@xyo-network/api-call-witness 5.3.2 → 5.3.4

package/src/Payload/types/ApiCallResult.ts

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

package/src/Payload/types/ApiCallXmlResult.ts

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

package/src/Payload/types/ApiUriCall.ts

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

package/src/Payload/types/ApiUriTemplateCall.ts

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

package/src/Payload/types/HttpMeta.ts

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

package/src/Payload/types/MimeTypes.ts

@@ -1,13 +0,0 @@
-// 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

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

package/src/Payload/types/Verb.ts

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

package/src/Payload/types/index.ts

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

package/src/Witness/Config.ts

@@ -1,43 +0,0 @@
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
-import type { WitnessConfig } from '@xyo-network/witness-model'
-
-import type {
-  ApiCallPayload, ApiUriCallPayload, ApiUriTemplateCallPayload, MimeTypes,
-} from '../Payload/index.ts'
-import { ApiCallWitnessConfigSchema } from './Schema.ts'
-
-export type ApiCallWitnessConfigBase = WitnessConfig<{
-  accept?: MimeTypes
-  headers?: Record<string, string | undefined>
-  queries?: ApiCallPayload['queries']
-  schema: ApiCallWitnessConfigSchema
-  timeout?: number
-  verb?: ApiCallPayload['verb']
-}>
-
-export type ApiUriCallWitnessConfig = WitnessConfig<
-  ApiCallWitnessConfigBase & {
-    uri: ApiUriCallPayload['uri']
-  }
->
-
-export type ApiUriTemplateCallWitnessConfig = WitnessConfig<
-  ApiCallWitnessConfigBase & {
-    params?: Record<string, string>
-    uriTemplate: ApiUriTemplateCallPayload['uriTemplate']
-  }
->
-
-export type ApiCallWitnessConfig = ApiUriCallWitnessConfig | ApiUriTemplateCallWitnessConfig | ApiCallWitnessConfigBase
-
-export const isApiCallWitnessConfig = isPayloadOfSchemaType<ApiCallWitnessConfig>(ApiCallWitnessConfigSchema)
-export const asApiCallWitnessConfig = AsObjectFactory.create(isApiCallWitnessConfig)
-
-export const isApiUriCallWitnessConfig = (value?: unknown): value is ApiUriCallWitnessConfig =>
-  isApiCallWitnessConfig(value) && !!(value as ApiUriCallWitnessConfig).uri
-export const asApiUriCallWitnessConfig = AsObjectFactory.create(isApiUriCallWitnessConfig)
-
-export const isApiUriTemplateCallWitnessConfig = (value?: unknown): value is ApiUriTemplateCallWitnessConfig =>
-  isApiCallWitnessConfig(value) && !!(value as ApiUriTemplateCallWitnessConfig).uriTemplate
-export const asApiUriTemplateCallWitnessConfig = AsObjectFactory.create(isApiUriTemplateCallWitnessConfig)

package/src/Witness/Params.ts

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

package/src/Witness/Schema.ts

@@ -1,4 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-export const ApiCallWitnessConfigSchema = asSchema('network.xyo.api.call.witness.config', true)
-export type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema

package/src/Witness/Witness.ts

