@cyysummer/projector 0.0.9 → 0.0.10

package/dist/index.js

@@ -1,7 +1,7 @@
 /**
-* @cyysummer/projector v0.0.9
+* @cyysummer/projector v0.0.10
 * (c) 2021-PRESENT Chris Liu
 * @license MIT
 **/
-import w from"on-change";import{cloneDeep as m,set as x}from"lodash-es";import{withEvents as v}from"@cyysummer/core";var f=class extends v(){constructor(t){super();this._paused=!1;this._shadow=m(t)}receive(t,r){if(this._paused)return;x(this._shadow,t,r);let o=[{path:t,value:r}];this.emit("record",{next:this._shadow,patches:o}),this._ensureProjector(),this._projector?.project(this._shadow,...o)}sendTo(t){typeof t=="function"?this._projectorFactory=t:this._projector=t}pause(){this._paused=!0}resume(){this._paused=!1}_ensureProjector(){!this._projector&&this._projectorFactory&&(this._projector=this._projectorFactory())}};import{get as p,keys as l}from"lodash-es";var S=n=>{},d=class{at(e){return(t,r)=>{let o=i(r);return t.execute(e,o)}}atWith(e,t){return(o,c)=>{let a=i(c),u=t(a);return o.execute(e,u)}}arrayAt(e,t){return(r,o)=>{let c=o.path?p(o.source,o.path):o.value;if(c&&Array.isArray(c)&&c.length>0){let a={keys:typeof c[0]=="object"?l(c[0]):[],resolveHeader:(u,s)=>String(u),...t};return r.executeArray(e,c,a)}}}arrayAtWith(e,t,r){return(o,c)=>{let a=c.path?p(c.source,c.path):c.value;if(a&&Array.isArray(a)&&a.length>0){let u=a.map(t),s={keys:typeof a[0]=="object"?l(a[0]):[],resolveHeader:(T,j)=>String(T),...r};return o.executeArray(e,u,s)}}}loop(e){return async(t,r)=>{let o=i(r);if(Array.isArray(o)){let c=o;for(let a=0;a<c.length;a++){let u=c[a],T=e(u,a)(t,{value:u});T instanceof Promise&&await T}}else throw new Error(`Effect: Value at path '${r.path}' is not an array.`)}}sourceWith(e,t){return(r,o)=>{let c=t(o.source);return r.execute(e,c)}}raw(e,t){return(r,o)=>r.execute(e,t)}sequence(e){return async(t,r)=>{let o=i(r);for(let c of e)await c(t,{value:o})}}sequenceWith(e,t){return async(o,c)=>{let a=i(c),u=t(a);for(let s of e)await s(o,{value:u})}}when(e,t,r=S){return(o,c)=>{let a=i(c);return(e(a)?t:r)(o,{value:a})}}whenFromSource(e,t,r=S){return(o,c)=>(e(c.source)?t:r)(o,c)}},i=n=>n.source&&n.path?p(n.source,n.path):n.value;var h=class{constructor(e){this._schema=e;if(!e)throw new Error("Projector: Schema is required.")}project(e,...t){for(let r of t)this._dispatch(e,r)}_dispatch(e,t){let{path:r,value:o}=t,c=this._resolveEffect(r);c&&(this._ensureScheduler(),this._scheduler.enqueue({path:r.join("."),effect:c,ctx:{source:e,path:r,value:o}}))}_ensureScheduler(){if(!this._scheduler)throw new Error("Projector: no scheduler.")}_resolveEffect(e){let t=this._schema;for(let r of e){if(!t)return null;t=t[r]}return typeof t=="function"?t:null}},g=class extends h{constructor(e,t){super(e),this._scheduler=t}},E=class extends h{scheduleWith(e){return typeof e=="function"?this._schedulerFactory=e:this._scheduler=e,this}_ensureScheduler(){if(!this._scheduler&&this._schedulerFactory&&(this._scheduler=this._schedulerFactory()),!this._scheduler)throw new Error("Projector: no scheduler.")}};import{debounce as b}from"lodash-es";var y=class{constructor(e){this._strategy=e;this._queue=new Map}enqueue(e){return this._queue.set(e.path,e),this}flush(){return this.checkStrategy(),log.trace("Scheduler.flush()",[...this._queue.keys()]),this.flushCore()}withStrategy(e){return typeof e=="function"?this._strategyFactory=e:this._strategy=e,this}checkStrategy(){if(!this._strategy&&this._strategyFactory&&(this._strategy=this._strategyFactory()),!this._strategy)throw new Error("Scheduler: target is not set")}async run(e){for(let t of e){let{effect:r,ctx:o}=t,c=r(this._strategy,o);c instanceof Promise&&await c}}},I=class extends y{constructor(t,r=500){super(t);this.timeout=r;this.flushCore=b(async()=>{let t=[...this._queue.values()];this._queue.clear(),this.run(t)},this.timeout)}},_=class extends y{async flushCore(){this._strategy.reset(),this.run([...this._queue.values()])}};function O(n){let e=new f(n);return[w(n,(r,o)=>e.receive(r,o),{pathAsArray:!0}),e]}export{E as DynamicProjector,d as EffectFactory,I as LazyScheduler,g as Projector,h as ProjectorBase,f as Recorder,y as Scheduler,_ as TotalScheduler,O as track};
+import L from"on-change";import{cloneDeep as x,set as w}from"lodash-es";import{withEvents as v}from"@cyysummer/core";var i=class extends v(){constructor(t){super();this._paused=!1;this._shadow=x(t)}receive(t,r){if(this._paused)return;w(this._shadow,t,r);let o=[{path:t,value:r}];this.emit("record",{next:this._shadow,patches:o}),this._ensureProjector(),this._projector?.project(this._shadow,...o)}sendTo(t){typeof t=="function"?this._projectorFactory=t:this._projector=t}pause(){this._paused=!0}resume(){this._paused=!1}_ensureProjector(){!this._projector&&this._projectorFactory&&(this._projector=this._projectorFactory())}};import F from"on-change";var l=class{constructor(e,t){this._schema=e;this._scheduler=t;if(!e)throw new Error("Projector: Schema is required.")}project(e,...t){for(let r of t)this._dispatch(e,r)}_dispatch(e,t){let{path:r,value:o}=t,c=this._resolveEffect(r);c&&(this._ensureScheduler(),this._scheduler.enqueue({path:r.join("."),effect:c,ctx:{source:e,path:r,value:o}}))}_ensureScheduler(){if(!this._scheduler)throw new Error("Projector: no scheduler.")}_resolveEffect(e){let t=this._schema;for(let r of e){if(!t)return null;t=t[r]}return typeof t=="function"?t:null}},f=class extends l{constructor(e,t){super(e,t)}},y=class extends l{withScheduler(e){return typeof e=="function"?this._schedulerFactory=e:this._scheduler=e,this}_ensureScheduler(){if(!this._scheduler&&this._schedulerFactory&&(this._scheduler=this._schedulerFactory()),!this._scheduler)throw new Error("Projector: no scheduler.")}};import{debounce as b}from"lodash-es";var d=class{constructor(e){this._strategy=e;this._queue=new Map}enqueue(e){return this._queue.set(e.path,e),this}flush(){return this.checkStrategy(),log.trace("Scheduler.flush()",[...this._queue.keys()]),this.flushCore()}withStrategy(e){return typeof e=="function"?this._strategyFactory=e:this._strategy=e,this}checkStrategy(){if(!this._strategy&&this._strategyFactory&&(this._strategy=this._strategyFactory()),!this._strategy)throw new Error("Scheduler: no strategy.")}async run(e){for(let t of e){let{effect:r,ctx:o}=t,c=r(this._strategy,o);c instanceof Promise&&await c}}},p=class extends d{constructor(t,r=500){super(t);this.wait=r;this.flushCore=b(async()=>{let t=[...this._queue.values()];this._queue.clear(),this.run(t)},this.wait)}},S=class extends d{async flushCore(){this._strategy.reset(),this.run([...this._queue.values()])}};import{debounce as j}from"lodash-es";var _=class{constructor(e,t){this._initial=e;this._schema=t;this._flushWait=0}buildDynamic(){this.track();let e=new y(this._schema);return this._scheduler&&e.withScheduler(this._scheduler),this._recorder.sendTo(e),{tracked:this._tracked,recorder:this._recorder,projector:e,scheduler:this._scheduler}}buildStatic(){if(!this._scheduler)throw new Error("Builder: no scheduler was provided. Call `withLazyScheduler()` or `withTotalScheduler()` to provide.");if(!this._strategy&&!this._strategyFactory)throw new Error("Builder: no strategy was provided. Call `withStrategy()` to provide.");if(!this._onFlush)throw new Error("Builder: no flush handler was provided. Call `onFlush()` to provide.");let e=async()=>{await this._scheduler.flush(),this._onFlush()};this.track(),this._scheduler.withStrategy(this._strategy??this._strategyFactory);let t=new f(this._schema,this._scheduler);return this._recorder.sendTo(t),this._recorder.on("record",this._flushWait?j(e,this._flushWait):e),{tracked:this._tracked,recorder:this._recorder,scheduler:this._scheduler}}onFlush(e,t=500){return this._onFlush=e,this._flushWait=t,this}withLazyScheduler(e=500){return this._scheduler=new p(void 0,e),this}withTotalScheduler(){return this._scheduler=new S,this}withStrategy(e){return typeof e=="function"?this._strategyFactory=e:this._strategy=e,this}track(){this._recorder&&this._tracked||(this._recorder=new i(this._initial),this._tracked=F(this._initial,(e,t)=>this._recorder.receive(e,t),{pathAsArray:!0}))}};import{get as g,keys as E}from"lodash-es";var m=u=>{},I=class{at(e){return(t,r)=>{let o=h(r);return t.execute(e,o)}}atWith(e,t){return(o,c)=>{let a=h(c),s=t(a);return o.execute(e,s)}}arrayAt(e,t){return(r,o)=>{let c=o.path?g(o.source,o.path):o.value;if(c&&Array.isArray(c)&&c.length>0){let a={keys:typeof c[0]=="object"?E(c[0]):[],resolveHeader:(s,n)=>String(s),...t};return r.executeArray(e,c,a)}}}arrayAtWith(e,t,r){return(o,c)=>{let a=c.path?g(c.source,c.path):c.value;if(a&&Array.isArray(a)&&a.length>0){let s=a.map(t),n={keys:typeof a[0]=="object"?E(a[0]):[],resolveHeader:(T,P)=>String(T),...r};return o.executeArray(e,s,n)}}}loop(e){return async(t,r)=>{let o=h(r);if(Array.isArray(o)){let c=o;for(let a=0;a<c.length;a++){let s=c[a],T=e(s,a)(t,{value:s});T instanceof Promise&&await T}}else throw new Error(`Effect: Value at path '${r.path}' is not an array.`)}}sourceWith(e,t){return(r,o)=>{let c=t(o.source);return r.execute(e,c)}}raw(e,t){return(r,o)=>r.execute(e,t)}sequence(e){return async(t,r)=>{let o=h(r);for(let c of e)await c(t,{value:o})}}sequenceWith(e,t){return async(o,c)=>{let a=h(c),s=t(a);for(let n of e)await n(o,{value:s})}}when(e,t,r=m){return(o,c)=>{let a=h(c);return(e(a)?t:r)(o,{value:a})}}whenFromSource(e,t,r=m){return(o,c)=>(e(c.source)?t:r)(o,c)}},h=u=>u.source&&u.path?g(u.source,u.path):u.value;function G(u){let e=new i(u);return[L(u,(r,o)=>e.receive(r,o),{pathAsArray:!0}),e]}export{_ as Builder,y as DynamicProjector,I as EffectFactory,p as LazyScheduler,f as Projector,l as ProjectorBase,i as Recorder,d as Scheduler,S as TotalScheduler,G as track};
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cyysummer/projector",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "A powerful state projection library for creating anything.",
   "license": "MIT",
   "author": "Chris Liu",

