@univerjs/protocol 0.1.45 → 0.1.46-alpha.2

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

@@ -0,0 +1,238 @@
+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 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 {
+    /** 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>;
+}

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

@@ -0,0 +1,25 @@
+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>;
+}

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

@@ -0,0 +1,25 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../univer/constants/errors';
+export declare const protobufPackage = "universer.v1";
+export interface CreateSurveyRequest {
+    product: string;
+    email: string;
+    content: string;
+}
+export interface CreateSurveyResponse {
+    error: Error | undefined;
+}
+export interface CaptureEventRequest {
+    distinctId: string;
+    eventName: string;
+    /** a JSON string */
+    properties: string;
+}
+export interface CaptureEventResponse {
+    error: Error | undefined;
+}
+export interface SurveyService {
+    Create(request: CreateSurveyRequest, metadata?: Metadata): Observable<CreateSurveyResponse>;
+    CaptureEvent(request: CaptureEventRequest, metadata?: Metadata): Observable<CaptureEventResponse>;
+}

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

@@ -0,0 +1,48 @@
+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 = "universer.v1";
+export interface DeleteTemplateRequest {
+    templateId: string;
+}
+export interface DeleteTemplateResponse {
+    error: Error | undefined;
+}
+export interface GetTemplateRequest {
+    type: UniverType;
+    length: number;
+    lastLabel: string;
+    category: string;
+}
+export interface GetTemplateResponse {
+    error: Error | undefined;
+    hasMore: boolean;
+    lastLabel: string;
+    data: Template[];
+}
+export interface CreateTemplateRequest {
+    type: UniverType;
+    unitId: string;
+    name: string;
+    description: string;
+    coverImgUrl: string;
+    category: string;
+}
+export interface CreateTemplateResponse {
+    error: Error | undefined;
+    templateId: string;
+}
+export interface Template {
+    type: UniverType;
+    templateId: string;
+    name: string;
+    description: string;
+    coverImgUrl: string;
+    category: string;
+}
+export interface TemplateService {
+    GetTemplateList(request: GetTemplateRequest, metadata?: Metadata): Observable<GetTemplateResponse>;
+    CreateTemplate(request: CreateTemplateRequest, metadata?: Metadata): Observable<CreateTemplateResponse>;
+    DeleteTemplate(request: DeleteTemplateRequest, metadata?: Metadata): Observable<DeleteTemplateResponse>;
+}

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

