@xyo-network/module-instance-payload-plugin 2.35.11

package/dist/esm/Payload.d.ts

@@ -0,0 +1,11 @@
+import { XyoPayload } from '@xyo-network/payload';
+import { XyoModuleInstanceSchema } from './Schema';
+export interface XyoModuleInstanceQueryConfig {
+    cost?: string;
+}
+export declare type XyoModuleInstancePayload = XyoPayload<{
+    schema: XyoModuleInstanceSchema;
+    address: string;
+    queries?: Record<string, XyoModuleInstanceQueryConfig>;
+}>;
+//# sourceMappingURL=Payload.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAElD,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,oBAAY,wBAAwB,GAAG,UAAU,CAAC;IAChD,MAAM,EAAE,uBAAuB,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAA;CACvD,CAAC,CAAA"}

package/dist/esm/Payload.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Payload.js.map

package/dist/esm/Payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Payload.js","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":""}

package/dist/esm/Plugin.d.ts

@@ -0,0 +1,32 @@
+export declare const XyoModuleInstancePayloadPlugin: () => import("@xyo-network/payload-plugin").XyoPayloadPlugin<import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+    schema: "network.xyo.module.instance";
+    address: string;
+    queries?: Record<string, import("./Payload").XyoModuleInstanceQueryConfig> | undefined;
+}, import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+    security?: {
+        allowed?: Record<string, string[][]> | undefined;
+        disallowed?: Record<string, string[]> | undefined;
+    } | undefined;
+} & {
+    schema: "network.xyo.module.instance.config";
+    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;
+} & {
+    targetSchema: "network.xyo.module.instance";
+}, import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+    security?: {
+        allowed?: Record<string, string[][]> | undefined;
+        disallowed?: Record<string, string[]> | undefined;
+    } | undefined;
+} & {
+    schema: "network.xyo.module.instance";
+    address: string;
+    queries?: Record<string, import("./Payload").XyoModuleInstanceQueryConfig> | 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":"AAOA,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWvC,CAAA"}

package/dist/esm/Plugin.js

@@ -0,0 +1,16 @@
+import { createXyoPayloadPlugin } from '@xyo-network/payload-plugin';
+import { XyoModuleInstanceSchema } from './Schema';
+import { XyoModuleInstancePayloadTemplate } from './Template';
+import { XyoModuleInstanceWitness, XyoModuleInstanceWitnessConfigSchema } from './Witness';
+export const XyoModuleInstancePayloadPlugin = () => createXyoPayloadPlugin({
+    schema: XyoModuleInstanceSchema,
+    template: XyoModuleInstancePayloadTemplate,
+    witness: (config) => {
+        return new XyoModuleInstanceWitness({
+            ...config,
+            schema: XyoModuleInstanceWitnessConfigSchema,
+            targetSchema: XyoModuleInstanceSchema,
+        });
+    },
+});
+//# 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,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AAGpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAClD,OAAO,EAAE,gCAAgC,EAAE,MAAM,YAAY,CAAA;AAC7D,OAAO,EAAE,wBAAwB,EAAkC,oCAAoC,EAAE,MAAM,WAAW,CAAA;AAE1H,MAAM,CAAC,MAAM,8BAA8B,GAAG,GAAG,EAAE,CACjD,sBAAsB,CAA2D;IAC/E,MAAM,EAAE,uBAAuB;IAC/B,QAAQ,EAAE,gCAAgC;IAC1C,OAAO,EAAE,CAAC,MAAM,EAA4B,EAAE;QAC5C,OAAO,IAAI,wBAAwB,CAAC;YAClC,GAAG,MAAM;YACT,MAAM,EAAE,oCAAoC;YAC5C,YAAY,EAAE,uBAAuB;SACtC,CAAC,CAAA;IACJ,CAAC;CACF,CAAC,CAAA"}

package/dist/esm/Schema.d.ts

@@ -0,0 +1,3 @@
+export declare type XyoModuleInstanceSchema = 'network.xyo.module.instance';
+export declare const XyoModuleInstanceSchema: XyoModuleInstanceSchema;
+//# sourceMappingURL=Schema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,oBAAY,uBAAuB,GAAG,6BAA6B,CAAA;AACnE,eAAO,MAAM,uBAAuB,EAAE,uBAAuD,CAAA"}

package/dist/esm/Schema.js

@@ -0,0 +1,2 @@
+export const XyoModuleInstanceSchema = 'network.xyo.module.instance';
+//# sourceMappingURL=Schema.js.map

package/dist/esm/Schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,uBAAuB,GAA4B,6BAA6B,CAAA"}

package/dist/esm/Template.d.ts

@@ -0,0 +1,3 @@
+import { XyoModuleInstancePayload } from './Payload';
+export declare const XyoModuleInstancePayloadTemplate: () => Partial<XyoModuleInstancePayload>;
+//# sourceMappingURL=Template.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Template.d.ts","sourceRoot":"","sources":["../../src/Template.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AAGpD,eAAO,MAAM,gCAAgC,QAAO,QAAQ,wBAAwB,CAMnF,CAAA"}

package/dist/esm/Template.js

@@ -0,0 +1,9 @@
+import { XyoModuleInstanceSchema } from './Schema';
+export const XyoModuleInstancePayloadTemplate = () => {
+    return {
+        address: undefined,
+        queries: undefined,
+        schema: XyoModuleInstanceSchema,
+    };
+};
+//# sourceMappingURL=Template.js.map

package/dist/esm/Template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Template.js","sourceRoot":"","sources":["../../src/Template.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAElD,MAAM,CAAC,MAAM,gCAAgC,GAAG,GAAsC,EAAE;IACtF,OAAO;QACL,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,SAAS;QAClB,MAAM,EAAE,uBAAuB;KAChC,CAAA;AACH,CAAC,CAAA"}

package/dist/esm/Witness.d.ts

@@ -0,0 +1,23 @@
+import { XyoModule } from '@xyo-network/module';
+import { XyoWitness, XyoWitnessConfig } from '@xyo-network/witness';
+import { XyoModuleInstancePayload } from './Payload';
+import { XyoModuleInstanceSchema } from './Schema';
+export declare type XyoModuleInstanceWitnessConfigSchema = 'network.xyo.module.instance.config';
+export declare const XyoModuleInstanceWitnessConfigSchema: XyoModuleInstanceWitnessConfigSchema;
+export declare type XyoModuleInstanceWitnessConfig = XyoWitnessConfig<XyoModuleInstancePayload, {
+    schema: XyoModuleInstanceWitnessConfigSchema;
+    module?: XyoModule;
+}>;
+export declare class XyoModuleInstanceWitness extends XyoWitness<XyoModuleInstancePayload, XyoModuleInstanceWitnessConfig> {
+    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;
+    observe(fields?: Partial<XyoModuleInstancePayload>): Promise<XyoModuleInstancePayload>;
+    static schema: XyoModuleInstanceSchema;
+}
+//# 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,MAAM,qBAAqB,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAGnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAElD,oBAAY,oCAAoC,GAAG,oCAAoC,CAAA;AACvF,eAAO,MAAM,oCAAoC,EAAE,oCAA2E,CAAA;AAE9H,oBAAY,8BAA8B,GAAG,gBAAgB,CAC3D,wBAAwB,EACxB;IACE,MAAM,EAAE,oCAAoC,CAAA;IAC5C,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB,CACF,CAAA;AAED,qBAAa,wBAAyB,SAAQ,UAAU,CAAC,wBAAwB,EAAE,8BAA8B,CAAC;IAChH,SAAS,KAAK,MAAM;;;;;;;mBAEnB;IAEc,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAIrG,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAA0B;CACjE"}

package/dist/esm/Witness.js

@@ -0,0 +1,14 @@
+import { XyoWitness } from '@xyo-network/witness';
+import merge from 'lodash/merge';
+import { XyoModuleInstanceSchema } from './Schema';
+export const XyoModuleInstanceWitnessConfigSchema = 'network.xyo.module.instance.config';
+export class XyoModuleInstanceWitness extends XyoWitness {
+    get module() {
+        return this.config?.module;
+    }
+    async observe(fields) {
+        return await super.observe(merge({ queries: this.module?.queries }, fields));
+    }
+    static 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,UAAU,EAAoB,MAAM,sBAAsB,CAAA;AACnE,OAAO,KAAK,MAAM,cAAc,CAAA;AAGhC,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAGlD,MAAM,CAAC,MAAM,oCAAoC,GAAyC,oCAAoC,CAAA;AAU9H,MAAM,OAAO,wBAAyB,SAAQ,UAAoE;IAChH,IAAc,MAAM;QAClB,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,CAAA;IAC5B,CAAC;IAEQ,KAAK,CAAC,OAAO,CAAC,MAA0C;QAC/D,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAC9E,CAAC;IAED,MAAM,CAAC,MAAM,GAA4B,uBAAuB,CAAA"}

package/dist/esm/index.d.ts

@@ -0,0 +1,8 @@
+import { XyoModuleInstancePayloadPlugin } from './Plugin';
+export * from './Payload';
+export * from './Schema';
+export * from './Template';
+export * from './Witness';
+export { XyoModuleInstancePayloadPlugin };
+export default XyoModuleInstancePayloadPlugin;
+//# 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,8BAA8B,EAAE,MAAM,UAAU,CAAA;AAEzD,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,8BAA8B,EAAE,CAAA;AAGzC,eAAe,8BAA8B,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,9 @@
+import { XyoModuleInstancePayloadPlugin } from './Plugin';
+export * from './Payload';
+export * from './Schema';
+export * from './Template';
+export * from './Witness';
+export { XyoModuleInstancePayloadPlugin };
+// eslint-disable-next-line import/no-default-export
+export default XyoModuleInstancePayloadPlugin;
+//# 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,8BAA8B,EAAE,MAAM,UAAU,CAAA;AAEzD,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,8BAA8B,EAAE,CAAA;AAEzC,oDAAoD;AACpD,eAAe,8BAA8B,CAAA"}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@xyo-network/module-instance-payload-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.36.11",
+    "@xyo-network/payload": "^2.36.11",
+    "@xyo-network/payload-plugin": "^2.36.11",
+    "@xyo-network/witness": "^2.36.11",
+    "lodash": "^4.17.21",
+    "tslib": "^2.4.0"
+  },
+  "peerDependencies": {
+    "axios": "^0.27.2",
+    "pako": "^2.0.4"
+  },
+  "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.35.11"
+}

