@lcap/nasl 3.7.0-beta.4 → 3.7.0-beta.6

package/dist/src/concepts/EntityProperty__.d.ts

@@ -0,0 +1,255 @@
+import { TranslatorState, TranslatorGenerator } from '../translator';
+declare type changeType = 'up' | 'down';
+interface defaultCode {
+    code?: string;
+    executeCode?: boolean;
+}
+import Entity from './Entity__';
+import Module from './Module__';
+import DataSource from './DataSource__';
+import BaseNode from '../common/BaseNode';
+import TypeAnnotation from './TypeAnnotation__';
+import DatabaseTypeAnnotation from './DatabaseTypeAnnotation__';
+import DefaultValue from './DefaultValue__';
+/**
+ * 实体属性
+ */
+export declare class EntityProperty extends BaseNode {
+    /** 类名 */
+    static readonly ConceptName: string;
+    /**
+     * 是否为抽象类
+     * 抽象类不能产生 concept: string
+     */
+    static isAbstract: boolean;
+    /** 继承链 */
+    static readonly inheritanceChain: string[];
+    /**
+     * 产品概念
+     */
+    readonly concept: 'EntityProperty';
+    /**
+     * 实体属性名称
+     */
+    name: string;
+    /**
+     * 唯一标识
+     */
+    uuid: string;
+    /**
+     * 数据库列名
+     */
+    columnName: string;
+    /**
+     * 实体属性标题
+     */
+    label: string;
+    /**
+     * 实体属性描述
+     */
+    description: string;
+    /**
+     * 类型
+     */
+    typeAnnotation: TypeAnnotation;
+    /**
+     * 数据库存储类型
+     */
+    databaseTypeAnnotation: DatabaseTypeAnnotation;
+    /**
+     * 是否必填
+     */
+    required: boolean;
+    /**
+     * 默认值
+     */
+    defaultValue: DefaultValue;
+    /**
+     * 当前属性是否为主键
+     */
+    primaryKey: boolean;
+    /**
+     * 关联实体的命名空间
+     */
+    relationNamespace: string;
+    /**
+     * 关联实体
+     */
+    relationEntity: string;
+    /**
+     * 关联属性
+     */
+    relationProperty: string;
+    /**
+     * 关联属性实体记录删除规则
+     */
+    deleteRule: 'protect' | 'cascade';
+    /**
+     * 显示方式
+     */
+    display: {
+        [name: string]: boolean;
+    };
+    /**
+     * 验证规则
+     */
+    rules: Array<string>;
+    /**
+     * 生成规则
+     */
+    generationRule: 'auto' | 'autoIncrement' | 'manual';
+    /**
+     * 表示 Oracle 主键自增时的序列名称
+     */
+    sequence: string;
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<EntityProperty>);
+    static from(source: any, parentNode?: any, parentKey?: string): EntityProperty;
+    /**
+     * 设置实体属性标题
+     */
+    setLabel(label: string): void;
+    /**
+     * 设置实体属性描述
+     */
+    setDescription(description: string): void;
+    /**
+     * 设置数据库存储类型
+     */
+    setDatabaseTypeAnnotation(databaseTypeAnnotation: DatabaseTypeAnnotation): void;
+    /**
+     * 设置是否必填
+     */
+    setRequired(required: boolean): void;
+    /**
+     * 设置当前属性是否为主键
+     */
+    setPrimaryKey(primaryKey: boolean): void;
+    /**
+     * 设置生成规则
+     */
+    setGenerationRule(generationRule: 'auto' | 'autoIncrement' | 'manual'): void;
+    /**
+     * 祖先 Entity
+     */
+    get entity(): Entity;
+    /**
+     * 祖先 Module
+     */
+    get module(): Module;
+    /**
+     * 祖先 DataSource
+     */
+    get dataSource(): DataSource;
+    /**
+     * 设置实体属性名称
+     */
+    setName(name: string): Promise<void>;
+    /**
+     * 设置数据库列名
+     */
+    setColumnName(columnName: string): void;
+    delete(): Promise<void>;
+    _effect(options?: {
+        action?: 'delete';
+    }): Promise<void>;
+    /**
+     * 设置是否必填
+     */
+    setSequence(sequence: string): void;
+    /**
+     * 设置是否必填
+     */
+    setDisplay(display: {
+        [name: string]: boolean;
+    }): void;
+    setDeleteRule(deleteRule: string): void;
+    /**
+     * 根据全局设置中的数据库命名规则，生成 属性列名
+     */
+    genFormatColumnName(): any;
+    /**
+     * 根据全局设置中的数据库命名规则，将 属性列名 重命名
+     * 此方法不会 update
+     */
+    __formatColumnName(): void;
+    /**
+     * 根据全局设置中的数据库命名规则，将 属性列名 重命名
+     */
+    formatColumnName(): void;
+    toEmbeddedTS(state?: TranslatorState): TranslatorGenerator;
+    toNaturalTS(state?: TranslatorState): string;
+    toTextualNASL(state?: TranslatorState): string;
+    /**
+     * 设置数据类型
+     * @param typeAnnotation 类型标注对象
+     */
+    setDataType(typeAnnotation: TypeAnnotation): void;
+    /**
+     * 设置数据类型
+     * @param typeAnnotation 类型唯一标识
+     */
+    setDataType(typeKey: string): void;
+    static getDefaultOptions(): {
+        typeAnnotation: {
+            concept: string;
+            typeKind: string;
+            typeNamespace: string;
+            typeName: string;
+        };
+    };
+    /**
+     * 关联属性
+     */
+    clearReference(): void;
+    /**
+     * 属性上移
+     */
+    moveUp(): void;
+    /**
+     * 属性下移
+     */
+    moveDown(): void;
+    /**
+     * 数组移动位置
+     */
+    changeSort(arr: any[], index: number, type: changeType): any[];
+    /**
+     * 设置关联实体属性名称
+     */
+    setRelationProperty(relationProperty: string): void;
+    /**
+     * 设置关联实体实体名称
+     */
+    setRelationNamespace(relationNamespace: string): void;
+    /**
+     * 设置关联实体实体名称
+     */
+    setRelationEntity(relationEntity: string): void;
+    /**
+     * 设置验证规则
+     */
+    setRules(rules: Array<string>): void;
+    /**
+     * 是否可编辑
+     * */
+    get readonly(): boolean;
+    get databaseTypeInfo(): any;
+    get dataBaseTypes(): any;
+    get dataBaseTypeMap(): any;
+    get defaultDataBaseType(): any;
+    get currentDataBaseType(): any;
+    get inferredDefaultDataBaseName(): any;
+    __showAdvanced: boolean;
+    /**
+     * 是否展开
+     */
+    isLeaf: boolean;
+    /**
+     * 默认值toJS的结果
+     */
+    defaultCode: defaultCode;
+}
+export default EntityProperty;

