@xyo-network/id-plugin 2.42.0

package/dist/esm/Plugin.d.ts

@@ -0,0 +1,16 @@
+import { XyoModuleParams } from '@xyo-network/module';
+import { PayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin';
+export declare const IdPlugin: () => PayloadSetWitnessPlugin<XyoModuleParams<import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+    security?: {
+        allowed?: Record<string, string[][]> | undefined;
+        disallowed?: Record<string, string[]> | undefined;
+    } | undefined;
+} & {
+    salt: string;
+    schema: "network.xyo.id.witness.config";
+} & {
+    targetSet?: (import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & import("@xyo-network/payload").PayloadSet & {
+        schema: "network.xyo.payload.set";
+    }) | undefined;
+}>>;
+//# sourceMappingURL=Plugin.d.ts.map

package/dist/esm/Plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAErD,OAAO,EAA0B,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAIhG,eAAO,MAAM,QAAQ;;;;;;;;;;;;GASlB,CAAA"}

package/dist/esm/Plugin.js

@@ -0,0 +1,11 @@
+import { IdSchema } from '@xyo-network/id-payload-plugin';
+import { PayloadSetSchema } from '@xyo-network/payload';
+import { createPayloadSetPlugin } from '@xyo-network/payloadset-plugin';
+import { IdWitness } from './Witness';
+export const IdPlugin = () => createPayloadSetPlugin({ required: { [IdSchema]: 1 }, schema: PayloadSetSchema }, {
+    witness: async (params) => {
+        const result = await IdWitness.create(params);
+        return result;
+    },
+});
+//# sourceMappingURL=Plugin.js.map

package/dist/esm/Plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAA;AAEzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAA2B,MAAM,gCAAgC,CAAA;AAEhG,OAAO,EAAE,SAAS,EAAmB,MAAM,WAAW,CAAA;AAEtD,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,EAAE,CAC3B,sBAAsB,CACpB,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAE,EACzD;IACE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACxB,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC7C,OAAO,MAAM,CAAA;IACf,CAAC;CACF,CACF,CAAA"}

package/dist/esm/Witness.d.ts

@@ -0,0 +1,17 @@
+import { IdPayload } from '@xyo-network/id-payload-plugin';
+import { XyoModuleParams } from '@xyo-network/module';
+import { XyoPayload } from '@xyo-network/payload';
+import { AbstractWitness, XyoWitnessConfig } from '@xyo-network/witness';
+export type IdWitnessConfigSchema = 'network.xyo.id.witness.config';
+export declare const IdWitnessConfigSchema: IdWitnessConfigSchema;
+export type IdWitnessConfig = XyoWitnessConfig<{
+    salt: string;
+    schema: IdWitnessConfigSchema;
+}>;
+export declare class IdWitness extends AbstractWitness<IdWitnessConfig> {
+    static configSchema: "network.xyo.id.witness.config";
+    get salt(): string;
+    static create(params?: XyoModuleParams<IdWitnessConfig>): Promise<IdWitness>;
+    observe(payloads?: IdPayload[]): Promise<XyoPayload[]>;
+}
+//# sourceMappingURL=Witness.d.ts.map

package/dist/esm/Witness.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAY,MAAM,gCAAgC,CAAA;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAExE,MAAM,MAAM,qBAAqB,GAAG,+BAA+B,CAAA;AACnE,eAAO,MAAM,qBAAqB,EAAE,qBAAuD,CAAA;AAE3F,MAAM,MAAM,eAAe,GAAG,gBAAgB,CAAC;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,qBAAqB,CAAA;CAC9B,CAAC,CAAA;AAEF,qBAAa,SAAU,SAAQ,eAAe,CAAC,eAAe,CAAC;IAC7D,OAAgB,YAAY,kCAAwB;IAEpD,IAAW,IAAI,WAEd;WAEqB,MAAM,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAI5E,OAAO,CAAC,QAAQ,GAAE,SAAS,EAAO,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;CAiB1E"}

package/dist/esm/Witness.js

