@webda/models 0.0.0-stage → 4.0.0-beta.4

package/lib/model.model.d.ts

@@ -0,0 +1,286 @@
+import { WEBDA_EVENTS, WEBDA_PRIMARY_KEY, type PK, type PrimaryKeyType, type Storable, WEBDA_PRIMARY_KEY_SEPARATOR, WEBDA_STORAGE, ModelClass } from "./storable.js";
+import { WEBDA_DIRTY } from "@webda/utils";
+import type { SelfDTO, SelfJSONed } from "./types.js";
+import { type ModelRef } from "./relations.js";
+import type { Repository } from "./repositories/repository.js";
+import { ObjectSerializer, type SerializerContext } from "@webda/serialize";
+import { LoadParameters } from "./types.js";
+/**
+ * Make all properties optional except those in K.
+ */
+export type PartialExcept<T, K extends keyof T> = Partial<T> & Pick<T, K>;
+/**
+ * Make only the properties in K optional, keeping the rest required.
+ */
+export type ExceptPartial<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/**
+ * Allow simulated delete
+ */
+export declare const WEBDA_DELETED = "__deleted";
+/**
+ * Event sent by models
+ *
+ * Events are sent by the model to notify of changes
+ * after the changes are done
+ *
+ * If you need to prevent the change, you should extend the object
+ */
+export type ModelEvents<T = any> = {
+    Create: {
+        object_id: string;
+        object: T;
+    };
+    PartialUpdate: any;
+    Delete: {
+        object_id: string;
+    };
+    Update: {
+        object_id: string;
+        object: T;
+        previous: T;
+    };
+    Patch: {
+        object_id: string;
+        object: T;
+        previous: T;
+    };
+    Query: {
+        query: string;
+    };
+    Created: {
+        object_id: string;
+        object: T;
+    };
+    PartialUpdated: any;
+    Deleted: {
+        object_id: string;
+    };
+    Patched: {
+        object_id: string;
+        object: T;
+        previous: T;
+    };
+    Updated: {
+        object_id: string;
+        object: T;
+        previous: T;
+    };
+    Queried: {
+        query: string;
+        results: T[];
+        continuationToken?: string;
+    };
+};
+/**
+ * Serializer used by repositories to store a model.
+ *
+ * `ObjectSerializer` walks a model with `for...in`, which only reaches its
+ * enumerable fields. Accessors generated by `@webda/content-mapper` (Date
+ * coercion, relation links) are non-enumerable prototype properties whose
+ * values live in `WEBDA_STORAGE`, so a repository silently dropped them. This
+ * serializer adds them, and stores a relation link (`ModelLink`,
+ * `ModelLinksSimpleArray`, ...) as its `toJSON()` — the primary key(s) — which
+ * is what the generated setter accepts back on load and what queries compare
+ * against.
+ */
+export declare class ModelSerializer extends ObjectSerializer {
+    /**
+     * Serialize the model's fields, including those held in `WEBDA_STORAGE`
+     * @param obj - the model to serialize
+     * @param context - the serializer context
+     * @returns the serialized value and metadata
+     */
+    serializer(obj: any, context: SerializerContext): {
+        value: {
+            [key: string]: any;
+        };
+        metadata: {
+            [key: string]: any;
+        } | undefined;
+    };
+}
+declare const Model_base: {
+    new (...args: any[]): {
+        toProxy(): /*elided*/ any;
+    };
+    getRepository<T extends ModelClass>(this: T): Repository<T>;
+    create<T extends ModelClass>(this: T, data: InstanceType<T> extends infer T_1 ? { [K in keyof T_1 as K extends symbol ? never : InstanceType<T>[K] extends (...args: any[]) => any ? never : K]: T_1[K]; } : never, save?: boolean): Promise<InstanceType<T>>;
+    query<T extends ModelClass>(this: T, query: import("@webda/ql").WebdaQLString<InstanceType<T>>, params?: import("@webda/ql").QueryParameters): Promise<{
+        results: InstanceType<T>[];
+        continuationToken?: string;
+    }>;
+    iterate<T extends ModelClass>(this: T, query: import("@webda/ql").WebdaQLString<InstanceType<T>>, params?: import("@webda/ql").QueryParameters): AsyncGenerator<InstanceType<T>, any, any>;
+    ref<T extends ModelClass>(this: T, key: import("./storable.js").SettablePrimaryKey<InstanceType<T>>): import("./relations.js").ModelRefWithCreate<InstanceType<T>>;
+} & ObjectConstructor;
+/**
+ * Model object definition
+ *
+ * This is the core of many application
+ */
+export declare abstract class Model extends Model_base implements Storable {
+    /**
+     * Model events
+     */
+    [WEBDA_EVENTS]?: ModelEvents<this>;
+    /**
+     * Internal backing store for morpher-generated accessor properties.
+     * Populated automatically when getter/setter pairs are generated at build time.
+     */
+    protected [WEBDA_STORAGE]: Record<string, any>;
+    /**
+     * Properties that are dirty and need to be saved
+     * @private
+     */
+    [WEBDA_DIRTY]?: Set<string>;
+    /** Non-abstract class need to define their PrimaryKey */
+    abstract [WEBDA_PRIMARY_KEY]: readonly (keyof this)[];
+    /**
+     * K is inferred as the literal tuple type of `this.keyFields`,
+     * so K[number] is the exact union of keys you wrote.
+     * @returns the primary key value
+     */
+    getPrimaryKey<K extends readonly (keyof this)[]>(this: this & {
+        [WEBDA_PRIMARY_KEY]: K;
+        [WEBDA_PRIMARY_KEY_SEPARATOR]?: string;
+    }): PrimaryKeyType<this>;
+    /**
+     * Return the string representation of the primary key
+     * @returns the string UID
+     */
+    getUUID(): string;
+    /**
+     * Get a reference to this model instance in its repository
+     * @returns a model reference
+     */
+    ref(): ModelRef<this>;
+    /**
+     * Set the primary key of the model
+     * @param this - the model instance
+     * @param value - the primary key value to set
+     * @returns the model instance
+     */
+    setPrimaryKey<K extends readonly (keyof this)[]>(this: this & {
+        [WEBDA_PRIMARY_KEY]: K;
+    }, value: PK<this, K[number]>): this;
+    /**
+     * Get the repository associated with this model class
+     * @returns the repository
+     */
+    getRepository(): Repository<ModelClass<this>>;
+    /**
+     * Register Model custom serializer
+     * @param this - the model class constructor
+     * @param overwrite - whether to overwrite an existing serializer
+     * @param identifier - fully-qualified model identifier (e.g. `WebdaSample/User`)
+     *   used to namespace the serializer key when multiple classes share the same
+     *   JS constructor name. Defaults to the constructor's own name.
+     *
+     * TODO Might want to move to deserialize static function
+     */
+    static registerSerializer<T extends ModelClass>(this: T & {
+        fromJSON?: (data: any) => InstanceType<T>;
+        getStaticProperties?: () => any;
+    }, overwrite?: boolean, identifier?: string): void;
+    /**
+     * Serialize the model to JSON.
+     *
+     * Uses `for...in` to include both own enumerable properties (regular class fields)
+     * and inherited enumerable prototype getters generated by the morpher for coercible
+     * fields (e.g. Date). Symbol-keyed internals and methods are excluded automatically.
+     * @returns the model instance
+     */
+    toJSON(): this;
+    /**
+     * Public representation of the model: its JSON form without `__`-prefixed
+     * (server-only) keys, at any depth. Dates are serialized as strings.
+     *
+     * Implemented as a `JSON.parse(JSON.stringify(this))` round-trip, so circular
+     * references throw, BigInt throws and Buffers become `{ type: "Buffer", data }`.
+     * A model with such fields must override `toDTO`.
+     * @returns the DTO
+     */
+    toDTO(): SelfDTO<this>;
+    /**
+     * Reload the model from the repository, updating all properties in-place
+     * @returns the refreshed model instance
+     */
+    refresh(): Promise<this>;
+    /**
+     * Save the model to the repository
+     * @returns the saved model instance
+     */
+    save(): Promise<this>;
+    /**
+     * Helper to emit events from the class
+     * @param event - the event name to emit
+     * @param payload - the event data
+     */
+    protected emit<T extends keyof this[typeof WEBDA_EVENTS]>(event: T, payload: this[typeof WEBDA_EVENTS][T]): Promise<void>;
+    /**
+     * Custom deserializers for the model
+     * @returns a map of field deserializers, or undefined
+     */
+    static getDeserializers<T extends ModelClass>(this: T): Partial<Record<keyof InstanceType<T>, (value: any) => any>> | undefined;
+    /** Built-in deserializer helpers for common types */
+    static DefaultDeserializer: {
+        Date: (value: string | number | Date | undefined) => Date;
+    };
+    /**
+     * Deserialize the model
+     * @param this - the model class constructor
+     * @param data - the raw data to deserialize
+     * @param instance - optional existing instance to populate
+     * @returns the deserialized model instance
+     */
+    static deserialize<T extends ModelClass, K extends object = InstanceType<T>>(this: T, data: any, instance?: K): K;
+    /**
+     * Allow to load from Storage, Dto and helper formats
+     * @param params - the data to load
+     * @returns the model instance
+     */
+    load(params: LoadParameters<this>): this;
+    /**
+     * Check whether this model instance has been soft-deleted
+     * @returns true if soft-deleted
+     */
+    isDeleted(): any;
+    /**
+     * Delete a model
+     * @returns a promise resolving when deleted (void)
+     */
+    delete(): Promise<void>;
+    /**
+     * Patch the object
+     * @param data - the partial data to patch with
+     * @returns the patched model instance
+     */
+    patch(data: Partial<SelfJSONed<this>>): Promise<this>;
+}
+/**
+ * Simple model with a UUID
+ */
+export declare class UuidModel extends Model {
+    /**
+     * Definition of the primary key
+     */
+    [WEBDA_PRIMARY_KEY]: readonly ["uuid"];
+    /**
+     * UUID of the model
+     * @format uuid
+     */
+    uuid: string;
+    /**
+     * Constructor
+     * @param data - optional initial data
+     */
+    constructor(data?: Partial<UuidModel>);
+    /**
+     * Generate a new UUID for this model.
+     * Override to provide custom ID generation logic.
+     * @param data - Optional partial data used during construction
+     * @returns the generated UUID string
+     */
+    generateUUID(data?: any): string;
+}
+export {};
+//# sourceMappingURL=model.model.d.ts.map

