@univerjs-pro/exchange-client 0.5.0-nightly.202411121606 → 0.5.0-nightly.202411141606

package/lib/types/index.d.ts

@@ -1,483 +1,10 @@
-import { default as default_2 } from 'react';
-import { Disposable as Disposable_2 } from '@univerjs/core';
-import { HTTPService } from '@univerjs/network';
-import { IConfigService } from '@univerjs/core';
-import { IdentifierDecorator } from '@wendellhu/redi';
-import { IDisposable } from '@univerjs/core';
-import { IDocumentData } from '@univerjs/core';
-import { IDocumentMeta } from '@univerjs/protocol';
-import { IError } from '@univerjs/protocol';
-import { ILogService } from '@univerjs/core';
-import { IMessageService } from '@univerjs/ui';
-import { Injector } from '@univerjs/core';
-import { ISheetBlock } from '@univerjs/protocol';
-import { ISnapshot } from '@univerjs/protocol';
-import { IUniverInstanceService } from '@univerjs/core';
-import { IWorkbookData } from '@univerjs/core';
-import { IWorkbookMeta } from '@univerjs/protocol';
-import { IWorksheetMeta } from '@univerjs/protocol';
-import { LocaleService } from '@univerjs/core';
-import { Observable } from 'rxjs';
-import { Plugin as Plugin_2 } from '@univerjs/core';
-import { UniverInstanceType } from '@univerjs/core';
-import { UniverType } from '@univerjs/protocol';
-
-/**
- * Triggers a download of a given File object.
- *
- * @param {File} file - The File object to be downloaded.
- */
-export declare function downloadFile(file: File | Blob, filename: string, fileExt: string): void;
-
-/** @deprecated Will be removed in the 0.2.19 release */
-export declare const EXCHANGE_EXPORT_SERVER_URL_KEY = "EXCHANGE_EXPORT_SERVER_URL_KEY";
-
-/** @deprecated Will be removed in the 0.2.19 release */
-export declare const EXCHANGE_GET_TASK_SERVER_URL_KEY = "EXCHANGE_GET_TASK_SERVER_URL_KEY";
-
-/** @deprecated Will be removed in the 0.2.19 release */
-export declare const EXCHANGE_IMPORT_SERVER_URL_KEY = "EXCHANGE_IMPORT_SERVER_URL_KEY";
-
-/** @deprecated Will be removed in the 0.2.19 release */
-export declare const EXCHANGE_SIGN_URL_SERVER_URL_KEY = "EXCHANGE_SIGN_URL_SERVER_URL_KEY";
-
-/** @deprecated Will be removed in the 0.2.19 release */
-export declare const EXCHANGE_UPLOAD_FILE_SERVER_URL_KEY = "EXCHANGE_UPLOAD_FILE_SERVER_URL_KEY";
-
-export declare class ExchangeOperateService extends Disposable_2 implements IExchangeOperateService, IDisposable {
-    private _univerInstanceService;
-    private readonly _messageService;
-    private readonly _localeService;
-    private readonly _exchangeService;
-    private readonly _uploadNotificationService;
-    protected readonly _logService: ILogService;
-    private _interrupted;
-    private readonly _progress$;
-    readonly progress$: Observable<IUploadProgress>;
-    private _totalUploadTaskCount;
-    private _doneUploadTaskCount;
-    constructor(_univerInstanceService: IUniverInstanceService, _messageService: IMessageService, _localeService: LocaleService, _exchangeService: ExchangeService, _uploadNotificationService: UploadNotificationService, _logService: ILogService);
-    interrupt(): void;
-    uploadFileToUnitId(types: UniverType[]): Promise<{
-        unitId: string;
-        type: UniverType;
-    } | undefined>;
-    importDOCXToUnitId(): Promise<string | undefined>;
-    importDOCXToSnapshot(): Promise<void>;
-    exportDOCXByUnitId(unitId?: string, unitName?: string, unitType?: UniverInstanceType): Promise<void>;
-    exportDOCXBySnapshot(): Promise<void>;
-    importXLSXToUnitId(): Promise<string | undefined>;
-    importXLSXToSnapshot(): Promise<void>;
-    exportXLSXByUnitId(unitId?: string, unitName?: string): Promise<void>;
-    exportXLSXBySnapshot(): Promise<void>;
-    registerLink(getLink: (unitId: string, univerType: UniverInstanceType) => string): void;
-    private _importFileToUnitId;
-    private _getUnitID;
-    private _getUnitName;
-    private _getUnitJson;
-    /**
-     * Get unit link /?unit={unitId}&type=2
-     * @param unitId
-     * @param type
-     * @returns
-     */
-    private _getLinkByUnitId;
-    private _refresh;
-    private _showNetworkError;
-    private _showDownloadMessage;
-    private _showUploadMessage;
-    private _emitProgress;
-    private _addTotalCount;
-    private _addDoneTask;
-    private _completeProgress;
-    private _clearProgress;
-}
-
-export declare class ExchangeService extends Disposable_2 implements IExchangeService, IDisposable {
-    private readonly _configService;
-    private readonly _requestService;
-    private readonly _requestState$;
-    readonly requestState$: Observable<IRequestState>;
-    constructor(_configService: IConfigService, _requestService: RequestService);
-    dispose(): void;
-    importDOCXToSnapshot(file: File | string): Promise<IDocumentData | undefined>;
-    exportDOCXByUnitId(unitId: string): Promise<File | undefined>;
-    exportDOCXBySnapshot(snapshot: IDocumentData): Promise<File | undefined>;
-    importXLSXToSnapshot(file: File | string): Promise<IWorkbookData | undefined>;
-    exportXLSXByUnitId(unitId: string): Promise<File | undefined>;
-    exportXLSXBySnapshot(data: IWorkbookData): Promise<File | undefined>;
-    importFileToUnitId(file: File | string, univerType: UniverType): Promise<string | undefined>;
-    private _importToSnapshot;
-    /**
-     * Export file by snapshot
-     * @param snapshot
-     * @param univerType
-     * @returns
-     */
-    private _exportBySnapshot;
-    private _export;
-    private _upload;
-    private _import;
-    private _signUrl;
-    private _getDownloadEndpointURL;
-}
-
-export declare function getUniverTypeByFile(file: File): UniverType.UNIVER_UNKNOWN | UniverType.UNIVER_DOC | UniverType.UNIVER_SHEET | UniverType.UNIVER_SLIDE;
-
-export declare function getUploadFile(types: UniverType[], multiple?: boolean): Promise<FileList | null>;
-
-declare interface IDocumentMetaJson extends Omit<IDocumentMeta, 'originalMeta'> {
-    originalMeta: string;
-}
-
-export declare interface IExchangeOperateService {
-    interrupt(): void;
-    /**
-     * Upload file to server, get unitId and open unit
-     * @param file
-     */
-    importXLSXToUnitId(): Promise<string | undefined>;
-    /**
-     * Upload xlsx file to server, get snapshot and refresh current sheet
-     * @param file
-     */
-    importXLSXToSnapshot(): Promise<void>;
-    /**
-     * Export xlsx file by unitId
-     * @returns
-     */
-    exportXLSXByUnitId(unitId?: string, unitName?: string, unitType?: UniverInstanceType): Promise<void>;
-    /**
-     * Export xlsx file by snapshot
-     * @returns
-     */
-    exportXLSXBySnapshot(): Promise<void>;
-    /**
-     * Upload file to server, get unitId and open unit
-     * @param file
-     */
-    importDOCXToUnitId(): Promise<string | undefined>;
-    /**
-     * Upload docx file to server, get snapshot and refresh current doc
-     * @param file
-     */
-    importDOCXToSnapshot(): Promise<void>;
-    /**
-     * Export docx file by unitId
-     * @returns
-     */
-    exportDOCXByUnitId(unitId?: string, unitName?: string, unitType?: UniverType): Promise<void>;
-    /**
-     * Export docx file by snapshot
-     * @returns
-     */
-    exportDOCXBySnapshot(): Promise<void>;
-    /**
-     * Upload file, supports multiple types
-     * @param file
-     */
-    uploadFileToUnitId(types: UniverType[]): Promise<{
-        unitId: string;
-        type: UniverType;
-    } | undefined>;
-    /**
-     * Customize the imported Unit URL format according to the needs of your own scene
-     * @param getLink
-     */
-    registerLink(getLink: (unitId: string, univerType: UniverInstanceType) => string): void;
-    /**
-     * Observable of upload progress
-     */
-    progress$: Observable<IUploadProgress>;
-}
-
-export declare const IExchangeOperateService: IdentifierDecorator<IExchangeOperateService>;
-
-export declare interface IExchangeService {
-    requestState$: Observable<IRequestState>;
-    /**
-     * Import XLSX file to workbook data
-     * @param file
-     */
-    importXLSXToSnapshot(file: File | string): Promise<IWorkbookData | undefined>;
-    /**
-     * Export XLSX file by unit id
-     * @param unitId
-     */
-    exportXLSXByUnitId(unitId: string): Promise<File | undefined>;
-    /**
-     * Export XLSX file by workbook data
-     * @param data
-     * @returns
-     */
-    exportXLSXBySnapshot(snapshot: IWorkbookData): Promise<File | undefined>;
-    /**
-     * Import DOCX file to document data
-     * @param file
-     */
-    importDOCXToSnapshot(file: File | string): Promise<IDocumentData | undefined>;
-    /**
-     * Export DOCX file by unit id
-     * @param unitId
-     */
-    exportDOCXByUnitId(unitId: string): Promise<File | undefined>;
-    /**
-     * Export DOCX file by document data
-     * @param data
-     * @returns
-     */
-    exportDOCXBySnapshot(snapshot: IDocumentData): Promise<File | undefined>;
-    /**
-     * Import file to unit id
-     * @param file
-     * @param univerType
-     */
-    importFileToUnitId(file: File | string, univerType: UniverType): Promise<string | undefined>;
-}
-
-export declare const IExchangeService: IdentifierDecorator<IExchangeService>;
-
-declare interface IExportRequest {
-    /** if unitID is specified, the input is the unit in the database */
-    unitID: string;
-    /** if jsonID is specified, the input is the json file which represents a univer unit */
-    jsonID: string;
-    type: UniverType;
-}
-
-declare interface IExportResponse {
-    error: IError | undefined;
-    taskID: string;
-}
-
-declare interface IExportTaskResult {
-    fileID: string;
-    fileUrl: string;
-}
-
-declare interface IFileUploadResponse {
-    FileId: string;
-    error: IError;
-}
-
-declare interface IGetTaskResponse {
-    error: IError | undefined;
-    taskID: string;
-    status: string;
-    import?: IImportTaskResult | undefined;
-    export?: IExportTaskResult | undefined;
-}
-
-declare interface IImportRequest {
-    fileID: string;
-    type: UniverType;
-    outputType: ImportOutputType;
-    /** not supported yet */
-    fileUrl: string;
-}
-
-declare interface IImportResponse {
-    taskID: string;
-    error: IError;
-}
-
-declare interface IImportTaskResult {
-    outputType: ImportOutputType;
-    unitID: string;
-    jsonID: string;
-}
-
-declare interface ILinkList {
-    link: string;
-    name: string;
-    type: UniverType;
-}
-
-declare enum ImportOutputType {
-    UNDEFINED = 0,
-    /** UNIT - Import to univer unit, unit is store in the database */
-    UNIT = 1,
-    /** JSON - Import and convert to a json file which represents a univer unit, not store in the database */
-    JSON = 2,
-    UNRECOGNIZED = -1
-}
-
-export declare interface IRequestService {
-    upload(file: File | string): Promise<IFileUploadResponse | undefined>;
-    import(importRequest: IImportRequest): Promise<IImportResponse | undefined>;
-    export(exportRequest: IExportRequest): Promise<IExportResponse | undefined>;
-    getTask(taskID: string): Promise<IGetTaskResponse | undefined>;
-    signUrl(fileID: string): Promise<ISignUrlResponse | undefined>;
-}
-
-export declare const IRequestService: IdentifierDecorator<IRequestService>;
-
-declare interface IRequestState {
-    error: IError | undefined;
-    state: RequestState;
-}
-
-declare interface ISheetBlockData extends Omit<ISheetBlock, 'data'> {
-    data: string;
-}
-
-declare interface ISheetBlockJson {
-    [key: string]: Partial<ISheetBlockData>;
-}
-
-declare interface ISignUrlResponse {
-    error: IError | undefined;
-    url: string;
-}
-
-declare interface ISnapshotBlockJson {
-    snapshot: ISnapshotJson;
-    sheetBlocks: ISheetBlockJson;
-}
-
-declare interface ISnapshotJson extends Omit<ISnapshot, 'workbook' | 'doc'> {
-    workbook: Partial<IWorkbookMetaJson>;
-    doc: Partial<IDocumentMetaJson>;
-}
-
-declare interface IUniverExchangeClientConfig {
-    /**
-     * The URL of the endpoint for downloading files.
-     * @default 'location.origin'
-     */
-    downloadEndpointUrl?: string;
-    uploadFileServerUrl?: string;
-    importServerUrl?: string;
-    exportServerUrl?: string;
-    getTaskServerUrl?: string;
-    signUrlServerUrl?: string;
-    maxTimeoutTime?: number;
-}
-
-export declare interface IUploadNotificationService {
-    visible$: Observable<boolean>;
-    state$: Observable<UploadNotificationState>;
-    list$: Observable<ILinkList[]>;
-    /**
-     * Show upload notification
-     */
-    show(): void;
-    /**
-     * Hide upload notification
-     */
-    hide(): void;
-    /**
-     * Update upload notification state
-     * @param state
-     */
-    updateState(state: UploadNotificationState): void;
-    /**
-     * Push link to upload notification
-     * @param link
-     */
-    pushLink(link: ILinkList): void;
-}
-
-export declare const IUploadNotificationService: IdentifierDecorator<IUploadNotificationService>;
-
-declare interface IUploadProgress {
-    /** Task that already completed. */
-    done: number;
-    /** The total number of tasks need to execute. */
-    count: number;
-}
-
-declare interface IWorkbookMetaJson extends Omit<IWorkbookMeta, 'originalMeta' | 'sheets'> {
-    originalMeta: string;
-    sheets: {
-        [key: string]: Partial<IWorksheetMetaJson>;
-    };
-}
-
-declare interface IWorksheetMetaJson extends Omit<IWorksheetMeta, 'originalMeta'> {
-    originalMeta: string;
-}
-
-/**
- * TODO@Dushusir maybe move to ExchangeClientPlugin plugin for reuse
- */
-export declare class RequestService implements IRequestService, IDisposable {
-    private readonly _configService;
-    private readonly _httpService;
-    constructor(_configService: IConfigService, _httpService: HTTPService);
-    dispose(): void;
-    /**
-     * upload file to server
-     * @param file
-     */
-    upload(file: File | string, size?: number, flate?: boolean): Promise<IFileUploadResponse | undefined>;
-    import(importRequest: IImportRequest): Promise<IImportResponse | undefined>;
-    export(exportRequest: IExportRequest): Promise<IExportResponse | undefined>;
-    getTask(taskID: string): Promise<IGetTaskResponse | undefined>;
-    signUrl(fileID: string): Promise<ISignUrlResponse | undefined>;
-    private _getUploadFileURL;
-    private _getImportURL;
-    private _getExportURL;
-    private _getTaskURL;
-    private _getSignURL;
-    private _getMaxPollingTime;
-}
-
-declare enum RequestState {
-    UPLOAD = 0,
-    IMPORT = 1,
-    EXPORT = 2,
-    GET_TASK = 3,
-    SIGN_URL = 4,
-    GET_JSON = 5,
-    GET_FILE = 6
-}
-
-/**
- * Convert the workbook data to snapshot data
- * @param workbookData
- * @returns
- */
-export declare function transformWorkbookDataToSnapshotJson(workbookData: IWorkbookData): Promise<ISnapshotBlockJson>;
-
-export declare class UniverExchangeClientPlugin extends Plugin_2 {
-    private readonly _config;
-    readonly _injector: Injector;
-    private readonly _configService;
-    static pluginName: string;
-    constructor(_config: IUniverExchangeClientConfig | undefined, _injector: Injector, _configService: IConfigService);
-    onStarting(): void;
-    onReady(): void;
-}
-
-export declare function UploadNotificationContainer(): default_2.JSX.Element;
-
-export declare class UploadNotificationService extends Disposable_2 implements IUploadNotificationService, IDisposable {
-    private readonly _visible$;
-    private readonly _state$;
-    private readonly _list$;
-    readonly visible$: Observable<boolean>;
-    readonly state$: Observable<UploadNotificationState>;
-    readonly list$: Observable<ILinkList[]>;
-    private _list;
-    constructor();
-    dispose(): void;
-    show(): void;
-    hide(): void;
-    updateState(state: UploadNotificationState): void;
-    pushLink(link: ILinkList): void;
-}
-
-export declare enum UploadNotificationState {
-    UPLOADING = 0,
-    SUCCESS = 1,
-    ERROR = 2
-}
-
-export { }
-
-
-declare module '@univerjs/core' {
-    interface FUniver extends IFUniverExchangeClientMixin {
-    }
-}
+export { UniverExchangeClientPlugin } from './plugin';
+export { ExchangeService, IExchangeService } from './services/exchange.service';
+export { ExchangeOperateService, IExchangeOperateService } from './services/operate.service';
+export { IRequestService, RequestService } from './services/request.service';
+/** @deprecated Will be removed in the 0.2.19 release */
+export { EXCHANGE_EXPORT_SERVER_URL_KEY, EXCHANGE_GET_TASK_SERVER_URL_KEY, EXCHANGE_IMPORT_SERVER_URL_KEY, EXCHANGE_SIGN_URL_SERVER_URL_KEY, EXCHANGE_UPLOAD_FILE_SERVER_URL_KEY } from './services/request.service';
+export { IUploadNotificationService, UploadNotificationService, UploadNotificationState } from './services/upload-notification.service';
+export { downloadFile, getUniverTypeByFile, getUploadFile } from './services/utils/tool';
+export { UploadNotificationContainer } from './views/UploadNotificationContainer';
+export { transformWorkbookDataToSnapshotJson } from './services/utils/snapshot';

