@cyysummer/projector 0.0.5 → 0.0.7

package/dist/index.js

@@ -1,7 +1,7 @@
 /**
-* @cyysummer/projector v0.0.5
+* @cyysummer/projector v0.0.7
 * (c) 2021-PRESENT Chris Liu
 * @license MIT
 **/
-import E from"on-change";import{set as g}from"lodash-es";import{withEvents as I}from"@cyysummer/core";var i=class extends I(){constructor(e){super();this._paused=!1;this._shadow=structuredClone(e)}receive(e,r){if(this._paused)return;g(this._shadow,e,r);let c=[{path:e,value:r}];this.emit("record",{next:this._shadow,patches:c}),this._ensureProjector(),this._projector?.project(this._shadow,...c)}sendTo(e){typeof e=="function"?this._projectorFactory=e:this._projector=e}pause(){this._paused=!0}resume(){this._paused=!1}_ensureProjector(){!this._projector&&this._projectorFactory&&(this._projector=this._projectorFactory())}};import{get as d}from"lodash-es";var l=u=>{},p=class{constructor(t){this._strategy=t}chain(t){return async(e,r)=>{let c=n(r);for(let o of t)await o(e,{value:c})}}chainWith(t,e){return async(c,o)=>{let s=n(o),a=e(s);for(let f of t)await f(c,{value:a})}}create(t){return(e,r)=>{let c=n(r);return this._strategy.execute(e,t,c)}}createIf(t,e,r=l){return(c,o)=>{let s=n(o);return(t(s)?e:r)(c,{value:s})}}createIfRoot(t,e,r=l){return(c,o)=>(t(o.source)?e:r)(c,o)}createRoot(t,e){return(r,c)=>{let o=e(c.source);return this._strategy.execute(r,t,o)}}createForArray(t){return(e,r)=>{let c=r.path?d(r.source,r.path):r.value;if(c&&Array.isArray(c)&&c.length>0){let o=Object.keys(c[0]);return this._strategy.executeArray(e,t,o,c)}}}createForRaw(t,e){return(r,c)=>this._strategy.execute(r,t,e)}createWith(t,e){return(c,o)=>{let s=n(o),a=e(s);return this._strategy.execute(c,t,a)}}};function n(u){return u.source&&u.path?d(u.source,u.path):u.value}var h=class{constructor(t){this._schema=t;if(!t)throw new Error("Projector: Schema is required.")}project(t,...e){for(let r of e)this._dispatch(t,r)}_dispatch(t,e){let{path:r,value:c}=e,o=this._resolveEffect(r);o&&(this._ensureScheduler(),this._scheduler.enqueue({path:r.join("."),effect:o,ctx:{source:t,path:r,value:c}}))}_ensureScheduler(){if(!this._scheduler)throw new Error("Projector: no scheduler.")}_resolveEffect(t){let e=this._schema;for(let r of t){if(!e)return null;e=e[r]}return typeof e=="function"?e:null}},S=class extends h{constructor(t,e){super(t),this._scheduler=e}},y=class extends h{scheduleWith(t){return typeof t=="function"?this._schedulerFactory=t:this._scheduler=t,this}_ensureScheduler(){if(!this._scheduler&&this._schedulerFactory&&(this._scheduler=this._schedulerFactory()),!this._scheduler)throw new Error("Projector: no scheduler.")}};var T=class{constructor(t){this._target=t}withTarget(t){return typeof t=="function"?this._targetFactory=t:this._target=t,this}checkTarget(){if(!this._target&&this._targetFactory&&(this._target=this._targetFactory()),!this._target)throw new Error("Scheduler: target is not set")}},_=class extends T{constructor(){super(...arguments);this._queue=new Map}enqueue(e){return this._queue.set(e.path,e),this}async flush(){this.checkTarget(),log.trace("BufferedScheduler: flushing");let e=[...this._queue.values()];this._queue.clear();for(let r of e){let{effect:c,ctx:o}=r,s=c(this._target,o);s instanceof Promise&&await s}}};function C(u){let t=new i(u);return[E(u,t.receive.bind(t),{pathAsArray:!0}),t]}export{_ as BufferedScheduler,y as DynamicProjector,p as EffectBuilder,S as Projector,h as ProjectorBase,i as Recorder,T as Scheduler,C as track};
+import I from"on-change";import{set as E}from"lodash-es";import{withEvents as m}from"@cyysummer/core";var i=class extends m(){constructor(e){super();this._paused=!1;this._shadow=structuredClone(e)}receive(e,r){if(this._paused)return;E(this._shadow,e,r);let c=[{path:e,value:r}];this.emit("record",{next:this._shadow,patches:c}),this._ensureProjector(),this._projector?.project(this._shadow,...c)}sendTo(e){typeof e=="function"?this._projectorFactory=e:this._projector=e}pause(){this._paused=!0}resume(){this._paused=!1}_ensureProjector(){!this._projector&&this._projectorFactory&&(this._projector=this._projectorFactory())}};import{get as S}from"lodash-es";var p=u=>{},d=class{constructor(t){this._strategy=t}create(t){return(e,r)=>{let c=a(r);return this._strategy.execute(e,t,c)}}createWith(t,e){return(c,o)=>{let s=a(o),n=e(s);return this._strategy.execute(c,t,n)}}forEach(t){return async(e,r)=>{let c=a(r);if(Array.isArray(c)){let o=c;for(let s=0;s<o.length;s++){let n=o[s],l=t(n,s)(e,{value:n});l instanceof Promise&&await l}}else throw new Error(`Effect: Value at path '${r.path}' is not an array.`)}}fromArray(t){return(e,r)=>{let c=r.path?S(r.source,r.path):r.value;if(c&&Array.isArray(c)&&c.length>0){let o=Object.keys(c[0]);return this._strategy.executeArray(e,t,o,c)}}}fromPrimitive(t){return(e,r)=>{let c=a(r);return this._strategy.execute(e,t,c)}}fromSource(t,e){return(r,c)=>{let o=e(c.source);return this._strategy.execute(r,t,o)}}fromValue(t,e){return(r,c)=>this._strategy.execute(r,t,e)}sequence(t){return async(e,r)=>{let c=a(r);for(let o of t)await o(e,{value:c})}}sequenceWith(t,e){return async(c,o)=>{let s=a(o),n=e(s);for(let T of t)await T(c,{value:n})}}when(t,e,r=p){return(c,o)=>{let s=a(o);return(t(s)?e:r)(c,{value:s})}}whenFromSource(t,e,r=p){return(c,o)=>(t(o.source)?e:r)(c,o)}};function a(u){return u.source&&u.path?S(u.source,u.path):u.value}var f=class{constructor(t){this._schema=t;if(!t)throw new Error("Projector: Schema is required.")}project(t,...e){for(let r of e)this._dispatch(t,r)}_dispatch(t,e){let{path:r,value:c}=e,o=this._resolveEffect(r);o&&(this._ensureScheduler(),this._scheduler.enqueue({path:r.join("."),effect:o,ctx:{source:t,path:r,value:c}}))}_ensureScheduler(){if(!this._scheduler)throw new Error("Projector: no scheduler.")}_resolveEffect(t){let e=this._schema;for(let r of t){if(!e)return null;e=e[r]}return typeof e=="function"?e:null}},y=class extends f{constructor(t,e){super(t),this._scheduler=e}},_=class extends f{scheduleWith(t){return typeof t=="function"?this._schedulerFactory=t:this._scheduler=t,this}_ensureScheduler(){if(!this._scheduler&&this._schedulerFactory&&(this._scheduler=this._schedulerFactory()),!this._scheduler)throw new Error("Projector: no scheduler.")}};var h=class{constructor(t){this._target=t}withTarget(t){return typeof t=="function"?this._targetFactory=t:this._target=t,this}checkTarget(){if(!this._target&&this._targetFactory&&(this._target=this._targetFactory()),!this._target)throw new Error("Scheduler: target is not set")}},g=class extends h{constructor(){super(...arguments);this._queue=new Map}enqueue(e){return this._queue.set(e.path,e),this}async flush(){this.checkTarget(),log.trace("BufferedScheduler: flushing");let e=[...this._queue.values()];this._queue.clear();for(let r of e){let{effect:c,ctx:o}=r,s=c(this._target,o);s instanceof Promise&&await s}}};function k(u){let t=new i(u);return[I(u,t.receive.bind(t),{pathAsArray:!0}),t]}export{g as BufferedScheduler,_ as DynamicProjector,d as EffectFactory,y as Projector,f as ProjectorBase,i as Recorder,h as Scheduler,k as track};
 //# sourceMappingURL=index.js.map