@@ -0,0 +1,102 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../univer/constants/errors';
+import { ExecutionStatus, ExecutionTriggerType } from './uniscript_logs';
+export declare const protobufPackage = "universer.v1";
+export declare enum TriggerIntervalUnit {
+    UNDEFINED_Unit = 0,
+    SECOND = 1,
+    MINUTE = 2,
+    HOUR = 3,
+    DAY = 4,
+    WEEK = 5,
+    MONTH = 6,
+    YEAR = 7,
+    UNRECOGNIZED = -1
+}
+export declare enum TriggerStatus {
+    TriggerStatusEnable = 0,
+    TriggerStatusDISABLED = 1,
+    TriggerStatusDelete = 2,
+    UNRECOGNIZED = -1
+}
+export interface Trigger {
+    triggerId: string;
+    workspaceId: string;
+    /** scriptId, unitId etc */
+    sourceId: string;
+    triggerName: string;
+    functionName: string;
+    source: ExecutionTriggerType;
+    startTime: string;
+    endTime: string;
+    intervalTime: number;
+    intervalUnit: TriggerIntervalUnit;
+    description: string;
+    /** begin time, timestamp seconds */
+    lastRunTime: string;
+    lastRunResult: ExecutionStatus;
+    creator: string;
+    createTime: string;
+    updateTime: string;
+}
+export interface CreateTriggerRequest {
+    workspaceId: string;
+    sourceId: string;
+    triggerName: string;
+    functionName: string;
+    source: ExecutionTriggerType;
+    startTime: string;
+    endTime: string;
+    intervalTime: number;
+    intervalUnit: TriggerIntervalUnit;
+    description: string;
+}
+export interface CreateTriggerResponse {
+    error: Error | undefined;
+    triggerId: string;
+}
+export interface UpdateTriggerRequest {
+    triggerId: string;
+    sourceId?: string | undefined;
+    triggerName?: string | undefined;
+    functionName?: string | undefined;
+    source?: ExecutionTriggerType | undefined;
+    startTime?: string | undefined;
+    endTime?: string | undefined;
+    intervalTime?: number | undefined;
+    intervalUnit?: TriggerIntervalUnit | undefined;
+    description?: string | undefined;
+    /** only use enable/disable trigger */
+    status?: TriggerStatus | undefined;
+}
+export interface UpdateTriggerResponse {
+    error: Error | undefined;
+}
+export interface DeleteTriggersRequest {
+    triggerIds: string[];
+}
+export interface DeleteTriggersResponse {
+    error: Error | undefined;
+}
+export interface ListTriggersRequest {
+    workspaceId: string;
+}
+export interface ListTriggersResponse {
+    error: Error | undefined;
+    triggers: Trigger[];
+}
+export interface GetTriggerRequest {
+    triggerId: string;
+}
+export interface GetTriggerResponse {
+    error: Error | undefined;
+    trigger: Trigger | undefined;
+}
+export interface TriggerService {
+    CreateTrigger(request: CreateTriggerRequest, metadata?: Metadata): Observable<CreateTriggerResponse>;
+    UpdateTrigger(request: UpdateTriggerRequest, metadata?: Metadata): Observable<UpdateTriggerResponse>;
+    DeleteTriggers(request: DeleteTriggersRequest, metadata?: Metadata): Observable<DeleteTriggersResponse>;
+    ListTriggers(request: ListTriggersRequest, metadata?: Metadata): Observable<ListTriggersResponse>;
+    GetTrigger(request: GetTriggerRequest, metadata?: Metadata): Observable<GetTriggerResponse>;
+}

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

@@ -0,0 +1,104 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../univer/constants/errors';
+export declare const protobufPackage = "universer.v1";
+export declare enum UniscriptEnv {
+    UNDEFINED_ENV = 0,
+    NODE = 1,
+    BROWSER = 2,
+    PYTHON = 3,
+    /** REQUIREMENTS_TXT - requirements.txt for python */
+    REQUIREMENTS_TXT = 4,
+    /** WORKSPACE_ENV_VARS - script defined environment variables within the workspace */
+    WORKSPACE_ENV_VARS = 5,
+    UNRECOGNIZED = -1
+}
+export interface InstallPackagesRequest {
+    workspaceId: string;
+}
+export interface InstallPackagesResponse {
+    error: Error | undefined;
+    status: string;
+    message: string;
+}
+export interface Uniscript {
+    scriptId: string;
+    workspaceId: string;
+    name: string;
+    script: string;
+    env: UniscriptEnv;
+    creator: string;
+}
+export interface CreateUniscriptRequest {
+    workspaceId: string;
+    name: string;
+    script: string;
+    env: UniscriptEnv;
+}
+export interface CreateUniscriptResponse {
+    error: Error | undefined;
+    scriptId: string;
+}
+export interface UpdateUniscriptRequest {
+    scriptId: string;
+    script?: string | undefined;
+    name?: string | undefined;
+}
+export interface UpdateUniscriptResponse {
+    error: Error | undefined;
+}
+export interface ListUniscriptsRequest {
+    workspaceId?: string | undefined;
+    scriptIds: string[];
+    unitId?: string | undefined;
+    env?: UniscriptEnv | undefined;
+}
+export interface ListUniscriptsResponse {
+    error: Error | undefined;
+    uniscripts: Uniscript[];
+}
+export interface DeleteUniscriptsRequest {
+    scriptIds: string[];
+}
+export interface DeleteUniscriptsResponse {
+    error: Error | undefined;
+}
+export interface RunUniscriptRequest {
+    /** find script by scriptId or scriptName */
+    scriptId: string;
+    scriptName: string;
+    /** ONLY run SERVER script in IDE do not need unitId */
+    unitId: string;
+    /**
+     * runId is required if you want to run uniscript on browser context;
+     * runId is optional if you want to run uniscript on node context
+     */
+    runId: string;
+    /** name of function to run */
+    function: string;
+    /**
+     * argsOfFunction is a json string, it should be a list of arguments
+     * e.g. '[123, "hello", true, {"a": 1, "b": 2}]'
+     */
+    argsOfFunction?: string | undefined;
+    /** executionId, unique id of one execution, pass this id for execution logs record. */
+    executionId: string;
+    /** when client script invoke server script, use invokeId to associate their logs. */
+    invokeId: string;
+    /** env, not used now. */
+    env: UniscriptEnv;
+    /** is a string of compiled scrip */
+    compiledScript: string;
+}
+export interface RunUniscriptResponse {
+    error: Error | undefined;
+    result: string;
+}
+export interface UniscriptService {
+    CreateUniscript(request: CreateUniscriptRequest, metadata?: Metadata): Observable<CreateUniscriptResponse>;
+    UpdateUniscript(request: UpdateUniscriptRequest, metadata?: Metadata): Observable<UpdateUniscriptResponse>;
+    ListUniscripts(request: ListUniscriptsRequest, metadata?: Metadata): Observable<ListUniscriptsResponse>;
+    DeleteUniscripts(request: DeleteUniscriptsRequest, metadata?: Metadata): Observable<DeleteUniscriptsResponse>;
+    RunUniscript(request: RunUniscriptRequest, metadata?: Metadata): Observable<RunUniscriptResponse>;
+    InstallPackages(request: InstallPackagesRequest, metadata?: Metadata): Observable<InstallPackagesResponse>;
+}

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

