@contentstack/cli-migration 1.10.3 → 1.11.0

package/lib/modules/content-types.js

@@ -0,0 +1,173 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/* eslint-disable camelcase */
+const fields_1 = tslib_1.__importDefault(require("./fields"));
+// Services
+const services_1 = require("../services");
+// Config
+const config_1 = require("../config");
+// Utils
+const utils_1 = require("../utils");
+// Base class
+const base_1 = tslib_1.__importDefault(require("./base"));
+// Properties
+const { getMapInstance, set, get } = utils_1.map;
+const { actions, validationAction } = utils_1.constants;
+const { getUid } = utils_1.schemaHelper;
+const { create, edit } = validationAction;
+/**
+ * ContentType class
+ * @class ContentType
+ * @augments Base
+ */
+class ContentType extends base_1.default {
+    constructor() {
+        super();
+        this.contentTypeService = new services_1.ContentTypeService();
+    }
+    /**
+     * Creates content type by passing content type name and options
+     * @param {string} id Content type UID
+     * @param {Object} opts Optional: Content type fields definition
+     * @returns {Field} instance of Field
+     * @example
+     * 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 = {}) {
+        const callsite = (0, utils_1.getCallsite)();
+        // base class method
+        let options = Object.assign(Object.assign({}, config_1.defaultOptions), opts);
+        delete options.title;
+        delete options.description;
+        this.dispatch(callsite, id, opts, create);
+        const { title, description } = opts;
+        const mapInstance = getMapInstance();
+        const { CREATE_CT } = actions;
+        const uid = getUid(id);
+        const ctObj = { content_type: { title, uid, description, options } };
+        const ctActionObj = { [CREATE_CT]: ctObj };
+        const { contentTypeService } = this;
+        // Sets data to post in map object
+        set(id, mapInstance, ctActionObj);
+        // Sets action and id in content type service
+        contentTypeService.setIdAndAction(id, CREATE_CT);
+        const tasks = [contentTypeService.postContentTypes.bind(contentTypeService, callsite, id, CREATE_CT)];
+        const req = {
+            title: `Adding content type: ${id}`,
+            failMessage: `Failed to create content type: ${id}`,
+            successMessage: `Successfully added content type: ${id}`,
+            tasks,
+        };
+        let field = new fields_1.default(id, CREATE_CT, contentTypeService, req);
+        // TODO: should find better way to attach content type level methods
+        field.singleton = this.singleton;
+        field.isPage = this.isPage;
+        return field;
+    }
+    /**
+     * Set content type to singleton or multiple
+     * @param {boolean} value set value true to set content type as singleton default it is multiple
+     * @returns {ContentType} instance of ContentType for chaining
+     */
+    singleton(value) {
+        const mapInstance = getMapInstance();
+        const { id, action } = this;
+        const contentType = get(id, mapInstance);
+        contentType[action].content_type.options.singleton = value;
+        return this;
+    }
+    /**
+     * Set content type to singleton or multiple
+     * @param {boolean} value set value false to set content type as content as block default true
+     * @returns {ContentType} instance of ContentType for chaining
+     */
+    isPage(value) {
+        const mapInstance = getMapInstance();
+        const { id, action } = this;
+        const contentType = get(id, mapInstance);
+        contentType[action].content_type.options.is_page = value;
+        return this;
+    }
+    /**
+     * Edits content type by passing content type name and options
+     * @param {string} id Content type UID
+     * @param {Object} opts Optional: Content type fields definition
+     * @returns {Field} instance of Field
+     * @example
+     * module.exports = ({migration}) => {
+     *  const blog = migration.editContentType('blog');
+     *  blog.description('Changed description');
+     * }
+     */
+    editContentType(id, opts = {}) {
+        let options = Object.assign(Object.assign({}, config_1.defaultOptions), opts);
+        delete options.title;
+        delete options.description;
+        const callsite = (0, utils_1.getCallsite)();
+        // base class method
+        this.dispatch(callsite, id, {}, edit);
+        const { title, description } = opts;
+        const mapInstance = getMapInstance();
+        const { EDIT_CT } = actions;
+        const uid = id;
+        const ctObj = { content_type: { title, uid, description, options } };
+        const ctActionObj = { [EDIT_CT]: ctObj };
+        const { contentTypeService } = this;
+        // Sets data to update in map object
+        let ctAction = get(id, mapInstance);
+        set(id, mapInstance, Object.assign(Object.assign({}, ctActionObj), ctAction));
+        // Sets action and id in content type service
+        contentTypeService.setIdAndAction(id, EDIT_CT);
+        const tasks = [
+            contentTypeService.fetchContentType.bind(contentTypeService, callsite, id),
+            contentTypeService.applyActionsOnFields.bind(contentTypeService, callsite),
+            contentTypeService.editContentType.bind(contentTypeService, callsite),
+        ];
+        const req = {
+            title: `Editing content type: ${id}`,
+            failMessage: `Failed to edit content type: ${id}`,
+            successMessage: `Successfully updated content type: ${id}`,
+            tasks,
+        };
+        // Keeping the same instance of contentTypeService in Field class
+        let fieldI = new fields_1.default(id, EDIT_CT, contentTypeService, req);
+        // TODO: should find better way to attach content type level methods
+        fieldI.singleton = this.singleton;
+        fieldI.isPage = this.isPage;
+        return fieldI;
+    }
+    /**
+     * Deletes content type by passing content type name
+     * @param {string} id Content type UID
+     * @returns {Field} instance of Field
+     * @example
+     * module.exports = {migrations} => {
+     *  const blog = migrations.deleteContentType('blog');
+     * }
+     */
+    deleteContentType(id) {
+        const callsite = (0, utils_1.getCallsite)();
+        const mapInstance = getMapInstance();
+        const { DELETE_CT } = actions;
+        const uid = getUid(id);
+        const ctObj = { content_type: { uid, force: false } }; // keep by default false
+        const ctActionObj = { [DELETE_CT]: ctObj };
+        const { contentTypeService } = this;
+        // Sets data to delete in map object
+        set(id, mapInstance, ctActionObj);
+        // Sets action and id in content type service
+        contentTypeService.setIdAndAction(id, DELETE_CT);
+        const tasks = [contentTypeService.deleteContentType.bind(contentTypeService, callsite)];
+        const req = { title: 'Deleting content type', tasks };
+        return new fields_1.default(id, DELETE_CT, contentTypeService, req);
+    }
+}
+exports.default = ContentType;
+//# sourceMappingURL=content-types.js.map

