@xyo-network/file-browser-plugin 6.0.2 → 6.1.0
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/README.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
[![logo][]](https://xyo.network)
|
|
2
|
+
|
|
1
3
|
# @xyo-network/file-browser-plugin
|
|
2
4
|
|
|
3
5
|
[![npm][npm-badge]][npm-link]
|
|
@@ -36,9 +38,12 @@ bun add {{name}}
|
|
|
36
38
|
|
|
37
39
|
See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
|
|
38
40
|
|
|
41
|
+
## Credits
|
|
39
42
|
|
|
43
|
+
[Made with 🔥 and ❄️ by XYO Foundation](https://xyo.network)
|
|
40
44
|
|
|
41
45
|
[npm-badge]: https://img.shields.io/npm/v/@xyo-network/file-browser-plugin.svg
|
|
42
46
|
[npm-link]: https://www.npmjs.com/package/@xyo-network/file-browser-plugin
|
|
43
47
|
[license-badge]: https://img.shields.io/npm/l/@xyo-network/file-browser-plugin.svg
|
|
44
48
|
[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
|
|
49
|
+
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BrowserFileWitness.d.ts","sourceRoot":"","sources":["../../src/BrowserFileWitness.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAIjD,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,aAAa,CAAA;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAG/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C,KAAK,wBAAwB,GAAG,iBAAiB,GAAG,kCAAkC,CAAA;AAEtF,qBAAa,kBAAmB,SAAQ,WAAW,CAAC,wBAAwB,CAAC;IAC3E,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAoD;IACpG,gBAAyB,mBAAmB,EAAE,MAAM,CAA0B;cAErD,cAAc;
|
|
1
|
+
{"version":3,"file":"BrowserFileWitness.d.ts","sourceRoot":"","sources":["../../src/BrowserFileWitness.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAIjD,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,aAAa,CAAA;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAG/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C,KAAK,wBAAwB,GAAG,iBAAiB,GAAG,kCAAkC,CAAA;AAEtF,qBAAa,kBAAmB,SAAQ,WAAW,CAAC,wBAAwB,CAAC;IAC3E,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAoD;IACpG,gBAAyB,mBAAmB,EAAE,MAAM,CAA0B;cAErD,cAAc;YAWzB,cAAc;YAKd,kBAAkB;CAyBjC"}
|
package/dist/browser/index.mjs
CHANGED
|
@@ -40,16 +40,9 @@ var BrowserFileWitness = class extends FileWitness {
|
|
|
40
40
|
throw new Error(`Error reading file: ${e}`, { cause: e });
|
|
41
41
|
}
|
|
42
42
|
}
|
|
43
|
-
readBinaryFile(file) {
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
fileReader.addEventListener("load", (event) => {
|
|
47
|
-
const arrayBuffer = event.target?.result;
|
|
48
|
-
resolve(new Uint8Array(arrayBuffer));
|
|
49
|
-
});
|
|
50
|
-
fileReader.onerror = () => reject(new Error("FileReader failed", { cause: fileReader.error ?? void 0 }));
|
|
51
|
-
fileReader.readAsArrayBuffer(file);
|
|
52
|
-
});
|
|
43
|
+
async readBinaryFile(file) {
|
|
44
|
+
const arrayBuffer = await file.arrayBuffer();
|
|
45
|
+
return new Uint8Array(arrayBuffer);
|
|
53
46
|
}
|
|
54
47
|
async witnessBrowserFile() {
|
|
55
48
|
const file = assertEx(this.params.file, () => "File is missing from params");
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/BrowserFileWitness.ts", "../../src/Config.ts", "../../src/Schema.ts", "../../src/util/GenerateDataUri.ts", "../../src/Witness.ts", "../../src/Payload.ts", "../../src/PluginBrowser.ts"],
|
|
4
|
-
"sourcesContent": ["import { assertEx } from '@xylabs/sdk-js'\nimport type { Schema } from '@xyo-network/sdk-js'\nimport { PayloadBuilder } from '@xyo-network/sdk-js'\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}`, { cause: e })\n }\n }\n\n private readBinaryFile(file: File): Promise<Uint8Array> {\n
|
|
5
|
-
"mappings": ";AAAA,SAAS,gBAAgB;AAEzB,SAAS,sBAAsB;;;ACD/B,SAAS,gBAAgB;AAGlB,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;;;ACAA,SAAS,uBAAuB;AASzB,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,IAAI,EAAE,OAAO,EAAE,CAAC;AAAA,IAC1D;AAAA,EACF;AAAA,
|
|
4
|
+
"sourcesContent": ["import { assertEx } from '@xylabs/sdk-js'\nimport type { Schema } from '@xyo-network/sdk-js'\nimport { PayloadBuilder } from '@xyo-network/sdk-js'\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}`, { cause: e })\n }\n }\n\n private async readBinaryFile(file: File): Promise<Uint8Array> {\n const arrayBuffer = await file.arrayBuffer()\n return new Uint8Array(arrayBuffer)\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/sdk-js'\nimport { asSchema } from '@xyo-network/sdk-js'\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/sdk-js'\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/sdk-js'\nimport type {\n AnyConfigSchema, Payload, Schema, WitnessModule, WitnessParams,\n} from '@xyo-network/sdk-js'\nimport { AbstractWitness } from '@xyo-network/sdk-js'\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/sdk-js'\nimport { isPayloadOfSchemaType } from '@xyo-network/sdk-js'\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 { createPayloadSetWitnessPlugin, PayloadSetSchema } from '@xyo-network/sdk-js'\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"],
|
|
5
|
+
"mappings": ";AAAA,SAAS,gBAAgB;AAEzB,SAAS,sBAAsB;;;ACD/B,SAAS,gBAAgB;AAGlB,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;;;ACAA,SAAS,uBAAuB;AASzB,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,IAAI,EAAE,OAAO,EAAE,CAAC;AAAA,IAC1D;AAAA,EACF;AAAA,EAEA,MAAc,eAAe,MAAiC;AAC5D,UAAM,cAAc,MAAM,KAAK,YAAY;AAC3C,WAAO,IAAI,WAAW,WAAW;AAAA,EACnC;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;;;AK1DA,SAAS,6BAA6B;AAoB/B,IAAM,gBAAgB,sBAAmC,UAAU;;;ACrB1E,SAAS,+BAA+B,wBAAwB;AAKzD,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;",
|
|
6
6
|
"names": ["asSchema"]
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/file-browser-plugin",
|
|
3
|
-
"version": "6.0
|
|
3
|
+
"version": "6.1.0",
|
|
4
4
|
"description": "Typescript/Javascript Plugins for XYO Platform",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -38,18 +38,16 @@
|
|
|
38
38
|
"@opentelemetry/sdk-trace-base": "^2.7.1",
|
|
39
39
|
"@scure/base": "^2.2.0",
|
|
40
40
|
"@scure/bip39": "~2.2.0",
|
|
41
|
-
"@xylabs/geo": "^6.0
|
|
42
|
-
"@xylabs/sdk-js": "^6.0
|
|
43
|
-
"@xylabs/threads": "^6.0
|
|
44
|
-
"@xylabs/toolchain": "~8.1.
|
|
45
|
-
"@xylabs/tsconfig": "~8.1.
|
|
46
|
-
"@xylabs/vitest-extended": "
|
|
47
|
-
"@xyo-network/sdk-js": "^6.0
|
|
48
|
-
"@xyo-network/sdk-protocol-js": "~6.
|
|
41
|
+
"@xylabs/geo": "^6.1.0",
|
|
42
|
+
"@xylabs/sdk-js": "^6.1.0",
|
|
43
|
+
"@xylabs/threads": "^6.1.0",
|
|
44
|
+
"@xylabs/toolchain": "~8.1.20",
|
|
45
|
+
"@xylabs/tsconfig": "~8.1.20",
|
|
46
|
+
"@xylabs/vitest-extended": "^6.1.0",
|
|
47
|
+
"@xyo-network/sdk-js": "^6.1.0",
|
|
48
|
+
"@xyo-network/sdk-protocol-js": "~6.1",
|
|
49
49
|
"ajv": "^8.20.0",
|
|
50
50
|
"async-mutex": "^0.5.0",
|
|
51
|
-
"bn.js": "^5.2.3",
|
|
52
|
-
"buffer": "^6.0.3",
|
|
53
51
|
"debug": "~4.4.3",
|
|
54
52
|
"eslint": "^10.4.1",
|
|
55
53
|
"ethers": "^6.16.0",
|
|
@@ -57,7 +55,6 @@
|
|
|
57
55
|
"idb": "^8.0.3",
|
|
58
56
|
"lru-cache": "^11.5.1",
|
|
59
57
|
"observable-fns": "~0.6.1",
|
|
60
|
-
"pako": "~2.1.0",
|
|
61
58
|
"typescript": "~6.0.3",
|
|
62
59
|
"vite": "^8.0.16",
|
|
63
60
|
"vitest": "^4.1.8",
|
|
@@ -76,21 +73,21 @@
|
|
|
76
73
|
"@xylabs/sdk-js": "^6.0",
|
|
77
74
|
"@xylabs/threads": "^6.0",
|
|
78
75
|
"@xyo-network/sdk-js": "^6.0",
|
|
79
|
-
"@xyo-network/sdk-protocol-js": "
|
|
76
|
+
"@xyo-network/sdk-protocol-js": "^6.1",
|
|
80
77
|
"ajv": "^8.20",
|
|
81
78
|
"async-mutex": "^0.5",
|
|
82
|
-
"bn.js": "^5.2",
|
|
83
|
-
"buffer": "^6.0",
|
|
84
79
|
"debug": "~4.4",
|
|
85
80
|
"ethers": "^6.16",
|
|
86
81
|
"hash-wasm": "^4.12",
|
|
87
82
|
"idb": "^8.0",
|
|
88
83
|
"lru-cache": "^11.3",
|
|
89
84
|
"observable-fns": "~0.6",
|
|
90
|
-
"pako": "~2.1",
|
|
91
85
|
"webextension-polyfill": "^0.12",
|
|
92
86
|
"zod": "^4.4"
|
|
93
87
|
},
|
|
88
|
+
"engines": {
|
|
89
|
+
"node": "^24"
|
|
90
|
+
},
|
|
94
91
|
"publishConfig": {
|
|
95
92
|
"access": "public"
|
|
96
93
|
}
|