use-abcd 0.0.1 → 0.1.0

package/README.md

@@ -29,7 +29,7 @@ bun add use-abcd
 ## Quick Example
 
 ```typescript
-import { useCrud } from "use-crud";
+import { useCrud } from "use-abcd";
 
 type Todo = {
   id: string;
@@ -88,6 +88,8 @@ function TodoList() {
 }
 ```
 
+> **Note**: This is a single-file library with a focused scope. Please read the source code for a deeper understanding of its implementation and capabilities.
+
 ## License
 
 MIT

package/dist/useCrud.d.ts

@@ -28,8 +28,6 @@ export declare type CrudConfig<T extends Item = Item, C = any> = {
     getServerSnapshot?: () => StoreState<T>;
 };
 
-export declare function customLog(title?: string, ...messages: any[]): void;
-
 /**
  * Cache implementation for storing and managing fetch results
  * with configurable age and capacity limits.
@@ -54,14 +52,14 @@ export declare type FetchFn<T extends Item = Item> = (option: QueryOption) => Pr
 
 export declare type Item = {
     id: string;
-} & Record<string, unknown>;
+} & Record<string, any>;
 
 export declare type ItemWithState<T extends Item = Item> = {
     data: T;
-    state: "create" | "update" | "delete" | "idle" | "error";
+    state: TransitionStates;
     optimistic: boolean;
     errors: string[];
-    input?: T;
+    action?: [TransitionStates, T];
 };
 
 export declare type QueryOption = {
@@ -86,6 +84,8 @@ export declare type TransitionFn<T extends Item = Item> = (item: Partial<T>, opt
     id: string;
 }>;
 
+export declare type TransitionStates = "create" | "update" | "delete" | "idle" | "error" | "changed";
+
 export declare type Updater<T> = (updatable: T) => void;
 
 /**
@@ -101,18 +101,21 @@ export declare function useCrud<T extends Item = Item, C extends Record<string,
     items: {
         id: string;
         data: T;
-        state: "create" | "update" | "delete" | "idle" | "error";
+        state: TransitionStates;
         optimistic: boolean;
         errors: string[];
-        input?: T;
+        action?: [TransitionStates, T];
     }[];
     metadata: unknown;
     isLoading: boolean;
     hasError: boolean;
     errors: string[];
     create: (item: Omit<T, "id">) => void;
-    update: (item: T, updater: Updater<T>, isOptimistic?: boolean) => void;
-    remove: (item: T) => void;
+    update: (item: ItemWithState<T>, updater: Updater<T>, isOptimistic?: boolean) => void;
+    change: (item: ItemWithState<T>, updater: Updater<T>) => void;
+    retry: (item: ItemWithState<T>) => void;
+    save: (item: ItemWithState<T>) => void;
+    remove: (item: ItemWithState<T>) => void;
     cancelFetch: () => void;
     cancelOperation: (id: string) => void;
 };
@@ -128,8 +131,11 @@ export declare function useCrudOperations<T extends Item = Item, C extends Recor
     fetch: () => void;
     refetch: () => void;
     create: (item: Omit<T, "id">) => void;
-    update: (item: T, updater: Updater<T>, isOptimistic?: boolean) => void;
-    remove: (item: T) => void;
+    update: (item: ItemWithState<T>, updater: Updater<T>, isOptimistic?: boolean) => void;
+    change: (item: ItemWithState<T>, updater: Updater<T>) => void;
+    save: (item: ItemWithState<T>) => void;
+    retry: (item: ItemWithState<T>) => void;
+    remove: (item: ItemWithState<T>) => void;
     cancelFetch: () => void;
     cancelOperation: (id: string) => void;
 };