@finos/legend-application 0.1.0 → 0.2.2

package/src/stores/WebApplicationNavigator.ts

@@ -20,6 +20,20 @@ import { guaranteeNonNullable } from '@finos/legend-shared';
 /**
  * This is an initial attempt to try to generalize the application
  * to other platforms. But regardless, this is more convenient for testing.
+ *
+ * FIXME: this is not the right way to do this. Our intention here is to make
+ * app navigator something generic enough so we are somewhat platform-agnostic
+ * i.e. browser, electron, PC, UNIX, etc.
+ *
+ * Parameterize on the type of the location might not be the best thing to do.
+ * Because typing wise, this forces us to also parameterize consumers of this,
+ * which is `ApplicationStore`. It means that we must dictate in the source
+ * code the platform the app depends on, clearly for web browser, `string` is the
+ * easy option, but if we do so, it defeats the purpose of this abstraction in the
+ * first place.
+ *
+ * As such, instead, we should design a more generic concept `Location` to pass around.
+ * We would need to flesh out the details, but this is the rough idea.
  */
 interface ApplicationNavigator<T> {
   reload(): void;
@@ -27,6 +41,8 @@ interface ApplicationNavigator<T> {
   jumpTo(location: T): void;
   openNewWindow(location: T): void;
   getCurrentLocation(): T;
+  getCurrentLocationPath(): T;
+  generateLocation(locationPath: T): T;
 }
 
 export class WebApplicationNavigator implements ApplicationNavigator<string> {
@@ -63,10 +79,14 @@ export class WebApplicationNavigator implements ApplicationNavigator<string> {
     return this.window.location.href;
   }
 
-  generateLocation(location: string): string {
+  getCurrentLocationPath(): string {
+    return this.historyAPI.location.pathname;
+  }
+
+  generateLocation(locationPath: string): string {
     return (
       window.location.origin +
-      this.historyAPI.createHref({ pathname: location })
+      this.historyAPI.createHref({ pathname: locationPath })
     );
   }
 }

package/tsconfig.json

@@ -22,6 +22,7 @@
     "allowSyntheticDefaultImports": true,
     "strict": true,
     "noImplicitOverride": true,
+    "noUncheckedIndexedAccess": true,
     "exactOptionalPropertyTypes": true,
     "forceConsistentCasingInFileNames": true,
     "outDir": "./lib",
@@ -29,11 +30,6 @@
     "rootDir": "./src",
     "jsx": "react-jsx"
   },
-  "references": [
-    {
-      "path": "./tsconfig.package.json"
-    }
-  ],
   "files": [
     "./src/const.ts",
     "./src/index.ts",
@@ -49,6 +45,7 @@
     "./src/stores/WebApplicationNavigator.ts",
     "./src/application/LegendApplication.tsx",
     "./src/components/ActionAlert.tsx",
+    "./src/components/AppHeader.tsx",
     "./src/components/ApplicationBackdrop.tsx",
     "./src/components/ApplicationStoreProvider.tsx",
     "./src/components/ApplicationStoreProviderTestUtils.tsx",

package/tsconfig.package.json

@@ -1,40 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": [
-      "dom",
-      "dom.iterable",
-      "esnext",
-      "webworker",
-      "scripthost"
-    ],
-    "composite": true,
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "target": "esnext",
-    "module": "esnext",
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "importsNotUsedAsValues": "error",
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "strict": true,
-    "noImplicitOverride": true,
-    "exactOptionalPropertyTypes": true,
-    "forceConsistentCasingInFileNames": true,
-    "outDir": "./lib",
-    "tsBuildInfoFile": "./build/package.tsbuildinfo",
-    "rootDir": "./"
-  },
-  "files": [
-    "./package.json"
-  ],
-  "include": [
-    "package.json"
-  ],
-  "exclude": [
-    "lib"
-  ]
-}