@xyo-network/file-browser-plugin 2.87.2

package/dist/node/index.cjs

@@ -0,0 +1,134 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  BrowserFilePlugin: () => BrowserFilePlugin,
+  BrowserFileWitness: () => BrowserFileWitness,
+  FileSchema: () => FileSchema,
+  FileWitness: () => FileWitness,
+  FileWitnessConfigSchema: () => FileWitnessConfigSchema,
+  default: () => BrowserFilePlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/BrowserFileWitness.ts
+var import_assert = require("@xylabs/assert");
+var import_payload_builder = require("@xyo-network/payload-builder");
+var import_sha = __toESM(require("sha.js"), 1);
+
+// src/Config.ts
+var FileWitnessConfigSchema = "network.xyo.file.witness.config";
+
+// src/Schema.ts
+var FileSchema = "network.xyo.file";
+
+// src/util/GenerateDataUri.ts
+var import_base = require("@scure/base");
+var generateDataUri = (data) => {
+  return `data:application/octet-stream;base64,${import_base.base64.encode(data)}`;
+};
+
+// src/Witness.ts
+var import_abstract_witness = require("@xyo-network/abstract-witness");
+var FileWitness = class extends import_abstract_witness.AbstractWitness {
+  static configSchemas = [FileWitnessConfigSchema];
+  observeHandler(payloads) {
+    return [{ ...payloads == null ? void 0 : payloads[0], schema: FileSchema }];
+  }
+};
+
+// src/BrowserFileWitness.ts
+var BrowserFileWitness = class extends FileWitness {
+  static configSchemas = [FileWitnessConfigSchema];
+  async observeHandler() {
+    try {
+      const [payload] = await this.witnessBrowserFile();
+      console.log(`BrowserFileWitness: ${await import_payload_builder.PayloadBuilder.dataHash(payload)}`);
+      return [payload];
+    } catch (e) {
+      throw new Error(`Error reading file: ${e}`);
+    }
+  }
+  readBinaryFile(file) {
+    return new Promise((resolve, reject) => {
+      const fileReader = new FileReader();
+      fileReader.addEventListener("load", (event) => {
+        var _a;
+        const arrayBuffer = (_a = event.target) == null ? void 0 : _a.result;
+        resolve(new Uint8Array(arrayBuffer));
+      });
+      fileReader.onerror = () => reject(fileReader.error);
+      fileReader.readAsArrayBuffer(file);
+    });
+  }
+  async witnessBrowserFile() {
+    const file = (0, import_assert.assertEx)(this.params.file, "File is missing from params");
+    const fileBinary = await this.readBinaryFile(file);
+    const result = new Uint8Array(fileBinary);
+    const hash = (0, import_sha.default)("sha256").update(result).digest("hex").padStart(64, "0");
+    return [
+      {
+        hash,
+        length: fileBinary.byteLength,
+        meta: {
+          name: file.name,
+          type: file.type
+        },
+        modified: file.lastModified,
+        schema: FileSchema,
+        uri: this.config.storage === "data-uri" ? generateDataUri(fileBinary) : file.name
+      },
+      fileBinary
+    ];
+  }
+};
+
+// src/PluginBrowser.ts
+var import_payload_model = require("@xyo-network/payload-model");
+var import_payloadset_plugin = require("@xyo-network/payloadset-plugin");
+var BrowserFilePlugin = () => (0, import_payloadset_plugin.createPayloadSetWitnessPlugin)(
+  { required: { [FileSchema]: 1 }, schema: import_payload_model.PayloadSetSchema },
+  {
+    witness: async (params) => {
+      const result = await BrowserFileWitness.create(params);
+      return result;
+    }
+  }
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BrowserFilePlugin,
+  BrowserFileWitness,
+  FileSchema,
+  FileWitness,
+  FileWitnessConfigSchema
+});
+//# sourceMappingURL=index.cjs.map

