@ordercloud/oc-codegen
Version:
OpenAPI codegen tool built for the OrderCloud API
303 lines (302 loc) • 17.1 kB
JavaScript
;
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 __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);
};
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 (g && (g = 0, op[0] && (_ = 0)), _) 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 __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var swagger_parser_1 = __importDefault(require("swagger-parser"));
var templateDataFormatter_1 = __importDefault(require("./formatters/templateDataFormatter"));
var handlebars_1 = __importDefault(require("handlebars"));
var fs_extra_1 = __importDefault(require("fs-extra"));
var klaw_1 = __importDefault(require("klaw"));
var path_1 = __importDefault(require("path"));
__exportStar(require("./models"), exports);
function generate(options) {
return __awaiter(this, void 0, void 0, function () {
var spec, hooks, templateData, handlebarsExtensions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// Set default options
if (!options.output) {
options.output = process.cwd();
}
if (!options.inputSpec) {
options.inputSpec = 'https://api.ordercloud.io/v1/openapi/v3';
}
if (options.hooks) {
options.hooks = path_1.default.resolve(process.cwd(), options.hooks);
}
if (options.handlebarsExtensions) {
options.handlebarsExtensions = path_1.default.resolve(process.cwd(), options.handlebarsExtensions);
}
return [4 /*yield*/, tryGetParsedSpec(options.inputSpec || 'https://api.ordercloud.io/v1/openapi/v3')];
case 1:
spec = _a.sent();
hooks = options.hooks ? require(options.hooks) : {};
return [4 /*yield*/, templateDataFormatter_1.default.format(spec, hooks)];
case 2:
templateData = _a.sent();
// Output template data for debugging
if (options.debug) {
// tslint:disable-next-line: no-console
return [2 /*return*/, console.log(JSON.stringify(templateData, null, 4))];
}
// Register handlebars extensions
if (options.handlebarsExtensions) {
handlebarsExtensions = require(options.handlebarsExtensions);
handlebarsExtensions(handlebars_1.default);
}
// Pass template data to templates and write files
return [4 /*yield*/, generateDirectoryStructure(templateData, options)];
case 3:
// Pass template data to templates and write files
_a.sent();
return [2 /*return*/];
}
});
});
}
/**
* @ignore
* not part of public api, don't include in generated docs
*/
function tryGetParsedSpec(inputSpec) {
return __awaiter(this, void 0, void 0, function () {
var MAX_RETRIES, index, err_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
MAX_RETRIES = 3;
index = 1;
_a.label = 1;
case 1:
if (!(index <= MAX_RETRIES)) return [3 /*break*/, 7];
_a.label = 2;
case 2:
_a.trys.push([2, 5, , 6]);
return [4 /*yield*/, swagger_parser_1.default.parse(inputSpec)];
case 3: return [4 /*yield*/, _a.sent()];
case 4: return [2 /*return*/, (_a.sent())];
case 5:
err_1 = _a.sent();
if (index === MAX_RETRIES) {
console.error(err_1);
throw Error("Failed to parse spec after ".concat(MAX_RETRIES, " tries.\n Path to spec: ").concat(inputSpec));
}
return [3 /*break*/, 6];
case 6:
index++;
return [3 /*break*/, 1];
case 7: return [2 /*return*/];
}
});
});
}
/**
* @ignore
* not part of public api, don't include in generated docs
*/
function generateDirectoryStructure(templateData, options) {
return __awaiter(this, void 0, void 0, function () {
var _a;
var _this = this;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (!options.clean) return [3 /*break*/, 2];
return [4 /*yield*/, fs_extra_1.default.emptyDir(options.output)];
case 1:
_a = _b.sent();
return [3 /*break*/, 4];
case 2: return [4 /*yield*/, fs_extra_1.default.ensureDir(options.output)];
case 3:
_a = _b.sent();
_b.label = 4;
case 4:
_a;
return [2 /*return*/, new Promise(function (resolve, reject) {
var allPromises = [];
var walker = (0, klaw_1.default)(options.templates);
walker.on('data', function (file) { return __awaiter(_this, void 0, void 0, function () {
var name_1, promises, promises, promises;
var _this = this;
return __generator(this, function (_a) {
try {
if (file.stats.isDirectory()) {
// we're only interested in processing files
return [2 /*return*/];
}
name_1 = path_1.default.basename(file.path);
if (name_1.includes('_OPERATION_')) {
promises = templateData.operations.map(function (operation) { return __awaiter(_this, void 0, void 0, function () {
var context, writeFilePath;
return __generator(this, function (_a) {
context = __assign(__assign({}, templateData), { operation: operation });
writeFilePath = file.path.replace('_OPERATION_', operation.id);
return [2 /*return*/, generateFile(options.templates, options.output, context, file.path, writeFilePath)];
});
}); });
allPromises = __spreadArray(__spreadArray([], allPromises, true), promises, true);
}
else if (name_1.includes('_MODEL_')) {
promises = templateData.models.map(function (model) { return __awaiter(_this, void 0, void 0, function () {
var context, writeFilePath;
return __generator(this, function (_a) {
context = __assign(__assign({}, templateData), { model: model });
writeFilePath = file.path.replace('_MODEL_', model.name);
return [2 /*return*/, generateFile(options.templates, options.output, context, file.path, writeFilePath)];
});
}); });
allPromises = __spreadArray(__spreadArray([], allPromises, true), promises, true);
}
else if (name_1.includes('_RESOURCE_')) {
promises = templateData.resources.map(function (resource) { return __awaiter(_this, void 0, void 0, function () {
var context, writeFilePath;
return __generator(this, function (_a) {
context = __assign(__assign({}, templateData), { resource: resource });
writeFilePath = file.path.replace('_RESOURCE_', resource.id);
return [2 /*return*/, generateFile(options.templates, options.output, context, file.path, writeFilePath)];
});
}); });
allPromises = __spreadArray(__spreadArray([], allPromises, true), promises, true);
}
else {
// this file should only exist once
allPromises = __spreadArray(__spreadArray([], allPromises, true), [
generateFile(options.templates, options.output, templateData, file.path, file.path),
], false);
}
}
catch (e) {
return [2 /*return*/, reject(e)];
}
return [2 /*return*/];
});
}); });
walker.on('error', function (err) {
return reject(err);
});
walker.on('end', function () { return __awaiter(_this, void 0, void 0, function () {
var e_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, Promise.all(allPromises)];
case 1:
_a.sent();
return [2 /*return*/, resolve()];
case 2:
e_1 = _a.sent();
return [2 /*return*/, reject(e_1)];
case 3: return [2 /*return*/];
}
});
}); });
})];
}
});
});
}
/**
* @ignore
* not part of public api, don't include in generated docs
*/
function generateFile(templatesFolder, outputFolder, context, readFilePath, writeFilePath) {
return __awaiter(this, void 0, void 0, function () {
var templatePath, generatedPath, templateData, template, generatedContent;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
templatePath = path_1.default.relative(templatesFolder, writeFilePath.replace('.hbs', ''));
generatedPath = path_1.default.resolve(outputFolder, templatePath);
return [4 /*yield*/, fs_extra_1.default.readFile(readFilePath, 'utf-8').catch(function (e) {
throw Error("Unable to read file ".concat(readFilePath, "\nMessage: ").concat(e.message));
})];
case 1:
templateData = _a.sent();
template = handlebars_1.default.compile(templateData, { noEscape: true });
generatedContent = template(context);
return [4 /*yield*/, fs_extra_1.default.outputFile(generatedPath, generatedContent).catch(function (e) {
throw Error("Unable to write file ".concat(generatedPath, "\nMessage: ").concat(e.message));
})];
case 2:
_a.sent();
return [2 /*return*/];
}
});
});
}
exports.default = {
generate: generate,
};