@contrail/cli 3.4.0 → 3.4.2-alpha

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 (233) hide show
  1. package/README.md +1 -1
  2. package/bin/dev +0 -0
  3. package/bin/run +0 -0
  4. package/dist/__mocks__/@contrail/sdk.d.ts +123 -123
  5. package/dist/__mocks__/@contrail/sdk.js +716 -716
  6. package/dist/api/app-extension-deployments.d.ts +2 -2
  7. package/dist/api/app-extension-deployments.js +11 -11
  8. package/dist/api/app-extension-packages.d.ts +2 -2
  9. package/dist/api/app-extension-packages.js +11 -11
  10. package/dist/api/apps.d.ts +10 -10
  11. package/dist/api/apps.js +63 -63
  12. package/dist/api/event-workflow-action-definition.d.ts +3 -3
  13. package/dist/api/event-workflow-action-definition.js +18 -18
  14. package/dist/api/event-workflow-template-definition.d.ts +7 -7
  15. package/dist/api/event-workflow-template-definition.js +26 -26
  16. package/dist/api/event-workflow-templates.d.ts +8 -8
  17. package/dist/api/event-workflow-templates.js +32 -32
  18. package/dist/api/schedules.d.ts +7 -7
  19. package/dist/api/schedules.js +32 -32
  20. package/dist/api/types.d.ts +11 -11
  21. package/dist/api/types.js +79 -79
  22. package/dist/api/users.d.ts +2 -2
  23. package/dist/api/users.js +18 -18
  24. package/dist/api/webhooks.d.ts +4 -4
  25. package/dist/api/webhooks.js +16 -16
  26. package/dist/auth/login.d.ts +3 -3
  27. package/dist/auth/login.js +221 -221
  28. package/dist/auth/login.spec.d.ts +1 -1
  29. package/dist/auth/login.spec.js +10 -10
  30. package/dist/baseFlags.d.ts +10 -10
  31. package/dist/baseFlags.js +25 -25
  32. package/dist/basecommand.d.ts +15 -15
  33. package/dist/basecommand.js +83 -83
  34. package/dist/commands/app/create.d.ts +10 -10
  35. package/dist/commands/app/create.js +96 -96
  36. package/dist/commands/app/delete.d.ts +11 -11
  37. package/dist/commands/app/delete.js +40 -40
  38. package/dist/commands/app/extension/deploy.d.ts +18 -18
  39. package/dist/commands/app/extension/deploy.js +127 -127
  40. package/dist/commands/app/extension/deployment/list.d.ts +14 -14
  41. package/dist/commands/app/extension/deployment/list.js +82 -82
  42. package/dist/commands/app/getApiKey.d.ts +11 -11
  43. package/dist/commands/app/getApiKey.js +49 -49
  44. package/dist/commands/app/init.d.ts +10 -10
  45. package/dist/commands/app/init.js +67 -67
  46. package/dist/commands/app/install.d.ts +13 -13
  47. package/dist/commands/app/install.js +135 -135
  48. package/dist/commands/app/publish.d.ts +14 -14
  49. package/dist/commands/app/publish.js +69 -69
  50. package/dist/commands/app/uninstall.d.ts +12 -12
  51. package/dist/commands/app/uninstall.js +68 -68
  52. package/dist/commands/app/upgrade.d.ts +14 -14
  53. package/dist/commands/app/upgrade.js +108 -108
  54. package/dist/commands/app/version/major.d.ts +11 -11
  55. package/dist/commands/app/version/major.js +39 -39
  56. package/dist/commands/app/version/minor.d.ts +11 -11
  57. package/dist/commands/app/version/minor.js +39 -39
  58. package/dist/commands/app/version/patch.d.ts +11 -11
  59. package/dist/commands/app/version/patch.js +39 -39
  60. package/dist/commands/config/create.d.ts +12 -12
  61. package/dist/commands/config/create.js +27 -27
  62. package/dist/commands/config/describe.d.ts +14 -14
  63. package/dist/commands/config/describe.js +46 -46
  64. package/dist/commands/config/list.d.ts +11 -11
  65. package/dist/commands/config/list.js +38 -38
  66. package/dist/commands/config/set.d.ts +16 -16
  67. package/dist/commands/config/set.js +46 -46
  68. package/dist/commands/config/use.d.ts +14 -14
  69. package/dist/commands/config/use.js +47 -47
  70. package/dist/commands/file/upload.d.ts +15 -15
  71. package/dist/commands/file/upload.js +69 -69
  72. package/dist/commands/groups/export.d.ts +14 -14
  73. package/dist/commands/groups/export.js +103 -103
  74. package/dist/commands/groups/import.d.ts +14 -14
  75. package/dist/commands/groups/import.js +190 -190
  76. package/dist/commands/instance/export.d.ts +12 -12
  77. package/dist/commands/instance/export.js +36 -36
  78. package/dist/commands/instance/import.d.ts +11 -11
  79. package/dist/commands/instance/import.js +34 -34
  80. package/dist/commands/load/colors.d.ts +14 -14
  81. package/dist/commands/load/colors.js +53 -53
  82. package/dist/commands/load/custom-entity.d.ts +14 -14
  83. package/dist/commands/load/custom-entity.js +55 -55
  84. package/dist/commands/load/line-sheet.d.ts +14 -14
  85. package/dist/commands/load/line-sheet.js +55 -55
  86. package/dist/commands/load/upload-and-load.d.ts +14 -14
  87. package/dist/commands/load/upload-and-load.js +46 -46
  88. package/dist/commands/projects/export.d.ts +13 -13
  89. package/dist/commands/projects/export.js +35 -35
  90. package/dist/commands/projects/list.d.ts +10 -10
  91. package/dist/commands/projects/list.js +36 -36
  92. package/dist/commands/projects/load.d.ts +25 -25
  93. package/dist/commands/projects/load.js +198 -198
  94. package/dist/commands/types/exportOptionSetHierarchies.d.ts +11 -11
  95. package/dist/commands/types/exportOptionSetHierarchies.js +133 -133
  96. package/dist/commands/types/getAll.d.ts +21 -21
  97. package/dist/commands/types/getAll.js +180 -180
  98. package/dist/commands/types/getOptionSets.d.ts +16 -16
  99. package/dist/commands/types/getOptionSets.js +170 -170
  100. package/dist/commands/types/loadAll.d.ts +12 -12
  101. package/dist/commands/types/loadAll.js +55 -55
  102. package/dist/commands/types/mergeOptionSets.d.ts +13 -13
  103. package/dist/commands/types/mergeOptionSets.js +119 -119
  104. package/dist/commands/types/mergeTypeProperties.d.ts +15 -15
  105. package/dist/commands/types/mergeTypeProperties.js +95 -95
  106. package/dist/commands/types/parseOptionSetsHierarchyLocalFile.d.ts +14 -14
  107. package/dist/commands/types/parseOptionSetsHierarchyLocalFile.js +133 -133
  108. package/dist/commands/types/parseOptionSetsHierarchyValuesToKeysLocalFile.d.ts +14 -14
  109. package/dist/commands/types/parseOptionSetsHierarchyValuesToKeysLocalFile.js +102 -102
  110. package/dist/commands/types/parseOptionSetsLocalFiles.d.ts +39 -39
  111. package/dist/commands/types/parseOptionSetsLocalFiles.js +229 -229
  112. package/dist/commands/types/parseOptionSetsToFolderStructure.d.ts +13 -13
  113. package/dist/commands/types/parseOptionSetsToFolderStructure.js +68 -68
  114. package/dist/commands/types/parseTypesFromFiles.d.ts +14 -14
  115. package/dist/commands/types/parseTypesFromFiles.js +40 -40
  116. package/dist/commands/types/parseTypesFromLocalFiles.d.ts +14 -14
  117. package/dist/commands/types/parseTypesFromLocalFiles.js +37 -37
  118. package/dist/commands/types/parseTypesFromTemplateAndDataFromLocalFiles.d.ts +15 -15
  119. package/dist/commands/types/parseTypesFromTemplateAndDataFromLocalFiles.js +39 -39
  120. package/dist/commands/types/parseTypesFromTemplateFromLocalFiles.d.ts +14 -14
  121. package/dist/commands/types/parseTypesFromTemplateFromLocalFiles.js +38 -38
  122. package/dist/commands/types/uploadOptionSetHierarchies.d.ts +12 -12
  123. package/dist/commands/types/uploadOptionSetHierarchies.js +257 -257
  124. package/dist/commands/types/uploadOptionSets.d.ts +13 -13
  125. package/dist/commands/types/uploadOptionSets.js +155 -155
  126. package/dist/commands/types/uploadOptionSetsHierarchyLocalFile.d.ts +15 -15
  127. package/dist/commands/types/uploadOptionSetsHierarchyLocalFile.js +135 -135
  128. package/dist/commands/types/uploadRuleSets.d.ts +12 -12
  129. package/dist/commands/types/uploadRuleSets.js +197 -197
  130. package/dist/commands/types/uploadTypePolicies.d.ts +12 -12
  131. package/dist/commands/types/uploadTypePolicies.js +233 -233
  132. package/dist/commands/types/uploadTypePropertyPolicies.d.ts +13 -13
  133. package/dist/commands/types/uploadTypePropertyPolicies.js +286 -286
  134. package/dist/commands/types/uploadTypes.d.ts +13 -13
  135. package/dist/commands/types/uploadTypes.js +35 -35
  136. package/dist/commands/types/uploadUsageInfo.d.ts +15 -12
  137. package/dist/commands/types/uploadUsageInfo.js +179 -172
  138. package/dist/commands/types/uploadUsageInfo.spec.d.ts +1 -0
  139. package/dist/commands/types/uploadUsageInfo.spec.js +249 -0
  140. package/dist/commands/users/export.d.ts +14 -14
  141. package/dist/commands/users/export.js +76 -76
  142. package/dist/commands/users/import.d.ts +14 -14
  143. package/dist/commands/users/import.js +68 -68
  144. package/dist/commands/webhooks/create.d.ts +11 -11
  145. package/dist/commands/webhooks/create.js +25 -25
  146. package/dist/commands/webhooks/delete.d.ts +14 -14
  147. package/dist/commands/webhooks/delete.js +53 -53
  148. package/dist/commands/webhooks/getWebhookTrigger.d.ts +13 -13
  149. package/dist/commands/webhooks/getWebhookTrigger.js +40 -40
  150. package/dist/commands/webhooks/list.d.ts +12 -12
  151. package/dist/commands/webhooks/list.js +31 -31
  152. package/dist/commands/workflow-template-definitions/install.d.ts +10 -10
  153. package/dist/commands/workflow-template-definitions/install.js +19 -19
  154. package/dist/commands/workflow-template-definitions/list.d.ts +10 -10
  155. package/dist/commands/workflow-template-definitions/list.js +19 -19
  156. package/dist/commands/workflow-templates/delete.d.ts +10 -10
  157. package/dist/commands/workflow-templates/delete.js +19 -19
  158. package/dist/commands/workflow-templates/export.d.ts +14 -14
  159. package/dist/commands/workflow-templates/export.js +78 -78
  160. package/dist/commands/workflow-templates/list.d.ts +10 -10
  161. package/dist/commands/workflow-templates/list.js +19 -19
  162. package/dist/commands/workflow-templates/load.d.ts +13 -13
  163. package/dist/commands/workflow-templates/load.js +26 -26
  164. package/dist/common.d.ts +4 -4
  165. package/dist/common.js +18 -18
  166. package/dist/helpers/app/actions-deployer.d.ts +11 -11
  167. package/dist/helpers/app/actions-deployer.js +123 -123
  168. package/dist/helpers/app/app-config-validators.d.ts +22 -22
  169. package/dist/helpers/app/app-config-validators.js +100 -100
  170. package/dist/helpers/app/app-config-validators.spec.d.ts +1 -1
  171. package/dist/helpers/app/app-config-validators.spec.js +310 -310
  172. package/dist/helpers/app/app-deployer.d.ts +12 -12
  173. package/dist/helpers/app/app-deployer.js +278 -278
  174. package/dist/helpers/app/app-template-parsers.d.ts +14 -14
  175. package/dist/helpers/app/app-template-parsers.js +106 -106
  176. package/dist/helpers/app/extension-package-deployer.d.ts +7 -7
  177. package/dist/helpers/app/extension-package-deployer.js +175 -175
  178. package/dist/helpers/app/extensions-deployer.d.ts +9 -9
  179. package/dist/helpers/app/extensions-deployer.js +95 -91
  180. package/dist/helpers/app/load-app-config.d.ts +4 -4
  181. package/dist/helpers/app/load-app-config.js +22 -22
  182. package/dist/helpers/app/metadata-extractor.d.ts +1 -1
  183. package/dist/helpers/app/metadata-extractor.js +100 -100
  184. package/dist/helpers/app/setup-template.d.ts +8 -8
  185. package/dist/helpers/app/setup-template.js +48 -48
  186. package/dist/helpers/app/update-app-config.d.ts +2 -2
  187. package/dist/helpers/app/update-app-config.js +20 -20
  188. package/dist/helpers/app/upgrade-version.d.ts +16 -16
  189. package/dist/helpers/app/upgrade-version.js +37 -37
  190. package/dist/helpers/app/upgrade-version.spec.d.ts +1 -1
  191. package/dist/helpers/app/upgrade-version.spec.js +33 -33
  192. package/dist/helpers/colors/helpers.d.ts +12 -12
  193. package/dist/helpers/colors/helpers.js +84 -84
  194. package/dist/helpers/config/config.d.ts +16 -16
  195. package/dist/helpers/config/config.js +223 -223
  196. package/dist/helpers/file-helpers.d.ts +2 -2
  197. package/dist/helpers/file-helpers.js +36 -36
  198. package/dist/helpers/load/helpers.d.ts +20 -20
  199. package/dist/helpers/load/helpers.js +141 -141
  200. package/dist/helpers/load/helpers.spec.d.ts +1 -1
  201. package/dist/helpers/load/helpers.spec.js +62 -62
  202. package/dist/helpers/load/validators.d.ts +14 -14
  203. package/dist/helpers/load/validators.js +182 -182
  204. package/dist/helpers/load/validators.spec.d.ts +1 -1
  205. package/dist/helpers/load/validators.spec.js +450 -450
  206. package/dist/helpers/projects/helpers.d.ts +3 -3
  207. package/dist/helpers/projects/helpers.js +167 -167
  208. package/dist/helpers/types/csv-parser.d.ts +1 -1
  209. package/dist/helpers/types/csv-parser.js +59 -59
  210. package/dist/helpers/types/parseOptionSetsLocalFiles.spec.d.ts +1 -1
  211. package/dist/helpers/types/parseOptionSetsLocalFiles.spec.js +285 -285
  212. package/dist/helpers/types/type-extractor.d.ts +1 -1
  213. package/dist/helpers/types/type-extractor.js +36 -36
  214. package/dist/helpers/types/type-parser.d.ts +4 -4
  215. package/dist/helpers/types/type-parser.js +119 -119
  216. package/dist/helpers/types/type-uploader.d.ts +20 -20
  217. package/dist/helpers/types/type-uploader.js +336 -336
  218. package/dist/helpers/types/type-uploader.spec.d.ts +1 -1
  219. package/dist/helpers/types/type-uploader.spec.js +266 -266
  220. package/dist/helpers/types/uploadOptionSets.spec.d.ts +1 -1
  221. package/dist/helpers/types/uploadOptionSets.spec.js +19 -19
  222. package/dist/helpers/workflow-template-definitions/workflow-template-definition-deployer.d.ts +12 -12
  223. package/dist/helpers/workflow-template-definitions/workflow-template-definition-deployer.js +158 -158
  224. package/dist/helpers/workflow-templates/helper.d.ts +20 -20
  225. package/dist/helpers/workflow-templates/helper.js +285 -285
  226. package/dist/index.d.ts +1 -1
  227. package/dist/index.js +5 -5
  228. package/dist/interfaces.d.ts +470 -443
  229. package/dist/interfaces.js +163 -163
  230. package/dist/logger.d.ts +3 -3
  231. package/dist/logger.js +33 -33
  232. package/oclif.manifest.json +1 -1
  233. package/package.json +6 -6
