@ale-rainbow/web-sdk 5.1.0

package/lib/services/fileDocument/fileDocument.service.d.ts

@@ -0,0 +1,229 @@
+/**
+ * @module FileDocuments
+ */
+import { Service } from "../../services/service";
+import type { Bubble } from "../../models/bubble.model";
+import type { User } from "../../models/user.model";
+import { RBEvent } from "../../models/event.model";
+import type { Conversation } from "../../models/conversation.model";
+import type { ConsumptionData } from "../files/fileStorage.service";
+import type { FileDescriptor } from "../../models/common/fileDescriptor";
+import type { Subscription } from "rxjs";
+import type { FileDocument, FileDocumentExternalSearchOptions, FileDocumentExternalStorage, FileDocumentSearchOptions } from "../../models/fileDocument.model";
+import { FileDocumentRB } from "../../models/fileDocument.model";
+export declare enum FileDocumentCapabilities {
+    THUMBNAILS = "THUMBNAILS",
+    SAVE = "SAVE",
+    TRANSFERT = "TRANSFERT"
+}
+/**
+ * @internal
+ */
+export declare const FILEDOCUMENT_SVC = "FileDocumentService";
+/**
+ * @eventProperty
+ * Events fired by the DocumentsService
+ */
+export declare enum FileDocumentServiceEvents {
+    /**
+     * @eventProperty
+     * This event is fired when a fileDocument is added in the storage
+     */
+    ON_FILE_DOCUMENT_UPLOADED = "ON_FILE_DOCUMENT_UPLOADED",
+    /**
+     * @eventProperty
+     * This event is fired when a fileDocument is updated (state change or viewer added/removed) in the storage
+     */
+    ON_FILE_DOCUMENT_UPDATED = "ON_FILE_DOCUMENT_UPDATED",
+    /**
+     * @eventProperty
+     * This event is fired when a fileDocument is removed from the storage
+     */
+    ON_FILE_DOCUMENT_REMOVED = "ON_FILE_DOCUMENT_REMOVED",
+    /**
+     * @eventProperty
+     * This event is fired when fileDocument storage consumption is updated
+     */
+    ON_CONSUMPTION_UPDATED = "ON_CONSUMPTION_UPDATED",
+    /**
+     * @eventProperty
+     * This event is fired when fileDocument storage usage exceeds 90%.
+     */
+    ON_CONSUMPTION_WARNING = "ON_CONSUMPTION_WARNING",
+    /**
+    * @eventProperty
+    * This event is fired when the content of the document is modified
+    */
+    ON_FILE_DOCUMENT_CONTENT_MODIFIED = "ON_FILE_DOCUMENT_CONTENT_MODIFIED"
+}
+export interface FileDocumentConsumptionData extends ConsumptionData {
+    /** @internal */
+    option?: any;
+}
+export interface FileDocumentService {
+    /**
+     * This property contains the current usage status of your fileDocument storage.
+     */
+    consumption?: FileDocumentConsumptionData;
+    /**
+     * Subscribe to updates from the service (all events are of RBEvent);
+     * @param handler - The call-back function that will be subscribed to the RxJS subject
+     * @param eventNames - array of event to listen
+     */
+    subscribe: (handler: (event: RBEvent<FileDocumentServiceEvents>) => any, eventNames?: FileDocumentServiceEvents | FileDocumentServiceEvents[]) => Subscription;
+    /**
+     * This factory allows to create Document instance from a JavaScript File
+     * @param file - the JavaScript file to manage
+     * @throws an RBError (ex: RBErrorCode.STORAGE_NOT_ENOUGH_SPACE_AVAILABLE)
+     */
+    createFileDocument: (file: File) => Promise<FileDocument>;
+    /**
+     * This method allows to replace the document content.
+     * @param document - The file descriptor object.
+     * @param data - the content blob
+     */
+    replaceFileDocumentContent: (document: FileDocument, data: Blob) => void;
+    /**
+     * This method allows you to search for fileDocuments in your fileDocument storage.
+     * The main search criterion is by name, but you can also leave this field empty
+     * and use the criteria contained in search options
+     * @param options - Search options
+     */
+    searchFileDocuments: (options?: FileDocumentSearchOptions) => Promise<FileDocument[]>;
+    /**
+     * This method retrieves the fileDocuments shared in a conversation.
+     * For obvious performance reasons, it does not return the full list of fileDocuments, but a page of 1000 fileDocuments.
+     * To retrieve the next page, simply call it up again.
+     * @param conversation - the conversation
+     */
+    getConversationFileDocuments: (conversation: Conversation) => Promise<{
+        documents: FileDocument[];
+        complete: boolean;
+    }>;
+    /**
+     * This method retrieves the fileDocuments shared in a conversation.
+     * For obvious performance reasons, it does not return the full list of fileDocuments, but a page of 1000 fileDocuments.
+     * To retrieve the next page, simply call it up again.
+     * @param conversation - the conversation
+     */
+    /**
+     * This method will create an archive (zip) will all fileDocuments; Once generated, the zip will be available in the user storage;
+     * ATTENTION: In return you'll get the FileDocument that can be used to download the archive, but it will remain in the user storage; So consider removing it from the storage in order to save space;
+     * ATTENTION2: Each call of this API will generate a new zip that will be storred in the storage of the user.
+     * NB: This process might take a while, up to several minutes (depending on the files size, etc)
+     * @param zipName - the name of the zip [Optional]
+     * @param documents - the list of documents to zip
+     */
+    createZipFromDocuments: (zipName: string, documents: FileDocument[]) => Promise<FileDocument>;
+    /**
+     * Builds a downloadable archive of a P2P call recording (audio + transcript/summary bundled server-side).
+     */
+    createZipFromCallRecord: (zipName: string, callRecordId: string) => Promise<FileDocument>;
+    /**
+     * Wraps a file descriptor into a {@link FileDocument} instance.
+     */
+    createDocumentFromFileDescriptor: (fd: FileDescriptor) => FileDocument;
+    /**
+     * Retrieves a {@link FileDocument} instance from the local cache by its identifier.
+     *
+     * **Legacy compatibility** — This method exists to address legacy behaviours where a
+     * `FileDocument` object could not be obtained through the standard asynchronous APIs
+     * (e.g. {@link searchFileDocuments}, {@link getConversationFileDocuments}).
+     * It performs a **synchronous** lookup against the in-memory document registry and
+     * should therefore only be used when the document is already known to be cached locally.
+     * Prefer the async APIs for any new development.
+     *
+     * @param fileDocumentId - The unique identifier of the file document to retrieve.
+     * @returns The matching {@link FileDocument}, or `undefined` if not found in the local cache.
+     */
+    getFileDocumentById: (fileDocumentId: string) => FileDocument;
+    /**
+     * Checks whether a given capability is available for a {@link FileDocument}.
+     *
+     * @param fileDocument - The file document to test.
+     * @param capability - The capability to check. Possible values:
+     *   - `FileDocumentCapabilities.THUMBNAILS` — whether a thumbnail preview can be generated.
+     *   - `FileDocumentCapabilities.SAVE` — whether the document can be saved locally.
+     *   - `FileDocumentCapabilities.TRANSFERT` — whether the document can be transferred.
+     * @returns `true` if the capability is supported for this document, `false` otherwise.
+     */
+    getFileDocumentCapability: (fileDocument: FileDocument, capability: FileDocumentCapabilities) => boolean;
+    /**
+     * Information about the connected external storage (OwnCloud/NextCloud), if any.
+     */
+    readonly externalStorage: FileDocumentExternalStorage | undefined;
+    /**
+     * Lists file documents from an external storage (OwnCloud/NextCloud) at the given path.
+     * Returns files and directory entries. Directories have `type === 'directory'`.
+     * @param options - Path, sort, filter options.
+     */
+    searchExternalStorageFileDocuments: (options?: FileDocumentExternalSearchOptions) => Promise<{
+        fileDocuments: FileDocument[];
+        allReceived: boolean;
+    }>;
+    /**
+     * Initiates the authentication flow for the connected external storage.
+     */
+    authenticateExternalStorage: () => Promise<void>;
+    /**
+     * Logs out from the connected external storage.
+     */
+    logoutExternalStorage: () => Promise<void>;
+}
+/** @internal */
+export declare class FileDocumentServiceRB extends Service implements FileDocumentService {
+    private logger;
+    private fileStorage;
+    private fileServer;
+    private eventSubject;
+    private subscriptions?;
+    private documents;
+    static getInstance(): FileDocumentServiceRB;
+    static build(): FileDocumentServiceRB;
+    private constructor();
+    start(): Promise<void>;
+    reconnect(): Promise<void>;
+    stop(): Promise<void>;
+    private attachEventHandler;
+    subscribe(handler: (event: RBEvent<FileDocumentServiceEvents>) => any, eventNames?: FileDocumentServiceEvents | FileDocumentServiceEvents[]): Subscription;
+    sendEvent(name: FileDocumentServiceEvents, data?: any): void;
+    createFileDocument(file: File): Promise<FileDocument>;
+    replaceFileDocumentContent(document: FileDocument, data: Blob): void;
+    createFileDocumentFromExisitingFileDescriptor(fd: FileDescriptor, file: File): Promise<FileDocument>;
+    hasEnoughSpace(document: FileDocument): boolean;
+    uploadDocument(document: FileDocument): Promise<FileDocument>;
+    downloadDocument(document: FileDocument): Promise<Blob>;
+    abortDocumentTransfert(document: FileDocument): Promise<FileDocument>;
+    copyDocument(document: FileDocument): Promise<FileDocument>;
+    deleteDocument(document: FileDocument): Promise<void>;
+    get consumption(): FileDocumentConsumptionData;
+    addDocumentViewer(document: FileDocument, viewer: User | Bubble): Promise<void>;
+    deleteDocumentViewer(document: FileDocument, viewer: User | Bubble): Promise<void>;
+    searchFileDocuments(searchOptions?: FileDocumentSearchOptions): Promise<FileDocument[]>;
+    createZipFromDocuments(zipName: string, documents: FileDocument[]): Promise<FileDocument>;
+    /**
+     * Builds a downloadable archive of a P2P call recording (audio + transcript/summary bundled server-side) via
+     * the dedicated call_record archive endpoint, and resolves with the archive FileDocument once it is ready.
+     */
+    createZipFromCallRecord(zipName: string, callRecordId: string): Promise<FileDocument>;
+    getConversationFileDocuments(conversation: Conversation): Promise<{
+        documents: FileDocument[];
+        complete: boolean;
+    }>;
+    getLocalUrl(fileDocument: FileDocument): Promise<string>;
+    getPublicUrl(fileDocument: FileDocument): Promise<string>;
+    getTextContent(fileDocument: FileDocument, noCache?: boolean): Promise<string>;
+    getJsonContent<T = any>(fileDocument: FileDocument): Promise<T>;
+    getFileDocumentCapability(fileDocument: FileDocument, capability: FileDocumentCapabilities): boolean;
+    getFileDescriptorUrl(fd: FileDescriptor): Promise<string>;
+    getFileDocumentById(fileDocumentId: string): FileDocument;
+    createDocumentFromFileDescriptor(fd: FileDescriptor): FileDocumentRB;
+    get externalStorage(): FileDocumentExternalStorage | undefined;
+    searchExternalStorageFileDocuments(options?: FileDocumentExternalSearchOptions): Promise<{
+        fileDocuments: FileDocument[];
+        allReceived: boolean;
+    }>;
+    authenticateExternalStorage(): Promise<void>;
+    logoutExternalStorage(): Promise<void>;
+}
+//# sourceMappingURL=fileDocument.service.d.ts.map

