@spoosh/plugin-transform 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +25 -40
  2. package/dist/index.d.mts +17 -28
  3. package/dist/index.d.ts +17 -28
  4. package/dist/index.js +1 -1
  5. package/dist/index.mjs +1 -1
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @spoosh/plugin-transform
2
2
 
3
- Transform request and response data with full type inference.
3
+ Transform response data with full type inference.
4
4
 
5
5
  **[Documentation](https://spoosh.dev/docs/plugins/transform)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
6
6
 
@@ -12,7 +12,9 @@ npm install @spoosh/plugin-transform
12
12
 
13
13
  ## Usage
14
14
 
15
- ### Request Transforms
15
+ ### Response Transforms
16
+
17
+ Response transforms produce a separate `transformedData` field in `meta` while preserving the original `data`:
16
18
 
17
19
  ```typescript
18
20
  import { Spoosh } from "@spoosh/core";
@@ -20,61 +22,44 @@ import { transformPlugin } from "@spoosh/plugin-transform";
20
22
 
21
23
  const client = new Spoosh<ApiSchema, Error>("/api").use([transformPlugin()]);
22
24
 
23
- const { data } = useRead((api) => api("posts").GET({ query: { page: 1 } }), {
24
- transform: {
25
- query: (q) => ({ ...q, limit: 10 }),
26
- },
25
+ const { data, meta } = useRead((api) => api("posts").GET(), {
26
+ transform: (posts) => ({
27
+ count: posts.length,
28
+ hasMore: posts.length >= 10,
29
+ ids: posts.map((p) => p.id),
30
+ }),
27
31
  });
28
32
 
29
- // Transform body in useWrite
30
- const { trigger } = useWrite((api) => api("posts").POST);
31
-
32
- trigger({
33
- body: { title: "New Post" },
34
- transform: {
35
- body: (b) => ({ ...b, createdAt: Date.now() }),
36
- },
37
- });
33
+ // data = Post[] (original response, preserved)
34
+ // meta.transformedData = { count: number, hasMore: boolean, ids: number[] } | undefined
38
35
  ```
39
36
 
40
- ### Response Transforms
37
+ ### Async Transforms
41
38
 
42
- Response transforms produce a separate `transformedData` field while preserving the original `data`:
39
+ Transform functions support async operations:
43
40
 
44
41
  ```typescript
45
- const { data, transformedData } = useRead((api) => api("posts").GET(), {
46
- transform: {
47
- response: (posts) => ({
48
- count: posts.length,
49
- hasMore: posts.length >= 10,
50
- ids: posts.map((p) => p.id),
51
- }),
42
+ const { data, meta } = useRead((api) => api("posts").GET(), {
43
+ transform: async (posts) => {
44
+ const enriched = await enrichPostsWithMetadata(posts);
45
+ return {
46
+ count: enriched.length,
47
+ titles: enriched.map((p) => p.title),
48
+ };
52
49
  },
53
50
  });
54
-
55
- // data = Post[] (original response, preserved)
56
- // transformedData = { count: number, hasMore: boolean, ids: number[] } | undefined
57
51
  ```
58
52
 
59
- ## Transform Types
60
-
61
- The plugin supports transformation of:
62
-
63
- - **query** - Transform query parameters before request
64
- - **body** - Transform request body before request (files auto-detected)
65
- - **response** - Transform response data after request (produces `transformedData`)
66
-
67
53
  ## Features
68
54
 
69
- - ✅ Full type inference for all transforms
55
+ - ✅ Full type inference for transforms
70
56
  - ✅ Async transform functions supported
71
- - ✅ Automatic deep cloning (safe to mutate)
72
57
  - ✅ Per-request transforms (no global config needed)
73
58
  - ✅ Return `undefined` to remove data entirely
74
59
 
75
60
  ## TypeScript Limitation (useWrite)
76
61
 
77
- Due to TypeScript limitations with dynamic trigger options, `transformedData` is typed as `never` in `useWrite` hook results. Use type assertion:
62
+ Due to TypeScript limitations with dynamic trigger options, `meta.transformedData` is typed as `never` in `useWrite` hook results. Use type assertion:
78
63
 
79
64
  ```typescript
80
65
  type TransformedPost = {
@@ -82,10 +67,10 @@ type TransformedPost = {
82
67
  postId: number;
83
68
  };
84
69
 
85
- const { transformedData } = useWrite((api) => api("posts").POST);
70
+ const { meta } = useWrite((api) => api("posts").POST);
86
71
 
87
72
  // Type assertion required
88
- const typed = transformedData as TransformedPost | undefined;
73
+ const typed = meta.transformedData as TransformedPost | undefined;
89
74
  ```
90
75
 
91
76
  This limitation does not affect `useRead` or `useInfiniteRead`, where options are passed at hook creation time.
package/dist/index.d.mts CHANGED
@@ -1,26 +1,25 @@
1
1
  import { ResolverContext, SpooshPlugin } from '@spoosh/core';
2
2
 
3
3
  type MaybePromise<T> = T | Promise<T>;
4
+ /**
5
+ * Transform response data after request. Returns transformedData (can be any type).
6
+ */
4
7
  type ResponseTransformer<TIn = unknown, TOut = unknown> = (response: TIn) => MaybePromise<TOut>;
5
- interface TransformConfig {
6
- /** Transform response data after request. Returns transformedData (can be any type). */
7
- response?: ResponseTransformer<unknown, unknown>;
8
- }
9
8
  /**
10
9
  * Plugin-level config. All transforms are per-request only for type inference.
11
10
  */
12
11
  type TransformPluginConfig = object;
13
12
  interface TransformReadOptions {
14
- /** Per-request transform functions. */
15
- transform?: TransformConfig;
13
+ /** Per-request transform function for response data. */
14
+ transform?: ResponseTransformer<unknown, unknown>;
16
15
  }
17
16
  interface TransformWriteOptions {
18
- /** Per-request transform functions. */
19
- transform?: TransformConfig;
17
+ /** Per-request transform function for response data. */
18
+ transform?: ResponseTransformer<unknown, unknown>;
20
19
  }
21
20
  interface TransformInfiniteReadOptions {
22
- /** Per-request transform functions. */
23
- transform?: TransformConfig;
21
+ /** Per-request transform function for response data. */
22
+ transform?: ResponseTransformer<unknown, unknown>;
24
23
  }
25
24
  type TransformReadResult = object;
26
25
  type TransformWriteResult = object;
@@ -30,9 +29,7 @@ type TransformOptions = TransformReadOptions | TransformWriteOptions | Transform
30
29
  * Returns `never` if no response transformer is provided.
31
30
  */
32
31
  type InferTransformedData<TOptions> = TOptions extends {
33
- transform: {
34
- response: (data: never) => MaybePromise<infer R>;
35
- };
32
+ transform: (data: never) => MaybePromise<infer R>;
36
33
  } ? R : never;
37
34
  /**
38
35
  * Conditionally adds `transformedData` field to hook result.
@@ -43,19 +40,13 @@ type TransformResultField<TOptions> = [
43
40
  ] extends [never] ? object : {
44
41
  transformedData: InferTransformedData<TOptions> | undefined;
45
42
  };
46
- type ResolvedTransformConfig<TContext extends ResolverContext> = {
47
- /** Transform response data after request. Returns transformedData (can be any type). */
48
- response?: ResponseTransformer<TContext["data"], unknown>;
49
- };
50
43
  declare module "@spoosh/core" {
51
44
  interface PluginResolvers<TContext extends ResolverContext> {
52
- transform: ResolvedTransformConfig<TContext> | undefined;
45
+ transform: ResponseTransformer<TContext["data"], unknown> | undefined;
53
46
  }
54
47
  interface PluginResultResolvers<TOptions> {
55
48
  transformedData: TOptions extends {
56
- transform: {
57
- response: (data: never) => MaybePromise<infer R>;
58
- };
49
+ transform: (data: never) => MaybePromise<infer R>;
59
50
  } ? Awaited<R> | undefined : never;
60
51
  }
61
52
  }
