@ale-rainbow/web-sdk 5.1.0

package/lib/models/common/fileDescriptor.d.ts

@@ -0,0 +1,317 @@
+import { BehaviorSubject } from "rxjs/internal/BehaviorSubject";
+import type { Subscription } from "rxjs";
+import { Subject } from "rxjs";
+import type { FileViewer } from "../../models/common/fileViewer";
+import type { Contact } from "../contact.model";
+/**
+ * @enum
+ * @name FileStorageType
+ * @description This enum is used to represent the type of the storage (Rainbow or External)
+ */
+export declare enum FileStorageType {
+    RAINBOW = "Rainbow",
+    OWNCLOUD = "OwnCloud",
+    NEXTCLOUD = "NextCloud"
+}
+export declare enum FileState {
+    DELETED = "deleted",
+    UPLOADING = "uploading",
+    UPLOADED = "uploaded",
+    NOT_UPLOADED = "not_uploaded",
+    DOWNLOADING = "downloading",
+    UPLOADERROR = "uploadError",
+    UNKNOWN = "unknown"
+}
+declare class ThumbnailPlaceholder {
+    icon: string;
+    style: string;
+    type: string;
+    constructor(icon: string, style: string, type: string);
+}
+interface IThumbnail {
+    availableThumbnail: boolean;
+    md5sum: string;
+    size: number;
+    wantThumbnailDate: Date;
+    isThumbnailAvailable: () => boolean;
+}
+/**
+ * This class is used to represent a File Descriptor or a Short File Descriptor which describes a file shared in a conversation (one-to-one or bubble).
+ */
+export declare class FileDescriptor {
+    /**
+     * @public
+     * @property {string} id The file descriptor ID (File Descriptor only)
+     * @readonly
+     */
+    id: string;
+    /**
+     * @public
+     * @property {string} path The file descriptor path
+     * @readonly
+     */
+    path: string;
+    /**
+     * @public
+     * @property {string} type The file descriptor type (file or directory)
+     * @readonly
+     */
+    type: string;
+    /**
+     * @public
+     * @property {string} url The file descriptor url (File Descriptor only)
+     * @readonly
+     */
+    url: string;
+    /**
+     * @public
+     * @property {string} ownerId The ID of the owner (File Descriptor only)
+     * @readonly
+     */
+    ownerId: string;
+    /**
+     * @public
+     * @property {string} owner The owner's contact (File Descriptor only)
+     * @readonly
+     */
+    owner: Contact;
+    /**
+     * @public
+     * @property {string} fileName The name of the file
+     * @readonly
+     */
+    fileName: string;
+    /**
+     * @public
+     * @property {string} fileNameToFilter The name of the file avfter dyacritis
+     * @readonly
+     */
+    fileNameToFilter: string;
+    /**
+     * @public
+     * @property {string} extension The extension of the file
+     * @readonly
+     */
+    extension: string;
+    /**
+     * @public
+     * @property {string} typeMIME The mime type of the file ('mime' in Short File Descriptor)
+     * @readonly
+     */
+    typeMIME: string;
+    /**
+     * @public
+     * @property {string} size The size of the file (octets)
+     * @readonly
+     */
+    size: number;
+    /**
+     * @public
+     * @property {object} registrationDate The creation date (File Descriptor only)
+     * @readonly
+     */
+    registrationDate: Date;
+    /**
+     * @public
+     * @property {object} uploadedDate The upload date (File Descriptor only)
+     * @readonly
+     */
+    uploadedDate: Date;
+    /**
+     * @private
+     * @property {object} dateToSort The date to sort (?)
+     * @readonly
+     */
+    dateToSort: Date;
+    /**
+     * @private
+     * @property {boolean} externalStorage True if this fileDescriptor is linked to external storage
+     * @readonly
+     */
+    externalStorage: boolean;
+    /**
+     * @public
+     * @property {string} transcriptionStatus the state of transcription
+     * @readonly
+     */
+    transcriptionStatus: string;
+    /**
+     * @public
+     * @property {string} transcription the text of the transcription
+     * @readonly
+     */
+    transcription: string;
+    /**
+     * @public
+     * @property {boolean} transcriptionAlreadyActivated To know if the transcription has been launched
+     * @readonly
+     */
+    transcriptionAlreadyActivated: boolean;
+    /**
+     * @public
+     * @property {boolean} callRecord True when the file is a P2P call recording.
+     * @readonly
+     */
+    callRecord: boolean;
+    /**
+     * @public
+     * @property {string} callId Id of the P2P call this recording is attached to (matches the call log call_id).
+     * @readonly
+     */
+    callId: string;
+    /**
+     * @private
+     * @property {any[]} viewers The list of viewers (File Descriptor only)
+     * @readonly
+     */
+    private _viewers;
+    get viewers(): FileViewer[];
+    set viewers(value: FileViewer[]);
+    viewersSubject: BehaviorSubject<FileViewer[]>;
+    state: FileState;
+    stateSubject: BehaviorSubject<FileState>;
+    fileToSend?: File;
+    previewBlob?: Blob;
+    previewBlobSubject: BehaviorSubject<Blob>;
+    blobOrientation?: any;
+    blobOrientationSubject: BehaviorSubject<any>;
+    /**
+     * @public
+     * @property {number} original_h original image height
+     * @description height of original image (for image only)
+     */
+    original_h: number;
+    /**
+     * @public
+     * @property {number} original_w original image width
+     * @description weight of original image (for image only)
+     */
+    original_w: number;
+    /**
+     * @private
+     * @property {object} tags data for visual voice mails
+     * @readonly
+     */
+    tags: any;
+    time: number;
+    displayDate: any;
+    /**
+     * @public
+     * @property {Subject<any>} progressSubject Observable for download progress
+     * @readonly
+     */
+    progressSubject: Subject<any>;
+    /**
+     * @public
+     * @property {any} localURL ????
+     * @readonly
+     */
+    localURL: any;
+    cancelTransfertDefer: any;
+    abortTransferController: AbortController;
+    abortXMLHttpRequestArray: Function[];
+    fileTransferSubscription: Subscription;
+    loadingRef: number[];
+    chunkTotalNumber: number;
+    chunkPerformedPercent: number;
+    chunkPercentArray: number[];
+    chunkPerformed: number;
+    publicUrl: string;
+    publicUrlExpirationDate: Date;
+    chunkWrittenInDisk: number;
+    writeStream: any;
+    thumbnail: IThumbnail;
+    /**
+     * @public
+     * @property {ThumbnailPlaceholder} thumbnailPlaceholder The thumbnail icon placeholder info
+     * @readonly
+     */
+    thumbnailPlaceholder: ThumbnailPlaceholder;
+    /**
+     * @public
+     * @property {number} orientation image orientation
+     * @description
+     *      There are four possible values for orientation and the image should be rotated acording to this value.
+     *      1 -> rotate(0deg),
+     *      3 -> rotate(180deg),
+     *      6 -> rotate(90deg),
+     *      8 -> rotate(270deg).
+     */
+    orientation: number;
+    /**
+     * @public
+     * @property {string} virusScanState Result of virus scan
+     * @readonly
+     */
+    virusScanState: string;
+    /**
+     * @public
+     * @property {boolean} cantBeScanned True when the server has confirmed this file cannot be scanned
+     * (either via a vscan XMPP notification with cantBeScannedYet=true, or after a timeout with no
+     * scan activity — indicating an old server with no virus scan support).
+     */
+    cantBeScanned: boolean;
+    /**
+     * True when the browser failed to decode/play this video for
+     * this session (client-derived, not server data — not reset by update()).
+     */
+    unsupportedFormat: boolean;
+    /**
+     * @public
+     * @property {boolean} voiceMessage True when the file is a voice message
+     * @readonly
+     */
+    voiceMessage: boolean;
+    /**
+     * @public
+     * @property {boolean} recordingFile Property indicating whether the file is a part of a recording file batch
+     * @readonly
+     */
+    recordingFile: boolean;
+    /**
+     * @public
+     * @property {string} recordingConferenceId ID of the recording conference. If the file is a recording file it indicates the ID of the conference
+     * @readonly
+     */
+    recordingConferenceId: string;
+    /**
+     * @public
+     * @property {boolean} voiceMessage True when the preview is downloaded
+     * @readonly
+     */
+    previewDownloaded: boolean;
+    private constructor();
+    static create(id: string, url: string, ownerId: string, fileName: string, extension: string, mime: string, size: number, registrationDate: Date, uploadedDate: Date, dateToSort: Date, viewers: any, state: FileState, thumbnail: IThumbnail, orientation: number, original_w: number, original_h: number, tags: any, virusScanState: any, voiceMessage: any, recordingFile: boolean, recordingConferenceId: string, transcriptionStatus: string, transcription: string): FileDescriptor;
+    static createFromExternalStorageData(data: any): FileDescriptor;
+    isMicrosoftFile(): boolean;
+    isRainbowStorage(): boolean;
+    isThumbnailPossible(): boolean;
+    isJavaScript(): boolean;
+    isText(): boolean;
+    isLog(): boolean;
+    isMarkdown(): boolean;
+    isPDF(): boolean;
+    isVideo(): boolean;
+    isSVG(): boolean;
+    isImage(): boolean;
+    isAudioVideo(): boolean;
+    isUploaded(): boolean;
+    isPublicUrlExpired(): boolean;
+    isAlreadyFileViewer(viewerId: string): boolean;
+    getDisplayName(): string;
+    getDisplayNameTruncated(): string[];
+    getExtension(): string;
+    getDuration(): number;
+    getThumbnailPlaceholderFromMimetype(mime: string): ThumbnailPlaceholder;
+    releaseURL(): void;
+    setState(newState: FileState): void;
+    setOriginalImageDimensions(width: number, height: number): void;
+    update(fd: FileDescriptor): void;
+    getDate(): Date;
+    private refreshFilePercent;
+    updateProgressInfo(): void;
+    isInfected(): boolean;
+    isSoleFileViewer(fileViewerId: string): boolean;
+}
+export {};
+//# sourceMappingURL=fileDescriptor.d.ts.map

