@itwin/ecschema-metadata 4.8.0-dev.3 → 4.8.0-dev.32

package/lib/esm/Deserialization/AbstractParser.js

@@ -0,0 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @internal */
+export class AbstractParser {
+}
+//# sourceMappingURL=AbstractParser.js.map

package/lib/esm/Deserialization/AbstractParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractParser.js","sourceRoot":"","sources":["../../../src/Deserialization/AbstractParser.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAmB/F,gBAAgB;AAChB,MAAM,OAAgB,cAAc;CAiCnC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport {\r\n  ConstantProps, CustomAttributeClassProps, EntityClassProps, EnumerationProps, InvertedUnitProps, KindOfQuantityProps, MixinProps,\r\n  NavigationPropertyProps, PhenomenonProps, PrimitiveArrayPropertyProps, PrimitivePropertyProps, PropertyCategoryProps, RelationshipClassProps,\r\n  SchemaItemFormatProps, SchemaItemUnitProps, SchemaProps, SchemaReferenceProps, StructArrayPropertyProps, StructClassProps, StructPropertyProps, UnitSystemProps,\r\n} from \"../Deserialization/JsonProps\";\r\nimport { CustomAttribute } from \"../Metadata/CustomAttribute\";\r\nimport { CustomAttributeClass } from \"../Metadata/CustomAttributeClass\";\r\n\r\ntype SchemaItemTuple<T> = Readonly<[string /** Name */, string /** SchemaItemType */, Readonly<T>]>;\r\ntype PropertyTuple<T> = Readonly<[string /** Name */, string /** Property */, Readonly<T>]>;\r\n\r\n/** @internal */\r\nexport type CustomAttributeProvider = (caClass: CustomAttributeClass) => CustomAttribute;\r\n\r\n/** @internal */\r\nexport type CAProviderTuple = Readonly<[string /** Full Name */, CustomAttributeProvider]>;\r\n\r\n/** @internal */\r\nexport abstract class AbstractParser<TItem = any, TProperty = TItem> {\r\n  public abstract parseSchema(): SchemaProps;\r\n  public abstract getReferences(): Iterable<SchemaReferenceProps>;\r\n\r\n  public abstract getItems(): Iterable<SchemaItemTuple<TItem>>;\r\n  public abstract findItem(itemName: string): SchemaItemTuple<TItem> | undefined;\r\n\r\n  public abstract parseEntityClass(data: Readonly<TItem>): EntityClassProps;\r\n  public abstract parseMixin(data: Readonly<TItem>): MixinProps;\r\n  public abstract parseStructClass(data: Readonly<TItem>): StructClassProps;\r\n  public abstract parseCustomAttributeClass(data: Readonly<TItem>): CustomAttributeClassProps;\r\n  public abstract parseRelationshipClass(data: Readonly<TItem>): RelationshipClassProps;\r\n  public abstract parseEnumeration(data: Readonly<TItem>): EnumerationProps;\r\n  public abstract parseKindOfQuantity(data: Readonly<TItem>): KindOfQuantityProps;\r\n  public abstract parsePropertyCategory(data: Readonly<TItem>): PropertyCategoryProps;\r\n  public abstract parseUnit(data: Readonly<TItem>): SchemaItemUnitProps;\r\n  public abstract parseInvertedUnit(data: Readonly<TItem>): InvertedUnitProps;\r\n  public abstract parseConstant(data: Readonly<TItem>): ConstantProps;\r\n  public abstract parsePhenomenon(data: Readonly<TItem>): PhenomenonProps;\r\n  public abstract parseFormat(data: Readonly<TItem>): SchemaItemFormatProps;\r\n  public abstract parseUnitSystem(data: Readonly<TItem>): UnitSystemProps;\r\n\r\n  public abstract getProperties(data: Readonly<TItem>, itemName: string): Iterable<PropertyTuple<TProperty>>;\r\n  public abstract parsePrimitiveProperty(data: Readonly<TProperty>): PrimitivePropertyProps;\r\n  public abstract parseStructProperty(data: Readonly<TProperty>): StructPropertyProps;\r\n  public abstract parsePrimitiveArrayProperty(data: Readonly<TProperty>): PrimitiveArrayPropertyProps;\r\n  public abstract parseStructArrayProperty(data: Readonly<TProperty>): StructArrayPropertyProps;\r\n  public abstract parseNavigationProperty(data: Readonly<TProperty>): NavigationPropertyProps;\r\n\r\n  public abstract getSchemaCustomAttributeProviders(): Iterable<CAProviderTuple>;\r\n  public abstract getClassCustomAttributeProviders(data: Readonly<TItem>): Iterable<CAProviderTuple>;\r\n  public abstract getPropertyCustomAttributeProviders(data: Readonly<TProperty>): Iterable<CAProviderTuple>;\r\n  public abstract getRelationshipConstraintCustomAttributeProviders(data: Readonly<TItem>): [Iterable<CAProviderTuple> /* source */, Iterable<CAProviderTuple> /* target */];\r\n}\r\n\r\n/** @internal */\r\n// eslint-disable-next-line @typescript-eslint/prefer-function-type\r\nexport interface AbstractParserConstructor<TSchema, TItem = any, TProperty = TItem> { new(obj: Readonly<TSchema>): AbstractParser<TItem, TProperty> }\r\n"]}