package/lib/modules/content-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-types.js","sourceRoot":"","sources":["../../src/modules/content-types.ts"],"names":[],"mappings":";;;AAAA,8BAA8B;AAC9B,8DAA6B;AAE7B,WAAW;AACX,0CAAiD;AAEjD,SAAS;AACT,sCAA2C;AAE3C,QAAQ;AACR,oCAA6E;AAE7E,aAAa;AACb,0DAA0B;AAE1B,aAAa;AACb,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,WAAI,CAAC;AAC1C,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,GAAG,iBAAS,CAAC;AAChD,MAAM,EAAE,MAAM,EAAE,GAAG,oBAAY,CAAC;AAChC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC;AAE1C;;;;GAIG;AACH,MAAqB,WAAY,SAAQ,cAAI;IAG3C;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,kBAAkB,GAAG,IAAI,6BAAkB,EAAE,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAAU,EAAE,OAAY,EAAE;QAC1C,MAAM,QAAQ,GAAG,IAAA,mBAAW,GAAE,CAAC;QAC/B,oBAAoB;QACpB,IAAI,OAAO,mCAAa,uBAAc,GAAK,IAAI,CAAE,CAAC;QAClD,OAAO,OAAO,CAAC,KAAK,CAAC;QACrB,OAAO,OAAO,CAAC,WAAW,CAAC;QAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1C,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QACpC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;QAErC,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QAEvB,MAAM,KAAK,GAAG,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;QAErE,MAAM,WAAW,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC;QAE3C,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QACpC,kCAAkC;QAClC,GAAG,CAAC,EAAE,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QAClC,6CAA6C;QAC7C,kBAAkB,CAAC,cAAc,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QACtG,MAAM,GAAG,GAAG;YACV,KAAK,EAAE,wBAAwB,EAAE,EAAE;YACnC,WAAW,EAAE,kCAAkC,EAAE,EAAE;YACnD,cAAc,EAAE,oCAAoC,EAAE,EAAE;YACxD,KAAK;SACN,CAAC;QACF,IAAI,KAAK,GAAG,IAAI,gBAAK,CAAC,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,CAAC,CAAC;QAC9D,oEAAoE;QACnE,KAAa,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACzC,KAAa,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,KAAc;QACtB,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;QACrC,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAC5B,MAAM,WAAW,GAAG,GAAG,CAAC,EAAY,EAAE,WAAW,CAAC,CAAC;QAEnD,WAAW,CAAC,MAAgB,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC;QACrE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAc;QACnB,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;QACrC,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAC5B,MAAM,WAAW,GAAG,GAAG,CAAC,EAAY,EAAE,WAAW,CAAC,CAAC;QAEnD,WAAW,CAAC,MAAgB,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC;QACnE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAU,EAAE,OAAY,EAAE;QACxC,IAAI,OAAO,mCAAa,uBAAc,GAAK,IAAI,CAAE,CAAC;QAClD,OAAO,OAAO,CAAC,KAAK,CAAC;QACrB,OAAO,OAAO,CAAC,WAAW,CAAC;QAE3B,MAAM,QAAQ,GAAG,IAAA,mBAAW,GAAE,CAAC;QAC/B,oBAAoB;QACpB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QACtC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QACpC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;QAErC,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAE5B,MAAM,GAAG,GAAG,EAAE,CAAC;QAEf,MAAM,KAAK,GAAG,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;QACrE,MAAM,WAAW,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC;QAEzC,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QAEpC,oCAAoC;QACpC,IAAI,QAAQ,GAAG,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAEpC,GAAG,CAAC,EAAE,EAAE,WAAW,kCAAO,WAAW,GAAK,QAAQ,EAAG,CAAC;QACtD,6CAA6C;QAC7C,kBAAkB,CAAC,cAAc,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG;YACZ,kBAAkB,CAAC,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,EAAE,QAAQ,EAAE,EAAE,CAAC;YAC1E,kBAAkB,CAAC,oBAAoB,CAAC,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;YAC1E,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC;SACtE,CAAC;QAEF,MAAM,GAAG,GAAG;YACV,KAAK,EAAE,yBAAyB,EAAE,EAAE;YACpC,WAAW,EAAE,gCAAgC,EAAE,EAAE;YACjD,cAAc,EAAE,sCAAsC,EAAE,EAAE;YAC1D,KAAK;SACN,CAAC;QAEF,iEAAiE;QACjE,IAAI,MAAM,GAAG,IAAI,gBAAK,CAAC,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,GAAG,CAAC,CAAC;QAC7D,oEAAoE;QACnE,MAAc,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC1C,MAAc,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAU;QAC1B,MAAM,QAAQ,GAAG,IAAA,mBAAW,GAAE,CAAC;QAE/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;QAErC,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAE9B,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QAEvB,MAAM,KAAK,GAAG,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,wBAAwB;QAE/E,MAAM,WAAW,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC;QAE3C,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QAEpC,oCAAoC;QACpC,GAAG,CAAC,EAAE,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QAClC,6CAA6C;QAC7C,kBAAkB,CAAC,cAAc,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;QAEjD,MAAM,KAAK,GAAG,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC,CAAC;QAExF,MAAM,GAAG,GAAG,EAAE,KAAK,EAAE,uBAAuB,EAAE,KAAK,EAAE,CAAC;QAEtD,OAAO,IAAI,gBAAK,CAAC,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;CACF;AAnLD,8BAmLC","sourcesContent":["/* eslint-disable camelcase */\nimport Field from './fields';\n\n// Services\nimport { ContentTypeService } from '../services';\n\n// Config\nimport { defaultOptions } from '../config';\n\n// Utils\nimport { map as _map, schemaHelper, constants, getCallsite } from '../utils';\n\n// Base class\nimport Base from './base';\n\n// Properties\nconst { getMapInstance, set, get } = _map;\nconst { actions, validationAction } = constants;\nconst { getUid } = schemaHelper;\nconst { create, edit } = validationAction;\n\n/**\n * ContentType class\n * @class ContentType\n * @augments Base\n */\nexport default class ContentType extends Base {\n  contentTypeService: ContentTypeService;\n\n  constructor() {\n    super();\n    this.contentTypeService = new ContentTypeService();\n  }\n\n  /**\n   * Creates content type by passing content type name and options\n   * @param {string} id Content type UID\n   * @param {Object} opts Optional: Content type fields definition\n   * @returns {Field} instance of Field\n   * @example\n   * module.exports = ({migration}) => {\n   *  const blog = migration\n   *    .createContentType('blog')\n   *    .title('blog title')\n   *    .description('blog 1')\n   *  blog.createField('title').display_name('Title').data_type('text').mandatory(true);\n   * }\n   */\n  createContentType(id: string, opts: any = {}): Field {\n    const callsite = getCallsite();\n    // base class method\n    let options: any = { ...defaultOptions, ...opts };\n    delete options.title;\n    delete options.description;\n    this.dispatch(callsite, id, opts, create);\n    const { title, description } = opts;\n    const mapInstance = getMapInstance();\n\n    const { CREATE_CT } = actions;\n    const uid = getUid(id);\n\n    const ctObj = { content_type: { title, uid, description, options } };\n\n    const ctActionObj = { [CREATE_CT]: ctObj };\n\n    const { contentTypeService } = this;\n    // Sets data to post in map object\n    set(id, mapInstance, ctActionObj);\n    // Sets action and id in content type service\n    contentTypeService.setIdAndAction(id, CREATE_CT);\n    const tasks = [contentTypeService.postContentTypes.bind(contentTypeService, callsite, id, CREATE_CT)];\n    const req = {\n      title: `Adding content type: ${id}`,\n      failMessage: `Failed to create content type: ${id}`,\n      successMessage: `Successfully added content type: ${id}`,\n      tasks,\n    };\n    let field = new Field(id, CREATE_CT, contentTypeService, req);\n    // TODO: should find better way to attach content type level methods\n    (field as any).singleton = this.singleton;\n    (field as any).isPage = this.isPage;\n    return field;\n  }\n\n  /**\n   * Set content type to singleton or multiple\n   * @param {boolean} value set value true to set content type as singleton default it is multiple\n   * @returns {ContentType} instance of ContentType for chaining\n   */\n  singleton(value: boolean): this {\n    const mapInstance = getMapInstance();\n    const { id, action } = this;\n    const contentType = get(id as string, mapInstance);\n\n    contentType[action as string].content_type.options.singleton = value;\n    return this;\n  }\n\n  /**\n   * Set content type to singleton or multiple\n   * @param {boolean} value set value false to set content type as content as block default true\n   * @returns {ContentType} instance of ContentType for chaining\n   */\n  isPage(value: boolean): this {\n    const mapInstance = getMapInstance();\n    const { id, action } = this;\n    const contentType = get(id as string, mapInstance);\n\n    contentType[action as string].content_type.options.is_page = value;\n    return this;\n  }\n\n  /**\n   * Edits content type by passing content type name and options\n   * @param {string} id Content type UID\n   * @param {Object} opts Optional: Content type fields definition\n   * @returns {Field} instance of Field\n   * @example\n   * module.exports = ({migration}) => {\n   *  const blog = migration.editContentType('blog');\n   *  blog.description('Changed description');\n   * }\n   */\n  editContentType(id: string, opts: any = {}): Field {\n    let options: any = { ...defaultOptions, ...opts };\n    delete options.title;\n    delete options.description;\n\n    const callsite = getCallsite();\n    // base class method\n    this.dispatch(callsite, id, {}, edit);\n    const { title, description } = opts;\n    const mapInstance = getMapInstance();\n\n    const { EDIT_CT } = actions;\n\n    const uid = id;\n\n    const ctObj = { content_type: { title, uid, description, options } };\n    const ctActionObj = { [EDIT_CT]: ctObj };\n\n    const { contentTypeService } = this;\n\n    // Sets data to update in map object\n    let ctAction = get(id, mapInstance);\n\n    set(id, mapInstance, { ...ctActionObj, ...ctAction });\n    // Sets action and id in content type service\n    contentTypeService.setIdAndAction(id, EDIT_CT);\n    const tasks = [\n      contentTypeService.fetchContentType.bind(contentTypeService, callsite, id),\n      contentTypeService.applyActionsOnFields.bind(contentTypeService, callsite),\n      contentTypeService.editContentType.bind(contentTypeService, callsite),\n    ];\n\n    const req = {\n      title: `Editing content type: ${id}`,\n      failMessage: `Failed to edit content type: ${id}`,\n      successMessage: `Successfully updated content type: ${id}`,\n      tasks,\n    };\n\n    // Keeping the same instance of contentTypeService in Field class\n    let fieldI = new Field(id, EDIT_CT, contentTypeService, req);\n    // TODO: should find better way to attach content type level methods\n    (fieldI as any).singleton = this.singleton;\n    (fieldI as any).isPage = this.isPage;\n    return fieldI;\n  }\n\n  /**\n   * Deletes content type by passing content type name\n   * @param {string} id Content type UID\n   * @returns {Field} instance of Field\n   * @example\n   * module.exports = {migrations} => {\n   *  const blog = migrations.deleteContentType('blog');\n   * }\n   */\n  deleteContentType(id: string): Field {\n    const callsite = getCallsite();\n\n    const mapInstance = getMapInstance();\n\n    const { DELETE_CT } = actions;\n\n    const uid = getUid(id);\n\n    const ctObj = { content_type: { uid, force: false } }; // keep by default false\n\n    const ctActionObj = { [DELETE_CT]: ctObj };\n\n    const { contentTypeService } = this;\n\n    // Sets data to delete in map object\n    set(id, mapInstance, ctActionObj);\n    // Sets action and id in content type service\n    contentTypeService.setIdAndAction(id, DELETE_CT);\n\n    const tasks = [contentTypeService.deleteContentType.bind(contentTypeService, callsite)];\n\n    const req = { title: 'Deleting content type', tasks };\n\n    return new Field(id, DELETE_CT, contentTypeService, req);\n  }\n}\n"]}

