@xyo-network/node-system-info-plugin 2.42.0

package/dist/esm/Config.d.ts

@@ -0,0 +1,8 @@
+import { XyoWitnessConfig } from '@xyo-network/witness';
+export type XyoNodeSystemInfoWitnessConfigSchema = 'network.xyo.system.info.witness.node.config';
+export declare const XyoNodeSystemInfoWitnessConfigSchema: XyoNodeSystemInfoWitnessConfigSchema;
+export type XyoNodeSystemInfoWitnessConfig = XyoWitnessConfig<{
+    nodeValues?: Record<string, string>;
+    schema: XyoNodeSystemInfoWitnessConfigSchema;
+}>;
+//# sourceMappingURL=Config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAEvD,MAAM,MAAM,oCAAoC,GAAG,6CAA6C,CAAA;AAChG,eAAO,MAAM,oCAAoC,EAAE,oCAAoF,CAAA;AAEvI,MAAM,MAAM,8BAA8B,GAAG,gBAAgB,CAAC;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACnC,MAAM,EAAE,oCAAoC,CAAA;CAC7C,CAAC,CAAA"}

package/dist/esm/Config.js

@@ -0,0 +1,2 @@
+export const XyoNodeSystemInfoWitnessConfigSchema = 'network.xyo.system.info.witness.node.config';
+//# sourceMappingURL=Config.js.map

package/dist/esm/Config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.js","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,oCAAoC,GAAyC,6CAA6C,CAAA"}

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 XyoNodeSystemInfoPlugin: () => PayloadSetWitnessPlugin<XyoModuleParams<import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+    security?: {
+        allowed?: Record<string, string[][]> | undefined;
+        disallowed?: Record<string, string[]> | undefined;
+    } | undefined;
+} & {
+    nodeValues?: Record<string, string> | undefined;
+    schema: "network.xyo.system.info.witness.node.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;AAKhG,eAAO,MAAM,uBAAuB;;;;;;;;;;;;GASjC,CAAA"}

package/dist/esm/Plugin.js