@@ -0,0 +1,28 @@
+import { IdSchema } from '@xyo-network/id-payload-plugin';
+import { AbstractWitness } from '@xyo-network/witness';
+export const IdWitnessConfigSchema = 'network.xyo.id.witness.config';
+export class IdWitness extends AbstractWitness {
+    static configSchema = IdWitnessConfigSchema;
+    get salt() {
+        return this.config?.salt ?? `${Math.floor(Math.random() * 9999999)}`;
+    }
+    static async create(params) {
+        return (await super.create(params));
+    }
+    async observe(payloads = []) {
+        return await super.observe(payloads.length > 0
+            ? payloads.map((fieldItems) => {
+                return {
+                    salt: fieldItems?.salt ?? this.salt,
+                    schema: IdSchema,
+                };
+            })
+            : [
+                {
+                    salt: this.salt,
+                    schema: IdSchema,
+                },
+            ]);
+    }
+}
+//# sourceMappingURL=Witness.js.map

package/dist/esm/Witness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,QAAQ,EAAE,MAAM,gCAAgC,CAAA;AAGpE,OAAO,EAAE,eAAe,EAAoB,MAAM,sBAAsB,CAAA;AAGxE,MAAM,CAAC,MAAM,qBAAqB,GAA0B,+BAA+B,CAAA;AAO3F,MAAM,OAAO,SAAU,SAAQ,eAAgC;IAC7D,MAAM,CAAU,YAAY,GAAG,qBAAqB,CAAA;IAEpD,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAA;IACtE,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,MAAM,CAAC,MAAyC;QACpE,OAAO,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAc,CAAA;IAClD,CAAC;IAEQ,KAAK,CAAC,OAAO,CAAC,WAAwB,EAAE;QAC/C,OAAO,MAAM,KAAK,CAAC,OAAO,CACxB,QAAQ,CAAC,MAAM,GAAG,CAAC;YACjB,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC1B,OAAO;oBACL,IAAI,EAAE,UAAU,EAAE,IAAI,IAAI,IAAI,CAAC,IAAI;oBACnC,MAAM,EAAE,QAAQ;iBACjB,CAAA;YACH,CAAC,CAAC;YACJ,CAAC,CAAC;gBACE;oBACE,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,MAAM,EAAE,QAAQ;iBACjB;aACF,CACN,CAAA;IACH,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,5 @@
+import { IdPlugin } from './Plugin';
+export * from './Witness';
+export { IdPlugin };
+export default IdPlugin;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAEnC,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,QAAQ,EAAE,CAAA;AAGnB,eAAe,QAAQ,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+import { IdPlugin } from './Plugin';
+export * from './Witness';
+export { IdPlugin };
+// eslint-disable-next-line import/no-default-export
+export default IdPlugin;
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAEnC,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,QAAQ,EAAE,CAAA;AAEnB,oDAAoD;AACpD,eAAe,QAAQ,CAAA"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@xyo-network/id-plugin",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xyo-network/id-payload-plugin": "^2.42.0",
+    "@xyo-network/module": "^2.42.0",
+    "@xyo-network/payload": "^2.42.0",
+    "@xyo-network/payloadset-plugin": "^2.42.0",
+    "@xyo-network/witness": "^2.42.0",
+    "tslib": "^2.4.1"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.42.0"
+}

package/src/Plugin.spec.ts

@@ -0,0 +1,13 @@
+import { IdSchema } from '@xyo-network/id-payload-plugin'
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+
+import { IdPlugin } from './Plugin'
+
+describe('IdPlugin', () => {
+  test('Add to Resolver', () => {
+    const plugin = IdPlugin()
+    const resolver = new PayloadSetPluginResolver().register(plugin)
+    expect(resolver.resolve(plugin.set)).toBeObject()
+    expect(resolver.witness(IdSchema)).toBeObject()
+  })
+})

package/src/Plugin.ts

