@knocklabs/cli 0.1.21 → 0.1.23

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 (57) hide show
  1. package/README.md +141 -41
  2. package/dist/commands/commit/list.js +21 -1
  3. package/dist/commands/guide/activate.js +121 -0
  4. package/dist/commands/guide/generate-types.js +148 -0
  5. package/dist/commands/guide/get.js +139 -0
  6. package/dist/commands/guide/list.js +112 -0
  7. package/dist/commands/guide/pull.js +209 -0
  8. package/dist/commands/guide/push.js +171 -0
  9. package/dist/commands/guide/validate.js +148 -0
  10. package/dist/commands/pull.js +157 -0
  11. package/dist/commands/push.js +175 -0
  12. package/dist/commands/workflow/generate-types.js +6 -5
  13. package/dist/lib/api-v1.js +61 -0
  14. package/dist/lib/helpers/const.js +4 -4
  15. package/dist/lib/helpers/date.js +3 -3
  16. package/dist/lib/helpers/error.js +8 -8
  17. package/dist/lib/helpers/flag.js +7 -7
  18. package/dist/lib/helpers/json.js +5 -5
  19. package/dist/lib/helpers/object.isomorphic.js +8 -8
  20. package/dist/lib/helpers/page.js +9 -9
  21. package/dist/lib/helpers/request.js +4 -4
  22. package/dist/lib/helpers/string.js +3 -3
  23. package/dist/lib/helpers/typegen.js +59 -0
  24. package/dist/lib/helpers/ux.js +3 -3
  25. package/dist/lib/marshal/email-layout/helpers.js +5 -5
  26. package/dist/lib/marshal/email-layout/processor.isomorphic.js +3 -3
  27. package/dist/lib/marshal/email-layout/reader.js +5 -5
  28. package/dist/lib/marshal/email-layout/writer.js +4 -4
  29. package/dist/lib/marshal/guide/helpers.js +283 -0
  30. package/dist/lib/marshal/guide/index.js +3 -0
  31. package/dist/lib/marshal/guide/processor.isomorphic.js +3 -3
  32. package/dist/lib/marshal/guide/reader.js +193 -0
  33. package/dist/lib/marshal/guide/writer.js +175 -0
  34. package/dist/lib/marshal/index.isomorphic.js +7 -7
  35. package/dist/lib/marshal/message-type/helpers.js +5 -5
  36. package/dist/lib/marshal/message-type/processor.isomorphic.js +3 -3
  37. package/dist/lib/marshal/message-type/reader.js +5 -5
  38. package/dist/lib/marshal/message-type/writer.js +4 -4
  39. package/dist/lib/marshal/partial/helpers.js +5 -5
  40. package/dist/lib/marshal/partial/processor.isomorphic.js +3 -3
  41. package/dist/lib/marshal/partial/reader.js +5 -5
  42. package/dist/lib/marshal/partial/writer.js +4 -4
  43. package/dist/lib/marshal/shared/const.isomorphic.js +3 -3
  44. package/dist/lib/marshal/shared/helpers.isomorphic.js +9 -2
  45. package/dist/lib/marshal/shared/helpers.js +4 -4
  46. package/dist/lib/marshal/translation/helpers.js +10 -10
  47. package/dist/lib/marshal/translation/processor.isomorphic.js +6 -6
  48. package/dist/lib/marshal/translation/writer.js +3 -3
  49. package/dist/lib/marshal/workflow/generator.js +4 -4
  50. package/dist/lib/marshal/workflow/helpers.js +53 -10
  51. package/dist/lib/marshal/workflow/processor.isomorphic.js +5 -5
  52. package/dist/lib/marshal/workflow/reader.js +5 -5
  53. package/dist/lib/marshal/workflow/writer.js +5 -5
  54. package/dist/lib/resources.js +32 -0
  55. package/oclif.manifest.json +961 -260
  56. package/package.json +8 -8
  57. package/dist/lib/type-generator.js +0 -100
