@decaf-ts/ui-decorators 0.5.14 → 0.5.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,4 @@
1
+ import { UIMediaBreakPoints } from "../ui/types";
1
2
  /**
2
3
  * @description Decorator that tags a class as a UI model
3
4
  * @summary Adds rendering capabilities to a model class by providing a render method
@@ -121,4 +122,116 @@ export declare function renderedBy(engine: string): (target: object, propertyKey
121
122
  * RenderingEngine->>System: renders with list item styling
122
123
  */
123
124
  export declare function uilistitem(tag?: string, props?: Record<string, any>): (original: any, propertyKey?: any) => void;
125
+ /**
126
+ * @description Decorator that adds event handlers to a UI model
127
+ * @summary Specifies event handlers that should be attached to the rendered model
128
+ * This decorator allows you to define event handlers that will be automatically
129
+ * attached to the rendered UI element. The handlers are passed as properties
130
+ * to the rendering engine.
131
+ *
132
+ * @param {Record<string, any>} [props] Object containing event handler functions and other properties
133
+ * @return {Function} A class decorator function
134
+ *
135
+ * @function uihandlers
136
+ * @category Class Decorators
137
+ *
138
+ * @example
139
+ * // Add event handlers to a model
140
+ * @uimodel('button')
141
+ * @uihandlers({
142
+ * onClick: (event) => console.log('Button clicked'),
143
+ * onMouseOver: (event) => console.log('Mouse over button'),
144
+ * disabled: false
145
+ * })
146
+ * class ClickableButton extends Model {
147
+ * @attribute()
148
+ * label: string;
149
+ * }
150
+ *
151
+ * // Add form submission handlers
152
+ * @uimodel('form')
153
+ * @uihandlers({
154
+ * onSubmit: (event) => {
155
+ * event.preventDefault();
156
+ * console.log('Form submitted');
157
+ * },
158
+ * onReset: (event) => console.log('Form reset')
159
+ * })
160
+ * class ContactForm extends Model {
161
+ * @attribute()
162
+ * email: string;
163
+ * }
164
+ *
165
+ * @mermaid
166
+ * sequenceDiagram
167
+ * participant System
168
+ * participant uihandlers
169
+ * participant Model
170
+ * participant RenderingEngine
171
+ * participant UI
172
+ * System->>uihandlers: apply to Model
173
+ * uihandlers->>Model: adds handler metadata
174
+ * Model->>RenderingEngine: requests rendering with handlers
175
+ * RenderingEngine->>UI: renders element with event handlers attached
176
+ * UI->>Model: triggers handlers on events
177
+ */
124
178
  export declare function uihandlers(props?: Record<string, any>): (original: any) => void;