package/lib/esm/Deserialization/Helper.d.ts

@@ -0,0 +1,263 @@
+import { SchemaContext } from "../Context";
+import { SchemaInfo } from "../Interfaces";
+import { Schema } from "../Metadata/Schema";
+import { ISchemaPartVisitor } from "../SchemaPartVisitorDelegate";
+import { AbstractParserConstructor } from "./AbstractParser";
+/**
+ * This class properly handles the order the deserialization of ECSchemas and SchemaItems from serialized formats.
+ * For example, when deserializing an ECClass most times all base class should be de-serialized before the given class.
+ * @internal
+ */
+export declare class SchemaReadHelper<T = unknown> {
+    private _context;
+    private _visitorHelper?;
+    private _parserType;
+    private _parser;
+    private _schema?;
+    private _schemaInfo?;
+    constructor(parserType: AbstractParserConstructor<T>, context?: SchemaContext, visitor?: ISchemaPartVisitor);
+    /**
+     * Creates a complete SchemaInfo and starts parsing the schema from a serialized representation.
+     * The info and schema promise will be registered with the SchemaContext.  The complete schema can be retrieved by
+     * calling getCachedSchema on the context.
+     * @param schema The Schema to populate
+     * @param rawSchema The serialized data to use to populate the Schema.
+     */
+    readSchemaInfo<U extends Schema>(schema: U, rawSchema: T): Promise<SchemaInfo>;
+    /**
+     * Populates the given Schema from a serialized representation.
+     * @param schema The Schema to populate
+     * @param rawSchema The serialized data to use to populate the Schema.
+     */
+    readSchema<U extends Schema>(schema: U, rawSchema: T): Promise<U>;
+    private loadSchema;
+    /**
+     * Populates the given Schema from a serialized representation.
+     * @param schema The Schema to populate
+     * @param rawSchema The serialized data to use to populate the Schema.
+     */
+    readSchemaSync<U extends Schema>(schema: U, rawSchema: T): U;
+    /**
+     * Ensures that the schema references can be located and adds them to the schema.
+     * @param ref The object to read the SchemaReference's props from.
+     */
+    private loadSchemaReference;
+    /**
+     * Ensures that the schema references can be located and adds them to the schema.
+     * @param ref The object to read the SchemaReference's props from.
+     */
+    private loadSchemaReferenceSync;
+    /**
+     * Validates schema references against multiple EC rules.
+     * @param schema The schema to validate.
+     */
+    private validateSchemaReferences;
+    /**
+     * Given the schema item object, the anticipated type and the name a schema item is created and loaded into the schema provided.
+     * @param schema The Schema the SchemaItem to.
+     * @param name The name of the schema item to be loaded.
+     * @param itemType The SchemaItemType of the item to load.
+     * @param schemaItemObject The Object to populate the SchemaItem with.
+     */
+    private loadSchemaItem;
+    /**
+     * Given the schema item object, the anticipated type and the name a schema item is created and loaded into the schema provided.
+     * @param schema The Schema the SchemaItem to.
+     * @param name The name of the schema item to be loaded.
+     * @param itemType The SchemaItemType of the item to load.
+     * @param schemaItemObject The Object to populate the SchemaItem with.
+     */
+    private loadSchemaItemSync;
+    /**
+     * Given the full (Schema.ItemName) or qualified (alias:ItemName) item name, returns
+     * a tuple of strings in the format ["SchemaName", "ItemName"]. The schema name may be
+     * empty if the item comes from the schema being parsed.
+     * @param fullOrQualifiedName The full or qualified name of the schema item.
+     * @param schema The schema that will be used to lookup the schema name by alias, if necessary.
+     */
+    private static resolveSchemaAndItemName;
+    /**
+     * Finds the a SchemaItem matching the name first by checking the schema that is being deserialized. If it does
+     * not exist within the schema, the SchemaContext will be searched.
+     * @param name The full (Schema.ItemName) or qualified (alias:ItemName) name of the SchemaItem to search for.
+     * @param skipVisitor Used to break Mixin -appliesTo-> Entity -extends-> Mixin cycle.
+     * @param loadCallBack Only called if the SchemaItem had to be loaded.
+     * @return The SchemaItem if it had to be loaded, otherwise undefined.
+     */
+    private findSchemaItem;
+    /**
+     * Finds the a SchemaItem matching the name first by checking the schema that is being deserialized. If it does
+     * not exist within the schema, the SchemaContext will be searched.
+     * @param name The full (Schema.ItemName) or qualified (alias:ItemName) name of the SchemaItem to search for.
+     * @param skipVisitor Used to break Mixin -appliesTo-> Entity -extends-> Mixin cycle.
+     * @param loadCallBack Only called if the SchemaItem had to be loaded.
+     * @return The SchemaItem if it had to be loaded, otherwise undefined.
+     */
+    private findSchemaItemSync;
+    /**
+     * Load dependencies on phenomenon and unitSystem for a Unit object and load the Unit from its serialized format.
+     * @param unit The Unit object that we are loading dependencies for and "deserializing into".
+     * @param rawUnit The serialized unit data
+     */
+    private loadUnit;
+    /**
+     * Load dependencies on phenomenon and unitSystem for a Unit object and load the Unit from its serialized format.
+     * @param unit The Unit object that we are loading dependencies for and "deserializing into".
+     * @param rawUnit The serialized unit data
+     */
+    private loadUnitSync;
+    /**
+     * Load the persistence unit and presentation unit dependencies for a KindOfQuantity object and load the KoQ from its serialized format.
+     * @param koq The KindOfQuantity object that we are loading dependencies for and "deserializing into".
+     * @param rawKoQ The serialized kind of quantity data
+     */
+    private loadKindOfQuantity;
+    /**
+     * Load the persistence unit and presentation unit dependencies for a KindOfQuantity object and load the KoQ from its serialized format.
+     * @param koq The KindOfQuantity object that we are loading dependencies for and "deserializing into".
+     * @param rawKoQ The serialized kind of quantity data
+     */
+    private loadKindOfQuantitySync;
+    /**
+     * Load the phenomenon dependency for a Constant object and load the Constant from its serialized format.
+     * @param constant The Constant object that we are loading the phenomenon dependency for
+     * @param rawConstant The serialized constant data
+     */
+    private loadConstant;
+    /**
+     * Load the phenomenon dependency for a Constant object and load the Constant from its serialized format.
+     * @param constant The Constant object that we are loading dependencies for and "deserializing into".
+     * @param rawConstant The serialized constant data
+     */
+    private loadConstantSync;
+    /**
+     * Load the unit system and invertsUnit dependencies for an Inverted Unit object and load the Inverted Unit from its serialized format.
+     * @param invertedUnit The InvertedUnit object that we are loading dependencies for and "deserializing into".
+     * @param rawInvertedUnit The serialized inverted unit data.
+     */
+    private loadInvertedUnit;
+    /**
+     * Load the unit system and invertsUnit dependencies for an Inverted Unit object and load the Inverted Unit from its serialized format.
+     * @param invertedUnit The InvertedUnit object that we are loading dependencies for and "deserializing into".
+     * @param rawInvertedUnit The serialized inverted unit data.
+     */
+    private loadInvertedUnitSync;
+    /**
+     * Load the unit dependencies for a Format object and load the Format from its serialized format.
+     * @param format The Format object that we are loading dependencies for and "deserializing into".
+     * @param rawFormat The serialized format data.
+     */
+    private loadFormat;
+    /**
+     * Load the unit dependencies for a Format object and load the Format from its serialized format.
+     * @param format The Format object that we are loading dependencies for and "deserializing into".
+     * @param rawFormat The serialized format data.
+     */
+    private loadFormatSync;
+    /**
+     * Load the base class and property type dependencies for an ECClass object and load the ECClass (and its properties) from its serialized format.
+     * @param classObj The ECClass object that we are loading dependencies for and "deserializing into".
+     * @param classProps The parsed class props object.
+     * @param rawClass The serialized class data.
+     */
+    private loadClass;
+    /**
+     * Load the base class and property type dependencies for an ECClass object and load the ECClass (and its properties) from its serialized format.
+     * @param classObj The ECClass object that we are loading dependencies for and "deserializing into".
+     * @param classProps The parsed class props object.
+     * @param rawClass The serialized class data.
+     */
+    private loadClassSync;
+    /**
+     * Load the mixin, base class, and property type dependencies for an EntityClass object and load the EntityClass (and properties) from its serialized format.
+     * @param entity The EntityClass that we are loading dependencies for and "deserializing into".
+     * @param rawEntity The serialized entity class data.
+     */
+    private loadEntityClass;
+    /**
+     * Load the mixin, base class, and property type dependencies for an EntityClass object and load the EntityClass (and properties) from its serialized format.
+     * @param entity The EntityClass that we are loading dependencies for and "deserializing into".
+     * @param rawEntity The serialized entity class data.
+     */
+    private loadEntityClassSync;
+    /**
+     * Load the appliesTo class, base class, and property type dependencies for a Mixin object and load the Mixin (and properties) from its serialized format.
+     * @param mixin The Mixin that we are loading dependencies for and "deserializing into".
+     * @param rawMixin The serialized mixin data.
+     */
+    private loadMixin;
+    /**
+     * Load the appliesTo class, base class, and property type dependencies for a Mixin object and load the Mixin (and properties) from its serialized format.
+     * @param mixin The Mixin that we are loading dependencies for and "deserializing into".
+     * @param rawMixin The serialized mixin data.
+     */
+    private loadMixinSync;
+    /**
+     * Load the relationship constraint, base class, and property type dependencies for a RelationshipClass object and load the RelationshipClass (and properties) from its serialized format.
+     * @param rel The RelationshipClass that we are loading dependencies for and "deserializing into".
+     * @param rawRel The serialized relationship class data.
+     */
+    private loadRelationshipClass;
+    /**
+     * Load the relationship constraint, base class, and property type dependencies for a RelationshipClass object and load the RelationshipClass (and properties) from its serialized format.
+     * @param rel The RelationshipClass that we are loading dependencies for and "deserializing into".
+     * @param rawRel The serialized relationship class data.
+     */
+    private loadRelationshipClassSync;
+    /**
+     * Load the abstract constraint and constraint class dependencies for a RelationshipConstraint object and load the RelationshipConstraint from its parsed props.
+     * @param relConstraint The RelationshipConstraint that we are loading dependencies for and "deserializing into".
+     * @param props The parsed relationship constraint props.
+     */
+    private loadRelationshipConstraint;
+    /**
+     * Load the abstract constraint and constraint class dependencies for a RelationshipConstraint object and load the RelationshipConstraint from its parsed props.
+     * @param relConstraint The RelationshipConstraint that we are loading dependencies for and "deserializing into".
+     * @param props The parsed relationship constraint props.
+     */
+    private loadRelationshipConstraintSync;
+    /**
+     * Load the type dependencies for a serialized property, then creates and deserialized the Property object in the given ECClass.
+     * @param classObj The ECClass that the Property should be created in.
+     * @param propName The name of the Property.
+     * @param propType The (serialized string) kind of property to create.
+     * @param rawProperty The serialized property data.
+     */
+    private loadPropertyTypes;
+    /**
+     * Load the type dependencies for a serialized property, then creates and deserialized the Property object in the given ECClass.
+     * @param classObj The ECClass that the Property should be created in.
+     * @param propName The name of the Property.
+     * @param propType The (serialized string) kind of property to create.
+     * @param rawProperty The serialized property data.
+     */
+    private loadPropertyTypesSync;
+    /**
+     * Load the propertyCategory, kindOfQuantity, and customAttribute dependencies for a Property object and load the Property from its parsed props.
+     * @param propertyObj The Property that we are loading dependencies for and "deserializing into".
+     * @param props The parsed property props.
+     * @param rawProperty The serialized property data.
+     */
+    private loadProperty;
+    /**
+     * Load the propertyCategory, kindOfQuantity, and customAttribute dependencies for a Property object and load the Property from its parsed props.
+     * @param propertyObj The Property that we are loading dependencies for and "deserializing into".
+     * @param props The parsed property props.
+     * @param rawProperty The serialized property data.
+     */
+    private loadPropertySync;
+    /**
+     * Load the customAttribute class dependencies for a set of CustomAttribute objects and add
+     * them to a given custom attribute container.
+     * @param container The CustomAttributeContainer that each CustomAttribute will be added to.
+     * @param customAttributes An iterable set of parsed CustomAttribute objects.
+     */
+    private loadCustomAttributes;
+    /**
+     * Load the customAttribute class dependencies for a set of CustomAttribute objects and add them to a given custom attribute container.
+     * @param container The CustomAttributeContainer that each CustomAttribute will be added to.
+     * @param customAttributes An iterable set of parsed CustomAttribute objects.
+     */
+    private loadCustomAttributesSync;
+}
+//# sourceMappingURL=Helper.d.ts.map

