@univerjs/protocol 0.1.47 → 0.1.49

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

@@ -16,6 +16,18 @@ export declare enum EntitlementItemType {
     BizDefined = 2,
     UNRECOGNIZED = -1
 }
+export declare enum EntitlementType {
+    InvalidEntitlement = 0,
+    TimeEntitlement = 1,
+    QuotaEntitlement = 2,
+    MixEntitlement = 3,
+    UNRECOGNIZED = -1
+}
+export declare enum QuotaKey {
+    NoneQuotaKey = 0,
+    CreditGeneral = 1,
+    UNRECOGNIZED = -1
+}
 export declare enum EntitlementItemId {
     WebTableExtractRate = 0,
     ServerExtractHistory = 1,
@@ -47,10 +59,46 @@ export declare enum EntitlementItemId {
     BiaoDaMaxEnrichmentRows = 26,
     /** BiaoDaUnitDownload - unit下载，type=Ability */
     BiaoDaUnitDownload = 31,
+    /** BiaoDaDashboardDownload - dashboard下载，type=Ability */
+    BiaoDaDashboardDownload = 32,
+    /** BiaoDaSuperScrapeRowsRate - 超级模板允许采集行数频控,type=Rate */
+    BiaoDaSuperScrapeRowsRate = 33,
+    /** BiaoDaSuperScrapeFreeTimesRate - 超级模板不限采集行数设置次数频控,type=Rate */
+    BiaoDaSuperScrapeFreeTimesRate = 34,
+    /** BiaoDaVideoScriptExtractTimesRate - 视频脚本提取处理次数频控,type=Rate */
+    BiaoDaVideoScriptExtractTimesRate = 35,
     /** XlsxAIBasicPoints - xlsx.ai 基础积分 */
     XlsxAIBasicPoints = 101,
     UNRECOGNIZED = -1
 }
+export declare enum QuotaSource {
+    InvalidQuotaSource = 0,
+    AwardedQuota = 1,
+    RedeemedQuota = 2,
+    RegisterQuota = 3,
+    QuotaPackage = 4,
+    PlanedQuota = 5,
+    ReferralQuota = 6,
+    UNRECOGNIZED = -1
+}
+export declare enum QuotaUsageReason {
+    NonSpeciedUsage = 0,
+    ScrapeUsage = 1,
+    ChatUsage = 2,
+    ReportUsage = 3,
+    UnitEditUsage = 4,
+    /** TitleUsage - more later */
+    TitleUsage = 5,
+    RecommendationUsage = 6,
+    PromptOptimizationUsage = 7,
+    /** VideoTaskScriptUsage - video task step usages */
+    VideoTaskScriptUsage = 8,
+    VideoTaskScriptAnalysisUsage = 9,
+    VideoTaskStoryboardUsage = 10,
+    VideoTaskReuseUsage = 11,
+    VideoTaskRecreatePromptUsage = 12,
+    UNRECOGNIZED = -1
+}
 export declare enum ProductType {
     NonProduct = 0,
     Recurring = 1,
@@ -59,6 +107,14 @@ export declare enum ProductType {
     OneTime = 3,
     UNRECOGNIZED = -1
 }
+export declare enum ProductCategory {
+    InvalidProductCategory = 0,
+    /** PlanProduct - 订阅类 */
+    PlanProduct = 1,
+    /** QuotaPackageProduct - 加量包类 */
+    QuotaPackageProduct = 2,
+    UNRECOGNIZED = -1
+}
 export declare enum SessionType {
     /** SetupIntent - collect payment method */
     SetupIntent = 0,
@@ -79,6 +135,16 @@ export declare enum SubscriptionStatus {
     Cancelled = 4,
     UNRECOGNIZED = -1
 }
+export declare enum IdentitySource {
+    InvalidIdentitySource = 0,
+    DefaultIdentity = 1,
+    AwardedIdentity = 2,
+    RedeemedIdentity = 3,
+    PlanedIdentity = 4,
+    RegisteredIdentity = 5,
+    ReferralIdentity = 6,
+    UNRECOGNIZED = -1
+}
 export declare enum UserInfoType {
     Email = 0,
     BillingAddress = 1,
@@ -137,6 +203,7 @@ export interface Entitlement {
     name: string;
     groups: EntitlementItemGroup[];
     id: string;
+    type: EntitlementType;
 }
 export interface RateDetail {
     /** eg. if interval=Week and interval_cnt=3, it's mean 3 weeks */
@@ -194,6 +261,89 @@ export interface DeductQuotaByUserRequest {
 export interface DeductQuotaByUserResponse {
     error: Error | undefined;
 }
+export interface ReportQuotaUsageRequest {
+    /** string representation of enum QuotaKey */
+    quotaKey: string;
+    quotaUsed: number;
+    /** used to aggregate credits cost */
+    messageId?: string | undefined;
+    /** used to aggregate credits cost */
+    conversationId?: string | undefined;
+    reason: QuotaUsageReason;
+}
+export interface ReportQuotaUsageResponse {
+    error: Error | undefined;
+}
+export interface ListQuotaDetailsRequest {
+    /**
+     * batchId,
+     * set to empty in the 1st scroller request,
+     * then set to nextBatchId(which was returned by the previous request) in the following scroller request.
+     */
+    batchId: string;
+    /** limit, specify how many records needed. */
+    limit: number;
+    quotaKey: string;
+    /** 是否只返回有可用quota的记录？ */
+    availableOnly: boolean;
+}
+export interface ListQuotaDetailsResponse {
+    details: QuotaDetailRecord[];
+    hasMore: boolean;
+    nextBatchId: string;
+    error: Error | undefined;
+}
+export interface ListQuotaUsageRecordsRequest {
+    /**
+     * batchId,
+     * set to empty in the 1st scroller request,
+     * then set to nextBatchId(which was returned by the previous request) in the following scroller request.
+     */
+    batchId: string;
+    /** limit, specify how many records needed. */
+    limit: number;
+    quotaKey: string;
+}
+export interface ListQuotaUsageRecordsResponse {
+    records: QuotaUsageRecord[];
+    hasMore: boolean;
+    nextBatchId: string;
+    error: Error | undefined;
+}
+export interface QuotaUsageRecord {
+    /** precision: seconds */
+    usageTime: string;
+    usageTotal: number;
+    reason: QuotaUsageReason;
+    conversationId?: string | undefined;
+    messageId?: string | undefined;
+}
+export interface GetQuotaItemRequest {
+    quotaKey: string;
+}
+export interface GetQuotaItemResponse {
+    /** 只返回真实可用大于0的明细 */
+    item: QuotaItem | undefined;
+    error: Error | undefined;
+}
+export interface QuotaDetailRecord {
+    source: QuotaSource;
+    /** precision: seconds */
+    grantTime: string;
+    /** precision: seconds */
+    expireTime: string;
+    quotaTotal: number;
+    quotaLeft: number;
+}
+export interface QuotaItem {
+    quotaKey: string;
+    totalAvailable: number;
+    details: QuotaDetailRecord[];
+}
+export interface QuotaItemConf {
+    quotaKey: string;
+    quotaTotal: number;
+}
 export interface Product {
     productId: string;
     productType: ProductType;
@@ -202,7 +352,14 @@ export interface Product {
     /** optional, recommendation text of the product */
     recommendation: string;
     tags: string[];
+    entitlementType: EntitlementType;
+    category: ProductCategory;
+    quotaConfs: {
+        [key: string]: QuotaItemConf;
+    };
+    /** subscription interval if product_type is Recurring */
     interval: Interval;
+    /** subscription interval count if product_type is Recurring */
     intervalCnt: number;
     /** the origin price */
     price: string;
@@ -212,9 +369,17 @@ export interface Product {
     promotionPrice: string;
     /** optional, how many interval the promotion last, set if there's any promotion and product_type is Recurring */
     promotionIntervalCnt: number;
+    /** work with quotaGrantIntervalCnt. subscription may be yearly, but quota is grant monthly. */
+    quotaGrantInterval: Interval;
+    /** work with quotaGrantInterval */
+    quotaGrantIntervalCnt: number;
     /** optional, the product table name */
     tabName: string;
 }
+export interface Product_QuotaConfsEntry {
+    key: string;
+    value: QuotaItemConf | undefined;
+}
 export interface PaymentSession {
     sessionType: SessionType;
     clientSecret: string;
@@ -232,6 +397,8 @@ export interface Subscription {
     subscriptTime: number;
     /** unix timestamp of UTC 0 */
     nextChargeTime: number;
+    entitlementType: EntitlementType;
+    entitlementLevel: number;
     /** is the subscription need payment */
     paymentNeeded: boolean;
     /** optional, set session data if payment_needed is true */
@@ -260,6 +427,8 @@ export interface Identity {
     isDefault: boolean;
     /** expire time in seconds, negative value means the identity will never expire */
     expireTimeSec: string;
+    entitlementType: EntitlementType;
+    identitySource: IdentitySource;
 }
 export interface GetSubscriptionSummaryRequest {
 }
@@ -269,8 +438,16 @@ export interface GetSubscriptionSummaryResponse {
     currentSubscription: Subscription | undefined;
     /** optional, may be set if currently has any subscription */
     paymentMethod: PaymentMethod | undefined;
+    /** key for QuotaKey string, val for available now */
+    availableQuotas: {
+        [key: string]: number;
+    };
     error: Error | undefined;
 }
+export interface GetSubscriptionSummaryResponse_AvailableQuotasEntry {
+    key: string;
+    value: number;
+}
 export interface Address {
     City: string;
     Country: string;
@@ -287,13 +464,19 @@ export interface ProductGroup {
     products: Product[];
 }
 export interface ListProductsRequest {
+    couponCode: string;
 }
 export interface ListProductsResponse {
+    /** only return the subscription products */
     groups: ProductGroup[];
     /** set if has subscription */
     currentSubscription: Subscription | undefined;
     identity: Identity | undefined;
+    /** deprecated */
     missingUserInfoTypes: UserInfoType[];
+    /** only return the quota packages */
+    quotaPackages: Product[];
+    isQuotaPackageAvailableForUser: boolean;
     error: Error | undefined;
 }
 export interface CreateSubscriptionRequest {
@@ -304,12 +487,19 @@ export interface CreateSubscriptionRequest {
     email: string;
     /** set the return url after payment complete */
     paymentReturnUrl: string;
+    couponCode: string;
 }
 export interface CreateSubscriptionResponse {
     session: PaymentSession | undefined;
     /** if error code is ENTITLE_NEED_BILLING_ADDRESS, collect user's billing address and try again */
     error: Error | undefined;
 }
+export interface ChangeSubscriptionRequest {
+    toProductId: string;
+}
+export interface ChangeSubscriptionResponse {
+    error: Error | undefined;
+}
 export interface CancelSubscriptionRequest {
     subscriptionId: string;
     /** optional */
@@ -326,8 +516,10 @@ export interface Invoice {
     /** format 12.45 */
     payAmount: string;
     currency: string;
+    userId: string;
     productId: string;
     productName: string;
+    subscriptionId: string;
     description: string;
     /** link of the receipt */
     receiptUrl: string;
@@ -335,6 +527,8 @@ export interface Invoice {
     invoicePdf: string;
     /** invoice number */
     invoiceNumber: string;
+    billingCycleNo: number;
+    couponCode: string;
 }
 export interface ListInvoicesRequest {
     /** no of the first page is 1 */
@@ -353,6 +547,19 @@ export interface ListInvoicesResponse {
     totalCnt: number;
     error: Error | undefined;
 }
+export interface ListPaidInvoicesRequest {
+    batchId: string;
+    limit: number;
+    /** [begin, end) */
+    periodBegin: number;
+    periodEnd: number;
+}
+export interface ListPaidInvoicesResponse {
+    invoices: Invoice[];
+    hasMore: boolean;
+    nextBatchId: string;
+    error: Error | undefined;
+}
 export interface GetPaymentConfigRequest {
 }
 export interface GetPaymentConfigResponse {
@@ -366,10 +573,18 @@ export interface PaymentRequest {
     qty: number;
     channel: PaymentChannel;
     orderId: string;
+    /** for stripe channel only, optional, set if previous PaymentRequest returns error code ENTITLE_NEED_BILLING_ADDRESS */
+    billingAddress: Address | undefined;
+    /** for stripe channel only, required, redirect URL after pay success */
+    succUrl: string;
 }
 export interface PaymentResponse {
     orderId: string;
+    /** for PaymentChannel AliPay and WechatPay */
     payQRCode: string;
+    /** for PaymentChannel Stripe */
+    payLink: string;
+    channel: PaymentChannel;
     error: Error | undefined;
 }
 export interface GetOrderStatusRequest {
@@ -399,15 +614,36 @@ export interface GrantEntitlementRequest {
     bizId: string;
     bizGrantId: string;
     toUserId: string;
+    /** if no fixed entitlement granted, set empty */
     entitlementId: string;
     interval: Interval;
     intervalCnt: number;
+    /** if no quota granted, set empty */
+    quotaConfs: {
+        [key: string]: QuotaItemConf;
+    };
+    /** set if entitlementId setted */
+    identitySource: IdentitySource;
+    /** set if quotaConfs setted */
+    quotaSource: QuotaSource;
+    /** quotaInterval & quotaIntervalCnt specify the duration of granted quota */
+    quotaInterval: Interval;
+    /** quotaInterval & quotaIntervalCnt specify the duration of granted quota */
+    quotaIntervalCnt: number;
+}
+export interface GrantEntitlementRequest_QuotaConfsEntry {
+    key: string;
+    value: QuotaItemConf | undefined;
 }
 export interface GrantEntitlementResponse {
     error: Error | undefined;
 }
 export interface EntitlementService {
     MGetEntitlementItemsByUser(request: MGetEntitlementItemsByUserRequest, metadata?: Metadata): Observable<MGetEntitlementItemsByUserResponse>;
+    GetQuotaItem(request: GetQuotaItemRequest, metadata?: Metadata): Observable<GetQuotaItemResponse>;
+    ReportQuotaUsage(request: ReportQuotaUsageRequest, metadata?: Metadata): Observable<ReportQuotaUsageResponse>;
+    ListQuotaDetails(request: ListQuotaDetailsRequest, metadata?: Metadata): Observable<ListQuotaDetailsResponse>;
+    ListQuotaUsageRecords(request: ListQuotaUsageRecordsRequest, metadata?: Metadata): Observable<ListQuotaUsageRecordsResponse>;
     /** for back-end only, can deduct and add. */
     TakeNItemRateByUser(request: TakeNItemRateByUserRequest, metadata?: Metadata): Observable<TakeNItemRateByUserResponse>;
     /** for front-end only case, just deduct, can not return quota. */
@@ -416,8 +652,10 @@ export interface EntitlementService {
     ListProducts(request: ListProductsRequest, metadata?: Metadata): Observable<ListProductsResponse>;
     GetSubscriptionSummary(request: GetSubscriptionSummaryRequest, metadata?: Metadata): Observable<GetSubscriptionSummaryResponse>;
     CreateSubscription(request: CreateSubscriptionRequest, metadata?: Metadata): Observable<CreateSubscriptionResponse>;
+    ChangeSubscription(request: ChangeSubscriptionRequest, metadata?: Metadata): Observable<ChangeSubscriptionResponse>;
     CancelSubscription(request: CancelSubscriptionRequest, metadata?: Metadata): Observable<CancelSubscriptionResponse>;
     ListInvoices(request: ListInvoicesRequest, metadata?: Metadata): Observable<ListInvoicesResponse>;
+    ListPaidInvoices(request: ListPaidInvoicesRequest, metadata?: Metadata): Observable<ListPaidInvoicesResponse>;
     Pay(request: PaymentRequest, metadata?: Metadata): Observable<PaymentResponse>;
     GetOrderStatus(request: GetOrderStatusRequest, metadata?: Metadata): Observable<GetOrderStatusResponse>;
     ListActiveEntitlements(request: ListActiveEntitlementsRequest, metadata?: Metadata): Observable<ListActiveEntitlementsResponse>;

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

@@ -28,6 +28,10 @@ export interface ImportRequest {
     scene: ImportScene;
     minSheetColumnCount: number;
     minSheetRowCount: number;
+    /** used for integration with customer system */
+    idempotencyKey?: string | undefined;
+    /** used for integration with customer system, just store and pass through. This metadata will store with the imported unit. */
+    metaData?: string | undefined;
 }
 export interface ImportResponse {
     error: Error | undefined;

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

@@ -16,6 +16,8 @@ export declare enum FileSource {
     UserProfileImg = 5,
     /** ClipsheetFragments - assign UserID, fragmented file will be deleted after 30 days */
     ClipsheetFragments = 6,
+    /** LLMInputData - assign UserID */
+    LLMInputData = 7,
     UNRECOGNIZED = -1
 }
 export declare enum DownloadUrlMode {
@@ -78,11 +80,29 @@ export interface PutFileByIdResponse {
     error: Error | undefined;
     fileId: string;
 }
+export interface SignPutUrlRequest {
+    fileSize: number;
+    name?: string | undefined;
+    source: FileSource;
+}
+export interface SignPutUrlResponse {
+    error: Error | undefined;
+    fileId: string;
+    putUrl: string;
+}
+export interface DeleteFileByIdRequest {
+    fileId: string;
+}
+export interface DeleteFileByIdResponse {
+    error: Error | undefined;
+}
 export interface FileService {
     SignUrl(request: SignUrlRequest, metadata?: Metadata): Observable<SignUrlResponse>;
+    SignPutUrl(request: SignPutUrlRequest, metadata?: Metadata): Observable<SignPutUrlResponse>;
     Upload(request: Observable<FileUploadRequest>, metadata?: Metadata): Observable<UploadResponse>;
     SetUniverGoJson(request: SetUniverGoJsonRequest, metadata?: Metadata): Observable<SetUniverGoJsonResponse>;
     GetUniverGoJson(request: GetUniverGoJsonRequest, metadata?: Metadata): Observable<GetUniverGoJsonResponse>;
     PutTemplateResouce(request: PutTemplateResouceRequest, metadata?: Metadata): Observable<PutTemplateResouceResponse>;
     PutFileById(request: Observable<PutFileByIdRequest>, metadata?: Metadata): Observable<PutFileByIdResponse>;
+    DeleteFileById(request: DeleteFileByIdRequest, metadata?: Metadata): Observable<DeleteFileByIdResponse>;
 }

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

@@ -0,0 +1,36 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Error } from '../../univer/constants/errors';
+export declare const protobufPackage = "universer.v1";
+export interface WriteFrontendLogRequest {
+    userId?: string | undefined;
+    logLabel: string;
+    content: string;
+}
+export interface WriteFrontendLogResponse {
+    error: Error | undefined;
+}
+export interface ListFrontendLogsRequest {
+    logLabel?: string | undefined;
+    startTime: number;
+    endTime: number;
+    next: string;
+    pageSize: number;
+    ascending: boolean;
+}
+export interface ListFrontendLogsResponse {
+    error: Error | undefined;
+    logs: ListFrontendLogsResponse_FrontendLog[];
+    hasMore: boolean;
+}
+export interface ListFrontendLogsResponse_FrontendLog {
+    logId: string;
+    userId: string;
+    logLabel: string;
+    timestamp: number;
+    content: string;
+}
+export interface FrontendLogsService {
+    WriteLog(request: WriteFrontendLogRequest, metadata?: Metadata): Observable<WriteFrontendLogResponse>;
+    List(request: ListFrontendLogsRequest, metadata?: Metadata): Observable<ListFrontendLogsResponse>;
+}

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

@@ -1,19 +1,28 @@
 import { Metadata } from '@grpc/grpc-js';
 import { Observable } from 'rxjs';
+import { Changeset } from '../../univer/changeset';
 import { Error } from '../../univer/constants/errors';
 import { UniverType } from '../../univer/constants/univer';
 import { User } from '../../univer/permission';
 export declare const protobufPackage = "universer.v1";
+export declare enum HistoryOrigin {
+    HISTORY_ORIGIN_UNSPECIFIED = 0,
+    HISTORY_ORIGIN_USER = 1,
+    HISTORY_ORIGIN_CHARACTER = 2,
+    UNRECOGNIZED = -1
+}
 export interface CreateHistoryRequest {
     unitId: string;
     subUnitId: string;
     type: UniverType;
     revision: number;
+    additionalFields?: string | undefined;
 }
 export interface CreateHistoryResponse {
     error: Error | undefined;
 }
 export interface History {
+    /** @deprecated */
     userId: string;
     unitId: string;
     command: string[];
@@ -21,11 +30,21 @@ export interface History {
     recoverTime: string;
     startRevision: number;
     endRevision: number;
+    /** additionalFields is a reserved field for future use */
+    additionalFields?: string | undefined;
+    origin?: HistoryOrigin | undefined;
+    startRevCreateTime: number;
+    endRevCreateTime: number;
+    userIds: string[];
 }
 export interface HistoryListRequest {
     length: number;
     lastLabel: string;
     unitId: string;
+    origin?: HistoryOrigin | undefined;
+    /** @deprecated */
+    userId?: string | undefined;
+    userIds: string[];
 }
 export interface HistoryEntities {
     datas: {
@@ -50,7 +69,38 @@ export interface HistoryListResponse {
     entities: HistoryEntities | undefined;
     historyIds: string[];
 }
+export interface ListHistoryCreatorsRequest {
+    unitId: string;
+}
+export interface ListHistoryCreatorsResponse {
+    error: Error | undefined;
+    creators: ListHistoryCreatorsResponse_Creator[];
+}
+export interface ListHistoryCreatorsResponse_Creator {
+    userId: string;
+    name: string;
+    avatar: string;
+    origins: HistoryOrigin[];
+}
+export interface GetHistoryCsRequest {
+    unitId: string;
+    startRevision: number;
+    endRevision: number;
+}
+export interface GetHistoryCsResponse {
+    error: Error | undefined;
+    changesets: Changeset[];
+    users: {
+        [key: string]: User;
+    };
+}
+export interface GetHistoryCsResponse_UsersEntry {
+    key: string;
+    value: User | undefined;
+}
 export interface HistoryService {
     GetHistoryList(request: HistoryListRequest, metadata?: Metadata): Observable<HistoryListResponse>;
     CreateHistory(request: CreateHistoryRequest, metadata?: Metadata): Observable<CreateHistoryResponse>;
+    ListHistoryCreators(request: ListHistoryCreatorsRequest, metadata?: Metadata): Observable<ListHistoryCreatorsResponse>;
+    GetHistoryCs(request: GetHistoryCsRequest, metadata?: Metadata): Observable<GetHistoryCsResponse>;
 }

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

@@ -99,6 +99,55 @@ export interface OIDCLoginStatus {
     feature: string;
     /** eg. youtube_abc */
     origin: string;
+    referralCode: string;
+}
+/** 小程序登录请求 */
+export interface MiniProgramLoginRequest {
+    /** 小程序 wx.login() 获取的 code */
+    code: string;
+    /** 登录状态信息（JSON格式的 OIDCLoginStatus） */
+    state: string;
+}
+/** 小程序登录响应 */
+export interface MiniProgramLoginResponse {
+    /** 临时 token，用于后续设置 cookie */
+    cookieToken: string;
+    /** 是否为新注册用户 */
+    isRegister: boolean;
+    needBindPhone: boolean;
+    error: Error | undefined;
+}
+/** 小程序绑定手机号请求 */
+export interface MiniProgramBindPhoneRequest {
+    cookieToken: string;
+    phoneCode: string;
+}
+/** 小程序绑定手机号响应 */
+export interface MiniProgramBindPhoneResponse {
+    success: boolean;
+    error: Error | undefined;
+}
+/** 小程序回调请求（WebView 中调用） */
+export interface MiniProgramCallbackRequest {
+    /** 从 MiniProgramLoginResponse 获取的 token */
+    cookieToken: string;
+    /** 登录成功后跳转的 URL */
+    redirectUri: string;
+}
+/** 小程序回调响应 */
+export interface MiniProgramCallbackResponse {
+    /** 是否成功设置 cookie */
+    success: boolean;
+    error: Error | undefined;
+}
+export interface WechatJSSDKSignatureRequest {
+    url: string;
+}
+export interface WechatJSSDKSignatureResponse {
+    error: Error | undefined;
+    timestamp: number;
+    nonceStr: string;
+    signature: string;
 }
 export interface OIDCService {
     AuthRedirect(request: AuthRedirectRequest, metadata?: Metadata): Observable<AuthRedirectResponse>;
@@ -111,4 +160,8 @@ export interface OIDCService {
     WechatCallback(request: WechatCallbackRequest, metadata?: Metadata): Observable<WechatCallbackResponse>;
     Authorize(request: AuthorizeRequest, metadata?: Metadata): Observable<AuthorizeResponse>;
     ExchangeToken(request: ExchangeTokenRequest, metadata?: Metadata): Observable<ExchangeTokenResponse>;
+    MiniProgramLogin(request: MiniProgramLoginRequest, metadata?: Metadata): Observable<MiniProgramLoginResponse>;
+    MiniProgramBindPhone(request: MiniProgramBindPhoneRequest, metadata?: Metadata): Observable<MiniProgramBindPhoneResponse>;
+    MiniProgramCallback(request: MiniProgramCallbackRequest, metadata?: Metadata): Observable<MiniProgramCallbackResponse>;
+    WechatJSSDKSignature(request: WechatJSSDKSignatureRequest, metadata?: Metadata): Observable<WechatJSSDKSignatureResponse>;
 }

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

@@ -0,0 +1,55 @@
+import { Metadata } from '@grpc/grpc-js';
+import { Observable } from 'rxjs';
+import { Reward } from '../../bizdomain/common';
+import { Error } from '../../univer/constants/errors';
+import { User } from './user';
+export declare const protobufPackage = "universer.v1";
+export interface GetReferralActivitySummaryRequest {
+    activityId: string;
+}
+export interface GetReferralActivitySummaryResponse {
+    /** the activity info */
+    activity: ReferralActivity | undefined;
+    /** this user's referral code in the activity */
+    referralCode: string;
+    /** successed(referee registered) referral records in the activity */
+    records: ReferralRecord[];
+    /** indicates that if there's more referral records */
+    hasMore: boolean;
+    /** use this field to fetch the next batch of referral records if hasMore=true */
+    nextBatchId: string;
+    error: Error | undefined;
+}
+export interface ReferralActivity {
+    beginTime: string;
+    endTime: string;
+    referrerRewards: Reward[];
+    refereeRewards: Reward[];
+}
+export interface ReferralRecord {
+    referralTime: string;
+    /** referee profile WITHOUT PRIVATE DATA. */
+    referee: User | undefined;
+}
+export interface ListReferralRecordsRequest {
+    /**
+     * batchId,
+     * set to empty in the 1st scroller request,
+     * then set to nextBatchId(which was returned by the previous request) in the following scroller request.
+     */
+    batchId: string;
+    /** limit, specify how many records needed. */
+    limit: number;
+    activityId: string;
+}
+export interface ListReferralRecordsResponse {
+    /** records order by referral time desc. */
+    records: ReferralRecord[];
+    hasMore: boolean;
+    nextBatchId: string;
+    error: Error | undefined;
+}
+export interface ReferralService {
+    GetReferralActivitySummary(request: GetReferralActivitySummaryRequest, metadata?: Metadata): Observable<GetReferralActivitySummaryResponse>;
+    ListReferralRecords(request: ListReferralRecordsRequest, metadata?: Metadata): Observable<ListReferralRecordsResponse>;
+}