@xyo-network/api-call-witness 2.94.5 → 2.94.6

package/package.json

@@ -14,11 +14,11 @@
     "@xylabs/axios": "^3.3.2",
     "@xylabs/hex": "^3.3.2",
     "@xylabs/object": "^3.3.2",
-    "@xyo-network/abstract-witness": "^2.99.3",
-    "@xyo-network/hash": "^2.99.3",
-    "@xyo-network/payload-builder": "^2.99.3",
-    "@xyo-network/payload-model": "^2.99.3",
-    "@xyo-network/witness-model": "^2.99.3",
+    "@xyo-network/abstract-witness": "^2.99.6",
+    "@xyo-network/hash": "^2.99.6",
+    "@xyo-network/payload-builder": "^2.99.6",
+    "@xyo-network/payload-model": "^2.99.6",
+    "@xyo-network/witness-model": "^2.99.6",
     "base64-js": "^1.5.1",
     "es6-dynamic-template": "^2.0.0"
   },
@@ -26,11 +26,11 @@
     "@xylabs/jest-helpers": "^3.3.2",
     "@xylabs/ts-scripts-yarn3": "^3.10.0",
     "@xylabs/tsconfig": "^3.10.0",
-    "@xyo-network/account": "^2.99.3",
-    "@xyo-network/manifest": "^2.99.3",
-    "@xyo-network/module-factory-locator": "^2.99.3",
-    "@xyo-network/module-model": "^2.99.3",
-    "@xyo-network/sentinel-model": "^2.99.3",
+    "@xyo-network/account": "^2.99.6",
+    "@xyo-network/manifest": "^2.99.6",
+    "@xyo-network/module-factory-locator": "^2.99.6",
+    "@xyo-network/module-model": "^2.99.6",
+    "@xyo-network/sentinel-model": "^2.99.6",
     "ethers": "^6.12.1",
     "jest": "^29.7.0",
     "typescript": "^5.4.5"
@@ -74,6 +74,6 @@
     "url": "https://github.com/XYOracleNetwork/plugins.git"
   },
   "sideEffects": false,
-  "version": "2.94.5",
+  "version": "2.94.6",
   "type": "module"
 }

package/src/Config.ts

@@ -9,6 +9,7 @@ export type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema
 
 export type ApiCallWitnessConfigBase = WitnessConfig<{
   accept?: 'application/json'
+  headers?: Record<string, string | undefined>
   queries?: ApiCall['queries']
   schema: ApiCallWitnessConfigSchema
   timeout?: number

package/src/Payload.ts

@@ -9,6 +9,7 @@ export type Verb = 'get' | 'post'
 export type Queries = Record<string, string>
 
 export interface ApiCallFields {
+  headers?: Record<string, string | undefined>
   queries?: Queries
   verb?: Verb
 }

package/src/Witness.ts

@@ -78,6 +78,10 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
     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: ApiCall[] = []): Promise<ApiCallResult[]> {
     await this.started('throw')
     try {
@@ -110,7 +114,7 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
     }
   }
 
-  private async httpGet(url: string, call: Hash): Promise<ApiCallResult> {
+  private async httpGet(url: string, call: Hash, headers?: Record<string, string | undefined>): Promise<ApiCallResult> {
     const result: ApiCallResult = {
       call,
       schema: ApiCallResultSchema,
@@ -118,7 +122,7 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
     try {
       switch (this.accept) {
         case 'application/json': {
-          const axios = new AxiosJson({ headers: { ...this.params.headers, Accept: 'application/json' }, timeout: this.timeout })
+          const axios = new AxiosJson({ 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