@cyysummer/projector 0.0.11 → 0.0.12

package/dist/index.js

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

package/package.json

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

package/types/lib.d.ts

@@ -56,6 +56,19 @@ type ArrayEffectOptions = {
     resolveHeader: (key: string | symbol, index?: number) => string;
 }
 
+
+type RecorderEvents = {
+    record: { next: any; patches: Patch[]; };
+};
+
+interface IRecorder<TSource extends object> extends IEventful<RecorderEvents> {
+    pause(): void;
+    receive(path: any[], value: any): void;
+    resume(): void;
+    sendTo(projector: IProjector<TSource>): void;
+    sendTo(factory: Func<IProjector<TSource>>): void;
+}
+
 /**
  * Strategy defines actual execution methods for projecting values to target.
  */
@@ -89,64 +102,6 @@ interface Patch {
     value: any;
 }
 
-type RecorderEvents = {
-    record: {
-        next: any;
-        patches: Patch[];
-    };
-};
-declare const RecorderBase_base: Constructor<object> & (new (...args: any[]) => object & IEventful<RecorderEvents>);
-/**
- * Record changes to an object.
- */
-declare abstract class RecorderBase<TSource extends object> extends RecorderBase_base {
-    protected _paused: boolean;
-    protected _projectorFactory?: Func<IProjector<TSource>>;
-    protected _shadow: TSource;
-    constructor(initial: TSource);
-    /**
-     * Receive changes from the tracked object.
-     * @param path
-     * @param value
-     * @returns
-     */
-    abstract receive(path: any[], value: any): void;
-    /**
-     * Send changes to a projector.
-     * @param projector
-     */
-    sendTo(projector: IProjector<TSource>): void;
-    /**
-     * Send changes to a projector.
-     * @param factory
-     */
-    sendTo(factory: Func<IProjector<TSource>>): void;
-    pause(): void;
-    resume(): void;
-}
-declare class Recorder<TSource extends object> extends RecorderBase<TSource> {
-    /**
-     * Receive changes from the tracked object.
-     * @param path
-     * @param value
-     * @returns
-     */
-    receive(path: any[], value: any): void;
-}
-declare class LazyRecorder<TSource extends object> extends RecorderBase<TSource> {
-    protected _wait: number;
-    protected _buffer: Map<string, Patch>;
-    constructor(initial: TSource, _wait?: number);
-    /**
-     * Receive changes from the tracked object.
-     * @param path
-     * @param value
-     * @returns
-     */
-    receive(path: any[], value: any): void;
-    protected readonly receiveCore: lodash_es.DebouncedFunc<() => void>;
-}
-
 declare abstract class ProjectorBase<TSource> implements IProjector<TSource> {
     protected _schema: Schema<TSource>;
     protected _scheduler?: IScheduler<any> | undefined;
@@ -173,19 +128,18 @@ declare class Builder<TSource extends object, TTarget, TLocation> {
     private _flushCallback?;
     private _recorder?;
     private _scheduler?;
-    private _strategy?;
     private _strategyFactory?;
     private _tracked?;
     constructor(_initial: TSource, _schema: Schema<TSource>, _waitTime?: number);
     buildDynamic(): {
         tracked: TSource;
-        recorder: RecorderBase<TSource>;
+        recorder: IRecorder<TSource>;
         projector: DynamicProjector<TSource>;
         scheduler: IScheduler<TTarget> | undefined;
     };
-    buildStatic(): {
+    build(): {
         tracked: TSource;
-        recorder: RecorderBase<TSource>;
+        recorder: IRecorder<TSource>;
         scheduler: IScheduler<TTarget>;
     };
     /**
@@ -194,7 +148,7 @@ declare class Builder<TSource extends object, TTarget, TLocation> {
      * @returns
      */
     onFlush(callback: Action): Builder<TSource, TTarget, TLocation>;
-    withLazyScheduler(wait?: number): Builder<TSource, TTarget, TLocation>;
+    withLazyScheduler(): 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>;
@@ -285,6 +239,58 @@ 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 const RecorderBase_base: Constructor<object> & (new (...args: any[]) => object & IEventful<RecorderEvents>);
+/**
+ * Record changes to an object.
+ */
+declare abstract class RecorderBase<TSource extends object> extends RecorderBase_base implements IRecorder<TSource> {
+    protected _paused: boolean;
+    protected _projectorFactory?: Func<IProjector<TSource>>;
+    protected _shadow: TSource;
+    constructor(initial: TSource);
+    /**
+     * Receive changes from the tracked object.
+     * @param path
+     * @param value
+     * @returns
+     */
+    abstract receive(path: any[], value: any): void;
+    /**
+     * Send changes to a projector.
+     * @param projector
+     */
+    sendTo(projector: IProjector<TSource>): void;
+    /**
+     * Send changes to a projector.
+     * @param factory
+     */
+    sendTo(factory: Func<IProjector<TSource>>): void;
+    pause(): void;
+    resume(): void;
+}
+declare class Recorder<TSource extends object> extends RecorderBase<TSource> {
+    /**
+     * Receive changes from the tracked object.
+     * @param path
+     * @param value
+     * @returns
+     */
+    receive(path: any[], value: any): void;
+}
+declare class LazyRecorder<TSource extends object> extends RecorderBase<TSource> {
+    protected _wait: number;
+    protected _buffer: Map<string, Patch>;
+    constructor(initial: TSource, _wait?: number);
+    /**
+     * Receive changes from the tracked object.
+     * @param path
+     * @param value
+     * @returns
+     */
+    receive(path: any[], value: any): void;
+    protected readonly receiveCore: lodash_es.DebouncedFunc<() => void>;
+}
+
 /**
  * Scheduler abstract class, used to schedule projector effects.
  */
@@ -328,8 +334,9 @@ declare class TotalScheduler<TTarget> extends Scheduler<TTarget> {
 /**
  * Track changes to an object.
  * @param initial Source object to track. This must the raw object, not reactive-enabled object.
+ * @param [wait=500] Wait before change notification. Useful when the object changes at high frequency.
  * @returns A tuple of the tracked object and a recorder.
  */
-declare function track<TSource extends object>(initial: TSource): [TSource, Recorder<TSource>];
+declare function track<TSource extends object>(initial: TSource, wait?: number): [TSource, IRecorder<TSource>];
 
 export { Builder, DynamicProjector, EffectFactory, LazyRecorder, LazyScheduler, Projector, ProjectorBase, Recorder, RecorderBase, Scheduler, TotalScheduler, track };

package/types/types.d.ts

@@ -54,6 +54,19 @@ export type ArrayEffectOptions = {
     resolveHeader: (key: string | symbol, index?: number) => string;
 }
 
+
+export type RecorderEvents = {
+    record: { next: any; patches: Patch[]; };
+};
+
+export interface IRecorder<TSource extends object> extends IEventful<RecorderEvents> {
+    pause(): void;
+    receive(path: any[], value: any): void;
+    resume(): void;
+    sendTo(projector: IProjector<TSource>): void;
+    sendTo(factory: Func<IProjector<TSource>>): void;
+}
+
 /**
  * Strategy defines actual execution methods for projecting values to target.
  */