@automerge/automerge-repo-svelte-store 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -1,10 +1,65 @@
-/// <reference types="svelte" />
+/**
+ * # Svelte store for Automerge Repo
+ *
+ * ## Example Usage
+ *
+ * For a working example, see the [Svelte counter demo](../automerge-repo-demo-counter-svelte/).
+ *
+ * @example
+ *
+ * ```svelte
+ * // App.svelte
+ * <script lang="ts">
+ *   import { Repo } from "@automerge/automerge-repo"
+ *   import Counter from './lib/Counter.svelte'
+ *   import { setContextRepo } from "@automerge/automerge-repo-svelte-store"
+ *
+ *   const repo = new Repo({storage: new SomeStorage() })
+ *
+ *   // Make the `Repo` available to child components (via Svelte's `setContext`).
+ *   setContextRepo(repo)
+ *
+ *   const docId = repo.create()
+ * </script>
+ *
+ * <main>
+ *   <div class="card">
+ *     <Counter {docId}/>
+ *   </div>
+ * </main>
+ * ```
+ *
+ *
+ * ```svelte
+ * // Counter.svelte`
+ * <script lang="ts">
+ *   import type { DocumentId } from "@automerge/automerge-repo"
+ *   import { document } from "@automerge/automerge-repo-svelte-store"
+ *
+ *   export let docId: DocumentId
+ *
+ *   // `document` calls `getContextRepo` internally to access the closest `Repo`.
+ *   const doc = document<{count?: number}>(docId)
+ *   const increment = () => {
+ *     doc.change((d) => d.count = (d.count || 0) + 1)
+ *   }
+ * </script>
+ *
+ * <button on:click={increment}>
+ *   count is {$doc?.count || 0}
+ * </button>
+ * ```
+ *
+ * ## Contributors
+ * Originally written by Dylan MacKenzie ([@ecstatic-morse](https://github.com/ecstatic-morse)).
+ *  * @packageDocumentation
+**/
 import type { ChangeFn, Doc } from "@automerge/automerge/next";
 import { AutomergeUrl, Repo } from "@automerge/automerge-repo";
 export declare function getContextRepo(): Repo;
 export declare function setContextRepo(repo: Repo): void;
 export declare function document<T>(documentId: AutomergeUrl): {
-    subscribe: (this: void, run: import("svelte/store").Subscriber<Doc<T>>, invalidate?: import("svelte/store").Invalidator<Doc<T>>) => import("svelte/store").Unsubscriber;
+    subscribe: (this: void, run: import("svelte/store").Subscriber<Doc<T>>, invalidate?: (value?: Doc<T>) => void) => import("svelte/store").Unsubscriber;
     change: (fn: ChangeFn<T>) => void;
 };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,2BAA2B,CAAA;AAC9D,OAAO,EACL,YAAY,EAEZ,IAAI,EACL,MAAM,2BAA2B,CAAA;AAMlC,wBAAgB,cAAc,IAAI,IAAI,CAErC;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,QAExC;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,UAAU,EAAE,YAAY;;iBAWnC,SAAS,CAAC,CAAC;EAI3B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,2BAA2B,CAAA;AAC9D,OAAO,EACL,YAAY,EAEZ,IAAI,EACL,MAAM,2BAA2B,CAAA;AAMlC,wBAAgB,cAAc,IAAI,IAAI,CAErC;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,QAExC;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,UAAU,EAAE,YAAY;;iBAWnC,SAAS,CAAC,CAAC;EAI3B"}

package/dist/index.js