package/lib/models/common/fileDescriptor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDescriptor.d.ts","sourceRoot":"","sources":["../../../src/models/common/fileDescriptor.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAEhF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;;;GAIG;AACH,oBAAY,eAAe;IACvB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,SAAS,cAAc;CAC1B;AAED,oBAAY,SAAS;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;IAC3B,OAAO,YAAY;CACtB;AAED,cAAM,oBAAoB;IACH,IAAI,EAAE,MAAM;IAAS,KAAK,EAAE,MAAM;IAAS,IAAI,EAAE,MAAM;gBAAvD,IAAI,EAAE,MAAM,EAAS,KAAK,EAAE,MAAM,EAAS,IAAI,EAAE,MAAM;CAC7E;AAED,UAAU,UAAU;IAChB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,IAAI,CAAC;IACxB,oBAAoB,EAAE,MAAM,OAAO,CAAC;CACvC;AAwBD;;GAEG;AACH,qBAAa,cAAc;IACvB;;;;OAIG;IACI,EAAE,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACI,IAAI,EAAE,MAAM,CAAM;IAEzB;;;;OAIG;IACI,IAAI,EAAE,MAAM,CAAU;IAE7B;;;;OAIG;IACI,GAAG,EAAE,MAAM,CAAQ;IAE1B;;;;OAIG;IACI,OAAO,EAAE,MAAM,CAAQ;IAE9B;;;;OAIG;IACI,KAAK,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACI,QAAQ,EAAE,MAAM,CAAQ;IAE/B;;;;OAIG;IACI,gBAAgB,EAAE,MAAM,CAAC;IAEhC;;;;OAIG;IACI,SAAS,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACI,QAAQ,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACI,IAAI,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACI,gBAAgB,EAAE,IAAI,CAAC;IAE9B;;;;OAIG;IACI,YAAY,EAAE,IAAI,CAAC;IAE1B;;;;OAIG;IACI,UAAU,EAAE,IAAI,CAAC;IAExB;;;;OAIG;IACI,eAAe,EAAE,OAAO,CAAS;IAExC;;;;OAIG;IACI,mBAAmB,EAAE,MAAM,CAAQ;IAE1C;;;;OAIG;IACI,aAAa,EAAE,MAAM,CAAQ;IAEpC;;;;OAIG;IACI,6BAA6B,EAAE,OAAO,CAAS;IAEtD;;;;OAIG;IACI,UAAU,EAAE,OAAO,CAAS;IAEnC;;;;OAIG;IACI,MAAM,EAAE,MAAM,CAAQ;IAE7B;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAe;IAC/B,IAAW,OAAO,IAAI,UAAU,EAAE,CAA0B;IAC5D,IAAW,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,EAAqE;IACpG,cAAc,gCAAyC;IAEvD,KAAK,EAAE,SAAS,CAAC;IACjB,YAAY,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IACzC,UAAU,CAAC,EAAE,IAAI,CAAa;IAC9B,WAAW,CAAC,EAAE,IAAI,CAAa;IAC/B,kBAAkB,EAAE,eAAe,CAAC,IAAI,CAAC,CAAwC;IACjF,eAAe,CAAC,EAAE,GAAG,CAAa;IAClC,sBAAsB,EAAE,eAAe,CAAC,GAAG,CAAC,CAAuC;IAE1F;;;;OAIG;IACI,UAAU,EAAE,MAAM,CAAK;IAE9B;;;;OAIG;IACI,UAAU,EAAE,MAAM,CAAK;IAE9B;;;;OAIG;IACI,IAAI,EAAE,GAAG,CAAQ;IAEjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,GAAG,CAAC;IAExB;;;;OAIG;IACI,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,CAAsB;IAE1D;;;;OAIG;IACI,QAAQ,EAAE,GAAG,CAAC;IAGd,oBAAoB,EAAE,GAAG,CAAC;IAC1B,uBAAuB,EAAE,eAAe,CAAyB;IACjE,wBAAwB,EAAE,QAAQ,EAAE,CAAM;IAC1C,wBAAwB,EAAE,YAAY,CAAC;IACvC,UAAU,EAAE,MAAM,EAAE,CAAM;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IAGvB,SAAS,EAAE,MAAM,CAAC;IAClB,uBAAuB,EAAE,IAAI,CAAC;IAG9B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,GAAG,CAAC;IAGjB,SAAS,EAAE,UAAU,CAAC;IAE7B;;;;OAIG;IACI,oBAAoB,EAAE,oBAAoB,CAAC;IAElD;;;;;;;;;OASG;IACI,WAAW,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACI,cAAc,EAAE,MAAM,CAAQ;IAErC;;;;;OAKG;IACI,aAAa,EAAE,OAAO,CAAS;IAEtC;;;OAGG;IACI,iBAAiB,EAAE,OAAO,CAAS;IAE1C;;;;OAIG;IACI,YAAY,EAAE,OAAO,CAAS;IAErC;;;;OAIG;IACI,aAAa,EAAE,OAAO,CAAS;IAEtC;;;;OAIG;IACI,qBAAqB,EAAE,MAAM,CAAM;IAE1C;;;;OAIG;IACI,iBAAiB,EAAE,OAAO,CAAS;IAE1C,OAAO;WAUO,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO,EAAE,qBAAqB,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,cAAc;WA2Bjd,6BAA6B,CAAC,IAAI,EAAE,GAAG;IAU9C,eAAe,IAAI,OAAO;IAK1B,gBAAgB,IAAI,OAAO;IAE3B,mBAAmB,IAAI,OAAO;IAE9B,YAAY,IAAI,OAAO;IAEvB,MAAM,IAAI,OAAO;IAEjB,KAAK,IAAI,OAAO;IAEhB,UAAU,IAAI,OAAO;IAErB,KAAK,IAAI,OAAO;IAEhB,OAAO,IAAI,OAAO;IAElB,KAAK,IAAI,OAAO;IAEhB,OAAO,IAAI,OAAO;IAKlB,YAAY,IAAI,OAAO;IAKvB,UAAU,IAAI,OAAO;IAIrB,kBAAkB,IAAI,OAAO;IAQ7B,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAM9C,cAAc,IAAI,MAAM;IAIxB,uBAAuB,IAAI,MAAM,EAAE;IAKnC,YAAY,IAAI,MAAM;IAKtB,WAAW,IAAI,MAAM;IAKrB,mCAAmC,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB;IA+DvE,UAAU;IAIV,QAAQ,CAAC,QAAQ,EAAE,SAAS;IAK5B,0BAA0B,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAKxD,MAAM,CAAC,EAAE,EAAE,cAAc;IA0BzB,OAAO,IAAI,IAAI;IAMtB,OAAO,CAAC,kBAAkB;IAUnB,kBAAkB;IAKlB,UAAU;IAIV,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;CAMzD"}