package/dist/src/concepts/Entity__.d.ts

@@ -0,0 +1,332 @@
+import type { EmbeddedTSFileGenerator } from '../utils';
+import type Namespace from './Namespace__';
+import { TranslatorState, TranslatorGenerator } from '../translator';
+import Module from './Module__';
+import DataSource from './DataSource__';
+import BaseNode from '../common/BaseNode';
+import EntityProperty from './EntityProperty__';
+import EntityIndex from './EntityIndex__';
+/**
+ * 实体
+ */
+export declare class Entity extends BaseNode {
+    /** 类名 */
+    static readonly ConceptName: string;
+    /**
+     * 是否为抽象类
+     * 抽象类不能产生 concept: string
+     */
+    static isAbstract: boolean;
+    /** 继承链 */
+    static readonly inheritanceChain: string[];
+    /**
+     * 产品概念
+     */
+    readonly concept: 'Entity';
+    /**
+     * 实体名称
+     */
+    name: string;
+    /**
+     * 唯一标识
+     */
+    uuid: string;
+    /**
+     * 数据库表名
+     */
+    tableName: string;
+    /**
+     * 实体描述
+     */
+    description: string;
+    /**
+     * 实体来源
+     */
+    origin: 'ide' | 'sql' | 'table' | 'excel';
+    /**
+     * 实体属性列表
+     */
+    properties: Array<EntityProperty>;
+    /**
+     * 实体索引列表
+     */
+    indexes: Array<EntityIndex>;
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<Entity>);
+    static from(source: any, parentNode?: any, parentKey?: string): Entity;
+    /**
+     * 设置实体描述
+     */
+    setDescription(description: string): void;
+    getPropertyExistingNames(excludedList?: Array<EntityProperty>): string[];
+    getPropertyUniqueName(name?: string): string;
+    /**
+     * 插入实体属性
+     * @internal
+     * @param name 实体属性名称，如果不填会自动生成一个唯一名称
+     */
+    _insertPropertyAt(name: string, index: number): EntityProperty;
+    /**
+     * 插入实体属性
+     * @internal
+     * @param propertyOptions 实体属性参数
+     */
+    _insertPropertyAt(propertyOptions: Partial<EntityProperty>, index: number): EntityProperty;
+    /**
+     * 插入实体属性
+     * @internal
+     * @param property 已有的实体属性实例
+     */
+    _insertPropertyAt(property: EntityProperty, index: number): EntityProperty;
+    /**
+     * 插入实体属性
+     * @param name 实体属性名称，如果不填会自动生成一个唯一名称
+     */
+    insertPropertyAt(name: string, index: number): EntityProperty;
+    /**
+     * 插入实体属性
+     * @param propertyOptions 实体属性参数
+     */
+    insertPropertyAt(propertyOptions: Partial<EntityProperty>, index: number): EntityProperty;
+    /**
+     * 插入实体属性
+     * @param property 已有的实体属性实例
+     */
+    insertPropertyAt(property: EntityProperty, index: number): EntityProperty;
+    /**
+     * 添加实体属性
+     * @internal
+     * @param name 实体属性名称，如果不填会自动生成一个唯一名称
+     */
+    _addProperty(name?: string): EntityProperty;
+    /**
+     * 添加实体属性
+     * @internal
+     * @param propertyOptions 实体属性参数
+     */
+    _addProperty(propertyOptions: Partial<EntityProperty>): EntityProperty;
+    /**
+     * 添加实体属性
+     * @internal
+     * @param property 已有的实体属性实例
+     */
+    _addProperty(property: EntityProperty): EntityProperty;
+    /**
+     * 添加实体属性
+     * @internal
+     * @param name 实体属性名称，如果不填会自动生成一个唯一名称
+     */
+    addProperty(name?: string): EntityProperty;
+    /**
+     * 添加实体属性
+     * @param propertyOptions 实体属性参数
+     */
+    addProperty(propertyOptions: Partial<EntityProperty>): EntityProperty;
+    /**
+     * 添加实体属性
+     * @param property 已有的实体属性实例
+     */
+    addProperty(property: EntityProperty): EntityProperty;
+    getEntityIndexExistingNames(excludedList?: Array<EntityIndex>): string[];
+    getEntityIndexUniqueName(name?: string): string;
+    /**
+     * 插入实体索引
+     * @internal
+     * @param name 实体索引名称，如果不填会自动生成一个唯一名称
+     */
+    _insertEntityIndexAt(name: string, index: number): EntityIndex;
+    /**
+     * 插入实体索引
+     * @internal
+     * @param entityIndexOptions 实体索引参数
+     */
+    _insertEntityIndexAt(entityIndexOptions: Partial<EntityIndex>, index: number): EntityIndex;
+    /**
+     * 插入实体索引
+     * @internal
+     * @param entityIndex 已有的实体索引实例
+     */
+    _insertEntityIndexAt(entityIndex: EntityIndex, index: number): EntityIndex;
+    /**
+     * 插入实体索引
+     * @param name 实体索引名称，如果不填会自动生成一个唯一名称
+     */
+    insertEntityIndexAt(name: string, index: number): EntityIndex;
+    /**
+     * 插入实体索引
+     * @param entityIndexOptions 实体索引参数
+     */
+    insertEntityIndexAt(entityIndexOptions: Partial<EntityIndex>, index: number): EntityIndex;
+    /**
+     * 插入实体索引
+     * @param entityIndex 已有的实体索引实例
+     */
+    insertEntityIndexAt(entityIndex: EntityIndex, index: number): EntityIndex;
+    /**
+     * 添加实体索引
+     * @internal
+     * @param name 实体索引名称，如果不填会自动生成一个唯一名称
+     */
+    _addEntityIndex(name?: string): EntityIndex;
+    /**
+     * 添加实体索引
+     * @internal
+     * @param entityIndexOptions 实体索引参数
+     */
+    _addEntityIndex(entityIndexOptions: Partial<EntityIndex>): EntityIndex;
+    /**
+     * 添加实体索引
+     * @internal
+     * @param entityIndex 已有的实体索引实例
+     */
+    _addEntityIndex(entityIndex: EntityIndex): EntityIndex;
+    /**
+     * 添加实体索引
+     * @internal
+     * @param name 实体索引名称，如果不填会自动生成一个唯一名称
+     */
+    addEntityIndex(name?: string): EntityIndex;
+    /**
+     * 添加实体索引
+     * @param entityIndexOptions 实体索引参数
+     */
+    addEntityIndex(entityIndexOptions: Partial<EntityIndex>): EntityIndex;
+    /**
+     * 添加实体索引
+     * @param entityIndex 已有的实体索引实例
+     */
+    addEntityIndex(entityIndex: EntityIndex): EntityIndex;
+    /**
+     * 删除实体属性
+     * @param name 实体属性名称
+     */
+    removeProperty(name: string): void;
+    /**
+     * 删除实体属性
+     * @param property 已有的实体属性实例
+     */
+    removeProperty(property: EntityProperty): void;
+    /**
+     * 删除实体索引
+     * @param name 实体索引名称
+     */
+    removeEntityIndex(name: string): void;
+    /**
+     * 删除实体索引
+     * @param entityIndex 已有的实体索引实例
+     */
+    removeEntityIndex(entityIndex: EntityIndex): void;
+    /**
+     * 祖先 Module
+     */
+    get module(): Module;
+    /**
+     * 祖先 DataSource
+     */
+    get dataSource(): DataSource;
+    getPropertyExistingColumnNames(excludedList?: Array<EntityProperty>): string[];
+    getPropertyUniqueColumnName(name?: string, excludedList?: Array<EntityProperty>): string;
+    getPropertyExistingNameList(excludedList?: Array<EntityProperty>): string[];
+    /**
+     * 设置实体表名并修改表名
+     */
+    setName(name: string): void;
+    /**
+     * 设置实体表名
+     */
+    setTableName(tableName: string): void;
+    isIgnoreFormatTableAndColumnName(): boolean;
+    genFormatTableName(): any;
+    /**
+     * 根据全局设置中的数据库命名规则，生成 属性列名
+     */
+    genFormatPropertyColumnName(property: EntityProperty): any;
+    /**
+     * 根据全局设置中的数据库命名规则，将 实体表名 重命名
+     * 此方法不会 update
+     */
+    __formatTableName(): void;
+    /**
+     * 根据全局设置中的数据库命名规则，将 实体表名 重命名
+     */
+    formatTableName(): void;
+    /**
+     * 根据全局设置中的数据库命名规则，将 属性列名 重命名
+     */
+    formatPropertyColumnName(): void;
+    /**
+     * 根据全局设置中的数据库命名规则，将 属性列名 重命名
+     * 此方法不会 update
+     */
+    __formatPropertyColumnName(): void;
+    /**
+     * 根据全局设置中的数据库命名规则，将 实体表名 和 属性列名 重命名
+     */
+    formatTableAndColumnName(): void;
+    static getDefaultOptions(): {
+        properties: ({
+            concept: string;
+            name: string;
+            columnName: string;
+            label: string;
+            description: string;
+            primaryKey: boolean;
+            required: boolean;
+            typeAnnotation: {
+                concept: string;
+                typeKind: string;
+                typeNamespace: string;
+                typeName: string;
+            };
+            display: {
+                inTable: boolean;
+                inFilter: boolean;
+                inForm: boolean;
+                inDetail: boolean;
+            };
+        } | {
+            concept: string;
+            name: string;
+            columnName: string;
+            label: string;
+            description: string;
+            typeAnnotation: {
+                concept: string;
+                typeKind: string;
+                typeNamespace: string;
+                typeName: string;
+            };
+            display: {
+                inTable: boolean;
+                inFilter: boolean;
+                inForm: boolean;
+                inDetail: boolean;
+            };
+            primaryKey?: undefined;
+            required?: undefined;
+        })[];
+    };
+    toEmbeddedTS(state?: TranslatorState): TranslatorGenerator;
+    toNaturalTS(state?: TranslatorState, entityName?: string): string;
+    toTextualNASL(state?: TranslatorState): string;
+    getNamespace(): string;
+    /**
+     * 生成宿主语言的文件路径
+     * @param name 一般不用传，用于 rename
+     */
+    getEmbeddedFilePath(name?: string): string;
+    get ns(): Namespace;
+    get logics(): import("./Logic__").Logic[];
+    toEmbeddedTSFile(): EmbeddedTSFileGenerator;
+    get propertyPrimaryKeyNames(): string[];
+    /**
+     * 获取已有的属性
+     * 因为这个primaryIndex不允许添加
+     * @param excludedList 排除的集合
+     * @returns 有属性
+     */
+    getRenderEntityIndexExistingNames(excludedList?: Array<EntityIndex>): string[];
+}
+export default Entity;

