@epilot/app-client 0.0.15 → 0.0.17

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={187:function(e,r,t){var p=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=p(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listAppConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createAppConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"},{"name":"version","in":"query","description":"Version of the app configuration to retrieve. Defaults to latest"}],"get":{"operationId":"getAppConfiguration","responses":{}},"put":{"operationId":"updateAppConfigurationMetadata","requestBody":{"$ref":"#/components/requestBodies/UpdateConfigMetadataRequest"},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listAppVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getAppConfigurationVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpdateVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstalledApps","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstalledApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"put":{"operationId":"installApp","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallAppRequest"},"responses":{}},"delete":{"operationId":"uninstallApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"UpdateConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"UpdateVersionRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallAppRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(p){var n=r[p];if(void 0!==n)return n.exports;var a=r[p]={exports:{}};return e[p].call(a.exports,a,a.exports,t),a.exports}(187),p=exports;for(var n in t)p[n]=t[n];t.__esModule&&Object.defineProperty(p,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={187:function(e,r,t){var p=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=p(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listAppConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createAppConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getAppConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"put":{"operationId":"updateAppConfigurationMetadata","requestBody":{"$ref":"#/components/requestBodies/UpdateConfigMetadataRequest"},"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/CreateLogoRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listAppVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getAppConfigurationVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpdateVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstalledApps","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstalledApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"put":{"operationId":"installApp","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallAppRequest"},"responses":{}},"delete":{"operationId":"uninstallApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoRequest":{"required":true,"content":{"application/json":{}}},"UpdateConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"UpdateVersionRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallAppRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(p){var n=r[p];if(void 0!==n)return n.exports;var a=r[p]={exports:{}};return e[p].call(a.exports,a,a.exports,t),a.exports}(187),p=exports;for(var n in t)p[n]=t[n];t.__esModule&&Object.defineProperty(p,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -40,15 +40,16 @@
           "in": "path",
           "required": true,
           "description": "ID of the app configuration"
-        },
-        {
-          "name": "version",
-          "in": "query",
-          "description": "Version of the app configuration to retrieve. Defaults to latest"
         }
       ],
       "get": {
         "operationId": "getAppConfiguration",
+        "parameters": [
+          {
+            "name": "version",
+            "in": "query"
+          }
+        ],
         "responses": {}
       },
       "put": {
@@ -70,6 +71,9 @@
       ],
       "post": {
         "operationId": "createLogoUploadUrl",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/CreateLogoRequest"
+        },
         "responses": {}
       },
       "delete": {
@@ -257,6 +261,12 @@
   },
   "components": {
     "requestBodies": {
+      "CreateLogoRequest": {
+        "required": true,
+        "content": {
+          "application/json": {}
+        }
+      },
       "UpdateConfigMetadataRequest": {
         "required": true,
         "content": {

package/dist/openapi.d.ts

@@ -14,6 +14,24 @@ declare namespace Components {
             name: Schemas.TranslatedString;
             description: Schemas.TranslatedString;
             category?: string;
+            /**
+             * S3 key of the logo file
+             */
+            logo_url_key?: string;
+        }
+        export interface CreateLogoRequest {
+            /**
+             * Original filename of the logo
+             * example:
+             * company-logo.png
+             */
+            filename: string;
+            /**
+             * MIME type of the logo file
+             * example:
+             * image/png
+             */
+            mime_type: "image/png" | "image/jpeg" | "image/jpg";
         }
         export interface InstallAppRequest {
             /**
@@ -28,6 +46,10 @@ declare namespace Components {
             documentation_url?: string;
             homepage_url?: string;
             notifications?: Schemas.NotificationConfig;
+            /**
+             * S3 key of the logo file
+             */
+            logo_url_key?: string;
         }
         export interface UpdateVersionRequest {
             /**
@@ -620,12 +642,14 @@ declare namespace Paths {
         }
     }
     namespace CreateLogoUploadUrl {
+        export type RequestBody = Components.RequestBodies.CreateLogoRequest;
         namespace Responses {
             export interface $200 {
                 /**
                  * Presigned S3 URL for uploading the logo
                  */
                 upload_url: string;
+                s3ref?: Components.Schemas.S3Reference;
                 /**
                  * Timestamp when the upload URL expires
                  */
@@ -664,6 +688,12 @@ declare namespace Paths {
         }
     }
     namespace GetAppConfiguration {
+        namespace Parameters {
+            export type Version = string;
+        }
+        export interface QueryParameters {
+            version?: Parameters.Version;
+        }
         namespace Responses {
             export type $200 = /* Configuration of the published app */ Components.Schemas.AppConfiguration;
             export interface $404 {
@@ -843,14 +873,10 @@ declare namespace Paths {
     namespace V1AppConfigurations$AppId {
         namespace Parameters {
             export type AppId = string;
-            export type Version = string;
         }
         export interface PathParameters {
             appId: Parameters.AppId;
         }
-        export interface QueryParameters {
-            version?: Parameters.Version;
-        }
     }
     namespace V1AppConfigurations$AppIdLogo {
         namespace Parameters {
@@ -889,7 +915,7 @@ export interface OperationMethods {
    * Retrieve a specific app configuration
    */
   'getAppConfiguration'(
-    parameters?: Parameters<Paths.V1AppConfigurations$AppId.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
+    parameters?: Parameters<Paths.GetAppConfiguration.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
@@ -899,7 +925,7 @@ export interface OperationMethods {
    * Update non-versioned configuration metadata of a given app configuration.
    */
   'updateAppConfigurationMetadata'(
-    parameters?: Parameters<Paths.V1AppConfigurations$AppId.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
+    parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
     data?: Paths.UpdateAppConfigurationMetadata.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UpdateAppConfigurationMetadata.Responses.$204>
@@ -910,7 +936,7 @@ export interface OperationMethods {
    */
   'createLogoUploadUrl'(
     parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
-    data?: any,
+    data?: Paths.CreateLogoUploadUrl.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CreateLogoUploadUrl.Responses.$200>
   /**
@@ -1055,7 +1081,7 @@ export interface PathsDictionary {
      * Retrieve a specific app configuration
      */
     'get'(
-      parameters?: Parameters<Paths.V1AppConfigurations$AppId.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
+      parameters?: Parameters<Paths.GetAppConfiguration.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
@@ -1065,7 +1091,7 @@ export interface PathsDictionary {
      * Update non-versioned configuration metadata of a given app configuration.
      */
     'put'(
-      parameters?: Parameters<Paths.V1AppConfigurations$AppId.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
+      parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
       data?: Paths.UpdateAppConfigurationMetadata.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.UpdateAppConfigurationMetadata.Responses.$204>
@@ -1078,7 +1104,7 @@ export interface PathsDictionary {
      */
     'post'(
       parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
-      data?: any,
+      data?: Paths.CreateLogoUploadUrl.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.CreateLogoUploadUrl.Responses.$200>
     /**

package/dist/openapi.json

@@ -121,20 +121,22 @@
             "type": "string"
           },
           "description": "ID of the app configuration"
-        },
-        {
-          "name": "version",
-          "in": "query",
-          "schema": {
-            "type": "string"
-          },
-          "description": "Version of the app configuration to retrieve. Defaults to latest"
         }
       ],
       "get": {
         "summary": "getAppConfiguration",
         "description": "Retrieve a specific app configuration",
         "operationId": "getAppConfiguration",
+        "parameters": [
+          {
+            "name": "version",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Version of the app configuration to retrieve"
+          }
+        ],
         "responses": {
           "200": {
             "description": "Successful response",
@@ -184,6 +186,9 @@
         "summary": "createLogoUploadUrl",
         "description": "Generate a presigned URL for uploading app logo to /<app-id>/logo.png path",
         "operationId": "createLogoUploadUrl",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/CreateLogoRequest"
+        },
         "responses": {
           "200": {
             "description": "Upload URL generated successfully",
@@ -199,6 +204,9 @@
                       "type": "string",
                       "description": "Presigned S3 URL for uploading the logo"
                     },
+                    "s3ref": {
+                      "$ref": "#/components/schemas/S3Reference"
+                    },
                     "expires_at": {
                       "type": "string",
                       "format": "date-time",
@@ -692,6 +700,37 @@
   },
   "components": {
     "requestBodies": {
+      "CreateLogoRequest": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "required": [
+                "filename",
+                "mime_type"
+              ],
+              "properties": {
+                "filename": {
+                  "type": "string",
+                  "description": "Original filename of the logo",
+                  "example": "company-logo.png"
+                },
+                "mime_type": {
+                  "type": "string",
+                  "description": "MIME type of the logo file",
+                  "enum": [
+                    "image/png",
+                    "image/jpeg",
+                    "image/jpg"
+                  ],
+                  "example": "image/png"
+                }
+              }
+            }
+          }
+        }
+      },
       "UpdateConfigMetadataRequest": {
         "required": true,
         "content": {
@@ -720,6 +759,10 @@
                 },
                 "notifications": {
                   "$ref": "#/components/schemas/NotificationConfig"
+                },
+                "logo_url_key": {
+                  "type": "string",
+                  "description": "S3 key of the logo file"
                 }
               }
             }
@@ -767,6 +810,10 @@
                 },
                 "category": {
                   "type": "string"
+                },
+                "logo_url_key": {
+                  "type": "string",
+                  "description": "S3 key of the logo file"
                 }
               }
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/app-client",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "JavaScript client library for the epilot App API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",