package/lib/models/common/filePublicDownload.d.ts

@@ -0,0 +1,26 @@
+import { Subject } from "rxjs";
+/**
+ * @public
+ * @class
+ * @name FilePublicDownload
+ * @description
+ *      This class is used to represent a File Descriptor or a Short File Descriptor which describes a file shared in a conversation (one-to-one or bubble).
+ */
+export declare class FilePublicDownload {
+    url: string;
+    fileName: string;
+    totalBytes: number;
+    receivedBytes: number;
+    savePath: string;
+    isCanceled: boolean;
+    openFolderOnceDownloadFinished: boolean;
+    progressSubject: Subject<any>;
+    static create(url: string, fileName: string, totalBytes: number, receivedBytes: number, savePath: string): FilePublicDownload;
+    /**
+     * @this FilePublicDownload
+     */
+    constructor(url: string, fileName: string, totalBytes: number, receivedBytes: number, savePath: string);
+    isDownloadFinished(): boolean;
+    askCancel(): void;
+}
+//# sourceMappingURL=filePublicDownload.d.ts.map

package/lib/models/common/filePublicDownload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filePublicDownload.d.ts","sourceRoot":"","sources":["../../../src/models/common/filePublicDownload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAG/B;;;;;;GAMG;AACH,qBAAa,kBAAkB;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,8BAA8B,EAAE,OAAO,CAAC;IAExC,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;WAGhB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,kBAAkB;IAIpI;;OAEG;gBACS,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAsC/F,kBAAkB;IAIlB,SAAS;CAInB"}

