@byted-apaas/server-sdk-node 1.1.23 → 1.1.24-beta.0

package/request/structs.d.ts

@@ -0,0 +1,99 @@
+export interface IApprovalInstanceListReq {
+    start_time?: number;
+    end_time?: number;
+    page_size?: number;
+    page_token?: string;
+}
+export interface IGetApprovalInstanceListResp {
+    approval_instance_ids: number[];
+    page_token: string;
+    count: number;
+    has_more: boolean;
+}
+export interface IGetApprovalInstanceResp {
+    approval_instance: {
+        id: number;
+        label: Record<string, string>;
+        initiator: number;
+        instance_start_time: number;
+        status: string;
+        tasks: {
+            id: number;
+            task_type: string;
+            task_status: string;
+            task_start_time: number;
+            task_end_time: number;
+            form_data: string;
+            approval_logic: string;
+            approvers: number[];
+            assigners: number[];
+            task_url: string;
+        }[];
+        comments: {
+            id: number;
+            commenter: number;
+            content: string;
+            create_at: number;
+            update_at: number;
+        }[];
+    };
+}
+export interface IApprovalInstanceReq {
+    includes: string;
+}
+export interface IApprovalInstanceListOptions {
+    startTime?: number;
+    endTime?: number;
+    pageSize?: number;
+    pageToken?: string;
+}
+export interface IApprovalInstanceList {
+    approvalInstanceIds: number[];
+    pageToken: string;
+    count: number;
+    hasMore: boolean;
+}
+export declare enum ApprovalInstanceStatus {
+    IN_PROCESS = "in_process",
+    AGREED = "agreed",
+    INPROCESS = "rejected",
+    CANCELED = "canceled",
+    FAILED = "failed",
+    COMPLETED = "completed",
+    UNSTARTED = "unstarted",
+    AUTO_END = "auto_end",
+    TERMINATED = "terminated"
+}
+export interface IApprovalInstance {
+    id: number;
+    label: Record<string, string>;
+    initiator: number;
+    instanceStartTime: number;
+    status: string;
+    tasks: IApprovalTask[];
+    comments: IApprovalComment[];
+}
+export interface IApprovalComment {
+    id: number;
+    commenter: number;
+    content: string;
+    createAt: number;
+    updateAt: number;
+}
+export interface IApprovalTask {
+    id: number;
+    taskType: string;
+    taskStatus: string;
+    taskStartTime: number;
+    taskEndTime: number;
+    formData: string;
+    approvalLogic: string;
+    approvers: number[];
+    assigners: number[];
+    taskURL: string;
+}
+export interface IGetApprovalInstanceOptions {
+    approvalInstanceId: number;
+    includeFormData?: boolean;
+    includeContent?: boolean;
+}

package/request/structs.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApprovalInstanceStatus = void 0;
+var ApprovalInstanceStatus;
+(function (ApprovalInstanceStatus) {
+    ApprovalInstanceStatus["IN_PROCESS"] = "in_process";
+    ApprovalInstanceStatus["AGREED"] = "agreed";
+    ApprovalInstanceStatus["INPROCESS"] = "rejected";
+    ApprovalInstanceStatus["CANCELED"] = "canceled";
+    ApprovalInstanceStatus["FAILED"] = "failed";
+    ApprovalInstanceStatus["COMPLETED"] = "completed";
+    ApprovalInstanceStatus["UNSTARTED"] = "unstarted";
+    ApprovalInstanceStatus["AUTO_END"] = "auto_end";
+    ApprovalInstanceStatus["TERMINATED"] = "terminated";
+})(ApprovalInstanceStatus = exports.ApprovalInstanceStatus || (exports.ApprovalInstanceStatus = {}));

package/types/types.d.ts

@@ -0,0 +1,79 @@
+export type _BooleanCond<T> = {};
+export type _LogicalCond<T> = {};
+type _LookupCond = number | {
+    _id: number;
+};
+type _MultiLookupCond = _LookupCond[];
+type PartialCompositeType<T> = Partial<{
+    [K in keyof T]: T[K] extends _LookupField[] ? _MultiLookupCond : T[K] extends _LookupField ? _LookupCond : Partial<T[K]>;
+}>;
+type _FieldCond<T> = T extends _LookupField[] ? _MultiLookupCond : T extends _LookupField ? _LookupCond : PartialCompositeType<T>;
+type _FirstLevelFieldCond<T> = Partial<{
+    [K in keyof T]: T[K] extends _LookupField ? _FieldCond<T[K]> : T[K];
+}>;
+type _KCond<T> = Partial<{
+    [K in keyof T]: _FieldCond<T[K]> | _BooleanCond<T[K]> | _LogicalCond<T[K]>;
+}>;
+type _WhereKCond<T> = Partial<{
+    [K in keyof T]: _FirstLevelFieldCond<T[K]> | _BooleanCond<T[K]> | _LogicalCond<T[K]>;
+}>;
+export type _Cond<T> = _KCond<T> | _LogicalCond<Partial<T>>;
+export type _WhereCond<T> = _WhereKCond<T> | _LogicalCond<Partial<T>>;
+export type _Record<T> = {
+    [K in keyof T]: T[K] extends _LookupField ? _LookupFieldRet : T[K];
+};
+export type _CondRequireID<T> = _Cond<T> & {
+    _id: number | string;
+};
+interface _LookupFieldRet {
+    /**
+     * 名称：_id
+     *
+     * 类型：数字 / Number
+     *
+     * 格式：number
+     */
+    _id: number;
+    /**
+     * 名称：角色名 / _name
+     *
+     * 类型：文本 / Text | 多语 / Multilingual
+     *
+     * 格式：string | {language_code: 1033|2052, text: string}[]
+     */
+    _name: string | {
+        language_code: 1033 | 2052;
+        text: string;
+    }[];
+    is_deleted: boolean;
+}
+interface _LookupField {
+    _id: number;
+}
+import { metadataMap, currentObjApiName } from '../data/index';
+/**
+ * target record 被使用于 workflow 场景下
+ */
+export interface TargetRecord {
+    /**
+     * workflow 被触发时，原始的记录信息
+     */
+    original: metadataMap[currentObjApiName];
+    /**
+     * workflow 运行到当前位置的记录信息
+     */
+    proposed: metadataMap[currentObjApiName];
+}
+export interface TriggerOld {
+    /**
+     * 更新前的记录数据
+     */
+    old: metadataMap[currentObjApiName];
+}
+export interface TriggerNew {
+    /**
+     * 创建或更新后的记录数据
+     */
+    new: metadataMap[currentObjApiName];
+}
+export {};

package/types/types.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });

package/version/version.d.ts

@@ -0,0 +1,2 @@
+export declare const SDKName: any;
+export declare const SDKVersion: any;

package/version/version.js

@@ -0,0 +1,8 @@
+"use strict";
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SDKVersion = exports.SDKName = void 0;
+const packageJson = require('.././package.json');
+exports.SDKName = packageJson.name;
+exports.SDKVersion = packageJson.version;