@lcap/nasl 0.3.14-beta.0 → 1.0.0-alpha

package/src/types/data/Interface.ts

@@ -1,438 +0,0 @@
-import { immutable, circular, excludedInJSON, action } from '../decorators';
-import {
-    config, utils, LEVEL_ENUM, Vertex, MicroService, Logic,
-    Service, ActionOptions, isBasicType,
-} from '..';
-import { interfaceService } from '../../service/data';
-import { findUsageService } from '../../service/common';
-import { catchFn } from '../logic/Logic';
-
-/**
- * 接口类
- */
-export class Interface extends Vertex {
-    /**
-     * 概念类型
-     */
-    @immutable()
-    public readonly level: LEVEL_ENUM = LEVEL_ENUM.interface;
-    /**
-     * Id
-     */
-    @immutable()
-    public readonly id: string = undefined;
-    /**
-     * InterfaceKey
-     */
-    @immutable()
-    public readonly key: string = undefined;
-    /**
-     * 名称
-     */
-    @immutable()
-    public readonly name: string = undefined;
-    /**
-     * 协议
-     */
-    @immutable()
-    public readonly protocol: string = undefined;
-    /**
-     * 地址
-     */
-    @immutable()
-    public readonly host: string = undefined;
-    /**
-     * 端口
-     */
-    @immutable()
-    public readonly port: string = undefined;
-    /**
-     * 路径
-     */
-    @immutable()
-    public readonly path: string = undefined;
-    /**
-     * 方法
-     */
-    @immutable()
-    public readonly method: string = undefined;
-    /**
-     * 描述
-     */
-    @immutable()
-    public readonly description: string = undefined;
-    /**
-     * 请求数据
-     */
-    @excludedInJSON()
-    @immutable()
-    public exportedInterface: Interface = undefined;
-    /**
-     * 逻辑 Id
-     */
-    @immutable()
-    public readonly logicId: string = undefined;
-    /**
-     * 逻辑
-     * @TODO 使用 excludedInJSON 有点问题，不同 class 相同字段会串
-     */
-    @excludedInJSON()
-    @immutable()
-    public logic: Logic = undefined;
-    /**
-     * Service 类型
-     */
-    @immutable()
-    public readonly serviceType:
-        'micro' | 'entity' | 'process' | 'processComponent' | 'external' | 'export' = undefined;
-    /**
-     * Service Id
-     */
-    @immutable()
-    public readonly serviceId: string = undefined;
-    /**
-     * Service Name
-     */
-    @immutable()
-    public readonly category: string = undefined;
-    /**
-     * 所属实体 Id
-     */
-    public entityId: string = undefined;
-    /**
-     * Service 名称
-     */
-    @immutable()
-    public readonly serviceName: string = undefined;
-    /**
-     * Service
-     */
-    @circular()
-    @immutable()
-    public readonly service: MicroService = undefined;
-    /**
-     * 参数
-     */
-    @immutable()
-    public parameters: string = undefined;
-    /**
-     * 返回值
-     */
-    @immutable()
-    public responses: string = undefined;
-    /**
-     * 请求数据
-     */
-    @immutable()
-    public requestBody: string = undefined;
-    /**
-     * 树组件的子节点字段
-     */
-    @excludedInJSON()
-    @immutable()
-    public readonly moreChildrenFields: Array<string> = ['logic.params', 'logic.returns', 'logic.variables'];
-    /**
-     * 周边存在的名称
-     */
-    @excludedInJSON()
-    public existingNames: Array<string> = [];
-    /**
-     * @param source 需要合并的部分参数
-     */
-    constructor(source?: Partial<Interface>) {
-        super();
-        source && this.assign(source);
-    }
-    /**
-     * 按当前 id 加载接口数据
-     * @requires this.id
-     */
-    async load() {
-        const result = await interfaceService.loadDetail({
-            path: {
-                id: this.id,
-            },
-        });
-
-        this.assign(result);
-        return this;
-    }
-    /**
-     * 添加接口
-     */
-    @action('添加接口')
-    async create(none?: void, actionOptions?: ActionOptions, then?: () => Promise<any>) {
-        config.defaultApp?.emit('saving');
-        if (!this.logicId) {
-            this.logic.assign({ name: this.name });
-            await this.logic.create();
-
-            this.assign({
-                path: this.path || '/api/' + this.name,
-                logicId: this.logic.id,
-            });
-        }
-        const body = this.toPlainJSON();
-        body.logicId = this.logicId || this.logic.id;
-        utils.logger.debug('添加接口', body);
-        const result: Interface = await interfaceService.create({
-            headers: {
-                appId: config.defaultApp?.id,
-                operationAction: actionOptions?.actionName || 'Interface.create',
-                operationDesc: actionOptions?.actionDesc || `添加接口"${this.name}"`,
-            },
-            body,
-        });
-        this.pick(result, ['id']);
-        this.assign({
-            key: `#/${this.service.id}/${this.id}`,
-        });
-
-        await then?.();
-        this.service.emit('interfacesChange');
-        this.service.emit('vertexIdToNameChange', this.id, this.name);
-        await config.defaultApp?.history.load();
-        config.defaultApp?.emit('saved');
-        return this;
-    }
-    /**
-     * 删除接口
-     */
-    @action('删除接口')
-    async delete(none?: void, actionOptions?: ActionOptions) {
-        if (this.id) {
-            config.defaultApp?.emit('saving');
-        }
-
-        if (this.logic && this.serviceType?.toLowerCase() !== 'export')
-            await this.logic.delete();
-
-        if (this.id) {
-            await interfaceService.delete({
-                headers: {
-                    appId: config.defaultApp?.id,
-                    operationAction: actionOptions?.actionName || 'Interface.delete',
-                    operationDesc: actionOptions?.actionDesc || `删除接口"${this.name}"`,
-                },
-                path: {
-                    id: this.id,
-                },
-            });
-            const index = this.service.interfaces.indexOf(this);
-            ~index && this.service.interfaces.splice(index, 1);
-
-            this.service.globalLogic.removeInterface(this);
-            this.destroy();
-            this.service.syncStructures(); // 处理 CallQueryComponent 嵌套的情形
-            this.service.emit('interfacesChange');
-
-            await config.defaultApp?.history.load();
-            config.defaultApp?.emit('saved');
-        } else {
-            const index = this.service.interfaces.indexOf(this);
-            ~index && this.service.interfaces.splice(index, 1);
-            this.service.globalLogic.removeInterface(this);
-        }
-    }
-    /**
-     * 更新接口
-     */
-    async update(none?: void, actionOptions?: ActionOptions, then?: () => Promise<any>) {
-        config.defaultApp?.emit('saving');
-
-        const body = this.toPlainJSON();
-        await interfaceService.update({
-            headers: {
-                appId: config.defaultApp?.id,
-                operationAction: actionOptions?.actionName || 'Interface.update',
-                operationDesc: actionOptions?.actionDesc || `修改接口"${this.name}"`,
-            },
-            body,
-        }).catch(catchFn(this.logic));
-        await then?.();
-        await config.defaultApp?.history.load();
-        config.defaultApp?.emit('saved');
-        return this;
-    }
-    /**
-     * 设置接口名称
-     */
-    @action('设置接口名称')
-    async setName(name: string) {
-        const originalData = {
-            name: this.name,
-            path: this.path,
-        };
-        this.assign({ name, path: '/api/' + name });
-        try {
-            await this.update(undefined, {
-                actionDesc: '设置接口名称',
-            });
-
-            this.service.emit('interfacesChange');
-            this.service.emit('vertexIdToNameChange', this.id, this.name);
-        } catch (err) {
-            this.assign(originalData);
-            throw err;
-        }
-    }
-    /**
-     * 设置接口描述
-     */
-    @action('设置接口描述')
-    async setDescription(description: string) {
-        this.assign({ description });
-        await this.update(undefined, {
-            actionDesc: '设置接口描述',
-        });
-
-        this.service.emit('interfacesChange');
-    }
-    /**
-     * 设置接口路径
-     */
-    @action('设置接口路径')
-    async setPath(path: string) {
-        this.assign({ path });
-        await this.update(undefined, {
-            actionDesc: '设置接口路径',
-        });
-
-        this.service.emit('interfacesChange');
-    }
-    /**
-     * 设置接口方法
-     */
-    @action('设置接口方法')
-    async setMethod(method: string) {
-        this.assign({ method });
-        await this.update(undefined, {
-            actionDesc: '设置接口方法',
-        });
-
-        this.service.emit('interfacesChange');
-    }
-
-    /**
-     * 设置接口参数和返回值类型
-     */
-    @action('设置接口参数和返回值')
-    async setParamAndReturn() {
-        if (this.serviceType === 'micro' && this.exportedInterface) {
-            const logic = this.logic;
-            const exportedInterface = this.exportedInterface;
-            let bodyParameters: Array<utils.ParamStruts> = [];
-            if (exportedInterface.requestBody) {
-                const body = JSON.parse(exportedInterface.requestBody);
-                const schema = body?.content['application/json']?.schema;
-                const name = body?.description?.name || 'content';
-                const required = body?.required;
-                bodyParameters = [{
-                    name,
-                    schema,
-                    in: 'body',
-                    required,
-                    defaultValue: '',
-                }];
-            }
-
-            const params: Array<utils.ParamStruts> = Object.values(JSON.parse(exportedInterface.parameters || '{}')).map((p: utils.ParamStruts) => ({
-                name: p.name,
-                schema: p.schema,
-                in: p.in,
-                required: true,
-                defaultValue: '',
-            }));
-
-            const parameters = params.concat(bodyParameters).filter((p) => !!p);
-
-            const finnalParameter: Array<utils.ParamStruts> = [];
-            if (logic) {
-                logic.params.forEach((p) => {
-                    const finded = parameters.find((param) => param.name === p.name);
-                    const isBasic = isBasicType(p.schema);
-                    if (finded) {
-                        finnalParameter.push({
-                            name: p.name,
-                            schema: p.schema,
-                            in: isBasic ? 'query' : 'body',
-                            required: finded.required,
-                            defaultValue: finded.defaultValue,
-                        });
-                    } else {
-                        finnalParameter.push({
-                            name: p.name,
-                            schema: p.schema,
-                            in: isBasic ? 'query' : 'body',
-                            required: !isBasic,
-                            defaultValue: '',
-                        });
-                    }
-                });
-            }
-            let finnalResponses = '';
-            if (logic.returns.length > 0) {
-                const p = logic.returns[0];
-                const payload = {
-                    description: {
-                        name: p.name,
-                    },
-                    content: {
-                        'application/json': {
-                            schema: p.schema,
-                        },
-                    },
-                };
-                finnalResponses = JSON.stringify({
-                    200: payload,
-                });
-            }
-
-            const {
-                parameters: finnalP,
-                requestBody: finnalB,
-            }: utils.resolvedParameter = utils.resolveParameter(finnalParameter);
-
-            exportedInterface.parameters = finnalP;
-            exportedInterface.requestBody = finnalB;
-            exportedInterface.responses = finnalResponses;
-            await exportedInterface.update();
-        }
-        this.service.emit('interfacesChange');
-    }
-
-    /**
-     * 查找引用
-     */
-    @action('查找引用')
-    async findUsage() {
-        let id = this.id;
-        if (['entity', 'micro', 'process', 'processComponent'].includes(this.serviceType)) {
-            id = this.logicId;
-        }
-        const result = await findUsageService.findUsage({
-            query: {
-                id,
-            },
-        });
-
-        return result;
-    }
-
-    /**
-     * 从后端 JSON 生成规范的 Interface 对象
-     */
-    public static from(source: any, service: Service) {
-        const item = new Interface(source);
-        item.assign({
-            service,
-            expanded: false,
-            key: `#/${service.id}/${item.id}`,
-        });
-        item.logic && item.assign({ logic: Logic.from(item.logic, item) });
-
-        return item;
-    }
-}
-
-export default Interface;