package/lib/models/common/fileViewer.d.ts

@@ -0,0 +1,20 @@
+import type { ChannelRB } from "../../models/channel.model";
+import type { Contact } from "../../models/contact.model";
+declare class FileViewerType {
+    static USER: string;
+    static ROOM: string;
+}
+/**
+ * This class is used to represent a File Viewer who is the list of persons (individual or a bubble) that can access (download) the file.
+ */
+export declare class FileViewer {
+    viewerId: string;
+    type: FileViewerType;
+    contact: Contact;
+    room: any;
+    channel: ChannelRB;
+    static createFromData(data: any): FileViewer[];
+    private constructor();
+}
+export {};
+//# sourceMappingURL=fileViewer.d.ts.map

package/lib/models/common/fileViewer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileViewer.d.ts","sourceRoot":"","sources":["../../../src/models/common/fileViewer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,2CAA2C,CAAC;AAC3E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2CAA2C,CAAC;AAEzE,cAAM,cAAc;IAChB,OAAc,IAAI,SAAU;IAC5B,OAAc,IAAI,SAAU;CAC/B;AAED;;GAEG;AACH,qBAAa,UAAU;IACZ,QAAQ,EAAE,MAAM,CAAQ;IACxB,IAAI,EAAE,cAAc,CAAQ;IAC5B,OAAO,EAAE,OAAO,CAAQ;IACxB,IAAI,EAAE,GAAG,CAAQ;IACjB,OAAO,EAAE,SAAS,CAAQ;WAEnB,cAAc,CAAC,IAAI,EAAE,GAAG,GAAG,UAAU,EAAE;IAMrD,OAAO;CAWV"}

