@xyo-network/url-plugin 4.1.1 → 5.0.0

package/dist/browser/indexBrowser.d.ts

@@ -1,27 +1,3 @@
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-declare const UrlWitnessConfigSchema: "network.xyo.url.witness.config";
-type UrlWitnessConfigSchema = typeof UrlWitnessConfigSchema;
-type UrlWitnessConfig = WitnessConfig<{
-    schema: UrlWitnessConfigSchema;
-    urls?: string[];
-}>;
-
-type UrlWitnessParams = WitnessParams<AnyConfigSchema<UrlWitnessConfig>>;
-
-declare class UrlWitness<TParams extends UrlWitnessParams = UrlWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    static hashUrl: ((url: string) => Promise<string>) | undefined;
-    get urls(): string[] | undefined;
-    protected observeHandler(payloads?: Payload[]): Promise<Payload[]>;
-}
-
-declare const UrlPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<UrlWitness<UrlWitnessParams>>;
-
-export { UrlPlugin, UrlWitness, UrlWitnessConfigSchema, UrlPlugin as default };
-export type { UrlWitnessConfig, UrlWitnessParams };
+export { UrlPlugin as default, UrlPlugin } from './PluginNode.ts';
+export * from './Witness/index.ts';
+//# sourceMappingURL=indexBrowser.d.ts.map

package/dist/neutral/indexNode.d.ts

@@ -1,27 +1,3 @@
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-declare const UrlWitnessConfigSchema: "network.xyo.url.witness.config";
-type UrlWitnessConfigSchema = typeof UrlWitnessConfigSchema;
-type UrlWitnessConfig = WitnessConfig<{
-    schema: UrlWitnessConfigSchema;
-    urls?: string[];
-}>;
-
-type UrlWitnessParams = WitnessParams<AnyConfigSchema<UrlWitnessConfig>>;
-
-declare class UrlWitness<TParams extends UrlWitnessParams = UrlWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    static hashUrl: ((url: string) => Promise<string>) | undefined;
-    get urls(): string[] | undefined;
-    protected observeHandler(payloads?: Payload[]): Promise<Payload[]>;
-}
-
-declare const UrlPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<UrlWitness<UrlWitnessParams>>;
-
-export { UrlPlugin, UrlWitness, UrlWitnessConfigSchema, UrlPlugin as default };
-export type { UrlWitnessConfig, UrlWitnessParams };
+export { UrlPlugin as default, UrlPlugin } from './PluginNode.ts';
+export * from './Witness/index.ts';
+//# sourceMappingURL=indexNode.d.ts.map

package/dist/node/indexNode.d.ts

@@ -1,27 +1,3 @@
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { Schema, Payload } from '@xyo-network/payload-model';
-
-declare const UrlWitnessConfigSchema: "network.xyo.url.witness.config";
-type UrlWitnessConfigSchema = typeof UrlWitnessConfigSchema;
-type UrlWitnessConfig = WitnessConfig<{
-    schema: UrlWitnessConfigSchema;
-    urls?: string[];
-}>;
-
-type UrlWitnessParams = WitnessParams<AnyConfigSchema<UrlWitnessConfig>>;
-
-declare class UrlWitness<TParams extends UrlWitnessParams = UrlWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    static hashUrl: ((url: string) => Promise<string>) | undefined;
-    get urls(): string[] | undefined;
-    protected observeHandler(payloads?: Payload[]): Promise<Payload[]>;
-}
-
-declare const UrlPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<UrlWitness<UrlWitnessParams>>;
-
-export { UrlPlugin, UrlWitness, UrlWitnessConfigSchema, UrlPlugin as default };
-export type { UrlWitnessConfig, UrlWitnessParams };
+export { UrlPlugin as default, UrlPlugin } from './PluginNode.ts';
+export * from './Witness/index.ts';
+//# sourceMappingURL=indexNode.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/url-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -36,21 +36,24 @@
   },
   "module": "dist/neutral/indexNode.mjs",
   "types": "dist/neutral/indexNode.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.13.23",