package/src/Payload.ts

@@ -0,0 +1,13 @@
+import { XyoPayload } from '@xyo-network/payload'
+
+import { XyoModuleInstanceSchema } from './Schema'
+
+export interface XyoModuleInstanceQueryConfig {
+  cost?: string
+}
+
+export type XyoModuleInstancePayload = XyoPayload<{
+  schema: XyoModuleInstanceSchema
+  address: string
+  queries?: Record<string, XyoModuleInstanceQueryConfig>
+}>

package/src/Plugin.spec.ts

@@ -0,0 +1,18 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import { XyoPayloadPluginResolver } from '@xyo-network/payload-plugin'
+
+import { XyoModuleInstancePayloadPlugin } from './Plugin'
+import { XyoModuleInstanceSchema } from './Schema'
+
+describe('XyoModuleInstancePayloadPlugin', () => {
+  test('Add to Resolver', () => {
+    const resolver = new XyoPayloadPluginResolver().register(XyoModuleInstancePayloadPlugin(), {
+      witness: {},
+    })
+    expect(resolver.resolve({ schema: XyoModuleInstanceSchema })).toBeObject()
+    expect(resolver.witness(XyoModuleInstanceSchema)).toBeObject()
+  })
+})

package/src/Plugin.ts

@@ -0,0 +1,19 @@
+import { createXyoPayloadPlugin } from '@xyo-network/payload-plugin'
+
+import { XyoModuleInstancePayload } from './Payload'
+import { XyoModuleInstanceSchema } from './Schema'
+import { XyoModuleInstancePayloadTemplate } from './Template'
+import { XyoModuleInstanceWitness, XyoModuleInstanceWitnessConfig, XyoModuleInstanceWitnessConfigSchema } from './Witness'
+
+export const XyoModuleInstancePayloadPlugin = () =>
+  createXyoPayloadPlugin<XyoModuleInstancePayload, XyoModuleInstanceWitnessConfig>({
+    schema: XyoModuleInstanceSchema,
+    template: XyoModuleInstancePayloadTemplate,
+    witness: (config): XyoModuleInstanceWitness => {
+      return new XyoModuleInstanceWitness({
+        ...config,
+        schema: XyoModuleInstanceWitnessConfigSchema,
+        targetSchema: XyoModuleInstanceSchema,
+      })
+    },
+  })

