@epilot/blueprint-manifest-client 2.2.1

package/README.md

@@ -0,0 +1,29 @@
+# @epilot/blueprint-manifest-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/tf-blueprints-client.svg)](https://www.npmjs.com/package/@epilot/tf-blueprints-client)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/@epilot/tf-blueprints-client?label=gzip%20bundle)](https://bundlephobia.com/package/@epilot/tf-blueprints-client)
+[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/epilot-dev/sdk-js/blob/main/LICENSE)
+
+Client library for epilot [Blueprint Manifest API](https://docs.epilot.io/api/blueprint-manifest)
+
+Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
+
+## Installation
+
+```bash
+npm install --save @epilot/tf-blueprints-client
+```
+
+## Usage
+
+```typescript
+import { getClient } from "@epilot/blueprint-manifest";
+
+const blueprintManifestClient = getClient();
+const res = await blueprintManifestClient.getJob('my-job');
+```
+
+## Documentation:
+
+https://docs.epilot.io/api/blueprints

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,40 @@
+"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={914:function(e,t,o){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=r(o(240));t.default=s.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://blueprint-manifest.sls.epilot.io"}],"paths":{"/v1/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getJob","parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{}}},"/v1/blueprint-manifest/jobs:createExport":{"post":{"operationId":"createExport","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:exportManifest":{"post":{"operationId":"exportManifest","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest:uploadManifest":{"post":{"operationId":"uploadManifest","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs:createPlan":{"post":{"operationId":"createPlan","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:applyPlan":{"post":{"operationId":"applyPlan","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{"parameters":{"JobID":{"name":"job_id","in":"path","required":true}}}}')}},t={},o=function o(r){var s=t[r];if(void 0!==s)return s.exports;var n=t[r]={exports:{}};return e[r].call(n.exports,n,n.exports,o),n.exports}(914),r=exports;for(var s in o)r[s]=o[s];o.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();

