n8n
Version:
n8n Workflow Automation Tool
137 lines • 6.25 kB
JavaScript
;
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 __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.loadPublicApiVersions = void 0;
exports.isApiEnabled = isApiEnabled;
const typedi_1 = require("typedi");
const express_1 = __importDefault(require("express"));
const promises_1 = __importDefault(require("fs/promises"));
const path_1 = __importDefault(require("path"));
const validator_1 = __importDefault(require("validator"));
const yamljs_1 = __importDefault(require("yamljs"));
const License_1 = require("../License");
const user_repository_1 = require("../databases/repositories/user.repository");
const url_service_1 = require("../services/url.service");
const config_1 = require("@n8n/config");
const event_service_1 = require("../events/event.service");
async function createApiRouter(version, openApiSpecPath, handlersDirectory, publicApiEndpoint) {
const n8nPath = typedi_1.Container.get(config_1.GlobalConfig).path;
const swaggerDocument = yamljs_1.default.load(openApiSpecPath);
swaggerDocument.server = [
{
url: `${typedi_1.Container.get(url_service_1.UrlService).getInstanceBaseUrl()}/${publicApiEndpoint}/${version}}`,
},
];
const apiController = express_1.default.Router();
if (!typedi_1.Container.get(config_1.GlobalConfig).publicApi.swaggerUiDisabled) {
const { serveFiles, setup } = await Promise.resolve().then(() => __importStar(require('swagger-ui-express')));
const swaggerThemePath = path_1.default.join(__dirname, 'swaggerTheme.css');
const swaggerThemeCss = await promises_1.default.readFile(swaggerThemePath, { encoding: 'utf-8' });
apiController.use(`/${publicApiEndpoint}/${version}/docs`, serveFiles(swaggerDocument), setup(swaggerDocument, {
customCss: swaggerThemeCss,
customSiteTitle: 'n8n Public API UI',
customfavIcon: `${n8nPath}favicon.ico`,
}));
}
apiController.get(`/${publicApiEndpoint}/${version}/openapi.yml`, (_, res) => {
res.sendFile(openApiSpecPath);
});
const { middleware: openApiValidatorMiddleware } = await Promise.resolve().then(() => __importStar(require('express-openapi-validator')));
apiController.use(`/${publicApiEndpoint}/${version}`, express_1.default.json(), openApiValidatorMiddleware({
apiSpec: openApiSpecPath,
operationHandlers: handlersDirectory,
validateRequests: true,
validateApiSpec: true,
formats: {
email: {
type: 'string',
validate: (email) => validator_1.default.isEmail(email),
},
identifier: {
type: 'string',
validate: (identifier) => validator_1.default.isUUID(identifier) || validator_1.default.isEmail(identifier),
},
jsonString: {
validate: (data) => {
try {
JSON.parse(data);
return true;
}
catch (e) {
return false;
}
},
},
},
validateSecurity: {
handlers: {
ApiKeyAuth: async (req, _scopes, schema) => {
const apiKey = req.headers[schema.name.toLowerCase()];
const user = await typedi_1.Container.get(user_repository_1.UserRepository).findOne({
where: { apiKey },
});
if (!user)
return false;
typedi_1.Container.get(event_service_1.EventService).emit('public-api-invoked', {
userId: user.id,
path: req.path,
method: req.method,
apiVersion: version,
});
req.user = user;
return true;
},
},
},
}));
apiController.use((error, _req, res, _next) => {
return res.status(error.status || 400).json({
message: error.message,
});
});
return apiController;
}
const loadPublicApiVersions = async (publicApiEndpoint) => {
var _a;
const folders = await promises_1.default.readdir(__dirname);
const versions = folders.filter((folderName) => folderName.startsWith('v'));
const apiRouters = await Promise.all(versions.map(async (version) => {
const openApiPath = path_1.default.join(__dirname, version, 'openapi.yml');
return await createApiRouter(version, openApiPath, __dirname, publicApiEndpoint);
}));
const version = (_a = versions.pop()) === null || _a === void 0 ? void 0 : _a.charAt(1);
return {
apiRouters,
apiLatestVersion: version ? Number(version) : 1,
};
};
exports.loadPublicApiVersions = loadPublicApiVersions;
function isApiEnabled() {
return !typedi_1.Container.get(config_1.GlobalConfig).publicApi.disabled && !typedi_1.Container.get(License_1.License).isAPIDisabled();
}
//# sourceMappingURL=index.js.map