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

package/dist/openapi.d.ts

@@ -74,6 +74,10 @@ declare namespace Components {
              * Email address for support requests
              */
             support_email?: string;
+            /**
+             * Flag to indicate if the app is in dev mode. If true, the app takes the override properties of components into account.
+             */
+            dev_mode?: boolean;
         }
         export interface PatchVersionRequest {
             /**
@@ -85,12 +89,6 @@ 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
@@ -252,6 +250,10 @@ declare namespace Components {
              */
             name: string;
             author?: Author;
+            /**
+             * Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account.
+             */
+            dev_mode?: boolean;
             /**
              * List of available versions of the app
              */
@@ -411,6 +413,10 @@ declare namespace Components {
              */
             name: string;
             author?: Author;
+            /**
+             * Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account.
+             */
+            dev_mode?: boolean;
             /**
              * List of available versions of the app
              */
@@ -573,9 +579,6 @@ 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 {
@@ -677,6 +680,10 @@ declare namespace Components {
              * Unique identifier for the organization the app is installed in
              */
             installer_org_id: string;
+            /**
+             * Organization ID of the app creator
+             */
+            owner_org_id?: string;
             /**
              * Flag to indicate if the app is enabled. Enabled is set to true when required option values are set.
              */
@@ -769,6 +776,7 @@ declare namespace Components {
             };
         } & (TextArg | BooleanArg | EnumArg);
         export interface JourneyBlockConfig {
+            override_dev_mode?: /* Override URL when app is in dev mode */ OverrideDevMode;
             /**
              * URL of the web component object
              * example:
@@ -850,6 +858,17 @@ declare namespace Components {
             component_id: string;
             options: Option[];
         }
+        /**
+         * Override URL when app is in dev mode
+         */
+        export interface OverrideDevMode {
+            /**
+             * URL of the web component object in dev mode
+             * example:
+             * http://localhost:3000/bundle.js
+             */
+            override_url?: string;
+        }
         export interface PortalAuth {
             type?: string;
             url?: string;
@@ -921,6 +940,10 @@ declare namespace Components {
              */
             name: string;
             author?: Author;
+            /**
+             * Flag to indicate if the app is in dev mode.
+             */
+            dev_mode?: boolean;
             /**
              * Category of the app.
              */
@@ -1924,7 +1947,6 @@ 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;
@@ -1951,6 +1973,7 @@ export type NotificationEvent = Components.Schemas.NotificationEvent;
 export type Option = Components.Schemas.Option;
 export type Options = Components.Schemas.Options;
 export type OptionsRef = Components.Schemas.OptionsRef;
+export type OverrideDevMode = Components.Schemas.OverrideDevMode;
 export type PortalAuth = Components.Schemas.PortalAuth;
 export type PortalExtensionComponent = Components.Schemas.PortalExtensionComponent;
 export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;

package/dist/openapi.json

@@ -19,9 +19,6 @@
     {
       "url": "https://app.sls.epilot.io"
     },
-    {
-      "url": "https://app.sls.epilot.io"
-    },
     {
       "url": "https://app.sls.epilot.io"
     }
@@ -1155,6 +1152,10 @@
                 "support_email": {
                   "type": "string",
                   "description": "Email address for support requests"
+                },
+                "dev_mode": {
+                  "type": "boolean",
+                  "description": "Flag to indicate if the app is in dev mode. If true, the app takes the override properties of components into account."
                 }
               }
             }
@@ -1524,14 +1525,6 @@
           },
           "configuration": {
             "$ref": "#/components/schemas/CustomFlowConfig"
-          },
-          "surfaces": {
-            "type": "object",
-            "properties": {
-              "flow_action_config": {
-                "$ref": "#/components/schemas/AppBridgeSurfaceConfig"
-              }
-            }
           }
         }
       },
@@ -1739,6 +1732,17 @@
           }
         }
       },
+      "OverrideDevMode": {
+        "type": "object",
+        "description": "Override URL when app is in dev mode",
+        "properties": {
+          "override_url": {
+            "type": "string",
+            "description": "URL of the web component object in dev mode",
+            "example": "http://localhost:3000/bundle.js"
+          }
+        }
+      },
       "JourneyBlockConfig": {
         "type": "object",
         "required": [
@@ -1746,6 +1750,9 @@
           "component_tag"
         ],
         "properties": {
+          "override_dev_mode": {
+            "$ref": "#/components/schemas/OverrideDevMode"
+          },
           "component_url": {
             "type": "string",
             "description": "URL of the web component object",
@@ -1785,18 +1792,6 @@
           }
         }
       },
-      "AppBridgeSurfaceConfig": {
-        "type": "object",
-        "properties": {
-          "app_url": {
-            "type": "string",
-            "description": "URL of the uploaded App Bridge App"
-          }
-        },
-        "required": [
-          "app_url"
-        ]
-      },
       "JourneyBlockComponentArgs": {
         "allOf": [
           {
@@ -2016,6 +2011,10 @@
           "author": {
             "$ref": "#/components/schemas/Author"
           },
+          "dev_mode": {
+            "type": "boolean",
+            "description": "Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account."
+          },
           "versions": {
             "type": "array",
             "items": {
@@ -2245,6 +2244,11 @@
             "description": "Unique identifier for the organization the app is installed in",
             "readOnly": true
           },
+          "owner_org_id": {
+            "type": "string",
+            "description": "Organization ID of the app creator",
+            "readOnly": true
+          },
           "enabled": {
             "readOnly": true,
             "type": "boolean",
@@ -2333,6 +2337,10 @@
           "author": {
             "$ref": "#/components/schemas/Author"
           },
+          "dev_mode": {
+            "type": "boolean",
+            "description": "Flag to indicate if the app is in dev mode."
+          },
           "category": {
             "type": "string",
             "description": "Category of the app."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/app-client",
-  "version": "0.5.6-rc.1",
+  "version": "0.5.6",
   "description": "JavaScript client library for the epilot App API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
     "test": "jest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/app.yaml",
+    "openapi": "node ../../scripts/update-openapi.js ../../../backend/app-api/packages/functions/src/api/openapi.yml",
     "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",