@crowdstrike/foundry-js 0.2.2 → 0.5.0

package/dist/lib/navigation.d.ts

@@ -0,0 +1,18 @@
+import type FalconApi from '../api';
+import type { LocalData } from '../types';
+import type { NavigateToRequestMessage } from '../types';
+declare const ALLOWED_TARGETS: readonly ["_self", "_blank"];
+export declare class Navigation<DATA extends LocalData = LocalData> {
+    private readonly falcon;
+    constructor(falcon: FalconApi<DATA>);
+    navigateTo({ path, type, target, metaKey, ctrlKey, shiftKey, }: {
+        path: string;
+        target?: NavigateToRequestMessage['payload']['target'];
+        type?: NavigateToRequestMessage['payload']['type'];
+        metaKey?: boolean;
+        ctrlKey?: boolean;
+        shiftKey?: boolean;
+    }): Promise<void>;
+    onClick(event: MouseEvent | KeyboardEvent, defaultTarget?: (typeof ALLOWED_TARGETS)[number], defaultType?: NavigateToRequestMessage['payload']['type']): Promise<void>;
+}
+export {};

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

@@ -0,0 +1,9 @@
+import type { Bridge } from '../bridge';
+import type { LocalData } from '../types';
+export declare class ResizeTracker<DATA extends LocalData = LocalData> {
+    private bridge;
+    private observer;
+    constructor(bridge: Bridge<DATA>);
+    private handleResizeEvent;
+    destroy(): void;
+}

package/dist/lib/ui.d.ts

@@ -0,0 +1,8 @@
+import type { Bridge } from '../bridge';
+import type { ExtensionIdentifier, LocalData, OpenModalOptions } from '../types';
+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>;
+    closeModal<PAYLOAD = unknown>(payload?: PAYLOAD): void;
+}

package/dist/types.d.ts

@@ -1,12 +1,11 @@
 import type { ApiIdentifier } from './apis/available-apis';
-import { GetQueriesIncidentsV1RequestMessage, GetQueriesIncidentsV1ResponseMessage, IncidentsApiRequestMessage, IncidentsApiResponseMessage, PostEntitiesIncidentsGetV1RequestMessage, PostEntitiesIncidentsGetV1ResponseMessage } from './apis/incidents/types';
-import { GetQueriesScriptsV1RequestMessage, GetQueriesScriptsV1ResponseMessage, PostEntitiesScriptsGetV2RequestMessage, PostEntitiesScriptsGetV2ResponseMessage, RemoteResponseApiRequestMessage, RemoteResponseApiResponseMessage } from './apis/remote-response/types';
+import type { ApiRequestMessage, ApiResponseMessage } from './apis/types';
+import type { PostEntitiesPutFilesGetV1ApiResponse } from './apis/remote-response';
 export type QueryParam = string | number | string[] | number[] | boolean;
 export interface BaseUrlParams {
     [key: string]: QueryParam | undefined;
 }
-export type LocalData = unknown;
-export type MessageType = 'connect' | 'api' | 'data';
+export type MessageType = 'connect' | 'navigateTo' | 'loggingapi' | 'api' | 'data' | 'broadcast' | 'fileUpload' | 'collection' | 'livereload' | 'resize' | 'openModal' | 'closeModal';
 export interface BaseMessage {
     type: MessageType;
     payload?: unknown;
@@ -21,10 +20,124 @@ export interface ConnectResponseMessage<DATA extends LocalData = LocalData> exte
         data?: DATA;
     };
 }
+export type Theme = 'theme-light' | 'theme-dark';
+export interface LocalData {
+    theme: Theme;
+    cid: string;
+    locale: string;
+    timezone?: string;
+    dateFormat?: string;
+    [key: string]: unknown;
+}
 export interface DataUpdateMessage<DATA extends LocalData = LocalData> extends BaseMessage {
     type: 'data';
     payload: DATA;
 }
