@finos/legend-application 1.1.9 → 1.2.2

package/src/components/DocumentationLink.tsx

@@ -0,0 +1,44 @@
+/**
+ * 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 { clsx, QuestionCircleIcon } from '@finos/legend-art';
+import { useApplicationStore } from './ApplicationStoreProvider';
+
+export const DocumentationLink: React.FC<{
+  documentationKey: string;
+  className?: string | undefined;
+}> = (props) => {
+  const { documentationKey, className } = props;
+  const applicationStore = useApplicationStore();
+  const documentationLink =
+    applicationStore.docRegistry.getEntry(documentationKey);
+  const openDocLink = (): void => {
+    if (documentationLink) {
+      applicationStore.navigator.openNewWindow(documentationLink);
+    }
+  };
+
+  if (!documentationLink) {
+    return null;
+  }
+  return (
+    <QuestionCircleIcon
+      title="Click to see documentation"
+      onClick={openDocLink}
+      className={clsx('documentation-link', className)}
+    />
+  );
+};

package/src/components/LambdaEditor.tsx

@@ -55,7 +55,7 @@ export type LambdaEditorOnKeyDownEventHandler = {
 
 const LambdaErrorFeedback: React.FC<{
   error?: EngineError | undefined;
-  discardChanges: () => Promise<void>;
+  discardChanges: () => void;
 }> = (props) => {
   const { error, discardChanges } = props;
 
@@ -136,17 +136,17 @@ const LambdaEditorInline = observer(
 
     const transformLambdaToString = async (pretty: boolean): Promise<void> => {
       transformStringToLambda?.cancel();
-      return await flowResult(
+      return flowResult(
         lambdaEditorState.convertLambdaObjectToGrammarString(pretty),
-      ).catch(applicationStore.alertIllegalUnhandledError);
+      ).catch(applicationStore.alertUnhandledError);
     };
-    const discardChanges = applicationStore.guaranteeSafeAction(() =>
+    const discardChanges = applicationStore.guardUnhandledError(() =>
       transformLambdaToString(isExpanded),
     );
     const toggleExpandedMode = (): void => {
       if (!forceExpansion && !parserError) {
         transformLambdaToString(!isExpanded).catch(
-          applicationStore.alertIllegalUnhandledError,
+          applicationStore.alertUnhandledError,
         );
         setExpanded(!isExpanded);
       }
@@ -273,7 +273,7 @@ const LambdaEditorInline = observer(
             const stringToLambdaTransformation = transformStringToLambda();
             if (stringToLambdaTransformation) {
               flowResult(stringToLambdaTransformation).catch(
-                applicationStore.alertIllegalUnhandledError,
+                applicationStore.alertUnhandledError,
               );
             }
           }
@@ -459,11 +459,11 @@ const LambdaEditorPopUp = observer(
 
     const transformLambdaToString = async (pretty: boolean): Promise<void> => {
       transformStringToLambda?.cancel();
-      return await flowResult(
+      return flowResult(
         lambdaEditorState.convertLambdaObjectToGrammarString(pretty),
-      ).catch(applicationStore.alertIllegalUnhandledError);
+      ).catch(applicationStore.alertUnhandledError);
     };
-    const discardChanges = applicationStore.guaranteeSafeAction(() =>
+    const discardChanges = applicationStore.guardUnhandledError(() =>
       transformLambdaToString(true),
     );
 
@@ -531,7 +531,7 @@ const LambdaEditorPopUp = observer(
             const stringToLambdaTransformation = transformStringToLambda();
             if (stringToLambdaTransformation) {
               flowResult(stringToLambdaTransformation).catch(
-                applicationStore.alertIllegalUnhandledError,
+                applicationStore.alertUnhandledError,
               );
             }
           }
@@ -598,7 +598,7 @@ const LambdaEditorPopUp = observer(
     useEffect(() => {
       flowResult(
         lambdaEditorState.convertLambdaObjectToGrammarString(true),
-      ).catch(applicationStore.alertIllegalUnhandledError);
+      ).catch(applicationStore.alertUnhandledError);
     }, [applicationStore, lambdaEditorState]);
 
     useEffect(

package/src/components/NotificationManager.tsx

@@ -84,8 +84,9 @@ export const NotificationManager = observer(() => {
     applicationStore.setNotification(undefined);
     setIsExpanded(false);
   };
-  const handleCopy = (): Promise<void> =>
-    applicationStore.copyTextToClipboard(message);
+  const handleCopy = applicationStore.guardUnhandledError(() =>
+    applicationStore.copyTextToClipboard(message),
+  );
   const toggleExpansion = (): void => setIsExpanded(!isExpanded);
 
   const onSnackbarAutoHideOrClickAway = (

package/src/index.ts

@@ -27,12 +27,13 @@ export * from './components/ApplicationStoreProviderTestUtils';
 export * from './components/WebApplicationNavigatorProviderTestUtils';
 
 export { AppHeader } from './components/AppHeader';
+export { DocumentationLink } from './components/DocumentationLink';
 export * from './components/TextInputEditor';
 export * from './components/LambdaEditor';
 
 export * from './stores/ApplicationStore';
 export { APPLICATION_LOG_EVENT } from './stores/ApplicationLogEvent';
-export * from './stores/ApplicationConfig';
+export * from './stores/LegendApplicationConfig';
 export { WebApplicationNavigator } from './stores/WebApplicationNavigator';
 export { LambdaEditorState } from './stores/LambdaEditorState';
 export * from './stores/PackageableElementOption';

package/src/stores/ApplicationStore.ts

@@ -28,9 +28,10 @@ import {
 } from '@finos/legend-shared';
 import { makeAutoObservable, action } from 'mobx';
 import { APPLICATION_LOG_EVENT } from './ApplicationLogEvent';
-import type { LegendApplicationConfig } from './ApplicationConfig';
+import type { LegendApplicationConfig } from './LegendApplicationConfig';
 import type { WebApplicationNavigator } from './WebApplicationNavigator';
 import type { LegendApplicationPluginManager } from '../application/LegendApplicationPluginManager';
+import type { LegendApplicationDocumentationRegistry } from './LegendApplicationDocumentationRegistry';
 
 export enum ActionAlertType {
   STANDARD = 'STANDARD',
@@ -105,6 +106,7 @@ export class ApplicationStore<T extends LegendApplicationConfig> {
   blockingAlertInfo?: BlockingAlertInfo | undefined;
   actionAlertInfo?: ActionAlertInfo | undefined;
   config: T;
+  docRegistry: LegendApplicationDocumentationRegistry;
 
   log: Log = new Log();
   telemetryService = new TelemetryService();
@@ -129,6 +131,7 @@ export class ApplicationStore<T extends LegendApplicationConfig> {
     });
 
     this.config = config;
+    this.docRegistry = config.docRegistry;
     this.navigator = navigator;
 
     // Register plugins
@@ -256,10 +259,10 @@ export class ApplicationStore<T extends LegendApplicationConfig> {
    * ever occurs, it still shows very apparently in the UI, as such, printing out in the console is not good enough,
    * but crashing the app is bad too, so this is a good balance.
    */
