@spoosh/plugin-initial-data 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,45 @@
+# @spoosh/plugin-initial-data
+
+Initial data plugin for Spoosh - show data immediately before fetch completes.
+
+**[Documentation](https://spoosh.dev/docs/plugins/initial-data)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
+
+## Installation
+
+```bash
+npm install @spoosh/plugin-initial-data
+```
+
+## Usage
+
+```typescript
+import { initialDataPlugin } from "@spoosh/plugin-initial-data";
+
+const plugins = [initialDataPlugin()];
+
+// Show prefetched data immediately, then refetch in background
+const { data, isInitialData } = useRead((api) => api.posts.$get(), {
+  initialData: prefetchedPosts,
+});
+
+// Show initial data without background refetch
+const { data } = useRead((api) => api.posts.$get(), {
+  initialData: prefetchedPosts,
+  refetchOnInitialData: false,
+});
+```
+
+## Options
+
+### Per-Request Options
+
+| Option                 | Type      | Default | Description                                   |
+| ---------------------- | --------- | ------- | --------------------------------------------- |
+| `initialData`          | `TData`   | -       | Data to show immediately on first mount       |
+| `refetchOnInitialData` | `boolean` | `true`  | Whether to refetch after showing initial data |
+
+### Result
+
+| Property        | Type      | Description                                                |
+| --------------- | --------- | ---------------------------------------------------------- |
+| `isInitialData` | `boolean` | `true` if currently showing initial data (not yet fetched) |

package/dist/index.d.mts

@@ -0,0 +1,60 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface InitialDataReadOptions<TData = unknown> {
+    /** Data to use immediately on first mount (before fetch completes) */
+    initialData?: TData;
+    /** Refetch fresh data after showing initial data. Default: true */
+    refetchOnInitialData?: boolean;
+}
+type InitialDataInfiniteReadOptions<TData = unknown> = InitialDataReadOptions<TData>;
+interface InitialDataReadResult {
+    /** True if currently showing initial data (not yet fetched from server) */
+    isInitialData: boolean;
+}
+type InitialDataWriteOptions = object;
+type InitialDataWriteResult = object;
+declare module "@spoosh/core" {
+    interface PluginResolvers<TContext> {
+        initialData: TContext["data"] | undefined;
+    }
+}
+
+/**
+ * Enables providing initial data for queries.
+ *
+ * Initial data is shown immediately on first mount, before any fetch completes.
+ * By default, a background refetch is triggered to get fresh data.
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/initial-data | Initial Data Plugin Documentation}
+ *
+ * @returns Initial data plugin instance
+ *
+ * @example
+ * ```ts
+ * const plugins = [
+ *   initialDataPlugin(),
+ *   cachePlugin({ staleTime: 5000 }),
+ * ];
+ *
+ * // Basic usage - shows initialData, refetches in background
+ * const { data, isInitialData } = useRead(
+ *   (api) => api.posts.$get(),
+ *   { initialData: prefetchedPosts }
+ * );
+ *
+ * // Disable background refetch
+ * const { data } = useRead(
+ *   (api) => api.posts.$get(),
+ *   { initialData: prefetchedPosts, refetchOnInitialData: false }
+ * );
+ * ```
+ */
+declare function initialDataPlugin(): SpooshPlugin<{
+    readOptions: InitialDataReadOptions;
+    writeOptions: InitialDataWriteOptions;
+    infiniteReadOptions: InitialDataInfiniteReadOptions;
+    readResult: InitialDataReadResult;
+    writeResult: InitialDataWriteResult;
+}>;
+
+export { type InitialDataInfiniteReadOptions, type InitialDataReadOptions, type InitialDataReadResult, type InitialDataWriteOptions, type InitialDataWriteResult, initialDataPlugin };

package/dist/index.d.ts

@@ -0,0 +1,60 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface InitialDataReadOptions<TData = unknown> {
+    /** Data to use immediately on first mount (before fetch completes) */
+    initialData?: TData;
+    /** Refetch fresh data after showing initial data. Default: true */
+    refetchOnInitialData?: boolean;
+}
+type InitialDataInfiniteReadOptions<TData = unknown> = InitialDataReadOptions<TData>;
+interface InitialDataReadResult {
+    /** True if currently showing initial data (not yet fetched from server) */
+    isInitialData: boolean;
+}
+type InitialDataWriteOptions = object;
+type InitialDataWriteResult = object;
+declare module "@spoosh/core" {
+    interface PluginResolvers<TContext> {
+        initialData: TContext["data"] | undefined;
+    }
+}
+
+/**
+ * Enables providing initial data for queries.
+ *
+ * Initial data is shown immediately on first mount, before any fetch completes.
+ * By default, a background refetch is triggered to get fresh data.
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/initial-data | Initial Data Plugin Documentation}
+ *
+ * @returns Initial data plugin instance
+ *
+ * @example
+ * ```ts
+ * const plugins = [
+ *   initialDataPlugin(),
+ *   cachePlugin({ staleTime: 5000 }),
+ * ];
+ *
+ * // Basic usage - shows initialData, refetches in background
+ * const { data, isInitialData } = useRead(
+ *   (api) => api.posts.$get(),
+ *   { initialData: prefetchedPosts }
+ * );
+ *
+ * // Disable background refetch
+ * const { data } = useRead(
+ *   (api) => api.posts.$get(),
+ *   { initialData: prefetchedPosts, refetchOnInitialData: false }
+ * );
+ * ```
+ */
+declare function initialDataPlugin(): SpooshPlugin<{
+    readOptions: InitialDataReadOptions;
+    writeOptions: InitialDataWriteOptions;
+    infiniteReadOptions: InitialDataInfiniteReadOptions;
+    readResult: InitialDataReadResult;
+    writeResult: InitialDataWriteResult;
+}>;
+
+export { type InitialDataInfiniteReadOptions, type InitialDataReadOptions, type InitialDataReadResult, type InitialDataWriteOptions, type InitialDataWriteResult, initialDataPlugin };

package/dist/index.js

@@ -0,0 +1,104 @@
+"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, {
+  initialDataPlugin: () => initialDataPlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+function initialDataPlugin() {
+  const initialDataAppliedFor = /* @__PURE__ */ new Set();
+  return {
+    name: "spoosh:initialData",
+    operations: ["read", "infiniteRead"],
+    middleware: async (context, next) => {
+      const pluginOptions = context.pluginOptions;
+      if (pluginOptions?.initialData === void 0) {
+        const response2 = await next();
+        if (!response2.error) {
+          context.stateManager.setPluginResult(context.queryKey, {
+            isInitialData: false
+          });
+        }
+        return response2;
+      }
+      if (!context.hookId) {
+        const response2 = await next();
+        if (!response2.error) {
+          context.stateManager.setPluginResult(context.queryKey, {
+            isInitialData: false
+          });
+        }
+        return response2;
+      }
+      if (initialDataAppliedFor.has(context.hookId)) {
+        const response2 = await next();
+        if (!response2.error) {
+          context.stateManager.setPluginResult(context.queryKey, {
+            isInitialData: false
+          });
+        }
+        return response2;
+      }
+      const cached = context.stateManager.getCache(context.queryKey);
+      if (cached?.state?.data !== void 0) {
+        initialDataAppliedFor.add(context.hookId);
+        const response2 = await next();
+        if (!response2.error) {
+          context.stateManager.setPluginResult(context.queryKey, {
+            isInitialData: false
+          });
+        }
+        return response2;
+      }
+      initialDataAppliedFor.add(context.hookId);
+      context.stateManager.setCache(context.queryKey, {
+        state: {
+          data: pluginOptions.initialData,
+          error: void 0,
+          timestamp: Date.now()
+        },
+        tags: context.tags
+      });
+      context.stateManager.setPluginResult(context.queryKey, {
+        isInitialData: true
+      });
+      if (pluginOptions.refetchOnInitialData === false) {
+        return { data: pluginOptions.initialData, status: 200 };
+      }
+      const response = await next();
+      if (!response.error) {
+        context.stateManager.setPluginResult(context.queryKey, {
+          isInitialData: false
+        });
+      }
+      return response;
+    },
+    lifecycle: {
+      onUnmount(context) {
+        if (context.hookId) {
+          initialDataAppliedFor.delete(context.hookId);
+        }
+      }
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,81 @@
+// src/plugin.ts
+function initialDataPlugin() {
+  const initialDataAppliedFor = /* @__PURE__ */ new Set();
+  return {
+    name: "spoosh:initialData",
+    operations: ["read", "infiniteRead"],
+    middleware: async (context, next) => {
+      const pluginOptions = context.pluginOptions;
+      if (pluginOptions?.initialData === void 0) {
+        const response2 = await next();
+        if (!response2.error) {
+          context.stateManager.setPluginResult(context.queryKey, {
+            isInitialData: false
+          });
+        }
+        return response2;
+      }
+      if (!context.hookId) {
+        const response2 = await next();
+        if (!response2.error) {
+          context.stateManager.setPluginResult(context.queryKey, {
+            isInitialData: false
+          });
+        }
+        return response2;
+      }
+      if (initialDataAppliedFor.has(context.hookId)) {
+        const response2 = await next();
+        if (!response2.error) {
+          context.stateManager.setPluginResult(context.queryKey, {
+            isInitialData: false
+          });
+        }
+        return response2;
+      }
+      const cached = context.stateManager.getCache(context.queryKey);
+      if (cached?.state?.data !== void 0) {
+        initialDataAppliedFor.add(context.hookId);
+        const response2 = await next();
+        if (!response2.error) {
+          context.stateManager.setPluginResult(context.queryKey, {
+            isInitialData: false
+          });
+        }
+        return response2;
+      }
+      initialDataAppliedFor.add(context.hookId);
+      context.stateManager.setCache(context.queryKey, {
+        state: {
+          data: pluginOptions.initialData,
+          error: void 0,
+          timestamp: Date.now()
+        },
+        tags: context.tags
+      });
+      context.stateManager.setPluginResult(context.queryKey, {
+        isInitialData: true
+      });
+      if (pluginOptions.refetchOnInitialData === false) {
+        return { data: pluginOptions.initialData, status: 200 };
+      }
+      const response = await next();
+      if (!response.error) {
+        context.stateManager.setPluginResult(context.queryKey, {
+          isInitialData: false
+        });
+      }
+      return response;
+    },
+    lifecycle: {
+      onUnmount(context) {
+        if (context.hookId) {
+          initialDataAppliedFor.delete(context.hookId);
+        }
+      }
+    }
+  };
+}
+export {
+  initialDataPlugin
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@spoosh/plugin-initial-data",
+  "version": "0.1.0-beta.0",
+  "description": "Initial data plugin for Spoosh - show data immediately before fetch completes",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nxnom/spoosh.git",
+    "directory": "packages/plugin-initial-data"
+  },
+  "bugs": {
+    "url": "https://github.com/nxnom/spoosh/issues"
+  },
+  "homepage": "https://spoosh.dev/docs/plugins/initial-data",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "spoosh",
+    "plugin",
+    "initial-data",
+    "api-client",
+    "prefetch"
+  ],
+  "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'"
+  }
+}