@contrail/cli 3.4.2 → 3.4.4-alpha.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 (241) hide show
  1. package/README.md +38 -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/load-local/index.d.ts +17 -0
  89. package/dist/commands/load-local/index.js +156 -0
  90. package/dist/commands/projects/export.d.ts +13 -13
  91. package/dist/commands/projects/export.js +35 -35
  92. package/dist/commands/projects/list.d.ts +10 -10
  93. package/dist/commands/projects/list.js +36 -36
  94. package/dist/commands/projects/load.d.ts +25 -25
  95. package/dist/commands/projects/load.js +198 -198
  96. package/dist/commands/types/exportOptionSetHierarchies.d.ts +11 -11
  97. package/dist/commands/types/exportOptionSetHierarchies.js +133 -133
  98. package/dist/commands/types/getAll.d.ts +21 -21
  99. package/dist/commands/types/getAll.js +180 -180
  100. package/dist/commands/types/getOptionSets.d.ts +16 -16
  101. package/dist/commands/types/getOptionSets.js +170 -170
  102. package/dist/commands/types/loadAll.d.ts +12 -12
  103. package/dist/commands/types/loadAll.js +55 -55
  104. package/dist/commands/types/mergeOptionSets.d.ts +13 -13
  105. package/dist/commands/types/mergeOptionSets.js +116 -116
  106. package/dist/commands/types/mergeTypeProperties.d.ts +15 -15
  107. package/dist/commands/types/mergeTypeProperties.js +95 -95
  108. package/dist/commands/types/parseOptionSetsHierarchyLocalFile.d.ts +14 -14
  109. package/dist/commands/types/parseOptionSetsHierarchyLocalFile.js +133 -133
  110. package/dist/commands/types/parseOptionSetsHierarchyValuesToKeysLocalFile.d.ts +14 -14
  111. package/dist/commands/types/parseOptionSetsHierarchyValuesToKeysLocalFile.js +102 -102
  112. package/dist/commands/types/parseOptionSetsLocalFiles.d.ts +39 -39
  113. package/dist/commands/types/parseOptionSetsLocalFiles.js +229 -229
  114. package/dist/commands/types/parseOptionSetsToFolderStructure.d.ts +13 -13
  115. package/dist/commands/types/parseOptionSetsToFolderStructure.js +68 -68
  116. package/dist/commands/types/parseTypesFromFiles.d.ts +14 -14
  117. package/dist/commands/types/parseTypesFromFiles.js +40 -40
  118. package/dist/commands/types/parseTypesFromLocalFiles.d.ts +14 -14
  119. package/dist/commands/types/parseTypesFromLocalFiles.js +37 -37
  120. package/dist/commands/types/parseTypesFromTemplateAndDataFromLocalFiles.d.ts +15 -15
  121. package/dist/commands/types/parseTypesFromTemplateAndDataFromLocalFiles.js +39 -39
  122. package/dist/commands/types/parseTypesFromTemplateFromLocalFiles.d.ts +14 -14
  123. package/dist/commands/types/parseTypesFromTemplateFromLocalFiles.js +38 -38
  124. package/dist/commands/types/uploadOptionSetHierarchies.d.ts +12 -12
  125. package/dist/commands/types/uploadOptionSetHierarchies.js +257 -257
  126. package/dist/commands/types/uploadOptionSets.d.ts +13 -13
  127. package/dist/commands/types/uploadOptionSets.js +155 -155
  128. package/dist/commands/types/uploadOptionSetsHierarchyLocalFile.d.ts +15 -15
  129. package/dist/commands/types/uploadOptionSetsHierarchyLocalFile.js +135 -135
  130. package/dist/commands/types/uploadRuleSets.d.ts +12 -12
  131. package/dist/commands/types/uploadRuleSets.js +197 -197
  132. package/dist/commands/types/uploadTypePolicies.d.ts +12 -12
  133. package/dist/commands/types/uploadTypePolicies.js +233 -233
  134. package/dist/commands/types/uploadTypePropertyPolicies.d.ts +13 -13
  135. package/dist/commands/types/uploadTypePropertyPolicies.js +286 -286
  136. package/dist/commands/types/uploadTypes.d.ts +13 -13
  137. package/dist/commands/types/uploadTypes.js +35 -35
  138. package/dist/commands/types/uploadUsageInfo.d.ts +15 -12
  139. package/dist/commands/types/uploadUsageInfo.js +179 -172
  140. package/dist/commands/types/uploadUsageInfo.spec.d.ts +1 -0
  141. package/dist/commands/types/uploadUsageInfo.spec.js +249 -0
  142. package/dist/commands/users/export.d.ts +14 -14
  143. package/dist/commands/users/export.js +76 -76
  144. package/dist/commands/users/import.d.ts +14 -14
  145. package/dist/commands/users/import.js +68 -68
  146. package/dist/commands/webhooks/create.d.ts +11 -11
  147. package/dist/commands/webhooks/create.js +25 -25
  148. package/dist/commands/webhooks/delete.d.ts +14 -14
  149. package/dist/commands/webhooks/delete.js +53 -53
  150. package/dist/commands/webhooks/getWebhookTrigger.d.ts +13 -13
  151. package/dist/commands/webhooks/getWebhookTrigger.js +40 -40
  152. package/dist/commands/webhooks/list.d.ts +12 -12
  153. package/dist/commands/webhooks/list.js +31 -31
  154. package/dist/commands/workflow-template-definitions/install.d.ts +10 -10
  155. package/dist/commands/workflow-template-definitions/install.js +19 -19
  156. package/dist/commands/workflow-template-definitions/list.d.ts +10 -10
  157. package/dist/commands/workflow-template-definitions/list.js +19 -19
  158. package/dist/commands/workflow-templates/delete.d.ts +10 -10
  159. package/dist/commands/workflow-templates/delete.js +19 -19
  160. package/dist/commands/workflow-templates/export.d.ts +14 -14
  161. package/dist/commands/workflow-templates/export.js +78 -78
  162. package/dist/commands/workflow-templates/list.d.ts +10 -10
  163. package/dist/commands/workflow-templates/list.js +19 -19
  164. package/dist/commands/workflow-templates/load.d.ts +13 -13
  165. package/dist/commands/workflow-templates/load.js +26 -26
  166. package/dist/common.d.ts +4 -4
  167. package/dist/common.js +18 -18
  168. package/dist/helpers/app/actions-deployer.d.ts +11 -11
  169. package/dist/helpers/app/actions-deployer.js +123 -123
  170. package/dist/helpers/app/app-config-validators.d.ts +22 -22
  171. package/dist/helpers/app/app-config-validators.js +100 -100
  172. package/dist/helpers/app/app-config-validators.spec.d.ts +1 -1
  173. package/dist/helpers/app/app-config-validators.spec.js +310 -310
  174. package/dist/helpers/app/app-deployer.d.ts +12 -12
  175. package/dist/helpers/app/app-deployer.js +278 -278
  176. package/dist/helpers/app/app-template-parsers.d.ts +14 -14
  177. package/dist/helpers/app/app-template-parsers.js +106 -106
  178. package/dist/helpers/app/extension-package-deployer.d.ts +7 -7
  179. package/dist/helpers/app/extension-package-deployer.js +175 -175
  180. package/dist/helpers/app/extensions-deployer.d.ts +9 -9
  181. package/dist/helpers/app/extensions-deployer.js +95 -95
  182. package/dist/helpers/app/load-app-config.d.ts +4 -4
  183. package/dist/helpers/app/load-app-config.js +22 -22
  184. package/dist/helpers/app/metadata-extractor.d.ts +1 -1
  185. package/dist/helpers/app/metadata-extractor.js +100 -100
  186. package/dist/helpers/app/setup-template.d.ts +8 -8
  187. package/dist/helpers/app/setup-template.js +48 -48
  188. package/dist/helpers/app/update-app-config.d.ts +2 -2
  189. package/dist/helpers/app/update-app-config.js +20 -20
  190. package/dist/helpers/app/upgrade-version.d.ts +16 -16
  191. package/dist/helpers/app/upgrade-version.js +37 -37
  192. package/dist/helpers/app/upgrade-version.spec.d.ts +1 -1
  193. package/dist/helpers/app/upgrade-version.spec.js +33 -33
  194. package/dist/helpers/colors/helpers.d.ts +12 -12
  195. package/dist/helpers/colors/helpers.js +84 -84
  196. package/dist/helpers/config/config.d.ts +16 -16
  197. package/dist/helpers/config/config.js +223 -223
  198. package/dist/helpers/file-helpers.d.ts +2 -2
  199. package/dist/helpers/file-helpers.js +36 -36
  200. package/dist/helpers/load/helpers.d.ts +20 -20
  201. package/dist/helpers/load/helpers.js +141 -141
  202. package/dist/helpers/load/helpers.spec.d.ts +1 -1
  203. package/dist/helpers/load/helpers.spec.js +62 -62
  204. package/dist/helpers/load/validators.d.ts +14 -14
  205. package/dist/helpers/load/validators.js +182 -182
  206. package/dist/helpers/load/validators.spec.d.ts +1 -1
  207. package/dist/helpers/load/validators.spec.js +450 -450
  208. package/dist/helpers/pipeline/formatters.d.ts +6 -0
  209. package/dist/helpers/pipeline/formatters.js +219 -0
  210. package/dist/helpers/projects/helpers.d.ts +3 -3
  211. package/dist/helpers/projects/helpers.js +167 -167
  212. package/dist/helpers/types/csv-parser.d.ts +1 -1
  213. package/dist/helpers/types/csv-parser.js +59 -59
  214. package/dist/helpers/types/option-set-helper.d.ts +9 -9
  215. package/dist/helpers/types/option-set-helper.js +48 -48
  216. package/dist/helpers/types/option-set-helper.spec.d.ts +1 -1
  217. package/dist/helpers/types/option-set-helper.spec.js +64 -64
  218. package/dist/helpers/types/parseOptionSetsLocalFiles.spec.d.ts +1 -1
  219. package/dist/helpers/types/parseOptionSetsLocalFiles.spec.js +285 -285
  220. package/dist/helpers/types/type-extractor.d.ts +1 -1
  221. package/dist/helpers/types/type-extractor.js +36 -36
  222. package/dist/helpers/types/type-parser.d.ts +4 -4
  223. package/dist/helpers/types/type-parser.js +119 -119
  224. package/dist/helpers/types/type-uploader.d.ts +20 -20
  225. package/dist/helpers/types/type-uploader.js +336 -336
  226. package/dist/helpers/types/type-uploader.spec.d.ts +1 -1
  227. package/dist/helpers/types/type-uploader.spec.js +266 -266
  228. package/dist/helpers/types/uploadOptionSets.spec.d.ts +1 -1
  229. package/dist/helpers/types/uploadOptionSets.spec.js +19 -19
  230. package/dist/helpers/workflow-template-definitions/workflow-template-definition-deployer.d.ts +12 -12
  231. package/dist/helpers/workflow-template-definitions/workflow-template-definition-deployer.js +158 -158
  232. package/dist/helpers/workflow-templates/helper.d.ts +20 -20
  233. package/dist/helpers/workflow-templates/helper.js +285 -285
  234. package/dist/index.d.ts +1 -1
  235. package/dist/index.js +5 -5
  236. package/dist/interfaces.d.ts +470 -445
  237. package/dist/interfaces.js +163 -163
  238. package/dist/logger.d.ts +3 -3
  239. package/dist/logger.js +33 -33
  240. package/oclif.manifest.json +85 -1
  241. package/package.json +11 -6
