@finos/legend-graph 0.2.2 → 0.3.1

package/src/models/protocols/pure/v1/engine/query/V1_Query.ts

@@ -14,8 +14,17 @@
  * limitations under the License.
  */
 
-import { SerializationFactory } from '@finos/legend-shared';
-import { createModelSchema, optional, primitive } from 'serializr';
+import {
+  NullphobicSerializationFactory,
+  usingModelSchema,
+} from '@finos/legend-shared';
+import { createModelSchema, list, optional, primitive } from 'serializr';
+import type { V1_StereotypePtr } from '../../model/packageableElements/domain/V1_StereotypePtr';
+import type { V1_TaggedValue } from '../../model/packageableElements/domain/V1_TaggedValue';
+import {
+  V1_stereotypePtrSchema,
+  V1_taggedValueSchema,
+} from '../../transformation/pureProtocol/serializationHelpers/V1_DomainSerializationHelper';
 
 export class V1_Query {
   name!: string;
@@ -27,8 +36,10 @@ export class V1_Query {
   runtime!: string;
   content!: string;
   owner?: string | undefined;
+  taggedValues?: V1_TaggedValue[] | undefined;
+  stereotypes?: V1_StereotypePtr[] | undefined;
 
-  static readonly serialization = new SerializationFactory(
+  static readonly serialization = new NullphobicSerializationFactory(
     createModelSchema(V1_Query, {
       artifactId: primitive(),
       content: primitive(),
@@ -38,6 +49,8 @@ export class V1_Query {
       name: primitive(),
       owner: optional(primitive()),
       runtime: primitive(),
+      stereotypes: optional(list(usingModelSchema(V1_stereotypePtrSchema))),
+      taggedValues: optional(list(usingModelSchema(V1_taggedValueSchema))),
       versionId: primitive(),
     }),
   );
@@ -51,7 +64,7 @@ export class V1_LightQuery {
   artifactId!: string;
   versionId!: string;
 
-  static readonly serialization = new SerializationFactory(
+  static readonly serialization = new NullphobicSerializationFactory(
     createModelSchema(V1_Query, {
       artifactId: primitive(),
       id: primitive(),

package/src/models/protocols/pure/v1/engine/query/V1_QuerySearchSpecification.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 {
+  NullphobicSerializationFactory,
+  SerializationFactory,
+  usingModelSchema,
+} from '@finos/legend-shared';
+import { createModelSchema, list, optional, primitive } from 'serializr';
+import type { V1_StereotypePtr } from '../../model/packageableElements/domain/V1_StereotypePtr';
+import type { V1_TaggedValue } from '../../model/packageableElements/domain/V1_TaggedValue';
+import {
+  V1_stereotypePtrSchema,
+  V1_taggedValueSchema,
+} from '../../transformation/pureProtocol/serializationHelpers/V1_DomainSerializationHelper';
+
+export class V1_QueryProjectCoordinates {
+  groupId!: string;
+  artifactId!: string;
+
+  static readonly serialization = new SerializationFactory(
+    createModelSchema(V1_QueryProjectCoordinates, {
+      artifactId: primitive(),
+      groupId: primitive(),
+    }),
+  );
+}
+
+export class V1_QuerySearchSpecification {
+  searchTerm?: string | undefined;
+  projectCoordinates?: V1_QueryProjectCoordinates[] | undefined;
+  taggedValues?: V1_TaggedValue[] | undefined;
+  stereotypes?: V1_StereotypePtr[] | undefined;
+  limit?: number | undefined;
+  showCurrentUserQueriesOnly?: boolean | undefined;
+
+  static readonly serialization = new NullphobicSerializationFactory(
+    createModelSchema(V1_QuerySearchSpecification, {
+      limit: optional(primitive()),
+      projectCoordinates: optional(
+        list(usingModelSchema(V1_QueryProjectCoordinates.serialization.schema)),
+      ),
+      searchTerm: optional(primitive()),
+      showCurrentUserQueriesOnly: optional(primitive()),
+      stereotypes: optional(list(usingModelSchema(V1_stereotypePtrSchema))),
+      taggedValues: optional(list(usingModelSchema(V1_taggedValueSchema))),
+    }),
+  );
+}

package/src/models/protocols/pure/v1/model/context/V1_PureModelContextText.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { V1_PureModelContext } from '../../model/context/V1_PureModelContext';
+import type { V1_Protocol } from '../../model/V1_Protocol';
+
+export class V1_PureModelContextText extends V1_PureModelContext {
+  serializer?: V1_Protocol | undefined;
+  code?: string | undefined;
+}

package/src/models/protocols/pure/v1/model/packageableElements/store/relational/connection/V1_DatasourceSpecification.ts

@@ -84,6 +84,7 @@ export class V1_SnowflakeDatasourceSpecification
   nonProxyHosts?: string | undefined;
   organization?: string | undefined;
   accountType?: string | undefined;
+  role?: string | undefined;
 
   get hashCode(): string {
     return hashArray([
@@ -98,6 +99,7 @@ export class V1_SnowflakeDatasourceSpecification
       this.nonProxyHosts ?? '',
       this.organization ?? '',
       this.accountType ?? '',
+      this.role ?? '',
       this.quotedIdentifiersIgnoreCase?.toString() ?? '',
     ]);
   }

package/src/models/protocols/pure/v1/transformation/pureGraph/from/V1_ConnectionTransformer.ts

@@ -120,6 +120,7 @@ const transformSnowflakeDatasourceSpecification = (
   source.nonProxyHosts = metamodel.nonProxyHosts;
   source.organization = metamodel.organization;
   source.accountType = metamodel.accountType;
+  source.role = metamodel.role;
   return source;
 };
 

package/src/models/protocols/pure/v1/transformation/pureGraph/from/V1_ValueSpecificationTransformer.ts

@@ -200,6 +200,7 @@ class V1_ValueSpecificationTransformer
       }
       case PRIMITIVE_TYPE.LATESTDATE: {
         const cPrimitiveType = new V1_CLatestDate();
+        cPrimitiveType.multiplicity = multiplicity;
         return cPrimitiveType;
       }
       default:

package/src/models/protocols/pure/v1/transformation/pureGraph/to/helpers/V1_DomainBuilderHelper.ts

@@ -248,7 +248,8 @@ const isCompatibleDerivedProperty = (
 ): boolean =>
   o.name === name &&
   Array.isArray(o.parameters) &&
-  o.parameters.length === params.length;
+  // We add 1 to account for the `this` parameter in the derived property
+  o.parameters.length + 1 === params.length;
 
 export const V1_getAppliedProperty = (
   parentClass: Class,

package/src/models/protocols/pure/v1/transformation/pureGraph/to/helpers/V1_RelationalConnectionBuilderHelper.ts

@@ -134,6 +134,7 @@ export const V1_buildDatasourceSpecification = (
     snowflakeSpec.nonProxyHosts = protocol.nonProxyHosts;
     snowflakeSpec.organization = protocol.organization;
     snowflakeSpec.accountType = protocol.accountType;
+    snowflakeSpec.role = protocol.role;
     return snowflakeSpec;
   } else if (protocol instanceof V1_BigQueryDatasourceSpecification) {
     assertNonEmptyString(

package/src/models/protocols/pure/v1/transformation/pureGraph/to/helpers/V1_ValueSpecificationBuilderHelper.ts

@@ -19,6 +19,8 @@ import {
   guaranteeNonNullable,
   guaranteeType,
   UnsupportedOperationError,
+  isNonNullable,
+  uniq,
 } from '@finos/legend-shared';
 import {
   TYPICAL_MULTIPLICITY_TYPE,
@@ -265,6 +267,17 @@ export class V1_ValueSpecificationBuilder
       ),
     );
     instance.values = transformed;
+    // NOTE: Engine applies a more sophisticated `findMostCommon()` algorithm to find the collection's generic type. Here we only handle the case where the collection has one type.
+    const typeValues = uniq(
+      instance.values
+        .map((v) => v.genericType?.value.rawType)
+        .filter(isNonNullable),
+    );
+    if (typeValues.length === 1) {
+      instance.genericType = GenericTypeExplicitReference.create(
+        new GenericType(guaranteeNonNullable(typeValues[0])),
+      );
+    }
     return instance;
   }
 
@@ -690,7 +703,7 @@ function buildPropertyGraphFetchTree(
 ): PropertyGraphFetchTree {
   let property: AbstractProperty;
   let pureParameters: ValueSpecification[] = [];
-  if (!propertyGraphFetchTree.parameters.length) {
+  if (propertyGraphFetchTree.parameters.length) {
     const thisVariable = new V1_Variable();
     thisVariable.name = 'this';
     thisVariable.class = parentClass.path;

package/src/models/protocols/pure/v1/transformation/pureProtocol/V1_PureProtocolSerialization.ts

@@ -23,6 +23,7 @@ import {
   SKIP,
   serialize,
   deserialize,
+  object,
 } from 'serializr';
 import type { PlainObject } from '@finos/legend-shared';
 import {
@@ -46,6 +47,7 @@ import { V1_packageableElementPointerDeserializerSchema } from '../../transforma
 import type { PureProtocolProcessorPlugin } from '../../../PureProtocolProcessorPlugin';
 import type { Entity } from '@finos/legend-model-storage';
 import { GraphDataDeserializationError } from '../../../../../../graphManager/GraphManagerUtils';
+import { V1_PureModelContextText } from '../../model/context/V1_PureModelContextText';
 
 enum V1_SDLCType {
   ALLOY = 'alloy',
@@ -55,6 +57,7 @@ export enum V1_PureModelContextType {
   DATA = 'data',
   POINTER = 'pointer',
   COMPOSITE = 'composite',
+  TEXT = 'text',
 }
 
 export const V1_entitiesToPureModelContextData = async (
@@ -109,10 +112,13 @@ const alloySDLCSerializationModelSchema = createModelSchema(V1_AlloySDLC, {
   ),
 });
 
-export const V1_pureModelContextDataPropSchema = custom(
-  (value) =>
-    value === undefined ? SKIP : serialize(V1_PureModelContextData, value),
-  (value) => deserialize(V1_PureModelContextData, value),
+const V1_pureModelContextTextSchema = createModelSchema(
+  V1_PureModelContextText,
+  {
+    _type: usingConstantValueSchema(V1_PureModelContextType.TEXT),
+    serializer: usingModelSchema(V1_Protocol.serialization.schema),
+    code: optional(primitive()),
+  },
 );
 
 const V1_pureModelContextPointerModelSchema = createModelSchema(
@@ -129,7 +135,7 @@ const V1_pureModelContextCompositeModelSchema = createModelSchema(
   {
     _type: usingConstantValueSchema(V1_PureModelContextType.COMPOSITE),
     serializer: usingModelSchema(V1_Protocol.serialization.schema),
-    data: V1_pureModelContextDataPropSchema,
+    data: object(V1_PureModelContextData),
     pointer: usingModelSchema(V1_pureModelContextPointerModelSchema),
   },
 );
@@ -172,9 +178,17 @@ export const V1_serializePureModelContext = (
     return V1_serializePureModelContextData(pureModelContext);
   } else if (pureModelContext instanceof V1_PureModelContextComposite) {
     return serialize(V1_pureModelContextCompositeModelSchema, pureModelContext);
+  } else if (pureModelContext instanceof V1_PureModelContextText) {
+    return serialize(V1_pureModelContextTextSchema, pureModelContext);
   }
   throw new UnsupportedOperationError(
     `Can't serialize Pure model context`,
     pureModelContext,
   );
 };
+
+export const V1_pureModelContextPropSchema = custom(
+  (val: V1_PureModelContext) => V1_serializePureModelContext(val),
+  // TODO: we will populate this when we need to `deserialize`
+  (val) => SKIP,
+);

package/src/models/protocols/pure/v1/transformation/pureProtocol/serializationHelpers/V1_ConnectionSerializationHelper.ts

@@ -175,6 +175,7 @@ const snowflakeDatasourceSpecificationModelSchema = createModelSchema(
     proxyPort: optional(primitive()),
     quotedIdentifiersIgnoreCase: optional(primitive()),
     region: primitive(),
+    role: optional(primitive()),
     warehouseName: primitive(),
   },
 );

package/src/models/protocols/pure/v1/transformation/pureProtocol/serializationHelpers/V1_DatabaseSerializationHelper.ts

@@ -21,13 +21,13 @@ import {
   list,
   deserialize,
   serialize,
-  SKIP,
   object,
   alias,
   optional,
 } from 'serializr';
 import type { PlainObject } from '@finos/legend-shared';
 import {
+  optionalCustom,
   usingConstantValueSchema,
   deserializeArray,
   UnsupportedOperationError,
@@ -343,11 +343,9 @@ const V1_elementWithJoinsModelSchema = createModelSchema(V1_ElementWithJoins, {
     V1_RelationalOperationElementType.ELEMENT_WITH_JOINS,
   ),
   joins: list(usingModelSchema(V1_joinPointerModelSchema)),
-  relationalElement: custom(
-    (val) =>
-      val === undefined ? SKIP : V1_serializeRelationalOperationElement(val),
-    (val) =>
-      val === undefined ? SKIP : V1_deserializeRelationalOperationElement(val),
+  relationalElement: optionalCustom(
+    V1_serializeRelationalOperationElement,
+    V1_deserializeRelationalOperationElement,
   ),
 });
 

package/src/models/protocols/pure/v1/transformation/pureProtocol/serializationHelpers/V1_DomainSerializationHelper.ts

@@ -251,10 +251,7 @@ export const V1_constraintSchema = createModelSchema(V1_Constraint, {
   enforcementLevel: optional(primitive()),
   externalId: optional(primitive()),
   functionDefinition: usingModelSchema(V1_rawLambdaModelSchema),
-  messageFunction: custom(
-    (value) => (value ? serialize(V1_rawLambdaModelSchema, value) : SKIP),
-    (value) => deserialize(V1_rawLambdaModelSchema, value),
-  ),
+  messageFunction: optional(usingModelSchema(V1_rawLambdaModelSchema)),
   name: primitive(),
 });
 

package/src/models/protocols/pure/v1/transformation/pureProtocol/serializationHelpers/V1_MappingSerializationHelper.ts

@@ -577,7 +577,7 @@ function V1_serializeClassMapping(
   } else if (value instanceof V1_AggregationAwareClassMapping) {
     return serialize(aggregationAwareClassMappingModelSchema, value);
   }
-  if (plugins !== undefined) {
+  if (plugins) {
     const extraClassMappingSerializers = plugins.flatMap(
       (plugin) =>
         (
@@ -615,7 +615,7 @@ function V1_deserializeClassMapping(
     case V1_ClassMappingType.AGGREGATION_AWARE:
       return deserialize(aggregationAwareClassMappingModelSchema, json);
     default: {
-      if (plugins !== undefined) {
+      if (plugins) {
         const extraClassMappingDeserializers = plugins.flatMap(
           (plugin) =>
             (
@@ -1007,18 +1007,8 @@ export const V1_mappingModelSchema = (
     ),
     classMappings: list(
       custom(
-        (val) => {
-          if (plugins !== undefined) {
-            return V1_serializeClassMapping(val, plugins);
-          }
-          return V1_serializeClassMapping(val);
-        },
-        (val) => {
-          if (plugins !== undefined) {
-            return V1_deserializeClassMapping(val, plugins);
-          }
-          return V1_deserializeClassMapping(val);
-        },
+        (val) => V1_serializeClassMapping(val, plugins),
+        (val) => V1_deserializeClassMapping(val, plugins),
       ),
     ),
     enumerationMappings: list(

package/src/models/protocols/pure/v1/transformation/pureProtocol/serializationHelpers/V1_MilestoningSerializationHelper.ts

@@ -16,16 +16,15 @@
 
 import type { PlainObject } from '@finos/legend-shared';
 import {
+  optionalCustom,
   usingConstantValueSchema,
   UnsupportedOperationError,
 } from '@finos/legend-shared';
 import {
   createModelSchema,
-  custom,
   deserialize,
   primitive,
   serialize,
-  SKIP,
 } from 'serializr';
 import { V1_BusinessMilestoning } from '../../../model/packageableElements/store/relational/model/milestoning/V1_BusinessMilestoning';
 import { V1_BusinessSnapshotMilestoning } from '../../../model/packageableElements/store/relational/model/milestoning/V1_BusinessSnapshotMilestoning';
@@ -49,9 +48,9 @@ const businessMilestoningModelSchema = createModelSchema(
   {
     _type: usingConstantValueSchema(V1_MilestoningType.BUSINESS_MILESTONING),
     from: primitive(),
-    infinityDate: custom(
-      (val) => (val ? V1_serializeRawValueSpecification(val) : SKIP),
-      (val) => (val ? V1_deserializeRawValueSpecification(val) : SKIP),
+    infinityDate: optionalCustom(
+      V1_serializeRawValueSpecification,
+      V1_deserializeRawValueSpecification,
     ),
     thru: primitive(),
     thruIsInclusive: primitive(),
@@ -64,9 +63,9 @@ const businessSnapshotMilestoningModelSchema = createModelSchema(
     _type: usingConstantValueSchema(
       V1_MilestoningType.BUSINESS_SNAPSHOT_MILESTONING,
     ),
-    infinityDate: custom(
-      (val) => (val ? V1_serializeRawValueSpecification(val) : SKIP),
-      (val) => (val ? V1_deserializeRawValueSpecification(val) : SKIP),
+    infinityDate: optionalCustom(
+      V1_serializeRawValueSpecification,
+      V1_deserializeRawValueSpecification,
     ),
     snapshotDate: primitive(),
   },
@@ -77,9 +76,9 @@ const processingMilestoningModelSchema = createModelSchema(
   {
     _type: usingConstantValueSchema(V1_MilestoningType.PROCESSING_MILESTONING),
     in: primitive(),
-    infinityDate: custom(
-      (val) => (val ? V1_serializeRawValueSpecification(val) : SKIP),
-      (val) => (val ? V1_deserializeRawValueSpecification(val) : SKIP),
+    infinityDate: optionalCustom(
+      V1_serializeRawValueSpecification,
+      V1_deserializeRawValueSpecification,
     ),
     out: primitive(),
     outIsInclusive: primitive(),

package/src/models/protocols/pure/v1/transformation/pureProtocol/serializationHelpers/executionPlan/V1_ExecutionPlanSerializationHelper.ts

@@ -22,10 +22,10 @@ import {
   primitive,
   list,
   optional,
-  SKIP,
 } from 'serializr';
 import type { PlainObject } from '@finos/legend-shared';
 import {
+  optionalCustom,
   deserializeArray,
   serializeArray,
   deseralizeMap,
@@ -64,9 +64,9 @@ const dataTypeResultTypeModelSchema = createModelSchema(V1_DataTypeResultType, {
 
 const TDSColumnModelSchema = createModelSchema(V1_TDSColumn, {
   doc: optional(primitive()),
-  enumMapping: custom(
-    (val) => (val ? serializeMap(val) : SKIP),
-    (val) => (val ? deseralizeMap(val) : undefined),
+  enumMapping: optionalCustom(
+    (val: Map<string, unknown>) => serializeMap(val),
+    deseralizeMap,
   ),
   name: primitive(),
   relationalType: optional(primitive()),

package/tsconfig.json

@@ -70,10 +70,12 @@
     "./src/graphManager/action/generation/GenerationOutput.ts",
     "./src/graphManager/action/generation/ImportConfigurationDescription.ts",
     "./src/graphManager/action/query/Query.ts",
+    "./src/graphManager/action/query/QuerySearchSpecification.ts",
     "./src/graphManager/action/service/ServiceExecutionMode.ts",
     "./src/graphManager/action/service/ServiceRegistrationResult.ts",
     "./src/graphManager/action/service/ServiceTestResult.ts",
     "./src/helpers/DatabaseHelper.ts",
+    "./src/helpers/DomainHelper.ts",
     "./src/helpers/MappingHelper.ts",
     "./src/helpers/MappingResolutionHelper.ts",
     "./src/helpers/ServiceHelper.ts",
@@ -265,6 +267,7 @@
     "./src/models/protocols/pure/v1/engine/import/V1_ImportConfigurationDescription.ts",
     "./src/models/protocols/pure/v1/engine/import/V1_PureModelContextGenerationInput.ts",
     "./src/models/protocols/pure/v1/engine/query/V1_Query.ts",
+    "./src/models/protocols/pure/v1/engine/query/V1_QuerySearchSpecification.ts",
     "./src/models/protocols/pure/v1/engine/service/V1_ServiceConfiguration.ts",
     "./src/models/protocols/pure/v1/engine/service/V1_ServiceRegistrationResult.ts",
     "./src/models/protocols/pure/v1/engine/service/V1_ServiceStorage.ts",
@@ -275,6 +278,7 @@
     "./src/models/protocols/pure/v1/model/context/V1_PureModelContextComposite.ts",
     "./src/models/protocols/pure/v1/model/context/V1_PureModelContextData.ts",
     "./src/models/protocols/pure/v1/model/context/V1_PureModelContextPointer.ts",
+    "./src/models/protocols/pure/v1/model/context/V1_PureModelContextText.ts",
     "./src/models/protocols/pure/v1/model/context/V1_SDLC.ts",
     "./src/models/protocols/pure/v1/model/executionPlan/V1_ExecutionPlan.ts",
     "./src/models/protocols/pure/v1/model/executionPlan/V1_SimpleExecutionPlan.ts",