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

package/dist/neutral/index.d.ts

@@ -1,140 +1,3 @@
-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 };
+export * from './Payload/index.ts';
+export * from './Witness/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/api-call-witness",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,30 +28,33 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@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",
+    "@xylabs/assert": "^5.0.0",
+    "@xylabs/axios": "^5.0.0",
+    "@xylabs/hex": "^5.0.0",
+    "@xylabs/object": "^5.0.0",
+    "@xylabs/url": "^5.0.0",
+    "@xyo-network/abstract-witness": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/witness-model": "^5.0.0",
+    "axios": "^1.11.0",
     "base64-js": "^1.5.1",
     "es6-dynamic-template": "^2.0.0"
   },
   "devDependencies": {
-    "@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",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/manifest": "^5.0.0",
+    "@xyo-network/module-factory-locator": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/sentinel-model": "^5.0.0",
+    "@xyo-network/wallet": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/Witness/spec/Witness.spec.ts

@@ -0,0 +1,27 @@
+import '@xylabs/vitest-extended'
+
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import {
+  ApiCallResultSchema, ApiCallSchema, isApiCallErrorResult,
+} from '../../Payload/index.ts'
+import { ApiCallWitnessConfigSchema } from '../Schema.ts'
+import { ApiCallWitness } from '../Witness.ts'
+
+describe('CryptoWalletNftWitness', () => {
+  const uri = 'https://cnn.com'
+  describe('observe', () => {
+    it('get code from contract', async () => {
+      const witness = await ApiCallWitness.create({
+        account: 'random',
+        config: { accept: 'application/json', schema: ApiCallWitnessConfigSchema },
+      })
+      const observation = await witness.observe([{ schema: ApiCallSchema, uri }])
+      expect(observation[0].schema).toBe(ApiCallResultSchema)
+      expect(isApiCallErrorResult(observation[0].schema)).toBe(false)
+    })
+  })
+})

package/src/Witness/spec/opensea.nft-call.spec.ts

@@ -0,0 +1,123 @@
+import '@xylabs/vitest-extended'
+
+import type { PackageManifestPayload } from '@xyo-network/manifest'
+import { ManifestWrapper } from '@xyo-network/manifest'
+import { ModuleFactoryLocator } from '@xyo-network/module-factory-locator'
+import type { ModuleParams } from '@xyo-network/module-model'
+import { ModuleFactory } from '@xyo-network/module-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+import { asSentinelInstance } from '@xyo-network/sentinel-model'
+import { HDWallet } from '@xyo-network/wallet'
+import { asWitnessInstance } from '@xyo-network/witness-model'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import type { ApiCallJsonResult, ApiUriTemplateCallPayload } from '../../Payload/index.ts'
+import { ApiCallResultSchema, ApiCallSchema } from '../../Payload/index.ts'
+import type { ApiCallWitnessConfig } from '../Config.ts'
+import { ApiCallWitness } from '../Witness.ts'
+import openseaNftsManifest from './opensea.nft-call.json' with { type: 'json' }
+
+describe('OpenSeaApi', () => {
+  const address = '0xECA1bB9c8d3Fd8b926372f42c8D4c6c3ed0669B3' // Random Wallet
+
+  const apiKey = process.env.OPENSEA_API_KEY
+
+  describe.skipIf(!apiKey)('report', () => {
+    type OpenSeaNft = {
+      /*
+       * Collection slug. A unique string to identify a collection on OpenSea
+       */
+      collection: string
+      /*
+       * The unique public blockchain identifier for the contract
+       */
+      contract: string
+      /**
+       * @deprecated
+       */
+      created_at: string
+      /*
+       * Description of the NFT
+       */
+      description: string
+      /*
+       * The NFT's unique identifier within the smart contract (also referred to as token_id)
+       */
+      identifier: string
+      /*
+       * Link to the image associated with the NFT
+       */
+      image_url: string
+      /*
+       * If the item is currently able to be bought or sold using OpenSea
+       */
+      is_disabled: boolean
+      /*
+       * If the item is currently classified as 'Not Safe for Work' by OpenSea as defined in OpenSea's NSFW Policy.
+       */
+      is_nsfw: boolean
+      /*
+       * Link to the offchain metadata store
+       */
+      metadata_url: string
+      /*
+       * Name of the NFT
+       */
+      name: string
+      /*
+       * ERC standard of the token (erc721, erc1155)
+       */
+      token_standard: string
+      /*
+       * Last time that the NFT's metadata was updated by OpenSea
+       */
+      updated_at: string
+    }
+    type OpenSeaListNftsByAccountResponse = {
+      next: string
+      nfts: OpenSeaNft[]
+    }
+    it('specifying address', async () => {
+      const mnemonic = 'later puppy sound rebuild rebuild noise ozone amazing hope broccoli crystal grief'
+      const wallet = await HDWallet.fromPhrase(mnemonic)
+      const locator = new ModuleFactoryLocator()
+
+      locator.register(
+        new ModuleFactory(ApiCallWitness, {
+          config: { uriTemplate: 'https://api.opensea.io/api/v2/chain/ethereum/account/${address}/nfts' },
+          headers: { 'x-api-key': apiKey },
+        } as ModuleParams<ApiCallWitnessConfig>),
+      )
+
+      const manifest = new ManifestWrapper(openseaNftsManifest as PackageManifestPayload, wallet, locator)
+
+      const node = await manifest.loadNodeFromIndex(0)
+
+      const mods = await node.resolve('*')
+
+      expect(mods.length).toBeGreaterThan(1)
+
+      const resolvedWitness = await node.resolve('ApiCallWitness')
+      expect(resolvedWitness).toBeDefined()
+
+      const witness = asWitnessInstance(resolvedWitness)
+      expect(witness).toBeDefined()
+
+      const sentinel = asSentinelInstance(await node.resolve('ApiCallSentinel'))
+      expect(sentinel).toBeDefined()
+
+      const call: ApiUriTemplateCallPayload = { params: { address }, schema: ApiCallSchema }
+
+      const report = await sentinel?.report([call])
+
+      const apiCallResult = report?.find(isPayloadOfSchemaType<ApiCallJsonResult<OpenSeaListNftsByAccountResponse>>(ApiCallResultSchema))
+      expect(apiCallResult).toBeDefined()
+      expect(apiCallResult?.schema).toBeString()
+      expect(apiCallResult?.data.nfts).toBeArrayOfSize(1)
+      expect(apiCallResult?.data.nfts[0].collection).toBeString()
+    })
+  })
+})

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    neutral: { src: true },
-    node: {},
-  },
-}
-
-export default config