@univerjs-pro/exchange-client 0.2.6

package/lib/types/index.d.ts

@@ -0,0 +1,9 @@
+export { IExchangeService, ExchangeService } from './services/exchange.service';
+export { getUploadFile, downloadFile, getUniverTypeByFile } from './services/utils/tool';
+export { IUploadNotificationService, UploadNotificationService, UploadNotificationState } from './services/upload-notification.service';
+export { IUploadProgressService, UploadProgressService } from './services/upload-progress.service';
+export { UploadNotificationContainer } from './views/UploadNotificationContainer';
+export { RequestService, IRequestService } from './services/request.service';
+export { EXCHANGE_UPLOAD_FILE_SERVER_URL_KEY, EXCHANGE_IMPORT_SERVER_URL_KEY, EXCHANGE_EXPORT_SERVER_URL_KEY, EXCHANGE_GET_TASK_SERVER_URL_KEY, EXCHANGE_SIGN_URL_SERVER_URL_KEY } from './services/request.service';
+export { IExchangeOperateService } from './services/operate.service';
+export { UniverExchangeClientPlugin } from './plugin';

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

@@ -0,0 +1,4 @@
+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,4 @@
+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,4 @@
+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,4 @@
+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 { Injector, LocaleService, Plugin } from '@univerjs/core';
+
+export declare class UniverExchangeClientPlugin extends Plugin {
+    private readonly _;
+    readonly _injector: Injector;
+    private readonly _localeService;
+    static pluginName: string;
+    constructor(_: undefined, _injector: Injector, _localeService: LocaleService);
+    initialize(): void;
+    onReady(): void;
+}

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

@@ -0,0 +1,88 @@
+import { IDisposable, IDocumentData, IWorkbookData, Disposable } from '@univerjs/core';
+import { IError, UniverType } from '@univerjs/protocol';
+import { Observable } from 'rxjs';
+import { RequestService } from './request.service';
+
+export declare enum RequestState {
+    UPLOAD = 0,
+    IMPORT = 1,
+    EXPORT = 2,
+    GET_TASK = 3,
+    SIGN_URL = 4,
+    GET_JSON = 5,
+    GET_FILE = 6,
+    BINDING = 7
+}
+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('@univerjs/core').IdentifierDecorator<IExchangeService>;
+export declare class ExchangeService extends Disposable implements IExchangeService, IDisposable {
+    private readonly _requestService;
+    private readonly _requestState$;
+    readonly requestState$: Observable<IRequestState>;
+    constructor(_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 _binding;
+}

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

@@ -0,0 +1,97 @@
+import { IDisposable, Disposable, ILogService, IUniverInstanceService, LocaleService, UniverInstanceType } from '@univerjs/core';
+import { IProgressService, IMessageService } from '@univerjs/ui';
+import { UniverType } from '@univerjs/protocol';
+import { ExchangeService } from './exchange.service';
+import { UploadNotificationService } from './upload-notification.service';
+
+export 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?: UniverInstanceType): Promise<void>;
+    /**
+     * Export docx file by snapshot
+     * @returns
+     */
+    exportDOCXBySnapshot(): Promise<void>;
+    /**
+     * Upload file, supports multiple types
+     * @param file
+     */
+    uploadFileToUnitId(types: UniverType[]): Promise<string | 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;
+}
+export declare const IExchangeOperateService: import('@univerjs/core').IdentifierDecorator<IExchangeOperateService>;
+export declare class ExchangeOperateService extends Disposable implements IExchangeOperateService, IDisposable {
+    private _univerInstanceService;
+    private readonly _messageService;
+    private readonly _localeService;
+    private readonly _exchangeService;
+    private readonly _uploadNotificationService;
+    private readonly _uploadProgressService;
+    protected readonly _logService: ILogService;
+    private _interrupted;
+    constructor(_univerInstanceService: IUniverInstanceService, _messageService: IMessageService, _localeService: LocaleService, _exchangeService: ExchangeService, _uploadNotificationService: UploadNotificationService, _uploadProgressService: IProgressService, _logService: ILogService);
+    interrupt(): void;
+    uploadFileToUnitId(types: UniverType[]): Promise<string | 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;
+}

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

