@ale-rainbow/web-sdk 5.1.0

package/lib/rainbow.sdk.d.ts

@@ -0,0 +1,309 @@
+/**
+ * @module RainbowSDK
+ */
+import "./strophejs";
+import type { SDKPlugin } from "./plugins/plugin";
+import { SettingsService } from "./services/core/settings.service";
+import type { ConnectionService } from "./services/core/connection.service";
+import type { ExternalLoggerInterface, LogLevelEnum } from "./services/core/logger.service";
+import { LoggerService } from "./services/core/logger.service";
+import type { UserNetworkService } from "./services/core/userNetwork.service";
+import type { BubbleConferenceService, ConversationService, DirectorySearchService, I18nService, ProfileService, CountryService } from "./services";
+import { NotificationsViewerService } from "./services";
+import type { ConnectedUser } from "./models";
+import { UtilitiesService } from "./services/utilities/utilities.service";
+import type { BubbleService } from "./services/bubbles";
+import type { WebinarService } from "./services/webinars/webinars.service";
+import type { CallService } from "./services/call/call.service";
+import type { FavoritesService } from "./services/favorites/favorites.service";
+import type { CallLogService } from "./services/callLog/callLog.service";
+import type { DataChannelService } from "./services/dataChannel";
+import type { DeviceManagementService } from "./services/deviceManagement/deviceManagement.service";
+import type { TelephonyConfigService } from "./services/telephonyConfig";
+import type { SDKAdminService } from "./services/admin";
+import type { BubbleTagService } from "./services/bubbles/bubbleTag.service";
+import type { UserService } from "./services/users/user.service";
+import type { FileDocumentService } from "./services/fileDocument/fileDocument.service";
+import type { LiveTranscriptionService } from "./services/transcription/liveTranscription.service";
+import type { LocalTranslationService } from "./services/localTranslation/localTranslation.service";
+import type { TodoServiceRB } from "./services/todo/todo.service";
+import type { BubbleConferenceRecapService } from "./services/conference/bubbleConferenceRecap.service";
+import type { ChannelService } from "./services/channels/channel.service";
+import type { CallRecorderService } from "./services/call/callRecorder.service";
+import type { RPCService } from "./services/rpc/rpc.service";
+import type { PollsService } from "./services/polls/polls.service";
+import type { HelpCenterService } from "./services/helpcenter/helpCenter.service";
+import type { WhatsNewService } from "./services/helpcenter/whatsNew.service";
+export interface RainbowSDKAppConfig {
+    /** Rainbow xmpp resource prefix */
+    xmppResourcePrefix?: string;
+    /** Rainbow backend server url */
+    server?: string;
+    /** Rainbow application identifier */
+    applicationId?: string;
+    /** Rainbow application secretKey */
+    secretKey?: string;
+}
+export interface RainbowSDKMarkdownParser {
+    markdownToHtml: (markdown: string) => string;
+}
+export interface RainbowSDKConfig {
+    /** Application configuration */
+    appConfig?: RainbowSDKAppConfig;
+    /** List of plugins to use in the application */
+    plugins?: SDKPlugin[];
+    /** When set to true, the sdk will try to connect with localStorage token information */
+    autoLogin?: boolean;
+    /** Specify the SDK internal log level */
+    logLevel?: LogLevelEnum;
+    /** When set to true, sone additional CONNECTING events will be emitted to manage a connection progress bar */
+    progressEvents?: boolean;
+    /** Markdown parser implementation to use across SDK service */
+    markdownParser?: RainbowSDKMarkdownParser;
+    /** @internal */
+    logger?: ExternalLoggerInterface;
+    /** @internal */
+    devMode?: boolean;
+}
+/**
+ * This class is the **Web Rainbow SDK** main entry point
+ * It offers :
+ * + Lifecycle methods (create, start and stop methods)
+ * + A get method to fetch plugin services
+ * + Direct accesses to "core" plugins
+ */
+export declare class RainbowSDK {
+    /**
+     * Direct access to core ConnectedUser
+     * @returns the ConnectedUser instance
+     */
+    get connectedUser(): ConnectedUser | undefined;
+    /**
+     * Direct access to core ConnectionService
+     * @returns the ConnectionService singleton instance
+     */
+    get connectionService(): ConnectionService;
+    /**
+      * Direct access to core ConversationService
+      * @returns the ConversationService singleton instance if available
+      */
+    get conversationService(): ConversationService;
+    /**
+     * Direct access to core UserService
+     * @returns the UserService singleton instance
+     */
+    get userService(): UserService;
+    /**
+     * Direct access to core UtilitiesService
+     * @returns the UtilitiesService singleton instance
+     */
+    get utils(): UtilitiesService;
+    /**
+     * Direct access to core LoggerService
+     * @returns the LoggerService singleton instance
+     * @internal
+     */
+    get loggerService(): LoggerService;
+    /**
+     * Direct access to core i18nService
+     * @returns the I18nService singleton instance
+     * @internal
+     */
+    get i18nService(): I18nService;
+    /**
+     * Direct access to core ProfileService
+     * @returns the ProfileService singleton instance
+     */
+    get profileService(): ProfileService;
+    /**
+     * Direct access to core CountryService
+     * @returns the CountryService singleton instance
+     */
+    get countryService(): CountryService;
+    /**
+     * Direct access to core UserNetworkService
+     * @returns the UserNetworkService singleton instance
+     */
+    get userNetwork(): UserNetworkService;
+    /**
+     * Direct access to BubbleService
+     * @returns the BubbleService singleton instance if available
+     */
+    get bubbleService(): BubbleService | undefined;
+    /**
+     * Direct access to BubbleTagService
+     * @returns the BubbleService singleton instance if available
+     */
+    get BubbleTagService(): BubbleTagService | undefined;
+    /**
+     * Direct access to WebinarService
+     * @returns the WebinarService singleton instance if available
+     */
+    get webinarService(): WebinarService | undefined;
+    /**
+     * Direct access to FileDocumentService
+     * @returns the DocumentsService singleton instance if available
+     */
+    get fileDocumentService(): FileDocumentService | undefined;
+    /**
+     * Direct access to core DirectoryService
+     * @returns the DirectoryService singleton instance
+     */
+    get directorySearchService(): DirectorySearchService;
+    /**
+     * Direct access to CallService
+     * @returns the CallService singleton instance if available
+     */
+    get callService(): CallService | undefined;
+    /**
+     * Direct access to CallRecorderService
+     * @returns the CallService singleton instance if available
+     */
+    get callRecorderService(): CallRecorderService | undefined;
+    /**
+     * Direct access to FavoritesService
+     * @returns the FavoritesService singleton instance if available
+     */
+    get favoritesService(): FavoritesService | undefined;
+    /**
+     * Direct access to CallLogService
+     * @returns the CallLogService singleton instance if available
+     */
+    get callLogsService(): CallLogService | undefined;
+    /**
+     * Direct access to BubbleConferenceService
+     * @returns the BubbleConferenceService singleton instance if available
+     */
+    get bubbleConferenceService(): BubbleConferenceService | undefined;
+    /**
+     * Direct access to DataChannelService
+     * @returns the DataChannelService singleton instance if available
+     */
+    get dataChannelService(): DataChannelService | undefined;
+    /**
+     * Direct access to DeviceManagementService
+     * @returns the DeviceManagementService singleton instance if available
+     */
+    get deviceManagementService(): DeviceManagementService | undefined;
+    /**
+     * Direct access to TelephonyConfigService
+     * @returns the TelephonyConfigService singleton instance if available
+     */
+    get telephonyConfigService(): TelephonyConfigService | undefined;
+    /**
+     * Direct access to TranscriptionService
+     * @returns the TranscriptionService singleton instance if available
+     */
+    get transcriptionService(): LiveTranscriptionService | undefined;
+    /**
+     * Direct access to LocalTranslationService (on-device translation, lazily created)
+     * @returns the LocalTranslationService singleton instance
+     */
+    get localTranslationService(): LocalTranslationService;
+    /**
+     * Direct access to BubbleConferenceRecapService
+     * @returns the BubbleConferenceRecapService singleton instance if available
+     */
+    get conferenceRecapService(): BubbleConferenceRecapService | undefined;
+    /**
+     * Direct access to ChannelService
+     * @returns the ChannelService singleton instance if available
+     */
+    get channelService(): ChannelService | undefined;
+    /**
+     * Direct access to ChannelService
+     * @returns the ChannelService singleton instance if available
+     */
+    get settingsService(): SettingsService;
+    /**
+     * Direct access to TodoServiceRB
+     * @returns the TodoServiceRB singleton instance if available
+     */
+    get todoService(): TodoServiceRB | undefined;
+    /**
+     * Direct access to PollsService
+     * @returns the PollsService singleton instance if available
+     */
+    get pollsService(): PollsService | undefined;
+    /**
+     * Direct access to NotificationsViewerService
+     * @returns the NotificationsViewerService singleton instance if available
+     */
+    get notificationService(): NotificationsViewerService;
+    /**
+     * Direct access to AdminService
+     * @returns the AdminService singleton instance if available
+     */
+    get adminService(): SDKAdminService | undefined;
+    /**
+     * Direct access to RPCService
+     * @returns the RPCService singleton instance if available
+     */
+    get rpcService(): RPCService | undefined;
+    /**
+     * Direct access to HelpCenterService
+     * @returns the HelpCenterService singleton instance if available
+     */
+    get helpCenterService(): HelpCenterService | undefined;
+    /**
+     * Direct access to WhatsNewService
+     * @returns the WhatsNewService singleton instance if available
+     */
+    get whatsNewService(): WhatsNewService | undefined;
+    markdownParser: RainbowSDKMarkdownParser | undefined;
+    private _contactService;
+    private _userService;
+    private _loggerService;
+    private _connectionService;
+    private _utilitiesService;
+    private _conversationService;
+    private _directorySearchService;
+    private _errorHelperService;
+    private _notificationViewerService;
+    /**
+     * Static method to reach the RainbowSDK singleton instance
+     * @returns The Rainbow singleton instance
+     */
+    static getInstance(): RainbowSDK;
+    /**
+     * Static method to create the RainbowSDK singleton instance
+     * @returns The Rainbow singleton instance
+     */
+    static create(options?: RainbowSDKConfig): RainbowSDK;
+    private constructor();
+    /**
+     * Permits to enable console logs
+     * @param enable - when set to true logs are displayed on console
+     */
+    enableLogs(enable: boolean): void;
+    /**
+     * Permits to specify logLevel
+     * @param logLevel - when set to true logs are displayed on console
+     */
+    setLogLevel(logLevel: LogLevelEnum): void;
+    /**
+     * Permits to get current logLevel
+     */
+    getLogLevel(): LogLevelEnum;
+    /**
+     * Permits to start the Rainbow SDK
+     * @returns resolve when Rainbow SDK is started
+     */
+    start(): Promise<ConnectedUser | undefined>;
+    /**
+    * Permits to stop the Rainbow SDK
+    * @returns resolve when Rainbow SDK is stopped
+    */
+    stop(): Promise<void>;
+    /**
+    * Get the current Rainbow SDK version
+    * @returns the current Rainbow SDK version
+    */
+    getVersion(): string;
+    /**
+    * Permit to fetch the singleton instance of a named service
+    * @returns the singleton instance of a named service
+    */
+    get<T = any>(serviceName: string): T | undefined;
+}
+//# sourceMappingURL=rainbow.sdk.d.ts.map

