arkanalyzer 1.0.6 → 1.0.8

package/lib/core/model/ArkField.js

@@ -15,15 +15,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArkField = exports.FieldCategory = void 0;
-const Decorator_1 = require("../base/Decorator");
 const Position_1 = require("../base/Position");
-const EtsConst_1 = require("../common/EtsConst");
-const COMPONENT_MEMBER_DECORATORS = new Set([
-    'State', 'Prop', 'Link', 'StorageProp', 'StorageLink',
-    'Provide', 'Consume', 'ObjectLink',
-    'LocalStorageLink', 'LocalStorageProp',
-    'Local', 'Param', 'Event', 'Provider', 'Consumer'
-]);
+const ArkBaseModel_1 = require("./ArkBaseModel");
 var FieldCategory;
 (function (FieldCategory) {
     FieldCategory[FieldCategory["PROPERTY_DECLARATION"] = 0] = "PROPERTY_DECLARATION";
@@ -34,14 +27,14 @@ var FieldCategory;
     FieldCategory[FieldCategory["ENUM_MEMBER"] = 5] = "ENUM_MEMBER";
     FieldCategory[FieldCategory["INDEX_SIGNATURE"] = 6] = "INDEX_SIGNATURE";
     FieldCategory[FieldCategory["GET_ACCESSOR"] = 7] = "GET_ACCESSOR";
-})(FieldCategory || (exports.FieldCategory = FieldCategory = {}));
+})(FieldCategory = exports.FieldCategory || (exports.FieldCategory = {}));
 /**
  * @category core/model
  */
