@epilot/app-client 0.0.1 → 0.0.2

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={187:function(e,t,p){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=r(p(466));t.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:uploadManifest":{"post":{"operationId":"uploadManifest","requestBody":{"content":{"application/json":{}}},"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":{}}}}}}')}},t={},p=function p(r){var s=t[r];if(void 0!==s)return s.exports;var a=t[r]={exports:{}};return e[r].call(a.exports,a,a.exports,p),a.exports}(187),r=exports;for(var s in p)r[s]=p[s];p.__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 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})})();

package/dist/openapi-runtime.json

@@ -10,14 +10,17 @@
     }
   ],
   "paths": {
-    "/v1/app:uploadManifest": {
-      "post": {
-        "operationId": "uploadManifest",
-        "requestBody": {
-          "content": {
-            "application/json": {}
-          }
-        },
+    "/v1/app-configurations/{appId}": {
+      "parameters": [
+        {
+          "name": "appId",
+          "in": "path",
+          "required": true,
+          "description": "ID of the app configuration"
+        }
+      ],
+      "get": {
+        "operationId": "getAppConfiguration",
         "responses": {}
       }
     },

package/dist/openapi.d.ts

@@ -10,7 +10,12 @@ import type {
 
 declare namespace Components {
     namespace RequestBodies {
-        export type InstallAppRequest = /* Information about the installed app */ Schemas.App;
+        export interface InstallAppRequest {
+            /**
+             * Configuration values for the app components
+             */
+            config_values?: Schemas.ComponentConfigValues[];
+        }
     }
     namespace Schemas {
         /**
@@ -27,8 +32,10 @@ declare namespace Components {
              * URL of the app documentation.
              */
             documentation_url?: string;
+            /**
+             * Markdown description of the app.
+             */
             description?: string;
-            app_s3ref?: S3Reference;
             created_by?: string;
             created_at?: string;
             updated_at?: string;
@@ -71,10 +78,7 @@ declare namespace Components {
             /**
              * Configuration values for the app components
              */
-            config_values?: {
-                component_id?: string;
-                options?: /* Options for the component configuration */ ConfigurationOptions[];
-            };
+            config_values?: ComponentConfigValues[];
         }
         /**
          * Configuration of the published app
@@ -90,11 +94,10 @@ declare namespace Components {
              * URL of the app documentation.
              */
             documentation_url?: string;
-            description?: string;
             /**
-             * Link to the bundle (.zip) which contains all the app relevant assets
+             * Markdown description of the app.
              */
-            app_s3ref?: S3Reference;
+            description?: string;
             created_by?: string;
             created_at?: string;
             updated_at?: string;
@@ -192,6 +195,23 @@ declare namespace Components {
              */
             token_id?: string;
         }
+        export interface ComponentConfigValue {
+            /**
+             * Key matching a config_option from the component
+             */
+            key: string;
+            /**
+             * The configured value for this option
+             */
+            value: string;
+        }
+        export interface ComponentConfigValues {
+            /**
+             * ID of the component these values are for
+             */
+            component_id: string;
+            options: ComponentConfigValue[];
+        }
         /**
          * Type of app component
          */
@@ -212,18 +232,13 @@ declare namespace Components {
              * Detailed description of what this configuration option does
              */
             description?: string;
-            /**
-             * The configured value (only used in App installation)
-             */
-            value?: string;
             type: "string" | "number" | "boolean" | "secret";
-            /**
-             * Whether this configuration option must be set
-             */
-            required?: boolean;
         }
         export interface JourneyBlockConfig {
-            bundle_s3Ref?: S3Reference;
+            /**
+             * URL of the web component object
+             */
+            object_url: string;
             /**
              * Custom element tag for the component
              */
@@ -294,6 +309,13 @@ declare namespace Components {
     }
 }
 declare namespace Paths {
+    namespace GetAppConfiguration {
+        namespace Responses {
+            export type $200 = /* Configuration of the published app */ Components.Schemas.AppConfiguration;
+            export interface $404 {
+            }
+        }
+    }
     namespace GetInstalledApp {
         namespace Parameters {
             export type AppId = string;
@@ -358,33 +380,27 @@ declare namespace Paths {
             }
         }
     }
-    namespace UploadManifest {
-        export type RequestBody = Components.Schemas.UploadFilePayload;
-        namespace Responses {
-            export interface $201 {
-                s3ref?: Components.Schemas.S3Reference;
-                /**
-                 * example:
-                 * https://epilot-dev-blueprints.s3.eu-central-1.amazonaws.com/templates/document.pdf
-                 */
-                upload_url?: string; // url
-            }
+    namespace V1AppConfigurations$AppId {
+        namespace Parameters {
+            export type AppId = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
         }
     }
 }
 
 export interface OperationMethods {
   /**
-   * uploadManifest - uploadManifest
-   * 
-   * Create pre-signed S3 URL to upload a manifest file.
+   * getAppConfiguration - getAppConfiguration
    * 
+   * Retrieve a specific app configuration
    */
-  'uploadManifest'(
-    parameters?: Parameters<UnknownParamsObject> | null,
-    data?: Paths.UploadManifest.RequestBody,
+  'getAppConfiguration'(
+    parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
+    data?: any,
     config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.UploadManifest.Responses.$201>
+  ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
   /**
    * listInstalledApps - listInstalledApps
    * 
@@ -428,18 +444,17 @@ export interface OperationMethods {
 }
 
 export interface PathsDictionary {
-  ['/v1/app:uploadManifest']: {
+  ['/v1/app-configurations/{appId}']: {
     /**
-     * uploadManifest - uploadManifest
-     * 
-     * Create pre-signed S3 URL to upload a manifest file.
+     * getAppConfiguration - getAppConfiguration
      * 
+     * Retrieve a specific app configuration
      */
-    'post'(
-      parameters?: Parameters<UnknownParamsObject> | null,
-      data?: Paths.UploadManifest.RequestBody,
+    'get'(
+      parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
+      data?: any,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.UploadManifest.Responses.$201>
+    ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
   }
   ['/v1/app']: {
     /**
@@ -495,6 +510,8 @@ export type Author = Components.Schemas.Author;
 export type BaseComponent = Components.Schemas.BaseComponent;
 export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
 export type CallerIdentity = Components.Schemas.CallerIdentity;
+export type ComponentConfigValue = Components.Schemas.ComponentConfigValue;
+export type ComponentConfigValues = Components.Schemas.ComponentConfigValues;
 export type ComponentType = Components.Schemas.ComponentType;
 export type ConfigurationOptions = Components.Schemas.ConfigurationOptions;
 export type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;

package/dist/openapi.json

@@ -22,43 +22,35 @@
     }
   ],
   "paths": {
-    "/v1/app:uploadManifest": {
-      "post": {
-        "operationId": "uploadManifest",
-        "summary": "uploadManifest",
-        "description": "Create pre-signed S3 URL to upload a manifest file.\n",
-        "tags": [
-          "Import"
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/UploadFilePayload"
-              }
-            }
-          }
-        },
+    "/v1/app-configurations/{appId}": {
+      "parameters": [
+        {
+          "name": "appId",
+          "in": "path",
+          "required": true,
+          "schema": {
+            "type": "string"
+          },
+          "description": "ID of the app configuration"
+        }
+      ],
+      "get": {
+        "summary": "getAppConfiguration",
+        "description": "Retrieve a specific app configuration",
+        "operationId": "getAppConfiguration",
         "responses": {
-          "201": {
-            "description": "Pre-signed URL for POST / PUT upload",
+          "200": {
+            "description": "Successful response",
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {
-                    "s3ref": {
-                      "$ref": "#/components/schemas/S3Reference"
-                    },
-                    "upload_url": {
-                      "type": "string",
-                      "format": "url",
-                      "example": "https://epilot-dev-blueprints.s3.eu-central-1.amazonaws.com/templates/document.pdf"
-                    }
-                  }
+                  "$ref": "#/components/schemas/AppConfiguration"
                 }
               }
             }
+          },
+          "404": {
+            "description": "App configuration not found"
           }
         }
       }
@@ -221,7 +213,16 @@
         "content": {
           "application/json": {
             "schema": {
-              "$ref": "#/components/schemas/App"
+              "type": "object",
+              "properties": {
+                "config_values": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/ComponentConfigValues"
+                  },
+                  "description": "Configuration values for the app components"
+                }
+              }
             }
           }
         }
@@ -262,10 +263,6 @@
             "type": "string",
             "description": "Detailed description of what this configuration option does"
           },
-          "value": {
-            "type": "string",
-            "description": "The configured value (only used in App installation)"
-          },
           "type": {
             "type": "string",
             "enum": [
@@ -274,11 +271,42 @@
               "boolean",
               "secret"
             ]
+          }
+        }
+      },
+      "ComponentConfigValue": {
+        "type": "object",
+        "required": [
+          "key",
+          "value"
+        ],
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "Key matching a config_option from the component"
           },
-          "required": {
-            "type": "boolean",
-            "default": false,
-            "description": "Whether this configuration option must be set"
+          "value": {
+            "type": "string",
+            "description": "The configured value for this option"
+          }
+        }
+      },
+      "ComponentConfigValues": {
+        "type": "object",
+        "required": [
+          "component_id",
+          "options"
+        ],
+        "properties": {
+          "component_id": {
+            "type": "string",
+            "description": "ID of the component these values are for"
+          },
+          "options": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ComponentConfigValue"
+            }
           }
         }
       },
@@ -536,12 +564,13 @@
       "JourneyBlockConfig": {
         "type": "object",
         "required": [
-          "bundleS3ref",
+          "object_url",
           "componentTag"
         ],
         "properties": {
-          "bundle_s3Ref": {
-            "$ref": "#/components/schemas/S3Reference"
+          "object_url": {
+            "type": "string",
+            "description": "URL of the web component object"
           },
           "component_tag": {
             "type": "string",
@@ -579,24 +608,17 @@
             "readOnly": true
           },
           "enabled": {
+            "readOnly": true,
             "type": "boolean",
             "default": true,
             "description": "Flag to indicate if the app is enabled."
           },
           "config_values": {
-            "type": "object",
-            "properties": {
-              "component_id": {
-                "type": "string"
-              },
-              "options": {
-                "type": "array",
-                "items": {
-                  "$ref": "#/components/schemas/ConfigurationOptions"
-                }
-              }
-            },
-            "description": "Configuration values for the app components"
+            "description": "Configuration values for the app components",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ComponentConfigValues"
+            }
           }
         }
       },
@@ -619,11 +641,8 @@
             "description": "URL of the app documentation."
           },
           "description": {
-            "type": "string"
-          },
-          "app_s3ref": {
-            "description": "Link to the bundle (.zip) which contains all the app relevant assets",
-            "$ref": "#/components/schemas/S3Reference"
+            "type": "string",
+            "description": "Markdown description of the app."
           },
           "created_by": {
             "type": "string",

package/package.json

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