refactor: Removed type-check

Author: trodrigues

lib/contentful.js

@@ -6,17 +6,6 @@
 
 import createHttpClient from './create-http-client'
 import createCdaApi from './create-cda-api'
-import {typeCheck} from './type-check'
-
-const ClientParams = `{
-  space: String,
-  accessToken: String,
-  insecure: Maybe Boolean,
-  host: Maybe String,
-  resolveLinks: Maybe Boolean,
-  agent: Maybe Object,
-  headers: Maybe Object
-}`
 
 /**
  * Create a client instance
@@ -46,8 +35,6 @@ export default function createClient (axios, params) {
     throw new TypeError('Expected parameter space')
   }
 
-  typeCheck(ClientParams, params)
-
   // Use resolveLinks param if specified, otherwise default to true
   const resolveLinks = !!('resolveLinks' in params ? params.resolveLinks : true)
 

lib/create-cda-api.js

@@ -182,3 +182,78 @@ export default function createCdaApi (http, resolveLinksGlobalSetting) {
     sync: sync
   }
 }
+
+/**
+ * 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 Entities
+ * @typedef Sys
+ * @prop {string} type
+ * @prop {string} id
+ * @prop {Entities.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 Entities
+ * @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
+ */
+
+/**
+ * @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 Entities
+ * @typedef Field
+ * @type EntryFields.Symbol | EntryFields.Text | EntryFields.Integer | EntryFields.Number | EntryFields.Date | EntryFields.Boolean | EntryFields.Location | Entities.Link | Array<EntryFields.Symbol|Entities.Link> | Object
+ */

lib/entities/asset.js

@@ -1,7 +1,4 @@
-import {typeCheck} from '../type-check'
 import {cloneDeep} from 'lodash/lang'
-import {SysProps} from './sys'
-import Field from './field'
 import mixinToPlainObject from '../mixins/to-plain-object'
 
 /**
@@ -19,23 +16,13 @@ import mixinToPlainObject from '../mixins/to-plain-object'
  * @prop {Object} fields.file.details - Details for the file, depending on file type (example: image size in bytes, etc)
  * @prop {function(): Object} toPlainObject() - Returns this Asset as a plain JS object
  */
-const Asset = `{
-  sys: {
-    ${SysProps},
-    locale: String
-  },
-  fields: Field
-}`
-
-export default Asset
 
 /**
  * @private
  * @param {Object} data - Raw asset data
  * @return {Asset} Wrapped asset data
  */
 export function wrapAsset (data) {
-  typeCheck(Asset, data, [Field])
   return Object.freeze(mixinToPlainObject(cloneDeep(data)))
 }
 