179
+ /**
180
+ * @description Decorator that creates a layout container with grid specifications
181
+ * @summary Combines UI model functionality with layout grid configuration
182
+ * This decorator creates a UI model that acts as a layout container with specified
183
+ * column and row configurations. It's a convenience decorator that combines
184
+ * @uimodel with layout-specific properties for responsive grid layouts.
185
+ *
186
+ * @param {string} tag The HTML tag to use for the layout container
187
+ * @param {number} [cols=1] Number of columns in the grid layout
188
+ * @param {number|string[]} [rows=1] Number of rows or array of row definitions
189
+ * @param {UIMediaBreakPoints} [breakpoint='m'] Media breakpoint for responsive behavior
190
+ * @return {Function} A class decorator function
191
+ *
192
+ * @function uilayout
193
+ * @category Class Decorators
194
+ *
195
+ * @example
196
+ * // Create a simple 2-column layout
197
+ * @uilayout('div', 2, 3)
198
+ * class TwoColumnLayout extends Model {
199
+ * @attribute()
200
+ * @uilayoutitem(1, 1)
201
+ * header: string;
202
+ *
203
+ * @attribute()
204
+ * @uilayoutitem(1, 2)
205
+ * leftContent: string;
206
+ *
207
+ * @attribute()
208
+ * @uilayoutitem(2, 2)
209
+ * rightContent: string;
210
+ * }
211
+ *
212
+ * // Create a responsive layout with custom breakpoint
213
+ * @uilayout('section', 3, 2, 'l')
214
+ * class ResponsiveLayout extends Model {
215
+ * @attribute()
216
+ * @uilayoutitem(1, 1)
217
+ * title: string;
218
+ *
219
+ * @attribute()
220
+ * @uilayoutitem(2, 1)
221
+ * subtitle: string;
222
+ * }
223
+ *
224
+ * @mermaid
225
+ * sequenceDiagram
226
+ * participant System
227
+ * participant uilayout
228
+ * participant uimodel
229
+ * participant Model
230
+ * participant RenderingEngine
231
+ * System->>uilayout: apply to Model
232
+ * uilayout->>uimodel: call with layout props
233
+ * uimodel->>Model: adds model metadata with layout config
234
+ * Model->>RenderingEngine: requests rendering as layout container
235
+ * RenderingEngine->>System: renders grid layout with specified dimensions
236
+ */
237
+ export declare function uilayout(tag: string, cols?: number, rows?: number | string[], breakpoint?: UIMediaBreakPoints): (original: any, propertyKey?: any) => void;
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"model.js","sourceRoot":"","sources":["../../src/model/model.ts"],"names":[],"mappings":"","sourcesContent":["import { ModelErrorDefinition } from \"@decaf-ts/decorator-validation\";\nimport {\n  BuilderRegistry,\n  Comparable,\n  Constructor,\n  Hashable,\n  ModelArg,\n  ModelBuilderFunction,\n  ModelConstructor,\n  Serializable,\n  Validatable,\n} from \"@decaf-ts/decorator-validation\";\nimport { Renderable } from \"./Renderable\";\n\ndeclare module \"@decaf-ts/decorator-validation\" {\n  // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n  // @ts-expect-error\n  declare abstract class Model\n    implements\n      Validatable,\n      Serializable,\n      Hashable,\n      Comparable<Model>,\n      Renderable\n  {\n    protected constructor(arg?: ModelArg<Model>);\n\n    hasErrors(...exclusions: any[]): ModelErrorDefinition | undefined;\n    hasErrors(\n      previousVersion?: Model | any,\n      ...exclusions: any[]\n    ): ModelErrorDefinition | undefined;\n\n    /**\n     * @description Compares this model with another object for equality\n     * @summary Compare object equality recursively, checking all properties\n     * @param {any} obj - Object to compare to\n     * @param {...string} exceptions - Property names to be excluded from the comparison\n     * @return {boolean} True if objects are equal, false otherwise\n     */\n    equals(obj: any, ...exceptions: string[]): boolean;\n\n    /**\n     * @description Converts the model to a serialized string representation\n     * @summary Returns the serialized model according to the currently defined {@link Serializer}\n     * @return {string} Serialized representation of the model\n     */\n    serialize(): string;\n\n    /**\n     * @description Provides a string representation of the model\n     * @summary Override the implementation for JavaScript's default toString() method\n     * @return {string} String representation of the model\n     * @override\n     */\n    toString(): string;\n\n    /**\n     * @description Generates a hash code for the model\n     * @summary Defines a default implementation for object hash based on Java's string hash algorithm\n     * @return {string} Hash code for the model\n     */\n    hash(): string;\n\n    /**\n     * @description Converts a serialized string back to a model instance\n     * @summary Deserializes a Model from its string representation\n     * @param {string} str - The serialized string to deserialize\n     * @return {any} The deserialized model instance\n     * @throws {Error} If it fails to parse the string, or if it fails to build the model\n     */\n    static deserialize(str: string): any;\n\n    /**\n     * @description Iterates all common properties of obj (if existing) and self, and copies them onto self\n     * @summary Repopulates the Object properties with the ones from the new object\n     * @template T - Type extending Model\n     * @param {T} self - The target model instance to update\n     * @param {T|Record<string, any>} [obj] - The source object to copy properties from\n     * @return {T} The updated model instance\n     */\n    static fromObject<T extends Model>(\n      self: T,\n      obj?: T | Record<string, any>\n    ): T;\n\n    /**\n     * @description Iterates all common properties of obj (if existing) and self, and copies them onto self. Is aware of nested Model Objects and rebuilds them also. When List properties are decorated with {@link list}, the list items will also be rebuilt\n     * @summary Repopulates the instance with properties from the new Model Object, handling nested models\n     * @template T - Type extending Model\n     * @param {T} self - The target model instance to update\n     * @param {T|Record<string, any>} [obj] - The source model or object to copy properties from\n     * @return {T} The updated model instance\n     */\n    static fromModel<T extends Model>(\n      self: T,\n      obj?: T | Record<string, any>\n    ): T;\n\n    /**\n     * @description Configures the global model builder function used for creating model instances\n     * @summary Sets the Global {@link ModelBuilderFunction} used for model construction\n     * @param {ModelBuilderFunction} [builder] - The builder function to set, or undefined to reset\n     * @return {void}\n     */\n    static setBuilder(builder?: ModelBuilderFunction): void;\n\n    /**\n     * @description Returns the currently configured global model builder function\n     * @summary Retrieves the current global {@link ModelBuilderFunction} used for model construction\n     * @return {ModelBuilderFunction|undefined} The current builder function or undefined if not set\n     */\n    static getBuilder(): ModelBuilderFunction | undefined;\n\n    /**\n     * @description Retrieves the current model registry instance\n     * @summary Returns the current {@link ModelRegistryManager} used for model registration\n     * @return {BuilderRegistry<any>} ModelRegistry instance, defaults to {@link ModelRegistryManager}\n     * @private\n     */\n    private static getRegistry;\n\n    /**\n     * @description Sets the model registry to be used for model registration and retrieval\n     * @summary Configures the current model registry implementation\n     * @param {BuilderRegistry<any>} modelRegistry - The new implementation of Registry to use\n     * @return {void}\n     */\n    static setRegistry(modelRegistry: BuilderRegistry<any>): void;\n\n    /**\n     * @description Registers a model constructor with the model registry\n     * @summary Registers new Models for later retrieval and instantiation\n     * @template T - Type extending Model\n     * @param {ModelConstructor<T>} constructor - The model constructor to register\n     * @param {string} [name] - Optional name for registration, defaults to constructor name\n     * @return {void}\n     * @see ModelRegistry\n     */\n    static register<T extends Model>(\n      constructor: ModelConstructor<T>,\n      name?: string\n    ): void;\n\n    /**\n     * @description Retrieves a previously registered model constructor by name\n     * @summary Gets a registered Model {@link ModelConstructor} from the registry\n     * @template T - Type extending Model\n     * @param {string} name - The name of the model to retrieve\n     * @return {ModelConstructor<T>|undefined} The model constructor or undefined if not found\n     * @see ModelRegistry\n     */\n    static get<T extends Model>(name: string): ModelConstructor<T> | undefined;\n\n    /**\n     * @description Creates a new model instance from a plain object\n     * @summary Builds a model instance using the registered constructor\n     * @template T - Type extending Model\n     * @param {Record<string, any>} [obj] - The source object to build from\n     * @param {string} [clazz] - Optional class name to find the matching constructor\n     * @return {T} The built model instance\n     * @throws {Error} If clazz is not found, or obj is not a {@link Model} meaning it has no {@link ModelKeys.ANCHOR} property\n     * @see ModelRegistry\n     */\n    static build<T extends Model>(obj?: Record<string, any>, clazz?: string): T;\n\n    /**\n     * @description Retrieves metadata associated with a model instance\n     * @summary Gets the metadata attached to a model\n     * @template V - Type extending Model\n     * @param {V} model - The model instance to get metadata from\n     * @return {any} The model's metadata\n     */\n    static getMetadata<V extends Model>(model: V): any;\n\n    /**\n     * @description Retrieves all attribute names defined on a model\n     * @summary Gets the list of attributes for a model class or instance\n     * @template V - Type extending Model\n     * @param {(Constructor<V>|V)} model - The model constructor or instance\n     * @return {string[]} Array of attribute names\n     */\n    static getAttributes<V extends Model>(model: Constructor<V> | V): string[];\n\n    /**\n     * @description Compares two model instances for equality\n     * @summary Static method to check if two model instances are equal\n     * @template M - Type extending Model\n     * @param {M} obj1 - First model instance to compare\n     * @param {M} obj2 - Second model instance to compare\n     * @param {any[]} exceptions - Properties to exclude from comparison\n     * @return {boolean} True if models are equal, false otherwise\n     */\n    static equals<M extends Model>(\n      obj1: M,\n      obj2: M,\n      ...exceptions: any[]\n    ): boolean;\n\n    /**\n     * @description Validates a model and checks for errors\n     * @summary Static method to validate a model instance\n     * @template M - Type extending Model\n     * @param {M} model - The model instance to validate\n     * @param {string[]} propsToIgnore - Properties to exclude from validation\n     * @return {ModelErrorDefinition|undefined} Error definition if validation fails, undefined otherwise\n     */\n    static hasErrors<M extends Model>(\n      model: M,\n      ...propsToIgnore: string[]\n    ): ModelErrorDefinition | undefined;\n\n    /**\n     * @description Serializes a model instance to a string\n     * @summary Static method to convert a model to its serialized form\n     * @template M - Type extending Model\n     * @param {M} model - The model instance to serialize\n     * @return {string} The serialized representation of the model\n     */\n    static serialize<M extends Model>(model: M): any;\n\n    /**\n     * @description Generates a hash code for a model instance\n     * @summary Static method to create a hash code for a model\n     * @template M - Type extending Model\n     * @param {M} model - The model instance to hash\n     * @return {string} The hash code for the model\n     */\n    static hash<M extends Model>(model: M): any;\n\n    /**\n     * @description Builds a metadata key for reflection\n     * @summary Concatenates the model reflection prefix with the provided key string\n     * @param {string} str - The key string to append to the reflection prefix\n     * @return {string} The complete metadata key\n     */\n    static key(str: string): string;\n\n    /**\n     * @description Determines if an object is a model instance or has model metadata\n     * @summary Checks whether a given object is either an instance of the Model class or\n     * has model metadata attached to it. This function is essential for serialization and\n     * deserialization processes, as it helps identify model objects that need special handling.\n     * It safely handles potential errors during metadata retrieval.\n     *\n     * @param {Record<string, any>} target - The object to check\n     * @return {boolean} True if the object is a model instance or has model metadata, false otherwise\n     *\n     * @example\n     * ```typescript\n     * // Check if an object is a model\n     * const user = new User({ name: \"John\" });\n     * const isUserModel = isModel(user); // true\n     *\n     * // Check a plain object\n     * const plainObject = { name: \"John\" };\n     * const isPlainObjectModel = isModel(plainObject); // false\n     * ```\n     */\n    static isModel(target: Record<string, any>): boolean;\n\n    /**\n     * @description Checks if a property of a model is itself a model or has a model type\n     * @summary Determines whether a specific property of a model instance is either a model instance\n     * or has a type that is registered as a model. This function is used for model serialization\n     * and deserialization to properly handle nested models.\n     * @template M extends {@link Model}\n     * @param {M} target - The model instance to check\n     * @param {string} attribute - The property name to check\n     * @return {boolean | string | undefined} Returns true if the property is a model instance,\n     * the model name if the property has a model type, or undefined if not a model\n     */\n    static isPropertyModel<M extends Model>(\n      target: M,\n      attribute: string\n    ): boolean | string | undefined;\n\n    /**\n     * @description Checks if a property of a model is itself a model or has a model type\n     * @summary Determines whether a specific property of a model instance is either a model instance\n     * or has a type that is registered as a model. This function is used for model serialization\n     * and deserialization to properly handle nested models.\n     * @template R the expected UI code according to each rendering engine\n     * @param {any[]} args - optional engine specific args\n     */\n    render<R>(...args: any[]): R;\n  }\n}\n"]}
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9kZWwuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvbW9kZWwvbW9kZWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFJlbmRlcmFibGUgfSBmcm9tIFwiLi9SZW5kZXJhYmxlXCI7XG5cbmRlY2xhcmUgbW9kdWxlIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCIge1xuICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L2Jhbi10cy1jb21tZW50XG4gIC8vIEB0cy1leHBlY3QtZXJyb3JcbiAgZGVjbGFyZSBpbnRlcmZhY2UgTW9kZWwgZXh0ZW5kcyBSZW5kZXJhYmxlIHtcbiAgICAvKipcbiAgICAgKiBAZGVzY3JpcHRpb24gQ2hlY2tzIGlmIGEgcHJvcGVydHkgb2YgYSBtb2RlbCBpcyBpdHNlbGYgYSBtb2RlbCBvciBoYXMgYSBtb2RlbCB0eXBlXG4gICAgICogQHN1bW1hcnkgRGV0ZXJtaW5lcyB3aGV0aGVyIGEgc3BlY2lmaWMgcHJvcGVydHkgb2YgYSBtb2RlbCBpbnN0YW5jZSBpcyBlaXRoZXIgYSBtb2RlbCBpbnN0YW5jZVxuICAgICAqIG9yIGhhcyBhIHR5cGUgdGhhdCBpcyByZWdpc3RlcmVkIGFzIGEgbW9kZWwuIFRoaXMgZnVuY3Rpb24gaXMgdXNlZCBmb3IgbW9kZWwgc2VyaWFsaXphdGlvblxuICAgICAqIGFuZCBkZXNlcmlhbGl6YXRpb24gdG8gcHJvcGVybHkgaGFuZGxlIG5lc3RlZCBtb2RlbHMuXG4gICAgICogQHRlbXBsYXRlIFIgdGhlIGV4cGVjdGVkIFVJIGNvZGUgYWNjb3JkaW5nIHRvIGVhY2ggcmVuZGVyaW5nIGVuZ2luZVxuICAgICAqIEBwYXJhbSB7YW55W119IGFyZ3MgLSBvcHRpb25hbCBlbmdpbmUgc3BlY2lmaWMgYXJnc1xuICAgICAqL1xuICAgIHJlbmRlcjxSPiguLi5hcmdzOiBhbnlbXSk6IFI7XG4gIH1cbn1cbiJdfQ==
@@ -1,213 +1,6 @@
1
- import { ModelErrorDefinition } from "@decaf-ts/decorator-validation";
2
- import { BuilderRegistry, Comparable, Constructor, Hashable, ModelArg, ModelBuilderFunction, ModelConstructor, Serializable, Validatable } from "@decaf-ts/decorator-validation";
3
1
  import { Renderable } from "./Renderable";
