@finos/legend-graph 4.0.3 → 6.0.1

package/src/models/metamodels/pure/test/result/AtomicTestId.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { type Hashable, hashArray } from '@finos/legend-shared';
+import { CORE_HASH_STRUCTURE } from '../../../../../MetaModelConst';
+
+export class AtomicTestId implements Hashable {
+  testSuiteId!: string;
+  atomicTestId!: string;
+
+  get hashCode(): string {
+    return hashArray([
+      CORE_HASH_STRUCTURE.ATOMIC_TEST_ID,
+      this.testSuiteId,
+      this.atomicTestId,
+    ]);
+  }
+}

package/src/models/metamodels/pure/test/result/TestError.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { hashArray, type Hashable } from '@finos/legend-shared';
+import { CORE_HASH_STRUCTURE } from '../../../../../MetaModelConst';
+import { TestResult } from './TestResult';
+
+export class TestError extends TestResult implements Hashable {
+  error!: string;
+
+  override get hashCode(): string {
+    return hashArray([
+      CORE_HASH_STRUCTURE.TEST_ERROR,
+      this.testable,
+      this.atomicTestId,
+      this.error,
+    ]);
+  }
+}

package/src/models/metamodels/pure/test/result/TestFailed.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 { hashArray, type Hashable } from '@finos/legend-shared';
+import { CORE_HASH_STRUCTURE } from '../../../../../MetaModelConst';
+import type { AssertionStatus } from '../assertion/status/AssertionStatus';
+import { TestResult } from './TestResult';
+
+export class TestFailed extends TestResult implements Hashable {
+  assertStatuses: AssertionStatus[] = [];
+
+  override get hashCode(): string {
+    return hashArray([
+      CORE_HASH_STRUCTURE.TEST_FAILED,
+      this.testable,
+      this.atomicTestId,
+      hashArray(this.assertStatuses),
+    ]);
+  }
+}

package/src/models/metamodels/pure/test/result/TestPassed.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 { hashArray, type Hashable } from '@finos/legend-shared';
+import { CORE_HASH_STRUCTURE } from '../../../../../MetaModelConst';
+import { TestResult } from './TestResult';
+
+export class TestPassed extends TestResult implements Hashable {
+  override get hashCode(): string {
+    return hashArray([
+      CORE_HASH_STRUCTURE.TEST_PASSED,
+      this.testable,
+      this.atomicTestId,
+    ]);
+  }
+}

package/src/models/metamodels/pure/test/result/TestResult.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { hashArray, type Hashable } from '@finos/legend-shared';
+import { CORE_HASH_STRUCTURE } from '../../../../../MetaModelConst';
+import type { AtomicTestId } from './AtomicTestId';
+
+export class TestResult implements Hashable {
+  testable!: string; // should be `testable`
+  atomicTestId!: AtomicTestId;
+
+  get hashCode(): string {
+    return hashArray([
+      CORE_HASH_STRUCTURE.TEST_RESULT,
+      this.testable,
+      this.atomicTestId,
+    ]);
+  }
+}

package/src/models/metamodels/pure/valueSpecification/INTERNAL__PropagatedValue.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 {
+  ValueSpecification,
+  type ValueSpecificationVisitor,
+} from './ValueSpecification';
+
+/**
+ * This value specification maintains a reference to another value specification
+ *
+ * @internal This type is specific to Studio only, not a standard, recognizeable in Pure/engine.
+ */
+export class INTERNAL__PropagatedValue extends ValueSpecification {
+  getValue!: () => ValueSpecification;
+
+  accept_ValueSpecificationVisitor<T>(
+    visitor: ValueSpecificationVisitor<T>,
+  ): T {
+    return visitor.visit_INTERNAL__PropagatedValue(this);
+  }
+}

package/src/models/metamodels/pure/valueSpecification/INTERNAL__UnknownValueSpecification.ts

@@ -20,6 +20,12 @@ import {
   ValueSpecification,
 } from './ValueSpecification';
 
