@xyo-network/payload 2.21.11

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

@@ -0,0 +1 @@
+{"version":3,"file":"Wrapper.js","sourceRoot":"","sources":["../../../src/Wrapper/Wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAe,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAE9G,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAG9B,MAAM,OAAO,iBAAwC,SAAQ,SAAY;IACvE,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,GAAG,CAAA;IACjB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,wBAAwB,CAAI,IAAI,CAAC,GAAG,CAAC,CAAA;IAC9C,CAAC;IAED,IAAW,IAAI;QACb,OAAO,wBAAwB,CAAI,IAAI,CAAC,GAAG,CAAC,CAAA;IAC9C,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAA2B;QAClD,MAAM,OAAO,GAAG,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAA;QAC/C,IAAI,OAAO,EAAE;YACX,OAAO,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAA;SACtC;IACH,CAAC;CACF"}

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

@@ -0,0 +1,2 @@
+export * from './Validator';
+export * from './Wrapper';

package/dist/esm/Wrapper/index.js

@@ -0,0 +1,3 @@
+export * from './Validator';
+export * from './Wrapper';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Wrapper/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA"}

package/dist/esm/index.d.ts

@@ -0,0 +1,9 @@
+export * from './Builder';
+export * from './Huri';
+export * from './isXyoPayloadOfSchemaType';
+export * from './models';
+export * from './Query';
+export * from './Schema';
+export * from './SchemaNameValidator';
+export * from './Validator';
+export * from './Wrapper';

package/dist/esm/index.js

@@ -0,0 +1,10 @@
+export * from './Builder';
+export * from './Huri';
+export * from './isXyoPayloadOfSchemaType';
+export * from './models';
+export * from './Query';
+export * from './Schema';
+export * from './SchemaNameValidator';
+export * from './Validator';
+export * from './Wrapper';
+//# 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,cAAc,WAAW,CAAA;AACzB,cAAc,QAAQ,CAAA;AACtB,cAAc,4BAA4B,CAAA;AAC1C,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,uBAAuB,CAAA;AACrC,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA"}

package/dist/esm/isXyoPayloadOfSchemaType.d.ts

@@ -0,0 +1,4 @@
+import { XyoPayload } from './models';
+import { XyoSchemaPayload } from './Schema';
+export declare const isXyoPayloadOfSchemaType: <T extends XyoPayload<object>>(schema: string) => (x: XyoPayload) => x is T;
+export declare const isXyoSchemaPayload: (x: XyoPayload) => x is XyoSchemaPayload;

package/dist/esm/isXyoPayloadOfSchemaType.js

@@ -0,0 +1,5 @@
+export const isXyoPayloadOfSchemaType = (schema) => {
+    return (x) => x.schema === schema;
+};
+export const isXyoSchemaPayload = isXyoPayloadOfSchemaType('network.xyo.schema');
+//# sourceMappingURL=isXyoPayloadOfSchemaType.js.map

package/dist/esm/isXyoPayloadOfSchemaType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isXyoPayloadOfSchemaType.js","sourceRoot":"","sources":["../../src/isXyoPayloadOfSchemaType.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAuB,MAAc,EAAE,EAAE;IAC/E,OAAO,CAAC,CAAa,EAAU,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAA;AACvD,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,wBAAwB,CAAmB,oBAAoB,CAAC,CAAA"}

package/dist/esm/models/Base.d.ts

@@ -0,0 +1,6 @@
+export interface XyoPayloadBase {
+    schema: string;
+    previousHash?: string;
+    sources?: string[];
+    timestamp?: number;
+}

package/dist/esm/models/Base.js

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

package/dist/esm/models/Base.js.map

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

package/dist/esm/models/Meta.d.ts

@@ -0,0 +1,24 @@
+import { XyoPayloadBase } from './Base';
+import { XyoPayload } from './XyoPayload';
+export interface XyoPayloadMetaBase {
+    _hash: string;
+    _observeDuration?: number;
+    _archive: string;
+    _client?: string;
+    _reportedHash?: string;
+    _timestamp: number;
+    _sources?: XyoPayload[];
+    _user_agent?: string;
+    _schemaValid?: boolean;
+}
+export interface XyoQueryPayloadMetaBase extends XyoPayloadMetaBase {
+    _queryId: string;
+}
+export declare type XyoPayloadMeta<T = unknown> = T & XyoPayloadMetaBase;
+export declare type XyoPartialPayloadMeta<T = unknown> = T & Partial<XyoPayloadMetaBase>;
+export declare type XyoPayloadWithMeta<T = unknown> = T & XyoPayloadMetaBase & XyoPayloadBase;
+export declare type XyoPayloadWithPartialMeta<T = unknown> = T & Partial<XyoPayloadMetaBase> & XyoPayloadBase;
+export declare type XyoQueryPayloadMeta<T = unknown> = T & XyoQueryPayloadMetaBase;
+export declare type XyoQueryPartialPayloadMeta<T = unknown> = T & Partial<XyoQueryPayloadMetaBase>;
+export declare type XyoQueryPayloadWithMeta<T = unknown> = T & XyoQueryPayloadMetaBase & XyoPayloadBase;
+export declare type XyoQueryPayloadWithPartialMeta<T = unknown> = T & Partial<XyoQueryPayloadMetaBase> & XyoPayloadBase;

package/dist/esm/models/Meta.js

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

package/dist/esm/models/Meta.js.map

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

package/dist/esm/models/XyoPayload.d.ts

@@ -0,0 +1,2 @@
+import { XyoPayloadBase } from './Base';
+export declare type XyoPayload<T extends object = object> = T & XyoPayloadBase;

package/dist/esm/models/XyoPayload.js

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

package/dist/esm/models/XyoPayload.js.map

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

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

@@ -0,0 +1,3 @@
+export * from './Base';
+export * from './Meta';
+export * from './XyoPayload';

package/dist/esm/models/index.js

@@ -0,0 +1,4 @@
+export * from './Base';
+export * from './Meta';
+export * from './XyoPayload';
+//# sourceMappingURL=index.js.map

package/dist/esm/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,cAAc,CAAA"}

package/jest.config.cjs

@@ -0,0 +1,25 @@
+const generateJestConfig = ({ esModules }) => {
+  const esModuleslist = Array.isArray(esModules) ? esModules.join('|') : esModules
+  return {
+    globals: {
+      'ts-jest': {
+        tsconfig: 'tsconfig.test.json',
+      },
+    },
+    moduleNameMapper: {
+      '^(\\.{1,2}/.*)\\.js$': '$1',
+    },
+    preset: 'ts-jest/presets/default-esm',
+    setupFiles: ['dotenv/config'],
+    setupFilesAfterEnv: ['jest-sorted'],
+    testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
+    testTimeout: 20000,
+    transform: {
+      [`(${esModuleslist}).+\\.js$`]: 'babel-jest',
+      '^.+\\.tsx?$': 'ts-jest/legacy',
+    },
+    transformIgnorePatterns: [`./node_modules/(?!${esModuleslist})`],
+  }
+}
+
+module.exports = generateJestConfig({ esModules: ['is-ip', 'ip-regex', 'lodash-es', 'uuid'] })

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@xyo-network/payload",
+  "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": {
+    "@xylabs/sdk-js": "^2.5.9",
+    "@xyo-network/account": "^2.21.11",
+    "@xyo-network/core": "^2.21.11",
+    "axios": "^0.27.2"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "devDependencies": {
+    "tslib": "^2.4.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": true,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.21.11",
+  "packageManager": "yarn@3.1.1"
+}

package/src/Builder/Builder.spec.ts

@@ -0,0 +1,37 @@
+import { XyoPayloadBuilder } from './Builder'
+
+const schema = 'network.xyo.temp'
+
+const payloadHash = '57b78b1b7df3ac0369654642e879cdf2f3c95f9c5949bcb34ea3cb8309c538b4'
+
+const ADDITIONAL_FIELD_COUNT = 4
+
+describe('XyoBoundWitnessBuilder', () => {
+  test('build', () => {
+    let builder = new XyoPayloadBuilder({ schema })
+    expect(builder).toBeDefined()
+    builder = builder.fields({
+      testArray: [1, 2, 3],
+      testBoolean: true,
+      testNull: null,
+      testNullObject: { t: null, x: undefined },
+      testNumber: 5,
+      testObject: { t: 1 },
+      testSomeNullObject: { s: 1, t: null, x: undefined },
+      testString: 'hi',
+      testUndefined: undefined,
+    })
+    expect(builder).toBeDefined()
+
+    const actual = builder.build()
+
+    expect(actual).toBeDefined()
+    expect(actual._timestamp).toBeDefined()
+    expect(actual._client).toBeDefined()
+    expect(actual._hash).toBeDefined()
+    expect(actual.schema).toBeDefined()
+    expect(Object.keys(actual).length).toBe(8 + ADDITIONAL_FIELD_COUNT)
+    expect(Object.keys(actual.testSomeNullObject as object).length).toBe(2)
+    expect(actual._hash).toEqual(payloadHash)
+  })
+})

package/src/Builder/Builder.ts

@@ -0,0 +1,43 @@
+import { deepOmitUnderscoreFields, removeEmptyFields, StringKeyObject, XyoHasher } from '@xyo-network/core'
+
+import { XyoPayload } from '../models'
+
+export interface XyoPayloadBuilderOptions {
+  schema: string
+}
+
+export class XyoPayloadBuilder<T extends XyoPayload = XyoPayload<StringKeyObject>> {
+  private _fields: Partial<T> = {}
+  private _previousHash?: string
+  private _schema: string
+
+  constructor({ schema }: XyoPayloadBuilderOptions) {
+    this._schema = schema
+  }
+
+  public fields(fields?: Partial<T>) {
+    if (fields) {
+      this._fields = { ...this._fields, ...removeEmptyFields(fields) }
+    }
+    return this
+  }
+
+  public previousHash(hash?: string) {
+    this._previousHash = hash
+    return this
+  }
+
+  public hashableFields() {
+    return {
+      ...removeEmptyFields(deepOmitUnderscoreFields({ ...this._fields, previousHash: this._previousHash })),
+      schema: this._schema,
+    } as T
+  }
+
+  public build(): T {
+    const hashableFields = this.hashableFields()
+    const _hash = new XyoHasher(hashableFields).hash
+    const _timestamp = Date.now()
+    return { ...hashableFields, _client: 'js', _hash, _timestamp, schema: this._schema }
+  }
+}

package/src/Builder/index.ts

@@ -0,0 +1 @@
+export * from './Builder'

package/src/Huri/Huri.spec.ts

@@ -0,0 +1,92 @@
+import { delay } from '@xylabs/sdk-js'
+
+import { XyoPayload } from '../models'
+import { Huri } from './Huri'
+
+const hash = 'fb3606d71dcdd49a0aacc9d234e412684d577803c8a9ed9399a9d3776cc88e24'
+
+const valid = [
+  `https://${hash}`,
+  `https://api.archivist.xyo.network/temp/${hash}`,
+  `https://api.archivist.xyo.network/${hash}`,
+  `http://api.archivist.xyo.network/${hash}`,
+  `/api.archivist.xyo.network/${hash}`,
+  `//${hash}`,
+  `/${hash}`,
+  `${hash}`,
+]
+
+const validWithTempArchive = [
+  `https://api.archivist.xyo.network/temp/${hash}`,
+  `https://api.archivist.xyo.network/temp/${hash}`,
+  `http://api.archivist.xyo.network/temp/${hash}`,
+  `/api.archivist.xyo.network/temp/${hash}`,
+]
+
+const invalid = [`https:///api.archivist.xyo.network/${hash}`, `https://api.archivist.xyo.network//${hash}`]
+
+describe('Huri', () => {
+  describe('Valid Items', () => {
+    valid.map((item) => {
+      test(`valid [${item}]`, () => {
+        try {
+          const huri = new Huri(item)
+          expect(huri.hash).toBe(hash)
+        } catch (ex) {
+          console.error(`Valid Huri failed: [${item}]`)
+          console.error(ex)
+        }
+      })
+    })
+  })
+  describe('Valid Items w/archive', () => {
+    validWithTempArchive.map((item) => {
+      test(`valid w/archive [${item}]`, () => {
+        try {
+          const huri = new Huri(item)
+          expect(huri.hash).toBe(hash)
+          expect(huri.archive).toBe('temp')
+        } catch (ex) {
+          console.error(`Valid Huri w/archive failed: [${item}]`)
+          console.error(ex)
+        }
+      })
+    })
+  })
+  describe('Invalid Items', () => {
+    invalid.map((item) => {
+      test(`invalid [${item}]`, () => {
+        expect(() => new Huri(item)).toThrowError()
+      })
+    })
+  })
+  describe('Api Fetch', () => {
+    it('Valid Huri', async () => {
+      const huri = new Huri('https://beta.api.archivist.xyo.network/18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653057')
+      const result = await huri.fetch()
+      expect(result?.schema).toBe('network.xyo.schema')
+    })
+    it('Invalid Huri', async () => {
+      const huri = new Huri('https://beta.api.archivist.xyo.network/18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653bad')
+      await expect(huri.fetch()).rejects.toThrow()
+    })
+  })
+  describe('Fetch Override', () => {
+    invalid.map((item) => {
+      test(`invalid [${item}]`, async () => {
+        const oldFetch = Huri.fetch
+        Huri.fetch = async (huri: Huri) => {
+          await delay(0)
+          const payload: XyoPayload = {
+            schema: huri.hash,
+          }
+          return payload
+        }
+        const huri = new Huri('https://beta.api.archivist.xyo.network/18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653057')
+        const result = await huri.fetch()
+        Huri.fetch = oldFetch
+        expect(result?.schema).toBe('18f97b3e85f5bede65e7c0a85d74aee896de58ead8bc4b1b3d7300646c653057')
+      })
+    })
+  })
+})

package/src/Huri/Huri.ts

@@ -0,0 +1,155 @@
+import { assertEx } from '@xylabs/sdk-js'
+import { XyoAddressValue } from '@xyo-network/account'
+import { XyoDataLike } from '@xyo-network/core'
+import axios from 'axios'
+
+import { XyoPayload } from '../models'
+
+export type XyoObjectCategory = 'block' | 'payload'
+
+export type HuriFetchFunction = (huri: Huri) => Promise<XyoPayload | undefined>
+
+/* 
+  Valid Huri:
+
+  [<protocol>://][<archivist>/[<archive>/]]<hash>
+
+  defaults:
+    protocol: https
+    archivist: api.archivist.xyo.network
+*/
+
+export interface HuriOptions {
+  archivistUri?: string
+}
+
+export interface XyoFetchedPayload<T extends XyoPayload = XyoPayload> {
+  payload: T
+  huri?: Huri
+}
+
+export class Huri {
+  public originalHref: string
+  public protocol?: string
+  public archivist?: string
+  public archive?: string
+  public hash: string
+
+  private isHuri = true
+
+  constructor(huri: XyoDataLike | Huri, { archivistUri }: HuriOptions = {}) {
+    const huriString = Huri.isHuri(huri)?.href ?? typeof huri === 'string' ? (huri as string) : new XyoAddressValue(huri as XyoDataLike).hex
+    this.originalHref = huriString
+
+    const protocol = Huri.parseProtocol(huriString)
+    this.protocol = protocol ?? 'https'
+
+    const path = assertEx(Huri.parsePath(huriString), 'Missing path')
+    this.hash = this.parsePath(path, protocol !== undefined)
+
+    //if archivistUri sent, overwrite protocol and archivist
+    if (archivistUri) {
+      const archivistUriParts = archivistUri.split('://')
+      this.protocol = archivistUriParts[0]
+      this.archivist = archivistUriParts[1]
+    }
+
+    this.validateParse()
+  }
+
+  private parsePath(path: string, hasProtocol: boolean) {
+    const pathParts = path.split('/')
+
+    //if the protocal was found, then there is not allowed to be a leading /
+    assertEx(!(hasProtocol && pathParts[0].length === 0), 'Invalid protocol seperator')
+
+    //remove leading '/' if needed
+    pathParts[0].length === 0 ? pathParts.shift() : null
+
+    //hash is assumed to be the last part
+    const hash = assertEx(pathParts.pop(), 'No hash specified')
+
+    //archivist is assumed to be the first part
+    this.archivist = pathParts.shift() ?? 'api.archivist.xyo.network'
+
+    //the archive is whatever is left
+    this.archive = pathParts.pop()
+
+    //after we pull off all the path parts, there should be nothing left
+    assertEx(pathParts.length === 0, 'Too many path parts')
+
+    return hash
+  }
+
+  private validateParse() {
+    //the archivist should not be zero length
+    assertEx(this.archivist?.length !== 0, 'Invalid archivist length')
+
+    //the archivist should not be zero length (can be undefined)
+    assertEx(this.archive?.length !== 0, 'Invalid archive length')
+
+    //the archive should not be set if the archivist is not set
+    assertEx(!(this.archive && !this.archivist), 'If specifying archive, archivist is also required')
+  }
+
+  /*
+  The full href or the hash
+  */
+
+  public get href() {
+    const parts: string[] = []
+    if (this.protocol) {
+      parts.push(`${this.protocol}:/`)
+    }
+    if (this.archive) {
+      parts.push(`${this.archive}`)
+    }
+    if (this.archivist) {
+      parts.push(`${this.archivist}`)
+    }
+    parts.push(this.hash)
+    return parts.join('/')
+  }
+
+  public toString() {
+    return this.href
+  }
+
+  public async fetch() {
+    return await Huri.fetch(this)
+  }
+
+  static async fetch(huri: Huri): Promise<XyoPayload | undefined> {
+    return (await axios.get<XyoPayload>(huri.href)).data
+  }
+
+  private static parseProtocol(huri: string) {
+    const protocolSplit = huri.split('//')
+    assertEx(protocolSplit.length <= 2, `Invalid second protocol [${protocolSplit[2]}]`)
+    const rawProtocol = protocolSplit.length === 2 ? protocolSplit.shift() : undefined
+    if (rawProtocol) {
+      const protocolParts = rawProtocol?.split(':')
+      assertEx(protocolParts.length === 2, `Invalid protocol format [${rawProtocol}]`)
+      assertEx(protocolParts[1].length === 0, `Invalid protocol format (post :) [${rawProtocol}]`)
+      return protocolParts.shift()
+    }
+  }
+
+  private static parsePath(huri: string) {
+    const protocolSplit = huri.split('//')
+    assertEx(protocolSplit.length <= 2, `Invalid format [${huri}]`)
+    if (protocolSplit.length === 1) {
+      return huri
+    }
+    if (protocolSplit.length === 2) {
+      return protocolSplit[1]
+    }
+  }
+
+  public static isHuri(value: unknown) {
+    if (typeof value === 'object') {
+      return (value as Huri).isHuri ? (value as Huri) : undefined
+    }
+    return undefined
+  }
+}

package/src/Huri/index.ts

@@ -0,0 +1 @@
+export * from './Huri'

package/src/Query/QueryPayload.ts

@@ -0,0 +1,15 @@
+import { XyoPayload } from '../models'
+
+export interface XyoQueryPayload extends XyoPayload {
+  /** @field The preferred schema to use for the answer */
+  targetSchema?: string
+
+  /** @field The maximum XYO that can be spent executing the query */
+  budget?: number
+
+  /** @field The frequency on which this query can be rerun */
+  maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'
+
+  /** @field The starting point for the bidding on the query */
+  minBid?: number
+}

package/src/Query/index.ts

@@ -0,0 +1 @@
+export * from './QueryPayload'

package/src/Schema/Payload.ts

@@ -0,0 +1,11 @@
+import { XyoPayload } from '../models'
+
+export type XyoSchemaPayload = XyoPayload<{
+  /** @deprecated use definition.$id instead */
+  name?: string
+  definition: {
+    $id?: string
+    [key: string]: unknown
+  }
+  extends?: string
+}>

package/src/Schema/index.ts

@@ -0,0 +1 @@
+export * from './Payload'