@xyo-network/archivist-firebase 3.2.0

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,13 @@
+[![logo][]](https://xyo.network)
+
+Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
+
+## License
+
+> See the [LICENSE](LICENSE) file for license details
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO](https://xyo.network)
+
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/browser/Archivist.d.ts

@@ -0,0 +1,16 @@
+import { Hash } from '@xylabs/hex';
+import { AbstractArchivist } from '@xyo-network/archivist-abstract';
+import { ArchivistModuleEventData } from '@xyo-network/archivist-model';
+import { Payload, Schema, WithMeta } from '@xyo-network/payload-model';
+import { FirebaseArchivistParams } from './Params.ts';
+export declare class FirebaseArchivist<TParams extends FirebaseArchivistParams = FirebaseArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractArchivist<TParams, TEventData> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    get queries(): string[];
+    private get collection();
+    private get firebaseApp();
+    private get firestore();
+    protected getHandler(hashes: Hash[]): Promise<WithMeta<Payload>[]>;
+    protected insertHandler(payloads: Payload[]): Promise<WithMeta<Payload>[]>;
+}
+//# sourceMappingURL=Archivist.d.ts.map

package/dist/browser/Archivist.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Archivist.d.ts","sourceRoot":"","sources":["../../src/Archivist.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAKL,wBAAwB,EAEzB,MAAM,8BAA8B,CAAA;AAGrC,OAAO,EACL,OAAO,EAAE,MAAM,EACf,QAAQ,EACT,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAErD,qBACa,iBAAiB,CAC5B,OAAO,SAAS,uBAAuB,GAAG,uBAAuB,EACjE,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAA0D;IAC1G,gBAAyB,mBAAmB,EAAE,MAAM,CAAgC;IAEpF,IAAa,OAAO,aASnB;IAED,OAAO,KAAK,UAAU,GAErB;IAED,OAAO,KAAK,WAAW,GAEtB;IAED,OAAO,KAAK,SAAS,GAEpB;cAEwB,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;cAYxD,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;CAW1F"}

package/dist/browser/Config.d.ts

@@ -0,0 +1,10 @@
+import type { ArchivistConfig } from '@xyo-network/archivist-model';
+import { FirebaseArchivistSchema } from './Schema.ts';
+export type FirebaseArchivistConfigSchema = `${FirebaseArchivistSchema}.config`;
+export declare const FirebaseArchivistConfigSchema: FirebaseArchivistConfigSchema;
+export type FirebaseArchivistConfig = ArchivistConfig<{
+    collection?: string;
+    dbId?: string;
+    schema: FirebaseArchivistConfigSchema;
+}>;
+//# sourceMappingURL=Config.d.ts.map

package/dist/browser/Config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAEnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAErD,MAAM,MAAM,6BAA6B,GAAG,GAAG,uBAAuB,SAAS,CAAA;AAC/E,eAAO,MAAM,6BAA6B,EAAE,6BAAmE,CAAA;AAE/G,MAAM,MAAM,uBAAuB,GAAG,eAAe,CAAC;IACpD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,6BAA6B,CAAA;CACtC,CAAC,CAAA"}

package/dist/browser/Params.d.ts

@@ -0,0 +1,8 @@
+import type { FirebaseApp } from '@firebase/app';
+import type { ArchivistParams } from '@xyo-network/archivist-model';
+import type { AnyConfigSchema } from '@xyo-network/module-model';
+import type { FirebaseArchivistConfig } from './Config.ts';
+export type FirebaseArchivistParams = ArchivistParams<AnyConfigSchema<FirebaseArchivistConfig>, {
+    firebaseApp?: FirebaseApp;
+}>;
+//# sourceMappingURL=Params.d.ts.map

package/dist/browser/Params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../src/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAE1D,MAAM,MAAM,uBAAuB,GAAG,eAAe,CAAC,eAAe,CAAC,uBAAuB,CAAC,EAAE;IAC9F,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,CAAC,CAAA"}

package/dist/browser/Schema.d.ts

@@ -0,0 +1,3 @@
+export declare const FirebaseArchivistSchema = "network.xyo.archivist.firebase";
+export type FirebaseArchivistSchema = typeof FirebaseArchivistSchema;
+//# sourceMappingURL=Schema.d.ts.map

package/dist/browser/Schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB,mCAAmC,CAAA;AACvE,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAA"}

package/dist/browser/index.d.ts