@@ -0,0 +1,105 @@
+import { IConfigService, IDisposable } from '@univerjs/core';
+import { HTTPService } from '@univerjs/network';
+import { IError, UniverType } from '@univerjs/protocol';
+import { ISheetBlockJson, ISnapshotJson } from './utils/snapshot';
+
+export declare const EXCHANGE_UPLOAD_FILE_SERVER_URL_KEY = "EXCHANGE_UPLOAD_FILE_SERVER_URL_KEY";
+export declare const EXCHANGE_IMPORT_SERVER_URL_KEY = "EXCHANGE_IMPORT_SERVER_URL_KEY";
+export declare const EXCHANGE_EXPORT_SERVER_URL_KEY = "EXCHANGE_EXPORT_SERVER_URL_KEY";
+export declare const EXCHANGE_GET_TASK_SERVER_URL_KEY = "EXCHANGE_GET_TASK_SERVER_URL_KEY";
+export declare const EXCHANGE_SIGN_URL_SERVER_URL_KEY = "EXCHANGE_SIGN_URL_SERVER_URL_KEY";
+export declare const EXCHANGE_BINDING_SERVER_URL_KEY = "EXCHANGE_BINDING_SERVER_URL_KEY";
+export interface IFileUploadResponse {
+    FileId: string;
+    error: IError;
+}
+export 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 interface IImportRequest {
+    fileID: string;
+    type: UniverType;
+    outputType: ImportOutputType;
+    /** not supported yet */
+    fileUrl: string;
+}
+export interface IImportResponse {
+    taskID: string;
+    error: IError;
+}
+export 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;
+}
+export interface IExportResponse {
+    error: IError | undefined;
+    taskID: string;
+}
+export interface IGetTaskResponse {
+    error: IError | undefined;
+    taskID: string;
+    status: string;
+    import?: IImportTaskResult | undefined;
+    export?: IExportTaskResult | undefined;
+}
+export interface IImportTaskResult {
+    outputType: ImportOutputType;
+    unitID: string;
+    jsonID: string;
+}
+export interface IExportTaskResult {
+    fileID: string;
+    fileUrl: string;
+}
+export interface ISignUrlResponse {
+    error: IError | undefined;
+    url: string;
+}
+export interface IBindingResponse {
+    error: IError;
+}
+export interface ISnapshotJsonResponse {
+    snapshot: Partial<ISnapshotJson>;
+    sheetBlocks: ISheetBlockJson;
+}
+export 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: import('@univerjs/core').IdentifierDecorator<IRequestService>;
+/**
+ * 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>;
+    binding(unitId: string, type: UniverType): Promise<IBindingResponse | undefined>;
+    private _getUploadFileURL;
+    private _getImportURL;
+    private _getExportURL;
+    private _getTaskURL;
+    private _getSignURL;
+    private _getBindingURL;
+}

package/lib/types/services/upload-notification.service.d.ts

@@ -0,0 +1,53 @@
+import { Disposable, IDisposable } from '@univerjs/core';
+import { Observable } from 'rxjs';
+import { UniverType } from '@univerjs/protocol';
+
+export declare enum UploadNotificationState {
+    UPLOADING = 0,
+    SUCCESS = 1,
+    ERROR = 2
+}
+export interface ILinkList {
+    link: string;
+    name: string;
+    type: UniverType;
+}
+export 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: import('@univerjs/core').IdentifierDecorator<IUploadNotificationService>;
+export declare class UploadNotificationService extends Disposable 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;
+}

package/lib/types/services/upload-progress.service.d.ts

@@ -0,0 +1,5 @@
+import { IProgressService, ProgressService } from '@univerjs/ui';
+
+export declare class UploadProgressService extends ProgressService {
+}
+export declare const IUploadProgressService: import('@univerjs/core').IdentifierDecorator<IProgressService>;

package/lib/types/services/utils/snapshot.d.ts

@@ -0,0 +1,53 @@
+import { IWorkbookData, Nullable } from '@univerjs/core';
+import { IDocumentMeta, ISheetBlock, ISnapshot, IWorkbookMeta, IWorksheetMeta } from '@univerjs/protocol';
+
+export interface IWorksheetMetaJson extends Omit<IWorksheetMeta, 'originalMeta'> {
+    originalMeta: string;
+}
+export interface IWorkbookMetaJson extends Omit<IWorkbookMeta, 'originalMeta' | 'sheets'> {
+    originalMeta: string;
+    sheets: {
+        [key: string]: Partial<IWorksheetMetaJson>;
+    };
+}
+export interface IDocumentMetaJson extends Omit<IDocumentMeta, 'originalMeta'> {
+    originalMeta: string;
+}
+export interface ISnapshotJson extends Omit<ISnapshot, 'workbook' | 'doc'> {
+    workbook: Partial<IWorkbookMetaJson>;
+    doc: Partial<IDocumentMetaJson>;
+}
+export interface ISheetBlockData extends Omit<ISheetBlock, 'data'> {
+    data: string;
+}
+export interface ISheetBlockJson {
+    [key: string]: Partial<ISheetBlockData>;
+}
+export interface ISnapshotBlockJson {
+    snapshot: ISnapshotJson;
+    sheetBlocks: ISheetBlockJson;
+}
+export interface ISnapshotBlockJsonResponse {
+    snapshot: ISnapshot;
+    sheetBlocks: {
+        [key: string]: ISheetBlock;
+    };
+}
+/**
+ * Convert the Uint8Array in the snapshot to a string for easy transmission to the backend
+ * @param snapshot
+ * @returns
+ */
+export declare function transformSnapshotMetaToString(snapshot: ISnapshot): Nullable<ISnapshotJson>;
+/**
+ * Convert the Uint8Array in the sheet block to a string for easy transmission to the backend
+ * @param sheetBlocks
+ * @returns
+ */
+export declare function transformSheetBlockMetaToString(sheetBlocks: ISheetBlock[]): ISheetBlockJson;
+/**
+ * Convert the workbook data to snapshot data
+ * @param workbookData
+ * @returns
+ */
+export declare function transformWorkbookDataToSnapshotJson(workbookData: IWorkbookData): Promise<ISnapshotBlockJson>;