@@ -0,0 +1,11 @@
+import { XyoNodeSystemInfoSchema } from '@xyo-network/node-system-info-payload-plugin';
+import { PayloadSetSchema } from '@xyo-network/payload';
+import { createPayloadSetPlugin } from '@xyo-network/payloadset-plugin';
+import { XyoNodeSystemInfoWitness } from './Witness';
+export const XyoNodeSystemInfoPlugin = () => createPayloadSetPlugin({ required: { [XyoNodeSystemInfoSchema]: 1 }, schema: PayloadSetSchema }, {
+    witness: async (params) => {
+        const result = await XyoNodeSystemInfoWitness.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,8CAA8C,CAAA;AACtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAA2B,MAAM,gCAAgC,CAAA;AAGhG,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AAEpD,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,12 @@
+import { XyoModuleParams } from '@xyo-network/module';
+import { XyoNodeSystemInfoPayload } from '@xyo-network/node-system-info-payload-plugin';
+import { AbstractWitness } from '@xyo-network/witness';
+import { XyoNodeSystemInfoWitnessConfig } from './Config';
+export declare class XyoNodeSystemInfoWitness<TPayload extends XyoNodeSystemInfoPayload = XyoNodeSystemInfoPayload> extends AbstractWitness<XyoNodeSystemInfoWitnessConfig> {
+    static configSchema: "network.xyo.system.info.witness.node.config";
+    static create(params?: XyoModuleParams<XyoNodeSystemInfoWitnessConfig>): Promise<XyoNodeSystemInfoWitness>;
+    observe(payloads?: TPayload[]): Promise<(import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+        schema: string;
+    })[]>;
+}
+//# 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,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAA2B,wBAAwB,EAA2B,MAAM,8CAA8C,CAAA;AACzI,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAGtD,OAAO,EAAE,8BAA8B,EAAwC,MAAM,UAAU,CAAA;AAE/F,qBAAa,wBAAwB,CACnC,QAAQ,SAAS,wBAAwB,GAAG,wBAAwB,CACpE,SAAQ,eAAe,CAAC,8BAA8B,CAAC;IACvD,OAAgB,YAAY,gDAAuC;WAE7C,MAAM,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAI1G,OAAO,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE;;;CAI7C"}

package/dist/esm/Witness.js

@@ -0,0 +1,15 @@
+import { defaultSystemInfoConfig, XyoNodeSystemInfoSchema } from '@xyo-network/node-system-info-payload-plugin';
+import { AbstractWitness } from '@xyo-network/witness';
+import { get } from 'systeminformation';
+import { XyoNodeSystemInfoWitnessConfigSchema } from './Config';
+export class XyoNodeSystemInfoWitness extends AbstractWitness {
+    static configSchema = XyoNodeSystemInfoWitnessConfigSchema;
+    static async create(params) {
+        return (await super.create(params));
+    }
+    async observe(payloads) {
+        const node = await get(this.config?.nodeValues ?? defaultSystemInfoConfig());
+        return await super.observe([{ ...node, ...payloads?.[0], schema: XyoNodeSystemInfoSchema }]);
+    }
+}
+//# 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,EAA4B,uBAAuB,EAAE,MAAM,8CAA8C,CAAA;AACzI,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAEvC,OAAO,EAAkC,oCAAoC,EAAE,MAAM,UAAU,CAAA;AAE/F,MAAM,OAAO,wBAEX,SAAQ,eAA+C;IACvD,MAAM,CAAU,YAAY,GAAG,oCAAoC,CAAA;IAEnE,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,QAAqB;QAC1C,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,IAAI,uBAAuB,EAAE,CAAC,CAAA;QAC5E,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAC,CAAA;IAC9F,CAAC"}

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

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

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@xyo-network/node-system-info-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/node-system-info-payload-plugin": "^2.42.0",
+    "@xyo-network/payload": "^2.42.0",
+    "@xyo-network/payloadset-plugin": "^2.42.0",
+    "@xyo-network/witness": "^2.42.0",
+    "systeminformation": "^5.16.5",
+    "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/Config.ts

@@ -0,0 +1,9 @@
+import { XyoWitnessConfig } from '@xyo-network/witness'
+
+export type XyoNodeSystemInfoWitnessConfigSchema = 'network.xyo.system.info.witness.node.config'
+export const XyoNodeSystemInfoWitnessConfigSchema: XyoNodeSystemInfoWitnessConfigSchema = 'network.xyo.system.info.witness.node.config'
+
+export type XyoNodeSystemInfoWitnessConfig = XyoWitnessConfig<{
+  nodeValues?: Record<string, string>
+  schema: XyoNodeSystemInfoWitnessConfigSchema
+}>

package/src/Plugin.spec.ts

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

package/src/Plugin.ts

@@ -0,0 +1,18 @@
+import { XyoModuleParams } from '@xyo-network/module'
+import { XyoNodeSystemInfoSchema } from '@xyo-network/node-system-info-payload-plugin'
+import { PayloadSetSchema } from '@xyo-network/payload'
+import { createPayloadSetPlugin, PayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
+
+import { XyoNodeSystemInfoWitnessConfig } from './Config'
+import { XyoNodeSystemInfoWitness } from './Witness'
+
+export const XyoNodeSystemInfoPlugin = () =>
+  createPayloadSetPlugin<PayloadSetWitnessPlugin<XyoModuleParams<XyoNodeSystemInfoWitnessConfig>>>(
+    { required: { [XyoNodeSystemInfoSchema]: 1 }, schema: PayloadSetSchema },
+    {
+      witness: async (params) => {
+        const result = await XyoNodeSystemInfoWitness.create(params)
+        return result
+      },
+    },
+  )

package/src/Witness.spec.ts

@@ -0,0 +1,23 @@
+import { PayloadWrapper } from '@xyo-network/payload'
+
+import { XyoNodeSystemInfoWitnessConfigSchema } from './Config'
+import { XyoNodeSystemInfoWitness } from './Witness'
+
+describe('XyoSystemInfoWitness', () => {
+  test('observe', async () => {
+    const witness = await XyoNodeSystemInfoWitness.create({
+      config: { schema: XyoNodeSystemInfoWitnessConfigSchema },
+    })
+
+    const [observation] = await witness.observe()
+    expect(observation.schema).toBe('network.xyo.system.info.node')
+    expect(new PayloadWrapper(observation).valid).toBe(true)
+  }, 60000)
+  test('observe [no config]', async () => {
+    const witness = await XyoNodeSystemInfoWitness.create()
+
+    const [observation] = await witness.observe()
+    expect(observation.schema).toBe('network.xyo.system.info.node')
+    expect(new PayloadWrapper(observation).valid).toBe(true)
+  }, 60000)
+})

package/src/Witness.ts

@@ -0,0 +1,21 @@
+import { XyoModuleParams } from '@xyo-network/module'
+import { defaultSystemInfoConfig, XyoNodeSystemInfoPayload, XyoNodeSystemInfoSchema } from '@xyo-network/node-system-info-payload-plugin'
+import { AbstractWitness } from '@xyo-network/witness'
+import { get } from 'systeminformation'
+
+import { XyoNodeSystemInfoWitnessConfig, XyoNodeSystemInfoWitnessConfigSchema } from './Config'
+
+export class XyoNodeSystemInfoWitness<
+  TPayload extends XyoNodeSystemInfoPayload = XyoNodeSystemInfoPayload,
+> extends AbstractWitness<XyoNodeSystemInfoWitnessConfig> {
+  static override configSchema = XyoNodeSystemInfoWitnessConfigSchema
+
+  static override async create(params?: XyoModuleParams<XyoNodeSystemInfoWitnessConfig>): Promise<XyoNodeSystemInfoWitness> {
+    return (await super.create(params)) as XyoNodeSystemInfoWitness
+  }
+
+  override async observe(payloads?: TPayload[]) {
+    const node = await get(this.config?.nodeValues ?? defaultSystemInfoConfig())
+    return await super.observe([{ ...node, ...payloads?.[0], schema: XyoNodeSystemInfoSchema }])
+  }
+}

package/src/index.ts

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