package/lib/services/fileDocument/fileDocument.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDocument.service.d.ts","sourceRoot":"","sources":["../../../src/services/fileDocument/fileDocument.service.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAEhE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAkB,MAAM,iCAAiC,CAAC;AACpF,OAAO,KAAK,EAAE,eAAe,EAA2B,MAAM,8BAA8B,CAAC;AAG7F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEzC,OAAO,KAAK,EAAE,YAAY,EAAE,iCAAiC,EAAE,2BAA2B,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAC/J,OAAO,EAAsB,cAAc,EAAoF,MAAM,iCAAiC,CAAC;AAIvK,oBAAY,wBAAwB;IAChC,UAAU,eAAe;IACzB,IAAI,SAAS;IACb,SAAS,cAAc;CAC1B;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,wBAAwB,CAAC;AAEtD;;;GAGG;AACH,oBAAY,yBAAyB;IACjC;;;OAGG;IACH,yBAAyB,8BAA8B;IAEvD;;;OAGG;IACH,wBAAwB,6BAA6B;IAErD;;;OAGG;IACH,wBAAwB,6BAA6B;IAErD;;;OAGG;IACH,sBAAsB,2BAA2B;IAEjD;;;OAGG;IACH,sBAAsB,2BAA2B;IAEjD;;;MAGE;IACF,iCAAiC,sCAAsC;CAC1E;AAED,MAAM,WAAW,2BAA4B,SAAQ,eAAe;IAChE,gBAAgB;IAChB,MAAM,CAAC,EAAE,GAAG,CAAC;CAChB;AACD,MAAM,WAAW,mBAAmB;IAEhC;;OAEG;IACH,WAAW,CAAC,EAAE,2BAA2B,CAAC;IAE1C;;;;OAIG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,yBAAyB,CAAC,KAAK,GAAG,EAAE,UAAU,CAAC,EAAE,yBAAyB,GAAG,yBAAyB,EAAE,KAAK,YAAY,CAAC;IAE/J;;;;OAIG;IACH,kBAAkB,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IAE1D;;;;OAIG;IACH,0BAA0B,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAEzE;;;;;OAKG;IACH,mBAAmB,EAAE,CAAC,OAAO,CAAC,EAAE,yBAAyB,KAAK,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAEtF;;;;;OAKG;IACH,4BAA4B,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,OAAO,CAAC;QAAE,SAAS,EAAE,YAAY,EAAE,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAC;KAAE,CAAC,CAAC;IAEzH;;;;;OAKG;IAEH;;;;;;;OAOG;IACH,sBAAsB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IAE9F;;OAEG;IACH,uBAAuB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IAE1F;;OAEG;IACH,gCAAgC,EAAE,CAAC,EAAE,EAAE,cAAc,KAAK,YAAY,CAAC;IAEvE;;;;;;;;;;;;OAYG;IACH,mBAAmB,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,YAAY,CAAC;IAE9D;;;;;;;;;OASG;IACH,yBAAyB,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,wBAAwB,KAAK,OAAO,CAAC;IAEzG;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,2BAA2B,GAAG,SAAS,CAAC;IAElE;;;;OAIG;IACH,kCAAkC,EAAE,CAAC,OAAO,CAAC,EAAE,iCAAiC,KAAK,OAAO,CAAC;QAAE,aAAa,EAAE,YAAY,EAAE,CAAC;QAAC,WAAW,EAAE,OAAO,CAAC;KAAE,CAAC,CAAC;IAEvJ;;OAEG;IACH,2BAA2B,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;OAEG;IACH,qBAAqB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9C;AAED,gBAAgB;AAChB,qBAAa,qBAAsB,SAAQ,OAAQ,YAAW,mBAAmB;IAC7E,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,WAAW,CAAwD;IAC3E,OAAO,CAAC,UAAU,CAAsD;IACxE,OAAO,CAAC,YAAY,CAAkG;IACtH,OAAO,CAAC,aAAa,CAAC,CAAiB;IACvC,OAAO,CAAC,SAAS,CAAoC;WAEvC,WAAW;WAIX,KAAK;IAInB,OAAO;IAIM,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIlC,OAAO,CAAC,kBAAkB;IA+CnB,SAAS,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,yBAAyB,CAAC,KAAK,GAAG,EAAE,UAAU,CAAC,EAAE,yBAAyB,GAAG,yBAAyB,EAAE,GAAG,YAAY;IAkB1J,SAAS,CAAC,IAAI,EAAE,yBAAyB,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI;IAItD,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAS3D,0BAA0B,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI;IAI9D,6CAA6C,CAAC,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC;IAQ1G,cAAc,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO;IAKzC,cAAc,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAc7D,gBAAgB,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAYvD,sBAAsB,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IASrE,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAa3D,cAAc,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAUlE,IAAW,WAAW,IAAI,2BAA2B,CAAkD;IAE1F,iBAAiB,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAa/E,oBAAoB,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYlF,mBAAmB,CAAC,aAAa,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAiBvF,sBAAsB,CAAC,OAAO,EAAE,MAAW,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IA6B3G;;;OAGG;IACU,uBAAuB,CAAC,OAAO,EAAE,MAAW,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAyB1F,4BAA4B,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,YAAY,EAAE,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAC;KAAE,CAAC;IAapH,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAIxD,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzD,cAAc,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAarF,cAAc,CAAC,CAAC,GAAG,GAAG,EAAE,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC;IAgBrE,yBAAyB,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,wBAAwB,GAAG,OAAO;IAK9F,oBAAoB,CAAC,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/D,mBAAmB,CAAC,cAAc,EAAE,MAAM,GAAG,YAAY;IAOzD,gCAAgC,CAAC,EAAE,EAAE,cAAc,GAAG,cAAc;IAQ3E,IAAW,eAAe,IAAI,2BAA2B,GAAG,SAAS,CAEpE;IAEY,kCAAkC,CAAC,OAAO,CAAC,EAAE,iCAAiC,GAAG,OAAO,CAAC;QAAE,aAAa,EAAE,YAAY,EAAE,CAAC;QAAC,WAAW,EAAE,OAAO,CAAC;KAAE,CAAC;IAiBlJ,2BAA2B,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5C,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;CAGtD"}

