@xyo-network/domain-payload-plugin 2.23.3 → 2.24.0

package/dist/esm/Payload.d.ts

@@ -0,0 +1,21 @@
+import { XyoNetworkPayload } from '@xyo-network/network';
+import { XyoPayload } from '@xyo-network/payload';
+import { XyoDomainPayloadSchema } from './Schema';
+export interface XyoAlias {
+    /** @field cononical name (ex. network.xyo.example) */
+    name?: string;
+    /** @field huri to the aliased payload */
+    huri: string;
+}
+export interface XyoDomainPayload extends XyoPayload {
+    schema: XyoDomainPayloadSchema;
+    /** @field Values associated with this domain [out] */
+    aliases?: Record<string, XyoAlias>;
+    /** @field Additional config files [huri] [out] */
+    additional?: string[];
+    /** @field Known networks [out] */
+    networks?: XyoNetworkPayload[];
+}
+/** @deprecated use XyoDomainPayload instead */
+export declare type XyoDomainConfig = XyoDomainPayload;
+//# 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,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAEjD,MAAM,WAAW,QAAQ;IACvB,sDAAsD;IACtD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,MAAM,EAAE,sBAAsB,CAAA;IAC9B,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IAClC,kDAAkD;IAClD,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAC/B;AAED,+CAA+C;AAC/C,oBAAY,eAAe,GAAG,gBAAgB,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,5 @@
+import { XyoPayloadPluginFunc } from '@xyo-network/payload-plugin';
+import { XyoDomainPayload } from './Payload';
+import { XyoDomainPayloadSchema } from './Schema';
+export declare const XyoDomainPayloadPlugin: XyoPayloadPluginFunc<XyoDomainPayloadSchema, XyoDomainPayload>;
+//# 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":"AAEA,OAAO,EAA0B,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAE1F,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAIjD,eAAO,MAAM,sBAAsB,EAAE,oBAAoB,CAAC,sBAAsB,EAAE,gBAAgB,CAU9F,CAAA"}

package/dist/esm/Plugin.js

@@ -0,0 +1,16 @@
+import { assertEx } from '@xylabs/sdk-js';
+import { createXyoPayloadPlugin } from '@xyo-network/payload-plugin';
+import { XyoDomainPayloadSchema } from './Schema';
+import { XyoDomainWitness } from './Witness';
+import { XyoDomainPayloadWrapper } from './Wrapper';
+export const XyoDomainPayloadPlugin = () => createXyoPayloadPlugin({
+    schema: XyoDomainPayloadSchema,
+    witness: () => {
+        return new XyoDomainWitness();
+    },
+    wrap: (payload) => {
+        assertEx(payload.schema === XyoDomainPayloadSchema);
+        return new XyoDomainPayloadWrapper(payload);
+    },
+});
+//# 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,gBAAgB,CAAA;AAEzC,OAAO,EAAE,sBAAsB,EAAwB,MAAM,6BAA6B,CAAA;AAG1F,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AAEnD,MAAM,CAAC,MAAM,sBAAsB,GAAmE,GAAG,EAAE,CACzG,sBAAsB,CAAC;IACrB,MAAM,EAAE,sBAAsB;IAC9B,OAAO,EAAE,GAAqB,EAAE;QAC9B,OAAO,IAAI,gBAAgB,EAAE,CAAA;IAC/B,CAAC;IACD,IAAI,EAAE,CAAC,OAAmB,EAA2B,EAAE;QACrD,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,sBAAsB,CAAC,CAAA;QACnD,OAAO,IAAI,uBAAuB,CAAC,OAA2B,CAAC,CAAA;IACjE,CAAC;CACF,CAAC,CAAA"}

package/dist/esm/Schema.d.ts

@@ -0,0 +1,3 @@
+export declare type XyoDomainPayloadSchema = 'network.xyo.domain';
+export declare const XyoDomainPayloadSchema: XyoDomainPayloadSchema;
+//# 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,sBAAsB,GAAG,oBAAoB,CAAA;AACzD,eAAO,MAAM,sBAAsB,EAAE,sBAA6C,CAAA"}

