[API] Init API wrapper package

.changeset/great-flowers-boil.md

@@ -0,0 +1,5 @@
+---
+"@thirdweb-dev/api": patch
+---
+
+Init api wrapper

packages/api/README.md

@@ -0,0 +1,42 @@
+# thirdweb API OpenAPI TypeScript wrapper
+
+This package is a thin OpenAPI wrapper for the thirdweb API
+
+## Configuration
+
+```ts
+import { configure } from "@thirdweb-dev/api";
+
+// call this once at the startup of your application
+configure({
+  secretKey: "<PROJECT_SECRET_KEY>",
+});
+```
+
+## Example Usage
+
+```ts
+import { writeContract } from "@thirdweb-dev/api";
+
+const result = await writeContract({
+  headers: {
+    "x-secret-key": "<PROJECT-SECRET-KEY>",
+  },
+  body: {
+    from: "0x1234567891234567891234567891234567891234",
+    chainId: "1",
+    calls: [
+      {
+        contractAddress: "0x1234567890123456789012345678901234567890",
+        method: "function transfer(address to, uint256 amount)",
+        params: [
+          "0x1234567890123456789012345678901234567890",
+          "1000000000000000000",
+        ],
+      },
+    ],
+  },
+});
+```
+
+This package was autogenerated from the [thirdweb openAPI spec](https://api.thirdweb.com/reference) using [@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts)

packages/api/biome.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.0.6/schema.json",
+  "linter": {
+    "rules": {
+      "correctness": {
+        "useImportExtensions": {
+          "fix": "safe",
+          "level": "error",
+          "options": {
+            "forceJsExtensions": true
+          }
+        }
+      }
+    }
+  },
+  "overrides": [
+    {
+      "assist": {
+        "actions": {
+          "source": {
+            "useSortedKeys": "off"
+          }
+        }
+      },
+      "includes": ["package.json"]
+    }
+  ]
+}

packages/api/openapi-ts.config.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from "@hey-api/openapi-ts";
+
+export default defineConfig({
+  input: "https://api.thirdweb.com/openapi.json",
+  output: { format: "biome", lint: "biome", path: "src/client" },
+});

packages/api/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@thirdweb-dev/api",
+  "version": "0.0.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thirdweb-dev/js.git#main"
+  },
+  "author": "thirdweb eng <[email protected]>",
+  "type": "module",
+  "main": "./dist/cjs/exports/thirdweb.js",
+  "module": "./dist/esm/exports/thirdweb.js",
+  "types": "./dist/types/exports/thirdweb.d.ts",
+  "typings": "./dist/types/exports/thirdweb.d.ts",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/thirdweb-dev/js/issues"
+  },
+  "dependencies": {
+    "@hey-api/client-fetch": "0.10.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types/exports/thirdweb.d.ts",
+      "import": "./dist/esm/exports/thirdweb.js",
+      "default": "./dist/cjs/exports/thirdweb.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/*",
+    "src/*"
+  ],
+  "devDependencies": {
+    "@biomejs/biome": "2.0.6",
+    "@hey-api/openapi-ts": "0.76.0",
+    "rimraf": "6.0.1",
+    "tslib": "^2.8.1"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.0.4"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "pnpm clean && pnpm build:cjs && pnpm build:esm && pnpm build:types",
+    "build:cjs": "tsc --project ./tsconfig.build.json --module commonjs --outDir ./dist/cjs --verbatimModuleSyntax false && printf '{\"type\":\"commonjs\"}' > ./dist/cjs/package.json",
+    "build:esm": "tsc --project ./tsconfig.build.json --module es2020 --outDir ./dist/esm && printf '{\"type\": \"module\",\"sideEffects\":false}' > ./dist/esm/package.json",
+    "build:generate": "openapi-ts && pnpm format && pnpm fix",
+    "build:types": "tsc --project ./tsconfig.build.json --module esnext --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap",
+    "clean": "rimraf dist",
+    "fix": "biome check --write ./src",
+    "format": "biome format --write ./src",
+    "lint": "biome check ./src"
+  }
+}

packages/api/src/client/client.gen.ts

@@ -0,0 +1,28 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import {
+	type Config,
+	createClient,
+	createConfig,
+	type ClientOptions as DefaultClientOptions,
+} from "./client/index.js";
+import type { ClientOptions } from "./types.gen.js";
+
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> =
+	(
+		override?: Config<DefaultClientOptions & T>,
+	) => Config<Required<DefaultClientOptions> & T>;
+
+export const client = createClient(
+	createConfig<ClientOptions>({
+		baseUrl: "https://api.thirdweb.com",
+	}),
+);

packages/api/src/client/client/client.ts

