@crowdstrike/foundry-js 0.2.2 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/dist/abstraction/api-integration.d.ts +23 -0
  2. package/dist/abstraction/cloud-function.d.ts +49 -0
  3. package/dist/abstraction/collection.d.ts +20 -0
  4. package/dist/abstraction/logscale.d.ts +14 -0
  5. package/dist/api.d.ts +32 -2
  6. package/dist/apis/actors/index.d.ts +77 -0
  7. package/dist/apis/alerts/index.d.ts +126 -0
  8. package/dist/apis/available-apis.d.ts +1 -1
  9. package/dist/apis/customobjects/index.d.ts +89 -0
  10. package/dist/apis/detects/index.d.ts +93 -0
  11. package/dist/apis/devices/index.d.ts +270 -0
  12. package/dist/apis/faas-gateway/index.d.ts +41 -0
  13. package/dist/apis/fwmgr/index.d.ts +407 -0
  14. package/dist/apis/incidents/index.d.ts +112 -0
  15. package/dist/apis/loggingapi/index.d.ts +68 -0
  16. package/dist/apis/mitre/index.d.ts +31 -0
  17. package/dist/apis/plugins/index.d.ts +52 -0
  18. package/dist/apis/public-api.d.ts +25 -3
  19. package/dist/apis/remote-response/index.d.ts +74 -0
  20. package/dist/apis/types-response-for.d.ts +29 -0
  21. package/dist/apis/types.d.ts +30 -2
  22. package/dist/apis/workflows/index.d.ts +58 -0
  23. package/dist/bridge.d.ts +8 -3
  24. package/dist/index.d.ts +2 -1
  25. package/dist/index.js +2210 -332
  26. package/dist/index.js.map +1 -1
  27. package/dist/lib/navigation.d.ts +18 -0
  28. package/dist/lib/resize-tracker.d.ts +9 -0
  29. package/dist/lib/ui.d.ts +8 -0
  30. package/dist/types.d.ts +129 -10
  31. package/dist/utils.d.ts +2 -2
  32. package/package.json +5 -1
  33. package/dist/apis/incidents/bridge.d.ts +0 -15
  34. package/dist/apis/incidents/types.d.ts +0 -33
  35. package/dist/apis/remote-response/bridge.d.ts +0 -15
  36. package/dist/apis/remote-response/types.d.ts +0 -33