package/package.json

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

package/types/lib.d.ts

@@ -2,18 +2,16 @@
  * A Schema defines how to project changes from a source object to a target object.
  */
 // prettier-ignore
-type Schema<TSource, T = any> = TSource extends object ?
-    Partial<{
-        // If the property is an array, map whole array to effect.
-        // Else map property to schema.
-        [K in keyof T]:
-        T[K] extends Array<infer U> ?
-        Effect<TSource, U>
-        // If TSource is an object, map each property to schema, or write effect for the property.
-        : Schema<TSource, T[K]> | Effect<TSource, T[K]>;
-    }>
-    // Else map T to effect.
-    : Effect<TSource, T>;
+type Schema<TSource, T = TSource> = {
+    // If the property is an array, map to effect.
+    [K in keyof T]?: T[K] extends Array<infer U>
+        ? Effect<TSource, U[]>
+        // Else, if the property is an object, map to schema or effect.
+        : T[K] extends object
+            ? Schema<TSource, T[K]> | Effect<TSource, T[K]>
+            // Else, leaf property, map to effect.
+            : Effect<TSource, T[K]>;
+};
 
 /**
  * An effect defines how to project a value from source to target.
@@ -45,8 +43,8 @@ interface IEffectContext<TSource, TValue> {
  * Strategy defines actual execution methods for projecting values to target.
  */
 interface ITargetExecutionStrategy<TTarget, TLocation = any> {
-    execute<T>(target: TTarget, at: TLocation, value: T): MaybePromise<void>;
-    executeArray<T>(target: TTarget, at: TLocation, keys: Partial<keyof T>[], rows: T[]): MaybePromise<void>;
+    execute<T>(target: TTarget, location: TLocation, value: T): MaybePromise<void>;
+    executeArray<T>(target: TTarget, location: TLocation, keys: Partial<keyof T>[], rows: T[]): MaybePromise<void>;
 }
 
 interface IProjector<TSource> {
@@ -112,71 +110,73 @@ declare class Recorder<TSource extends object> extends Recorder_base {
 /**
  * Build effects for a target.
  */
-declare class EffectBuilder<TTarget, TSource extends object> {
-    private _strategy;
-    constructor(_strategy: ITargetExecutionStrategy<TTarget>);
+declare class EffectFactory<TTarget, TSource extends object, TLocation = any> {
+    protected _strategy: ITargetExecutionStrategy<TTarget, TLocation>;
+    constructor(_strategy: ITargetExecutionStrategy<TTarget, TLocation>);
     /**
-     * Call multiple effects in sequence.
-     * @param effects Effects to call.
+     * Create an effect that will applied at the specified location.
+     * @param location The location in `TTarget` where the effect is executed.
      * @returns
      */
-    chain<T>(effects: Effect<TSource, T>[]): Effect<TSource, T>;
+    create<T>(location: TLocation): Effect<TSource, T>;
     /**
-     * Call multiple effects in sequence. Use `customizer` to transform the original value.
-     * @param effects Effects to call.
-     * @param customizer Function to transform the original value.
+     * Create an effect that will applied at the specified location. Use `mapper` to transform the source object.
+     * @param location The location in `TTarget` where the effect is executed.
+     * @param mapper Function to transform the source object.
      * @returns
      */
-    chainWith<T, R>(effects: Effect<TSource, R>[], customizer: Func1<T, R>): Effect<TSource, R>;
+    createWith<T, R>(location: TLocation, mapper: Func1<T, R>): Effect<TSource, R>;
+    forEach<T, U = T extends Array<infer K> ? K : never>(each: Func2<U, number, Effect<TSource, U>>): Effect<TSource, T>;
     /**
-     * Create an effect for the specified location.
-     * @param at The location in `TTarget` where the effect is to be executed.
+     * Create an effect that will applied at the specified location for array data.
+     * @param location The location in `TTarget` where the effect is executed.
      * @returns
      */
-    create<T>(at: string): Effect<TSource, T>;
+    fromArray<T extends Array<U>, U extends object = any>(location: TLocation): Effect<TSource, T>;
+    fromPrimitive<T>(location: TLocation): Effect<TSource, T>;
     /**
-     * Execute effect based on condition. The condition is based on the value of the current property path.
-     * @param condition Condition delegate that takes the original value of the property and returns true or false.
-     * @param whenTrue When condition is true, this effect is executed.
-     * @param whenFalse When condition is false, this effect is executed.
+     * Create an effect that will applied at the specified location. Use `mapper` to transform the source object.
+     * @param location The location in `TTarget` where the effect is executed.
+     * @param mapper Function to transform the source object.
      * @returns
      */
-    createIf<T>(condition: Predicate<T>, whenTrue: Effect<TSource, any>, whenFalse?: Effect<TSource, any>): Effect<TSource, T>;
+    fromSource<T>(location: TLocation, mapper: Func1<TSource, string>): Effect<TSource, T>;
     /**
-     * Execute effect based on condition. The condition is based on the source object.
-     * @param condition Condition delegate that takes the source object and returns true or false.
-     * @param whenTrue When condition is true, this effect is executed.
-     * @param whenFalse When condition is false, this effect is executed.
+     * Create an effect that will applied at the specified location for raw value. This effect will not read from source object.
+     * @param location The location in `TTarget` where the effect is executed.
+     * @param value The value to use.
      * @returns
      */
-    createIfRoot<T>(condition: Predicate<TSource>, whenTrue: Effect<TSource, any>, whenFalse?: Effect<TSource, any>): Effect<TSource, T>;
+    fromValue<T>(location: TLocation, value: T): Effect<TSource, T>;
     /**
-     * Create an effect for the specified location. Use customizer to transform the source object.
-     * @param at The location in `TTarget` where the effect is to be executed.
-     * @param customizer Function to transform the source object.
+     * Call multiple effects in sequence.
+     * @param effects Effects to call.
      * @returns
      */
-    createRoot<T>(at: string, customizer: Func1<TSource, string>): Effect<TSource, T>;
+    sequence<T>(effects: Effect<TSource, T>[]): Effect<TSource, T>;
     /**
-     * Create an effect for the specified location for array data.
-     * @param at The location in `TTarget` where the effect is to be executed.
+     * Call multiple effects in sequence. Use `mapper` to transform the original value.
+     * @param effects Effects to call.
+     * @param mapper Function to transform the original value.
      * @returns
      */
-    createForArray<T extends Array<U>, U extends object = any>(at: string): Effect<TSource, T>;
+    sequenceWith<T, R>(effects: Effect<TSource, R>[], mapper: Func1<T, R>): Effect<TSource, R>;
     /**
-     * Create an effect for the specified location for raw value. This will not read from source object.
-     * @param at The location in `TTarget` where the effect is to be executed.
-     * @param raw Raw value to use.
+     * Execute effect based on condition. The condition is based on the value of the current property path.
+     * @param condition Condition delegate that takes the original value of the property and returns true or false.
+     * @param ifTrue When condition is true, this effect is executed.
+     * @param ifFalse When condition is false, this effect is executed.
      * @returns
      */
-    createForRaw<T>(at: string, raw: T): Effect<TSource, T>;
+    when<T>(condition: Predicate<T>, ifTrue: Effect<TSource, any>, ifFalse?: Effect<TSource, any>): Effect<TSource, T>;
     /**
-     * Create an effect for the specified location. Use `customizer` to transform the source object.
-     * @param at The location in `TTarget` where the effect is to be executed.
-     * @param customizer Function to transform the source object.
+     * Execute effect based on condition. The condition is based on the source object.
+     * @param condition Condition delegate that takes the source object and returns true or false.
+     * @param ifTrue When condition is true, this effect is executed.
+     * @param ifFalse When condition is false, this effect is executed.
      * @returns
      */
-    createWith<T, R>(at: string, customizer: Func1<T, R>): Effect<TSource, R>;
+    whenFromSource<T>(condition: Predicate<TSource>, ifTrue: Effect<TSource, any>, ifFalse?: Effect<TSource, any>): Effect<TSource, T>;
 }
 
 declare abstract class ProjectorBase<TSource> implements IProjector<TSource> {
@@ -227,4 +227,4 @@ declare class BufferedScheduler<TTarget> extends Scheduler<TTarget> {
  */
 declare function track<TSource extends object>(initial: TSource): [TSource, Recorder<TSource>];
 
-export { BufferedScheduler, DynamicProjector, EffectBuilder, Projector, ProjectorBase, Recorder, Scheduler, track };
+export { BufferedScheduler, DynamicProjector, EffectFactory, Projector, ProjectorBase, Recorder, Scheduler, track };

package/types/types.d.ts

@@ -2,18 +2,16 @@
  * A Schema defines how to project changes from a source object to a target object.
  */
 // prettier-ignore
-export type Schema<TSource, T = any> = TSource extends object ?
-    Partial<{
-        // If the property is an array, map whole array to effect.
-        // Else map property to schema.
-        [K in keyof T]:
-        T[K] extends Array<infer U> ?
-        Effect<TSource, U>
-        // If TSource is an object, map each property to schema, or write effect for the property.
-        : Schema<TSource, T[K]> | Effect<TSource, T[K]>;
-    }>
-    // Else map T to effect.
-    : Effect<TSource, T>;
+export type Schema<TSource, T = TSource> = {
+    // If the property is an array, map to effect.
+    [K in keyof T]?: T[K] extends Array<infer U>
+        ? Effect<TSource, U[]>
+        // Else, if the property is an object, map to schema or effect.
+        : T[K] extends object
+            ? Schema<TSource, T[K]> | Effect<TSource, T[K]>
+            // Else, leaf property, map to effect.
+            : Effect<TSource, T[K]>;
+};
 
 /**
  * An effect defines how to project a value from source to target.
@@ -45,8 +43,8 @@ export interface IEffectContext<TSource, TValue> {
  * Strategy defines actual execution methods for projecting values to target.
  */
 export interface ITargetExecutionStrategy<TTarget, TLocation = any> {
-    execute<T>(target: TTarget, at: TLocation, value: T): MaybePromise<void>;
-    executeArray<T>(target: TTarget, at: TLocation, keys: Partial<keyof T>[], rows: T[]): MaybePromise<void>;
+    execute<T>(target: TTarget, location: TLocation, value: T): MaybePromise<void>;
+    executeArray<T>(target: TTarget, location: TLocation, keys: Partial<keyof T>[], rows: T[]): MaybePromise<void>;
 }
 
 export interface IProjector<TSource> {