@crowdstrike/foundry-js 0.20.0 → 0.21.0

package/README.md

@@ -169,36 +169,23 @@ To call API Integration, App should be initially provisioned, and configuration
 
 ### Navigation utilities
 
-As Page or UI extension will run inside sandboxed iframe, clicking links or navigating will be limited.
-When browser URL changes, Foundry UI Page will receive that data via iframe hash change event.
-You can listen to hash change event and process your app internal navigation. 
+As the Page or UI extension will run inside a sandboxed iframe, the `navigateTo` method must be used to change the url of the parent context (Falcon Console).
 
-```javascript
-window.addEventListener("hashchange", (event) => {
-  let rawHash = new URL(event.newURL).hash;
-
-  const path = rawHash.substring(1);
-}, false);
-
-// to read initial hash when your app loads:
-const initialPath = document.location.hash.substring(1);
-```
-
-If you have links in your application, that point to the internal URLs of your application (for example navigation from /page-1 to /page-2) - 
-you can add `data-` attribute to those links, and add onClick handler, that will handle navigation outside of iframe and will update iframe hash.
+To open an external url (in a new tab): 
 
 ```javascript
-// find all links with data attribute - `data-internal-link` 
-document.querySelector('[data-internal-link]')
-  .addEventListener('click', (event) => falcon.navigation.onClick(event, '_self', 'internal'));
+falcon.navigation.navigateTo({
+  path: 'https://www.github.com',
+});
 ```
 
-If you have external links that you want to navigate to, for example www.crowdstrike.com, you can add `data-` attribute to identify those:
+To navigate to a new url within Falcon Console: 
 
 ```javascript
-// find all links with data attribute - `data-external-link` 
-document.querySelector('[data-external-link]')
-      .addEventListener('click', (event) => falcon.navigation.onClick(event));
+falcon.navigation.navigateTo({
+  path: '/login',
+  type: "falcon",
+});
 ```
 
 ### Modal utility

package/dist/index.js

@@ -3265,6 +3265,9 @@ class Navigation {
             },
         });
     }
+    /**
+     * @deprecated Use navigateTo directly
+     */
     async onClick(event, defaultTarget = '_self', defaultType = 'falcon') {
         if (!(event instanceof Event)) {
             throw Error('"event" property should be subclass of Event');

package/dist/lib/navigation.d.ts

@@ -13,6 +13,9 @@ export declare class Navigation<DATA extends LocalData = LocalData> {
         ctrlKey?: boolean;
         shiftKey?: boolean;
     }): Promise<void>;
+    /**
+     * @deprecated Use navigateTo directly
+     */
     onClick(event: MouseEvent | KeyboardEvent, defaultTarget?: (typeof ALLOWED_TARGETS)[number], defaultType?: NavigateToRequestMessage['payload']['type']): Promise<void>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdstrike/foundry-js",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "foundry-js is the JavaScript SDK for authoring UI Extensions for CrowdStrike's Foundry platform.",
   "repository": {
     "type": "git",
@@ -29,21 +29,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "_build": "concurrently 'npm:build:*'",
-    "_start": "concurrently 'npm:watch:*'",
-    "build": "rollup -c ./config/rollup.config.ts --configPlugin typescript",
-    "api-docs": "typedoc",
-    "lint": "concurrently 'npm:lint:*(!fix)' --names 'lint:'",
-    "lint:fix": "concurrently 'npm:lint:*:fix' --names 'fix:'",
-    "lint:js": "eslint . --cache",
-    "lint:js:fix": "eslint . --fix",
-    "lint:types": "tsc --noEmit",
-    "prepublishOnly": "yarn build",
-    "release": "changeset publish",
-    "start": "yarn build --watch",
-    "test": "vitest"
-  },
   "dependencies": {
     "emittery": "1.2.0",
     "typescript-memoize": "1.1.1",
@@ -56,27 +41,30 @@
     "@rollup/plugin-node-resolve": "16.0.1",
     "@rollup/plugin-replace": "6.0.2",
     "@rollup/plugin-typescript": "12.1.4",
+    "@types/node": "25.0.3",
     "@typescript-eslint/eslint-plugin": "8.45.0",
     "@typescript-eslint/parser": "8.45.0",
     "concurrently": "9.2.1",
-    "eslint": "9.36.0",
-    "eslint-config-prettier": "10.1.8",
-    "eslint-plugin-import": "2.32.0",
-    "eslint-plugin-prettier": "5.5.4",
-    "eslint-plugin-sort-imports-es6-autofix": "0.6.0",
-    "happy-dom": "20.0.0",
-    "jsdom": "27.0.0",
+    "eslint": "9.39.1",
+    "happy-dom": "20.0.2",
     "p-event": "7.0.0",
-    "prettier": "3.6.2",
-    "rollup": "4.52.3",
+    "rollup": "4.54.0",
     "tslib": "2.8.1",
-    "typedoc": "0.28.13",
-    "typedoc-plugin-missing-exports": "4.1.0",
-    "typedoc-plugin-rename-defaults": "0.7.3",
-    "typescript": "5.9.2",
-    "vitest": "3.2.4"
+    "typescript": "5.9.3",
+    "vitest": "4.0.13"
   },
   "engines": {
     "node": ">=22"
+  },
+  "scripts": {
+    "build": "rollup -c ./config/rollup.config.ts --configPlugin typescript",
+    "lint": "concurrently 'npm:lint:*(!fix)' --names 'lint:'",
+    "lint:fix": "concurrently 'npm:lint:*:fix' --names 'fix:'",
+    "lint:js": "eslint . --cache",
+    "lint:js:fix": "eslint . --fix",
+    "lint:types": "tsc --noEmit",
+    "release": "changeset publish",
+    "start": "pnpm build --watch",
+    "test": "vitest"
   }
-}
+}