@tramvai/tokens-common 4.36.2 → 4.38.0

package/lib/cache.d.ts

@@ -1,4 +1,4 @@
-import type { Options } from '@tinkoff/lru-cache-nano';
+import type { CacheServerMetricsHandlers } from './cacheMetrics';
 /**
  * @description
  * Function for creating a new cache
@@ -10,20 +10,21 @@ export declare const CREATE_CACHE_TOKEN: CacheFactory & {
 };
 /**
  * @description
- * Function that us called on force cache clean up in the app
+ * Function that is called on force cache clean up in the app
  */
-export declare const REGISTER_CLEAR_CACHE_TOKEN: ((type: string) => void | Promise<void>) & {
+export declare const REGISTER_CLEAR_CACHE_TOKEN: ((type?: CacheType) => void | Promise<void>) & {
     __type?: "multi token" | undefined;
 };
 /**
  * @description
  * Force cleaning up all caches in the app
  */
-export declare const CLEAR_CACHE_TOKEN: ((type?: string) => Promise<void>) & {
+export declare const CLEAR_CACHE_TOKEN: ((type?: CacheType) => Promise<void | void[]>) & {
     __type?: "base token" | undefined;
 };
 export interface Cache<T = any> {
     get(key: string): T | undefined;
+    peek(key: string): T | undefined;
     set(key: string, value: T, options?: {
         ttl?: number;
     }): void;
@@ -36,11 +37,88 @@ export interface Cache<T = any> {
     load(arr: Array<[string, {
         value: T;
     }]>): void;
+    size: number;
 }
-export type CacheType = 'memory' | 'memory-lfu';
-export interface CacheOptionsByType<T> {
-    memory: [Options<string, T> | undefined] | [];
-    ['memory-lfu']: [Options<string, T> | undefined] | [];
-}
-export type CacheFactory = <T, Type extends CacheType = 'memory'>(type?: Type, ...args: CacheOptionsByType<T>[Type]) => Cache<T>;
+export declare const MEMORY_LRU = "memory";
+export declare const MEMORY_LFU = "memory-lfu";
+export type CacheType = typeof MEMORY_LRU | typeof MEMORY_LFU;
+export type CacheMethod = keyof {
+    [M in keyof Cache as Cache[M] extends Function ? M : never]: any;
+};
+type CacheWithMetricsOptions = {
+    /** Cache metrics label */
+    name?: string;
+};
+type LRUOptions = {
+    /**
+     * The number of most recently used items to keep.
+     * Note that we may store fewer items than this if maxSize is hit.
+     */
+    max?: number;
+    /**
+     * Max time to live for items before they are considered stale.
+     * Note that stale items are NOT preemptively removed by default,
+     * and MAY live in the cache, contributing to its LRU max, long after
+     * they have expired.
+     *
+     * Also, as this cache is optimized for LRU/MRU operations, some of
+     * the staleness/TTL checks will reduce performance, as they will incur
+     * overhead by deleting items.
+     *
+     * Must be a positive integer in ms, defaults to 0, which means "no TTL"
+     *
+     * @default 0
+     */
+    ttl?: number;
+    /**
+     * Minimum amount of time in ms in which to check for staleness.
+     * Defaults to 1, which means that the current time is checked
+     * at most once per millisecond.
+     *
+     * Set to 0 to check the current time every time staleness is tested.
+     *
+     * Note that setting this to a higher value will improve performance
+     * somewhat while using ttl tracking, albeit at the expense of keeping
+     * stale items around a bit longer than intended.
+     *
+     * @default 1
+     */
+    ttlResolution?: number;
+    /**
+     * Return stale items from cache.get() before disposing of them
+     *
+     * @default false
+     */
+    allowStale?: boolean;
+    /**
+     * Update the age of items on cache.get(), renewing their TTL
+     *
+     * @default false
+     */
+    updateAgeOnGet?: boolean;
+};
+type LFUOptions = {
+    /**
+     * Specifies the maximum number item to accumulate in the cache. Defaults to 100
+     */
+    max?: number;
+    /**
+     * Specifies the number of items to be evicted once the cache is full.
+     * If options.max is specified and options.evictCount is not specified,
+     * then it defaults to 10% of options.max else it defaults to 1
+     */
+    evictCount?: number;
+    /**
+     * Maximum time upto which the keys would be retained in the cache even when unused.
+     * Note that this time is in milliseconds(ms)
+     */
+    maxAge?: number;
+};
+export type CacheFactoryOptions<Type extends CacheType> = CacheWithMetricsOptions & (Type extends typeof MEMORY_LRU ? LRUOptions : Type extends typeof MEMORY_LFU ? LFUOptions : never);
+export type CacheOptions<Type extends CacheType> = CacheFactoryOptions<Type> & {
+    type: Type;
+    max: number;
+};
+export type CacheFactory = <T, Type extends CacheType = typeof MEMORY_LRU>(cacheType?: Type, options?: CacheFactoryOptions<Type>, metrics?: CacheServerMetricsHandlers) => Cache<T>;
+export {};
 //# sourceMappingURL=cache.d.ts.map

package/lib/cache.es.js

@@ -9,7 +9,7 @@ import { createToken } from '@tinkoff/dippy';
 const CREATE_CACHE_TOKEN = createToken('createCache');
 /**
  * @description
- * Function that us called on force cache clean up in the app
+ * Function that is called on force cache clean up in the app
  */
 const REGISTER_CLEAR_CACHE_TOKEN = createToken('registerClearCache', { multi: true });
 /**
@@ -17,5 +17,7 @@ const REGISTER_CLEAR_CACHE_TOKEN = createToken('registerClearCache', { multi: tr
  * Force cleaning up all caches in the app
  */
 const CLEAR_CACHE_TOKEN = createToken('clearCache');
+const MEMORY_LRU = 'memory';
+const MEMORY_LFU = 'memory-lfu';
 
-export { CLEAR_CACHE_TOKEN, CREATE_CACHE_TOKEN, REGISTER_CLEAR_CACHE_TOKEN };
+export { CLEAR_CACHE_TOKEN, CREATE_CACHE_TOKEN, MEMORY_LFU, MEMORY_LRU, REGISTER_CLEAR_CACHE_TOKEN };

package/lib/cache.js

@@ -13,7 +13,7 @@ var dippy = require('@tinkoff/dippy');
 const CREATE_CACHE_TOKEN = dippy.createToken('createCache');
 /**
  * @description
- * Function that us called on force cache clean up in the app
+ * Function that is called on force cache clean up in the app
  */
 const REGISTER_CLEAR_CACHE_TOKEN = dippy.createToken('registerClearCache', { multi: true });
 /**
@@ -21,7 +21,11 @@ const REGISTER_CLEAR_CACHE_TOKEN = dippy.createToken('registerClearCache', { mul
  * Force cleaning up all caches in the app
  */
 const CLEAR_CACHE_TOKEN = dippy.createToken('clearCache');
+const MEMORY_LRU = 'memory';
+const MEMORY_LFU = 'memory-lfu';
 
 exports.CLEAR_CACHE_TOKEN = CLEAR_CACHE_TOKEN;
 exports.CREATE_CACHE_TOKEN = CREATE_CACHE_TOKEN;
+exports.MEMORY_LFU = MEMORY_LFU;
+exports.MEMORY_LRU = MEMORY_LRU;
 exports.REGISTER_CLEAR_CACHE_TOKEN = REGISTER_CLEAR_CACHE_TOKEN;

package/lib/cacheMetrics.d.ts

@@ -0,0 +1,15 @@
+import type { CacheMethod } from './cache';
+/**
+ * @description
+ * Handlers for server cache metrics
+ */
+export declare const CACHE_METRICS_SERVER_TOKEN: CacheServerMetricsHandlers & {
+    __type?: "base token" | undefined;
+};
+export type CacheServerMetricsHandlers = {
+    onHit(name: string, method: CacheMethod): void;
+    onMiss(name: string, method: CacheMethod): void;
+    onMax(name: string, size: number): void;
+    onSize(name: string, size: number): void;
+};
+//# sourceMappingURL=cacheMetrics.d.ts.map

package/lib/cacheMetrics.es.js

@@ -0,0 +1,9 @@
+import { createToken } from '@tinkoff/dippy';
+
+/**
+ * @description
+ * Handlers for server cache metrics
+ */
+const CACHE_METRICS_SERVER_TOKEN = createToken('cacheMetricsServer');
+
+export { CACHE_METRICS_SERVER_TOKEN };

package/lib/cacheMetrics.js

@@ -0,0 +1,13 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var dippy = require('@tinkoff/dippy');
+
+/**
+ * @description
+ * Handlers for server cache metrics
+ */
+const CACHE_METRICS_SERVER_TOKEN = dippy.createToken('cacheMetricsServer');
+
+exports.CACHE_METRICS_SERVER_TOKEN = CACHE_METRICS_SERVER_TOKEN;

package/lib/index.d.ts

@@ -3,6 +3,7 @@ export * from './context';
 export * from './action';
 export * from './hook';
 export * from './pubsub';
+export * from './cacheMetrics';
 export * from './cache';
 export * from './componentRegistry';
 export * from './state';

package/lib/index.es.js

@@ -3,7 +3,8 @@ export { CONTEXT_TOKEN } from './context.es.js';
 export { ACTION_CONDITIONALS, ACTION_EXECUTION_TOKEN, ACTION_PAGE_RUNNER_TOKEN, ACTION_REGISTRY_TOKEN, DEFERRED_ACTIONS_MAP_TOKEN, LIMIT_ACTION_GLOBAL_TIME_RUN } from './action.es.js';
 export { HOOK_TOKEN } from './hook.es.js';
 export { PUBSUB_FACTORY_TOKEN, PUBSUB_TOKEN, ROOT_PUBSUB_TOKEN } from './pubsub.es.js';
-export { CLEAR_CACHE_TOKEN, CREATE_CACHE_TOKEN, REGISTER_CLEAR_CACHE_TOKEN } from './cache.es.js';
+export { CACHE_METRICS_SERVER_TOKEN } from './cacheMetrics.es.js';
+export { CLEAR_CACHE_TOKEN, CREATE_CACHE_TOKEN, MEMORY_LFU, MEMORY_LRU, REGISTER_CLEAR_CACHE_TOKEN } from './cache.es.js';
 export { COMPONENT_REGISTRY_TOKEN } from './componentRegistry.es.js';
 export { COMBINE_REDUCERS, DISPATCHER_CONTEXT_TOKEN, DISPATCHER_TOKEN, INITIAL_APP_STATE_TOKEN, STORE_MIDDLEWARE, STORE_TOKEN } from './state.es.js';
 export { LOGGER_INIT_HOOK, LOGGER_REMOTE_REPORTER, LOGGER_SHARED_CONTEXT, LOGGER_TOKEN } from './logger.es.js';

package/lib/index.js

@@ -7,6 +7,7 @@ var context = require('./context.js');
 var action = require('./action.js');
 var hook = require('./hook.js');
 var pubsub = require('./pubsub.js');
+var cacheMetrics = require('./cacheMetrics.js');
 var cache = require('./cache.js');
 var componentRegistry = require('./componentRegistry.js');
 var state = require('./state.js');
@@ -32,8 +33,11 @@ exports.HOOK_TOKEN = hook.HOOK_TOKEN;
 exports.PUBSUB_FACTORY_TOKEN = pubsub.PUBSUB_FACTORY_TOKEN;
 exports.PUBSUB_TOKEN = pubsub.PUBSUB_TOKEN;
 exports.ROOT_PUBSUB_TOKEN = pubsub.ROOT_PUBSUB_TOKEN;
+exports.CACHE_METRICS_SERVER_TOKEN = cacheMetrics.CACHE_METRICS_SERVER_TOKEN;
 exports.CLEAR_CACHE_TOKEN = cache.CLEAR_CACHE_TOKEN;
 exports.CREATE_CACHE_TOKEN = cache.CREATE_CACHE_TOKEN;
+exports.MEMORY_LFU = cache.MEMORY_LFU;
+exports.MEMORY_LRU = cache.MEMORY_LRU;
 exports.REGISTER_CLEAR_CACHE_TOKEN = cache.REGISTER_CLEAR_CACHE_TOKEN;
 exports.COMPONENT_REGISTRY_TOKEN = componentRegistry.COMPONENT_REGISTRY_TOKEN;
 exports.COMBINE_REDUCERS = state.COMBINE_REDUCERS;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/tokens-common",
-  "version": "4.36.2",
+  "version": "4.38.0",
   "description": "Tramvai tokens for @tramvai/module-common",
   "main": "lib/index.js",
   "module": "lib/index.es.js",
@@ -18,15 +18,14 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@tinkoff/lru-cache-nano": "^7.9.0",
     "@tinkoff/url": "0.10.1",
-    "@tramvai/react": "4.36.2",
-    "@tramvai/tokens-core": "4.36.2"
+    "@tramvai/react": "4.38.0",
+    "@tramvai/tokens-core": "4.38.0"
   },
   "peerDependencies": {
     "@tinkoff/dippy": "0.10.8",
     "@tinkoff/logger": "0.10.277",
-    "@tramvai/types-actions-state-context": "4.36.2",
+    "@tramvai/types-actions-state-context": "4.38.0",
     "react": ">=16.8",
     "tslib": "^2.4.0"
   },