@cyysummer/projector 0.0.8 → 0.0.9

package/dist/index.js

@@ -1,7 +1,7 @@
 /**
-* @cyysummer/projector v0.0.8
+* @cyysummer/projector v0.0.9
 * (c) 2021-PRESENT Chris Liu
 * @license MIT
 **/
-import b from"on-change";import{set as m}from"lodash-es";import{withEvents as I}from"@cyysummer/core";var T=class extends I(){constructor(e){super();this._paused=!1;this._shadow=structuredClone(e)}receive(e,r){if(this._paused)return;m(this._shadow,e,r);let o=[{path:e,value:r}];this.emit("record",{next:this._shadow,patches:o}),this._ensureProjector(),this._projector?.project(this._shadow,...o)}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 l,keys as d}from"lodash-es";var y=s=>{},S=class{constructor(t){this._strategy=t}at(t){return(e,r)=>{let o=i(r);return this._strategy.execute(e,t,o)}}atWith(t,e){return(o,c)=>{let u=i(c),a=e(u);return this._strategy.execute(o,t,a)}}arrayAt(t,e){return(r,o)=>{let c=o.path?l(o.source,o.path):o.value;if(c&&Array.isArray(c)&&c.length>0){let u={keys:typeof c[0]=="object"?d(c[0]):[],resolveHeader:(a,n)=>String(a),...e};return this._strategy.executeArray(r,t,c,u)}}}arrayAtWith(t,e,r){return(o,c)=>{let u=c.path?l(c.source,c.path):c.value;if(u&&Array.isArray(u)&&u.length>0){let a=u.map(e),n={keys:typeof u[0]=="object"?d(u[0]):[],resolveHeader:(f,v)=>String(f),...r};return this._strategy.executeArray(o,t,a,n)}}}loop(t){return async(e,r)=>{let o=i(r);if(Array.isArray(o)){let c=o;for(let u=0;u<c.length;u++){let a=c[u],f=t(a,u)(e,{value:a});f instanceof Promise&&await f}}else throw new Error(`Effect: Value at path '${r.path}' is not an array.`)}}sourceWith(t,e){return(r,o)=>{let c=e(o.source);return this._strategy.execute(r,t,c)}}raw(t,e){return(r,o)=>this._strategy.execute(r,t,e)}sequence(t){return async(e,r)=>{let o=i(r);for(let c of t)await c(e,{value:o})}}sequenceWith(t,e){return async(o,c)=>{let u=i(c),a=e(u);for(let n of t)await n(o,{value:a})}}when(t,e,r=y){return(o,c)=>{let u=i(c);return(t(u)?e:r)(o,{value:u})}}whenFromSource(t,e,r=y){return(o,c)=>(t(c.source)?e:r)(o,c)}},i=s=>s.source&&s.path?l(s.source,s.path):s.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:o}=e,c=this._resolveEffect(r);c&&(this._ensureScheduler(),this._scheduler.enqueue({path:r.join("."),effect:c,ctx:{source:t,path:r,value:o}}))}_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}},_=class extends h{constructor(t,e){super(t),this._scheduler=e}},g=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 p=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")}},E=class extends p{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",[...this._queue.keys()]);let e=[...this._queue.values()];this._queue.clear();for(let r of e){let{effect:o,ctx:c}=r,u=o(this._target,c);u instanceof Promise&&await u}}};function k(s){let t=new T(s);return[b(s,t.receive.bind(t),{pathAsArray:!0}),t]}export{E as BufferedScheduler,g as DynamicProjector,S as EffectFactory,_ as Projector,h as ProjectorBase,T as Recorder,p as Scheduler,k as track};
+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};
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cyysummer/projector",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "A powerful state projection library for creating anything.",
   "license": "MIT",
   "author": "Chris Liu",
@@ -18,7 +18,7 @@
     }
   },
   "dependencies": {
-    "lodash-es": "^4.17.22",
+    "lodash-es": "4.17.22",
     "on-change": "^6.0.1",
     "@cyysummer/core": "^0.0.12"
   },
