@codex-data/sdk 2.3.42 → 2.4.1

package/dist/sdk/index.d.ts

@@ -1,6 +1,7 @@
 import { TypedDocumentNode } from "@graphql-typed-document-node/core";
 import { Variables } from "graphql-request";
 import { ExecutionResult, Sink } from "graphql-ws";
+import { SubscriptionOptions } from "./edge";
 import { Mutation } from "./Mutation";
 import { Query } from "./Query";
 import { Subscribe } from "./Subscribe";
@@ -8,6 +9,7 @@ export type CleanupFunction = () => void;
 export type ApiConfig = {
     apiUrl: string;
     apiRealtimeUrl: string;
+    apiEdgeUrl?: string;
     ws?: boolean;
     headers?: Record<string, string>;
     wsHeaders?: Record<string, string>;
@@ -19,6 +21,8 @@ export declare class Codex {
     private apiConfig?;
     private client;
     private wsClient;
+    private edgeWsClient;
+    private disposed;
     queries: Query;
     mutations: Mutation;
     subscriptions: Subscribe;
@@ -29,6 +33,7 @@ export declare class Codex {
     constructor(apiKey: string, apiConfig?: Partial<ApiConfig> | undefined);
     private parseConfig;
     private createGraphQLClient;
+    private websocketOptions;
     private createWebsocketClient;
     private getRequestHeaders;
     /**
@@ -72,5 +77,5 @@ export declare class Codex {
      * @param sink - The sink to receive the results.
      * @returns A cleanup function to unsubscribe from the subscription.
      */
-    subscribe<TResults, TVars extends Record<string, unknown> = Record<string, never>>(doc: string, args: TVars, sink: Sink<ExecutionResult<TResults>>): CleanupFunction;
+    subscribe<TResults, TVars extends Record<string, unknown> = Record<string, never>>(doc: string, args: TVars, sink: Sink<ExecutionResult<TResults>>, options?: SubscriptionOptions): CleanupFunction;
 }

package/dist/sdk/index.js

@@ -16,6 +16,7 @@ exports.Codex = void 0;
 const graphql_request_1 = require("graphql-request");
 const graphql_ws_1 = require("graphql-ws");
 const isomorphic_ws_1 = __importDefault(require("isomorphic-ws"));
+const edge_1 = require("./edge");
 const invariant_1 = require("./invariant");
 const Mutation_1 = require("./Mutation");
 const Query_1 = require("./Query");
@@ -34,6 +35,7 @@ class Codex {
         var _a, _b;
         this.apiKey = apiKey;
         this.apiConfig = apiConfig;
+        this.disposed = false;
         const config = this.parseConfig((_a = this.apiConfig) !== null && _a !== void 0 ? _a : {});
         this.queries = new Query_1.Query(this);
         this.mutations = new Mutation_1.Mutation(this);
@@ -55,15 +57,16 @@ class Codex {
             fetch: config.fetch,
         });
     }
+    websocketOptions(config) {
+        return {
+            webSocketImpl: isomorphic_ws_1.default,
+            keepAlive: 10000, // ping server every 10 seconds
+            url: config.apiRealtimeUrl,
+            connectionParams: Object.assign({ Authorization: this.apiKey }, config.wsHeaders),
+        };
+    }
     createWebsocketClient(config) {
-        return config.ws
-            ? (0, graphql_ws_1.createClient)({
-                webSocketImpl: isomorphic_ws_1.default,
-                keepAlive: 10000, // ping server every 10 seconds
-                url: config.apiRealtimeUrl,
-                connectionParams: Object.assign({ Authorization: this.apiKey }, config.wsHeaders),
-            })
-            : undefined;
+        return config.ws ? (0, graphql_ws_1.createClient)(this.websocketOptions(config)) : undefined;
     }
     getRequestHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -83,8 +86,11 @@ class Codex {
     updateConfig(incomingConfig) {
         var _a, _b, _c;
         // If we have an existing websocket connection, dispose of it.
-        if (this.wsClient)
-            this.dispose();
+        if (this.wsClient || this.edgeWsClient)
+            void this.dispose();
+        this.edgeWsClient = undefined;
+        this.disposed = false;
+        this.apiConfig = Object.assign(Object.assign({}, this.apiConfig), incomingConfig);
         // Merge the incoming config with the existing config.
         const config = this.parseConfig(Object.assign({}, this.apiConfig, incomingConfig));
         // Create a new websocket connection with the new headers.
@@ -108,8 +114,9 @@ class Codex {
      */
     dispose() {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            (_a = this.wsClient) === null || _a === void 0 ? void 0 : _a.dispose();
+            var _a, _b;
+            this.disposed = true;
+            yield Promise.all([(_a = this.wsClient) === null || _a === void 0 ? void 0 : _a.dispose(), (_b = this.edgeWsClient) === null || _b === void 0 ? void 0 : _b.dispose()]);
         });
     }
     /**
@@ -155,15 +162,26 @@ class Codex {
      * @param sink - The sink to receive the results.
      * @returns A cleanup function to unsubscribe from the subscription.
      */
-    subscribe(doc, args, sink) {
+    subscribe(doc, args, sink, options) {
+        var _a;
         if (!this.wsClient) {
             throw new Error("Websocket is not enabled in the config");
         }
-        const cleanup = this.wsClient.subscribe({
-            query: doc,
-            variables: args,
-        }, sink);
-        return cleanup;
+        if (this.disposed)
+            throw new Error("SDK has been disposed");
+        const payload = { query: doc, variables: args };
+        if (!(options === null || options === void 0 ? void 0 : options.useEdge))
+            return this.wsClient.subscribe(payload, sink);
+        // Validate before creating the edge transport or starting an operation.
+        const snapshot = (0, edge_1.prepareEdgeSubscription)(payload);
+        if (!this.edgeWsClient) {
+            const config = this.parseConfig((_a = this.apiConfig) !== null && _a !== void 0 ? _a : {});
+            this.edgeWsClient = (0, edge_1.createEdgeClient)(Object.assign(Object.assign({}, this.websocketOptions(config)), { url: config.apiEdgeUrl }));
+            this.edgeWsClient.on("error", (error) => {
+                console.error("Websocket error: ", error);
+            });
+        }
+        return this.edgeWsClient.subscribe(snapshot, sink);
     }
 }
 exports.Codex = Codex;

package/dist/sdk/index.mjs

@@ -1,6 +1,7 @@
 import { GraphQLClient } from "graphql-request";
 import { createClient, } from "graphql-ws";
 import WebSocket from "isomorphic-ws";
+import { createEdgeClient, prepareEdgeSubscription, } from "./edge";
 import { invariant } from "./invariant";
 import { Mutation } from "./Mutation";
 import { Query } from "./Query";
@@ -18,6 +19,7 @@ export class Codex {
     constructor(apiKey, apiConfig) {
         this.apiKey = apiKey;
         this.apiConfig = apiConfig;
+        this.disposed = false;
         const config = this.parseConfig(this.apiConfig ?? {});
         this.queries = new Query(this);
         this.mutations = new Mutation(this);
@@ -44,18 +46,19 @@ export class Codex {
             fetch: config.fetch,
         });
     }
+    websocketOptions(config) {
+        return {
+            webSocketImpl: WebSocket,
+            keepAlive: 10000, // ping server every 10 seconds
+            url: config.apiRealtimeUrl,
+            connectionParams: {
+                Authorization: this.apiKey,
+                ...config.wsHeaders,
+            },
+        };
+    }
     createWebsocketClient(config) {
-        return config.ws
-            ? createClient({
-                webSocketImpl: WebSocket,
-                keepAlive: 10000, // ping server every 10 seconds
-                url: config.apiRealtimeUrl,
-                connectionParams: {
-                    Authorization: this.apiKey,
-                    ...config.wsHeaders,
-                },
-            })
-            : undefined;
+        return config.ws ? createClient(this.websocketOptions(config)) : undefined;
     }
     async getRequestHeaders() {
         // Get any dynamic headers
@@ -74,8 +77,11 @@ export class Codex {
      */
     updateConfig(incomingConfig) {
         // If we have an existing websocket connection, dispose of it.
-        if (this.wsClient)
-            this.dispose();
+        if (this.wsClient || this.edgeWsClient)
+            void this.dispose();
+        this.edgeWsClient = undefined;
+        this.disposed = false;
+        this.apiConfig = { ...this.apiConfig, ...incomingConfig };
         // Merge the incoming config with the existing config.
         const config = this.parseConfig(Object.assign({}, this.apiConfig, incomingConfig));
         // Create a new websocket connection with the new headers.
@@ -98,7 +104,8 @@ export class Codex {
      * It's useful for when you need to modify some of the configuration, or when you're done with the class.
      */
     async dispose() {
-        this.wsClient?.dispose();
+        this.disposed = true;
+        await Promise.all([this.wsClient?.dispose(), this.edgeWsClient?.dispose()]);
     }
     /**
      * This is the preferred way to execute queries.
@@ -137,14 +144,27 @@ export class Codex {
      * @param sink - The sink to receive the results.
      * @returns A cleanup function to unsubscribe from the subscription.
      */
-    subscribe(doc, args, sink) {
+    subscribe(doc, args, sink, options) {
         if (!this.wsClient) {
             throw new Error("Websocket is not enabled in the config");
         }
-        const cleanup = this.wsClient.subscribe({
-            query: doc,
-            variables: args,
-        }, sink);
-        return cleanup;
+        if (this.disposed)
+            throw new Error("SDK has been disposed");
+        const payload = { query: doc, variables: args };
+        if (!options?.useEdge)
+            return this.wsClient.subscribe(payload, sink);
+        // Validate before creating the edge transport or starting an operation.
+        const snapshot = prepareEdgeSubscription(payload);
+        if (!this.edgeWsClient) {
+            const config = this.parseConfig(this.apiConfig ?? {});
+            this.edgeWsClient = createEdgeClient({
+                ...this.websocketOptions(config),
+                url: config.apiEdgeUrl,
+            });
+            this.edgeWsClient.on("error", (error) => {
+                console.error("Websocket error: ", error);
+            });
+        }
+        return this.edgeWsClient.subscribe(snapshot, sink);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codex-data/sdk",
-  "version": "2.3.42",
+  "version": "2.4.1",
   "engines": {
     "node": ">=17.5.0"
   },
@@ -13,16 +13,46 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.js"
     },
-    "./schema.graphql": "./schema.graphql"
+    "./schema.graphql": "./schema.graphql",
+    "./edge": {
+      "types": "./dist/edge.d.ts",
+      "import": "./dist/edge.mjs",
+      "require": "./dist/edge.js"
+    }
   },
   "sideEffects": false,
+  "scripts": {
+    "prebuild": "pnpm run clean && pnpm run generate:configs",
+    "clean": "rm -rf dist dist-esm",
+    "build": "pnpm run copy:schema && pnpm run generate:graphql && pnpm run build:sdk && pnpm run codegen && pnpm run lint ./src/sdk --fix && pnpm run build:types",
+    "build:types": "pnpm run build:cjs && pnpm run build:esm && pnpm run build:rename-esm",
+    "build:cjs": "tsc",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:rename-esm": "find dist-esm -name '*.js' -exec sh -c 'mv \"$1\" \"${1%.js}.mjs\"' _ {} \\; && cp -r dist-esm/* dist/ && rm -rf dist-esm",
+    "fetch:schema": "curl -s https://graph.codex.io/schema/latest.graphql --output src/resources/schema.graphql && cp src/resources/schema.graphql schema.graphql",
+    "copy:schema": "cp src/resources/schema.graphql schema.graphql",
+    "schema:diff": "tsx src/scripts/schemaDiff.ts",
+    "generate:configs": "tsx src/scripts/generateNetworkConfigs.ts",
+    "generate:graphql": "tsx src/scripts/generateGraphql.ts",
+    "build:sdk": "tsx src/scripts/buildSdk.ts",
+    "codegen": "graphql-codegen --config codegen.ts",
+    "lint": "eslint --ext .ts src",
+    "test": "jest",
+    "format": "prettier --write .",
+    "prepublishOnly": "pnpm run build",
+    "publish:beta": "pnpm publish --tag beta --access public",
+    "publish:latest": "pnpm publish --access public"
+  },
   "files": [
     "dist/index.js",
     "dist/index.mjs",
     "dist/index.d.ts",
     "dist/sdk/",
     "schema.graphql",
-    "README.md"
+    "README.md",
+    "dist/edge.js",
+    "dist/edge.mjs",
+    "dist/edge.d.ts"
   ],
   "keywords": [
     "crypto",
@@ -80,25 +110,10 @@
     "tsx": "^4.19.1",
     "typescript": "^5.2.2"
   },
-  "scripts": {
-    "prebuild": "pnpm run clean && pnpm run generate:configs",
-    "clean": "rm -rf dist dist-esm",
-    "build": "pnpm run copy:schema && pnpm run generate:graphql && pnpm run build:sdk && pnpm run codegen && pnpm run lint ./src/sdk --fix && pnpm run build:types",
-    "build:types": "pnpm run build:cjs && pnpm run build:esm && pnpm run build:rename-esm",
-    "build:cjs": "tsc",
-    "build:esm": "tsc -p tsconfig.esm.json",
-    "build:rename-esm": "find dist-esm -name '*.js' -exec sh -c 'mv \"$1\" \"${1%.js}.mjs\"' _ {} \\; && cp -r dist-esm/* dist/ && rm -rf dist-esm",
-    "fetch:schema": "curl -s https://graph.codex.io/schema/latest.graphql --output src/resources/schema.graphql && cp src/resources/schema.graphql schema.graphql",
-    "copy:schema": "cp src/resources/schema.graphql schema.graphql",
-    "schema:diff": "tsx src/scripts/schemaDiff.ts",
-    "generate:configs": "tsx src/scripts/generateNetworkConfigs.ts",
-    "generate:graphql": "tsx src/scripts/generateGraphql.ts",
-    "build:sdk": "tsx src/scripts/buildSdk.ts",
-    "codegen": "graphql-codegen --config codegen.ts",
-    "lint": "eslint --ext .ts src",
-    "test": "jest",
-    "format": "prettier --write .",
-    "publish:beta": "pnpm publish --tag beta --access public",
-    "publish:latest": "pnpm publish --access public"
+  "packageManager": "pnpm@10.16.0",
+  "pnpm": {
+    "overrides": {
+      "graphql": "^16.9.0"
+    }
   }
-}
+}