@plyaz/types 1.12.3 → 1.12.4

package/dist/store/index.d.ts

@@ -1 +1 @@
-export {};
+export type * from "./types";

package/dist/store/types.d.ts

@@ -0,0 +1,83 @@
+import type { StateCreator } from 'zustand';
+import type { BaseErrorContext } from '../api';
+/**
+ * Represents the error state and actions available for managing global errors.
+ *
+ * @typedef {Object} ErrorSliceType
+ * @property {ReturnResponseType | null} error - The current error state, or `null` if no error exists.
+ * @property {(error: ReturnResponseType) => void} addError - Adds or updates the global error state.
+ * @property {() => void} clearError - Clears the current error from the store.
+ */
+type ErrorSeverity = 'critical' | 'error' | 'warning' | 'info';
+interface BaseError {
+    statusCode: number;
+    message: string;
+    timestamp: string;
+    type: string;
+    context?: BaseErrorContext;
+}
+export interface ErrorLogEntry {
+    id: string;
+    error: BaseError;
+    timestamp: string;
+    severity?: ErrorSeverity;
+    source?: string;
+    correlationId?: string;
+    dismissed?: boolean;
+    context?: Record<string, object>;
+}
+export interface ErrorOptions {
+    source?: string;
+    context?: Record<string, object>;
+    severity?: ErrorSeverity;
+    correlationId?: string;
+}
+export interface ErrorSliceType {
+    errors: ErrorLogEntry[];
+    maxErrors: number;
+    addError: (error: BaseError, options?: ErrorOptions) => void;
+    addErrors: (errors: BaseError[], options?: ErrorOptions) => void;
+    clearError: (errorId: string) => void;
+    clearErrors: (errorIds: string[]) => void;
+    clearErrorsByType: (type: string) => void;
+    clearErrorsBySeverity: (severity: ErrorSeverity) => void;
+    clearAll: () => void;
+    dismissError: (errorId: string) => void;
+    dismissErrors: (errorIds: string[]) => void;
+    dismissAll: () => void;
+    getLatestError: () => ErrorLogEntry | null;
+    getErrorsByType: (type: string) => ErrorLogEntry[];
+    getErrorsBySeverity: (severity: ErrorSeverity) => ErrorLogEntry[];
+    getErrorsBySource: (source: string) => ErrorLogEntry[];
+    getUndismissedErrors: () => ErrorLogEntry[];
+    getActiveErrors: () => ErrorLogEntry[];
+    hasActiveErrors: () => boolean;
+    getErrorCount: () => number;
+    getActiveErrorCount: () => number;
+}
+/**
+ * Base Zustand slice creator type.
+ *
+ * Used for slices **without** middleware such as `persist` or `immer`.
+ */
+export type BaseSliceCreator<T> = StateCreator<T>;
+type MiddlewareMutators = [never, unknown][];
+/**
+ * Zustand slice creator type for slices that use middleware
+ * like `persist` and `immer`.
+ *
+ * Note: You don't need to manually specify middleware type tuples
+ * (like `["zustand/persist", T]`) since Zustand automatically infers them.
+ */
+export type PersistentSliceCreator<T> = StateCreator<T, [
+], MiddlewareMutators, T>;
+/**
+ * Root store type that combines multiple Zustand slices.
+ *
+ * Currently includes only `ErrorSliceType`, but can later be extended
+ * to include other slices such as `AuthSliceType`, `UserSliceType`, etc.
+ *
+ * @typedef {ErrorSliceType} RootStore
+ */
+export type RootStore = ErrorSliceType;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.12.3",
+  "version": "1.12.4",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",
@@ -183,7 +183,8 @@
   "packageManager": "pnpm@10.11.0",
   "dependencies": {
     "pino": "^10.0.0",
-    "type-fest": "^4.41.0"
+    "type-fest": "^4.41.0",
+    "zustand": "^5.0.0"
   },
   "devDependencies": {
     "@changesets/cli": "^2.29.5",