@epilot/app-client 0.5.6 → 0.6.0-rc.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 o=n(t(466));r.default=o.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","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/public/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"}],"get":{"operationId":"getPublicConfiguration","parameters":[{"name":"version","in":"query"}],"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":{}},"delete":{"operationId":"deleteConfiguration","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/{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":{}}},"PatchVersionRequest":{"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})})();
+(()=>{"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.1.0","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/public/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"}],"get":{"operationId":"getPublicConfiguration","parameters":[{"name":"version","in":"query"}],"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":{}},"delete":{"operationId":"deleteConfiguration","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}/zip":{"post":{"operationId":"createZipUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"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/{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":{}}},"PatchVersionRequest":{"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

@@ -100,6 +100,24 @@
         "responses": {}
       }
     },
+    "/v1/app-configurations/{appId}/zip": {
+      "post": {
+        "operationId": "createZipUploadUrl",
+        "parameters": [
+          {
+            "name": "appId",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
     "/v1/app-configurations/{appId}/logo": {
       "parameters": [
         {

package/dist/openapi.d.ts

@@ -16,7 +16,7 @@ declare namespace Components {
              */
             version: string;
             /**
-             * ID of the journye block component
+             * ID of the journey block component
              */
             component_id?: string;
         }
@@ -89,6 +89,20 @@ declare namespace Components {
         export type UpsertComponentRequest = Schemas.BaseComponent;
     }
     namespace Schemas {
+        export interface AppBridgeSurfaceConfig {
+            /**
+             * URL of the uploaded App Bridge App. This is the entrypoint for the app
+             */
+            app_url: string;
+            /**
+             * URL of the uploaded zip file containing the app
+             */
+            zip_url?: string;
+            /**
+             * URL of the app in dev mode
+             */
+            override_url?: string;
+        }
         export interface Audit {
             /**
              * Timestamp of the creation
@@ -156,6 +170,9 @@ declare namespace Components {
              * List of options for the app component
              */
             options?: /* Options for the component configuration */ Options[];
+            surfaces?: {
+                [key: string]: any;
+            };
         } & (JourneyBlockComponent | PortalExtensionComponent | CustomFlowActionComponent);
         export interface BaseComponentCommon {
             /**
@@ -192,6 +209,9 @@ declare namespace Components {
              * List of options for the app component
              */
             options?: /* Options for the component configuration */ Options[];
+            surfaces?: {
+                [key: string]: any;
+            };
         }
         export interface BaseCustomActionConfig {
             /**
@@ -579,6 +599,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 {
@@ -865,7 +888,7 @@ declare namespace Components {
             /**
              * URL of the web component object in dev mode
              * example:
-             * http://localhost:3000/bundle.js
+             * http://localhost:3000
              */
             override_url?: string;
         }
@@ -1140,6 +1163,40 @@ declare namespace Paths {
             }
         }
     }
+    namespace CreateZipUploadUrl {
+        namespace Parameters {
+            export type AppId = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+        }
+        export interface RequestBody {
+            /**
+             * example:
+             * dist.zip
+             */
+            filename?: string;
+        }
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * Presigned S3 URL for uploading the bundle
+                 */
+                upload_url: string;
+                /**
+                 * Public CDN URL for the unpacked artifacts
+                 */
+                artifact_url: string;
+                s3ref?: Components.Schemas.S3Reference;
+                /**
+                 * Timestamp when the upload URL expires
+                 */
+                expires_at?: string; // date-time
+            }
+            export interface $404 {
+            }
+        }
+    }
     namespace DeleteComponent {
         namespace Parameters {
             export type AppId = string;
@@ -1517,13 +1574,24 @@ export interface OperationMethods {
   /**
    * createBundleUploadUrl - createBundleUploadUrl
    * 
-   * Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path
+   * Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path
    */
   'createBundleUploadUrl'(
     parameters?: Parameters<Paths.CreateBundleUploadUrl.PathParameters> | null,
     data?: Paths.CreateBundleUploadUrl.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CreateBundleUploadUrl.Responses.$200>
+  /**
+   * createZipUploadUrl - createZipUploadUrl
+   * 
+   * Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path
+   * 
+   */
+  'createZipUploadUrl'(
+    parameters?: Parameters<Paths.CreateZipUploadUrl.PathParameters> | null,
+    data?: Paths.CreateZipUploadUrl.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateZipUploadUrl.Responses.$200>
   /**
    * createLogoUploadUrl - createLogoUploadUrl
    * 
@@ -1757,7 +1825,7 @@ export interface PathsDictionary {
     /**
      * createBundleUploadUrl - createBundleUploadUrl
      * 
-     * Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path
+     * Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path
      */
     'post'(
       parameters?: Parameters<Paths.CreateBundleUploadUrl.PathParameters> | null,
@@ -1765,6 +1833,19 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.CreateBundleUploadUrl.Responses.$200>
   }
+  ['/v1/app-configurations/{appId}/zip']: {
+    /**
+     * createZipUploadUrl - createZipUploadUrl
+     * 
+     * Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path
+     * 
+     */
+    'post'(
+      parameters?: Parameters<Paths.CreateZipUploadUrl.PathParameters> | null,
+      data?: Paths.CreateZipUploadUrl.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateZipUploadUrl.Responses.$200>
+  }
   ['/v1/app-configurations/{appId}/logo']: {
     /**
      * createLogoUploadUrl - createLogoUploadUrl
@@ -1947,6 +2028,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

@@ -257,7 +257,7 @@
     "/v1/app-configurations/{appId}/bundle": {
       "post": {
         "summary": "createBundleUploadUrl",
-        "description": "Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path",
+        "description": "Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path",
         "operationId": "createBundleUploadUrl",
         "tags": [
           "App Configuration"
@@ -318,6 +318,80 @@
         }
       }
     },
+    "/v1/app-configurations/{appId}/zip": {
+      "post": {
+        "summary": "createZipUploadUrl",
+        "operationId": "createZipUploadUrl",
+        "description": "Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path\n",
+        "tags": [
+          "App Configuration"
+        ],
+        "parameters": [
+          {
+            "name": "appId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID of the app configuration"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "filename": {
+                    "type": "string",
+                    "example": "dist.zip"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Upload URL generated successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "upload_url",
+                    "artifact_url"
+                  ],
+                  "properties": {
+                    "upload_url": {
+                      "type": "string",
+                      "description": "Presigned S3 URL for uploading the bundle"
+                    },
+                    "artifact_url": {
+                      "type": "string",
+                      "description": "Public CDN URL for the unpacked artifacts"
+                    },
+                    "s3ref": {
+                      "$ref": "#/components/schemas/S3Reference"
+                    },
+                    "expires_at": {
+                      "type": "string",
+                      "format": "date-time",
+                      "description": "Timestamp when the upload URL expires"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "App configuration not found"
+          }
+        }
+      }
+    },
     "/v1/app-configurations/{appId}/logo": {
       "parameters": [
         {
@@ -1112,7 +1186,7 @@
                 },
                 "component_id": {
                   "type": "string",
-                  "description": "ID of the journye block component"
+                  "description": "ID of the journey block component"
                 }
               }
             }
@@ -1460,6 +1534,9 @@
               "$ref": "#/components/schemas/Options"
             },
             "description": "List of options for the app component"
+          },
+          "surfaces": {
+            "type": "object"
           }
         }
       },
@@ -1525,6 +1602,14 @@
           },
           "configuration": {
             "$ref": "#/components/schemas/CustomFlowConfig"
+          },
+          "surfaces": {
+            "type": "object",
+            "properties": {
+              "flow_action_config": {
+                "$ref": "#/components/schemas/AppBridgeSurfaceConfig"
+              }
+            }
           }
         }
       },
@@ -1739,7 +1824,7 @@
           "override_url": {
             "type": "string",
             "description": "URL of the web component object in dev mode",
-            "example": "http://localhost:3000/bundle.js"
+            "example": "http://localhost:3000"
           }
         }
       },
@@ -1792,6 +1877,26 @@
           }
         }
       },
+      "AppBridgeSurfaceConfig": {
+        "type": "object",
+        "properties": {
+          "app_url": {
+            "type": "string",
+            "description": "URL of the uploaded App Bridge App. This is the entrypoint for the app"
+          },
+          "zip_url": {
+            "type": "string",
+            "description": "URL of the uploaded zip file containing the app"
+          },
+          "override_url": {
+            "type": "string",
+            "description": "URL of the app in dev mode"
+          }
+        },
+        "required": [
+          "app_url"
+        ]
+      },
       "JourneyBlockComponentArgs": {
         "allOf": [
           {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/app-client",
-  "version": "0.5.6",
+  "version": "0.6.0-rc.2",
   "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 ../../../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",