-    "@xylabs/crypto": "^4.13.23",
-    "@xyo-network/abstract-witness": "^4.1.7",
-    "@xyo-network/module-model": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7",
-    "@xyo-network/payloadset-plugin": "^4.1.7",
-    "@xyo-network/url-payload-plugin": "^4.1.1",
-    "@xyo-network/witness-model": "^4.1.7"
+    "@xylabs/assert": "^5.0.0",
+    "@xylabs/crypto": "^5.0.0",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payloadset-plugin": "^5.0.0",
+    "@xyo-network/url-payload-plugin": "^5.0.0",
+    "@xyo-network/witness-model": "^5.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.23",
-    "knip": "^5.62.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/spec/Plugin.spec.ts

@@ -0,0 +1,18 @@
+import '@xylabs/vitest-extended'
+
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { UrlPlugin } from '../PluginNode.ts'
+
+describe('UrlPlugin', () => {
+  test('Add to Resolver', async () => {
+    const plugin = UrlPlugin()
+    const resolver = await new PayloadSetPluginResolver().register(plugin)
+    expect(await resolver.resolve(plugin.set)).toBeObject()
+    expect(await resolver.witness(plugin.set)).toBeObject()
+  })
+})

package/src/util/spec/hashFile.spec.ts

@@ -0,0 +1,35 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { hashFile } from '../hashFile.ts'
+
+describe('hashFile', () => {
+  describe('with existing file', () => {
+    const expected = '5359b8ebfd4e9251c27a40cc12e64a4cc182e8cfacafc53d2e0c591651d4cc42'
+    it('hashes file by path', async () => {
+      const file = `${__dirname}/test.txt`
+      const actual = await hashFile(file)
+      expect(actual).toEqual(expected)
+    })
+    it('hashes file by file URI', async () => {
+      const file = `file://${__dirname}/test.txt`
+      const actual = await hashFile(file)
+      expect(actual).toEqual(expected)
+    })
+  })
+  describe('with non-existent file', () => {
+    it('throws', async () => {
+      try {
+        await hashFile('missing.txt')
+      } catch {
+        expect(true).toBeTruthy()
+        return
+      }
+      expect(false).toBeTruthy()
+    })
+  })
+})

package/src/util/spec/hashHttpUrl.spec.ts

@@ -0,0 +1,38 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { hashHttpUrl } from '../hashHttpUrl.ts'
+
+describe('hashHttpUrl', () => {
+  describe('with existing URL', () => {
+    it('hashes http URLs', async () => {
+      // TODO: Replace with a more static http URL
+      const expected = '6da5620880159634213e197fafca1dde0272153be3e4590818533fab8d040770'
+
+      const url = 'http://www.google.com/favicon.ico'
+      const actual = await hashHttpUrl(url)
+      expect(actual).toEqual(expected)
+    })
+    it('hashes https URLs', async () => {
+      const expected = '5b6fb901d981dd1da84844069c3eb5aaf725a4f23e40613751eecd5ca0bc4060'
+      const url = 'https://xyo.network/favicon.ico'
+      const actual = await hashHttpUrl(url)
+      expect(actual).toEqual(expected)
+    })
+  })
+  describe('with non-existent URL', () => {
+    it('throws', async () => {
+      try {
+        await hashHttpUrl('https://foo.bar.baz.quix/missing.txt')
+      } catch {
+        expect(true).toBeTruthy()
+        return
+      }
+      expect(false).toBeTruthy()
+    })
+  })
+})

package/src/util/spec/hashUrl.spec.ts

@@ -0,0 +1,25 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { hashUrl } from '../hashUrl.ts'
+
+describe('hashUrl', () => {
+  describe('with https URL', () => {
+    it('hashes resource', async () => {
+      const url = 'https://xyo.network/favicon.ico'
+      const actual = await hashUrl(url)
+      expect(actual).toBeTruthy()
+    })
+  })
+  describe('with file URL', () => {
+    it('hashes resource', async () => {
+      const url = `file://${__dirname}/test.txt`
+      const actual = await hashUrl(url)
+      expect(actual).toBeTruthy()
+    })
+  })
+})

package/typedoc.json

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

package/xy.config.ts

@@ -1,11 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    entryMode: 'custom',
-    browser: { src: { entry: ['indexBrowser.ts'] } },
-    neutral: { src: { entry: ['indexNode.ts'] } },
-    node: { src: { entry: ['indexNode.ts'] } },
-  },
-}
-
-export default config