Flash5/flash-extensions/flash-ext-view-jte/README.md

flash-ext-view-jte

Opinionated jte SSR extension for Flash.

This module keeps jte semantics front and center:

• JteExtension
• JteHandler
• @Template
• ViewModel from flash-ext-view-core
• global.* reserved namespace

The extension mirrors gg.jte.ContentType into Flash HTTP content type:

• gg.jte.ContentType.Html -> text/html
• gg.jte.ContentType.Plain -> text/plain

Static serving (opinionated)

Static serving is enabled by default and serves classpath assets from /static/** (src/main/resources/static/**) on an HTTP wildcard route.

Defaults:

• serveStatics = true
• staticPrefix = "/static"
• ETag via CRC32 + length
• 304 Not Modified on If-None-Match
• pre-compressed .gz support when client sends Accept-Encoding: gzip
• MIME auto-resolution for common web/media/font/wasm types
• cache policy:
  • versioned assets (file.<hash>.ext or query ?v=... / ?hash=...) -> public, max-age=31536000, immutable
  • non-versioned -> no-cache
• byte-range support for large files (threshold configurable, default 64 KiB)

If classpath /static is missing, extension logs a warning and disables static routes.

Configuration examples

// option 1: customizer constructor
app.install(new JteExtension(cfg -> cfg
    .templateRoot("/templates")
    .serveStatics(true)
    .staticPrefix("/assets")));

// option 2: fluent style
app.install(new JteExtension()
    .templateRoot("/templates")
    .withStaticServing()
    .staticPrefix("/assets"));

Disable static serving:

app.install(new JteExtension().serveStatics(false));

Enable static CORS (default disabled):

app.install(new JteExtension().staticCors(cfg -> cfg
    .enableStaticCors(true)
    .staticCorsAllowOrigin("*")
    .staticCorsAllowMethods("GET,HEAD,OPTIONS")
    .staticCorsAllowHeaders("*")
    .staticCorsMaxAge(3600)));

Quick Start

import dev.relism.extension.FlashApp;
import dev.relism.ext.view.core.ViewModel;
import dev.relism.ext.view.jte.*;

FlashApp.create(8080)
    .install(new JteExtension(cfg -> cfg
        .templateRoot("/templates")
        .contentType(gg.jte.ContentType.Html)))
    .scan("com.example.web")
    .startAndBlock();

import dev.relism.ext.view.core.ViewModel;
import dev.relism.ext.view.jte.*;
import dev.relism.routing.GET;

@GET("/")
@Template("pages/home.jte")
public final class HomePage extends JteHandler {
    @Override
    public ViewModel render(dev.relism.models.Request req) {
        return ViewModel.empty()
            .with("page", new HomePageModel("Flash + jte", "elorc"))
            .with("build", "dev");
    }

    public record HomePageModel(String title, String author) {}
}

Docs

• docs/architecture.md
• docs/handlers.md
• docs/model-and-globals.md
• docs/performance.md