@@ -113,6 +113,8 @@ class ApiV1 {
113
113
  const params = (0, _objectisomorphic.prune)({
114
114
  environment: flags.environment,
115
115
  promoted: flags.promoted,
116
+ resource_type: flags["resource-type"],
117
+ resource_id: flags["resource-id"],
116
118
  ...(0, _page.toPageParams)(flags)
117
119
  });
118
120
  return this.get("/commits", {
@@ -333,6 +335,65 @@ class ApiV1 {
333
335
  params
334
336
  });
335
337
  }
338
+ // By resources: Guides
339
+ async listGuides({ flags }) {
340
+ const params = (0, _objectisomorphic.prune)({
341
+ environment: flags.environment,
342
+ annotate: flags.annotate,
343
+ hide_uncommitted_changes: flags["hide-uncommitted-changes"],
344
+ include_json_schema: flags["include-json-schema"],
345
+ ...(0, _page.toPageParams)(flags)
346
+ });
347
+ return this.get("/guides", {
348
+ params
349
+ });
350
+ }
351
+ async getGuide({ args, flags }) {
352
+ const params = (0, _objectisomorphic.prune)({
353
+ environment: flags.environment,
354
+ annotate: flags.annotate,
355
+ hide_uncommitted_changes: flags["hide-uncommitted-changes"]
356
+ });
357
+ return this.get(`/guides/${args.guideKey}`, {
358
+ params
359
+ });
360
+ }
361
+ async validateGuide({ flags }, guide) {
362
+ const params = (0, _objectisomorphic.prune)({
363
+ environment: flags.environment
364
+ });
365
+ const data = {
366
+ guide
367
+ };
368
+ return this.put(`/guides/${guide.key}/validate`, data, {
369
+ params
370
+ });
371
+ }
372
+ async upsertGuide({ flags }, guide) {
373
+ const params = (0, _objectisomorphic.prune)({
374
+ environment: flags.environment,
375
+ annotate: flags.annotate,
376
+ commit: flags.commit,
377
+ commit_message: flags["commit-message"]
378
+ });
379
+ const data = {
380
+ guide
381
+ };
382
+ return this.put(`/guides/${guide.key}`, data, {
383
+ params
384
+ });
385
+ }
386
+ async activateGuide({ args, flags }) {
387
+ const params = (0, _objectisomorphic.prune)({
388
+ environment: flags.environment,
389
+ status: flags.status,
390
+ from: flags.from,
391
+ until: flags.until
392
+ });
393
+ return this.put(`/guides/${args.guideKey}/activate`, {}, {
394
+ params
395
+ });
396
+ }
336
397
  // By methods:
337
398
  async get(subpath, config) {
338
399
  return this.client.get(`/${API_VERSION}` + subpath, config);
@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- KnockEnv: function() {
12
+ get KnockEnv () {
13
13
  return KnockEnv;
14
14
  },
15
- isTestEnv: function() {
15
+ get isTestEnv () {
16
16
  return isTestEnv;
17
17
  },
18
- sandboxDir: function() {
18
+ get sandboxDir () {
19
19
  return sandboxDir;
20
20
  }
21
21
  });
@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- formatDate: function() {
12
+ get formatDate () {
13
13
  return formatDate;
14
14
  },
15
- formatDateTime: function() {
15
+ get formatDateTime () {
16
16
  return formatDateTime;
17
17
  }
18
18
  });
@@ -5,29 +5,29 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- ApiError: function() {
12
+ get ApiError () {
13
13
  return ApiError;
14
14
  },
15
- JsonDataError: function() {
15
+ get JsonDataError () {
16
16
  return JsonDataError;
17
17
  },
18
- JsonSyntaxError: function() {
18
+ get JsonSyntaxError () {
19
19
  return JsonSyntaxError;
20
20
  },
21
- LiquidParseError: function() {
21
+ get LiquidParseError () {
22
22
  return LiquidParseError;
23
23
  },
24
- SourceError: function() {
24
+ get SourceError () {
25
25
  return SourceError;
26
26
  },
27
- formatError: function() {
27
+ get formatError () {
28
28
  return formatError;
29
29
  },
30
- formatErrors: function() {
30
+ get formatErrors () {
31
31
  return formatErrors;
32
32
  }
33
33
  });
@@ -5,26 +5,26 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- booleanStr: function() {
12
+ get booleanStr () {
13
13
  return booleanStr;
14
14
  },
15
- dirPath: function() {
15
+ get dirPath () {
16
16
  return dirPath;
17
17
  },
18
- filePath: function() {
18
+ get filePath () {
19
19
  return filePath;
20
20
  },
21
- jsonStr: function() {
21
+ get jsonStr () {
22
22
  return jsonStr;
23
23
  },
24
- maybeJsonStr: function() {
24
+ get maybeJsonStr () {
25
25
  return maybeJsonStr;
26
26
  },
27
- maybeJsonStrAsList: function() {
27
+ get maybeJsonStrAsList () {
28
28
  return maybeJsonStrAsList;
29
29
  }
30
30
  });
@@ -5,20 +5,20 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- DOUBLE_SPACES: function() {
12
+ get DOUBLE_SPACES () {
13
13
  return DOUBLE_SPACES;
14
14
  },
15
- parseJson: function() {
15
+ get parseJson () {
16
16
  return parseJson;
17
17
  },
18
- readJson: function() {
18
+ get readJson () {
19
19
  return readJson;
20
20
  },
21
- tryJsonParse: function() {
21
+ get tryJsonParse () {
22
22
  return tryJsonParse;
23
23
  }
24
24
  });
@@ -12,29 +12,29 @@ Object.defineProperty(exports, "__esModule", {
12
12
  function _export(target, all) {
13
13
  for(var name in all)Object.defineProperty(target, name, {
14
14
  enumerable: true,
15
- get: all[name]
15
+ get: Object.getOwnPropertyDescriptor(all, name).get
16
16
  });
17
17
  }
18
18
  _export(exports, {
19
- ObjPath: function() {
19
+ get ObjPath () {
20
20
  return ObjPath;
21
21
  },
22
- getLastFound: function() {
22
+ get getLastFound () {
23
23
  return getLastFound;
24
24
  },
25
- mapValuesDeep: function() {
25
+ get mapValuesDeep () {
26
26
  return mapValuesDeep;
27
27
  },
28
- merge: function() {
28
+ get merge () {
29
29
  return merge;
30
30
  },
31
- omitDeep: function() {
31
+ get omitDeep () {
32
32
  return omitDeep;
33
33
  },
34
- prune: function() {
34
+ get prune () {
35
35
  return prune;
36
36
  },
37
- split: function() {
37
+ get split () {
38
38
  return split;
39
39
  }
40
40
  });
@@ -5,32 +5,32 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- MAX_PAGINATION_LIMIT: function() {
12
+ get MAX_PAGINATION_LIMIT () {
13
13
  return MAX_PAGINATION_LIMIT;
14
14
  },
15
- PageAction: function() {
15
+ get PageAction () {
16
16
  return PageAction;
17
17
  },
18
- formatPageActionPrompt: function() {
18
+ get formatPageActionPrompt () {
19
19
  return formatPageActionPrompt;
20
20
  },
21
- maybePromptPageAction: function() {
21
+ get maybePromptPageAction () {
22
22
  return maybePromptPageAction;
23
23
  },
24
- pageFlags: function() {
24
+ get pageFlags () {
25
25
  return pageFlags;
26
26
  },
27
- paramsForPageAction: function() {
27
+ get paramsForPageAction () {
28
28
  return paramsForPageAction;
29
29
  },
30
- toPageParams: function() {
30
+ get toPageParams () {
31
31
  return toPageParams;
32
32
  },
33
- validatePageActionInput: function() {
33
+ get validatePageActionInput () {
34
34
  return validatePageActionInput;
35
35
  }
36
36
  });
@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- formatErrorRespMessage: function() {
12
+ get formatErrorRespMessage () {
13
13
  return formatErrorRespMessage;
14
14
  },
15
- isSuccessResp: function() {
15
+ get isSuccessResp () {
16
16
  return isSuccessResp;
17
17
  },
18
- withSpinner: function() {
18
+ get withSpinner () {
19
19
  return withSpinner;
20
20
  }
21
21
  });
@@ -7,14 +7,14 @@ Object.defineProperty(exports, "__esModule", {
7
7
  function _export(target, all) {
8
8
  for(var name in all)Object.defineProperty(target, name, {
9
9
  enumerable: true,
10
- get: all[name]
10
+ get: Object.getOwnPropertyDescriptor(all, name).get
11
11
  });
12
12
  }
13
13
  _export(exports, {
14
- checkSlugifiedFormat: function() {
14
+ get checkSlugifiedFormat () {
15
15
  return checkSlugifiedFormat;
16
16
  },
17
- indentString: function() {
17
+ get indentString () {
18
18
  return indentString;
19
19
  }
20
20
  });
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", {
3
+ value: true
4
+ });
5
+ function _export(target, all) {
6
+ for(var name in all)Object.defineProperty(target, name, {
7
+ enumerable: true,
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
+ });
10
+ }
11
+ _export(exports, {
12
+ get getLanguageFromExtension () {
13
+ return getLanguageFromExtension;
14
+ },
15
+ get supportedExtensions () {
16
+ return supportedExtensions;
17
+ },
18
+ get transformSchema () {
19
+ return transformSchema;
20
+ }
21
+ });
22
+ const supportedExtensions = [
23
+ ".ts",
24
+ ".py",
25
+ ".go",
26
+ ".rb"
27
+ ];
28
+ function getLanguageFromExtension(extension) {
29
+ switch(extension){
30
+ case "ts":
31
+ case ".ts":
32
+ return "typescript";
33
+ case "py":
34
+ case ".py":
35
+ return "python";
36
+ case "go":
37
+ case ".go":
38
+ return "go";
39
+ case "rb":
40
+ case ".rb":
41
+ return "ruby";
42
+ default:
43
+ return undefined;
44
+ }
45
+ }
46
+ function transformSchema(schema) {
47
+ if (schema.type === "object" && !schema.additionalProperties) {
48
+ schema.additionalProperties = false;
49
+ }
50
+ var _schema_properties;
51
+ for (const key of Object.keys((_schema_properties = schema.properties) !== null && _schema_properties !== void 0 ? _schema_properties : {})){
52
+ const property = schema.properties[key];
53
+ if (property.type === "object") {
54
+ const transformedProperty = transformSchema(property);
55
+ schema.properties[key] = transformedProperty;
56
+ }
57
+ }
58
+ return schema;
59
+ }
@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- promptToConfirm: function() {
12
+ get promptToConfirm () {
13
13
  return promptToConfirm;
14
14
  },
15
- spinner: function() {
15
+ get spinner () {
16
16
  return spinner;
17
17
  }
18
18
  });
@@ -5,20 +5,20 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- emailLayoutJsonPath: function() {
12
+ get emailLayoutJsonPath () {
13
13
  return emailLayoutJsonPath;
14
14
  },
15
- ensureValidCommandTarget: function() {
15
+ get ensureValidCommandTarget () {
16
16
  return ensureValidCommandTarget;
17
17
  },
18
- isEmailLayoutDir: function() {
18
+ get isEmailLayoutDir () {
19
19
  return isEmailLayoutDir;
20
20
  },
21
- lsEmailLayoutJson: function() {
21
+ get lsEmailLayoutJson () {
22
22
  return lsEmailLayoutJson;
23
23
  }
24
24
  });
@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- LAYOUT_JSON: function() {
12
+ get LAYOUT_JSON () {
13
13
  return LAYOUT_JSON;
14
14
  },
15
- buildEmailLayoutDirBundle: function() {
15
+ get buildEmailLayoutDirBundle () {
16
16
  return buildEmailLayoutDirBundle;
17
17
  }
18
18
  });
@@ -5,14 +5,14 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- readAllForCommandTarget: function() {
12
+ get readAllForCommandTarget () {
13
13
  return readAllForCommandTarget;
14
14
  },
15
- readEmailLayoutDir: function() {
15
+ get readEmailLayoutDir () {
16
16
  return readEmailLayoutDir;
17
17
  }
18
18
  });
@@ -135,7 +135,7 @@ const readAllForCommandTarget = async (target, opts = {})=>{
135
135
  };
136
136
  const readEmailLayoutDir = async (layoutDirCtx, opts = {})=>{
137
137
  const { abspath } = layoutDirCtx;
138
- const { withExtractedFiles = false, withReadonlyField = false } = opts;
138
+ const { withExtractedFiles = false } = opts;
139
139
  const dirExists = await _fsextra.pathExists(abspath);
140
140
  if (!dirExists) throw new Error(`${abspath} does not exist`);
141
141
  const layoutJsonPath = await (0, _helpers1.lsEmailLayoutJson)(abspath);
@@ -143,7 +143,7 @@ const readEmailLayoutDir = async (layoutDirCtx, opts = {})=>{
143
143
  const result = await (0, _json.readJson)(layoutJsonPath);
144
144
  if (!result[0]) return result;
145
145
  let [layoutJson] = result;
146
- layoutJson = withReadonlyField ? layoutJson : (0, _objectisomorphic.omitDeep)(layoutJson, [
146
+ layoutJson = (0, _objectisomorphic.omitDeep)(layoutJson, [
147
147
  "__readonly"
148
148
  ]);
149
149
  return withExtractedFiles ? joinExtractedFiles(layoutDirCtx, layoutJson) : [
@@ -5,17 +5,17 @@ Object.defineProperty(exports, "__esModule", {
5
5
  function _export(target, all) {
6
6
  for(var name in all)Object.defineProperty(target, name, {
7
7
  enumerable: true,
8
- get: all[name]
8
+ get: Object.getOwnPropertyDescriptor(all, name).get
9
9
  });
10
10
  }
11
11
  _export(exports, {
12
- pruneLayoutsIndexDir: function() {
12
+ get pruneLayoutsIndexDir () {
13
13
  return pruneLayoutsIndexDir;
14
14
  },
15
- writeEmailLayoutDirFromData: function() {
15
+ get writeEmailLayoutDirFromData () {
16
16
  return writeEmailLayoutDirFromData;
17
17
  },
18
- writeEmailLayoutIndexDir: function() {
18
+ get writeEmailLayoutIndexDir () {
19
19
  return writeEmailLayoutIndexDir;
20
20
  }
21
21
  });