@@ -0,0 +1,157 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../univer/constants/errors';
+export declare const protobufPackage = "universer.v1";
+export declare enum ExecutionTriggerType {
+    ExecutionTriggerType_None = 0,
+    /** ExecutionTriggerType_IDE - trigger by IDE debug/run */
+    ExecutionTriggerType_IDE = 1,
+    /** ExecutionTriggerType_UI - trigger by self-designed UI components */
+    ExecutionTriggerType_UI = 2,
+    /** ExecutionTriggerType_HOOKS - trigger by pre-designed hooks */
+    ExecutionTriggerType_HOOKS = 3,
+    /** ExecutionTriggerType_TriggerCron - triggered by triggerCron */
+    ExecutionTriggerType_TriggerCron = 4,
+    /** ExecutionTriggerType_TriggerSheet - triggered by triggerSheet */
+    ExecutionTriggerType_TriggerSheet = 5,
+    UNRECOGNIZED = -1
+}
+export declare enum ExecutionStatus {
+    ExecutionStatus_None = 0,
+    ExecutionStatus_Executing = 1,
+    ExecutionStatus_Success = 2,
+    ExecutionStatus_Fail = 3,
+    ExecutionStatus_Cancelled = 4,
+    ExecutionStatus_Timeout = 5,
+    UNRECOGNIZED = -1
+}
+export declare enum LogSource {
+    LogSource_None = 0,
+    LogSource_ClientScript = 1,
+    LogSource_NodeScript = 2,
+    LogSource_PythonScript = 3,
+    UNRECOGNIZED = -1
+}
+export declare enum ExecutionEvent {
+    ExecutionEvent_None = 0,
+    /** ExecutionEvent_Begin - execution begin */
+    ExecutionEvent_Begin = 1,
+    /** ExecutionEvent_Success - execution completed success */
+    ExecutionEvent_Success = 2,
+    /** ExecutionEvent_Fail - execution complete with fail */
+    ExecutionEvent_Fail = 3,
+    /** ExecutionEvent_Cancelled - execution cancelled */
+    ExecutionEvent_Cancelled = 4,
+    /** ExecutionEvent_Timeout - execute timeout & killed */
+    ExecutionEvent_Timeout = 5,
+    UNRECOGNIZED = -1
+}
+export interface Execution {
+    executionId: string;
+    triggerType: ExecutionTriggerType;
+    workspaceId: string;
+    functionName: string;
+    /** should set triggerId if triggerType in(TriggerCron, TriggerSheet) */
+    triggerId: string;
+    /** timestamp milli-seconds */
+    beginTime: string;
+    /** timestamp milli-seconds */
+    endTime: string;
+    /** DO NOT set this field when call UpsertExecution */
+    status: ExecutionStatus;
+}
+export interface LogEntry {
+    executionId: string;
+    source: LogSource;
+    /**
+     * should generate a log with non-empty invokeId
+     * when client script call server script,
+     * otherwise, left it's empty
+     */
+    invokeId: string;
+    /**
+     * when server script called by client script
+     * fill the parentInvokeId with the invokeId of the system script call log.
+     */
+    parentInvokeId: string;
+    /**
+     * timestamp of the log entry generated
+     * precision: milli-seconds
+     */
+    timestamp: string;
+    level: string;
+    /** raw log entry message */
+    message: string;
+    /** extra infos explain by js/python it's self. */
+    extra: string;
+}
+export interface UpsertExecutionRequest {
+    event: ExecutionEvent;
+    execution: Execution | undefined;
+}
+export interface UpsertExecutionResponse {
+    error: Error | undefined;
+}
+export interface AppendExecutionLogsRequest {
+    logs: LogEntry[];
+}
+export interface AppendExecutionLogsResponse {
+    error: Error | undefined;
+}
+export interface ListExecutionsRequest {
+    /** workspaceId is needed */
+    workspaceId: string;
+    /**
+     * execution time range, timestamp seconds
+     * empty means no limit, end should GE begin.
+     */
+    timeRangeBegin: string;
+    timeRangeEnd: string;
+    status: ExecutionStatus[];
+    triggerTypes: ExecutionTriggerType[];
+    triggerId: string;
+    functionName: string;
+    /** pageNo, start with 1. */
+    pageNo: number;
+    pageSize: number;
+}
+export interface ListExecutionsResponse {
+    executions: Execution[];
+    totalCnt: number;
+    error: Error | undefined;
+}
+export interface ListExecutionLogsRequest {
+    executionId: string;
+    /** batchId, 1st batch set empty */
+    batchId: string;
+}
+export interface ListExecutionLogsResponse {
+    logs: LogEntry[];
+    hasMore: boolean;
+    /** if hasMore=true, return nextBatchId */
+    nextBatchId: string;
+    error: Error | undefined;
+}
+export interface GetExecutionProgressRequest {
+    executionId: string;
+    /** logsPoint fetched to, set to empty in the 1st query */
+    logsPoint: string;
+}
+export interface GetExecutionProgressResponse {
+    /** newest execution data */
+    execution: Execution | undefined;
+    /** newly logs */
+    newlyLogs: LogEntry[];
+    /** nextLogsPoint, use this point in the next query. */
+    nextLogsPoint: string;
+    error: Error | undefined;
+}
+export interface UniscriptLogService {
+    UpsertExecution(request: UpsertExecutionRequest, metadata?: Metadata): Observable<UpsertExecutionResponse>;
+    AppendExecutionLogs(request: AppendExecutionLogsRequest, metadata?: Metadata): Observable<AppendExecutionLogsResponse>;
+    /** order by execution start-time desc default. */
+    ListExecutions(request: ListExecutionsRequest, metadata?: Metadata): Observable<ListExecutionsResponse>;
+    /** order by log time asc default. */
+    ListExecutionLogs(request: ListExecutionLogsRequest, metadata?: Metadata): Observable<ListExecutionLogsResponse>;
+    GetExecutionProgress(request: GetExecutionProgressRequest, metadata?: Metadata): Observable<GetExecutionProgressResponse>;
+}