@epilot/blueprint-manifest-client 2.3.0 → 2.3.1

package/dist/openapi.json

@@ -16,7 +16,11 @@
     },
     {
       "name": "Import",
-      "description": "Import a Blueprint Manifest"
+      "description": "Install or update a Blueprint Manifest"
+    },
+    {
+      "name": "Manifests",
+      "description": "Manage installed Manifests"
     }
   ],
   "security": [
@@ -64,7 +68,7 @@
       "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",
+        "description": "Creates a new Export Job with a list of available resources to export from the passed root resource.\n\nMultiple root resources can be added by calling this multiple times with the same jobId\n",
         "tags": [
           "Export"
         ],
@@ -75,25 +79,7 @@
                 "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"
-                    ]
+                    "$ref": "#/components/schemas/ResourceNodeType"
                   },
                   "resourceIds": {
                     "type": "array",
@@ -103,12 +89,12 @@
                     "minItems": 1,
                     "maxItems": 25
                   },
+                  "jobId": {
+                    "$ref": "#/components/schemas/JobID"
+                  },
                   "isExportingMultipleResources": {
                     "type": "boolean",
                     "description": "Temporary flag to indicate if multiple resources are being exported"
-                  },
-                  "jobId": {
-                    "type": "string"
                   }
                 }
               }
@@ -237,7 +223,7 @@
       "post": {
         "operationId": "createPlan",
         "summary": "createPlan",
-        "description": "Creates a new import job from an uploaded manifest file and returns the plan",
+        "description": "Creates a new import job from an uploaded manifest file and returns the plan.\n\nCreates an updated plan for an installed manifest when `manifest_id` is passed\n",
         "tags": [
           "Import"
         ],
@@ -245,14 +231,50 @@
           "content": {
             "application/json": {
               "schema": {
-                "type": "object",
-                "properties": {
-                  "manifestFilePath": {
-                    "description": "Path to the manifest file uploaded via `uploadManifest`",
-                    "type": "string",
-                    "example": "example.tf"
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "s3ref": {
+                        "allOf": [
+                          {
+                            "description": "s3ref of manifest file uploaded via `uploadManifest`"
+                          },
+                          {
+                            "$ref": "#/components/schemas/S3Reference"
+                          }
+                        ]
+                      },
+                      "manifest_id": {
+                        "allOf": [
+                          {
+                            "description": "Update an existing manifest (optional)"
+                          },
+                          {
+                            "$ref": "#/components/schemas/ManifestID"
+                          }
+                        ]
+                      }
+                    },
+                    "required": [
+                      "s3ref"
+                    ]
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "manifestFilePath": {
+                        "deprecated": true,
+                        "description": "Manifest file key uploaded via `uploadManifest`",
+                        "type": "string",
+                        "example": "example.tf"
+                      }
+                    },
+                    "required": [
+                      "manifestFilePath"
+                    ]
                   }
-                }
+                ]
               }
             }
           }
@@ -281,7 +303,7 @@
       "post": {
         "operationId": "applyPlan",
         "summary": "applyPlan",
-        "description": "Apply a plan returned by `createPlan`",
+        "description": "Apply a plan returned by `createPlan`.",
         "tags": [
           "Import"
         ],
@@ -307,11 +329,112 @@
         },
         "responses": {
           "200": {
-            "description": "Success",
+            "description": "Applied Import Job ID",
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "string"
+                  "type": "object",
+                  "properties": {
+                    "jobId": {
+                      "$ref": "#/components/schemas/JobID"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/blueprint-manifest/manifests": {
+      "get": {
+        "operationId": "listInstalledManifests",
+        "summary": "listInstalledManifests",
+        "description": "List Blueprint Manifests installed to the organization",
+        "tags": [
+          "Manifests"
+        ],
+        "responses": {
+          "200": {
+            "description": "Installed Blueprint Manifests in the organization",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "total": {
+                      "type": "integer",
+                      "example": 1
+                    },
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/ManifestItem"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/blueprint-manifest/manifests/{manifest_id}": {
+      "get": {
+        "operationId": "getManifest",
+        "summary": "getManifest",
+        "description": "Get installed Manifest by ID",
+        "tags": [
+          "Manifests"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "required": true,
+            "name": "manifest_id",
+            "schema": {
+              "$ref": "#/components/schemas/ManifestID"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Installed Blueprint Manifest in the Organization",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Manifest"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteManifest",
+        "summary": "deleteManifest",
+        "description": "Remove installed manifest from the org\n\nNote that this does not delete the installed resources of the Manifest!\n",
+        "tags": [
+          "Manifests"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "required": true,
+            "name": "manifest_id",
+            "schema": {
+              "$ref": "#/components/schemas/ManifestID"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The deleted Manifest",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Manifest"
                 }
               }
             }
@@ -322,6 +445,42 @@
   },
   "components": {
     "schemas": {
+      "ManifestID": {
+        "type": "string",
+        "description": "ID of an imported / installed manifest",
+        "example": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"
+      },
+      "JobID": {
+        "type": "string",
+        "description": "ID of an import or export job (state machine)",
+        "example": "4854bb2a-94f9-424d-a968-3fb17fb0bf89"
+      },
+      "Manifest": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CommonManifestFields"
+          },
+          {
+            "$ref": "#/components/schemas/CommonMarkdownFields"
+          },
+          {
+            "$ref": "#/components/schemas/CommonImportFields"
+          },
+          {
+            "$ref": "#/components/schemas/ManifestTimestampFields"
+          }
+        ]
+      },
+      "ManifestItem": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CommonManifestFields"
+          },
+          {
+            "$ref": "#/components/schemas/ManifestTimestampFields"
+          }
+        ]
+      },
       "JobStatus": {
         "type": "string",
         "enum": [
@@ -351,7 +510,8 @@
           "schema_group",
           "workflow_definition",
           "closing_reason",
-          "taxonomy_classification"
+          "taxonomy_classification",
+          "webhook"
         ]
       },
       "RootResourceNode": {
@@ -473,67 +633,148 @@
           "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"
+        "allOf": [
+          {
+            "type": "object",
+            "properties": {
+              "job_id": {
+                "$ref": "#/components/schemas/JobID"
+              },
+              "job_status": {
+                "$ref": "#/components/schemas/JobStatus"
+              },
+              "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/RootResourceNode"
+                    }
+                  },
+                  {
+                    "$ref": "#/components/schemas/RootResourceNode"
+                  }
+                ]
+              },
+              "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/RootResourceNode"
+                    }
+                  },
+                  {
+                    "$ref": "#/components/schemas/RootResourceNode"
+                  }
+                ]
+              },
+              "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"
+              }
+            }
           },
