@opens/gateways 1.16.21 → 1.16.23

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,3 +1,66 @@
1
+ /** Datasource associated with an app form field. */
2
+ interface AppDatasource {
3
+ id: string;
4
+ }
5
+ /** Field exposed in an app form section. */
6
+ interface AppField {
7
+ id: string;
8
+ label: string;
9
+ type: string;
10
+ required: boolean;
11
+ placeholder: string | null;
12
+ key: string;
13
+ datasource: AppDatasource | null;
14
+ }
15
+ /** Section exposed in an app form. */
16
+ interface AppSection {
17
+ id: string;
18
+ fields: AppField[];
19
+ }
20
+ /** Form definition associated with an app. */
21
+ interface AppForm {
22
+ id: string;
23
+ sections: AppSection[];
24
+ }
25
+ /** App available to the authenticated company. */
26
+ interface App {
27
+ id: number;
28
+ companyId: string;
29
+ name: string | null;
30
+ description: string | null;
31
+ icon: string | null;
32
+ active: boolean;
33
+ actionId: number | null;
34
+ }
35
+ /** App detail response including its form definition. */
36
+ interface AppDetails extends App {
37
+ form: AppForm | null;
38
+ }
39
+ /** Response returned when listing apps available to the authenticated company. */
40
+ interface AppListResponse {
41
+ data: App[];
42
+ total: number;
43
+ }
44
+ /** Request parameters for retrieving an app. */
45
+ interface GetAppRequest {
46
+ appId: number;
47
+ }
48
+ /** Request parameters and context used to resolve an app datasource. */
49
+ interface ResolveAppDatasourceRequest {
50
+ appId: number;
51
+ datasourceId: string;
52
+ context: Record<string, unknown>;
53
+ }
54
+ /** Item returned by an app datasource resolution. */
55
+ interface AppDatasourceItem {
56
+ value: unknown;
57
+ label: string;
58
+ }
59
+ /** Response returned when resolving an app datasource. */
60
+ interface ResolveAppDatasourceResponse {
61
+ items: AppDatasourceItem[];
62
+ }
63
+
1
64
  /** Action configured for an integration partner webhook. */
2
65
  interface IntegrationAction {
3
66
  id: number;
@@ -158,4 +221,4 @@ interface DeleteIntegrationActionParams {
158
221
  actionId: number;
159
222
  }
160
223
 
161
- export type { AutomationPartner, AutomationPartnerAction, CreateAutomationPartnerRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, GetAutomationPartnerRequest, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, ListAutomationActionsRequest, ListAutomationPartnersRequest, UpdateIntegrationActionParams, UpdateIntegrationActionRequest, UpdateIntegrationFieldParams, UpdateIntegrationFieldRequest };
224
+ export type { App, AppDatasource, AppDatasourceItem, AppDetails, AppField, AppForm, AppListResponse, AppSection, AutomationPartner, AutomationPartnerAction, CreateAutomationPartnerRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, GetAppRequest, GetAutomationPartnerRequest, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, ListAutomationActionsRequest, ListAutomationPartnersRequest, ResolveAppDatasourceRequest, ResolveAppDatasourceResponse, UpdateIntegrationActionParams, UpdateIntegrationActionRequest, UpdateIntegrationFieldParams, UpdateIntegrationFieldRequest };
@@ -1,3 +1,66 @@
1
+ /** Datasource associated with an app form field. */
2
+ interface AppDatasource {
3
+ id: string;
4
+ }
5
+ /** Field exposed in an app form section. */
6
+ interface AppField {
7
+ id: string;
8
+ label: string;
9
+ type: string;
10
+ required: boolean;
11
+ placeholder: string | null;
12
+ key: string;
13
+ datasource: AppDatasource | null;
14
+ }
15
+ /** Section exposed in an app form. */
16
+ interface AppSection {
17
+ id: string;
18
+ fields: AppField[];
19
+ }
20
+ /** Form definition associated with an app. */
21
+ interface AppForm {
22
+ id: string;
23
+ sections: AppSection[];
24
+ }
25
+ /** App available to the authenticated company. */
26
+ interface App {
27
+ id: number;
28
+ companyId: string;
29
+ name: string | null;
30
+ description: string | null;
31
+ icon: string | null;
32
+ active: boolean;
33
+ actionId: number | null;
34
+ }
35
+ /** App detail response including its form definition. */
36
+ interface AppDetails extends App {
37
+ form: AppForm | null;
38
+ }
39
+ /** Response returned when listing apps available to the authenticated company. */
40
+ interface AppListResponse {
41
+ data: App[];
42
+ total: number;
43
+ }
44
+ /** Request parameters for retrieving an app. */
45
+ interface GetAppRequest {
46
+ appId: number;
47
+ }
48
+ /** Request parameters and context used to resolve an app datasource. */
49
+ interface ResolveAppDatasourceRequest {
50
+ appId: number;
51
+ datasourceId: string;
52
+ context: Record<string, unknown>;
53
+ }
54
+ /** Item returned by an app datasource resolution. */
55
+ interface AppDatasourceItem {
56
+ value: unknown;
57
+ label: string;
58
+ }
59
+ /** Response returned when resolving an app datasource. */
60
+ interface ResolveAppDatasourceResponse {
61
+ items: AppDatasourceItem[];
62
+ }
63
+
1
64
  /** Action configured for an integration partner webhook. */
2
65
  interface IntegrationAction {
3
66
  id: number;
@@ -158,4 +221,4 @@ interface DeleteIntegrationActionParams {
158
221
  actionId: number;
159
222
  }
160
223
 
161
- export type { AutomationPartner, AutomationPartnerAction, CreateAutomationPartnerRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, GetAutomationPartnerRequest, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, ListAutomationActionsRequest, ListAutomationPartnersRequest, UpdateIntegrationActionParams, UpdateIntegrationActionRequest, UpdateIntegrationFieldParams, UpdateIntegrationFieldRequest };
224
+ export type { App, AppDatasource, AppDatasourceItem, AppDetails, AppField, AppForm, AppListResponse, AppSection, AutomationPartner, AutomationPartnerAction, CreateAutomationPartnerRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, GetAppRequest, GetAutomationPartnerRequest, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, ListAutomationActionsRequest, ListAutomationPartnersRequest, ResolveAppDatasourceRequest, ResolveAppDatasourceResponse, UpdateIntegrationActionParams, UpdateIntegrationActionRequest, UpdateIntegrationFieldParams, UpdateIntegrationFieldRequest };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/integrations/contracts/index.ts"],"sourcesContent":["export * from './integration';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../../../src/integrations/contracts/index.ts"],"sourcesContent":["export * from './app';\nexport * from './integration';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.16.21",
2
+ "version": "1.16.23",
3
3
  "description": "A simple package to help with some common tasks",
4
4
  "name": "@opens/gateways",
5
5
  "private": false,
@@ -59,4 +59,4 @@
59
59
  "dependencies": {
60
60
  "axios": "^1.18.0"
61
61
  }
62
- }
62
+ }