package/lib/rainbow.sdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rainbow.sdk.d.ts","sourceRoot":"","sources":["../src/rainbow.sdk.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,OAAO,aAAa,CAAC;AAErB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAKlD,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAEnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,OAAO,KAAK,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC5F,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAG/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,WAAW,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACpJ,OAAO,EAA6E,0BAA0B,EAA0C,MAAM,YAAY,CAAC;AAE3K,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAC1E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAE3E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAE/E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEzE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAEjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sDAAsD,CAAC;AAEpG,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AAE7E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAEjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAC;AAExF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,oDAAoD,CAAC;AAEnG,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sDAAsD,CAAC;AAEpG,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAElE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,qDAAqD,CAAC;AAExG,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAE1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAEhF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAE7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAEnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAElF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AAG9E,MAAM,WAAW,mBAAmB;IAChC,mCAAmC;IACnC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,qCAAqC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACrC,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;CAChD;AAED,MAAM,WAAW,gBAAgB;IAE7B,gCAAgC;IAChC,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAEhC,gDAAgD;IAChD,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IAEtB,wFAAwF;IACxF,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,yCAAyC;IACzC,QAAQ,CAAC,EAAE,YAAY,CAAC;IAExB,8GAA8G;IAC9G,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,+DAA+D;IAC/D,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAE1C,gBAAgB;IAChB,MAAM,CAAC,EAAE,uBAAuB,CAAC;IAEjC,gBAAgB;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;GAMG;AACH,qBAAa,UAAU;IACnB;;;OAGG;IACH,IAAW,aAAa,IAAI,aAAa,GAAG,SAAS,CAA6C;IAElG;;;OAGG;IACH,IAAW,iBAAiB,IAAI,iBAAiB,CAAoC;IAErF;;;QAGI;IACJ,IAAW,mBAAmB,IAAI,mBAAmB,CAAsC;IAE3F;;;OAGG;IACH,IAAW,WAAW,IAAI,WAAW,CAA8B;IAEnE;;;OAGG;IACH,IAAW,KAAK,IAAI,gBAAgB,CAAmC;IAEvE;;;;OAIG;IACH,IAAW,aAAa,IAAI,aAAa,CAAgC;IAEzE;;;;OAIG;IACH,IAAW,WAAW,IAAI,WAAW,CAA4C;IAEjF;;;OAGG;IACH,IAAW,cAAc,IAAI,cAAc,CAAkD;IAE7F;;;OAGG;IACH,IAAW,cAAc,IAAI,cAAc,CAAkD;IAE7F;;;OAGG;IACH,IAAW,WAAW,IAAI,kBAAkB,CAAqD;IAEjG;;;OAGG;IACH,IAAW,aAAa,IAAI,aAAa,GAAG,SAAS,CAAgD;IAErG;;;OAGG;IACH,IAAW,gBAAgB,IAAI,gBAAgB,GAAG,SAAS,CAAuD;IAElH;;;OAGG;IACH,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAkD;IAEzG;;;OAGG;IACH,IAAW,mBAAmB,IAAI,mBAAmB,GAAG,SAAS,CAA4D;IAE7H;;;OAGG;IACH,IAAW,sBAAsB,IAAI,sBAAsB,CAAmE;IAE9H;;;OAGG;IACH,IAAW,WAAW,IAAI,WAAW,GAAG,SAAS,CAA4C;IAE7F;;;OAGG;IACH,IAAW,mBAAmB,IAAI,mBAAmB,GAAG,SAAS,CAA6D;IAE9H;;;OAGG;IACH,IAAW,gBAAgB,IAAI,gBAAgB,GAAG,SAAS,CAAsD;IAEjH;;;OAGG;IACH,IAAW,eAAe,IAAI,cAAc,GAAG,SAAS,CAAmD;IAE3G;;;OAGG;IACH,IAAW,uBAAuB,IAAI,uBAAuB,GAAG,SAAS,CAAqE;IAE9I;;;OAGG;IACH,IAAW,kBAAkB,IAAI,kBAAkB,GAAG,SAAS,CAA2D;IAE1H;;;OAGG;IACH,IAAW,uBAAuB,IAAI,uBAAuB,GAAG,SAAS,CAAqE;IAE9I;;;OAGG;IACH,IAAW,sBAAsB,IAAI,sBAAsB,GAAG,SAAS,CAAkE;IAEzI;;;OAGG;IACH,IAAW,oBAAoB,IAAI,wBAAwB,GAAG,SAAS,CAAuE;IAE9I;;;OAGG;IACH,IAAW,uBAAuB,IAAI,uBAAuB,CAAoD;IAEjH;;;OAGG;IACH,IAAW,sBAAsB,IAAI,4BAA4B,GAAG,SAAS,CAAyE;IAEtJ;;;OAGG;IACH,IAAW,cAAc,IAAI,cAAc,GAAG,SAAS,CAAkD;IAEzG;;;OAGG;IACH,IAAW,eAAe,IAAI,eAAe,CAAoD;IAEjG;;;OAGG;IACH,IAAW,WAAW,IAAI,aAAa,GAAG,SAAS,CAA8C;IAEjG;;;OAGG;IACH,IAAW,YAAY,IAAI,YAAY,GAAG,SAAS,CAA8C;IAEjG;;;OAGG;IACH,IAAW,mBAAmB,IAAI,0BAA0B,CAA4C;IAExG;;;OAGG;IACH,IAAW,YAAY,IAAI,eAAe,GAAG,SAAS,CAAqD;IAE3G;;;OAGG;IACH,IAAW,UAAU,IAAI,UAAU,GAAG,SAAS,CAA0C;IAEzF;;;OAGG;IACH,IAAW,iBAAiB,IAAI,iBAAiB,GAAG,SAAS,CAAyD;IAEtH;;;OAGG;IACH,IAAW,eAAe,IAAI,eAAe,GAAG,SAAS,CAAqD;IAEvG,cAAc,EAAE,wBAAwB,GAAG,SAAS,CAAC;IAE5D,OAAO,CAAC,eAAe,CAAgD;IACvE,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,cAAc,CAA8C;IACpE,OAAO,CAAC,kBAAkB,CAA0D;IACpF,OAAO,CAAC,iBAAiB,CAAoD;IAC7E,OAAO,CAAC,oBAAoB,CAAuC;IACnE,OAAO,CAAC,uBAAuB,CAAkE;IACjG,OAAO,CAAC,mBAAmB,CAAoC;IAC/D,OAAO,CAAC,0BAA0B,CAA4C;IAE9E;;;OAGG;WACW,WAAW,IAAI,UAAU;IAOvC;;;OAGG;WACW,MAAM,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,UAAU;IAiF5D,OAAO;IAEP;;;OAGG;IACI,UAAU,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAIxC;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IAIhD;;OAEG;IACI,WAAW,IAAI,YAAY;IAIlC;;;OAGG;IACU,KAAK,IAAI,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAIxD;;;MAGE;IACW,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIlC;;;MAGE;IACK,UAAU,IAAI,MAAM;IAI3B;;;MAGE;IACK,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;CAG1D"}

