API Mock folder created

Author: uttamukkoji

README.md

@@ -24,17 +24,15 @@ import contentstack from ‘@contentstack/management’
 ```
 To initialize the SDK, you will need to pass ```axios``` instance as follows:
 ```
-import axios from 'axios'
-contentstackClient = contentstack.client(axios, {})
+contentstackClient = contentstack.client()
 ```
 
 ### Authentication
 To use this SDK, you need to authenticate your users by using the Authtoken, credentials, or Management Token (stack-level token).
 ### Authtoken
 An [Authtoken](https://www.contentstack.com/docs/developers/create-tokens/types-of-tokens/#authentication-tokens-authtokens-) is a read-write token used to make authorized CMA requests, and it is a **user-specific** token.
 ```
-import axios from 'axios'
-contentstackClient = contentstack.client(axios, { authtoken: 'AUTHTOKEN' })
+contentstackClient = contentstack.client({ authtoken: 'AUTHTOKEN' })
 ```
 ### Login
 To Login to Contentstack by using credentials, you can use the following lines of code:
@@ -49,7 +47,7 @@ contentstackClient.login({ email: 'EMAIL', password: 'PASSWORD'})
 ### Management Token
 [Management Tokens](https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens/) are **stack-level** tokens, with no users attached to them.
 ```