package/src/Schema.ts

@@ -0,0 +1,2 @@
+export type XyoModuleInstanceSchema = 'network.xyo.module.instance'
+export const XyoModuleInstanceSchema: XyoModuleInstanceSchema = 'network.xyo.module.instance'

package/src/Template.ts

@@ -0,0 +1,10 @@
+import { XyoModuleInstancePayload } from './Payload'
+import { XyoModuleInstanceSchema } from './Schema'
+
+export const XyoModuleInstancePayloadTemplate = (): Partial<XyoModuleInstancePayload> => {
+  return {
+    address: undefined,
+    queries: undefined,
+    schema: XyoModuleInstanceSchema,
+  }
+}

package/src/Witness.spec.ts

@@ -0,0 +1,16 @@
+import { XyoMemoryArchivist } from '@xyo-network/archivist'
+
+import { XyoModuleInstanceSchema } from './Schema'
+import { XyoModuleInstanceWitness, XyoModuleInstanceWitnessConfigSchema } from './Witness'
+
+describe('XyoElevationWitness', () => {
+  test('Witnessing', async () => {
+    const module = new XyoMemoryArchivist()
+    const witness = new XyoModuleInstanceWitness({ module, schema: XyoModuleInstanceWitnessConfigSchema, targetSchema: XyoModuleInstanceSchema })
+    const result = await witness.observe()
+
+    console.log(`Module: ${JSON.stringify(result, null, 2)}`)
+
+    expect(result.queries?.length).toBe(2)
+  })
+})