package/lib/model.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.model.d.ts","sourceRoot":"","sources":["../src/model.model.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,KAAK,EAAE,EACP,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,2BAA2B,EAC3B,aAAa,EACb,UAAU,EACX,MAAM,eAAe,CAAC;AACvB,OAAO,EAAc,WAAW,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,KAAK,EAAW,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE/D,OAAO,EAAE,KAAK,QAAQ,EAAgB,MAAM,gBAAgB,CAAC;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAsB,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAG5C;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC1E;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEnF;;GAEG;AACH,eAAO,MAAM,aAAa,cAAc,CAAC;AAEzC;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,GAAG,IAAI;IACjC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,CAAC,CAAA;KAAE,CAAC;IACzC,aAAa,EAAE,GAAG,CAAC;IACnB,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9B,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,CAAC,CAAC;QAAC,QAAQ,EAAE,CAAC,CAAA;KAAE,CAAC;IACtD,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,CAAC,CAAC;QAAC,QAAQ,EAAE,CAAC,CAAA;KAAE,CAAC;IACrD,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAEzB,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,CAAC,CAAA;KAAE,CAAC;IAC1C,cAAc,EAAE,GAAG,CAAC;IACpB,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/B,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,CAAC,CAAC;QAAC,QAAQ,EAAE,CAAC,CAAA;KAAE,CAAC;IACvD,OAAO,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,CAAC,CAAC;QAAC,QAAQ,EAAE,CAAC,CAAA;KAAE,CAAC;IACvD,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACtE,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,iBAAiB;;;;;;;MAc9C;CACF;;;;;;;;;;;;;;AAED;;;;GAIG;AACH,8BAAsB,KAAM,SAAQ,UAAoC,YAAW,QAAQ;IACzF;;OAEG;IACH,CAAC,YAAY,CAAC,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC;;;OAGG;IACH,SAAS,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IACpD;;;OAGG;IACH,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAE5B,yDAAyD;IACzD,SAAgB,CAAC,iBAAiB,CAAC,EAAE,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;IAE7D;;;;OAIG;IACH,aAAa,CAAC,CAAC,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,EAC7C,IAAI,EAAE,IAAI,GAAG;QAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QAAC,CAAC,2BAA2B,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAC9E,cAAc,CAAC,IAAI,CAAC,CAYtB;IAED;;;OAGG;IACH,OAAO,IAAI,MAAM,CAEhB;IAED;;;OAGG;IACH,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAEpB;IAED;;;;;OAKG;IACH,aAAa,CAAC,CAAC,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,EAC7C,IAAI,EAAE,IAAI,GAAG;QAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAA;KAAE,EACvC,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GACzB,IAAI,CASN;IAED;;;OAGG;IACH,aAAa,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAE5C;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,kBAAkB,CAAC,CAAC,SAAS,UAAU,EAC5C,IAAI,EAAE,CAAC,GAAG;QAAE,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC;QAAC,mBAAmB,CAAC,EAAE,MAAM,GAAG,CAAA;KAAE,EACxF,SAAS,GAAE,OAAc,EACzB,UAAU,CAAC,EAAE,MAAM,GAClB,IAAI,CAgBN;IAED;;;;;;;OAOG;IACH,MAAM,IAAI,IAAI,CAEb;IAED;;;;;;;;OAQG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAarB;IAED;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAK7B;IAED;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAW1B;IAED;;;;OAIG;IACH,UAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,OAAO,YAAY,CAAC,EAC5D,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,IAAI,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,GACpC,OAAO,CAAC,IAAI,CAAC,CAEf;IAED;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,CAAC,SAAS,UAAU,EAC1C,IAAI,EAAE,CAAC,GACN,OAAO,CAAC,MAAM,CAAC,MAAM,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,SAAS,CAEzE;IAED,qDAAqD;IACrD,MAAM,CAAC,mBAAmB;QACxB,IAAI,UAAU,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;MAChD;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,CA6BhH;IAED;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI,CAIvC;IAED;;;OAGG;IACH,SAAS,QAER;IAED;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAK5B;IAED;;;;OAIG;IACG,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAW1D;CACF;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC;;OAEG;IACI,CAAC,iBAAiB,CAAC,YAAI,MAAM,EAAW;IAC/C;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,YAAY,IAAI,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,EAGpC;IAED;;;;;OAKG;IACH,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,MAAM,CAE/B;CACF"}

