@xyo-network/filesystem-archivist 2.41.8

package/dist/esm/FilesystemArchivist.d.ts

@@ -0,0 +1,37 @@
+import { XyoArchivist, XyoArchivistConfig } from '@xyo-network/archivist';
+import { XyoBoundWitness } from '@xyo-network/boundwitness';
+import { XyoModuleParams } from '@xyo-network/module';
+import { XyoPayload } from '@xyo-network/payload';
+import { PromisableArray } from '@xyo-network/promise';
+export interface FileSystemArchivistData {
+    payloads: XyoPayload[];
+}
+export type FilesystemArchivistConfigSchema = 'network.xyo.module.config.archivist.filesystem';
+export declare const FilesystemArchivistConfigSchema: FilesystemArchivistConfigSchema;
+export type FilesystemArchivistConfig = XyoArchivistConfig<{
+    filePath: string;
+    schema: FilesystemArchivistConfigSchema;
+}>;
+/** @description Currently only a read-only archivist that loads payloads from filesystem
+ * but allows for future expansion to read/write
+ */
+export declare class FilesystemArchivist<TConfig extends FilesystemArchivistConfig = FilesystemArchivistConfig> extends XyoArchivist<TConfig> {
+    static configSchema: "network.xyo.module.config.archivist.filesystem";
+    private _memoryArchivist?;
+    protected constructor(params: XyoModuleParams<TConfig>);
+    get filePath(): string;
+    private get memoryArchivist();
+    static create(params?: XyoModuleParams<FilesystemArchivistConfig>): Promise<FilesystemArchivist>;
+    private static dataFromRawJson;
+    private static payloadsFromRawPayloads;
+    all(): PromisableArray<XyoPayload>;
+    clear(): void | Promise<void>;
+    commit(): Promise<XyoBoundWitness[]>;
+    delete(hashes: string[]): PromisableArray<boolean>;
+    get(hashes: string[]): Promise<XyoPayload[]>;
+    insert(payloads: XyoPayload[]): Promise<XyoBoundWitness[]>;
+    queries(): string[];
+    protected loadFromFile(): Promise<void>;
+    private rawJsonFromFile;
+}
+//# sourceMappingURL=FilesystemArchivist.d.ts.map

package/dist/esm/FilesystemArchivist.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilesystemArchivist.d.ts","sourceRoot":"","sources":["../../src/FilesystemArchivist.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,YAAY,EAGZ,kBAAkB,EAGnB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAkB,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,UAAU,EAAE,CAAA;CACvB;AAED,MAAM,MAAM,+BAA+B,GAAG,gDAAgD,CAAA;AAC9F,eAAO,MAAM,+BAA+B,EAAE,+BAAkF,CAAA;AAEhI,MAAM,MAAM,yBAAyB,GAAG,kBAAkB,CAAC;IACzD,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,+BAA+B,CAAA;CACxC,CAAC,CAAA;AAEF;;GAEG;AACH,qBAAa,mBAAmB,CAAC,OAAO,SAAS,yBAAyB,GAAG,yBAAyB,CAAE,SAAQ,YAAY,CAAC,OAAO,CAAC;IACnI,OAAgB,YAAY,mDAAkC;IAE9D,OAAO,CAAC,gBAAgB,CAAC,CAAoB;IAE7C,SAAS,aAAa,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC;IAItD,IAAW,QAAQ,WAElB;IAED,OAAO,KAAK,eAAe,GAE1B;WAEqB,MAAM,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,yBAAyB,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAM/G,OAAO,CAAC,MAAM,CAAC,eAAe;IAQ9B,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAKtB,GAAG,IAAI,eAAe,CAAC,UAAU,CAAC;IAIlC,KAAK,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvB,MAAM,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAI1C,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC;IAIrD,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAI5C,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAIvD,OAAO;cAIP,YAAY;YAYd,eAAe;CAG9B"}

package/dist/esm/FilesystemArchivist.js