+/**
+ * This value specification is used to hold a value specification type that we can't yet handle
+ * It wraps the protocol JSON of the unknown value specification.
+ *
+ * @internal This type is specific to Studio only, not a standard, recognizeable in Pure/engine.
+ */
 export class INTERNAL__UnknownValueSpecification extends ValueSpecification {
   content: object;
 

package/src/models/metamodels/pure/valueSpecification/ValueSpecification.ts

@@ -39,11 +39,15 @@ import type {
 } from './SimpleFunctionExpression';
 import type { INTERNAL__UnknownValueSpecification } from './INTERNAL__UnknownValueSpecification';
 import type { VariableExpression } from './VariableExpression';
+import type { INTERNAL__PropagatedValue } from './INTERNAL__PropagatedValue';
 
 export interface ValueSpecificationVisitor<T> {
   visit_RootGraphFetchTreeInstanceValue(
     valueSpecification: RootGraphFetchTreeInstanceValue,
   ): T;
+  visit_INTERNAL__PropagatedValue(
+    valueSpecification: INTERNAL__PropagatedValue,
+  ): T;
   visit_PropertyGraphFetchTreeInstanceValue(
     valueSpecification: PropertyGraphFetchTreeInstanceValue,
   ): T;

package/src/models/protocols/pure/DSLData_PureProtocolProcessorPlugin_Extension.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 type { PlainObject } from '@finos/legend-shared';
+import type { EmbeddedData } from '../../metamodels/pure/data/EmbeddedData';
+import type { PureProtocolProcessorPlugin } from './PureProtocolProcessorPlugin';
+import type { V1_EmbeddedData } from './v1/model/data/V1_EmbeddedData';
+import type { V1_GraphTransformerContext } from './v1/transformation/pureGraph/from/V1_GraphTransformerContext';
+import type { V1_GraphBuilderContext } from './v1/transformation/pureGraph/to/V1_GraphBuilderContext';
+
+export type V1_EmbeddedDataBuilder = (
+  protocol: V1_EmbeddedData,
+  context: V1_GraphBuilderContext,
+) => EmbeddedData | undefined;
+
+export type V1_EmbeddedDataTransformer = (
+  metamodel: EmbeddedData,
+  context: V1_GraphTransformerContext,
+) => V1_EmbeddedData | undefined;
+
+export type V1_EmbeddedDataProtocolSerializer = (
+  protocol: V1_EmbeddedData,
+) => PlainObject<V1_EmbeddedData> | undefined;
+
+export type V1_EmbeddedDataProtocolDeserializer = (
+  json: PlainObject<V1_EmbeddedData>,
+) => V1_EmbeddedData | undefined;
+
+export interface DSLData_PureProtocolProcessorPlugin_Extension
+  extends PureProtocolProcessorPlugin {
+  V1_getExtraEmbeddedDataBuilders?(): V1_EmbeddedDataBuilder[];
+
+  V1_getExtraEmbeddedDataTransformers?(): V1_EmbeddedDataTransformer[];
+
+  V1_getExtraEmbeddedDataProtocolSerializers?(): V1_EmbeddedDataProtocolSerializer[];
+
+  V1_getExtraEmbeddedDataProtocolDeserializers?(): V1_EmbeddedDataProtocolDeserializer[];
+}

package/src/models/protocols/pure/DSLExternalFormat_PureProtocolProcessorPlugin.ts

@@ -25,8 +25,8 @@ import {
 import { deserialize, serialize } from 'serializr';
 import type { PureModel } from '../../../graph/PureModel';
 import {
-  getBinding,
-  getSchemaSet,
+  getOwnBinding,
+  getOwnSchemaSet,
 } from '../../../graphManager/DSLExternalFormat_GraphManagerHelper';
 import type { Connection } from '../../metamodels/pure/packageableElements/connection/Connection';
 import type { Mapping } from '../../metamodels/pure/packageableElements/mapping/Mapping';
@@ -77,7 +77,10 @@ import {
   V1_resolveSchemaSet,
 } from './v1/transformation/pureGraph/to/V1_DSLExternalFormat_GraphBuilderHelper';
 import { V1_ElementBuilder } from './v1/transformation/pureGraph/to/V1_ElementBuilder';
-import type { V1_GraphBuilderContext } from './v1/transformation/pureGraph/to/V1_GraphBuilderContext';
+import {
+  V1_buildFullPath,
+  type V1_GraphBuilderContext,
+} from './v1/transformation/pureGraph/to/V1_GraphBuilderContext';
 import {
   V1_bindingModelSchema,
   V1_BINDING_ELEMENT_PROTOCOL_TYPE,
@@ -114,7 +117,7 @@ export class DSLExternalFormat_PureProtocolProcessorPlugin
         ): PackageableElement => {
           assertType(elementProtocol, V1_Binding);
           const element = new Binding(elementProtocol.name);
-          const path = context.currentSubGraph.buildPath(
+          const path = V1_buildFullPath(
             elementProtocol.package,
             elementProtocol.name,
           );
@@ -126,11 +129,11 @@ export class DSLExternalFormat_PureProtocolProcessorPlugin
           context: V1_GraphBuilderContext,
         ): void => {
           assertType(elementProtocol, V1_Binding);
-          const path = context.graph.buildPath(
+          const path = V1_buildFullPath(
             elementProtocol.package,
             elementProtocol.name,
           );
-          const element = getBinding(path, context.graph);
+          const element = getOwnBinding(path, context.currentSubGraph);
           const schemaSet = elementProtocol.schemaSet
             ? V1_resolveSchemaSet(elementProtocol.schemaSet, context)
             : undefined;
@@ -166,7 +169,7 @@ export class DSLExternalFormat_PureProtocolProcessorPlugin
         ): PackageableElement => {
           assertType(elementProtocol, V1_SchemaSet);
           const element = new SchemaSet(elementProtocol.name);
-          const path = context.currentSubGraph.buildPath(
+          const path = V1_buildFullPath(
             elementProtocol.package,
             elementProtocol.name,
           );
@@ -182,11 +185,11 @@ export class DSLExternalFormat_PureProtocolProcessorPlugin
           context: V1_GraphBuilderContext,
         ): void => {
           assertType(elementProtocol, V1_SchemaSet);
-          const path = context.graph.buildPath(
+          const path = V1_buildFullPath(
             elementProtocol.package,
             elementProtocol.name,
           );
-          const element = getSchemaSet(path, context.graph);
+          const element = getOwnSchemaSet(path, context.currentSubGraph);
           element.format = guaranteeNonEmptyString(elementProtocol.format);
           element.schemas = elementProtocol.schemas.map((schema) => {
             const schemaElement = new Schema();

package/src/models/protocols/pure/PureProtocolProcessorPlugin.ts

@@ -79,6 +79,10 @@ export type V1_PropertyExpressionTypeInferrer = (
  * of plugin methods here without having to modify the abstract layer of graph manager.
  */
 export abstract class PureProtocolProcessorPlugin extends AbstractPlugin {
+  /**
+   * This helps to better type-checking for this empty abtract type
+   * See https://github.com/finos/legend-studio/blob/master/docs/technical/typescript-usage.md#understand-typescript-structual-type-system
+   */
   private readonly _$nominalTypeBrand!: 'PureProtocolProcessorPlugin';
 
   install(pluginManager: GraphPluginManager): void {

package/src/models/protocols/pure/v1/V1_Core_SystemModels.json

@@ -1,5 +1,52 @@
 {
   "elements": [
+    {
+      "_type": "Enumeration",
+      "name": "DurationUnit",
+      "package": "meta::pure::functions::date",
+      "values": [
+        {
+          "value": "DAYS"
+        },
+        {
+          "value": "WEEKS"
+        },
+        {
+          "value": "MONTHS"
+        },
+        {
+          "value": "YEARS"
+        }
+      ]
+    },
+    {
+      "_type": "Enumeration",
+      "name": "DayOfWeek",
+      "package": "meta::pure::functions::date",
+      "values": [
+        {
+          "value": "Monday"
+        },
+        {
+          "value": "Tuesday"
+        },
+        {
+          "value": "Wednesday"
+        },
+        {
+          "value": "Thursday"
+        },
+        {
+          "value": "Friday"
+        },
+        {
+          "value": "Saturday"
+        },
+        {
+          "value": "Sunday"
+        }
+      ]
+    },
     {
       "stereotypes": ["public", "protected", "private", "externalizable"],
       "package": "meta::pure::profiles",
@@ -1539,7 +1586,7 @@
               "value": "Key"
             }
           ],
-          "type": "metamodel::type::Nil"
+          "type": "meta::pure::metamodel::type::Nil"
         }
       ],
       "qualifiedProperties": [
@@ -1567,7 +1614,7 @@
     {
       "_type": "class",
       "name": "Nil",
-      "package": "metamodel::type"
+      "package": "meta::pure::metamodel::type"
     },
     {
       "_type": "class",