545563e776
- Complete NestJS TypeScript implementation with WebSocket support - Direct messaging (DM) and group chat functionality - End-to-end encryption with AES encryption and key pairs - Media file support (images, videos, audio, documents) up to 100MB - Push notifications with Firebase Cloud Messaging integration - Mention alerts and real-time typing indicators - User authentication with JWT and Passport - SQLite database with TypeORM entities and relationships - Comprehensive API documentation with Swagger/OpenAPI - File upload handling with secure access control - Online/offline status tracking and presence management - Message editing, deletion, and reply functionality - Notification management with automatic cleanup - Health check endpoint for monitoring - CORS configuration for cross-origin requests - Environment-based configuration management - Structured for Flutter SDK integration Features implemented: ✅ Real-time messaging with Socket.IO ✅ User registration and authentication ✅ Direct messages and group chats ✅ Media file uploads and management ✅ End-to-end encryption ✅ Push notifications ✅ Mention alerts ✅ Typing indicators ✅ Message read receipts ✅ Online status tracking ✅ File access control ✅ Comprehensive API documentation Ready for Flutter SDK development and production deployment.
89 lines
2.3 KiB
JavaScript
89 lines
2.3 KiB
JavaScript
/**
|
|
* Translate doclet descriptions from Markdown into HTML.
|
|
*
|
|
* @module plugins/markdown
|
|
*/
|
|
const env = require('jsdoc/env');
|
|
|
|
const config = env.conf.markdown || {};
|
|
const defaultTags = [
|
|
'author',
|
|
'classdesc',
|
|
'description',
|
|
'exceptions',
|
|
'params',
|
|
'properties',
|
|
'returns',
|
|
'see',
|
|
'summary'
|
|
];
|
|
const hasOwnProp = Object.prototype.hasOwnProperty;
|
|
const parse = require('jsdoc/util/markdown').getParser();
|
|
let tags = [];
|
|
let excludeTags = [];
|
|
|
|
function shouldProcessString(tagName, text) {
|
|
let shouldProcess = true;
|
|
|
|
// we only want to process `@author` and `@see` tags that contain Markdown links
|
|
if ( (tagName === 'author' || tagName === 'see') && !text.includes('[') ) {
|
|
shouldProcess = false;
|
|
}
|
|
|
|
return shouldProcess;
|
|
}
|
|
|
|
/**
|
|
* Process the markdown source in a doclet. The properties that should be processed are
|
|
* configurable, but always include "author", "classdesc", "description", "exceptions", "params",
|
|
* "properties", "returns", and "see". Handled properties can be bare strings, objects, or arrays
|
|
* of objects.
|
|
*/
|
|
function process(doclet) {
|
|
tags.forEach(tag => {
|
|
if ( !hasOwnProp.call(doclet, tag) ) {
|
|
return;
|
|
}
|
|
|
|
if (typeof doclet[tag] === 'string' && shouldProcessString(tag, doclet[tag]) ) {
|
|
doclet[tag] = parse(doclet[tag]);
|
|
}
|
|
else if ( Array.isArray(doclet[tag]) ) {
|
|
doclet[tag].forEach((value, index, original) => {
|
|
const inner = {};
|
|
|
|
inner[tag] = value;
|
|
process(inner);
|
|
original[index] = inner[tag];
|
|
});
|
|
}
|
|
else if (doclet[tag]) {
|
|
process(doclet[tag]);
|
|
}
|
|
});
|
|
}
|
|
|
|
// set up the list of "tags" (properties) to process
|
|
if (config.tags) {
|
|
tags = config.tags.slice();
|
|
}
|
|
// set up the list of default tags to exclude from processing
|
|
if (config.excludeTags) {
|
|
excludeTags = config.excludeTags.slice();
|
|
}
|
|
defaultTags.forEach(tag => {
|
|
if (!excludeTags.includes(tag) && !tags.includes(tag)) {
|
|
tags.push(tag);
|
|
}
|
|
});
|
|
|
|
exports.handlers = {
|
|
/**
|
|
* Translate Markdown syntax in a new doclet's description into HTML. Is run
|
|
* by JSDoc 3 whenever a "newDoclet" event fires.
|
|
*/
|
|
newDoclet({doclet}) {
|
|
process(doclet);
|
|
}
|
|
};
|