@webda/core 4.0.0-beta.2 → 4.0.0-beta.4

package/lib/models/registry.model.js

@@ -0,0 +1,104 @@
+import { UuidModel } from "@webda/models";
+/**
+ * Specific type for registry
+ */
+export class RegistryEntry extends UuidModel {
+    /** Create a new RegistryEntry
+     * @param data - initial data
+     */
+    constructor(data) {
+        super(data);
+        Object.assign(this, data);
+    }
+    /**
+     * Registry entries are not serializable to DTO
+     * @returns the result
+     */
+    toDTO() {
+        return undefined;
+    }
+    /**
+     * No-op DTO deserialization for registry entries
+     * @returns this for chaining
+     */
+    fromDTO() {
+        return this;
+    }
+    /**
+     * Remove an attribute from the registry
+     * @param uuid - the unique identifier
+     * @param attribute - the attribute name
+     * @returns the result
+     */
+    static async removeAttribute(uuid, attribute) {
+        // @ts-ignore
+        return await RegistryEntry.ref(uuid).removeAttribute(attribute);
+    }
+    /**
+     * Set an attribute from the registry
+     * @param uuid - the unique identifier
+     * @param attribute - the attribute name
+     * @param value - the value to set
+     * @returns the result
+     */
+    static async setAttribute(uuid, attribute, value) {
+        // @ts-ignore
+        return await RegistryEntry.ref(uuid).setAttribute(attribute, value);
+    }
+    /**
+     * Helper for upsert
+     * @param uuid - the unique identifier
+     * @param data - the data to process
+     * @returns the result
+     */
+    static async get(uuid, data) {
+        return data
+            ? await RegistryEntry.ref(uuid).upsert(data)
+            : await RegistryEntry.ref(uuid).get();
+    }
+    /**
+     * Helper for upsert
+     * @param uuid - the unique identifier
+     * @param data - the data to process
+     * @returns the result
+     */
+    static async put(uuid, data) {
+        return await RegistryEntry.ref(uuid).upsert(data);
+    }
+    /**
+     * Delete a registry entry by UUID
+     * @param uuid - the unique identifier
+     * @returns the result
+     */
+    static async delete(uuid) {
+        return await RegistryEntry.ref(uuid).delete();
+    }
+    /**
+     * Check if a registry entry exists
+     * @param uuid - the unique identifier
+     * @returns the result
+     */
+    static exists(uuid) {
+        return RegistryEntry.ref(uuid).exists();
+    }
+    /**
+     * Perform a conditional patch
+     * @param uuid - the unique identifier
+     * @param patch - the patch to apply
+     * @param conditionField - the condition field name
+     * @param conditionValue - the condition value
+     * @returns the result
+     */
+    static patch(uuid, patch, conditionField, conditionValue) {
+        // @ts-ignore
+        return RegistryEntry.ref(uuid).patch(patch, conditionField, conditionValue);
+    }
+}
+/**
+ * Use the registry
+ * @returns the result
+ */
+export function useRegistry() {
+    return RegistryEntry;
+}
+//# sourceMappingURL=registry.model.js.map

package/lib/models/registry.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.model.js","sourceRoot":"","sources":["../../src/models/registry.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,SAAS,EACV,MAAM,eAAe,CAAC;AAGvB;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC1C;;OAEG;IACH,YAAY,IAA8B;QACxC,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,SAAiB;QAC1D,aAAa;QACb,OAAO,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,eAAe,CAAM,SAAS,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,SAAiB,EAAE,KAAU;QACnE,aAAa;QACb,OAAO,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,YAAY,CAAM,SAAS,EAAE,KAAK,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,CAAU,IAAY,EAAE,IAAQ;QAC9C,OAAO,IAAI;YACT,CAAC,CAAM,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAM,IAAI,CAAC;YACtD,CAAC,CAAoB,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,CAAU,IAAY,EAAE,IAAO;QAC7C,OAAY,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAM,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAY;QAC9B,OAAO,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,IAAY;QACxB,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1C,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,IAAY,EAAE,KAAU,EAAE,cAAsB,EAAE,cAAmB;QAChF,aAAa;QACb,OAAO,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,EAAO,cAAc,EAAE,cAAc,CAAC,CAAC;IACnF,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW;IACzB,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/lib/models/rolemodel.model.d.ts

