@nestjsvn/swagger-sse
Version:
OpenAPI documentation and interactive Swagger UI for NestJS Server-Sent Events endpoints
159 lines (158 loc) • 6.45 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 () {
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;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.defaultSsePluginOptions = void 0;
exports.sseTransformer = sseTransformer;
const ts = __importStar(require("typescript"));
const ast_utils_1 = require("./ast-utils");
/**
* TypeScript AST transformer for automatic SSE endpoint detection
*
* This transformer automatically detects @Sse() decorated methods and adds
* @ApiSse() decorators with inferred event types from Observable return types.
*
* @param program TypeScript program
* @param options Plugin configuration options
* @returns Transformer factory
*/
function sseTransformer(program, options = {}) {
return (context) => {
return (sourceFile) => {
// Check if this file imports NestJS SSE decorators
const hasNestJsImports = hasRelevantImports(sourceFile);
if (!hasNestJsImports) {
return sourceFile;
}
function visit(node) {
if (ts.isMethodDeclaration(node)) {
return transformSseMethod(node, context, options);
}
return ts.visitEachChild(node, visit, context);
}
const transformedFile = ts.visitNode(sourceFile, visit);
// Add necessary imports if we transformed any methods
return addRequiredImports(transformedFile, context);
};
};
}
/**
* Transform an SSE method by adding @ApiSse decorator if needed
*
* @param node Method declaration node
* @param context Transformation context
* @param options Plugin options
* @returns Transformed method declaration
*/
function transformSseMethod(node, context, options) {
// Only transform methods that have @Sse decorator but not @ApiSse
if (!(0, ast_utils_1.hasSseDecorator)(node) || (0, ast_utils_1.hasApiSseDecorator)(node)) {
return node;
}
// Extract event types from the method's return type
const eventTypes = (0, ast_utils_1.extractEventTypes)(node);
if (eventTypes.length === 0) {
console.warn(`No event types found for SSE method: ${node.name?.getText()}`);
return node;
}
// Add @ApiSse decorator with extracted event types
return (0, ast_utils_1.addApiSseDecorator)(node, context, eventTypes, options);
}
/**
* Check if the source file has relevant NestJS imports
*
* @param sourceFile Source file to check
* @returns True if file imports NestJS SSE-related decorators
*/
function hasRelevantImports(sourceFile) {
for (const statement of sourceFile.statements) {
if (ts.isImportDeclaration(statement)) {
const moduleSpecifier = statement.moduleSpecifier;
if (ts.isStringLiteral(moduleSpecifier)) {
const moduleName = moduleSpecifier.text;
// Check for NestJS common imports (where @Sse is located)
if (moduleName === '@nestjs/common') {
// Check if @Sse is imported
if (statement.importClause?.namedBindings &&
ts.isNamedImports(statement.importClause.namedBindings)) {
const imports = statement.importClause.namedBindings.elements;
return imports.some(imp => imp.name.text === 'Sse');
}
}
}
}
}
return false;
}
/**
* Add required imports for @ApiSse decorator if not already present
*
* @param sourceFile Source file to modify
* @param context Transformation context
* @returns Modified source file with imports
*/
function addRequiredImports(sourceFile, context) {
const factory = context.factory;
// Check if @ApiSse is already imported
let hasApiSseImport = false;
for (const statement of sourceFile.statements) {
if (ts.isImportDeclaration(statement)) {
const moduleSpecifier = statement.moduleSpecifier;
if (ts.isStringLiteral(moduleSpecifier) && moduleSpecifier.text === '@nestjsvn/swagger-sse') {
if (statement.importClause?.namedBindings &&
ts.isNamedImports(statement.importClause.namedBindings)) {
const imports = statement.importClause.namedBindings.elements;
hasApiSseImport = imports.some(imp => imp.name.text === 'ApiSse');
}
}
}
}
// Add import if not present
if (!hasApiSseImport) {
const apiSseImport = factory.createImportDeclaration(undefined, factory.createImportClause(false, undefined, factory.createNamedImports([
factory.createImportSpecifier(false, undefined, factory.createIdentifier('ApiSse')),
])), factory.createStringLiteral('@nestjsvn/swagger-sse'));
const statements = [apiSseImport, ...sourceFile.statements];
return factory.updateSourceFile(sourceFile, statements);
}
return sourceFile;
}
/**
* Default plugin options
*/
exports.defaultSsePluginOptions = {
eventNamingConvention: 'kebab-case',
introspectComments: true,
autoGenerateOperationId: true,
};