@epilot/app-client 0.3.1 → 0.3.2

package/dist/definition.js

@@ -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 a=n(t(466));r.default=a.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":"listConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createConfiguration","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":"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/{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":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(n){var a=r[n];if(void 0!==a)return a.exports;var o=r[n]={exports:{}};return e[n].call(o.exports,o,o.exports,t),o.exports}(187),n=exports;for(var a in t)n[a]=t[a];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
+(()=>{"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.0.3","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/{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":{}}},"/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":{}}},"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})})();

package/dist/openapi-runtime.json

@@ -150,9 +150,32 @@
           }
         ],
         "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": "patchVersion",
+        "operationId": "patchComponent",
         "parameters": [
           {
             "name": "appId",
@@ -163,12 +186,38 @@
             "name": "version",
             "in": "path",
             "required": true
+          },
+          {
+            "name": "componentId",
+            "in": "path",
+            "required": true
           }
         ],
         "requestBody": {
-          "$ref": "#/components/requestBodies/PatchVersionRequest"
+          "$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}": {
@@ -309,7 +358,7 @@
           "application/json": {}
         }
       },
-      "PatchVersionRequest": {
+      "UpsertComponentRequest": {
         "required": true,
         "content": {
           "application/json": {}

package/dist/openapi.d.ts

@@ -71,12 +71,7 @@ declare namespace Components {
              */
             support_email?: string;
         }
-        export interface PatchVersionRequest {
-            /**
-             * Updated full list of app components
-             */
-            components: Schemas.BaseComponent[];
-        }
+        export type UpsertComponentRequest = Schemas.BaseComponent;
     }
     namespace Schemas {
         export interface Audit {
@@ -691,6 +686,14 @@ declare namespace Paths {
         export type RequestBody = Components.RequestBodies.CreateBundlePresignedRequest;
         namespace Responses {
             export interface $200 {
+                /**
+                 * ID of the journye block component
+                 */
+                component_id?: string;
+                /**
+                 * URL of the web component object
+                 */
+                component_url?: string;
                 /**
                  * Presigned S3 URL for uploading the bundle
                  */
@@ -705,6 +708,25 @@ declare namespace Paths {
             }
         }
     }
+    namespace CreateComponent {
+        namespace Parameters {
+            export type AppId = string;
+            export type Version = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+            version: Parameters.Version;
+        }
+        export type RequestBody = Components.RequestBodies.UpsertComponentRequest;
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $400 {
+            }
+            export interface $404 {
+            }
+        }
+    }
     namespace CreateConfiguration {
         export type RequestBody = Components.RequestBodies.CreateConfigRequest;
         namespace Responses {
@@ -731,6 +753,24 @@ declare namespace Paths {
             }
         }
     }
+    namespace DeleteComponent {
+        namespace Parameters {
+            export type AppId = string;
+            export type ComponentId = string;
+            export type Version = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+            version: Parameters.Version;
+            componentId: Parameters.ComponentId;
+        }
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $404 {
+            }
+        }
+    }
     namespace DeleteLogo {
         namespace Responses {
             export interface $204 {
@@ -883,44 +923,46 @@ declare namespace Paths {
             }
         }
     }
-    namespace PatchInstallation {
+    namespace PatchComponent {
         namespace Parameters {
             export type AppId = string;
+            export type ComponentId = string;
+            export type Version = string;
         }
         export interface PathParameters {
             appId: Parameters.AppId;
+            version: Parameters.Version;
+            componentId: Parameters.ComponentId;
         }
-        export type RequestBody = Components.RequestBodies.InstallRequest;
+        export type RequestBody = Components.RequestBodies.UpsertComponentRequest;
         namespace Responses {
             export interface $204 {
             }
-            export interface $404 {
-            }
-        }
-    }
-    namespace PatchMetadata {
-        export type RequestBody = Components.RequestBodies.PatchConfigMetadataRequest;
-        namespace Responses {
-            export interface $204 {
+            export interface $400 {
             }
             export interface $404 {
             }
         }
     }
-    namespace PatchVersion {
+    namespace PatchInstallation {
         namespace Parameters {
             export type AppId = string;
-            export type Version = string;
         }
         export interface PathParameters {
             appId: Parameters.AppId;
-            version: Parameters.Version;
         }
-        export type RequestBody = Components.RequestBodies.PatchVersionRequest;
+        export type RequestBody = Components.RequestBodies.InstallRequest;
         namespace Responses {
             export interface $204 {
             }
-            export interface $400 {
+            export interface $404 {
+            }
+        }
+    }
+    namespace PatchMetadata {
+        export type RequestBody = Components.RequestBodies.PatchConfigMetadataRequest;
+        namespace Responses {
+            export interface $204 {
             }
             export interface $404 {
             }
@@ -1066,16 +1108,6 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetVersion.Responses.$200>
-  /**
-   * patchVersion - patchVersion
-   * 
-   * Patch version specific data of a configuration
-   */
-  'patchVersion'(
-    parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
-    data?: Paths.PatchVersion.RequestBody,
-    config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.PatchVersion.Responses.$204>
   /**
    * deleteVersion - deleteVersion
    * 
@@ -1086,6 +1118,36 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteVersion.Responses.$204>
+  /**
+   * createComponent - createComponent
+   * 
+   * Patch an existing app version to create/add a component
+   */
+  'createComponent'(
+    parameters?: Parameters<Paths.CreateComponent.PathParameters> | null,
+    data?: Paths.CreateComponent.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateComponent.Responses.$204>
+  /**
+   * patchComponent - patchComponent
+   * 
+   * Patch an existing app version to update its components
+   */
+  'patchComponent'(
+    parameters?: Parameters<Paths.PatchComponent.PathParameters> | null,
+    data?: Paths.PatchComponent.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PatchComponent.Responses.$204>
+  /**
+   * deleteComponent - deleteComponent
+   * 
+   * Delete a specific component from an app version
+   */
+  'deleteComponent'(
+    parameters?: Parameters<Paths.DeleteComponent.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteComponent.Responses.$204>
   /**
    * cloneVersion - cloneVersion
    * 
@@ -1270,16 +1332,40 @@ export interface PathsDictionary {
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteVersion.Responses.$204>
+  }
+  ['/v1/app-configurations/{appId}/versions/{version}/components']: {
     /**
-     * patchVersion - patchVersion
+     * createComponent - createComponent
      * 
-     * Patch version specific data of a configuration
+     * Patch an existing app version to create/add a component
+     */
+    'post'(
+      parameters?: Parameters<Paths.CreateComponent.PathParameters> | null,
+      data?: Paths.CreateComponent.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateComponent.Responses.$204>
+  }
+  ['/v1/app-configurations/{appId}/versions/{version}/components/{componentId}']: {
+    /**
+     * patchComponent - patchComponent
+     * 
+     * Patch an existing app version to update its components
      */
     'patch'(
-      parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
-      data?: Paths.PatchVersion.RequestBody,
+      parameters?: Parameters<Paths.PatchComponent.PathParameters> | null,
+      data?: Paths.PatchComponent.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PatchComponent.Responses.$204>
+    /**
+     * deleteComponent - deleteComponent
+     * 
+     * Delete a specific component from an app version
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteComponent.PathParameters> | null,
+      data?: any,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.PatchVersion.Responses.$204>
+    ): OperationResponse<Paths.DeleteComponent.Responses.$204>
   }
   ['/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}']: {
     /**

package/dist/openapi.json

@@ -200,6 +200,14 @@
                     "upload_url"
                   ],
                   "properties": {
+                    "component_id": {
+                      "type": "string",
+                      "description": "ID of the journye block component"
+                    },
+                    "component_url": {
+                      "type": "string",
+                      "description": "URL of the web component object"
+                    },
                     "upload_url": {
                       "type": "string",
                       "description": "Presigned S3 URL for uploading the bundle"
@@ -438,11 +446,13 @@
             "description": "Version is in use by installations"
           }
         }
-      },
-      "patch": {
-        "summary": "patchVersion",
-        "description": "Patch version specific data of a configuration",
-        "operationId": "patchVersion",
+      }
+    },
+    "/v1/app-configurations/{appId}/versions/{version}/components": {
+      "post": {
+        "summary": "createComponent",
+        "description": "Patch an existing app version to create/add a component",
+        "operationId": "createComponent",
         "parameters": [
           {
             "name": "appId",
@@ -464,11 +474,11 @@
           }
         ],
         "requestBody": {
-          "$ref": "#/components/requestBodies/PatchVersionRequest"
+          "$ref": "#/components/requestBodies/UpsertComponentRequest"
         },
         "responses": {
           "204": {
-            "description": "Version updated successfully"
+            "description": "Component created successfully"
           },
           "400": {
             "description": "Invalid version format"
@@ -479,6 +489,98 @@
         }
       }
     },
+    "/v1/app-configurations/{appId}/versions/{version}/components/{componentId}": {
+      "patch": {
+        "summary": "patchComponent",
+        "description": "Patch an existing app version to update its components",
+        "operationId": "patchComponent",
+        "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"
+          },
+          {
+            "name": "componentId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID of the component to update"
+          }
+        ],
+        "requestBody": {
+          "$ref": "#/components/requestBodies/UpsertComponentRequest"
+        },
+        "responses": {
+          "204": {
+            "description": "Component patched successfully"
+          },
+          "400": {
+            "description": "Invalid version format"
+          },
+          "404": {
+            "description": "Version or component not found"
+          }
+        }
+      },
+      "delete": {
+        "summary": "deleteComponent",
+        "description": "Delete a specific component from an app version",
+        "operationId": "deleteComponent",
+        "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"
+          },
+          {
+            "name": "componentId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID of the component to delete"
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Component deleted successfully"
+          },
+          "404": {
+            "description": "Version or component not found"
+          }
+        }
+      }
+    },
     "/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}": {
       "post": {
         "summary": "cloneVersion",
@@ -872,24 +974,12 @@
           }
         }
       },
-      "PatchVersionRequest": {
+      "UpsertComponentRequest": {
         "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"
-                }
-              }
+              "$ref": "#/components/schemas/BaseComponent"
             }
           }
         }

package/package.json

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