@finos/legend-graph 32.1.63 → 32.1.64

package/src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_DataProductSerializationHelper.ts

@@ -16,7 +16,6 @@
 
 import {
   createModelSchema,
-  custom,
   deserialize,
   optional,
   primitive,
@@ -24,13 +23,21 @@ import {
 } from 'serializr';
 import {
   type V1_AccessPoint,
-  V1_AccessPointGroup,
   V1_DATA_PRODUCT_ELEMENT_PROTOCOL_TYPE,
   V1_DataProduct,
   V1_Email,
   V1_SupportInfo,
   V1_LakehouseAccessPoint,
   V1_UnknownAccessPoint,
+  V1_AccessPointGroup,
+  V1_ModelAccessPointGroup,
+  V1_ElementScope,
+  V1_DataProductRuntimeInfo,
+  V1_DataProductDiagram,
+  V1_EmbeddedImageIcon,
+  V1_LibraryIcon,
+  type V1_DataProductIcon,
+  V1_DataProductLink,
 } from '../../../model/packageableElements/dataProduct/V1_DataProduct.js';
 import {
   UnsupportedOperationError,
@@ -40,9 +47,15 @@ import {
   type PlainObject,
   customListWithSchema,
   optionalCustomUsingModelSchema,
+  optionalCustom,
+  optionalCustomList,
 } from '@finos/legend-shared';
 import { V1_rawLambdaModelSchema } from './V1_RawValueSpecificationSerializationHelper.js';
-import { V1_stereotypePtrModelSchema } from './V1_CoreSerializationHelper.js';
+import {
+  V1_packageableElementPointerModelSchema,
+  V1_stereotypePtrModelSchema,
+  V1_taggedValueModelSchema,
+} from './V1_CoreSerializationHelper.js';
 
 export enum V1_AccessPointType {
   LAKEHOUSE = 'lakehouseAccessPoint',
@@ -50,16 +63,21 @@ export enum V1_AccessPointType {
   EQUAL_TO_TDS = 'equalToTDS',
 }
 
+export enum V1_AccessPointGrouptype {
+  DEFAULT_ACCESS_POINT_GROUP = 'defaultAccessPointGroup',
+  MODEL_ACCESS_POINT_GROUP = 'modelAccessPointGroup',
+}
+
 export const V1_lakehouseAccessPointModelSchema = createModelSchema(
   V1_LakehouseAccessPoint,
   {
     _type: usingConstantValueSchema(V1_AccessPointType.LAKEHOUSE),
-    id: primitive(),
-    description: optional(primitive()),
-    targetEnvironment: primitive(),
     classification: optional(primitive()),
+    description: optional(primitive()),
     func: usingModelSchema(V1_rawLambdaModelSchema),
+    id: primitive(),
     reproducible: optional(primitive()),
+    targetEnvironment: primitive(),
   },
 );
 
@@ -92,62 +110,181 @@ const V1_deserializeAccessPoint = (
   }
 };
 
-export const V1_AccessPointGroupModelSchema = createModelSchema(
-  V1_AccessPointGroup,
+export const V1_DataProductRuntimeInfoModelSchema = createModelSchema(
+  V1_DataProductRuntimeInfo,
   {
+    description: optional(primitive()),
     id: primitive(),
+    runtime: usingModelSchema(V1_packageableElementPointerModelSchema),
+  },
+);
+
+export const V1_dataProductDiagramModelSchema = createModelSchema(
+  V1_DataProductDiagram,
+  {
+    title: primitive(),
     description: optional(primitive()),
-    stereotypes: customListWithSchema(V1_stereotypePtrModelSchema, {
-      INTERNAL__forceReturnEmptyInTest: true,
-    }),
+    diagram: usingModelSchema(V1_packageableElementPointerModelSchema),
+  },
+);
+
+export const V1_ElementScopeModelSchema = createModelSchema(V1_ElementScope, {
+  element: usingModelSchema(V1_packageableElementPointerModelSchema),
+  exclude: optional(primitive()),
+});
+
+export const V1_ModelAccessPointGroupModelSchema = createModelSchema(
+  V1_ModelAccessPointGroup,
+  {
+    _type: usingConstantValueSchema(
+      V1_AccessPointGrouptype.MODEL_ACCESS_POINT_GROUP,
+    ),
     accessPoints: customList(
       V1_serializeAccessPoint,
       V1_deserializeAccessPoint,
     ),
+    compatibleRuntimes: customListWithSchema(
+      V1_DataProductRuntimeInfoModelSchema,
+    ),
+    defaultRuntime: primitive(),
+    description: optional(primitive()),
+    diagrams: customListWithSchema(V1_dataProductDiagramModelSchema),
+    featuredElements: customListWithSchema(V1_ElementScopeModelSchema),
+    id: primitive(),
+    stereotypes: customListWithSchema(V1_stereotypePtrModelSchema),
+    mapping: usingModelSchema(V1_packageableElementPointerModelSchema),
+  },
+);
+
+export const V1_DefaultAccessPointGroupModelSchema = createModelSchema(
+  V1_AccessPointGroup,
+  {
+    _type: usingConstantValueSchema(
+      V1_AccessPointGrouptype.DEFAULT_ACCESS_POINT_GROUP,
+    ),
+    accessPoints: customList(
+      V1_serializeAccessPoint,
+      V1_deserializeAccessPoint,
+    ),
+    description: optional(primitive()),
+    id: primitive(),
+    stereotypes: customListWithSchema(V1_stereotypePtrModelSchema, {
+      INTERNAL__forceReturnEmptyInTest: true,
+    }),
+  },
+);
+
+const V1_serializeAccessPointGroup = (
+  protocol: V1_AccessPointGroup,
+): PlainObject<V1_AccessPointGroup> => {
+  if (protocol instanceof V1_ModelAccessPointGroup) {
+    return serialize(V1_ModelAccessPointGroupModelSchema, protocol);
+  }
+  return serialize(V1_DefaultAccessPointGroupModelSchema, protocol);
+};
+
+const V1_deserializeAccessPointGroup = (
+  json: PlainObject<V1_AccessPointGroup>,
+): V1_AccessPointGroup => {
+  switch (json._type) {
+    case V1_AccessPointGrouptype.MODEL_ACCESS_POINT_GROUP:
+      return deserialize(V1_ModelAccessPointGroupModelSchema, json);
+    default: {
+      return deserialize(V1_DefaultAccessPointGroupModelSchema, json);
+    }
+  }
+};
+
+enum V1_DataProductIconType {
+  EMBEDDED_IMAGE_ICON = 'embeddedImageIcon',
+  LIBRARY_ICON = 'libraryIcon',
+}
+
+const V1_EmbeddedImageIconModelSchema = createModelSchema(
+  V1_EmbeddedImageIcon,
+  {
+    _type: usingConstantValueSchema(V1_DataProductIconType.EMBEDDED_IMAGE_ICON),
+    imageUrl: primitive(),
   },
 );
 
+const V1_LibraryIconModelSchema = createModelSchema(V1_LibraryIcon, {
+  _type: usingConstantValueSchema(V1_DataProductIconType.LIBRARY_ICON),
+  iconId: primitive(),
+  libraryId: primitive(),
+});
+
+const V1_deserializeDataProductIcon = (
+  json: PlainObject<V1_DataProductIcon>,
+): V1_DataProductIcon => {
+  switch (json._type) {
+    case V1_DataProductIconType.EMBEDDED_IMAGE_ICON:
+      return deserialize(V1_EmbeddedImageIconModelSchema, json);
+    case V1_DataProductIconType.LIBRARY_ICON:
+      return deserialize(V1_LibraryIconModelSchema, json);
+    default:
+      throw new UnsupportedOperationError(
+        `Can't deserialize data product icon type '${json._type}'`,
+      );
+  }
+};
+
+const V1_serializeDataProductIcon = (
+  protocol: V1_DataProductIcon,
+): PlainObject<V1_DataProductIcon> => {
+  if (protocol instanceof V1_EmbeddedImageIcon) {
+    return serialize(V1_EmbeddedImageIconModelSchema, protocol);
+  } else if (protocol instanceof V1_LibraryIcon) {
+    return serialize(V1_LibraryIconModelSchema, protocol);
+  }
+  throw new UnsupportedOperationError(
+    `Can't serialize data product icon type`,
+    protocol,
+  );
+};
+
 export const V1_EmailModelSchema = createModelSchema(V1_Email, {
-  title: primitive(),
   address: primitive(),
+  title: primitive(),
+});
+
+const V1_DataProductLinkModelSchema = createModelSchema(V1_DataProductLink, {
+  label: optional(primitive()),
+  url: primitive(),
 });
 
 export const V1_SupportInfoModelSchema = createModelSchema(V1_SupportInfo, {
-  documentationUrl: optional(primitive()),
-  website: optional(primitive()),
-  faqUrl: optional(primitive()),
-  supportUrl: optional(primitive()),
+  documentation: optional(usingModelSchema(V1_DataProductLinkModelSchema)),
   emails: customListWithSchema(V1_EmailModelSchema),
+  faqUrl: optional(usingModelSchema(V1_DataProductLinkModelSchema)),
+  supportUrl: optional(usingModelSchema(V1_DataProductLinkModelSchema)),
+  website: optional(usingModelSchema(V1_DataProductLinkModelSchema)),
 });
 
 export const V1_dataProductModelSchema = createModelSchema(V1_DataProduct, {
   _type: usingConstantValueSchema(V1_DATA_PRODUCT_ELEMENT_PROTOCOL_TYPE),
-  name: primitive(),
-  package: primitive(),
-  title: optional(primitive()),
+  accessPointGroups: customList(
+    V1_serializeAccessPointGroup,
+    V1_deserializeAccessPointGroup,
+  ),
+  coverageRegions: optionalCustomList(
+    (json) => (json as string).toLowerCase(),
+    (json) => (json as unknown as string).toUpperCase(),
+  ),
+
+  deliveryFrequency: optionalCustom(
+    (json) => (json as string).toLowerCase(),
+    (json) => (json as string).toUpperCase(),
+  ),
   description: optional(primitive()),
-  accessPointGroups: customListWithSchema(V1_AccessPointGroupModelSchema),
-  // TODO: replace custom deserializer with optional(primitive())
-  icon: custom(
-    () => undefined,
-    () => {
-      const randomIndex = Math.floor(Math.random() * 6);
-      switch (randomIndex) {
-        case 0:
-          return 'FaUser';
-        case 1:
-          return 'FaUserSecret';
-        case 2:
-          return 'FaDollarSign';
-        case 3:
-          return 'FaShoppingCart';
-        case 4:
-          return 'FaServer';
-        default:
-          return undefined;
-      }
-    },
+  icon: optionalCustom(
+    V1_serializeDataProductIcon,
+    V1_deserializeDataProductIcon,
   ),
-  imageUrl: optional(primitive()),
+  name: primitive(),
+  package: primitive(),
+  stereotypes: customListWithSchema(V1_stereotypePtrModelSchema),
   supportInfo: optionalCustomUsingModelSchema(V1_SupportInfoModelSchema),
+  taggedValues: customListWithSchema(V1_taggedValueModelSchema),
+  title: optional(primitive()),
 });

package/src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_EntitlementSerializationHelper.ts

@@ -16,6 +16,7 @@
 
 import {
   customListWithSchema,
+  optionalCustomListWithSchema,
   UnsupportedOperationError,
   usingConstantValueSchema,
   usingModelSchema,
@@ -42,6 +43,7 @@ import {
   V1_ContractUserStatusResponse,
   V1_LiteDataContractsResponse,
   V1_LiteDataContract,
+  V1_DataContractApprovedUsersResponse,
 } from '../../../lakehouse/entitlements/V1_ConsumerEntitlements.js';
 import {
   createModelSchema,
@@ -520,3 +522,8 @@ export const V1_entitlementsDataProductDetailsResponseToDataProductDetails = (
   );
   return response.dataProducts;
 };
+
+export const V1_DataContractApprovedUsersResponseModelSchema =
+  createModelSchema(V1_DataContractApprovedUsersResponse, {
+    approvedUsers: optionalCustomListWithSchema(V1_UserModelSchema),
+  });

package/src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_TerminalSerializationHelper.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 { createModelSchema, primitive } from 'serializr';
+import { V1_Terminal } from '../../../model/packageableElements/dataProduct/V1_Terminal.js';
+
+export const V1_TerminalModelSchema = createModelSchema(V1_Terminal, {
+  id: primitive(),
+  providerName: primitive(),
+  productName: primitive(),
+  category: primitive(),
+  vendorProfileId: primitive(),
+  modelName: primitive(),
+  description: primitive(),
+  applicationName: primitive(),
+  tieredPrice: primitive(),
+  price: primitive(),
+  totalFirmPrice: primitive(),
+});

package/src/index.ts

@@ -51,6 +51,12 @@ export {
   Measure,
   Unit,
 } from './graph/metamodel/pure/packageableElements/domain/Measure.js';
+export type {
+  TDSRowDataType,
+  TDSResultCellDataType,
+  TDSResultCellData,
+  TDSResultCellCoordinate,
+} from './graph-manager/action/execution/ExecutionResultHelper.js';
 export {
   EnumValueReference,
   EnumValueExplicitReference,
@@ -185,6 +191,10 @@ export {
   V1_LakehouseAccessPoint,
   V1_AccessPoint,
   V1_AccessPointGroup,
+  V1_DataProductIcon,
+  V1_DataProductDiagram,
+  V1_EmbeddedImageIcon,
+  V1_LibraryIcon,
 } from './graph-manager/protocol/pure/v1/model/packageableElements/dataProduct/V1_DataProduct.js';
 export {
   V1_ExecuteInput,
@@ -322,6 +332,7 @@ export {
   V1_AppDirNodeModelSchema,
   V1_ContractUserStatusResponseModelSchema,
   V1_createContractPayloadModelSchema,
+  V1_DataContractApprovedUsersResponseModelSchema,
   V1_dataContractsResponseModelSchema,
   V1_dataContractsResponseModelSchemaToContracts,
   V1_DataProductOriginType,
@@ -703,6 +714,7 @@ export {
   LakehouseTargetEnv,
   AccessPointGroup,
   AccessPoint,
+  DataProductLink,
 } from './graph/metamodel/pure/dataProduct/DataProduct.js';
 export * from './graph-manager/action/changeDetection/DataProductObserveHelper.js';
 
@@ -981,6 +993,8 @@ export { V1_DatabaseToModelGenerationInput } from './graph-manager/protocol/pure
 export { V1_RelationalConnectionBuilder } from './graph-manager/protocol/pure/v1/engine/relational/V1_RelationalConnectionBuilder.js';
 export * from './graph-manager/protocol/pure/extensions/DSL_FunctionActivator_PureProtocolProcessorPlugin_Extension.js';
 export * from './graph-manager/protocol/pure/extensions/DSL_Lakehouse_PureProtocolProcessorPlugin_Extension.js';
+export { V1_Terminal } from './graph-manager/protocol/pure/v1/model/packageableElements/dataProduct/V1_Terminal.js';
+export { V1_TerminalModelSchema } from './graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_TerminalSerializationHelper.js';
 
 // ------------------------------------- TO BE MODULARIZED --------------------------------------------
 /**

package/tsconfig.json

@@ -580,6 +580,7 @@
     "./src/graph-manager/protocol/pure/v1/model/packageableElements/connection/V1_PackageableConnection.ts",
     "./src/graph-manager/protocol/pure/v1/model/packageableElements/data/V1_DataElement.ts",
     "./src/graph-manager/protocol/pure/v1/model/packageableElements/dataProduct/V1_DataProduct.ts",
+    "./src/graph-manager/protocol/pure/v1/model/packageableElements/dataProduct/V1_Terminal.ts",
     "./src/graph-manager/protocol/pure/v1/model/packageableElements/domain/V1_Association.ts",
     "./src/graph-manager/protocol/pure/v1/model/packageableElements/domain/V1_Class.ts",
     "./src/graph-manager/protocol/pure/v1/model/packageableElements/domain/V1_Constraint.ts",
@@ -889,6 +890,7 @@
     "./src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_ServiceSerializationHelper.ts",
     "./src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_StoreSerializationHelper.ts",
     "./src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_SubscriptionSerializationHelper.ts",
+    "./src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_TerminalSerializationHelper.ts",
     "./src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_TestSerializationHelper.ts",
     "./src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_TypeSerializationHelper.ts",
     "./src/graph-manager/protocol/pure/v1/transformation/pureProtocol/serializationHelpers/V1_ValueSpecificationSerializer.ts",