@rxap/open-api
Version:
This package provides tools for working with OpenAPI specifications in Angular applications. It includes services for configuring and loading OpenAPI definitions, validating requests and responses against schemas, and handling errors. It also offers utili
907 lines (689 loc) • 30.6 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>angular-open-api</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">angular-open-api</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content interface">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Interfaces</li>
<li class="breadcrumb-item"
>
SchemaValidationResponse</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/lib/schema-validation.mixin.ts</code>
</p>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Optional</span>
<a href="#body"
>
body
</a>
</li>
<li>
<span class="modifier">Optional</span>
<a href="#data"
>
data
</a>
</li>
<li>
<a href="#headers"
>
headers
</a>
</li>
<li>
<a href="#status"
>
status
</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3 id="inputs">Properties</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="body"></a>
<span class="name "><b>body</b>
<a href="#body">
<span class="icon ion-ios-link"></span>
</a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>body: <code>Data | null</code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Data | null</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Optional</i>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="data"></a>
<span class="name "><b>data</b>
<a href="#data">
<span class="icon ion-ios-link"></span>
</a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>data: <code>Data</code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Data</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Optional</i>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="headers"></a>
<span class="name "><b>headers</b>
<a href="#headers">
<span class="icon ion-ios-link"></span>
</a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>headers: <code>HttpHeaders</code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>HttpHeaders</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="status"></a>
<span class="name "><b>status</b>
<a href="#status">
<span class="icon ion-ios-link"></span>
</a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>status: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import {
HttpHeaders,
HttpParams,
} from '@angular/common/http';
import { isDevMode } from '@angular/core';
import { HttpRemoteMethodParameter } from '@rxap/remote-method/http';
import {
assertsObject,
coerceArray,
isPromiseLike,
IsRecord,
} from '@rxap/utilities';
import Ajv from 'ajv';
import { OpenAPIV3 } from 'openapi-types';
import { RxapOpenApiError } from './error';
import { OperationObjectWithMetadata } from './open-api';
import {
IsReferenceObject,
NotContainsReferenceObjects,
} from './utilities';
export interface SchemaValidationResponse<Data> {
headers: HttpHeaders;
status: number;
body?: Data | null;
data?: Data;
}
export class SchemaValidationMixin<Response = any, Parameters extends Record<string, any> | void = any, RequestBody = any> {
public static STRICT = false;
protected disableSchemaValidation?: boolean;
/**
* Validates the parameters against the schema specified in the operation object
*
* @param operation
* @param parameters
* @param strict
* @protected
*/
public validateParameters(operation: OperationObjectWithMetadata, parameters?: Parameters, strict = false): void {
const operationParameters = coerceArray(operation.parameters);
if (!NotContainsReferenceObjects<OpenAPIV3.ParameterObject>(operationParameters)) {
throw new RxapOpenApiError('The operation parameters contains ReferenceObject!');
}
if (parameters === undefined) {
// TODO : find concept to definition witch parameter should not be checked if required
// header parameters are never required if changes the semantic release manager breaks
const requiredParameters = operationParameters.filter(parameter => parameter.required &&
parameter.in !==
'header');
if (requiredParameters.length) {
if (isDevMode()) {
console.debug('Some operation parameters are required!', requiredParameters.map(p => p.name));
}
this.validationError('Some operation parameters are required!', strict);
}
} else if (IsRecord(parameters)) {
for (const parameter of operationParameters) {
if (parameter.required) {
// header parameters are never required if changes the semantic release manager breaks
if (parameter.in !== 'header') {
if (!parameters.hasOwnProperty(parameter.name)) {
this.validationError(`The operation parameter '${ parameter.name }' is required!`, strict);
}
}
}
if (parameter.schema) {
if (parameters.hasOwnProperty(parameter.name)) {
const value = parameters[parameter.name];
if (!this.validate(parameter.schema, value)) {
this.validationError(
`The parameter '${ parameter.name }' is not valid against the schema!`,
strict,
parameter.schema,
value,
);
}
}
}
}
} else {
if (operationParameters.length === 0 || operationParameters.every(op => !op.required)) {
if (isDevMode()) {
console.warn(
`The operation ${ operation.operationId } does not expect any parameters. But a parameter is provided.`,
parameters,
);
}
} else {
throw new Error('The parameters object is not a record');
}
}
}
/**
* Validates the http response against the schema specified in the operation object
*
* @param operation
* @param response
* @param strict
* @protected
*/
public validateResponse(
operation: OperationObjectWithMetadata,
response: SchemaValidationResponse<Response>,
strict = false,
): void {
// region only validate the response if the content type is undefined or application/json
const contentType = response.headers.get('Content-Type');
if (contentType && contentType !== 'application/json') {
if (isDevMode()) {
console.warn('Response validation is only supported for content type application/json');
}
return;
}
// endregion
if (operation.responses) {
const status = response.status;
// region extract the response object based on the response status
let responseObject: OpenAPIV3.ResponseObject | OpenAPIV3.ReferenceObject | undefined;
if (operation.responses[status]) {
responseObject = operation.responses[status];
} else {
// use the default response object if no matching was found.
responseObject = operation.responses['default'];
}
// endregion
if (responseObject) {
if (IsReferenceObject(responseObject)) {
throw new RxapOpenApiError('Found a reference object. The operation config is not expand!');
}
// region validate the response against the schema if defined
// TODO : create schema that validates all parameters at once
if (responseObject.content &&
responseObject.content['application/json'] &&
responseObject.content['application/json'].schema) {
const schema = responseObject.content['application/json'].schema;
const data = response.body ?? response.data;
if (!this.validate(schema, data)) {
this.validationError('The response is not valid ageist the operation schema!', strict, schema, data);
}
}
// endregion
}
}
}
public validateRequestBody(operation: OperationObjectWithMetadata, body?: RequestBody, strict = false): void {
// only validate body if type of object
if (typeof body !== 'object') {
return;
}
if (operation.requestBody) {
if (IsReferenceObject(operation.requestBody)) {
throw new RxapOpenApiError('Found a reference object. The operation config is not expand!');
}
if (body === undefined && operation.requestBody.required) {
this.validationError('The request body is required!', strict);
}
if (operation.requestBody.content && operation.requestBody.content['application/json']) {
const schema = operation.requestBody.content['application/json'].schema;
if (schema) {
if (!this.validate(schema, body)) {
this.validationError('The request body is not valid!', strict, schema, body);
}
}
}
}
}
public validationError(
message: string,
strict: boolean,
schema?: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject,
value?: any,
) {
if (isDevMode() && schema !== undefined) {
console.debug(
message,
{
schema,
value,
},
);
}
if (strict || SchemaValidationMixin.STRICT) {
throw new RxapOpenApiError(message, '', 'SchemaValidationMixin');
} else {
console.warn(message);
}
}
public buildHttpParams(
operationParameters: OpenAPIV3.ParameterObject[],
parameters?: Parameters,
ignoreUndefined = true,
): HttpParams {
let params = new HttpParams();
if (IsRecord(parameters)) {
for (const parameter of operationParameters.filter(p => p.in === 'query')) {
const parameterName = parameter.name;
if (parameters.hasOwnProperty(parameter.name)) {
const value = parameters[parameter.name];
if (value === undefined && ignoreUndefined) {
continue;
}
if (Array.isArray(value)) {
if (value.length) {
const first = value.shift();
params = params.set(parameterName, typeof first === 'object' ? JSON.stringify(first) : first);
for (const item of value) {
params = params.append(parameterName, typeof item === 'object' ? JSON.stringify(item) : item);
}
}
} else {
params = params.set(parameter.name, typeof value === 'object' ? JSON.stringify(value) : value);
}
}
}
}
return params;
}
public buildHttpHeaders(operationParameters: OpenAPIV3.ParameterObject[], parameters?: Parameters): HttpHeaders {
let headers = new HttpHeaders();
if (IsRecord(parameters)) {
for (const parameter of operationParameters.filter(p => p.in === 'header')) {
if (parameters.hasOwnProperty(parameter.name)) {
const value = parameters[parameter.name];
if (Array.isArray(value)) {
if (value.length) {
const first = value.shift();
headers = headers.set(parameters['name'], typeof first === 'object' ? JSON.stringify(first) : first);
for (const item of value) {
headers = headers.append(parameters['name'], typeof item === 'object' ? JSON.stringify(item) : item);
}
}
} else {
headers = headers.set(parameter.name, typeof value === 'object' ? JSON.stringify(value) : value);
}
}
}
}
return headers;
}
public buildHttpPathParams(
operationParameters: OpenAPIV3.ParameterObject[],
parameters?: Parameters,
): Record<string, string> {
const pathParams: Record<string, any> = {};
if (IsRecord(parameters)) {
for (const parameter of operationParameters.filter(p => p.in === 'path')) {
if (parameters.hasOwnProperty(parameter.name)) {
pathParams[parameter.name] = encodeURIComponent(typeof parameters[parameter.name] === 'object' ?
JSON.stringify(parameters[parameter.name]) :
parameters[parameter.name]);
}
}
}
return pathParams;
}
/**
* Converts open api parameters into the corresponding http options to
* create a http request. The transformation is guided by the openapi definition
*
* @param operation
* @param parameters
* @param requestBody
* @param ignoreUndefined
*/
public buildHttpOptions(
operation: OperationObjectWithMetadata,
parameters?: Parameters,
requestBody?: RequestBody,
ignoreUndefined = true,
): HttpRemoteMethodParameter {
const options: HttpRemoteMethodParameter = {};
const operationParameters = coerceArray(operation.parameters);
if (!NotContainsReferenceObjects<OpenAPIV3.ParameterObject>(operationParameters)) {
throw new RxapOpenApiError('The operation parameters contains ReferenceObject!');
}
const params = this.buildHttpParams(operationParameters, parameters, ignoreUndefined);
const headers = this.buildHttpHeaders(operationParameters, parameters);
const pathParams: Record<string, any> = this.buildHttpPathParams(operationParameters, parameters);
if (params.keys().length) {
options.params = params;
}
if (headers.keys().length) {
options.headers = headers;
}
if (Object.keys(pathParams).length) {
options.pathParams = pathParams;
}
if (requestBody !== undefined) {
const [ body, contentType ] = this.buildBody(operation, requestBody);
if (body !== undefined) {
options.body = body;
if (contentType !== undefined) {
options.headers ??= new HttpHeaders();
options.headers.set('Content-Type', contentType);
}
}
}
return options;
}
private buildBody(operation: OperationObjectWithMetadata, requestBody: RequestBody): [ any, string | undefined ] {
const accept: string[] = [];
if (operation.requestBody && !IsReferenceObject(operation.requestBody)) {
if (operation.requestBody.content) {
for (const contentType of Object.keys(operation.requestBody.content)) {
accept.push(contentType);
}
}
}
if (!accept.length) {
console.warn('No content type found for the request body! Omitting the body!');
return [ undefined, undefined ];
}
if (accept.length > 1) {
console.warn('Multiple content types found for the request body! Using the first one!');
}
const contentType = accept[0];
switch (contentType) {
case 'application/json':
assertsObject(requestBody);
return [ requestBody, contentType ];
case 'application/x-www-form-urlencoded':
assertsObject(requestBody);
// eslint-disable-next-line no-case-declarations
let params = new HttpParams();
for (const [ key, value ] of Object.entries(requestBody)) {
params = params.set(key, value);
}
return [ params.toString(), contentType ];
case 'multipart/form-data':
assertsObject(requestBody);
// eslint-disable-next-line no-case-declarations
const formData = new FormData();
// Iterate through the JSON object and append each field to FormData
for (const [ key, value ] of Object.entries(requestBody)) {
formData.append(key, value);
}
return [ formData, contentType ];
default:
return [ requestBody, contentType ];
}
}
private validate(schema: string | boolean | object, value: any): boolean {
if (this.disableSchemaValidation) {
return true;
}
if (typeof schema !== 'object') {
throw new Error('The schema must be an object!');
}
if (!schema) {
throw new Error('The schema must not be null or undefined!');
}
let result: boolean | PromiseLike<any>;
const ajv = new Ajv();
const validate = ajv.compile(schema);
try {
result = validate(value);
} catch (e: any) {
console.error(e.message);
return false;
}
if (isPromiseLike(result)) {
throw new Error(
'Async schema validation is not yet supported. Ensure the all refs in the openapi schema are internal!');
}
return result;
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
var COMPODOC_CURRENT_PAGE_URL = 'SchemaValidationResponse.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>