package/dist/src/concepts/EnumItem__.d.ts

@@ -0,0 +1,83 @@
+import { TranslatorState, TranslatorGenerator } from '../translator';
+import Enum from './Enum__';
+import Module from './Module__';
+import { Params } from '../common/EventEmitter';
+import BaseNode from '../common/BaseNode';
+import type StaticString from './StaticString__';
+/**
+ * 枚举值
+ */
+export declare class EnumItem extends BaseNode {
+    /** 类名 */
+    static readonly ConceptName: string;
+    /**
+     * 是否为抽象类
+     * 抽象类不能产生 concept: string
+     */
+    static isAbstract: boolean;
+    /** 继承链 */
+    static readonly inheritanceChain: string[];
+    /**
+     * 产品概念
+     */
+    readonly concept: 'EnumItem';
+    /**
+     * 枚举值的值
+     */
+    value: string;
+    /**
+     * 枚举值标题
+     */
+    label: StaticString;
+    /**
+     * @param source 需要合并的部分参数
+     */
+    constructor(source?: Partial<EnumItem>);
+    static from(source: any, parentNode?: any, parentKey?: string): EnumItem;
+    /**
+     * 设置枚举值的值
+     */
+    setValue(value: string): void;
+    /**
+     * 设置枚举值标题
+     */
+    setLabel(label: StaticString): void;
+    /**
+     * 删除静态字符串
+     * @param name 静态字符串名称
+     */
+    removeLabel(name: string): void;
+    /**
+     * 删除静态字符串
+     * @param label 已有的静态字符串实例
+     */
+    removeLabel(label: StaticString): void;
+    __removeStaticString(staticString: StaticString): Params;
+    /**
+     * 祖先 Enum
+     */
+    get enumeration(): Enum;
+    /**
+     * 祖先 Module
+     */
+    get module(): Module;
+    /**
+     * 枚举子集，等点击下拉列表的时候会去赋值
+     */
+    expression: undefined;
+    /**
+     * 是否叶子节点，叶子节点隐藏展开按钮
+     */
+    isLeaf: boolean;
+    toEmbeddedTS(state?: TranslatorState): TranslatorGenerator;
+    toNaturalTS(state?: TranslatorState): string;
+    toTextualNASL(state?: TranslatorState): string;
+    setName(value: string): void;
+    getValue(): string;
+    toJS(state?: TranslatorState): string;
+    /**
+     * 设置枚举值标题
+     */
+    setLabelValue(label: string): void;
+}
+export default EnumItem;