package/lib/esm/Deserialization/Helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Helper.d.ts","sourceRoot":"","sources":["../../../src/Deserialization/Helper.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,EAA2B,UAAU,EAAE,MAAM,eAAe,CAAC;AAWpE,OAAO,EAAiB,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAI3D,OAAO,EAAE,kBAAkB,EAA6B,MAAM,8BAA8B,CAAC;AAE7F,OAAO,EAAkB,yBAAyB,EAAmB,MAAM,kBAAkB,CAAC;AAO9F;;;;GAIG;AACH,qBAAa,gBAAgB,CAAC,CAAC,GAAG,OAAO;IACvC,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,cAAc,CAAC,CAA4B;IACnD,OAAO,CAAC,WAAW,CAAwC;IAC3D,OAAO,CAAC,OAAO,CAA2B;IAI1C,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,WAAW,CAAC,CAAa;gBAErB,UAAU,EAAE,yBAAyB,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,kBAAkB;IAM3G;;;;;;OAMG;IACU,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;IA+B3F;;;;OAIG;IACU,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;YAahE,UAAU;IAgCxB;;;;OAIG;IACI,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,CAAC;IA0CnE;;;OAGG;YACW,mBAAmB;IAkBjC;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAqB/B;;;OAGG;IACH,OAAO,CAAE,wBAAwB;IAkBjC;;;;;;OAMG;YACW,cAAc;IAuE5B;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAsE1B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAcvC;;;;;;;OAOG;YACW,cAAc;IAmC5B;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IA+B1B;;;;OAIG;YACW,QAAQ;IAStB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IASpB;;;;OAIG;YACW,kBAAkB;IAehC;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAc9B;;;;OAIG;YACW,YAAY;IAO1B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;;;OAIG;YACW,gBAAgB;IAS9B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAS5B;;;;OAIG;YACW,UAAU;IAYxB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAatB;;;;;OAKG;YACW,SAAS;IAsBvB;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IAsBrB;;;;OAIG;YACW,eAAe;IAY7B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAY3B;;;;OAIG;YACW,SAAS;IAavB;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAarB;;;;OAIG;YACW,qBAAqB;IAWnC;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;IAWjC;;;;OAIG;YACW,0BAA0B;IAYxC;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAatC;;;;;;OAMG;YACW,iBAAiB;IA6C/B;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IA4C7B;;;;;OAKG;YACW,YAAY;IAa1B;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAaxB;;;;;OAKG;YACW,oBAAoB;IAmBlC;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;CAWjC"}