@univerjs-pro/exchange-client 0.4.2 → 0.5.0-nightly.202411091605

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

@@ -1,107 +0,0 @@
-import { IDisposable, IConfigService } from '@univerjs/core';
-import { IError, UniverType } from '@univerjs/protocol';
-import { ISheetBlockJson, ISnapshotJson } from './utils/snapshot';
-import { HTTPService } from '@univerjs/network';
-/** @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";
-/** @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_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_SIGN_URL_SERVER_URL_KEY = "EXCHANGE_SIGN_URL_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('@wendellhu/redi').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>;
-    private _getUploadFileURL;
-    private _getImportURL;
-    private _getExportURL;
-    private _getTaskURL;
-    private _getSignURL;
-    private _getMaxPollingTime;
-}

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

@@ -1,52 +0,0 @@
-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('@wendellhu/redi').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/utils/snapshot.d.ts

@@ -1,76 +0,0 @@
-import { IWorkbookData, Nullable } from '@univerjs/core';
-import { ICopyFileMetaRequest, ICopyFileMetaResponse, IDocumentMeta, IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetDeserializedSheetBlockResponse, IGetLatestCsReqIdBySidRequest, IGetLatestCsReqIdBySidResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetRequest, ISaveChangesetResponse, ISaveSheetBlockRequest, ISaveSheetBlockResponse, ISaveSnapshotRequest, ISaveSnapshotResponse, ISheetBlock, ISnapshot, IWorkbookMeta, IWorksheetMeta } from '@univerjs/protocol';
-import { ILogContext, ISnapshotServerService } from '@univerjs-pro/collaboration';
-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>;
-/**
- * The server needs to fully implement all interfaces, but when used by the client, use saveSheetBlock to cache the sheet block locally, and use getSheetBlock to obtain the sheet block.
- */
-export declare class ClientSnapshotServerService implements ISnapshotServerService {
-    private _sheetBlockCache;
-    /** Load snapshot from a database. */
-    getUnitOnRev(context: ILogContext, params: IGetUnitOnRevRequest): Promise<IGetUnitOnRevResponse>;
-    /** Load sheet block from a database.  */
-    getSheetBlock(context: ILogContext, params: IGetSheetBlockRequest): Promise<IGetSheetBlockResponse>;
-    /** Load deserialized sheet block from a database.  */
-    getDeserializedSheetBlock(context: ILogContext, params: IGetSheetBlockRequest): Promise<IGetDeserializedSheetBlockResponse>;
-    /** Fetch missing changeset */
-    fetchMissingChangesets(context: ILogContext, params: IFetchMissingChangesetsRequest): Promise<IFetchMissingChangesetsResponse>;
-    getResourcesRequest(context: ILogContext, params: IGetResourcesRequest): Promise<IGetResourcesResponse>;
-    /** Save snapshot to a database. */
-    saveSnapshot(context: ILogContext, params: ISaveSnapshotRequest): Promise<ISaveSnapshotResponse>;
-    /** Save sheet block to a database. */
-    saveSheetBlock(context: ILogContext, params: ISaveSheetBlockRequest): Promise<ISaveSheetBlockResponse>;
-    /** Save changeset to a database. */
-    saveChangeset(context: ILogContext, params: ISaveChangesetRequest): Promise<ISaveChangesetResponse>;
-    copyFileMeta(context: ILogContext, params: ICopyFileMetaRequest): Promise<ICopyFileMetaResponse>;
-    getLatestCsReqIdBySid(context: ILogContext, params: IGetLatestCsReqIdBySidRequest): Promise<IGetLatestCsReqIdBySidResponse>;
-}

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

@@ -1,19 +0,0 @@
-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

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

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

@@ -1,6 +0,0 @@
-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

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

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

@@ -1,7 +0,0 @@
-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

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

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

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

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

@@ -1,5 +0,0 @@
-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

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

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

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

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

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