package/dist/esm/Schema.js

@@ -0,0 +1,2 @@
+export const XyoDomainPayloadSchema = 'network.xyo.domain';
+//# 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,sBAAsB,GAA2B,oBAAoB,CAAA"}

package/dist/esm/Template.d.ts

@@ -0,0 +1,3 @@
+import { XyoDomainPayload } from './Payload';
+export declare const domainConfigTemplate: () => XyoDomainPayload;
+//# 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,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAE5C,eAAO,MAAM,oBAAoB,QAAO,gBAuBtC,CAAA"}

package/dist/esm/Template.js

@@ -0,0 +1,25 @@
+export const domainConfigTemplate = () => ({
+    aliases: {
+        'com.example.id': {
+            huri: '',
+        },
+    },
+    networks: [
+        {
+            name: '',
+            nodes: [
+                {
+                    name: '',
+                    schema: 'network.xyo.node',
+                    slug: '',
+                    type: 'archivist',
+                    uri: '',
+                },
+            ],
+            schema: 'network.xyo.network',
+            slug: '',
+        },
+    ],
+    schema: 'network.xyo.domain',
+});
+//# 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":"AAEA,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAqB,EAAE,CAAC,CAAC;IAC3D,OAAO,EAAE;QACP,gBAAgB,EAAE;YAChB,IAAI,EAAE,EAAE;SACT;KACF;IACD,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,EAAE;YACR,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,EAAE;oBACR,MAAM,EAAE,kBAAkB;oBAC1B,IAAI,EAAE,EAAE;oBACR,IAAI,EAAE,WAAW;oBACjB,GAAG,EAAE,EAAE;iBACR;aACF;YACD,MAAM,EAAE,qBAAqB;YAC7B,IAAI,EAAE,EAAE;SACT;KACF;IACD,MAAM,EAAE,oBAAoB;CAC7B,CAAC,CAAA"}

package/dist/esm/Witness.d.ts

@@ -0,0 +1,11 @@
+import { XyoSimpleWitness } from '@xyo-network/witness';
+import { XyoDomainPayload } from './Payload';
+export declare class XyoDomainWitness extends XyoSimpleWitness<XyoDomainPayload> {
+    static dmarc: string;
+    constructor();
+    static generateDmarc(domain: string): string;
+}
+/** @deprecated use XyoDomainWitness instead */
+export declare class XyoDomainConfigWitness extends XyoDomainWitness {
+}
+//# 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,EAAE,MAAM,sBAAsB,CAAA;AAEvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAK5C,qBAAa,gBAAiB,SAAQ,gBAAgB,CAAC,gBAAgB,CAAC;IACtE,OAAc,KAAK,SAAS;;WASd,aAAa,CAAC,MAAM,EAAE,MAAM;CAG3C;AAED,+CAA+C;AAC/C,qBAAa,sBAAuB,SAAQ,gBAAgB;CAAG"}

package/dist/esm/Witness.js

@@ -0,0 +1,19 @@
+import { XyoSimpleWitness } from '@xyo-network/witness';
+import { domainConfigTemplate } from './Template';
+const template = domainConfigTemplate();
+export class XyoDomainWitness extends XyoSimpleWitness {
+    static dmarc = '_xyo';
+    constructor() {
+        super({
+            schema: template.schema,
+            template,
+        });
+    }
+    static generateDmarc(domain) {
+        return `${XyoDomainWitness.dmarc}.${domain}`;
+    }
+}
+/** @deprecated use XyoDomainWitness instead */
+export class XyoDomainConfigWitness extends XyoDomainWitness {
+}
+//# 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,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAGvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAEjD,MAAM,QAAQ,GAAG,oBAAoB,EAAE,CAAA;AAEvC,MAAM,OAAO,gBAAiB,SAAQ,gBAAkC;IAC/D,MAAM,CAAC,KAAK,GAAG,MAAM,CAAA;IAE5B;QACE,KAAK,CAAC;YACJ,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,QAAQ;SACT,CAAC,CAAA;IACJ,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,MAAc;QACxC,OAAO,GAAG,gBAAgB,CAAC,KAAK,IAAI,MAAM,EAAE,CAAA;IAC9C,CAAC;;AAGH,+CAA+C;AAC/C,MAAM,OAAO,sBAAuB,SAAQ,gBAAgB;CAAG"}