-          "job_id": {
-            "$ref": "#/components/schemas/JobID"
+          {
+            "$ref": "#/components/schemas/CommonImportFields"
           },
-          "message": {
-            "type": "string"
+          {
+            "$ref": "#/components/schemas/CommonMarkdownFields"
           },
-          "timestamp": {
+          {
+            "$ref": "#/components/schemas/CommonManifestFields"
+          }
+        ]
+      },
+      "UploadFilePayload": {
+        "type": "object",
+        "properties": {
+          "filename": {
             "type": "string",
-            "format": "date-time"
+            "example": "main.tf"
           },
-          "plan_file_content": {
+          "mime_type": {
+            "description": "MIME type of file",
             "type": "string",
-            "description": "An URL to download the plan file"
+            "example": "application/pdf",
+            "default": "application/octet-stream"
+          }
+        },
+        "required": [
+          "filename"
+        ]
+      },
+      "S3Reference": {
+        "type": "object",
+        "properties": {
+          "bucket": {
+            "type": "string",
+            "example": "blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw"
           },
-          "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/RootResourceNode"
-                }
-              },
-              {
-                "$ref": "#/components/schemas/RootResourceNode"
-              }
-            ]
+          "key": {
+            "type": "string",
+            "example": "templates/main.tf"
+          }
+        }
+      },
+      "CommonManifestFields": {
+        "type": "object",
+        "properties": {
+          "manifest_id": {
+            "$ref": "#/components/schemas/ManifestID"
           },
-          "large_resources_to_export_url": {
+          "source_blueprint_name": {
             "type": "string",
-            "description": "An URL to download the resources to export when the resources are too large to be included in the response"
+            "example": "Solar B2B"
           },
-          "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/RootResourceNode"
-                }
-              },
-              {
-                "$ref": "#/components/schemas/RootResourceNode"
-              }
-            ]
+          "source_blueprint_slug": {
+            "type": "string",
+            "description": "URL slug of a blueprint from the epilot marketplace",
+            "example": "solar-b2b"
           },
-          "large_resources_to_import_url": {
+          "source_blueprint_version": {
+            "type": "string",
+            "description": "Version of the blueprint (semver)",
+            "example": "1.0.0"
+          }
+        }
+      },
+      "ManifestTimestampFields": {
+        "type": "object",
+        "properties": {
+          "created_at": {
+            "description": "When the manifest was first installed (applied)",
             "type": "string",
-            "description": "An URL to download the resources to import when the resources are too large to be included in the response"
+            "format": "date-time"
           },
+          "updated_at": {
+            "description": "When the manifest was last updated (applied)",
+            "type": "string",
+            "format": "date-time"
+          }
+        }
+      },
+      "CommonImportFields": {
+        "type": "object",
+        "properties": {
           "imported_resources": {
             "description": "An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import",
             "oneOf": [
@@ -550,13 +791,27 @@
           },
           "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"
-          },
+            "format": "uri",
+            "description": "An URL to download the imported resources when the resources are too large to be included in the response",
+            "example": "https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json"
+          }
+        }
+      },
+      "CommonMarkdownFields": {
+        "type": "object",
+        "properties": {
           "markdown": {
             "type": "object",
+            "description": "Markdown content part of a manifest file",
             "properties": {
+              "manifest": {
+                "type": "string",
+                "description": "Markdown content shown before installing the manifest",
+                "example": "This is the content of the manifest.md file which contains the manifest descripton.       \n"
+              },
               "preinstall": {
                 "type": "string",
+                "deprecated": true,
                 "description": "Markdown content to be displayed when showing the plan to install blueprint",
                 "example": "This is the content of the preinstall.md file\n"
               },
@@ -568,37 +823,6 @@
             }
           }
         }
-      },
-      "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": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/blueprint-manifest-client",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "Client for epilot Terraform Blueprint Manifest API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,6 @@
   "keywords": [
     "blueprint",
     "manifest",
-    "tf-blueprints",
     "terraform"
   ],
   "scripts": {
@@ -27,7 +26,8 @@
     "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/blueprint-manifest.yaml",
     "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprint-manifest-api/lambda/TerraformHandlerFunction/openapi.yml",
     "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
-    "build": "tsc && npm run bundle-definition",
+    "build": "tsc && npm run build:patch && npm run bundle-definition",
+    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
     "build:watch": "npm run build && tsc -w",
     "prepublishOnly": "npm run typegen && npm run build",
     "lint": "../../node_modules/eslint/bin/eslint.js src"
@@ -71,5 +71,5 @@
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"
   },
-  "gitHead": "6c12dc4aaf7ddf60ad11c6f596fb478559fa3052"
+  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 epilot GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.