@xyo-network/http-call-witness 3.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (126) hide show
  1. package/LICENSE +165 -0
  2. package/README.md +13 -0
  3. package/dist/neutral/Payload/Schema.d.ts +5 -0
  4. package/dist/neutral/Payload/Schema.d.ts.map +1 -0
  5. package/dist/neutral/Payload/identity/asHttpCall.d.ts +5 -0
  6. package/dist/neutral/Payload/identity/asHttpCall.d.ts.map +1 -0
  7. package/dist/neutral/Payload/identity/asHttpCallBase64Result.d.ts +23 -0
  8. package/dist/neutral/Payload/identity/asHttpCallBase64Result.d.ts.map +1 -0
  9. package/dist/neutral/Payload/identity/asHttpCallResult.d.ts +5 -0
  10. package/dist/neutral/Payload/identity/asHttpCallResult.d.ts.map +1 -0
  11. package/dist/neutral/Payload/identity/asHttpCallXmlResult.d.ts +23 -0
  12. package/dist/neutral/Payload/identity/asHttpCallXmlResult.d.ts.map +1 -0
  13. package/dist/neutral/Payload/identity/asHttpUriCall.d.ts +17 -0
  14. package/dist/neutral/Payload/identity/asHttpUriCall.d.ts.map +1 -0
  15. package/dist/neutral/Payload/identity/asHttpUriTemplateCall.d.ts +20 -0
  16. package/dist/neutral/Payload/identity/asHttpUriTemplateCall.d.ts.map +1 -0
  17. package/dist/neutral/Payload/identity/index.d.ts +14 -0
  18. package/dist/neutral/Payload/identity/index.d.ts.map +1 -0
  19. package/dist/neutral/Payload/identity/isHttpCall.d.ts +3 -0
  20. package/dist/neutral/Payload/identity/isHttpCall.d.ts.map +1 -0
  21. package/dist/neutral/Payload/identity/isHttpCallBase64Result.d.ts +3 -0
  22. package/dist/neutral/Payload/identity/isHttpCallBase64Result.d.ts.map +1 -0
  23. package/dist/neutral/Payload/identity/isHttpCallErrorResult.d.ts +3 -0
  24. package/dist/neutral/Payload/identity/isHttpCallErrorResult.d.ts.map +1 -0
  25. package/dist/neutral/Payload/identity/isHttpCallResult.d.ts +3 -0
  26. package/dist/neutral/Payload/identity/isHttpCallResult.d.ts.map +1 -0
  27. package/dist/neutral/Payload/identity/isHttpCallXmlResult.d.ts +3 -0
  28. package/dist/neutral/Payload/identity/isHttpCallXmlResult.d.ts.map +1 -0
  29. package/dist/neutral/Payload/identity/isHttpUriCall.d.ts +3 -0
  30. package/dist/neutral/Payload/identity/isHttpUriCall.d.ts.map +1 -0
  31. package/dist/neutral/Payload/identity/isHttpUriTemplateCall.d.ts +3 -0
  32. package/dist/neutral/Payload/identity/isHttpUriTemplateCall.d.ts.map +1 -0
  33. package/dist/neutral/Payload/index.d.ts +4 -0
  34. package/dist/neutral/Payload/index.d.ts.map +1 -0
  35. package/dist/neutral/Payload/types/HttpCall.d.ts +4 -0
  36. package/dist/neutral/Payload/types/HttpCall.d.ts.map +1 -0
  37. package/dist/neutral/Payload/types/HttpCallBase64Result.d.ts +11 -0
  38. package/dist/neutral/Payload/types/HttpCallBase64Result.d.ts.map +1 -0
  39. package/dist/neutral/Payload/types/HttpCallErrorResult.d.ts +9 -0
  40. package/dist/neutral/Payload/types/HttpCallErrorResult.d.ts.map +1 -0
  41. package/dist/neutral/Payload/types/HttpCallFields.d.ts +8 -0
  42. package/dist/neutral/Payload/types/HttpCallFields.d.ts.map +1 -0
  43. package/dist/neutral/Payload/types/HttpCallHtmlResult.d.ts +9 -0
  44. package/dist/neutral/Payload/types/HttpCallHtmlResult.d.ts.map +1 -0
  45. package/dist/neutral/Payload/types/HttpCallJsonResult.d.ts +34 -0
  46. package/dist/neutral/Payload/types/HttpCallJsonResult.d.ts.map +1 -0
  47. package/dist/neutral/Payload/types/HttpCallResult.d.ts +8 -0
  48. package/dist/neutral/Payload/types/HttpCallResult.d.ts.map +1 -0
  49. package/dist/neutral/Payload/types/HttpCallXmlResult.d.ts +9 -0
  50. package/dist/neutral/Payload/types/HttpCallXmlResult.d.ts.map +1 -0
  51. package/dist/neutral/Payload/types/HttpMeta.d.ts +5 -0
  52. package/dist/neutral/Payload/types/HttpMeta.d.ts.map +1 -0
  53. package/dist/neutral/Payload/types/HttpUriCall.d.ts +7 -0
  54. package/dist/neutral/Payload/types/HttpUriCall.d.ts.map +1 -0
  55. package/dist/neutral/Payload/types/HttpUriTemplateCall.d.ts +8 -0
  56. package/dist/neutral/Payload/types/HttpUriTemplateCall.d.ts.map +1 -0
  57. package/dist/neutral/Payload/types/MimeTypes.d.ts +2 -0
  58. package/dist/neutral/Payload/types/MimeTypes.d.ts.map +1 -0
  59. package/dist/neutral/Payload/types/Queries.d.ts +2 -0
  60. package/dist/neutral/Payload/types/Queries.d.ts.map +1 -0
  61. package/dist/neutral/Payload/types/Verb.d.ts +2 -0
  62. package/dist/neutral/Payload/types/Verb.d.ts.map +1 -0
  63. package/dist/neutral/Payload/types/index.d.ts +15 -0
  64. package/dist/neutral/Payload/types/index.d.ts.map +1 -0
  65. package/dist/neutral/Witness/Config.d.ts +140 -0
  66. package/dist/neutral/Witness/Config.d.ts.map +1 -0
  67. package/dist/neutral/Witness/Params.d.ts +7 -0
  68. package/dist/neutral/Witness/Params.d.ts.map +1 -0
  69. package/dist/neutral/Witness/Schema.d.ts +3 -0
  70. package/dist/neutral/Witness/Schema.d.ts.map +1 -0
  71. package/dist/neutral/Witness/Witness.d.ts +16 -0
  72. package/dist/neutral/Witness/Witness.d.ts.map +1 -0
  73. package/dist/neutral/Witness/index.d.ts +5 -0
  74. package/dist/neutral/Witness/index.d.ts.map +1 -0
  75. package/dist/neutral/index.d.ts +3 -0
  76. package/dist/neutral/index.d.ts.map +1 -0
  77. package/dist/neutral/index.mjs +349 -0
  78. package/dist/neutral/index.mjs.map +1 -0
  79. package/dist/neutral/lib/checkIpfsUrl.d.ts +2 -0
  80. package/dist/neutral/lib/checkIpfsUrl.d.ts.map +1 -0
  81. package/dist/neutral/lib/index.d.ts +2 -0
  82. package/dist/neutral/lib/index.d.ts.map +1 -0
  83. package/package.json +62 -0
  84. package/src/Payload/Schema.ts +5 -0
  85. package/src/Payload/identity/asHttpCall.ts +5 -0
  86. package/src/Payload/identity/asHttpCallBase64Result.ts +5 -0
  87. package/src/Payload/identity/asHttpCallResult.ts +5 -0
  88. package/src/Payload/identity/asHttpCallXmlResult.ts +5 -0
  89. package/src/Payload/identity/asHttpUriCall.ts +5 -0
  90. package/src/Payload/identity/asHttpUriTemplateCall.ts +5 -0
  91. package/src/Payload/identity/index.ts +13 -0
  92. package/src/Payload/identity/isHttpCall.ts +6 -0
  93. package/src/Payload/identity/isHttpCallBase64Result.ts +8 -0
  94. package/src/Payload/identity/isHttpCallErrorResult.ts +7 -0
  95. package/src/Payload/identity/isHttpCallResult.ts +6 -0
  96. package/src/Payload/identity/isHttpCallXmlResult.ts +8 -0
  97. package/src/Payload/identity/isHttpUriCall.ts +4 -0
  98. package/src/Payload/identity/isHttpUriTemplateCall.ts +5 -0
  99. package/src/Payload/index.ts +3 -0
  100. package/src/Payload/types/HttpCall.ts +4 -0
  101. package/src/Payload/types/HttpCallBase64Result.ts +15 -0
  102. package/src/Payload/types/HttpCallErrorResult.ts +13 -0
  103. package/src/Payload/types/HttpCallFields.ts +8 -0
  104. package/src/Payload/types/HttpCallHtmlResult.ts +13 -0
  105. package/src/Payload/types/HttpCallJsonResult.ts +23 -0
  106. package/src/Payload/types/HttpCallResult.ts +12 -0
  107. package/src/Payload/types/HttpCallXmlResult.ts +13 -0
  108. package/src/Payload/types/HttpMeta.ts +4 -0
  109. package/src/Payload/types/HttpUriCall.ts +11 -0
  110. package/src/Payload/types/HttpUriTemplateCall.ts +12 -0
  111. package/src/Payload/types/MimeTypes.ts +13 -0
  112. package/src/Payload/types/Queries.ts +1 -0
  113. package/src/Payload/types/Verb.ts +1 -0
  114. package/src/Payload/types/index.ts +14 -0
  115. package/src/Witness/Config.ts +43 -0
  116. package/src/Witness/Params.ts +11 -0
  117. package/src/Witness/Schema.ts +2 -0
  118. package/src/Witness/Witness.ts +219 -0
  119. package/src/Witness/index.ts +4 -0
  120. package/src/Witness/spec/opensea.nft-call.json +41 -0
  121. package/src/index.ts +2 -0
  122. package/src/lib/checkIpfsUrl.ts +44 -0
  123. package/src/lib/index.ts +1 -0
  124. package/src/types.d.ts +1 -0
  125. package/typedoc.json +5 -0
  126. package/xy.config.ts +10 -0
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/Payload/identity/asHttpCall.ts","../../src/Payload/identity/isHttpCall.ts","../../src/Payload/Schema.ts","../../src/Payload/identity/asHttpCallBase64Result.ts","../../src/Payload/identity/isHttpCallBase64Result.ts","../../src/Payload/identity/asHttpCallResult.ts","../../src/Payload/identity/isHttpCallResult.ts","../../src/Payload/identity/asHttpCallXmlResult.ts","../../src/Payload/identity/isHttpCallXmlResult.ts","../../src/Payload/identity/asHttpUriCall.ts","../../src/Payload/identity/isHttpUriCall.ts","../../src/Payload/identity/asHttpUriTemplateCall.ts","../../src/Payload/identity/isHttpUriTemplateCall.ts","../../src/Payload/identity/isHttpCallErrorResult.ts","../../src/Payload/types/HttpCallJsonResult.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 { isHttpCall } from './isHttpCall.ts'\n\nexport const asApiCall = AsObjectFactory.create(isHttpCall)\n","import { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { HttpCallSchema } from '../Schema.ts'\nimport type { HttpCall } from '../types/index.ts'\n\nexport const isHttpCall = isPayloadOfSchemaType<HttpCall>(HttpCallSchema)\n","export const HttpCallSchema = 'network.xyo.http.call'\nexport type HttpCallSchema = typeof HttpCallSchema\n\nexport const HttpCallResultSchema = `${HttpCallSchema}.result`\nexport type HttpCallResultSchema = typeof HttpCallResultSchema\n","import { AsObjectFactory } from '@xylabs/object'\n\nimport { isHttpCallBase64Result } from './isHttpCallBase64Result.ts'\n\nexport const asHttpCallBase64Result = AsObjectFactory.create(isHttpCallBase64Result)\n","import { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { HttpCallResultSchema } from '../Schema.ts'\nimport type { HttpCallBase64Result } from '../types/index.ts'\n\nexport const isHttpCallBase64Result = (x?: unknown | null): x is HttpCallBase64Result => {\n return isPayloadOfSchemaType(HttpCallResultSchema)(x) && typeof (x as HttpCallBase64Result)?.data === 'string'\n}\n","import { AsObjectFactory } from '@xylabs/object'\n\nimport { isHttpCallResult } from './isHttpCallResult.ts'\n\nexport const asHttpCallResult = AsObjectFactory.create(isHttpCallResult)\n","import { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { HttpCallResultSchema } from '../Schema.ts'\nimport type { HttpCallResult } from '../types/index.ts'\n\nexport const isHttpCallResult = isPayloadOfSchemaType<HttpCallResult>(HttpCallResultSchema)\n","import { AsObjectFactory } from '@xylabs/object'\n\nimport { isHttpCallXmlResult } from './isHttpCallXmlResult.ts'\n\nexport const asHttpCallXmlResult = AsObjectFactory.create(isHttpCallXmlResult)\n","import { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { HttpCallResultSchema } from '../Schema.ts'\nimport type { HttpCallXmlResult } from '../types/index.ts'\n\nexport const isHttpCallXmlResult = (x?: unknown | null): x is HttpCallXmlResult => {\n return isPayloadOfSchemaType(HttpCallResultSchema)(x) && typeof (x as HttpCallXmlResult)?.data === 'string'\n}\n","import { AsObjectFactory } from '@xylabs/object'\n\nimport { isHttpUriCall } from './isHttpUriCall.ts'\n\nexport const asHttpUriCall = AsObjectFactory.create(isHttpUriCall)\n","import type { HttpUriCall } from '../types/index.ts'\nimport { isHttpCall } from './isHttpCall.ts'\n\nexport const isHttpUriCall = (value?: unknown): value is HttpUriCall => isHttpCall(value) && !!(value as HttpUriCall).uri\n","import { AsObjectFactory } from '@xylabs/object'\n\nimport { isHttpUriTemplateCall } from './isHttpUriTemplateCall.ts'\n\nexport const asHttpUriTemplateCall = AsObjectFactory.create(isHttpUriTemplateCall)\n","import type { HttpUriTemplateCall } from '../types/index.ts'\nimport { isHttpCall } from './isHttpCall.ts'\n\nexport const isHttpUriTemplateCall = (value?: unknown): value is HttpUriTemplateCall =>\n isHttpCall(value) && !!((value as HttpUriTemplateCall).uriTemplate || (value as HttpUriTemplateCall).params)\n","import { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { HttpCallResultSchema } from '../Schema.ts'\nimport type { HttpCallErrorResult, HttpCallResult } from '../types/index.ts'\n\nexport const isHttpCallErrorResult = (value: unknown): value is HttpCallErrorResult =>\n !!isPayloadOfSchemaType<HttpCallResult>(HttpCallResultSchema) && ((value as HttpCallErrorResult).http?.status ?? 200) >= 400\n","import type { Hash } from '@xylabs/hex'\nimport type { JsonArray, JsonObject } from '@xylabs/object'\nimport { AsObjectFactory } from '@xylabs/object'\nimport type { Payload } from '@xyo-network/payload-model'\nimport { isPayloadOfSchemaType } from '@xyo-network/payload-model'\n\nimport { HttpCallResultSchema } from '../Schema.ts'\n\nexport type HttpCallJsonResultType = JsonArray | JsonObject\n\nexport type HttpCallJsonResult<T extends HttpCallJsonResultType = HttpCallJsonResultType> = Payload<\n {\n call: Hash\n contentType: 'application/json'\n data: T\n },\n HttpCallResultSchema\n>\n\nexport const isHttpCallJsonResult = <T extends HttpCallJsonResultType = HttpCallJsonResultType>(x?: unknown | null): x is HttpCallJsonResult<T> => {\n return isPayloadOfSchemaType(HttpCallResultSchema)(x) && (x as HttpCallJsonResult)?.contentType === 'application/json'\n}\nexport const asHttpCallJsonResult = AsObjectFactory.create(isHttpCallJsonResult)\n","import { AsObjectFactory } from '@xylabs/object'\nimport { isPayloadOfSchemaType } from '@xyo-network/payload-model'\nimport type { WitnessConfig } from '@xyo-network/witness-model'\n\nimport type {\n HttpCall, HttpUriCall, HttpUriTemplateCall, MimeTypes,\n} from '../Payload/index.ts'\nimport { HttpCallWitnessConfigSchema } from './Schema.ts'\n\nexport type HttpCallWitnessConfigBase = WitnessConfig<{\n accept?: MimeTypes\n headers?: Record<string, string | undefined>\n queries?: HttpCall['queries']\n schema: HttpCallWitnessConfigSchema\n timeout?: number\n verb?: HttpCall['verb']\n}>\n\nexport type HttpUriCallWitnessConfig = WitnessConfig<\n HttpCallWitnessConfigBase & {\n uri: HttpUriCall['uri']\n }\n>\n\nexport type HttpUriTemplateCallWitnessConfig = WitnessConfig<\n HttpCallWitnessConfigBase & {\n params?: Record<string, string>\n uriTemplate: HttpUriTemplateCall['uriTemplate']\n }\n>\n\nexport type HttpCallWitnessConfig = HttpUriCallWitnessConfig | HttpUriTemplateCallWitnessConfig | HttpCallWitnessConfigBase\n\nexport const isHttpCallWitnessConfig = isPayloadOfSchemaType<HttpCallWitnessConfig>(HttpCallWitnessConfigSchema)\nexport const asHttpCallWitnessConfig = AsObjectFactory.create(isHttpCallWitnessConfig)\n\nexport const isHttpUriCallWitnessConfig = (value?: unknown): value is HttpUriCallWitnessConfig =>\n isHttpCallWitnessConfig(value) && !!(value as HttpUriCallWitnessConfig).uri\nexport const asHttpUriCallWitnessConfig = AsObjectFactory.create(isHttpUriCallWitnessConfig)\n\nexport const isHttpUriTemplateCallWitnessConfig = (value?: unknown): value is HttpUriTemplateCallWitnessConfig =>\n isHttpCallWitnessConfig(value) && !!(value as HttpUriTemplateCallWitnessConfig).uriTemplate\nexport const asHttpUriTemplateCallWitnessConfig = AsObjectFactory.create(isHttpUriTemplateCallWitnessConfig)\n","export const HttpCallWitnessConfigSchema = 'network.xyo.http.call.witness.config'\nexport type HttpCallWitnessConfigSchema = typeof HttpCallWitnessConfigSchema\n","/* eslint-disable max-statements */\nimport { assertEx } from '@xylabs/assert'\nimport { AxiosJson } from '@xylabs/axios'\nimport type { Hash } from '@xylabs/hex'\nimport { URL } from '@xylabs/url'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport { PayloadHasher } from '@xyo-network/hash'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Schema } from '@xyo-network/payload-model'\nimport { isPayloadOfSchemaType } from '@xyo-network/payload-model'\nimport type { AxiosError } from 'axios'\nimport { Axios } from 'axios'\nimport { fromByteArray } from 'base64-js'\nimport fillTemplate from 'es6-dynamic-template'\n\nimport { checkIpfsUrl } from '../lib/index.ts'\nimport type {\n HttpCall,\n HttpCallBase64Result,\n HttpCallErrorResult,\n HttpCallJsonResult,\n HttpCallJsonResultType,\n HttpCallResult,\n HttpCallXmlResult,\n MimeTypes,\n} from '../Payload/index.ts'\nimport {\n asHttpUriCall,\n asHttpUriTemplateCall,\n HttpCallResultSchema,\n HttpCallSchema,\n} from '../Payload/index.ts'\nimport type { HttpCallHtmlResult } from '../Payload/types/index.ts'\nimport { asHttpUriCallWitnessConfig, asHttpUriTemplateCallWitnessConfig } from './Config.ts'\nimport type { HttpCallWitnessParams } from './Params.ts'\nimport { HttpCallWitnessConfigSchema } from './Schema.ts'\n\nexport class HttpCallWitness<TParams extends HttpCallWitnessParams = HttpCallWitnessParams> extends AbstractWitness<TParams, HttpCall, HttpCallResult> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, HttpCallWitnessConfigSchema]\n static override readonly defaultConfigSchema: Schema = HttpCallWitnessConfigSchema\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?: HttpCall): string {\n const { uri: callUri } = asHttpUriCall(call) ?? {}\n const {\n uriTemplate: callUriTemplate, params: callParams, queries: callQueries,\n } = asHttpUriTemplateCall(call) ?? {}\n const { uri: configUri } = asHttpUriCallWitnessConfig(this.config) ?? {}\n const {\n uriTemplate: configUriTemplate, params: configParams, queries: configQueries,\n } = asHttpUriTemplateCallWitnessConfig(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 {\n ...this.params.headers, ...this.config.headers, ...headers,\n }\n }\n\n protected override async observeHandler(inPayloads: HttpCall[] = []): Promise<HttpCallResult[]> {\n await this.started('throw')\n try {\n const observations = await Promise.all(\n inPayloads.filter(isPayloadOfSchemaType(HttpCallSchema)).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: HttpCallResult = {\n call: await PayloadHasher.hash(call),\n schema: HttpCallResultSchema,\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 // eslint-disable-next-line complexity\n private async httpGet(url: string, call: Hash, headers?: Record<string, string | undefined>): Promise<HttpCallResult> {\n const result: HttpCallResult = {\n call,\n schema: HttpCallResultSchema,\n }\n try {\n switch (this.accept) {\n case 'application/json': {\n const axios = new AxiosJson({\n headers: { ...this.getHeaders(headers), Accept: 'application/json' }, timeout: this.timeout, decompress: true,\n })\n const response = await axios.get<HttpCallJsonResultType>(url)\n if (response.status >= 200 && response.status < 300) {\n const jsonResult = result as HttpCallJsonResult\n jsonResult.data = response.data\n jsonResult.contentType = 'application/json'\n } else {\n const errorResult = result as HttpCallErrorResult\n errorResult.http = { status: response.status }\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 decompress: true,\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 HttpCallXmlResult\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 HttpCallErrorResult\n errorResult.http = { status: response.status }\n }\n break\n }\n case 'text/html':{\n const axios = new Axios({\n headers: { ...this.getHeaders(headers), Accept: this.accept },\n responseType: 'text',\n decompress: true,\n timeout: this.timeout,\n })\n const response = await axios.get(url)\n if (response.status >= 200 && response.status < 300) {\n const htmlResult = result as HttpCallHtmlResult\n htmlResult.data = response.data\n htmlResult.contentType = response.headers['content-type']?.toString() ?? 'text/html'\n } else {\n const errorResult = result as HttpCallErrorResult\n errorResult.http = { status: response.status }\n }\n break\n }\n default: {\n const axios = new Axios({\n headers: this.params.headers, responseType: 'arraybuffer', timeout: this.timeout, decompress: true,\n })\n const response = await axios.get(url)\n if (response.status >= 200 && response.status < 300) {\n const jsonResult = result as HttpCallBase64Result\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 HttpCallErrorResult\n errorResult.http = { status: response.status }\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'\nimport { URL } from '@xylabs/url'\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,iBAAiB;AAGvB,IAAM,uBAAuB,GAAG,cAAc;;;ADE9C,IAAM,aAAa,sBAAgC,cAAc;;;ADDjE,IAAM,YAAY,gBAAgB,OAAO,UAAU;;;AGJ1D,SAAS,mBAAAA,wBAAuB;;;ACAhC,SAAS,yBAAAC,8BAA6B;AAK/B,IAAM,yBAAyB,CAAC,MAAkD;AACvF,SAAOC,uBAAsB,oBAAoB,EAAE,CAAC,KAAK,OAAQ,GAA4B,SAAS;AACxG;;;ADHO,IAAM,yBAAyBC,iBAAgB,OAAO,sBAAsB;;;AEJnF,SAAS,mBAAAC,wBAAuB;;;ACAhC,SAAS,yBAAAC,8BAA6B;AAK/B,IAAM,mBAAmBC,uBAAsC,oBAAoB;;;ADDnF,IAAM,mBAAmBC,iBAAgB,OAAO,gBAAgB;;;AEJvE,SAAS,mBAAAC,wBAAuB;;;ACAhC,SAAS,yBAAAC,8BAA6B;AAK/B,IAAM,sBAAsB,CAAC,MAA+C;AACjF,SAAOC,uBAAsB,oBAAoB,EAAE,CAAC,KAAK,OAAQ,GAAyB,SAAS;AACrG;;;ADHO,IAAM,sBAAsBC,iBAAgB,OAAO,mBAAmB;;;AEJ7E,SAAS,mBAAAC,wBAAuB;;;ACGzB,IAAM,gBAAgB,CAAC,UAA0C,WAAW,KAAK,KAAK,CAAC,CAAE,MAAsB;;;ADC/G,IAAM,gBAAgBC,iBAAgB,OAAO,aAAa;;;AEJjE,SAAS,mBAAAC,wBAAuB;;;ACGzB,IAAM,wBAAwB,CAAC,UACpC,WAAW,KAAK,KAAK,CAAC,EAAG,MAA8B,eAAgB,MAA8B;;;ADAhG,IAAM,wBAAwBC,iBAAgB,OAAO,qBAAqB;;;AEJjF,SAAS,yBAAAC,8BAA6B;AAK/B,IAAM,wBAAwB,CAAC,UACpC,CAAC,CAACC,uBAAsC,oBAAoB,MAAO,MAA8B,MAAM,UAAU,QAAQ;;;ACJ3H,SAAS,mBAAAC,wBAAuB;AAEhC,SAAS,yBAAAC,8BAA6B;AAe/B,IAAM,uBAAuB,CAA4D,MAAmD;AACjJ,SAAOC,uBAAsB,oBAAoB,EAAE,CAAC,KAAM,GAA0B,gBAAgB;AACtG;AACO,IAAM,uBAAuBC,iBAAgB,OAAO,oBAAoB;;;ACtB/E,SAAS,mBAAAC,wBAAuB;AAChC,SAAS,yBAAAC,8BAA6B;;;ACD/B,IAAM,8BAA8B;;;ADiCpC,IAAM,0BAA0BC,uBAA6C,2BAA2B;AACxG,IAAM,0BAA0BC,iBAAgB,OAAO,uBAAuB;AAE9E,IAAM,6BAA6B,CAAC,UACzC,wBAAwB,KAAK,KAAK,CAAC,CAAE,MAAmC;AACnE,IAAM,6BAA6BA,iBAAgB,OAAO,0BAA0B;AAEpF,IAAM,qCAAqC,CAAC,UACjD,wBAAwB,KAAK,KAAK,CAAC,CAAE,MAA2C;AAC3E,IAAM,qCAAqCA,iBAAgB,OAAO,kCAAkC;;;AEzC3G,SAAS,YAAAC,iBAAgB;AACzB,SAAS,iBAAiB;AAE1B,SAAS,OAAAC,YAAW;AACpB,SAAS,uBAAuB;AAChC,SAAS,qBAAqB;AAC9B,SAAS,sBAAsB;AAE/B,SAAS,yBAAAC,8BAA6B;AAEtC,SAAS,aAAa;AACtB,SAAS,qBAAqB;AAC9B,OAAO,kBAAkB;;;ACbzB,SAAS,gBAAgB;AACzB,SAAS,WAAW;AAEpB,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,aAAO,OAAO,SAAS,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,aAAO,OAAO,SAAS,IAAI,GAAG,IAAI,IAAI,KAAK,KAAK;AAAA,IAClD,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF,QAAQ;AAIN,WAAO;AAAA,EACT;AACF;;;ADNO,IAAM,kBAAN,cAA6F,gBAAmD;AAAA,EACrJ,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,2BAA2B;AAAA,EACvG,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,MAAyB;AAClC,UAAM,EAAE,KAAK,QAAQ,IAAI,cAAc,IAAI,KAAK,CAAC;AACjD,UAAM;AAAA,MACJ,aAAa;AAAA,MAAiB,QAAQ;AAAA,MAAY,SAAS;AAAA,IAC7D,IAAI,sBAAsB,IAAI,KAAK,CAAC;AACpC,UAAM,EAAE,KAAK,UAAU,IAAI,2BAA2B,KAAK,MAAM,KAAK,CAAC;AACvE,UAAM;AAAA,MACJ,aAAa;AAAA,MAAmB,QAAQ;AAAA,MAAc,SAAS;AAAA,IACjE,IAAI,mCAAmC,KAAK,MAAM,KAAK,CAAC;AAExD,UAAM,SAAS,EAAE,GAAG,cAAc,GAAG,WAAW;AAEhD,QAAI,MAAuB;AAE3B,QAAI,SAAS;AACX,YAAM,IAAIC,KAAI,OAAO;AAAA,IACvB,WAAW,iBAAiB;AAC1B,YAAM,IAAIA,KAAI,aAAa,iBAAiB,MAAM,CAAC;AAAA,IACrD,WAAW,WAAW;AACpB,YAAM,IAAIA,KAAI,SAAS;AAAA,IACzB,WAAW,mBAAmB;AAC5B,YAAM,IAAIA,KAAI,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,KAAK,aAAa,IAAI,KAAK,KAAK,CAAC;AAC/D,aAAO,IAAI;AAAA,IACb;AAEA,UAAM,IAAI,MAAM,qFAAqF;AAAA,EACvG;AAAA,EAEA,WAAW,SAAkF;AAC3F,WAAO;AAAA,MACL,GAAG,KAAK,OAAO;AAAA,MAAS,GAAG,KAAK,OAAO;AAAA,MAAS,GAAG;AAAA,IACrD;AAAA,EACF;AAAA,EAEA,MAAyB,eAAe,aAAyB,CAAC,GAA8B;AAC9F,UAAM,KAAK,QAAQ,OAAO;AAC1B,QAAI;AACF,YAAM,eAAe,MAAM,QAAQ;AAAA,QACjC,WAAW,OAAOC,uBAAsB,cAAc,CAAC,EAAE,IAAI,OAAO,SAAS;AAC3E,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,cAA8B;AAAA,YAClC,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;AAAA,EAGA,MAAc,QAAQ,KAAa,MAAY,SAAuE;AACpH,UAAM,SAAyB;AAAA,MAC7B;AAAA,MACA,QAAQ;AAAA,IACV;AACA,QAAI;AACF,cAAQ,KAAK,QAAQ;AAAA,QACnB,KAAK,oBAAoB;AACvB,gBAAM,QAAQ,IAAI,UAAU;AAAA,YAC1B,SAAS,EAAE,GAAG,KAAK,WAAW,OAAO,GAAG,QAAQ,mBAAmB;AAAA,YAAG,SAAS,KAAK;AAAA,YAAS,YAAY;AAAA,UAC3G,CAAC;AACD,gBAAM,WAAW,MAAM,MAAM,IAA4B,GAAG;AAC5D,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,EAAE,QAAQ,SAAS,OAAO;AAAA,UAC/C;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,YAAY;AAAA,YACZ,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,cAAc,SAAS,QAAQ,cAAc,GAAG,SAAS,KAAK;AAAA,UAC1E,OAAO;AACL,kBAAM,cAAc;AACpB,wBAAY,OAAO,EAAE,QAAQ,SAAS,OAAO;AAAA,UAC/C;AACA;AAAA,QACF;AAAA,QACA,KAAK,aAAY;AACf,gBAAM,QAAQ,IAAI,MAAM;AAAA,YACtB,SAAS,EAAE,GAAG,KAAK,WAAW,OAAO,GAAG,QAAQ,KAAK,OAAO;AAAA,YAC5D,cAAc;AAAA,YACd,YAAY;AAAA,YACZ,SAAS,KAAK;AAAA,UAChB,CAAC;AACD,gBAAM,WAAW,MAAM,MAAM,IAAI,GAAG;AACpC,cAAI,SAAS,UAAU,OAAO,SAAS,SAAS,KAAK;AACnD,kBAAM,aAAa;AACnB,uBAAW,OAAO,SAAS;AAC3B,uBAAW,cAAc,SAAS,QAAQ,cAAc,GAAG,SAAS,KAAK;AAAA,UAC3E,OAAO;AACL,kBAAM,cAAc;AACpB,wBAAY,OAAO,EAAE,QAAQ,SAAS,OAAO;AAAA,UAC/C;AACA;AAAA,QACF;AAAA,QACA,SAAS;AACP,gBAAM,QAAQ,IAAI,MAAM;AAAA,YACtB,SAAS,KAAK,OAAO;AAAA,YAAS,cAAc;AAAA,YAAe,SAAS,KAAK;AAAA,YAAS,YAAY;AAAA,UAChG,CAAC;AACD,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,cAAc,SAAS,QAAQ,cAAc,GAAG,SAAS,KAAK;AAAA,UAC3E,OAAO;AACL,kBAAM,cAAc;AACpB,wBAAY,OAAO,EAAE,QAAQ,SAAS,OAAO;AAAA,UAC/C;AACA;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,IAAI;AACX,YAAM,aAAa;AACnB,UAAI,WAAW,cAAc;AAC3B,YAAI,YAAY,UAAU,WAAW,QAAW;AAC9C,iBAAO,OAAO,OAAO,QAAQ,CAAC;AAC9B,iBAAO,KAAK,SAAS,YAAY,UAAU;AAAA,QAC7C;AACA,YAAI,YAAY,SAAS,QAAW;AAClC,iBAAO,OAAO,OAAO,QAAQ,CAAC;AAC9B,iBAAO,KAAK,OAAO,YAAY;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","URL","isPayloadOfSchemaType","URL","isPayloadOfSchemaType","assertEx"]}
@@ -0,0 +1,2 @@
1
+ export declare const checkIpfsUrl: (urlToCheck: string, ipfsGateway?: string) => string;
2
+ //# sourceMappingURL=checkIpfsUrl.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"checkIpfsUrl.d.ts","sourceRoot":"","sources":["../../../src/lib/checkIpfsUrl.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,YAAY,eAAgB,MAAM,gBAAgB,MAAM,KAAG,MAgCvE,CAAA"}
@@ -0,0 +1,2 @@
1
+ export * from './checkIpfsUrl.ts';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}
package/package.json ADDED
@@ -0,0 +1,62 @@
1
+ {
2
+ "name": "@xyo-network/http-call-witness",
3
+ "version": "3.0.4",
4
+ "description": "Typescript/Javascript Plugins for XYO Platform",
5
+ "homepage": "https://xyo.network",
6
+ "bugs": {
7
+ "url": "git+https://github.com/XYOracleNetwork/plugins/issues",
8
+ "email": "support@xyo.network"
9
+ },
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "git+https://github.com/XYOracleNetwork/plugins.git"
13
+ },
14
+ "license": "LGPL-3.0-only",
15
+ "author": {
16
+ "name": "XYO Development Team",
17
+ "email": "support@xyo.network",
18
+ "url": "https://xyo.network"
19
+ },
20
+ "sideEffects": false,
21
+ "type": "module",
22
+ "exports": {
23
+ ".": {
24
+ "types": "./dist/neutral/index.d.ts",
25
+ "default": "./dist/neutral/index.mjs"
26
+ },
27
+ "./package.json": "./package.json"
28
+ },
29
+ "module": "dist/neutral/index.mjs",
30
+ "types": "dist/neutral/index.d.ts",
31
+ "dependencies": {
32
+ "@xylabs/assert": "^4.0.4",
33
+ "@xylabs/axios": "^4.0.4",
34
+ "@xylabs/hex": "^4.0.4",
35
+ "@xylabs/object": "^4.0.4",
36
+ "@xylabs/url": "^4.0.4",
37
+ "@xyo-network/abstract-witness": "^3.0.10",
38
+ "@xyo-network/hash": "^3.0.10",
39
+ "@xyo-network/payload-builder": "^3.0.10",
40
+ "@xyo-network/payload-model": "^3.0.10",
41
+ "@xyo-network/witness-model": "^3.0.10",
42
+ "axios": "^1.7.5",
43
+ "base64-js": "^1.5.1",
44
+ "es6-dynamic-template": "^2.0.0"
45
+ },
46
+ "devDependencies": {
47
+ "@xylabs/jest-helpers": "^4.0.4",
48
+ "@xylabs/ts-scripts-yarn3": "^4.0.7",
49
+ "@xylabs/tsconfig": "^4.0.7",
50
+ "@xyo-network/account": "^3.0.10",
51
+ "@xyo-network/manifest": "^3.0.10",
52
+ "@xyo-network/module-factory-locator": "^3.0.10",
53
+ "@xyo-network/module-model": "^3.0.10",
54
+ "@xyo-network/sentinel-model": "^3.0.10",
55
+ "ethers": "^6.13.2",
56
+ "jest": "^29.7.0",
57
+ "typescript": "^5.5.4"
58
+ },
59
+ "publishConfig": {
60
+ "access": "public"
61
+ }
62
+ }
@@ -0,0 +1,5 @@
1
+ export const HttpCallSchema = 'network.xyo.http.call'
2
+ export type HttpCallSchema = typeof HttpCallSchema
3
+
4
+ export const HttpCallResultSchema = `${HttpCallSchema}.result`
5
+ export type HttpCallResultSchema = typeof HttpCallResultSchema
@@ -0,0 +1,5 @@
1
+ import { AsObjectFactory } from '@xylabs/object'
2
+
3
+ import { isHttpCall } from './isHttpCall.ts'
4
+
5
+ export const asApiCall = AsObjectFactory.create(isHttpCall)
@@ -0,0 +1,5 @@
1
+ import { AsObjectFactory } from '@xylabs/object'
2
+
3
+ import { isHttpCallBase64Result } from './isHttpCallBase64Result.ts'
4
+
5
+ export const asHttpCallBase64Result = AsObjectFactory.create(isHttpCallBase64Result)
@@ -0,0 +1,5 @@
1
+ import { AsObjectFactory } from '@xylabs/object'
2
+
3
+ import { isHttpCallResult } from './isHttpCallResult.ts'
4
+
5
+ export const asHttpCallResult = AsObjectFactory.create(isHttpCallResult)
@@ -0,0 +1,5 @@
1
+ import { AsObjectFactory } from '@xylabs/object'
2
+
3
+ import { isHttpCallXmlResult } from './isHttpCallXmlResult.ts'
4
+
5
+ export const asHttpCallXmlResult = AsObjectFactory.create(isHttpCallXmlResult)
@@ -0,0 +1,5 @@
1
+ import { AsObjectFactory } from '@xylabs/object'
2
+
3
+ import { isHttpUriCall } from './isHttpUriCall.ts'
4
+
5
+ export const asHttpUriCall = AsObjectFactory.create(isHttpUriCall)
@@ -0,0 +1,5 @@
1
+ import { AsObjectFactory } from '@xylabs/object'
2
+
3
+ import { isHttpUriTemplateCall } from './isHttpUriTemplateCall.ts'
4
+
5
+ export const asHttpUriTemplateCall = AsObjectFactory.create(isHttpUriTemplateCall)
@@ -0,0 +1,13 @@
1
+ export * from './asHttpCall.ts'
2
+ export * from './asHttpCallBase64Result.ts'
3
+ export * from './asHttpCallResult.ts'
4
+ export * from './asHttpCallXmlResult.ts'
5
+ export * from './asHttpUriCall.ts'
6
+ export * from './asHttpUriTemplateCall.ts'
7
+ export * from './isHttpCall.ts'
8
+ export * from './isHttpCallBase64Result.ts'
9
+ export * from './isHttpCallErrorResult.ts'
10
+ export * from './isHttpCallResult.ts'
11
+ export * from './isHttpCallXmlResult.ts'
12
+ export * from './isHttpUriCall.ts'
13
+ export * from './isHttpUriTemplateCall.ts'
@@ -0,0 +1,6 @@
1
+ import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
2
+
3
+ import { HttpCallSchema } from '../Schema.ts'
4
+ import type { HttpCall } from '../types/index.ts'
5
+
6
+ export const isHttpCall = isPayloadOfSchemaType<HttpCall>(HttpCallSchema)
@@ -0,0 +1,8 @@
1
+ import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
2
+
3
+ import { HttpCallResultSchema } from '../Schema.ts'
4
+ import type { HttpCallBase64Result } from '../types/index.ts'
5
+
6
+ export const isHttpCallBase64Result = (x?: unknown | null): x is HttpCallBase64Result => {
7
+ return isPayloadOfSchemaType(HttpCallResultSchema)(x) && typeof (x as HttpCallBase64Result)?.data === 'string'
8
+ }
@@ -0,0 +1,7 @@
1
+ import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
2
+
3
+ import { HttpCallResultSchema } from '../Schema.ts'
4
+ import type { HttpCallErrorResult, HttpCallResult } from '../types/index.ts'
5
+
6
+ export const isHttpCallErrorResult = (value: unknown): value is HttpCallErrorResult =>
7
+ !!isPayloadOfSchemaType<HttpCallResult>(HttpCallResultSchema) && ((value as HttpCallErrorResult).http?.status ?? 200) >= 400
@@ -0,0 +1,6 @@
1
+ import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
2
+
3
+ import { HttpCallResultSchema } from '../Schema.ts'
4
+ import type { HttpCallResult } from '../types/index.ts'
5
+
6
+ export const isHttpCallResult = isPayloadOfSchemaType<HttpCallResult>(HttpCallResultSchema)
@@ -0,0 +1,8 @@
1
+ import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
2
+
3
+ import { HttpCallResultSchema } from '../Schema.ts'
4
+ import type { HttpCallXmlResult } from '../types/index.ts'
5
+
6
+ export const isHttpCallXmlResult = (x?: unknown | null): x is HttpCallXmlResult => {
7
+ return isPayloadOfSchemaType(HttpCallResultSchema)(x) && typeof (x as HttpCallXmlResult)?.data === 'string'
8
+ }
@@ -0,0 +1,4 @@
1
+ import type { HttpUriCall } from '../types/index.ts'
2
+ import { isHttpCall } from './isHttpCall.ts'
3
+
4
+ export const isHttpUriCall = (value?: unknown): value is HttpUriCall => isHttpCall(value) && !!(value as HttpUriCall).uri
@@ -0,0 +1,5 @@
1
+ import type { HttpUriTemplateCall } from '../types/index.ts'
2
+ import { isHttpCall } from './isHttpCall.ts'
3
+
4
+ export const isHttpUriTemplateCall = (value?: unknown): value is HttpUriTemplateCall =>
5
+ isHttpCall(value) && !!((value as HttpUriTemplateCall).uriTemplate || (value as HttpUriTemplateCall).params)
@@ -0,0 +1,3 @@
1
+ export * from './identity/index.ts'
2
+ export * from './Schema.ts'
3
+ export * from './types/index.ts'
@@ -0,0 +1,4 @@
1
+ import type { HttpUriCall } from './HttpUriCall.ts'
2
+ import type { HttpUriTemplateCall } from './HttpUriTemplateCall.ts'
3
+
4
+ export type HttpCall = HttpUriCall | HttpUriTemplateCall
@@ -0,0 +1,15 @@
1
+ import type { Hash } from '@xylabs/hex'
2
+ import type { Payload } from '@xyo-network/payload-model'
3
+
4
+ import type { HttpCallResultSchema } from '../Schema.ts'
5
+ import type { HttpCallJsonResult } from './HttpCallJsonResult.ts'
6
+ import type { HttpCallXmlResult } from './HttpCallXmlResult.ts'
7
+
8
+ export type HttpCallBase64Result = Payload<
9
+ {
10
+ call: Hash
11
+ contentType: Exclude<Exclude<string, HttpCallJsonResult['contentType']>, HttpCallXmlResult['contentType']>
12
+ data: string
13
+ },
14
+ HttpCallResultSchema
15
+ >
@@ -0,0 +1,13 @@
1
+ import type { Hash } from '@xylabs/hex'
2
+ import type { Payload } from '@xyo-network/payload-model'
3
+
4
+ import type { HttpCallResultSchema } from '../Schema.ts'
5
+ import type { HttpMeta } from './HttpMeta.ts'
6
+
7
+ export type HttpCallErrorResult = Payload<
8
+ {
9
+ call: Hash
10
+ http?: HttpMeta
11
+ },
12
+ HttpCallResultSchema
13
+ >
@@ -0,0 +1,8 @@
1
+ import type { Queries } from './Queries.ts'
2
+ import type { Verb } from './Verb.ts'
3
+
4
+ export interface HttpCallFields {
5
+ headers?: Record<string, string | undefined>
6
+ queries?: Queries
7
+ verb?: Verb
8
+ }
@@ -0,0 +1,13 @@
1
+ import type { Hash } from '@xylabs/hex'
2
+ import type { Payload } from '@xyo-network/payload-model'
3
+
4
+ import type { HttpCallResultSchema } from '../Schema.ts'
5
+
6
+ export type HttpCallHtmlResult = Payload<
7
+ {
8
+ call: Hash
9
+ contentType: 'text/html'
10
+ data: string
11
+ },
12
+ HttpCallResultSchema
13
+ >
@@ -0,0 +1,23 @@
1
+ import type { Hash } from '@xylabs/hex'
2
+ import type { JsonArray, JsonObject } from '@xylabs/object'
3
+ import { AsObjectFactory } from '@xylabs/object'
4
+ import type { Payload } from '@xyo-network/payload-model'
5
+ import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
6
+
7
+ import { HttpCallResultSchema } from '../Schema.ts'
8
+
9
+ export type HttpCallJsonResultType = JsonArray | JsonObject
10
+
11
+ export type HttpCallJsonResult<T extends HttpCallJsonResultType = HttpCallJsonResultType> = Payload<
12
+ {
13
+ call: Hash
14
+ contentType: 'application/json'
15
+ data: T
16
+ },
17
+ HttpCallResultSchema
18
+ >
19
+
20
+ export const isHttpCallJsonResult = <T extends HttpCallJsonResultType = HttpCallJsonResultType>(x?: unknown | null): x is HttpCallJsonResult<T> => {
21
+ return isPayloadOfSchemaType(HttpCallResultSchema)(x) && (x as HttpCallJsonResult)?.contentType === 'application/json'
22
+ }
23
+ export const asHttpCallJsonResult = AsObjectFactory.create(isHttpCallJsonResult)
@@ -0,0 +1,12 @@
1
+ import type { JsonArray, JsonObject } from '@xylabs/object'
2
+
3
+ import type { HttpCallBase64Result } from './HttpCallBase64Result.ts'
4
+ import type { HttpCallErrorResult } from './HttpCallErrorResult.ts'
5
+ import type { HttpCallJsonResult } from './HttpCallJsonResult.ts'
6
+
7
+ type NewType = JsonObject
8
+
9
+ export type HttpCallResult<TJson extends JsonArray | JsonObject = JsonArray | NewType> =
10
+ | HttpCallBase64Result
11
+ | HttpCallJsonResult<TJson>
12
+ | HttpCallErrorResult
@@ -0,0 +1,13 @@
1
+ import type { Hash } from '@xylabs/hex'
2
+ import type { Payload } from '@xyo-network/payload-model'
3
+
4
+ import type { HttpCallResultSchema } from '../Schema.ts'
5
+
6
+ export type HttpCallXmlResult = Payload<
7
+ {
8
+ call: Hash
9
+ contentType: 'application/xml' | 'text/xml'
10
+ data: string
11
+ },
12
+ HttpCallResultSchema
13
+ >
@@ -0,0 +1,4 @@
1
+ export interface HttpMeta {
2
+ code?: string
3
+ status?: number
4
+ }
@@ -0,0 +1,11 @@
1
+ import type { Payload } from '@xyo-network/payload-model'
2
+
3
+ import type { HttpCallSchema } from '../Schema.ts'
4
+ import type { HttpCallFields } from './HttpCallFields.ts'
5
+
6
+ export type HttpUriCall = Payload<
7
+ HttpCallFields & {
8
+ uri: string
9
+ },
10
+ HttpCallSchema
11
+ >
@@ -0,0 +1,12 @@
1
+ import type { Payload } from '@xyo-network/payload-model'
2
+
3
+ import type { HttpCallSchema } from '../Schema.ts'
4
+ import type { HttpCallFields } from './HttpCallFields.ts'
5
+
6
+ export type HttpUriTemplateCall = Payload<
7
+ HttpCallFields & {
8
+ params?: Record<string, string>
9
+ uriTemplate?: string
10
+ },
11
+ HttpCallSchema
12
+ >
@@ -0,0 +1,13 @@
1
+ // TODO: Bring in from some library or package for completeness
2
+ export type MimeTypes =
3
+ | 'application/json' // JSON format
4
+ | 'application/octet-stream' // Binary data
5
+ | 'application/pdf' // PDF format
6
+ | 'application/xhtml+xml' // XHTML format
7
+ | 'application/xml' // XML format
8
+ | 'image/gif' // GIF image format
9
+ | 'image/jpeg' // JPEG image format
10
+ | 'image/png' // PNG image format
11
+ | 'text/html' // HTML format
12
+ | 'text/plain' // Plain text format
13
+ | 'text/xml' // XML format (alternative)
@@ -0,0 +1 @@
1
+ export type Queries = Record<string, string>
@@ -0,0 +1 @@
1
+ export type Verb = 'get' | 'post'
@@ -0,0 +1,14 @@
1
+ export * from './HttpCall.ts'
2
+ export * from './HttpCallBase64Result.ts'
3
+ export * from './HttpCallErrorResult.ts'
4
+ export * from './HttpCallFields.ts'
5
+ export * from './HttpCallHtmlResult.ts'
6
+ export * from './HttpCallJsonResult.ts'
7
+ export * from './HttpCallResult.ts'
8
+ export * from './HttpCallXmlResult.ts'
9
+ export * from './HttpMeta.ts'
10
+ export * from './HttpUriCall.ts'
11
+ export * from './HttpUriTemplateCall.ts'
12
+ export * from './MimeTypes.ts'
13
+ export * from './Queries.ts'
14
+ export * from './Verb.ts'
@@ -0,0 +1,43 @@
1
+ import { AsObjectFactory } from '@xylabs/object'
2
+ import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
3
+ import type { WitnessConfig } from '@xyo-network/witness-model'
4
+
5
+ import type {
6
+ HttpCall, HttpUriCall, HttpUriTemplateCall, MimeTypes,
7
+ } from '../Payload/index.ts'
8
+ import { HttpCallWitnessConfigSchema } from './Schema.ts'
9
+
10
+ export type HttpCallWitnessConfigBase = WitnessConfig<{
11
+ accept?: MimeTypes
12
+ headers?: Record<string, string | undefined>
13
+ queries?: HttpCall['queries']
14
+ schema: HttpCallWitnessConfigSchema
15
+ timeout?: number
16
+ verb?: HttpCall['verb']
17
+ }>
18
+
19
+ export type HttpUriCallWitnessConfig = WitnessConfig<
20
+ HttpCallWitnessConfigBase & {
21
+ uri: HttpUriCall['uri']
22
+ }
23
+ >
24
+
25
+ export type HttpUriTemplateCallWitnessConfig = WitnessConfig<
26
+ HttpCallWitnessConfigBase & {
27
+ params?: Record<string, string>
28
+ uriTemplate: HttpUriTemplateCall['uriTemplate']
29
+ }
30
+ >
31
+
32
+ export type HttpCallWitnessConfig = HttpUriCallWitnessConfig | HttpUriTemplateCallWitnessConfig | HttpCallWitnessConfigBase
33
+
34
+ export const isHttpCallWitnessConfig = isPayloadOfSchemaType<HttpCallWitnessConfig>(HttpCallWitnessConfigSchema)
35
+ export const asHttpCallWitnessConfig = AsObjectFactory.create(isHttpCallWitnessConfig)
36
+
37
+ export const isHttpUriCallWitnessConfig = (value?: unknown): value is HttpUriCallWitnessConfig =>
38
+ isHttpCallWitnessConfig(value) && !!(value as HttpUriCallWitnessConfig).uri
39
+ export const asHttpUriCallWitnessConfig = AsObjectFactory.create(isHttpUriCallWitnessConfig)
40
+
41
+ export const isHttpUriTemplateCallWitnessConfig = (value?: unknown): value is HttpUriTemplateCallWitnessConfig =>
42
+ isHttpCallWitnessConfig(value) && !!(value as HttpUriTemplateCallWitnessConfig).uriTemplate
43
+ export const asHttpUriTemplateCallWitnessConfig = AsObjectFactory.create(isHttpUriTemplateCallWitnessConfig)
@@ -0,0 +1,11 @@
1
+ import type { WitnessParams } from '@xyo-network/witness-model'
2
+
3
+ import type { HttpCallWitnessConfig } from './Config.ts'
4
+
5
+ export type HttpCallWitnessParams = WitnessParams<
6
+ HttpCallWitnessConfig,
7
+ {
8
+ headers?: Record<string, string | undefined>
9
+ ipfsGateway?: string
10
+ }
11
+ >
@@ -0,0 +1,2 @@
1
+ export const HttpCallWitnessConfigSchema = 'network.xyo.http.call.witness.config'
2
+ export type HttpCallWitnessConfigSchema = typeof HttpCallWitnessConfigSchema