# amplify-flutter-datastore-extension > amplify plugin to generate Flutter Extensions for DataStore operations. Latest version **0.2.3** (published 2023-10-15) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install amplify-flutter-datastore-extension pnpm add amplify-flutter-datastore-extension yarn add amplify-flutter-datastore-extension bun add amplify-flutter-datastore-extension ``` ## Health **Score 40/100 (D)** — status: abandoned. Positive: has types; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned. ## Facts | | | |---|---| | Version | 0.2.3 | | Published | 2023-10-15 | | First published | 2023-09-23 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 6 | | Unpacked size | 68.7 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | MURAKAMI Masahiko | | Maintainers | fossamagna | | Keywords | aws, amplify, datastore, flutter | ## Links - npm: https://www.npmjs.com/package/amplify-flutter-datastore-extension - Repository: https://github.com/fossamagna/amplify-flutter-datastore-extension - Homepage: https://github.com/fossamagna/amplify-flutter-datastore-extension#readme - Issues: https://github.com/fossamagna/amplify-flutter-datastore-extension/issues - npm.io page: https://npm.io/package/amplify-flutter-datastore-extension ## Dependencies (6) - [glob](https://npm.io/package/glob.md) ^10.3.4 - [fs-extra](https://npm.io/package/fs-extra.md) ^11.1.1 - [amplify-cli-core](https://npm.io/package/amplify-cli-core.md) ^4.0.4 - [@graphql-codegen/core](https://npm.io/package/@graphql-codegen/core.md) 2.6.8 - [graphql-transformer-common](https://npm.io/package/graphql-transformer-common.md) ^4.25.1 - [@aws-amplify/appsync-modelgen-plugin](https://npm.io/package/@aws-amplify/appsync-modelgen-plugin.md) ^2.6.0 ## Alternatives - [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads - [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads - [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads - [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads - [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads ## Recent versions - 0.2.3 (latest) — 2023-10-15 - 0.2.2 — 2023-10-10 - 0.2.1 — 2023-09-26 - 0.2.0 — 2023-09-26 - 0.1.0 — 2023-09-23 ## README
Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
## About The Project This project is amplify plugin to generate Flutter Extensions for DataStore operations. This feature is automatically executed when run `amplify codegen models`. [![NPM version][npm-image]][npm-url] [![codecov][codecov-image]][codecov-url] ## Getting Started This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps. ### Prerequisites First, install AWS Amplify CLI using npm (we assume you have pre-installed node.js). ```sh npm install -g @aws-amplify/cli ``` ### Installation 1. Install NPM packages ```sh npm install -g amplify-flutter-datastore-extension ``` 2. Enable this plugin ```sh amplify plugin add $(npm root -g)/amplify-flutter-datastore-extension ``` ## Usage `amplify/backend/api/{api_name}/schema.graphql` containing the following: ```graphql type Todo @model { id: ID! name: String! description: String } ``` Run the following command: ```bash amplify codegen models ``` The plugin outputs `DataStoreExtension.dart` with the following contents: ```dart import 'ModelProvider.dart'; import 'package:amplify_core/amplify_core.dart' as amplify_core; /** This is an auto generated extension representing the Todo type in your schema. */ extension TodoExtension on amplify_core.DataStoreCategory { Future getTodo(String id) { return query( Todo.classType, where: Todo.MODEL_IDENTIFIER.eq(TodoModelIdentifier(id: id)), ) .then((list) => list.single); } Future getTodoOrNull(String id) { return query( Todo.classType, where: Todo.MODEL_IDENTIFIER.eq(TodoModelIdentifier(id: id)), ) .then((list) => list.singleOrNull); } } ``` You can call it as follows: ```dart final id = "080f33bf-0362-4c7f-9dfa-de64fc231dca"; final todo = await Amplify.DataStore.getTodo(id); ``` ## Roadmap See the [open issues](https://github.com/fossamagna/amplify-flutter-datastore-extension/issues) for a list of proposed features (and known issues). ## Contributing Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request ## License Distributed under the Apache-2.0 License. See `LICENSE` for more information. ## Contact Masahiko MURAKAMI - [@fossamagna](https://twitter.com/fossamagna) Project Link: [https://github.com/fossamagna/amplify-flutter-datastore-extension](https://github.com/fossamagna/amplify-flutter-datastore-extension) [npm-image]: https://badge.fury.io/js/amplify-flutter-datastore-extension.svg [npm-url]: https://npmjs.org/package/amplify-flutter-datastore-extension [codecov-image]: https://codecov.io/gh/fossamagna/amplify-flutter-datastore-extension/graph/badge.svg?token=J4S4TO6zXB [codecov-url]: https://codecov.io/gh/fossamagna/amplify-flutter-datastore-extension --- _Source: https://npm.io/package/amplify-flutter-datastore-extension · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._