@knocklabs/cli 1.0.0 → 1.0.3

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 (39) hide show
  1. package/README.md +283 -76
  2. package/dist/commands/audience/archive.js +120 -0
  3. package/dist/commands/audience/get.js +169 -0
  4. package/dist/commands/audience/list.js +159 -0
  5. package/dist/commands/audience/new.js +243 -0
  6. package/dist/commands/audience/open.js +106 -0
  7. package/dist/commands/audience/pull.js +214 -0
  8. package/dist/commands/audience/push.js +172 -0
  9. package/dist/commands/audience/validate.js +147 -0
  10. package/dist/commands/branch/create.js +40 -3
  11. package/dist/commands/branch/list.js +14 -9
  12. package/dist/commands/branch/switch.js +7 -2
  13. package/dist/commands/guide/push.js +2 -1
  14. package/dist/commands/layout/push.js +2 -1
  15. package/dist/commands/message-type/push.js +2 -1
  16. package/dist/commands/partial/push.js +2 -1
  17. package/dist/commands/pull.js +19 -12
  18. package/dist/commands/push.js +24 -13
  19. package/dist/commands/translation/push.js +2 -1
  20. package/dist/commands/workflow/push.js +2 -1
  21. package/dist/lib/api-v1.js +12 -6
  22. package/dist/lib/helpers/flag.js +6 -0
  23. package/dist/lib/helpers/git.js +22 -3
  24. package/dist/lib/helpers/project-config.js +1 -0
  25. package/dist/lib/marshal/audience/generator.js +38 -0
  26. package/dist/lib/marshal/audience/helpers.js +142 -0
  27. package/dist/lib/marshal/audience/index.js +23 -0
  28. package/dist/lib/marshal/audience/processor.isomorphic.js +25 -0
  29. package/dist/lib/marshal/audience/reader.js +149 -0
  30. package/dist/lib/marshal/audience/types.js +15 -0
  31. package/dist/lib/marshal/audience/writer.js +177 -0
  32. package/dist/lib/marshal/index.isomorphic.js +18 -14
  33. package/dist/lib/marshal/translation/helpers.js +2 -1
  34. package/dist/lib/marshal/translation/reader.js +1 -1
  35. package/dist/lib/resources.js +3 -0
  36. package/dist/lib/run-context/loader.js +9 -20
  37. package/dist/lib/urls.js +4 -0
  38. package/oclif.manifest.json +879 -188
  39. package/package.json +10 -10
@@ -289,35 +289,658 @@
289
289
  "hasDynamicHelp": false,
290
290
  "multiple": false,
291
291
  "type": "option"
