@xyo-network/archivist-firebase 6.0.4 → 6.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/browser/Archivist.d.ts +1 -1
- package/dist/browser/Archivist.d.ts.map +1 -1
- package/dist/browser/Config.d.ts.map +1 -1
- package/dist/browser/Schema.d.ts +1 -1
- package/dist/browser/Schema.d.ts.map +1 -1
- package/dist/browser/index.mjs.map +2 -2
- package/package.json +14 -15
package/README.md
CHANGED
|
@@ -38,10 +38,12 @@ bun add {{name}}
|
|
|
38
38
|
|
|
39
39
|
See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
|
|
40
40
|
|
|
41
|
+
## Credits
|
|
41
42
|
|
|
43
|
+
[Made with 🔥 and ❄️ by XYO Foundation](https://xyo.network)
|
|
42
44
|
|
|
43
|
-
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
44
45
|
[npm-badge]: https://img.shields.io/npm/v/@xyo-network/archivist-firebase.svg
|
|
45
46
|
[npm-link]: https://www.npmjs.com/package/@xyo-network/archivist-firebase
|
|
46
47
|
[license-badge]: https://img.shields.io/npm/l/@xyo-network/archivist-firebase.svg
|
|
47
48
|
[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
|
|
49
|
+
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
@@ -7,7 +7,7 @@ export declare class FirebaseArchivist<TParams extends FirebaseArchivistParams =
|
|
|
7
7
|
static readonly configSchemas: Schema[];
|
|
8
8
|
static readonly defaultConfigSchema: Schema;
|
|
9
9
|
static readonly labels: {
|
|
10
|
-
|
|
10
|
+
'network.xyo.storage.class': string;
|
|
11
11
|
};
|
|
12
12
|
get queries(): Schema[];
|
|
13
13
|
private get collection();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Archivist.d.ts","sourceRoot":"","sources":["../../src/Archivist.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,OAAO,EAAE,iBAAiB,EAAqB,MAAM,iCAAiC,CAAA;AACtF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAA;AAG5E,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAAE,eAAe,EACjC,MAAM,8BAA8B,CAAA;AAGrC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAE1D,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;IACpF,gBAAyB,MAAM
|
|
1
|
+
{"version":3,"file":"Archivist.d.ts","sourceRoot":"","sources":["../../src/Archivist.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAE1C,OAAO,EAAE,iBAAiB,EAAqB,MAAM,iCAAiC,CAAA;AACtF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAA;AAG5E,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAAE,eAAe,EACjC,MAAM,8BAA8B,CAAA;AAGrC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAE1D,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;IACpF,gBAAyB,MAAM,EAAE;QAC/B,2BAA2B,EAAE,MAAM,CAAA;KACpC,CAAsD;IAEvD,IAAa,OAAO,IAAI,MAAM,EAAE,CAK/B;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,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAY/D,aAAa,CAAC,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;CAUlH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAKnE,eAAO,MAAM,6BAA6B
|
|
1
|
+
{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AAKnE,eAAO,MAAM,6BAA6B,EAAE,MAAM,GAAG;IACnD,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAA;CAC8B,CAAA;AACvD,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAA;AAEhF,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/Schema.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,uBAAuB
|
|
1
|
+
{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,uBAAuB,EAAE,gCAAgC,GAAG;IACvE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAA;CAC2B,CAAA;AACpD,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/Archivist.ts", "../../src/Config.ts", "../../src/Schema.ts"],
|
|
4
|
-
"sourcesContent": ["import {\n collection,\n doc,\n getDoc,\n getFirestore,\n setDoc,\n} from '@firebase/firestore'\nimport type { Hash } from '@xylabs/sdk-js'\nimport { assertEx, exists } from '@xylabs/sdk-js'\nimport { AbstractArchivist, StorageClassLabel } from '@xyo-network/archivist-abstract'\nimport type { ArchivistModuleEventData } from '@xyo-network/archivist-model'\nimport { ArchivistInsertQuerySchema } from '@xyo-network/archivist-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport type {\n Payload, Schema, WithStorageMeta,\n} from '@xyo-network/sdk-protocol-js'\n\nimport { FirebaseArchivistConfigSchema } from './Config.ts'\nimport type { 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 static override readonly labels = { ...super.labels, [StorageClassLabel]: 'network' }\n\n override get queries() {\n return [\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<WithStorageMeta<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 docSnap.data() as WithStorageMeta<Payload>\n }))).filter(exists)\n }\n\n protected override async insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]> {\n const payloadCollection = this.collection\n return await Promise.all(payloads.map(\n async (payload) => {\n const docRef = doc(payloadCollection, payload._hash)\n await setDoc(docRef, payload)\n return payload\n },\n ))\n }\n}\n", "import type { ArchivistConfig } from '@xyo-network/archivist-model'\nimport { asSchema } from '@xyo-network/sdk-protocol-js'\n\nimport { FirebaseArchivistSchema } from './Schema.ts'\n\nexport const FirebaseArchivistConfigSchema = asSchema(`${FirebaseArchivistSchema}.config`, true)\nexport type FirebaseArchivistConfigSchema = typeof FirebaseArchivistConfigSchema\n\nexport type FirebaseArchivistConfig = ArchivistConfig<{\n collection?: string\n dbId?: string\n schema: FirebaseArchivistConfigSchema\n}>\n", "import { asSchema } from '@xyo-network/sdk-protocol-js'\n\nexport const FirebaseArchivistSchema = asSchema('network.xyo.archivist.firebase', true)\nexport type FirebaseArchivistSchema = typeof FirebaseArchivistSchema\n"],
|
|
5
|
-
"mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,UAAU,cAAc;AACjC,SAAS,mBAAmB,yBAAyB;AAErD,SAAS,kCAAkC;AAC3C,SAAS,uBAAuB;;;ACXhC,SAAS,YAAAA,iBAAgB;;;ACDzB,SAAS,gBAAgB;AAElB,IAAM,
|
|
4
|
+
"sourcesContent": ["import {\n collection,\n doc,\n getDoc,\n getFirestore,\n setDoc,\n} from '@firebase/firestore'\nimport type { Hash } from '@xylabs/sdk-js'\nimport { assertEx, exists } from '@xylabs/sdk-js'\nimport { AbstractArchivist, StorageClassLabel } from '@xyo-network/archivist-abstract'\nimport type { ArchivistModuleEventData } from '@xyo-network/archivist-model'\nimport { ArchivistInsertQuerySchema } from '@xyo-network/archivist-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport type {\n Payload, Schema, WithStorageMeta,\n} from '@xyo-network/sdk-protocol-js'\n\nimport { FirebaseArchivistConfigSchema } from './Config.ts'\nimport type { 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 static override readonly labels: {\n 'network.xyo.storage.class': string\n } = { ...super.labels, [StorageClassLabel]: 'network' }\n\n override get queries(): Schema[] {\n return [\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<WithStorageMeta<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 docSnap.data() as WithStorageMeta<Payload>\n }))).filter(exists)\n }\n\n protected override async insertHandler(payloads: WithStorageMeta<Payload>[]): Promise<WithStorageMeta<Payload>[]> {\n const payloadCollection = this.collection\n return await Promise.all(payloads.map(\n async (payload) => {\n const docRef = doc(payloadCollection, payload._hash)\n await setDoc(docRef, payload)\n return payload\n },\n ))\n }\n}\n", "import type { ArchivistConfig } from '@xyo-network/archivist-model'\nimport { asSchema } from '@xyo-network/sdk-protocol-js'\n\nimport { FirebaseArchivistSchema } from './Schema.ts'\n\nexport const FirebaseArchivistConfigSchema: string & {\n readonly __schema: true\n} = asSchema(`${FirebaseArchivistSchema}.config`, true)\nexport type FirebaseArchivistConfigSchema = typeof FirebaseArchivistConfigSchema\n\nexport type FirebaseArchivistConfig = ArchivistConfig<{\n collection?: string\n dbId?: string\n schema: FirebaseArchivistConfigSchema\n}>\n", "import { asSchema } from '@xyo-network/sdk-protocol-js'\n\nexport const FirebaseArchivistSchema: 'network.xyo.archivist.firebase' & {\n readonly __schema: true\n} = asSchema('network.xyo.archivist.firebase', true)\nexport type FirebaseArchivistSchema = typeof FirebaseArchivistSchema\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,UAAU,cAAc;AACjC,SAAS,mBAAmB,yBAAyB;AAErD,SAAS,kCAAkC;AAC3C,SAAS,uBAAuB;;;ACXhC,SAAS,YAAAA,iBAAgB;;;ACDzB,SAAS,gBAAgB;AAElB,IAAM,0BAET,SAAS,kCAAkC,IAAI;;;ADC5C,IAAM,gCAETC,UAAS,GAAG,uBAAuB,WAAW,IAAI;;;ADc/C,IAAM,oBAAN,cAGG,kBAAuC;AAAA,EAO/C,IAAa,UAAoB;AAC/B,WAAO;AAAA,MACL;AAAA,MACA,GAAG,MAAM;AAAA,IACX;AAAA,EACF;AAAA,EAEA,IAAY,aAAa;AACvB,WAAO,WAAW,KAAK,WAAW,SAAS,KAAK,OAAO,YAAY,MAAM,yBAAyB,CAAC;AAAA,EACrG;AAAA,EAEA,IAAY,cAAc;AACxB,WAAO,SAAS,KAAK,OAAO,aAAa,MAAM,qBAAqB;AAAA,EACtE;AAAA,EAEA,IAAY,YAAY;AACtB,WAAO,aAAa,KAAK,aAAa,SAAS,KAAK,OAAO,MAAM,MAAM,mBAAmB,CAAC;AAAA,EAC7F;AAAA,EAEA,MAAyB,WAAW,QAAqD;AACvF,UAAM,oBAAoB,KAAK;AAC/B,YAAQ,MAAM,QAAQ,IAAI,OAAO,IAAI,OAAO,SAAS;AACnD,YAAM,SAAS,IAAI,mBAAmB,IAAI;AAC1C,YAAM,UAAU,MAAM,OAAO,MAAM;AACnC,UAAI,CAAC,QAAQ,OAAO,GAAG;AACrB,eAAO;AAAA,MACT;AACA,aAAO,QAAQ,KAAK;AAAA,IACtB,CAAC,CAAC,GAAG,OAAO,MAAM;AAAA,EACpB;AAAA,EAEA,MAAyB,cAAc,UAA2E;AAChH,UAAM,oBAAoB,KAAK;AAC/B,WAAO,MAAM,QAAQ,IAAI,SAAS;AAAA,MAChC,OAAO,YAAY;AACjB,cAAM,SAAS,IAAI,mBAAmB,QAAQ,KAAK;AACnD,cAAM,OAAO,QAAQ,OAAO;AAC5B,eAAO;AAAA,MACT;AAAA,IACF,CAAC;AAAA,EACH;AACF;AA/CE,cAJW,mBAIc,iBAA0B,CAAC,GAAG,iDAAM,kBAAe,6BAA6B;AACzG,cALW,mBAKc,uBAA8B;AACvD,cANW,mBAMc,UAErB,EAAE,GAAG,iDAAM,WAAQ,CAAC,iBAAiB,GAAG,UAAU;AAR3C,oBAAN;AAAA,EADN,gBAAgB;AAAA,GACJ;",
|
|
6
6
|
"names": ["asSchema", "asSchema"]
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/archivist-firebase",
|
|
3
|
-
"version": "6.0
|
|
3
|
+
"version": "6.1.0",
|
|
4
4
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -34,9 +34,9 @@
|
|
|
34
34
|
"README.md"
|
|
35
35
|
],
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@xyo-network/archivist-abstract": "~6.0
|
|
38
|
-
"@xyo-network/archivist-model": "~6.0
|
|
39
|
-
"@xyo-network/module-model": "~6.0
|
|
37
|
+
"@xyo-network/archivist-abstract": "~6.1.0",
|
|
38
|
+
"@xyo-network/archivist-model": "~6.1.0",
|
|
39
|
+
"@xyo-network/module-model": "~6.1.0"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"@bitauth/libauth": "~3.0.0",
|
|
@@ -49,16 +49,14 @@
|
|
|
49
49
|
"@opentelemetry/sdk-trace-base": "^2.7.1",
|
|
50
50
|
"@scure/base": "~2.2.0",
|
|
51
51
|
"@scure/bip39": "~2.2.0",
|
|
52
|
-
"@xylabs/geo": "^6.0
|
|
53
|
-
"@xylabs/sdk-js": "^6.0
|
|
54
|
-
"@xylabs/threads": "^6.0
|
|
55
|
-
"@xylabs/toolchain": "
|
|
56
|
-
"@xylabs/tsconfig": "
|
|
57
|
-
"@xyo-network/sdk-protocol-js": "
|
|
52
|
+
"@xylabs/geo": "^6.1.0",
|
|
53
|
+
"@xylabs/sdk-js": "^6.1.0",
|
|
54
|
+
"@xylabs/threads": "^6.1.0",
|
|
55
|
+
"@xylabs/toolchain": "^8.1.20",
|
|
56
|
+
"@xylabs/tsconfig": "^8.1.20",
|
|
57
|
+
"@xyo-network/sdk-protocol-js": "^6.1.0",
|
|
58
58
|
"ajv": "^8.20.0",
|
|
59
59
|
"async-mutex": "^0.5.0",
|
|
60
|
-
"bn.js": "^5.2.3",
|
|
61
|
-
"buffer": "^6.0.3",
|
|
62
60
|
"debug": "~4.4.3",
|
|
63
61
|
"eslint": "^10.4.1",
|
|
64
62
|
"ethers": "^6.16.0",
|
|
@@ -87,11 +85,9 @@
|
|
|
87
85
|
"@xylabs/geo": "^6.0",
|
|
88
86
|
"@xylabs/sdk-js": "^6.0",
|
|
89
87
|
"@xylabs/threads": "^6.0",
|
|
90
|
-
"@xyo-network/sdk-protocol-js": "
|
|
88
|
+
"@xyo-network/sdk-protocol-js": "^6.1",
|
|
91
89
|
"ajv": "^8.20",
|
|
92
90
|
"async-mutex": "^0.5",
|
|
93
|
-
"bn.js": "^5.2",
|
|
94
|
-
"buffer": "^6.0",
|
|
95
91
|
"debug": "~4.4",
|
|
96
92
|
"ethers": "^6.16",
|
|
97
93
|
"hash-wasm": "~4.12",
|
|
@@ -101,6 +97,9 @@
|
|
|
101
97
|
"webextension-polyfill": "^0.12",
|
|
102
98
|
"zod": "^4.4"
|
|
103
99
|
},
|
|
100
|
+
"engines": {
|
|
101
|
+
"node": "^24"
|
|
102
|
+
},
|
|
104
103
|
"publishConfig": {
|
|
105
104
|
"access": "public"
|
|
106
105
|
}
|