@kosdev-code/kos-ui-sdk 2.0.5 → 2.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kosdev-code/kos-ui-sdk",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "type": "module",
   "main": "./index.cjs",
   "module": "./index.js",
@@ -36,7 +36,7 @@
   },
   "kos": {
     "build": {
-      "gitHash": "609de03c7138d0851980c6120ed70b95bd33192b"
+      "gitHash": "3caa35fec5d055da290df0c4aa13813890ec98e3"
     }
   }
 }

package/ui/hooks/index.d.ts

@@ -15,6 +15,7 @@ export * from './use-config-bean';
 export * from './use-config-property';
 export * from './use-date-props';
 export * from './use-date-relative-prop';
+export * from './use-function-warmup';
 export * from './use-kos-date-formats';
 export * from './use-kos-model';
 export * from './use-kos-region-timezones';

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,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,uBAAuB,CAAC"}

package/ui/hooks/use-function-warmup.d.ts

@@ -0,0 +1,44 @@
+export type WarmupMarker = {
+    __warmup: true;
+};
+type Warmupable<T extends (arg?: any) => any> = (arg?: any | WarmupMarker) => ReturnType<T>;
+/**
+ * A React hook that warms up a given function by invoking it during an idle period
+ * or after a short timeout. This is useful for preloading or preparing expensive
+ * computations or resources in advance.
+ *
+ * @template T - The type of the function to be warmed up. It must accept an optional
+ * argument and return any value.
+ *
+ * @param fn - The function to be warmed up. It should handle a special warmup argument
+ * (`{ __warmup: true }`) gracefully, as this argument is passed during the warmup phase.
+ *
+ * @remarks
+ * - If the browser supports `requestIdleCallback`, the warmup function will be invoked
+ * during an idle period. Otherwise, it will fall back to using `setTimeout` with a
+ * 1-millisecond delay.
+ * - Any errors thrown during the warmup invocation are caught and ignored to ensure
+ * that the warmup process does not disrupt the application.
+ *
+ * @example
+ * ```tsx
+ * import { useFunctionWarmup } from './use-function-warmup';
+ *
+ * const expensiveFunction = (options?: { __warmup?: boolean }) => {
+ *   if (options?.__warmup) {
+ *     console.log('Warming up...');
+ *   } else {
+ *     console.log('Executing expensive function...');
+ *   }
+ * };
+ *
+ * function MyComponent() {
+ *   useFunctionWarmup(expensiveFunction);
+ *
+ *   return <div>My Component</div>;
+ * }
+ * ```
+ */
+export declare function useFunctionWarmup<T extends (arg?: any) => any>(fn: Warmupable<T>): void;
+export {};
+//# sourceMappingURL=use-function-warmup.d.ts.map

package/ui/hooks/use-function-warmup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-function-warmup.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/ui/hooks/use-function-warmup.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,YAAY,GAAG;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAC;AAG9C,KAAK,UAAU,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,IAAI,CAC9C,GAAG,CAAC,EAAE,GAAG,GAAG,YAAY,KACrB,UAAU,CAAC,CAAC,CAAC,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,EAC5D,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,QAiBlB"}