package/src/types/data/Module.ts

@@ -1,51 +0,0 @@
-import { immutable, circular } from '../decorators';
-import {
-    LEVEL_ENUM, Vertex,
-    Interface, Structure, Enum, App,
-} from '..';
-
-export interface Category {
-    level: LEVEL_ENUM.category;
-    name: string;
-    categoryInterfaces: Array<Interface>;
-    categoryStructures: Array<Structure>;
-    isLeaf: false;
-    structureExpanded: false;
-    interfaceExpanded: false;
-}
-/**
- * 数据分类
- */
-export class Module extends Vertex {
-    /**
-     * 模块名
-     */
-    @immutable()
-    public readonly name: string = '';
-    @immutable()
-    public readonly level: LEVEL_ENUM = LEVEL_ENUM.module;
-
-    @immutable()
-    public globalLogics: Array<Interface> = [];
-    public structures: Array<Structure> = [];
-    public enums: Array<Enum> = [];
-
-    public structureExpanded: Boolean = false;
-    public enumExpanded: Boolean = false;
-    public globalLogicExpanded: Boolean = false;
-    public structureHidden: Boolean = false;
-    public enumHidden: Boolean = false;
-
-    @circular()
-    @immutable()
-    public readonly app: App = undefined;
-    /**
-     * @param source 需要合并的部分参数
-     */
-    constructor(source?: Partial<Module>) {
-        super();
-        source && this.assign(source);
-    }
-}
-
-export default Module;

