@epilot/app-client 0.0.6 → 0.0.8

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={187:function(e,p,t){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(p,"__esModule",{value:!0});var a=r(t(466));p.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/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getAppConfiguration","responses":{}}},"/v1/app":{"get":{"operationId":"listInstalledApps","parameters":[{"name":"componentType","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":{}}}},"components":{"requestBodies":{"InstallAppRequest":{"content":{"application/json":{}}}}}}')}},p={},t=function t(r){var a=p[r];if(void 0!==a)return a.exports;var n=p[r]={exports:{}};return e[r].call(n.exports,n,n.exports,t),n.exports}(187),r=exports;for(var a in t)r[a]=t[a];t.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={187:function(e,p,t){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(p,"__esModule",{value:!0});var s=r(t(466));p.default=s.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/upload-url":{"post":{"operationId":"getUploadUrl","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/app-configurations":{"post":{"operationId":"publishApp","requestBody":{"$ref":"#/components/requestBodies/PublishAppRequest"},"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getAppConfiguration","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":{}}}},"components":{"requestBodies":{"PublishAppRequest":{"required":true,"content":{"application/json":{}}},"InstallAppRequest":{"content":{"application/json":{}}}}}}')}},p={},t=function t(r){var s=p[r];if(void 0!==s)return s.exports;var n=p[r]={exports:{}};return e[r].call(n.exports,n,n.exports,t),n.exports}(187),r=exports;for(var s in t)r[s]=t[s];t.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -10,6 +10,27 @@
     }
   ],
   "paths": {
+    "/v1/app-configurations/upload-url": {
+      "post": {
+        "operationId": "getUploadUrl",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
+    "/v1/app-configurations": {
+      "post": {
+        "operationId": "publishApp",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/PublishAppRequest"
+        },
+        "responses": {}
+      }
+    },
     "/v1/app-configurations/{appId}": {
       "parameters": [
         {
@@ -32,6 +53,10 @@
             "name": "componentType",
             "in": "query"
           },
+          {
+            "name": "enabled",
+            "in": "query"
+          },
           {
             "name": "page",
             "in": "query"
@@ -85,6 +110,12 @@
   },
   "components": {
     "requestBodies": {
+      "PublishAppRequest": {
+        "required": true,
+        "content": {
+          "application/json": {}
+        }
+      },
       "InstallAppRequest": {
         "content": {
           "application/json": {}

package/dist/openapi.d.ts

@@ -16,6 +16,12 @@ declare namespace Components {
              */
             option_values?: Schemas.OptionsRef[];
         }
+        export interface PublishAppRequest {
+            s3_reference: Schemas.S3Reference;
+            metadata?: {
+                access_level?: "public" | "private";
+            };
+        }
     }
     namespace Schemas {
         /**
@@ -124,55 +130,30 @@ declare namespace Components {
             access_level?: "public" | "private";
         }
         export interface Author {
-            /**
-             * Unique identifier for the author
-             */
-            id: string;
             /**
              * Name of the author
              */
-            name: string;
+            name?: string;
             /**
              * Company of the author
              */
-            company?: string;
+            company: string;
             /**
              * Email of the author
              */
             email?: string;
         }
         export type BaseComponent = {
-            component_type: "CUSTOM_JOURNEY_BLOCK";
-            configuration: JourneyBlockConfig;
             /**
              * Unique identifier for the component
              */
             id: string;
-            /**
-             * Name of the component
-             */
-            name?: string;
-            /**
-             * List of options for the app component
-             */
-            options?: /* Options for the component configuration */ Options[];
-        } | {
-            component_type: "PORTAL_EXTENSION";
-            origin?: "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL";
-            configuration: PortalExtensionConfig;
-            /**
-             * Unique identifier for the component
-             */
-            id: string;
-            /**
-             * Name of the component
-             */
-            name?: string;
+            name?: TranslatedString;
             /**
              * List of options for the app component
              */
             options?: /* Options for the component configuration */ Options[];
-        };
+        } & (JourneyBlockComponent | PortalExtensionComponent);
         export interface BaseComponentCommon {
             /**
              * Unique identifier for the component
@@ -181,7 +162,7 @@ declare namespace Components {
             /**
              * Name of the component
              */
-            name?: string;
+            name?: TranslatedString;
             /**
              * List of options for the app component
              */
@@ -217,15 +198,21 @@ declare namespace Components {
          * Type of app component
          */
         export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION";
+        export interface JourneyBlockComponent {
+            component_type: "CUSTOM_JOURNEY_BLOCK";
+            configuration: JourneyBlockConfig;
+        }
         export interface JourneyBlockConfig {
             /**
              * URL of the web component object
+             * example:
+             * https://cdn.apps.com/123/v1.0.0/bundle.js
              */
             component_url: string;
             /**
              * Custom element tag for the component
              */
-            component_tag?: string;
+            component_tag: string;
         }
         export interface Option {
             /**
@@ -257,7 +244,11 @@ declare namespace Components {
              * Detailed description of what this configuration option does
              */
             description?: string;
-            type: "string" | "number" | "boolean" | "secret";
+            /**
+             * The configured value for this option. Is only present when the component is installed.
+             */
+            value?: string;
+            type: "text" | "number" | "boolean" | "secret";
         }
         export interface OptionsRef {
             /**
@@ -274,12 +265,17 @@ declare namespace Components {
                 [name: string]: string;
             };
         }
+        export interface PortalExtensionComponent {
+            component_type: "PORTAL_EXTENSION";
+            origin?: "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL";
+            configuration: PortalExtensionConfig;
+        }
         export interface PortalExtensionConfig {
             id?: string;
             hooks?: {
                 id?: string;
                 type?: string;
-                name?: string;
+                name?: TranslatedString;
                 interval?: string[];
                 auth?: PortalAuth;
                 call?: {
@@ -295,8 +291,8 @@ declare namespace Components {
             links?: {
                 id?: string;
                 type?: string;
-                name?: string;
-                description?: string;
+                name?: TranslatedString;
+                description?: TranslatedString;
                 condition?: string;
                 auth?: PortalAuth;
                 redirect?: {
@@ -333,10 +329,9 @@ declare namespace Components {
         }
         export interface UploadFilePayload {
             /**
-             * example:
-             * example.manifest.zip
+             * ID of the app configuration. Required for app updates.
              */
-            filename: string;
+            app_id?: string;
         }
     }
 }
@@ -361,6 +356,26 @@ declare namespace Paths {
             }
         }
     }
+    namespace GetUploadUrl {
+        export type RequestBody = Components.Schemas.UploadFilePayload;
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * ID of the app configuration
+                 */
+                app_id?: string;
+                /**
+                 * Presigned S3 URL for uploading the file
+                 */
+                upload_url: string;
+                s3_reference: Components.Schemas.S3Reference;
+                /**
+                 * Timestamp when the upload URL expires
+                 */
+                expires_at?: string; // date-time
+            }
+        }
+    }
     namespace InstallApp {
         namespace Parameters {
             export type AppId = string;
@@ -379,11 +394,13 @@ declare namespace Paths {
     namespace ListInstalledApps {
         namespace Parameters {
             export type ComponentType = /* Type of app component */ Components.Schemas.ComponentType;
+            export type Enabled = boolean;
             export type Page = number;
             export type PageSize = number;
         }
         export interface QueryParameters {
             componentType?: Parameters.ComponentType;
+            enabled?: Parameters.Enabled;
             page?: Parameters.Page;
             pageSize?: Parameters.PageSize;
         }
@@ -398,6 +415,19 @@ declare namespace Paths {
             }
         }
     }
+    namespace PublishApp {
+        export type RequestBody = Components.RequestBodies.PublishAppRequest;
+        namespace Responses {
+            export interface $202 {
+                app_id: string;
+                status: "pending" | "published";
+                /**
+                 * Step Function execution ARN for status tracking
+                 */
+                execution_arn?: string;
+            }
+        }
+    }
     namespace UninstallApp {
         namespace Parameters {
             export type AppId = string;
@@ -423,6 +453,26 @@ declare namespace Paths {
 }
 
 export interface OperationMethods {
+  /**
+   * getUploadUrl - getUploadUrl
+   * 
+   * Generate a presigned URL for uploading app package zip file
+   */
+  'getUploadUrl'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.GetUploadUrl.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetUploadUrl.Responses.$200>
+  /**
+   * publishApp - publishApp
+   * 
+   * Publish a new app configuration from uploaded zip file
+   */
+  'publishApp'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.PublishApp.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PublishApp.Responses.$202>
   /**
    * getAppConfiguration - getAppConfiguration
    * 
@@ -476,6 +526,30 @@ export interface OperationMethods {
 }
 
 export interface PathsDictionary {
+  ['/v1/app-configurations/upload-url']: {
+    /**
+     * getUploadUrl - getUploadUrl
+     * 
+     * Generate a presigned URL for uploading app package zip file
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.GetUploadUrl.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetUploadUrl.Responses.$200>
+  }
+  ['/v1/app-configurations']: {
+    /**
+     * publishApp - publishApp
+     * 
+     * Publish a new app configuration from uploaded zip file
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.PublishApp.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PublishApp.Responses.$202>
+  }
   ['/v1/app-configurations/{appId}']: {
     /**
      * getAppConfiguration - getAppConfiguration
@@ -543,11 +617,13 @@ export type BaseComponent = Components.Schemas.BaseComponent;
 export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
 export type CallerIdentity = Components.Schemas.CallerIdentity;
 export type ComponentType = Components.Schemas.ComponentType;
+export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
 export type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;
 export type Option = Components.Schemas.Option;
 export type Options = Components.Schemas.Options;
 export type OptionsRef = Components.Schemas.OptionsRef;
 export type PortalAuth = Components.Schemas.PortalAuth;
+export type PortalExtensionComponent = Components.Schemas.PortalExtensionComponent;
 export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
 export type S3Reference = Components.Schemas.S3Reference;
 export type TranslatedString = Components.Schemas.TranslatedString;

package/dist/openapi.json

@@ -22,6 +22,99 @@
     }
   ],
   "paths": {
+    "/v1/app-configurations/upload-url": {
+      "post": {
+        "summary": "getUploadUrl",
+        "description": "Generate a presigned URL for uploading app package zip file",
+        "operationId": "getUploadUrl",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UploadFilePayload"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Upload URL generated successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "upload_url",
+                    "s3_reference"
+                  ],
+                  "properties": {
+                    "app_id": {
+                      "type": "string",
+                      "description": "ID of the app configuration"
+                    },
+                    "upload_url": {
+                      "type": "string",
+                      "description": "Presigned S3 URL for uploading the file"
+                    },
+                    "s3_reference": {
+                      "$ref": "#/components/schemas/S3Reference"
+                    },
+                    "expires_at": {
+                      "type": "string",
+                      "format": "date-time",
+                      "description": "Timestamp when the upload URL expires"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/app-configurations": {
+      "post": {
+        "summary": "publishApp",
+        "description": "Publish a new app configuration from uploaded zip file",
+        "operationId": "publishApp",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/PublishAppRequest"
+        },
+        "responses": {
+          "202": {
+            "description": "App publication process started",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "app_id",
+                    "status"
+                  ],
+                  "properties": {
+                    "app_id": {
+                      "type": "string"
+                    },
+                    "status": {
+                      "type": "string",
+                      "enum": [
+                        "pending",
+                        "published"
+                      ]
+                    },
+                    "execution_arn": {
+                      "type": "string",
+                      "description": "Step Function execution ARN for status tracking"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/app-configurations/{appId}": {
       "parameters": [
         {
@@ -70,6 +163,14 @@
             "description": "Filter apps by specific component type",
             "example": "CUSTOM_JOURNEY_BLOCK"
           },
+          {
+            "name": "enabled",
+            "in": "query",
+            "schema": {
+              "type": "boolean"
+            },
+            "description": "Filter apps by enabled status"
+          },
           {
             "name": "page",
             "in": "query",
@@ -209,6 +310,36 @@
   },
   "components": {
     "requestBodies": {
+      "PublishAppRequest": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "required": [
+                "s3_reference"
+              ],
+              "properties": {
+                "s3_reference": {
+                  "$ref": "#/components/schemas/S3Reference"
+                },
+                "metadata": {
+                  "type": "object",
+                  "properties": {
+                    "access_level": {
+                      "type": "string",
+                      "enum": [
+                        "public",
+                        "private"
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
       "InstallAppRequest": {
         "content": {
           "application/json": {
@@ -267,10 +398,14 @@
             "type": "string",
             "description": "Detailed description of what this configuration option does"
           },
+          "value": {
+            "type": "string",
+            "description": "The configured value for this option. Is only present when the component is installed."
+          },
           "type": {
             "type": "string",
             "enum": [
-              "string",
+              "text",
               "number",
               "boolean",
               "secret"
@@ -317,14 +452,11 @@
       "UploadFilePayload": {
         "type": "object",
         "properties": {
-          "filename": {
+          "app_id": {
             "type": "string",
-            "example": "example.manifest.zip"
+            "description": "ID of the app configuration. Required for app updates."
           }
-        },
-        "required": [
-          "filename"
-        ]
+        }
       },
       "S3Reference": {
         "type": "object",
@@ -356,14 +488,9 @@
       "Author": {
         "type": "object",
         "required": [
-          "id",
-          "name"
+          "company"
         ],
         "properties": {
-          "id": {
-            "type": "string",
-            "description": "Unique identifier for the author"
-          },
           "name": {
             "type": "string",
             "description": "Name of the author"
@@ -389,7 +516,7 @@
             "description": "Unique identifier for the component"
           },
           "name": {
-            "type": "string",
+            "$ref": "#/components/schemas/TranslatedString",
             "description": "Name of the component"
           },
           "options": {
@@ -407,58 +534,65 @@
             "$ref": "#/components/schemas/BaseComponentCommon"
           },
           {
+            "type": "object",
+            "discriminator": {
+              "propertyName": "component_type",
+              "mapping": {
+                "CUSTOM_JOURNEY_BLOCK": "#/components/schemas/JourneyBlockComponent",
+                "PORTAL_EXTENSION": "#/components/schemas/PortalExtensionComponent"
+              }
+            },
             "oneOf": [
               {
-                "type": "object",
-                "required": [
-                  "component_type",
-                  "configuration"
-                ],
-                "properties": {
-                  "component_type": {
-                    "type": "string",
-                    "enum": [
-                      "CUSTOM_JOURNEY_BLOCK"
-                    ]
-                  },
-                  "configuration": {
-                    "$ref": "#/components/schemas/JourneyBlockConfig"
-                  }
-                }
+                "$ref": "#/components/schemas/JourneyBlockComponent"
               },
               {
-                "type": "object",
-                "required": [
-                  "component_type",
-                  "configuration"
-                ],
-                "properties": {
-                  "component_type": {
-                    "type": "string",
-                    "enum": [
-                      "PORTAL_EXTENSION"
-                    ]
-                  },
-                  "origin": {
-                    "type": "string",
-                    "enum": [
-                      "END_CUSTOMER_PORTAL",
-                      "INSTALLER_PORTAL"
-                    ]
-                  },
-                  "configuration": {
-                    "$ref": "#/components/schemas/PortalExtensionConfig"
-                  }
-                }
+                "$ref": "#/components/schemas/PortalExtensionComponent"
               }
             ]
           }
+        ]
+      },
+      "JourneyBlockComponent": {
+        "type": "object",
+        "required": [
+          "component_type",
+          "configuration"
         ],
-        "discriminator": {
-          "propertyName": "componentType",
-          "mapping": {
-            "CUSTOM_JOURNEY_BLOCK": "#/components/schemas/JourneyBlockConfig",
-            "PORTAL_EXTENSION": "#/components/schemas/PortalExtensionConfig"
+        "properties": {
+          "component_type": {
+            "type": "string",
+            "enum": [
+              "CUSTOM_JOURNEY_BLOCK"
+            ]
+          },
+          "configuration": {
+            "$ref": "#/components/schemas/JourneyBlockConfig"
+          }
+        }
+      },
+      "PortalExtensionComponent": {
+        "type": "object",
+        "required": [
+          "component_type",
+          "configuration"
+        ],
+        "properties": {
+          "component_type": {
+            "type": "string",
+            "enum": [
+              "PORTAL_EXTENSION"
+            ]
+          },
+          "origin": {
+            "type": "string",
+            "enum": [
+              "END_CUSTOMER_PORTAL",
+              "INSTALLER_PORTAL"
+            ]
+          },
+          "configuration": {
+            "$ref": "#/components/schemas/PortalExtensionConfig"
           }
         }
       },
@@ -480,7 +614,7 @@
                   "type": "string"
                 },
                 "name": {
-                  "type": "string"
+                  "$ref": "#/components/schemas/TranslatedString"
                 },
                 "interval": {
                   "type": "array",
@@ -526,10 +660,10 @@
                   "type": "string"
                 },
                 "name": {
-                  "type": "string"
+                  "$ref": "#/components/schemas/TranslatedString"
                 },
                 "description": {
-                  "type": "string"
+                  "$ref": "#/components/schemas/TranslatedString"
                 },
                 "condition": {
                   "type": "string"
@@ -580,12 +714,13 @@
         "type": "object",
         "required": [
           "component_url",
-          "componentTag"
+          "component_tag"
         ],
         "properties": {
           "component_url": {
             "type": "string",
-            "description": "URL of the web component object"
+            "description": "URL of the web component object",
+            "example": "https://cdn.apps.com/123/v1.0.0/bundle.js"
           },
           "component_tag": {
             "type": "string",

package/package.json

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