@contentstack/cli-migration 1.3.14 → 1.4.0

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @contentstack/cli-migration
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-migration/1.3.14 darwin-arm64 node-v20.8.0
+@contentstack/cli-migration/1.4.0 darwin-arm64 node-v20.8.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "1.3.14",
+  "version": "1.4.0",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~1.2.14",
-    "@contentstack/cli-utilities": "~1.5.4",
+    "@contentstack/cli-command": "~1.2.15",
+    "@contentstack/cli-utilities": "~1.5.5",
     "async": "^3.2.4",
     "callsites": "^3.1.0",
     "cardinal": "^2.1.1",

package/src/config/default-options.js

@@ -2,6 +2,6 @@
 'use strict';
 
 module.exports = {
-  is_page: true,
+  is_page: false,
   singleton: false,
 };

package/src/modules/content-types.js

@@ -38,10 +38,12 @@ class ContentType extends Base {
    * @param {Object} opts Optional: Content type fields definition
    * @returns {Field} instance of Field
    * @example
-   * module.exports = {migrations} => {
-   *  const blog = migrations.createContentType('blog', {
-   *    title: 'blog'
-   *  })
+   * module.exports = ({migration}) => {
+   *  const blog = migration
+   *    .createContentType('blog')
+   *    .title('blog title')
+   *    .description('blog 1')
+   *  blog.createField('title').display_name('Title').data_type('text').mandatory(true);
    * }
    */
   createContentType(id, opts = {}) {
@@ -114,10 +116,8 @@ class ContentType extends Base {
    * @param {Object} opts Optional: Content type fields definition
    * @returns {Field} instance of Field
    * @example
-   * module.exports = {migrations} => {
-   *  const blog = migrations.editContentType('blog', {
-   *    title: 'blog'
-   *  });
+   * module.exports = ({migration}) => {
+   *  const blog = migration.editContentType('blog');
    *  blog.description('Changed description');
    * }
    */

package/src/modules/fields.js

@@ -16,6 +16,8 @@ const {
   field_metadata,
   reference_to,
   actions: _actions,
+  taxonomies,
+  multiple,
 } = constants;
 
 // Base class
@@ -52,11 +54,24 @@ class Field extends Base {
    * module.exports =({ migration })=> {
    *  const blog = migration.editContentType('blog');
    *
-   *  blog.createField('author');
+   *  blog.createField('author')
    *   .display_name('Author')
    *   .data_type('text')
    *   .mandatory(false);
    * };
+   * 
+   * Create a taxonomy field
+   * 
+   *  module.exports =({ migration })=> {
+   *  const blog = migration.editContentType('blog');
+   *
+   *  blog.createField('taxonomies')
+   *   .display_name('Taxonomy1')
+   *   .data_type('taxonomy')
+   *   .taxonomies([{ "taxonomy_uid": "test_taxonomy1", "max_terms": 2, "mandatory": false}])
+   *   .multiple(true)
+   *   .mandatory(false);
+   * };
    */
   createField(field, opts) {
     this.updateContentTypeSchema(field);
@@ -227,6 +242,26 @@ class Field extends Base {
     return this;
   }
 
+  /**
+   * The 'taxonomies' property should contain at least one taxonomy object
+   * @param {string | string[]} value list of taxonomies.
+   * @returns {Field} current instance of field object to chain further methods.
+   */
+  taxonomies(value) {
+    this.buildSchema(taxonomies, this.field, value);
+    return this;
+  }
+
+  /**
+   *
+   * @param {boolean} value set true if field is multiple
+   * @returns {Field} current instance of field object to chain further methods.
+   */
+  multiple(value) {
+    this.buildSchema(multiple, this.field, value);
+    return this;
+  }
+
   /**
    *
    * @param {boolean} value set true if refer to multiple content types

package/src/utils/constants.js

@@ -21,6 +21,8 @@ exports.unique = 'unique';
 exports.display_name = 'display_name';
 exports.reference_to = 'reference_to';
 exports.field_metadata = 'field_metadata';
+exports.taxonomies = 'taxonomies';
+exports.multiple = 'multiple';
 
 exports.actions = {
   CUSTOM_TASK: 'CUSTOM_TASK',