@finos/legend-extension-dsl-data-space-studio 0.1.337 → 0.1.339

package/src/components/DataSpaceEditor.tsx

@@ -14,35 +14,14 @@
  * limitations under the License.
  */
 
-import { useState } from 'react';
 import { observer } from 'mobx-react-lite';
 import { useEditorStore } from '@finos/legend-application-studio';
-import {
-  EyeIcon,
-  WandIcon,
-  Panel,
-  PanelContent,
-  PanelHeader,
-  Dialog,
-  Modal,
-  ModalHeader,
-  ModalBody,
-  ModalFooter,
-  ModalFooterButton,
-  CustomSelectorInput,
-} from '@finos/legend-art';
-import {
-  DataSpaceEditorState,
-  onConvertDataSpaceToDataProduct,
-  onMergeDataSpaceToDataProduct,
-} from '../stores/DataSpaceEditorState.js';
+import { EyeIcon, Panel, PanelContent, PanelHeader } from '@finos/legend-art';
+import { DataSpaceEditorState } from '../stores/DataSpaceEditorState.js';
 import { DataSpaceGeneralEditor } from './DataSpaceGeneralEditor/DataSpaceGeneralEditor.js';
 import { DataSpacePreviewState } from '../stores/DataSpacePreviewState.js';
 import { flowResult } from 'mobx';
-import {
-  isStubbed_PackageableElement,
-  type DataProduct,
-} from '@finos/legend-graph';
+import { isStubbed_PackageableElement } from '@finos/legend-graph';
 import { DSL_DATA_SPACE_LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY } from '../__lib__/DSL_DataSpace_LegendStudioDocumentation.js';
 import { useApplicationNavigationContext } from '@finos/legend-application';
 
@@ -78,71 +57,6 @@ export const DataSpaceEditor = observer(() => {
     ).catch(editorStore.applicationStore.alertUnhandledError);
   };
 
-  const convertDataSpace = (): void => {
-    flowResult(
-      onConvertDataSpaceToDataProduct(dataSpace, editorStore, dataSpaceState),
-    ).catch(editorStore.applicationStore.alertUnhandledError);
-  };
-
-  const eligibleMergeTargets =
-    editorStore.graphManagerState.graph.ownDataProducts.filter(
-      (dp) => dp.nativeModelAccess === undefined,
-    );
-
-  const mergeDataSpace = (targetDataProduct: DataProduct): void => {
-    flowResult(
-      onMergeDataSpaceToDataProduct(
-        dataSpace,
-        targetDataProduct,
-        editorStore,
-        dataSpaceState,
-      ),
-    ).catch(editorStore.applicationStore.alertUnhandledError);
-  };
-
-  const [showConvertModal, setShowConvertModal] = useState(false);
-
-  const modeOptions: { label: string; value: string }[] = [
-    { label: 'Merge', value: 'merge' },
-    { label: 'Create', value: 'create' },
-  ];
-
-  const [selectedMode, setSelectedMode] = useState<{
-    label: string;
-    value: string;
-  } | null>(modeOptions[0] ?? null);
-
-  const mergeTargetOptions = eligibleMergeTargets.map((dp) => ({
-    label: dp.path,
-    value: dp,
-  }));
-
-  const [selectedMergeTarget, setSelectedMergeTarget] = useState<{
-    label: string;
-    value: DataProduct;
-  } | null>(mergeTargetOptions[0] ?? null);
-
-  const onConvertButtonClick = (): void => {
-    if (eligibleMergeTargets.length === 0) {
-      convertDataSpace();
-      return;
-    }
-    setSelectedMode(modeOptions[0] ?? null);
-    setSelectedMergeTarget(mergeTargetOptions[0] ?? null);
-    setShowConvertModal(true);
-  };
-
-  const closeConvertModal = (): void => setShowConvertModal(false);
-
-  const handleConvertConfirm = (): void => {
-    closeConvertModal();
-    if (selectedMode?.value === 'merge' && selectedMergeTarget) {
-      mergeDataSpace(selectedMergeTarget.value);
-    } else {
-      convertDataSpace();
-    }
-  };
-
   useApplicationNavigationContext(
     DSL_DATA_SPACE_LEGEND_STUDIO_APPLICATION_NAVIGATION_CONTEXT_KEY.DATA_SPACE_EDITOR,
   );
