arkanalyzer 1.0.20 → 1.0.21

package/lib/core/model/ArkField.js

@@ -1,113 +1,113 @@
-"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.ArkField = exports.FieldCategory = void 0;
-const Position_1 = require("../base/Position");
-const ArkBaseModel_1 = require("./ArkBaseModel");
-var FieldCategory;
-(function (FieldCategory) {
-    FieldCategory[FieldCategory["PROPERTY_DECLARATION"] = 0] = "PROPERTY_DECLARATION";
-    FieldCategory[FieldCategory["PROPERTY_ASSIGNMENT"] = 1] = "PROPERTY_ASSIGNMENT";
-    FieldCategory[FieldCategory["SHORT_HAND_PROPERTY_ASSIGNMENT"] = 2] = "SHORT_HAND_PROPERTY_ASSIGNMENT";
-    FieldCategory[FieldCategory["SPREAD_ASSIGNMENT"] = 3] = "SPREAD_ASSIGNMENT";
-    FieldCategory[FieldCategory["PROPERTY_SIGNATURE"] = 4] = "PROPERTY_SIGNATURE";
-    FieldCategory[FieldCategory["ENUM_MEMBER"] = 5] = "ENUM_MEMBER";
-    FieldCategory[FieldCategory["INDEX_SIGNATURE"] = 6] = "INDEX_SIGNATURE";
-    FieldCategory[FieldCategory["GET_ACCESSOR"] = 7] = "GET_ACCESSOR";
-})(FieldCategory = exports.FieldCategory || (exports.FieldCategory = {}));
-/**
- * @category core/model
- */
-class ArkField extends ArkBaseModel_1.ArkBaseModel {
-    constructor() {
-        super();
-        this.code = "";
-        this.questionToken = false;
-        this.exclamationToken = false;
-        this.initializer = [];
-    }
-    getDeclaringArkClass() {
-        return this.declaringClass;
-    }
-    setDeclaringArkClass(declaringClass) {
-        this.declaringClass = declaringClass;
-    }
-    /**
-     * Returns the codes of field as a **string.**
-     * @returns the codes of field.
-     */
-    getCode() {
-        return this.code;
-    }
-    setCode(code) {
-        this.code = code;
-    }
-    getCategory() {
-        return this.category;
-    }
-    setCategory(category) {
-        this.category = category;
-    }
-    getName() {
-        return this.fieldSignature.getFieldName();
-    }
-    getType() {
-        return this.fieldSignature.getType();
-    }
-    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;
-    }
-    setQuestionToken(questionToken) {
-        this.questionToken = questionToken;
-    }
-    setExclamationToken(exclamationToken) {
-        this.exclamationToken = exclamationToken;
-    }
-    getQuestionToken() {
-        return this.questionToken;
-    }
-    getExclamationToken() {
-        return this.exclamationToken;
-    }
-    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;
-    }
-    validate() {
-        return this.validateFields(['category', 'declaringClass', 'fieldSignature']);
-    }
-}
-exports.ArkField = ArkField;
+"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.ArkField = exports.FieldCategory = void 0;
+const Position_1 = require("../base/Position");
+const ArkBaseModel_1 = require("./ArkBaseModel");
+var FieldCategory;
+(function (FieldCategory) {
+    FieldCategory[FieldCategory["PROPERTY_DECLARATION"] = 0] = "PROPERTY_DECLARATION";
+    FieldCategory[FieldCategory["PROPERTY_ASSIGNMENT"] = 1] = "PROPERTY_ASSIGNMENT";
+    FieldCategory[FieldCategory["SHORT_HAND_PROPERTY_ASSIGNMENT"] = 2] = "SHORT_HAND_PROPERTY_ASSIGNMENT";
+    FieldCategory[FieldCategory["SPREAD_ASSIGNMENT"] = 3] = "SPREAD_ASSIGNMENT";
+    FieldCategory[FieldCategory["PROPERTY_SIGNATURE"] = 4] = "PROPERTY_SIGNATURE";
+    FieldCategory[FieldCategory["ENUM_MEMBER"] = 5] = "ENUM_MEMBER";
+    FieldCategory[FieldCategory["INDEX_SIGNATURE"] = 6] = "INDEX_SIGNATURE";
+    FieldCategory[FieldCategory["GET_ACCESSOR"] = 7] = "GET_ACCESSOR";
+})(FieldCategory = exports.FieldCategory || (exports.FieldCategory = {}));
+/**
+ * @category core/model
+ */
+class ArkField extends ArkBaseModel_1.ArkBaseModel {
+    constructor() {
+        super();
+        this.code = "";
+        this.questionToken = false;
+        this.exclamationToken = false;
+        this.initializer = [];
+    }
+    getDeclaringArkClass() {
+        return this.declaringClass;
+    }
+    setDeclaringArkClass(declaringClass) {
+        this.declaringClass = declaringClass;
+    }
+    /**
+     * Returns the codes of field as a **string.**
+     * @returns the codes of field.
+     */
+    getCode() {
+        return this.code;
+    }
+    setCode(code) {
+        this.code = code;
+    }
+    getCategory() {
+        return this.category;
+    }
+    setCategory(category) {
+        this.category = category;
+    }
+    getName() {
+        return this.fieldSignature.getFieldName();
+    }
+    getType() {
+        return this.fieldSignature.getType();
+    }
+    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;
+    }
+    setQuestionToken(questionToken) {
+        this.questionToken = questionToken;
+    }
+    setExclamationToken(exclamationToken) {
+        this.exclamationToken = exclamationToken;
+    }
+    getQuestionToken() {
+        return this.questionToken;
+    }
+    getExclamationToken() {
+        return this.exclamationToken;
+    }
+    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;
+    }
+    validate() {
+        return this.validateFields(['category', 'declaringClass', 'fieldSignature']);
+    }
+}
+exports.ArkField = ArkField;

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

