@contentstack/cli-cm-seed 1.1.5 → 1.2.0

package/README.md

@@ -11,6 +11,7 @@ To import content to your stack, you can choose from the following two sources:
 ## Commands
 <!-- commands -->
 * [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value)
+* [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value-1)
 
 ## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]`
 
@@ -20,24 +21,64 @@ Create a stack from existing content types, entries, assets, etc
 USAGE
   $ csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]
 
-OPTIONS
-  -k, --stack-api-key=stack-api-key  Provide stack api key to seed content to
-  -n, --stack-name=stack-name        Name of a new stack that needs to be created.
-  -o, --org=org                      Provide Organization UID to create a new stack
-  -r, --repo=repo                    GitHub account or GitHub account/repository
-  -s, --stack=stack                  Provide stack UID to seed content to
-  -y, --yes=yes                      [Optional] Skip stack confirmation
+FLAGS
+  -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.
+  -o, --org=<value>            Provide Organization UID to create a new stack
+  -r, --repo=<value>           GitHub account or GitHub account/repository
+  -s, --stack=<value>          Provide stack UID to seed content to
+  -y, --yes=<value>            [Optional] Skip stack confirmation
+
+DESCRIPTION
+  Create a stack from existing content types, entries, assets, etc
 
 ALIASES
   $ csdx cm:seed
 
 EXAMPLES
   $ csdx cm:stacks:seed
+
   $ csdx cm:stacks:seed --repo "account"
+
   $ csdx cm:stacks:seed --repo "account/repository"
+
   $ 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
+
+  $ csdx cm:stacks:seed --repo "account/repository" --org "your-org-uid" --stack-name "stack-name" //create a new stack in given org uid
+```
+
+## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]`
+
+Create a stack from existing content types, entries, assets, etc
+
+```
+USAGE
+  $ csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]
+
+FLAGS
+  -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.
+  -o, --org=<value>            Provide Organization UID to create a new stack
+  -r, --repo=<value>           GitHub account or GitHub account/repository
+  -s, --stack=<value>          Provide stack UID to seed content to
+  -y, --yes=<value>            [Optional] Skip stack confirmation
+
+DESCRIPTION
+  Create a stack from existing content types, entries, assets, etc
+
+ALIASES
+  $ csdx cm:seed
+
+EXAMPLES
+  $ csdx cm:stacks:seed
+
+  $ csdx cm:stacks:seed --repo "account"
+
+  $ csdx cm:stacks:seed --repo "account/repository"
+
+  $ 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
 ```
 
 _See code: [src/commands/cm/stacks/seed.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-seed/src/commands/cm/stacks/seed.ts)_

package/lib/commands/cm/stacks/seed.d.ts