@@ -83,12 +74,10 @@ declare module "@spoosh/core" {
83
74
  * const { data, meta } = useRead(
84
75
  * (api) => api.posts.$get(),
85
76
  * {
86
- * transform: {
87
- * response: (posts) => ({
88
- * count: posts.length,
89
- * hasMore: posts.length >= 10,
90
- * }),
91
- * },
77
+ * transform: (posts) => ({
78
+ * count: posts.length,
79
+ * hasMore: posts.length >= 10,
80
+ * }),
92
81
  * }
93
82
  * );
94
83
  *
@@ -104,4 +93,4 @@ declare function transformPlugin(): SpooshPlugin<{
104
93
  writeResult: TransformWriteResult;
105
94
  }>;
106
95
 
107
- export { type InferTransformedData, type MaybePromise, type ResponseTransformer, type TransformConfig, type TransformInfiniteReadOptions, type TransformOptions, type TransformPluginConfig, type TransformReadOptions, type TransformReadResult, type TransformResultField, type TransformWriteOptions, type TransformWriteResult, transformPlugin };
96
+ 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 CHANGED
@@ -1,26 +1,25 @@
1
1
  import { ResolverContext, SpooshPlugin } from '@spoosh/core';
2
2
 
3
3
  type MaybePromise<T> = T | Promise<T>;
4
+ /**
5
+ * Transform response data after request. Returns transformedData (can be any type).
6
+ */
4
7
  type ResponseTransformer<TIn = unknown, TOut = unknown> = (response: TIn) => MaybePromise<TOut>;
5
- interface TransformConfig {
6
- /** Transform response data after request. Returns transformedData (can be any type). */
7
- response?: ResponseTransformer<unknown, unknown>;
8
- }
9
8
  /**
10
9
  * Plugin-level config. All transforms are per-request only for type inference.
11
10
  */
12
11
  type TransformPluginConfig = object;
13
12
  interface TransformReadOptions {
14
- /** Per-request transform functions. */
15
- transform?: TransformConfig;
13
+ /** Per-request transform function for response data. */
14
+ transform?: ResponseTransformer<unknown, unknown>;
16
15
  }
17
16
  interface TransformWriteOptions {
18
- /** Per-request transform functions. */
19
- transform?: TransformConfig;
17
+ /** Per-request transform function for response data. */
18
+ transform?: ResponseTransformer<unknown, unknown>;
20
19
  }
21
20
  interface TransformInfiniteReadOptions {
22
- /** Per-request transform functions. */
23
- transform?: TransformConfig;
21
+ /** Per-request transform function for response data. */
22
+ transform?: ResponseTransformer<unknown, unknown>;
24
23
  }
25
24
  type TransformReadResult = object;
26
25
  type TransformWriteResult = object;
@@ -30,9 +29,7 @@ type TransformOptions = TransformReadOptions | TransformWriteOptions | Transform
30
29
  * Returns `never` if no response transformer is provided.
31
30
  */
32
31
  type InferTransformedData<TOptions> = TOptions extends {
33
- transform: {
34
- response: (data: never) => MaybePromise<infer R>;
35
- };
32
+ transform: (data: never) => MaybePromise<infer R>;
36
33
  } ? R : never;
37
34
  /**
38
35
  * Conditionally adds `transformedData` field to hook result.
@@ -43,19 +40,13 @@ type TransformResultField<TOptions> = [
43
40
  ] extends [never] ? object : {
44
41
  transformedData: InferTransformedData<TOptions> | undefined;
45
42
  };
46
- type ResolvedTransformConfig<TContext extends ResolverContext> = {
47
- /** Transform response data after request. Returns transformedData (can be any type). */
48
- response?: ResponseTransformer<TContext["data"], unknown>;
49
- };
50
43
  declare module "@spoosh/core" {
51
44
  interface PluginResolvers<TContext extends ResolverContext> {
52
- transform: ResolvedTransformConfig<TContext> | undefined;
45
+ transform: ResponseTransformer<TContext["data"], unknown> | undefined;
53
46
  }
54
47
  interface PluginResultResolvers<TOptions> {
55
48
  transformedData: TOptions extends {
56
- transform: {
57
- response: (data: never) => MaybePromise<infer R>;
58
- };
49
+ transform: (data: never) => MaybePromise<infer R>;
59
50
  } ? Awaited<R> | undefined : never;
60
51
  }
61
52
  }