package/lib/services/admin/admin-alarm.service.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @module Admin
+ */
+import type { AuthService } from "../../services/core/auth.service";
+import type { LoggerService } from "../../services/core/logger.service";
+import type { ErrorHelperService } from "../../services/utilities/errorHelper.service";
+/**
+ * Admin sub-service for alarm counter retrieval.
+ *
+ * Accessible via `adminService.alarm`.
+ *
+ * @example
+ * ```ts
+ * const counter = await adminService.alarm.getAlarmCounter();
+ * ```
+ */
+export interface SDKAdminAlarmService {
+    /**
+     * Fetches the number of active alarms for a given company or business partner.
+     *
+     * @param options - Optional filter by companyId or bpId.
+     * @returns The number of active alarms.
+     */
+    getAlarmCounter: (options?: {
+        companyId?: string;
+        bpId?: string;
+    }) => Promise<number>;
+}
+/**
+ * @internal
+ */
+export declare class SDKAdminAlarmServiceRB implements SDKAdminAlarmService {
+    private readonly authService;
+    private readonly loggerService;
+    private readonly errorHelperService;
+    constructor(authService: AuthService, loggerService: LoggerService, errorHelperService: ErrorHelperService);
+    getAlarmCounter(options?: {
+        companyId?: string;
+        bpId?: string;
+    }): Promise<number>;
+}
+//# sourceMappingURL=admin-alarm.service.d.ts.map

