@epilot/app-client 0.0.12 → 0.0.14

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={187:function(e,r,p){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=t(p(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/CreateAppRequest"},"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":{}}},"/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":{}}},"/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":{"CreateAppRequest":{"required":true,"content":{"application/json":{}}},"InstallAppRequest":{"content":{"application/json":{}}}}}}')}},r={},p=function p(t){var n=r[t];if(void 0!==n)return n.exports;var a=r[t]={exports:{}};return e[t].call(a.exports,a,a.exports,p),a.exports}(187),t=exports;for(var n in p)t[n]=p[n];p.__esModule&&Object.defineProperty(t,"__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"},{"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})})();

package/dist/openapi-runtime.json

@@ -28,7 +28,7 @@
       "post": {
         "operationId": "createAppConfiguration",
         "requestBody": {
-          "$ref": "#/components/requestBodies/CreateAppRequest"
+          "$ref": "#/components/requestBodies/CreateConfigRequest"
         },
         "responses": {}
       }
@@ -50,6 +50,13 @@
       "get": {
         "operationId": "getAppConfiguration",
         "responses": {}
+      },
+      "put": {
+        "operationId": "updateAppConfigurationMetadata",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/UpdateConfigMetadataRequest"
+        },
+        "responses": {}
       }
     },
     "/v1/app-configurations/{appId}/logo": {
@@ -123,6 +130,25 @@
           }
         ],
         "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}": {
@@ -231,7 +257,19 @@
   },
   "components": {
     "requestBodies": {
-      "CreateAppRequest": {
+      "UpdateConfigMetadataRequest": {
+        "required": true,
+        "content": {
+          "application/json": {}
+        }
+      },
+      "UpdateVersionRequest": {
+        "required": true,
+        "content": {
+          "application/json": {}
+        }
+      },
+      "CreateConfigRequest": {
         "required": true,
         "content": {
           "application/json": {}

package/dist/openapi.d.ts

@@ -10,7 +10,7 @@ import type {
 
 declare namespace Components {
     namespace RequestBodies {
-        export interface CreateAppRequest {
+        export interface CreateConfigRequest {
             name: Schemas.TranslatedString;
             description: Schemas.TranslatedString;
             category?: string;
@@ -21,6 +21,20 @@ declare namespace Components {
              */
             option_values?: Schemas.OptionsRef[];
         }
+        export interface UpdateConfigMetadataRequest {
+            name: Schemas.TranslatedString;
+            description: Schemas.TranslatedString;
+            category?: string;
+            documentation_url?: string;
+            homepage_url?: string;
+            notifications?: Schemas.NotificationConfig;
+        }
+        export interface UpdateVersionRequest {
+            /**
+             * Updated full list of app components
+             */
+            components: Schemas.BaseComponent[];
+        }
     }
     namespace Schemas {
         /**
@@ -28,7 +42,7 @@ declare namespace Components {
          */
         export interface App {
             app_id?: string;
-            name?: TranslatedString;
+            name: TranslatedString;
             author?: Author;
             /**
              * List of available versions of the app
@@ -54,7 +68,7 @@ declare namespace Components {
              * URL of the app homepage.
              */
             homepage_url?: string;
-            description?: TranslatedString;
+            description: TranslatedString;
             notifications?: NotificationConfig;
             /**
              * Organization ID of the app owner, required for private apps or sandbox accounts
@@ -135,7 +149,7 @@ declare namespace Components {
          */
         export interface AppConfiguration {
             app_id?: string;
-            name?: TranslatedString;
+            name: TranslatedString;
             author?: Author;
             /**
              * List of available versions of the app
@@ -161,7 +175,7 @@ declare namespace Components {
              * URL of the app homepage.
              */
             homepage_url?: string;
-            description?: TranslatedString;
+            description: TranslatedString;
             notifications?: NotificationConfig;
             /**
              * Organization ID of the app owner, required for private apps or sandbox accounts
@@ -212,7 +226,7 @@ declare namespace Components {
          */
         export interface AppMetadata {
             app_id?: string;
-            name?: TranslatedString;
+            name: TranslatedString;
             author?: Author;
             /**
              * List of available versions of the app
@@ -241,7 +255,7 @@ declare namespace Components {
             /**
              * Markdown description of the app.
              */
-            description?: TranslatedString;
+            description: TranslatedString;
             /**
              * Configuration for developer notifications
              */
@@ -446,10 +460,7 @@ declare namespace Components {
             /**
              * List of events to subscribe to
              */
-            events: [
-                NotificationEvent,
-                ...NotificationEvent[]
-            ];
+            events?: NotificationEvent[];
         }
         export type NotificationEvent = "app.installed" | "app.uninstalled";
         export interface Option {
@@ -562,7 +573,7 @@ declare namespace Components {
             /**
              * English translation
              */
-            en?: string;
+            en?: string | null;
             /**
              * German translation
              */
@@ -601,7 +612,7 @@ declare namespace Paths {
         }
     }
     namespace CreateAppConfiguration {
-        export type RequestBody = Components.RequestBodies.CreateAppRequest;
+        export type RequestBody = Components.RequestBodies.CreateConfigRequest;
         namespace Responses {
             export interface $202 {
                 app_id: string;
@@ -737,7 +748,7 @@ declare namespace Paths {
         }
         namespace Responses {
             export interface $200 {
-                versions?: string[];
+                versions?: /* Configuration data about your app which is versionable */ Components.Schemas.AppVersioned[];
                 pagination?: {
                     total?: number;
                     page?: number;
@@ -801,6 +812,34 @@ declare namespace Paths {
             }
         }
     }
+    namespace UpdateAppConfigurationMetadata {
+        export type RequestBody = Components.RequestBodies.UpdateConfigMetadataRequest;
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $404 {
+            }
+        }
+    }
+    namespace UpdateAppVersion {
+        namespace Parameters {
+            export type AppId = string;
+            export type Version = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+            version: Parameters.Version;
+        }
+        export type RequestBody = Components.RequestBodies.UpdateVersionRequest;
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $400 {
+            }
+            export interface $404 {
+            }
+        }
+    }
     namespace V1AppConfigurations$AppId {
         namespace Parameters {
             export type AppId = string;
@@ -854,6 +893,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
+  /**
+   * updateAppConfigurationMetadata - updateAppConfigurationMetadata
+   * 
+   * Update non-versioned configuration metadata of a given app configuration.
+   */
+  'updateAppConfigurationMetadata'(
+    parameters?: Parameters<Paths.V1AppConfigurations$AppId.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
+    data?: Paths.UpdateAppConfigurationMetadata.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpdateAppConfigurationMetadata.Responses.$204>
   /**
    * createLogoUploadUrl - createLogoUploadUrl
    * 
@@ -894,6 +943,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetAppConfigurationVersion.Responses.$200>
+  /**
+   * updateAppVersion - updateAppVersion
+   * 
+   * Update configuration data of a given app version
+   */
+  'updateAppVersion'(
+    parameters?: Parameters<Paths.UpdateAppVersion.PathParameters> | null,
+    data?: Paths.UpdateAppVersion.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpdateAppVersion.Responses.$204>
   /**
    * deleteAppVersion - deleteAppVersion
    * 
@@ -1000,6 +1059,16 @@ export interface PathsDictionary {
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
+    /**
+     * updateAppConfigurationMetadata - updateAppConfigurationMetadata
+     * 
+     * Update non-versioned configuration metadata of a given app configuration.
+     */
+    'put'(
+      parameters?: Parameters<Paths.V1AppConfigurations$AppId.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
+      data?: Paths.UpdateAppConfigurationMetadata.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpdateAppConfigurationMetadata.Responses.$204>
   }
   ['/v1/app-configurations/{appId}/logo']: {
     /**
@@ -1056,6 +1125,16 @@ export interface PathsDictionary {
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteAppVersion.Responses.$204>
+    /**
+     * updateAppVersion - updateAppVersion
+     * 
+     * Update configuration data of a given app version
+     */
+    'put'(
+      parameters?: Parameters<Paths.UpdateAppVersion.PathParameters> | null,
+      data?: Paths.UpdateAppVersion.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpdateAppVersion.Responses.$204>
   }
   ['/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}']: {
     /**

package/dist/openapi.json

@@ -87,7 +87,7 @@
         "description": "Create a new private app configuration. To make it public a verification process needs to be triggered",
         "operationId": "createAppConfiguration",
         "requestBody": {
-          "$ref": "#/components/requestBodies/CreateAppRequest"
+          "$ref": "#/components/requestBodies/CreateConfigRequest"
         },
         "responses": {
           "202": {
@@ -150,6 +150,22 @@
             "description": "App configuration not found"
           }
         }
+      },
+      "put": {
+        "summary": "updateAppConfigurationMetadata",
+        "description": "Update non-versioned configuration metadata of a given app configuration.",
+        "operationId": "updateAppConfigurationMetadata",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/UpdateConfigMetadataRequest"
+        },
+        "responses": {
+          "204": {
+            "description": "Configuration updated successfully"
+          },
+          "404": {
+            "description": "App configuration not found"
+          }
+        }
       }
     },
     "/v1/app-configurations/{appId}/logo": {
@@ -257,7 +273,7 @@
                     "versions": {
                       "type": "array",
                       "items": {
-                        "type": "string"
+                        "$ref": "#/components/schemas/AppVersioned"
                       }
                     },
                     "pagination": {
@@ -361,6 +377,45 @@
             "description": "Version is in use by installations"
           }
         }
+      },
+      "put": {
+        "summary": "updateAppVersion",
+        "description": "Update configuration data of a given app version",
+        "operationId": "updateAppVersion",
+        "parameters": [
+          {
+            "name": "appId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID of the app configuration"
+          },
+          {
+            "name": "version",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "Version to update"
+          }
+        ],
+        "requestBody": {
+          "$ref": "#/components/requestBodies/UpdateVersionRequest"
+        },
+        "responses": {
+          "204": {
+            "description": "Version updated successfully"
+          },
+          "400": {
+            "description": "Invalid version format"
+          },
+          "404": {
+            "description": "Version not found"
+          }
+        }
       }
     },
     "/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}": {
@@ -637,7 +692,63 @@
   },
   "components": {
     "requestBodies": {
-      "CreateAppRequest": {
+      "UpdateConfigMetadataRequest": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "required": [
+                "name",
+                "description"
+              ],
+              "properties": {
+                "name": {
+                  "$ref": "#/components/schemas/TranslatedString"
+                },
+                "description": {
+                  "$ref": "#/components/schemas/TranslatedString"
+                },
+                "category": {
+                  "type": "string"
+                },
+                "documentation_url": {
+                  "type": "string"
+                },
+                "homepage_url": {
+                  "type": "string"
+                },
+                "notifications": {
+                  "$ref": "#/components/schemas/NotificationConfig"
+                }
+              }
+            }
+          }
+        }
+      },
+      "UpdateVersionRequest": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "required": [
+                "components"
+              ],
+              "properties": {
+                "components": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/BaseComponent"
+                  },
+                  "description": "Updated full list of app components"
+                }
+              }
+            }
+          }
+        }
+      },
+      "CreateConfigRequest": {
         "required": true,
         "content": {
           "application/json": {
@@ -830,8 +941,7 @@
       "NotificationConfig": {
         "type": "object",
         "required": [
-          "email",
-          "events"
+          "email"
         ],
         "properties": {
           "email": {
@@ -846,7 +956,7 @@
             "items": {
               "$ref": "#/components/schemas/NotificationEvent"
             },
-            "minItems": 1
+            "minItems": 0
           }
         }
       },
@@ -1227,6 +1337,10 @@
       "AppMetadata": {
         "description": "Basic metadata about your app configuration which does not get versioned",
         "type": "object",
+        "required": [
+          "name",
+          "description"
+        ],
         "properties": {
           "app_id": {
             "type": "string",
@@ -1430,6 +1544,7 @@
         "properties": {
           "en": {
             "type": "string",
+            "nullable": true,
             "description": "English translation"
           },
           "de": {

package/package.json

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