@codex-data/sdk 0.5.7

package/README.md

@@ -0,0 +1,104 @@
+# Codex SDK
+
+This package exists to help you develop on top of the Codex API (https://docs.codex.io).
+
+It provides the public schema SDL for you to use. You can use graphql-codegen to generate types and queries for example.
+
+> [!NOTE]
+> We've changed our name from Defined to Codex.
+>
+> You will see references to our previous company name, Defined, while we make the switch to Codex.
+
+## Installation
+
+| packager                      | command                   |
+| ----------------------------- | ------------------------- |
+| [npm](https://www.npmjs.com/) | `npm add @codex-data/sdk`  |
+| [yarn](https://yarnpkg.com/)  | `yarn add @codex-data/sdk` |
+| [bun](https://bun.sh/)        | `bun add @codex-data/sdk`  |
+
+## Usage
+
+Follow one of the examples in the [examples](/examples) directory, or simply run.
+
+Fetch a token.
+
+```typescript
+import { Codex } from "@codex-data/sdk";
+
+const sdk = new Codex(MY_API_KEY);
+
+sdk.queries
+  .token({
+    input: {
+      address: "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c",
+      networkId: 56,
+    },
+  })
+  .then(console.log);
+```
+
+Use your own GraphQL selections
+
+```typescript
+import { Network } from "../../src/resources/graphql";
+import { Codex } from "@codex-data/sdk/dist/sdk";
+
+const sdk = new Codex(process.env.CODEX_API_KEY || "");
+
+sdk
+  .send<{ getNetworks: Network[] }>(
+    `
+  query GetNetworks {
+    getNetworks { id name }
+  }
+`,
+    {}
+  )
+  .then((res) => {
+    console.log("Networks: ", res.getNetworks);
+  });
+```
+
+## Running the examples
+
+You'll need to have [`curl`](https://curl.se/) installed in order to build this locally, as it fetches the schema from the Codex API.
+
+You need to provide an API key in order for the examples to work. We have [bun](https://bun.sh) in use for development here.
+
+After installing [bun](https://bun.sh), from the project root.
+
+- `bun i`
+- `bun run build`
+
+### Simple
+
+This performs a simple inline graphql request, and uses a user-provided query and selection set.
+
+- `cd examples/simple`
+- `bun i`
+- `CODEX_API_KEY=xyz bun run index.ts`
+
+You can define your own GraphQL queries and use those with codegen (see next section). The pre-defined queries we provide in the
+examples do not include all of the fields for every query.
+
+### Codegen
+
+This shows how to use graphql-codegen to generate query types and get a fully typed end-to-end experience.
+
+- `cd examples/codegen`
+- `bun i`
+- `bun run codegen`
+- `CODEX_API_KEY=xyz bun run src/index.ts`
+
+### Next
+
+This shows how you could use it in a NextJS project.
+
+- `cd examples/next`
+- `bun i`
+- `NEXT_PUBLIC_CODEX_API_KEY=xyz bun run dev`
+
+## Contributing
+
+Prs open!

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * as GraphQL from "./resources/graphql";
+export * from "./sdk";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,32 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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 });
+exports.GraphQL = void 0;
+exports.GraphQL = __importStar(require("./resources/graphql"));
+__exportStar(require("./sdk"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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