@finos/legend-extension-dsl-data-product 0.0.2

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@finos/legend-extension-dsl-data-product",
+  "version": "0.0.2",
+  "description": "Legend data product viewer core",
+  "keywords": [
+    "legend",
+    "data product",
+    "viewer"
+  ],
+  "homepage": "https://github.com/finos/legend-studio/tree/master/packages/legend-extension-dsl-data-product",
+  "bugs": {
+    "url": "https://github.com/finos/legend-studio/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/finos/legend-studio.git",
+    "directory": "packages/legend-extension-dsl-data-product"
+  },
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": "./lib/index.js",
+    "./test": "./lib/__test__.js",
+    "./lib/index.css": "./lib/index.css"
+  },
+  "module": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "yarn clean && yarn build:sass && yarn build:ts",
+    "build:sass": "cross-env INIT_CWD=$INIT_CWD node ../../scripts/workflow/buildSass.js",
+    "build:ts": "tsc --project ./tsconfig.build.json",
+    "clean": "npm-run-all clean:cache clean:lib",
+    "clean:cache": "rimraf \"build\"",
+    "clean:lib": "rimraf \"lib\"",
+    "dev": "npm-run-all --parallel dev:sass dev:ts",
+    "dev:sass": "sass style:lib --watch --load-path=../../node_modules/@finos/legend-art/scss",
+    "dev:ts": "tsc --watch --preserveWatchOutput",
+    "lint:js": "cross-env NODE_ENV=production eslint --cache --cache-location ./build/.eslintcache --report-unused-disable-directives --parser-options=project:\"./tsconfig.json\" \"./src/**/*.{js,ts,tsx}\"",
+    "publish:prepare": "node ../../scripts/release/preparePublishContent.js",
+    "publish:snapshot": "node ../../scripts/release/publishDevSnapshot.js",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@finos/legend-application": "16.0.70",
+    "@finos/legend-art": "7.1.123",
+    "@finos/legend-code-editor": "2.0.118",
+    "@finos/legend-graph": "32.2.8",
+    "@finos/legend-lego": "2.0.129",
+    "@finos/legend-server-depot": "6.1.1",
+    "@finos/legend-server-lakehouse": "0.2.8",
+    "@finos/legend-server-marketplace": "0.1.8",
+    "@finos/legend-shared": "11.0.20",
+    "@finos/legend-storage": "3.0.139",
+    "@mui/lab": "6.0.1-beta.34",
+    "@mui/material": "6.4.7",
+    "@testing-library/dom": "10.4.0",
+    "@testing-library/react": "16.2.0",
+    "@types/react": "19.0.10",
+    "@types/react-dom": "19.0.4",
+    "dompurify": "3.2.5",
+    "mobx": "6.13.6",
+    "mobx-react-lite": "4.1.0",
+    "mobx-utils": "6.1.0",
+    "node-diff3": "3.1.2",
+    "oidc-client-ts": "^3.2.0",
+    "react": "19.0.0",
+    "react-dnd": "16.0.1",
+    "react-dom": "19.0.0",
+    "react-oidc-context": "^3.3.0",
+    "serializr": "3.0.3",
+    "yaml": "2.7.0"
+  },
+  "devDependencies": {
+    "@finos/legend-dev-utils": "2.2.5",
+    "@jest/globals": "29.7.0",
+    "cross-env": "7.0.3",
+    "eslint": "9.20.1",
+    "jest": "29.7.0",
+    "npm-run-all": "4.1.5",
+    "rimraf": "6.0.1",
+    "sass": "1.85.0",
+    "typescript": "5.7.3"
+  },
+  "peerDependencies": {
+    "react": "^19.0.0"
+  },
+  "publishConfig": {
+    "directory": "build/publishContent"
+  },
+  "extensions": {
+    "dataProductDataAccessApplicationPlugin": "@finos/legend-application-plugin-dsl-data-product-data-access"
+  }
+}

package/src/__lib__/DSL_DataProduct_Event.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+export enum DSL_DATAPRODUCT_EVENT {
+  FETCH_INGEST_ENV_FAILURE = 'dataProduct.access.ingest-env.failure',
+}

package/src/components/Core_DataProductDataAccess_LegendApplicationPlugin.tsx