+export interface ResizeMessage extends BaseMessage {
+    type: 'resize';
+    payload: {
+        height: number;
+    };
+}
+export interface LogscaleRequestMessage extends BaseMessage {
+    type: 'loggingapi';
+    payload: {
+        type: 'ingest' | 'dynamic-execute' | 'saved-query-execute';
+        data: Record<string, unknown>;
+        tag?: string;
+        tagSource?: string;
+        testData?: boolean;
+    };
+}
+export interface LogscaleResponseMessage extends BaseMessage {
+    type: 'loggingapi';
+    payload: unknown;
+}
+export interface NavigateToRequestMessage extends BaseMessage {
+    type: 'navigateTo';
+    payload: {
+        path: string;
+        type: 'internal' | 'falcon';
+        target: '_self' | '_blank';
+        metaKey: boolean;
+        ctrlKey: boolean;
+        shiftKey: boolean;
+    };
+}
+export interface NavigateToResponseMessage extends BaseMessage {
+    type: 'navigateTo';
+}
+export interface CollectionRequestMessage extends BaseMessage {
+    type: 'collection';
+    payload: {
+        type: 'write';
+        key: string;
+        collection: string;
+        data: Record<string, unknown>;
+    } | {
+        type: 'search';
+        startKey: string;
+        endKey: string;
+        limit: string;
+        collection: string;
+    } | {
+        type: 'read' | 'delete';
+        key: string;
+        collection: string;
+    };
+}
+export interface CollectionResponseMessage extends BaseMessage {
+    type: 'collection';
+    payload: unknown;
+}
+export interface OpenModalOptions {
+    path?: string;
+    data?: Record<string, unknown>;
+    align?: 'top';
+    size?: 'sm' | 'md' | 'lg' | 'xl';
+}
+export interface OpenModalRequestMessage extends BaseMessage {
+    type: 'openModal';
+    payload: {
+        extension: ExtensionIdentifier;
+        title: string;
+        options: OpenModalOptions;
+    };
+}
+export interface CloseModalRequestMessage<PAYLOAD = unknown> extends BaseMessage {
+    type: 'closeModal';
+    payload: PAYLOAD;
+}
+export interface OpenModalResponseMessage<PAYLOAD = unknown> extends BaseMessage {
+    type: 'openModal';
+    payload: PAYLOAD;
+}
+export interface BroadcastMessage<PAYLOAD = unknown> extends BaseMessage {
+    type: 'broadcast';
+    payload: PAYLOAD;
+}
+export interface LivereloadMessage extends BaseMessage {
+    type: 'livereload';
+}
+export type FileUploadType = 'remote-response';
+export interface RtrFileUploadPayload {
+    name?: string;
+    description?: string;
+    comments_for_audit_log?: string;
+}
+export type RtrFileUploadResponse = PostEntitiesPutFilesGetV1ApiResponse;
+export type PayloadForFileUploadType<TYPE extends FileUploadType> = TYPE extends 'remote-response' ? RtrFileUploadPayload : never;
+export type ResponseForFileUploadType<TYPE extends FileUploadType> = TYPE extends 'remote-response' ? RtrFileUploadResponse : never;
+export interface FileUploadRequestMessage<T extends FileUploadType = FileUploadType> extends BaseMessage {
+    type: 'fileUpload';
+    fileUploadType: T;
+    payload?: PayloadForFileUploadType<T>;
+}
+export interface FileUploadResponseMessage<T extends FileUploadType = FileUploadType> extends BaseMessage {
+    type: 'fileUpload';
+    fileUploadType: T;
+    payload?: ResponseForFileUploadType<T>;
+}
 export interface ApiRequestGetPayload<PARAMS extends BaseUrlParams = BaseUrlParams> {
     params: PARAMS;
 }
@@ -52,10 +165,6 @@ export interface BaseApiResponseMessage<T = unknown> extends BaseMessage {
     type: 'api';
     payload: T;
 }
