@xyo-network/domain-payload-plugin 5.3.20 → 5.3.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/domain-payload-plugin",
-  "version": "5.3.20",
+  "version": "5.3.24",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,37 +30,46 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
-    "!**/*.test.*"
+    "!**/*.test.*",
+    "README.md"
   ],
   "dependencies": {
-    "@xyo-network/dns": "~5.3.20",
-    "@xyo-network/huri": "~5.3.20",
-    "@xyo-network/network": "~5.3.20",
-    "@xyo-network/payload-builder": "~5.3.20",
-    "@xyo-network/payload-model": "~5.3.20",
-    "@xyo-network/payload-plugin": "~5.3.20",
-    "@xyo-network/payload-wrapper": "~5.3.20"
+    "@xyo-network/dns": "~5.3.24",
+    "@xyo-network/huri": "~5.3.24",
+    "@xyo-network/network": "~5.3.24",
+    "@xyo-network/payload-model": "~5.3.24",
+    "@xyo-network/payload-builder": "~5.3.24",
+    "@xyo-network/payload-plugin": "~5.3.24",
+    "@xyo-network/payload-wrapper": "~5.3.24"
   },
   "devDependencies": {
-    "@xylabs/sdk-js": "^5.0.90",
-    "@xylabs/ts-scripts-common": "~7.5.6",
-    "@xylabs/ts-scripts-yarn3": "~7.5.6",
-    "@xylabs/tsconfig": "~7.5.6",
-    "@xylabs/vitest-extended": "~5.0.90",
-    "@xyo-network/api-models": "~5.3.20",
-    "axios": "^1.13.6",
+    "@opentelemetry/api": "^1.9.1",
+    "@types/node": "^25.5.0",
+    "@xylabs/sdk-js": "^5.0.93",
+    "@xylabs/ts-scripts-common": "~7.6.16",
+    "@xylabs/ts-scripts-pnpm": "~7.6.16",
+    "@xylabs/tsconfig": "~7.6.16",
+    "@xylabs/vitest-extended": "~5.0.93",
+    "acorn": "^8.16.0",
+    "axios": "^1.14.0",
+    "esbuild": "^0.28.0",
+    "ethers": "^6.16.0",
+    "tslib": "^2.8.1",
     "typescript": "~5.9.3",
+    "vite": "^8.0.3",
     "vitest": "~4.1.2",
-    "zod": "^4.3.6"
+    "zod": "^4.3.6",
+    "@xyo-network/api-models": "~5.3.24"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",
+    "ethers": "^6",
+    "tslib": "^2.8.1",
     "zod": "^4"
   },
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/Payload.ts

@@ -1,22 +0,0 @@
-import type { NetworkPayload } from '@xyo-network/network'
-import { isPayloadOfSchemaType, type Payload } from '@xyo-network/payload-model'
-
-import { DomainSchema } from './Schema.ts'
-
-export interface Alias {
-  /** @field huri to the aliased payload */
-  huri: string
-  /** @field canonical name (ex. network.xyo.example) */
-  name?: string
-}
-
-export type DomainPayload = Payload<{
-  /** @field Additional config files [huri] [out] */
-  additional?: string[]
-  /** @field Values associated with this domain [out] */
-  aliases?: Record<string, Alias>
-  /** @field Known networks [out] */
-  networks?: NetworkPayload[]
-}, DomainSchema>
-
-export const isDomainPayload = isPayloadOfSchemaType<DomainPayload>(DomainSchema)

package/src/Plugin.ts

@@ -1,14 +0,0 @@
-import type { Payload } from '@xyo-network/payload-model'
-import { createPayloadPlugin } from '@xyo-network/payload-plugin'
-
-import type { DomainPayload } from './Payload.ts'
-import { DomainSchema } from './Schema.ts'
-import { domainConfigTemplate } from './Template.ts'
-import { DomainPayloadWrapper } from './Wrapper.ts'
-
-export const DomainPayloadPlugin = () =>
-  createPayloadPlugin<DomainPayload>({
-    schema: DomainSchema,
-    template: domainConfigTemplate,
-    wrap: (payload: Payload) => DomainPayloadWrapper.wrap(payload as DomainPayload),
-  })

