@sisense/sdk-ui 1.6.0 → 1.7.1

package/dist/utils/create-cache.d.ts

@@ -0,0 +1,33 @@
+export type CacheKey = string;
+/**
+ * Function to create cache key from params of the async function you want to cache
+ */
+export type CreateCacheKeyFn<AsyncFnToCache extends AsyncFn> = (...params: Parameters<AsyncFnToCache>) => CacheKey;
+type AsyncFn = (...params: any[]) => Promise<any>;
+export type CreateCacheFn = <AsyncFnToCache extends AsyncFn>(createCacheKey: CreateCacheKeyFn<AsyncFnToCache>, options?: CacheOptions) => {
+    withCache: (fn: AsyncFnToCache) => AsyncFnToCache;
+    clearCache: (specificKey?: CacheKey) => void;
+};
+type CacheOptions = {
+    cacheMaxSize?: number;
+};
+/**
+ * Universal cache creator for any async function
+ *
+ * @param createCacheKey - function to create cache key from params of the async function you want to cache
+ * @param options - optional object with cache options
+ * @returns - object with two methods: withCache and clearCache.
+ * "withCache" is a function that wraps the async function you want to cache.
+ * "clearCache" is a function to clear the cache.
+ *
+ * @example
+ * const myAsyncFn = async (a: number, b: number) => a + b;
+ *
+ * // define here how to create cache-key for your function
+ * const createExecuteQueryCacheKey: CreateCacheKeyFn<typeof myAsyncFn> = (a, b) => `${a}+${b}`;
+ *
+ * const { withCache, clearCache } = createCache(createExecuteQueryCacheKey);
+ * const executeQueryWithCache = withCache(executeQuery);
+ */
+export declare const createCache: CreateCacheFn;
+export {};

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.6.0",
+  "version": "1.7.1",
   "type": "module",
   "exports": {
     ".": {
@@ -39,13 +39,13 @@
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "@mui/material": "^5.11.6",
-    "@sisense/sdk-common": "^1.6.0",
-    "@sisense/sdk-data": "^1.6.0",
-    "@sisense/sdk-pivot-client": "^1.6.0",
-    "@sisense/sdk-query-client": "^1.6.0",
-    "@sisense/sdk-rest-client": "^1.6.0",
-    "@sisense/sdk-tracking": "^1.6.0",
-    "@sisense/sisense-charts": "5.1.0-alpha-04052758.0",
+    "@sisense/sdk-common": "^1.7.1",
+    "@sisense/sdk-data": "^1.7.1",
+    "@sisense/sdk-pivot-client": "^1.7.1",
+    "@sisense/sdk-query-client": "^1.7.1",
+    "@sisense/sdk-rest-client": "^1.7.1",
+    "@sisense/sdk-tracking": "^1.7.1",
+    "@sisense/sisense-charts": "5.1.0-alpha-831b13b4.0",
     "@tanstack/react-query": "4.36.1",
     "classnames": "^2.3.2",
     "colorjs.io": "^0.4.3",