@@ -0,0 +1,74 @@
+import { readFile } from 'node:fs/promises';
+import { assertEx } from '@xylabs/assert';
+import { XyoArchivist, XyoArchivistAllQuerySchema, XyoArchivistCommitQuerySchema, XyoArchivistFindQuerySchema, XyoMemoryArchivist, } from '@xyo-network/archivist';
+import { PayloadWrapper } from '@xyo-network/payload';
+export const FilesystemArchivistConfigSchema = 'network.xyo.module.config.archivist.filesystem';
+/** @description Currently only a read-only archivist that loads payloads from filesystem
+ * but allows for future expansion to read/write
+ */
+export class FilesystemArchivist extends XyoArchivist {
+    static configSchema = FilesystemArchivistConfigSchema;
+    _memoryArchivist;
+    constructor(params) {
+        super(params);
+    }
+    get filePath() {
+        return this.config?.filePath ?? 'archivist.xyo.json';
+    }
+    get memoryArchivist() {
+        return assertEx(this._memoryArchivist);
+    }
+    static async create(params) {
+        const instance = (await super.create(params));
+        await instance.loadFromFile();
+        return instance;
+    }
+    static dataFromRawJson(rawJson) {
+        const data = JSON.parse(rawJson);
+        assertEx(typeof data === 'object', 'Archivist Data must be object');
+        assertEx(Array.isArray(data.payloads), 'Archivist Data "payloads" field must be array of payloads');
+        data.payloads = this.payloadsFromRawPayloads(data.payloads);
+        return data;
+    }
+    static payloadsFromRawPayloads(rawPayloads) {
+        //validation should be done in here.  I don't believe parse does much validation yet.
+        return rawPayloads.map((payload) => PayloadWrapper.parse(payload).payload);
+    }
+    all() {
+        return this.memoryArchivist.all();
+    }
+    clear() {
+        return this.memoryArchivist.clear();
+    }
+    async commit() {
+        return await this.memoryArchivist.commit();
+    }
+    delete(hashes) {
+        return this.memoryArchivist.delete(hashes);
+    }
+    async get(hashes) {
+        return await this.memoryArchivist.get(hashes);
+    }
+    async insert(payloads) {
+        return await this.memoryArchivist.insert(payloads);
+    }
+    queries() {
+        return [XyoArchivistAllQuerySchema, XyoArchivistFindQuerySchema, XyoArchivistCommitQuerySchema, ...super.queries()];
+    }
+    async loadFromFile() {
+        this._memoryArchivist = await XyoMemoryArchivist.create();
+        try {
+            const data = FilesystemArchivist.dataFromRawJson(await this.rawJsonFromFile());
+            await this._memoryArchivist.insert(data.payloads);
+        }
+        catch (ex) {
+            const error = ex;
+            this.logger?.error(error.message);
+            throw ex;
+        }
+    }
+    async rawJsonFromFile() {
+        return await readFile(this.filePath, { encoding: 'utf8' });
+    }
+}
+//# sourceMappingURL=FilesystemArchivist.js.map

