@lcap/nasl-concepts 3.9.0-beta.1

package/out/concepts/EntityProperty__.d.ts

@@ -0,0 +1,254 @@
+import { TranslatorGenerator } from '@lcap/nasl-translator';
+type changeType = 'up' | 'down';
+interface defaultCode {
+    code?: string;
+    executeCode?: boolean;
+}
+import type Entity from './Entity__';
+import type Module from './Module__';
+import type DataSource from './DataSource__';
+import BaseNode from '../common/BaseNode';
+import type TypeAnnotation from './TypeAnnotation__';
+import type DatabaseTypeAnnotation from './DatabaseTypeAnnotation__';
+import type 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: Record<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?: import("@lcap/nasl-types/out/translator").TranslatorState<import("@lcap/nasl-types/out/concept").BaseNode>): TranslatorGenerator;
+    toNaturalTS(state?: import("@lcap/nasl-types/out/translator").TranslatorState<import("@lcap/nasl-types/out/concept").BaseNode>): string;
+    toTextualNASL(state?: import("@lcap/nasl-types/out/translator").TranslatorState<import("@lcap/nasl-types/out/concept").BaseNode>): 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;
+//# sourceMappingURL=EntityProperty__.d.ts.map

package/out/concepts/EntityProperty__.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityProperty__.d.ts","sourceRoot":"","sources":["../../src/concepts/EntityProperty__.ts"],"names":[],"mappings":"AAEA,OAAO,EAQL,mBAAmB,EAGpB,MAAM,uBAAuB,CAAC;AAG/B,KAAK,UAAU,GAAG,IAAI,GAAG,MAAM,CAAC;AAEhC,UAAU,WAAW;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,OAAO,KAAK,MAAM,MAAM,YAAY,CAAC;AACrC,OAAO,KAAK,MAAM,MAAM,YAAY,CAAC;AACrC,OAAO,KAAK,UAAU,MAAM,gBAAgB,CAAC;AAY7C,OAAO,QAAQ,MAAM,oBAAoB,CAAC;AAC1C,OAAO,KAAK,cAAc,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,sBAAsB,MAAM,4BAA4B,CAAC;AACrE,OAAO,KAAK,YAAY,MAAM,kBAAkB,CAAC;AAEjD;;GAEG;AACH,qBACa,cAAe,SAAQ,QAAQ;IAC1C,SAAS;IACT,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAoB;IACvD;;;OAGG;IACH,MAAM,CAAC,UAAU,EAAE,OAAO,CAAS;IACnC,UAAU;IACV,MAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAgB;IAE1D;;OAEG;IAGH,QAAQ,CAAC,OAAO,EAAG,gBAAgB,CAAC;IACpC;;OAEG;IAEH,IAAI,EAAE,MAAM,CAAM;IAElB;;OAEG;IAEH,IAAI,EAAE,MAAM,CAAgB;IAE5B;;OAEG;IAEH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IAEH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IAEH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IAIH,cAAc,EAAE,cAAc,CAAC;IAE/B;;OAEG;IAIH,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IAEH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IAIH,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;OAEG;IAEH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IAEH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IAEH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IAEH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IAEH,UAAU,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAEnC;;OAEG;IAEH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAKvB;IAET;;OAEG;IAKH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAM;IAE1B;;OAEG;IAEH,cAAc,EAAE,MAAM,GAAG,eAAe,GAAG,QAAQ,CAAU;IAE7D;;OAEG;IAEH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;gBACS,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAM5C,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,cAAc;IAI9E;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM;IAStB;;OAEG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM;IASlC;;OAEG;IACH,yBAAyB,CAAC,sBAAsB,EAAE,sBAAsB;IAYxE;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,OAAO;IAS7B;;OAEG;IACH,aAAa,CAAC,UAAU,EAAE,OAAO;IASjC;;OAEG;IACH,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,eAAe,GAAG,QAAQ;IAarE;;OAEG;IACH,IAAI,MAAM,WAET;IACD;;OAEG;IACH,IAAI,MAAM,WAET;IACD;;OAEG;IACH,IAAI,UAAU,eAEb;IAED;;OAEG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM;IA0C1B;;OAEG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM;IAS1B,MAAM;IAUN,OAAO,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,QAAQ,CAAA;KAAO;IAgCjD;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM;IAS5B;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE;IAS/C,aAAa,CAAC,UAAU,EAAE,MAAM;IAShC;;OAEG;IACH,mBAAmB;IAInB;;;OAGG;IACH,kBAAkB;IAOlB;;OAEG;IACH,gBAAgB;IAQf,YAAY,CAAC,KAAK,6GAAwB,GAAG,mBAAmB;IAqBjE,WAAW,CAAC,KAAK,6GAAwB,GAAG,MAAM;IAmBlD,aAAa,CAAC,KAAK,6GAAwB,GAAG,MAAM;IAoCpD;;;OAGG;IACH,WAAW,CAAC,cAAc,EAAE,cAAc,GAAG,IAAI;IACjD;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;WAwBpB,iBAAiB;;;;;;;;IAW/B;;OAEG;IACH,cAAc;IAWd;;OAEG;IACH,MAAM;IAUN;;OAEG;IACH,QAAQ;IASR;;OAEG;IAEH,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU;IAStD;;OAEG;IACH,mBAAmB,CAAC,gBAAgB,EAAE,MAAM;IAS5C;;OAEG;IACH,oBAAoB,CAAC,iBAAiB,EAAE,MAAM;IAS9C;;OAEG;IACH,iBAAiB,CAAC,cAAc,EAAE,MAAM;IASxC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;IAS7B;;SAEK;IACL,IAAI,QAAQ,YAEX;IAGD,IAAI,gBAAgB,QAmBnB;IAGD,IAAI,aAAa,QAEhB;IAGD,IAAI,eAAe,QAElB;IAGD,IAAI,mBAAmB,QAEtB;IAGD,IAAI,mBAAmB,QAgBtB;IAGD,IAAI,2BAA2B,QA6C9B;IAED,cAAc,EAAE,OAAO,CAAS;IAEhC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAQ;IAEvB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAM;CAM/B;AAED,eAAe,cAAc,CAAC"}