@@ -1,3 +1,59 @@
+/**
+ * # Svelte store for Automerge Repo
+ *
+ * ## Example Usage
+ *
+ * For a working example, see the [Svelte counter demo](../automerge-repo-demo-counter-svelte/).
+ *
+ * @example
+ *
+ * ```svelte
+ * // App.svelte
+ * <script lang="ts">
+ *   import { Repo } from "@automerge/automerge-repo"
+ *   import Counter from './lib/Counter.svelte'
+ *   import { setContextRepo } from "@automerge/automerge-repo-svelte-store"
+ *
+ *   const repo = new Repo({storage: new SomeStorage() })
+ *
+ *   // Make the `Repo` available to child components (via Svelte's `setContext`).
+ *   setContextRepo(repo)
+ *
+ *   const docId = repo.create()
+ * </script>
+ *
+ * <main>
+ *   <div class="card">
+ *     <Counter {docId}/>
+ *   </div>
+ * </main>
+ * ```
+ *
+ *
+ * ```svelte
+ * // Counter.svelte`
+ * <script lang="ts">
+ *   import type { DocumentId } from "@automerge/automerge-repo"
+ *   import { document } from "@automerge/automerge-repo-svelte-store"
+ *
+ *   export let docId: DocumentId
+ *
+ *   // `document` calls `getContextRepo` internally to access the closest `Repo`.
+ *   const doc = document<{count?: number}>(docId)
+ *   const increment = () => {
+ *     doc.change((d) => d.count = (d.count || 0) + 1)
+ *   }
+ * </script>
+ *
+ * <button on:click={increment}>
+ *   count is {$doc?.count || 0}
+ * </button>
+ * ```
+ *
+ * ## Contributors
+ * Originally written by Dylan MacKenzie ([@ecstatic-morse](https://github.com/ecstatic-morse)).
+ *  * @packageDocumentation
+**/
 import { getContext, setContext } from "svelte";
 import { writable } from "svelte/store";
 const ContextRepoKey = Symbol("svelte-context-automerge-repo");

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@automerge/automerge-repo-svelte-store",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "A Svelte store containing your automerge documentsj",
-  "repository": "https://github.com/automerge/automerge-repo",
+  "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo-svelte-store",
   "license": "MIT",
-  "private": false,
   "type": "module",
   "main": "dist/index.js",
   "scripts": {
@@ -12,11 +11,11 @@
     "watch": "npm-watch"
   },
   "peerDependencies": {
-    "@automerge/automerge": "^2.1.0"
+    "@automerge/automerge": "^2.1.0",
+    "svelte": "^3.0.0"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.2",
-    "svelte": ">=3.0.0"
+    "@automerge/automerge-repo": "^1.0.4"
   },
   "watch": {
     "build": {
@@ -29,5 +28,9 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c72b9ec33c3a1f7f39ad20cb4fa0d766afe42158"
+  "devDependencies": {
+    "@automerge/automerge": "^2.1.0",
+    "svelte": "^3.0.0"
+  },
+  "gitHead": "17fd5260f9af3e65da636fef084e8c04d6c4bed0"
 }

package/src/index.ts

@@ -1,3 +1,60 @@
+/**
+ * # Svelte store for Automerge Repo
+ * 
+ * ## Example Usage
+ * 
+ * For a working example, see the [Svelte counter demo](../automerge-repo-demo-counter-svelte/).
+ * 
+ * @example 
+ * 
+ * ```svelte
+ * // App.svelte
+ * <script lang="ts">
+ *   import { Repo } from "@automerge/automerge-repo"
+ *   import Counter from './lib/Counter.svelte'
+ *   import { setContextRepo } from "@automerge/automerge-repo-svelte-store"
+ * 
+ *   const repo = new Repo({storage: new SomeStorage() })
+ * 
+ *   // Make the `Repo` available to child components (via Svelte's `setContext`).
+ *   setContextRepo(repo)
+ * 
+ *   const docId = repo.create()
+ * </script>
+ * 
+ * <main>
+ *   <div class="card">
+ *     <Counter {docId}/>
+ *   </div>
+ * </main>
+ * ```
+ * 
+ * 
+ * ```svelte
+ * // Counter.svelte`
+ * <script lang="ts">
+ *   import type { DocumentId } from "@automerge/automerge-repo"
+ *   import { document } from "@automerge/automerge-repo-svelte-store"
+ * 
+ *   export let docId: DocumentId
+ * 
+ *   // `document` calls `getContextRepo` internally to access the closest `Repo`.
+ *   const doc = document<{count?: number}>(docId)
+ *   const increment = () => {
+ *     doc.change((d) => d.count = (d.count || 0) + 1)
+ *   }
+ * </script>
+ * 
+ * <button on:click={increment}>
+ *   count is {$doc?.count || 0}
+ * </button>
+ * ```
+ * 
+ * ## Contributors
+ * Originally written by Dylan MacKenzie ([@ecstatic-morse](https://github.com/ecstatic-morse)).
+ *  * @packageDocumentation
+**/
+
 import type { ChangeFn, Doc } from "@automerge/automerge/next"
 import {
   AutomergeUrl,

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "extends": "../../typedoc.base.json",
+    "entryPoints": ["src/index.ts"],
+    "readme": "none"
+}