@finos/legend-application 16.0.79 → 16.0.80

package/lib/index.css

@@ -1,4 +1,4 @@
-/** @license @finos/legend-application v16.0.79
+/** @license @finos/legend-application v16.0.80
  * Copyright (c) 2020-present, Goldman Sachs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");

package/lib/index.d.ts

@@ -35,6 +35,7 @@ export { forceDispatchKeyboardEvent, BackdropContainer, } from './components/App
 export * from './stores/ApplicationStore.js';
 export { NAVIGATION_ZONE_SEPARATOR, NavigationService, type NavigationAddress, type NavigationLocation, type NavigationZone, } from './stores/navigation/NavigationService.js';
 export { downloadStream } from './util/DownloadHelperServiceWorker.js';
+export { useSyncStateAndSearchParam } from './util/URLUtils.js';
 export * from './stores/storage/ApplicationStorage.js';
 export * from './stores/storage/StorageService.js';
 export * from './stores/SettingService.js';

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,oCAAoC,CAAC;AACnD,cAAc,0CAA0C,CAAC;AACzD,cAAc,iDAAiD,CAAC;AAEhE,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAE,MAAM,0CAA0C,CAAC;AAE1F,cAAc,0CAA0C,CAAC;AACzD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,iDAAiD,CAAC;AAChE,cAAc,qCAAqC,CAAC;AACpD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qCAAqC,CAAC;AACpD,cAAc,+BAA+B,CAAC;AAC9C,OAAO,EACL,0BAA0B,EAC1B,iBAAiB,GAClB,MAAM,uDAAuD,CAAC;AAE/D,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EACL,yBAAyB,EACzB,iBAAiB,EACjB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,GACpB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iDAAiD,CAAC;AAChE,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,oCAAoC,CAAC;AACnD,cAAc,0CAA0C,CAAC;AACzD,cAAc,iDAAiD,CAAC;AAEhE,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAE,MAAM,0CAA0C,CAAC;AAE1F,cAAc,0CAA0C,CAAC;AACzD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,iDAAiD,CAAC;AAChE,cAAc,qCAAqC,CAAC;AACpD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qCAAqC,CAAC;AACpD,cAAc,+BAA+B,CAAC;AAC9C,OAAO,EACL,0BAA0B,EAC1B,iBAAiB,GAClB,MAAM,uDAAuD,CAAC;AAE/D,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EACL,yBAAyB,EACzB,iBAAiB,EACjB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,GACpB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAChE,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iDAAiD,CAAC;AAChE,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC"}

package/lib/index.js

@@ -35,6 +35,7 @@ export { forceDispatchKeyboardEvent, BackdropContainer, } from './components/App
 export * from './stores/ApplicationStore.js';
 export { NAVIGATION_ZONE_SEPARATOR, NavigationService, } from './stores/navigation/NavigationService.js';
 export { downloadStream } from './util/DownloadHelperServiceWorker.js';
+export { useSyncStateAndSearchParam } from './util/URLUtils.js';
 export * from './stores/storage/ApplicationStorage.js';
 export * from './stores/storage/StorageService.js';
 export * from './stores/SettingService.js';

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,oCAAoC,CAAC;AACnD,cAAc,0CAA0C,CAAC;AACzD,cAAc,iDAAiD,CAAC;AAEhE,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAE,MAAM,0CAA0C,CAAC;AAE1F,cAAc,0CAA0C,CAAC;AACzD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,iDAAiD,CAAC;AAChE,cAAc,qCAAqC,CAAC;AACpD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qCAAqC,CAAC;AACpD,cAAc,+BAA+B,CAAC;AAC9C,OAAO,EACL,0BAA0B,EAC1B,iBAAiB,GAClB,MAAM,uDAAuD,CAAC;AAE/D,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EACL,yBAAyB,EACzB,iBAAiB,GAIlB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iDAAiD,CAAC;AAChE,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,oCAAoC,CAAC;AACnD,cAAc,0CAA0C,CAAC;AACzD,cAAc,iDAAiD,CAAC;AAEhE,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAE,MAAM,0CAA0C,CAAC;AAE1F,cAAc,0CAA0C,CAAC;AACzD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,iDAAiD,CAAC;AAChE,cAAc,qCAAqC,CAAC;AACpD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qCAAqC,CAAC;AACpD,cAAc,+BAA+B,CAAC;AAC9C,OAAO,EACL,0BAA0B,EAC1B,iBAAiB,GAClB,MAAM,uDAAuD,CAAC;AAE/D,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EACL,yBAAyB,EACzB,iBAAiB,GAIlB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAChE,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kCAAkC,CAAC;AACjD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iDAAiD,CAAC;AAChE,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC"}

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@finos/legend-application",
-    "version": "16.0.79",
+    "version": "16.0.80",
     "description": "Legend application core",
     "keywords": [
         "legend",

package/lib/util/URLUtils.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 { SetURLSearchParams } from 'react-router';
+/**
+ * Util hook to keep a state variable in sync with a URL search parameter.
+ *
+ * @param stateVar the state variable to sync
+ * @param updateStateVar setter function to update the state variable (should be memoized with useCallback)
+ * @param searchParamKey the key of the URL search parameter to sync with
+ * @param searchParams the current URL search parameters (i.e., from useSearchParams)
+ * @param setSearchParams function to update the URL search parameters (i.e., from useSearchParams)
+ * @param initializedCallback function to check if the underlying state is initialized and ready to sync with URL (should be memoized with useCallback)
+ */
+export declare const useSyncStateAndSearchParam: (stateVar: string | boolean | number | undefined, updateStateVar: (val: string | undefined) => void, searchParamKey: string, searchParams: URLSearchParams, setSearchParams: SetURLSearchParams, initializedCallback: () => boolean) => void;
+//# sourceMappingURL=URLUtils.d.ts.map

