@contentstack/management
Version:
The Content Management API is used to manage the content of your Contentstack account
201 lines (197 loc) • 8.43 kB
JavaScript
import _defineProperty from "@babel/runtime/helpers/defineProperty";
import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
import _regeneratorRuntime from "@babel/runtime/regenerator";
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) { _defineProperty(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; }
import cloneDeep from 'lodash/cloneDeep';
import { deleteEntity, query } from '../../entity';
import { Variants } from './variants/index';
import error from '../../core/contentstackError';
/**
* VariantGroups allow you to group a collection of variants within a stack. Using variant groups you can organize variants that need to work together. Read more about <a href='https://www.contentstack.com/docs/developers/create-content-types/manage-variants'>VariantGroups</a>.
* @namespace VariantGroup
*/
export function VariantGroup(http) {
var _this = this;
var data = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
this.stackHeaders = data.stackHeaders;
this.urlPath = "/variant_groups";
if (data.variant_group) {
Object.assign(this, cloneDeep(data.variant_group));
this.urlPath += "/".concat(this.uid);
/**
* @description The Update VariantGroup call lets you update the name and description of an existing VariantGroup.
* @memberof VariantGroup
* @func update
* @returns {Promise<VariantGroup.VariantGroup>} Promise for VariantGroup instance
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
* const up_data = {name: 'update name'}
* client.stack({ api_key: 'api_key'}).variantGroup('variant_group_uid').update(up_data)
* .then((variant_group) => console.log(variant_group))
*
*/
this.update = /*#__PURE__*/function () {
var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee(data) {
var response, _t;
return _regeneratorRuntime.wrap(function (_context) {
while (1) switch (_context.prev = _context.next) {
case 0:
_context.prev = 0;
_context.next = 1;
return http.put(_this.urlPath, data, {
headers: _objectSpread({}, cloneDeep(_this.stackHeaders))
});
case 1:
response = _context.sent;
if (!response.data) {
_context.next = 2;
break;
}
return _context.abrupt("return", response.data);
case 2:
return _context.abrupt("return", error(response));
case 3:
_context.next = 5;
break;
case 4:
_context.prev = 4;
_t = _context["catch"](0);
return _context.abrupt("return", error(_t));
case 5:
case "end":
return _context.stop();
}
}, _callee, null, [[0, 4]]);
}));
return function (_x) {
return _ref.apply(this, arguments);
};
}();
/**
* @description The Delete VariantGroup call is used to delete an existing VariantGroup permanently from your Stack.
* @memberof VariantGroup
* @func delete
* @returns {Object} Response Object.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).variantGroup('variant_group_uid').delete()
* .then((response) => console.log(response.notice))
*/
this["delete"] = deleteEntity(http);
/**
* @description The variants method returns a Variants instance for managing variants within this Variant Group.
* @param {String} uid The UID of the variant you want to get details.
* @returns {Variants} Instance of Variants.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).variantGroup('variant_group_uid').variants('variant_uid').fetch()
* .then((variants) => console.log(variants))
*/
this.variants = function () {
var uid = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
var data = {
stackHeaders: _this.stackHeaders
};
data.variant_group_uid = _this.uid;
if (uid) {
data.variants = {
uid: uid
};
}
return new Variants(http, data);
};
} else {
/**
* @description The Create a variant group call creates a new variant group in a particular stack of your Contentstack account.
* @memberof VariantGroup
* @func create
* @returns {Promise<VariantGroup.VariantGroup>} Promise for VariantGroup instance
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
* const variant_group = {
* "name": "Colors",
* "content_types": [
* "iphone_product_page"
* ],
* "uid": "iphone_color_white", // optional
* }
* client.stack().variantGroup().create({ variant_group })
* .then((variant_group) => console.log(variant_group))
*/
this.create = /*#__PURE__*/function () {
var _ref2 = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee2(data) {
var response, _t2;
return _regeneratorRuntime.wrap(function (_context2) {
while (1) switch (_context2.prev = _context2.next) {
case 0:
_context2.prev = 0;
_context2.next = 1;
return http.post("".concat(_this.urlPath), data, {
headers: _objectSpread({}, cloneDeep(_this.stackHeaders))
});
case 1:
response = _context2.sent;
if (!response.data) {
_context2.next = 2;
break;
}
return _context2.abrupt("return", response.data);
case 2:
return _context2.abrupt("return", error(response));
case 3:
_context2.next = 5;
break;
case 4:
_context2.prev = 4;
_t2 = _context2["catch"](0);
return _context2.abrupt("return", error(_t2));
case 5:
case "end":
return _context2.stop();
}
}, _callee2, null, [[0, 4]]);
}));
return function (_x2) {
return _ref2.apply(this, arguments);
};
}();
/**
* @description The Query on Variant Groups will allow you to fetch details of all or specific Variant Groups.
* @memberof VariantGroup
* @func query
* @param {Object} params - URI parameters
* @prop {Object} params.query - Queries that you can use to fetch filtered results for variant groups.
* @returns {Object} Query builder object with find(), count(), and findOne() methods.
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key' }).variantGroup().query({ query: { name: 'Variant Group Name' } }).find()
* .then((variant_groups) => console.log(variant_groups))
*/
this.query = query({
http: http,
wrapperCollection: VariantGroupCollection
});
}
return this;
}
export function VariantGroupCollection(http, data) {
var obj = cloneDeep(data.variant_groups) || [];
var variantGroupCollection = obj.map(function (userdata) {
return new VariantGroup(http, {
variant_group: userdata,
stackHeaders: data.stackHeaders
});
});
return variantGroupCollection;
}