@byted-apaas/server-sdk-node 0.0.2-beta.2 → 0.0.2-beta.5

package/context/metadata/types/objects.ts

@@ -1,251 +0,0 @@
-import {I18ns} from "./common";
-
-export interface BaseFieldType {
-    type: string;
-    apiName: string;
-    label: I18ns;
-}
-
-export interface KTextFieldType extends BaseFieldType {
-    required: boolean;      // 默认值：false
-    unique: boolean;        // 默认值：false
-    caseSensitive: boolean;      // unique 为 false 时生效，默认值：true
-    multiline: boolean;          // 默认值：false
-    maxLength: number;           // 默认值：1000
-    validationRegex: string;     // 正则校验的表达式
-    errorMsg: I18ns;
-}
-
-export interface RichTextType extends BaseFieldType {
-    required: boolean;           // 默认值：false
-    maxLength: number;
-}
-
-export interface MultilingualType extends BaseFieldType {
-    required: boolean;         // 默认值：false
-    unique: boolean;           // 默认值：false
-    caseSensitive: boolean;    // unique 为 ture 时生效，默认值：true
-    multiline: boolean;        // 默认值：false
-    maxLength: number;         // 默认值：1000
-}
-
-export interface NumberType extends BaseFieldType {
-    required: boolean;        // 默认值：false
-    unique: boolean;          // 默认值：false
-    displayAsPercentage: boolean;  // 默认值：false
-    decimalPlacesNumber: number;
-}
-
-export interface KDateType extends BaseFieldType {
-    required: boolean;        // 默认值：false
-}
-
-export interface DateTimeType extends BaseFieldType {
-    required: boolean;        // 默认值：false
-}
-
-export type SubOptionType = {
-    label: I18ns;
-    apiName: string;
-    description: I18ns;
-    color: ("grey" | "blue" | "cyan" | "green" | "yellow" | "orange" | "red" | "magenta" | "purple" | "blueMagenta");  // 按色阶顺序给默认值
-    active: boolean;          // 默认值： true
-}
-
-export interface OptionType extends BaseFieldType {
-    required: boolean;        // 默认值：false
-    multiple: boolean;        // 默认值：false
-    optionSource: ("custom" | "global");         // 对应选项字段的「选项来源」属性（分为「自定义选项」和「使用全局选项）, 默认值："custom"
-    globalOptionApiName: string;  // 关联全局选项的 apiName（创建字段时，设定 optionSource 为 "custom"，则无需传入，且生成的元数据中不包含该属性）
-    optionList: SubOptionType[];
-}
-
-export interface Email extends BaseFieldType {
-    required: boolean;        // 默认值：false
-    unique: boolean;        // 默认值：false
-}
-
-export interface MobileNumber extends BaseFieldType {
-    required: boolean;        // 默认值：false
-    unique: boolean;        // 默认值：false
-}
-
-export interface Boolean extends BaseFieldType {
-    descriptionWhenTrue: I18ns;
-    descriptionWhenFalse: I18ns;
-    defaultValue: boolean;
-}
-
-export interface AvatarOrLogo extends BaseFieldType {
-    displayStyle: ("square" | "round");  // 默认值："square"
-}
-
-export interface SortConditionType {
-    fieldApiName: string;
-    sort: ("asc" | "desc")                  // 默认值："asc"
-}
-
-type ConditionType = {
-    left: {
-        objectApiName: string;
-        fieldApiName: string;
-    };
-    operator: ("eq" | "neq" | "in" | "notIn" | "empty" | "notEmpty" | "lte" | "gte" | "hasAllOf" | "hasNoneOf" | "hasAnyOf");
-    valueType: ("reference" | "specified");
-    right: (object | string);      // 当 valueType 为 "reference" 时，值类型同 left 属性；若为 "specified"，值类型则为固定的字符串值
-}
-
-type CriterionType = {
-    conditions: ConditionType[];          // filter 条件
-    logic: string;
-}
-
-export type FilterType = {
-    label: string;                      // 对应为查找字段设置过滤条件中的「名称」属性
-    needTriggerCriterion: boolean;      // 默认值：false
-    triggerCriterion: CriterionType
-    criterion: CriterionType
-    errorMsg: I18ns;
-}
-
-export interface Lookup extends BaseFieldType {
-    required: boolean;                         // 默认值：false
-    multiple: boolean;                         // 默认值：false，对应查找字段的「关联记录数」属性（分为「单条」和「多条」）
-    objectApiName: string;                     // 字段 look up 的对象
-    hierarchy: boolean;                        // 默认值：false，multiple 为 false 时生效
-    displayStyle: ("search" | "dropDown" | "tree");   // 默认值："dropDown"，对应查找字段的「关联记录展示方式」属性，仅当 hierarchy 为 true 时才可设置为 "tree"
-    sortConditions: SortConditionType[];
-    filter: FilterType[];
-}
-
-export interface FormulaType extends BaseFieldType {
-    returnType: string;            // 对应公式字段的「公式返回值类型」属性
-    formula: I18ns;
-}
-
-export interface AutoIDType extends BaseFieldType {
-    generateMethod: ("random" | "incremental");  // 默认值: "random"
-    digitsNumber: number;
-    prefix: string;
-    suffix: string;
-}
-
-export interface ReferenceFieldType extends BaseFieldType {
-    guideFieldApiName: string;
-    fieldApiName: string;
-}
-
-export interface FileType extends BaseFieldType {
-    required: boolean;     // 默认值: false
-    multiple: boolean;     // 默认值: false
-    fileTypes: string[];    // 支持 "jpeg"|"jpg"|"png"|"gif"|"pdf"|"docx"|"doc"|"xlsx"|"xls"|"pptx"|"ppt"|"csv"|"txt"|"json"|"mp4"|"zip"|"rar"，同时支持 "*.doc" 的描述方式，当为空数组，或 null、undefined 时，默认支持「全部类型」
-}
-
-export interface BackLookuType extends BaseFieldType {
-    objectApiName: string;
-    fieldApiName: string; //  由于下游提供仍是 api ID 版本，因此禁用
-}
-
-export interface CompositeType extends BaseFieldType {
-    compositeTypeApiName: string;    // 关联组合类型的 apiName，「主子对象」需求调整后，将不存在该 key
-    subFields: BaseFieldType[];    // 组合类型中的子字段的元数据
-    required: boolean;               // 默认值: false
-    multiple: boolean;               // 默认值: false
-}
-
-export interface ExtractSingleRecordType extends BaseFieldType {
-    compositeTypeApiName: string;    // 关联组合类型的 apiName，「主子对象」需求调整后，将调整为「子表单」类型字段的 apiName
-    subFields: BaseFieldType[];    // 组合类型中的子字段的元数据
-    filter: FilterType[];
-    sortConditions: SortConditionType[];
-    recordPosition: number;          // 默认值: 1，对应多值取单值字段的「返回记录」（分为「第一条」、「最后一条」和「第 {{n}} 条」），取值为正整数时为相应位置的记录，取值为 -1 时为「最后一条」记录
-}
-
-export type FieldType = {
-    "allow_search": boolean,
-    "api_name": string,
-    "calculated": boolean,
-    "description": I18ns,
-    "domain": number,
-    "encryption_mode": string,
-    "field_permission": number,
-    "formula_id": number,
-    "id": number,
-    "indexed": number,
-    "inherit_settings": object,
-    "is_encrypted": boolean,
-    "is_inherit": boolean,
-    "is_progress_field": boolean,
-    "label": I18ns,
-    "namespace": string,
-    "object_api_name": string,
-    "object_id": number,
-    "order": number,
-    "required": boolean,
-    "tenant_id": number,
-    "type": {
-        "name": string,
-        "settings": {
-            "multiline": boolean,
-            "text_version": number,
-            "decimal_places": number,
-            "display_as_percentage": boolean,
-            "placeholder": object,
-            "max_length": number,
-            "regexp_expression": string,
-            "regexp_err_msg": I18ns,
-            "is_array": boolean,
-            "option_type": string,
-            "related_to_global_option": {
-                "apiName": string,
-                "id": number,
-                "name": string,
-            },
-            "options": {
-                "name": I18ns,
-                "api_name": string,
-                "description": I18ns,
-                "color_id": string,
-                "active": boolean,
-            }[],
-            "description_if_true": I18ns,
-            "description_if_false": I18ns,
-            "display_style": string,
-            "default_value": boolean,
-            "referenced_object_api_name": string,
-            "is_hierarchy": boolean,
-            "return_type": string,
-            "formulas": I18ns,
-            "generation_method": string,
-            "digits": number,
-            "prefix": string,
-            "suffix": string,
-            "target_referenced_object_api_name": string,
-            "target_reference_field_api_name": string,
-            "multiple": boolean,
-            "mime_types": string[],
-            "related_to_object_api_name": string,
-            "related_to_field_api_name": string,
-            "related_to_api_name": string,
-            "related_to_fields": object[],
-            "filter": FilterType[],
-            "sort": {
-                "field": string,
-                "type": "string",
-                "direction": ("asc" | "desc")
-            }[],
-            "filter_record": {
-                "index": number,
-                "type": string,
-            },
-            "is_extract": boolean,
-        }
-    },
-    "unique_type": number,
-    "updated_at": number,
-    "updated_by": {
-        "avatar": object,
-        "id": number,
-        "name": string,
-    },
-}

