'use strict';
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.wrapEntry = wrapEntry;
exports.wrapEntryCollection = wrapEntryCollection;
var _cloneDeep = require('lodash/cloneDeep');
var _cloneDeep2 = _interopRequireDefault(_cloneDeep);
var _freezeSys = require('contentful-sdk-core/freeze-sys');
var _freezeSys2 = _interopRequireDefault(_freezeSys);
var _enhanceWithMethods = require('../enhance-with-methods');
var _enhanceWithMethods2 = _interopRequireDefault(_enhanceWithMethods);
var _toPlainObject = require('contentful-sdk-core/mixins/to-plain-object');
var _toPlainObject2 = _interopRequireDefault(_toPlainObject);
var _instanceActions = require('../instance-actions');
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
/**
* Types of fields found in an Entry
* @namespace EntryFields
*/
/**
* @memberof EntryFields
* @typedef Symbol
* @type string
*/
/**
* @memberof EntryFields
* @typedef Text
* @type string
*/
/**
* @memberof EntryFields
* @typedef Integer
* @type number
*/
/**
* @memberof EntryFields
* @typedef Number
* @type number
*/
/**
* @memberof EntryFields
* @typedef Date
* @type string
*/
/**
* @memberof EntryFields
* @typedef Boolean
* @type boolean
*/
/**
* @memberof EntryFields
* @typedef Location
* @prop {string} lat - latitude
* @prop {string} lon - longitude
*/
/**
* A Field in an Entry can have one of the following types that can be defined in Contentful. See <a href="https://www.contentful.com/developers/docs/references/field-type/">Field Types</a> for more details.
* @memberof EntryFields
* @typedef Field
* @type EntryFields.Symbol | EntryFields.Text | EntryFields.Integer | EntryFields.Number | EntryFields.Date | EntryFields.Boolean | EntryFields.Location | Meta.Link | Array<EntryFields.Symbol|Meta.Link> | Object
*/
/**
* @memberof Entry
* @typedef Entry
* @prop {Meta.Sys} sys - Standard system metadata with additional entry specific properties
* @prop {Meta.Link} sys.contentType - Content Type used by this Entry
* @prop {string=} sys.locale - If present, indicates the locale which this entry uses
* @prop {Object<EntryFields.Field>} fields - Object with content for each field
* @prop {function(): Object} toPlainObject() - Returns this Entry as a plain JS object
*/
function createEntryApi(http) {
return {
/**
* Sends an update to the server with any changes made to the object's properties
* @memberof Entry
* @func update
* @return {Promise<Entry>} Object returned from the server with updated changes.
* @example
* entry.fields.name['en-US'] = 'Blog Post'
* entry.update()
* .then(entry => console.log(entry.fields.name['en-US']))
*/
update: (0, _instanceActions.createUpdateEntity)({
http: http,
entityPath: 'entries',
wrapperMethod: wrapEntry
}),
/**
* Deletes this object on the server.
* @memberof Entry
* @func delete
* @return {Promise} Promise for the deletion. It contains no data, but the Promise error case should be handled.
* @example
* entry.delete()
* .catch(err => console.log(err))
*/
delete: (0, _instanceActions.createDeleteEntity)({
http: http,
entityPath: 'entries'
}),
/**
* Publishes the object
* @memberof Entry
* @func publish
* @return {Promise<Entry>} Object returned from the server with updated metadata.
* @example
* entry.publish()
* .then(entry => console.log(entry.sys.publishedVersion))
*/
publish: (0, _instanceActions.createPublishEntity)({
http: http,
entityPath: 'entries',
wrapperMethod: wrapEntry
}),
/**
* Unpublishes the object
* @memberof Entry
* @func unpublish
* @return {Promise<Entry>} Object returned from the server with updated metadata.
* @example
* entry.unpublish()
* .then(entry => console.log(entry.sys))
*/
unpublish: (0, _instanceActions.createUnpublishEntity)({
http: http,
entityPath: 'entries',
wrapperMethod: wrapEntry
}),
/**
* Archives the object
* @memberof Entry
* @func archive
* @return {Promise<Entry>} Object returned from the server with updated metadata.
* @example
* entry.archive()
* .then(entry => console.log(entry.sys.archivedVersion))
*/
archive: (0, _instanceActions.createArchiveEntity)({
http: http,
entityPath: 'entries',
wrapperMethod: wrapEntry
}),
/**
* Unarchives the object
* @memberof Entry
* @func unarchive
* @return {Promise<Entry>} Object returned from the server with updated metadata.
* @example
* entry.unarchive()
* .then(entry => console.log(entry.sys))
*/
unarchive: (0, _instanceActions.createUnarchiveEntity)({
http: http,
entityPath: 'entries',
wrapperMethod: wrapEntry
}),
/**
* Checks if the entry is published. A published entry might have unpublished changes (@see {Entry.isUpdated})
* @memberof Entry
* @func isPublished
* @return {boolean}
*/
isPublished: (0, _instanceActions.createPublishedChecker)(),
/**
* Checks if the entry is updated. This means the entry was previously published but has unpublished changes.
* @memberof Entry
* @func isUpdated
* @return {boolean}
*/
isUpdated: (0, _instanceActions.createUpdatedChecker)(),
/**
* Checks if the entry is in draft mode. This means it is not published.
* @memberof Entry
* @func isDraft
* @return {boolean}
*/
isDraft: (0, _instanceActions.createDraftChecker)(),
/**
* Checks if entry is archived. This means it's not exposed to the Delivery/Preview APIs.
* @memberof Entry
* @func isArchived
* @return {boolean}
*/
isArchived: (0, _instanceActions.createArchivedChecker)()
};
}
/**
* @private
* @param {Object} http - HTTP client instance
* @param {Object} data - Raw entry data
* @return {Entry} Wrapped entry data
*/
/**
* Entry instances
* @namespace Entry
*/
function wrapEntry(http, data) {
var entry = (0, _toPlainObject2.default)((0, _cloneDeep2.default)(data));
(0, _enhanceWithMethods2.default)(entry, createEntryApi(http));
return (0, _freezeSys2.default)(entry);
}
/**
* @memberof Entry
* @typedef EntryCollection
* @prop {number} total
* @prop {number} skip
* @prop {number} limit
* @prop {Array<Entry.Entry>} items
* @prop {Array<Object>=} errors - Array of errors that might occur when retrieving entries.
* @prop {function(): Object} toPlainObject() - Returns this Entry collection as a plain JS object
*/
/**
* Data is also mixed in with link getters if links exist and includes were requested
* @private
* @param {Object} http - HTTP client instance
* @param {Object} data - Raw entry collection data
* @return {EntryCollection} Wrapped entry collection data
*/
function wrapEntryCollection(http, data, resolveLinks) {
var entries = (0, _toPlainObject2.default)((0, _cloneDeep2.default)(data));
entries.items = entries.items.map(function (entity) {
return wrapEntry(http, entity);
});
return (0, _freezeSys2.default)(entries);
}