@@ -1,197 +0,0 @@
-/* eslint-disable max-statements */
-
-import type { Hash } from '@xylabs/sdk-js'
-import {
-  assertEx, axiosJsonConfig, URL,
-} from '@xylabs/sdk-js'
-import { AbstractWitness } from '@xyo-network/abstract-witness'
-import type { Schema } from '@xyo-network/payload-model'
-import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
-import { PayloadBuilder } from '@xyo-network/sdk-js'
-import type { AxiosError } from 'axios'
-import { Axios } from 'axios'
-import { fromByteArray } from 'base64-js'
-import fillTemplate from 'es6-dynamic-template'
-
-import { checkIpfsUrl } from '../lib/index.ts'
-import type {
-  ApiCallBase64Result,
-  ApiCallErrorResult,
-  ApiCallJsonResult,
-  ApiCallJsonResultType,
-  ApiCallPayload,
-  ApiCallResult,
-  ApiCallXmlResult,
-  MimeTypes,
-} from '../Payload/index.ts'
-import {
-  ApiCallResultSchema,
-  ApiCallSchema,
-  asApiUriCallPayload,
-  asApiUriTemplateCall,
-} from '../Payload/index.ts'
-import { asApiUriCallWitnessConfig, asApiUriTemplateCallWitnessConfig } from './Config.ts'
-import type { ApiCallWitnessParams } from './Params.ts'
-import { ApiCallWitnessConfigSchema } from './Schema.ts'
-
-export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnessParams> extends AbstractWitness<TParams, ApiCallPayload, ApiCallResult> {
-  static override readonly configSchemas: Schema[] = [...super.configSchemas, ApiCallWitnessConfigSchema]
-  static override readonly defaultConfigSchema: Schema = ApiCallWitnessConfigSchema
-
-  get accept(): MimeTypes {
-    return this.config.accept ?? 'application/json'
-  }
-
-  get ipfsGateway() {
-    return this.params.ipfsGateway
-  }
-
-  get timeout() {
-    return this.config.timeout
-  }
-
-  getFullUri(call?: ApiCallPayload): string {
-    const { uri: callUri } = asApiUriCallPayload(call) ?? {}
-    const {
-      uriTemplate: callUriTemplate, params: callParams, queries: callQueries,
-    } = asApiUriTemplateCall(call) ?? {}
-    const { uri: configUri } = asApiUriCallWitnessConfig(this.config) ?? {}
-    const {
-      uriTemplate: configUriTemplate, params: configParams, queries: configQueries,
-    } = asApiUriTemplateCallWitnessConfig(this.config) ?? {}
-
-    const params = { ...configParams, ...callParams }
-
-    let url: URL | undefined = undefined
-
-    if (callUri) {
-      url = new URL(callUri)
-    } else if (callUriTemplate) {
-      url = new URL(fillTemplate(callUriTemplate, params))
-    } else if (configUri) {
-      url = new URL(configUri)
-    } else if (configUriTemplate) {
-      url = new URL(fillTemplate(configUriTemplate, params))
-    }
-
-    if (url) {
-      const queries = Object.entries({ ...configQueries, ...callQueries })
-      for (let [key, value] of queries) url?.searchParams.set(key, value)
-      return url.href
-    }
-
-    throw new Error('Unable to determine uri. No uri/uriTemplate specified in either the call or config.')
-  }
-
-  getHeaders(headers?: Record<string, string | undefined>): Record<string, string | undefined> {
-    return {
-      ...this.params.headers, ...this.config.headers, ...headers,
-    }
-  }
-
-  protected override async observeHandler(inPayloads: ApiCallPayload[] = []): Promise<ApiCallResult[]> {
-    await this.started('throw')
-    try {
-      const observations = await Promise.all(
-        inPayloads.filter(isPayloadOfSchemaType<ApiCallPayload>(ApiCallSchema)).map(async (call) => {
-          const { verb: callVerb } = call
-          const { verb: configVerb } = this.config
-          const verb = callVerb ?? configVerb ?? 'get'
-          const uri = this.getFullUri(call)
-
-          const validatedUri = assertEx(checkIpfsUrl(uri, this.ipfsGateway), () => 'Invalid URI')
-
-          if (verb === 'get') {
-            return this.httpGet(validatedUri, (await PayloadBuilder.dataHash(call)))
-          }
-
-          const observation: ApiCallResult = {
-            call: await PayloadBuilder.hash(call),
-            schema: ApiCallResultSchema,
-          }
-          return observation
-        }),
-      )
-      return observations
-    } catch (ex) {
-      const error = ex as Error
-      console.error(`Error [${this.config.name}]: ${error.message}`)
-      console.log(error.stack)
-      throw error
-    }
-  }
-
-  // eslint-disable-next-line complexity
-  private async httpGet(url: string, call: Hash, headers?: Record<string, string | undefined>): Promise<ApiCallResult> {
-    const result: ApiCallResult = {
-      call,
-      schema: ApiCallResultSchema,
-    }
-    try {
-      switch (this.accept) {
-        case 'application/json': {
-          const axios = new Axios(axiosJsonConfig({ headers: { ...this.getHeaders(headers), Accept: 'application/json' }, timeout: this.timeout }))
-          const response = await axios.get<ApiCallJsonResultType>(url)
-          if (response.status >= 200 && response.status < 300) {
-            const jsonResult = result as ApiCallJsonResult
-            jsonResult.data = response.data
-            jsonResult.contentType = 'application/json'
-          } else {
-            const errorResult = result as ApiCallErrorResult
-            errorResult.http = { status: response.status }
-          }
-          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)
-          if (response.status >= 200 && response.status < 300) {
-            const jsonResult = result as ApiCallBase64Result
-            jsonResult.data = fromByteArray(response.data)
-            jsonResult.contentType = response.headers['content-type']?.toString() ?? 'application/octet-stream'
-          } else {
-            const errorResult = result as ApiCallErrorResult
-            errorResult.http = { status: response.status }
-          }
-          break
-        }
-      }
-    } catch (ex) {
-      const axiosError = ex as AxiosError
-      if (axiosError.isAxiosError) {
-        if (axiosError?.response?.status !== undefined) {
-          result.http = result.http ?? {}
-          result.http.status = axiosError?.response?.status
-        }
-        if (axiosError?.code !== undefined) {
-          result.http = result.http ?? {}
-          result.http.code = axiosError?.code
-        }
-        return result
-      } else {
-        throw ex
-      }
-    }
-    return result
-  }
-}