package/lib/models/common/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./context";
+export * from "./error";
+export * from "./fileDescriptor";
+export * from "./filePublicDownload";
+export * from "./fileViewer";
+export * from "./theme";
+export * from "./userTheme";
+export * from "./themeColor";
+//# sourceMappingURL=index.d.ts.map

package/lib/models/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/models/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}

package/lib/models/common/theme.d.ts

@@ -0,0 +1,185 @@
+import { BehaviorSubject } from "rxjs";
+import { ThemeColor } from "../../models/common/themeColor";
+/**
+ * @enum {string}
+ * @public
+ * @readonly
+ * @description Enumeration of the possible theme's type.
+ */
+export declare enum ThemeType {
+    LIGHT = "light",
+    DARK = "dark"
+}
+/**
+ * @enum {string}
+ * @public
+ * @readonly
+ * @description Enumeration of the possible theme's visibility.
+ */
+export declare enum ThemeVisibility {
+    PRIVATE = "private",
+    PUBLIC = "public"
+}
+/**
+ * @enum {string}
+ * @public
+ * @readonly
+ * @description Enumeration of the possible theme's type.
+ */
+export declare enum ThemeAvatarShape {
+    SQUARE = "square",
+    CIRCLE = "circle"
+}
+/**
+ * @interface IThemeDTO
+ * @description
+ *      Data Transfer Object (DTO) for transferring required data that represents a Theme available for a company.
+ */
+export interface IThemeDTO {
+    id?: string;
+    name: string;
+    type?: ThemeType;
+    ownedByCompany?: string;
+    website?: string;
+    isRainbowDefaultTheme?: boolean;
+    isWhiteLabelTheme?: boolean;
+    visibility?: ThemeVisibility;
+    avatarShape?: ThemeAvatarShape;
+    lastAvatarUpdateDate?: string | null;
+    UIElements?: Record<string, string>[];
+}
+/**
+ * @interface ITheme
+ * @description
+ *      Interface that represents a theme that is available for a company.
+ */
+export interface ITheme extends Omit<IThemeDTO, "UIElements"> {
+    displayName: string;
+    svgPreview: any;
+    logoSrc: string;
+    cssClassName: string;
+    themeColors: ThemeColor[];
+    getThemeColorOfKey: (cssKey: string) => ThemeColor | undefined;
+}
+/**
+ * @class
+ * @name Theme
+ * @description
+ *      This class is used to represent a Theme intended to a Rainbow Company.
+ */
+export declare class Theme implements Required<ITheme> {
+    /**
+     * @public
+     * @property {string} id The theme identifier.
+     * @readonly
+     */
+    id: string;
+    /**
+     * @public
+     * @property {string} name The theme name.
+     * @readonly
+     */
+    name: string;
+    /**
+     * @public
+     * @property {string} displayName The theme name to display.
+     * @readonly
+     */
+    displayName: string;
+    /**
+     * @public
+     * @property {ThemeType} type This string informs if the theme is a white or a dark type.
+     * @readonly
+     */
+    type: ThemeType;
+    /**
+     * @public
+     * @property {boolean} isRainbowDefaultTheme Is the rainbow default Theme.
+     * @readonly
+     */
+    isRainbowDefaultTheme: boolean;
+    /**
+     * @public
+     * @property {boolean} isWhiteLabelTheme Is a custom white label Theme published by a Business Partner.
+     * @readonly
+     */
+    isWhiteLabelTheme: boolean;
+    /**
+     * @public
+     * @property {ThemeVisibility} visibility The theme identifier.
+     * @readonly
+     */
+    visibility: ThemeVisibility;
+    /**
+     * @public
+     * @property {string} ownedByCompany This id of the company owning the theme.
+     * @readonly
+     */
+    ownedByCompany: string;
+    /**
+     * @public
+     * @property {string} website The theme web site Url.
+     * @readonly
+     */
+    website: string;
+    /**
+     * @public
+     * @property {string} lastAvatarUpdateDate The theme logo last modification date.
+     * @readonly
+     */
+    lastAvatarUpdateDate: string;
+    /**
+     * @public
+     * @property {ThemeAvatarShape} avatarShape The theme logo shape (square, round).
+     * @readonly
+     */
+    private _avatarShape;
+    avatarShapeSubject: BehaviorSubject<string>;
+    get avatarShape(): ThemeAvatarShape;
+    set avatarShape(value: ThemeAvatarShape);
+    /**
+     * @public
+     * @property {string} logoSrc The theme logo url to display.
+     * @readonly
+     */
+    private _logoSrc;
+    logoSrcSubject: BehaviorSubject<any>;
+    get logoSrc(): string;
+    set logoSrc(value: string);
+    /**
+     * @public
+     * @property {string} themeColors Array of Colors.
+     * @readonly
+     */
+    themeColors: ThemeColor[];
+    /**
+     * @public
+     * @property {any} svgPreview Theme preview SVG.
+     * @readonly
+     */
+    svgPreview: any;
+    /**
+     * @public
+     * @property {string} cssClassName The CSS Class Name.
+     * @readonly
+     */
+    cssClassName: string;
+    isPublic(): boolean;
+    isPrivate(): boolean;
+    isOwnedBy(companyId: string): boolean;
+    isWhiteLabel(): boolean;
+    isLogoAvailable(): boolean;
+    isWhiteType(): boolean;
+    getThemeColorOfKey(cssKey: string): ThemeColor | undefined;
+    compareTo(theme: Theme): boolean;
+    compareToWithoutLogo(theme: Theme): boolean;
+    constructor(data: Partial<ITheme>);
+    static createFromData(data: IThemeDTO): Theme;
+    static create(id: string, name: string, displayName: string, visibility: ThemeVisibility): Theme;
+    static createStaticWebTheme(name: string, displayName: string, visibility: ThemeVisibility): Theme;
+    static createNewThemeWithConfigurableThemeColors(theme: Theme, isWhiteLabel?: boolean): Theme;
+    static duplicateTheme(theme: Theme): Theme;
+    static duplicateThemeColorsFromTheme(theme: Theme, origTheme: Theme): void;
+    private static generateUUID24Char;
+}
+//# sourceMappingURL=theme.d.ts.map

