@univerjs/protocol 0.1.46-alpha.0 → 0.1.46-alpha.2

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

@@ -0,0 +1,424 @@
+import { Duration } from '../google/protobuf/duration';
+export declare const protobufPackage = "universer.v1";
+export declare enum ReleaseType {
+    UNKNOWN_TYPE = 0,
+    DEV = 1,
+    NON_COMMERCIAL = 2,
+    COMMERCIAL = 3,
+    UniverGO = 4,
+    UNRECOGNIZED = -1
+}
+export declare enum FeatureType {
+    UNKNOWN_FEATURE = 0,
+    UNIT_FEATURE = 1,
+    SHEET_FEATURE = 2,
+    DOC_FEATURE = 3,
+    SLIDE_FEATURE = 4,
+    WORKSPACE_FEATURE = 5,
+    UNRECOGNIZED = -1
+}
+export interface Bootstrap {
+    server: Server | undefined;
+    data: Data | undefined;
+    service: Service | undefined;
+    admin: Admin[];
+    extra: ExtraConf | undefined;
+    auth: Auth | undefined;
+    apiLimit: ApiLimit | undefined;
+    sentryConfig: SentryConfig | undefined;
+    usip: USIP | undefined;
+    dataProtectionConf: DataProtectionConf | undefined;
+    sesConfig: SESConf | undefined;
+    workspace: WorkspaceConf | undefined;
+    postHogConf: PostHogConf | undefined;
+    entitlementConf: EntitlementConf | undefined;
+    statsConf: StatsConf | undefined;
+    jaegerConf: JaegerConf | undefined;
+    scriptLogsConf: ScriptLogsConf | undefined;
+    smsConf: SMSConf | undefined;
+    invitationCode: InvitationCode | undefined;
+    models: ModelConf[];
+    wechat: Wechat | undefined;
+}
+export interface Server {
+    http: Server_HTTP | undefined;
+    grpc: Server_GRPC | undefined;
+}
+export interface Server_HTTP {
+    network: string;
+    addr: string;
+    timeout: Duration | undefined;
+    corsAllowOrigins: string[];
+}
+export interface Server_GRPC {
+    network: string;
+    addr: string;
+    timeout: Duration | undefined;
+}
+export interface S3 {
+    accessKeyID: string;
+    accessKeySecret: string;
+    region: string;
+    endpoint: string;
+    endpointPublic: string;
+    usePathStyle: boolean;
+    presignExpires: Duration | undefined;
+    defaultBucket: string;
+    /** bool useDownloadProxy = 9; */
+    publicBucket: string;
+}
+export interface Data {
+    database: Data_Database | undefined;
+    redis: Data_Redis | undefined;
+    rabbitmq: Data_Rabbitmq | undefined;
+    clickhouse: Data_Clickhouse | undefined;
+    temporal: Data_Temporal | undefined;
+    s3: S3 | undefined;
+}
+export interface Data_Database {
+    driver: string;
+    database: string;
+    dsn: string;
+    maxOpenConns: number;
+    maxIdleConns: number;
+    connMaxLifetime: number;
+    replicaDSN: string;
+}
+export interface Data_Redis {
+    network: string;
+    /** if cluster use comma to split */
+    addr: string;
+    readTimeout: Duration | undefined;
+    writeTimeout: Duration | undefined;
+    sentinel: Data_Redis_Sentinel | undefined;
+    db: number;
+    username: string;
+    password: string;
+    poolSize: number;
+}
+export interface Data_Redis_Sentinel {
+    enabled: boolean;
+    masterName: string;
+    sentinelAddr: string;
+    username: string;
+    password: string;
+}
+export interface Data_Rabbitmq {
+    addr: string;
+    cluster: Data_Rabbitmq_Cluster | undefined;
+    eventSync: boolean;
+    enabled: boolean;
+}
+export interface Data_Rabbitmq_Cluster {
+    enabled: boolean;
+    username: string;
+    password: string;
+    /** use comma to split */
+    addr: string;
+    vhost: string;
+    schema: string;
+}
+export interface Data_Clickhouse {
+    dsn: string;
+}
+export interface Data_Temporal {
+    addr: string;
+    namespace: string;
+    workerTaskQueue: string;
+}
+export interface Service {
+    apply: Service_RpcService | undefined;
+    fileExchange: Service_RpcService | undefined;
+    nodeRuntime: Service_RpcService | undefined;
+    pythonRuntime: Service_RpcService | undefined;
+    yuumi: Service_HttpService | undefined;
+}
+export interface Service_RpcService {
+    addr: string;
+    network: string;
+    timeout: Duration | undefined;
+}
+export interface Service_HttpService {
+    addr: string;
+    timeout: Duration | undefined;
+}
+export interface Admin {
+    user: string;
+    password: string;
+}
+export interface ExtraConf {
+    celldataMaxSize: number;
+}
+export interface LicenseArgs {
+    maxUnits: number;
+    maxMemberInRoom: number;
+    concurrentUnits: number;
+    maxImportSize: number;
+    maxNumberOfCells: number;
+    print: Print | undefined;
+}
+export interface LicenseV2 {
+    id: string;
+    version: string;
+    /** LicenseBiz json string */
+    jsonData: string;
+    signature: string;
+    /** only for upgrade shell */
+    upgradeDeadline: number;
+}
+export interface LicenseBiz {
+    id: string;
+    version: string;
+    domain: string[];
+    /** dev、no-commercial、commercial */
+    releaseType: ReleaseType;
+    feature: Feature | undefined;
+    upgradeDeadline: number;
+    issuedAt: number;
+    /** optional */
+    email: string;
+    /** optional */
+    difficulty: number;
+    /** optional */
+    nonce: number;
+}
+export interface Feature {
+    unitFeature: UnitFeature | undefined;
+    sheetFeature: SheetFeature | undefined;
+    docFeature: DocFeature | undefined;
+    workspaceFeature: WorkspaceFeature | undefined;
+}
+export interface SheetFeature {
+    expirationTime: number;
+    reviews: boolean;
+    pivotTableNum: number;
+    maxImportSize: number;
+    maxPrintNum: number;
+}
+export interface DocFeature {
+    expirationTime: number;
+    reviews: boolean;
+    maxImportSize: number;
+    maxPrintNum: number;
+}
+export interface UnitFeature {
+    expirationTime: number;
+    maxUnits: number;
+    maxMemberInRoom: number;
+    concurrentUnits: number;
+}
+export interface WorkspaceFeature {
+    expirationTime: number;
+    maxHistoryNum: number;
+}
+export interface Print {
+    pageLimit: number;
+}
+export interface Config {
+    confDir: string;
+    confName: string;
+}
+export interface Auth {
+    enabled: boolean;
+    oidc: Auth_OIDC | undefined;
+    oauth2: Auth_Oauth2 | undefined;
+    permission: Auth_Permission | undefined;
+    univerEnabled: boolean;
+    anonymous: Auth_Anonymous | undefined;
+    cookieDomain: string;
+    casdoorSDK: Auth_CasdoorSDK | undefined;
+    admin: Auth_Admin | undefined;
+    loginErrorURL: string;
+    mobileBindURL: string;
+    homepageURL: string;
+}
+export interface Auth_OIDC {
+    issuer: string;
+    clientID: string;
+    clientSecret: string;
+    redirectURL: string;
+    /** @deprecated */
+    cookieDomain: string;
+    enabled: boolean;
+}
+export interface Auth_CasdoorSDK {
+    organizationName: string;
+    applicationName: string;
+    /** casdoor domain eg. https://login.univer.work */
+    domain: string;
+}
+export interface Auth_Oauth2 {
+    clientID: string;
+    clientSecret: string;
+    redirectURL: string;
+    /** @deprecated */
+    cookieDomain: string;
+    enabled: boolean;
+    authURL: string;
+    tokenURL: string;
+    apiURL: string;
+    scopes: string;
+    openidPath: string;
+    emailPath: string;
+    namePath: string;
+    avatarPath: string;
+}
+export interface Auth_Anonymous {
+    enabled: boolean;
+}
+export interface Auth_Permission {
+    enabled: boolean;
+    defaultShareScope: string;
+    defaultShareRole: string;
+    enableObjInherit: boolean;
+    customerStrategies: string;
+}
+export interface Auth_Admin {
+    userIDs: string[];
+    liteServer: boolean;
+}
+export interface ApiLimit {
+    method: ApiLimit_TokenLimit | undefined;
+    ip: ApiLimit_TokenLimit | undefined;
+    perMethod: {
+        [key: string]: ApiLimit_TokenLimit;
+    };
+    /** for every user limit */
+    user: ApiLimit_TokenLimit | undefined;
+    perMethodUser: {
+        [key: string]: ApiLimit_TokenLimit;
+    };
+    /** for specific method limit */
+    perMethodIp: {
+        [key: string]: ApiLimit_TokenLimit;
+    };
+}
+export interface ApiLimit_TokenLimit {
+    tokens: number;
+    interval: Duration | undefined;
+}
+export interface ApiLimit_PerMethodEntry {
+    key: string;
+    value: ApiLimit_TokenLimit | undefined;
+}
+export interface ApiLimit_PerMethodUserEntry {
+    key: string;
+    value: ApiLimit_TokenLimit | undefined;
+}
+export interface ApiLimit_PerMethodIpEntry {
+    key: string;
+    value: ApiLimit_TokenLimit | undefined;
+}
+export interface SentryConfig {
+    dsn: string;
+    debug: boolean;
+    enableTracing: boolean;
+    TracesSampleRate: number;
+}
+/** Univer Server Integration Protocol */
+export interface USIP {
+    enabled: boolean;
+    uri: USIP_USIPUri | undefined;
+}
+export interface USIP_USIPUri {
+    userinfo: string;
+    collaborators: string;
+    role: string;
+    credential: string;
+}
+export interface DataProtectionConf {
+    enableProtection: boolean;
+    dataKeyRotate: Duration | undefined;
+    dataKeyCacheExpiration: Duration | undefined;
+    /** if enableProtection=true, choose one for current */
+    awskms: DataProtectionConf_AwsKMSConf | undefined;
+    localKMS: DataProtectionConf_LocalKMSConf | undefined;
+}
+export interface DataProtectionConf_AwsKMSConf {
+    accessKeyID: string;
+    accessKeySecret: string;
+    region: string;
+    kmsKeyID: string;
+}
+export interface DataProtectionConf_LocalKMSConf {
+    cmkAlias: string;
+    cmkBase64: string;
+}
+export interface SESConf {
+    accessKey: string;
+    accessSecret: string;
+    region: string;
+    /** @deprecated */
+    templateName: string;
+    redirectURL: string;
+    template: SESConf_SESTemplate | undefined;
+}
+export interface SESConf_SESTemplate {
+    login: string;
+    clipsheetWorkflow: string;
+    emailAuthCode: string;
+}
+export interface WorkspaceConf {
+    enabled: boolean;
+}
+export interface PostHogConf {
+    enabled: boolean;
+    endpoint: string;
+    projectKey: string;
+}
+export interface EntitlementConf {
+    enable: boolean;
+    defaultEntiConf: EntitlementConf_DefaultEntiConf | undefined;
+    cronConf: EntitlementConf_CronConf | undefined;
+    stripeConf: EntitlementConf_StripeConf | undefined;
+}
+export interface EntitlementConf_DefaultEntiConf {
+    anonymousDefaultEntiId: number;
+    registeredDefaultEntiId: number;
+}
+export interface EntitlementConf_CronConf {
+    reportRetryCron: string;
+    minRetryInterval: number;
+    retryRate: number;
+    pendingSubCleanCron: string;
+    detectInterval: number;
+    cleanRate: number;
+}
+export interface EntitlementConf_StripeConf {
+    apiPK: string;
+    apiSK: string;
+    whSK: string;
+    timeout: number;
+}
+export interface StatsConf {
+    /** seconds */
+    timeInterval: number;
+    maxRecords: number;
+    addr: string;
+}
+export interface JaegerConf {
+    enabled: boolean;
+    grpcEndpoint: string;
+}
+export interface ScriptLogsConf {
+    enable: boolean;
+    retentionDuration: Duration | undefined;
+}
+export interface SMSConf {
+    accessKey: string;
+    accessSecret: string;
+    endpoint: string;
+    signName: string;
+    templateCodeForLogin: string;
+}
+export interface InvitationCode {
+    enabled: boolean;
+}
+export interface ModelConf {
+    id: string;
+    name: string;
+}
+export interface Wechat {
+    appID: string;
+    appSecret: string;
+}

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

