arkanalyzer 1.0.20 → 1.0.22

package/lib/core/model/ArkFile.js

@@ -1,267 +1,267 @@
-"use strict";
-/*
- * Copyright (c) 2024-2025 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.ArkFile = exports.notStmtOrExprKind = void 0;
-const ArkNamespace_1 = require("./ArkNamespace");
-const ArkSignature_1 = require("./ArkSignature");
-const TSConst_1 = require("../common/TSConst");
-exports.notStmtOrExprKind = ['ModuleDeclaration', 'ClassDeclaration', 'InterfaceDeclaration', 'EnumDeclaration', 'ExportDeclaration',
-    'ExportAssignment', 'MethodDeclaration', 'Constructor', 'FunctionDeclaration', 'GetAccessor', 'SetAccessor', 'ArrowFunction',
-    'FunctionExpression', 'MethodSignature', 'ConstructSignature', 'CallSignature'];
-/**
- * @category core/model
- */
-class ArkFile {
-    constructor() {
-        this.absoluteFilePath = '';
-        this.projectDir = '';
-        this.code = '';
-        // name to model
-        this.namespaces = new Map(); // don't contain nested namespaces
-        this.classes = new Map(); // don't contain class in namespace
-        this.importInfoMap = new Map();
-        this.exportInfoMap = new Map();
-        this.fileSignature = ArkSignature_1.FileSignature.DEFAULT;
-        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;
-    }
-    getModuleScene() {
-        return this.moduleScene;
-    }
-    setModuleScene(moduleScene) {
-        this.moduleScene = moduleScene;
-    }
-    setProjectDir(projectDir) {
-        this.projectDir = projectDir;
-    }
-    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;
-    }
-    setFilePath(absoluteFilePath) {
-        this.absoluteFilePath = absoluteFilePath;
-    }
-    setCode(code) {
-        this.code = code;
-    }
-    /**
-     * Returns the codes of file as a **string.**
-     * @returns the codes of file.
-     */
-    getCode() {
-        return this.code;
-    }
-    addArkClass(arkClass) {
-        this.classes.set(arkClass.getName(), arkClass);
-    }
-    getDefaultClass() {
-        return this.defaultClass;
-    }
-    setDefaultClass(defaultClass) {
-        this.defaultClass = defaultClass;
-    }
-    getNamespace(namespaceSignature) {
-        const namespaceName = namespaceSignature.getNamespaceName();
-        return this.getNamespaceWithName(namespaceName);
-    }
-    getNamespaceWithName(namespaceName) {
-        return this.namespaces.get(namespaceName) || null;
-    }
-    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 instanceof ArkSignature_1.AliasClassSignature ? classSignature.getOriginName()
-            : classSignature.getClassName();
-        return this.getClassWithName(className);
-    }
-    getClassWithName(Class) {
-        return this.classes.get(Class) || null;
-    }
-    getClasses() {
-        return Array.from(this.classes.values());
-    }
-    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());
-    }
-    getImportInfoBy(name) {
-        return this.importInfoMap.get(name);
-    }
-    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) => {
-            if (key !== TSConst_1.ALL || value.getFrom()) {
-                exportInfos.push(value);
-            }
-        });
-        return exportInfos;
-    }
-    /**
-     * Find out the {@link ExportInfo} of this {@link ArkFile} by the given export name.
-     * It returns an {@link ExportInfo} or 'undefined' if it failed to find.
-     * @param name
-     * @returns
-     * @example
-     ```typescript
-     // abc.ts ArkFile
-     export class A {
-     ...
-     }
-
-     export namespace B {
-     export namespace C {
-     export class D {}
-     }
-     }
-
-     // xyz.ts call getExportInfoBy
-     let arkFile = scene.getFile(fileSignature);
-
-     // a is the export class A defined in abc.ts
-     let a = arkFile.getExportInfoBy('A');
-
-     // b is the export class D within namespace C defined in abc.ts
-     let b = arkFile.getExportInfoBy('B.C.D');
-     ```
-     */
-    getExportInfoBy(name) {
-        const separator = '.';
-        const names = name.split(separator);
-        if (names.length === 1) {
-            return this.exportInfoMap.get(names[0]);
-        }
-        let index = 0;
-        let currExportInfo = this.exportInfoMap.get(names[index]);
-        if (currExportInfo === undefined) {
-            return undefined;
-        }
-        for (let i = 1; i < names.length; i++) {
-            const arkExport = currExportInfo.getArkExport();
-            if (arkExport && arkExport instanceof ArkNamespace_1.ArkNamespace) {
-                currExportInfo = arkExport.getExportInfoBy(names[i]);
-                if (currExportInfo === undefined) {
-                    return undefined;
-                }
-            }
-        }
-        return currExportInfo;
-    }
-    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();
-    }
-    getModuleName() {
-        var _a;
-        return (_a = this.moduleScene) === null || _a === void 0 ? void 0 : _a.getModuleName();
-    }
-    setOhPackageJson5Path(ohPackageJson5Path) {
-        this.ohPackageJson5Path = ohPackageJson5Path;
-    }
-    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;
-    }
-    setFileSignature(fileSignature) {
-        this.fileSignature = fileSignature;
-    }
-    getAllNamespacesUnderThisFile() {
-        let namespaces = [];
-        namespaces.push(...this.namespaces.values());
-        this.namespaces.forEach((ns) => {
-            namespaces.push(...ns.getAllNamespacesUnderThisNamespace());
-        });
-        return namespaces;
-    }
-    getAnonymousClassNumber() {
-        return this.anonymousClassNumber++;
-    }
-}
-exports.ArkFile = ArkFile;
+"use strict";
+/*
+ * Copyright (c) 2024-2025 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.ArkFile = exports.notStmtOrExprKind = void 0;
+const ArkNamespace_1 = require("./ArkNamespace");
+const ArkSignature_1 = require("./ArkSignature");
+const TSConst_1 = require("../common/TSConst");
+exports.notStmtOrExprKind = ['ModuleDeclaration', 'ClassDeclaration', 'InterfaceDeclaration', 'EnumDeclaration', 'ExportDeclaration',
+    'ExportAssignment', 'MethodDeclaration', 'Constructor', 'FunctionDeclaration', 'GetAccessor', 'SetAccessor', 'ArrowFunction',
+    'FunctionExpression', 'MethodSignature', 'ConstructSignature', 'CallSignature'];
+/**
+ * @category core/model
+ */
+class ArkFile {
+    constructor() {
+        this.absoluteFilePath = '';
+        this.projectDir = '';
+        this.code = '';
+        // name to model
+        this.namespaces = new Map(); // don't contain nested namespaces
+        this.classes = new Map(); // don't contain class in namespace
+        this.importInfoMap = new Map();
+        this.exportInfoMap = new Map();
+        this.fileSignature = ArkSignature_1.FileSignature.DEFAULT;
+        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;
+    }
+    getModuleScene() {
+        return this.moduleScene;
+    }
+    setModuleScene(moduleScene) {
+        this.moduleScene = moduleScene;
+    }
+    setProjectDir(projectDir) {
+        this.projectDir = projectDir;
+    }
+    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;
+    }
+    setFilePath(absoluteFilePath) {
+        this.absoluteFilePath = absoluteFilePath;
+    }
+    setCode(code) {
+        this.code = code;
+    }
+    /**
+     * Returns the codes of file as a **string.**
+     * @returns the codes of file.
+     */
+    getCode() {
+        return this.code;
+    }
+    addArkClass(arkClass) {
+        this.classes.set(arkClass.getName(), arkClass);
+    }
+    getDefaultClass() {
+        return this.defaultClass;
+    }
+    setDefaultClass(defaultClass) {
+        this.defaultClass = defaultClass;
+    }
+    getNamespace(namespaceSignature) {
+        const namespaceName = namespaceSignature.getNamespaceName();
+        return this.getNamespaceWithName(namespaceName);
+    }
+    getNamespaceWithName(namespaceName) {
+        return this.namespaces.get(namespaceName) || null;
+    }
+    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 instanceof ArkSignature_1.AliasClassSignature ? classSignature.getOriginName()
+            : classSignature.getClassName();
+        return this.getClassWithName(className);
+    }
+    getClassWithName(Class) {
+        return this.classes.get(Class) || null;
+    }
+    getClasses() {
+        return Array.from(this.classes.values());
+    }
+    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());
+    }
+    getImportInfoBy(name) {
+        return this.importInfoMap.get(name);
+    }
+    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) => {
+            if (key !== TSConst_1.ALL || value.getFrom()) {
+                exportInfos.push(value);
+            }
+        });
+        return exportInfos;
+    }
+    /**
+     * Find out the {@link ExportInfo} of this {@link ArkFile} by the given export name.
+     * It returns an {@link ExportInfo} or 'undefined' if it failed to find.
+     * @param name
+     * @returns
+     * @example
+     ```typescript
+     // abc.ts ArkFile
+     export class A {
+     ...
+     }
+
+     export namespace B {
+     export namespace C {
+     export class D {}
+     }
+     }
+
+     // xyz.ts call getExportInfoBy
+     let arkFile = scene.getFile(fileSignature);
+
+     // a is the export class A defined in abc.ts
+     let a = arkFile.getExportInfoBy('A');
+
+     // b is the export class D within namespace C defined in abc.ts
+     let b = arkFile.getExportInfoBy('B.C.D');
+     ```
+     */
+    getExportInfoBy(name) {
+        const separator = '.';
+        const names = name.split(separator);
+        if (names.length === 1) {
+            return this.exportInfoMap.get(names[0]);
+        }
+        let index = 0;
+        let currExportInfo = this.exportInfoMap.get(names[index]);
+        if (currExportInfo === undefined) {
+            return undefined;
+        }
+        for (let i = 1; i < names.length; i++) {
+            const arkExport = currExportInfo.getArkExport();
+            if (arkExport && arkExport instanceof ArkNamespace_1.ArkNamespace) {
+                currExportInfo = arkExport.getExportInfoBy(names[i]);
+                if (currExportInfo === undefined) {
+                    return undefined;
+                }
+            }
+        }
+        return currExportInfo;
+    }
+    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();
+    }
+    getModuleName() {
+        var _a;
+        return (_a = this.moduleScene) === null || _a === void 0 ? void 0 : _a.getModuleName();
+    }
+    setOhPackageJson5Path(ohPackageJson5Path) {
+        this.ohPackageJson5Path = ohPackageJson5Path;
+    }
+    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;
+    }
+    setFileSignature(fileSignature) {
+        this.fileSignature = fileSignature;
+    }
+    getAllNamespacesUnderThisFile() {
+        let namespaces = [];
+        namespaces.push(...this.namespaces.values());
+        this.namespaces.forEach((ns) => {
+            namespaces.push(...ns.getAllNamespacesUnderThisNamespace());
+        });
+        return namespaces;
+    }
+    getAnonymousClassNumber() {
+        return this.anonymousClassNumber++;
+    }
+}
+exports.ArkFile = ArkFile;

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