-export type ApiRequestMessage = IncidentsApiRequestMessage | RemoteResponseApiRequestMessage;
-export type RequestMessage = ConnectRequestMessage | ApiRequestMessage;
-export type ApiResponseMessage = IncidentsApiResponseMessage | RemoteResponseApiResponseMessage;
-export type ResponseMessage<DATA extends LocalData = LocalData> = ConnectResponseMessage<DATA> | ApiResponseMessage | DataUpdateMessage<DATA>;
 export interface MessageMetadata {
     messageId: string;
     version?: string;
@@ -64,6 +173,16 @@ export interface MessageEnvelope<M> {
     message: M;
     meta: MessageMetadata;
 }
-export type ResponseFor<REQ extends RequestMessage, DATA extends LocalData> = REQ extends ConnectRequestMessage ? ConnectResponseMessage<DATA> : REQ extends GetQueriesIncidentsV1RequestMessage ? GetQueriesIncidentsV1ResponseMessage : REQ extends PostEntitiesIncidentsGetV1RequestMessage ? PostEntitiesIncidentsGetV1ResponseMessage : REQ extends GetQueriesScriptsV1RequestMessage ? GetQueriesScriptsV1ResponseMessage : REQ extends PostEntitiesScriptsGetV2RequestMessage ? PostEntitiesScriptsGetV2ResponseMessage : unknown;
-export type PayloadOf<RESPONSE extends ResponseMessage> = RESPONSE['payload'];
+export type UnidirectionalRequestMessage = BroadcastMessage | ResizeMessage | CloseModalRequestMessage;
+export type RequestMessage = ConnectRequestMessage | NavigateToRequestMessage | CollectionRequestMessage | ApiRequestMessage | FileUploadRequestMessage | LogscaleRequestMessage | OpenModalRequestMessage;
 export { ApiIdentifier };
+export type ResponseMessage<DATA extends LocalData = LocalData> = ConnectResponseMessage<DATA> | NavigateToResponseMessage | ApiResponseMessage | DataUpdateMessage<DATA> | BroadcastMessage | FileUploadResponseMessage | CollectionResponseMessage | LivereloadMessage | LogscaleResponseMessage | OpenModalResponseMessage;
+import type { ResponseFor as ApiResponseFor } from './apis/types-response-for';
+type ResponseFor<REQ extends RequestMessage, DATA extends LocalData> = REQ extends ConnectRequestMessage ? ConnectResponseMessage<DATA> : REQ extends NavigateToRequestMessage ? NavigateToResponseMessage : REQ extends CollectionRequestMessage ? CollectionResponseMessage : REQ extends LogscaleRequestMessage ? LogscaleResponseMessage : REQ extends FileUploadRequestMessage<infer FILEUPLOADTYPE> ? FileUploadResponseMessage<FILEUPLOADTYPE> : REQ extends OpenModalRequestMessage ? OpenModalResponseMessage : ApiResponseFor<REQ>;
+export { ResponseFor };
+export type PayloadOf<RESPONSE extends ResponseMessage> = RESPONSE['payload'];
+export type ExtensionType = 'extension' | 'page';
+export interface ExtensionIdentifier {
+    type: ExtensionType;
+    id: string;
+}

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import { LocalData, MessageEnvelope, ResponseMessage } from './types';
-import FalconPublicApis from './apis/public-api';
+import type FalconPublicApis from './apis/public-api';
+import type { LocalData, MessageEnvelope, ResponseMessage } from './types';
 export declare function assertConnection(falcon: FalconPublicApis): void;
 export declare function isValidResponse<DATA extends LocalData>(event: MessageEvent<MessageEnvelope<ResponseMessage<DATA>> | any>): event is MessageEvent<MessageEnvelope<ResponseMessage<DATA>>>;

package/package.json

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

package/dist/apis/incidents/bridge.d.ts

@@ -1,15 +0,0 @@
-/**
- *
- * This file is autogenerated.
- *
- * DO NOT EDIT DIRECTLY
- *
- **/
-import type { Bridge } from '../../bridge';
-import type { GetQueriesIncidentsV1ApiResponse, GetQueriesIncidentsV1QueryParams, PostEntitiesIncidentsGetV1ApiResponse, PostEntitiesIncidentsGetV1PostData, PostEntitiesIncidentsGetV1QueryParams } from './types';
-export declare class IncidentsApiBridge {
-    private bridge;
-    constructor(bridge: Bridge);
-    getIncidentIds(urlParams?: GetQueriesIncidentsV1QueryParams): Promise<GetQueriesIncidentsV1ApiResponse>;
-    getIncidentEntities(postBody: PostEntitiesIncidentsGetV1PostData, urlParams?: PostEntitiesIncidentsGetV1QueryParams): Promise<PostEntitiesIncidentsGetV1ApiResponse>;
-}

package/dist/apis/incidents/types.d.ts

@@ -1,33 +0,0 @@
-/**
- *
- * This file is autogenerated.
- *
- * DO NOT EDIT DIRECTLY
- *
- **/
-import type { BaseApiRequestMessage, BaseApiResponseMessage, ApiResponsePayload, BaseUrlParams, QueryParam } from '../../types';
-export type IncidentsRequestApi = 'incidents';
-export interface GetQueriesIncidentsV1QueryParams extends BaseUrlParams {
-    filter?: string;
-    limit?: QueryParam;
-    offset?: QueryParam;
-    sort?: QueryParam;
-}
-export type GetQueriesIncidentsV1ApiResponse = ApiResponsePayload<string>;
-export interface GetQueriesIncidentsV1RequestMessage extends BaseApiRequestMessage<GetQueriesIncidentsV1QueryParams> {
-    api: IncidentsRequestApi;
-    method: 'getQueriesIncidentsV1';
-}
-export type GetQueriesIncidentsV1ResponseMessage = BaseApiResponseMessage<GetQueriesIncidentsV1ApiResponse>;
-export interface PostEntitiesIncidentsGetV1QueryParams extends BaseUrlParams {
-}
-export interface PostEntitiesIncidentsGetV1PostData {
-}
-export type PostEntitiesIncidentsGetV1ApiResponse = ApiResponsePayload<any>;
-export interface PostEntitiesIncidentsGetV1RequestMessage extends BaseApiRequestMessage<PostEntitiesIncidentsGetV1QueryParams, PostEntitiesIncidentsGetV1PostData> {
-    api: IncidentsRequestApi;
-    method: 'postEntitiesIncidentsGetV1';
-}
-export type PostEntitiesIncidentsGetV1ResponseMessage = BaseApiResponseMessage<PostEntitiesIncidentsGetV1ApiResponse>;
-export type IncidentsApiRequestMessage = GetQueriesIncidentsV1RequestMessage | PostEntitiesIncidentsGetV1RequestMessage;
-export type IncidentsApiResponseMessage = GetQueriesIncidentsV1ResponseMessage | PostEntitiesIncidentsGetV1ResponseMessage;

package/dist/apis/remote-response/bridge.d.ts

@@ -1,15 +0,0 @@
-/**
- *
- * This file is autogenerated.
- *
- * DO NOT EDIT DIRECTLY
- *
- **/
-import type { Bridge } from '../../bridge';
-import { GetQueriesScriptsV1ApiResponse, GetQueriesScriptsV1QueryParams, PostEntitiesScriptsGetV2ApiResponse, PostEntitiesScriptsGetV2PostData, PostEntitiesScriptsGetV2QueryParams } from './types';
-export declare class RemoteResponseApiBridge {
-    private bridge;
-    constructor(bridge: Bridge);
-    getScriptIds(urlParams?: GetQueriesScriptsV1QueryParams): Promise<GetQueriesScriptsV1ApiResponse>;
-    getScriptEntities(postBody: PostEntitiesScriptsGetV2PostData, urlParams?: PostEntitiesScriptsGetV2QueryParams): Promise<PostEntitiesScriptsGetV2ApiResponse>;
-}

package/dist/apis/remote-response/types.d.ts

@@ -1,33 +0,0 @@
-/**
- *
- * This file is autogenerated.
- *
- * DO NOT EDIT DIRECTLY
- *
- **/
-import type { BaseApiRequestMessage, BaseApiResponseMessage, ApiResponsePayload, BaseUrlParams, QueryParam } from '../../types';
-export type RemoteResponseRequestApi = 'remoteResponse';
-export interface GetQueriesScriptsV1QueryParams extends BaseUrlParams {
-    filter?: string;
-    limit?: QueryParam;
-    offset?: QueryParam;
-    sort?: QueryParam;
-}
-export type GetQueriesScriptsV1ApiResponse = ApiResponsePayload<string>;
-export interface GetQueriesScriptsV1RequestMessage extends BaseApiRequestMessage<GetQueriesScriptsV1QueryParams> {
-    api: RemoteResponseRequestApi;
-    method: 'getQueriesScriptsV1';
-}
-export type GetQueriesScriptsV1ResponseMessage = BaseApiResponseMessage<GetQueriesScriptsV1ApiResponse>;
-export interface PostEntitiesScriptsGetV2QueryParams extends BaseUrlParams {
-}
-export interface PostEntitiesScriptsGetV2PostData {
-}
-export type PostEntitiesScriptsGetV2ApiResponse = ApiResponsePayload<any>;
-export interface PostEntitiesScriptsGetV2RequestMessage extends BaseApiRequestMessage<PostEntitiesScriptsGetV2QueryParams, PostEntitiesScriptsGetV2PostData> {
-    api: RemoteResponseRequestApi;
-    method: 'postEntitiesScriptsGetV2';
-}
-export type PostEntitiesScriptsGetV2ResponseMessage = BaseApiResponseMessage<PostEntitiesScriptsGetV2ApiResponse>;
-export type RemoteResponseApiRequestMessage = GetQueriesScriptsV1RequestMessage | PostEntitiesScriptsGetV2RequestMessage;
-export type RemoteResponseApiResponseMessage = GetQueriesScriptsV1ResponseMessage | PostEntitiesScriptsGetV2ResponseMessage;