@xyo-network/http-call-witness 4.1.0 → 4.2.0

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 (2) hide show
  1. package/dist/neutral/index.d.ts +3 -146
  2. package/package.json +20 -21
package/dist/neutral/index.d.ts CHANGED
@@ -1,146 +1,3 @@
1
- import * as _xylabs_object from '@xylabs/object';
2
- import { JsonArray, JsonObject } from '@xylabs/object';
3
- import { Payload, Schema } from '@xyo-network/payload-model';
4
- import { Hash } from '@xylabs/hex';
5
- import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
6
- import { AbstractWitness } from '@xyo-network/abstract-witness';
7
-
8
- declare const asApiCall: _xylabs_object.AsTypeFunction<HttpCall>;
9
-
10
- declare const asHttpCallBase64Result: _xylabs_object.AsTypeFunction<HttpCallBase64Result>;
11
-
12
- declare const asHttpCallResult: _xylabs_object.AsTypeFunction<HttpCallResult>;
13
-
14
- declare const asHttpCallXmlResult: _xylabs_object.AsTypeFunction<HttpCallXmlResult>;
15
-
16
- declare const asHttpUriCall: _xylabs_object.AsTypeFunction<HttpUriCall>;
17
-
18
- declare const asHttpUriTemplateCall: _xylabs_object.AsTypeFunction<HttpUriTemplateCall>;
19
-
20
- declare const HttpCallSchema = "network.xyo.http.call";
21
- type HttpCallSchema = typeof HttpCallSchema;
22
- declare const HttpCallResultSchema = "network.xyo.http.call.result";
23
- type HttpCallResultSchema = typeof HttpCallResultSchema;
24
-
25
- type Queries = Record<string, string>;
26
-
27
- type Verb = 'get' | 'post';
28
-
29
- interface HttpCallFields {
30
- headers?: Record<string, string | undefined>;
31
- queries?: Queries;
32
- verb?: Verb;
33
- }
34
-
35
- type HttpUriCall = Payload<HttpCallFields & {
36
- uri: string;
37
- }, HttpCallSchema>;
38
-
39
- type HttpUriTemplateCall = Payload<HttpCallFields & {
40
- params?: Record<string, string>;
41
- uriTemplate?: string;
42
- }, HttpCallSchema>;
43
-
44
- type HttpCall = HttpUriCall | HttpUriTemplateCall;
45
-
46
- type HttpCallJsonResultType = JsonArray | JsonObject;
47
- type HttpCallJsonResult<T extends HttpCallJsonResultType = HttpCallJsonResultType> = Payload<{
48
- call: Hash;
49
- contentType: 'application/json';
50
- data: T;
51
- }, HttpCallResultSchema>;
52
- declare const isHttpCallJsonResult: <T extends HttpCallJsonResultType = HttpCallJsonResultType>(x?: unknown | null) => x is HttpCallJsonResult<T>;
53
- declare const asHttpCallJsonResult: _xylabs_object.AsTypeFunction<HttpCallJsonResult<HttpCallJsonResultType>>;
54
-
55
- type HttpCallXmlResult = Payload<{
56
- call: Hash;
57
- contentType: 'application/xml' | 'text/xml';
58
- data: string;
59
- }, HttpCallResultSchema>;
60
-
61
- type HttpCallBase64Result = Payload<{
62
- call: Hash;
63
- contentType: Exclude<Exclude<string, HttpCallJsonResult['contentType']>, HttpCallXmlResult['contentType']>;
64
- data: string;
65
- }, HttpCallResultSchema>;
66
-
67
- interface HttpMeta {
68
- code?: string;
69
- status?: number;
70
- }
71
-
72
- type HttpCallErrorResult = Payload<{
73
- call: Hash;
74
- http?: HttpMeta;
75
- }, HttpCallResultSchema>;
76
-
77
- type HttpCallHtmlResult = Payload<{
78
- call: Hash;
79
- contentType: 'text/html';
80
- data: string;
81
- }, HttpCallResultSchema>;
82
-
83
- type NewType = JsonObject;
84
- type HttpCallResult<TJson extends JsonArray | JsonObject = JsonArray | NewType> = HttpCallBase64Result | HttpCallJsonResult<TJson> | HttpCallErrorResult;
85
-
86
- type MimeTypes = 'application/json' | 'application/octet-stream' | 'application/pdf' | 'application/xhtml+xml' | 'application/xml' | 'image/gif' | 'image/jpeg' | 'image/png' | 'text/html' | 'text/plain' | 'text/xml';
87
-
88
- declare const isHttpCall: (x?: unknown | null) => x is HttpCall;
89
-
90
- declare const isHttpCallBase64Result: (x?: unknown | null) => x is HttpCallBase64Result;
91
-
92
- declare const isHttpCallErrorResult: (value: unknown) => value is HttpCallErrorResult;
93
-
94
- declare const isHttpCallResult: (x?: unknown | null) => x is HttpCallResult;
95
-
96
- declare const isHttpCallXmlResult: (x?: unknown | null) => x is HttpCallXmlResult;
97
-
98
- declare const isHttpUriCall: (value?: unknown) => value is HttpUriCall;
99
-
100
- declare const isHttpUriTemplateCall: (value?: unknown) => value is HttpUriTemplateCall;
101
-
102
- declare const HttpCallWitnessConfigSchema = "network.xyo.http.call.witness.config";
103
- type HttpCallWitnessConfigSchema = typeof HttpCallWitnessConfigSchema;
104
-
105
- type HttpCallWitnessConfigBase = WitnessConfig<{
106
- accept?: MimeTypes;
107
- headers?: Record<string, string | undefined>;
108
- queries?: HttpCall['queries'];
109
- schema: HttpCallWitnessConfigSchema;
110
- timeout?: number;
111
- verb?: HttpCall['verb'];
112
- }>;
113
- type HttpUriCallWitnessConfig = WitnessConfig<HttpCallWitnessConfigBase & {
114
- uri: HttpUriCall['uri'];
115
- }>;
116
- type HttpUriTemplateCallWitnessConfig = WitnessConfig<HttpCallWitnessConfigBase & {
117
- params?: Record<string, string>;
118
- uriTemplate: HttpUriTemplateCall['uriTemplate'];
119
- }>;
120
- type HttpCallWitnessConfig = HttpUriCallWitnessConfig | HttpUriTemplateCallWitnessConfig | HttpCallWitnessConfigBase;
121
- declare const isHttpCallWitnessConfig: (x?: unknown | null) => x is HttpCallWitnessConfig;
122
- declare const asHttpCallWitnessConfig: _xylabs_object.AsTypeFunction<HttpCallWitnessConfig>;
123
- declare const isHttpUriCallWitnessConfig: (value?: unknown) => value is HttpUriCallWitnessConfig;
124
- declare const asHttpUriCallWitnessConfig: _xylabs_object.AsTypeFunction<HttpUriCallWitnessConfig>;
125
- declare const isHttpUriTemplateCallWitnessConfig: (value?: unknown) => value is HttpUriTemplateCallWitnessConfig;
126
- declare const asHttpUriTemplateCallWitnessConfig: _xylabs_object.AsTypeFunction<HttpUriTemplateCallWitnessConfig>;
127
-
128
- interface HttpCallWitnessParams extends WitnessParams<HttpCallWitnessConfig> {
129
- headers?: Record<string, string | undefined>;
130
- ipfsGateway?: string;
131
- }
132
-
133
- declare class HttpCallWitness<TParams extends HttpCallWitnessParams = HttpCallWitnessParams> extends AbstractWitness<TParams, HttpCall, HttpCallResult> {
134
- static readonly configSchemas: Schema[];
135
- static readonly defaultConfigSchema: Schema;
136
- get accept(): MimeTypes;
137
- get ipfsGateway(): string | undefined;
138
- get timeout(): number | undefined;
139
- getFullUri(call?: HttpCall): string;
140
- getHeaders(headers?: Record<string, string | undefined>): Record<string, string | undefined>;
141
- protected observeHandler(inPayloads?: HttpCall[]): Promise<HttpCallResult[]>;
142
- private httpGet;
143
- }
144
-
145
- export { HttpCallResultSchema, HttpCallSchema, HttpCallWitness, HttpCallWitnessConfigSchema, asApiCall, asHttpCallBase64Result, asHttpCallJsonResult, asHttpCallResult, asHttpCallWitnessConfig, asHttpCallXmlResult, asHttpUriCall, asHttpUriCallWitnessConfig, asHttpUriTemplateCall, asHttpUriTemplateCallWitnessConfig, isHttpCall, isHttpCallBase64Result, isHttpCallErrorResult, isHttpCallJsonResult, isHttpCallResult, isHttpCallWitnessConfig, isHttpCallXmlResult, isHttpUriCall, isHttpUriCallWitnessConfig, isHttpUriTemplateCall, isHttpUriTemplateCallWitnessConfig };
146
- export type { HttpCall, HttpCallBase64Result, HttpCallErrorResult, HttpCallFields, HttpCallHtmlResult, HttpCallJsonResult, HttpCallJsonResultType, HttpCallResult, HttpCallWitnessConfig, HttpCallWitnessConfigBase, HttpCallWitnessParams, HttpCallXmlResult, HttpMeta, HttpUriCall, HttpUriCallWitnessConfig, HttpUriTemplateCall, HttpUriTemplateCallWitnessConfig, MimeTypes, Queries, Verb };
1
+ export * from './Payload/index.ts';
2
+ export * from './Witness/index.ts';
3
+ //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/http-call-witness",
3
- "version": "4.1.0",
3
+ "version": "4.2.0",
4
4
  "description": "Typescript/Javascript Plugins for XYO Platform",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,31 +29,30 @@
