@epilot/app-client 0.6.4 → 0.7.1
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/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +16 -2
- package/dist/openapi.d.ts +28 -25
- package/dist/openapi.json +45 -18
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/public
|
|
1
|
+
(()=>{"use strict";var e={466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/public/app/{appId}/components/{componentId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"},{"name":"componentId","in":"path","required":true,"description":"ID of the component to retrieve"}],"get":{"operationId":"getPublicFacingComponent","responses":{}}},"/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}/events":{"post":{"operationId":"queryEvents","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"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}/zip":{"post":{"operationId":"createZipUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"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":{}}},"/v1/app-events":{"post":{"operationId":"ingestEvent","requestBody":{"required":true,"content":{"application/json":{}}},"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":{}}}}}}')},757: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}},r={},t=function t(n){var o=r[n];if(void 0!==o)return o.exports;var p=r[n]={exports:{}};return e[n].call(p.exports,p,p.exports,t),p.exports}(757),n=exports;for(var o in t)n[o]=t[o];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
|
|
@@ -10,9 +10,23 @@
|
|
|
10
10
|
}
|
|
11
11
|
],
|
|
12
12
|
"paths": {
|
|
13
|
-
"/v1/public
|
|
13
|
+
"/v1/public/app/{appId}/components/{componentId}": {
|
|
14
|
+
"parameters": [
|
|
15
|
+
{
|
|
16
|
+
"name": "appId",
|
|
17
|
+
"in": "path",
|
|
18
|
+
"required": true,
|
|
19
|
+
"description": "ID of the app configuration to install"
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"name": "componentId",
|
|
23
|
+
"in": "path",
|
|
24
|
+
"required": true,
|
|
25
|
+
"description": "ID of the component to retrieve"
|
|
26
|
+
}
|
|
27
|
+
],
|
|
14
28
|
"get": {
|
|
15
|
-
"operationId": "
|
|
29
|
+
"operationId": "getPublicFacingComponent",
|
|
16
30
|
"responses": {}
|
|
17
31
|
}
|
|
18
32
|
},
|
package/dist/openapi.d.ts
CHANGED
|
@@ -55,6 +55,10 @@ declare namespace Components {
|
|
|
55
55
|
* Configuration values for the app components
|
|
56
56
|
*/
|
|
57
57
|
option_values?: Schemas.OptionsRef[];
|
|
58
|
+
/**
|
|
59
|
+
* Manifest ID used to create/update the entity
|
|
60
|
+
*/
|
|
61
|
+
_manifest?: string /* uuid */[];
|
|
58
62
|
}
|
|
59
63
|
export interface PatchConfigMetadataRequest {
|
|
60
64
|
/**
|
|
@@ -1536,23 +1540,12 @@ declare namespace Paths {
|
|
|
1536
1540
|
}
|
|
1537
1541
|
}
|
|
1538
1542
|
}
|
|
1539
|
-
namespace
|
|
1543
|
+
namespace GetPublicFacingComponent {
|
|
1540
1544
|
namespace Responses {
|
|
1541
1545
|
export interface $200 {
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
*/
|
|
1546
|
-
algorithm?: string;
|
|
1547
|
-
/**
|
|
1548
|
-
* PEM-formatted RSA public key
|
|
1549
|
-
*/
|
|
1550
|
-
public_key?: string;
|
|
1551
|
-
/**
|
|
1552
|
-
* example:
|
|
1553
|
-
* epilot
|
|
1554
|
-
*/
|
|
1555
|
-
issuer?: string;
|
|
1546
|
+
component?: Components.Schemas.BaseComponent;
|
|
1547
|
+
}
|
|
1548
|
+
export interface $404 {
|
|
1556
1549
|
}
|
|
1557
1550
|
}
|
|
1558
1551
|
}
|
|
@@ -1799,20 +1792,30 @@ declare namespace Paths {
|
|
|
1799
1792
|
appId: Parameters.AppId;
|
|
1800
1793
|
}
|
|
1801
1794
|
}
|
|
1795
|
+
namespace V1PublicApp$AppIdComponents$ComponentId {
|
|
1796
|
+
namespace Parameters {
|
|
1797
|
+
export type AppId = string;
|
|
1798
|
+
export type ComponentId = string;
|
|
1799
|
+
}
|
|
1800
|
+
export interface PathParameters {
|
|
1801
|
+
appId: Parameters.AppId;
|
|
1802
|
+
componentId: Parameters.ComponentId;
|
|
1803
|
+
}
|
|
1804
|
+
}
|
|
1802
1805
|
}
|
|
1803
1806
|
|
|
1804
1807
|
|
|
1805
1808
|
export interface OperationMethods {
|
|
1806
1809
|
/**
|
|
1807
|
-
*
|
|
1810
|
+
* getPublicFacingComponent - getPublicFacingComponent
|
|
1808
1811
|
*
|
|
1809
|
-
* Retrieve
|
|
1812
|
+
* Retrieve public facing components for an installed app
|
|
1810
1813
|
*/
|
|
1811
|
-
'
|
|
1812
|
-
parameters?: Parameters<
|
|
1814
|
+
'getPublicFacingComponent'(
|
|
1815
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdComponents$ComponentId.PathParameters> | null,
|
|
1813
1816
|
data?: any,
|
|
1814
1817
|
config?: AxiosRequestConfig
|
|
1815
|
-
): OperationResponse<Paths.
|
|
1818
|
+
): OperationResponse<Paths.GetPublicFacingComponent.Responses.$200>
|
|
1816
1819
|
/**
|
|
1817
1820
|
* listConfigurations - listConfigurations
|
|
1818
1821
|
*
|
|
@@ -2077,17 +2080,17 @@ export interface OperationMethods {
|
|
|
2077
2080
|
}
|
|
2078
2081
|
|
|
2079
2082
|
export interface PathsDictionary {
|
|
2080
|
-
['/v1/public
|
|
2083
|
+
['/v1/public/app/{appId}/components/{componentId}']: {
|
|
2081
2084
|
/**
|
|
2082
|
-
*
|
|
2085
|
+
* getPublicFacingComponent - getPublicFacingComponent
|
|
2083
2086
|
*
|
|
2084
|
-
* Retrieve
|
|
2087
|
+
* Retrieve public facing components for an installed app
|
|
2085
2088
|
*/
|
|
2086
2089
|
'get'(
|
|
2087
|
-
parameters?: Parameters<
|
|
2090
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdComponents$ComponentId.PathParameters> | null,
|
|
2088
2091
|
data?: any,
|
|
2089
2092
|
config?: AxiosRequestConfig
|
|
2090
|
-
): OperationResponse<Paths.
|
|
2093
|
+
): OperationResponse<Paths.GetPublicFacingComponent.Responses.$200>
|
|
2091
2094
|
}
|
|
2092
2095
|
['/v1/app-configurations']: {
|
|
2093
2096
|
/**
|
package/dist/openapi.json
CHANGED
|
@@ -36,39 +36,57 @@
|
|
|
36
36
|
}
|
|
37
37
|
],
|
|
38
38
|
"paths": {
|
|
39
|
-
"/v1/public
|
|
39
|
+
"/v1/public/app/{appId}/components/{componentId}": {
|
|
40
|
+
"parameters": [
|
|
41
|
+
{
|
|
42
|
+
"name": "appId",
|
|
43
|
+
"in": "path",
|
|
44
|
+
"required": true,
|
|
45
|
+
"schema": {
|
|
46
|
+
"type": "string"
|
|
47
|
+
},
|
|
48
|
+
"description": "ID of the app configuration to install"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "componentId",
|
|
52
|
+
"in": "path",
|
|
53
|
+
"required": true,
|
|
54
|
+
"schema": {
|
|
55
|
+
"type": "string"
|
|
56
|
+
},
|
|
57
|
+
"description": "ID of the component to retrieve"
|
|
58
|
+
}
|
|
59
|
+
],
|
|
40
60
|
"get": {
|
|
41
|
-
"security": [
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
61
|
+
"security": [
|
|
62
|
+
{
|
|
63
|
+
"EpilotAuth": []
|
|
64
|
+
}
|
|
65
|
+
],
|
|
66
|
+
"summary": "getPublicFacingComponent",
|
|
67
|
+
"description": "Retrieve public facing components for an installed app",
|
|
68
|
+
"operationId": "getPublicFacingComponent",
|
|
45
69
|
"tags": [
|
|
46
|
-
"App
|
|
70
|
+
"App Installation"
|
|
47
71
|
],
|
|
48
72
|
"responses": {
|
|
49
73
|
"200": {
|
|
50
|
-
"description": "
|
|
74
|
+
"description": "Successful response with public app component details",
|
|
51
75
|
"content": {
|
|
52
76
|
"application/json": {
|
|
53
77
|
"schema": {
|
|
54
78
|
"type": "object",
|
|
55
79
|
"properties": {
|
|
56
|
-
"
|
|
57
|
-
"
|
|
58
|
-
"example": "rsa-sha256"
|
|
59
|
-
},
|
|
60
|
-
"public_key": {
|
|
61
|
-
"type": "string",
|
|
62
|
-
"description": "PEM-formatted RSA public key"
|
|
63
|
-
},
|
|
64
|
-
"issuer": {
|
|
65
|
-
"type": "string",
|
|
66
|
-
"example": "epilot"
|
|
80
|
+
"component": {
|
|
81
|
+
"$ref": "#/components/schemas/BaseComponent"
|
|
67
82
|
}
|
|
68
83
|
}
|
|
69
84
|
}
|
|
70
85
|
}
|
|
71
86
|
}
|
|
87
|
+
},
|
|
88
|
+
"404": {
|
|
89
|
+
"description": "App Installation not found"
|
|
72
90
|
}
|
|
73
91
|
}
|
|
74
92
|
}
|
|
@@ -1453,6 +1471,15 @@
|
|
|
1453
1471
|
"$ref": "#/components/schemas/OptionsRef"
|
|
1454
1472
|
},
|
|
1455
1473
|
"description": "Configuration values for the app components"
|
|
1474
|
+
},
|
|
1475
|
+
"_manifest": {
|
|
1476
|
+
"type": "array",
|
|
1477
|
+
"description": "Manifest ID used to create/update the entity",
|
|
1478
|
+
"items": {
|
|
1479
|
+
"type": "string",
|
|
1480
|
+
"format": "uuid",
|
|
1481
|
+
"example": "123e4567-e89b-12d3-a456-426614174000"
|
|
1482
|
+
}
|
|
1456
1483
|
}
|
|
1457
1484
|
}
|
|
1458
1485
|
}
|