package/src/Schema.ts

@@ -1,4 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-export const DomainSchema = asSchema('network.xyo.domain', true)
-export type DomainSchema = typeof DomainSchema

package/src/Template.ts

@@ -1,25 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-import type { DomainPayload } from './Payload.ts'
-import { DomainSchema } from './Schema.ts'
-
-export const domainConfigTemplate = (): DomainPayload => ({
-  aliases: { 'com.example.id': { huri: '' } },
-  networks: [
-    {
-      name: '',
-      nodes: [
-        {
-          name: '',
-          schema: asSchema('network.xyo.network.node', true),
-          slug: '',
-          type: 'archivist',
-          uri: '',
-        },
-      ],
-      schema: asSchema('network.xyo.network', true),
-      slug: '',
-    },
-  ],
-  schema: DomainSchema,
-})

package/src/Wrapper.ts

@@ -1,113 +0,0 @@
-import {
-  axiosJson, Base, isBrowser,
-  isString,
-} from '@xylabs/sdk-js'
-import { type Hash, isHash } from '@xylabs/sdk-js'
-import type { ApiEnvelope } from '@xyo-network/api-models'
-import { DnsRecordType, domainResolve } from '@xyo-network/dns'
-import type { FetchedPayload, HuriOptions } from '@xyo-network/huri'
-import { Huri } from '@xyo-network/huri'
-import type { NetworkPayload } from '@xyo-network/network'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import { PayloadWrapper } from '@xyo-network/payload-wrapper'
-import type { AxiosError } from 'axios'
-
-import {
-  type Alias, type DomainPayload, isDomainPayload,
-} from './Payload.ts'
-
-export interface FetchedAlias extends FetchedPayload {
-  alias: Alias
-}
-
-export class DomainPayloadWrapper<T extends DomainPayload = DomainPayload> extends PayloadWrapper<T> {
-  aliases?: FetchedAlias[] | null
-
-  static async discover(reverseDomainName: string, proxy?: string) {
-    const parts = reverseDomainName.split('.')
-    for (let i = 2; i <= parts.length; i++) {
-      const domainToCheck = parts.filter((_, index) => index < i).toReversed().join('.')
-      const result = (await this.discoverDNSEntry(domainToCheck)) ?? (await this.discoverRootFile(domainToCheck, proxy))
-      if (result) {
-        return result
-      }
-    }
-  }
-
-  static async discoverDNSEntry(domain: string) {
-    try {
-      const hash = (await domainResolve(`_xyo.${domain}`, DnsRecordType.TXT))?.Answer?.[0]?.data
-      if (isHash(hash)) {
-        const huri = new Huri(hash)
-        const payload = (await huri.fetch())
-        if (isDomainPayload(payload)) {
-          return new DomainPayloadWrapper(payload)
-        }
-      }
-    } catch {
-      Base.defaultLogger?.log(`DomainConfig dns reading error entry not found [${domain}]`)
-    }
-  }
-
-  static async discoverRootFile(domain: string, proxy?: string) {
-    return isBrowser() || isString(proxy) ? await this.discoverRootFileWithProxy(domain, proxy) : await this.discoverRootFileDirect(domain)
-  }
-
-  static async discoverRootFileDirect(domain: string) {
-    try {
-      const config = (await axiosJson.get<DomainPayload>(`https://${domain}/xyo-config.json`)).data
-      return new DomainPayloadWrapper(config)
-    } catch {
-      console.log(`DomainConfig root file not found [${domain}]`)
-    }
-  }
-
-  static async discoverRootFileWithProxy(domain: string, proxy = 'https://api.archivist.xyo.network/domain') {
-    try {
-      const requestUrl = `${proxy}/${domain.split('.').toReversed().join('.')}`
-      const config = (await axiosJson.get<ApiEnvelope<DomainPayload>>(requestUrl)).data.data
-      return new DomainPayloadWrapper(config)
-    } catch (ex) {
-      const error = ex as AxiosError
-      console.log(`DomainConfig root file not found using proxy [${domain}] [${error.code}]`)
-    }
-  }
-
-  async fetch(networkSlug?: Hash) {
-    await this.fetchAliases(networkSlug)
-  }
-
-  async fetchAliases(networkSlug?: Hash) {
-    // set it to null to signify fetch ran
-    this.aliases = null
-
-    const archivistUri = await 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 FetchedPayload[] after we filter out any null/undefined entries
-      this.aliases = fetchedAliases.filter(Boolean) as FetchedAlias[]
-    }
-  }
-
-  private async fetchAlias(alias: Alias, huriOptions?: HuriOptions): Promise<FetchedAlias | null> {
-    const huri = new Huri(alias.huri, huriOptions)
-    const payload = await huri.fetch()
-    return payload
-      ? {
-          alias, huri, payload: payload,
-        }
-      : null
-  }
-
-  private async findArchivistUri(hash?: Hash): Promise<string | undefined> {
-    return (await this.getNetwork(hash))?.nodes?.find(payload => (payload.type === 'archivist' ? payload : undefined))?.uri
-  }
-
-  private async getNetwork(hash?: Hash): Promise<NetworkPayload | undefined> {
-    return isHash(hash) ? await PayloadBuilder.findByDataHash(this.payload.networks, hash) : this.payload.networks?.[0]
-  }
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from './Payload.ts'
-export { DomainPayloadPlugin as default, DomainPayloadPlugin } from './Plugin.ts'
-export * from './Schema.ts'
-export * from './Template.ts'
-export * from './Wrapper.ts'