package/lib/services/admin/admin-alarm.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin-alarm.service.d.ts","sourceRoot":"","sources":["../../../src/services/admin/admin-alarm.service.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iDAAiD,CAAC;AACnF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mDAAmD,CAAC;AACvF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6DAA6D,CAAC;AAItG;;;;;;;;;GASG;AACH,MAAM,WAAW,oBAAoB;IAEjC;;;;;OAKG;IACH,eAAe,EAAE,CAAC,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;KAAE,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC1F;AAED;;GAEG;AACH,qBAAa,sBAAuB,YAAW,oBAAoB;IAE3D,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,kBAAkB;gBAFlB,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,EAC5B,kBAAkB,EAAE,kBAAkB;IAG9C,eAAe,CAAC,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;CAqBlG"}

package/lib/services/admin/admin-company.service.d.ts

@@ -0,0 +1,167 @@
+/**
+ * @module Admin
+ */
+import { Company } from "../..";
+/**
+ * The splash screen a company uses — the image shown while the application loads.
+ *
+ * A company holds at most one uploaded image, and {@link uploadedUsed} says whether that image
+ * or the default Rainbow screen is in use: uploading and selecting are two distinct steps.
+ */
+export interface SplashScreenInfo {
+    /** `true` when the company's Business Partner forbids customising the splash screen. */
+    readonly isForced: boolean;
+    /** `true` when the uploaded image is in use, `false` for the default Rainbow screen. */
+    readonly uploadedUsed: boolean;
+    /** ISO date of the last change. Also used to bust the image cache. */
+    readonly lastUpdateDate: string;
+    /** Identifier of the company the splash screen belongs to. */
+    readonly companyId: string;
+}
+/**
+ * Admin sub-service for company management.
+ *
+ * Accessible via `adminService.company`.
+ *
+ * @example
+ * ```ts
+ * const company = await adminService.company.get(companyId);
+ * const all = await adminService.company.getAll();
+ * const created = await adminService.company.create('Acme', 'FR');
+ * await adminService.company.remove(company);
+ * ```
+ */
+export interface SDKAdminCompanyService {
+    /**
+     * Fetches a single company by its identifier.
+     *
+     * @param companyId - The unique identifier of the company.
+     * @returns The matching {@link Company} instance with full details.
+     * @throws {@link RainbowError} when the company is not found or the request fails.
+     */
+    get: (companyId: string) => Promise<Company>;
+    /**
+     * Fetches all companies visible to the authenticated admin.
+     *
+     * @returns An array of {@link Company} instances.
+     * @throws {@link RainbowError} when the request fails.
+     */
+    getAll: () => Promise<Company[]>;
+    /**
+     * Creates a new company.
+     *
+     * @param name - Display name of the company.
+     * @param country - ISO country code (e.g. `"FR"`, `"US"`).
+     * @param state - Optional state or region within the country.
+     * @returns The newly created {@link Company} instance.
+     * @throws {@link RainbowError} when creation fails.
+     */
+    create: (name: string, country: string, state?: string) => Promise<Company>;
+    /**
+     * Creates the connected user's own company, for a user who has none yet.
+     *
+     * Unlike {@link create}, which is the administrator's endpoint, this goes through the
+     * end-user API: a standalone user carries no admin role and could not call the other one.
+     * The backend attaches the caller to the new company and makes them its administrator, so the
+     * connected contact must be refreshed afterwards — `isInDefaultCompany` and the roles change.
+     *
+     * @throws the backend error; `errorDetailsCode` 400500 / 400504 means the name is taken.
+     */
+    createMyCompany: (name: string, country: string, state?: string) => Promise<Company>;
+    /**
+     * Deletes a company.
+     *
+     * @param companyRef - The company to delete, as either its string ID or a {@link Company} instance.
+     * @throws {@link RainbowError} when the deletion fails.
+     */
+    remove: (companyRef: string | Company) => Promise<void>;
+    /**
+     * Resolves and sets the logo image on a company object.
+     *
+     * Computes the avatar image (either from the server or a generated fallback)
+     * and assigns it to `company.logo`.
+     *
+     * @param company - The company whose logo should be resolved.
+     * @returns The same {@link Company} instance with `logo` populated.
+     * @throws {@link RainbowError} when the logo resolution fails.
+     */
+    getLogo: (company: Company) => Promise<Company>;
+    /**
+     * Loads the banner image for a company and assigns it to `company.banner`.
+     *
+     * @param company - The company whose banner should be loaded.
+     * @returns The same {@link Company} instance with `banner` populated (or unchanged when none exists).
+     */
+    getBanner: (company: Company) => Promise<Company>;
+    /**
+     * Reads which splash screen a company currently uses.
+     *
+     * @param companyId - The unique identifier of the company.
+     * @returns The company's {@link SplashScreenInfo}.
+     * @throws {@link RainbowError} when the request fails.
+     */
+    getSplashScreen: (companyId: string) => Promise<SplashScreenInfo>;
+    /**
+     * Uploads a custom splash screen image for a company, replacing any previous one.
+     *
+     * Uploading does not select the image on its own — call {@link setSplashScreen} to put it in
+     * use, unless the returned `uploadedUsed` already says the backend selected it.
+     *
+     * @param companyId - The unique identifier of the company.
+     * @param image - The image file, sent as-is with its own content type.
+     * @returns The updated {@link SplashScreenInfo}.
+     * @throws {@link RainbowError} when the upload fails; `errorDetailsCode` 413000 means the file
+     * exceeds the size the backend accepts.
+     */
+    uploadSplashScreen: (companyId: string, image: File) => Promise<SplashScreenInfo>;
+    /**
+     * Chooses between the uploaded image and the default Rainbow screen.
+     *
+     * @param companyId - The unique identifier of the company.
+     * @param useUploaded - `true` to use the uploaded image, `false` for the default screen.
+     * @returns The updated {@link SplashScreenInfo}.
+     * @throws {@link RainbowError} when the request fails.
+     */
+    setSplashScreen: (companyId: string, useUploaded: boolean) => Promise<SplashScreenInfo>;
+    /**
+     * Deletes the company's uploaded splash screen image, falling back to the default screen.
+     *
+     * @param companyId - The unique identifier of the company.
+     * @throws {@link RainbowError} when the deletion fails.
+     */
+    removeSplashScreen: (companyId: string) => Promise<void>;
+    resolveId: (companyRef: string | Company) => string | undefined;
+}
+/**
+ * @internal
+ */
+export declare class SDKAdminCompanyServiceRB implements SDKAdminCompanyService {
+    private readonly userInfoService;
+    private readonly authService;
+    private readonly loggerService;
+    private readonly errorHelperService;
+    private readonly userService;
+    getAll(): Promise<Company[]>;
+    get(companyId: string): Promise<Company>;
+    create(name: string, country: string, state?: string): Promise<Company>;
+    createMyCompany(name: string, country: string, state?: string): Promise<Company>;
+    remove(companyRef: string | Company): Promise<void>;
+    getLogo(company: Company): Promise<Company>;
+    getBanner(company: Company): Promise<Company>;
+    getSplashScreen(companyId: string): Promise<SplashScreenInfo>;
+    uploadSplashScreen(companyId: string, image: File): Promise<SplashScreenInfo>;
+    setSplashScreen(companyId: string, useUploaded: boolean): Promise<SplashScreenInfo>;
+    removeSplashScreen(companyId: string): Promise<void>;
+    /**
+     * Resolves a company reference to its string identifier.
+     *
+     * Accepts either a raw company ID string or a {@link Company} instance and
+     * returns the corresponding string ID. Returns `undefined` if the argument
+     * is neither.
+     *
+     * @param companyRef - A company ID string or a {@link Company} instance.
+     * @returns The resolved string identifier, or `undefined` when the input is unrecognised.
+     */
+    resolveId(companyRef: string | Company): string | undefined;
+}
+//# sourceMappingURL=admin-company.service.d.ts.map