package/lib/model.model.js

@@ -0,0 +1,336 @@
+var _a, _b;
+import { WEBDA_EVENTS, WEBDA_PRIMARY_KEY, WEBDA_PRIMARY_KEY_SEPARATOR, WEBDA_STORAGE } from "./storable.js";
+import { WEBDA_DIRTY } from "@webda/utils";
+import { randomUUID } from "crypto";
+import { RelationRole } from "./relations.js";
+import { ObjectSerializer, registerSerializer } from "@webda/serialize";
+import { RepositoryStorageClassMixIn } from "./repositories/hooks.js";
+/**
+ * Allow simulated delete
+ */
+export const WEBDA_DELETED = "__deleted";
+/**
+ * Serializer used by repositories to store a model.
+ *
+ * `ObjectSerializer` walks a model with `for...in`, which only reaches its
+ * enumerable fields. Accessors generated by `@webda/content-mapper` (Date
+ * coercion, relation links) are non-enumerable prototype properties whose
+ * values live in `WEBDA_STORAGE`, so a repository silently dropped them. This
+ * serializer adds them, and stores a relation link (`ModelLink`,
+ * `ModelLinksSimpleArray`, ...) as its `toJSON()` — the primary key(s) — which
+ * is what the generated setter accepts back on load and what queries compare
+ * against.
+ */
+export class ModelSerializer extends ObjectSerializer {
+    /**
+     * Serialize the model's fields, including those held in `WEBDA_STORAGE`
+     * @param obj - the model to serialize
+     * @param context - the serializer context
+     * @returns the serialized value and metadata
+     */
+    serializer(obj, context) {
+        const storage = obj?.[WEBDA_STORAGE];
+        if (!storage || !Object.keys(storage).length) {
+            return super.serializer(obj, context);
+        }
+        const fields = {};
+        for (const key in obj) {
+            fields[key] = obj[key];
+        }
+        for (const key of Object.keys(storage)) {
+            const value = obj[key];
+            fields[key] = value !== null && typeof value === "object" && RelationRole in value ? value.toJSON() : value;
+        }
+        return super.serializer(fields, context);
+    }
+}
+/**
+ * Model object definition
+ *
+ * This is the core of many application
+ */
+export class Model extends RepositoryStorageClassMixIn(Object) {
+    constructor() {
+        super(...arguments);
+        /**
+         * Internal backing store for morpher-generated accessor properties.
+         * Populated automatically when getter/setter pairs are generated at build time.
+         */
+        this[_a] = {};
+    }
+    static { _a = WEBDA_STORAGE; }
+    /**
+     * K is inferred as the literal tuple type of `this.keyFields`,
+     * so K[number] is the exact union of keys you wrote.
+     * @returns the primary key value
+     */
+    getPrimaryKey() {
+        const result = {};
+        if (this[WEBDA_PRIMARY_KEY].length === 1) {
+            return this[this[WEBDA_PRIMARY_KEY][0]];
+        }
+        for (const k of this[WEBDA_PRIMARY_KEY]) {
+            result[k] = this[k];
+        }
+        result.toString = () => {
+            return this[WEBDA_PRIMARY_KEY].map(k => `${this[k]}`).join(this[WEBDA_PRIMARY_KEY_SEPARATOR] || "_");
+        };
+        return result;
+    }
+    /**
+     * Return the string representation of the primary key
+     * @returns the string UID
+     */
+    getUUID() {
+        return this.getRepository().getUID(this);
+    }
+    /**
+     * Get a reference to this model instance in its repository
+     * @returns a model reference
+     */
+    ref() {
+        return this.getRepository().ref(this.getPrimaryKey());
+    }
+    /**
+     * Set the primary key of the model
+     * @param this - the model instance
+     * @param value - the primary key value to set
+     * @returns the model instance
+     */
+    setPrimaryKey(value) {
+        if (this[WEBDA_PRIMARY_KEY].length === 1) {
+            this[this[WEBDA_PRIMARY_KEY][0]] = value;
+        }
+        else {
+            for (const k of this[WEBDA_PRIMARY_KEY]) {
+                this[k] = value[k];
+            }
+        }
+        return this;
+    }
+    /**
+     * Get the repository associated with this model class
+     * @returns the repository
+     */
+    getRepository() {
+        return this.constructor.getRepository();
+    }
+    /**
+     * Register Model custom serializer
+     * @param this - the model class constructor
+     * @param overwrite - whether to overwrite an existing serializer
+     * @param identifier - fully-qualified model identifier (e.g. `WebdaSample/User`)
+     *   used to namespace the serializer key when multiple classes share the same
+     *   JS constructor name. Defaults to the constructor's own name.
+     *
+     * TODO Might want to move to deserialize static function
+     */
+    static registerSerializer(overwrite = true, identifier) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const clazz = this;
+        if (!clazz.getStaticProperties) {
+            clazz.getStaticProperties = () => ({});
+        }
+        // Use the fully-qualified model identifier (e.g. "WebdaSample/User") when
+        // available so two classes that share a JS constructor name — like an app
+        // override shadowing a framework-provided model — don't collide on the
+        // same serializer key.
+        const typeKey = identifier ? `@webda/models/${identifier}` : `@webda/models/${this.prototype.constructor.name}`;
+        // The base ObjectSerializer.deserializer is responsible for invoking the
+        // model's compile-time-emitted `__hydrateBehaviors(rawData)` method (when
+        // present), so a model loaded from a store ends up with the same wired
+        // Behavior instances as one populated via `model.load(...)`.
+        registerSerializer(typeKey, new ModelSerializer(clazz, clazz.getStaticProperties()), overwrite);
+    }
+    /**
+     * Serialize the model to JSON.
+     *
+     * Uses `for...in` to include both own enumerable properties (regular class fields)
+     * and inherited enumerable prototype getters generated by the morpher for coercible
+     * fields (e.g. Date). Symbol-keyed internals and methods are excluded automatically.
+     * @returns the model instance
+     */
+    toJSON() {
+        return this;
+    }
+    /**
+     * Public representation of the model: its JSON form without `__`-prefixed
+     * (server-only) keys, at any depth. Dates are serialized as strings.
+     *
+     * Implemented as a `JSON.parse(JSON.stringify(this))` round-trip, so circular
+     * references throw, BigInt throws and Buffers become `{ type: "Buffer", data }`.
+     * A model with such fields must override `toDTO`.
+     * @returns the DTO
+     */
+    toDTO() {
+        const strip = (value) => {
+            if (Array.isArray(value))
+                return value.map(strip);
+            if (value && typeof value === "object") {
+                const out = {};
+                for (const [k, v] of Object.entries(value)) {
+                    if (!k.startsWith("__"))
+                        out[k] = strip(v);
+                }
+                return out;
+            }
+            return value;
+        };
+        return strip(JSON.parse(JSON.stringify(this)));
+    }
+    /**
+     * Reload the model from the repository, updating all properties in-place
+     * @returns the refreshed model instance
+     */
+    async refresh() {
+        const repo = this.getRepository();
+        const data = await repo.get(this.getPrimaryKey());
+        Object.assign(this, data);
+        return this;
+    }
+    /**
+     * Save the model to the repository
+     * @returns the saved model instance
+     */
+    async save() {
+        const repo = this.getRepository();
+        const concreteThis = this;
+        if (!concreteThis["dirty"]?.valueOf()) {
+            await repo.upsert(concreteThis);
+        }
+        else {
+            const patch = concreteThis["dirty"].getPatch();
+            await repo.patch(this.getPrimaryKey(), patch);
+            concreteThis["dirty"].clear();
+        }
+        return this;
+    }
+    /**
+     * Helper to emit events from the class
+     * @param event - the event name to emit
+     * @param payload - the event data
+     */
+    async emit(event, payload) {
+        await this.getRepository().emit(event, payload);
+    }
+    /**
+     * Custom deserializers for the model
+     * @returns a map of field deserializers, or undefined
+     */
+    static getDeserializers() {
+        return undefined;
+    }
+    /** Built-in deserializer helpers for common types */
+    static { this.DefaultDeserializer = {
+        Date: (value) => (value ? new Date(value) : new Date())
+    }; }
+    /**
+     * Deserialize the model
+     * @param this - the model class constructor
+     * @param data - the raw data to deserialize
+     * @param instance - optional existing instance to populate
+     * @returns the deserialized model instance
+     */
+    static deserialize(data, instance) {
+        if (!instance) {
+            instance = new this(data);
+            return instance;
+        }
+        // Deserialize with custom deserializers if any
+        const deserializers = this.getDeserializers ? this.getDeserializers() : undefined;
+        let info = deserializers ? {} : data;
+        if (deserializers) {
+            for (const key in data) {
+                if (deserializers[key]) {
+                    info[key] = deserializers[key](data[key]);
+                }
+                else {
+                    info[key] = data[key];
+                }
+            }
+        }
+        else {
+            info = data;
+        }
+        Object.assign(instance, info);
+        // Hydrate Behavior-typed attributes by delegating to the per-model
+        // `__hydrateBehaviors(rawData)` method generated by `@webda/content-mapper`
+        // transformer for any model that declares Behavior-typed properties.
+        // Models without such properties simply lack the method, so the optional
+        // chain makes this a no-op for them. The same call sits inside the base
+        // ObjectSerializer.deserializer so both load paths share the contract.
+        instance.__hydrateBehaviors?.(data);
+        return instance;
+    }
+    /**
+     * Allow to load from Storage, Dto and helper formats
+     * @param params - the data to load
+     * @returns the model instance
+     */
+    load(params) {
+        // @ts-ignore
+        this.constructor.deserialize(params, this);
+        return this;
+    }
+    /**
+     * Check whether this model instance has been soft-deleted
+     * @returns true if soft-deleted
+     */
+    isDeleted() {
+        return this[WEBDA_DELETED];
+    }
+    /**
+     * Delete a model
+     * @returns a promise resolving when deleted (void)
+     */
+    async delete() {
+        // Mark the model as deleted
+        // return this.ref().setAttribute(WEBDA_DELETED, Date.now());
+        // or delete for real
+        return this.ref().delete();
+    }
+    /**
+     * Patch the object
+     * @param data - the partial data to patch with
+     * @returns the patched model instance
+     */
+    async patch(data) {
+        this.load(data);
+        const repo = this.getRepository();
+        await repo.patch(this.getPrimaryKey(), Object.keys(data).reduce((acc, key) => {
+            acc[key] = this[key];
+            return acc;
+        }, {}));
+        return this;
+    }
+}
+/**
+ * Simple model with a UUID
+ */
+export class UuidModel extends Model {
+    static { _b = WEBDA_PRIMARY_KEY; }
+    /**
+     * Constructor
+     * @param data - optional initial data
+     */
+    constructor(data) {
+        super();
+        /**
+         * Definition of the primary key
+         */
+        this[_b] = ["uuid"];
+        this.uuid = data?.uuid || this.generateUUID(data);
+    }
+    /**
+     * Generate a new UUID for this model.
+     * Override to provide custom ID generation logic.
+     * @param data - Optional partial data used during construction
+     * @returns the generated UUID string
+     */
+    generateUUID(data) {
+        return randomUUID();
+    }
+}
+// Register serializer for UuidModel
+UuidModel.registerSerializer();
+//# sourceMappingURL=model.model.js.map