package/lib/modules/fields.d.ts

@@ -0,0 +1,179 @@
+import Base from './base';
+/**
+ * Field class
+ * @class Field
+ */
+export default class Field extends Base {
+    uid: string;
+    action: string;
+    contentTypeService: any;
+    request: any;
+    field: string | undefined;
+    fieldToMove: string | undefined;
+    singleton?: (value: boolean) => this;
+    isPage?: (value: boolean) => this;
+    constructor(uid: string, action: string, contentTypeService: any, request: any);
+    /**
+     * @typedef {Object} Task
+     * @param {string} title - Title for custom task
+     * @param {function[]} task - array of async function to be executed
+     * @param {string} failMessage message to be printed when task fails
+     * @param {string} successMessage - message to be printed when task succeeds
+     */
+    /**
+     * Creates a field with provided uid.
+     * @param {string} field Field name to be created
+     * @param {Object} opts Options to be passed
+     * @returns {Field} current instance of field object to chain further methods.
+     * @example
+     * module.exports =({ migration })=> {
+     *  const blog = migration.editContentType('blog');
+     *
+     *  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: string, opts?: any): this;
+    /**
+     * Edits the field with provided uid.
+     * @param {string} field Field name to be edited
+     * @param {Object} opts Options to be passed
+     * @returns {Field} current instance of field object to chain further methods.
+     * @example
+     * module.exports =({ migration })=> {
+     * const blog = migration.editContentType('blog');
+     *
+     * blog.editField('uniqueid')
+     *   .display_name('Unique ID')
+     *   .mandatory(false);
+     * };
+     */
+    editField(field: string, opts?: any): this;
+    /**
+     * Delete a field from the content type
+     * @param {string} field Field uid to be deleted
+     * @returns {Field} current instance of field object to chain further methods.
+     * @example
+     * module.exports =({ migration })=> {
+     *  const blog = migration.editContentType('blog');
+     *
+     *  blog.deleteField('uniqueid');
+     * };
+     */
+    deleteField(field: string): this;
+    /**
+     * Move the field (position of the field in the editor)
+     * @param {string} field Field uid to be moved
+     * @returns {Field} current instance of field object to chain further methods.
+     * @example
+     * module.exports = ({migration}) => {
+     *  const blog = migration.editContentType('blog');
+     *
+     *  blog.createField('credits')
+     *    .display_name('Credits')
+     *    .data_type('text')
+     *    .mandatory(false);
+     *
+     *  blog.createField('references')
+     *    .display_name('References')
+     *    .data_type('text')
+     *    .mandatory(false);
+     *
+     *  blog.moveField('uniqueid').toTheBottom();
+     *  blog.moveField('references').beforeField('credits');
+     *  blog.moveField('author').toTheTop();
+     *  blog.moveField('url').afterField('author');
+     * };
+     */
+    moveField(field: string): this;
+    updateContentTypeSchema(field: string, subAction?: string): void;
+    /**
+     *
+     * @param {string} value set display name for the field
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    display_name(value: string): this;
+    /**
+     *
+     * @param {string} value Set data type of the field e.g. text, json, boolean
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    data_type(value: string): this;
+    /**
+     *
+     * @param {boolean} value set true when field is mandatory
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    mandatory(value: boolean): this;
+    /**
+     *
+     * @param {string|boolean|number} value set true when field is mandatory
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    default(value: string | boolean | number): this;
+    /**
+     *
+     * @param {boolean} value set true if field is unique
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    unique(value: boolean): this;
+    /**
+     *
+     * @param {string | string[]} value uid of reference content type set array if ref_multipleContentType true
+     * @see {@link ref_multipleContentType}
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    reference_to(value: string | string[]): this;
+    /**
+     *
+     * @param {string} value set true if accepts multiple entries as reference
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    ref_multiple(value: boolean): 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: any): this;
+    /**
+     *
+     * @param {boolean} value set true if field is multiple
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    multiple(value: boolean): this;
+    /**
+     *
+     * @param {boolean} value set true if refer to multiple content types
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    ref_multipleContentType(value: boolean): this;
+    toTheBottom(): void;
+    toTheTop(): void;
+    afterField(field: string): void;
+    beforeField(field: string): void;
+    buildSchema(prop: string, field: string, value: any): void;
+    /**
+     * Once you add the fields to content type you can call this method to get the task definition
+     * @returns {Task} This task definition is to pass to migration.addTask()
+     * @example
+     * migration.addTask(foo.getTaskDefinition())
+     */
+    getTaskDefinition(): any;
+    getSchemaFromOptions(opts: any, field: string): void;
+}

