floppy-disk 3.1.0 → 3.1.1

package/README.md

@@ -1,9 +1,12 @@
 # FloppyDisk.ts 💾
 
-A lightweight, simple, and powerful state management library.
+A unified state model for **sync & async** data.
 
-This library was highly-inspired by [Zustand](https://www.npmjs.com/package/zustand) and [TanStack-Query](https://tanstack.com/query), they're awesome state manager.
-FloppyDisk provides a very similar developer experience (DX), while introducing additional features and a smaller bundle size.
+If you know [Zustand](https://zustand.docs.pmnd.rs) & [TanStack-Query](https://tanstack.com/query), you already know FloppyDisk.\
+It keeps what works, removes unnecessary complexity, and unifies everything into a simpler API.\
+No relearning—just a better experience.
+
+_Smaller bundle. Zero dependencies._
 
 Demo: https://afiiif.github.io/floppy-disk/
 
@@ -18,11 +21,11 @@ npm install floppy-disk
 Here's how to create and use a store:
 
 ```tsx
-import { createStore } from 'floppy-disk/react';
+import { createStore } from "floppy-disk/react";
 
 const useDigimon = createStore({
   age: 7,
-  level: 'Rookie',
+  level: "Rookie",
 });
 ```
 
@@ -57,10 +60,10 @@ function Control() {
 const evolve = () => {
   const { level } = useDigimon.getState();
 
-  const order = ['In-Training', 'Rookie', 'Champion', 'Ultimate'];
+  const order = ["In-Training", "Rookie", "Champion", "Ultimate"];
   const nextLevel = order[order.indexOf(level) + 1];
 
-  if (!nextLevel) return console.warn('Already at ultimate level');
+  if (!nextLevel) return console.warn("Already at ultimate level");
 
   useDigimon.setState({ level: nextLevel });
 };
@@ -74,7 +77,7 @@ You can subscribe manually:
 
 ```tsx
 const unsubscribe = useMyStore.subscribe((state, prev) => {
-  console.log('New state:', state);
+  console.log("New state:", state);
 });
 
 // Later
@@ -88,16 +91,16 @@ const useTowerDefense = createStore(
   { archers: 3, mages: 1, barracks: 2, artillery: 1 },
   {
     onFirstSubscribe: () => {
-      console.log('First subscriber! We’re officially popular 🎉');
+      console.log("First subscriber! We’re officially popular 🎉");
     },
     onSubscribe: () => {
-      console.log('New subscriber joined. Welcome aboard 🫡');
+      console.log("New subscriber joined. Welcome aboard 🫡");
     },
     onUnsubscribe: () => {
-      console.log('Subscriber left... was it something I said? 😭');
+      console.log("Subscriber left... was it something I said? 😭");
     },
     onLastUnsubscribe: () => {
-      console.log('Everyone left. Guess I’ll just exist quietly now...');
+      console.log("Everyone left. Guess I’ll just exist quietly now...");
     },
   },
 );
@@ -212,7 +215,7 @@ If you need retry mechanism, then you can always add it manually.
 Create a query using `createQuery`:
 
 ```tsx
-import { createQuery } from 'floppy-disk/react';
+import { createQuery } from "floppy-disk/react";
 
 const myCoolQuery = createQuery(
   myAsyncFn,
@@ -225,7 +228,7 @@ const useMyCoolQuery = myCoolQuery();
 
 function MyComponent() {
   const query = useMyCoolQuery();
-  if (query.state === 'INITIAL') return <div>Loading...</div>;
+  if (query.state === "INITIAL") return <div>Loading...</div>;
   if (query.error) return <div>Error: {query.error.message}</div>;
   return <div>{JSON.stringify(query.data)}</div>;
 }
@@ -259,7 +262,7 @@ const value = useMyQuery().data?.foo.bar.baz;
 You can create parameterized queries:
 
 ```tsx
-import { getUserById, type GetUserByIdResponse } from '../utils';
+import { getUserById, type GetUserByIdResponse } from "../utils";
 
 type MyQueryParam = { id: string };
 
@@ -275,7 +278,7 @@ Use it with parameters:
 function UserDetail({ id }) {
   const useUserQuery = userQuery({ id: 1 });
   const query = useUserQuery();
-  if (query.state === 'INITIAL') return <div>Loading...</div>;
+  if (query.state === "INITIAL") return <div>Loading...</div>;
   if (query.error) return <div>Error: {query.error.message}</div>;
   return <div>{JSON.stringify(query.data)}</div>;
 }
@@ -323,7 +326,7 @@ function Page({ cursor }: { cursor?: string }) {
   const usePostsQuery = postsQuery({ cursor });
   const { state, data, error } = usePostsQuery();
 
-  if (state === 'INITIAL') return <div>Loading...</div>;
+  if (state === "INITIAL") return <div>Loading...</div>;
   if (error) return <div>Error</div>;
 
   return (

package/esm/index.d.mts

@@ -1 +1 @@
-export * from 'floppy-disk/vanilla';
+export * from "./vanilla.ts";

package/esm/react/create-mutation.d.mts

@@ -1,4 +1,4 @@
-import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
+import { type InitStoreOptions, type SetState } from "../vanilla.ts";
 /**
  * Represents the state of a mutation.
  *
@@ -17,7 +17,7 @@ import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
 export type MutationState<TData, TVariable, TError> = {
     isPending: boolean;
 } & ({
-    state: 'INITIAL';
+    state: "INITIAL";
     isSuccess: false;
     isError: false;
     variable: undefined;
@@ -26,7 +26,7 @@ export type MutationState<TData, TVariable, TError> = {
     error: undefined;
     errorUpdatedAt: undefined;
 } | {
-    state: 'SUCCESS';
+    state: "SUCCESS";
     isSuccess: true;
     isError: false;
     variable: TVariable;
@@ -35,7 +35,7 @@ export type MutationState<TData, TVariable, TError> = {
     error: undefined;
     errorUpdatedAt: undefined;
 } | {
-    state: 'ERROR';
+    state: "ERROR";
     isSuccess: false;
     isError: true;
     variable: TVariable;

package/esm/react/create-query.d.mts

@@ -1,4 +1,4 @@
-import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
+import { type InitStoreOptions, type SetState } from "../vanilla.ts";
 /**
  * Represents the state of a query.
  *
@@ -25,7 +25,7 @@ export type QueryState<TData, TError> = {
     isRetrying: boolean;
     retryCount: number;
 } & ({
-    state: 'INITIAL';
+    state: "INITIAL";
     isSuccess: false;
     isError: false;
     data: undefined;
@@ -33,7 +33,7 @@ export type QueryState<TData, TError> = {
     error: undefined;
     errorUpdatedAt: undefined;
 } | {
-    state: 'SUCCESS';
+    state: "SUCCESS";
     isSuccess: true;
     isError: false;
     data: TData;
@@ -41,7 +41,7 @@ export type QueryState<TData, TError> = {
     error: undefined;
     errorUpdatedAt: undefined;
 } | {
-    state: 'ERROR';
+    state: "ERROR";
     isSuccess: false;
     isError: true;
     data: undefined;
@@ -49,7 +49,7 @@ export type QueryState<TData, TError> = {
     error: TError;
     errorUpdatedAt: number;
 } | {
-    state: 'SUCCESS_BUT_REVALIDATION_ERROR';
+    state: "SUCCESS_BUT_REVALIDATION_ERROR";
     isSuccess: true;
     isError: false;
     data: TData;

package/esm/react/create-store.d.mts

@@ -1,4 +1,4 @@
-import { type InitStoreOptions } from 'floppy-disk/vanilla';
+import { type InitStoreOptions } from "../vanilla.ts";
 /**
  * Creates a single store with a bound React hook.
  *

package/esm/react/create-stores.d.mts

@@ -1,4 +1,4 @@
-import { type InitStoreOptions } from 'floppy-disk/vanilla';
+import { type InitStoreOptions } from "../vanilla.ts";
 /**
  * Creates a factory for multiple stores identified by a key.
  *

package/esm/react/use-isomorphic-layout-effect.d.mts

@@ -1,4 +1,4 @@
-import { useLayoutEffect } from 'react';
+import { useLayoutEffect } from "react";
 /**
  * Does exactly same as `useLayoutEffect`.\
  * It will use `useEffect` in **server-side** to prevent warning when executed on server-side.

package/esm/react/use-mutation.d.mts

@@ -1,4 +1,4 @@
-import { type MutationOptions, type MutationState } from './create-mutation.mjs';
+import { type MutationOptions, type MutationState } from "./create-mutation.ts";
 /**
  * A hook for managing async mutation state.
  *

package/esm/react/use-store.d.mts

@@ -1,4 +1,4 @@
-import { type StoreApi } from 'floppy-disk/vanilla';
+import { type StoreApi } from "../vanilla.ts";
 type Path = Array<string | number | symbol>;
 export declare const getValueByPath: (obj: any, path: Path) => any;
 export declare const isPrefixPath: (candidatePrefix: Path, targetPath: Path) => boolean;

package/esm/react.d.mts

@@ -1,7 +1,7 @@
-export * from './react/use-isomorphic-layout-effect.mjs';
-export { useStoreState } from './react/use-store.mjs';
-export * from './react/create-store.mjs';
-export * from './react/create-stores.mjs';
-export * from './react/create-query.mjs';
-export { createMutation, type MutationOptions, type MutationState, } from './react/create-mutation.mjs';
-export * from './react/use-mutation.mjs';
+export * from "./react/use-isomorphic-layout-effect.ts";
+export { useStoreState } from "./react/use-store.ts";
+export * from "./react/create-store.ts";
+export * from "./react/create-stores.ts";
+export * from "./react/create-query.ts";
+export { createMutation, type MutationOptions, type MutationState, } from "./react/create-mutation.ts";
+export * from "./react/use-mutation.ts";

package/esm/vanilla.d.mts

@@ -1,3 +1,3 @@
-export * from './vanilla/basic.mjs';
-export * from './vanilla/hash.mjs';
-export * from './vanilla/store.mjs';
+export * from "./vanilla/basic.ts";
+export * from "./vanilla/hash.ts";
+export * from "./vanilla/store.ts";

package/index.d.ts

@@ -1 +1 @@
-export * from 'floppy-disk/vanilla';
+export * from "./vanilla.ts";

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "floppy-disk",
-  "description": "Lightweight, simple, and powerful state management library",
+  "description": "Lightweight unified state management for sync and async data.",
   "private": false,
-  "version": "3.1.0",
+  "version": "3.1.1",
   "keywords": [
     "utilities",
     "store",

package/react/create-mutation.d.ts

@@ -1,4 +1,4 @@
-import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
+import { type InitStoreOptions, type SetState } from "../vanilla.ts";
 /**
  * Represents the state of a mutation.
  *
@@ -17,7 +17,7 @@ import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
 export type MutationState<TData, TVariable, TError> = {
     isPending: boolean;
 } & ({
-    state: 'INITIAL';
+    state: "INITIAL";
     isSuccess: false;
     isError: false;
     variable: undefined;
@@ -26,7 +26,7 @@ export type MutationState<TData, TVariable, TError> = {
     error: undefined;
     errorUpdatedAt: undefined;
 } | {
-    state: 'SUCCESS';
+    state: "SUCCESS";
     isSuccess: true;
     isError: false;
     variable: TVariable;
@@ -35,7 +35,7 @@ export type MutationState<TData, TVariable, TError> = {
     error: undefined;
     errorUpdatedAt: undefined;
 } | {
-    state: 'ERROR';
+    state: "ERROR";
     isSuccess: false;
     isError: true;
     variable: TVariable;

package/react/create-query.d.ts

@@ -1,4 +1,4 @@
-import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
+import { type InitStoreOptions, type SetState } from "../vanilla.ts";
 /**
  * Represents the state of a query.
  *
@@ -25,7 +25,7 @@ export type QueryState<TData, TError> = {
     isRetrying: boolean;
     retryCount: number;
 } & ({
-    state: 'INITIAL';
+    state: "INITIAL";
     isSuccess: false;
     isError: false;
     data: undefined;
@@ -33,7 +33,7 @@ export type QueryState<TData, TError> = {
     error: undefined;
     errorUpdatedAt: undefined;
 } | {
-    state: 'SUCCESS';
+    state: "SUCCESS";
     isSuccess: true;
     isError: false;
     data: TData;
@@ -41,7 +41,7 @@ export type QueryState<TData, TError> = {
     error: undefined;
     errorUpdatedAt: undefined;
 } | {
-    state: 'ERROR';
+    state: "ERROR";
     isSuccess: false;
     isError: true;
     data: undefined;
@@ -49,7 +49,7 @@ export type QueryState<TData, TError> = {
     error: TError;
     errorUpdatedAt: number;
 } | {
-    state: 'SUCCESS_BUT_REVALIDATION_ERROR';
+    state: "SUCCESS_BUT_REVALIDATION_ERROR";
     isSuccess: true;
     isError: false;
     data: TData;

package/react/create-store.d.ts

@@ -1,4 +1,4 @@
-import { type InitStoreOptions } from 'floppy-disk/vanilla';
+import { type InitStoreOptions } from "../vanilla.ts";
 /**
  * Creates a single store with a bound React hook.
  *

package/react/create-stores.d.ts

@@ -1,4 +1,4 @@
-import { type InitStoreOptions } from 'floppy-disk/vanilla';
+import { type InitStoreOptions } from "../vanilla.ts";
 /**
  * Creates a factory for multiple stores identified by a key.
  *

package/react/use-isomorphic-layout-effect.d.ts

@@ -1,4 +1,4 @@
-import { useLayoutEffect } from 'react';
+import { useLayoutEffect } from "react";
 /**
  * Does exactly same as `useLayoutEffect`.\
  * It will use `useEffect` in **server-side** to prevent warning when executed on server-side.

package/react/use-mutation.d.ts

@@ -1,4 +1,4 @@
-import { type MutationOptions, type MutationState } from './create-mutation';
+import { type MutationOptions, type MutationState } from "./create-mutation.ts";
 /**
  * A hook for managing async mutation state.
  *

package/react/use-store.d.ts

@@ -1,4 +1,4 @@
-import { type StoreApi } from 'floppy-disk/vanilla';
+import { type StoreApi } from "../vanilla.ts";
 type Path = Array<string | number | symbol>;
 export declare const getValueByPath: (obj: any, path: Path) => any;
 export declare const isPrefixPath: (candidatePrefix: Path, targetPath: Path) => boolean;

package/react.d.ts

@@ -1,7 +1,7 @@
-export * from './react/use-isomorphic-layout-effect';
-export { useStoreState } from './react/use-store';
-export * from './react/create-store';
-export * from './react/create-stores';
-export * from './react/create-query';
-export { createMutation, type MutationOptions, type MutationState, } from './react/create-mutation';
-export * from './react/use-mutation';
+export * from "./react/use-isomorphic-layout-effect.ts";
+export { useStoreState } from "./react/use-store.ts";
+export * from "./react/create-store.ts";
+export * from "./react/create-stores.ts";
+export * from "./react/create-query.ts";
+export { createMutation, type MutationOptions, type MutationState, } from "./react/create-mutation.ts";
+export * from "./react/use-mutation.ts";

package/vanilla.d.ts

@@ -1,3 +1,3 @@
-export * from './vanilla/basic';
-export * from './vanilla/hash';
-export * from './vanilla/store';
+export * from "./vanilla/basic.ts";
+export * from "./vanilla/hash.ts";
+export * from "./vanilla/store.ts";