@cratestack/adapter-rtk 0.5.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Stephane Segning
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,38 @@
+# @cratestack/adapter-rtk
+
+An [RTK Query](https://redux-toolkit.js.org/rtk-query/overview) `BaseQueryFn` adapter over
+CrateStack's generated TypeScript RPC client (`transport rpc` schemas) — dispatches every endpoint
+through the same runtime and `RpcLink` chain (`@cratestack/link-batch`, `@cratestack/link-logger`,
+etc.) the rest of the generated client uses, instead of RTK Query's default `fetchBaseQuery`
+reimplementing the wire protocol.
+
+There is currently no fully-generated RTK Query endpoint set (unlike the generated
+`rpc-react-query.ts.j2` hooks for `@tanstack/react-query`) — this package is the primitive for
+hand-writing one.
+
+## Usage
+
+```ts
+import { createRpcBaseQuery } from "@cratestack/adapter-rtk";
+import { createApi } from "@reduxjs/toolkit/query/react";
+import { client } from "./generated/client"; // your project's generated client instance
+
+export const api = createApi({
+  reducerPath: "api",
+  baseQuery: createRpcBaseQuery(client.runtime),
+  endpoints: (builder) => ({
+    getWidget: builder.query<Widget, number>({
+      query: (id) => ({ opId: "model.Widget.get", input: { id } }),
+    }),
+    createOrder: builder.mutation<Order, CreateOrderInput>({
+      query: (input) => ({ opId: "model.Order.create", input }),
+    }),
+  }),
+});
+```
+
+`createRpcBaseQuery` takes an `RpcCaller` — any object with a `call<I, O>(opId, input, options?)`
+method, which is exactly the shape of a generated client's public `.runtime` field
+(`CratestackRpcRuntime`). A failed call surfaces as `{ status: "RPC_ERROR", data: RpcErrorBody }`
+when the server returned a structured error, or `{ status: "RPC_TRANSPORT_ERROR" }` for a network
+failure with no such body.

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import type { RpcCaller } from "@cratestack/ts-types";
+import type { BaseQueryFn } from "@reduxjs/toolkit/query";
+export type { RpcCaller } from "@cratestack/ts-types";
+/** A single RTK Query endpoint request — the `args` shape every
+ *  endpoint defined against {@link createRpcBaseQuery} passes to
+ *  `query()`/`queryFn()`. */
+export interface RpcBaseQueryArgs {
+    opId: string;
+    input?: unknown;
+}
+/** The error shape RTK Query endpoints see in `error` on a failed
+ *  call — distinguishes a real server-side `RpcErrorBody` ("RPC_ERROR",
+ *  `data` carries the decoded body) from a transport-level failure
+ *  ("RPC_TRANSPORT_ERROR", no structured body). */
+export interface RpcBaseQueryError {
+    status: "RPC_ERROR" | "RPC_TRANSPORT_ERROR";
+    error: string;
+    data?: unknown;
+}
+/** Adapts an `RpcCaller` (a generated client's `.runtime`, or the
+ *  runtime itself) into an RTK Query `BaseQueryFn`, so
+ *  `createApi({ baseQuery: createRpcBaseQuery(client.runtime) })`
+ *  dispatches every endpoint through the same `RpcLink` chain
+ *  (`@cratestack/link-batch`, `@cratestack/link-logger`, etc.) the rest
+ *  of the generated client uses — instead of RTK Query's default
+ *  `fetchBaseQuery` reimplementing the wire protocol. */
+export declare function createRpcBaseQuery(client: RpcCaller): BaseQueryFn<RpcBaseQueryArgs, unknown, RpcBaseQueryError>;
+//# 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,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE1D,YAAY,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;6BAE6B;AAC7B,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;mDAGmD;AACnD,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,WAAW,GAAG,qBAAqB,CAAC;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;;yDAMyD;AACzD,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,SAAS,GAChB,WAAW,CAAC,gBAAgB,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAS3D"}

package/dist/index.js

@@ -0,0 +1,29 @@
+/** Adapts an `RpcCaller` (a generated client's `.runtime`, or the
+ *  runtime itself) into an RTK Query `BaseQueryFn`, so
+ *  `createApi({ baseQuery: createRpcBaseQuery(client.runtime) })`
+ *  dispatches every endpoint through the same `RpcLink` chain
+ *  (`@cratestack/link-batch`, `@cratestack/link-logger`, etc.) the rest
+ *  of the generated client uses — instead of RTK Query's default
+ *  `fetchBaseQuery` reimplementing the wire protocol. */
+export function createRpcBaseQuery(client) {
+    return async ({ opId, input }, api) => {
+        try {
+            const data = await client.call(opId, input ?? null, { signal: api.signal });
+            return { data };
+        }
+        catch (error) {
+            return { error: toBaseQueryError(error) };
+        }
+    };
+}
+function toBaseQueryError(error) {
+    if (typeof error === "object" && error !== null && "code" in error && "message" in error) {
+        const body = error;
+        return { status: "RPC_ERROR", error: body.message, data: body };
+    }
+    return {
+        status: "RPC_TRANSPORT_ERROR",
+        error: error instanceof Error ? error.message : String(error),
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAuBA;;;;;;yDAMyD;AACzD,MAAM,UAAU,kBAAkB,CAChC,MAAiB;IAEjB,OAAO,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,EAAE;QACpC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YAC5E,OAAO,EAAE,IAAI,EAAE,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,EAAE,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5C,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,MAAM,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;QACzF,MAAM,IAAI,GAAG,KAA6D,CAAC;QAC3E,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAClE,CAAC;IACD,OAAO;QACL,MAAM,EAAE,qBAAqB;QAC7B,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;KAC9D,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@cratestack/adapter-rtk",
+  "version": "0.5.2",
+  "description": "An RTK Query BaseQueryFn adapter over CrateStack's generated TypeScript RPC client.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cratestack/cratestack.git",
+    "directory": "packages/cratestack-adapter-rtk"
+  },
+  "homepage": "https://cratestack.dev",
+  "bugs": "https://github.com/cratestack/cratestack/issues",
+  "keywords": ["cratestack", "cstack", "rpc", "rtk-query", "redux-toolkit"],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": ["dist", "README.md", "LICENSE"],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "lint": "biome check ."
+  },
+  "dependencies": {
+    "@cratestack/ts-types": "0.5.2"
+  },
+  "peerDependencies": {
+    "@reduxjs/toolkit": "^2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@reduxjs/toolkit": { "optional": true }
+  },
+  "devDependencies": {
+    "@reduxjs/toolkit": "^2.0.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}