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

package/dist/neutral/index.d.ts

@@ -1,146 +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 asApiCall: _xylabs_object.AsTypeFunction<HttpCall>;
-
-declare const asHttpCallBase64Result: _xylabs_object.AsTypeFunction<HttpCallBase64Result>;
-
-declare const asHttpCallResult: _xylabs_object.AsTypeFunction<HttpCallResult>;
-
-declare const asHttpCallXmlResult: _xylabs_object.AsTypeFunction<HttpCallXmlResult>;
-
-declare const asHttpUriCall: _xylabs_object.AsTypeFunction<HttpUriCall>;
-
-declare const asHttpUriTemplateCall: _xylabs_object.AsTypeFunction<HttpUriTemplateCall>;
-
-declare const HttpCallSchema = "network.xyo.http.call";
-type HttpCallSchema = typeof HttpCallSchema;
-declare const HttpCallResultSchema = "network.xyo.http.call.result";
-type HttpCallResultSchema = typeof HttpCallResultSchema;
-
-type Queries = Record<string, string>;
-
-type Verb = 'get' | 'post';
-
-interface HttpCallFields {
-    headers?: Record<string, string | undefined>;
-    queries?: Queries;
-    verb?: Verb;
-}
-
-type HttpUriCall = Payload<HttpCallFields & {
-    uri: string;
-}, HttpCallSchema>;
-
-type HttpUriTemplateCall = Payload<HttpCallFields & {
-    params?: Record<string, string>;
-    uriTemplate?: string;
-}, HttpCallSchema>;
-
-type HttpCall = HttpUriCall | HttpUriTemplateCall;
-
-type HttpCallJsonResultType = JsonArray | JsonObject;
-type HttpCallJsonResult<T extends HttpCallJsonResultType = HttpCallJsonResultType> = Payload<{
-    call: Hash;
-    contentType: 'application/json';
-    data: T;
-}, HttpCallResultSchema>;
-declare const isHttpCallJsonResult: <T extends HttpCallJsonResultType = HttpCallJsonResultType>(x?: unknown | null) => x is HttpCallJsonResult<T>;
-declare const asHttpCallJsonResult: _xylabs_object.AsTypeFunction<HttpCallJsonResult<HttpCallJsonResultType>>;
-
-type HttpCallXmlResult = Payload<{
-    call: Hash;
-    contentType: 'application/xml' | 'text/xml';
-    data: string;
-}, HttpCallResultSchema>;
-
-type HttpCallBase64Result = Payload<{
-    call: Hash;
-    contentType: Exclude<Exclude<string, HttpCallJsonResult['contentType']>, HttpCallXmlResult['contentType']>;
-    data: string;
-}, HttpCallResultSchema>;
-
-interface HttpMeta {
-    code?: string;
-    status?: number;
-}
-
-type HttpCallErrorResult = Payload<{
-    call: Hash;
-    http?: HttpMeta;
-}, HttpCallResultSchema>;
-
-type HttpCallHtmlResult = Payload<{
-    call: Hash;
-    contentType: 'text/html';
-    data: string;
-}, HttpCallResultSchema>;
-
-type NewType = JsonObject;
-type HttpCallResult<TJson extends JsonArray | JsonObject = JsonArray | NewType> = HttpCallBase64Result | HttpCallJsonResult<TJson> | HttpCallErrorResult;
-
-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 isHttpCall: (x?: unknown | null) => x is HttpCall;
-
-declare const isHttpCallBase64Result: (x?: unknown | null) => x is HttpCallBase64Result;
-
-declare const isHttpCallErrorResult: (value: unknown) => value is HttpCallErrorResult;
-
-declare const isHttpCallResult: (x?: unknown | null) => x is HttpCallResult;
-
-declare const isHttpCallXmlResult: (x?: unknown | null) => x is HttpCallXmlResult;
-
-declare const isHttpUriCall: (value?: unknown) => value is HttpUriCall;
-
-declare const isHttpUriTemplateCall: (value?: unknown) => value is HttpUriTemplateCall;
-
-declare const HttpCallWitnessConfigSchema = "network.xyo.http.call.witness.config";
-type HttpCallWitnessConfigSchema = typeof HttpCallWitnessConfigSchema;
-
-type HttpCallWitnessConfigBase = WitnessConfig<{
-    accept?: MimeTypes;
-    headers?: Record<string, string | undefined>;
-    queries?: HttpCall['queries'];
-    schema: HttpCallWitnessConfigSchema;
-    timeout?: number;
-    verb?: HttpCall['verb'];
-}>;
-type HttpUriCallWitnessConfig = WitnessConfig<HttpCallWitnessConfigBase & {
-    uri: HttpUriCall['uri'];
-}>;
-type HttpUriTemplateCallWitnessConfig = WitnessConfig<HttpCallWitnessConfigBase & {
-    params?: Record<string, string>;
-    uriTemplate: HttpUriTemplateCall['uriTemplate'];
-}>;
-type HttpCallWitnessConfig = HttpUriCallWitnessConfig | HttpUriTemplateCallWitnessConfig | HttpCallWitnessConfigBase;
-declare const isHttpCallWitnessConfig: (x?: unknown | null) => x is HttpCallWitnessConfig;
-declare const asHttpCallWitnessConfig: _xylabs_object.AsTypeFunction<HttpCallWitnessConfig>;
-declare const isHttpUriCallWitnessConfig: (value?: unknown) => value is HttpUriCallWitnessConfig;
-declare const asHttpUriCallWitnessConfig: _xylabs_object.AsTypeFunction<HttpUriCallWitnessConfig>;
-declare const isHttpUriTemplateCallWitnessConfig: (value?: unknown) => value is HttpUriTemplateCallWitnessConfig;
-declare const asHttpUriTemplateCallWitnessConfig: _xylabs_object.AsTypeFunction<HttpUriTemplateCallWitnessConfig>;
-
-interface HttpCallWitnessParams extends WitnessParams<HttpCallWitnessConfig> {
-    headers?: Record<string, string | undefined>;
-    ipfsGateway?: string;
-}
-
-declare class HttpCallWitness<TParams extends HttpCallWitnessParams = HttpCallWitnessParams> extends AbstractWitness<TParams, HttpCall, HttpCallResult> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    get accept(): MimeTypes;
-    get ipfsGateway(): string | undefined;
-    get timeout(): number | undefined;
-    getFullUri(call?: HttpCall): string;
-    getHeaders(headers?: Record<string, string | undefined>): Record<string, string | undefined>;
-    protected observeHandler(inPayloads?: HttpCall[]): Promise<HttpCallResult[]>;
-    private httpGet;
-}
-
-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 };
-export type { HttpCall, HttpCallBase64Result, HttpCallErrorResult, HttpCallFields, HttpCallHtmlResult, HttpCallJsonResult, HttpCallJsonResultType, HttpCallResult, HttpCallWitnessConfig, HttpCallWitnessConfigBase, HttpCallWitnessParams, HttpCallXmlResult, HttpMeta, HttpUriCall, HttpUriCallWitnessConfig, HttpUriTemplateCall, HttpUriTemplateCallWitnessConfig, 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/http-call-witness",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,32 +28,35 @@
   },
   "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/hash": "^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/hash": "^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",
