Skip to content

Commit 76de1f8

Browse files
uttamukkojiuttamukkoji
committed
feat: ✨ app installation configuration api [CS-35745]
1 parent 93f3e38 commit 76de1f8

6 files changed

Lines changed: 263 additions & 6 deletions

File tree

‎lib/app/installation/index.js‎

Lines changed: 121 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,127 @@ export function Installation (http, data, params = {}) {
9494
} || {}
9595
const response = await http.get(`${this.urlPath}/configuration`, headers)
9696
if (response.data) {
97-
return response.data.data
97+
return response.data
98+
} else {
99+
throw error(response)
100+
}
101+
} catch (err) {
102+
throw error(err)
103+
}
104+
}
105+
/**
106+
* @description To update organization level app installation configuration.
107+
* @memberof Installation
108+
* @func setConfiguration
109+
* @param {*} config Config that needs to be updated
110+
* @returns {Promise<Response>}
111+
*
112+
* @example
113+
* import * as contentstack from '@contentstack/management'
114+
* const client = contentstack.client({ authtoken: 'TOKEN'})
115+
*
116+
* client.organization('organization_uid').app('app_uid').installation('installation_uid').setConfiguration({<configuration_details>})
117+
* .then((response) => console.log(response))
118+
*/
119+
this.setConfiguration = async (config) => {
120+
try {
121+
const headers = {
122+
headers: { ...cloneDeep(params) }
123+
} || {}
124+
const response = await http.put(`${this.urlPath}/configuration`, config, headers)
125+
if (response.data) {
126+
return response.data
127+
} else {
128+
throw error(response)
129+
}
130+
} catch (err) {
131+
throw error(err)
132+
}
133+
}
134+
135+
/**
136+
* @description To fetch server side organization level config required for the app.
137+
* @memberof Installation
138+
* @func getServerConfig
139+
* @param {*} param
140+
* @returns {Promise<Response>}
141+
*
142+
* @example
143+
* import * as contentstack from '@contentstack/management'
144+
* const client = contentstack.client({ authtoken: 'TOKEN'})
145+
*
146+
* client.organization('organization_uid').app('app_uid').installation('installation_uid').serverConfig()
147+
* .then((response) => console.log(response))
148+
*/
149+
this.serverConfig = async (param = {}) => {
150+
try {
151+
const headers = {
152+
headers: { ...cloneDeep(params) },
153+
params: {
154+
...cloneDeep(param)
155+
}
156+
} || {}
157+
const response = await http.get(`${this.urlPath}/server-configuration`, headers)
158+
if (response.data) {
159+
return response.data
160+
} else {
161+
throw error(response)
162+
}
163+
} catch (err) {
164+
throw error(err)
165+
}
166+
}
167+
/**
168+
* @description To update server side organization level config required for the app.
169+
* @memberof Installation
170+
* @func setServerConfig
171+
* @param {*} config Config that needs to be updated
172+
* @returns {Promise<Response>}
173+
*
174+
* @example
175+
* import * as contentstack from '@contentstack/management'
176+
* const client = contentstack.client({ authtoken: 'TOKEN'})
177+
*
178+
* client.organization('organization_uid').app('app_uid').installation('installation_uid').setServerConfig({<configuration_details>})
179+
* .then((response) => console.log(response))
180+
*/
181+
this.setServerConfig = async (config) => {
182+
try {
183+
const headers = {
184+
headers: { ...cloneDeep(params) }
185+
} || {}
186+
const response = await http.put(`${this.urlPath}/server-configuration`, config, headers)
187+
if (response.data) {
188+
return response.data
189+
} else {
190+
throw error(response)
191+
}
192+
} catch (err) {
193+
throw error(err)
194+
}
195+
}
196+
197+
/**
198+
* @description To fetch installation data of an app configuration.
199+
* @memberof Installation
200+
* @func installationData
201+
* @returns {Promise<Response>}
202+
*
203+
* @example
204+
* import * as contentstack from '@contentstack/management'
205+
* const client = contentstack.client({ authtoken: 'TOKEN'})
206+
*
207+
* client.organization('organization_uid').app('app_uid').installation('installation_uid').installationData()
208+
* .then((response) => console.log(response))
209+
*/
210+
this.installationData = async () => {
211+
try {
212+
const headers = {
213+
headers: { ...cloneDeep(params) }
214+
} || {}
215+
const response = await http.get(`${this.urlPath}/installationData`, headers)
216+
if (response.data) {
217+
return response.data
98218
} else {
99219
throw error(response)
100220
}

‎test/api/app-test.js‎

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,39 @@ describe('Apps api Test', () => {
133133
.catch(done)
134134
})
135135

136+
it('Get installationData for installation test', done => {
137+
client.organization(orgID).app(appUid).installation(installationUid).installationData()
138+
.then((installation) => {
139+
expect(installation).to.not.equal(null)
140+
done()
141+
}).catch(done)
142+
})
143+
136144
it('Get configuration for installation test', done => {
137145
client.organization(orgID).app(appUid).installation(installationUid).configuration()
138-
.then((installation) => {
139-
expect(installation).to.deep.equal({})
146+
.then((config) => {
147+
expect(config).to.not.equal(null)
148+
done()
149+
}).catch(done)
150+
})
151+
it('Set configuration for installation test', done => {
152+
client.organization(orgID).app(appUid).installation(installationUid).setConfiguration({})
153+
.then((config) => {
154+
expect(config.data).to.deep.equal({})
155+
done()
156+
}).catch(done)
157+
})
158+
it('Get server config for installation test', done => {
159+
client.organization(orgID).app(appUid).installation(installationUid).serverConfig()
160+
.then((config) => {
161+
expect(config).to.not.equal(null)
162+
done()
163+
}).catch(done)
164+
})
165+
it('Set server config for installation test', done => {
166+
client.organization(orgID).app(appUid).installation(installationUid).serServerConfig({})
167+
.then((config) => {
168+
expect(config.data).to.deep.equal({})
140169
done()
141170
}).catch(done)
142171
})

‎test/typescript/app.ts‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,13 +158,40 @@ export function installation(organization: Organization) {
158158
}).catch(done)
159159
})
160160

161+
test('Get installation data for App installation', done => {
162+
organization.app(appUid).installation(installationUid).installationData()
163+
.then(() => {
164+
done()
165+
}).catch(done)
166+
})
167+
161168
test('Get Configuration for App installation', done => {
162169
organization.app(appUid).installation(installationUid).configuration()
163170
.then(() => {
164171
done()
165172
}).catch(done)
166173
})
167174

175+
test('Get Server Configuration for App installation', done => {
176+
organization.app(appUid).installation(installationUid).serverConfig()
177+
.then(() => {
178+
done()
179+
}).catch(done)
180+
})
181+
182+
test('Set Configuration for App installation', done => {
183+
organization.app(appUid).installation(installationUid).setConfiguration({})
184+
.then(() => {
185+
done()
186+
}).catch(done)
187+
})
188+
test('Set Server Configuration for App installation', done => {
189+
organization.app(appUid).installation(installationUid).setServerConfig({})
190+
.then(() => {
191+
done()
192+
}).catch(done)
193+
})
194+
168195
test('Uninstall App installation', done => {
169196
organization.app(appUid).installation(installationUid).uninstall()
170197
.then((installation) => {

‎test/unit/apps-test.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ describe('Contentstack apps test', () => {
4646
expect(app.hosting()).to.not.equal(undefined)
4747
expect(app.installation()).to.not.equal(undefined)
4848
expect(app.installation(uid)).to.not.equal(undefined)
49+
expect(app.authorization()).to.not.equal(undefined)
4950
done()
5051
})
5152

‎test/unit/installation-test.js‎

Lines changed: 78 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ describe('Contentstack apps installation test', () => {
1414
expect(installation.update).to.be.equal(undefined)
1515
expect(installation.uninstall).to.be.equal(undefined)
1616
expect(installation.findAll).to.be.equal(undefined)
17+
expect(installation.installationData).to.be.equal(undefined)
18+
expect(installation.configuration).to.be.equal(undefined)
19+
expect(installation.setConfiguration).to.be.equal(undefined)
20+
expect(installation.serverConfig).to.be.equal(undefined)
21+
expect(installation.setServerConfig).to.be.equal(undefined)
1722
done()
1823
})
1924

@@ -24,6 +29,11 @@ describe('Contentstack apps installation test', () => {
2429
expect(installation.fetch).to.be.equal(undefined)
2530
expect(installation.update).to.be.equal(undefined)
2631
expect(installation.uninstall).to.be.equal(undefined)
32+
expect(installation.installationData).to.be.equal(undefined)
33+
expect(installation.configuration).to.be.equal(undefined)
34+
expect(installation.setConfiguration).to.be.equal(undefined)
35+
expect(installation.serverConfig).to.be.equal(undefined)
36+
expect(installation.setServerConfig).to.be.equal(undefined)
2737
expect(installation.findAll).to.not.equal(undefined)
2838
done()
2939
})
@@ -35,6 +45,11 @@ describe('Contentstack apps installation test', () => {
3545
expect(installation.fetch).to.not.equal(undefined)
3646
expect(installation.update).to.not.equal(undefined)
3747
expect(installation.uninstall).to.not.equal(undefined)
48+
expect(installation.installationData).to.not.equal(undefined)
49+
expect(installation.configuration).to.not.equal(undefined)
50+
expect(installation.setConfiguration).to.not.equal(undefined)
51+
expect(installation.serverConfig).to.not.equal(undefined)
52+
expect(installation.setServerConfig).to.not.equal(undefined)
3853
expect(installation.findAll).to.be.equal(undefined)
3954
done()
4055
})
@@ -114,6 +129,22 @@ describe('Contentstack apps installation test', () => {
114129
.catch(done)
115130
})
116131

132+
it('Get installation installationData test', done => {
133+
const mock = new MockAdapter(Axios)
134+
const uid = installationMock.uid
135+
mock.onGet(`/installations/${uid}/installationData`).reply(200, {
136+
data: {}
137+
})
138+
139+
makeInstallation({ data: { uid } })
140+
.installationData()
141+
.then((data) => {
142+
expect(data).to.not.equal(null)
143+
done()
144+
})
145+
.catch(done)
146+
})
147+
117148
it('Get installation configuration test', done => {
118149
const mock = new MockAdapter(Axios)
119150
const uid = installationMock.uid
@@ -123,8 +154,53 @@ describe('Contentstack apps installation test', () => {
123154

124155
makeInstallation({ data: { uid } })
125156
.configuration()
126-
.then((configuration) => {
127-
expect(configuration).to.deep.equal({})
157+
.then((data) => {
158+
expect(data).to.not.equal(null)
159+
done()
160+
})
161+
.catch(done)
162+
})
163+
it('Set installation configuration test', done => {
164+
const mock = new MockAdapter(Axios)
165+
const uid = installationMock.uid
166+
mock.onPut(`/installations/${uid}/configuration`).reply(200, {
167+
data: {}
168+
})
169+
170+
makeInstallation({ data: { uid } })
171+
.setConfiguration({})
172+
.then((data) => {
173+
expect(data).to.not.equal(null)
174+
done()
175+
})
176+
.catch(done)
177+
})
178+
it('Get installation server config test', done => {
179+
const mock = new MockAdapter(Axios)
180+
const uid = installationMock.uid
181+
mock.onGet(`/installations/${uid}/server-configuration`).reply(200, {
182+
data: {}
183+
})
184+
185+
makeInstallation({ data: { uid } })
186+
.serverConfig()
187+
.then((data) => {
188+
expect(data).to.not.equal(null)
189+
done()
190+
})
191+
.catch(done)
192+
})
193+
it('Get installation installationData test', done => {
194+
const mock = new MockAdapter(Axios)
195+
const uid = installationMock.uid
196+
mock.onPut(`/installations/${uid}/server-configuration`).reply(200, {
197+
data: {}
198+
})
199+
200+
makeInstallation({ data: { uid } })
201+
.setServerConfig({})
202+
.then((data) => {
203+
expect(data).to.not.equal(null)
128204
done()
129205
})
130206
.catch(done)

‎types/app/installation.d.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
import { ContentstackCollection } from "../contentstackCollection";
22
import { AnyProperty, SystemFields } from "../utility/fields";
33

4-
export interface Installation extends SystemFields{
4+
export interface Installation extends SystemFields {
55
update(param?: AnyProperty): Promise<Installation>
66
fetch(param?: AnyProperty): Promise<Installation>
77
uninstall(param?: AnyProperty): Promise<AnyProperty>
88
configuration(param?: AnyProperty): Promise<AnyProperty>
9+
setConfiguration(config: AnyProperty): Promise<AnyProperty>
10+
serverConfig(param?: AnyProperty): Promise<AnyProperty>
11+
setServerConfig(config: AnyProperty): Promise<AnyProperty>
12+
installationData(): Promise<AnyProperty>
913
}
1014

1115
export interface Installations {

0 commit comments

Comments
 (0)