@@ -0,0 +1,5 @@
+export * from './Archivist.ts';
+export * from './Config.ts';
+export * from './Params.ts';
+export * from './Schema.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA"}

package/dist/browser/index.mjs

@@ -0,0 +1,86 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/Archivist.ts
+import { collection, doc, getDoc, getFirestore, setDoc } from "@firebase/firestore";
+import { assertEx } from "@xylabs/assert";
+import { exists } from "@xylabs/exists";
+import { AbstractArchivist } from "@xyo-network/archivist-abstract";
+import { ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ArchivistNextQuerySchema } from "@xyo-network/archivist-model";
+import { creatableModule } from "@xyo-network/module-model";
+import { PayloadBuilder } from "@xyo-network/payload-builder";
+
+// src/Schema.ts
+var FirebaseArchivistSchema = "network.xyo.archivist.firebase";
+
+// src/Config.ts
+var FirebaseArchivistConfigSchema = `${FirebaseArchivistSchema}.config`;
+
+// src/Archivist.ts
+function _ts_decorate(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+__name(_ts_decorate, "_ts_decorate");
+var FirebaseArchivist = class extends AbstractArchivist {
+  static {
+    __name(this, "FirebaseArchivist");
+  }
+  static configSchemas = [
+    ...super.configSchemas,
+    FirebaseArchivistConfigSchema
+  ];
+  static defaultConfigSchema = FirebaseArchivistConfigSchema;
+  get queries() {
+    return [
+      ArchivistNextQuerySchema,
+      ArchivistAllQuerySchema,
+      ArchivistClearQuerySchema,
+      ArchivistDeleteQuerySchema,
+      ArchivistInsertQuerySchema,
+      ...super.queries
+    ];
+  }
+  get collection() {
+    return collection(this.firestore, assertEx(this.config.collection, () => "Missing collection name"));
+  }
+  get firebaseApp() {
+    return assertEx(this.params.firebaseApp, () => "Missing FirebaseApp");
+  }
+  get firestore() {
+    return getFirestore(this.firebaseApp, assertEx(this.config.dbId, () => "no dbId specified"));
+  }
+  async getHandler(hashes) {
+    const payloadCollection = this.collection;
+    return (await Promise.all(hashes.map(async (hash) => {
+      const docRef = doc(payloadCollection, hash);
+      const docSnap = await getDoc(docRef);
+      if (!docSnap.exists()) {
+        return null;
+      }
+      return PayloadBuilder.build(docSnap.data());
+    }))).filter(exists);
+  }
+  async insertHandler(payloads) {
+    const pairs = await PayloadBuilder.hashPairs(payloads, {
+      stamp: false
+    });
+    const payloadCollection = this.collection;
+    return await Promise.all(pairs.map(async ([payload, hash]) => {
+      const docRef = doc(payloadCollection, hash);
+      await setDoc(docRef, payload);
+      return payload;
+    }));
+  }
+};
+FirebaseArchivist = _ts_decorate([
+  creatableModule()
+], FirebaseArchivist);
+export {
+  FirebaseArchivist,
+  FirebaseArchivistConfigSchema,
+  FirebaseArchivistSchema
+};
+//# sourceMappingURL=index.mjs.map

package/dist/browser/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Archivist.ts","../../src/Schema.ts","../../src/Config.ts"],"sourcesContent":["import {\n  collection,\n  doc,\n  getDoc,\n  getFirestore,\n  setDoc,\n} from '@firebase/firestore'\nimport { assertEx } from '@xylabs/assert'\nimport { exists } from '@xylabs/exists'\nimport { Hash } from '@xylabs/hex'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n  ArchivistAllQuerySchema,\n  ArchivistClearQuerySchema,\n  ArchivistDeleteQuerySchema,\n  ArchivistInsertQuerySchema,\n  ArchivistModuleEventData,\n  ArchivistNextQuerySchema,\n} from '@xyo-network/archivist-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport {\n  Payload, Schema,\n  WithMeta,\n} from '@xyo-network/payload-model'\n\nimport { FirebaseArchivistConfigSchema } from './Config.ts'\nimport { FirebaseArchivistParams } from './Params.ts'\n\n@creatableModule()\nexport class FirebaseArchivist<\n  TParams extends FirebaseArchivistParams = FirebaseArchivistParams,\n  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, FirebaseArchivistConfigSchema]\n  static override readonly defaultConfigSchema: Schema = FirebaseArchivistConfigSchema\n\n  override get queries() {\n    return [\n      ArchivistNextQuerySchema,\n      ArchivistAllQuerySchema,\n      ArchivistClearQuerySchema,\n      ArchivistDeleteQuerySchema,\n      ArchivistInsertQuerySchema,\n      ...super.queries,\n    ]\n  }\n\n  private get collection() {\n    return collection(this.firestore, assertEx(this.config.collection, () => 'Missing collection name'))\n  }\n\n  private get firebaseApp() {\n    return assertEx(this.params.firebaseApp, () => 'Missing FirebaseApp')\n  }\n\n  private get firestore() {\n    return getFirestore(this.firebaseApp, assertEx(this.config.dbId, () => 'no dbId specified'))\n  }\n\n  protected override async getHandler(hashes: Hash[]): Promise<WithMeta<Payload>[]> {\n    const payloadCollection = this.collection\n    return (await Promise.all(hashes.map(async (hash) => {\n      const docRef = doc(payloadCollection, hash)\n      const docSnap = await getDoc(docRef)\n      if (!docSnap.exists()) {\n        return null\n      }\n      return PayloadBuilder.build(docSnap.data() as Payload)\n    }))).filter(exists)\n  }\n\n  protected override async insertHandler(payloads: Payload[]): Promise<WithMeta<Payload>[]> {\n    const pairs = await PayloadBuilder.hashPairs(payloads, { stamp: false })\n    const payloadCollection = this.collection\n    return await Promise.all(pairs.map(\n      async ([payload, hash]) => {\n        const docRef = doc(payloadCollection, hash)\n        await setDoc(docRef, payload)\n        return payload\n      },\n    ))\n  }\n}\n","export const FirebaseArchivistSchema = 'network.xyo.archivist.firebase'\nexport type FirebaseArchivistSchema = typeof FirebaseArchivistSchema\n","import type { ArchivistConfig } from '@xyo-network/archivist-model'\n\nimport { FirebaseArchivistSchema } from './Schema.ts'\n\nexport type FirebaseArchivistConfigSchema = `${FirebaseArchivistSchema}.config`\nexport const FirebaseArchivistConfigSchema: FirebaseArchivistConfigSchema = `${FirebaseArchivistSchema}.config`\n\nexport type FirebaseArchivistConfig = ArchivistConfig<{\n  collection?: string\n  dbId?: string\n  schema: FirebaseArchivistConfigSchema\n}>\n"],"mappings":";;;;AAAA,SACEA,YACAC,KACAC,QACAC,cACAC,cACK;AACP,SAASC,gBAAgB;AACzB,SAASC,cAAc;AAEvB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BACAC,4BACAC,4BAEAC,gCACK;AACP,SAASC,uBAAuB;AAChC,SAASC,sBAAsB;;;ACpBxB,IAAMC,0BAA0B;;;ACKhC,IAAMC,gCAA+D,GAAGC,uBAAAA;;;;;;;;;;AFyBxE,IAAMC,oBAAN,cAGGC,kBAAAA;SAAAA;;;EACR,OAAyBC,gBAA0B;OAAI,MAAMA;IAAeC;;EAC5E,OAAyBC,sBAA8BD;EAEvD,IAAaE,UAAU;AACrB,WAAO;MACLC;MACAC;MACAC;MACAC;MACAC;SACG,MAAML;;EAEb;EAEA,IAAYM,aAAa;AACvB,WAAOA,WAAW,KAAKC,WAAWC,SAAS,KAAKC,OAAOH,YAAY,MAAM,yBAAA,CAAA;EAC3E;EAEA,IAAYI,cAAc;AACxB,WAAOF,SAAS,KAAKG,OAAOD,aAAa,MAAM,qBAAA;EACjD;EAEA,IAAYH,YAAY;AACtB,WAAOK,aAAa,KAAKF,aAAaF,SAAS,KAAKC,OAAOI,MAAM,MAAM,mBAAA,CAAA;EACzE;EAEA,MAAyBC,WAAWC,QAA8C;AAChF,UAAMC,oBAAoB,KAAKV;AAC/B,YAAQ,MAAMW,QAAQC,IAAIH,OAAOI,IAAI,OAAOC,SAAAA;AAC1C,YAAMC,SAASC,IAAIN,mBAAmBI,IAAAA;AACtC,YAAMG,UAAU,MAAMC,OAAOH,MAAAA;AAC7B,UAAI,CAACE,QAAQE,OAAM,GAAI;AACrB,eAAO;MACT;AACA,aAAOC,eAAeC,MAAMJ,QAAQK,KAAI,CAAA;IAC1C,CAAA,CAAA,GAAKC,OAAOJ,MAAAA;EACd;EAEA,MAAyBK,cAAcC,UAAmD;AACxF,UAAMC,QAAQ,MAAMN,eAAeO,UAAUF,UAAU;MAAEG,OAAO;IAAM,CAAA;AACtE,UAAMlB,oBAAoB,KAAKV;AAC/B,WAAO,MAAMW,QAAQC,IAAIc,MAAMb,IAC7B,OAAO,CAACgB,SAASf,IAAAA,MAAK;AACpB,YAAMC,SAASC,IAAIN,mBAAmBI,IAAAA;AACtC,YAAMgB,OAAOf,QAAQc,OAAAA;AACrB,aAAOA;IACT,CAAA,CAAA;EAEJ;AACF;;;;","names":["collection","doc","getDoc","getFirestore","setDoc","assertEx","exists","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","ArchivistNextQuerySchema","creatableModule","PayloadBuilder","FirebaseArchivistSchema","FirebaseArchivistConfigSchema","FirebaseArchivistSchema","FirebaseArchivist","AbstractArchivist","configSchemas","FirebaseArchivistConfigSchema","defaultConfigSchema","queries","ArchivistNextQuerySchema","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","collection","firestore","assertEx","config","firebaseApp","params","getFirestore","dbId","getHandler","hashes","payloadCollection","Promise","all","map","hash","docRef","doc","docSnap","getDoc","exists","PayloadBuilder","build","data","filter","insertHandler","payloads","pairs","hashPairs","stamp","payload","setDoc"]}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@xyo-network/archivist-firebase",
+  "version": "3.2.0",
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "homepage": "https://xyo.network",
+  "bugs": {
+    "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues",
+    "email": "support@xyo.network"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "license": "LGPL-3.0-only",
+  "author": {
+    "name": "XYO Development Team",
+    "email": "support@xyo.network",
+    "url": "https://xyo.network"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/browser/index.d.ts",
+      "default": "./dist/browser/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "dist/browser/index.mjs",
+  "types": "dist/browser/index.d.ts",
+  "dependencies": {
+    "@firebase/app": "^0.10.12",
+    "@firebase/firestore": "^4.7.3",
+    "@xylabs/assert": "^4.1.0",
+    "@xylabs/exists": "^4.1.0",
+    "@xylabs/hex": "^4.1.0",
+    "@xylabs/lodash": "^4.1.0",
+    "@xyo-network/archivist-abstract": "^3.2.0",
+    "@xyo-network/archivist-model": "^3.2.0",
+    "@xyo-network/module-model": "^3.2.0",
+    "@xyo-network/payload-builder": "^3.2.0",
+    "@xyo-network/payload-model": "^3.2.0"
+  },
+  "devDependencies": {
+    "@firebase/app-compat": "^0.2.42",
+    "@firebase/rules-unit-testing": "^3.0.4",
+    "@xylabs/object": "^4.1.0",
+    "@xylabs/ts-scripts-yarn3": "^4.1.0",
+    "@xylabs/tsconfig": "^4.1.0",
+    "@xyo-network/account": "^3.2.0",
+    "@xyo-network/id-payload-plugin": "^3.2.0",
+    "@xyo-network/payload-wrapper": "^3.2.0",
+    "firebase": "^10.14.0",
+    "typescript": "^5.6.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/Archivist.ts

@@ -0,0 +1,84 @@
+import {
+  collection,
+  doc,
+  getDoc,
+  getFirestore,
+  setDoc,
+} from '@firebase/firestore'
+import { assertEx } from '@xylabs/assert'
+import { exists } from '@xylabs/exists'
+import { Hash } from '@xylabs/hex'
+import { AbstractArchivist } from '@xyo-network/archivist-abstract'
+import {
+  ArchivistAllQuerySchema,
+  ArchivistClearQuerySchema,
+  ArchivistDeleteQuerySchema,
+  ArchivistInsertQuerySchema,
+  ArchivistModuleEventData,
+  ArchivistNextQuerySchema,
+} from '@xyo-network/archivist-model'
+import { creatableModule } from '@xyo-network/module-model'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import {
+  Payload, Schema,
+  WithMeta,
+} from '@xyo-network/payload-model'
+
+import { FirebaseArchivistConfigSchema } from './Config.ts'
+import { FirebaseArchivistParams } from './Params.ts'
+
+@creatableModule()
+export class FirebaseArchivist<
+  TParams extends FirebaseArchivistParams = FirebaseArchivistParams,
+  TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,
+> extends AbstractArchivist<TParams, TEventData> {
+  static override readonly configSchemas: Schema[] = [...super.configSchemas, FirebaseArchivistConfigSchema]
+  static override readonly defaultConfigSchema: Schema = FirebaseArchivistConfigSchema
+
+  override get queries() {
+    return [
+      ArchivistNextQuerySchema,
+      ArchivistAllQuerySchema,
+      ArchivistClearQuerySchema,
+      ArchivistDeleteQuerySchema,
+      ArchivistInsertQuerySchema,
+      ...super.queries,
+    ]
+  }
+
+  private get collection() {
+    return collection(this.firestore, assertEx(this.config.collection, () => 'Missing collection name'))
+  }
+
+  private get firebaseApp() {
+    return assertEx(this.params.firebaseApp, () => 'Missing FirebaseApp')
+  }
+
+  private get firestore() {
+    return getFirestore(this.firebaseApp, assertEx(this.config.dbId, () => 'no dbId specified'))
+  }
+
+  protected override async getHandler(hashes: Hash[]): Promise<WithMeta<Payload>[]> {
+    const payloadCollection = this.collection
+    return (await Promise.all(hashes.map(async (hash) => {
+      const docRef = doc(payloadCollection, hash)
+      const docSnap = await getDoc(docRef)
+      if (!docSnap.exists()) {
+        return null
+      }
+      return PayloadBuilder.build(docSnap.data() as Payload)
+    }))).filter(exists)
+  }
+
+  protected override async insertHandler(payloads: Payload[]): Promise<WithMeta<Payload>[]> {
+    const pairs = await PayloadBuilder.hashPairs(payloads, { stamp: false })
+    const payloadCollection = this.collection
+    return await Promise.all(pairs.map(
+      async ([payload, hash]) => {
+        const docRef = doc(payloadCollection, hash)
+        await setDoc(docRef, payload)
+        return payload
+      },
+    ))
+  }
+}

package/src/Config.ts

@@ -0,0 +1,12 @@
+import type { ArchivistConfig } from '@xyo-network/archivist-model'
+
+import { FirebaseArchivistSchema } from './Schema.ts'
+
+export type FirebaseArchivistConfigSchema = `${FirebaseArchivistSchema}.config`
+export const FirebaseArchivistConfigSchema: FirebaseArchivistConfigSchema = `${FirebaseArchivistSchema}.config`
+
+export type FirebaseArchivistConfig = ArchivistConfig<{
+  collection?: string
+  dbId?: string
+  schema: FirebaseArchivistConfigSchema
+}>

package/src/Params.ts

@@ -0,0 +1,9 @@
+import type { FirebaseApp } from '@firebase/app'
+import type { ArchivistParams } from '@xyo-network/archivist-model'
+import type { AnyConfigSchema } from '@xyo-network/module-model'
+
+import type { FirebaseArchivistConfig } from './Config.ts'
+
+export type FirebaseArchivistParams = ArchivistParams<AnyConfigSchema<FirebaseArchivistConfig>, {
+  firebaseApp?: FirebaseApp
+}>

package/src/Schema.ts

@@ -0,0 +1,2 @@
+export const FirebaseArchivistSchema = 'network.xyo.archivist.firebase'
+export type FirebaseArchivistSchema = typeof FirebaseArchivistSchema

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './Archivist.ts'
+export * from './Config.ts'
+export * from './Params.ts'
+export * from './Schema.ts'

package/src/spec/firestore.rules

@@ -0,0 +1,14 @@
+service cloud.firestore {
+  match /databases/{database}/documents {
+    
+    // Match any document in the "users" collection
+    match /users/{userId} {
+      
+      // Allow read and write access if the requesting user is authenticated and their UID matches the document ID
+      allow read, write: if request.auth != null && request.auth.uid == userId;
+      
+      // Deny all other access
+      allow read, write: if false;
+    }
+  }
+}

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}

package/xy.config.ts

@@ -0,0 +1,10 @@
+import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    browser: { src: true },
+    neutral: {},
+    node: {},
+  },
+}
+
+export default config