feat: ✨ app installation configuration api [CS-35745]

uttamukkoji · uttamukkoji · commit 76de1f8cf8e7 · 2023-03-21T14:24:07.000+05:30
diff --git a/lib/app/installation/index.js b/lib/app/installation/index.js
@@ -94,7 +94,127 @@ export function Installation (http, data, params = {}) {
         } || {}
         const response = await http.get(`${this.urlPath}/configuration`, headers)
         if (response.data) {
-          return response.data.data
+          return response.data
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
+    /**
+     * @description To update organization level app installation configuration.
+     * @memberof Installation
+     * @func setConfiguration
+     * @param {*} config Config that needs to be updated
+     * @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').setConfiguration({<configuration_details>})
+     * .then((response) => console.log(response))
+     */
+    this.setConfiguration = async (config) => {
+      try {
+        const headers = {
+          headers: { ...cloneDeep(params) }
+        } || {}
+        const response = await http.put(`${this.urlPath}/configuration`, config, headers)
+        if (response.data) {
+          return response.data
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
+
+    /**
+     * @description To fetch server side organization level config required for the app.
+     * @memberof Installation
+     * @func getServerConfig
+     * @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').serverConfig()
+     * .then((response) => console.log(response))
+     */
+    this.serverConfig = async (param = {}) => {
+      try {
+        const headers = {
+          headers: { ...cloneDeep(params) },
+          params: {
+            ...cloneDeep(param)
+          }
+        } || {}
+        const response = await http.get(`${this.urlPath}/server-configuration`, headers)
+        if (response.data) {
+          return response.data
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
+    /**
+   * @description To update server side organization level config required for the app.
+   * @memberof Installation
+   * @func setServerConfig
+   * @param {*} config Config that needs to be updated
+   * @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').setServerConfig({<configuration_details>})
+   * .then((response) => console.log(response))
+   */
+    this.setServerConfig = async (config) => {
+      try {
+        const headers = {
+          headers: { ...cloneDeep(params) }
+        } || {}
+        const response = await http.put(`${this.urlPath}/server-configuration`, config, headers)
+        if (response.data) {
+          return response.data
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
+
+    /**
+     * @description To fetch installation data of an app configuration.
+     * @memberof Installation
+     * @func installationData
+     * @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').installationData()
+     * .then((response) => console.log(response))
+     */
+    this.installationData = async () => {
+      try {
+        const headers = {
+          headers: { ...cloneDeep(params) }
+        } || {}
+        const response = await http.get(`${this.urlPath}/installationData`, headers)
+        if (response.data) {
+          return response.data
         } else {
           throw error(response)
         }
diff --git a/test/api/app-test.js b/test/api/app-test.js
@@ -133,10 +133,39 @@ describe('Apps api Test', () => {
       .catch(done)
   })
 
+  it('Get installationData for installation test', done => {
+    client.organization(orgID).app(appUid).installation(installationUid).installationData()
+      .then((installation) => {
+        expect(installation).to.not.equal(null)
+        done()
+      }).catch(done)
+  })
+
   it('Get configuration for installation test', done => {
     client.organization(orgID).app(appUid).installation(installationUid).configuration()
-      .then((installation) => {
-        expect(installation).to.deep.equal({})
+      .then((config) => {
+        expect(config).to.not.equal(null)
+        done()
+      }).catch(done)
+  })
+  it('Set configuration for installation test', done => {
+    client.organization(orgID).app(appUid).installation(installationUid).setConfiguration({})
+      .then((config) => {
+        expect(config.data).to.deep.equal({})
+        done()
+      }).catch(done)
+  })
+  it('Get server config for installation test', done => {
+    client.organization(orgID).app(appUid).installation(installationUid).serverConfig()
+      .then((config) => {
+        expect(config).to.not.equal(null)
+        done()
+      }).catch(done)
+  })
+  it('Set server config for installation test', done => {
+    client.organization(orgID).app(appUid).installation(installationUid).serServerConfig({})
+      .then((config) => {
+        expect(config.data).to.deep.equal({})
         done()
       }).catch(done)
   })
diff --git a/test/typescript/app.ts b/test/typescript/app.ts
@@ -158,13 +158,40 @@ export function installation(organization: Organization) {
             }).catch(done)
         })
 
+        test('Get installation data for App installation', done => {
+            organization.app(appUid).installation(installationUid).installationData()
+            .then(() => {
+                done()
+            }).catch(done)
+        })
+
         test('Get Configuration for App installation', done => {
             organization.app(appUid).installation(installationUid).configuration()
             .then(() => {
                 done()
             }).catch(done)
         })
 
+        test('Get Server Configuration for App installation', done => {
+            organization.app(appUid).installation(installationUid).serverConfig()
+            .then(() => {
+                done()
+            }).catch(done)
+        })
+
+        test('Set Configuration for App installation', done => {
+            organization.app(appUid).installation(installationUid).setConfiguration({})
+            .then(() => {
+                done()
+            }).catch(done)
+        })
+        test('Set Server Configuration for App installation', done => {
+            organization.app(appUid).installation(installationUid).setServerConfig({})
+            .then(() => {
+                done()
+            }).catch(done)
+        })
+
         test('Uninstall App installation', done => {
             organization.app(appUid).installation(installationUid).uninstall()
             .then((installation) => {
diff --git a/test/unit/apps-test.js b/test/unit/apps-test.js
@@ -46,6 +46,7 @@ describe('Contentstack apps test', () => {
     expect(app.hosting()).to.not.equal(undefined)
     expect(app.installation()).to.not.equal(undefined)
     expect(app.installation(uid)).to.not.equal(undefined)
+    expect(app.authorization()).to.not.equal(undefined)
     done()
   })
 
diff --git a/test/unit/installation-test.js b/test/unit/installation-test.js
@@ -14,6 +14,11 @@ describe('Contentstack apps installation test', () => {
     expect(installation.update).to.be.equal(undefined)
     expect(installation.uninstall).to.be.equal(undefined)
     expect(installation.findAll).to.be.equal(undefined)
+    expect(installation.installationData).to.be.equal(undefined)
+    expect(installation.configuration).to.be.equal(undefined)
+    expect(installation.setConfiguration).to.be.equal(undefined)
+    expect(installation.serverConfig).to.be.equal(undefined)
+    expect(installation.setServerConfig).to.be.equal(undefined)
     done()
   })
 
@@ -24,6 +29,11 @@ describe('Contentstack apps installation test', () => {
     expect(installation.fetch).to.be.equal(undefined)
     expect(installation.update).to.be.equal(undefined)
     expect(installation.uninstall).to.be.equal(undefined)
+    expect(installation.installationData).to.be.equal(undefined)
+    expect(installation.configuration).to.be.equal(undefined)
+    expect(installation.setConfiguration).to.be.equal(undefined)
+    expect(installation.serverConfig).to.be.equal(undefined)
+    expect(installation.setServerConfig).to.be.equal(undefined)
     expect(installation.findAll).to.not.equal(undefined)
     done()
   })
@@ -35,6 +45,11 @@ describe('Contentstack apps installation test', () => {
     expect(installation.fetch).to.not.equal(undefined)
     expect(installation.update).to.not.equal(undefined)
     expect(installation.uninstall).to.not.equal(undefined)
+    expect(installation.installationData).to.not.equal(undefined)
+    expect(installation.configuration).to.not.equal(undefined)
+    expect(installation.setConfiguration).to.not.equal(undefined)
+    expect(installation.serverConfig).to.not.equal(undefined)
+    expect(installation.setServerConfig).to.not.equal(undefined)
     expect(installation.findAll).to.be.equal(undefined)
     done()
   })
@@ -114,6 +129,22 @@ describe('Contentstack apps installation test', () => {
       .catch(done)
   })
 
+  it('Get installation installationData test', done => {
+    const mock = new MockAdapter(Axios)
+    const uid = installationMock.uid
+    mock.onGet(`/installations/${uid}/installationData`).reply(200, {
+      data: {}
+    })
+
+    makeInstallation({ data: { uid } })
+      .installationData()
+      .then((data) => {
+        expect(data).to.not.equal(null)
+        done()
+      })
+      .catch(done)
+  })
+
   it('Get installation configuration test', done => {
     const mock = new MockAdapter(Axios)
     const uid = installationMock.uid
@@ -123,8 +154,53 @@ describe('Contentstack apps installation test', () => {
 
     makeInstallation({ data: { uid } })
       .configuration()
-      .then((configuration) => {
-        expect(configuration).to.deep.equal({})
+      .then((data) => {
+        expect(data).to.not.equal(null)
+        done()
+      })
+      .catch(done)
+  })
+  it('Set installation configuration test', done => {
+    const mock = new MockAdapter(Axios)
+    const uid = installationMock.uid
+    mock.onPut(`/installations/${uid}/configuration`).reply(200, {
+      data: {}
+    })
+
+    makeInstallation({ data: { uid } })
+      .setConfiguration({})
+      .then((data) => {
+        expect(data).to.not.equal(null)
+        done()
+      })
+      .catch(done)
+  })
+  it('Get installation server config test', done => {
+    const mock = new MockAdapter(Axios)
+    const uid = installationMock.uid
+    mock.onGet(`/installations/${uid}/server-configuration`).reply(200, {
+      data: {}
+    })
+
+    makeInstallation({ data: { uid } })
+      .serverConfig()
+      .then((data) => {
+        expect(data).to.not.equal(null)
+        done()
+      })
+      .catch(done)
+  })
+  it('Get installation installationData test', done => {
+    const mock = new MockAdapter(Axios)
+    const uid = installationMock.uid
+    mock.onPut(`/installations/${uid}/server-configuration`).reply(200, {
+      data: {}
+    })
+
+    makeInstallation({ data: { uid } })
+      .setServerConfig({})
+      .then((data) => {
+        expect(data).to.not.equal(null)
         done()
       })
       .catch(done)
diff --git a/types/app/installation.d.ts b/types/app/installation.d.ts
@@ -1,11 +1,15 @@
 import { ContentstackCollection } from "../contentstackCollection";
 import { AnyProperty, SystemFields } from "../utility/fields";
 
-export interface Installation extends SystemFields{
+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>
+    setConfiguration(config: AnyProperty): Promise<AnyProperty>
+    serverConfig(param?: AnyProperty): Promise<AnyProperty>
+    setServerConfig(config: AnyProperty): Promise<AnyProperty>
+    installationData(): Promise<AnyProperty>
 }
 
 export interface Installations {
