@itwin/ecschema2ts 4.0.0-dev.8 → 4.0.0-dev.81

package/lib/cjs/ecschema2ts.d.ts

@@ -1,131 +1,131 @@
-import { Schema } from "@itwin/ecschema-metadata";
-/**
- * @beta
- */
-export declare class ECSchemaToTs {
-    private _tsBentleyModuleNames;
-    private _tsBentleyModuleResolvedConflictNames;
-    private _schema?;
-    private _schemaItemList;
-    constructor();
-    /**
-     * Given the schema, the function will converted it to typescript strings
-     * @param schema The schema to be converted to typescript strings
-     */
-    convertSchemaToTs(schema: Schema): {
-        schemaTsString: string;
-        elemTsString: string;
-        propsTsString: string;
-    };
-    /**
-     * The function will push all the base classes to be the first ones in the schema item list.
-     * For example, if class A extends base class B and base class C, B and C will be on the first of the list and then A at the end.
-     * If B extends C, then B will be first and C will be next in the list and then A at the end.
-     * If B and C does not depend on each other, the order of B and C will not be important.
-     * The arrangement is to make sure that base class will be converted first and then, derived classes and so on
-     */
-    private dependencyToFront;
-    /**
-     * The function converts the schema meta data to typescript Schema class
-     */
-    private convertSchemaToTsClass;
-    /**
-     * The function converts the schema item to respective typescript classes
-     */
-    private convertElemToTsClasses;
-    /**
-     * The function converts the schema item properties to respective typescript props interfaces
-     */
-    private convertPropsToTsInterfaces;
-    /**
-     * Convert mixin or struct class or entity class to respective typescript interface
-     * @param ecClass Schema mixin or struct or entity to be converted typescript interface
-     * @param classNameToModule Typescrip modules to be updated after the conversion
-     */
-    private convertECClassPropsToTsInterface;
-    /**
-     * Convert schema enumeration to typescript enumeration
-     * @param ecEnum Schema enumeration to be converted to typescript enumeration
-     */
-    private convertEnumToTs;
-    /**
-     * Convert schema entity to typescript entity class. The typescript class will implement respective props
-     * typescript interface if the schema entity class has properties
-     * @param ecClass Schema class to be converted to typescript class
-     * @param classNameToModule Typescrip modules to be updated after the conversion
-     */
-    private convertEntityToTs;
-    /**
-     * Convert class properties to typescript member declaration
-     * @param ecClass The schema class that has the properties to be converted to typescript member variables
-     * @param classNameToModule Typescrip modules to be updated after the conversion
-     */
-    private convertPropsToTsVars;
-    /**
-     * Convert schema extended type to typescript type
-     * @param typeName Schema extended type to be converted to typescript type
-     * @param classNameToModule Typescrip modules to be updated after the conversion
-     */
-    private convertExtendedTypeNameToTsType;
-    /**
-     * Convert schema primitive type to typescript type
-     * @param type Schema primitive type to be converted to typescript type
-     * @param classNameToModule Typescrip modules to be updated after the conversion
-     */
-    private convertPrimitiveTypeToTsType;
-    /**
-     * Convert schema description to typescript comment
-     * @param description Schema description to be converted to typescript comment
-     */
-    private convertDescriptionToTsComment;
-    /**
-     * Convert all modules needed for the converted schema types to typescript import statements
-     * @param classNameToModule Modules to be converted to typescript imports statement
-     */
-    private convertImportToTsImport;
-    /**
-     * Traverse the inheritance tree to retrieve first base classes that have properties
-     * @param ecClass Schema class to be traverse
-     */
-    private getBaseClassWithProps;
-    /**
-     * Traverse the inheritance tree to retrieve base classes of a schema class
-     * @param ecClass Schema class to be traverse
-     */
-    private getAllBaseClasses;
-    /**
-     * Traverse the inheritance tree horizontally and vertically of a schema class
-     * @param ecClass Schema class to be traverse
-     * @param visited Set of classes that are already visited
-     * @param shouldTraverseDown Lambda to determine if it should traverse more vertically
-     */
-    private traverseBaseClass;
-    /**
-     * Add required typescript class that is to be imported from a required module during Schema conversion to typescript. If there is naming conflict
-     * it will resolve it by appending prefix name with class name, for example: import { element as BisCoreElement } from "BisCoreElement";
-     * @param classNameToModule Typescript modules that is needed for the conversion. It maps typescript class with the required modules
-     * @param refModule Typescript module that the typescrip class comes from
-     * @param className Required Typescript class for the conversion
-     */
-    private addImportClass;
-    /**
-     * Add appropriate typescript props interface to the classNameToModule and return the corresponding typescript base props interface
-     * @param classNameToModule Typescript modules that is needed for the conversion. It maps typescript class with the required modules
-     * @param baseECClass Base class of ecClass that has properties. Its name will be used to derived typescript base props interface
-     * @param ecClass ECClass to be converted to Typescript
-     */
-    private addImportBasePropsClass;
-    /**
-     * Add appropriate typescript base class to the classNameToModule and return the corresponding typescript base class
-     * @param classNameToModule Typescript modules that is needed for the conversion. It maps typescript class with the required modules
-     * @param baseECClass Base class of ecClass
-     * @param ecClass ECClass to be converted to Typescript
-     */
-    private addImportBaseClass;
-    /**
-     * Lower the first character of the property name
-     * @param propName Property name
-     */
-    private lowerPropertyName;
-}
+import { Schema } from "@itwin/ecschema-metadata";
+/**
+ * @beta
+ */
+export declare class ECSchemaToTs {
+    private _tsBentleyModuleNames;
+    private _tsBentleyModuleResolvedConflictNames;
+    private _schema?;
+    private _schemaItemList;
+    constructor();
+    /**
+     * Given the schema, the function will converted it to typescript strings
+     * @param schema The schema to be converted to typescript strings
+     */
+    convertSchemaToTs(schema: Schema): {
+        schemaTsString: string;
+        elemTsString: string;
+        propsTsString: string;
+    };
+    /**
+     * The function will push all the base classes to be the first ones in the schema item list.
+     * For example, if class A extends base class B and base class C, B and C will be on the first of the list and then A at the end.
+     * If B extends C, then B will be first and C will be next in the list and then A at the end.
+     * If B and C does not depend on each other, the order of B and C will not be important.
+     * The arrangement is to make sure that base class will be converted first and then, derived classes and so on
+     */
+    private dependencyToFront;
+    /**
+     * The function converts the schema meta data to typescript Schema class
+     */
+    private convertSchemaToTsClass;
+    /**
+     * The function converts the schema item to respective typescript classes
+     */
+    private convertElemToTsClasses;
+    /**
+     * The function converts the schema item properties to respective typescript props interfaces
+     */
+    private convertPropsToTsInterfaces;
+    /**
+     * Convert mixin or struct class or entity class to respective typescript interface
+     * @param ecClass Schema mixin or struct or entity to be converted typescript interface
+     * @param classNameToModule Typescrip modules to be updated after the conversion
+     */
+    private convertECClassPropsToTsInterface;
+    /**
+     * Convert schema enumeration to typescript enumeration
+     * @param ecEnum Schema enumeration to be converted to typescript enumeration
+     */
+    private convertEnumToTs;
+    /**
+     * Convert schema entity to typescript entity class. The typescript class will implement respective props
+     * typescript interface if the schema entity class has properties
+     * @param ecClass Schema class to be converted to typescript class
+     * @param classNameToModule Typescrip modules to be updated after the conversion
+     */
+    private convertEntityToTs;
+    /**
+     * Convert class properties to typescript member declaration
+     * @param ecClass The schema class that has the properties to be converted to typescript member variables
+     * @param classNameToModule Typescrip modules to be updated after the conversion
+     */
+    private convertPropsToTsVars;
+    /**
+     * Convert schema extended type to typescript type
+     * @param typeName Schema extended type to be converted to typescript type
+     * @param classNameToModule Typescrip modules to be updated after the conversion
+     */
+    private convertExtendedTypeNameToTsType;
+    /**
+     * Convert schema primitive type to typescript type
+     * @param type Schema primitive type to be converted to typescript type
+     * @param classNameToModule Typescrip modules to be updated after the conversion
+     */
+    private convertPrimitiveTypeToTsType;
+    /**
+     * Convert schema description to typescript comment
+     * @param description Schema description to be converted to typescript comment
+     */
+    private convertDescriptionToTsComment;
+    /**
+     * Convert all modules needed for the converted schema types to typescript import statements
+     * @param classNameToModule Modules to be converted to typescript imports statement
+     */
+    private convertImportToTsImport;
+    /**
+     * Traverse the inheritance tree to retrieve first base classes that have properties
+     * @param ecClass Schema class to be traverse
+     */
+    private getBaseClassWithProps;
+    /**
+     * Traverse the inheritance tree to retrieve base classes of a schema class
+     * @param ecClass Schema class to be traverse
+     */
+    private getAllBaseClasses;
+    /**
+     * Traverse the inheritance tree horizontally and vertically of a schema class
+     * @param ecClass Schema class to be traverse
+     * @param visited Set of classes that are already visited
+     * @param shouldTraverseDown Lambda to determine if it should traverse more vertically
+     */
+    private traverseBaseClass;
+    /**
+     * Add required typescript class that is to be imported from a required module during Schema conversion to typescript. If there is naming conflict
+     * it will resolve it by appending prefix name with class name, for example: import { element as BisCoreElement } from "BisCoreElement";
+     * @param classNameToModule Typescript modules that is needed for the conversion. It maps typescript class with the required modules
+     * @param refModule Typescript module that the typescrip class comes from
+     * @param className Required Typescript class for the conversion
+     */
+    private addImportClass;
+    /**
+     * Add appropriate typescript props interface to the classNameToModule and return the corresponding typescript base props interface
+     * @param classNameToModule Typescript modules that is needed for the conversion. It maps typescript class with the required modules
+     * @param baseECClass Base class of ecClass that has properties. Its name will be used to derived typescript base props interface
+     * @param ecClass ECClass to be converted to Typescript
+     */
+    private addImportBasePropsClass;
+    /**
+     * Add appropriate typescript base class to the classNameToModule and return the corresponding typescript base class
+     * @param classNameToModule Typescript modules that is needed for the conversion. It maps typescript class with the required modules
+     * @param baseECClass Base class of ecClass
+     * @param ecClass ECClass to be converted to Typescript
+     */
+    private addImportBaseClass;
+    /**
+     * Lower the first character of the property name
+     * @param propName Property name
+     */
+    private lowerPropertyName;
+}
 //# sourceMappingURL=ecschema2ts.d.ts.map