@contentstack/cli-cm-seed 2.0.0-beta.10 → 2.0.0-beta.12

package/README.md

@@ -10,22 +10,22 @@ To import content to your stack, you can choose from the following two sources:
 <!-- usagestop -->
 ## Commands
 <!-- commands -->
-* [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes <value>] [--alias <value>] [--locale <value>]`](#csdx-cmstacksseed---repo-value---org-value---stack-api-key-value---stack-name-value---yes-value---alias-value---locale-value)
+* [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [-y] [--alias <value>] [--locale <value>]`](#csdx-cmstacksseed---repo-value---org-value---stack-api-key-value---stack-name-value--y---alias-value---locale-value)
 
-## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes <value>] [--alias <value>] [--locale <value>]`
+## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [-y] [--alias <value>] [--locale <value>]`
 
 Create a stack from existing content types, entries, assets, etc
 
 ```
 USAGE
-  $ csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes
-    <value>] [--alias <value>] [--locale <value>]
+  $ csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [-y]
+    [--alias <value>] [--locale <value>]
 
 FLAGS
   -a, --alias=<value>          Alias of the management token
   -k, --stack-api-key=<value>  Provide stack API key to seed content to
   -n, --stack-name=<value>     Name of a new stack that needs to be created.
-  -y, --yes=<value>            [Optional] Skip the stack confirmation.
+  -y, --yes                    [Optional] Skip the stack confirmation.
       --org=<value>            Provide Organization UID to create a new stack
       --repo=<value>           GitHub organization name or GitHub user name/repository name.
 

package/lib/commands/cm/stacks/seed.js

@@ -23,7 +23,7 @@ class SeedCommand extends cli_command_1.Command {
                 stackUid: seedFlags['stack-api-key'],
                 stackName: seedFlags['stack-name'],
                 fetchLimit: seedFlags['fetch-limit'],
-                skipStackConfirmation: seedFlags['yes'],
+                skipStackConfirmation: seedFlags.yes,
                 isAuthenticated: (0, cli_utilities_1.isAuthenticated)(),
                 alias: managementTokenAlias,
                 master_locale: seedFlags['locale'],
@@ -48,7 +48,6 @@ class SeedCommand extends cli_command_1.Command {
         }
     }
 }
-exports.default = SeedCommand;
 SeedCommand.description = 'Create a stack from existing content types, entries, assets, etc';
 SeedCommand.examples = [
     '$ csdx cm:stacks:seed',
@@ -57,7 +56,7 @@ SeedCommand.examples = [
     '$ csdx cm:stacks:seed --repo "account/repository" --stack-api-key "stack-api-key" //seed content into specific stack',
     '$ csdx cm:stacks:seed --repo "account/repository" --org "your-org-uid" --stack-name "stack-name" //create a new stack in given org uid',
 ];
-SeedCommand.usage = 'cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes <value>] [--alias <value>] [--locale <value>]';
+SeedCommand.usage = 'cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [-y] [--alias <value>] [--locale <value>]';
 SeedCommand.flags = {
     repo: cli_utilities_1.flags.string({
         description: 'GitHub organization name or GitHub user name/repository name.',
@@ -85,13 +84,12 @@ SeedCommand.flags = {
         exclusive: ['stack-api-key'],
     }),
     'fetch-limit': cli_utilities_1.flags.string({
-        char: 'l',
         description: 'Limit for number of organizations or stacks to be fetched.',
         multiple: false,
         required: false,
         hidden: true,
     }),
-    yes: cli_utilities_1.flags.string({
+    yes: cli_utilities_1.flags.boolean({
         char: 'y',
         required: false,
         description: '[Optional] Skip the stack confirmation.',
@@ -102,6 +100,8 @@ SeedCommand.flags = {
     }),
     locale: cli_utilities_1.flags.string({
         description: 'Master Locale of the stack',
+        default: 'en-us',
         hidden: true,
     }),
 };
+exports.default = SeedCommand;

package/lib/seed/github/client.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Stream } from 'stream';
 export default class GitHubClient {
     username: string;
@@ -15,6 +14,7 @@ export default class GitHubClient {
     makeHeadApiCall(repo: string): Promise<any>;
     makeGetApiCall(repo: string): Promise<any>;
     checkIfRepoExists(repo: string): Promise<boolean>;
+    getMasterLocaleFromRepo(repo: string): Promise<string | null>;
     getLatestTarballUrl(repo: string): Promise<any>;
     streamRelease(url: string): Promise<Stream>;
     extract(destination: string, stream: Stream): Promise<void>;

package/lib/seed/github/client.js

@@ -100,6 +100,23 @@ class GitHubClient {
         }
         return false;
     }
+    async getMasterLocaleFromRepo(repo) {
+        var _a;
+        try {
+            const response = await this.httpClient.get(`https://raw.githubusercontent.com/${this.username}/${repo}/main/stack/locales/master-locale.json`);
+            if (response.data) {
+                const localeData = response.data;
+                const localeKey = Object.keys(localeData)[0];
+                if (localeKey && ((_a = localeData[localeKey]) === null || _a === void 0 ? void 0 : _a.code)) {
+                    return localeData[localeKey].code;
+                }
+            }
+        }
+        catch (error) {
+            console.log('Could not fetch master locale from repository', error);
+        }
+        return null;
+    }
     async getLatestTarballUrl(repo) {
         try {
             const response = await this.httpClient.get(`${this.gitHubRepoUrl}/${repo}/releases/latest`);

package/lib/seed/importer.js

@@ -1,17 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
+exports.run = run;
+const fs = require("fs");
 const process = require("process");
 const path = require("path");
 const cli_cm_import_1 = require("@contentstack/cli-cm-import");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const STACK_FOLDER = 'stack';
 async function run(options) {
-    const importPath = (0, cli_utilities_1.pathValidator)(path.resolve((0, cli_utilities_1.sanitizePath)(options.tmpPath), STACK_FOLDER));
+    const tmpPathResolved = path.resolve((0, cli_utilities_1.sanitizePath)(options.tmpPath));
+    const stackPath = path.join(tmpPathResolved, STACK_FOLDER);
+    // Support both structures: repo with stack/ folder (per docs) or content at root
+    const importPath = fs.existsSync(stackPath)
+        ? (0, cli_utilities_1.pathValidator)(stackPath)
+        : (0, cli_utilities_1.pathValidator)(tmpPathResolved);
     const args = options.alias
         ? ['-k', options.api_key, '-d', importPath, '--alias', options.alias]
         : ['-k', options.api_key, '-d', importPath];
     process.chdir(options.tmpPath);
     await cli_cm_import_1.default.run(args.concat('--skip-audit'));
 }
-exports.run = run;

package/lib/seed/index.d.ts

@@ -10,7 +10,7 @@ export interface ContentModelSeederOptions {
     stackUid: string | undefined;
     stackName: string | undefined;
     fetchLimit: string | undefined;
-    skipStackConfirmation: string | undefined;
+    skipStackConfirmation: boolean | undefined;
     isAuthenticated: boolean | false;
     managementToken?: string | undefined;
     alias?: string | undefined;

package/lib/seed/index.js

@@ -127,48 +127,18 @@ class ContentModelSeeder {
         return newStack.api_key;
     }
     async shouldProceed(api_key) {
-        let count;
         const stack_details = await this.csClient.getStack(api_key);
-        if (this.options.master_locale != stack_details.master_locale) {
-            cli_utilities_1.cliux.print(`Compass app requires the master locale to be set to English (en).`, {
-                color: "yellow",
+        const repoMasterLocale = await this.ghClient.getMasterLocaleFromRepo(this.ghRepo);
+        const expectedLocale = repoMasterLocale || this.options.master_locale || exports.ENGLISH_LOCALE;
+        if (stack_details.master_locale !== expectedLocale) {
+            cli_utilities_1.cliux.print(`Repository '${this.ghRepo}' requires the master locale to be set to '${expectedLocale}', but your stack has '${stack_details.master_locale}'.`, {
+                color: 'yellow',
                 bold: true,
             });
             return false;
         }
-        const managementBody = {
-            "name": "Checking roles for creating management token",
-            "description": "This is a compass app 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
-        };
-        let managementTokenResult = await this.csClient.createManagementToken(api_key, this.managementToken, managementBody);
-        if ((managementTokenResult === null || managementTokenResult === void 0 ? void 0 : managementTokenResult.response_code) == "161" || (managementTokenResult === null || managementTokenResult === void 0 ? void 0 : managementTokenResult.response_code) == "401") {
-            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: 'red',
-            });
-            return false;
-        }
-        count = await this.csClient.getContentTypeCount(api_key, this.managementToken);
-        if (count > 0 && this._options.skipStackConfirmation !== 'yes') {
+        const count = await this.csClient.getContentTypeCount(api_key, this.managementToken);
+        if (count > 0 && !this._options.skipStackConfirmation) {
             const proceed = await (0, interactive_1.inquireProceed)();
             if (!proceed) {
                 return false;

package/lib/seed/interactive.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.inquireStack = exports.inquireProceed = exports.inquireOrganization = exports.inquireRepo = void 0;
-const inquirer = require('inquirer');
+exports.inquireRepo = inquireRepo;
+exports.inquireOrganization = inquireOrganization;
+exports.inquireProceed = inquireProceed;
+exports.inquireStack = inquireStack;
+const inquirer_1 = require("inquirer");
 async function inquireRepo(repos) {
     if (!repos || repos.length === 0)
         throw new Error('Precondition failed: No Repositories found.');
@@ -11,7 +14,7 @@ async function inquireRepo(repos) {
     const choices = repos.map((r) => {
         return { name: formatStackName(r.name), value: extractRepoName(r.html_url) };
     });
-    const response = await inquirer.prompt([
+    const response = await inquirer_1.default.prompt([
         {
             type: 'list',
             name: 'choice',
@@ -21,7 +24,6 @@ async function inquireRepo(repos) {
     ]);
     return response;
 }
-exports.inquireRepo = inquireRepo;
 async function inquireOrganization(organizations) {
     if (!organizations || organizations.length === 0)
         throw new Error('Precondition failed: No Organizations found.');
@@ -31,7 +33,7 @@ async function inquireOrganization(organizations) {
     const choices = organizations.map((r) => {
         return { name: r.name, value: r.uid };
     });
-    const response = await inquirer.prompt([
+    const response = await inquirer_1.default.prompt([
         {
             type: 'list',
             name: 'uid',
@@ -41,9 +43,8 @@ async function inquireOrganization(organizations) {
     ]);
     return organizations.find((r) => r.uid === response.uid);
 }
-exports.inquireOrganization = inquireOrganization;
 async function inquireProceed() {
-    const createResponse = await inquirer.prompt([
+    const createResponse = await inquirer_1.default.prompt([
         {
             type: 'confirm',
             name: 'choice',
@@ -52,12 +53,11 @@ async function inquireProceed() {
     ]);
     return createResponse.choice;
 }
-exports.inquireProceed = inquireProceed;
 async function inquireStack(stacks, stackName) {
     const result = {};
     const hasStacks = stacks !== null && stacks.length > 0;
     if (hasStacks && !stackName) {
-        const createResponse = await inquirer.prompt([
+        const createResponse = await inquirer_1.default.prompt([
             {
                 type: 'list',
                 name: 'choice',
@@ -83,7 +83,7 @@ async function inquireStack(stacks, stackName) {
         if (stackName)
             result.name = stackName.trim();
         else {
-            const nameResponse = await inquirer.prompt([
+            const nameResponse = await inquirer_1.default.prompt([
                 {
                     type: 'input',
                     name: 'name',
@@ -105,7 +105,7 @@ async function inquireStack(stacks, stackName) {
             return { name: `${s.name}`, value: s.uid };
         });
         choices.sort((a, b) => (a.name > b.name ? 1 : -1));
-        const selectResponse = await inquirer.prompt([
+        const selectResponse = await inquirer_1.default.prompt([
             {
                 type: 'list',
                 name: 'uid',
@@ -120,7 +120,6 @@ async function inquireStack(stacks, stackName) {
     }
     return result;
 }
-exports.inquireStack = inquireStack;
 function formatStackName(name) {
     return name
         .replace('stack-', '')

package/oclif.manifest.json

@@ -57,7 +57,6 @@
           "type": "option"
         },
         "fetch-limit": {
-          "char": "l",
           "description": "Limit for number of organizations or stacks to be fetched.",
           "hidden": true,
           "name": "fetch-limit",
@@ -71,9 +70,8 @@
           "description": "[Optional] Skip the stack confirmation.",
           "name": "yes",
           "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+          "allowNo": false,
+          "type": "boolean"
         },
         "alias": {
           "char": "a",
@@ -87,6 +85,7 @@
           "description": "Master Locale of the stack",
           "hidden": true,
           "name": "locale",
+          "default": "en-us",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -99,7 +98,7 @@
       "pluginName": "@contentstack/cli-cm-seed",
       "pluginType": "core",
       "strict": true,
-      "usage": "cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes <value>] [--alias <value>] [--locale <value>]",
+      "usage": "cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [-y] [--alias <value>] [--locale <value>]",
       "isESM": false,
       "relativePath": [
         "lib",
@@ -110,5 +109,5 @@
       ]
     }
   },
-  "version": "2.0.0-beta.10"
+  "version": "2.0.0-beta.12"
 }

package/package.json

@@ -1,23 +1,23 @@
 {
   "name": "@contentstack/cli-cm-seed",
   "description": "create a Stack from existing content types, entries, assets, etc.",
-  "version": "2.0.0-beta.10",
+  "version": "2.0.0-beta.12",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-cm-import": "~2.0.0-beta.11",
-    "@contentstack/cli-command": "~2.0.0-beta.2",
-    "@contentstack/cli-utilities": "~2.0.0-beta.2",
-    "inquirer": "8.2.7",
+    "@contentstack/cli-cm-import": "~2.0.0-beta.13",
+    "@contentstack/cli-command": "~2.0.0-beta.4",
+    "@contentstack/cli-utilities": "~2.0.0-beta.4",
+    "inquirer": "12.11.1",
     "mkdirp": "^1.0.4",
-    "tar": "^7.5.10",
+    "tar": "^7.5.11",
     "tmp": "^0.2.5"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.9",
     "@types/jest": "^26.0.24",
     "@types/mkdirp": "^1.0.2",
-    "@types/node": "^14.18.63",
+    "@types/node": "^18.11.9",
     "@types/tar": "^6.1.13",
     "@types/tmp": "^0.2.6",
     "axios": "^1.13.5",
@@ -26,9 +26,10 @@
     "eslint-config-oclif-typescript": "^3.1.14",
     "jest": "^29.7.0",
     "oclif": "^4.17.46",
+    "@oclif/plugin-help": "^6.2.28",
     "ts-jest": "^29.4.6",
     "ts-node": "^8.10.2",
-    "typescript": "^4.9.5"
+    "typescript": "^5.9.3"
   },
   "engines": {
     "node": ">=14.0.0"
@@ -49,6 +50,9 @@
   "oclif": {
     "commands": "./lib/commands",
     "bin": "csdx",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
     "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-seed/<%- commandPath %>"
   },
   "csdxConfig": {
@@ -67,4 +71,4 @@
     "compile": "tsc -b tsconfig.json",
     "build": "pnpm compile && oclif manifest && oclif readme"
   }
-}
+}