@contentstack/management
Version:
The Content Management API is used to manage the content of your Contentstack account
326 lines (320 loc) • 13.7 kB
JavaScript
;
var _interopRequireDefault3 = require("@babel/runtime/helpers/interopRequireDefault");
var _interopRequireDefault2 = _interopRequireDefault3(require("@babel/runtime/helpers/interopRequireDefault"));
Object.defineProperty(exports, "__esModule", {
value: true
});
var _defineProperty2 = require("@babel/runtime/helpers/defineProperty");
var _defineProperty3 = (0, _interopRequireDefault2["default"])(_defineProperty2);
var _asyncToGenerator2 = require("@babel/runtime/helpers/asyncToGenerator");
var _asyncToGenerator3 = (0, _interopRequireDefault2["default"])(_asyncToGenerator2);
exports.Release = Release;
exports.ReleaseCollection = ReleaseCollection;
var _regenerator = require("@babel/runtime/regenerator");
var _regenerator2 = (0, _interopRequireDefault2["default"])(_regenerator);
var _cloneDeep = require("lodash/cloneDeep");
var _cloneDeep2 = (0, _interopRequireDefault2["default"])(_cloneDeep);
var _entity = require("../../entity");
var _contentstackError = require("../../core/contentstackError");
var _contentstackError2 = (0, _interopRequireDefault2["default"])(_contentstackError);
var _items = require("./items");
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty3["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
/**
* @description You can pin a set of entries and assets (along with the deploy action, i.e., publish/unpublish) to a ‘release’, and then deploy this release to an environment.
* This will publish/unpublish all the the items of the release to the specified environment. Read more about <a href='https://www.contentstack.com/docs/developers/create-releases'>Releases</a>.
* @namespace Release
*/
function Release(http) {
var _this = this;
var data = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
this.stackHeaders = data.stackHeaders;
this.urlPath = "/releases";
if (data.release) {
Object.assign(this, (0, _cloneDeep2["default"])(data.release));
if (data.release.items) {
this.items = new _items.ReleaseItemCollection(http, {
items: data.release.items,
stackHeaders: data.stackHeaders
}, this.uid);
}
this.urlPath = "/releases/".concat(this.uid);
/**
* @description The Update Release call lets you update the name and description of an existing Release.
* @memberof Release
* @func update
* @returns {Promise<Release.Release>} Promise for Release instance
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* const relase = {
* name: "Release Name",
* description: "2018-12-12",
* locked: false,
* archived: false
* }
*
* var release = client.stack({ api_key: 'api_key'}).release('release_uid')
* Object.assign(release, cloneDeep(release))
*
* release.update()
* .then((release) => {
* release.title = 'My New release'
* release.description = 'Release description'
* return release.update()
* })
* .then((release) => console.log(release))
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
*
* client.stack({ api_key: 'api_key'}).release('release_uid').fetch()
* .then((release) => {
* release.title = 'My New release'
* release.description = 'Release description'
* return release.update()
* })
* .then((release) => console.log(release))
*
*/
this.update = (0, _entity.update)(http, 'release');
/**
* @description The fetch Release call fetches Release details.
* @memberof Release
* @func fetch
* @returns {Promise<Release.Release>} Promise for Release instance
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).release('release_uid').fetch()
* .then((release) => console.log(release))
*
*/
this.fetch = (0, _entity.fetch)(http, 'release');
/**
* @description The Delete Release call is used to delete an existing Release permanently from your Stack.
* @memberof Release
* @func delete
* @returns {Object} Response Object.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).release('release_uid').delete()
* .then((response) => console.log(response.notice))
*/
this["delete"] = (0, _entity.deleteEntity)(http);
/**
* @description A ReleaseItem is a set of entries and assets that needs to be deployed (published or unpublished) all at once to a particular environment.
* @memberof Release
* @func item
* @returns {ReleaseItem} Instance of ReleaseItem.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).release('release_uid').item().fetchAll()
* .then((items) => console.log(items))
*/
this.item = function () {
return new _items.ReleaseItem(http, {
releaseUid: _this.uid,
stackHeaders: _this.stackHeaders
});
};
/**
* @description The Deploy a Release request deploys a specific Release to specific environment(s) and locale(s).
* @memberof Release
* @func deploy
* @returns {Object} Response Object.
* @param {Array} environments - environment(s) on which the Release should be deployed.
* @param {Array} locales - locale(s) on which the Release should be deployed.
* @param {String} action - action on which the Release should be deployed.
* @param {String} scheduledAt - scheudle time for the Release to deploy.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).release('release_uid').deploy({
* environments: [
* "production",
* "uat"
* ],
* locales: [
* "en-us",
* "ja-jp"
* ],
* scheduledAt: '2018-12-12T13:13:13:122Z',
* action: 'publish',
*
* })
* .then((response) => console.log(response.notice))
*/
this.deploy = /*#__PURE__*/function () {
var _ref2 = (0, _asyncToGenerator3["default"])(/*#__PURE__*/_regenerator2["default"].mark(function _callee(_ref) {
var environments, locales, scheduledAt, action, release, headers, response, _t;
return _regenerator2["default"].wrap(function (_context) {
while (1) switch (_context.prev = _context.next) {
case 0:
environments = _ref.environments, locales = _ref.locales, scheduledAt = _ref.scheduledAt, action = _ref.action;
release = {
environments: environments,
locales: locales,
scheduledAt: scheduledAt,
action: action
};
headers = {
headers: _objectSpread({}, (0, _cloneDeep2["default"])(_this.stackHeaders))
} || {};
_context.prev = 1;
_context.next = 2;
return http.post("".concat(_this.urlPath, "/deploy"), {
release: release
}, headers);
case 2:
response = _context.sent;
if (!response.data) {
_context.next = 3;
break;
}
return _context.abrupt("return", response.data);
case 3:
throw (0, _contentstackError2["default"])(response);
case 4:
_context.next = 6;
break;
case 5:
_context.prev = 5;
_t = _context["catch"](1);
throw (0, _contentstackError2["default"])(_t);
case 6:
case "end":
return _context.stop();
}
}, _callee, null, [[1, 5]]);
}));
return function (_x) {
return _ref2.apply(this, arguments);
};
}();
/**
* @description The Clone a Release request allows you to clone (make a copy of) a specific Release in a stack.
* @memberof Release
* @func clone
* @returns {Promise<Release.Release>} Promise for Release instance
* @param {String} name - name of the cloned Release.
* @param {String} description - description of the cloned Release.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).release('release_uid').clone({ name: 'New Name', description: 'New Description'})
* .then((release) => console.log(release))
*
*/
this.clone = /*#__PURE__*/function () {
var _ref4 = (0, _asyncToGenerator3["default"])(/*#__PURE__*/_regenerator2["default"].mark(function _callee2(_ref3) {
var name, description, release, headers, response, _t2;
return _regenerator2["default"].wrap(function (_context2) {
while (1) switch (_context2.prev = _context2.next) {
case 0:
name = _ref3.name, description = _ref3.description;
release = {
name: name,
description: description
};
headers = {
headers: _objectSpread({}, (0, _cloneDeep2["default"])(_this.stackHeaders))
} || {};
_context2.prev = 1;
_context2.next = 2;
return http.post("".concat(_this.urlPath, "/clone"), {
release: release
}, headers);
case 2:
response = _context2.sent;
if (!response.data) {
_context2.next = 3;
break;
}
return _context2.abrupt("return", new Release(http, response.data));
case 3:
throw (0, _contentstackError2["default"])(response);
case 4:
_context2.next = 6;
break;
case 5:
_context2.prev = 5;
_t2 = _context2["catch"](1);
throw (0, _contentstackError2["default"])(_t2);
case 6:
case "end":
return _context2.stop();
}
}, _callee2, null, [[1, 5]]);
}));
return function (_x2) {
return _ref4.apply(this, arguments);
};
}();
} else {
/**
* @description The Create a Release request allows you to create a new Release in your stack. To add entries/assets to a Release, you need to provide the UIDs of the entries/assets in ‘items’ in the request body.
* @memberof Release
* @func create
* @param {Object} param.release Release details.
* @returns {Promise<Release.Release>} Promise for Release instance
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
* const release = {
* name: "Release Name",
* description: "2018-12-12",
* locked: false,
* archived: false
* }
* client.stack({ api_key: 'api_key'}).release().create({ release })
* .then((release) => console.log(release))
*/
this.create = (0, _entity.create)({
http: http
});
/**
* @description The Query on release will allow to fetch details of all or specific Releases.
* @memberof Release
* @func query
* @param {Boolean} param.include_countThe ‘include_count’ parameter includes the count of total number of releases in your stack, along with the details of each release.
* @param {Boolean} param.include_items_count The ‘include_items_count’ parameter returns the total number of items in a specific release.
* @param {Int} param.limit The ‘limit’ parameter will return a specific number of releases in the output.
* @param {Int} param.skip The ‘skip’ parameter will skip a specific number of releases in the response.
* @returns {Array<Release>} Array of Release.
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).release().query().find()
* .then((release) => console.log(release))
*/
this.query = (0, _entity.query)({
http: http,
wrapperCollection: ReleaseCollection
});
}
return this;
}
function ReleaseCollection(http, data) {
var obj = (0, _cloneDeep2["default"])(data.releases) || [];
var releaseCollection = obj.map(function (userdata) {
return new Release(http, {
release: userdata,
stackHeaders: data.stackHeaders
});
});
return releaseCollection;
}