package/types/lib.d.ts

@@ -59,7 +59,7 @@ type ArrayEffectOptions = {
 /**
  * Strategy defines actual execution methods for projecting values to target.
  */
-interface ITargetExecutionStrategy<TTarget, TLocation = any> {
+interface ITargetExecutionStrategy<TTarget, TLocation> {
     execute<T extends any>(location: TLocation, value: T): MaybePromise<void>;
     executeArray<T extends any>(location: TLocation, rows: T[], options: ArrayEffectOptions): MaybePromise<void>;
     reset(): void;
@@ -72,8 +72,8 @@ interface IProjector<TSource> {
 interface IScheduler<TTarget> {
     enqueue(effect: IScheduleItem): void;
     flush(): MaybePromise<void>;
-    withStrategy(target: ITargetExecutionStrategy<TTarget, unknown>): IScheduler<TTarget>;
-    withStrategy(target: Func<ITargetExecutionStrategy<TTarget, unknown>>): IScheduler<TTarget>;
+    withStrategy(strategy: ITargetExecutionStrategy<TTarget, any>): IScheduler<TTarget>;
+    withStrategy(factory: Func<ITargetExecutionStrategy<TTarget, any>>): IScheduler<TTarget>;
 }
 
 interface IScheduleItem<TSource, TValue> {
@@ -125,6 +125,55 @@ declare class Recorder<TSource extends object> extends Recorder_base {
     private _ensureProjector;
 }
 
+declare abstract class ProjectorBase<TSource> implements IProjector<TSource> {
+    protected _schema: Schema<TSource>;
+    protected _scheduler?: IScheduler<any> | undefined;
+    constructor(_schema: Schema<TSource>, _scheduler?: IScheduler<any> | undefined);
+    project(next: TSource, ...patches: Patch[]): void;
+    protected _dispatch(next: TSource, patch: Patch): void;
+    protected _ensureScheduler(): void;
+    protected _resolveEffect(path: (string | symbol)[]): Effect<TSource, any> | null;
+}
+declare class Projector<TSource> extends ProjectorBase<TSource> {
+    constructor(_schema: Schema<TSource>, _scheduler: IScheduler<any>);
+}
+declare class DynamicProjector<TSource> extends ProjectorBase<TSource> {
+    private _schedulerFactory?;
+    withScheduler(scheduler: IScheduler<any>): IProjector<TSource>;
+    withScheduler(factory: Func<IScheduler<any>>): IProjector<TSource>;
+    protected _ensureScheduler(): void;
+}
+
+declare class Builder<TSource extends object, TTarget, TLocation> {
+    private _initial;
+    private _schema;
+    private _flushWait;
+    private _onFlush?;
+    private _recorder?;
+    private _scheduler?;
+    private _strategy?;
+    private _strategyFactory?;
+    private _tracked?;
+    constructor(_initial: TSource, _schema: Schema<TSource>);
+    buildDynamic(): {
+        tracked: TSource;
+        recorder: Recorder<TSource>;
+        projector: DynamicProjector<TSource>;
+        scheduler: IScheduler<TTarget> | undefined;
+    };
+    buildStatic(): {
+        tracked: TSource;
+        recorder: Recorder<TSource>;
+        scheduler: IScheduler<TTarget>;
+    };
+    onFlush(callback: Action, wait?: number): Builder<TSource, TTarget, TLocation>;
+    withLazyScheduler(wait?: number): Builder<TSource, TTarget, TLocation>;
+    withTotalScheduler(): Builder<TSource, TTarget, TLocation>;
+    withStrategy(strategy: ITargetExecutionStrategy<TTarget, TLocation>): Builder<TSource, TTarget, TLocation>;
+    withStrategy(factory: Func<ITargetExecutionStrategy<TTarget, TLocation>>): Builder<TSource, TTarget, TLocation>;
+    private track;
+}
+
 /**
  * Build effects for a target.
  * @template TSource The type of the source object.
@@ -209,25 +258,6 @@ declare class EffectFactory<TSource extends object, TLocation = any> {
     whenFromSource<T>(condition: Predicate<TSource>, ifTrue: Effect<TSource, any>, ifFalse?: Effect<TSource, any>): Effect<TSource, T>;
 }
 
-declare abstract class ProjectorBase<TSource> implements IProjector<TSource> {
-    protected _schema: Schema<TSource>;
-    protected _scheduler?: IScheduler<any>;
-    constructor(_schema: Schema<TSource>);
-    project(next: TSource, ...patches: Patch[]): void;
-    protected _dispatch(next: TSource, patch: Patch): void;
-    protected _ensureScheduler(): void;
-    protected _resolveEffect(path: (string | symbol)[]): Effect<TSource, any> | null;
-}
-declare class Projector<TSource> extends ProjectorBase<TSource> {
-    constructor(_schema: Schema<TSource>, _scheduler: IScheduler<any>);
-}
-declare class DynamicProjector<TSource> extends ProjectorBase<TSource> {
-    private _schedulerFactory?;
-    scheduleWith(scheduler: IScheduler<any>): IProjector<TSource>;
-    scheduleWith(schedulerFactory: Func<IScheduler<any>>): IProjector<TSource>;
-    protected _ensureScheduler(): void;
-}
-
 /**
  * Scheduler abstract class, used to schedule projector effects.
  */
@@ -239,7 +269,7 @@ declare abstract class Scheduler<TTarget> implements IScheduler<TTarget> {
     enqueue(item: IScheduleItem<any, any>): IScheduler<TTarget>;
     flush(): MaybePromise<void>;
     withStrategy(strategy: ITargetExecutionStrategy<TTarget, any>): IScheduler<TTarget>;
-    withStrategy(strategy: Func<ITargetExecutionStrategy<TTarget, any>>): IScheduler<TTarget>;
+    withStrategy(factory: Func<ITargetExecutionStrategy<TTarget, any>>): IScheduler<TTarget>;
     protected checkStrategy(): void;
     protected abstract flushCore(): MaybePromise<void>;
     protected run(list: IScheduleItem<any, any>[]): Promise<void>;
@@ -247,7 +277,7 @@ declare abstract class Scheduler<TTarget> implements IScheduler<TTarget> {
 /**
  * A scheduler that **delays and batches** effect executions using debounce.
  *
- * Effects are collected in a queue and only executed after the specified `timeout`
+ * Effects are collected in a queue and only executed after the specified `wait`
  * has passed without any new effects being enqueued. This helps reduce redundant
  * executions (e.g. during rapid successive state updates) and is especially useful
  * when projecting to expensive targets like UI rendering, DOM updates, or network requests.
@@ -257,8 +287,8 @@ declare abstract class Scheduler<TTarget> implements IScheduler<TTarget> {
  * effects in batch.
  */
 declare class LazyScheduler<TTarget> extends Scheduler<TTarget> {
-    protected timeout: number;
-    constructor(strategy?: ITargetExecutionStrategy<TTarget, any>, timeout?: number);
+    protected wait: number;
+    constructor(strategy?: ITargetExecutionStrategy<TTarget, any>, wait?: number);
     protected readonly flushCore: lodash_es.DebouncedFunc<() => Promise<void>>;
 }
 /**
@@ -275,4 +305,4 @@ declare class TotalScheduler<TTarget> extends Scheduler<TTarget> {
  */
 declare function track<TSource extends object>(initial: TSource): [TSource, Recorder<TSource>];
 
-export { DynamicProjector, EffectFactory, LazyScheduler, Projector, ProjectorBase, Recorder, Scheduler, TotalScheduler, track };
+export { Builder, DynamicProjector, EffectFactory, LazyScheduler, Projector, ProjectorBase, Recorder, Scheduler, TotalScheduler, track };

package/types/types.d.ts

@@ -57,7 +57,7 @@ export type ArrayEffectOptions = {
 /**
  * Strategy defines actual execution methods for projecting values to target.
  */
-export interface ITargetExecutionStrategy<TTarget, TLocation = any> {
+export interface ITargetExecutionStrategy<TTarget, TLocation> {
     execute<T extends any>(location: TLocation, value: T): MaybePromise<void>;
     executeArray<T extends any>(location: TLocation, rows: T[], options: ArrayEffectOptions): MaybePromise<void>;
     reset(): void;
@@ -70,8 +70,8 @@ export interface IProjector<TSource> {
 export interface IScheduler<TTarget> {
     enqueue(effect: IScheduleItem): void;
     flush(): MaybePromise<void>;
-    withStrategy(target: ITargetExecutionStrategy<TTarget, unknown>): IScheduler<TTarget>;
-    withStrategy(target: Func<ITargetExecutionStrategy<TTarget, unknown>>): IScheduler<TTarget>;
+    withStrategy(strategy: ITargetExecutionStrategy<TTarget, any>): IScheduler<TTarget>;
+    withStrategy(factory: Func<ITargetExecutionStrategy<TTarget, any>>): IScheduler<TTarget>;
 }
 
 export interface IScheduleItem<TSource, TValue> {