@epilot/app-client 0.0.1

package/README.md

@@ -0,0 +1,29 @@
+# @epilot/app-client
+
+[![CI](https://github.com/epilot-dev/sdk-js/workflows/CI/badge.svg)](https://github.com/epilot-dev/sdk-js/actions?query=workflow%3ACI)
+[![npm version](https://img.shields.io/npm/v/@epilot/app-client.svg)](https://www.npmjs.com/package/@epilot/app-client)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/@epilot/app-client?label=gzip%20bundle)](https://bundlephobia.com/package/@epilot/app-client)
+[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/epilot-dev/sdk-js/blob/main/LICENSE)
+
+tbw
+
+Uses [`openapi-client-axios`](https://github.com/openapistack/openapi-client-axios)
+
+## Installation
+
+```bash
+npm install --save @epilot/app-client
+```
+
+## Usage
+
+```typescript
+import { getClient } from '@epilot/app-client';
+const appClient = getClient();
+
+const logs = await appClient.getLogs({ limit: 25, page: 2 });
+```
+
+## Documentation
+
+tbw

package/dist/client.d.ts

@@ -0,0 +1,3 @@
+import { Client } from './openapi';
+export declare const getClient: () => Client;
+export declare const createClient: () => Client;

package/dist/client.js

@@ -0,0 +1,37 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = exports.getClient = void 0;
+var lambda_powertools_correlation_ids_1 = __importDefault(require("@dazn/lambda-powertools-correlation-ids"));
+var openapi_client_axios_1 = __importDefault(require("openapi-client-axios"));
+var definition_1 = __importDefault(require("./definition"));
+var client;
+var getClient = function () {
+    if (!client) {
+        client = (0, exports.createClient)();
+    }
+    return client;
+};
+exports.getClient = getClient;
+var createClient = function () {
+    var _a;
+    var api = new openapi_client_axios_1.default({ definition: definition_1.default, quick: true });
+    var apiClient = api.initSync();
+    apiClient.defaults.headers.common = __assign(__assign({}, ((_a = apiClient.defaults.headers.common) !== null && _a !== void 0 ? _a : {})), (lambda_powertools_correlation_ids_1.default.get() || {}));
+    return apiClient;
+};
+exports.createClient = createClient;
+//# sourceMappingURL=client.js.map

package/dist/definition.d.ts

@@ -0,0 +1,3 @@
+import type { Document } from 'openapi-client-axios';
+declare const _default: Document;
+export default _default;

package/dist/definition.js

@@ -0,0 +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})})();

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './openapi';
+export type { OpenAPIClient, OpenAPIClientAxios, Document } from 'openapi-client-axios';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);
+//# sourceMappingURL=index.js.map

package/dist/openapi-runtime.json

@@ -0,0 +1,92 @@
+{
+  "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": {}
+        }
+      }
+    }
+  }
+}

package/dist/openapi.d.ts

