jsda-kit

v0.4.17

Published

11 days ago

JSDA Toolkit for modern Web

Downloads

603

0High
0Medium
0Low

alex_sova

JSDA JS JAMStack SSR SSG Micro-products Symbiote.js JSDA-Kit

JSDA-Kit

A comprehensive, isomorphic JavaScript toolkit for building modern web applications with support for Static Site Generation (SSG), Server-Side Rendering (SSR), and dynamic real-time servers. JSDA-Kit transforms standard JavaScript ESM modules into powerful web asset generation endpoints.

What is JSDA?

JSDA (JavaScript Distributed Web Assets) revolutionizes web development by treating JavaScript ESM modules as text-based web asset generation endpoints. This approach provides PHP-like templating capabilities while leveraging modern JavaScript's universal nature and ESM module system.

Learn more: https://github.com/rnd-pro/jsda

Key Features

Isomorphic Architecture: Universal JavaScript execution in both browser and Node.js environments
Real-Time Asset Bundling: Instant JS/CSS bundling with esbuild - no Webpack required
Server-Side Rendering: Native SSR support for Custom Elements and Web Components
Zero Configuration: Works out of the box with sensible defaults
Automatic ImportMaps: Dynamic import map generation based on project structure
Hybrid App Support: Seamlessly combine SSR, SPA, micro-frontends, and dynamic components
Distributed Assets: ESM-over-HTTPS delivery for modular components
Dynamic Styling: JavaScript-powered CSS with Shadow DOM support
Performance Optimized: Fast in-memory caching for production
Extensible: Clean APIs for custom middleware and extensions
TypeScript Ready: Full TypeScript support with comprehensive type definitions
CLI: Powerful command-line interface with hot reload and build tools

Quick Start

Installation

npm install jsda-kit

CLI Usage (Recommended)

# Start development server
jsda serve

# Build static site
jsda build

# Start SSG (Static Site Generation) with file watching
jsda ssg

# Create project structure
jsda init

Programmatic Usage

// Start a JSDA server
import { JSDAServer } from 'jsda-kit/server';

const server = new JSDAServer({
  port: 3000,
  cache: true,
  routes: './routes.js'
});

server.start();

Core Components

Server Engine

JSDAServer: Main HTTP server with request routing and asset transformation
SSR Engine: Recursive server-side rendering for Web Components
Configuration System: Flexible, hierarchical configuration management
Path Resolution: Smart module path resolution for local and remote assets

Isomorphic Tools

Asset Processing: HTML/CSS/JS minification and optimization
MIME Handling: Automatic content-type detection and serving
Data Processing: Template data injection and transformation
Markdown Support: Integrated Markdown to HTML conversion

Build System

Static Generation: Export static sites from dynamic JSDA applications
File Watching: Development mode with hot reload capabilities
Import Maps: Automatic generation of browser-compatible module maps
Asset Bundling: Real-time bundling with esbuild integration
Project Structure Analysis: Automated project tree generation

TypeScript Support

Type Definitions: Complete TypeScript definitions for JSDA configuration
IDE Integration: Enhanced development experience with IntelliSense

Use Cases

JAMStack Sites: Static site generation with dynamic capabilities
Micro-Frontends: Modular, distributed web application architecture
Rapid Prototyping: Quick setup for testing ideas and concepts
AI-Augmented Development: Integration-ready for AI-powered workflows
Component Libraries: Distributable web component ecosystems
Hybrid Applications: Mixed SSR/SPA applications with seamless transitions

Example Usage

Creating a Simple HTML Page

// pages/home.html.js
export default /*html*/ `
<!DOCTYPE html>
<html>
<head>
  <title>Welcome to JSDA</title>
</head>
<body>
  <h1>Hello, JSDA World!</h1>
  <p>Current time: ${new Date().toISOString()}</p>
</body>
</html>
`;

Building Dynamic CSS

// styles/theme.css.js
const primaryColor = '#007acc';
const secondaryColor = '#f0f0f0';

export default /*css*/ `
:root {
  --primary: ${primaryColor};
  --secondary: ${secondaryColor};
}

body {
  background: var(--secondary);
  color: var(--primary);
  font-family: system-ui, sans-serif;
}
`;

Web Component with SSR

// components/my-component/index.js
import { Symbiote } from '@symbiotejs/symbiote';

class MyComponent extends Symbiote {

  ssrMode = true;

  init$ = {
    message: 'Hello from Web Component!',
    timestamp: Date.now(),
  };
}

MyComponent.reg('my-component');

// SSR component template:
import myData from `../myData.js`;

export default /*html*/ `
<div>
  <p>${myData.message}</p>
  <my-another-component></my-another-component>
</div>
`;

// Component usage:
export  default /*html*/ `
<!-- Some HTML -->
  <my-component></my-component>
<!-- Some HTML -->
`;

Documentation

For detailed documentation, examples, and advanced usage patterns, visit:

Contributing

We welcome contributions! Please see our Contributing Guide and Code of Conduct.

Development Setup

# Clone the repository
git clone https://github.com/rnd-pro/jsda-kit.git
cd jsda-kit

# Install dependencies
npm install

# Run example with CLI
jsda serve

# Or run specific commands
jsda ssg     # Static Site Generation with watching
jsda build   # Build static files
jsda init # Create project structure

License

Related Projects

JSDA Manifest - JSDA concept and basic conventions description
Symbiote.js - Reactive Web Components framework

Made with ❤️ by the RND-PRO team