@epilot/blueprint-manifest-client 3.4.0 → 3.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +34 -8
- package/dist/openapi.json +51 -8
- package/package.json +15 -14
- package/LICENSE +0 -21
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={
|
|
1
|
+
(()=>{"use strict";var e={914:function(e,t,r){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=n(r(240));t.default=s.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://blueprint-manifest.sls.epilot.io"}],"paths":{"/v1/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getJob","deprecated":true,"parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{}}},"/v1/blueprint-manifest/jobs:createExport":{"post":{"operationId":"createExport","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:exportManifest":{"post":{"operationId":"exportManifest","deprecated":true,"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","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:applyPlan":{"post":{"operationId":"applyPlan","deprecated":true,"parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/manifests":{"get":{"operationId":"listInstalledManifests","deprecated":true,"responses":{}}},"/v1/blueprint-manifest/manifests/{manifest_id}":{"get":{"operationId":"getManifest","deprecated":true,"parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}},"put":{"operationId":"updateManifest","deprecated":true,"parameters":[{"in":"path","required":true,"name":"manifest_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteManifest","deprecated":true,"parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints":{"get":{"operationId":"listBlueprints","responses":{}},"post":{"operationId":"createBlueprint","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints:pre-install":{"post":{"operationId":"preInstallBlueprint","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprint:install":{"post":{"operationId":"installBlueprint","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}":{"get":{"operationId":"getBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}},"put":{"operationId":"updateBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}:export":{"post":{"operationId":"exportBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources":{"post":{"operationId":"addBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies":{"post":{"operationId":"syncDependencies","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk":{"post":{"operationId":"bulkAddBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"put":{"operationId":"bulkUpdateBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"bulkDeleteBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}":{"put":{"operationId":"updateBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"responses":{}}},"/v2/blueprint-manifest/jobs":{"get":{"operationId":"listBlueprintJobs","responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getBlueprintJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}:continue":{"post":{"operationId":"continueInstallationJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}:cancel":{"post":{"operationId":"cancelBlueprintJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}}},"components":{"parameters":{"JobID":{"name":"job_id","in":"path","required":true}}}}')}},t={},r=function r(n){var s=t[n];if(void 0!==s)return s.exports;var i=t[n]={exports:{}};return e[n].call(i.exports,i,i.exports,r),i.exports}(914),n=exports;for(var s in r)n[s]=r[s];r.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -79,6 +79,24 @@ declare namespace Components {
|
|
|
79
79
|
resources?: BlueprintResource[];
|
|
80
80
|
}
|
|
81
81
|
export type Blueprint = CustomBlueprint | FileBlueprint | MarketplaceBlueprint | DeployedBlueprint | AppBlueprint;
|
|
82
|
+
export interface BlueprintDependenciesSyncJob {
|
|
83
|
+
id?: /**
|
|
84
|
+
* ID of a job
|
|
85
|
+
* example:
|
|
86
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
87
|
+
*/
|
|
88
|
+
BlueprintJobID;
|
|
89
|
+
events?: BlueprintJobEvent[];
|
|
90
|
+
triggered_at?: string; // date-time
|
|
91
|
+
created_by?: CallerIdentity;
|
|
92
|
+
blueprint_id?: /**
|
|
93
|
+
* ID of a blueprint
|
|
94
|
+
* example:
|
|
95
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
96
|
+
*/
|
|
97
|
+
BlueprintID;
|
|
98
|
+
status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED";
|
|
99
|
+
}
|
|
82
100
|
export interface BlueprintExportJob {
|
|
83
101
|
id?: /**
|
|
84
102
|
* ID of a job
|
|
@@ -139,7 +157,7 @@ declare namespace Components {
|
|
|
139
157
|
*/
|
|
140
158
|
resources_to_ignore?: string[];
|
|
141
159
|
}
|
|
142
|
-
export type BlueprintJob = BlueprintExportJob | BlueprintInstallationJob;
|
|
160
|
+
export type BlueprintJob = BlueprintExportJob | BlueprintInstallationJob | BlueprintDependenciesSyncJob;
|
|
143
161
|
export interface BlueprintJobEvent {
|
|
144
162
|
timestamp?: string; // date-time
|
|
145
163
|
message?: string;
|
|
@@ -1233,6 +1251,10 @@ declare namespace Components {
|
|
|
1233
1251
|
docs_url?: string;
|
|
1234
1252
|
source_type: "marketplace";
|
|
1235
1253
|
resources?: BlueprintResource[];
|
|
1254
|
+
/**
|
|
1255
|
+
* List of compatible app IDs for the blueprint
|
|
1256
|
+
*/
|
|
1257
|
+
compatible_apps?: string[];
|
|
1236
1258
|
}
|
|
1237
1259
|
export type PlanChanges = ("create" | "update" | "internal-update" | "no-op" | "delete")[];
|
|
1238
1260
|
/**
|
|
@@ -1310,7 +1332,7 @@ declare namespace Components {
|
|
|
1310
1332
|
/**
|
|
1311
1333
|
* Type of the resource
|
|
1312
1334
|
*/
|
|
1313
|
-
export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban";
|
|
1335
|
+
export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "erp_integration" | "erp_integration_use_case" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template";
|
|
1314
1336
|
export interface ResourceReplacement {
|
|
1315
1337
|
/**
|
|
1316
1338
|
* Original resource ID to be replaced
|
|
@@ -2018,8 +2040,13 @@ declare namespace Paths {
|
|
|
2018
2040
|
blueprint_id: Parameters.BlueprintId;
|
|
2019
2041
|
}
|
|
2020
2042
|
namespace Responses {
|
|
2021
|
-
export interface $
|
|
2022
|
-
|
|
2043
|
+
export interface $202 {
|
|
2044
|
+
job_id?: /**
|
|
2045
|
+
* ID of a job
|
|
2046
|
+
* example:
|
|
2047
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2048
|
+
*/
|
|
2049
|
+
Components.Schemas.BlueprintJobID;
|
|
2023
2050
|
}
|
|
2024
2051
|
}
|
|
2025
2052
|
}
|
|
@@ -2098,7 +2125,6 @@ declare namespace Paths {
|
|
|
2098
2125
|
}
|
|
2099
2126
|
}
|
|
2100
2127
|
|
|
2101
|
-
|
|
2102
2128
|
export interface OperationMethods {
|
|
2103
2129
|
/**
|
|
2104
2130
|
* getJob - getJob
|
|
@@ -2312,7 +2338,7 @@ export interface OperationMethods {
|
|
|
2312
2338
|
parameters?: Parameters<Paths.SyncDependencies.PathParameters> | null,
|
|
2313
2339
|
data?: any,
|
|
2314
2340
|
config?: AxiosRequestConfig
|
|
2315
|
-
): OperationResponse<Paths.SyncDependencies.Responses.$
|
|
2341
|
+
): OperationResponse<Paths.SyncDependencies.Responses.$202>
|
|
2316
2342
|
/**
|
|
2317
2343
|
* bulkUpdateBlueprintResources - bulkUpdateBlueprintResources
|
|
2318
2344
|
*
|
|
@@ -2647,7 +2673,7 @@ export interface PathsDictionary {
|
|
|
2647
2673
|
parameters?: Parameters<Paths.SyncDependencies.PathParameters> | null,
|
|
2648
2674
|
data?: any,
|
|
2649
2675
|
config?: AxiosRequestConfig
|
|
2650
|
-
): OperationResponse<Paths.SyncDependencies.Responses.$
|
|
2676
|
+
): OperationResponse<Paths.SyncDependencies.Responses.$202>
|
|
2651
2677
|
}
|
|
2652
2678
|
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk']: {
|
|
2653
2679
|
/**
|
|
@@ -2755,9 +2781,9 @@ export interface PathsDictionary {
|
|
|
2755
2781
|
|
|
2756
2782
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2757
2783
|
|
|
2758
|
-
|
|
2759
2784
|
export type AppBlueprint = Components.Schemas.AppBlueprint;
|
|
2760
2785
|
export type Blueprint = Components.Schemas.Blueprint;
|
|
2786
|
+
export type BlueprintDependenciesSyncJob = Components.Schemas.BlueprintDependenciesSyncJob;
|
|
2761
2787
|
export type BlueprintExportJob = Components.Schemas.BlueprintExportJob;
|
|
2762
2788
|
export type BlueprintID = Components.Schemas.BlueprintID;
|
|
2763
2789
|
export type BlueprintInstallStatus = Components.Schemas.BlueprintInstallStatus;
|
package/dist/openapi.json
CHANGED
|
@@ -1130,18 +1130,23 @@
|
|
|
1130
1130
|
}
|
|
1131
1131
|
],
|
|
1132
1132
|
"responses": {
|
|
1133
|
-
"
|
|
1134
|
-
"description": "
|
|
1133
|
+
"202": {
|
|
1134
|
+
"description": "Dependencies sync job started",
|
|
1135
|
+
"headers": {
|
|
1136
|
+
"Location": {
|
|
1137
|
+
"description": "URL to poll the job",
|
|
1138
|
+
"schema": {
|
|
1139
|
+
"type": "string"
|
|
1140
|
+
}
|
|
1141
|
+
}
|
|
1142
|
+
},
|
|
1135
1143
|
"content": {
|
|
1136
1144
|
"application/json": {
|
|
1137
1145
|
"schema": {
|
|
1138
1146
|
"type": "object",
|
|
1139
1147
|
"properties": {
|
|
1140
|
-
"
|
|
1141
|
-
"
|
|
1142
|
-
"items": {
|
|
1143
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
1144
|
-
}
|
|
1148
|
+
"job_id": {
|
|
1149
|
+
"$ref": "#/components/schemas/BlueprintJobID"
|
|
1145
1150
|
}
|
|
1146
1151
|
}
|
|
1147
1152
|
}
|
|
@@ -1802,6 +1807,13 @@
|
|
|
1802
1807
|
"items": {
|
|
1803
1808
|
"$ref": "#/components/schemas/BlueprintResource"
|
|
1804
1809
|
}
|
|
1810
|
+
},
|
|
1811
|
+
"compatible_apps": {
|
|
1812
|
+
"type": "array",
|
|
1813
|
+
"items": {
|
|
1814
|
+
"type": "string"
|
|
1815
|
+
},
|
|
1816
|
+
"description": "List of compatible app IDs for the blueprint"
|
|
1805
1817
|
}
|
|
1806
1818
|
}
|
|
1807
1819
|
}
|
|
@@ -1986,6 +1998,33 @@
|
|
|
1986
1998
|
},
|
|
1987
1999
|
{
|
|
1988
2000
|
"$ref": "#/components/schemas/BlueprintInstallationJob"
|
|
2001
|
+
},
|
|
2002
|
+
{
|
|
2003
|
+
"$ref": "#/components/schemas/BlueprintDependenciesSyncJob"
|
|
2004
|
+
}
|
|
2005
|
+
]
|
|
2006
|
+
},
|
|
2007
|
+
"BlueprintDependenciesSyncJob": {
|
|
2008
|
+
"allOf": [
|
|
2009
|
+
{
|
|
2010
|
+
"$ref": "#/components/schemas/CommonBlueprintJobFields"
|
|
2011
|
+
},
|
|
2012
|
+
{
|
|
2013
|
+
"type": "object",
|
|
2014
|
+
"properties": {
|
|
2015
|
+
"blueprint_id": {
|
|
2016
|
+
"$ref": "#/components/schemas/BlueprintID"
|
|
2017
|
+
},
|
|
2018
|
+
"status": {
|
|
2019
|
+
"type": "string",
|
|
2020
|
+
"enum": [
|
|
2021
|
+
"IN_PROGRESS",
|
|
2022
|
+
"SUCCESS",
|
|
2023
|
+
"FAILED",
|
|
2024
|
+
"CANCELED"
|
|
2025
|
+
]
|
|
2026
|
+
}
|
|
2027
|
+
}
|
|
1989
2028
|
}
|
|
1990
2029
|
]
|
|
1991
2030
|
},
|
|
@@ -2143,6 +2182,8 @@
|
|
|
2143
2182
|
"closing_reason",
|
|
2144
2183
|
"taxonomy_classification",
|
|
2145
2184
|
"webhook",
|
|
2185
|
+
"erp_integration",
|
|
2186
|
+
"erp_integration_use_case",
|
|
2146
2187
|
"dashboard",
|
|
2147
2188
|
"custom_variable",
|
|
2148
2189
|
"usergroup",
|
|
@@ -2151,7 +2192,9 @@
|
|
|
2151
2192
|
"role",
|
|
2152
2193
|
"portal_config",
|
|
2153
2194
|
"target",
|
|
2154
|
-
"kanban"
|
|
2195
|
+
"kanban",
|
|
2196
|
+
"validation_rule",
|
|
2197
|
+
"flow_template"
|
|
2155
2198
|
]
|
|
2156
2199
|
},
|
|
2157
2200
|
"PlanChanges": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/blueprint-manifest-client",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.5.1",
|
|
4
4
|
"description": "Client for epilot Terraform Blueprint Manifest API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -21,6 +21,18 @@
|
|
|
21
21
|
"manifest",
|
|
22
22
|
"terraform"
|
|
23
23
|
],
|
|
24
|
+
"scripts": {
|
|
25
|
+
"test": "jest",
|
|
26
|
+
"bundle-definition": "webpack",
|
|
27
|
+
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/blueprint-manifest.yaml",
|
|
28
|
+
"openapi:local": "node ../../scripts/update-openapi.js ../../../blueprint-manifest-api/lambda/TerraformHandlerFunction/openapi.yml",
|
|
29
|
+
"typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
|
|
30
|
+
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
31
|
+
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
32
|
+
"build:watch": "npm run build && tsc -w",
|
|
33
|
+
"prepublishOnly": "npm run typegen && npm run build",
|
|
34
|
+
"lint": "pnpm exec eslint src"
|
|
35
|
+
},
|
|
24
36
|
"files": [
|
|
25
37
|
"*.js",
|
|
26
38
|
"*.d.ts",
|
|
@@ -60,16 +72,5 @@
|
|
|
60
72
|
"webpack": "^5.18.0",
|
|
61
73
|
"webpack-cli": "^4.4.0"
|
|
62
74
|
},
|
|
63
|
-
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
64
|
-
|
|
65
|
-
"test": "jest",
|
|
66
|
-
"bundle-definition": "webpack",
|
|
67
|
-
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/blueprint-manifest.yaml",
|
|
68
|
-
"openapi:local": "node ../../scripts/update-openapi.js ../../../blueprint-manifest-api/lambda/TerraformHandlerFunction/openapi.yml",
|
|
69
|
-
"typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
|
|
70
|
-
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
71
|
-
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
72
|
-
"build:watch": "npm run build && tsc -w",
|
|
73
|
-
"lint": "pnpm exec eslint src"
|
|
74
|
-
}
|
|
75
|
-
}
|
|
75
|
+
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
76
|
+
}
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
The MIT License (MIT)
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2025 epilot GmbH
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in
|
|
13
|
-
all copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
-
THE SOFTWARE.
|