package/context/msg/msg.ts

@@ -1,49 +0,0 @@
-import * as Request from "../../request/interface";
-import * as common from "@byted-apaas/server-common-node"
-import Multilingual = common.fieldType.Multilingual
-
-export type _IconType = "success" | "error" | "progress" | "info"
-
-export class _NotifyCenter {
-    /**
-     * 消息中心推送消息
-     * @param msg 消息
-     */
-    public async create(msg: {
-        icon: _IconType,
-        percent: Number,
-        target_users: number[],
-        title: Multilingual,
-        detail: Multilingual,
-    }): Promise<number> {
-        return await Request.GetInstance().createMessage(msg);
-    };
-    /**
-     * 消息中心更新消息
-     * @param msgId 消息 ID
-     * @param msg 消息
-     */
-    public async update(msgId: number, msg: {
-        icon?: _IconType,
-        percent?: Number,
-        target_users?: number[],
-        title?: Multilingual,
-        detail?: Multilingual,
-    }): Promise<void> {
-        return await Request.GetInstance().updateMessage(msgId, msg);
-    };
-}
-
-/**
- * 消息类
- */
-export class Message {
-    /**
-     * 消息中心
-     */
-    notifyCenter: _NotifyCenter;
-
-    constructor() {
-        this.notifyCenter = new _NotifyCenter();
-    }
-}

