@finos/legend-graph 0.0.6 → 0.1.3

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

@@ -42,7 +42,7 @@ import { V1_PureModelContextComposite } from '../../model/context/V1_PureModelCo
 import { V1_Protocol } from '../../model/V1_Protocol';
 import { V1_AlloySdlc } from '../../model/context/V1_AlloySdlc';
 import type { V1_PureModelContext } from '../../model/context/V1_PureModelContext';
-import { V1_packageableElementPointerDeserrializerSchema } from '../../transformation/pureProtocol/serializationHelpers/V1_CoreSerializationHelper';
+import { V1_packageableElementPointerDeserializerSchema } from '../../transformation/pureProtocol/serializationHelpers/V1_CoreSerializationHelper';
 import type { PureProtocolProcessorPlugin } from '../../../PureProtocolProcessorPlugin';
 import type { Entity } from '@finos/legend-model-storage';
 import { GraphDataDeserializationError } from '../../../../../../graphManager/GraphManagerUtils';
@@ -102,9 +102,10 @@ const alloySdlcSerializationModelSchema = createModelSchema(V1_AlloySdlc, {
   _type: usingConstantValueSchema(V1_SdlcType.ALLOY),
   baseVersion: optional(primitive()),
   version: primitive(),
-  project: primitive(),
+  groupId: primitive(),
+  artifactId: primitive(),
   packageableElementPointers: list(
-    usingModelSchema(V1_packageableElementPointerDeserrializerSchema),
+    usingModelSchema(V1_packageableElementPointerDeserializerSchema),
   ),
 });
 

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

@@ -24,6 +24,7 @@ import {
   list,
   optional,
 } from 'serializr';
