Source: entities/space.js

  1. 'use strict';
  3. Object.defineProperty(exports, "__esModule", {
  4.   value: true
  5. });
  6. exports.wrapSpace = wrapSpace;
  7. exports.wrapSpaceCollection = wrapSpaceCollection;
  9. var _cloneDeep = require('lodash/cloneDeep');
  11. var _cloneDeep2 = _interopRequireDefault(_cloneDeep);
  13. var _freezeSys = require('contentful-sdk-core/freeze-sys');
  15. var _freezeSys2 = _interopRequireDefault(_freezeSys);
  17. var _toPlainObject = require('contentful-sdk-core/mixins/to-plain-object');
  19. var _toPlainObject2 = _interopRequireDefault(_toPlainObject);
  21. var _wrapHttpClient = require('contentful-sdk-core/wrap-http-client');
  23. var _wrapHttpClient2 = _interopRequireDefault(_wrapHttpClient);
  25. var _enhanceWithMethods = require('../enhance-with-methods');
  27. var _enhanceWithMethods2 = _interopRequireDefault(_enhanceWithMethods);
  29. var _createSpaceApi = require('../create-space-api');
  31. var _createSpaceApi2 = _interopRequireDefault(_createSpaceApi);
  33. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  35. /**
  36.  * @memberof Space
  37.  * @typedef Space
  38.  * @prop {Object} sys - System metadata
  39.  * @prop {string} sys.id - Space id
  40.  * @prop {string} sys.type - Entity type
  41.  * @prop {string} name - Space name
  42.  * @prop {Array<string>} locales - Array with locale codes
  43.  * @prop {function(): Object} toPlainObject() - Returns this Space as a plain JS object
  44.  */
  46. /**
  47.  * @memberof Space
  48.  * @typedef SpaceCollection
  49.  * @prop {number} total
  50.  * @prop {number} skip
  51.  * @prop {number} limit
  52.  * @prop {Array<Space.Space>} items
  53.  * @prop {function(): Object} toPlainObject() - Returns this Space collection as a plain JS object
  54.  */
  56. /**
  57.  * This method creates the API for the given space with all the methods for
  58.  * reading and creating other entities. It also passes down a clone of the
  59.  * http client with a space id, so the base path for requests now has the
  60.  * space id already set.
  61.  * @private
  62.  * @param  {Object} http - HTTP client instance
  63.  * @param  {Object} data - API response for a Space
  64.  * @return {Space}
  65.  */
  66. function wrapSpace(http, data) {
  67.   var space = (0, _toPlainObject2.default)((0, _cloneDeep2.default)(data));
  68.   var _http$httpClientParam = http.httpClientParams;
  69.   var rateLimit = _http$httpClientParam.rateLimit;
  70.   var rateLimitPeriod = _http$httpClientParam.rateLimitPeriod;
  71.   var maxRetries = _http$httpClientParam.maxRetries;
  72.   var retryOnTooManyRequests = _http$httpClientParam.retryOnTooManyRequests;
  74.   var httpClientParams = {
  75.     concurrency: rateLimit,
  76.     delay: rateLimitPeriod,
  77.     maxRetries: maxRetries,
  78.     retryOnTooManyRequests: retryOnTooManyRequests
  79.   };
  80.   var spaceScopedHttpClient = (0, _wrapHttpClient2.default)(http.cloneWithNewParams({
  81.     space: space.sys.id
  82.   }), httpClientParams);
  83.   var spaceApi = (0, _createSpaceApi2.default)({
  84.     http: spaceScopedHttpClient
  85.   });
  86.   var enhancedSpace = (0, _enhanceWithMethods2.default)(space, spaceApi);
  87.   return (0, _freezeSys2.default)(enhancedSpace);
  88. }
  90. /**
  91.  * This method wraps each space in a collection with the space API. See wrapSpace
  92.  * above for more details.
  93.  * @private
  94.  * @param  {Object} http - HTTP client instance
  95.  * @param  {Object} data - API response for a Space collection
  96.  * @return {SpaceCollection}
  97.  */
  98. function wrapSpaceCollection(http, data) {
  99.   var spaces = (0, _toPlainObject2.default)((0, _cloneDeep2.default)(data));
  100.   spaces.items = spaces.items.map(function (entity) {
  101.     return wrapSpace(http, entity);
  102.   });
  103.   return (0, _freezeSys2.default)(spaces);
  104. }