@cyysummer/projector 0.0.2 → 0.0.3

package/dist/index.js

@@ -3,4 +3,4 @@
 * (c) 2021-PRESENT Chris Liu
 * @license MIT
 **/
-import _ from"on-change";import{set as g}from"lodash-es";import{withEvents as S}from"@cyysummer/core";var T=class extends S(){constructor(e){super();this._paused=!1;this._shadow=structuredClone(e)}record(e,r){this._paused||(g(this._shadow,e,r),this.emit("record",{next:this._shadow,path:e,value:r}))}pause(){this._paused=!0}resume(){this._paused=!1}};import{get as p}from"lodash-es";var l=a=>{},h=class{constructor(t){this._strategy=t}chain(t){return async(e,r)=>{let c=s(r);for(let o of t)await o(e,{value:c})}}chainWith(t,e){return async(c,o)=>{let u=s(o),n=e(u);for(let f of t)await f(c,{value:n})}}create(t){return(e,r)=>{let c=s(r);return this._strategy.execute(e,t,c)}}createIf(t,e,r=l){return(c,o)=>{let u=s(o);return(t(u)?e:r)(c,{value:u})}}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?p(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 u=s(o),n=e(u);return this._strategy.execute(c,t,n)}}};function s(a){return a.source&&a.path?p(a.source,a.path):a.value}var y=class{constructor(t,e){this._schema=t;this._scheduler=e}project(t,...e){if(!this._schema)throw new Error("Schema not loaded");for(let r of e)this._dispatch(t,r)}_dispatch(t,e){let{path:r,value:c}=e,o=this._resolveEffect(r);o&&this._scheduler.enqueue({path:r.join("."),effect:o,ctx:{source:t,path:r,value:c}})}_resolveEffect(t){let e=this._schema;for(let r of t){if(!e)return null;e=e[r]}return typeof e=="function"?e:null}};var i=class{constructor(t=null){this._target=t;this._targetFactory=null}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")}},d=class extends i{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,u=c(this._target,o);u instanceof Promise&&await u}}};function F(a){let t=new T(a);return[_(a,t.record.bind(t),{pathAsArray:!0}),t]}export{d as BufferedScheduler,h as EffectBuilder,y as Projector,T as Recorder,i as Scheduler,F as track};
+import m from"on-change";import{set as d}from"lodash-es";import{withEvents as g}from"@cyysummer/core";var T=class extends g(){constructor(e){super();this._paused=!1;this._shadow=structuredClone(e)}record(e,r){this._paused||(d(this._shadow,e,r),this.emit("record",{next:this._shadow,patches:[{path:e,value:r}]}))}pause(){this._paused=!0}resume(){this._paused=!1}};import{get as p}from"lodash-es";var h=a=>{},l=class{constructor(t){this._strategy=t}chain(t){return async(e,r)=>{let c=s(r);for(let o of t)await o(e,{value:c})}}chainWith(t,e){return async(c,o)=>{let u=s(o),n=e(u);for(let i of t)await i(c,{value:n})}}create(t){return(e,r)=>{let c=s(r);return this._strategy.execute(e,t,c)}}createIf(t,e,r=h){return(c,o)=>{let u=s(o);return(t(u)?e:r)(c,{value:u})}}createIfRoot(t,e,r=h){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?p(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 u=s(o),n=e(u);return this._strategy.execute(c,t,n)}}};function s(a){return a.source&&a.path?p(a.source,a.path):a.value}var y=class{constructor(t,e){this._schema=t;this._scheduler=e}project(t,...e){if(!this._schema)throw new Error("Schema not loaded");for(let r of e)this._dispatch(t,r)}_dispatch(t,e){let{path:r,value:c}=e,o=this._resolveEffect(r);o&&this._scheduler.enqueue({path:r.join("."),effect:o,ctx:{source:t,path:r,value:c}})}_resolveEffect(t){let e=this._schema;for(let r of t){if(!e)return null;e=e[r]}return typeof e=="function"?e:null}};var f=class{constructor(t=null){this._target=t;this._targetFactory=null}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")}},S=class extends f{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,u=c(this._target,o);u instanceof Promise&&await u}}};function F(a){let t=new T(a);return[m(a,t.record.bind(t),{pathAsArray:!0}),t]}export{S as BufferedScheduler,l as EffectBuilder,y as Projector,T as Recorder,f as Scheduler,F as track};

package/package.json

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

package/types/lib.d.ts

@@ -1,8 +1,68 @@
+// 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>;
+
+// todo: Solve this `any`
+type Effect<TSource, TValue> = (target: any, ctx: IEffectContext<TSource, TValue>) => MaybePromise<void>;
+
+interface IEffectContext<TSource, TValue> {
+    /**
+     * The source object.
+     */
+    source?: TSource;
+    /**
+     * The path of the property.
+     */
+    path?: string;
+    /**
+     * The value of the property.
+     *
+     * If `source` or `path` is not specified, the value is passed from another effect.
+     */
+    value: TValue;
+}
+
+interface ITargetStrategy<TTarget> {
+    execute<T>(target: TTarget, at: string, value: T): MaybePromise<void>;
+    executeArray<T>(target: TTarget, at: string, keys: Partial<keyof T>[], rows: T[]): MaybePromise<void>;
+}
+
+interface IProjector<TSource> {
+    project(next: TSource, ...patches: Patch[]): void;
+}
+
+interface IScheduler<TTarget> {
+    enqueue(effect: IScheduleItem): void;
+    flush(): MaybePromise<void>;
+    withTarget(target: TTarget): IScheduler<TTarget>;
+    withTarget(target: Func<TTarget>): IScheduler<TTarget>;
+}
+
+interface IScheduleItem<TSource, TValue> {
+    path: string;
+    effect: Effect<TSource, TValue>;
+    ctx: IEffectContext<TSource, TValue>;
+}
+
+interface Patch {
+    path: (string | symbol)[];
+    value: any;
+}
+
 type RecorderEvents = {
     record: {
         next: any;
-        path: any[];
-        value: any;
+        patches: Patch[];
     };
 };
 declare const Recorder_base: Constructor<object> & (new (...args: any[]) => object & IEventful<RecorderEvents>);

package/types/types.d.ts

@@ -1,5 +1,5 @@
 // prettier-ignore
-type Schema<TSource, T = any> = TSource extends object ?
+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.
@@ -13,9 +13,9 @@ type Schema<TSource, T = any> = TSource extends object ?
     : Effect<TSource, T>;
 
 // todo: Solve this `any`
-type Effect<TSource, TValue> = (target: any, ctx: IEffectContext<TSource, TValue>) => MaybePromise<void>;
+export type Effect<TSource, TValue> = (target: any, ctx: IEffectContext<TSource, TValue>) => MaybePromise<void>;
 
-interface IEffectContext<TSource, TValue> {
+export interface IEffectContext<TSource, TValue> {
     /**
      * The source object.
      */
@@ -32,29 +32,29 @@ interface IEffectContext<TSource, TValue> {
     value: TValue;
 }
 
-interface ITargetStrategy<TTarget> {
+export interface ITargetStrategy<TTarget> {
     execute<T>(target: TTarget, at: string, value: T): MaybePromise<void>;
     executeArray<T>(target: TTarget, at: string, keys: Partial<keyof T>[], rows: T[]): MaybePromise<void>;
 }
 
-interface IProjector<TSource> {
+export interface IProjector<TSource> {
     project(next: TSource, ...patches: Patch[]): void;
 }
 
-interface IScheduler<TTarget> {
+export interface IScheduler<TTarget> {
     enqueue(effect: IScheduleItem): void;
     flush(): MaybePromise<void>;
     withTarget(target: TTarget): IScheduler<TTarget>;
     withTarget(target: Func<TTarget>): IScheduler<TTarget>;
 }
 
-interface IScheduleItem<TSource, TValue> {
+export interface IScheduleItem<TSource, TValue> {
     path: string;
     effect: Effect<TSource, TValue>;
     ctx: IEffectContext<TSource, TValue>;
 }
 
-interface Patch {
+export interface Patch {
     path: (string | symbol)[];
     value: any;
 }