292
+ },
293
+ "force": {
294
+ "name": "force",
295
+ "summary": "Force pushes the resource or resources to Knock, overwriting whatever is currently stored. If you're using this on a non-development environment, you should also ensure you `commit` the changes.",
296
+ "allowNo": false,
297
+ "type": "boolean"
298
+ }
299
+ },
300
+ "hasDynamicHelp": false,
301
+ "hiddenAliases": [],
302
+ "id": "push",
303
+ "pluginAlias": "@knocklabs/cli",
304
+ "pluginName": "@knocklabs/cli",
305
+ "pluginType": "core",
306
+ "strict": true,
307
+ "summary": "Push all resources from a local file system to Knock.",
308
+ "enableJsonFlag": false,
309
+ "isESM": false,
310
+ "relativePath": [
311
+ "dist",
312
+ "commands",
313
+ "push.js"
314
+ ]
315
+ },
316
+ "whoami": {
317
+ "aliases": [],
318
+ "args": {},
319
+ "flags": {
320
+ "json": {
321
+ "description": "Format output as json.",
322
+ "helpGroup": "GLOBAL",
323
+ "name": "json",
324
+ "allowNo": false,
325
+ "type": "boolean"
326
+ },
327
+ "service-token": {
328
+ "env": "KNOCK_SERVICE_TOKEN",
329
+ "name": "service-token",
330
+ "required": false,
331
+ "summary": "The service token to authenticate with.",
332
+ "hasDynamicHelp": false,
333
+ "multiple": false,
334
+ "type": "option"
335
+ },
336
+ "api-origin": {
337
+ "hidden": true,
338
+ "name": "api-origin",
339
+ "required": false,
340
+ "hasDynamicHelp": false,
341
+ "multiple": false,
342
+ "type": "option"
343
+ }
344
+ },
345
+ "hasDynamicHelp": false,
346
+ "hiddenAliases": [],
347
+ "id": "whoami",
348
+ "pluginAlias": "@knocklabs/cli",
349
+ "pluginName": "@knocklabs/cli",
350
+ "pluginType": "core",
351
+ "strict": true,
352
+ "summary": "Verify the provided service token.",
353
+ "enableJsonFlag": true,
354
+ "isESM": false,
355
+ "relativePath": [
356
+ "dist",
357
+ "commands",
358
+ "whoami.js"
359
+ ]
360
+ },
361
+ "audience:archive": {
362
+ "aliases": [],
363
+ "args": {
364
+ "audienceKey": {
365
+ "description": "The key of the audience to archive.",
366
+ "name": "audienceKey",
367
+ "required": true
368
+ }
369
+ },
370
+ "description": "\nWARNING: Archiving an audience affects ALL environments and cannot be undone.\nUse this command with caution.\n",
371
+ "flags": {
372
+ "service-token": {
373
+ "env": "KNOCK_SERVICE_TOKEN",
374
+ "name": "service-token",
375
+ "required": false,
376
+ "summary": "The service token to authenticate with.",
377
+ "hasDynamicHelp": false,
378
+ "multiple": false,
379
+ "type": "option"
380
+ },
381
+ "api-origin": {
382
+ "hidden": true,
383
+ "name": "api-origin",
384
+ "required": false,
385
+ "hasDynamicHelp": false,
386
+ "multiple": false,
387
+ "type": "option"
388
+ },
389
+ "environment": {
390
+ "name": "environment",
391
+ "required": true,
392
+ "summary": "The environment to use.",
393
+ "hasDynamicHelp": false,
394
+ "multiple": false,
395
+ "type": "option"
396
+ },
397
+ "branch": {
398
+ "name": "branch",
399
+ "summary": "The slug of the branch to use.",
400
+ "hasDynamicHelp": false,
401
+ "multiple": false,
402
+ "type": "option"
403
+ },
404
+ "force": {
405
+ "name": "force",
406
+ "summary": "Skip confirmation prompt.",
407
+ "allowNo": false,
408
+ "type": "boolean"
409
+ }
410
+ },
411
+ "hasDynamicHelp": false,
412
+ "hiddenAliases": [],
413
+ "id": "audience:archive",
414
+ "pluginAlias": "@knocklabs/cli",
415
+ "pluginName": "@knocklabs/cli",
416
+ "pluginType": "core",
417
+ "strict": true,
418
+ "summary": "Archive an audience (affects ALL environments).",
419
+ "enableJsonFlag": false,
420
+ "isESM": false,
421
+ "relativePath": [
422
+ "dist",
423
+ "commands",
424
+ "audience",
425
+ "archive.js"
426
+ ]
427
+ },
428
+ "audience:get": {
429
+ "aliases": [],
430
+ "args": {
431
+ "audienceKey": {
432
+ "name": "audienceKey",
433
+ "required": true
434
+ }
435
+ },
436
+ "flags": {
437
+ "json": {
438
+ "description": "Format output as json.",
439
+ "helpGroup": "GLOBAL",
440
+ "name": "json",
441
+ "allowNo": false,
442
+ "type": "boolean"
443
+ },
444
+ "service-token": {
445
+ "env": "KNOCK_SERVICE_TOKEN",
446
+ "name": "service-token",
447
+ "required": false,
448
+ "summary": "The service token to authenticate with.",
449
+ "hasDynamicHelp": false,
450
+ "multiple": false,
451
+ "type": "option"
452
+ },
453
+ "api-origin": {
454
+ "hidden": true,
455
+ "name": "api-origin",
456
+ "required": false,
457
+ "hasDynamicHelp": false,
458
+ "multiple": false,
459
+ "type": "option"
460
+ },
461
+ "environment": {
462
+ "name": "environment",
463
+ "summary": "The environment to use.",
464
+ "default": "development",
465
+ "hasDynamicHelp": false,
466
+ "multiple": false,
467
+ "type": "option"
468
+ },
469
+ "branch": {
470
+ "name": "branch",
471
+ "summary": "The slug of the branch to use.",
472
+ "hasDynamicHelp": false,
473
+ "multiple": false,
474
+ "type": "option"
475
+ },
476
+ "hide-uncommitted-changes": {
477
+ "name": "hide-uncommitted-changes",
478
+ "summary": "Hide any uncommitted changes.",
479
+ "allowNo": false,
480
+ "type": "boolean"
481
+ }
482
+ },
483
+ "hasDynamicHelp": false,
484
+ "hiddenAliases": [],
485
+ "id": "audience:get",
486
+ "pluginAlias": "@knocklabs/cli",
487
+ "pluginName": "@knocklabs/cli",
488
+ "pluginType": "core",
489
+ "strict": true,
490
+ "summary": "Display a single audience from an environment.",
491
+ "enableJsonFlag": true,
492
+ "isESM": false,
493
+ "relativePath": [
494
+ "dist",
495
+ "commands",
496
+ "audience",
497
+ "get.js"
498
+ ]
499
+ },
500
+ "audience:list": {
501
+ "aliases": [],
502
+ "args": {},
503
+ "flags": {
504
+ "json": {
505
+ "description": "Format output as json.",
506
+ "helpGroup": "GLOBAL",
507
+ "name": "json",
508
+ "allowNo": false,
509
+ "type": "boolean"
510
+ },
511
+ "service-token": {
512
+ "env": "KNOCK_SERVICE_TOKEN",
513
+ "name": "service-token",
514
+ "required": false,
515
+ "summary": "The service token to authenticate with.",
516
+ "hasDynamicHelp": false,
517
+ "multiple": false,
518
+ "type": "option"
519
+ },
520
+ "api-origin": {
521
+ "hidden": true,
522
+ "name": "api-origin",
523
+ "required": false,
524
+ "hasDynamicHelp": false,
525
+ "multiple": false,
526
+ "type": "option"
527
+ },
528
+ "environment": {
529
+ "name": "environment",
530
+ "summary": "The environment to use.",
531
+ "default": "development",
532
+ "hasDynamicHelp": false,
533
+ "multiple": false,
534
+ "type": "option"
535
+ },
536
+ "branch": {
537
+ "name": "branch",
538
+ "summary": "The slug of the branch to use.",
539
+ "hasDynamicHelp": false,
540
+ "multiple": false,
541
+ "type": "option"
542
+ },
543
+ "hide-uncommitted-changes": {
544
+ "name": "hide-uncommitted-changes",
545
+ "summary": "Hide any uncommitted changes.",
546
+ "allowNo": false,
547
+ "type": "boolean"
548
+ },
549
+ "after": {
550
+ "name": "after",
551
+ "summary": "The cursor after which to fetch the next page.",
552
+ "hasDynamicHelp": false,
553
+ "multiple": false,
554
+ "type": "option"
555
+ },
556
+ "before": {
557
+ "name": "before",
558
+ "summary": "The cursor before which to fetch the previous page.",
559
+ "hasDynamicHelp": false,
560
+ "multiple": false,
561
+ "type": "option"
562
+ },
563
+ "limit": {
564
+ "name": "limit",
565
+ "summary": "The total number of entries to fetch per page.",
566
+ "hasDynamicHelp": false,
567
+ "multiple": false,
568
+ "type": "option"
569
+ }
570
+ },
571
+ "hasDynamicHelp": false,
572
+ "hiddenAliases": [],
573
+ "id": "audience:list",
574
+ "pluginAlias": "@knocklabs/cli",
575
+ "pluginName": "@knocklabs/cli",
576
+ "pluginType": "core",
577
+ "strict": true,
578
+ "summary": "Display all audiences for an environment.",
579
+ "enableJsonFlag": true,
580
+ "isESM": false,
581
+ "relativePath": [
582
+ "dist",
583
+ "commands",
584
+ "audience",
585
+ "list.js"
586
+ ]
587
+ },
588
+ "audience:new": {
589
+ "aliases": [],
590
+ "args": {},
591
+ "flags": {
592
+ "service-token": {
593
+ "env": "KNOCK_SERVICE_TOKEN",
594
+ "name": "service-token",
595
+ "required": false,
596
+ "summary": "The service token to authenticate with.",
597
+ "hasDynamicHelp": false,
598
+ "multiple": false,
599
+ "type": "option"
600
+ },
601
+ "api-origin": {
602
+ "hidden": true,
603
+ "name": "api-origin",
604
+ "required": false,
605
+ "hasDynamicHelp": false,
606
+ "multiple": false,
607
+ "type": "option"
608
+ },
609
+ "name": {
610
+ "char": "n",
611
+ "name": "name",
612
+ "summary": "The name of the audience",
613
+ "hasDynamicHelp": false,
614
+ "multiple": false,
615
+ "type": "option"
616
+ },
617
+ "key": {
618
+ "char": "k",
619
+ "name": "key",
620
+ "summary": "The key of the audience",
621
+ "hasDynamicHelp": false,
622
+ "multiple": false,
623
+ "type": "option"
624
+ },
625
+ "type": {
626
+ "char": "t",
627
+ "name": "type",
628
+ "summary": "The type of the audience (static, dynamic). Note: dynamic is in beta and requires access.",
629
+ "hasDynamicHelp": false,
630
+ "multiple": false,
631
+ "options": [
632
+ "static",
633
+ "dynamic"
634
+ ],
635
+ "type": "option"
636
+ },
637
+ "description": {
638
+ "char": "d",
639
+ "name": "description",
640
+ "summary": "The description of the audience",
641
+ "hasDynamicHelp": false,
642
+ "multiple": false,
643
+ "type": "option"
644
+ },
645
+ "environment": {
646
+ "name": "environment",
647
+ "summary": "The environment to create the audience in. Defaults to development.",
648
+ "default": "development",
649
+ "hasDynamicHelp": false,
650
+ "multiple": false,
651
+ "type": "option"
652
+ },
653
+ "branch": {
654
+ "name": "branch",
655
+ "summary": "The slug of the branch to use.",
656
+ "hasDynamicHelp": false,
657
+ "multiple": false,
658
+ "type": "option"
659
+ },
660
+ "force": {
661
+ "name": "force",
662
+ "summary": "Force the creation of the audience directory without confirmation.",
663
+ "allowNo": false,
664
+ "type": "boolean"
665
+ },
666
+ "push": {
667
+ "char": "p",
668
+ "name": "push",
669
+ "summary": "Whether or not to push the audience to Knock after creation.",
670
+ "allowNo": false,
671
+ "type": "boolean"
672
+ }
673
+ },
674
+ "hasDynamicHelp": false,
675
+ "hiddenAliases": [],
676
+ "id": "audience:new",
677
+ "pluginAlias": "@knocklabs/cli",
678
+ "pluginName": "@knocklabs/cli",
679
+ "pluginType": "core",
680
+ "strict": true,
681
+ "summary": "Create a new audience with a minimal configuration.",
682
+ "enableJsonFlag": false,
683
+ "isESM": false,
684
+ "relativePath": [
685
+ "dist",
686
+ "commands",
687
+ "audience",
688
+ "new.js"
689
+ ]
690
+ },
691
+ "audience:open": {
692
+ "aliases": [],
693
+ "args": {
694
+ "audienceKey": {
695
+ "name": "audienceKey",
696
+ "required": true
697
+ }
698
+ },
699
+ "flags": {
700
+ "service-token": {
701
+ "env": "KNOCK_SERVICE_TOKEN",
702
+ "name": "service-token",
703
+ "required": false,
704
+ "summary": "The service token to authenticate with.",
705
+ "hasDynamicHelp": false,
706
+ "multiple": false,
707
+ "type": "option"
708
+ },
709
+ "api-origin": {
710
+ "hidden": true,
711
+ "name": "api-origin",
712
+ "required": false,
713
+ "hasDynamicHelp": false,
714
+ "multiple": false,
715
+ "type": "option"
716
+ },
717
+ "environment": {
718
+ "name": "environment",
719
+ "summary": "The environment to use.",
720
+ "default": "development",
721
+ "hasDynamicHelp": false,
722
+ "multiple": false,
723
+ "type": "option"
724
+ },
725
+ "branch": {
726
+ "name": "branch",
727
+ "summary": "The slug of the branch to use.",
728
+ "hasDynamicHelp": false,
729
+ "multiple": false,
730
+ "type": "option"
731
+ }
732
+ },
733
+ "hasDynamicHelp": false,
734
+ "hiddenAliases": [],
735
+ "id": "audience:open",
736
+ "pluginAlias": "@knocklabs/cli",
737
+ "pluginName": "@knocklabs/cli",
738
+ "pluginType": "core",
739
+ "strict": true,
740
+ "summary": "Open an audience in the Knock dashboard.",
741
+ "enableJsonFlag": false,
742
+ "isESM": false,
743
+ "relativePath": [
744
+ "dist",
745
+ "commands",
746
+ "audience",
747
+ "open.js"
748
+ ]
749
+ },
750
+ "audience:pull": {
751
+ "aliases": [],
752
+ "args": {
753
+ "audienceKey": {
754
+ "name": "audienceKey",
755
+ "required": false
756
+ }
757
+ },
758
+ "flags": {
759
+ "service-token": {
760
+ "env": "KNOCK_SERVICE_TOKEN",
761
+ "name": "service-token",
762
+ "required": false,
763
+ "summary": "The service token to authenticate with.",
764
+ "hasDynamicHelp": false,
765
+ "multiple": false,
766
+ "type": "option"
767
+ },
768
+ "api-origin": {
769
+ "hidden": true,
770
+ "name": "api-origin",
771
+ "required": false,
772
+ "hasDynamicHelp": false,
773
+ "multiple": false,
774
+ "type": "option"
775
+ },
776
+ "environment": {
777
+ "name": "environment",
778
+ "summary": "The environment to use.",
779
+ "default": "development",
780
+ "hasDynamicHelp": false,
781
+ "multiple": false,
782
+ "type": "option"
783
+ },
784
+ "branch": {
785
+ "name": "branch",
786
+ "summary": "The slug of the branch to use.",
787
+ "hasDynamicHelp": false,
788
+ "multiple": false,
789
+ "type": "option"
790
+ },
791
+ "all": {
792
+ "name": "all",
793
+ "summary": "Whether to pull all audiences from the specified environment.",
794
+ "allowNo": false,
795
+ "type": "boolean"
796
+ },
797
+ "audiences-dir": {
798
+ "dependsOn": [
799
+ "all"
800
+ ],
801
+ "name": "audiences-dir",
802
+ "summary": "The target directory path to pull all audiences into.",
803
+ "hasDynamicHelp": false,
804
+ "multiple": false,
805
+ "type": "option"
806
+ },
807
+ "hide-uncommitted-changes": {
808
+ "name": "hide-uncommitted-changes",
809
+ "summary": "Hide any uncommitted changes.",
810
+ "allowNo": false,
811
+ "type": "boolean"
812
+ },
813
+ "force": {
814
+ "name": "force",
815
+ "summary": "Remove the confirmation prompt.",
816
+ "allowNo": false,
817
+ "type": "boolean"
292
818
  }
293
819
  },
294
820
  "hasDynamicHelp": false,
295
821
  "hiddenAliases": [],
296
- "id": "push",
822
+ "id": "audience:pull",
297
823
  "pluginAlias": "@knocklabs/cli",
298
824
  "pluginName": "@knocklabs/cli",
299
825
  "pluginType": "core",
300
826
  "strict": true,
301
- "summary": "Push all resources from a local file system to Knock.",
827
+ "summary": "Pull one or more audiences from an environment into a local file system.",
302
828
  "enableJsonFlag": false,
303
829
  "isESM": false,
304
830
  "relativePath": [
305
831
  "dist",
306
832
  "commands",
307
- "push.js"
833
+ "audience",
834
+ "pull.js"
308
835
  ]
309
836
  },
