@epilot/app-client 0.0.8 → 0.0.10

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 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})})();
+(()=>{"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":"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 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,27 +10,6 @@
     }
   ],
   "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": [
         {

package/dist/openapi.d.ts

@@ -39,6 +39,7 @@ declare namespace Components {
              */
             documentation_url?: string;
             description?: TranslatedString;
+            notifications?: NotificationConfig;
             created_by?: string;
             created_at?: string;
             /**
@@ -108,6 +109,10 @@ declare namespace Components {
              * Markdown description of the app.
              */
             description?: TranslatedString;
+            /**
+             * Configuration for developer notifications
+             */
+            notifications?: NotificationConfig;
             created_by?: string;
             created_at?: string;
             updated_at?: string;
@@ -168,6 +173,9 @@ declare namespace Components {
              */
             options?: /* Options for the component configuration */ Options[];
         }
+        export interface BooleanArg {
+            type?: "boolean";
+        }
         export interface CallerIdentity {
             /**
              * a human readable name of the caller (e.g. user name, token name or email address)
@@ -198,10 +206,55 @@ declare namespace Components {
          * Type of app component
          */
         export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION";
+        export interface EnumArg {
+            type?: "enum";
+            /**
+             * If true, allows selection of multiple values
+             */
+            isMulti?: boolean;
+            /**
+             * List of options for enum type
+             */
+            options: [
+                {
+                    /**
+                     * Unique identifier for the option
+                     */
+                    id: string;
+                    /**
+                     * Display label for the option
+                     */
+                    label: TranslatedString;
+                },
+                ...{
+                    /**
+                     * Unique identifier for the option
+                     */
+                    id: string;
+                    /**
+                     * Display label for the option
+                     */
+                    label: TranslatedString;
+                }[]
+            ];
+        }
         export interface JourneyBlockComponent {
             component_type: "CUSTOM_JOURNEY_BLOCK";
             configuration: JourneyBlockConfig;
         }
+        export type JourneyBlockComponentArgs = {
+            /**
+             * Unique identifier for this component arg
+             */
+            key: string;
+            type: "text" | "boolean" | "enum";
+            /**
+             * Flag to indicate if this option is required
+             */
+            required?: boolean;
+            description?: TranslatedString;
+            label: TranslatedString;
+        } & (TextArg | BooleanArg | EnumArg);
         export interface JourneyBlockConfig {
             /**
              * URL of the web component object
@@ -213,7 +266,33 @@ declare namespace Components {
              * Custom element tag for the component
              */
             component_tag: string;
+            /**
+             * Arguments to pass to the component
+             */
+            component_args?: JourneyBlockComponentArgs[];
+            /**
+             * Define data which is mapped to entity mapping ui blocks
+             */
+            component_mapping?: {
+                [name: string]: "string" | "boolean" | "date" | "datetime";
+            };
         }
+        export interface NotificationConfig {
+            /**
+             * Email address to receive notifications
+             * example:
+             * developer@example.com
+             */
+            email: string; // email
+            /**
+             * List of events to subscribe to
+             */
+            events: [
+                NotificationEvent,
+                ...NotificationEvent[]
+            ];
+        }
+        export type NotificationEvent = "app.installed" | "app.uninstalled";
         export interface Option {
             /**
              * Key matching a config_option from the component
@@ -317,6 +396,9 @@ declare namespace Components {
              */
             key: string;
         }
+        export interface TextArg {
+            type?: "text";
+        }
         export interface TranslatedString {
             /**
              * English translation
@@ -356,26 +438,6 @@ 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;
@@ -415,19 +477,6 @@ 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;
@@ -453,26 +502,6 @@ 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
    * 
@@ -526,30 +555,6 @@ 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
@@ -615,10 +620,15 @@ export type AppConfiguration = Components.Schemas.AppConfiguration;
 export type Author = Components.Schemas.Author;
 export type BaseComponent = Components.Schemas.BaseComponent;
 export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
+export type BooleanArg = Components.Schemas.BooleanArg;
 export type CallerIdentity = Components.Schemas.CallerIdentity;
 export type ComponentType = Components.Schemas.ComponentType;
+export type EnumArg = Components.Schemas.EnumArg;
 export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
+export type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
 export type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;
+export type NotificationConfig = Components.Schemas.NotificationConfig;
+export type NotificationEvent = Components.Schemas.NotificationEvent;
 export type Option = Components.Schemas.Option;
 export type Options = Components.Schemas.Options;
 export type OptionsRef = Components.Schemas.OptionsRef;
@@ -626,5 +636,6 @@ 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 TextArg = Components.Schemas.TextArg;
 export type TranslatedString = Components.Schemas.TranslatedString;
 export type UploadFilePayload = Components.Schemas.UploadFilePayload;

package/dist/openapi.json

@@ -22,99 +22,6 @@
     }
   ],
   "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": [
         {
@@ -505,6 +412,36 @@
           }
         }
       },
+      "NotificationConfig": {
+        "type": "object",
+        "required": [
+          "email",
+          "events"
+        ],
+        "properties": {
+          "email": {
+            "type": "string",
+            "format": "email",
+            "description": "Email address to receive notifications",
+            "example": "developer@example.com"
+          },
+          "events": {
+            "type": "array",
+            "description": "List of events to subscribe to",
+            "items": {
+              "$ref": "#/components/schemas/NotificationEvent"
+            },
+            "minItems": 1
+          }
+        }
+      },
+      "NotificationEvent": {
+        "type": "string",
+        "enum": [
+          "app.installed",
+          "app.uninstalled"
+        ]
+      },
       "BaseComponentCommon": {
         "type": "object",
         "required": [
@@ -725,6 +662,150 @@
           "component_tag": {
             "type": "string",
             "description": "Custom element tag for the component"
+          },
+          "component_args": {
+            "type": "array",
+            "description": "Arguments to pass to the component",
+            "items": {
+              "$ref": "#/components/schemas/JourneyBlockComponentArgs"
+            }
+          },
+          "component_mapping": {
+            "description": "Define data which is mapped to entity mapping ui blocks",
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "enum": [
+                "string",
+                "boolean",
+                "date",
+                "datetime"
+              ]
+            }
+          }
+        }
+      },
+      "JourneyBlockComponentArgs": {
+        "allOf": [
+          {
+            "type": "object",
+            "required": [
+              "key",
+              "label",
+              "type"
+            ],
+            "properties": {
+              "key": {
+                "type": "string",
+                "description": "Unique identifier for this component arg"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "text",
+                  "boolean",
+                  "enum"
+                ]
+              },
+              "required": {
+                "type": "boolean",
+                "description": "Flag to indicate if this option is required",
+                "default": false
+              },
+              "description": {
+                "description": "Description of what this component arg does",
+                "$ref": "#/components/schemas/TranslatedString"
+              },
+              "label": {
+                "description": "Human-readable label for the component arg",
+                "$ref": "#/components/schemas/TranslatedString"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "discriminator": {
+              "propertyName": "type",
+              "mapping": {
+                "text": "#/components/schemas/TextArg",
+                "boolean": "#/components/schemas/BooleanArg",
+                "enum": "#/components/schemas/EnumArg"
+              }
+            },
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/TextArg"
+              },
+              {
+                "$ref": "#/components/schemas/BooleanArg"
+              },
+              {
+                "$ref": "#/components/schemas/EnumArg"
+              }
+            ]
+          }
+        ]
+      },
+      "TextArg": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "text"
+            ]
+          }
+        }
+      },
+      "BooleanArg": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "boolean"
+            ]
+          }
+        }
+      },
+      "EnumArg": {
+        "type": "object",
+        "required": [
+          "options"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "enum"
+            ]
+          },
+          "isMulti": {
+            "type": "boolean",
+            "description": "If true, allows selection of multiple values",
+            "default": false
+          },
+          "options": {
+            "type": "array",
+            "description": "List of options for enum type",
+            "minItems": 1,
+            "items": {
+              "type": "object",
+              "required": [
+                "id",
+                "label"
+              ],
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Unique identifier for the option"
+                },
+                "label": {
+                  "$ref": "#/components/schemas/TranslatedString",
+                  "description": "Display label for the option"
+                }
+              }
+            }
           }
         }
       },
@@ -804,6 +885,10 @@
             "$ref": "#/components/schemas/TranslatedString",
             "description": "Markdown description of the app."
           },
+          "notifications": {
+            "$ref": "#/components/schemas/NotificationConfig",
+            "description": "Configuration for developer notifications"
+          },
           "created_by": {
             "type": "string",
             "readOnly": true

package/package.json

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