@@ -48,19 +35,12 @@ export function wrapAsset (data) {
  * @prop {Array<Entities.Asset>} items
  * @prop {function(): Object} toPlainObject() - Returns this Asset collection as a plain JS object
  */
-const AssetCollection = `{
-  total: Number,
-  skip: Number,
-  limit: Number,
-  items: [${Asset}]
-}`
 
 /**
  * @private
  * @param {Object} data - Raw asset collection data
  * @return {AssetCollection} Wrapped asset collection data
  */
 export function wrapAssetCollection (data) {
-  typeCheck(AssetCollection, data, [Field])
   return Object.freeze(mixinToPlainObject(cloneDeep(data)))
 }

lib/entities/content-type.js

@@ -1,6 +1,4 @@
-import {typeCheck} from '../type-check'
 import {cloneDeep} from 'lodash/lang'
-import Sys from './sys'
 import mixinToPlainObject from '../mixins/to-plain-object'
 
 /**
@@ -13,29 +11,13 @@ import mixinToPlainObject from '../mixins/to-plain-object'
  * @prop {string} Array<Field> - All the fields contained in this Content Type
  * @prop {function(): Object} toPlainObject() - Returns this Content Type as a plain JS object
  */
-const ContentType = `{
-  sys: ${Sys},
-  name: String,
-  description: String,
-  displayField: String,
-  fields: [
-    {
-      id: String,
-      name: String,
-      type: String,
-      localized: Boolean,
-      required: Boolean
-    }
-  ]
-}`
 
 /**
  * @private
  * @param {Object} data - Raw content type data
  * @return {ContentType} Wrapped content type data
  */
 export function wrapContentType (data) {
-  typeCheck(ContentType, data)
   return Object.freeze(mixinToPlainObject(cloneDeep(data)))
 }
 
@@ -48,19 +30,12 @@ export function wrapContentType (data) {
  * @prop {Array<Entities.ContentType>} items
  * @prop {function(): Object} toPlainObject() - Returns this Content Type collection as a plain JS object
  */
-const ContentTypeCollection = `{
-  total: Number,
-  skip: Number,
-  limit: Number,
-  items: [${ContentType}]
-}`
 
 /**
  * @private
  * @param {Object} data - Raw content type collection data
  * @return {ContentTypeCollection} Wrapped content type collection data
  */
 export function wrapContentTypeCollection (data) {
-  typeCheck(ContentTypeCollection, data)
   return Object.freeze(mixinToPlainObject(cloneDeep(data)))
 }

lib/entities/entry.js

@@ -1,9 +1,4 @@
-import {typeCheck} from '../type-check'
 import {cloneDeep} from 'lodash/lang'
-import {SysProps} from './sys'
-import Field from './field'
-import Link from './link'
-import Asset from './Asset'
 import mixinToPlainObject from '../mixins/to-plain-object'
 import mixinLinkGetters from '../mixins/link-getters'
 
@@ -16,24 +11,13 @@ import mixinLinkGetters from '../mixins/link-getters'
  * @prop {Object<EntryFields.Field>} fields - Object with content for each field
  * @prop {function(): Object} toPlainObject() - Returns this Entry as a plain JS object
  */
-const Entry = `{
-  sys: {
-    ${SysProps},
-    locale: String,
-    contentType: ${Link}
-  },
-  fields: Field
-}`
-
-export default Entry
 
 /**
  * @private
  * @param {Object} data - Raw entry data
  * @return {Entry} Wrapped entry data
  */
 export function wrapEntry (data) {
-  typeCheck(Entry, data, [Field])
   return Object.freeze(mixinToPlainObject(cloneDeep(data)))
 }
 
@@ -46,18 +30,6 @@ export function wrapEntry (data) {
  * @prop {Array<Entities.Entry>} items
  * @prop {function(): Object} toPlainObject() - Returns this Entry collection as a plain JS object
  */
-const EntryCollection = `{
-  total: Number,
-  skip: Number,
-  limit: Number,
-  items: [${Entry}],
-  includes: Maybe {
-    Entry: Maybe [${Entry}],
-    Asset: Maybe [${Asset}],
-    DeletedEntry: Maybe [${Entry}],
-    DeletedAsset: Maybe [${Asset}]
-  }
-}`
 
 /**
  * Data is also mixed in with link getters if links exist and includes were requested
@@ -66,7 +38,6 @@ const EntryCollection = `{
  * @return {EntryCollection} Wrapped entry collection data
  */
 export function wrapEntryCollection (data, resolveLinks) {
-  typeCheck(EntryCollection, data, [Field])
   const wrappedData = mixinToPlainObject(cloneDeep(data))
   if (wrappedData.includes && resolveLinks) {
     mixinLinkGetters(wrappedData.items, wrappedData.includes)

lib/entities/field.js

@@ -1,63 +1,11 @@
 import {typeCheck} from '../type-check'
 import Link from './link'
 
-/**
- * @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
- */
 const Location = `{
   lat: String,
   lon: String
 }`
 
-/**
- * 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 Entities
- * @typedef Field
- * @type EntryFields.Symbol | EntryFields.Text | EntryFields.Integer | EntryFields.Number | EntryFields.Date | EntryFields.Boolean | EntryFields.Location | Entities.Link | Array<EntryFields.Symbol|Entities.Link> | Object
- */
 export default {
   name: 'Field',
   type: {

lib/entities/link.js

@@ -1,4 +1,3 @@
-import {typeCheck} from '../type-check'
 import mixinToPlainObject from '../mixins/to-plain-object'
 
 /**
@@ -11,21 +10,12 @@ import mixinToPlainObject from '../mixins/to-plain-object'
  * @prop {Array<string>} locales - Array with locale codes
  * @prop {function(): Object} toPlainObject() - Returns this Space as a plain JS object
  */
-const Space = `{
-  sys: {
-    id: String,
-    type: String
-  },
-  name: String,
-  locales: [String]
-}`
 
 /**
  * @private
  * @param  {Object} data - API response for a Space
  * @return {Space}
  */
 export function wrapSpace (data) {
-  typeCheck(Space, data)
   return Object.freeze(mixinToPlainObject(data))
 }