@spoosh/plugin-transform 0.2.0 → 0.4.0

package/README.md

@@ -1,6 +1,6 @@
 # @spoosh/plugin-transform
 
-Transform request and response data with full type inference.
+Transform response data with full type inference.
 
 **[Documentation](https://spoosh.dev/docs/plugins/transform)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
 
@@ -12,7 +12,9 @@ npm install @spoosh/plugin-transform
 
 ## Usage
 
-### Request Transforms
+### Response Transforms
+
+Response transforms produce a separate `transformedData` field in `meta` while preserving the original `data`:
 
 ```typescript
 import { Spoosh } from "@spoosh/core";
@@ -20,63 +22,44 @@ import { transformPlugin } from "@spoosh/plugin-transform";
 
 const client = new Spoosh<ApiSchema, Error>("/api").use([transformPlugin()]);
 
-const { data } = useRead((api) => api.posts.$get({ query: { page: 1 } }), {
-  transform: {
-    query: (q) => ({ ...q, limit: 10 }),
-  },
+const { data, meta } = useRead((api) => api("posts").GET(), {
+  transform: (posts) => ({
+    count: posts.length,
+    hasMore: posts.length >= 10,
+    ids: posts.map((p) => p.id),
+  }),
 });
 
-// Transform body in useWrite
-const { trigger } = useWrite((api) => api.posts.$post);
-
-trigger({
-  body: { title: "New Post" },
-  transform: {
-    body: (b) => ({ ...b, createdAt: Date.now() }),
-  },
-});
+// data = Post[] (original response, preserved)
+// meta.transformedData = { count: number, hasMore: boolean, ids: number[] } | undefined
 ```
 
-### Response Transforms
+### Async Transforms
 
-Response transforms produce a separate `transformedData` field while preserving the original `data`:
+Transform functions support async operations:
 
 ```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),
-    }),
+const { data, meta } = useRead((api) => api("posts").GET(), {
+  transform: async (posts) => {
+    const enriched = await enrichPostsWithMetadata(posts);
+    return {
+      count: enriched.length,
+      titles: enriched.map((p) => p.title),
+    };
   },
 });
-
-// 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
+- ✅ Full type inference for 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:
+Due to TypeScript limitations with dynamic trigger options, `meta.transformedData` is typed as `never` in `useWrite` hook results. Use type assertion:
 
 ```typescript
 type TransformedPost = {
@@ -84,10 +67,10 @@ type TransformedPost = {
   postId: number;
 };
 
-const { transformedData } = useWrite((api) => api.posts.$post);
+const { meta } = useWrite((api) => api("posts").POST);
 
 // Type assertion required
-const typed = transformedData as TransformedPost | undefined;
+const typed = meta.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

@@ -1,42 +1,25 @@
 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>;
+/**
+ * Transform response data after request. Returns transformedData (can be any type).
+ */
 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;
+    /** Per-request transform function for response data. */
+    transform?: ResponseTransformer<unknown, unknown>;
 }
 interface TransformWriteOptions {
-    /** Per-request transform functions. */
-    transform?: TransformConfig;
+    /** Per-request transform function for response data. */
+    transform?: ResponseTransformer<unknown, unknown>;
 }
 interface TransformInfiniteReadOptions {
-    /** Per-request transform functions. */
-    transform?: TransformConfig;
+    /** Per-request transform function for response data. */
+    transform?: ResponseTransformer<unknown, unknown>;
 }
 type TransformReadResult = object;
 type TransformWriteResult = object;
@@ -46,9 +29,7 @@ type TransformOptions = TransformReadOptions | TransformWriteOptions | Transform
  * Returns `never` if no response transformer is provided.
  */
 type InferTransformedData<TOptions> = TOptions extends {
-    transform: {
-        response: (data: never) => MaybePromise<infer R>;
-    };
+    transform: (data: never) => MaybePromise<infer R>;
 } ? R : never;
 /**
  * Conditionally adds `transformedData` field to hook result.
@@ -59,36 +40,21 @@ type TransformResultField<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;
+        transform: ResponseTransformer<TContext["data"], unknown> | undefined;
     }
     interface PluginResultResolvers<TOptions> {
         transformedData: TOptions extends {
-            transform: {
-                response: (data: never) => MaybePromise<infer R>;
-            };
+            transform: (data: never) => MaybePromise<infer R>;
         } ? Awaited<R> | undefined : never;
     }
 }
 
 /**
- * Enables data transformation for query, body, formData, urlEncoded, and response.
+ * Enables response data transformation.
  *
- * Supports both sync and async transformer functions. All data is deep-cloned
- * before transformation to prevent mutation of original objects.
+ * Supports both sync and async transformer functions.
  *
  * All transforms are per-request for full type inference.
  *
@@ -105,26 +71,18 @@ declare module "@spoosh/core" {
  *   ]);
  *
  * // Per-request transforms with full type inference
- * const { data, transformedData } = useRead(
+ * const { data, meta } = useRead(
  *   (api) => api.posts.$get(),
  *   {
- *     transform: {
- *       query: (q) => ({ ...q, timestamp: Date.now() }),
- *       response: (posts) => ({
- *         count: posts.length,
- *         hasMore: posts.length >= 10,
- *       }),
- *     },
+ *     transform: (posts) => ({
+ *       count: posts.length,
+ *       hasMore: posts.length >= 10,
+ *     }),
  *   }
  * );
  *
- * // useWrite with body transform
- * trigger({
- *   body: { name: "test" },
- *   transform: {
- *     body: (b) => ({ ...b, createdAt: Date.now() }),
- *   },
- * });
+ * // Access transformed data via meta
+ * console.log(meta.transformedData);
  * ```
  */
 declare function transformPlugin(): SpooshPlugin<{
@@ -135,4 +93,4 @@ declare function transformPlugin(): SpooshPlugin<{
     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 };
+export { type InferTransformedData, type MaybePromise, type ResponseTransformer, type TransformInfiniteReadOptions, type TransformOptions, type TransformPluginConfig, type TransformReadOptions, type TransformReadResult, type TransformResultField, type TransformWriteOptions, type TransformWriteResult, transformPlugin };

package/dist/index.d.ts

@@ -1,42 +1,25 @@
 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>;
+/**
+ * Transform response data after request. Returns transformedData (can be any type).
+ */
 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;
+    /** Per-request transform function for response data. */
+    transform?: ResponseTransformer<unknown, unknown>;
 }
 interface TransformWriteOptions {
-    /** Per-request transform functions. */
-    transform?: TransformConfig;
+    /** Per-request transform function for response data. */
+    transform?: ResponseTransformer<unknown, unknown>;
 }
 interface TransformInfiniteReadOptions {
-    /** Per-request transform functions. */
-    transform?: TransformConfig;
+    /** Per-request transform function for response data. */
+    transform?: ResponseTransformer<unknown, unknown>;
 }
 type TransformReadResult = object;
 type TransformWriteResult = object;
@@ -46,9 +29,7 @@ type TransformOptions = TransformReadOptions | TransformWriteOptions | Transform
  * Returns `never` if no response transformer is provided.
  */
 type InferTransformedData<TOptions> = TOptions extends {
-    transform: {
-        response: (data: never) => MaybePromise<infer R>;
-    };
+    transform: (data: never) => MaybePromise<infer R>;
 } ? R : never;
 /**
  * Conditionally adds `transformedData` field to hook result.
@@ -59,36 +40,21 @@ type TransformResultField<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;
+        transform: ResponseTransformer<TContext["data"], unknown> | undefined;
     }
     interface PluginResultResolvers<TOptions> {
         transformedData: TOptions extends {
-            transform: {
-                response: (data: never) => MaybePromise<infer R>;
-            };
+            transform: (data: never) => MaybePromise<infer R>;
         } ? Awaited<R> | undefined : never;
     }
 }
 
 /**
- * Enables data transformation for query, body, formData, urlEncoded, and response.
+ * Enables response data transformation.
  *
- * Supports both sync and async transformer functions. All data is deep-cloned
- * before transformation to prevent mutation of original objects.
+ * Supports both sync and async transformer functions.
  *
  * All transforms are per-request for full type inference.
  *
@@ -105,26 +71,18 @@ declare module "@spoosh/core" {
  *   ]);
  *
  * // Per-request transforms with full type inference
- * const { data, transformedData } = useRead(
+ * const { data, meta } = useRead(
  *   (api) => api.posts.$get(),
  *   {
- *     transform: {
- *       query: (q) => ({ ...q, timestamp: Date.now() }),
- *       response: (posts) => ({
- *         count: posts.length,
- *         hasMore: posts.length >= 10,
- *       }),
- *     },
+ *     transform: (posts) => ({
+ *       count: posts.length,
+ *       hasMore: posts.length >= 10,
+ *     }),
  *   }
  * );
  *
- * // useWrite with body transform
- * trigger({
- *   body: { name: "test" },
- *   transform: {
- *     body: (b) => ({ ...b, createdAt: Date.now() }),
- *   },
- * });
+ * // Access transformed data via meta
+ * console.log(meta.transformedData);
  * ```
  */
 declare function transformPlugin(): SpooshPlugin<{
@@ -135,4 +93,4 @@ declare function transformPlugin(): SpooshPlugin<{
     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 };
+export { type InferTransformedData, type MaybePromise, type ResponseTransformer, type TransformInfiniteReadOptions, type TransformOptions, type TransformPluginConfig, type TransformReadOptions, type TransformReadResult, type TransformResultField, type TransformWriteOptions, type TransformWriteResult, transformPlugin };

package/dist/index.js

@@ -25,61 +25,13 @@ __export(src_exports, {
 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;
+      const responseTransformer = pluginOptions?.transform;
       if (responseTransformer && response.data !== void 0) {
         const transformedData = await responseTransformer(response.data);
         context.stateManager.setMeta(context.queryKey, {

package/dist/index.mjs

@@ -1,59 +1,11 @@
 // 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;
+      const responseTransformer = pluginOptions?.transform;
       if (responseTransformer && response.data !== void 0) {
         const transformedData = await responseTransformer(response.data);
         context.stateManager.setMeta(context.queryKey, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoosh/plugin-transform",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Data transformation plugin for Spoosh with sync/async support",
   "license": "MIT",
   "repository": {
@@ -33,10 +33,10 @@
     }
   },
   "peerDependencies": {
-    "@spoosh/core": ">=0.4.0"
+    "@spoosh/core": ">=0.6.0"
   },
   "devDependencies": {
-    "@spoosh/core": "0.5.0",
+    "@spoosh/core": "0.6.0",
     "@spoosh/test-utils": "0.1.5"
   },
   "scripts": {