@univerjs/protocol 0.1.47-alpha.0 → 0.1.48

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

@@ -1,259 +0,0 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-import { Error } from '../univer/constants/errors';
-export declare const protobufPackage = "univerpro.v1";
-/** 数字过滤器枚举 */
-export declare enum NumberFilterEnum {
-    valueBetween = 0,
-    valueEqual = 1,
-    valueGreaterThan = 2,
-    valueGreaterThanOrEqual = 3,
-    valueLessThan = 4,
-    valueLessThanOrEqual = 5,
-    valueNotBetween = 6,
-    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;
-    workbookId: string;
-    worksheetId: string;
-    range: string;
-}
-export interface GetValuesResponse {
-    error: Error | undefined;
-    /** A matrix of values in JSON format. */
-    value: string;
-}
-export interface SetValueRequest {
-    sessionId: string;
-    waitForComputing: boolean;
-    workbookId: string;
-    worksheetId: string;
-    range: string;
-    /** A value in JSON format. */
-    value: string;
-}
-export interface SetValueResponse {
-    error: Error | undefined;
-    /** A matrix of values in JSON format. */
-    value: string;
-}
-export interface SetValuesRequest {
-    sessionId: string;
-    waitForComputing: boolean;
-    workbookId: string;
-    worksheetId: string;
-    range: string;
-    /** A matrix of values in JSON format. */
-    values: string;
-}
-export interface SetValuesResponse {
-    error: Error | undefined;
-    /** A matrix of values in JSON format. */
-    value: string;
-}
-export interface MergeRequest {
-    sessionId: string;
-    workbookId: string;
-    worksheetId: string;
-    range: string;
-}
-export interface MergeResponse {
-    error: Error | undefined;
-}
-export interface SetBorderRequest {
-    sessionId: string;
-    workbookId: string;
-    worksheetId: string;
-    range: string;
-    /** JSON serialized IBorderInfo. */
-    data: string;
-}
-export interface SetBorderResponse {
-    error: Error | undefined;
-}
-export interface SetBackgroundColorRequest {
-    sessionId: string;
-    workbookId: string;
-    worksheetId: string;
-    range: string;
-    color: string;
-}
-export interface SetBackgroundColorResponse {
-    error: Error | undefined;
-}
-export interface SetWorkbookNameRequest {
-    sessionId: string;
-    workbookId: string;
-    name: string;
-}
-export interface SetWorkbookNameResponse {
-    error: Error | undefined;
-}
-export interface CreateWorkbookRequest {
-    sessionId: string;
-    name: string;
-}
-export interface CreateWorkbookResponse {
-    error: Error | undefined;
-}
-export interface CloseSessionRequest {
-    sessionId: string;
-}
-export interface CloseSessionResponse {
-    error: Error | undefined;
-}
-export interface GetAggregationParamsRequest {
-    sessionId: string;
-    unitIds: string[];
-}
-export interface GetAggregationParamsResponse {
-    error: Error | undefined;
-    views: View[];
-}
-/** unit 维度的视图 */
-export interface View {
-    unitId: string;
-    /** 视图 */
-    views: ViewDetail[];
-    /** 方体 */
-    cuboids: Cuboid[];
-}
-/** 视图 */
-export interface ViewDetail {
-    id: string;
-    name: string;
-    description: string;
-    unitId: string;
-    /** multiple tables join */
-    tableIds: string[];
-    fields: Field[];
-}
-/** 方体 */
-export interface Cuboid {
-    id: string;
-    name: string;
-    description: string;
-    unitId: string;
-    /** multiple tables join */
-    tableId: string;
-    fields: Field[];
-}
-/** 字段 */
-export interface Field {
-    id: string;
-    /** multiple tables join */
-    tableId: string;
-    /** workbook id */
-    unitId: string;
-    name: string;
-    /** string, number, boolean, date */
-    type: string;
-    description: string;
-    /** only for type string */
-    dataItems: string[];
-}
-export interface RunAggregationRequest {
-    sessionId: string;
-    /** view id */
-    viewId: string;
-    /** workbook id */
-    unitId: string;
-    dimensions: Dimension[];
-    measures: Measure[];
-}
-export interface Measure {
-    /** field id */
-    id: string;
-    /** table id */
-    tableId: string;
-    /** sum, avg, count, max, min */
-    aggregation: string;
-}
-export interface Dimension {
-    /** field id */
-    fieldId: string;
-    /** table id */
-    tableId: string;
-    filterNumber: FilterNumber | undefined;
-    filterString: FilterString | undefined;
-}
-export interface FilterString {
-    /** filter string param */
-    list: string[];
-    /** select all */
-    isAll: boolean;
-}
-export interface FilterNumber {
-    operator: NumberFilterEnum;
-    value: number;
-    /** only for valueBetween */
-    values: number[];
-}
-/** 获取方体的请求 */
-export interface GetCuboidsByIdRequest {
-    sessionId: string;
-    /** view id, or cuboid id */
-    id: string;
-    /** workbook id */
-    unitId: string;
-}
-/** 方体的返回结果 */
-export interface GetCuboidsByIdResponse {
-    error: Error | undefined;
-    id: string;
-    unitId: string;
-    param: RunAggregationRequest | undefined;
-    cuboids: CuboidData[];
-}
-export interface CuboidData {
-    id: string;
-    name: string;
-    unitId: string;
-    /** JSON 化的数据矩阵，每一行是一个字符串数组 */
-    data: string;
-}
-/**
- * This service is used to get the SSC (Server-Side Computing) data for a given session.
- * It is implemented in Node.js. See `univer-pro/apps/univer-collaboration-server`.
- */
-export interface SSCService {
-    /**
-     * #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>;
-    Merge(request: MergeRequest, metadata?: Metadata): Observable<MergeResponse>;
-    SetBorder(request: SetBorderRequest, metadata?: Metadata): Observable<SetBorderResponse>;
-    SetBackgroundColor(request: SetBackgroundColorRequest, metadata?: Metadata): Observable<SetBackgroundColorResponse>;
-    SetWorkbookName(request: SetWorkbookNameRequest, metadata?: Metadata): Observable<SetWorkbookNameResponse>;
-    CreateWorkbook(request: CreateWorkbookRequest, metadata?: Metadata): Observable<CreateWorkbookResponse>;
-    /** Close the session and release resources allocated for this session. */
-    CloseSession(request: CloseSessionRequest, metadata?: Metadata): Observable<CloseSessionResponse>;
-    /** 获取视图或者方体的 meta 信息，让 AI 判断需要如何处理数据 */
-    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/lib/types/ts/v1/ssr.d.ts

@@ -1,25 +0,0 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-import { Error } from '../univer/constants/errors';
-import { UniverType } from '../univer/constants/univer';
-export declare const protobufPackage = "univerpro.v1";
-export interface GetSSRRequest {
-    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 GetSSRResponse {
-    error: Error | undefined;
-    /** PNG Image encoded in base64 format. */
-    imageEncoded: string;
-}
-/**
- * This service is used to get the SSR (Server-Side Rendering) data for a given
- * unit and maybe a given Worksheet as well.
- * It is implemented in Node.js. See `univer-pro/apps/univer-collaboration-server`.
- */
-export interface SSRService {
-    /** Get a snapshot with given `unitId` (perhaps with `subUnitId` as well) of its latest revision. */
-    GetSnapshot(request: GetSSRRequest, metadata?: Metadata): Observable<GetSSRResponse>;
-}