@limetech/lime-web-components 6.4.1 → 6.5.0

package/dist/application/repository.d.ts

@@ -2,26 +2,123 @@ import { StateRepository } from '../core';
 import { User } from './user';
 import { Session } from './session';
 /**
+ * Repository for accessing application-level state and metadata.
+ *
+ * The ApplicationRepository provides access to global application information including
+ * the current user, session details, application name, and language settings. It extends
+ * {@link StateRepository} to provide reactive subscriptions to these values, allowing components
+ * to automatically update when application state changes.
+ *
+ * This repository is typically available immediately when a component loads and provides
+ * essential context about the running application and the authenticated user.
+ *
+ * @example Use decorators for reactive state management
+ * ```typescript
+ * class MyComponent {
+ *     @State()
+ *     @SelectCurrentUser()
+ *     private user: User;
+ *
+ *     @State()
+ *     @SelectApplicationName()
+ *     private appName: string;
+ * }
+ * ```
+ *
+ * @example Direct repository access (useful for one-time reads)
+ * ```typescript
+ * const repository = platform.get(PlatformServiceName.Application);
+ *
+ * const session = repository.getSession();
+ * const hasAdminAccess = session?.admin || false;
+ *
+ * const user = repository.getCurrentUser();
+ * if (user?.groups.some(g => g.name === 'Administrators')) {
+ *     // User is an administrator
+ * }
+ * ```
+ *
  * @public
  * @group Application
  */
 export interface ApplicationRepository extends StateRepository {
     /**
-     * Get the name of the application
+     * Get the name of the current Lime CRM application.
+     *
+     * The application name identifies which Lime CRM database/application the user
+     * is currently connected to.
+     *
+     * @returns The application name
+     *
+     * @example
+     * ```typescript
+     * const appName = appRepo.getApplicationName();
+     * console.log(`Connected to: ${appName}`); // "Connected to: CustomerCRM"
+     * ```
      */
     getApplicationName(): string | undefined;
     /**
-     * Get the currently logged in user
+     * Get the currently logged in user.
+     *
+     * Returns the User object containing information about the authenticated user,
+     * including their username, full name, email, groups, and associated coworker
+     * record if applicable.
+     *
+     * @returns The current User object, or undefined if not authenticated
+     *
+     * @example
+     * ```typescript
+     * const user = appRepo.getCurrentUser();
+     * if (user?.groups.some(g => g.name === 'Administrators')) {
+     *     // Show admin features
+     * }
+     * ```
      */
     getCurrentUser(): User | undefined;
     /**
-     * Get the current session
+     * Get the current session information.
+     *
+     * The session contains detailed information about the current user session including
+     * login time, session timeout, enabled features, database connection details, and
+     * whether the user has administrative privileges.
+     *
+     * @returns The current Session object, or undefined if no active session
+     *
+     * @example
+     * ```typescript
+     * const session = appRepo.getSession();
+     *
+     * // Check if session is about to expire
+     * const expirationTime = new Date(session?.expirationTime);
+     * const minutesLeft = (expirationTime.getTime() - Date.now()) / 60000;
+     * if (minutesLeft < 5) {
+     *     // Warn user about session expiration
+     * }
+     *
+     * // Check for admin privileges
+     * if (session?.admin) {
+     *     // Enable admin features
+     * }
+     * ```
      */
     getSession(): Session | undefined;
     /**
-     * Get the current language
+     * Get the current interface language.
+     *
+     * Returns the two-letter ISO 639-1 language code for the current user interface
+     * language. This should be used for localizing component text and formatting
+     * locale-specific data like dates and numbers.
+     *
+     * @returns A two-letter language code (e.g., "en", "sv", "de", "fi")
+     *
+     * @example
+     * ```typescript
+     * const language = appRepo.getLanguage();
      *
-     * @returns a two-letter language code, for example "en"
+     * // Format dates according to language
+     * const locale = language === 'sv' ? 'sv-SE' : 'en-US';
+     * const formatted = new Date().toLocaleDateString(locale);
+     * ```
      */
     getLanguage(): string;
 }

