Source: contentful.js

  1. 'use strict';
  3. Object.defineProperty(exports, "__esModule", {
  4.   value: true
  5. });
  6. exports.default = createClient;
  8. var _defaults = require('lodash/defaults');
  10. var _defaults2 = _interopRequireDefault(_defaults);
  12. var _assign = require('lodash/assign');
  14. var _assign2 = _interopRequireDefault(_assign);
  16. var _cloneDeep = require('lodash/cloneDeep');
  18. var _cloneDeep2 = _interopRequireDefault(_cloneDeep);
  20. var _version = require('../version');
  22. var _version2 = _interopRequireDefault(_version);
  24. var _createHttpClient = require('contentful-sdk-core/create-http-client');
  26. var _createHttpClient2 = _interopRequireDefault(_createHttpClient);
  28. var _wrapHttpClient = require('contentful-sdk-core/wrap-http-client');
  30. var _wrapHttpClient2 = _interopRequireDefault(_wrapHttpClient);
  32. var _createContentfulApi = require('./create-contentful-api');
  34. var _createContentfulApi2 = _interopRequireDefault(_createContentfulApi);
  36. var _createLinkResolver = require('./create-link-resolver');
  38. var _createLinkResolver2 = _interopRequireDefault(_createLinkResolver);
  40. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  42. /**
  43.  * Create a client instance
  44.  * @func
  45.  * @name createClient
  46.  * @memberof contentful
  47.  * @param {Object} params - Client initialization parameters
  48.  * @prop {string} params.space - Space ID
  49.  * @prop {string} params.accessToken - Contentful CDA Access Token
  50.  * @prop {boolean=} params.insecure - Requests will be made over http instead of the default https (default: true)
  51.  * @prop {string=} params.host - API host (default: cdn.contentful.com). Also usable with preview.contentful.com.
  52.  * @prop {Object=} params.agent - Optional Node.js HTTP agent for proxying (see <a href="https://nodejs.org/api/http.html#http_class_http_agent">Node.js docs</a> and <a href="https://www.npmjs.com/package/https-proxy-agent">https-proxy-agent</a>)
  53.  * @prop {Object=} params.headers - Optional additional headers
  54.  * @prop {number=} params.concurrency - Number of allowed concurrent requests. Changing this value is not recommended. (default: 6)
  55.  * @prop {number=} params.delay - Delay in milliseconds for waiting after hitting the allowed number of concurrent requests. Changing this value is not recommended. (default: 1000)
  56.  * @prop {number=} params.maxRetries - Maximum number of retries when a 429 is received (default: 5)
  57.  * @prop {boolean=} params.retryOnTooManyRequests - If we should retry on 429s (default: true)
  58.  * @prop {boolean=} params.resolveLinks - If we should resolve links between entries  
  59.  * @returns {ContentfulClientAPI.ClientAPI}
  60.  * @example
  61.  * const client = contentful.createClient({
  62.  *  accessToken: 'myAccessToken',
  63.  *  space: 'mySpaceId'
  64.  * })
  65.  */
  66. /**
  67.  * Contentful Delivery API SDK. Allows you to create instances of a client
  68.  * with access to the Contentful Content Delivery API.
  69.  * @namespace contentful
  70.  * @see ContentfulClientAPI
  71.  */
  73. function createClient(axios, params) {
  74.   params = (0, _defaults2.default)((0, _cloneDeep2.default)(params), {
  75.     rateLimit: 9,
  76.     rateLimitPeriod: 1000,
  77.     maxRetries: 5,
  78.     retryOnTooManyRequests: true
  79.   });
  81.   if (!params.accessToken) {
  82.     throw new TypeError('Expected parameter accessToken');
  83.   }
  85.   if (!params.space) {
  86.     throw new TypeError('Expected parameter space');
  87.   }
  89.   // Use resolveLinks param if specified, otherwise default to true
  90.   var resolveLinks = !!('resolveLinks' in params ? params.resolveLinks : true);
  91.   var shouldLinksResolve = (0, _createLinkResolver2.default)(resolveLinks);
  93.   params.defaultHostname = 'cdn.contentful.com';
  94.   params.headers = (0, _assign2.default)(params.headers, {
  95.     'Content-Type': 'application/vnd.contentful.delivery.v1+json',
  96.     'X-Contentful-User-Agent': 'contentful.js/' + _version2.default
  97.   });
  99.   var http = (0, _wrapHttpClient2.default)((0, _createHttpClient2.default)(axios, params), {
  100.     concurrency: params.rateLimit,
  101.     delay: params.rateLimitPeriod,
  102.     maxRetries: params.maxRetries,
  103.     retryOnTooManyRequests: params.retryOnTooManyRequests
  104.   });
  106.   return (0, _createContentfulApi2.default)({
  107.     http: http,
  108.     shouldLinksResolve: shouldLinksResolve
  109.   });
  110. }