package/lib/types/locale/en-US.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/fa-IR.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/ru-RU.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/vi-VN.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/zh-CN.d.ts

@@ -0,0 +1,21 @@
+declare const locales: {
+    exchange: {
+        file: string;
+        upload: string;
+        download: string;
+        uploading: string;
+        uploadSuccess: string;
+        uploadSuccessTip: string;
+        downloading: string;
+        downloadSuccess: string;
+        unknownMistake: string;
+        networkError: string;
+        tooLarge: string;
+        internalError: string;
+        interrupt: string;
+        wait: string;
+        cancel: string;
+        uploadAgain: string;
+    };
+};
+export default locales;

package/lib/types/locale/zh-TW.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/plugin.d.ts

@@ -0,0 +1,11 @@
+import { IUniverExchangeClientConfig } from './controllers/config.schema';
+import { IConfigService, Injector, Plugin } from '@univerjs/core';
+export declare class UniverExchangeClientPlugin extends Plugin {
+    private readonly _config;
+    readonly _injector: Injector;
+    private readonly _configService;
+    static pluginName: string;
+    constructor(_config: IUniverExchangeClientConfig | undefined, _injector: Injector, _configService: IConfigService);
+    onStarting(): void;
+    onReady(): void;
+}

package/lib/types/services/__tests__/snapshot.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/services/exchange.service.d.ts

