@univerjs/protocol 0.1.46-alpha.4 → 0.1.47-alpha.0

package/lib/types/index.d.ts

@@ -28,7 +28,7 @@ export { FileSource, type FileService as IFileService, type FileUploadRequest as
 export type { CreateHistoryRequest as ICreateHistoryRequest, CreateHistoryResponse as ICreateHistoryResponse, History as IHistory, HistoryEntities as IHistoryEntities, HistoryListRequest as IHistoryListRequest, HistoryService as IHistoryService, } from './ts/v1/history';
 export type { GetUserLicenseRequest as IGetUserLicenseRequest, GetUserLicenseResponse as IGetUserLicenseResponse, LicenseService as ILicenseService, } from './ts/v1/license';
 export { type CopyFileMetaRequest as ICopyFileMetaRequest, type CopyFileMetaResponse as ICopyFileMetaResponse, type FetchMissingChangesetsRequest as IFetchMissingChangesetsRequest, type FetchMissingChangesetsResponse as IFetchMissingChangesetsResponse, type GetLatestCsReqIdBySidRequest as IGetLatestCsReqIdBySidRequest, type GetLatestCsReqIdBySidResponse as IGetLatestCsReqIdBySidResponse, type GetResourcesRequest as IGetResourcesRequest, type GetResourcesResponse as IGetResourcesResponse, type GetSheetBlockRequest as IGetSheetBlockRequest, type GetSheetBlockResponse as IGetSheetBlockResponse, type GetSnapshotRequest as IGetSnapshotRequest, type GetSnapshotResponse as IGetSnapshotResponse, type GetUnitOnRevRequest as IGetUnitOnRevRequest, type GetUnitOnRevResponse as IGetUnitOnRevResponse, type SaveChangesetRequest as ISaveChangesetRequest, type SaveChangesetResponse as ISaveChangesetResponse, type SaveSheetBlockRequest as ISaveSheetBlockRequest, type SaveSheetBlockResponse as ISaveSheetBlockResponse, type SaveSnapshotRequest as ISaveSnapshotRequest, type SaveSnapshotResponse as ISaveSnapshotResponse, type SnapshotService as ISnapshotService, type UpdateUnitRequest as IUpdateUnitRequest, type UpdateUnitResponse as IUpdateUnitResponse, } from './ts/v1/snapshot';
-export type { CloseSessionRequest as ICloseSessionRequest, CloseSessionResponse as ICloseSessionResponse, CreateWorkbookRequest as ICreateWorkbookRequest, CreateWorkbookResponse as ICreateWorkbookResponse, Cuboid as ICuboid, CuboidData as ICuboidData, Dimension as IDimension, Field as IField, FilterNumber as IFilterNumber, FilterString as IFilterString, GetAggregationParamsRequest as IGetAggregationParamsRequest, GetAggregationParamsResponse as IGetAggregationParamsResponse, GetCuboidsByIdRequest as IGetCuboidsByIdRequest, GetCuboidsByIdResponse as IGetCuboidsByIdResponse, GetValuesRequest as IGetValuesRequest, GetValuesResponse as IGetValuesResponse, Measure as IMeasure, MergeRequest as IMergeRequest, MergeResponse as IMergeResponse, RunAggregationRequest as IRunAggregationRequest, SetBackgroundColorRequest as ISetBackgroundColorRequest, SetBackgroundColorResponse as ISetBackgroundColorResponse, SetBorderRequest as ISetBorderRequest, SetBorderResponse as ISetBorderResponse, SetValueRequest as ISetValueRequest, SetValueResponse as ISetValueResponse, SetValuesRequest as ISetValuesRequest, SetValuesResponse as ISetValuesResponse, SetWorkbookNameRequest as ISetWorkbookNameRequest, SetWorkbookNameResponse as ISetWorkbookNameResponse, SSCService as ISSCService, View as IView, ViewDetail as IViewDetail, } from './ts/v1/ssc';
+export type { CloseSessionRequest as ICloseSessionRequest, CloseSessionResponse as ICloseSessionResponse, CreateWorkbookRequest as ICreateWorkbookRequest, CreateWorkbookResponse as ICreateWorkbookResponse, Cuboid as ICuboid, CuboidData as ICuboidData, Dimension as IDimension, Field as IField, FilterNumber as IFilterNumber, FilterString as IFilterString, GetAggregationParamsRequest as IGetAggregationParamsRequest, GetAggregationParamsResponse as IGetAggregationParamsResponse, GetCuboidsByIdRequest as IGetCuboidsByIdRequest, GetCuboidsByIdResponse as IGetCuboidsByIdResponse, GetValuesRequest as IGetValuesRequest, GetValuesResponse as IGetValuesResponse, Measure as IMeasure, MergeRequest as IMergeRequest, MergeResponse as IMergeResponse, RunAggregationRequest as IRunAggregationRequest, SetBackgroundColorRequest as ISetBackgroundColorRequest, SetBackgroundColorResponse as ISetBackgroundColorResponse, SetBorderRequest as ISetBorderRequest, SetBorderResponse as ISetBorderResponse, SetValueRequest as ISetValueRequest, SetValueResponse as ISetValueResponse, SetValuesRequest as ISetValuesRequest, SetValuesResponse as ISetValuesResponse, SetWorkbookNameRequest as ISetWorkbookNameRequest, SetWorkbookNameResponse as ISetWorkbookNameResponse, SSCService as ISSCService, View as IView, ViewDetail as IViewDetail, ComputeRequest as IComputeRequest, ComputeResponse as IComputeResponse, } from './ts/v1/ssc';
 export { NumberFilterEnum } from './ts/v1/ssc';
 export type { GetSSRRequest as IGetSSRRequest, GetSSRResponse as IGetSSRResponse, SSRService as ISSRService, } from './ts/v1/ssr';
 export { type InstallPackagesRequest as IInstallPackagesRequest, type InstallPackagesResponse as IInstallPackagesResponse, type RunUniscriptRequest as IRunUniscriptRequest, type RunUniscriptResponse as IRunUniscriptResponse, type Uniscript as IUniscript, type UniscriptEnv as IUniscriptEnv, UniscriptEnv, } from './ts/v1/uniscript';

package/lib/types/ts/v1/conf.d.ts

@@ -44,6 +44,7 @@ export interface Bootstrap {
 export interface Server {
     http: Server_HTTP | undefined;
     grpc: Server_GRPC | undefined;
+    shutdownTimeout: Duration | undefined;
 }
 export interface Server_HTTP {
     network: string;

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

@@ -240,7 +240,13 @@ export interface SnapshotService {
     SaveChangeset(request: SaveChangesetRequest, metadata?: Metadata): Observable<SaveChangesetResponse>;
     GetLatestCsReqIdBySid(request: GetLatestCsReqIdBySidRequest, metadata?: Metadata): Observable<GetLatestCsReqIdBySidResponse>;
     FetchMissingChangesets(request: FetchMissingChangesetsRequest, metadata?: Metadata): Observable<FetchMissingChangesetsResponse>;
+    /**
+     * 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>;
+    /** Update a snapshot to the database. */
+    UpdateSnapshot(request: SaveSnapshotRequest, metadata?: Metadata): Observable<SaveSnapshotResponse>;
     GetSnapshot(request: GetSnapshotRequest, metadata?: Metadata): Observable<GetSnapshotResponse>;
     SaveSheetBlock(request: SaveSheetBlockRequest, metadata?: Metadata): Observable<SaveSheetBlockResponse>;
     GetSheetBlock(request: GetSheetBlockRequest, metadata?: Metadata): Observable<GetSheetBlockResponse>;

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

@@ -14,6 +14,22 @@ export declare enum NumberFilterEnum {
     valueNotEqual = 7,
     UNRECOGNIZED = -1
 }
+export interface ComputeRequest {
+    /** 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 ComputeResponse {
+    error: Error | undefined;
+    /** Of which revision the unit is processed on. */
+    revision: number;
+}
 export interface GetValuesRequest {
     sessionId: string;
     waitForComputing: boolean;
@@ -220,7 +236,10 @@ export interface CuboidData {
  * It is implemented in Node.js. See `univer-pro/apps/univer-collaboration-server`.
  */
 export interface SSCService {
-    /** Get value from the worksheet. */
+    /**
+     * #region deprecated
+     * Get value from the worksheet.
+     */
     GetValues(request: GetValuesRequest, metadata?: Metadata): Observable<GetValuesResponse>;
     SetValue(request: SetValueRequest, metadata?: Metadata): Observable<SetValueResponse>;
     SetValues(request: SetValuesRequest, metadata?: Metadata): Observable<SetValuesResponse>;
@@ -235,4 +254,6 @@ export interface SSCService {
     GetAggregationParams(request: GetAggregationParamsRequest, metadata?: Metadata): Observable<GetAggregationParamsResponse>;
     RunAggregation(request: RunAggregationRequest, metadata?: Metadata): Observable<GetCuboidsByIdResponse>;
     GetCuboidsById(request: GetCuboidsByIdRequest, metadata?: Metadata): Observable<GetCuboidsByIdResponse>;
+    /** Trigger computing of a unit and write the result back into the snapshot service. */
+    Compute(request: ComputeRequest, metadata?: Metadata): Observable<ComputeResponse>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/protocol",
-  "version": "0.1.46-alpha.4",
+  "version": "0.1.47-alpha.0",
   "private": false,
   "description": "A protocol of Univer repos",
   "author": "DreamNum <developer@univer.ai>",
@@ -40,7 +40,7 @@
   "devDependencies": {
     "rimraf": "^6.0.1",
     "typescript": "^5.8.3",
-    "vite": "^6.3.4",
+    "vite": "^6.3.5",
     "vite-plugin-dts": "^4.5.3"
   },
   "scripts": {