package/src/Witness.ts

@@ -0,0 +1,29 @@
+import { XyoModule } from '@xyo-network/module'
+import { XyoWitness, XyoWitnessConfig } from '@xyo-network/witness'
+import merge from 'lodash/merge'
+
+import { XyoModuleInstancePayload } from './Payload'
+import { XyoModuleInstanceSchema } from './Schema'
+
+export type XyoModuleInstanceWitnessConfigSchema = 'network.xyo.module.instance.config'
+export const XyoModuleInstanceWitnessConfigSchema: XyoModuleInstanceWitnessConfigSchema = 'network.xyo.module.instance.config'
+
+export type XyoModuleInstanceWitnessConfig = XyoWitnessConfig<
+  XyoModuleInstancePayload,
+  {
+    schema: XyoModuleInstanceWitnessConfigSchema
+    module?: XyoModule
+  }
+>
+
+export class XyoModuleInstanceWitness extends XyoWitness<XyoModuleInstancePayload, XyoModuleInstanceWitnessConfig> {
+  protected get module() {
+    return this.config?.module
+  }
+
+  override async observe(fields?: Partial<XyoModuleInstancePayload>): Promise<XyoModuleInstancePayload> {
+    return await super.observe(merge({ queries: this.module?.queries }, fields))
+  }
+
+  static schema: XyoModuleInstanceSchema = XyoModuleInstanceSchema
+}

package/src/index.ts

@@ -0,0 +1,11 @@
+import { XyoModuleInstancePayloadPlugin } from './Plugin'
+
+export * from './Payload'
+export * from './Schema'
+export * from './Template'
+export * from './Witness'
+
+export { XyoModuleInstancePayloadPlugin }
+
+// eslint-disable-next-line import/no-default-export
+export default XyoModuleInstancePayloadPlugin