@@ -0,0 +1,189 @@
+import type { Client, Config, RequestOptions } from "./types.js";
+import {
+	buildUrl,
+	createConfig,
+	createInterceptors,
+	getParseAs,
+	mergeConfigs,
+	mergeHeaders,
+	setAuthParams,
+} from "./utils.js";
+
+type ReqInit = Omit<RequestInit, "body" | "headers"> & {
+	body?: any;
+	headers: ReturnType<typeof mergeHeaders>;
+};
+
+export const createClient = (config: Config = {}): Client => {
+	let _config = mergeConfigs(createConfig(), config);
+
+	const getConfig = (): Config => ({ ..._config });
+
+	const setConfig = (config: Config): Config => {
+		_config = mergeConfigs(_config, config);
+		return getConfig();
+	};
+
+	const interceptors = createInterceptors<
+		Request,
+		Response,
+		unknown,
+		RequestOptions
+	>();
+
+	const request: Client["request"] = async (options) => {
+		const opts = {
+			..._config,
+			...options,
+			fetch: options.fetch ?? _config.fetch ?? globalThis.fetch,
+			headers: mergeHeaders(_config.headers, options.headers),
+		};
+
+		if (opts.security) {
+			await setAuthParams({
+				...opts,
+				security: opts.security,
+			});
+		}
+
+		if (opts.body && opts.bodySerializer) {
+			opts.body = opts.bodySerializer(opts.body);
+		}
+
+		// remove Content-Type header if body is empty to avoid sending invalid requests
+		if (opts.body === undefined || opts.body === "") {
+			opts.headers.delete("Content-Type");
+		}
+
+		const url = buildUrl(opts);
+		const requestInit: ReqInit = {
+			redirect: "follow",
+			...opts,
+		};
+
+		let request = new Request(url, requestInit);
+
+		for (const fn of interceptors.request._fns) {
+			if (fn) {
+				request = await fn(request, opts);
+			}
+		}
+
+		// fetch must be assigned here, otherwise it would throw the error:
+		// TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
+		const _fetch = opts.fetch!;
+		let response = await _fetch(request);
+
+		for (const fn of interceptors.response._fns) {
+			if (fn) {
+				response = await fn(response, request, opts);
+			}
+		}
+
+		const result = {
+			request,
+			response,
+		};
+
+		if (response.ok) {
+			if (
+				response.status === 204 ||
+				response.headers.get("Content-Length") === "0"
+			) {
+				return opts.responseStyle === "data"
+					? {}
+					: {
+							data: {},
+							...result,
+						};
+			}
+
+			const parseAs =
+				(opts.parseAs === "auto"
+					? getParseAs(response.headers.get("Content-Type"))
+					: opts.parseAs) ?? "json";
+
+			let data: any;
+			switch (parseAs) {
+				case "arrayBuffer":
+				case "blob":
+				case "formData":
+				case "json":
+				case "text":
+					data = await response[parseAs]();
+					break;
+				case "stream":
+					return opts.responseStyle === "data"
+						? response.body
+						: {
+								data: response.body,
+								...result,
+							};
+			}
+
+			if (parseAs === "json") {
+				if (opts.responseValidator) {
+					await opts.responseValidator(data);
+				}
+
+				if (opts.responseTransformer) {
+					data = await opts.responseTransformer(data);
+				}
+			}
+
+			return opts.responseStyle === "data"
+				? data
+				: {
+						data,
+						...result,
+					};
+		}
+
+		let error = await response.text();
+
+		try {
+			error = JSON.parse(error);
+		} catch {
+			// noop
+		}
+
+		let finalError = error;
+
+		for (const fn of interceptors.error._fns) {
+			if (fn) {
+				finalError = (await fn(error, response, request, opts)) as string;
+			}
+		}
+
+		finalError = finalError || ({} as string);
+
+		if (opts.throwOnError) {
+			throw finalError;
+		}
+
+		// TODO: we probably want to return error and improve types
+		return opts.responseStyle === "data"
+			? undefined
+			: {
+					error: finalError,
+					...result,
+				};
+	};
+
+	return {
+		buildUrl,
+		connect: (options) => request({ ...options, method: "CONNECT" }),
+		delete: (options) => request({ ...options, method: "DELETE" }),
+		get: (options) => request({ ...options, method: "GET" }),
+		getConfig,
+		head: (options) => request({ ...options, method: "HEAD" }),
+		interceptors,
+		options: (options) => request({ ...options, method: "OPTIONS" }),
+		patch: (options) => request({ ...options, method: "PATCH" }),
+		post: (options) => request({ ...options, method: "POST" }),
+		put: (options) => request({ ...options, method: "PUT" }),
+		request,
+		setConfig,
+		trace: (options) => request({ ...options, method: "TRACE" }),
+	};
+};

packages/api/src/client/client/index.ts

@@ -0,0 +1,22 @@
+export type { Auth } from "../core/auth.js";
+export type { QuerySerializerOptions } from "../core/bodySerializer.js";
+export {
+	formDataBodySerializer,
+	jsonBodySerializer,
+	urlSearchParamsBodySerializer,
+} from "../core/bodySerializer.js";
+export { buildClientParams } from "../core/params.js";
+export { createClient } from "./client.js";
+export type {
+	Client,
+	ClientOptions,
+	Config,
+	CreateClientConfig,
+	Options,
+	OptionsLegacyParser,
+	RequestOptions,
+	RequestResult,
+	ResponseStyle,
+	TDataShape,
+} from "./types.js";
+export { createConfig, mergeHeaders } from "./utils.js";