@univerjs/protocol 0.1.49 → 0.21.0

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

@@ -1,48 +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 = "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/universer/v1/toolkit.d.ts

@@ -1,23 +0,0 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-import { Error } from '../../univer/constants/errors';
-export declare const protobufPackage = "universer.v1";
-export interface PreviewLinkRequest {
-    url: string;
-}
-export interface PreviewLinkResponse {
-    /** only title now */
-    title: string;
-    error: Error | undefined;
-}
-export interface GetXfyunUrlRequest {
-}
-export interface GetXfyunUrlResponse {
-    error: Error | undefined;
-    /** 讯飞语音听写 WebSocket 鉴权 URL */
-    url: string;
-}
-export interface ToolkitService {
-    PreviewLink(request: PreviewLinkRequest, metadata?: Metadata): Observable<PreviewLinkResponse>;
-    GetXfyunUrl(request: GetXfyunUrlRequest, metadata?: Metadata): Observable<GetXfyunUrlResponse>;
-}

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

@@ -1,102 +0,0 @@
-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/universer/v1/uniscript.d.ts

@@ -1,104 +0,0 @@
-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/universer/v1/uniscript_logs.d.ts

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

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

@@ -1,65 +0,0 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-import { Error } from '../../univer/constants/errors';
-import { Uniscript } from './uniscript';
-export declare const protobufPackage = "universer.v1";
-export interface UniverGoTemplate {
-    templateId: string;
-    name: string;
-    description: string;
-    preview: string;
-    uniscripts: Uniscript[];
-    creator: string;
-    cover: string;
-}
-export interface CreateUniverGoTemplateRequest {
-    name: string;
-    description: string;
-    preview: string;
-    uniscripts: Uniscript[];
-    creator: string;
-    cover: string;
-}
-export interface CreateUniverGoTemplateResponse {
-    error: Error | undefined;
-    templateId: string;
-}
-export interface UpdateUniverGoTemplateRequest {
-    templateId: string;
-    name?: string | undefined;
-    description?: string | undefined;
-    preview?: string | undefined;
-    uniscripts: Uniscript[];
-    cover: string;
-}
-export interface UpdateUniverGoTemplateResponse {
-    error: Error | undefined;
-}
-export interface ListUniverGoTemplatesRequest {
-    templateIds: string[];
-}
-export interface ListUniverGoTemplatesResponse {
-    error: Error | undefined;
-    templates: UniverGoTemplate[];
-}
-export interface DeleteUniverGoTemplatesRequest {
-    templateIds: string[];
-}
-export interface DeleteUniverGoTemplatesResponse {
-    error: Error | undefined;
-}
-export interface CheckUpdatesRequest {
-}
-export interface CheckUpdatesResponse {
-    error: Error | undefined;
-    templateIds: string[];
-    /** timestamp in seconds */
-    timeOfLastUpdate: string;
-}
-export interface UniverGoTemplateService {
-    CreateUniverGoTemplate(request: CreateUniverGoTemplateRequest, metadata?: Metadata): Observable<CreateUniverGoTemplateResponse>;
-    UpdateUniverGoTemplate(request: UpdateUniverGoTemplateRequest, metadata?: Metadata): Observable<UpdateUniverGoTemplateResponse>;
-    ListUniverGoTemplates(request: ListUniverGoTemplatesRequest, metadata?: Metadata): Observable<ListUniverGoTemplatesResponse>;
-    DeleteUniverGoTemplates(request: DeleteUniverGoTemplatesRequest, metadata?: Metadata): Observable<DeleteUniverGoTemplatesResponse>;
-    CheckUpdates(request: CheckUpdatesRequest, metadata?: Metadata): Observable<CheckUpdatesResponse>;
-}

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

@@ -1,23 +0,0 @@
-export declare const protobufPackage = "universer.v1";
-export declare enum UserEventType {
-    UserEvent_None = 0,
-    /** UserEvent_Registered - UserRegisteredEvent */
-    UserEvent_Registered = 1,
-    UNRECOGNIZED = -1
-}
-export interface UserEvent {
-    eventId: string;
-    eventTime: number;
-    type: UserEventType;
-    /** json string of the real event */
-    data: string;
-}
-export interface UserRegisteredEvent {
-    userId: string;
-    registerTime: number;
-    maskedName: string;
-    maskedEmail: string;
-    maskedMobile: string;
-    channel: string;
-    referralCode: string;
-}

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

@@ -1,22 +0,0 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-import { Error } from '../../univer/constants/errors';
-export declare const protobufPackage = "universer.v1";
-export interface SetUserSettingsRequest {
-    /** user settings json */
-    settings: string;
-}
-export interface SetUserSettingsResponse {
-    error: Error | undefined;
-}
-export interface GetUserSettingsRequest {
-}
-export interface GetUserSettingsResponse {
-    /** user settings json */
-    settings: string;
-    error: Error | undefined;
-}
-export interface UserSettingsService {
-    GetUserSettings(request: GetUserSettingsRequest, metadata?: Metadata): Observable<GetUserSettingsResponse>;
-    SetUserSettings(request: SetUserSettingsRequest, metadata?: Metadata): Observable<SetUserSettingsResponse>;
-}

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

@@ -1,62 +0,0 @@
-import { Metadata } from '@grpc/grpc-js';
-import { Observable } from 'rxjs';
-export declare const protobufPackage = "universer.v1";
-export interface USIPUser {
-    userID: string;
-    name: string;
-    avatar: string;
-}
-export interface USIPSubject {
-    id: string;
-    name: string;
-    avatar: string;
-    type: string;
-}
-export interface USIPCollaborator {
-    subject: USIPSubject | undefined;
-    role: string;
-}
-export interface GetUSIPUsersRequest {
-    userIDs: string[];
-}
-export interface GetUSIPUsersResponse {
-    users: USIPUser[];
-}
-export interface GetUSIPCollaboratorsRequest {
-    unitIDs: string[];
-}
-export interface GetUSIPCollaboratorsResponse {
-    collaborators: GetUSIPCollaboratorsResponse_USIPUnitCollaborator[];
-}
-export interface GetUSIPCollaboratorsResponse_USIPUnitCollaborator {
-    unitID: string;
-    subjects: USIPCollaborator[];
-}
-/** GetRoleRequest should use header to pass user credential */
-export interface GetUSIPRoleRequest {
-    userID: string;
-    unitID: string;
-}
-export interface GetUSIPRoleResponse {
-    userID: string;
-    role: string;
-}
-/** VerifyCredentialRequest should use header to pass user credential */
-export interface VerifyUSIPCredentialRequest {
-}
-export interface VerifyUSIPCredentialResponse {
-    user: USIPUser | undefined;
-}
-export interface UpdateUnitEditTimeRequest {
-    unitID: string;
-    editTimeUnixMs: number;
-}
-export interface UpdateUnitEditTimeResponse {
-}
-export interface USIPService {
-    GetUsers(request: GetUSIPUsersRequest, metadata?: Metadata): Observable<GetUSIPUsersResponse>;
-    GetCollaborators(request: GetUSIPCollaboratorsRequest, metadata?: Metadata): Observable<GetUSIPCollaboratorsResponse>;
-    GetRole(request: GetUSIPRoleRequest, metadata?: Metadata): Observable<GetUSIPRoleResponse>;
-    VerifyCredential(request: VerifyUSIPCredentialRequest, metadata?: Metadata): Observable<VerifyUSIPCredentialResponse>;
-    UpdateUnitEditTime(request: UpdateUnitEditTimeRequest, metadata?: Metadata): Observable<UpdateUnitEditTimeResponse>;
-}