@univerjs/protocol 0.1.48 → 0.20.1-insiders.20260418-3a69981

package/lib/types/ts/universer/v1/snapshot.d.ts

@@ -1,16 +1,30 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-import { Changeset, Command, Mutation } from '../../univer/changeset';
-import { Error } from '../../univer/constants/errors';
-import { UniverType } from '../../univer/constants/univer';
-import { InitialSheet } from '../../univer/initial_sheet';
-import { Resource } from '../../univer/resource';
-import { Snapshot, TableInfo } from '../../univer/snapshot';
-import { CustomCellTemplate } from '../../univer/unit_template';
-import { Unit } from '../../univer/univer_file';
-import { SheetBlock, SheetBlockMeta } from '../../univer/workbook';
-export declare const protobufPackage = "universer.v1";
-export interface GetSnapshotMetaWithPreCalculatedRequest {
+/**
+ * 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 { 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 { IResource } from '../../univer/resource';
+import type { ISnapshot, ITableInfo } from '../../univer/snapshot';
+import type { ICustomCellTemplate } from '../../univer/unit-template';
+import type { IUnit } from '../../univer/univer-file';
+import type { ISheetBlock, ISheetBlockMeta } from '../../univer/workbook';
+interface IGetSnapshotMetaWithPreCalculatedRequest {
     /** The id of the unit to be computed. */
     workbookId: string;
     /**
@@ -19,23 +33,19 @@ export interface GetSnapshotMetaWithPreCalculatedRequest {
      */
     revision: number;
 }