@@ -1,45 +1,45 @@
-import { ArkFile } from './ArkFile';
-import { LineColPosition } from '../base/Position';
-import { ExportInfo, FromInfo } from './ArkExport';
-import { ArkBaseModel } from './ArkBaseModel';
-import { ArkError } from '../common/ArkError';
-/**
- * @category core/model
- */
-export declare class ImportInfo extends ArkBaseModel implements FromInfo {
-    private importClauseName;
-    private importType;
-    private importFrom?;
-    private nameBeforeAs?;
-    private declaringArkFile;
-    private originTsPosition?;
-    private tsSourceCode?;
-    private lazyExportInfo?;
-    constructor();
-    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;
-    getDeclaringArkFile(): ArkFile;
-    getImportClauseName(): string;
-    setImportClauseName(importClauseName: string): void;
-    getImportType(): string;
-    setImportType(importType: string): void;
-    setImportFrom(importFrom: string): void;
-    getNameBeforeAs(): string | undefined;
-    setNameBeforeAs(nameBeforeAs: string | undefined): void;
-    setOriginTsPosition(originTsPosition: LineColPosition): void;
-    getOriginTsPosition(): LineColPosition;
-    setTsSourceCode(tsSourceCode: string): void;
-    getTsSourceCode(): string;
-    getFrom(): string | undefined;
-    isDefault(): boolean;
-    validate(): ArkError;
-}
+import { ArkFile } from './ArkFile';
+import { LineColPosition } from '../base/Position';
+import { ExportInfo, FromInfo } from './ArkExport';
+import { ArkBaseModel } from './ArkBaseModel';
+import { ArkError } from '../common/ArkError';
+/**
+ * @category core/model
+ */
+export declare class ImportInfo extends ArkBaseModel implements FromInfo {
+    private importClauseName;
+    private importType;
+    private importFrom?;
+    private nameBeforeAs?;
+    private declaringArkFile;
+    private originTsPosition?;
+    private tsSourceCode?;
+    private lazyExportInfo?;
+    constructor();
+    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;
+    getDeclaringArkFile(): ArkFile;
+    getImportClauseName(): string;
+    setImportClauseName(importClauseName: string): void;
+    getImportType(): string;
+    setImportType(importType: string): void;
+    setImportFrom(importFrom: string): void;
+    getNameBeforeAs(): string | undefined;
+    setNameBeforeAs(nameBeforeAs: string | undefined): 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