@cobaltio/cobalt-js 1.0.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -59,11 +59,11 @@ cobalt.token = "COBALT_SESSION_TOKEN";
59
59
  ## Typedefs
60
60
 
61
61
  <dl>
62
- <dt><a href="#AppConfig">AppConfig</a> : <code>object</code></dt>
62
+ <dt><a href="#Config">Config</a> : <code>object</code></dt>
63
63
  <dd><p>The configuration data for an application.</p>
64
64
  </dd>
65
- <dt><a href="#AppInstance">AppInstance</a> : <code>Object</code></dt>
66
- <dd><p>An installed application.</p>
65
+ <dt><a href="#SavedConfig">SavedConfig</a> : <code>Object</code></dt>
66
+ <dd><p>An saved config.</p>
67
67
  </dd>
68
68
  <dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
69
69
  <dd><p>The workflow.</p>
@@ -90,11 +90,11 @@ Cobalt Frontend SDK
90
90
  * [.authCustom(applicationId, payload)](#Cobalt+authCustom) ⇒ <code>Promise.&lt;unknown&gt;</code>
91
91
  * [.checkAuth(application)](#Cobalt+checkAuth) ⇒ <code>Promise.&lt;Boolean&gt;</code>
92
92
  * [.removeAuth(application, [applicationId])](#Cobalt+removeAuth) ⇒ <code>Promise.&lt;void&gt;</code>
93
- * [.getAppConfig(application)](#Cobalt+getAppConfig) ⇒ [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig)
94
- * [.install(applicationId, payload)](#Cobalt+install) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
95
- * [.getInstallation(applicationId, installationId)](#Cobalt+getInstallation) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
96
- * [.updateInstallation(applicationId, installationId, payload)](#Cobalt+updateInstallation) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
97
- * [.deleteInstallation(applicationId, installationId)](#Cobalt+deleteInstallation) ⇒ <code>Promise.&lt;unknown&gt;</code>
93
+ * [.getConfig(application)](#Cobalt+getConfig) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
94
+ * [.saveConfig(applicationId, payload)](#Cobalt+saveConfig) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
95
+ * [.getSavedConfig(applicationId, configId)](#Cobalt+getSavedConfig) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
96
+ * [.updateSavedConfig(applicationId, configId, payload)](#Cobalt+updateSavedConfig) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
97
+ * [.deleteSavedConfig(applicationId, configId)](#Cobalt+deleteSavedConfig) ⇒ <code>Promise.&lt;unknown&gt;</code>
98
98
 
99
99
  <a name="new_Cobalt_new"></a>
100
100
 
@@ -170,73 +170,73 @@ Unauthorize the specified application and remove any associated data from Cobalt
170
170
  | application | <code>String</code> | The application type. |
171
171
  | [applicationId] | <code>String</code> | The application ID in case of custom applications. |
172
172
 
173
- <a name="Cobalt+getAppConfig"></a>
173
+ <a name="Cobalt+getConfig"></a>
174
174
 
175
- ### cobalt.getAppConfig(application) ⇒ [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig)
175
+ ### cobalt.getConfig(application) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
176
176
  Returns the configuration data for the specified application.
177
177
 
178
178
  **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
179
- **Returns**: [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig) - The specified application's configuration data.
179
+ **Returns**: [<code>Promise.&lt;Config&gt;</code>](#Config) - The specified application's configuration data.
180
180
 
181
181
  | Param | Type | Description |
182
182
  | --- | --- | --- |
183
183
  | application | <code>String</code> | The application ID. |
184
184
 
185
- <a name="Cobalt+install"></a>
185
+ <a name="Cobalt+saveConfig"></a>
186
186
 
187
- ### cobalt.install(applicationId, payload) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
188
- Install the specified application.
187
+ ### cobalt.saveConfig(applicationId, payload) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
188
+ Save the specified config.
189
189
 
190
190
  **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
191
- **Returns**: [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance) - The specified application installation.
191
+ **Returns**: [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig) - The specified saved config.
192
192
 
193
193
  | Param | Type | Description |
194
194
  | --- | --- | --- |
195
195
  | applicationId | <code>String</code> | The application ID. |
196
- | payload | [<code>AppInstance</code>](#AppInstance) | The install payload. |
196
+ | payload | [<code>SavedConfig</code>](#SavedConfig) | The config payload. |
197
197
 
198
- <a name="Cobalt+getInstallation"></a>
198
+ <a name="Cobalt+getSavedConfig"></a>
199
199
 
200
- ### cobalt.getInstallation(applicationId, installationId) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
201
- Returns the specified application installation.
200
+ ### cobalt.getSavedConfig(applicationId, configId) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
201
+ Returns the specified saved config.
202
202
 
203
203
  **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
204
- **Returns**: [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance) - The specified application installation.
204
+ **Returns**: [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig) - The specified saved config.
205
205
 
206
206
  | Param | Type | Description |
207
207
  | --- | --- | --- |
208
208
  | applicationId | <code>String</code> | The application ID. |
209
- | installationId | <code>String</code> | The installation ID of the application instance. |
209
+ | configId | <code>String</code> | The config ID of the saved config. |
210
210
 
211
- <a name="Cobalt+updateInstallation"></a>
211
+ <a name="Cobalt+updateSavedConfig"></a>
212
212
 
213
- ### cobalt.updateInstallation(applicationId, installationId, payload) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
214
- Update the specified application installation.
213
+ ### cobalt.updateSavedConfig(applicationId, configId, payload) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
214
+ Update the specified saved config.
215
215
 
216
216
  **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
217
- **Returns**: [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance) - The specified application installation.
217
+ **Returns**: [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig) - The specified saved config.
218
218
 
219
219
  | Param | Type | Description |
220
220
  | --- | --- | --- |
221
221
  | applicationId | <code>String</code> | The application ID. |
222
- | installationId | <code>String</code> | The installation ID of the application instance. |
223
- | payload | [<code>AppInstance</code>](#AppInstance) | The update payload. |
222
+ | configId | <code>String</code> | The config ID of the saved config. |
223
+ | payload | [<code>SavedConfig</code>](#SavedConfig) | The update payload. |
224
224
 
225
- <a name="Cobalt+deleteInstallation"></a>
225
+ <a name="Cobalt+deleteSavedConfig"></a>
226
226
 
227
- ### cobalt.deleteInstallation(applicationId, installationId) ⇒ <code>Promise.&lt;unknown&gt;</code>
228
- Delete the specified installation.
227
+ ### cobalt.deleteSavedConfig(applicationId, configId) ⇒ <code>Promise.&lt;unknown&gt;</code>
228
+ Delete the specified saved config.
229
229
 
230
230
  **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
231
231
 
232
232
  | Param | Type | Description |
233
233
  | --- | --- | --- |
234
234
  | applicationId | <code>String</code> | The application ID. |
235
- | installationId | <code>String</code> | The installation ID of the application instance. |
235
+ | configId | <code>String</code> | The config ID of the saved config. |
236
236
 
237
- <a name="AppConfig"></a>
237
+ <a name="Config"></a>
238
238
 
239
- ## AppConfig : <code>object</code>
239
+ ## Config : <code>object</code>
240
240
  The configuration data for an application.
241
241
 
242
242
  **Kind**: global typedef
@@ -247,17 +247,17 @@ The configuration data for an application.
247
247
  | application_data_slots | <code>Array.&lt;DataSlot&gt;</code> | Array of application data slots. |
248
248
  | workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Array of workflows. |
249
249
 
250
- <a name="AppInstance"></a>
250
+ <a name="SavedConfig"></a>
251
251
 
252
- ## AppInstance : <code>Object</code>
253
- An installed application.
252
+ ## SavedConfig : <code>Object</code>
253
+ An saved config.
254
254
 
255
255
  **Kind**: global typedef
256
256
  **Properties**
257
257
 
258
258
  | Name | Type | Description |
259
259
  | --- | --- | --- |
260
- | [installation_id] | <code>String</code> | Unique ID for the installation. |
260
+ | [config_id] | <code>String</code> | Unique ID for the saved config. |
261
261
  | application_data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of application data slots and their values. |
262
262
  | workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Whether the workflow is enabled. |
263
263
 
package/cobalt.js CHANGED
@@ -181,7 +181,7 @@ class Cobalt {
181
181
  }
182
182
 
183
183
  /**
184
- * @typedef {object} AppConfig The configuration data for an application.
184
+ * @typedef {object} Config The configuration data for an application.
185
185
  * @property {DataSlot[]} application_data_slots Array of application data slots.
186
186
  * @property {Workflow[]} workflows Array of workflows.
187
187
  */
@@ -189,9 +189,9 @@ class Cobalt {
189
189
  /**
190
190
  * Returns the configuration data for the specified application.
191
191
  * @param {String} application The application ID.
192
- * @returns {Promise<AppConfig>} The specified application's configuration data.
192
+ * @returns {Promise<Config>} The specified application's configuration data.
193
193
  */
194
- async getAppConfig(application) {
194
+ async getConfig(application) {
195
195
  const res = await fetch(`${this.baseUrl}/api/v1/application/${application}/config`, {
196
196
  headers: {
197
197
  authorization: `Bearer ${this.token}`,
@@ -206,8 +206,8 @@ class Cobalt {
206
206
  }
207
207
 
208
208
  /**
209
- * @typedef {Object} AppInstance An installed application.
210
- * @property {String} [installation_id] Unique ID for the installation.
209
+ * @typedef {Object} SavedConfig An saved config.
210
+ * @property {String} [config_id] Unique ID for the saved config.
211
211
  * @property {Object.<string, string | number | boolean>} application_data_slots A map of application data slots and their values.
212
212
  * @property {Workflow[]} workflows Whether the workflow is enabled.
213
213
  */
@@ -220,12 +220,12 @@ class Cobalt {
220
220
  */
221
221
 
222
222
  /**
223
- * Install the specified application.
223
+ * Save the specified config.
224
224
  * @param {String} applicationId The application ID.
225
- * @param {AppInstance} payload The install payload.
226
- * @returns {Promise<AppInstance>} The specified application installation.
225
+ * @param {SavedConfig} payload The config payload.
226
+ * @returns {Promise<SavedConfig>} The specified saved config.
227
227
  */
228
- async install(applicationId, payload = {}) {
228
+ async saveConfig(applicationId, payload = {}) {
229
229
  const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/install`, {
230
230
  method: "POST",
231
231
  headers: {
@@ -243,13 +243,13 @@ class Cobalt {
243
243
  }
244
244
 
245
245
  /**
246
- * Returns the specified application installation.
246
+ * Returns the specified saved config.
247
247
  * @param {String} applicationId The application ID.
248
- * @param {String} installationId The installation ID of the application instance.
249
- * @returns {Promise<AppInstance>} The specified application installation.
248
+ * @param {String} configId The config ID of the saved config.
249
+ * @returns {Promise<SavedConfig>} The specified saved config.
250
250
  */
251
- async getInstallation(applicationId, installationId) {
252
- const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`, {
251
+ async getSavedConfig(applicationId, configId) {
252
+ const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`, {
253
253
  headers: {
254
254
  authorization: `Bearer ${this.token}`,
255
255
  },
@@ -263,14 +263,14 @@ class Cobalt {
263
263
  }
264
264
 
265
265
  /**
266
- * Update the specified application installation.
266
+ * Update the specified saved config.
267
267
  * @param {String} applicationId The application ID.
268
- * @param {String} installationId The installation ID of the application instance.
269
- * @param {AppInstance} payload The update payload.
270
- * @returns {Promise<AppInstance>} The specified application installation.
268
+ * @param {String} configId The config ID of the saved config.
269
+ * @param {SavedConfig} payload The update payload.
270
+ * @returns {Promise<SavedConfig>} The specified saved config.
271
271
  */
272
- async updateInstallation(applicationId, installationId, payload = {}) {
273
- const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`, {
272
+ async updateSavedConfig(applicationId, configId, payload = {}) {
273
+ const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`, {
274
274
  method: "PUT",
275
275
  headers: {
276
276
  authorization: `Bearer ${this.token}`,
@@ -287,13 +287,13 @@ class Cobalt {
287
287
  }
288
288
 
289
289
  /**
290
- * Delete the specified installation.
290
+ * Delete the specified saved config.
291
291
  * @param {String} applicationId The application ID.
292
- * @param {String} installationId The installation ID of the application instance.
292
+ * @param {String} configId The config ID of the saved config.
293
293
  * @returns {Promise<unknown>}
294
294
  */
295
- async deleteInstallation(applicationId, installationId) {
296
- const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`, {
295
+ async deleteSavedConfig(applicationId, configId) {
296
+ const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`, {
297
297
  method: "DELETE",
298
298
  headers: {
299
299
  authorization: `Bearer ${this.token}`,
package/cobalt.min.js CHANGED
@@ -1 +1 @@
1
- class Cobalt{constructor(options){this.baseUrl=options?.baseUrl||"https://api.gocobalt.io";this.token=options?.token}get token(){return this.sessionToken}set token(token){return this.sessionToken=typeof token==="string"?token:""}async getOAuthUrl(application){const res=await fetch(`${this.baseUrl}/api/v1/${application}/integrate`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data?.auth_url}async oauth(application){return new Promise((resolve,reject)=>{this.getOAuthUrl(application).then(oauthUrl=>{const connectWindow=window.open(oauthUrl);const interval=setInterval(()=>{this.checkAuth(application).then(connected=>{if(connected===true){connectWindow?.close();clearInterval(interval);resolve(true)}else{if(connectWindow?.closed){clearInterval(interval);resolve(false)}}}).catch(e=>{console.error(e);clearInterval(interval);reject(e)})},3e3)}).catch(reject)})}async auth(application,payload){const res=await fetch(`${this.baseUrl}/api/v1/${application}/save`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify({...payload})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data}async authCustom(applicationId,payload){const res=await fetch(`${this.baseUrl}/api/v1/custom/${applicationId}/save`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify({...payload})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data}async checkAuth(application){const res=await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/auth?integration_type=${application}`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return!!data?.status}async removeAuth(application,applicationId){const res=await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/${application}?app_id=${applicationId}`,{method:"DELETE",headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}}async getAppConfig(application){const res=await fetch(`${this.baseUrl}/api/v1/application/${application}/config`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async install(applicationId,payload={}){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/install`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify(payload)});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async getInstallation(applicationId,installationId){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async updateInstallation(applicationId,installationId,payload={}){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`,{method:"PUT",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify(payload)});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async deleteInstallation(applicationId,installationId){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`,{method:"DELETE",headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}}module.exports=Cobalt;
1
+ class Cobalt{constructor(options){this.baseUrl=options?.baseUrl||"https://api.gocobalt.io";this.token=options?.token}get token(){return this.sessionToken}set token(token){return this.sessionToken=typeof token==="string"?token:""}async getOAuthUrl(application){const res=await fetch(`${this.baseUrl}/api/v1/${application}/integrate`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data?.auth_url}async oauth(application){return new Promise((resolve,reject)=>{this.getOAuthUrl(application).then(oauthUrl=>{const connectWindow=window.open(oauthUrl);const interval=setInterval(()=>{this.checkAuth(application).then(connected=>{if(connected===true){connectWindow?.close();clearInterval(interval);resolve(true)}else{if(connectWindow?.closed){clearInterval(interval);resolve(false)}}}).catch(e=>{console.error(e);clearInterval(interval);reject(e)})},3e3)}).catch(reject)})}async auth(application,payload){const res=await fetch(`${this.baseUrl}/api/v1/${application}/save`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify({...payload})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data}async authCustom(applicationId,payload){const res=await fetch(`${this.baseUrl}/api/v1/custom/${applicationId}/save`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify({...payload})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data}async checkAuth(application){const res=await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/auth?integration_type=${application}`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return!!data?.status}async removeAuth(application,applicationId){const res=await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/${application}?app_id=${applicationId}`,{method:"DELETE",headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}}async getConfig(application){const res=await fetch(`${this.baseUrl}/api/v1/application/${application}/config`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async saveConfig(applicationId,payload={}){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/install`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify(payload)});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async getSavedConfig(applicationId,configId){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async updateSavedConfig(applicationId,configId,payload={}){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`,{method:"PUT",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify(payload)});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async deleteSavedConfig(applicationId,configId){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`,{method:"DELETE",headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}}module.exports=Cobalt;
package/docs.md CHANGED
@@ -9,11 +9,11 @@
9
9
  ## Typedefs
10
10
 
11
11
  <dl>
12
- <dt><a href="#AppConfig">AppConfig</a> : <code>object</code></dt>
12
+ <dt><a href="#Config">Config</a> : <code>object</code></dt>
13
13
  <dd><p>The configuration data for an application.</p>
14
14
  </dd>
15
- <dt><a href="#AppInstance">AppInstance</a> : <code>Object</code></dt>
16
- <dd><p>An installed application.</p>
15
+ <dt><a href="#SavedConfig">SavedConfig</a> : <code>Object</code></dt>
16
+ <dd><p>An saved config.</p>
17
17
  </dd>
18
18
  <dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
19
19
  <dd><p>The workflow.</p>
@@ -40,11 +40,11 @@ Cobalt Frontend SDK
40
40
  * [.authCustom(applicationId, payload)](#Cobalt+authCustom) ⇒ <code>Promise.&lt;unknown&gt;</code>
41
41
  * [.checkAuth(application)](#Cobalt+checkAuth) ⇒ <code>Promise.&lt;Boolean&gt;</code>
42
42
  * [.removeAuth(application, [applicationId])](#Cobalt+removeAuth) ⇒ <code>Promise.&lt;void&gt;</code>
43
- * [.getAppConfig(application)](#Cobalt+getAppConfig) ⇒ [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig)
44
- * [.install(applicationId, payload)](#Cobalt+install) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
45
- * [.getInstallation(applicationId, installationId)](#Cobalt+getInstallation) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
46
- * [.updateInstallation(applicationId, installationId, payload)](#Cobalt+updateInstallation) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
47
- * [.deleteInstallation(applicationId, installationId)](#Cobalt+deleteInstallation) ⇒ <code>Promise.&lt;unknown&gt;</code>
43
+ * [.getConfig(application)](#Cobalt+getConfig) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
44
+ * [.saveConfig(applicationId, payload)](#Cobalt+saveConfig) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
45
+ * [.getSavedConfig(applicationId, configId)](#Cobalt+getSavedConfig) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
46
+ * [.updateSavedConfig(applicationId, configId, payload)](#Cobalt+updateSavedConfig) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
47
+ * [.deleteSavedConfig(applicationId, configId)](#Cobalt+deleteSavedConfig) ⇒ <code>Promise.&lt;unknown&gt;</code>
48
48
 
49
49
  <a name="new_Cobalt_new"></a>
50
50
 
@@ -120,73 +120,73 @@ Unauthorize the specified application and remove any associated data from Cobalt
120
120
  | application | <code>String</code> | The application type. |
121
121
  | [applicationId] | <code>String</code> | The application ID in case of custom applications. |
122
122
 
123
- <a name="Cobalt+getAppConfig"></a>
123
+ <a name="Cobalt+getConfig"></a>
124
124
 
125
- ### cobalt.getAppConfig(application) ⇒ [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig)
125
+ ### cobalt.getConfig(application) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
126
126
  Returns the configuration data for the specified application.
127
127
 
128
128
  **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
129
- **Returns**: [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig) - The specified application's configuration data.
129
+ **Returns**: [<code>Promise.&lt;Config&gt;</code>](#Config) - The specified application's configuration data.
130
130
 
131
131
  | Param | Type | Description |
132
132
  | --- | --- | --- |
133
133
  | application | <code>String</code> | The application ID. |
134
134
 
135
- <a name="Cobalt+install"></a>
135
+ <a name="Cobalt+saveConfig"></a>
136
136
 
137
- ### cobalt.install(applicationId, payload) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
138
- Install the specified application.
137
+ ### cobalt.saveConfig(applicationId, payload) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
138
+ Save the specified config.
139
139
 
140
140
  **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
141
- **Returns**: [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance) - The specified application installation.
141
+ **Returns**: [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig) - The specified saved config.
142
142
 
143
143
  | Param | Type | Description |
144
144
  | --- | --- | --- |
145
145
  | applicationId | <code>String</code> | The application ID. |
146
- | payload | [<code>AppInstance</code>](#AppInstance) | The install payload. |
146
+ | payload | [<code>SavedConfig</code>](#SavedConfig) | The config payload. |
147
147
 
148
- <a name="Cobalt+getInstallation"></a>
148
+ <a name="Cobalt+getSavedConfig"></a>
149
149
 
150
- ### cobalt.getInstallation(applicationId, installationId) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
151
- Returns the specified application installation.
150
+ ### cobalt.getSavedConfig(applicationId, configId) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
151
+ Returns the specified saved config.
152
152
 
153
153
  **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
154
- **Returns**: [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance) - The specified application installation.
154
+ **Returns**: [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig) - The specified saved config.
155
155
 
156
156
  | Param | Type | Description |
157
157
  | --- | --- | --- |
158
158
  | applicationId | <code>String</code> | The application ID. |
159
- | installationId | <code>String</code> | The installation ID of the application instance. |
159
+ | configId | <code>String</code> | The config ID of the saved config. |
160
160
 
161
- <a name="Cobalt+updateInstallation"></a>
161
+ <a name="Cobalt+updateSavedConfig"></a>
162
162
 
163
- ### cobalt.updateInstallation(applicationId, installationId, payload) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
164
- Update the specified application installation.
163
+ ### cobalt.updateSavedConfig(applicationId, configId, payload) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
164
+ Update the specified saved config.
165
165
 
166
166
  **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
167
- **Returns**: [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance) - The specified application installation.
167
+ **Returns**: [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig) - The specified saved config.
168
168
 
169
169
  | Param | Type | Description |
170
170
  | --- | --- | --- |
171
171
  | applicationId | <code>String</code> | The application ID. |
172
- | installationId | <code>String</code> | The installation ID of the application instance. |
173
- | payload | [<code>AppInstance</code>](#AppInstance) | The update payload. |
172
+ | configId | <code>String</code> | The config ID of the saved config. |
173
+ | payload | [<code>SavedConfig</code>](#SavedConfig) | The update payload. |
174
174
 
175
- <a name="Cobalt+deleteInstallation"></a>
175
+ <a name="Cobalt+deleteSavedConfig"></a>
176
176
 
177
- ### cobalt.deleteInstallation(applicationId, installationId) ⇒ <code>Promise.&lt;unknown&gt;</code>
178
- Delete the specified installation.
177
+ ### cobalt.deleteSavedConfig(applicationId, configId) ⇒ <code>Promise.&lt;unknown&gt;</code>
178
+ Delete the specified saved config.
179
179
 
180
180
  **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
181
181
 
182
182
  | Param | Type | Description |
183
183
  | --- | --- | --- |
184
184
  | applicationId | <code>String</code> | The application ID. |
185
- | installationId | <code>String</code> | The installation ID of the application instance. |
185
+ | configId | <code>String</code> | The config ID of the saved config. |
186
186
 
187
- <a name="AppConfig"></a>
187
+ <a name="Config"></a>
188
188
 
189
- ## AppConfig : <code>object</code>
189
+ ## Config : <code>object</code>
190
190
  The configuration data for an application.
191
191
 
192
192
  **Kind**: global typedef
@@ -197,17 +197,17 @@ The configuration data for an application.
197
197
  | application_data_slots | <code>Array.&lt;DataSlot&gt;</code> | Array of application data slots. |
198
198
  | workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Array of workflows. |
199
199
 
200
- <a name="AppInstance"></a>
200
+ <a name="SavedConfig"></a>
201
201
 
202
- ## AppInstance : <code>Object</code>
203
- An installed application.
202
+ ## SavedConfig : <code>Object</code>
203
+ An saved config.
204
204
 
205
205
  **Kind**: global typedef
206
206
  **Properties**
207
207
 
208
208
  | Name | Type | Description |
209
209
  | --- | --- | --- |
210
- | [installation_id] | <code>String</code> | Unique ID for the installation. |
210
+ | [config_id] | <code>String</code> | Unique ID for the saved config. |
211
211
  | application_data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of application data slots and their values. |
212
212
  | workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Whether the workflow is enabled. |
213
213
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cobaltio/cobalt-js",
3
- "version": "1.0.1",
3
+ "version": "2.0.0",
4
4
  "description": "Cobalt frontend SDK",
5
5
  "main": "./cobalt.js",
6
6
  "scripts": {