package/lib/models/common/theme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../../src/models/common/theme.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,+CAA+C,CAAC;AAG3E;;;;;GAKG;AACH,oBAAY,SAAS;IAEjB,KAAK,UAAU;IAEf,IAAI,SAAS;CAChB;AAED;;;;;GAKG;AACH,oBAAY,eAAe;IAEvB,OAAO,YAAY;IAEnB,MAAM,WAAW;CACpB;AAED;;;;;GAKG;AACH,oBAAY,gBAAgB;IAExB,MAAM,WAAW;IAEjB,MAAM,WAAW;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAO,SAAQ,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,GAAG,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IAErB,WAAW,EAAE,UAAU,EAAE,CAAC;IAE1B,kBAAkB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,UAAU,GAAG,SAAS,CAAC;CAClE;AAED;;;;;GAKG;AACH,qBAAa,KAAM,YAAW,QAAQ,CAAC,MAAM,CAAC;IAC1C;;;;OAIG;IACI,EAAE,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACI,IAAI,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACI,WAAW,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACI,IAAI,EAAE,SAAS,CAAmB;IAEzC;;;;OAIG;IACI,qBAAqB,EAAE,OAAO,CAAC;IAEtC;;;;OAIG;IACI,iBAAiB,EAAE,OAAO,CAAC;IAElC;;;;OAIG;IACI,UAAU,EAAE,eAAe,CAA2B;IAE7D;;;;OAIG;IACI,cAAc,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;IACI,OAAO,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACI,oBAAoB,EAAE,MAAM,CAAC;IAEpC;;;;OAIG;IACH,OAAO,CAAC,YAAY,CAA6C;IAC1D,kBAAkB,0BAAkD;IAC3E,IAAW,WAAW,IAAI,gBAAgB,CAA8B;IACxE,IAAW,WAAW,CAAC,KAAK,EAAE,gBAAgB,EAAiF;IAE/H;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAgB;IACzB,cAAc,uBAA2C;IAChE,IAAW,OAAO,IAAI,MAAM,CAA0B;IACtD,IAAW,OAAO,CAAC,KAAK,EAAE,MAAM,EAAqE;IAErG;;;;OAIG;IACI,WAAW,EAAE,UAAU,EAAE,CAAC;IAEjC;;;;OAIG;IACI,UAAU,EAAE,GAAG,CAAC;IAEvB;;;;OAIG;IACI,YAAY,EAAE,MAAM,CAAC;IAMrB,QAAQ,IAAI,OAAO;IAInB,SAAS,IAAI,OAAO;IAIpB,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAIrC,YAAY,IAAI,OAAO;IAIvB,eAAe,IAAI,OAAO;IAI1B,WAAW,IAAI,OAAO;IAItB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAO1D,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAOhC,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;gBAkCtC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC;WAsCnB,cAAc,CAAC,IAAI,EAAE,SAAS,GAAG,KAAK;WAItC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,GAAG,KAAK;WAIzF,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,GAAG,KAAK;WAI3F,yCAAyC,CAAC,KAAK,EAAE,KAAK,EAAE,YAAY,GAAE,OAAe,GAAG,KAAK;WAe7F,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK;WAOnC,6BAA6B,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,GAAG,IAAI;IAMjF,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAIpC"}