package/dist/esm/Wrapper.d.ts

@@ -0,0 +1,21 @@
+import { XyoFetchedPayload, XyoPayloadWrapper } from '@xyo-network/payload';
+import { XyoAlias, XyoDomainPayload } from './Payload';
+export interface XyoFetchedAlias extends XyoFetchedPayload {
+    alias: XyoAlias;
+}
+export declare class XyoDomainPayloadWrapper<T extends XyoDomainPayload = XyoDomainPayload> extends XyoPayloadWrapper<T> {
+    aliases?: XyoFetchedAlias[] | null;
+    private getNetwork;
+    private findArchivistUri;
+    private fetchAlias;
+    fetchAliases(networkSlug?: string): Promise<void>;
+    fetch(networkSlug?: string): Promise<void>;
+    static discoverRootFileWithProxy(domain: string, proxy?: string): Promise<XyoDomainPayloadWrapper<XyoDomainPayload> | undefined>;
+    static discoverRootFileDirect(domain: string): Promise<XyoDomainPayloadWrapper<XyoDomainPayload> | undefined>;
+    static discoverRootFile(domain: string, proxy?: string): Promise<XyoDomainPayloadWrapper<XyoDomainPayload> | undefined>;
+    static discoverDNSEntry(domain: string): Promise<XyoDomainPayloadWrapper<XyoDomainPayload> | undefined>;
+    static discover(reverseDomainName: string, proxy?: string): Promise<XyoDomainPayloadWrapper<XyoDomainPayload> | undefined>;
+}
+/** @deprecated use XyoDomainPayloadWrapper instead */
+export declare type XyoDomainConfigWrapper = XyoDomainPayloadWrapper;
+//# sourceMappingURL=Wrapper.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Wrapper.d.ts","sourceRoot":"","sources":["../../src/Wrapper.ts"],"names":[],"mappings":"AAGA,OAAO,EAAqB,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAI9F,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAEtD,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACxD,KAAK,EAAE,QAAQ,CAAA;CAChB;AAED,qBAAa,uBAAuB,CAAC,CAAC,SAAS,gBAAgB,GAAG,gBAAgB,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IACvG,OAAO,CAAC,EAAE,eAAe,EAAE,GAAG,IAAI,CAAA;IAEzC,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,gBAAgB;YAIV,UAAU;IAMX,YAAY,CAAC,WAAW,CAAC,EAAE,MAAM;IAgBjC,KAAK,CAAC,WAAW,CAAC,EAAE,MAAM;WAInB,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,SAA6C;WAW5F,sBAAsB,CAAC,MAAM,EAAE,MAAM;WASrC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;WAI/C,gBAAgB,CAAC,MAAM,EAAE,MAAM;WAe/B,QAAQ,CAAC,iBAAiB,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;CAOvE;AAED,sDAAsD;AACtD,oBAAY,sBAAsB,GAAG,uBAAuB,CAAA"}

package/dist/esm/Wrapper.js