package/context/resources/IResources.ts

@@ -1,73 +0,0 @@
-import { Stream } from "stream";
-import { _KunlunOpenSDKFile } from "./impl/resources";
-import { UploadFileResp } from "../../request/interface";
-
-export interface _FileInfo {
-    id: string;
-}
-
-export interface _IKunlunFile {
-    /**
-     * 上传文件
-     * @param filePath 文件路径
-     * @param expire 文件过期时间，可选，单位：秒
-     */
-    upload(filePath: string, expire?: number): Promise<UploadFileResp>;
-    /**
-     * 上传文件
-     * @param stream 文件流
-     * @param expire 文件过期时间，可选，单位：秒
-     */
-    upload(stream: Stream, expire?: number): Promise<UploadFileResp>;
-    /**
-     * 下载文件
-     * @param fileToken 文件令牌
-     */
-    download(fileToken: string): Promise<Buffer>;
-
-    /**
-     * 下载文件
-     * @param fileToken 文件令牌
-     * @param filePath 文件保存的路径
-     */
-    download(fileToken: string, filePath: string): Promise<void>;
-
-    /**
-     * 下载文件
-     * @param fileInfo 文件信息
-     */
-    download(fileInfo: _FileInfo): Promise<Buffer>;
-
-    /**
-     * 下载文件
-     * @param fileInfo 文件信息
-     * @param filePath 文件保存的路径
-     */
-    download(fileInfo: _FileInfo, filePath: string): Promise<void>;
-}
-
-export type FileUploadResult = {
-    fileId: string;
-    type: string;
-    name: string;
-    size: number;
-};
-
-export type UploadAvatarResult = {
-    ImageId: string;
-    PreviewImageId: string;
-};
-export interface _IOpenSDKFile {
-    Upload(fileName: string, path: string): Promise<FileUploadResult>;
-    Upload(fileName: string, reader: Stream): Promise<FileUploadResult>;
-    Upload(fileName: string, buffer: Buffer): Promise<FileUploadResult>;
-    UploadAvatar(fileName: string, path: string): Promise<UploadAvatarResult>;
-    UploadAvatar(fileName: string, reader: Stream): Promise<UploadAvatarResult>;
-    UploadAvatar(fileName: string, buffer: Buffer): Promise<UploadAvatarResult>;
-    Download(fileID: string): Promise<Buffer>;
-    DownloadAvatar(imageID: string): Promise<Buffer>;
-}
-
-export interface _IOpenSDKResources {
-    file: _IOpenSDKFile;
-}