package/lib/util/URLUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"URLUtils.d.ts","sourceRoot":"","sources":["../../src/util/URLUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEvD;;;;;;;;;GASG;AACH,eAAO,MAAM,0BAA0B,GACrC,UAAU,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,EAC/C,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,EACjD,gBAAgB,MAAM,EACtB,cAAc,eAAe,EAC7B,iBAAiB,kBAAkB,EACnC,qBAAqB,MAAM,OAAO,KACjC,IA6BF,CAAC"}

package/lib/util/URLUtils.js

@@ -0,0 +1,57 @@
+/**
+ * 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 { useEffect } from 'react';
+/**
+ * Util hook to keep a state variable in sync with a URL search parameter.
+ *
+ * @param stateVar the state variable to sync
+ * @param updateStateVar setter function to update the state variable (should be memoized with useCallback)
+ * @param searchParamKey the key of the URL search parameter to sync with
+ * @param searchParams the current URL search parameters (i.e., from useSearchParams)
+ * @param setSearchParams function to update the URL search parameters (i.e., from useSearchParams)
+ * @param initializedCallback function to check if the underlying state is initialized and ready to sync with URL (should be memoized with useCallback)
+ */
+export const useSyncStateAndSearchParam = (stateVar, updateStateVar, searchParamKey, searchParams, setSearchParams, initializedCallback) => {
+    // Sync state with URL search param
+    useEffect(() => {
+        if (initializedCallback()) {
+            // On mount or when searchParams change, update state from URL
+            const urlParamValue = searchParams.get(searchParamKey) ?? undefined;
+            updateStateVar(urlParamValue);
+        }
+    }, [initializedCallback, searchParamKey, searchParams, updateStateVar]);
+    // Sync URL search param with state
+    useEffect(() => {
+        if (initializedCallback()) {
+            // When state changes, update URL param
+            if (stateVar) {
+                setSearchParams((params) => {
+                    const newParams = new URLSearchParams(params);
+                    newParams.set(searchParamKey, String(stateVar));
+                    return newParams;
+                });
+            }
+            else {
+                setSearchParams((params) => {
+                    const newParams = new URLSearchParams(params);
+                    newParams.delete(searchParamKey);
+                    return newParams;
+                });
+            }
+        }
+    }, [initializedCallback, searchParamKey, stateVar, setSearchParams]);
+};
+//# sourceMappingURL=URLUtils.js.map