@@ -0,0 +1,80 @@
+import { DnsRecordType, domainResolve, isBrowser } from '@xyo-network/core';
+import { XyoNetworkPayloadWrapper } from '@xyo-network/network';
+import { Huri, XyoPayloadWrapper } from '@xyo-network/payload';
+import axios from 'axios';
+import reverse from 'lodash/reverse';
+export class XyoDomainPayloadWrapper extends XyoPayloadWrapper {
+    aliases;
+    getNetwork(hash) {
+        return hash ? this.payload.networks?.find((value) => new XyoNetworkPayloadWrapper(value).hash === hash) : this.payload.networks?.[0];
+    }
+    findArchivistUri(hash) {
+        return this.getNetwork(hash)?.nodes?.find((payload) => (payload.type === 'archivist' ? payload : undefined))?.uri;
+    }
+    async fetchAlias(alias, huriOptions) {
+        const huri = new Huri(alias.huri, huriOptions);
+        const payload = await huri.fetch();
+        return payload ? { alias, huri, payload: payload } : null;
+    }
+    async fetchAliases(networkSlug) {
+        //set it to null to signify fetch ran
+        this.aliases = null;
+        const archivistUri = this.findArchivistUri(networkSlug);
+        if (this.payload.aliases) {
+            const fetchedAliases = await Promise.all(Object.entries(this.payload.aliases ?? {}).map(([, alias]) => {
+                return this.fetchAlias(alias, { archivistUri });
+            }));
+            //cast to XyoFetchedPayload[] after we filter out any null/undefined entries
+            this.aliases = fetchedAliases.filter((alias) => alias);
+        }
+    }
+    async fetch(networkSlug) {
+        await this.fetchAliases(networkSlug);
+    }
+    static async discoverRootFileWithProxy(domain, proxy = 'https://api.archivist.xyo.network/domain') {
+        try {
+            const requestUrl = `${proxy}/${domain.split('.').reverse().join('.')}`;
+            const config = (await axios.get(requestUrl)).data.data;
+            return new XyoDomainPayloadWrapper(config);
+        }
+        catch (ex) {
+            const error = ex;
+            console.log(`XyoDomainConfig root file not found using proxy [${domain}] [${error.code}]`);
+        }
+    }
+    static async discoverRootFileDirect(domain) {
+        try {
+            const config = (await axios.get(`https://${domain}/xyo-config.json`)).data;
+            return new XyoDomainPayloadWrapper(config);
+        }
+        catch (ex) {
+            console.log(`XyoDomainConfig root file not found [${domain}]`);
+        }
+    }
+    static async discoverRootFile(domain, proxy) {
+        return isBrowser() || proxy ? await this.discoverRootFileWithProxy(domain, proxy) : await this.discoverRootFileDirect(domain);
+    }
+    static async discoverDNSEntry(domain) {
+        try {
+            const hash = (await domainResolve(`_xyo.${domain}`, DnsRecordType.TXT))?.Answer?.[0]?.data;
+            if (hash) {
+                const huri = new Huri(hash);
+                const payload = (await huri.fetch());
+                if (payload) {
+                    return new XyoDomainPayloadWrapper(payload);
+                }
+            }
+        }
+        catch (ex) {
+            console.log(`XyoDomainConfig dns reading error entry not found [${domain}]`);
+        }
+    }
+    static async discover(reverseDomainName, proxy) {
+        const parts = reverseDomainName.split('.');
+        for (let i = 2; i <= parts.length; i++) {
+            const domainToCheck = reverse(parts.filter((_, index) => index < i)).join('.');
+            return (await this.discoverDNSEntry(domainToCheck)) ?? (await this.discoverRootFile(domainToCheck, proxy));
+        }
+    }
+}
+//# sourceMappingURL=Wrapper.js.map