package/dist/application/repository.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/application/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC1D;;OAEG;IACH,kBAAkB,IAAI,MAAM,GAAG,SAAS,CAAC;IAEzC;;OAEG;IACH,cAAc,IAAI,IAAI,GAAG,SAAS,CAAC;IAEnC;;OAEG;IACH,UAAU,IAAI,OAAO,GAAG,SAAS,CAAC;IAElC;;;;OAIG;IACH,WAAW,IAAI,MAAM,CAAC;CACzB"}
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/application/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC1D;;;;;;;;;;;;;OAaG;IACH,kBAAkB,IAAI,MAAM,GAAG,SAAS,CAAC;IAEzC;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,IAAI,IAAI,GAAG,SAAS,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,UAAU,IAAI,OAAO,GAAG,SAAS,CAAC;IAElC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,IAAI,MAAM,CAAC;CACzB"}

package/dist/application/session.d.ts

@@ -1,67 +1,157 @@
 /**
+ * Represents an active user session in Lime CRM.
+ *
+ * The Session object contains comprehensive information about the current user's
+ * authenticated session, including login details, enabled features, administrative
+ * privileges, and session timing. This information is crucial for security,
+ * feature availability, and session management.
+ *
+ * @example
+ * ```typescript
+ * // Access session information in a component
+ * const appRepo = platform.get(PlatformServiceName.Application);
+ * const session = appRepo.getSession();
+ *
+ * if (session?.active) {
+ *     console.log(`Logged in at: ${session.loginTime}`);
+ *     console.log(`Admin privileges: ${session.admin}`);
+ *
+ *     // Check session expiration
+ *     const expiresAt = new Date(session.expirationTime);
+ *     const now = new Date();
+ *     const minutesRemaining = (expiresAt.getTime() - now.getTime()) / 60000;
+ *
+ *     if (minutesRemaining < 5) {
+ *         // Warn about imminent session expiration
+ *         console.warn('Session expires in less than 5 minutes');
+ *     }
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Check for enabled features and addons
+ * const session = appRepo.getSession();
+ *
+ * // Check feature flags
+ * if (session?.features?.['advancedReporting']) {
+ *     // Enable advanced reporting features
+ * }
+ *
+ * // Check for specific addons
+ * if (session?.addons?.['salesAutomation']) {
+ *     // Show sales automation tools
+ * }
+ * ```
+ *
  * @public
  * @group Application
  */
 export interface Session {
     /**
-     * Whether the session is active or not
+     * Indicates whether the session is currently active.
+     *
+     * An active session means the user is authenticated and can perform operations.
+     * Sessions become inactive after logout or timeout.
      */
     active: boolean;
     /**
-     * Enabled addons
+     * Configuration and state of enabled addons/plugins.
+     *
+     * Contains a key-value map of addon names to their configuration objects.
+     * The structure of each addon's configuration depends on the addon itself.
      */
     addons: Record<string, any>;
     /**
-     * Whether the user is an admin or not
+     * Indicates whether the user has administrative privileges.
+     *
+     * Admin users typically have access to system configuration, user management,
+     * and other administrative features not available to regular users.
      */
     admin: boolean;
     /**
-     * Apm config
+     * Application Performance Monitoring (APM) configuration.
+     *
+     * Contains settings for performance tracking and monitoring tools.
+     * The exact structure depends on the APM provider being used.
      */
     apm: Record<string, unknown>;
     /**
-     * Name of the application
+     * The name of the Lime CRM application.
+     *
+     * Identifies which application/database the user is connected to.
      */
     application: string;
     /**
-     * Name of the application database
+     * The name of the underlying database.
+     *
+     * Technical database identifier, usually matching the application name
+     * but may differ in some configurations.
      */
     database: string;
     /**
-     * Application's display name
+     * User-friendly display name for the application.
+     *
+     * This is the name shown in the UI, which may be different from the
+     * technical application name. Often includes company or department name.
      */
     displayName: string;
+    /**
+     * ISO 8601 timestamp when the session will expire.
+     *
+     * After this time, the session becomes invalid and the user must
+     * re-authenticate.
+     */
     expirationTime?: string;
     /**
-     * Feature switches
+     * Feature flags controlling available functionality.
+     *
+     * A key-value map where keys are feature names and values indicate whether
+     * the feature is enabled.
      */
     features: Record<string, boolean>;
     /**
-     * Session ID
+     * Unique identifier for this session.
+     *
+     * Used for session tracking, logging, and debugging. Each login creates
+     * a new session with a unique ID.
      */
     id: string;
     /**
-     * Time of login
+     * ISO 8601 timestamp when the user logged in.
+     *
+     * Marks the start of the session.
      */
     loginTime: string;
     /**
-     * Time of logout
+     * ISO 8601 timestamp when the user logged out.
+     *
+     * Only present after the user has explicitly logged out. Not set for
+     * sessions that timeout.
      */
     logoutTime?: string;
     /**
-     * Application service number
+     * Application service instance number.
      */
     serviceNumber?: number;
     /**
-     * Time before the session times out
+     * Session timeout duration in seconds.
+     *
+     * Indicates how long a session can be idle before it automatically expires.
+     * The actual expiration time is calculated from the last activity.
      */
     sessionTimeout: number;
     /**
-     * ID of the user
+     * The ID of the authenticated user.
+     *
+     * References the User.id property. Used to identify which user owns
+     * this session.
      */
     userId: number;
     /**
-     * Name of the user's workstation
+     * Name or identifier of the user's workstation.
+     *
+     * Typically the computer name or IP address from which the user logged in.
      */
     workstation: string;
 }

