@crowdstrike/foundry-js 0.8.2 → 0.10.0

package/dist/index.js

@@ -830,81 +830,6 @@ function getNewFunction(originalMethod, hashFunction, duration = 0, tags) {
     };
 }
 
-/**
- *
- * This file is autogenerated.
- *
- * DO NOT EDIT DIRECTLY
- *
- **/
-class ActorsApiBridge {
-    bridge;
-    constructor(bridge) {
-        this.bridge = bridge;
-    }
-    getBridge() {
-        return this.bridge;
-    }
-    async getEntitiesActorsGetV2(urlParams = {}) {
-        const message = {
-            type: 'api',
-            api: 'actors',
-            method: 'getEntitiesActorsGetV2',
-            payload: {
-                params: urlParams,
-            },
-        };
-        return this.bridge.postMessage(message);
-    }
-    async getQueriesActorsV2(urlParams = {}) {
-        const message = {
-            type: 'api',
-            api: 'actors',
-            method: 'getQueriesActorsV2',
-            payload: {
-                params: urlParams,
-            },
-        };
-        return this.bridge.postMessage(message);
-    }
-    async postAggregatesActorsGetV2(postBody, urlParams = {}) {
-        const message = {
-            type: 'api',
-            api: 'actors',
-            method: 'postAggregatesActorsGetV2',
-            payload: {
-                body: postBody,
-                params: urlParams,
-            },
-        };
-        return this.bridge.postMessage(message);
-    }
-    async postEntitiesActorsGetV2(postBody, urlParams = {}) {
-        const message = {
-            type: 'api',
-            api: 'actors',
-            method: 'postEntitiesActorsGetV2',
-            payload: {
-                body: postBody,
-                params: urlParams,
-            },
-        };
-        return this.bridge.postMessage(message);
-    }
-    async postEntitiesMitreV1(postBody, urlParams = {}) {
-        const message = {
-            type: 'api',
-            api: 'actors',
-            method: 'postEntitiesMitreV1',
-            payload: {
-                body: postBody,
-                params: urlParams,
-            },
-        };
-        return this.bridge.postMessage(message);
-    }
-}
-
 /**
  *
  * This file is autogenerated.
@@ -1249,44 +1174,44 @@ class DevicesApiBridge {
         };
         return this.bridge.postMessage(message);
     }
-    async getAggregatesTagPrefixCountsV1(urlParams) {
+    async getAggregatesFgaTagPrefixCountsV1(urlParams) {
         const message = {
             type: 'api',
             api: 'devices',
-            method: 'getAggregatesTagPrefixCountsV1',
+            method: 'getAggregatesFgaTagPrefixCountsV1',
             payload: {
                 params: urlParams,
             },
         };
         return this.bridge.postMessage(message);
     }
-    async getEntitiesGroupsV1(urlParams) {
+    async getAggregatesTagPrefixCountsV1(urlParams) {
         const message = {
             type: 'api',
             api: 'devices',
-            method: 'getEntitiesGroupsV1',
+            method: 'getAggregatesTagPrefixCountsV1',
             payload: {
                 params: urlParams,
             },
         };
         return this.bridge.postMessage(message);
     }
-    async getEntitiesReleasesV1(urlParams) {
+    async getEntitiesFgaGroupsV1(urlParams) {
         const message = {
             type: 'api',
             api: 'devices',
-            method: 'getEntitiesReleasesV1',
+            method: 'getEntitiesFgaGroupsV1',
             payload: {
                 params: urlParams,
             },
         };
         return this.bridge.postMessage(message);
     }
-    async getEntitiesRespondV1(urlParams = {}) {
+    async getEntitiesGroupsV1(urlParams) {
         const message = {
             type: 'api',
             api: 'devices',
-            method: 'getEntitiesRespondV1',
+            method: 'getEntitiesGroupsV1',
             payload: {
                 params: urlParams,
             },
@@ -1337,6 +1262,17 @@ class DevicesApiBridge {
         };
         return this.bridge.postMessage(message);
     }
+    async getQueriesFgaGroupsV1(urlParams = {}) {
+        const message = {
+            type: 'api',
+            api: 'devices',
+            method: 'getQueriesFgaGroupsV1',
+            payload: {
+                params: urlParams,
+            },
+        };
+        return this.bridge.postMessage(message);
+    }
     async getQueriesGroupsV1(urlParams = {}) {
         const message = {
             type: 'api',
@@ -1384,6 +1320,18 @@ class DevicesApiBridge {
         };
         return this.bridge.postMessage(message);
     }
+    async postAggregatesFgaHostsGetV1(postBody, urlParams = {}) {
+        const message = {
+            type: 'api',
+            api: 'devices',
+            method: 'postAggregatesFgaHostsGetV1',
+            payload: {
+                body: postBody,
+                params: urlParams,
+            },
+        };
+        return this.bridge.postMessage(message);
+    }
     async postCombinedDevicesLoginHistoryV1(postBody, urlParams = {}) {
         const message = {
             type: 'api',
@@ -1396,6 +1344,18 @@ class DevicesApiBridge {
         };
         return this.bridge.postMessage(message);
     }
+    async postCombinedFgaHostsLoginHistoryV1(postBody, urlParams = {}) {
+        const message = {
+            type: 'api',
+            api: 'devices',
+            method: 'postCombinedFgaHostsLoginHistoryV1',
+            payload: {
+                body: postBody,
+                params: urlParams,
+            },
+        };
+        return this.bridge.postMessage(message);
+    }
     async postEntitiesDevicesActionsV4(postBody, urlParams = {}) {
         const message = {
             type: 'api',
@@ -1444,11 +1404,11 @@ class DevicesApiBridge {
         };
         return this.bridge.postMessage(message);
     }
-    async postEntitiesGroupActionsV1(postBody, urlParams) {
+    async postEntitiesFgaHostsReportsV1(postBody, urlParams = {}) {
         const message = {
             type: 'api',
             api: 'devices',
-            method: 'postEntitiesGroupActionsV1',
+            method: 'postEntitiesFgaHostsReportsV1',
             payload: {
                 body: postBody,
                 params: urlParams,
@@ -1456,11 +1416,11 @@ class DevicesApiBridge {
         };
         return this.bridge.postMessage(message);
     }
-    async postEntitiesGroupsV1(postBody, urlParams = {}) {
+    async postEntitiesFgaHostsV1(postBody, urlParams = {}) {
         const message = {
             type: 'api',
             api: 'devices',
-            method: 'postEntitiesGroupsV1',
+            method: 'postEntitiesFgaHostsV1',
             payload: {
                 body: postBody,
                 params: urlParams,
@@ -1468,11 +1428,23 @@ class DevicesApiBridge {
         };
         return this.bridge.postMessage(message);
     }
-    async postEntitiesReleasesV1(postBody, urlParams) {
+    async postEntitiesGroupActionsV1(postBody, urlParams) {
         const message = {
             type: 'api',
             api: 'devices',
-            method: 'postEntitiesReleasesV1',
+            method: 'postEntitiesGroupActionsV1',
+            payload: {
+                body: postBody,
+                params: urlParams,
+            },
+        };
+        return this.bridge.postMessage(message);
+    }
+    async postEntitiesGroupsV1(postBody, urlParams = {}) {
+        const message = {
+            type: 'api',
+            api: 'devices',
+            method: 'postEntitiesGroupsV1',
             payload: {
                 body: postBody,
                 params: urlParams,
@@ -2092,11 +2064,11 @@ class MitreApiBridge {
     getBridge() {
         return this.bridge;
     }
-    async getEntitiesMatrixV1(urlParams = {}) {
+    async getIntelMitreEntitiesMatrixV1(urlParams = {}) {
         const message = {
             type: 'api',
             api: 'mitre',
-            method: 'getEntitiesMatrixV1',
+            method: 'getIntelMitreEntitiesMatrixV1',
             payload: {
                 params: urlParams,
             },
@@ -2228,18 +2200,6 @@ class RemoteResponseApiBridge {
         };
         return this.bridge.postMessage(message);
     }
-    async postEntitiesAppRefreshSessionsV1(postBody, urlParams = {}) {
-        const message = {
-            type: 'api',
-            api: 'remoteResponse',
-            method: 'postEntitiesAppRefreshSessionsV1',
-            payload: {
-                body: postBody,
-                params: urlParams,
-            },
-        };
-        return this.bridge.postMessage(message);
-    }
     async postEntitiesAppSessionsV1(postBody, urlParams = {}) {
         const message = {
             type: 'api',
@@ -2354,67 +2314,75 @@ class WorkflowsApiBridge {
  *
  **/
 class FalconPublicApis {
-    isConnected = false;
-    get actors() {
-        assertConnection(this);
-        return new ActorsApiBridge(this.bridge);
+    api;
+    constructor(api) {
+        this.api = api;
     }
     get alerts() {
-        assertConnection(this);
-        return new AlertsApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new AlertsApiBridge(this.api.bridge);
     }
     get detects() {
-        assertConnection(this);
-        return new DetectsApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new DetectsApiBridge(this.api.bridge);
     }
     get devices() {
-        assertConnection(this);
-        return new DevicesApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new DevicesApiBridge(this.api.bridge);
     }
     get fwmgr() {
-        assertConnection(this);
-        return new FwmgrApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new FwmgrApiBridge(this.api.bridge);
     }
     get incidents() {
-        assertConnection(this);
-        return new IncidentsApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new IncidentsApiBridge(this.api.bridge);
     }
     get mitre() {
-        assertConnection(this);
-        return new MitreApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new MitreApiBridge(this.api.bridge);
     }
+    /**
+     * @internal
+     */
     get plugins() {
-        assertConnection(this);
-        return new PluginsApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new PluginsApiBridge(this.api.bridge);
     }
     get remoteResponse() {
-        assertConnection(this);
-        return new RemoteResponseApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new RemoteResponseApiBridge(this.api.bridge);
     }
     get userManagement() {
-        assertConnection(this);
-        return new UserManagementApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new UserManagementApiBridge(this.api.bridge);
     }
     get workflows() {
-        assertConnection(this);
-        return new WorkflowsApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new WorkflowsApiBridge(this.api.bridge);
     }
+    /**
+     * @internal
+     */
     get customobjects() {
-        assertConnection(this);
-        return new CustomobjectsApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new CustomobjectsApiBridge(this.api.bridge);
     }
+    /**
+     * @internal
+     */
     get faasGateway() {
-        assertConnection(this);
-        return new FaasGatewayApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new FaasGatewayApiBridge(this.api.bridge);
     }
+    /**
+     * @internal
+     */
     get loggingapi() {
-        assertConnection(this);
-        return new LoggingapiApiBridge(this.bridge);
+        assertConnection(this.api);
+        return new LoggingapiApiBridge(this.api.bridge);
     }
 }
-__decorate([
-    Memoize()
-], FalconPublicApis.prototype, "actors", null);
 __decorate([
     Memoize()
 ], FalconPublicApis.prototype, "alerts", null);
@@ -2463,7 +2431,7 @@ class ApiIntegration {
         this.definition = definition;
     }
     async execute({ request } = {}) {
-        return this.falcon.plugins.postEntitiesExecuteV1({
+        return this.falcon.api.plugins.postEntitiesExecuteV1({
             resources: [
                 {
                     definition_id: this.definition.definitionId,
@@ -2483,8 +2451,17 @@ class CloudFunction {
     static PATCH = 'PATCH';
     static PUT = 'PUT';
     static DELETE = 'DELETE';
+    /**
+     * @internal
+     */
     pollTimeout = 500;
+    /**
+     * @internal
+     */
     intervalId;
+    /**
+     * @internal
+     */
     constructor(falcon, definition) {
         this.falcon = falcon;
         this.definition = definition;
@@ -2499,7 +2476,7 @@ class CloudFunction {
                 function_name: this.definition.name,
                 function_version: this.definition.version,
             };
-        const result = await this.falcon.faasGateway.postEntitiesExecutionV1({
+        const result = await this.falcon.api.faasGateway.postEntitiesExecutionV1({
             ...functionDefinition,
             payload: {
                 path,
@@ -2523,7 +2500,7 @@ class CloudFunction {
         });
     }
     async getExecutionResult(executionId) {
-        const resultResponse = await this.falcon.faasGateway.getEntitiesExecutionV1({
+        const resultResponse = await this.falcon.api.faasGateway.getEntitiesExecutionV1({
             id: executionId,
         });
         const executionResult = resultResponse?.resources?.[0];
@@ -2663,6 +2640,13 @@ class Collection {
         this.falcon = falcon;
         this.definition = definition;
     }
+    /**
+     * Write data to the collection
+     *
+     * @param key
+     * @param data
+     * @returns
+     */
     async write(key, data) {
         return this.falcon.bridge.postMessage({
             type: 'collection',
@@ -2674,6 +2658,12 @@ class Collection {
             },
         });
     }
+    /**
+     * Read the data for the given `key`
+     *
+     * @param key
+     * @returns
+     */
     async read(key) {
         return this.falcon.bridge.postMessage({
             type: 'collection',
@@ -2684,6 +2674,12 @@ class Collection {
             },
         });
     }
+    /**
+     * Delete the data for the given `key`
+     *
+     * @param key
+     * @returns
+     */
     async delete(key) {
         return this.falcon.bridge.postMessage({
             type: 'collection',
@@ -2694,6 +2690,12 @@ class Collection {
             },
         });
     }
+    /**
+     * Search for data
+     *
+     * @param searchDefinition
+     * @returns
+     */
     async search({ filter, offset, sort, limit, }) {
         return this.falcon.bridge.postMessage({
             type: 'collection',
@@ -2714,7 +2716,16 @@ class Logscale {
     constructor(falcon) {
         this.falcon = falcon;
     }
-    async write(data, properties) {
+    /**
+     * Write data to LogScale
+     *
+     * @param data
+     * @param properties
+     * @returns
+     */
+    async write(
+    // @todo the proper type here is unclear  - we need to make clear how the user needs to call this
+    data, properties) {
         return this.falcon.bridge.postMessage({
             type: 'loggingapi',
             payload: {
@@ -2726,21 +2737,37 @@ class Logscale {
             },
         });
     }
-    async query(data) {
+    /**
+     * Execute a dynamic query
+     *
+     * @param query
+     * @returns Promise that resolves with the data
+     */
+    async query(
+    // @todo the proper type here is unclear  - we need to make clear how the user needs to call this
+    query) {
         return this.falcon.bridge.postMessage({
             type: 'loggingapi',
             payload: {
                 type: 'dynamic-execute',
-                data,
+                data: query,
             },
         });
     }
-    async savedQuery(data) {
+    /**
+     * Execute a saved query
+     *
+     * @param savedQuery
+     * @returns
+     */
+    async savedQuery(
+    // @todo the proper type here is unclear  - we need to make clear how the user needs to call this
+    savedQuery) {
         return this.falcon.bridge.postMessage({
             type: 'loggingapi',
             payload: {
                 type: 'saved-query-execute',
-                data,
+                data: savedQuery,
             },
         });
     }
@@ -2795,6 +2822,9 @@ class Navigation {
     }
 }
 
+/**
+ * @internal
+ */
 class ResizeTracker {
     bridge;
     observer;
@@ -2817,11 +2847,31 @@ class ResizeTracker {
     }
 }
 
+/**
+ * Invoke UI features within the main Falcon Console.
+ */
 class UI {
     bridge;
     constructor(bridge) {
         this.bridge = bridge;
     }
+    /**
+     * Open a modal within the Falcon Console, rendering an UI extension of your choice.
+     *
+     * ```js
+     * const result = await api.ui.openModal({ id: '<extension ID as defined in the manifest>', type: 'extension' }, 'Modal title', {
+        path: '/foo',
+        data: { foo: 'bar' },
+        size: 'lg',
+        align: 'top',
+      });
+      ```
+     *
+     * @param extension The identifier of the extension, consisting of {@link ExtensionIdentifier.id} and {@link ExtensionIdentifier.type}
+     * @param title The title to render in the header of the modal
+     * @param options
+     * @returns a Promise that resolves with the data passed to {@link closeModal}, or `undefined` if the user dismisses it
+     */
     async openModal(extension, title, options = {}) {
         const result = await this.bridge.postMessage({
             type: 'openModal',
@@ -2836,27 +2886,94 @@ class UI {
         }
         return result;
     }
+    /**
+     * Close a modal already opened via {@link openModal}. This can be called both by the extension that is rendered inside the modal or by the extension that opened the modal.
+     *
+     * @param payload the data to return to the caller that opened the modal as the value of the resolved promise
+     */
     closeModal(payload) {
         this.bridge.sendUnidirectionalMessage({
             type: 'closeModal',
             payload,
         });
     }
+    /**
+     * This opens a file upload modal inside the Falcon Console, to support file uploads, even large binary files.
+     *
+     * @param fileUploadType the type of file upload
+     * @param initialData data that you want to pre-populate the form with
+     */
+    async uploadFile(fileUploadType, initialData) {
+        return this.bridge.postMessage({
+            type: 'fileUpload',
+            fileUploadType,
+            payload: initialData,
+        });
+    }
 }
 
-class FalconApi extends FalconPublicApis {
+/**
+ * This is the main class and only entrypoint for engaging with the Falcon APIs from an Foundry UI extension or page.
+ *
+ * At the very minimum, you would have to instantiate the class and connect to the Falcon Console:
+ *
+ * ```js
+ * import FalconApi from '@crowdstrike/foundry-js';
+ *
+ * const api = new FalconApi();
+ *
+ * await api.connect();
+ * ```
+ *
+ */
+class FalconApi {
+    /**
+     * @internal
+     */
+    isConnected = false;
+    /**
+     * An event emitter that allows you to subscribe to events issued by the Falcon Console.
+     *
+     * Currently supported event types:
+     * * `data`: fires when {@link data} is updated.
+     * * `broadcast`: this event is received when another extension of the same app has send a `broadcast` event via {@link sendBroadcast}.
+     *
+     * ```js
+     * api.events.on('data', (newData) => console.log('new data received:', newData));
+     * ```
+     */
     events = new Emittery();
+    /**
+     * The "local data" that your extension receives from the Falcon Console. This can vary depending on the state of the Falcon Console and the socket of the extension.
+     *
+     * At the very least it will contain the data specified by the {@link LocalData} interface.
+     */
     data;
+    /**
+     * @internal
+     */
     bridge = new Bridge({
         onDataUpdate: (data) => this.handleDataUpdate(data),
         onBroadcast: (msg) => this.handleBroadcastMessage(msg),
         onLivereload: () => this.handleLivereloadMessage(),
     });
+    /**
+     * Namespace for all the {@link FalconPublicApis | Falcon Cloud APIs} you have access to with this SDK.
+     */
+    api = new FalconPublicApis(this);
+    /**
+     * The {@link UI} class contains methods to invoke UI features within the main Falcon Console.
+     */
     ui = new UI(this.bridge);
     resizeTracker;
     cloudFunctions = [];
     apiIntegrations = [];
     collections = [];
+    /**
+     * Connect to the main Falcon Console from within your UI extension.
+     *
+     * This establishes a connection to send messages between the extension and the Falcon Console. Only when established you will be able to call other APIs.
+     */
     async connect() {
         const { origin, data } = await this.bridge.postMessage({ type: 'connect' });
         this.bridge.setOrigin(origin);
@@ -2865,19 +2982,23 @@ class FalconApi extends FalconPublicApis {
         this.resizeTracker = new ResizeTracker(this.bridge);
         this.isConnected = true;
     }
+    /**
+     * The ID of the Foundry app this UI extension belongs to.
+     */
     get appId() {
         return this.data?.app.id;
     }
+    /**
+     * Sending broadcast messages is a mechanism for allowing communication between different UI extensions, when they are displayed at the same time.
+     * When sending a broadcast message, other extensions need to listen for the `broadcast` event on the {@link events} event emitter.
+     *
+     * Note that broadcast messages are only dispatched between UI extensions of the same app!
+     *
+     * @param payload the data you want to send to other UI extensions
+     */
     sendBroadcast(payload) {
         this.bridge.sendUnidirectionalMessage({ type: 'broadcast', payload });
     }
-    async uploadFile(fileUploadType, initialData) {
-        return this.bridge.postMessage({
-            type: 'fileUpload',
-            fileUploadType,
-            payload: initialData,
-        });
-    }
     handleDataUpdate(dataMessage) {
         this.data = dataMessage.payload;
         this.updateTheme(this.data.theme);
@@ -2897,34 +3018,58 @@ class FalconApi extends FalconPublicApis {
         document.documentElement.classList.add(activeTheme);
         document.documentElement.classList.remove(inactiveTheme);
     }
+    /**
+     * Create a {@link CloudFunction} to integrate with Falcon's "Function as a Service" platform.
+     *
+     * @param definition
+     * @returns
+     */
     cloudFunction(definition) {
         assertConnection(this);
         const cf = new CloudFunction(this, definition);
         this.cloudFunctions.push(cf);
         return cf;
     }
+    /**
+     * Create an {@link ApiIntegration} to call external APIs.
+     *
+     * @param defintition
+     * @returns
+     */
     apiIntegration({ definitionId, operationId, }) {
         assertConnection(this);
         if (!this.data) {
             throw Error('Data from console is missing');
         }
-        const cf = new ApiIntegration(this, {
+        const apiIntegration = new ApiIntegration(this, {
             operationId,
             definitionId: definitionId ?? this.data?.app.id,
         });
-        this.apiIntegrations.push(cf);
-        return cf;
-    }
+        this.apiIntegrations.push(apiIntegration);
+        return apiIntegration;
+    }
+    /**
+     * Create a {@link Collection} to write to and query Falcon's custom storage service.
+     *
+     * @param definition
+     * @returns
+     */
     collection({ collection }) {
         assertConnection(this);
         const co = new Collection(this, { collection });
         this.collections.push(co);
         return co;
     }
+    /**
+     * The {@link Navigation} class provides functionality to navigate to other pages.
+     */
     get navigation() {
         assertConnection(this);
         return new Navigation(this);
     }
+    /**
+     * The {@link Logscale} class allows you to read and write to your custom LogScale repository.
+     */
     get logscale() {
         assertConnection(this);
         return new Logscale(this);