@xyo-network/domain-plugin 2.42.0

package/dist/esm/Config.d.ts

@@ -0,0 +1,8 @@
+import { XyoWitnessConfig } from '@xyo-network/witness';
+export type XyoDomainWitnessConfigSchema = 'network.xyo.domain.witness.config';
+export declare const XyoDomainWitnessConfigSchema = "network.xyo.domain.witness.config";
+export type XyoDomainWitnessConfig = XyoWitnessConfig<{
+    domain: string;
+    schema: XyoDomainWitnessConfigSchema;
+}>;
+//# 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,4BAA4B,GAAG,mCAAmC,CAAA;AAC9E,eAAO,MAAM,4BAA4B,sCAAsC,CAAA;AAE/E,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;IACpD,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,4BAA4B,CAAA;CACrC,CAAC,CAAA"}

package/dist/esm/Config.js

@@ -0,0 +1,2 @@
+export const XyoDomainWitnessConfigSchema = 'network.xyo.domain.witness.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,4BAA4B,GAAG,mCAAmC,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 DomainPlugin: () => PayloadSetWitnessPlugin<XyoModuleParams<import("@xyo-network/payload").SchemaFields & import("@xyo-network/payload").PayloadFields & {
+    security?: {
+        allowed?: Record<string, string[][]> | undefined;
+        disallowed?: Record<string, string[]> | undefined;
+    } | undefined;
+} & {
+    domain: string;
+    schema: "network.xyo.domain.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;AAKhG,eAAO,MAAM,YAAY;;;;;;;;;;;;GAStB,CAAA"}

package/dist/esm/Plugin.js