package/dist/esm/FilesystemArchivist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilesystemArchivist.js","sourceRoot":"","sources":["../../src/FilesystemArchivist.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAE3C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EACL,YAAY,EACZ,0BAA0B,EAC1B,6BAA6B,EAE7B,2BAA2B,EAC3B,kBAAkB,GACnB,MAAM,wBAAwB,CAAA;AAG/B,OAAO,EAAE,cAAc,EAAc,MAAM,sBAAsB,CAAA;AAQjE,MAAM,CAAC,MAAM,+BAA+B,GAAoC,gDAAgD,CAAA;AAOhI;;GAEG;AACH,MAAM,OAAO,mBAA2F,SAAQ,YAAqB;IACnI,MAAM,CAAU,YAAY,GAAG,+BAA+B,CAAA;IAEtD,gBAAgB,CAAqB;IAE7C,YAAsB,MAAgC;QACpD,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,MAAM,EAAE,QAAQ,IAAI,oBAAoB,CAAA;IACtD,CAAC;IAED,IAAY,eAAe;QACzB,OAAO,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;IACxC,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,MAAM,CAAC,MAAmD;QAC9E,MAAM,QAAQ,GAAG,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAwB,CAAA;QACpE,MAAM,QAAQ,CAAC,YAAY,EAAE,CAAA;QAC7B,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,OAAe;QAC5C,MAAM,IAAI,GAA4B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACzD,QAAQ,CAAC,OAAO,IAAI,KAAK,QAAQ,EAAE,+BAA+B,CAAC,CAAA;QACnE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,2DAA2D,CAAC,CAAA;QACnG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC3D,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,WAAyB;QAC9D,qFAAqF;QACrF,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAA;IAC5E,CAAC;IAEe,GAAG;QACjB,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,CAAA;IACnC,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAA;IACrC,CAAC;IAEe,KAAK,CAAC,MAAM;QAC1B,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAA;IAC5C,CAAC;IAEe,MAAM,CAAC,MAAgB;QACrC,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC5C,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,MAAgB;QAC/B,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAC/C,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,QAAsB;QACxC,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpD,CAAC;IAEe,OAAO;QACrB,OAAO,CAAC,0BAA0B,EAAE,2BAA2B,EAAE,6BAA6B,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;IACrH,CAAC;IAES,KAAK,CAAC,YAAY;QAC1B,IAAI,CAAC,gBAAgB,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,CAAA;QACzD,IAAI;YACF,MAAM,IAAI,GAAG,mBAAmB,CAAC,eAAe,CAAC,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC,CAAA;YAC9E,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;SAClD;QAAC,OAAO,EAAE,EAAE;YACX,MAAM,KAAK,GAAG,EAAW,CAAA;YACzB,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YACjC,MAAM,EAAE,CAAA;SACT;IACH,CAAC;IAEO,KAAK,CAAC,eAAe;QAC3B,OAAO,MAAM,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAA;IAC5D,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export * from './FilesystemArchivist';
+//# sourceMappingURL=index.d.ts.map

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

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

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './FilesystemArchivist';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@xyo-network/filesystem-archivist",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^2.6.9",
+    "@xyo-network/archivist": "^2.41.8",
+    "@xyo-network/boundwitness": "^2.41.8",
+    "@xyo-network/module": "^2.41.8",
+    "@xyo-network/payload": "^2.41.8",
+    "@xyo-network/promise": "^2.41.8",
+    "tslib": "^2.4.1"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.41.8"
+}

package/src/FilesystemArchivist.spec.ts

@@ -0,0 +1,12 @@
+import { FilesystemArchivist, FilesystemArchivistConfigSchema } from './FilesystemArchivist'
+
+test('FilesystemArchivist Load', async () => {
+  const archivist = await FilesystemArchivist.create({
+    config: {
+      filePath: './packages/modules/packages/filesystem/packages/archivist/src/sample.archivist.xyo.json',
+      schema: FilesystemArchivistConfigSchema,
+    },
+  })
+  const all = await archivist.all()
+  expect(all.length).toBe(4)
+})

package/src/FilesystemArchivist.ts

