@xyo-network/filesystem-archivist 2.72.8 → 2.73.0

package/dist/{types/FilesystemArchivist.d.ts → index.d.mts}

@@ -1,23 +1,24 @@
-import { AbstractArchivist } from '@xyo-network/abstract-archivist';
-import { ArchivistConfig, ArchivistInstance, ArchivistParams } from '@xyo-network/archivist-model';
+import { AbstractArchivist } from '@xyo-network/archivist-abstract';
+import { ArchivistConfig, ArchivistParams, ArchivistInstance } from '@xyo-network/archivist-model';
 import { BoundWitness } from '@xyo-network/boundwitness-model';
 import { AnyConfigSchema } from '@xyo-network/module';
 import { Payload } from '@xyo-network/payload-model';
 import { PromisableArray } from '@xyo-network/promise';
-export interface FileSystemArchivistData {
+
+interface FileSystemArchivistData {
     payloads: Payload[];
 }
-export type FilesystemArchivistConfigSchema = 'network.xyo.archivist.filesystem.config';
-export declare const FilesystemArchivistConfigSchema: FilesystemArchivistConfigSchema;
-export type FilesystemArchivistConfig = ArchivistConfig<{
+type FilesystemArchivistConfigSchema = 'network.xyo.archivist.filesystem.config';
+declare const FilesystemArchivistConfigSchema: FilesystemArchivistConfigSchema;
+type FilesystemArchivistConfig = ArchivistConfig<{
     filePath?: string;
     schema: FilesystemArchivistConfigSchema;
 }>;
-export type FilesystemArchivistParams = ArchivistParams<AnyConfigSchema<FilesystemArchivistConfig>>;
+type FilesystemArchivistParams = ArchivistParams<AnyConfigSchema<FilesystemArchivistConfig>>;
 /** @description Currently only a read-only archivist that loads payloads from filesystem
  * but allows for future expansion to read/write
  */
-export declare class FilesystemArchivist<TParams extends FilesystemArchivistParams = FilesystemArchivistParams> extends AbstractArchivist<TParams> implements ArchivistInstance {
+declare class FilesystemArchivist<TParams extends FilesystemArchivistParams = FilesystemArchivistParams> extends AbstractArchivist<TParams> implements ArchivistInstance {
     static configSchemas: "network.xyo.archivist.filesystem.config"[];
     private _memoryArchivist?;
     get filePath(): string;
@@ -34,4 +35,5 @@ export declare class FilesystemArchivist<TParams extends FilesystemArchivistPara
     protected startHandler(): Promise<boolean>;
     private rawJsonFromFile;
 }
-//# sourceMappingURL=FilesystemArchivist.d.ts.map
+
+export { FileSystemArchivistData, FilesystemArchivist, FilesystemArchivistConfig, FilesystemArchivistConfigSchema, FilesystemArchivistParams };

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import { AbstractArchivist } from '@xyo-network/archivist-abstract';
+import { ArchivistConfig, ArchivistParams, ArchivistInstance } from '@xyo-network/archivist-model';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import { AnyConfigSchema } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+import { PromisableArray } from '@xyo-network/promise';
+
+interface FileSystemArchivistData {
+    payloads: Payload[];
+}
+type FilesystemArchivistConfigSchema = 'network.xyo.archivist.filesystem.config';
+declare const FilesystemArchivistConfigSchema: FilesystemArchivistConfigSchema;
+type FilesystemArchivistConfig = ArchivistConfig<{
+    filePath?: string;
+    schema: FilesystemArchivistConfigSchema;
+}>;
+type FilesystemArchivistParams = ArchivistParams<AnyConfigSchema<FilesystemArchivistConfig>>;
+/** @description Currently only a read-only archivist that loads payloads from filesystem
+ * but allows for future expansion to read/write
+ */
+declare class FilesystemArchivist<TParams extends FilesystemArchivistParams = FilesystemArchivistParams> extends AbstractArchivist<TParams> implements ArchivistInstance {
+    static configSchemas: "network.xyo.archivist.filesystem.config"[];
+    private _memoryArchivist?;
+    get filePath(): string;
+    get queries(): string[];
+    private get memoryArchivist();
+    private static dataFromRawJson;
+    private static payloadsFromRawPayloads;
+    protected allHandler(): PromisableArray<Payload>;
+    protected clearHandler(): void | Promise<void>;
+    protected commitHandler(): Promise<BoundWitness[]>;
+    protected deleteHandler(hashes: string[]): PromisableArray<string>;
+    protected getHandler(hashes: string[]): Promise<Payload[]>;
+    protected insertHandler(payloads: Payload[]): Promise<Payload[]>;
+    protected startHandler(): Promise<boolean>;
+    private rawJsonFromFile;
+}
+
+export { FileSystemArchivistData, FilesystemArchivist, FilesystemArchivistConfig, FilesystemArchivistConfigSchema, FilesystemArchivistParams };

package/dist/index.js

@@ -0,0 +1,130 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  FilesystemArchivist: () => FilesystemArchivist,
+  FilesystemArchivistConfigSchema: () => FilesystemArchivistConfigSchema
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/FilesystemArchivist.ts
+var import_promises = require("fs/promises");
+var import_assert = require("@xylabs/assert");
+var import_account = require("@xyo-network/account");
+var import_archivist_abstract = require("@xyo-network/archivist-abstract");
+var import_archivist_model = require("@xyo-network/archivist-model");
+var import_error = require("@xyo-network/error");
+var import_memory_archivist = require("@xyo-network/memory-archivist");
+var import_module = require("@xyo-network/module");
+var import_payload_wrapper = require("@xyo-network/payload-wrapper");
+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 FilesystemArchivistConfigSchema = "network.xyo.archivist.filesystem.config";
+var FilesystemArchivist = class FilesystemArchivist2 extends import_archivist_abstract.AbstractArchivist {
+  static {
+    __name(this, "FilesystemArchivist");
+  }
+  static configSchemas = [
+    FilesystemArchivistConfigSchema
+  ];
+  _memoryArchivist;
+  get filePath() {
+    return this.config?.filePath ?? "archivist.xyo.json";
+  }
+  get queries() {
+    return [
+      import_archivist_model.ArchivistAllQuerySchema,
+      import_archivist_model.ArchivistCommitQuerySchema,
+      ...super.queries
+    ];
+  }
+  get memoryArchivist() {
+    return (0, import_assert.assertEx)(this._memoryArchivist);
+  }
+  static dataFromRawJson(rawJson) {
+    const data = JSON.parse(rawJson);
+    (0, import_assert.assertEx)(typeof data === "object", "Archivist Data must be object");
+    (0, import_assert.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) {
+    return rawPayloads.map((payload) => import_payload_wrapper.PayloadWrapper.wrap(payload).payload());
+  }
+  allHandler() {
+    return this.memoryArchivist.all();
+  }
+  clearHandler() {
+    return this.memoryArchivist.clear();
+  }
+  async commitHandler() {
+    return await this.memoryArchivist.commit();
+  }
+  deleteHandler(hashes) {
+    return this.memoryArchivist.delete(hashes);
+  }
+  async getHandler(hashes) {
+    return await this.memoryArchivist.get(hashes);
+  }
+  async insertHandler(payloads) {
+    return await this.memoryArchivist.insert(payloads);
+  }
+  async startHandler() {
+    await super.startHandler();
+    this._memoryArchivist = await import_memory_archivist.MemoryArchivist.create({
+      account: await import_account.HDWallet.random()
+    });
+    try {
+      const data = FilesystemArchivist2.dataFromRawJson(await this.rawJsonFromFile());
+      await this._memoryArchivist.insert(data.payloads);
+    } catch (ex) {
+      (0, import_error.handleError)(ex, (error) => {
+        this.logger?.error(error.message);
+      });
+      return false;
+    }
+    return true;
+  }
+  async rawJsonFromFile() {
+    return await (0, import_promises.readFile)(this.filePath, {
+      encoding: "utf8"
+    });
+  }
+};
+FilesystemArchivist = _ts_decorate([
+  (0, import_module.creatableModule)()
+], FilesystemArchivist);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FilesystemArchivist,
+  FilesystemArchivistConfigSchema
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/FilesystemArchivist.ts"],"sourcesContent":["export * from './FilesystemArchivist'\n","import { readFile } from 'node:fs/promises'\n\nimport { assertEx } from '@xylabs/assert'\nimport { HDWallet } from '@xyo-network/account'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\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 { handleError } from '@xyo-network/error'\nimport { MemoryArchivist } from '@xyo-network/memory-archivist'\nimport { AnyConfigSchema, creatableModule } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { PayloadWrapper } from '@xyo-network/payload-wrapper'\nimport { PromisableArray } from '@xyo-network/promise'\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{\n  static override configSchemas = [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    data.payloads = this.payloadsFromRawPayloads(data.payloads)\n    return data\n  }\n\n  private static payloadsFromRawPayloads(rawPayloads: Payload[]) {\n    //validation should be done in here.  I don't believe parse does much validation yet.\n    return rawPayloads.map((payload) => PayloadWrapper.wrap(payload).payload())\n  }\n\n  protected override allHandler(): PromisableArray<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: string[]): PromisableArray<string> {\n    return this.memoryArchivist.delete(hashes)\n  }\n\n  protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n    return await this.memoryArchivist.get(hashes)\n  }\n\n  protected override async insertHandler(payloads: Payload[]): Promise<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;;;;;;;;ACAA,sBAAyB;AAEzB,oBAAyB;AACzB,qBAAyB;AACzB,gCAAkC;AAClC,6BAMO;AAEP,mBAA4B;AAC5B,8BAAgC;AAChC,oBAAiD;AAEjD,6BAA+B;;;;;;;;;;;;AAQxB,IAAMA,kCAAmE;AAahF,IAAaC,sBAAN,MAAAA,6BACGC,4CAAAA;SAAAA;;;EAGR,OAAgBC,gBAAgB;IAACH;;EAEzBI;EAER,IAAIC,WAAW;AACb,WAAO,KAAKC,QAAQD,YAAY;EAClC;EAEA,IAAaE,UAAU;AACrB,WAAO;MAACC;MAAyBC;SAA+B,MAAMF;;EACxE;EAEA,IAAYG,kBAAkB;AAC5B,eAAOC,wBAAS,KAAKP,gBAAgB;EACvC;EAEA,OAAeQ,gBAAgBC,SAAiB;AAC9C,UAAMC,OAAgCC,KAAKC,MAAMH,OAAAA;AACjDF,gCAAS,OAAOG,SAAS,UAAU,+BAAA;AACnCH,gCAASM,MAAMC,QAAQJ,KAAKK,QAAQ,GAAG,2DAAA;AACvCL,SAAKK,WAAW,KAAKC,wBAAwBN,KAAKK,QAAQ;AAC1D,WAAOL;EACT;EAEA,OAAeM,wBAAwBC,aAAwB;AAE7D,WAAOA,YAAYC,IAAI,CAACC,YAAYC,sCAAeC,KAAKF,OAAAA,EAASA,QAAO,CAAA;EAC1E;EAEmBG,aAAuC;AACxD,WAAO,KAAKhB,gBAAgBiB,IAAG;EACjC;EAEmBC,eAAqC;AACtD,WAAO,KAAKlB,gBAAgBmB,MAAK;EACnC;EAEA,MAAyBC,gBAAyC;AAChE,WAAO,MAAM,KAAKpB,gBAAgBqB,OAAM;EAC1C;EAEmBC,cAAcC,QAA2C;AAC1E,WAAO,KAAKvB,gBAAgBwB,OAAOD,MAAAA;EACrC;EAEA,MAAyBE,WAAWF,QAAsC;AACxE,WAAO,MAAM,KAAKvB,gBAAgB0B,IAAIH,MAAAA;EACxC;EAEA,MAAyBI,cAAclB,UAAyC;AAC9E,WAAO,MAAM,KAAKT,gBAAgB4B,OAAOnB,QAAAA;EAC3C;EAEA,MAAyBoB,eAAe;AACtC,UAAM,MAAMA,aAAAA;AACZ,SAAKnC,mBAAmB,MAAMoC,wCAAgBC,OAAO;MAAEC,SAAS,MAAMC,wBAASC,OAAM;IAAG,CAAA;AACxF,QAAI;AACF,YAAM9B,OAAOb,qBAAoBW,gBAAgB,MAAM,KAAKiC,gBAAe,CAAA;AAC3E,YAAM,KAAKzC,iBAAiBkC,OAAOxB,KAAKK,QAAQ;IAClD,SAAS2B,IAAI;AACXC,oCAAYD,IAAI,CAACE,UAAAA;AACf,aAAKC,QAAQD,MAAMA,MAAME,OAAO;MAClC,CAAA;AACA,aAAO;IACT;AACA,WAAO;EACT;EAEA,MAAcL,kBAAkB;AAC9B,WAAO,UAAMM,0BAAS,KAAK9C,UAAU;MAAE+C,UAAU;IAAO,CAAA;EAC1D;AACF;AA3EanD,sBAAAA,aAAAA;MADZoD,+BAAAA;GACYpD,mBAAAA;","names":["FilesystemArchivistConfigSchema","FilesystemArchivist","AbstractArchivist","configSchemas","_memoryArchivist","filePath","config","queries","ArchivistAllQuerySchema","ArchivistCommitQuerySchema","memoryArchivist","assertEx","dataFromRawJson","rawJson","data","JSON","parse","Array","isArray","payloads","payloadsFromRawPayloads","rawPayloads","map","payload","PayloadWrapper","wrap","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","creatableModule"]}

package/dist/index.mjs

@@ -0,0 +1,104 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/FilesystemArchivist.ts
+import { readFile } from "node:fs/promises";
+import { assertEx } from "@xylabs/assert";
+import { HDWallet } from "@xyo-network/account";
+import { AbstractArchivist } from "@xyo-network/archivist-abstract";
+import { ArchivistAllQuerySchema, ArchivistCommitQuerySchema } from "@xyo-network/archivist-model";
+import { handleError } from "@xyo-network/error";
+import { MemoryArchivist } from "@xyo-network/memory-archivist";
+import { creatableModule } from "@xyo-network/module";
+import { PayloadWrapper } from "@xyo-network/payload-wrapper";
+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 FilesystemArchivistConfigSchema = "network.xyo.archivist.filesystem.config";
+var FilesystemArchivist = class FilesystemArchivist2 extends AbstractArchivist {
+  static {
+    __name(this, "FilesystemArchivist");
+  }
+  static configSchemas = [
+    FilesystemArchivistConfigSchema
+  ];
+  _memoryArchivist;
+  get filePath() {
+    return this.config?.filePath ?? "archivist.xyo.json";
+  }
+  get queries() {
+    return [
+      ArchivistAllQuerySchema,
+      ArchivistCommitQuerySchema,
+      ...super.queries
+    ];
+  }
+  get memoryArchivist() {
+    return assertEx(this._memoryArchivist);
+  }
+  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) {
+    return rawPayloads.map((payload) => PayloadWrapper.wrap(payload).payload());
+  }
+  allHandler() {
+    return this.memoryArchivist.all();
+  }
+  clearHandler() {
+    return this.memoryArchivist.clear();
+  }
+  async commitHandler() {
+    return await this.memoryArchivist.commit();
+  }
+  deleteHandler(hashes) {
+    return this.memoryArchivist.delete(hashes);
+  }
+  async getHandler(hashes) {
+    return await this.memoryArchivist.get(hashes);
+  }
+  async insertHandler(payloads) {
+    return await this.memoryArchivist.insert(payloads);
+  }
+  async startHandler() {
+    await super.startHandler();
+    this._memoryArchivist = await MemoryArchivist.create({
+      account: await HDWallet.random()
+    });
+    try {
+      const data = FilesystemArchivist2.dataFromRawJson(await this.rawJsonFromFile());
+      await this._memoryArchivist.insert(data.payloads);
+    } catch (ex) {
+      handleError(ex, (error) => {
+        this.logger?.error(error.message);
+      });
+      return false;
+    }
+    return true;
+  }
+  async rawJsonFromFile() {
+    return await readFile(this.filePath, {
+      encoding: "utf8"
+    });
+  }
+};
+FilesystemArchivist = _ts_decorate([
+  creatableModule()
+], FilesystemArchivist);
+export {
+  FilesystemArchivist,
+  FilesystemArchivistConfigSchema
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/FilesystemArchivist.ts"],"sourcesContent":["import { readFile } from 'node:fs/promises'\n\nimport { assertEx } from '@xylabs/assert'\nimport { HDWallet } from '@xyo-network/account'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\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 { handleError } from '@xyo-network/error'\nimport { MemoryArchivist } from '@xyo-network/memory-archivist'\nimport { AnyConfigSchema, creatableModule } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { PayloadWrapper } from '@xyo-network/payload-wrapper'\nimport { PromisableArray } from '@xyo-network/promise'\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{\n  static override configSchemas = [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    data.payloads = this.payloadsFromRawPayloads(data.payloads)\n    return data\n  }\n\n  private static payloadsFromRawPayloads(rawPayloads: Payload[]) {\n    //validation should be done in here.  I don't believe parse does much validation yet.\n    return rawPayloads.map((payload) => PayloadWrapper.wrap(payload).payload())\n  }\n\n  protected override allHandler(): PromisableArray<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: string[]): PromisableArray<string> {\n    return this.memoryArchivist.delete(hashes)\n  }\n\n  protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n    return await this.memoryArchivist.get(hashes)\n  }\n\n  protected override async insertHandler(payloads: Payload[]): Promise<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,gBAAgB;AACzB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,kCAIK;AAEP,SAASC,mBAAmB;AAC5B,SAASC,uBAAuB;AAChC,SAA0BC,uBAAuB;AAEjD,SAASC,sBAAsB;;;;;;;;;;;;AAQxB,IAAMC,kCAAmE;AAahF,IAAaC,sBAAN,MAAAA,6BACGC,kBAAAA;SAAAA;;;EAGR,OAAgBC,gBAAgB;IAACH;;EAEzBI;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,+BAAA;AACnCH,aAASM,MAAMC,QAAQJ,KAAKK,QAAQ,GAAG,2DAAA;AACvCL,SAAKK,WAAW,KAAKC,wBAAwBN,KAAKK,QAAQ;AAC1D,WAAOL;EACT;EAEA,OAAeM,wBAAwBC,aAAwB;AAE7D,WAAOA,YAAYC,IAAI,CAACC,YAAYC,eAAeC,KAAKF,OAAAA,EAASA,QAAO,CAAA;EAC1E;EAEmBG,aAAuC;AACxD,WAAO,KAAKhB,gBAAgBiB,IAAG;EACjC;EAEmBC,eAAqC;AACtD,WAAO,KAAKlB,gBAAgBmB,MAAK;EACnC;EAEA,MAAyBC,gBAAyC;AAChE,WAAO,MAAM,KAAKpB,gBAAgBqB,OAAM;EAC1C;EAEmBC,cAAcC,QAA2C;AAC1E,WAAO,KAAKvB,gBAAgBwB,OAAOD,MAAAA;EACrC;EAEA,MAAyBE,WAAWF,QAAsC;AACxE,WAAO,MAAM,KAAKvB,gBAAgB0B,IAAIH,MAAAA;EACxC;EAEA,MAAyBI,cAAclB,UAAyC;AAC9E,WAAO,MAAM,KAAKT,gBAAgB4B,OAAOnB,QAAAA;EAC3C;EAEA,MAAyBoB,eAAe;AACtC,UAAM,MAAMA,aAAAA;AACZ,SAAKnC,mBAAmB,MAAMoC,gBAAgBC,OAAO;MAAEC,SAAS,MAAMC,SAASC,OAAM;IAAG,CAAA;AACxF,QAAI;AACF,YAAM9B,OAAOb,qBAAoBW,gBAAgB,MAAM,KAAKiC,gBAAe,CAAA;AAC3E,YAAM,KAAKzC,iBAAiBkC,OAAOxB,KAAKK,QAAQ;IAClD,SAAS2B,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,KAAK9C,UAAU;MAAE+C,UAAU;IAAO,CAAA;EAC1D;AACF;AA3EanD,sBAAAA,aAAAA;EADZoD,gBAAAA;GACYpD,mBAAAA;","names":["readFile","assertEx","HDWallet","AbstractArchivist","ArchivistAllQuerySchema","ArchivistCommitQuerySchema","handleError","MemoryArchivist","creatableModule","PayloadWrapper","FilesystemArchivistConfigSchema","FilesystemArchivist","AbstractArchivist","configSchemas","_memoryArchivist","filePath","config","queries","ArchivistAllQuerySchema","ArchivistCommitQuerySchema","memoryArchivist","assertEx","dataFromRawJson","rawJson","data","JSON","parse","Array","isArray","payloads","payloadsFromRawPayloads","rawPayloads","map","payload","PayloadWrapper","wrap","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","creatableModule"]}

package/package.json

@@ -10,45 +10,59 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xylabs/assert": "^2.9.3",
-    "@xyo-network/abstract-archivist": "~2.72.8",
-    "@xyo-network/account": "~2.72.8",
-    "@xyo-network/archivist-model": "~2.72.8",
-    "@xyo-network/boundwitness-model": "~2.72.8",
-    "@xyo-network/error": "~2.72.8",
-    "@xyo-network/memory-archivist": "~2.72.8",
-    "@xyo-network/module": "~2.72.8",
-    "@xyo-network/payload-model": "~2.72.8",
-    "@xyo-network/payload-wrapper": "~2.72.8",
-    "@xyo-network/promise": "~2.72.8"
+    "@xylabs/assert": "^2.10.7",
+    "@xyo-network/account": "~2.73.0",
+    "@xyo-network/archivist-abstract": "~2.73.0",
+    "@xyo-network/archivist-model": "~2.73.0",
+    "@xyo-network/boundwitness-model": "~2.73.0",
+    "@xyo-network/error": "~2.73.0",
+    "@xyo-network/memory-archivist": "~2.73.0",
+    "@xyo-network/module": "~2.73.0",
+    "@xyo-network/payload-model": "~2.73.0",
+    "@xyo-network/payload-wrapper": "~2.73.0",
+    "@xyo-network/promise": "~2.73.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^2.19.3",
-    "@xylabs/tsconfig": "^2.19.3",
+    "@xylabs/ts-scripts-yarn3": "^2.19.5",
+    "@xylabs/tsconfig": "^2.19.5",
+    "publint": "^0.2.2",
+    "tsup": "^7.2.0",
     "typescript": "^5.2.2"
   },
+  "scripts": {
+    "package-compile": "tsup && publint",
+    "package-recompile": "tsup && publint"
+  },
   "description": "Primary SDK for using XYO Protocol 2.0",
-  "browser": "dist/esm/index.js",
   "docs": "dist/docs.json",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "node": {
-        "import": "./dist/esm/index.js",
-        "require": "./dist/cjs/index.js"
-      },
-      "browser": {
-        "import": "./dist/esm/index.js",
-        "require": "./dist/cjs/index.js"
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
       },
-      "default": "./dist/esm/index.js"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      }
     },
     "./dist/docs.json": {
       "default": "./dist/docs.json"
     },
+    "./cjs": {
+      "default": "./dist/index.js"
+    },
+    "./docs": {
+      "default": "./dist/docs.json"
+    },
+    "./esm": {
+      "default": "./dist/index.mjs"
+    },
     "./package.json": "./package.json"
   },
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "homepage": "https://xyo.network",
   "license": "LGPL-3.0",
   "publishConfig": {
@@ -59,6 +73,5 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "types": "dist/types/index.d.ts",
-  "version": "2.72.8"
+  "version": "2.73.0"
 }

package/src/FilesystemArchivist.ts

@@ -1,8 +1,8 @@
 import { readFile } from 'node:fs/promises'
 
 import { assertEx } from '@xylabs/assert'
-import { AbstractArchivist } from '@xyo-network/abstract-archivist'
 import { HDWallet } from '@xyo-network/account'
+import { AbstractArchivist } from '@xyo-network/archivist-abstract'
 import {
   ArchivistAllQuerySchema,
   ArchivistCommitQuerySchema,

package/tsup.config.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from 'tsup'
+
+// eslint-disable-next-line import/no-default-export
+export default defineConfig({
+  bundle: true,
+  cjsInterop: true,
+  clean: true,
+  dts: {
+    entry: ['src/index.ts'],
+  },
+  entry: ['src/index.ts'],
+  format: ['cjs', 'esm'],
+  sourcemap: true,
+  splitting: false,
+  tsconfig: 'tsconfig.json',
+})

package/dist/cjs/FilesystemArchivist.js

@@ -1,96 +0,0 @@
-"use strict";
-var FilesystemArchivist_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FilesystemArchivist = exports.FilesystemArchivistConfigSchema = void 0;
-const tslib_1 = require("tslib");
-const promises_1 = require("node:fs/promises");
-const assert_1 = require("@xylabs/assert");
-const abstract_archivist_1 = require("@xyo-network/abstract-archivist");
-const account_1 = require("@xyo-network/account");
-const archivist_model_1 = require("@xyo-network/archivist-model");
-const error_1 = require("@xyo-network/error");
-const memory_archivist_1 = require("@xyo-network/memory-archivist");
-const module_1 = require("@xyo-network/module");
-const payload_wrapper_1 = require("@xyo-network/payload-wrapper");
-exports.FilesystemArchivistConfigSchema = 'network.xyo.archivist.filesystem.config';
-/** @description Currently only a read-only archivist that loads payloads from filesystem
- * but allows for future expansion to read/write
- */
-let FilesystemArchivist = exports.FilesystemArchivist = FilesystemArchivist_1 = class FilesystemArchivist extends abstract_archivist_1.AbstractArchivist {
-    get filePath() {
-        var _a, _b;
-        return (_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.filePath) !== null && _b !== void 0 ? _b : 'archivist.xyo.json';
-    }
-    get queries() {
-        return [archivist_model_1.ArchivistAllQuerySchema, archivist_model_1.ArchivistCommitQuerySchema, ...super.queries];
-    }
-    get memoryArchivist() {
-        return (0, assert_1.assertEx)(this._memoryArchivist);
-    }
-    static dataFromRawJson(rawJson) {
-        const data = JSON.parse(rawJson);
-        (0, assert_1.assertEx)(typeof data === 'object', 'Archivist Data must be object');
-        (0, assert_1.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) => payload_wrapper_1.PayloadWrapper.wrap(payload).payload());
-    }
-    allHandler() {
-        return this.memoryArchivist.all();
-    }
-    clearHandler() {
-        return this.memoryArchivist.clear();
-    }
-    commitHandler() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            return yield this.memoryArchivist.commit();
-        });
-    }
-    deleteHandler(hashes) {
-        return this.memoryArchivist.delete(hashes);
-    }
-    getHandler(hashes) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            return yield this.memoryArchivist.get(hashes);
-        });
-    }
-    insertHandler(payloads) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            return yield this.memoryArchivist.insert(payloads);
-        });
-    }
-    startHandler() {
-        const _super = Object.create(null, {
-            startHandler: { get: () => super.startHandler }
-        });
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield _super.startHandler.call(this);
-            this._memoryArchivist = yield memory_archivist_1.MemoryArchivist.create({ account: yield account_1.HDWallet.random() });
-            try {
-                const data = FilesystemArchivist_1.dataFromRawJson(yield this.rawJsonFromFile());
-                yield this._memoryArchivist.insert(data.payloads);
-            }
-            catch (ex) {
-                (0, error_1.handleError)(ex, (error) => {
-                    var _a;
-                    (_a = this.logger) === null || _a === void 0 ? void 0 : _a.error(error.message);
-                });
-                return false;
-            }
-            return true;
-        });
-    }
-    rawJsonFromFile() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            return yield (0, promises_1.readFile)(this.filePath, { encoding: 'utf8' });
-        });
-    }
-};
-FilesystemArchivist.configSchemas = [exports.FilesystemArchivistConfigSchema];
-exports.FilesystemArchivist = FilesystemArchivist = FilesystemArchivist_1 = tslib_1.__decorate([
-    (0, module_1.creatableModule)()
-], FilesystemArchivist);
-//# sourceMappingURL=FilesystemArchivist.js.map