310
- "whoami": {
837
+ "audience:push": {
311
838
  "aliases": [],
312
- "args": {},
839
+ "args": {
840
+ "audienceKey": {
841
+ "name": "audienceKey",
842
+ "required": false
843
+ }
844
+ },
313
845
  "flags": {
314
- "json": {
315
- "description": "Format output as json.",
316
- "helpGroup": "GLOBAL",
317
- "name": "json",
846
+ "service-token": {
847
+ "env": "KNOCK_SERVICE_TOKEN",
848
+ "name": "service-token",
849
+ "required": false,
850
+ "summary": "The service token to authenticate with.",
851
+ "hasDynamicHelp": false,
852
+ "multiple": false,
853
+ "type": "option"
854
+ },
855
+ "api-origin": {
856
+ "hidden": true,
857
+ "name": "api-origin",
858
+ "required": false,
859
+ "hasDynamicHelp": false,
860
+ "multiple": false,
861
+ "type": "option"
862
+ },
863
+ "environment": {
864
+ "name": "environment",
865
+ "summary": "The environment to push the audience to. Defaults to development.",
866
+ "default": "development",
867
+ "hasDynamicHelp": false,
868
+ "multiple": false,
869
+ "type": "option"
870
+ },
871
+ "branch": {
872
+ "name": "branch",
873
+ "summary": "The slug of the branch to use.",
874
+ "hasDynamicHelp": false,
875
+ "multiple": false,
876
+ "type": "option"
877
+ },
878
+ "all": {
879
+ "name": "all",
880
+ "summary": "Whether to push all audiences from the target directory.",
881
+ "allowNo": false,
882
+ "type": "boolean"
883
+ },
884
+ "audiences-dir": {
885
+ "dependsOn": [
886
+ "all"
887
+ ],
888
+ "name": "audiences-dir",
889
+ "summary": "The target directory path to find all audiences to push.",
890
+ "hasDynamicHelp": false,
891
+ "multiple": false,
892
+ "type": "option"
893
+ },
894
+ "commit": {
895
+ "name": "commit",
896
+ "summary": "Push and commit the audience(s) at the same time",
318
897
  "allowNo": false,
319
898
  "type": "boolean"
320
899
  },
900
+ "commit-message": {
901
+ "char": "m",
902
+ "dependsOn": [
903
+ "commit"
904
+ ],
905
+ "name": "commit-message",
906
+ "summary": "Use the given value as the commit message",
907
+ "hasDynamicHelp": false,
908
+ "multiple": false,
909
+ "type": "option"
910
+ },
911
+ "force": {
912
+ "name": "force",
913
+ "summary": "Force pushes the resource or resources to Knock, overwriting whatever is currently stored. If you're using this on a non-development environment, you should also ensure you `commit` the changes.",
914
+ "allowNo": false,
915
+ "type": "boolean"
916
+ }
917
+ },
918
+ "hasDynamicHelp": false,
919
+ "hiddenAliases": [],
920
+ "id": "audience:push",
921
+ "pluginAlias": "@knocklabs/cli",
922
+ "pluginName": "@knocklabs/cli",
923
+ "pluginType": "core",
924
+ "strict": true,
925
+ "summary": "Push one or more audiences from a local file system to Knock.",
926
+ "enableJsonFlag": false,
927
+ "isESM": false,
928
+ "relativePath": [
929
+ "dist",
930
+ "commands",
931
+ "audience",
932
+ "push.js"
933
+ ]
934
+ },
935
+ "audience:validate": {
936
+ "aliases": [],
937
+ "args": {
938
+ "audienceKey": {
939
+ "name": "audienceKey",
940
+ "required": false
941
+ }
942
+ },
943
+ "flags": {
321
944
  "service-token": {
322
945
  "env": "KNOCK_SERVICE_TOKEN",
323
946
  "name": "service-token",
@@ -334,22 +957,54 @@
334
957
  "hasDynamicHelp": false,
335
958
  "multiple": false,
336
959
  "type": "option"
960
+ },
961
+ "environment": {
962
+ "name": "environment",
963
+ "summary": "The environment to validate the audience against. Defaults to development.",
964
+ "default": "development",
965
+ "hasDynamicHelp": false,
966
+ "multiple": false,
967
+ "type": "option"
968
+ },
969
+ "branch": {
970
+ "name": "branch",
971
+ "summary": "The slug of the branch to use.",
972
+ "hasDynamicHelp": false,
973
+ "multiple": false,
974
+ "type": "option"
975
+ },
976
+ "all": {
977
+ "name": "all",
978
+ "summary": "Whether to validate all audiences from the target directory.",
979
+ "allowNo": false,
980
+ "type": "boolean"
981
+ },
982
+ "audiences-dir": {
983
+ "dependsOn": [
984
+ "all"
985
+ ],
986
+ "name": "audiences-dir",
987
+ "summary": "The target directory path to find all audiences to validate.",
988
+ "hasDynamicHelp": false,
989
+ "multiple": false,
990
+ "type": "option"
337
991
  }
338
992
  },
339
993
  "hasDynamicHelp": false,
340
994
  "hiddenAliases": [],
341
- "id": "whoami",
995
+ "id": "audience:validate",
342
996
  "pluginAlias": "@knocklabs/cli",
343
997
  "pluginName": "@knocklabs/cli",
344
998
  "pluginType": "core",
345
999
  "strict": true,
346
- "summary": "Verify the provided service token.",
347
- "enableJsonFlag": true,
1000
+ "summary": "Validate one or more audiences from a local file system.",
1001
+ "enableJsonFlag": false,
348
1002
  "isESM": false,
349
1003
  "relativePath": [
350
1004
  "dist",
351
1005
  "commands",
352
- "whoami.js"
1006
+ "audience",
1007
+ "validate.js"
353
1008
  ]
354
1009
  },
355
1010
  "branch:create": {
@@ -358,7 +1013,7 @@
358
1013
  "slug": {
359
1014
  "description": "The slug for the new branch",
360
1015
  "name": "slug",
361
- "required": true
1016
+ "required": false
362
1017
  }
363
1018
  },
364
1019
  "flags": {
@@ -721,52 +1376,6 @@
721
1376
  "list.js"
722
1377
  ]
723
1378
  },
724
- "environment:list": {
725
- "aliases": [],
726
- "args": {},
727
- "flags": {
728
- "json": {
729
- "description": "Format output as json.",
730
- "helpGroup": "GLOBAL",
731
- "name": "json",
732
- "allowNo": false,
733
- "type": "boolean"
734
- },
735
- "service-token": {
736
- "env": "KNOCK_SERVICE_TOKEN",
737
- "name": "service-token",
738
- "required": false,
739
- "summary": "The service token to authenticate with.",
740
- "hasDynamicHelp": false,
741
- "multiple": false,
742
- "type": "option"
743
- },
744
- "api-origin": {
745
- "hidden": true,
746
- "name": "api-origin",
747
- "required": false,
748
- "hasDynamicHelp": false,
749
- "multiple": false,
750
- "type": "option"
751
- }
752
- },
753
- "hasDynamicHelp": false,
754
- "hiddenAliases": [],
755
- "id": "environment:list",
756
- "pluginAlias": "@knocklabs/cli",
757
- "pluginName": "@knocklabs/cli",
758
- "pluginType": "core",
759
- "strict": true,
760
- "summary": "Display all environments configured for the account.",
761
- "enableJsonFlag": true,
762
- "isESM": false,
763
- "relativePath": [
764
- "dist",
765
- "commands",
766
- "environment",
767
- "list.js"
768
- ]
769
- },
770
1379
  "commit:get": {
771
1380
  "aliases": [],
772
1381
  "args": {
@@ -1058,6 +1667,52 @@
1058
1667
  "promote.js"
1059
1668
  ]
1060
1669
  },
1670
+ "environment:list": {
1671
+ "aliases": [],
1672
+ "args": {},
1673
+ "flags": {
1674
+ "json": {
1675
+ "description": "Format output as json.",
1676
+ "helpGroup": "GLOBAL",
1677
+ "name": "json",
1678
+ "allowNo": false,
1679
+ "type": "boolean"
1680
+ },
1681
+ "service-token": {
1682
+ "env": "KNOCK_SERVICE_TOKEN",
1683
+ "name": "service-token",
1684
+ "required": false,
1685
+ "summary": "The service token to authenticate with.",
1686
+ "hasDynamicHelp": false,
1687
+ "multiple": false,
1688
+ "type": "option"
1689
+ },
1690
+ "api-origin": {
1691
+ "hidden": true,
1692
+ "name": "api-origin",
1693
+ "required": false,
1694
+ "hasDynamicHelp": false,
1695
+ "multiple": false,
1696
+ "type": "option"
1697
+ }
1698
+ },
1699
+ "hasDynamicHelp": false,
1700
+ "hiddenAliases": [],
1701
+ "id": "environment:list",
1702
+ "pluginAlias": "@knocklabs/cli",
1703
+ "pluginName": "@knocklabs/cli",
1704
+ "pluginType": "core",
1705
+ "strict": true,
1706
+ "summary": "Display all environments configured for the account.",
1707
+ "enableJsonFlag": true,
1708
+ "isESM": false,
1709
+ "relativePath": [
1710
+ "dist",
1711
+ "commands",
1712
+ "environment",
1713
+ "list.js"
1714
+ ]
1715
+ },
1061
1716
  "guide:activate": {
1062
1717
  "aliases": [],
1063
1718
  "args": {
@@ -1699,6 +2354,12 @@
1699
2354
  "hasDynamicHelp": false,
1700
2355
  "multiple": false,
1701
2356
  "type": "option"
2357
+ },
2358
+ "force": {
2359
+ "name": "force",
2360
+ "summary": "Force pushes the resource or resources to Knock, overwriting whatever is currently stored. If you're using this on a non-development environment, you should also ensure you `commit` the changes.",
2361
+ "allowNo": false,
2362
+ "type": "boolean"
1702
2363
  }
1703
2364
  },
1704
2365
  "hasDynamicHelp": false,
@@ -1793,11 +2454,11 @@
1793
2454
  "validate.js"
1794
2455
  ]
