@xyo-network/api-graphql-plugin 2.78.3

package/dist/node/index.mjs

@@ -0,0 +1,67 @@
+// src/Plugin.ts
+import { PayloadSetSchema } from "@xyo-network/payload-model";
+import { createPayloadSetWitnessPlugin } from "@xyo-network/payloadset-plugin";
+
+// src/Witness.ts
+import { assertEx } from "@xylabs/assert";
+import { AbstractWitness } from "@xyo-network/abstract-witness";
+import { AxiosJson } from "@xyo-network/axios";
+import { isPayloadOfSchemaType } from "@xyo-network/payload-model";
+var ApiGraphqlWitnessConfigSchema = "network.xyo.api.witness.config";
+var GraphqlQuerySchema = "network.xyo.graphql.query";
+var GraphqlResultSchema = "network.xyo.graphql.result";
+var isGraphqlQuery = isPayloadOfSchemaType(GraphqlQuerySchema);
+var ApiGraphqlWitness = class extends AbstractWitness {
+  static configSchemas = [ApiGraphqlWitnessConfigSchema];
+  get endpoint() {
+    return assertEx(this.config.endpoint ?? this.params.endpoint, "No endpoint specified");
+  }
+  get headers() {
+    return this.params.headers;
+  }
+  get timeout() {
+    return this.config.timeout;
+  }
+  async observeHandler(payloads) {
+    await this.started("throw");
+    const queries = (payloads == null ? void 0 : payloads.filter(isGraphqlQuery)) ?? [];
+    const axios = new AxiosJson({ headers: this.headers, timeout: this.timeout });
+    const observations = await Promise.all(
+      queries.map(async ({ query, variables }) => {
+        const httpResult = await axios.post(this.endpoint, { query, variables });
+        const result = {
+          http: {
+            status: httpResult.status
+          },
+          result: httpResult.data,
+          schema: GraphqlResultSchema
+        };
+        return result;
+      })
+    );
+    return observations.flat();
+  }
+};
+
+// src/Plugin.ts
+var ApiGraphqlWitnessPlugin = () => createPayloadSetWitnessPlugin(
+  { required: { [GraphqlQuerySchema]: 1 }, schema: PayloadSetSchema },
+  {
+    witness: async (params) => {
+      return await ApiGraphqlWitness.create(params);
+    }
+  }
+);
+
+// src/index.ts
+var src_default = ApiGraphqlWitnessPlugin;
+export {
+  ApiGraphqlWitness,
+  ApiGraphqlWitnessConfigSchema,
+  ApiGraphqlWitnessPlugin,
+  GraphqlQuerySchema,
+  GraphqlResultSchema,
+  src_default as default,
+  isGraphqlQuery
+};
+//# sourceMappingURL=index.mjs.map

