@univerjs/protocol 0.1.45 → 0.1.46-alpha.2

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

@@ -0,0 +1,26 @@
+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 FeedbackType {
+    FeedbackType_None = 0,
+    FeedbackType_Others = 1,
+    FeedbackType_Feature = 2,
+    FeedbackType_Bug = 3,
+    FeedbackType_AIImprovement = 4,
+    UNRECOGNIZED = -1
+}
+export interface SubmitFeedbackRequest {
+    contactName: string;
+    contactEmail: string;
+    type: FeedbackType;
+    subject: string;
+    content: string;
+}
+export interface SubmitFeedbackResponse {
+    feedbackId: string;
+    error: Error | undefined;
+}
+export interface FeedbackService {
+    SubmitFeedback(request: SubmitFeedbackRequest, metadata?: Metadata): Observable<SubmitFeedbackResponse>;
+}

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

@@ -12,6 +12,8 @@ export declare enum FileSource {
     UnitEmbedded = 3,
     /** UnitSnapshot - assign UnitID */
     UnitSnapshot = 4,
+    /** UserProfileImg - assign UserID */
+    UserProfileImg = 5,
     UNRECOGNIZED = -1
 }
 export declare enum DownloadUrlMode {

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

@@ -0,0 +1,91 @@
+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 ConfigScopeType {
+    ConfigScopeType_None = 0,
+    ConfigScopeType_Workspace = 1,
+    ConfigScopeType_AddOns = 2,
+    UNRECOGNIZED = -1
+}
+export interface ConfigEntry {
+    workspaceId: string;
+    scopeType: ConfigScopeType;
+    /**
+     * scopeId, no need to set this field when scopeType is Workspace
+     * set to add-on ID when scopeType is AddOns
+     */
+    scopeId: string;
+    key: string;
+    val: string;
+    /** desc, explain what this key is used for, and how to set it. */
+    desc: string;
+}
+export interface MSetConfigsRequest {
+    configs: ConfigEntry[];
+}
+export interface MSetConfigsResponse {
+    error: Error | undefined;
+}
+export interface GetConfigByKeyRequest {
+    workspaceId: string;
+    scopeType: ConfigScopeType;
+    /**
+     * scopeId, no need to set this field when scopeType is Workspace
+     * set to add-on ID when scopeType is AddOns
+     */
+    scopeId: string;
+    key: string;
+}
+export interface GetConfigByKeyResponse {
+    /** indicates whether this key exists. */
+    exists: boolean;
+    /** if key exists, return the value. */
+    config: ConfigEntry | undefined;
+    error: Error | undefined;
+}
+export interface GetConfigsByScopeRequest {
+    workspaceId: string;
+    scopeType: ConfigScopeType;
+    /**
+     * scopeId, no need to set this field when scopeType is Workspace
+     * set to add-on ID when scopeType is AddOns
+     */
+    scopeId: string;
+}
+export interface GetConfigsByScopeResponse {
+    configs: ConfigEntry[];
+    error: Error | undefined;
+}
+export interface DeleteConfigByKeyRequest {
+    workspaceId: string;
+    scopeType: ConfigScopeType;
+    /**
+     * scopeId, no need to set this field when scopeType is Workspace
+     * set to add-on ID when scopeType is AddOns
+     */
+    scopeId: string;
+    key: string;
+}
+export interface DeleteConfigByKeyResponse {
+    error: Error | undefined;
+}
+export interface DeleteConfigsByScopeRequest {
+    workspaceId: string;
+    scopeType: ConfigScopeType;
+    /**
+     * scopeId, no need to set this field when scopeType is Workspace
+     * set to add-on ID when scopeType is AddOns
+     */
+    scopeId: string;
+}
+export interface DeleteConfigsByScopeResponse {
+    error: Error | undefined;
+}
+export interface GoConfigService {
+    MSetConfigs(request: MSetConfigsRequest, metadata?: Metadata): Observable<MSetConfigsResponse>;
+    GetConfigByKey(request: GetConfigByKeyRequest, metadata?: Metadata): Observable<GetConfigByKeyResponse>;
+    GetConfigsByScope(request: GetConfigsByScopeRequest, metadata?: Metadata): Observable<GetConfigsByScopeResponse>;
+    DeleteConfigByKey(request: DeleteConfigByKeyRequest, metadata?: Metadata): Observable<DeleteConfigByKeyResponse>;
+    DeleteConfigsByScope(request: DeleteConfigsByScopeRequest, metadata?: Metadata): Observable<DeleteConfigsByScopeResponse>;
+}

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

@@ -0,0 +1,47 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../univer/constants/errors';
+export declare const protobufPackage = "universer.v1";
+export interface VerifyInviteCodeRequest {
+    inviteCode: string;
+    feature: string;
+}
+export interface VerifyInviteCodeResponse {
+    error: Error | undefined;
+}
+export interface GenerateInviteCodeRequest {
+    length: number;
+    feature: string;
+}
+export interface GenerateInviteCodeResponse {
+    inviteCode: string[];
+    error: Error | undefined;
+}
+export interface UserInviteCodeRequest {
+    feature: string;
+}
+export interface UserInviteCodeResponse {
+    error: Error | undefined;
+}
+export interface BindInviteCodeRequest {
+    inviteCode: string;
+    feature: string;
+}
+export interface BindInviteCodeResponse {
+    error: Error | undefined;
+}
+export interface ApplyForInvitationCodeRequest {
+    feature: string;
+    content: string;
+    email: string;
+}
+export interface ApplyForInvitationCodeResponse {
+    error: Error | undefined;
+}
+export interface InviteCodeService {
+    VerifyInviteCode(request: VerifyInviteCodeRequest, metadata?: Metadata): Observable<VerifyInviteCodeResponse>;
+    GenerateInviteCode(request: GenerateInviteCodeRequest, metadata?: Metadata): Observable<GenerateInviteCodeResponse>;
+    UserInviteCode(request: UserInviteCodeRequest, metadata?: Metadata): Observable<UserInviteCodeResponse>;
+    BindInviteCode(request: BindInviteCodeRequest, metadata?: Metadata): Observable<BindInviteCodeResponse>;
+    ApplyForInvitationCode(request: ApplyForInvitationCodeRequest, metadata?: Metadata): Observable<ApplyForInvitationCodeResponse>;
+}

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

@@ -0,0 +1,35 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../univer/constants/errors';
+export declare const protobufPackage = "universer.v1";
+export interface GetLicenseQuotasRequest {
+    data: string;
+}
+export interface GetLicenseQuotasResponse {
+    error: Error | undefined;
+    data: string;
+}
+export interface GetUserLicenseRequest {
+}
+export interface GetUserLicenseResponse {
+    error: Error | undefined;
+    license: string;
+    /**
+     * deprecated license key
+     *
+     * @deprecated
+     */
+    key: string;
+    /** license id */
+    id1: string;
+    /** user id */
+    id2: string;
+    /** license type */
+    type: string;
+    /** true - report /false - not report */
+    isReport: boolean;
+}
+export interface LicenseService {
+    GetQuotas(request: GetLicenseQuotasRequest, metadata?: Metadata): Observable<GetLicenseQuotasResponse>;
+    GetLicense(request: GetUserLicenseRequest, metadata?: Metadata): Observable<GetUserLicenseResponse>;
+}

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

@@ -0,0 +1,103 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../univer/constants/errors';
+import { ReleaseType } from './conf';
+export declare const protobufPackage = "universer.v1";
+export interface GetLicenseByManagerRequest {
+    licenseId: string;
+}
+export interface GetLicenseByManagerResponse {
+    error: Error | undefined;
+    license: LicenseDetail | undefined;
+}
+export interface Page {
+    pageNum: number;
+    pageSize: number;
+    pageCount: number;
+    total: number;
+}
+export interface CreateLicenseRequest {
+}
+export interface CreateLicenseResponse {
+    error: Error | undefined;
+    license: string;
+}
+export interface LicensePageRequest {
+    page: Page | undefined;
+    email: string;
+}
+export interface LicensePageResponse {
+    error: Error | undefined;
+    page: Page | undefined;
+    license: LicenseDetail[];
+}
+export interface LicenseDetail {
+    id: string;
+    args: string;
+    license: string;
+}
+export interface GetLicenseRequest {
+}
+export interface GetLicenseResponse {
+    error: Error | undefined;
+    expirationTime: number;
+    createdTime: number;
+    license: string;
+}
+export interface DownloadLicenseRequest {
+}
+export interface DownloadLicenseResponse {
+    error: Error | undefined;
+}
+export interface DeployAccessRequest {
+    email: string;
+}
+export interface DeployAccessResponse {
+    error: Error | undefined;
+}
+export interface CliAuthCreateTokenRequest {
+}
+export interface CliAuthCreateTokenResponse {
+    error: Error | undefined;
+    token: string;
+}
+export interface CliAuthVerifyTokenRequest {
+    source: string;
+    token: string;
+}
+export interface CliAuthVerifyTokenResponse {
+    error: Error | undefined;
+    userId: string;
+    userName: string;
+}
+export interface CreateLicenseByManagerRequest {
+    detail: string;
+    userId: string;
+    domain: string[];
+    expirationTime: number;
+    releaseType: ReleaseType;
+    feature: {
+        [key: number]: number;
+    };
+    userScale?: number | undefined;
+    sheetImportExportConcurrency: number;
+    docImportExportConcurrency: number;
+}
+export interface CreateLicenseByManagerRequest_FeatureEntry {
+    key: number;
+    value: number;
+}
+export interface CreateLicenseByManagerResponse {
+    error: Error | undefined;
+}
+export interface LicenseManageService {
+    GetLicensePage(request: LicensePageRequest, metadata?: Metadata): Observable<LicensePageResponse>;
+    /** create commercial30days license */
+    CreateLicense(request: CreateLicenseRequest, metadata?: Metadata): Observable<CreateLicenseResponse>;
+    CreateLicenseByManager(request: CreateLicenseByManagerRequest, metadata?: Metadata): Observable<CreateLicenseByManagerResponse>;
+    GetLicenseByManager(request: GetLicenseByManagerRequest, metadata?: Metadata): Observable<GetLicenseByManagerResponse>;
+    GetLicense(request: GetLicenseRequest, metadata?: Metadata): Observable<GetLicenseResponse>;
+    DeployAccess(request: DeployAccessRequest, metadata?: Metadata): Observable<DeployAccessResponse>;
+    CliAuthCreateToken(request: CliAuthCreateTokenRequest, metadata?: Metadata): Observable<CliAuthCreateTokenResponse>;
+    CliAuthVerifyToken(request: CliAuthVerifyTokenRequest, metadata?: Metadata): Observable<CliAuthVerifyTokenResponse>;
+}

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

@@ -0,0 +1,24 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../univer/constants/errors';
+export declare const protobufPackage = "universer.v1";
+export interface Oauth2PageRequest {
+    url: string;
+}
+export interface Oauth2PageResponse {
+    error: Error | undefined;
+    redirectUri: string;
+}
+export interface Oauth2CallbackRequest {
+    code: string;
+    state: string;
+    redirectUri: string;
+}
+export interface Oauth2CallbackResponse {
+    error: Error | undefined;
+    redirectUri: string;
+}
+export interface Oauth2Service {
+    AuthPage(request: Oauth2PageRequest, metadata?: Metadata): Observable<Oauth2PageResponse>;
+    AuthCallback(request: Oauth2CallbackRequest, metadata?: Metadata): Observable<Oauth2CallbackResponse>;
+}

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

@@ -0,0 +1,80 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../univer/constants/errors';
+export declare const protobufPackage = "universer.v1";
+export interface AuthRedirectRequest {
+    url: string;
+}
+export interface AuthRedirectResponse {
+    error: Error | undefined;
+    redirectUri: string;
+}
+export interface AuthCallbackRequest {
+    code: string;
+    state: string;
+    redirectUri: string;
+}
+export interface AuthCallbackResponse {
+    error: Error | undefined;
+    redirectUri: string;
+}
+export interface EmailLoginRequest {
+    email: string;
+    url: string;
+    state: string;
+}
+export interface EmailLoginResponse {
+    error: Error | undefined;
+}
+export interface EmailCallbackRequest {
+    code: string;
+    state: string;
+    redirectUri: string;
+}
+export interface EmailCallbackResponse {
+    error: Error | undefined;
+    redirectUri: string;
+}
+export interface MobileLoginRequest {
+    phone: string;
+}
+export interface MobileLoginResponse {
+    error: Error | undefined;
+}
+export interface VerifyMobileStatusRequest {
+    phone: string;
+    code: string;
+    state: string;
+}
+export interface VerifyMobileStatusResponse {
+    code: string;
+    inviteCode: string;
+    error: Error | undefined;
+}
+export interface MobileCallbackRequest {
+    url: string;
+    code: string;
+    state: string;
+}
+export interface MobileCallbackResponse {
+    redirectUri: string;
+    error: Error | undefined;
+}
+export interface WechatCallbackRequest {
+    code: string;
+    state: string;
+}
+export interface WechatCallbackResponse {
+    error: Error | undefined;
+    redirectUri: string;
+}
+export interface OIDCService {
+    AuthRedirect(request: AuthRedirectRequest, metadata?: Metadata): Observable<AuthRedirectResponse>;
+    AuthCallback(request: AuthCallbackRequest, metadata?: Metadata): Observable<AuthCallbackResponse>;
+    EmailLogin(request: EmailLoginRequest, metadata?: Metadata): Observable<EmailLoginResponse>;
+    EmailCallback(request: EmailCallbackRequest, metadata?: Metadata): Observable<EmailCallbackResponse>;
+    MobileLogin(request: MobileLoginRequest, metadata?: Metadata): Observable<MobileLoginResponse>;
+    VerifyMobileStatus(request: VerifyMobileStatusRequest, metadata?: Metadata): Observable<VerifyMobileStatusResponse>;
+    MobileCallback(request: MobileCallbackRequest, metadata?: Metadata): Observable<MobileCallbackResponse>;
+    WechatCallback(request: WechatCallbackRequest, metadata?: Metadata): Observable<WechatCallbackResponse>;
+}

package/lib/types/ts/v1/source_connector/api.d.ts

@@ -0,0 +1,110 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+export declare const protobufPackage = "universer.v1.source_connector";
+export interface ModelConnector {
+    uuid: string;
+    config: string;
+    name: string;
+}
+export interface ModelStreamView {
+    uuid: string;
+    config: string;
+    name: string;
+}
+export interface ModelDisplayer {
+    uuid: string;
+    config: string;
+    name: string;
+}
+export interface CreateConnectorRequest {
+    config: string;
+    name: string;
+}
+export interface CreateConnectorResponse {
+}
+export interface ListConnectorsRequest {
+    all: boolean;
+    uuids: string[];
+}
+export interface ListConnectorsResponse {
+    connectors: ModelConnector[];
+}
+export interface UpdateConnectorRequest {
+    uuid: string;
+    config: string;
+    name: string;
+}
+export interface UpdateConnectorResponse {
+}
+export interface DeleteConnectorRequest {
+    uuid: string;
+}
+export interface DeleteConnectorResponse {
+}
+export interface CreateStreamViewRequest {
+    config: string;
+}
+export interface CreateStreamViewResponse {
+}
+export interface ListStreamViewsRequest {
+    all: boolean;
+    uuids: string[];
+}
+export interface ListStreamViewsResponse {
+    streamViews: ModelStreamView[];
+}
+export interface UpdateStreamViewRequest {
+    uuid: string;
+    config: string;
+}
+export interface UpdateStreamViewResponse {
+}
+export interface DeleteStreamViewRequest {
+    uuid: string;
+}
+export interface DeleteStreamViewResponse {
+}
+export interface StreamViewTestRequest {
+    config: string;
+}
+export interface StreamViewTestResponse {
+    result: string;
+}
+export interface CreateDisplayerRequest {
+    config: string;
+}
+export interface CreateDisplayerResponse {
+}
+export interface ListDisplayersRequest {
+    all: boolean;
+    uuids: string[];
+}
+export interface ListDisplayersResponse {
+    displayers: ModelDisplayer[];
+}
+export interface UpdateDisplayerRequest {
+    uuid: string;
+    config: string;
+}
+export interface UpdateDisplayerResponse {
+}
+export interface DeleteDisplayerRequest {
+    uuid: string;
+}
+export interface DeleteDisplayerResponse {
+}
+export interface ConnectorService {
+    CreateConnector(request: CreateConnectorRequest, metadata?: Metadata): Observable<CreateConnectorResponse>;
+    ListConnectors(request: ListConnectorsRequest, metadata?: Metadata): Observable<ListConnectorsResponse>;
+    UpdateConnector(request: UpdateConnectorRequest, metadata?: Metadata): Observable<UpdateConnectorResponse>;
+    DeleteConnector(request: DeleteConnectorRequest, metadata?: Metadata): Observable<DeleteConnectorResponse>;
+    CreateStreamView(request: CreateStreamViewRequest, metadata?: Metadata): Observable<CreateStreamViewResponse>;
+    ListStreamViews(request: ListStreamViewsRequest, metadata?: Metadata): Observable<ListStreamViewsResponse>;
+    UpdateStreamView(request: UpdateStreamViewRequest, metadata?: Metadata): Observable<UpdateStreamViewResponse>;
+    DeleteStreamView(request: DeleteStreamViewRequest, metadata?: Metadata): Observable<DeleteStreamViewResponse>;
+    StreamViewTest(request: StreamViewTestRequest, metadata?: Metadata): Observable<StreamViewTestResponse>;
+    CreateDisplayer(request: CreateDisplayerRequest, metadata?: Metadata): Observable<CreateDisplayerResponse>;
+    ListDisplayers(request: ListDisplayersRequest, metadata?: Metadata): Observable<ListDisplayersResponse>;
+    UpdateDisplayer(request: UpdateDisplayerRequest, metadata?: Metadata): Observable<UpdateDisplayerResponse>;
+    DeleteDisplayer(request: DeleteDisplayerRequest, metadata?: Metadata): Observable<DeleteDisplayerResponse>;
+}

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

@@ -0,0 +1,29 @@
+import { Airtable, BigQuery, GoogleSheet, Mysql, Notion, Postgresql, Salesforce, SpacexApi } from './source';
+export declare const protobufPackage = "universer.v1.source_connector";
+export interface ConnectorConfig {
+    connector: Connector | undefined;
+    streams: Stream[];
+}
+export interface Connector {
+    type: string;
+    schedule: string;
+    postgresql?: Postgresql | undefined;
+    mysql?: Mysql | undefined;
+    airtable?: Airtable | undefined;
+    googleSheet?: GoogleSheet | undefined;
+    salesforce?: Salesforce | undefined;
+    notion?: Notion | undefined;
+    bigquery?: BigQuery | undefined;
+    spacexApi?: SpacexApi | undefined;
+}
+export interface StreamSchema {
+    name: string;
+    displayName: string;
+    type: string;
+    value: string[];
+}
+export interface Stream {
+    name: string;
+    displayName: string;
+    schema: StreamSchema[];
+}

package/lib/types/ts/v1/source_connector/displayer.d.ts

@@ -0,0 +1,16 @@
+export declare const protobufPackage = "universer.v1.source_connector";
+export interface DisplayerConfig {
+    type: string;
+    name: string;
+    uuid: string;
+    nodes: Node[];
+}
+export interface Node {
+    name: string;
+    child: Node[];
+    views: View[];
+}
+export interface View {
+    viewID: string;
+    name: string;
+}

package/lib/types/ts/v1/source_connector/source.d.ts

@@ -0,0 +1,46 @@
+export declare const protobufPackage = "universer.v1.source_connector";
+export interface Postgresql {
+    host: string;
+    port: number;
+    schema: string;
+    database: string;
+    username: string;
+    password: string;
+    replicationMethod: Postgresql_ReplicationMethod | undefined;
+}
+export interface Postgresql_ReplicationMethod {
+    method: string;
+    replicationSlot: string;
+    publication: string;
+}
+export interface Mysql {
+    host: string;
+    port: number;
+    database: string;
+    username: string;
+    password: string;
+}
+export interface Airtable {
+    token: string;
+}
+export interface GoogleSheet {
+    sheetShareUrl: string;
+    serviceAccountInfo: string;
+}
+export interface Salesforce {
+    clientID: string;
+    clientSecret: string;
+    refreshToken: string;
+}
+export interface Notion {
+    token: string;
+}
+export interface BigQuery {
+    projectID: string;
+    datasetID: string;
+    credentialsJson: string;
+}
+export interface SpacexApi {
+    clientID: string;
+    options: string;
+}

package/lib/types/ts/v1/source_connector/stream_view.d.ts

@@ -0,0 +1,31 @@
+export declare const protobufPackage = "universer.v1.source_connector";
+export interface StreamViewConfig {
+    info: StreamViewInfo | undefined;
+    select: SelectColumn[];
+    where: WhereGroup[];
+    sql: string;
+}
+export interface StreamViewInfo {
+    name: string;
+    uuid: string;
+}
+export interface SelectColumn {
+    name: string;
+    value: string;
+}
+export interface WhereGroup {
+    group: string;
+    name: string;
+    conditions: WhereCondition[];
+}
+export interface WhereCondition {
+    column: string;
+    name: string;
+    type: string;
+    sql: string;
+    radio: WhereRadio[];
+}
+export interface WhereRadio {
+    name: string;
+    value: string;
+}