feat: ✨ Marketplace app implementation done

Author: uttamukkoji

lib/app/index.js

@@ -70,7 +70,7 @@ export function App (http, data) {
        * const client = contentstack.client({ authtoken: 'TOKEN'})
        *
        * client.organization('organization_uid').app('app_uid').delete()
-       * .then((app) => console.log(app))
+       * .then((response) => console.log(response))
        */
       this.delete = deleteEntity(http, false, this.params)
 
@@ -152,6 +152,8 @@ export function App (http, data) {
 
       /**
        * @description The install call is used to initiate the installation of the app
+       * @memberof App
+       * @func install
        * @param {String} param.targetType - The target on which app needs to be installed, stack or ogranization.
        * @param {String} param.targetUid - The uid of the target, on which the app will be installed
        * @returns Promise<Installation>
@@ -181,6 +183,8 @@ export function App (http, data) {
 
       /**
        * @description The Installation will allow you to fetch, update and delete of the app installation.
+       * @memberof App
+       * @func installation
        * @param {String} uid Installation uid
        * @returns Installation
        *
@@ -232,17 +236,17 @@ export function App (http, data) {
       this.create = create({ http, params: this.params })
 
       /**
-       * @description The create an app call is used for creating a new app in your Contentstack organization.
+       * @description The get all apps call is used to fetch all the apps in your Contentstack organization.
        * @memberof App
-       * @func create
+       * @func findAll
        * @returns {Promise<ContentstackCollection<App>>}
        *
        * @example
        * import * as contentstack from '@contentstack/management'
        * const client = contentstack.client({ authtoken: 'TOKEN'})
        *
        * client.organization('organization_uid').app().fetchAll()
-       * .then((app) => console.log(app))
+       * .then((collection) => console.log(collection))
        *
        */
       this.findAll = fetchAll(http, AppCollection, this.params)

lib/app/installation/index.js

@@ -1,4 +1,5 @@
 import cloneDeep from 'lodash/cloneDeep'
+import error from '../../core/contentstackError'
 import { deleteEntity, fetch, fetchAll, update } from '../../entity'
 
 export function Installation (http, data, params = {}) {
@@ -16,7 +17,7 @@ export function Installation (http, data, params = {}) {
     this.urlPath = `/installations/${this.uid}`
 
     /**
-     * @description The GET installation call is used to retrieve a specific installation of an app
+     * @description The GET installation call is used to retrieve a specific installation of an app.
      * @memberof Installation
      * @func fetch
      * @returns {Promise<Installation>}
@@ -32,7 +33,7 @@ export function Installation (http, data, params = {}) {
     this.fetch = fetch(http, 'data', this.params)
 
     /**
-     * @description The Update installation call is used to update information of an app
+     * @description The Update installation call is used to update information of an installation.
      * @memberof Installation
      * @func update
      * @returns {Promise<Installation>}
@@ -65,24 +66,57 @@ export function Installation (http, data, params = {}) {
      * const client = contentstack.client({ authtoken: 'TOKEN'})
      *
      * client.organization('organization_uid').app('app_uid').installation('installation_uid').uninstall()
-     * .then((app) => console.log(app))
+     * .then((response) => console.log(response))
      */
     this.uninstall = deleteEntity(http, false, this.params)
+
+    /**
+     * @description To fetch organization level app installation configuration.
+     * @memberof Installation
+     * @func configuration
+     * @param {*} param
+     * @returns {Promise<Response>}
+     *
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client({ authtoken: 'TOKEN'})
+     *
+     * client.organization('organization_uid').app('app_uid').installation('installation_uid').configuration()
+     * .then((response) => console.log(response))
+     */
+    this.configuration = async (param = {}) => {
+      try {
+        const headers = {
+          headers: { ...cloneDeep(params) },
+          params: {
+            ...cloneDeep(param)
+          }
+        } || {}
+        const response = await http.get(`${this.urlPath}/configuration`, headers)
+        if (response.data) {
+          return response.data.data
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
   } else {
     if (data.app_uid) {
       this.urlPath = `apps/${data.app_uid}/installations`
       /**
-       * @description The create an app call is used for creating a new app in your Contentstack organization.
+       * @description The find installation call is used to retrieve all installations of your Contentstack organization.
        * @memberof Installation
-       * @func create
+       * @func findAll
        * @returns {Promise<ContentstackCollection<Installation>>}
        *
        * @example
        * import * as contentstack from '@contentstack/management'
        * const client = contentstack.client({ authtoken: 'TOKEN'})
        *
        * client.organization('organization_uid').app('app_uid').installation().fetchAll()
-       * .then((app) => console.log(app))
+       * .then((collection) => console.log(collection))
        *
        */
       this.findAll = fetchAll(http, InstallationCollection, this.params)

test/api/app-test.js

@@ -117,6 +117,14 @@ describe('Apps api Test', () => {
       .catch(done)
   })
 
+  it('Get configuration for installation test', done => {
+    client.organization(orgID).app(appUid).installation(installationUid).configuration()
+      .then((installation) => {
+        expect(installation).to.deep.equal({})
+        done()
+      }).catch(done)
+  })
+
   it('Fetch installation test', done => {
     client.organization(orgID).app(appUid).installation(installationUid).fetch()
       .then((installation) => {

test/typescript/app.ts

@@ -145,6 +145,13 @@ export function installation(organization: Organization) {
             }).catch(done)
         })
 
+        test('Get Configuration for App installation', done => {
+            organization.app(appUid).installation(installationUid).configuration()
+            .then(() => {
+                done()
+            }).catch(done)
+        })
+
         test('Uninstall App installation', done => {
             organization.app(appUid).installation(installationUid).uninstall()
             .then((installation) => {

test/unit/apps-test.js

@@ -176,6 +176,7 @@ function checkApp (app) {
   expect(app.description).to.be.equal('Description of the app')
   expect(app.organization_uid).to.be.equal('org_uid')
 }
+
 function makeApp (data) {
   return new App(Axios, data)
 }

test/unit/installation-test.js

@@ -17,7 +17,7 @@ describe('Contentstack apps installation test', () => {
     done()
   })
 
-  it('Installation with app uid', done => { 
+  it('Installation with app uid', done => {
     const uid = appMock.uid
     const installation = makeInstallation({ app_uid: uid })
     expect(installation.urlPath).to.be.equal(`apps/${uid}/installations`)
@@ -91,11 +91,7 @@ describe('Contentstack apps installation test', () => {
       .findAll()
       .then((installations) => {
         installations.items.forEach(installation => {
-          expect(installation.status).to.be.equal(installationMock.status)
-          expect(installation.uid).to.be.equal(installationMock.uid)
-          expect(installation.organization_uid).to.be.equal(installationMock.organization_uid)
-          expect(installation.target.type).to.be.equal(installationMock.target.type)
-          expect(installation.target.uid).to.be.equal(installationMock.target.uid)
+          checkInstallation(installation)
         })
         done()
       })
@@ -112,11 +108,23 @@ describe('Contentstack apps installation test', () => {
     makeInstallation({ data: { uid } })
       .fetch()
       .then((installation) => {
-        expect(installation.status).to.be.equal(installationMock.status)
-        expect(installation.uid).to.be.equal(installationMock.uid)
-        expect(installation.organization_uid).to.be.equal(installationMock.organization_uid)
-        expect(installation.target.type).to.be.equal(installationMock.target.type)
-        expect(installation.target.uid).to.be.equal(installationMock.target.uid)
+        checkInstallation(installation)
+        done()
+      })
+      .catch(done)
+  })
+
+  it('Get installation configuration test', done => {
+    const mock = new MockAdapter(Axios)
+    const uid = installationMock.uid
+    mock.onGet(`/installations/${uid}/configuration`).reply(200, {
+      data: {}
+    })
+
+    makeInstallation({ data: { uid } })
+      .configuration()
+      .then((configuration) => {
+        expect(configuration).to.deep.equal({})
         done()
       })
       .catch(done)
@@ -131,11 +139,7 @@ describe('Contentstack apps installation test', () => {
     makeInstallation({ data: { uid } })
       .update()
       .then((installation) => {
-        expect(installation.status).to.be.equal(installationMock.status)
-        expect(installation.uid).to.be.equal(installationMock.uid)
-        expect(installation.organization_uid).to.be.equal(installationMock.organization_uid)
-        expect(installation.target.type).to.be.equal(installationMock.target.type)
-        expect(installation.target.uid).to.be.equal(installationMock.target.uid)
+        checkInstallation(installation)
         done()
       })
       .catch(done)
@@ -156,6 +160,14 @@ describe('Contentstack apps installation test', () => {
   })
 })
 
+function checkInstallation (installation) {
+  expect(installation.status).to.be.equal(installationMock.status)
+  expect(installation.uid).to.be.equal(installationMock.uid)
+  expect(installation.organization_uid).to.be.equal(installationMock.organization_uid)
+  expect(installation.target.type).to.be.equal(installationMock.target.type)
+  expect(installation.target.uid).to.be.equal(installationMock.target.uid)
+}
+
 function makeInstallation (data, param = {}) {
   return new Installation(Axios, data, param)
 }

types/app/installation.d.ts

@@ -5,6 +5,7 @@ export interface Installation extends SystemFields{
     update(param?: AnyProperty): Promise<Installation>
     fetch(param?: AnyProperty): Promise<Installation>
     uninstall(param?: AnyProperty): Promise<AnyProperty>
+    configuration(param?: AnyProperty): Promise<AnyProperty>
 }
 
 export interface Installations {