@univerjs/protocol 0.1.47-alpha.0 → 0.1.48

package/lib/types/ts/{v1 → universer/v1}/analyse_task.d.ts

@@ -1,9 +1,9 @@
 import { Metadata } from '@grpc/grpc-js';
 import { Observable } from 'rxjs';
-import { Error } from '../univer/constants/errors';
-import { UniverType } from '../univer/constants/univer';
-import { UnitRole, UnitShareScope } from '../univer/permission';
-import { DataFragmentationType } from './analyse_cmn';
+import { Error } from '../../univer/constants/errors';
+import { UniverType } from '../../univer/constants/univer';
+import { UnitRole, UnitShareScope } from '../../univer/permission';
+import { DataFragmentationType, SystemRemark } from './analyse_cmn';
 export declare const protobufPackage = "universer.v1";
 export declare enum AnalyseTaskStatus {
     AnalyseTaskStatus_None = 0,
@@ -69,6 +69,8 @@ export interface AnalyseTask {
     reportUnitType: UniverType;
     /** set if status is Completed */
     reportSummary: string;
+    /** set if task executed before, whether success, failure, or executing */
+    sysRemarks: SystemRemark[];
     /** set if status is failed */
     reason: Error | undefined;
     /**
@@ -181,6 +183,7 @@ export interface GetAnalyseTaskProgressRequest {
 }
 export interface GetAnalyseTaskProgressResponse {
     progress: AnalyseTaskProgressNode[];
+    sysRemarks: SystemRemark[];
     error: Error | undefined;
 }
 export interface StartNodeData {

package/lib/types/ts/{v1 → universer/v1}/authz.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from '@grpc/grpc-js';
 import { Observable } from 'rxjs';
-import { Error } from '../univer/constants/errors';
-import { ObjectScope, UnitAction, UnitObject, UnitPermissionStrategy, UnitRole, UnitRoleKV, UnitShareScope, User } from '../univer/permission';
+import { Error } from '../../univer/constants/errors';
+import { ObjectScope, UnitAction, UnitObject, UnitPermissionStrategy, UnitRole, UnitRoleKV, UnitShareScope, User } from '../../univer/permission';
 export declare const protobufPackage = "universer.v1";
 export interface Collaborator {
     id: string;

package/lib/types/ts/{v1 → universer/v1}/clipsheet_task.d.ts

@@ -1,24 +1,52 @@
 import { Metadata } from '@grpc/grpc-js';
 import { Observable } from 'rxjs';
-import { Error } from '../univer/constants/errors';
+import { Error } from '../../univer/constants/errors';
 export declare const protobufPackage = "universer.v1";
-export interface DAQTarget {
+export declare enum DAQTargetsType {
+    PlainUrlList = 0,
+    ArtifactField = 1,
+    UNRECOGNIZED = -1
+}
+export declare enum DAQTargetURLSource {
+    /** URL_UNKNOWN - unknown source, should not be used. */
+    URL_UNKNOWN = 0,
+    URL_EXPLICIT = 1,
+    URL_PLATFORM = 2,
+    UNRECOGNIZED = -1
+}
+export interface PlainDAQTarget {
     url: string;
     title: string;
+    /** the source of the URL, e.g., explicit or platform. */
+    urlSource: DAQTargetURLSource;
+}
+export interface ArtifactDAQTarget {
+    artifactId: string;
+    artifactTitle: string;
+    columnName: string;
+    columnIndex: number;
+    urlCnt: number;
 }
 export interface ClipsheetTask {
     id: string;
     /** managed by clipsheet plugin now. */
     status: number;
-    targets: DAQTarget[];
+    targets: PlainDAQTarget[];
     resultUnits: string[];
+    /** Some options, the user confirms one of them */
+    artifactTargets: ArtifactDAQTarget[];
+    targetsType: DAQTargetsType;
     /** managed by clipsheet plugin now. */
     extra: string;
     /** unix-timestamp milli seconds. */
     createTime: string;
 }
 export interface CreateClipsheetTaskRequest {
-    targets: DAQTarget[];
+    targets: PlainDAQTarget[];
+    artifactTargets: ArtifactDAQTarget[];
+    targetsType: DAQTargetsType;
+    /** set if create in the conversation. */
+    conversationId: string;
 }
 export interface CreateClipsheetTaskResponse {
     task: ClipsheetTask | undefined;

package/lib/types/ts/{v1 → universer/v1}/comb.d.ts

@@ -1,10 +1,10 @@
 import { Metadata } from '@grpc/grpc-js';
 import { Observable } from 'rxjs';
-import { Empty } from '../google/protobuf/empty';
-import { Changeset } from '../univer/changeset';
-import { CollaMsg } from '../univer/colla_msg';
-import { Error } from '../univer/constants/errors';
-import { UniverType } from '../univer/constants/univer';
+import { Empty } from '../../google/protobuf/empty';
+import { Changeset } from '../../univer/changeset';
+import { CollaMsg } from '../../univer/colla_msg';
+import { Error } from '../../univer/constants/errors';
+import { UniverType } from '../../univer/constants/univer';
 export declare const protobufPackage = "universer.v1";
 /** more details: https://c3fgartrp2.feishu.cn/docx/OS47dk8BCo1ZeKxXiNvcDLuZn2g#PymGdupuyoYfvTxv1EBciV7in9b */
 export declare enum CombCmd {

package/lib/types/ts/{v1 → universer/v1}/comment.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from '@grpc/grpc-js';
 import { Observable } from 'rxjs';
-import { CommentUpdate_Status } from '../univer/colla_msg';
-import { Error } from '../univer/constants/errors';
+import { CommentUpdate_Status } from '../../univer/colla_msg';
+import { Error } from '../../univer/constants/errors';
 import { User } from './user';
 export declare const protobufPackage = "universer.v1";
 export interface Reply {

package/lib/types/ts/{v1 → universer/v1}/conf.d.ts

@@ -1,4 +1,6 @@
-import { Duration } from '../google/protobuf/duration';
+import { Duration } from '../../google/protobuf/duration';
+import { MessageChannel } from '../../univer/constants/biz';
+import { Interval, QuotaItemConf } from './entitlement';
 export declare const protobufPackage = "universer.v1";
 export declare enum ReleaseType {
     UNKNOWN_TYPE = 0,
@@ -40,6 +42,12 @@ export interface Bootstrap {
     models: ModelConf[];
     wechat: Wechat | undefined;
     aiAnalyseSampleConf: AIAnalyseSampleConf | undefined;
+    permissionBasedExport: PermissionBasedExport | undefined;
+    notifyConf: NotifyConf | undefined;
+    ip2AddrCliConf: IP2AddrCliConf | undefined;
+    googleConf: GoogleConf | undefined;
+    proxyConf: ProxyConf | undefined;
+    unitRoutingConf: UnitRoutingConf | undefined;
 }
 export interface Server {
     http: Server_HTTP | undefined;
@@ -133,6 +141,10 @@ export interface Service {
     fileExchange: Service_RpcService | undefined;
     nodeRuntime: Service_RpcService | undefined;
     pythonRuntime: Service_RpcService | undefined;
+    ssc: Service_RpcService | undefined;
+    univerOps: Service_RpcService | undefined;
+    redemptionCode: Service_RpcService | undefined;
+    collaborationHelper: Service_RpcService | undefined;
     yuumi: Service_HttpService | undefined;
 }
 export interface Service_RpcService {
@@ -329,6 +341,7 @@ export interface USIP_USIPUri {
     collaborators: string;
     role: string;
     credential: string;
+    unitEditTime: string;
 }
 export interface DataProtectionConf {
     enableProtection: boolean;
@@ -377,11 +390,33 @@ export interface EntitlementConf {
     defaultEntiConf: EntitlementConf_DefaultEntiConf | undefined;
     cronConf: EntitlementConf_CronConf | undefined;
     stripeConf: EntitlementConf_StripeConf | undefined;
+    wechatPayConf: EntitlementConf_WechatPayConf | undefined;
+    aliPayConf: EntitlementConf_AliPayConf | undefined;
+    /** minutes eg. 1440 */
+    orderExpireInterval: number;
+    /** minutes eg. 15 */
+    intentExpireInterval: number;
+    identityExpireNtfConf: EntitlementConf_IdentityExpireNtfConf | undefined;
+    registerAwardConf: EntitlementConf_RegisterAwardConf | undefined;
 }
 export interface EntitlementConf_DefaultEntiConf {
     anonymousDefaultEntiId: number;
     registeredDefaultEntiId: number;
 }
+export interface EntitlementConf_RegisterAwardConf {
+    entiId: number;
+    entiInterval: Interval;
+    entiIntervalCnt: number;
+    quotaConfs: {
+        [key: string]: QuotaItemConf;
+    };
+    quotaInterval: Interval;
+    quotaIntervalCnt: number;
+}
+export interface EntitlementConf_RegisterAwardConf_QuotaConfsEntry {
+    key: string;
+    value: QuotaItemConf | undefined;
+}
 export interface EntitlementConf_CronConf {
     reportRetryCron: string;
     minRetryInterval: number;
@@ -389,6 +424,7 @@ export interface EntitlementConf_CronConf {
     pendingSubCleanCron: string;
     detectInterval: number;
     cleanRate: number;
+    maxActionBlockInterval: number;
 }
 export interface EntitlementConf_StripeConf {
     apiPK: string;
@@ -396,6 +432,30 @@ export interface EntitlementConf_StripeConf {
     whSK: string;
     timeout: number;
 }
+export interface EntitlementConf_WechatPayConf {
+    /** WeChat application ID */
+    appID: string;
+    /** Merchant certificate serial number */
+    mchCertificateSerialNumber: string;
+    /** Merchant ID */
+    mchID: string;
+    /** Merchant APIv3 key */
+    apiKey: string;
+    /** WeChat payment notification URL */
+    notifyUrl: string;
+}
+export interface EntitlementConf_AliPayConf {
+    appID: string;
+    privateKey: string;
+    apiKey: string;
+    /** alipay notification URL */
+    notifyUrl: string;
+    isProd: boolean;
+}
+export interface EntitlementConf_IdentityExpireNtfConf {
+    toNtfLeftDays: number[];
+    ntfRate: number;
+}
 export interface StatsConf {
     /** seconds */
     timeInterval: number;
@@ -436,3 +496,46 @@ export interface AIAnalyseSampleUnit {
     unitId: string;
     dataSummary: string;
 }
+export interface PermissionBasedExport {
+    enabled: boolean;
+}
+export interface NotifyConf {
+    /** 购买成功配置 */
+    purchase: NotifyConf_SceneConf[];
+    identityExpiring: NotifyConf_SceneConf[];
+}
+export interface NotifyConf_SceneConf {
+    channel: MessageChannel;
+    templateId: string;
+}
+export interface IP2AddrCliConf {
+    pathFmt: string;
+    token: string;
+}
+export interface GoogleConf {
+    enabled: boolean;
+    clientId: string;
+    clientSecret: string;
+    redirectUrl: string;
+    scopes: string[];
+    apikey: string;
+    appId: string;
+}
+export interface ProxyConf {
+    proxyUrl: string;
+}
+export interface UnitRoutingConf {
+    tiers: UnitRoutingConf_servicesTier[];
+    cacheSeconds: number;
+    refreshSeconds: number;
+    tierSwitchDelaySeconds: number;
+}
+export interface UnitRoutingConf_servicesTier {
+    tierName: string;
+    enable: boolean;
+    upgradeCellsThreshold: number;
+    downgradeCellsThreshold: number;
+    upgradeImportTimeThreshold: number;
+    applyServerAddr: string;
+    applyServerTimeout: Duration | undefined;
+}

package/lib/types/ts/{v1 → universer/v1}/connector.d.ts

@@ -1,7 +1,7 @@
 import { Metadata } from '@grpc/grpc-js';
 import { Observable } from 'rxjs';
-import { Error } from '../univer/constants/errors';
-import { RowData } from '../univer/workbook';
+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";

package/lib/types/ts/{v1 → universer/v1}/conversation.d.ts

@@ -1,8 +1,9 @@
 import { Metadata } from '@grpc/grpc-js';
 import { Observable } from 'rxjs';
-import { SystemHint } from '../ai_common/common';
-import { Error } from '../univer/constants/errors';
+import { SystemHint } from '../../ai_common/common';
+import { Error } from '../../univer/constants/errors';
 import { DataFragmentationType } from './analyse_cmn';
+import { RateDetail } from './entitlement';
 export declare const protobufPackage = "universer.v1";
 export declare enum CompletionStatus {
     Completion_None = 0,
@@ -75,6 +76,17 @@ export declare enum ChatSSEStatus {
     ChatSSEStatus_Success = 2,
     UNRECOGNIZED = -1
 }
+export interface ModelDetail {
+    /** use string representation of enum ai_common.UniverAIModel */
+    modelId: string;
+    rateDetails: RateDetail[];
+}
+export interface ListAvailableModelsRequest {
+}
+export interface ListAvailableModelsResponse {
+    models: ModelDetail[];
+    error: Error | undefined;
+}
 export interface GetConversationModelsRequest {
 }
 export interface GetConversationModel {
@@ -114,6 +126,16 @@ export interface Conversation {
     /** unix timestamp milli seconds */
     lastUpdate: string;
     title: string;
+    creatorUid: string;
+    expireTime: string;
+    shared: boolean;
+}
+export interface GetConversationRequest {
+    conversationId: string;
+}
+export interface GetConversationResponse {
+    conversation: Conversation | undefined;
+    error: Error | undefined;
 }
 export interface ListConversationsRequest {
     /**
@@ -139,6 +161,18 @@ export interface RenameConversationRequest {
 export interface RenameConversationResponse {
     error: Error | undefined;
 }
+export interface ShareConversationRequest {
+    conversationId: string;
+}
+export interface ShareConversationResponse {
+    error: Error | undefined;
+}
+export interface UnshareConversationRequest {
+    conversationId: string;
+}
+export interface UnshareConversationResponse {
+    error: Error | undefined;
+}
 export interface DeleteConversationRequest {
     conversationId: string;
 }
@@ -161,6 +195,8 @@ export interface ContentBlock {
     blockType: ContentBlockType;
     contentType: ContentType;
     body: string;
+    /** for multi-channel response, default is empty */
+    channelId?: string | undefined;
 }
 export interface Attachment {
     type: AttachmentType;
@@ -219,14 +255,23 @@ export interface SubmitPromptRequest {
     /** use unit or data source */
     dataSourceId: string;
     systemHints: SystemHint[];
+    /** Locale Code */
+    locale?: string | undefined;
 }
 /** SSE api: /universer-api/conversation/resume */
 export interface ResumeConversationRequest {
     conversationId: string;
-    clipsheetOption?: ClipsheetResumeOption | undefined;
+    /** see HITLType, use string, see ai_common/common.proto, eg. hitl_select_table */
+    type: string;
+    /** json string, see ai_common/common.proto */
+    resumeData: string;
+    /** Locale Code */
+    locale?: string | undefined;
+    model?: string | undefined;
 }
-export interface ClipsheetResumeOption {
-    regenerate: boolean;
+/** SSE api: /universer-api/conversation/reconnect */
+export interface ReconnectConversationRequest {
+    conversationId: string;
 }
 /** chat streaming response SSE block */
 export interface ChatSSEBlock {
@@ -247,6 +292,8 @@ export interface ChatSSEBlock {
      */
     body: string;
     status: ChatSSEStatus;
+    /** for multi-channel response, default is empty */
+    channelId?: string | undefined;
 }
 export interface ChatContentSSEBlock {
     contentType: ContentType;
@@ -300,17 +347,125 @@ export interface UpdateConversationDataFragmentationRequest {
 export interface UpdateConversationDataFragmentationResponse {
     error: Error | undefined;
 }
+export interface BindUnitWithConversationRequest {
+    unitId: string;
+    conversationId: string;
+    messageId: string;
+}
+export interface BindUnitWithConversationResponse {
+    error: Error | undefined;
+}
+export interface CancelConversationRequest {
+    conversationId: string;
+}
+export interface CancelConversationResponse {
+    error: Error | undefined;
+}
+export interface NeedReconnectConversationRequest {
+    conversationId: string;
+}
+export interface NeedReconnectConversationResponse {
+    needReconnect: boolean;
+    error: Error | undefined;
+}
+export interface CreateReportRequest {
+    conversationId: string;
+    messageId: string;
+}
+export interface CreateReportResponse {
+    report: Report | undefined;
+    error: Error | undefined;
+}
+export interface RedoReportRequest {
+    reportId: string;
+    conversationId: string;
+}
+export interface PollingReportRequest {
+    reportId: string;
+    conversationId: string;
+}
+export interface Report {
+    reportId: string;
+    conversationId: string;
+    messageId: string;
+    /** unix timestamp milli seconds */
+    createTime: number;
+    updateTime: number;
+    status: string;
+    fragmentationId: string;
+    title: string;
+    summary: string;
+}
+export interface ReportList {
+    reports: Report[];
+}
+export interface ListReportsRequest {
+    conversationId: string;
+}
+export interface ListReportsResponse {
+    /** @deprecated */
+    reports: Report[];
+    /** messageId -> ReportList */
+    reportsMap: {
+        [key: string]: ReportList;
+    };
+    error: Error | undefined;
+}
+export interface ListReportsResponse_ReportsMapEntry {
+    key: string;
+    value: ReportList | undefined;
+}
+export interface FinishReportRequest {
+    reportId: string;
+    status: string;
+    title: string;
+    summary: string;
+    content: string;
+}
+export interface FinishReportResponse {
+    error: Error | undefined;
+}
+export interface GetDashboardRequest {
+    conversationId: string;
+}
+export interface GetDashboardResponse {
+    conversationId: string;
+    dashboardJson: string;
+    error: Error | undefined;
+}
+export interface SaveDashboardRequest {
+    conversationId: string;
+    dashboardJson: string;
+}
+export interface SaveDashboardResponse {
+    error: Error | undefined;
+}
 export interface ConversationService {
+    GetConversation(request: GetConversationRequest, metadata?: Metadata): Observable<GetConversationResponse>;
     /** the conversation list is order by lastUpdate desc default. */
     ListConversations(request: ListConversationsRequest, metadata?: Metadata): Observable<ListConversationsResponse>;
     RenameConversation(request: RenameConversationRequest, metadata?: Metadata): Observable<RenameConversationResponse>;
+    ShareConversation(request: ShareConversationRequest, metadata?: Metadata): Observable<ShareConversationResponse>;
+    UnshareConversation(request: UnshareConversationRequest, metadata?: Metadata): Observable<UnshareConversationResponse>;
     DeleteConversation(request: DeleteConversationRequest, metadata?: Metadata): Observable<DeleteConversationResponse>;
     /** the message list is order by createTime desc default. */
     ListConversationMessages(request: ListConversationMessagesRequest, metadata?: Metadata): Observable<ListConversationMessagesResponse>;
     ReactMessage(request: ReactMessageRequest, metadata?: Metadata): Observable<ReactMessageResponse>;
     GetPromptRecommendations(request: GetPromptRecommendationsRequest, metadata?: Metadata): Observable<GetPromptRecommendationsResponse>;
+    /** deprecated, use ListAvailableModels instead */
     GetConversationModels(request: GetConversationModelsRequest, metadata?: Metadata): Observable<GetConversationModelsResponse>;
+    ListAvailableModels(request: ListAvailableModelsRequest, metadata?: Metadata): Observable<ListAvailableModelsResponse>;
     GetConversationDataFragmentation(request: GetConversationDataFragmentationRequest, metadata?: Metadata): Observable<GetConversationDataFragmentationResponse>;
     ListConversationDataFragmentations(request: ListConversationDataFragmentationsRequest, metadata?: Metadata): Observable<ListConversationDataFragmentationsResponse>;
     UpdateConversationDataFragmentation(request: UpdateConversationDataFragmentationRequest, metadata?: Metadata): Observable<UpdateConversationDataFragmentationResponse>;
+    BindUnitWithConversation(request: BindUnitWithConversationRequest, metadata?: Metadata): Observable<BindUnitWithConversationResponse>;
+    CancelConversation(request: CancelConversationRequest, metadata?: Metadata): Observable<CancelConversationResponse>;
+    NeedReconnectConversation(request: NeedReconnectConversationRequest, metadata?: Metadata): Observable<NeedReconnectConversationResponse>;
+    CreateReport(request: CreateReportRequest, metadata?: Metadata): Observable<CreateReportResponse>;
+    RedoReport(request: RedoReportRequest, metadata?: Metadata): Observable<CreateReportResponse>;
+    PollingReport(request: PollingReportRequest, metadata?: Metadata): Observable<CreateReportResponse>;
+    ListReports(request: ListReportsRequest, metadata?: Metadata): Observable<ListReportsResponse>;
+    FinishReport(request: FinishReportRequest, metadata?: Metadata): Observable<FinishReportResponse>;
+    GetDashboard(request: GetDashboardRequest, metadata?: Metadata): Observable<GetDashboardResponse>;
+    SaveDashboard(request: SaveDashboardRequest, metadata?: Metadata): Observable<SaveDashboardResponse>;
 }

package/lib/types/ts/{v1 → universer/v1}/email.d.ts

@@ -1,7 +1,16 @@
 import { Metadata } from '@grpc/grpc-js';
 import { Observable } from 'rxjs';
-import { Error } from '../univer/constants/errors';
+import { Error } from '../../univer/constants/errors';
 export declare const protobufPackage = "universer.v1";
+export interface SendRawEmailRequest {
+    recipientEmail: string;
+    data: string;
+    title: string;
+    template: string;
+}
+export interface SendRawEmailResponse {
+    error: Error | undefined;
+}
 export interface SendClipsheetWorkflowEmailRequest {
     userId: string;
     recipientEmail: string;
@@ -15,4 +24,5 @@ export interface SendClipsheetWorkflowEmailResponse {
 }
 export interface EmailService {
     SendClipsheetWorkflowEmail(request: SendClipsheetWorkflowEmailRequest, metadata?: Metadata): Observable<SendClipsheetWorkflowEmailResponse>;
+    SendRawEmail(request: SendRawEmailRequest, metadata?: Metadata): Observable<SendRawEmailResponse>;
 }