@xyo-network/filesystem-archivist 3.6.0-rc.2 → 3.6.0-rc.3
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.
|
@@ -4,7 +4,7 @@ import { AbstractArchivist } from '@xyo-network/archivist-abstract';
|
|
|
4
4
|
import { ArchivistConfig, ArchivistInstance, ArchivistParams } from '@xyo-network/archivist-model';
|
|
5
5
|
import { BoundWitness } from '@xyo-network/boundwitness-model';
|
|
6
6
|
import { AnyConfigSchema } from '@xyo-network/module-model';
|
|
7
|
-
import { Payload, Schema } from '@xyo-network/payload-model';
|
|
7
|
+
import { Payload, Schema, WithStorageMeta } from '@xyo-network/payload-model';
|
|
8
8
|
export interface FileSystemArchivistData {
|
|
9
9
|
payloads: Payload[];
|
|
10
10
|
}
|
|
@@ -26,12 +26,12 @@ export declare class FilesystemArchivist<TParams extends FilesystemArchivistPara
|
|
|
26
26
|
get queries(): string[];
|
|
27
27
|
private get memoryArchivist();
|
|
28
28
|
private static dataFromRawJson;
|
|
29
|
-
protected allHandler(): PromisableArray<Payload
|
|
29
|
+
protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;
|
|
30
30
|
protected clearHandler(): void | Promise<void>;
|
|
31
31
|
protected commitHandler(): Promise<BoundWitness[]>;
|
|
32
32
|
protected deleteHandler(hashes: Hash[]): PromisableArray<Hash>;
|
|
33
|
-
protected getHandler(hashes: Hash[]): Promise<Payload[]>;
|
|
34
|
-
protected insertHandler(payloads: Payload[]): Promise<Payload[]>;
|
|
33
|
+
protected getHandler(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]>;
|
|
34
|
+
protected insertHandler(payloads: Payload[]): Promise<WithStorageMeta<Payload>[]>;
|
|
35
35
|
protected startHandler(): Promise<boolean>;
|
|
36
36
|
private rawJsonFromFile;
|
|
37
37
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FilesystemArchivist.d.ts","sourceRoot":"","sources":["../../src/FilesystemArchivist.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAEnE,OAAO,EAGL,eAAe,EACf,iBAAiB,EACjB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAmB,MAAM,2BAA2B,CAAA;AAC5E,OAAO,
|
|
1
|
+
{"version":3,"file":"FilesystemArchivist.d.ts","sourceRoot":"","sources":["../../src/FilesystemArchivist.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAEnE,OAAO,EAGL,eAAe,EACf,iBAAiB,EACjB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAmB,MAAM,2BAA2B,CAAA;AAC5E,OAAO,EACL,OAAO,EAAE,MAAM,EAAE,eAAe,EACjC,MAAM,4BAA4B,CAAA;AAEnC,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,OAAO,EAAE,CAAA;CACpB;AAED,MAAM,MAAM,+BAA+B,GAAG,yCAAyC,CAAA;AACvF,eAAO,MAAM,+BAA+B,EAAE,+BAA2E,CAAA;AAEzH,MAAM,MAAM,yBAAyB,GAAG,eAAe,CAAC;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,+BAA+B,CAAA;CACxC,CAAC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,eAAe,CAAC,eAAe,CAAC,yBAAyB,CAAC,CAAC,CAAA;AAEnG;;GAEG;AACH,qBACa,mBAAmB,CAAC,OAAO,SAAS,yBAAyB,GAAG,yBAAyB,CACpG,SAAQ,iBAAiB,CAAC,OAAO,CACjC,YAAW,iBAAiB;IAC5B,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAA4D;IAC5G,gBAAyB,mBAAmB,EAAE,MAAM,CAAkC;IAEtF,OAAO,CAAC,gBAAgB,CAAC,CAAiB;IAE1C,IAAI,QAAQ,WAEX;IAED,IAAa,OAAO,aAEnB;IAED,OAAO,KAAK,eAAe,GAE1B;IAED,OAAO,CAAC,MAAM,CAAC,eAAe;cAOX,UAAU,IAAI,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;cAIvD,YAAY,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;cAI9B,aAAa,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;cAI9C,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;cAI9C,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAI/D,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAIvE,YAAY;YAevB,eAAe;CAG9B"}
|
package/dist/node/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/FilesystemArchivist.ts"],"sourcesContent":["import { readFile } from 'node:fs/promises'\n\nimport { assertEx } from '@xylabs/assert'\nimport { handleError } from '@xylabs/error'\nimport { Hash } from '@xylabs/hex'\nimport { PromisableArray } from '@xylabs/promise'\nimport { HDWallet } from '@xyo-network/account'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport { MemoryArchivist } from '@xyo-network/archivist-memory'\nimport {\n ArchivistAllQuerySchema,\n ArchivistCommitQuerySchema,\n ArchivistConfig,\n ArchivistInstance,\n ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { AnyConfigSchema, creatableModule } from '@xyo-network/module-model'\nimport {
|
|
1
|
+
{"version":3,"sources":["../../src/FilesystemArchivist.ts"],"sourcesContent":["import { readFile } from 'node:fs/promises'\n\nimport { assertEx } from '@xylabs/assert'\nimport { handleError } from '@xylabs/error'\nimport { Hash } from '@xylabs/hex'\nimport { PromisableArray } from '@xylabs/promise'\nimport { HDWallet } from '@xyo-network/account'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport { MemoryArchivist } from '@xyo-network/archivist-memory'\nimport {\n ArchivistAllQuerySchema,\n ArchivistCommitQuerySchema,\n ArchivistConfig,\n ArchivistInstance,\n ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport { BoundWitness } from '@xyo-network/boundwitness-model'\nimport { AnyConfigSchema, creatableModule } from '@xyo-network/module-model'\nimport {\n Payload, Schema, WithStorageMeta,\n} from '@xyo-network/payload-model'\n\nexport interface FileSystemArchivistData {\n payloads: Payload[]\n}\n\nexport type FilesystemArchivistConfigSchema = 'network.xyo.archivist.filesystem.config'\nexport const FilesystemArchivistConfigSchema: FilesystemArchivistConfigSchema = 'network.xyo.archivist.filesystem.config'\n\nexport type FilesystemArchivistConfig = ArchivistConfig<{\n filePath?: string\n schema: FilesystemArchivistConfigSchema\n}>\n\nexport type FilesystemArchivistParams = ArchivistParams<AnyConfigSchema<FilesystemArchivistConfig>>\n\n/** @description Currently only a read-only archivist that loads payloads from filesystem\n * but allows for future expansion to read/write\n */\n@creatableModule()\nexport class FilesystemArchivist<TParams extends FilesystemArchivistParams = FilesystemArchivistParams>\n extends AbstractArchivist<TParams>\n implements ArchivistInstance {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, FilesystemArchivistConfigSchema]\n static override readonly defaultConfigSchema: Schema = FilesystemArchivistConfigSchema\n\n private _memoryArchivist?: MemoryArchivist\n\n get filePath() {\n return this.config?.filePath ?? 'archivist.xyo.json'\n }\n\n override get queries() {\n return [ArchivistAllQuerySchema, ArchivistCommitQuerySchema, ...super.queries]\n }\n\n private get memoryArchivist() {\n return assertEx(this._memoryArchivist)\n }\n\n private static dataFromRawJson(rawJson: string) {\n const data: FileSystemArchivistData = JSON.parse(rawJson)\n assertEx(typeof data === 'object', () => 'Archivist Data must be object')\n assertEx(Array.isArray(data.payloads), () => 'Archivist Data \"payloads\" field must be array of payloads')\n return data\n }\n\n protected override allHandler(): PromisableArray<WithStorageMeta<Payload>> {\n return this.memoryArchivist.all()\n }\n\n protected override clearHandler(): void | Promise<void> {\n return this.memoryArchivist.clear()\n }\n\n protected override async commitHandler(): Promise<BoundWitness[]> {\n return await this.memoryArchivist.commit()\n }\n\n protected override deleteHandler(hashes: Hash[]): PromisableArray<Hash> {\n return this.memoryArchivist.delete(hashes)\n }\n\n protected override async getHandler(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]> {\n return await this.memoryArchivist.get(hashes)\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<WithStorageMeta<Payload>[]> {\n return await this.memoryArchivist.insert(payloads)\n }\n\n protected override async startHandler() {\n await super.startHandler()\n this._memoryArchivist = await MemoryArchivist.create({ account: await HDWallet.random() })\n try {\n const data = FilesystemArchivist.dataFromRawJson(await this.rawJsonFromFile())\n await this._memoryArchivist.insert(data.payloads)\n } catch (ex) {\n handleError(ex, (error) => {\n this.logger?.error(error.message)\n })\n return false\n }\n return true\n }\n\n private async rawJsonFromFile() {\n return await readFile(this.filePath, { encoding: 'utf8' })\n }\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AAEzB,SAASC,gBAAgB;AACzB,SAASC,mBAAmB;AAG5B,SAASC,gBAAgB;AACzB,SAASC,yBAAyB;AAClC,SAASC,uBAAuB;AAChC,SACEC,yBACAC,kCAIK;AAEP,SAA0BC,uBAAuB;;;;;;;;AAU1C,IAAMC,kCAAmE;AAazE,IAAMC,sBAAN,MAAMA,6BACHC,kBAAAA;SAAAA;;;EAER,OAAyBC,gBAA0B;OAAI,MAAMA;IAAeH;;EAC5E,OAAyBI,sBAA8BJ;EAE/CK;EAER,IAAIC,WAAW;AACb,WAAO,KAAKC,QAAQD,YAAY;EAClC;EAEA,IAAaE,UAAU;AACrB,WAAO;MAACC;MAAyBC;SAA+B,MAAMF;;EACxE;EAEA,IAAYG,kBAAkB;AAC5B,WAAOC,SAAS,KAAKP,gBAAgB;EACvC;EAEA,OAAeQ,gBAAgBC,SAAiB;AAC9C,UAAMC,OAAgCC,KAAKC,MAAMH,OAAAA;AACjDF,aAAS,OAAOG,SAAS,UAAU,MAAM,+BAAA;AACzCH,aAASM,MAAMC,QAAQJ,KAAKK,QAAQ,GAAG,MAAM,2DAAA;AAC7C,WAAOL;EACT;EAEmBM,aAAwD;AACzE,WAAO,KAAKV,gBAAgBW,IAAG;EACjC;EAEmBC,eAAqC;AACtD,WAAO,KAAKZ,gBAAgBa,MAAK;EACnC;EAEA,MAAyBC,gBAAyC;AAChE,WAAO,MAAM,KAAKd,gBAAgBe,OAAM;EAC1C;EAEmBC,cAAcC,QAAuC;AACtE,WAAO,KAAKjB,gBAAgBkB,OAAOD,MAAAA;EACrC;EAEA,MAAyBE,WAAWF,QAAqD;AACvF,WAAO,MAAM,KAAKjB,gBAAgBoB,IAAIH,MAAAA;EACxC;EAEA,MAAyBI,cAAcZ,UAA0D;AAC/F,WAAO,MAAM,KAAKT,gBAAgBsB,OAAOb,QAAAA;EAC3C;EAEA,MAAyBc,eAAe;AACtC,UAAM,MAAMA,aAAAA;AACZ,SAAK7B,mBAAmB,MAAM8B,gBAAgBC,OAAO;MAAEC,SAAS,MAAMC,SAASC,OAAM;IAAG,CAAA;AACxF,QAAI;AACF,YAAMxB,OAAOd,qBAAoBY,gBAAgB,MAAM,KAAK2B,gBAAe,CAAA;AAC3E,YAAM,KAAKnC,iBAAiB4B,OAAOlB,KAAKK,QAAQ;IAClD,SAASqB,IAAI;AACXC,kBAAYD,IAAI,CAACE,UAAAA;AACf,aAAKC,QAAQD,MAAMA,MAAME,OAAO;MAClC,CAAA;AACA,aAAO;IACT;AACA,WAAO;EACT;EAEA,MAAcL,kBAAkB;AAC9B,WAAO,MAAMM,SAAS,KAAKxC,UAAU;MAAEyC,UAAU;IAAO,CAAA;EAC1D;AACF;;;;","names":["readFile","assertEx","handleError","HDWallet","AbstractArchivist","MemoryArchivist","ArchivistAllQuerySchema","ArchivistCommitQuerySchema","creatableModule","FilesystemArchivistConfigSchema","FilesystemArchivist","AbstractArchivist","configSchemas","defaultConfigSchema","_memoryArchivist","filePath","config","queries","ArchivistAllQuerySchema","ArchivistCommitQuerySchema","memoryArchivist","assertEx","dataFromRawJson","rawJson","data","JSON","parse","Array","isArray","payloads","allHandler","all","clearHandler","clear","commitHandler","commit","deleteHandler","hashes","delete","getHandler","get","insertHandler","insert","startHandler","MemoryArchivist","create","account","HDWallet","random","rawJsonFromFile","ex","handleError","error","logger","message","readFile","encoding"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/filesystem-archivist",
|
|
3
|
-
"version": "3.6.0-rc.
|
|
3
|
+
"version": "3.6.0-rc.3",
|
|
4
4
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -37,13 +37,13 @@
|
|
|
37
37
|
"@xylabs/error": "^4.4.12",
|
|
38
38
|
"@xylabs/hex": "^4.4.12",
|
|
39
39
|
"@xylabs/promise": "^4.4.12",
|
|
40
|
-
"@xyo-network/account": "^3.6.0-rc.
|
|
41
|
-
"@xyo-network/archivist-abstract": "^3.6.0-rc.
|
|
42
|
-
"@xyo-network/archivist-memory": "^3.6.0-rc.
|
|
43
|
-
"@xyo-network/archivist-model": "^3.6.0-rc.
|
|
44
|
-
"@xyo-network/boundwitness-model": "^3.6.0-rc.
|
|
45
|
-
"@xyo-network/module-model": "^3.6.0-rc.
|
|
46
|
-
"@xyo-network/payload-model": "^3.6.0-rc.
|
|
40
|
+
"@xyo-network/account": "^3.6.0-rc.3",
|
|
41
|
+
"@xyo-network/archivist-abstract": "^3.6.0-rc.3",
|
|
42
|
+
"@xyo-network/archivist-memory": "^3.6.0-rc.3",
|
|
43
|
+
"@xyo-network/archivist-model": "^3.6.0-rc.3",
|
|
44
|
+
"@xyo-network/boundwitness-model": "^3.6.0-rc.3",
|
|
45
|
+
"@xyo-network/module-model": "^3.6.0-rc.3",
|
|
46
|
+
"@xyo-network/payload-model": "^3.6.0-rc.3"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@xylabs/ts-scripts-yarn3": "^4.2.4",
|
|
@@ -16,7 +16,9 @@ import {
|
|
|
16
16
|
} from '@xyo-network/archivist-model'
|
|
17
17
|
import { BoundWitness } from '@xyo-network/boundwitness-model'
|
|
18
18
|
import { AnyConfigSchema, creatableModule } from '@xyo-network/module-model'
|
|
19
|
-
import {
|
|
19
|
+
import {
|
|
20
|
+
Payload, Schema, WithStorageMeta,
|
|
21
|
+
} from '@xyo-network/payload-model'
|
|
20
22
|
|
|
21
23
|
export interface FileSystemArchivistData {
|
|
22
24
|
payloads: Payload[]
|
|
@@ -63,7 +65,7 @@ export class FilesystemArchivist<TParams extends FilesystemArchivistParams = Fil
|
|
|
63
65
|
return data
|
|
64
66
|
}
|
|
65
67
|
|
|
66
|
-
protected override allHandler(): PromisableArray<Payload
|
|
68
|
+
protected override allHandler(): PromisableArray<WithStorageMeta<Payload>> {
|
|
67
69
|
return this.memoryArchivist.all()
|
|
68
70
|
}
|
|
69
71
|
|
|
@@ -79,11 +81,11 @@ export class FilesystemArchivist<TParams extends FilesystemArchivistParams = Fil
|
|
|
79
81
|
return this.memoryArchivist.delete(hashes)
|
|
80
82
|
}
|
|
81
83
|
|
|
82
|
-
protected override async getHandler(hashes: Hash[]): Promise<Payload[]> {
|
|
84
|
+
protected override async getHandler(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]> {
|
|
83
85
|
return await this.memoryArchivist.get(hashes)
|
|
84
86
|
}
|
|
85
87
|
|
|
86
|
-
protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {
|
|
88
|
+
protected override async insertHandler(payloads: Payload[]): Promise<WithStorageMeta<Payload>[]> {
|
|
87
89
|
return await this.memoryArchivist.insert(payloads)
|
|
88
90
|
}
|
|
89
91
|
|