/**
* Contentful Management API Client. Contains methods which allow access to
* any operations that can be performed with a management token.
* @namespace ContentfulClientAPI
*/
/**
* Types for meta information found across the different entities in Contentful
* @namespace Meta
*/
/**
* System metadata. See <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/common-resource-attributes">Common Resource Attributes</a> for more details.
* @memberof Meta
* @typedef Sys
* @prop {string} type
* @prop {string} id
* @prop {Meta.Link} space
* @prop {string} createdAt
* @prop {string} updatedAt
* @prop {number} revision
*/
/**
* Link to another entity. See <a href="https://www.contentful.com/developers/docs/concepts/links/">Links</a> for more details.
* @memberof Meta
* @typedef Link
* @prop {string} type - type of this entity. Always link.
* @prop {string} id
* @prop {string} linkType - type of this link. If defined, either Entry or Asset
*/
/**
* @memberof ContentfulClientAPI
* @typedef {Object} ClientAPI
* @prop {function} getSpace
* @prop {function} getSpaces
* @prop {function} createSpace
*/
import { createRequestConfig } from 'contentful-sdk-core'
import errorHandler from './error-handler'
import entities from './entities'
/**
* Creates API object with methods to access functionality from Contentful's
* Management API
* @private
* @param {Object} params - API initialization params
* @prop {Object} http - HTTP client instance
* @prop {Function} shouldLinksResolve - Link resolver preconfigured with global setting
* @return {ClientAPI}
*/
export default function createClientApi ({ http }) {
const {wrapSpace, wrapSpaceCollection} = entities.space
const {wrapOrganizationCollection} = entities.organization
/**
* Gets all spaces
* @memberof ContentfulClientAPI
* @return {Promise<Space.SpaceCollection>} Promise for a collection of Spaces
* @example
* const contentful = require('contentful-management')
*
* const client = contentful.createClient({
* accessToken: '<content_management_api_key>'
* })
*
* client.getSpaces()
* .then((response) => console.log(response.items))
* .catch(console.error)
*/
function getSpaces (query = {}) {
return http.get('', createRequestConfig({query: query}))
.then((response) => wrapSpaceCollection(http, response.data), errorHandler)
}
/**
* Gets a space
* @memberof ContentfulClientAPI
* @param {string} id - Space ID
* @return {Promise<Space.Space>} Promise for a Space
* @example
* const contentful = require('contentful-management')
*
* const client = contentful.createClient({
* accessToken: '<content_management_api_key>'
* })
*
* client.getSpace('<space_id>')
* .then((space) => console.log(space))
* .catch(console.error)
*/
function getSpace (id) {
return http.get(id)
.then((response) => wrapSpace(http, response.data), errorHandler)
}
/**
* Creates a space
* @memberof ContentfulClientAPI
* @see {Space.Space}
* @param {object} data - Object representation of the Space to be created
* @param {string=} organizationId - Organization ID, if the associated token can manage more than one organization.
* @return {Promise<Space.Space>} Promise for the newly created Space
* @example
* const contentful = require('contentful-management')
*
* const client = contentful.createClient({
* accessToken: '<content_management_api_key>'
* })
*
* client.createSpace({
* name: 'Name of new space'
* })
* .then((space) => console.log(space))
* .catch(console.error)
*/
function createSpace (data, organizationId) {
return http.post('', data, {
headers: organizationId ? {'X-Contentful-Organization': organizationId} : {}
})
.then((response) => wrapSpace(http, response.data), errorHandler)
}
/**
* Gets a collection of Organizations
* @memberof ClientAPI
* @return {Promise<OrganizationCollection>} Promise for a collection of Organizations
* @example
* const contentful = require('contentful-management')
*
* space.getOrganizations()
* .then(result => console.log(result.items))
* .catch(console.error)
*/
function getOrganizations () {
const baseURL = http.defaults.baseURL.replace('/spaces/', '/organizations/')
return http.get('', {
baseURL
})
.then((response) => wrapOrganizationCollection(http, response.data), errorHandler)
}
/**
* Make a custom request to the Contentful management API's /spaces endpoint
* @memberof ContentfulClientAPI
* @param {Object} opts - axios request options (https://github.com/mzabriskie/axios)
* @return {Promise<Object>} Promise for the response data
* @example
* const contentful = require('contentful-management')
*
* const client = contentful.createClient({
* accessToken: '<content_management_api_key>'
* })
*
* client.rawRequest({
* method: 'GET',
* url: '/custom/path'
* })
* .then((responseData) => console.log(responseData))
* .catch(console.error)
*/
function rawRequest (opts) {
return http(opts).then((response) => response.data, errorHandler)
}
return {
getSpaces: getSpaces,
getSpace: getSpace,
createSpace: createSpace,
getOrganizations: getOrganizations,
rawRequest: rawRequest
}
}