@contentstack/cli-cm-bootstrap 1.9.3 → 1.10.0

package/README.md

@@ -15,7 +15,7 @@ $ npm install -g @contentstack/cli-cm-bootstrap
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-bootstrap/1.9.3 linux-x64 node-v18.20.3
+@contentstack/cli-cm-bootstrap/1.10.0 linux-x64 node-v18.20.4
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/bootstrap/index.d.ts

@@ -9,6 +9,7 @@ export interface BootstrapOptions {
     accessToken?: string;
     appType: string;
     livePreviewEnabled?: boolean;
+    master_locale: any;
 }
 export interface SeedParams {
     stackAPIKey?: string;

package/lib/bootstrap/index.js

@@ -64,6 +64,9 @@ class Bootstrap {
             if (this.options.seedParams.managementTokenAlias) {
                 cmd.push('--alias', this.options.seedParams.managementTokenAlias);
             }
+            if (this.options.master_locale) {
+                cmd.push('--locale', this.options.master_locale);
+            }
             const result = await seed_1.default.run(cmd);
             if (result && result.api_key) {
                 await (0, utils_1.setupEnvironments)(this.managementAPIClient, result.api_key, this.appConfig, this.cloneDirectory, this.region, this.options.livePreviewEnabled, this.options.seedParams.managementToken);

package/lib/bootstrap/utils.d.ts

@@ -1,8 +1,2 @@
 import { AppConfig } from '../config';
-/**
- * @description Setup the environment for a given app for each environment
- * Loads the environments for a given stack
- * Create delivery token
- * Create enviroment
- */
 export declare const setupEnvironments: (managementAPIClient: any, api_key: string, appConfig: AppConfig, clonedDirectory: string, region: any, livePreviewEnabled: boolean, managementToken?: string) => Promise<void>;

package/lib/bootstrap/utils.js

@@ -12,6 +12,7 @@ const messages_1 = require("../messages");
  * Create delivery token
  * Create enviroment
  */
+let managementTokenResult;
 const setupEnvironments = async (managementAPIClient, api_key, appConfig, clonedDirectory, region, livePreviewEnabled, managementToken) => {
     var _a, _b;
     const environmentResult = await managementAPIClient
@@ -19,6 +20,47 @@ const setupEnvironments = async (managementAPIClient, api_key, appConfig, cloned
         .environment()
         .query()
         .find();
+    //create management token if not present
+    if (!managementToken) {
+        const managementBody = {
+            "token": {
+                "name": "sample app",
+                "description": "This is a sample management token.",
+                "scope": [
+                    {
+                        "module": "content_type",
+                        "acl": {
+                            "read": true,
+                            "write": true
+                        }
+                    },
+                    {
+                        "module": "branch",
+                        "branches": [
+                            "main"
+                        ],
+                        "acl": {
+                            "read": true
+                        }
+                    }
+                ],
+                "expires_on": "3000-01-01",
+                "is_email_notification_enabled": false
+            }
+        };
+        managementTokenResult = await managementAPIClient
+            .stack({ api_key: api_key })
+            .managementToken()
+            .create(managementBody);
+        if (!managementTokenResult.uid) {
+            cli_utilities_1.cliux.print(`Info: Failed to generate a management token.\nNote: Management token is not available in your plan. Please contact the admin for support.`, {
+                color: 'yellow',
+            });
+            if ((await (0, interactive_1.continueBootstrapCommand)()) === 'no') {
+                return;
+            }
+        }
+    }
     if (Array.isArray(environmentResult.items) && environmentResult.items.length > 0) {
         for (const environment of environmentResult.items) {
             if (environment.name) {
@@ -104,7 +146,7 @@ const writeEnvFile = (content, fileName) => {
  * TBD: moving the content to config file
  */
 const envFileHandler = async (appConfigKey, environmentVariables, clonedDirectory, region, livePreviewEnabled) => {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f;
     if (!appConfigKey || !environmentVariables) {
         return;
     }
@@ -118,10 +160,11 @@ const envFileHandler = async (appConfigKey, environmentVariables, clonedDirector
     const managementAPIHost = (_a = region === null || region === void 0 ? void 0 : region.cma) === null || _a === void 0 ? void 0 : _a.substring('8');
     const regionName = region && region.name && region.name.toLowerCase();
     previewHost = (_c = (_b = region === null || region === void 0 ? void 0 : region.uiHost) === null || _b === void 0 ? void 0 : _b.substring(8)) === null || _c === void 0 ? void 0 : _c.replace('app', 'rest-preview');
-    appHost = (_d = region === null || region === void 0 ? void 0 : region.uiHost) === null || _d === void 0 ? void 0 : _d.substring(8);
+    const cdnHost = (_d = region === null || region === void 0 ? void 0 : region.cda) === null || _d === void 0 ? void 0 : _d.substring('8');
+    appHost = (_e = region === null || region === void 0 ? void 0 : region.uiHost) === null || _e === void 0 ? void 0 : _e.substring(8);
     const isUSRegion = regionName === 'us' || regionName === 'na';
     if (regionName !== 'eu' && !isUSRegion) {
-        customHost = (_e = region === null || region === void 0 ? void 0 : region.cma) === null || _e === void 0 ? void 0 : _e.substring(8);
+        customHost = (_f = region === null || region === void 0 ? void 0 : region.cma) === null || _f === void 0 ? void 0 : _f.substring(8);
     }
     const production = environmentVariables.environment === 'production' ? true : false;
     switch (appConfigKey) {
@@ -143,6 +186,13 @@ const envFileHandler = async (appConfigKey, environmentVariables, clonedDirector
                 : '\n'}CONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}\nCONTENTSTACK_API_HOST=${customHost ? customHost : managementAPIHost}${!isUSRegion && !customHost ? '\nCONTENTSTACK_REGION=' + region.name : ''}\nCONTENTSTACK_LIVE_PREVIEW=${livePreviewEnabled}\nCONTENTSTACK_LIVE_EDIT_TAGS=false`;
             result = await writeEnvFile(content, filePath);
             break;
+        case 'compass-app':
+            fileName = '.env';
+            filePath = (0, cli_utilities_1.pathValidator)(path.join((0, cli_utilities_1.sanitizePath)(clonedDirectory), (0, cli_utilities_1.sanitizePath)(fileName)));
+            content = `CONTENTSTACK_API_KEY=${environmentVariables.api_key}\nCONTENTSTACK_DELIVERY_TOKEN=${environmentVariables.deliveryToken}\nCONTENTSTACK_BRANCH=main${livePreviewEnabled
+                ? `\nCONTENTSTACK_PREVIEW_TOKEN=${environmentVariables.preview_token || `''`}\nCONTENTSTACK_PREVIEW_HOST=${previewHost}\n`
+                : '\n'}CONTENTSTACK_ENVIRONMENT=${environmentVariables.environment}${!isUSRegion && !customHost ? '\nCONTENTSTACK_REGION=' + region.name : ''}\nCONTENTSTACK_LIVE_PREVIEW=${livePreviewEnabled}\nCONTENTSTACK_LIVE_EDIT_TAGS=false\nCONTENTSTACK_API_HOST=${customHost ? customHost : managementAPIHost}${!isUSRegion && !customHost ? '\nCONTENTSTACK_REGION=' + region.name : ''}\nCONTENTSTACK_APP_HOST=${appHost}\nCONTENTSTACK_MANAGEMENT_TOKEN=${managementTokenResult.uid}\nCONTENTSTACK_HOST=${cdnHost}`;
+            result = await writeEnvFile(content, filePath);
         case 'gatsby':
         case 'gatsby-starter':
             fileName = `.env.${environmentVariables.environment}`;

package/lib/commands/cm/bootstrap.d.ts

@@ -1,5 +1,6 @@
 import { Command } from '@contentstack/cli-command';
 import { FlagInput } from '@contentstack/cli-utilities';
+export declare const DEFAULT_MASTER_LOCALE = "en-us";
 export default class BootstrapCommand extends Command {
     private bootstrapManagementAPIClient;
     static description: string;

package/lib/commands/cm/bootstrap.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_MASTER_LOCALE = void 0;
 const cli_command_1 = require("@contentstack/cli-command");
 const path_1 = require("path");
 const bootstrap_1 = require("../../bootstrap");
@@ -7,6 +8,7 @@ const interactive_1 = require("../../bootstrap/interactive");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const config_1 = require("../../config");
 const messages_1 = require("../../messages");
+exports.DEFAULT_MASTER_LOCALE = 'en-us';
 class BootstrapCommand extends cli_command_1.Command {
     async run() {
         const { flags: bootstrapCommandFlags } = await this.parse(BootstrapCommand);
@@ -46,6 +48,7 @@ class BootstrapCommand extends cli_command_1.Command {
             }
             const yes = bootstrapCommandFlags.yes;
             const appConfig = (0, config_1.getAppLevelConfigByName)(selectedAppName || selectedApp.configKey);
+            let master_locale = appConfig.master_locale || exports.DEFAULT_MASTER_LOCALE;
             let cloneDirectory = bootstrapCommandFlags.directory || bootstrapCommandFlags['project-dir'];
             if (!cloneDirectory) {
                 cloneDirectory = await (0, interactive_1.inquireCloneDirectory)();
@@ -79,6 +82,7 @@ class BootstrapCommand extends cli_command_1.Command {
                 region: this.region,
                 appType,
                 livePreviewEnabled,
+                master_locale,
             };
             const bootstrap = new bootstrap_1.default(options);
             await bootstrap.run();

package/lib/config.d.ts

@@ -9,6 +9,7 @@ export interface AppConfig {
     private?: boolean;
     branch?: string;
     appConfigKey?: string;
+    master_locale?: string;
 }
 declare const config: Configuration;
 export default config;

package/lib/config.js

@@ -18,6 +18,7 @@ const config = {
         { displayName: 'Vue JS', configKey: 'vue-starter' },
         { displayName: 'Stencil', configKey: 'stencil-starter' },
         { displayName: 'Nuxt3', configKey: 'nuxt3-starter' },
+        // { displayName: 'Compass App', configKey: 'compass-app' }
     ],
     appLevelConfig: {
         nextjs: {
@@ -36,6 +37,11 @@ const config = {
             source: 'contentstack/contentstack-angular-modularblock-example',
             stack: 'contentstack/stack-contentstack-angular-modularblock-example',
         },
+        'compass-app': {
+            source: 'contentstack/contentstack-universal-demo',
+            stack: 'contentstack/stack-contentstack-universal-demo',
+            master_locale: 'en',
+        },
         'nuxtjs-disabled': {
             source: 'contentstack/contentstack-nuxtjs-vue-universal-demo',
             stack: 'shafeeqd959/stack-contentstack-nuxtjs-vue-universal-demo',

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.9.3",
+  "version": "1.10.0",
   "commands": {
     "cm:bootstrap": {
       "id": "cm:bootstrap",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-cm-bootstrap",
   "description": "Bootstrap contentstack apps",
-  "version": "1.9.3",
+  "version": "1.10.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "scripts": {
@@ -17,9 +17,9 @@
     "test:report": "nyc --reporter=lcov mocha \"test/**/*.test.js\""
   },
   "dependencies": {
-    "@contentstack/cli-cm-seed": "~1.7.5",
-    "@contentstack/cli-command": "~1.2.18",
-    "@contentstack/cli-utilities": "~1.6.2",
+    "@contentstack/cli-cm-seed": "~1.7.6",
+    "@contentstack/cli-command": "~1.2.19",
+    "@contentstack/cli-utilities": "~1.7.1",
     "inquirer": "8.2.4",
     "mkdirp": "^1.0.4",
     "tar": "^6.2.1 "