Lime Web Components API Documentation - v7.4.0
    Preparing search index...

    Interface ApplicationRepository

    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 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.

    import { State } from '@stencil/core';
    import {
        SelectApplicationName,
        SelectCurrentUser,
        User,
    } from '@limetech/lime-web-components';

    class MyComponent {
        @State()
        @SelectCurrentUser()
        private user: User;

        @State()
        @SelectApplicationName()
        private appName: string;
    }

    import { PlatformServiceName } from '@limetech/lime-web-components';

    const repository = platform.get(PlatformServiceName.Application);

    const session = repository.getSession();
    const hasAdminAccess = session?.admin === true;

    const user = repository.getCurrentUser();
    const isAdministrator = user?.groups.some(
        (group) => group.name === 'Administrators'
    );
    interface ApplicationRepository {
        getApplicationName(): string | undefined;
        getCurrentUser(): User | undefined;
        getLanguage(): string;
        getSession(): Session | undefined;
        subscribe(
            callback: (...args: unknown[]) => void,
            options?: StateOptions,
        ): () => void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    getApplicationName getCurrentUser getLanguage getSession subscribe

    Methods

    • 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 string | undefined

      The application name

      import {
          createLogger,
          PlatformServiceName,
      } from '@limetech/lime-web-components';

      const repository = platform.get(PlatformServiceName.Application);
      const logger = createLogger('my-component');

      const appName = repository.getApplicationName();

      logger.info(`Connected to: ${appName}`); // "Connected to: CustomerCRM"

    • 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 User | undefined

      The current User object, or undefined if not authenticated

      import { PlatformServiceName } from '@limetech/lime-web-components';

      const repository = platform.get(PlatformServiceName.Application);
      const user = repository.getCurrentUser();

      const showAdminFeatures = user?.groups.some(
          (group) => group.name === 'Administrators'
      );

    • 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 string

      A two-letter language code (e.g., "en", "sv", "de", "fi")

      import { PlatformServiceName } from '@limetech/lime-web-components';

      const repository = platform.get(PlatformServiceName.Application);
      const language = repository.getLanguage();

      const locale = language === 'sv' ? 'sv-SE' : 'en-US';
      const formatted = new Date().toLocaleDateString(locale);

    • 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 Session | undefined

      The current Session object, or undefined if no active session

      import { PlatformServiceName } from '@limetech/lime-web-components';

      const repository = platform.get(PlatformServiceName.Application);
      const session = repository.getSession();

      const showAdminFeatures = session?.admin === true;

      // `expirationTime` is optional, so a session without one never counts as
      // expiring soon.
      let expiresSoon = false;

      if (session?.expirationTime) {
          const expiresAt = new Date(session.expirationTime);
          const minutesLeft = (expiresAt.getTime() - Date.now()) / 60_000;

          expiresSoon = minutesLeft < 5;
      }

    • Subscribe to state changes with optional transformation and filtering.

      The subscription will immediately invoke the callback with the current state (if any), then continue to call it whenever the state changes. The map and filter options allow you to transform and selectively receive updates.

      Parameters

      • callback: (...args: unknown[]) => void

        Function called with state updates (after map/filter applied)

      • Optionaloptions: StateOptions

        Optional transformations and filters for the subscription

      Returns () => void

      Unsubscribe function - call this to stop receiving updates

      • Map functions are applied sequentially to transform the state
      • Filter functions must all return true for the callback to be invoked
      • Functions in map/filter arrays are bound to the component instance
      • Always store and call the unsubscribe function when component is destroyed
      import { PlatformServiceName } from '@limetech/lime-web-components';

      const repository = platform.get(PlatformServiceName.Application);
      const logger = platform
          .get(PlatformServiceName.Logger)
          .createLogger('my-component');

      // Basic subscription
      const unsubscribeState = repository.subscribe((state) => {
          logger.debug('State updated', { state });
      });

      // With transformations
      const unsubscribeUserName = repository.subscribe(
          (userName) => logger.debug('User', { userName }),
          { map: [(state) => state.currentUser?.fullname] }
      );

    Settings

    Member Visibility

    On This Page

    Methods