@@ -157,20 +71,6 @@ export const DataSpaceEditor = observer(() => {
       />
       <PanelHeader title="General" darkMode={true}>
         <div className="panel__header__actions">
-          <div className="btn__dropdown-combo btn__dropdown-combo--primary">
-            <button
-              className="btn__dropdown-combo__label"
-              onClick={onConvertButtonClick}
-              title="Convert to Data Product"
-              tabIndex={-1}
-              style={{ width: 'auto', whiteSpace: 'nowrap' }}
-            >
-              <WandIcon className="btn__dropdown-combo__label__icon" />
-              <div className="btn__dropdown-combo__label__title">
-                Convert to DataProduct
-              </div>
-            </button>
-          </div>
           <div className="btn__dropdown-combo btn__dropdown-combo--primary">
             <button
               className="btn__dropdown-combo__label"
@@ -186,61 +86,6 @@ export const DataSpaceEditor = observer(() => {
         </div>
       </PanelHeader>
 
-      <Dialog open={showConvertModal} onClose={closeConvertModal}>
-        <Modal darkMode={true}>
-          <ModalHeader title="Convert to Data Product" />
-          <ModalBody>
-            <div className="panel__content__form__section">
-              <div className="panel__content__form__section__header__label">
-                Mode
-              </div>
-              <CustomSelectorInput
-                options={modeOptions}
-                onChange={(val: { label: string; value: string } | null) => {
-                  if (val) {
-                    setSelectedMode(val);
-                    if (val.value === 'merge') {
-                      setSelectedMergeTarget(mergeTargetOptions[0] ?? null);
-                    }
-                  }
-                }}
-                value={selectedMode}
-                darkMode={true}
-              />
-            </div>
-            {selectedMode?.value === 'merge' && (
-              <div className="panel__content__form__section">
-                <div className="panel__content__form__section__header__label">
-                  Target Data Product
-                </div>
-                <CustomSelectorInput
-                  options={mergeTargetOptions}
-                  onChange={(
-                    val: { label: string; value: DataProduct } | null,
-                  ) => {
-                    setSelectedMergeTarget(val);
-                  }}
-                  value={selectedMergeTarget}
-                  darkMode={true}
-                />
-              </div>
-            )}
-          </ModalBody>
-          <ModalFooter>
-            <ModalFooterButton
-              text="Cancel"
-              onClick={closeConvertModal}
-              type="secondary"
-            />
-            <ModalFooterButton
-              text={selectedMode?.value === 'merge' ? 'Merge' : 'Create'}
-              onClick={handleConvertConfirm}
-              disabled={selectedMode?.value === 'merge' && !selectedMergeTarget}
-            />
-          </ModalFooter>
-        </Modal>
-      </Dialog>
-
       <PanelContent>
         <DataSpaceGeneralEditor />
       </PanelContent>

package/src/components/DataSpaceGeneralEditor/DataSpaceGeneralEditor.tsx

@@ -14,13 +14,27 @@
  * limitations under the License.
  */
 
-import { useEditorStore } from '@finos/legend-application-studio';
 import {
+  useEditorStore,
+  LEGEND_STUDIO_DOCUMENTATION_KEY,
+  LegendStudioTelemetryHelper,
+  type DSL_DataSpace_LegendStudioApplicationPlugin_Extension,
+} from '@finos/legend-application-studio';
+import {
+  clsx,
   PanelContentLists,
   PanelForm,
   PanelFormTextField,
+  PanelLoadingIndicator,
+  SparkleIcon,
 } from '@finos/legend-art';
 import { observer } from 'mobx-react-lite';
+import { useState } from 'react';
+import {
+  assertErrorThrown,
+  HttpStatus,
+  NetworkClientError,
+} from '@finos/legend-shared';
 import { DataSpaceEditorState } from '../../stores/DataSpaceEditorState.js';
 import {
   dataSpace_setDescription,
@@ -38,6 +52,7 @@ export const DataSpaceGeneralEditor = observer(() => {
   const dataSpaceState =
     editorStore.tabManagerState.getCurrentEditorState(DataSpaceEditorState);
   const dataSpace = dataSpaceState.dataSpace;
+  const isReadOnly = dataSpaceState.isReadOnly;
 
   // Basic properties handlers
   const handleTitleChange = (value: string | undefined): void => {
@@ -48,6 +63,86 @@ export const DataSpaceGeneralEditor = observer(() => {
     dataSpace_setDescription(dataSpace, value);
   };
 
+  // AI documentation suggestion
+  const legendAIUrl = editorStore.applicationStore.config.legendAIUrl;
+  const aiDocSuggester = legendAIUrl
+    ? editorStore.pluginManager
+        .getApplicationPlugins()
+        .map((p) =>
+          (
+            p as DSL_DataSpace_LegendStudioApplicationPlugin_Extension
+          ).getExtraDataSpaceDocumentationAISuggester?.bind(p),
+        )
+        .find(Boolean)
+    : undefined;
+  const [isSuggestingWithAI, setIsSuggestingWithAI] = useState(false);
+  const [aiDocSuggestion, setAIDocSuggestion] = useState<string | undefined>(
+    undefined,
+  );
+  const suggestDocumentationWithAI = async (): Promise<void> => {
+    if (!aiDocSuggester || !legendAIUrl) {
+      return;
+    }
+    LegendStudioTelemetryHelper.logEvent_DataSpaceLegendAISuggestLaunched(
+      editorStore.applicationStore.telemetryService,
+      dataSpace.path,
+    );
+    setIsSuggestingWithAI(true);
+    setAIDocSuggestion(undefined);
+    try {
+      const definitions =
+        await editorStore.graphManagerState.graphManager.graphToPureCode(
+          editorStore.graphManagerState.graph,
+        );
+      const suggestion = await aiDocSuggester(
+        { definitions, data_space_name: dataSpace.path },
+        legendAIUrl,
+      );
+      setAIDocSuggestion(suggestion.description);
+    } catch (error) {
+      assertErrorThrown(error);
+      LegendStudioTelemetryHelper.logEvent_DataSpaceLegendAISuggestFailure(
+        editorStore.applicationStore.telemetryService,
+        dataSpace.path,
+        error.message,
+      );
+      if (
+        error instanceof NetworkClientError &&
+        (error.response.status === HttpStatus.UNAUTHORIZED ||
+          error.response.status === HttpStatus.FORBIDDEN)
+      ) {
+        const docEntry =
+          editorStore.applicationStore.documentationService.getDocEntry(
+            LEGEND_STUDIO_DOCUMENTATION_KEY.LEGENDAI_HOW_TO_GET_ENTITLEMENTS,
+          );
+        if (docEntry?.url) {
+          error.message = `${error.message}. Please check how to get entitlements: ${docEntry.url}`;
+        }
+      }
+      throw error;
+    } finally {
+      setIsSuggestingWithAI(false);
+    }
+  };
+  const applyAIDocSuggestion = (): void => {
+    if (!aiDocSuggestion) {
+      return;
+    }
+    LegendStudioTelemetryHelper.logEvent_DataSpaceLegendAISuggestApplied(
+      editorStore.applicationStore.telemetryService,
+      dataSpace.path,
+    );
+    dataSpace_setDescription(dataSpace, aiDocSuggestion);
+    setAIDocSuggestion(undefined);
+  };
+  const discardAIDocSuggestion = (): void => {
+    LegendStudioTelemetryHelper.logEvent_DataSpaceLegendAISuggestDiscarded(
+      editorStore.applicationStore.telemetryService,
+      dataSpace.path,
+    );
+    setAIDocSuggestion(undefined);
+  };
+
   return (
     <PanelContentLists className="dataSpace-editor__general">
       <PanelForm>
@@ -58,13 +153,73 @@ export const DataSpaceGeneralEditor = observer(() => {
           update={handleTitleChange}
           placeholder="Enter title"
         />
-        <PanelFormTextField
-          name="Description"
-          value={dataSpace.description ?? ''}
-          prompt="Provide a description for this Data Product."
-          update={handleDescriptionChange}
-          placeholder="Enter description"
-        />
+        <div className="panel__content__form__section">
+          <div className="panel__content__form__section__header__label">
+            Description
+            {aiDocSuggestion && (
+              <span
+                className="dataSpace-editor__ai-suggestion-badge"
+                style={{ marginLeft: '0.8rem' }}
+              >
+                <SparkleIcon />
+                AI Suggestion
+              </span>
+            )}
+            {aiDocSuggester && !aiDocSuggestion && (
+              <button
+                className="dataSpace-editor__ai-suggest-btn"
+                style={{ marginLeft: '0.8rem' }}
+                onClick={(): void => {
+                  suggestDocumentationWithAI().catch(
+                    editorStore.applicationStore.alertUnhandledError,
+                  );
+                }}
+                disabled={isSuggestingWithAI || isReadOnly}
+                title="Use AI to suggest a description for this data product"
+              >
+                <SparkleIcon />
+                <span>
+                  {isSuggestingWithAI ? 'Suggesting...' : 'Suggest with AI'}
+                </span>
+              </button>
+            )}
+          </div>
+          <div className="panel__content__form__section__header__prompt">
+            Provide a description for this Data Product.
+          </div>
+          <PanelLoadingIndicator isLoading={isSuggestingWithAI} />
+          <textarea
+            className={clsx('panel__content__form__section__textarea', {
+              'textarea--ai-suggested': Boolean(aiDocSuggestion),
+            })}
+            spellCheck={false}
+            disabled={isReadOnly}
+            readOnly={Boolean(aiDocSuggestion)}
+            value={aiDocSuggestion ?? dataSpace.description ?? ''}
+            onChange={(event) => {
+              handleDescriptionChange(event.target.value);
+            }}
+            placeholder="Enter description"
+          />
+          {aiDocSuggestion && (
+            <div className="dataSpace-editor__ai-suggestion__actions">
+              <button
+                className="btn btn--dark dataSpace-editor__ai-suggestion__apply-btn"
+                onClick={applyAIDocSuggestion}
+                title="Apply AI suggestion to description"
+              >
+                Apply Suggestion
+              </button>
+              <button
+                className="btn dataSpace-editor__ai-suggestion__dismiss-btn"
+                onClick={discardAIDocSuggestion}
+                title="Dismiss AI suggestion"
+              >
+                Dismiss
+              </button>
+            </div>
+          )}
+        </div>
         <DataSpaceDefaultExecutionContextSection />
         <DataSpaceDiagramsSection />
         <DataSpaceElementsSection />

package/src/stores/DataSpaceEditorState.ts

@@ -14,21 +14,12 @@
  * limitations under the License.
  */
 
-import {
-  action,
-  computed,
-  flow,
-  flowResult,
-  makeObservable,
-  observable,
-} from 'mobx';
+import { action, computed, makeObservable, observable } from 'mobx';
 import {
   type EditorStore,
-  DataProductEditorState,
   ElementEditorState,
 } from '@finos/legend-application-studio';
 import {
-  type DataProduct,
   type PackageableElement,
   Package,
   Class,
@@ -36,7 +27,6 @@ import {
   Association,
   Service,
   ConcreteFunctionDefinition,
-  observe_DataProduct,
 } from '@finos/legend-graph';
 import { Diagram } from '@finos/legend-extension-dsl-diagram/graph';
 import {
@@ -44,113 +34,8 @@ import {
   DataSpacePackageableElementExecutable,
   type DataSpaceElement,
 } from '@finos/legend-extension-dsl-data-space/graph';
-import {
-  assertErrorThrown,
-  guaranteeType,
-  type GeneratorFn,
-} from '@finos/legend-shared';
+import { guaranteeType } from '@finos/legend-shared';
 import { DataSpaceExecutionContextState } from './DataSpaceExecutionContextState.js';
-import {
-  convertDataSpaceToDataProduct,
-  convertDataSpaceToNativeModelAccess,
-} from '../stores/DataSpaceToDataProductConverter.js';
-import { DSL_DATA_SPACE_LEGEND_STUDIO_APPLICATION_LOGGING_CONTEXT_KEY } from '../__lib__/DSL_DataSpace_LegendStudioDocumentation.js';
-
-export const onMergeDataSpaceToDataProduct = flow(function* (
-  dataSpace: DataSpace,
-  targetDataProduct: DataProduct,
-  editorStore: EditorStore,
-  dataSpaceEditorState: DataSpaceEditorState,
-): GeneratorFn<void> {
-  try {
-    targetDataProduct.nativeModelAccess =
-      convertDataSpaceToNativeModelAccess(dataSpace);
-
-    editorStore.graphManagerState.graph.deleteElement(dataSpace);
-
-    const dataSpacePackage = dataSpace.package;
-    if (dataSpacePackage && dataSpacePackage.children.length === 0) {
-      editorStore.graphManagerState.graph.deleteElement(dataSpacePackage);
-    }
-
-    const dataProductEditorState = new DataProductEditorState(
-      editorStore,
-      targetDataProduct,
-    );
-
-    editorStore.tabManagerState.closeTab(dataSpaceEditorState);
-    editorStore.tabManagerState.openTab(dataProductEditorState);
-    yield flowResult(editorStore.explorerTreeState.build());
-
-    editorStore.applicationStore.notificationService.notifySuccess(
-      `Successfully merged DataSpace ${dataSpace.name} into Data Product ${targetDataProduct.path}`,
-    );
-  } catch (error) {
-    assertErrorThrown(error);
-    editorStore.applicationStore.notificationService.notifyError(
-      `Failed to merge DataSpace into Data Product: ${error.message}`,
-    );
-  }
-});
-
-export const onConvertDataSpaceToDataProduct = flow(function* (
-  dataSpace: DataSpace,
-  editorStore: EditorStore,
-  dataSpaceEditorState: DataSpaceEditorState,
-): GeneratorFn<void> {
-  try {
-    const dataProduct = convertDataSpaceToDataProduct(
-      dataSpace,
-      editorStore.changeDetectionState.observerContext,
-    );
-
-    editorStore.graphManagerState.graph.deleteElement(dataSpace);
-
-    editorStore.graphManagerState.graph.addElement(
-      dataProduct,
-      dataSpace.package?.path.replace(/dataspace/, 'dataProduct'),
-    );
-
-    const dataSpacePackage = dataSpace.package;
-    if (dataSpacePackage && dataSpacePackage.children.length === 0) {
-      editorStore.graphManagerState.graph.deleteElement(dataSpacePackage);
-    }
-    const addedElement = editorStore.graphManagerState.graph.getNullableElement(
-      dataProduct.path,
-    );
-    if (addedElement) {
-      observe_DataProduct(
-        addedElement as DataProduct,
-        editorStore.changeDetectionState.observerContext,
-      );
-    }
-    const dataProductEditorState = new DataProductEditorState(
-      editorStore,
-      addedElement as DataProduct,
-    );
-
-    editorStore.tabManagerState.closeTab(dataSpaceEditorState);
-    editorStore.tabManagerState.openTab(dataProductEditorState);
-    yield flowResult(editorStore.explorerTreeState.build());
-    editorStore.applicationStore.telemetryService.logEvent(
-      DSL_DATA_SPACE_LEGEND_STUDIO_APPLICATION_LOGGING_CONTEXT_KEY.CONVERT_DATA_SPACE_TO_DATA_PRODUCT,
-      {
-        sourceInfo: editorStore.editorMode.getSourceInfo(),
-        dataSpacePath: dataSpace.path,
-        dataProductPath: dataProduct.path,
-      },
-    );
-
-    editorStore.applicationStore.notificationService.notifySuccess(
-      `Successfully converted DataSpace ${dataSpace.name} to Data Product`,
-    );
-  } catch (error) {
-    assertErrorThrown(error);
-    editorStore.applicationStore.notificationService.notifyError(
-      `Failed to convert DataSpace to Data Product: ${error.message}`,
-    );
-  }
-});
 
 export class DataSpaceEditorState extends ElementEditorState {
   executionContextState: DataSpaceExecutionContextState;

package/tsconfig.json

@@ -58,7 +58,6 @@
     "./src/stores/DataSpaceExecutionContextState.ts",
     "./src/stores/DataSpacePreviewState.ts",
     "./src/stores/DataSpaceTemplateQueryPromotionReviewerStore.ts",
-    "./src/stores/DataSpaceToDataProductConverter.ts",
     "./src/stores/studio/DSL_DataSpace_GraphModifierHelper.ts",
     "./src/components/DSL_DataProduct_ElementDriver.tsx",
     "./src/components/DSL_DataSpace_LegendStudioApplicationPlugin.tsx",

package/lib/stores/DataSpaceToDataProductConverter.d.ts

@@ -1,29 +0,0 @@
-/**
- * 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 DataSpace } from '@finos/legend-extension-dsl-data-space/graph';
-import { DataProduct, NativeModelAccess, ObserverContext } from '@finos/legend-graph';
-export declare enum DATA_PRODUCT_SUPPORT_TYPE {
-    DOCUMENTATION = "Documentation",
-    SUPPORT = "Support",
-    WEBSITE = "Website",
-    FAQ = "FAQ"
-}
-export declare const DATA_PRODUCT_DEFAULT_TITLE = "DataProduct Auto Generated title: Please update";
-export declare const DATA_PRODUCT_DEFAULT_DESCRIPTION_PREFIX = "Migrated using studio converter from dataspace: ";
-export declare const DATA_PRODUCT_NATIVE_MODEL_ACCESS_SAMPLE_QUERY_ID_PREFIX = "DATA_PRODUCT_NATIVE_MODEL_ACCESS_SAMPLE_QUERY_ID";
-export declare const convertDataSpaceToNativeModelAccess: (dataSpace: DataSpace) => NativeModelAccess;
-export declare const convertDataSpaceToDataProduct: (dataSpace: DataSpace, observerContext?: ObserverContext) => DataProduct;
-//# sourceMappingURL=DataSpaceToDataProductConverter.d.ts.map

package/lib/stores/DataSpaceToDataProductConverter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DataSpaceToDataProductConverter.d.ts","sourceRoot":"","sources":["../../src/stores/DataSpaceToDataProductConverter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,KAAK,SAAS,EAKf,MAAM,8CAA8C,CAAC;AACtD,OAAO,EACL,WAAW,EAUX,iBAAiB,EAGjB,eAAe,EAChB,MAAM,qBAAqB,CAAC;AAM7B,oBAAY,yBAAyB;IACnC,aAAa,kBAAkB;IAC/B,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,GAAG,QAAQ;CACZ;AAED,eAAO,MAAM,0BAA0B,oDACY,CAAC;AACpD,eAAO,MAAM,uCAAuC,qDACA,CAAC;AACrD,eAAO,MAAM,uDAAuD,qDAChB,CAAC;AA2IrD,eAAO,MAAM,mCAAmC,GAC9C,WAAW,SAAS,KACnB,iBAoBF,CAAC;AAEF,eAAO,MAAM,6BAA6B,GACxC,WAAW,SAAS,EACpB,kBAAiB,eAAyC,KACzD,WAgBF,CAAC"}