-export interface GetSnapshotMetaWithPreCalculatedResponse {
-    error: Error | undefined;
+interface IGetSnapshotMetaWithPreCalculatedResponse {
+    error: IError | undefined;
     /** Of which revision the unit is processed on. */
     revision: number;
     sscBlock: {
-        [key: string]: SheetBlockMeta;
+        [key: string]: ISheetBlockMeta;
     };
 }
-export interface GetSnapshotMetaWithPreCalculatedResponse_SscBlockEntry {
-    key: string;
-    value: SheetBlockMeta | undefined;
-}
-export interface GetUnitMetaRequest {
+interface IGetUnitMetaRequest {
     unitId: string;
 }
-export interface GetUnitMetaResponse {
-    error: Error | undefined;
+interface IGetUnitMetaResponse {
+    error: IError | undefined;
     unitId: string;
     name: string;
     creator: string;
@@ -43,108 +53,112 @@ export interface GetUnitMetaResponse {
     createTime: string;
     updateTime: string;
 }
-export interface GetSheetTableInfoRequest {
+interface IGetSheetTableInfoRequest {
     unitID: string;
     type: UniverType;
 }
-export interface GetSheetTableInfoResponse {
-    error: Error | undefined;
+interface IGetSheetTableInfoResponse {
+    error: IError | undefined;
     unitName: string;
-    table: SheetTable | undefined;
+    table: ISheetTable | undefined;
 }
-export interface GetSheetTableRequest {
+interface IGetSheetTableRequest {
     unitID: string;
     type: UniverType;
     tableId: string;
 }
-export interface GetSheetTableResponse {
-    error: Error | undefined;
+interface IGetSheetTableResponse {
+    error: IError | undefined;
     tableData: Uint8Array;
 }
-export interface ForkUnitRequest {
+export interface IForkUnitRequest {
     unitId: string;
     type: UniverType;
 }
-export interface ForkUnitResponse {
-    error: Error | undefined;
+export interface IForkUnitResponse {
+    error: IError | undefined;
     unitId: string;
 }
-export interface CopyFileMetaRequest {
+export interface ICopyFileMetaRequest {
     fileMetaId: string;
 }
-export interface CopyFileMetaResponse {
-    error: Error | undefined;
+export interface ICopyFileMetaResponse {
+    error: IError | undefined;
     fileMetaId: string;
 }
-export interface DirectWriteRequest {
+export interface IDirectWriteRequest {
     unitID: string;
     type: UniverType;
-    commands: Command[];
-    mutations: Mutation[];
+    commands: ICommand[];
+    mutations: IMutation[];
 }
-export interface DirectWriteResponse {
-    error: Error | undefined;
+export interface IDirectWriteResponse {
+    error: IError | undefined;
     revision: number;
 }
-export interface EnsureSnapshotRequest {
+export interface IEnsureSnapshotRequest {
     unitID: string;
     type: UniverType;
     revision: number;
 }
-export interface EnsureSnapshotResponse {
-    error: Error | undefined;
-    snapshot: Snapshot | undefined;
+export interface IEnsureSnapshotResponse {
+    error: IError | undefined;
+    snapshot: ISnapshot | undefined;
 }
-export interface UpdateUnitRequest {
+interface IUpdateUnitRequest {
     type: UniverType;
     unitId: string;
     name: string;
     memberId: string;
 }
-export interface UpdateUnitResponse {
-    error: Error | undefined;
+interface IUpdateUnitResponse {
+    error: IError | undefined;
 }
-export interface CreateUnitRequest {
+export interface ICreateUnitRequest {
     type: UniverType;
     name: string;
     creator: string;
     locale: string;
-    snapshot: Snapshot | undefined;
+    snapshot: ISnapshot | undefined;
     templateID: string;
-    customCell?: CustomCellTemplate | undefined;
-    initialSheets: InitialSheet[];
+    customCell?: ICustomCellTemplate | undefined;
+    initialSheets: IInitialSheet[];
     docContent: string;
     preCreateUnitId: string;
     workbookDataJson: string;
     /** univer ai for exchange */
-    table?: SheetTable | undefined;
-}
-export interface CreateUnitResponse {
-    error: Error | undefined;
+    table?: ISheetTable | undefined;
+    /** used for integration with customer system */
+    idempotencyKey?: string | undefined;
+    /** used for integration with customer system, just store and pass through */
+    metaData?: string | undefined;
+}
+export interface ICreateUnitResponse {
+    error: IError | undefined;
     unitID: string;
     sheetOrder: string[];
 }
-export interface SaveChangesetRequest {
-    changeset: Changeset | undefined;
+export interface ISaveChangesetRequest {
+    changeset: IChangeset | undefined;
     type: UniverType;
-    originChangeset: Changeset | undefined;
+    originChangeset: IChangeset | undefined;
 }
-export interface SaveChangesetResponse {
-    error: Error | undefined;
+export interface ISaveChangesetResponse {
+    error: IError | undefined;
     /** concurrent is the changesets need to follow up. */
-    concurrent: Changeset[];
+    concurrent: IChangeset[];
 }
-export interface GetLatestCsReqIdBySidRequest {
+export interface IGetLatestCsReqIdBySidRequest {
     sid: string;
     unitID: string;
     userID: string;
 }
-export interface GetLatestCsReqIdBySidResponse {
+export interface IGetLatestCsReqIdBySidResponse {
     /** set to default -1 if has no sid yet */
     latestReqID: number;
-    error: Error | undefined;
+    error: IError | undefined;
 }
-export interface FetchMissingChangesetsRequest {
+export interface IFetchMissingChangesetsRequest {
     /** unitID of the Univer document */
     unitID: string;
     type: UniverType;
@@ -153,111 +167,103 @@ export interface FetchMissingChangesetsRequest {
     /** include to revision, if to == 0 , will return (from, +inf] */
     to: number;
 }
-export interface FetchMissingChangesetsResponse {
-    error: Error | undefined;
-    changesets: Changeset[];
+export interface IFetchMissingChangesetsResponse {
+    error: IError | undefined;
+    changesets: IChangeset[];
     latestRevision?: number | undefined;
 }
-export interface SaveSnapshotRequest {
+export interface ISaveSnapshotRequest {
     unitID: string;
     type: UniverType;
-    snapshot: Snapshot | undefined;
+    snapshot: ISnapshot | undefined;
 }
-export interface SaveSnapshotResponse {
-    error: Error | undefined;
+export interface ISaveSnapshotResponse {
+    error: IError | undefined;
 }
-export interface GetSnapshotRequest {
+interface IGetSnapshotRequest {
     unitID: string;
     type: UniverType;
     revision: number;
 }
-export interface GetSnapshotResponse {
-    error: Error | undefined;
-    snapshot: Snapshot | undefined;
+interface IGetSnapshotResponse {
+    error: IError | undefined;
+    snapshot: ISnapshot | undefined;
 }
-export interface GetLatestSnapshotRevisionRequest {
+interface IGetLatestSnapshotRevisionRequest {
     unitID: string;
     type: UniverType;
 }
-export interface GetLatestSnapshotRevisionResponse {
-    error: Error | undefined;
+interface IGetLatestSnapshotRevisionResponse {
+    error: IError | undefined;
     latestRevision: number;
 }
-export interface GetUnitOnRevRequest {
+export interface IGetUnitOnRevRequest {
     unitID: string;
     type: UniverType;
     revision: number;
 }
-export interface GetUnitOnRevResponse {
-    error: Error | undefined;
+export interface IGetUnitOnRevResponse {
+    error: IError | undefined;
     /** the snapshot closest to revision */
-    snapshot: Snapshot | undefined;
+    snapshot: ISnapshot | undefined;
     /** the changesets need to follow up */
-    changesets: Changeset[];
+    changesets: IChangeset[];
 }
-export interface SaveSheetBlockRequest {
+export interface ISaveSheetBlockRequest {
     unitID: string;
     type: UniverType;
     /** no data */
-    block: SheetBlock | undefined;
+    block: ISheetBlock | undefined;
     fileID?: string | undefined;
 }
-export interface SaveSheetBlockResponse {
-    error: Error | undefined;
+export interface ISaveSheetBlockResponse {
+    error: IError | undefined;
     blockID: string;
 }
-export interface GetSheetBlockRequest {
+export interface IGetSheetBlockRequest {
     unitID: string;
     type: UniverType;
     /** string sheetID = 3; */
     blockID: string;
 }
-export interface GetSheetBlockResponse {
-    error: Error | undefined;
-    block: SheetBlock | undefined;
+export interface IGetSheetBlockResponse {
+    error: IError | undefined;
+    block: ISheetBlock | undefined;
 }
-export interface GetResourcesRequest {
+export interface IGetResourcesRequest {
     unitID: string;
     type: UniverType;
     resourceIDs: string[];
 }
-export interface GetResourcesResponse {
-    error: Error | undefined;
+export interface IGetResourcesResponse {
+    error: IError | undefined;
     /** key is resource id */
     resources: {
-        [key: string]: Resource;
+        [key: string]: IResource;
     };
 }
-export interface GetResourcesResponse_ResourcesEntry {
-    key: string;
-    value: Resource | undefined;
-}
-export interface ListUnitsRequest {
+interface IListUnitsRequest {
     type: UniverType;
     nextCursor: string;
 }
-export interface ListUnitsResponse {
-    error: Error | undefined;
-    units: Unit[];
+interface IListUnitsResponse {
+    error: IError | undefined;
+    units: IUnit[];
     nextCursor: string;
 }
-export interface DeleteUnitsRequest {
+interface IDeleteUnitsRequest {
     unitIds: string[];
 }
-export interface DeleteUnitsResponse {
-    error: Error | undefined;
+interface IDeleteUnitsResponse {
+    error: IError | undefined;
 }
-export interface SheetTable {
+interface ISheetTable {
     /** key: table-id */
     tables: {
-        [key: string]: TableInfo;
+        [key: string]: ITableInfo;
     };
 }
-export interface SheetTable_TablesEntry {
-    key: string;
-    value: TableInfo | undefined;
-}
-export interface ReportUnitRoutingStatsRequest {
+export interface IReportUnitRoutingStatsRequest {
     unitId: string;
     estimatedCells?: number | undefined;
     /** precision: seconds */
@@ -265,42 +271,43 @@ export interface ReportUnitRoutingStatsRequest {
     /** precision: seconds, report in import scene. */
     importTime?: number | undefined;
 }
-export interface ReportUnitRoutingStatsResponse {
-    error: Error | undefined;
-}
-export interface SnapshotService {
-    CreateUnit(request: CreateUnitRequest, metadata?: Metadata): Observable<CreateUnitResponse>;
-    UpdateUnit(request: UpdateUnitRequest, metadata?: Metadata): Observable<UpdateUnitResponse>;
-    ListUnits(request: ListUnitsRequest, metadata?: Metadata): Observable<ListUnitsResponse>;
-    DeleteUnits(request: DeleteUnitsRequest, metadata?: Metadata): Observable<DeleteUnitsResponse>;
-    SaveChangeset(request: SaveChangesetRequest, metadata?: Metadata): Observable<SaveChangesetResponse>;
-    GetLatestCsReqIdBySid(request: GetLatestCsReqIdBySidRequest, metadata?: Metadata): Observable<GetLatestCsReqIdBySidResponse>;
-    FetchMissingChangesets(request: FetchMissingChangesetsRequest, metadata?: Metadata): Observable<FetchMissingChangesetsResponse>;
+export interface IReportUnitRoutingStatsResponse {
+    error: IError | undefined;
+}
+export interface ISnapshotService {
+    ICreateUnit(request: ICreateUnitRequest, metadata?: Metadata): Observable<ICreateUnitResponse>;
+    UpdateUnit(request: IUpdateUnitRequest, metadata?: Metadata): Observable<IUpdateUnitResponse>;
+    ListUnits(request: IListUnitsRequest, metadata?: Metadata): Observable<IListUnitsResponse>;
+    DeleteUnits(request: IDeleteUnitsRequest, metadata?: Metadata): Observable<IDeleteUnitsResponse>;
+    SaveChangeset(request: ISaveChangesetRequest, metadata?: Metadata): Observable<ISaveChangesetResponse>;
+    GetLatestCsReqIdBySid(request: IGetLatestCsReqIdBySidRequest, metadata?: Metadata): Observable<IGetLatestCsReqIdBySidResponse>;
+    FetchMissingChangesets(request: IFetchMissingChangesetsRequest, metadata?: Metadata): Observable<IFetchMissingChangesetsResponse>;
     /**
      * Save a snapshot to the database. If the snapshot of the unit at a given revision is already
      * saved, the request will be ignored.
      */
-    SaveSnapshot(request: SaveSnapshotRequest, metadata?: Metadata): Observable<SaveSnapshotResponse>;
+    SaveSnapshot(request: ISaveSnapshotRequest, metadata?: Metadata): Observable<ISaveSnapshotResponse>;
     /** Update a snapshot to the database. */
-    UpdateSnapshot(request: SaveSnapshotRequest, metadata?: Metadata): Observable<SaveSnapshotResponse>;
-    GetSnapshot(request: GetSnapshotRequest, metadata?: Metadata): Observable<GetSnapshotResponse>;
-    GetLatestSnapshotRevision(request: GetLatestSnapshotRevisionRequest, metadata?: Metadata): Observable<GetLatestSnapshotRevisionResponse>;
-    SaveSheetBlock(request: SaveSheetBlockRequest, metadata?: Metadata): Observable<SaveSheetBlockResponse>;
-    GetSheetBlock(request: GetSheetBlockRequest, metadata?: Metadata): Observable<GetSheetBlockResponse>;
-    GetUnitOnRev(request: GetUnitOnRevRequest, metadata?: Metadata): Observable<GetUnitOnRevResponse>;
-    GetResources(request: GetResourcesRequest, metadata?: Metadata): Observable<GetResourcesResponse>;
-    EnsureSnapshot(request: EnsureSnapshotRequest, metadata?: Metadata): Observable<EnsureSnapshotResponse>;
+    UpdateSnapshot(request: ISaveSnapshotRequest, metadata?: Metadata): Observable<ISaveSnapshotResponse>;
+    GetSnapshot(request: IGetSnapshotRequest, metadata?: Metadata): Observable<IGetSnapshotResponse>;
+    GetLatestSnapshotRevision(request: IGetLatestSnapshotRevisionRequest, metadata?: Metadata): Observable<IGetLatestSnapshotRevisionResponse>;
+    SaveSheetBlock(request: ISaveSheetBlockRequest, metadata?: Metadata): Observable<ISaveSheetBlockResponse>;
+    GetSheetBlock(request: IGetSheetBlockRequest, metadata?: Metadata): Observable<IGetSheetBlockResponse>;
+    GetUnitOnRev(request: IGetUnitOnRevRequest, metadata?: Metadata): Observable<IGetUnitOnRevResponse>;
+    GetResources(request: IGetResourcesRequest, metadata?: Metadata): Observable<IGetResourcesResponse>;
+    EnsureSnapshot(request: IEnsureSnapshotRequest, metadata?: Metadata): Observable<IEnsureSnapshotResponse>;
     /** Directly write a changeset with a user's identification to the document. */
-    DirectWrite(request: DirectWriteRequest, metadata?: Metadata): Observable<DirectWriteResponse>;
-    CopyFileMeta(request: CopyFileMetaRequest, metadata?: Metadata): Observable<CopyFileMetaResponse>;
-    ForkUnit(request: ForkUnitRequest, metadata?: Metadata): Observable<ForkUnitResponse>;
+    DirectWrite(request: IDirectWriteRequest, metadata?: Metadata): Observable<IDirectWriteResponse>;
+    CopyFileMeta(request: ICopyFileMetaRequest, metadata?: Metadata): Observable<ICopyFileMetaResponse>;
+    ForkUnit(request: IForkUnitRequest, metadata?: Metadata): Observable<IForkUnitResponse>;
     /** get table info */
-    GetSheetTableInfo(request: GetSheetTableInfoRequest, metadata?: Metadata): Observable<GetSheetTableInfoResponse>;
+    GetSheetTableInfo(request: IGetSheetTableInfoRequest, metadata?: Metadata): Observable<IGetSheetTableInfoResponse>;
     /** get table data */
-    GetSheetTable(request: GetSheetTableRequest, metadata?: Metadata): Observable<GetSheetTableResponse>;
+    GetSheetTable(request: IGetSheetTableRequest, metadata?: Metadata): Observable<IGetSheetTableResponse>;
     /** get unit meta */
-    GetUnitMeta(request: GetUnitMetaRequest, metadata?: Metadata): Observable<GetUnitMetaResponse>;
-    /** 获取公式计算结果 */
-    GetSnapshotMetaWithPreCalculated(request: GetSnapshotMetaWithPreCalculatedRequest, metadata?: Metadata): Observable<GetSnapshotMetaWithPreCalculatedResponse>;
-    ReportUnitRoutingStats(request: ReportUnitRoutingStatsRequest, metadata?: Metadata): Observable<ReportUnitRoutingStatsResponse>;
+    GetUnitMeta(request: IGetUnitMetaRequest, metadata?: Metadata): Observable<IGetUnitMetaResponse>;
+    /** Get formula calculation results */
+    GetSnapshotMetaWithPreCalculated(request: IGetSnapshotMetaWithPreCalculatedRequest, metadata?: Metadata): Observable<IGetSnapshotMetaWithPreCalculatedResponse>;
+    ReportUnitRoutingStats(request: IReportUnitRoutingStatsRequest, metadata?: Metadata): Observable<IReportUnitRoutingStatsResponse>;
 }
+export {};