@contentstack/cli-config 2.0.0-beta.1 → 2.0.0-beta.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 (7) hide show
  1. package/README.md +17 -13
  2. package/lib/commands/config/set/region.js +11 -0
  3. package/lib/interfaces/index.d.ts +1 -0
  4. package/lib/utils/region-handler.d.ts +1 -0
  5. package/lib/utils/region-handler.js +3 -12
  6. package/oclif.manifest.json +148 -140
  7. package/package.json +4 -4
package/README.md CHANGED
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
18
18
  $ csdx COMMAND
19
19
  running command...
20
20
  $ csdx (--version)
21
- @contentstack/cli-config/2.0.0-beta.1 linux-x64 node-v22.22.0
21
+ @contentstack/cli-config/2.0.0-beta.2 linux-x64 node-v22.22.0
22
22
  $ csdx --help [COMMAND]
23
23
  USAGE
24
24
  $ csdx COMMAND
@@ -457,23 +457,25 @@ Set region for CLI
457
457
  ```
458
458
  USAGE
459
459
  $ csdx config:set:region [REGION] [--cda <value> --cma <value> --ui-host <value> -n <value>] [--developer-hub
460
- <value>] [--personalize <value>] [--launch <value>] [--studio <value>]
460
+ <value>] [--personalize <value>] [--launch <value>] [--studio <value>] [--asset-management <value>]
461
461
 
462
462
  ARGUMENTS
463
463
  [REGION] Name for the region
464
464
 
465
465
  FLAGS
466
- -n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
467
- --cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host and
468
- name flags are required
469
- --cma=<value> Custom host to set for content management API, , if this flag is added then cda, ui-host
470
- and name flags are required
471
- --developer-hub=<value> Custom host to set for Developer hub API
472
- --launch=<value> Custom host to set for Launch API
473
- --personalize=<value> Custom host to set for Personalize API
474
- --studio=<value> Custom host to set for Studio API
475
- --ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
476
- required
466
+ -n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are
467
+ required
468
+ --asset-management=<value> Custom host to set for Asset Management API
469
+ --cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host
470
+ and name flags are required
471
+ --cma=<value> Custom host to set for content management API, , if this flag is added then cda,
472
+ ui-host and name flags are required
473
+ --developer-hub=<value> Custom host to set for Developer hub API
474
+ --launch=<value> Custom host to set for Launch API
475
+ --personalize=<value> Custom host to set for Personalize API
476
+ --studio=<value> Custom host to set for Studio API
477
+ --ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
478
+ required
477
479
 
478
480
  DESCRIPTION
479
481
  Set region for CLI
@@ -505,6 +507,8 @@ EXAMPLES
505
507
 
506
508
  $ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --studio <custom_studio_url>
507
509
 
510
+ $ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --asset-management <asset_management_url>
511
+
508
512
  $ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url>
509
513
  ```
510
514
 
