@finos/legend-application 4.0.2 → 5.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finos/legend-application",
-  "version": "4.0.2",
+  "version": "5.0.1",
   "description": "Legend application core",
   "keywords": [
     "legend",
@@ -43,9 +43,9 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@finos/legend-art": "2.0.2",
-    "@finos/legend-graph": "8.0.2",
-    "@finos/legend-shared": "3.0.2",
+    "@finos/legend-art": "2.0.4",
+    "@finos/legend-graph": "9.0.1",
+    "@finos/legend-shared": "4.0.1",
     "@types/css-font-loading-module": "0.0.7",
     "@types/papaparse": "5.3.2",
     "@types/react": "18.0.14",
@@ -54,7 +54,7 @@
     "date-fns": "2.28.0",
     "fuse.js": "6.6.2",
     "history": "5.3.0",
-    "mobx": "6.6.0",
+    "mobx": "6.6.1",
     "mobx-react-lite": "3.4.0",
     "monaco-editor": "0.33.0",
     "papaparse": "5.3.2",
@@ -64,17 +64,18 @@
     "react-resize-detector": "7.1.2",
     "react-router": "5.3.3",
     "react-router-dom": "5.3.3",
-    "serializr": "2.0.5"
+    "serializr": "2.0.5",
+    "sql-formatter": "7.0.2"
   },
   "devDependencies": {
-    "@finos/legend-dev-utils": "2.0.1",
-    "@jest/globals": "28.1.1",
+    "@finos/legend-dev-utils": "2.0.3",
+    "@jest/globals": "28.1.2",
     "cross-env": "7.0.3",
     "eslint": "8.18.0",
-    "jest": "28.1.1",
+    "jest": "28.1.2",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
-    "sass": "1.52.3",
+    "sass": "1.53.0",
     "typescript": "4.7.4"
   },
   "peerDependencies": {

package/src/application/LegendApplication.tsx

@@ -30,12 +30,19 @@ import {
   guaranteeNonEmptyString,
   assertNonNullable,
   NetworkClient,
+  type Writable,
 } from '@finos/legend-shared';
 import { APPLICATION_EVENT } from '../stores/ApplicationEvent.js';
 import { configureComponents } from '@finos/legend-art';
 import type { GraphPluginManager } from '@finos/legend-graph';
 import type { LegendApplicationPluginManager } from './LegendApplicationPluginManager.js';
 import { setupPureLanguageService } from '../stores/PureLanguageSupport.js';
+import {
+  collectKeyedDocumnetationEntriesFromConfig,
+  type LegendApplicationDocumentationConfigEntry,
+  type LegendApplicationDocumentationRegistryData,
+  type LegendApplicationDocumentationRegistryEntry,
+} from '../stores/LegendApplicationDocumentationService.js';
 
 export abstract class LegendApplicationLogger {
   abstract debug(event: LogEvent, ...data: unknown[]): void;
@@ -126,6 +133,15 @@ export const setupLegendApplicationUILibrary = async (
   configureComponents();
 };
 
+export interface LegendApplicationConfigurationInput<
+  T extends LegendApplicationConfigurationData,
+> {
+  baseUrl: string;
+  configData: T;
+  versionData: LegendApplicationVersionData;
+  docEntries?: Record<string, LegendApplicationDocumentationConfigEntry>;
+}
+
 export abstract class LegendApplication {
   protected config!: LegendApplicationConfig;
   protected logger!: LegendApplicationLogger;
@@ -193,6 +209,8 @@ export abstract class LegendApplication {
     baseUrl: string,
   ): Promise<[LegendApplicationConfig, Record<PropertyKey, object>]> {
     const client = new NetworkClient();
+
+    // app config
     let configData: LegendApplicationConfigurationData | undefined;
     try {
       configData = await client.get<LegendApplicationConfigurationData>(
@@ -209,6 +227,8 @@ export abstract class LegendApplication {
       configData,
       `Can't fetch Legend application configuration`,
     );
+
+    // app version
     let versionData;
     try {
       versionData = await client.get<LegendApplicationVersionData>(
@@ -222,16 +242,86 @@ export abstract class LegendApplication {
       );
     }
     assertNonNullable(versionData, `Can't fetch Legend application version`);
+
     return [
-      await this.configureApplication(configData, versionData, baseUrl),
+      await this.configureApplication({
+        configData,
+        versionData,
+        baseUrl,
+      }),
       (configData.extensions ?? {}) as Record<PropertyKey, object>,
     ];
   }
 
+  async loadDocumentationRegistryData(
+    config: LegendApplicationConfig,
+  ): Promise<void> {
+    const entries: Record<string, LegendApplicationDocumentationConfigEntry> =
+      {};
+
+    await Promise.all(
+      [
+        ...config.documentationRegistryEntries,
+        ...this.pluginManager
+          .getApplicationPlugins()
+          .flatMap(
+            (plugin) => plugin.getExtraDocumentationRegistryEntries?.() ?? [],
+          ),
+      ].map(async (entry: LegendApplicationDocumentationRegistryEntry) => {
+        try {
+          const client = new NetworkClient(
+            entry.simple
+              ? {
+                  /**
+                   * NOTE: see the documentation for `simple` flag {@link LegendApplicationDocumentationRegistryEntry}
+                   * here, basically, we expect to fetch just the JSON from an endpoint where `Access-Control-Allow-Origin", "*"` is set
+                   * as such, we must not include the credential in our request
+                   * See https://stackoverflow.com/questions/19743396/cors-cannot-use-wildcard-in-access-control-allow-origin-when-credentials-flag-i
+                   */
+                  options: {
+                    credentials: 'omit',
+                  },
+                }
+              : {},
+          );
+          const docData =
+            await client.get<LegendApplicationDocumentationRegistryData>(
+              guaranteeNonEmptyString(
+                entry.url,
+                `Can't load documentation registry: 'url' field is missing or empty`,
+              ),
+            );
+          assertNonNullable(
+            docData.entries,
+            `Can't load documentation registry data: 'entries' field is missing`,
+          );
+          Object.entries(docData.entries).forEach(([key, docEntry]) => {
+            // NOTE: entries will NOT override
+            if (!entries[key]) {
+              entries[key] = docEntry;
+            }
+          });
+        } catch (error) {
+          assertErrorThrown(error);
+          this.logger.warn(
+            LogEvent.create(
+              APPLICATION_EVENT.APPLICATION_DOCUMENTATION_FETCH_FAILURE,
+            ),
+            error,
+          );
+        }
+      }),
+    );
+
+    // NOTE: config entries will override
+    (config as Writable<LegendApplicationConfig>).keyedDocumentationEntries = [
+      ...collectKeyedDocumnetationEntriesFromConfig(entries),
+      ...config.keyedDocumentationEntries,
+    ];
+  }
+
   protected abstract configureApplication(
-    configData: LegendApplicationConfigurationData,
-    versionData: LegendApplicationVersionData,
-    baseUrl: string,
+    input: LegendApplicationConfigurationInput<LegendApplicationConfigurationData>,
   ): Promise<LegendApplicationConfig>;
 
   protected abstract loadApplication(): Promise<void>;
@@ -252,6 +342,12 @@ export abstract class LegendApplication {
       this.pluginManager.configure(extensionConfigData);
       this.pluginManager.install();
 
+      // Other setups
+      await Promise.all(
+        // NOTE: to be done in parallel to save time
+        [this.loadDocumentationRegistryData(config)],
+      );
+
       await this.loadApplication();
 
       this.logger.info(

package/src/components/VirtualAssistant.tsx

@@ -271,14 +271,14 @@ const VirtualAssistantSearchPanel = observer(() => {
       ContentType.APPLICATION_JSON,
     );
   };
-  const downloadContextualDocRegistry = (): void => {
+  const downloadContextualDocMap = (): void => {
     downloadFileUsingDataURI(
       `documentation-registry_${format(
         new Date(Date.now()),
         DATE_TIME_FORMAT,
       )}.json`,
       JSON.stringify(
-        applicationStore.documentationService.publishContextualDocRegistry(),
+        applicationStore.documentationService.publishContextualDocMap(),
         undefined,
         TAB_SIZE,
       ),
@@ -363,8 +363,8 @@ const VirtualAssistantSearchPanel = observer(() => {
                 <MenuContentItem onClick={downloadDocRegistry}>
                   Download documentation registry
                 </MenuContentItem>
-                <MenuContentItem onClick={downloadContextualDocRegistry}>
-                  Download contextual documentation registry
+                <MenuContentItem onClick={downloadContextualDocMap}>
+                  Download contextual documentation mapping
                 </MenuContentItem>
               </MenuContent>
             }

package/src/components/{BasicValueSpecificationEditor.tsx → shared/BasicValueSpecificationEditor.tsx}

@@ -60,7 +60,7 @@ import { useEffect, useRef, useState } from 'react';
 import {
   instanceValue_changeValue,
   instanceValue_changeValues,
-} from '../stores/ValueSpecificationModifierHelper.js';
+} from '../../stores/shared/ValueSpecificationModifierHelper.js';
 import { CustomDatePicker } from './CustomDatePicker.js';
 
 type TypeCheckOption = {

package/src/components/{CustomDatePicker.tsx → shared/CustomDatePicker.tsx}

@@ -47,7 +47,7 @@ import { useEffect, useState } from 'react';
 import {
   genericType_setRawType,
   instanceValue_changeValue,
-} from '../stores/ValueSpecificationModifierHelper.js';
+} from '../../stores/shared/ValueSpecificationModifierHelper.js';
 
 enum CUSTOM_DATE_PICKER_OPTION {
   ABSOLUTE_DATE = 'Absolute Date',

package/src/components/{DocumentationLink.tsx → shared/DocumentationLink.tsx}

@@ -15,7 +15,7 @@
  */
 
 import { clsx, QuestionCircleIcon } from '@finos/legend-art';
-import { useApplicationStore } from './ApplicationStoreProvider.js';
+import { useApplicationStore } from '../ApplicationStoreProvider.js';
 
 export const DocumentationLink: React.FC<{
   documentationKey: string;

package/src/components/{LambdaEditor.tsx → shared/LambdaEditor.tsx}

@@ -35,7 +35,7 @@ import {
   LongArrowAltUpIcon,
   Dialog,
 } from '@finos/legend-art';
-import type { LambdaEditorState } from '../stores/LambdaEditorState.js';
+import type { LambdaEditorState } from '../../stores/shared/LambdaEditorState.js';
 import {
   debounce,
   noop,
@@ -44,9 +44,9 @@ import {
 } from '@finos/legend-shared';
 import { flowResult } from 'mobx';
 import { ParserError, type EngineError, type Type } from '@finos/legend-graph';
-import { APPLICATION_TEST_ID } from './ApplicationTestID.js';
-import { useApplicationStore } from './ApplicationStoreProvider.js';
-import { EDITOR_LANGUAGE, EDITOR_THEME, TAB_SIZE } from '../const.js';
+import { APPLICATION_TEST_ID } from '../ApplicationTestID.js';
+import { useApplicationStore } from '../ApplicationStoreProvider.js';
+import { EDITOR_LANGUAGE, EDITOR_THEME, TAB_SIZE } from '../../const.js';
 
 export type LambdaEditorOnKeyDownEventHandler = {
   matcher: (event: IKeyboardEvent) => boolean;

package/src/components/{LambdaParameterValuesEditor.tsx → shared/LambdaParameterValuesEditor.tsx}

@@ -22,8 +22,8 @@ import {
 } from '@finos/legend-graph';
 import { prettyCONSTName } from '@finos/legend-shared';
 import { observer } from 'mobx-react-lite';
-import type { LambdaParametersState } from '../stores/LambdaParameterState.js';
-import { useApplicationStore } from './ApplicationStoreProvider.js';
+import type { LambdaParametersState } from '../../stores/shared/LambdaParameterState.js';
+import { useApplicationStore } from '../ApplicationStoreProvider.js';
 import { BasicValueSpecificationEditor } from './BasicValueSpecificationEditor.js';
 
 // TODO we may want to further componentize this by removing the dialog wrapper

package/src/components/shared/PackageableElementOptionRenderer.tsx

@@ -0,0 +1,40 @@
+/**
+ * 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 { PackageableElement } from '@finos/legend-graph';
+import type { PackageableElementOption } from '../../index.js';
+
+export const getPackageableElementOptionalFormatter = (props?: {
+  darkMode?: boolean;
+}): ((
+  option: PackageableElementOption<PackageableElement>,
+) => React.ReactNode) =>
+  function PackageableElementOptionLabel(
+    option: PackageableElementOption<PackageableElement>,
+  ): React.ReactNode {
+    const className = props?.darkMode
+      ? 'packageable-element-format-option-label--dark'
+      : 'packageable-element-format-option-label';
+
+    return (
+      <div className={className}>
+        <div className={`${className}__name`}>{option.label}</div>
+        {option.value.package && (
+          <div className={`${className}__tag`}>{option.value.path}</div>
+        )}
+      </div>
+    );
+  };

package/src/components/{TextInputEditor.tsx → shared/TextInputEditor.tsx}

@@ -29,8 +29,8 @@ import {
   getEditorValue,
   normalizeLineEnding,
 } from '@finos/legend-art';
-import { type EDITOR_LANGUAGE, EDITOR_THEME, TAB_SIZE } from '../const.js';
-import { useApplicationStore } from './ApplicationStoreProvider.js';
+import { type EDITOR_LANGUAGE, EDITOR_THEME, TAB_SIZE } from '../../const.js';
+import { useApplicationStore } from '../ApplicationStoreProvider.js';
 
 export type TextInputEditorOnKeyDownEventHandler = {
   matcher: (event: IKeyboardEvent) => boolean;