jordy 0.19.0 → 0.20.0

package/esm5/cache/cache.js

@@ -0,0 +1,27 @@
+import { __awaiter, __generator } from "tslib";
+import { createStorage } from '../storage/createStorage.factory';
+import { createCacheKey } from './createCacheKey';
+export function cache(_a) {
+    var key = _a.key, _b = _a.type, type = _b === void 0 ? 'session' : _b, expired = _a.expired, fetcher = _a.fetcher;
+    var resultFetcher = function fetcherProxy(params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var sto, cachedData, newResult;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        sto = createStorage(type, createCacheKey(key, params), expired);
+                        cachedData = sto.get();
+                        if (cachedData) {
+                            return [2, cachedData];
+                        }
+                        return [4, fetcher(params)];
+                    case 1:
+                        newResult = _a.sent();
+                        sto.set(newResult);
+                        return [2, newResult];
+                }
+            });
+        });
+    };
+    return resultFetcher;
+}

package/esm5/cache/cache.type.js

@@ -0,0 +1 @@
+export {};

package/esm5/cache/clearAllCachesExceptBy.js

@@ -0,0 +1,37 @@
+import { memoryStorage } from '../storage/memoryStorage';
+var findRelatedKeyCurried = function (key) { return function (keyword) {
+    return key.indexOf(keyword) >= 0;
+}; };
+function findAllKeysExcepts(sto, keywords) {
+    var key = null;
+    var keyList = [];
+    var len = sto.length;
+    for (var keyIdx = 0; keyIdx < len; keyIdx++) {
+        key = sto.key(keyIdx);
+        if (key && !keywords.find(findRelatedKeyCurried(key))) {
+            keyList.push(key);
+        }
+    }
+    return keyList;
+}
+function getStorage(type) {
+    if (type === 'session') {
+        return sessionStorage;
+    }
+    if (type === 'local') {
+        return localStorage;
+    }
+    return memoryStorage;
+}
+export function clearAllCachesExceptBy(type, keywords, storageGetter) {
+    if (storageGetter === void 0) { storageGetter = getStorage; }
+    var sto = storageGetter(type);
+    var keyList = findAllKeysExcepts(sto, keywords);
+    if (keyList.length === 0) {
+        return 0;
+    }
+    for (var index = 0; index < keyList.length; index++) {
+        sto.removeItem(keyList[index]);
+    }
+    return keyList.length;
+}

package/esm5/{queries/utils → cache}/clearCacheByKeyword.js