@@ -0,0 +1,111 @@
+import { readFile } from 'node:fs/promises'
+
+import { assertEx } from '@xylabs/assert'
+import {
+  XyoArchivist,
+  XyoArchivistAllQuerySchema,
+  XyoArchivistCommitQuerySchema,
+  XyoArchivistConfig,
+  XyoArchivistFindQuerySchema,
+  XyoMemoryArchivist,
+} from '@xyo-network/archivist'
+import { XyoBoundWitness } from '@xyo-network/boundwitness'
+import { XyoModuleParams } from '@xyo-network/module'
+import { PayloadWrapper, XyoPayload } from '@xyo-network/payload'
+import { PromisableArray } from '@xyo-network/promise'
+
+export interface FileSystemArchivistData {
+  payloads: XyoPayload[]
+}
+
+export type FilesystemArchivistConfigSchema = 'network.xyo.module.config.archivist.filesystem'
+export const FilesystemArchivistConfigSchema: FilesystemArchivistConfigSchema = 'network.xyo.module.config.archivist.filesystem'
+
+export type FilesystemArchivistConfig = XyoArchivistConfig<{
+  filePath: string
+  schema: FilesystemArchivistConfigSchema
+}>
+
+/** @description Currently only a read-only archivist that loads payloads from filesystem
+ * but allows for future expansion to read/write
+ */
+export class FilesystemArchivist<TConfig extends FilesystemArchivistConfig = FilesystemArchivistConfig> extends XyoArchivist<TConfig> {
+  static override configSchema = FilesystemArchivistConfigSchema
+
+  private _memoryArchivist?: XyoMemoryArchivist
+
+  protected constructor(params: XyoModuleParams<TConfig>) {
+    super(params)
+  }
+
+  public get filePath() {
+    return this.config?.filePath ?? 'archivist.xyo.json'
+  }
+
+  private get memoryArchivist() {
+    return assertEx(this._memoryArchivist)
+  }
+
+  static override async create(params?: XyoModuleParams<FilesystemArchivistConfig>): Promise<FilesystemArchivist> {
+    const instance = (await super.create(params)) as FilesystemArchivist
+    await instance.loadFromFile()
+    return instance
+  }
+
+  private static dataFromRawJson(rawJson: string) {
+    const data: FileSystemArchivistData = JSON.parse(rawJson)
+    assertEx(typeof data === 'object', 'Archivist Data must be object')
+    assertEx(Array.isArray(data.payloads), 'Archivist Data "payloads" field must be array of payloads')
+    data.payloads = this.payloadsFromRawPayloads(data.payloads)
+    return data
+  }
+
+  private static payloadsFromRawPayloads(rawPayloads: XyoPayload[]) {
+    //validation should be done in here.  I don't believe parse does much validation yet.
+    return rawPayloads.map((payload) => PayloadWrapper.parse(payload).payload)
+  }
+
+  public override all(): PromisableArray<XyoPayload> {
+    return this.memoryArchivist.all()
+  }
+
+  public override clear(): void | Promise<void> {
+    return this.memoryArchivist.clear()
+  }
+
+  public override async commit(): Promise<XyoBoundWitness[]> {
+    return await this.memoryArchivist.commit()
+  }
+
+  public override delete(hashes: string[]): PromisableArray<boolean> {
+    return this.memoryArchivist.delete(hashes)
+  }
+
+  public async get(hashes: string[]): Promise<XyoPayload[]> {
+    return await this.memoryArchivist.get(hashes)
+  }
+
+  public async insert(payloads: XyoPayload[]): Promise<XyoBoundWitness[]> {
+    return await this.memoryArchivist.insert(payloads)
+  }
+
+  public override queries() {
+    return [XyoArchivistAllQuerySchema, XyoArchivistFindQuerySchema, XyoArchivistCommitQuerySchema, ...super.queries()]
+  }
+
+  protected async loadFromFile() {
+    this._memoryArchivist = await XyoMemoryArchivist.create()
+    try {
+      const data = FilesystemArchivist.dataFromRawJson(await this.rawJsonFromFile())
+      await this._memoryArchivist.insert(data.payloads)
+    } catch (ex) {
+      const error = ex as Error
+      this.logger?.error(error.message)
+      throw ex
+    }
+  }
+
+  private async rawJsonFromFile() {
+    return await readFile(this.filePath, { encoding: 'utf8' })
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './FilesystemArchivist'

package/src/sample.archivist.xyo.json

@@ -0,0 +1,16 @@
+{
+  "payloads": [
+    {
+      "schema": "network.xyo.test.1"
+    },
+    {
+      "schema": "network.xyo.test.2"
+    },
+    {
+      "schema": "network.xyo.test.3"
+    },
+    {
+      "schema": "network.xyo.test.4"
+    }
+  ]
+}

package/typedoc.json

@@ -0,0 +1,11 @@
+{
+  "intentionallyNotExported": [
+    "WithXyoPayloadMeta",
+    "XyoPayload",
+    "XyoPayloadFull",
+    "XyoBoundWitness",
+    "XyoDataLike",
+    "Huri",
+    "XyoSchemaPayload"
+  ]
+}