@aws-amplify/datastore 3.9.1-unstable.3 → 3.10.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.10.0](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/datastore@3.9.0...@aws-amplify/datastore@3.10.0) (2022-04-14)
+
+
+### Features
+
+* **data:** Datastore Docs ([#9753](https://github.com/aws-amplify/amplify-js/issues/9753)) ([4eb824f](https://github.com/aws-amplify/amplify-js/commit/4eb824f168df408469557e6ccc60edfee99953c2))
+
+
+
+
+
 # [3.9.0](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/datastore@3.8.0...@aws-amplify/datastore@3.9.0) (2022-04-04)
 
 

package/README.md

@@ -0,0 +1,154 @@
+# AWS Amplify DataStore Docs
+
+[Amplify DataStore](https://docs.amplify.aws/lib/datastore/getting-started/q/platform/js/) provides a programming model for leveraging shared and distributed data without writing additional code for offline and online scenarios, which makes working with distributed, cross-user data just as simple as working with local-only data.
+
+---
+
+| package                | version                                                         | open issues                                                                                                                                                                                  | closed issues                                                                                                                                                                                 |
+| ---------------------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| @aws-amplify/datastore | ![npm](https://img.shields.io/npm/v/@aws-amplify/datastore.svg) | [![Open Issues](https://img.shields.io/github/issues/aws-amplify/amplify-js/DataStore?color=red)](https://github.com/aws-amplify/amplify-js/issues?q=is%3Aissue+label%3ADataStore+is%3Aopen) | [![Closed Issues](https://img.shields.io/github/issues-closed/aws-amplify/amplify-js/DataStore)](https://github.com/aws-amplify/amplify-js/issues?q=is%3Aissue+label%3ADataStore+is%3Aclosed) |
+
+---
+
+## **👋 Note For Contributers: 👋**
+
+_**Please update these docs any time you find something that is incorrect or lacking. In particular, if a line in the docs prompts a question, take a moment to figure out the answer, then update the docs with the necessary detail.**_
+
+---
+
+## Getting Started
+
+Before you start reading through these docs, take a moment to understand [how DataStore works at a high level](https://docs.amplify.aws/lib/datastore/how-it-works/q/platform/js/). Additionally, we recommend first reading through [docs.amplify.aws](https://docs.amplify.aws/lib/datastore/getting-started/q/platform/js/). The purpose of these docs is to dive deep into the codebase itself and understand the inner workings of DataStore for the purpose of contributing. Understanding these docs is **not** necessary for using DataStore. Lastly, before reading, take a look at [the diagrams below](#diagrams).
+
+---
+
+## Docs
+
+- [Conflict Resolution](docs/conflict-resolution.md)
+- [Contributing](docs/contributing.md)
+- [DataStore Lifecycle Events ("Start", "Stop", "Clear")](docs/datastore-lifecycle-events.md)
+  - This explains how DataStore fundementally works, and is a great place to start.
+- [Getting Started](docs/getting-started.md) (Running against a sample app, etc.)
+- [Namespaces](docs/namespaces.md)
+- [How DataStore uses Observables](docs/observables.md)
+- [Schema Changes](docs/schema-changes.md)
+- [Storage](docs/storage.md)
+- [Sync Engine](docs/sync-engine.md)
+- ["Unsupported hacks" / workarounds](docs/workarounds.md)
+
+---
+
+# Diagrams
+
+_Note: relationships with dotted lines are explained more in a separate diagram._
+
+## How the DataStore API and Storage Engine Interact
+
+```mermaid
+flowchart TD
+  %% API and Storage
+  api[[DS API]]-- observe -->storage{Storage Engine}
+  storage-- next -->adapter[[Adapter]]
+  adapter-->db[[Local DB]]
+  db-->api
+  sync[[Sync Engine*]]-.-storage
+  sync-.-appSync[(AppSync)]
+```
+
+# How the Sync Engine Observes Changes in Storage and AppSync
+
+_Note: All green nodes belong to the Sync Engine._
+
+\* Merger first checks outbox
+
+\*\* Outbox sends outgoing messages to AppSync
+
+```mermaid
+flowchart TD
+
+  subgraph SyncEngine
+  index{index.ts}-- observe -->reach[Core reachability]
+
+  subgraph processors
+  mp[Mutation Processor]
+  sp[Subscription Processor]
+  syp[Sync Processor]
+  end
+
+  reach--next-->mp[Mutation Processor]
+  reach--next-->sp[Subscription Processor]
+  reach--next-->syp[Sync Processor]
+
+  subgraph outbox / merger
+  outbox[Outbox]
+  merger[Merger]
+  outbox---merger
+  end
+
+  end
+
+  api[DS API]-.->storage
+  mp-- 1. observe -->storage{Storage Engine}
+  storage-- 2. next -->merger[merger*]-- next -->storage
+
+
+  sp-- observe -->appsync[(AppSync)]
+  appsync-- next -->sp
+
+  syp---appsync
+
+  mp-->outbox[outbox**]
+
+  appsync<--->outbox
+  %% styling
+  classDef syncEngineClass fill:#8FB,stroke:#333,stroke-width:4px,color:#333;
+  class index,mp,sp,syp,merger,outbox syncEngineClass;
+```
+
+---
+
+# Project Structure
+
+<pre>
+amplify-js/packages/datastore/src
+├── authModeStrategies
+│   └── defaultAuthStraegy.ts
+│   └── index.ts
+│   └── multiAuthStrategy.ts
+├── datastore
+│   └── datastore.ts # Entry point for DataStore
+├── predicates
+│   └── index.ts
+│   └── sort.ts
+├── ssr
+├── storage # Storage Engine
+│   └── adapter # Platform-specific Storage Adapters
+│      └── getDefaultAdapter
+│      └── AsyncStorageAdapter.ts
+│      └── AsyncStorageDatabase.ts
+│      └── index.ts
+│      └── IndexedDBAdapter.ts
+│      └── InMemoryStore.native.ts
+│      └── InMemoryStore.ts
+│   └── storage.ts # Entry point for Storage
+├── sync # Sync Engine
+│   └── dataStoreReachability
+│      └── index.native.ts
+│      └── index.ts
+│   └── processors # Sync Engine Processors
+│      └── mutation.ts
+│      └── subscription.ts
+│      └── sync.ts
+│   └── datastoreConnectivity.ts # Subscribe to reachability monitor
+│   └── index.ts # Entry point for Sync Engine
+│   └── merger.ts # <a href="https://github.com/aws-amplify/amplify-js/blob/datastore-docs/packages/datastore/docs/sync-engine.md#merger" title="merger doc">doc</a>
+│   └── outbox.ts # <a href="https://github.com/aws-amplify/amplify-js/blob/datastore-docs/packages/datastore/docs/sync-engine.md#outbox" title="outbox doc">doc</a>
+</pre>
+
+---
+
+## Other Resources:
+
+- [High-level overview of how DataStore works](https://docs.amplify.aws/lib/datastore/how-it-works/q/platform/js/)
+- [DataStore Docs](https://docs.amplify.aws/lib/datastore/getting-started/q/platform/js/)
+- [re:Invent talk](https://www.youtube.com/watch?v=KcYl6_We0EU)

package/dist/aws-amplify-datastore.js

@@ -91422,7 +91422,7 @@ var __spread = undefined && undefined.__spread || function () {
   return ar;
 };
 
-
+ // https://github.com/aws-amplify/amplify-js/blob/datastore-docs/packages/datastore/docs/sync-engine.md#merger
 
 var ModelMerger =
 /** @class */
@@ -91751,6 +91751,7 @@ var __read = undefined && undefined.__read || function (o, n) {
 
 
  // TODO: Persist deleted ids
+// https://github.com/aws-amplify/amplify-js/blob/datastore-docs/packages/datastore/docs/sync-engine.md#outbox
 
 var MutationEventOutbox =
 /** @class */