package/dist/cjs/FilesystemArchivist.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FilesystemArchivist.js","sourceRoot":"","sources":["../../src/FilesystemArchivist.ts"],"names":[],"mappings":";;;;;AAAA,+CAA2C;AAE3C,2CAAyC;AACzC,wEAAmE;AACnE,kDAA+C;AAC/C,kEAMqC;AAErC,8CAAgD;AAChD,oEAA+D;AAC/D,gDAAsE;AAEtE,kEAA6D;AAQhD,QAAA,+BAA+B,GAAoC,yCAAyC,CAAA;AASzH;;GAEG;AAEI,IAAM,mBAAmB,yDAAzB,MAAM,mBACX,SAAQ,sCAA0B;IAOlC,IAAI,QAAQ;;QACV,OAAO,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,QAAQ,mCAAI,oBAAoB,CAAA;IACtD,CAAC;IAED,IAAa,OAAO;QAClB,OAAO,CAAC,yCAAuB,EAAE,4CAA0B,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IAChF,CAAC;IAED,IAAY,eAAe;QACzB,OAAO,IAAA,iBAAQ,EAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;IACxC,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,OAAe;QAC5C,MAAM,IAAI,GAA4B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACzD,IAAA,iBAAQ,EAAC,OAAO,IAAI,KAAK,QAAQ,EAAE,+BAA+B,CAAC,CAAA;QACnE,IAAA,iBAAQ,EAAC,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,WAAsB;QAC3D,qFAAqF;QACrF,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,gCAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;IAC7E,CAAC;IAEkB,UAAU;QAC3B,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,CAAA;IACnC,CAAC;IAEkB,YAAY;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAA;IACrC,CAAC;IAEwB,aAAa;;YACpC,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAA;QAC5C,CAAC;KAAA;IAEkB,aAAa,CAAC,MAAgB;QAC/C,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC5C,CAAC;IAEwB,UAAU,CAAC,MAAgB;;YAClD,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAC/C,CAAC;KAAA;IAEwB,aAAa,CAAC,QAAmB;;YACxD,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QACpD,CAAC;KAAA;IAEwB,YAAY;;;;;YACnC,MAAM,OAAM,YAAY,WAAE,CAAA;YAC1B,IAAI,CAAC,gBAAgB,GAAG,MAAM,kCAAe,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,kBAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;YAC1F,IAAI;gBACF,MAAM,IAAI,GAAG,qBAAmB,CAAC,eAAe,CAAC,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC,CAAA;gBAC9E,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;aAClD;YAAC,OAAO,EAAE,EAAE;gBACX,IAAA,mBAAW,EAAC,EAAE,EAAE,CAAC,KAAK,EAAE,EAAE;;oBACxB,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;gBACnC,CAAC,CAAC,CAAA;gBACF,OAAO,KAAK,CAAA;aACb;YACD,OAAO,IAAI,CAAA;QACb,CAAC;KAAA;IAEa,eAAe;;YAC3B,OAAO,MAAM,IAAA,mBAAQ,EAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAA;QAC5D,CAAC;KAAA;;AAtEe,iCAAa,GAAG,CAAC,uCAA+B,CAAC,AAApC,CAAoC;8BAJtD,mBAAmB;IAD/B,IAAA,wBAAe,GAAE;GACL,mBAAmB,CA2E/B"}

package/dist/cjs/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./FilesystemArchivist"), exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

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