@xyo-network/api-call-witness 3.2.2 → 3.2.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.
- package/dist/neutral/Payload/identity/asApiCall.d.ts +3 -3
- package/dist/neutral/Payload/identity/asApiCall.d.ts.map +1 -1
- package/dist/neutral/Payload/identity/asApiCallBase64Result.d.ts +2 -2
- package/dist/neutral/Payload/identity/asApiCallResult.d.ts +2 -2
- package/dist/neutral/Payload/identity/asApiCallXmlResult.d.ts +2 -2
- package/dist/neutral/Payload/identity/asApiUriCall.d.ts +3 -3
- package/dist/neutral/Payload/identity/asApiUriCall.d.ts.map +1 -1
- package/dist/neutral/Payload/identity/asApiUriTemplateCall.d.ts +2 -2
- package/dist/neutral/Payload/identity/asApiUriTemplateCall.d.ts.map +1 -1
- package/dist/neutral/Payload/identity/isApiCall.d.ts +2 -2
- package/dist/neutral/Payload/identity/isApiCall.d.ts.map +1 -1
- package/dist/neutral/Payload/identity/isApiCallBase64Result.d.ts.map +1 -1
- package/dist/neutral/Payload/identity/isApiCallXmlResult.d.ts.map +1 -1
- package/dist/neutral/Payload/identity/isApiUriCall.d.ts +2 -2
- package/dist/neutral/Payload/identity/isApiUriCall.d.ts.map +1 -1
- package/dist/neutral/Payload/identity/isApiUriTemplateCall.d.ts +2 -2
- package/dist/neutral/Payload/identity/isApiUriTemplateCall.d.ts.map +1 -1
- package/dist/neutral/Payload/types/ApiCall.d.ts +3 -3
- package/dist/neutral/Payload/types/ApiCall.d.ts.map +1 -1
- package/dist/neutral/Payload/types/ApiCallJsonResult.d.ts +74 -74
- package/dist/neutral/Payload/types/ApiCallJsonResult.d.ts.map +1 -1
- package/dist/neutral/Payload/types/ApiUriCall.d.ts +1 -1
- package/dist/neutral/Payload/types/ApiUriCall.d.ts.map +1 -1
- package/dist/neutral/Payload/types/ApiUriTemplateCall.d.ts +1 -1
- package/dist/neutral/Payload/types/ApiUriTemplateCall.d.ts.map +1 -1
- package/dist/neutral/Witness/Config.d.ts +35 -35
- package/dist/neutral/Witness/Config.d.ts.map +1 -1
- package/dist/neutral/Witness/Witness.d.ts +4 -4
- package/dist/neutral/Witness/Witness.d.ts.map +1 -1
- package/dist/neutral/index.mjs +13 -14
- package/dist/neutral/index.mjs.map +1 -1
- package/package.json +16 -17
- package/src/Payload/identity/asApiCall.ts +2 -2
- package/src/Payload/identity/asApiUriCall.ts +2 -2
- package/src/Payload/identity/asApiUriTemplateCall.ts +2 -2
- package/src/Payload/identity/isApiCall.ts +2 -2
- package/src/Payload/identity/isApiCallBase64Result.ts +2 -2
- package/src/Payload/identity/isApiCallXmlResult.ts +2 -2
- package/src/Payload/identity/isApiUriCall.ts +3 -3
- package/src/Payload/identity/isApiUriTemplateCall.ts +4 -4
- package/src/Payload/types/ApiCall.ts +3 -3
- package/src/Payload/types/ApiCallJsonResult.ts +2 -1
- package/src/Payload/types/ApiUriCall.ts +1 -1
- package/src/Payload/types/ApiUriTemplateCall.ts +1 -1
- package/src/Witness/Config.ts +5 -5
- package/src/Witness/Witness.ts +8 -9
|
@@ -5,6 +5,7 @@ import type { Payload } from '@xyo-network/payload-model'
|
|
|
5
5
|
import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
|
|
6
6
|
|
|
7
7
|
import { ApiCallResultSchema } from '../Schema.ts'
|
|
8
|
+
import type { ApiCallResult } from './ApiCallResult.ts'
|
|
8
9
|
|
|
9
10
|
export type ApiCallJsonResultType = JsonArray | JsonObject
|
|
10
11
|
|
|
@@ -18,6 +19,6 @@ export type ApiCallJsonResult<T extends ApiCallJsonResultType = ApiCallJsonResul
|
|
|
18
19
|
>
|
|
19
20
|
|
|
20
21
|
export const isApiCallJsonResult = <T extends ApiCallJsonResultType = ApiCallJsonResultType>(x?: unknown | null): x is ApiCallJsonResult<T> => {
|
|
21
|
-
return isPayloadOfSchemaType(ApiCallResultSchema)(x) && (x as ApiCallJsonResult)?.contentType === 'application/json'
|
|
22
|
+
return isPayloadOfSchemaType<ApiCallResult>(ApiCallResultSchema)(x) && (x as ApiCallJsonResult)?.contentType === 'application/json'
|
|
22
23
|
}
|
|
23
24
|
export const asApiCallJsonResult = AsObjectFactory.create(isApiCallJsonResult)
|
|
@@ -3,7 +3,7 @@ import type { Payload } from '@xyo-network/payload-model'
|
|
|
3
3
|
import type { ApiCallSchema } from '../Schema.ts'
|
|
4
4
|
import type { ApiCallFields } from './ApiCallFields.ts'
|
|
5
5
|
|
|
6
|
-
export type
|
|
6
|
+
export type ApiUriCallPayload = Payload<
|
|
7
7
|
ApiCallFields & {
|
|
8
8
|
uri: string
|
|
9
9
|
},
|
|
@@ -3,7 +3,7 @@ import type { Payload } from '@xyo-network/payload-model'
|
|
|
3
3
|
import type { ApiCallSchema } from '../Schema.ts'
|
|
4
4
|
import type { ApiCallFields } from './ApiCallFields.ts'
|
|
5
5
|
|
|
6
|
-
export type
|
|
6
|
+
export type ApiUriTemplateCallPayload = Payload<
|
|
7
7
|
ApiCallFields & {
|
|
8
8
|
params?: Record<string, string>
|
|
9
9
|
uriTemplate?: string
|
package/src/Witness/Config.ts
CHANGED
|
@@ -3,29 +3,29 @@ import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
|
|
|
3
3
|
import type { WitnessConfig } from '@xyo-network/witness-model'
|
|
4
4
|
|
|
5
5
|
import type {
|
|
6
|
-
|
|
6
|
+
ApiCallPayload, ApiUriCallPayload, ApiUriTemplateCallPayload, MimeTypes,
|
|
7
7
|
} from '../Payload/index.ts'
|
|
8
8
|
import { ApiCallWitnessConfigSchema } from './Schema.ts'
|
|
9
9
|
|
|
10
10
|
export type ApiCallWitnessConfigBase = WitnessConfig<{
|
|
11
11
|
accept?: MimeTypes
|
|
12
12
|
headers?: Record<string, string | undefined>
|
|
13
|
-
queries?:
|
|
13
|
+
queries?: ApiCallPayload['queries']
|
|
14
14
|
schema: ApiCallWitnessConfigSchema
|
|
15
15
|
timeout?: number
|
|
16
|
-
verb?:
|
|
16
|
+
verb?: ApiCallPayload['verb']
|
|
17
17
|
}>
|
|
18
18
|
|
|
19
19
|
export type ApiUriCallWitnessConfig = WitnessConfig<
|
|
20
20
|
ApiCallWitnessConfigBase & {
|
|
21
|
-
uri:
|
|
21
|
+
uri: ApiUriCallPayload['uri']
|
|
22
22
|
}
|
|
23
23
|
>
|
|
24
24
|
|
|
25
25
|
export type ApiUriTemplateCallWitnessConfig = WitnessConfig<
|
|
26
26
|
ApiCallWitnessConfigBase & {
|
|
27
27
|
params?: Record<string, string>
|
|
28
|
-
uriTemplate:
|
|
28
|
+
uriTemplate: ApiUriTemplateCallPayload['uriTemplate']
|
|
29
29
|
}
|
|
30
30
|
>
|
|
31
31
|
|
package/src/Witness/Witness.ts
CHANGED
|
@@ -4,7 +4,6 @@ import { AxiosJson } from '@xylabs/axios'
|
|
|
4
4
|
import type { Hash } from '@xylabs/hex'
|
|
5
5
|
import { URL } from '@xylabs/url'
|
|
6
6
|
import { AbstractWitness } from '@xyo-network/abstract-witness'
|
|
7
|
-
import { PayloadHasher } from '@xyo-network/hash'
|
|
8
7
|
import { PayloadBuilder } from '@xyo-network/payload-builder'
|
|
9
8
|
import type { Schema } from '@xyo-network/payload-model'
|
|
10
9
|
import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
|
|
@@ -15,11 +14,11 @@ import fillTemplate from 'es6-dynamic-template'
|
|
|
15
14
|
|
|
16
15
|
import { checkIpfsUrl } from '../lib/index.ts'
|
|
17
16
|
import type {
|
|
18
|
-
ApiCall,
|
|
19
17
|
ApiCallBase64Result,
|
|
20
18
|
ApiCallErrorResult,
|
|
21
19
|
ApiCallJsonResult,
|
|
22
20
|
ApiCallJsonResultType,
|
|
21
|
+
ApiCallPayload,
|
|
23
22
|
ApiCallResult,
|
|
24
23
|
ApiCallXmlResult,
|
|
25
24
|
MimeTypes,
|
|
@@ -27,14 +26,14 @@ import type {
|
|
|
27
26
|
import {
|
|
28
27
|
ApiCallResultSchema,
|
|
29
28
|
ApiCallSchema,
|
|
30
|
-
|
|
29
|
+
asApiUriCallPayload,
|
|
31
30
|
asApiUriTemplateCall,
|
|
32
31
|
} from '../Payload/index.ts'
|
|
33
32
|
import { asApiUriCallWitnessConfig, asApiUriTemplateCallWitnessConfig } from './Config.ts'
|
|
34
33
|
import type { ApiCallWitnessParams } from './Params.ts'
|
|
35
34
|
import { ApiCallWitnessConfigSchema } from './Schema.ts'
|
|
36
35
|
|
|
37
|
-
export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnessParams> extends AbstractWitness<TParams,
|
|
36
|
+
export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnessParams> extends AbstractWitness<TParams, ApiCallPayload, ApiCallResult> {
|
|
38
37
|
static override readonly configSchemas: Schema[] = [...super.configSchemas, ApiCallWitnessConfigSchema]
|
|
39
38
|
static override readonly defaultConfigSchema: Schema = ApiCallWitnessConfigSchema
|
|
40
39
|
|
|
@@ -50,8 +49,8 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
|
|
|
50
49
|
return this.config.timeout
|
|
51
50
|
}
|
|
52
51
|
|
|
53
|
-
getFullUri(call?:
|
|
54
|
-
const { uri: callUri } =
|
|
52
|
+
getFullUri(call?: ApiCallPayload): string {
|
|
53
|
+
const { uri: callUri } = asApiUriCallPayload(call) ?? {}
|
|
55
54
|
const {
|
|
56
55
|
uriTemplate: callUriTemplate, params: callParams, queries: callQueries,
|
|
57
56
|
} = asApiUriTemplateCall(call) ?? {}
|
|
@@ -89,11 +88,11 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
|
|
|
89
88
|
}
|
|
90
89
|
}
|
|
91
90
|
|
|
92
|
-
protected override async observeHandler(inPayloads:
|
|
91
|
+
protected override async observeHandler(inPayloads: ApiCallPayload[] = []): Promise<ApiCallResult[]> {
|
|
93
92
|
await this.started('throw')
|
|
94
93
|
try {
|
|
95
94
|
const observations = await Promise.all(
|
|
96
|
-
inPayloads.filter(isPayloadOfSchemaType(ApiCallSchema)).map(async (call) => {
|
|
95
|
+
inPayloads.filter(isPayloadOfSchemaType<ApiCallPayload>(ApiCallSchema)).map(async (call) => {
|
|
97
96
|
const { verb: callVerb } = call
|
|
98
97
|
const { verb: configVerb } = this.config
|
|
99
98
|
const verb = callVerb ?? configVerb ?? 'get'
|
|
@@ -106,7 +105,7 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
|
|
|
106
105
|
}
|
|
107
106
|
|
|
108
107
|
const observation: ApiCallResult = {
|
|
109
|
-
call: await
|
|
108
|
+
call: await PayloadBuilder.hash(call),
|
|
110
109
|
schema: ApiCallResultSchema,
|
|
111
110
|
}
|
|
112
111
|
return observation
|