@plyaz/types 1.22.6 → 1.22.7

package/dist/core/frontend/types.d.ts

@@ -41,36 +41,28 @@ import type { CoreDomainServiceInstance, CoreServiceEntry } from '../init';
  *   selectedId: string | null;
  * }
  *
+ * // Extend CoreBaseFrontendStore - all CRUD methods included in base
  * interface MyStore extends CoreBaseFrontendStore<MyStoreData> {
  *   items: MyEntity[];
  *   selectedId: string | null;
  *   isLoading: boolean;
- *
- *   // Required by CoreBaseFrontendStore
- *   setData: (data: MyStoreData) => void;
- *   updateData: (data: Partial<MyStoreData>) => void;
- *   setLoading: (isLoading: boolean) => void;
- *
- *   // Domain-specific methods
- *   addItem: (item: MyEntity) => void;
- *   updateItem: (id: string, item: MyEntity) => void;
- *   removeItem: (id: string) => void;
  * }
  *
- * export const useMyStore = create<MyStore>((set) => ({
+ * export const useMyStore = create<MyStore>((set, get) => ({
  *   items: [],
  *   selectedId: null,
  *   isLoading: false,
  *
+ *   // CoreBaseFrontendStore methods
+ *   getData: () => ({ items: get().items, selectedId: get().selectedId }),
  *   setData: (data) => set({ items: data.items, selectedId: data.selectedId }),
  *   updateData: (data) => set((state) => ({ ...state, ...data })),
  *   setLoading: (isLoading) => set({ isLoading }),
- *
- *   addItem: (item) => set((state) => ({ items: [...state.items, item] })),
- *   updateItem: (id, item) => set((state) => ({
- *     items: state.items.map((i) => (i.id === id ? item : i)),
+ *   addData: (item) => set((state) => ({ items: [...state.items, item] })),
+ *   updateDataById: (id, item) => set((state) => ({
+ *     items: state.items.map((i) => i.id === id ? { ...i, ...item } : i),
  *   })),
- *   removeItem: (id) => set((state) => ({
+ *   removeData: (id) => set((state) => ({
  *     items: state.items.filter((i) => i.id !== id),
  *   })),
  * }));
@@ -79,8 +71,9 @@ import type { CoreDomainServiceInstance, CoreServiceEntry } from '../init';
  * ## Service Integration
  * Services automatically call these methods after successful operations:
  * - After `fetchAll()` → calls `setData()` with full dataset
- * - After `create()` → service calls custom `addItem()` in `afterCreate` hook
- * - After `update()` → service calls custom `updateItem()` in `afterUpdate` hook
+ * - After `create()` → calls `addData()` to append new item
+ * - After `update()` → calls `updateDataById()` to update specific item
+ * - After `delete()` → calls `removeData()` to remove item
  * - Before any operation → calls `setLoading(true)`
  * - After operation completes → calls `setLoading(false)`
  *
@@ -90,6 +83,20 @@ import type { CoreDomainServiceInstance, CoreServiceEntry } from '../init';
  * @see {@link BaseFrontendDomainService} for service implementation
  */
 export interface CoreBaseFrontendStore<TData = Record<string, unknown>> {
+    /**
+     * Get current store data.
+     *
+     * Used by services to read current state for operations like delete
+     * (filter out item) or optimistic updates.
+     *
+     * @returns Current data object
+     *
+     * @example
+     * ```typescript
+     * getData: () => ({ items: get().items, selectedId: get().selectedId })
+     * ```
+     */
+    getData?(): TData;
     /**
      * Set/replace all data in the store (full replacement).
      *
@@ -133,6 +140,55 @@ export interface CoreBaseFrontendStore<TData = Record<string, unknown>> {
      * ```
      */
     setLoading?(isLoading: boolean): void;
+    /**
+     * Add data to store (append to array).
+     *
+     * Called by services after successful create operations.
+     * Store implementation handles appending to the items array.
+     *
+     * @param item - Item to add
+     *
+     * @example
+     * ```typescript
+     * addData: (item) => set((state) => ({
+     *   items: [...state.items, item]
+     * }))
+     * ```
+     */
+    addData?(item: unknown): void;
+    /**
+     * Update data in store by ID.
+     *
+     * Called by services after successful update operations.
+     * Store implementation handles finding and updating the specific item.
+     *
+     * @param id - Item ID to update
+     * @param item - Updated item data
+     *
+     * @example
+     * ```typescript
+     * updateDataById: (id, item) => set((state) => ({
+     *   items: state.items.map((i) => i.id === id ? { ...i, ...item } : i)
+     * }))
+     * ```
+     */
+    updateDataById?(id: string, item: unknown): void;
+    /**
+     * Remove data from store by ID.
+     *
+     * Called by services after successful delete operations.
+     * Store implementation handles filtering out the item.
+     *
+     * @param id - Item ID to remove
+     *
+     * @example
+     * ```typescript
+     * removeData: (id) => set((state) => ({
+     *   items: state.items.filter((item) => item.id !== id)
+     * }))
+     * ```
+     */
+    removeData?(id: string): void;
 }
 /**
  * Fetcher function type for API operations
@@ -526,6 +582,61 @@ export interface CoreStoreHandlers<TData = Record<string, unknown>, TStore exten
      * ```
      */
     setLoading?: (store: TStore, isLoading: boolean) => void;
+    /**
+     * Custom handler for adding data to store.
+     *
+     * Replaces the default `store.addData(item)` call.
+     * Called during create operations.
+     *
+     * @param store - Store instance
+     * @param item - Item to add
+     *
+     * @example
+     * ```typescript
+     * addData: (store, item) => {
+     *   store.appendItem(item);
+     *   store.setLastCreated(item.id);
+     * }
+     * ```
+     */
+    addData?: (store: TStore, item: unknown) => void;
+    /**
+     * Custom handler for updating data by ID.
+     *
+     * Replaces the default `store.updateDataById(id, item)` call.
+     * Called during update operations.
+     *
+     * @param store - Store instance
+     * @param id - Item ID to update
+     * @param item - Updated item data
+     *
+     * @example
+     * ```typescript
+     * updateDataById: (store, id, item) => {
+     *   store.updateItemById(id, item);
+     *   store.setLastUpdated(id);
+     * }
+     * ```
+     */
+    updateDataById?: (store: TStore, id: string, item: unknown) => void;
+    /**
+     * Custom handler for removing data by ID.
+     *
+     * Replaces the default `store.removeData(id)` call.
+     * Called during delete operations.
+     *
+     * @param store - Store instance
+     * @param id - Item ID to remove
+     *
+     * @example
+     * ```typescript
+     * removeData: (store, id) => {
+     *   store.removeItemById(id);
+     *   store.clearSelection();
+     * }
+     * ```
+     */
+    removeData?: (store: TStore, id: string) => void;
 }
 /**
  * Configuration for frontend domain services

package/dist/examples/types.d.ts

@@ -123,17 +123,9 @@ export interface ExampleFrontendStoreState {
 }
 /**
  * Example frontend store actions.
- * Extends CoreBaseFrontendStore to ensure required methods are present.
+ * Extends CoreBaseFrontendStore which provides all CRUD methods.
  */
 export interface ExampleFrontendStoreActions extends CoreBaseFrontendStore<ExampleFrontendStoreData> {
-    /** Set items array */
-    setItems: (items: ExampleEntity[]) => void;
-    /** Add a single item */
-    addItem: (item: ExampleEntity) => void;
-    /** Update a single item */
-    updateItem: (id: string, updates: Partial<ExampleEntity>) => void;
-    /** Remove a single item */
-    removeItem: (id: string) => void;
     /** Select an item by ID */
     selectItem: (id: string | null) => void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.22.6",
+  "version": "1.22.7",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",