@@ -1,132 +1,132 @@
-import { ModuleScene, Scene } from '../../Scene';
-import { ExportInfo } from './ArkExport';
-import { ImportInfo } from './ArkImport';
-import { ArkClass } from './ArkClass';
-import { ArkNamespace } from './ArkNamespace';
-import { ClassSignature, FileSignature, NamespaceSignature } from './ArkSignature';
-export declare const notStmtOrExprKind: string[];
-/**
- * @category core/model
- */
-export declare class ArkFile {
-    private absoluteFilePath;
-    private projectDir;
-    private code;
-    private defaultClass;
-    private namespaces;
-    private classes;
-    private importInfoMap;
-    private exportInfoMap;
-    private scene;
-    private moduleScene?;
-    private fileSignature;
-    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;
-    setDefaultClass(defaultClass: ArkClass): void;
-    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[];
-    /**
-     * 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: 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[];
-    getAnonymousClassNumber(): number;
-}
+import { ModuleScene, Scene } from '../../Scene';
+import { ExportInfo } from './ArkExport';
+import { ImportInfo } from './ArkImport';
+import { ArkClass } from './ArkClass';
+import { ArkNamespace } from './ArkNamespace';
+import { ClassSignature, FileSignature, NamespaceSignature } from './ArkSignature';
+export declare const notStmtOrExprKind: string[];
+/**
+ * @category core/model
+ */
+export declare class ArkFile {
+    private absoluteFilePath;
+    private projectDir;
+    private code;
+    private defaultClass;
+    private namespaces;
+    private classes;
+    private importInfoMap;
+    private exportInfoMap;
+    private scene;
+    private moduleScene?;
+    private fileSignature;
+    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;
+    setDefaultClass(defaultClass: ArkClass): void;
+    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[];
+    /**
+     * 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: 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[];
+    getAnonymousClassNumber(): number;
+}
 //# sourceMappingURL=ArkFile.d.ts.map