29
29
  "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/assert": "^4.13.15",
33
- "@xylabs/axios": "^4.13.15",
34
- "@xylabs/hex": "^4.13.15",
35
- "@xylabs/object": "^4.13.15",
36
- "@xylabs/url": "^4.13.15",
37
- "@xyo-network/abstract-witness": "^4.1.1",
38
- "@xyo-network/hash": "^4.1.1",
39
- "@xyo-network/payload-builder": "^4.1.1",
40
- "@xyo-network/payload-model": "^4.1.1",
41
- "@xyo-network/witness-model": "^4.1.1",
42
- "axios": "^1.10.0",
32
+ "@xylabs/assert": "^4.15.1",
33
+ "@xylabs/axios": "^4.15.1",
34
+ "@xylabs/hex": "^4.15.1",
35
+ "@xylabs/object": "^4.15.1",
36
+ "@xylabs/url": "^4.15.1",
37
+ "@xyo-network/abstract-witness": "^4.3.0",
38
+ "@xyo-network/hash": "^4.3.0",
39
+ "@xyo-network/payload-builder": "^4.3.0",
40
+ "@xyo-network/payload-model": "^4.3.0",
41
+ "@xyo-network/witness-model": "^4.3.0",
42
+ "axios": "^1.11.0",
43
43
  "base64-js": "^1.5.1",
