@finos/legend-graph 6.0.1 → 8.0.1

package/lib/helpers/{MappingHelper.d.ts → DSLMapping_Helper.d.ts}

@@ -13,11 +13,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { EnumerationMapping } from '../models/metamodels/pure/packageableElements/mapping/EnumerationMapping';
-import type { SetImplementation } from '../models/metamodels/pure/packageableElements/mapping/SetImplementation';
-import type { Class } from '../models/metamodels/pure/packageableElements/domain/Class';
-import type { Enumeration } from '../models/metamodels/pure/packageableElements/domain/Enumeration';
-import type { Mapping } from '../models/metamodels/pure/packageableElements/mapping/Mapping';
+import type { EnumerationMapping } from '../models/metamodels/pure/packageableElements/mapping/EnumerationMapping.js';
+import type { SetImplementation } from '../models/metamodels/pure/packageableElements/mapping/SetImplementation.js';
+import type { Class } from '../models/metamodels/pure/packageableElements/domain/Class.js';
+import type { Enumeration } from '../models/metamodels/pure/packageableElements/domain/Enumeration.js';
+import type { Mapping } from '../models/metamodels/pure/packageableElements/mapping/Mapping.js';
+import type { PropertyMapping } from '../models/metamodels/pure/packageableElements/mapping/PropertyMapping.js';
+import type { InstanceSetImplementation } from '../models/metamodels/pure/packageableElements/mapping/InstanceSetImplementation.js';
+import type { EngineRuntime, IdentifiedConnection } from '../models/metamodels/pure/packageableElements/runtime/Runtime.js';
+import { OperationSetImplementation } from '../models/metamodels/pure/packageableElements/mapping/OperationSetImplementation.js';
+import { ObjectInputType } from '../models/metamodels/pure/packageableElements/store/modelToModel/mapping/ObjectInputData.js';
+/**
+ * Get all included mappings, accounted for loop and duplication (which should be caught by compiler)
+ */
+export declare const getAllIncludedMappings: (mapping: Mapping) => Mapping[];
 export declare const getAllClassMappings: (mapping: Mapping) => SetImplementation[];
 export declare const getAllEnumerationMappings: (mapping: Mapping) => EnumerationMapping[];
 export declare const extractClassMappingsFromAggregationAwareClassMappings: (mapping: Mapping) => SetImplementation[];
