Jodit Connector Node.js

TypeScript-based file management backend for the Jodit Editor with comprehensive features.

Features

• File operations (browse, upload, rename, move, delete)
• Folder management
• Image processing
• Document generation
• Authentication & access control
• Express integration
• Custom storage adapters
• Auto-generated OpenAPI documentation
• Role-based access control

Installation

NPM

npm install jodit-nodejs
Copy

Docker

Pull the Docker image:

docker pull chupurnov/jodit-nodejs:latest
Copy

Run the container:

docker run --rm -p 8081:8081 chupurnov/jodit-nodejs
Copy

The server will be available at http://localhost:8081.

Basic Usage

Start Server with Default Configuration

import { start } from 'jodit-nodejs';

// Start server with default config
const server = await start(8081);
console.log('Server running on http://localhost:8081');
Copy

Authentication Example

import { start, AuthCallback } from 'jodit-nodejs';

const checkAuth: AuthCallback = async req => {
	const token = req.headers.authorization;
	if (!token) return 'guest';

	// Validate token and return user role
	const user = await validateToken(token);
	return user.role;
};

const server = await start(8081, {
	auth: checkAuth
});
Copy

Custom Configuration

import { start } from 'jodit-nodejs';

const server = await start(8081, {
	baseDir: './uploads',
	auth: async req => {
		// Your authentication logic
		return 'admin';
	},
	accessControl: {
		admin: {
			read: true,
			write: true,
			delete: true
		},
		guest: {
			read: true,
			write: false,
			delete: false
		}
	}
});
Copy

Integration with Jodit Editor

Configure Jodit Editor to use your jodit-nodejs backend:

Jodit.make('#editor', {
	uploader: {
		url: 'http://localhost:8081/upload'
	},
	filebrowser: {
		ajax: {
			url: 'http://localhost:8081'
		}
	}
});
Copy

With Authentication

Jodit.make('#editor', {
	uploader: {
		url: 'http://localhost:8081/upload',
		headers: {
			Authorization: 'Bearer YOUR_TOKEN'
		}
	},
	filebrowser: {
		ajax: {
			url: 'http://localhost:8081',
			headers: {
				Authorization: 'Bearer YOUR_TOKEN'
			}
		}
	}
});
Copy

Key Technologies

• TypeScript with strict mode
• Express 5.x framework
• Zod runtime validation
• Winston logging
• @hapi/boom error handling

Documentation

For more details, visit the official documentation.

License

MIT