@codex-data/sdk 1.0.40 → 1.1.0-beta.1

package/dist/sdk/generated/index.d.ts

@@ -1,3 +1 @@
-export * from "./fragment-masking";
 export * from "./gql";
-//# sourceMappingURL=index.d.ts.map

package/dist/sdk/generated/index.js

@@ -14,6 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./fragment-masking"), exports);
 __exportStar(require("./gql"), exports);
-//# sourceMappingURL=index.js.map

package/dist/sdk/generated/index.mjs

@@ -0,0 +1 @@
+export * from "./gql";

package/dist/sdk/index.d.ts

@@ -74,4 +74,3 @@ export declare class Codex {
      */
     subscribe<TResults, TVars extends Record<string, unknown> = Record<string, never>>(doc: string, args: TVars, sink: Sink<ExecutionResult<TResults>>): CleanupFunction;
 }
-//# sourceMappingURL=index.d.ts.map

package/dist/sdk/index.js

@@ -167,4 +167,3 @@ class Codex {
     }
 }
 exports.Codex = Codex;
-//# sourceMappingURL=index.js.map

package/dist/sdk/index.mjs

@@ -0,0 +1,150 @@
+import { GraphQLClient } from "graphql-request";
+import { createClient, } from "graphql-ws";
+import WebSocket from "isomorphic-ws";
+import { invariant } from "./invariant";
+import { Mutation } from "./Mutation";
+import { Query } from "./Query";
+import { Subscribe } from "./Subscribe";
+const defaultConfig = {
+    apiUrl: `https://graph.codex.io/graphql`,
+    apiRealtimeUrl: `wss://graph.codex.io/graphql`,
+    ws: true,
+};
+export class Codex {
+    /**
+     * @param apiKey - The api key to use for the requests.
+     * @param apiConfig - The configuration to use for the requests.
+     */
+    constructor(apiKey, apiConfig) {
+        this.apiKey = apiKey;
+        this.apiConfig = apiConfig;
+        const config = this.parseConfig(this.apiConfig ?? {});
+        this.queries = new Query(this);
+        this.mutations = new Mutation(this);
+        this.subscriptions = new Subscribe(this);
+        this.client = this.createGraphQLClient(config);
+        this.wsClient = this.createWebsocketClient(config);
+        this.wsClient?.on("error", (error) => {
+            console.error("Websocket error: ", error);
+        });
+    }
+    parseConfig(config) {
+        invariant(this.apiKey, "apiKey must be defined");
+        return Object.assign({}, defaultConfig, config);
+    }
+    createGraphQLClient(config) {
+        return new GraphQLClient(config.apiUrl, {
+            method: "POST",
+            headers: new Headers({
+                "Content-Type": "application/json",
+                Authorization: this.apiKey,
+                "X-Apollo-Operation-Name": "query",
+                ...config.headers,
+            }),
+            fetch: config.fetch,
+        });
+    }
+    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;
+    }
+    async getRequestHeaders() {
+        // Get any dynamic headers
+        const dynamicHeaders = await this.apiConfig?.applyHeaders?.();
+        const staticHeaders = this.apiConfig?.headers;
+        const headers = {
+            ...staticHeaders,
+            ...dynamicHeaders,
+        };
+        return headers;
+    }
+    /**
+     * Need to update the headers on the websocket connection.
+     * This is useful if the api key changes, or you need to modify the connection init params at all.
+     * NOTE: it will dispose of the old connection, so all existing subscriptions will be closed.
+     */
+    updateConfig(incomingConfig) {
+        // If we have an existing websocket connection, dispose of it.
+        if (this.wsClient)
+            this.dispose();
+        // 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.
+        this.wsClient = this.createWebsocketClient(config);
+        this.client = this.createGraphQLClient(config);
+        this.wsClient?.on("error", (error) => {
+            console.error("Websocket error: ", error);
+        });
+        this.wsClient?.on("closed", (er) => {
+            console.log("Websocket closed", er);
+        });
+        this.wsClient?.on("connecting", () => {
+            console.log("Websocket connecting");
+        });
+    }
+    /**
+     * Call this to dispose of the websocket connection, and make this class ready for garbage collection.
+     * This will also close any open subscriptions.
+     *
+     * 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 is the preferred way to execute queries.
+     * @param doc - The graphql document node to execute.
+     * @param args - The variables to pass to the document.
+     * @returns The result of the query.
+     */
+    async query(doc, args = {}) {
+        const res = await this.client.request(doc, args, await this.getRequestHeaders());
+        return res;
+    }
+    /**
+     * This is functionally the same thing as the `query` method, but it's more expressive.
+     * @param doc - The graphql document node to execute.
+     * @param args - The variables to pass to the document.
+     * @returns The result of the mutation.
+     */
+    async mutation(doc, args = {}) {
+        const res = await this.client.request(doc, args, await this.getRequestHeaders());
+        return res;
+    }
+    /**
+     * This should be used when you don't want to use graphql libaries to create a document node,
+     * and would rather just pass in a string.
+     * @param gqlString - The graphql document string to execute.
+     * @param args - The variables to pass to the document.
+     * @returns The result of the mutation.
+     */
+    async send(gqlString, args = {}) {
+        const res = await this.client.request(gqlString, args, await this.getRequestHeaders());
+        return res;
+    }
+    /**
+     * @param doc - The graphql document string to execute.
+     * @param args - The variables to pass to the document.
+     * @param sink - The sink to receive the results.
+     * @returns A cleanup function to unsubscribe from the subscription.
+     */
+    subscribe(doc, args, sink) {
+        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;
+    }
+}

