@xyo-network/id-plugin 4.1.1 → 5.0.0

package/dist/neutral/index.d.ts

@@ -1,26 +1,3 @@
-import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
-import { Promisable } from '@xylabs/promise';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import { Id } from '@xyo-network/id-payload-plugin';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { Schema, Payload } from '@xyo-network/payload-model';
-import { WitnessParams, WitnessConfig } from '@xyo-network/witness-model';
-
-type IdWitnessConfigSchema = 'network.xyo.id.witness.config';
-declare const IdWitnessConfigSchema: IdWitnessConfigSchema;
-type IdWitnessConfig = WitnessConfig<{
-    salt?: string;
-    schema: IdWitnessConfigSchema;
-}>;
-type IdWitnessParams = WitnessParams<AnyConfigSchema<IdWitnessConfig>>;
-declare class IdWitness<TParams extends IdWitnessParams = IdWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    get salt(): string;
-    protected observeHandler(payloads?: Payload[]): Promisable<Id[]>;
-}
-
-declare const IdPlugin: () => _xyo_network_payloadset_plugin.PayloadSetWitnessPlugin<IdWitness<IdWitnessParams>>;
-
-export { IdPlugin, IdWitness, IdWitnessConfigSchema, IdPlugin as default };
-export type { IdWitnessConfig, IdWitnessParams };
+export { IdPlugin as default, IdPlugin } from './Plugin.ts';
+export * from './Witness.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/id-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,21 +28,24 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/promise": "^4.13.23",
-    "@xyo-network/abstract-witness": "^4.1.7",
-    "@xyo-network/id-payload-plugin": "^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/witness-model": "^4.1.7"
+    "@xylabs/promise": "^5.0.0",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/id-payload-plugin": "^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/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",
-    "@xyo-network/payload-wrapper": "^4.1.7",
-    "knip": "^5.62.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/payload-wrapper": "^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 { IdPlugin } from '../Plugin.ts'
+
+describe('IdPlugin', () => {
+  test('Add to Resolver', async () => {
+    const plugin = IdPlugin()
+    const resolver = await new PayloadSetPluginResolver().register(plugin)
+    expect(await resolver.resolve(plugin.set)).toBeObject()
+    expect(await resolver.witness(plugin.set)).toBeObject()
+  })
+})

package/src/spec/Witness.dom.spec.ts

@@ -0,0 +1,33 @@
+import '@xylabs/vitest-extended'
+
+import { IdSchema } from '@xyo-network/id-payload-plugin'
+import type { Payload } from '@xyo-network/payload-model'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import {
+  describe, expect,
+  test,
+} from 'vitest'
+
+import { IdWitness, IdWitnessConfigSchema } from '../Witness.ts'
+
+describe('IdWitness [Browser]', () => {
+  test('observe', async () => {
+    const witness = await IdWitness.create({
+      account: 'random',
+      config: { salt: 'test', schema: IdWitnessConfigSchema },
+    })
+    const [observation] = await witness.observe([{ salt: 'test', schema: IdSchema } as Payload])
+    expect(observation.schema).toBe(IdSchema)
+    expect(await PayloadWrapper.wrap(observation).getValid()).toBe(true)
+  })
+
+  test('observe [no salt]', async () => {
+    const witness = await IdWitness.create({
+      account: 'random',
+      config: { schema: IdWitnessConfigSchema },
+    })
+    const [observation] = await witness.observe([{ salt: 'test', schema: IdSchema } as Payload])
+    expect(observation.schema).toBe(IdSchema)
+    expect(await PayloadWrapper.wrap(observation).getValid()).toBe(true)
+  })
+})

package/src/spec/Witness.spec.ts

@@ -0,0 +1,86 @@
+import '@xylabs/vitest-extended'
+
+import type { Id } from '@xyo-network/id-payload-plugin'
+import { IdSchema } from '@xyo-network/id-payload-plugin'
+import type { Payload } from '@xyo-network/payload-model'
+import { PayloadWrapper } from '@xyo-network/payload-wrapper'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { IdWitness, IdWitnessConfigSchema } from '../Witness.ts'
+
+describe('IdWitness', () => {
+  describe('observe', () => {
+    const payloadSalt = 'payload salt'
+    describe('with config', () => {
+      const configSalt = 'config salt'
+      const config = {
+        salt: configSalt,
+        schema: IdWitnessConfigSchema,
+        targetSchema: IdSchema,
+      }
+      describe('with payloads supplied to observe', () => {
+        it('without salt uses config salt', async () => {
+          const witness = await IdWitness.create({ account: 'random', config })
+          const observations = (await witness.observe()) as Id[]
+          await validateObservationShape(observations)
+          const [observation] = observations
+          expect(observation.salt).toBe(witness.config.salt)
+        })
+        it('with salt uses payload salt', async () => {
+          const witness = await IdWitness.create({ account: 'random', config })
+          const observations = (await witness.observe([{ salt: payloadSalt, schema: IdSchema }] as Id[])) as Id[]
+          await validateObservationShape(observations)
+          const [observation] = observations
+          expect(observation.salt).toBe(payloadSalt)
+        })
+      })
+      describe('with no payloads supplied to observe', () => {
+        it('uses config salt', async () => {
+          const witness = await IdWitness.create({ account: 'random', config })
+          const observations = (await witness.observe()) as Id[]
+          await validateObservationShape(observations)
+          const [observation] = observations
+          expect(observation.salt).toBe(witness.config.salt)
+        })
+      })
+    })
+    describe('with no config', () => {
+      describe('with payloads supplied to observe', () => {
+        it('without salt uses random numeric string', async () => {
+          const witness = await IdWitness.create({ account: 'random' })
+          const observations = (await witness.observe()) as Id[]
+          await validateObservationShape(observations)
+          const [observation] = observations
+          expect(Number.parseInt(observation.salt)).toBeInteger()
+        })
+        it('with salt uses payload salt', async () => {
+          const witness = await IdWitness.create({ account: 'random' })
+          const observations = (await witness.observe([{ salt: payloadSalt, schema: IdSchema } as Payload])) as Id[]
+          await validateObservationShape(observations)
+          const [observation] = observations
+          expect(observation.salt).toBe(payloadSalt)
+        })
+      })
+      describe('with no payloads supplied to observe', () => {
+        it('uses random numeric string', async () => {
+          const witness = await IdWitness.create({ account: 'random' })
+          const observations = (await witness.observe()) as Id[]
+          await validateObservationShape(observations)
+          const [observation] = observations
+          expect(Number.parseInt(observation.salt)).toBeInteger()
+        })
+      })
+    })
+  })
+})
+
+const validateObservationShape = async (observations: Id[]) => {
+  expect(observations).toBeArrayOfSize(1)
+  const [observation] = observations
+  expect(observation.salt).toBeString()
+  expect(observation.schema).toBe(IdSchema)
+  expect(await PayloadWrapper.wrap(observation).getValid()).toBe(true)
+}

package/typedoc.json

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

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    node: {},
-    neutral: { src: true },
-  },
-}
-
-export default config