package/dist/esm/Wrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Wrapper.js","sourceRoot":"","sources":["../../src/Wrapper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,EAAqB,wBAAwB,EAAE,MAAM,sBAAsB,CAAA;AAClF,OAAO,EAAE,IAAI,EAAkC,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC9F,OAAO,KAAqB,MAAM,OAAO,CAAA;AACzC,OAAO,OAAO,MAAM,gBAAgB,CAAA;AAQpC,MAAM,OAAO,uBAAuE,SAAQ,iBAAoB;IACvG,OAAO,CAA2B;IAEjC,UAAU,CAAC,IAAa;QAC9B,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,wBAAwB,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAA;IACtI,CAAC;IAEO,gBAAgB,CAAC,IAAa;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAA;IACnH,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,KAAe,EAAE,WAAyB;QACjE,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QAC9C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAA;QAClC,OAAO,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;IAC3D,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,WAAoB;QAC5C,qCAAqC;QACrC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QAEnB,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;QACvD,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACxB,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CACtC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE;gBAC3D,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,YAAY,EAAE,CAAC,CAAA;YACjD,CAAC,CAAC,CACH,CAAA;YACD,4EAA4E;YAC5E,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAsB,CAAA;SAC5E;IACH,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,WAAoB;QACrC,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAA;IACtC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,MAAc,EAAE,KAAK,GAAG,0CAA0C;QAC9G,IAAI;YACF,MAAM,UAAU,GAAG,GAAG,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;YACtE,MAAM,MAAM,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,CAAmC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAA;YACxF,OAAO,IAAI,uBAAuB,CAAC,MAAM,CAAC,CAAA;SAC3C;QAAC,OAAO,EAAE,EAAE;YACX,MAAM,KAAK,GAAG,EAAgB,CAAA;YAC9B,OAAO,CAAC,GAAG,CAAC,oDAAoD,MAAM,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,CAAA;SAC3F;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,MAAc;QACvD,IAAI;YACF,MAAM,MAAM,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,CAAmB,WAAW,MAAM,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAA;YAC5F,OAAO,IAAI,uBAAuB,CAAC,MAAM,CAAC,CAAA;SAC3C;QAAC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,GAAG,CAAC,wCAAwC,MAAM,GAAG,CAAC,CAAA;SAC/D;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAc,EAAE,KAAc;QACjE,OAAO,SAAS,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;IAC/H,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAc;QACjD,IAAI;YACF,MAAM,IAAI,GAAG,CAAC,MAAM,aAAa,CAAC,QAAQ,MAAM,EAAE,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAA;YAC1F,IAAI,IAAI,EAAE;gBACR,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAA;gBAC3B,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAqB,CAAA;gBACxD,IAAI,OAAO,EAAE;oBACX,OAAO,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAA;iBAC5C;aACF;SACF;QAAC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,GAAG,CAAC,sDAAsD,MAAM,GAAG,CAAC,CAAA;SAC7E;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,iBAAyB,EAAE,KAAc;QACpE,MAAM,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACtC,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC9E,OAAO,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC,CAAA;SAC3G;IACH,CAAC;CACF"}

package/dist/esm/Wrapper.spec..d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Wrapper.spec..d.ts.map

package/dist/esm/Wrapper.spec..d.ts.map

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

package/dist/esm/Wrapper.spec..js

@@ -0,0 +1,33 @@
+import { XyoDomainPayloadWrapper } from './Wrapper';
+describe('DomainPayloadWrapper', () => {
+    test('Valid-discover', async () => {
+        const wrapper = await XyoDomainPayloadWrapper.discover('network.xyo.domain');
+        expect(wrapper?.payload.schema).toBe('network.xyo.domain');
+        await wrapper?.fetch();
+        expect(wrapper?.aliases?.length).toBe(3);
+        expect(wrapper?.aliases?.[0].huri).toBeDefined();
+    });
+    test('Valid-discover-proxy', async () => {
+        const wrapper = await XyoDomainPayloadWrapper.discover('network.xyo.domain', `${process.env.API_DOMAIN}/domain`);
+        expect(wrapper?.payload.schema).toBe('network.xyo.domain');
+        await wrapper?.fetch();
+        expect(wrapper?.aliases?.length).toBe(3);
+        expect(wrapper?.aliases?.[0].huri).toBeDefined();
+    });
+    test('Invalid-discover-proxy', async () => {
+        const wrapper = await XyoDomainPayloadWrapper.discoverRootFileWithProxy('xyoo.network', `${process.env.API_DOMAIN}/domain`);
+        expect(wrapper?.payload.schema).toBeUndefined();
+    });
+    test('Valid-discover-direct', async () => {
+        const wrapper = await XyoDomainPayloadWrapper.discoverRootFileDirect('xyo.network');
+        expect(wrapper?.payload.schema).toBe('network.xyo.domain');
+        await wrapper?.fetch();
+        expect(wrapper?.aliases?.length).toBe(3);
+        expect(wrapper?.aliases?.[0].huri).toBeDefined();
+    });
+    test('InValid', async () => {
+        const wrapper = await XyoDomainPayloadWrapper.discover('blahblah.blahblah.blahblah');
+        expect(wrapper).toBe(undefined);
+    });
+});
+//# sourceMappingURL=Wrapper.spec..js.map

