@spoosh/plugin-transform 0.1.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Spoosh
+
+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,93 @@
+# @spoosh/plugin-transform
+
+Transform request and response data with full type inference.
+
+**[Documentation](https://spoosh.dev/docs/plugins/transform)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
+
+## Installation
+
+```bash
+npm install @spoosh/plugin-transform
+```
+
+## Usage
+
+### Request Transforms
+
+```typescript
+import { transformPlugin } from "@spoosh/plugin-transform";
+
+const plugins = [transformPlugin()];
+
+// Transform query parameters
+const { data } = useRead((api) => api.posts.$get({ query: { page: 1 } }), {
+  transform: {
+    query: (q) => ({ ...q, limit: 10 }),
+  },
+});
+
+// Transform body in useWrite
+const { trigger } = useWrite((api) => api.posts.$post);
+
+trigger({
+  body: { title: "New Post" },
+  transform: {
+    body: (b) => ({ ...b, createdAt: Date.now() }),
+  },
+});
+```
+
+### Response Transforms
+
+Response transforms produce a separate `transformedData` field while preserving the original `data`:
+
+```typescript
+const { data, transformedData } = useRead((api) => api.posts.$get(), {
+  transform: {
+    response: (posts) => ({
+      count: posts.length,
+      hasMore: posts.length >= 10,
+      ids: posts.map((p) => p.id),
+    }),
+  },
+});
+
+// data = Post[] (original response, preserved)
+// transformedData = { count: number, hasMore: boolean, ids: number[] } | undefined
+```
+
+## Transform Types
+
+The plugin supports transformation of:
+
+- **query** - Transform query parameters before request
+- **body** - Transform JSON body before request
+- **formData** - Transform form data before request
+- **urlEncoded** - Transform URL-encoded data before request
+- **response** - Transform response data after request (produces `transformedData`)
+
+## Features
+
+- ✅ Full type inference for all transforms
+- ✅ Async transform functions supported
+- ✅ Automatic deep cloning (safe to mutate)
+- ✅ Per-request transforms (no global config needed)
+- ✅ Return `undefined` to remove data entirely
+
+## TypeScript Limitation (useWrite)
+
+Due to TypeScript limitations with dynamic trigger options, `transformedData` is typed as `never` in `useWrite` hook results. Use type assertion:
+
+```typescript
+type TransformedPost = {
+  success: boolean;
+  postId: number;
+};
+
+const { transformedData } = useWrite((api) => api.posts.$post);
+
+// Type assertion required
+const typed = transformedData as TransformedPost | undefined;
+```
+
+This limitation does not affect `useRead` or `useInfiniteRead`, where options are passed at hook creation time.

package/dist/index.d.mts

@@ -0,0 +1,132 @@
+import { ResolverContext, SpooshPlugin } from '@spoosh/core';
+
+type MaybePromise<T> = T | Promise<T>;
+/** Suggests keys from TIn but all optional and any type, plus allows extra keys */
+type FlexibleOutput<TIn> = {
+    [K in keyof TIn]?: unknown;
+} & Record<string, unknown>;
+type QueryTransformer<TIn = unknown> = (query: TIn) => MaybePromise<FlexibleOutput<TIn> | undefined>;
+type BodyTransformer<TIn = unknown> = (body: TIn) => MaybePromise<FlexibleOutput<TIn> | undefined>;
+type FormDataTransformer<TIn = unknown> = (formData: TIn) => MaybePromise<FlexibleOutput<TIn> | undefined>;
+type UrlEncodedTransformer<TIn = unknown> = (urlEncoded: TIn) => MaybePromise<FlexibleOutput<TIn> | undefined>;
+type ResponseTransformer<TIn = unknown, TOut = unknown> = (response: TIn) => MaybePromise<TOut>;
+interface TransformConfig {
+    /** Transform query parameters before request. Return undefined to remove query. */
+    query?: QueryTransformer;
+    /** Transform JSON body before request. Return undefined to remove body. */
+    body?: BodyTransformer;
+    /** Transform form data before request. Return undefined to remove formData. */
+    formData?: FormDataTransformer;
+    /** Transform URL-encoded data before request. Return undefined to remove urlEncoded. */
+    urlEncoded?: UrlEncodedTransformer;
+    /** Transform response data after request. Returns transformedData (can be any type). */
+    response?: ResponseTransformer<unknown, unknown>;
+}
+/**
+ * Plugin-level config. All transforms are per-request only for type inference.
+ */
+type TransformPluginConfig = object;
+interface TransformReadOptions {
+    /** Per-request transform functions. */
+    transform?: TransformConfig;
+}
+interface TransformWriteOptions {
+    /** Per-request transform functions. */
+    transform?: TransformConfig;
+}
+interface TransformInfiniteReadOptions {
+    /** Per-request transform functions. */
+    transform?: TransformConfig;
+}
+type TransformReadResult = object;
+type TransformWriteResult = object;
+type TransformOptions = TransformReadOptions | TransformWriteOptions | TransformInfiniteReadOptions;
+/**
+ * Extracts the return type of a response transformer from hook options.
+ * Returns `never` if no response transformer is provided.
+ */
+type InferTransformedData<TOptions> = TOptions extends {
+    transform: {
+        response: (data: never) => MaybePromise<infer R>;
+    };
+} ? R : never;
+/**
+ * Conditionally adds `transformedData` field to hook result.
+ * Only present when a response transformer is provided.
+ */
+type TransformResultField<TOptions> = [
+    InferTransformedData<TOptions>
+] extends [never] ? object : {
+    transformedData: InferTransformedData<TOptions> | undefined;
+};
+type ResolvedTransformConfig<TContext extends ResolverContext> = {
+    /** Transform query parameters before request. Return undefined to remove query. */
+    query?: QueryTransformer<TContext["input"]["query"]>;
+    /** Transform JSON body before request. Return undefined to remove body. */
+    body?: BodyTransformer<TContext["input"]["body"]>;
+    /** Transform form data before request. Return undefined to remove formData. */
+    formData?: FormDataTransformer<TContext["input"]["formData"]>;
+    /** Transform URL-encoded data before request. Return undefined to remove urlEncoded. */
+    urlEncoded?: UrlEncodedTransformer<TContext["input"]["urlEncoded"]>;
+    /** Transform response data after request. Returns transformedData (can be any type). */
+    response?: ResponseTransformer<TContext["data"], unknown>;
+};
+declare module "@spoosh/core" {
+    interface PluginResolvers<TContext extends ResolverContext> {
+        transform: ResolvedTransformConfig<TContext> | undefined;
+    }
+    interface PluginResultResolvers<TOptions> {
+        transformedData: TOptions extends {
+            transform: {
+                response: (data: never) => MaybePromise<infer R>;
+            };
+        } ? Awaited<R> | undefined : never;
+    }
+}
+
+/**
+ * Enables data transformation for query, body, formData, urlEncoded, and response.
+ *
+ * Supports both sync and async transformer functions. All data is deep-cloned
+ * before transformation to prevent mutation of original objects.
+ *
+ * All transforms are per-request for full type inference.
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/transform | Transform Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * // Per-request transforms with full type inference
+ * const { data, transformedData } = useRead(
+ *   (api) => api.posts.$get(),
+ *   {
+ *     transform: {
+ *       query: (q) => ({ ...q, timestamp: Date.now() }),
+ *       response: (posts) => ({
+ *         count: posts.length,
+ *         hasMore: posts.length >= 10,
+ *       }),
+ *     },
+ *   }
+ * );
+ * // data = original posts array (preserved)
+ * // transformedData = { count: number, hasMore: boolean }
+ *
+ * // useWrite with body transform
+ * trigger({
+ *   body: { name: "test" },
+ *   transform: {
+ *     body: (b) => ({ ...b, createdAt: Date.now() }),
+ *   },
+ * });
+ * ```
+ */
+declare function transformPlugin(): SpooshPlugin<{
+    readOptions: TransformReadOptions;
+    writeOptions: TransformWriteOptions;
+    infiniteReadOptions: TransformInfiniteReadOptions;
+    readResult: TransformReadResult;
+    writeResult: TransformWriteResult;
+}>;
+
+export { type BodyTransformer, type FormDataTransformer, type InferTransformedData, type MaybePromise, type QueryTransformer, type ResponseTransformer, type TransformConfig, type TransformInfiniteReadOptions, type TransformOptions, type TransformPluginConfig, type TransformReadOptions, type TransformReadResult, type TransformResultField, type TransformWriteOptions, type TransformWriteResult, type UrlEncodedTransformer, transformPlugin };

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+import { ResolverContext, SpooshPlugin } from '@spoosh/core';
+
+type MaybePromise<T> = T | Promise<T>;
+/** Suggests keys from TIn but all optional and any type, plus allows extra keys */
+type FlexibleOutput<TIn> = {
+    [K in keyof TIn]?: unknown;
+} & Record<string, unknown>;
+type QueryTransformer<TIn = unknown> = (query: TIn) => MaybePromise<FlexibleOutput<TIn> | undefined>;
+type BodyTransformer<TIn = unknown> = (body: TIn) => MaybePromise<FlexibleOutput<TIn> | undefined>;
+type FormDataTransformer<TIn = unknown> = (formData: TIn) => MaybePromise<FlexibleOutput<TIn> | undefined>;
+type UrlEncodedTransformer<TIn = unknown> = (urlEncoded: TIn) => MaybePromise<FlexibleOutput<TIn> | undefined>;
+type ResponseTransformer<TIn = unknown, TOut = unknown> = (response: TIn) => MaybePromise<TOut>;
+interface TransformConfig {
+    /** Transform query parameters before request. Return undefined to remove query. */
+    query?: QueryTransformer;
+    /** Transform JSON body before request. Return undefined to remove body. */
+    body?: BodyTransformer;
+    /** Transform form data before request. Return undefined to remove formData. */
+    formData?: FormDataTransformer;
+    /** Transform URL-encoded data before request. Return undefined to remove urlEncoded. */
+    urlEncoded?: UrlEncodedTransformer;
+    /** Transform response data after request. Returns transformedData (can be any type). */
+    response?: ResponseTransformer<unknown, unknown>;
+}
+/**
+ * Plugin-level config. All transforms are per-request only for type inference.
+ */
+type TransformPluginConfig = object;
+interface TransformReadOptions {
+    /** Per-request transform functions. */
+    transform?: TransformConfig;
+}
+interface TransformWriteOptions {
+    /** Per-request transform functions. */
+    transform?: TransformConfig;
+}
+interface TransformInfiniteReadOptions {
+    /** Per-request transform functions. */
+    transform?: TransformConfig;
+}
+type TransformReadResult = object;
+type TransformWriteResult = object;
+type TransformOptions = TransformReadOptions | TransformWriteOptions | TransformInfiniteReadOptions;
+/**
+ * Extracts the return type of a response transformer from hook options.
+ * Returns `never` if no response transformer is provided.
+ */
+type InferTransformedData<TOptions> = TOptions extends {
+    transform: {
+        response: (data: never) => MaybePromise<infer R>;
+    };
+} ? R : never;
+/**
+ * Conditionally adds `transformedData` field to hook result.
+ * Only present when a response transformer is provided.
+ */
+type TransformResultField<TOptions> = [
+    InferTransformedData<TOptions>
+] extends [never] ? object : {
+    transformedData: InferTransformedData<TOptions> | undefined;
+};
+type ResolvedTransformConfig<TContext extends ResolverContext> = {
+    /** Transform query parameters before request. Return undefined to remove query. */
+    query?: QueryTransformer<TContext["input"]["query"]>;
+    /** Transform JSON body before request. Return undefined to remove body. */
+    body?: BodyTransformer<TContext["input"]["body"]>;
+    /** Transform form data before request. Return undefined to remove formData. */
+    formData?: FormDataTransformer<TContext["input"]["formData"]>;
+    /** Transform URL-encoded data before request. Return undefined to remove urlEncoded. */
+    urlEncoded?: UrlEncodedTransformer<TContext["input"]["urlEncoded"]>;
+    /** Transform response data after request. Returns transformedData (can be any type). */
+    response?: ResponseTransformer<TContext["data"], unknown>;
+};
+declare module "@spoosh/core" {
+    interface PluginResolvers<TContext extends ResolverContext> {
+        transform: ResolvedTransformConfig<TContext> | undefined;
+    }
+    interface PluginResultResolvers<TOptions> {
+        transformedData: TOptions extends {
+            transform: {
+                response: (data: never) => MaybePromise<infer R>;
+            };
+        } ? Awaited<R> | undefined : never;
+    }
+}
+
+/**
+ * Enables data transformation for query, body, formData, urlEncoded, and response.
+ *
+ * Supports both sync and async transformer functions. All data is deep-cloned
+ * before transformation to prevent mutation of original objects.
+ *
+ * All transforms are per-request for full type inference.
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/transform | Transform Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * // Per-request transforms with full type inference
+ * const { data, transformedData } = useRead(
+ *   (api) => api.posts.$get(),
+ *   {
+ *     transform: {
+ *       query: (q) => ({ ...q, timestamp: Date.now() }),
+ *       response: (posts) => ({
+ *         count: posts.length,
+ *         hasMore: posts.length >= 10,
+ *       }),
+ *     },
+ *   }
+ * );
+ * // data = original posts array (preserved)
+ * // transformedData = { count: number, hasMore: boolean }
+ *
+ * // useWrite with body transform
+ * trigger({
+ *   body: { name: "test" },
+ *   transform: {
+ *     body: (b) => ({ ...b, createdAt: Date.now() }),
+ *   },
+ * });
+ * ```
+ */
+declare function transformPlugin(): SpooshPlugin<{
+    readOptions: TransformReadOptions;
+    writeOptions: TransformWriteOptions;
+    infiniteReadOptions: TransformInfiniteReadOptions;
+    readResult: TransformReadResult;
+    writeResult: TransformWriteResult;
+}>;
+
+export { type BodyTransformer, type FormDataTransformer, type InferTransformedData, type MaybePromise, type QueryTransformer, type ResponseTransformer, type TransformConfig, type TransformInfiniteReadOptions, type TransformOptions, type TransformPluginConfig, type TransformReadOptions, type TransformReadResult, type TransformResultField, type TransformWriteOptions, type TransformWriteResult, type UrlEncodedTransformer, transformPlugin };

package/dist/index.js

@@ -0,0 +1,91 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  transformPlugin: () => transformPlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+function deepClone(value) {
+  try {
+    if (value === void 0 || value === null) {
+      return value;
+    }
+    return structuredClone(value);
+  } catch {
+    return value;
+  }
+}
+function transformPlugin() {
+  return {
+    name: "spoosh:transform",
+    operations: ["read", "write", "infiniteRead"],
+    middleware: async (context, next) => {
+      const { requestOptions } = context;
+      const pluginOptions = context.pluginOptions;
+      const transform = pluginOptions?.transform;
+      if (transform?.query && requestOptions.query) {
+        const cloned = deepClone(requestOptions.query);
+        const transformed = await transform.query(cloned);
+        context.requestOptions = {
+          ...context.requestOptions,
+          query: transformed
+        };
+      }
+      if (transform?.body && requestOptions.body) {
+        const cloned = deepClone(requestOptions.body);
+        const transformed = await transform.body(cloned);
+        context.requestOptions = {
+          ...context.requestOptions,
+          body: transformed
+        };
+      }
+      if (transform?.formData && requestOptions.formData) {
+        const cloned = deepClone(requestOptions.formData);
+        const transformed = await transform.formData(cloned);
+        context.requestOptions = {
+          ...context.requestOptions,
+          formData: transformed
+        };
+      }
+      if (transform?.urlEncoded && requestOptions.urlEncoded) {
+        const cloned = deepClone(requestOptions.urlEncoded);
+        const transformed = await transform.urlEncoded(cloned);
+        context.requestOptions = {
+          ...context.requestOptions,
+          urlEncoded: transformed
+        };
+      }
+      return next();
+    },
+    onResponse: async (context, response) => {
+      const pluginOptions = context.pluginOptions;
+      const responseTransformer = pluginOptions?.transform?.response;
+      if (responseTransformer && response.data !== void 0) {
+        const transformedData = await responseTransformer(response.data);
+        context.stateManager.setPluginResult(context.queryKey, {
+          transformedData
+        });
+      }
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,68 @@
+// src/plugin.ts
+function deepClone(value) {
+  try {
+    if (value === void 0 || value === null) {
+      return value;
+    }
+    return structuredClone(value);
+  } catch {
+    return value;
+  }
+}
+function transformPlugin() {
+  return {
+    name: "spoosh:transform",
+    operations: ["read", "write", "infiniteRead"],
+    middleware: async (context, next) => {
+      const { requestOptions } = context;
+      const pluginOptions = context.pluginOptions;
+      const transform = pluginOptions?.transform;
+      if (transform?.query && requestOptions.query) {
+        const cloned = deepClone(requestOptions.query);
+        const transformed = await transform.query(cloned);
+        context.requestOptions = {
+          ...context.requestOptions,
+          query: transformed
+        };
+      }
+      if (transform?.body && requestOptions.body) {
+        const cloned = deepClone(requestOptions.body);
+        const transformed = await transform.body(cloned);
+        context.requestOptions = {
+          ...context.requestOptions,
+          body: transformed
+        };
+      }
+      if (transform?.formData && requestOptions.formData) {
+        const cloned = deepClone(requestOptions.formData);
+        const transformed = await transform.formData(cloned);
+        context.requestOptions = {
+          ...context.requestOptions,
+          formData: transformed
+        };
+      }
+      if (transform?.urlEncoded && requestOptions.urlEncoded) {
+        const cloned = deepClone(requestOptions.urlEncoded);
+        const transformed = await transform.urlEncoded(cloned);
+        context.requestOptions = {
+          ...context.requestOptions,
+          urlEncoded: transformed
+        };
+      }
+      return next();
+    },
+    onResponse: async (context, response) => {
+      const pluginOptions = context.pluginOptions;
+      const responseTransformer = pluginOptions?.transform?.response;
+      if (responseTransformer && response.data !== void 0) {
+        const transformedData = await responseTransformer(response.data);
+        context.stateManager.setPluginResult(context.queryKey, {
+          transformedData
+        });
+      }
+    }
+  };
+}
+export {
+  transformPlugin
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@spoosh/plugin-transform",
+  "version": "0.1.0-beta.0",
+  "description": "Data transformation plugin for Spoosh with sync/async support",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nxnom/spoosh.git",
+    "directory": "packages/plugin-transform"
+  },
+  "bugs": {
+    "url": "https://github.com/nxnom/spoosh/issues"
+  },
+  "homepage": "https://spoosh.dev/docs/plugins/transform",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "spoosh",
+    "plugin",
+    "transform",
+    "middleware",
+    "api-client"
+  ],
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "peerDependencies": {
+    "@spoosh/core": ">=0.1.0"
+  },
+  "devDependencies": {
+    "@spoosh/core": "0.1.0-beta.0",
+    "@spoosh/test-utils": "0.1.0-beta.0"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --max-warnings 0",
+    "format": "prettier --write 'src/**/*.ts'"
+  }
+}