-  notifyAndReturnAlternativeOnError = <T extends SuperGenericFunction, W>(
-    fn: T,
+  notifyAndReturnAlternativeOnError = <U extends SuperGenericFunction, W>(
+    fn: U,
     alternative: W,
-  ): ReturnType<T> | W | undefined => {
+  ): ReturnType<U> | W | undefined => {
     try {
       return fn();
     } catch (error) {
@@ -273,10 +276,10 @@ export class ApplicationStore<T extends LegendApplicationConfig> {
    * When we call store/state functions from the component, we should handle error thrown at these functions instead
    * of throwing them to the UI. This enforces that by throwing `IllegalStateError`
    */
-  alertIllegalUnhandledError = (error: Error): void => {
+  alertUnhandledError = (error: Error): void => {
     this.log.error(
       LogEvent.create(APPLICATION_LOG_EVENT.ILLEGAL_APPLICATION_STATE_OCCURRED),
-      'Encountered unhandled rejection in component',
+      'Encountered unhandled error in component tree',
       error,
     );
     this.notifyIllegalState(error.message);
@@ -285,10 +288,11 @@ export class ApplicationStore<T extends LegendApplicationConfig> {
   /**
    * Guarantee that the action being used by the component does not throw unhandled errors
    */
-  guaranteeSafeAction =
-    (actionFn: () => Promise<void>): (() => Promise<void>) =>
-    (): Promise<void> =>
-      actionFn().catch(this.alertIllegalUnhandledError);
+  guardUnhandledError =
+    (actionFn: () => Promise<void>): (() => void) =>
+    (): void => {
+      actionFn().catch(this.alertUnhandledError);
+    };
 
   async copyTextToClipboard(text: string): Promise<void> {
     if (typeof navigator.clipboard.writeText === 'function') {

package/src/stores/ApplicationStoreTestUtils.ts

@@ -17,7 +17,7 @@
 import { ApplicationStore } from './ApplicationStore';
 import { createBrowserHistory } from 'history';
 import { WebApplicationNavigator } from './WebApplicationNavigator';
-import type { LegendApplicationConfig } from './ApplicationConfig';
+import type { LegendApplicationConfig } from './LegendApplicationConfig';
 import type { LegendApplicationPluginManager } from '../application/LegendApplicationPluginManager';
 
 export const TEST_DATA__applicationVersion = {

package/src/stores/{ApplicationConfig.ts → LegendApplicationConfig.ts}

@@ -18,6 +18,7 @@ import {
   guaranteeNonEmptyString,
   guaranteeNonNullable,
 } from '@finos/legend-shared';
+import { LegendApplicationDocumentationRegistry } from './LegendApplicationDocumentationRegistry';
 
 export interface LegendApplicationVersionData {
   buildTime: string;
@@ -28,6 +29,10 @@ export interface LegendApplicationVersionData {
 export interface LegendApplicationConfigurationData {
   appName: string;
   env: string;
+  documentation?: {
+    url: string;
+    entries?: Record<string, string>;
+  };
   // TODO: when we support vault-like settings
   // See https://github.com/finos/legend-studio/issues/407
   // settingOverrides
@@ -39,6 +44,8 @@ export abstract class LegendApplicationConfig {
   readonly baseUrl: string;
   readonly env: string;
 
+  readonly docRegistry: LegendApplicationDocumentationRegistry;
+
   readonly appVersion: string;
   readonly appVersionBuildTime: string;
   readonly appVersionCommitId: string;
@@ -58,6 +65,13 @@ export abstract class LegendApplicationConfig {
       `Can't configure application: 'env' field is missing or empty`,
     );
 
+    // Documentation
+    this.docRegistry = new LegendApplicationDocumentationRegistry();
+    this.docRegistry.url = configData.documentation?.url;
+    Object.entries(configData.documentation?.entries ?? []).forEach((entry) =>
+      this.docRegistry.registerEntry(entry[0], entry[1]),
+    );
+
     // Version
     this.appVersion = guaranteeNonNullable(
       versionData.version,

package/src/stores/LegendApplicationDocumentationRegistry.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 class LegendApplicationDocumentationRegistry {
+  url?: string | undefined;
+
+  private registry = new Map<string, string>();
+
+  registerEntry(key: string, value: string): void {
+    this.registry.set(key, value);
+  }
+
+  getEntry(key: string): string | undefined {
+    return this.registry.get(key);
+  }
+}

package/tsconfig.json

@@ -34,11 +34,12 @@
     "./src/const.ts",
     "./src/index.ts",
     "./src/components/ApplicationTestID.ts",
-    "./src/stores/ApplicationConfig.ts",
     "./src/stores/ApplicationLogEvent.ts",
     "./src/stores/ApplicationStore.ts",
     "./src/stores/ApplicationStoreTestUtils.ts",
     "./src/stores/LambdaEditorState.ts",
+    "./src/stores/LegendApplicationConfig.ts",
+    "./src/stores/LegendApplicationDocumentationRegistry.ts",
     "./src/stores/PackageableElementOption.ts",
     "./src/stores/PureLanguageSupport.ts",
     "./src/stores/WebApplicationNavigator.ts",
@@ -49,6 +50,7 @@
     "./src/components/ApplicationStoreProvider.tsx",
     "./src/components/ApplicationStoreProviderTestUtils.tsx",
     "./src/components/BlockingAlert.tsx",
+    "./src/components/DocumentationLink.tsx",
     "./src/components/LambdaEditor.tsx",
     "./src/components/LegendApplicationComponentFrameworkProvider.tsx",
     "./src/components/NotificationManager.tsx",

package/CHANGELOG.md

@@ -1,102 +0,0 @@
-# @finos/legend-application
-
-## 1.1.9
-
-## 1.1.8
-
-## 1.1.7
-
-## 1.1.6
-
-## 1.1.5
-
-## 1.1.4
-
-## 1.1.3
-
-## 1.1.2
-
-## 1.1.1
-
-## 1.1.0
-
-### Minor Changes
-
-- [#788](https://github.com/finos/legend-studio/pull/788) [`ca293f83`](https://github.com/finos/legend-studio/commit/ca293f83e554f488f58ee77249838b6b87a3e3da) ([@akphi](https://github.com/akphi)) - Rename `notification snackbar` to `notification manager`. Bundle `notification manager`, `blocking alert`, and `action alert` as well as `LegendStyleProvider` into `LegendApplicationComponentFrameworkProvider`.
-
-### Patch Changes
-
-- [#768](https://github.com/finos/legend-studio/pull/768) [`f2927570`](https://github.com/finos/legend-studio/commit/f2927570b2afdc2954912bdbb20058606d2cf8bc) ([@gayathrir11](https://github.com/gayathrir11)) - Handle empty error messages from Engine.
-
-## 1.0.3
-
-## 1.0.2
-
-## 1.0.1
-
-## 1.0.0
-
-### Major Changes
-
-- [#707](https://github.com/finos/legend-studio/pull/707) [`5d9912d9`](https://github.com/finos/legend-studio/commit/5d9912d9a2c883e23d8852325a25fe59ae7597b1) ([@akphi](https://github.com/akphi)) - **BREAKING CHANGE:** Loggers are now considered as plugins, as such, we nolonger expose `.withLoggers()` when booting the application.
-
-* [#707](https://github.com/finos/legend-studio/pull/707) [`5d9912d9`](https://github.com/finos/legend-studio/commit/5d9912d9a2c883e23d8852325a25fe59ae7597b1) ([@akphi](https://github.com/akphi)) - **BREAKING CHANGE:** Create a new abstract class `LegendApplicationPluginManager` that contains plugins that is relevant at application level, such as `telemetry`, `tracer`, `logger`, etc. Now all specific Legend applications plugin manager must extend this class, e.g. `LegendStudioPluginManager extends LegendApplicationPluginManager`.
-
-## 0.2.2
-
-## 0.2.1
-
-## 0.2.0
-
-### Minor Changes
-
-- [#692](https://github.com/finos/legend-studio/pull/692) [`caab0e67`](https://github.com/finos/legend-studio/commit/caab0e6772181e514b246fe6030a02e7169952cc) ([@akphi](https://github.com/akphi)) - Add `AppHeader` component.
-
-## 0.1.2
-
-## 0.1.1
-
-### Patch Changes
-
-- [#618](https://github.com/finos/legend-studio/pull/618) [`dcf06d09`](https://github.com/finos/legend-studio/commit/dcf06d09bc82d84e05a3d1e6af0d7f445c3d0b39) ([@YannanGao-gs](https://github.com/YannanGao-gs)) - Avoid auto-hiding error notification.
-  Fix the width of expanded notification window.
-
-## 0.1.0
-
-### Minor Changes
-
-- [#587](https://github.com/finos/legend-studio/pull/587) [`a6a0329`](https://github.com/finos/legend-studio/commit/a6a03290a2c78071bb53549b88f5fa075321afdb) ([@YannanGao-gs](https://github.com/YannanGao-gs)) - Improves the display of notifications with a long message by allowing users to copy message content and toggle to `expand` to see the full message.
-
-### Patch Changes
-
-- [#584](https://github.com/finos/legend-studio/pull/584) [`b32e834b`](https://github.com/finos/legend-studio/commit/b32e834ba037658de53632403c79aa0f0f651971) ([@akphi](https://github.com/akphi)) - `notifyError()` now will only take `Error | string`. This will help Typescript catches cases where we pass non-error objects to the notification dispatcher.
-
-## 0.0.13
-
-## 0.0.12
-
-## 0.0.11
-
-## 0.0.10
-
-## 0.0.9
-
-## 0.0.8
-
-### Patch Changes
-
-- [#506](https://github.com/finos/legend-studio/pull/506) [`4fd0d256`](https://github.com/finos/legend-studio/commit/4fd0d2560ef245d97f1d86a4a6ed227a9c3d2cbe) ([@akphi](https://github.com/akphi)) - Add popup mode for `LambdaEditor` to allow more spaces for users to work with big lambdas. Also, document `LambdaEditor` props and add 2 new flags to disable `expansion` mode and `popup` mode.
-
-## 0.0.7
-
-## 0.0.6
-
-## 0.0.5
-
-## 0.0.4
-
-## 0.0.3
-
-## 0.0.2
-
-## 0.0.1

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

@@ -1 +0,0 @@
-{"version":3,"file":"ApplicationConfig.d.ts","sourceRoot":"","sources":["../../src/stores/ApplicationConfig.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAOH,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IAIZ,UAAU,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;CAC3C;AAED,8BAAsB,uBAAuB;IAC3C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;gBAGlC,UAAU,EAAE,kCAAkC,EAC9C,WAAW,EAAE,4BAA4B,EACzC,OAAO,EAAE,MAAM;CA0BlB"}

package/lib/stores/ApplicationConfig.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ApplicationConfig.js","sourceRoot":"","sources":["../../src/stores/ApplicationConfig.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EACL,uBAAuB,EACvB,oBAAoB,GACrB,MAAM,sBAAsB,CAAC;AAiB9B,MAAM,OAAgB,uBAAuB;IAClC,OAAO,CAAS;IAChB,OAAO,CAAS;IAChB,GAAG,CAAS;IAEZ,UAAU,CAAS;IACnB,mBAAmB,CAAS;IAC5B,kBAAkB,CAAS;IAEpC,YACE,UAA8C,EAC9C,WAAyC,EACzC,OAAe;QAEf,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,uBAAuB,CACpC,UAAU,CAAC,OAAO,EAClB,kEAAkE,CACnE,CAAC;QACF,IAAI,CAAC,GAAG,GAAG,uBAAuB,CAChC,UAAU,CAAC,GAAG,EACd,8DAA8D,CAC/D,CAAC;QAEF,UAAU;QACV,IAAI,CAAC,UAAU,GAAG,oBAAoB,CACpC,WAAW,CAAC,OAAO,EACnB,+DAA+D,CAChE,CAAC;QACF,IAAI,CAAC,mBAAmB,GAAG,oBAAoB,CAC7C,WAAW,CAAC,SAAS,EACrB,iEAAiE,CAClE,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,oBAAoB,CAC5C,WAAW,CAAC,SAAS,EACrB,iEAAiE,CAClE,CAAC;IACJ,CAAC;CACF"}