@epilot/app-client 0.3.2 → 0.3.3

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.0.3","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/{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":{}}},"/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":{}}},"/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":{}}},"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.0.3","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","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":{}}},"/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":{}}},"/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":{}}},"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

@@ -33,6 +33,20 @@
         "responses": {}
       }
     },
+    "/v1/app-configurations/public/{appId}": {
+      "parameters": [
+        {
+          "name": "appId",
+          "in": "path",
+          "required": true,
+          "description": "ID of the app configuration to install"
+        }
+      ],
+      "get": {
+        "operationId": "getPublicConfiguration",
+        "responses": {}
+      }
+    },
     "/v1/app-configurations/{appId}": {
       "parameters": [
         {

package/dist/openapi.d.ts

@@ -112,6 +112,7 @@ declare namespace Components {
              */
             id: string;
             name?: TranslatedString;
+            description?: TranslatedString;
             /**
              * List of options for the app component
              */
@@ -126,6 +127,10 @@ declare namespace Components {
              * Name of the component
              */
             name?: TranslatedString;
+            /**
+             * Description of the component
+             */
+            description?: TranslatedString;
             /**
              * List of options for the app component
              */
@@ -617,6 +622,57 @@ declare namespace Components {
             pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
             billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
         }
+        /**
+         * Public configuration of the published app
+         */
+        export interface PublicConfiguration {
+            /**
+             * ID of the app configuration
+             */
+            app_id?: string;
+            /**
+             * Organization ID of the app owner
+             */
+            owner_org_id?: string;
+            /**
+             * Name of the app
+             */
+            name?: string;
+            author?: Author;
+            /**
+             * Category of the app.
+             */
+            category?: string;
+            /**
+             * URL of the app icon.
+             */
+            icon_url?: string;
+            /**
+             * URL of the app documentation.
+             */
+            documentation_url?: string;
+            /**
+             * Markdown description of the app.
+             */
+            description?: TranslatedString;
+            /**
+             * Pricing information for the app
+             */
+            pricing?: Pricing;
+            components?: BaseComponent[];
+            /**
+             * Flag to indicate if the app is in beta.
+             */
+            is_beta?: boolean;
+            /**
+             * Timestamp when the app version is deprecated
+             */
+            deprecated_at?: string;
+            /**
+             * Version of the app that is installed
+             */
+            version?: string;
+        }
         export interface S3Reference {
             /**
              * The name of the S3 bucket where the JSON file for import is stored.
@@ -730,7 +786,7 @@ declare namespace Paths {
     namespace CreateConfiguration {
         export type RequestBody = Components.RequestBodies.CreateConfigRequest;
         namespace Responses {
-            export interface $202 {
+            export interface $201 {
                 app_id: string;
             }
         }
@@ -825,6 +881,13 @@ declare namespace Paths {
             }
         }
     }
+    namespace GetPublicConfiguration {
+        namespace Responses {
+            export type $200 = /* Public configuration of the published app */ Components.Schemas.PublicConfiguration;
+            export interface $404 {
+            }
+        }
+    }
     namespace GetVersion {
         namespace Parameters {
             export type AppId = string;
@@ -1015,6 +1078,14 @@ declare namespace Paths {
             appId: Parameters.AppId;
         }
     }
+    namespace V1AppConfigurationsPublic$AppId {
+        namespace Parameters {
+            export type AppId = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+        }
+    }
 }
 
 export interface OperationMethods {
@@ -1037,7 +1108,17 @@ export interface OperationMethods {
     parameters?: Parameters<UnknownParamsObject> | null,
     data?: Paths.CreateConfiguration.RequestBody,
     config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.CreateConfiguration.Responses.$202>
+  ): OperationResponse<Paths.CreateConfiguration.Responses.$201>
+  /**
+   * getPublicConfiguration - getPublicConfiguration
+   * 
+   * Retrieve the public configuration of an app to install in your tenant
+   */
+  'getPublicConfiguration'(
+    parameters?: Parameters<Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetPublicConfiguration.Responses.$200>
   /**
    * getConfiguration - getConfiguration
    * 
@@ -1241,7 +1322,19 @@ export interface PathsDictionary {
       parameters?: Parameters<UnknownParamsObject> | null,
       data?: Paths.CreateConfiguration.RequestBody,
       config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.CreateConfiguration.Responses.$202>
+    ): OperationResponse<Paths.CreateConfiguration.Responses.$201>
+  }
+  ['/v1/app-configurations/public/{appId}']: {
+    /**
+     * getPublicConfiguration - getPublicConfiguration
+     * 
+     * Retrieve the public configuration of an app to install in your tenant
+     */
+    'get'(
+      parameters?: Parameters<Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetPublicConfiguration.Responses.$200>
   }
   ['/v1/app-configurations/{appId}']: {
     /**
@@ -1474,6 +1567,7 @@ export type PortalAuth = Components.Schemas.PortalAuth;
 export type PortalExtensionComponent = Components.Schemas.PortalExtensionComponent;
 export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
 export type Pricing = Components.Schemas.Pricing;
+export type PublicConfiguration = Components.Schemas.PublicConfiguration;
 export type S3Reference = Components.Schemas.S3Reference;
 export type TextArg = Components.Schemas.TextArg;
 export type TranslatedString = Components.Schemas.TranslatedString;

package/dist/openapi.json

@@ -90,7 +90,7 @@
           "$ref": "#/components/requestBodies/CreateConfigRequest"
         },
         "responses": {
-          "202": {
+          "201": {
             "description": "App configuration created successfully",
             "content": {
               "application/json": {
@@ -111,6 +111,39 @@
         }
       }
     },
+    "/v1/app-configurations/public/{appId}": {
+      "parameters": [
+        {
+          "name": "appId",
+          "in": "path",
+          "required": true,
+          "schema": {
+            "type": "string"
+          },
+          "description": "ID of the app configuration to install"
+        }
+      ],
+      "get": {
+        "summary": "getPublicConfiguration",
+        "description": "Retrieve the public configuration of an app to install in your tenant",
+        "operationId": "getPublicConfiguration",
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PublicConfiguration"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "App configuration not found"
+          }
+        }
+      }
+    },
     "/v1/app-configurations/{appId}": {
       "parameters": [
         {
@@ -1222,6 +1255,10 @@
             "$ref": "#/components/schemas/TranslatedString",
             "description": "Name of the component"
           },
+          "description": {
+            "$ref": "#/components/schemas/TranslatedString",
+            "description": "Description of the component"
+          },
           "options": {
             "type": "array",
             "items": {
@@ -1643,7 +1680,6 @@
           "description",
           "latest_version",
           "owner_org_id",
-          "has_public_version",
           "app_id",
           "versions"
         ],
@@ -1879,6 +1915,68 @@
           }
         }
       },
+      "PublicConfiguration": {
+        "description": "Public configuration of the published app",
+        "type": "object",
+        "properties": {
+          "app_id": {
+            "type": "string",
+            "description": "ID of the app configuration"
+          },
+          "owner_org_id": {
+            "type": "string",
+            "description": "Organization ID of the app owner"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the app"
+          },
+          "author": {
+            "$ref": "#/components/schemas/Author"
+          },
+          "category": {
+            "type": "string",
+            "description": "Category of the app."
+          },
+          "icon_url": {
+            "type": "string",
+            "description": "URL of the app icon."
+          },
+          "documentation_url": {
+            "type": "string",
+            "description": "URL of the app documentation."
+          },
+          "description": {
+            "$ref": "#/components/schemas/TranslatedString",
+            "description": "Markdown description of the app."
+          },
+          "pricing": {
+            "$ref": "#/components/schemas/Pricing",
+            "description": "Pricing information for the app"
+          },
+          "components": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/BaseComponent"
+            },
+            "minItems": 0
+          },
+          "is_beta": {
+            "type": "boolean",
+            "description": "Flag to indicate if the app is in beta.",
+            "readOnly": true
+          },
+          "deprecated_at": {
+            "type": "string",
+            "description": "Timestamp when the app version is deprecated"
+          },
+          "version": {
+            "type": "string",
+            "description": "Version of the app that is installed",
+            "readOnly": true
+          }
+        }
+      },
       "Configuration": {
         "description": "Configuration of the published app",
         "allOf": [

package/package.json

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