@knocklabs/cli 0.1.23 → 0.2.0

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 (15) hide show
  1. package/README.md +128 -102
  2. package/bin/dev.js +4 -4
  3. package/dist/commands/knock.js +3 -0
  4. package/dist/commands/login.js +50 -0
  5. package/dist/commands/logout.js +48 -0
  6. package/dist/commands/whoami.js +6 -2
  7. package/dist/lib/api-v1.js +13 -4
  8. package/dist/lib/auth.js +256 -0
  9. package/dist/lib/base-command.js +85 -12
  10. package/dist/lib/helpers/browser.js +25 -0
  11. package/dist/lib/types.js +4 -0
  12. package/dist/lib/urls.js +32 -0
  13. package/dist/lib/user-config.js +69 -31
  14. package/oclif.manifest.json +220 -146
  15. package/package.json +7 -6
package/oclif.manifest.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "service-token": {
8
8
  "env": "KNOCK_SERVICE_TOKEN",
9
9
  "name": "service-token",
10
- "required": true,
10
+ "required": false,
11
11
  "summary": "The service token to authenticate with.",
12
12
  "hasDynamicHelp": false,
13
13
  "multiple": false,
@@ -38,6 +38,80 @@
38
38
  "knock.js"
39
39
  ]
40
40
  },