package/dist/node/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Plugin.ts","../../src/Witness.ts","../../src/index.ts"],"sourcesContent":["import { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'\n\nimport { ApiGraphqlWitness, GraphqlQuerySchema } from './Witness'\n\nexport const ApiGraphqlWitnessPlugin = () =>\n  createPayloadSetWitnessPlugin<ApiGraphqlWitness>(\n    { required: { [GraphqlQuerySchema]: 1 }, schema: PayloadSetSchema },\n    {\n      witness: async (params) => {\n        return await ApiGraphqlWitness.create(params)\n      },\n    },\n  )\n","import { assertEx } from '@xylabs/assert'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport { AxiosJson } from '@xyo-network/axios'\nimport { NftCollectionWitnessConfigSchema } from '@xyo-network/crypto-nft-collection-payload-plugin'\nimport { AnyConfigSchema } from '@xyo-network/module-model'\nimport { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'\nimport { WitnessConfig, WitnessParams } from '@xyo-network/witness-model'\nimport type { ExecutionResult } from 'graphql'\n\nexport const ApiGraphqlWitnessConfigSchema = 'network.xyo.api.witness.config'\nexport type ApiGraphqlWitnessConfigSchema = typeof ApiGraphqlWitnessConfigSchema\n\nexport type ApiGraphqlWitnessConfig = WitnessConfig<{\n  endpoint?: string\n  schema: ApiGraphqlWitnessConfigSchema\n  timeout?: number\n}>\n\nexport type HttpHeaderValue = string | string[] | number | boolean | null\n\nexport interface HttpHeaders {\n  [key: string]: HttpHeaderValue\n}\n\nexport type ApiGraphqlWitnessParams = WitnessParams<\n  AnyConfigSchema<ApiGraphqlWitnessConfig>,\n  {\n    endpoint?: string\n    headers?: HttpHeaders\n  }\n>\n\nexport const GraphqlQuerySchema = 'network.xyo.graphql.query'\nexport type GraphqlQuerySchema = typeof GraphqlQuerySchema\n\nexport type GraphqlQuery = Payload<\n  {\n    query: string\n    variables: Record<string, unknown>\n  },\n  GraphqlQuerySchema\n>\n\nexport const GraphqlResultSchema = 'network.xyo.graphql.result'\nexport type GraphqlResultSchema = typeof GraphqlResultSchema\n\nexport type GraphqlResult<TData = Record<string, unknown>, TExtensions = Record<string, unknown>> = Payload<\n  {\n    http?: {\n      code?: string\n      ipAddress?: string\n      status?: number\n    }\n    result?: ExecutionResult<TData, TExtensions>\n  },\n  GraphqlResultSchema\n>\n\nexport const isGraphqlQuery = isPayloadOfSchemaType<GraphqlQuery>(GraphqlQuerySchema)\n\nexport class ApiGraphqlWitness<TParams extends ApiGraphqlWitnessParams = ApiGraphqlWitnessParams> extends AbstractWitness<\n  TParams,\n  GraphqlQuery,\n  GraphqlResult\n> {\n  static override configSchemas = [ApiGraphqlWitnessConfigSchema]\n\n  get endpoint() {\n    return assertEx(this.config.endpoint ?? this.params.endpoint, 'No endpoint specified')\n  }\n\n  get headers() {\n    return this.params.headers\n  }\n\n  get timeout() {\n    return this.config.timeout\n  }\n\n  protected override async observeHandler(payloads?: GraphqlQuery[]): Promise<GraphqlResult[]> {\n    await this.started('throw')\n    const queries = payloads?.filter(isGraphqlQuery) ?? []\n    const axios = new AxiosJson({ headers: this.headers, timeout: this.timeout })\n    const observations = await Promise.all(\n      queries.map(async ({ query, variables }) => {\n        const httpResult = await axios.post(this.endpoint, { query, variables })\n        const result: GraphqlResult = {\n          http: {\n            status: httpResult.status,\n          },\n          result: httpResult.data,\n          schema: GraphqlResultSchema,\n        }\n        return result\n      }),\n    )\n    return observations.flat()\n  }\n}\n","import { ApiGraphqlWitnessPlugin } from './Plugin'\n\nexport * from './Witness'\n\nexport { ApiGraphqlWitnessPlugin }\n\n// eslint-disable-next-line import/no-default-export\nexport default ApiGraphqlWitnessPlugin\n"],"mappings":";AAAA,SAAS,wBAAwB;AACjC,SAAS,qCAAqC;;;ACD9C,SAAS,gBAAgB;AACzB,SAAS,uBAAuB;AAChC,SAAS,iBAAiB;AAG1B,SAAS,6BAAsC;AAIxC,IAAM,gCAAgC;AAuBtC,IAAM,qBAAqB;AAW3B,IAAM,sBAAsB;AAe5B,IAAM,iBAAiB,sBAAoC,kBAAkB;AAE7E,IAAM,oBAAN,cAAmG,gBAIxG;AAAA,EACA,OAAgB,gBAAgB,CAAC,6BAA6B;AAAA,EAE9D,IAAI,WAAW;AACb,WAAO,SAAS,KAAK,OAAO,YAAY,KAAK,OAAO,UAAU,uBAAuB;AAAA,EACvF;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,MAAyB,eAAe,UAAqD;AAC3F,UAAM,KAAK,QAAQ,OAAO;AAC1B,UAAM,WAAU,qCAAU,OAAO,oBAAmB,CAAC;AACrD,UAAM,QAAQ,IAAI,UAAU,EAAE,SAAS,KAAK,SAAS,SAAS,KAAK,QAAQ,CAAC;AAC5E,UAAM,eAAe,MAAM,QAAQ;AAAA,MACjC,QAAQ,IAAI,OAAO,EAAE,OAAO,UAAU,MAAM;AAC1C,cAAM,aAAa,MAAM,MAAM,KAAK,KAAK,UAAU,EAAE,OAAO,UAAU,CAAC;AACvE,cAAM,SAAwB;AAAA,UAC5B,MAAM;AAAA,YACJ,QAAQ,WAAW;AAAA,UACrB;AAAA,UACA,QAAQ,WAAW;AAAA,UACnB,QAAQ;AAAA,QACV;AACA,eAAO;AAAA,MACT,CAAC;AAAA,IACH;AACA,WAAO,aAAa,KAAK;AAAA,EAC3B;AACF;;;AD7FO,IAAM,0BAA0B,MACrC;AAAA,EACE,EAAE,UAAU,EAAE,CAAC,kBAAkB,GAAG,EAAE,GAAG,QAAQ,iBAAiB;AAAA,EAClE;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,aAAO,MAAM,kBAAkB,OAAO,MAAM;AAAA,IAC9C;AAAA,EACF;AACF;;;AENF,IAAO,cAAQ;","names":[]}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@xyo-network/api-graphql-plugin",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xylabs/assert": "^2.13.3",
+    "@xyo-network/abstract-witness": "~2.78.3",
+    "@xyo-network/axios": "~2.78.3",
+    "@xyo-network/crypto-nft-collection-payload-plugin": "~2.78.3",
+    "@xyo-network/module-model": "~2.78.3",
+    "@xyo-network/payload-model": "~2.78.3",
+    "@xyo-network/payloadset-plugin": "~2.78.3",
+    "@xyo-network/witness-model": "~2.78.3"
+  },
+  "devDependencies": {
+    "@xylabs/jest-helpers": "^2.13.3",
+    "@xylabs/ts-scripts-yarn3": "^3.1.13",
+    "@xylabs/tsconfig": "^3.1.13",
+    "@xyo-network/account": "~2.78.3",
+    "ethers": "^5.7.2",
+    "graphql": "^16.8.1",
+    "jest": "^29.7.0",
+    "typescript": "^5.2.2"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "docs": "dist/docs.json",
+  "types": "dist/node/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.ts",
+          "default": "./dist/node/index.js"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.mjs"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.js",
+  "module": "dist/node/index.mjs",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.78.3"
+}

