@itwin/ecschema-metadata 5.5.0-dev.13 → 5.5.0-dev.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -101,7 +101,7 @@ export type StructClassProps = ClassProps;
|
|
|
101
101
|
*/
|
|
102
102
|
export interface CustomAttributeClassProps extends ClassProps {
|
|
103
103
|
/**
|
|
104
|
-
* Can be any combination of the [CustomAttributeContainerType]$
|
|
104
|
+
* Can be any combination of the [CustomAttributeContainerType]($docs/bis/ec/customattribute-container-types.md) string values
|
|
105
105
|
* separated by commas.
|
|
106
106
|
*/
|
|
107
107
|
readonly appliesTo: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"JsonProps.js","sourceRoot":"","sources":["../../../src/Deserialization/JsonProps.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","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/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { FormatDefinition, FormatProps, UnitSystemKey } from \"@itwin/core-quantity\";\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnyPropertyProps =\r\n | PrimitivePropertyProps\r\n | StructPropertyProps\r\n | PrimitiveArrayPropertyProps\r\n | StructArrayPropertyProps\r\n | NavigationPropertyProps;\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnyClassProps =\r\n | EntityClassProps\r\n | MixinProps\r\n | CustomAttributeClassProps\r\n | RelationshipClassProps;\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnySchemaItemProps =\r\n | AnyClassProps\r\n | EnumerationProps\r\n | KindOfQuantityProps\r\n | PropertyCategoryProps\r\n | SchemaItemUnitProps\r\n | InvertedUnitProps\r\n | ConstantProps\r\n | PhenomenonProps\r\n | SchemaItemFormatProps\r\n | SchemaItemOverrideFormatProps;\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaProps {\r\n readonly $schema: string;\r\n readonly name: string;\r\n readonly version: string;\r\n readonly alias: string;\r\n readonly label?: string;\r\n readonly description?: string;\r\n readonly references?: SchemaReferenceProps[];\r\n readonly items?: { [name: string]: SchemaItemProps };\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n readonly ecSpecMajorVersion?: number;\r\n readonly ecSpecMinorVersion?: number;\r\n}\r\n\r\n/**\r\n * JSON Object interface used to deserialize into a [[SchemaKey]].\r\n * @public @preview\r\n */\r\nexport interface SchemaKeyProps {\r\n /** The schema name */\r\n readonly name: string;\r\n /** Read version of the schema */\r\n readonly read: number;\r\n /** Write version of the schema */\r\n readonly write: number;\r\n /** Minor version of the schema */\r\n readonly minor: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaReferenceProps {\r\n readonly name: string;\r\n readonly version: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaItemProps {\r\n // NEEDSWORK: Still need to clarify how single-item deserialization works...\r\n readonly $schema?: string;\r\n readonly schema?: string; // conditionally required\r\n readonly schemaVersion?: string;\r\n readonly name?: string;\r\n readonly schemaItemType?: string;\r\n readonly label?: string;\r\n readonly description?: string;\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n readonly originalECSpecMajorVersion?: number;\r\n readonly originalECSpecMinorVersion?: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface ClassProps extends SchemaItemProps {\r\n readonly modifier?: string;\r\n readonly baseClass?: string;\r\n readonly properties?: AnyPropertyProps[];\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface EntityClassProps extends ClassProps {\r\n readonly mixins?: string[];\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface MixinProps extends ClassProps {\r\n readonly appliesTo: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type StructClassProps = ClassProps;\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface CustomAttributeClassProps extends ClassProps {\r\n /**\r\n * Can be any combination of the [CustomAttributeContainerType]$
|
|
1
|
+
{"version":3,"file":"JsonProps.js","sourceRoot":"","sources":["../../../src/Deserialization/JsonProps.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG","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/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { FormatDefinition, FormatProps, UnitSystemKey } from \"@itwin/core-quantity\";\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnyPropertyProps =\r\n | PrimitivePropertyProps\r\n | StructPropertyProps\r\n | PrimitiveArrayPropertyProps\r\n | StructArrayPropertyProps\r\n | NavigationPropertyProps;\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnyClassProps =\r\n | EntityClassProps\r\n | MixinProps\r\n | CustomAttributeClassProps\r\n | RelationshipClassProps;\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnySchemaItemProps =\r\n | AnyClassProps\r\n | EnumerationProps\r\n | KindOfQuantityProps\r\n | PropertyCategoryProps\r\n | SchemaItemUnitProps\r\n | InvertedUnitProps\r\n | ConstantProps\r\n | PhenomenonProps\r\n | SchemaItemFormatProps\r\n | SchemaItemOverrideFormatProps;\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaProps {\r\n readonly $schema: string;\r\n readonly name: string;\r\n readonly version: string;\r\n readonly alias: string;\r\n readonly label?: string;\r\n readonly description?: string;\r\n readonly references?: SchemaReferenceProps[];\r\n readonly items?: { [name: string]: SchemaItemProps };\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n readonly ecSpecMajorVersion?: number;\r\n readonly ecSpecMinorVersion?: number;\r\n}\r\n\r\n/**\r\n * JSON Object interface used to deserialize into a [[SchemaKey]].\r\n * @public @preview\r\n */\r\nexport interface SchemaKeyProps {\r\n /** The schema name */\r\n readonly name: string;\r\n /** Read version of the schema */\r\n readonly read: number;\r\n /** Write version of the schema */\r\n readonly write: number;\r\n /** Minor version of the schema */\r\n readonly minor: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaReferenceProps {\r\n readonly name: string;\r\n readonly version: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaItemProps {\r\n // NEEDSWORK: Still need to clarify how single-item deserialization works...\r\n readonly $schema?: string;\r\n readonly schema?: string; // conditionally required\r\n readonly schemaVersion?: string;\r\n readonly name?: string;\r\n readonly schemaItemType?: string;\r\n readonly label?: string;\r\n readonly description?: string;\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n readonly originalECSpecMajorVersion?: number;\r\n readonly originalECSpecMinorVersion?: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface ClassProps extends SchemaItemProps {\r\n readonly modifier?: string;\r\n readonly baseClass?: string;\r\n readonly properties?: AnyPropertyProps[];\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface EntityClassProps extends ClassProps {\r\n readonly mixins?: string[];\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface MixinProps extends ClassProps {\r\n readonly appliesTo: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type StructClassProps = ClassProps;\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface CustomAttributeClassProps extends ClassProps {\r\n /**\r\n * Can be any combination of the [CustomAttributeContainerType]($docs/bis/ec/customattribute-container-types.md) string values\r\n * separated by commas.\r\n */\r\n readonly appliesTo: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface RelationshipClassProps extends ClassProps {\r\n readonly strength: string;\r\n readonly strengthDirection: string;\r\n readonly source: RelationshipConstraintProps;\r\n readonly target: RelationshipConstraintProps;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface RelationshipConstraintProps {\r\n readonly multiplicity: string;\r\n readonly roleLabel: string;\r\n readonly polymorphic: boolean;\r\n readonly abstractConstraint?: string;\r\n readonly constraintClasses: string[];\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface EnumerationProps extends SchemaItemProps {\r\n readonly type: string;\r\n readonly isStrict: boolean;\r\n readonly enumerators: EnumeratorProps[];\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface EnumeratorProps {\r\n readonly name: string;\r\n readonly value: string | number;\r\n readonly label?: string;\r\n readonly description?: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface KindOfQuantityProps extends SchemaItemProps {\r\n readonly persistenceUnit: string;\r\n readonly presentationUnits?: string | string[];\r\n readonly relativeError: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PropertyCategoryProps extends SchemaItemProps {\r\n readonly priority: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PropertyProps {\r\n readonly name: string;\r\n readonly type: string;\r\n readonly description?: string;\r\n readonly label?: string;\r\n readonly isReadOnly?: boolean;\r\n readonly category?: string;\r\n readonly priority?: number;\r\n readonly inherited?: boolean;\r\n readonly kindOfQuantity?: string;\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PrimitiveOrEnumPropertyBaseProps extends PropertyProps {\r\n readonly extendedTypeName?: string;\r\n readonly minLength?: number;\r\n readonly maxLength?: number;\r\n readonly minValue?: number;\r\n readonly maxValue?: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PrimitivePropertyProps\r\n extends PrimitiveOrEnumPropertyBaseProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface StructPropertyProps extends PropertyProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface EnumerationPropertyProps\r\n extends PrimitiveOrEnumPropertyBaseProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface ArrayPropertyProps extends PrimitiveOrEnumPropertyBaseProps {\r\n readonly minOccurs?: number;\r\n readonly maxOccurs?: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PrimitiveArrayPropertyProps extends ArrayPropertyProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface StructArrayPropertyProps extends ArrayPropertyProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface NavigationPropertyProps extends PropertyProps {\r\n readonly relationshipName: string;\r\n readonly direction: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface ConstantProps extends SchemaItemProps {\r\n readonly phenomenon: string;\r\n readonly definition: string;\r\n readonly numerator?: number;\r\n readonly denominator?: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type SchemaItemFormatProps = SchemaItemProps & FormatProps;\r\n\r\n/**\r\n * This interface defines properties necessary to support persistence of a set of formats.\r\n * @beta\r\n */\r\nexport interface FormatSet {\r\n /** The unique name identifier for this format set. */\r\n name: string;\r\n /** The display label for this format set. */\r\n label: string;\r\n /** The description for this format set. */\r\n description?: string;\r\n /** A [UnitSystemKey]($quantity) that determines the unit system for this format set. */\r\n unitSystem: UnitSystemKey;\r\n /** \r\n * A mapping of kind of quantity identifiers to their corresponding format properties.\r\n * When a format is a [FormatDefinition]($quantity), it defines the complete format specification.\r\n * When a format is a string, it references another kindOfQuantityId to map one format to another.\r\n */\r\n formats: { [kindOfQuantityId: string]: FormatDefinition | string };\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaItemOverrideFormatProps extends SchemaItemFormatProps {\r\n readonly parent: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface InvertedUnitProps extends SchemaItemProps {\r\n readonly invertsUnit: string;\r\n readonly unitSystem: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PhenomenonProps extends SchemaItemProps {\r\n readonly definition: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type UnitSystemProps = SchemaItemProps;\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaItemUnitProps extends SchemaItemProps {\r\n readonly phenomenon: string;\r\n readonly unitSystem: string;\r\n readonly definition: string;\r\n readonly numerator?: number;\r\n readonly denominator?: number;\r\n readonly offset?: number;\r\n}\r\n"]}
|
|
@@ -101,7 +101,7 @@ export type StructClassProps = ClassProps;
|
|
|
101
101
|
*/
|
|
102
102
|
export interface CustomAttributeClassProps extends ClassProps {
|
|
103
103
|
/**
|
|
104
|
-
* Can be any combination of the [CustomAttributeContainerType]$
|
|
104
|
+
* Can be any combination of the [CustomAttributeContainerType]($docs/bis/ec/customattribute-container-types.md) string values
|
|
105
105
|
* separated by commas.
|
|
106
106
|
*/
|
|
107
107
|
readonly appliesTo: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"JsonProps.js","sourceRoot":"","sources":["../../../src/Deserialization/JsonProps.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG","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/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { FormatDefinition, FormatProps, UnitSystemKey } from \"@itwin/core-quantity\";\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnyPropertyProps =\r\n | PrimitivePropertyProps\r\n | StructPropertyProps\r\n | PrimitiveArrayPropertyProps\r\n | StructArrayPropertyProps\r\n | NavigationPropertyProps;\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnyClassProps =\r\n | EntityClassProps\r\n | MixinProps\r\n | CustomAttributeClassProps\r\n | RelationshipClassProps;\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnySchemaItemProps =\r\n | AnyClassProps\r\n | EnumerationProps\r\n | KindOfQuantityProps\r\n | PropertyCategoryProps\r\n | SchemaItemUnitProps\r\n | InvertedUnitProps\r\n | ConstantProps\r\n | PhenomenonProps\r\n | SchemaItemFormatProps\r\n | SchemaItemOverrideFormatProps;\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaProps {\r\n readonly $schema: string;\r\n readonly name: string;\r\n readonly version: string;\r\n readonly alias: string;\r\n readonly label?: string;\r\n readonly description?: string;\r\n readonly references?: SchemaReferenceProps[];\r\n readonly items?: { [name: string]: SchemaItemProps };\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n readonly ecSpecMajorVersion?: number;\r\n readonly ecSpecMinorVersion?: number;\r\n}\r\n\r\n/**\r\n * JSON Object interface used to deserialize into a [[SchemaKey]].\r\n * @public @preview\r\n */\r\nexport interface SchemaKeyProps {\r\n /** The schema name */\r\n readonly name: string;\r\n /** Read version of the schema */\r\n readonly read: number;\r\n /** Write version of the schema */\r\n readonly write: number;\r\n /** Minor version of the schema */\r\n readonly minor: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaReferenceProps {\r\n readonly name: string;\r\n readonly version: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaItemProps {\r\n // NEEDSWORK: Still need to clarify how single-item deserialization works...\r\n readonly $schema?: string;\r\n readonly schema?: string; // conditionally required\r\n readonly schemaVersion?: string;\r\n readonly name?: string;\r\n readonly schemaItemType?: string;\r\n readonly label?: string;\r\n readonly description?: string;\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n readonly originalECSpecMajorVersion?: number;\r\n readonly originalECSpecMinorVersion?: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface ClassProps extends SchemaItemProps {\r\n readonly modifier?: string;\r\n readonly baseClass?: string;\r\n readonly properties?: AnyPropertyProps[];\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface EntityClassProps extends ClassProps {\r\n readonly mixins?: string[];\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface MixinProps extends ClassProps {\r\n readonly appliesTo: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type StructClassProps = ClassProps;\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface CustomAttributeClassProps extends ClassProps {\r\n /**\r\n * Can be any combination of the [CustomAttributeContainerType]$
|
|
1
|
+
{"version":3,"file":"JsonProps.js","sourceRoot":"","sources":["../../../src/Deserialization/JsonProps.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG","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/** @packageDocumentation\r\n * @module Metadata\r\n */\r\n\r\nimport { FormatDefinition, FormatProps, UnitSystemKey } from \"@itwin/core-quantity\";\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnyPropertyProps =\r\n | PrimitivePropertyProps\r\n | StructPropertyProps\r\n | PrimitiveArrayPropertyProps\r\n | StructArrayPropertyProps\r\n | NavigationPropertyProps;\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnyClassProps =\r\n | EntityClassProps\r\n | MixinProps\r\n | CustomAttributeClassProps\r\n | RelationshipClassProps;\r\n/**\r\n * @public @preview\r\n */\r\nexport type AnySchemaItemProps =\r\n | AnyClassProps\r\n | EnumerationProps\r\n | KindOfQuantityProps\r\n | PropertyCategoryProps\r\n | SchemaItemUnitProps\r\n | InvertedUnitProps\r\n | ConstantProps\r\n | PhenomenonProps\r\n | SchemaItemFormatProps\r\n | SchemaItemOverrideFormatProps;\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaProps {\r\n readonly $schema: string;\r\n readonly name: string;\r\n readonly version: string;\r\n readonly alias: string;\r\n readonly label?: string;\r\n readonly description?: string;\r\n readonly references?: SchemaReferenceProps[];\r\n readonly items?: { [name: string]: SchemaItemProps };\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n readonly ecSpecMajorVersion?: number;\r\n readonly ecSpecMinorVersion?: number;\r\n}\r\n\r\n/**\r\n * JSON Object interface used to deserialize into a [[SchemaKey]].\r\n * @public @preview\r\n */\r\nexport interface SchemaKeyProps {\r\n /** The schema name */\r\n readonly name: string;\r\n /** Read version of the schema */\r\n readonly read: number;\r\n /** Write version of the schema */\r\n readonly write: number;\r\n /** Minor version of the schema */\r\n readonly minor: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaReferenceProps {\r\n readonly name: string;\r\n readonly version: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaItemProps {\r\n // NEEDSWORK: Still need to clarify how single-item deserialization works...\r\n readonly $schema?: string;\r\n readonly schema?: string; // conditionally required\r\n readonly schemaVersion?: string;\r\n readonly name?: string;\r\n readonly schemaItemType?: string;\r\n readonly label?: string;\r\n readonly description?: string;\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n readonly originalECSpecMajorVersion?: number;\r\n readonly originalECSpecMinorVersion?: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface ClassProps extends SchemaItemProps {\r\n readonly modifier?: string;\r\n readonly baseClass?: string;\r\n readonly properties?: AnyPropertyProps[];\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface EntityClassProps extends ClassProps {\r\n readonly mixins?: string[];\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface MixinProps extends ClassProps {\r\n readonly appliesTo: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type StructClassProps = ClassProps;\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface CustomAttributeClassProps extends ClassProps {\r\n /**\r\n * Can be any combination of the [CustomAttributeContainerType]($docs/bis/ec/customattribute-container-types.md) string values\r\n * separated by commas.\r\n */\r\n readonly appliesTo: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface RelationshipClassProps extends ClassProps {\r\n readonly strength: string;\r\n readonly strengthDirection: string;\r\n readonly source: RelationshipConstraintProps;\r\n readonly target: RelationshipConstraintProps;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface RelationshipConstraintProps {\r\n readonly multiplicity: string;\r\n readonly roleLabel: string;\r\n readonly polymorphic: boolean;\r\n readonly abstractConstraint?: string;\r\n readonly constraintClasses: string[];\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface EnumerationProps extends SchemaItemProps {\r\n readonly type: string;\r\n readonly isStrict: boolean;\r\n readonly enumerators: EnumeratorProps[];\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface EnumeratorProps {\r\n readonly name: string;\r\n readonly value: string | number;\r\n readonly label?: string;\r\n readonly description?: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface KindOfQuantityProps extends SchemaItemProps {\r\n readonly persistenceUnit: string;\r\n readonly presentationUnits?: string | string[];\r\n readonly relativeError: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PropertyCategoryProps extends SchemaItemProps {\r\n readonly priority: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PropertyProps {\r\n readonly name: string;\r\n readonly type: string;\r\n readonly description?: string;\r\n readonly label?: string;\r\n readonly isReadOnly?: boolean;\r\n readonly category?: string;\r\n readonly priority?: number;\r\n readonly inherited?: boolean;\r\n readonly kindOfQuantity?: string;\r\n readonly customAttributes?: Array<{ [value: string]: any }>;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PrimitiveOrEnumPropertyBaseProps extends PropertyProps {\r\n readonly extendedTypeName?: string;\r\n readonly minLength?: number;\r\n readonly maxLength?: number;\r\n readonly minValue?: number;\r\n readonly maxValue?: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PrimitivePropertyProps\r\n extends PrimitiveOrEnumPropertyBaseProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface StructPropertyProps extends PropertyProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface EnumerationPropertyProps\r\n extends PrimitiveOrEnumPropertyBaseProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface ArrayPropertyProps extends PrimitiveOrEnumPropertyBaseProps {\r\n readonly minOccurs?: number;\r\n readonly maxOccurs?: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PrimitiveArrayPropertyProps extends ArrayPropertyProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface StructArrayPropertyProps extends ArrayPropertyProps {\r\n readonly typeName: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface NavigationPropertyProps extends PropertyProps {\r\n readonly relationshipName: string;\r\n readonly direction: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface ConstantProps extends SchemaItemProps {\r\n readonly phenomenon: string;\r\n readonly definition: string;\r\n readonly numerator?: number;\r\n readonly denominator?: number;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type SchemaItemFormatProps = SchemaItemProps & FormatProps;\r\n\r\n/**\r\n * This interface defines properties necessary to support persistence of a set of formats.\r\n * @beta\r\n */\r\nexport interface FormatSet {\r\n /** The unique name identifier for this format set. */\r\n name: string;\r\n /** The display label for this format set. */\r\n label: string;\r\n /** The description for this format set. */\r\n description?: string;\r\n /** A [UnitSystemKey]($quantity) that determines the unit system for this format set. */\r\n unitSystem: UnitSystemKey;\r\n /** \r\n * A mapping of kind of quantity identifiers to their corresponding format properties.\r\n * When a format is a [FormatDefinition]($quantity), it defines the complete format specification.\r\n * When a format is a string, it references another kindOfQuantityId to map one format to another.\r\n */\r\n formats: { [kindOfQuantityId: string]: FormatDefinition | string };\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaItemOverrideFormatProps extends SchemaItemFormatProps {\r\n readonly parent: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface InvertedUnitProps extends SchemaItemProps {\r\n readonly invertsUnit: string;\r\n readonly unitSystem: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface PhenomenonProps extends SchemaItemProps {\r\n readonly definition: string;\r\n}\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport type UnitSystemProps = SchemaItemProps;\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport interface SchemaItemUnitProps extends SchemaItemProps {\r\n readonly phenomenon: string;\r\n readonly unitSystem: string;\r\n readonly definition: string;\r\n readonly numerator?: number;\r\n readonly denominator?: number;\r\n readonly offset?: number;\r\n}\r\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itwin/ecschema-metadata",
|
|
3
|
-
"version": "5.5.0-dev.
|
|
3
|
+
"version": "5.5.0-dev.14",
|
|
4
4
|
"description": "ECObjects core concepts in typescript",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "lib/cjs/ecschema-metadata.js",
|
|
@@ -48,13 +48,13 @@
|
|
|
48
48
|
"rimraf": "^6.0.1",
|
|
49
49
|
"sinon": "^17.0.2",
|
|
50
50
|
"typescript": "~5.6.2",
|
|
51
|
-
"@itwin/build-tools": "5.5.0-dev.
|
|
52
|
-
"@itwin/core-
|
|
53
|
-
"@itwin/core-
|
|
51
|
+
"@itwin/build-tools": "5.5.0-dev.14",
|
|
52
|
+
"@itwin/core-bentley": "5.5.0-dev.14",
|
|
53
|
+
"@itwin/core-quantity": "5.5.0-dev.14"
|
|
54
54
|
},
|
|
55
55
|
"peerDependencies": {
|
|
56
|
-
"@itwin/core-bentley": "5.5.0-dev.
|
|
57
|
-
"@itwin/core-quantity": "5.5.0-dev.
|
|
56
|
+
"@itwin/core-bentley": "5.5.0-dev.14",
|
|
57
|
+
"@itwin/core-quantity": "5.5.0-dev.14"
|
|
58
58
|
},
|
|
59
59
|
"nyc": {
|
|
60
60
|
"extends": "./node_modules/@itwin/build-tools/.nycrc"
|