@@ -0,0 +1,74 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../univer/constants/errors';
+import { RowData } from '../univer/workbook';
+import { DisplayerConfig } from './source_connector/displayer';
+import { SelectColumn, WhereGroup as WhereGroup1 } from './source_connector/stream_view';
+export declare const protobufPackage = "universer.v1";
+export interface Connector {
+    connectorID: string;
+    name: string;
+}
+export interface Displayer {
+    diplayerID: string;
+    name: string;
+}
+export interface WhereGroup {
+    group: string;
+    conditions: WhereCondition[];
+}
+export interface WhereCondition {
+    column: string;
+    value: any[];
+}
+export interface ListDisplayersRequest {
+}
+export interface ListDisplayersResponse {
+    error: Error | undefined;
+    displayers: Displayer[];
+}
+export interface GetDisplayerRequest {
+    displayerID: string;
+}
+export interface GetDisplayerResponse {
+    error: Error | undefined;
+    display: DisplayerConfig | undefined;
+}
+export interface GetStreamViewRequest {
+    viewID: string;
+}
+export interface GetStreamViewResponse {
+    error: Error | undefined;
+    select: SelectColumn[];
+    where: WhereGroup1[];
+}
+export interface GetStreamViewRownumResponse {
+    error: Error | undefined;
+    rownum: number;
+}
+export interface StreamViewQueryRequest {
+    viewID: string;
+    schedule: string;
+    select: string[];
+    where: WhereGroup[];
+}
+export interface QueryResponse {
+    error: Error | undefined;
+    nextCursor: string;
+    dataformID: string;
+    celldatas: RowData[];
+    columns: string[];
+}
+export interface DataformQueryRequest {
+    dataformID: string;
+    cursor: string;
+}
+export interface ConnectorService {
+    ListDisplayers(request: ListDisplayersRequest, metadata?: Metadata): Observable<ListDisplayersResponse>;
+    GetDisplayer(request: GetDisplayerRequest, metadata?: Metadata): Observable<GetDisplayerResponse>;
+    GetStreamView(request: GetStreamViewRequest, metadata?: Metadata): Observable<GetStreamViewResponse>;
+    GetStreamViewRownum(request: StreamViewQueryRequest, metadata?: Metadata): Observable<GetStreamViewRownumResponse>;
+    StreamViewPreview(request: StreamViewQueryRequest, metadata?: Metadata): Observable<QueryResponse>;
+    StreamViewQuery(request: StreamViewQueryRequest, metadata?: Metadata): Observable<QueryResponse>;
+    DataformQuery(request: DataformQueryRequest, metadata?: Metadata): Observable<QueryResponse>;
+}