@knocklabs/cli 1.0.0-rc.1 → 1.0.2

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 (34) hide show
  1. package/README.md +332 -64
  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 +167 -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/open.js +106 -0
  14. package/dist/commands/layout/open.js +106 -0
  15. package/dist/commands/message-type/open.js +106 -0
  16. package/dist/commands/partial/open.js +106 -0
  17. package/dist/commands/pull.js +19 -12
  18. package/dist/commands/push.js +19 -12
  19. package/dist/commands/workflow/open.js +106 -0
  20. package/dist/lib/helpers/git.js +22 -3
  21. package/dist/lib/helpers/project-config.js +1 -0
  22. package/dist/lib/marshal/audience/generator.js +38 -0
  23. package/dist/lib/marshal/audience/helpers.js +142 -0
  24. package/dist/lib/marshal/audience/index.js +23 -0
  25. package/dist/lib/marshal/audience/processor.isomorphic.js +25 -0
  26. package/dist/lib/marshal/audience/reader.js +149 -0
  27. package/dist/lib/marshal/audience/types.js +15 -0
  28. package/dist/lib/marshal/audience/writer.js +177 -0
  29. package/dist/lib/marshal/index.isomorphic.js +18 -14
  30. package/dist/lib/resources.js +3 -0
  31. package/dist/lib/run-context/loader.js +12 -20
  32. package/dist/lib/urls.js +20 -0
  33. package/oclif.manifest.json +1368 -430
  34. package/package.json +11 -11
@@ -352,13 +352,656 @@
352
352
  "whoami.js"
353
353
  ]
354
354
  },