package/dist/node/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.ts","../../src/BrowserFileWitness.ts","../../src/Config.ts","../../src/Schema.ts","../../src/util/GenerateDataUri.ts","../../src/Witness.ts","../../src/PluginBrowser.ts"],"sourcesContent":["export * from './BrowserFileWitness'\nexport * from './Config'\nexport * from './Params'\nexport { BrowserFilePlugin, BrowserFilePlugin as default } from './PluginBrowser'\nexport * from './Schema'\nexport * from './Witness'\n","import { assertEx } from '@xylabs/assert'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport shajs from 'sha.js'\n\nimport { FileWitnessConfigSchema } from './Config'\nimport { BrowserFileWitnessAdditionalParams } from './Params'\nimport { FilePayload } from './Payload'\nimport { FileSchema } from './Schema'\nimport { generateDataUri } from './util'\nimport { FileWitness, FileWitnessParams } from './Witness'\n\ntype BrowserFileWitnessParams = FileWitnessParams & BrowserFileWitnessAdditionalParams\n\nexport class BrowserFileWitness extends FileWitness<BrowserFileWitnessParams> {\n  static override configSchemas = [FileWitnessConfigSchema]\n\n  protected override async observeHandler() {\n    try {\n      const [payload] = await this.witnessBrowserFile()\n      console.log(`BrowserFileWitness: ${await PayloadBuilder.dataHash(payload)}`)\n      return [payload]\n    } catch (e) {\n      throw new Error(`Error reading file: ${e}`)\n    }\n  }\n\n  private readBinaryFile(file: File): Promise<Uint8Array> {\n    return new Promise((resolve, reject) => {\n      const fileReader = new FileReader()\n      fileReader.addEventListener('load', (event) => {\n        const arrayBuffer = event.target?.result as ArrayBuffer\n        resolve(new Uint8Array(arrayBuffer))\n      })\n      // eslint-disable-next-line unicorn/prefer-add-event-listener\n      fileReader.onerror = () => reject(fileReader.error)\n      // eslint-disable-next-line unicorn/prefer-blob-reading-methods\n      fileReader.readAsArrayBuffer(file)\n    })\n  }\n\n  private async witnessBrowserFile(): Promise<[FilePayload, Uint8Array]> {\n    const file = assertEx(this.params.file, 'File is missing from params')\n    const fileBinary = await this.readBinaryFile(file)\n    const result = new Uint8Array(fileBinary)\n    const hash = shajs('sha256').update(result).digest('hex').padStart(64, '0')\n\n    return [\n      {\n        hash,\n        length: fileBinary.byteLength,\n        meta: {\n          name: file.name,\n          type: file.type,\n        },\n        modified: file.lastModified,\n        schema: FileSchema,\n        uri: this.config.storage === 'data-uri' ? generateDataUri(fileBinary) : file.name,\n      },\n      fileBinary,\n    ]\n  }\n}\n","import { WitnessConfig } from '@xyo-network/witness-model'\n\nexport type FileWitnessConfigSchema = 'network.xyo.file.witness.config'\nexport const FileWitnessConfigSchema: FileWitnessConfigSchema = 'network.xyo.file.witness.config'\n\nexport type FileWitnessConfig = WitnessConfig<{\n  schema: FileWitnessConfigSchema\n  storage?: 'data-uri'\n}>\n","export type FileSchema = 'network.xyo.file'\nexport const FileSchema: FileSchema = 'network.xyo.file'\n","import { base64 } from '@scure/base'\n\nexport const generateDataUri = (data: Uint8Array): string => {\n  return `data:application/octet-stream;base64,${base64.encode(data)}`\n}\n","import { Promisable } from '@xylabs/promise'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport { AnyConfigSchema } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\nimport { WitnessModule, WitnessParams } from '@xyo-network/witness-model'\n\nimport { FileWitnessConfig, FileWitnessConfigSchema } from './Config'\nimport { FileSchema } from './Schema'\n\nexport type FileWitnessParams = WitnessParams<AnyConfigSchema<FileWitnessConfig>>\n\n// Abstract so that derived classes provide a type for the file param and methods to parse it\nexport abstract class FileWitness<TParams extends FileWitnessParams = FileWitnessParams> extends AbstractWitness<TParams> implements WitnessModule {\n  static override configSchemas = [FileWitnessConfigSchema]\n\n  protected override observeHandler(payloads?: Payload[]): Promisable<Payload[]> {\n    return [{ ...payloads?.[0], schema: FileSchema }]\n  }\n}\n","import { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'\n\nimport { BrowserFileWitness } from './BrowserFileWitness'\nimport { FileSchema } from './Schema'\n\nexport const BrowserFilePlugin = () =>\n  createPayloadSetWitnessPlugin<BrowserFileWitness>(\n    { required: { [FileSchema]: 1 }, schema: PayloadSetSchema },\n    {\n      witness: async (params) => {\n        const result = await BrowserFileWitness.create(params)\n        return result\n      },\n    },\n  )\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,oBAAyB;AACzB,6BAA+B;AAC/B,iBAAkB;;;ACCX,IAAM,0BAAmD;;;ACFzD,IAAM,aAAyB;;;ACDtC,kBAAuB;AAEhB,IAAM,kBAAkB,CAAC,SAA6B;AAC3D,SAAO,wCAAwC,mBAAO,OAAO,IAAI,CAAC;AACpE;;;ACHA,8BAAgC;AAWzB,IAAe,cAAf,cAA0F,wCAAkD;AAAA,EACjJ,OAAgB,gBAAgB,CAAC,uBAAuB;AAAA,EAErC,eAAe,UAA6C;AAC7E,WAAO,CAAC,EAAE,GAAG,qCAAW,IAAI,QAAQ,WAAW,CAAC;AAAA,EAClD;AACF;;;AJLO,IAAM,qBAAN,cAAiC,YAAsC;AAAA,EAC5E,OAAgB,gBAAgB,CAAC,uBAAuB;AAAA,EAExD,MAAyB,iBAAiB;AACxC,QAAI;AACF,YAAM,CAAC,OAAO,IAAI,MAAM,KAAK,mBAAmB;AAChD,cAAQ,IAAI,uBAAuB,MAAM,sCAAe,SAAS,OAAO,CAAC,EAAE;AAC3E,aAAO,CAAC,OAAO;AAAA,IACjB,SAAS,GAAG;AACV,YAAM,IAAI,MAAM,uBAAuB,CAAC,EAAE;AAAA,IAC5C;AAAA,EACF;AAAA,EAEQ,eAAe,MAAiC;AACtD,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,YAAM,aAAa,IAAI,WAAW;AAClC,iBAAW,iBAAiB,QAAQ,CAAC,UAAU;AA7BrD;AA8BQ,cAAM,eAAc,WAAM,WAAN,mBAAc;AAClC,gBAAQ,IAAI,WAAW,WAAW,CAAC;AAAA,MACrC,CAAC;AAED,iBAAW,UAAU,MAAM,OAAO,WAAW,KAAK;AAElD,iBAAW,kBAAkB,IAAI;AAAA,IACnC,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,qBAAyD;AACrE,UAAM,WAAO,wBAAS,KAAK,OAAO,MAAM,6BAA6B;AACrE,UAAM,aAAa,MAAM,KAAK,eAAe,IAAI;AACjD,UAAM,SAAS,IAAI,WAAW,UAAU;AACxC,UAAM,WAAO,WAAAA,SAAM,QAAQ,EAAE,OAAO,MAAM,EAAE,OAAO,KAAK,EAAE,SAAS,IAAI,GAAG;AAE1E,WAAO;AAAA,MACL;AAAA,QACE;AAAA,QACA,QAAQ,WAAW;AAAA,QACnB,MAAM;AAAA,UACJ,MAAM,KAAK;AAAA,UACX,MAAM,KAAK;AAAA,QACb;AAAA,QACA,UAAU,KAAK;AAAA,QACf,QAAQ;AAAA,QACR,KAAK,KAAK,OAAO,YAAY,aAAa,gBAAgB,UAAU,IAAI,KAAK;AAAA,MAC/E;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF;;;AK7DA,2BAAiC;AACjC,+BAA8C;AAKvC,IAAM,oBAAoB,UAC/B;AAAA,EACE,EAAE,UAAU,EAAE,CAAC,UAAU,GAAG,EAAE,GAAG,QAAQ,sCAAiB;AAAA,EAC1D;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,YAAM,SAAS,MAAM,mBAAmB,OAAO,MAAM;AACrD,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":["shajs"]}

package/dist/node/index.d.cts

@@ -0,0 +1,7 @@
+export * from './BrowserFileWitness';
+export * from './Config';
+export * from './Params';
+export { BrowserFilePlugin, BrowserFilePlugin as default } from './PluginBrowser';
+export * from './Schema';
+export * from './Witness';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,IAAI,OAAO,EAAE,MAAM,iBAAiB,CAAA;AACjF,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA"}

package/dist/node/index.d.mts

@@ -0,0 +1,7 @@
+export * from './BrowserFileWitness';
+export * from './Config';
+export * from './Params';
+export { BrowserFilePlugin, BrowserFilePlugin as default } from './PluginBrowser';
+export * from './Schema';
+export * from './Witness';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,IAAI,OAAO,EAAE,MAAM,iBAAiB,CAAA;AACjF,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA"}

package/dist/node/index.d.ts

@@ -0,0 +1,7 @@
+export * from './BrowserFileWitness';
+export * from './Config';
+export * from './Params';
+export { BrowserFilePlugin, BrowserFilePlugin as default } from './PluginBrowser';
+export * from './Schema';
+export * from './Witness';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,IAAI,OAAO,EAAE,MAAM,iBAAiB,CAAA;AACjF,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA"}

package/dist/node/index.js

@@ -0,0 +1,93 @@
+// src/BrowserFileWitness.ts
+import { assertEx } from "@xylabs/assert";
+import { PayloadBuilder } from "@xyo-network/payload-builder";
+import shajs from "sha.js";
+
+// src/Config.ts
+var FileWitnessConfigSchema = "network.xyo.file.witness.config";
+
+// src/Schema.ts
+var FileSchema = "network.xyo.file";
+
+// src/util/GenerateDataUri.ts
+import { base64 } from "@scure/base";
+var generateDataUri = (data) => {
+  return `data:application/octet-stream;base64,${base64.encode(data)}`;
+};
+
+// src/Witness.ts
+import { AbstractWitness } from "@xyo-network/abstract-witness";
+var FileWitness = class extends AbstractWitness {
+  static configSchemas = [FileWitnessConfigSchema];
+  observeHandler(payloads) {
+    return [{ ...payloads == null ? void 0 : payloads[0], schema: FileSchema }];
+  }
+};
+
+// src/BrowserFileWitness.ts
+var BrowserFileWitness = class extends FileWitness {
+  static configSchemas = [FileWitnessConfigSchema];
+  async observeHandler() {
+    try {
+      const [payload] = await this.witnessBrowserFile();
+      console.log(`BrowserFileWitness: ${await PayloadBuilder.dataHash(payload)}`);
+      return [payload];
+    } catch (e) {
+      throw new Error(`Error reading file: ${e}`);
+    }
+  }
+  readBinaryFile(file) {
+    return new Promise((resolve, reject) => {
+      const fileReader = new FileReader();
+      fileReader.addEventListener("load", (event) => {
+        var _a;
+        const arrayBuffer = (_a = event.target) == null ? void 0 : _a.result;
+        resolve(new Uint8Array(arrayBuffer));
+      });
+      fileReader.onerror = () => reject(fileReader.error);
+      fileReader.readAsArrayBuffer(file);
+    });
+  }
+  async witnessBrowserFile() {
+    const file = assertEx(this.params.file, "File is missing from params");
+    const fileBinary = await this.readBinaryFile(file);
+    const result = new Uint8Array(fileBinary);
+    const hash = shajs("sha256").update(result).digest("hex").padStart(64, "0");
+    return [
+      {
+        hash,
+        length: fileBinary.byteLength,
+        meta: {
+          name: file.name,
+          type: file.type
+        },
+        modified: file.lastModified,
+        schema: FileSchema,
+        uri: this.config.storage === "data-uri" ? generateDataUri(fileBinary) : file.name
+      },
+      fileBinary
+    ];
+  }
+};
+
+// src/PluginBrowser.ts
+import { PayloadSetSchema } from "@xyo-network/payload-model";
+import { createPayloadSetWitnessPlugin } from "@xyo-network/payloadset-plugin";
+var BrowserFilePlugin = () => createPayloadSetWitnessPlugin(
+  { required: { [FileSchema]: 1 }, schema: PayloadSetSchema },
+  {
+    witness: async (params) => {
+      const result = await BrowserFileWitness.create(params);
+      return result;
+    }
+  }
+);
+export {
+  BrowserFilePlugin,
+  BrowserFileWitness,
+  FileSchema,
+  FileWitness,
+  FileWitnessConfigSchema,
+  BrowserFilePlugin as default
+};
+//# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/BrowserFileWitness.ts","../../src/Config.ts","../../src/Schema.ts","../../src/util/GenerateDataUri.ts","../../src/Witness.ts","../../src/PluginBrowser.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport shajs from 'sha.js'\n\nimport { FileWitnessConfigSchema } from './Config'\nimport { BrowserFileWitnessAdditionalParams } from './Params'\nimport { FilePayload } from './Payload'\nimport { FileSchema } from './Schema'\nimport { generateDataUri } from './util'\nimport { FileWitness, FileWitnessParams } from './Witness'\n\ntype BrowserFileWitnessParams = FileWitnessParams & BrowserFileWitnessAdditionalParams\n\nexport class BrowserFileWitness extends FileWitness<BrowserFileWitnessParams> {\n  static override configSchemas = [FileWitnessConfigSchema]\n\n  protected override async observeHandler() {\n    try {\n      const [payload] = await this.witnessBrowserFile()\n      console.log(`BrowserFileWitness: ${await PayloadBuilder.dataHash(payload)}`)\n      return [payload]\n    } catch (e) {\n      throw new Error(`Error reading file: ${e}`)\n    }\n  }\n\n  private readBinaryFile(file: File): Promise<Uint8Array> {\n    return new Promise((resolve, reject) => {\n      const fileReader = new FileReader()\n      fileReader.addEventListener('load', (event) => {\n        const arrayBuffer = event.target?.result as ArrayBuffer\n        resolve(new Uint8Array(arrayBuffer))\n      })\n      // eslint-disable-next-line unicorn/prefer-add-event-listener\n      fileReader.onerror = () => reject(fileReader.error)\n      // eslint-disable-next-line unicorn/prefer-blob-reading-methods\n      fileReader.readAsArrayBuffer(file)\n    })\n  }\n\n  private async witnessBrowserFile(): Promise<[FilePayload, Uint8Array]> {\n    const file = assertEx(this.params.file, 'File is missing from params')\n    const fileBinary = await this.readBinaryFile(file)\n    const result = new Uint8Array(fileBinary)\n    const hash = shajs('sha256').update(result).digest('hex').padStart(64, '0')\n\n    return [\n      {\n        hash,\n        length: fileBinary.byteLength,\n        meta: {\n          name: file.name,\n          type: file.type,\n        },\n        modified: file.lastModified,\n        schema: FileSchema,\n        uri: this.config.storage === 'data-uri' ? generateDataUri(fileBinary) : file.name,\n      },\n      fileBinary,\n    ]\n  }\n}\n","import { WitnessConfig } from '@xyo-network/witness-model'\n\nexport type FileWitnessConfigSchema = 'network.xyo.file.witness.config'\nexport const FileWitnessConfigSchema: FileWitnessConfigSchema = 'network.xyo.file.witness.config'\n\nexport type FileWitnessConfig = WitnessConfig<{\n  schema: FileWitnessConfigSchema\n  storage?: 'data-uri'\n}>\n","export type FileSchema = 'network.xyo.file'\nexport const FileSchema: FileSchema = 'network.xyo.file'\n","import { base64 } from '@scure/base'\n\nexport const generateDataUri = (data: Uint8Array): string => {\n  return `data:application/octet-stream;base64,${base64.encode(data)}`\n}\n","import { Promisable } from '@xylabs/promise'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport { AnyConfigSchema } from '@xyo-network/module-model'\nimport { Payload } from '@xyo-network/payload-model'\nimport { WitnessModule, WitnessParams } from '@xyo-network/witness-model'\n\nimport { FileWitnessConfig, FileWitnessConfigSchema } from './Config'\nimport { FileSchema } from './Schema'\n\nexport type FileWitnessParams = WitnessParams<AnyConfigSchema<FileWitnessConfig>>\n\n// Abstract so that derived classes provide a type for the file param and methods to parse it\nexport abstract class FileWitness<TParams extends FileWitnessParams = FileWitnessParams> extends AbstractWitness<TParams> implements WitnessModule {\n  static override configSchemas = [FileWitnessConfigSchema]\n\n  protected override observeHandler(payloads?: Payload[]): Promisable<Payload[]> {\n    return [{ ...payloads?.[0], schema: FileSchema }]\n  }\n}\n","import { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'\n\nimport { BrowserFileWitness } from './BrowserFileWitness'\nimport { FileSchema } from './Schema'\n\nexport const BrowserFilePlugin = () =>\n  createPayloadSetWitnessPlugin<BrowserFileWitness>(\n    { required: { [FileSchema]: 1 }, schema: PayloadSetSchema },\n    {\n      witness: async (params) => {\n        const result = await BrowserFileWitness.create(params)\n        return result\n      },\n    },\n  )\n"],"mappings":";AAAA,SAAS,gBAAgB;AACzB,SAAS,sBAAsB;AAC/B,OAAO,WAAW;;;ACCX,IAAM,0BAAmD;;;ACFzD,IAAM,aAAyB;;;ACDtC,SAAS,cAAc;AAEhB,IAAM,kBAAkB,CAAC,SAA6B;AAC3D,SAAO,wCAAwC,OAAO,OAAO,IAAI,CAAC;AACpE;;;ACHA,SAAS,uBAAuB;AAWzB,IAAe,cAAf,cAA0F,gBAAkD;AAAA,EACjJ,OAAgB,gBAAgB,CAAC,uBAAuB;AAAA,EAErC,eAAe,UAA6C;AAC7E,WAAO,CAAC,EAAE,GAAG,qCAAW,IAAI,QAAQ,WAAW,CAAC;AAAA,EAClD;AACF;;;AJLO,IAAM,qBAAN,cAAiC,YAAsC;AAAA,EAC5E,OAAgB,gBAAgB,CAAC,uBAAuB;AAAA,EAExD,MAAyB,iBAAiB;AACxC,QAAI;AACF,YAAM,CAAC,OAAO,IAAI,MAAM,KAAK,mBAAmB;AAChD,cAAQ,IAAI,uBAAuB,MAAM,eAAe,SAAS,OAAO,CAAC,EAAE;AAC3E,aAAO,CAAC,OAAO;AAAA,IACjB,SAAS,GAAG;AACV,YAAM,IAAI,MAAM,uBAAuB,CAAC,EAAE;AAAA,IAC5C;AAAA,EACF;AAAA,EAEQ,eAAe,MAAiC;AACtD,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,YAAM,aAAa,IAAI,WAAW;AAClC,iBAAW,iBAAiB,QAAQ,CAAC,UAAU;AA7BrD;AA8BQ,cAAM,eAAc,WAAM,WAAN,mBAAc;AAClC,gBAAQ,IAAI,WAAW,WAAW,CAAC;AAAA,MACrC,CAAC;AAED,iBAAW,UAAU,MAAM,OAAO,WAAW,KAAK;AAElD,iBAAW,kBAAkB,IAAI;AAAA,IACnC,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,qBAAyD;AACrE,UAAM,OAAO,SAAS,KAAK,OAAO,MAAM,6BAA6B;AACrE,UAAM,aAAa,MAAM,KAAK,eAAe,IAAI;AACjD,UAAM,SAAS,IAAI,WAAW,UAAU;AACxC,UAAM,OAAO,MAAM,QAAQ,EAAE,OAAO,MAAM,EAAE,OAAO,KAAK,EAAE,SAAS,IAAI,GAAG;AAE1E,WAAO;AAAA,MACL;AAAA,QACE;AAAA,QACA,QAAQ,WAAW;AAAA,QACnB,MAAM;AAAA,UACJ,MAAM,KAAK;AAAA,UACX,MAAM,KAAK;AAAA,QACb;AAAA,QACA,UAAU,KAAK;AAAA,QACf,QAAQ;AAAA,QACR,KAAK,KAAK,OAAO,YAAY,aAAa,gBAAgB,UAAU,IAAI,KAAK;AAAA,MAC/E;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF;;;AK7DA,SAAS,wBAAwB;AACjC,SAAS,qCAAqC;AAKvC,IAAM,oBAAoB,MAC/B;AAAA,EACE,EAAE,UAAU,EAAE,CAAC,UAAU,GAAG,EAAE,GAAG,QAAQ,iBAAiB;AAAA,EAC1D;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,YAAM,SAAS,MAAM,mBAAmB,OAAO,MAAM;AACrD,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":[]}

package/dist/node/util/GenerateDataUri.d.cts

@@ -0,0 +1,2 @@
+export declare const generateDataUri: (data: Uint8Array) => string;
+//# sourceMappingURL=GenerateDataUri.d.ts.map

package/dist/node/util/GenerateDataUri.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenerateDataUri.d.ts","sourceRoot":"","sources":["../../../src/util/GenerateDataUri.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe,SAAU,UAAU,KAAG,MAElD,CAAA"}

package/dist/node/util/GenerateDataUri.d.mts

@@ -0,0 +1,2 @@
+export declare const generateDataUri: (data: Uint8Array) => string;
+//# sourceMappingURL=GenerateDataUri.d.ts.map

package/dist/node/util/GenerateDataUri.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenerateDataUri.d.ts","sourceRoot":"","sources":["../../../src/util/GenerateDataUri.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe,SAAU,UAAU,KAAG,MAElD,CAAA"}

package/dist/node/util/GenerateDataUri.d.ts

@@ -0,0 +1,2 @@
+export declare const generateDataUri: (data: Uint8Array) => string;
+//# sourceMappingURL=GenerateDataUri.d.ts.map

package/dist/node/util/GenerateDataUri.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenerateDataUri.d.ts","sourceRoot":"","sources":["../../../src/util/GenerateDataUri.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe,SAAU,UAAU,KAAG,MAElD,CAAA"}

package/dist/node/util/index.d.cts

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

package/dist/node/util/index.d.cts.map

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

package/dist/node/util/index.d.mts

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

package/dist/node/util/index.d.mts.map

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

package/dist/node/util/index.d.ts

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

package/dist/node/util/index.d.ts.map

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

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@xyo-network/file-browser-plugin",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/plugins/issues"
+  },
+  "dependencies": {
+    "@scure/base": "^1.1.5",
+    "@xylabs/assert": "^2.14.0",
+    "@xylabs/promise": "^2.14.0",
+    "@xyo-network/abstract-witness": "^2.89.3",
+    "@xyo-network/module-model": "^2.89.3",
+    "@xyo-network/payload-builder": "^2.89.3",
+    "@xyo-network/payload-model": "^2.89.3",
+    "@xyo-network/payloadset-plugin": "^2.89.3",
+    "@xyo-network/witness-model": "^2.89.3",
+    "sha.js": "^2.4.11"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.2.42",
+    "@xylabs/tsconfig": "^3.2.42",
+    "@xyo-network/account": "^2.89.3",
+    "typescript": "^5.3.3"
+  },
+  "description": "Typescript/Javascript Plugins for XYO Platform",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.cts",
+          "default": "./dist/node/index.cjs"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.js"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "types": "dist/node/index.d.ts",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/plugins.git"
+  },
+  "sideEffects": false,
+  "version": "2.87.2",
+  "type": "module"
+}

package/src/BrowserFileWitness.ts

@@ -0,0 +1,62 @@
+import { assertEx } from '@xylabs/assert'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import shajs from 'sha.js'
+
+import { FileWitnessConfigSchema } from './Config'
+import { BrowserFileWitnessAdditionalParams } from './Params'
+import { FilePayload } from './Payload'
+import { FileSchema } from './Schema'
+import { generateDataUri } from './util'
+import { FileWitness, FileWitnessParams } from './Witness'
+
+type BrowserFileWitnessParams = FileWitnessParams & BrowserFileWitnessAdditionalParams
+
+export class BrowserFileWitness extends FileWitness<BrowserFileWitnessParams> {
+  static override configSchemas = [FileWitnessConfigSchema]
+
+  protected override async observeHandler() {
+    try {
+      const [payload] = await this.witnessBrowserFile()
+      console.log(`BrowserFileWitness: ${await PayloadBuilder.dataHash(payload)}`)
+      return [payload]
+    } catch (e) {
+      throw new Error(`Error reading file: ${e}`)
+    }
+  }
+
+  private readBinaryFile(file: File): Promise<Uint8Array> {
+    return new Promise((resolve, reject) => {
+      const fileReader = new FileReader()
+      fileReader.addEventListener('load', (event) => {
+        const arrayBuffer = event.target?.result as ArrayBuffer
+        resolve(new Uint8Array(arrayBuffer))
+      })
+      // eslint-disable-next-line unicorn/prefer-add-event-listener
+      fileReader.onerror = () => reject(fileReader.error)
+      // eslint-disable-next-line unicorn/prefer-blob-reading-methods
+      fileReader.readAsArrayBuffer(file)
+    })
+  }
+
+  private async witnessBrowserFile(): Promise<[FilePayload, Uint8Array]> {
+    const file = assertEx(this.params.file, 'File is missing from params')
+    const fileBinary = await this.readBinaryFile(file)
+    const result = new Uint8Array(fileBinary)
+    const hash = shajs('sha256').update(result).digest('hex').padStart(64, '0')
+
+    return [
+      {
+        hash,
+        length: fileBinary.byteLength,
+        meta: {
+          name: file.name,
+          type: file.type,
+        },
+        modified: file.lastModified,
+        schema: FileSchema,
+        uri: this.config.storage === 'data-uri' ? generateDataUri(fileBinary) : file.name,
+      },
+      fileBinary,
+    ]
+  }
+}

package/src/Config.ts

@@ -0,0 +1,9 @@
+import { WitnessConfig } from '@xyo-network/witness-model'
+
+export type FileWitnessConfigSchema = 'network.xyo.file.witness.config'
+export const FileWitnessConfigSchema: FileWitnessConfigSchema = 'network.xyo.file.witness.config'
+
+export type FileWitnessConfig = WitnessConfig<{
+  schema: FileWitnessConfigSchema
+  storage?: 'data-uri'
+}>

package/src/Params.ts

@@ -0,0 +1,3 @@
+export type BrowserFileWitnessAdditionalParams = {
+  file?: File
+}

package/src/Payload.ts

@@ -0,0 +1,19 @@
+import { Payload } from '@xyo-network/payload-model'
+
+import { FileSchema } from './Schema'
+
+export type BinaryDataHash = string
+
+/** @description File location and optional data */
+export type FilePayload = Payload<
+  {
+    created?: number
+    hash: BinaryDataHash
+    length: number
+    /** @field Storage specific meta data */
+    meta?: Record<string, string | number>
+    modified?: number
+    uri: string
+  },
+  FileSchema
+>

package/src/PluginBrowser.ts

@@ -0,0 +1,16 @@
+import { PayloadSetSchema } from '@xyo-network/payload-model'
+import { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
+
+import { BrowserFileWitness } from './BrowserFileWitness'
+import { FileSchema } from './Schema'
+
+export const BrowserFilePlugin = () =>
+  createPayloadSetWitnessPlugin<BrowserFileWitness>(
+    { required: { [FileSchema]: 1 }, schema: PayloadSetSchema },
+    {
+      witness: async (params) => {
+        const result = await BrowserFileWitness.create(params)
+        return result
+      },
+    },
+  )

package/src/Schema.ts

@@ -0,0 +1,2 @@
+export type FileSchema = 'network.xyo.file'
+export const FileSchema: FileSchema = 'network.xyo.file'

package/src/Witness.ts

@@ -0,0 +1,19 @@
+import { Promisable } from '@xylabs/promise'
+import { AbstractWitness } from '@xyo-network/abstract-witness'
+import { AnyConfigSchema } from '@xyo-network/module-model'
+import { Payload } from '@xyo-network/payload-model'
+import { WitnessModule, WitnessParams } from '@xyo-network/witness-model'
+
+import { FileWitnessConfig, FileWitnessConfigSchema } from './Config'
+import { FileSchema } from './Schema'
+
+export type FileWitnessParams = WitnessParams<AnyConfigSchema<FileWitnessConfig>>
+
+// Abstract so that derived classes provide a type for the file param and methods to parse it
+export abstract class FileWitness<TParams extends FileWitnessParams = FileWitnessParams> extends AbstractWitness<TParams> implements WitnessModule {
+  static override configSchemas = [FileWitnessConfigSchema]
+
+  protected override observeHandler(payloads?: Payload[]): Promisable<Payload[]> {
+    return [{ ...payloads?.[0], schema: FileSchema }]
+  }
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from './BrowserFileWitness'
+export * from './Config'
+export * from './Params'
+export { BrowserFilePlugin, BrowserFilePlugin as default } from './PluginBrowser'
+export * from './Schema'
+export * from './Witness'

package/src/util/GenerateDataUri.ts

@@ -0,0 +1,5 @@
+import { base64 } from '@scure/base'
+
+export const generateDataUri = (data: Uint8Array): string => {
+  return `data:application/octet-stream;base64,${base64.encode(data)}`
+}

package/src/util/index.ts

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

package/typedoc.json

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

package/xy.config.ts

@@ -0,0 +1,15 @@
+import { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    browser: {
+      src: true,
+    },
+    entryMode: 'single',
+    node: {
+      src: true,
+    },
+  },
+}
+
+// eslint-disable-next-line import/no-default-export
+export default config