-class ArkField {
+class ArkField extends ArkBaseModel_1.ArkBaseModel {
     constructor() {
+        super();
         this.code = "";
-        this.modifiers = new Set();
         this.questionToken = false;
         this.exclamationToken = false;
         this.initializer = [];
@@ -52,6 +45,10 @@ class ArkField {
     setDeclaringArkClass(declaringClass) {
         this.declaringClass = declaringClass;
     }
+    /**
+     * Returns the codes of field as a **string.**
+     * @returns the codes of field.
+     */
     getCode() {
         return this.code;
     }
@@ -70,54 +67,22 @@ class ArkField {
     getType() {
         return this.fieldSignature.getType();
     }
-    getModifiers() {
-        return this.modifiers;
-    }
-    addModifier(modifier) {
-        this.modifiers.add(modifier);
-    }
     getSignature() {
         return this.fieldSignature;
     }
     setSignature(fieldSig) {
         this.fieldSignature = fieldSig;
     }
+    /**
+     * Returns an array of statements used for initialization.
+     * @returns An array of statements used for initialization.
+     */
     getInitializer() {
         return this.initializer;
     }
     setInitializer(initializer) {
         this.initializer = initializer;
     }
-    isStatic() {
-        if (this.modifiers.has("StaticKeyword")) {
-            return true;
-        }
-        return false;
-    }
-    isProtected() {
-        if (this.modifiers.has("ProtectedKeyword")) {
-            return true;
-        }
-        return false;
-    }
-    isPrivate() {
-        if (this.modifiers.has("PrivateKeyword")) {
-            return true;
-        }
-        return false;
-    }
-    isPublic() {
-        if (this.modifiers.has("PublicKeyword")) {
-            return true;
-        }
-        return false;
-    }
-    isReadonly() {
-        if (this.modifiers.has("ReadonlyKeyword")) {
-            return true;
-        }
-        return false;
-    }
     setQuestionToken(questionToken) {
         this.questionToken = questionToken;
     }
@@ -133,25 +98,16 @@ class ArkField {
     setOriginPosition(position) {
         this.originPosition = position;
     }
+    /**
+     * Returns the original position of the field at source code.
+     * @returns The original position of the field at source code.
+     */
     getOriginPosition() {
         var _a;
         return (_a = this.originPosition) !== null && _a !== void 0 ? _a : Position_1.LineColPosition.DEFAULT;
     }
-    getDecorators() {
-        return Array.from(this.modifiers).filter((item) => {
-            return item instanceof Decorator_1.Decorator;
-        });
-    }
-    getStateDecorators() {
-        return Array.from(this.modifiers).filter((item) => {
-            return (item instanceof Decorator_1.Decorator) && (COMPONENT_MEMBER_DECORATORS.has(item.getKind()));
-        });
-    }
-    hasBuilderParamDecorator() {
-        let decorators = this.getDecorators();
-        return decorators.filter((value) => {
-            return value.getKind() == EtsConst_1.BUILDER_PARAM_DECORATOR;
-        }).length != 0;
+    validate() {
+        return this.validateFields(['category', 'declaringClass', 'fieldSignature']);
     }
 }
 exports.ArkField = ArkField;

package/lib/core/model/ArkFile.d.ts

@@ -23,16 +23,40 @@ export declare class ArkFile {
     private ohPackageJson5Path;
     private anonymousClassNumber;
     constructor();
+    /**
+     * Returns the **string** name of the file, which also acts as the file's relative path.
+     * @returns The file's name (also means its relative path).
+     */
     getName(): string;
     setScene(scene: Scene): void;
+    /**
+     * Returns the scene (i.e., {@link Scene}) built for the project. The {@link Scene} is the core class of ArkAnalyzer,
+     * through which users can access all the information of the analyzed code (project),
+     * including file list, class list, method list, property list, etc.
+     * @returns The scene of the file.
+     */
     getScene(): Scene;
     getModuleScene(): ModuleScene | undefined;
     setModuleScene(moduleScene: ModuleScene): void;
     setProjectDir(projectDir: string): void;
     getProjectDir(): string;
+    /**
+     * Get a file path.
+     * @returns The absolute file path.
+     * @example
+     * 1. Read source code based on file path.
+
+    ```typescript
+    let str = fs.readFileSync(arkFile.getFilePath(), 'utf8');
+    ```
+     */
     getFilePath(): string;
     setFilePath(absoluteFilePath: string): void;
     setCode(code: string): void;
+    /**
+     * Returns the codes of file as a **string.**
+     * @returns the codes of file.
+     */
     getCode(): string;
     addArkClass(arkClass: ArkClass): void;
     getDefaultClass(): ArkClass;
@@ -40,20 +64,38 @@ export declare class ArkFile {
     getNamespace(namespaceSignature: NamespaceSignature): ArkNamespace | null;
     getNamespaceWithName(namespaceName: string): ArkNamespace | null;
     getNamespaces(): ArkNamespace[];
+    /**
+     * Returns the class based on its class signature. If the class could not be found, **null** will be returned.
+     * @param classSignature - the class signature.
+     * @returns A class. If there is no class, the return will be a **null**.
+     */
     getClass(classSignature: ClassSignature): ArkClass | null;
     getClassWithName(Class: string): ArkClass | null;
     getClasses(): ArkClass[];
     addNamespace(namespace: ArkNamespace): void;
+    /**
+     * Returns an **array** of import information.
+     * The import information includes: clause's name, type, modifiers, location where it is imported from, etc.
+     * @returns An **array** of import information.
+     */
     getImportInfos(): ImportInfo[];
     getImportInfoBy(name: string): ImportInfo | undefined;
     addImportInfo(importInfo: ImportInfo): void;
+    removeImportInfo(importInfo: ImportInfo): boolean;
+    removeNamespace(namespace: ArkNamespace): boolean;
+    removeArkClass(arkClass: ArkClass): boolean;
     getExportInfos(): ExportInfo[];
     getExportInfoBy(name: string): ExportInfo | undefined;
     addExportInfo(exportInfo: ExportInfo, key?: string): void;
+    removeExportInfo(exportInfo: ExportInfo, key?: string): void;
     getProjectName(): string;
     getModuleName(): string | undefined;
     setOhPackageJson5Path(ohPackageJson5Path: string[]): void;
     getOhPackageJson5Path(): string[];
+    /**
+     * Returns the file signature of this file. A file signature consists of project's name and file's name.
+     * @returns The file signature of this file.
+     */
     getFileSignature(): FileSignature;
     setFileSignature(fileSignature: FileSignature): void;
     getAllNamespacesUnderThisFile(): ArkNamespace[];

package/lib/core/model/ArkFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ArkFile.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkFile.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGnF,eAAO,MAAM,iBAAiB,UAEqD,CAAC;AAEpF;;GAEG;AACH,qBAAa,OAAO;IAChB,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,IAAI,CAAc;IAE1B,OAAO,CAAC,YAAY,CAAY;IAGhC,OAAO,CAAC,UAAU,CAA8D;IAChF,OAAO,CAAC,OAAO,CAAsD;IAErE,OAAO,CAAC,aAAa,CAA0D;IAC/E,OAAO,CAAC,aAAa,CAA0D;IAE/E,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,WAAW,CAAC,CAAc;IAElC,OAAO,CAAC,aAAa,CAAwC;IAE7D,OAAO,CAAC,kBAAkB,CAAgB;IAE1C,OAAO,CAAC,oBAAoB,CAAa;;IAKlC,OAAO;IAIP,QAAQ,CAAC,KAAK,EAAE,KAAK;IAIrB,QAAQ;IAIR,cAAc;IAId,cAAc,CAAC,WAAW,EAAE,WAAW;IAIvC,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC,aAAa,IAAI,MAAM;IAIvB,WAAW,IAAI,MAAM;IAIrB,WAAW,CAAC,gBAAgB,EAAE,MAAM;IAIpC,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB,OAAO;IAIP,WAAW,CAAC,QAAQ,EAAE,QAAQ;IAI9B,eAAe;IAIf,eAAe,CAAC,YAAY,EAAE,QAAQ;IAItC,YAAY,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,YAAY,GAAG,IAAI;IAKzE,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IAIhE,aAAa,IAAI,YAAY,EAAE;IAI/B,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,QAAQ,GAAG,IAAI;IAKzD,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAIhD,UAAU,IAAI,QAAQ,EAAE;IAIxB,YAAY,CAAC,SAAS,EAAE,YAAY;IAIpC,cAAc,IAAI,UAAU,EAAE;IAI9B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIrD,aAAa,CAAC,UAAU,EAAE,UAAU;IAIpC,cAAc,IAAI,UAAU,EAAE;IAU9B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIrD,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,MAAM;IAIlD,cAAc;IAId,aAAa;IAIb,qBAAqB,CAAC,kBAAkB,EAAE,MAAM,EAAE;IAIlD,qBAAqB;IAIrB,gBAAgB;IAIhB,gBAAgB,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAIpD,6BAA6B,IAAI,YAAY,EAAE;IAS/C,uBAAuB;CAGjC"}
+{"version":3,"file":"ArkFile.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkFile.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGnF,eAAO,MAAM,iBAAiB,UAEqD,CAAC;AAEpF;;GAEG;AACH,qBAAa,OAAO;IAChB,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,IAAI,CAAc;IAE1B,OAAO,CAAC,YAAY,CAAY;IAGhC,OAAO,CAAC,UAAU,CAA8D;IAChF,OAAO,CAAC,OAAO,CAAsD;IAErE,OAAO,CAAC,aAAa,CAA0D;IAC/E,OAAO,CAAC,aAAa,CAA0D;IAE/E,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,WAAW,CAAC,CAAc;IAElC,OAAO,CAAC,aAAa,CAAwC;IAE7D,OAAO,CAAC,kBAAkB,CAAgB;IAE1C,OAAO,CAAC,oBAAoB,CAAa;;IAKzC;;;OAGG;IACI,OAAO;IAIP,QAAQ,CAAC,KAAK,EAAE,KAAK;IAI5B;;;;;OAKG;IACI,QAAQ;IAIR,cAAc;IAId,cAAc,CAAC,WAAW,EAAE,WAAW;IAIvC,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC,aAAa,IAAI,MAAM;IAI9B;;;;;;;;;OASG;IACI,WAAW,IAAI,MAAM;IAIrB,WAAW,CAAC,gBAAgB,EAAE,MAAM;IAIpC,OAAO,CAAC,IAAI,EAAE,MAAM;IAI3B;;;OAGG;IACI,OAAO;IAIP,WAAW,CAAC,QAAQ,EAAE,QAAQ;IAI9B,eAAe;IAIf,eAAe,CAAC,YAAY,EAAE,QAAQ;IAItC,YAAY,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,YAAY,GAAG,IAAI;IAKzE,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IAIhE,aAAa,IAAI,YAAY,EAAE;IAItC;;;;OAIG;IACI,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,QAAQ,GAAG,IAAI;IAKzD,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IAIhD,UAAU,IAAI,QAAQ,EAAE;IAIxB,YAAY,CAAC,SAAS,EAAE,YAAY;IAI3C;;;;OAIG;IACI,cAAc,IAAI,UAAU,EAAE;IAI9B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIrD,aAAa,CAAC,UAAU,EAAE,UAAU;IAIpC,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAIjD,eAAe,CAAC,SAAS,EAAE,YAAY,GAAG,OAAO;IAMjD,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;IAM3C,cAAc,IAAI,UAAU,EAAE;IAU9B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIrD,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,MAAM;IAIlD,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IAQ5D,cAAc;IAId,aAAa;IAIb,qBAAqB,CAAC,kBAAkB,EAAE,MAAM,EAAE;IAIlD,qBAAqB;IAI5B;;;OAGG;IACI,gBAAgB;IAIhB,gBAAgB,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAIpD,6BAA6B,IAAI,YAAY,EAAE;IAS/C,uBAAuB;CAGjC"}

package/lib/core/model/ArkFile.js

@@ -37,12 +37,22 @@ class ArkFile {
         this.ohPackageJson5Path = [];
         this.anonymousClassNumber = 0;
     }
+    /**
+     * Returns the **string** name of the file, which also acts as the file's relative path.
+     * @returns The file's name (also means its relative path).
+     */
     getName() {
         return this.fileSignature.getFileName();
     }
     setScene(scene) {
         this.scene = scene;
     }
+    /**
+     * Returns the scene (i.e., {@link Scene}) built for the project. The {@link Scene} is the core class of ArkAnalyzer,
+     * through which users can access all the information of the analyzed code (project),
+     * including file list, class list, method list, property list, etc.
+     * @returns The scene of the file.
+     */
     getScene() {
         return this.scene;
     }
@@ -58,6 +68,16 @@ class ArkFile {
     getProjectDir() {
         return this.projectDir;
     }
+    /**
+     * Get a file path.
+     * @returns The absolute file path.
+     * @example
+     * 1. Read source code based on file path.
+
+    ```typescript
+    let str = fs.readFileSync(arkFile.getFilePath(), 'utf8');
+    ```
+     */
     getFilePath() {
         return this.absoluteFilePath;
     }
@@ -67,6 +87,10 @@ class ArkFile {
     setCode(code) {
         this.code = code;
     }
+    /**
+     * Returns the codes of file as a **string.**
+     * @returns the codes of file.
+     */
     getCode() {
         return this.code;
     }
@@ -89,6 +113,11 @@ class ArkFile {
     getNamespaces() {
         return Array.from(this.namespaces.values());
     }
+    /**
+     * Returns the class based on its class signature. If the class could not be found, **null** will be returned.
+     * @param classSignature - the class signature.
+     * @returns A class. If there is no class, the return will be a **null**.
+     */
     getClass(classSignature) {
         const className = classSignature.getClassName();
         return this.getClassWithName(className);
@@ -102,6 +131,11 @@ class ArkFile {
     addNamespace(namespace) {
         this.namespaces.set(namespace.getName(), namespace);
     }
+    /**
+     * Returns an **array** of import information.
+     * The import information includes: clause's name, type, modifiers, location where it is imported from, etc.
+     * @returns An **array** of import information.
+     */
     getImportInfos() {
         return Array.from(this.importInfoMap.values());
     }
@@ -111,6 +145,19 @@ class ArkFile {
     addImportInfo(importInfo) {
         this.importInfoMap.set(importInfo.getImportClauseName(), importInfo);
     }
+    removeImportInfo(importInfo) {
+        return this.importInfoMap.delete(importInfo.getImportClauseName());
+    }
+    removeNamespace(namespace) {
+        let rtn = this.namespaces.delete(namespace.getName());
+        rtn && (rtn = this.getScene().removeNamespace(namespace));
+        return rtn;
+    }
+    removeArkClass(arkClass) {
+        let rtn = this.classes.delete(arkClass.getName());
+        rtn && (rtn = this.getScene().removeClass(arkClass));
+        return rtn;
+    }
     getExportInfos() {
         const exportInfos = [];
         this.exportInfoMap.forEach((value, key) => {
@@ -126,6 +173,13 @@ class ArkFile {
     addExportInfo(exportInfo, key) {
         this.exportInfoMap.set(key !== null && key !== void 0 ? key : exportInfo.getExportClauseName(), exportInfo);
     }
+    removeExportInfo(exportInfo, key) {
+        if (key) {
+            this.exportInfoMap.delete(key);
+            return;
+        }
+        this.exportInfoMap.delete(exportInfo.getExportClauseName());
+    }
     getProjectName() {
         return this.fileSignature.getProjectName();
     }
@@ -139,6 +193,10 @@ class ArkFile {
     getOhPackageJson5Path() {
         return this.ohPackageJson5Path;
     }
+    /**
+     * Returns the file signature of this file. A file signature consists of project's name and file's name.
+     * @returns The file signature of this file.
+     */
     getFileSignature() {
         return this.fileSignature;
     }

package/lib/core/model/ArkImport.d.ts

@@ -1,25 +1,28 @@
 import { ArkFile } from './ArkFile';
 import { LineColPosition } from '../base/Position';
-import { Decorator } from '../base/Decorator';
 import { ExportInfo, FromInfo } from './ArkExport';
+import { ArkBaseModel } from './ArkBaseModel';
+import { ArkError } from '../common/ArkError';
 /**
  * @category core/model
  */
-export declare class ImportInfo implements FromInfo {
+export declare class ImportInfo extends ArkBaseModel implements FromInfo {
     private importClauseName;
     private importType;
     private importFrom?;
     private nameBeforeAs?;
-    private modifiers;
     private declaringArkFile;
     private originTsPosition?;
     private tsSourceCode?;
     private lazyExportInfo?;
     constructor();
-    build(importClauseName: string, importType: string, importFrom: string, originTsPosition: LineColPosition, modifiers: Set<string | Decorator>, nameBeforeAs?: string): void;
+    build(importClauseName: string, importType: string, importFrom: string, originTsPosition: LineColPosition, modifiers: number, nameBeforeAs?: string): void;
     getOriginName(): string;
     /**
-     * 获取实际的引用（调用时生成）
+     * Returns the export information, i.e., the actual reference generated at the time of call.
+     * The export information includes: clause's name, clause's type, modifiers, location
+     * where it is exported from, etc. If the export information could not be found, **null** will be returned.
+     * @returns The export information. If there is no export information, the return will be a **null**.
      */
     getLazyExportInfo(): ExportInfo | null;
     setDeclaringArkFile(declaringArkFile: ArkFile): void;
@@ -31,13 +34,12 @@ export declare class ImportInfo implements FromInfo {
     setImportFrom(importFrom: string): void;
     getNameBeforeAs(): string | undefined;
     setNameBeforeAs(nameBeforeAs: string | undefined): void;
-    getModifiers(): Set<string | Decorator>;
-    addModifier(name: string | Decorator): void;
     setOriginTsPosition(originTsPosition: LineColPosition): void;
     getOriginTsPosition(): LineColPosition;
     setTsSourceCode(tsSourceCode: string): void;
     getTsSourceCode(): string;
     getFrom(): string | undefined;
     isDefault(): boolean;
+    validate(): ArkError;
 }
 //# sourceMappingURL=ArkImport.d.ts.map

package/lib/core/model/ArkImport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ArkImport.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkImport.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGnD;;GAEG;AACH,qBAAa,UAAW,YAAW,QAAQ;IACvC,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,OAAO,CAAC,SAAS,CAA0D;IAE3E,OAAO,CAAC,gBAAgB,CAAW;IAEnC,OAAO,CAAC,gBAAgB,CAAC,CAAkB;IAC3C,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,OAAO,CAAC,cAAc,CAAC,CAAoB;;IAKpC,KAAK,CAAC,gBAAgB,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,eAAe,EACnG,SAAS,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,YAAY,CAAC,EAAE,MAAM;IAW/D,aAAa,IAAI,MAAM;IAI9B;;OAEG;IACI,iBAAiB,IAAI,UAAU,GAAG,IAAI;IAOtC,mBAAmB,CAAC,gBAAgB,EAAE,OAAO,GAAG,IAAI;IAIpD,mBAAmB,IAAI,OAAO;IAI9B,mBAAmB,IAAI,MAAM;IAI7B,mBAAmB,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;IAInD,aAAa,IAAI,MAAM;IAIvB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAIvC,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAIvC,eAAe,IAAI,MAAM,GAAG,SAAS;IAIrC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS;IAIhD,YAAY,IAAI,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC;IAIvC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAI3C,mBAAmB,CAAC,gBAAgB,EAAE,eAAe,GAAG,IAAI;IAI5D,mBAAmB,IAAI,eAAe;IAItC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAI3C,eAAe,IAAI,MAAM;IAIzB,OAAO,IAAI,MAAM,GAAG,SAAS;IAI7B,SAAS,IAAI,OAAO;CAM9B"}
+{"version":3,"file":"ArkImport.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkImport.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C;;GAEG;AACH,qBAAa,UAAW,SAAQ,YAAa,YAAW,QAAQ;IAC5D,OAAO,CAAC,gBAAgB,CAAc;IACtC,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,OAAO,CAAC,gBAAgB,CAAW;IAEnC,OAAO,CAAC,gBAAgB,CAAC,CAAkB;IAC3C,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,OAAO,CAAC,cAAc,CAAC,CAAoB;;IAMpC,KAAK,CAAC,gBAAgB,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,eAAe,EACnG,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;IAS9C,aAAa,IAAI,MAAM;IAI9B;;;;;OAKG;IACI,iBAAiB,IAAI,UAAU,GAAG,IAAI;IAOtC,mBAAmB,CAAC,gBAAgB,EAAE,OAAO,GAAG,IAAI;IAIpD,mBAAmB,IAAI,OAAO;IAI9B,mBAAmB,IAAI,MAAM;IAI7B,mBAAmB,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;IAInD,aAAa,IAAI,MAAM;IAIvB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAIvC,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAIvC,eAAe,IAAI,MAAM,GAAG,SAAS;IAIrC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS;IAIhD,mBAAmB,CAAC,gBAAgB,EAAE,eAAe,GAAG,IAAI;IAI5D,mBAAmB,IAAI,eAAe;IAItC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAI3C,eAAe,IAAI,MAAM;IAIzB,OAAO,IAAI,MAAM,GAAG,SAAS;IAI7B,SAAS,IAAI,OAAO;IAOpB,QAAQ,IAAI,QAAQ;CAG9B"}

package/lib/core/model/ArkImport.js

@@ -17,23 +17,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImportInfo = void 0;
 const Position_1 = require("../base/Position");
 const ModelUtils_1 = require("../common/ModelUtils");
+const ArkBaseModel_1 = require("./ArkBaseModel");
 /**
  * @category core/model
  */
-class ImportInfo {
+class ImportInfo extends ArkBaseModel_1.ArkBaseModel {
     constructor() {
+        super();
         this.importClauseName = '';
         this.importType = '';
-        this.modifiers = new Set();
     }
     build(importClauseName, importType, importFrom, originTsPosition, modifiers, nameBeforeAs) {
         this.setImportClauseName(importClauseName);
         this.setImportType(importType);
         this.setImportFrom(importFrom);
         this.setOriginTsPosition(originTsPosition);
-        modifiers.forEach((modifier) => {
-            this.addModifier(modifier);
-        });
+        this.addModifier(modifiers);
         this.setNameBeforeAs(nameBeforeAs);
     }
     getOriginName() {
@@ -41,7 +40,10 @@ class ImportInfo {
         return (_a = this.nameBeforeAs) !== null && _a !== void 0 ? _a : this.importClauseName;
     }
     /**
-     * 获取实际的引用（调用时生成）
+     * Returns the export information, i.e., the actual reference generated at the time of call.
+     * The export information includes: clause's name, clause's type, modifiers, location
+     * where it is exported from, etc. If the export information could not be found, **null** will be returned.
+     * @returns The export information. If there is no export information, the return will be a **null**.
      */
     getLazyExportInfo() {
         if (this.lazyExportInfo === undefined) {
@@ -76,12 +78,6 @@ class ImportInfo {
     setNameBeforeAs(nameBeforeAs) {
         this.nameBeforeAs = nameBeforeAs;
     }
-    getModifiers() {
-        return this.modifiers;
-    }
-    addModifier(name) {
-        this.modifiers.add(name);
-    }
     setOriginTsPosition(originTsPosition) {
         this.originTsPosition = originTsPosition;
     }
@@ -105,5 +101,8 @@ class ImportInfo {
         }
         return this.importType === 'Identifier';
     }
+    validate() {
+        return this.validateFields(['declaringArkFile']);
+    }
 }
 exports.ImportInfo = ImportInfo;

package/lib/core/model/ArkMetadata.d.ts

@@ -0,0 +1,20 @@
+export declare enum ArkMetadataKind {
+    LEADING_COMMENTS = 0
+}
+export type ArkMetadataType = string[];
+/**
+ * ArkMetadata
+ * @example
+ * // get leading comments
+ * let stmt: Stmt = xxx;
+ * let comments = stmt.getMetadata(ArkMetadataKind.LEADING_COMMENTS) || [];
+ * comments.forEach((comment) => {
+ *   logger.info(comment);
+ * });
+ */
+export declare class ArkMetadata {
+    protected metadata?: Map<ArkMetadataKind, ArkMetadataType>;
+    getMetadata(kind: ArkMetadataKind): ArkMetadataType | undefined;
+    setMetadata(kind: ArkMetadataKind, value: ArkMetadataType): void;
+}
+//# sourceMappingURL=ArkMetadata.d.ts.map

package/lib/core/model/ArkMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArkMetadata.d.ts","sourceRoot":"","sources":["../../../src/core/model/ArkMetadata.ts"],"names":[],"mappings":"AAeA,oBAAY,eAAe;IACvB,gBAAgB,IAAA;CACnB;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,EAAE,CAAC;AAEvC;;;;;;;;;GASG;AACH,qBAAa,WAAW;IACpB,SAAS,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;IAEpD,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,eAAe,GAAG,SAAS;IAI/D,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,eAAe,GAAG,IAAI;CAM1E"}

package/lib/core/model/ArkMetadata.js

@@ -0,0 +1,44 @@
+"use strict";
+/*
+ * Copyright (c) 2024 Huawei Device Co., Ltd.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArkMetadata = exports.ArkMetadataKind = void 0;
+var ArkMetadataKind;
+(function (ArkMetadataKind) {
+    ArkMetadataKind[ArkMetadataKind["LEADING_COMMENTS"] = 0] = "LEADING_COMMENTS";
+})(ArkMetadataKind = exports.ArkMetadataKind || (exports.ArkMetadataKind = {}));
+/**
+ * ArkMetadata
+ * @example
+ * // get leading comments
+ * let stmt: Stmt = xxx;
+ * let comments = stmt.getMetadata(ArkMetadataKind.LEADING_COMMENTS) || [];
+ * comments.forEach((comment) => {
+ *   logger.info(comment);
+ * });
+ */
+class ArkMetadata {
+    getMetadata(kind) {
+        var _a;
+        return (_a = this.metadata) === null || _a === void 0 ? void 0 : _a.get(kind);
+    }
+    setMetadata(kind, value) {
+        if (!this.metadata) {
+            this.metadata = new Map();
+        }
+        this.metadata.set(kind, value);
+    }
+}
+exports.ArkMetadata = ArkMetadata;