effector-storage 7.1.0 → 8.0.0

package/index.d.cts

@@ -1,4 +1,4 @@
-import { Unit, Subscription, Store, Event, Effect } from 'effector';
+import { Unit, UnitTargetable, Store, Event, Effect, StoreWritable, EventCallable, Subscription } from 'effector';
 export { AsyncStorageConfig, asyncStorage } from './async-storage';
 export { BroadcastConfig, broadcast } from './broadcast';
 export { LocalStorageConfig, local } from './local';
@@ -10,22 +10,98 @@ export { SessionStorageConfig, session } from './session';
 export { StorageConfig, storage } from './storage';
 export { async, either, farcached } from './tools';
 
+/** The Contract interface. */
+interface Contract$1<Raw, Data extends Raw> {
+    /**
+     * Checks if Raw is Data
+     */
+    isData: (prepared: Raw) => prepared is Data;
+    /**
+     * - empty array is dedicated for valid response
+     * - array of string with validation erorrs for invalidDataError
+     */
+    getErrorMessages: (prepared: Raw) => string[];
+}
+
+/** The Standard Schema interface. */
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+    /** The Standard Schema properties. */
+    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+declare namespace StandardSchemaV1 {
+    /** The Standard Schema properties interface. */
+    interface Props<Input = unknown, Output = Input> {
+        /** The version number of the standard. */
+        readonly version: 1;
+        /** The vendor name of the schema library. */
+        readonly vendor: string;
+        /** Validates unknown input values. */
+        readonly validate: (value: unknown, options?: StandardSchemaV1.Options | undefined) => Result<Output> | Promise<Result<Output>>;
+        /** Inferred types associated with the schema. */
+        readonly types?: Types<Input, Output> | undefined;
+    }
+    /** The result interface of the validate function. */
+    type Result<Output> = SuccessResult<Output> | FailureResult;
+    /** The result interface if validation succeeds. */
+    interface SuccessResult<Output> {
+        /** The typed output value. */
+        readonly value: Output;
+        /** A falsy value for `issues` indicates success. */
+        readonly issues?: undefined;
+    }
+    interface Options {
+        /** Explicit support for additional vendor-specific parameters, if needed. */
+        readonly libraryOptions?: Record<string, unknown> | undefined;
+    }
+    /** The result interface if validation fails. */
+    interface FailureResult {
+        /** The issues of failed validation. */
+        readonly issues: ReadonlyArray<Issue>;
+    }
+    /** The issue interface of the failure output. */
+    interface Issue {
+        /** The error message of the issue. */
+        readonly message: string;
+        /** The path of the issue, if any. */
+        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
+    }
+    /** The path segment interface of the issue. */
+    interface PathSegment {
+        /** The key representing a path segment. */
+        readonly key: PropertyKey;
+    }
+    /** The Standard Schema types interface. */
+    interface Types<Input = unknown, Output = Input> {
+        /** The input type of the schema. */
+        readonly input: Input;
+        /** The output type of the schema. */
+        readonly output: Output;
+    }
+    /** Infers the input type of a Standard Schema. */
+    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+    /** Infers the output type of a Standard Schema. */
+    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+}
+
+interface Adapter<State> {
+    get(this: void, //
+    raw?: any, ctx?: any): State | undefined | Promise<State | undefined>;
+    set(this: void, //
+    value: State, ctx?: any): void | Promise<void>;
+}
+interface DisposableAdapter<State> extends Adapter<State> {
+    (): void;
+}
 interface StorageAdapter {
-    <State>(key: string, update: (raw?: any) => void): {
-        get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined;
-        set(value: State, ctx?: any): void;
-    };
+    <State>(key: string, update: (raw?: any) => void): Adapter<State> | DisposableAdapter<State>;
     keyArea?: any;
     noop?: boolean;
 }
 interface StorageAdapterFactory<AdapterConfig> {
-    (config?: AdapterConfig): StorageAdapter;
+    (config: AdapterConfig): StorageAdapter;
     factory: true;
 }