package/lib/services/admin/admin-company.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin-company.service.d.ts","sourceRoot":"","sources":["../../../src/services/admin/admin-company.service.ts"],"names":[],"mappings":"AACA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAkD,MAAM,sBAAsB,CAAC;AAO/F;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAE7B,wFAAwF;IACxF,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B,wFAAwF;IACxF,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAE/B,sEAAsE;IACtE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,8DAA8D;IAC9D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC9B;AAQD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,sBAAsB;IAEnC;;;;;;OAMG;IACH,GAAG,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7C;;;;;OAKG;IACH,MAAM,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEjC;;;;;;;;OAQG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5E;;;;;;;;;OASG;IACH,eAAe,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAErF;;;;;OAKG;IACH,MAAM,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;;;;;OASG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhD;;;;;OAKG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAElD;;;;;;OAMG;IACH,eAAe,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAElE;;;;;;;;;;;OAWG;IACH,kBAAkB,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAElF;;;;;;;OAOG;IACH,eAAe,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAExF;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,SAAS,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,KAAK,MAAM,GAAG,SAAS,CAAC;CACnE;AAED;;GAEG;AACH,qBAAa,wBAAyB,YAAW,sBAAsB;IACnE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAkD;IAClF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0C;IACtE,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA8C;IAC5E,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAwD;IAC3F,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA+B;IAE9C,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAe5B,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAexC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBvE,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBhF,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAenD,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAc3C,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAsB7C,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAiB7D,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkB7E,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkBnF,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAejE;;;;;;;;;OASG;IACI,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS;CAOrE"}