package/lib/types/services/utils/tool.d.ts

@@ -0,0 +1,20 @@
+import { UniverType } from '@univerjs/protocol';
+
+export declare function downloadFileByURL(url: string, filename: string, fileExt: string): void;
+/**
+ * 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;
+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>;
+export declare function getFileByURL(url: string): Promise<File | undefined>;
+export declare function getFileNameFromURL(url: string): string | undefined;
+export declare function getTextFromURL(url: string): Promise<string | undefined>;
+export declare function blobToString(blob: Blob): Promise<string>;
+export declare function bufferToFile(buffer: Uint8Array): File;
+export declare function replaceType(path: string, type: string): string;
+export declare function replaceUnitId(path: string, type: string): string;
+export declare function replaceTaskID(path: string, taskID: string): string;
+export declare function replaceFileID(path: string, fileID: string): string;

package/lib/types/views/UploadNotificationContainer.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+
+export declare function UploadNotificationContainer(): React.JSX.Element;

package/lib/types/views/link-list/LinkList.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { ILinkList } from '../../services/upload-notification.service';
+
+export interface ILinkListProps {
+    list: ILinkList[];
+}
+export declare function LinkList(props: ILinkListProps): React.JSX.Element;

package/lib/types/views/upload-again/UploadAgain.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+
+export declare function UploadAgain(): React.JSX.Element;

package/lib/types/views/upload-button/UploadButton.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+
+export interface IUploadButton {
+    children?: React.ReactNode;
+    className?: string;
+    onClick?: (e: React.MouseEvent<HTMLButtonElement>) => void;
+}
+export declare function UploadButton(props: IUploadButton): React.JSX.Element;

package/lib/types/views/upload-error/UploadError.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+
+export declare function UploadError(): React.JSX.Element;

package/lib/types/views/upload-notification/UploadNotification.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+
+export declare function UploadNotification(): false | React.JSX.Element;

package/lib/types/views/upload-success/UploadSuccess.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+
+export interface IUploadSuccessProps {
+    count: number;
+}
+export declare function UploadSuccess(props: IUploadSuccessProps): React.JSX.Element;

package/lib/types/views/uploading/Uploading.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+
+export declare function Uploading(): React.JSX.Element;

package/lib/types/views/uploading/upload-cancel/UploadCancel.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+
+export declare function UploadCancel(): React.JSX.Element;

package/lib/types/views/uploading/upload-progress/UploadProgress.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+
+export interface IUploadProgressProps {
+    barColor: string;
+}
+export declare function UploadProgress(props: IUploadProgressProps): React.JSX.Element;