@@ -0,0 +1,504 @@
+/* eslint-disable */
+
+import type {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios';
+
+declare namespace Components {
+    namespace RequestBodies {
+        export type InstallAppRequest = /* Information about the installed app */ Schemas.App;
+    }
+    namespace Schemas {
+        /**
+         * Information about the installed app
+         */
+        export interface App {
+            app_id?: string;
+            name?: string;
+            /**
+             * URL of the app icon.
+             */
+            icon_url?: string;
+            /**
+             * URL of the app documentation.
+             */
+            documentation_url?: string;
+            description?: string;
+            app_s3ref?: S3Reference;
+            created_by?: string;
+            created_at?: string;
+            updated_at?: string;
+            version?: string;
+            author?: Author;
+            status?: "published" | "pending";
+            components?: BaseComponent[];
+            /**
+             * Flag to indicate if the app is built by epilot.
+             */
+            internal?: boolean;
+            /**
+             * Organization ID of the app owner, required for private apps
+             */
+            owner_org_id?: string;
+            /**
+             * Access level of the app.
+             */
+            access_level?: "public" | "private";
+            /**
+             * Unique identifier for the app installation
+             */
+            installation_id?: string;
+            /**
+             * Unique identifier for the organization the app is installed in
+             */
+            organization_id?: string;
+            /**
+             * Timestamp of app creation
+             */
+            installed_at?: string;
+            /**
+             * User ID of the user who installed the app
+             */
+            installed_by?: string;
+            /**
+             * Flag to indicate if the app is enabled.
+             */
+            enabled?: boolean;
+            /**
+             * Configuration values for the app components
+             */
+            config_values?: {
+                component_id?: string;
+                options?: /* Options for the component configuration */ ConfigurationOptions[];
+            };
+        }
+        /**
+         * Configuration of the published app
+         */
+        export interface AppConfiguration {
+            app_id?: string;
+            name?: string;
+            /**
+             * URL of the app icon.
+             */
+            icon_url?: string;
+            /**
+             * URL of the app documentation.
+             */
+            documentation_url?: string;
+            description?: string;
+            /**
+             * Link to the bundle (.zip) which contains all the app relevant assets
+             */
+            app_s3ref?: S3Reference;
+            created_by?: string;
+            created_at?: string;
+            updated_at?: string;
+            version?: string;
+            author?: Author;
+            status?: "published" | "pending";
+            components?: BaseComponent[];
+            /**
+             * Flag to indicate if the app is built by epilot.
+             */
+            internal?: boolean;
+            /**
+             * Organization ID of the app owner, required for private apps
+             */
+            owner_org_id?: string;
+            /**
+             * Access level of the app.
+             */
+            access_level?: "public" | "private";
+        }
+        export interface Author {
+            /**
+             * Unique identifier for the author
+             */
+            id: string;
+            /**
+             * Name of the author
+             */
+            name: string;
+            /**
+             * Company of the author
+             */
+            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;
+            /**
+             * List of required options for the app component
+             */
+            config_options?: /* Options for the component configuration */ ConfigurationOptions[];
+        } | {
+            component_type?: "PORTAL_EXTENSION";
+            configuration: PortalExtensionConfig;
+            /**
+             * Unique identifier for the component
+             */
+            id: string;
+            /**
+             * List of required options for the app component
+             */
+            config_options?: /* Options for the component configuration */ ConfigurationOptions[];
+        };
+        export interface BaseComponentCommon {
+            /**
+             * Unique identifier for the component
+             */
+            id: string;
+            /**
+             * List of required options for the app component
+             */
+            config_options?: /* Options for the component configuration */ ConfigurationOptions[];
+        }
+        export interface CallerIdentity {
+            /**
+             * a human readable name of the caller (e.g. user name, token name or email address)
+             * example:
+             * manifest@epilot.cloud
+             */
+            name?: any;
+            /**
+             * epilot organization id
+             * example:
+             * 911690
+             */
+            org_id: string;
+            /**
+             * epilot user id, when called by a user
+             * example:
+             * 11001045
+             */
+            user_id?: string;
+            /**
+             * token id, when called by API token
+             * example:
+             * api_5ZugdRXasLfWBypHi93Fk
+             */
+            token_id?: string;
+        }
+        /**
+         * Type of app component
+         */
+        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION";
+        /**
+         * Options for the component configuration
+         */
+        export interface ConfigurationOptions {
+            /**
+             * Unique identifier for this configuration option
+             */
+            key: string;
+            /**
+             * Human-readable label for the configuration option
+             */
+            label?: string;
+            /**
+             * 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;
+            /**
+             * Custom element tag for the component
+             */
+            component_tag?: string;
+        }
+        export interface PortalAuth {
+            type?: string;
+            url?: string;
+            method?: string;
+            headers?: {
+                [name: string]: string;
+            };
+        }
+        export interface PortalExtensionConfig {
+            id?: string;
+            hooks?: {
+                id?: string;
+                type?: string;
+                name?: string;
+                interval?: string[];
+                auth?: PortalAuth;
+                call?: {
+                    url?: string;
+                    headers?: {
+                        [name: string]: string;
+                    };
+                    params?: {
+                        [name: string]: string;
+                    };
+                };
+            }[];
+            links?: {
+                id?: string;
+                type?: string;
+                name?: string;
+                description?: string;
+                condition?: string;
+                auth?: PortalAuth;
+                redirect?: {
+                    url?: string;
+                    params?: {
+                        [name: string]: string;
+                    };
+                };
+            }[];
+        }
+        export interface S3Reference {
+            /**
+             * The name of the S3 bucket where the JSON file for import is stored.
+             * example:
+             * my-bucket
+             */
+            bucket: string;
+            /**
+             * The key or path to the JSON file within the S3 bucket.
+             * example:
+             * manifest.json
+             */
+            key: string;
+        }
+        export interface UploadFilePayload {
+            /**
+             * example:
+             * example.manifest.zip
+             */
+            filename: string;
+        }
+    }
+}
+declare namespace Paths {
+    namespace GetInstalledApp {
+        namespace Parameters {
+            export type AppId = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+        }
+        namespace Responses {
+            export type $200 = /* Information about the installed app */ Components.Schemas.App;
+            export interface $404 {
+            }
+        }
+    }
+    namespace InstallApp {
+        namespace Parameters {
+            export type AppId = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+        }
+        export type RequestBody = Components.RequestBodies.InstallAppRequest;
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $404 {
+            }
+        }
+    }
+    namespace ListInstalledApps {
+        namespace Parameters {
+            export type ComponentType = /* Type of app component */ Components.Schemas.ComponentType;
+            export type Page = number;
+            export type PageSize = number;
+        }
+        export interface QueryParameters {
+            componentType?: Parameters.ComponentType;
+            page?: Parameters.Page;
+            pageSize?: Parameters.PageSize;
+        }
+        namespace Responses {
+            export interface $200 {
+                apps?: /* Information about the installed app */ Components.Schemas.App[];
+                pagination?: {
+                    total?: number;
+                    page?: number;
+                    pageSize?: number;
+                };
+            }
+        }
+    }
+    namespace UninstallApp {
+        namespace Parameters {
+            export type AppId = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+        }
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $404 {
+            }
+        }
+    }
+    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
+            }
+        }
+    }
+}
+
+export interface OperationMethods {
+  /**
+   * uploadManifest - uploadManifest
+   * 
+   * Create pre-signed S3 URL to upload a manifest file.
+   * 
+   */
+  'uploadManifest'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.UploadManifest.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UploadManifest.Responses.$201>
+  /**
+   * listInstalledApps - listInstalledApps
+   * 
+   * Retrieve a list of installed apps for the organization.
+   */
+  'listInstalledApps'(
+    parameters?: Parameters<Paths.ListInstalledApps.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListInstalledApps.Responses.$200>
+  /**
+   * getInstalledApp - getInstalledApp
+   * 
+   * Retrieve details of an installed app by its ID.
+   */
+  'getInstalledApp'(
+    parameters?: Parameters<Paths.GetInstalledApp.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetInstalledApp.Responses.$200>
+  /**
+   * installApp - installApp
+   * 
+   * Update assets of a specific installed app by its ID.
+   */
+  'installApp'(
+    parameters?: Parameters<Paths.InstallApp.PathParameters> | null,
+    data?: Paths.InstallApp.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.InstallApp.Responses.$204>
+  /**
+   * uninstallApp - uninstallApp
+   * 
+   * Uninstall an app by its ID.
+   */
+  'uninstallApp'(
+    parameters?: Parameters<Paths.UninstallApp.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UninstallApp.Responses.$204>
+}
+
+export interface PathsDictionary {
+  ['/v1/app:uploadManifest']: {
+    /**
+     * uploadManifest - uploadManifest
+     * 
+     * Create pre-signed S3 URL to upload a manifest file.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.UploadManifest.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UploadManifest.Responses.$201>
+  }
+  ['/v1/app']: {
+    /**
+     * listInstalledApps - listInstalledApps
+     * 
+     * Retrieve a list of installed apps for the organization.
+     */
+    'get'(
+      parameters?: Parameters<Paths.ListInstalledApps.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListInstalledApps.Responses.$200>
+  }
+  ['/v1/app/{appId}']: {
+    /**
+     * getInstalledApp - getInstalledApp
+     * 
+     * Retrieve details of an installed app by its ID.
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetInstalledApp.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetInstalledApp.Responses.$200>
+    /**
+     * installApp - installApp
+     * 
+     * Update assets of a specific installed app by its ID.
+     */
+    'put'(
+      parameters?: Parameters<Paths.InstallApp.PathParameters> | null,
+      data?: Paths.InstallApp.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.InstallApp.Responses.$204>
+    /**
+     * uninstallApp - uninstallApp
+     * 
+     * Uninstall an app by its ID.
+     */
+    'delete'(
+      parameters?: Parameters<Paths.UninstallApp.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UninstallApp.Responses.$204>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
+
+export type App = Components.Schemas.App;
+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 CallerIdentity = Components.Schemas.CallerIdentity;
+export type ComponentType = Components.Schemas.ComponentType;
+export type ConfigurationOptions = Components.Schemas.ConfigurationOptions;
+export type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;
+export type PortalAuth = Components.Schemas.PortalAuth;
+export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
+export type S3Reference = Components.Schemas.S3Reference;
+export type UploadFilePayload = Components.Schemas.UploadFilePayload;