-type Contract<Data> = ((raw: unknown) => raw is Data) | {
-    isData: (raw: unknown) => raw is Data;
-    getErrorMessages: (raw: unknown) => string[];
-};
+type Contract<Data> = ((raw: unknown) => raw is Data) | StandardSchemaV1<unknown, Data> | Contract$1<unknown, Data>;
 type Done<State> = {
     key: string;
     keyPrefix: string;
@@ -39,13 +115,15 @@ type Fail<Err> = {
     error: Err;
     value?: any;
 };
-type Finally<State, Err> = (Done<State> & {
+type FinallyDone<State> = Done<State> & {
     status: 'done';
-}) | (Fail<Err> & {
+};
+type FinallyFail<Err> = Fail<Err> & {
     status: 'fail';
-});
+};
+type Finally<State, Err> = FinallyDone<State> | FinallyFail<Err>;
 interface ConfigPersist {
-    pickup?: Unit<any>;
+    pickup?: Unit<any> | Unit<any>[];
     context?: Unit<any>;
     keyPrefix?: string;
     contract?: Contract<any>;
@@ -58,21 +136,21 @@ interface ConfigAdapterFactory<AdapterConfig> {
 }
 interface ConfigCommon<State, Err = Error> {
     clock?: Unit<any>;
-    done?: Unit<Done<State>>;
-    fail?: Unit<Fail<Err>>;
-    finally?: Unit<Finally<State, Err>>;
-    pickup?: Unit<any>;
+    done?: UnitTargetable<Done<State>>;
+    fail?: UnitTargetable<Fail<Err>>;
+    finally?: UnitTargetable<Finally<State, Err>>;
+    pickup?: Unit<any> | Unit<any>[];
     context?: Unit<any>;
     key?: string;
     keyPrefix?: string;
     contract?: Contract<State | undefined>;
 }
 interface ConfigJustStore<State> {
-    store: Store<State>;
+    store: StoreWritable<State>;
 }
 interface ConfigJustSourceTarget<State> {
     source: Store<State> | Event<State> | Effect<State, any, any>;
-    target: Store<State> | Event<State> | Effect<State, any, any>;
+    target: StoreWritable<State> | EventCallable<State> | Effect<State, any, any>;
 }
 interface ConfigStore<State, Err = Error> extends ConfigCommon<State, Err>, ConfigJustStore<State> {
 }
@@ -88,10 +166,11 @@ interface Persist {
 /**
  * Creates custom `persist`
  */
-declare function createPersist(defaults?: ConfigPersist): Persist;
+declare const createPersist: (defaults?: ConfigPersist) => Persist;
 /**
  * Default `persist`
  */
 declare const persist: Persist;
 
-export { type ConfigPersist, type ConfigSourceTarget, type ConfigStore, type Contract, type Done, type Fail, type Finally, type Persist, type StorageAdapter, type StorageAdapterFactory, createPersist, persist };
+export { createPersist, persist };
+export type { Adapter, ConfigPersist, ConfigSourceTarget, ConfigStore, Contract, DisposableAdapter, Done, Fail, Finally, Persist, StorageAdapter, StorageAdapterFactory };

package/index.d.ts

@@ -1,4 +1,4 @@
-import { Unit, Subscription, Store, Event, Effect } from 'effector';
+import { Unit, UnitTargetable, Store, Event, Effect, StoreWritable, EventCallable, Subscription } from 'effector';
 export { AsyncStorageConfig, asyncStorage } from './async-storage';
 export { BroadcastConfig, broadcast } from './broadcast';
 export { LocalStorageConfig, local } from './local';
@@ -10,22 +10,98 @@ export { SessionStorageConfig, session } from './session';
 export { StorageConfig, storage } from './storage';
 export { async, either, farcached } from './tools';
 
+/** The Contract interface. */
+interface Contract$1<Raw, Data extends Raw> {
+    /**
+     * Checks if Raw is Data
+     */
+    isData: (prepared: Raw) => prepared is Data;
+    /**
+     * - empty array is dedicated for valid response
+     * - array of string with validation erorrs for invalidDataError
+     */
+    getErrorMessages: (prepared: Raw) => string[];
+}
+
+/** The Standard Schema interface. */
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+    /** The Standard Schema properties. */
+    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+declare namespace StandardSchemaV1 {
+    /** The Standard Schema properties interface. */
+    interface Props<Input = unknown, Output = Input> {
+        /** The version number of the standard. */
+        readonly version: 1;
+        /** The vendor name of the schema library. */
+        readonly vendor: string;
+        /** Validates unknown input values. */
+        readonly validate: (value: unknown, options?: StandardSchemaV1.Options | undefined) => Result<Output> | Promise<Result<Output>>;
+        /** Inferred types associated with the schema. */
+        readonly types?: Types<Input, Output> | undefined;
+    }
+    /** The result interface of the validate function. */
+    type Result<Output> = SuccessResult<Output> | FailureResult;
+    /** The result interface if validation succeeds. */
+    interface SuccessResult<Output> {
+        /** The typed output value. */
+        readonly value: Output;
+        /** A falsy value for `issues` indicates success. */
+        readonly issues?: undefined;
+    }
+    interface Options {
+        /** Explicit support for additional vendor-specific parameters, if needed. */
+        readonly libraryOptions?: Record<string, unknown> | undefined;
+    }
+    /** The result interface if validation fails. */
+    interface FailureResult {
+        /** The issues of failed validation. */
+        readonly issues: ReadonlyArray<Issue>;
+    }
+    /** The issue interface of the failure output. */
+    interface Issue {
+        /** The error message of the issue. */
+        readonly message: string;
+        /** The path of the issue, if any. */
+        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
+    }
+    /** The path segment interface of the issue. */
+    interface PathSegment {
+        /** The key representing a path segment. */
+        readonly key: PropertyKey;
+    }
+    /** The Standard Schema types interface. */
+    interface Types<Input = unknown, Output = Input> {
+        /** The input type of the schema. */
+        readonly input: Input;
+        /** The output type of the schema. */
+        readonly output: Output;
+    }
+    /** Infers the input type of a Standard Schema. */
+    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+    /** Infers the output type of a Standard Schema. */
+    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+}
+
+interface Adapter<State> {
+    get(this: void, //
+    raw?: any, ctx?: any): State | undefined | Promise<State | undefined>;
+    set(this: void, //
+    value: State, ctx?: any): void | Promise<void>;
+}
+interface DisposableAdapter<State> extends Adapter<State> {
+    (): void;
+}
 interface StorageAdapter {
-    <State>(key: string, update: (raw?: any) => void): {
-        get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined;
-        set(value: State, ctx?: any): void;
-    };
+    <State>(key: string, update: (raw?: any) => void): Adapter<State> | DisposableAdapter<State>;
     keyArea?: any;
     noop?: boolean;
 }
 interface StorageAdapterFactory<AdapterConfig> {
-    (config?: AdapterConfig): StorageAdapter;
+    (config: AdapterConfig): StorageAdapter;
     factory: true;
 }
-type Contract<Data> = ((raw: unknown) => raw is Data) | {
-    isData: (raw: unknown) => raw is Data;
-    getErrorMessages: (raw: unknown) => string[];
-};
+type Contract<Data> = ((raw: unknown) => raw is Data) | StandardSchemaV1<unknown, Data> | Contract$1<unknown, Data>;
 type Done<State> = {
     key: string;
     keyPrefix: string;
@@ -39,13 +115,15 @@ type Fail<Err> = {
     error: Err;
     value?: any;
 };
-type Finally<State, Err> = (Done<State> & {
+type FinallyDone<State> = Done<State> & {
     status: 'done';
-}) | (Fail<Err> & {
+};
+type FinallyFail<Err> = Fail<Err> & {
     status: 'fail';
-});
+};
+type Finally<State, Err> = FinallyDone<State> | FinallyFail<Err>;
 interface ConfigPersist {
-    pickup?: Unit<any>;
+    pickup?: Unit<any> | Unit<any>[];
     context?: Unit<any>;
     keyPrefix?: string;
     contract?: Contract<any>;
@@ -58,21 +136,21 @@ interface ConfigAdapterFactory<AdapterConfig> {
 }
 interface ConfigCommon<State, Err = Error> {
     clock?: Unit<any>;
-    done?: Unit<Done<State>>;
-    fail?: Unit<Fail<Err>>;
-    finally?: Unit<Finally<State, Err>>;
-    pickup?: Unit<any>;
+    done?: UnitTargetable<Done<State>>;
+    fail?: UnitTargetable<Fail<Err>>;
+    finally?: UnitTargetable<Finally<State, Err>>;
+    pickup?: Unit<any> | Unit<any>[];
     context?: Unit<any>;
     key?: string;
     keyPrefix?: string;
     contract?: Contract<State | undefined>;
 }
 interface ConfigJustStore<State> {
-    store: Store<State>;
+    store: StoreWritable<State>;
 }
 interface ConfigJustSourceTarget<State> {
     source: Store<State> | Event<State> | Effect<State, any, any>;
-    target: Store<State> | Event<State> | Effect<State, any, any>;
+    target: StoreWritable<State> | EventCallable<State> | Effect<State, any, any>;
 }
 interface ConfigStore<State, Err = Error> extends ConfigCommon<State, Err>, ConfigJustStore<State> {
 }
@@ -88,10 +166,11 @@ interface Persist {
 /**
  * Creates custom `persist`
  */
-declare function createPersist(defaults?: ConfigPersist): Persist;
+declare const createPersist: (defaults?: ConfigPersist) => Persist;
 /**
  * Default `persist`
  */
 declare const persist: Persist;
 
-export { type ConfigPersist, type ConfigSourceTarget, type ConfigStore, type Contract, type Done, type Fail, type Finally, type Persist, type StorageAdapter, type StorageAdapterFactory, createPersist, persist };
+export { createPersist, persist };
+export type { Adapter, ConfigPersist, ConfigSourceTarget, ConfigStore, Contract, DisposableAdapter, Done, Fail, Finally, Persist, StorageAdapter, StorageAdapterFactory };

package/index.js

@@ -1,2 +1,2 @@
-import{persist as o}from"./core/index.js";export{asyncStorage}from"./async-storage/index.js";export{broadcast}from"./broadcast/index.js";export{local}from"./local/index.js";export{log}from"./log/index.js";export{memory}from"./memory/index.js";export{nil}from"./nil/index.js";export{query}from"./query/index.js";export{session}from"./session/index.js";export{storage}from"./storage/index.js";export{async,either,farcached}from"./tools/index.js";function r(r){return e=>o({...r,...e})}var e=o;export{r as createPersist,e as persist};
+import{persist as o}from"./core/index.js";export{asyncStorage}from"./async-storage/index.js";export{broadcast}from"./broadcast/index.js";export{local}from"./local/index.js";export{log}from"./log/index.js";export{memory}from"./memory/index.js";export{nil}from"./nil/index.js";export{query}from"./query/index.js";export{session}from"./session/index.js";export{storage}from"./storage/index.js";export{async,either,farcached}from"./tools/index.js";var r=r=>e=>o({...r,...e}),e=o;export{r as createPersist,e as persist};
 //# sourceMappingURL=index.js.map

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  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 { BroadcastConfig } from './broadcast'\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 { broadcast } from './broadcast'\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":"4bAiDO,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 basePersist } from './core'\n\nexport type {\n  Adapter,\n  ConfigPersist,\n  ConfigSourceTarget,\n  ConfigStore,\n  Contract,\n  DisposableAdapter,\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 { BroadcastConfig } from './broadcast'\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'\nexport { asyncStorage } from './async-storage'\nexport { broadcast } from './broadcast'\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 const createPersist =\n  (defaults?: ConfigPersist): Persist =>\n  (config: any) =>\n    basePersist({\n      ...defaults,\n      ...config,\n    })\n\n/**\n * Default `persist`\n */\nexport const persist: Persist = basePersist\n"],"names":["createPersist","defaults","config","basePersist","persist"],"mappings":"4bAkDO,IAAMA,EACVC,GACAC,GACCC,EAAY,IACPF,KACAC,IAMIE,EAAmBD"}

package/local/index.cjs

@@ -1,2 +1,2 @@
-"use strict";var e=require("../core/index.cjs"),r=require("../nil/index.cjs"),t=require("../storage/index.cjs");function n(e){return function(){try{return"undefined"!=typeof localStorage}catch(e){return!0}}()?t.storage({storage:()=>localStorage,sync:!0,...e}):r.nil({keyArea:"local"})}function o(r){return t=>e.persist({adapter:n,...r,...t})}n.factory=!0;var s=o();exports.createPersist=o,exports.local=n,exports.persist=s;
+"use strict";var e=require("../core/index.cjs"),r=require("../nil/index.cjs"),t=require("../storage/index.cjs"),s=e=>(()=>{try{return"undefined"!=typeof localStorage}catch(e){return!0}})()?t.storage({storage:()=>localStorage,sync:!0,...e}):r.nil({keyArea:"local"});s.factory=!0;var a=r=>t=>e.persist({adapter:s,...r,...t}),o=/*#__PURE__*/a();exports.createPersist=a,exports.local=s,exports.persist=o;
 //# sourceMappingURL=index.cjs.map

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  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"}
+{"version":3,"file":"index.cjs","sources":["../../src/local/index.ts"],"sourcesContent":["import type { Subscription } from 'effector'\nimport type {\n  ConfigPersist as BaseConfigPersist,\n  ConfigSourceTarget as BaseConfigSourceTarget,\n  ConfigStore as BaseConfigStore,\n  StorageAdapterFactory,\n} from '../types'\nimport { persist as base } from '../core'\nimport { nil } from '../nil'\nimport { storage } from '../storage'\n\nexport type {\n  Adapter,\n  Contract,\n  DisposableAdapter,\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 */\nconst 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 */\nexport const local: StorageAdapterFactory<\n  LocalStorageConfig | undefined | void\n> = (config) => {\n  return supports()\n    ? storage({\n        storage: () => localStorage,\n        sync: true,\n        ...config,\n      })\n    : nil({ keyArea: 'local' })\n}\n\n// mark as factory\nlocal.factory = true\n\n/**\n * Creates custom partially applied `persist`\n * with predefined `localStorage` adapter\n */\nexport const createPersist =\n  (defaults?: ConfigPersist): Persist =>\n  (config) =>\n    base({\n      adapter: local,\n      ...defaults,\n      ...config,\n    })\n\n/**\n * Default partially applied `persist`\n */\nexport const persist: Persist = /*#__PURE__*/ createPersist()\n"],"names":["local","config","supports","localStorage","_error","storage","sync","nil","keyArea","factory","createPersist","defaults","base","adapter","persist"],"mappings":"gHAgEaA,EAERC,GAfYC,MACf,IACE,MAA+B,oBAAjBC,YAChB,CAAE,MAAOC,GAGP,OAAO,CACT,GASOF,GACHG,UAAQ,CACNA,QAASA,IAAMF,aACfG,MAAM,KACHL,IAELM,EAAAA,IAAI,CAAEC,QAAS,UAIrBR,EAAMS,SAAU,EAMT,IAAMC,EACVC,GACAV,GACCW,UAAK,CACHC,QAASb,KACNW,KACAV,IAMIa,eAAiCJ"}

package/local/index.d.cts

@@ -1,21 +1,97 @@
-import { Unit, Store, Event, Effect, Subscription } from 'effector';
+import { Unit, UnitTargetable, Store, Event, Effect, StoreWritable, EventCallable, Subscription } from 'effector';
 
+/** The Contract interface. */
+interface Contract$1<Raw, Data extends Raw> {
+    /**
+     * Checks if Raw is Data
+     */
+    isData: (prepared: Raw) => prepared is Data;
+    /**
+     * - empty array is dedicated for valid response
+     * - array of string with validation erorrs for invalidDataError
+     */
+    getErrorMessages: (prepared: Raw) => string[];
+}
+
+/** The Standard Schema interface. */
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+    /** The Standard Schema properties. */
+    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
+}
+declare namespace StandardSchemaV1 {
+    /** The Standard Schema properties interface. */
+    interface Props<Input = unknown, Output = Input> {
+        /** The version number of the standard. */
+        readonly version: 1;
+        /** The vendor name of the schema library. */
+        readonly vendor: string;
+        /** Validates unknown input values. */
+        readonly validate: (value: unknown, options?: StandardSchemaV1.Options | undefined) => Result<Output> | Promise<Result<Output>>;
+        /** Inferred types associated with the schema. */
+        readonly types?: Types<Input, Output> | undefined;
+    }
+    /** The result interface of the validate function. */
+    type Result<Output> = SuccessResult<Output> | FailureResult;
+    /** The result interface if validation succeeds. */
+    interface SuccessResult<Output> {
+        /** The typed output value. */
+        readonly value: Output;
+        /** A falsy value for `issues` indicates success. */
+        readonly issues?: undefined;
+    }
+    interface Options {
+        /** Explicit support for additional vendor-specific parameters, if needed. */
+        readonly libraryOptions?: Record<string, unknown> | undefined;
+    }
+    /** The result interface if validation fails. */
+    interface FailureResult {
+        /** The issues of failed validation. */
+        readonly issues: ReadonlyArray<Issue>;
+    }
+    /** The issue interface of the failure output. */
+    interface Issue {
+        /** The error message of the issue. */
+        readonly message: string;
+        /** The path of the issue, if any. */
+        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
+    }
+    /** The path segment interface of the issue. */
+    interface PathSegment {
+        /** The key representing a path segment. */
+        readonly key: PropertyKey;
+    }
+    /** The Standard Schema types interface. */
+    interface Types<Input = unknown, Output = Input> {
+        /** The input type of the schema. */
+        readonly input: Input;
+        /** The output type of the schema. */
+        readonly output: Output;
+    }
+    /** Infers the input type of a Standard Schema. */
+    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+    /** Infers the output type of a Standard Schema. */
+    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+}
+
+interface Adapter<State> {
+    get(this: void, //
+    raw?: any, ctx?: any): State | undefined | Promise<State | undefined>;
+    set(this: void, //
+    value: State, ctx?: any): void | Promise<void>;
+}
+interface DisposableAdapter<State> extends Adapter<State> {
+    (): void;
+}
 interface StorageAdapter {
-    <State>(key: string, update: (raw?: any) => void): {
-        get(raw?: any, ctx?: any): State | Promise<State | undefined> | undefined;
-        set(value: State, ctx?: any): void;
-    };
+    <State>(key: string, update: (raw?: any) => void): Adapter<State> | DisposableAdapter<State>;
     keyArea?: any;
     noop?: boolean;
 }
 interface StorageAdapterFactory<AdapterConfig> {
-    (config?: AdapterConfig): StorageAdapter;
+    (config: AdapterConfig): StorageAdapter;
     factory: true;
 }
-type Contract<Data> = ((raw: unknown) => raw is Data) | {
-    isData: (raw: unknown) => raw is Data;
-    getErrorMessages: (raw: unknown) => string[];
-};
+type Contract<Data> = ((raw: unknown) => raw is Data) | StandardSchemaV1<unknown, Data> | Contract$1<unknown, Data>;
 type Done<State> = {
     key: string;
     keyPrefix: string;
@@ -29,34 +105,36 @@ type Fail<Err> = {
     error: Err;
     value?: any;
 };
-type Finally<State, Err> = (Done<State> & {
+type FinallyDone<State> = Done<State> & {
     status: 'done';
-}) | (Fail<Err> & {
+};
+type FinallyFail<Err> = Fail<Err> & {
     status: 'fail';
-});
+};
+type Finally<State, Err> = FinallyDone<State> | FinallyFail<Err>;
 interface ConfigPersist$1 {
-    pickup?: Unit<any>;
+    pickup?: Unit<any> | 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>;
+    done?: UnitTargetable<Done<State>>;
+    fail?: UnitTargetable<Fail<Err>>;
+    finally?: UnitTargetable<Finally<State, Err>>;
+    pickup?: Unit<any> | Unit<any>[];
     context?: Unit<any>;
     key?: string;
     keyPrefix?: string;
     contract?: Contract<State | undefined>;
 }
 interface ConfigJustStore<State> {
-    store: Store<State>;
+    store: StoreWritable<State>;
 }
 interface ConfigJustSourceTarget<State> {
     source: Store<State> | Event<State> | Effect<State, any, any>;
-    target: Store<State> | Event<State> | Effect<State, any, any>;
+    target: StoreWritable<State> | EventCallable<State> | Effect<State, any, any>;
 }
 interface ConfigStore$1<State, Err = Error> extends ConfigCommon<State, Err>, ConfigJustStore<State> {
 }
@@ -82,18 +160,19 @@ interface Persist {
     <State, Err = Error>(config: ConfigSourceTarget<State, Err>): Subscription;
     <State, Err = Error>(config: ConfigStore<State, Err>): Subscription;
 }
-declare function local(config?: LocalStorageConfig): StorageAdapter;
-declare namespace local {
-    var factory: true;
-}
+/**
+ * Creates `localStorage` adapter
+ */
+declare const local: StorageAdapterFactory<LocalStorageConfig | undefined | void>;
 /**
  * Creates custom partially applied `persist`
  * with predefined `localStorage` adapter
  */
-declare function createPersist(defaults?: ConfigPersist): Persist;
+declare const createPersist: (defaults?: ConfigPersist) => Persist;
 /**
  * Default partially applied `persist`
  */
 declare const persist: Persist;
 
-export { type ConfigPersist, type ConfigSourceTarget, type ConfigStore, type Contract, type Done, type Fail, type Finally, type LocalStorageConfig, type Persist, type StorageAdapter, type StorageAdapterFactory, createPersist, local, persist };
+export { createPersist, local, persist };
+export type { Adapter, ConfigPersist, ConfigSourceTarget, ConfigStore, Contract, DisposableAdapter, Done, Fail, Finally, LocalStorageConfig, Persist, StorageAdapter, StorageAdapterFactory };