@xyo-network/api-call-witness 2.79.6 → 2.79.8

package/package.json

@@ -13,17 +13,22 @@
     "@xylabs/assert": "^2.13.9",
     "@xylabs/axios": "^2.13.9",
     "@xylabs/buffer": "^2.13.9",
-    "@xyo-network/abstract-witness": "~2.79.6",
-    "@xyo-network/hash": "~2.79.6",
-    "@xyo-network/object": "~2.79.6",
-    "@xyo-network/payload-model": "~2.79.6",
-    "@xyo-network/witness-model": "~2.79.6",
-    "base64-js": "^1.5.1"
+    "@xyo-network/abstract-witness": "~2.79.8",
+    "@xyo-network/hash": "~2.79.8",
+    "@xyo-network/object": "~2.79.8",
+    "@xyo-network/payload-model": "~2.79.8",
+    "@xyo-network/witness-model": "~2.79.8",
+    "base64-js": "^1.5.1",
+    "es6-template-strings": "^2.0.1"
   },
   "devDependencies": {
     "@xylabs/jest-helpers": "^2.13.9",
     "@xylabs/ts-scripts-yarn3": "^3.1.21",
     "@xylabs/tsconfig": "^3.1.21",
+    "@xyo-network/account": "~2.79.8",
+    "@xyo-network/manifest": "~2.79.8",
+    "@xyo-network/module-model": "~2.79.8",
+    "@xyo-network/sentinel-model": "~2.79.8",
     "ethers": "^5.7.2",
     "jest": "^29.7.0",
     "typescript": "^5.2.2"
@@ -67,6 +72,6 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.79.6",
+  "version": "2.79.8",
   "type": "module"
 }

package/src/Config.ts

@@ -0,0 +1,42 @@
+import { AsObjectFactory } from '@xyo-network/object'
+import { isPayloadOfSchemaType, Payload } 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
+
+export type ApiCallWitnessConfigBase = WitnessConfig<{
+  accept?: 'application/json'
+  queries?: ApiCall['queries']
+  schema: ApiCallWitnessConfigSchema
+  timeout?: number
+  verb?: ApiCall['verb']
+}>
+
+export type ApiUriCallWitnessConfig = WitnessConfig<
+  ApiCallWitnessConfigBase & {
+    uri: ApiUriCall['uri']
+  }
+>
+
+export type ApiUriTemplateCallWitnessConfig = WitnessConfig<
+  ApiCallWitnessConfigBase & {
+    params?: Record<string, unknown>
+    uriTemplate: ApiUriTemplateCall['uriTemplate']
+  }
+>
+
+export type ApiCallWitnessConfig = ApiUriCallWitnessConfig | ApiUriTemplateCallWitnessConfig | ApiCallWitnessConfigBase
+
+export const isApiCallWitnessConfig = isPayloadOfSchemaType(ApiCallWitnessConfigSchema)
+export const asApiCallWitnessConfig = AsObjectFactory.create(isApiCallWitnessConfig)
+
+export const isApiUriCallWitnessConfig = (payload?: Payload): payload is ApiUriCallWitnessConfig =>
+  isApiCallWitnessConfig(payload) && !!(payload as ApiUriCallWitnessConfig).uri
+export const asApiUriCallWitnessConfig = AsObjectFactory.create(isApiUriCallWitnessConfig)
+
+export const isApiUriTemplateCallWitnessConfig = (payload?: Payload): payload is ApiUriTemplateCallWitnessConfig =>
+  isApiCallWitnessConfig(payload) && !!(payload as ApiUriTemplateCallWitnessConfig).uriTemplate
+export const asApiUriTemplateCallWitnessConfig = AsObjectFactory.create(isApiUriTemplateCallWitnessConfig)

package/src/Payload.ts

@@ -1,19 +1,35 @@
 import { Hash } from '@xyo-network/hash'
-import { Payload } from '@xyo-network/payload-model'
+import { AsObjectFactory } from '@xyo-network/object'
+import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
 
 export const ApiCallSchema = 'network.xyo.api.call'
 export type ApiCallSchema = typeof ApiCallSchema
 
-export type Verb = 'get' | 'post'
+type Verb = 'get' | 'post'
+type Queries = Record<string, string>
 