-contentstackClient.stack('API_KEY', 'MANAGEMENT_TOKEN')
+contentstackClient.stack({ apiKey: 'API_KEY', managementToken: 'MANAGEMENT_TOKEN' })
 .fetch()
 .then((stack) => {
 	console.log(stack)
@@ -60,14 +58,13 @@ contentstackClient.stack('API_KEY', 'MANAGEMENT_TOKEN')
 To use the JavaScript CMA SDK, you need to first initialize it. To do this, use the following code:
 ```
 import contentstack from ‘@contentstack/management’
-import axios from 'axios'
 
-var contentstackClient = contentstack.client(axios, { authtoken: 'AUTHTOKEN' })
+var contentstackClient = contentstack.client({ authtoken: 'AUTHTOKEN' })
 ```
 #### Fetch Stack Detail
 Use the following lines of code to fetch your stack detail using this SDK:
 ```
-contentstackClient.stack('API_KEY')
+contentstackClient.stack({ apiKey: 'API_KEY' })
 .fetch()
 .then((stack) => {
 	console.log(stack)
@@ -82,7 +79,7 @@ var  entry  = {
 	url: '/sampleEntry'
 }
 
-contentstackClient.stack('API_KEY').contentType('CONTENT_TYPE_UID').entry().create({ entry })
+contentstackClient.stack({ apiKey: 'API_KEY' }).contentType('CONTENT_TYPE_UID').entry().create({ entry })
 .then((entry) => {
 	console.log(entry)
 })
@@ -96,7 +93,7 @@ var  asset  = {
 	title: 'Asset Title'
 }
 
-contentstackClient.stack('API_KEY').asset().create({ asset })
+contentstackClient.stack({ apiKey: 'API_KEY' }).asset().create({ asset })
 .then((asset) => {
 	console.log(asset)
 })

lib/contentstack.js

@@ -2,19 +2,19 @@
  * The Content Management API (CMA) is used to manage the content of your Contentstack account. This includes creating, updating, deleting, and fetching content of your account.
  * @namespace Contentstack
  */
-import httpClient from './core/contentstackHTTPClient.js'
+import packages from '../package.json'
 import clonedeep from 'lodash/cloneDeep'
 import getUserAgent from './core/Util.js'
 import contentstackClient from './contentstackClient.js'
-import packages from '../package.json'
+import httpClient from './core/contentstackHTTPClient.js'
 
 /**
  * Create client instance
  * @name client
  * @memberof Contentstack
- * @param {Object} axios - Axios Object
  * @param {object} params - Client initialization parameters
- * @prop {string} params.host - API host (default: api.contentstack.com)
+ * @param {Object} param.proxy -
+ * @prop {string} params.host - API host (default: api.contentstack.io)
  * @prop {object} params.headers - Optional additional headers
  * @prop {number} params.timeout - Optional number of milliseconds before the request times out. Default is 30000
  * @prop {number} params.retryLimit - Optional number of retries before failure. Default is 5
@@ -24,11 +24,9 @@ import packages from '../package.json'
  * @returns Contentstack.Client
  * @example
  * import * as contentstack from '@contentstack/management'
- * const client = contentstack.client({
- *
- * })
+ * const client = contentstack.client()
  */
-export function client (axios, params) {
+export function client (params = {}) {
   const defaultParameter = {
     defaultHostName: 'api.contentstack.io'
   }
@@ -56,7 +54,7 @@ export function client (axios, params) {
     ...params.headers,
     ...requiredHeaders
   }
-  const http = httpClient(axios, params)
+  const http = httpClient(params)
   const api = contentstackClient({
     http: http
   })

lib/contentstackClient.js

@@ -3,7 +3,7 @@
  */
 import { Stack } from './stack/index.js'
 import { Organization } from './organization/index'
-// import { create, query } from './entity'
+import cloneDeep from 'lodash/cloneDeep'
 import { User } from './user/index'
 import error from './core/contentstackError'
 
@@ -19,7 +19,7 @@ export default function contentstackClient ({ http }) {
    * @returns {Promise}
    * @example
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.login({ email: <emailid>, password: <password> })
    * .then(() => console.log('Logged in successfully'))
@@ -44,7 +44,7 @@ export default function contentstackClient ({ http }) {
    * @returns {Promise}
    * @example
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.getUser()
    * .then((user) => console.log(user))
@@ -60,39 +60,34 @@ export default function contentstackClient ({ http }) {
    * @description Get Stack instance. A stack is a space that stores the content of a project.
    * @memberof ContentstackClient
    * @func stack
-   * @param {String} api_key - Stack API Key
+   * @param {String} apiKey - Stack API Key
+   * @param {String} managementToken - Stack API Key
    * @returns {Stack} Instance of Stack
    *
    * @example
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    * const stack = {name: 'My New Stack'}
    * client.stack().create({ stack }, { organization_uid: 'org_uid' })
    * .then((stack) => console.log(stack))
    *
    * @example
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.stack('api_key').fetch()
    * .then((stack) => console.log(stack))
    *
    * @example
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.stack('api_key', 'management_token').fetch()
    * .then((stack) => console.log(stack))
    *
    */
-  function stack (apiKey = null, managementToken = null) {
-    var stack = {}
-    if (apiKey && apiKey !== undefined) {
-      stack.api_key = apiKey
-    }
-    if (managementToken && managementToken !== undefined) {
-      stack.authorization = managementToken
-    }
+  function stack (params = {}) {
+    var stack = { ...cloneDeep(params) }
     return new Stack(http, { stack })
   }
 
@@ -105,14 +100,14 @@ export default function contentstackClient ({ http }) {
    *
    * @example
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.organization().query().find()
    * .then((organization) => console.log(organization))
    *
    * @example
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.organization('org_uid').fetch()
    * .then((organization) => console.log(organization))
@@ -131,7 +126,7 @@ export default function contentstackClient ({ http }) {
    *
    * @example
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    * const notice = client.logout()
    *
    */

lib/core/contentstack-retry.js

@@ -2,8 +2,6 @@
 export default function contentstckRetry (axios, defaultOptions, retryLimit = 5, retryDelay = 2) {
   var networkError = 0
   axios.interceptors.request.use(function (config) {
-    // var currentState = config['contentstack'] || {}
-    // config['contentstack'] = currentState
     if (config.headers.authorization && config.headers.authorization !== undefined) {
       delete config.headers.authtoken
     }
@@ -22,19 +20,21 @@ export default function contentstckRetry (axios, defaultOptions, retryLimit = 5,
     var response = error.response
     if (!response) {
       retryErrorType = `Server connection`
+      return Promise.reject(error)
+    }
+
+    if (response && response.status === 429) {
+      retryErrorType = 'Rate Limit'
       networkError++
       if (networkError > retryLimit) {
+        networkError = 0
         return Promise.reject(error)
       }
+      wait = retryDelay
     } else {
       networkError = 0
     }
 
-    if (response && response.status === 429) {
-      retryErrorType = 'Rate Limit'
-      wait = retryDelay
-    }
-
     if (retryErrorType && error.config !== undefined) {
       var config = error.config
       defaultOptions.logHandler('warning', `${retryErrorType} error occurred. Waiting for ${wait} ms before retrying...`)

lib/core/contentstackHTTPClient.js

@@ -1,10 +1,10 @@
 import clonedeep from 'lodash/cloneDeep'
 import Qs from 'qs'
-// import axiosRetry from 'axios-retry'
+import axios from 'axios'
 import contentstackRetry from './contentstack-retry'
 const HOST_REGEX = /^(?!\w+:\/\/)([^\s:]+\.[^\s:]+)(?::(\d+))?(?!:)$/
 
-export default function contentstackHttpClient (axios, options) {
+export default function contentstackHttpClient (options) {
   const defaultConfig = {
     insecure: false,
     retryOnError: true,
@@ -65,6 +65,7 @@ export default function contentstackHttpClient (axios, options) {
     timeout: config.timeout,
     adapter: config.adapter,
     maxContentLength: config.maxContentLength,
+    maxBodyLength: config.maxBodyLength,
     // Contentstack
     logHandler: config.logHandler,
     responseLogger: config.responseLogger,

lib/organization/index.js

@@ -24,7 +24,7 @@ export function Organization (http, data) {
      * @returns {Promise<Organization.Organization>} Promise for Organization instance
      * @example
      * import * as contentstack from '@contentstack/management'
-     * const client = contentstack.client({})
+     * const client = contentstack.client()
      *
      * client.organization('organization_uid).fetch()
      * .then((organization) => console.log(organization))
@@ -46,7 +46,7 @@ export function Organization (http, data) {
        * @returns {ContentstackCollection} Instance of ContentstackCollection.
        * @example
        * import * as contentstack from '@contentstack/management'
-       * const client = contentstack.client({})
+       * const client = contentstack.client()
        *
        * client.organization('organization_uid).stacks({ include_count: true })
        * .then((organization) => console.log(organization))
@@ -73,7 +73,7 @@ export function Organization (http, data) {
        * @returns {Object} Response Object.
        * @example
        * import * as contentstack from '@contentstack/management'
-       * const client = contentstack.client({})
+       * const client = contentstack.client()
        *
        * client.stack('api_key').transferOwnership('emailId')
        * .then((notice) => console.log(notice))
@@ -99,7 +99,7 @@ export function Organization (http, data) {
        * @returns {ContentstackCollection} ContentstackCollection of instance.
        * @example
        * import * as contentstack from '@contentstack/management'
-       * const client = contentstack.client({})
+       * const client = contentstack.client()
        *
        * client.organization('organization_uid).addUser({ users: { 'abc@test.com': ['org_uid1', 'org_uid2' ]}, stacks: { 'abc@test.com': { 'api_key1': [ 'stack_role_id' ] } } })
        * .then((response) => console.log(response))
@@ -125,7 +125,7 @@ export function Organization (http, data) {
        * @returns {String} Success message of invitation send.
        * @example
        * import * as contentstack from '@contentstack/management'
-       * const client = contentstack.client({})
+       * const client = contentstack.client()
        *
        * client.organization('organization_uid).getInvitations()
        * .then((notice) => console.log(notice))
@@ -151,7 +151,7 @@ export function Organization (http, data) {
        * @returns {Object} Response Object.
        * @example
        * import * as contentstack from '@contentstack/management'
-       * const client = contentstack.client({})
+       * const client = contentstack.client()
        *
        * client.organization('organization_uid).resendInvitition('invitation_uid')
        * .then((notice) => console.log(notice))
@@ -183,7 +183,7 @@ export function Organization (http, data) {
        * @returns {Array<Role>} Array of Role instance
        * @example
        * import * as contentstack from '@contentstack/management'
-       * const client = contentstack.client({})
+       * const client = contentstack.client()
        *
        * client.organization('organization_uid).roles()
        * .then((roles) => console.log(roles))
@@ -216,7 +216,7 @@ export function Organization (http, data) {
      * @returns {ContentstackCollection} Result collection of content of specified module.
      * @example
      * import * as contentstack from '@contentstack/management'
-     * const client = contentstack.client({})
+     * const client = contentstack.client()
      *
      * client.organization().fetchAll()
      * .then((collection) => console.log(collection))

lib/query/index.js

@@ -17,14 +17,14 @@ export default function Query (http, urlPath, param, stackHeaders = null, wrappe
    * @returns {ContentstackCollection} Result collection of content of specified module.
    * @example All Stack
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.stack().query().find()
    * .then((collection) => console.log(collection))
    *
    * @example Query on stack
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.stack().query( { query: { name: 'Stack name' } }).find()
    * .then((collection) => console.log(collection))
@@ -47,14 +47,14 @@ export default function Query (http, urlPath, param, stackHeaders = null, wrappe
    * @returns {Object} Result is Object of content of specified module.
    * @example All Stack
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.stack().query().count()
    * .then((response) => console.log(response))
    *
    * @example Query on Asset
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.stack('api_key').query({ query: { title: 'Stack name' } }).count()
    * .then((response) => console.log(response))
@@ -81,14 +81,14 @@ export default function Query (http, urlPath, param, stackHeaders = null, wrappe
    * @returns {ContentstackCollection} Result content of specified module.
    * @example Stack
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.stack().query().findOne()
    * .then((collection) => console.log(collection))
    *
    * @example Query on stack
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    *
    * client.stack().query({ query: { title: 'Stack name' } }).findOne()
    * .then((collection) => console.log(collection))

lib/stack/asset/folders/index.js

@@ -22,7 +22,7 @@ export function Folder (http, data = {}) {
    *
    * @example
    * import * as contentstack from '@contentstack/management'
-   * const client = contentstack.client({})
+   * const client = contentstack.client()
    * const asset = {name: 'My New contentType'}
    * client.stack().asset().folders().create({ asset })
    * .then((folder) => console.log(folder))