@crowdstrike/foundry-js 0.9.0 → 0.10.0

package/dist/lib/resize-tracker.d.ts

@@ -1,5 +1,8 @@
 import type { Bridge } from '../bridge';
 import type { LocalData } from '../types';
+/**
+ * @internal
+ */
 export declare class ResizeTracker<DATA extends LocalData = LocalData> {
     private bridge;
     private observer;

package/dist/lib/ui.d.ts

@@ -1,9 +1,40 @@
 import type { Bridge } from '../bridge';
 import type { ExtensionIdentifier, FileUploadType, LocalData, OpenModalOptions, PayloadForFileUploadType, ResponseForFileUploadType } from '../types';
+/**
+ * Invoke UI features within the main Falcon Console.
+ */
 export declare class UI<DATA extends LocalData = LocalData> {
     private bridge;
     constructor(bridge: Bridge<DATA>);
-    openModal<PAYLOAD = unknown>(extension: ExtensionIdentifier, title: string, options?: OpenModalOptions): Promise<PAYLOAD>;
+    /**
+     * 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
+     */
+    openModal<PAYLOAD = unknown>(extension: ExtensionIdentifier, title: string, options?: OpenModalOptions): Promise<PAYLOAD | undefined>;
+    /**
+     * 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 = unknown>(payload?: PAYLOAD): void;
+    /**
+     * 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
+     */
     uploadFile<TYPE extends FileUploadType>(fileUploadType: TYPE, initialData?: PayloadForFileUploadType<TYPE>): Promise<ResponseForFileUploadType<TYPE> | undefined>;
 }

package/dist/types.d.ts

@@ -25,15 +25,36 @@ export interface UserData {
     uuid: string;
     username: string;
 }
+/**
+ * The minimum {@link FalconApi.data} every UI extension receives from the Falcon Console.
+ */
 export interface LocalData {
     app: {
         id: string;
     };
+    /**
+     * Details of the currently signed in user
+     */
     user: UserData;
+    /**
+     * The current light or dark mode in the Falcon Console
+     */
     theme: Theme;
+    /**
+     * Current customer ID
+     */
     cid: string;
+    /**
+     * The locale of the current user, e.g. 'en-us'
+     */
     locale: string;
+    /**
+     * Timezone of the current user, e.g. 'America/New_York'
+     */
     timezone?: string;
+    /**
+     * The date format preferred by the current user, in a [`moment.js` format](https://momentjs.com/docs/#/displaying/format/)
+     */
     dateFormat?: string;
     [key: string]: unknown;
 }
@@ -130,8 +151,17 @@ export interface CollectionResponseMessage extends BaseMessage {
 }
 export interface OpenModalOptions {
     path?: string;
+    /**
+     * additional local data to pass to the modal's extension
+     */
     data?: Record<string, unknown>;
+    /**
+     * Vertical alignment of the modal, "top" or undefined (Default is center)
+     */
     align?: 'top';
+    /**
+     * Width of the modal (Default is "md")
+     */
     size?: 'sm' | 'md' | 'lg' | 'xl';
 }
 export interface OpenModalRequestMessage extends BaseMessage {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdstrike/foundry-js",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "foundry.js is the JavaScript SDK for authoring UI Extensions for CrowdStrike's Foundry platform.",
   "repository": {
     "type": "git",

package/dist/apis/actors/index.d.ts

@@ -1,77 +0,0 @@
-/**
- *
- * This file is autogenerated.
- *
- * DO NOT EDIT DIRECTLY
- *
- **/
-import type { Bridge } from '../../bridge';
-import type { ApiResponsePayload, BaseApiRequestMessage, BaseApiResponseMessage, BaseUrlParams, QueryParam } from '../../types';
-export type ActorsRequestApi = 'actors';
-export type CommonApiResponseMessage = BaseApiResponseMessage<ApiResponsePayload>;
-export interface CommonApiRequestMessage extends BaseApiRequestMessage<BaseUrlParams, unknown> {
-    api: ActorsRequestApi;
-}
-export interface GetEntitiesActorsGetV2QueryParams extends BaseUrlParams {
-    ids?: QueryParam;
-}
-export type GetEntitiesActorsGetV2ApiResponse = ApiResponsePayload;
-export type GetEntitiesActorsGetV2ResponseMessage = BaseApiResponseMessage<GetEntitiesActorsGetV2ApiResponse>;
-export interface GetEntitiesActorsGetV2RequestMessage extends BaseApiRequestMessage<GetEntitiesActorsGetV2QueryParams> {
-    api: ActorsRequestApi;
-    method: 'getEntitiesActorsGetV2';
-}
-export interface GetQueriesActorsV2QueryParams extends BaseUrlParams {
-    filter?: string;
-    limit?: QueryParam;
-    offset?: QueryParam;
-    q?: QueryParam;
-    sort?: QueryParam;
-}
-export type GetQueriesActorsV2ApiResponse = ApiResponsePayload;
-export type GetQueriesActorsV2ResponseMessage = BaseApiResponseMessage<GetQueriesActorsV2ApiResponse>;
-export interface GetQueriesActorsV2RequestMessage extends BaseApiRequestMessage<GetQueriesActorsV2QueryParams> {
-    api: ActorsRequestApi;
-    method: 'getQueriesActorsV2';
-}
-export type PostAggregatesActorsGetV2QueryParams = BaseUrlParams;
-export type PostAggregatesActorsGetV2ApiResponse = ApiResponsePayload;
-export interface PostAggregatesActorsGetV2PostData {
-}
-export type PostAggregatesActorsGetV2ResponseMessage = BaseApiResponseMessage<PostAggregatesActorsGetV2ApiResponse>;
-export interface PostAggregatesActorsGetV2RequestMessage extends BaseApiRequestMessage<PostAggregatesActorsGetV2QueryParams, PostAggregatesActorsGetV2PostData> {
-    api: ActorsRequestApi;
-    method: 'postAggregatesActorsGetV2';
-}
-export interface PostEntitiesActorsGetV2QueryParams extends BaseUrlParams {
-    ids?: QueryParam;
-}
-export type PostEntitiesActorsGetV2ApiResponse = ApiResponsePayload;
-export interface PostEntitiesActorsGetV2PostData {
-}
-export type PostEntitiesActorsGetV2ResponseMessage = BaseApiResponseMessage<PostEntitiesActorsGetV2ApiResponse>;
-export interface PostEntitiesActorsGetV2RequestMessage extends BaseApiRequestMessage<PostEntitiesActorsGetV2QueryParams, PostEntitiesActorsGetV2PostData> {
-    api: ActorsRequestApi;
-    method: 'postEntitiesActorsGetV2';
-}
-export type PostEntitiesMitreV1QueryParams = BaseUrlParams;
-export type PostEntitiesMitreV1ApiResponse = ApiResponsePayload;
-export interface PostEntitiesMitreV1PostData {
-}
-export type PostEntitiesMitreV1ResponseMessage = BaseApiResponseMessage<PostEntitiesMitreV1ApiResponse>;
-export interface PostEntitiesMitreV1RequestMessage extends BaseApiRequestMessage<PostEntitiesMitreV1QueryParams, PostEntitiesMitreV1PostData> {
-    api: ActorsRequestApi;
-    method: 'postEntitiesMitreV1';
-}
-export type ActorsApiRequestMessage = GetEntitiesActorsGetV2RequestMessage | GetQueriesActorsV2RequestMessage | PostAggregatesActorsGetV2RequestMessage | PostEntitiesActorsGetV2RequestMessage | PostEntitiesMitreV1RequestMessage;
-export type ActorsApiResponseMessage = GetEntitiesActorsGetV2ResponseMessage | GetQueriesActorsV2ResponseMessage | PostAggregatesActorsGetV2ResponseMessage | PostEntitiesActorsGetV2ResponseMessage | PostEntitiesMitreV1ResponseMessage;
-export declare class ActorsApiBridge {
-    private bridge;
-    constructor(bridge: Bridge);
-    getBridge(): Bridge<import("../../types").LocalData>;
-    getEntitiesActorsGetV2(urlParams?: GetEntitiesActorsGetV2QueryParams): Promise<GetEntitiesActorsGetV2ApiResponse>;
-    getQueriesActorsV2(urlParams?: GetQueriesActorsV2QueryParams): Promise<GetQueriesActorsV2ApiResponse>;
-    postAggregatesActorsGetV2(postBody: PostAggregatesActorsGetV2PostData, urlParams?: PostAggregatesActorsGetV2QueryParams): Promise<PostAggregatesActorsGetV2ApiResponse>;
-    postEntitiesActorsGetV2(postBody: PostEntitiesActorsGetV2PostData, urlParams?: PostEntitiesActorsGetV2QueryParams): Promise<PostEntitiesActorsGetV2ApiResponse>;
-    postEntitiesMitreV1(postBody: PostEntitiesMitreV1PostData, urlParams?: PostEntitiesMitreV1QueryParams): Promise<PostEntitiesMitreV1ApiResponse>;
-}