+import type { ModelSchema } from 'serializr';
 import type { PlainObject } from '@finos/legend-shared';
 import {
   usingConstantValueSchema,
@@ -59,6 +60,7 @@ import {
 } from '../../../model/packageableElements/store/relational/connection/V1_AuthenticationStrategy';
 import type { PureProtocolProcessorPlugin } from '../../../../PureProtocolProcessorPlugin';
 import type { StoreRelational_PureProtocolProcessorPlugin_Extension } from '../../../../StoreRelational_PureProtocolProcessorPlugin_Extension';
+import type { DSLMapping_PureProtocolProcessorPlugin_Extension } from '../../../../DSLMapping_PureProtocolProcessorPlugin_Extension';
 import { V1_ConnectionPointer } from '../../../model/packageableElements/connection/V1_ConnectionPointer';
 
 export const V1_PACKAGEABLE_CONNECTION_ELEMENT_PROTOCOL_TYPE = 'connection';
@@ -164,8 +166,13 @@ const snowflakeDatasourceSpecificationModelSchema = createModelSchema(
   {
     _type: usingConstantValueSchema(V1_DatasourceSpecificationType.SNOWFLAKE),
     accountName: primitive(),
+    accountType: optional(primitive()),
     cloudType: optional(primitive()),
     databaseName: primitive(),
+    nonProxyHosts: optional(primitive()),
+    organization: optional(primitive()),
+    proxyHost: optional(primitive()),
+    proxyPort: optional(primitive()),
     quotedIdentifiersIgnoreCase: optional(primitive()),
     region: primitive(),
     warehouseName: primitive(),
@@ -454,6 +461,7 @@ export const V1_deserializeAuthenticationStrategy = (
 export const V1_serializeConnectionValue = (
   protocol: V1_Connection,
   allowPointer: boolean,
+  plugins: PureProtocolProcessorPlugin[],
 ): PlainObject<V1_Connection> => {
   /* @MARKER: NEW CONNECTION TYPE SUPPORT --- consider adding connection type handler here whenever support for a new one is added to the app */
   if (protocol instanceof V1_JsonModelConnection) {
@@ -474,12 +482,25 @@ export const V1_serializeConnectionValue = (
       `Serializing connection pointer is not allowed here`,
     );
   }
+  const extraConnectionProtocolSerializers = plugins.flatMap(
+    (plugin) =>
+      (
+        plugin as DSLMapping_PureProtocolProcessorPlugin_Extension
+      ).V1_getExtraConnectionProtocolSerializers?.() ?? [],
+  );
+  for (const serializer of extraConnectionProtocolSerializers) {
+    const json = serializer(protocol);
+    if (json) {
+      return json;
+    }
+  }
   throw new UnsupportedOperationError(`Can't serialize connection`, protocol);
 };
 
 export const V1_deserializeConnectionValue = (
   json: PlainObject<V1_Connection>,
   allowPointer: boolean,
+  plugins: PureProtocolProcessorPlugin[],
 ): V1_Connection => {
   switch (json._type) {
     /* @MARKER: NEW CONNECTION TYPE SUPPORT --- consider adding connection type handler here whenever support for a new one is added to the app */
@@ -500,10 +521,23 @@ export const V1_deserializeConnectionValue = (
       throw new IllegalStateError(
         `Deserializing connection pointer is not allowed here`,
       );
-    default:
+    default: {
+      const extraConnectionProtocolDeserializers = plugins.flatMap(
+        (plugin) =>
+          (
+            plugin as DSLMapping_PureProtocolProcessorPlugin_Extension
+          ).V1_getExtraConnectionProtocolDeserializers?.() ?? [],
+      );
+      for (const deserializer of extraConnectionProtocolDeserializers) {
+        const protocol = deserializer(json);
+        if (protocol) {
+          return protocol;
+        }
+      }
       throw new UnsupportedOperationError(
         `Can't deserialize connection of type '${json._type}'`,
       );
+    }
   }
 };
 
@@ -532,17 +566,17 @@ export const V1_deserializeDatabaseConnectionValue = (
   }
 };
 
-export const V1_packageableConnectionModelSchema = createModelSchema(
-  V1_PackageableConnection,
-  {
+export const V1_packageableConnectionModelSchema = (
+  plugins: PureProtocolProcessorPlugin[],
+): ModelSchema<V1_PackageableConnection> =>
+  createModelSchema(V1_PackageableConnection, {
     _type: usingConstantValueSchema(
       V1_PACKAGEABLE_CONNECTION_ELEMENT_PROTOCOL_TYPE,
     ),
     connectionValue: custom(
-      (val) => V1_serializeConnectionValue(val, false),
-      (val) => V1_deserializeConnectionValue(val, false),
+      (val) => V1_serializeConnectionValue(val, false, plugins),
+      (val) => V1_deserializeConnectionValue(val, false, plugins),
     ),
     name: primitive(),
     package: primitive(),
-  },
-);
+  });

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

@@ -30,11 +30,13 @@ export const V1_sourceInformationSerialization = new SerializationFactory(
   }),
 );
 
-export const V1_packageableElementPointerDeserrializerSchema =
-  createModelSchema(V1_PackageableElementPointer, {
+export const V1_packageableElementPointerDeserializerSchema = createModelSchema(
+  V1_PackageableElementPointer,
+  {
     path: primitive(),
     type: primitive(),
-  });
+  },
+);
 
 export const V1_multiplicitySchema = createModelSchema(V1_Multiplicity, {
   lowerBound: primitive(),

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

@@ -21,7 +21,7 @@ import {
   usingModelSchema,
   usingConstantValueSchema,
 } from '@finos/legend-shared';
-import { V1_packageableElementPointerDeserrializerSchema } from '../../../transformation/pureProtocol/serializationHelpers/V1_CoreSerializationHelper';
+import { V1_packageableElementPointerDeserializerSchema } from '../../../transformation/pureProtocol/serializationHelpers/V1_CoreSerializationHelper';
 import {
   V1_GenerationSpecification,
   V1_GenerationTreeNode,
@@ -49,7 +49,7 @@ export const V1_generationSpecificationsModelSchema = createModelSchema(
       V1_GENERATION_SPECIFICATION_ELEMENT_PROTOCOL_TYPE,
     ),
     fileGenerations: list(
-      usingModelSchema(V1_packageableElementPointerDeserrializerSchema),
+      usingModelSchema(V1_packageableElementPointerDeserializerSchema),
     ),
     generationNodes: list(usingModelSchema(V1_generationTreeNodeModelSchema)),
     name: primitive(),

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

@@ -45,7 +45,7 @@ import { V1_Mapping } from '../../../model/packageableElements/mapping/V1_Mappin
 import { V1_MappingTest } from '../../../model/packageableElements/mapping/V1_MappingTest';
 import {
   V1_multiplicitySchema,
-  V1_packageableElementPointerDeserrializerSchema,
+  V1_packageableElementPointerDeserializerSchema,
 } from '../../../transformation/pureProtocol/serializationHelpers/V1_CoreSerializationHelper';
 import { V1_propertyPointerModelSchema } from './V1_DomainSerializationHelper';
 import { V1_FlatDataInputData } from '../../../model/packageableElements/store/flatData/mapping/V1_FlatDataInputData';
@@ -204,6 +204,7 @@ const rootRelationalClassMappingModelSchema = createModelSchema(
   {
     _type: usingConstantValueSchema(V1_ClassMappingType.ROOT_RELATIONAL),
     class: primitive(),
+    extendsClassMappingId: optional(primitive()),
     distinct: primitive(),
     filter: usingModelSchema(V1_filterMappingModelSchema),
     groupBy: custom(
@@ -243,6 +244,7 @@ const relationalClassMappingModelSchema = createModelSchema(
   {
     _type: usingConstantValueSchema(V1_ClassMappingType.RELATIONAL),
     class: optional(primitive()),
+    extendsClassMappingId: optional(primitive()),
     id: optional(primitive()),
     primaryKey: list(
       custom(
@@ -296,7 +298,6 @@ const otherwiseEmbeddedRelationalPropertyMappingModelSchgema =
       V1_PropertyMappingType.OTHERWISE_EMBEDDED_RELATIONAL,
     ),
     classMapping: usingModelSchema(relationalClassMappingModelSchema),
-    id: optional(primitive()),
     otherwisePropertyMapping: custom(
       (val) => V1_serializeRelationalPropertyMapping(val),
       (val) => V1_deserializeRelationalPropertyMapping(val),
@@ -345,8 +346,6 @@ function V1_serializeRelationalPropertyMapping(
 ): PlainObject<V1_PropertyMapping> | typeof SKIP {
   if (protocol instanceof V1_RelationalPropertyMapping) {
     return serialize(relationalPropertyMappingModelSchema, protocol);
-  } else if (protocol instanceof V1_EmbeddedRelationalPropertyMapping) {
-    return serialize(embeddedRelationalPropertyMappingModelSchema, protocol);
   } else if (
     protocol instanceof V1_OtherwiseEmbeddedRelationalPropertyMapping
   ) {
@@ -354,6 +353,8 @@ function V1_serializeRelationalPropertyMapping(
       otherwiseEmbeddedRelationalPropertyMappingModelSchgema,
       protocol,
     );
+  } else if (protocol instanceof V1_EmbeddedRelationalPropertyMapping) {
+    return serialize(embeddedRelationalPropertyMappingModelSchema, protocol);
   } else if (protocol instanceof V1_InlineEmbeddedPropertyMapping) {
     return serialize(inlineEmbeddedPropertyMappingModelSchema, protocol);
   } else if (protocol instanceof V1_XStorePropertyMapping) {
@@ -619,7 +620,7 @@ const V1_flatDataInputData = createModelSchema(V1_FlatDataInputData, {
   _type: usingConstantValueSchema(V1_InputDataType.FLAT_DATA),
   data: primitive(),
   sourceFlatData: usingModelSchema(
-    V1_packageableElementPointerDeserrializerSchema,
+    V1_packageableElementPointerDeserializerSchema,
   ),
 });
 

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

@@ -20,6 +20,8 @@ import {
   list,
   custom,
   serialize,
+  deserialize,
+  object,
 } from 'serializr';
 import type { PlainObject } from '@finos/legend-shared';
 import {
@@ -27,7 +29,7 @@ import {
   UnsupportedOperationError,
   usingModelSchema,
 } from '@finos/legend-shared';
-import { V1_packageableElementPointerDeserrializerSchema } from '../../../transformation/pureProtocol/serializationHelpers/V1_CoreSerializationHelper';
+import { V1_packageableElementPointerDeserializerSchema } from '../../../transformation/pureProtocol/serializationHelpers/V1_CoreSerializationHelper';
 import { V1_PackageableRuntime } from '../../../model/packageableElements/runtime/V1_PackageableRuntime';
 import type { V1_Runtime } from '../../../model/packageableElements/runtime/V1_Runtime';
 import {
@@ -41,6 +43,7 @@ import {
   V1_serializeConnectionValue,
   V1_deserializeConnectionValue,
 } from './V1_ConnectionSerializationHelper';
+import type { PureProtocolProcessorPlugin } from '../../../../PureProtocolProcessorPlugin';
 
 export const V1_PACKAGEABLE_RUNTIME_ELEMENT_PROTOCOL_TYPE = 'runtime';
 
@@ -58,53 +61,51 @@ export const V1_runtimePointerModelSchema = createModelSchema(
   },
 );
 
-export const V1_legacyRuntimeModelSchema = createModelSchema(V1_LegacyRuntime, {
-  _type: usingConstantValueSchema(V1_RuntimeType.LEGACY_RUNTIME),
-  connections: list(
-    custom(
-      (val) => V1_serializeConnectionValue(val, true),
-      (val) => V1_deserializeConnectionValue(val, true),
+export const V1_setupLegacyRuntimeSerialization = (
+  plugins: PureProtocolProcessorPlugin[],
+): void => {
+  createModelSchema(V1_LegacyRuntime, {
+    _type: usingConstantValueSchema(V1_RuntimeType.LEGACY_RUNTIME),
+    connections: list(
+      custom(
+        (val) => V1_serializeConnectionValue(val, true, plugins),
+        (val) => V1_deserializeConnectionValue(val, true, plugins),
+      ),
     ),
-  ),
-  mappings: list(
-    usingModelSchema(V1_packageableElementPointerDeserrializerSchema),
-  ),
-});
+    mappings: list(
+      usingModelSchema(V1_packageableElementPointerDeserializerSchema),
+    ),
+  });
+};
 
-export const V1_identifiedConnectionModelSchema = createModelSchema(
-  V1_IdentifiedConnection,
-  {
+export const V1_setupEngineRuntimeSerialization = (
+  plugins: PureProtocolProcessorPlugin[],
+): void => {
+  createModelSchema(V1_IdentifiedConnection, {
     connection: custom(
-      (val) => V1_serializeConnectionValue(val, true),
-      (val) => V1_deserializeConnectionValue(val, true),
+      (val) => V1_serializeConnectionValue(val, true, plugins),
+      (val) => V1_deserializeConnectionValue(val, true, plugins),
     ),
     id: primitive(),
-  },
-);
-
-export const V1_storeConnectionModelSchema = createModelSchema(
-  V1_StoreConnections,
-  {
-    store: usingModelSchema(V1_packageableElementPointerDeserrializerSchema),
-    storeConnections: list(
-      usingModelSchema(V1_identifiedConnectionModelSchema),
+  });
+  createModelSchema(V1_StoreConnections, {
+    store: usingModelSchema(V1_packageableElementPointerDeserializerSchema),
+    storeConnections: list(object(V1_IdentifiedConnection)),
+  });
+  createModelSchema(V1_EngineRuntime, {
+    _type: usingConstantValueSchema(V1_RuntimeType.ENGINE_RUNTIME),
+    connections: list(object(V1_StoreConnections)),
+    mappings: list(
+      usingModelSchema(V1_packageableElementPointerDeserializerSchema),
     ),
-  },
-);
-
-export const V1_engineRuntimeModelSchema = createModelSchema(V1_EngineRuntime, {
-  _type: usingConstantValueSchema(V1_RuntimeType.ENGINE_RUNTIME),
-  connections: list(usingModelSchema(V1_storeConnectionModelSchema)),
-  mappings: list(
-    usingModelSchema(V1_packageableElementPointerDeserrializerSchema),
-  ),
-});
+  });
+};
 
 export const V1_serializeRuntime = (
   protocol: V1_Runtime,
 ): PlainObject<V1_Runtime> => {
   if (protocol instanceof V1_EngineRuntime) {
-    return serialize(V1_engineRuntimeModelSchema, protocol);
+    return serialize(V1_EngineRuntime, protocol);
   } else if (protocol instanceof V1_RuntimePointer) {
     return serialize(V1_runtimePointerModelSchema, protocol);
   }
@@ -119,6 +120,9 @@ export const V1_packageableRuntimeModelSchema = createModelSchema(
     ),
     name: primitive(),
     package: primitive(),
-    runtimeValue: usingModelSchema(V1_engineRuntimeModelSchema),
+    runtimeValue: custom(
+      (val) => serialize(V1_EngineRuntime, val),
+      (val) => deserialize(V1_EngineRuntime, val),
+    ),
   },
 );

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

@@ -46,8 +46,6 @@ import {
 } from '../../../model/packageableElements/runtime/V1_Runtime';
 import {
   V1_runtimePointerModelSchema,
-  V1_engineRuntimeModelSchema,
-  V1_legacyRuntimeModelSchema,
   V1_RuntimeType,
 } from './V1_RuntimeSerializationHelper';
 import type { V1_ServiceTest } from '../../../model/packageableElements/service/V1_ServiceTest';
@@ -81,9 +79,9 @@ const V1_serializeRuntimeValue = (
   if (protocol instanceof V1_RuntimePointer) {
     return serialize(V1_runtimePointerModelSchema, protocol);
   } else if (protocol instanceof V1_EngineRuntime) {
-    return serialize(V1_engineRuntimeModelSchema, protocol);
+    return serialize(V1_EngineRuntime, protocol);
   } else if (protocol instanceof V1_LegacyRuntime) {
-    return serialize(V1_legacyRuntimeModelSchema, protocol);
+    return serialize(V1_LegacyRuntime, protocol);
   }
   throw new UnsupportedOperationError(
     `Can't serialize runtime value`,
@@ -98,10 +96,10 @@ const V1_deserializeRuntimeValue = (
     case V1_RuntimeType.RUNTIME_POINTER:
       return deserialize(V1_runtimePointerModelSchema, json);
     case V1_RuntimeType.ENGINE_RUNTIME:
-      return deserialize(V1_engineRuntimeModelSchema, json);
+      return deserialize(V1_EngineRuntime, json);
     case V1_RuntimeType.LEGACY_RUNTIME:
     case undefined:
-      return deserialize(V1_legacyRuntimeModelSchema, json);
+      return deserialize(V1_LegacyRuntime, json);
     default:
       throw new UnsupportedOperationError(
         `Can't deeserialize runtime value of type '${json._type}'`,

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

@@ -70,10 +70,7 @@ import type {
 import { V1_PropertyPathElement } from '../../../model/valueSpecification/raw/path/V1_PropertyPathElement';
 import type { V1_PathElement } from '../../../model/valueSpecification/raw/path/V1_PathElement';
 import { V1_AppliedProperty } from '../../../model/valueSpecification/application/V1_AppliedProperty';
-import {
-  V1_engineRuntimeModelSchema,
-  V1_serializeRuntime,
-} from './V1_RuntimeSerializationHelper';
+import { V1_serializeRuntime } from './V1_RuntimeSerializationHelper';
 import type { V1_ExecutionContext } from '../../../model/valueSpecification/raw/executionContext/V1_ExecutionContext';
 import { V1_AnalyticsExecutionContext } from '../../../model/valueSpecification/raw/executionContext/V1_AnalyticsExecutionContext';
 import { V1_BaseExecutionContext } from '../../../model/valueSpecification/raw/executionContext/V1_BaseExecutionContext';
@@ -82,6 +79,7 @@ import { V1_PackageableElementPtr } from '../../../model/valueSpecification/raw/
 import { V1_HackedClass } from '../../../model/valueSpecification/raw/V1_HackedClass';
 import { V1_HackedUnit } from '../../../model/valueSpecification/raw/V1_HackedUnit';
 import type { V1_INTERNAL__UnknownValueSpecfication } from '../../../model/valueSpecification/V1_INTERNAL__UnknownValueSpecfication';
+import { V1_EngineRuntime } from '../../../model/packageableElements/runtime/V1_Runtime';
 
 enum V1_PathElementType {
   PROPERTY_PATH_ELEMENT = 'propertyPath',
@@ -320,7 +318,7 @@ const runtimeInstanceModelSchema = createModelSchema(V1_RuntimeInstance, {
   _type: usingConstantValueSchema(V1_ValueSpecificationType.RUNTIME_INSTANCE),
   runtime: custom(
     (val) => V1_serializeRuntime(val),
-    (val) => deserialize(V1_engineRuntimeModelSchema, val),
+    (val) => deserialize(V1_EngineRuntime, val),
   ),
 });
 

package/tsconfig.json

@@ -234,6 +234,7 @@
     "./src/models/metamodels/pure/valueSpecification/ValueSpecification.ts",
     "./src/models/metamodels/pure/valueSpecification/VariableExpression.ts",
     "./src/models/protocols/pure/DSLGenerationSpecification_PureProtocolProcessorPlugin_Extension.ts",
+    "./src/models/protocols/pure/DSLMapping_PureProtocolProcessorPlugin_Extension.ts",
     "./src/models/protocols/pure/Pure.ts",
     "./src/models/protocols/pure/PureProtocolProcessorPlugin.ts",
     "./src/models/protocols/pure/StoreRelational_PureProtocolProcessorPlugin_Extension.ts",

package/tsconfig.package.json

@@ -0,0 +1,40 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext",
+      "webworker",
+      "scripthost"
+    ],
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "module": "esnext",
+    "skipLibCheck": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "importsNotUsedAsValues": "error",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./lib",
+    "tsBuildInfoFile": "./build/package.tsbuildinfo",
+    "rootDir": "./"
+  },
+  "files": [
+    "./package.json"
+  ],
+  "include": [
+    "package.json"
+  ],
+  "exclude": [
+    "lib"
+  ]
+}