package/dist/esm/Wrapper.spec..js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Wrapper.spec..js","sourceRoot":"","sources":["../../src/Wrapper.spec..ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AAEnD,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,IAAI,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QAChC,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAA;QAC5E,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;QAC1D,MAAM,OAAO,EAAE,KAAK,EAAE,CAAA;QACtB,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACxC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAA;IAClD,CAAC,CAAC,CAAA;IACF,IAAI,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACtC,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAAC,QAAQ,CAAC,oBAAoB,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,SAAS,CAAC,CAAA;QAChH,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;QAC1D,MAAM,OAAO,EAAE,KAAK,EAAE,CAAA;QACtB,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACxC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAA;IAClD,CAAC,CAAC,CAAA;IACF,IAAI,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAAC,yBAAyB,CAAC,cAAc,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,SAAS,CAAC,CAAA;QAC3H,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAA;IACjD,CAAC,CAAC,CAAA;IACF,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACvC,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAA;QACnF,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;QAC1D,MAAM,OAAO,EAAE,KAAK,EAAE,CAAA;QACtB,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACxC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAA;IAClD,CAAC,CAAC,CAAA;IACF,IAAI,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;QACzB,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAAC,QAAQ,CAAC,4BAA4B,CAAC,CAAA;QACpF,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACjC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/esm/index.d.ts

@@ -1,5 +1,9 @@
-import { XyoDomainPayload } from '@xyo-network/domain';
-import { XyoPayloadPluginFunc } from '@xyo-network/payload-plugin';
-declare const plugin: XyoPayloadPluginFunc<'network.xyo.domain', XyoDomainPayload>;
-export default plugin;
+import { XyoDomainPayloadPlugin } from './Plugin';
+export * from './Payload';
+export * from './Schema';
+export * from './Template';
+export * from './Witness';
+export * from './Wrapper';
+export { XyoDomainPayloadPlugin };
+export default XyoDomainPayloadPlugin;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAoB,MAAM,qBAAqB,CAAA;AACxE,OAAO,EAA0B,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AAE1F,QAAA,MAAM,MAAM,EAAE,oBAAoB,CAAC,oBAAoB,EAAE,gBAAgB,CAMrE,CAAA;AAGJ,eAAe,MAAM,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAEjD,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,sBAAsB,EAAE,CAAA;AAGjC,eAAe,sBAAsB,CAAA"}

package/dist/esm/index.js

@@ -1,11 +1,10 @@
-import { XyoDomainWitness } from '@xyo-network/domain';
-import { createXyoPayloadPlugin } from '@xyo-network/payload-plugin';
-const plugin = () => createXyoPayloadPlugin({
-    schema: 'network.xyo.domain',
-    witness: () => {
-        return new XyoDomainWitness();
-    },
-});
+import { XyoDomainPayloadPlugin } from './Plugin';
+export * from './Payload';
+export * from './Schema';
+export * from './Template';
+export * from './Witness';
+export * from './Wrapper';
+export { XyoDomainPayloadPlugin };
 // eslint-disable-next-line import/no-default-export
-export default plugin;
+export default XyoDomainPayloadPlugin;
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACxE,OAAO,EAAE,sBAAsB,EAAwB,MAAM,6BAA6B,CAAA;AAE1F,MAAM,MAAM,GAAiE,GAAG,EAAE,CAChF,sBAAsB,CAAC;IACrB,MAAM,EAAE,oBAAoB;IAC5B,OAAO,EAAE,GAAqB,EAAE;QAC9B,OAAO,IAAI,gBAAgB,EAAE,CAAA;IAC/B,CAAC;CACF,CAAC,CAAA;AAEJ,oDAAoD;AACpD,eAAe,MAAM,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAEjD,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,sBAAsB,EAAE,CAAA;AAEjC,oDAAoD;AACpD,eAAe,sBAAsB,CAAA"}

