@crowdstrike/foundry-js 0.6.0 → 0.7.0

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.
@@ -1,5 +1,5 @@
1
- import type FalconApi from "../api";
2
- import type { LocalData } from "../types";
1
+ import type FalconApi from '../api';
2
+ import type { LocalData } from '../types';
3
3
  interface FunctionDefinition {
4
4
  id: string;
5
5
  version: number;
@@ -37,11 +37,11 @@ export declare class CloudFunction<DATA extends LocalData = LocalData> {
37
37
  queryParams: {
38
38
  [x: string]: string[];
39
39
  }[];
40
- get: (queryParams?: GetParameters["queryParams"]) => Promise<unknown>;
41
- post: (body: PostParameters["body"], queryParams?: PostParameters["queryParams"], headers?: PostParameters["headers"]) => Promise<unknown>;
42
- patch: (body: PatchParameters["body"], queryParams?: PatchParameters["queryParams"], headers?: PatchParameters["headers"]) => Promise<unknown>;
43
- put: (body: PutParameters["body"], queryParams?: PutParameters["queryParams"], headers?: PutParameters["headers"]) => Promise<unknown>;
44
- delete: (body: DeleteParameters["body"], queryParams?: DeleteParameters["queryParams"], headers?: DeleteParameters["headers"]) => Promise<unknown>;
40
+ get: (queryParams?: GetParameters['queryParams']) => Promise<unknown>;
41
+ post: (body: PostParameters['body'], queryParams?: PostParameters['queryParams'], headers?: PostParameters['headers']) => Promise<unknown>;
42
+ patch: (body: PatchParameters['body'], queryParams?: PatchParameters['queryParams'], headers?: PatchParameters['headers']) => Promise<unknown>;
43
+ put: (body: PutParameters['body'], queryParams?: PutParameters['queryParams'], headers?: PutParameters['headers']) => Promise<unknown>;
44
+ delete: (body: DeleteParameters['body'], queryParams?: DeleteParameters['queryParams'], headers?: DeleteParameters['headers']) => Promise<unknown>;
45
45
  };
46
46
  get({ path, queryParams, headers }: GetParameters): Promise<unknown>;
47
47
  post({ path, queryParams, body, headers }: PostParameters): Promise<unknown>;
@@ -12,9 +12,9 @@ export declare class Collection<DATA extends LocalData = LocalData> {
12
12
  private readonly falcon;
13
13
  private readonly definition;
14
14
  constructor(falcon: FalconApi<DATA>, definition: CollectionDefinition);
15
- write(key: string, data: Record<string, unknown>): Promise<any>;
16
- read(key: string): Promise<any>;
17
- delete(key: string): Promise<any>;
18
- search({ startKey, endKey, limit }: CollectionSearchDefinition): Promise<any>;
15
+ write(key: string, data: Record<string, unknown>): Promise<unknown>;
16
+ read(key: string): Promise<unknown>;
17
+ delete(key: string): Promise<unknown>;
18
+ search({ startKey, endKey, limit }: CollectionSearchDefinition): Promise<unknown>;
19
19
  }
20
20
  export {};
@@ -8,7 +8,7 @@ interface WriteProperties {
8
8
  export declare class Logscale<DATA extends LocalData = LocalData> {
9
9
  private readonly falcon;
10
10
  constructor(falcon: FalconApi<DATA>);
11
- write(data: LogscaleRequestMessage['payload']['data'], properties: WriteProperties): Promise<any>;
12
- query(data: LogscaleRequestMessage['payload']['data']): Promise<any>;
11
+ write(data: LogscaleRequestMessage['payload']['data'], properties: WriteProperties): Promise<unknown>;
12
+ query(data: LogscaleRequestMessage['payload']['data']): Promise<unknown>;
13
13
  }
14
14
  export {};
package/dist/api.d.ts CHANGED
@@ -32,7 +32,7 @@ export default class FalconApi<DATA extends LocalData = LocalData> extends Falco
32
32
  id: string;
33
33
  version: number;
34
34
  }): CloudFunction<DATA>;