@@ -1,4 +1,4 @@
-import { memoryStorage } from '../../storage';
+import { memoryStorage } from '../storage/memoryStorage';
 function getStorage(type) {
     if (type === 'session') {
         return sessionStorage;

package/esm5/{queries/utils → cache}/createCacheKey.js

@@ -1,4 +1,4 @@
-import { isNumber, isObject, isString } from '../../util';
+import { isNumber, isObject, isString } from '../util';
 export function createCacheKey(key, params, subKeys) {
     if (isObject(params)) {
         var appendedValues = void 0;

package/esm5/cache/index.js

@@ -0,0 +1,5 @@
+export * from './cache';
+export * from './cache.type';
+export * from './clearAllCachesExceptBy';
+export * from './clearCacheByKeyword';
+export * from './createCacheKey';

package/esm5/hooks/index.js

@@ -1,4 +1,5 @@
 export * from './useDebounce';
+export * from './useMakeDeps';
+export * from './useNavigate';
 export * from './useQueryParams';
 export * from './useThrottle';
-export * from './useNavigate';

package/esm5/index.js

@@ -1,6 +1,6 @@
 import { DeviceDetectProvider, withAdaptiveRender, useIsMobile, useIsTablet, useIsNative, } from './adaptive-render';
-import { cache } from './proxies';
 import { useRouteSystem } from './route-system';
+export * from './cache';
 export * from './http-api';
 export * from './hooks';
 export * from './queries';
@@ -9,4 +9,4 @@ export * from './types';
 export * from './util';
 export * from './jwt';
 export * from './validate';
-export { DeviceDetectProvider, withAdaptiveRender, useIsMobile, useIsTablet, useIsNative, cache, useRouteSystem, };
+export { DeviceDetectProvider, withAdaptiveRender, useIsMobile, useIsTablet, useIsNative, useRouteSystem, };

package/esm5/queries/buildQueryCreator.js

@@ -1,8 +1,8 @@
 import { __awaiter, __generator, __read, __spreadArray } from "tslib";
+import { createCacheKey, clearCacheByKeyword } from '../cache';
 import { useCallback, useLayoutEffect, useRef, useState } from 'react';
 import { createStorage } from '../storage';
-import { useMakeDeps } from './useMakeDeps';
-import { clearCacheByKeyword, createCacheKey } from './utils';
+import { useMakeDeps } from '../hooks/useMakeDeps';
 function defConverter(args) {
     return args;
 }

package/esm5/storage/index.js

@@ -4,7 +4,7 @@ export * from './MemorySimpleStorage';
 export * from './SimpleStorageAdapter';
 export * from './StorageTokenProvider';
 export * from './cookie';
-export * from './memoryStorage';
 export * from './createStorage.factory';
-export * from './storage.type';
 export * from './createTokenProvider.factory';
+export * from './memoryStorage';
+export * from './storage.type';

package/libs/cache/cache.d.ts

@@ -0,0 +1,27 @@
+import { CacheConfigDto } from './cache.type';
+/**
+ * 데이터를 가져오는 비동기 함수에 대해 그 결과값을 일정시간동안 캐싱하는 비동기 함수를 만든다.
+ *
+ * @example
+ * ```
+ * // 선언
+ * const cachedFetchJordyDashboard = cache({
+ *   key: 'jordy_dashboard',
+ *   type: 'memory',
+ *   expired: 60 * 3,
+ *   fetcher: repo.jordy.fetchDashboard,
+ * });
+ *
+ * // 사용
+ * async function main() {
+ *   const params = { date: Date.now(), page: 1 };
+ *   const result = await cachedFetchJordyDashboard(params);
+ *
+ *   console.log(result);
+ * }
+ * ```
+ *
+ * @param {CacheConfigDto} config 캐시 설정
+ * @returns 캐시 기능이 적용된 비동기 함수
+ */
+export declare function cache<R, P = void>({ key, type, expired, fetcher, }: CacheConfigDto<R, P>): (params: P) => Promise<R>;

package/libs/cache/cache.type.d.ts

@@ -0,0 +1,26 @@
+import { StorageType } from 'packages/storage/storage.type';
+export declare type LargeStorageType = Exclude<StorageType, 'cookie'>;
+export interface CacheConfigDto<R, P> {
+    /**
+     * 캐시 고유키
+     */
+    key: string;
+    /**
+     * 캐시 종류 선택.
+     *
+     * @default 'session'
+     */
+    type?: LargeStorageType;
+    /**
+     * 캐시 유효기간 설정. (seconds)
+     *
+     * 0 혹은 설정하지 않으면 기한이 없다.
+     *
+     * @default 0
+     */
+    expired?: number;
+    /**
+     * 데이터 가져오기를 실제 수행 할 함수.
+     */
+    fetcher: (params: P) => Promise<R>;
+}

package/libs/cache/clearAllCachesExceptBy.d.ts

@@ -0,0 +1,23 @@
+import { StorageKeyManager } from '../storage/storage.type';
+import { LargeStorageType } from './cache.type';
+declare function getStorage(type: LargeStorageType): StorageKeyManager;
+/**
+ * 제시된 키워드가 포함되지 않은 캐시들을 모두 제거한다.
+ *
+ * @example
+ * ```
+ * clearAllCachesExceptBy(
+ *   'local', // 로컬 스토리지 대상 예시
+ *   ['jordy', 'theson', 'lookpin'], // 삭제 시 제외할 키워드들
+ * );
+ * ```
+ *
+ * @param type 지울 대상. local or session or memory
+ * @param keywords 제외할 키워드
+ * @param storageGetter 대상이되는 스토리지 함수. 테스트 용도가 아니면 별도로 지정하지 않음.
+ * @returns 지워진 모든 캐시 개수
+ *
+ * @see clearCacheByKeyword - 지정된 키워드들에 한해서만 캐시를 지움.
+ */
+export declare function clearAllCachesExceptBy(type: LargeStorageType, keywords: string[], storageGetter?: typeof getStorage): number;
+export {};

package/libs/{queries/utils → cache}/clearCacheByKeyword.d.ts

@@ -1,5 +1,5 @@
-import { StorageKeyManager, StorageType } from '../../storage';
-declare type LargeStorageType = Exclude<StorageType, 'cookie'>;
+import { StorageKeyManager } from '../storage/storage.type';
+import { LargeStorageType } from './cache.type';
 declare function getStorage(type: LargeStorageType): StorageKeyManager;
 /**
  * 캐시를 제거한다.
@@ -8,7 +8,9 @@ declare function getStorage(type: LargeStorageType): StorageKeyManager;
  *
  * @param type 캐시 타입 (쿠키 제외)
  * @param keyword 삭제 대상이 되는 키워드
- * @returns
+ * @returns 지워진 캐시 개수
+ *
+ * @see clearAllCachesExceptBy - 지정된 키워드 외의 모든 캐시를 지움.
  */
 export declare function clearCacheByKeyword(type: LargeStorageType, keyword: string | string[], storageGetter?: typeof getStorage): number;
 export {};

package/libs/cache/createCacheKey.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 키와 파라미터를 조합하여 키값을 만든다.
+ *
+ * 이 함수는 각종 캐시 제어 기능에 쓰인다.
+ *
+ * @param key 기반이 되는 키값
+ * @param params 조합될 1차 파라미터값. 객체일 경우 그 키와 값을 직렬화 하여 사용, 아닐경우 그 값 자체로 사용.
+ * @param subKeys params 에서 사용될 키를 지정한다. 미 지정 시 params 의 모든 키를 대상으로 키값을 만든다.
+ * @returns
+ */
+export declare function createCacheKey<P>(key: string, params?: P, subKeys?: Array<keyof P>): string;

package/libs/cache/index.d.ts

@@ -0,0 +1,5 @@
+export * from './cache';
+export * from './cache.type';
+export * from './clearAllCachesExceptBy';
+export * from './clearCacheByKeyword';
+export * from './createCacheKey';

package/libs/hooks/index.d.ts

@@ -1,4 +1,5 @@
 export * from './useDebounce';
+export * from './useMakeDeps';
+export * from './useNavigate';
 export * from './useQueryParams';
 export * from './useThrottle';
-export * from './useNavigate';

package/libs/index.d.ts

@@ -1,6 +1,6 @@
 import { DeviceDetectProvider, withAdaptiveRender, useIsMobile, useIsTablet, useIsNative } from './adaptive-render';
-import { cache } from './proxies';
 import { ModuleRouteModel, useRouteSystem } from './route-system';
+export * from './cache';
 export * from './http-api';
 export * from './hooks';
 export * from './queries';
@@ -9,4 +9,4 @@ export * from './types';
 export * from './util';
 export * from './jwt';
 export * from './validate';
-export { ModuleRouteModel, DeviceDetectProvider, withAdaptiveRender, useIsMobile, useIsTablet, useIsNative, cache, useRouteSystem, };
+export { ModuleRouteModel, DeviceDetectProvider, withAdaptiveRender, useIsMobile, useIsTablet, useIsNative, useRouteSystem, };

package/libs/storage/index.d.ts

@@ -4,7 +4,7 @@ export * from './MemorySimpleStorage';
 export * from './SimpleStorageAdapter';
 export * from './StorageTokenProvider';
 export * from './cookie';
-export * from './memoryStorage';
 export * from './createStorage.factory';
-export * from './storage.type';
 export * from './createTokenProvider.factory';
+export * from './memoryStorage';
+export * from './storage.type';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jordy",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "typescript based frontend toolkit",
   "repository": {
     "type": "git",

package/esm5/proxies/cache.proxy.js

@@ -1,40 +0,0 @@
-import { __read, __spreadArray } from "tslib";
-import { createStorage } from '../storage';
-import { isServer } from '../util/envCheck';
-var FORCE_NOT_CACHE = false;
-function createKey(url, params) {
-    if (params) {
-        return "".concat(url, "-").concat(JSON.stringify(params));
-    }
-    return url;
-}
-export function cache(type, expiredTime) {
-    if (expiredTime === void 0) { expiredTime = 0; }
-    if (isServer() || FORCE_NOT_CACHE) {
-        return function (baseApi) {
-            return baseApi.get;
-        };
-    }
-    var cacheProxy = function (fn) {
-        return function (url, params) {
-            var storage = createStorage(type, createKey(url, params), expiredTime);
-            var value = storage.get();
-            if (value) {
-                return Promise.resolve(value);
-            }
-            return fn(url, params).then(function (data) {
-                storage.set(data);
-                return data;
-            });
-        };
-    };
-    return function (baseApi) {
-        return cacheProxy(function () {
-            var args = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args[_i] = arguments[_i];
-            }
-            return baseApi.get.apply(baseApi, __spreadArray([], __read(args), false));
-        });
-    };
-}

package/esm5/proxies/index.js

@@ -1 +0,0 @@
-export * from './cache.proxy';

package/esm5/queries/utils/index.js

@@ -1,2 +0,0 @@
-export * from './clearCacheByKeyword';
-export * from './createCacheKey';

package/libs/proxies/cache.proxy.d.ts

@@ -1,11 +0,0 @@
-import { HttpApi } from '../http-api';
-declare type CacheProxy = (baseApi: HttpApi) => <T extends string | string[] | Record<string, any>, P = void | Record<string, any>>(url: string, params?: P) => Promise<T>;
-declare type CacheType = 'local' | 'session' | 'memory';
-/**
- * 스토리지를 이용한 API 캐시를 적용한다.
- *
- * @param type local, session, memory 셋 중 하나. 기본 local.
- * @param expiredTime 캐시가 만료되는 시간(seconds). 0 이하면 무제한. 기본 0.
- */
-export declare function cache(type?: CacheType, expiredTime?: number): CacheProxy;
-export {};

package/libs/proxies/index.d.ts

@@ -1 +0,0 @@
-export * from './cache.proxy';

package/libs/queries/utils/createCacheKey.d.ts

@@ -1 +0,0 @@
-export declare function createCacheKey<P>(key: string, params?: P, subKeys?: Array<keyof P>): string;

package/libs/queries/utils/index.d.ts

@@ -1,2 +0,0 @@
-export * from './clearCacheByKeyword';
-export * from './createCacheKey';