package/package.json

@@ -10,11 +10,19 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/domain": "^2.23.3",
-    "@xyo-network/payload": "^2.23.3",
-    "@xyo-network/payload-plugin": "^2.23.3"
+    "@xylabs/sdk-js": "^2.6.3",
+    "@xyo-network/api": "^2.24.0",
+    "@xyo-network/core": "^2.24.0",
+    "@xyo-network/network": "^2.24.0",
+    "@xyo-network/payload": "^2.24.0",
+    "@xyo-network/payload-plugin": "^2.24.0",
+    "@xyo-network/witness": "^2.24.0",
+    "axios": "^0.27.2",
+    "lodash": "^4.17.21",
+    "tslib": "^2.4.0"
   },
   "devDependencies": {
+    "@types/lodash": "^4.14.182",
     "@xylabs/tsconfig": "^2.5.13"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
@@ -50,6 +58,6 @@
   },
   "sideEffects": false,
   "types": "dist/esm/index.d.ts",
-  "version": "2.23.3",
+  "version": "2.24.0",
   "packageManager": "yarn@3.1.1"
 }

package/src/Payload.ts

@@ -0,0 +1,24 @@
+import { XyoNetworkPayload } from '@xyo-network/network'
+import { XyoPayload } from '@xyo-network/payload'
+
+import { XyoDomainPayloadSchema } from './Schema'
+
+export interface XyoAlias {
+  /** @field cononical name (ex. network.xyo.example) */
+  name?: string
+  /** @field huri to the aliased payload */
+  huri: string
+}
+
+export interface XyoDomainPayload extends XyoPayload {
+  schema: XyoDomainPayloadSchema
+  /** @field Values associated with this domain [out] */
+  aliases?: Record<string, XyoAlias>
+  /** @field Additional config files [huri] [out] */
+  additional?: string[]
+  /** @field Known networks [out] */
+  networks?: XyoNetworkPayload[]
+}
+
+/** @deprecated use XyoDomainPayload instead */
+export type XyoDomainConfig = XyoDomainPayload

package/src/Plugin.spec.ts

@@ -0,0 +1,11 @@
+import { XyoPayloadPluginResolver } from '@xyo-network/payload-plugin'
+
+import { XyoDomainPayloadPlugin } from './Plugin'
+import { XyoDomainPayloadSchema } from './Schema'
+
+describe('XyoDomainPayloadPlugin', () => {
+  test('Add to Resolver', () => {
+    const resolver = new XyoPayloadPluginResolver().register(XyoDomainPayloadPlugin())
+    expect(resolver.resolve({ schema: XyoDomainPayloadSchema })).toBeDefined()
+  })
+})

package/src/Plugin.ts

@@ -0,0 +1,20 @@
+import { assertEx } from '@xylabs/sdk-js'
+import { XyoPayload } from '@xyo-network/payload'
+import { createXyoPayloadPlugin, XyoPayloadPluginFunc } from '@xyo-network/payload-plugin'
+
+import { XyoDomainPayload } from './Payload'
+import { XyoDomainPayloadSchema } from './Schema'
+import { XyoDomainWitness } from './Witness'
+import { XyoDomainPayloadWrapper } from './Wrapper'
+
+export const XyoDomainPayloadPlugin: XyoPayloadPluginFunc<XyoDomainPayloadSchema, XyoDomainPayload> = () =>
+  createXyoPayloadPlugin({
+    schema: XyoDomainPayloadSchema,
+    witness: (): XyoDomainWitness => {
+      return new XyoDomainWitness()
+    },
+    wrap: (payload: XyoPayload): XyoDomainPayloadWrapper => {
+      assertEx(payload.schema === XyoDomainPayloadSchema)
+      return new XyoDomainPayloadWrapper(payload as XyoDomainPayload)
+    },
+  })

package/src/Schema.ts

@@ -0,0 +1,2 @@
+export type XyoDomainPayloadSchema = 'network.xyo.domain'
+export const XyoDomainPayloadSchema: XyoDomainPayloadSchema = 'network.xyo.domain'