package/lib/models/common/themeColor.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @interface IThemeColor
+ * @description
+ *      Represents a color declaration in Theme.
+ */
+export interface IThemeColor {
+    displayName: string;
+    cssVariableName: string;
+    cssValue: string;
+    configurable: boolean;
+}
+/**
+ * @class
+ * @name ThemeColor
+ * @description
+ *      This class is used to represent a color declaration in a Theme.
+ */
+export declare class ThemeColor implements IThemeColor {
+    /**
+     * @public
+     * @property {string} displayName The color displayable translation name.
+     * @readonly
+     */
+    displayName: string;
+    /**
+     * @public
+     * @property {string} cssVariableName The color css name.
+     * @readonly
+     */
+    cssVariableName: string;
+    /**
+     * @public
+     * @property {string} cssValue The color css value.
+     * @readonly
+     */
+    cssValue: string;
+    /**
+     * @public
+     * @property {string} configurable is this color configurable.
+     * @readonly
+     */
+    configurable: boolean;
+    constructor(attributes: IThemeColor);
+    static create(displayName: string, cssVariableName: string, cssValue: string, configurable: boolean): ThemeColor;
+    static createFromThemeColor(themeColor: ThemeColor): ThemeColor;
+}
+//# sourceMappingURL=themeColor.d.ts.map

