@knocklabs/cli 0.1.4 → 0.1.6
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.
- package/README.md +152 -6
- package/dist/commands/layout/get.js +94 -0
- package/dist/commands/layout/list.js +82 -0
- package/dist/commands/layout/pull.js +195 -0
- package/dist/commands/layout/push.js +155 -0
- package/dist/commands/layout/validate.js +130 -0
- package/dist/commands/workflow/get.js +39 -7
- package/dist/commands/workflow/list.js +4 -1
- package/dist/lib/api-v1.js +47 -0
- package/dist/lib/marshal/email-layout/helpers.js +124 -0
- package/dist/lib/marshal/email-layout/index.js +19 -0
- package/dist/lib/marshal/email-layout/reader.js +193 -0
- package/dist/lib/marshal/email-layout/types.js +4 -0
- package/dist/lib/marshal/email-layout/writer.js +240 -0
- package/dist/lib/marshal/shared/helpers.js +135 -0
- package/dist/lib/marshal/workflow/generator.js +3 -2
- package/dist/lib/marshal/workflow/helpers.js +27 -5
- package/dist/lib/marshal/workflow/reader.js +8 -106
- package/dist/lib/marshal/workflow/types.js +1 -0
- package/dist/lib/marshal/workflow/writer.js +76 -40
- package/dist/lib/run-context/loader.js +11 -0
- package/oclif.manifest.json +318 -1
- package/package.json +10 -7
package/oclif.manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.1.
|
|
2
|
+
"version": "0.1.6",
|
|
3
3
|
"commands": {
|
|
4
4
|
"knock": {
|
|
5
5
|
"id": "knock",
|
|
@@ -174,6 +174,323 @@
|
|
|
174
174
|
},
|
|
175
175
|
"args": {}
|
|
176
176
|
},
|
|
177
|
+
"layout:get": {
|
|
178
|
+
"id": "layout:get",
|
|
179
|
+
"summary": "Display a single email layout from an environment.",
|
|
180
|
+
"strict": true,
|
|
181
|
+
"pluginName": "@knocklabs/cli",
|
|
182
|
+
"pluginAlias": "@knocklabs/cli",
|
|
183
|
+
"pluginType": "core",
|
|
184
|
+
"aliases": [],
|
|
185
|
+
"flags": {
|
|
186
|
+
"service-token": {
|
|
187
|
+
"name": "service-token",
|
|
188
|
+
"type": "option",
|
|
189
|
+
"summary": "The service token to authenticate with.",
|
|
190
|
+
"required": true,
|
|
191
|
+
"multiple": false
|
|
192
|
+
},
|
|
193
|
+
"api-origin": {
|
|
194
|
+
"name": "api-origin",
|
|
195
|
+
"type": "option",
|
|
196
|
+
"hidden": true,
|
|
197
|
+
"required": false,
|
|
198
|
+
"multiple": false
|
|
199
|
+
},
|
|
200
|
+
"environment": {
|
|
201
|
+
"name": "environment",
|
|
202
|
+
"type": "option",
|
|
203
|
+
"summary": "The environment to use.",
|
|
204
|
+
"multiple": false,
|
|
205
|
+
"default": "development"
|
|
206
|
+
},
|
|
207
|
+
"hide-uncommitted-changes": {
|
|
208
|
+
"name": "hide-uncommitted-changes",
|
|
209
|
+
"type": "boolean",
|
|
210
|
+
"summary": "Hide any uncommitted changes.",
|
|
211
|
+
"allowNo": false
|
|
212
|
+
},
|
|
213
|
+
"json": {
|
|
214
|
+
"name": "json",
|
|
215
|
+
"type": "boolean",
|
|
216
|
+
"description": "Format output as json.",
|
|
217
|
+
"helpGroup": "GLOBAL",
|
|
218
|
+
"allowNo": false
|
|
219
|
+
}
|
|
220
|
+
},
|
|
221
|
+
"args": {
|
|
222
|
+
"emailLayoutKey": {
|
|
223
|
+
"name": "emailLayoutKey",
|
|
224
|
+
"required": true
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
},
|
|
228
|
+
"layout:list": {
|
|
229
|
+
"id": "layout:list",
|
|
230
|
+
"summary": "Display all email layouts for an environment.",
|
|
231
|
+
"strict": true,
|
|
232
|
+
"pluginName": "@knocklabs/cli",
|
|
233
|
+
"pluginAlias": "@knocklabs/cli",
|
|
234
|
+
"pluginType": "core",
|
|
235
|
+
"aliases": [],
|
|
236
|
+
"flags": {
|
|
237
|
+
"service-token": {
|
|
238
|
+
"name": "service-token",
|
|
239
|
+
"type": "option",
|
|
240
|
+
"summary": "The service token to authenticate with.",
|
|
241
|
+
"required": true,
|
|
242
|
+
"multiple": false
|
|
243
|
+
},
|
|
244
|
+
"api-origin": {
|
|
245
|
+
"name": "api-origin",
|
|
246
|
+
"type": "option",
|
|
247
|
+
"hidden": true,
|
|
248
|
+
"required": false,
|
|
249
|
+
"multiple": false
|
|
250
|
+
},
|
|
251
|
+
"environment": {
|
|
252
|
+
"name": "environment",
|
|
253
|
+
"type": "option",
|
|
254
|
+
"summary": "The environment to use.",
|
|
255
|
+
"multiple": false,
|
|
256
|
+
"default": "development"
|
|
257
|
+
},
|
|
258
|
+
"hide-uncommitted-changes": {
|
|
259
|
+
"name": "hide-uncommitted-changes",
|
|
260
|
+
"type": "boolean",
|
|
261
|
+
"summary": "Hide any uncommitted changes.",
|
|
262
|
+
"allowNo": false
|
|
263
|
+
},
|
|
264
|
+
"after": {
|
|
265
|
+
"name": "after",
|
|
266
|
+
"type": "option",
|
|
267
|
+
"summary": "The cursor after which to fetch the next page.",
|
|
268
|
+
"multiple": false
|
|
269
|
+
},
|
|
270
|
+
"before": {
|
|
271
|
+
"name": "before",
|
|
272
|
+
"type": "option",
|
|
273
|
+
"summary": "The cursor before which to fetch the previous page.",
|
|
274
|
+
"multiple": false
|
|
275
|
+
},
|
|
276
|
+
"limit": {
|
|
277
|
+
"name": "limit",
|
|
278
|
+
"type": "option",
|
|
279
|
+
"summary": "The total number of entries to fetch per page.",
|
|
280
|
+
"multiple": false
|
|
281
|
+
},
|
|
282
|
+
"json": {
|
|
283
|
+
"name": "json",
|
|
284
|
+
"type": "boolean",
|
|
285
|
+
"description": "Format output as json.",
|
|
286
|
+
"helpGroup": "GLOBAL",
|
|
287
|
+
"allowNo": false
|
|
288
|
+
}
|
|
289
|
+
},
|
|
290
|
+
"args": {}
|
|
291
|
+
},
|
|
292
|
+
"layout:pull": {
|
|
293
|
+
"id": "layout:pull",
|
|
294
|
+
"summary": "Pull one or more email layouts from an environment into a local file system.",
|
|
295
|
+
"strict": true,
|
|
296
|
+
"pluginName": "@knocklabs/cli",
|
|
297
|
+
"pluginAlias": "@knocklabs/cli",
|
|
298
|
+
"pluginType": "core",
|
|
299
|
+
"aliases": [],
|
|
300
|
+
"flags": {
|
|
301
|
+
"service-token": {
|
|
302
|
+
"name": "service-token",
|
|
303
|
+
"type": "option",
|
|
304
|
+
"summary": "The service token to authenticate with.",
|
|
305
|
+
"required": true,
|
|
306
|
+
"multiple": false
|
|
307
|
+
},
|
|
308
|
+
"api-origin": {
|
|
309
|
+
"name": "api-origin",
|
|
310
|
+
"type": "option",
|
|
311
|
+
"hidden": true,
|
|
312
|
+
"required": false,
|
|
313
|
+
"multiple": false
|
|
314
|
+
},
|
|
315
|
+
"environment": {
|
|
316
|
+
"name": "environment",
|
|
317
|
+
"type": "option",
|
|
318
|
+
"summary": "The environment to use.",
|
|
319
|
+
"multiple": false,
|
|
320
|
+
"default": "development"
|
|
321
|
+
},
|
|
322
|
+
"all": {
|
|
323
|
+
"name": "all",
|
|
324
|
+
"type": "boolean",
|
|
325
|
+
"summary": "Whether to pull all email layouts from the specified environment.",
|
|
326
|
+
"allowNo": false
|
|
327
|
+
},
|
|
328
|
+
"layouts-dir": {
|
|
329
|
+
"name": "layouts-dir",
|
|
330
|
+
"type": "option",
|
|
331
|
+
"summary": "The target directory path to pull all email layouts into.",
|
|
332
|
+
"multiple": false,
|
|
333
|
+
"dependsOn": [
|
|
334
|
+
"all"
|
|
335
|
+
],
|
|
336
|
+
"aliases": [
|
|
337
|
+
"email-layouts-dir"
|
|
338
|
+
]
|
|
339
|
+
},
|
|
340
|
+
"hide-uncommitted-changes": {
|
|
341
|
+
"name": "hide-uncommitted-changes",
|
|
342
|
+
"type": "boolean",
|
|
343
|
+
"summary": "Hide any uncommitted changes.",
|
|
344
|
+
"allowNo": false
|
|
345
|
+
},
|
|
346
|
+
"force": {
|
|
347
|
+
"name": "force",
|
|
348
|
+
"type": "boolean",
|
|
349
|
+
"summary": "Remove the confirmation prompt.",
|
|
350
|
+
"allowNo": false
|
|
351
|
+
}
|
|
352
|
+
},
|
|
353
|
+
"args": {
|
|
354
|
+
"emailLayoutKey": {
|
|
355
|
+
"name": "emailLayoutKey",
|
|
356
|
+
"required": false
|
|
357
|
+
}
|
|
358
|
+
}
|
|
359
|
+
},
|
|
360
|
+
"layout:push": {
|
|
361
|
+
"id": "layout:push",
|
|
362
|
+
"summary": "Push one or more email layouts from a local file system to Knock.",
|
|
363
|
+
"strict": true,
|
|
364
|
+
"pluginName": "@knocklabs/cli",
|
|
365
|
+
"pluginAlias": "@knocklabs/cli",
|
|
366
|
+
"pluginType": "core",
|
|
367
|
+
"aliases": [],
|
|
368
|
+
"flags": {
|
|
369
|
+
"service-token": {
|
|
370
|
+
"name": "service-token",
|
|
371
|
+
"type": "option",
|
|
372
|
+
"summary": "The service token to authenticate with.",
|
|
373
|
+
"required": true,
|
|
374
|
+
"multiple": false
|
|
375
|
+
},
|
|
376
|
+
"api-origin": {
|
|
377
|
+
"name": "api-origin",
|
|
378
|
+
"type": "option",
|
|
379
|
+
"hidden": true,
|
|
380
|
+
"required": false,
|
|
381
|
+
"multiple": false
|
|
382
|
+
},
|
|
383
|
+
"environment": {
|
|
384
|
+
"name": "environment",
|
|
385
|
+
"type": "option",
|
|
386
|
+
"summary": "Pushing an email layout is only allowed in the development environment",
|
|
387
|
+
"multiple": false,
|
|
388
|
+
"options": [
|
|
389
|
+
"development"
|
|
390
|
+
],
|
|
391
|
+
"default": "development"
|
|
392
|
+
},
|
|
393
|
+
"all": {
|
|
394
|
+
"name": "all",
|
|
395
|
+
"type": "boolean",
|
|
396
|
+
"summary": "Whether to push all layouts from the target directory.",
|
|
397
|
+
"allowNo": false
|
|
398
|
+
},
|
|
399
|
+
"layouts-dir": {
|
|
400
|
+
"name": "layouts-dir",
|
|
401
|
+
"type": "option",
|
|
402
|
+
"summary": "The target directory path to find all layouts to push.",
|
|
403
|
+
"multiple": false,
|
|
404
|
+
"dependsOn": [
|
|
405
|
+
"all"
|
|
406
|
+
],
|
|
407
|
+
"aliases": [
|
|
408
|
+
"email-layouts-dir"
|
|
409
|
+
]
|
|
410
|
+
},
|
|
411
|
+
"commit": {
|
|
412
|
+
"name": "commit",
|
|
413
|
+
"type": "boolean",
|
|
414
|
+
"summary": "Push and commit the layout(s) at the same time",
|
|
415
|
+
"allowNo": false
|
|
416
|
+
},
|
|
417
|
+
"commit-message": {
|
|
418
|
+
"name": "commit-message",
|
|
419
|
+
"type": "option",
|
|
420
|
+
"char": "m",
|
|
421
|
+
"summary": "Use the given value as the commit message",
|
|
422
|
+
"multiple": false,
|
|
423
|
+
"dependsOn": [
|
|
424
|
+
"commit"
|
|
425
|
+
]
|
|
426
|
+
}
|
|
427
|
+
},
|
|
428
|
+
"args": {
|
|
429
|
+
"emailLayoutKey": {
|
|
430
|
+
"name": "emailLayoutKey",
|
|
431
|
+
"required": false
|
|
432
|
+
}
|
|
433
|
+
}
|
|
434
|
+
},
|
|
435
|
+
"layout:validate": {
|
|
436
|
+
"id": "layout:validate",
|
|
437
|
+
"summary": "Validate one or more layouts from a local file system.",
|
|
438
|
+
"strict": true,
|
|
439
|
+
"pluginName": "@knocklabs/cli",
|
|
440
|
+
"pluginAlias": "@knocklabs/cli",
|
|
441
|
+
"pluginType": "core",
|
|
442
|
+
"aliases": [],
|
|
443
|
+
"flags": {
|
|
444
|
+
"service-token": {
|
|
445
|
+
"name": "service-token",
|
|
446
|
+
"type": "option",
|
|
447
|
+
"summary": "The service token to authenticate with.",
|
|
448
|
+
"required": true,
|
|
449
|
+
"multiple": false
|
|
450
|
+
},
|
|
451
|
+
"api-origin": {
|
|
452
|
+
"name": "api-origin",
|
|
453
|
+
"type": "option",
|
|
454
|
+
"hidden": true,
|
|
455
|
+
"required": false,
|
|
456
|
+
"multiple": false
|
|
457
|
+
},
|
|
458
|
+
"environment": {
|
|
459
|
+
"name": "environment",
|
|
460
|
+
"type": "option",
|
|
461
|
+
"summary": "Validating a layout is only done in the development environment",
|
|
462
|
+
"multiple": false,
|
|
463
|
+
"options": [
|
|
464
|
+
"development"
|
|
465
|
+
],
|
|
466
|
+
"default": "development"
|
|
467
|
+
},
|
|
468
|
+
"all": {
|
|
469
|
+
"name": "all",
|
|
470
|
+
"type": "boolean",
|
|
471
|
+
"summary": "Whether to validate all layouts from the target directory.",
|
|
472
|
+
"allowNo": false
|
|
473
|
+
},
|
|
474
|
+
"layouts-dir": {
|
|
475
|
+
"name": "layouts-dir",
|
|
476
|
+
"type": "option",
|
|
477
|
+
"summary": "The target directory path to find all layouts to validate.",
|
|
478
|
+
"multiple": false,
|
|
479
|
+
"dependsOn": [
|
|
480
|
+
"all"
|
|
481
|
+
],
|
|
482
|
+
"aliases": [
|
|
483
|
+
"email-layouts-dir"
|
|
484
|
+
]
|
|
485
|
+
}
|
|
486
|
+
},
|
|
487
|
+
"args": {
|
|
488
|
+
"emailLayoutKey": {
|
|
489
|
+
"name": "emailLayoutKey",
|
|
490
|
+
"required": false
|
|
491
|
+
}
|
|
492
|
+
}
|
|
493
|
+
},
|
|
177
494
|
"translation:get": {
|
|
178
495
|
"id": "translation:get",
|
|
179
496
|
"summary": "Display a single translation from an environment.",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@knocklabs/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.6",
|
|
4
4
|
"description": "Knock CLI",
|
|
5
5
|
"author": "@knocklabs",
|
|
6
6
|
"bin": {
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
"@prantlf/jsonlint": "^14.0.3",
|
|
24
24
|
"axios": "^1.4.0",
|
|
25
25
|
"date-fns": "^2.30.0",
|
|
26
|
-
"enquirer": "^2.
|
|
26
|
+
"enquirer": "^2.4.1",
|
|
27
27
|
"fs-extra": "^11.1.1",
|
|
28
|
-
"liquidjs": "^10.8.
|
|
28
|
+
"liquidjs": "^10.8.4",
|
|
29
29
|
"locale-codes": "^1.3.1",
|
|
30
30
|
"lodash": "^4.17.21",
|
|
31
31
|
"yup": "^1.2.0"
|
|
@@ -38,12 +38,12 @@
|
|
|
38
38
|
"@types/chai": "^4",
|
|
39
39
|
"@types/fs-extra": "^11.0.1",
|
|
40
40
|
"@types/mocha": "^10.0.1",
|
|
41
|
-
"@types/node": "^20.
|
|
41
|
+
"@types/node": "^20.8.6",
|
|
42
42
|
"chai": "^4",
|
|
43
43
|
"eslint": "^7.32.0",
|
|
44
44
|
"eslint-config-oclif": "^4",
|
|
45
45
|
"eslint-config-oclif-typescript": "^1.0.3",
|
|
46
|
-
"eslint-config-prettier": "^8.
|
|
46
|
+
"eslint-config-prettier": "^8.10.0",
|
|
47
47
|
"eslint-plugin-prettier": "^4.2.1",
|
|
48
48
|
"eslint-plugin-simple-import-sort": "^10.0.0",
|
|
49
49
|
"mocha": "^10",
|
|
@@ -54,8 +54,8 @@
|
|
|
54
54
|
"sinon": "^15.2.0",
|
|
55
55
|
"ts-node": "^10.9.1",
|
|
56
56
|
"tsconfig-paths": "^4.2.0",
|
|
57
|
-
"tslib": "^2.
|
|
58
|
-
"typescript": "^5.1.
|
|
57
|
+
"tslib": "^2.6.2",
|
|
58
|
+
"typescript": "^5.1.6"
|
|
59
59
|
},
|
|
60
60
|
"oclif": {
|
|
61
61
|
"bin": "knock",
|
|
@@ -75,6 +75,9 @@
|
|
|
75
75
|
},
|
|
76
76
|
"translation": {
|
|
77
77
|
"description": "Manage translation files."
|
|
78
|
+
},
|
|
79
|
+
"layout": {
|
|
80
|
+
"description": "Manage email layouts."
|
|
78
81
|
}
|
|
79
82
|
}
|
|
80
83
|
},
|