41
+ "login": {
42
+ "aliases": [],
43
+ "args": {},
44
+ "flags": {
45
+ "service-token": {
46
+ "env": "KNOCK_SERVICE_TOKEN",
47
+ "name": "service-token",
48
+ "required": false,
49
+ "summary": "The service token to authenticate with.",
50
+ "hasDynamicHelp": false,
51
+ "multiple": false,
52
+ "type": "option"
53
+ },
54
+ "api-origin": {
55
+ "hidden": true,
56
+ "name": "api-origin",
57
+ "required": false,
58
+ "hasDynamicHelp": false,
59
+ "multiple": false,
60
+ "type": "option"
61
+ }
62
+ },
63
+ "hasDynamicHelp": false,
64
+ "hiddenAliases": [],
65
+ "id": "login",
66
+ "pluginAlias": "@knocklabs/cli",
67
+ "pluginName": "@knocklabs/cli",
68
+ "pluginType": "core",
69
+ "strict": true,
70
+ "enableJsonFlag": false,
71
+ "isESM": false,
72
+ "relativePath": [
73
+ "dist",
74
+ "commands",
75
+ "login.js"
76
+ ]
77
+ },
78
+ "logout": {
79
+ "aliases": [],
80
+ "args": {},
81
+ "flags": {
82
+ "service-token": {
83
+ "env": "KNOCK_SERVICE_TOKEN",
84
+ "name": "service-token",
85
+ "required": false,
86
+ "summary": "The service token to authenticate with.",
87
+ "hasDynamicHelp": false,
88
+ "multiple": false,
89
+ "type": "option"
90
+ },
91
+ "api-origin": {
92
+ "hidden": true,
93
+ "name": "api-origin",
94
+ "required": false,
95
+ "hasDynamicHelp": false,
96
+ "multiple": false,
97
+ "type": "option"
98
+ }
99
+ },
100
+ "hasDynamicHelp": false,
101
+ "hiddenAliases": [],
102
+ "id": "logout",
103
+ "pluginAlias": "@knocklabs/cli",
104
+ "pluginName": "@knocklabs/cli",
105
+ "pluginType": "core",
106
+ "strict": true,
107
+ "enableJsonFlag": false,
108
+ "isESM": false,
109
+ "relativePath": [
110
+ "dist",
111
+ "commands",
112
+ "logout.js"
113
+ ]
114
+ },
41
115
  "ping": {
42
116
  "aliases": [],
43
117
  "args": {},
@@ -45,7 +119,7 @@
45
119
  "service-token": {
46
120
  "env": "KNOCK_SERVICE_TOKEN",
47
121
  "name": "service-token",
48
- "required": true,
122
+ "required": false,
49
123
  "summary": "The service token to authenticate with.",
50
124
  "hasDynamicHelp": false,
51
125
  "multiple": false,
@@ -83,7 +157,7 @@
83
157
  "service-token": {
84
158
  "env": "KNOCK_SERVICE_TOKEN",
85
159
  "name": "service-token",
86
- "required": true,
160
+ "required": false,
87
161
  "summary": "The service token to authenticate with.",
88
162
  "hasDynamicHelp": false,
89
163
  "multiple": false,
@@ -149,7 +223,7 @@
149
223
  "service-token": {
150
224
  "env": "KNOCK_SERVICE_TOKEN",
151
225
  "name": "service-token",
152
- "required": true,
226
+ "required": false,
153
227
  "summary": "The service token to authenticate with.",
154
228
  "hasDynamicHelp": false,
155
229
  "multiple": false,
@@ -230,7 +304,7 @@
230
304
  "service-token": {
231
305
  "env": "KNOCK_SERVICE_TOKEN",
232
306
  "name": "service-token",
233
- "required": true,
307
+ "required": false,
234
308
  "summary": "The service token to authenticate with.",
235
309
  "hasDynamicHelp": false,
236
310
  "multiple": false,
@@ -280,7 +354,7 @@
280
354
  "service-token": {
281
355
  "env": "KNOCK_SERVICE_TOKEN",
282
356
  "name": "service-token",
283
- "required": true,
357
+ "required": false,
284
358
  "summary": "The service token to authenticate with.",
285
359
  "hasDynamicHelp": false,
286
360
  "multiple": false,
@@ -319,7 +393,7 @@
319
393
  "service-token": {
320
394
  "env": "KNOCK_SERVICE_TOKEN",
321
395
  "name": "service-token",
322
- "required": true,
396
+ "required": false,
323
397
  "summary": "The service token to authenticate with.",
324
398
  "hasDynamicHelp": false,
325
399
  "multiple": false,
@@ -390,7 +464,7 @@
390
464
  "service-token": {
391
465
  "env": "KNOCK_SERVICE_TOKEN",
392
466
  "name": "service-token",
393
- "required": true,
467
+ "required": false,
394
468
  "summary": "The service token to authenticate with.",
395
469
  "hasDynamicHelp": false,
396
470
  "multiple": false,
@@ -486,7 +560,7 @@
486
560
  "service-token": {
487
561
  "env": "KNOCK_SERVICE_TOKEN",
488
562
  "name": "service-token",
489
- "required": true,
563
+ "required": false,
490
564
  "summary": "The service token to authenticate with.",
491
565
  "hasDynamicHelp": false,
492
566
  "multiple": false,
@@ -551,7 +625,7 @@
551
625
  "service-token": {
552
626
  "env": "KNOCK_SERVICE_TOKEN",
553
627
  "name": "service-token",
554
- "required": true,
628
+ "required": false,
555
629
  "summary": "The service token to authenticate with.",
556
630
  "hasDynamicHelp": false,
557
631
  "multiple": false,
@@ -640,7 +714,7 @@
640
714
  "service-token": {
641
715
  "env": "KNOCK_SERVICE_TOKEN",
642
716
  "name": "service-token",
643
- "required": true,
717
+ "required": false,
644
718
  "summary": "The service token to authenticate with.",
645
719
  "hasDynamicHelp": false,
646
720
  "multiple": false,
@@ -706,7 +780,7 @@
706
780
  "service-token": {
707
781
  "env": "KNOCK_SERVICE_TOKEN",
708
782
  "name": "service-token",
709
- "required": true,
783
+ "required": false,
710
784
  "summary": "The service token to authenticate with.",
711
785
  "hasDynamicHelp": false,
712
786
  "multiple": false,
@@ -767,7 +841,7 @@
767
841
  "service-token": {
768
842
  "env": "KNOCK_SERVICE_TOKEN",
769
843
  "name": "service-token",
770
- "required": true,
844
+ "required": false,
771
845
  "summary": "The service token to authenticate with.",
772
846
  "hasDynamicHelp": false,
773
847
  "multiple": false,
@@ -847,7 +921,7 @@
847
921
  "service-token": {
848
922
  "env": "KNOCK_SERVICE_TOKEN",
849
923
  "name": "service-token",
850
- "required": true,
924
+ "required": false,
851
925
  "summary": "The service token to authenticate with.",
852
926
  "hasDynamicHelp": false,
853
927
  "multiple": false,
@@ -928,7 +1002,7 @@
928
1002
  "service-token": {
929
1003
  "env": "KNOCK_SERVICE_TOKEN",
930
1004
  "name": "service-token",
931
- "required": true,
1005
+ "required": false,
932
1006
  "summary": "The service token to authenticate with.",
933
1007
  "hasDynamicHelp": false,
934
1008
  "multiple": false,
@@ -1017,7 +1091,7 @@
1017
1091
  "service-token": {
1018
1092
  "env": "KNOCK_SERVICE_TOKEN",
1019
1093
  "name": "service-token",
1020
- "required": true,
1094
+ "required": false,
1021
1095
  "summary": "The service token to authenticate with.",
1022
1096
  "hasDynamicHelp": false,
1023
1097
  "multiple": false,
@@ -1077,11 +1151,11 @@
1077
1151
  "validate.js"
1078
1152
  ]
1079
1153
  },
1080
- "message-type:get": {
1154
+ "layout:get": {
1081
1155
  "aliases": [],
1082
1156
  "args": {
1083
- "messageTypeKey": {
1084
- "name": "messageTypeKey",
1157
+ "emailLayoutKey": {
1158
+ "name": "emailLayoutKey",
1085
1159
  "required": true
1086
1160
  }
1087
1161
  },
@@ -1096,7 +1170,7 @@
1096
1170
  "service-token": {
1097
1171
  "env": "KNOCK_SERVICE_TOKEN",
1098
1172
  "name": "service-token",
1099
- "required": true,
1173
+ "required": false,
1100
1174
  "summary": "The service token to authenticate with.",
1101
1175
  "hasDynamicHelp": false,
1102
1176
  "multiple": false,
@@ -1126,24 +1200,23 @@
1126
1200
  }
1127
1201
  },
1128
1202
  "hasDynamicHelp": false,
1129
- "hidden": true,
1130
1203
  "hiddenAliases": [],
1131
- "id": "message-type:get",
1204
+ "id": "layout:get",
1132
1205
  "pluginAlias": "@knocklabs/cli",
1133
1206
  "pluginName": "@knocklabs/cli",
1134
1207
  "pluginType": "core",
1135
1208
  "strict": true,
1136
- "summary": "Display a single in-app message type from an environment.",
1209
+ "summary": "Display a single email layout from an environment.",
1137
1210
  "enableJsonFlag": true,
1138
1211
  "isESM": false,
1139
1212
  "relativePath": [
1140
1213
  "dist",
1141
1214
  "commands",
1142
- "message-type",
1215
+ "layout",
1143
1216
  "get.js"
1144
1217
  ]
1145
1218
  },
1146
- "message-type:list": {
1219
+ "layout:list": {
1147
1220
  "aliases": [],
1148
1221
  "args": {},
1149
1222
  "flags": {
@@ -1157,7 +1230,7 @@
1157
1230
  "service-token": {
1158
1231
  "env": "KNOCK_SERVICE_TOKEN",
1159
1232
  "name": "service-token",
1160
- "required": true,
1233
+ "required": false,
1161
1234
  "summary": "The service token to authenticate with.",
1162
1235
  "hasDynamicHelp": false,
1163
1236
  "multiple": false,
@@ -1208,28 +1281,27 @@
1208
1281
  }
1209
1282
  },
1210
1283
  "hasDynamicHelp": false,
1211
- "hidden": true,
1212
1284
  "hiddenAliases": [],
1213
- "id": "message-type:list",
1285
+ "id": "layout:list",
1214
1286
  "pluginAlias": "@knocklabs/cli",
1215
1287
  "pluginName": "@knocklabs/cli",
1216
1288
  "pluginType": "core",
1217
1289
  "strict": true,
1218
- "summary": "Display all in-app message types for an environment.",
1290
+ "summary": "Display all email layouts for an environment.",
1219
1291
  "enableJsonFlag": true,
1220
1292
  "isESM": false,
1221
1293
  "relativePath": [
1222
1294
  "dist",
1223
1295
  "commands",
1224
- "message-type",
1296
+ "layout",
1225
1297
  "list.js"
1226
1298
  ]
1227
1299
  },
1228
- "message-type:pull": {
1300
+ "layout:pull": {
1229
1301
  "aliases": [],
1230
1302
  "args": {
1231
- "messageTypeKey": {
1232
- "name": "messageTypeKey",
1303
+ "emailLayoutKey": {
1304
+ "name": "emailLayoutKey",
1233
1305
  "required": false
1234
1306
  }
1235
1307
  },
@@ -1237,7 +1309,7 @@
1237
1309
  "service-token": {
1238
1310
  "env": "KNOCK_SERVICE_TOKEN",
1239
1311
  "name": "service-token",
1240
- "required": true,
1312
+ "required": false,
1241
1313
  "summary": "The service token to authenticate with.",
1242
1314
  "hasDynamicHelp": false,
1243
1315
  "multiple": false,
@@ -1261,16 +1333,19 @@
1261
1333
  },
1262
1334
  "all": {
1263
1335
  "name": "all",
1264
- "summary": "Whether to pull all in-app message types from the specified environment.",
1336
+ "summary": "Whether to pull all email layouts from the specified environment.",
1265
1337
  "allowNo": false,
1266
1338
  "type": "boolean"
1267
1339
  },
1268
- "message-types-dir": {
1340
+ "layouts-dir": {
1341
+ "aliases": [
1342
+ "email-layouts-dir"
1343
+ ],
1269
1344
  "dependsOn": [
1270
1345
  "all"
1271
1346
  ],
1272
- "name": "message-types-dir",
1273
- "summary": "The target directory path to pull all in-app message types into.",
1347
+ "name": "layouts-dir",
1348
+ "summary": "The target directory path to pull all email layouts into.",
1274
1349
  "hasDynamicHelp": false,
1275
1350
  "multiple": false,
1276
1351
  "type": "option"
@@ -1289,28 +1364,27 @@
1289
1364
  }
1290
1365
  },
1291
1366
  "hasDynamicHelp": false,
1292
- "hidden": true,
1293
1367
  "hiddenAliases": [],
1294
- "id": "message-type:pull",
1368
+ "id": "layout:pull",
1295
1369
  "pluginAlias": "@knocklabs/cli",
1296
1370
  "pluginName": "@knocklabs/cli",
1297
1371
  "pluginType": "core",
1298
1372
  "strict": true,
1299
- "summary": "Pull one or more in-app message types from an environment into a local file system.",
1373
+ "summary": "Pull one or more email layouts from an environment into a local file system.",
1300
1374
  "enableJsonFlag": false,
1301
1375
  "isESM": false,
1302
1376
  "relativePath": [
1303
1377
  "dist",
1304
1378
  "commands",
1305
- "message-type",
1379
+ "layout",
1306
1380
  "pull.js"
1307
1381
  ]
1308
1382
  },
1309
- "message-type:push": {
1383
+ "layout:push": {
1310
1384
  "aliases": [],
1311
1385
  "args": {
1312
- "messageTypeKey": {
1313
- "name": "messageTypeKey",
1386
+ "emailLayoutKey": {
1387
+ "name": "emailLayoutKey",
1314
1388
  "required": false
1315
1389
  }
1316
1390
  },
@@ -1318,7 +1392,7 @@
1318
1392
  "service-token": {
1319
1393
  "env": "KNOCK_SERVICE_TOKEN",
1320
1394
  "name": "service-token",
1321
- "required": true,
1395
+ "required": false,
1322
1396
  "summary": "The service token to authenticate with.",
1323
1397
  "hasDynamicHelp": false,
1324
1398
  "multiple": false,
@@ -1334,7 +1408,7 @@
1334
1408
  },
1335
1409
  "environment": {
1336
1410
  "name": "environment",
1337
- "summary": "Pushing a message type is only allowed in the development environment",
1411
+ "summary": "Pushing an email layout is only allowed in the development environment",
1338
1412
  "default": "development",
1339
1413
  "hasDynamicHelp": false,
1340
1414
  "multiple": false,
@@ -1345,23 +1419,26 @@
1345
1419
  },
1346
1420
  "all": {
1347
1421
  "name": "all",
1348
- "summary": "Whether to push all message types from the target directory.",
1422
+ "summary": "Whether to push all layouts from the target directory.",
1349
1423
  "allowNo": false,
1350
1424
  "type": "boolean"
1351
1425
  },
1352
- "message-types-dir": {
1426
+ "layouts-dir": {
1427
+ "aliases": [
1428
+ "email-layouts-dir"
1429
+ ],
1353
1430
  "dependsOn": [
1354
1431
  "all"
1355
1432
  ],
1356
- "name": "message-types-dir",
1357
- "summary": "The target directory path to find all message types to push.",
1433
+ "name": "layouts-dir",
1434
+ "summary": "The target directory path to find all layouts to push.",
1358
1435
  "hasDynamicHelp": false,
1359
1436
  "multiple": false,
1360
1437
  "type": "option"
1361
1438
  },
1362
1439
  "commit": {
1363
1440
  "name": "commit",
1364
- "summary": "Push and commit the message type(s) at the same time",
1441
+ "summary": "Push and commit the layout(s) at the same time",
1365
1442
  "allowNo": false,
1366
1443
  "type": "boolean"
1367
1444
  },
@@ -1378,28 +1455,27 @@
1378
1455
  }
1379
1456
  },
1380
1457
  "hasDynamicHelp": false,
1381
- "hidden": true,
1382
1458
  "hiddenAliases": [],
1383
- "id": "message-type:push",
1459
+ "id": "layout:push",
1384
1460
  "pluginAlias": "@knocklabs/cli",
1385
1461
  "pluginName": "@knocklabs/cli",
1386
1462
  "pluginType": "core",
1387
1463
  "strict": true,
1388
- "summary": "Push one or more message types from a local file system to Knock.",
1464
+ "summary": "Push one or more email layouts from a local file system to Knock.",
1389
1465
  "enableJsonFlag": false,
1390
1466
  "isESM": false,
1391
1467
  "relativePath": [
1392
1468
  "dist",
1393
1469
  "commands",
1394
- "message-type",
1470
+ "layout",
1395
1471
  "push.js"
1396
1472
  ]
1397
1473
  },
1398
- "message-type:validate": {
1474
+ "layout:validate": {
1399
1475
  "aliases": [],
1400
1476
  "args": {
1401
- "messageTypeKey": {
1402
- "name": "messageTypeKey",
1477
+ "emailLayoutKey": {
1478
+ "name": "emailLayoutKey",
1403
1479
  "required": false
1404
1480
  }
1405
1481
  },
@@ -1407,7 +1483,7 @@
1407
1483
  "service-token": {
1408
1484
  "env": "KNOCK_SERVICE_TOKEN",
1409
1485
  "name": "service-token",
1410
- "required": true,
1486
+ "required": false,
1411
1487
  "summary": "The service token to authenticate with.",
1412
1488
  "hasDynamicHelp": false,
1413
1489
  "multiple": false,
@@ -1423,7 +1499,7 @@
1423
1499
  },
1424
1500
  "environment": {
1425
1501
  "name": "environment",
1426
- "summary": "Validating a message type is only done in the development environment",
1502
+ "summary": "Validating a layout is only done in the development environment",
1427
1503
  "default": "development",
1428
1504
  "hasDynamicHelp": false,
1429
1505
  "multiple": false,
@@ -1434,44 +1510,46 @@
1434
1510
  },
1435
1511
  "all": {
1436
1512
  "name": "all",
1437
- "summary": "Whether to validate all message types from the target directory.",
1513
+ "summary": "Whether to validate all layouts from the target directory.",
1438
1514
  "allowNo": false,
1439
1515
  "type": "boolean"
1440
1516
  },
1441
- "message-types-dir": {
1517
+ "layouts-dir": {
1518
+ "aliases": [
1519
+ "email-layouts-dir"
1520
+ ],
1442
1521
  "dependsOn": [
1443
1522
  "all"
1444
1523
  ],
1445
- "name": "message-types-dir",
1446
- "summary": "The target directory path to find all message types to validate.",
1524
+ "name": "layouts-dir",
1525
+ "summary": "The target directory path to find all layouts to validate.",
1447
1526
  "hasDynamicHelp": false,
1448
1527
  "multiple": false,
1449
1528
  "type": "option"
1450
1529
  }
1451
1530
  },
1452
1531
  "hasDynamicHelp": false,
1453
- "hidden": true,
1454
1532
  "hiddenAliases": [],
1455
- "id": "message-type:validate",
1533
+ "id": "layout:validate",
1456
1534
  "pluginAlias": "@knocklabs/cli",
1457
1535
  "pluginName": "@knocklabs/cli",
1458
1536
  "pluginType": "core",
1459
1537
  "strict": true,
1460
- "summary": "Validate one or more message types from a local file system.",
1538
+ "summary": "Validate one or more layouts from a local file system.",
1461
1539
  "enableJsonFlag": false,
1462
1540
  "isESM": false,
1463
1541
  "relativePath": [
1464
1542
  "dist",
1465
1543
  "commands",
1466
- "message-type",
1544
+ "layout",
1467
1545
  "validate.js"
1468
1546
  ]
1469
1547
  },
1470
- "layout:get": {
1548
+ "message-type:get": {
1471
1549
  "aliases": [],
1472
1550
  "args": {
1473
- "emailLayoutKey": {
1474
- "name": "emailLayoutKey",
1551
+ "messageTypeKey": {
1552
+ "name": "messageTypeKey",
1475
1553
  "required": true
1476
1554
  }
1477
1555
  },
@@ -1486,7 +1564,7 @@
1486
1564
  "service-token": {
1487
1565
  "env": "KNOCK_SERVICE_TOKEN",
1488
1566
  "name": "service-token",
1489
- "required": true,
1567
+ "required": false,
1490
1568
  "summary": "The service token to authenticate with.",
1491
1569
  "hasDynamicHelp": false,
1492
1570
  "multiple": false,
@@ -1516,23 +1594,24 @@
1516
1594
  }
1517
1595
  },
1518
1596
  "hasDynamicHelp": false,
1597
+ "hidden": true,
1519
1598
  "hiddenAliases": [],
1520
- "id": "layout:get",
1599
+ "id": "message-type:get",
1521
1600
  "pluginAlias": "@knocklabs/cli",
1522
1601
  "pluginName": "@knocklabs/cli",
1523
1602
  "pluginType": "core",
1524
1603
  "strict": true,
1525
- "summary": "Display a single email layout from an environment.",
1604
+ "summary": "Display a single in-app message type from an environment.",
1526
1605
  "enableJsonFlag": true,
1527
1606
  "isESM": false,
1528
1607
  "relativePath": [
1529
1608
  "dist",
1530
1609
  "commands",
1531
- "layout",
1610
+ "message-type",
1532
1611
  "get.js"
1533
1612
  ]
1534
1613
  },
1535
- "layout:list": {
1614
+ "message-type:list": {
1536
1615
  "aliases": [],
1537
1616
  "args": {},
1538
1617
  "flags": {
@@ -1546,7 +1625,7 @@
1546
1625
  "service-token": {
1547
1626
  "env": "KNOCK_SERVICE_TOKEN",
1548
1627
  "name": "service-token",
1549
- "required": true,
1628
+ "required": false,
1550
1629
  "summary": "The service token to authenticate with.",
1551
1630
  "hasDynamicHelp": false,
1552
1631
  "multiple": false,
@@ -1597,27 +1676,28 @@
1597
1676
  }
1598
1677
  },
1599
1678
  "hasDynamicHelp": false,
1679
+ "hidden": true,
1600
1680
  "hiddenAliases": [],
1601
- "id": "layout:list",
1681
+ "id": "message-type:list",
1602
1682
  "pluginAlias": "@knocklabs/cli",
1603
1683
  "pluginName": "@knocklabs/cli",
1604
1684
  "pluginType": "core",
1605
1685
  "strict": true,
1606
- "summary": "Display all email layouts for an environment.",
1686
+ "summary": "Display all in-app message types for an environment.",
1607
1687
  "enableJsonFlag": true,
1608
1688
  "isESM": false,
1609
1689
  "relativePath": [
1610
1690
  "dist",
1611
1691
  "commands",
1612
- "layout",
1692
+ "message-type",
1613
1693
  "list.js"
1614
1694
  ]
1615
1695
  },
1616
- "layout:pull": {
1696
+ "message-type:pull": {
1617
1697
  "aliases": [],
1618
1698
  "args": {
1619
- "emailLayoutKey": {
1620
- "name": "emailLayoutKey",
1699
+ "messageTypeKey": {
1700
+ "name": "messageTypeKey",
1621
1701
  "required": false
1622
1702
  }
1623
1703
  },
@@ -1625,7 +1705,7 @@
1625
1705
  "service-token": {
1626
1706
  "env": "KNOCK_SERVICE_TOKEN",
1627
1707
  "name": "service-token",
1628
- "required": true,
1708
+ "required": false,
1629
1709
  "summary": "The service token to authenticate with.",
1630
1710
  "hasDynamicHelp": false,
1631
1711
  "multiple": false,
@@ -1649,19 +1729,16 @@
1649
1729
  },
1650
1730
  "all": {
1651
1731
  "name": "all",
1652
- "summary": "Whether to pull all email layouts from the specified environment.",
1732
+ "summary": "Whether to pull all in-app message types from the specified environment.",
1653
1733
  "allowNo": false,
1654
1734
  "type": "boolean"
1655
1735
  },
1656
- "layouts-dir": {
1657
- "aliases": [
1658
- "email-layouts-dir"
1659
- ],
1736
+ "message-types-dir": {
1660
1737
  "dependsOn": [
1661
1738
  "all"
1662
1739
  ],
1663
- "name": "layouts-dir",
1664
- "summary": "The target directory path to pull all email layouts into.",
1740
+ "name": "message-types-dir",
1741
+ "summary": "The target directory path to pull all in-app message types into.",
1665
1742
  "hasDynamicHelp": false,
1666
1743
  "multiple": false,
1667
1744
  "type": "option"
@@ -1680,27 +1757,28 @@
1680
1757
  }
1681
1758
  },
1682
1759
  "hasDynamicHelp": false,
1760
+ "hidden": true,
1683
1761
  "hiddenAliases": [],
1684
- "id": "layout:pull",
1762
+ "id": "message-type:pull",
1685
1763
  "pluginAlias": "@knocklabs/cli",
1686
1764
  "pluginName": "@knocklabs/cli",
1687
1765
  "pluginType": "core",
1688
1766
  "strict": true,
1689
- "summary": "Pull one or more email layouts from an environment into a local file system.",
1767
+ "summary": "Pull one or more in-app message types from an environment into a local file system.",
1690
1768
  "enableJsonFlag": false,
1691
1769
  "isESM": false,
1692
1770
  "relativePath": [
1693
1771
  "dist",
1694
1772
  "commands",
1695
- "layout",
1773
+ "message-type",
1696
1774
  "pull.js"
1697
1775
  ]
1698
1776
  },
1699
- "layout:push": {
1777
+ "message-type:push": {
1700
1778
  "aliases": [],
1701
1779
  "args": {
1702
- "emailLayoutKey": {
1703
- "name": "emailLayoutKey",
1780
+ "messageTypeKey": {
1781
+ "name": "messageTypeKey",
1704
1782
  "required": false
1705
1783
  }
1706
1784
  },
@@ -1708,7 +1786,7 @@
1708
1786
  "service-token": {
1709
1787
  "env": "KNOCK_SERVICE_TOKEN",
1710
1788
  "name": "service-token",
1711
- "required": true,
1789
+ "required": false,
1712
1790
  "summary": "The service token to authenticate with.",
1713
1791
  "hasDynamicHelp": false,
1714
1792
  "multiple": false,
@@ -1724,7 +1802,7 @@
1724
1802
  },
1725
1803
  "environment": {
1726
1804
  "name": "environment",
1727
- "summary": "Pushing an email layout is only allowed in the development environment",
1805
+ "summary": "Pushing a message type is only allowed in the development environment",
1728
1806
  "default": "development",
1729
1807
  "hasDynamicHelp": false,
1730
1808
  "multiple": false,
@@ -1735,26 +1813,23 @@
1735
1813
  },
1736
1814
  "all": {
1737
1815
  "name": "all",
1738
- "summary": "Whether to push all layouts from the target directory.",
1816
+ "summary": "Whether to push all message types from the target directory.",
1739
1817
  "allowNo": false,
1740
1818
  "type": "boolean"
1741
1819
  },
1742
- "layouts-dir": {
1743
- "aliases": [
1744
- "email-layouts-dir"
1745
- ],
1820
+ "message-types-dir": {
1746
1821
  "dependsOn": [
1747
1822
  "all"
1748
1823
  ],
1749
- "name": "layouts-dir",
1750
- "summary": "The target directory path to find all layouts to push.",
1824
+ "name": "message-types-dir",
1825
+ "summary": "The target directory path to find all message types to push.",
1751
1826
  "hasDynamicHelp": false,
1752
1827
  "multiple": false,
1753
1828
  "type": "option"
1754
1829
  },
1755
1830
  "commit": {
1756
1831
  "name": "commit",
1757
- "summary": "Push and commit the layout(s) at the same time",
1832
+ "summary": "Push and commit the message type(s) at the same time",
1758
1833
  "allowNo": false,
1759
1834
  "type": "boolean"
1760
1835
  },
@@ -1771,27 +1846,28 @@
1771
1846
  }
1772
1847
  },
1773
1848
  "hasDynamicHelp": false,
1849
+ "hidden": true,
1774
1850
  "hiddenAliases": [],
1775
- "id": "layout:push",
1851
+ "id": "message-type:push",
1776
1852
  "pluginAlias": "@knocklabs/cli",
1777
1853
  "pluginName": "@knocklabs/cli",
1778
1854
  "pluginType": "core",
1779
1855
  "strict": true,
1780
- "summary": "Push one or more email layouts from a local file system to Knock.",
1856
+ "summary": "Push one or more message types from a local file system to Knock.",
1781
1857
  "enableJsonFlag": false,
1782
1858
  "isESM": false,
1783
1859
  "relativePath": [
1784
1860
  "dist",
1785
1861
  "commands",
1786
- "layout",
1862
+ "message-type",
1787
1863
  "push.js"
1788
1864
  ]
1789
1865
  },
1790
- "layout:validate": {
1866
+ "message-type:validate": {
1791
1867
  "aliases": [],
1792
1868
  "args": {
1793
- "emailLayoutKey": {
1794
- "name": "emailLayoutKey",
1869
+ "messageTypeKey": {
1870
+ "name": "messageTypeKey",
1795
1871
  "required": false
1796
1872
  }
1797
1873
  },
@@ -1799,7 +1875,7 @@
1799
1875
  "service-token": {
1800
1876
  "env": "KNOCK_SERVICE_TOKEN",
1801
1877
  "name": "service-token",
1802
- "required": true,
1878
+ "required": false,
1803
1879
  "summary": "The service token to authenticate with.",
1804
1880
  "hasDynamicHelp": false,
1805
1881
  "multiple": false,
@@ -1815,7 +1891,7 @@
1815
1891
  },
1816
1892
  "environment": {
1817
1893
  "name": "environment",
1818
- "summary": "Validating a layout is only done in the development environment",
1894
+ "summary": "Validating a message type is only done in the development environment",
1819
1895
  "default": "development",
1820
1896
  "hasDynamicHelp": false,
1821
1897
  "multiple": false,
@@ -1826,38 +1902,36 @@
1826
1902
  },
1827
1903
  "all": {
1828
1904
  "name": "all",
1829
- "summary": "Whether to validate all layouts from the target directory.",
1905
+ "summary": "Whether to validate all message types from the target directory.",
1830
1906
  "allowNo": false,
1831
1907
  "type": "boolean"
1832
1908
  },
1833
- "layouts-dir": {
1834
- "aliases": [
1835
- "email-layouts-dir"
1836
- ],
1909
+ "message-types-dir": {
1837
1910
  "dependsOn": [
1838
1911
  "all"
1839
1912
  ],
1840
- "name": "layouts-dir",
1841
- "summary": "The target directory path to find all layouts to validate.",
1913
+ "name": "message-types-dir",
1914
+ "summary": "The target directory path to find all message types to validate.",
1842
1915
  "hasDynamicHelp": false,
1843
1916
  "multiple": false,
1844
1917
  "type": "option"
1845
1918
  }
1846
1919
  },
1847
1920
  "hasDynamicHelp": false,
1921
+ "hidden": true,
1848
1922
  "hiddenAliases": [],
1849
- "id": "layout:validate",
1923
+ "id": "message-type:validate",
1850
1924
  "pluginAlias": "@knocklabs/cli",
1851
1925
  "pluginName": "@knocklabs/cli",
1852
1926
  "pluginType": "core",
1853
1927
  "strict": true,
1854
- "summary": "Validate one or more layouts from a local file system.",
1928
+ "summary": "Validate one or more message types from a local file system.",
1855
1929
  "enableJsonFlag": false,
1856
1930
  "isESM": false,
1857
1931
  "relativePath": [
1858
1932
  "dist",
1859
1933
  "commands",
1860
- "layout",
1934
+ "message-type",
1861
1935
  "validate.js"
1862
1936
  ]
1863
1937
  },
@@ -1880,7 +1954,7 @@
1880
1954
  "service-token": {
1881
1955
  "env": "KNOCK_SERVICE_TOKEN",
1882
1956
  "name": "service-token",
1883
- "required": true,
1957
+ "required": false,
1884
1958
  "summary": "The service token to authenticate with.",
1885
1959
  "hasDynamicHelp": false,
1886
1960
  "multiple": false,
@@ -1940,7 +2014,7 @@
1940
2014
  "service-token": {
1941
2015
  "env": "KNOCK_SERVICE_TOKEN",
1942
2016
  "name": "service-token",
1943
- "required": true,
2017
+ "required": false,
1944
2018
  "summary": "The service token to authenticate with.",
1945
2019
  "hasDynamicHelp": false,
1946
2020
  "multiple": false,
@@ -2019,7 +2093,7 @@
2019
2093
  "service-token": {
2020
2094
  "env": "KNOCK_SERVICE_TOKEN",
2021
2095
  "name": "service-token",
2022
- "required": true,
2096
+ "required": false,
2023
2097
  "summary": "The service token to authenticate with.",
2024
2098
  "hasDynamicHelp": false,
2025
2099
  "multiple": false,
@@ -2099,7 +2173,7 @@
2099
2173
  "service-token": {
2100
2174
  "env": "KNOCK_SERVICE_TOKEN",
2101
2175
  "name": "service-token",
2102
- "required": true,
2176
+ "required": false,
2103
2177
  "summary": "The service token to authenticate with.",
2104
2178
  "hasDynamicHelp": false,
2105
2179
  "multiple": false,
@@ -2187,7 +2261,7 @@
2187
2261
  "service-token": {
2188
2262
  "env": "KNOCK_SERVICE_TOKEN",
2189
2263
  "name": "service-token",
2190
- "required": true,
2264
+ "required": false,
2191
2265
  "summary": "The service token to authenticate with.",
2192
2266
  "hasDynamicHelp": false,
2193
2267
  "multiple": false,
@@ -2266,7 +2340,7 @@
2266
2340
  "service-token": {
2267
2341
  "env": "KNOCK_SERVICE_TOKEN",
2268
2342
  "name": "service-token",
2269
- "required": true,
2343
+ "required": false,
2270
2344
  "summary": "The service token to authenticate with.",
2271
2345
  "hasDynamicHelp": false,
2272
2346
  "multiple": false,
@@ -2338,7 +2412,7 @@
2338
2412
  "service-token": {
2339
2413
  "env": "KNOCK_SERVICE_TOKEN",
2340
2414
  "name": "service-token",
2341
- "required": true,
2415
+ "required": false,
2342
2416
  "summary": "The service token to authenticate with.",
2343
2417
  "hasDynamicHelp": false,
2344
2418
  "multiple": false,
@@ -2418,7 +2492,7 @@
2418
2492
  "service-token": {
2419
2493
  "env": "KNOCK_SERVICE_TOKEN",
2420
2494
  "name": "service-token",
2421
- "required": true,
2495
+ "required": false,
2422
2496
  "summary": "The service token to authenticate with.",
2423
2497
  "hasDynamicHelp": false,
2424
2498
  "multiple": false,
@@ -2511,7 +2585,7 @@
2511
2585
  "service-token": {
2512
2586
  "env": "KNOCK_SERVICE_TOKEN",
2513
2587
  "name": "service-token",
2514
- "required": true,
2588
+ "required": false,
2515
2589
  "summary": "The service token to authenticate with.",
2516
2590
  "hasDynamicHelp": false,
2517
2591
  "multiple": false,
@@ -2600,7 +2674,7 @@
2600
2674
  "service-token": {
2601
2675
  "env": "KNOCK_SERVICE_TOKEN",
2602
2676
  "name": "service-token",
2603
- "required": true,
2677
+ "required": false,
2604
2678
  "summary": "The service token to authenticate with.",
2605
2679
  "hasDynamicHelp": false,
2606
2680
  "multiple": false,
@@ -2672,7 +2746,7 @@
2672
2746
  "service-token": {
2673
2747
  "env": "KNOCK_SERVICE_TOKEN",
2674
2748
  "name": "service-token",
2675
- "required": true,
2749
+ "required": false,
2676
2750
  "summary": "The service token to authenticate with.",
2677
2751
  "hasDynamicHelp": false,
2678
2752
  "multiple": false,
@@ -2738,7 +2812,7 @@
2738
2812
  "service-token": {
2739
2813
  "env": "KNOCK_SERVICE_TOKEN",
2740
2814
  "name": "service-token",
2741
- "required": true,
2815
+ "required": false,
2742
2816
  "summary": "The service token to authenticate with.",
2743
2817
  "hasDynamicHelp": false,
2744
2818
  "multiple": false,
@@ -2804,7 +2878,7 @@
2804
2878
  "service-token": {
2805
2879
  "env": "KNOCK_SERVICE_TOKEN",
2806
2880
  "name": "service-token",
2807
- "required": true,
2881
+ "required": false,
2808
2882
  "summary": "The service token to authenticate with.",
2809
2883
  "hasDynamicHelp": false,
2810
2884
  "multiple": false,
@@ -2864,7 +2938,7 @@
2864
2938
  "service-token": {
2865
2939
  "env": "KNOCK_SERVICE_TOKEN",
2866
2940
  "name": "service-token",
2867
- "required": true,
2941
+ "required": false,
2868
2942
  "summary": "The service token to authenticate with.",
2869
2943
  "hasDynamicHelp": false,
2870
2944
  "multiple": false,
@@ -2943,7 +3017,7 @@
2943
3017
  "service-token": {
2944
3018
  "env": "KNOCK_SERVICE_TOKEN",
2945
3019
  "name": "service-token",
2946
- "required": true,
3020
+ "required": false,
2947
3021
  "summary": "The service token to authenticate with.",
2948
3022
  "hasDynamicHelp": false,
2949
3023
  "multiple": false,
@@ -3001,7 +3075,7 @@
3001
3075
  "service-token": {
3002
3076
  "env": "KNOCK_SERVICE_TOKEN",
3003
3077
  "name": "service-token",
3004
- "required": true,
3078
+ "required": false,
3005
3079
  "summary": "The service token to authenticate with.",
3006
3080
  "hasDynamicHelp": false,
3007
3081
  "multiple": false,
@@ -3081,7 +3155,7 @@
3081
3155
  "service-token": {
3082
3156
  "env": "KNOCK_SERVICE_TOKEN",
3083
3157
  "name": "service-token",
3084
- "required": true,
3158
+ "required": false,
3085
3159
  "summary": "The service token to authenticate with.",
3086
3160
  "hasDynamicHelp": false,
3087
3161
  "multiple": false,
@@ -3169,7 +3243,7 @@
3169
3243
  "service-token": {
3170
3244
  "env": "KNOCK_SERVICE_TOKEN",
3171
3245
  "name": "service-token",
3172
- "required": true,
3246
+ "required": false,
3173
3247
  "summary": "The service token to authenticate with.",
3174
3248
  "hasDynamicHelp": false,
3175
3249
  "multiple": false,
@@ -3253,7 +3327,7 @@
3253
3327
  "service-token": {
3254
3328
  "env": "KNOCK_SERVICE_TOKEN",
3255
3329
  "name": "service-token",
3256
- "required": true,
3330
+ "required": false,
3257
3331
  "summary": "The service token to authenticate with.",
3258
3332
  "hasDynamicHelp": false,
3259
3333
  "multiple": false,
@@ -3313,5 +3387,5 @@
3313
3387
  ]
3314
3388
  }
3315
3389
  },
3316
- "version": "0.1.23"
3390
+ "version": "0.2.0"
3317
3391
  }