@univerjs-pro/collaboration 0.2.9 → 0.2.11

package/lib/types/index.d.ts

@@ -6,10 +6,12 @@ export { type ICombRequestEvent, type ICombResponseEvent, type IHeartbeatRequest
 export { UniverCollaborationPlugin } from './plugin';
 export { CompressMutationService } from './services/compress-mutation/compress-mutation-service';
 export { RevisionService, SINGLE_SNAPSHOT_MUTATIONS, SINGLE_HISTORY_MUTATIONS } from './services/rev/rev.service';
-export { SnapshotService } from './services/snapshot/snapshot.service';
+export { ISnapshotServerService, SnapshotService } from './services/snapshot/snapshot.service';
+export { transformDocumentDataToSnapshot, transformSnapshotToDocumentData, transformSnapshotToWorkbookData, transformWorkbookDataToSnapshot, generateTempDocumentSnapshot, generateTemporarySnap, getSheetBlocksFromSnapshot } from './services/snapshot/snapshot-transform';
+export { textDecoder, textEncoder } from './services/snapshot/snapshot-utils';
 export { type IMutationTransformAlgorithm, ITransformService, TransformService, makeArray, } from './services/transform/transform.service';
 export { type IFailureTransformChangesetsResult, type IFailureTransformMutationResult, type IFailureTransformMutationsResult, type IFailureTransformMutationsWithChangesetResult, isTransformChangesetsFailure, isTransformChangesetsSuccess, isTransformMutationFailure, isTransformMutationsFailure, isTransformMutationsSuccess, isTransformMutationSuccess, isTransformMutationsWithChangesetFailure, isTransformMutationsWithChangesetSuccess, type ISuccessTransformChangesetsResult, type ISuccessTransformMutationResult, type ISuccessTransformMutationsResult, type ISuccessTransformMutationsWithChangesetResult, type ITransformChangesetsResult, type ITransformMutationResult, type ITransformMutationsResult, type ITransformMutationsWithChangesetResult, } from './services/transform/types';
-export { mapDocumentTypeToUniverType } from './utils';
+export { mapDocumentTypeToUniverType, type ILogContext, b64DecodeUnicode, b64EncodeUnicode } from './utils';
 export { IHistoryIoService } from './services/history/type';
 export { RevertRevisionMutation, type IRevertRevisionMutationParams } from './command/revert-revision.mutation';
 export { CreateUnitMutation, type ICreateUnitMutationParams } from './command/create-unit.mutation';

package/lib/types/services/history/type.d.ts

@@ -1,5 +1,5 @@
-import { ILogContext } from '@univerjs/core';
 import { ICreateHistoryRequest, ICreateHistoryResponse } from '@univerjs/protocol';
+import { ILogContext } from '../../utils';
 export interface IHistoryIoService {
     createHistory(config: ICreateHistoryRequest, context?: ILogContext): Promise<ICreateHistoryResponse>;
 }

package/lib/types/services/snapshot/__tests__/snapshot-mock.d.ts

@@ -0,0 +1,22 @@
+import { IWorkbookData } from '@univerjs/core';
+import { IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetRequest, ISaveChangesetResponse, ISaveSheetBlockRequest, ISaveSheetBlockResponse, ISaveSnapshotRequest, ISaveSnapshotResponse, ISheetBlock, ISnapshot } from '@univerjs/protocol';
+import { ILogContext } from '../../../utils';
+import { ISnapshotServerService } from '../snapshot.service';
+export declare const testSnapshot: () => ISnapshot;
+export declare const testSheetBlocks: () => ISheetBlock[];
+export declare const testWorkbookData: () => IWorkbookData;
+export declare class MockSnapshotServerService implements ISnapshotServerService {
+    /** 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>;
+    /** 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>;
+}

package/lib/types/services/snapshot/__tests__/snapshot-transform.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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 {};

package/lib/types/services/snapshot/__tests__/snapshot.service.spec.d.ts

@@ -1,5 +1,6 @@
-import { ILogContext, ISnapshotServerService } from '@univerjs/core';
 import { IFetchMissingChangesetsResponse, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetResponse, ISaveSheetBlockResponse, ISaveSnapshotResponse } from '@univerjs/protocol';
+import { ISnapshotServerService } from '../snapshot.service';
+import { ILogContext } from '../../../utils';
 export declare class MockSnapshotServerService implements ISnapshotServerService {
     getUnitOnRev(_context: ILogContext, params: IGetUnitOnRevRequest): Promise<IGetUnitOnRevResponse>;
     getSheetBlock(_context: ILogContext, params: IGetSheetBlockRequest): Promise<IGetSheetBlockResponse>;

package/lib/types/services/snapshot/snapshot-transform.d.ts

@@ -0,0 +1,30 @@
+import { ISheetBlock, ISnapshot } from '@univerjs/protocol';
+import { IDocumentData, IWorkbookData } from '@univerjs/core';
+import { ILogContext } from '../../utils';
+import { ISnapshotServerService } from './snapshot.service';
+export declare function generateTempDocumentSnapshot(_context: ILogContext, document: IDocumentData, unitID: string, rev: number): Promise<{
+    snapshot: ISnapshot;
+}>;
+export declare function generateTemporarySnap(context: ILogContext, workbook: IWorkbookData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
+    snapshotRes: ISnapshot;
+}>;
+export declare function transformWorkbookDataToSnapshot(context: ILogContext, workbook: IWorkbookData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
+    snapshot: ISnapshot;
+}>;
+/**
+ * Assemble a snapshot to a workbook.
+ * @param snapshot
+ * @param sheetBlocks
+ */
+export declare function transformSnapshotToWorkbookData(snapshot: ISnapshot, sheetBlocks: ISheetBlock[], _context?: ILogContext): IWorkbookData;
+export declare function transformSnapshotToDocumentData(snapshot: ISnapshot): IDocumentData;
+export declare function transformDocumentDataToSnapshot(context: ILogContext, document: IDocumentData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
+    snapshot: ISnapshot;
+}>;
+/**
+ *
+ * @param snapshot
+ * @param snapshotService
+ * @returns
+ */
+export declare function getSheetBlocksFromSnapshot(snapshot: ISnapshot, snapshotService: ISnapshotServerService): Promise<ISheetBlock[]>;

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

@@ -0,0 +1,15 @@
+import { ICellData, IDocumentData, IObjectMatrixPrimitiveType, IWorkbookData, IWorksheetData } from '@univerjs/core';
+import { ISheetBlock } from '@univerjs/protocol';
+export declare const textEncoder: TextEncoder;
+export declare const textDecoder: TextDecoder;
+/**
+ * @param worksheet
+ */
+export declare function encodeWorksheetOtherMetas(worksheet: Partial<IWorksheetData>): Uint8Array;
+export declare function encodeWorkbookOtherMetas(workbook: IWorkbookData): Uint8Array;
+export declare function encodeDocOriginalMeta(document: IDocumentData): Uint8Array;
+export declare function decodeWorksheetOtherMetas(buffer: Uint8Array | string): Partial<IWorksheetData>;
+export declare function decodeWorkbookOtherMetas(buffer: Uint8Array | string): Partial<IWorkbookData>;
+export declare function decodePartOfCellData(buffer: Uint8Array | string): IObjectMatrixPrimitiveType<ICellData>;
+export declare function decodeDocOriginalMeta(buffer: Uint8Array | string): Partial<IDocumentData>;
+export declare function splitCellDataToBlocks(cellData: IObjectMatrixPrimitiveType<ICellData>, maxColumn: number): ISheetBlock[];

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

@@ -1,6 +1,29 @@
-import { DocumentDataModel, IDocumentData, ILogContext, IWorkbookData, Workbook, ICommandService, Injector, IResourceManagerService, ISnapshotServerService, IUniverInstanceService } from '@univerjs/core';
+import { DocumentDataModel, IDocumentData, IWorkbookData, Workbook, ICommandService, Injector, IResourceManagerService, IUniverInstanceService } from '@univerjs/core';
+import { IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetRequest, ISaveChangesetResponse, ISaveSheetBlockRequest, ISaveSheetBlockResponse, ISaveSnapshotRequest, ISaveSnapshotResponse } from '@univerjs/protocol';
 import { CompressMutationService } from '../compress-mutation/compress-mutation-service';
 import { RevisionService } from '../rev/rev.service';
+import { ILogContext } from '../../utils';
+/**
+ * It provides implementations for server side controllers to load or save
+ * or load snapshots. This service should be implemented by the host environment.
+ * And it shouldn't contain any business logic.
+ */
+export declare const ISnapshotServerService: import('@univerjs/core').IdentifierDecorator<ISnapshotServerService>;
+export interface ISnapshotServerService {
+    /** 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>;
+    /** 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>;
+}
 /**
  * The service provides methods to load snapshots from the snapshot server.
  */

package/lib/types/utils.d.ts

@@ -1,3 +1,8 @@
 import { UniverInstanceType } from '@univerjs/core';
 import { UniverType } from '@univerjs/protocol';
 export declare function mapDocumentTypeToUniverType(documentType: UniverInstanceType): UniverType;
+export interface ILogContext {
+    metadata?: Record<string, string>;
+}
+export declare function b64EncodeUnicode(str: string): string;
+export declare function b64DecodeUnicode(str: string): string;