package/src/Witness/index.ts

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

package/src/Witness/spec/opensea.nft-call.json

@@ -1,41 +0,0 @@
-{
-  "$schema": "https://raw.githubusercontent.com/XYOracleNetwork/sdk-xyo-client-js/main/packages/manifest/src/schema.json",
-  "nodes": [
-    {
-      "config": {
-        "name": "ApiCall",
-        "schema": "network.xyo.node.config"
-      },
-      "modules": {
-        "public": [
-          {
-            "config": {
-              "language": "javascript",
-              "name": "ApiCallWitness",
-              "queries": {
-                "limit": 1
-              },
-              "schema": "network.xyo.api.call.witness.config",
-              "uriTemplate": "https://api.opensea.io/api/v2/chain/ethereum/account/${address}/nfts"
-            }
-          },
-          {
-            "config": {
-              "language": "javascript",
-              "name": "ApiCallSentinel",
-              "schema": "network.xyo.sentinel.config",
-              "synchronous": "true",
-              "tasks": [
-                {
-                  "input": true,
-                  "mod": "ApiCallWitness"
-                }
-              ]
-            }
-          }
-        ]
-      }
-    }
-  ],
-  "schema": "network.xyo.manifest"
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './Payload/index.ts'
-export * from './Witness/index.ts'

package/src/lib/checkIpfsUrl.ts

@@ -1,43 +0,0 @@
-import { assertEx, URL } from '@xylabs/sdk-js'
-
-const allowIpfsIoRepair = true
-
-/**
- * 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 const checkIpfsUrl = (urlToCheck: string, ipfsGateway?: string): string => {
-  try {
-    const url = new URL(urlToCheck)
-    let protocol = url.protocol
-    let host = url.host
-    let path = url.pathname
-    const query = url.search
-    if (protocol === 'ipfs:') {
-      protocol = 'https:'
-      host = assertEx(ipfsGateway, () => 'No ipfsGateway provided')
-      path = url.host === 'ipfs' ? `ipfs${path}` : `ipfs/${url.host}${path}`
-      const root = `${protocol}//${host}/${path}`
-      return query?.length > 0 ? `${root}?${query}` : root
-    } else if (allowIpfsIoRepair && protocol === 'https' && host === 'ipfs.io') {
-      protocol = 'https:'
-      host = assertEx(ipfsGateway, () => 'No ipfsGateway provided')
-      const pathParts = path.split('/')
-      if (pathParts[0] === 'ipfs') {
-        pathParts.shift()
-      }
-      path = pathParts.join('/')
-      const root = `${protocol}//${host}/${path}`
-      return query?.length > 0 ? `${root}?${query}` : root
-    } else {
-      return urlToCheck
-    }
-  } catch {
-    // const error = ex as Error
-    // console.error(`${error.name}:${error.message} [${urlToCheck}]`)
-    // console.log(error.stack)
-    return urlToCheck
-  }
-}

package/src/lib/index.ts

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

package/src/types.d.ts

@@ -1 +0,0 @@
-declare module 'es6-dynamic-template'