package/lib/model.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.model.js","sourceRoot":"","sources":["../src/model.model.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,YAAY,EACZ,iBAAiB,EAIjB,2BAA2B,EAC3B,aAAa,EAEd,MAAM,eAAe,CAAC;AACvB,OAAO,EAAc,WAAW,EAAE,MAAM,cAAc,CAAC;AAEvD,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAiB,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE7D,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAA0B,MAAM,kBAAkB,CAAC;AAEhG,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAWtE;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,WAAW,CAAC;AA0BzC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,eAAgB,SAAQ,gBAAgB;IACnD;;;;;OAKG;IACH,UAAU,CAAC,GAAQ,EAAE,OAA0B;QAC7C,MAAM,OAAO,GAAoC,GAAG,EAAE,CAAC,aAAa,CAAC,CAAC;QACtE,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;YAC7C,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC;QACD,MAAM,MAAM,GAAwB,EAAE,CAAC;QACvC,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;YACtB,MAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACvB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,YAAY,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAC9G,CAAC;QACD,OAAO,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAgB,KAAM,SAAQ,2BAA2B,CAAC,MAAM,CAAC;IAAvE;;QAKE;;;WAGG;QACO,QAAe,GAAwB,EAAE,CAAC;IA2RtD,CAAC;kBA3RY,aAAa;IAUxB;;;;OAIG;IACH,aAAa;QAGX,MAAM,MAAM,GAAG,EAA2B,CAAC;QAC3C,IAAI,IAAI,CAAC,iBAAiB,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzC,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAQ,CAAC;QACjD,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACxC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACtB,CAAC;QACD,MAAM,CAAC,QAAQ,GAAG,GAAG,EAAE;YACrB,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;QACvG,CAAC,CAAC;QACF,OAAO,MAAa,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,GAAG;QACD,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,CAAQ,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAEX,KAA0B;QAE1B,IAAI,IAAI,CAAC,iBAAiB,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAY,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBACvC,IAAY,CAAC,CAAC,CAAC,GAAI,KAAa,CAAC,CAAQ,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAQ,IAAI,CAAC,WAAmB,CAAC,aAAa,EAAE,CAAC;IACnD,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,kBAAkB,CAEvB,SAAS,GAAY,IAAI,EACzB,UAAmB;QAEnB,4DAA4D;QAC5D,MAAM,KAAK,GAAuF,IAAI,CAAC;QACvG,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC;YAC/B,KAAK,CAAC,mBAAmB,GAAG,GAAG,EAAE,CAAC,CAAC,EAAE,CAAQ,CAAC;QAChD,CAAC;QACD,0EAA0E;QAC1E,0EAA0E;QAC1E,uEAAuE;QACvE,uBAAuB;QACvB,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,iBAAiB,UAAU,EAAE,CAAC,CAAC,CAAC,iBAAiB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAChH,yEAAyE;QACzE,0EAA0E;QAC1E,uEAAuE;QACvE,6DAA6D;QAC7D,kBAAkB,CAAC,OAAO,EAAE,IAAI,eAAe,CAAC,KAAY,EAAE,KAAK,CAAC,mBAAmB,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;OAOG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK;QACH,MAAM,KAAK,GAAG,CAAC,KAAU,EAAO,EAAE;YAChC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAAE,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAClD,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACvC,MAAM,GAAG,GAAQ,EAAE,CAAC;gBACpB,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC3C,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;wBAAE,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC7C,CAAC;gBACD,OAAO,GAAG,CAAC;YACb,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAClC,MAAM,YAAY,GAA6C,IAAW,CAAC;QAC3E,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC;YACtC,MAAM,IAAI,CAAC,MAAM,CAAC,YAA6B,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAmB,CAAC;YAChE,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,CAAC,CAAC;YAC9C,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;QAChC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,IAAI,CAClB,KAAQ,EACR,OAAqC;QAErC,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,gBAAgB;QAGrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,qDAAqD;aAC9C,wBAAmB,GAAG;QAC3B,IAAI,EAAE,CAAC,KAAyC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;KAC5F,AAFyB,CAExB;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAoE,IAAS,EAAE,QAAY;QAC3G,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,IAAK,IAAY,CAAC,IAAI,CAAC,CAAC;YACnC,OAAO,QAAa,CAAC;QACvB,CAAC;QACD,+CAA+C;QAC/C,MAAM,aAAa,GAAI,IAAY,CAAC,gBAAgB,CAAC,CAAC,CAAE,IAAY,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACpG,IAAI,IAAI,GAAQ,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC1C,IAAI,aAAa,EAAE,CAAC;YAClB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,IAAI,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvB,IAAI,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC5C,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,IAAI,CAAC;QACd,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAE9B,mEAAmE;QACnE,4EAA4E;QAC5E,qEAAqE;QACrE,yEAAyE;QACzE,wEAAwE;QACxE,uEAAuE;QACtE,QAAgB,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,CAAC;QAC7C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,MAA4B;QAC/B,aAAa;QACb,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,OAAQ,IAAY,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM;QACV,4BAA4B;QAC5B,6DAA6D;QAC7D,qBAAqB;QACrB,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,IAA+B;QACzC,IAAI,CAAC,IAAI,CAAC,IAAW,CAAC,CAAC;QACvB,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAClC,MAAM,IAAI,CAAC,KAAK,CACd,IAAI,CAAC,aAAa,EAAE,EACpB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACnC,GAAW,CAAC,GAAG,CAAC,GAAI,IAAY,CAAC,GAAG,CAAC,CAAC;YACvC,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAmB,CAAC,CACxB,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;kBAI1B,iBAAiB;IAOzB;;;OAGG;IACH,YAAY,IAAyB;QACnC,KAAK,EAAE,CAAC;QAfV;;WAEG;QACI,QAAmB,GAAG,CAAC,MAAM,CAAU,CAAC;QAa7C,IAAI,CAAC,IAAI,GAAG,IAAI,EAAE,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,IAAU;QACrB,OAAO,UAAU,EAAE,CAAC;IACtB,CAAC;CACF;AAED,oCAAoC;AACpC,SAAS,CAAC,kBAAkB,EAAE,CAAC"}