44
44
  "es6-dynamic-template": "^2.0.0"
45
45
  },
46
46
  "devDependencies": {
47
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
48
- "@xylabs/tsconfig": "^7.0.0-rc.24",
49
- "@xylabs/vitest-extended": "^4.13.15",
50
- "@xyo-network/manifest": "^4.1.1",
51
- "@xyo-network/module-factory-locator": "^4.1.1",
52
- "@xyo-network/module-model": "^4.1.1",
53
- "@xyo-network/sentinel-model": "^4.1.1",
54
- "@xyo-network/wallet": "^4.1.1",
47
+ "@xylabs/ts-scripts-yarn3": "^7.0.1",
48
+ "@xylabs/tsconfig": "^7.0.1",
49
+ "@xylabs/vitest-extended": "^4.15.1",
50
+ "@xyo-network/manifest": "^4.3.0",
51
+ "@xyo-network/module-factory-locator": "^4.3.0",
52
+ "@xyo-network/module-model": "^4.3.0",
53
+ "@xyo-network/sentinel-model": "^4.3.0",
54
+ "@xyo-network/wallet": "^4.3.0",
55
55
  "ethers": "^6.15.0",
56
- "knip": "^5.61.3",
57
56
  "typescript": "^5.8.3",
58
57
  "vitest": "^3.2.4"
59
58
  },