@lcap/nasl-concepts 3.9.0-beta.1

package/out/concepts/EntityProperty__.js

@@ -0,0 +1,715 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var EntityProperty_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityProperty = void 0;
+const types_1 = require("./basics/types");
+const nasl_translator_1 = require("@lcap/nasl-translator");
+const decorators_1 = require("../decorators");
+const utils_1 = require("../utils");
+const utils = __importStar(require("../utils"));
+const BaseNode_1 = __importDefault(require("../common/BaseNode"));
+/**
+ * 实体属性
+ */
+let EntityProperty = class EntityProperty extends BaseNode_1.default {
+    static { EntityProperty_1 = this; }
+    /** 类名 */
+    static { this.ConceptName = 'EntityProperty'; }
+    /**
+     * 是否为抽象类
+     * 抽象类不能产生 concept: string
+     */
+    static { this.isAbstract = false; }
+    /** 继承链 */
+    static { this.inheritanceChain = ['BaseNode']; }
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source) {
+        source = Object.assign({}, EntityProperty_1.getDefaultOptions(), source);
+        super(source);
+        /**
+         * 实体属性名称
+         */
+        this.name = '';
+        /**
+         * 唯一标识
+         */
+        this.uuid = (0, utils_1.createUUID)();
+        /**
+         * 显示方式
+         */
+        this.display = {
+            inDetail: true,
+            inFilter: true,
+            inForm: true,
+            inTable: true,
+        };
+        /**
+         * 验证规则
+         */
+        this.rules = [];
+        /**
+         * 生成规则
+         */
+        this.generationRule = 'auto';
+        this.__showAdvanced = false;
+        /**
+         * 是否展开
+         */
+        this.isLeaf = true;
+        /**
+         * 默认值toJS的结果
+         */
+        this.defaultCode = {};
+        super.subConstructor(source);
+    }
+    static from(source, parentNode, parentKey) {
+        return super.from(source, parentNode, parentKey);
+    }
+    /**
+     * 设置实体属性标题
+     */
+    setLabel(label) {
+        const object = {
+            label,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 设置实体属性描述
+     */
+    setDescription(description) {
+        const object = {
+            description,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 设置数据库存储类型
+     */
+    setDatabaseTypeAnnotation(databaseTypeAnnotation) {
+        databaseTypeAnnotation._delete();
+        const relationOptions = { parentNode: this, parentKey: 'databaseTypeAnnotation' };
+        Object.assign(databaseTypeAnnotation, relationOptions);
+        const object = {
+            databaseTypeAnnotation,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 设置是否必填
+     */
+    setRequired(required) {
+        const object = {
+            required,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 设置当前属性是否为主键
+     */
+    setPrimaryKey(primaryKey) {
+        const object = {
+            primaryKey,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 设置生成规则
+     */
+    setGenerationRule(generationRule) {
+        const object = {
+            generationRule,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    //================================================================================
+    // ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+    // 自动生成的代码已结束。下面可以手动编写。
+    //================================================================================
+    /**
+     * 祖先 Entity
+     */
+    get entity() {
+        return this.getAncestor('Entity');
+    }
+    /**
+     * 祖先 Module
+     */
+    get module() {
+        return this.getAncestor('Module');
+    }
+    /**
+     * 祖先 DataSource
+     */
+    get dataSource() {
+        return this.getAncestor('DataSource');
+    }
+    /**
+     * 设置实体属性名称
+     */
+    async setName(name) {
+        const object = {
+            name,
+        };
+        // 列名为初始化时需赋值为属性名，同时需要与其他列名中去重
+        if (this.__columnNameInit === false) {
+            delete this.__columnNameInit;
+            const columnNames = this.parentNode.properties
+                .filter((item) => item !== this)
+                .map((item) => item.columnName);
+            const columnName = utils.unique(name, columnNames, undefined, false);
+            object.columnName = columnName;
+            this.update({
+                ...object,
+                field: 'name',
+            });
+            return;
+        }
+        // 根据 name 格式化列名
+        const oldName = this.name;
+        const oldColumnName = this.columnName;
+        this.name = name;
+        this.columnName = name;
+        this.__formatColumnName();
+        if (this.columnName !== oldColumnName && !this.parentNode.isIgnoreFormatTableAndColumnName()) {
+            object.columnName = this.columnName;
+        }
+        this.name = oldName;
+        this.columnName = oldColumnName;
+        this.app?.emit('collect:start', { actionMsg: '修改实体属性名' });
+        this.update({
+            ...object,
+            field: 'name',
+        });
+        await this._effect();
+        this.app?.emit('collect:end');
+    }
+    /**
+     * 设置数据库列名
+     */
+    setColumnName(columnName) {
+        const object = {
+            columnName,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    async delete() {
+        let actionMsg = '删除实体属性';
+        if (this.name)
+            actionMsg += `“${this.name}”`;
+        this.app?.emit('collect:start', { actionMsg });
+        // 副作用
+        await this._effect({ action: 'delete' });
+        super.delete();
+        this.app?.emit('collect:end');
+    }
+    async _effect(options = {}) {
+        // 处理选中的此字段的 CallQueryComponent
+        const callQueryComponents = new Set();
+        const refs = await this.findUsage();
+        refs.forEach((val) => {
+            const loopFindNode = (item) => {
+                if (item?.children) {
+                    item.children.forEach((i) => loopFindNode(i));
+                }
+                else {
+                    const target = item?.node?.getAncestor('CallQueryComponent');
+                    if (target) {
+                        callQueryComponents.add(target);
+                    }
+                }
+            };
+            loopFindNode(val);
+        });
+        callQueryComponents?.forEach((node) => {
+            const targetField = node.select.selectFieldElements.find((item) => item.entityAsName === this.parentNode.name && item.propertyName === this.name);
+            if (targetField) {
+                if (options.action === 'delete') {
+                    // 删除字段对应的 QueryFieldExpression
+                    targetField.delete();
+                }
+                // 更新数据结构
+                node.saveStructure();
+            }
+        });
+    }
+    /**
+     * 设置是否必填
+     */
+    setSequence(sequence) {
+        const object = {
+            sequence,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 设置是否必填
+     */
+    setDisplay(display) {
+        const object = {
+            display,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    setDeleteRule(deleteRule) {
+        const object = {
+            deleteRule,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 根据全局设置中的数据库命名规则，生成 属性列名
+     */
+    genFormatColumnName() {
+        return this.parentNode.genFormatPropertyColumnName(this);
+    }
+    /**
+     * 根据全局设置中的数据库命名规则，将 属性列名 重命名
+     * 此方法不会 update
+     */
+    __formatColumnName() {
+        const newColumnName = this.genFormatColumnName();
+        if (newColumnName && (!this.columnName || (this.columnName && newColumnName !== this.columnName))) {
+            this.columnName = newColumnName;
+        }
+    }
+    /**
+     * 根据全局设置中的数据库命名规则，将 属性列名 重命名
+     */
+    formatColumnName() {
+        const newColumnName = this.genFormatColumnName();
+        if (newColumnName && (!this.columnName || (this.columnName && newColumnName !== this.columnName))) {
+            this.setColumnName(newColumnName);
+        }
+    }
+    *toEmbeddedTS(state = (0, nasl_translator_1.createCompilerState)()) {
+        const self = this;
+        let code = '';
+        if (self.relationNamespace && self.relationEntity && self.relationProperty) {
+            code += `@nasl.annotation.EntityRelation(new ${self.relationNamespace}.${self.relationEntity}().${self.relationProperty})\n`;
+            code += (0, nasl_translator_1.indent)((state?.tabSize || 0) + 2);
+            // code += indent((state?.tabSize || 0) + 1);
+        }
+        code += self.name;
+        if (self.typeAnnotation) {
+            code += ': ';
+            code += yield* self.typeAnnotation.toEmbeddedTS((0, nasl_translator_1.shiftState)(state, code));
+        }
+        if (!state.onlyDeclaration && this.defaultValue?.expression) {
+            code += ` = `;
+            code += `${yield* this.defaultValue.toEmbeddedTS((0, nasl_translator_1.shiftState)(state, code))}`;
+        }
+        return code;
+    }
+    toNaturalTS(state = (0, nasl_translator_1.createCompilerState)()) {
+        let code = '';
+        if (state.descriptionComment)
+            code += (0, nasl_translator_1.createDescriptionComment)(state, this, ['label', 'description']);
+        if (this.relationNamespace && this.relationEntity && this.relationProperty) {
+            code += `@EntityRelation(() => new ${this.relationEntity}().${this.relationProperty})\n`;
+            code += (0, nasl_translator_1.indent)(state.tabSize);
+        }
+        code += this.name;
+        if (this.typeAnnotation) {
+            code += ': ';
+            code += this.typeAnnotation.toNaturalTS((0, nasl_translator_1.shiftState)(state, code, { inline: true }));
+        }
+        return code;
+    }
+    toTextualNASL(state = (0, nasl_translator_1.createCompilerState)()) {
+        let code = '';
+        const index = this.parentNode?.properties.indexOf(this);
+        if (index > 0)
+            code += `\n${(0, nasl_translator_1.indent)(state.tabSize)}`;
+        code += (0, nasl_translator_1.createDecoratorCode)(state, this, [
+            'label',
+            'description',
+            'uuid',
+            'columnName',
+            'databaseTypeAnnotation',
+            'required',
+            'primaryKey',
+            'generationRule',
+            'sequence',
+        ]);
+        // , 'display'
+        // if (this.relationNamespace && this.relationEntity && this.relationProperty) {
+        //   code += `@EntityRelation(() => new ${this.relationEntity}().${this.relationProperty})\n`;
+        //   code += indent(state.tabSize);
+        // }
+        code += this.name;
+        if (this.typeAnnotation) {
+            code += ': ';
+            code += this.typeAnnotation.toTextualNASL((0, nasl_translator_1.shiftState)(state, code, { inline: true }));
+        }
+        if (this.defaultValue) {
+            code += ` = ${this.defaultValue.toTextualNASL((0, nasl_translator_1.shiftState)(state, code, { inline: true }))}`;
+        }
+        return code;
+    }
+    setDataType(typeAnnotation) {
+        if (typeof typeAnnotation === 'string') {
+            typeAnnotation = types_1.dataTypesMap[typeAnnotation];
+            if (!typeAnnotation)
+                // eslint-disable-next-line prefer-rest-params
+                throw new Error(`找不到类型：${arguments[0]}`);
+        }
+        else {
+            typeAnnotation._delete?.();
+            const relationOptions = { parentId: this.id, parentConcept: this.concept, parentNode: this };
+            Object.assign(typeAnnotation, relationOptions);
+        }
+        const object = {
+            typeAnnotation,
+        };
+        if (this.defaultValue) {
+            object.defaultValue = null;
+            this.updateRelyFileNode(this.app);
+        }
+        return this.update({
+            ...object,
+        });
+    }
+    static getDefaultOptions() {
+        return {
+            typeAnnotation: {
+                concept: 'TypeAnnotation',
+                typeKind: 'primitive',
+                typeNamespace: 'nasl.core',
+                typeName: 'String',
+            },
+        };
+    }
+    /**
+     * 关联属性
+     */
+    clearReference() {
+        const object = {
+            relationEntity: null,
+            relationProperty: null,
+            relationNamespace: null,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 属性上移
+     */
+    moveUp() {
+        const properties = [...this.parentNode.properties];
+        const propertiesNameList = properties.map((item) => item.name);
+        const oldIndex = propertiesNameList.indexOf(this.name);
+        this.changeSort(properties, oldIndex, 'up');
+        this.parentNode.update({
+            properties,
+        });
+    }
+    /**
+     * 属性下移
+     */
+    moveDown() {
+        const properties = [...this.parentNode.properties];
+        const propertiesNameList = properties.map((item) => item.name);
+        const oldIndex = propertiesNameList.indexOf(this.name);
+        this.changeSort(properties, oldIndex, 'down');
+        this.parentNode.update({
+            properties,
+        });
+    }
+    /**
+     * 数组移动位置
+     */
+    changeSort(arr, index, type) {
+        arr.splice(type !== 'up' ? index : index - 1, 1, ...arr.splice(type !== 'up' ? index + 1 : index, 1, arr[type !== 'up' ? index : index - 1]));
+        return arr;
+    }
+    /**
+     * 设置关联实体属性名称
+     */
+    setRelationProperty(relationProperty) {
+        const object = {
+            relationProperty,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 设置关联实体实体名称
+     */
+    setRelationNamespace(relationNamespace) {
+        const object = {
+            relationNamespace,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 设置关联实体实体名称
+     */
+    setRelationEntity(relationEntity) {
+        const object = {
+            relationEntity,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 设置验证规则
+     */
+    setRules(rules) {
+        const object = {
+            rules,
+        };
+        this.update({
+            ...object,
+        });
+    }
+    /**
+     * 是否可编辑
+     * */
+    get readonly() {
+        return !!this.module || this.generationRule !== 'manual';
+    }
+    // 存储类型信息
+    get databaseTypeInfo() {
+        const dataSourceSqlType = this.getAncestor('DataSource')?.dataSourceSqlType;
+        const databaseTypeMap = this.app?.__databaseTypeMap?.[dataSourceSqlType] || {};
+        let { typeKind, typeName, typeNamespace } = this?.typeAnnotation || {};
+        let databaseTypeInfo;
+        if (typeNamespace?.endsWith('.metadataTypes')) {
+            const referenceNode = this.app.findNodeByCompleteName(typeNamespace + '.' + typeName)?.typeAnnotation || {};
+            typeKind = referenceNode.typeKind;
+            typeName = referenceNode.typeName;
+            typeNamespace = referenceNode.typeNamespace;
+        }
+        if (typeNamespace?.endsWith('.enums')) {
+            const referenceNode = this.app.findNodeByCompleteName(typeNamespace + '.' + typeName)?.valueType || {};
+            typeKind = referenceNode.typeKind;
+            typeName = referenceNode.typeName;
+            typeNamespace = referenceNode.typeNamespace;
+        }
+        databaseTypeInfo = databaseTypeMap[typeKind] || databaseTypeMap[typeName];
+        return databaseTypeInfo;
+    }
+    // 当前nasl类型对应的存储类型列表
+    get dataBaseTypes() {
+        return this.databaseTypeInfo?.dataBaseTypes;
+    }
+    // 当前nasl类型对应的存储类型Map
+    get dataBaseTypeMap() {
+        return this.databaseTypeInfo?.dataBaseTypeMap;
+    }
+    // 当前nasl类型对应的默认存储类型
+    get defaultDataBaseType() {
+        return this.databaseTypeInfo?.defaultDataBaseType;
+    }
+    // 当前选中的存储类型
+    get currentDataBaseType() {
+        if (this.databaseTypeAnnotation) {
+            const databaseTypeMap = this.dataBaseTypeMap || {};
+            const { typeName } = this.databaseTypeAnnotation;
+            return databaseTypeMap[typeName];
+        }
+        const { typeName } = this.typeAnnotation;
+        if (typeName === 'String') {
+            const defaultDataBaseName = this.inferredDefaultDataBaseName;
+            if (defaultDataBaseName && defaultDataBaseName !== this.defaultDataBaseType?.type) {
+                return {
+                    ...(this.dataBaseTypeMap[defaultDataBaseName] || {}),
+                };
+            }
+        }
+        return this.defaultDataBaseType;
+    }
+    // 根据最大长度推断的默认数据库类型
+    get inferredDefaultDataBaseName() {
+        let defaultDataBaseName;
+        const { typeName } = this.typeAnnotation;
+        if (typeName === 'String') {
+            const dataSourceSqlType = this.getAncestor('DataSource')?.dataSourceSqlType;
+            let maxLength;
+            const { rules } = this;
+            if (Array.isArray(rules)) {
+                // 是否需要更新规则
+                rules.forEach((rule) => {
+                    const match = rule.match(/^([^()]+)\(([\d\-.]+)\)$/);
+                    if (match) {
+                        const [, key, value] = match;
+                        if (key === 'maxLength') {
+                            maxLength = value;
+                        }
+                    }
+                });
+            }
+            // 不同数据库 最大长度 短、中、长 对应的默认储存类型
+            const sqlMap = {
+                mysql: {
+                    255: 'varchar',
+                    4000: 'text',
+                    16777215: 'mediumtext',
+                },
+                oracle: {
+                    255: 'varchar2',
+                    4000: 'clob',
+                    16777215: 'clob',
+                },
+                dameng: {
+                    255: 'varchar2',
+                    4000: 'text',
+                    16777215: 'text',
+                },
+                db2: {
+                    255: 'varchar',
+                    4000: 'clob',
+                    16777215: 'clob',
+                },
+            };
+            defaultDataBaseName = sqlMap?.[dataSourceSqlType]?.[maxLength];
+        }
+        return defaultDataBaseName;
+    }
+};
+exports.EntityProperty = EntityProperty;
+__decorate([
+    (0, decorators_1.property)()
+    // @ts-ignore
+], EntityProperty.prototype, "concept", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "name", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "uuid", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "columnName", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "label", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "description", void 0);
+__decorate([
+    (0, decorators_1.property)({
+        objectRef: 'TypeAnnotation',
+    })
+], EntityProperty.prototype, "typeAnnotation", void 0);
+__decorate([
+    (0, decorators_1.property)({
+        objectRef: 'DatabaseTypeAnnotation',
+    })
+], EntityProperty.prototype, "databaseTypeAnnotation", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "required", void 0);
+__decorate([
+    (0, decorators_1.property)({
+        objectRef: 'DefaultValue',
+    })
+], EntityProperty.prototype, "defaultValue", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "primaryKey", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "relationNamespace", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "relationEntity", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "relationProperty", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "deleteRule", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "display", void 0);
+__decorate([
+    (0, decorators_1.property)({
+        isArray: true,
+        defaultValue: [],
+    })
+], EntityProperty.prototype, "rules", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "generationRule", void 0);
+__decorate([
+    (0, decorators_1.property)()
+], EntityProperty.prototype, "sequence", void 0);
+__decorate([
+    nasl_translator_1.withSourceMapGenerator
+], EntityProperty.prototype, "toEmbeddedTS", null);
+__decorate([
+    (0, nasl_translator_1.withSourceMap)()
+], EntityProperty.prototype, "toNaturalTS", null);
+__decorate([
+    (0, nasl_translator_1.withSourceMap)()
+], EntityProperty.prototype, "toTextualNASL", null);
+exports.EntityProperty = EntityProperty = EntityProperty_1 = __decorate([
+    (0, decorators_1.concept)('实体属性')
+], EntityProperty);
+exports.default = EntityProperty;
+//================================================================================
+// ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑   ↑
+// 自动生成的代码已结束。下面可以手动编写。
+//================================================================================
+//# sourceMappingURL=EntityProperty__.js.map