package/lib/util/URLUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"URLUtils.js","sourceRoot":"","sources":["../../src/util/URLUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGlC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,QAA+C,EAC/C,cAAiD,EACjD,cAAsB,EACtB,YAA6B,EAC7B,eAAmC,EACnC,mBAAkC,EAC5B,EAAE;IACR,mCAAmC;IACnC,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,mBAAmB,EAAE,EAAE,CAAC;YAC1B,8DAA8D;YAC9D,MAAM,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,SAAS,CAAC;YACpE,cAAc,CAAC,aAAa,CAAC,CAAC;QAChC,CAAC;IACH,CAAC,EAAE,CAAC,mBAAmB,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC,CAAC;IAExE,mCAAmC;IACnC,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,mBAAmB,EAAE,EAAE,CAAC;YAC1B,uCAAuC;YACvC,IAAI,QAAQ,EAAE,CAAC;gBACb,eAAe,CAAC,CAAC,MAAM,EAAE,EAAE;oBACzB,MAAM,SAAS,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;oBAC9C,SAAS,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;oBAChD,OAAO,SAAS,CAAC;gBACnB,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,eAAe,CAAC,CAAC,MAAM,EAAE,EAAE;oBACzB,MAAM,SAAS,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;oBAC9C,SAAS,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;oBACjC,OAAO,SAAS,CAAC;gBACnB,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC,EAAE,CAAC,mBAAmB,EAAE,cAAc,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;AACvE,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finos/legend-application",
-  "version": "16.0.79",
+  "version": "16.0.80",
   "description": "Legend application core",
   "keywords": [
     "legend",

package/src/index.ts

@@ -48,6 +48,7 @@ export {
   type NavigationZone,
 } from './stores/navigation/NavigationService.js';
 export { downloadStream } from './util/DownloadHelperServiceWorker.js';
+export { useSyncStateAndSearchParam } from './util/URLUtils.js';
 export * from './stores/storage/ApplicationStorage.js';
 export * from './stores/storage/StorageService.js';
 export * from './stores/SettingService.js';

package/src/util/URLUtils.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 { useEffect } from 'react';
+import type { SetURLSearchParams } from 'react-router';
+
+/**
+ * Util hook to keep a state variable in sync with a URL search parameter.
+ *
+ * @param stateVar the state variable to sync
+ * @param updateStateVar setter function to update the state variable (should be memoized with useCallback)
+ * @param searchParamKey the key of the URL search parameter to sync with
+ * @param searchParams the current URL search parameters (i.e., from useSearchParams)
+ * @param setSearchParams function to update the URL search parameters (i.e., from useSearchParams)
+ * @param initializedCallback function to check if the underlying state is initialized and ready to sync with URL (should be memoized with useCallback)
+ */
+export const useSyncStateAndSearchParam = (
+  stateVar: string | boolean | number | undefined,
+  updateStateVar: (val: string | undefined) => void,
+  searchParamKey: string,
+  searchParams: URLSearchParams,
+  setSearchParams: SetURLSearchParams,
+  initializedCallback: () => boolean,
+): void => {
+  // Sync state with URL search param
+  useEffect(() => {
+    if (initializedCallback()) {
+      // On mount or when searchParams change, update state from URL
+      const urlParamValue = searchParams.get(searchParamKey) ?? undefined;
+      updateStateVar(urlParamValue);
+    }
+  }, [initializedCallback, searchParamKey, searchParams, updateStateVar]);
+
+  // Sync URL search param with state
+  useEffect(() => {
+    if (initializedCallback()) {
+      // When state changes, update URL param
+      if (stateVar) {
+        setSearchParams((params) => {
+          const newParams = new URLSearchParams(params);
+          newParams.set(searchParamKey, String(stateVar));
+          return newParams;
+        });
+      } else {
+        setSearchParams((params) => {
+          const newParams = new URLSearchParams(params);
+          newParams.delete(searchParamKey);
+          return newParams;
+        });
+      }
+    }
+  }, [initializedCallback, searchParamKey, stateVar, setSearchParams]);
+};

package/tsconfig.json

@@ -96,6 +96,7 @@
     "./src/stores/terminal/Terminal.ts",
     "./src/stores/terminal/XTerm.ts",
     "./src/util/DownloadHelperServiceWorker.ts",
+    "./src/util/URLUtils.ts",
     "./src/components/ActionAlert.tsx",
     "./src/components/ApplicationComponentFrameworkProvider.tsx",
     "./src/components/ApplicationFrameworkProvider.tsx",