@@ -1,443 +1,470 @@
1
- import { AppExtensionType, AppExtensionUserApps, NodeRuntime } from '@contrail/entity-types';
2
- import { ExternalLink } from '@contrail/entity-types';
3
- /** Describes the derivative JSON / object represented
4
- * in app.yml file.
5
- */
6
- export interface AppDeclaration {
7
- appIdentifier: string;
8
- appName: string;
9
- appDescription?: string;
10
- visibility: 'private' | 'public';
11
- accessGrants?: AccessGrantConfiguration[];
12
- publisher: string;
13
- version: string;
14
- eventWorkflowTriggerKeyMapping: string;
15
- thumbnail?: string;
16
- keywords?: Array<string>;
17
- actions?: {
18
- [key: string]: AppActionDeclaration;
19
- };
20
- extensions?: ExtensionDefinitionDeclaration[];
21
- appConfiguration: ConfigPropertyElements;
22
- externalLinks: ExternalLink[];
23
- triggers: {
24
- [key: string]: AppTriggerDeclaration;
25
- };
26
- workflows?: {
27
- [key: string]: WorkflowDefinition | WorkflowTemplateDeclaration;
28
- };
29
- nodeRuntime?: NodeRuntime;
30
- }
31
- export interface AccessGrantConfiguration {
32
- orgSlug: string;
33
- permissions: AppAccessPermission[];
34
- }
35
- export type CreateAppAccessGrantDTO = {
36
- issuerReference: string;
37
- recipientReference: string;
38
- scope: AppAccessGrantScope;
39
- };
40
- export interface AppAccessGrant extends CreateAppAccessGrantDTO {
41
- appId: string;
42
- }
43
- export declare enum AppAccessGrantScope {
44
- install = "INSTALL"
45
- }
46
- export declare enum AppAccessPermission {
47
- INSTALL = "install"
48
- }
49
- export interface ExtensionDefinitionDeclaration {
50
- name: string;
51
- identifier: string;
52
- extensionType?: AppExtensionType;
53
- userApps?: AppExtensionUserApps[];
54
- modalDimensions?: any;
55
- iframeUrl?: string;
56
- }
57
- export interface ConfigPropertyElements {
58
- [key: string]: ConfigPropertyElement;
59
- }
60
- export interface ConfigPropertyElement {
61
- propertyType: string;
62
- options?: any[];
63
- label: string;
64
- dynamic?: boolean;
65
- masked?: boolean;
66
- }
67
- export interface AppActionDeclaration {
68
- handler: string;
69
- public?: boolean;
70
- name: string;
71
- internal?: boolean;
72
- description?: string;
73
- actionConfiguration?: ConfigPropertyElements;
74
- async?: boolean;
75
- }
76
- export interface AppTriggerDeclaration {
77
- key: string;
78
- name: string;
79
- external?: boolean;
80
- description?: string;
81
- }
82
- export interface WorkflowDefinition {
83
- id?: string;
84
- identifier: string;
85
- name: string;
86
- triggerKey: string;
87
- workflowDefinition: WorkflowDefinitionPaths;
88
- ownerKey: string;
89
- isActive: boolean;
90
- public: boolean;
91
- builtIn?: boolean;
92
- supportingAppId?: string;
93
- parallelWorkerCount?: number;
94
- messageGroupId?: string;
95
- messageGroup?: string;
96
- dynamicMessageGroupId?: string;
97
- }
98
- export interface WorkflowTemplateDeclaration {
99
- appIdentifier: string;
100
- workflows?: WorkflowTemplate[];
101
- }
102
- export interface WorkflowTemplate {
103
- id?: string;
104
- identifier?: string;
105
- name: string;
106
- builtIn?: boolean;
107
- triggerKey: string;
108
- workflowDefinition: WorkflowDefinitionPaths;
109
- isActive: boolean;
110
- ownerKey?: string;
111
- crons?: CronDeclaration[];
112
- supportingAppId?: string;
113
- parallelWorkerCount?: number;
114
- messageGroupId?: string;
115
- messageGroup?: string;
116
- dynamicMessageGroupId?: string;
117
- createdOn?: Date;
118
- updatedOn?: Date;
119
- createdById?: string;
120
- updatedById?: string;
121
- createdBy?: any;
122
- updatedBy?: any;
123
- }
124
- export interface WorkflowDefinitionPaths {
125
- paths: WorkflowConditional[];
126
- }
127
- export interface WorkflowConditional {
128
- conditional: string;
129
- actionDefinitionConfigs: ActionDefinitionConfig[];
130
- }
131
- export interface ActionDefinitionConfig {
132
- name: string;
133
- action: string;
134
- config?: {
135
- [key: string]: any;
136
- };
137
- id?: string;
138
- identifier?: string;
139
- }
140
- export interface App {
141
- id: string;
142
- identifier: string;
143
- name: string;
144
- public: boolean;
145
- description?: string;
146
- publisher: string;
147
- thumbnail: string;
148
- eventWorkflowTriggerKeyMapping: string;
149
- configProperties?: ConfigProperty[];
150
- triggerKeyDefinitions?: TriggerKeyDefinition[];
151
- latestAppVersionId?: string;
152
- }
153
- export interface AppOrg {
154
- id: string;
155
- createdOn?: Date;
156
- updatedOn?: Date;
157
- createdById?: string;
158
- updatedById?: string;
159
- createdBy?: any;
160
- updatedBy?: any;
161
- orgId?: string;
162
- status: AppOrgStatus;
163
- appId?: string;
164
- app?: App;
165
- appVersionId?: string;
166
- appVersion?: AppVersion;
167
- apiKey?: AppApiKey;
168
- appConfig?: any;
169
- }
170
- export interface Webhook {
171
- id?: string;
172
- createdOn?: Date;
173
- createdById?: string;
174
- createdBy?: any;
175
- orgId?: string;
176
- }
177
- export interface AppCodePackage {
178
- id: string;
179
- appId: string;
180
- uploadURL: string;
181
- }
182
- export declare enum AppOrgStatus {
183
- INSTALLING = "INSTALLING",
184
- FAILED_INSTALLING = "FAILED_INSTALLING",
185
- READY = "READY",
186
- DELETING = "DELETING",
187
- FAILED_DELETING = "FAILED_DELETING"
188
- }
189
- export declare enum AppVersionStatus {
190
- PUBLISHING = "PUBLISHING",
191
- FAILED_PUBLISHING = "FAILED_PUBLISHING",
192
- PUBLISHED = "PUBLISHED",
193
- ARCHIVING = "ARCHIVING",
194
- FAILED_ARCHIVING = "FAILED_ARCHIVING",
195
- ARCHIVED = "ARCHIVED"
196
- }
197
- export declare class AppVersion {
198
- id: string;
199
- createdOn?: Date;
200
- updatedOn?: Date;
201
- createdById?: string;
202
- updatedById?: string;
203
- createdBy?: any;
204
- updatedBy?: any;
205
- orgId?: string;
206
- appId?: string;
207
- app?: App;
208
- appOrgs?: AppOrg[];
209
- versionNumber: number;
210
- semver: string;
211
- status: AppVersionStatus;
212
- eventWorkflowTriggerKeyMapping: string;
213
- configProperties?: ConfigProperty[];
214
- triggerKeyDefinitions?: TriggerKeyDefinition[];
215
- }
216
- export declare class AppApiKey {
217
- id: string;
218
- createdOn?: Date;
219
- updatedOn?: Date;
220
- createdById?: string;
221
- updatedById?: string;
222
- createdBy?: any;
223
- updatedBy?: any;
224
- orgId?: string;
225
- appOrgId?: string;
226
- appOrg?: AppOrg;
227
- apiKey?: string;
228
- }
229
- export declare class ConfigProperty {
230
- slug: string;
231
- propertyType: string;
232
- options?: any[];
233
- label: string;
234
- }
235
- export interface EventWorkflowActionDefinition {
236
- id?: string;
237
- identifier?: string;
238
- name?: string;
239
- internal?: boolean;
240
- executeFunctionString?: string;
241
- ownerKey?: string;
242
- public?: boolean;
243
- configProperties?: ConfigProperty[];
244
- async?: boolean;
245
- }
246
- export declare class TriggerKeyDefinition {
247
- name: string;
248
- description?: string;
249
- triggerKey: string;
250
- external?: boolean;
251
- }
252
- export declare class CommonConfiguration {
253
- [key: string]: any;
254
- }
255
- export declare enum AssortmentType {
256
- ASSORTMENT = "ASSORTMENT",
257
- BOARD = "BOARD",
258
- PLAN = "PLAN",
259
- SHOWCASE = "SHOWCASE"
260
- }
261
- export declare class AssortmentConfiguration {
262
- identifier: string;
263
- name: string;
264
- type: AssortmentType;
265
- sourceAssortmentIdentifier?: string;
266
- composedFromAssortmentIdentifiers?: string[];
267
- ownerAtts?: {
268
- [key: string]: any;
269
- };
270
- assortmentAtts?: {
271
- [key: string]: any;
272
- };
273
- }
274
- export declare class Folder {
275
- identifier: string;
276
- name: string;
277
- principals: string[];
278
- assortments: AssortmentConfiguration[];
279
- subFolders: Folder[];
280
- }
281
- export declare class ProjectConfiguration {
282
- projectName: string;
283
- identifier: string;
284
- commonConfig: CommonConfiguration;
285
- principals: string[];
286
- assortments: AssortmentConfiguration[];
287
- subFolders: Folder[];
288
- }
289
- export declare class ProjectConfigurationTemplate {
290
- projectName: string;
291
- identifier: string;
292
- commonConfig: CommonConfiguration;
293
- principals: string[];
294
- allFolders: FolderSlim[];
295
- allAssortments: AssortmentConfigurationSlim[];
296
- allAssortmentRelationships: AssortmentConfigurationRelationships[];
297
- }
298
- export declare class FolderSlim {
299
- identifier: string;
300
- name: string;
301
- principals: string[];
302
- folderIdentifier: string;
303
- }
304
- export declare class AssortmentConfigurationSlim {
305
- identifier: string;
306
- name: string;
307
- type: AssortmentType;
308
- folderIdentifier: string;
309
- sourceAssortmentIdentifier?: string;
310
- composedFromAssortmentIdentifiers?: string[];
311
- ownerAtts?: {
312
- [key: string]: any;
313
- };
314
- assortmentAtts?: {
315
- [key: string]: any;
316
- };
317
- }
318
- export declare class AssortmentConfigurationRelationships {
319
- identifier: string;
320
- sourceAssortmentIdentifier?: string;
321
- composedFromAssortmentIdentifiers?: string[];
322
- ownerAtts?: {
323
- [key: string]: any;
324
- };
325
- assortmentAtts?: {
326
- [key: string]: any;
327
- };
328
- }
329
- export interface ReducedType {
330
- slug: string;
331
- label: string;
332
- typePath: string;
333
- isArchived: boolean;
334
- typeProperties: ReducedTypeProperty[];
335
- }
336
- export interface ReducedTypeProperty {
337
- id: string;
338
- isArchived: boolean;
339
- propertyType: PropertyType;
340
- slug: string;
341
- carryOverDefault: any;
342
- carryOverBehavior: string;
343
- label: string;
344
- editable: boolean;
345
- searchable: boolean;
346
- core: boolean;
347
- typePropertyOptionSetSlug: string;
348
- formula: string;
349
- referencedTypePath: string;
350
- referencedTypeRole: string;
351
- typePropertyUserListId: string;
352
- typePropertyUserListName?: string;
353
- isUniqueProperty: boolean;
354
- isUniquePropertyInFamily: boolean;
355
- referencedTypeRootSlug: string;
356
- defaultValue: string;
357
- propertyLevel: string;
358
- inherited: boolean;
359
- formulaFunction?: string;
360
- validationFunction?: string;
361
- numberFormat?: any;
362
- sequenceSeedValue?: number;
363
- copyBehavior?: string;
364
- }
365
- export interface ReducedOptionSet {
366
- name: string;
367
- slug: string;
368
- isArchived: boolean;
369
- optionSet: any[];
370
- }
371
- export declare enum PropertyType {
372
- Text = "text",
373
- String = "string",
374
- Number = "number",
375
- Date = "date",
376
- Boolean = "boolean",
377
- MultiSelect = "multi_select",
378
- SingleSelect = "choice",
379
- Url = "url",
380
- Currency = "currency",
381
- Percent = "percent",
382
- Rating = "rating",
383
- Formula = "formula",
384
- ObjectReference = "object_reference",
385
- ObjectReferenceList = "object_ref_list",
386
- DataGrid = "data_grid",
387
- CascadingSelect = "cascading_select",
388
- Sequence = "sequence",
389
- Constant = "constant",
390
- Composite = "composite",
391
- UserList = "userList",
392
- Image = "image",
393
- Json = "json"
394
- }
395
- export interface CronDeclaration {
396
- name: string;
397
- cron: string;
398
- }
399
- export declare enum AppExtensionDeploymentStatus {
400
- PENDING = "PENDING",
401
- PROCESSING = "PROCESSING",
402
- FAILED = "FAILED",
403
- DEPLOYED = "DEPLOYED"
404
- }
405
- export declare enum AppExtensionPackageStatus {
406
- PENDING = "PENDING",
407
- PROCESSING = "PROCESSING",
408
- FAILED = "FAILED",
409
- READY = "READY"
410
- }
411
- export interface AppExtensionPackage {
412
- id: string;
413
- createdOn?: Date;
414
- updatedOn?: Date;
415
- createdById?: string;
416
- updatedById?: string;
417
- createdBy?: any;
418
- updatedBy?: any;
419
- orgId?: string;
420
- name: string;
421
- appId?: string;
422
- app?: App;
423
- deploymentId?: string;
424
- deployment?: AppExtensionDeployment;
425
- status: AppExtensionPackageStatus;
426
- uploadURL?: string;
427
- }
428
- export interface AppExtensionDeployment {
429
- id: string;
430
- createdOn?: Date;
431
- updatedOn?: Date;
432
- createdById?: string;
433
- updatedById?: string;
434
- createdBy?: any;
435
- updatedBy?: any;
436
- orgId?: string;
437
- appId?: string;
438
- app?: App;
439
- name: string;
440
- cloudFrontUrl?: string;
441
- distributionId?: string;
442
- status: AppExtensionDeploymentStatus;
443
- }
1
+ import { AppExtensionType, AppExtensionUserApps, NodeRuntime, AppExtensionDisplayConfiguration } from '@contrail/entity-types';
2
+ import { ExternalLink } from '@contrail/entity-types';
3
+ /** Describes the derivative JSON / object represented
4
+ * in app.yml file.
5
+ */
6
+ export interface AppDeclaration {
7
+ appIdentifier: string;
8
+ appName: string;
9
+ appDescription?: string;
10
+ visibility: 'private' | 'public';
11
+ accessGrants?: AccessGrantConfiguration[];
12
+ publisher: string;
13
+ version: string;
14
+ eventWorkflowTriggerKeyMapping: string;
15
+ thumbnail?: string;
16
+ keywords?: Array<string>;
17
+ actions?: {
18
+ [key: string]: AppActionDeclaration;
19
+ };
20
+ extensions?: ExtensionDefinitionDeclaration[];
21
+ appConfiguration: ConfigPropertyElements;
22
+ externalLinks: ExternalLink[];
23
+ triggers: {
24
+ [key: string]: AppTriggerDeclaration;
25
+ };
26
+ workflows?: {
27
+ [key: string]: WorkflowDefinition | WorkflowTemplateDeclaration;
28
+ };
29
+ nodeRuntime?: NodeRuntime;
30
+ }
31
+ export interface AccessGrantConfiguration {
32
+ orgSlug: string;
33
+ permissions: AppAccessPermission[];
34
+ }
35
+ export type CreateAppAccessGrantDTO = {
36
+ issuerReference: string;
37
+ recipientReference: string;
38
+ scope: AppAccessGrantScope;
39
+ };
40
+ export interface AppAccessGrant extends CreateAppAccessGrantDTO {
41
+ appId: string;
42
+ }
43
+ export declare enum AppAccessGrantScope {
44
+ install = "INSTALL"
45
+ }
46
+ export declare enum AppAccessPermission {
47
+ INSTALL = "install"
48
+ }
49
+ export interface ExtensionDefinitionDeclaration {
50
+ name: string;
51
+ identifier: string;
52
+ extensionType?: AppExtensionType;
53
+ userApps?: AppExtensionUserApps[];
54
+ /** @deprecated since entity-types v1.5.1, use display instead */
55
+ modalDimensions?: any;
56
+ display?: AppExtensionDisplayConfiguration;
57
+ iframeUrl?: string;
58
+ }
59
+ export interface ConfigPropertyElements {
60
+ [key: string]: ConfigPropertyElement;
61
+ }
62
+ export interface ConfigPropertyElement {
63
+ propertyType: string;
64
+ options?: any[];
65
+ label: string;
66
+ dynamic?: boolean;
67
+ masked?: boolean;
68
+ }
69
+ export interface AppActionDeclaration {
70
+ handler: string;
71
+ public?: boolean;
72
+ name: string;
73
+ internal?: boolean;
74
+ description?: string;
75
+ actionConfiguration?: ConfigPropertyElements;
76
+ async?: boolean;
77
+ }
78
+ export interface AppTriggerDeclaration {
79
+ key: string;
80
+ name: string;
81
+ external?: boolean;
82
+ description?: string;
83
+ }
84
+ export interface WorkflowDefinition {
85
+ id?: string;
86
+ identifier: string;
87
+ name: string;
88
+ triggerKey: string;
89
+ workflowDefinition: WorkflowDefinitionPaths;
90
+ ownerKey: string;
91
+ isActive: boolean;
92
+ public: boolean;
93
+ builtIn?: boolean;
94
+ supportingAppId?: string;
95
+ parallelWorkerCount?: number;
96
+ messageGroupId?: string;
97
+ messageGroup?: string;
98
+ dynamicMessageGroupId?: string;
99
+ }
100
+ export interface WorkflowTemplateDeclaration {
101
+ appIdentifier: string;
102
+ workflows?: WorkflowTemplate[];
103
+ }
104
+ export interface WorkflowTemplate {
105
+ id?: string;
106
+ identifier?: string;
107
+ name: string;
108
+ builtIn?: boolean;
109
+ triggerKey: string;
110
+ workflowDefinition: WorkflowDefinitionPaths;
111
+ isActive: boolean;
112
+ ownerKey?: string;
113
+ crons?: CronDeclaration[];
114
+ supportingAppId?: string;
115
+ parallelWorkerCount?: number;
116
+ messageGroupId?: string;
117
+ messageGroup?: string;
118
+ dynamicMessageGroupId?: string;
119
+ createdOn?: Date;
120
+ updatedOn?: Date;
121
+ createdById?: string;
122
+ updatedById?: string;
123
+ createdBy?: any;
124
+ updatedBy?: any;
125
+ }
126
+ export interface WorkflowDefinitionPaths {
127
+ paths: WorkflowConditional[];
128
+ }
129
+ export interface WorkflowConditional {
130
+ conditional: string;
131
+ actionDefinitionConfigs: ActionDefinitionConfig[];
132
+ }
133
+ export interface ActionDefinitionConfig {
134
+ name: string;
135
+ action: string;
136
+ config?: {
137
+ [key: string]: any;
138
+ };
139
+ id?: string;
140
+ identifier?: string;
141
+ }
142
+ export interface App {
143
+ id: string;
144
+ identifier: string;
145
+ name: string;
146
+ public: boolean;
147
+ description?: string;
148
+ publisher: string;
149
+ thumbnail: string;
150
+ eventWorkflowTriggerKeyMapping: string;
151
+ configProperties?: ConfigProperty[];
152
+ triggerKeyDefinitions?: TriggerKeyDefinition[];
153
+ latestAppVersionId?: string;
154
+ }
155
+ export interface AppOrg {
156
+ id: string;
157
+ createdOn?: Date;
158
+ updatedOn?: Date;
159
+ createdById?: string;
160
+ updatedById?: string;
161
+ createdBy?: any;
162
+ updatedBy?: any;
163
+ orgId?: string;
164
+ status: AppOrgStatus;
165
+ appId?: string;
166
+ app?: App;
167
+ appVersionId?: string;
168
+ appVersion?: AppVersion;
169
+ apiKey?: AppApiKey;
170
+ appConfig?: any;
171
+ }
172
+ export interface Webhook {
173
+ id?: string;
174
+ createdOn?: Date;
175
+ createdById?: string;
176
+ createdBy?: any;
177
+ orgId?: string;
178
+ }
179
+ export interface AppCodePackage {
180
+ id: string;
181
+ appId: string;
182
+ uploadURL: string;
183
+ }
184
+ export declare enum AppOrgStatus {
185
+ INSTALLING = "INSTALLING",
186
+ FAILED_INSTALLING = "FAILED_INSTALLING",
187
+ READY = "READY",
188
+ DELETING = "DELETING",
189
+ FAILED_DELETING = "FAILED_DELETING"
190
+ }
191
+ export declare enum AppVersionStatus {
192
+ PUBLISHING = "PUBLISHING",
193
+ FAILED_PUBLISHING = "FAILED_PUBLISHING",
194
+ PUBLISHED = "PUBLISHED",
195
+ ARCHIVING = "ARCHIVING",
196
+ FAILED_ARCHIVING = "FAILED_ARCHIVING",
197
+ ARCHIVED = "ARCHIVED"
198
+ }
199
+ export declare class AppVersion {
200
+ id: string;
201
+ createdOn?: Date;
202
+ updatedOn?: Date;
203
+ createdById?: string;
204
+ updatedById?: string;
205
+ createdBy?: any;
206
+ updatedBy?: any;
207
+ orgId?: string;
208
+ appId?: string;
209
+ app?: App;
210
+ appOrgs?: AppOrg[];
211
+ versionNumber: number;
212
+ semver: string;
213
+ status: AppVersionStatus;
214
+ eventWorkflowTriggerKeyMapping: string;
215
+ configProperties?: ConfigProperty[];
216
+ triggerKeyDefinitions?: TriggerKeyDefinition[];
217
+ }
218
+ export declare class AppApiKey {
219
+ id: string;
220
+ createdOn?: Date;
221
+ updatedOn?: Date;
222
+ createdById?: string;
223
+ updatedById?: string;
224
+ createdBy?: any;
225
+ updatedBy?: any;
226
+ orgId?: string;
227
+ appOrgId?: string;
228
+ appOrg?: AppOrg;
229
+ apiKey?: string;
230
+ }
231
+ export declare class ConfigProperty {
232
+ slug: string;
233
+ propertyType: string;
234
+ options?: any[];
235
+ label: string;
236
+ }
237
+ export interface EventWorkflowActionDefinition {
238
+ id?: string;
239
+ identifier?: string;
240
+ name?: string;
241
+ internal?: boolean;
242
+ executeFunctionString?: string;
243
+ ownerKey?: string;
244
+ public?: boolean;
245
+ configProperties?: ConfigProperty[];
246
+ async?: boolean;
247
+ }
248
+ export declare class TriggerKeyDefinition {
249
+ name: string;
250
+ description?: string;
251
+ triggerKey: string;
252
+ external?: boolean;
253
+ }
254
+ export declare class CommonConfiguration {
255
+ [key: string]: any;
256
+ }
257
+ export declare enum AssortmentType {
258
+ ASSORTMENT = "ASSORTMENT",
259
+ BOARD = "BOARD",
260
+ PLAN = "PLAN",
261
+ SHOWCASE = "SHOWCASE"
262
+ }
263
+ export declare class AssortmentConfiguration {
264
+ identifier: string;
265
+ name: string;
266
+ type: AssortmentType;
267
+ sourceAssortmentIdentifier?: string;
268
+ composedFromAssortmentIdentifiers?: string[];
269
+ ownerAtts?: {
270
+ [key: string]: any;
271
+ };
272
+ assortmentAtts?: {
273
+ [key: string]: any;
274
+ };
275
+ }
276
+ export declare class Folder {
277
+ identifier: string;
278
+ name: string;
279
+ principals: string[];
280
+ assortments: AssortmentConfiguration[];
281
+ subFolders: Folder[];
282
+ }
283
+ export declare class ProjectConfiguration {
284
+ projectName: string;
285
+ identifier: string;
286
+ commonConfig: CommonConfiguration;
287
+ principals: string[];
288
+ assortments: AssortmentConfiguration[];
289
+ subFolders: Folder[];
290
+ }
291
+ export declare class ProjectConfigurationTemplate {
292
+ projectName: string;
293
+ identifier: string;
294
+ commonConfig: CommonConfiguration;
295
+ principals: string[];
296
+ allFolders: FolderSlim[];
297
+ allAssortments: AssortmentConfigurationSlim[];
298
+ allAssortmentRelationships: AssortmentConfigurationRelationships[];
299
+ }
300
+ export declare class FolderSlim {
301
+ identifier: string;
302
+ name: string;
303
+ principals: string[];
304
+ folderIdentifier: string;
305
+ }
306
+ export declare class AssortmentConfigurationSlim {
307
+ identifier: string;
308
+ name: string;
309
+ type: AssortmentType;
310
+ folderIdentifier: string;
311
+ sourceAssortmentIdentifier?: string;
312
+ composedFromAssortmentIdentifiers?: string[];
313
+ ownerAtts?: {
314
+ [key: string]: any;
315
+ };
316
+ assortmentAtts?: {
317
+ [key: string]: any;
318
+ };
319
+ }
320
+ export declare class AssortmentConfigurationRelationships {
321
+ identifier: string;
322
+ sourceAssortmentIdentifier?: string;
323
+ composedFromAssortmentIdentifiers?: string[];
324
+ ownerAtts?: {
325
+ [key: string]: any;
326
+ };
327
+ assortmentAtts?: {
328
+ [key: string]: any;
329
+ };
330
+ }
331
+ export interface ReducedType {
332
+ slug: string;
333
+ label: string;
334
+ typePath: string;
335
+ isArchived: boolean;
336
+ typeProperties: ReducedTypeProperty[];
337
+ }
338
+ export interface ReducedTypeProperty {
339
+ id: string;
340
+ isArchived: boolean;
341
+ propertyType: PropertyType;
342
+ slug: string;
343
+ carryOverDefault: any;
344
+ carryOverBehavior: string;
345
+ label: string;
346
+ editable: boolean;
347
+ searchable: boolean;
348
+ core: boolean;
349
+ typePropertyOptionSetSlug: string;
350
+ formula: string;
351
+ referencedTypePath: string;
352
+ referencedTypeRole: string;
353
+ typePropertyUserListId: string;
354
+ typePropertyUserListName?: string;
355
+ isUniqueProperty: boolean;
356
+ isUniquePropertyInFamily: boolean;
357
+ referencedTypeRootSlug: string;
358
+ defaultValue: string;
359
+ propertyLevel: string;
360
+ inherited: boolean;
361
+ formulaFunction?: string;
362
+ validationFunction?: string;
363
+ numberFormat?: any;
364
+ sequenceSeedValue?: number;
365
+ copyBehavior?: string;
366
+ }
367
+ export interface ReducedOptionSet {
368
+ name: string;
369
+ slug: string;
370
+ isArchived: boolean;
371
+ optionSet: any[];
372
+ }
373
+ export interface ReducedUsageInfo {
374
+ typeId: string;
375
+ typePropertyId: string;
376
+ typePath: string;
377
+ typePropertySlug: string;
378
+ editable: boolean;
379
+ used: boolean;
380
+ formulaFunction?: string;
381
+ validationFunction?: string;
382
+ numberFormat?: any;
383
+ defaultValue?: string;
384
+ label?: string;
385
+ required?: boolean;
386
+ searchable?: boolean;
387
+ isUniqueProperty?: boolean;
388
+ isUniquePropertyInFamily?: boolean;
389
+ copyBehavior?: string;
390
+ copyDefault?: string;
391
+ propertyLevel?: string;
392
+ isArchived: boolean;
393
+ isFederationProperty?: boolean;
394
+ carryOverBehavior?: string;
395
+ carryOverDefault?: string;
396
+ }
397
+ export type PersistReducedUsageInfo = Omit<ReducedUsageInfo, 'typePath' | 'typePropertySlug'>;
398
+ export declare enum PropertyType {
399
+ Text = "text",
400
+ String = "string",
401
+ Number = "number",
402
+ Date = "date",
403
+ Boolean = "boolean",
404
+ MultiSelect = "multi_select",
405
+ SingleSelect = "choice",
406
+ Url = "url",
407
+ Currency = "currency",
408
+ Percent = "percent",
409
+ Rating = "rating",
410
+ Formula = "formula",
411
+ ObjectReference = "object_reference",
412
+ ObjectReferenceList = "object_ref_list",
413
+ DataGrid = "data_grid",
414
+ CascadingSelect = "cascading_select",
415
+ Sequence = "sequence",
416
+ Constant = "constant",
417
+ Composite = "composite",
418
+ UserList = "userList",
419
+ Image = "image",
420
+ Json = "json"
421
+ }
422
+ export interface CronDeclaration {
423
+ name: string;
424
+ cron: string;
425
+ }
426
+ export declare enum AppExtensionDeploymentStatus {
427
+ PENDING = "PENDING",
428
+ PROCESSING = "PROCESSING",
429
+ FAILED = "FAILED",
430
+ DEPLOYED = "DEPLOYED"
431
+ }
432
+ export declare enum AppExtensionPackageStatus {
433
+ PENDING = "PENDING",
434
+ PROCESSING = "PROCESSING",
435
+ FAILED = "FAILED",
436
+ READY = "READY"
437
+ }
438
+ export interface AppExtensionPackage {
439
+ id: string;
440
+ createdOn?: Date;
441
+ updatedOn?: Date;
442
+ createdById?: string;
443
+ updatedById?: string;
444
+ createdBy?: any;
445
+ updatedBy?: any;
446
+ orgId?: string;
447
+ name: string;
448
+ appId?: string;
449
+ app?: App;
450
+ deploymentId?: string;
451
+ deployment?: AppExtensionDeployment;
452
+ status: AppExtensionPackageStatus;
453
+ uploadURL?: string;
454
+ }
455
+ export interface AppExtensionDeployment {
456
+ id: string;
457
+ createdOn?: Date;
458
+ updatedOn?: Date;
459
+ createdById?: string;
460
+ updatedById?: string;
461
+ createdBy?: any;
462
+ updatedBy?: any;
463
+ orgId?: string;
464
+ appId?: string;
465
+ app?: App;
466
+ name: string;
467
+ cloudFrontUrl?: string;
468
+ distributionId?: string;
469
+ status: AppExtensionDeploymentStatus;
470
+ }