@@ -0,0 +1,52 @@
1
+ /**
2
+ *
3
+ * This file is autogenerated.
4
+ *
5
+ * DO NOT EDIT DIRECTLY
6
+ *
7
+ **/
8
+ import type { Bridge } from '../../bridge';
9
+ import type { ApiResponsePayload, BaseApiRequestMessage, BaseApiResponseMessage, BaseUrlParams, QueryParam } from '../../types';
10
+ export type PluginsRequestApi = 'plugins';
11
+ export type CommonApiResponseMessage = BaseApiResponseMessage<ApiResponsePayload>;
12
+ export interface CommonApiRequestMessage extends BaseApiRequestMessage<BaseUrlParams, unknown> {
13
+ api: PluginsRequestApi;
14
+ }
15
+ export interface GetEntitiesConfigsV1QueryParams extends BaseUrlParams {
16
+ ids?: QueryParam;
17
+ appId?: QueryParam;
18
+ }
19
+ export type GetEntitiesConfigsV1ApiResponse = ApiResponsePayload;
20
+ export type GetEntitiesConfigsV1ResponseMessage = BaseApiResponseMessage<GetEntitiesConfigsV1ApiResponse>;
21
+ export interface GetEntitiesConfigsV1RequestMessage extends BaseApiRequestMessage<GetEntitiesConfigsV1QueryParams> {
22
+ api: PluginsRequestApi;
23
+ method: 'getEntitiesConfigsV1';
24
+ }
25
+ export type PostEntitiesExecuteDraftV1QueryParams = BaseUrlParams;
26
+ export type PostEntitiesExecuteDraftV1ApiResponse = ApiResponsePayload;
27
+ export interface PostEntitiesExecuteDraftV1PostData {
28
+ }
29
+ export type PostEntitiesExecuteDraftV1ResponseMessage = BaseApiResponseMessage<PostEntitiesExecuteDraftV1ApiResponse>;
30
+ export interface PostEntitiesExecuteDraftV1RequestMessage extends BaseApiRequestMessage<PostEntitiesExecuteDraftV1QueryParams, PostEntitiesExecuteDraftV1PostData> {
31
+ api: PluginsRequestApi;
32
+ method: 'postEntitiesExecuteDraftV1';
33
+ }
34
+ export type PostEntitiesExecuteV1QueryParams = BaseUrlParams;
35
+ export type PostEntitiesExecuteV1ApiResponse = ApiResponsePayload;
36
+ export interface PostEntitiesExecuteV1PostData {
37
+ }
38
+ export type PostEntitiesExecuteV1ResponseMessage = BaseApiResponseMessage<PostEntitiesExecuteV1ApiResponse>;
39
+ export interface PostEntitiesExecuteV1RequestMessage extends BaseApiRequestMessage<PostEntitiesExecuteV1QueryParams, PostEntitiesExecuteV1PostData> {
40
+ api: PluginsRequestApi;
41
+ method: 'postEntitiesExecuteV1';
42
+ }
43
+ export type PluginsApiRequestMessage = GetEntitiesConfigsV1RequestMessage | PostEntitiesExecuteDraftV1RequestMessage | PostEntitiesExecuteV1RequestMessage;
44
+ export type PluginsApiResponseMessage = GetEntitiesConfigsV1ResponseMessage | PostEntitiesExecuteDraftV1ResponseMessage | PostEntitiesExecuteV1ResponseMessage;
45
+ export declare class PluginsApiBridge {
46
+ private bridge;
47
+ constructor(bridge: Bridge);
48
+ getBridge(): Bridge<import("../../types").LocalData>;
49
+ getEntitiesConfigsV1(urlParams?: GetEntitiesConfigsV1QueryParams): Promise<GetEntitiesConfigsV1ApiResponse>;
50
+ postEntitiesExecuteDraftV1(postBody: PostEntitiesExecuteDraftV1PostData, urlParams?: PostEntitiesExecuteDraftV1QueryParams): Promise<PostEntitiesExecuteDraftV1ApiResponse>;
51
+ postEntitiesExecuteV1(postBody: PostEntitiesExecuteV1PostData, urlParams?: PostEntitiesExecuteV1QueryParams): Promise<PostEntitiesExecuteV1ApiResponse>;
52
+ }
@@ -12,12 +12,34 @@
12
12
  * ```
13
13
  *
14
14
  **/
15
- import { IncidentsApiBridge } from './incidents/bridge';
16
- import { RemoteResponseApiBridge } from './remote-response/bridge';
17
- import { Bridge } from '../bridge';
15
+ import { ActorsApiBridge } from './actors';
16
+ import { AlertsApiBridge } from './alerts';
17
+ import { CustomobjectsApiBridge } from './customobjects';
18
+ import { DetectsApiBridge } from './detects';
19
+ import { DevicesApiBridge } from './devices';
20
+ import { FaasGatewayApiBridge } from './faas-gateway';
21
+ import { FwmgrApiBridge } from './fwmgr';
22
+ import { IncidentsApiBridge } from './incidents';
23
+ import { LoggingapiApiBridge } from './loggingapi';
24
+ import { MitreApiBridge } from './mitre';
25
+ import { PluginsApiBridge } from './plugins';
26
+ import { RemoteResponseApiBridge } from './remote-response';
27
+ import { WorkflowsApiBridge } from './workflows';
28
+ import type { Bridge } from '../bridge';
18
29
  export default abstract class FalconPublicApis {
19
30
  isConnected: boolean;
20
31
  abstract bridge: Bridge<any>;
32
+ get actors(): ActorsApiBridge;
33
+ get alerts(): AlertsApiBridge;
34
+ get detects(): DetectsApiBridge;
35
+ get devices(): DevicesApiBridge;
36
+ get fwmgr(): FwmgrApiBridge;
21
37
  get incidents(): IncidentsApiBridge;
38
+ get mitre(): MitreApiBridge;
39
+ get plugins(): PluginsApiBridge;
22
40
  get remoteResponse(): RemoteResponseApiBridge;
41
+ get workflows(): WorkflowsApiBridge;
42
+ get customobjects(): CustomobjectsApiBridge;
43
+ get faasGateway(): FaasGatewayApiBridge;
44
+ get loggingapi(): LoggingapiApiBridge;
23
45
  }
@@ -0,0 +1,74 @@
1
+ /**
2
+ *
3
+ * This file is autogenerated.
4
+ *
5
+ * DO NOT EDIT DIRECTLY
6
+ *
7
+ **/
8
+ import type { Bridge } from '../../bridge';
9
+ import type { ApiResponsePayload, BaseApiRequestMessage, BaseApiResponseMessage, BaseUrlParams, QueryParam } from '../../types';
10
+ export type RemoteResponseRequestApi = 'remoteResponse';
11
+ export type CommonApiResponseMessage = BaseApiResponseMessage<ApiResponsePayload>;
12
+ export interface CommonApiRequestMessage extends BaseApiRequestMessage<BaseUrlParams, unknown> {
13
+ api: RemoteResponseRequestApi;
14
+ }
15
+ export interface GetQueriesPutFilesV1QueryParams extends BaseUrlParams {
16
+ filter?: string;
17
+ limit?: QueryParam;
18
+ offset?: QueryParam;
19
+ sort?: QueryParam;
20
+ }
21
+ export type GetQueriesPutFilesV1ApiResponse = ApiResponsePayload;
22
+ export type GetQueriesPutFilesV1ResponseMessage = BaseApiResponseMessage<GetQueriesPutFilesV1ApiResponse>;
23
+ export interface GetQueriesPutFilesV1RequestMessage extends BaseApiRequestMessage<GetQueriesPutFilesV1QueryParams> {
24
+ api: RemoteResponseRequestApi;
25
+ method: 'getQueriesPutFilesV1';
26
+ }
27
+ export interface GetQueriesScriptsV1QueryParams extends BaseUrlParams {
28
+ filter?: string;
29
+ limit?: QueryParam;
30
+ offset?: QueryParam;
31
+ sort?: QueryParam;
32
+ }
33
+ export type GetQueriesScriptsV1ApiResponse = ApiResponsePayload;
34
+ export type GetQueriesScriptsV1ResponseMessage = BaseApiResponseMessage<GetQueriesScriptsV1ApiResponse>;
35
+ export interface GetQueriesScriptsV1RequestMessage extends BaseApiRequestMessage<GetQueriesScriptsV1QueryParams> {
36
+ api: RemoteResponseRequestApi;
37
+ method: 'getQueriesScriptsV1';
38
+ }
39
+ export type PostEntitiesPutFilesGetV1QueryParams = BaseUrlParams;
40
+ export type PostEntitiesPutFilesGetV1ApiResponse = ApiResponsePayload;
41
+ export interface PostEntitiesPutFilesGetV1PostData {
42
+ }
43
+ export type PostEntitiesPutFilesGetV1ResponseMessage = BaseApiResponseMessage<PostEntitiesPutFilesGetV1ApiResponse>;
44
+ export interface PostEntitiesPutFilesGetV1RequestMessage extends BaseApiRequestMessage<PostEntitiesPutFilesGetV1QueryParams, PostEntitiesPutFilesGetV1PostData> {
45
+ api: RemoteResponseRequestApi;
46
+ method: 'postEntitiesPutFilesGetV1';
47
+ }
48
+ export type PostEntitiesPutFilesV1QueryParams = BaseUrlParams;
49
+ export type PostEntitiesPutFilesV1ApiResponse = ApiResponsePayload;
50
+ export interface PostEntitiesPutFilesV1PostData {
51
+ }
52
+ export type PostEntitiesPutFilesV1ResponseMessage = BaseApiResponseMessage<PostEntitiesPutFilesV1ApiResponse>;
53
+ export interface PostEntitiesPutFilesV1RequestMessage extends BaseApiRequestMessage<PostEntitiesPutFilesV1QueryParams, PostEntitiesPutFilesV1PostData> {
54
+ api: RemoteResponseRequestApi;
55
+ method: 'postEntitiesPutFilesV1';
56
+ }
57
+ export type PostEntitiesScriptsGetV2QueryParams = BaseUrlParams;
58
+ export type PostEntitiesScriptsGetV2ApiResponse = ApiResponsePayload;
59
+ export interface PostEntitiesScriptsGetV2PostData {
60
+ }
61
+ export type PostEntitiesScriptsGetV2ResponseMessage = BaseApiResponseMessage<PostEntitiesScriptsGetV2ApiResponse>;
62
+ export interface PostEntitiesScriptsGetV2RequestMessage extends BaseApiRequestMessage<PostEntitiesScriptsGetV2QueryParams, PostEntitiesScriptsGetV2PostData> {
63
+ api: RemoteResponseRequestApi;
64
+ method: 'postEntitiesScriptsGetV2';
65
+ }
66
+ export type RemoteResponseApiRequestMessage = GetQueriesScriptsV1RequestMessage | PostEntitiesScriptsGetV2RequestMessage;
67
+ export type RemoteResponseApiResponseMessage = GetQueriesScriptsV1ResponseMessage | PostEntitiesScriptsGetV2ResponseMessage;
68
+ export declare class RemoteResponseApiBridge {
69
+ private bridge;
70
+ constructor(bridge: Bridge);
71
+ getBridge(): Bridge<import("../../types").LocalData>;
72
+ getScriptIds(urlParams?: GetQueriesScriptsV1QueryParams): Promise<GetQueriesScriptsV1ApiResponse>;
73
+ getScriptEntities(postBody: PostEntitiesScriptsGetV2PostData, urlParams?: PostEntitiesScriptsGetV2QueryParams): Promise<PostEntitiesScriptsGetV2ApiResponse>;
74
+ }
@@ -0,0 +1,29 @@
1
+ /**
2
+ *
3
+ * This file is autogenerated from the available APIs for App Platform.
4
+ *
5
+ * DO NOT EDIT DIRECTLY
6
+ *
7
+ * If you need to change the contents of this file please edit the above configuration file and
8
+ * then run:
9
+ *
10
+ * ```
11
+ * yarn cs-gen platform-apis
12
+ * ```
13
+ *
14
+ **/
15
+ import type { RequestMessage } from '../types';
16
+ import type { GetEntitiesActorsGetV2RequestMessage as Request00, GetQueriesActorsV2RequestMessage as Request01, PostAggregatesActorsGetV2RequestMessage as Request02, PostEntitiesActorsGetV2RequestMessage as Request03, PostEntitiesMitreV1RequestMessage as Request04, GetEntitiesActorsGetV2ResponseMessage as Response00, GetQueriesActorsV2ResponseMessage as Response01, PostAggregatesActorsGetV2ResponseMessage as Response02, PostEntitiesActorsGetV2ResponseMessage as Response03, PostEntitiesMitreV1ResponseMessage as Response04 } from './actors';
17
+ import type { DeleteEntitiesSuppressedDevicesV1RequestMessage as Request10, GetQueriesAlertsV1RequestMessage as Request11, PatchCombinedAlertsV2RequestMessage as Request12, PatchEntitiesAlertsV2RequestMessage as Request13, PatchEntitiesSuppressedDevicesV1RequestMessage as Request14, PostAggregatesAlertsV1RequestMessage as Request15, PostEntitiesAlertsV1RequestMessage as Request16, PostEntitiesSuppressedDevicesV1RequestMessage as Request17, DeleteEntitiesSuppressedDevicesV1ResponseMessage as Response10, GetQueriesAlertsV1ResponseMessage as Response11, PatchCombinedAlertsV2ResponseMessage as Response12, PatchEntitiesAlertsV2ResponseMessage as Response13, PatchEntitiesSuppressedDevicesV1ResponseMessage as Response14, PostAggregatesAlertsV1ResponseMessage as Response15, PostEntitiesAlertsV1ResponseMessage as Response16, PostEntitiesSuppressedDevicesV1ResponseMessage as Response17 } from './alerts';
18
+ import type { GetEntitiesSuppressedDevicesV1RequestMessage as Request20, PatchEntitiesDetectsV2RequestMessage as Request21, PatchQueriesDetectsV1RequestMessage as Request22, PatchQueriesDetectsV2RequestMessage as Request23, PostAggregatesDetectsGetV1RequestMessage as Request24, PostEntitiesSummariesGetV1RequestMessage as Request25, PostEntitiesSuppressedDevicesV1RequestMessage as Request26, GetEntitiesSuppressedDevicesV1ResponseMessage as Response20, PatchEntitiesDetectsV2ResponseMessage as Response21, PatchQueriesDetectsV1ResponseMessage as Response22, PatchQueriesDetectsV2ResponseMessage as Response23, PostAggregatesDetectsGetV1ResponseMessage as Response24, PostEntitiesSummariesGetV1ResponseMessage as Response25, PostEntitiesSuppressedDevicesV1ResponseMessage as Response26 } from './detects';
19
+ import type { DeleteEntitiesGroupsV1RequestMessage as Request30, GetAggregatesBucketsV1RequestMessage as Request31, PatchEntitiesDevicesTagsV2RequestMessage as Request310, PatchEntitiesGroupsV1RequestMessage as Request311, PostAggregatesDevicesGetV1RequestMessage as Request312, PostCombinedDevicesLoginHistoryV1RequestMessage as Request313, PostEntitiesDevicesActionsV4RequestMessage as Request314, PostEntitiesDevicesHiddenActionsV4RequestMessage as Request315, PostEntitiesDevicesReportsV1RequestMessage as Request316, PostEntitiesDevicesV2RequestMessage as Request317, PostEntitiesGroupActionsV1RequestMessage as Request318, PostEntitiesGroupsV1RequestMessage as Request319, GetAggregatesTagPrefixCountsV1RequestMessage as Request32, PostEntitiesReleasesV1RequestMessage as Request320, GetEntitiesGroupsV1RequestMessage as Request33, GetEntitiesReleasesV1RequestMessage as Request34, GetEntitiesRespondV1RequestMessage as Request35, GetQueriesAvailableGroupsV1RequestMessage as Request36, GetQueriesDevicesHiddenV2RequestMessage as Request37, GetQueriesDevicesV2RequestMessage as Request38, GetQueriesGroupsV1RequestMessage as Request39, DeleteEntitiesGroupsV1ResponseMessage as Response30, GetAggregatesBucketsV1ResponseMessage as Response31, PatchEntitiesDevicesTagsV2ResponseMessage as Response310, PatchEntitiesGroupsV1ResponseMessage as Response311, PostAggregatesDevicesGetV1ResponseMessage as Response312, PostCombinedDevicesLoginHistoryV1ResponseMessage as Response313, PostEntitiesDevicesActionsV4ResponseMessage as Response314, PostEntitiesDevicesHiddenActionsV4ResponseMessage as Response315, PostEntitiesDevicesReportsV1ResponseMessage as Response316, PostEntitiesDevicesV2ResponseMessage as Response317, PostEntitiesGroupActionsV1ResponseMessage as Response318, PostEntitiesGroupsV1ResponseMessage as Response319, GetAggregatesTagPrefixCountsV1ResponseMessage as Response32, PostEntitiesReleasesV1ResponseMessage as Response320, GetEntitiesGroupsV1ResponseMessage as Response33, GetEntitiesReleasesV1ResponseMessage as Response34, GetEntitiesRespondV1ResponseMessage as Response35, GetQueriesAvailableGroupsV1ResponseMessage as Response36, GetQueriesDevicesHiddenV2ResponseMessage as Response37, GetQueriesDevicesV2ResponseMessage as Response38, GetQueriesGroupsV1ResponseMessage as Response39 } from './devices';
20
+ import type { DeleteEntitiesNetworkLocationsV1RequestMessage as Request40, DeleteEntitiesPoliciesV1RequestMessage as Request41, GetEntitiesRulesV1RequestMessage as Request410, GetLibraryEntitiesRuleGroupsV1RequestMessage as Request411, GetLibraryQueriesRuleGroupsV1RequestMessage as Request412, GetQueriesEventsV1RequestMessage as Request413, GetQueriesFirewallFieldsV1RequestMessage as Request414, GetQueriesNetworkLocationsV1RequestMessage as Request415, GetQueriesPlatformsV1RequestMessage as Request416, GetQueriesPolicyRulesV1RequestMessage as Request417, GetQueriesRuleGroupsV1RequestMessage as Request418, GetQueriesRulesV1RequestMessage as Request419, DeleteEntitiesRuleGroupsV1RequestMessage as Request42, PatchEntitiesNetworkLocationsV1RequestMessage as Request420, PatchEntitiesRuleGroupsV1RequestMessage as Request421, PostAggregatesEventsGetV1RequestMessage as Request422, PostAggregatesPolicyRulesGetV1RequestMessage as Request423, PostAggregatesRuleGroupsGetV1RequestMessage as Request424, PostAggregatesRulesGetV1RequestMessage as Request425, PostEntitiesNetworkLocationsMetadataV1RequestMessage as Request426, PostEntitiesNetworkLocationsPrecedenceV1RequestMessage as Request427, PostEntitiesNetworkLocationsV1RequestMessage as Request428, PostEntitiesOntologyV1RequestMessage as Request429, GetEntitiesEventsV1RequestMessage as Request43, PostEntitiesRuleGroupsV1RequestMessage as Request430, PostEntitiesRulesValidateFilepathV1RequestMessage as Request431, PutEntitiesNetworkLocationsV1RequestMessage as Request432, PutEntitiesPoliciesV2RequestMessage as Request433, GetEntitiesFirewallFieldsV1RequestMessage as Request44, GetEntitiesNetworkLocationsDetailsV1RequestMessage as Request45, GetEntitiesNetworkLocationsV1RequestMessage as Request46, GetEntitiesPlatformsV1RequestMessage as Request47, GetEntitiesPoliciesV1RequestMessage as Request48, GetEntitiesRuleGroupsV1RequestMessage as Request49, DeleteEntitiesNetworkLocationsV1ResponseMessage as Response40, DeleteEntitiesPoliciesV1ResponseMessage as Response41, GetEntitiesRulesV1ResponseMessage as Response410, GetLibraryEntitiesRuleGroupsV1ResponseMessage as Response411, GetLibraryQueriesRuleGroupsV1ResponseMessage as Response412, GetQueriesEventsV1ResponseMessage as Response413, GetQueriesFirewallFieldsV1ResponseMessage as Response414, GetQueriesNetworkLocationsV1ResponseMessage as Response415, GetQueriesPlatformsV1ResponseMessage as Response416, GetQueriesPolicyRulesV1ResponseMessage as Response417, GetQueriesRuleGroupsV1ResponseMessage as Response418, GetQueriesRulesV1ResponseMessage as Response419, DeleteEntitiesRuleGroupsV1ResponseMessage as Response42, PatchEntitiesNetworkLocationsV1ResponseMessage as Response420, PatchEntitiesRuleGroupsV1ResponseMessage as Response421, PostAggregatesEventsGetV1ResponseMessage as Response422, PostAggregatesPolicyRulesGetV1ResponseMessage as Response423, PostAggregatesRuleGroupsGetV1ResponseMessage as Response424, PostAggregatesRulesGetV1ResponseMessage as Response425, PostEntitiesNetworkLocationsMetadataV1ResponseMessage as Response426, PostEntitiesNetworkLocationsPrecedenceV1ResponseMessage as Response427, PostEntitiesNetworkLocationsV1ResponseMessage as Response428, PostEntitiesOntologyV1ResponseMessage as Response429, GetEntitiesEventsV1ResponseMessage as Response43, PostEntitiesRuleGroupsV1ResponseMessage as Response430, PostEntitiesRulesValidateFilepathV1ResponseMessage as Response431, PutEntitiesNetworkLocationsV1ResponseMessage as Response432, PutEntitiesPoliciesV2ResponseMessage as Response433, GetEntitiesFirewallFieldsV1ResponseMessage as Response44, GetEntitiesNetworkLocationsDetailsV1ResponseMessage as Response45, GetEntitiesNetworkLocationsV1ResponseMessage as Response46, GetEntitiesPlatformsV1ResponseMessage as Response47, GetEntitiesPoliciesV1ResponseMessage as Response48, GetEntitiesRuleGroupsV1ResponseMessage as Response49 } from './fwmgr';
21
+ import type { GetCombinedCrowdscoresV1RequestMessage as Request50, GetQueriesBehaviorsV1RequestMessage as Request51, GetQueriesIncidentsV1RequestMessage as Request52, PostAggregatesBehaviorsGetV1RequestMessage as Request53, PostAggregatesIncidentsGetV1RequestMessage as Request54, PostEntitiesBehaviorsGetV1RequestMessage as Request55, PostEntitiesIncidentActionsV1RequestMessage as Request56, PostEntitiesIncidentsGetV1RequestMessage as Request57, GetCombinedCrowdscoresV1ResponseMessage as Response50, GetQueriesBehaviorsV1ResponseMessage as Response51, GetQueriesIncidentsV1ResponseMessage as Response52, PostAggregatesBehaviorsGetV1ResponseMessage as Response53, PostAggregatesIncidentsGetV1ResponseMessage as Response54, PostEntitiesBehaviorsGetV1ResponseMessage as Response55, PostEntitiesIncidentActionsV1ResponseMessage as Response56, PostEntitiesIncidentsGetV1ResponseMessage as Response57 } from './incidents';
22
+ import type { GetEntitiesMatrixV1RequestMessage as Request60, GetEntitiesMatrixV1ResponseMessage as Response60 } from './mitre';
23
+ import type { GetEntitiesConfigsV1RequestMessage as Request70, PostEntitiesExecuteDraftV1RequestMessage as Request71, PostEntitiesExecuteV1RequestMessage as Request72, GetEntitiesConfigsV1ResponseMessage as Response70, PostEntitiesExecuteDraftV1ResponseMessage as Response71, PostEntitiesExecuteV1ResponseMessage as Response72 } from './plugins';
24
+ import type { GetQueriesScriptsV1RequestMessage as Request80, PostEntitiesScriptsGetV2RequestMessage as Request81, GetQueriesScriptsV1ResponseMessage as Response80, PostEntitiesScriptsGetV2ResponseMessage as Response81 } from './remote-response';
25
+ import type { GetEntitiesExecutionResultsV1RequestMessage as Request90, PostEntitiesExecuteV1RequestMessage as Request91, PostEntitiesExecutionActionsV1RequestMessage as Request92, GetEntitiesExecutionResultsV1ResponseMessage as Response90, PostEntitiesExecuteV1ResponseMessage as Response91, PostEntitiesExecutionActionsV1ResponseMessage as Response92 } from './workflows';
26
+ import type { DeleteV1CollectionsCollectionNameObjectsObjectKeyRequestMessage as Request100, GetV1CollectionsRequestMessage as Request101, GetV1CollectionsCollectionNameObjectsRequestMessage as Request102, GetV1CollectionsCollectionNameObjectsObjectKeyRequestMessage as Request103, GetV1CollectionsCollectionNameObjectsObjectKeyMetadataRequestMessage as Request104, PostV1CollectionsCollectionNameObjectsRequestMessage as Request105, PutV1CollectionsCollectionNameObjectsObjectKeyRequestMessage as Request106, DeleteV1CollectionsCollectionNameObjectsObjectKeyResponseMessage as Response100, GetV1CollectionsResponseMessage as Response101, GetV1CollectionsCollectionNameObjectsResponseMessage as Response102, GetV1CollectionsCollectionNameObjectsObjectKeyResponseMessage as Response103, GetV1CollectionsCollectionNameObjectsObjectKeyMetadataResponseMessage as Response104, PostV1CollectionsCollectionNameObjectsResponseMessage as Response105, PutV1CollectionsCollectionNameObjectsObjectKeyResponseMessage as Response106 } from './customobjects';
27
+ import type { GetEntitiesExecutionV1RequestMessage as Request110, PostEntitiesExecutionV1RequestMessage as Request111, GetEntitiesExecutionV1ResponseMessage as Response110, PostEntitiesExecutionV1ResponseMessage as Response111 } from './faas-gateway';
28
+ import type { GetEntitiesSavedSearchesExecuteV1RequestMessage as Request120, PostEntitiesSavedSearchesExecuteV1RequestMessage as Request121, GetEntitiesSavedSearchesExecuteV1ResponseMessage as Response120, PostEntitiesSavedSearchesExecuteV1ResponseMessage as Response121 } from './loggingapi';
29
+ export type ResponseFor<REQ extends RequestMessage> = REQ extends Request00 ? Response00 : REQ extends Request01 ? Response01 : REQ extends Request02 ? Response02 : REQ extends Request03 ? Response03 : REQ extends Request04 ? Response04 : REQ extends Request10 ? Response10 : REQ extends Request11 ? Response11 : REQ extends Request12 ? Response12 : REQ extends Request13 ? Response13 : REQ extends Request14 ? Response14 : REQ extends Request15 ? Response15 : REQ extends Request16 ? Response16 : REQ extends Request17 ? Response17 : REQ extends Request20 ? Response20 : REQ extends Request21 ? Response21 : REQ extends Request22 ? Response22 : REQ extends Request23 ? Response23 : REQ extends Request24 ? Response24 : REQ extends Request25 ? Response25 : REQ extends Request26 ? Response26 : REQ extends Request30 ? Response30 : REQ extends Request31 ? Response31 : REQ extends Request32 ? Response32 : REQ extends Request33 ? Response33 : REQ extends Request34 ? Response34 : REQ extends Request35 ? Response35 : REQ extends Request36 ? Response36 : REQ extends Request37 ? Response37 : REQ extends Request38 ? Response38 : REQ extends Request39 ? Response39 : REQ extends Request310 ? Response310 : REQ extends Request311 ? Response311 : REQ extends Request312 ? Response312 : REQ extends Request313 ? Response313 : REQ extends Request314 ? Response314 : REQ extends Request315 ? Response315 : REQ extends Request316 ? Response316 : REQ extends Request317 ? Response317 : REQ extends Request318 ? Response318 : REQ extends Request319 ? Response319 : REQ extends Request320 ? Response320 : REQ extends Request40 ? Response40 : REQ extends Request41 ? Response41 : REQ extends Request42 ? Response42 : REQ extends Request43 ? Response43 : REQ extends Request44 ? Response44 : REQ extends Request45 ? Response45 : REQ extends Request46 ? Response46 : REQ extends Request47 ? Response47 : REQ extends Request48 ? Response48 : REQ extends Request49 ? Response49 : REQ extends Request410 ? Response410 : REQ extends Request411 ? Response411 : REQ extends Request412 ? Response412 : REQ extends Request413 ? Response413 : REQ extends Request414 ? Response414 : REQ extends Request415 ? Response415 : REQ extends Request416 ? Response416 : REQ extends Request417 ? Response417 : REQ extends Request418 ? Response418 : REQ extends Request419 ? Response419 : REQ extends Request420 ? Response420 : REQ extends Request421 ? Response421 : REQ extends Request422 ? Response422 : REQ extends Request423 ? Response423 : REQ extends Request424 ? Response424 : REQ extends Request425 ? Response425 : REQ extends Request426 ? Response426 : REQ extends Request427 ? Response427 : REQ extends Request428 ? Response428 : REQ extends Request429 ? Response429 : REQ extends Request430 ? Response430 : REQ extends Request431 ? Response431 : REQ extends Request432 ? Response432 : REQ extends Request433 ? Response433 : REQ extends Request50 ? Response50 : REQ extends Request51 ? Response51 : REQ extends Request52 ? Response52 : REQ extends Request53 ? Response53 : REQ extends Request54 ? Response54 : REQ extends Request55 ? Response55 : REQ extends Request56 ? Response56 : REQ extends Request57 ? Response57 : REQ extends Request60 ? Response60 : REQ extends Request70 ? Response70 : REQ extends Request71 ? Response71 : REQ extends Request72 ? Response72 : REQ extends Request80 ? Response80 : REQ extends Request81 ? Response81 : REQ extends Request90 ? Response90 : REQ extends Request91 ? Response91 : REQ extends Request92 ? Response92 : REQ extends Request100 ? Response100 : REQ extends Request101 ? Response101 : REQ extends Request102 ? Response102 : REQ extends Request103 ? Response103 : REQ extends Request104 ? Response104 : REQ extends Request105 ? Response105 : REQ extends Request106 ? Response106 : REQ extends Request110 ? Response110 : REQ extends Request111 ? Response111 : REQ extends Request120 ? Response120 : REQ extends Request121 ? Response121 : unknown;
@@ -1,2 +1,30 @@
1
- export * from './incidents/types';
2
- export * from './remote-response/types';
1
+ /**
2
+ *
3
+ * This file is autogenerated from the available APIs for App Platform.
4
+ *
5
+ * DO NOT EDIT DIRECTLY
6
+ *
7
+ * If you need to change the contents of this file please edit the above configuration file and
8
+ * then run:
9
+ *
10
+ * ```
11
+ * yarn cs-gen platform-apis
12
+ * ```
13
+ *
14
+ **/
15
+ import { ActorsApiRequestMessage, ActorsApiResponseMessage } from './actors';
16
+ import { AlertsApiRequestMessage, AlertsApiResponseMessage } from './alerts';
17
+ import { CustomobjectsApiRequestMessage, CustomobjectsApiResponseMessage } from './customobjects';
18
+ import { DetectsApiRequestMessage, DetectsApiResponseMessage } from './detects';
19
+ import { DevicesApiRequestMessage, DevicesApiResponseMessage } from './devices';
20
+ import { FaasGatewayApiRequestMessage, FaasGatewayApiResponseMessage } from './faas-gateway';
21
+ import { FwmgrApiRequestMessage, FwmgrApiResponseMessage } from './fwmgr';
22
+ import { IncidentsApiRequestMessage, IncidentsApiResponseMessage } from './incidents';
23
+ import { LoggingapiApiRequestMessage, LoggingapiApiResponseMessage } from './loggingapi';
24
+ import { MitreApiRequestMessage, MitreApiResponseMessage } from './mitre';
25
+ import { PluginsApiRequestMessage, PluginsApiResponseMessage } from './plugins';
26
+ import { RemoteResponseApiRequestMessage, RemoteResponseApiResponseMessage } from './remote-response';
27
+ import { WorkflowsApiRequestMessage, WorkflowsApiResponseMessage } from './workflows';
28
+ export { ActorsApiRequestMessage, ActorsApiResponseMessage, AlertsApiRequestMessage, AlertsApiResponseMessage, DetectsApiRequestMessage, DetectsApiResponseMessage, DevicesApiRequestMessage, DevicesApiResponseMessage, FwmgrApiRequestMessage, FwmgrApiResponseMessage, IncidentsApiRequestMessage, IncidentsApiResponseMessage, MitreApiRequestMessage, MitreApiResponseMessage, PluginsApiRequestMessage, PluginsApiResponseMessage, RemoteResponseApiRequestMessage, RemoteResponseApiResponseMessage, WorkflowsApiRequestMessage, WorkflowsApiResponseMessage, CustomobjectsApiRequestMessage, CustomobjectsApiResponseMessage, FaasGatewayApiRequestMessage, FaasGatewayApiResponseMessage, LoggingapiApiRequestMessage, LoggingapiApiResponseMessage, };
29
+ export type ApiRequestMessage = ActorsApiRequestMessage | AlertsApiRequestMessage | DetectsApiRequestMessage | DevicesApiRequestMessage | FwmgrApiRequestMessage | IncidentsApiRequestMessage | MitreApiRequestMessage | PluginsApiRequestMessage | RemoteResponseApiRequestMessage | WorkflowsApiRequestMessage | CustomobjectsApiRequestMessage | FaasGatewayApiRequestMessage | LoggingapiApiRequestMessage;
30
+ export type ApiResponseMessage = ActorsApiResponseMessage | AlertsApiResponseMessage | DetectsApiResponseMessage | DevicesApiResponseMessage | FwmgrApiResponseMessage | IncidentsApiResponseMessage | MitreApiResponseMessage | PluginsApiResponseMessage | RemoteResponseApiResponseMessage | WorkflowsApiResponseMessage | CustomobjectsApiResponseMessage | FaasGatewayApiResponseMessage | LoggingapiApiResponseMessage;
@@ -0,0 +1,58 @@
1
+ /**
2
+ *
3
+ * This file is autogenerated.
4
+ *
5
+ * DO NOT EDIT DIRECTLY
6
+ *
7
+ **/
8
+ import type { Bridge } from '../../bridge';
9
+ import type { ApiResponsePayload, BaseApiRequestMessage, BaseApiResponseMessage, BaseUrlParams, QueryParam } from '../../types';
10
+ export type WorkflowsRequestApi = 'workflows';
11
+ export type CommonApiResponseMessage = BaseApiResponseMessage<ApiResponsePayload>;
12
+ export interface CommonApiRequestMessage extends BaseApiRequestMessage<BaseUrlParams, unknown> {
13
+ api: WorkflowsRequestApi;
14
+ }
15
+ export interface GetEntitiesExecutionResultsV1QueryParams extends BaseUrlParams {
16
+ ids: QueryParam;
17
+ }
18
+ export type GetEntitiesExecutionResultsV1ApiResponse = ApiResponsePayload;
19
+ export type GetEntitiesExecutionResultsV1ResponseMessage = BaseApiResponseMessage<GetEntitiesExecutionResultsV1ApiResponse>;
20
+ export interface GetEntitiesExecutionResultsV1RequestMessage extends BaseApiRequestMessage<GetEntitiesExecutionResultsV1QueryParams> {
21
+ api: WorkflowsRequestApi;
22
+ method: 'getEntitiesExecutionResultsV1';
23
+ }
24
+ export interface PostEntitiesExecuteV1QueryParams extends BaseUrlParams {
25
+ definitionId?: QueryParam;
26
+ name?: QueryParam;
27
+ key?: QueryParam;
28
+ depth?: QueryParam;
29
+ }
30
+ export type PostEntitiesExecuteV1ApiResponse = ApiResponsePayload;
31
+ export interface PostEntitiesExecuteV1PostData {
32
+ }
33
+ export type PostEntitiesExecuteV1ResponseMessage = BaseApiResponseMessage<PostEntitiesExecuteV1ApiResponse>;
34
+ export interface PostEntitiesExecuteV1RequestMessage extends BaseApiRequestMessage<PostEntitiesExecuteV1QueryParams, PostEntitiesExecuteV1PostData> {
35
+ api: WorkflowsRequestApi;
36
+ method: 'postEntitiesExecuteV1';
37
+ }
38
+ export interface PostEntitiesExecutionActionsV1QueryParams extends BaseUrlParams {
39
+ actionName: QueryParam;
40
+ }
41
+ export type PostEntitiesExecutionActionsV1ApiResponse = ApiResponsePayload;
42
+ export interface PostEntitiesExecutionActionsV1PostData {
43
+ }
44
+ export type PostEntitiesExecutionActionsV1ResponseMessage = BaseApiResponseMessage<PostEntitiesExecutionActionsV1ApiResponse>;
45
+ export interface PostEntitiesExecutionActionsV1RequestMessage extends BaseApiRequestMessage<PostEntitiesExecutionActionsV1QueryParams, PostEntitiesExecutionActionsV1PostData> {
46
+ api: WorkflowsRequestApi;
47
+ method: 'postEntitiesExecutionActionsV1';
48
+ }
49
+ export type WorkflowsApiRequestMessage = GetEntitiesExecutionResultsV1RequestMessage | PostEntitiesExecuteV1RequestMessage | PostEntitiesExecutionActionsV1RequestMessage;
50
+ export type WorkflowsApiResponseMessage = GetEntitiesExecutionResultsV1ResponseMessage | PostEntitiesExecuteV1ResponseMessage | PostEntitiesExecutionActionsV1ResponseMessage;
51
+ export declare class WorkflowsApiBridge {
52
+ private bridge;
53
+ constructor(bridge: Bridge);
54
+ getBridge(): Bridge<import("../../types").LocalData>;
55
+ getEntitiesExecutionResultsV1(urlParams: GetEntitiesExecutionResultsV1QueryParams): Promise<GetEntitiesExecutionResultsV1ApiResponse>;
56
+ postEntitiesExecuteV1(postBody: PostEntitiesExecuteV1PostData, urlParams?: PostEntitiesExecuteV1QueryParams): Promise<PostEntitiesExecuteV1ApiResponse>;
57
+ postEntitiesExecutionActionsV1(postBody: PostEntitiesExecutionActionsV1PostData, urlParams: PostEntitiesExecutionActionsV1QueryParams): Promise<PostEntitiesExecutionActionsV1ApiResponse>;
58
+ }
package/dist/bridge.d.ts CHANGED
@@ -1,15 +1,20 @@
1
- import type { DataUpdateMessage, LocalData, PayloadOf, RequestMessage, ResponseFor } from './types';
1
+ import type { BroadcastMessage, DataUpdateMessage, LivereloadMessage, LocalData, RequestMessage, UnidirectionalRequestMessage } from './types';
2
2
  interface BridgeOptions<DATA extends LocalData> {
3
3
  onDataUpdate?: (event: DataUpdateMessage<DATA>) => void;
4
+ onBroadcast?: (event: BroadcastMessage) => void;
5
+ onLivereload?: (event: LivereloadMessage) => void;
4
6
  }
5
7
  export declare class Bridge<DATA extends LocalData = LocalData> {
6
8
  private onDataUpdate;
9
+ private onBroadcast;
10
+ private onLivereload;
7
11
  private pendingMessages;
8
12
  private targetOrigin;
9
- constructor({ onDataUpdate }?: BridgeOptions<DATA>);
13
+ constructor({ onDataUpdate, onBroadcast, onLivereload, }?: BridgeOptions<DATA>);
10
14
  destroy(): void;
11
15
  setOrigin(origin: string): void;
12
- postMessage<REQ extends RequestMessage>(message: REQ): Promise<PayloadOf<ResponseFor<REQ, DATA>>>;
16
+ sendUnidirectionalMessage(message: UnidirectionalRequestMessage): void;
17
+ postMessage<REQ extends RequestMessage>(message: REQ): Promise<any>;
13
18
  private handleMessage;
14
19
  }
15
20
  export {};
package/dist/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ export { Bridge } from './bridge';
1
2
  export { default } from './api';
2
- export * from './types';
3
3
  export * from './apis/types';
4
+ export * from './types';