@graffiti-garden/wrapper-synchronize 0.2.3 → 0.2.4

package/dist/cjs/index.js

@@ -107,7 +107,9 @@ class GraffitiSynchronize extends import_api.Graffiti {
         this.callbacks.delete(callback);
       }
     );
-    return repeater;
+    return (async function* () {
+      for await (const i of repeater) yield i;
+    })();
   }
   /**
    * This method has the same signature as {@link discover} but listens for
@@ -178,6 +180,8 @@ class GraffitiSynchronize extends import_api.Graffiti {
    *
    * Be careful using this method. Without additional filters it can
    * expose the user to content out of context.
+   *
+   * @group Synchronize Methods
    */
   synchronizeAll(schema, session) {
     return this.synchronize(() => true, [], schema, session);
@@ -248,7 +252,7 @@ class GraffitiSynchronize extends import_api.Graffiti {
   };
   objectStreamContinue(iterator) {
     const this_ = this;
-    return async function* () {
+    return (async function* () {
       while (true) {
         const result = await iterator.next();
         if (result.done) {
@@ -265,17 +269,17 @@ class GraffitiSynchronize extends import_api.Graffiti {
         }
         yield result.value;
       }
-    }();
+    })();
   }
   objectStream(iterator) {
     const wrapped = this.objectStreamContinue(iterator);
-    return async function* () {
+    return (async function* () {
       while (true) {
         const result = await wrapped.next();
         if (result.done) return result.value;
         if (result.value.error || !result.value.tombstone) yield result.value;
       }
-    }();
+    })();
   }
   discover = (...args) => {
     const iterator = this.graffiti.discover(...args);
@@ -286,7 +290,8 @@ class GraffitiSynchronize extends import_api.Graffiti {
     return this.objectStream(iterator);
   };
   continueObjectStream = (...args) => {
-    return this.graffiti.continueObjectStream(...args);
+    const iterator = this.graffiti.continueObjectStream(...args);
+    return this.objectStreamContinue(iterator);
   };
 }
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/index.ts"],
-  "sourcesContent": ["import type Ajv from \"ajv\";\nimport { Graffiti } from \"@graffiti-garden/api\";\nimport type {\n  GraffitiSession,\n  JSONSchema,\n  GraffitiObjectStream,\n  GraffitiObjectStreamContinueEntry,\n  GraffitiObjectStreamContinue,\n  GraffitiObject,\n} from \"@graffiti-garden/api\";\nimport type { GraffitiObjectBase } from \"@graffiti-garden/api\";\nimport { Repeater } from \"@repeaterjs/repeater\";\nimport type { applyPatch } from \"fast-json-patch\";\nimport {\n  applyGraffitiPatch,\n  compileGraffitiObjectSchema,\n  isActorAllowedGraffitiObject,\n  maskGraffitiObject,\n  unpackObjectUrl,\n} from \"@graffiti-garden/implementation-local/utilities\";\nexport type * from \"@graffiti-garden/api\";\n\nexport type GraffitiSynchronizeCallback = (\n  oldObject: GraffitiObjectStreamContinueEntry<{}>,\n  newObject?: GraffitiObjectStreamContinueEntry<{}>,\n) => void;\n\nexport interface GraffitiSynchronizeOptions {\n  /**\n   * Allows synchronize to listen to all objects, not just those\n   * that the session is allowed to see. This is useful to get a\n   * global view of all Graffiti objects passsing through the system,\n   * for example to build a client-side cache. Additional mechanisms\n   * should be in place to ensure that users do not see objects or\n   * properties they are not allowed to see.\n   *\n   * Default: `false`\n   */\n  omniscient?: boolean;\n}\n\n/**\n * Wraps the [Graffiti API](https://api.graffiti.garden/classes/Graffiti.html)\n * so that changes made or received in one part of an application\n * are automatically routed to other parts of the application.\n * This is an important tool for building responsive\n * and consistent user interfaces, and is built upon to make\n * the [Graffiti Vue Plugin](https://vue.graffiti.garden/variables/GraffitiPlugin.html)\n * and possibly other front-end libraries in the future.\n *\n * Specifically, it provides the following *synchronize*\n * methods for each of the following API methods:\n *\n * | API Method | Synchronize Method |\n * |------------|--------------------|\n * | {@link get} | {@link synchronizeGet} |\n * | {@link discover} | {@link synchronizeDiscover} |\n * | {@link recoverOrphans} | {@link synchronizeRecoverOrphans} |\n *\n * Whenever a change is made via {@link put}, {@link patch}, and {@link delete} or\n * received from {@link get}, {@link discover}, and {@link recoverOrphans},\n * those changes are forwarded to the appropriate synchronize method.\n * Each synchronize method returns an iterator that streams these changes\n * continually until the user calls `return` on the iterator or `break`s out of the loop,\n * allowing for live updates without additional polling.\n *\n * Example 1: Suppose a user publishes a post using {@link put}. If the feed\n * displaying that user's posts is using {@link synchronizeDiscover} to listen for changes,\n * then the user's new post will instantly appear in their feed, giving the UI a\n * responsive feel.\n *\n * Example 2: Suppose one of a user's friends changes their name. As soon as the\n * user's application receives one notice of that change (using {@link get}\n * or {@link discover}), then {@link synchronizeDiscover} listeners can be used to update\n * all instance's of that friend's name in the user's application instantly,\n * providing a consistent user experience.\n *\n * @groupDescription Synchronize Methods\n * This group contains methods that listen for changes made via\n * {@link put}, {@link patch}, and {@link delete} or fetched from\n * {@link get}, {@link discover}, and {@link recoverOrphans} and then\n * streams appropriate changes to provide a responsive and consistent user experience.\n */\nexport class GraffitiSynchronize extends Graffiti {\n  protected ajv_: Promise<Ajv> | undefined;\n  protected applyPatch_: Promise<typeof applyPatch> | undefined;\n  protected readonly graffiti: Graffiti;\n  protected readonly callbacks = new Set<GraffitiSynchronizeCallback>();\n  protected readonly options: GraffitiSynchronizeOptions;\n\n  channelStats: Graffiti[\"channelStats\"];\n  login: Graffiti[\"login\"];\n  logout: Graffiti[\"logout\"];\n  sessionEvents: Graffiti[\"sessionEvents\"];\n\n  get ajv() {\n    if (!this.ajv_) {\n      this.ajv_ = (async () => {\n        const { default: Ajv } = await import(\"ajv\");\n        return new Ajv({ strict: false });\n      })();\n    }\n    return this.ajv_;\n  }\n\n  get applyPatch() {\n    if (!this.applyPatch_) {\n      this.applyPatch_ = (async () => {\n        const { applyPatch } = await import(\"fast-json-patch\");\n        return applyPatch;\n      })();\n    }\n    return this.applyPatch_;\n  }\n\n  /**\n   * Wraps a Graffiti API instance to provide the synchronize methods.\n   * The GraffitiSyncrhonize class rather than the Graffiti class\n   * must be used for all functions for the synchronize methods to work.\n   */\n  constructor(\n    /**\n     * The [Graffiti API](https://api.graffiti.garden/classes/Graffiti.html)\n     * instance to wrap.\n     */\n    graffiti: Graffiti,\n    options?: GraffitiSynchronizeOptions,\n  ) {\n    super();\n    this.options = options ?? {};\n    this.graffiti = graffiti;\n    this.channelStats = graffiti.channelStats.bind(graffiti);\n    this.login = graffiti.login.bind(graffiti);\n    this.logout = graffiti.logout.bind(graffiti);\n    this.sessionEvents = graffiti.sessionEvents;\n  }\n\n  protected synchronize<Schema extends JSONSchema>(\n    matchObject: (object: GraffitiObjectBase) => boolean,\n    channels: string[],\n    schema: Schema,\n    session?: GraffitiSession | null,\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const seenUrls = new Set<string>();\n\n    const repeater = new Repeater<GraffitiObjectStreamContinueEntry<Schema>>(\n      async (push, stop) => {\n        const validate = compileGraffitiObjectSchema(await this.ajv, schema);\n        const callback: GraffitiSynchronizeCallback = (\n          oldObjectRaw,\n          newObjectRaw,\n        ) => {\n          for (const objectRaw of [newObjectRaw, oldObjectRaw]) {\n            if (objectRaw?.tombstone) {\n              if (seenUrls.has(objectRaw.object.url)) {\n                push(objectRaw);\n              }\n            } else if (\n              objectRaw &&\n              matchObject(objectRaw.object) &&\n              (this.options.omniscient ||\n                isActorAllowedGraffitiObject(objectRaw.object, session))\n            ) {\n              // Deep clone the object to prevent mutation\n              const object = JSON.parse(\n                JSON.stringify(objectRaw.object),\n              ) as GraffitiObject<{}>;\n              if (!this.options.omniscient) {\n                maskGraffitiObject(object, channels, session);\n              }\n              if (validate(object)) {\n                push({ object });\n                seenUrls.add(object.url);\n                break;\n              }\n            }\n          }\n        };\n\n        this.callbacks.add(callback);\n        await stop;\n        this.callbacks.delete(callback);\n      },\n    );\n\n    return repeater;\n  }\n\n  /**\n   * This method has the same signature as {@link discover} but listens for\n   * changes made via {@link put}, {@link patch}, and {@link delete} or\n   * fetched from {@link get}, {@link discover}, and {@link recoverOrphans}\n   * and then streams appropriate changes to provide a responsive and\n   * consistent user experience.\n   *\n   * Unlike {@link discover}, this method continuously listens for changes\n   * and will not terminate unless the user calls the `return` method on the iterator\n   * or `break`s out of the loop.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeDiscover<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.discover<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [channels, schema, session] = args;\n    function matchObject(object: GraffitiObjectBase) {\n      return object.channels.some((channel) => channels.includes(channel));\n    }\n    return this.synchronize<Schema>(matchObject, channels, schema, session);\n  }\n\n  /**\n   * This method has the same signature as {@link get} but\n   * listens for changes made via {@link put}, {@link patch}, and {@link delete} or\n   * fetched from {@link get}, {@link discover}, and {@link recoverOrphans} and then\n   * streams appropriate changes to provide a responsive and consistent user experience.\n   *\n   * Unlike {@link get}, which returns a single result, this method continuously\n   * listens for changes which are output as an asynchronous stream, similar\n   * to {@link discover}.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeGet<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.get<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [objectUrl, schema, session] = args;\n    const url = unpackObjectUrl(objectUrl);\n    function matchObject(object: GraffitiObjectBase) {\n      return object.url === url;\n    }\n    return this.synchronize<Schema>(matchObject, [], schema, session);\n  }\n\n  /**\n   * This method has the same signature as {@link recoverOrphans} but\n   * listens for changes made via\n   * {@link put}, {@link patch}, and {@link delete} or fetched from\n   * {@link get}, {@link discover}, and {@link recoverOrphans} and then\n   * streams appropriate changes to provide a responsive and consistent user experience.\n   *\n   * Unlike {@link recoverOrphans}, this method continuously listens for changes\n   * and will not terminate unless the user calls the `return` method on the iterator\n   * or `break`s out of the loop.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeRecoverOrphans<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.recoverOrphans<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [schema, session] = args;\n    function matchObject(object: GraffitiObjectBase) {\n      return object.actor === session.actor && object.channels.length === 0;\n    }\n    return this.synchronize<Schema>(matchObject, [], schema, session);\n  }\n\n  /**\n   * Streams changes made to *any* object in *any* channel\n   * and made by *any* user. You may want to use it in conjuction with\n   * {@link GraffitiSynchronizeOptions.omniscient} to get a global view\n   * of all Graffiti objects passing through the system. This is useful\n   * for building a client-side cache, for example.\n   *\n   * Be careful using this method. Without additional filters it can\n   * expose the user to content out of context.\n   */\n  synchronizeAll<Schema extends JSONSchema>(\n    schema: Schema,\n    session?: GraffitiSession | null,\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    return this.synchronize<Schema>(() => true, [], schema, session);\n  }\n\n  protected async synchronizeDispatch(\n    oldObject: GraffitiObjectStreamContinueEntry<{}>,\n    newObject?: GraffitiObjectStreamContinueEntry<{}>,\n    waitForListeners = false,\n  ) {\n    for (const callback of this.callbacks) {\n      callback(oldObject, newObject);\n    }\n    if (waitForListeners) {\n      // Wait for the listeners to receive\n      // their objects, before returning the operation\n      // that triggered them.\n      //\n      // This is important for mutators (put, patch, delete)\n      // to ensure the application state has been updated\n      // everywhere before returning, giving consistent\n      // feedback to the user that the operation has completed.\n      //\n      // The opposite is true for accessors (get, discover, recoverOrphans),\n      // where it is a weird user experience to call `get`\n      // in one place and have the application update\n      // somewhere else first. It is also less efficient.\n      //\n      // The hack is simply to await one \"macro task cycle\".\n      // We need to wait for this cycle rather than using\n      // `await push` in the callback, because it turns out\n      // that `await push` won't resolve until the following\n      // .next() call of the iterator, so if only\n      // one .next() is called, this dispatch will hang.\n      await new Promise((resolve) => setTimeout(resolve, 0));\n    }\n  }\n\n  get: Graffiti[\"get\"] = async (...args) => {\n    const object = await this.graffiti.get(...args);\n    this.synchronizeDispatch({ object });\n    return object;\n  };\n\n  put: Graffiti[\"put\"] = async (...args) => {\n    const oldObject = await this.graffiti.put<{}>(...args);\n    const partialObject = args[0];\n    const newObject: GraffitiObjectBase = {\n      ...oldObject,\n      value: partialObject.value,\n      channels: partialObject.channels,\n      allowed: partialObject.allowed,\n    };\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      {\n        object: newObject,\n      },\n      true,\n    );\n    return oldObject;\n  };\n\n  patch: Graffiti[\"patch\"] = async (...args) => {\n    const oldObject = await this.graffiti.patch(...args);\n    const newObject: GraffitiObjectBase = { ...oldObject };\n    for (const prop of [\"value\", \"channels\", \"allowed\"] as const) {\n      applyGraffitiPatch(await this.applyPatch, prop, args[0], newObject);\n    }\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      {\n        object: newObject,\n      },\n      true,\n    );\n    return oldObject;\n  };\n\n  delete: Graffiti[\"delete\"] = async (...args) => {\n    const oldObject = await this.graffiti.delete(...args);\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      undefined,\n      true,\n    );\n    return oldObject;\n  };\n\n  protected objectStreamContinue<Schema extends JSONSchema>(\n    iterator: GraffitiObjectStreamContinue<Schema>,\n  ): GraffitiObjectStreamContinue<Schema> {\n    const this_ = this;\n    return (async function* () {\n      while (true) {\n        const result = await iterator.next();\n        if (result.done) {\n          const { continue: continue_, cursor } = result.value;\n          return {\n            continue: () => this_.objectStreamContinue<Schema>(continue_()),\n            cursor,\n          };\n        }\n        if (!result.value.error) {\n          this_.synchronizeDispatch(\n            result.value as GraffitiObjectStreamContinueEntry<{}>,\n          );\n        }\n        yield result.value;\n      }\n    })();\n  }\n\n  protected objectStream<Schema extends JSONSchema>(\n    iterator: GraffitiObjectStream<Schema>,\n  ): GraffitiObjectStream<Schema> {\n    const wrapped = this.objectStreamContinue<Schema>(iterator);\n    return (async function* () {\n      // Filter out the tombstones for type safety\n      while (true) {\n        const result = await wrapped.next();\n        if (result.done) return result.value;\n        if (result.value.error || !result.value.tombstone) yield result.value;\n      }\n    })();\n  }\n\n  discover: Graffiti[\"discover\"] = (...args) => {\n    const iterator = this.graffiti.discover(...args);\n    return this.objectStream<(typeof args)[1]>(iterator);\n  };\n\n  recoverOrphans: Graffiti[\"recoverOrphans\"] = (...args) => {\n    const iterator = this.graffiti.recoverOrphans(...args);\n    return this.objectStream<(typeof args)[0]>(iterator);\n  };\n\n  continueObjectStream: Graffiti[\"continueObjectStream\"] = (...args) => {\n    // TODO!!\n    return this.graffiti.continueObjectStream(...args);\n  };\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,iBAAyB;AAUzB,sBAAyB;AAEzB,uBAMO;AAgEA,MAAM,4BAA4B,oBAAS;AAAA,EACtC;AAAA,EACA;AAAA,EACS;AAAA,EACA,YAAY,oBAAI,IAAiC;AAAA,EACjD;AAAA,EAEnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEA,IAAI,MAAM;AACR,QAAI,CAAC,KAAK,MAAM;AACd,WAAK,QAAQ,YAAY;AACvB,cAAM,EAAE,SAAS,IAAI,IAAI,MAAM,OAAO,KAAK;AAC3C,eAAO,IAAI,IAAI,EAAE,QAAQ,MAAM,CAAC;AAAA,MAClC,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,aAAa;AACf,QAAI,CAAC,KAAK,aAAa;AACrB,WAAK,eAAe,YAAY;AAC9B,cAAM,EAAE,WAAW,IAAI,MAAM,OAAO,iBAAiB;AACrD,eAAO;AAAA,MACT,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,YAKE,UACA,SACA;AACA,UAAM;AACN,SAAK,UAAU,WAAW,CAAC;AAC3B,SAAK,WAAW;AAChB,SAAK,eAAe,SAAS,aAAa,KAAK,QAAQ;AACvD,SAAK,QAAQ,SAAS,MAAM,KAAK,QAAQ;AACzC,SAAK,SAAS,SAAS,OAAO,KAAK,QAAQ;AAC3C,SAAK,gBAAgB,SAAS;AAAA,EAChC;AAAA,EAEU,YACR,aACA,UACA,QACA,SAC2D;AAC3D,UAAM,WAAW,oBAAI,IAAY;AAEjC,UAAM,WAAW,IAAI;AAAA,MACnB,OAAO,MAAM,SAAS;AACpB,cAAM,eAAW,8CAA4B,MAAM,KAAK,KAAK,MAAM;AACnE,cAAM,WAAwC,CAC5C,cACA,iBACG;AACH,qBAAW,aAAa,CAAC,cAAc,YAAY,GAAG;AACpD,gBAAI,WAAW,WAAW;AACxB,kBAAI,SAAS,IAAI,UAAU,OAAO,GAAG,GAAG;AACtC,qBAAK,SAAS;AAAA,cAChB;AAAA,YACF,WACE,aACA,YAAY,UAAU,MAAM,MAC3B,KAAK,QAAQ,kBACZ,+CAA6B,UAAU,QAAQ,OAAO,IACxD;AAEA,oBAAM,SAAS,KAAK;AAAA,gBAClB,KAAK,UAAU,UAAU,MAAM;AAAA,cACjC;AACA,kBAAI,CAAC,KAAK,QAAQ,YAAY;AAC5B,yDAAmB,QAAQ,UAAU,OAAO;AAAA,cAC9C;AACA,kBAAI,SAAS,MAAM,GAAG;AACpB,qBAAK,EAAE,OAAO,CAAC;AACf,yBAAS,IAAI,OAAO,GAAG;AACvB;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAEA,aAAK,UAAU,IAAI,QAAQ;AAC3B,cAAM;AACN,aAAK,UAAU,OAAO,QAAQ;AAAA,MAChC;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,uBACK,MACwD;AAC3D,UAAM,CAAC,UAAU,QAAQ,OAAO,IAAI;AACpC,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,SAAS,KAAK,CAAC,YAAY,SAAS,SAAS,OAAO,CAAC;AAAA,IACrE;AACA,WAAO,KAAK,YAAoB,aAAa,UAAU,QAAQ,OAAO;AAAA,EACxE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,kBACK,MACwD;AAC3D,UAAM,CAAC,WAAW,QAAQ,OAAO,IAAI;AACrC,UAAM,UAAM,kCAAgB,SAAS;AACrC,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,QAAQ;AAAA,IACxB;AACA,WAAO,KAAK,YAAoB,aAAa,CAAC,GAAG,QAAQ,OAAO;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,6BACK,MACwD;AAC3D,UAAM,CAAC,QAAQ,OAAO,IAAI;AAC1B,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,UAAU,QAAQ,SAAS,OAAO,SAAS,WAAW;AAAA,IACtE;AACA,WAAO,KAAK,YAAoB,aAAa,CAAC,GAAG,QAAQ,OAAO;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,eACE,QACA,SAC2D;AAC3D,WAAO,KAAK,YAAoB,MAAM,MAAM,CAAC,GAAG,QAAQ,OAAO;AAAA,EACjE;AAAA,EAEA,MAAgB,oBACd,WACA,WACA,mBAAmB,OACnB;AACA,eAAW,YAAY,KAAK,WAAW;AACrC,eAAS,WAAW,SAAS;AAAA,IAC/B;AACA,QAAI,kBAAkB;AAqBpB,YAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,CAAC,CAAC;AAAA,IACvD;AAAA,EACF;AAAA,EAEA,MAAuB,UAAU,SAAS;AACxC,UAAM,SAAS,MAAM,KAAK,SAAS,IAAI,GAAG,IAAI;AAC9C,SAAK,oBAAoB,EAAE,OAAO,CAAC;AACnC,WAAO;AAAA,EACT;AAAA,EAEA,MAAuB,UAAU,SAAS;AACxC,UAAM,YAAY,MAAM,KAAK,SAAS,IAAQ,GAAG,IAAI;AACrD,UAAM,gBAAgB,KAAK,CAAC;AAC5B,UAAM,YAAgC;AAAA,MACpC,GAAG;AAAA,MACH,OAAO,cAAc;AAAA,MACrB,UAAU,cAAc;AAAA,MACxB,SAAS,cAAc;AAAA,IACzB;AACA,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,QAA2B,UAAU,SAAS;AAC5C,UAAM,YAAY,MAAM,KAAK,SAAS,MAAM,GAAG,IAAI;AACnD,UAAM,YAAgC,EAAE,GAAG,UAAU;AACrD,eAAW,QAAQ,CAAC,SAAS,YAAY,SAAS,GAAY;AAC5D,+CAAmB,MAAM,KAAK,YAAY,MAAM,KAAK,CAAC,GAAG,SAAS;AAAA,IACpE;AACA,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,SAA6B,UAAU,SAAS;AAC9C,UAAM,YAAY,MAAM,KAAK,SAAS,OAAO,GAAG,IAAI;AACpD,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEU,qBACR,UACsC;AACtC,UAAM,QAAQ;AACd,WAAQ,mBAAmB;AACzB,aAAO,MAAM;AACX,cAAM,SAAS,MAAM,SAAS,KAAK;AACnC,YAAI,OAAO,MAAM;AACf,gBAAM,EAAE,UAAU,WAAW,OAAO,IAAI,OAAO;AAC/C,iBAAO;AAAA,YACL,UAAU,MAAM,MAAM,qBAA6B,UAAU,CAAC;AAAA,YAC9D;AAAA,UACF;AAAA,QACF;AACA,YAAI,CAAC,OAAO,MAAM,OAAO;AACvB,gBAAM;AAAA,YACJ,OAAO;AAAA,UACT;AAAA,QACF;AACA,cAAM,OAAO;AAAA,MACf;AAAA,IACF,EAAG;AAAA,EACL;AAAA,EAEU,aACR,UAC8B;AAC9B,UAAM,UAAU,KAAK,qBAA6B,QAAQ;AAC1D,WAAQ,mBAAmB;AAEzB,aAAO,MAAM;AACX,cAAM,SAAS,MAAM,QAAQ,KAAK;AAClC,YAAI,OAAO,KAAM,QAAO,OAAO;AAC/B,YAAI,OAAO,MAAM,SAAS,CAAC,OAAO,MAAM,UAAW,OAAM,OAAO;AAAA,MAClE;AAAA,IACF,EAAG;AAAA,EACL;AAAA,EAEA,WAAiC,IAAI,SAAS;AAC5C,UAAM,WAAW,KAAK,SAAS,SAAS,GAAG,IAAI;AAC/C,WAAO,KAAK,aAA+B,QAAQ;AAAA,EACrD;AAAA,EAEA,iBAA6C,IAAI,SAAS;AACxD,UAAM,WAAW,KAAK,SAAS,eAAe,GAAG,IAAI;AACrD,WAAO,KAAK,aAA+B,QAAQ;AAAA,EACrD;AAAA,EAEA,uBAAyD,IAAI,SAAS;AAEpE,WAAO,KAAK,SAAS,qBAAqB,GAAG,IAAI;AAAA,EACnD;AACF;",
+  "sourcesContent": ["import type Ajv from \"ajv\";\nimport { Graffiti } from \"@graffiti-garden/api\";\nimport type {\n  GraffitiSession,\n  JSONSchema,\n  GraffitiObjectStream,\n  GraffitiObjectStreamContinueEntry,\n  GraffitiObjectStreamContinue,\n  GraffitiObject,\n} from \"@graffiti-garden/api\";\nimport type { GraffitiObjectBase } from \"@graffiti-garden/api\";\nimport { Repeater } from \"@repeaterjs/repeater\";\nimport type { applyPatch } from \"fast-json-patch\";\nimport {\n  applyGraffitiPatch,\n  compileGraffitiObjectSchema,\n  isActorAllowedGraffitiObject,\n  maskGraffitiObject,\n  unpackObjectUrl,\n} from \"@graffiti-garden/implementation-local/utilities\";\nexport type * from \"@graffiti-garden/api\";\n\nexport type GraffitiSynchronizeCallback = (\n  oldObject: GraffitiObjectStreamContinueEntry<{}>,\n  newObject?: GraffitiObjectStreamContinueEntry<{}>,\n) => void;\n\nexport interface GraffitiSynchronizeOptions {\n  /**\n   * Allows synchronize to listen to all objects, not just those\n   * that the session is allowed to see. This is useful to get a\n   * global view of all Graffiti objects passsing through the system,\n   * for example to build a client-side cache. Additional mechanisms\n   * should be in place to ensure that users do not see objects or\n   * properties they are not allowed to see.\n   *\n   * Default: `false`\n   */\n  omniscient?: boolean;\n}\n\n/**\n * Wraps the [Graffiti API](https://api.graffiti.garden/classes/Graffiti.html)\n * so that changes made or received in one part of an application\n * are automatically routed to other parts of the application.\n * This is an important tool for building responsive\n * and consistent user interfaces, and is built upon to make\n * the [Graffiti Vue Plugin](https://vue.graffiti.garden/variables/GraffitiPlugin.html)\n * and possibly other front-end libraries in the future.\n *\n * [See a live example](/example).\n *\n * Specifically, this library provides the following *synchronize*\n * methods to correspond with each of the following Graffiti API methods:\n *\n * | API Method | Synchronize Method |\n * |------------|--------------------|\n * | {@link get} | {@link synchronizeGet} |\n * | {@link discover} | {@link synchronizeDiscover} |\n * | {@link recoverOrphans} | {@link synchronizeRecoverOrphans} |\n *\n * Whenever a change is made via {@link put}, {@link patch}, and {@link delete} or\n * received from {@link get}, {@link discover}, and {@link recoverOrphans},\n * those changes are forwarded to the appropriate synchronize method.\n * Each synchronize method returns an iterator that streams these changes\n * continually until the user calls `return` on the iterator or `break`s out of the loop,\n * allowing for live updates without additional polling.\n *\n * Example 1: Suppose a user publishes a post using {@link put}. If the feed\n * displaying that user's posts is using {@link synchronizeDiscover} to listen for changes,\n * then the user's new post will instantly appear in their feed, giving the UI a\n * responsive feel.\n *\n * Example 2: Suppose one of a user's friends changes their name. As soon as the\n * user's application receives one notice of that change (using {@link get}\n * or {@link discover}), then {@link synchronizeDiscover} listeners can be used to update\n * all instance's of that friend's name in the user's application instantly,\n * providing a consistent user experience.\n *\n * The source code for this library is [available on GitHub](https://github.com/graffiti-garden/wrapper-synchronize/).\n *\n * @groupDescription Synchronize Methods\n * This group contains methods that listen for changes made via\n * {@link put}, {@link patch}, and {@link delete} or fetched from\n * {@link get}, {@link discover}, and {@link recoverOrphans} and then\n * streams appropriate changes to provide a responsive and consistent user experience.\n */\nexport class GraffitiSynchronize extends Graffiti {\n  protected ajv_: Promise<Ajv> | undefined;\n  protected applyPatch_: Promise<typeof applyPatch> | undefined;\n  protected readonly graffiti: Graffiti;\n  protected readonly callbacks = new Set<GraffitiSynchronizeCallback>();\n  protected readonly options: GraffitiSynchronizeOptions;\n\n  channelStats: Graffiti[\"channelStats\"];\n  login: Graffiti[\"login\"];\n  logout: Graffiti[\"logout\"];\n  sessionEvents: Graffiti[\"sessionEvents\"];\n\n  protected get ajv() {\n    if (!this.ajv_) {\n      this.ajv_ = (async () => {\n        const { default: Ajv } = await import(\"ajv\");\n        return new Ajv({ strict: false });\n      })();\n    }\n    return this.ajv_;\n  }\n\n  protected get applyPatch() {\n    if (!this.applyPatch_) {\n      this.applyPatch_ = (async () => {\n        const { applyPatch } = await import(\"fast-json-patch\");\n        return applyPatch;\n      })();\n    }\n    return this.applyPatch_;\n  }\n\n  /**\n   * Wraps a Graffiti API instance to provide the synchronize methods.\n   * The GraffitiSyncrhonize class rather than the Graffiti class\n   * must be used for all functions for the synchronize methods to work.\n   */\n  constructor(\n    /**\n     * The [Graffiti API](https://api.graffiti.garden/classes/Graffiti.html)\n     * instance to wrap.\n     */\n    graffiti: Graffiti,\n    options?: GraffitiSynchronizeOptions,\n  ) {\n    super();\n    this.options = options ?? {};\n    this.graffiti = graffiti;\n    this.channelStats = graffiti.channelStats.bind(graffiti);\n    this.login = graffiti.login.bind(graffiti);\n    this.logout = graffiti.logout.bind(graffiti);\n    this.sessionEvents = graffiti.sessionEvents;\n  }\n\n  protected synchronize<Schema extends JSONSchema>(\n    matchObject: (object: GraffitiObjectBase) => boolean,\n    channels: string[],\n    schema: Schema,\n    session?: GraffitiSession | null,\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const seenUrls = new Set<string>();\n\n    const repeater = new Repeater<GraffitiObjectStreamContinueEntry<Schema>>(\n      async (push, stop) => {\n        const validate = compileGraffitiObjectSchema(await this.ajv, schema);\n        const callback: GraffitiSynchronizeCallback = (\n          oldObjectRaw,\n          newObjectRaw,\n        ) => {\n          for (const objectRaw of [newObjectRaw, oldObjectRaw]) {\n            if (objectRaw?.tombstone) {\n              if (seenUrls.has(objectRaw.object.url)) {\n                push(objectRaw);\n              }\n            } else if (\n              objectRaw &&\n              matchObject(objectRaw.object) &&\n              (this.options.omniscient ||\n                isActorAllowedGraffitiObject(objectRaw.object, session))\n            ) {\n              // Deep clone the object to prevent mutation\n              const object = JSON.parse(\n                JSON.stringify(objectRaw.object),\n              ) as GraffitiObject<{}>;\n              if (!this.options.omniscient) {\n                maskGraffitiObject(object, channels, session);\n              }\n              if (validate(object)) {\n                push({ object });\n                seenUrls.add(object.url);\n                break;\n              }\n            }\n          }\n        };\n\n        this.callbacks.add(callback);\n        await stop;\n        this.callbacks.delete(callback);\n      },\n    );\n\n    return (async function* () {\n      for await (const i of repeater) yield i;\n    })();\n  }\n\n  /**\n   * This method has the same signature as {@link discover} but listens for\n   * changes made via {@link put}, {@link patch}, and {@link delete} or\n   * fetched from {@link get}, {@link discover}, and {@link recoverOrphans}\n   * and then streams appropriate changes to provide a responsive and\n   * consistent user experience.\n   *\n   * Unlike {@link discover}, this method continuously listens for changes\n   * and will not terminate unless the user calls the `return` method on the iterator\n   * or `break`s out of the loop.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeDiscover<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.discover<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [channels, schema, session] = args;\n    function matchObject(object: GraffitiObjectBase) {\n      return object.channels.some((channel) => channels.includes(channel));\n    }\n    return this.synchronize<Schema>(matchObject, channels, schema, session);\n  }\n\n  /**\n   * This method has the same signature as {@link get} but\n   * listens for changes made via {@link put}, {@link patch}, and {@link delete} or\n   * fetched from {@link get}, {@link discover}, and {@link recoverOrphans} and then\n   * streams appropriate changes to provide a responsive and consistent user experience.\n   *\n   * Unlike {@link get}, which returns a single result, this method continuously\n   * listens for changes which are output as an asynchronous stream, similar\n   * to {@link discover}.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeGet<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.get<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [objectUrl, schema, session] = args;\n    const url = unpackObjectUrl(objectUrl);\n    function matchObject(object: GraffitiObjectBase) {\n      return object.url === url;\n    }\n    return this.synchronize<Schema>(matchObject, [], schema, session);\n  }\n\n  /**\n   * This method has the same signature as {@link recoverOrphans} but\n   * listens for changes made via\n   * {@link put}, {@link patch}, and {@link delete} or fetched from\n   * {@link get}, {@link discover}, and {@link recoverOrphans} and then\n   * streams appropriate changes to provide a responsive and consistent user experience.\n   *\n   * Unlike {@link recoverOrphans}, this method continuously listens for changes\n   * and will not terminate unless the user calls the `return` method on the iterator\n   * or `break`s out of the loop.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeRecoverOrphans<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.recoverOrphans<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [schema, session] = args;\n    function matchObject(object: GraffitiObjectBase) {\n      return object.actor === session.actor && object.channels.length === 0;\n    }\n    return this.synchronize<Schema>(matchObject, [], schema, session);\n  }\n\n  /**\n   * Streams changes made to *any* object in *any* channel\n   * and made by *any* user. You may want to use it in conjuction with\n   * {@link GraffitiSynchronizeOptions.omniscient} to get a global view\n   * of all Graffiti objects passing through the system. This is useful\n   * for building a client-side cache, for example.\n   *\n   * Be careful using this method. Without additional filters it can\n   * expose the user to content out of context.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeAll<Schema extends JSONSchema>(\n    schema: Schema,\n    session?: GraffitiSession | null,\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    return this.synchronize<Schema>(() => true, [], schema, session);\n  }\n\n  protected async synchronizeDispatch(\n    oldObject: GraffitiObjectStreamContinueEntry<{}>,\n    newObject?: GraffitiObjectStreamContinueEntry<{}>,\n    waitForListeners = false,\n  ) {\n    for (const callback of this.callbacks) {\n      callback(oldObject, newObject);\n    }\n    if (waitForListeners) {\n      // Wait for the listeners to receive\n      // their objects, before returning the operation\n      // that triggered them.\n      //\n      // This is important for mutators (put, patch, delete)\n      // to ensure the application state has been updated\n      // everywhere before returning, giving consistent\n      // feedback to the user that the operation has completed.\n      //\n      // The opposite is true for accessors (get, discover, recoverOrphans),\n      // where it is a weird user experience to call `get`\n      // in one place and have the application update\n      // somewhere else first. It is also less efficient.\n      //\n      // The hack is simply to await one \"macro task cycle\".\n      // We need to wait for this cycle rather than using\n      // `await push` in the callback, because it turns out\n      // that `await push` won't resolve until the following\n      // .next() call of the iterator, so if only\n      // one .next() is called, this dispatch will hang.\n      await new Promise((resolve) => setTimeout(resolve, 0));\n    }\n  }\n\n  get: Graffiti[\"get\"] = async (...args) => {\n    const object = await this.graffiti.get(...args);\n    this.synchronizeDispatch({ object });\n    return object;\n  };\n\n  put: Graffiti[\"put\"] = async (...args) => {\n    const oldObject = await this.graffiti.put<{}>(...args);\n    const partialObject = args[0];\n    const newObject: GraffitiObjectBase = {\n      ...oldObject,\n      value: partialObject.value,\n      channels: partialObject.channels,\n      allowed: partialObject.allowed,\n    };\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      {\n        object: newObject,\n      },\n      true,\n    );\n    return oldObject;\n  };\n\n  patch: Graffiti[\"patch\"] = async (...args) => {\n    const oldObject = await this.graffiti.patch(...args);\n    const newObject: GraffitiObjectBase = { ...oldObject };\n    for (const prop of [\"value\", \"channels\", \"allowed\"] as const) {\n      applyGraffitiPatch(await this.applyPatch, prop, args[0], newObject);\n    }\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      {\n        object: newObject,\n      },\n      true,\n    );\n    return oldObject;\n  };\n\n  delete: Graffiti[\"delete\"] = async (...args) => {\n    const oldObject = await this.graffiti.delete(...args);\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      undefined,\n      true,\n    );\n    return oldObject;\n  };\n\n  protected objectStreamContinue<Schema extends JSONSchema>(\n    iterator: GraffitiObjectStreamContinue<Schema>,\n  ): GraffitiObjectStreamContinue<Schema> {\n    const this_ = this;\n    return (async function* () {\n      while (true) {\n        const result = await iterator.next();\n        if (result.done) {\n          const { continue: continue_, cursor } = result.value;\n          return {\n            continue: () => this_.objectStreamContinue<Schema>(continue_()),\n            cursor,\n          };\n        }\n        if (!result.value.error) {\n          this_.synchronizeDispatch(\n            result.value as GraffitiObjectStreamContinueEntry<{}>,\n          );\n        }\n        yield result.value;\n      }\n    })();\n  }\n\n  protected objectStream<Schema extends JSONSchema>(\n    iterator: GraffitiObjectStream<Schema>,\n  ): GraffitiObjectStream<Schema> {\n    const wrapped = this.objectStreamContinue<Schema>(iterator);\n    return (async function* () {\n      // Filter out the tombstones for type safety\n      while (true) {\n        const result = await wrapped.next();\n        if (result.done) return result.value;\n        if (result.value.error || !result.value.tombstone) yield result.value;\n      }\n    })();\n  }\n\n  discover: Graffiti[\"discover\"] = (...args) => {\n    const iterator = this.graffiti.discover(...args);\n    return this.objectStream<(typeof args)[1]>(iterator);\n  };\n\n  recoverOrphans: Graffiti[\"recoverOrphans\"] = (...args) => {\n    const iterator = this.graffiti.recoverOrphans(...args);\n    return this.objectStream<(typeof args)[0]>(iterator);\n  };\n\n  continueObjectStream: Graffiti[\"continueObjectStream\"] = (...args) => {\n    const iterator = this.graffiti.continueObjectStream(...args);\n    return this.objectStreamContinue<{}>(iterator);\n  };\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,iBAAyB;AAUzB,sBAAyB;AAEzB,uBAMO;AAoEA,MAAM,4BAA4B,oBAAS;AAAA,EACtC;AAAA,EACA;AAAA,EACS;AAAA,EACA,YAAY,oBAAI,IAAiC;AAAA,EACjD;AAAA,EAEnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEA,IAAc,MAAM;AAClB,QAAI,CAAC,KAAK,MAAM;AACd,WAAK,QAAQ,YAAY;AACvB,cAAM,EAAE,SAAS,IAAI,IAAI,MAAM,OAAO,KAAK;AAC3C,eAAO,IAAI,IAAI,EAAE,QAAQ,MAAM,CAAC;AAAA,MAClC,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAc,aAAa;AACzB,QAAI,CAAC,KAAK,aAAa;AACrB,WAAK,eAAe,YAAY;AAC9B,cAAM,EAAE,WAAW,IAAI,MAAM,OAAO,iBAAiB;AACrD,eAAO;AAAA,MACT,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,YAKE,UACA,SACA;AACA,UAAM;AACN,SAAK,UAAU,WAAW,CAAC;AAC3B,SAAK,WAAW;AAChB,SAAK,eAAe,SAAS,aAAa,KAAK,QAAQ;AACvD,SAAK,QAAQ,SAAS,MAAM,KAAK,QAAQ;AACzC,SAAK,SAAS,SAAS,OAAO,KAAK,QAAQ;AAC3C,SAAK,gBAAgB,SAAS;AAAA,EAChC;AAAA,EAEU,YACR,aACA,UACA,QACA,SAC2D;AAC3D,UAAM,WAAW,oBAAI,IAAY;AAEjC,UAAM,WAAW,IAAI;AAAA,MACnB,OAAO,MAAM,SAAS;AACpB,cAAM,eAAW,8CAA4B,MAAM,KAAK,KAAK,MAAM;AACnE,cAAM,WAAwC,CAC5C,cACA,iBACG;AACH,qBAAW,aAAa,CAAC,cAAc,YAAY,GAAG;AACpD,gBAAI,WAAW,WAAW;AACxB,kBAAI,SAAS,IAAI,UAAU,OAAO,GAAG,GAAG;AACtC,qBAAK,SAAS;AAAA,cAChB;AAAA,YACF,WACE,aACA,YAAY,UAAU,MAAM,MAC3B,KAAK,QAAQ,kBACZ,+CAA6B,UAAU,QAAQ,OAAO,IACxD;AAEA,oBAAM,SAAS,KAAK;AAAA,gBAClB,KAAK,UAAU,UAAU,MAAM;AAAA,cACjC;AACA,kBAAI,CAAC,KAAK,QAAQ,YAAY;AAC5B,yDAAmB,QAAQ,UAAU,OAAO;AAAA,cAC9C;AACA,kBAAI,SAAS,MAAM,GAAG;AACpB,qBAAK,EAAE,OAAO,CAAC;AACf,yBAAS,IAAI,OAAO,GAAG;AACvB;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAEA,aAAK,UAAU,IAAI,QAAQ;AAC3B,cAAM;AACN,aAAK,UAAU,OAAO,QAAQ;AAAA,MAChC;AAAA,IACF;AAEA,YAAQ,mBAAmB;AACzB,uBAAiB,KAAK,SAAU,OAAM;AAAA,IACxC,GAAG;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,uBACK,MACwD;AAC3D,UAAM,CAAC,UAAU,QAAQ,OAAO,IAAI;AACpC,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,SAAS,KAAK,CAAC,YAAY,SAAS,SAAS,OAAO,CAAC;AAAA,IACrE;AACA,WAAO,KAAK,YAAoB,aAAa,UAAU,QAAQ,OAAO;AAAA,EACxE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,kBACK,MACwD;AAC3D,UAAM,CAAC,WAAW,QAAQ,OAAO,IAAI;AACrC,UAAM,UAAM,kCAAgB,SAAS;AACrC,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,QAAQ;AAAA,IACxB;AACA,WAAO,KAAK,YAAoB,aAAa,CAAC,GAAG,QAAQ,OAAO;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,6BACK,MACwD;AAC3D,UAAM,CAAC,QAAQ,OAAO,IAAI;AAC1B,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,UAAU,QAAQ,SAAS,OAAO,SAAS,WAAW;AAAA,IACtE;AACA,WAAO,KAAK,YAAoB,aAAa,CAAC,GAAG,QAAQ,OAAO;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,eACE,QACA,SAC2D;AAC3D,WAAO,KAAK,YAAoB,MAAM,MAAM,CAAC,GAAG,QAAQ,OAAO;AAAA,EACjE;AAAA,EAEA,MAAgB,oBACd,WACA,WACA,mBAAmB,OACnB;AACA,eAAW,YAAY,KAAK,WAAW;AACrC,eAAS,WAAW,SAAS;AAAA,IAC/B;AACA,QAAI,kBAAkB;AAqBpB,YAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,CAAC,CAAC;AAAA,IACvD;AAAA,EACF;AAAA,EAEA,MAAuB,UAAU,SAAS;AACxC,UAAM,SAAS,MAAM,KAAK,SAAS,IAAI,GAAG,IAAI;AAC9C,SAAK,oBAAoB,EAAE,OAAO,CAAC;AACnC,WAAO;AAAA,EACT;AAAA,EAEA,MAAuB,UAAU,SAAS;AACxC,UAAM,YAAY,MAAM,KAAK,SAAS,IAAQ,GAAG,IAAI;AACrD,UAAM,gBAAgB,KAAK,CAAC;AAC5B,UAAM,YAAgC;AAAA,MACpC,GAAG;AAAA,MACH,OAAO,cAAc;AAAA,MACrB,UAAU,cAAc;AAAA,MACxB,SAAS,cAAc;AAAA,IACzB;AACA,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,QAA2B,UAAU,SAAS;AAC5C,UAAM,YAAY,MAAM,KAAK,SAAS,MAAM,GAAG,IAAI;AACnD,UAAM,YAAgC,EAAE,GAAG,UAAU;AACrD,eAAW,QAAQ,CAAC,SAAS,YAAY,SAAS,GAAY;AAC5D,+CAAmB,MAAM,KAAK,YAAY,MAAM,KAAK,CAAC,GAAG,SAAS;AAAA,IACpE;AACA,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,SAA6B,UAAU,SAAS;AAC9C,UAAM,YAAY,MAAM,KAAK,SAAS,OAAO,GAAG,IAAI;AACpD,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEU,qBACR,UACsC;AACtC,UAAM,QAAQ;AACd,YAAQ,mBAAmB;AACzB,aAAO,MAAM;AACX,cAAM,SAAS,MAAM,SAAS,KAAK;AACnC,YAAI,OAAO,MAAM;AACf,gBAAM,EAAE,UAAU,WAAW,OAAO,IAAI,OAAO;AAC/C,iBAAO;AAAA,YACL,UAAU,MAAM,MAAM,qBAA6B,UAAU,CAAC;AAAA,YAC9D;AAAA,UACF;AAAA,QACF;AACA,YAAI,CAAC,OAAO,MAAM,OAAO;AACvB,gBAAM;AAAA,YACJ,OAAO;AAAA,UACT;AAAA,QACF;AACA,cAAM,OAAO;AAAA,MACf;AAAA,IACF,GAAG;AAAA,EACL;AAAA,EAEU,aACR,UAC8B;AAC9B,UAAM,UAAU,KAAK,qBAA6B,QAAQ;AAC1D,YAAQ,mBAAmB;AAEzB,aAAO,MAAM;AACX,cAAM,SAAS,MAAM,QAAQ,KAAK;AAClC,YAAI,OAAO,KAAM,QAAO,OAAO;AAC/B,YAAI,OAAO,MAAM,SAAS,CAAC,OAAO,MAAM,UAAW,OAAM,OAAO;AAAA,MAClE;AAAA,IACF,GAAG;AAAA,EACL;AAAA,EAEA,WAAiC,IAAI,SAAS;AAC5C,UAAM,WAAW,KAAK,SAAS,SAAS,GAAG,IAAI;AAC/C,WAAO,KAAK,aAA+B,QAAQ;AAAA,EACrD;AAAA,EAEA,iBAA6C,IAAI,SAAS;AACxD,UAAM,WAAW,KAAK,SAAS,eAAe,GAAG,IAAI;AACrD,WAAO,KAAK,aAA+B,QAAQ;AAAA,EACrD;AAAA,EAEA,uBAAyD,IAAI,SAAS;AACpE,UAAM,WAAW,KAAK,SAAS,qBAAqB,GAAG,IAAI;AAC3D,WAAO,KAAK,qBAAyB,QAAQ;AAAA,EAC/C;AACF;",
   "names": []
 }

package/dist/esm/index.js

@@ -80,7 +80,9 @@ class GraffitiSynchronize extends Graffiti {
         this.callbacks.delete(callback);
       }
     );
-    return repeater;
+    return (async function* () {
+      for await (const i of repeater) yield i;
+    })();
   }
   /**
    * This method has the same signature as {@link discover} but listens for
@@ -151,6 +153,8 @@ class GraffitiSynchronize extends Graffiti {
    *
    * Be careful using this method. Without additional filters it can
    * expose the user to content out of context.
+   *
+   * @group Synchronize Methods
    */
   synchronizeAll(schema, session) {
     return this.synchronize(() => true, [], schema, session);
@@ -221,7 +225,7 @@ class GraffitiSynchronize extends Graffiti {
   };
   objectStreamContinue(iterator) {
     const this_ = this;
-    return async function* () {
+    return (async function* () {
       while (true) {
         const result = await iterator.next();
         if (result.done) {
@@ -238,17 +242,17 @@ class GraffitiSynchronize extends Graffiti {
         }
         yield result.value;
       }
-    }();
+    })();
   }
   objectStream(iterator) {
     const wrapped = this.objectStreamContinue(iterator);
-    return async function* () {
+    return (async function* () {
       while (true) {
         const result = await wrapped.next();
         if (result.done) return result.value;
         if (result.value.error || !result.value.tombstone) yield result.value;
       }
-    }();
+    })();
   }
   discover = (...args) => {
     const iterator = this.graffiti.discover(...args);
@@ -259,7 +263,8 @@ class GraffitiSynchronize extends Graffiti {
     return this.objectStream(iterator);
   };
   continueObjectStream = (...args) => {
-    return this.graffiti.continueObjectStream(...args);
+    const iterator = this.graffiti.continueObjectStream(...args);
+    return this.objectStreamContinue(iterator);
   };
 }
 export {

package/dist/esm/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/index.ts"],
-  "sourcesContent": ["import type Ajv from \"ajv\";\nimport { Graffiti } from \"@graffiti-garden/api\";\nimport type {\n  GraffitiSession,\n  JSONSchema,\n  GraffitiObjectStream,\n  GraffitiObjectStreamContinueEntry,\n  GraffitiObjectStreamContinue,\n  GraffitiObject,\n} from \"@graffiti-garden/api\";\nimport type { GraffitiObjectBase } from \"@graffiti-garden/api\";\nimport { Repeater } from \"@repeaterjs/repeater\";\nimport type { applyPatch } from \"fast-json-patch\";\nimport {\n  applyGraffitiPatch,\n  compileGraffitiObjectSchema,\n  isActorAllowedGraffitiObject,\n  maskGraffitiObject,\n  unpackObjectUrl,\n} from \"@graffiti-garden/implementation-local/utilities\";\nexport type * from \"@graffiti-garden/api\";\n\nexport type GraffitiSynchronizeCallback = (\n  oldObject: GraffitiObjectStreamContinueEntry<{}>,\n  newObject?: GraffitiObjectStreamContinueEntry<{}>,\n) => void;\n\nexport interface GraffitiSynchronizeOptions {\n  /**\n   * Allows synchronize to listen to all objects, not just those\n   * that the session is allowed to see. This is useful to get a\n   * global view of all Graffiti objects passsing through the system,\n   * for example to build a client-side cache. Additional mechanisms\n   * should be in place to ensure that users do not see objects or\n   * properties they are not allowed to see.\n   *\n   * Default: `false`\n   */\n  omniscient?: boolean;\n}\n\n/**\n * Wraps the [Graffiti API](https://api.graffiti.garden/classes/Graffiti.html)\n * so that changes made or received in one part of an application\n * are automatically routed to other parts of the application.\n * This is an important tool for building responsive\n * and consistent user interfaces, and is built upon to make\n * the [Graffiti Vue Plugin](https://vue.graffiti.garden/variables/GraffitiPlugin.html)\n * and possibly other front-end libraries in the future.\n *\n * Specifically, it provides the following *synchronize*\n * methods for each of the following API methods:\n *\n * | API Method | Synchronize Method |\n * |------------|--------------------|\n * | {@link get} | {@link synchronizeGet} |\n * | {@link discover} | {@link synchronizeDiscover} |\n * | {@link recoverOrphans} | {@link synchronizeRecoverOrphans} |\n *\n * Whenever a change is made via {@link put}, {@link patch}, and {@link delete} or\n * received from {@link get}, {@link discover}, and {@link recoverOrphans},\n * those changes are forwarded to the appropriate synchronize method.\n * Each synchronize method returns an iterator that streams these changes\n * continually until the user calls `return` on the iterator or `break`s out of the loop,\n * allowing for live updates without additional polling.\n *\n * Example 1: Suppose a user publishes a post using {@link put}. If the feed\n * displaying that user's posts is using {@link synchronizeDiscover} to listen for changes,\n * then the user's new post will instantly appear in their feed, giving the UI a\n * responsive feel.\n *\n * Example 2: Suppose one of a user's friends changes their name. As soon as the\n * user's application receives one notice of that change (using {@link get}\n * or {@link discover}), then {@link synchronizeDiscover} listeners can be used to update\n * all instance's of that friend's name in the user's application instantly,\n * providing a consistent user experience.\n *\n * @groupDescription Synchronize Methods\n * This group contains methods that listen for changes made via\n * {@link put}, {@link patch}, and {@link delete} or fetched from\n * {@link get}, {@link discover}, and {@link recoverOrphans} and then\n * streams appropriate changes to provide a responsive and consistent user experience.\n */\nexport class GraffitiSynchronize extends Graffiti {\n  protected ajv_: Promise<Ajv> | undefined;\n  protected applyPatch_: Promise<typeof applyPatch> | undefined;\n  protected readonly graffiti: Graffiti;\n  protected readonly callbacks = new Set<GraffitiSynchronizeCallback>();\n  protected readonly options: GraffitiSynchronizeOptions;\n\n  channelStats: Graffiti[\"channelStats\"];\n  login: Graffiti[\"login\"];\n  logout: Graffiti[\"logout\"];\n  sessionEvents: Graffiti[\"sessionEvents\"];\n\n  get ajv() {\n    if (!this.ajv_) {\n      this.ajv_ = (async () => {\n        const { default: Ajv } = await import(\"ajv\");\n        return new Ajv({ strict: false });\n      })();\n    }\n    return this.ajv_;\n  }\n\n  get applyPatch() {\n    if (!this.applyPatch_) {\n      this.applyPatch_ = (async () => {\n        const { applyPatch } = await import(\"fast-json-patch\");\n        return applyPatch;\n      })();\n    }\n    return this.applyPatch_;\n  }\n\n  /**\n   * Wraps a Graffiti API instance to provide the synchronize methods.\n   * The GraffitiSyncrhonize class rather than the Graffiti class\n   * must be used for all functions for the synchronize methods to work.\n   */\n  constructor(\n    /**\n     * The [Graffiti API](https://api.graffiti.garden/classes/Graffiti.html)\n     * instance to wrap.\n     */\n    graffiti: Graffiti,\n    options?: GraffitiSynchronizeOptions,\n  ) {\n    super();\n    this.options = options ?? {};\n    this.graffiti = graffiti;\n    this.channelStats = graffiti.channelStats.bind(graffiti);\n    this.login = graffiti.login.bind(graffiti);\n    this.logout = graffiti.logout.bind(graffiti);\n    this.sessionEvents = graffiti.sessionEvents;\n  }\n\n  protected synchronize<Schema extends JSONSchema>(\n    matchObject: (object: GraffitiObjectBase) => boolean,\n    channels: string[],\n    schema: Schema,\n    session?: GraffitiSession | null,\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const seenUrls = new Set<string>();\n\n    const repeater = new Repeater<GraffitiObjectStreamContinueEntry<Schema>>(\n      async (push, stop) => {\n        const validate = compileGraffitiObjectSchema(await this.ajv, schema);\n        const callback: GraffitiSynchronizeCallback = (\n          oldObjectRaw,\n          newObjectRaw,\n        ) => {\n          for (const objectRaw of [newObjectRaw, oldObjectRaw]) {\n            if (objectRaw?.tombstone) {\n              if (seenUrls.has(objectRaw.object.url)) {\n                push(objectRaw);\n              }\n            } else if (\n              objectRaw &&\n              matchObject(objectRaw.object) &&\n              (this.options.omniscient ||\n                isActorAllowedGraffitiObject(objectRaw.object, session))\n            ) {\n              // Deep clone the object to prevent mutation\n              const object = JSON.parse(\n                JSON.stringify(objectRaw.object),\n              ) as GraffitiObject<{}>;\n              if (!this.options.omniscient) {\n                maskGraffitiObject(object, channels, session);\n              }\n              if (validate(object)) {\n                push({ object });\n                seenUrls.add(object.url);\n                break;\n              }\n            }\n          }\n        };\n\n        this.callbacks.add(callback);\n        await stop;\n        this.callbacks.delete(callback);\n      },\n    );\n\n    return repeater;\n  }\n\n  /**\n   * This method has the same signature as {@link discover} but listens for\n   * changes made via {@link put}, {@link patch}, and {@link delete} or\n   * fetched from {@link get}, {@link discover}, and {@link recoverOrphans}\n   * and then streams appropriate changes to provide a responsive and\n   * consistent user experience.\n   *\n   * Unlike {@link discover}, this method continuously listens for changes\n   * and will not terminate unless the user calls the `return` method on the iterator\n   * or `break`s out of the loop.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeDiscover<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.discover<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [channels, schema, session] = args;\n    function matchObject(object: GraffitiObjectBase) {\n      return object.channels.some((channel) => channels.includes(channel));\n    }\n    return this.synchronize<Schema>(matchObject, channels, schema, session);\n  }\n\n  /**\n   * This method has the same signature as {@link get} but\n   * listens for changes made via {@link put}, {@link patch}, and {@link delete} or\n   * fetched from {@link get}, {@link discover}, and {@link recoverOrphans} and then\n   * streams appropriate changes to provide a responsive and consistent user experience.\n   *\n   * Unlike {@link get}, which returns a single result, this method continuously\n   * listens for changes which are output as an asynchronous stream, similar\n   * to {@link discover}.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeGet<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.get<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [objectUrl, schema, session] = args;\n    const url = unpackObjectUrl(objectUrl);\n    function matchObject(object: GraffitiObjectBase) {\n      return object.url === url;\n    }\n    return this.synchronize<Schema>(matchObject, [], schema, session);\n  }\n\n  /**\n   * This method has the same signature as {@link recoverOrphans} but\n   * listens for changes made via\n   * {@link put}, {@link patch}, and {@link delete} or fetched from\n   * {@link get}, {@link discover}, and {@link recoverOrphans} and then\n   * streams appropriate changes to provide a responsive and consistent user experience.\n   *\n   * Unlike {@link recoverOrphans}, this method continuously listens for changes\n   * and will not terminate unless the user calls the `return` method on the iterator\n   * or `break`s out of the loop.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeRecoverOrphans<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.recoverOrphans<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [schema, session] = args;\n    function matchObject(object: GraffitiObjectBase) {\n      return object.actor === session.actor && object.channels.length === 0;\n    }\n    return this.synchronize<Schema>(matchObject, [], schema, session);\n  }\n\n  /**\n   * Streams changes made to *any* object in *any* channel\n   * and made by *any* user. You may want to use it in conjuction with\n   * {@link GraffitiSynchronizeOptions.omniscient} to get a global view\n   * of all Graffiti objects passing through the system. This is useful\n   * for building a client-side cache, for example.\n   *\n   * Be careful using this method. Without additional filters it can\n   * expose the user to content out of context.\n   */\n  synchronizeAll<Schema extends JSONSchema>(\n    schema: Schema,\n    session?: GraffitiSession | null,\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    return this.synchronize<Schema>(() => true, [], schema, session);\n  }\n\n  protected async synchronizeDispatch(\n    oldObject: GraffitiObjectStreamContinueEntry<{}>,\n    newObject?: GraffitiObjectStreamContinueEntry<{}>,\n    waitForListeners = false,\n  ) {\n    for (const callback of this.callbacks) {\n      callback(oldObject, newObject);\n    }\n    if (waitForListeners) {\n      // Wait for the listeners to receive\n      // their objects, before returning the operation\n      // that triggered them.\n      //\n      // This is important for mutators (put, patch, delete)\n      // to ensure the application state has been updated\n      // everywhere before returning, giving consistent\n      // feedback to the user that the operation has completed.\n      //\n      // The opposite is true for accessors (get, discover, recoverOrphans),\n      // where it is a weird user experience to call `get`\n      // in one place and have the application update\n      // somewhere else first. It is also less efficient.\n      //\n      // The hack is simply to await one \"macro task cycle\".\n      // We need to wait for this cycle rather than using\n      // `await push` in the callback, because it turns out\n      // that `await push` won't resolve until the following\n      // .next() call of the iterator, so if only\n      // one .next() is called, this dispatch will hang.\n      await new Promise((resolve) => setTimeout(resolve, 0));\n    }\n  }\n\n  get: Graffiti[\"get\"] = async (...args) => {\n    const object = await this.graffiti.get(...args);\n    this.synchronizeDispatch({ object });\n    return object;\n  };\n\n  put: Graffiti[\"put\"] = async (...args) => {\n    const oldObject = await this.graffiti.put<{}>(...args);\n    const partialObject = args[0];\n    const newObject: GraffitiObjectBase = {\n      ...oldObject,\n      value: partialObject.value,\n      channels: partialObject.channels,\n      allowed: partialObject.allowed,\n    };\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      {\n        object: newObject,\n      },\n      true,\n    );\n    return oldObject;\n  };\n\n  patch: Graffiti[\"patch\"] = async (...args) => {\n    const oldObject = await this.graffiti.patch(...args);\n    const newObject: GraffitiObjectBase = { ...oldObject };\n    for (const prop of [\"value\", \"channels\", \"allowed\"] as const) {\n      applyGraffitiPatch(await this.applyPatch, prop, args[0], newObject);\n    }\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      {\n        object: newObject,\n      },\n      true,\n    );\n    return oldObject;\n  };\n\n  delete: Graffiti[\"delete\"] = async (...args) => {\n    const oldObject = await this.graffiti.delete(...args);\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      undefined,\n      true,\n    );\n    return oldObject;\n  };\n\n  protected objectStreamContinue<Schema extends JSONSchema>(\n    iterator: GraffitiObjectStreamContinue<Schema>,\n  ): GraffitiObjectStreamContinue<Schema> {\n    const this_ = this;\n    return (async function* () {\n      while (true) {\n        const result = await iterator.next();\n        if (result.done) {\n          const { continue: continue_, cursor } = result.value;\n          return {\n            continue: () => this_.objectStreamContinue<Schema>(continue_()),\n            cursor,\n          };\n        }\n        if (!result.value.error) {\n          this_.synchronizeDispatch(\n            result.value as GraffitiObjectStreamContinueEntry<{}>,\n          );\n        }\n        yield result.value;\n      }\n    })();\n  }\n\n  protected objectStream<Schema extends JSONSchema>(\n    iterator: GraffitiObjectStream<Schema>,\n  ): GraffitiObjectStream<Schema> {\n    const wrapped = this.objectStreamContinue<Schema>(iterator);\n    return (async function* () {\n      // Filter out the tombstones for type safety\n      while (true) {\n        const result = await wrapped.next();\n        if (result.done) return result.value;\n        if (result.value.error || !result.value.tombstone) yield result.value;\n      }\n    })();\n  }\n\n  discover: Graffiti[\"discover\"] = (...args) => {\n    const iterator = this.graffiti.discover(...args);\n    return this.objectStream<(typeof args)[1]>(iterator);\n  };\n\n  recoverOrphans: Graffiti[\"recoverOrphans\"] = (...args) => {\n    const iterator = this.graffiti.recoverOrphans(...args);\n    return this.objectStream<(typeof args)[0]>(iterator);\n  };\n\n  continueObjectStream: Graffiti[\"continueObjectStream\"] = (...args) => {\n    // TODO!!\n    return this.graffiti.continueObjectStream(...args);\n  };\n}\n"],
-  "mappings": "AACA,SAAS,gBAAgB;AAUzB,SAAS,gBAAgB;AAEzB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAgEA,MAAM,4BAA4B,SAAS;AAAA,EACtC;AAAA,EACA;AAAA,EACS;AAAA,EACA,YAAY,oBAAI,IAAiC;AAAA,EACjD;AAAA,EAEnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEA,IAAI,MAAM;AACR,QAAI,CAAC,KAAK,MAAM;AACd,WAAK,QAAQ,YAAY;AACvB,cAAM,EAAE,SAAS,IAAI,IAAI,MAAM,OAAO,KAAK;AAC3C,eAAO,IAAI,IAAI,EAAE,QAAQ,MAAM,CAAC;AAAA,MAClC,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,aAAa;AACf,QAAI,CAAC,KAAK,aAAa;AACrB,WAAK,eAAe,YAAY;AAC9B,cAAM,EAAE,WAAW,IAAI,MAAM,OAAO,iBAAiB;AACrD,eAAO;AAAA,MACT,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,YAKE,UACA,SACA;AACA,UAAM;AACN,SAAK,UAAU,WAAW,CAAC;AAC3B,SAAK,WAAW;AAChB,SAAK,eAAe,SAAS,aAAa,KAAK,QAAQ;AACvD,SAAK,QAAQ,SAAS,MAAM,KAAK,QAAQ;AACzC,SAAK,SAAS,SAAS,OAAO,KAAK,QAAQ;AAC3C,SAAK,gBAAgB,SAAS;AAAA,EAChC;AAAA,EAEU,YACR,aACA,UACA,QACA,SAC2D;AAC3D,UAAM,WAAW,oBAAI,IAAY;AAEjC,UAAM,WAAW,IAAI;AAAA,MACnB,OAAO,MAAM,SAAS;AACpB,cAAM,WAAW,4BAA4B,MAAM,KAAK,KAAK,MAAM;AACnE,cAAM,WAAwC,CAC5C,cACA,iBACG;AACH,qBAAW,aAAa,CAAC,cAAc,YAAY,GAAG;AACpD,gBAAI,WAAW,WAAW;AACxB,kBAAI,SAAS,IAAI,UAAU,OAAO,GAAG,GAAG;AACtC,qBAAK,SAAS;AAAA,cAChB;AAAA,YACF,WACE,aACA,YAAY,UAAU,MAAM,MAC3B,KAAK,QAAQ,cACZ,6BAA6B,UAAU,QAAQ,OAAO,IACxD;AAEA,oBAAM,SAAS,KAAK;AAAA,gBAClB,KAAK,UAAU,UAAU,MAAM;AAAA,cACjC;AACA,kBAAI,CAAC,KAAK,QAAQ,YAAY;AAC5B,mCAAmB,QAAQ,UAAU,OAAO;AAAA,cAC9C;AACA,kBAAI,SAAS,MAAM,GAAG;AACpB,qBAAK,EAAE,OAAO,CAAC;AACf,yBAAS,IAAI,OAAO,GAAG;AACvB;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAEA,aAAK,UAAU,IAAI,QAAQ;AAC3B,cAAM;AACN,aAAK,UAAU,OAAO,QAAQ;AAAA,MAChC;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,uBACK,MACwD;AAC3D,UAAM,CAAC,UAAU,QAAQ,OAAO,IAAI;AACpC,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,SAAS,KAAK,CAAC,YAAY,SAAS,SAAS,OAAO,CAAC;AAAA,IACrE;AACA,WAAO,KAAK,YAAoB,aAAa,UAAU,QAAQ,OAAO;AAAA,EACxE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,kBACK,MACwD;AAC3D,UAAM,CAAC,WAAW,QAAQ,OAAO,IAAI;AACrC,UAAM,MAAM,gBAAgB,SAAS;AACrC,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,QAAQ;AAAA,IACxB;AACA,WAAO,KAAK,YAAoB,aAAa,CAAC,GAAG,QAAQ,OAAO;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,6BACK,MACwD;AAC3D,UAAM,CAAC,QAAQ,OAAO,IAAI;AAC1B,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,UAAU,QAAQ,SAAS,OAAO,SAAS,WAAW;AAAA,IACtE;AACA,WAAO,KAAK,YAAoB,aAAa,CAAC,GAAG,QAAQ,OAAO;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,eACE,QACA,SAC2D;AAC3D,WAAO,KAAK,YAAoB,MAAM,MAAM,CAAC,GAAG,QAAQ,OAAO;AAAA,EACjE;AAAA,EAEA,MAAgB,oBACd,WACA,WACA,mBAAmB,OACnB;AACA,eAAW,YAAY,KAAK,WAAW;AACrC,eAAS,WAAW,SAAS;AAAA,IAC/B;AACA,QAAI,kBAAkB;AAqBpB,YAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,CAAC,CAAC;AAAA,IACvD;AAAA,EACF;AAAA,EAEA,MAAuB,UAAU,SAAS;AACxC,UAAM,SAAS,MAAM,KAAK,SAAS,IAAI,GAAG,IAAI;AAC9C,SAAK,oBAAoB,EAAE,OAAO,CAAC;AACnC,WAAO;AAAA,EACT;AAAA,EAEA,MAAuB,UAAU,SAAS;AACxC,UAAM,YAAY,MAAM,KAAK,SAAS,IAAQ,GAAG,IAAI;AACrD,UAAM,gBAAgB,KAAK,CAAC;AAC5B,UAAM,YAAgC;AAAA,MACpC,GAAG;AAAA,MACH,OAAO,cAAc;AAAA,MACrB,UAAU,cAAc;AAAA,MACxB,SAAS,cAAc;AAAA,IACzB;AACA,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,QAA2B,UAAU,SAAS;AAC5C,UAAM,YAAY,MAAM,KAAK,SAAS,MAAM,GAAG,IAAI;AACnD,UAAM,YAAgC,EAAE,GAAG,UAAU;AACrD,eAAW,QAAQ,CAAC,SAAS,YAAY,SAAS,GAAY;AAC5D,yBAAmB,MAAM,KAAK,YAAY,MAAM,KAAK,CAAC,GAAG,SAAS;AAAA,IACpE;AACA,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,SAA6B,UAAU,SAAS;AAC9C,UAAM,YAAY,MAAM,KAAK,SAAS,OAAO,GAAG,IAAI;AACpD,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEU,qBACR,UACsC;AACtC,UAAM,QAAQ;AACd,WAAQ,mBAAmB;AACzB,aAAO,MAAM;AACX,cAAM,SAAS,MAAM,SAAS,KAAK;AACnC,YAAI,OAAO,MAAM;AACf,gBAAM,EAAE,UAAU,WAAW,OAAO,IAAI,OAAO;AAC/C,iBAAO;AAAA,YACL,UAAU,MAAM,MAAM,qBAA6B,UAAU,CAAC;AAAA,YAC9D;AAAA,UACF;AAAA,QACF;AACA,YAAI,CAAC,OAAO,MAAM,OAAO;AACvB,gBAAM;AAAA,YACJ,OAAO;AAAA,UACT;AAAA,QACF;AACA,cAAM,OAAO;AAAA,MACf;AAAA,IACF,EAAG;AAAA,EACL;AAAA,EAEU,aACR,UAC8B;AAC9B,UAAM,UAAU,KAAK,qBAA6B,QAAQ;AAC1D,WAAQ,mBAAmB;AAEzB,aAAO,MAAM;AACX,cAAM,SAAS,MAAM,QAAQ,KAAK;AAClC,YAAI,OAAO,KAAM,QAAO,OAAO;AAC/B,YAAI,OAAO,MAAM,SAAS,CAAC,OAAO,MAAM,UAAW,OAAM,OAAO;AAAA,MAClE;AAAA,IACF,EAAG;AAAA,EACL;AAAA,EAEA,WAAiC,IAAI,SAAS;AAC5C,UAAM,WAAW,KAAK,SAAS,SAAS,GAAG,IAAI;AAC/C,WAAO,KAAK,aAA+B,QAAQ;AAAA,EACrD;AAAA,EAEA,iBAA6C,IAAI,SAAS;AACxD,UAAM,WAAW,KAAK,SAAS,eAAe,GAAG,IAAI;AACrD,WAAO,KAAK,aAA+B,QAAQ;AAAA,EACrD;AAAA,EAEA,uBAAyD,IAAI,SAAS;AAEpE,WAAO,KAAK,SAAS,qBAAqB,GAAG,IAAI;AAAA,EACnD;AACF;",
+  "sourcesContent": ["import type Ajv from \"ajv\";\nimport { Graffiti } from \"@graffiti-garden/api\";\nimport type {\n  GraffitiSession,\n  JSONSchema,\n  GraffitiObjectStream,\n  GraffitiObjectStreamContinueEntry,\n  GraffitiObjectStreamContinue,\n  GraffitiObject,\n} from \"@graffiti-garden/api\";\nimport type { GraffitiObjectBase } from \"@graffiti-garden/api\";\nimport { Repeater } from \"@repeaterjs/repeater\";\nimport type { applyPatch } from \"fast-json-patch\";\nimport {\n  applyGraffitiPatch,\n  compileGraffitiObjectSchema,\n  isActorAllowedGraffitiObject,\n  maskGraffitiObject,\n  unpackObjectUrl,\n} from \"@graffiti-garden/implementation-local/utilities\";\nexport type * from \"@graffiti-garden/api\";\n\nexport type GraffitiSynchronizeCallback = (\n  oldObject: GraffitiObjectStreamContinueEntry<{}>,\n  newObject?: GraffitiObjectStreamContinueEntry<{}>,\n) => void;\n\nexport interface GraffitiSynchronizeOptions {\n  /**\n   * Allows synchronize to listen to all objects, not just those\n   * that the session is allowed to see. This is useful to get a\n   * global view of all Graffiti objects passsing through the system,\n   * for example to build a client-side cache. Additional mechanisms\n   * should be in place to ensure that users do not see objects or\n   * properties they are not allowed to see.\n   *\n   * Default: `false`\n   */\n  omniscient?: boolean;\n}\n\n/**\n * Wraps the [Graffiti API](https://api.graffiti.garden/classes/Graffiti.html)\n * so that changes made or received in one part of an application\n * are automatically routed to other parts of the application.\n * This is an important tool for building responsive\n * and consistent user interfaces, and is built upon to make\n * the [Graffiti Vue Plugin](https://vue.graffiti.garden/variables/GraffitiPlugin.html)\n * and possibly other front-end libraries in the future.\n *\n * [See a live example](/example).\n *\n * Specifically, this library provides the following *synchronize*\n * methods to correspond with each of the following Graffiti API methods:\n *\n * | API Method | Synchronize Method |\n * |------------|--------------------|\n * | {@link get} | {@link synchronizeGet} |\n * | {@link discover} | {@link synchronizeDiscover} |\n * | {@link recoverOrphans} | {@link synchronizeRecoverOrphans} |\n *\n * Whenever a change is made via {@link put}, {@link patch}, and {@link delete} or\n * received from {@link get}, {@link discover}, and {@link recoverOrphans},\n * those changes are forwarded to the appropriate synchronize method.\n * Each synchronize method returns an iterator that streams these changes\n * continually until the user calls `return` on the iterator or `break`s out of the loop,\n * allowing for live updates without additional polling.\n *\n * Example 1: Suppose a user publishes a post using {@link put}. If the feed\n * displaying that user's posts is using {@link synchronizeDiscover} to listen for changes,\n * then the user's new post will instantly appear in their feed, giving the UI a\n * responsive feel.\n *\n * Example 2: Suppose one of a user's friends changes their name. As soon as the\n * user's application receives one notice of that change (using {@link get}\n * or {@link discover}), then {@link synchronizeDiscover} listeners can be used to update\n * all instance's of that friend's name in the user's application instantly,\n * providing a consistent user experience.\n *\n * The source code for this library is [available on GitHub](https://github.com/graffiti-garden/wrapper-synchronize/).\n *\n * @groupDescription Synchronize Methods\n * This group contains methods that listen for changes made via\n * {@link put}, {@link patch}, and {@link delete} or fetched from\n * {@link get}, {@link discover}, and {@link recoverOrphans} and then\n * streams appropriate changes to provide a responsive and consistent user experience.\n */\nexport class GraffitiSynchronize extends Graffiti {\n  protected ajv_: Promise<Ajv> | undefined;\n  protected applyPatch_: Promise<typeof applyPatch> | undefined;\n  protected readonly graffiti: Graffiti;\n  protected readonly callbacks = new Set<GraffitiSynchronizeCallback>();\n  protected readonly options: GraffitiSynchronizeOptions;\n\n  channelStats: Graffiti[\"channelStats\"];\n  login: Graffiti[\"login\"];\n  logout: Graffiti[\"logout\"];\n  sessionEvents: Graffiti[\"sessionEvents\"];\n\n  protected get ajv() {\n    if (!this.ajv_) {\n      this.ajv_ = (async () => {\n        const { default: Ajv } = await import(\"ajv\");\n        return new Ajv({ strict: false });\n      })();\n    }\n    return this.ajv_;\n  }\n\n  protected get applyPatch() {\n    if (!this.applyPatch_) {\n      this.applyPatch_ = (async () => {\n        const { applyPatch } = await import(\"fast-json-patch\");\n        return applyPatch;\n      })();\n    }\n    return this.applyPatch_;\n  }\n\n  /**\n   * Wraps a Graffiti API instance to provide the synchronize methods.\n   * The GraffitiSyncrhonize class rather than the Graffiti class\n   * must be used for all functions for the synchronize methods to work.\n   */\n  constructor(\n    /**\n     * The [Graffiti API](https://api.graffiti.garden/classes/Graffiti.html)\n     * instance to wrap.\n     */\n    graffiti: Graffiti,\n    options?: GraffitiSynchronizeOptions,\n  ) {\n    super();\n    this.options = options ?? {};\n    this.graffiti = graffiti;\n    this.channelStats = graffiti.channelStats.bind(graffiti);\n    this.login = graffiti.login.bind(graffiti);\n    this.logout = graffiti.logout.bind(graffiti);\n    this.sessionEvents = graffiti.sessionEvents;\n  }\n\n  protected synchronize<Schema extends JSONSchema>(\n    matchObject: (object: GraffitiObjectBase) => boolean,\n    channels: string[],\n    schema: Schema,\n    session?: GraffitiSession | null,\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const seenUrls = new Set<string>();\n\n    const repeater = new Repeater<GraffitiObjectStreamContinueEntry<Schema>>(\n      async (push, stop) => {\n        const validate = compileGraffitiObjectSchema(await this.ajv, schema);\n        const callback: GraffitiSynchronizeCallback = (\n          oldObjectRaw,\n          newObjectRaw,\n        ) => {\n          for (const objectRaw of [newObjectRaw, oldObjectRaw]) {\n            if (objectRaw?.tombstone) {\n              if (seenUrls.has(objectRaw.object.url)) {\n                push(objectRaw);\n              }\n            } else if (\n              objectRaw &&\n              matchObject(objectRaw.object) &&\n              (this.options.omniscient ||\n                isActorAllowedGraffitiObject(objectRaw.object, session))\n            ) {\n              // Deep clone the object to prevent mutation\n              const object = JSON.parse(\n                JSON.stringify(objectRaw.object),\n              ) as GraffitiObject<{}>;\n              if (!this.options.omniscient) {\n                maskGraffitiObject(object, channels, session);\n              }\n              if (validate(object)) {\n                push({ object });\n                seenUrls.add(object.url);\n                break;\n              }\n            }\n          }\n        };\n\n        this.callbacks.add(callback);\n        await stop;\n        this.callbacks.delete(callback);\n      },\n    );\n\n    return (async function* () {\n      for await (const i of repeater) yield i;\n    })();\n  }\n\n  /**\n   * This method has the same signature as {@link discover} but listens for\n   * changes made via {@link put}, {@link patch}, and {@link delete} or\n   * fetched from {@link get}, {@link discover}, and {@link recoverOrphans}\n   * and then streams appropriate changes to provide a responsive and\n   * consistent user experience.\n   *\n   * Unlike {@link discover}, this method continuously listens for changes\n   * and will not terminate unless the user calls the `return` method on the iterator\n   * or `break`s out of the loop.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeDiscover<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.discover<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [channels, schema, session] = args;\n    function matchObject(object: GraffitiObjectBase) {\n      return object.channels.some((channel) => channels.includes(channel));\n    }\n    return this.synchronize<Schema>(matchObject, channels, schema, session);\n  }\n\n  /**\n   * This method has the same signature as {@link get} but\n   * listens for changes made via {@link put}, {@link patch}, and {@link delete} or\n   * fetched from {@link get}, {@link discover}, and {@link recoverOrphans} and then\n   * streams appropriate changes to provide a responsive and consistent user experience.\n   *\n   * Unlike {@link get}, which returns a single result, this method continuously\n   * listens for changes which are output as an asynchronous stream, similar\n   * to {@link discover}.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeGet<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.get<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [objectUrl, schema, session] = args;\n    const url = unpackObjectUrl(objectUrl);\n    function matchObject(object: GraffitiObjectBase) {\n      return object.url === url;\n    }\n    return this.synchronize<Schema>(matchObject, [], schema, session);\n  }\n\n  /**\n   * This method has the same signature as {@link recoverOrphans} but\n   * listens for changes made via\n   * {@link put}, {@link patch}, and {@link delete} or fetched from\n   * {@link get}, {@link discover}, and {@link recoverOrphans} and then\n   * streams appropriate changes to provide a responsive and consistent user experience.\n   *\n   * Unlike {@link recoverOrphans}, this method continuously listens for changes\n   * and will not terminate unless the user calls the `return` method on the iterator\n   * or `break`s out of the loop.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeRecoverOrphans<Schema extends JSONSchema>(\n    ...args: Parameters<typeof Graffiti.prototype.recoverOrphans<Schema>>\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    const [schema, session] = args;\n    function matchObject(object: GraffitiObjectBase) {\n      return object.actor === session.actor && object.channels.length === 0;\n    }\n    return this.synchronize<Schema>(matchObject, [], schema, session);\n  }\n\n  /**\n   * Streams changes made to *any* object in *any* channel\n   * and made by *any* user. You may want to use it in conjuction with\n   * {@link GraffitiSynchronizeOptions.omniscient} to get a global view\n   * of all Graffiti objects passing through the system. This is useful\n   * for building a client-side cache, for example.\n   *\n   * Be careful using this method. Without additional filters it can\n   * expose the user to content out of context.\n   *\n   * @group Synchronize Methods\n   */\n  synchronizeAll<Schema extends JSONSchema>(\n    schema: Schema,\n    session?: GraffitiSession | null,\n  ): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>> {\n    return this.synchronize<Schema>(() => true, [], schema, session);\n  }\n\n  protected async synchronizeDispatch(\n    oldObject: GraffitiObjectStreamContinueEntry<{}>,\n    newObject?: GraffitiObjectStreamContinueEntry<{}>,\n    waitForListeners = false,\n  ) {\n    for (const callback of this.callbacks) {\n      callback(oldObject, newObject);\n    }\n    if (waitForListeners) {\n      // Wait for the listeners to receive\n      // their objects, before returning the operation\n      // that triggered them.\n      //\n      // This is important for mutators (put, patch, delete)\n      // to ensure the application state has been updated\n      // everywhere before returning, giving consistent\n      // feedback to the user that the operation has completed.\n      //\n      // The opposite is true for accessors (get, discover, recoverOrphans),\n      // where it is a weird user experience to call `get`\n      // in one place and have the application update\n      // somewhere else first. It is also less efficient.\n      //\n      // The hack is simply to await one \"macro task cycle\".\n      // We need to wait for this cycle rather than using\n      // `await push` in the callback, because it turns out\n      // that `await push` won't resolve until the following\n      // .next() call of the iterator, so if only\n      // one .next() is called, this dispatch will hang.\n      await new Promise((resolve) => setTimeout(resolve, 0));\n    }\n  }\n\n  get: Graffiti[\"get\"] = async (...args) => {\n    const object = await this.graffiti.get(...args);\n    this.synchronizeDispatch({ object });\n    return object;\n  };\n\n  put: Graffiti[\"put\"] = async (...args) => {\n    const oldObject = await this.graffiti.put<{}>(...args);\n    const partialObject = args[0];\n    const newObject: GraffitiObjectBase = {\n      ...oldObject,\n      value: partialObject.value,\n      channels: partialObject.channels,\n      allowed: partialObject.allowed,\n    };\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      {\n        object: newObject,\n      },\n      true,\n    );\n    return oldObject;\n  };\n\n  patch: Graffiti[\"patch\"] = async (...args) => {\n    const oldObject = await this.graffiti.patch(...args);\n    const newObject: GraffitiObjectBase = { ...oldObject };\n    for (const prop of [\"value\", \"channels\", \"allowed\"] as const) {\n      applyGraffitiPatch(await this.applyPatch, prop, args[0], newObject);\n    }\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      {\n        object: newObject,\n      },\n      true,\n    );\n    return oldObject;\n  };\n\n  delete: Graffiti[\"delete\"] = async (...args) => {\n    const oldObject = await this.graffiti.delete(...args);\n    await this.synchronizeDispatch(\n      {\n        tombstone: true,\n        object: oldObject,\n      },\n      undefined,\n      true,\n    );\n    return oldObject;\n  };\n\n  protected objectStreamContinue<Schema extends JSONSchema>(\n    iterator: GraffitiObjectStreamContinue<Schema>,\n  ): GraffitiObjectStreamContinue<Schema> {\n    const this_ = this;\n    return (async function* () {\n      while (true) {\n        const result = await iterator.next();\n        if (result.done) {\n          const { continue: continue_, cursor } = result.value;\n          return {\n            continue: () => this_.objectStreamContinue<Schema>(continue_()),\n            cursor,\n          };\n        }\n        if (!result.value.error) {\n          this_.synchronizeDispatch(\n            result.value as GraffitiObjectStreamContinueEntry<{}>,\n          );\n        }\n        yield result.value;\n      }\n    })();\n  }\n\n  protected objectStream<Schema extends JSONSchema>(\n    iterator: GraffitiObjectStream<Schema>,\n  ): GraffitiObjectStream<Schema> {\n    const wrapped = this.objectStreamContinue<Schema>(iterator);\n    return (async function* () {\n      // Filter out the tombstones for type safety\n      while (true) {\n        const result = await wrapped.next();\n        if (result.done) return result.value;\n        if (result.value.error || !result.value.tombstone) yield result.value;\n      }\n    })();\n  }\n\n  discover: Graffiti[\"discover\"] = (...args) => {\n    const iterator = this.graffiti.discover(...args);\n    return this.objectStream<(typeof args)[1]>(iterator);\n  };\n\n  recoverOrphans: Graffiti[\"recoverOrphans\"] = (...args) => {\n    const iterator = this.graffiti.recoverOrphans(...args);\n    return this.objectStream<(typeof args)[0]>(iterator);\n  };\n\n  continueObjectStream: Graffiti[\"continueObjectStream\"] = (...args) => {\n    const iterator = this.graffiti.continueObjectStream(...args);\n    return this.objectStreamContinue<{}>(iterator);\n  };\n}\n"],
+  "mappings": "AACA,SAAS,gBAAgB;AAUzB,SAAS,gBAAgB;AAEzB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAoEA,MAAM,4BAA4B,SAAS;AAAA,EACtC;AAAA,EACA;AAAA,EACS;AAAA,EACA,YAAY,oBAAI,IAAiC;AAAA,EACjD;AAAA,EAEnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEA,IAAc,MAAM;AAClB,QAAI,CAAC,KAAK,MAAM;AACd,WAAK,QAAQ,YAAY;AACvB,cAAM,EAAE,SAAS,IAAI,IAAI,MAAM,OAAO,KAAK;AAC3C,eAAO,IAAI,IAAI,EAAE,QAAQ,MAAM,CAAC;AAAA,MAClC,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAc,aAAa;AACzB,QAAI,CAAC,KAAK,aAAa;AACrB,WAAK,eAAe,YAAY;AAC9B,cAAM,EAAE,WAAW,IAAI,MAAM,OAAO,iBAAiB;AACrD,eAAO;AAAA,MACT,GAAG;AAAA,IACL;AACA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,YAKE,UACA,SACA;AACA,UAAM;AACN,SAAK,UAAU,WAAW,CAAC;AAC3B,SAAK,WAAW;AAChB,SAAK,eAAe,SAAS,aAAa,KAAK,QAAQ;AACvD,SAAK,QAAQ,SAAS,MAAM,KAAK,QAAQ;AACzC,SAAK,SAAS,SAAS,OAAO,KAAK,QAAQ;AAC3C,SAAK,gBAAgB,SAAS;AAAA,EAChC;AAAA,EAEU,YACR,aACA,UACA,QACA,SAC2D;AAC3D,UAAM,WAAW,oBAAI,IAAY;AAEjC,UAAM,WAAW,IAAI;AAAA,MACnB,OAAO,MAAM,SAAS;AACpB,cAAM,WAAW,4BAA4B,MAAM,KAAK,KAAK,MAAM;AACnE,cAAM,WAAwC,CAC5C,cACA,iBACG;AACH,qBAAW,aAAa,CAAC,cAAc,YAAY,GAAG;AACpD,gBAAI,WAAW,WAAW;AACxB,kBAAI,SAAS,IAAI,UAAU,OAAO,GAAG,GAAG;AACtC,qBAAK,SAAS;AAAA,cAChB;AAAA,YACF,WACE,aACA,YAAY,UAAU,MAAM,MAC3B,KAAK,QAAQ,cACZ,6BAA6B,UAAU,QAAQ,OAAO,IACxD;AAEA,oBAAM,SAAS,KAAK;AAAA,gBAClB,KAAK,UAAU,UAAU,MAAM;AAAA,cACjC;AACA,kBAAI,CAAC,KAAK,QAAQ,YAAY;AAC5B,mCAAmB,QAAQ,UAAU,OAAO;AAAA,cAC9C;AACA,kBAAI,SAAS,MAAM,GAAG;AACpB,qBAAK,EAAE,OAAO,CAAC;AACf,yBAAS,IAAI,OAAO,GAAG;AACvB;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAEA,aAAK,UAAU,IAAI,QAAQ;AAC3B,cAAM;AACN,aAAK,UAAU,OAAO,QAAQ;AAAA,MAChC;AAAA,IACF;AAEA,YAAQ,mBAAmB;AACzB,uBAAiB,KAAK,SAAU,OAAM;AAAA,IACxC,GAAG;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,uBACK,MACwD;AAC3D,UAAM,CAAC,UAAU,QAAQ,OAAO,IAAI;AACpC,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,SAAS,KAAK,CAAC,YAAY,SAAS,SAAS,OAAO,CAAC;AAAA,IACrE;AACA,WAAO,KAAK,YAAoB,aAAa,UAAU,QAAQ,OAAO;AAAA,EACxE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,kBACK,MACwD;AAC3D,UAAM,CAAC,WAAW,QAAQ,OAAO,IAAI;AACrC,UAAM,MAAM,gBAAgB,SAAS;AACrC,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,QAAQ;AAAA,IACxB;AACA,WAAO,KAAK,YAAoB,aAAa,CAAC,GAAG,QAAQ,OAAO;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,6BACK,MACwD;AAC3D,UAAM,CAAC,QAAQ,OAAO,IAAI;AAC1B,aAAS,YAAY,QAA4B;AAC/C,aAAO,OAAO,UAAU,QAAQ,SAAS,OAAO,SAAS,WAAW;AAAA,IACtE;AACA,WAAO,KAAK,YAAoB,aAAa,CAAC,GAAG,QAAQ,OAAO;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,eACE,QACA,SAC2D;AAC3D,WAAO,KAAK,YAAoB,MAAM,MAAM,CAAC,GAAG,QAAQ,OAAO;AAAA,EACjE;AAAA,EAEA,MAAgB,oBACd,WACA,WACA,mBAAmB,OACnB;AACA,eAAW,YAAY,KAAK,WAAW;AACrC,eAAS,WAAW,SAAS;AAAA,IAC/B;AACA,QAAI,kBAAkB;AAqBpB,YAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,CAAC,CAAC;AAAA,IACvD;AAAA,EACF;AAAA,EAEA,MAAuB,UAAU,SAAS;AACxC,UAAM,SAAS,MAAM,KAAK,SAAS,IAAI,GAAG,IAAI;AAC9C,SAAK,oBAAoB,EAAE,OAAO,CAAC;AACnC,WAAO;AAAA,EACT;AAAA,EAEA,MAAuB,UAAU,SAAS;AACxC,UAAM,YAAY,MAAM,KAAK,SAAS,IAAQ,GAAG,IAAI;AACrD,UAAM,gBAAgB,KAAK,CAAC;AAC5B,UAAM,YAAgC;AAAA,MACpC,GAAG;AAAA,MACH,OAAO,cAAc;AAAA,MACrB,UAAU,cAAc;AAAA,MACxB,SAAS,cAAc;AAAA,IACzB;AACA,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,QAA2B,UAAU,SAAS;AAC5C,UAAM,YAAY,MAAM,KAAK,SAAS,MAAM,GAAG,IAAI;AACnD,UAAM,YAAgC,EAAE,GAAG,UAAU;AACrD,eAAW,QAAQ,CAAC,SAAS,YAAY,SAAS,GAAY;AAC5D,yBAAmB,MAAM,KAAK,YAAY,MAAM,KAAK,CAAC,GAAG,SAAS;AAAA,IACpE;AACA,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,QACE,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,SAA6B,UAAU,SAAS;AAC9C,UAAM,YAAY,MAAM,KAAK,SAAS,OAAO,GAAG,IAAI;AACpD,UAAM,KAAK;AAAA,MACT;AAAA,QACE,WAAW;AAAA,QACX,QAAQ;AAAA,MACV;AAAA,MACA;AAAA,MACA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEU,qBACR,UACsC;AACtC,UAAM,QAAQ;AACd,YAAQ,mBAAmB;AACzB,aAAO,MAAM;AACX,cAAM,SAAS,MAAM,SAAS,KAAK;AACnC,YAAI,OAAO,MAAM;AACf,gBAAM,EAAE,UAAU,WAAW,OAAO,IAAI,OAAO;AAC/C,iBAAO;AAAA,YACL,UAAU,MAAM,MAAM,qBAA6B,UAAU,CAAC;AAAA,YAC9D;AAAA,UACF;AAAA,QACF;AACA,YAAI,CAAC,OAAO,MAAM,OAAO;AACvB,gBAAM;AAAA,YACJ,OAAO;AAAA,UACT;AAAA,QACF;AACA,cAAM,OAAO;AAAA,MACf;AAAA,IACF,GAAG;AAAA,EACL;AAAA,EAEU,aACR,UAC8B;AAC9B,UAAM,UAAU,KAAK,qBAA6B,QAAQ;AAC1D,YAAQ,mBAAmB;AAEzB,aAAO,MAAM;AACX,cAAM,SAAS,MAAM,QAAQ,KAAK;AAClC,YAAI,OAAO,KAAM,QAAO,OAAO;AAC/B,YAAI,OAAO,MAAM,SAAS,CAAC,OAAO,MAAM,UAAW,OAAM,OAAO;AAAA,MAClE;AAAA,IACF,GAAG;AAAA,EACL;AAAA,EAEA,WAAiC,IAAI,SAAS;AAC5C,UAAM,WAAW,KAAK,SAAS,SAAS,GAAG,IAAI;AAC/C,WAAO,KAAK,aAA+B,QAAQ;AAAA,EACrD;AAAA,EAEA,iBAA6C,IAAI,SAAS;AACxD,UAAM,WAAW,KAAK,SAAS,eAAe,GAAG,IAAI;AACrD,WAAO,KAAK,aAA+B,QAAQ;AAAA,EACrD;AAAA,EAEA,uBAAyD,IAAI,SAAS;AACpE,UAAM,WAAW,KAAK,SAAS,qBAAqB,GAAG,IAAI;AAC3D,WAAO,KAAK,qBAAyB,QAAQ;AAAA,EAC/C;AACF;",
   "names": []
 }

package/dist/index.d.ts

@@ -27,8 +27,10 @@ export interface GraffitiSynchronizeOptions {
  * the [Graffiti Vue Plugin](https://vue.graffiti.garden/variables/GraffitiPlugin.html)
  * and possibly other front-end libraries in the future.
  *
- * Specifically, it provides the following *synchronize*
- * methods for each of the following API methods:
+ * [See a live example](/example).
+ *
+ * Specifically, this library provides the following *synchronize*
+ * methods to correspond with each of the following Graffiti API methods:
  *
  * | API Method | Synchronize Method |
  * |------------|--------------------|
@@ -54,6 +56,8 @@ export interface GraffitiSynchronizeOptions {
  * all instance's of that friend's name in the user's application instantly,
  * providing a consistent user experience.
  *
+ * The source code for this library is [available on GitHub](https://github.com/graffiti-garden/wrapper-synchronize/).
+ *
  * @groupDescription Synchronize Methods
  * This group contains methods that listen for changes made via
  * {@link put}, {@link patch}, and {@link delete} or fetched from
@@ -70,8 +74,8 @@ export declare class GraffitiSynchronize extends Graffiti {
     login: Graffiti["login"];
     logout: Graffiti["logout"];
     sessionEvents: Graffiti["sessionEvents"];
-    get ajv(): Promise<Ajv>;
-    get applyPatch(): Promise<typeof applyPatch>;
+    protected get ajv(): Promise<Ajv>;
+    protected get applyPatch(): Promise<typeof applyPatch>;
     /**
      * Wraps a Graffiti API instance to provide the synchronize methods.
      * The GraffitiSyncrhonize class rather than the Graffiti class
@@ -134,6 +138,8 @@ export declare class GraffitiSynchronize extends Graffiti {
      *
      * Be careful using this method. Without additional filters it can
      * expose the user to content out of context.
+     *
+     * @group Synchronize Methods
      */
     synchronizeAll<Schema extends JSONSchema>(schema: Schema, session?: GraffitiSession | null): AsyncGenerator<GraffitiObjectStreamContinueEntry<Schema>>;
     protected synchronizeDispatch(oldObject: GraffitiObjectStreamContinueEntry<{}>, newObject?: GraffitiObjectStreamContinueEntry<{}>, waitForListeners?: boolean): Promise<void>;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,KAAK,EACV,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,iCAAiC,EACjC,4BAA4B,EAE7B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAQlD,mBAAmB,sBAAsB,CAAC;AAE1C,MAAM,MAAM,2BAA2B,GAAG,CACxC,SAAS,EAAE,iCAAiC,CAAC,EAAE,CAAC,EAChD,SAAS,CAAC,EAAE,iCAAiC,CAAC,EAAE,CAAC,KAC9C,IAAI,CAAC;AAEV,MAAM,WAAW,0BAA0B;IACzC;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,mBAAoB,SAAQ,QAAQ;IAC/C,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IACzC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,UAAU,CAAC,GAAG,SAAS,CAAC;IAC9D,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IACtC,SAAS,CAAC,QAAQ,CAAC,SAAS,mCAA0C;IACtE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAC;IAEvD,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;IACvC,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACzB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC3B,aAAa,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAEzC,IAAI,GAAG,iBAQN;IAED,IAAI,UAAU,+BAQb;IAED;;;;OAIG;;IAED;;;OAGG;IACH,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,0BAA0B;IAWtC,SAAS,CAAC,WAAW,CAAC,MAAM,SAAS,UAAU,EAC7C,WAAW,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,OAAO,EACpD,QAAQ,EAAE,MAAM,EAAE,EAClB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,GAC/B,cAAc,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;IA8C5D;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,MAAM,SAAS,UAAU,EAC3C,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAC9D,cAAc,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAQ5D;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,MAAM,SAAS,UAAU,EACtC,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GACzD,cAAc,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAS5D;;;;;;;;;;;;OAYG;IACH,yBAAyB,CAAC,MAAM,SAAS,UAAU,EACjD,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,GACpE,cAAc,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAQ5D;;;;;;;;;OASG;IACH,cAAc,CAAC,MAAM,SAAS,UAAU,EACtC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,GAC/B,cAAc,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;cAI5C,mBAAmB,CACjC,SAAS,EAAE,iCAAiC,CAAC,EAAE,CAAC,EAChD,SAAS,CAAC,EAAE,iCAAiC,CAAC,EAAE,CAAC,EACjD,gBAAgB,UAAQ;IA8B1B,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAIlB;IAEF,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAoBlB;IAEF,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAiBtB;IAEF,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAWxB;IAEF,SAAS,CAAC,oBAAoB,CAAC,MAAM,SAAS,UAAU,EACtD,QAAQ,EAAE,4BAA4B,CAAC,MAAM,CAAC,GAC7C,4BAA4B,CAAC,MAAM,CAAC;IAsBvC,SAAS,CAAC,YAAY,CAAC,MAAM,SAAS,UAAU,EAC9C,QAAQ,EAAE,oBAAoB,CAAC,MAAM,CAAC,GACrC,oBAAoB,CAAC,MAAM,CAAC;IAY/B,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,CAG5B;IAEF,cAAc,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAGxC;IAEF,oBAAoB,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAGpD;CACH"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,KAAK,EACV,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,iCAAiC,EACjC,4BAA4B,EAE7B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAQlD,mBAAmB,sBAAsB,CAAC;AAE1C,MAAM,MAAM,2BAA2B,GAAG,CACxC,SAAS,EAAE,iCAAiC,CAAC,EAAE,CAAC,EAChD,SAAS,CAAC,EAAE,iCAAiC,CAAC,EAAE,CAAC,KAC9C,IAAI,CAAC;AAEV,MAAM,WAAW,0BAA0B;IACzC;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,qBAAa,mBAAoB,SAAQ,QAAQ;IAC/C,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IACzC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,UAAU,CAAC,GAAG,SAAS,CAAC;IAC9D,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IACtC,SAAS,CAAC,QAAQ,CAAC,SAAS,mCAA0C;IACtE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAC;IAEvD,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;IACvC,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACzB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC3B,aAAa,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAEzC,SAAS,KAAK,GAAG,iBAQhB;IAED,SAAS,KAAK,UAAU,+BAQvB;IAED;;;;OAIG;;IAED;;;OAGG;IACH,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,0BAA0B;IAWtC,SAAS,CAAC,WAAW,CAAC,MAAM,SAAS,UAAU,EAC7C,WAAW,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,OAAO,EACpD,QAAQ,EAAE,MAAM,EAAE,EAClB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,GAC/B,cAAc,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAgD5D;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,MAAM,SAAS,UAAU,EAC3C,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAC9D,cAAc,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAQ5D;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,MAAM,SAAS,UAAU,EACtC,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GACzD,cAAc,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAS5D;;;;;;;;;;;;OAYG;IACH,yBAAyB,CAAC,MAAM,SAAS,UAAU,EACjD,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,GACpE,cAAc,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAQ5D;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,MAAM,SAAS,UAAU,EACtC,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,GAC/B,cAAc,CAAC,iCAAiC,CAAC,MAAM,CAAC,CAAC;cAI5C,mBAAmB,CACjC,SAAS,EAAE,iCAAiC,CAAC,EAAE,CAAC,EAChD,SAAS,CAAC,EAAE,iCAAiC,CAAC,EAAE,CAAC,EACjD,gBAAgB,UAAQ;IA8B1B,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAIlB;IAEF,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAoBlB;IAEF,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAiBtB;IAEF,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAWxB;IAEF,SAAS,CAAC,oBAAoB,CAAC,MAAM,SAAS,UAAU,EACtD,QAAQ,EAAE,4BAA4B,CAAC,MAAM,CAAC,GAC7C,4BAA4B,CAAC,MAAM,CAAC;IAsBvC,SAAS,CAAC,YAAY,CAAC,MAAM,SAAS,UAAU,EAC9C,QAAQ,EAAE,oBAAoB,CAAC,MAAM,CAAC,GACrC,oBAAoB,CAAC,MAAM,CAAC;IAY/B,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,CAG5B;IAEF,cAAc,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAGxC;IAEF,oBAAoB,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAGpD;CACH"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graffiti-garden/wrapper-synchronize",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Internal synchronization for the Graffiti API",
   "types": "./dist/index.d.ts",
   "module": "./dist/esm/index.js",
@@ -24,7 +24,7 @@
     "test:coverage": "vitest --coverage",
     "build:types": "tsc --declaration --emitDeclarationOnly",
     "build:js": "tsx esbuild.config.mts",
-    "build:docs": "typedoc --options typedoc.json",
+    "build:docs": "typedoc --options typedoc.json && cp -r example docs",
     "build": "rm -rf dist && npm run build:types && npm run build:js && npm run build:docs",
     "prepublishOnly": "npm update && npm test && npm run build"
   },
@@ -45,19 +45,19 @@
   },
   "homepage": "https://sync.graffiti.garden/classes/GraffitiSynchronize.html",
   "devDependencies": {
-    "@types/node": "^22.13.1",
-    "@vitest/coverage-v8": "^3.0.6",
-    "tsx": "^4.19.2",
-    "typedoc": "^0.27.6",
-    "typescript": "^5.7.3",
-    "vitest": "^3.0.5"
+    "@types/node": "^24.7.2",
+    "@vitest/coverage-v8": "^3.2.4",
+    "esbuild-plugin-polyfill-node": "^0.3.0",
+    "tsx": "^4.20.6",
+    "typedoc": "^0.28.14",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
   },
   "dependencies": {
-    "@graffiti-garden/api": "^0.6.2",
-    "@graffiti-garden/implementation-local": "^0.6.2",
+    "@graffiti-garden/api": "^0.6.4",
+    "@graffiti-garden/implementation-local": "^0.6.4",
     "@repeaterjs/repeater": "^3.0.6",
     "ajv": "^8.17.1",
-    "esbuild-plugin-polyfill-node": "^0.3.0",
     "fast-json-patch": "^3.1.1"
   }
 }

package/src/index.ts

@@ -48,8 +48,10 @@ export interface GraffitiSynchronizeOptions {
  * the [Graffiti Vue Plugin](https://vue.graffiti.garden/variables/GraffitiPlugin.html)
  * and possibly other front-end libraries in the future.
  *
- * Specifically, it provides the following *synchronize*
- * methods for each of the following API methods:
+ * [See a live example](/example).
+ *
+ * Specifically, this library provides the following *synchronize*
+ * methods to correspond with each of the following Graffiti API methods:
  *
  * | API Method | Synchronize Method |
  * |------------|--------------------|
@@ -75,6 +77,8 @@ export interface GraffitiSynchronizeOptions {
  * all instance's of that friend's name in the user's application instantly,
  * providing a consistent user experience.
  *
+ * The source code for this library is [available on GitHub](https://github.com/graffiti-garden/wrapper-synchronize/).
+ *
  * @groupDescription Synchronize Methods
  * This group contains methods that listen for changes made via
  * {@link put}, {@link patch}, and {@link delete} or fetched from
@@ -93,7 +97,7 @@ export class GraffitiSynchronize extends Graffiti {
   logout: Graffiti["logout"];
   sessionEvents: Graffiti["sessionEvents"];
 
-  get ajv() {
+  protected get ajv() {
     if (!this.ajv_) {
       this.ajv_ = (async () => {
         const { default: Ajv } = await import("ajv");
@@ -103,7 +107,7 @@ export class GraffitiSynchronize extends Graffiti {
     return this.ajv_;
   }
 
-  get applyPatch() {
+  protected get applyPatch() {
     if (!this.applyPatch_) {
       this.applyPatch_ = (async () => {
         const { applyPatch } = await import("fast-json-patch");
@@ -183,7 +187,9 @@ export class GraffitiSynchronize extends Graffiti {
       },
     );
 
-    return repeater;
+    return (async function* () {
+      for await (const i of repeater) yield i;
+    })();
   }
 
   /**
@@ -264,6 +270,8 @@ export class GraffitiSynchronize extends Graffiti {
    *
    * Be careful using this method. Without additional filters it can
    * expose the user to content out of context.
+   *
+   * @group Synchronize Methods
    */
   synchronizeAll<Schema extends JSONSchema>(
     schema: Schema,
@@ -414,7 +422,7 @@ export class GraffitiSynchronize extends Graffiti {
   };
 
   continueObjectStream: Graffiti["continueObjectStream"] = (...args) => {
-    // TODO!!
-    return this.graffiti.continueObjectStream(...args);
+    const iterator = this.graffiti.continueObjectStream(...args);
+    return this.objectStreamContinue<{}>(iterator);
   };
 }