@univerjs/protocol 0.1.49 → 0.21.0

package/lib/types/ts/univer/workbook.d.ts

@@ -1,6 +1,20 @@
-import { DocumentMeta } from './doc';
-import { Resource } from './resource';
-export declare const protobufPackage = "univer";
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IDocumentMeta } from './doc';
+import type { IResource } from './resource';
 export declare enum CellValueType {
     UNKNOWN = 0,
     STRING = 1,
@@ -9,7 +23,7 @@ export declare enum CellValueType {
     FORCE_STRING = 4,
     UNRECOGNIZED = -1
 }
-export interface WorksheetMeta {
+export interface IWorksheetMeta {
     type: number;
     id: string;
     name: string;
@@ -18,7 +32,7 @@ export interface WorksheetMeta {
     /** The original meta data in JSON format. Cell data is excluded. */
     originalMeta: Uint8Array;
 }
-export interface WorkbookMeta {
+export interface IWorkbookMeta {
     unitID: string;
     rev: number;
     creator: string;
@@ -26,71 +40,33 @@ export interface WorkbookMeta {
     sheetOrder: string[];
     /** The key is sheet id */
     sheets: {
-        [key: string]: WorksheetMeta;
+        [key: string]: IWorksheetMeta;
     };
     /**
      * Questions:  should snapshot server read the celldata?
-     * map<string, univer.Resource> resources = 8; // The key is sheet id
+     * map<string, univer.IResource> resources = 8; // The key is sheet id
      */
-    resources: Resource[];
+    resources: IResource[];
     /** The key is sheet id */
     blockMeta: {
-        [key: string]: SheetBlockMeta;
+        [key: string]: ISheetBlockMeta;
     };
     /** The original meta data in JSON format. Cell data is excluded. */
     originalMeta: Uint8Array;
 }
-export interface WorkbookMeta_SheetsEntry {
-    key: string;
-    value: WorksheetMeta | undefined;
-}
-export interface WorkbookMeta_BlockMetaEntry {
-    key: string;
-    value: SheetBlockMeta | undefined;
-}
-/** import/export would use this message */
-export interface CellDataMatrix {
-    /** The key is the row number */
-    rows: {
-        [key: number]: RowData;
-    };
-}
-export interface CellDataMatrix_RowsEntry {
-    key: number;
-    value: RowData | undefined;
-}
-export interface RowData {
-    rowNumber: number;
-    /** The key is the column number */
-    items: {
-        [key: number]: CellItem;
-    };
-}
-export interface RowData_ItemsEntry {
-    key: number;
-    value: CellItem | undefined;
-}
-export interface CellItem {
-    cell?: CellData | undefined;
-    data?: SomeData | undefined;
-}
-export interface SomeData {
-    id: string;
-    name: string;
-}
-export interface CellValue {
+interface ICellValue {
     strV?: string | undefined;
     numV?: number | undefined;
     boolV?: boolean | undefined;
 }
 /** Represents the data for a cell. */
-export interface CellData {
+export interface ICellData {
     /** The value of the cell. */
-    v: CellValue | undefined;
+    v: ICellValue | undefined;
     /** The type of the cell value. */
     t: CellValueType;
     /** univer doc */
-    p: DocumentMeta | undefined;
+    p: IDocumentMeta | undefined;
     /** style */
     s: string;
     /** formula */
@@ -102,15 +78,16 @@ export interface CellData {
     /** New Excel formulas need to add prefixes for differentiation, e.g., _xlfn._xlws. _xlfn. _xlws. _xludf. */
     xf: string;
 }
-export interface SheetBlock {
+export interface ISheetBlock {
     /** block id, generate by backend server */
     id: string;
     startRow: number;
     endRow: number;
     data: Uint8Array;
 }
-export interface SheetBlockMeta {
+export interface ISheetBlockMeta {
     sheetID: string;
     /** sheet block ids */
     blocks: string[];
 }
+export {};

package/lib/types/ts/univercloud/stats/v1/stats.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare enum IRecordType {
+    /** Unknown - don't use */
+    Unknown = 0,
+    Colla = 1,
+    Import = 2,
+    Export = 3,
+    ICreateUnit = 4,
+    UNRECOGNIZED = -1
+}
+export interface IRecord {
+    /** name: key */
+    k: IRecordType;
+    /** name: label */
+    l: {
+        [key: string]: string;
+    };
+    /** name: value */
+    v: number;
+}

package/lib/types/ts/univerpro/v1/apply.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IChangeset, ICommand, IMutation } from '../../univer/changeset';
+import type { IError } from '../../univer/constants/errors';
+import type { UniverType } from '../../univer/constants/univer';
+import type { IInitialSheet } from '../../univer/initial-sheet';
+import type { ISnapshot } from '../../univer/snapshot';
+import type { ICustomCellTemplate } from '../../univer/unit-template';
+export interface IForkUnitRequest {
+    sourceUnitId: string;
+    targetUnitId: string;
+    type: UniverType;
+}
+export interface IForkUnitResponse {
+    error: IError | undefined;
+    snapshot: ISnapshot | undefined;
+}
+export interface IGetUnitRawContentRequest {
+    unitID: string;
+    type: UniverType;
+    subUnitID: string;
+}
+export interface IGetUnitRawContentResponse {
+    error: IError | undefined;
+    initialSheet: IInitialSheet | undefined;
+    dataStream: string;
+}
+/** The meta required to create a new unit. */
+export interface IWorkbookCreateMeta {
+    /**
+     * If you want to create an empty sheet, make this undefined or a empty
+     * string.
+     */
+    templateID?: string | undefined;
+    /** Name of the unit. It should be localized. */
+    name: string;
+    /** Locale of the unit. */
+    locale: string;
+    customCell?: ICustomCellTemplate | undefined;
+    /** Other meta in the future. */
+    docContent: string;
+}
+export interface ICreateUnitRequest {
+    unitID: string;
+    type: UniverType;
+    name: string;
+    creator: string;
+    /** If `type` is UniverType.UNIVER_SHEEET, this is requried. */
+    workbookMeta?: IWorkbookCreateMeta | undefined;
+    /** Other meta for other types of univer. */
+    initialSheets: IInitialSheet[];
+    workbookDataJson: string;
+}
+export interface ICreateUnitResponse {
+    error: IError | undefined;
+    sheetOrder: string[];
+}
+/**
+ * IApplyRequest is almost the same as a IChangeset.
+ * See `changeset.proto` for details.
+ */
+export interface IApplyRequest {
+    unitID: string;
+    type: UniverType;
+    /** changeset to apply */
+    changeset: IChangeset | undefined;
+    /** changsetset to fast forward to, these cs has been applied to the document */
+    fastForward: IChangeset[];
+}
+export interface IApplyResponse {
+    error: IError | undefined;
+    /** The revision of the document right now */
+    revision: number;
+}
+export interface IDirectWriteRequest {
+    unitID: string;
+    type: UniverType;
+    body: IDirectWriteBody | undefined;
+    userID: string;
+}
+interface IDirectWriteBody {
+    unitID: string;
+    type: UniverType;
+    userID: string;
+    /** ICommand to be executed. Not that you must provide a on of commands or mutations, not both. */
+    commands: ICommand[];
+    /** ICommand to be executed. Not that you must provide a on of commands or mutations, not both. */
+    mutations: IMutation[];
+}
+export interface IDirectWriteResponse {
+    error: IError | undefined;
+    revision: number;
+}
+export interface IDisposeRequest {
+    unitID: string;
+}
+export interface IDisposeResponse {
+    error: IError | undefined;
+}
+export interface IEnsureSnapshotRequest {
+    unitID: string;
+    type: UniverType;
+    revision: number;
+}
+export interface IEnsureSnapshotResponse {
+    error: IError | undefined;
+    snapshot: ISnapshot | undefined;
+}
+export interface IPreloadUnitRequest {
+    unitID: string;
+    type: UniverType;
+}
+export interface IPreloadUnitResponse {
+    error: IError | undefined;
+}
+export {};

package/lib/types/ts/univerpro/v1/helper.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { Metadata } from '@grpc/grpc-js';
+import type { Observable } from 'rxjs';
+import type { IError } from '../../univer/constants/errors';
+import type { UniverType } from '../../univer/constants/univer';
+import type { IEnsureSnapshotRequest, IEnsureSnapshotResponse } from './apply';
+export interface ICreateLatestSnapshotInBackgroundRequest {
+    unitID: string;
+    type: UniverType;
+}
+export interface ICreateLatestSnapshotInBackgroundResponse {
+    error: IError | undefined;
+}
+export interface ICollaborationHelperService {
+    /**
+     * Ensure the snapshot at a given number would be saved to the snapshot service
+     * without fetching it back. Normally used for background saving.
+     */
+    CreateLatestSnapshotInBackground(request: ICreateLatestSnapshotInBackgroundRequest, metadata?: Metadata): Observable<ICreateLatestSnapshotInBackgroundResponse>;
+    /** from IApplyService */
+    EnsureSnapshot(request: IEnsureSnapshotRequest, metadata?: Metadata): Observable<IEnsureSnapshotResponse>;
+}

package/lib/types/ts/univerpro/v1/ssc.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IError } from '../../univer/constants/errors';
+import type { IRange } from '../../univer/range';
+import type { ITableInfo } from '../../univer/snapshot';
+import type { ISheetBlockMeta } from '../../univer/workbook';
+export declare enum responseDataMode {
+    /** none - no data, default */
+    none = 0,
+    /** all - all data */
+    all = 1,
+    /** sample - sample data */
+    sample = 2,
+    UNRECOGNIZED = -1
+}
+export interface IGetPreprocessRangesRequest {
+    unitId: string;
+    rev: number;
+    /** use string, see responseDataMode enum, default is "none" */
+    responseDataMode?: string | undefined;
+}
+export interface ITableInfoList {
+    tableInfos: ITableInfo[];
+}
+export interface IGetPreprocessRangesResponse {
+    error: IError | undefined;
+    tableInfo: {
+        [key: string]: ITableInfoList;
+    };
+}
+export interface IGetValuesRequest {
+    workbookId: string;
+    worksheetId: string;
+    range: IRange | undefined;
+}
+export interface IGetValuesResponse {
+    error: IError | undefined;
+    /** A matrix of values in JSON format. */
+    value: string;
+}
+export interface IComputeRequest {
+    /** The id of the unit to be computed. */
+    workbookId: string;
+    /**
+     * The revision of the unit to be computed. If not specified or set to 0, the SSC service
+     * will fetch the latest version at the request time.
+     */
+    revision: number;
+    /** Timeout in milliseconds. Default is 30s. */
+    timeout: number;
+}
+export interface IComputeResponse {
+    error: IError | undefined;
+    /** Of which revision the unit is processed on. */
+    revision: number;
+    sscBlock: {
+        [key: string]: ISheetBlockMeta;
+    };
+}

package/lib/types/ts/univerpro/v1/ssr.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IError } from '../../univer/constants/errors';
+import type { UniverType } from '../../univer/constants/univer';
+export interface IGetSSRRequest {
+    unitId: string;
+    type: UniverType;
+    /** It is the id of a worksheet for Univer Sheet, or the id of a page for Univer Slide. */
+    subUnitId: string;
+}
+export interface IGetSSRResponse {
+    error: IError | undefined;
+    /** PNG Image encoded in base64 format. */
+    imageEncoded: string;
+}

package/lib/types/ts/universer/v1/access-key.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { Metadata } from '@grpc/grpc-js';
+import type { Observable } from 'rxjs';
+import type { IError } from '../../univer/constants/errors';
+interface IAccessKey {
+    recordId: string;
+    accessKey: string;
+    createdAt: number;
+    agent: boolean;
+    description: string;
+}
+interface ICreateAccessKeyRequest {
+    agent: boolean;
+    description?: string | undefined;
+}
+interface ICreateAccessKeyResponse {
+    error: IError | undefined;
+    accessKey: IAccessKey | undefined;
+}
+interface IListAccessKeysRequest {
+}
+interface IListAccessKeysResponse {
+    error: IError | undefined;
+    accessKeys: IAccessKey[];
+}
+interface IDeleteAccessKeyRequest {
+    recordId: string;
+}
+interface IDeleteAccessKeyResponse {
+    error: IError | undefined;
+}
+export interface IAccessKeyService {
+    CreateAccessKey(request: ICreateAccessKeyRequest, metadata?: Metadata): Observable<ICreateAccessKeyResponse>;
+    ListAccessKeys(request: IListAccessKeysRequest, metadata?: Metadata): Observable<IListAccessKeysResponse>;
+    DeleteAccessKey(request: IDeleteAccessKeyRequest, metadata?: Metadata): Observable<IDeleteAccessKeyResponse>;
+}
+export {};