@@ -26,11 +26,11 @@
     "@cyysummer/core": "^0.0.12"
   },
   "devDependencies": {
-    "@types/lodash-es": "^4.17.12",
-    "tsup": "^8.5.0",
-    "typescript": "^5.9.2",
-    "vite": "^7.1.5",
-    "vitest": "^3.2.4"
+    "@types/lodash-es": "4.17.12",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1",
+    "vitest": "^4.0.17"
   },
   "publishConfig": {
     "access": "public"

package/types/lib.d.ts

@@ -1,3 +1,5 @@
+import * as lodash_es from 'lodash-es';
+
 /**
  * A Schema defines how to project changes from a source object to a target object.
  */
@@ -16,8 +18,8 @@ type Schema<TSource, T = TSource> = {
 /**
  * An effect defines how to project a value from source to target.
  */
-// todo: Solve this `any`
-type Effect<TSource, TValue> = (target: any, ctx: IEffectContext<TSource, TValue>) => MaybePromise<void>;
+// todo: Solve ITargetExecutionStrategy<any, any>. How to obtain TTarget and TLocation?
+type Effect<TSource, TValue> = (strategy: ITargetExecutionStrategy<any, any>, ctx: IEffectContext<TSource, TValue>) => MaybePromise<void>;
 
 /**
  * The context for an effect. It contains information about changes.
@@ -58,8 +60,9 @@ type ArrayEffectOptions = {
  * Strategy defines actual execution methods for projecting values to target.
  */
 interface ITargetExecutionStrategy<TTarget, TLocation = any> {
-    execute<T extends any>(target: TTarget, location: TLocation, value: T): MaybePromise<void>;
-    executeArray<T extends any>(target: TTarget, location: TLocation, rows: T[], options: ArrayEffectOptions): MaybePromise<void>;
+    execute<T extends any>(location: TLocation, value: T): MaybePromise<void>;
+    executeArray<T extends any>(location: TLocation, rows: T[], options: ArrayEffectOptions): MaybePromise<void>;
+    reset(): void;
 }
 
 interface IProjector<TSource> {
@@ -69,8 +72,8 @@ interface IProjector<TSource> {
 interface IScheduler<TTarget> {
     enqueue(effect: IScheduleItem): void;
     flush(): MaybePromise<void>;
-    withTarget(target: TTarget): IScheduler<TTarget>;
-    withTarget(target: Func<TTarget>): IScheduler<TTarget>;
+    withStrategy(target: ITargetExecutionStrategy<TTarget, unknown>): IScheduler<TTarget>;
+    withStrategy(target: Func<ITargetExecutionStrategy<TTarget, unknown>>): IScheduler<TTarget>;
 }
 
 interface IScheduleItem<TSource, TValue> {
@@ -124,32 +127,32 @@ declare class Recorder<TSource extends object> extends Recorder_base {
 
 /**
  * Build effects for a target.
+ * @template TSource The type of the source object.
+ * @template TLocation The type used to describe a location within an effect target. This is interpreted by the execution strategy and may represent a bookmark, anchor, or address.
  */
-declare class EffectFactory<TTarget, TSource extends object, TLocation = any> {
-    protected _strategy: ITargetExecutionStrategy<TTarget, TLocation>;
-    constructor(_strategy: ITargetExecutionStrategy<TTarget, TLocation>);
+declare class EffectFactory<TSource extends object, TLocation = any> {
     /**
-     * Create an effect that will be applied at the specified location.
-     * @param location The location in `TTarget` where the effect is executed.
+     * Create an effect bound to a specific location on the target. Source value should be primitive type.
+     * @param location Identifies the location on the effect target where this effect will be executed.
      * @returns
      */
     at<T>(location: TLocation): Effect<TSource, T>;
     /**
-     * Create an effect that will be applied at the specified location. Use `mapper` to transform the value.
-     * @param location The location in `TTarget` where the effect is executed.
+     * Create an effect bound to a specific location on the target. When it executs, source value will be transformed with `mapper`. Source value should be primitive type.
+     * @param location Identifies the location on the effect target where this effect will be executed.
      * @param mapper Function to transform the value.
      * @returns
      */
     atWith<T, R>(location: TLocation, mapper: Func1<T, R>): Effect<TSource, R>;
     /**
-     * Create an effect that will be applied at the specified location for array data.
-     * @param location The location in `TTarget` where the effect is executed.
+     * Create an effect bound to a specific location on the target. Source value should be an array.
+     * @param location Identifies the location on the effect target where this effect will be executed.
      * @returns
      */
     arrayAt<T, U = UnwrapArray<T>>(location: TLocation, options?: Partial<ArrayEffectOptions>): Effect<TSource, T>;
     /**
-     * Create an effect that will be applied at the specified location for array data.
-     * @param location The location in `TTarget` where the effect is executed.
+     * Create an effect bound to a specific location on the target. When it executs, source value will be transformed with `mapper`. Source value should be an array.
+     * @param location Identifies the location on the effect target where this effect will be executed.
      * @param mapper Function to transform the element of the array.
      * @returns
      */
@@ -162,15 +165,15 @@ declare class EffectFactory<TTarget, TSource extends object, TLocation = any> {
      */
     loop<T, U = T extends Array<infer K> ? K : never>(each: Func2<U, number, Effect<TSource, U>>): Effect<TSource, T>;
     /**
-     * Create an effect that will be applied at the specified location for `TSource` object. Use `mapper` to transform the `TSource` object.
-     * @param location The location in `TTarget` where the effect is executed.
+     * Create an effect bound to a specific location on the target for `TSource` object. When it executs, `TSource` object will be transformed with `mapper`.
+     * @param location Identifies the location on the effect target where this effect will be executed.
      * @param mapper Function to transform the `TSource` object.
      * @returns
      */
     sourceWith<T>(location: TLocation, mapper: Func1<TSource, string>): Effect<TSource, T>;
     /**
-     * Create an effect that will be applied at the specified location for raw value. This effect will not read from `TSource` object.
-     * @param location The location in `TTarget` where the effect is executed.
+     * Create an effect bound to a specific location on the target for raw value. This effect will not read from `TSource` object.
+     * @param location Identifies the location on the effect target where this effect will be executed.
      * @param rawValue The value to use.
      * @returns
      */
@@ -182,7 +185,7 @@ declare class EffectFactory<TTarget, TSource extends object, TLocation = any> {
      */
     sequence<T>(effects: Effect<TSource, T>[]): Effect<TSource, T>;
     /**
-     * Call multiple effects in sequence. Use `mapper` to transform the value.
+     * Call multiple effects in sequence. When it executs, source value will be transformed with `mapper` first, then pass to `effects`.
      * @param effects Effects to call.
      * @param mapper Function to transform the value.
      * @returns
@@ -229,22 +232,40 @@ declare class DynamicProjector<TSource> extends ProjectorBase<TSource> {
  * Scheduler abstract class, used to schedule projector effects.
  */
 declare abstract class Scheduler<TTarget> implements IScheduler<TTarget> {
-    protected _target?: TTarget | undefined;
-    protected _targetFactory?: Func<TTarget>;
-    constructor(_target?: TTarget | undefined);
-    abstract enqueue(item: IScheduleItem<TTarget, any>): IScheduler<TTarget>;
-    abstract flush(): MaybePromise<void>;
-    withTarget(target: TTarget): IScheduler<TTarget>;
-    withTarget(target: Func<TTarget>): IScheduler<TTarget>;
-    protected checkTarget(): void;
+    protected _strategy?: ITargetExecutionStrategy<TTarget, any> | undefined;
+    protected readonly _queue: Map<string, IScheduleItem<any, any>>;
+    protected _strategyFactory?: Func<ITargetExecutionStrategy<TTarget, any>>;
+    constructor(_strategy?: ITargetExecutionStrategy<TTarget, any> | undefined);
+    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>;
+    protected checkStrategy(): void;
+    protected abstract flushCore(): MaybePromise<void>;
+    protected run(list: IScheduleItem<any, any>[]): Promise<void>;
+}
+/**
+ * A scheduler that **delays and batches** effect executions using debounce.
+ *
+ * Effects are collected in a queue and only executed after the specified `timeout`
+ * 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.
+ *
+ * In contrast to `TotalScheduler` which eagerly executes all effects on every projection,
+ * `LazyScheduler` is more conservative: it waits for a quiet period before flushing the accumulated
+ * effects in batch.
+ */
+declare class LazyScheduler<TTarget> extends Scheduler<TTarget> {
+    protected timeout: number;
+    constructor(strategy?: ITargetExecutionStrategy<TTarget, any>, timeout?: number);
+    protected readonly flushCore: lodash_es.DebouncedFunc<() => Promise<void>>;
 }
 /**
- * Buffered scheduler, will buffer effects and execute them in batch.
+ * Run all queued effects at once. The queue will NOT be cleared. The strategy will `reset()` before running any effects.
  */
-declare class BufferedScheduler<TTarget> extends Scheduler<TTarget> {
-    protected readonly _queue: Map<string, IScheduleItem<TTarget, any>>;
-    enqueue(item: IScheduleItem<TTarget, any>): IScheduler<TTarget>;
-    flush(): Promise<void>;
+declare class TotalScheduler<TTarget> extends Scheduler<TTarget> {
+    protected flushCore(): Promise<void>;
 }
 
 /**
@@ -254,4 +275,4 @@ declare class BufferedScheduler<TTarget> extends Scheduler<TTarget> {
  */
 declare function track<TSource extends object>(initial: TSource): [TSource, Recorder<TSource>];
 
-export { BufferedScheduler, DynamicProjector, EffectFactory, Projector, ProjectorBase, Recorder, Scheduler, track };
+export { DynamicProjector, EffectFactory, LazyScheduler, Projector, ProjectorBase, Recorder, Scheduler, TotalScheduler, track };

package/types/types.d.ts

@@ -16,8 +16,8 @@ export type Schema<TSource, T = TSource> = {
 /**
  * An effect defines how to project a value from source to target.
  */
-// todo: Solve this `any`
-export type Effect<TSource, TValue> = (target: any, ctx: IEffectContext<TSource, TValue>) => MaybePromise<void>;
+// todo: Solve ITargetExecutionStrategy<any, any>. How to obtain TTarget and TLocation?
+export type Effect<TSource, TValue> = (strategy: ITargetExecutionStrategy<any, any>, ctx: IEffectContext<TSource, TValue>) => MaybePromise<void>;
 
 /**
  * The context for an effect. It contains information about changes.
@@ -58,8 +58,9 @@ export type ArrayEffectOptions = {
  * Strategy defines actual execution methods for projecting values to target.
  */
 export interface ITargetExecutionStrategy<TTarget, TLocation = any> {
-    execute<T extends any>(target: TTarget, location: TLocation, value: T): MaybePromise<void>;
-    executeArray<T extends any>(target: TTarget, location: TLocation, rows: T[], options: ArrayEffectOptions): MaybePromise<void>;
+    execute<T extends any>(location: TLocation, value: T): MaybePromise<void>;
+    executeArray<T extends any>(location: TLocation, rows: T[], options: ArrayEffectOptions): MaybePromise<void>;
+    reset(): void;
 }
 
 export interface IProjector<TSource> {
@@ -69,8 +70,8 @@ export interface IProjector<TSource> {
 export interface IScheduler<TTarget> {
     enqueue(effect: IScheduleItem): void;
     flush(): MaybePromise<void>;
-    withTarget(target: TTarget): IScheduler<TTarget>;
-    withTarget(target: Func<TTarget>): IScheduler<TTarget>;
+    withStrategy(target: ITargetExecutionStrategy<TTarget, unknown>): IScheduler<TTarget>;
+    withStrategy(target: Func<ITargetExecutionStrategy<TTarget, unknown>>): IScheduler<TTarget>;
 }
 
 export interface IScheduleItem<TSource, TValue> {