@epilot/app-client 0.5.4 → 0.5.6-rc.1

package/dist/openapi.d.ts

@@ -47,6 +47,10 @@ declare namespace Components {
             mime_type: "image/png" | "image/jpeg" | "image/jpg";
         }
         export interface InstallRequest {
+            /**
+             * Version of the app to update to
+             */
+            version?: string;
             /**
              * Configuration values for the app components
              */
@@ -81,6 +85,12 @@ declare namespace Components {
         export type UpsertComponentRequest = Schemas.BaseComponent;
     }
     namespace Schemas {
+        export interface AppBridgeSurfaceConfig {
+            /**
+             * URL of the uploaded App Bridge App
+             */
+            app_url: string;
+        }
         export interface Audit {
             /**
              * Timestamp of the creation
@@ -194,18 +204,6 @@ declare namespace Components {
              * Description of the custom action
              */
             description?: string;
-            /**
-             * The ID of the app to fetch configuration from the app API
-             * example:
-             * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
-             */
-            app_id: string;
-            /**
-             * The ID of the component to fetch configuration from the app API
-             * example:
-             * 12345678-1234-1234-1234-123456789012
-             */
-            component_id: string;
         }
         /**
          * How often the subscription is billed
@@ -575,6 +573,9 @@ declare namespace Components {
         export interface CustomFlowActionComponent {
             component_type: "CUSTOM_FLOW_ACTION";
             configuration: CustomFlowConfig;
+            surfaces?: {
+                flow_action_config?: AppBridgeSurfaceConfig;
+            };
         }
         export type CustomFlowConfig = ExternalIntegrationCustomActionConfig;
         export interface EnumArg {
@@ -636,18 +637,6 @@ declare namespace Components {
              * Description of the custom action
              */
             description?: string;
-            /**
-             * The ID of the app to fetch configuration from the app API
-             * example:
-             * c451c26a-cc7a-4c1c-92bf-1c6246cbfe88
-             */
-            app_id: string;
-            /**
-             * The ID of the component to fetch configuration from the app API
-             * example:
-             * 12345678-1234-1234-1234-123456789012
-             */
-            component_id: string;
             type: "external_integration";
             external_integration_settings?: {
                 /**
@@ -733,6 +722,10 @@ declare namespace Components {
                  */
                 updated_by?: string;
             };
+            /**
+             * Manifest ID used to create/update the entity
+             */
+            _manifest?: string /* uuid */[];
         }
         export interface JourneyBlockComponent {
             component_type: "CUSTOM_JOURNEY_BLOCK";
@@ -974,6 +967,10 @@ declare namespace Components {
              */
             version: string;
             role?: Role;
+            /**
+             * Latest version of the app
+             */
+            latest_version?: string;
             /**
              * Flag to indicate if the app is public.
              */
@@ -1237,8 +1234,7 @@ declare namespace Paths {
         }
         export type RequestBody = Components.RequestBodies.InstallRequest;
         namespace Responses {
-            export interface $204 {
-            }
+            export type $201 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
             export interface $404 {
             }
         }
@@ -1634,7 +1630,7 @@ export interface OperationMethods {
     parameters?: Parameters<Paths.Install.PathParameters> | null,
     data?: Paths.Install.RequestBody,
     config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.Install.Responses.$204>
+  ): OperationResponse<Paths.Install.Responses.$201>
   /**
    * patchInstallation - patchInstallation
    * 
@@ -1890,7 +1886,7 @@ export interface PathsDictionary {
       parameters?: Parameters<Paths.Install.PathParameters> | null,
       data?: Paths.Install.RequestBody,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.Install.Responses.$204>
+    ): OperationResponse<Paths.Install.Responses.$201>
     /**
      * patchInstallation - patchInstallation
      * 
@@ -1928,6 +1924,7 @@ export interface PathsDictionary {
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
+export type AppBridgeSurfaceConfig = Components.Schemas.AppBridgeSurfaceConfig;
 export type Audit = Components.Schemas.Audit;
 export type Author = Components.Schemas.Author;
 export type BaseComponent = Components.Schemas.BaseComponent;

package/dist/openapi.json

@@ -19,6 +19,9 @@
     {
       "url": "https://app.sls.epilot.io"
     },
+    {
+      "url": "https://app.sls.epilot.io"
+    },
     {
       "url": "https://app.sls.epilot.io"
     }
@@ -945,8 +948,15 @@
           "$ref": "#/components/requestBodies/InstallRequest"
         },
         "responses": {
-          "204": {
-            "description": "App successfully installed."
+          "201": {
+            "description": "App successfully installed.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Installation"
+                }
+              }
+            }
           },
           "404": {
             "description": "App not found."
@@ -1217,6 +1227,10 @@
             "schema": {
               "type": "object",
               "properties": {
+                "version": {
+                  "type": "string",
+                  "description": "Version of the app to update to"
+                },
                 "option_values": {
                   "type": "array",
                   "items": {
@@ -1510,6 +1524,14 @@
           },
           "configuration": {
             "$ref": "#/components/schemas/CustomFlowConfig"
+          },
+          "surfaces": {
+            "type": "object",
+            "properties": {
+              "flow_action_config": {
+                "$ref": "#/components/schemas/AppBridgeSurfaceConfig"
+              }
+            }
           }
         }
       },
@@ -1523,22 +1545,8 @@
           "description": {
             "type": "string",
             "description": "Description of the custom action"
-          },
-          "app_id": {
-            "type": "string",
-            "description": "The ID of the app to fetch configuration from the app API",
-            "example": "c451c26a-cc7a-4c1c-92bf-1c6246cbfe88"
-          },
-          "component_id": {
-            "type": "string",
-            "description": "The ID of the component to fetch configuration from the app API",
-            "example": "12345678-1234-1234-1234-123456789012"
           }
-        },
-        "required": [
-          "app_id",
-          "component_id"
-        ]
+        }
       },
       "ExternalIntegrationCustomActionConfig": {
         "allOf": [
@@ -1777,6 +1785,18 @@
           }
         }
       },
+      "AppBridgeSurfaceConfig": {
+        "type": "object",
+        "properties": {
+          "app_url": {
+            "type": "string",
+            "description": "URL of the uploaded App Bridge App"
+          }
+        },
+        "required": [
+          "app_url"
+        ]
+      },
       "JourneyBlockComponentArgs": {
         "allOf": [
           {
@@ -2271,6 +2291,15 @@
                 "$ref": "#/components/schemas/Audit"
               }
             ]
+          },
+          "_manifest": {
+            "type": "array",
+            "description": "Manifest ID used to create/update the entity",
+            "items": {
+              "type": "string",
+              "format": "uuid",
+              "example": "123e4567-e89b-12d3-a456-426614174000"
+            }
           }
         }
       },
@@ -2360,6 +2389,11 @@
           "role": {
             "$ref": "#/components/schemas/Role"
           },
+          "latest_version": {
+            "type": "string",
+            "description": "Latest version of the app",
+            "readOnly": true
+          },
           "public": {
             "type": "boolean",
             "default": true,

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@epilot/app-client",
-  "version": "0.5.4",
+  "version": "0.5.6-rc.1",
   "description": "JavaScript client library for the epilot App API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "epilot GmbH",
   "license": "MIT",
+  "private": false,
   "repository": {
     "type": "git",
     "url": "git+https://github.com/epilot-dev/sdk-js.git",
@@ -24,7 +25,7 @@
     "test": "jest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js ../../../backend/app-api/packages/functions/src/api/openapi.yml",
+    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/app.yaml",
     "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
     "build": "tsc && npm run build:patch && npm run bundle-definition",
     "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",