@xyo-network/file-browser-plugin 5.2.3 → 5.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/Config.d.ts +4 -2
- package/dist/browser/Config.d.ts.map +1 -1
- package/dist/browser/Schema.d.ts +4 -2
- package/dist/browser/Schema.d.ts.map +1 -1
- package/dist/browser/index.mjs +4 -2
- package/dist/browser/index.mjs.map +1 -1
- package/package.json +14 -14
- package/src/Config.ts +3 -2
- package/src/Schema.ts +4 -2
package/dist/browser/Config.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type { WitnessConfig } from '@xyo-network/witness-model';
|
|
2
|
-
export type FileWitnessConfigSchema =
|
|
3
|
-
export declare const FileWitnessConfigSchema:
|
|
2
|
+
export type FileWitnessConfigSchema = typeof FileWitnessConfigSchema;
|
|
3
|
+
export declare const FileWitnessConfigSchema: "network.xyo.file.witness.config" & {
|
|
4
|
+
readonly __schema: true;
|
|
5
|
+
};
|
|
4
6
|
export type FileWitnessConfig = WitnessConfig<{
|
|
5
7
|
schema: FileWitnessConfigSchema;
|
|
6
8
|
storage?: 'data-uri';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAA;AACpE,eAAO,MAAM,uBAAuB;;CAAoD,CAAA;AAExF,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC;IAC5C,MAAM,EAAE,uBAAuB,CAAA;IAC/B,OAAO,CAAC,EAAE,UAAU,CAAA;CACrB,CAAC,CAAA"}
|
package/dist/browser/Schema.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAA;AAC1C,eAAO,MAAM,UAAU;;CAAqC,CAAA"}
|
package/dist/browser/index.mjs
CHANGED
|
@@ -3,10 +3,12 @@ import { assertEx } from "@xylabs/assert";
|
|
|
3
3
|
import { PayloadBuilder } from "@xyo-network/payload-builder";
|
|
4
4
|
|
|
5
5
|
// src/Config.ts
|
|
6
|
-
|
|
6
|
+
import { asSchema } from "@xyo-network/payload-model";
|
|
7
|
+
var FileWitnessConfigSchema = asSchema("network.xyo.file.witness.config", true);
|
|
7
8
|
|
|
8
9
|
// src/Schema.ts
|
|
9
|
-
|
|
10
|
+
import { asSchema as asSchema2 } from "@xyo-network/payload-model";
|
|
11
|
+
var FileSchema = asSchema2("network.xyo.file", true);
|
|
10
12
|
|
|
11
13
|
// src/util/GenerateDataUri.ts
|
|
12
14
|
import { base64 } from "@scure/base";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/BrowserFileWitness.ts","../../src/Config.ts","../../src/Schema.ts","../../src/util/GenerateDataUri.ts","../../src/Witness.ts","../../src/Payload.ts","../../src/PluginBrowser.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Schema } from '@xyo-network/payload-model'\n\nimport { FileWitnessConfigSchema } from './Config.ts'\nimport type { BrowserFileWitnessAdditionalParams } from './Params.ts'\nimport type { FilePayload } from './Payload.ts'\nimport { FileSchema } from './Schema.ts'\nimport { generateDataUri } from './util/index.ts'\nimport type { FileWitnessParams } from './Witness.ts'\nimport { FileWitness } from './Witness.ts'\n\ntype BrowserFileWitnessParams = FileWitnessParams & BrowserFileWitnessAdditionalParams\n\nexport class BrowserFileWitness extends FileWitness<BrowserFileWitnessParams> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, FileWitnessConfigSchema]\n static override readonly defaultConfigSchema: Schema = FileWitnessConfigSchema\n\n protected override async observeHandler() {\n try {\n const [payload] = await this.witnessBrowserFile()\n const { logger } = this.params\n logger?.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 hashBuffer = await globalThis.crypto.subtle.digest('SHA-256', result)\n\n // Convert ArrayBuffer to hex string\n const hashArray = [...new Uint8Array(hashBuffer)]\n const hash = hashArray.map(b => b.toString(16).padStart(2, '0')).join('')\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 type { WitnessConfig } from '@xyo-network/witness-model'\n\nexport type FileWitnessConfigSchema =
|
|
1
|
+
{"version":3,"sources":["../../src/BrowserFileWitness.ts","../../src/Config.ts","../../src/Schema.ts","../../src/util/GenerateDataUri.ts","../../src/Witness.ts","../../src/Payload.ts","../../src/PluginBrowser.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Schema } from '@xyo-network/payload-model'\n\nimport { FileWitnessConfigSchema } from './Config.ts'\nimport type { BrowserFileWitnessAdditionalParams } from './Params.ts'\nimport type { FilePayload } from './Payload.ts'\nimport { FileSchema } from './Schema.ts'\nimport { generateDataUri } from './util/index.ts'\nimport type { FileWitnessParams } from './Witness.ts'\nimport { FileWitness } from './Witness.ts'\n\ntype BrowserFileWitnessParams = FileWitnessParams & BrowserFileWitnessAdditionalParams\n\nexport class BrowserFileWitness extends FileWitness<BrowserFileWitnessParams> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, FileWitnessConfigSchema]\n static override readonly defaultConfigSchema: Schema = FileWitnessConfigSchema\n\n protected override async observeHandler() {\n try {\n const [payload] = await this.witnessBrowserFile()\n const { logger } = this.params\n logger?.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 hashBuffer = await globalThis.crypto.subtle.digest('SHA-256', result)\n\n // Convert ArrayBuffer to hex string\n const hashArray = [...new Uint8Array(hashBuffer)]\n const hash = hashArray.map(b => b.toString(16).padStart(2, '0')).join('')\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 { asSchema } from '@xyo-network/payload-model'\nimport type { WitnessConfig } from '@xyo-network/witness-model'\n\nexport type FileWitnessConfigSchema = typeof FileWitnessConfigSchema\nexport const FileWitnessConfigSchema = asSchema('network.xyo.file.witness.config', true)\n\nexport type FileWitnessConfig = WitnessConfig<{\n schema: FileWitnessConfigSchema\n storage?: 'data-uri'\n}>\n","import { asSchema } from '@xyo-network/payload-model'\n\nexport type FileSchema = typeof FileSchema\nexport const FileSchema = asSchema('network.xyo.file', true)\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 type { Promisable } from '@xylabs/promise'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport type { Payload, Schema } from '@xyo-network/payload-model'\nimport type { WitnessModule, WitnessParams } from '@xyo-network/witness-model'\n\nimport type { FileWitnessConfig } from './Config.ts'\nimport { FileWitnessConfigSchema } from './Config.ts'\nimport { FileSchema } from './Schema.ts'\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 readonly configSchemas: Schema[] = [...super.configSchemas, FileWitnessConfigSchema]\n static override readonly defaultConfigSchema: Schema = FileWitnessConfigSchema\n\n protected override observeHandler(payloads?: Payload[]): Promisable<Payload[]> {\n return [{ ...payloads?.[0], schema: FileSchema }]\n }\n}\n","import type { Payload } from '@xyo-network/payload-model'\nimport { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { FileSchema } from './Schema.ts'\n\nexport type BinaryDataHash = string\n\n/** @description File location and optional data */\nexport type FilePayload = Payload<\n {\n created?: number\n hash: BinaryDataHash\n length: number\n /** @field Storage specific meta data */\n meta?: Record<string, string | number>\n modified?: number\n uri: string\n },\n FileSchema\n>\n\nexport const isFilePayload = isPayloadOfSchemaType<FilePayload>(FileSchema)\n","import { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'\n\nimport { BrowserFileWitness } from './BrowserFileWitness.ts'\nimport { FileSchema } from './Schema.ts'\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;;;ACD/B,SAAS,gBAAgB;AAIlB,IAAM,0BAA0B,SAAS,mCAAmC,IAAI;;;ACJvF,SAAS,YAAAA,iBAAgB;AAGlB,IAAM,aAAaA,UAAS,oBAAoB,IAAI;;;ACH3D,SAAS,cAAc;AAEhB,IAAM,kBAAkB,CAAC,SAA6B;AAC3D,SAAO,wCAAwC,OAAO,OAAO,IAAI,CAAC;AACpE;;;ACHA,SAAS,uBAAuB;AAYzB,IAAe,cAAf,cAA0F,gBAAkD;AAAA,EACjJ,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,uBAAuB;AAAA,EACnG,OAAyB,sBAA8B;AAAA,EAEpC,eAAe,UAA6C;AAC7E,WAAO,CAAC,EAAE,GAAG,WAAW,CAAC,GAAG,QAAQ,WAAW,CAAC;AAAA,EAClD;AACF;;;AJNO,IAAM,qBAAN,cAAiC,YAAsC;AAAA,EAC5E,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,uBAAuB;AAAA,EACnG,OAAyB,sBAA8B;AAAA,EAEvD,MAAyB,iBAAiB;AACxC,QAAI;AACF,YAAM,CAAC,OAAO,IAAI,MAAM,KAAK,mBAAmB;AAChD,YAAM,EAAE,OAAO,IAAI,KAAK;AACxB,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;AAC7C,cAAM,cAAc,MAAM,QAAQ;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,MAAM,6BAA6B;AAC3E,UAAM,aAAa,MAAM,KAAK,eAAe,IAAI;AACjD,UAAM,SAAS,IAAI,WAAW,UAAU;AACxC,UAAM,aAAa,MAAM,WAAW,OAAO,OAAO,OAAO,WAAW,MAAM;AAG1E,UAAM,YAAY,CAAC,GAAG,IAAI,WAAW,UAAU,CAAC;AAChD,UAAM,OAAO,UAAU,IAAI,OAAK,EAAE,SAAS,EAAE,EAAE,SAAS,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE;AAExE,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;;;AKnEA,SAAS,6BAA6B;AAoB/B,IAAM,gBAAgB,sBAAmC,UAAU;;;ACrB1E,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":["asSchema"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/file-browser-plugin",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.3.1",
|
|
4
4
|
"description": "Typescript/Javascript Plugins for XYO Platform",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -37,24 +37,24 @@
|
|
|
37
37
|
],
|
|
38
38
|
"dependencies": {
|
|
39
39
|
"@scure/base": "~2.0.0",
|
|
40
|
-
"@xylabs/assert": "~5.0.
|
|
41
|
-
"@xylabs/promise": "~5.0.
|
|
42
|
-
"@xyo-network/abstract-witness": "~5.2
|
|
43
|
-
"@xyo-network/module-model": "~5.2
|
|
44
|
-
"@xyo-network/payload-builder": "~5.2
|
|
45
|
-
"@xyo-network/payload-model": "~5.2
|
|
46
|
-
"@xyo-network/payloadset-plugin": "~5.2
|
|
47
|
-
"@xyo-network/witness-model": "~5.2
|
|
40
|
+
"@xylabs/assert": "~5.0.64",
|
|
41
|
+
"@xylabs/promise": "~5.0.64",
|
|
42
|
+
"@xyo-network/abstract-witness": "~5.3.2",
|
|
43
|
+
"@xyo-network/module-model": "~5.3.2",
|
|
44
|
+
"@xyo-network/payload-builder": "~5.3.2",
|
|
45
|
+
"@xyo-network/payload-model": "~5.3.2",
|
|
46
|
+
"@xyo-network/payloadset-plugin": "~5.3.2",
|
|
47
|
+
"@xyo-network/witness-model": "~5.3.2"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@types/sha.js": "~2.4.4",
|
|
51
|
-
"@xylabs/ts-scripts-yarn3": "~7.2
|
|
52
|
-
"@xylabs/tsconfig": "~7.2
|
|
53
|
-
"@xylabs/vitest-extended": "~5.0.
|
|
51
|
+
"@xylabs/ts-scripts-yarn3": "~7.3.2",
|
|
52
|
+
"@xylabs/tsconfig": "~7.3.2",
|
|
53
|
+
"@xylabs/vitest-extended": "~5.0.64",
|
|
54
54
|
"typescript": "~5.9.3",
|
|
55
|
-
"vitest": "~4.0.
|
|
55
|
+
"vitest": "~4.0.18"
|
|
56
56
|
},
|
|
57
57
|
"publishConfig": {
|
|
58
58
|
"access": "public"
|
|
59
59
|
}
|
|
60
|
-
}
|
|
60
|
+
}
|
package/src/Config.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
+
import { asSchema } from '@xyo-network/payload-model'
|
|
1
2
|
import type { WitnessConfig } from '@xyo-network/witness-model'
|
|
2
3
|
|
|
3
|
-
export type FileWitnessConfigSchema =
|
|
4
|
-
export const FileWitnessConfigSchema
|
|
4
|
+
export type FileWitnessConfigSchema = typeof FileWitnessConfigSchema
|
|
5
|
+
export const FileWitnessConfigSchema = asSchema('network.xyo.file.witness.config', true)
|
|
5
6
|
|
|
6
7
|
export type FileWitnessConfig = WitnessConfig<{
|
|
7
8
|
schema: FileWitnessConfigSchema
|
package/src/Schema.ts
CHANGED