35
- apiIntegration({ definitionId, operationId }: {
35
+ apiIntegration({ definitionId, operationId, }: {
36
36
  operationId: string;
37
37
  definitionId: string;
38
38
  }): ApiIntegration<DATA>;
@@ -1,15 +1,8 @@
1
1
  /**
2
2
  *
3
- * This file is autogenerated from the available APIs for App Platform.
3
+ * This file is autogenerated.
4
4
  *
5
5
  * DO NOT EDIT DIRECTLY
6
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
7
  **/
15
8
  export type ApiIdentifier = 'actors' | 'alerts' | 'detects' | 'devices' | 'fwmgr' | 'incidents' | 'mitre' | 'plugins' | 'remoteResponse' | 'workflows' | 'customobjects' | 'faasGateway' | 'loggingapi';
@@ -1,16 +1,9 @@
1
1
  /**
2
2
  *
3
- * This file is autogenerated from the available APIs for App Platform.
3
+ * This file is autogenerated.
4
4
  *
5
5
  * DO NOT EDIT DIRECTLY
6
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
7
  **/
15
8
  import { ActorsApiBridge } from './actors';
16
9
  import { AlertsApiBridge } from './alerts';
@@ -12,6 +12,25 @@ export type CommonApiResponseMessage = BaseApiResponseMessage<ApiResponsePayload
12
12
  export interface CommonApiRequestMessage extends BaseApiRequestMessage<BaseUrlParams, unknown> {
13
13
  api: RemoteResponseRequestApi;
14
14
  }
15
+ export interface GetEntitiesAppCommandV1QueryParams extends BaseUrlParams {
16
+ cloudRequestId: QueryParam;
17
+ sequenceId: QueryParam;
18
+ }
19
+ export type GetEntitiesAppCommandV1ApiResponse = ApiResponsePayload;
20
+ export type GetEntitiesAppCommandV1ResponseMessage = BaseApiResponseMessage<GetEntitiesAppCommandV1ApiResponse>;
21
+ export interface GetEntitiesAppCommandV1RequestMessage extends BaseApiRequestMessage<GetEntitiesAppCommandV1QueryParams> {
22
+ api: RemoteResponseRequestApi;
23
+ method: 'getEntitiesAppCommandV1';
24
+ }
25
+ export interface GetEntitiesPutFilesV2QueryParams extends BaseUrlParams {
26
+ ids: QueryParam;
27
+ }
28
+ export type GetEntitiesPutFilesV2ApiResponse = ApiResponsePayload;
29
+ export type GetEntitiesPutFilesV2ResponseMessage = BaseApiResponseMessage<GetEntitiesPutFilesV2ApiResponse>;
30
+ export interface GetEntitiesPutFilesV2RequestMessage extends BaseApiRequestMessage<GetEntitiesPutFilesV2QueryParams> {
31
+ api: RemoteResponseRequestApi;
32
+ method: 'getEntitiesPutFilesV2';
33
+ }
15
34
  export interface GetQueriesPutFilesV1QueryParams extends BaseUrlParams {
16
35
  filter?: string;
17
36
  limit?: QueryParam;
@@ -36,23 +55,46 @@ export interface GetQueriesScriptsV1RequestMessage extends BaseApiRequestMessage
36
55
  api: RemoteResponseRequestApi;
37
56
  method: 'getQueriesScriptsV1';
38
57
  }
39
- export type PostEntitiesPutFilesGetV1QueryParams = BaseUrlParams;
40
- export type PostEntitiesPutFilesGetV1ApiResponse = ApiResponsePayload;
41
- export interface PostEntitiesPutFilesGetV1PostData {
58
+ export interface PostEntitiesAppCommandV1QueryParams extends BaseUrlParams {
59
+ appScriptVersion?: QueryParam;
60
+ }
61
+ export type PostEntitiesAppCommandV1ApiResponse = ApiResponsePayload;
62
+ export interface PostEntitiesAppCommandV1PostData {
63
+ }
64
+ export type PostEntitiesAppCommandV1ResponseMessage = BaseApiResponseMessage<PostEntitiesAppCommandV1ApiResponse>;
65
+ export interface PostEntitiesAppCommandV1RequestMessage extends BaseApiRequestMessage<PostEntitiesAppCommandV1QueryParams, PostEntitiesAppCommandV1PostData> {
66
+ api: RemoteResponseRequestApi;
67
+ method: 'postEntitiesAppCommandV1';
68
+ }
69
+ export type PostEntitiesAppRefreshSessionsV1QueryParams = BaseUrlParams;
70
+ export type PostEntitiesAppRefreshSessionsV1ApiResponse = ApiResponsePayload;
71
+ export interface PostEntitiesAppRefreshSessionsV1PostData {
72
+ }
73
+ export type PostEntitiesAppRefreshSessionsV1ResponseMessage = BaseApiResponseMessage<PostEntitiesAppRefreshSessionsV1ApiResponse>;
74
+ export interface PostEntitiesAppRefreshSessionsV1RequestMessage extends BaseApiRequestMessage<PostEntitiesAppRefreshSessionsV1QueryParams, PostEntitiesAppRefreshSessionsV1PostData> {
75
+ api: RemoteResponseRequestApi;
76
+ method: 'postEntitiesAppRefreshSessionsV1';
77
+ }
78
+ export interface PostEntitiesAppSessionsV1QueryParams extends BaseUrlParams {
79
+ timeout?: QueryParam;
80
+ timeoutDuration?: QueryParam;
81
+ }
82
+ export type PostEntitiesAppSessionsV1ApiResponse = ApiResponsePayload;
83
+ export interface PostEntitiesAppSessionsV1PostData {
42
84
  }
43
- export type PostEntitiesPutFilesGetV1ResponseMessage = BaseApiResponseMessage<PostEntitiesPutFilesGetV1ApiResponse>;
44
- export interface PostEntitiesPutFilesGetV1RequestMessage extends BaseApiRequestMessage<PostEntitiesPutFilesGetV1QueryParams, PostEntitiesPutFilesGetV1PostData> {
85
+ export type PostEntitiesAppSessionsV1ResponseMessage = BaseApiResponseMessage<PostEntitiesAppSessionsV1ApiResponse>;
86
+ export interface PostEntitiesAppSessionsV1RequestMessage extends BaseApiRequestMessage<PostEntitiesAppSessionsV1QueryParams, PostEntitiesAppSessionsV1PostData> {
45
87
  api: RemoteResponseRequestApi;
46
- method: 'postEntitiesPutFilesGetV1';
88
+ method: 'postEntitiesAppSessionsV1';
47
89
  }
48
- export type PostEntitiesPutFilesV1QueryParams = BaseUrlParams;
49
- export type PostEntitiesPutFilesV1ApiResponse = ApiResponsePayload;
50
- export interface PostEntitiesPutFilesV1PostData {
90
+ export type PostEntitiesPutFilesV2QueryParams = BaseUrlParams;
91
+ export type PostEntitiesPutFilesV2ApiResponse = ApiResponsePayload;
92
+ export interface PostEntitiesPutFilesV2PostData {
51
93
  }
52
- export type PostEntitiesPutFilesV1ResponseMessage = BaseApiResponseMessage<PostEntitiesPutFilesV1ApiResponse>;
53
- export interface PostEntitiesPutFilesV1RequestMessage extends BaseApiRequestMessage<PostEntitiesPutFilesV1QueryParams, PostEntitiesPutFilesV1PostData> {
94
+ export type PostEntitiesPutFilesV2ResponseMessage = BaseApiResponseMessage<PostEntitiesPutFilesV2ApiResponse>;
95
+ export interface PostEntitiesPutFilesV2RequestMessage extends BaseApiRequestMessage<PostEntitiesPutFilesV2QueryParams, PostEntitiesPutFilesV2PostData> {
54
96
  api: RemoteResponseRequestApi;
55
- method: 'postEntitiesPutFilesV1';
97
+ method: 'postEntitiesPutFilesV2';
56
98
  }
57
99
  export type PostEntitiesScriptsGetV2QueryParams = BaseUrlParams;
58
100
  export type PostEntitiesScriptsGetV2ApiResponse = ApiResponsePayload;
@@ -63,12 +105,16 @@ export interface PostEntitiesScriptsGetV2RequestMessage extends BaseApiRequestMe
63
105
  api: RemoteResponseRequestApi;
64
106
  method: 'postEntitiesScriptsGetV2';
65
107
  }
66
- export type RemoteResponseApiRequestMessage = GetQueriesScriptsV1RequestMessage | PostEntitiesScriptsGetV2RequestMessage;
67
- export type RemoteResponseApiResponseMessage = GetQueriesScriptsV1ResponseMessage | PostEntitiesScriptsGetV2ResponseMessage;
108
+ export type RemoteResponseApiRequestMessage = GetEntitiesAppCommandV1RequestMessage | GetQueriesScriptsV1RequestMessage | PostEntitiesAppCommandV1RequestMessage | PostEntitiesAppRefreshSessionsV1RequestMessage | PostEntitiesAppSessionsV1RequestMessage | PostEntitiesScriptsGetV2RequestMessage;
109
+ export type RemoteResponseApiResponseMessage = GetEntitiesAppCommandV1ResponseMessage | GetQueriesScriptsV1ResponseMessage | PostEntitiesAppCommandV1ResponseMessage | PostEntitiesAppRefreshSessionsV1ResponseMessage | PostEntitiesAppSessionsV1ResponseMessage | PostEntitiesScriptsGetV2ResponseMessage;
68
110
  export declare class RemoteResponseApiBridge {
69
111
  private bridge;
70
112
  constructor(bridge: Bridge);
71
113
  getBridge(): Bridge<import("../../types").LocalData>;
114
+ getEntitiesAppCommandV1(urlParams: GetEntitiesAppCommandV1QueryParams): Promise<GetEntitiesAppCommandV1ApiResponse>;
72
115
  getScriptIds(urlParams?: GetQueriesScriptsV1QueryParams): Promise<GetQueriesScriptsV1ApiResponse>;
116
+ postEntitiesAppCommandV1(postBody: PostEntitiesAppCommandV1PostData, urlParams?: PostEntitiesAppCommandV1QueryParams): Promise<PostEntitiesAppCommandV1ApiResponse>;
117
+ postEntitiesAppRefreshSessionsV1(postBody: PostEntitiesAppRefreshSessionsV1PostData, urlParams?: PostEntitiesAppRefreshSessionsV1QueryParams): Promise<PostEntitiesAppRefreshSessionsV1ApiResponse>;
118
+ postEntitiesAppSessionsV1(postBody: PostEntitiesAppSessionsV1PostData, urlParams?: PostEntitiesAppSessionsV1QueryParams): Promise<PostEntitiesAppSessionsV1ApiResponse>;
73
119
  getScriptEntities(postBody: PostEntitiesScriptsGetV2PostData, urlParams?: PostEntitiesScriptsGetV2QueryParams): Promise<PostEntitiesScriptsGetV2ApiResponse>;
74
120
  }
@@ -1,16 +1,9 @@
1
1
  /**
2
2
  *
3
- * This file is autogenerated from the available APIs for App Platform.
3
+ * This file is autogenerated.
4
4
  *
5
5
  * DO NOT EDIT DIRECTLY
6
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
7
  **/
15
8
  import type { RequestMessage } from '../types';
16
9
  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';
@@ -21,9 +14,9 @@ import type { DeleteEntitiesNetworkLocationsV1RequestMessage as Request40, Delet
21
14
  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
15
  import type { GetEntitiesMatrixV1RequestMessage as Request60, GetEntitiesMatrixV1ResponseMessage as Response60 } from './mitre';
23
16
  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';
17
+ import type { GetEntitiesAppCommandV1RequestMessage as Request80, GetQueriesScriptsV1RequestMessage as Request81, PostEntitiesAppCommandV1RequestMessage as Request82, PostEntitiesAppRefreshSessionsV1RequestMessage as Request83, PostEntitiesAppSessionsV1RequestMessage as Request84, PostEntitiesScriptsGetV2RequestMessage as Request85, GetEntitiesAppCommandV1ResponseMessage as Response80, GetQueriesScriptsV1ResponseMessage as Response81, PostEntitiesAppCommandV1ResponseMessage as Response82, PostEntitiesAppRefreshSessionsV1ResponseMessage as Response83, PostEntitiesAppSessionsV1ResponseMessage as Response84, PostEntitiesScriptsGetV2ResponseMessage as Response85 } from './remote-response';
25
18
  import type { GetEntitiesExecutionResultsV1RequestMessage as Request90, PostEntitiesExecuteV1RequestMessage as Request91, PostEntitiesExecutionActionsV1RequestMessage as Request92, GetEntitiesExecutionResultsV1ResponseMessage as Response90, PostEntitiesExecuteV1ResponseMessage as Response91, PostEntitiesExecutionActionsV1ResponseMessage as Response92 } from './workflows';
26
19
  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
20
  import type { GetEntitiesExecutionV1RequestMessage as Request110, PostEntitiesExecutionV1RequestMessage as Request111, GetEntitiesExecutionV1ResponseMessage as Response110, PostEntitiesExecutionV1ResponseMessage as Response111 } from './faas-gateway';
28
21
  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;
22
+ 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 Request82 ? Response82 : REQ extends Request83 ? Response83 : REQ extends Request84 ? Response84 : REQ extends Request85 ? Response85 : 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,16 +1,9 @@
1
1
  /**
2
2
  *
3
- * This file is autogenerated from the available APIs for App Platform.
3
+ * This file is autogenerated.
4
4
  *
5
5
  * DO NOT EDIT DIRECTLY
6
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
7
  **/
15
8
  import { ActorsApiRequestMessage, ActorsApiResponseMessage } from './actors';
16
9
  import { AlertsApiRequestMessage, AlertsApiResponseMessage } from './alerts';
package/dist/bridge.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import type { BroadcastMessage, DataUpdateMessage, LivereloadMessage, LocalData, RequestMessage, UnidirectionalRequestMessage } from './types';
1
+ import type { BroadcastMessage, DataUpdateMessage, LivereloadMessage, LocalData, PayloadOf, RequestMessage, ResponseFor, UnidirectionalRequestMessage } from './types';
2
2
  interface BridgeOptions<DATA extends LocalData> {
3
3
  onDataUpdate?: (event: DataUpdateMessage<DATA>) => void;
4
4
  onBroadcast?: (event: BroadcastMessage) => void;
@@ -14,7 +14,7 @@ export declare class Bridge<DATA extends LocalData = LocalData> {
14
14
  destroy(): void;
15
15
  setOrigin(origin: string): void;
16
16
  sendUnidirectionalMessage(message: UnidirectionalRequestMessage): void;
17
- postMessage<REQ extends RequestMessage>(message: REQ): Promise<any>;
17
+ postMessage<REQ extends RequestMessage>(message: REQ): Promise<PayloadOf<ResponseFor<REQ, DATA>>>;
18
18
  private handleMessage;
19
19
  }
20
20
  export {};
package/dist/index.js CHANGED
@@ -120,8 +120,6 @@ class Bridge {
120
120
  };
121
121
  window.parent.postMessage(eventData, this.targetOrigin);
122
122
  }
123
- // TODO: For some reason with adding more APIs, return type is not working
124
- // Promise<PayloadOf<ResponseFor<REQ, DATA>>>
125
123
  async postMessage(message) {
126
124
  return new Promise((resolve, reject) => {
127
125
  const messageId = v4();
@@ -2163,6 +2161,17 @@ class RemoteResponseApiBridge {
2163
2161
  getBridge() {
2164
2162
  return this.bridge;
2165
2163
  }
2164
+ async getEntitiesAppCommandV1(urlParams) {
2165
+ const message = {
2166
+ type: 'api',
2167
+ api: 'remoteResponse',
2168
+ method: 'getEntitiesAppCommandV1',
2169
+ payload: {
2170
+ params: urlParams,
2171
+ },
2172
+ };
2173
+ return this.bridge.postMessage(message);
2174
+ }
2166
2175
  async getScriptIds(urlParams = {}) {
2167
2176
  const message = {
2168
2177
  type: 'api',
@@ -2174,6 +2183,42 @@ class RemoteResponseApiBridge {
2174
2183
  };
2175
2184
  return this.bridge.postMessage(message);
2176
2185
  }
2186
+ async postEntitiesAppCommandV1(postBody, urlParams = {}) {
2187
+ const message = {
2188
+ type: 'api',
2189
+ api: 'remoteResponse',
2190
+ method: 'postEntitiesAppCommandV1',
2191
+ payload: {
2192
+ body: postBody,
2193
+ params: urlParams,
2194
+ },
2195
+ };
2196
+ return this.bridge.postMessage(message);
2197
+ }
2198
+ async postEntitiesAppRefreshSessionsV1(postBody, urlParams = {}) {
2199
+ const message = {
2200
+ type: 'api',
2201
+ api: 'remoteResponse',
2202
+ method: 'postEntitiesAppRefreshSessionsV1',
2203
+ payload: {
2204
+ body: postBody,
2205
+ params: urlParams,
2206
+ },
2207
+ };
2208
+ return this.bridge.postMessage(message);
2209
+ }
2210
+ async postEntitiesAppSessionsV1(postBody, urlParams = {}) {
2211
+ const message = {
2212
+ type: 'api',
2213
+ api: 'remoteResponse',
2214
+ method: 'postEntitiesAppSessionsV1',
2215
+ payload: {
2216
+ body: postBody,
2217
+ params: urlParams,
2218
+ },
2219
+ };
2220
+ return this.bridge.postMessage(message);
2221
+ }
2177
2222
  async getScriptEntities(postBody, urlParams = {}) {
2178
2223
  const message = {
2179
2224
  type: 'api',
@@ -2242,17 +2287,10 @@ class WorkflowsApiBridge {
2242
2287
 
2243
2288
  /**
2244
2289
  *
2245
- * This file is autogenerated from the available APIs for App Platform.
2290
+ * This file is autogenerated.
2246
2291
  *
2247
2292
  * DO NOT EDIT DIRECTLY
2248
2293
  *
2249
- * If you need to change the contents of this file please edit the above configuration file and
2250
- * then run:
2251
- *
2252
- * ```
2253
- * yarn cs-gen platform-apis
2254
- * ```
2255
- *
2256
2294
  **/
2257
2295
  class FalconPublicApis {
2258
2296
  isConnected = false;
@@ -2372,11 +2410,11 @@ class ApiIntegration {
2372
2410
  class CloudFunction {
2373
2411
  falcon;
2374
2412
  definition;
2375
- static GET = "GET";
2376
- static POST = "POST";
2377
- static PATCH = "PATCH";
2378
- static PUT = "PUT";
2379
- static DELETE = "DELETE";
2413
+ static GET = 'GET';
2414
+ static POST = 'POST';
2415
+ static PATCH = 'PATCH';
2416
+ static PUT = 'PUT';
2417
+ static DELETE = 'DELETE';
2380
2418
  pollTimeout = 500;
2381
2419
  intervalId;
2382
2420
  constructor(falcon, definition) {
@@ -2436,7 +2474,7 @@ class CloudFunction {
2436
2474
  }, this.pollTimeout);
2437
2475
  }
2438
2476
  path(pathEntry) {
2439
- const urlPath = new URL(pathEntry, "http://localhost");
2477
+ const urlPath = new URL(pathEntry, 'http://localhost');
2440
2478
  const path = urlPath.pathname;
2441
2479
  const searchParams = [...urlPath.searchParams.entries()].map(([key, value]) => ({
2442
2480
  [key]: [value],
@@ -2770,7 +2808,7 @@ class FalconApi extends FalconPublicApis {
2770
2808
  this.cloudFunctions.push(cf);
2771
2809
  return cf;
2772
2810
  }
2773
- apiIntegration({ definitionId, operationId }) {
2811
+ apiIntegration({ definitionId, operationId, }) {
2774
2812
  assertConnection(this);
2775
2813
  const cf = new ApiIntegration(this, { operationId, definitionId });
2776
2814
  this.apiIntegrations.push(cf);