@@ -83,12 +74,10 @@ declare module "@spoosh/core" {
83
74
  * const { data, meta } = useRead(
84
75
  * (api) => api.posts.$get(),
85
76
  * {
86
- * transform: {
87
- * response: (posts) => ({
88
- * count: posts.length,
89
- * hasMore: posts.length >= 10,
90
- * }),
91
- * },
77
+ * transform: (posts) => ({
78
+ * count: posts.length,
79
+ * hasMore: posts.length >= 10,
80
+ * }),
92
81
  * }
93
82
  * );
94
83
  *
@@ -104,4 +93,4 @@ declare function transformPlugin(): SpooshPlugin<{
104
93
  writeResult: TransformWriteResult;
105
94
  }>;
106
95
 
107
- export { type InferTransformedData, type MaybePromise, type ResponseTransformer, type TransformConfig, type TransformInfiniteReadOptions, type TransformOptions, type TransformPluginConfig, type TransformReadOptions, type TransformReadResult, type TransformResultField, type TransformWriteOptions, type TransformWriteResult, transformPlugin };
96
+ 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 CHANGED
@@ -31,7 +31,7 @@ function transformPlugin() {
31
31
  operations: ["read", "write", "infiniteRead"],
32
32
  onResponse: async (context, response) => {
33
33
  const pluginOptions = context.pluginOptions;
34
- const responseTransformer = pluginOptions?.transform?.response;
34
+ const responseTransformer = pluginOptions?.transform;
35
35
  if (responseTransformer && response.data !== void 0) {
36
36
  const transformedData = await responseTransformer(response.data);
37
37
  context.stateManager.setMeta(context.queryKey, {
package/dist/index.mjs CHANGED
@@ -5,7 +5,7 @@ function transformPlugin() {
5
5
  operations: ["read", "write", "infiniteRead"],
6
6
  onResponse: async (context, response) => {
7
7
  const pluginOptions = context.pluginOptions;
8
- const responseTransformer = pluginOptions?.transform?.response;
8
+ const responseTransformer = pluginOptions?.transform;
9
9
  if (responseTransformer && response.data !== void 0) {
10
10
  const transformedData = await responseTransformer(response.data);
11
11
  context.stateManager.setMeta(context.queryKey, {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spoosh/plugin-transform",
3
- "version": "0.3.0",
3
+ "version": "0.4.0",
4
4
  "description": "Data transformation plugin for Spoosh with sync/async support",
5
5
  "license": "MIT",
6
6
  "repository": {