@epilot/app-client 0.5.3 → 0.5.5

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.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={187:function(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var o=n(t(466));r.default=o.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/public/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"}],"get":{"operationId":"getPublicConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"patch":{"operationId":"patchMetadata","requestBody":{"$ref":"#/components/requestBodies/PatchConfigMetadataRequest"},"responses":{}}},"/v1/app-configurations/{appId}/bundle":{"post":{"operationId":"createBundleUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/CreateBundlePresignedRequest"},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","requestBody":{"$ref":"#/components/requestBodies/CreateLogoPresignedRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/PatchVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components":{"post":{"operationId":"createComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components/{componentId}":{"patch":{"operationId":"patchComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}},"delete":{"operationId":"deleteComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstallations","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstallation","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"post":{"operationId":"install","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"patch":{"operationId":"patchInstallation","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"delete":{"operationId":"uninstall","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoPresignedRequest":{"required":true,"content":{"application/json":{}}},"CreateBundlePresignedRequest":{"required":true,"content":{"application/json":{}}},"PatchConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"PatchVersionRequest":{"required":true,"content":{"application/json":{}}},"UpsertComponentRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(n){var o=r[n];if(void 0!==o)return o.exports;var a=r[n]={exports:{}};return e[n].call(a.exports,a,a.exports,t),a.exports}(187),n=exports;for(var o in t)n[o]=t[o];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={187:function(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var o=n(t(466));r.default=o.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/public/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"}],"get":{"operationId":"getPublicConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"patch":{"operationId":"patchMetadata","requestBody":{"$ref":"#/components/requestBodies/PatchConfigMetadataRequest"},"responses":{}},"delete":{"operationId":"deleteConfiguration","responses":{}}},"/v1/app-configurations/{appId}/bundle":{"post":{"operationId":"createBundleUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/CreateBundlePresignedRequest"},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","requestBody":{"$ref":"#/components/requestBodies/CreateLogoPresignedRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/PatchVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components":{"post":{"operationId":"createComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components/{componentId}":{"patch":{"operationId":"patchComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}},"delete":{"operationId":"deleteComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstallations","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstallation","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"post":{"operationId":"install","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"patch":{"operationId":"patchInstallation","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"delete":{"operationId":"uninstall","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoPresignedRequest":{"required":true,"content":{"application/json":{}}},"CreateBundlePresignedRequest":{"required":true,"content":{"application/json":{}}},"PatchConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"PatchVersionRequest":{"required":true,"content":{"application/json":{}}},"UpsertComponentRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(n){var o=r[n];if(void 0!==o)return o.exports;var a=r[n]={exports:{}};return e[n].call(a.exports,a,a.exports,t),a.exports}(187),n=exports;for(var o in t)n[o]=t[o];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
@@ -78,6 +78,10 @@
78
78
  "$ref": "#/components/requestBodies/PatchConfigMetadataRequest"
79
79
  },
80
80
  "responses": {}
81
+ },
82
+ "delete": {
83
+ "operationId": "deleteConfiguration",
84
+ "responses": {}
81
85
  }
82
86
  },
