effector-storage 6.0.0 → 6.0.1

package/README.md

@@ -19,6 +19,7 @@ Small module for [Effector](https://github.com/effector/effector) ☄️ to sync
   - [with query string](#with-query-string)
   - [with React Native AsyncStorage](#with-react-native-asyncstorage)
   - [with React Native EncryptedStorage](#with-react-native-encryptedstorage)
+  - [extra adapters](#extra-adapters)
 - [Usage with domains](#usage-with-domains)
 - [Formulae](#formulae)
   - [Units](#units)
@@ -63,7 +64,7 @@ $ npm install --save effector-storage
 
 ### with `localStorage`
 
-Docs: [effector-storage/local](https://github.com/yumauri/effector-storage/tree/master/src/local/README.md)
+Docs: [effector-storage/local](https://github.com/yumauri/effector-storage/tree/main/src/local/README.md)
 
 ```javascript
 import { persist } from 'effector-storage/local'
@@ -79,7 +80,7 @@ Stores, persisted in `localStorage`, are automatically synced between two (or mo
 
 ### with `sessionStorage`
 
-Docs: [effector-storage/session](https://github.com/yumauri/effector-storage/tree/master/src/session/README.md)
+Docs: [effector-storage/session](https://github.com/yumauri/effector-storage/tree/main/src/session/README.md)
 
 Same as above, just import `persist` from `'effector-storage/session'`:
 
@@ -91,7 +92,7 @@ Stores, persisted in `sessionStorage`, are synced between instances, but not bet
 
 ### with query string
 
-Docs: [effector-storage/query](https://github.com/yumauri/effector-storage/tree/master/src/query/README.md)
+Docs: [effector-storage/query](https://github.com/yumauri/effector-storage/tree/main/src/query/README.md)
 
 You can _reflect_ plain string store value in query string parameter, using this adapter. Think of it like about synchronizing store value and query string parameter.
 
@@ -109,7 +110,9 @@ Use this only with plain string stores (`Store<string | null>`) to avoid strange
 
 ### with React Native AsyncStorage
 
-Docs: [effector-storage/rn/async](https://github.com/yumauri/effector-storage/tree/master/src/rn/async/README.md)
+❗️ Will be deprecated in next minor release and removed in next major release, in favor of [`@effector-storage/react-native-async-storage`](https://github.com/yumauri/effector-storage-extras/tree/main/packages/react-native-async-storage).
+
+Docs: [effector-storage/rn/async](https://github.com/yumauri/effector-storage/tree/main/src/rn/async/README.md)
 
 ```javascript
 import { persist } from 'effector-storage/rn/async'
@@ -125,7 +128,9 @@ persist({ store: $counter })
 
 ### with React Native EncryptedStorage
 
-Docs: [effector-storage/rn/encrypted](https://github.com/yumauri/effector-storage/tree/master/src/rn/encrypted/README.md)
+❗️ Will be deprecated in next minor release and removed in next major release, in favor of [`@effector-storage/react-native-encrypted-storage`](https://github.com/yumauri/effector-storage-extras/tree/main/packages/react-native-encrypted-storage).
+
+Docs: [effector-storage/rn/encrypted](https://github.com/yumauri/effector-storage/tree/main/src/rn/encrypted/README.md)
 
 ```javascript
 import { persist } from 'effector-storage/rn/encrypted'
@@ -139,6 +144,10 @@ persist({ store: $counter })
 
 ⚠️ Note, that [EncryptedStorage] is asynchronous (it is based on [AsyncStorage] actually).
 
+### extra adapters
+
+You can find a collection of useful adapters in [effector-storage-extras](https://github.com/yumauri/effector-storage-extras). That side repository was created in order to not bloat `effector-storage` with dependencies and adapters, which depends on other libraries.
+
 ## Usage with domains
 
 You can use `persist` inside Domain's `onCreateStore` hook:
@@ -250,14 +259,14 @@ persist({
 
 There are two gotchas with contracts:
 
-1. From `effector-storage` point of view it is absolutely normal, when there is no persisted value in the storage yet. So, `undefined` value is _always valid_, event if contract is not explicitly allows it.
-2. `effector-storage` does not validate data, which is written to the storage. But it will validate it nonetheless, after persisting, so, if you write invalid data to the storage, `fail` will be triggered, but data _will be_ persisted.
+1. From `effector-storage` point of view it is absolutely normal, when there is no persisted value in the storage yet. So, `undefined` value is _always valid_, even if contract does not explicitly allow it.
+2. `effector-storage` does not prevent persisting invalid data to the storage, but it will validate it nonetheless, after persisting, so, if you write invalid data to the storage, `fail` will be triggered, but data will be persisted.
 
 ### Notes
 
 Without specifying `pickup` property, calling `persist` will immediately call adapter to get initial value. In case of synchronous storage (like `localStorage` or `sessionStorage`) this action will synchronously set store value, and call `done`/`fail`/`finally` right away. You should take that into account, if you adds some logic on `done`, for example — place `persist` after that logic (see issue [#38](https://github.com/yumauri/effector-storage/issues/38) for more details).
 
-You can modify adapter to be asynchronous to mitigate this behavior with [`async`](https://github.com/yumauri/effector-storage/tree/master/src/tools/README.md#async) function.
+You can modify adapter to be asynchronous to mitigate this behavior with [`async`](https://github.com/yumauri/effector-storage/tree/main/src/tools/README.md#async) function.
 
 ## `createPersist` factory
 
@@ -316,7 +325,7 @@ Adapter is a function, which is called by the core `persist` function, and has f
 ```typescript
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any
@@ -342,7 +351,7 @@ In case it is omitted — adapter instances is used instead.
 
 #### noop
 
-Marks adapter as "no-op" for [`either`](https://github.com/yumauri/effector-storage/tree/master/src/tools/README.md#either) function.
+Marks adapter as "no-op" for [`either`](https://github.com/yumauri/effector-storage/tree/main/src/tools/README.md#either) function.
 
 ### Synchronous storage adapter example
 
@@ -550,11 +559,11 @@ Use this approach with caution, beware of infinite circular updates. To avoid th
 
 ## TODO
 
-- [x] [localStorage] support (docs: [effector-storage/local](https://github.com/yumauri/effector-storage/tree/master/src/local/README.md))
-- [x] [sessionStorage] support (docs: [effector-storage/session](https://github.com/yumauri/effector-storage/tree/master/src/session/README.md))
-- [x] [query string](https://developer.mozilla.org/en-US/docs/Web/API/Location/search) support (docs: [effector-storage/query](https://github.com/yumauri/effector-storage/tree/master/src/query/README.md))
-- [x] [AsyncStorage] support (docs: [effector-storage/rn/async](https://github.com/yumauri/effector-storage/tree/master/src/rn/async/README.md))
-- [x] [EncryptedStorage] support (docs: [effector-storage/rn/encrypted](https://github.com/yumauri/effector-storage/tree/master/src/rn/encrypted/README.md))
+- [x] [localStorage] support (docs: [effector-storage/local](https://github.com/yumauri/effector-storage/tree/main/src/local/README.md))
+- [x] [sessionStorage] support (docs: [effector-storage/session](https://github.com/yumauri/effector-storage/tree/main/src/session/README.md))
+- [x] [query string](https://developer.mozilla.org/en-US/docs/Web/API/Location/search) support (docs: [effector-storage/query](https://github.com/yumauri/effector-storage/tree/main/src/query/README.md))
+- [x] [AsyncStorage] support (docs: [effector-storage/rn/async](https://github.com/yumauri/effector-storage/tree/main/src/rn/async/README.md))
+- [x] [EncryptedStorage] support (docs: [effector-storage/rn/encrypted](https://github.com/yumauri/effector-storage/tree/main/src/rn/encrypted/README.md))
 - [ ] [IndexedDB] support
 - [ ] [Cookies] support
 - [ ] you name it support

package/async-storage/index.cjs.d.ts

@@ -1,6 +1,6 @@
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any

package/async-storage/index.d.ts

@@ -1,6 +1,6 @@
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any

package/async-storage/index.js.flow

@@ -10,7 +10,7 @@ declare interface StorageAdapter {
     key: string,
     update: (raw?: any) => any
   ): {
-    get(raw?: any, ctx?: any): State | Promise<State>,
+    get(raw?: any, ctx?: any): State | Promise<State | void> | void,
     set(value: State, ctx?: any): void,
     ...
   };

package/core/index.cjs.d.ts

@@ -2,7 +2,7 @@ import { Unit, Store, Event, Effect, Subscription } from 'effector'
 
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any

package/core/index.d.ts

@@ -2,7 +2,7 @@ import { Unit, Store, Event, Effect, Subscription } from 'effector'
 
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any

package/core/index.js.flow

@@ -11,7 +11,7 @@ declare interface StorageAdapter {
     key: string,
     update: (raw?: any) => any
   ): {
-    get(raw?: any, ctx?: any): State | Promise<State>,
+    get(raw?: any, ctx?: any): State | Promise<State | void> | void,
     set(value: State, ctx?: any): void,
     ...
   };

package/index.cjs.d.ts

@@ -11,7 +11,7 @@ export { async, either, farcached } from './tools'
 
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any
@@ -115,6 +115,7 @@ export {
   ConfigPersist,
   ConfigSourceTarget,
   ConfigStore,
+  Contract,
   Done,
   Fail,
   Finally,

package/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import type { ConfigPersist, Persist } from './types'\nimport { persist as base } from './core'\n\nexport type {\n  ConfigPersist,\n  ConfigSourceTarget,\n  ConfigStore,\n  Done,\n  Fail,\n  Finally,\n  Persist,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from './types'\n\n//\n// reexport adapters\n//\n\nexport type { AsyncStorageConfig } from './async-storage'\nexport type { LocalStorageConfig } from './local'\nexport type { LogConfig } from './log'\nexport type { MemoryConfig } from './memory'\nexport type { NilConfig } from './nil'\nexport type { QueryConfig } from './query'\nexport type { SessionStorageConfig } from './session'\nexport type { StorageConfig } from './storage'\n\nexport { asyncStorage } from './async-storage'\nexport { local } from './local'\nexport { log } from './log'\nexport { memory } from './memory'\nexport { nil } from './nil'\nexport { query } from './query'\nexport { session } from './session'\nexport { storage } from './storage'\n\n//\n// reexport tools\n//\n\nexport { async, either, farcached } from './tools'\n\n/**\n * Creates custom `persist`\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config: any) =>\n    base({\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default `persist`\n */\nexport const persist: Persist = base\n"],"names":["persist","base","defaults","config"],"mappings":"+UAyDaA,EAAmBC,EAAAA,0SAXzB,SAAuBC,GAC5B,OAAQC,GACNF,EAAAA,QAAK,IACAC,KACAC,GAET"}
+{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import type { ConfigPersist, Persist } from './types'\nimport { persist as base } from './core'\n\nexport type {\n  ConfigPersist,\n  ConfigSourceTarget,\n  ConfigStore,\n  Contract,\n  Done,\n  Fail,\n  Finally,\n  Persist,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from './types'\n\n//\n// reexport adapters\n//\n\nexport type { AsyncStorageConfig } from './async-storage'\nexport type { LocalStorageConfig } from './local'\nexport type { LogConfig } from './log'\nexport type { MemoryConfig } from './memory'\nexport type { NilConfig } from './nil'\nexport type { QueryConfig } from './query'\nexport type { SessionStorageConfig } from './session'\nexport type { StorageConfig } from './storage'\n\nexport { asyncStorage } from './async-storage'\nexport { local } from './local'\nexport { log } from './log'\nexport { memory } from './memory'\nexport { nil } from './nil'\nexport { query } from './query'\nexport { session } from './session'\nexport { storage } from './storage'\n\n//\n// reexport tools\n//\n\nexport { async, either, farcached } from './tools'\n\n/**\n * Creates custom `persist`\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config: any) =>\n    base({\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default `persist`\n */\nexport const persist: Persist = base\n"],"names":["persist","base","defaults","config"],"mappings":"+UA0DaA,EAAmBC,EAAAA,0SAXzB,SAAuBC,GAC5B,OAAQC,GACNF,EAAAA,QAAK,IACAC,KACAC,GAET"}

package/index.d.ts

@@ -11,7 +11,7 @@ export { async, either, farcached } from './tools'
 
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any
@@ -115,6 +115,7 @@ export {
   ConfigPersist,
   ConfigSourceTarget,
   ConfigStore,
+  Contract,
   Done,
   Fail,
   Finally,

package/index.js.flow

@@ -20,7 +20,7 @@ declare interface StorageAdapter {
     key: string,
     update: (raw?: any) => any
   ): {
-    get(raw?: any, ctx?: any): State | Promise<State>,
+    get(raw?: any, ctx?: any): State | Promise<State | void> | void,
     set(value: State, ctx?: any): void,
     ...
   };
@@ -134,6 +134,7 @@ declare export {
   ConfigPersist,
   ConfigSourceTarget,
   ConfigStore,
+  Contract,
   Done,
   Fail,
   Finally,

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import type { ConfigPersist, Persist } from './types'\nimport { persist as base } from './core'\n\nexport type {\n  ConfigPersist,\n  ConfigSourceTarget,\n  ConfigStore,\n  Done,\n  Fail,\n  Finally,\n  Persist,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from './types'\n\n//\n// reexport adapters\n//\n\nexport type { AsyncStorageConfig } from './async-storage'\nexport type { LocalStorageConfig } from './local'\nexport type { LogConfig } from './log'\nexport type { MemoryConfig } from './memory'\nexport type { NilConfig } from './nil'\nexport type { QueryConfig } from './query'\nexport type { SessionStorageConfig } from './session'\nexport type { StorageConfig } from './storage'\n\nexport { asyncStorage } from './async-storage'\nexport { local } from './local'\nexport { log } from './log'\nexport { memory } from './memory'\nexport { nil } from './nil'\nexport { query } from './query'\nexport { session } from './session'\nexport { storage } from './storage'\n\n//\n// reexport tools\n//\n\nexport { async, either, farcached } from './tools'\n\n/**\n * Creates custom `persist`\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config: any) =>\n    base({\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default `persist`\n */\nexport const persist: Persist = base\n"],"names":["createPersist","defaults","config","base","persist"],"mappings":"gZA8CO,SAASA,EAAcC,GAC5B,OAAQC,GACNC,EAAK,IACAF,KACAC,GAET,CAKO,IAAME,EAAmBD"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import type { ConfigPersist, Persist } from './types'\nimport { persist as base } from './core'\n\nexport type {\n  ConfigPersist,\n  ConfigSourceTarget,\n  ConfigStore,\n  Contract,\n  Done,\n  Fail,\n  Finally,\n  Persist,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from './types'\n\n//\n// reexport adapters\n//\n\nexport type { AsyncStorageConfig } from './async-storage'\nexport type { LocalStorageConfig } from './local'\nexport type { LogConfig } from './log'\nexport type { MemoryConfig } from './memory'\nexport type { NilConfig } from './nil'\nexport type { QueryConfig } from './query'\nexport type { SessionStorageConfig } from './session'\nexport type { StorageConfig } from './storage'\n\nexport { asyncStorage } from './async-storage'\nexport { local } from './local'\nexport { log } from './log'\nexport { memory } from './memory'\nexport { nil } from './nil'\nexport { query } from './query'\nexport { session } from './session'\nexport { storage } from './storage'\n\n//\n// reexport tools\n//\n\nexport { async, either, farcached } from './tools'\n\n/**\n * Creates custom `persist`\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config: any) =>\n    base({\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default `persist`\n */\nexport const persist: Persist = base\n"],"names":["createPersist","defaults","config","base","persist"],"mappings":"gZA+CO,SAASA,EAAcC,GAC5B,OAAQC,GACNC,EAAK,IACAF,KACAC,GAET,CAKO,IAAME,EAAmBD"}

package/local/index.cjs.d.ts

@@ -2,7 +2,7 @@ import { Unit, Store, Event, Effect, Subscription } from 'effector'
 
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any
@@ -62,6 +62,12 @@ interface ConfigJustSourceTarget<State> {
   source: Store<State> | Event<State> | Effect<State, any, any>
   target: Store<State> | Event<State> | Effect<State, any, any>
 }
+interface ConfigStore$1<State, Err = Error>
+  extends ConfigCommon<State, Err>,
+    ConfigJustStore<State> {}
+interface ConfigSourceTarget$1<State, Err = Error>
+  extends ConfigCommon<State, Err>,
+    ConfigJustSourceTarget<State> {}
 
 interface ConfigPersist extends ConfigPersist$1 {
   sync?: boolean | 'force'
@@ -76,12 +82,10 @@ interface LocalStorageConfig {
 }
 interface ConfigStore<State, Err = Error>
   extends LocalStorageConfig,
-    ConfigCommon<State, Err>,
-    ConfigJustStore<State> {}
+    ConfigStore$1<State, Err> {}
 interface ConfigSourceTarget<State, Err = Error>
   extends LocalStorageConfig,
-    ConfigCommon<State, Err>,
-    ConfigJustSourceTarget<State> {}
+    ConfigSourceTarget$1<State, Err> {}
 interface Persist {
   <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription
   <State, Err = Error>(config: ConfigStore<State, Err>): Subscription
@@ -104,6 +108,7 @@ export {
   ConfigPersist,
   ConfigSourceTarget,
   ConfigStore,
+  Contract,
   Done,
   Fail,
   Finally,

package/local/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../../src/local/index.ts"],"sourcesContent":["import type { Subscription } from 'effector'\nimport type {\n  ConfigPersist as BaseConfigPersist,\n  ConfigCommon,\n  ConfigJustStore,\n  ConfigJustSourceTarget,\n  StorageAdapter,\n} from '../types'\nimport { persist as base } from '../core'\nimport { nil } from '../nil'\nimport { storage } from '../storage'\n\nexport type {\n  Done,\n  Fail,\n  Finally,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from '../types'\n\nexport interface ConfigPersist extends BaseConfigPersist {\n  sync?: boolean | 'force'\n  timeout?: number\n}\n\nexport interface LocalStorageConfig {\n  sync?: boolean | 'force'\n  serialize?: (value: any) => string\n  deserialize?: (value: string) => any\n  timeout?: number\n  def?: any\n}\n\nexport interface ConfigStore<State, Err = Error>\n  extends LocalStorageConfig,\n    ConfigCommon<State, Err>,\n    ConfigJustStore<State> {}\n\nexport interface ConfigSourceTarget<State, Err = Error>\n  extends LocalStorageConfig,\n    ConfigCommon<State, Err>,\n    ConfigJustSourceTarget<State> {}\n\nexport interface Persist {\n  <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription\n  <State, Err = Error>(config: ConfigStore<State, Err>): Subscription\n}\n\n/**\n * Function, checking if `localStorage` exists\n */\nfunction supports() {\n  try {\n    return typeof localStorage !== 'undefined'\n  } catch (error) {\n    // accessing `localStorage` could throw an exception only in one case -\n    // when `localStorage` IS supported, but blocked by security policies\n    return true\n  }\n}\n\n/**\n * Creates `localStorage` adapter\n */\nlocal.factory = true as const\nexport function local(config?: LocalStorageConfig): StorageAdapter {\n  return supports()\n    ? storage({\n        storage: () => localStorage,\n        sync: true,\n        ...config,\n      })\n    : nil({ keyArea: 'local' })\n}\n\n/**\n * Creates custom partially applied `persist`\n * with predefined `localStorage` adapter\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config) =>\n    base({\n      adapter: local,\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default partially applied `persist`\n */\nexport const persist = createPersist()\n"],"names":["local","config","localStorage","error","supports","storage","sync","nil","keyArea","createPersist","defaults","base","adapter","factory","persist"],"mappings":"gHAiEO,SAASA,EAAMC,GACpB,OAfF,WACE,IACE,MAA+B,oBAAjBC,YACf,CAAC,MAAOC,GAGP,OAAO,CACT,CACF,CAOSC,GACHC,UAAQ,CACNA,QAASA,IAAMH,aACfI,MAAM,KACHL,IAELM,EAAAA,IAAI,CAAEC,QAAS,SACrB,CAMO,SAASC,EAAcC,GAC5B,OAAQT,GACNU,EAAAA,QAAK,CACHC,QAASZ,KACNU,KACAT,GAET,CAtBAD,EAAMa,SAAU,EA2BHC,IAAAA,EAAUL"}
+{"version":3,"file":"index.cjs","sources":["../../src/local/index.ts"],"sourcesContent":["import type { Subscription } from 'effector'\nimport type {\n  ConfigPersist as BaseConfigPersist,\n  ConfigStore as BaseConfigStore,\n  ConfigSourceTarget as BaseConfigSourceTarget,\n  StorageAdapter,\n} from '../types'\nimport { persist as base } from '../core'\nimport { nil } from '../nil'\nimport { storage } from '../storage'\n\nexport type {\n  Contract,\n  Done,\n  Fail,\n  Finally,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from '../types'\n\nexport interface ConfigPersist extends BaseConfigPersist {\n  sync?: boolean | 'force'\n  timeout?: number\n}\n\nexport interface LocalStorageConfig {\n  sync?: boolean | 'force'\n  serialize?: (value: any) => string\n  deserialize?: (value: string) => any\n  timeout?: number\n  def?: any\n}\n\nexport interface ConfigStore<State, Err = Error>\n  extends LocalStorageConfig,\n    BaseConfigStore<State, Err> {}\n\nexport interface ConfigSourceTarget<State, Err = Error>\n  extends LocalStorageConfig,\n    BaseConfigSourceTarget<State, Err> {}\n\nexport interface Persist {\n  <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription\n  <State, Err = Error>(config: ConfigStore<State, Err>): Subscription\n}\n\n/**\n * Function, checking if `localStorage` exists\n */\nfunction supports() {\n  try {\n    return typeof localStorage !== 'undefined'\n  } catch (error) {\n    // accessing `localStorage` could throw an exception only in one case -\n    // when `localStorage` IS supported, but blocked by security policies\n    return true\n  }\n}\n\n/**\n * Creates `localStorage` adapter\n */\nlocal.factory = true as const\nexport function local(config?: LocalStorageConfig): StorageAdapter {\n  return supports()\n    ? storage({\n        storage: () => localStorage,\n        sync: true,\n        ...config,\n      })\n    : nil({ keyArea: 'local' })\n}\n\n/**\n * Creates custom partially applied `persist`\n * with predefined `localStorage` adapter\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config) =>\n    base({\n      adapter: local,\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default partially applied `persist`\n */\nexport const persist = createPersist()\n"],"names":["local","config","localStorage","error","supports","storage","sync","nil","keyArea","createPersist","defaults","base","adapter","factory","persist"],"mappings":"gHA+DO,SAASA,EAAMC,GACpB,OAfF,WACE,IACE,MAA+B,oBAAjBC,YACf,CAAC,MAAOC,GAGP,OAAO,CACT,CACF,CAOSC,GACHC,UAAQ,CACNA,QAASA,IAAMH,aACfI,MAAM,KACHL,IAELM,EAAAA,IAAI,CAAEC,QAAS,SACrB,CAMO,SAASC,EAAcC,GAC5B,OAAQT,GACNU,EAAAA,QAAK,CACHC,QAASZ,KACNU,KACAT,GAET,CAtBAD,EAAMa,SAAU,EA2BHC,IAAAA,EAAUL"}

package/local/index.d.ts

@@ -2,7 +2,7 @@ import { Unit, Store, Event, Effect, Subscription } from 'effector'
 
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any
@@ -62,6 +62,12 @@ interface ConfigJustSourceTarget<State> {
   source: Store<State> | Event<State> | Effect<State, any, any>
   target: Store<State> | Event<State> | Effect<State, any, any>
 }
+interface ConfigStore$1<State, Err = Error>
+  extends ConfigCommon<State, Err>,
+    ConfigJustStore<State> {}
+interface ConfigSourceTarget$1<State, Err = Error>
+  extends ConfigCommon<State, Err>,
+    ConfigJustSourceTarget<State> {}
 
 interface ConfigPersist extends ConfigPersist$1 {
   sync?: boolean | 'force'
@@ -76,12 +82,10 @@ interface LocalStorageConfig {
 }
 interface ConfigStore<State, Err = Error>
   extends LocalStorageConfig,
-    ConfigCommon<State, Err>,
-    ConfigJustStore<State> {}
+    ConfigStore$1<State, Err> {}
 interface ConfigSourceTarget<State, Err = Error>
   extends LocalStorageConfig,
-    ConfigCommon<State, Err>,
-    ConfigJustSourceTarget<State> {}
+    ConfigSourceTarget$1<State, Err> {}
 interface Persist {
   <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription
   <State, Err = Error>(config: ConfigStore<State, Err>): Subscription
@@ -104,6 +108,7 @@ export {
   ConfigPersist,
   ConfigSourceTarget,
   ConfigStore,
+  Contract,
   Done,
   Fail,
   Finally,

package/local/index.js.flow

@@ -11,7 +11,7 @@ declare interface StorageAdapter {
     key: string,
     update: (raw?: any) => any
   ): {
-    get(raw?: any, ctx?: any): State | Promise<State>,
+    get(raw?: any, ctx?: any): State | Promise<State | void> | void,
     set(value: State, ctx?: any): void,
     ...
   };
@@ -83,6 +83,16 @@ declare interface ConfigJustSourceTarget<State> {
   source: Store<State> | Event<State> | Effect<State, any, any>;
   target: Store<State> | Event<State> | Effect<State, any, any>;
 }
+declare type ConfigStore$1<State, Err = Error> = { ... } & ConfigCommon<
+  State,
+  Err
+> &
+  ConfigJustStore<State>
+declare type ConfigSourceTarget$1<State, Err = Error> = { ... } & ConfigCommon<
+  State,
+  Err
+> &
+  ConfigJustSourceTarget<State>
 declare type ConfigPersist = {
   sync?: boolean | 'force',
   timeout?: number,
@@ -96,13 +106,11 @@ declare interface LocalStorageConfig {
   def?: any;
 }
 declare type ConfigStore<State, Err = Error> = { ... } & LocalStorageConfig &
-  ConfigCommon<State, Err> &
-  ConfigJustStore<State>
+  ConfigStore$1<State, Err>
 declare type ConfigSourceTarget<State, Err = Error> = {
   ...
 } & LocalStorageConfig &
-  ConfigCommon<State, Err> &
-  ConfigJustSourceTarget<State>
+  ConfigSourceTarget$1<State, Err>
 declare interface Persist {
   <State, Err>(config: ConfigSourceTarget<State, Err>): Subscription;
   <State, Err>(config: ConfigStore<State, Err>): Subscription;
@@ -120,6 +128,7 @@ declare export {
   ConfigPersist,
   ConfigSourceTarget,
   ConfigStore,
+  Contract,
   Done,
   Fail,
   Finally,

package/local/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/local/index.ts"],"sourcesContent":["import type { Subscription } from 'effector'\nimport type {\n  ConfigPersist as BaseConfigPersist,\n  ConfigCommon,\n  ConfigJustStore,\n  ConfigJustSourceTarget,\n  StorageAdapter,\n} from '../types'\nimport { persist as base } from '../core'\nimport { nil } from '../nil'\nimport { storage } from '../storage'\n\nexport type {\n  Done,\n  Fail,\n  Finally,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from '../types'\n\nexport interface ConfigPersist extends BaseConfigPersist {\n  sync?: boolean | 'force'\n  timeout?: number\n}\n\nexport interface LocalStorageConfig {\n  sync?: boolean | 'force'\n  serialize?: (value: any) => string\n  deserialize?: (value: string) => any\n  timeout?: number\n  def?: any\n}\n\nexport interface ConfigStore<State, Err = Error>\n  extends LocalStorageConfig,\n    ConfigCommon<State, Err>,\n    ConfigJustStore<State> {}\n\nexport interface ConfigSourceTarget<State, Err = Error>\n  extends LocalStorageConfig,\n    ConfigCommon<State, Err>,\n    ConfigJustSourceTarget<State> {}\n\nexport interface Persist {\n  <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription\n  <State, Err = Error>(config: ConfigStore<State, Err>): Subscription\n}\n\n/**\n * Function, checking if `localStorage` exists\n */\nfunction supports() {\n  try {\n    return typeof localStorage !== 'undefined'\n  } catch (error) {\n    // accessing `localStorage` could throw an exception only in one case -\n    // when `localStorage` IS supported, but blocked by security policies\n    return true\n  }\n}\n\n/**\n * Creates `localStorage` adapter\n */\nlocal.factory = true as const\nexport function local(config?: LocalStorageConfig): StorageAdapter {\n  return supports()\n    ? storage({\n        storage: () => localStorage,\n        sync: true,\n        ...config,\n      })\n    : nil({ keyArea: 'local' })\n}\n\n/**\n * Creates custom partially applied `persist`\n * with predefined `localStorage` adapter\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config) =>\n    base({\n      adapter: local,\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default partially applied `persist`\n */\nexport const persist = createPersist()\n"],"names":["local","config","localStorage","error","supports","storage","sync","nil","keyArea","createPersist","defaults","base","adapter","factory","persist"],"mappings":"+HAiEO,SAASA,EAAMC,GACpB,OAfF,WACE,IACE,MAA+B,oBAAjBC,YACf,CAAC,MAAOC,GAGP,OAAO,CACT,CACF,CAOSC,GACHC,EAAQ,CACNA,QAASA,IAAMH,aACfI,MAAM,KACHL,IAELM,EAAI,CAAEC,QAAS,SACrB,CAMO,SAASC,EAAcC,GAC5B,OAAQT,GACNU,EAAK,CACHC,QAASZ,KACNU,KACAT,GAET,CAtBAD,EAAMa,SAAU,EA2BHC,IAAAA,EAAUL"}
+{"version":3,"file":"index.js","sources":["../../src/local/index.ts"],"sourcesContent":["import type { Subscription } from 'effector'\nimport type {\n  ConfigPersist as BaseConfigPersist,\n  ConfigStore as BaseConfigStore,\n  ConfigSourceTarget as BaseConfigSourceTarget,\n  StorageAdapter,\n} from '../types'\nimport { persist as base } from '../core'\nimport { nil } from '../nil'\nimport { storage } from '../storage'\n\nexport type {\n  Contract,\n  Done,\n  Fail,\n  Finally,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from '../types'\n\nexport interface ConfigPersist extends BaseConfigPersist {\n  sync?: boolean | 'force'\n  timeout?: number\n}\n\nexport interface LocalStorageConfig {\n  sync?: boolean | 'force'\n  serialize?: (value: any) => string\n  deserialize?: (value: string) => any\n  timeout?: number\n  def?: any\n}\n\nexport interface ConfigStore<State, Err = Error>\n  extends LocalStorageConfig,\n    BaseConfigStore<State, Err> {}\n\nexport interface ConfigSourceTarget<State, Err = Error>\n  extends LocalStorageConfig,\n    BaseConfigSourceTarget<State, Err> {}\n\nexport interface Persist {\n  <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription\n  <State, Err = Error>(config: ConfigStore<State, Err>): Subscription\n}\n\n/**\n * Function, checking if `localStorage` exists\n */\nfunction supports() {\n  try {\n    return typeof localStorage !== 'undefined'\n  } catch (error) {\n    // accessing `localStorage` could throw an exception only in one case -\n    // when `localStorage` IS supported, but blocked by security policies\n    return true\n  }\n}\n\n/**\n * Creates `localStorage` adapter\n */\nlocal.factory = true as const\nexport function local(config?: LocalStorageConfig): StorageAdapter {\n  return supports()\n    ? storage({\n        storage: () => localStorage,\n        sync: true,\n        ...config,\n      })\n    : nil({ keyArea: 'local' })\n}\n\n/**\n * Creates custom partially applied `persist`\n * with predefined `localStorage` adapter\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config) =>\n    base({\n      adapter: local,\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default partially applied `persist`\n */\nexport const persist = createPersist()\n"],"names":["local","config","localStorage","error","supports","storage","sync","nil","keyArea","createPersist","defaults","base","adapter","factory","persist"],"mappings":"+HA+DO,SAASA,EAAMC,GACpB,OAfF,WACE,IACE,MAA+B,oBAAjBC,YACf,CAAC,MAAOC,GAGP,OAAO,CACT,CACF,CAOSC,GACHC,EAAQ,CACNA,QAASA,IAAMH,aACfI,MAAM,KACHL,IAELM,EAAI,CAAEC,QAAS,SACrB,CAMO,SAASC,EAAcC,GAC5B,OAAQT,GACNU,EAAK,CACHC,QAASZ,KACNU,KACAT,GAET,CAtBAD,EAAMa,SAAU,EA2BHC,IAAAA,EAAUL"}

package/log/index.cjs.d.ts

@@ -1,6 +1,6 @@
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any

package/log/index.d.ts

@@ -1,6 +1,6 @@
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any

package/log/index.js.flow

@@ -10,7 +10,7 @@ declare interface StorageAdapter {
     key: string,
     update: (raw?: any) => any
   ): {
-    get(raw?: any, ctx?: any): State | Promise<State>,
+    get(raw?: any, ctx?: any): State | Promise<State | void> | void,
     set(value: State, ctx?: any): void,
     ...
   };

package/memory/index.cjs.d.ts

@@ -2,7 +2,7 @@ import { Unit, Store, Event, Effect, Subscription } from 'effector'
 
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any
@@ -38,7 +38,7 @@ type Finally<State, Err> =
   | (Fail<Err> & {
       status: 'fail'
     })
-interface ConfigPersist {
+interface ConfigPersist$1 {
   pickup?: Unit<any>
   context?: Unit<any>
   keyPrefix?: string
@@ -62,6 +62,12 @@ interface ConfigJustSourceTarget<State> {
   source: Store<State> | Event<State> | Effect<State, any, any>
   target: Store<State> | Event<State> | Effect<State, any, any>
 }
+interface ConfigStore$1<State, Err = Error>
+  extends ConfigCommon<State, Err>,
+    ConfigJustStore<State> {}
+interface ConfigSourceTarget$1<State, Err = Error>
+  extends ConfigCommon<State, Err>,
+    ConfigJustSourceTarget<State> {}
 
 interface MemoryConfig {
   area?: Map<string, any>
@@ -71,12 +77,10 @@ declare namespace adapter {
   var factory: true
 }
 
-interface ConfigStore<State, Err = Error>
-  extends ConfigCommon<State, Err>,
-    ConfigJustStore<State> {}
+interface ConfigPersist extends ConfigPersist$1 {}
+interface ConfigStore<State, Err = Error> extends ConfigStore$1<State, Err> {}
 interface ConfigSourceTarget<State, Err = Error>
-  extends ConfigCommon<State, Err>,
-    ConfigJustSourceTarget<State> {}
+  extends ConfigSourceTarget$1<State, Err> {}
 interface Persist {
   <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription
   <State, Err = Error>(config: ConfigStore<State, Err>): Subscription
@@ -96,6 +100,7 @@ export {
   ConfigPersist,
   ConfigSourceTarget,
   ConfigStore,
+  Contract,
   Done,
   Fail,
   Finally,

package/memory/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../../src/memory/adapter.ts","../../src/memory/index.ts"],"sourcesContent":["import type { StorageAdapter } from '../types'\n\nconst data = new Map<string, any>()\n\nexport interface MemoryConfig {\n  area?: Map<string, any>\n}\n\n/**\n * Memory adapter\n */\nadapter.factory = true as const\nexport function adapter({ area = data }: MemoryConfig = {}): StorageAdapter {\n  const adapter: StorageAdapter = <State>(key: string) => ({\n    get: () => area.get(key),\n    set: (value: State) => area.set(key, value),\n  })\n\n  adapter.keyArea = area\n  return adapter\n}\n","import type { Subscription } from 'effector'\nimport type {\n  ConfigPersist,\n  ConfigCommon,\n  ConfigJustStore,\n  ConfigJustSourceTarget,\n} from '../types'\nimport { persist as base } from '../core'\nimport { adapter } from './adapter'\n\nexport type {\n  ConfigPersist,\n  Done,\n  Fail,\n  Finally,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from '../types'\nexport type { MemoryConfig } from './adapter'\n\nexport interface ConfigStore<State, Err = Error>\n  extends ConfigCommon<State, Err>,\n    ConfigJustStore<State> {}\n\nexport interface ConfigSourceTarget<State, Err = Error>\n  extends ConfigCommon<State, Err>,\n    ConfigJustSourceTarget<State> {}\n\nexport interface Persist {\n  <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription\n  <State, Err = Error>(config: ConfigStore<State, Err>): Subscription\n}\n\n/**\n * Returns memory adapter\n */\nexport { adapter as memory }\n\n/**\n * Creates custom partially applied `persist`\n * with predefined `memory` adapter\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config) =>\n    base({\n      adapter: adapter(),\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default partially applied `persist`\n */\nexport const persist = createPersist()\n"],"names":["data","Map","adapter","area","key","get","set","value","keyArea","createPersist","defaults","config","base","factory","persist"],"mappings":"gDAEMA,EAAO,IAAIC,IAUV,SAASC,GAAQC,KAAEA,EAAOH,GAAuB,IACtD,IAAME,EAAkCE,IAAiB,CACvDC,IAAKA,IAAMF,EAAKE,IAAID,GACpBE,IAAMC,GAAiBJ,EAAKG,IAAIF,EAAKG,KAIvC,OADAL,EAAQM,QAAUL,EACXD,CACT,CCsBO,SAASO,EAAcC,GAC5B,OAAQC,GACNC,EAAAA,QAAK,CACHV,QAASA,OACNQ,KACAC,GAET,CDtCAT,EAAQW,SAAU,EC2CLC,IAAAA,EAAUL"}
+{"version":3,"file":"index.cjs","sources":["../../src/memory/adapter.ts","../../src/memory/index.ts"],"sourcesContent":["import type { StorageAdapter } from '../types'\n\nconst data = new Map<string, any>()\n\nexport interface MemoryConfig {\n  area?: Map<string, any>\n}\n\n/**\n * Memory adapter\n */\nadapter.factory = true as const\nexport function adapter({ area = data }: MemoryConfig = {}): StorageAdapter {\n  const adapter: StorageAdapter = <State>(key: string) => ({\n    get: () => area.get(key),\n    set: (value: State) => area.set(key, value),\n  })\n\n  adapter.keyArea = area\n  return adapter\n}\n","import type { Subscription } from 'effector'\nimport type {\n  ConfigPersist as BaseConfigPersist,\n  ConfigStore as BaseConfigStore,\n  ConfigSourceTarget as BaseConfigSourceTarget,\n} from '../types'\nimport { persist as base } from '../core'\nimport { adapter } from './adapter'\n\nexport type {\n  Contract,\n  Done,\n  Fail,\n  Finally,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from '../types'\nexport type { MemoryConfig } from './adapter'\n\nexport interface ConfigPersist extends BaseConfigPersist {}\n\nexport interface ConfigStore<State, Err = Error>\n  extends BaseConfigStore<State, Err> {}\n\nexport interface ConfigSourceTarget<State, Err = Error>\n  extends BaseConfigSourceTarget<State, Err> {}\n\nexport interface Persist {\n  <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription\n  <State, Err = Error>(config: ConfigStore<State, Err>): Subscription\n}\n\n/**\n * Returns memory adapter\n */\nexport { adapter as memory }\n\n/**\n * Creates custom partially applied `persist`\n * with predefined `memory` adapter\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config) =>\n    base({\n      adapter: adapter(),\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default partially applied `persist`\n */\nexport const persist = createPersist()\n"],"names":["data","Map","adapter","area","key","get","set","value","keyArea","createPersist","defaults","config","base","factory","persist"],"mappings":"gDAEMA,EAAO,IAAIC,IAUV,SAASC,GAAQC,KAAEA,EAAOH,GAAuB,IACtD,IAAME,EAAkCE,IAAiB,CACvDC,IAAKA,IAAMF,EAAKE,IAAID,GACpBE,IAAMC,GAAiBJ,EAAKG,IAAIF,EAAKG,KAIvC,OADAL,EAAQM,QAAUL,EACXD,CACT,CCqBO,SAASO,EAAcC,GAC5B,OAAQC,GACNC,EAAAA,QAAK,CACHV,QAASA,OACNQ,KACAC,GAET,CDrCAT,EAAQW,SAAU,EC0CLC,IAAAA,EAAUL"}

package/memory/index.d.ts

@@ -2,7 +2,7 @@ import { Unit, Store, Event, Effect, Subscription } from 'effector'
 
 interface StorageAdapter {
   <State>(key: string, update: (raw?: any) => any): {
-    get(raw?: any, ctx?: any): State | Promise<State>
+    get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined
     set(value: State, ctx?: any): void
   }
   keyArea?: any
@@ -38,7 +38,7 @@ type Finally<State, Err> =
   | (Fail<Err> & {
       status: 'fail'
     })
-interface ConfigPersist {
+interface ConfigPersist$1 {
   pickup?: Unit<any>
   context?: Unit<any>
   keyPrefix?: string
@@ -62,6 +62,12 @@ interface ConfigJustSourceTarget<State> {
   source: Store<State> | Event<State> | Effect<State, any, any>
   target: Store<State> | Event<State> | Effect<State, any, any>
 }
+interface ConfigStore$1<State, Err = Error>
+  extends ConfigCommon<State, Err>,
+    ConfigJustStore<State> {}
+interface ConfigSourceTarget$1<State, Err = Error>
+  extends ConfigCommon<State, Err>,
+    ConfigJustSourceTarget<State> {}
 
 interface MemoryConfig {
   area?: Map<string, any>
@@ -71,12 +77,10 @@ declare namespace adapter {
   var factory: true
 }
 
-interface ConfigStore<State, Err = Error>
-  extends ConfigCommon<State, Err>,
-    ConfigJustStore<State> {}
+interface ConfigPersist extends ConfigPersist$1 {}
+interface ConfigStore<State, Err = Error> extends ConfigStore$1<State, Err> {}
 interface ConfigSourceTarget<State, Err = Error>
-  extends ConfigCommon<State, Err>,
-    ConfigJustSourceTarget<State> {}
+  extends ConfigSourceTarget$1<State, Err> {}
 interface Persist {
   <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription
   <State, Err = Error>(config: ConfigStore<State, Err>): Subscription
@@ -96,6 +100,7 @@ export {
   ConfigPersist,
   ConfigSourceTarget,
   ConfigStore,
+  Contract,
   Done,
   Fail,
   Finally,