@@ -0,0 +1,28 @@
+import { Model } from "@webda/models";
+import type { IOperationContext } from "../contexts/icontext.js";
+/** Model with role-based access control, mapping actions to required roles */
+declare abstract class RoleModel extends Model {
+    abstract getRolesMap(): {
+        [key: string]: string;
+    };
+    /**
+     * Whether actions without an explicit role mapping are allowed
+     * @returns true if the condition is met
+     */
+    isPermissive(): boolean;
+    /**
+     * Get the roles for the current user, caching them in the session
+     * @param ctx - the operation context
+     * @returns the result
+     */
+    getRoles(ctx: IOperationContext): Promise<any>;
+    /**
+     * Check if the user has the required role for the given action
+     * @param context - the execution context
+     * @param action - the action to check
+     * @returns the result
+     */
+    canAct(context: IOperationContext, action: string): Promise<string | boolean>;
+}
+export { RoleModel };
+//# sourceMappingURL=rolemodel.model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rolemodel.model.d.ts","sourceRoot":"","sources":["../../src/models/rolemodel.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAIjE,8EAA8E;AAC9E,uBAAe,SAAU,SAAQ,KAAK;IACpC,QAAQ,CAAC,WAAW,IAAI;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAElD;;;OAGG;IACH,YAAY,IAAI,OAAO,CAEtB;IAED;;;;OAIG;IACG,QAAQ,CAAC,GAAG,EAAE,iBAAiB,gBAYpC;IAED;;;;;OAKG;IACG,MAAM,CAAC,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,CAalF;CACF;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/lib/models/{rolemodel.js → rolemodel.model.js}