package/lib/commands/config/set/region.js CHANGED
@@ -14,6 +14,7 @@ class RegionSetCommand extends base_command_1.BaseCommand {
14
14
  let personalizeUrl = regionSetFlags['personalize'];
15
15
  let launchHubUrl = regionSetFlags['launch'];
16
16
  let composableStudioUrl = regionSetFlags['studio'];
17
+ let assetManagementUrl = regionSetFlags['asset-management'];
17
18
  let selectedRegion = args.region;
18
19
  if (!(cda && cma && uiHost && name) && !selectedRegion) {
19
20
  selectedRegion = await utils_1.interactive.askRegions();
@@ -43,6 +44,9 @@ class RegionSetCommand extends base_command_1.BaseCommand {
43
44
  if (!composableStudioUrl) {
44
45
  composableStudioUrl = this.transformUrl(cma, 'composable-studio-api');
45
46
  }
47
+ if (!assetManagementUrl) {
48
+ assetManagementUrl = this.transformUrl(cma, 'am-api');
49
+ }
46
50
  let customRegion = {
47
51
  cda,
48
52
  cma,
@@ -52,6 +56,7 @@ class RegionSetCommand extends base_command_1.BaseCommand {
52
56
  personalizeUrl,
53
57
  launchHubUrl,
54
58
  composableStudioUrl,
59
+ assetManagementUrl,
55
60
  };
56
61
  customRegion = utils_1.regionHandler.setCustomRegion(customRegion);
57
62
  await cli_utilities_1.authHandler.setConfigData('logout'); //Todo: Handle this logout flow well through logout command call
@@ -63,6 +68,7 @@ class RegionSetCommand extends base_command_1.BaseCommand {
63
68
  cli_utilities_1.cliux.success(`Personalize URL: ${customRegion.personalizeUrl}`);
64
69
  cli_utilities_1.cliux.success(`Launch URL: ${customRegion.launchHubUrl}`);
65
70
  cli_utilities_1.cliux.success(`Studio URL: ${customRegion.composableStudioUrl}`);
71
+ cli_utilities_1.cliux.success(`Asset Management URL: ${customRegion.assetManagementUrl}`);
66
72
  }
67
73
  catch (error) {
68
74
  (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.contextDetails), { module: 'config-set-region' }));
@@ -79,6 +85,7 @@ class RegionSetCommand extends base_command_1.BaseCommand {
79
85
  cli_utilities_1.cliux.success(`Personalize URL: ${regionDetails.personalizeUrl}`);
80
86
  cli_utilities_1.cliux.success(`Launch URL: ${regionDetails.launchHubUrl}`);
81
87
  cli_utilities_1.cliux.success(`Studio URL: ${regionDetails.composableStudioUrl}`);
88
+ cli_utilities_1.cliux.success(`Asset Management URL: ${regionDetails.assetManagementUrl}`);
82
89
  }
83
90
  else {
84
91
  cli_utilities_1.cliux.error(`Invalid region specified.`);
@@ -126,6 +133,9 @@ RegionSetCommand.flags = {
126
133
  studio: cli_utilities_1.flags.string({
127
134
  description: 'Custom host to set for Studio API',
128
135
  }),
136
+ 'asset-management': cli_utilities_1.flags.string({
137
+ description: 'Custom host to set for Asset Management API',
138
+ }),
129
139
  };
130
140
  RegionSetCommand.examples = [
131
141
  '$ csdx config:set:region',
@@ -141,6 +151,7 @@ RegionSetCommand.examples = [
141
151
  '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --personalize <custom_personalize_url>',
142
152
  '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --launch <custom_launch_url>',
143
153
  '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --studio <custom_studio_url>',
154
+ '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --asset-management <asset_management_url>',
144
155
  '$ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url>',
145
156
  ];
146
157
  RegionSetCommand.args = {
package/lib/interfaces/index.d.ts CHANGED
@@ -17,6 +17,7 @@ export interface Region {
17
17
  personalizeUrl: string;
18
18
  launchHubUrl: string;
19
19
  composableStudioUrl: string;
20
+ assetManagementUrl?: string;
20
21
  }
21
22
  export interface Limit {
22
23
  value: number;
package/lib/utils/region-handler.d.ts CHANGED
@@ -47,6 +47,7 @@ declare class UserConfig {
47
47
  personalizeUrl: any;
48
48
  launchHubUrl: any;
49
49
  composableStudioUrl: any;
50
+ assetManagementUrl: any;
50
51
  };
51
52
  }
52
53
  export { regions };
package/lib/utils/region-handler.js CHANGED
@@ -35,6 +35,7 @@ function getRegionObject(regionKey) {
35
35
  launchHubUrl: endpoints.launch,
36
36
  personalizeUrl: endpoints.personalizeManagement,
37
37
  composableStudioUrl: endpoints.composableStudio,
38
+ assetManagementUrl: endpoints.assetManagement,
38
39
  };
39
40
  }
40
41
  catch (error) {
@@ -46,18 +47,7 @@ function getRegionObject(regionKey) {
46
47
  * This creates a regions object similar to the old hardcoded one but using @contentstack/utils
47
48
  */
48
49
  function getAvailableRegions() {
49
- const regionKeys = [
50
- 'NA',
51
- 'AWS-NA',
52
- 'EU',
53
- 'AWS-EU',
54
- 'AU',
55
- 'AWS-AU',
56
- 'AZURE-NA',
57
- 'AZURE-EU',
58
- 'GCP-NA',
59
- 'GCP-EU',
60
- ];
50
+ const regionKeys = ['NA', 'AWS-NA', 'EU', 'AWS-EU', 'AU', 'AWS-AU', 'AZURE-NA', 'AZURE-EU', 'GCP-NA', 'GCP-EU'];
61
51
  const regions = {};
62
52
  for (const key of regionKeys) {
63
53
  const regionObj = getRegionObject(key);
@@ -151,6 +141,7 @@ class UserConfig {
151
141
  personalizeUrl: regionObject['personalizeUrl'],
152
142
  launchHubUrl: regionObject['launchHubUrl'],
153
143
  composableStudioUrl: regionObject['composableStudioUrl'],
144
+ assetManagementUrl: regionObject['assetManagementUrl'],
154
145
  };
155
146
  return sanitizedRegion;
156
147
  }
package/oclif.manifest.json CHANGED
@@ -146,145 +146,6 @@
146
146
  "region.js"
147
147
  ]
148
148
  },
149
- "config:remove:base-branch": {
150
- "aliases": [],
151
- "args": {},
152
- "description": "Remove branch config for CLI",
153
- "examples": [
154
- "$ csdx config:remove:base-branch",
155
- "$ csdx config:remove:base-branch --stack-api-key <value>"
156
- ],
157
- "flags": {
158
- "stack-api-key": {
159
- "char": "k",
160
- "description": "Stack API key.",
161
- "name": "stack-api-key",
162
- "hasDynamicHelp": false,
163
- "multiple": false,
164
- "type": "option"
165
- },
166
- "yes": {
167
- "char": "y",
168
- "description": "Force remove.",
169
- "name": "yes",
170
- "allowNo": false,
171
- "type": "boolean"
172
- }
173
- },
174
- "hasDynamicHelp": false,
175
- "hiddenAliases": [],
176
- "id": "config:remove:base-branch",
177
- "pluginAlias": "@contentstack/cli-config",
178
- "pluginName": "@contentstack/cli-config",
179
- "pluginType": "core",
180
- "strict": true,
181
- "isESM": false,
182
- "relativePath": [
183
- "lib",
184
- "commands",
185
- "config",
186
- "remove",
187
- "base-branch.js"
188
- ]
189
- },
190
- "config:remove:early-access-header": {
191
- "aliases": [
192
- "config:remove:ea-header"
193
- ],
194
- "args": {},
195
- "description": "Remove Early Access header",
196
- "examples": [
197
- "$ <%= config.bin %> <%= command.id %>",
198
- "$ <%= config.bin %> <%= command.id %> --header-alias <value>"
199
- ],
200
- "flags": {
201
- "header-alias": {
202
- "description": "(optional) Provide the Early Access header alias name.",
203
- "name": "header-alias",
204
- "hasDynamicHelp": false,
205
- "multiple": false,
206
- "type": "option"
207
- },
208
- "yes": {
209
- "char": "y",
210
- "description": "(optional) Force the removal of Early Access header configuration by skipping the confirmation.",
211
- "name": "yes",
212
- "allowNo": false,
213
- "type": "boolean"
214
- }
215
- },
216
- "hasDynamicHelp": false,
217
- "hiddenAliases": [],
218
- "id": "config:remove:early-access-header",
219
- "pluginAlias": "@contentstack/cli-config",
220
- "pluginName": "@contentstack/cli-config",
221
- "pluginType": "core",
222
- "strict": true,
223
- "isESM": false,
224
- "relativePath": [
225
- "lib",
226
- "commands",
227
- "config",
228
- "remove",
229
- "early-access-header.js"
230
- ]
231
- },
232
- "config:remove:proxy": {
233
- "aliases": [],
234
- "args": {},
235
- "description": "Remove proxy configuration from global config",
236
- "examples": [
237
- "csdx config:remove:proxy"
238
- ],
239
- "flags": {},
240
- "hasDynamicHelp": false,
241
- "hiddenAliases": [],
242
- "id": "config:remove:proxy",
243
- "pluginAlias": "@contentstack/cli-config",
244
- "pluginName": "@contentstack/cli-config",
245
- "pluginType": "core",
246
- "strict": true,
247
- "isESM": false,
248
- "relativePath": [
249
- "lib",
250
- "commands",
251
- "config",
252
- "remove",
253
- "proxy.js"
254
- ]
255
- },
256
- "config:remove:rate-limit": {
257
- "aliases": [],
258
- "args": {},
259
- "description": "Remove rate-limit of the organization",
260
- "examples": [
261
- "$ csdx config:remove:rate-limit --org <<org_uid>>"
262
- ],
263
- "flags": {
264
- "org": {
265
- "description": "Provide the organization UID",
266
- "name": "org",
267
- "hasDynamicHelp": false,
268
- "multiple": false,
269
- "type": "option"
270
- }
271
- },
272
- "hasDynamicHelp": false,
273
- "hiddenAliases": [],
274
- "id": "config:remove:rate-limit",
275
- "pluginAlias": "@contentstack/cli-config",
276
- "pluginName": "@contentstack/cli-config",
277
- "pluginType": "core",
278
- "strict": true,
279
- "isESM": false,
280
- "relativePath": [
281
- "lib",
282
- "commands",
283
- "config",
284
- "remove",
285
- "rate-limit.js"
286
- ]
287
- },
288
149
  "config:set:base-branch": {
289
150
  "aliases": [],
290
151
  "args": {},
@@ -567,6 +428,7 @@
567
428
  "$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name \"India\" --personalize <custom_personalize_url>",
568
429
  "$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name \"India\" --launch <custom_launch_url>",
569
430
  "$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name \"India\" --studio <custom_studio_url>",
431
+ "$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name \"India\" --asset-management <asset_management_url>",
570
432
  "$ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name \"India\" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url>"
571
433
  ],
572
434
  "flags": {
@@ -646,6 +508,13 @@
646
508
  "hasDynamicHelp": false,
647
509
  "multiple": false,
648
510
  "type": "option"
511
+ },
512
+ "asset-management": {
513
+ "description": "Custom host to set for Asset Management API",
514
+ "name": "asset-management",
515
+ "hasDynamicHelp": false,
516
+ "multiple": false,
517
+ "type": "option"
649
518
  }
650
519
  },
651
520
  "hasDynamicHelp": false,
@@ -663,7 +532,146 @@
663
532
  "set",
664
533
  "region.js"
665
534
  ]
535
+ },
536
+ "config:remove:base-branch": {
537
+ "aliases": [],
538
+ "args": {},
539
+ "description": "Remove branch config for CLI",
540
+ "examples": [
541
+ "$ csdx config:remove:base-branch",
542
+ "$ csdx config:remove:base-branch --stack-api-key <value>"
543
+ ],
544
+ "flags": {
545
+ "stack-api-key": {
546
+ "char": "k",
547
+ "description": "Stack API key.",
548
+ "name": "stack-api-key",
549
+ "hasDynamicHelp": false,
550
+ "multiple": false,
551
+ "type": "option"
552
+ },
553
+ "yes": {
554
+ "char": "y",
555
+ "description": "Force remove.",
556
+ "name": "yes",
557
+ "allowNo": false,
558
+ "type": "boolean"
559
+ }
560
+ },
561
+ "hasDynamicHelp": false,
562
+ "hiddenAliases": [],
563
+ "id": "config:remove:base-branch",
564
+ "pluginAlias": "@contentstack/cli-config",
565
+ "pluginName": "@contentstack/cli-config",
566
+ "pluginType": "core",
567
+ "strict": true,
568
+ "isESM": false,
569
+ "relativePath": [
570
+ "lib",
571
+ "commands",
572
+ "config",
573
+ "remove",
574
+ "base-branch.js"
575
+ ]
576
+ },
577
+ "config:remove:early-access-header": {
578
+ "aliases": [
579
+ "config:remove:ea-header"
580
+ ],
581
+ "args": {},
582
+ "description": "Remove Early Access header",
583
+ "examples": [
584
+ "$ <%= config.bin %> <%= command.id %>",
585
+ "$ <%= config.bin %> <%= command.id %> --header-alias <value>"
586
+ ],
587
+ "flags": {
588
+ "header-alias": {
589
+ "description": "(optional) Provide the Early Access header alias name.",
590
+ "name": "header-alias",
591
+ "hasDynamicHelp": false,
592
+ "multiple": false,
593
+ "type": "option"
594
+ },
595
+ "yes": {
596
+ "char": "y",
597
+ "description": "(optional) Force the removal of Early Access header configuration by skipping the confirmation.",
598
+ "name": "yes",
599
+ "allowNo": false,
600
+ "type": "boolean"
601
+ }
602
+ },
603
+ "hasDynamicHelp": false,
604
+ "hiddenAliases": [],
605
+ "id": "config:remove:early-access-header",
606
+ "pluginAlias": "@contentstack/cli-config",
607
+ "pluginName": "@contentstack/cli-config",
608
+ "pluginType": "core",
609
+ "strict": true,
610
+ "isESM": false,
611
+ "relativePath": [
612
+ "lib",
613
+ "commands",
614
+ "config",
615
+ "remove",
616
+ "early-access-header.js"
617
+ ]
618
+ },
619
+ "config:remove:proxy": {
620
+ "aliases": [],
621
+ "args": {},
622
+ "description": "Remove proxy configuration from global config",
623
+ "examples": [
624
+ "csdx config:remove:proxy"
625
+ ],
626
+ "flags": {},
627
+ "hasDynamicHelp": false,
628
+ "hiddenAliases": [],
629
+ "id": "config:remove:proxy",
630
+ "pluginAlias": "@contentstack/cli-config",
631
+ "pluginName": "@contentstack/cli-config",
632
+ "pluginType": "core",
633
+ "strict": true,
634
+ "isESM": false,
635
+ "relativePath": [
636
+ "lib",
637
+ "commands",
638
+ "config",
639
+ "remove",
640
+ "proxy.js"
641
+ ]
642
+ },
643
+ "config:remove:rate-limit": {
644
+ "aliases": [],
645
+ "args": {},
646
+ "description": "Remove rate-limit of the organization",
647
+ "examples": [
648
+ "$ csdx config:remove:rate-limit --org <<org_uid>>"
649
+ ],
650
+ "flags": {
651
+ "org": {
652
+ "description": "Provide the organization UID",
653
+ "name": "org",
654
+ "hasDynamicHelp": false,
655
+ "multiple": false,
656
+ "type": "option"
657
+ }
658
+ },
659
+ "hasDynamicHelp": false,
660
+ "hiddenAliases": [],
661
+ "id": "config:remove:rate-limit",
662
+ "pluginAlias": "@contentstack/cli-config",
663
+ "pluginName": "@contentstack/cli-config",
664
+ "pluginType": "core",
665
+ "strict": true,
666
+ "isESM": false,
667
+ "relativePath": [
668
+ "lib",
669
+ "commands",
670
+ "config",
671
+ "remove",
672
+ "rate-limit.js"
673
+ ]
666
674
  }
667
675
  },
668
- "version": "2.0.0-beta.1"
676
+ "version": "2.0.0-beta.2"
669
677
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@contentstack/cli-config",
3
3
  "description": "Contentstack CLI plugin for configuration",
4
- "version": "2.0.0-beta.1",
4
+ "version": "2.0.0-beta.2",
5
5
  "author": "Contentstack",
6
6
  "scripts": {
7
7
  "build": "npm run clean && npm run compile",
@@ -22,9 +22,9 @@
22
22
  },
23
23
  "dependencies": {
24
24
  "@contentstack/cli-command": "~2.0.0-beta",
25
- "@contentstack/cli-utilities": "~2.0.0-beta",
25
+ "@contentstack/cli-utilities": "~2.0.0-beta.1",
26
26
  "@contentstack/utils": "~1.7.0",
27
- "@oclif/core": "^4.3.0",
27
+ "@oclif/core": "^4.8.1",
28
28
  "@oclif/plugin-help": "^6.2.28",
29
29
  "lodash": "^4.17.23"
30
30
  },
@@ -81,4 +81,4 @@
81
81
  }
82
82
  },
83
83
  "repository": "contentstack/cli"
84
- }
84
+ }