package/lib/services/fileDocument/index.d.ts

@@ -0,0 +1,5 @@
+export type { FileDocumentService, FileDocumentConsumptionData } from "./fileDocument.service";
+export { FileDocumentServiceEvents, FileDocumentCapabilities } from "./fileDocument.service";
+export type { FileDocumentExternalStorage, FileDocumentExternalSearchOptions } from "../../models/fileDocument.model";
+export { FileDocumentStorageType } from "../../models/fileDocument.model";
+//# sourceMappingURL=index.d.ts.map

package/lib/services/fileDocument/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/fileDocument/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAC/F,OAAO,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAC7F,YAAY,EAAE,2BAA2B,EAAE,iCAAiC,EAAE,MAAM,iCAAiC,CAAC;AACtH,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC"}

package/lib/services/files/fileDescriptorEventHandler.service.d.ts

@@ -0,0 +1,18 @@
+import type { XMLElements } from "../../utils/xmlParser";
+export declare class FileDescriptorEventHandlerService {
+    private mainService;
+    private logger;
+    private contactService;
+    private eventService;
+    private fileStorageService;
+    private fileServerService;
+    private p2pRecapService;
+    static create(): FileDescriptorEventHandlerService;
+    onManagementMessageReceived(stanza: any): boolean;
+    private manageArchiveFileReady;
+    private manageFileStanzaData;
+    manageThumbnailStanzaData(stanzaElem: XMLElements): Promise<void>;
+    private manageFileVscanStanzaData;
+    private manageFileTranslateStanzaData;
+}
+//# sourceMappingURL=fileDescriptorEventHandler.service.d.ts.map