@@ -1,8 +1,20 @@
-import { CoreModel, WebdaError } from "../index.js";
-class RoleModel extends CoreModel {
+import { Model } from "@webda/models";
+import * as WebdaError from "../errors/errors.js";
+import { useContext } from "../contexts/execution.js";
+/** Model with role-based access control, mapping actions to required roles */
+class RoleModel extends Model {
+    /**
+     * Whether actions without an explicit role mapping are allowed
+     * @returns true if the condition is met
+     */
     isPermissive() {
         return false;
     }
+    /**
+     * Get the roles for the current user, caching them in the session
+     * @param ctx - the operation context
+     * @returns the result
+     */
     async getRoles(ctx) {
         if (!ctx.getCurrentUserId()) {
             throw new WebdaError.Forbidden("No user");
@@ -16,7 +28,13 @@ class RoleModel extends CoreModel {
         ctx.getSession().roles = user.getRoles();
         return ctx.getSession().roles;
     }
-    async canAct(ctx, action) {
+    /**
+     * Check if the user has the required role for the given action
+     * @param context - the execution context
+     * @param action - the action to check
+     * @returns the result
+     */
+    async canAct(context, action) {
         // If this action doesn't require role
         if (!this.getRolesMap()[action]) {
             if (this.isPermissive()) {
@@ -24,7 +42,7 @@ class RoleModel extends CoreModel {
             }
             return "No permission for this action defined";
         }
-        const roles = await this.getRoles(ctx);
+        const roles = await this.getRoles(useContext());
         if (roles.indexOf(this.getRolesMap()[action]) >= 0) {
             return true;
         }
@@ -32,4 +50,4 @@ class RoleModel extends CoreModel {
     }
 }
 export { RoleModel };
-//# sourceMappingURL=rolemodel.js.map
+//# sourceMappingURL=rolemodel.model.js.map

package/lib/models/rolemodel.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rolemodel.model.js","sourceRoot":"","sources":["../../src/models/rolemodel.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAEtC,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEtD,8EAA8E;AAC9E,MAAe,SAAU,SAAQ,KAAK;IAGpC;;;OAGG;IACH,YAAY;QACV,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAsB;QACnC,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,CAAC;YAC5B,MAAM,IAAI,UAAU,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;QACD,iCAAiC;QACjC,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;YAC3B,OAAO,GAAG,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC;QAChC,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,cAAc,EAAE,CAAC;QACxC,yBAAyB;QACzB,GAAG,CAAC,UAAU,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACzC,OAAO,GAAG,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,OAA0B,EAAE,MAAc;QACrD,sCAAsC;QACtC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YAChC,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,uCAAuC,CAAC;QACjD,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QAChD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/lib/models/simpleuser.model.d.ts

@@ -0,0 +1,78 @@
+import { Ident } from "./ident.model.js";
+import { ModelRelated, Settable } from "@webda/models";
+import { User } from "./user.model.js";
+/**
+ * Simple user offers groups and roles management
+ *
+ * Groups and roles are defined just as string, no
+ * models
+ */
+export declare class SimpleUser extends User {
+    /** Create a new SimpleUser
+     * @param data - initial data
+     */
+    constructor(data?: Settable<SimpleUser>);
+    /**
+     * Groups for a user
+     */
+    _groups: string[];
+    /**
+     * Roles of the user
+     */
+    _roles: string[];
+    /**
+     * Normal ident
+     */
+    readonly _idents: ModelRelated<Ident, User, "_user">;
+    /**
+     * Return idents
+     * @returns the result
+     */
+    getIdents(): any;
+    /**
+     * Add a group for the user
+     * @param group - the group name
+     * @returns the result
+     */
+    addGroup(group: string): void;
+    /**
+     *
+     * @param group - the group name
+     * @returns true if the condition is met
+     */
+    inGroup(group: string): boolean;
+    /**
+     * Remove a group from this user
+     * @param group - the group name
+     */
+    removeGroup(group: string): void;
+    /**
+     * Get all groups this user belongs to
+     * @returns the list of results
+     */
+    getGroups(): string[];
+    /**
+     * Get all roles assigned to this user
+     * @returns the list of results
+     */
+    getRoles(): string[];
+    /**
+     * Add a role to this user if not already present
+     * @param role - the role
+     */
+    addRole(role: string): void;
+    /**
+     * Check if this user has the given role
+     * @param role - the role
+     * @returns the result
+     */
+    hasRole(role: string): boolean;
+    /**
+     * Remove a role from this user
+     * @param role - the role
+     */
+    removeRole(role: string): void;
+    /** Generated by @webda/content-mapper: include values held in WEBDA_STORAGE. */
+    toJSON(): any;
+}
+//# sourceMappingURL=simpleuser.model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"simpleuser.model.d.ts","sourceRoot":"","sources":["../../src/models/simpleuser.model.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAW,YAAY,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,IAAI;IAClC;;OAEG;IACH,YAAY,IAAI,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,EAEtC;IACD;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAM;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAM;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAAgF;IACpI;;;OAGG;IACH,SAAS,IACgB,GAAG,CAC3B;IAED;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,QAKrB;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAK9B;IAED;;;OAGG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,QAMxB;IAED;;;OAGG;IACH,SAAS,IAAI,MAAM,EAAE,CAEpB;IAED;;;OAGG;IACH,QAAQ,IAAI,MAAM,EAAE,CAEnB;IAED;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,QAKnB;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,WAEnB;IAED;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,QAMtB;IAED,gFAAgF;IAChF,MAAM,IAAI,GAAG,CAQZ;CACF"}

package/lib/models/simpleuser.model.js

@@ -0,0 +1,124 @@
+import { WEBDA_STORAGE } from "@webda/models";
+import { Ident } from "./ident.model.js";
+import { ModelRelated } from "@webda/models";
+import { User } from "./user.model.js";
+/**
+ * Simple user offers groups and roles management
+ *
+ * Groups and roles are defined just as string, no
+ * models
+ */
+export class SimpleUser extends User {
+    /** Create a new SimpleUser
+     * @param data - initial data
+     */
+    constructor(data) {
+        super(data);
+    }
+    /**
+     * Groups for a user
+     */
+    _groups = [];
+    /**
+     * Roles of the user
+     */
+    _roles = [];
+    /**
+     * Normal ident
+     */
+    _idents = new ModelRelated(Ident, this, "_user");
+    /**
+     * Return idents
+     * @returns the result
+     */
+    getIdents() {
+        return this._idents;
+    }
+    /**
+     * Add a group for the user
+     * @param group - the group name
+     * @returns the result
+     */
+    addGroup(group) {
+        if (this.inGroup(group)) {
+            return;
+        }
+        this._groups.push(group);
+    }
+    /**
+     *
+     * @param group - the group name
+     * @returns true if the condition is met
+     */
+    inGroup(group) {
+        if (group === "all" || group === this.uuid) {
+            return true;
+        }
+        return this._groups.includes(group);
+    }
+    /**
+     * Remove a group from this user
+     * @param group - the group name
+     */
+    removeGroup(group) {
+        const ind = this._groups.indexOf(group);
+        if (ind < 0) {
+            return;
+        }
+        this._groups.splice(ind, 1);
+    }
+    /**
+     * Get all groups this user belongs to
+     * @returns the list of results
+     */
+    getGroups() {
+        return this._groups;
+    }
+    /**
+     * Get all roles assigned to this user
+     * @returns the list of results
+     */
+    getRoles() {
+        return this._roles;
+    }
+    /**
+     * Add a role to this user if not already present
+     * @param role - the role
+     */
+    addRole(role) {
+        if (this.hasRole(role)) {
+            return;
+        }
+        this._roles.push(role);
+    }
+    /**
+     * Check if this user has the given role
+     * @param role - the role
+     * @returns the result
+     */
+    hasRole(role) {
+        return this._roles.indexOf(role) >= 0;
+    }
+    /**
+     * Remove a role from this user
+     * @param role - the role
+     */
+    removeRole(role) {
+        const ind = this._roles.indexOf(role);
+        if (ind < 0) {
+            return;
+        }
+        this._roles.splice(ind, 1);
+    }
+    /** Generated by @webda/content-mapper: include values held in WEBDA_STORAGE. */
+    toJSON() {
+        const parent = super.toJSON ? super.toJSON() : {};
+        const result = parent === this ? {} : parent;
+        for (const key of Object.keys(this)) {
+            result[key] = this[key];
+        }
+        Object.assign(result, this[WEBDA_STORAGE]);
+        return result;
+    }
+}
+//# sourceMappingURL=simpleuser.model.js.map

package/lib/models/simpleuser.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simpleuser.model.js","sourceRoot":"","sources":["../../src/models/simpleuser.model.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAW,YAAY,EAAY,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC;;;;;GAKG;AACH,MAAM,OAAO,UAAW,SAAQ,IAAI;IAClC;;OAEG;IACH,YAAY,IAA2B;QACrC,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IACD;;OAEG;IACH,OAAO,GAAa,EAAE,CAAC;IACvB;;OAEG;IACH,MAAM,GAAa,EAAE,CAAC;IACtB;;OAEG;IACM,OAAO,GAAuC,IAAI,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAuC,CAAC;IACpI;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,OAAc,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YAC3C,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,KAAa;QACvB,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,IAAY;QAClB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,IAAY;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED,gFAAgF;IAChF,MAAM;QACJ,MAAM,MAAM,GAAS,KAAK,CAAC,MAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpE,MAAM,MAAM,GAAQ,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;QAClD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,MAAM,CAAC,GAAG,CAAC,GAAI,IAAY,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAG,IAAY,CAAC,aAAa,CAAC,CAAC,CAAC;QACpD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/lib/models/types.d.ts

@@ -0,0 +1,113 @@
+import type { ModelMetadata } from "@webda/compiler";
+import type { Model, ModelClass } from "@webda/models";
+import type { OmitByTypeRecursive } from "@webda/tsc-esm";
+import type { HttpMethodType } from "../contexts/httpcontext.js";
+import type { IContextAware } from "../contexts/icontext.js";
+/**
+ * Add the @webda/core metadata on models
+ */
+export type ModelDefinition<T extends Model = Model> = ModelClass<T> & {
+    Metadata: ModelMetadata;
+};
+/**
+ * Expose parameters for the model
+ */
+export interface ExposeParameters {
+    /**
+     * If model have parent but you still want it to be exposed as root
+     * in domain-like service: DomainService, GraphQL
+     *
+     * It would create alias for the model in the root too
+     */
+    root?: boolean;
+    /**
+     * You can select to not expose some methods like create, update, delete, get, query
+     */
+    restrict: {
+        /**
+         * Create a new object
+         */
+        create?: boolean;
+        /**
+         * Update an existing object
+         *
+         * Includes PUT and PATCH
+         */
+        update?: boolean;
+        /**
+         * Query the object
+         */
+        query?: boolean;
+        /**
+         * Get a single object
+         */
+        get?: boolean;
+        /**
+         * Delete an object
+         */
+        delete?: boolean;
+    };
+}
+/**
+ * Reference to a user model
+ */
+export interface IUser extends Model {
+    /**
+     * Get the user email
+     */
+    getEmail(): string | undefined;
+}
+/**
+ * Define a object that can define permission on attribute level
+ */
+export interface IAttributeLevelPermissionModel extends IContextAware {
+    attributePermission(attribute: string | symbol, value: any, action: "READ" | "WRITE"): any;
+}
+/**
+ * Define an Action on a model
+ *
+ * It is basically a method designed to be called by the API or external
+ * systems
+ */
+export interface ModelAction {
+    /**
+     * Method for the route
+     *
+     * By default ["PUT"]
+     */
+    methods?: HttpMethodType[];
+    /**
+     * Define if the action is global or per object
+     *
+     * The method that implement the action must be called
+     * `_${actionName}`
+     */
+    global?: boolean;
+    /**
+     * Additional openapi info
+     */
+    openapi?: any;
+    /**
+     * Method of the action
+     */
+    method?: string;
+    /**
+     * Name of the method implementing the action, when the action is exposed
+     * under another name with `@Action({ name })`
+     */
+    handler?: string;
+}
+/**
+ * Define an export of actions from Model
+ */
+export type ModelActions = {
+    [key: string]: ModelAction;
+};
+/**
+ * Raw model without methods
+ *
+ * This is used to represent a model without methods and stripping out the helper methods
+ */
+export type RawModel<T extends object> = Partial<OmitByTypeRecursive<Omit<T, "__dirty" | "Events" | "__type" | "__types" | "_new" | "context">, Function>>;
+export type { ModelGraphBinaryDefinition } from "@webda/compiler";
+//# sourceMappingURL=types.d.ts.map

package/lib/models/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/models/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAA8B,MAAM,iBAAiB,CAAC;AACjF,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG;IAAE,QAAQ,EAAE,aAAa,CAAA;CAAE,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE;QACR;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB;;;;WAIG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB;;WAEG;QACH,GAAG,CAAC,EAAE,OAAO,CAAC;QACd;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,KAAM,SAAQ,KAAK;IAClC;;OAEG;IACH,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,aAAa;IACnE,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,GAAG,CAAC;CAC5F;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,GAAG,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,IAAI,OAAO,CAC9C,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE,QAAQ,CAAC,CACzG,CAAC;AAEF,YAAY,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC"}

package/lib/models/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib/models/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/models/types.ts"],"names":[],"mappings":""}

package/lib/models/user.model.d.ts

@@ -0,0 +1,103 @@
+import { IOperationContext } from "../contexts/icontext.js";
+import { Password } from "./password.model.js";
+import { type ModelClass, type ModelEvents, type Settable, UuidModel, WEBDA_EVENTS } from "@webda/models";
+export type UserEvents<T> = ModelEvents<T> & {
+    Login: {
+        user: T;
+    };
+    Logout: {
+        user: T;
+    };
+};
+/**
+ * First basic model for User
+ * @class
+ * @WebdaModel
+ */
+export declare class User extends UuidModel {
+    [WEBDA_EVENTS]: UserEvents<this>;
+    /** Create a new User
+     * @param data - initial data
+     */
+    constructor(data?: Settable<User>);
+    /**
+     * Password credential
+     */
+    password?: Password;
+    /**
+     * Map v3 records (`__password` string) onto the Password behavior shape
+     * @param data - raw data
+     * @returns the mapped data
+     */
+    private static mapV3;
+    /**
+     * Flag an instance whose data went through the v3 mapping (see {@link V3_PASSWORD_MAPPED})
+     * @param instance - the user
+     */
+    private static flagV3;
+    /**
+     * Map v3 records onto the Password behavior before hydration
+     * @param data - raw data
+     * @param instance - instance to populate
+     * @returns the populated instance
+     */
+    static deserialize<T extends ModelClass, K extends object = InstanceType<T>>(this: T, data: any, instance?: K): K;
+    /**
+     * Display name for this user
+     * @optional
+     * @Frontend
+     */
+    displayName: string;
+    /**
+     * Define the user avatar if exists
+     */
+    _avatar?: string;
+    /**
+     * Contains the locale of the user if known
+     */
+    locale?: string;
+    /**
+     * Contain main user email if exists
+     */
+    email?: string;
+    /**
+     * Return displayable public entry
+     * @returns the result
+     * @Frontend
+     */
+    toPublicEntry(): any;
+    /**
+     * Get email
+     * @returns the result
+     */
+    getEmail(): string | undefined;
+    /**
+     * Get user groups
+     * @returns the list of results
+     */
+    getGroups(): string[];
+    /**
+     * Get roles
+     * @returns the list of results
+     */
+    getRoles(): string[];
+    /**
+     * Get display name
+     * @returns the result string
+     */
+    getDisplayName(): string;
+    /**
+     * Only the user themselves can act on their own object
+     * @param ctx - the operation context
+     * @param action - the action to check
+     * @returns the result
+     */
+    canAct(ctx: IOperationContext, action: string): Promise<string | boolean>;
+    /**
+     * String representation of the user
+     * @returns the result
+     */
+    toString(): string;
+    protected __hydrateBehaviors(rawData?: any): void;
+}
+//# sourceMappingURL=user.model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"user.model.d.ts","sourceRoot":"","sources":["../../src/models/user.model.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAsB,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,KAAK,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE1G,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG;IAC3C,KAAK,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC;IACnB,MAAM,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC;CACrB,CAAC;AACF;;;;GAIG;AACH,qBAAa,IAAK,SAAQ,SAAS;IACjC,CAAC,YAAY,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IACjC;;OAEG;IACH,YAAY,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,EAShC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,KAAK;IASpB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM;IASrB;;;;;OAKG;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,CAKhH;IACD;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,aAAa,IAAI,GAAG,CAOnB;IAED;;;OAGG;IACH,QAAQ,IAAI,MAAM,GAAG,SAAS,CAE7B;IAED;;;OAGG;IACH,SAAS,IAAI,MAAM,EAAE,CAEpB;IAED;;;OAGG;IACH,QAAQ,IAAI,MAAM,EAAE,CAEnB;IAED;;;OAGG;IACH,cAAc,IAAI,MAAM,CAEvB;IAED;;;;;OAKG;IACG,MAAM,CAAC,GAAG,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,CAK9E;IAED;;;OAGG;IACH,QAAQ,WAEP;IACD,SAAS,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,IAAI,CAiBhD;CACF"}