package/dist/sdk/invariant.d.ts

@@ -1,2 +1 @@
 export declare function invariant(condition: unknown, message?: string | (() => string)): asserts condition;
-//# sourceMappingURL=invariant.d.ts.map

package/dist/sdk/invariant.js

@@ -27,4 +27,3 @@ message) {
     const value = provided ? `${prefix}: ${provided}` : prefix;
     throw new Error(value);
 }
-//# sourceMappingURL=invariant.js.map

package/dist/sdk/invariant.mjs

@@ -0,0 +1,26 @@
+const isProduction = process.env.NODE_ENV === "production";
+const prefix = "Invariant failed";
+// Throw an error if the condition fails
+// Strip out error messages for production
+// > Not providing an inline default argument for message as the result is smaller
+export function invariant(condition, 
+// Can provide a string, or a function that returns a string for cases where
+// the message takes a fair amount of effort to compute
+message) {
+    if (condition) {
+        return;
+    }
+    // Condition not passed
+    // In production we strip the message but still throw
+    if (isProduction) {
+        throw new Error(prefix);
+    }
+    // When not in production we allow the message to pass through
+    // *This block will be removed in production builds*
+    const provided = typeof message === "function" ? message() : message;
+    // Options:
+    // 1. message provided: `${prefix}: ${provided}`
+    // 2. message not provided: prefix
+    const value = provided ? `${prefix}: ${provided}` : prefix;
+    throw new Error(value);
+}

package/package.json

@@ -1,22 +1,26 @@
 {
   "name": "@codex-data/sdk",
-  "version": "1.0.40",
+  "version": "1.1.0-beta.1",
   "engines": {
     "node": ">=17.5.0"
   },
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
-  "scripts": {
-    "prebuild": "bun run generate:configs",
-    "build": "bun run fetch:schema && bun run src/scripts/generateGraphql.ts && bun run src/scripts/buildSdk.ts && bun run codegen && bun run lint ./src/sdk --fix && bun run eslint --no-ignore ./src/resources/**/*.graphql --fix && bun run tsc",
-    "fetch:schema": "curl -s https://graph.codex.io/schema/latest.graphql --output src/resources/schema.graphql",
-    "generate:configs": "bun run src/scripts/generateNetworkConfigs.ts",
-    "codegen": "graphql-codegen --config codegen.ts",
-    "lint": "eslint --ext .ts src",
-    "test": "jest"
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
   },
+  "sideEffects": false,
   "files": [
-    "dist"
+    "dist/index.js",
+    "dist/index.mjs",
+    "dist/index.d.ts",
+    "dist/sdk/",
+    "README.md"
   ],
   "keywords": [
     "crypto",
@@ -32,20 +36,13 @@
   "homepage": "https://docs.codex.io",
   "description": "The Codex SDK for JavaScript/Typescript. It provides generated types and convenient ways to access the graphql api.",
   "dependencies": {
-    "@graphql-tools/wrap": "^10.0.5",
-    "@types/jest": "^29.5.4",
-    "@types/lodash": "^4.17.7",
-    "@types/node": "^20.5.7",
-    "gql-query-builder": "^3.8.0",
-    "graphql": "^16.9.0",
-    "graphql-ast-types": "^1.0.2",
+    "@graphql-typed-document-node/core": "^3.2.0",
     "graphql-request": "^6.1.0",
     "graphql-ws": "^5.14.0",
-    "isomorphic-ws": "^5.0.0",
-    "lodash": "^4.17.21",
-    "mkdirp": "^3.0.1",
-    "tsx": "^4.19.1",
-    "typescript": "^5.2.2"
+    "isomorphic-ws": "^5.0.0"
+  },
+  "peerDependencies": {
+    "graphql": "^16.0.0"
   },
   "devDependencies": {
     "@graphql-codegen/cli": "5.0.0",
@@ -53,19 +50,50 @@
     "@graphql-codegen/introspection": "4.0.0",
     "@graphql-codegen/typescript": "4.0.1",
     "@graphql-eslint/eslint-plugin": "^3.20.1",
+    "@graphql-tools/wrap": "^10.0.5",
+    "@types/jest": "^29.5.4",
+    "@types/lodash": "^4.17.7",
+    "@types/node": "^20.5.7",
     "@typescript-eslint/eslint-plugin": "^6.7.3",
     "@typescript-eslint/parser": "^6.7.3",
+    "chalk": "^4.1.2",
+    "cli-spinners": "^2.9.2",
+    "dotenv": "^16.4.5",
     "eslint": "^8.50.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
+    "gql-query-builder": "^3.8.0",
+    "graphql": "^16.9.0",
+    "graphql-tag": "^2.12.6",
     "jest": "^29.6.4",
+    "lodash": "^4.17.21",
     "merge": "^2.1.1",
+    "mkdirp": "^3.0.1",
+    "ora": "^5.4.1",
     "prettier": "^3.0.3",
-    "ts-jest": "^29.1.1"
+    "ts-jest": "^29.1.1",
+    "tsx": "^4.19.1",
+    "typescript": "^5.2.2"
   },
-  "resolutions": {
-    "graphql": "^16.9.0"
+  "scripts": {
+    "prebuild": "pnpm run clean && pnpm run generate:configs",
+    "clean": "rm -rf dist dist-esm",
+    "build": "pnpm run fetch: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",
+    "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"
   }
-}
+}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,qBAAqB,CAAC;AAC/C,cAAc,OAAO,CAAC"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAA+C;AAC/C,wCAAsB"}