package/lib/services/files/fileDescriptorEventHandler.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileDescriptorEventHandler.service.d.ts","sourceRoot":"","sources":["../../../src/services/files/fileDescriptorEventHandler.service.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAc,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAIpF,qBAAa,iCAAiC;IAC1C,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,kBAAkB,CAAqF;IAC/G,OAAO,CAAC,iBAAiB,CAAkF;IAC3G,OAAO,CAAC,eAAe,CAA4E;WAErF,MAAM,IAAI,iCAAiC;IAIlD,2BAA2B,CAAC,MAAM,EAAE,GAAG;YAoBhC,sBAAsB;IAYpC,OAAO,CAAC,oBAAoB;IAiJf,yBAAyB,CAAC,UAAU,EAAE,WAAW;IAyD9D,OAAO,CAAC,yBAAyB;YA4DnB,6BAA6B;CA6B9C"}

package/lib/services/files/fileServer.service.d.ts

@@ -0,0 +1,268 @@
+import type { FileDescriptor } from "../../models/common/fileDescriptor";
+import type { FileStorageExternalStorage } from "../../services/files/fileStorage.service";
+import { FileStorageCapabilities, FileStorageService } from "../../services/files/fileStorage.service";
+import { Service } from "../../services/service";
+export declare const FILE_SERVER_SVC = "FileServerService";
+/**
+ * Helper class to handle image URLs (to avoid memory issues)
+ * @class LocalImage
+ */
+export declare class LocalImage {
+    /**
+     * Image url to be use. e.g. in src attribute.
+     * @type {string}
+     * @memberof LocalImage
+     */
+    url: string;
+    /**
+     * {@link FileDescriptor} associated with this LocalImage
+     * @type {FileDescriptor}
+     * @memberof LocalImage
+     */
+    fd: FileDescriptor;
+    /**
+     * Method to be called to release the URL object created when instanciating the class
+     * @memberof LocalImage
+     */
+    release(): void;
+    /**
+     * Creates an instance of LocalImage.
+     * Note: Careful, a URL object is created so {@link release()} is to be called when object is no longer in use
+     * @param {FileDescriptor} fd image file descriptor
+     * @param {Blob} blob file blob
+     * @memberof LocalImage
+     */
+    constructor(fd: FileDescriptor, blob: Blob);
+}
+/**
+ * File server constraints (maxChunkSize, maxFileSize) for user
+ * @class FileServerCapabilities
+ */
+export interface FileServerCapabilities {
+    /**
+     * Threshold from which it's better for clients to follow a download strategy by chunk [octet]
+     */
+    maxChunkSizeDownload: number;
+    /**
+     * Threshold from which it's better for clients to follow an upload strategy by chunk [octet]
+     */
+    maxChunkSizeUpload: number;
+    /**
+     * Data related with the external fileserver used
+     */
+    externalStorage?: FileStorageExternalStorage;
+}
+export interface IFileServerService {
+    uploadAFileByChunk: (fileDescriptor: FileDescriptor, file: File) => Promise<any>;
+    uploadFile: (fileDescriptor: FileDescriptor) => Promise<FileDescriptor>;
+    updateFileVariant: (fileId: string, variant: string, content: string) => Promise<void>;
+}
+export declare class FileServerService extends Service implements IFileServerService {
+    readonly ONE_KILOBYTE = 1024;
+    readonly ONE_MEGABYTE: number;
+    readonly ONE_GIGABYTE: number;
+    readonly FILE_RANGE: number;
+    readonly PARALLEL_REQUEST_NB = 10;
+    private _started;
+    get started(): boolean;
+    set started(value: boolean);
+    private serviceStatusSubject;
+    private portalURL;
+    private fileMessageHandlerRef;
+    private fileDescriptorEventHandler;
+    private thumbnailPromises;
+    private thumbnailPreviewPromises;
+    private cache;
+    private authService;
+    private xmppService;
+    private logger;
+    private fileStorageService;
+    private errorHelperService;
+    private centralizedService;
+    private mainService;
+    capabilities: FileServerCapabilities;
+    static getInstance(): FileServerService;
+    static build(): FileServerService;
+    private constructor();
+    private waitTillStarted;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    reconnect(): void;
+    attachHandlers(): void;
+    private removeHandlers;
+    /**
+     * Get a "public URL" for a given {@link FileDescriptor} (API request to {@link https://api.openrainbow.org/filestorage/#api-files_server_download-files_getFileTemporaryURL Rainbow File Storage portal - files server download - 2 - Get backend temporary URL})
+     * @param {FileDescriptor} fileDescriptor for which we want to retrieve a public URL
+     * @returns {Promise<string>} Resolves with the public url
+     * @memberof FileServerService
+     */
+    getFileDescriptorPublicUrl(fileDescriptor: FileDescriptor, variant?: string): Promise<string>;
+    /**
+     * Update the content of a file variant in place. P2P call-record sub-files (summary/transcription/...) have no
+     * own descriptor: they are addressed by the parent file id + `variant`.
+     */
+    updateFileVariant(fileId: string, variant: string, content: string): Promise<void>;
+    /**
+     * Method creates an URL for a given fileDescriptor
+     * @param {FileDescriptor} fileDescriptor for which we retrieve the URL
+     * @param {boolean} [thumbnail] whether it is the thumbnail that is requested
+     * @param {boolean} [cacheEnabled] whether to use cache or not
+     * @returns {Promise<string>} resolves with the URL
+     * @memberof FileServerService
+     */
+    getFileDescriptorUrl(fileDescriptor: FileDescriptor, thumbnail?: boolean, cacheEnabled?: boolean): Promise<string>;
+    /**
+     * Removes a given {@link FileDescriptor} from cache
+     * @param {FileDescriptor} fileDescriptor to be removed from cache
+     * @memberof FileServerService
+     */
+    removeFileDescriptorFromCache(fileDescriptor: FileDescriptor): void;
+    /**
+     * Clears the RainbowImageCache
+     * @memberof FileServerService
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Method retrieve the {@link LocalImage} of a given file
+     * @param {string} fileDescriptorId ID of file
+     * @param {boolean} thumbnail whether we want to retrieve the thumbnail
+     * @param {boolean} [forced] whether we want to force a server request
+     * @returns {Promise<LocalImage>} resolves with the {@link LocalImage}
+     * @memberof FileServerService
+     */
+    getLocalImage(fileDescriptorId: string, thumbnail: boolean, forced?: boolean): Promise<LocalImage>;
+    private getLargeBlobThumbnail;
+    /**
+     * Method used to get partial data from server
+     * @param {FileDescriptor} fileDescriptor of file to retrieve
+     * @param {string} url to use for download
+     * @param {number} minRange minRange for download operation
+     * @param {number} maxRange maxRange for download operation
+     * @param {number} index of partial request
+     * @param {boolean} __cancelable cancellable request ?
+     * @param {number} currentLoadingRef some kind  of graphical stuff
+     * @returns {Promise<{}>} resolves when partial data's download is complete
+     * @memberof FileServerService
+     */
+    private getPartialDataFromServer;
+    getFileStorageService(): FileStorageService;
+    /**
+     * Retrieve Blob of thumbnail preview of a given file descriptor
+     * @param {FileDescriptor} fileDescriptor for which we retrieve the blob
+     * @returns {Promise<Blob>} resolves with the blob
+     * @memberof FileServerService
+     */
+    private getBlobThumbnailPreviewFromFileDescriptor;
+    /**
+     * Retrieve Blob of thumbnail of a given file descriptor
+     * @param {FileDescriptor} fileDescriptor for which we retrieve the blob
+     * @returns {Promise<Blob>} resolves with the blob
+     * @memberof FileServerService
+     */
+    getBlobThumbnailFromFileDescriptor(fileDescriptor: FileDescriptor): Promise<Blob>;
+    /**
+     * Helper method to call getPartialDataFromServer and handle its response
+     * @private
+     * @param {FileDescriptor} fileDescriptor of file to retrieve
+     * @param {string} url to use for download
+     * @param {number} minRange minRange for download operation
+     * @param {number} maxRange maxRange for download operation
+     * @param {number} index of partial request
+     * @param {boolean} cancelable cancellable request ?
+     * @param {number} currentLoadingRef some kind  of graphical stuff
+     * @param {any[]} blobArray to fill with response
+     * @param {Function} [actionOnPartialResponse] what to do when partial response is received
+     * @returns {*}  {Promise<any>}
+     * @memberof FileServerService
+     */
+    private callAndProcessGetPartialDataFromServer;
+    /**
+     * Method retrieve the blob of a given file descriptor
+     * @param {FileDescriptor} fileDescriptor whose blob we want to retrieve
+     * @param {boolean} [cancelable] whether action is ancellable
+     * @param {Function} [actionOnPartialResponse] what to do when partial response is received
+     * @returns {Promise<Blob>} resolves with the retieved blob
+     * @memberof FileServerService
+     */
+    getBlobFromFileDescriptor(fileDescriptor: FileDescriptor, cancelable?: boolean, actionOnPartialResponse?: Function): Promise<Blob>;
+    /**
+     * Write the given blob's ArrayBuffer to fileDescriptor
+     * @param {FileDescriptor} fd to fill
+     * @param {ArrayBuffer[]} blobArray of data to write
+     * @returns {void}
+     * @memberof FileServerService
+     */
+    private writeAvailableChunksInDisk;
+    /**
+     * Method creates blob from a file retrieved from server
+     * @param {string} url server url for request
+     * @param {FileDescriptor} fileDescriptor for which we retrieve the blob
+     * @returns {Promise<Blob>} resolves with the Blob created from data received from server
+     * @memberof FileServerService
+     */
+    getBlobFileDescriptorFromUrl(url: string, fileDescriptor: FileDescriptor): Promise<Blob>;
+    /**
+     * Method retrieves an URL object from an url
+     * @param {string} id [required] the ID of the image file
+     * @returns {Promise<any>} Object containing the orientation and the Object URL
+     * @memberof FileServerService
+     */
+    getBlobUrlAndOrientationByFileDescriptorId(id: string): Promise<any>;
+    /**
+     * Method to read EXIF data for image to extract the orientation and store it
+     * @param {FileDescriptor} fileDescriptor of image to read
+     * @param {Blob} blob of file to analyze
+     * @returns {Promise<any>} : return the orientation value if available
+     */
+    setImageOrientationForFileDescriptor(fileDescriptor: FileDescriptor, blob: Blob): Promise<any>;
+    /**
+     * Builds the context of an upload that was aborted after a part failed, so the log line that ends the
+     * transfer carries everything needed to find the request again in the server logs.
+     * @param {FileDescriptor} fileDescriptor of the file being uploaded
+     * @param {UploadPartError} error rejected by the failing part
+     * @returns {string} file id, size, number of parts, http status and x-rainbow-request-id when known
+     * @memberof FileServerService
+     */
+    private formatUploadFailure;
+    /**
+     * Method sends data to server using range request mecanism (RFC7233)
+     * Note: this implementation uses XMLHttpRequest, not fetch, because fetch cannot report upload progress.
+     * It therefore bypasses the window.fetch interceptor of MainService, so the Rainbow identification
+     * headers and the SEND/RECV traces are applied by this method itself.
+     * @param {UploadRequestData} uploadRequestData to be sent
+     * @returns {Promise<{}>} file descriptor data received as response from server or http error response
+     * @memberof FileServerService
+     */
+    private sendPartialDataToServer;
+    /**
+     * Method to upload a file by chunk
+     * @param {FileDescriptor} fileDescriptor of file to upoad
+     * @param {File} file to upload
+     * @returns {Promise<any>} resolves with the fileDescriptor uploaded
+     * @memberof FileServerService
+     */
+    uploadAFileByChunk(fileDescriptor: FileDescriptor, file: File): Promise<any>;
+    /**
+     * Method to upload a file
+     * @param {FileDescriptor} fileDescriptor of file to upload . Note: attribute "fileToSend" of fileDescriptor will be uploaded
+     * @returns {Promise<any>} resolves with the fileDescriptor uploaded
+     * @memberof FileServerService
+     */
+    uploadFile(fileDescriptor: FileDescriptor): Promise<FileDescriptor>;
+    /**
+     * Method cancels the transfer for a given fileDescriptor
+     * @param {string} fileDescriptorId ID of fileDescriptor transfer to cancel
+     * @memberof FileServerService
+     */
+    cancelCurrentFiletransfer(fileDescriptorId: string): void;
+    /**
+     * This API advice client about file server constraints (maxChunkSize, maxFileSize). (API request to {@link https://api.openrainbow.org/filestorage/#api-files_server_capabilities Rainbow File Storage portal - files server capabilities - Capabilities})
+     * @description
+     *      Method retrieves user quota (capabilities) for user
+     * @returns {Promise<FileServerCapabilities>} resolves with a {@link FileServerCapabilities} object
+     * @memberof FileServerService
+     */
+    getServerCapabilities(): Promise<FileServerCapabilities>;
+    getFileDescriptorCapability(fileDescriptor: FileDescriptor, capability: FileStorageCapabilities): boolean;
+}
+//# sourceMappingURL=fileServer.service.d.ts.map