@@ -1,445 +1,470 @@
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 declare enum PropertyType {
374
- Text = "text",
375
- String = "string",
376
- Number = "number",
377
- Date = "date",
378
- Boolean = "boolean",
379
- MultiSelect = "multi_select",
380
- SingleSelect = "choice",
381
- Url = "url",
382
- Currency = "currency",
383
- Percent = "percent",
384
- Rating = "rating",
385
- Formula = "formula",
386
- ObjectReference = "object_reference",
387
- ObjectReferenceList = "object_ref_list",
388
- DataGrid = "data_grid",
389
- CascadingSelect = "cascading_select",
390
- Sequence = "sequence",
391
- Constant = "constant",
392
- Composite = "composite",
393
- UserList = "userList",
394
- Image = "image",
395
- Json = "json"
396
- }
397
- export interface CronDeclaration {
398
- name: string;
399
- cron: string;
400
- }
401
- export declare enum AppExtensionDeploymentStatus {
402
- PENDING = "PENDING",
403
- PROCESSING = "PROCESSING",
404
- FAILED = "FAILED",
405
- DEPLOYED = "DEPLOYED"
406
- }
407
- export declare enum AppExtensionPackageStatus {
408
- PENDING = "PENDING",
409
- PROCESSING = "PROCESSING",
410
- FAILED = "FAILED",
411
- READY = "READY"
412
- }
413
- export interface AppExtensionPackage {
414
- id: string;
415
- createdOn?: Date;
416
- updatedOn?: Date;
417
- createdById?: string;
418
- updatedById?: string;
419
- createdBy?: any;
420
- updatedBy?: any;
421
- orgId?: string;
422
- name: string;
423
- appId?: string;
424
- app?: App;
425
- deploymentId?: string;
426
- deployment?: AppExtensionDeployment;
427
- status: AppExtensionPackageStatus;
428
- uploadURL?: string;
429
- }
430
- export interface AppExtensionDeployment {
431
- id: string;
432
- createdOn?: Date;
433
- updatedOn?: Date;
434
- createdById?: string;
435
- updatedById?: string;
436
- createdBy?: any;
437
- updatedBy?: any;
438
- orgId?: string;
439
- appId?: string;
440
- app?: App;
441
- name: string;
442
- cloudFrontUrl?: string;
443
- distributionId?: string;
444
- status: AppExtensionDeploymentStatus;
445
- }
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
+ }