package/dist/application/session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../src/application/session.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,OAAO;IACpB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IAEH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB"}
+{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../src/application/session.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,WAAW,OAAO;IACpB;;;;;OAKG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;;OAKG;IAEH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE5B;;;;;OAKG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE7B;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB"}

package/dist/application/user.d.ts

@@ -1,70 +1,179 @@
 /**
+ * Represents a user in the Lime CRM system.
+ *
+ * The User object contains all relevant information about an authenticated user,
+ * including their identity, contact details, group memberships, and associated
+ * business object (coworker) if applicable. This information is used throughout
+ * the platform for authentication, authorization, and personalization.
+ *
+ * @example
+ * ```typescript
+ * // Access user information in a component
+ * const appRepo = platform.get(PlatformServiceName.Application);
+ * const user = appRepo.getCurrentUser();
+ *
+ * console.log(`Logged in as: ${user.fullname} (${user.username})`);
+ * console.log(`Email: ${user.email}`);
+ * console.log(`Member of ${user.groups.length} groups`);
+ *
+ * // Check for specific group membership
+ * const isAdmin = user.groups.some(g => g.name === 'Administrators');
+ * const isSales = user.groups.some(g => g.name === 'Sales');
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Load the user's coworker record for additional details
+ * if (user.coworker) {
+ *     const repo = platform.get(PlatformServiceName.LimeObjectRepository);
+ *     const coworkerObject = await repo.loadObject(
+ *         user.coworker.limetype,
+ *         user.coworker.id
+ *     );
+ *     // Access additional coworker properties like phone, department, etc.
+ * }
+ * ```
+ *
  * @public
  * @group Application
  */
 export interface User {
     /**
-     * The name of the user
+     * The unique username used for authentication.
+     *
+     * This is the login identifier for the user, typically in a format like
+     * "john.doe" or "jdoe". It must be unique across the system.
      */
     username: string;
     /**
-     * The full name of the user
+     * The user's full display name.
+     *
+     * This is the human-readable name shown in the UI, typically in the format
+     * "First Last" (e.g., "John Doe"). Used for display purposes throughout
+     * the application.
      */
     fullname: string;
     /**
-     * The id of the user
+     * The unique numeric identifier for the user.
      */
     id: number;
     /**
-     * The email of the user
+     * The user's email address.
      */
     email: string;
     /**
-     * Whether the user is active or not
+     * Indicates whether the user account is currently active.
+     *
+     * Inactive users cannot log in to the system. Useful for temporarily
+     * disabling accounts without deletion.
      */
     active: boolean;
     /**
-     * The groups the user belongs to
+     * List of security groups the user belongs to.
+     *
+     * Groups control access permissions and feature availability. A user can
+     * belong to multiple groups, inheriting permissions from all of them.
      */
     groups: UserGroup[];
     /**
-     * The default group the user belongs to
+     * The user's primary group assignment.
+     *
+     * When a user belongs to multiple groups, this indicates their main group
+     * affiliation. Used for default permissions and organizational structure.
      */
     defaultGroup: UserGroup;
     /**
-     * The coworker the user is connected to
+     * Reference to the user's associated coworker business object.
+     *
+     * Many Lime CRM systems have a coworker limetype that stores additional
+     * employee information beyond the user account (phone, department, manager, etc.).
+     * This property links to that record if it exists.
      */
     coworker: UserCoworker;
 }
 /**
+ * Represents a security group in Lime CRM.
+ *
+ * Groups are used to organize users and control their access permissions.
+ * Users inherit permissions from all groups they belong to. Groups typically
+ * represent departments, roles, or permission levels within the organization.
+ *
+ * @example
+ * ```typescript
+ * // Check if user belongs to specific groups
+ * const user = appRepo.getCurrentUser();
+ * const adminGroup = user.groups.find(g => g.name === 'Administrators');
+ * if (adminGroup) {
+ *     console.log(`User is admin (Group ID: ${adminGroup.id})`);
+ *     console.log(`Description: ${adminGroup.description}`);
+ * }
+ * ```
+ *
  * @public
  * @group Application
  */
 export interface UserGroup {
     /**
-     * Name of the group
+     * The unique name identifier for the group.
+     *
+     * Group names are used throughout the system for permission checks
+     * and access control.
      */
     name: string;
     /**
-     * Id of the group
+     * The numeric identifier for the group.
+     *
+     * Used internally for group references in the database.
      */
     id: number;
     /**
-     * Group description
+     * Human-readable description of the group's purpose.
+     *
+     * Provides additional context about what the group represents
+     * and what permissions it typically grants.
      */
     description: string;
 }
 /**
+ * Reference to a user's associated coworker business object.
+ *
+ * In Lime CRM, user accounts (for authentication) are often separate from
+ * coworker/employee records (business objects with additional data). This
+ * interface provides the link between the two, allowing you to load the
+ * full coworker record when needed.
+ *
+ * @example
+ * ```typescript
+ * // Load full coworker details
+ * const user = appRepo.getCurrentUser();
+ * if (user.coworker) {
+ *     const repo = platform.get(PlatformServiceName.LimeObjectRepository);
+ *     const coworker = await repo.loadObject(
+ *         user.coworker.limetype,  // Usually 'coworker' or 'employee'
+ *         user.coworker.id
+ *     );
+ *
+ *     // Access additional properties
+ *     console.log(`Phone: ${coworker.properties.phone}`);
+ *     console.log(`Department: ${coworker.properties.department}`);
+ * }
+ * ```
+ *
  * @public
  * @group Application
  */
 export interface UserCoworker {
     /**
-     * Id of the coworker `LimeObject`
+     * The ID of the coworker LimeObject.
+     *
+     * Use this with {@link LimeObjectRepository} to load the full coworker record.
      */
     id: number;
     /**
-     * Name of the `Limetype` used for coworkers
+     * The name of the Limetype used for coworker records.
+     *
+     * Typically "coworker" or "employee", but can vary by configuration.
+     * Use this as the limetype parameter when loading the object.
      */
     limetype: string;
 }

package/dist/application/user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/application/user.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,IAAI;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,SAAS,EAAE,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,SAAS,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CACpB"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/application/user.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,WAAW,IAAI;IACjB;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;;OAKG;IACH,MAAM,EAAE,SAAS,EAAE,CAAC;IAEpB;;;;;OAKG;IACH,YAAY,EAAE,SAAS,CAAC;IAExB;;;;;;OAMG;IACH,QAAQ,EAAE,YAAY,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,YAAY;IACzB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;CACpB"}