@@ -0,0 +1,17 @@
+import { IdSchema } from '@xyo-network/id-payload-plugin'
+import { XyoModuleParams } from '@xyo-network/module'
+import { PayloadSetSchema } from '@xyo-network/payload'
+import { createPayloadSetPlugin, PayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
+
+import { IdWitness, IdWitnessConfig } from './Witness'
+
+export const IdPlugin = () =>
+  createPayloadSetPlugin<PayloadSetWitnessPlugin<XyoModuleParams<IdWitnessConfig>>>(
+    { required: { [IdSchema]: 1 }, schema: PayloadSetSchema },
+    {
+      witness: async (params) => {
+        const result = await IdWitness.create(params)
+        return result
+      },
+    },
+  )

package/src/Witness.browser.spec.ts

@@ -0,0 +1,26 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { IdSchema } from '@xyo-network/id-payload-plugin'
+import { PayloadWrapper } from '@xyo-network/payload'
+
+import { IdWitness, IdWitnessConfigSchema } from './Witness'
+
+describe('IdWitness [Browser]', () => {
+  test('observe', async () => {
+    const witness = await IdWitness.create({
+      config: { salt: 'test', schema: IdWitnessConfigSchema },
+    })
+    const [observation] = await witness.observe([{ salt: 'test', schema: IdSchema }])
+    expect(observation.schema).toBe(IdSchema)
+    expect(new PayloadWrapper(observation).valid).toBe(true)
+  })
+
+  test('observe [no config]', async () => {
+    const witness = await IdWitness.create()
+    const [observation] = await witness.observe([{ salt: 'test', schema: IdSchema }])
+    expect(observation.schema).toBe(IdSchema)
+    expect(new PayloadWrapper(observation).valid).toBe(true)
+  })
+})

package/src/Witness.spec.ts

@@ -0,0 +1,78 @@
+import { IdPayload, IdSchema } from '@xyo-network/id-payload-plugin'
+import { PayloadWrapper } from '@xyo-network/payload'
+
+import { IdWitness, IdWitnessConfigSchema } from './Witness'
+
+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({ config })
+          const observations = (await witness.observe()) as IdPayload[]
+          validateObservationShape(observations)
+          const [observation] = observations
+          expect(observation.salt).toBe(witness.config.salt)
+        })
+        it('with salt uses payload salt', async () => {
+          const witness = await IdWitness.create({ config })
+          const observations = (await witness.observe([{ salt: payloadSalt, schema: IdSchema }])) as IdPayload[]
+          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({ config })
+          const observations = (await witness.observe()) as IdPayload[]
+          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()
+          const observations = (await witness.observe()) as IdPayload[]
+          validateObservationShape(observations)
+          const [observation] = observations
+          expect(parseInt(observation.salt)).toBeInteger()
+        })
+        it('with salt uses payload salt', async () => {
+          const witness = await IdWitness.create()
+          const observations = (await witness.observe([{ salt: payloadSalt, schema: IdSchema }])) as IdPayload[]
+          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()
+          const observations = (await witness.observe()) as IdPayload[]
+          validateObservationShape(observations)
+          const [observation] = observations
+          expect(parseInt(observation.salt)).toBeInteger()
+        })
+      })
+    })
+  })
+})
+
+const validateObservationShape = (observations: IdPayload[]) => {
+  expect(observations).toBeArrayOfSize(1)
+  const [observation] = observations
+  expect(observation.salt).toBeString()
+  expect(observation.schema).toBe(IdSchema)
+  expect(new PayloadWrapper(observation).valid).toBe(true)
+}

package/src/Witness.ts

@@ -0,0 +1,42 @@
+import { IdPayload, IdSchema } from '@xyo-network/id-payload-plugin'
+import { XyoModuleParams } from '@xyo-network/module'
+import { XyoPayload } from '@xyo-network/payload'
+import { AbstractWitness, XyoWitnessConfig } from '@xyo-network/witness'
+
+export type IdWitnessConfigSchema = 'network.xyo.id.witness.config'
+export const IdWitnessConfigSchema: IdWitnessConfigSchema = 'network.xyo.id.witness.config'
+
+export type IdWitnessConfig = XyoWitnessConfig<{
+  salt: string
+  schema: IdWitnessConfigSchema
+}>
+
+export class IdWitness extends AbstractWitness<IdWitnessConfig> {
+  static override configSchema = IdWitnessConfigSchema
+
+  public get salt() {
+    return this.config?.salt ?? `${Math.floor(Math.random() * 9999999)}`
+  }
+
+  static override async create(params?: XyoModuleParams<IdWitnessConfig>): Promise<IdWitness> {
+    return (await super.create(params)) as IdWitness
+  }
+
+  override async observe(payloads: IdPayload[] = []): Promise<XyoPayload[]> {
+    return await super.observe(
+      payloads.length > 0
+        ? payloads.map((fieldItems) => {
+            return {
+              salt: fieldItems?.salt ?? this.salt,
+              schema: IdSchema,
+            }
+          })
+        : [
+            {
+              salt: this.salt,
+              schema: IdSchema,
+            },
+          ],
+    )
+  }
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+import { IdPlugin } from './Plugin'
+
+export * from './Witness'
+
+export { IdPlugin }
+
+// eslint-disable-next-line import/no-default-export
+export default IdPlugin