package/src/types/data/Schema.ts

@@ -1,133 +0,0 @@
-type integer = number;
-
-export interface BaseSchema {
-    type?: string;
-    format?: string;
-    name?: string;
-    description?: string;
-    required?: boolean;
-    nullable?: boolean;
-}
-
-export interface BooleanSchema extends BaseSchema {
-    type: 'boolean';
-    defaultValue?: boolean;
-}
-
-export interface IntegerSchema extends BaseSchema {
-    type: 'integer';
-    format?: 'byte' | 'short' | 'int' | 'long';
-    defaultValue?: integer;
-    minimum?: integer;
-    maximum?: integer;
-}
-
-export interface NumberSchema extends BaseSchema {
-    type: 'number';
-    format?: 'float' | 'double' | 'decimal';
-    defaultValue?: number;
-    minimum?: number;
-    maximum?: number;
-}
-
-export interface StringSchema extends BaseSchema {
-    type: 'string';
-    format?: 'byte' | 'binary' | 'blob' | 'uuid' | 'date' | 'time' | 'date-time' | 'enum' | 'password' | 'phone-number' | 'email';
-    defaultValue?: string;
-    minLength?: number;
-    maxLength?: number;
-}
-
-export interface ArraySchema extends BaseSchema {
-    type: 'array';
-    items: Schema;
-}
-
-export interface SetSchema extends BaseSchema {
-    type: 'set';
-    items: Schema;
-}
-export interface MapSchema extends BaseSchema {
-    type: 'map';
-    key: Schema;
-    value: Schema;
-}
-
-export interface ObjectSchema extends BaseSchema {
-    type: 'object';
-    propertyList: Array<Schema>;
-}
-
-export interface EnumItemSchema {
-    label: string,
-    value: string,
-}
-
-export interface EnumSchema extends BaseSchema {
-    type: 'enum';
-    enumItemList: Array<EnumItemSchema>;
-}
-
-/**
- * 明确一下：有 $ref 时，没有 type；有 type 时，没有 $ref。两者互斥！
- */
-export interface RefSchema extends BaseSchema {
-    $ref: string;
-    /**
-     * 当前这一版先用 isArray 来处理数组类型
-     */
-    isArray?: boolean;
-}
-
-export interface BasicSchema extends BaseSchema {
-    type: 'boolean' | 'integer' | 'number' | 'string';
-    format?: string;
-    defaultValue?: any;
-    minimum?: integer;
-    maximum?: integer;
-}
-
-export interface BasicRefSchema extends BaseSchema {
-    type?: 'boolean' | 'integer' | 'number' | 'string' | 'array' | 'set' | 'map' | 'object' | 'enum' | string;
-    format?: string;
-    defaultValue?: any;
-    minimum?: integer;
-    maximum?: integer;
-    $ref?: string;
-    isArray?: boolean;
-}
-
-export interface Schema extends BaseSchema {
-    id?: string;
-    type?: 'boolean' | 'integer' | 'number' | 'string' | 'array' | 'set' | 'map' | 'object' | 'enum' | string;
-    format?: string;
-    defaultValue?: any;
-    minimum?: integer;
-    maximum?: integer;
-    items?: Schema;
-    propertyList?: Array<Schema>;
-    typeKey?: string;
-
-    typeName?: string;
-    typeParamValue?: Schema;
-    typeParams?: Array<Schema>;
-    typeInstantiation?: Schema;
-    typeParamName?: string;
-    /**
-     * @deprecated
-     * 在后续的迭代中去掉它
-     */
-    properties?: { [name: string]: Schema };
-    enumItemList?: Array<EnumItemSchema>;
-    relationship?: string;
-    /**
-     * @deprecated
-     * 在后续的迭代中去掉它
-     */
-    enumItems?: { [name: string]: string };
-    $ref?: string;
-    isArray?: boolean;
-    isLeaf?: boolean;
-}
-
-export default Schema;