4
2
  declare module "@decaf-ts/decorator-validation" {
5
- abstract class Model implements Validatable, Serializable, Hashable, Comparable<Model>, Renderable {
6
- protected constructor(arg?: ModelArg<Model>);
7
- hasErrors(...exclusions: any[]): ModelErrorDefinition | undefined;
8
- hasErrors(previousVersion?: Model | any, ...exclusions: any[]): ModelErrorDefinition | undefined;
9
- /**
10
- * @description Compares this model with another object for equality
11
- * @summary Compare object equality recursively, checking all properties
12
- * @param {any} obj - Object to compare to
13
- * @param {...string} exceptions - Property names to be excluded from the comparison
14
- * @return {boolean} True if objects are equal, false otherwise
15
- */
16
- equals(obj: any, ...exceptions: string[]): boolean;
17
- /**
18
- * @description Converts the model to a serialized string representation
19
- * @summary Returns the serialized model according to the currently defined {@link Serializer}
20
- * @return {string} Serialized representation of the model
21
- */
22
- serialize(): string;
23
- /**
24
- * @description Provides a string representation of the model
25
- * @summary Override the implementation for JavaScript's default toString() method
26
- * @return {string} String representation of the model
27
- * @override
28
- */
29
- toString(): string;
30
- /**
31
- * @description Generates a hash code for the model
32
- * @summary Defines a default implementation for object hash based on Java's string hash algorithm
33
- * @return {string} Hash code for the model
34
- */
35
- hash(): string;
36
- /**
37
- * @description Converts a serialized string back to a model instance
38
- * @summary Deserializes a Model from its string representation
39
- * @param {string} str - The serialized string to deserialize
40
- * @return {any} The deserialized model instance
41
- * @throws {Error} If it fails to parse the string, or if it fails to build the model
42
- */
43
- static deserialize(str: string): any;
44
- /**
45
- * @description Iterates all common properties of obj (if existing) and self, and copies them onto self
46
- * @summary Repopulates the Object properties with the ones from the new object
47
- * @template T - Type extending Model
48
- * @param {T} self - The target model instance to update
49
- * @param {T|Record<string, any>} [obj] - The source object to copy properties from
50
- * @return {T} The updated model instance
51
- */
52
- static fromObject<T extends Model>(self: T, obj?: T | Record<string, any>): T;
53
- /**
54
- * @description Iterates all common properties of obj (if existing) and self, and copies them onto self. Is aware of nested Model Objects and rebuilds them also. When List properties are decorated with {@link list}, the list items will also be rebuilt
55
- * @summary Repopulates the instance with properties from the new Model Object, handling nested models
56
- * @template T - Type extending Model
57
- * @param {T} self - The target model instance to update
58
- * @param {T|Record<string, any>} [obj] - The source model or object to copy properties from
59
- * @return {T} The updated model instance
60
- */
61
- static fromModel<T extends Model>(self: T, obj?: T | Record<string, any>): T;
62
- /**
63
- * @description Configures the global model builder function used for creating model instances
64
- * @summary Sets the Global {@link ModelBuilderFunction} used for model construction
65
- * @param {ModelBuilderFunction} [builder] - The builder function to set, or undefined to reset
66
- * @return {void}
67
- */
68
- static setBuilder(builder?: ModelBuilderFunction): void;
69
- /**
70
- * @description Returns the currently configured global model builder function
71
- * @summary Retrieves the current global {@link ModelBuilderFunction} used for model construction
72
- * @return {ModelBuilderFunction|undefined} The current builder function or undefined if not set
73
- */
74
- static getBuilder(): ModelBuilderFunction | undefined;
75
- /**
76
- * @description Retrieves the current model registry instance
77
- * @summary Returns the current {@link ModelRegistryManager} used for model registration
78
- * @return {BuilderRegistry<any>} ModelRegistry instance, defaults to {@link ModelRegistryManager}
79
- * @private
80
- */
81
- private static getRegistry;
82
- /**
83
- * @description Sets the model registry to be used for model registration and retrieval
84
- * @summary Configures the current model registry implementation
85
- * @param {BuilderRegistry<any>} modelRegistry - The new implementation of Registry to use
86
- * @return {void}
87
- */
88
- static setRegistry(modelRegistry: BuilderRegistry<any>): void;
89
- /**
90
- * @description Registers a model constructor with the model registry
91
- * @summary Registers new Models for later retrieval and instantiation
92
- * @template T - Type extending Model
93
- * @param {ModelConstructor<T>} constructor - The model constructor to register
94
- * @param {string} [name] - Optional name for registration, defaults to constructor name
95
- * @return {void}
96
- * @see ModelRegistry
97
- */
98
- static register<T extends Model>(constructor: ModelConstructor<T>, name?: string): void;
99
- /**
100
- * @description Retrieves a previously registered model constructor by name
101
- * @summary Gets a registered Model {@link ModelConstructor} from the registry
102
- * @template T - Type extending Model
103
- * @param {string} name - The name of the model to retrieve
104
- * @return {ModelConstructor<T>|undefined} The model constructor or undefined if not found
105
- * @see ModelRegistry
106
- */
107
- static get<T extends Model>(name: string): ModelConstructor<T> | undefined;
108
- /**
109
- * @description Creates a new model instance from a plain object
110
- * @summary Builds a model instance using the registered constructor
111
- * @template T - Type extending Model
112
- * @param {Record<string, any>} [obj] - The source object to build from
113
- * @param {string} [clazz] - Optional class name to find the matching constructor
114
- * @return {T} The built model instance
115
- * @throws {Error} If clazz is not found, or obj is not a {@link Model} meaning it has no {@link ModelKeys.ANCHOR} property
116
- * @see ModelRegistry
117
- */
118
- static build<T extends Model>(obj?: Record<string, any>, clazz?: string): T;
119
- /**
120
- * @description Retrieves metadata associated with a model instance
121
- * @summary Gets the metadata attached to a model
122
- * @template V - Type extending Model
123
- * @param {V} model - The model instance to get metadata from
124
- * @return {any} The model's metadata
125
- */
126
- static getMetadata<V extends Model>(model: V): any;
127
- /**
128
- * @description Retrieves all attribute names defined on a model
129
- * @summary Gets the list of attributes for a model class or instance
130
- * @template V - Type extending Model
131
- * @param {(Constructor<V>|V)} model - The model constructor or instance
132
- * @return {string[]} Array of attribute names
133
- */
134
- static getAttributes<V extends Model>(model: Constructor<V> | V): string[];
135
- /**
136
- * @description Compares two model instances for equality
137
- * @summary Static method to check if two model instances are equal
138
- * @template M - Type extending Model
139
- * @param {M} obj1 - First model instance to compare
140
- * @param {M} obj2 - Second model instance to compare
141
- * @param {any[]} exceptions - Properties to exclude from comparison
142
- * @return {boolean} True if models are equal, false otherwise
143
- */
144
- static equals<M extends Model>(obj1: M, obj2: M, ...exceptions: any[]): boolean;
145
- /**
146
- * @description Validates a model and checks for errors
147
- * @summary Static method to validate a model instance
148
- * @template M - Type extending Model
149
- * @param {M} model - The model instance to validate
150
- * @param {string[]} propsToIgnore - Properties to exclude from validation
151
- * @return {ModelErrorDefinition|undefined} Error definition if validation fails, undefined otherwise
152
- */
153
- static hasErrors<M extends Model>(model: M, ...propsToIgnore: string[]): ModelErrorDefinition | undefined;
154
- /**
155
- * @description Serializes a model instance to a string
156
- * @summary Static method to convert a model to its serialized form
157
- * @template M - Type extending Model
158
- * @param {M} model - The model instance to serialize
159
- * @return {string} The serialized representation of the model
160
- */
161
- static serialize<M extends Model>(model: M): any;
162
- /**
163
- * @description Generates a hash code for a model instance
164
- * @summary Static method to create a hash code for a model
165
- * @template M - Type extending Model
166
- * @param {M} model - The model instance to hash
167
- * @return {string} The hash code for the model
168
- */
169
- static hash<M extends Model>(model: M): any;
170
- /**
171
- * @description Builds a metadata key for reflection
172
- * @summary Concatenates the model reflection prefix with the provided key string
173
- * @param {string} str - The key string to append to the reflection prefix
174
- * @return {string} The complete metadata key
175
- */
176
- static key(str: string): string;
177
- /**
178
- * @description Determines if an object is a model instance or has model metadata
179
- * @summary Checks whether a given object is either an instance of the Model class or
180
- * has model metadata attached to it. This function is essential for serialization and
181
- * deserialization processes, as it helps identify model objects that need special handling.
182
- * It safely handles potential errors during metadata retrieval.
183
- *
184
- * @param {Record<string, any>} target - The object to check
185
- * @return {boolean} True if the object is a model instance or has model metadata, false otherwise
186
- *
187
- * @example
188
- * ```typescript
189
- * // Check if an object is a model
190
- * const user = new User({ name: "John" });
191
- * const isUserModel = isModel(user); // true
192
- *
193
- * // Check a plain object
194
- * const plainObject = { name: "John" };
195
- * const isPlainObjectModel = isModel(plainObject); // false
196
- * ```
197
- */
198
- static isModel(target: Record<string, any>): boolean;
199
- /**
200
- * @description Checks if a property of a model is itself a model or has a model type
201
- * @summary Determines whether a specific property of a model instance is either a model instance
202
- * or has a type that is registered as a model. This function is used for model serialization
203
- * and deserialization to properly handle nested models.
204
- * @template M extends {@link Model}
205
- * @param {M} target - The model instance to check
206
- * @param {string} attribute - The property name to check
207
- * @return {boolean | string | undefined} Returns true if the property is a model instance,
208
- * the model name if the property has a model type, or undefined if not a model
209
- */
210
- static isPropertyModel<M extends Model>(target: M, attribute: string): boolean | string | undefined;
3
+ interface Model extends Renderable {
211
4
  /**
212
5
  * @description Checks if a property of a model is itself a model or has a model type
213
6
  * @summary Determines whether a specific property of a model instance is either a model instance