@temboplus/afloat 0.1.56 → 0.1.57

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

@@ -3,80 +3,63 @@ import { Profile } from "./profile.model";
  * Represents a user in Afloat.
  *
  * This class centralizes user-related logic, simplifying interaction
- * with user-related data and ensuring consistent permission checks across the application.
+ * with user-related data and ensuring consistent access checks across the application.
  */
 export declare class User {
     /**
-     * Logged-in user name
+     * Logged-in user name.
      */
     name: string;
     /**
-     * Logged-in identity: phone-number or email address
+     * Logged-in identity: phone number or email address.
      */
     identity: string;
     /**
-     * The user's Afloat profile, containing personal information such as name, contact details, and account information.
+     * The user's Afloat profile.
      */
     profile: Profile;
     /**
-     * The user's authentication token. This token must be passed in the request headers
-     * for all authenticated API endpoints.
+     * The user's authentication token.
      */
     token: string;
     /**
-     * Indicates whether the user is required to change their default password.
+     * Indicates whether the user must change their default password.
      */
     resetPassword: boolean;
     /**
-     * A map of permission keys to boolean values, indicating whether the user has access
-     * to specific actions or features in the system.
+     * A list of granted access keys (permissions).
      */
-    private permissionsMap;
+    access: string[];
     /**
-     * Creates a new instance of the `User` class.
-     *
-     * @param userData - An object containing the user's profile, token,
-     * permissions (access list), and the `resetPassword` flag.
+     * A map of access keys to boolean values for fast permission checks.
      */
-    private constructor();
+    private accessMap;
     /**
-     * Checks if the user has a specific permission.
-     *
-     * @param permission - The permission key to check.
-     * @returns `true` if the user has the specified permission, otherwise `false`.
+     * Creates a new `User` instance.
      */
-    can(permission: string): boolean;
+    private constructor();
     /**
-     * Returns all permissions the user has.
+     * Checks if the user has a specific access permission.
      *
-     * @returns An array of permission keys granted to the user.
+     * @param key - The access key to check.
+     * @returns `true` if the user has the specified access, otherwise `false`.
      */
-    getPermissions(): string[];
+    can(key: string): boolean;
     /**
      * Returns a plain object representation of the user.
-     * Unlike `toJSON()`, this does not stringify the object.
-     *
-     * @returns An object representing the current User instance.
+     * This can safely be embedded in a JWT payload.
      */
     toObject(): Record<string, any>;
     /**
      * Serializes the `User` instance to a JSON string.
-     *
-     * @returns A JSON string representation of the `User` instance.
      */
     toJSON(): string;
     /**
      * Creates a new `User` instance from a JSON string.
-     *
-     * @param jsonString - A JSON string containing user data.
-     * @returns A `User` instance reconstructed from the JSON data, or `undefined` if invalid.
      */
     static fromJSON(jsonString: string): User | undefined;
     /**
-     * Creates a new `User` instance from a data object, JSON string, or object with a Profile instance/object.
-     *
-     * @param data - The data object or stringified JSON containing user information.
-     * @returns A `User` instance, or `undefined` if the data is invalid or incomplete.
+     * Creates a new `User` instance from a plain object.
      */
     static from(data: any): User | undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temboplus/afloat",
-  "version": "0.1.56",
+  "version": "0.1.57",
   "description": "A foundational library for Temboplus-Afloat projects.",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",