@luminocity/lemonate-gateway 8.2.3 → 8.2.5

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import moment from 'moment';
+import * as axios from 'axios';
 import { AxiosInstance, ResponseType } from 'axios';
 import WebSocket from 'isomorphic-ws';
 import FormData from 'form-data';
@@ -613,7 +614,7 @@ type BaseBlogArticle = {
     tags: string[];
     slug?: string;
 };
-type ProgressCallback = (percent: number, loaded: number, total: number | undefined) => void;
+type ProgressCallback$1 = (percent: number, loaded: number, total: number | undefined) => void;
 type ConversationEntry = {
     _id: string;
     text: string;
@@ -1568,7 +1569,7 @@ declare class ApiClient extends EventEmitter {
     execute(method: string, resource: string, data?: unknown, options?: Partial<{
         responseType: ResponseType;
         withNext: boolean;
-        progressCallback?: ProgressCallback;
+        progressCallback?: ProgressCallback$1;
         emitOnSuccess: string;
         headers: {
             [key: string]: string;
@@ -1921,14 +1922,14 @@ declare class ApiClient extends EventEmitter {
      * @param {Function} [progressCallback] - Download progress callback.
      * @returns {Promise<Blob>} The downloaded item.
      */
-    downloadItem(id: string, progressCallback?: ProgressCallback): Promise<any>;
+    downloadItem(id: string, progressCallback?: ProgressCallback$1): Promise<any>;
     /**
      * Download a public item by ID.
      * @param {string} id - The item ID.
      * @param {Function} [loadingProgressFunc] - Download progress callback.
      * @returns {Promise<Blob>} The downloaded item.
      */
-    publicDownloadItem(id: any, loadingProgressFunc?: ProgressCallback): Promise<any>;
+    publicDownloadItem(id: any, loadingProgressFunc?: ProgressCallback$1): Promise<any>;
     /**
      * Get the hash of an item by ID.
      * @param {string} id - The item ID.
@@ -1958,7 +1959,7 @@ declare class ApiClient extends EventEmitter {
      * @param {AbortController} [controller] - Abort controller for the request.
      * @returns {Promise<Object>} The response.
      */
-    uploadThumbnail(id: string, size: number, bufferOrFile: any, filename?: string, progressCallback?: ProgressCallback, controller?: AbortController): Promise<any>;
+    uploadThumbnail(id: string, size: number, bufferOrFile: any, filename?: string, progressCallback?: ProgressCallback$1, controller?: AbortController): Promise<any>;
     /**
      * Get a public thumbnail for an item.
      * @param {string} size - The thumbnail size.
@@ -2023,7 +2024,7 @@ declare class ApiClient extends EventEmitter {
      * @param {AbortController} [controller] - Abort controller for the request.
      * @returns {Promise<Object>} The created item.
      */
-    uploadAndCreate(folderId: string, data: any, filename: string, options: any, progressCallback?: ProgressCallback, controller?: AbortController): Promise<any>;
+    uploadAndCreate(folderId: string, data: any, filename: string, options: any, progressCallback?: ProgressCallback$1, controller?: AbortController): Promise<any>;
     /**
      * Upload a file to an existing item.
      * @param itemId - The item ID.
@@ -2034,7 +2035,7 @@ declare class ApiClient extends EventEmitter {
      * @param [options.omitHandleDependencyChange] - If true, will not cause previews and thumbnails to rerender
      * @param [options.keepThumbnails] - If true, will not remove thumbnails to be rerendered
      */
-    upload(itemId: string, bufferOrFile: Buffer | File | Blob | string, filename: string, progressCallback?: ProgressCallback, controller?: AbortController, options?: {
+    upload(itemId: string, bufferOrFile: Buffer | File | Blob | string, filename: string, progressCallback?: ProgressCallback$1, controller?: AbortController, options?: {
         omitHandleDependencyChange?: boolean;
         keepThumbnails?: boolean;
     }): Promise<void>;
@@ -2071,7 +2072,7 @@ declare class ApiClient extends EventEmitter {
      * @param {Function} [progressCallback] - Download progress callback.
      * @returns {Promise<Blob>} The downloaded attachment.
      */
-    downloadAttachmentPOP(id: string, name: string, queryParam?: number, index?: number, progressCallback?: ProgressCallback): Promise<any>;
+    downloadAttachmentPOP(id: string, name: string, queryParam?: number, index?: number, progressCallback?: ProgressCallback$1): Promise<any>;
     _getAttachmentUrlPath(id: string, name: string, queryParam?: number, index?: number, isPublic?: boolean): string;
     /**
      * Download attachment
@@ -2082,7 +2083,7 @@ declare class ApiClient extends EventEmitter {
      * @param [progressCallback] - Download progress callback.
      * @returns The attachment data.
      */
-    downloadAttachment(id: string, name: string, queryParam?: number, index?: number, progressCallback?: ProgressCallback): Promise<{
+    downloadAttachment(id: string, name: string, queryParam?: number, index?: number, progressCallback?: ProgressCallback$1): Promise<{
         blob: Blob;
     }>;
     /**
@@ -2094,7 +2095,7 @@ declare class ApiClient extends EventEmitter {
      * @param {Function} [progressCallback] - Download progress callback.
      * @returns {Promise<Blob>} The downloaded attachment.
      */
-    downloadPublicAttachment(id: string, name: string, queryParam?: number, index?: number, progressCallback?: ProgressCallback): Promise<any>;
+    downloadPublicAttachment(id: string, name: string, queryParam?: number, index?: number, progressCallback?: ProgressCallback$1): Promise<any>;
     /**
      * Upload an attachment to an item. This endpoint needs admin permissions.
      * @param {string} id - Id of the item to attach the file to
@@ -2107,7 +2108,7 @@ declare class ApiClient extends EventEmitter {
      * @param {AbortController} [controller] - Abort controller for the request.
      * @return {Promise<Object>}
      */
-    uploadAttachment(id: string, name: string, queryParam?: number, index?: number, bufferOrFile?: any, filename?: string, progressCallback?: ProgressCallback, controller?: AbortController): Promise<any>;
+    uploadAttachment(id: string, name: string, queryParam?: number, index?: number, bufferOrFile?: any, filename?: string, progressCallback?: ProgressCallback$1, controller?: AbortController): Promise<any>;
     /**
      * Invalidates attachment in attachmentCache and then deletes attachment
      * @param {string} id - The item ID.
@@ -4088,6 +4089,12 @@ declare namespace Package {
   export type { Package_MetadataItem as MetadataItem };
 }
 
+type ProgressCallback = (progressInfo: {
+    phase: string;
+    percent: number;
+    bytesTotal: number;
+    bytesLoaded: number;
+}) => void;
 declare class ItemRepo {
     apiClient: ApiClient;
     activeItem: PreparedItem | undefined;
@@ -4131,7 +4138,7 @@ declare class ItemRepo {
     createNewScript(parent: Block, index: number | undefined, ownerItem: PreparedItem): Script;
     removeScript(script: Script, parent: Block): void;
     findBlock(id: string): Block | null;
-    loadPackage(url: string): Promise<PreparedItem>;
+    loadPackage(url: string, progressCallback?: ProgressCallback): Promise<PreparedItem>;
     createPackageItemUrl(itemId: string): string | null;
     revokePackageItemUrl(url: string): void;
     _loadPackageContentRecursively(item: any, reportProgressFunc: Function): Promise<PreparedItem[]>;
@@ -4325,6 +4332,10 @@ declare const _default: {
      * @param {{minS?:number, maxS?:number, minL?:number, maxL?:number, return?:'hex'|'hsl'|'rgb'}} [opts]
      */
     colorFromString(str: string, opts?: any): string;
+    downloadFile(url: string, progressCallback?: (percent: number, bytesTotal: number, bytesLoaded: number) => void): Promise<axios.AxiosResponse<any, any> | {
+        data: Blob;
+        mimeType: string;
+    }>;
 };
 
 declare class ProfilerEntry {
@@ -12432,4 +12443,4 @@ declare class CustomField extends Snapshotable {
 }
 
 export { AccessDeniedException, AggregatedItem, ApiClient, ApiGateway, Block, CustomField, EventEmitter, Field, InvalidArgumentException, InvalidStateException, Item, ItemCache$1 as ItemCache, ItemRepo, ItemVisibility, LinkableItemsCache, LoaderException, Package as PackageTools, PreparedItem, Profiler, Proxifier, ProxyEvent, QuotaExceededException, Script, ScriptField, Snapshot, Storage, Template, TemplateFactory, ThumbCache, UndoManager, eventBus, getDatatypeByName, getDatatypes, hasPermission, profileAsyncBlock, profileBlock, _default as tools, verifyAcl };
-export type { Acl, Attachments, BaseBlogArticle, ConversationEntry, CustomFieldDefinition, FolderListingOptions, FolderListingWithOptions, ItemOptions, ItemQueryOptions, ItemQueryWithOptions, ItemWithOptions, JobState, Me, ProgressCallback, UserInfo };
+export type { Acl, Attachments, BaseBlogArticle, ConversationEntry, CustomFieldDefinition, FolderListingOptions, FolderListingWithOptions, ItemOptions, ItemQueryOptions, ItemQueryWithOptions, ItemWithOptions, JobState, Me, ProgressCallback$1 as ProgressCallback, UserInfo };