83
87
  "/v1/app-configurations/{appId}/bundle": {
package/dist/openapi.d.ts CHANGED
@@ -47,6 +47,10 @@ declare namespace Components {
47
47
  mime_type: "image/png" | "image/jpeg" | "image/jpg";
48
48
  }
49
49
  export interface InstallRequest {
50
+ /**
51
+ * Version of the app to update to
52
+ */
53
+ version?: string;
50
54
  /**
51
55
  * Configuration values for the app components
52
56
  */
@@ -194,18 +198,6 @@ declare namespace Components {
194
198
  * Description of the custom action
195
199
  */
196
200
  description?: string;
197
- /**
198
- * The ID of the app to fetch configuration from the app API
199
- * example:
200
- * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
201
- */
202
- app_id: string;
203
- /**
204
- * The ID of the component to fetch configuration from the app API
205
- * example:
206
- * 12345678-1234-1234-1234-123456789012
207
- */
208
- component_id: string;
209
201
  }
210
202
  /**
211
203
  * How often the subscription is billed
@@ -636,18 +628,6 @@ declare namespace Components {
636
628
  * Description of the custom action
637
629
  */
638
630
  description?: string;
639
- /**
640
- * The ID of the app to fetch configuration from the app API
641
- * example:
642
- * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
643
- */
644
- app_id: string;
645
- /**
646
- * The ID of the component to fetch configuration from the app API
647
- * example:
648
- * 12345678-1234-1234-1234-123456789012
649
- */
650
- component_id: string;
651
631
  type: "external_integration";
652
632
  external_integration_settings?: {
653
633
  /**
@@ -974,6 +954,10 @@ declare namespace Components {
974
954
  */
975
955
  version: string;
976
956
  role?: Role;
957
+ /**
958
+ * Latest version of the app
959
+ */
960
+ latest_version?: string;
977
961
  /**
978
962
  * Flag to indicate if the app is public.
979
963
  */
@@ -1138,6 +1122,14 @@ declare namespace Paths {
1138
1122
  }
1139
1123
  }
1140
1124
  }
1125
+ namespace DeleteConfiguration {
1126
+ namespace Responses {
1127
+ export interface $204 {
1128
+ }
1129
+ export interface $404 {
1130
+ }
1131
+ }
1132
+ }
1141
1133
  namespace DeleteLogo {
1142
1134
  namespace Responses {
1143
1135
  export interface $204 {
@@ -1229,8 +1221,7 @@ declare namespace Paths {
1229
1221
  }
1230
1222
  export type RequestBody = Components.RequestBodies.InstallRequest;
1231
1223
  namespace Responses {
1232
- export interface $204 {
1233
- }
1224
+ export type $201 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
1234
1225
  export interface $404 {
1235
1226
  }
1236
1227
  }
@@ -1477,6 +1468,16 @@ export interface OperationMethods {
1477
1468
  data?: Paths.PatchMetadata.RequestBody,
1478
1469
  config?: AxiosRequestConfig
1479
1470
  ): OperationResponse<Paths.PatchMetadata.Responses.$204>
1471
+ /**
1472
+ * deleteConfiguration - Delete app configuration
1473
+ *
1474
+ * Delete an app configuration and all its versions and components.
1475
+ */
1476
+ 'deleteConfiguration'(
1477
+ parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
1478
+ data?: any,
1479
+ config?: AxiosRequestConfig
1480
+ ): OperationResponse<Paths.DeleteConfiguration.Responses.$204>
1480
1481
  /**
1481
1482
  * createBundleUploadUrl - createBundleUploadUrl
1482
1483
  *
@@ -1616,7 +1617,7 @@ export interface OperationMethods {
1616
1617
  parameters?: Parameters<Paths.Install.PathParameters> | null,
1617
1618
  data?: Paths.Install.RequestBody,
1618
1619
  config?: AxiosRequestConfig
1619
- ): OperationResponse<Paths.Install.Responses.$204>
1620
+ ): OperationResponse<Paths.Install.Responses.$201>
1620
1621
  /**
1621
1622
  * patchInstallation - patchInstallation
1622
1623
  *
@@ -1705,6 +1706,16 @@ export interface PathsDictionary {
1705
1706
  data?: Paths.PatchMetadata.RequestBody,
1706
1707
  config?: AxiosRequestConfig
1707
1708
  ): OperationResponse<Paths.PatchMetadata.Responses.$204>
1709
+ /**
1710
+ * deleteConfiguration - Delete app configuration
1711
+ *
1712
+ * Delete an app configuration and all its versions and components.
1713
+ */
1714
+ 'delete'(
1715
+ parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
1716
+ data?: any,
1717
+ config?: AxiosRequestConfig
1718
+ ): OperationResponse<Paths.DeleteConfiguration.Responses.$204>
1708
1719
  }
1709
1720
  ['/v1/app-configurations/{appId}/bundle']: {
1710
1721
  /**
@@ -1862,7 +1873,7 @@ export interface PathsDictionary {
1862
1873
  parameters?: Parameters<Paths.Install.PathParameters> | null,
1863
1874
  data?: Paths.Install.RequestBody,
1864
1875
  config?: AxiosRequestConfig
1865
- ): OperationResponse<Paths.Install.Responses.$204>
1876
+ ): OperationResponse<Paths.Install.Responses.$201>
1866
1877
  /**
1867
1878
  * patchInstallation - patchInstallation
1868
1879
  *
package/dist/openapi.json CHANGED
@@ -236,6 +236,22 @@
236
236
  "description": "App configuration not found"
237
237
  }
238
238
  }
239
+ },
240
+ "delete": {
241
+ "summary": "Delete app configuration",
242
+ "description": "Delete an app configuration and all its versions and components.",
243
+ "operationId": "deleteConfiguration",
244
+ "tags": [
245
+ "App Configuration"
246
+ ],
247
+ "responses": {
248
+ "204": {
249
+ "description": "App configuration deleted successfully"
250
+ },
251
+ "404": {
252
+ "description": "App configuration not found"
253
+ }
254
+ }
239
255
  }
240
256
  },
241
257
  "/v1/app-configurations/{appId}/bundle": {
@@ -929,8 +945,15 @@
929
945
  "$ref": "#/components/requestBodies/InstallRequest"
930
946
  },
931
947
  "responses": {
932
- "204": {
933
- "description": "App successfully installed."
948
+ "201": {
949
+ "description": "App successfully installed.",
950
+ "content": {
951
+ "application/json": {
952
+ "schema": {
953
+ "$ref": "#/components/schemas/Installation"
954
+ }
955
+ }
956
+ }
934
957
  },
935
958
  "404": {
936
959
  "description": "App not found."
@@ -1201,6 +1224,10 @@
1201
1224
  "schema": {
1202
1225
  "type": "object",
1203
1226
  "properties": {
1227
+ "version": {
1228
+ "type": "string",
1229
+ "description": "Version of the app to update to"
1230
+ },
1204
1231
  "option_values": {
1205
1232
  "type": "array",
1206
1233
  "items": {
@@ -1507,22 +1534,8 @@
1507
1534
  "description": {
1508
1535
  "type": "string",
1509
1536
  "description": "Description of the custom action"
1510
- },
1511
- "app_id": {
1512
- "type": "string",
1513
- "description": "The ID of the app to fetch configuration from the app API",
1514
- "example": "c451c26a-cc7a-4c1c-92bf-1c6246cbfe88"
1515
- },
1516
- "component_id": {
1517
- "type": "string",
1518
- "description": "The ID of the component to fetch configuration from the app API",
1519
- "example": "12345678-1234-1234-1234-123456789012"
1520
1537
  }
1521
- },
1522
- "required": [
1523
- "app_id",
1524
- "component_id"
1525
- ]
1538
+ }
1526
1539
  },
1527
1540
  "ExternalIntegrationCustomActionConfig": {
1528
1541
  "allOf": [
@@ -2344,6 +2357,11 @@
2344
2357
  "role": {
2345
2358
  "$ref": "#/components/schemas/Role"
2346
2359
  },
2360
+ "latest_version": {
2361
+ "type": "string",
2362
+ "description": "Latest version of the app",
2363
+ "readOnly": true
2364
+ },
2347
2365
  "public": {
2348
2366
  "type": "boolean",
2349
2367
  "default": true,
package/package.json CHANGED
@@ -1,11 +1,12 @@
1
1
  {
2
2
  "name": "@epilot/app-client",
3
- "version": "0.5.3",
3
+ "version": "0.5.5",
4
4
  "description": "JavaScript client library for the epilot App API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "author": "epilot GmbH",
8
8
  "license": "MIT",
9
+ "private": false,
9
10
  "repository": {
10
11
  "type": "git",
11
12
  "url": "git+https://github.com/epilot-dev/sdk-js.git",