@@ -0,0 +1,233 @@
+/**
+ * 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 packageJson from '../../package.json' with { type: 'json' };
+import {
+  type V1_OrganizationalScope,
+  V1_UserType,
+  V1_AdhocTeam,
+  V1_User,
+} from '@finos/legend-graph';
+import { LegendUser } from '@finos/legend-shared';
+import { useEffect, useState, type ChangeEvent } from 'react';
+import {
+  type DataProductAPGState,
+  AccessPointGroupAccess,
+} from '../stores/DataProduct/DataProductAPGState.js';
+import type { ContractConsumerTypeRendererConfig } from '../stores/DataProduct/DataProductDataAccessState.js';
+import type { DataProductDataAccess_LegendApplicationPlugin_Extension } from '../stores/DataProductDataAccess_LegendApplicationPlugin_Extension.js';
+import { UserSearchInput } from '@finos/legend-art';
+import { TextField } from '@mui/material';
+import {
+  type LegendApplicationPluginManager,
+  LegendApplicationPlugin,
+} from '@finos/legend-application';
+
+export class Core_DataProductDataAccess_LegendApplicationPlugin
+  extends LegendApplicationPlugin
+  implements DataProductDataAccess_LegendApplicationPlugin_Extension
+{
+  static NAME = packageJson.extensions.dataProductDataAccessApplicationPlugin;
+
+  constructor() {
+    super(
+      Core_DataProductDataAccess_LegendApplicationPlugin.NAME,
+      packageJson.version,
+    );
+  }
+
+  install(
+    pluginManager: LegendApplicationPluginManager<LegendApplicationPlugin>,
+  ): void {
+    pluginManager.registerApplicationPlugin(this);
+  }
+
+  getContractConsumerTypeRendererConfigs(): ContractConsumerTypeRendererConfig[] {
+    const buildAdhocUser = (
+      userName: string,
+      type?: V1_UserType,
+    ): V1_AdhocTeam => {
+      const _user = new V1_User();
+      _user.name = userName;
+      _user.userType = type ?? V1_UserType.WORKFORCE_USER;
+      const _adhocTeam = new V1_AdhocTeam();
+      _adhocTeam.users = [_user];
+      return _adhocTeam;
+    };
+
+    const CommonRenderer = (props: {
+      type: 'user' | 'system-account';
+      label: string;
+      apgState: DataProductAPGState;
+      handleOrganizationalScopeChange: (
+        consumer: V1_OrganizationalScope,
+      ) => void;
+      handleDescriptionChange: (description: string | undefined) => void;
+      handleIsValidChange: (isValid: boolean) => void;
+      enableUserSearch: boolean;
+    }): React.ReactElement => {
+      const {
+        type,
+        label,
+        apgState,
+        handleOrganizationalScopeChange,
+        handleDescriptionChange,
+        handleIsValidChange,
+        enableUserSearch,
+      } = props;
+      const [description, setDescription] = useState<string>('');
+      const [user, setUser] = useState<LegendUser>(new LegendUser());
+      const [loadingCurrentUser, setLoadingCurrentUser] = useState(false);
+
+      // Update parent state whenever local state changes
+      useEffect(() => {
+        handleOrganizationalScopeChange(
+          buildAdhocUser(
+            user.id,
+            type === 'system-account'
+              ? V1_UserType.SYSTEM_ACCOUNT
+              : V1_UserType.WORKFORCE_USER,
+          ),
+        );
+        handleDescriptionChange(description);
+        handleIsValidChange(user.id !== '' && description.trim() !== '');
+      }, [
+        type,
+        user,
+        description,
+        handleOrganizationalScopeChange,
+        handleDescriptionChange,
+        handleIsValidChange,
+      ]);
+
+      useEffect(() => {
+        const fetchCurrentUser = async () => {
+          if (apgState.dataProductViewerState.userSearchService) {
+            setLoadingCurrentUser(true);
+            try {
+              const currentUser =
+                await apgState.dataProductViewerState.userSearchService.getOrFetchUser(
+                  apgState.applicationStore.identityService.currentUser,
+                );
+              if (currentUser instanceof LegendUser) {
+                setUser(currentUser);
+              }
+            } finally {
+              setLoadingCurrentUser(false);
+            }
+          }
+        };
+        // We should only fetch the current user if the current user is not already entitled.
+        // If the current user is already entitled, we can assume they are requesting access for another user or system account.
+        if (apgState.access === AccessPointGroupAccess.NO_ACCESS) {
+          // eslint-disable-next-line no-void
+          void fetchCurrentUser();
+        }
+      }, [
+        apgState.access,
+        apgState.applicationStore.identityService.currentUser,
+        apgState.dataProductViewerState.userSearchService,
+      ]);
+
+      return (
+        <>
+          {apgState.access === AccessPointGroupAccess.ENTERPRISE && (
+            <p className="marketplace-lakehouse-entitlements__data-contract-creator__enterprise-apg-notice">
+              Note: Enterprise APGs only require contracts for System Accounts.
+              Regular users do not need to request access.
+            </p>
+          )}
+          <UserSearchInput
+            className="marketplace-lakehouse-entitlements__data-contract-creator__user-input"
+            key={label}
+            userValue={user}
+            setUserValue={(_user: LegendUser): void => setUser(_user)}
+            userSearchService={
+              enableUserSearch
+                ? apgState.dataProductViewerState.userSearchService
+                : undefined
+            }
+            label={label}
+            required={true}
+            variant="outlined"
+            fullWidth={true}
+            initializing={loadingCurrentUser}
+          />
+          <TextField
+            className="marketplace-lakehouse-entitlements__data-contract-creator__business-justification-input"
+            required={true}
+            name="business-justification"
+            label="Business Justification"
+            variant="outlined"
+            fullWidth={true}
+            value={description}
+            onChange={(event: ChangeEvent<HTMLInputElement>) =>
+              setDescription(event.target.value)
+            }
+          />
+        </>
+      );
+    };
+
+    return [
+      {
+        type: 'User',
+        createContractRenderer: (
+          apgState: DataProductAPGState,
+          handleOrganizationalScopeChange: (
+            consumer: V1_OrganizationalScope,
+          ) => void,
+          handleDescriptionChange: (description: string | undefined) => void,
+          handleIsValidChange: (isValid: boolean) => void,
+        ) => (
+          <CommonRenderer
+            key="user"
+            type="user"
+            label="User"
+            apgState={apgState}
+            handleOrganizationalScopeChange={handleOrganizationalScopeChange}
+            handleDescriptionChange={handleDescriptionChange}
+            handleIsValidChange={handleIsValidChange}
+            enableUserSearch={true}
+          />
+        ),
+      },
+      {
+        type: 'System Account',
+        enableForEnterpriseAPGs: true,
+        createContractRenderer: (
+          apgState: DataProductAPGState,
+          handleOrganizationalScopeChange: (
+            consumer: V1_OrganizationalScope,
+          ) => void,
+          handleDescriptionChange: (description: string | undefined) => void,
+          handleIsValidChange: (isValid: boolean) => void,
+        ) => (
+          <CommonRenderer
+            key="system-account"
+            type="system-account"
+            label="System Account"
+            apgState={apgState}
+            handleOrganizationalScopeChange={handleOrganizationalScopeChange}
+            handleDescriptionChange={handleDescriptionChange}
+            handleIsValidChange={handleIsValidChange}
+            enableUserSearch={false}
+          />
+        ),
+      },
+    ];
+  }
+}

package/src/components/DataProduct/DataContract/EntitlementsDataContractCreator.tsx

@@ -0,0 +1,182 @@
+/**
+ * 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 {
+  ELEMENT_PATH_DELIMITER,
+  type V1_OrganizationalScope,
+} from '@finos/legend-graph';
+import { observer } from 'mobx-react-lite';
+import { useMemo, useState } from 'react';
+import { flowResult } from 'mobx';
+import {
+  Button,
+  ButtonGroup,
+  Dialog,
+  DialogActions,
+  DialogContent,
+  DialogTitle,
+} from '@mui/material';
+import {
+  CubesLoadingIndicator,
+  CubesLoadingIndicatorIcon,
+} from '@finos/legend-art';
+import { guaranteeNonNullable, isNonNullable } from '@finos/legend-shared';
+import type {
+  ContractConsumerTypeRendererConfig,
+  DataProductDataAccessState,
+} from '../../../stores/DataProduct/DataProductDataAccessState.js';
+import {
+  AccessPointGroupAccess,
+  type DataProductAPGState,
+} from '../../../stores/DataProduct/DataProductAPGState.js';
+
+export const EntitlementsDataContractCreator = observer(
+  (props: {
+    open: boolean;
+    onClose: () => void;
+    token: string | undefined;
+    apgState: DataProductAPGState;
+    dataAccessState: DataProductDataAccessState;
+  }) => {
+    const { open, onClose, token, apgState, dataAccessState } = props;
+    const viewerState = dataAccessState.dataProductViewerState;
+    const accessPointGroup = guaranteeNonNullable(
+      dataAccessState.dataContractAccessPointGroup,
+      'Cannot show DataContractCreator. No access point group is selected.',
+    );
+    const consumerTypeRendererConfigs: ContractConsumerTypeRendererConfig[] =
+      useMemo(
+        () =>
+          dataAccessState.dataAccessPlugins
+            .map((plugin) => plugin.getContractConsumerTypeRendererConfigs?.())
+            .flat()
+            .filter(isNonNullable)
+            .filter(
+              (rendererConfig: ContractConsumerTypeRendererConfig) =>
+                apgState.access !== AccessPointGroupAccess.ENTERPRISE ||
+                rendererConfig.enableForEnterpriseAPGs,
+            ),
+        [apgState.access, dataAccessState.dataAccessPlugins],
+      );
+    const [selectedConsumerType, setSelectedConsumerType] = useState<string>(
+      consumerTypeRendererConfigs[0]?.type ?? '',
+    );
+    const [consumer, setConsumer] = useState<
+      V1_OrganizationalScope | undefined
+    >();
+    const [description, setDescription] = useState<string | undefined>();
+    const [isValid, setIsValid] = useState<boolean>(false);
+
+    const currentConsumerTypeComponent = useMemo(
+      () =>
+        consumerTypeRendererConfigs
+          .find((config) => config.type === selectedConsumerType)
+          ?.createContractRenderer(
+            apgState,
+            setConsumer,
+            setDescription,
+            setIsValid,
+          ),
+      [apgState, consumerTypeRendererConfigs, selectedConsumerType],
+    );
+
+    const onCreate = (): void => {
+      if (isValid && consumer && description) {
+        flowResult(
+          dataAccessState.createContract(
+            consumer,
+            description,
+            accessPointGroup,
+            token,
+          ),
+        ).catch(viewerState.applicationStore.alertUnhandledError);
+      }
+    };
+
+    const dataProductTitle =
+      viewerState.product.title ??
+      viewerState.product.path.split(ELEMENT_PATH_DELIMITER).pop();
+
+    return (
+      <Dialog open={open} onClose={onClose} fullWidth={true} maxWidth="md">
+        <DialogTitle>Data Contract Request</DialogTitle>
+        <DialogContent className="marketplace-lakehouse-entitlements__data-contract-creator__content">
+          <CubesLoadingIndicator
+            isLoading={dataAccessState.creatingContractState.isInProgress}
+          >
+            <CubesLoadingIndicatorIcon />
+          </CubesLoadingIndicator>
+          {!dataAccessState.creatingContractState.isInProgress && (
+            <>
+              <div>
+                Submit access request for{' '}
+                <span className="marketplace-lakehouse-text__emphasis">
+                  {accessPointGroup.id}
+                </span>{' '}
+                Access Point Group in{' '}
+                <span className="marketplace-lakehouse-text__emphasis">
+                  {dataProductTitle}
+                </span>{' '}
+                Data Product
+              </div>
+              <ButtonGroup
+                className="marketplace-lakehouse-entitlements__data-contract-creator__consumer-type-btn-group"
+                variant="contained"
+              >
+                {consumerTypeRendererConfigs.map((config) => (
+                  <Button
+                    key={config.type}
+                    variant={
+                      selectedConsumerType === config.type
+                        ? 'contained'
+                        : 'outlined'
+                    }
+                    onClick={(): void => {
+                      if (config.type !== selectedConsumerType) {
+                        setSelectedConsumerType(config.type);
+                      }
+                    }}
+                  >
+                    {config.type}
+                  </Button>
+                ))}
+              </ButtonGroup>
+              {currentConsumerTypeComponent}
+            </>
+          )}
+        </DialogContent>
+        <DialogActions>
+          <Button
+            onClick={onCreate}
+            variant="contained"
+            disabled={
+              dataAccessState.creatingContractState.isInProgress || !isValid
+            }
+          >
+            Create
+          </Button>
+          <Button
+            onClick={onClose}
+            variant="outlined"
+            disabled={dataAccessState.creatingContractState.isInProgress}
+          >
+            Cancel
+          </Button>
+        </DialogActions>
+      </Dialog>
+    );
+  },
+);