@ordercloud/oc-codegen
Version:
OpenAPI codegen tool built for the OrderCloud API
234 lines (233 loc) • 12.7 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 __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 ModelService = /** @class */ (function () {
function ModelService() {
}
ModelService.prototype.formatModels = function (spec, operations, hooks) {
return __awaiter(this, void 0, void 0, function () {
var modelInputs, models, boolArray_1;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
modelInputs = _.values(_.mapValues(spec.components.schemas, function (model, modelName) { return ({
model: model,
modelName: modelName,
}); }));
return [4 /*yield*/, Promise.all(modelInputs.map(function (_a) {
var model = _a.model, modelName = _a.modelName;
return typeof hooks.formatModel === 'function'
? hooks.formatModel(model, modelName, operations, spec)
: _this.formatModel(model, modelName, operations, spec);
}))];
case 1:
models = _a.sent();
if (!(typeof hooks.filterModels === 'function')) return [3 /*break*/, 3];
return [4 /*yield*/, Promise.all(models.map(function (model) { return hooks.filterModels(model, models, operations, spec); }))];
case 2:
boolArray_1 = _a.sent();
models = models.filter(function () { return boolArray_1.shift(); });
_a.label = 3;
case 3:
if (!(typeof hooks.postFormatModel === 'function')) return [3 /*break*/, 5];
return [4 /*yield*/, Promise.all(models.map(function (m) {
return hooks.postFormatModel(m, models, operations, spec);
}))];
case 4:
models = _a.sent();
_a.label = 5;
case 5: return [2 /*return*/, models];
}
});
});
};
ModelService.prototype.formatModel = function (model, modelName, operations, spec) {
var _this = this;
// required fields for a model roll up from an operation
// if an operation matches a model and that operation has required fields
// then those same required fields for the operation are required fields for the model
if (model.enum) {
return {
name: modelName,
type: model.type,
example: null,
properties: [],
enumValues: model.enum,
fileImports: [],
isEnum: true,
isList: false,
isStandardList: false,
isFacetList: false,
isAssignmentsList: false,
hasXp: false,
};
}
var requiredFields = null;
var operationWithRequiredParams = operations.find(function (op) {
var paramWithRequiredFields = op.allParams.find(function (p) { return p.hasRequiredFields; });
return op.resourceID.includes(modelName) && paramWithRequiredFields;
});
if (operationWithRequiredParams) {
requiredFields = operationWithRequiredParams.allParams.find(function (p) { return p.hasRequiredFields; }).requiredFields;
}
//This process will merge all inherited model properties with standard model properties
if (model.allOf && model.allOf.length) {
//Resolve the inherited model, for now assume there is only one
var inheritedModel = utility_1.default.resolveReference(model.allOf[0].$ref, spec);
//If inherited model proprties exist
if (inheritedModel && inheritedModel.properties) {
//Loop over each key/value pair of the inherited model
Object.entries(inheritedModel.properties).forEach(function (_a) {
var inheritedKey = _a[0], inheritedProp = _a[1];
//If the same inherited key exists on the standard model, merge it with the inherited property
//Otherwise, assign the inherited property to the inherited key in the standard model
model.properties[inheritedKey] = model.properties[inheritedKey]
? Object.assign({}, inheritedProp, model.properties[inheritedKey])
: inheritedProp;
});
}
}
var properties = _.values(_.mapValues(model.properties, function (property, propertyName) {
return _this.formatProperty(property, propertyName, requiredFields, spec);
}));
return {
name: modelName,
type: model.type,
example: model.example,
properties: properties,
enumValues: [],
fileImports: _.uniq(properties.filter(function (p) { return p.isCustomType; }).map(function (p) { return p.type; })),
isEnum: false,
isList: Boolean(properties.find(function (prop) { return prop.name === 'Meta'; })),
isStandardList: Boolean(!properties.find(function (prop) { return prop.name === 'Meta' && prop.type === 'MetaWithFacets'; }) &&
!properties.find(function (prop) { return prop.name === 'Items' && prop.type.includes('Assignment'); })),
isFacetList: Boolean(properties.find(function (prop) { return prop.name === 'Meta' && prop.type === 'MetaWithFacets'; })),
isAssignmentsList: Boolean(properties.find(function (prop) { return prop.name === 'Items' && prop.type.includes('Assignment'); })),
hasXp: Boolean(properties.find(function (prop) { return prop.name === 'xp'; })),
};
};
ModelService.prototype.formatProperty = function (property, propertyName, requiredFields, spec) {
var allParamProps = {
name: propertyName,
isReadOnly: property.readOnly,
isRequired: Boolean(requiredFields && requiredFields.includes(propertyName)),
isQueryParam: false,
isPathParam: false,
isBodyParam: false,
isXp: propertyName === 'xp',
enumValues: property.enum || [],
requiredFields: [],
hasRequiredFields: false,
description: property.description || '',
format: property.format,
maxLength: property.maxLength,
minLength: property.minLength,
minimum: property.minimum,
maximum: property.maximum,
default: property.default,
};
if (property.type === 'array') {
var type = property.items.type || utility_1.default.getType(property.items.$ref);
return __assign(__assign({}, allParamProps), { type: type, isArray: true, isPrimitive: false, isComplexType: true, isCustomType: utility_1.default.isCustomType(type), isEnum: this.isPropEnum(property, type, spec) });
}
else {
var type = void 0;
if (property.allOf) {
type = utility_1.default.getType(property.allOf[0].$ref);
}
else {
type = property.type || utility_1.default.getType(property.$ref);
}
return __assign(__assign({}, allParamProps), { type: type, isArray: false, isPrimitive: utility_1.default.isPrimitive(type), isComplexType: utility_1.default.isComplexType(type), isCustomType: utility_1.default.isCustomType(type), isEnum: this.isPropEnum(property, type, spec) });
}
};
ModelService.prototype.isPropEnum = function (prop, type, spec) {
var isCustomType = utility_1.default.isCustomType(type);
if (!isCustomType) {
return Boolean(prop.enum);
}
var resolvedProp = spec.components.schemas[type];
return Boolean(resolvedProp && resolvedProp['enum']);
};
return ModelService;
}());
exports.default = new ModelService();