package/src/schemadef.json

@@ -1,115 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "additionalProperties": false,
-  "definitions": {
-    "alias": {
-      "additionalProperties": false,
-      "properties": {
-        "huri": {
-          "type": "string"
-        },
-        "name": {
-          "type": "string"
-        }
-      },
-      "required": [
-        "name",
-        "huri"
-      ],
-      "type": "object"
-    },
-    "network": {
-      "additionalProperties": false,
-      "properties": {
-        "name": {
-          "type": "string"
-        },
-        "nodes": {
-          "items": {
-            "$ref": "#/definitions/node"
-          },
-          "type": "array"
-        },
-        "slug": {
-          "type": "string"
-        }
-      },
-      "required": [
-        "slug"
-      ],
-      "type": "object"
-    },
-    "node": {
-      "additionalProperties": false,
-      "properties": {
-        "name": {
-          "type": "string"
-        },
-        "slug": {
-          "type": "string"
-        },
-        "type": {
-          "$ref": "#/definitions/node_type"
-        },
-        "uri": {
-          "type": "string"
-        }
-      },
-      "required": [
-        "slug",
-        "type"
-      ],
-      "type": "object"
-    },
-    "node_type": {
-      "enum": [
-        "sentinel",
-        "bridge",
-        "archivist",
-        "diviner"
-      ],
-      "type": "string"
-    }
-  },
-  "properties": {
-    "additional": {
-      "description": "List of HURIs to additional configs for this domain",
-      "items": {
-        "type": "string"
-      },
-      "nullable": false,
-      "type": "array"
-    },
-    "aliases": {
-      "description": "List of HURIs to that are officially defined by this domain",
-      "items": {
-        "type": "string"
-      },
-      "nullable": false,
-      "type": "array"
-    },
-    "domain": {
-      "description": "The name of the domain that this config applies to",
-      "nullable": false,
-      "type": "string"
-    },
-    "networks": {
-      "description": "List of networks that this domain participates in",
-      "items": {
-        "$ref": "#/definitions/network"
-      },
-      "nullable": false,
-      "type": "array"
-    },
-    "schema": {
-      "description": "The schema name (must be network.xyo.domain)",
-      "nullable": false,
-      "pattern": "/^network.xyo.domain$/",
-      "type": "string"
-    }
-  },
-  "required": [
-    "domain",
-    "schema"
-  ]
-}