effector-storage 5.0.0 → 6.0.0

package/tools/index.js.flow

@@ -0,0 +1,101 @@
+/**
+ * Flowtype definitions for index
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+// see https://gist.github.com/thecotne/6e5969f4aaf8f253985ed36b30ac9fe0
+type $FlowGen$If<X: boolean, Then, Else = empty> = $Call<
+  ((true, Then, Else) => Then) & ((false, Then, Else) => Else),
+  X,
+  Then,
+  Else
+>
+
+type $FlowGen$Assignable<A, B> = $Call<
+  ((...r: [B]) => true) & ((...r: [A]) => false),
+  A
+>
+
+import { Store, Effect, Event } from 'effector'
+declare interface StorageAdapter {
+  <State>(
+    key: string,
+    update: (raw?: any) => any
+  ): {
+    get(raw?: any, ctx?: any): State | Promise<State>,
+    set(value: State, ctx?: any): void,
+    ...
+  };
+  keyArea?: any;
+  noop?: boolean;
+}
+declare interface StorageAdapterFactory<AdapterConfig> {
+  (config?: AdapterConfig): StorageAdapter;
+  factory: true;
+}
+declare function async<A: StorageAdapter | StorageAdapterFactory<any>>(
+  adapter: A
+): $FlowGen$If<
+  $FlowGen$Assignable<A, StorageAdapterFactory<T>>,
+  StorageAdapterFactory<T>,
+  StorageAdapter
+>
+declare function either<
+  A1: StorageAdapter | StorageAdapterFactory<any>,
+  A2: StorageAdapter | StorageAdapterFactory<any>
+>(
+  one: A1,
+  another: A2
+): $FlowGen$If<
+  $FlowGen$Assignable<A1, StorageAdapterFactory<T1>>,
+  $FlowGen$If<
+    $FlowGen$Assignable<A2, StorageAdapterFactory<T2>>,
+    StorageAdapterFactory<{ ...T1, ...T2 }>,
+    StorageAdapterFactory<T1>
+  >,
+  $FlowGen$If<
+    $FlowGen$Assignable<A2, StorageAdapterFactory<T2>>,
+    StorageAdapterFactory<T2>,
+    StorageAdapter
+  >
+>
+declare interface CacheAdapterInstance {
+  get: Effect<
+    {
+      key: string,
+      ...
+    },
+    {
+      value: mixed,
+      cachedAt: number,
+      ...
+    } | null
+  >;
+  set: Effect<
+    {
+      key: string,
+      value: mixed,
+      ...
+    },
+    void
+  >;
+  purge: Event<void>;
+  unset: Effect<
+    {
+      key: string,
+      ...
+    },
+    void
+  >;
+}
+declare type CacheAdapter = {
+  __: {
+    $instance: Store<CacheAdapterInstance>,
+    ...
+  },
+  ...
+} & CacheAdapterInstance
+declare function farcached(adapter: CacheAdapter, keyArea?: any): StorageAdapter
+declare export { async, either, farcached }

package/tools/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/tools/async.ts","../../src/tools/either.ts","../../src/tools/farcached.ts"],"sourcesContent":["import type { StorageAdapter, StorageAdapterFactory } from '../types'\n\n/**\n * Makes synchronous storage adapter asynchronous\n */\n\nexport function async<A extends StorageAdapter | StorageAdapterFactory<any>>(\n  adapter: A\n): A extends StorageAdapterFactory<infer T>\n  ? StorageAdapterFactory<T>\n  : StorageAdapter\n\nexport function async<T>(\n  adapterOrFactory: StorageAdapter | StorageAdapterFactory<T>\n): StorageAdapter | StorageAdapterFactory<T> {\n  const isFactory = 'factory' in adapterOrFactory\n\n  create.factory = true as const\n  function create(config?: T) {\n    const adapter = isFactory ? adapterOrFactory(config) : adapterOrFactory\n\n    const asyncAdapter: StorageAdapter = <State>(\n      key: string,\n      update: (raw?: any) => any\n    ) => {\n      const { get, set } = adapter<State>(key, update)\n      return {\n        get: (value: State) => Promise.resolve(value).then(get),\n        set: (value?: any) => Promise.resolve(value).then(set),\n      }\n    }\n\n    asyncAdapter.keyArea = adapter.keyArea\n    asyncAdapter.noop = adapter.noop\n    return asyncAdapter\n  }\n\n  return isFactory ? create : create()\n}\n","import type { StorageAdapter, StorageAdapterFactory } from '../types'\n\n/**\n * Returns first adapter, if it is not noop, and second otherwise.\n *\n * In this example,\n *  - adapter for localStorage will be used in browser environment,\n *  - logging adapter will be used in node environment\n *\n * persist({\n *   store: $store,\n *   adapter: either(local(), log()),\n *   key: 'store'\n * })\n *\n * could be also used with factories\n *\n * persist({\n *   store: $store,\n *   adapter: either(local, log),\n *   key: 'store'\n * })\n *\n * or even mixed\n *\n * persist({\n *   store: $store,\n *   adapter: either(local, log()),\n *   key: 'store'\n * })\n */\n\nexport function either<\n  A1 extends StorageAdapter | StorageAdapterFactory<any>,\n  A2 extends StorageAdapter | StorageAdapterFactory<any>\n>(\n  one: A1,\n  another: A2\n): A1 extends StorageAdapterFactory<infer T1>\n  ? A2 extends StorageAdapterFactory<infer T2>\n    ? StorageAdapterFactory<T1 & T2>\n    : StorageAdapterFactory<T1>\n  : A2 extends StorageAdapterFactory<infer T2>\n  ? StorageAdapterFactory<T2>\n  : StorageAdapter\n\nexport function either<T1, T2>(\n  one: StorageAdapter | StorageAdapterFactory<T1>,\n  another: StorageAdapter | StorageAdapterFactory<T2>\n): StorageAdapter | StorageAdapterFactory<T1 & T2> {\n  const isFactory1 = 'factory' in one\n  const isFactory2 = 'factory' in another\n\n  create.factory = true as const\n  function create(config?: T1 & T2) {\n    const adapter1 = isFactory1 ? one(config) : one\n    const adapter2 = isFactory2 ? another(config) : another\n    return adapter1.noop ? adapter2 : adapter1\n  }\n\n  return isFactory1 || isFactory2 ? create : create()\n}\n","import type { StorageAdapter } from '../types'\nimport type { CacheAdapter } from '@farfetched/core'\nimport { attach } from 'effector'\n\n/**\n * Wraps @farfetched/core cache adapter to be used as `persist` adapter :)\n * @see https://farfetched.pages.dev/api/operators/cache.html\n *\n * persist({\n *   store: $store,\n *   adapter: farcached(localStorageCache({ maxAge: '15m' })),\n *   key: 'store'\n * })\n *\n * Out of the box Farfetched provides 4 cache adapters:\n * - `inMemoryCache`\n * - `sessionStorageCache`\n * - `localStorageCache`\n * - `voidCache` (this one is noop)\n *\n * From real usage point of view, using Farfetched cache adapters could be useful,\n * when you need logic for cache invalidation, because all of provided adapters\n * have `maxAge` option.\n *\n * Also, you could use Farfetched cache adapters to inject different\n * cache adapters with `fork` using `cache.__.$instance` internal store.\n * @see https://farfetched.pages.dev/recipes/server_cache.html#inject-adapter\n */\n\nexport function farcached(\n  adapter: CacheAdapter,\n  keyArea?: any\n): StorageAdapter {\n  const farfetchedAdapter: StorageAdapter = <State>(key: string) => {\n    return {\n      get: attach({\n        source: adapter.__.$instance,\n        async effect(instance: CacheAdapter) {\n          const persisted = await instance.get({ key })\n          return persisted?.value as State\n        },\n      } as any),\n      set: attach({\n        source: adapter.__.$instance,\n        async effect(instance: CacheAdapter, value?: any) {\n          return instance.set({ key, value })\n        },\n      } as any),\n    }\n  }\n\n  farfetchedAdapter.keyArea = keyArea ?? adapter\n  return farfetchedAdapter\n}\n"],"names":["async","adapterOrFactory","isFactory","create","config","adapter","asyncAdapter","key","update","get","set","value","Promise","resolve","then","keyArea","noop","factory","either","one","another","isFactory1","isFactory2","adapter1","adapter2","farcached","farfetchedAdapter","attach","source","__","$instance","instance","persisted","effect"],"mappings":"kCAYO,SAASA,EACdC,GAEA,IAAMC,EAAY,YAAaD,EAG/B,SAASE,EAAOC,GACd,IAAMC,EAAUH,EAAYD,EAAiBG,GAAUH,EAEjDK,EAA+BA,CACnCC,EACAC,KAEA,IAAMC,IAAEA,EAAGC,IAAEA,GAAQL,EAAeE,EAAKC,GACzC,MAAO,CACLC,IAAME,GAAiBC,QAAQC,QAAQF,GAAOG,KAAKL,GACnDC,IAAMC,GAAgBC,QAAQC,QAAQF,GAAOG,KAAKJ,GACnD,EAKH,OAFAJ,EAAaS,QAAUV,EAAQU,QAC/BT,EAAaU,KAAOX,EAAQW,KACrBV,CACT,CAEA,OApBAH,EAAOc,SAAU,EAoBVf,EAAYC,EAASA,GAC9B,CCQO,SAASe,EACdC,EACAC,GAEA,IAAMC,EAAa,YAAaF,EAC1BG,EAAa,YAAaF,EAGhC,SAASjB,EAAOC,GACd,IAAMmB,EAAWF,EAAaF,EAAIf,GAAUe,EACtCK,EAAWF,EAAaF,EAAQhB,GAAUgB,EAChD,OAAOG,EAASP,KAAOQ,EAAWD,CACpC,CAEA,OAPApB,EAAOc,SAAU,EAOVI,GAAcC,EAAanB,EAASA,GAC7C,CChCO,SAASsB,EACdpB,EACAU,GAEA,IAAMW,EAA4CnB,IACzC,CACLE,IAAKkB,EAAO,CACVC,OAAQvB,EAAQwB,GAAGC,UACnB9B,aAAa+B,GACX,IAAMC,QAAkBD,EAAStB,IAAI,CAAEF,QACvC,OAAOyB,GAAWrB,KACpB,IAEFD,IAAKiB,EAAO,CACVC,OAAQvB,EAAQwB,GAAGC,UACnB9B,OAAYiC,MAACF,EAAwBpB,IAC5BoB,EAASrB,IAAI,CAAEH,MAAKI,cAOnC,OADAe,EAAkBX,QAAUA,GAAWV,EAChCqB,CACT"}

package/tools/package.json

@@ -0,0 +1,8 @@
+{
+  "type": "module",
+  "sideEffects": false,
+  "main": "index.cjs",
+  "module": "index.js",
+  "react-native": "index.js",
+  "types": "index.d.ts"
+}