@automerge/automerge-repo-svelte-store 1.0.6 → 1.0.7

package/README.md

@@ -37,6 +37,7 @@ For a working example, see the [Svelte counter demo](../automerge-repo-demo-coun
   export let docId: DocumentId
 
   // `document` calls `getContextRepo` internally to access the closest `Repo`.
+  // alternatively, you may pass in a specific repo as the second parameter
   const doc = document<{count?: number}>(docId)
   const increment = () => {
     doc.change((d) => d.count = (d.count || 0) + 1)
@@ -48,5 +49,7 @@ For a working example, see the [Svelte counter demo](../automerge-repo-demo-coun
 </button>
 ```
 
+
+
 ## Contributors
 Originally written by Dylan MacKenzie ([@ecstatic-morse](https://github.com/ecstatic-morse)).

package/dist/index.d.ts

@@ -39,6 +39,7 @@
  *   export let docId: DocumentId
  *
  *   // `document` calls `getContextRepo` internally to access the closest `Repo`.
+ *   // alternatively, you may pass in a specific repo as the second parameter
  *   const doc = document<{count?: number}>(docId)
  *   const increment = () => {
  *     doc.change((d) => d.count = (d.count || 0) + 1)
@@ -53,12 +54,20 @@
  * ## 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): {
+/**
+ *  A Svelte store for an Automerge document.
+ *
+ *  @param {AutomergeUrl} documentId - The Automerge document ID
+ *  @param {Repo=} repo - (Optional) The Automerge repo to use. If not provided, the repo will be retrieved from context.
+ *
+ *  @returns A Svelte store for the Automerge document.
+ */
+export declare function document<T>(documentId: AutomergeUrl, repo?: Repo): {
     subscribe: (this: void, run: import("svelte/store").Subscriber<Doc<T>>, invalidate?: (value?: Doc<T>) => void) => import("svelte/store").Unsubscriber;
     change: (fn: ChangeFn<T>) => void;
 };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAwDI;AAEJ,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;;;;;;;GAOG;AAEH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE,IAAI;;iBAWhD,SAAS,CAAC,CAAC;EAI3B"}

package/dist/index.js

@@ -39,6 +39,7 @@
  *   export let docId: DocumentId
  *
  *   // `document` calls `getContextRepo` internally to access the closest `Repo`.
+ *   // alternatively, you may pass in a specific repo as the second parameter
  *   const doc = document<{count?: number}>(docId)
  *   const increment = () => {
  *     doc.change((d) => d.count = (d.count || 0) + 1)
@@ -53,7 +54,7 @@
  * ## 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");
@@ -63,8 +64,16 @@ export function getContextRepo() {
 export function setContextRepo(repo) {
     setContext(ContextRepoKey, repo);
 }
-export function document(documentId) {
-    const repo = getContextRepo();
+/**
+ *  A Svelte store for an Automerge document.
+ *
+ *  @param {AutomergeUrl} documentId - The Automerge document ID
+ *  @param {Repo=} repo - (Optional) The Automerge repo to use. If not provided, the repo will be retrieved from context.
+ *
+ *  @returns A Svelte store for the Automerge document.
+ */
+export function document(documentId, repo) {
+    repo = repo ?? getContextRepo();
     const handle = repo.find(documentId);
     const { set, subscribe } = writable(handle.docSync(), () => {
         const onChange = (h) => set(h.doc);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo-svelte-store",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "A Svelte store containing your automerge documentsj",
   "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo-svelte-store",
   "license": "MIT",
@@ -11,11 +11,11 @@
     "watch": "npm-watch"
   },
   "peerDependencies": {
-    "@automerge/automerge": "^2.1.0",
+    "@automerge/automerge": "^2.1.5",
     "svelte": "^3.0.0"
   },
   "dependencies": {
-    "@automerge/automerge-repo": "^1.0.6"
+    "@automerge/automerge-repo": "^1.0.7"
   },
   "watch": {
     "build": {
@@ -29,8 +29,7 @@
     "access": "public"
   },
   "devDependencies": {
-    "@automerge/automerge": "^2.1.0",
     "svelte": "^3.0.0"
   },
-  "gitHead": "088696831fed48c7a8a88109acd0465222dc8522"
+  "gitHead": "71060981f168e511a99ab85b155a54a13fd04bcc"
 }

package/src/index.ts

@@ -1,59 +1,60 @@
 /**
  * # Svelte store for Automerge Repo
- * 
+ *
  * ## Example Usage
- * 
+ *
  * For a working example, see the [Svelte counter demo](../automerge-repo-demo-counter-svelte/).
- * 
- * @example 
- * 
+ *
+ * @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`.
+ *   // alternatively, you may pass in a specific repo as the second parameter
  *   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 {
@@ -74,8 +75,17 @@ export function setContextRepo(repo: Repo) {
   setContext(ContextRepoKey, repo)
 }
 
-export function document<T>(documentId: AutomergeUrl) {
-  const repo = getContextRepo()
+/**
+ *  A Svelte store for an Automerge document.
+ *
+ *  @param {AutomergeUrl} documentId - The Automerge document ID
+ *  @param {Repo=} repo - (Optional) The Automerge repo to use. If not provided, the repo will be retrieved from context.
+ *
+ *  @returns A Svelte store for the Automerge document.
+ */
+
+export function document<T>(documentId: AutomergeUrl, repo?: Repo) {
+  repo = repo ?? getContextRepo()
   const handle = repo.find<T>(documentId)
   const { set, subscribe } = writable<Doc<T>>(handle.docSync(), () => {
     const onChange = (h: DocHandleChangePayload<T>) => set(h.doc)

package/typedoc.json

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