package/dist/index.d.ts

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

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,99 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "",
+    "version": ""
+  },
+  "servers": [
+    {
+      "url": "https://blueprint-manifest.sls.epilot.io"
+    }
+  ],
+  "paths": {
+    "/v1/blueprint-manifest/jobs/{job_id}": {
+      "get": {
+        "operationId": "getJob",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/JobID"
+          }
+        ],
+        "responses": {}
+      }
+    },
+    "/v1/blueprint-manifest/jobs:createExport": {
+      "post": {
+        "operationId": "createExport",
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
+    "/v1/blueprint-manifest/jobs/{job_id}:exportManifest": {
+      "post": {
+        "operationId": "exportManifest",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/JobID"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
+    "/v1/blueprint-manifest:uploadManifest": {
+      "post": {
+        "operationId": "uploadManifest",
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
+    "/v1/blueprint-manifest/jobs:createPlan": {
+      "post": {
+        "operationId": "createPlan",
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
+    "/v1/blueprint-manifest/jobs/{job_id}:applyPlan": {
+      "post": {
+        "operationId": "applyPlan",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/JobID"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    }
+  },
+  "components": {
+    "parameters": {
+      "JobID": {
+        "name": "job_id",
+        "in": "path",
+        "required": true
+      }
+    }
+  }
+}

package/dist/openapi.d.ts

@@ -0,0 +1,414 @@
+/* eslint-disable */
+import type {
+  OpenAPIClient,
+  Parameters,
+  UnknownParamsObject,
+  OperationResponse,
+  AxiosRequestConfig,
+} from 'openapi-client-axios'; 
+
+declare namespace Components {
+    namespace Parameters {
+        export type JobID = /**
+         * ID of an import or export job
+         * example:
+         * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+         */
+        Schemas.JobID;
+    }
+    export interface PathParameters {
+        JobID?: Parameters.JobID;
+    }
+    namespace Schemas {
+        export interface Job {
+            job_status?: JobStatus;
+            job_id?: /**
+             * ID of an import or export job
+             * example:
+             * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+             */
+            JobID;
+            message?: string;
+            timestamp?: string; // date-time
+            /**
+             * An URL to download the plan file
+             */
+            plan_file_content?: string;
+            /**
+             * An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
+             */
+            resources_to_export?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ ResourceNode[] | ResourceNode;
+            /**
+             * An URL to download the resources to export when the resources are too large to be included in the response
+             */
+            large_resources_to_export_url?: string;
+            /**
+             * An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
+             */
+            resources_to_import?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ ResourceNode[] | ResourceNode;
+            /**
+             * An URL to download the resources to import when the resources are too large to be included in the response
+             */
+            large_resources_to_import_url?: string;
+            /**
+             * An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
+             */
+            imported_resources?: /* An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import */ ResourceNode[] | ResourceNode;
+            /**
+             * An URL to download the imported resources when the resources are too large to be included in the response
+             */
+            large_imported_resources_url?: string;
+            markdown?: {
+                /**
+                 * Markdown content to be displayed when showing the plan to install blueprint
+                 * example:
+                 * This is the content of the preinstall.md file
+                 *
+                 */
+                preinstall?: string;
+                /**
+                 * Markdown content to be displayed when showing the plan to install blueprint
+                 * example:
+                 * This is the content of the postinstall.md file
+                 *
+                 */
+                postinstall?: string;
+            };
+        }
+        /**
+         * ID of an import or export job
+         * example:
+         * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+         */
+        export type JobID = string;
+        export type JobStatus = "STARTED" | "WAITING_USER_ACTION" | "CANCELLED" | "IN_PROGRESS" | "SUCCESS" | "FAILED";
+        export interface ResourceNode {
+            id: string;
+            type: ResourceNodeType;
+            name?: string;
+            source_id?: string;
+            address?: string;
+            dependencies?: ResourceNode[];
+            changes?: ("create" | "update" | "no-op" | "delete")[];
+        }
+        export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "workflow_definition" | "closing_reason" | "taxonomy_classification";
+        export interface S3Reference {
+            /**
+             * example:
+             * epilot-dev-blueprints
+             */
+            bucket?: string;
+            /**
+             * example:
+             * templates/main.tf
+             */
+            key?: string;
+        }
+        export interface UploadFilePayload {
+            /**
+             * example:
+             * main.tf
+             */
+            filename: string;
+            /**
+             * MIME type of file
+             * example:
+             * application/pdf
+             */
+            mime_type?: string;
+        }
+    }
+}
+declare namespace Paths {
+    namespace ApplyPlan {
+        namespace Parameters {
+            export type JobId = /**
+             * ID of an import or export job
+             * example:
+             * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+             */
+            Components.Schemas.JobID;
+        }
+        export interface PathParameters {
+            job_id: Parameters.JobId;
+        }
+        export interface RequestBody {
+            /**
+             * example:
+             * example.tf
+             */
+            manifestFilePath?: string;
+        }
+        namespace Responses {
+            export type $200 = string;
+        }
+    }
+    namespace CreateExport {
+        export interface RequestBody {
+            resourceType?: "journey" | "product" | "price" | "tax" | "automation_flow" | "designbuilder" | "file" | "emailtemplate" | "entity" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "workflow_definition" | "closing_reason" | "taxonomy_classification";
+            resourceIds?: [
+                string,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?,
+                string?
+            ];
+        }
+        namespace Responses {
+            export interface $200 {
+                jobId?: /**
+                 * ID of an import or export job
+                 * example:
+                 * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+                 */
+                Components.Schemas.JobID;
+            }
+        }
+    }
+    namespace CreatePlan {
+        export interface RequestBody {
+            /**
+             * Path to the manifest file uploaded via `uploadManifest`
+             * example:
+             * example.tf
+             */
+            manifestFilePath?: string;
+        }
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * example:
+                 * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+                 */
+                jobId?: string;
+            }
+        }
+    }
+    namespace ExportManifest {
+        namespace Parameters {
+            export type JobId = /**
+             * ID of an import or export job
+             * example:
+             * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+             */
+            Components.Schemas.JobID;
+        }
+        export interface PathParameters {
+            job_id: Parameters.JobId;
+        }
+        export interface RequestBody {
+            /**
+             * An array of resource IDs to export
+             */
+            selectedResourceIds?: string[];
+            /**
+             * example:
+             * journey_HouseConnectionJourney
+             */
+            resourceName?: string;
+        }
+        namespace Responses {
+            export interface $200 {
+                jobId?: /**
+                 * ID of an import or export job
+                 * example:
+                 * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+                 */
+                Components.Schemas.JobID;
+            }
+        }
+    }
+    namespace GetJob {
+        namespace Parameters {
+            export type JobId = /**
+             * ID of an import or export job
+             * example:
+             * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+             */
+            Components.Schemas.JobID;
+        }
+        export interface PathParameters {
+            job_id: Parameters.JobId;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.Job;
+        }
+    }
+    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 {
+  /**
+   * getJob - getJob
+   * 
+   * Get the current status of a blueprint (export or import)
+   */
+  'getJob'(
+    parameters?: Parameters<Paths.GetJob.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetJob.Responses.$200>
+  /**
+   * createExport - createExport
+   * 
+   * Creates a new Export Job with a list of available resources to export from the passed root resource.
+   * 
+   */
+  'createExport'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreateExport.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateExport.Responses.$200>
+  /**
+   * exportManifest - exportManifest
+   * 
+   * Triggers exporting a manifest file using selected resoruce ids for a job created with `createExportJob`
+   */
+  'exportManifest'(
+    parameters?: Parameters<Paths.ExportManifest.PathParameters> | null,
+    data?: Paths.ExportManifest.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ExportManifest.Responses.$200>
+  /**
+   * 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>
+  /**
+   * createPlan - createPlan
+   * 
+   * Creates a new import job from an uploaded manifest file and returns the plan
+   */
+  'createPlan'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreatePlan.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreatePlan.Responses.$200>
+  /**
+   * applyPlan - applyPlan
+   * 
+   * Apply a plan returned by `createPlan`
+   */
+  'applyPlan'(
+    parameters?: Parameters<Paths.ApplyPlan.PathParameters> | null,
+    data?: Paths.ApplyPlan.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ApplyPlan.Responses.$200>
+}
+
+export interface PathsDictionary {
+  ['/v1/blueprint-manifest/jobs/{job_id}']: {
+    /**
+     * getJob - getJob
+     * 
+     * Get the current status of a blueprint (export or import)
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetJob.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetJob.Responses.$200>
+  }
+  ['/v1/blueprint-manifest/jobs:createExport']: {
+    /**
+     * createExport - createExport
+     * 
+     * Creates a new Export Job with a list of available resources to export from the passed root resource.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CreateExport.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateExport.Responses.$200>
+  }
+  ['/v1/blueprint-manifest/jobs/{job_id}:exportManifest']: {
+    /**
+     * exportManifest - exportManifest
+     * 
+     * Triggers exporting a manifest file using selected resoruce ids for a job created with `createExportJob`
+     */
+    'post'(
+      parameters?: Parameters<Paths.ExportManifest.PathParameters> | null,
+      data?: Paths.ExportManifest.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ExportManifest.Responses.$200>
+  }
+  ['/v1/blueprint-manifest: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/blueprint-manifest/jobs:createPlan']: {
+    /**
+     * createPlan - createPlan
+     * 
+     * Creates a new import job from an uploaded manifest file and returns the plan
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CreatePlan.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreatePlan.Responses.$200>
+  }
+  ['/v1/blueprint-manifest/jobs/{job_id}:applyPlan']: {
+    /**
+     * applyPlan - applyPlan
+     * 
+     * Apply a plan returned by `createPlan`
+     */
+    'post'(
+      parameters?: Parameters<Paths.ApplyPlan.PathParameters> | null,
+      data?: Paths.ApplyPlan.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ApplyPlan.Responses.$200>
+  }
+}
+
+export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/dist/openapi.json

@@ -0,0 +1,533 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Blueprint Manifest API",
+    "version": "0.1.0",
+    "description": "Service to create and install Blueprint Manifest files"
+  },
+  "tags": [
+    {
+      "name": "Jobs",
+      "description": "Manage Export and Import Jobs"
+    },
+    {
+      "name": "Export",
+      "description": "Export a Blueprint Manifest"
+    },
+    {
+      "name": "Import",
+      "description": "Import a Blueprint Manifest"
+    }
+  ],
+  "security": [
+    {
+      "EpilotAuth": []
+    }
+  ],
+  "servers": [
+    {
+      "url": "https://blueprint-manifest.sls.epilot.io"
+    }
+  ],
+  "paths": {
+    "/v1/blueprint-manifest/jobs/{job_id}": {
+      "get": {
+        "operationId": "getJob",
+        "summary": "getJob",
+        "description": "Get the current status of a blueprint (export or import)",
+        "tags": [
+          "Jobs"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/JobID"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Current status of the blueprint",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Job"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/blueprint-manifest/jobs:createExport": {
+      "post": {
+        "operationId": "createExport",
+        "summary": "createExport",
+        "description": "Creates a new Export Job with a list of available resources to export from the passed root resource.\n",
+        "tags": [
+          "Export"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "resourceType": {
+                    "type": "string",
+                    "enum": [
+                      "journey",
+                      "product",
+                      "price",
+                      "tax",
+                      "automation_flow",
+                      "designbuilder",
+                      "file",
+                      "emailtemplate",
+                      "entity",
+                      "schema",
+                      "schema_attribute",
+                      "schema_capability",
+                      "schema_group",
+                      "workflow_definition",
+                      "closing_reason",
+                      "taxonomy_classification"
+                    ]
+                  },
+                  "resourceIds": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "minItems": 1,
+                    "maxItems": 25
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Created Export Job ID",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "jobId": {
+                      "$ref": "#/components/schemas/JobID"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/blueprint-manifest/jobs/{job_id}:exportManifest": {
+      "post": {
+        "operationId": "exportManifest",
+        "summary": "exportManifest",
+        "description": "Triggers exporting a manifest file using selected resoruce ids for a job created with `createExportJob`",
+        "tags": [
+          "Export"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/JobID"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "selectedResourceIds": {
+                    "description": "An array of resource IDs to export",
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "resourceName": {
+                    "type": "string",
+                    "example": "journey_HouseConnectionJourney"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Export Job ID",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "jobId": {
+                      "$ref": "#/components/schemas/JobID"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/blueprint-manifest: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"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Pre-signed URL for POST / PUT upload",
+            "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"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/blueprint-manifest/jobs:createPlan": {
+      "post": {
+        "operationId": "createPlan",
+        "summary": "createPlan",
+        "description": "Creates a new import job from an uploaded manifest file and returns the plan",
+        "tags": [
+          "Import"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "manifestFilePath": {
+                    "description": "Path to the manifest file uploaded via `uploadManifest`",
+                    "type": "string",
+                    "example": "example.tf"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Created Import Job ID",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "jobId": {
+                      "type": "string",
+                      "example": "4854bb2a-94f9-424d-a968-3fb17fb0bf89"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/blueprint-manifest/jobs/{job_id}:applyPlan": {
+      "post": {
+        "operationId": "applyPlan",
+        "summary": "applyPlan",
+        "description": "Apply a plan returned by `createPlan`",
+        "tags": [
+          "Import"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/JobID"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "manifestFilePath": {
+                    "type": "string",
+                    "example": "example.tf"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "JobStatus": {
+        "type": "string",
+        "enum": [
+          "STARTED",
+          "WAITING_USER_ACTION",
+          "CANCELLED",
+          "IN_PROGRESS",
+          "SUCCESS",
+          "FAILED"
+        ]
+      },
+      "ResourceNodeType": {
+        "type": "string",
+        "enum": [
+          "designbuilder",
+          "journey",
+          "product",
+          "price",
+          "tax",
+          "automation_flow",
+          "entity_mapping",
+          "file",
+          "emailtemplate",
+          "schema",
+          "schema_attribute",
+          "schema_capability",
+          "schema_group",
+          "workflow_definition",
+          "closing_reason",
+          "taxonomy_classification"
+        ]
+      },
+      "ResourceNode": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "type": {
+            "$ref": "#/components/schemas/ResourceNodeType"
+          },
+          "name": {
+            "type": "string"
+          },
+          "source_id": {
+            "type": "string"
+          },
+          "address": {
+            "type": "string"
+          },
+          "dependencies": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ResourceNode"
+            }
+          },
+          "changes": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": [
+                "create",
+                "update",
+                "no-op",
+                "delete"
+              ]
+            }
+          }
+        },
+        "required": [
+          "id",
+          "type"
+        ]
+      },
+      "JobID": {
+        "type": "string",
+        "description": "ID of an import or export job",
+        "example": "4854bb2a-94f9-424d-a968-3fb17fb0bf89"
+      },
+      "Job": {
+        "type": "object",
+        "properties": {
+          "job_status": {
+            "$ref": "#/components/schemas/JobStatus"
+          },
+          "job_id": {
+            "$ref": "#/components/schemas/JobID"
+          },
+          "message": {
+            "type": "string"
+          },
+          "timestamp": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "plan_file_content": {
+            "type": "string",
+            "description": "An URL to download the plan file"
+          },
+          "resources_to_export": {
+            "description": "An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import",
+            "oneOf": [
+              {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ResourceNode"
+                }
+              },
+              {
+                "$ref": "#/components/schemas/ResourceNode"
+              }
+            ]
+          },
+          "large_resources_to_export_url": {
+            "type": "string",
+            "description": "An URL to download the resources to export when the resources are too large to be included in the response"
+          },
+          "resources_to_import": {
+            "description": "An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import",
+            "oneOf": [
+              {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ResourceNode"
+                }
+              },
+              {
+                "$ref": "#/components/schemas/ResourceNode"
+              }
+            ]
+          },
+          "large_resources_to_import_url": {
+            "type": "string",
+            "description": "An URL to download the resources to import when the resources are too large to be included in the response"
+          },
+          "imported_resources": {
+            "description": "An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import",
+            "oneOf": [
+              {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ResourceNode"
+                }
+              },
+              {
+                "$ref": "#/components/schemas/ResourceNode"
+              }
+            ]
+          },
+          "large_imported_resources_url": {
+            "type": "string",
+            "description": "An URL to download the imported resources when the resources are too large to be included in the response"
+          },
+          "markdown": {
+            "type": "object",
+            "properties": {
+              "preinstall": {
+                "type": "string",
+                "description": "Markdown content to be displayed when showing the plan to install blueprint",
+                "example": "This is the content of the preinstall.md file\n"
+              },
+              "postinstall": {
+                "type": "string",
+                "description": "Markdown content to be displayed when showing the plan to install blueprint",
+                "example": "This is the content of the postinstall.md file\n"
+              }
+            }
+          }
+        }
+      },
+      "UploadFilePayload": {
+        "type": "object",
+        "properties": {
+          "filename": {
+            "type": "string",
+            "example": "main.tf"
+          },
+          "mime_type": {
+            "description": "MIME type of file",
+            "type": "string",
+            "example": "application/pdf",
+            "default": "application/octet-stream"
+          }
+        },
+        "required": [
+          "filename"
+        ]
+      },
+      "S3Reference": {
+        "type": "object",
+        "properties": {
+          "bucket": {
+            "type": "string",
+            "example": "epilot-dev-blueprints"
+          },
+          "key": {
+            "type": "string",
+            "example": "templates/main.tf"
+          }
+        }
+      }
+    },
+    "parameters": {
+      "JobID": {
+        "name": "job_id",
+        "in": "path",
+        "required": true,
+        "description": "ID of an import or export job",
+        "schema": {
+          "$ref": "#/components/schemas/JobID"
+        }
+      }
+    },
+    "securitySchemes": {
+      "EpilotAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "description": "Authorization header with epilot OAuth2 bearer token",
+        "bearerFormat": "JWT"
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@epilot/blueprint-manifest-client",
+  "version": "2.2.1",
+  "description": "Client for epilot Terraform Blueprint Manifest API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "epilot GmbH",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/epilot-dev/sdk-js.git",
+    "directory": "clients/blueprint-manifest-client"
+  },
+  "bugs": {
+    "url": "https://github.com/epilot-dev/sdk-js/issues"
+  },
+  "homepage": "https://github.com/epilot-dev/sdk-js/tree/main/clients/blueprint-manifest-client#readme",
+  "keywords": [
+    "blueprint",
+    "manifest",
+    "tf-blueprints",
+    "terraform"
+  ],
+  "scripts": {
+    "test": "jest",
+    "bundle-definition": "webpack",
+    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/blueprint-manifest.yaml",
+    "typegen": "echo '/* eslint-disable */' > src/openapi.d.ts && typegen ./src/openapi.json >> src/openapi.d.ts",
+    "build": "tsc && npm run bundle-definition",
+    "build:watch": "npm run build && tsc -w",
+    "prepublishOnly": "npm run typegen && npm run build",
+    "lint": "../../node_modules/eslint/bin/eslint.js src"
+  },
+  "files": [
+    "*.js",
+    "*.d.ts",
+    "**/*.js",
+    "**/*.d.ts",
+    "**/*.json",
+    "!*.test.*",
+    "!**/*.test.*",
+    "!node_modules",
+    "!src",
+    "!src/**",
+    "!*.config.js"
+  ],
+  "peerDependencies": {
+    "axios": "^1.6.2"
+  },
+  "dependencies": {
+    "@dazn/lambda-powertools-correlation-ids": "^1.28.1",
+    "buffer": "^6.0.3",
+    "https-browserify": "^1.0.0",
+    "openapi-client-axios": "^7.5.1",
+    "stream-http": "^3.1.1",
+    "url": "^0.11.0",
+    "util": "^0.12.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^26.0.20",
+    "axios": "^1.6.2",
+    "copy-webpack-plugin": "^7.0.0",
+    "jest": "^26.6.3",
+    "json-loader": "^0.5.7",
+    "openapi-client-axios-typegen": "^7.4.1",
+    "openapicmd": "^2.1.0",
+    "ts-jest": "^26.5.0",
+    "ts-loader": "^8.0.14",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.1.3",
+    "webpack": "^5.18.0",
+    "webpack-cli": "^4.4.0"
+  },
+  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "target": "es5",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "lib": ["esnext", "dom"],
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "esModuleInterop": true,
+    "noImplicitAny": true,
+    "strictPropertyInitialization": false,
+    "strictNullChecks": false,
+    "resolveJsonModule": true,
+    "baseUrl": ".",
+    "rootDir": "src",
+    "outDir": "dist",
+    "sourceMap": true,
+    "declaration": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["**/*.test.ts"]
+}