@vue-modeler/model 2.2.0-beta.6 → 2.2.4

package/README.md

@@ -1,4 +1,4 @@
-# Introduction
+# vue-modeler/model
 
 ## What is @vue-modeler/model
 
@@ -10,7 +10,7 @@ A state management library based on models for [Vue.js](https://vuejs.org/). The
 
 - **No global state store**. No store means no problems. State is encapsulated within the model and is reactive. Outside the model, it's only accessible for reading and observation.
 - **Extremely simple API**: A model prototype is a standard class, actions are defined as standard methods with decorators. Create a model by calling a factory method — nothing more needed. Reactive properties and behavior are defined using the standard Vue API.
-- **Supports shared models**. A built-in model container ensures that a model remains in memory while being used. Unused models are automatically removed from the container.
+- **Supports shared models**. Models can be shared across components. You can manage model instances using dependency injection or your own container pattern.
 - **Follows DRY principle**. Actions have their own state. There's no need to write additional code to track action states. Focus instead on designing architecture and business logic.
 - **Embraces OOP**. Model prototypes are classes, supporting inheritance, encapsulation, polymorphism, and destructors.
 - **Complies with SOLID principles**. Encourages clean coding practices like composition of models, dependency injection via constructors, separation of interfaces, single responsibility, etc.
@@ -55,14 +55,14 @@ This library promises to simplify state management in [Vue.js](https://vuejs.org
 
 ## Installation
 
-First, [install @vue-modeler/dc](https://github.com/vue-modeler/dc?tab=readme-ov-file#installation)
-
-Then install @vue-modeler/model:
+Install @vue-modeler/model:
 
 ```bash
 npm add @vue-modeler/model
 ```
 
+It is recommended to use it together with the dependency container [@vue-modeler/dc](https://github.com/vue-modeler/dc). For installation instructions and provider setup, see the [@vue-modeler/dc documentation](https://github.com/vue-modeler/dc?tab=readme-ov-file#installation).
+
 ## Usage Examples
 
 ### 1. Define Proto model
@@ -105,7 +105,7 @@ class User extends ProtoModel {
   ) {
      super()
 
-     this.action(this.init).exec()
+     this.init()
   }   
   
   // Actions (async methods with @action decorator)
@@ -148,17 +148,30 @@ export const patchUser = async (dto: PatchDto): Promise<void> => {
 }
 ```
 
-### 3. Compose all together and create model provider  
+### 3. Create model provider
 
-```typescript 
-import { model } from '@vue-modeler/model'
+Using `@vue-modeler/dc` (recommended):
 
-export const useUser = model(() => new User({
-   fetchUser, 
-   patch: patchUser
+```typescript
+import { provider } from '@vue-modeler/dc'
+import { User } from './user-model'
+import { fetchUser, patchUser } from './api'
+
+export const useUser = provider(() => User.model({
+  fetchUser,
+  patch: patchUser
 }))
 ```
 
+Or without dependency container:
+
+```typescript
+export const useUser = () => User.model({
+  fetchUser,
+  patch: patchUser
+})
+```
+
 ### 4. Using Models in Vue Components
 
 ```html

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var K=Object.defineProperty;var L=(r,t,e)=>t in r?K(r,t,{enumerable:!0,configurable:!0,writable:!0,value:e}):r[t]=e;var i=(r,t,e)=>L(r,typeof t!="symbol"?t+"":t,e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const u=require("vue");class I extends Error{constructor(t,e){super(e.cause.message),this.actionName=t,this.options=e,this.name=this.constructor.name}get cause(){return this.options.cause}throwCause(){throw this.cause}toString(){return this.options.cause.message}}class d extends Error{constructor(t,e){super(t,e),this.message=t,this.options=e,this.name=this.constructor.name}}class b extends d{constructor(t,e,o){super(`Trying to update state of ${t} from ${e} to ${o}`),this.name=this.constructor.name}}class $ extends d{constructor(t,e){super(`Unexpected AbortError for the action ${t} in state ${e}`),this.name=this.constructor.name}}const B=r=>r instanceof DOMException&&r.name==="AbortError"||typeof r=="object"&&r!==null&&"message"in r&&r.message==="canceled",s=class s{constructor(t,e,o,a){i(this,"name");i(this,"_state",s.possibleState.ready);i(this,"_value",null);i(this,"_args",null);this._model=t,this.actionFunction=e,this.ownerGetter=o,this.setStateCb=a;const n=e.name;if(!(n in this._model&&typeof this._model[n]=="function"))throw new d(`Model does not contain method ${n}`);if(typeof e[s.actionFlag]!="function")throw new d(`Method ${n} is not action`);this.name=n}static create(t,e,o,a){return u.shallowReactive(new s(t,e,o,a))}toString(){return this.name}get owner(){return this.ownerGetter()}get possibleStates(){return Object.values(s.possibleState)}get state(){return this._state}set state(t){const e=this._state;this._state=t,this.setStateCb&&this.setStateCb(this,e,t)}get abortController(){return this.isPending?this._value.abortController:null}get args(){return this._args||[]}get promise(){return this.isPending?this._value.promise:null}get error(){return this.isError?this._value:null}get abortReason(){return this.isAbort?this._value.abortController.signal.reason:null}get isPending(){return this.state===s.possibleState.pending}get isError(){return this.state===s.possibleState.error}get isReady(){return this.state===s.possibleState.ready}get isLock(){return this.state===s.possibleState.lock}get isAbort(){return this.state===s.possibleState.abort}is(...t){return!!t.find(e=>this.state===e)}exec(...t){if(this.is(s.possibleState.lock,s.possibleState.pending))throw new b(this.name,this.state,s.possibleState.pending);const e=[...t];let o=t.length&&t[t.length-1];o instanceof AbortController||(o=new AbortController,e.push(o)),this.state=s.possibleState.pending,this._args=t;const n=this.actionFunction[s.actionFlag].apply(this._model,e);if(!(n instanceof Promise))return this.state=s.possibleState.ready,Promise.resolve();const l=n.then(()=>{this.ready()}).catch(c=>{if(c instanceof d||c instanceof RangeError||c instanceof ReferenceError||c instanceof SyntaxError||c instanceof TypeError||c instanceof URIError||c instanceof EvalError)throw c;const y=B(c);if(y&&!this.is(s.possibleState.pending,s.possibleState.lock))throw new $(this.name,this.state);if(y&&this._value.abortController instanceof AbortController&&this._value.abortController.signal.reason===s.abortedByLock){this.state=s.possibleState.lock,this._value=null;return}if(y){this.state=s.possibleState.abort;return}this.setError(new I(this.name,{cause:c}))});return this._value={promise:l,abortController:o},l}abort(t){return this.isPending?(this._value.abortController.abort(t),this._value.promise):Promise.resolve()}lock(){return this.isPending?this.abort(s.abortedByLock):(this.state=s.possibleState.lock,this._value=null,Promise.resolve())}unlock(){if(!this.isLock)throw new b(this.name,this.state,s.possibleState.ready);return this.ready()}setError(t){if(!this.isPending)throw new b(this.name,this.state,s.possibleState.error);return this.state=s.possibleState.error,this._value=t,this}ready(){return this.state=s.possibleState.ready,this}resetError(){if(!this.error)throw new b(this.name,this.state,s.possibleState.ready);return this.ready()}};i(s,"actionFlag",Symbol("__action_original_method__")),i(s,"possibleState",{pending:"pending",error:"error",lock:"lock",ready:"ready",abort:"abort"}),i(s,"abortedByLock",Symbol("lock"));let h=s;const p=Symbol("scope"),w=Symbol("model"),A=Symbol("actions"),v=Symbol("actionIds"),m=Symbol("actionStates"),E=Symbol("actionsSize"),f=Symbol("watchStopHandlers"),T=Proxy;function D(r){if(!(r instanceof g))throw new Error("ProtoModel instance is required");const t=new T(u.shallowReactive(r),{get(e,o,a){const n=Reflect.get(e,o,a),l=typeof n=="function";return l&&h.actionFlag in n&&typeof n[h.actionFlag]=="function"?e.action(n):l?n.bind(e):n}});return r[w]=t,t}var k,M,C,P,R,x,F;F=p,x=w,R=A,P=v,C=m,M=E,k=f;const S=class S{constructor(){i(this,F,u.effectScope(!0));i(this,x,null);i(this,R,new WeakMap);i(this,P,new WeakMap);i(this,C,new Map);i(this,M,0);i(this,k,new Set)}static model(...t){if(this.prototype===S.prototype)throw new Error("ProtoModel is abstract class and can not be instantiated");const e=new this(...t);return S.createModel(e)}get hasPendingActions(){return!!this.getActionStatesRef(h.possibleState.pending).value}get hasActionWithError(){return!!this.getActionStatesRef(h.possibleState.error).value}watch(...t){if(t.length===0)throw new Error("watch requires at least one argument");const e=t.length===1?this[p].run(()=>u.watchEffect(t[0])):this[p].run(()=>u.watch(...t));if(!e)throw new Error("watchStopHandler is undefined");return this[f].add(e),()=>{e(),this[f].delete(e)}}computed(t,e){return this[p].run(()=>u.computed(t,e))}updateBit(t,e,o){const a=o?1:0,n=~(1<<e);return t&n|a<<e}createAction(t){const e=()=>{if(!this[w])throw new Error("Model not set");return this[w]},o=h.create(this,t,e,this.setActionState.bind(this));return this[A].set(t,o),this[v].set(o,++this[E]),this.setActionState(o),o}getActionStatesRef(t){const e=this[m].get(t)||u.ref(0);return this[m].get(t)===void 0&&this[m].set(t,e),e}action(t){if(!(h.actionFlag in t&&typeof t[h.actionFlag]=="function"))throw new d("Action decorator is not applied to the method");return this[A].get(t)||this.createAction(t)}setActionState(t){const e=this[v].get(t);if(!e)throw new Error("Action not found");for(const o of t.possibleStates)o!==t.state&&(this.getActionStatesRef(o).value=this.updateBit(this.getActionStatesRef(o).value,e,!1));this.getActionStatesRef(t.state).value=this.updateBit(this.getActionStatesRef(t.state).value,e,!0)}isModelOf(t){return this instanceof t}destructor(){this[f].forEach(t=>{t()}),this[f]=new Set,this[p].stop()}};i(S,"createModel",D);let g=S;function O(r,t){if(t.static)throw new Error("Action decorator is not supported for static methods");if(t.private)throw new Error("Action decorator is not supported for private methods");let e;try{e=t.name.toString()}catch(a){const l=`Invalid context. Can\`t get name of the method: ${a instanceof Error?a.message:"unknown error"}`;throw new Error(l)}const o={[e]:function(...a){return this.action(o[e]).exec(...a)}};return o[e][h.actionFlag]=r,o[e]}exports.Action=h;exports.ActionError=I;exports.ActionInternalError=d;exports.ActionStatusConflictError=b;exports.ActionUnexpectedAbortError=$;exports.ProtoModel=g;exports.action=O;
+"use strict";var L=Object.defineProperty;var B=(r,t,e)=>t in r?L(r,t,{enumerable:!0,configurable:!0,writable:!0,value:e}):r[t]=e;var i=(r,t,e)=>B(r,typeof t!="symbol"?t+"":t,e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const u=require("vue");class I extends Error{constructor(t,e){super(e.cause.message),this.actionName=t,this.options=e,this.name=this.constructor.name}get cause(){return this.options.cause}throwCause(){throw this.cause}toString(){return this.options.cause.message}}class d extends Error{constructor(t,e){super(t,e),this.message=t,this.options=e,this.name=this.constructor.name}}class b extends d{constructor(t,e,o){super(`Trying to update state of ${t} from ${e} to ${o}`),this.name=this.constructor.name}}class $ extends d{constructor(t,e){super(`Unexpected AbortError for the action ${t} in state ${e}`),this.name=this.constructor.name}}const T=r=>r instanceof DOMException&&r.name==="AbortError"||typeof r=="object"&&r!==null&&"message"in r&&r.message==="canceled",s=class s{constructor(t,e,o,c,h){i(this,"name");i(this,"_state",s.possibleState.ready);i(this,"_value",null);i(this,"_args",null);this._model=t,this.actionFunction=e,this.ownerGetter=o,this.setStateCb=c,this._validateArgs=h;const n=e.name;if(!(n in this._model&&typeof this._model[n]=="function"))throw new d(`Model does not contain method ${n}`);if(typeof e[s.actionFlag]!="function")throw new d(`Method ${n} is not action`);this.name=n}static create(t,e,o,c,h){return u.shallowReactive(new s(t,e,o,c,h))}toString(){return this.name}get owner(){return this.ownerGetter()}get possibleStates(){return Object.values(s.possibleState)}get state(){return this._state}set state(t){const e=this._state;this._state=t,this.setStateCb(this,e,t)}get abortController(){return this.isPending?this._value.abortController:null}get args(){return this._args||[]}get promise(){return this.isPending?this._value.promise:null}get error(){return this.isError?this._value:null}get abortReason(){return this.isAbort?this._value.abortController.signal.reason:null}get isPending(){return this.state===s.possibleState.pending}get isError(){return this.state===s.possibleState.error}get isReady(){return this.state===s.possibleState.ready}get isLock(){return this.state===s.possibleState.lock}get isAbort(){return this.state===s.possibleState.abort}is(...t){return!!t.find(e=>this.state===e)}validate(...t){return this._validateArgs(this,...t)}exec(...t){if(this.is(s.possibleState.lock,s.possibleState.pending))throw new b(this.name,this.state,s.possibleState.pending);const e=[...t];let o=t.length&&t[t.length-1];o instanceof AbortController||(o=new AbortController,e.push(o)),this.state=s.possibleState.pending,this._args=t;const h=this.actionFunction[s.actionFlag].apply(this._model,e);if(!(h instanceof Promise))return this.state=s.possibleState.ready,Promise.resolve();const n=h.then(()=>{this.ready()}).catch(a=>{if(a instanceof d||a instanceof RangeError||a instanceof ReferenceError||a instanceof SyntaxError||a instanceof TypeError||a instanceof URIError||a instanceof EvalError)throw a;const w=T(a);if(w&&!this.is(s.possibleState.pending,s.possibleState.lock))throw new $(this.name,this.state);if(w&&this._value.abortController instanceof AbortController&&this._value.abortController.signal.reason===s.abortedByLock){this.state=s.possibleState.lock,this._value=null;return}if(w){this.state=s.possibleState.abort;return}this.setError(new I(this.name,{cause:a}))});return this._value={promise:n,abortController:o},n}abort(t){return this.isPending?(this._value.abortController.abort(t),this._value.promise):Promise.resolve()}lock(){return this.isPending?this.abort(s.abortedByLock):(this.state=s.possibleState.lock,this._value=null,Promise.resolve())}unlock(){if(!this.isLock)throw new b(this.name,this.state,s.possibleState.ready);return this.ready()}setError(t){if(!this.isPending)throw new b(this.name,this.state,s.possibleState.error);return this.state=s.possibleState.error,this._value=t,this}ready(){return this.state=s.possibleState.ready,this}resetError(){if(!this.error)throw new b(this.name,this.state,s.possibleState.ready);return this.ready()}};i(s,"actionFlag",Symbol("__action_original_method__")),i(s,"possibleState",{pending:"pending",error:"error",lock:"lock",ready:"ready",abort:"abort"}),i(s,"abortedByLock",Symbol("lock"));let l=s;const p=Symbol("scope"),S=Symbol("model"),A=Symbol("actions"),y=Symbol("actionIds"),g=Symbol("actionStates"),E=Symbol("actionsSize"),f=Symbol("watchStopHandlers"),D=Proxy;var k,M,P,C,R,x,F;F=p,x=S,R=A,C=y,P=g,M=E,k=f;const m=class m{constructor(){i(this,F,u.effectScope(!0));i(this,x,null);i(this,R,new WeakMap);i(this,C,new WeakMap);i(this,P,new Map);i(this,M,0);i(this,k,new Set)}static createModel(t){if(!(t instanceof m))throw new Error("ProtoModel instance is required");const e=new D(u.shallowReactive(t),{get(o,c,h){const n=Reflect.get(o,c,h),a=typeof n=="function";return a&&l.actionFlag in n&&typeof n[l.actionFlag]=="function"?o.action(n):a?n.bind(o):n}});return t[S]=e,e}static model(...t){if(this.prototype===m.prototype)throw new Error("ProtoModel is abstract class and can not be instantiated");const e=new this(...t);return m.createModel(e)}get hasPendingActions(){return!!this.getActionStatesRef(l.possibleState.pending).value}get hasActionWithError(){return!!this.getActionStatesRef(l.possibleState.error).value}watch(...t){if(t.length===0)throw new Error("watch requires at least one argument");const e=t.length===1?this[p].run(()=>u.watchEffect(t[0])):this[p].run(()=>u.watch(...t));if(!e)throw new Error("watchStopHandler is undefined");return this[f].add(e),()=>{e(),this[f].delete(e)}}computed(t,e){return this[p].run(()=>u.computed(t,e))}updateBit(t,e,o){const c=o?1:0,h=~(1<<e);return t&h|c<<e}createAction(t){const e=()=>{if(!this[S])throw new Error("Model not set");return this[S]},o=l.create(this,t,e,this.setActionState.bind(this),this.validateArgs.bind(this));return this[A].set(t,o),this[y].set(o,++this[E]),this.setActionState(o),o}getActionStatesRef(t){const e=this[g].get(t)||u.ref(0);return this[g].get(t)===void 0&&this[g].set(t,e),e}action(t){if(!(l.actionFlag in t&&typeof t[l.actionFlag]=="function"))throw new d("Action decorator is not applied to the method");return this[A].get(t)||this.createAction(t)}setActionState(t){const e=this[y].get(t);if(!e)throw new Error("Action not found");for(const o of t.possibleStates)o!==t.state&&(this.getActionStatesRef(o).value=this.updateBit(this.getActionStatesRef(o).value,e,!1));this.getActionStatesRef(t.state).value=this.updateBit(this.getActionStatesRef(t.state).value,e,!0)}validateArgs(t,...e){const o=`validateArgs is not implemented for action ${t.name} in the model`;return[new Error(o)]}isModelOf(t){return this instanceof t}destructor(){this[f].forEach(t=>{t()}),this[f]=new Set,this[p].stop()}};let v=m;function O(r,t){if(t.static)throw new Error("Action decorator is not supported for static methods");if(t.private)throw new Error("Action decorator is not supported for private methods");let e;try{e=t.name.toString()}catch(c){const n=`Invalid context. Can\`t get name of the method: ${c instanceof Error?c.message:"unknown error"}`;throw new Error(n)}const o={[e]:function(...c){return this.action(o[e]).exec(...c)}};return o[e][l.actionFlag]=r,o[e]}exports.Action=l;exports.ActionError=I;exports.ActionInternalError=d;exports.ActionStatusConflictError=b;exports.ActionUnexpectedAbortError=$;exports.ProtoModel=v;exports.action=O;

package/dist/index.d.ts

@@ -16,7 +16,8 @@ export declare class Action<T extends object, Args extends any[] = unknown[]> im
     protected _model: T;
     protected actionFunction: OriginalMethodWrapper<Args>;
     protected ownerGetter: () => Model<T>;
-    protected setStateCb?: ((action: ActionLike<T, Args>, oldState: ActionStateName, newState: ActionStateName) => void) | undefined;
+    protected setStateCb: (action: ActionLike<T, Args>, oldState: ActionStateName, newState: ActionStateName) => void;
+    protected _validateArgs: (action: ActionLike<T, Args>, ...args: Args) => Error[];
     static readonly actionFlag: unique symbol;
     static readonly possibleState: {
         readonly pending: "pending";
@@ -30,8 +31,8 @@ export declare class Action<T extends object, Args extends any[] = unknown[]> im
     protected _state: ActionStateName;
     protected _value: ActionValue;
     protected _args: Args | null;
-    constructor(_model: T, actionFunction: OriginalMethodWrapper<Args>, ownerGetter: () => Model<T>, setStateCb?: ((action: ActionLike<T, Args>, oldState: ActionStateName, newState: ActionStateName) => void) | undefined);
-    static create<T extends ProtoModel, Args extends unknown[] = unknown[]>(model: T, actionFunction: OriginalMethodWrapper<Args>, ownerGetter: () => Model<T>, setStateCb?: (action: ActionLike<T, Args>, oldState: ActionStateName, newState: ActionStateName) => void): ActionLike<T, Args>;
+    constructor(_model: T, actionFunction: OriginalMethodWrapper<Args>, ownerGetter: () => Model<T>, setStateCb: (action: ActionLike<T, Args>, oldState: ActionStateName, newState: ActionStateName) => void, _validateArgs: (action: ActionLike<T, Args>, ...args: Args) => Error[]);
+    static create<T extends ProtoModel, Args extends unknown[] = unknown[]>(model: T, actionFunction: OriginalMethodWrapper<Args>, ownerGetter: () => Model<T>, setStateCb: (action: ActionLike<T, Args>, oldState: ActionStateName, newState: ActionStateName) => void, validateArgs: (action: ActionLike<T, Args>, ...args: Args) => Error[]): ActionLike<T, Args>;
     toString(): string;
     get owner(): Model<T>;
     get possibleStates(): ActionStateName[];
@@ -48,6 +49,7 @@ export declare class Action<T extends object, Args extends any[] = unknown[]> im
     get isLock(): boolean;
     get isAbort(): boolean;
     is(...args: ActionStateName[]): boolean;
+    validate(...args: Args): Error[];
     /**
      * Put into action in PENDING state
      */
@@ -122,6 +124,7 @@ export declare interface ActionLike<T extends object, Args extends any[] = unkno
     readonly isLock: boolean;
     readonly isAbort: boolean;
     is(...args: ActionStateName[]): boolean;
+    validate(...args: Args): Error[];
     exec(...args: Args): Promise<void>;
     abort(reason?: unknown): Promise<void>;
     lock(): Promise<void>;
@@ -153,33 +156,6 @@ export declare class ActionUnexpectedAbortError extends ActionInternalError {
 
 declare type ActionValue = ActionPendingValue | ActionError | null;
 
-/**
- * Wraps ProtoModel instance with proxy to handle get traps for actions
- * and to return Action instance instead of original method.
- *
- * ```ts
- * class TestModel extends ProtoModel {
- *   constructor() {
- *     super()
- *   }
- *
- *   @action async someAction(): Promise<void> {
- *     return Promise.resolve()
- *   }
- * }
- *
- * const model = createModel(new TestModel())
- * const action = model.someAction // will return Action instance instead of original method
- * model.someAction.exec() // will execute action
- * model.someAction.isPending // will return true if action is pending
- * model.someAction.error // will return error if action is errored
- * ```
- * @param protoModel - ProtoModel instance.
- * @returns model instance wrapped with proxy.
- * @see src/proto-model.ts
- */
-declare function createModel<Target extends ProtoModel>(protoModel: Target): Model<Target>;
-
 export declare type Model<T extends object = object> = ShallowReactive<{
     [K in keyof T]: T[K] extends ((...args: infer Args) => Promise<void>) ? ActionLike<T, Args> : K extends ProtectedMethodInModel ? never : T[K];
 }>;
@@ -209,13 +185,36 @@ export declare abstract class ProtoModel {
     protected [actionStatesKey]: Map<"pending" | "error" | "lock" | "ready" | "abort", Ref<number>>;
     protected [actionsSizeKey]: number;
     protected [watchStopHandlersKey]: Set<WatchStopHandle>;
-    protected static createModel: typeof createModel;
+    /**
+     * Wraps ProtoModel instance with proxy to handle get traps for actions
+     * and to return Action instance instead of original method.
+     *
+     * ```ts
+     * class TestModel extends ProtoModel {
+     *   constructor() {
+     *     super()
+     *   }
+     *
+     *   @action async someAction(): Promise<void> {
+     *     return Promise.resolve()
+     *   }
+     * }
+     *
+     * const model = ProtoModel.createModel(new TestModel())
+     * const action = model.someAction // will return Action instance instead of original method
+     * model.someAction.exec() // will execute action
+     * model.someAction.isPending // will return true if action is pending
+     * model.someAction.error // will return error if action is errored
+     * ```
+     * @param protoModel - ProtoModel instance.
+     * @returns model instance wrapped with proxy.
+     */
+    static createModel<Target extends ProtoModel>(protoModel: Target): Model<Target>;
     /**
      * Creates a model instance.
      *
      * @param args - arguments for the model constructor.
      * @returns model instance.
-     * @see src/create-model.ts
      */
     static model<T extends ProtoModel, Args extends unknown[]>(this: new (...args: Args) => T, ...args: Args): Model<T>;
     get hasPendingActions(): boolean;
@@ -332,6 +331,7 @@ export declare abstract class ProtoModel {
      * @see type Model<T>
      */
     setActionState(action: ActionLike<this>): void;
+    protected validateArgs(action: ActionLike<this>, ...args: unknown[]): Error[];
     isModelOf<T extends ProtoModel>(typeModel: ModelConstructor_2<T>): boolean;
     destructor(): void;
 }

package/dist/index.js

@@ -1,8 +1,8 @@
-var I = Object.defineProperty;
-var $ = (r, t, e) => t in r ? I(r, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : r[t] = e;
-var i = (r, t, e) => $(r, typeof t != "symbol" ? t + "" : t, e);
-import { shallowReactive as F, effectScope as K, watchEffect as L, watch as B, computed as D, ref as T } from "vue";
-class H extends Error {
+var $ = Object.defineProperty;
+var K = (r, t, e) => t in r ? $(r, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : r[t] = e;
+var i = (r, t, e) => K(r, typeof t != "symbol" ? t + "" : t, e);
+import { shallowReactive as F, effectScope as L, watchEffect as B, watch as D, computed as T, ref as H } from "vue";
+class O extends Error {
   constructor(t, e) {
     super(e.cause.message), this.actionName = t, this.options = e, this.name = this.constructor.name;
   }
@@ -26,18 +26,18 @@ class b extends u {
     super(`Trying to update state of ${t} from ${e} to ${o}`), this.name = this.constructor.name;
   }
 }
-class O extends u {
+class j extends u {
   constructor(t, e) {
     super(`Unexpected AbortError for the action ${t} in state ${e}`), this.name = this.constructor.name;
   }
 }
-const j = (r) => r instanceof DOMException && r.name === "AbortError" || typeof r == "object" && r !== null && "message" in r && r.message === "canceled", s = class s {
-  constructor(t, e, o, a) {
+const z = (r) => r instanceof DOMException && r.name === "AbortError" || typeof r == "object" && r !== null && "message" in r && r.message === "canceled", s = class s {
+  constructor(t, e, o, c, h) {
     i(this, "name");
     i(this, "_state", s.possibleState.ready);
     i(this, "_value", null);
     i(this, "_args", null);
-    this._model = t, this.actionFunction = e, this.ownerGetter = o, this.setStateCb = a;
+    this._model = t, this.actionFunction = e, this.ownerGetter = o, this.setStateCb = c, this._validateArgs = h;
     const n = e.name;
     if (!(n in this._model && typeof this._model[n] == "function"))
       throw new u(`Model does not contain method ${n}`);
@@ -45,8 +45,14 @@ const j = (r) => r instanceof DOMException && r.name === "AbortError" || typeof
       throw new u(`Method ${n} is not action`);
     this.name = n;
   }
-  static create(t, e, o, a) {
-    return F(new s(t, e, o, a));
+  static create(t, e, o, c, h) {
+    return F(new s(
+      t,
+      e,
+      o,
+      c,
+      h
+    ));
   }
   toString() {
     return this.name;
@@ -62,7 +68,7 @@ const j = (r) => r instanceof DOMException && r.name === "AbortError" || typeof
   }
   set state(t) {
     const e = this._state;
-    this._state = t, this.setStateCb && this.setStateCb(this, e, t);
+    this._state = t, this.setStateCb(this, e, t);
   }
   get abortController() {
     return this.isPending ? this._value.abortController : null;
@@ -98,6 +104,9 @@ const j = (r) => r instanceof DOMException && r.name === "AbortError" || typeof
   is(...t) {
     return !!t.find((e) => this.state === e);
   }
+  validate(...t) {
+    return this._validateArgs(this, ...t);
+  }
   /**
    * Put into action in PENDING state  
    */
@@ -111,31 +120,31 @@ const j = (r) => r instanceof DOMException && r.name === "AbortError" || typeof
     const e = [...t];
     let o = t.length && t[t.length - 1];
     o instanceof AbortController || (o = new AbortController(), e.push(o)), this.state = s.possibleState.pending, this._args = t;
-    const n = this.actionFunction[s.actionFlag].apply(this._model, e);
-    if (!(n instanceof Promise))
+    const h = this.actionFunction[s.actionFlag].apply(this._model, e);
+    if (!(h instanceof Promise))
       return this.state = s.possibleState.ready, Promise.resolve();
-    const l = n.then(() => {
+    const n = h.then(() => {
       this.ready();
-    }).catch((c) => {
-      if (c instanceof u || c instanceof RangeError || c instanceof ReferenceError || c instanceof SyntaxError || c instanceof TypeError || c instanceof URIError || c instanceof EvalError)
-        throw c;
-      const w = j(c);
-      if (w && !this.is(s.possibleState.pending, s.possibleState.lock))
-        throw new O(this.name, this.state);
-      if (w && this._value.abortController instanceof AbortController && this._value.abortController.signal.reason === s.abortedByLock) {
+    }).catch((a) => {
+      if (a instanceof u || a instanceof RangeError || a instanceof ReferenceError || a instanceof SyntaxError || a instanceof TypeError || a instanceof URIError || a instanceof EvalError)
+        throw a;
+      const S = z(a);
+      if (S && !this.is(s.possibleState.pending, s.possibleState.lock))
+        throw new j(this.name, this.state);
+      if (S && this._value.abortController instanceof AbortController && this._value.abortController.signal.reason === s.abortedByLock) {
         this.state = s.possibleState.lock, this._value = null;
         return;
       }
-      if (w) {
+      if (S) {
         this.state = s.possibleState.abort;
         return;
       }
-      this.setError(new H(this.name, { cause: c }));
+      this.setError(new O(this.name, { cause: a }));
     });
     return this._value = {
-      promise: l,
+      promise: n,
       abortController: o
-    }, l;
+    }, n;
   }
   // Returns same promise as exec method
   // but in reject state
@@ -184,44 +193,67 @@ i(s, "actionFlag", Symbol("__action_original_method__")), i(s, "possibleState",
   ready: "ready",
   abort: "abort"
 }), i(s, "abortedByLock", Symbol("lock"));
-let h = s;
-const d = Symbol("scope"), S = Symbol("model"), g = Symbol("actions"), y = Symbol("actionIds"), m = Symbol("actionStates"), v = Symbol("actionsSize"), p = Symbol("watchStopHandlers"), z = Proxy;
-function G(r) {
-  if (!(r instanceof A))
-    throw new Error("ProtoModel instance is required");
-  const t = new z(
-    F(r),
-    {
-      get(e, o, a) {
-        const n = Reflect.get(e, o, a), l = typeof n == "function";
-        return l && h.actionFlag in n && typeof n[h.actionFlag] == "function" ? e.action(n) : l ? n.bind(e) : n;
-      }
-    }
-  );
-  return r[S] = t, t;
-}
-var k, E, M, C, P, R, x;
-x = d, R = S, P = g, C = y, M = m, E = v, k = p;
+let l = s;
+const d = Symbol("scope"), m = Symbol("model"), w = Symbol("actions"), y = Symbol("actionIds"), g = Symbol("actionStates"), A = Symbol("actionsSize"), p = Symbol("watchStopHandlers"), G = Proxy;
+var E, k, M, P, C, R, x;
+x = d, R = m, C = w, P = y, M = g, k = A, E = p;
 const f = class f {
   constructor() {
     // each model has its own effect scope to avoid memory leaks
-    i(this, x, K(!0));
+    i(this, x, L(!0));
     i(this, R, null);
     // we use WeakMap to store actions as keys to avoid memory leaks
-    i(this, P, /* @__PURE__ */ new WeakMap());
     i(this, C, /* @__PURE__ */ new WeakMap());
+    i(this, P, /* @__PURE__ */ new WeakMap());
     i(this, M, /* @__PURE__ */ new Map());
     // WeakMap doesn't have a size property, so we need to store the size of the map
-    i(this, E, 0);
+    i(this, k, 0);
     // watchers are stored in a set to avoid memory leaks
-    i(this, k, /* @__PURE__ */ new Set());
+    i(this, E, /* @__PURE__ */ new Set());
+  }
+  /**
+   * Wraps ProtoModel instance with proxy to handle get traps for actions
+   * and to return Action instance instead of original method.
+   * 
+   * ```ts
+   * class TestModel extends ProtoModel {
+   *   constructor() {
+   *     super()
+   *   }
+   * 
+   *   @action async someAction(): Promise<void> {
+   *     return Promise.resolve()
+   *   }
+   * }
+   * 
+   * const model = ProtoModel.createModel(new TestModel())
+   * const action = model.someAction // will return Action instance instead of original method
+   * model.someAction.exec() // will execute action
+   * model.someAction.isPending // will return true if action is pending
+   * model.someAction.error // will return error if action is errored
+   * ```
+   * @param protoModel - ProtoModel instance.
+   * @returns model instance wrapped with proxy.
+   */
+  static createModel(t) {
+    if (!(t instanceof f))
+      throw new Error("ProtoModel instance is required");
+    const e = new G(
+      F(t),
+      {
+        get(o, c, h) {
+          const n = Reflect.get(o, c, h), a = typeof n == "function";
+          return a && l.actionFlag in n && typeof n[l.actionFlag] == "function" ? o.action(n) : a ? n.bind(o) : n;
+        }
+      }
+    );
+    return t[m] = e, e;
   }
   /**
    * Creates a model instance.
    * 
    * @param args - arguments for the model constructor.
    * @returns model instance.
-   * @see src/create-model.ts
    */
   static model(...t) {
     if (this.prototype === f.prototype)
@@ -230,10 +262,10 @@ const f = class f {
     return f.createModel(e);
   }
   get hasPendingActions() {
-    return !!this.getActionStatesRef(h.possibleState.pending).value;
+    return !!this.getActionStatesRef(l.possibleState.pending).value;
   }
   get hasActionWithError() {
-    return !!this.getActionStatesRef(h.possibleState.error).value;
+    return !!this.getActionStatesRef(l.possibleState.error).value;
   }
   /**
    * Registers watcher in the model effect scope.
@@ -294,7 +326,7 @@ const f = class f {
   watch(...t) {
     if (t.length === 0)
       throw new Error("watch requires at least one argument");
-    const e = t.length === 1 ? this[d].run(() => L(t[0])) : this[d].run(() => B(...t));
+    const e = t.length === 1 ? this[d].run(() => B(t[0])) : this[d].run(() => D(...t));
     if (!e)
       throw new Error("watchStopHandler is undefined");
     return this[p].add(e), () => {
@@ -302,29 +334,30 @@ const f = class f {
     };
   }
   computed(t, e) {
-    return this[d].run(() => D(t, e));
+    return this[d].run(() => T(t, e));
   }
   // @see https://github.com/trekhleb/javascript-algorithms/blob/master/src/algorithms/math/bits/updateBit.js
   updateBit(t, e, o) {
-    const a = o ? 1 : 0, n = ~(1 << e);
-    return t & n | a << e;
+    const c = o ? 1 : 0, h = ~(1 << e);
+    return t & h | c << e;
   }
   createAction(t) {
     const e = () => {
-      if (!this[S])
+      if (!this[m])
         throw new Error("Model not set");
-      return this[S];
-    }, o = h.create(
+      return this[m];
+    }, o = l.create(
       this,
       t,
       e,
-      this.setActionState.bind(this)
+      this.setActionState.bind(this),
+      this.validateArgs.bind(this)
     );
-    return this[g].set(t, o), this[y].set(o, ++this[v]), this.setActionState(o), o;
+    return this[w].set(t, o), this[y].set(o, ++this[A]), this.setActionState(o), o;
   }
   getActionStatesRef(t) {
-    const e = this[m].get(t) || T(0);
-    return this[m].get(t) === void 0 && this[m].set(t, e), e;
+    const e = this[g].get(t) || H(0);
+    return this[g].get(t) === void 0 && this[g].set(t, e), e;
   }
   /**
    * Gets Action instance by wrapped original method or create Action instance.
@@ -370,9 +403,9 @@ const f = class f {
    * @returns action
   */
   action(t) {
-    if (!(h.actionFlag in t && typeof t[h.actionFlag] == "function"))
+    if (!(l.actionFlag in t && typeof t[l.actionFlag] == "function"))
       throw new u("Action decorator is not applied to the method");
-    return this[g].get(t) || this.createAction(t);
+    return this[w].get(t) || this.createAction(t);
   }
   /**
    * It is public method in context ProtoModel,
@@ -388,6 +421,11 @@ const f = class f {
       o !== t.state && (this.getActionStatesRef(o).value = this.updateBit(this.getActionStatesRef(o).value, e, !1));
     this.getActionStatesRef(t.state).value = this.updateBit(this.getActionStatesRef(t.state).value, e, !0);
   }
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  validateArgs(t, ...e) {
+    const o = `validateArgs is not implemented for action ${t.name} in the model`;
+    return [new Error(o)];
+  }
   isModelOf(t) {
     return this instanceof t;
   }
@@ -397,9 +435,8 @@ const f = class f {
     }), this[p] = /* @__PURE__ */ new Set(), this[d].stop();
   }
 };
-i(f, "createModel", G);
-let A = f;
-function V(r, t) {
+let v = f;
+function N(r, t) {
   if (t.static)
     throw new Error("Action decorator is not supported for static methods");
   if (t.private)
@@ -407,26 +444,26 @@ function V(r, t) {
   let e;
   try {
     e = t.name.toString();
-  } catch (a) {
-    const l = `Invalid context. Can\`t get name of the method: ${a instanceof Error ? a.message : "unknown error"}`;
-    throw new Error(l);
+  } catch (c) {
+    const n = `Invalid context. Can\`t get name of the method: ${c instanceof Error ? c.message : "unknown error"}`;
+    throw new Error(n);
   }
   const o = {
     // Action constructor checks that model has method with the same name.
     // We can`t define anonymous function and change name because Function.name is readonly property.
     // So we need to create stub object to save original method name
-    [e]: function(...a) {
-      return this.action(o[e]).exec(...a);
+    [e]: function(...c) {
+      return this.action(o[e]).exec(...c);
     }
   };
-  return o[e][h.actionFlag] = r, o[e];
+  return o[e][l.actionFlag] = r, o[e];
 }
 export {
-  h as Action,
-  H as ActionError,
+  l as Action,
+  O as ActionError,
   u as ActionInternalError,
   b as ActionStatusConflictError,
-  O as ActionUnexpectedAbortError,
-  A as ProtoModel,
-  V as action
+  j as ActionUnexpectedAbortError,
+  v as ProtoModel,
+  N as action
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@vue-modeler/model",
-  "version": "2.2.0-beta.6",
+  "version": "2.2.4",
   "description": "A state management library based on models for Vue.js",
   "author": "abratko",
   "license": "MIT",