@byted-apaas/server-sdk-node 0.0.1-beta.3

package/types/types.d.ts

@@ -0,0 +1,79 @@
+export declare type _BooleanCond<T> = {};
+export declare type _LogicalCond<T> = {};
+declare type _LookupCond = number | {
+    _id: number;
+};
+declare type _MultiLookupCond = _LookupCond[];
+declare type PartialCompositeType<T> = Partial<{
+    [K in keyof T]: T[K] extends _LookupField[] ? _MultiLookupCond : T[K] extends _LookupField ? _LookupCond : Partial<T[K]>;
+}>;
+declare type _FieldCond<T> = T extends _LookupField[] ? _MultiLookupCond : T extends _LookupField ? _LookupCond : PartialCompositeType<T>;
+declare type _FirstLevelFieldCond<T> = Partial<{
+    [K in keyof T]: T[K] extends _LookupField ? _FieldCond<T[K]> : T[K];
+}>;
+declare type _KCond<T> = Partial<{
+    [K in keyof T]: _FieldCond<T[K]> | _BooleanCond<T[K]> | _LogicalCond<T[K]>;
+}>;
+declare type _WhereKCond<T> = Partial<{
+    [K in keyof T]: _FirstLevelFieldCond<T[K]> | _BooleanCond<T[K]> | _LogicalCond<T[K]>;
+}>;
+export declare type _Cond<T> = _KCond<T> | _LogicalCond<Partial<T>>;
+export declare type _WhereCond<T> = _WhereKCond<T> | _LogicalCond<Partial<T>>;
+export declare type _Record<T> = {
+    [K in keyof T]: T[K] extends _LookupField ? _LookupFieldRet : T[K];
+};
+export declare type _CondRequireID<T> = _Cond<T> & {
+    _id: number;
+};
+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/types/types.ts

@@ -0,0 +1,108 @@
+// Copyright 2022 ByteDance Ltd. and/or its affiliates
+// SPDX-License-Identifier: MIT
+
+// Condition 部分，用于声明在查询、操作符等场景使用的 条件、逻辑条件、布尔条件 和 字段条件
+// 布尔类型条件
+export type _BooleanCond<T> = {}
+
+// 逻辑类型条件
+export type _LogicalCond<T> = {}
+
+// lookup 类型的条件，被改写为 number 或 仅包含 _id 属性的 object
+type _LookupCond = number | { _id: number }
+
+// 多值 lookup 类型的条件，改写为 number 或 仅包含 id 属性的 object 的数组
+type _MultiLookupCond = _LookupCond[]
+
+// 展开底层类型对象结构，在 Composite Type 的情况下，需要进行二次展开判断是否有单值或多值 Lookup
+type PartialCompositeType<T> = Partial<{
+    [K in keyof T]: T[K] extends _LookupField[] ? _MultiLookupCond : T[K] extends _LookupField ? _LookupCond : Partial<T[K]>;
+}>
+
+// 字段条件，如果字段为 lookup 类型，则改写为 lookup cond，否则返回 Partial
+type _FieldCond<T> = T extends _LookupField[] ? _MultiLookupCond : T extends _LookupField ? _LookupCond : PartialCompositeType<T>
+
+// 第一层字段：需要提示出第二层 LookUp 的对象结构
+type _FirstLevelFieldCond<T> = Partial<{
+    [K in keyof T]: T[K] extends _LookupField ? _FieldCond<T[K]> : T[K]
+}>
+
+// kunlun 的对象筛选条件，对象的每个字段可以传入 字段条件、布尔条件或者逻辑条件
+type _KCond<T> = Partial<{
+    [K in keyof T]: _FieldCond<T[K]> | _BooleanCond<T[K]> | _LogicalCond<T[K]>
+}>
+
+// kunlun 的对象筛选条件，对象的每个字段可以传入 字段条件、布尔条件或者逻辑条件
+type _WhereKCond<T> = Partial<{
+    [K in keyof T]: _FirstLevelFieldCond<T[K]> | _BooleanCond<T[K]> | _LogicalCond<T[K]>
+}>
+
+// 条件，可以传入一个 kunlun 的对象筛选条件 或者 一个逻辑条件
+export type _Cond<T> = _KCond<T> | _LogicalCond<Partial<T>>;
+
+// 筛选条件
+export type _WhereCond<T> = _WhereKCond<T> | _LogicalCond<Partial<T>>;
+
+// 返回记录，主要为了将 lookup 字段类型特化为特化结构
+export type _Record<T> = {
+    [K in keyof T]: T[K] extends _LookupField ? _LookupFieldRet : T[K]
+}
+
+// 用于 update 和 delete 场景
+export type _CondRequireID<T> = _Cond<T> & { _id: number }
+
+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,
+}
+
+// lookup 类型字段的特征
+interface _LookupField {
+    _id: number
+}
+
+import { metadataMap, currentObjApiName } from '../data/index'
+
+/**
+ * target record 被使用于 workflow 场景下
+ */
+export interface TargetRecord {
+    /**
+     * workflow 被触发时，原始的记录信息
+     */
+    original: metadataMap[currentObjApiName];
+    /**
+     * workflow 运行到当前位置的记录信息
+     */
+    proposed: metadataMap[currentObjApiName];
+}
+
+// trigger old
+export interface TriggerOld {
+    /**
+     * 更新前的记录数据
+     */
+    old: metadataMap[currentObjApiName];
+}
+
+export interface TriggerNew {
+    /**
+     * 创建或更新后的记录数据
+     */
+    new: metadataMap[currentObjApiName];
+}