effector-storage 6.0.0 → 6.1.0

package/README.md

@@ -17,8 +17,10 @@ Small module for [Effector](https://github.com/effector/effector) ☄️ to sync
   - [with `localStorage`](#with-localstorage)
   - [with `sessionStorage`](#with-sessionstorage)
   - [with query string](#with-query-string)
+  - [with `BroadcastChannel`](#with-broadcastchannel)
   - [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 +65,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 +81,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 +93,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.
 
@@ -104,12 +106,21 @@ persist({ store: $id, key: 'id' })
 
 If two (or more) stores are persisted in query string with the same key — they are synced between themselves.
 
-⚠️ **Note**<br>
-Use this only with plain string stores (`Store<string | null>`) to avoid strange unexpected behavior.
+### with `BroadcastChannel`
+
+Docs: [effector-storage/broadcast](https://github.com/yumauri/effector-storage/tree/main/src/broadcast/README.md)
+
+You can sync stores across different browsing contexts (tabs, windows, workers), just import `persist` from `'effector-storage/broadcast'`:
+
+```javascript
+import { persist } from 'effector-storage/broadcast'
+```
 
 ### with React Native AsyncStorage
 
-Docs: [effector-storage/rn/async](https://github.com/yumauri/effector-storage/tree/master/src/rn/async/README.md)
+❗️ Deprecated and will be 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 +136,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)
+❗️ Deprecated and will be 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 +152,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:
@@ -171,7 +188,7 @@ In order to synchronize _something_, you need to specify effector units. Dependi
 
 - `store` ([_Store_]): Store to synchronize with local/session storage.
 - `source` ([_Event_] | [_Effect_] | [_Store_]): Source unit, which updates will be sent to local/session storage.
-- `target` ([_Event_] | [_Effect_] | [_Store_]): Target unit, which will receive updates from local/session storage (as well as initial value). Must be different than `source` to avoid circular updates — `source` updates are forwarded directly to `target`.
+- `target` ([_Event_] | [_Effect_] | [_Store_]): Target unit, which will receive updates from local/session storage (as well as initial value). Must be different than `source` to avoid circular updates — `source` updates are passed directly to `target`.
 
 ### Options
 
@@ -250,14 +267,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 +333,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 +359,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
 
@@ -416,7 +433,7 @@ If your storage can be updated from _external source_, and doesn't have any even
 You can use optional `pickup` parameter to specify unit to trigger update (keep in mind, that when you add `pickup`, `persist` _will not_ get initial value from storage automatically):
 
 ```javascript
-import { createEvent, createStore, forward } from 'effector'
+import { createEvent, createStore } from 'effector'
 import { persist } from 'effector-storage/session'
 
 // event, which will be used to trigger update
@@ -435,7 +452,7 @@ pickup()
 Another option, if you have your own adapter, you can add this feature right into it:
 
 ```javascript
-import { createEvent, createStore, forward } from 'effector'
+import { createEvent, createStore } from 'effector'
 import { persist } from 'effector-storage'
 
 // event, which will be used in adapter to react to
@@ -550,12 +567,13 @@ 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))
-- [ ] [IndexedDB] support
+- [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] [BroadcastChannel] support (docs: [effector-storage/broadcast](https://github.com/yumauri/effector-storage/tree/main/src/broadcast/README.md))
+- [x] [AsyncStorage] support (extras: [@effector-storage/react-native-async-storage](https://github.com/yumauri/effector-storage-extras/tree/main/packages/react-native-async-storage))
+- [x] [EncryptedStorage] support (extras: [@effector-storage/react-native-encrypted-storage](https://github.com/yumauri/effector-storage-extras/tree/main/packages/react-native-encrypted-storage))
+- [x] [IndexedDB] support (extras: [@effector-storage/idb-keyval](https://github.com/yumauri/effector-storage-extras/tree/main/packages/idb-keyval))
 - [ ] [Cookies] support
 - [ ] you name it support
 
@@ -569,6 +587,7 @@ Use this approach with caution, beware of infinite circular updates. To avoid th
 [sessionstorage]: https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage
 [`'storage'`]: https://developer.mozilla.org/en-US/docs/Web/API/StorageEvent
 [indexeddb]: https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API
+[broadcastchannel]: https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel
 [asyncstorage]: https://react-native-async-storage.github.io/async-storage/
 [encryptedstorage]: https://github.com/emeraldsanto/react-native-encrypted-storage
 [cookies]: https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie

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/broadcast/index.cjs

@@ -0,0 +1,2 @@
+"use strict";var e=require("../core/index.cjs"),r=require("../nil/index.cjs"),t=new Map;function a(e){return"undefined"!=typeof BroadcastChannel?function({channel:e="effector-storage"}){var r,a=t.get(e)??(r=new BroadcastChannel(e));r&&t.set(e,r);var s=(e,r)=>(a.addEventListener("message",(({data:t})=>{null==t?r((()=>{throw new Error("Unable to deserialize message")})):t.key===e&&r((()=>t.value))})),a.addEventListener("messageerror",(()=>{r((()=>{throw new Error("Unable to deserialize message")}))})),{get(e){if(e)return e()},set(r){a.postMessage({key:e,value:r})}});return s.keyArea=a,s}({...e}):r.nil({keyArea:"broadcast"})}function s(r){return t=>e.persist({adapter:a,...r,...t})}a.factory=!0;var n=s();exports.broadcast=a,exports.createPersist=s,exports.persist=n;
+//# sourceMappingURL=index.cjs.map

package/broadcast/index.cjs.d.ts

@@ -0,0 +1,116 @@
+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 | undefined> | undefined
+    set(value: State, ctx?: any): void
+  }
+  keyArea?: any
+  noop?: boolean
+}
+interface StorageAdapterFactory<AdapterConfig> {
+  (config?: AdapterConfig): StorageAdapter
+  factory: true
+}
+type Contract<Data> =
+  | ((raw: unknown) => raw is Data)
+  | {
+      isData: (raw: unknown) => raw is Data
+      getErrorMessages: (raw: unknown) => string[]
+    }
+type Done<State> = {
+  key: string
+  keyPrefix: string
+  operation: 'set' | 'get'
+  value: State
+}
+type Fail<Err> = {
+  key: string
+  keyPrefix: string
+  operation: 'set' | 'get'
+  error: Err
+  value?: any
+}
+type Finally<State, Err> =
+  | (Done<State> & {
+      status: 'done'
+    })
+  | (Fail<Err> & {
+      status: 'fail'
+    })
+interface ConfigPersist$1 {
+  pickup?: Unit<any>
+  context?: Unit<any>
+  keyPrefix?: string
+  contract?: Contract<any>
+}
+interface ConfigCommon<State, Err = Error> {
+  clock?: Unit<any>
+  done?: Unit<Done<State>>
+  fail?: Unit<Fail<Err>>
+  finally?: Unit<Finally<State, Err>>
+  pickup?: Unit<any>
+  context?: Unit<any>
+  key?: string
+  keyPrefix?: string
+  contract?: Contract<State | undefined>
+}
+interface ConfigJustStore<State> {
+  store: Store<State>
+}
+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 BroadcastConfig {
+  channel?: string
+}
+
+interface ConfigPersist extends ConfigPersist$1 {}
+interface ConfigStore<State, Err = Error>
+  extends BroadcastConfig,
+    ConfigStore$1<State, Err> {}
+interface ConfigSourceTarget<State, Err = Error>
+  extends BroadcastConfig,
+    ConfigSourceTarget$1<State, Err> {}
+interface Persist {
+  <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription
+  <State, Err = Error>(config: ConfigStore<State, Err>): Subscription
+}
+declare function broadcast(config?: BroadcastConfig): StorageAdapter
+declare namespace broadcast {
+  var factory: true
+}
+/**
+ * Creates custom partially applied `persist`
+ * with predefined BroadcastChannel adapter
+ */
+declare function createPersist(defaults?: ConfigPersist): Persist
+/**
+ * Default partially applied `persist`
+ */
+declare const persist: Persist
+
+export {
+  BroadcastConfig,
+  ConfigPersist,
+  ConfigSourceTarget,
+  ConfigStore,
+  Contract,
+  Done,
+  Fail,
+  Finally,
+  Persist,
+  StorageAdapter,
+  StorageAdapterFactory,
+  broadcast,
+  createPersist,
+  persist,
+}

package/broadcast/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../../src/broadcast/adapter.ts","../../src/broadcast/index.ts"],"sourcesContent":["import type { StorageAdapter } from '../types'\n\nexport interface BroadcastConfig {\n  channel?: string\n}\n\n/**\n * BroadcastChannel instances cache\n */\nconst channels = new Map<string, BroadcastChannel>()\n\n/**\n * BroadcastChannel adapter factory\n */\nexport function adapter({\n  channel = 'effector-storage',\n}: BroadcastConfig): StorageAdapter {\n  let created: BroadcastChannel | undefined\n  const bus = channels.get(channel) ?? (created = new BroadcastChannel(channel))\n  if (created) channels.set(channel, created)\n\n  const adapter: StorageAdapter = <State>(\n    key: string,\n    update: (raw?: any) => any\n  ) => {\n    bus.addEventListener('message', ({ data }) => {\n      // according to e2e tests, chromium can call `message`\n      // instead of `messageerror`, with `null` as message's data\n      if (data == null) {\n        update(() => {\n          throw new Error('Unable to deserialize message')\n        })\n      } else if (data.key === key) {\n        update(() => {\n          return data.value\n        })\n      }\n    })\n\n    // I know only one case when this event can be fired:\n    // if message was sent from page to shared worker, and it contains `SharedArrayBuffer`\n    // https://bugs.webkit.org/show_bug.cgi?id=171216\n    bus.addEventListener('messageerror', () => {\n      update(() => {\n        throw new Error('Unable to deserialize message')\n      })\n    })\n\n    return {\n      get(box?: () => State | undefined) {\n        if (box) return box()\n      },\n\n      set(value: State) {\n        bus.postMessage({ key, value })\n      },\n    }\n  }\n\n  adapter.keyArea = bus\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  StorageAdapter,\n} from '../types'\nimport type { BroadcastConfig } from './adapter'\nimport { persist as base } from '../core'\nimport { nil } from '../nil'\nimport { adapter } from './adapter'\n\nexport type {\n  Contract,\n  Done,\n  Fail,\n  Finally,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from '../types'\nexport type { BroadcastConfig } from './adapter'\n\nexport interface ConfigPersist extends BaseConfigPersist {}\n\nexport interface ConfigStore<State, Err = Error>\n  extends BroadcastConfig,\n    BaseConfigStore<State, Err> {}\n\nexport interface ConfigSourceTarget<State, Err = Error>\n  extends BroadcastConfig,\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 `BroadcastChannel` exists and accessible\n */\nfunction supports() {\n  return typeof BroadcastChannel !== 'undefined'\n}\n\n/**\n * Creates BroadcastChannel string adapter\n */\nbroadcast.factory = true as const\nexport function broadcast(config?: BroadcastConfig): StorageAdapter {\n  return supports()\n    ? adapter({\n        ...config,\n      })\n    : nil({ keyArea: 'broadcast' })\n}\n\n/**\n * Creates custom partially applied `persist`\n * with predefined BroadcastChannel adapter\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config) =>\n    base({\n      adapter: broadcast,\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default partially applied `persist`\n */\nexport const persist = createPersist()\n"],"names":["channels","Map","broadcast","config","BroadcastChannel","channel","created","bus","get","set","adapter","key","update","addEventListener","data","Error","value","box","postMessage","keyArea","nil","createPersist","defaults","base","factory","persist"],"mappings":"8EASMA,EAAW,IAAIC,ICuCd,SAASC,EAAUC,GACxB,MARmC,oBAArBC,iBD3BT,UAAiBC,QACtBA,EAAU,qBAEV,IAAIC,EACEC,EAAMP,EAASQ,IAAIH,KAAaC,EAAU,IAAIF,iBAAiBC,IACjEC,GAASN,EAASS,IAAIJ,EAASC,GAEnC,IAAMI,EAA0BA,CAC9BC,EACAC,KAEAL,EAAIM,iBAAiB,WAAW,EAAGC,WAGrB,MAARA,EACFF,GAAO,KACL,MAAM,IAAIG,MAAM,gCAAgC,IAEzCD,EAAKH,MAAQA,GACtBC,GAAO,IACEE,EAAKE,OAEhB,IAMFT,EAAIM,iBAAiB,gBAAgB,KACnCD,GAAO,KACL,MAAM,IAAIG,MAAM,gCAAgC,GAChD,IAGG,CACLP,IAAIS,GACF,GAAIA,EAAK,OAAOA,GACjB,EAEDR,IAAIO,GACFT,EAAIW,YAAY,CAAEP,MAAKK,SACzB,IAKJ,OADAN,EAAQS,QAAUZ,EACXG,CACT,CCXMA,CAAQ,IACHP,IAELiB,EAAAA,IAAI,CAAED,QAAS,aACrB,CAMO,SAASE,EAAcC,GAC5B,OAAQnB,GACNoB,EAAAA,QAAK,CACHb,QAASR,KACNoB,KACAnB,GAET,CApBAD,EAAUsB,SAAU,EAyBPC,IAAAA,EAAUJ"}

package/broadcast/index.d.ts

@@ -0,0 +1,116 @@
+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 | undefined> | undefined
+    set(value: State, ctx?: any): void
+  }
+  keyArea?: any
+  noop?: boolean
+}
+interface StorageAdapterFactory<AdapterConfig> {
+  (config?: AdapterConfig): StorageAdapter
+  factory: true
+}
+type Contract<Data> =
+  | ((raw: unknown) => raw is Data)
+  | {
+      isData: (raw: unknown) => raw is Data
+      getErrorMessages: (raw: unknown) => string[]
+    }
+type Done<State> = {
+  key: string
+  keyPrefix: string
+  operation: 'set' | 'get'
+  value: State
+}
+type Fail<Err> = {
+  key: string
+  keyPrefix: string
+  operation: 'set' | 'get'
+  error: Err
+  value?: any
+}
+type Finally<State, Err> =
+  | (Done<State> & {
+      status: 'done'
+    })
+  | (Fail<Err> & {
+      status: 'fail'
+    })
+interface ConfigPersist$1 {
+  pickup?: Unit<any>
+  context?: Unit<any>
+  keyPrefix?: string
+  contract?: Contract<any>
+}
+interface ConfigCommon<State, Err = Error> {
+  clock?: Unit<any>
+  done?: Unit<Done<State>>
+  fail?: Unit<Fail<Err>>
+  finally?: Unit<Finally<State, Err>>
+  pickup?: Unit<any>
+  context?: Unit<any>
+  key?: string
+  keyPrefix?: string
+  contract?: Contract<State | undefined>
+}
+interface ConfigJustStore<State> {
+  store: Store<State>
+}
+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 BroadcastConfig {
+  channel?: string
+}
+
+interface ConfigPersist extends ConfigPersist$1 {}
+interface ConfigStore<State, Err = Error>
+  extends BroadcastConfig,
+    ConfigStore$1<State, Err> {}
+interface ConfigSourceTarget<State, Err = Error>
+  extends BroadcastConfig,
+    ConfigSourceTarget$1<State, Err> {}
+interface Persist {
+  <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription
+  <State, Err = Error>(config: ConfigStore<State, Err>): Subscription
+}
+declare function broadcast(config?: BroadcastConfig): StorageAdapter
+declare namespace broadcast {
+  var factory: true
+}
+/**
+ * Creates custom partially applied `persist`
+ * with predefined BroadcastChannel adapter
+ */
+declare function createPersist(defaults?: ConfigPersist): Persist
+/**
+ * Default partially applied `persist`
+ */
+declare const persist: Persist
+
+export {
+  BroadcastConfig,
+  ConfigPersist,
+  ConfigSourceTarget,
+  ConfigStore,
+  Contract,
+  Done,
+  Fail,
+  Finally,
+  Persist,
+  StorageAdapter,
+  StorageAdapterFactory,
+  broadcast,
+  createPersist,
+  persist,
+}

package/broadcast/index.js

@@ -0,0 +1,2 @@
+import{persist as e}from"../core/index.js";import{nil as r}from"../nil/index.js";var a=new Map;function t(e){return"undefined"!=typeof BroadcastChannel?function({channel:e="effector-storage"}){var r,t=a.get(e)??(r=new BroadcastChannel(e));r&&a.set(e,r);var n=(e,r)=>(t.addEventListener("message",(({data:a})=>{null==a?r((()=>{throw new Error("Unable to deserialize message")})):a.key===e&&r((()=>a.value))})),t.addEventListener("messageerror",(()=>{r((()=>{throw new Error("Unable to deserialize message")}))})),{get(e){if(e)return e()},set(r){t.postMessage({key:e,value:r})}});return n.keyArea=t,n}({...e}):r({keyArea:"broadcast"})}function n(r){return a=>e({adapter:t,...r,...a})}t.factory=!0;var s=n();export{t as broadcast,n as createPersist,s as persist};
+//# sourceMappingURL=index.js.map

package/broadcast/index.js.flow

@@ -0,0 +1,134 @@
+/**
+ * Flowtype definitions for index
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import { Unit, Store, Event, Effect, Subscription } from 'effector'
+declare interface StorageAdapter {
+  <State>(
+    key: string,
+    update: (raw?: any) => any
+  ): {
+    get(raw?: any, ctx?: any): State | Promise<State | void> | void,
+    set(value: State, ctx?: any): void,
+    ...
+  };
+  keyArea?: any;
+  noop?: boolean;
+}
+declare interface StorageAdapterFactory<AdapterConfig> {
+  (config?: AdapterConfig): StorageAdapter;
+  factory: true;
+}
+declare type Contract<Data> =
+  | ((raw: mixed) => boolean)
+  | {
+      isData: (raw: mixed) => boolean,
+      getErrorMessages: (raw: mixed) => string[],
+      ...
+    }
+declare type Done<State> = {
+  key: string,
+  keyPrefix: string,
+  operation: 'set' | 'get',
+  value: State,
+  ...
+}
+declare type Fail<Err> = {
+  key: string,
+  keyPrefix: string,
+  operation: 'set' | 'get',
+  error: Err,
+  value?: any,
+  ...
+}
+declare type Finally<State, Err> =
+  | {
+      ...Done<State>,
+      ...{
+        status: 'done',
+        ...
+      },
+    }
+  | {
+      ...Fail<Err>,
+      ...{
+        status: 'fail',
+        ...
+      },
+    }
+declare interface ConfigPersist$1 {
+  pickup?: Unit<any>;
+  context?: Unit<any>;
+  keyPrefix?: string;
+  contract?: Contract<any>;
+}
+declare interface ConfigCommon<State, Err = Error> {
+  clock?: Unit<any>;
+  done?: Unit<Done<State>>;
+  fail?: Unit<Fail<Err>>;
+  finally?: Unit<Finally<State, Err>>;
+  pickup?: Unit<any>;
+  context?: Unit<any>;
+  key?: string;
+  keyPrefix?: string;
+  contract?: Contract<State | void>;
+}
+declare interface ConfigJustStore<State> {
+  store: Store<State>;
+}
+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 interface BroadcastConfig {
+  channel?: string;
+}
+declare type ConfigPersist = { ... } & ConfigPersist$1
+declare type ConfigStore<State, Err = Error> = { ... } & BroadcastConfig &
+  ConfigStore$1<State, Err>
+declare type ConfigSourceTarget<State, Err = Error> = {
+  ...
+} & BroadcastConfig &
+  ConfigSourceTarget$1<State, Err>
+declare interface Persist {
+  <State, Err>(config: ConfigSourceTarget<State, Err>): Subscription;
+  <State, Err>(config: ConfigStore<State, Err>): Subscription;
+}
+declare var broadcast: typeof npm$namespace$broadcast
+
+declare var npm$namespace$broadcast: {|
+  (config?: BroadcastConfig): StorageAdapter,
+  factory: typeof broadcast$factory,
+|}
+declare var broadcast$factory: true
+declare function createPersist(defaults?: ConfigPersist): Persist
+declare var persist: Persist
+declare export {
+  BroadcastConfig,
+  ConfigPersist,
+  ConfigSourceTarget,
+  ConfigStore,
+  Contract,
+  Done,
+  Fail,
+  Finally,
+  Persist,
+  StorageAdapter,
+  StorageAdapterFactory,
+  broadcast,
+  createPersist,
+  persist,
+}

package/broadcast/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/broadcast/adapter.ts","../../src/broadcast/index.ts"],"sourcesContent":["import type { StorageAdapter } from '../types'\n\nexport interface BroadcastConfig {\n  channel?: string\n}\n\n/**\n * BroadcastChannel instances cache\n */\nconst channels = new Map<string, BroadcastChannel>()\n\n/**\n * BroadcastChannel adapter factory\n */\nexport function adapter({\n  channel = 'effector-storage',\n}: BroadcastConfig): StorageAdapter {\n  let created: BroadcastChannel | undefined\n  const bus = channels.get(channel) ?? (created = new BroadcastChannel(channel))\n  if (created) channels.set(channel, created)\n\n  const adapter: StorageAdapter = <State>(\n    key: string,\n    update: (raw?: any) => any\n  ) => {\n    bus.addEventListener('message', ({ data }) => {\n      // according to e2e tests, chromium can call `message`\n      // instead of `messageerror`, with `null` as message's data\n      if (data == null) {\n        update(() => {\n          throw new Error('Unable to deserialize message')\n        })\n      } else if (data.key === key) {\n        update(() => {\n          return data.value\n        })\n      }\n    })\n\n    // I know only one case when this event can be fired:\n    // if message was sent from page to shared worker, and it contains `SharedArrayBuffer`\n    // https://bugs.webkit.org/show_bug.cgi?id=171216\n    bus.addEventListener('messageerror', () => {\n      update(() => {\n        throw new Error('Unable to deserialize message')\n      })\n    })\n\n    return {\n      get(box?: () => State | undefined) {\n        if (box) return box()\n      },\n\n      set(value: State) {\n        bus.postMessage({ key, value })\n      },\n    }\n  }\n\n  adapter.keyArea = bus\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  StorageAdapter,\n} from '../types'\nimport type { BroadcastConfig } from './adapter'\nimport { persist as base } from '../core'\nimport { nil } from '../nil'\nimport { adapter } from './adapter'\n\nexport type {\n  Contract,\n  Done,\n  Fail,\n  Finally,\n  StorageAdapter,\n  StorageAdapterFactory,\n} from '../types'\nexport type { BroadcastConfig } from './adapter'\n\nexport interface ConfigPersist extends BaseConfigPersist {}\n\nexport interface ConfigStore<State, Err = Error>\n  extends BroadcastConfig,\n    BaseConfigStore<State, Err> {}\n\nexport interface ConfigSourceTarget<State, Err = Error>\n  extends BroadcastConfig,\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 `BroadcastChannel` exists and accessible\n */\nfunction supports() {\n  return typeof BroadcastChannel !== 'undefined'\n}\n\n/**\n * Creates BroadcastChannel string adapter\n */\nbroadcast.factory = true as const\nexport function broadcast(config?: BroadcastConfig): StorageAdapter {\n  return supports()\n    ? adapter({\n        ...config,\n      })\n    : nil({ keyArea: 'broadcast' })\n}\n\n/**\n * Creates custom partially applied `persist`\n * with predefined BroadcastChannel adapter\n */\nexport function createPersist(defaults?: ConfigPersist): Persist {\n  return (config) =>\n    base({\n      adapter: broadcast,\n      ...defaults,\n      ...config,\n    })\n}\n\n/**\n * Default partially applied `persist`\n */\nexport const persist = createPersist()\n"],"names":["channels","Map","broadcast","config","BroadcastChannel","channel","created","bus","get","set","adapter","key","update","addEventListener","data","Error","value","box","postMessage","keyArea","nil","createPersist","defaults","base","factory","persist"],"mappings":"iFASA,IAAMA,EAAW,IAAIC,ICuCd,SAASC,EAAUC,GACxB,MARmC,oBAArBC,iBD3BT,UAAiBC,QACtBA,EAAU,qBAEV,IAAIC,EACEC,EAAMP,EAASQ,IAAIH,KAAaC,EAAU,IAAIF,iBAAiBC,IACjEC,GAASN,EAASS,IAAIJ,EAASC,GAEnC,IAAMI,EAA0BA,CAC9BC,EACAC,KAEAL,EAAIM,iBAAiB,WAAW,EAAGC,WAGrB,MAARA,EACFF,GAAO,KACL,MAAM,IAAIG,MAAM,gCAAgC,IAEzCD,EAAKH,MAAQA,GACtBC,GAAO,IACEE,EAAKE,OAEhB,IAMFT,EAAIM,iBAAiB,gBAAgB,KACnCD,GAAO,KACL,MAAM,IAAIG,MAAM,gCAAgC,GAChD,IAGG,CACLP,IAAIS,GACF,GAAIA,EAAK,OAAOA,GACjB,EAEDR,IAAIO,GACFT,EAAIW,YAAY,CAAEP,MAAKK,SACzB,IAKJ,OADAN,EAAQS,QAAUZ,EACXG,CACT,CCXMA,CAAQ,IACHP,IAELiB,EAAI,CAAED,QAAS,aACrB,CAMO,SAASE,EAAcC,GAC5B,OAAQnB,GACNoB,EAAK,CACHb,QAASR,KACNoB,KACAnB,GAET,CApBAD,EAAUsB,SAAU,EAyBPC,IAAAA,EAAUJ"}

package/broadcast/package.json

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

package/core/index.cjs

@@ -1,2 +1,2 @@
-"use strict";var e=require("effector"),r=new Map,t=e=>(r,t)=>e(t,r.ref),o=e.createEvent();o.watch((e=>console.error(e.error))),exports.persist=function(a){var{adapter:i,store:f,source:s=f,target:n=f,clock:d=s,done:c,fail:u=o,finally:l,pickup:p,context:v,key:y,keyPrefix:g="",contract:m}=a;if(!i)throw Error("Adapter is not defined");if(!s)throw Error("Store or source is not defined");if(!n)throw Error("Target is not defined");if(!y&&s.shortName===s.id)throw Error("Key or name is not defined");if(s===n&&!e.is.store(s))throw Error("Source must be different from target");void 0===a.def&&e.is.store(s)&&(a.def=s.defaultState);var k="factory"in i?i(a):i,w=y||s.shortName,h=function(t,o){var a=r.get(t);void 0===a&&(a=new Map,r.set(t,a));var i=a.get(o);return void 0!==i||(i=e.createStore(null,{serialize:"ignore"}),a.set(o,i)),i}(k.keyArea||k,g+w),E=e.createNode(),x=()=>e.clearNode(E),P=e=>({status:r="fail",params:t,result:o,error:a})=>"done"===r?{status:r,key:w,keyPrefix:g,operation:e,value:"get"===e?o:t}:{status:r,key:w,keyPrefix:g,operation:e,value:t,error:a};return e.withRegion(E,(()=>{var r=e.createStore({ref:void 0},{serialize:"ignore"}),o=k(g+w,(e=>D(e))),a=e.attach({source:r,effect:t(o.get)}),i=e.attach({source:r,effect:t(o.set)}),f=e.createEffect((e=>r=>!e||void 0===r||("isData"in e?e.isData(r):e(r))?r:(()=>{throw"getErrorMessages"in e?e.getErrorMessages(r):void 0})())(m)),y=e.createEvent(),E=y.filterMap((({status:e,key:r,keyPrefix:t,operation:o,value:a})=>"done"===e?{key:r,keyPrefix:t,operation:o,value:a}:void 0)),x=y.filterMap((({status:e,key:r,keyPrefix:t,operation:o,error:a,value:i})=>"fail"===e?{key:r,keyPrefix:t,operation:o,error:a,value:i}:void 0)),M=e.createEvent(),D=a;r.updates.watch((()=>{D=(r=>{try{return e.scopeBind(r,{safe:!0})}catch(e){return r}})(a)})),e.sample({source:s,clock:d,target:M}),e.guard({source:e.sample(h,M,((e,r)=>[r,e])),filter:([e,r])=>e!==r,target:i.prepend((([e])=>e))}),e.forward({from:[a.doneData,i],to:h}),e.sample({source:e.merge([a.doneData,h]),target:f}),e.forward({from:f.doneData,to:n}),e.forward({from:[a.finally.map(P("get")),i.finally.map(P("set")),f.fail.map(P("validate"))],to:y}),e.forward({from:x,to:u}),c&&e.forward({from:E,to:c}),l&&e.forward({from:y,to:l}),v&&r.on(v,(({ref:e},r)=>({ref:void 0===r?e:r}))),p?(e.forward({from:p,to:a.prepend((()=>{}))}),r.on(p,(({ref:e},r)=>({ref:void 0===r?e:r})))):a()})),x.unsubscribe=x};
+"use strict";var e=require("effector"),r=new Map,t=e=>([r],t)=>e(t,r),a=e.createEvent();a.watch((e=>console.error(e.error))),exports.persist=function(o){var{adapter:i,store:s,source:c=s,target:n=s,clock:l=c,done:f,fail:d=a,finally:u,pickup:p,context:g,key:k,keyPrefix:v="",contract:y}=o;if(!i)throw Error("Adapter is not defined");if(!c)throw Error("Store or source is not defined");if(!n)throw Error("Target is not defined");if(!k&&c.shortName===c.id)throw Error("Key or name is not defined");if(c===n&&!e.is.store(c))throw Error("Source must be different from target");void 0===o.def&&e.is.store(c)&&(o.def=c.defaultState);var m="factory"in i?i(o):i,h=k||c.shortName,w=function(t,a){var o=r.get(t);void 0===o&&(o=new Map,r.set(t,o));var i=o.get(a);return void 0!==i||(i=e.createStore(null,{serialize:"ignore"}),o.set(a,i)),i}(m.keyArea||m,v+h),E=e.createNode(),x=()=>e.clearNode(E),P=e=>({status:r="fail",params:t,result:a,error:o})=>"done"===r?{status:r,key:h,keyPrefix:v,operation:e,value:"get"===e?a:t}:{status:r,key:h,keyPrefix:v,operation:e,value:"function"==typeof t?void 0:t,error:o};return e.withRegion(E,(()=>{var r=e.createStore([],{serialize:"ignore"}),a=m(v+h,(e=>D(e))),o=e.attach({source:r,effect:t(a.get)}),i=e.attach({source:r,effect:t(a.set)}),s=e.createEffect((e=>r=>!e||void 0===r||("isData"in e?e.isData(r):e(r))?r:(()=>{throw"getErrorMessages"in e?e.getErrorMessages(r):void 0})())(y)),k=e.createEvent(),E=k.filterMap((({status:e,key:r,keyPrefix:t,operation:a,value:o})=>"done"===e?{key:r,keyPrefix:t,operation:a,value:o}:void 0)),x=k.filterMap((({status:e,key:r,keyPrefix:t,operation:a,error:o,value:i})=>"fail"===e?{key:r,keyPrefix:t,operation:a,error:o,value:i}:void 0)),M=e.createEvent(),D=o;r.updates.watch((()=>{D=(r=>{try{return e.scopeBind(r,{safe:!0})}catch(e){return r}})(o)})),e.sample({source:c,clock:l,target:M}),e.guard({source:e.sample(w,M,((e,r)=>[r,e])),filter:([e,r])=>e!==r,target:i.prepend((([e])=>e))}),e.sample({clock:[o.doneData,i],target:w}),e.sample({clock:[o.doneData,w],target:s}),e.sample({clock:s.doneData,target:n}),e.sample({clock:[o.finally.map(P("get")),i.finally.map(P("set")),s.fail.map(P("validate"))],target:k}),u&&e.sample({clock:k,target:u}),f&&e.sample({clock:E,target:f}),e.sample({clock:x,target:d}),g&&r.on(g,(([e],r)=>[void 0===r?e:r])),p?(e.sample({clock:p,fn:()=>{},target:o}),r.on(p,(([e],r)=>[void 0===r?e:r]))):o()})),x.unsubscribe=x};
 //# sourceMappingURL=index.cjs.map

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