package/lib/services/files/fileServer.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileServer.service.d.ts","sourceRoot":"","sources":["../../../src/services/files/fileServer.service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mDAAmD,CAAC;AAMxF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,yDAAyD,CAAC;AAC1G,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,yDAAyD,CAAC;AAKtH,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAIhE,eAAO,MAAM,eAAe,sBAAsB,CAAC;AA4BnD;;;GAGG;AACH,qBAAa,UAAU;IACnB;;;;OAIG;IACI,GAAG,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACI,EAAE,EAAE,cAAc,CAAC;IAE1B;;;OAGG;IACI,OAAO,IAAI,IAAI;IAEtB;;;;;;OAMG;gBACS,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI;CAI7C;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE,0BAA0B,CAAC;CAChD;AAED,MAAM,WAAW,kBAAkB;IAC/B,kBAAkB,EAAE,CAAC,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACjF,UAAU,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IACxE,iBAAiB,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1F;AAED,qBAAa,iBAAkB,SAAQ,OAAQ,YAAW,kBAAkB;IACxE,QAAQ,CAAC,YAAY,QAAQ;IAC7B,QAAQ,CAAC,YAAY,SAAe;IACpC,QAAQ,CAAC,YAAY,SAAsB;IAC3C,QAAQ,CAAC,UAAU,SAAyB;IAC5C,QAAQ,CAAC,mBAAmB,MAAM;IAElC,OAAO,CAAC,QAAQ,CAAkB;IAClC,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,IAAW,OAAO,CAAC,KAAK,EAAE,OAAO,EAGhC;IAED,OAAO,CAAC,oBAAoB,CAA4C;IACxE,OAAO,CAAC,SAAS,CAAuE;IACxF,OAAO,CAAC,qBAAqB,CAAM;IACnC,OAAO,CAAC,0BAA0B,CAAoC;IACtE,OAAO,CAAC,iBAAiB,CAAuB;IAChD,OAAO,CAAC,wBAAwB,CAAuB;IACvD,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,kBAAkB,CAAwD;IAClF,OAAO,CAAC,kBAAkB,CAAwD;IAClF,OAAO,CAAC,kBAAkB,CAAa;IACvC,OAAO,CAAC,WAAW,CAA0C;IAGtD,YAAY,EAAE,sBAAsB,CAIrC;WAEQ,WAAW;WAIX,KAAK;IAInB,OAAO;YAEO,eAAe;IAUhB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAwBtB,IAAI;IAMV,SAAS,IAAI,IAAI;IAIjB,cAAc;IAYrB,OAAO,CAAC,cAAc;IAKtB;;;;;OAKG;IACU,0BAA0B,CAAC,cAAc,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA8D1G;;;OAGG;IACU,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAe/F;;;;;;;OAOG;IACU,oBAAoB,CAAC,cAAc,EAAE,cAAc,EAAE,SAAS,GAAE,OAAe,EAAE,YAAY,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IA0C7I;;;;OAIG;IACI,6BAA6B,CAAC,cAAc,EAAE,cAAc;IAOnE;;;OAGG;IACU,UAAU;IASvB;;;;;;;OAOG;IACU,aAAa,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAE,OAAc,GAAG,OAAO,CAAC,UAAU,CAAC;YA6BvG,qBAAqB;IAKnC;;;;;;;;;;;OAWG;YACW,wBAAwB;IAwD/B,qBAAqB;IAE5B;;;;;OAKG;YACW,yCAAyC;IA+BvD;;;;;OAKG;IACU,kCAAkC,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAqD9F;;;;;;;;;;;;;;OAcG;YACW,sCAAsC;IA+BpD;;;;;;;OAOG;IACU,yBAAyB,CAAC,cAAc,EAAE,cAAc,EAAE,UAAU,GAAE,OAAc,EAAE,uBAAuB,GAAE,QAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAiJ3J;;;;;;OAMG;YACW,0BAA0B;IAyBxC;;;;;;OAMG;IACU,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IA6FrG;;;;;OAKG;IACU,0CAA0C,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA8BjF;;;;;OAKG;IACU,oCAAoC,CAAC,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC;IA8C3G;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAM3B;;;;;;;;OAQG;YACW,uBAAuB;IA2HrC;;;;;;OAMG;IACU,kBAAkB,CAAC,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC;IAqFzF;;;;;OAKG;IACU,UAAU,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAuFhF;;;;OAIG;IACI,yBAAyB,CAAC,gBAAgB,EAAE,MAAM;IAgBzD;;;;;;OAMG;IACU,qBAAqB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAsB9D,2BAA2B,CAAC,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,uBAAuB,GAAG,OAAO;CAWnH"}