package/lib/models/common/themeColor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"themeColor.d.ts","sourceRoot":"","sources":["../../../src/models/common/themeColor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,WAAW;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,qBAAa,UAAW,YAAW,WAAW;IAC1C;;;;OAIG;IACI,WAAW,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACI,eAAe,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACI,QAAQ,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACI,YAAY,EAAE,OAAO,CAAC;gBAMjB,UAAU,EAAE,WAAW;WAWrB,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,UAAU;WAIzG,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU;CAGzE"}

package/lib/models/common/userTheme.d.ts

@@ -0,0 +1,42 @@
+import type { ITheme, IThemeDTO, ThemeVisibility } from "./theme";
+import { Theme } from "./theme";
+/**
+ * @interface IUserThemeDTO
+ * @description
+ *      Data Transfer Object (DTO) for transferring required data that represents a Theme that is available for a user.
+ */
+export interface IUserThemeDTO extends IThemeDTO {
+    isThemeSelectedByUser: boolean;
+    isThemeSelectedByAdmin: boolean;
+}
+/**
+ * @interface IUserTheme
+ * @description
+ *      Interface that represents a theme that is available for a user.
+ */
+export interface IUserTheme extends ITheme, Omit<IUserThemeDTO, "UIElements"> {
+}
+/**
+ * @class
+ * @name UserTheme
+ * @description
+ *      This class is used to represent a Theme that is available for a user.
+ */
+export declare class UserTheme extends Theme implements Required<IUserTheme> {
+    /**
+     * @public
+     * @property {boolean} isThemeSelectedByUser This boolean informs if the user has already selected this theme (only present for a theme that is available for a specified user).
+     * @readonly
+     */
+    isThemeSelectedByUser: boolean;
+    /**
+     * @public
+     * @property {boolean} isThemeSelectedByAdmin This boolean informs if the admin has already selected this theme for the user (only present for a theme that is available for a specified user).
+     * @readonly
+     */
+    isThemeSelectedByAdmin: boolean;
+    constructor(data: Partial<IUserTheme | ITheme>);
+    static createFromData(data: IUserThemeDTO | IThemeDTO): UserTheme;
+    static create(id: string, name: string, displayName: string, visibility: ThemeVisibility): UserTheme;
+}
+//# sourceMappingURL=userTheme.d.ts.map

package/lib/models/common/userTheme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userTheme.d.ts","sourceRoot":"","sources":["../../../src/models/common/userTheme.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC5C,qBAAqB,EAAE,OAAO,CAAC;IAC/B,sBAAsB,EAAE,OAAO,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC;CAC5E;AAED;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,KAAM,YAAW,QAAQ,CAAC,UAAU,CAAC;IAChE;;;;OAIG;IACI,qBAAqB,EAAE,OAAO,CAAC;IAEtC;;;;OAIG;IACI,sBAAsB,EAAE,OAAO,CAAC;gBAM3B,IAAI,EAAE,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;WAahC,cAAc,CAAC,IAAI,EAAE,aAAa,GAAG,SAAS,GAAG,SAAS;WAI1D,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,eAAe,GAAG,SAAS;CAG9G"}