zustic 1.0.6 → 1.0.7

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026, DeveloperRejaul
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -2,7 +2,7 @@
 
 # Zustic
 
-### Lightweight State Management for Modern React Applications
+### Ultra-Lightweight State Management for Modern React Applications
 
 [![npm version](https://img.shields.io/npm/v/zustic.svg)](https://npm.im/zustic)
 [![npm downloads](https://img.shields.io/npm/dm/zustic.svg)](https://npm.im/zustic)

package/dist/index.d.mts

@@ -1,5 +1,75 @@
+/**
+ * Store creation function signature.
+ * Initializes store state and returns the initial state value.
+ *
+ * The function receives set and get utilities to manage state:
+ * - `set` updates partial state or via updater function
+ * - `get` retrieves current state
+ *
+ * @template T - Type of store state
+ *
+ * @example
+ * ```typescript
+ * type CounterState = {count: number; increment: () => void};
+ *
+ * const useCounter = create<CounterState>((set, get) => ({
+ *   count: 0,
+ *   increment: () => set({count: get().count + 1})
+ * }));
+ * ```
+ */
 type CreateParamsType<T> = (set: (partial: Partial<T> | ((state: T) => Partial<T>)) => void, get: () => T) => T;
+/**
+ * State update parameter type.
+ * Can be either a partial state object or an updater function.
+ * Provides flexibility for both shallow and computed updates.
+ *
+ * @template T - Type of store state
+ *
+ * @example
+ * ```typescript
+ * // Partial object update
+ * set({count: 5});
+ *
+ * // Updater function
+ * set((state) => ({count: state.count + 1}));
+ * ```
+ */
 type SetSateParams<T> = Partial<T> | ((state: T) => Partial<T>);
+/**
+ * Middleware function type for intercepting state updates.
+ * Follows higher-order function pattern for composability.
+ *
+ * Middlewares can:
+ * - Log state changes
+ * - Persist state to storage
+ * - Validate state updates
+ * - Handle side effects
+ *
+ * @template T - Type of store state
+ *
+ * @example
+ * ```typescript
+ * // Logger middleware
+ * const logger: Middleware<CounterState> = (set, get) => (next) => (partial) => {
+ *   console.log('Updating from:', get());
+ *   next(partial);
+ *   console.log('Updated to:', get());
+ * };
+ *
+ * // Persistence middleware
+ * const persist: Middleware<CounterState> = (set, get) => (next) => (partial) => {
+ *   next(partial);
+ *   localStorage.setItem('state', JSON.stringify(get()));
+ * };
+ *
+ * // Use with store
+ * const useCounter = create(
+ *   (set, get) => ({count: 0}),
+ *   compose(logger, persist)
+ * );
+ * ```
+ */
 type Middleware<T> = (set: (partial: SetSateParams<T>) => void, get: () => T) => (next: (partial: SetSateParams<T>) => void) => (partial: SetSateParams<T>) => void;
 
 /**

package/dist/index.d.ts

@@ -1,5 +1,75 @@
+/**
+ * Store creation function signature.
+ * Initializes store state and returns the initial state value.
+ *
+ * The function receives set and get utilities to manage state:
+ * - `set` updates partial state or via updater function
+ * - `get` retrieves current state
+ *
+ * @template T - Type of store state
+ *
+ * @example
+ * ```typescript
+ * type CounterState = {count: number; increment: () => void};
+ *
+ * const useCounter = create<CounterState>((set, get) => ({
+ *   count: 0,
+ *   increment: () => set({count: get().count + 1})
+ * }));
+ * ```
+ */
 type CreateParamsType<T> = (set: (partial: Partial<T> | ((state: T) => Partial<T>)) => void, get: () => T) => T;
+/**
+ * State update parameter type.
+ * Can be either a partial state object or an updater function.
+ * Provides flexibility for both shallow and computed updates.
+ *
+ * @template T - Type of store state
+ *
+ * @example
+ * ```typescript
+ * // Partial object update
+ * set({count: 5});
+ *
+ * // Updater function
+ * set((state) => ({count: state.count + 1}));
+ * ```
+ */
 type SetSateParams<T> = Partial<T> | ((state: T) => Partial<T>);
+/**
+ * Middleware function type for intercepting state updates.
+ * Follows higher-order function pattern for composability.
+ *
+ * Middlewares can:
+ * - Log state changes
+ * - Persist state to storage
+ * - Validate state updates
+ * - Handle side effects
+ *
+ * @template T - Type of store state
+ *
+ * @example
+ * ```typescript
+ * // Logger middleware
+ * const logger: Middleware<CounterState> = (set, get) => (next) => (partial) => {
+ *   console.log('Updating from:', get());
+ *   next(partial);
+ *   console.log('Updated to:', get());
+ * };
+ *
+ * // Persistence middleware
+ * const persist: Middleware<CounterState> = (set, get) => (next) => (partial) => {
+ *   next(partial);
+ *   localStorage.setItem('state', JSON.stringify(get()));
+ * };
+ *
+ * // Use with store
+ * const useCounter = create(
+ *   (set, get) => ({count: 0}),
+ *   compose(logger, persist)
+ * );
+ * ```
+ */
 type Middleware<T> = (set: (partial: SetSateParams<T>) => void, get: () => T) => (next: (partial: SetSateParams<T>) => void) => (partial: SetSateParams<T>) => void;
 
 /**