@xyo-network/module-instance-plugin 2.42.0

package/dist/esm/Plugin.d.ts

@@ -0,0 +1,23 @@
+import { XyoModuleParams } from '@xyo-network/module';
+import { PayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin';
+export declare const XyoModuleInstancePlugin: () => PayloadSetWitnessPlugin<XyoModuleParams<import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+    security?: {
+        allowed?: Record<string, string[][]> | undefined;
+        disallowed?: Record<string, string[]> | undefined;
+    } | undefined;
+} & {
+    module?: import("@xyo-network/module").XyoModule<import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+        security?: {
+            allowed?: Record<string, string[][]> | undefined;
+            disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+    } & {
+        schema: string;
+    }> | undefined;
+    schema: "network.xyo.module.instance.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":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAGrD,OAAO,EAA0B,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAIhG,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;GASjC,CAAA"}

package/dist/esm/Plugin.js

@@ -0,0 +1,11 @@
+import { XyoModuleInstanceSchema } from '@xyo-network/module-instance-payload-plugin';
+import { PayloadSetSchema } from '@xyo-network/payload';
+import { createPayloadSetPlugin } from '@xyo-network/payloadset-plugin';
+import { XyoModuleInstanceWitness } from './Witness';
+export const XyoModuleInstancePlugin = () => createPayloadSetPlugin({ required: { [XyoModuleInstanceSchema]: 1 }, schema: PayloadSetSchema }, {
+    witness: async (params) => {
+        const result = await XyoModuleInstanceWitness.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":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAA;AACrF,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAA2B,MAAM,gCAAgC,CAAA;AAEhG,OAAO,EAAE,wBAAwB,EAAkC,MAAM,WAAW,CAAA;AAEpF,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE,CAC1C,sBAAsB,CACpB,EAAE,QAAQ,EAAE,EAAE,CAAC,uBAAuB,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAE,EACxE;IACE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACxB,MAAM,MAAM,GAAG,MAAM,wBAAwB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC5D,OAAO,MAAM,CAAA;IACf,CAAC;CACF,CACF,CAAA"}

package/dist/esm/Witness.d.ts

@@ -0,0 +1,23 @@
+import { XyoModule, XyoModuleParams } from '@xyo-network/module';
+import { XyoPayload } from '@xyo-network/payload';
+import { AbstractWitness, XyoWitnessConfig } from '@xyo-network/witness';
+export type XyoModuleInstanceWitnessConfigSchema = 'network.xyo.module.instance.config';
+export declare const XyoModuleInstanceWitnessConfigSchema: XyoModuleInstanceWitnessConfigSchema;
+export type XyoModuleInstanceWitnessConfig = XyoWitnessConfig<{
+    module?: XyoModule;
+    schema: XyoModuleInstanceWitnessConfigSchema;
+}>;
+export declare class XyoModuleInstanceWitness extends AbstractWitness<XyoModuleInstanceWitnessConfig> {
+    static configSchema: "network.xyo.module.instance.config";
+    protected get module(): XyoModule<import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+        security?: {
+            allowed?: Record<string, string[][]> | undefined;
+            disallowed?: Record<string, string[]> | undefined;
+        } | undefined;
+    } & {
+        schema: string;
+    }> | undefined;
+    static create(params?: XyoModuleParams<XyoModuleInstanceWitnessConfig>): Promise<XyoModuleInstanceWitness>;
+    observe(payloads?: Partial<XyoPayload>[]): 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,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAGxE,MAAM,MAAM,oCAAoC,GAAG,oCAAoC,CAAA;AACvF,eAAO,MAAM,oCAAoC,EAAE,oCAA2E,CAAA;AAE9H,MAAM,MAAM,8BAA8B,GAAG,gBAAgB,CAAC;IAC5D,MAAM,CAAC,EAAE,SAAS,CAAA;IAClB,MAAM,EAAE,oCAAoC,CAAA;CAC7C,CAAC,CAAA;AAEF,qBAAa,wBAAyB,SAAQ,eAAe,CAAC,8BAA8B,CAAC;IAC3F,OAAgB,YAAY,uCAAuC;IAEnE,SAAS,KAAK,MAAM;;;;;;;mBAEnB;WAEqB,MAAM,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAI1G,OAAO,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;CAGhF"}

package/dist/esm/Witness.js

@@ -0,0 +1,17 @@
+import { XyoModuleInstanceSchema } from '@xyo-network/module-instance-payload-plugin';
+import { AbstractWitness } from '@xyo-network/witness';
+import merge from 'lodash/merge';
+export const XyoModuleInstanceWitnessConfigSchema = 'network.xyo.module.instance.config';
+export class XyoModuleInstanceWitness extends AbstractWitness {
+    static configSchema = XyoModuleInstanceWitnessConfigSchema;
+    get module() {
+        return this.config?.module;
+    }
+    static async create(params) {
+        return (await super.create(params));
+    }
+    async observe(payloads) {
+        return await super.observe([merge({ queries: this.module?.queries }, payloads?.[0], { schema: XyoModuleInstanceSchema })]);
+    }
+}
+//# 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":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAA;AAErF,OAAO,EAAE,eAAe,EAAoB,MAAM,sBAAsB,CAAA;AACxE,OAAO,KAAK,MAAM,cAAc,CAAA;AAGhC,MAAM,CAAC,MAAM,oCAAoC,GAAyC,oCAAoC,CAAA;AAO9H,MAAM,OAAO,wBAAyB,SAAQ,eAA+C;IAC3F,MAAM,CAAU,YAAY,GAAG,oCAAoC,CAAA;IAEnE,IAAc,MAAM;QAClB,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,CAAA;IAC5B,CAAC;IAED,MAAM,CAAU,KAAK,CAAC,MAAM,CAAC,MAAwD;QACnF,OAAO,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAA6B,CAAA;IACjE,CAAC;IAEQ,KAAK,CAAC,OAAO,CAAC,QAAgC;QACrD,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAC,CAAC,CAAA;IAC5H,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,5 @@
+import { XyoModuleInstancePlugin } from './Plugin';
+export * from './Witness';
+export { XyoModuleInstancePlugin };
+export default XyoModuleInstancePlugin;
+//# 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,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAElD,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,uBAAuB,EAAE,CAAA;AAGlC,eAAe,uBAAuB,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+import { XyoModuleInstancePlugin } from './Plugin';
+export * from './Witness';
+export { XyoModuleInstancePlugin };
+// eslint-disable-next-line import/no-default-export
+export default XyoModuleInstancePlugin;
+//# 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,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAElD,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,uBAAuB,EAAE,CAAA;AAElC,oDAAoD;AACpD,eAAe,uBAAuB,CAAA"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@xyo-network/module-instance-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/module": "^2.42.0",
+    "@xyo-network/module-instance-payload-plugin": "^2.42.0",
+    "@xyo-network/payload": "^2.42.0",
+    "@xyo-network/payloadset-plugin": "^2.42.0",
+    "@xyo-network/witness": "^2.42.0",
+    "lodash": "^4.17.21",
+    "tslib": "^2.4.1"
+  },
+  "devDependencies": {
+    "axios": "~1.2.1",
+    "pako": "^2.1.0"
+  },
+  "peerDependencies": {
+    "axios": "~1.2.1",
+    "pako": "^2.1.0"
+  },
+  "description": "Contains the information about a module instance",
+  "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,22 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { XyoModuleInstanceSchema } from '@xyo-network/module-instance-payload-plugin'
+import { PayloadSetPluginResolver } from '@xyo-network/payloadset-plugin'
+
+import { XyoModuleInstancePlugin } from './Plugin'
+import { XyoModuleInstanceWitnessConfigSchema } from './Witness'
+
+describe('XyoModuleInstancePlugin', () => {
+  test('Add to Resolver', () => {
+    const plugin = XyoModuleInstancePlugin()
+    const resolver = new PayloadSetPluginResolver().register(plugin, {
+      witness: {
+        config: { schema: XyoModuleInstanceWitnessConfigSchema, targetSchema: XyoModuleInstanceSchema },
+      },
+    })
+    expect(resolver.resolve(plugin.set)).toBeObject()
+    expect(resolver.witness(XyoModuleInstanceSchema)).toBeObject()
+  })
+})

package/src/Plugin.ts

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

package/src/Witness.spec.ts

@@ -0,0 +1,21 @@
+import { MemoryArchivist } from '@xyo-network/archivist'
+import { PayloadWrapper } from '@xyo-network/payload'
+
+import { XyoModuleInstanceWitness, XyoModuleInstanceWitnessConfigSchema } from './Witness'
+
+describe('XyoModuleInstanceWitness', () => {
+  test('Witnessing', async () => {
+    const module = await MemoryArchivist.create()
+    const witness = await XyoModuleInstanceWitness.create({
+      config: { module, schema: XyoModuleInstanceWitnessConfigSchema },
+    })
+    const [result] = await witness.observe()
+    expect(new PayloadWrapper(result).valid).toBe(true)
+  })
+
+  test('Witnessing [no config]', async () => {
+    const witness = await XyoModuleInstanceWitness.create()
+    const [result] = await witness.observe()
+    expect(new PayloadWrapper(result).valid).toBe(true)
+  })
+})

package/src/Witness.ts

@@ -0,0 +1,29 @@
+import { XyoModule, XyoModuleParams } from '@xyo-network/module'
+import { XyoModuleInstanceSchema } from '@xyo-network/module-instance-payload-plugin'
+import { XyoPayload } from '@xyo-network/payload'
+import { AbstractWitness, XyoWitnessConfig } from '@xyo-network/witness'
+import merge from 'lodash/merge'
+
+export type XyoModuleInstanceWitnessConfigSchema = 'network.xyo.module.instance.config'
+export const XyoModuleInstanceWitnessConfigSchema: XyoModuleInstanceWitnessConfigSchema = 'network.xyo.module.instance.config'
+
+export type XyoModuleInstanceWitnessConfig = XyoWitnessConfig<{
+  module?: XyoModule
+  schema: XyoModuleInstanceWitnessConfigSchema
+}>
+
+export class XyoModuleInstanceWitness extends AbstractWitness<XyoModuleInstanceWitnessConfig> {
+  static override configSchema = XyoModuleInstanceWitnessConfigSchema
+
+  protected get module() {
+    return this.config?.module
+  }
+
+  static override async create(params?: XyoModuleParams<XyoModuleInstanceWitnessConfig>): Promise<XyoModuleInstanceWitness> {
+    return (await super.create(params)) as XyoModuleInstanceWitness
+  }
+
+  override async observe(payloads?: Partial<XyoPayload>[]): Promise<XyoPayload[]> {
+    return await super.observe([merge({ queries: this.module?.queries }, payloads?.[0], { schema: XyoModuleInstanceSchema })])
+  }
+}

package/src/index.ts

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