@@ -0,0 +1,87 @@
+import { IDisposable, IDocumentData, IWorkbookData, Disposable, IConfigService } from '@univerjs/core';
+import { IError, UniverType } from '@univerjs/protocol';
+import { RequestService } from './request.service';
+import { Observable } from 'rxjs';
+export declare enum RequestState {
+    UPLOAD = 0,
+    IMPORT = 1,
+    EXPORT = 2,
+    GET_TASK = 3,
+    SIGN_URL = 4,
+    GET_JSON = 5,
+    GET_FILE = 6
+}
+export interface IRequestState {
+    error: IError | undefined;
+    state: RequestState;
+}
+export interface IExchangeService {
+    requestState$: Observable<IRequestState>;
+    /**
+     * Import XLSX file to workbook data
+     * @param file
+     */
+    importXLSXToSnapshot(file: File | string): Promise<IWorkbookData | undefined>;
+    /**
+     * Export XLSX file by unit id
+     * @param unitId
+     */
+    exportXLSXByUnitId(unitId: string): Promise<File | undefined>;
+    /**
+     * Export XLSX file by workbook data
+     * @param data
+     * @returns
+     */
+    exportXLSXBySnapshot(snapshot: IWorkbookData): Promise<File | undefined>;
+    /**
+     * Import DOCX file to document data
+     * @param file
+     */
+    importDOCXToSnapshot(file: File | string): Promise<IDocumentData | undefined>;
+    /**
+     * Export DOCX file by unit id
+     * @param unitId
+     */
+    exportDOCXByUnitId(unitId: string): Promise<File | undefined>;
+    /**
+     * Export DOCX file by document data
+     * @param data
+     * @returns
+     */
+    exportDOCXBySnapshot(snapshot: IDocumentData): Promise<File | undefined>;
+    /**
+     * Import file to unit id
+     * @param file
+     * @param univerType
+     */
+    importFileToUnitId(file: File | string, univerType: UniverType): Promise<string | undefined>;
+}
+export declare const IExchangeService: import('@wendellhu/redi').IdentifierDecorator<IExchangeService>;
+export declare class ExchangeService extends Disposable implements IExchangeService, IDisposable {
+    private readonly _configService;
+    private readonly _requestService;
+    private readonly _requestState$;
+    readonly requestState$: Observable<IRequestState>;
+    constructor(_configService: IConfigService, _requestService: RequestService);
+    dispose(): void;
+    importDOCXToSnapshot(file: File | string): Promise<IDocumentData | undefined>;
+    exportDOCXByUnitId(unitId: string): Promise<File | undefined>;
+    exportDOCXBySnapshot(snapshot: IDocumentData): Promise<File | undefined>;
+    importXLSXToSnapshot(file: File | string): Promise<IWorkbookData | undefined>;
+    exportXLSXByUnitId(unitId: string): Promise<File | undefined>;
+    exportXLSXBySnapshot(data: IWorkbookData): Promise<File | undefined>;
+    importFileToUnitId(file: File | string, univerType: UniverType): Promise<string | undefined>;
+    private _importToSnapshot;
+    /**
+     * Export file by snapshot
+     * @param snapshot
+     * @param univerType
+     * @returns
+     */
+    private _exportBySnapshot;
+    private _export;
+    private _upload;
+    private _import;
+    private _signUrl;
+    private _getDownloadEndpointURL;
+}