@citrineos/util
Version:
The OCPP util module which supplies helpful utilities like cache and queue connectors, etc.
208 lines • 8.44 kB
JavaScript
;
// Copyright (c) 2023 S44, LLC
// Copyright Contributors to the CitrineOS Project
//
// SPDX-License-Identifier: Apache 2.0
/* eslint-disable */
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 () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__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 __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getAuthorizationTokenFromRequest = exports.getHeaderValue = void 0;
exports.initSwagger = initSwagger;
const swagger_1 = __importDefault(require("@fastify/swagger"));
const swagger_ui_1 = __importDefault(require("@fastify/swagger-ui"));
const fs_1 = __importDefault(require("fs"));
const base_1 = require("@citrineos/base");
const FastifyAuth = __importStar(require("@fastify/auth"));
const packageJson = __importStar(require("../../package.json"));
/**
* This transformation is used to set default tags
*
* @param {object} swaggerObject - The original Swagger object to be transformed.
* @param {object} openapiObject - The original OpenAPI object to be transformed.
* @return {object} The transformed OpenAPI object.
*/
function OcppTransformObject({ swaggerObject, openapiObject, }) {
console.log('OcppTransformObject: Transforming OpenAPI object...');
if (openapiObject.paths && openapiObject.components) {
for (const pathKey in openapiObject.paths) {
const path = openapiObject.paths[pathKey];
if (path) {
for (const methodKey in path) {
const method = path[methodKey];
if (method) {
// Set tags based on path key if tags were not passed in
if (!method.tags) {
// Get tag index
// e.g, '/ocpp/1.6/evdriver' -> 'evdriver'
// e.g, '/data/evdriver' -> 'evdriver'
const tagIndex = pathKey.includes('data') ? 2 : 3;
method.tags = pathKey
.split('/')
.slice(tagIndex, -1)
.map((tag) => tag.charAt(0).toUpperCase() + tag.slice(1));
}
}
}
}
}
}
return openapiObject;
}
const registerSwaggerUi = (systemConfig, server) => {
var _a, _b, _c;
const swaggerUiOptions = {
routePrefix: (_a = systemConfig.util.swagger) === null || _a === void 0 ? void 0 : _a.path,
securityDefinitions: {
authorization: {
name: 'authorization',
type: 'apiKey',
in: 'header',
},
},
exposeRoute: true,
uiConfig: {
filter: true,
},
theme: {
title: 'CitrineOS Central System API',
css: [
{
filename: '',
content: '.swagger-ui .topbar { background-color: #fafafa; } .swagger-ui .topbar .download-url-wrapper { display: none; }',
},
],
},
};
if ((_b = systemConfig.util.swagger) === null || _b === void 0 ? void 0 : _b.logoPath) {
swaggerUiOptions['logo'] = {
type: 'image/png',
content: fs_1.default.readFileSync((_c = systemConfig.util.swagger) === null || _c === void 0 ? void 0 : _c.logoPath),
};
}
server.register(swagger_ui_1.default, swaggerUiOptions);
};
const getHeaderValue = (headers, key) => {
for (let i = 0; i < headers.length; i += 2) {
if (headers[i].toLowerCase() === key.toLowerCase()) {
return headers[i + 1];
}
}
return undefined;
};
exports.getHeaderValue = getHeaderValue;
const getTokenFromAuthHeader = (authorizationHeader) => {
if (!!authorizationHeader) {
const token = authorizationHeader.split('Bearer ')[1];
return token;
}
return undefined;
};
const getAuthorizationTokenFromRawHeaders = (headers) => {
const authorizationHeader = (0, exports.getHeaderValue)(headers, base_1.HttpHeader.Authorization);
return getTokenFromAuthHeader(authorizationHeader);
};
const getAuthorizationTokenFromRequest = (request) => {
const token = getAuthorizationTokenFromRawHeaders(request.raw.rawHeaders);
if (!token) {
throw new base_1.UnauthorizedError('Token not found in headers');
}
return token;
};
exports.getAuthorizationTokenFromRequest = getAuthorizationTokenFromRequest;
const registerFastifyAuth = (server) => __awaiter(void 0, void 0, void 0, function* () {
yield server.register(FastifyAuth).after();
console.log(server.authorization);
server.decorate('authorization', function (request, reply, done) {
try {
const token = (0, exports.getAuthorizationTokenFromRequest)(request);
console.log('Received authorization token', token);
done();
}
catch (e) {
reply.code(base_1.HttpStatus.UNAUTHORIZED);
}
});
});
const buildLocalReference = (json, _parent, _property, i) => {
// If title is missing but $id is available, set title to $id
if (!json.title && json.$id) {
json.title = json.$id;
}
// Return title if available, otherwise fallback to $id, or def-<index> as a last resort
return json.title || json.$id || `def-${i}`;
};
const registerFastifySwagger = (systemConfig, server) => {
server.register(swagger_1.default, {
openapi: {
info: {
title: 'CitrineOS Central System API',
description: 'Central System API for OCPP 2.0.1 messaging.',
version: packageJson.version,
},
components: {
securitySchemes: {
authorization: {
type: 'http',
scheme: 'bearer',
},
},
},
},
transformObject: OcppTransformObject,
refResolver: {
buildLocalReference,
},
});
};
function initSwagger(systemConfig, server) {
return __awaiter(this, void 0, void 0, function* () {
registerFastifySwagger(systemConfig, server);
registerSwaggerUi(systemConfig, server);
yield registerFastifyAuth(server);
});
}
//# sourceMappingURL=swagger.js.map