@kosdev-code/kos-ui-sdk 2.1.33 → 2.1.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kosdev-code/kos-ui-sdk",
-  "version": "2.1.33",
+  "version": "2.1.34",
   "type": "module",
   "main": "./index.cjs",
   "module": "./index.js",
@@ -36,7 +36,7 @@
   },
   "kos": {
     "build": {
-      "gitHash": "e05cb0b38c81d9ea95d719504f4afe4a6c8737bf"
+      "gitHash": "009439d0e2ae59f61a2144470b35aa46cfc002ed"
     }
   }
 }

package/ui/hooks/index.d.ts

@@ -27,5 +27,6 @@ export * from './use-press-gesture';
 export * from './use-project-reloading';
 export * from './use-region-time-props';
 export * from './use-time-props';
+export * from './view-model';
 export * from './with-project-reload';
 //# sourceMappingURL=index.d.ts.map

package/ui/hooks/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/ui/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,eAAe,CAAC;AACtD,cAAc,YAAY,CAAC;AAC3B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,OAAO,CAAC;AACtB,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC9D,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,SAAS,CAAC;AACxB,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAC1B,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/ui/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,eAAe,CAAC;AACtD,cAAc,YAAY,CAAC;AAC3B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,OAAO,CAAC;AACtB,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC9D,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,SAAS,CAAC;AACxB,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAC1B,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC"}

package/ui/hooks/view-model/index.d.ts

@@ -0,0 +1,2 @@
+export * from './use-view-model';
+//# sourceMappingURL=index.d.ts.map

package/ui/hooks/view-model/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/ui/hooks/view-model/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/ui/hooks/view-model/use-view-model.d.ts

@@ -0,0 +1,80 @@
+/// <reference types="react" />
+/**
+ * Configuration options for the useViewModel hook.
+ */
+export interface UseViewModelOptions {
+    /**
+     * When true, calls the ViewModel's dispose() method on unmount
+     * and when dependencies change causing recreation.
+     * Default: true (if dispose method exists)
+     */
+    disposeOnUnmount?: boolean;
+}
+/**
+ * Result returned by useViewModel when the ViewModel implements IKosViewModelReady.
+ */
+export interface UseViewModelResult<T> {
+    /** The ViewModel instance */
+    viewModel: T;
+    /** Whether the ViewModel's ready() hook has completed */
+    ready: boolean;
+    /** Error from the ready() hook, if any */
+    error: Error | undefined;
+}
+/**
+ * React hook for creating and managing ViewModel instances.
+ *
+ * The hook:
+ * - Creates the ViewModel using the provided factory function
+ * - Calls ready() if the ViewModel implements IKosViewModelReady
+ * - Automatically calls dispose() on unmount (if the method exists)
+ * - Re-creates the ViewModel when dependencies change
+ * - Disposes the previous ViewModel when recreating
+ *
+ * @param factory - Function that creates the ViewModel instance
+ * @param deps - Dependency array (similar to useEffect/useMemo)
+ * @param options - Optional configuration
+ * @returns UseViewModelResult with viewModel, ready state, and error
+ *
+ * @example
+ * ```typescript
+ * // Basic usage (no ready hook)
+ * function Counter() {
+ *   const { viewModel: vm, ready } = useViewModel(() => new CounterViewModel(), []);
+ *
+ *   return (
+ *     <div>
+ *       <span>{vm.count}</span>
+ *       <button onClick={() => vm.increment()}>+</button>
+ *     </div>
+ *   );
+ * }
+ *
+ * // With ready hook for async initialization
+ * function OrderSummary({ orderId }: Props) {
+ *   const { model: order } = useKosModel<IOrderModel>({ modelId: orderId });
+ *   const { model: inventory } = useKosModel<IInventoryModel>({ modelId: 'inventory' });
+ *
+ *   const { viewModel: vm, ready, error } = useViewModel(
+ *     () => new OrderSummaryViewModel(order!, inventory!),
+ *     [order, inventory]
+ *   );
+ *
+ *   if (error) return <ErrorDisplay error={error} />;
+ *   if (!ready) return <Loading />;
+ *
+ *   return <div>Total: ${vm.total}</div>;
+ * }
+ *
+ * // Disable auto-disposal
+ * const { viewModel: vm } = useViewModel(
+ *   () => new MyViewModel(),
+ *   [],
+ *   { disposeOnUnmount: false }
+ * );
+ * ```
+ *
+ * @category KOS React Hook
+ */
+export declare function useViewModel<T>(factory: () => T, deps: React.DependencyList, options?: UseViewModelOptions): UseViewModelResult<T>;
+//# sourceMappingURL=use-view-model.d.ts.map

package/ui/hooks/view-model/use-view-model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-view-model.d.ts","sourceRoot":"","sources":["../../../../../../../packages/sdk/kos-ui-sdk/src/ui/hooks/view-model/use-view-model.ts"],"names":[],"mappings":";AAMA;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,6BAA6B;IAC7B,SAAS,EAAE,CAAC,CAAC;IACb,yDAAyD;IACzD,KAAK,EAAE,OAAO,CAAC;IACf,0CAA0C;IAC1C,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,OAAO,EAAE,MAAM,CAAC,EAChB,IAAI,EAAE,KAAK,CAAC,cAAc,EAC1B,OAAO,GAAE,mBAAwB,GAChC,kBAAkB,CAAC,CAAC,CAAC,CAoFvB"}