package/lib/services/admin/admin-department.service.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @module Admin
+ */
+import type { AuthService, LoggerService, ErrorHelperService } from "../..";
+/**
+ * Admin sub-service for department read access.
+ *
+ * Accessible via `adminService.department`.
+ *
+ * @example
+ * ```ts
+ * const departments = await adminService.department.getAll(companyId);
+ * ```
+ */
+export interface SDKAdminDepartmentService {
+    /**
+     * Fetches all departments for a given company.
+     *
+     * Empty or falsy department entries returned by the server are filtered out.
+     * When `companyId` is omitted or empty, the server returns departments for
+     * the authenticated user's own company.
+     *
+     * @param companyId - The unique identifier of the company.
+     * @returns An array of raw department data objects.
+     * @throws {@link RainbowError} when the request fails.
+     */
+    getAll: (companyId: string) => Promise<string[]>;
+}
+/**
+ * @internal
+ */
+export declare class SDKAdminDepartmentServiceRB implements SDKAdminDepartmentService {
+    private readonly authService;
+    private readonly loggerService;
+    private readonly errorHelperService;
+    constructor(authService: AuthService, loggerService: LoggerService, errorHelperService: ErrorHelperService);
+    getAll(companyId: string): Promise<string[]>;
+}
+//# sourceMappingURL=admin-department.service.d.ts.map

package/lib/services/admin/admin-department.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin-department.service.d.ts","sourceRoot":"","sources":["../../../src/services/admin/admin-department.service.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE3F;;;;;;;;;GASG;AACH,MAAM,WAAW,yBAAyB;IAEtC;;;;;;;;;;OAUG;IACH,MAAM,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACpD;AAED;;GAEG;AACH,qBAAa,2BAA4B,YAAW,yBAAyB;IAErE,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,kBAAkB;gBAFlB,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,EAC5B,kBAAkB,EAAE,kBAAkB;IAG9C,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAc5D"}