@xyo-network/api-call-witness 2.97.0-rc.1 → 2.97.1

package/dist/node/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Config.ts","../../src/Payload.ts","../../src/Witness.ts","../../src/lib/checkIpfsUrl.ts"],"sourcesContent":["import { AsObjectFactory } from '@xylabs/object'\nimport { isPayloadOfSchemaType } from '@xyo-network/payload-model'\nimport { WitnessConfig } from '@xyo-network/witness-model'\n\nimport { ApiCall, ApiUriCall, ApiUriTemplateCall } from './Payload'\n\nexport const ApiCallWitnessConfigSchema = 'network.xyo.api.call.witness.config'\nexport type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema\n\nexport type ApiCallWitnessConfigBase = WitnessConfig<{\n  accept?: 'application/json'\n  headers?: Record<string, string | undefined>\n  queries?: ApiCall['queries']\n  schema: ApiCallWitnessConfigSchema\n  timeout?: number\n  verb?: ApiCall['verb']\n}>\n\nexport type ApiUriCallWitnessConfig = WitnessConfig<\n  ApiCallWitnessConfigBase & {\n    uri: ApiUriCall['uri']\n  }\n>\n\nexport type ApiUriTemplateCallWitnessConfig = WitnessConfig<\n  ApiCallWitnessConfigBase & {\n    params?: Record<string, string>\n    uriTemplate: ApiUriTemplateCall['uriTemplate']\n  }\n>\n\nexport type ApiCallWitnessConfig = ApiUriCallWitnessConfig | ApiUriTemplateCallWitnessConfig | ApiCallWitnessConfigBase\n\nexport const isApiCallWitnessConfig = isPayloadOfSchemaType<ApiCallWitnessConfig>(ApiCallWitnessConfigSchema)\nexport const asApiCallWitnessConfig = AsObjectFactory.create(isApiCallWitnessConfig)\n\nexport const isApiUriCallWitnessConfig = (value?: unknown): value is ApiUriCallWitnessConfig =>\n  isApiCallWitnessConfig(value) && !!(value as ApiUriCallWitnessConfig).uri\nexport const asApiUriCallWitnessConfig = AsObjectFactory.create(isApiUriCallWitnessConfig)\n\nexport const isApiUriTemplateCallWitnessConfig = (value?: unknown): value is ApiUriTemplateCallWitnessConfig =>\n  isApiCallWitnessConfig(value) && !!(value as ApiUriTemplateCallWitnessConfig).uriTemplate\nexport const asApiUriTemplateCallWitnessConfig = AsObjectFactory.create(isApiUriTemplateCallWitnessConfig)\n","import { Hash } from '@xylabs/hex'\nimport { AsObjectFactory, JsonArray, JsonObject } from '@xylabs/object'\nimport { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'\n\nexport const ApiCallSchema = 'network.xyo.api.call'\nexport type ApiCallSchema = typeof ApiCallSchema\n\nexport type Verb = 'get' | 'post'\nexport type Queries = Record<string, string>\n\nexport interface ApiCallFields {\n  headers?: Record<string, string | undefined>\n  queries?: Queries\n  verb?: Verb\n}\n\nexport type ApiUriCall = Payload<\n  ApiCallFields & {\n    uri: string\n  },\n  ApiCallSchema\n>\nexport const isApiUriCall = (value?: unknown): value is ApiUriCall => isApiCall(value) && !!(value as ApiUriCall).uri\nexport const asApiUriCall = AsObjectFactory.create(isApiUriCall)\n\nexport type ApiUriTemplateCall = Payload<\n  ApiCallFields & {\n    params?: Record<string, string>\n    uriTemplate?: string\n  },\n  ApiCallSchema\n>\nexport const isApiUriTemplateCall = (value?: unknown): value is ApiUriTemplateCall =>\n  isApiCall(value) && !!((value as ApiUriTemplateCall).uriTemplate || (value as ApiUriTemplateCall).params)\nexport const asApiUriTemplateCall = AsObjectFactory.create(isApiUriTemplateCall)\n\nexport type ApiCall = ApiUriCall | ApiUriTemplateCall\n\nexport const ApiCallResultSchema = 'network.xyo.api.call.result'\nexport type ApiCallResultSchema = typeof ApiCallResultSchema\n\nexport const isApiCall = isPayloadOfSchemaType<ApiCall>(ApiCallSchema)\nexport const asApiCall = AsObjectFactory.create(isApiCall)\n\nexport interface HttpMeta {\n  code?: string\n  status?: number\n}\n\nexport type ApiCallJsonResultType = JsonArray | JsonObject\n\nexport type ApiCallJsonResult<T extends ApiCallJsonResultType = ApiCallJsonResultType> = Payload<\n  {\n    call: Hash\n    contentType: 'application/json'\n    data: T\n  },\n  ApiCallResultSchema\n>\n\nexport const isApiCallJsonResult = <T extends ApiCallJsonResultType = ApiCallJsonResultType>(x?: unknown | null): x is ApiCallJsonResult<T> => {\n  return isPayloadOfSchemaType(ApiCallResultSchema)(x) && (x as ApiCallJsonResult)?.contentType === 'application/json'\n}\nexport const asApiCallJsonResult = AsObjectFactory.create(isApiCallJsonResult)\n\nexport type ApiCallBase64Result = Payload<\n  {\n    call: Hash\n    contentType: Exclude<string, ApiCallJsonResult['contentType']>\n    data: string\n  },\n  ApiCallResultSchema\n>\n\nexport type ApiCallErrorResult = Payload<\n  {\n    call: Hash\n    http?: HttpMeta\n  },\n  ApiCallResultSchema\n>\n\nexport type ApiCallResult<TJson extends JsonArray | JsonObject = JsonArray | JsonObject> =\n  | ApiCallBase64Result\n  | ApiCallJsonResult<TJson>\n  | ApiCallErrorResult\n\nexport const isApiCallResult = isPayloadOfSchemaType<ApiCallResult>(ApiCallResultSchema)\nexport const isApiCallErrorResult = (value: unknown): value is ApiCallErrorResult =>\n  !!isPayloadOfSchemaType<ApiCallResult>(ApiCallResultSchema) && ((value as ApiCallErrorResult).http?.status ?? 200) >= 400\nexport const asApiCallResult = AsObjectFactory.create(isApiCallResult)\n","/* eslint-disable max-statements */\nimport { assertEx } from '@xylabs/assert'\nimport { Axios, AxiosError, AxiosJson } from '@xylabs/axios'\nimport { Hash } from '@xylabs/hex'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { isPayloadOfSchemaType, Schema } from '@xyo-network/payload-model'\nimport { WitnessParams } from '@xyo-network/witness-model'\nimport { fromByteArray } from 'base64-js'\nimport fillTemplate from 'es6-dynamic-template'\n\nimport { ApiCallWitnessConfig, ApiCallWitnessConfigSchema, asApiUriCallWitnessConfig, asApiUriTemplateCallWitnessConfig } from './Config'\nimport { checkIpfsUrl } from './lib'\nimport {\n  ApiCall,\n  ApiCallBase64Result,\n  ApiCallErrorResult,\n  ApiCallJsonResult,\n  ApiCallJsonResultType,\n  ApiCallResult,\n  ApiCallResultSchema,\n  ApiCallSchema,\n  asApiUriCall,\n  asApiUriTemplateCall,\n} from './Payload'\n\nexport type ApiCallWitnessParams = WitnessParams<\n  ApiCallWitnessConfig,\n  {\n    headers?: Record<string, string | undefined>\n    ipfsGateway?: string\n  }\n>\n\nexport class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnessParams> extends AbstractWitness<TParams, ApiCall, ApiCallResult> {\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, ApiCallWitnessConfigSchema]\n  static override readonly defaultConfigSchema: Schema = ApiCallWitnessConfigSchema\n\n  get accept() {\n    return this.config.accept ?? 'application/json'\n  }\n\n  get ipfsGateway() {\n    return this.params.ipfsGateway\n  }\n\n  get timeout() {\n    return this.config.timeout\n  }\n\n  getFullUri(call?: ApiCall): string {\n    const { uri: callUri } = asApiUriCall(call) ?? {}\n    const { uriTemplate: callUriTemplate, params: callParams, queries: callQueries } = asApiUriTemplateCall(call) ?? {}\n    const { uri: configUri } = asApiUriCallWitnessConfig(this.config) ?? {}\n    const { uriTemplate: configUriTemplate, params: configParams, queries: configQueries } = asApiUriTemplateCallWitnessConfig(this.config) ?? {}\n\n    const params = { ...configParams, ...callParams }\n\n    let url: URL | undefined = undefined\n\n    if (callUri) {\n      url = new URL(callUri)\n    } else if (callUriTemplate) {\n      url = new URL(fillTemplate(callUriTemplate, params))\n    } else if (configUri) {\n      url = new URL(configUri)\n    } else if (configUriTemplate) {\n      url = new URL(fillTemplate(configUriTemplate, params))\n    }\n\n    if (url) {\n      const queries = Object.entries({ ...configQueries, ...callQueries })\n      queries.map(([key, value]) => url?.searchParams.set(key, value))\n      return url.href\n    }\n\n    throw new Error('Unable to determine uri. No uri/uriTemplate specified in either the call or config.')\n  }\n\n  getHeaders(headers?: Record<string, string | undefined>): Record<string, string | undefined> {\n    return { ...this.params.headers, ...this.config.headers, ...headers }\n  }\n\n  protected override async observeHandler(inPayloads: ApiCall[] = []): Promise<ApiCallResult[]> {\n    await this.started('throw')\n    try {\n      const observations = await Promise.all(\n        inPayloads.filter(isPayloadOfSchemaType(ApiCallSchema)).map(async (call) => {\n          const { verb: callVerb } = call\n          const { verb: configVerb } = this.config\n          const verb = callVerb ?? configVerb ?? 'get'\n          const uri = this.getFullUri(call)\n\n          const validatedUri = assertEx(checkIpfsUrl(uri, this.ipfsGateway), () => 'Invalid URI')\n\n          if (verb === 'get') {\n            return this.httpGet(validatedUri, (await PayloadBuilder.build(call)).$hash)\n          }\n\n          const observation: ApiCallResult = {\n            call: await PayloadHasher.hash(call),\n            schema: ApiCallResultSchema,\n          }\n          return observation\n        }),\n      )\n      return observations\n    } catch (ex) {\n      const error = ex as Error\n      console.error(`Error [${this.config.name}]: ${error.message}`)\n      console.log(error.stack)\n      throw error\n    }\n  }\n\n  private async httpGet(url: string, call: Hash, headers?: Record<string, string | undefined>): Promise<ApiCallResult> {\n    const result: ApiCallResult = {\n      call,\n      schema: ApiCallResultSchema,\n    }\n    try {\n      switch (this.accept) {\n        case 'application/json': {\n          const axios = new AxiosJson({ headers: { ...this.getHeaders(headers), Accept: 'application/json' }, timeout: this.timeout })\n          const response = await axios.get<ApiCallJsonResultType>(url)\n          if (response.status >= 200 && response.status < 300) {\n            const jsonResult = result as ApiCallJsonResult\n            jsonResult.data = response.data\n            jsonResult.contentType = 'application/json'\n          } else {\n            const errorResult = result as ApiCallErrorResult\n            errorResult.http = {\n              status: response.status,\n            }\n          }\n          break\n        }\n        default: {\n          const axios = new Axios({ headers: this.params.headers, responseType: 'arraybuffer', timeout: this.timeout })\n          const response = await axios.get(url)\n          if (response.status >= 200 && response.status < 300) {\n            const jsonResult = result as ApiCallBase64Result\n            jsonResult.data = fromByteArray(Buffer.from(response.data, 'binary'))\n            jsonResult.contentType = response.headers['content-type']?.toString() ?? 'application/octet-stream'\n          } else {\n            const errorResult = result as ApiCallErrorResult\n            errorResult.http = {\n              status: response.status,\n            }\n          }\n          break\n        }\n      }\n    } catch (ex) {\n      const axiosError = ex as AxiosError\n      if (axiosError.isAxiosError) {\n        if (axiosError?.response?.status !== undefined) {\n          result.http = result.http ?? {}\n          result.http.status = axiosError?.response?.status\n        }\n        if (axiosError?.code !== undefined) {\n          result.http = result.http ?? {}\n          result.http.code = axiosError?.code\n        }\n        return result\n      } else {\n        throw ex\n      }\n    }\n    return result\n  }\n}\n","import { assertEx } from '@xylabs/assert'\n\nconst allowIpfsIoRepair = true\n\n/**\n * Returns the equivalent IPFS gateway URL for the supplied URL.\n * @param urlToCheck The URL to check\n * @returns If the supplied URL is an IPFS URL, it converts the URL to the\n * equivalent IPFS gateway URL. Otherwise, returns the original URL.\n */\nexport const checkIpfsUrl = (urlToCheck: string, ipfsGateway?: string): string => {\n  try {\n    const url = new URL(urlToCheck)\n    let protocol = url.protocol\n    let host = url.host\n    let path = url.pathname\n    const query = url.search\n    if (protocol === 'ipfs:') {\n      protocol = 'https:'\n      host = assertEx(ipfsGateway, () => 'No ipfsGateway provided')\n      path = url.host === 'ipfs' ? `ipfs${path}` : `ipfs/${url.host}${path}`\n      const root = `${protocol}//${host}/${path}`\n      return query?.length > 0 ? `${root}?${query}` : root\n    } else if (allowIpfsIoRepair && protocol === 'https' && host === 'ipfs.io') {\n      protocol = 'https:'\n      host = assertEx(ipfsGateway, () => 'No ipfsGateway provided')\n      const pathParts = path.split('/')\n      if (pathParts[0] === 'ipfs') {\n        pathParts.shift()\n      }\n      path = pathParts.join('/')\n      const root = `${protocol}//${host}/${path}`\n      return query?.length > 0 ? `${root}?${query}` : root\n    } else {\n      return urlToCheck\n    }\n  } catch {\n    //const error = ex as Error\n    //console.error(`${error.name}:${error.message} [${urlToCheck}]`)\n    //console.log(error.stack)\n    return urlToCheck\n  }\n}\n"],"mappings":";AAAA,SAAS,uBAAuB;AAChC,SAAS,6BAA6B;AAK/B,IAAM,6BAA6B;AA2BnC,IAAM,yBAAyB,sBAA4C,0BAA0B;AACrG,IAAM,yBAAyB,gBAAgB,OAAO,sBAAsB;AAE5E,IAAM,4BAA4B,CAAC,UACxC,uBAAuB,KAAK,KAAK,CAAC,CAAE,MAAkC;AACjE,IAAM,4BAA4B,gBAAgB,OAAO,yBAAyB;AAElF,IAAM,oCAAoC,CAAC,UAChD,uBAAuB,KAAK,KAAK,CAAC,CAAE,MAA0C;AACzE,IAAM,oCAAoC,gBAAgB,OAAO,iCAAiC;;;ACzCzG,SAAS,mBAAAA,wBAA8C;AACvD,SAAS,yBAAAC,8BAAsC;AAExC,IAAM,gBAAgB;AAkBtB,IAAM,eAAe,CAAC,UAAyC,UAAU,KAAK,KAAK,CAAC,CAAE,MAAqB;AAC3G,IAAM,eAAeD,iBAAgB,OAAO,YAAY;AASxD,IAAM,uBAAuB,CAAC,UACnC,UAAU,KAAK,KAAK,CAAC,EAAG,MAA6B,eAAgB,MAA6B;AAC7F,IAAM,uBAAuBA,iBAAgB,OAAO,oBAAoB;AAIxE,IAAM,sBAAsB;AAG5B,IAAM,YAAYC,uBAA+B,aAAa;AAC9D,IAAM,YAAYD,iBAAgB,OAAO,SAAS;AAkBlD,IAAM,sBAAsB,CAA0D,MAAkD;AAC7I,SAAOC,uBAAsB,mBAAmB,EAAE,CAAC,MAAM,uBAAyB,iBAAgB;AACpG;AACO,IAAM,sBAAsBD,iBAAgB,OAAO,mBAAmB;AAwBtE,IAAM,kBAAkBC,uBAAqC,mBAAmB;AAChF,IAAM,uBAAuB,CAAC,UAA6C;AAxFlF;AAyFE,UAAC,CAACA,uBAAqC,mBAAmB,QAAO,WAA6B,SAA7B,mBAAmC,WAAU,QAAQ;AAAA;AACjH,IAAM,kBAAkBD,iBAAgB,OAAO,eAAe;;;ACzFrE,SAAS,YAAAE,iBAAgB;AACzB,SAAS,OAAmB,iBAAiB;AAE7C,SAAS,uBAAuB;AAChC,SAAS,qBAAqB;AAC9B,SAAS,sBAAsB;AAC/B,SAAS,yBAAAC,8BAAqC;AAE9C,SAAS,qBAAqB;AAC9B,OAAO,kBAAkB;;;ACVzB,SAAS,gBAAgB;AAEzB,IAAM,oBAAoB;AAQnB,IAAM,eAAe,CAAC,YAAoB,gBAAiC;AAChF,MAAI;AACF,UAAM,MAAM,IAAI,IAAI,UAAU;AAC9B,QAAI,WAAW,IAAI;AACnB,QAAI,OAAO,IAAI;AACf,QAAI,OAAO,IAAI;AACf,UAAM,QAAQ,IAAI;AAClB,QAAI,aAAa,SAAS;AACxB,iBAAW;AACX,aAAO,SAAS,aAAa,MAAM,yBAAyB;AAC5D,aAAO,IAAI,SAAS,SAAS,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,GAAG,IAAI;AACpE,YAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI;AACzC,cAAO,+BAAO,UAAS,IAAI,GAAG,IAAI,IAAI,KAAK,KAAK;AAAA,IAClD,WAAW,qBAAqB,aAAa,WAAW,SAAS,WAAW;AAC1E,iBAAW;AACX,aAAO,SAAS,aAAa,MAAM,yBAAyB;AAC5D,YAAM,YAAY,KAAK,MAAM,GAAG;AAChC,UAAI,UAAU,CAAC,MAAM,QAAQ;AAC3B,kBAAU,MAAM;AAAA,MAClB;AACA,aAAO,UAAU,KAAK,GAAG;AACzB,YAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI;AACzC,cAAO,+BAAO,UAAS,IAAI,GAAG,IAAI,IAAI,KAAK,KAAK;AAAA,IAClD,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF,QAAQ;AAIN,WAAO;AAAA,EACT;AACF;;;ADPO,IAAM,iBAAN,cAA0F,gBAAiD;AAAA,EAChJ,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,0BAA0B;AAAA,EACtG,OAAyB,sBAA8B;AAAA,EAEvD,IAAI,SAAS;AACX,WAAO,KAAK,OAAO,UAAU;AAAA,EAC/B;AAAA,EAEA,IAAI,cAAc;AAChB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,WAAW,MAAwB;AACjC,UAAM,EAAE,KAAK,QAAQ,IAAI,aAAa,IAAI,KAAK,CAAC;AAChD,UAAM,EAAE,aAAa,iBAAiB,QAAQ,YAAY,SAAS,YAAY,IAAI,qBAAqB,IAAI,KAAK,CAAC;AAClH,UAAM,EAAE,KAAK,UAAU,IAAI,0BAA0B,KAAK,MAAM,KAAK,CAAC;AACtE,UAAM,EAAE,aAAa,mBAAmB,QAAQ,cAAc,SAAS,cAAc,IAAI,kCAAkC,KAAK,MAAM,KAAK,CAAC;AAE5I,UAAM,SAAS,EAAE,GAAG,cAAc,GAAG,WAAW;AAEhD,QAAI,MAAuB;AAE3B,QAAI,SAAS;AACX,YAAM,IAAI,IAAI,OAAO;AAAA,IACvB,WAAW,iBAAiB;AAC1B,YAAM,IAAI,IAAI,aAAa,iBAAiB,MAAM,CAAC;AAAA,IACrD,WAAW,WAAW;AACpB,YAAM,IAAI,IAAI,SAAS;AAAA,IACzB,WAAW,mBAAmB;AAC5B,YAAM,IAAI,IAAI,aAAa,mBAAmB,MAAM,CAAC;AAAA,IACvD;AAEA,QAAI,KAAK;AACP,YAAM,UAAU,OAAO,QAAQ,EAAE,GAAG,eAAe,GAAG,YAAY,CAAC;AACnE,cAAQ,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,2BAAK,aAAa,IAAI,KAAK,MAAM;AAC/D,aAAO,IAAI;AAAA,IACb;AAEA,UAAM,IAAI,MAAM,qFAAqF;AAAA,EACvG;AAAA,EAEA,WAAW,SAAkF;AAC3F,WAAO,EAAE,GAAG,KAAK,OAAO,SAAS,GAAG,KAAK,OAAO,SAAS,GAAG,QAAQ;AAAA,EACtE;AAAA,EAEA,MAAyB,eAAe,aAAwB,CAAC,GAA6B;AAC5F,UAAM,KAAK,QAAQ,OAAO;AAC1B,QAAI;AACF,YAAM,eAAe,MAAM,QAAQ;AAAA,QACjC,WAAW,OAAOC,uBAAsB,aAAa,CAAC,EAAE,IAAI,OAAO,SAAS;AAC1E,gBAAM,EAAE,MAAM,SAAS,IAAI;AAC3B,gBAAM,EAAE,MAAM,WAAW,IAAI,KAAK;AAClC,gBAAM,OAAO,YAAY,cAAc;AACvC,gBAAM,MAAM,KAAK,WAAW,IAAI;AAEhC,gBAAM,eAAeC,UAAS,aAAa,KAAK,KAAK,WAAW,GAAG,MAAM,aAAa;AAEtF,cAAI,SAAS,OAAO;AAClB,mBAAO,KAAK,QAAQ,eAAe,MAAM,eAAe,MAAM,IAAI,GAAG,KAAK;AAAA,UAC5E;AAEA,gBAAM,cAA6B;AAAA,YACjC,MAAM,MAAM,cAAc,KAAK,IAAI;AAAA,YACnC,QAAQ;AAAA,UACV;AACA,iBAAO;AAAA,QACT,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,SAAS,IAAI;AACX,YAAM,QAAQ;AACd,cAAQ,MAAM,UAAU,KAAK,OAAO,IAAI,MAAM,MAAM,OAAO,EAAE;AAC7D,cAAQ,IAAI,MAAM,KAAK;AACvB,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAc,QAAQ,KAAa,MAAY,SAAsE;AApHvH;AAqHI,UAAM,SAAwB;AAAA,MAC5B;AAAA,MACA,QAAQ;AAAA,IACV;AACA,QAAI;AACF,cAAQ,KAAK,QAAQ;AAAA,QACnB,KAAK,oBAAoB;AACvB,gBAAM,QAAQ,IAAI,UAAU,EAAE,SAAS,EAAE,GAAG,KAAK,WAAW,OAAO,GAAG,QAAQ,mBAAmB,GAAG,SAAS,KAAK,QAAQ,CAAC;AAC3H,gBAAM,WAAW,MAAM,MAAM,IAA2B,GAAG;AAC3D,cAAI,SAAS,UAAU,OAAO,SAAS,SAAS,KAAK;AACnD,kBAAM,aAAa;AACnB,uBAAW,OAAO,SAAS;AAC3B,uBAAW,cAAc;AAAA,UAC3B,OAAO;AACL,kBAAM,cAAc;AACpB,wBAAY,OAAO;AAAA,cACjB,QAAQ,SAAS;AAAA,YACnB;AAAA,UACF;AACA;AAAA,QACF;AAAA,QACA,SAAS;AACP,gBAAM,QAAQ,IAAI,MAAM,EAAE,SAAS,KAAK,OAAO,SAAS,cAAc,eAAe,SAAS,KAAK,QAAQ,CAAC;AAC5G,gBAAM,WAAW,MAAM,MAAM,IAAI,GAAG;AACpC,cAAI,SAAS,UAAU,OAAO,SAAS,SAAS,KAAK;AACnD,kBAAM,aAAa;AACnB,uBAAW,OAAO,cAAc,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAC;AACpE,uBAAW,gBAAc,cAAS,QAAQ,cAAc,MAA/B,mBAAkC,eAAc;AAAA,UAC3E,OAAO;AACL,kBAAM,cAAc;AACpB,wBAAY,OAAO;AAAA,cACjB,QAAQ,SAAS;AAAA,YACnB;AAAA,UACF;AACA;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,IAAI;AACX,YAAM,aAAa;AACnB,UAAI,WAAW,cAAc;AAC3B,cAAI,8CAAY,aAAZ,mBAAsB,YAAW,QAAW;AAC9C,iBAAO,OAAO,OAAO,QAAQ,CAAC;AAC9B,iBAAO,KAAK,UAAS,8CAAY,aAAZ,mBAAsB;AAAA,QAC7C;AACA,aAAI,yCAAY,UAAS,QAAW;AAClC,iBAAO,OAAO,OAAO,QAAQ,CAAC;AAC9B,iBAAO,KAAK,OAAO,yCAAY;AAAA,QACjC;AACA,eAAO;AAAA,MACT,OAAO;AACL,cAAM;AAAA,MACR;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;","names":["AsObjectFactory","isPayloadOfSchemaType","assertEx","isPayloadOfSchemaType","isPayloadOfSchemaType","assertEx"]}
+{"version":3,"sources":["../../src/Payload/identity/asApiCall.ts","../../src/Payload/identity/isApiCall.ts","../../src/Payload/Schema.ts","../../src/Payload/identity/asApiCallBase64Result.ts","../../src/Payload/identity/isApiCallBase64Result.ts","../../src/Payload/identity/asApiCallResult.ts","../../src/Payload/identity/isApiCallResult.ts","../../src/Payload/identity/asApiCallXmlResult.ts","../../src/Payload/identity/isApiCallXmlResult.ts","../../src/Payload/identity/asApiUriCall.ts","../../src/Payload/identity/isApiUriCall.ts","../../src/Payload/identity/asApiUriTemplateCall.ts","../../src/Payload/identity/isApiUriTemplateCall.ts","../../src/Payload/identity/isApiCallErrorResult.ts","../../src/Payload/types/ApiCallJsonResult.ts","../../src/Witness/Config.ts","../../src/Witness/Schema.ts","../../src/Witness/Witness.ts","../../src/lib/checkIpfsUrl.ts"],"sourcesContent":["import { AsObjectFactory } from '@xylabs/object'\n\nimport { isApiCall } from './isApiCall'\n\nexport const asApiCall = AsObjectFactory.create(isApiCall)\n","import { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { ApiCallSchema } from '../Schema'\nimport { ApiCall } from '../types'\n\nexport const isApiCall = isPayloadOfSchemaType<ApiCall>(ApiCallSchema)\n","export const ApiCallSchema = 'network.xyo.api.call'\nexport type ApiCallSchema = typeof ApiCallSchema\n\nexport const ApiCallResultSchema = `${ApiCallSchema}.result`\nexport type ApiCallResultSchema = typeof ApiCallResultSchema\n","import { AsObjectFactory } from '@xylabs/object'\n\nimport { isApiCallBase64Result } from './isApiCallBase64Result'\n\nexport const asApiCallBase64Result = AsObjectFactory.create(isApiCallBase64Result)\n","import { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { ApiCallResultSchema } from '../Schema'\nimport { ApiCallBase64Result } from '../types'\n\nexport const isApiCallBase64Result = (x?: unknown | null): x is ApiCallBase64Result => {\n  return isPayloadOfSchemaType(ApiCallResultSchema)(x) && typeof (x as ApiCallBase64Result)?.data === 'string'\n}\n","import { AsObjectFactory } from '@xylabs/object'\n\nimport { isApiCallResult } from './isApiCallResult'\n\nexport const asApiCallResult = AsObjectFactory.create(isApiCallResult)\n","import { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { ApiCallResultSchema } from '../Schema'\nimport { ApiCallResult } from '../types'\n\nexport const isApiCallResult = isPayloadOfSchemaType<ApiCallResult>(ApiCallResultSchema)\n","import { AsObjectFactory } from '@xylabs/object'\n\nimport { isApiCallXmlResult } from './isApiCallXmlResult'\n\nexport const asApiCallXmlResult = AsObjectFactory.create(isApiCallXmlResult)\n","import { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { ApiCallResultSchema } from '../Schema'\nimport { ApiCallXmlResult } from '../types'\n\nexport const isApiCallXmlResult = (x?: unknown | null): x is ApiCallXmlResult => {\n  return isPayloadOfSchemaType(ApiCallResultSchema)(x) && typeof (x as ApiCallXmlResult)?.data === 'string'\n}\n","import { AsObjectFactory } from '@xylabs/object'\n\nimport { isApiUriCall } from './isApiUriCall'\n\nexport const asApiUriCall = AsObjectFactory.create(isApiUriCall)\n","import { ApiUriCall } from '../types'\nimport { isApiCall } from './isApiCall'\n\nexport const isApiUriCall = (value?: unknown): value is ApiUriCall => isApiCall(value) && !!(value as ApiUriCall).uri\n","import { AsObjectFactory } from '@xylabs/object'\n\nimport { isApiUriTemplateCall } from './isApiUriTemplateCall'\n\nexport const asApiUriTemplateCall = AsObjectFactory.create(isApiUriTemplateCall)\n","import { ApiUriTemplateCall } from '../types'\nimport { isApiCall } from './isApiCall'\n\nexport const isApiUriTemplateCall = (value?: unknown): value is ApiUriTemplateCall =>\n  isApiCall(value) && !!((value as ApiUriTemplateCall).uriTemplate || (value as ApiUriTemplateCall).params)\n","import { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { ApiCallResultSchema } from '../Schema'\nimport { ApiCallErrorResult, ApiCallResult } from '../types'\n\nexport const isApiCallErrorResult = (value: unknown): value is ApiCallErrorResult =>\n  !!isPayloadOfSchemaType<ApiCallResult>(ApiCallResultSchema) && ((value as ApiCallErrorResult).http?.status ?? 200) >= 400\n","import { Hash } from '@xylabs/hex'\nimport { AsObjectFactory, JsonArray, JsonObject } from '@xylabs/object'\nimport { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'\n\nimport { ApiCallResultSchema } from '../Schema'\n\nexport type ApiCallJsonResultType = JsonArray | JsonObject\n\nexport type ApiCallJsonResult<T extends ApiCallJsonResultType = ApiCallJsonResultType> = Payload<\n  {\n    call: Hash\n    contentType: 'application/json'\n    data: T\n  },\n  ApiCallResultSchema\n>\n\nexport const isApiCallJsonResult = <T extends ApiCallJsonResultType = ApiCallJsonResultType>(x?: unknown | null): x is ApiCallJsonResult<T> => {\n  return isPayloadOfSchemaType(ApiCallResultSchema)(x) && (x as ApiCallJsonResult)?.contentType === 'application/json'\n}\nexport const asApiCallJsonResult = AsObjectFactory.create(isApiCallJsonResult)\n","import { AsObjectFactory } from '@xylabs/object'\nimport { isPayloadOfSchemaType } from '@xyo-network/payload-model'\nimport { WitnessConfig } from '@xyo-network/witness-model'\n\nimport { ApiCall, ApiUriCall, ApiUriTemplateCall, MimeTypes } from '../Payload'\nimport { ApiCallWitnessConfigSchema } from './Schema'\n\nexport type ApiCallWitnessConfigBase = WitnessConfig<{\n  accept?: MimeTypes\n  headers?: Record<string, string | undefined>\n  queries?: ApiCall['queries']\n  schema: ApiCallWitnessConfigSchema\n  timeout?: number\n  verb?: ApiCall['verb']\n}>\n\nexport type ApiUriCallWitnessConfig = WitnessConfig<\n  ApiCallWitnessConfigBase & {\n    uri: ApiUriCall['uri']\n  }\n>\n\nexport type ApiUriTemplateCallWitnessConfig = WitnessConfig<\n  ApiCallWitnessConfigBase & {\n    params?: Record<string, string>\n    uriTemplate: ApiUriTemplateCall['uriTemplate']\n  }\n>\n\nexport type ApiCallWitnessConfig = ApiUriCallWitnessConfig | ApiUriTemplateCallWitnessConfig | ApiCallWitnessConfigBase\n\nexport const isApiCallWitnessConfig = isPayloadOfSchemaType<ApiCallWitnessConfig>(ApiCallWitnessConfigSchema)\nexport const asApiCallWitnessConfig = AsObjectFactory.create(isApiCallWitnessConfig)\n\nexport const isApiUriCallWitnessConfig = (value?: unknown): value is ApiUriCallWitnessConfig =>\n  isApiCallWitnessConfig(value) && !!(value as ApiUriCallWitnessConfig).uri\nexport const asApiUriCallWitnessConfig = AsObjectFactory.create(isApiUriCallWitnessConfig)\n\nexport const isApiUriTemplateCallWitnessConfig = (value?: unknown): value is ApiUriTemplateCallWitnessConfig =>\n  isApiCallWitnessConfig(value) && !!(value as ApiUriTemplateCallWitnessConfig).uriTemplate\nexport const asApiUriTemplateCallWitnessConfig = AsObjectFactory.create(isApiUriTemplateCallWitnessConfig)\n","export const ApiCallWitnessConfigSchema = 'network.xyo.api.call.witness.config'\nexport type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema\n","/* eslint-disable max-statements */\nimport { assertEx } from '@xylabs/assert'\nimport { Axios, AxiosError, AxiosJson } from '@xylabs/axios'\nimport { Hash } from '@xylabs/hex'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport { isPayloadOfSchemaType, Schema } from '@xyo-network/payload-model'\nimport { fromByteArray } from 'base64-js'\nimport fillTemplate from 'es6-dynamic-template'\n\nimport { checkIpfsUrl } from '../lib'\nimport {\n  ApiCall,\n  ApiCallBase64Result,\n  ApiCallErrorResult,\n  ApiCallJsonResult,\n  ApiCallJsonResultType,\n  ApiCallResult,\n  ApiCallResultSchema,\n  ApiCallSchema,\n  ApiCallXmlResult,\n  asApiUriCall,\n  asApiUriTemplateCall,\n  MimeTypes,\n} from '../Payload'\nimport { asApiUriCallWitnessConfig, asApiUriTemplateCallWitnessConfig } from './Config'\nimport { ApiCallWitnessParams } from './Params'\nimport { ApiCallWitnessConfigSchema } from './Schema'\n\nexport class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnessParams> extends AbstractWitness<TParams, ApiCall, ApiCallResult> {\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, ApiCallWitnessConfigSchema]\n  static override readonly defaultConfigSchema: Schema = ApiCallWitnessConfigSchema\n\n  get accept(): MimeTypes {\n    return this.config.accept ?? 'application/json'\n  }\n\n  get ipfsGateway() {\n    return this.params.ipfsGateway\n  }\n\n  get timeout() {\n    return this.config.timeout\n  }\n\n  getFullUri(call?: ApiCall): string {\n    const { uri: callUri } = asApiUriCall(call) ?? {}\n    const { uriTemplate: callUriTemplate, params: callParams, queries: callQueries } = asApiUriTemplateCall(call) ?? {}\n    const { uri: configUri } = asApiUriCallWitnessConfig(this.config) ?? {}\n    const { uriTemplate: configUriTemplate, params: configParams, queries: configQueries } = asApiUriTemplateCallWitnessConfig(this.config) ?? {}\n\n    const params = { ...configParams, ...callParams }\n\n    let url: URL | undefined = undefined\n\n    if (callUri) {\n      url = new URL(callUri)\n    } else if (callUriTemplate) {\n      url = new URL(fillTemplate(callUriTemplate, params))\n    } else if (configUri) {\n      url = new URL(configUri)\n    } else if (configUriTemplate) {\n      url = new URL(fillTemplate(configUriTemplate, params))\n    }\n\n    if (url) {\n      const queries = Object.entries({ ...configQueries, ...callQueries })\n      queries.map(([key, value]) => url?.searchParams.set(key, value))\n      return url.href\n    }\n\n    throw new Error('Unable to determine uri. No uri/uriTemplate specified in either the call or config.')\n  }\n\n  getHeaders(headers?: Record<string, string | undefined>): Record<string, string | undefined> {\n    return { ...this.params.headers, ...this.config.headers, ...headers }\n  }\n\n  protected override async observeHandler(inPayloads: ApiCall[] = []): Promise<ApiCallResult[]> {\n    await this.started('throw')\n    try {\n      const observations = await Promise.all(\n        inPayloads.filter(isPayloadOfSchemaType(ApiCallSchema)).map(async (call) => {\n          const { verb: callVerb } = call\n          const { verb: configVerb } = this.config\n          const verb = callVerb ?? configVerb ?? 'get'\n          const uri = this.getFullUri(call)\n\n          const validatedUri = assertEx(checkIpfsUrl(uri, this.ipfsGateway), () => 'Invalid URI')\n\n          if (verb === 'get') {\n            return this.httpGet(validatedUri, (await PayloadBuilder.build(call)).$hash)\n          }\n\n          const observation: ApiCallResult = {\n            call: await PayloadHasher.hash(call),\n            schema: ApiCallResultSchema,\n          }\n          return observation\n        }),\n      )\n      return observations\n    } catch (ex) {\n      const error = ex as Error\n      console.error(`Error [${this.config.name}]: ${error.message}`)\n      console.log(error.stack)\n      throw error\n    }\n  }\n\n  private async httpGet(url: string, call: Hash, headers?: Record<string, string | undefined>): Promise<ApiCallResult> {\n    const result: ApiCallResult = {\n      call,\n      schema: ApiCallResultSchema,\n    }\n    try {\n      switch (this.accept) {\n        case 'application/json': {\n          const axios = new AxiosJson({ headers: { ...this.getHeaders(headers), Accept: 'application/json' }, timeout: this.timeout })\n          const response = await axios.get<ApiCallJsonResultType>(url)\n          if (response.status >= 200 && response.status < 300) {\n            const jsonResult = result as ApiCallJsonResult\n            jsonResult.data = response.data\n            jsonResult.contentType = 'application/json'\n          } else {\n            const errorResult = result as ApiCallErrorResult\n            errorResult.http = {\n              status: response.status,\n            }\n          }\n          break\n        }\n        case 'application/xml':\n        case 'text/xml': {\n          const axios = new Axios({\n            headers: { ...this.getHeaders(headers), Accept: this.accept },\n            responseType: 'arraybuffer',\n            timeout: this.timeout,\n          })\n          const response = await axios.get(url)\n          if (response.status >= 200 && response.status < 300) {\n            const xmlResult = result as ApiCallXmlResult\n            xmlResult.data = Buffer.from(response.data, 'binary').toString('utf8')\n            xmlResult.contentType = response.headers['content-type']?.toString() ?? 'application/xml'\n          } else {\n            const errorResult = result as ApiCallErrorResult\n            errorResult.http = {\n              status: response.status,\n            }\n          }\n          break\n        }\n        default: {\n          const axios = new Axios({ headers: this.params.headers, responseType: 'arraybuffer', timeout: this.timeout })\n          const response = await axios.get(url)\n          if (response.status >= 200 && response.status < 300) {\n            const jsonResult = result as ApiCallBase64Result\n            jsonResult.data = fromByteArray(Buffer.from(response.data, 'binary'))\n            jsonResult.contentType = response.headers['content-type']?.toString() ?? 'application/octet-stream'\n          } else {\n            const errorResult = result as ApiCallErrorResult\n            errorResult.http = {\n              status: response.status,\n            }\n          }\n          break\n        }\n      }\n    } catch (ex) {\n      const axiosError = ex as AxiosError\n      if (axiosError.isAxiosError) {\n        if (axiosError?.response?.status !== undefined) {\n          result.http = result.http ?? {}\n          result.http.status = axiosError?.response?.status\n        }\n        if (axiosError?.code !== undefined) {\n          result.http = result.http ?? {}\n          result.http.code = axiosError?.code\n        }\n        return result\n      } else {\n        throw ex\n      }\n    }\n    return result\n  }\n}\n","import { assertEx } from '@xylabs/assert'\n\nconst allowIpfsIoRepair = true\n\n/**\n * Returns the equivalent IPFS gateway URL for the supplied URL.\n * @param urlToCheck The URL to check\n * @returns If the supplied URL is an IPFS URL, it converts the URL to the\n * equivalent IPFS gateway URL. Otherwise, returns the original URL.\n */\nexport const checkIpfsUrl = (urlToCheck: string, ipfsGateway?: string): string => {\n  try {\n    const url = new URL(urlToCheck)\n    let protocol = url.protocol\n    let host = url.host\n    let path = url.pathname\n    const query = url.search\n    if (protocol === 'ipfs:') {\n      protocol = 'https:'\n      host = assertEx(ipfsGateway, () => 'No ipfsGateway provided')\n      path = url.host === 'ipfs' ? `ipfs${path}` : `ipfs/${url.host}${path}`\n      const root = `${protocol}//${host}/${path}`\n      return query?.length > 0 ? `${root}?${query}` : root\n    } else if (allowIpfsIoRepair && protocol === 'https' && host === 'ipfs.io') {\n      protocol = 'https:'\n      host = assertEx(ipfsGateway, () => 'No ipfsGateway provided')\n      const pathParts = path.split('/')\n      if (pathParts[0] === 'ipfs') {\n        pathParts.shift()\n      }\n      path = pathParts.join('/')\n      const root = `${protocol}//${host}/${path}`\n      return query?.length > 0 ? `${root}?${query}` : root\n    } else {\n      return urlToCheck\n    }\n  } catch {\n    //const error = ex as Error\n    //console.error(`${error.name}:${error.message} [${urlToCheck}]`)\n    //console.log(error.stack)\n    return urlToCheck\n  }\n}\n"],"mappings":";AAAA,SAAS,uBAAuB;;;ACAhC,SAAS,6BAA6B;;;ACA/B,IAAM,gBAAgB;AAGtB,IAAM,sBAAsB,GAAG,aAAa;;;ADE5C,IAAM,YAAY,sBAA+B,aAAa;;;ADD9D,IAAM,YAAY,gBAAgB,OAAO,SAAS;;;AGJzD,SAAS,mBAAAA,wBAAuB;;;ACAhC,SAAS,yBAAAC,8BAA6B;AAK/B,IAAM,wBAAwB,CAAC,MAAiD;AACrF,SAAOC,uBAAsB,mBAAmB,EAAE,CAAC,KAAK,QAAQ,uBAA2B,UAAS;AACtG;;;ADHO,IAAM,wBAAwBC,iBAAgB,OAAO,qBAAqB;;;AEJjF,SAAS,mBAAAC,wBAAuB;;;ACAhC,SAAS,yBAAAC,8BAA6B;AAK/B,IAAM,kBAAkBC,uBAAqC,mBAAmB;;;ADDhF,IAAM,kBAAkBC,iBAAgB,OAAO,eAAe;;;AEJrE,SAAS,mBAAAC,wBAAuB;;;ACAhC,SAAS,yBAAAC,8BAA6B;AAK/B,IAAM,qBAAqB,CAAC,MAA8C;AAC/E,SAAOC,uBAAsB,mBAAmB,EAAE,CAAC,KAAK,QAAQ,uBAAwB,UAAS;AACnG;;;ADHO,IAAM,qBAAqBC,iBAAgB,OAAO,kBAAkB;;;AEJ3E,SAAS,mBAAAC,wBAAuB;;;ACGzB,IAAM,eAAe,CAAC,UAAyC,UAAU,KAAK,KAAK,CAAC,CAAE,MAAqB;;;ADC3G,IAAM,eAAeC,iBAAgB,OAAO,YAAY;;;AEJ/D,SAAS,mBAAAC,wBAAuB;;;ACGzB,IAAM,uBAAuB,CAAC,UACnC,UAAU,KAAK,KAAK,CAAC,EAAG,MAA6B,eAAgB,MAA6B;;;ADA7F,IAAM,uBAAuBC,iBAAgB,OAAO,oBAAoB;;;AEJ/E,SAAS,yBAAAC,8BAA6B;AAK/B,IAAM,uBAAuB,CAAC,UAA6C;AALlF;AAME,UAAC,CAACC,uBAAqC,mBAAmB,QAAO,WAA6B,SAA7B,mBAAmC,WAAU,QAAQ;AAAA;;;ACLxH,SAAS,mBAAAC,wBAA8C;AACvD,SAAS,yBAAAC,8BAAsC;AAexC,IAAM,sBAAsB,CAA0D,MAAkD;AAC7I,SAAOC,uBAAsB,mBAAmB,EAAE,CAAC,MAAM,uBAAyB,iBAAgB;AACpG;AACO,IAAM,sBAAsBC,iBAAgB,OAAO,mBAAmB;;;ACpB7E,SAAS,mBAAAC,wBAAuB;AAChC,SAAS,yBAAAC,8BAA6B;;;ACD/B,IAAM,6BAA6B;;;AD+BnC,IAAM,yBAAyBC,uBAA4C,0BAA0B;AACrG,IAAM,yBAAyBC,iBAAgB,OAAO,sBAAsB;AAE5E,IAAM,4BAA4B,CAAC,UACxC,uBAAuB,KAAK,KAAK,CAAC,CAAE,MAAkC;AACjE,IAAM,4BAA4BA,iBAAgB,OAAO,yBAAyB;AAElF,IAAM,oCAAoC,CAAC,UAChD,uBAAuB,KAAK,KAAK,CAAC,CAAE,MAA0C;AACzE,IAAM,oCAAoCA,iBAAgB,OAAO,iCAAiC;;;AEvCzG,SAAS,YAAAC,iBAAgB;AACzB,SAAS,OAAmB,iBAAiB;AAE7C,SAAS,uBAAuB;AAChC,SAAS,qBAAqB;AAC9B,SAAS,sBAAsB;AAC/B,SAAS,yBAAAC,8BAAqC;AAC9C,SAAS,qBAAqB;AAC9B,OAAO,kBAAkB;;;ACTzB,SAAS,gBAAgB;AAEzB,IAAM,oBAAoB;AAQnB,IAAM,eAAe,CAAC,YAAoB,gBAAiC;AAChF,MAAI;AACF,UAAM,MAAM,IAAI,IAAI,UAAU;AAC9B,QAAI,WAAW,IAAI;AACnB,QAAI,OAAO,IAAI;AACf,QAAI,OAAO,IAAI;AACf,UAAM,QAAQ,IAAI;AAClB,QAAI,aAAa,SAAS;AACxB,iBAAW;AACX,aAAO,SAAS,aAAa,MAAM,yBAAyB;AAC5D,aAAO,IAAI,SAAS,SAAS,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,GAAG,IAAI;AACpE,YAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI;AACzC,cAAO,+BAAO,UAAS,IAAI,GAAG,IAAI,IAAI,KAAK,KAAK;AAAA,IAClD,WAAW,qBAAqB,aAAa,WAAW,SAAS,WAAW;AAC1E,iBAAW;AACX,aAAO,SAAS,aAAa,MAAM,yBAAyB;AAC5D,YAAM,YAAY,KAAK,MAAM,GAAG;AAChC,UAAI,UAAU,CAAC,MAAM,QAAQ;AAC3B,kBAAU,MAAM;AAAA,MAClB;AACA,aAAO,UAAU,KAAK,GAAG;AACzB,YAAM,OAAO,GAAG,QAAQ,KAAK,IAAI,IAAI,IAAI;AACzC,cAAO,+BAAO,UAAS,IAAI,GAAG,IAAI,IAAI,KAAK,KAAK;AAAA,IAClD,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF,QAAQ;AAIN,WAAO;AAAA,EACT;AACF;;;ADZO,IAAM,iBAAN,cAA0F,gBAAiD;AAAA,EAChJ,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,0BAA0B;AAAA,EACtG,OAAyB,sBAA8B;AAAA,EAEvD,IAAI,SAAoB;AACtB,WAAO,KAAK,OAAO,UAAU;AAAA,EAC/B;AAAA,EAEA,IAAI,cAAc;AAChB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,WAAW,MAAwB;AACjC,UAAM,EAAE,KAAK,QAAQ,IAAI,aAAa,IAAI,KAAK,CAAC;AAChD,UAAM,EAAE,aAAa,iBAAiB,QAAQ,YAAY,SAAS,YAAY,IAAI,qBAAqB,IAAI,KAAK,CAAC;AAClH,UAAM,EAAE,KAAK,UAAU,IAAI,0BAA0B,KAAK,MAAM,KAAK,CAAC;AACtE,UAAM,EAAE,aAAa,mBAAmB,QAAQ,cAAc,SAAS,cAAc,IAAI,kCAAkC,KAAK,MAAM,KAAK,CAAC;AAE5I,UAAM,SAAS,EAAE,GAAG,cAAc,GAAG,WAAW;AAEhD,QAAI,MAAuB;AAE3B,QAAI,SAAS;AACX,YAAM,IAAI,IAAI,OAAO;AAAA,IACvB,WAAW,iBAAiB;AAC1B,YAAM,IAAI,IAAI,aAAa,iBAAiB,MAAM,CAAC;AAAA,IACrD,WAAW,WAAW;AACpB,YAAM,IAAI,IAAI,SAAS;AAAA,IACzB,WAAW,mBAAmB;AAC5B,YAAM,IAAI,IAAI,aAAa,mBAAmB,MAAM,CAAC;AAAA,IACvD;AAEA,QAAI,KAAK;AACP,YAAM,UAAU,OAAO,QAAQ,EAAE,GAAG,eAAe,GAAG,YAAY,CAAC;AACnE,cAAQ,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM,2BAAK,aAAa,IAAI,KAAK,MAAM;AAC/D,aAAO,IAAI;AAAA,IACb;AAEA,UAAM,IAAI,MAAM,qFAAqF;AAAA,EACvG;AAAA,EAEA,WAAW,SAAkF;AAC3F,WAAO,EAAE,GAAG,KAAK,OAAO,SAAS,GAAG,KAAK,OAAO,SAAS,GAAG,QAAQ;AAAA,EACtE;AAAA,EAEA,MAAyB,eAAe,aAAwB,CAAC,GAA6B;AAC5F,UAAM,KAAK,QAAQ,OAAO;AAC1B,QAAI;AACF,YAAM,eAAe,MAAM,QAAQ;AAAA,QACjC,WAAW,OAAOC,uBAAsB,aAAa,CAAC,EAAE,IAAI,OAAO,SAAS;AAC1E,gBAAM,EAAE,MAAM,SAAS,IAAI;AAC3B,gBAAM,EAAE,MAAM,WAAW,IAAI,KAAK;AAClC,gBAAM,OAAO,YAAY,cAAc;AACvC,gBAAM,MAAM,KAAK,WAAW,IAAI;AAEhC,gBAAM,eAAeC,UAAS,aAAa,KAAK,KAAK,WAAW,GAAG,MAAM,aAAa;AAEtF,cAAI,SAAS,OAAO;AAClB,mBAAO,KAAK,QAAQ,eAAe,MAAM,eAAe,MAAM,IAAI,GAAG,KAAK;AAAA,UAC5E;AAEA,gBAAM,cAA6B;AAAA,YACjC,MAAM,MAAM,cAAc,KAAK,IAAI;AAAA,YACnC,QAAQ;AAAA,UACV;AACA,iBAAO;AAAA,QACT,CAAC;AAAA,MACH;AACA,aAAO;AAAA,IACT,SAAS,IAAI;AACX,YAAM,QAAQ;AACd,cAAQ,MAAM,UAAU,KAAK,OAAO,IAAI,MAAM,MAAM,OAAO,EAAE;AAC7D,cAAQ,IAAI,MAAM,KAAK;AACvB,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAc,QAAQ,KAAa,MAAY,SAAsE;AA/GvH;AAgHI,UAAM,SAAwB;AAAA,MAC5B;AAAA,MACA,QAAQ;AAAA,IACV;AACA,QAAI;AACF,cAAQ,KAAK,QAAQ;AAAA,QACnB,KAAK,oBAAoB;AACvB,gBAAM,QAAQ,IAAI,UAAU,EAAE,SAAS,EAAE,GAAG,KAAK,WAAW,OAAO,GAAG,QAAQ,mBAAmB,GAAG,SAAS,KAAK,QAAQ,CAAC;AAC3H,gBAAM,WAAW,MAAM,MAAM,IAA2B,GAAG;AAC3D,cAAI,SAAS,UAAU,OAAO,SAAS,SAAS,KAAK;AACnD,kBAAM,aAAa;AACnB,uBAAW,OAAO,SAAS;AAC3B,uBAAW,cAAc;AAAA,UAC3B,OAAO;AACL,kBAAM,cAAc;AACpB,wBAAY,OAAO;AAAA,cACjB,QAAQ,SAAS;AAAA,YACnB;AAAA,UACF;AACA;AAAA,QACF;AAAA,QACA,KAAK;AAAA,QACL,KAAK,YAAY;AACf,gBAAM,QAAQ,IAAI,MAAM;AAAA,YACtB,SAAS,EAAE,GAAG,KAAK,WAAW,OAAO,GAAG,QAAQ,KAAK,OAAO;AAAA,YAC5D,cAAc;AAAA,YACd,SAAS,KAAK;AAAA,UAChB,CAAC;AACD,gBAAM,WAAW,MAAM,MAAM,IAAI,GAAG;AACpC,cAAI,SAAS,UAAU,OAAO,SAAS,SAAS,KAAK;AACnD,kBAAM,YAAY;AAClB,sBAAU,OAAO,OAAO,KAAK,SAAS,MAAM,QAAQ,EAAE,SAAS,MAAM;AACrE,sBAAU,gBAAc,cAAS,QAAQ,cAAc,MAA/B,mBAAkC,eAAc;AAAA,UAC1E,OAAO;AACL,kBAAM,cAAc;AACpB,wBAAY,OAAO;AAAA,cACjB,QAAQ,SAAS;AAAA,YACnB;AAAA,UACF;AACA;AAAA,QACF;AAAA,QACA,SAAS;AACP,gBAAM,QAAQ,IAAI,MAAM,EAAE,SAAS,KAAK,OAAO,SAAS,cAAc,eAAe,SAAS,KAAK,QAAQ,CAAC;AAC5G,gBAAM,WAAW,MAAM,MAAM,IAAI,GAAG;AACpC,cAAI,SAAS,UAAU,OAAO,SAAS,SAAS,KAAK;AACnD,kBAAM,aAAa;AACnB,uBAAW,OAAO,cAAc,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAC;AACpE,uBAAW,gBAAc,cAAS,QAAQ,cAAc,MAA/B,mBAAkC,eAAc;AAAA,UAC3E,OAAO;AACL,kBAAM,cAAc;AACpB,wBAAY,OAAO;AAAA,cACjB,QAAQ,SAAS;AAAA,YACnB;AAAA,UACF;AACA;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,IAAI;AACX,YAAM,aAAa;AACnB,UAAI,WAAW,cAAc;AAC3B,cAAI,8CAAY,aAAZ,mBAAsB,YAAW,QAAW;AAC9C,iBAAO,OAAO,OAAO,QAAQ,CAAC;AAC9B,iBAAO,KAAK,UAAS,8CAAY,aAAZ,mBAAsB;AAAA,QAC7C;AACA,aAAI,yCAAY,UAAS,QAAW;AAClC,iBAAO,OAAO,OAAO,QAAQ,CAAC;AAC9B,iBAAO,KAAK,OAAO,yCAAY;AAAA,QACjC;AACA,eAAO;AAAA,MACT,OAAO;AACL,cAAM;AAAA,MACR;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;","names":["AsObjectFactory","isPayloadOfSchemaType","isPayloadOfSchemaType","AsObjectFactory","AsObjectFactory","isPayloadOfSchemaType","isPayloadOfSchemaType","AsObjectFactory","AsObjectFactory","isPayloadOfSchemaType","isPayloadOfSchemaType","AsObjectFactory","AsObjectFactory","AsObjectFactory","AsObjectFactory","AsObjectFactory","isPayloadOfSchemaType","isPayloadOfSchemaType","AsObjectFactory","isPayloadOfSchemaType","isPayloadOfSchemaType","AsObjectFactory","AsObjectFactory","isPayloadOfSchemaType","isPayloadOfSchemaType","AsObjectFactory","assertEx","isPayloadOfSchemaType","isPayloadOfSchemaType","assertEx"]}

package/dist/node/lib/checkIpfsUrl.d.cts

@@ -1,8 +1,2 @@
-/**
- * Returns the equivalent IPFS gateway URL for the supplied URL.
- * @param urlToCheck The URL to check
- * @returns If the supplied URL is an IPFS URL, it converts the URL to the
- * equivalent IPFS gateway URL. Otherwise, returns the original URL.
- */
 export declare const checkIpfsUrl: (urlToCheck: string, ipfsGateway?: string) => string;
 //# sourceMappingURL=checkIpfsUrl.d.ts.map

package/dist/node/lib/checkIpfsUrl.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,KAAG,MAgCvE,CAAA"}
+{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,KAAG,MAgCvE,CAAA"}

package/dist/node/lib/checkIpfsUrl.d.mts

@@ -1,8 +1,2 @@
-/**
- * Returns the equivalent IPFS gateway URL for the supplied URL.
- * @param urlToCheck The URL to check
- * @returns If the supplied URL is an IPFS URL, it converts the URL to the
- * equivalent IPFS gateway URL. Otherwise, returns the original URL.
- */
 export declare const checkIpfsUrl: (urlToCheck: string, ipfsGateway?: string) => string;
 //# sourceMappingURL=checkIpfsUrl.d.ts.map

package/dist/node/lib/checkIpfsUrl.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,KAAG,MAgCvE,CAAA"}
+{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,KAAG,MAgCvE,CAAA"}

package/dist/node/lib/checkIpfsUrl.d.ts

@@ -1,8 +1,2 @@
-/**
- * Returns the equivalent IPFS gateway URL for the supplied URL.
- * @param urlToCheck The URL to check
- * @returns If the supplied URL is an IPFS URL, it converts the URL to the
- * equivalent IPFS gateway URL. Otherwise, returns the original URL.
- */
 export declare const checkIpfsUrl: (urlToCheck: string, ipfsGateway?: string) => string;
 //# sourceMappingURL=checkIpfsUrl.d.ts.map

package/dist/node/lib/checkIpfsUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,KAAG,MAgCvE,CAAA"}
+{"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,KAAG,MAgCvE,CAAA"}

package/package.json

@@ -14,26 +14,26 @@
     "@xylabs/axios": "^3.5.1",
     "@xylabs/hex": "^3.5.1",
     "@xylabs/object": "^3.5.1",
-    "@xyo-network/abstract-witness": "next",
-    "@xyo-network/hash": "next",
-    "@xyo-network/payload-builder": "next",
-    "@xyo-network/payload-model": "next",
-    "@xyo-network/witness-model": "next",
+    "@xyo-network/abstract-witness": "^2.107.4",
+    "@xyo-network/hash": "^2.107.4",
+    "@xyo-network/payload-builder": "^2.107.4",
+    "@xyo-network/payload-model": "^2.107.4",
+    "@xyo-network/witness-model": "^2.107.4",
     "base64-js": "^1.5.1",
     "es6-dynamic-template": "^2.0.0"
   },
   "devDependencies": {
     "@xylabs/jest-helpers": "^3.5.1",
-    "@xylabs/ts-scripts-yarn3": "^3.11.2",
-    "@xylabs/tsconfig": "^3.11.2",
-    "@xyo-network/account": "next",
-    "@xyo-network/manifest": "next",
-    "@xyo-network/module-factory-locator": "next",
-    "@xyo-network/module-model": "next",
-    "@xyo-network/sentinel-model": "next",
-    "ethers": "^6.12.1",
+    "@xylabs/ts-scripts-yarn3": "^3.11.10",
+    "@xylabs/tsconfig": "^3.11.10",
+    "@xyo-network/account": "^2.107.4",
+    "@xyo-network/manifest": "^2.107.4",
+    "@xyo-network/module-factory-locator": "^2.107.4",
+    "@xyo-network/module-model": "^2.107.4",
+    "@xyo-network/sentinel-model": "^2.107.4",
+    "ethers": "^6.13.1",
     "jest": "^29.7.0",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.2"
   },
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "exports": {
@@ -74,7 +74,6 @@
     "url": "https://github.com/XYOracleNetwork/plugins.git"
   },
   "sideEffects": false,
-  "version": "2.97.0-rc.1",
-  "type": "module",
-  "stableVersion": "2.96.0"
+  "version": "2.97.1",
+  "type": "module"
 }

package/src/Payload/Schema.ts

@@ -0,0 +1,5 @@
+export const ApiCallSchema = 'network.xyo.api.call'
+export type ApiCallSchema = typeof ApiCallSchema
+
+export const ApiCallResultSchema = `${ApiCallSchema}.result`
+export type ApiCallResultSchema = typeof ApiCallResultSchema

package/src/Payload/identity/asApiCall.ts

@@ -0,0 +1,5 @@
+import { AsObjectFactory } from '@xylabs/object'
+
+import { isApiCall } from './isApiCall'
+
+export const asApiCall = AsObjectFactory.create(isApiCall)

package/src/Payload/identity/asApiCallBase64Result.ts

@@ -0,0 +1,5 @@
+import { AsObjectFactory } from '@xylabs/object'
+
+import { isApiCallBase64Result } from './isApiCallBase64Result'
+
+export const asApiCallBase64Result = AsObjectFactory.create(isApiCallBase64Result)

package/src/Payload/identity/asApiCallResult.ts

@@ -0,0 +1,5 @@
+import { AsObjectFactory } from '@xylabs/object'
+
+import { isApiCallResult } from './isApiCallResult'
+
+export const asApiCallResult = AsObjectFactory.create(isApiCallResult)

package/src/Payload/identity/asApiCallXmlResult.ts

@@ -0,0 +1,5 @@
+import { AsObjectFactory } from '@xylabs/object'
+
+import { isApiCallXmlResult } from './isApiCallXmlResult'
+
+export const asApiCallXmlResult = AsObjectFactory.create(isApiCallXmlResult)

package/src/Payload/identity/asApiUriCall.ts

@@ -0,0 +1,5 @@
+import { AsObjectFactory } from '@xylabs/object'
+
+import { isApiUriCall } from './isApiUriCall'
+
+export const asApiUriCall = AsObjectFactory.create(isApiUriCall)

package/src/Payload/identity/asApiUriTemplateCall.ts

@@ -0,0 +1,5 @@
+import { AsObjectFactory } from '@xylabs/object'
+
+import { isApiUriTemplateCall } from './isApiUriTemplateCall'
+
+export const asApiUriTemplateCall = AsObjectFactory.create(isApiUriTemplateCall)

package/src/Payload/identity/index.ts

@@ -0,0 +1,13 @@
+export * from './asApiCall'
+export * from './asApiCallBase64Result'
+export * from './asApiCallResult'
+export * from './asApiCallXmlResult'
+export * from './asApiUriCall'
+export * from './asApiUriTemplateCall'
+export * from './isApiCall'
+export * from './isApiCallBase64Result'
+export * from './isApiCallErrorResult'
+export * from './isApiCallResult'
+export * from './isApiCallXmlResult'
+export * from './isApiUriCall'
+export * from './isApiUriTemplateCall'

package/src/Payload/identity/isApiCall.ts

@@ -0,0 +1,6 @@
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import { ApiCallSchema } from '../Schema'
+import { ApiCall } from '../types'
+
+export const isApiCall = isPayloadOfSchemaType<ApiCall>(ApiCallSchema)

package/src/Payload/identity/isApiCallBase64Result.ts

@@ -0,0 +1,8 @@
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import { ApiCallResultSchema } from '../Schema'
+import { ApiCallBase64Result } from '../types'
+
+export const isApiCallBase64Result = (x?: unknown | null): x is ApiCallBase64Result => {
+  return isPayloadOfSchemaType(ApiCallResultSchema)(x) && typeof (x as ApiCallBase64Result)?.data === 'string'
+}

package/src/Payload/identity/isApiCallErrorResult.ts

@@ -0,0 +1,7 @@
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import { ApiCallResultSchema } from '../Schema'
+import { ApiCallErrorResult, ApiCallResult } from '../types'
+
+export const isApiCallErrorResult = (value: unknown): value is ApiCallErrorResult =>
+  !!isPayloadOfSchemaType<ApiCallResult>(ApiCallResultSchema) && ((value as ApiCallErrorResult).http?.status ?? 200) >= 400

package/src/Payload/identity/isApiCallResult.ts

@@ -0,0 +1,6 @@
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import { ApiCallResultSchema } from '../Schema'
+import { ApiCallResult } from '../types'
+
+export const isApiCallResult = isPayloadOfSchemaType<ApiCallResult>(ApiCallResultSchema)

package/src/Payload/identity/isApiCallXmlResult.ts

@@ -0,0 +1,8 @@
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import { ApiCallResultSchema } from '../Schema'
+import { ApiCallXmlResult } from '../types'
+
+export const isApiCallXmlResult = (x?: unknown | null): x is ApiCallXmlResult => {
+  return isPayloadOfSchemaType(ApiCallResultSchema)(x) && typeof (x as ApiCallXmlResult)?.data === 'string'
+}

package/src/Payload/identity/isApiUriCall.ts

@@ -0,0 +1,4 @@
+import { ApiUriCall } from '../types'
+import { isApiCall } from './isApiCall'
+
+export const isApiUriCall = (value?: unknown): value is ApiUriCall => isApiCall(value) && !!(value as ApiUriCall).uri

package/src/Payload/identity/isApiUriTemplateCall.ts

@@ -0,0 +1,5 @@
+import { ApiUriTemplateCall } from '../types'
+import { isApiCall } from './isApiCall'
+
+export const isApiUriTemplateCall = (value?: unknown): value is ApiUriTemplateCall =>
+  isApiCall(value) && !!((value as ApiUriTemplateCall).uriTemplate || (value as ApiUriTemplateCall).params)

package/src/Payload/index.ts

@@ -0,0 +1,3 @@
+export * from './identity'
+export * from './Schema'
+export * from './types'

package/src/Payload/types/ApiCall.ts

@@ -0,0 +1,4 @@
+import { ApiUriCall } from './ApiUriCall'
+import { ApiUriTemplateCall } from './ApiUriTemplateCall'
+
+export type ApiCall = ApiUriCall | ApiUriTemplateCall

package/src/Payload/types/ApiCallBase64Result.ts

@@ -0,0 +1,15 @@
+import { Hash } from '@xylabs/hex'
+import { Payload } from '@xyo-network/payload-model'
+
+import { ApiCallResultSchema } from '../Schema'
+import { ApiCallJsonResult } from './ApiCallJsonResult'
+import { ApiCallXmlResult } from './ApiCallXmlResult'
+
+export type ApiCallBase64Result = Payload<
+  {
+    call: Hash
+    contentType: Exclude<Exclude<string, ApiCallJsonResult['contentType']>, ApiCallXmlResult['contentType']>
+    data: string
+  },
+  ApiCallResultSchema
+>

package/src/Payload/types/ApiCallErrorResult.ts

@@ -0,0 +1,13 @@
+import { Hash } from '@xylabs/hex'
+import { Payload } from '@xyo-network/payload-model'
+
+import { ApiCallResultSchema } from '../Schema'
+import { HttpMeta } from './HttpMeta'
+
+export type ApiCallErrorResult = Payload<
+  {
+    call: Hash
+    http?: HttpMeta
+  },
+  ApiCallResultSchema
+>

package/src/Payload/types/ApiCallFields.ts

@@ -0,0 +1,8 @@
+import { Queries } from './Queries'
+import { Verb } from './Verb'
+
+export interface ApiCallFields {
+  headers?: Record<string, string | undefined>
+  queries?: Queries
+  verb?: Verb
+}

package/src/Payload/types/ApiCallJsonResult.ts

@@ -0,0 +1,21 @@
+import { Hash } from '@xylabs/hex'
+import { AsObjectFactory, JsonArray, JsonObject } from '@xylabs/object'
+import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
+
+import { ApiCallResultSchema } from '../Schema'
+
+export type ApiCallJsonResultType = JsonArray | JsonObject
+
+export type ApiCallJsonResult<T extends ApiCallJsonResultType = ApiCallJsonResultType> = Payload<
+  {
+    call: Hash
+    contentType: 'application/json'
+    data: T
+  },
+  ApiCallResultSchema
+>
+
+export const isApiCallJsonResult = <T extends ApiCallJsonResultType = ApiCallJsonResultType>(x?: unknown | null): x is ApiCallJsonResult<T> => {
+  return isPayloadOfSchemaType(ApiCallResultSchema)(x) && (x as ApiCallJsonResult)?.contentType === 'application/json'
+}
+export const asApiCallJsonResult = AsObjectFactory.create(isApiCallJsonResult)

package/src/Payload/types/ApiCallResult.ts

@@ -0,0 +1,12 @@
+import { JsonArray, JsonObject } from '@xylabs/object'
+
+import { ApiCallBase64Result } from './ApiCallBase64Result'
+import { ApiCallErrorResult } from './ApiCallErrorResult'
+import { ApiCallJsonResult } from './ApiCallJsonResult'
+
+type NewType = JsonObject
+
+export type ApiCallResult<TJson extends JsonArray | JsonObject = JsonArray | NewType> =
+  | ApiCallBase64Result
+  | ApiCallJsonResult<TJson>
+  | ApiCallErrorResult

package/src/Payload/types/ApiCallXmlResult.ts

@@ -0,0 +1,13 @@
+import { Hash } from '@xylabs/hex'
+import { Payload } from '@xyo-network/payload-model'
+
+import { ApiCallResultSchema } from '../Schema'
+
+export type ApiCallXmlResult = Payload<
+  {
+    call: Hash
+    contentType: 'application/xml' | 'text/xml'
+    data: string
+  },
+  ApiCallResultSchema
+>

package/src/Payload/types/ApiUriCall.ts

@@ -0,0 +1,11 @@
+import { Payload } from '@xyo-network/payload-model'
+
+import { ApiCallSchema } from '../Schema'
+import { ApiCallFields } from './ApiCallFields'
+
+export type ApiUriCall = Payload<
+  ApiCallFields & {
+    uri: string
+  },
+  ApiCallSchema
+>

package/src/Payload/types/ApiUriTemplateCall.ts

@@ -0,0 +1,12 @@
+import { Payload } from '@xyo-network/payload-model'
+
+import { ApiCallSchema } from '../Schema'
+import { ApiCallFields } from './ApiCallFields'
+
+export type ApiUriTemplateCall = Payload<
+  ApiCallFields & {
+    params?: Record<string, string>
+    uriTemplate?: string
+  },
+  ApiCallSchema
+>

package/src/Payload/types/HttpMeta.ts

@@ -0,0 +1,4 @@
+export interface HttpMeta {
+  code?: string
+  status?: number
+}

package/src/Payload/types/MimeTypes.ts

@@ -0,0 +1,13 @@
+// TODO: Bring in from some library or package for completeness
+export type MimeTypes =
+  | 'application/json' // JSON format
+  | 'application/octet-stream' // Binary data
+  | 'application/pdf' // PDF format
+  | 'application/xhtml+xml' // XHTML format
+  | 'application/xml' // XML format
+  | 'image/gif' // GIF image format
+  | 'image/jpeg' // JPEG image format
+  | 'image/png' // PNG image format
+  | 'text/html' // HTML format
+  | 'text/plain' // Plain text format
+  | 'text/xml' // XML format (alternative)

package/src/Payload/types/Queries.ts

@@ -0,0 +1 @@
+export type Queries = Record<string, string>

package/src/Payload/types/Verb.ts

@@ -0,0 +1 @@
+export type Verb = 'get' | 'post'

package/src/Payload/types/index.ts

@@ -0,0 +1,13 @@
+export * from './ApiCall'
+export * from './ApiCallBase64Result'
+export * from './ApiCallErrorResult'
+export * from './ApiCallFields'
+export * from './ApiCallJsonResult'
+export * from './ApiCallResult'
+export * from './ApiCallXmlResult'
+export * from './ApiUriCall'
+export * from './ApiUriTemplateCall'
+export * from './HttpMeta'
+export * from './MimeTypes'
+export * from './Queries'
+export * from './Verb'

package/src/{Config.ts → Witness/Config.ts}

@@ -2,13 +2,11 @@ import { AsObjectFactory } from '@xylabs/object'
 import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
 import { WitnessConfig } from '@xyo-network/witness-model'
 
-import { ApiCall, ApiUriCall, ApiUriTemplateCall } from './Payload'
-
-export const ApiCallWitnessConfigSchema = 'network.xyo.api.call.witness.config'
-export type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema
+import { ApiCall, ApiUriCall, ApiUriTemplateCall, MimeTypes } from '../Payload'
+import { ApiCallWitnessConfigSchema } from './Schema'
 
 export type ApiCallWitnessConfigBase = WitnessConfig<{
-  accept?: 'application/json'
+  accept?: MimeTypes
   headers?: Record<string, string | undefined>
   queries?: ApiCall['queries']
   schema: ApiCallWitnessConfigSchema

package/src/Witness/Params.ts

@@ -0,0 +1,11 @@
+import { WitnessParams } from '@xyo-network/witness-model'
+
+import { ApiCallWitnessConfig } from './Config'
+
+export type ApiCallWitnessParams = WitnessParams<
+  ApiCallWitnessConfig,
+  {
+    headers?: Record<string, string | undefined>
+    ipfsGateway?: string
+  }
+>

package/src/Witness/Schema.ts

@@ -0,0 +1,2 @@
+export const ApiCallWitnessConfigSchema = 'network.xyo.api.call.witness.config'
+export type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema

package/src/{Witness.ts → Witness/Witness.ts}

@@ -6,12 +6,10 @@ import { AbstractWitness } from '@xyo-network/abstract-witness'
 import { PayloadHasher } from '@xyo-network/hash'
 import { PayloadBuilder } from '@xyo-network/payload-builder'
 import { isPayloadOfSchemaType, Schema } from '@xyo-network/payload-model'
-import { WitnessParams } from '@xyo-network/witness-model'
 import { fromByteArray } from 'base64-js'
 import fillTemplate from 'es6-dynamic-template'
 
-import { ApiCallWitnessConfig, ApiCallWitnessConfigSchema, asApiUriCallWitnessConfig, asApiUriTemplateCallWitnessConfig } from './Config'
-import { checkIpfsUrl } from './lib'
+import { checkIpfsUrl } from '../lib'
 import {
   ApiCall,
   ApiCallBase64Result,
@@ -21,23 +19,20 @@ import {
   ApiCallResult,
   ApiCallResultSchema,
   ApiCallSchema,
+  ApiCallXmlResult,
   asApiUriCall,
   asApiUriTemplateCall,
-} from './Payload'
-
-export type ApiCallWitnessParams = WitnessParams<
-  ApiCallWitnessConfig,
-  {
-    headers?: Record<string, string | undefined>
-    ipfsGateway?: string
-  }
->
+  MimeTypes,
+} from '../Payload'
+import { asApiUriCallWitnessConfig, asApiUriTemplateCallWitnessConfig } from './Config'
+import { ApiCallWitnessParams } from './Params'
+import { ApiCallWitnessConfigSchema } from './Schema'
 
 export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnessParams> extends AbstractWitness<TParams, ApiCall, ApiCallResult> {
   static override readonly configSchemas: Schema[] = [...super.configSchemas, ApiCallWitnessConfigSchema]
   static override readonly defaultConfigSchema: Schema = ApiCallWitnessConfigSchema
 
-  get accept() {
+  get accept(): MimeTypes {
     return this.config.accept ?? 'application/json'
   }
 
@@ -136,6 +131,26 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
           }
           break
         }
+        case 'application/xml':
+        case 'text/xml': {
+          const axios = new Axios({
+            headers: { ...this.getHeaders(headers), Accept: this.accept },
+            responseType: 'arraybuffer',
+            timeout: this.timeout,
+          })
+          const response = await axios.get(url)
+          if (response.status >= 200 && response.status < 300) {
+            const xmlResult = result as ApiCallXmlResult
+            xmlResult.data = Buffer.from(response.data, 'binary').toString('utf8')
+            xmlResult.contentType = response.headers['content-type']?.toString() ?? 'application/xml'
+          } else {
+            const errorResult = result as ApiCallErrorResult
+            errorResult.http = {
+              status: response.status,
+            }
+          }
+          break
+        }
         default: {
           const axios = new Axios({ headers: this.params.headers, responseType: 'arraybuffer', timeout: this.timeout })
           const response = await axios.get(url)

package/src/Witness/index.ts

@@ -0,0 +1,4 @@
+export * from './Config'
+export * from './Params'
+export * from './Schema'
+export * from './Witness'

package/src/index.ts

@@ -1,3 +1,2 @@
-export * from './Config'
 export * from './Payload'
 export * from './Witness'

package/dist/browser/Config.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE1D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAEnE,eAAO,MAAM,0BAA0B,wCAAwC,CAAA;AAC/E,MAAM,MAAM,0BAA0B,GAAG,OAAO,0BAA0B,CAAA;AAE1E,MAAM,MAAM,wBAAwB,GAAG,aAAa,CAAC;IACnD,MAAM,CAAC,EAAE,kBAAkB,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;IAC5B,MAAM,EAAE,0BAA0B,CAAA;IAClC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;CACvB,CAAC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,aAAa,CACjD,wBAAwB,GAAG;IACzB,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAA;CACvB,CACF,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG,aAAa,CACzD,wBAAwB,GAAG;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,WAAW,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAAA;CAC/C,CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,uBAAuB,GAAG,+BAA+B,GAAG,wBAAwB,CAAA;AAEvH,eAAO,MAAM,sBAAsB,4CAA0E,CAAA;AAC7G,eAAO,MAAM,sBAAsB;;;CAAiD,CAAA;AAEpF,eAAO,MAAM,yBAAyB,WAAY,OAAO;;;;;;;cAxB7C,OAAO,CAAC,SAAS,CAAC;YACpB,0BAA0B;;WAE3B,OAAO,CAAC,MAAM,CAAC;;;;SAKf,UAAU,CAAC,KAAK,CAAC;;;CAiBiD,CAAA;AAC3E,eAAO,MAAM,yBAAyB;;;;;;;;kBA1B1B,OAAO,CAAC,SAAS,CAAC;gBACpB,0BAA0B;;eAE3B,OAAO,CAAC,MAAM,CAAC;;;;aAKf,UAAU,CAAC,KAAK,CAAC;;;;;;;;;;;kBARd,OAAO,CAAC,SAAS,CAAC;gBACpB,0BAA0B;;eAE3B,OAAO,CAAC,MAAM,CAAC;;;;aAKf,UAAU,CAAC,KAAK,CAAC;;;;;;;;;;kBARd,OAAO,CAAC,SAAS,CAAC;gBACpB,0BAA0B;;eAE3B,OAAO,CAAC,MAAM,CAAC;;;;aAKf,UAAU,CAAC,KAAK,CAAC;;;;CAkBgE,CAAA;AAE1F,eAAO,MAAM,iCAAiC,WAAY,OAAO;;;;;;;cA5BrD,OAAO,CAAC,SAAS,CAAC;YACpB,0BAA0B;;WAE3B,OAAO,CAAC,MAAM,CAAC;;;;;iBAYP,kBAAkB,CAAC,aAAa,CAAC;;;CAcyC,CAAA;AAC3F,eAAO,MAAM,iCAAiC;;;;;;;;kBA9BlC,OAAO,CAAC,SAAS,CAAC;gBACpB,0BAA0B;;eAE3B,OAAO,CAAC,MAAM,CAAC;;;;;qBAYP,kBAAkB,CAAC,aAAa,CAAC;;;;;;;;;;;kBAftC,OAAO,CAAC,SAAS,CAAC;gBACpB,0BAA0B;;eAE3B,OAAO,CAAC,MAAM,CAAC;;;;;qBAYP,kBAAkB,CAAC,aAAa,CAAC;;;;;;;;;;kBAftC,OAAO,CAAC,SAAS,CAAC;gBACpB,0BAA0B;;eAE3B,OAAO,CAAC,MAAM,CAAC;;;;;qBAYP,kBAAkB,CAAC,aAAa,CAAC;;;;CAewD,CAAA"}