355
+ "audience:archive": {
356
+ "aliases": [],
357
+ "args": {
358
+ "audienceKey": {
359
+ "description": "The key of the audience to archive.",
360
+ "name": "audienceKey",
361
+ "required": true
362
+ }
363
+ },
364
+ "description": "\nWARNING: Archiving an audience affects ALL environments and cannot be undone.\nUse this command with caution.\n",
365
+ "flags": {
366
+ "service-token": {
367
+ "env": "KNOCK_SERVICE_TOKEN",
368
+ "name": "service-token",
369
+ "required": false,
370
+ "summary": "The service token to authenticate with.",
371
+ "hasDynamicHelp": false,
372
+ "multiple": false,
373
+ "type": "option"
374
+ },
375
+ "api-origin": {
376
+ "hidden": true,
377
+ "name": "api-origin",
378
+ "required": false,
379
+ "hasDynamicHelp": false,
380
+ "multiple": false,
381
+ "type": "option"
382
+ },
383
+ "environment": {
384
+ "name": "environment",
385
+ "required": true,
386
+ "summary": "The environment to use.",
387
+ "hasDynamicHelp": false,
388
+ "multiple": false,
389
+ "type": "option"
390
+ },
391
+ "branch": {
392
+ "name": "branch",
393
+ "summary": "The slug of the branch to use.",
394
+ "hasDynamicHelp": false,
395
+ "multiple": false,
396
+ "type": "option"
397
+ },
398
+ "force": {
399
+ "name": "force",
400
+ "summary": "Skip confirmation prompt.",
401
+ "allowNo": false,
402
+ "type": "boolean"
403
+ }
404
+ },
405
+ "hasDynamicHelp": false,
406
+ "hiddenAliases": [],
407
+ "id": "audience:archive",
408
+ "pluginAlias": "@knocklabs/cli",
409
+ "pluginName": "@knocklabs/cli",
410
+ "pluginType": "core",
411
+ "strict": true,
412
+ "summary": "Archive an audience (affects ALL environments).",
413
+ "enableJsonFlag": false,
414
+ "isESM": false,
415
+ "relativePath": [
416
+ "dist",
417
+ "commands",
418
+ "audience",
419
+ "archive.js"
420
+ ]
421
+ },
422
+ "audience:get": {
423
+ "aliases": [],
424
+ "args": {
425
+ "audienceKey": {
426
+ "name": "audienceKey",
427
+ "required": true
428
+ }
429
+ },
430
+ "flags": {
431
+ "json": {
432
+ "description": "Format output as json.",
433
+ "helpGroup": "GLOBAL",
434
+ "name": "json",
435
+ "allowNo": false,
436
+ "type": "boolean"
437
+ },
438
+ "service-token": {
439
+ "env": "KNOCK_SERVICE_TOKEN",
440
+ "name": "service-token",
441
+ "required": false,
442
+ "summary": "The service token to authenticate with.",
443
+ "hasDynamicHelp": false,
444
+ "multiple": false,
445
+ "type": "option"
446
+ },
447
+ "api-origin": {
448
+ "hidden": true,
449
+ "name": "api-origin",
450
+ "required": false,
451
+ "hasDynamicHelp": false,
452
+ "multiple": false,
453
+ "type": "option"
454
+ },
455
+ "environment": {
456
+ "name": "environment",
457
+ "summary": "The environment to use.",
458
+ "default": "development",
459
+ "hasDynamicHelp": false,
460
+ "multiple": false,
461
+ "type": "option"
462
+ },
463
+ "branch": {
464
+ "name": "branch",
465
+ "summary": "The slug of the branch to use.",
466
+ "hasDynamicHelp": false,
467
+ "multiple": false,
468
+ "type": "option"
469
+ },
470
+ "hide-uncommitted-changes": {
471
+ "name": "hide-uncommitted-changes",
472
+ "summary": "Hide any uncommitted changes.",
473
+ "allowNo": false,
474
+ "type": "boolean"
475
+ }
476
+ },
477
+ "hasDynamicHelp": false,
478
+ "hiddenAliases": [],
479
+ "id": "audience:get",
480
+ "pluginAlias": "@knocklabs/cli",
481
+ "pluginName": "@knocklabs/cli",
482
+ "pluginType": "core",
483
+ "strict": true,
484
+ "summary": "Display a single audience from an environment.",
485
+ "enableJsonFlag": true,
486
+ "isESM": false,
487
+ "relativePath": [
488
+ "dist",
489
+ "commands",
490
+ "audience",
491
+ "get.js"
492
+ ]
493
+ },
494
+ "audience:list": {
495
+ "aliases": [],
496
+ "args": {},
497
+ "flags": {
498
+ "json": {
499
+ "description": "Format output as json.",
500
+ "helpGroup": "GLOBAL",
501
+ "name": "json",
502
+ "allowNo": false,
503
+ "type": "boolean"
504
+ },
505
+ "service-token": {
506
+ "env": "KNOCK_SERVICE_TOKEN",
507
+ "name": "service-token",
508
+ "required": false,
509
+ "summary": "The service token to authenticate with.",
510
+ "hasDynamicHelp": false,
511
+ "multiple": false,
512
+ "type": "option"
513
+ },
514
+ "api-origin": {
515
+ "hidden": true,
516
+ "name": "api-origin",
517
+ "required": false,
518
+ "hasDynamicHelp": false,
519
+ "multiple": false,
520
+ "type": "option"
521
+ },
522
+ "environment": {
523
+ "name": "environment",
524
+ "summary": "The environment to use.",
525
+ "default": "development",
526
+ "hasDynamicHelp": false,
527
+ "multiple": false,
528
+ "type": "option"
529
+ },
530
+ "branch": {
531
+ "name": "branch",
532
+ "summary": "The slug of the branch to use.",
533
+ "hasDynamicHelp": false,
534
+ "multiple": false,
535
+ "type": "option"
536
+ },
537
+ "hide-uncommitted-changes": {
538
+ "name": "hide-uncommitted-changes",
539
+ "summary": "Hide any uncommitted changes.",
540
+ "allowNo": false,
541
+ "type": "boolean"
542
+ },
543
+ "after": {
544
+ "name": "after",
545
+ "summary": "The cursor after which to fetch the next page.",
546
+ "hasDynamicHelp": false,
547
+ "multiple": false,
548
+ "type": "option"
549
+ },
550
+ "before": {
551
+ "name": "before",
552
+ "summary": "The cursor before which to fetch the previous page.",
553
+ "hasDynamicHelp": false,
554
+ "multiple": false,
555
+ "type": "option"
556
+ },
557
+ "limit": {
558
+ "name": "limit",
559
+ "summary": "The total number of entries to fetch per page.",
560
+ "hasDynamicHelp": false,
561
+ "multiple": false,
562
+ "type": "option"
563
+ }
564
+ },
565
+ "hasDynamicHelp": false,
566
+ "hiddenAliases": [],
567
+ "id": "audience:list",
568
+ "pluginAlias": "@knocklabs/cli",
569
+ "pluginName": "@knocklabs/cli",
570
+ "pluginType": "core",
571
+ "strict": true,
572
+ "summary": "Display all audiences for an environment.",
573
+ "enableJsonFlag": true,
574
+ "isESM": false,
575
+ "relativePath": [
576
+ "dist",
577
+ "commands",
578
+ "audience",
579
+ "list.js"
580
+ ]
581
+ },
582
+ "audience:new": {
583
+ "aliases": [],
584
+ "args": {},
585
+ "flags": {
586
+ "service-token": {
587
+ "env": "KNOCK_SERVICE_TOKEN",
588
+ "name": "service-token",
589
+ "required": false,
590
+ "summary": "The service token to authenticate with.",
591
+ "hasDynamicHelp": false,
592
+ "multiple": false,
593
+ "type": "option"
594
+ },
595
+ "api-origin": {
596
+ "hidden": true,
597
+ "name": "api-origin",
598
+ "required": false,
599
+ "hasDynamicHelp": false,
600
+ "multiple": false,
601
+ "type": "option"
602
+ },
603
+ "name": {
604
+ "char": "n",
605
+ "name": "name",
606
+ "summary": "The name of the audience",
607
+ "hasDynamicHelp": false,
608
+ "multiple": false,
609
+ "type": "option"
610
+ },
611
+ "key": {
612
+ "char": "k",
613
+ "name": "key",
614
+ "summary": "The key of the audience",
615
+ "hasDynamicHelp": false,
616
+ "multiple": false,
617
+ "type": "option"
618
+ },
619
+ "type": {
620
+ "char": "t",
621
+ "name": "type",
622
+ "summary": "The type of the audience (static, dynamic). Note: dynamic is in beta and requires access.",
623
+ "hasDynamicHelp": false,
624
+ "multiple": false,
625
+ "options": [
626
+ "static",
627
+ "dynamic"
628
+ ],
629
+ "type": "option"
630
+ },
631
+ "description": {
632
+ "char": "d",
633
+ "name": "description",
634
+ "summary": "The description of the audience",
635
+ "hasDynamicHelp": false,
636
+ "multiple": false,
637
+ "type": "option"
638
+ },
639
+ "environment": {
640
+ "name": "environment",
641
+ "summary": "The environment to create the audience in. Defaults to development.",
642
+ "default": "development",
643
+ "hasDynamicHelp": false,
644
+ "multiple": false,
645
+ "type": "option"
646
+ },
647
+ "branch": {
648
+ "name": "branch",
649
+ "summary": "The slug of the branch to use.",
650
+ "hasDynamicHelp": false,
651
+ "multiple": false,
652
+ "type": "option"
653
+ },
654
+ "force": {
655
+ "name": "force",
656
+ "summary": "Force the creation of the audience directory without confirmation.",
657
+ "allowNo": false,
658
+ "type": "boolean"
659
+ },
660
+ "push": {
661
+ "char": "p",
662
+ "name": "push",
663
+ "summary": "Whether or not to push the audience to Knock after creation.",
664
+ "allowNo": false,
665
+ "type": "boolean"
666
+ }
667
+ },
668
+ "hasDynamicHelp": false,
669
+ "hiddenAliases": [],
670
+ "id": "audience:new",
671
+ "pluginAlias": "@knocklabs/cli",
672
+ "pluginName": "@knocklabs/cli",
673
+ "pluginType": "core",
674
+ "strict": true,
675
+ "summary": "Create a new audience with a minimal configuration.",
676
+ "enableJsonFlag": false,
677
+ "isESM": false,
678
+ "relativePath": [
679
+ "dist",
680
+ "commands",
681
+ "audience",
682
+ "new.js"
683
+ ]
684
+ },
685
+ "audience:open": {
686
+ "aliases": [],
687
+ "args": {
688
+ "audienceKey": {
689
+ "name": "audienceKey",
690
+ "required": true
691
+ }
692
+ },
693
+ "flags": {
694
+ "service-token": {
695
+ "env": "KNOCK_SERVICE_TOKEN",
696
+ "name": "service-token",
697
+ "required": false,
698
+ "summary": "The service token to authenticate with.",
699
+ "hasDynamicHelp": false,
700
+ "multiple": false,
701
+ "type": "option"
702
+ },
703
+ "api-origin": {
704
+ "hidden": true,
705
+ "name": "api-origin",
706
+ "required": false,
707
+ "hasDynamicHelp": false,
708
+ "multiple": false,
709
+ "type": "option"
710
+ },
711
+ "environment": {
712
+ "name": "environment",
713
+ "summary": "The environment to use.",
714
+ "default": "development",
715
+ "hasDynamicHelp": false,
716
+ "multiple": false,
717
+ "type": "option"
718
+ },
719
+ "branch": {
720
+ "name": "branch",
721
+ "summary": "The slug of the branch to use.",
722
+ "hasDynamicHelp": false,
723
+ "multiple": false,
724
+ "type": "option"
725
+ }
726
+ },
727
+ "hasDynamicHelp": false,
728
+ "hiddenAliases": [],
729
+ "id": "audience:open",
730
+ "pluginAlias": "@knocklabs/cli",
731
+ "pluginName": "@knocklabs/cli",
732
+ "pluginType": "core",
733
+ "strict": true,
734
+ "summary": "Open an audience in the Knock dashboard.",
735
+ "enableJsonFlag": false,
736
+ "isESM": false,
737
+ "relativePath": [
738
+ "dist",
739
+ "commands",
740
+ "audience",
741
+ "open.js"
742
+ ]
743
+ },
744
+ "audience:pull": {
745
+ "aliases": [],
746
+ "args": {
747
+ "audienceKey": {
748
+ "name": "audienceKey",
749
+ "required": false
750
+ }
751
+ },
752
+ "flags": {
753
+ "service-token": {
754
+ "env": "KNOCK_SERVICE_TOKEN",
755
+ "name": "service-token",
756
+ "required": false,
757
+ "summary": "The service token to authenticate with.",
758
+ "hasDynamicHelp": false,
759
+ "multiple": false,
760
+ "type": "option"
761
+ },
762
+ "api-origin": {
763
+ "hidden": true,
764
+ "name": "api-origin",
765
+ "required": false,
766
+ "hasDynamicHelp": false,
767
+ "multiple": false,
768
+ "type": "option"
769
+ },
770
+ "environment": {
771
+ "name": "environment",
772
+ "summary": "The environment to use.",
773
+ "default": "development",
774
+ "hasDynamicHelp": false,
775
+ "multiple": false,
776
+ "type": "option"
777
+ },
778
+ "branch": {
779
+ "name": "branch",
780
+ "summary": "The slug of the branch to use.",
781
+ "hasDynamicHelp": false,
782
+ "multiple": false,
783
+ "type": "option"
784
+ },
785
+ "all": {
786
+ "name": "all",
787
+ "summary": "Whether to pull all audiences from the specified environment.",
788
+ "allowNo": false,
789
+ "type": "boolean"
790
+ },
791
+ "audiences-dir": {
792
+ "dependsOn": [
793
+ "all"
794
+ ],
795
+ "name": "audiences-dir",
796
+ "summary": "The target directory path to pull all audiences into.",
797
+ "hasDynamicHelp": false,
798
+ "multiple": false,
799
+ "type": "option"
800
+ },
801
+ "hide-uncommitted-changes": {
802
+ "name": "hide-uncommitted-changes",
803
+ "summary": "Hide any uncommitted changes.",
804
+ "allowNo": false,
805
+ "type": "boolean"
806
+ },
807
+ "force": {
808
+ "name": "force",
809
+ "summary": "Remove the confirmation prompt.",
810
+ "allowNo": false,
811
+ "type": "boolean"
812
+ }
813
+ },
814
+ "hasDynamicHelp": false,
815
+ "hiddenAliases": [],
816
+ "id": "audience:pull",
817
+ "pluginAlias": "@knocklabs/cli",
818
+ "pluginName": "@knocklabs/cli",
819
+ "pluginType": "core",
820
+ "strict": true,
821
+ "summary": "Pull one or more audiences from an environment into a local file system.",
822
+ "enableJsonFlag": false,
823
+ "isESM": false,
824
+ "relativePath": [
825
+ "dist",
826
+ "commands",
827
+ "audience",
828
+ "pull.js"
829
+ ]
830
+ },
831
+ "audience:push": {
832
+ "aliases": [],
833
+ "args": {
834
+ "audienceKey": {
835
+ "name": "audienceKey",
836
+ "required": false
837
+ }
838
+ },
839
+ "flags": {
840
+ "service-token": {
841
+ "env": "KNOCK_SERVICE_TOKEN",
842
+ "name": "service-token",
843
+ "required": false,
844
+ "summary": "The service token to authenticate with.",
845
+ "hasDynamicHelp": false,
846
+ "multiple": false,
847
+ "type": "option"
848
+ },
849
+ "api-origin": {
850
+ "hidden": true,
851
+ "name": "api-origin",
852
+ "required": false,
853
+ "hasDynamicHelp": false,
854
+ "multiple": false,
855
+ "type": "option"
856
+ },
857
+ "environment": {
858
+ "name": "environment",
859
+ "summary": "The environment to push the audience to. Defaults to development.",
860
+ "default": "development",
861
+ "hasDynamicHelp": false,
862
+ "multiple": false,
863
+ "type": "option"
864
+ },
865
+ "branch": {
866
+ "name": "branch",
867
+ "summary": "The slug of the branch to use.",
868
+ "hasDynamicHelp": false,
869
+ "multiple": false,
870
+ "type": "option"
871
+ },
872
+ "all": {
873
+ "name": "all",
874
+ "summary": "Whether to push all audiences from the target directory.",
875
+ "allowNo": false,
876
+ "type": "boolean"
877
+ },
878
+ "audiences-dir": {
879
+ "dependsOn": [
880
+ "all"
881
+ ],
882
+ "name": "audiences-dir",
883
+ "summary": "The target directory path to find all audiences to push.",
884
+ "hasDynamicHelp": false,
885
+ "multiple": false,
886
+ "type": "option"
887
+ },
888
+ "commit": {
889
+ "name": "commit",
890
+ "summary": "Push and commit the audience(s) at the same time",
891
+ "allowNo": false,
892
+ "type": "boolean"
893
+ },
894
+ "commit-message": {
895
+ "char": "m",
896
+ "dependsOn": [
897
+ "commit"
898
+ ],
899
+ "name": "commit-message",
900
+ "summary": "Use the given value as the commit message",
901
+ "hasDynamicHelp": false,
902
+ "multiple": false,
903
+ "type": "option"
904
+ }
905
+ },
906
+ "hasDynamicHelp": false,
907
+ "hiddenAliases": [],
908
+ "id": "audience:push",
909
+ "pluginAlias": "@knocklabs/cli",
910
+ "pluginName": "@knocklabs/cli",
911
+ "pluginType": "core",
912
+ "strict": true,
913
+ "summary": "Push one or more audiences from a local file system to Knock.",
914
+ "enableJsonFlag": false,
915
+ "isESM": false,
916
+ "relativePath": [
917
+ "dist",
918
+ "commands",
919
+ "audience",
920
+ "push.js"
921
+ ]
922
+ },
923
+ "audience:validate": {
924
+ "aliases": [],
925
+ "args": {
926
+ "audienceKey": {
927
+ "name": "audienceKey",
928
+ "required": false
929
+ }
930
+ },
931
+ "flags": {
932
+ "service-token": {
933
+ "env": "KNOCK_SERVICE_TOKEN",
934
+ "name": "service-token",
935
+ "required": false,
936
+ "summary": "The service token to authenticate with.",
937
+ "hasDynamicHelp": false,
938
+ "multiple": false,
939
+ "type": "option"
940
+ },
941
+ "api-origin": {
942
+ "hidden": true,
943
+ "name": "api-origin",
944
+ "required": false,
945
+ "hasDynamicHelp": false,
946
+ "multiple": false,
947
+ "type": "option"
948
+ },
949
+ "environment": {
950
+ "name": "environment",
951
+ "summary": "The environment to validate the audience against. Defaults to development.",
952
+ "default": "development",
953
+ "hasDynamicHelp": false,
954
+ "multiple": false,
955
+ "type": "option"
956
+ },
957
+ "branch": {
958
+ "name": "branch",
959
+ "summary": "The slug of the branch to use.",
960
+ "hasDynamicHelp": false,
961
+ "multiple": false,
962
+ "type": "option"
963
+ },
964
+ "all": {
965
+ "name": "all",
966
+ "summary": "Whether to validate all audiences from the target directory.",
967
+ "allowNo": false,
968
+ "type": "boolean"
969
+ },
970
+ "audiences-dir": {
971
+ "dependsOn": [
972
+ "all"
973
+ ],
974
+ "name": "audiences-dir",
975
+ "summary": "The target directory path to find all audiences to validate.",
976
+ "hasDynamicHelp": false,
977
+ "multiple": false,
978
+ "type": "option"
979
+ }
980
+ },
981
+ "hasDynamicHelp": false,
982
+ "hiddenAliases": [],
983
+ "id": "audience:validate",
984
+ "pluginAlias": "@knocklabs/cli",
985
+ "pluginName": "@knocklabs/cli",
986
+ "pluginType": "core",
987
+ "strict": true,
988
+ "summary": "Validate one or more audiences from a local file system.",
989
+ "enableJsonFlag": false,
990
+ "isESM": false,
991
+ "relativePath": [
992
+ "dist",
993
+ "commands",
994
+ "audience",
995
+ "validate.js"
996
+ ]
997
+ },
355
998
  "branch:create": {
356
999
  "aliases": [],
357
1000
  "args": {
358
1001
  "slug": {
359
1002
  "description": "The slug for the new branch",
360
1003
  "name": "slug",
361
- "required": true
1004
+ "required": false
362
1005
  }
363
1006
  },
364
1007
  "flags": {
@@ -675,52 +1318,6 @@
675
1318
  "switch.js"
676
1319
  ]
677
1320
  },