package/context/resources/impl/resources.ts

@@ -1,170 +0,0 @@
-import { Stream } from "stream";
-import { _FileInfo, _IKunlunFile, _IOpenSDKFile, UploadAvatarResult, FileUploadResult } from "../IResources";
-import * as Request from "../../../request/interface";
-import { runCtxForOpenSDK } from "../../../application/impl/common";
-import * as common from "@byted-apaas/server-common-node"
-import { AppCtx } from "../../../application/application";
-import { streamToBuffer } from "@jorgeferrero/stream-to-buffer";
-
-const exceptions = common.exceptions;
-
-const fs = require('fs');
-
-export class _KunlunOpenSDKFile implements _IOpenSDKFile {
-    appCtx: AppCtx
-
-    constructor(appCtx: AppCtx) {
-        this.appCtx = appCtx;
-    }
-
-    async Upload(fileName: string, path: string): Promise<FileUploadResult>;
-    async Upload(fileName: string, reader: Stream): Promise<FileUploadResult>;
-    async Upload(fileName: string, buffer: Buffer): Promise<FileUploadResult>;
-    async Upload(fileName: string, source: string | Stream | Buffer): Promise<FileUploadResult> {
-        // 1. check parameters type
-        if (typeof fileName !== 'string') {
-            throw new exceptions.InvalidParamError('upload method parameter fileName must be string. ');
-        }
-        if (typeof source !== 'string' && !(source instanceof Stream) && !(source instanceof Buffer)) {
-            throw new exceptions.InvalidParamError('upload method parameter source must be string or stream or buffer. ');
-        }
-        // 2. divide by source type
-        if (typeof source === 'string') {
-            // upload from path
-            if (!fs.existsSync(source)) {
-                throw new exceptions.InvalidParamError(`no such file '${source}'`)
-            }
-            source = fs.createReadStream(source);
-        }
-        if (source instanceof Stream) {
-            // upload from stream
-            source = await streamToBuffer(source as any);
-        }
-        if (source instanceof Buffer) {
-            return await runCtxForOpenSDK(this.appCtx, async () => {
-                return await Request.GetInstance().openSDKUploadFile(fileName, source as Buffer);
-            });
-        }
-        return null;
-    };
-    async UploadAvatar(fileName: string, path: string): Promise<UploadAvatarResult>;
-    async UploadAvatar(fileName: string, reader: Stream): Promise<UploadAvatarResult>;
-    async UploadAvatar(fileName: string, buffer: Buffer): Promise<UploadAvatarResult>;
-    async UploadAvatar(fileName: string, source: string | Stream | Buffer): Promise<UploadAvatarResult> {
-        // 1. check parameters type
-        if (typeof fileName !== 'string') {
-            throw new exceptions.InvalidParamError('upload method parameter fileName must be string. ');
-        }
-        if (typeof source !== 'string' && !(source instanceof Stream) && !(source instanceof Buffer)) {
-            throw new exceptions.InvalidParamError('upload method parameter source must be string or stream or buffer. ');
-        }
-        // 2. divide by source type
-        if (typeof source === 'string') {
-            // upload from path
-            if (!fs.existsSync(source)) {
-                throw new exceptions.InvalidParamError(`no such file '${source}'`)
-            }
-            source = fs.createReadStream(source);
-        }
-        if (source instanceof Stream) {
-            // upload from stream
-            source = await streamToBuffer(source as any);
-        }
-        if (source instanceof Buffer) {
-            // upload from buffer
-            return await runCtxForOpenSDK(this.appCtx, async () => {
-                return await Request.GetInstance().openSDKUploadAvatar(fileName, source as Buffer);
-            })
-        }
-        return null;
-    };
-    async Download(fileID: string): Promise<Buffer> {
-        // 1. check parameters type
-        if (typeof fileID !== 'string') {
-            throw new exceptions.InvalidParamError('download method parameter fileID must be string. ');
-        }
-        return await runCtxForOpenSDK(this.appCtx, async () => {
-            return await Request.GetInstance().downloadFileByID(fileID) as Buffer;
-        })
-    };
-    async DownloadAvatar(imageID: string): Promise<Buffer> {
-        // 1. check parameters type
-        if (typeof imageID !== 'string') {
-            throw new exceptions.InvalidParamError('download method parameter imageID must be string. ');
-        }
-        return await runCtxForOpenSDK(this.appCtx, async () => {
-            return await Request.GetInstance().openSDKDownloadAvatar(imageID) as Buffer;
-        })
-    };
-}
-
-export class _KunlunFile implements _IKunlunFile {
-    async download(fileToken: string): Promise<Buffer>;
-    async download(fileToken: string, filePath?: string): Promise<void>;
-    async download(fileToken: _FileInfo): Promise<Buffer>;
-    async download(fileInfo: _FileInfo, filePath: string): Promise<void>;
-    async download(fileTokenOrInfo: string | _FileInfo, filePath?: string): Promise<Buffer | void> {
-        if (typeof (fileTokenOrInfo) === "string") {
-            return await Request.GetInstance().downloadFileByToken(fileTokenOrInfo, filePath);
-        } else if (typeof (fileTokenOrInfo) === "object") {
-            if (!fileTokenOrInfo.id) {
-                throw new exceptions.InvalidParamError(`The value of fileInfo.id is empty`);
-            }
-
-            if (typeof (fileTokenOrInfo.id) !== "string") {
-                throw new exceptions.InvalidParamError(`The type of fileInfo.id should be string, but ${typeof (fileTokenOrInfo)}`);
-            }
-            return await Request.GetInstance().downloadFileByID(fileTokenOrInfo.id, filePath);
-        } else {
-            throw new exceptions.InvalidParamError(`The type of first param should be string or object, but ${typeof (fileTokenOrInfo)}`);
-        }
-    }
-
-    async upload(filePath: string): Promise<Request.UploadFileResp>;
-    async upload(stream: Stream): Promise<Request.UploadFileResp>;
-    async upload(filePath: string, expire: number): Promise<Request.UploadFileResp>;
-    async upload(stream: Stream, expire: number): Promise<Request.UploadFileResp>;
-    async upload(data: string | Stream, expire?: number, ...ret: string[]): Promise<Request.UploadFileResp> {
-        if (ret.length > 0) {
-            throw new exceptions.InvalidParamError(`params is too many, as ${ret.length + 2}`)
-        }
-        if (!data) {
-            throw new exceptions.InvalidParamError(`params is null`)
-        }
-
-        // 1. data is filePath, read it from disk, convert it to Steam.
-        if (typeof (data) === 'string') {
-            if (!fs.existsSync(data)) {
-                throw new exceptions.InvalidParamError(`no such file '${data}'`)
-            }
-            data = fs.createReadStream(data);
-        }
-
-        // 2. data must be Stream at here.
-        return await Request.GetInstance().uploadFile(data as Stream, expire);
-    }
-}
-
-/**
- * OpenSDK 静态资源操作类
- */
-export class _OpenSDKResources {
-    file: _IOpenSDKFile;
-
-    constructor(appCtx: AppCtx) {
-        this.file = new _KunlunOpenSDKFile(appCtx);
-    }
-}
-
-/**
- * 静态资源操作类
- */
-export class _Resources {
-
-    file: _IKunlunFile;
-
-    constructor() {
-        this.file = new _KunlunFile();
-    }
-
-}