@xyo-network/api-call-witness 4.0.0 → 4.1.1

package/dist/neutral/Witness/spec/Witness.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=Witness.spec.d.ts.map

package/dist/neutral/Witness/spec/Witness.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.spec.d.ts","sourceRoot":"","sources":["../../../../src/Witness/spec/Witness.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/Witness/spec/opensea.nft-call.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=opensea.nft-call.spec.d.ts.map

package/dist/neutral/Witness/spec/opensea.nft-call.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"opensea.nft-call.spec.d.ts","sourceRoot":"","sources":["../../../../src/Witness/spec/opensea.nft-call.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/index.d.ts

@@ -0,0 +1,140 @@
+import * as _xylabs_object from '@xylabs/object';
+import { JsonArray, JsonObject } from '@xylabs/object';
+import { Payload, Schema } from '@xyo-network/payload-model';
+import { Hash } from '@xylabs/hex';
+import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
+import { AbstractWitness } from '@xyo-network/abstract-witness';
+
+declare const asApiCallPayload: _xylabs_object.AsTypeFunction<ApiCallPayload>;
+
+declare const asApiCallBase64Result: _xylabs_object.AsTypeFunction<ApiCallBase64Result>;
+
+declare const asApiCallResult: _xylabs_object.AsTypeFunction<ApiCallResult>;
+
+declare const asApiCallXmlResult: _xylabs_object.AsTypeFunction<ApiCallXmlResult>;
+
+declare const asApiUriCallPayload: _xylabs_object.AsTypeFunction<ApiUriCallPayload>;
+
+declare const asApiUriTemplateCall: _xylabs_object.AsTypeFunction<ApiUriTemplateCallPayload>;
+
+declare const ApiCallSchema = "network.xyo.api.call";
+type ApiCallSchema = typeof ApiCallSchema;
+declare const ApiCallResultSchema = "network.xyo.api.call.result";
+type ApiCallResultSchema = typeof ApiCallResultSchema;
+
+type Queries = Record<string, string>;
+
+type Verb = 'get' | 'post';
+
+interface ApiCallFields {
+    headers?: Record<string, string | undefined>;
+    queries?: Queries;
+    verb?: Verb;
+}
+
+type ApiUriCallPayload = Payload<ApiCallFields & {
+    uri: string;
+}, ApiCallSchema>;
+
+type ApiUriTemplateCallPayload = Payload<ApiCallFields & {
+    params?: Record<string, string>;
+    uriTemplate?: string;
+}, ApiCallSchema>;
+
+type ApiCallPayload = ApiUriCallPayload | ApiUriTemplateCallPayload;
+
+type ApiCallJsonResultType = JsonArray | JsonObject;
+type ApiCallJsonResult<T extends ApiCallJsonResultType = ApiCallJsonResultType> = Payload<{
+    call: Hash;
+    contentType: 'application/json';
+    data: T;
+}, ApiCallResultSchema>;
+declare const isApiCallJsonResult: <T extends ApiCallJsonResultType = ApiCallJsonResultType>(x?: unknown | null) => x is ApiCallJsonResult<T>;
+declare const asApiCallJsonResult: _xylabs_object.AsTypeFunction<ApiCallJsonResult<ApiCallJsonResultType>>;
+
+type ApiCallXmlResult = Payload<{
+    call: Hash;
+    contentType: 'application/xml' | 'text/xml';
+    data: string;
+}, ApiCallResultSchema>;
+
+type ApiCallBase64Result = Payload<{
+    call: Hash;
+    contentType: Exclude<Exclude<string, ApiCallJsonResult['contentType']>, ApiCallXmlResult['contentType']>;
+    data: string;
+}, ApiCallResultSchema>;
+
+interface HttpMeta {
+    code?: string;
+    status?: number;
+}
+
+type ApiCallErrorResult = Payload<{
+    call: Hash;
+    http?: HttpMeta;
+}, ApiCallResultSchema>;
+
+type NewType = JsonObject;
+type ApiCallResult<TJson extends JsonArray | JsonObject = JsonArray | NewType> = ApiCallBase64Result | ApiCallJsonResult<TJson> | ApiCallErrorResult;
+
+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';
+
+declare const isApiCallPayload: (x?: unknown | null) => x is ApiCallPayload;
+
+declare const isApiCallBase64Result: (x?: unknown | null) => x is ApiCallBase64Result;
+
+declare const isApiCallErrorResult: (value: unknown) => value is ApiCallErrorResult;
+
+declare const isApiCallResult: (x?: unknown | null) => x is ApiCallResult;
+
+declare const isApiCallXmlResult: (x?: unknown | null) => x is ApiCallXmlResult;
+
+declare const isApiUriCallPayload: (value?: unknown) => value is ApiUriCallPayload;
+
+declare const isApiUriTemplateCallPayload: (value?: unknown) => value is ApiUriTemplateCallPayload;
+
+declare const ApiCallWitnessConfigSchema = "network.xyo.api.call.witness.config";
+type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema;
+
+type ApiCallWitnessConfigBase = WitnessConfig<{
+    accept?: MimeTypes;
+    headers?: Record<string, string | undefined>;
+    queries?: ApiCallPayload['queries'];
+    schema: ApiCallWitnessConfigSchema;
+    timeout?: number;
+    verb?: ApiCallPayload['verb'];
+}>;
+type ApiUriCallWitnessConfig = WitnessConfig<ApiCallWitnessConfigBase & {
+    uri: ApiUriCallPayload['uri'];
+}>;
+type ApiUriTemplateCallWitnessConfig = WitnessConfig<ApiCallWitnessConfigBase & {
+    params?: Record<string, string>;
+    uriTemplate: ApiUriTemplateCallPayload['uriTemplate'];
+}>;
+type ApiCallWitnessConfig = ApiUriCallWitnessConfig | ApiUriTemplateCallWitnessConfig | ApiCallWitnessConfigBase;
+declare const isApiCallWitnessConfig: (x?: unknown | null) => x is ApiCallWitnessConfig;
+declare const asApiCallWitnessConfig: _xylabs_object.AsTypeFunction<ApiCallWitnessConfig>;
+declare const isApiUriCallWitnessConfig: (value?: unknown) => value is ApiUriCallWitnessConfig;
+declare const asApiUriCallWitnessConfig: _xylabs_object.AsTypeFunction<ApiUriCallWitnessConfig>;
+declare const isApiUriTemplateCallWitnessConfig: (value?: unknown) => value is ApiUriTemplateCallWitnessConfig;
+declare const asApiUriTemplateCallWitnessConfig: _xylabs_object.AsTypeFunction<ApiUriTemplateCallWitnessConfig>;
+
+interface ApiCallWitnessParams extends WitnessParams<ApiCallWitnessConfig> {
+    headers?: Record<string, string | undefined>;
+    ipfsGateway?: string;
+}
+
+declare class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnessParams> extends AbstractWitness<TParams, ApiCallPayload, ApiCallResult> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    get accept(): MimeTypes;
+    get ipfsGateway(): string | undefined;
+    get timeout(): number | undefined;
+    getFullUri(call?: ApiCallPayload): string;
+    getHeaders(headers?: Record<string, string | undefined>): Record<string, string | undefined>;
+    protected observeHandler(inPayloads?: ApiCallPayload[]): Promise<ApiCallResult[]>;
+    private httpGet;
+}
+
+export { ApiCallResultSchema, ApiCallSchema, ApiCallWitness, ApiCallWitnessConfigSchema, asApiCallBase64Result, asApiCallJsonResult, asApiCallPayload, asApiCallResult, asApiCallWitnessConfig, asApiCallXmlResult, asApiUriCallPayload, asApiUriCallWitnessConfig, asApiUriTemplateCall, asApiUriTemplateCallWitnessConfig, isApiCallBase64Result, isApiCallErrorResult, isApiCallJsonResult, isApiCallPayload, isApiCallResult, isApiCallWitnessConfig, isApiCallXmlResult, isApiUriCallPayload, isApiUriCallWitnessConfig, isApiUriTemplateCallPayload, isApiUriTemplateCallWitnessConfig };
+export type { ApiCallBase64Result, ApiCallErrorResult, ApiCallFields, ApiCallJsonResult, ApiCallJsonResultType, ApiCallPayload, ApiCallResult, ApiCallWitnessConfig, ApiCallWitnessConfigBase, ApiCallWitnessParams, ApiCallXmlResult, ApiUriCallPayload, ApiUriCallWitnessConfig, ApiUriTemplateCallPayload, ApiUriTemplateCallWitnessConfig, HttpMeta, MimeTypes, Queries, Verb };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/api-call-witness",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,37 +21,37 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.12.31",
-    "@xylabs/axios": "^4.12.31",
-    "@xylabs/hex": "^4.12.31",
-    "@xylabs/object": "^4.12.31",
-    "@xylabs/url": "^4.12.31",
-    "@xyo-network/abstract-witness": "^4.0.1",
-    "@xyo-network/payload-builder": "^4.0.1",
-    "@xyo-network/payload-model": "^4.0.1",
-    "@xyo-network/witness-model": "^4.0.1",
+    "@xylabs/assert": "^4.13.23",
+    "@xylabs/axios": "^4.13.23",
+    "@xylabs/hex": "^4.13.23",
+    "@xylabs/object": "^4.13.23",
+    "@xylabs/url": "^4.13.23",
+    "@xyo-network/abstract-witness": "^4.1.7",
+    "@xyo-network/payload-builder": "^4.1.7",
+    "@xyo-network/payload-model": "^4.1.7",
+    "@xyo-network/witness-model": "^4.1.7",
     "axios": "^1.10.0",
     "base64-js": "^1.5.1",
     "es6-dynamic-template": "^2.0.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.12",
-    "@xylabs/tsconfig": "^6.5.12",
-    "@xylabs/vitest-extended": "^4.12.31",
-    "@xyo-network/manifest": "^4.0.1",
-    "@xyo-network/module-factory-locator": "^4.0.1",
-    "@xyo-network/module-model": "^4.0.1",
-    "@xyo-network/sentinel-model": "^4.0.1",
-    "@xyo-network/wallet": "^4.0.1",
-    "knip": "^5.61.3",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
+    "@xylabs/tsconfig": "^7.0.0-rc.24",
+    "@xylabs/vitest-extended": "^4.13.23",
+    "@xyo-network/manifest": "^4.1.7",
+    "@xyo-network/module-factory-locator": "^4.1.7",
+    "@xyo-network/module-model": "^4.1.7",
+    "@xyo-network/sentinel-model": "^4.1.7",
+    "@xyo-network/wallet": "^4.1.7",
+    "knip": "^5.62.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/dist/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './Payload/index.ts';
-export * from './Witness/index.ts';
-//# sourceMappingURL=index.d.ts.map