678
- "channel:list": {
679
- "aliases": [],
680
- "args": {},
681
- "flags": {
682
- "json": {
683
- "description": "Format output as json.",
684
- "helpGroup": "GLOBAL",
685
- "name": "json",
686
- "allowNo": false,
687
- "type": "boolean"
688
- },
689
- "service-token": {
690
- "env": "KNOCK_SERVICE_TOKEN",
691
- "name": "service-token",
692
- "required": false,
693
- "summary": "The service token to authenticate with.",
694
- "hasDynamicHelp": false,
695
- "multiple": false,
696
- "type": "option"
697
- },
698
- "api-origin": {
699
- "hidden": true,
700
- "name": "api-origin",
701
- "required": false,
702
- "hasDynamicHelp": false,
703
- "multiple": false,
704
- "type": "option"
705
- }
706
- },
707
- "hasDynamicHelp": false,
708
- "hiddenAliases": [],
709
- "id": "channel:list",
710
- "pluginAlias": "@knocklabs/cli",
711
- "pluginName": "@knocklabs/cli",
712
- "pluginType": "core",
713
- "strict": true,
714
- "summary": "Display all channels configured for the account.",
715
- "enableJsonFlag": true,
716
- "isESM": false,
717
- "relativePath": [
718
- "dist",
719
- "commands",
720
- "channel",
721
- "list.js"
722
- ]
723
- },
724
1321
  "commit:get": {
725
1322
  "aliases": [],
726
1323
  "args": {
@@ -943,20 +1540,86 @@
943
1540
  "pluginName": "@knocklabs/cli",
944
1541
  "pluginType": "core",
945
1542
  "strict": true,
946
- "summary": "Display all commits in an environment",
947
- "enableJsonFlag": true,
1543
+ "summary": "Display all commits in an environment",
1544
+ "enableJsonFlag": true,
1545
+ "isESM": false,
1546
+ "relativePath": [
1547
+ "dist",
1548
+ "commands",
1549
+ "commit",
1550
+ "list.js"
1551
+ ]
1552
+ },
1553
+ "commit:promote": {
1554
+ "aliases": [],
1555
+ "args": {},
1556
+ "flags": {
1557
+ "service-token": {
1558
+ "env": "KNOCK_SERVICE_TOKEN",
1559
+ "name": "service-token",
1560
+ "required": false,
1561
+ "summary": "The service token to authenticate with.",
1562
+ "hasDynamicHelp": false,
1563
+ "multiple": false,
1564
+ "type": "option"
1565
+ },
1566
+ "api-origin": {
1567
+ "hidden": true,
1568
+ "name": "api-origin",
1569
+ "required": false,
1570
+ "hasDynamicHelp": false,
1571
+ "multiple": false,
1572
+ "type": "option"
1573
+ },
1574
+ "to": {
1575
+ "name": "to",
1576
+ "summary": "The destination environment to promote all changes from the preceding environment.",
1577
+ "hasDynamicHelp": false,
1578
+ "multiple": false,
1579
+ "type": "option"
1580
+ },
1581
+ "force": {
1582
+ "name": "force",
1583
+ "summary": "Remove the confirmation prompt.",
1584
+ "allowNo": false,
1585
+ "type": "boolean"
1586
+ },
1587
+ "only": {
1588
+ "name": "only",
1589
+ "summary": "The target commit id to promote to the subsequent environment",
1590
+ "hasDynamicHelp": false,
1591
+ "multiple": false,
1592
+ "type": "option"
1593
+ }
1594
+ },
1595
+ "hasDynamicHelp": false,
1596
+ "hiddenAliases": [],
1597
+ "id": "commit:promote",
1598
+ "pluginAlias": "@knocklabs/cli",
1599
+ "pluginName": "@knocklabs/cli",
1600
+ "pluginType": "core",
1601
+ "strict": true,
1602
+ "summary": "Promote one or all commits to the subsequent environment.",
1603
+ "enableJsonFlag": false,
948
1604
  "isESM": false,
949
1605
  "relativePath": [
950
1606
  "dist",
951
1607
  "commands",
952
1608
  "commit",
953
- "list.js"
1609
+ "promote.js"
954
1610
  ]
955
1611
  },
956
- "commit:promote": {
1612
+ "channel:list": {
957
1613
  "aliases": [],
958
1614
  "args": {},
959
1615
  "flags": {
1616
+ "json": {
1617
+ "description": "Format output as json.",
1618
+ "helpGroup": "GLOBAL",
1619
+ "name": "json",
1620
+ "allowNo": false,
1621
+ "type": "boolean"
1622
+ },
960
1623
  "service-token": {
961
1624
  "env": "KNOCK_SERVICE_TOKEN",
962
1625
  "name": "service-token",
@@ -973,43 +1636,23 @@
973
1636
  "hasDynamicHelp": false,
974
1637
  "multiple": false,
975
1638
  "type": "option"
976
- },
977
- "to": {
978
- "name": "to",
979
- "summary": "The destination environment to promote all changes from the preceding environment.",
980
- "hasDynamicHelp": false,
981
- "multiple": false,
982
- "type": "option"
983
- },
984
- "force": {
985
- "name": "force",
986
- "summary": "Remove the confirmation prompt.",
987
- "allowNo": false,
988
- "type": "boolean"
989
- },
990
- "only": {
991
- "name": "only",
992
- "summary": "The target commit id to promote to the subsequent environment",
993
- "hasDynamicHelp": false,
994
- "multiple": false,
995
- "type": "option"
996
1639
  }
997
1640
  },
998
1641
  "hasDynamicHelp": false,
999
1642
  "hiddenAliases": [],
1000
- "id": "commit:promote",
1643
+ "id": "channel:list",
1001
1644
  "pluginAlias": "@knocklabs/cli",
1002
1645
  "pluginName": "@knocklabs/cli",
1003
1646
  "pluginType": "core",
1004
1647
  "strict": true,
1005
- "summary": "Promote one or all commits to the subsequent environment.",
1006
- "enableJsonFlag": false,
1648
+ "summary": "Display all channels configured for the account.",
1649
+ "enableJsonFlag": true,
1007
1650
  "isESM": false,
1008
1651
  "relativePath": [
1009
1652
  "dist",
1010
1653
  "commands",
1011
- "commit",
1012
- "promote.js"
1654
+ "channel",
1655
+ "list.js"
1013
1656
  ]
1014
1657
  },
1015
1658
  "environment:list": {
@@ -1480,6 +2123,65 @@
1480
2123
  "new.js"
1481
2124
  ]
1482
2125
  },
2126
+ "guide:open": {
2127
+ "aliases": [],
2128
+ "args": {
2129
+ "guideKey": {
2130
+ "name": "guideKey",
2131
+ "required": true
2132
+ }
2133
+ },
2134
+ "flags": {
2135
+ "service-token": {
2136
+ "env": "KNOCK_SERVICE_TOKEN",
2137
+ "name": "service-token",
2138
+ "required": false,
2139
+ "summary": "The service token to authenticate with.",
2140
+ "hasDynamicHelp": false,
2141
+ "multiple": false,
2142
+ "type": "option"
2143
+ },
2144
+ "api-origin": {
2145
+ "hidden": true,
2146
+ "name": "api-origin",
2147
+ "required": false,
2148
+ "hasDynamicHelp": false,
2149
+ "multiple": false,
2150
+ "type": "option"
2151
+ },
2152
+ "environment": {
2153
+ "name": "environment",
2154
+ "summary": "The environment to use.",
2155
+ "default": "development",
2156
+ "hasDynamicHelp": false,
2157
+ "multiple": false,
2158
+ "type": "option"
2159
+ },
2160
+ "branch": {
2161
+ "name": "branch",
2162
+ "summary": "The slug of the branch to use.",
2163
+ "hasDynamicHelp": false,
2164
+ "multiple": false,
2165
+ "type": "option"
2166
+ }
2167
+ },
2168
+ "hasDynamicHelp": false,
2169
+ "hiddenAliases": [],
2170
+ "id": "guide:open",
2171
+ "pluginAlias": "@knocklabs/cli",
2172
+ "pluginName": "@knocklabs/cli",
2173
+ "pluginType": "core",
2174
+ "strict": true,
2175
+ "summary": "Open a guide in the Knock dashboard.",
2176
+ "enableJsonFlag": false,
2177
+ "isESM": false,
2178
+ "relativePath": [
2179
+ "dist",
2180
+ "commands",
2181
+ "guide",
2182
+ "open.js"
2183
+ ]
2184
+ },
1483
2185
  "guide:pull": {
1484
2186
  "aliases": [],
1485
2187
  "args": {
@@ -1984,6 +2686,65 @@
1984
2686
  "new.js"
1985
2687
  ]
1986
2688
  },
2689
+ "layout:open": {
2690
+ "aliases": [],
2691
+ "args": {
2692
+ "layoutKey": {
2693
+ "name": "layoutKey",
2694
+ "required": true
2695
+ }
2696
+ },
2697
+ "flags": {
2698
+ "service-token": {
2699
+ "env": "KNOCK_SERVICE_TOKEN",
2700
+ "name": "service-token",
2701
+ "required": false,
2702
+ "summary": "The service token to authenticate with.",
2703
+ "hasDynamicHelp": false,
2704
+ "multiple": false,
2705
+ "type": "option"
2706
+ },
2707
+ "api-origin": {
2708
+ "hidden": true,
2709
+ "name": "api-origin",
2710
+ "required": false,
2711
+ "hasDynamicHelp": false,
2712
+ "multiple": false,
2713
+ "type": "option"
2714
+ },
2715
+ "environment": {
2716
+ "name": "environment",
2717
+ "summary": "The environment to use.",
2718
+ "default": "development",
2719
+ "hasDynamicHelp": false,
2720
+ "multiple": false,
2721
+ "type": "option"
2722
+ },
2723
+ "branch": {
2724
+ "name": "branch",
2725
+ "summary": "The slug of the branch to use.",
2726
+ "hasDynamicHelp": false,
2727
+ "multiple": false,
2728
+ "type": "option"
2729
+ }
2730
+ },
2731
+ "hasDynamicHelp": false,
2732
+ "hiddenAliases": [],
2733
+ "id": "layout:open",
2734
+ "pluginAlias": "@knocklabs/cli",
2735
+ "pluginName": "@knocklabs/cli",
2736
+ "pluginType": "core",
2737
+ "strict": true,
2738
+ "summary": "Open a layout in the Knock dashboard.",
2739
+ "enableJsonFlag": false,
2740
+ "isESM": false,
2741
+ "relativePath": [
2742
+ "dist",
2743
+ "commands",
2744
+ "layout",
2745
+ "open.js"
2746
+ ]
2747
+ },
1987
2748
  "layout:pull": {
1988
2749
  "aliases": [],
1989
2750
  "args": {
@@ -2253,11 +3014,11 @@
2253
3014
  "validate.js"
2254
3015
  ]
2255
3016
  },
2256
- "partial:get": {
3017
+ "message-type:get": {
2257
3018
  "aliases": [],
2258
3019
  "args": {
2259
- "partialKey": {
2260
- "name": "partialKey",
3020
+ "messageTypeKey": {
3021
+ "name": "messageTypeKey",
2261
3022
  "required": true
2262
3023
  }
2263
3024
  },
@@ -2310,22 +3071,22 @@
2310
3071
  },
2311
3072
  "hasDynamicHelp": false,
2312
3073
  "hiddenAliases": [],
2313
- "id": "partial:get",
3074
+ "id": "message-type:get",
2314
3075
  "pluginAlias": "@knocklabs/cli",
2315
3076
  "pluginName": "@knocklabs/cli",
2316
3077
  "pluginType": "core",
2317
3078
  "strict": true,
2318
- "summary": "Display a single partial from an environment.",
3079
+ "summary": "Display a single in-app message type from an environment.",
2319
3080
  "enableJsonFlag": true,
2320
3081
  "isESM": false,
2321
3082
  "relativePath": [
2322
3083
  "dist",
2323
3084
  "commands",
2324
- "partial",
3085
+ "message-type",
2325
3086
  "get.js"
2326
3087
  ]
2327
3088
  },
2328
- "partial:list": {
3089
+ "message-type:list": {
2329
3090
  "aliases": [],
2330
3091
  "args": {},
2331
3092
  "flags": {
@@ -2398,22 +3159,22 @@
2398
3159
  },
2399
3160
  "hasDynamicHelp": false,
2400
3161
  "hiddenAliases": [],
2401
- "id": "partial:list",
3162
+ "id": "message-type:list",
2402
3163
  "pluginAlias": "@knocklabs/cli",
2403
3164
  "pluginName": "@knocklabs/cli",
2404
3165
  "pluginType": "core",
2405
3166
  "strict": true,
2406
- "summary": "Display all partials for an environment.",
3167
+ "summary": "Display all in-app message types for an environment.",
2407
3168
  "enableJsonFlag": true,
2408
3169
  "isESM": false,
2409
3170
  "relativePath": [
2410
3171
  "dist",
2411
3172
  "commands",
2412
- "partial",
3173
+ "message-type",
2413
3174
  "list.js"
2414
3175
  ]
2415
3176
  },
2416
- "partial:new": {
3177
+ "message-type:new": {
2417
3178
  "aliases": [],
2418
3179
  "args": {},
2419
3180
  "flags": {
@@ -2437,7 +3198,7 @@
2437
3198
  "name": {
2438
3199
  "char": "n",
2439
3200
  "name": "name",
2440
- "summary": "The name of the partial",
3201
+ "summary": "The name of the message type",
2441
3202
  "hasDynamicHelp": false,
2442
3203
  "multiple": false,
2443
3204
  "type": "option"
@@ -2445,28 +3206,14 @@
2445
3206
  "key": {
2446
3207
  "char": "k",
2447
3208
  "name": "key",
2448
- "summary": "The key of the partial",
2449
- "hasDynamicHelp": false,
2450
- "multiple": false,
2451
- "type": "option"
2452
- },
2453
- "type": {
2454
- "char": "t",
2455
- "name": "type",
2456
- "summary": "The type of the partial (html, json, markdown, text). You cannot use this flag with --template.",
3209
+ "summary": "The key of the message type",
2457
3210
  "hasDynamicHelp": false,
2458
3211
  "multiple": false,
2459
- "options": [
2460
- "html",
2461
- "json",
2462
- "markdown",
2463
- "text"
2464
- ],
2465
3212
  "type": "option"
2466
3213
  },
2467
3214
  "environment": {
2468
3215
  "name": "environment",
2469
- "summary": "The environment to create the partial in. Defaults to development.",
3216
+ "summary": "The environment to create the message type in. Defaults to development.",
2470
3217
  "default": "development",
2471
3218
  "hasDynamicHelp": false,
2472
3219
  "multiple": false,
@@ -2481,20 +3228,79 @@
2481
3228
  },
2482
3229
  "force": {
2483
3230
  "name": "force",
2484
- "summary": "Force the creation of the partial directory without confirmation.",
3231
+ "summary": "Force the creation of the message type directory without confirmation.",
2485
3232
  "allowNo": false,
2486
3233
  "type": "boolean"
2487
3234
  },
2488
3235
  "push": {
2489
3236
  "char": "p",
2490
3237
  "name": "push",
2491
- "summary": "Whether or not to push the partial to Knock after creation.",
3238
+ "summary": "Whether or not to push the message type to Knock after creation.",
2492
3239
  "allowNo": false,
2493
3240
  "type": "boolean"
2494
3241
  },
2495
- "template": {
2496
- "name": "template",
2497
- "summary": "The template to use for the partial. Should be `partials/{key}`. You cannot use this flag with --type.",
3242
+ "template": {
3243
+ "name": "template",
3244
+ "summary": "The template to use for the message type. Should be `message-types/{key}`.",
3245
+ "hasDynamicHelp": false,
3246
+ "multiple": false,
3247
+ "type": "option"
3248
+ }
3249
+ },
3250
+ "hasDynamicHelp": false,
3251
+ "hiddenAliases": [],
3252
+ "id": "message-type:new",
3253
+ "pluginAlias": "@knocklabs/cli",
3254
+ "pluginName": "@knocklabs/cli",
3255
+ "pluginType": "core",
3256
+ "strict": true,
3257
+ "summary": "Create a new message type with a minimal configuration.",
3258
+ "enableJsonFlag": false,
3259
+ "isESM": false,
3260
+ "relativePath": [
3261
+ "dist",
3262
+ "commands",
3263
+ "message-type",
3264
+ "new.js"
3265
+ ]
3266
+ },
3267
+ "message-type:open": {
3268
+ "aliases": [],
3269
+ "args": {
3270
+ "messageTypeKey": {
3271
+ "name": "messageTypeKey",
3272
+ "required": true
3273
+ }
3274
+ },
3275
+ "flags": {
3276
+ "service-token": {
3277
+ "env": "KNOCK_SERVICE_TOKEN",
3278
+ "name": "service-token",
3279
+ "required": false,
3280
+ "summary": "The service token to authenticate with.",
3281
+ "hasDynamicHelp": false,
3282
+ "multiple": false,
3283
+ "type": "option"
3284
+ },
3285
+ "api-origin": {
3286
+ "hidden": true,
3287
+ "name": "api-origin",
3288
+ "required": false,
3289
+ "hasDynamicHelp": false,
3290
+ "multiple": false,
3291
+ "type": "option"
3292
+ },
3293
+ "environment": {
3294
+ "name": "environment",
3295
+ "summary": "The environment to use.",
3296
+ "default": "development",
3297
+ "hasDynamicHelp": false,
3298
+ "multiple": false,
3299
+ "type": "option"
3300
+ },
3301
+ "branch": {
3302
+ "name": "branch",
3303
+ "summary": "The slug of the branch to use.",
2498
3304
  "hasDynamicHelp": false,
2499
3305
  "multiple": false,
2500
3306
  "type": "option"
@@ -2502,26 +3308,26 @@
2502
3308
  },
2503
3309
  "hasDynamicHelp": false,
2504
3310
  "hiddenAliases": [],
2505
- "id": "partial:new",
3311
+ "id": "message-type:open",
2506
3312
  "pluginAlias": "@knocklabs/cli",
2507
3313
  "pluginName": "@knocklabs/cli",
2508
3314
  "pluginType": "core",
2509
3315
  "strict": true,
2510
- "summary": "Create a new partial with a minimal configuration.",
3316
+ "summary": "Open a message type in the Knock dashboard.",
2511
3317
  "enableJsonFlag": false,
2512
3318
  "isESM": false,
2513
3319
  "relativePath": [
2514
3320
  "dist",
2515
3321
  "commands",
2516
- "partial",
2517
- "new.js"
3322
+ "message-type",
3323
+ "open.js"
2518
3324
  ]
2519
3325
  },
2520
- "partial:pull": {
3326
+ "message-type:pull": {
2521
3327
  "aliases": [],
2522
3328
  "args": {
2523
- "partialKey": {
2524
- "name": "partialKey",
3329
+ "messageTypeKey": {
3330
+ "name": "messageTypeKey",
2525
3331
  "required": false
2526
3332
  }
2527
3333
  },
@@ -2560,16 +3366,16 @@
2560
3366
  },
2561
3367
  "all": {
2562
3368
  "name": "all",
2563
- "summary": "Whether to pull all partials from the specified environment.",
3369
+ "summary": "Whether to pull all in-app message types from the specified environment.",
2564
3370
  "allowNo": false,
2565
3371
  "type": "boolean"
2566
3372
  },
2567
- "partials-dir": {
3373
+ "message-types-dir": {
2568
3374
  "dependsOn": [
2569
3375
  "all"
2570
3376
  ],
2571
- "name": "partials-dir",
2572
- "summary": "The target directory path to pull all partials into.",
3377
+ "name": "message-types-dir",
3378
+ "summary": "The target directory path to pull all in-app message types into.",
2573
3379
  "hasDynamicHelp": false,
2574
3380
  "multiple": false,
2575
3381
  "type": "option"
@@ -2589,26 +3395,26 @@
2589
3395
  },
2590
3396
  "hasDynamicHelp": false,
2591
3397
  "hiddenAliases": [],
2592
- "id": "partial:pull",
3398
+ "id": "message-type:pull",
2593
3399
  "pluginAlias": "@knocklabs/cli",
2594
3400
  "pluginName": "@knocklabs/cli",
2595
3401
  "pluginType": "core",
2596
3402
  "strict": true,
2597
- "summary": "Pull one or more partial from an environment into a local file system.",
3403
+ "summary": "Pull one or more in-app message types from an environment into a local file system.",
2598
3404
  "enableJsonFlag": false,
2599
3405
  "isESM": false,
2600
3406
  "relativePath": [
2601
3407
  "dist",
2602
3408
  "commands",
2603
- "partial",
3409
+ "message-type",
2604
3410
  "pull.js"
2605
3411
  ]
2606
3412
  },
2607
- "partial:push": {
3413
+ "message-type:push": {
2608
3414
  "aliases": [],
2609
3415
  "args": {
2610
- "partialKey": {
2611
- "name": "partialKey",
3416
+ "messageTypeKey": {
3417
+ "name": "messageTypeKey",
2612
3418
  "required": false
2613
3419
  }
2614
3420
  },
@@ -2632,7 +3438,7 @@
2632
3438
  },
2633
3439
  "environment": {
2634
3440
  "name": "environment",
2635
- "summary": "Pushing a partial is only allowed in the development environment",
3441
+ "summary": "Pushing a message type is only allowed in the development environment",
2636
3442
  "default": "development",
2637
3443
  "hasDynamicHelp": false,
2638
3444
  "multiple": false,
@@ -2650,23 +3456,23 @@
2650
3456
  },
2651
3457
  "all": {
2652
3458
  "name": "all",
2653
- "summary": "Whether to push all partials from the target directory.",
3459
+ "summary": "Whether to push all message types from the target directory.",
2654
3460
  "allowNo": false,
2655
3461
  "type": "boolean"
2656
3462
  },
2657
- "partials-dir": {
3463
+ "message-types-dir": {
2658
3464
  "dependsOn": [
2659
3465
  "all"
2660
3466
  ],
2661
- "name": "partials-dir",
2662
- "summary": "The target directory path to find all partials to push.",
3467
+ "name": "message-types-dir",
3468
+ "summary": "The target directory path to find all message types to push.",
2663
3469
  "hasDynamicHelp": false,
2664
3470
  "multiple": false,
2665
3471
  "type": "option"
2666
3472
  },
2667
3473
  "commit": {
2668
3474
  "name": "commit",
2669
- "summary": "Push and commit the partial(s) at the same time",
3475
+ "summary": "Push and commit the message type(s) at the same time",
2670
3476
  "allowNo": false,
2671
3477
  "type": "boolean"
2672
3478
  },
@@ -2684,26 +3490,26 @@
2684
3490
  },
2685
3491
  "hasDynamicHelp": false,
2686
3492
  "hiddenAliases": [],
2687
- "id": "partial:push",
3493
+ "id": "message-type:push",
2688
3494
  "pluginAlias": "@knocklabs/cli",
2689
3495
  "pluginName": "@knocklabs/cli",
2690
3496
  "pluginType": "core",
2691
3497
  "strict": true,
2692
- "summary": "Push one or more partials from a local file system to Knock.",
3498
+ "summary": "Push one or more message types from a local file system to Knock.",
2693
3499
  "enableJsonFlag": false,
2694
3500
  "isESM": false,
2695
3501
  "relativePath": [
2696
3502
  "dist",
2697
3503
  "commands",
2698
- "partial",
3504
+ "message-type",
2699
3505
  "push.js"
2700
3506
  ]
2701
3507
  },
2702
- "partial:validate": {
3508
+ "message-type:validate": {
2703
3509
  "aliases": [],
2704
3510
  "args": {
2705
- "partialKey": {
2706
- "name": "partialKey",
3511
+ "messageTypeKey": {
3512
+ "name": "messageTypeKey",
2707
3513
  "required": false
2708
3514
  }
2709
3515
  },
@@ -2727,7 +3533,7 @@
2727
3533
  },
2728
3534
  "environment": {
2729
3535
  "name": "environment",
2730
- "summary": "Validating a partial is only done in the development environment",
3536
+ "summary": "Validating a message type is only done in the development environment",
2731
3537
  "default": "development",
2732
3538
  "hasDynamicHelp": false,
2733
3539
  "multiple": false,
@@ -2745,16 +3551,16 @@
2745
3551
  },
2746
3552
  "all": {
2747
3553
  "name": "all",
2748
- "summary": "Whether to validate all partials from the target directory.",
3554
+ "summary": "Whether to validate all message types from the target directory.",
2749
3555
  "allowNo": false,
2750
3556
  "type": "boolean"
2751
3557
  },
2752
- "partials-dir": {
3558
+ "message-types-dir": {
2753
3559
  "dependsOn": [
2754
3560
  "all"
2755
3561
  ],
2756
- "name": "partials-dir",
2757
- "summary": "The target directory path to find all partials to validate.",
3562
+ "name": "message-types-dir",
3563
+ "summary": "The target directory path to find all message types to validate.",
2758
3564
  "hasDynamicHelp": false,
2759
3565
  "multiple": false,
2760
3566
  "type": "option"
@@ -2762,27 +3568,26 @@
2762
3568
  },
2763
3569
  "hasDynamicHelp": false,
2764
3570
  "hiddenAliases": [],
2765
- "id": "partial:validate",
3571
+ "id": "message-type:validate",
2766
3572
  "pluginAlias": "@knocklabs/cli",
2767
3573
  "pluginName": "@knocklabs/cli",
2768
3574
  "pluginType": "core",
2769
3575
  "strict": true,
2770
- "summary": "Validate one or more partials from a local file system.",
3576
+ "summary": "Validate one or more message types from a local file system.",
2771
3577
  "enableJsonFlag": false,
2772
3578
  "isESM": false,
2773
3579
  "relativePath": [
2774
3580
  "dist",
2775
3581
  "commands",
2776
- "partial",
3582
+ "message-type",
2777
3583
  "validate.js"
2778
3584
  ]
2779
3585
  },
2780
- "translation:get": {
3586
+ "partial:get": {
2781
3587
  "aliases": [],
2782
3588
  "args": {
2783
- "translationRef": {
2784
- "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
2785
- "name": "translationRef",
3589
+ "partialKey": {
3590
+ "name": "partialKey",
2786
3591
  "required": true
2787
3592
  }
2788
3593
  },
@@ -2803,17 +3608,195 @@
2803
3608
  "multiple": false,
2804
3609
  "type": "option"
2805
3610
  },
2806
- "api-origin": {
2807
- "hidden": true,
2808
- "name": "api-origin",
2809
- "required": false,
3611
+ "api-origin": {
3612
+ "hidden": true,
3613
+ "name": "api-origin",
3614
+ "required": false,
3615
+ "hasDynamicHelp": false,
3616
+ "multiple": false,
3617
+ "type": "option"
3618
+ },
3619
+ "environment": {
3620
+ "name": "environment",
3621
+ "summary": "The environment to use.",
3622
+ "default": "development",
3623
+ "hasDynamicHelp": false,
3624
+ "multiple": false,
3625
+ "type": "option"
3626
+ },
3627
+ "branch": {
3628
+ "name": "branch",
3629
+ "summary": "The slug of the branch to use.",
3630
+ "hasDynamicHelp": false,
3631
+ "multiple": false,
3632
+ "type": "option"
3633
+ },
3634
+ "hide-uncommitted-changes": {
3635
+ "name": "hide-uncommitted-changes",
3636
+ "summary": "Hide any uncommitted changes.",
3637
+ "allowNo": false,
3638
+ "type": "boolean"
3639
+ }
3640
+ },
3641
+ "hasDynamicHelp": false,
3642
+ "hiddenAliases": [],
3643
+ "id": "partial:get",
3644
+ "pluginAlias": "@knocklabs/cli",
3645
+ "pluginName": "@knocklabs/cli",
3646
+ "pluginType": "core",
3647
+ "strict": true,
3648
+ "summary": "Display a single partial from an environment.",
3649
+ "enableJsonFlag": true,
3650
+ "isESM": false,
3651
+ "relativePath": [
3652
+ "dist",
3653
+ "commands",
3654
+ "partial",
3655
+ "get.js"
3656
+ ]
3657
+ },
3658
+ "partial:list": {
3659
+ "aliases": [],
3660
+ "args": {},
3661
+ "flags": {
3662
+ "json": {
3663
+ "description": "Format output as json.",
3664
+ "helpGroup": "GLOBAL",
3665
+ "name": "json",
3666
+ "allowNo": false,
3667
+ "type": "boolean"
3668
+ },
3669
+ "service-token": {
3670
+ "env": "KNOCK_SERVICE_TOKEN",
3671
+ "name": "service-token",
3672
+ "required": false,
3673
+ "summary": "The service token to authenticate with.",
3674
+ "hasDynamicHelp": false,
3675
+ "multiple": false,
3676
+ "type": "option"
3677
+ },
3678
+ "api-origin": {
3679
+ "hidden": true,
3680
+ "name": "api-origin",
3681
+ "required": false,
3682
+ "hasDynamicHelp": false,
3683
+ "multiple": false,
3684
+ "type": "option"
3685
+ },
3686
+ "environment": {
3687
+ "name": "environment",
3688
+ "summary": "The environment to use.",
3689
+ "default": "development",
3690
+ "hasDynamicHelp": false,
3691
+ "multiple": false,
3692
+ "type": "option"
3693
+ },
3694
+ "branch": {
3695
+ "name": "branch",
3696
+ "summary": "The slug of the branch to use.",
3697
+ "hasDynamicHelp": false,
3698
+ "multiple": false,
3699
+ "type": "option"
3700
+ },
3701
+ "hide-uncommitted-changes": {
3702
+ "name": "hide-uncommitted-changes",
3703
+ "summary": "Hide any uncommitted changes.",
3704
+ "allowNo": false,
3705
+ "type": "boolean"
3706
+ },
3707
+ "after": {
3708
+ "name": "after",
3709
+ "summary": "The cursor after which to fetch the next page.",
3710
+ "hasDynamicHelp": false,
3711
+ "multiple": false,
3712
+ "type": "option"
3713
+ },
3714
+ "before": {
3715
+ "name": "before",
3716
+ "summary": "The cursor before which to fetch the previous page.",
3717
+ "hasDynamicHelp": false,
3718
+ "multiple": false,
3719
+ "type": "option"
3720
+ },
3721
+ "limit": {
3722
+ "name": "limit",
3723
+ "summary": "The total number of entries to fetch per page.",
3724
+ "hasDynamicHelp": false,
3725
+ "multiple": false,
3726
+ "type": "option"
3727
+ }
3728
+ },
3729
+ "hasDynamicHelp": false,
3730
+ "hiddenAliases": [],
3731
+ "id": "partial:list",
3732
+ "pluginAlias": "@knocklabs/cli",
3733
+ "pluginName": "@knocklabs/cli",
3734
+ "pluginType": "core",
3735
+ "strict": true,
3736
+ "summary": "Display all partials for an environment.",
3737
+ "enableJsonFlag": true,
3738
+ "isESM": false,
3739
+ "relativePath": [
3740
+ "dist",
3741
+ "commands",
3742
+ "partial",
3743
+ "list.js"
3744
+ ]
3745
+ },
3746
+ "partial:new": {
3747
+ "aliases": [],
3748
+ "args": {},
3749
+ "flags": {
3750
+ "service-token": {
3751
+ "env": "KNOCK_SERVICE_TOKEN",
3752
+ "name": "service-token",
3753
+ "required": false,
3754
+ "summary": "The service token to authenticate with.",
3755
+ "hasDynamicHelp": false,
3756
+ "multiple": false,
3757
+ "type": "option"
3758
+ },
3759
+ "api-origin": {
3760
+ "hidden": true,
3761
+ "name": "api-origin",
3762
+ "required": false,
3763
+ "hasDynamicHelp": false,
3764
+ "multiple": false,
3765
+ "type": "option"
3766
+ },
3767
+ "name": {
3768
+ "char": "n",
3769
+ "name": "name",
3770
+ "summary": "The name of the partial",
3771
+ "hasDynamicHelp": false,
3772
+ "multiple": false,
3773
+ "type": "option"
3774
+ },
3775
+ "key": {
3776
+ "char": "k",
3777
+ "name": "key",
3778
+ "summary": "The key of the partial",
3779
+ "hasDynamicHelp": false,
3780
+ "multiple": false,
3781
+ "type": "option"
3782
+ },
3783
+ "type": {
3784
+ "char": "t",
3785
+ "name": "type",
3786
+ "summary": "The type of the partial (html, json, markdown, text). You cannot use this flag with --template.",
2810
3787
  "hasDynamicHelp": false,
2811
3788
  "multiple": false,
3789
+ "options": [
3790
+ "html",
3791
+ "json",
3792
+ "markdown",
3793
+ "text"
3794
+ ],
2812
3795
  "type": "option"
2813
3796
  },
2814
3797
  "environment": {
2815
3798
  "name": "environment",
2816
- "summary": "The environment to use.",
3799
+ "summary": "The environment to create the partial in. Defaults to development.",
2817
3800
  "default": "development",
2818
3801
  "hasDynamicHelp": false,
2819
3802
  "multiple": false,
@@ -2826,54 +3809,53 @@
2826
3809
  "multiple": false,
2827
3810
  "type": "option"
2828
3811
  },
2829
- "hide-uncommitted-changes": {
2830
- "name": "hide-uncommitted-changes",
2831
- "summary": "Hide any uncommitted changes.",
3812
+ "force": {
3813
+ "name": "force",
3814
+ "summary": "Force the creation of the partial directory without confirmation.",
2832
3815
  "allowNo": false,
2833
3816
  "type": "boolean"
2834
3817
  },
2835
- "format": {
2836
- "name": "format",
2837
- "summary": "Specify the output format of the returned translations.",
2838
- "default": "json",
3818
+ "push": {
3819
+ "char": "p",
3820
+ "name": "push",
3821
+ "summary": "Whether or not to push the partial to Knock after creation.",
3822
+ "allowNo": false,
3823
+ "type": "boolean"
3824
+ },
3825
+ "template": {
3826
+ "name": "template",
3827
+ "summary": "The template to use for the partial. Should be `partials/{key}`. You cannot use this flag with --type.",
2839
3828
  "hasDynamicHelp": false,
2840
3829
  "multiple": false,
2841
- "options": [
2842
- "json",
2843
- "po"
2844
- ],
2845
3830
  "type": "option"
2846
3831
  }
2847
3832
  },
2848
3833
  "hasDynamicHelp": false,
2849
3834
  "hiddenAliases": [],
2850
- "id": "translation:get",
3835
+ "id": "partial:new",
2851
3836
  "pluginAlias": "@knocklabs/cli",
2852
3837
  "pluginName": "@knocklabs/cli",
2853
3838
  "pluginType": "core",
2854
3839
  "strict": true,
2855
- "summary": "Display a single translation from an environment.",
2856
- "enableJsonFlag": true,
2857
- "verifyFeatureEnabled": "translations",
3840
+ "summary": "Create a new partial with a minimal configuration.",
3841
+ "enableJsonFlag": false,
2858
3842
  "isESM": false,
2859
3843
  "relativePath": [
2860
3844
  "dist",
2861
3845
  "commands",
2862
- "translation",
2863
- "get.js"
3846
+ "partial",
3847
+ "new.js"
2864
3848
  ]
2865
3849
  },
2866
- "translation:list": {
3850
+ "partial:open": {
2867
3851
  "aliases": [],
2868
- "args": {},
3852
+ "args": {
3853
+ "partialKey": {
3854
+ "name": "partialKey",
3855
+ "required": true
3856
+ }
3857
+ },
2869
3858
  "flags": {
2870
- "json": {
2871
- "description": "Format output as json.",
2872
- "helpGroup": "GLOBAL",
2873
- "name": "json",
2874
- "allowNo": false,
2875
- "type": "boolean"
2876
- },
2877
3859
  "service-token": {
2878
3860
  "env": "KNOCK_SERVICE_TOKEN",
2879
3861
  "name": "service-token",
@@ -2905,59 +3887,30 @@
2905
3887
  "hasDynamicHelp": false,
2906
3888
  "multiple": false,
2907
3889
  "type": "option"
2908
- },
2909
- "hide-uncommitted-changes": {
2910
- "name": "hide-uncommitted-changes",
2911
- "summary": "Hide any uncommitted changes.",
2912
- "allowNo": false,
2913
- "type": "boolean"
2914
- },
2915
- "after": {
2916
- "name": "after",
2917
- "summary": "The cursor after which to fetch the next page.",
2918
- "hasDynamicHelp": false,
2919
- "multiple": false,
2920
- "type": "option"
2921
- },
2922
- "before": {
2923
- "name": "before",
2924
- "summary": "The cursor before which to fetch the previous page.",
2925
- "hasDynamicHelp": false,
2926
- "multiple": false,
2927
- "type": "option"
2928
- },
2929
- "limit": {
2930
- "name": "limit",
2931
- "summary": "The total number of entries to fetch per page.",
2932
- "hasDynamicHelp": false,
2933
- "multiple": false,
2934
- "type": "option"
2935
3890
  }
2936
3891
  },
2937
3892
  "hasDynamicHelp": false,
2938
3893
  "hiddenAliases": [],
2939
- "id": "translation:list",
3894
+ "id": "partial:open",
2940
3895
  "pluginAlias": "@knocklabs/cli",
2941
3896
  "pluginName": "@knocklabs/cli",
2942
3897
  "pluginType": "core",
2943
3898
  "strict": true,
2944
- "summary": "Display all translations for an environment.",
2945
- "enableJsonFlag": true,
2946
- "verifyFeatureEnabled": "translations",
3899
+ "summary": "Open a partial in the Knock dashboard.",
3900
+ "enableJsonFlag": false,
2947
3901
  "isESM": false,
2948
3902
  "relativePath": [
2949
3903
  "dist",
2950
3904
  "commands",
2951
- "translation",
2952
- "list.js"
3905
+ "partial",
3906
+ "open.js"
2953
3907
  ]
2954
3908
  },
2955
- "translation:pull": {
3909
+ "partial:pull": {
2956
3910
  "aliases": [],
2957
3911
  "args": {
2958
- "translationRef": {
2959
- "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
2960
- "name": "translationRef",
3912
+ "partialKey": {
3913
+ "name": "partialKey",
2961
3914
  "required": false
2962
3915
  }
2963
3916
  },
@@ -2996,16 +3949,16 @@
2996
3949
  },
2997
3950
  "all": {
2998
3951
  "name": "all",
2999
- "summary": "Whether to pull all translations from the specified environment.",
3952
+ "summary": "Whether to pull all partials from the specified environment.",
3000
3953
  "allowNo": false,
3001
3954
  "type": "boolean"
3002
3955
  },
3003
- "translations-dir": {
3956
+ "partials-dir": {
3004
3957
  "dependsOn": [
3005
3958
  "all"
3006
3959
  ],
3007
- "name": "translations-dir",
3008
- "summary": "The target directory path to pull all translations into.",
3960
+ "name": "partials-dir",
3961
+ "summary": "The target directory path to pull all partials into.",
3009
3962
  "hasDynamicHelp": false,
3010
3963
  "multiple": false,
3011
3964
  "type": "option"
@@ -3021,44 +3974,30 @@
3021
3974
  "summary": "Remove the confirmation prompt.",
3022
3975
  "allowNo": false,
3023
3976
  "type": "boolean"
3024
- },
3025
- "format": {
3026
- "name": "format",
3027
- "summary": "Specify the output format of the returned translations.",
3028
- "default": "json",
3029
- "hasDynamicHelp": false,
3030
- "multiple": false,
3031
- "options": [
3032
- "json",
3033
- "po"
3034
- ],
3035
- "type": "option"
3036
3977
  }
3037
3978
  },
3038
3979
  "hasDynamicHelp": false,
3039
3980
  "hiddenAliases": [],
3040
- "id": "translation:pull",
3981
+ "id": "partial:pull",
3041
3982
  "pluginAlias": "@knocklabs/cli",
3042
3983
  "pluginName": "@knocklabs/cli",
3043
3984
  "pluginType": "core",
3044
3985
  "strict": true,
3045
- "summary": "Pull one or more translations from an environment into a local file system.",
3986
+ "summary": "Pull one or more partial from an environment into a local file system.",
3046
3987
  "enableJsonFlag": false,
3047
- "verifyFeatureEnabled": "translations",
3048
3988
  "isESM": false,
3049
3989
  "relativePath": [
3050
3990
  "dist",
3051
3991
  "commands",
3052
- "translation",
3992
+ "partial",
3053
3993
  "pull.js"
3054
3994
  ]
3055
3995
  },
3056
- "translation:push": {
3996
+ "partial:push": {
3057
3997
  "aliases": [],
3058
3998
  "args": {
3059
- "translationRef": {
3060
- "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
3061
- "name": "translationRef",
3999
+ "partialKey": {
4000
+ "name": "partialKey",
3062
4001
  "required": false
3063
4002
  }
3064
4003
  },
@@ -3082,7 +4021,7 @@
3082
4021
  },
3083
4022
  "environment": {
3084
4023
  "name": "environment",
3085
- "summary": "Pushing a translation is only allowed in the development environment",
4024
+ "summary": "Pushing a partial is only allowed in the development environment",
3086
4025
  "default": "development",
3087
4026
  "hasDynamicHelp": false,
3088
4027
  "multiple": false,
@@ -3100,23 +4039,23 @@
3100
4039
  },
3101
4040
  "all": {
3102
4041
  "name": "all",
3103
- "summary": "Whether to push all translations from the target directory.",
4042
+ "summary": "Whether to push all partials from the target directory.",
3104
4043
  "allowNo": false,
3105
4044
  "type": "boolean"
3106
4045
  },
3107
- "translations-dir": {
4046
+ "partials-dir": {
3108
4047
  "dependsOn": [
3109
4048
  "all"
3110
4049
  ],
3111
- "name": "translations-dir",
3112
- "summary": "The target directory path to find all translations to push.",
4050
+ "name": "partials-dir",
4051
+ "summary": "The target directory path to find all partials to push.",
3113
4052
  "hasDynamicHelp": false,
3114
4053
  "multiple": false,
3115
4054
  "type": "option"
3116
4055
  },
3117
4056
  "commit": {
3118
4057
  "name": "commit",
3119
- "summary": "Push and commit the translation(s) at the same time",
4058
+ "summary": "Push and commit the partial(s) at the same time",
3120
4059
  "allowNo": false,
3121
4060
  "type": "boolean"
3122
4061
  },
@@ -3134,28 +4073,26 @@
3134
4073
  },
3135
4074
  "hasDynamicHelp": false,
3136
4075
  "hiddenAliases": [],
3137
- "id": "translation:push",
4076
+ "id": "partial:push",
3138
4077
  "pluginAlias": "@knocklabs/cli",
3139
4078
  "pluginName": "@knocklabs/cli",
3140
4079
  "pluginType": "core",
3141
4080
  "strict": true,
3142
- "summary": "Push one or more translations from a local file system to Knock.",
4081
+ "summary": "Push one or more partials from a local file system to Knock.",
3143
4082
  "enableJsonFlag": false,
3144
- "verifyFeatureEnabled": "translations",
3145
4083
  "isESM": false,
3146
4084
  "relativePath": [
3147
4085
  "dist",
3148
4086
  "commands",
3149
- "translation",
4087
+ "partial",
3150
4088
  "push.js"
3151
4089
  ]
3152
4090
  },
3153
- "translation:validate": {
4091
+ "partial:validate": {
3154
4092
  "aliases": [],
3155
4093
  "args": {
3156
- "translationRef": {
3157
- "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
3158
- "name": "translationRef",
4094
+ "partialKey": {
4095
+ "name": "partialKey",
3159
4096
  "required": false
3160
4097
  }
3161
4098
  },
@@ -3179,7 +4116,7 @@
3179
4116
  },
3180
4117
  "environment": {
3181
4118
  "name": "environment",
3182
- "summary": "Validating a translation is only done in the development environment",
4119
+ "summary": "Validating a partial is only done in the development environment",
3183
4120
  "default": "development",
3184
4121
  "hasDynamicHelp": false,
3185
4122
  "multiple": false,
@@ -3197,16 +4134,16 @@
3197
4134
  },
3198
4135
  "all": {
3199
4136
  "name": "all",
3200
- "summary": "Whether to validate all translations from the target directory.",
4137
+ "summary": "Whether to validate all partials from the target directory.",
3201
4138
  "allowNo": false,
3202
4139
  "type": "boolean"
3203
4140
  },
3204
- "translations-dir": {
4141
+ "partials-dir": {
3205
4142
  "dependsOn": [
3206
4143
  "all"
3207
4144
  ],
3208
- "name": "translations-dir",
3209
- "summary": "The target directory path to find all translations to validate.",
4145
+ "name": "partials-dir",
4146
+ "summary": "The target directory path to find all partials to validate.",
3210
4147
  "hasDynamicHelp": false,
3211
4148
  "multiple": false,
3212
4149
  "type": "option"
@@ -3214,97 +4151,30 @@
3214
4151
  },
3215
4152
  "hasDynamicHelp": false,
3216
4153
  "hiddenAliases": [],
3217
- "id": "translation:validate",
4154
+ "id": "partial:validate",
3218
4155
  "pluginAlias": "@knocklabs/cli",
3219
4156
  "pluginName": "@knocklabs/cli",
3220
4157
  "pluginType": "core",
3221
4158
  "strict": true,
3222
- "summary": "Validate one or more translations from a local file system.",
4159
+ "summary": "Validate one or more partials from a local file system.",
3223
4160
  "enableJsonFlag": false,
3224
- "verifyFeatureEnabled": "translations",
3225
- "isESM": false,
3226
- "relativePath": [
3227
- "dist",
3228
- "commands",
3229
- "translation",
3230
- "validate.js"
3231
- ]
3232
- },
3233
- "message-type:get": {
3234
- "aliases": [],
3235
- "args": {
3236
- "messageTypeKey": {
3237
- "name": "messageTypeKey",
3238
- "required": true
3239
- }
3240
- },
3241
- "flags": {
3242
- "json": {
3243
- "description": "Format output as json.",
3244
- "helpGroup": "GLOBAL",
3245
- "name": "json",
3246
- "allowNo": false,
3247
- "type": "boolean"
3248
- },
3249
- "service-token": {
3250
- "env": "KNOCK_SERVICE_TOKEN",
3251
- "name": "service-token",
3252
- "required": false,
3253
- "summary": "The service token to authenticate with.",
3254
- "hasDynamicHelp": false,
3255
- "multiple": false,
3256
- "type": "option"
3257
- },
3258
- "api-origin": {
3259
- "hidden": true,
3260
- "name": "api-origin",
3261
- "required": false,
3262
- "hasDynamicHelp": false,
3263
- "multiple": false,
3264
- "type": "option"
3265
- },
3266
- "environment": {
3267
- "name": "environment",
3268
- "summary": "The environment to use.",
3269
- "default": "development",
3270
- "hasDynamicHelp": false,
3271
- "multiple": false,
3272
- "type": "option"
3273
- },
3274
- "branch": {
3275
- "name": "branch",
3276
- "summary": "The slug of the branch to use.",
3277
- "hasDynamicHelp": false,
3278
- "multiple": false,
3279
- "type": "option"
3280
- },
3281
- "hide-uncommitted-changes": {
3282
- "name": "hide-uncommitted-changes",
3283
- "summary": "Hide any uncommitted changes.",
3284
- "allowNo": false,
3285
- "type": "boolean"
3286
- }
3287
- },
3288
- "hasDynamicHelp": false,
3289
- "hiddenAliases": [],
3290
- "id": "message-type:get",
3291
- "pluginAlias": "@knocklabs/cli",
3292
- "pluginName": "@knocklabs/cli",
3293
- "pluginType": "core",
3294
- "strict": true,
3295
- "summary": "Display a single in-app message type from an environment.",
3296
- "enableJsonFlag": true,
3297
4161
  "isESM": false,
3298
4162
  "relativePath": [
3299
4163
  "dist",
3300
4164
  "commands",
3301
- "message-type",
3302
- "get.js"
4165
+ "partial",
4166
+ "validate.js"
3303
4167
  ]
3304
4168
  },
3305
- "message-type:list": {
4169
+ "translation:get": {
3306
4170
  "aliases": [],
3307
- "args": {},
4171
+ "args": {
4172
+ "translationRef": {
4173
+ "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
4174
+ "name": "translationRef",
4175
+ "required": true
4176
+ }
4177
+ },
3308
4178
  "flags": {
3309
4179
  "json": {
3310
4180
  "description": "Format output as json.",
@@ -3351,49 +4221,48 @@
3351
4221
  "allowNo": false,
3352
4222
  "type": "boolean"
3353
4223
  },
3354
- "after": {
3355
- "name": "after",
3356
- "summary": "The cursor after which to fetch the next page.",
3357
- "hasDynamicHelp": false,
3358
- "multiple": false,
3359
- "type": "option"
3360
- },
3361
- "before": {
3362
- "name": "before",
3363
- "summary": "The cursor before which to fetch the previous page.",
3364
- "hasDynamicHelp": false,
3365
- "multiple": false,
3366
- "type": "option"
3367
- },
3368
- "limit": {
3369
- "name": "limit",
3370
- "summary": "The total number of entries to fetch per page.",
4224
+ "format": {
4225
+ "name": "format",
4226
+ "summary": "Specify the output format of the returned translations.",
4227
+ "default": "json",
3371
4228
  "hasDynamicHelp": false,
3372
4229
  "multiple": false,
4230
+ "options": [
4231
+ "json",
4232
+ "po"
4233
+ ],
3373
4234
  "type": "option"
3374
4235
  }
3375
4236
  },
3376
4237
  "hasDynamicHelp": false,
3377
4238
  "hiddenAliases": [],
3378
- "id": "message-type:list",
4239
+ "id": "translation:get",
3379
4240
  "pluginAlias": "@knocklabs/cli",
3380
4241
  "pluginName": "@knocklabs/cli",
3381
4242
  "pluginType": "core",
3382
4243
  "strict": true,
3383
- "summary": "Display all in-app message types for an environment.",
4244
+ "summary": "Display a single translation from an environment.",
3384
4245
  "enableJsonFlag": true,
4246
+ "verifyFeatureEnabled": "translations",
3385
4247
  "isESM": false,
3386
4248
  "relativePath": [
3387
4249
  "dist",
3388
4250
  "commands",
3389
- "message-type",
3390
- "list.js"
4251
+ "translation",
4252
+ "get.js"
3391
4253
  ]
3392
4254
  },
3393
- "message-type:new": {
4255
+ "translation:list": {
3394
4256
  "aliases": [],
3395
4257
  "args": {},
3396
4258
  "flags": {
4259
+ "json": {
4260
+ "description": "Format output as json.",
4261
+ "helpGroup": "GLOBAL",
4262
+ "name": "json",
4263
+ "allowNo": false,
4264
+ "type": "boolean"
4265
+ },
3397
4266
  "service-token": {
3398
4267
  "env": "KNOCK_SERVICE_TOKEN",
3399
4268
  "name": "service-token",
@@ -3411,25 +4280,9 @@
3411
4280
  "multiple": false,
3412
4281
  "type": "option"
3413
4282
  },
3414
- "name": {
3415
- "char": "n",
3416
- "name": "name",
3417
- "summary": "The name of the message type",
3418
- "hasDynamicHelp": false,
3419
- "multiple": false,
3420
- "type": "option"
3421
- },
3422
- "key": {
3423
- "char": "k",
3424
- "name": "key",
3425
- "summary": "The key of the message type",
3426
- "hasDynamicHelp": false,
3427
- "multiple": false,
3428
- "type": "option"
3429
- },
3430
4283
  "environment": {
3431
4284
  "name": "environment",
3432
- "summary": "The environment to create the message type in. Defaults to development.",
4285
+ "summary": "The environment to use.",
3433
4286
  "default": "development",
3434
4287
  "hasDynamicHelp": false,
3435
4288
  "multiple": false,
@@ -3442,22 +4295,29 @@
3442
4295
  "multiple": false,
3443
4296
  "type": "option"
3444
4297
  },
3445
- "force": {
3446
- "name": "force",
3447
- "summary": "Force the creation of the message type directory without confirmation.",
4298
+ "hide-uncommitted-changes": {
4299
+ "name": "hide-uncommitted-changes",
4300
+ "summary": "Hide any uncommitted changes.",
3448
4301
  "allowNo": false,
3449
4302
  "type": "boolean"
3450
4303
  },
3451
- "push": {
3452
- "char": "p",
3453
- "name": "push",
3454
- "summary": "Whether or not to push the message type to Knock after creation.",
3455
- "allowNo": false,
3456
- "type": "boolean"
4304
+ "after": {
4305
+ "name": "after",
4306
+ "summary": "The cursor after which to fetch the next page.",
4307
+ "hasDynamicHelp": false,
4308
+ "multiple": false,
4309
+ "type": "option"
3457
4310
  },
3458
- "template": {
3459
- "name": "template",
3460
- "summary": "The template to use for the message type. Should be `message-types/{key}`.",
4311
+ "before": {
4312
+ "name": "before",
4313
+ "summary": "The cursor before which to fetch the previous page.",
4314
+ "hasDynamicHelp": false,
4315
+ "multiple": false,
4316
+ "type": "option"
4317
+ },
4318
+ "limit": {
4319
+ "name": "limit",
4320
+ "summary": "The total number of entries to fetch per page.",
3461
4321
  "hasDynamicHelp": false,
3462
4322
  "multiple": false,
3463
4323
  "type": "option"
@@ -3465,26 +4325,28 @@
3465
4325
  },
3466
4326
  "hasDynamicHelp": false,
3467
4327
  "hiddenAliases": [],
3468
- "id": "message-type:new",
4328
+ "id": "translation:list",
3469
4329
  "pluginAlias": "@knocklabs/cli",
3470
4330
  "pluginName": "@knocklabs/cli",
3471
4331
  "pluginType": "core",
3472
4332
  "strict": true,
3473
- "summary": "Create a new message type with a minimal configuration.",
3474
- "enableJsonFlag": false,
4333
+ "summary": "Display all translations for an environment.",
4334
+ "enableJsonFlag": true,
4335
+ "verifyFeatureEnabled": "translations",
3475
4336
  "isESM": false,
3476
4337
  "relativePath": [
3477
4338
  "dist",
3478
4339
  "commands",
3479
- "message-type",
3480
- "new.js"
4340
+ "translation",
4341
+ "list.js"
3481
4342
  ]
3482
4343
  },
3483
- "message-type:pull": {
4344
+ "translation:pull": {
3484
4345
  "aliases": [],
3485
4346
  "args": {
3486
- "messageTypeKey": {
3487
- "name": "messageTypeKey",
4347
+ "translationRef": {
4348
+ "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
4349
+ "name": "translationRef",
3488
4350
  "required": false
3489
4351
  }
3490
4352
  },
@@ -3523,16 +4385,16 @@
3523
4385
  },
3524
4386
  "all": {
3525
4387
  "name": "all",
3526
- "summary": "Whether to pull all in-app message types from the specified environment.",
4388
+ "summary": "Whether to pull all translations from the specified environment.",
3527
4389
  "allowNo": false,
3528
4390
  "type": "boolean"
3529
4391
  },
3530
- "message-types-dir": {
4392
+ "translations-dir": {
3531
4393
  "dependsOn": [
3532
4394
  "all"
3533
4395
  ],
3534
- "name": "message-types-dir",
3535
- "summary": "The target directory path to pull all in-app message types into.",
4396
+ "name": "translations-dir",
4397
+ "summary": "The target directory path to pull all translations into.",
3536
4398
  "hasDynamicHelp": false,
3537
4399
  "multiple": false,
3538
4400
  "type": "option"
@@ -3548,30 +4410,44 @@
3548
4410
  "summary": "Remove the confirmation prompt.",
3549
4411
  "allowNo": false,
3550
4412
  "type": "boolean"
4413
+ },
4414
+ "format": {
4415
+ "name": "format",
4416
+ "summary": "Specify the output format of the returned translations.",
4417
+ "default": "json",
4418
+ "hasDynamicHelp": false,
4419
+ "multiple": false,
4420
+ "options": [
4421
+ "json",
4422
+ "po"
4423
+ ],
4424
+ "type": "option"
3551
4425
  }
3552
4426
  },
3553
4427
  "hasDynamicHelp": false,
3554
4428
  "hiddenAliases": [],
3555
- "id": "message-type:pull",
4429
+ "id": "translation:pull",
3556
4430
  "pluginAlias": "@knocklabs/cli",
3557
4431
  "pluginName": "@knocklabs/cli",
3558
4432
  "pluginType": "core",
3559
4433
  "strict": true,
3560
- "summary": "Pull one or more in-app message types from an environment into a local file system.",
4434
+ "summary": "Pull one or more translations from an environment into a local file system.",
3561
4435
  "enableJsonFlag": false,
4436
+ "verifyFeatureEnabled": "translations",
3562
4437
  "isESM": false,
3563
4438
  "relativePath": [
3564
4439
  "dist",
3565
4440
  "commands",
3566
- "message-type",
4441
+ "translation",
3567
4442
  "pull.js"
3568
4443
  ]
3569
4444
  },
3570
- "message-type:push": {
4445
+ "translation:push": {
3571
4446
  "aliases": [],
3572
4447
  "args": {
3573
- "messageTypeKey": {
3574
- "name": "messageTypeKey",
4448
+ "translationRef": {
4449
+ "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
4450
+ "name": "translationRef",
3575
4451
  "required": false
3576
4452
  }
3577
4453
  },
@@ -3595,7 +4471,7 @@
3595
4471
  },
3596
4472
  "environment": {
3597
4473
  "name": "environment",
3598
- "summary": "Pushing a message type is only allowed in the development environment",
4474
+ "summary": "Pushing a translation is only allowed in the development environment",
3599
4475
  "default": "development",
3600
4476
  "hasDynamicHelp": false,
3601
4477
  "multiple": false,
@@ -3613,23 +4489,23 @@
3613
4489
  },
3614
4490
  "all": {
3615
4491
  "name": "all",
3616
- "summary": "Whether to push all message types from the target directory.",
4492
+ "summary": "Whether to push all translations from the target directory.",
3617
4493
  "allowNo": false,
3618
4494
  "type": "boolean"
3619
4495
  },
3620
- "message-types-dir": {
4496
+ "translations-dir": {
3621
4497
  "dependsOn": [
3622
4498
  "all"
3623
4499
  ],
3624
- "name": "message-types-dir",
3625
- "summary": "The target directory path to find all message types to push.",
4500
+ "name": "translations-dir",
4501
+ "summary": "The target directory path to find all translations to push.",
3626
4502
  "hasDynamicHelp": false,
3627
4503
  "multiple": false,
3628
4504
  "type": "option"
3629
4505
  },
3630
4506
  "commit": {
3631
4507
  "name": "commit",
3632
- "summary": "Push and commit the message type(s) at the same time",
4508
+ "summary": "Push and commit the translation(s) at the same time",
3633
4509
  "allowNo": false,
3634
4510
  "type": "boolean"
3635
4511
  },
@@ -3647,26 +4523,28 @@
3647
4523
  },
3648
4524
  "hasDynamicHelp": false,
3649
4525
  "hiddenAliases": [],
3650
- "id": "message-type:push",
4526
+ "id": "translation:push",
3651
4527
  "pluginAlias": "@knocklabs/cli",
3652
4528
  "pluginName": "@knocklabs/cli",
3653
4529
  "pluginType": "core",
3654
4530
  "strict": true,
3655
- "summary": "Push one or more message types from a local file system to Knock.",
4531
+ "summary": "Push one or more translations from a local file system to Knock.",
3656
4532
  "enableJsonFlag": false,
4533
+ "verifyFeatureEnabled": "translations",
3657
4534
  "isESM": false,
3658
4535
  "relativePath": [
3659
4536
  "dist",
3660
4537
  "commands",
3661
- "message-type",
4538
+ "translation",
3662
4539
  "push.js"
3663
4540
  ]
3664
4541
  },
3665
- "message-type:validate": {
4542
+ "translation:validate": {
3666
4543
  "aliases": [],
3667
4544
  "args": {
3668
- "messageTypeKey": {
3669
- "name": "messageTypeKey",
4545
+ "translationRef": {
4546
+ "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
4547
+ "name": "translationRef",
3670
4548
  "required": false
3671
4549
  }
3672
4550
  },
@@ -3690,7 +4568,7 @@
3690
4568
  },
3691
4569
  "environment": {
3692
4570
  "name": "environment",
3693
- "summary": "Validating a message type is only done in the development environment",
4571
+ "summary": "Validating a translation is only done in the development environment",
3694
4572
  "default": "development",
3695
4573
  "hasDynamicHelp": false,
3696
4574
  "multiple": false,
@@ -3708,16 +4586,16 @@
3708
4586
  },
3709
4587
  "all": {
3710
4588
  "name": "all",
3711
- "summary": "Whether to validate all message types from the target directory.",
4589
+ "summary": "Whether to validate all translations from the target directory.",
3712
4590
  "allowNo": false,
3713
4591
  "type": "boolean"
3714
4592
  },
3715
- "message-types-dir": {
4593
+ "translations-dir": {
3716
4594
  "dependsOn": [
3717
4595
  "all"
3718
4596
  ],
3719
- "name": "message-types-dir",
3720
- "summary": "The target directory path to find all message types to validate.",
4597
+ "name": "translations-dir",
4598
+ "summary": "The target directory path to find all translations to validate.",
3721
4599
  "hasDynamicHelp": false,
3722
4600
  "multiple": false,
3723
4601
  "type": "option"
@@ -3725,18 +4603,19 @@
3725
4603
  },
3726
4604
  "hasDynamicHelp": false,
3727
4605
  "hiddenAliases": [],
3728
- "id": "message-type:validate",
4606
+ "id": "translation:validate",
3729
4607
  "pluginAlias": "@knocklabs/cli",
3730
4608
  "pluginName": "@knocklabs/cli",
3731
4609
  "pluginType": "core",
3732
4610
  "strict": true,
3733
- "summary": "Validate one or more message types from a local file system.",
4611
+ "summary": "Validate one or more translations from a local file system.",
3734
4612
  "enableJsonFlag": false,
4613
+ "verifyFeatureEnabled": "translations",
3735
4614
  "isESM": false,
3736
4615
  "relativePath": [
3737
4616
  "dist",
3738
4617
  "commands",
3739
- "message-type",
4618
+ "translation",
3740
4619
  "validate.js"
3741
4620
  ]
3742
4621
  },
@@ -4139,6 +5018,65 @@
4139
5018
  "new.js"
4140
5019
  ]
4141
5020
  },
5021
+ "workflow:open": {
5022
+ "aliases": [],
5023
+ "args": {
5024
+ "workflowKey": {
5025
+ "name": "workflowKey",
5026
+ "required": true
5027
+ }
5028
+ },
5029
+ "flags": {
5030
+ "service-token": {
5031
+ "env": "KNOCK_SERVICE_TOKEN",
5032
+ "name": "service-token",
5033
+ "required": false,
5034
+ "summary": "The service token to authenticate with.",
5035
+ "hasDynamicHelp": false,
5036
+ "multiple": false,
5037
+ "type": "option"
5038
+ },
5039
+ "api-origin": {
5040
+ "hidden": true,
5041
+ "name": "api-origin",
5042
+ "required": false,
5043
+ "hasDynamicHelp": false,
5044
+ "multiple": false,
5045
+ "type": "option"
5046
+ },
5047
+ "environment": {
5048
+ "name": "environment",
5049
+ "summary": "The environment to use.",
5050
+ "default": "development",
5051
+ "hasDynamicHelp": false,
5052
+ "multiple": false,
5053
+ "type": "option"
5054
+ },
5055
+ "branch": {
5056
+ "name": "branch",
5057
+ "summary": "The slug of the branch to use.",
5058
+ "hasDynamicHelp": false,
5059
+ "multiple": false,
5060
+ "type": "option"
5061
+ }
5062
+ },
5063
+ "hasDynamicHelp": false,
5064
+ "hiddenAliases": [],
5065
+ "id": "workflow:open",
5066
+ "pluginAlias": "@knocklabs/cli",
5067
+ "pluginName": "@knocklabs/cli",
5068
+ "pluginType": "core",
5069
+ "strict": true,
5070
+ "summary": "Open a workflow in the Knock dashboard.",
5071
+ "enableJsonFlag": false,
5072
+ "isESM": false,
5073
+ "relativePath": [
5074
+ "dist",
5075
+ "commands",
5076
+ "workflow",
5077
+ "open.js"
5078
+ ]
5079
+ },
4142
5080
  "workflow:pull": {
4143
5081
  "aliases": [],
4144
5082
  "args": {
@@ -4485,5 +5423,5 @@
4485
5423
  ]
4486
5424
  }
4487
5425
  },
4488
- "version": "1.0.0-rc.1"
5426
+ "version": "1.0.2"
4489
5427
  }