node-tfe
Version:
A Typescript Client for Terraform Cloud/Enterprise V2 API
251 lines • 18.2 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Client = void 0;
var axios_1 = __importDefault(require("axios"));
var qs_1 = __importDefault(require("qs"));
var url_join_1 = __importDefault(require("url-join"));
var configurationVersions_1 = require("./endpoints/configurationVersions");
var runs_1 = require("./endpoints/runs");
var stateVersions_1 = require("./endpoints/stateVersions");
var tags_1 = require("./endpoints/tags");
var workspaces_1 = require("./endpoints/workspaces");
var Types_1 = require("./enums/Types");
var ResourceNotFoundError_1 = require("./errors/ResourceNotFoundError");
var UnauthorizedError_1 = require("./errors/UnauthorizedError");
var WorkspaceLockError_1 = require("./errors/WorkspaceLockError");
var userAgent = 'node-tfe',
// DefaultAddress of Terraform Enterprise.
DefaultAddress = 'https://app.terraform.io',
// DefaultBasePath on which the API is served.
DefaultBasePath = '/api/v2/';
var Client = /** @class */ (function () {
function Client(config) {
config.address =
config.address || process.env.TFE_ADDRESS || DefaultAddress;
config.basePath = config.basePath || DefaultBasePath;
config.token = config.token || process.env.TFE_TOKEN;
if (!config.token) {
throw new Error('missing API token');
}
this.baseURL = (0, url_join_1.default)(config.address, config.basePath);
this.token = config.token;
this.HTTPClient = axios_1.default.create({
baseURL: this.baseURL,
headers: {
Authorization: 'Bearer ' + this.token,
'User-Agent': userAgent,
},
paramsSerializer: function (params) {
return qs_1.default.stringify(params, { arrayFormat: 'brackets' });
},
});
// Add a response interceptor
this.HTTPClient.interceptors.response.use(function (response) {
return response;
}, function (error) {
var _a, _b, _c;
if (error.response) {
// The request was made and the server responded with a status code
// that falls out of the range of 2xx
if (((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 401) {
throw new UnauthorizedError_1.UnauthorizedError();
}
if (((_b = error.response) === null || _b === void 0 ? void 0 : _b.status) === 404) {
var type = void 0;
if (error.request.path.includes('/workspaces/')) {
type = Types_1.Types.workspace;
}
if (error.request.path.includes('/configuration-versions/')) {
type = Types_1.Types.configurationVersion;
}
if (error.request.path.includes('/runs/')) {
type = Types_1.Types.run;
}
if (error.request.path.includes('/current-state-version')) {
type = Types_1.Types.stateVersion;
}
if (error.request.path.includes('/tags')) {
type = Types_1.Types.tags;
}
throw new ResourceNotFoundError_1.ResourceNotFoundError(type);
}
if (((_c = error.response) === null || _c === void 0 ? void 0 : _c.status) === 409) {
throw new WorkspaceLockError_1.WorkspaceLockError();
}
throw new Error(JSON.stringify(error.response.data));
}
throw error;
});
// ADD endpoints
this.Workspaces = new workspaces_1.Workspaces(this);
this.ConfigurationVersions = new configurationVersions_1.ConfigurationVersions(this);
this.Runs = new runs_1.Runs(this);
this.StateVersions = new stateVersions_1.StateVersions(this);
this.Tags = new tags_1.OrganizationTags(this);
}
Client.prototype.get = function (path, params) {
return __awaiter(this, void 0, void 0, function () {
var config, response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = {
url: path,
headers: {
Authorization: 'Bearer ' + this.token,
Accept: 'application/vnd.api+json',
},
params: params || {},
};
return [4 /*yield*/, this.HTTPClient(config)];
case 1:
response = _a.sent();
// https://www.terraform.io/docs/cloud/api/index.html#json-api-documents
return [2 /*return*/, response.data];
}
});
});
};
Client.prototype.post = function (path, body) {
return __awaiter(this, void 0, void 0, function () {
var config, response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = {
method: 'post',
url: path,
headers: {
Authorization: 'Bearer ' + this.token,
Accept: 'application/vnd.api+json',
'Content-Type': 'application/vnd.api+json',
},
data: body,
};
return [4 /*yield*/, this.HTTPClient(config)];
case 1:
response = _a.sent();
// https://www.terraform.io/docs/cloud/api/index.html#json-api-documents
return [2 /*return*/, response.data];
}
});
});
};
Client.prototype.put = function (path, body) {
return __awaiter(this, void 0, void 0, function () {
var config, response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = {
method: 'put',
url: path,
headers: {
Authorization: 'Bearer ' + this.token,
Accept: 'application/vnd.api+json',
'Content-Type': 'application/octet-stream',
},
data: body,
};
return [4 /*yield*/, this.HTTPClient(config)];
case 1:
response = _a.sent();
// https://www.terraform.io/docs/cloud/api/index.html#json-api-documents
return [2 /*return*/, response.data];
}
});
});
};
Client.prototype.patch = function (path, body) {
return __awaiter(this, void 0, void 0, function () {
var config, response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = {
method: 'patch',
url: path,
headers: {
Authorization: 'Bearer ' + this.token,
Accept: 'application/vnd.api+json',
'Content-Type': 'application/vnd.api+json',
},
data: body || {},
};
return [4 /*yield*/, this.HTTPClient(config)];
case 1:
response = _a.sent();
// https://www.terraform.io/docs/cloud/api/index.html#json-api-documents
return [2 /*return*/, response.data];
}
});
});
};
Client.prototype.delete = function (path, body) {
return __awaiter(this, void 0, void 0, function () {
var config, response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
config = {
method: 'delete',
url: path,
headers: {
Authorization: 'Bearer ' + this.token,
Accept: 'application/vnd.api+json',
'Content-Type': 'application/vnd.api+json',
},
data: body
};
return [4 /*yield*/, this.HTTPClient(config)];
case 1:
response = _a.sent();
// https://www.terraform.io/docs/cloud/api/index.html#json-api-documents
return [2 /*return*/, response.data];
}
});
});
};
return Client;
}());
exports.Client = Client;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGZlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL3RmZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSxnREFBeUQ7QUFDekQsMENBQW9CO0FBRXBCLHNEQUErQjtBQUMvQiwyRUFBMEU7QUFDMUUseUNBQXdDO0FBQ3hDLDJEQUEwRDtBQUMxRCx5Q0FBb0Q7QUFDcEQscURBQW9EO0FBQ3BELHVDQUFzQztBQUN0Qyx3RUFBdUU7QUFDdkUsZ0VBQStEO0FBQy9ELGtFQUFpRTtBQUlqRSxJQUFNLFNBQVMsR0FBRyxVQUFVO0FBQzFCLDBDQUEwQztBQUMxQyxjQUFjLEdBQUcsMEJBQTBCO0FBQzNDLDhDQUE4QztBQUM5QyxlQUFlLEdBQUcsVUFBVSxDQUFDO0FBRS9CO0lBVUUsZ0JBQVksTUFBYztRQUN4QixNQUFNLENBQUMsT0FBTztZQUNaLE1BQU0sQ0FBQyxPQUFPLElBQUksT0FBTyxDQUFDLEdBQUcsQ0FBQyxXQUFXLElBQUksY0FBYyxDQUFDO1FBQzlELE1BQU0sQ0FBQyxRQUFRLEdBQUcsTUFBTSxDQUFDLFFBQVEsSUFBSSxlQUFlLENBQUM7UUFDckQsTUFBTSxDQUFDLEtBQUssR0FBRyxNQUFNLENBQUMsS0FBSyxJQUFLLE9BQU8sQ0FBQyxHQUFHLENBQUMsU0FBb0IsQ0FBQztRQUVqRSxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssRUFBRTtZQUNqQixNQUFNLElBQUksS0FBSyxDQUFDLG1CQUFtQixDQUFDLENBQUM7U0FDdEM7UUFFRCxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUEsa0JBQU8sRUFBQyxNQUFNLENBQUMsT0FBTyxFQUFFLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUN4RCxJQUFJLENBQUMsS0FBSyxHQUFHLE1BQU0sQ0FBQyxLQUFLLENBQUM7UUFDMUIsSUFBSSxDQUFDLFVBQVUsR0FBRyxlQUFLLENBQUMsTUFBTSxDQUFDO1lBQzdCLE9BQU8sRUFBRSxJQUFJLENBQUMsT0FBTztZQUNyQixPQUFPLEVBQUU7Z0JBQ1AsYUFBYSxFQUFFLFNBQVMsR0FBRyxJQUFJLENBQUMsS0FBSztnQkFDckMsWUFBWSxFQUFFLFNBQVM7YUFDeEI7WUFDRCxnQkFBZ0IsRUFBRSxVQUFVLE1BQU07Z0JBQ2hDLE9BQU8sWUFBRSxDQUFDLFNBQVMsQ0FBQyxNQUFNLEVBQUUsRUFBRSxXQUFXLEVBQUUsVUFBVSxFQUFFLENBQUMsQ0FBQztZQUMzRCxDQUFDO1NBQ0YsQ0FBQyxDQUFDO1FBRUgsNkJBQTZCO1FBQzdCLElBQUksQ0FBQyxVQUFVLENBQUMsWUFBWSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQ3ZDLFVBQVUsUUFBUTtZQUNoQixPQUFPLFFBQVEsQ0FBQztRQUNsQixDQUFDLEVBQ0QsVUFBVSxLQUFpQjs7WUFDekIsSUFBSSxLQUFLLENBQUMsUUFBUSxFQUFFO2dCQUNsQixtRUFBbUU7Z0JBQ25FLHFDQUFxQztnQkFDckMsSUFBSSxDQUFBLE1BQUEsS0FBSyxDQUFDLFFBQVEsMENBQUUsTUFBTSxNQUFLLEdBQUcsRUFBRTtvQkFDbEMsTUFBTSxJQUFJLHFDQUFpQixFQUFFLENBQUM7aUJBQy9CO2dCQUNELElBQUksQ0FBQSxNQUFBLEtBQUssQ0FBQyxRQUFRLDBDQUFFLE1BQU0sTUFBSyxHQUFHLEVBQUU7b0JBQ2xDLElBQUksSUFBSSxTQUFBLENBQUM7b0JBRVQsSUFBSSxLQUFLLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsY0FBYyxDQUFDLEVBQUU7d0JBQy9DLElBQUksR0FBRyxhQUFLLENBQUMsU0FBUyxDQUFDO3FCQUN4QjtvQkFDRCxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQywwQkFBMEIsQ0FBQyxFQUFFO3dCQUMzRCxJQUFJLEdBQUcsYUFBSyxDQUFDLG9CQUFvQixDQUFDO3FCQUNuQztvQkFDRCxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsRUFBRTt3QkFDekMsSUFBSSxHQUFHLGFBQUssQ0FBQyxHQUFHLENBQUM7cUJBQ2xCO29CQUNELElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLHdCQUF3QixDQUFDLEVBQUU7d0JBQ3pELElBQUksR0FBRyxhQUFLLENBQUMsWUFBWSxDQUFDO3FCQUMzQjtvQkFDRCxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsRUFBRTt3QkFDeEMsSUFBSSxHQUFHLGFBQUssQ0FBQyxJQUFJLENBQUM7cUJBQ25CO29CQUNELE1BQU0sSUFBSSw2Q0FBcUIsQ0FBQyxJQUFJLENBQUMsQ0FBQztpQkFDdkM7Z0JBQ0QsSUFBSSxDQUFBLE1BQUEsS0FBSyxDQUFDLFFBQVEsMENBQUUsTUFBTSxNQUFLLEdBQUcsRUFBRTtvQkFDbEMsTUFBTSxJQUFJLHVDQUFrQixFQUFFLENBQUM7aUJBQ2hDO2dCQUNELE1BQU0sSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7YUFDdEQ7WUFDRCxNQUFNLEtBQUssQ0FBQztRQUNkLENBQUMsQ0FDRixDQUFDO1FBRUYsZ0JBQWdCO1FBQ2hCLElBQUksQ0FBQyxVQUFVLEdBQUcsSUFBSSx1QkFBVSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3ZDLElBQUksQ0FBQyxxQkFBcUIsR0FBRyxJQUFJLDZDQUFxQixDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzdELElBQUksQ0FBQyxJQUFJLEdBQUcsSUFBSSxXQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDM0IsSUFBSSxDQUFDLGFBQWEsR0FBRyxJQUFJLDZCQUFhLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDN0MsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLHVCQUFnQixDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3pDLENBQUM7SUFFSyxvQkFBRyxHQUFULFVBQVUsSUFBWSxFQUFFLE1BQVk7Ozs7Ozt3QkFDNUIsTUFBTSxHQUFHOzRCQUNiLEdBQUcsRUFBRSxJQUFJOzRCQUNULE9BQU8sRUFBRTtnQ0FDUCxhQUFhLEVBQUUsU0FBUyxHQUFHLElBQUksQ0FBQyxLQUFLO2dDQUNyQyxNQUFNLEVBQUUsMEJBQTBCOzZCQUNuQzs0QkFDRCxNQUFNLEVBQUUsTUFBTSxJQUFJLEVBQUU7eUJBQ3JCLENBQUM7d0JBRWUscUJBQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsRUFBQTs7d0JBQXhDLFFBQVEsR0FBRyxTQUE2Qjt3QkFFOUMsd0VBQXdFO3dCQUN4RSxzQkFBTyxRQUFRLENBQUMsSUFBSSxFQUFDOzs7O0tBQ3RCO0lBRUsscUJBQUksR0FBVixVQUFXLElBQVksRUFBRSxJQUFVOzs7Ozs7d0JBQzNCLE1BQU0sR0FBRzs0QkFDYixNQUFNLEVBQUUsTUFBZTs0QkFDdkIsR0FBRyxFQUFFLElBQUk7NEJBQ1QsT0FBTyxFQUFFO2dDQUNQLGFBQWEsRUFBRSxTQUFTLEdBQUcsSUFBSSxDQUFDLEtBQUs7Z0NBQ3JDLE1BQU0sRUFBRSwwQkFBMEI7Z0NBQ2xDLGNBQWMsRUFBRSwwQkFBMEI7NkJBQzNDOzRCQUNELElBQUksRUFBRSxJQUFJO3lCQUNYLENBQUM7d0JBRWUscUJBQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsRUFBQTs7d0JBQXhDLFFBQVEsR0FBRyxTQUE2Qjt3QkFFOUMsd0VBQXdFO3dCQUN4RSxzQkFBTyxRQUFRLENBQUMsSUFBSSxFQUFDOzs7O0tBQ3RCO0lBRUssb0JBQUcsR0FBVCxVQUFVLElBQVksRUFBRSxJQUF1Qjs7Ozs7O3dCQUN2QyxNQUFNLEdBQUc7NEJBQ2IsTUFBTSxFQUFFLEtBQWM7NEJBQ3RCLEdBQUcsRUFBRSxJQUFJOzRCQUNULE9BQU8sRUFBRTtnQ0FDUCxhQUFhLEVBQUUsU0FBUyxHQUFHLElBQUksQ0FBQyxLQUFLO2dDQUNyQyxNQUFNLEVBQUUsMEJBQTBCO2dDQUNsQyxjQUFjLEVBQUUsMEJBQTBCOzZCQUMzQzs0QkFDRCxJQUFJLEVBQUUsSUFBSTt5QkFDWCxDQUFDO3dCQUVlLHFCQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLEVBQUE7O3dCQUF4QyxRQUFRLEdBQUcsU0FBNkI7d0JBRTlDLHdFQUF3RTt3QkFDeEUsc0JBQU8sUUFBUSxDQUFDLElBQUksRUFBQzs7OztLQUN0QjtJQUVLLHNCQUFLLEdBQVgsVUFBWSxJQUFZLEVBQUUsSUFBVTs7Ozs7O3dCQUM1QixNQUFNLEdBQUc7NEJBQ2IsTUFBTSxFQUFFLE9BQWdCOzRCQUN4QixHQUFHLEVBQUUsSUFBSTs0QkFDVCxPQUFPLEVBQUU7Z0NBQ1AsYUFBYSxFQUFFLFNBQVMsR0FBRyxJQUFJLENBQUMsS0FBSztnQ0FDckMsTUFBTSxFQUFFLDBCQUEwQjtnQ0FDbEMsY0FBYyxFQUFFLDBCQUEwQjs2QkFDM0M7NEJBQ0QsSUFBSSxFQUFFLElBQUksSUFBSSxFQUFFO3lCQUNqQixDQUFDO3dCQUVlLHFCQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLEVBQUE7O3dCQUF4QyxRQUFRLEdBQUcsU0FBNkI7d0JBRTlDLHdFQUF3RTt3QkFDeEUsc0JBQU8sUUFBUSxDQUFDLElBQUksRUFBQzs7OztLQUN0QjtJQUVLLHVCQUFNLEdBQVosVUFBYSxJQUFZLEVBQUUsSUFBVTs7Ozs7O3dCQUM3QixNQUFNLEdBQUc7NEJBQ2IsTUFBTSxFQUFFLFFBQWlCOzRCQUN6QixHQUFHLEVBQUUsSUFBSTs0QkFDVCxPQUFPLEVBQUU7Z0NBQ1AsYUFBYSxFQUFFLFNBQVMsR0FBRyxJQUFJLENBQUMsS0FBSztnQ0FDckMsTUFBTSxFQUFFLDBCQUEwQjtnQ0FDbEMsY0FBYyxFQUFFLDBCQUEwQjs2QkFDM0M7NEJBQ0QsSUFBSSxFQUFFLElBQUk7eUJBQ1gsQ0FBQzt3QkFDZSxxQkFBTSxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxFQUFBOzt3QkFBeEMsUUFBUSxHQUFHLFNBQTZCO3dCQUM5Qyx3RUFBd0U7d0JBQ3hFLHNCQUFPLFFBQVEsQ0FBQyxJQUFJLEVBQUM7Ozs7S0FDdEI7SUFDSCxhQUFDO0FBQUQsQ0FBQyxBQXZLRCxJQXVLQztBQXZLWSx3QkFBTSJ9