+    "@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",
     "ethers": "^6.15.0",
-    "knip": "^5.62.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 {
+  HttpCallResultSchema, HttpCallSchema, isHttpCallErrorResult,
+} from '../../Payload/index.ts'
+import { HttpCallWitnessConfigSchema } from '../Schema.ts'
+import { HttpCallWitness } from '../Witness.ts'
+
+describe('CryptoWalletNftWitness', () => {
+  const uri = 'https://cnn.com'
+  describe('observe', () => {
+    it('get code from contract', async () => {
+      const witness = await HttpCallWitness.create({
+        account: 'random',
+        config: { accept: 'text/html', schema: HttpCallWitnessConfigSchema },
+      })
+      const observation = await witness.observe([{ schema: HttpCallSchema, uri }])
+      expect(observation[0].schema).toBe(HttpCallResultSchema)
+      expect(isHttpCallErrorResult(observation[0].schema)).toBe(false)
+    })
+  })
+})

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

@@ -0,0 +1,122 @@
+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 { 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 { HttpCallJsonResult, HttpUriTemplateCall } from '../../Payload/index.ts'
+import { HttpCallResultSchema, HttpCallSchema } from '../../Payload/index.ts'
+import type { HttpCallWitnessParams } from '../Params.ts'
+import { HttpCallWitness } from '../Witness.ts'
+import openseaNftsManifest from './opensea.nft-call.json' with { type: 'json' }
+
+describe('OpenSeaHttp', () => {
+  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(HttpCallWitness, {
+          config: { uriTemplate: 'https://api.opensea.io/api/v2/chain/ethereum/account/${address}/nfts' },
+          headers: { 'x-api-key': apiKey },
+        } as HttpCallWitnessParams),
+      )
+
+      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('HttpCallWitness')
+      expect(resolvedWitness).toBeDefined()
+
+      const witness = asWitnessInstance(resolvedWitness)
+      expect(witness).toBeDefined()
+
+      const sentinel = asSentinelInstance(await node.resolve('HttpCallSentinel'))
+      expect(sentinel).toBeDefined()
+
+      const call: HttpUriTemplateCall = { params: { address }, schema: HttpCallSchema }
+
+      const report = await sentinel?.report([call])
+
+      const apiCallResult = report?.find(isPayloadOfSchemaType<HttpCallJsonResult<OpenSeaListNftsByAccountResponse>>(HttpCallResultSchema))
+      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