@virentia/effector 0.1.1 → 0.2.0

package/dist/index.d.cts

@@ -1,188 +1,36 @@
-import * as core from "@virentia/core";
-import { EventPayload, Scope as Scope$1 } from "@virentia/core";
+import * as virentia from "@virentia/core";
+import { Effect, EventCallable, Scope, Unit, UnitTargetable } from "effector";
 
-//#region lib/types.d.ts
-declare const unitKind: unique symbol;
-type Unsubscribe = () => void;
-interface Scope {
-  readonly __core: Scope$1;
-  getState<T>(store: Store<T>): T;
-}
-interface Unit<T = unknown> {
-  readonly [unitKind]: UnitKind;
-  readonly node: core.Node;
-  readonly shortName: string;
-  getType(): string;
-  watch(fn: (payload: T) => void): Unsubscribe;
-}
-interface Event<T = void> extends Unit<T> {
-  map<Next>(fn: (payload: T) => Next): Event<Next>;
-  filter(config: {
-    fn(payload: T): boolean;
-  } | ((payload: T) => boolean)): Event<T>;
-  filterMap<Next>(fn: (payload: T) => Next | undefined): Event<Next>;
-  prepend<Before>(fn: (payload: Before) => T): EventCallable<Before>;
+//#region lib/index.d.ts
+interface EffectorCompatibilityOptions {
+  name?: string;
 }
-interface EventCallable<T = void> extends Event<T> {
-  (...payload: EventPayload<T>): Promise<void>;
+interface EffectorAssociationConfig {
+  virentia: virentia.Scope;
+  effector: Scope;
 }
-interface Store<T> extends Unit<T> {
-  readonly updates: Event<T>;
-  readonly sid?: string;
-  defaultState: T;
-  getState(scope?: Scope): T;
-  map<Next>(fn: (state: T) => Next): Store<Next>;
-  on<Payload>(trigger: Unit<Payload>, reducer: (state: T, payload: Payload) => T): Store<T>;
-  reset(trigger: Unit<any> | readonly Unit<any>[]): Store<T>;
+interface EffectorAssociationLookup {
+  virentia?: virentia.Scope;
+  effector?: Scope;
 }
-interface StoreWritable<T> extends Store<T> {
-  setState(value: T, scope?: Scope): void;
-  on<Payload>(trigger: Unit<Payload>, reducer: (state: T, payload: Payload) => T): StoreWritable<T>;
-  reset(trigger: Unit<any> | readonly Unit<any>[]): StoreWritable<T>;
+type EffectorPayloadMap<From, To> = (payload: From) => To;
+type EffectorCompatibilityUnsubscribe = () => void;
+interface EffectorAssociation {
+  dispose(): void;
 }
-interface Effect<Params, Done, Fail = Error> extends Unit<Params> {
-  (...params: EventPayload<Params>): Promise<Done>;
-  readonly done: Event<{
-    params: Params;
-    result: Done;
-  }>;
-  readonly fail: Event<{
-    params: Params;
-    error: Fail;
-  }>;
-  readonly finally: Event<{
-    status: "done";
-    params: Params;
-    result: Done;
-  } | {
-    status: "fail";
-    params: Params;
-    error: Fail;
-  }>;
-  readonly doneData: Event<Done>;
-  readonly failData: Event<Fail>;
-  readonly pending: Store<boolean>;
-  readonly inFlight: Store<number>;
-  prepend<Before>(fn: (payload: Before) => Params): EventCallable<Before>;
-  use: {
-    (handler: (params: Params) => Done | PromiseLike<Done>): Effect<Params, Done, Fail>;
-    getCurrent(): (params: Params) => Done | PromiseLike<Done>;
-  };
+interface EffectorCompatibility {
+  associate(config: EffectorAssociationConfig): EffectorAssociation;
+  ensureAssociation(config?: EffectorAssociationLookup): EffectorAssociation;
+  link<From, To = From>(from: Unit<From> | VirentiaUnit<From>, to: UnitTargetable<To> | VirentiaTarget<To>, map?: EffectorPayloadMap<From, To>): EffectorCompatibilityUnsubscribe;
+  asEffector<T>(unit: virentia.Effect<T, any, any>): Effect<T, any, unknown>;
+  asEffector<T>(unit: VirentiaUnit<T>): EventCallable<T>;
+  asEffector<T>(unit: Unit<T>): Unit<T>;
+  asVirentia<T>(unit: VirentiaUnit<T>): VirentiaUnit<T>;
+  asVirentia<T>(unit: Effect<T, any, any>): virentia.Effect<T, any, unknown>;
+  asVirentia<T>(unit: Unit<T>): virentia.EventCallable<T>;
 }
-type UnitKind = "event" | "store" | "effect";
-type AnyUnit = Event<any> | Store<any> | Effect<any, any, any>;
-type UnitTargetable<T = any> = EventCallable<T> | StoreWritable<T> | Effect<T, any, any>;
-type UnitTarget<T> = Unit<T> | readonly Unit<T>[];
-type SourceShape = Store<any> | readonly Store<any>[] | Record<string, Store<any>>;
-type SourceValue<Source> = Source extends Store<infer Value> ? Value : Source extends readonly unknown[] ? { [Key in keyof Source]: Source[Key] extends Store<infer Value> ? Value : never } : Source extends Record<string, Store<any>> ? { [Key in keyof Source]: Source[Key] extends Store<infer Value> ? Value : never } : never;
-type StoreValues = Record<string, unknown> | ReadonlyMap<StoreWritable<any> | string, unknown> | readonly (readonly [StoreWritable<any>, unknown])[];
-//#endregion
-//#region lib/attach.d.ts
-declare function attach<Params, Done, Fail>(config: {
-  effect: Effect<Params, Done, Fail>;
-  name?: string;
-}): Effect<Params, Done, Fail>;
-declare function attach<Params, Done, Fail = Error>(config: {
-  effect(params: Params): Done | PromiseLike<Done>;
-  name?: string;
-}): Effect<Params, Done, Fail>;
-declare function attach<Params, Done, Fail, AttachedParams>(config: {
-  effect: Effect<Params, Done, Fail>;
-  mapParams(params: AttachedParams): Params;
-  name?: string;
-}): Effect<AttachedParams, Done, Fail>;
-declare function attach<Source extends SourceShape, Params, Done, Fail>(config: {
-  source: Source;
-  effect: Effect<Params, Done, Fail>;
-  name?: string;
-}): Effect<Params, Done, Fail>;
-declare function attach<Source extends SourceShape, Params, Done, Fail, AttachedParams>(config: {
-  source: Source;
-  effect: Effect<Params, Done, Fail>;
-  mapParams(params: AttachedParams, source: SourceValue<Source>): Params;
-  name?: string;
-}): Effect<AttachedParams, Done, Fail>;
-declare function attach<Source extends SourceShape, Params, Done, Fail = Error>(config: {
-  source: Source;
-  effect(source: SourceValue<Source>, params: Params): Done | PromiseLike<Done>;
-  name?: string;
-}): Effect<Params, Done, Fail>;
-//#endregion
-//#region lib/effect.d.ts
-declare function createEffect<Params = void, Done = void, Fail = Error>(handlerOrConfig?: ((params: Params) => Done | PromiseLike<Done>) | {
-  name?: string;
-  handler?: (params: Params) => Done | PromiseLike<Done>;
-}): Effect<Params, Done, Fail>;
-//#endregion
-//#region lib/event.d.ts
-declare function createEvent<T = void>(nameOrConfig?: string | {
-  name?: string;
-}): EventCallable<T>;
-//#endregion
-//#region lib/guards.d.ts
-declare const is: {
-  unit(value: unknown): value is AnyUnit;
-  event(value: unknown): value is Event<any>;
-  store(value: unknown): value is Store<any>;
-  effect(value: unknown): value is Effect<any, any, any>;
-  targetable(value: unknown): value is UnitTargetable;
-};
-//#endregion
-//#region lib/operators.d.ts
-declare function sample(config: {
-  clock?: AnyUnit | readonly AnyUnit[];
-  source?: SourceShape;
-  filter?: Store<boolean> | ((source: any, clock: any) => boolean);
-  fn?: (source: any, clock: any) => any;
-  target?: UnitTarget<any>;
-}): AnyUnit;
-declare function combine(shape: SourceShape, fn?: (value: any) => any): Store<any>;
-declare function combine(...args: any[]): Store<any>;
-declare function split<T>(source: Unit<T>, cases: Record<string, (payload: T) => boolean>): Record<string, Event<T>>;
-declare function split<T>(config: {
-  source: Unit<T>;
-  match: ((payload: T) => string) | Record<string, (payload: T) => boolean>;
-  cases?: Record<string, Event<T>>;
-}): Record<string, Event<T>>;
-declare function createApi<T, Shape extends Record<string, (state: T, payload: any) => T>>(store: StoreWritable<T>, reducers: Shape): { [Key in keyof Shape]: EventCallable<Parameters<Shape[Key]>[1]> };
-declare function restore<T>(unit: Event<T> | Effect<any, T, any>, defaultState: T): StoreWritable<T>;
-//#endregion
-//#region lib/persistence.d.ts
-declare function serialize(scope: Scope, config?: {
-  onlyChanges?: boolean;
-  ignore?: readonly (Store<any> | string)[];
-}): Record<string, unknown>;
-declare function hydrate(scope: Scope, config: {
-  values: StoreValues;
-}): void;
-//#endregion
-//#region lib/scope.d.ts
-declare function fork(config?: {
-  values?: StoreValues;
-}): Scope;
-declare function allSettled<T>(unit: Event<T> | StoreWritable<T>, options?: {
-  scope?: Scope;
-  params?: T;
-}): Promise<void>;
-declare function allSettled<Params, Done, Fail>(unit: Effect<Params, Done, Fail>, options?: {
-  scope?: Scope;
-  params?: Params;
-}): Promise<{
-  status: "done";
-  value: Done;
-} | {
-  status: "fail";
-  value: Fail;
-}>;
-declare function scopeBind<T>(unit: EventCallable<T> | Effect<T, any, any>, config?: {
-  scope?: Scope;
-}): (...payload: EventPayload<T>) => unknown;
-//#endregion
-//#region lib/store.d.ts
-declare function createStore<T>(defaultState: T, config?: {
-  name?: string;
-  sid?: string;
-  skipVoid?: boolean;
-}): StoreWritable<T>;
+type VirentiaUnit<T = unknown> = virentia.Event<T> | virentia.EventCallable<T> | virentia.Effect<T, any, any> | virentia.Store<T> | virentia.StoreWritable<T>;
+type VirentiaTarget<T = unknown> = virentia.EventCallable<T> | virentia.Effect<T, any, any> | virentia.StoreWritable<T>;
+declare function createEffectorCompatibility(_options?: EffectorCompatibilityOptions): EffectorCompatibility;
 //#endregion
-export { type Effect, type Event, type EventCallable, type Scope, type Store, type StoreWritable, type Unit, type Unsubscribe, allSettled, attach, combine, createApi, createEffect, createEvent, createStore, fork, hydrate, is, restore, sample, scopeBind, serialize, split };
+export { EffectorAssociation, EffectorAssociationConfig, EffectorAssociationLookup, EffectorCompatibility, EffectorCompatibilityOptions, EffectorCompatibilityUnsubscribe, EffectorPayloadMap, VirentiaTarget, VirentiaUnit, createEffectorCompatibility };

package/dist/index.d.mts

@@ -1,188 +1,36 @@
-import * as core from "@virentia/core";
-import { EventPayload, Scope as Scope$1 } from "@virentia/core";
+import * as virentia from "@virentia/core";
+import { Effect, EventCallable, Scope, Unit, UnitTargetable } from "effector";
 
-//#region lib/types.d.ts
-declare const unitKind: unique symbol;
-type Unsubscribe = () => void;
-interface Scope {
-  readonly __core: Scope$1;
-  getState<T>(store: Store<T>): T;
-}
-interface Unit<T = unknown> {
-  readonly [unitKind]: UnitKind;
-  readonly node: core.Node;
-  readonly shortName: string;
-  getType(): string;
-  watch(fn: (payload: T) => void): Unsubscribe;
-}
-interface Event<T = void> extends Unit<T> {
-  map<Next>(fn: (payload: T) => Next): Event<Next>;
-  filter(config: {
-    fn(payload: T): boolean;
-  } | ((payload: T) => boolean)): Event<T>;
-  filterMap<Next>(fn: (payload: T) => Next | undefined): Event<Next>;
-  prepend<Before>(fn: (payload: Before) => T): EventCallable<Before>;
+//#region lib/index.d.ts
+interface EffectorCompatibilityOptions {
+  name?: string;
 }
-interface EventCallable<T = void> extends Event<T> {
-  (...payload: EventPayload<T>): Promise<void>;
+interface EffectorAssociationConfig {
+  virentia: virentia.Scope;
+  effector: Scope;
 }
-interface Store<T> extends Unit<T> {
-  readonly updates: Event<T>;
-  readonly sid?: string;
-  defaultState: T;
-  getState(scope?: Scope): T;
-  map<Next>(fn: (state: T) => Next): Store<Next>;
-  on<Payload>(trigger: Unit<Payload>, reducer: (state: T, payload: Payload) => T): Store<T>;
-  reset(trigger: Unit<any> | readonly Unit<any>[]): Store<T>;
+interface EffectorAssociationLookup {
+  virentia?: virentia.Scope;
+  effector?: Scope;
 }
-interface StoreWritable<T> extends Store<T> {
-  setState(value: T, scope?: Scope): void;
-  on<Payload>(trigger: Unit<Payload>, reducer: (state: T, payload: Payload) => T): StoreWritable<T>;
-  reset(trigger: Unit<any> | readonly Unit<any>[]): StoreWritable<T>;
+type EffectorPayloadMap<From, To> = (payload: From) => To;
+type EffectorCompatibilityUnsubscribe = () => void;
+interface EffectorAssociation {
+  dispose(): void;
 }
-interface Effect<Params, Done, Fail = Error> extends Unit<Params> {
-  (...params: EventPayload<Params>): Promise<Done>;
-  readonly done: Event<{
-    params: Params;
-    result: Done;
-  }>;
-  readonly fail: Event<{
-    params: Params;
-    error: Fail;
-  }>;
-  readonly finally: Event<{
-    status: "done";
-    params: Params;
-    result: Done;
-  } | {
-    status: "fail";
-    params: Params;
-    error: Fail;
-  }>;
-  readonly doneData: Event<Done>;
-  readonly failData: Event<Fail>;
-  readonly pending: Store<boolean>;
-  readonly inFlight: Store<number>;
-  prepend<Before>(fn: (payload: Before) => Params): EventCallable<Before>;
-  use: {
-    (handler: (params: Params) => Done | PromiseLike<Done>): Effect<Params, Done, Fail>;
-    getCurrent(): (params: Params) => Done | PromiseLike<Done>;
-  };
+interface EffectorCompatibility {
+  associate(config: EffectorAssociationConfig): EffectorAssociation;
+  ensureAssociation(config?: EffectorAssociationLookup): EffectorAssociation;
+  link<From, To = From>(from: Unit<From> | VirentiaUnit<From>, to: UnitTargetable<To> | VirentiaTarget<To>, map?: EffectorPayloadMap<From, To>): EffectorCompatibilityUnsubscribe;
+  asEffector<T>(unit: virentia.Effect<T, any, any>): Effect<T, any, unknown>;
+  asEffector<T>(unit: VirentiaUnit<T>): EventCallable<T>;
+  asEffector<T>(unit: Unit<T>): Unit<T>;
+  asVirentia<T>(unit: VirentiaUnit<T>): VirentiaUnit<T>;
+  asVirentia<T>(unit: Effect<T, any, any>): virentia.Effect<T, any, unknown>;
+  asVirentia<T>(unit: Unit<T>): virentia.EventCallable<T>;
 }
-type UnitKind = "event" | "store" | "effect";
-type AnyUnit = Event<any> | Store<any> | Effect<any, any, any>;
-type UnitTargetable<T = any> = EventCallable<T> | StoreWritable<T> | Effect<T, any, any>;
-type UnitTarget<T> = Unit<T> | readonly Unit<T>[];
-type SourceShape = Store<any> | readonly Store<any>[] | Record<string, Store<any>>;
-type SourceValue<Source> = Source extends Store<infer Value> ? Value : Source extends readonly unknown[] ? { [Key in keyof Source]: Source[Key] extends Store<infer Value> ? Value : never } : Source extends Record<string, Store<any>> ? { [Key in keyof Source]: Source[Key] extends Store<infer Value> ? Value : never } : never;
-type StoreValues = Record<string, unknown> | ReadonlyMap<StoreWritable<any> | string, unknown> | readonly (readonly [StoreWritable<any>, unknown])[];
-//#endregion
-//#region lib/attach.d.ts
-declare function attach<Params, Done, Fail>(config: {
-  effect: Effect<Params, Done, Fail>;
-  name?: string;
-}): Effect<Params, Done, Fail>;
-declare function attach<Params, Done, Fail = Error>(config: {
-  effect(params: Params): Done | PromiseLike<Done>;
-  name?: string;
-}): Effect<Params, Done, Fail>;
-declare function attach<Params, Done, Fail, AttachedParams>(config: {
-  effect: Effect<Params, Done, Fail>;
-  mapParams(params: AttachedParams): Params;
-  name?: string;
-}): Effect<AttachedParams, Done, Fail>;
-declare function attach<Source extends SourceShape, Params, Done, Fail>(config: {
-  source: Source;
-  effect: Effect<Params, Done, Fail>;
-  name?: string;
-}): Effect<Params, Done, Fail>;
-declare function attach<Source extends SourceShape, Params, Done, Fail, AttachedParams>(config: {
-  source: Source;
-  effect: Effect<Params, Done, Fail>;
-  mapParams(params: AttachedParams, source: SourceValue<Source>): Params;
-  name?: string;
-}): Effect<AttachedParams, Done, Fail>;
-declare function attach<Source extends SourceShape, Params, Done, Fail = Error>(config: {
-  source: Source;
-  effect(source: SourceValue<Source>, params: Params): Done | PromiseLike<Done>;
-  name?: string;
-}): Effect<Params, Done, Fail>;
-//#endregion
-//#region lib/effect.d.ts
-declare function createEffect<Params = void, Done = void, Fail = Error>(handlerOrConfig?: ((params: Params) => Done | PromiseLike<Done>) | {
-  name?: string;
-  handler?: (params: Params) => Done | PromiseLike<Done>;
-}): Effect<Params, Done, Fail>;
-//#endregion
-//#region lib/event.d.ts
-declare function createEvent<T = void>(nameOrConfig?: string | {
-  name?: string;
-}): EventCallable<T>;
-//#endregion
-//#region lib/guards.d.ts
-declare const is: {
-  unit(value: unknown): value is AnyUnit;
-  event(value: unknown): value is Event<any>;
-  store(value: unknown): value is Store<any>;
-  effect(value: unknown): value is Effect<any, any, any>;
-  targetable(value: unknown): value is UnitTargetable;
-};
-//#endregion
-//#region lib/operators.d.ts
-declare function sample(config: {
-  clock?: AnyUnit | readonly AnyUnit[];
-  source?: SourceShape;
-  filter?: Store<boolean> | ((source: any, clock: any) => boolean);
-  fn?: (source: any, clock: any) => any;
-  target?: UnitTarget<any>;
-}): AnyUnit;
-declare function combine(shape: SourceShape, fn?: (value: any) => any): Store<any>;
-declare function combine(...args: any[]): Store<any>;
-declare function split<T>(source: Unit<T>, cases: Record<string, (payload: T) => boolean>): Record<string, Event<T>>;
-declare function split<T>(config: {
-  source: Unit<T>;
-  match: ((payload: T) => string) | Record<string, (payload: T) => boolean>;
-  cases?: Record<string, Event<T>>;
-}): Record<string, Event<T>>;
-declare function createApi<T, Shape extends Record<string, (state: T, payload: any) => T>>(store: StoreWritable<T>, reducers: Shape): { [Key in keyof Shape]: EventCallable<Parameters<Shape[Key]>[1]> };
-declare function restore<T>(unit: Event<T> | Effect<any, T, any>, defaultState: T): StoreWritable<T>;
-//#endregion
-//#region lib/persistence.d.ts
-declare function serialize(scope: Scope, config?: {
-  onlyChanges?: boolean;
-  ignore?: readonly (Store<any> | string)[];
-}): Record<string, unknown>;
-declare function hydrate(scope: Scope, config: {
-  values: StoreValues;
-}): void;
-//#endregion
-//#region lib/scope.d.ts
-declare function fork(config?: {
-  values?: StoreValues;
-}): Scope;
-declare function allSettled<T>(unit: Event<T> | StoreWritable<T>, options?: {
-  scope?: Scope;
-  params?: T;
-}): Promise<void>;
-declare function allSettled<Params, Done, Fail>(unit: Effect<Params, Done, Fail>, options?: {
-  scope?: Scope;
-  params?: Params;
-}): Promise<{
-  status: "done";
-  value: Done;
-} | {
-  status: "fail";
-  value: Fail;
-}>;
-declare function scopeBind<T>(unit: EventCallable<T> | Effect<T, any, any>, config?: {
-  scope?: Scope;
-}): (...payload: EventPayload<T>) => unknown;
-//#endregion
-//#region lib/store.d.ts
-declare function createStore<T>(defaultState: T, config?: {
-  name?: string;
-  sid?: string;
-  skipVoid?: boolean;
-}): StoreWritable<T>;
+type VirentiaUnit<T = unknown> = virentia.Event<T> | virentia.EventCallable<T> | virentia.Effect<T, any, any> | virentia.Store<T> | virentia.StoreWritable<T>;
+type VirentiaTarget<T = unknown> = virentia.EventCallable<T> | virentia.Effect<T, any, any> | virentia.StoreWritable<T>;
+declare function createEffectorCompatibility(_options?: EffectorCompatibilityOptions): EffectorCompatibility;
 //#endregion
-export { type Effect, type Event, type EventCallable, type Scope, type Store, type StoreWritable, type Unit, type Unsubscribe, allSettled, attach, combine, createApi, createEffect, createEvent, createStore, fork, hydrate, is, restore, sample, scopeBind, serialize, split };
+export { EffectorAssociation, EffectorAssociationConfig, EffectorAssociationLookup, EffectorCompatibility, EffectorCompatibilityOptions, EffectorCompatibilityUnsubscribe, EffectorPayloadMap, VirentiaTarget, VirentiaUnit, createEffectorCompatibility };