-export type ApiCall = Payload<
-  {
+export interface ApiCallFields {
+  queries?: Queries
+  verb?: Verb
+}
+
+export type ApiUriCall = Payload<
+  ApiCallFields & {
     uri: string
-    verb?: Verb
   },
   ApiCallSchema
 >
 
+export type ApiUriTemplateCall = Payload<
+  ApiCallFields & {
+    params?: Record<string, unknown>
+    uriTemplate?: string
+  },
+  ApiCallSchema
+>
+
+export type ApiCall = ApiUriCall | ApiUriTemplateCall
+
 export const ApiCallResultSchema = 'network.xyo.api.call.result'
 export type ApiCallResultSchema = typeof ApiCallResultSchema
 
@@ -49,3 +65,13 @@ export type ApiCallErrorResult = Payload<
 >
 
 export type ApiCallResult = ApiCallBase64Result | ApiCallJsonResult | ApiCallErrorResult
+
+export const isApiCall = isPayloadOfSchemaType(ApiCallSchema)
+export const asApiCall = AsObjectFactory.create(isApiCall)
+
+export const isApiUriCall = (payload?: Payload): payload is ApiUriCall => isApiCall(payload) && !!(payload as ApiUriCall).uri
+export const asApiUriCall = AsObjectFactory.create(isApiUriCall)
+
+export const isApiUriTemplateCall = (payload?: Payload): payload is ApiUriTemplateCall =>
+  isApiCall(payload) && !!((payload as ApiUriTemplateCall).uriTemplate || (payload as ApiUriTemplateCall).params)
+export const asApiUriTemplateCall = AsObjectFactory.create(isApiUriTemplateCall)

package/src/Witness.ts

@@ -5,9 +5,11 @@ import { AbstractWitness } from '@xyo-network/abstract-witness'
 import { Hash, PayloadHasher } from '@xyo-network/hash'
 import { JsonArray, JsonObject } from '@xyo-network/object'
 import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
-import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model'
+import { WitnessParams } from '@xyo-network/witness-model'
 import { fromByteArray } from 'base64-js'
+import template from 'es6-template-strings'
 
+import { ApiCallWitnessConfig, ApiCallWitnessConfigSchema, asApiUriCallWitnessConfig, asApiUriTemplateCallWitnessConfig } from './Config'
 import { checkIpfsUrl } from './lib'
 import {
   ApiCall,
@@ -17,37 +19,71 @@ import {
   ApiCallResult,
   ApiCallResultSchema,
   ApiCallSchema,
-  Verb,
+  asApiUriCall,
+  asApiUriTemplateCall,
 } from './Payload'
 
-export const ApiCallWitnessConfigSchema = 'network.xyo.api.call.witness.config'
-export type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema
-
-export type ApiCallWitnessConfig = WitnessConfig<{
-  accept: 'application/json'
-  schema: ApiCallWitnessConfigSchema
-  verb?: Verb
-}>
-
-export type ApiCallWitnessParams = WitnessParams<ApiCallWitnessConfig, { ipfsGateway?: string }>
+export type ApiCallWitnessParams = WitnessParams<
+  ApiCallWitnessConfig,
+  {
+    headers?: Record<string, string | undefined>
+    ipfsGateway?: string
+  }
+>
 
 export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnessParams> extends AbstractWitness<TParams, ApiCall, ApiCallResult> {
   static override configSchemas = [ApiCallWitnessConfigSchema]
 
   get accept() {
-    return this.config.accept
+    return this.config.accept ?? 'application/json'
   }
 
   get ipfsGateway() {
     return this.params.ipfsGateway
   }
 
+  get timeout() {
+    return this.config.timeout
+  }
+
+  getFullUri(call?: ApiCall): string {
+    const { uri: callUri } = asApiUriCall(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(template(callUriTemplate, params))
+    } else if (configUri) {
+      url = new URL(configUri)
+    } else if (configUriTemplate) {
+      url = new URL(template(configUriTemplate, params))
+    }
+
+    if (url) {
+      const queries = Object.entries({ ...configQueries, ...callQueries })
+      queries.map(([key, value]) => url?.searchParams.set(key, value))
+      return url.href
+    }
+
+    throw Error('Unable to determine uri. No uri/uriTemplate specified in either the call or config.')
+  }
+
   protected override async observeHandler(inPayloads: ApiCall[] = []): Promise<ApiCallResult[]> {
     await this.started('throw')
     try {
       const observations = await Promise.all(
         inPayloads.filter(isPayloadOfSchemaType(ApiCallSchema)).map(async (call) => {
-          const { uri, verb } = 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')
 
@@ -65,7 +101,8 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
       return observations
     } catch (ex) {
       const error = ex as Error
-      console.log(`Error [${this.config.name}]: ${error.message}`)
+      console.error(`Error [${this.config.name}]: ${error.message}`)
+      console.log(error.stack)
       throw error
     }
   }
@@ -78,7 +115,7 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
     try {
       switch (this.accept) {
         case 'application/json': {
-          const axios = new AxiosJson()
+          const axios = new AxiosJson({ headers: this.params.headers, timeout: this.timeout })
           const response = await axios.get<JsonArray | JsonObject>(url)
           if (response.status >= 200 && response.status < 300) {
             const jsonResult = result as ApiCallJsonResult
@@ -93,7 +130,7 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
           break
         }
         default: {
-          const axios = new Axios({ responseType: 'arraybuffer' })
+          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

package/src/index.ts

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

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

@@ -0,0 +1,41 @@
+{
+  "$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,
+                  "module": "ApiCallWitness"
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "schema": "network.xyo.manifest"
+}

package/src/types.d.ts

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