@@ -29,4 +38,18 @@ export declare const getEnumerationMappingsByEnumeration: (mapping: Mapping, enu
 export declare const getAllSuperSetImplementations: (currentSetImpl: SetImplementation) => SetImplementation[];
 export declare const findRootSetImplementation: (classMappingsWithSimilarTarget: SetImplementation[]) => SetImplementation | undefined;
 export declare const getRootSetImplementation: (mapping: Mapping, _class: Class) => SetImplementation | undefined;
-//# sourceMappingURL=MappingHelper.d.ts.map
+export declare const findPropertyMapping: (instanceSetImplementation: InstanceSetImplementation, propertyName: string, targetId: string | undefined) => PropertyMapping | undefined;
+/**
+ * Get all child set implementation of an operation set implementation (including itself).
+ * This takes into account loops and duplication.
+ */
+export declare const getAllChildSetImplementations: (operationSetImplementation: OperationSetImplementation) => SetImplementation[];
+/**
+ * Get all leaf set implementations (i.e. no operation) of an operation set implementation
+ * This takes into account loops and duplication.
+ */
+export declare const getLeafSetImplementations: (operationSetImplementation: OperationSetImplementation) => SetImplementation[];
+export declare const getObjectInputType: (type: string) => ObjectInputType;
+export declare const getAllIdentifiedConnections: (runtime: EngineRuntime) => IdentifiedConnection[];
+export declare const generateIdentifiedConnectionId: (runtime: EngineRuntime) => string;
+//# sourceMappingURL=DSLMapping_Helper.d.ts.map

package/lib/helpers/DSLMapping_Helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DSLMapping_Helper.d.ts","sourceRoot":"","sources":["../../src/helpers/DSLMapping_Helper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAWH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6EAA6E,CAAC;AACtH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4EAA4E,CAAC;AACpH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,+DAA+D,CAAC;AAC3F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qEAAqE,CAAC;AACvG,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kEAAkE,CAAC;AAGhG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0EAA0E,CAAC;AAChH,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oFAAoF,CAAC;AACpI,OAAO,KAAK,EACV,aAAa,EACb,oBAAoB,EACrB,MAAM,kEAAkE,CAAC;AAC1E,OAAO,EAAE,0BAA0B,EAAE,MAAM,qFAAqF,CAAC;AACjI,OAAO,EAAE,eAAe,EAAE,MAAM,6FAA6F,CAAC;AAI9H;;GAEG;AACH,eAAO,MAAM,sBAAsB,YAAa,OAAO,KAAG,OAAO,EAchE,CAAC;AAEF,eAAO,MAAM,mBAAmB,YAAa,OAAO,KAAG,iBAAiB,EAOrE,CAAC;AAEJ,eAAO,MAAM,yBAAyB,YAC3B,OAAO,KACf,kBAAkB,EAOlB,CAAC;AAEJ,eAAO,MAAM,qDAAqD,YACvD,OAAO,KACf,iBAAiB,EAgBnB,CAAC;AAEF,eAAO,MAAM,sBAAsB,YACxB,OAAO,MACZ,MAAM,KACT,iBAOA,CAAC;AAEJ,eAAO,MAAM,mBAAmB,YACrB,OAAO,MACZ,MAAM,KACT,iBAOA,CAAC;AAEJ,eAAO,MAAM,0BAA0B,YAC5B,OAAO,UACR,KAAK,KACZ,iBAAiB,EAKjB,CAAC;AAEJ,eAAO,MAAM,uBAAuB,YACzB,OAAO,UACR,KAAK,KACZ,iBAAiB,EAKjB,CAAC;AAEJ,eAAO,MAAM,mCAAmC,YACrC,OAAO,eACH,WAAW,KACvB,kBAAkB,EAIlB,CAAC;AAEJ,eAAO,MAAM,6BAA6B,mBACxB,iBAAiB,KAChC,iBAAiB,EAkBnB,CAAC;AAEF,eAAO,MAAM,yBAAyB,mCACJ,iBAAiB,EAAE,KAClD,iBAAiB,GAAG,SAetB,CAAC;AAEF,eAAO,MAAM,wBAAwB,YAC1B,OAAO,UACR,KAAK,KACZ,iBAAiB,GAAG,SAC8C,CAAC;AAEtE,eAAO,MAAM,mBAAmB,8BACH,yBAAyB,gBACtC,MAAM,YACV,MAAM,GAAG,SAAS,KAC3B,eAAe,GAAG,SAapB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,6BAA6B,+BACZ,0BAA0B,KACrD,iBAAiB,EAqBnB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,+BACR,0BAA0B,KACrD,iBAAiB,EAGjB,CAAC;AAEJ,eAAO,MAAM,kBAAkB,SAAU,MAAM,KAAG,eAWjD,CAAC;AAIF,eAAO,MAAM,2BAA2B,YAC7B,aAAa,KACrB,oBAAoB,EAGpB,CAAC;AAEJ,eAAO,MAAM,8BAA8B,YAChC,aAAa,KACrB,MAcF,CAAC"}

package/lib/helpers/DSLMapping_Helper.js

@@ -0,0 +1,155 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * 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.
+ */
+import { assertTrue, filterByType, findLast, generateEnumerableNameFromToken, guaranteeNonNullable, uniq, UnsupportedOperationError, } from '@finos/legend-shared';
+import { AggregationAwareSetImplementation } from '../models/metamodels/pure/packageableElements/mapping/aggregationAware/AggregationAwareSetImplementation.js';
+import { RootRelationalInstanceSetImplementation } from '../models/metamodels/pure/packageableElements/store/relational/mapping/RootRelationalInstanceSetImplementation.js';
+import { OperationSetImplementation } from '../models/metamodels/pure/packageableElements/mapping/OperationSetImplementation.js';
+import { ObjectInputType } from '../models/metamodels/pure/packageableElements/store/modelToModel/mapping/ObjectInputData.js';
+// ----------------------------------------- Mapping -----------------------------------------
+/**
+ * Get all included mappings, accounted for loop and duplication (which should be caught by compiler)
+ */
+export const getAllIncludedMappings = (mapping) => {
+    const visited = new Set();
+    visited.add(mapping);
+    const resolveIncludes = (_mapping) => {
+        _mapping.includes.forEach((incMapping) => {
+            if (!visited.has(incMapping.included.value)) {
+                visited.add(incMapping.included.value);
+                resolveIncludes(incMapping.included.value);
+            }
+        });
+    };
+    resolveIncludes(mapping);
+    visited.delete(mapping);
+    return Array.from(visited);
+};
+export const getAllClassMappings = (mapping) => uniq(mapping.classMappings.concat(getAllIncludedMappings(mapping)
+    .map((e) => e.classMappings)
+    .flat()));
+export const getAllEnumerationMappings = (mapping) => uniq(mapping.enumerationMappings.concat(getAllIncludedMappings(mapping)
+    .map((e) => e.enumerationMappings)
+    .flat()));
+export const extractClassMappingsFromAggregationAwareClassMappings = (mapping) => {
+    const aggregationAwareClassMappings = mapping.classMappings.filter(filterByType(AggregationAwareSetImplementation));
+    return [
+        ...aggregationAwareClassMappings.map((aggregate) => aggregate.mainSetImplementation),
+        ...aggregationAwareClassMappings
+            .map((aggregate) => aggregate.aggregateSetImplementations.map((setImpl) => setImpl.setImplementation))
+            .flat(),
+    ];
+};
+export const getOwnClassMappingById = (mapping, id) => guaranteeNonNullable([
+    ...mapping.classMappings,
+    ...extractClassMappingsFromAggregationAwareClassMappings(mapping),
+].find((classMapping) => classMapping.id.value === id), `Can't find class mapping with ID '${id}' in mapping '${mapping.path}'`);
+export const getClassMappingById = (mapping, id) => guaranteeNonNullable([
+    ...getAllClassMappings(mapping),
+    ...extractClassMappingsFromAggregationAwareClassMappings(mapping),
+].find((classMapping) => classMapping.id.value === id), `Can't find class mapping with ID '${id}' in mapping '${mapping.path}'`);
+export const getOwnClassMappingsByClass = (mapping, _class) => 
+// TODO: Add association property Mapping to class mappings, AggregationAwareSetImplementation, mappingClass
+// NOTE: Add in the proper order so find root can resolve properly down the line
+mapping.classMappings.filter((classMapping) => classMapping.class.value === _class);
+export const getClassMappingsByClass = (mapping, _class) => 
+// TODO: Add association property Mapping to class mappings, AggregationAwareSetImplementation, mappingClass
+// NOTE: Add in the proper order so find root can resolve properly down the line
+getAllClassMappings(mapping).filter((classMapping) => classMapping.class.value === _class);
+export const getEnumerationMappingsByEnumeration = (mapping, enumeration) => getAllEnumerationMappings(mapping).filter((enumerationMapping) => enumerationMapping.enumeration.value === enumeration);
+export const getAllSuperSetImplementations = (currentSetImpl) => {
+    if (currentSetImpl instanceof RootRelationalInstanceSetImplementation &&
+        currentSetImpl.superSetImplementationId) {
+        const superSetImpl = [
+            getClassMappingById(currentSetImpl._PARENT, currentSetImpl.superSetImplementationId),
+        ];
+        const superSetImplFromParents = superSetImpl
+            .map((s) => getAllSuperSetImplementations(s))
+            .flat();
+        return superSetImpl.concat(superSetImplFromParents);
+    }
+    else {
+        return [];
+    }
+};
+export const findRootSetImplementation = (classMappingsWithSimilarTarget) => {
+    // NOTE: we use find last so that we can be sure we're picking the root set implementation of the current mapping first,
+    // not the root set implementation of one of the included mappings, in case there's no root, we would prefer the root
+    // of one of the included mappings (whichever comes later),
+    // if there is not root set, and only one set implementation is found, we assume that is the root
+    if (classMappingsWithSimilarTarget.length === 1 &&
+        classMappingsWithSimilarTarget[0]?.root.value === false) {
+        return classMappingsWithSimilarTarget[0];
+    }
+    return findLast(classMappingsWithSimilarTarget, (setImp) => setImp.root.value);
+};
+export const getRootSetImplementation = (mapping, _class) => findRootSetImplementation(getClassMappingsByClass(mapping, _class));
+export const findPropertyMapping = (instanceSetImplementation, propertyName, targetId) => {
+    let properties = undefined;
+    properties = instanceSetImplementation.propertyMappings.filter((propertyMapping) => propertyMapping.property.value.name === propertyName);
+    if (targetId === undefined || properties.length === 1) {
+        return properties[0];
+    }
+    return properties.find((propertyMapping) => propertyMapping.targetSetImplementation &&
+        propertyMapping.targetSetImplementation.id.value === targetId);
+};
+/**
+ * Get all child set implementation of an operation set implementation (including itself).
+ * This takes into account loops and duplication.
+ */
+export const getAllChildSetImplementations = (operationSetImplementation) => {
+    const visitedOperations = new Set();
+    visitedOperations.add(operationSetImplementation);
+    const _leaves = new Set();
+    const resolveLeaves = (_opSetImpl) => {
+        _opSetImpl.parameters.forEach((p) => {
+            const setImp = p.setImplementation.value;
+            if (setImp instanceof OperationSetImplementation &&
+                !visitedOperations.has(setImp)) {
+                visitedOperations.add(setImp);
+                resolveLeaves(setImp);
+            }
+            else {
+                _leaves.add(setImp);
+            }
+        });
+    };
+    resolveLeaves(operationSetImplementation);
+    visitedOperations.delete(operationSetImplementation);
+    return Array.from(_leaves).concat(Array.from(visitedOperations));
+};
+/**
+ * Get all leaf set implementations (i.e. no operation) of an operation set implementation
+ * This takes into account loops and duplication.
+ */
+export const getLeafSetImplementations = (operationSetImplementation) => getAllChildSetImplementations(operationSetImplementation).filter((child) => !(child instanceof OperationSetImplementation));
+export const getObjectInputType = (type) => {
+    switch (type) {
+        case ObjectInputType.JSON:
+            return ObjectInputType.JSON;
+        case ObjectInputType.XML:
+            return ObjectInputType.XML;
+        default:
+            throw new UnsupportedOperationError(`Encountered unsupported object input type '${type}'`);
+    }
+};
+// ----------------------------------------- Runtime -----------------------------------------
+export const getAllIdentifiedConnections = (runtime) => runtime.connections.flatMap((storeConnections) => storeConnections.storeConnections);
+export const generateIdentifiedConnectionId = (runtime) => {
+    const generatedId = generateEnumerableNameFromToken(getAllIdentifiedConnections(runtime).map((identifiedConnection) => identifiedConnection.id), 'connection');
+    assertTrue(!getAllIdentifiedConnections(runtime).find((identifiedConnection) => identifiedConnection.id === generatedId), `Can't auto-generate connection ID with value '${generatedId}'`);
+    return generatedId;
+};
+//# sourceMappingURL=DSLMapping_Helper.js.map

package/lib/helpers/DSLMapping_Helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DSLMapping_Helper.js","sourceRoot":"","sources":["../../src/helpers/DSLMapping_Helper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,+BAA+B,EAC/B,oBAAoB,EACpB,IAAI,EACJ,yBAAyB,GAC1B,MAAM,sBAAsB,CAAC;AAM9B,OAAO,EAAE,iCAAiC,EAAE,MAAM,6GAA6G,CAAC;AAChK,OAAO,EAAE,uCAAuC,EAAE,MAAM,mHAAmH,CAAC;AAO5K,OAAO,EAAE,0BAA0B,EAAE,MAAM,qFAAqF,CAAC;AACjI,OAAO,EAAE,eAAe,EAAE,MAAM,6FAA6F,CAAC;AAE9H,8FAA8F;AAE9F;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,OAAgB,EAAa,EAAE;IACpE,MAAM,OAAO,GAAG,IAAI,GAAG,EAAW,CAAC;IACnC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACrB,MAAM,eAAe,GAAG,CAAC,QAAiB,EAAQ,EAAE;QAClD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAC3C,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACvC,eAAe,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC5C;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IACF,eAAe,CAAC,OAAO,CAAC,CAAC;IACzB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACxB,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAAuB,EAAE,CAC3E,IAAI,CACF,OAAO,CAAC,aAAa,CAAC,MAAM,CAC1B,sBAAsB,CAAC,OAAO,CAAC;KAC5B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC;KAC3B,IAAI,EAAE,CACV,CACF,CAAC;AAEJ,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,OAAgB,EACM,EAAE,CACxB,IAAI,CACF,OAAO,CAAC,mBAAmB,CAAC,MAAM,CAChC,sBAAsB,CAAC,OAAO,CAAC;KAC5B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC;KACjC,IAAI,EAAE,CACV,CACF,CAAC;AAEJ,MAAM,CAAC,MAAM,qDAAqD,GAAG,CACnE,OAAgB,EACK,EAAE;IACvB,MAAM,6BAA6B,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAChE,YAAY,CAAC,iCAAiC,CAAC,CAChD,CAAC;IACF,OAAO;QACL,GAAG,6BAA6B,CAAC,GAAG,CAClC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,qBAAqB,CAC/C;QACD,GAAG,6BAA6B;aAC7B,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CACjB,SAAS,CAAC,2BAA2B,CAAC,GAAG,CACvC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,iBAAiB,CACvC,CACF;aACA,IAAI,EAAE;KACV,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAAgB,EAChB,EAAU,EACS,EAAE,CACrB,oBAAoB,CAClB;IACE,GAAG,OAAO,CAAC,aAAa;IACxB,GAAG,qDAAqD,CAAC,OAAO,CAAC;CAClE,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,EACtD,qCAAqC,EAAE,iBAAiB,OAAO,CAAC,IAAI,GAAG,CACxE,CAAC;AAEJ,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,OAAgB,EAChB,EAAU,EACS,EAAE,CACrB,oBAAoB,CAClB;IACE,GAAG,mBAAmB,CAAC,OAAO,CAAC;IAC/B,GAAG,qDAAqD,CAAC,OAAO,CAAC;CAClE,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,EACtD,qCAAqC,EAAE,iBAAiB,OAAO,CAAC,IAAI,GAAG,CACxE,CAAC;AAEJ,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,OAAgB,EAChB,MAAa,EACQ,EAAE;AACvB,4GAA4G;AAC5G,gFAAgF;AAChF,OAAO,CAAC,aAAa,CAAC,MAAM,CAC1B,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,CACtD,CAAC;AAEJ,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,OAAgB,EAChB,MAAa,EACQ,EAAE;AACvB,4GAA4G;AAC5G,gFAAgF;AAChF,mBAAmB,CAAC,OAAO,CAAC,CAAC,MAAM,CACjC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,CACtD,CAAC;AAEJ,MAAM,CAAC,MAAM,mCAAmC,GAAG,CACjD,OAAgB,EAChB,WAAwB,EACF,EAAE,CACxB,yBAAyB,CAAC,OAAO,CAAC,CAAC,MAAM,CACvC,CAAC,kBAAkB,EAAE,EAAE,CACrB,kBAAkB,CAAC,WAAW,CAAC,KAAK,KAAK,WAAW,CACvD,CAAC;AAEJ,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,cAAiC,EACZ,EAAE;IACvB,IACE,cAAc,YAAY,uCAAuC;QACjE,cAAc,CAAC,wBAAwB,EACvC;QACA,MAAM,YAAY,GAAG;YACnB,mBAAmB,CACjB,cAAc,CAAC,OAAO,EACtB,cAAc,CAAC,wBAAwB,CACxC;SACF,CAAC;QACF,MAAM,uBAAuB,GAAG,YAAY;aACzC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC;aAC5C,IAAI,EAAE,CAAC;QACV,OAAO,YAAY,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;KACrD;SAAM;QACL,OAAO,EAAE,CAAC;KACX;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,8BAAmD,EACpB,EAAE;IACjC,wHAAwH;IACxH,qHAAqH;IACrH,2DAA2D;IAC3D,iGAAiG;IACjG,IACE,8BAA8B,CAAC,MAAM,KAAK,CAAC;QAC3C,8BAA8B,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,KAAK,KAAK,EACvD;QACA,OAAO,8BAA8B,CAAC,CAAC,CAAC,CAAC;KAC1C;IACD,OAAO,QAAQ,CACb,8BAA8B,EAC9B,CAAC,MAAyB,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CACjD,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,OAAgB,EAChB,MAAa,EACkB,EAAE,CACjC,yBAAyB,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAEtE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,yBAAoD,EACpD,YAAoB,EACpB,QAA4B,EACC,EAAE;IAC/B,IAAI,UAAU,GAAG,SAAS,CAAC;IAC3B,UAAU,GAAG,yBAAyB,CAAC,gBAAgB,CAAC,MAAM,CAC5D,CAAC,eAAe,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,CAC1E,CAAC;IACF,IAAI,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QACrD,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;KACtB;IACD,OAAO,UAAU,CAAC,IAAI,CACpB,CAAC,eAAe,EAAE,EAAE,CAClB,eAAe,CAAC,uBAAuB;QACvC,eAAe,CAAC,uBAAuB,CAAC,EAAE,CAAC,KAAK,KAAK,QAAQ,CAChE,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,0BAAsD,EACjC,EAAE;IACvB,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAA8B,CAAC;IAChE,iBAAiB,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,IAAI,GAAG,EAAqB,CAAC;IAC7C,MAAM,aAAa,GAAG,CAAC,UAAsC,EAAQ,EAAE;QACrE,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAClC,MAAM,MAAM,GAAG,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC;YACzC,IACE,MAAM,YAAY,0BAA0B;gBAC5C,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,EAC9B;gBACA,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC9B,aAAa,CAAC,MAAM,CAAC,CAAC;aACvB;iBAAM;gBACL,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;aACrB;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IACF,aAAa,CAAC,0BAA0B,CAAC,CAAC;IAC1C,iBAAiB,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;IACrD,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,0BAAsD,EACjC,EAAE,CACvB,6BAA6B,CAAC,0BAA0B,CAAC,CAAC,MAAM,CAC9D,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,YAAY,0BAA0B,CAAC,CAC1D,CAAC;AAEJ,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAmB,EAAE;IAClE,QAAQ,IAAI,EAAE;QACZ,KAAK,eAAe,CAAC,IAAI;YACvB,OAAO,eAAe,CAAC,IAAI,CAAC;QAC9B,KAAK,eAAe,CAAC,GAAG;YACtB,OAAO,eAAe,CAAC,GAAG,CAAC;QAC7B;YACE,MAAM,IAAI,yBAAyB,CACjC,8CAA8C,IAAI,GAAG,CACtD,CAAC;KACL;AACH,CAAC,CAAC;AAEF,8FAA8F;AAE9F,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,OAAsB,EACE,EAAE,CAC1B,OAAO,CAAC,WAAW,CAAC,OAAO,CACzB,CAAC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CACxD,CAAC;AAEJ,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC5C,OAAsB,EACd,EAAE;IACV,MAAM,WAAW,GAAG,+BAA+B,CACjD,2BAA2B,CAAC,OAAO,CAAC,CAAC,GAAG,CACtC,CAAC,oBAAoB,EAAE,EAAE,CAAC,oBAAoB,CAAC,EAAE,CAClD,EACD,YAAY,CACb,CAAC;IACF,UAAU,CACR,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,IAAI,CACxC,CAAC,oBAAoB,EAAE,EAAE,CAAC,oBAAoB,CAAC,EAAE,KAAK,WAAW,CAClE,EACD,iDAAiD,WAAW,GAAG,CAChE,CAAC;IACF,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC"}

package/lib/helpers/DomainHelper.d.ts

@@ -13,27 +13,85 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { PureModel } from '../graph/PureModel';
-import { Class } from '../models/metamodels/pure/packageableElements/domain/Class';
-import { MILESTONING_STEREOTYPE } from '../MetaModelConst';
-import { Profile } from '../models/metamodels/pure/packageableElements/domain/Profile';
-import { Tag } from '../models/metamodels/pure/packageableElements/domain/Tag';
-import { Enum } from '../models/metamodels/pure/packageableElements/domain/Enum';
-import { Stereotype } from '../models/metamodels/pure/packageableElements/domain/Stereotype';
-import { TaggedValue } from '../models/metamodels/pure/packageableElements/domain/TaggedValue';
-import type { Enumeration } from '../models/metamodels/pure/packageableElements/domain/Enumeration';
-import { Package } from '../models/metamodels/pure/packageableElements/domain/Package';
-import type { PackageableElement } from '../models/metamodels/pure/packageableElements/PackageableElement';
-import type { BasicModel } from '../graph/BasicModel';
+import type { PureModel } from '../graph/PureModel.js';
+import { Class } from '../models/metamodels/pure/packageableElements/domain/Class.js';
+import { MILESTONING_STEREOTYPE } from '../MetaModelConst.js';
+import { Package } from '../models/metamodels/pure/packageableElements/domain/Package.js';
+import type { PackageableElement } from '../models/metamodels/pure/packageableElements/PackageableElement.js';
+import { type Clazz } from '@finos/legend-shared';
+import type { BasicModel } from '../graph/BasicModel.js';
+import type { Profile } from '../models/metamodels/pure/packageableElements/domain/Profile.js';
+import type { Tag } from '../models/metamodels/pure/packageableElements/domain/Tag.js';
+import type { Stereotype } from '../models/metamodels/pure/packageableElements/domain/Stereotype.js';
+import type { Type } from '../models/metamodels/pure/packageableElements/domain/Type.js';
+import { Enumeration } from '../models/metamodels/pure/packageableElements/domain/Enumeration.js';
+import { Property } from '../models/metamodels/pure/packageableElements/domain/Property.js';
+import type { Association } from '../models/metamodels/pure/packageableElements/domain/Association.js';
+import type { AbstractProperty, PropertyOwner } from '../models/metamodels/pure/packageableElements/domain/AbstractProperty.js';
+import { DerivedProperty } from '../models/metamodels/pure/packageableElements/domain/DerivedProperty.js';
+import type { Enum } from '../models/metamodels/pure/packageableElements/domain/Enum.js';
+import type { Constraint } from '../models/metamodels/pure/packageableElements/domain/Constraint.js';
+import type { GenericType } from '../models/metamodels/pure/packageableElements/domain/GenericType.js';
+import type { Multiplicity } from '../models/metamodels/pure/packageableElements/domain/Multiplicity.js';
 export declare const addElementToPackage: (parent: Package, element: PackageableElement) => void;
 export declare const deleteElementFromPackage: (parent: Package, packageableElement: PackageableElement) => void;
 export declare const getElementRootPackage: (element: PackageableElement) => Package;
 export declare const getOrCreatePackage: (parentPackage: Package, relativePackagePath: string, createNewPackageIfNotFound: boolean, cache: Map<string, Package> | undefined) => Package;
 export declare const getOrCreateGraphPackage: (graph: BasicModel, packagePath: string | undefined, cache: Map<string, Package> | undefined) => Package;
-export declare const createStubTag: (profile: Profile) => Tag;
-export declare const createStubTaggedValue: (tag: Tag) => TaggedValue;
-export declare const createStubStereotype: (profile: Profile) => Stereotype;
-export declare const createStubProfile: () => Profile;
-export declare const createStubEnum: (enumeration: Enumeration) => Enum;
+export declare const getRawGenericType: <T extends Type>(genericType: GenericType, clazz: Clazz<T>) => T;
+/**
+ * Extract the type of temporal milestone the class is associated with (using stereotype).
+ *
+ * Whatever the type, it means the class is milestoned, which means:
+ * 1. properties of this type will now be considered milestoned, and will be automatically
+ *    converted into a derived property which accept some temporal parameters (depending
+ *    on the milestoning type)
+ * 2. when we query properties of this type, we can provide the values for these parameters
+ */
 export declare const getMilestoneTemporalStereotype: (val: Class, graph: PureModel) => MILESTONING_STEREOTYPE | undefined;
+export declare const getTag: (profile: Profile, value: string) => Tag;
+export declare const getStereotype: (profile: Profile, value: string) => Stereotype;
+export declare const getEnumValueNames: (enumeration: Enumeration) => string[];
+export declare const getEnumValue: (enumeration: Enumeration, name: string) => Enum;
+export declare const getFirstAssociatedProperty: (association: Association) => Property;
+export declare const getSecondAssociatedProperty: (association: Association) => Property;
+export declare const getOtherAssociatedProperty: (association: Association, property: Property) => Property;
+export declare const getAssociatedPropertyClass: (association: Association, property: AbstractProperty) => Class;
+export declare const getOwnProperty: (propertyOwner: PropertyOwner, name: string) => Property;
+/**
+ * Get all super types of a class, accounted for loop and duplication (which should be caught by compiler)
+ * NOTE: we intentionally leave out `Any`
+ */
+export declare const getAllSuperclasses: (c: Class) => Class[];
+/**
+ * Get all subclasses of a class, accounted for loop and duplication (which should be caught by compiler)
+ * NOTE: we intentionally leave out `Any`
+ */
+export declare const getAllSubclasses: (c: Class) => Class[];
+/**
+ * Get class and its supertypes' properties recursively, duplications and loops are handled (Which should be caught by compiler)
+ */
+export declare const getAllClassProperties: (_class: Class) => Property[];
+export declare const getAllClassDerivedProperties: (_class: Class) => DerivedProperty[];
+export declare const getClassProperty: (_class: Class, name: string) => Property;
+export declare const getAllOwnClassProperties: (_class: Class) => AbstractProperty[];
+export declare const getOwnClassProperty: (_class: Class, name: string) => AbstractProperty;
+export declare const getAllClassConstraints: (_class: Class) => Constraint[];
+/**
+ * Check if the first type subtype of the second type
+ *
+ * NOTE: Use this for contravariant and covariant check
+ * See https://www.originate.com/cheat-codes-for-contravariance-and-covariance
+ * See https://en.wikipedia.org/wiki/Covariance_and_contravariance_of_vectors
+ */
+export declare const isSubType: (type1: Type, type2: Type) => boolean;
+/**
+ * Check if the first type supertype of the second type
+ *
+ * NOTE: Use this for contravariant and covariant check
+ * See https://www.originate.com/cheat-codes-for-contravariance-and-covariance
+ * See https://en.wikipedia.org/wiki/Covariance_and_contravariance_of_vectors
+ */
+export declare const isSuperType: (type1: Type, type2: Type) => boolean;
+export declare const getMultiplicityDescription: (multiplicity: Multiplicity) => string;
 //# sourceMappingURL=DomainHelper.d.ts.map

package/lib/helpers/DomainHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DomainHelper.d.ts","sourceRoot":"","sources":["../../src/helpers/DomainHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,4DAA4D,CAAC;AACnF,OAAO,EAIL,sBAAsB,EACvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,OAAO,EAAE,MAAM,8DAA8D,CAAC;AACvF,OAAO,EAAE,GAAG,EAAE,MAAM,0DAA0D,CAAC;AAC/E,OAAO,EAAE,IAAI,EAAE,MAAM,2DAA2D,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,iEAAiE,CAAC;AAC7F,OAAO,EAAE,WAAW,EAAE,MAAM,kEAAkE,CAAC;AAE/F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kEAAkE,CAAC;AACpG,OAAO,EAAE,OAAO,EAAE,MAAM,8DAA8D,CAAC;AACvF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kEAAkE,CAAC;AAQ3G,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEtD,eAAO,MAAM,mBAAmB,WACtB,OAAO,WACN,kBAAkB,KAC1B,IAIF,CAAC;AAEF,eAAO,MAAM,wBAAwB,WAC3B,OAAO,sBACK,kBAAkB,KACrC,IAIF,CAAC;AAEF,eAAO,MAAM,qBAAqB,YAAa,kBAAkB,KAAG,OAGxB,CAAC;AA+D7C,eAAO,MAAM,kBAAkB,kBACd,OAAO,uBACD,MAAM,8BACC,OAAO,SAC5B,IAAI,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,KACtC,OAgDF,CAAC;AAEF,eAAO,MAAM,uBAAuB,UAC3B,UAAU,eACJ,MAAM,GAAG,SAAS,SACxB,IAAI,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,KACtC,OAGF,CAAC;AAEF,eAAO,MAAM,aAAa,YAAa,OAAO,KAAG,GAA2B,CAAC;AAC7E,eAAO,MAAM,qBAAqB,QAAS,GAAG,KAAG,WACM,CAAC;AACxD,eAAO,MAAM,oBAAoB,YAAa,OAAO,KAAG,UAC3B,CAAC;AAC9B,eAAO,MAAM,iBAAiB,QAAO,OAA0B,CAAC;AAChE,eAAO,MAAM,cAAc,gBAAiB,WAAW,KAAG,IAC/B,CAAC;AAE5B,eAAO,MAAM,8BAA8B,QACpC,KAAK,SACH,SAAS,KACf,sBAAsB,GAAG,SA2B3B,CAAC"}
+{"version":3,"file":"DomainHelper.d.ts","sourceRoot":"","sources":["../../src/helpers/DomainHelper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,+DAA+D,CAAC;AACtF,OAAO,EAIL,sBAAsB,EAGvB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,iEAAiE,CAAC;AAC1F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qEAAqE,CAAC;AAC9G,OAAO,EACL,KAAK,KAAK,EAQX,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iEAAiE,CAAC;AAC/F,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,6DAA6D,CAAC;AACvF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oEAAoE,CAAC;AACrG,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,8DAA8D,CAAC;AAKzF,OAAO,EAAE,WAAW,EAAE,MAAM,qEAAqE,CAAC;AAElG,OAAO,EAAE,QAAQ,EAAE,MAAM,kEAAkE,CAAC;AAC5F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qEAAqE,CAAC;AACvG,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACd,MAAM,0EAA0E,CAAC;AAClF,OAAO,EAAE,eAAe,EAAE,MAAM,yEAAyE,CAAC;AAC1G,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,8DAA8D,CAAC;AACzF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oEAAoE,CAAC;AACrG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qEAAqE,CAAC;AACvG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sEAAsE,CAAC;AAEzG,eAAO,MAAM,mBAAmB,WACtB,OAAO,WACN,kBAAkB,KAC1B,IAIF,CAAC;AAEF,eAAO,MAAM,wBAAwB,WAC3B,OAAO,sBACK,kBAAkB,KACrC,IAIF,CAAC;AAEF,eAAO,MAAM,qBAAqB,YAAa,kBAAkB,KAAG,OAGxB,CAAC;AA+D7C,eAAO,MAAM,kBAAkB,kBACd,OAAO,uBACD,MAAM,8BACC,OAAO,SAC5B,IAAI,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,KACtC,OAgDF,CAAC;AAEF,eAAO,MAAM,uBAAuB,UAC3B,UAAU,eACJ,MAAM,GAAG,SAAS,SACxB,IAAI,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,KACtC,OAGF,CAAC;AAEF,eAAO,MAAM,iBAAiB,gCACf,WAAW,uBAE0B,CAAC;AAErD;;;;;;;;GAQG;AACH,eAAO,MAAM,8BAA8B,QACpC,KAAK,SACH,SAAS,KACf,sBAAsB,GAAG,SA2B3B,CAAC;AAEF,eAAO,MAAM,MAAM,YAAa,OAAO,SAAS,MAAM,KAAG,GAItD,CAAC;AAEJ,eAAO,MAAM,aAAa,YAAa,OAAO,SAAS,MAAM,KAAG,UAI7D,CAAC;AAEJ,eAAO,MAAM,iBAAiB,gBAAiB,WAAW,KAAG,MAAM,EACJ,CAAC;AAEhE,eAAO,MAAM,YAAY,gBAAiB,WAAW,QAAQ,MAAM,KAAG,IAInE,CAAC;AAEJ,eAAO,MAAM,0BAA0B,gBACxB,WAAW,KACvB,QAA2D,CAAC;AAE/D,eAAO,MAAM,2BAA2B,gBACzB,WAAW,KACvB,QAA2D,CAAC;AAE/D,eAAO,MAAM,0BAA0B,gBACxB,WAAW,YACd,QAAQ,KACjB,QAOF,CAAC;AAEF,eAAO,MAAM,0BAA0B,gBACxB,WAAW,YACd,gBAAgB,KACzB,KAiBF,CAAC;AAEF,eAAO,MAAM,cAAc,kBACV,aAAa,QACtB,MAAM,KACX,QAIA,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,kBAAkB,MAAO,KAAK,KAAG,KAAK,EAelD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,MAAO,KAAK,KAAG,KAAK,EAchD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,WAAY,KAAK,KAAG,QAAQ,EAO3D,CAAC;AAEJ,eAAO,MAAM,4BAA4B,WAC/B,KAAK,KACZ,eAAe,EAOf,CAAC;AAEJ,eAAO,MAAM,gBAAgB,WAAY,KAAK,QAAQ,MAAM,KAAG,QAI5D,CAAC;AAEJ,eAAO,MAAM,wBAAwB,WAAY,KAAK,KAAG,gBAAgB,EAGpC,CAAC;AAEtC,eAAO,MAAM,mBAAmB,WACtB,KAAK,QACP,MAAM,KACX,gBAIA,CAAC;AAEJ,eAAO,MAAM,sBAAsB,WAAY,KAAK,KAAG,UAAU,EAKtD,CAAC;AAEZ;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,UAAW,IAAI,SAAS,IAAI,KAAG,OAgCpD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,UAAW,IAAI,SAAS,IAAI,KAAG,OAgCtD,CAAC;AAEF,eAAO,MAAM,0BAA0B,iBACvB,YAAY,KACzB,MAgBF,CAAC"}

package/lib/helpers/DomainHelper.js

@@ -13,17 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Class } from '../models/metamodels/pure/packageableElements/domain/Class';
-import { CORE_PURE_PATH, ELEMENT_PATH_DELIMITER, RESERVERD_PACKAGE_NAMES, MILESTONING_STEREOTYPE, } from '../MetaModelConst';
-import { Profile } from '../models/metamodels/pure/packageableElements/domain/Profile';
-import { Tag } from '../models/metamodels/pure/packageableElements/domain/Tag';
-import { Enum } from '../models/metamodels/pure/packageableElements/domain/Enum';
-import { Stereotype } from '../models/metamodels/pure/packageableElements/domain/Stereotype';
-import { TaggedValue } from '../models/metamodels/pure/packageableElements/domain/TaggedValue';
-import { TagExplicitReference } from '../models/metamodels/pure/packageableElements/domain/TagReference';
-import { Package } from '../models/metamodels/pure/packageableElements/domain/Package';
-import { AssertionError, assertNonEmptyString, assertTrue, guaranteeType, } from '@finos/legend-shared';
-import { createPath } from '../MetaModelUtils';
+import { Class } from '../models/metamodels/pure/packageableElements/domain/Class.js';
+import { CORE_PURE_PATH, ELEMENT_PATH_DELIMITER, RESERVERD_PACKAGE_NAMES, MILESTONING_STEREOTYPE, PRIMITIVE_TYPE, MULTIPLICITY_INFINITE, } from '../MetaModelConst.js';
+import { Package } from '../models/metamodels/pure/packageableElements/domain/Package.js';
+import { AssertionError, assertNonEmptyString, assertTrue, guaranteeNonNullable, guaranteeType, uniqBy, UnsupportedOperationError, } from '@finos/legend-shared';
+import { createPath } from '../MetaModelUtils.js';
+import { Measure, Unit, } from '../models/metamodels/pure/packageableElements/domain/Measure.js';
+import { Enumeration } from '../models/metamodels/pure/packageableElements/domain/Enumeration.js';
+import { PrimitiveType } from '../models/metamodels/pure/packageableElements/domain/PrimitiveType.js';
+import { Property } from '../models/metamodels/pure/packageableElements/domain/Property.js';
+import { DerivedProperty } from '../models/metamodels/pure/packageableElements/domain/DerivedProperty.js';
 export const addElementToPackage = (parent, element) => {
     // To improve performance we won't do duplication check here
     parent.children.push(element);
@@ -64,7 +63,7 @@ const _getOrCreatePackage = (parentPackage, relativePackagePath, createNewPackag
     }
     // populate cache after resolving the package
     if (cache) {
-        cache.set(createPath(parentPackage.fullPath, packageName), pkg);
+        cache.set(createPath(parentPackage.path, packageName), pkg);
     }
     // traverse the package chain
     if (index !== -1) {
@@ -76,7 +75,7 @@ export const getOrCreatePackage = (parentPackage, relativePackagePath, createNew
     // check cache to find the shortest chain of packages to find/build
     if (cache) {
         // short-circuit
-        const cachedPackage = cache.get(createPath(parentPackage.fullPath, relativePackagePath));
+        const cachedPackage = cache.get(createPath(parentPackage.path, relativePackagePath));
         if (cachedPackage) {
             return cachedPackage;
         }
@@ -84,7 +83,7 @@ export const getOrCreatePackage = (parentPackage, relativePackagePath, createNew
         // up its ancestor chain till we find a cache hit
         let immediateParentPackageRelativePath = relativePackagePath;
         while (immediateParentPackageRelativePath !== '') {
-            const fullPath = createPath(parentPackage.fullPath, immediateParentPackageRelativePath);
+            const fullPath = createPath(parentPackage.path, immediateParentPackageRelativePath);
             const cachedParentPackage = cache.get(fullPath);
             if (cachedParentPackage) {
                 return _getOrCreatePackage(cachedParentPackage, relativePackagePath.substring(immediateParentPackageRelativePath.length +
@@ -103,11 +102,16 @@ export const getOrCreateGraphPackage = (graph, packagePath, cache) => {
     assertNonEmptyString(packagePath, 'Package path is required');
     return getOrCreatePackage(graph.root, packagePath, true, cache);
 };
-export const createStubTag = (profile) => new Tag(profile, '');
-export const createStubTaggedValue = (tag) => new TaggedValue(TagExplicitReference.create(tag), '');
-export const createStubStereotype = (profile) => new Stereotype(profile, '');
-export const createStubProfile = () => new Profile('');
-export const createStubEnum = (enumeration) => new Enum('', enumeration);
+export const getRawGenericType = (genericType, clazz) => guaranteeType(genericType.rawType, clazz);
+/**
+ * Extract the type of temporal milestone the class is associated with (using stereotype).
+ *
+ * Whatever the type, it means the class is milestoned, which means:
+ * 1. properties of this type will now be considered milestoned, and will be automatically
+ *    converted into a derived property which accept some temporal parameters (depending
+ *    on the milestoning type)
+ * 2. when we query properties of this type, we can provide the values for these parameters
+ */
 export const getMilestoneTemporalStereotype = (val, graph) => {
     const milestonedProfile = graph.getProfile(CORE_PURE_PATH.PROFILE_TEMPORAL);
     let stereotype;
@@ -127,4 +131,175 @@ export const getMilestoneTemporalStereotype = (val, graph) => {
     });
     return stereotype;
 };
+export const getTag = (profile, value) => guaranteeNonNullable(profile.p_tags.find((tag) => tag.value === value), `Can't find tag '${value}' in profile '${profile.path}'`);
+export const getStereotype = (profile, value) => guaranteeNonNullable(profile.p_stereotypes.find((stereotype) => stereotype.value === value), `Can't find stereotype '${value}' in profile '${profile.path}'`);
+export const getEnumValueNames = (enumeration) => enumeration.values.map((value) => value.name).filter(Boolean);
+export const getEnumValue = (enumeration, name) => guaranteeNonNullable(enumeration.values.find((value) => value.name === name), `Can't find enum value '${name}' in enumeration '${enumeration.path}'`);
+export const getFirstAssociatedProperty = (association) => guaranteeNonNullable(association.properties[0]);
+export const getSecondAssociatedProperty = (association) => guaranteeNonNullable(association.properties[1]);
+export const getOtherAssociatedProperty = (association, property) => {
+    const idx = association.properties.findIndex((p) => p === property);
+    assertTrue(idx !== -1, `Can't find property '${property.name}' in association '${association.path}'`);
+    return guaranteeNonNullable(association.properties[(idx + 1) % 2]);
+};
+export const getAssociatedPropertyClass = (association, property) => {
+    if (property instanceof Property) {
+        return guaranteeType(getOtherAssociatedProperty(association, property).genericType
+            .ownerReference.value, Class, `Association property '${property.name}' must be of type 'class'`);
+    }
+    else if (property instanceof DerivedProperty) {
+        throw new UnsupportedOperationError(`Derived property is not currently supported in association`);
+    }
+    throw new UnsupportedOperationError(`Can't get associated class of property`, property);
+};
+export const getOwnProperty = (propertyOwner, name) => guaranteeNonNullable(propertyOwner.properties.find((property) => property.name === name), `Can't find property '${name}' in owner '${propertyOwner.path}'`);
+/**
+ * Get all super types of a class, accounted for loop and duplication (which should be caught by compiler)
+ * NOTE: we intentionally leave out `Any`
+ */
+export const getAllSuperclasses = (c) => {
+    const visitedClasses = new Set();
+    visitedClasses.add(c);
+    const resolveSuperTypes = (_class) => {
+        _class.generalizations.forEach((gen) => {
+            const superType = getRawGenericType(gen.value, Class);
+            if (!visitedClasses.has(superType)) {
+                visitedClasses.add(superType);
+                resolveSuperTypes(superType);
+            }
+        });
+    };
+    resolveSuperTypes(c);
+    visitedClasses.delete(c);
+    return Array.from(visitedClasses);
+};
+/**
+ * Get all subclasses of a class, accounted for loop and duplication (which should be caught by compiler)
+ * NOTE: we intentionally leave out `Any`
+ */
+export const getAllSubclasses = (c) => {
+    const visitedClasses = new Set();
+    visitedClasses.add(c);
+    const resolveSubclasses = (_class) => {
+        _class._subclasses.forEach((subclass) => {
+            if (!visitedClasses.has(subclass)) {
+                visitedClasses.add(subclass);
+                resolveSubclasses(subclass);
+            }
+        });
+    };
+    resolveSubclasses(c);
+    visitedClasses.delete(c);
+    return Array.from(visitedClasses);
+};
+/**
+ * Get class and its supertypes' properties recursively, duplications and loops are handled (Which should be caught by compiler)
+ */
+export const getAllClassProperties = (_class) => uniqBy(getAllSuperclasses(_class)
+    .concat(_class)
+    .map((c) => c.propertiesFromAssociations.concat(c.properties))
+    .flat(), (property) => property.name);
+export const getAllClassDerivedProperties = (_class) => uniqBy(getAllSuperclasses(_class)
+    .concat(_class)
+    .map((c) => c.derivedProperties)
+    .flat(), (property) => property.name);
+export const getClassProperty = (_class, name) => guaranteeNonNullable(getAllClassProperties(_class).find((property) => property.name === name), `Can't find property '${name}' in class '${_class.path}'`);
+export const getAllOwnClassProperties = (_class) => _class.properties
+    .concat(_class.propertiesFromAssociations)
+    .concat(_class.derivedProperties);
+export const getOwnClassProperty = (_class, name) => guaranteeNonNullable(getAllOwnClassProperties(_class).find((property) => property.name === name), `Can't find property '${name}' in class '${_class.path}'`);
+export const getAllClassConstraints = (_class) => 
+// Perhaps we don't need to care about deduping constraints here like for properties
+getAllSuperclasses(_class)
+    .concat(_class)
+    .map((c) => c.constraints)
+    .flat();
+/**
+ * Check if the first type subtype of the second type
+ *
+ * NOTE: Use this for contravariant and covariant check
+ * See https://www.originate.com/cheat-codes-for-contravariance-and-covariance
+ * See https://en.wikipedia.org/wiki/Covariance_and_contravariance_of_vectors
+ */
+export const isSubType = (type1, type2) => {
+    if (type1 instanceof Unit) {
+        return type1.measure === type2;
+    }
+    else if (type1 instanceof Measure) {
+        return false;
+    }
+    else if (type1 instanceof Enumeration) {
+        return false;
+    }
+    else if (type1 instanceof PrimitiveType) {
+        if (!(type2 instanceof PrimitiveType)) {
+            return false;
+        }
+        if (type2.name === PRIMITIVE_TYPE.NUMBER) {
+            return (type1.name === PRIMITIVE_TYPE.INTEGER ||
+                type1.name === PRIMITIVE_TYPE.FLOAT ||
+                type1.name === PRIMITIVE_TYPE.DECIMAL);
+        }
+        if (type2.name === PRIMITIVE_TYPE.DATE) {
+            return (type1.name === PRIMITIVE_TYPE.STRICTDATE ||
+                type1.name === PRIMITIVE_TYPE.DATETIME ||
+                type1.name === PRIMITIVE_TYPE.LATESTDATE);
+        }
+    }
+    else if (type1 instanceof Class) {
+        return (type1.path === CORE_PURE_PATH.ANY ||
+            (type2 instanceof Class && getAllSuperclasses(type2).includes(type1)));
+    }
+    return false;
+};
+/**
+ * Check if the first type supertype of the second type
+ *
+ * NOTE: Use this for contravariant and covariant check
+ * See https://www.originate.com/cheat-codes-for-contravariance-and-covariance
+ * See https://en.wikipedia.org/wiki/Covariance_and_contravariance_of_vectors
+ */
+export const isSuperType = (type1, type2) => {
+    if (type1 instanceof Unit) {
+        return false;
+    }
+    else if (type1 instanceof Measure) {
+        return type2 instanceof Unit && type2.measure === type1;
+    }
+    else if (type1 instanceof Enumeration) {
+        return false;
+    }
+    else if (type1 instanceof PrimitiveType) {
+        if (!(type2 instanceof PrimitiveType)) {
+            return false;
+        }
+        if (type1.name === PRIMITIVE_TYPE.NUMBER) {
+            return (type2.name === PRIMITIVE_TYPE.INTEGER ||
+                type2.name === PRIMITIVE_TYPE.FLOAT ||
+                type2.name === PRIMITIVE_TYPE.DECIMAL);
+        }
+        if (type1.name === PRIMITIVE_TYPE.DATE) {
+            return (type2.name === PRIMITIVE_TYPE.STRICTDATE ||
+                type2.name === PRIMITIVE_TYPE.DATETIME ||
+                type2.name === PRIMITIVE_TYPE.LATESTDATE);
+        }
+    }
+    else if (type1 instanceof Class) {
+        return (type2.path === CORE_PURE_PATH.ANY ||
+            (type2 instanceof Class && getAllSubclasses(type2).includes(type1)));
+    }
+    return false;
+};
+export const getMultiplicityDescription = (multiplicity) => {
+    if (multiplicity.lowerBound === multiplicity.upperBound) {
+        return `[${multiplicity.lowerBound.toString()}] - Must have exactly ${multiplicity.lowerBound.toString()} value(s)`;
+    }
+    else if (multiplicity.lowerBound === 0 &&
+        multiplicity.upperBound === undefined) {
+        return `[${MULTIPLICITY_INFINITE}] - May have many values`;
+    }
+    return `[${multiplicity.lowerBound}..${multiplicity.upperBound ?? MULTIPLICITY_INFINITE}] - ${multiplicity.upperBound
+        ? `Must have from ${multiplicity.lowerBound} to ${multiplicity.upperBound} value(s)`
+        : `Must have at least ${multiplicity.lowerBound} values(s)`}`;
+};
 //# sourceMappingURL=DomainHelper.js.map