package/src/Plugin.ts

@@ -0,0 +1,14 @@
+import { PayloadSetSchema } from '@xyo-network/payload-model'
+import { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
+
+import { ApiGraphqlWitness, GraphqlQuerySchema } from './Witness'
+
+export const ApiGraphqlWitnessPlugin = () =>
+  createPayloadSetWitnessPlugin<ApiGraphqlWitness>(
+    { required: { [GraphqlQuerySchema]: 1 }, schema: PayloadSetSchema },
+    {
+      witness: async (params) => {
+        return await ApiGraphqlWitness.create(params)
+      },
+    },
+  )

package/src/Witness.ts

@@ -0,0 +1,99 @@
+import { assertEx } from '@xylabs/assert'
+import { AbstractWitness } from '@xyo-network/abstract-witness'
+import { AxiosJson } from '@xyo-network/axios'
+import { NftCollectionWitnessConfigSchema } from '@xyo-network/crypto-nft-collection-payload-plugin'
+import { AnyConfigSchema } from '@xyo-network/module-model'
+import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
+import { WitnessConfig, WitnessParams } from '@xyo-network/witness-model'
+import type { ExecutionResult } from 'graphql'
+
+export const ApiGraphqlWitnessConfigSchema = 'network.xyo.api.witness.config'
+export type ApiGraphqlWitnessConfigSchema = typeof ApiGraphqlWitnessConfigSchema
+
+export type ApiGraphqlWitnessConfig = WitnessConfig<{
+  endpoint?: string
+  schema: ApiGraphqlWitnessConfigSchema
+  timeout?: number
+}>
+
+export type HttpHeaderValue = string | string[] | number | boolean | null
+
+export interface HttpHeaders {
+  [key: string]: HttpHeaderValue
+}
+
+export type ApiGraphqlWitnessParams = WitnessParams<
+  AnyConfigSchema<ApiGraphqlWitnessConfig>,
+  {
+    endpoint?: string
+    headers?: HttpHeaders
+  }
+>
+
+export const GraphqlQuerySchema = 'network.xyo.graphql.query'
+export type GraphqlQuerySchema = typeof GraphqlQuerySchema
+
+export type GraphqlQuery = Payload<
+  {
+    query: string
+    variables: Record<string, unknown>
+  },
+  GraphqlQuerySchema
+>
+
+export const GraphqlResultSchema = 'network.xyo.graphql.result'
+export type GraphqlResultSchema = typeof GraphqlResultSchema
+
+export type GraphqlResult<TData = Record<string, unknown>, TExtensions = Record<string, unknown>> = Payload<
+  {
+    http?: {
+      code?: string
+      ipAddress?: string
+      status?: number
+    }
+    result?: ExecutionResult<TData, TExtensions>
+  },
+  GraphqlResultSchema
+>
+
+export const isGraphqlQuery = isPayloadOfSchemaType<GraphqlQuery>(GraphqlQuerySchema)
+
+export class ApiGraphqlWitness<TParams extends ApiGraphqlWitnessParams = ApiGraphqlWitnessParams> extends AbstractWitness<
+  TParams,
+  GraphqlQuery,
+  GraphqlResult
+> {
+  static override configSchemas = [ApiGraphqlWitnessConfigSchema]
+
+  get endpoint() {
+    return assertEx(this.config.endpoint ?? this.params.endpoint, 'No endpoint specified')
+  }
+
+  get headers() {
+    return this.params.headers
+  }
+
+  get timeout() {
+    return this.config.timeout
+  }
+
+  protected override async observeHandler(payloads?: GraphqlQuery[]): Promise<GraphqlResult[]> {
+    await this.started('throw')
+    const queries = payloads?.filter(isGraphqlQuery) ?? []
+    const axios = new AxiosJson({ headers: this.headers, timeout: this.timeout })
+    const observations = await Promise.all(
+      queries.map(async ({ query, variables }) => {
+        const httpResult = await axios.post(this.endpoint, { query, variables })
+        const result: GraphqlResult = {
+          http: {
+            status: httpResult.status,
+          },
+          result: httpResult.data,
+          schema: GraphqlResultSchema,
+        }
+        return result
+      }),
+    )
+    return observations.flat()
+  }
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+import { ApiGraphqlWitnessPlugin } from './Plugin'
+
+export * from './Witness'
+
+export { ApiGraphqlWitnessPlugin }
+
+// eslint-disable-next-line import/no-default-export
+export default ApiGraphqlWitnessPlugin

package/typedoc.json

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