package/src/Template.ts

@@ -0,0 +1,26 @@
+import { XyoDomainPayload } from './Payload'
+
+export const domainConfigTemplate = (): XyoDomainPayload => ({
+  aliases: {
+    'com.example.id': {
+      huri: '',
+    },
+  },
+  networks: [
+    {
+      name: '',
+      nodes: [
+        {
+          name: '',
+          schema: 'network.xyo.node',
+          slug: '',
+          type: 'archivist',
+          uri: '',
+        },
+      ],
+      schema: 'network.xyo.network',
+      slug: '',
+    },
+  ],
+  schema: 'network.xyo.domain',
+})

package/src/Witness.spec.ts

@@ -0,0 +1,14 @@
+import { XyoDomainWitness } from './Witness'
+
+describe('XyoDomainConfigWitness', () => {
+  test('valid-instantiation', () => {
+    const witness = new XyoDomainWitness()
+    expect(witness).toBeTruthy()
+    expect(witness?.config?.schema).toBe('network.xyo.domain')
+    expect(XyoDomainWitness.dmarc).toBe('_xyo')
+  })
+
+  test('generatesDemarc', () => {
+    expect(XyoDomainWitness.generateDmarc('foo')).toBe('_xyo.foo')
+  })
+})

package/src/Witness.ts

@@ -0,0 +1,24 @@
+import { XyoSimpleWitness } from '@xyo-network/witness'
+
+import { XyoDomainPayload } from './Payload'
+import { domainConfigTemplate } from './Template'
+
+const template = domainConfigTemplate()
+
+export class XyoDomainWitness extends XyoSimpleWitness<XyoDomainPayload> {
+  public static dmarc = '_xyo'
+
+  constructor() {
+    super({
+      schema: template.schema,
+      template,
+    })
+  }
+
+  public static generateDmarc(domain: string) {
+    return `${XyoDomainWitness.dmarc}.${domain}`
+  }
+}
+
+/** @deprecated use XyoDomainWitness instead */
+export class XyoDomainConfigWitness extends XyoDomainWitness {}

package/src/Wrapper.spec..ts

@@ -0,0 +1,33 @@
+import { XyoDomainPayloadWrapper } from './Wrapper'
+
+describe('DomainPayloadWrapper', () => {
+  test('Valid-discover', async () => {
+    const wrapper = await XyoDomainPayloadWrapper.discover('network.xyo.domain')
+    expect(wrapper?.payload.schema).toBe('network.xyo.domain')
+    await wrapper?.fetch()
+    expect(wrapper?.aliases?.length).toBe(3)
+    expect(wrapper?.aliases?.[0].huri).toBeDefined()
+  })
+  test('Valid-discover-proxy', async () => {
+    const wrapper = await XyoDomainPayloadWrapper.discover('network.xyo.domain', `${process.env.API_DOMAIN}/domain`)
+    expect(wrapper?.payload.schema).toBe('network.xyo.domain')
+    await wrapper?.fetch()
+    expect(wrapper?.aliases?.length).toBe(3)
+    expect(wrapper?.aliases?.[0].huri).toBeDefined()
+  })
+  test('Invalid-discover-proxy', async () => {
+    const wrapper = await XyoDomainPayloadWrapper.discoverRootFileWithProxy('xyoo.network', `${process.env.API_DOMAIN}/domain`)
+    expect(wrapper?.payload.schema).toBeUndefined()
+  })
+  test('Valid-discover-direct', async () => {
+    const wrapper = await XyoDomainPayloadWrapper.discoverRootFileDirect('xyo.network')
+    expect(wrapper?.payload.schema).toBe('network.xyo.domain')
+    await wrapper?.fetch()
+    expect(wrapper?.aliases?.length).toBe(3)
+    expect(wrapper?.aliases?.[0].huri).toBeDefined()
+  })
+  test('InValid', async () => {
+    const wrapper = await XyoDomainPayloadWrapper.discover('blahblah.blahblah.blahblah')
+    expect(wrapper).toBe(undefined)
+  })
+})