@crowdstrike/foundry-js 0.2.2

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 CrowdStrike
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+# @crowdstrike/foundry-js
+
+`foundry.js` is the JavaScript SDK for authoring UI Extensions for CrowdStrike's Foundry platform.
+
+## Installation
+
+```sh
+npm install @crowdstrike/foundry-js
+# or
+yarn add @crowdstrike/foundry-js
+# or
+pnpm add @crowdstrike/foundry-js
+```
+
+## Usage
+
+> TODO

package/dist/api.d.ts

@@ -0,0 +1,16 @@
+import { LocalData } from 'types';
+import FalconPublicApis from './apis/public-api';
+import Emittery from 'emittery';
+import { Bridge } from './bridge';
+interface EventMap<DATA extends LocalData> {
+    data: DATA;
+}
+export default class FalconApi<DATA extends LocalData = LocalData> extends FalconPublicApis {
+    events: Emittery<EventMap<DATA>, EventMap<DATA> & import("emittery").OmnipresentEventData, DATA extends undefined ? "data" : never>;
+    data?: DATA;
+    bridge: Bridge<DATA>;
+    connect(): Promise<void>;
+    private handleDataUpdate;
+    destroy(): void;
+}
+export {};

package/dist/apis/available-apis.d.ts

@@ -0,0 +1,15 @@
+/**
+ *
+ * This file is autogenerated from the available APIs for App Platform.
+ *
+ * DO NOT EDIT DIRECTLY
+ *
+ * If you need to change the contents of this file please edit the above configuration file and
+ * then run:
+ *
+ * ```
+ * yarn cs-gen platform-apis
+ * ```
+ *
+ **/
+export type ApiIdentifier = 'incidents' | 'remoteResponse';

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

@@ -0,0 +1,15 @@
+/**
+ *
+ * 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

@@ -0,0 +1,33 @@
+/**
+ *
+ * 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/public-api.d.ts

@@ -0,0 +1,23 @@
+/**
+ *
+ * This file is autogenerated from the available APIs for App Platform.
+ *
+ * DO NOT EDIT DIRECTLY
+ *
+ * If you need to change the contents of this file please edit the above configuration file and
+ * then run:
+ *
+ * ```
+ * yarn cs-gen platform-apis
+ * ```
+ *
+ **/
+import { IncidentsApiBridge } from './incidents/bridge';
+import { RemoteResponseApiBridge } from './remote-response/bridge';
+import { Bridge } from '../bridge';
+export default abstract class FalconPublicApis {
+    isConnected: boolean;
+    abstract bridge: Bridge<any>;
+    get incidents(): IncidentsApiBridge;
+    get remoteResponse(): RemoteResponseApiBridge;
+}

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

@@ -0,0 +1,15 @@
+/**
+ *
+ * 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

@@ -0,0 +1,33 @@
+/**
+ *
+ * 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;

package/dist/apis/types.d.ts

@@ -0,0 +1,2 @@
+export * from './incidents/types';
+export * from './remote-response/types';

package/dist/apis/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "current";

package/dist/bridge.d.ts

@@ -0,0 +1,15 @@
+import type { DataUpdateMessage, LocalData, PayloadOf, RequestMessage, ResponseFor } from './types';
+interface BridgeOptions<DATA extends LocalData> {
+    onDataUpdate?: (event: DataUpdateMessage<DATA>) => void;
+}
+export declare class Bridge<DATA extends LocalData = LocalData> {
+    private onDataUpdate;
+    private pendingMessages;
+    private targetOrigin;
+    constructor({ onDataUpdate }?: BridgeOptions<DATA>);
+    destroy(): void;
+    setOrigin(origin: string): void;
+    postMessage<REQ extends RequestMessage>(message: REQ): Promise<PayloadOf<ResponseFor<REQ, DATA>>>;
+    private handleMessage;
+}
+export {};

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from './api';
+export * from './types';
+export * from './apis/types';