package/lib/modules/fields.js

@@ -0,0 +1,292 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+// Utils
+const utils_1 = require("../utils");
+// Utils Properties
+const { getMapInstance, get } = utils_1.map;
+const { getSchema } = utils_1.schemaHelper;
+const { data_type, mandatory, _default, unique, display_name, field_metadata, reference_to, actions: _actions, taxonomies, multiple, } = utils_1.constants;
+// Base class
+const base_1 = tslib_1.__importDefault(require("./base"));
+/**
+ * Field class
+ * @class Field
+ */
+class Field extends base_1.default {
+    // prop, value
+    constructor(uid, action, contentTypeService, request) {
+        super(uid);
+        this.uid = uid;
+        this.action = action;
+        this.contentTypeService = contentTypeService;
+        this.request = request;
+    }
+    /**
+     * @typedef {Object} Task
+     * @param {string} title - Title for custom task
+     * @param {function[]} task - array of async function to be executed
+     * @param {string} failMessage message to be printed when task fails
+     * @param {string} successMessage - message to be printed when task succeeds
+     */
+    /**
+     * Creates a field with provided uid.
+     * @param {string} field Field name to be created
+     * @param {Object} opts Options to be passed
+     * @returns {Field} current instance of field object to chain further methods.
+     * @example
+     * module.exports =({ migration })=> {
+     *  const blog = migration.editContentType('blog');
+     *
+     *  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);
+        // Build schema from options provided
+        if (opts && Object.keys(opts).length) {
+            this.getSchemaFromOptions(opts, field);
+            return this;
+        }
+        return this;
+    }
+    /**
+     * Edits the field with provided uid.
+     * @param {string} field Field name to be edited
+     * @param {Object} opts Options to be passed
+     * @returns {Field} current instance of field object to chain further methods.
+     * @example
+     * module.exports =({ migration })=> {
+     * const blog = migration.editContentType('blog');
+     *
+     * blog.editField('uniqueid')
+     *   .display_name('Unique ID')
+     *   .mandatory(false);
+     * };
+     */
+    editField(field, opts) {
+        const { EDIT_FIELD } = _actions;
+        this.updateContentTypeSchema(field, EDIT_FIELD);
+        // Build schema from options provided
+        if (opts && Object.keys(opts).length) {
+            this.getSchemaFromOptions(opts, field);
+            return this;
+        }
+        return this;
+    }
+    /**
+     * Delete a field from the content type
+     * @param {string} field Field uid to be deleted
+     * @returns {Field} current instance of field object to chain further methods.
+     * @example
+     * module.exports =({ migration })=> {
+     *  const blog = migration.editContentType('blog');
+     *
+     *  blog.deleteField('uniqueid');
+     * };
+     */
+    deleteField(field) {
+        const { DELETE_FIELD } = _actions;
+        this.updateContentTypeSchema(field, DELETE_FIELD);
+        return this;
+    }
+    /**
+     * Move the field (position of the field in the editor)
+     * @param {string} field Field uid to be moved
+     * @returns {Field} current instance of field object to chain further methods.
+     * @example
+     * module.exports = ({migration}) => {
+     *  const blog = migration.editContentType('blog');
+     *
+     *  blog.createField('credits')
+     *    .display_name('Credits')
+     *    .data_type('text')
+     *    .mandatory(false);
+     *
+     *  blog.createField('references')
+     *    .display_name('References')
+     *    .data_type('text')
+     *    .mandatory(false);
+     *
+     *  blog.moveField('uniqueid').toTheBottom();
+     *  blog.moveField('references').beforeField('credits');
+     *  blog.moveField('author').toTheTop();
+     *  blog.moveField('url').afterField('author');
+     * };
+     */
+    moveField(field) {
+        this.fieldToMove = field;
+        return this;
+    }
+    updateContentTypeSchema(field, subAction) {
+        const mapInstance = getMapInstance();
+        const { uid, action } = this;
+        const contentType = get(uid, mapInstance);
+        let contentTypeSchema = contentType[action].content_type.schema;
+        contentTypeSchema = contentTypeSchema || [];
+        const schemaObj = getSchema(field, subAction);
+        contentTypeSchema.push(schemaObj);
+        contentType[action].content_type.schema = contentTypeSchema;
+        this.field = schemaObj.uid;
+    }
+    // changeFieldId(currentId, newId) { }
+    /**
+     *
+     * @param {string} value set display name for the field
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    display_name(value) {
+        this.buildSchema(display_name, this.field, value);
+        return this;
+    }
+    /**
+     *
+     * @param {string} value Set data type of the field e.g. text, json, boolean
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    data_type(value) {
+        this.buildSchema(data_type, this.field, value);
+        return this;
+    }
+    /**
+     *
+     * @param {boolean} value set true when field is mandatory
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    mandatory(value) {
+        this.buildSchema(mandatory, this.field, value);
+        return this;
+    }
+    /**
+     *
+     * @param {string|boolean|number} value set true when field is mandatory
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    default(value) {
+        this.buildSchema(_default, this.field, value);
+        return this;
+    }
+    /**
+     *
+     * @param {boolean} value set true if field is unique
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    unique(value) {
+        this.buildSchema(unique, this.field, value);
+        return this;
+    }
+    /**
+     *
+     * @param {string | string[]} value uid of reference content type set array if ref_multipleContentType true
+     * @see {@link ref_multipleContentType}
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    reference_to(value) {
+        this.buildSchema(reference_to, this.field, value);
+        return this;
+    }
+    /**
+     *
+     * @param {string} value set true if accepts multiple entries as reference
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    ref_multiple(value) {
+        this.buildSchema(field_metadata, this.field, { ref_multiple: value, ref_multiple_content_types: true });
+        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
+     * @returns {Field} current instance of field object to chain further methods.
+     */
+    ref_multipleContentType(value) {
+        this.buildSchema(field_metadata, this.field, { ref_multiple_content_types: value });
+        return this;
+    }
+    toTheBottom() {
+        const { fieldToMove, contentTypeService } = this;
+        if (!fieldToMove)
+            throw new Error('Cannot access this method directly.');
+        contentTypeService.getActions({ action: 'toTheBottom', fieldToMove });
+    }
+    toTheTop() {
+        const { fieldToMove, contentTypeService } = this;
+        if (!fieldToMove)
+            throw new Error('Cannot access this method directly.');
+        contentTypeService.getActions({ action: 'toTheTop', fieldToMove });
+    }
+    afterField(field) {
+        const { fieldToMove, contentTypeService } = this;
+        if (!fieldToMove)
+            throw new Error('Cannot access this method directly.');
+        contentTypeService.getActions({ action: 'afterField', fieldToMove, against: field });
+    }
+    beforeField(field) {
+        const { fieldToMove, contentTypeService } = this;
+        if (!fieldToMove)
+            throw new Error('Cannot access this method directly.');
+        contentTypeService.getActions({ action: 'beforeField', fieldToMove, against: field });
+    }
+    buildSchema(prop, field, value) {
+        const mapInstance = getMapInstance();
+        const { uid, action } = this;
+        const contentType = get(uid, mapInstance);
+        for (const _schema of contentType[action].content_type.schema) {
+            if (_schema.uid === field) {
+                _schema[prop] = value;
+                break;
+            }
+        }
+    }
+    /**
+     * Once you add the fields to content type you can call this method to get the task definition
+     * @returns {Task} This task definition is to pass to migration.addTask()
+     * @example
+     * migration.addTask(foo.getTaskDefinition())
+     */
+    getTaskDefinition() {
+        return this.request;
+    }
+    getSchemaFromOptions(opts, field) {
+        const allKeys = Object.keys(opts);
+        allKeys.forEach((_key) => {
+            this.buildSchema(_key, field, opts[_key]);
+        });
+    }
+}
+exports.default = Field;
+//# sourceMappingURL=fields.js.map