@@ -1,16 +1,16 @@
-import { Command, flags } from '@contentstack/cli-command';
+import { Command } from '@contentstack/cli-command';
 export default class SeedCommand extends Command {
     static description: string;
     static examples: string[];
     static usage: string;
     static flags: {
-        repo: flags.IOptionFlag<string | undefined>;
-        org: flags.IOptionFlag<string | undefined>;
-        'stack-api-key': flags.IOptionFlag<string | undefined>;
-        'stack-name': flags.IOptionFlag<string | undefined>;
-        'fetch-limit': flags.IOptionFlag<string | undefined>;
-        yes: flags.IOptionFlag<string | undefined>;
-        stack: flags.IOptionFlag<string | undefined>;
+        repo: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        org: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'stack-api-key': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'stack-name': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'fetch-limit': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        yes: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        stack: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
     };
     static aliases: string[];
     run(): Promise<{

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

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const cli_command_1 = require("@contentstack/cli-command");
-const seed_1 = require("../../../seed");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
+const seed_1 = require("../../../seed");
 class SeedCommand extends cli_command_1.Command {
     async run() {
         try {
-            const { flags: seedFlags } = this.parse(SeedCommand);
+            const { flags: seedFlags } = await this.parse(SeedCommand);
             if (!this.authToken) {
                 this.error('You need to login, first. See: auth:login --help', {
                     exit: 2,

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

@@ -1,4 +1,4 @@
-import { AxiosInstance } from 'axios';
+import * as ContentstackManagementSDK from '@contentstack/management';
 export interface Organization {
     uid: string;
     name: string;
@@ -18,13 +18,13 @@ export interface CreateStackOptions {
     org_uid: string;
 }
 export default class ContentstackClient {
-    instance: AxiosInstance;
+    instance: Promise<ContentstackManagementSDK.ContentstackClient>;
     limit: number;
-    constructor(cmaHost: string, authToken: string, limit: number);
+    constructor(cmaHost: string, limit: number);
     getOrganization(org_uid: string): Promise<Organization>;
-    getOrganizations(): Promise<Organization[]>;
+    getOrganizations(skip?: number, organizations?: Organization[]): Promise<Organization[]>;
     getStack(stackUID: string): Promise<Stack>;
-    getStacks(org_uid: string): Promise<Stack[]>;
+    getStacks(org_uid: string, skip?: number, stacks?: Stack[]): Promise<Stack[]>;
     getContentTypeCount(api_key: string): Promise<number>;
     createStack(options: CreateStackOptions): Promise<Stack>;
     private buildError;

package/lib/seed/contentstack/client.js

@@ -1,46 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const axios = require('axios');
 const error_1 = require("./error");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
 class ContentstackClient {
-    constructor(cmaHost, authToken, limit) {
-        this.instance = axios.create({
-            baseURL: `https://${cmaHost}/v3/`,
-            headers: {
-                authtoken: authToken,
-            },
-        });
+    constructor(cmaHost, limit) {
+        this.instance = (0, cli_utilities_1.managementSDKClient)({ host: cmaHost });
         this.limit = limit || 100;
     }
     async getOrganization(org_uid) {
         try {
-            const response = await this.instance.get(`/organizations/${org_uid}`);
-            const o = response.data.organization;
+            const client = await this.instance;
+            const response = await client.organization(org_uid).fetch();
             return {
-                uid: o.uid,
-                name: o.name,
-                enabled: o.enabled,
+                uid: response.uid,
+                name: response.name,
+                enabled: response.enabled,
             };
         }
         catch (error) {
             throw this.buildError(error);
         }
     }
-    async getOrganizations() {
+    async getOrganizations(skip = 0, organizations = []) {
         try {
-            const response = await this.instance.get('/organizations', {
-                params: {
-                    asc: 'name',
-                    limit: this.limit,
-                },
-            });
-            return response.data.organizations.map((o) => {
+            const client = await this.instance;
+            const response = await client.organization().fetchAll({ limit: this.limit, asc: 'name', include_count: true, skip: skip });
+            organizations = organizations.concat(response.items.map((o) => {
                 return {
                     uid: o.uid,
                     name: o.name,
                     enabled: o.enabled,
                 };
-            });
+            }));
+            if (organizations.length < response.count) {
+                organizations = await this.getOrganizations(skip + this.limit);
+            }
+            return organizations;
         }
         catch (error) {
             throw this.buildError(error);
@@ -48,30 +43,25 @@ class ContentstackClient {
     }
     async getStack(stackUID) {
         try {
-            const response = await this.instance.get('/stacks', {
-                headers: { api_key: stackUID },
-            });
-            const s = response.data.stack;
+            const client = await this.instance;
+            const response = await client.stack({ api_key: stackUID }).fetch();
             return {
-                uid: s.uid,
-                name: s.name,
-                master_locale: s.master_locale,
-                api_key: s.api_key,
-                org_uid: s.org_uid,
+                uid: response.uid,
+                name: response.name,
+                master_locale: response.master_locale,
+                api_key: response.api_key,
+                org_uid: response.org_uid,
             };
         }
         catch (error) {
             throw this.buildError(error);
         }
     }
-    async getStacks(org_uid) {
+    async getStacks(org_uid, skip = 0, stacks = []) {
         try {
-            const response = await this.instance.get('/stacks', {
-                params: {
-                    organization_uid: org_uid,
-                },
-            });
-            return response.data.stacks.map((s) => {
+            const client = await this.instance;
+            const response = await client.organization(org_uid).stacks({ limit: this.limit, include_count: true, skip: skip });
+            stacks = stacks.concat(response.items.map((s) => {
                 return {
                     uid: s.uid,
                     name: s.name,
@@ -79,7 +69,11 @@ class ContentstackClient {
                     api_key: s.api_key,
                     org_uid: s.org_uid,
                 };
-            });
+            }));
+            if (stacks.length < response.count) {
+                stacks = await this.getStacks(org_uid, skip + this.limit, stacks);
+            }
+            return stacks;
         }
         catch (error) {
             throw this.buildError(error);
@@ -87,14 +81,9 @@ class ContentstackClient {
     }
     async getContentTypeCount(api_key) {
         try {
-            const response = await this.instance.get('/content_types', {
-                params: {
-                    api_key: api_key,
-                    include_count: true,
-                },
-                headers: { api_key },
-            });
-            return response.data.count;
+            const client = await this.instance;
+            const response = await client.stack({ api_key: api_key }).contentType().query({ include_count: true }).find();
+            return response.count;
         }
         catch (error) {
             throw this.buildError(error);
@@ -102,6 +91,7 @@ class ContentstackClient {
     }
     async createStack(options) {
         try {
+            const client = await this.instance;
             const body = {
                 stack: {
                     name: options.name,
@@ -109,19 +99,13 @@ class ContentstackClient {
                     master_locale: options.master_locale,
                 },
             };
-            const response = await this.instance.post('/stacks', body, {
-                headers: {
-                    'Content-Type': 'application/json',
-                    organization_uid: options.org_uid,
-                },
-            });
-            const stack = response.data.stack;
+            const response = await client.stack().create(body, { organization_uid: options.org_uid });
             return {
-                uid: stack.uid,
-                api_key: stack.api_key,
-                master_locale: stack.master_locale,
-                name: stack.name,
-                org_uid: stack.org_uid,
+                uid: response.uid,
+                api_key: response.api_key,
+                master_locale: response.master_locale,
+                name: response.name,
+                org_uid: response.org_uid,
             };
         }
         catch (error) {

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

@@ -13,6 +13,7 @@ export default class GitHubClient {
     getAllRepos(count?: number): Promise<any>;
     getLatest(repo: string, destination: string): Promise<void>;
     makeHeadApiCall(repo: string): Promise<any>;
+    makeGetApiCall(repo: string): Promise<any>;
     checkIfRepoExists(repo: string): Promise<boolean>;
     getLatestTarballUrl(repo: string): Promise<any>;
     streamRelease(url: string): Promise<Stream>;

package/lib/seed/github/client.js

@@ -54,6 +54,34 @@ class GitHubClient {
             https.request(options, resolve).on('error', reject).end();
         });
     }
+    makeGetApiCall(repo) {
+        return new Promise((resolve, reject) => {
+            const { host, pathname } = new URL(this.gitHubRepoUrl);
+            const options = {
+                host,
+                method: 'GET',
+                path: `${pathname}/${repo}/contents`,
+                headers: { 'user-agent': 'node.js' },
+            };
+            https.request(options, (response) => {
+                let responseBody = '';
+                const data = { statusCode: response.statusCode, };
+                if (data.statusCode === 403) {
+                    const xRateLimitReset = response.rawHeaders[response.rawHeaders.indexOf('X-RateLimit-Reset') + 1];
+                    const startDate = (new Date()).getTime() / 1000;
+                    const diffInSeconds = Number(xRateLimitReset) - startDate;
+                    data.statusMessage = `Exceeded requests limit. Please try again after ${(diffInSeconds / 60).toFixed(1)} minutes.`;
+                }
+                response.on('data', (chunk) => {
+                    responseBody += chunk.toString();
+                });
+                response.on('end', () => {
+                    const body = JSON.parse(responseBody);
+                    resolve(Object.assign(Object.assign({}, data), { data: body }));
+                });
+            }).on('error', reject).end();
+        });
+    }
     async checkIfRepoExists(repo) {
         try {
             /**

package/lib/seed/index.js

@@ -25,7 +25,7 @@ class ContentModelSeeder {
         this.ghUsername = gh.username || DEFAULT_OWNER;
         this.ghRepo = gh.repo;
         const limit = Number(this.options.fetchLimit);
-        this.csClient = new client_1.default(options.cmaHost, options.authToken, limit);
+        this.csClient = new client_1.default(options.cmaHost, limit);
         this.ghClient = new client_2.default(this.ghUsername, DEFAULT_STACK_PATTERN);
     }
     async run() {
@@ -58,9 +58,18 @@ class ContentModelSeeder {
         if (!this.ghRepo) {
             await this.inquireGitHubRepo();
         }
-        const repoExists = await this.ghClient.checkIfRepoExists(this.ghRepo);
+        let repoExists = false;
+        let repoResponseData = {};
+        try {
+            const repoCheckResult = await this.ghClient.makeGetApiCall(this.ghRepo);
+            repoExists = repoCheckResult.statusCode === 200;
+            repoResponseData = { status: repoCheckResult.statusCode, statusMessage: repoCheckResult.statusMessage };
+        }
+        catch (error) {
+            throw error;
+        }
         if (repoExists === false) {
-            cli_utilities_1.cliux.error(`Could not find GitHub repository '${this.ghPath}'.`);
+            cli_utilities_1.cliux.error(repoResponseData.status === 403 ? repoResponseData.statusMessage : `Could not find GitHub repository '${this.ghPath}'.`);
             if (this.parent)
                 this.parent.exit(1);
         }

package/oclif.manifest.json

@@ -1 +1,97 @@
-{"version":"1.1.5","commands":{"cm:stacks:seed":{"id":"cm:stacks:seed","description":"Create a stack from existing content types, entries, assets, etc","usage":"cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]","pluginName":"@contentstack/cli-cm-seed","pluginType":"core","aliases":["cm:seed"],"examples":["$ csdx cm:stacks:seed","$ csdx cm:stacks:seed --repo \"account\"","$ csdx cm:stacks:seed --repo \"account/repository\"","$ 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"],"flags":{"repo":{"name":"repo","type":"option","char":"r","description":"GitHub account or GitHub account/repository","required":false},"org":{"name":"org","type":"option","char":"o","description":"Provide Organization UID to create a new stack","required":false},"stack-api-key":{"name":"stack-api-key","type":"option","char":"k","description":"Provide stack api key to seed content to","required":false},"stack-name":{"name":"stack-name","type":"option","char":"n","description":"Name of a new stack that needs to be created.","required":false},"fetch-limit":{"name":"fetch-limit","type":"option","char":"l","description":"Limit for number of Organizations or stacks to be fetched","hidden":true,"required":false},"yes":{"name":"yes","type":"option","char":"y","description":"[Optional] Skip stack confirmation","required":false},"stack":{"name":"stack","type":"option","char":"s","description":"Provide stack UID to seed content to","required":false}},"args":[]}}}
+{
+  "version": "1.2.0",
+  "commands": {
+    "cm:stacks:seed": {
+      "id": "cm:stacks:seed",
+      "description": "Create a stack from existing content types, entries, assets, etc",
+      "strict": true,
+      "usage": "cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]",
+      "pluginName": "@contentstack/cli-cm-seed",
+      "pluginAlias": "@contentstack/cli-cm-seed",
+      "pluginType": "core",
+      "aliases": [
+        "cm:seed"
+      ],
+      "examples": [
+        "$ csdx cm:stacks:seed",
+        "$ csdx cm:stacks:seed --repo \"account\"",
+        "$ csdx cm:stacks:seed --repo \"account/repository\"",
+        "$ 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"
+      ],
+      "flags": {
+        "repo": {
+          "name": "repo",
+          "type": "option",
+          "char": "r",
+          "description": "GitHub account or GitHub account/repository",
+          "required": false,
+          "multiple": false
+        },
+        "org": {
+          "name": "org",
+          "type": "option",
+          "char": "o",
+          "description": "Provide Organization UID to create a new stack",
+          "required": false,
+          "multiple": false,
+          "exclusive": [
+            "stack"
+          ]
+        },
+        "stack-api-key": {
+          "name": "stack-api-key",
+          "type": "option",
+          "char": "k",
+          "description": "Provide stack api key to seed content to",
+          "required": false,
+          "multiple": false,
+          "exclusive": [
+            "org"
+          ]
+        },
+        "stack-name": {
+          "name": "stack-name",
+          "type": "option",
+          "char": "n",
+          "description": "Name of a new stack that needs to be created.",
+          "required": false,
+          "multiple": false,
+          "exclusive": [
+            "stack"
+          ]
+        },
+        "fetch-limit": {
+          "name": "fetch-limit",
+          "type": "option",
+          "char": "l",
+          "description": "Limit for number of Organizations or stacks to be fetched",
+          "hidden": true,
+          "required": false,
+          "multiple": false
+        },
+        "yes": {
+          "name": "yes",
+          "type": "option",
+          "char": "y",
+          "description": "[Optional] Skip stack confirmation",
+          "required": false,
+          "multiple": false
+        },
+        "stack": {
+          "name": "stack",
+          "type": "option",
+          "char": "s",
+          "description": "Provide stack UID to seed content to",
+          "required": false,
+          "multiple": false,
+          "exclusive": [
+            "org",
+            "name"
+          ]
+        }
+      },
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -1,25 +1,24 @@
 {
   "name": "@contentstack/cli-cm-seed",
   "description": "create a Stack from existing content types, entries, assets, etc.",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-cm-import": "^1.2.3",
-    "@contentstack/cli-command": "^1.0.3",
-    "@contentstack/cli-utilities": "^1.0.4",
-    "@oclif/command": "^1.8.16",
-    "@oclif/config": "^1.18.3",
+    "@contentstack/cli-cm-import": "^1.3.0",
+    "@contentstack/cli-command": "^1.1.0",
+    "@contentstack/cli-utilities": "^1.1.0",
+    "@contentstack/management": "^1.6.1",
     "axios": "1.1.3",
     "inquirer": "8.2.4",
     "mkdirp": "^1.0.4",
     "tar": "^6.0.5",
     "tmp": "^0.2.1",
-    "tslib": "^1.13.0"
+    "tslib": "^2.4.1"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1.22.2",
-    "@oclif/plugin-help": "^5.1.12",
+    "@oclif/dev-cli": "^1.26.10",
+    "@oclif/plugin-help": "^5.1.19",
     "@types/inquirer": "^9.0.3",
     "@types/jest": "^26.0.15",
     "@types/mkdirp": "^1.0.1",
@@ -53,9 +52,6 @@
   "oclif": {
     "commands": "./lib/commands",
     "bin": "csdx",
-    "devPlugins": [
-      "@oclif/plugin-help"
-    ],
     "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-seed/<%- commandPath %>"
   },
   "csdxConfig": {
@@ -69,7 +65,7 @@
     "pack": "npm pack --dry-run",
     "postpack": "rm -f oclif.manifest.json",
     "posttest": "eslint . --ext .ts --config .eslintrc",
-    "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
-    "version": "oclif-dev readme && git add README.md"
+    "prepack": "rm -rf lib && tsc -b && oclif manifest && oclif readme",
+    "version": "oclif readme && git add README.md"
   }
 }