1795
2456
  },
1796
- "layout:get": {
2457
+ "message-type:get": {
1797
2458
  "aliases": [],
1798
2459
  "args": {
1799
- "emailLayoutKey": {
1800
- "name": "emailLayoutKey",
2460
+ "messageTypeKey": {
2461
+ "name": "messageTypeKey",
1801
2462
  "required": true
1802
2463
  }
1803
2464
  },
@@ -1850,22 +2511,22 @@
1850
2511
  },
1851
2512
  "hasDynamicHelp": false,
1852
2513
  "hiddenAliases": [],
1853
- "id": "layout:get",
2514
+ "id": "message-type:get",
1854
2515
  "pluginAlias": "@knocklabs/cli",
1855
2516
  "pluginName": "@knocklabs/cli",
1856
2517
  "pluginType": "core",
1857
2518
  "strict": true,
1858
- "summary": "Display a single email layout from an environment.",
2519
+ "summary": "Display a single in-app message type from an environment.",
1859
2520
  "enableJsonFlag": true,
1860
2521
  "isESM": false,
1861
2522
  "relativePath": [
1862
2523
  "dist",
1863
2524
  "commands",
1864
- "layout",
2525
+ "message-type",
1865
2526
  "get.js"
1866
2527
  ]
1867
2528
  },
1868
- "layout:list": {
2529
+ "message-type:list": {
1869
2530
  "aliases": [],
1870
2531
  "args": {},
1871
2532
  "flags": {
@@ -1938,22 +2599,22 @@
1938
2599
  },
1939
2600
  "hasDynamicHelp": false,
1940
2601
  "hiddenAliases": [],
1941
- "id": "layout:list",
2602
+ "id": "message-type:list",
1942
2603
  "pluginAlias": "@knocklabs/cli",
1943
2604
  "pluginName": "@knocklabs/cli",
1944
2605
  "pluginType": "core",
1945
2606
  "strict": true,
1946
- "summary": "Display all email layouts for an environment.",
2607
+ "summary": "Display all in-app message types for an environment.",
1947
2608
  "enableJsonFlag": true,
1948
2609
  "isESM": false,
1949
2610
  "relativePath": [
1950
2611
  "dist",
1951
2612
  "commands",
1952
- "layout",
2613
+ "message-type",
1953
2614
  "list.js"
1954
2615
  ]
1955
2616
  },
1956
- "layout:new": {
2617
+ "message-type:new": {
1957
2618
  "aliases": [],
1958
2619
  "args": {},
1959
2620
  "flags": {
@@ -1977,7 +2638,7 @@
1977
2638
  "name": {
1978
2639
  "char": "n",
1979
2640
  "name": "name",
1980
- "summary": "The name of the email layout",
2641
+ "summary": "The name of the message type",
1981
2642
  "hasDynamicHelp": false,
1982
2643
  "multiple": false,
1983
2644
  "type": "option"
@@ -1985,14 +2646,14 @@
1985
2646
  "key": {
1986
2647
  "char": "k",
1987
2648
  "name": "key",
1988
- "summary": "The key of the email layout",
2649
+ "summary": "The key of the message type",
1989
2650
  "hasDynamicHelp": false,
1990
2651
  "multiple": false,
1991
2652
  "type": "option"
1992
2653
  },
1993
2654
  "environment": {
1994
2655
  "name": "environment",
1995
- "summary": "The environment to create the email layout in. Defaults to development.",
2656
+ "summary": "The environment to create the message type in. Defaults to development.",
1996
2657
  "default": "development",
1997
2658
  "hasDynamicHelp": false,
1998
2659
  "multiple": false,
@@ -2007,20 +2668,20 @@
2007
2668
  },
2008
2669
  "force": {
2009
2670
  "name": "force",
2010
- "summary": "Force the creation of the email layout directory without confirmation.",
2671
+ "summary": "Force the creation of the message type directory without confirmation.",
2011
2672
  "allowNo": false,
2012
2673
  "type": "boolean"
2013
2674
  },
2014
2675
  "push": {
2015
2676
  "char": "p",
2016
2677
  "name": "push",
2017
- "summary": "Whether or not to push the email layout to Knock after creation.",
2678
+ "summary": "Whether or not to push the message type to Knock after creation.",
2018
2679
  "allowNo": false,
2019
2680
  "type": "boolean"
2020
2681
  },
2021
2682
  "template": {
2022
2683
  "name": "template",
2023
- "summary": "The template to use for the email layout. Should be `email-layouts/{key}`.",
2684
+ "summary": "The template to use for the message type. Should be `message-types/{key}`.",
2024
2685
  "hasDynamicHelp": false,
2025
2686
  "multiple": false,
2026
2687
  "type": "option"
@@ -2028,26 +2689,26 @@
2028
2689
  },
2029
2690
  "hasDynamicHelp": false,
2030
2691
  "hiddenAliases": [],
2031
- "id": "layout:new",
2692
+ "id": "message-type:new",
2032
2693
  "pluginAlias": "@knocklabs/cli",
2033
2694
  "pluginName": "@knocklabs/cli",
2034
2695
  "pluginType": "core",
2035
2696
  "strict": true,
2036
- "summary": "Create a new email layout with a minimal configuration.",
2697
+ "summary": "Create a new message type with a minimal configuration.",
2037
2698
  "enableJsonFlag": false,
2038
2699
  "isESM": false,
2039
2700
  "relativePath": [
2040
2701
  "dist",
2041
2702
  "commands",
2042
- "layout",
2703
+ "message-type",
2043
2704
  "new.js"
2044
2705
  ]
2045
2706
  },
2046
- "layout:open": {
2707
+ "message-type:open": {
2047
2708
  "aliases": [],
2048
2709
  "args": {
2049
- "layoutKey": {
2050
- "name": "layoutKey",
2710
+ "messageTypeKey": {
2711
+ "name": "messageTypeKey",
2051
2712
  "required": true
2052
2713
  }
2053
2714
  },
@@ -2087,26 +2748,26 @@
2087
2748
  },
2088
2749
  "hasDynamicHelp": false,
2089
2750
  "hiddenAliases": [],
2090
- "id": "layout:open",
2751
+ "id": "message-type:open",
2091
2752
  "pluginAlias": "@knocklabs/cli",
2092
2753
  "pluginName": "@knocklabs/cli",
2093
2754
  "pluginType": "core",
2094
2755
  "strict": true,
2095
- "summary": "Open a layout in the Knock dashboard.",
2756
+ "summary": "Open a message type in the Knock dashboard.",
2096
2757
  "enableJsonFlag": false,
2097
2758
  "isESM": false,
2098
2759
  "relativePath": [
2099
2760
  "dist",
2100
2761
  "commands",
2101
- "layout",
2762
+ "message-type",
2102
2763
  "open.js"
2103
2764
  ]
2104
2765
  },
2105
- "layout:pull": {
2766
+ "message-type:pull": {
2106
2767
  "aliases": [],
2107
2768
  "args": {
2108
- "emailLayoutKey": {
2109
- "name": "emailLayoutKey",
2769
+ "messageTypeKey": {
2770
+ "name": "messageTypeKey",
2110
2771
  "required": false
2111
2772
  }
2112
2773
  },
@@ -2145,19 +2806,16 @@
2145
2806
  },
2146
2807
  "all": {
2147
2808
  "name": "all",
2148
- "summary": "Whether to pull all email layouts from the specified environment.",
2809
+ "summary": "Whether to pull all in-app message types from the specified environment.",
2149
2810
  "allowNo": false,
2150
2811
  "type": "boolean"
2151
2812
  },
2152
- "layouts-dir": {
2153
- "aliases": [
2154
- "email-layouts-dir"
2155
- ],
2813
+ "message-types-dir": {
2156
2814
  "dependsOn": [
2157
2815
  "all"
2158
2816
  ],
2159
- "name": "layouts-dir",
2160
- "summary": "The target directory path to pull all email layouts into.",
2817
+ "name": "message-types-dir",
2818
+ "summary": "The target directory path to pull all in-app message types into.",
2161
2819
  "hasDynamicHelp": false,
2162
2820
  "multiple": false,
2163
2821
  "type": "option"
@@ -2177,26 +2835,26 @@
2177
2835
  },
2178
2836
  "hasDynamicHelp": false,
2179
2837
  "hiddenAliases": [],
2180
- "id": "layout:pull",
2838
+ "id": "message-type:pull",
2181
2839
  "pluginAlias": "@knocklabs/cli",
2182
2840
  "pluginName": "@knocklabs/cli",
2183
2841
  "pluginType": "core",
2184
2842
  "strict": true,
2185
- "summary": "Pull one or more email layouts from an environment into a local file system.",
2843
+ "summary": "Pull one or more in-app message types from an environment into a local file system.",
2186
2844
  "enableJsonFlag": false,
2187
2845
  "isESM": false,
2188
2846
  "relativePath": [
2189
2847
  "dist",
2190
2848
  "commands",
2191
- "layout",
2849
+ "message-type",
2192
2850
  "pull.js"
2193
2851
  ]
2194
2852
  },
2195
- "layout:push": {
2853
+ "message-type:push": {
2196
2854
  "aliases": [],
2197
2855
  "args": {
2198
- "emailLayoutKey": {
2199
- "name": "emailLayoutKey",
2856
+ "messageTypeKey": {
2857
+ "name": "messageTypeKey",
2200
2858
  "required": false
2201
2859
  }
2202
2860
  },
@@ -2220,7 +2878,7 @@
2220
2878
  },
2221
2879
  "environment": {
2222
2880
  "name": "environment",
2223
- "summary": "Pushing an email layout is only allowed in the development environment",
2881
+ "summary": "Pushing a message type is only allowed in the development environment",
2224
2882
  "default": "development",
2225
2883
  "hasDynamicHelp": false,
2226
2884
  "multiple": false,
@@ -2238,26 +2896,23 @@
2238
2896
  },
2239
2897
  "all": {
2240
2898
  "name": "all",
2241
- "summary": "Whether to push all layouts from the target directory.",
2899
+ "summary": "Whether to push all message types from the target directory.",
2242
2900
  "allowNo": false,
2243
2901
  "type": "boolean"
2244
2902
  },
2245
- "layouts-dir": {
2246
- "aliases": [
2247
- "email-layouts-dir"
2248
- ],
2903
+ "message-types-dir": {
2249
2904
  "dependsOn": [
2250
2905
  "all"
2251
2906
  ],
2252
- "name": "layouts-dir",
2253
- "summary": "The target directory path to find all layouts to push.",
2907
+ "name": "message-types-dir",
2908
+ "summary": "The target directory path to find all message types to push.",
2254
2909
  "hasDynamicHelp": false,
2255
2910
  "multiple": false,
2256
2911
  "type": "option"
2257
2912
  },
2258
2913
  "commit": {
2259
2914
  "name": "commit",
2260
- "summary": "Push and commit the layout(s) at the same time",
2915
+ "summary": "Push and commit the message type(s) at the same time",
2261
2916
  "allowNo": false,
2262
2917
  "type": "boolean"
2263
2918
  },
@@ -2271,30 +2926,36 @@
2271
2926
  "hasDynamicHelp": false,
2272
2927
  "multiple": false,
2273
2928
  "type": "option"
2929
+ },
2930
+ "force": {
2931
+ "name": "force",
2932
+ "summary": "Force pushes the resource or resources to Knock, overwriting whatever is currently stored. If you're using this on a non-development environment, you should also ensure you `commit` the changes.",
2933
+ "allowNo": false,
2934
+ "type": "boolean"
2274
2935
  }
2275
2936
  },
2276
2937
  "hasDynamicHelp": false,
2277
2938
  "hiddenAliases": [],
2278
- "id": "layout:push",
2939
+ "id": "message-type:push",
2279
2940
  "pluginAlias": "@knocklabs/cli",
2280
2941
  "pluginName": "@knocklabs/cli",
2281
2942
  "pluginType": "core",
2282
2943
  "strict": true,
2283
- "summary": "Push one or more email layouts from a local file system to Knock.",
2944
+ "summary": "Push one or more message types from a local file system to Knock.",
2284
2945
  "enableJsonFlag": false,
2285
2946
  "isESM": false,
2286
2947
  "relativePath": [
2287
2948
  "dist",
2288
2949
  "commands",
2289
- "layout",
2950
+ "message-type",
2290
2951
  "push.js"
2291
2952
  ]
2292
2953
  },
2293
- "layout:validate": {
2954
+ "message-type:validate": {
2294
2955
  "aliases": [],
2295
2956
  "args": {
2296
- "emailLayoutKey": {
2297
- "name": "emailLayoutKey",
2957
+ "messageTypeKey": {
2958
+ "name": "messageTypeKey",
2298
2959
  "required": false
2299
2960
  }
2300
2961
  },
@@ -2318,7 +2979,7 @@
2318
2979
  },
2319
2980
  "environment": {
2320
2981
  "name": "environment",
2321
- "summary": "Validating a layout is only done in the development environment",
2982
+ "summary": "Validating a message type is only done in the development environment",
2322
2983
  "default": "development",
2323
2984
  "hasDynamicHelp": false,
2324
2985
  "multiple": false,
@@ -2336,19 +2997,16 @@
2336
2997
  },
2337
2998
  "all": {
2338
2999
  "name": "all",
2339
- "summary": "Whether to validate all layouts from the target directory.",
3000
+ "summary": "Whether to validate all message types from the target directory.",
2340
3001
  "allowNo": false,
2341
3002
  "type": "boolean"
2342
3003
  },
2343
- "layouts-dir": {
2344
- "aliases": [
2345
- "email-layouts-dir"
2346
- ],
3004
+ "message-types-dir": {
2347
3005
  "dependsOn": [
2348
3006
  "all"
2349
3007
  ],
2350
- "name": "layouts-dir",
2351
- "summary": "The target directory path to find all layouts to validate.",
3008
+ "name": "message-types-dir",
3009
+ "summary": "The target directory path to find all message types to validate.",
2352
3010
  "hasDynamicHelp": false,
2353
3011
  "multiple": false,
2354
3012
  "type": "option"
@@ -2356,26 +3014,26 @@
2356
3014
  },
2357
3015
  "hasDynamicHelp": false,
2358
3016
  "hiddenAliases": [],
2359
- "id": "layout:validate",
3017
+ "id": "message-type:validate",
2360
3018
  "pluginAlias": "@knocklabs/cli",
2361
3019
  "pluginName": "@knocklabs/cli",
2362
3020
  "pluginType": "core",
2363
3021
  "strict": true,
2364
- "summary": "Validate one or more layouts from a local file system.",
3022
+ "summary": "Validate one or more message types from a local file system.",
2365
3023
  "enableJsonFlag": false,
2366
3024
  "isESM": false,
2367
3025
  "relativePath": [
2368
3026
  "dist",
2369
3027
  "commands",
2370
- "layout",
3028
+ "message-type",
2371
3029
  "validate.js"
2372
3030
  ]
2373
3031
  },
2374
- "message-type:get": {
3032
+ "layout:get": {
2375
3033
  "aliases": [],
2376
3034
  "args": {
2377
- "messageTypeKey": {
2378
- "name": "messageTypeKey",
3035
+ "emailLayoutKey": {
3036
+ "name": "emailLayoutKey",
2379
3037
  "required": true
2380
3038
  }
2381
3039
  },
@@ -2428,22 +3086,22 @@
2428
3086
  },
2429
3087
  "hasDynamicHelp": false,
2430
3088
  "hiddenAliases": [],
2431
- "id": "message-type:get",
3089
+ "id": "layout:get",
2432
3090
  "pluginAlias": "@knocklabs/cli",
2433
3091
  "pluginName": "@knocklabs/cli",
2434
3092
  "pluginType": "core",
2435
3093
  "strict": true,
2436
- "summary": "Display a single in-app message type from an environment.",
3094
+ "summary": "Display a single email layout from an environment.",
2437
3095
  "enableJsonFlag": true,
2438
3096
  "isESM": false,
2439
3097
  "relativePath": [
2440
3098
  "dist",
2441
3099
  "commands",
2442
- "message-type",
3100
+ "layout",
2443
3101
  "get.js"
2444
3102
  ]
2445
3103
  },
2446
- "message-type:list": {
3104
+ "layout:list": {
2447
3105
  "aliases": [],
2448
3106
  "args": {},
2449
3107
  "flags": {
@@ -2516,22 +3174,22 @@
2516
3174
  },
2517
3175
  "hasDynamicHelp": false,
2518
3176
  "hiddenAliases": [],
2519
- "id": "message-type:list",
3177
+ "id": "layout:list",
2520
3178
  "pluginAlias": "@knocklabs/cli",
2521
3179
  "pluginName": "@knocklabs/cli",
2522
3180
  "pluginType": "core",
2523
3181
  "strict": true,
2524
- "summary": "Display all in-app message types for an environment.",
3182
+ "summary": "Display all email layouts for an environment.",
2525
3183
  "enableJsonFlag": true,
2526
3184
  "isESM": false,
2527
3185
  "relativePath": [
2528
3186
  "dist",
2529
3187
  "commands",
2530
- "message-type",
3188
+ "layout",
2531
3189
  "list.js"
2532
3190
  ]
2533
3191
  },
2534
- "message-type:new": {
3192
+ "layout:new": {
2535
3193
  "aliases": [],
2536
3194
  "args": {},
2537
3195
  "flags": {
@@ -2555,7 +3213,7 @@
2555
3213
  "name": {
2556
3214
  "char": "n",
2557
3215
  "name": "name",
2558
- "summary": "The name of the message type",
3216
+ "summary": "The name of the email layout",
2559
3217
  "hasDynamicHelp": false,
2560
3218
  "multiple": false,
2561
3219
  "type": "option"
@@ -2563,14 +3221,14 @@
2563
3221
  "key": {
2564
3222
  "char": "k",
2565
3223
  "name": "key",
2566
- "summary": "The key of the message type",
3224
+ "summary": "The key of the email layout",
2567
3225
  "hasDynamicHelp": false,
2568
3226
  "multiple": false,
2569
3227
  "type": "option"
2570
3228
  },
2571
3229
  "environment": {
2572
3230
  "name": "environment",
2573
- "summary": "The environment to create the message type in. Defaults to development.",
3231
+ "summary": "The environment to create the email layout in. Defaults to development.",
2574
3232
  "default": "development",
2575
3233
  "hasDynamicHelp": false,
2576
3234
  "multiple": false,
@@ -2585,20 +3243,20 @@
2585
3243
  },
2586
3244
  "force": {
2587
3245
  "name": "force",
2588
- "summary": "Force the creation of the message type directory without confirmation.",
3246
+ "summary": "Force the creation of the email layout directory without confirmation.",
2589
3247
  "allowNo": false,
2590
3248
  "type": "boolean"
2591
3249
  },
2592
3250
  "push": {
2593
3251
  "char": "p",
2594
3252
  "name": "push",
2595
- "summary": "Whether or not to push the message type to Knock after creation.",
3253
+ "summary": "Whether or not to push the email layout to Knock after creation.",
2596
3254
  "allowNo": false,
2597
3255
  "type": "boolean"
2598
3256
  },
2599
3257
  "template": {
2600
3258
  "name": "template",
2601
- "summary": "The template to use for the message type. Should be `message-types/{key}`.",
3259
+ "summary": "The template to use for the email layout. Should be `email-layouts/{key}`.",
2602
3260
  "hasDynamicHelp": false,
2603
3261
  "multiple": false,
2604
3262
  "type": "option"
@@ -2606,26 +3264,26 @@
2606
3264
  },
2607
3265
  "hasDynamicHelp": false,
2608
3266
  "hiddenAliases": [],
2609
- "id": "message-type:new",
3267
+ "id": "layout:new",
2610
3268
  "pluginAlias": "@knocklabs/cli",
2611
3269
  "pluginName": "@knocklabs/cli",
2612
3270
  "pluginType": "core",
2613
3271
  "strict": true,
2614
- "summary": "Create a new message type with a minimal configuration.",
3272
+ "summary": "Create a new email layout with a minimal configuration.",
2615
3273
  "enableJsonFlag": false,
2616
3274
  "isESM": false,
2617
3275
  "relativePath": [
2618
3276
  "dist",
2619
3277
  "commands",
2620
- "message-type",
3278
+ "layout",
2621
3279
  "new.js"
2622
3280
  ]
2623
3281
  },
2624
- "message-type:open": {
3282
+ "layout:open": {
2625
3283
  "aliases": [],
2626
3284
  "args": {
2627
- "messageTypeKey": {
2628
- "name": "messageTypeKey",
3285
+ "layoutKey": {
3286
+ "name": "layoutKey",
2629
3287
  "required": true
2630
3288
  }
2631
3289
  },
@@ -2665,26 +3323,26 @@
2665
3323
  },
2666
3324
  "hasDynamicHelp": false,
2667
3325
  "hiddenAliases": [],
2668
- "id": "message-type:open",
3326
+ "id": "layout:open",
2669
3327
  "pluginAlias": "@knocklabs/cli",
2670
3328
  "pluginName": "@knocklabs/cli",
2671
3329
  "pluginType": "core",
2672
3330
  "strict": true,
2673
- "summary": "Open a message type in the Knock dashboard.",
3331
+ "summary": "Open a layout in the Knock dashboard.",
2674
3332
  "enableJsonFlag": false,
2675
3333
  "isESM": false,
2676
3334
  "relativePath": [
2677
3335
  "dist",
2678
3336
  "commands",
2679
- "message-type",
3337
+ "layout",
2680
3338
  "open.js"
2681
3339
  ]
2682
3340
  },
2683
- "message-type:pull": {
3341
+ "layout:pull": {
2684
3342
  "aliases": [],
2685
3343
  "args": {
2686
- "messageTypeKey": {
2687
- "name": "messageTypeKey",
3344
+ "emailLayoutKey": {
3345
+ "name": "emailLayoutKey",
2688
3346
  "required": false
2689
3347
  }
2690
3348
  },
@@ -2723,16 +3381,19 @@
2723
3381
  },
2724
3382
  "all": {
2725
3383
  "name": "all",
2726
- "summary": "Whether to pull all in-app message types from the specified environment.",
3384
+ "summary": "Whether to pull all email layouts from the specified environment.",
2727
3385
  "allowNo": false,
2728
3386
  "type": "boolean"
2729
3387
  },
2730
- "message-types-dir": {
3388
+ "layouts-dir": {
3389
+ "aliases": [
3390
+ "email-layouts-dir"
3391
+ ],
2731
3392
  "dependsOn": [
2732
3393
  "all"
2733
3394
  ],
2734
- "name": "message-types-dir",
2735
- "summary": "The target directory path to pull all in-app message types into.",
3395
+ "name": "layouts-dir",
3396
+ "summary": "The target directory path to pull all email layouts into.",
2736
3397
  "hasDynamicHelp": false,
2737
3398
  "multiple": false,
2738
3399
  "type": "option"
@@ -2752,26 +3413,26 @@
2752
3413
  },
2753
3414
  "hasDynamicHelp": false,
2754
3415
  "hiddenAliases": [],
2755
- "id": "message-type:pull",
3416
+ "id": "layout:pull",
2756
3417
  "pluginAlias": "@knocklabs/cli",
2757
3418
  "pluginName": "@knocklabs/cli",
2758
3419
  "pluginType": "core",
2759
3420
  "strict": true,
2760
- "summary": "Pull one or more in-app message types from an environment into a local file system.",
3421
+ "summary": "Pull one or more email layouts from an environment into a local file system.",
2761
3422
  "enableJsonFlag": false,
2762
3423
  "isESM": false,
2763
3424
  "relativePath": [
2764
3425
  "dist",
2765
3426
  "commands",
2766
- "message-type",
3427
+ "layout",
2767
3428
  "pull.js"
2768
3429
  ]
2769
3430
  },
2770
- "message-type:push": {
3431
+ "layout:push": {
2771
3432
  "aliases": [],
2772
3433
  "args": {
2773
- "messageTypeKey": {
2774
- "name": "messageTypeKey",
3434
+ "emailLayoutKey": {
3435
+ "name": "emailLayoutKey",
2775
3436
  "required": false
2776
3437
  }
2777
3438
  },
@@ -2795,7 +3456,7 @@
2795
3456
  },
2796
3457
  "environment": {
2797
3458
  "name": "environment",
2798
- "summary": "Pushing a message type is only allowed in the development environment",
3459
+ "summary": "Pushing an email layout is only allowed in the development environment",
2799
3460
  "default": "development",
2800
3461
  "hasDynamicHelp": false,
2801
3462
  "multiple": false,
@@ -2813,23 +3474,26 @@
2813
3474
  },
2814
3475
  "all": {
2815
3476
  "name": "all",
2816
- "summary": "Whether to push all message types from the target directory.",
3477
+ "summary": "Whether to push all layouts from the target directory.",
2817
3478
  "allowNo": false,
2818
3479
  "type": "boolean"
2819
3480
  },
2820
- "message-types-dir": {
3481
+ "layouts-dir": {
3482
+ "aliases": [
3483
+ "email-layouts-dir"
3484
+ ],
2821
3485
  "dependsOn": [
2822
3486
  "all"
2823
3487
  ],
2824
- "name": "message-types-dir",
2825
- "summary": "The target directory path to find all message types to push.",
3488
+ "name": "layouts-dir",
3489
+ "summary": "The target directory path to find all layouts to push.",
2826
3490
  "hasDynamicHelp": false,
2827
3491
  "multiple": false,
2828
3492
  "type": "option"
2829
3493
  },
2830
3494
  "commit": {
2831
3495
  "name": "commit",
2832
- "summary": "Push and commit the message type(s) at the same time",
3496
+ "summary": "Push and commit the layout(s) at the same time",
2833
3497
  "allowNo": false,
2834
3498
  "type": "boolean"
2835
3499
  },
@@ -2843,30 +3507,36 @@
2843
3507
  "hasDynamicHelp": false,
2844
3508
  "multiple": false,
2845
3509
  "type": "option"
3510
+ },
3511
+ "force": {
3512
+ "name": "force",
3513
+ "summary": "Force pushes the resource or resources to Knock, overwriting whatever is currently stored. If you're using this on a non-development environment, you should also ensure you `commit` the changes.",
3514
+ "allowNo": false,
3515
+ "type": "boolean"
2846
3516
  }
2847
3517
  },
2848
3518
  "hasDynamicHelp": false,
2849
3519
  "hiddenAliases": [],
2850
- "id": "message-type:push",
3520
+ "id": "layout:push",
2851
3521
  "pluginAlias": "@knocklabs/cli",
2852
3522
  "pluginName": "@knocklabs/cli",
2853
3523
  "pluginType": "core",
2854
3524
  "strict": true,
2855
- "summary": "Push one or more message types from a local file system to Knock.",
3525
+ "summary": "Push one or more email layouts from a local file system to Knock.",
2856
3526
  "enableJsonFlag": false,
2857
3527
  "isESM": false,
2858
3528
  "relativePath": [
2859
3529
  "dist",
2860
3530
  "commands",
2861
- "message-type",
3531
+ "layout",
2862
3532
  "push.js"
2863
3533
  ]
2864
3534
  },
2865
- "message-type:validate": {
3535
+ "layout:validate": {
2866
3536
  "aliases": [],
2867
3537
  "args": {
2868
- "messageTypeKey": {
2869
- "name": "messageTypeKey",
3538
+ "emailLayoutKey": {
3539
+ "name": "emailLayoutKey",
2870
3540
  "required": false
2871
3541
  }
2872
3542
  },
@@ -2890,7 +3560,7 @@
2890
3560
  },
2891
3561
  "environment": {
2892
3562
  "name": "environment",
2893
- "summary": "Validating a message type is only done in the development environment",
3563
+ "summary": "Validating a layout is only done in the development environment",
2894
3564
  "default": "development",
2895
3565
  "hasDynamicHelp": false,
2896
3566
  "multiple": false,
@@ -2908,16 +3578,19 @@
2908
3578
  },
2909
3579
  "all": {
2910
3580
  "name": "all",
2911
- "summary": "Whether to validate all message types from the target directory.",
3581
+ "summary": "Whether to validate all layouts from the target directory.",
2912
3582
  "allowNo": false,
2913
3583
  "type": "boolean"
2914
3584
  },
2915
- "message-types-dir": {
3585
+ "layouts-dir": {
3586
+ "aliases": [
3587
+ "email-layouts-dir"
3588
+ ],
2916
3589
  "dependsOn": [
2917
3590
  "all"
2918
3591
  ],
2919
- "name": "message-types-dir",
2920
- "summary": "The target directory path to find all message types to validate.",
3592
+ "name": "layouts-dir",
3593
+ "summary": "The target directory path to find all layouts to validate.",
2921
3594
  "hasDynamicHelp": false,
2922
3595
  "multiple": false,
2923
3596
  "type": "option"
@@ -2925,18 +3598,18 @@
2925
3598
  },
2926
3599
  "hasDynamicHelp": false,
2927
3600
  "hiddenAliases": [],
2928
- "id": "message-type:validate",
3601
+ "id": "layout:validate",
2929
3602
  "pluginAlias": "@knocklabs/cli",
2930
3603
  "pluginName": "@knocklabs/cli",
2931
3604
  "pluginType": "core",
2932
3605
  "strict": true,
2933
- "summary": "Validate one or more message types from a local file system.",
3606
+ "summary": "Validate one or more layouts from a local file system.",
2934
3607
  "enableJsonFlag": false,
2935
3608
  "isESM": false,
2936
3609
  "relativePath": [
2937
3610
  "dist",
2938
3611
  "commands",
2939
- "message-type",
3612
+ "layout",
2940
3613
  "validate.js"
2941
3614
  ]
2942
3615
  },
@@ -3426,6 +4099,12 @@
3426
4099
  "hasDynamicHelp": false,
3427
4100
  "multiple": false,
3428
4101
  "type": "option"
4102
+ },
4103
+ "force": {
4104
+ "name": "force",
4105
+ "summary": "Force pushes the resource or resources to Knock, overwriting whatever is currently stored. If you're using this on a non-development environment, you should also ensure you `commit` the changes.",
4106
+ "allowNo": false,
4107
+ "type": "boolean"
3429
4108
  }
3430
4109
  },
3431
4110
  "hasDynamicHelp": false,
@@ -3876,6 +4555,12 @@
3876
4555
  "hasDynamicHelp": false,
3877
4556
  "multiple": false,
3878
4557
  "type": "option"
4558
+ },
4559
+ "force": {
4560
+ "name": "force",
4561
+ "summary": "Force pushes the resource or resources to Knock, overwriting whatever is currently stored. If you're using this on a non-development environment, you should also ensure you `commit` the changes.",
4562
+ "allowNo": false,
4563
+ "type": "boolean"
3879
4564
  }
3880
4565
  },
3881
4566
  "hasDynamicHelp": false,
@@ -4594,6 +5279,12 @@
4594
5279
  "hasDynamicHelp": false,
4595
5280
  "multiple": false,
4596
5281
  "type": "option"
5282
+ },
5283
+ "force": {
5284
+ "name": "force",
5285
+ "summary": "Force pushes the resource or resources to Knock, overwriting whatever is currently stored. If you're using this on a non-development environment, you should also ensure you `commit` the changes.",
5286
+ "allowNo": false,
5287
+ "type": "boolean"
4597
5288
  }
4598
5289
  },
4599
5290
  "hasDynamicHelp": false,
@@ -4780,5 +5471,5 @@
4780
5471
  ]
4781
5472
  }
4782
5473
  },
4783
- "version": "1.0.0"
5474
+ "version": "1.0.3"
4784
5475
  }