@@ -0,0 +1,11 @@
+import { XyoDomainSchema } from '@xyo-network/domain-payload-plugin';
+import { PayloadSetSchema } from '@xyo-network/payload';
+import { createPayloadSetPlugin } from '@xyo-network/payloadset-plugin';
+import { XyoDomainWitness } from './Witness';
+export const DomainPlugin = () => createPayloadSetPlugin({ required: { [XyoDomainSchema]: 1 }, schema: PayloadSetSchema }, {
+    witness: async (params) => {
+        const result = await XyoDomainWitness.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,eAAe,EAAE,MAAM,oCAAoC,CAAA;AAEpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAA2B,MAAM,gCAAgC,CAAA;AAGhG,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAE5C,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,EAAE,CAC/B,sBAAsB,CACpB,EAAE,QAAQ,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAChE;IACE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACxB,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QACpD,OAAO,MAAM,CAAA;IACf,CAAC;CACF,CACF,CAAA"}

package/dist/esm/Witness.d.ts

@@ -0,0 +1,13 @@
+import { XyoDomainPayload } from '@xyo-network/domain-payload-plugin';
+import { XyoModuleParams } from '@xyo-network/module';
+import { XyoPayload } from '@xyo-network/payload';
+import { AbstractWitness } from '@xyo-network/witness';
+import { XyoDomainWitnessConfig } from './Config';
+export declare class XyoDomainWitness extends AbstractWitness<XyoDomainWitnessConfig> {
+    static configSchema: string;
+    static dmarc: string;
+    static create(params?: XyoModuleParams<XyoDomainWitnessConfig>): Promise<XyoDomainWitness>;
+    static generateDmarc(domain: string): string;
+    observe(_payload: XyoDomainPayload[]): 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,gBAAgB,EAAmB,MAAM,oCAAoC,CAAA;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,OAAO,EAAE,sBAAsB,EAAgC,MAAM,UAAU,CAAA;AAE/E,qBAAa,gBAAiB,SAAQ,eAAe,CAAC,sBAAsB,CAAC;IAC3E,OAAgB,YAAY,SAA+B;IAC3D,OAAc,KAAK,SAAS;WAEN,MAAM,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,sBAAsB,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC;WAI3F,aAAa,CAAC,MAAM,EAAE,MAAM;IAI3B,OAAO,CAAC,QAAQ,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;CAG5E"}

package/dist/esm/Witness.js

@@ -0,0 +1,17 @@
+import { XyoDomainSchema } from '@xyo-network/domain-payload-plugin';
+import { AbstractWitness } from '@xyo-network/witness';
+import { XyoDomainWitnessConfigSchema } from './Config';
+export class XyoDomainWitness extends AbstractWitness {
+    static configSchema = XyoDomainWitnessConfigSchema;
+    static dmarc = '_xyo';
+    static async create(params) {
+        return (await super.create(params));
+    }
+    static generateDmarc(domain) {
+        return `${XyoDomainWitness.dmarc}.${domain}`;
+    }
+    async observe(_payload) {
+        return await super.observe([{ schema: XyoDomainSchema }]);
+    }
+}
+//# 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,EAAoB,eAAe,EAAE,MAAM,oCAAoC,CAAA;AAGtF,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,OAAO,EAA0B,4BAA4B,EAAE,MAAM,UAAU,CAAA;AAE/E,MAAM,OAAO,gBAAiB,SAAQ,eAAuC;IAC3E,MAAM,CAAU,YAAY,GAAG,4BAA4B,CAAA;IACpD,MAAM,CAAC,KAAK,GAAG,MAAM,CAAA;IAE5B,MAAM,CAAU,KAAK,CAAC,MAAM,CAAC,MAAgD;QAC3E,OAAO,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAqB,CAAA;IACzD,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,MAAc;QACxC,OAAO,GAAG,gBAAgB,CAAC,KAAK,IAAI,MAAM,EAAE,CAAA;IAC9C,CAAC;IAEQ,KAAK,CAAC,OAAO,CAAC,QAA4B;QACjD,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC,CAAA;IAC3D,CAAC"}

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

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

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@xyo-network/domain-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/domain-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"
+  },
+  "peerDependencies": {
+    "axios": "~1.2.1",
+    "pako": "^2.1.0"
+  },
+  "devDependencies": {
+    "axios": "~1.2.1",
+    "pako": "^2.1.0"
+  },
+  "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 XyoDomainWitnessConfigSchema = 'network.xyo.domain.witness.config'
+export const XyoDomainWitnessConfigSchema = 'network.xyo.domain.witness.config'
+
+export type XyoDomainWitnessConfig = XyoWitnessConfig<{
+  domain: string
+  schema: XyoDomainWitnessConfigSchema
+}>

package/src/Plugin.spec.ts

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

package/src/Plugin.ts

@@ -0,0 +1,18 @@
+import { XyoDomainSchema } from '@xyo-network/domain-payload-plugin'
+import { XyoModuleParams } from '@xyo-network/module'
+import { PayloadSetSchema } from '@xyo-network/payload'
+import { createPayloadSetPlugin, PayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
+
+import { XyoDomainWitnessConfig } from './Config'
+import { XyoDomainWitness } from './Witness'
+
+export const DomainPlugin = () =>
+  createPayloadSetPlugin<PayloadSetWitnessPlugin<XyoModuleParams<XyoDomainWitnessConfig>>>(
+    { required: { [XyoDomainSchema]: 1 }, schema: PayloadSetSchema },
+    {
+      witness: async (params) => {
+        const result = await XyoDomainWitness.create(params)
+        return result
+      },
+    },
+  )

package/src/Witness.spec.ts

@@ -0,0 +1,19 @@
+import { XyoDomainWitnessConfigSchema } from './Config'
+import { XyoDomainWitness } from './Witness'
+
+describe('XyoDomainConfigWitness', () => {
+  test('valid-instantiation', async () => {
+    const witness = await XyoDomainWitness.create({
+      config: {
+        domain: 'xyo.network',
+        schema: XyoDomainWitnessConfigSchema,
+      },
+    })
+    expect(witness).toBeTruthy()
+    expect(XyoDomainWitness.dmarc).toBe('_xyo')
+  })
+
+  test('generatesDmarc', () => {
+    expect(XyoDomainWitness.generateDmarc('foo')).toBe('_xyo.foo')
+  })
+})

package/src/Witness.ts

@@ -0,0 +1,23 @@
+import { XyoDomainPayload, XyoDomainSchema } from '@xyo-network/domain-payload-plugin'
+import { XyoModuleParams } from '@xyo-network/module'
+import { XyoPayload } from '@xyo-network/payload'
+import { AbstractWitness } from '@xyo-network/witness'
+
+import { XyoDomainWitnessConfig, XyoDomainWitnessConfigSchema } from './Config'
+
+export class XyoDomainWitness extends AbstractWitness<XyoDomainWitnessConfig> {
+  static override configSchema = XyoDomainWitnessConfigSchema
+  public static dmarc = '_xyo'
+
+  static override async create(params?: XyoModuleParams<XyoDomainWitnessConfig>): Promise<XyoDomainWitness> {
+    return (await super.create(params)) as XyoDomainWitness
+  }
+
+  public static generateDmarc(domain: string) {
+    return `${XyoDomainWitness.dmarc}.${domain}`
+  }
+
+  override async observe(_payload: XyoDomainPayload[]): Promise<XyoPayload[]> {
+    return await super.observe([{ schema: XyoDomainSchema }])
+  }
+}

package/src/index.ts

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