@ordercloud/oc-codegen
Version:
OpenAPI codegen tool built for the OrderCloud API
329 lines (328 loc) • 17.3 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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
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 _ = __importStar(require("lodash"));
var utility_1 = __importDefault(require("../utility"));
/**
* @ignore
* not part of public api, don't include in generated docs
*/
var OperationService = /** @class */ (function () {
function OperationService() {
}
OperationService.prototype.formatOperations = function (spec, hooks) {
return __awaiter(this, void 0, void 0, function () {
var operationInputs, operations, boolArray_1;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
operationInputs = _.flatten(_.values(_.mapValues(spec.paths, function (ops, path) {
var operations = _.omit(ops, 'parameters');
return _.values(_.mapValues(operations, function (o, verb) { return ({
operation: __assign(__assign({}, o), { parameters: __spreadArray(__spreadArray([], (o.parameters || []), true), (ops.parameters || []), true) }),
path: path,
verb: verb,
}); }));
})));
return [4 /*yield*/, Promise.all(operationInputs.map(function (_a) {
var operation = _a.operation, path = _a.path, verb = _a.verb;
return typeof hooks.formatOperation === 'function'
? hooks.formatOperation(operation, path, verb, spec)
: _this.formatOperation(operation, path, verb, spec);
}))];
case 1:
operations = _a.sent();
if (!(typeof hooks.filterOperations === 'function')) return [3 /*break*/, 3];
return [4 /*yield*/, Promise.all(operations.map(function (operation) {
return hooks.filterOperations(operation, operations, spec);
}))];
case 2:
boolArray_1 = _a.sent();
operations = operations.filter(function () { return boolArray_1.shift(); });
_a.label = 3;
case 3:
if (!(typeof hooks.postFormatOperation === 'function')) return [3 /*break*/, 5];
return [4 /*yield*/, Promise.all(operations.map(function (o) {
return hooks.postFormatOperation(o, operations, spec);
}))];
case 4:
operations = _a.sent();
_a.label = 5;
case 5: return [2 /*return*/, operations];
}
});
});
};
OperationService.prototype.formatOperation = function (operation, path, verb, spec) {
var _this = this;
var allParams = (operation.parameters || []).map(function (p) {
return _this.formatParam(p, spec);
});
var bodyParam = this.getBodyParam(operation.requestBody);
if (bodyParam) {
allParams = __spreadArray(__spreadArray([], allParams, true), [bodyParam], false);
}
var returnType = this.getReturnType(operation.responses);
var fileImports = _.uniq(_.compact(__spreadArray([
bodyParam && bodyParam.type,
returnType
], allParams.filter(function (p) { return p.isCustomType; }).map(function (p) { return p.type; }), true)));
var queryParams = allParams.filter(function (p) { return p.isQueryParam; });
var pathParams = allParams.filter(function (p) { return p.isPathParam; });
var operationName = operation.operationId.split('.')[1];
var o = {
id: operation.operationId,
name: operationName,
summary: operation.summary,
description: operation.description,
path: path,
verb: verb,
fileImports: fileImports,
resourceName: operation.tags[0],
resourceID: utility_1.default.makePascalCase(operation.tags[0]),
hasSummary: Boolean(operation.summary && operation.summary.length),
hasDescription: Boolean(operation.description && operation.description.length),
hasParams: allParams.length > 0,
hasQueryParams: queryParams.length > 0,
hasPathParams: pathParams.length > 0,
hasBodyParam: Boolean(bodyParam),
hasReturnType: Boolean(returnType),
hasFilters: Boolean(allParams.filter(function (p) { return p.name === 'filters'; }).length),
bodyParam: bodyParam,
returnType: returnType,
isPatch: verb === 'patch',
isPut: verb === 'put',
isDelete: verb === 'delete',
isPost: verb === 'post',
isGet: verb === 'get',
isList: Boolean(allParams.find(function (prop) { return prop.name === 'page'; })),
isAssignmentsList: Boolean(operationName === 'ListAssignments'),
isFacetList: this.getMetaTypeFromList(operation.responses) === 'MetaWithFacets',
allParams: allParams,
queryParams: queryParams,
pathParams: pathParams,
};
return o;
};
OperationService.prototype.getBodyParam = function (requestBody) {
var type;
var requiredFields;
var hasRequiredFields;
var schema = _.get(requestBody, 'content["application/json"].schema');
if (schema) {
if (schema.$ref) {
type = utility_1.default.getType(schema.$ref);
requiredFields = [];
hasRequiredFields = false;
}
else if (schema.allOf) {
type = utility_1.default.getType(schema.allOf[0].$ref);
requiredFields = schema.required;
hasRequiredFields = requiredFields && requiredFields.length > 0;
}
else {
type = 'object';
requiredFields = schema.required;
hasRequiredFields = requiredFields && requiredFields.length > 0;
}
// if (!type) {
// console.log('NO TYPE', JSON.stringify(requestBody));
// }
return {
name: utility_1.default.makeCamelCase(type),
description: requestBody.description || '',
type: type,
isArray: false,
isPrimitive: false,
isComplexType: true,
isCustomType: true,
isReadOnly: false,
isEnum: false,
isRequired: true,
isQueryParam: false,
isPathParam: false,
isBodyParam: true,
isXp: false,
enumValues: [],
requiredFields: requiredFields,
hasRequiredFields: hasRequiredFields,
format: '',
maxLength: null,
minLength: null,
minimum: null,
maximum: null,
default: null,
};
}
return null;
};
OperationService.prototype.getReturnType = function (responses) {
var _a, _b, _c, _d, _e;
if (!responses)
return null;
var responseCode = Object.keys(responses).find(function (code) {
var c = Number(code);
return c >= 200 && c < 300;
});
var response = responses[responseCode];
var schema = (_b = (_a = response === null || response === void 0 ? void 0 : response.content) === null || _a === void 0 ? void 0 : _a['application/json']) === null || _b === void 0 ? void 0 : _b.schema;
var ref = (schema === null || schema === void 0 ? void 0 : schema.$ref) || ((_e = (_d = (_c = schema === null || schema === void 0 ? void 0 : schema.properties) === null || _c === void 0 ? void 0 : _c.Items) === null || _d === void 0 ? void 0 : _d.items) === null || _e === void 0 ? void 0 : _e.$ref);
if (ref) {
return utility_1.default.getType(ref);
}
return null;
};
OperationService.prototype.getMetaTypeFromList = function (responses) {
var _a, _b, _c, _d;
var responsesArray = _.values(responses);
var firstResponse = responsesArray[0];
var schema = (_b = (_a = firstResponse.content) === null || _a === void 0 ? void 0 : _a['application/json']) === null || _b === void 0 ? void 0 : _b.schema;
var ref = (_d = (_c = schema === null || schema === void 0 ? void 0 : schema.properties) === null || _c === void 0 ? void 0 : _c.Meta) === null || _d === void 0 ? void 0 : _d.$ref;
return ref ? utility_1.default.getType(ref) : null;
};
OperationService.prototype.formatParam = function (inputProp, rawSpec) {
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
var prop = inputProp;
if (prop.$ref) {
prop = utility_1.default.resolveReference(prop.$ref, rawSpec);
}
if (prop.schema.$ref) {
// only props with $ref are enums
var type = utility_1.default.getType(prop.schema.$ref);
var resolvedProp = rawSpec.components.schemas[type];
return {
name: prop.name,
description: resolvedProp.description || prop.description,
isReadOnly: Boolean(prop.readOnly),
isEnum: true,
isRequired: Boolean(prop.required),
isQueryParam: prop.in === 'query',
isPathParam: prop.in === 'path',
isBodyParam: false,
isXp: prop.name === 'xp',
requiredFields: [],
hasRequiredFields: false,
enumValues: [],
format: prop.schema.format || '',
maxLength: null,
minLength: null,
minimum: null,
maximum: null,
default: null,
type: type,
isArray: false,
isPrimitive: false,
isComplexType: true,
isCustomType: true,
};
}
var commonProps = {
name: prop.name,
description: prop.description,
isReadOnly: prop.readOnly,
isEnum: Boolean((_b = (_a = prop === null || prop === void 0 ? void 0 : prop.schema) === null || _a === void 0 ? void 0 : _a.enum) !== null && _b !== void 0 ? _b : (_d = (_c = prop === null || prop === void 0 ? void 0 : prop.schema) === null || _c === void 0 ? void 0 : _c.items) === null || _d === void 0 ? void 0 : _d.enum),
isRequired: prop.required,
isQueryParam: prop.in === 'query',
isPathParam: prop.in === 'path',
isBodyParam: false,
isXp: prop.name === 'xp',
requiredFields: [],
hasRequiredFields: false,
enumValues: (_j = (_f = (_e = prop === null || prop === void 0 ? void 0 : prop.schema) === null || _e === void 0 ? void 0 : _e.enum) !== null && _f !== void 0 ? _f : (_h = (_g = prop === null || prop === void 0 ? void 0 : prop.schema) === null || _g === void 0 ? void 0 : _g.items) === null || _h === void 0 ? void 0 : _h.enum) !== null && _j !== void 0 ? _j : [],
format: prop.schema.format || '',
maxLength: prop.schema.maxLength || null,
minLength: prop.schema.minLength || null,
minimum: prop.schema.minimum || null,
maximum: prop.schema.maximum || null,
default: prop.schema.default || null,
};
if (prop.schema.type === 'array') {
return __assign(__assign({}, commonProps), { type: prop.schema.items.type, isArray: true, isPrimitive: false, isComplexType: true, isCustomType: utility_1.default.isCustomType(prop.schema.items.type) });
}
return __assign(__assign({}, commonProps), { type: prop.schema.type, isArray: false, isPrimitive: utility_1.default.isPrimitive(prop.schema.type), isComplexType: utility_1.default.isComplexType(prop.schema.type), isCustomType: utility_1.default.isCustomType(prop.schema.type) });
};
return OperationService;
}());
exports.default = new OperationService();