@orieljs/framework 0.1.0-alpha.5 → 0.1.0-alpha.7

package/dist/{jsx-runtime-WKTl3EEw.d.ts → jsx-runtime-6um4Mwfb.d.ts}

@@ -1,50 +1,5 @@
-import { Token } from './contracts.js';
-import { S as ServiceProvider$1, A as Application } from './index.d-DOlTeG-8.js';
-
-interface Htmlable {
-    toHtml(): string;
-}
-
-interface View$1 extends Htmlable {
-    readonly name: string;
-    with(key: string | Record<string, unknown>, value?: unknown): this;
-    render(): Promise<string>;
-}
-/** Resolves 'posts.index' → resources/views/posts/index.tsx and renders it to HTML on the server. */
-interface ViewFactory {
-    make(name: string, data?: Record<string, unknown>): View$1;
-    exists(name: string): boolean;
-    share(key: string | Record<string, unknown>, value?: unknown): void;
-    composer(views: string | string[], composer: (view: View$1) => void | Promise<void>): void;
-    /** Renders TSX (an element, a string, an Htmlable, a View, promises of them) to HTML, like Blade::render(). */
-    renderToString(node: unknown): Promise<string>;
-}
-declare const ViewFactory: Token<ViewFactory>;
-
-type ErrorKind = 'Http' | 'Server' | 'ModelNotFound' | 'Validation' | 'Authentication' | 'Authorization' | 'TokenMismatch' | 'BindingResolution' | 'CircularDependency' | 'ContainerNotAvailable';
-/** Every error thrown by the framework implements this. The exception handler switches on `kind`. */
-interface OrielError extends Error {
-    readonly kind: ErrorKind;
-    /** HTTP status the error should render as, when relevant. */
-    readonly status?: number;
-    readonly headers?: Record<string, string>;
-}
-
-declare abstract class ServiceProvider implements ServiceProvider$1 {
-    protected readonly app: Application;
-    constructor(app: Application);
-    register(): void;
-    boot(): void | Promise<void>;
-    /** Package defaults under `key`; values the app already set win (shallow merge, like Laravel). */
-    protected mergeConfigFrom(defaults: Record<string, unknown>, key: string): void;
-}
-
-interface FacadeStatics<T> {
-    getFacadeRoot(): T;
-    /** Replace the instance in the current container (used by X.fake()). */
-    swap(instance: T): void;
-}
-type Facade<T, X = object> = T & X & FacadeStatics<T>;
+import { Htmlable, OrielError, ErrorKind, View as View$1, ViewFactory } from './contracts.js';
+import { F as Facade, S as ServiceProvider } from './index.d-WQpfdIbG.js';
 
 /** Marks the objects jsx() returns (Symbol.for, so two copies of the package agree). */
 declare const ELEMENT: unique symbol;
@@ -97,6 +52,93 @@ declare function renderToString(node: Renderable): Promise<string>;
 /** Renders to a UTF-8 byte stream, sending everything rendered so far each time rendering waits on a promise. */
 declare function renderToStream(node: Renderable): ReadableStream<Uint8Array>;
 
+/**
+ * The `o:` attributes of Live components, typed for TSX: a directive (`o:model`, `o:loading`, …) or an action on a DOM
+ * event (`o:click="save"`), with modifiers joined by `-` (`o:model-live`, `o:keydown-enter`). An `o:` name that is
+ * neither doesn't compile (`o:clik`, `o:modle`), and the forms listed here are completed by editors and have their
+ * values checked. TypeScript doesn't check JSX attribute names that contain a `-` unless the type lists them, so a
+ * form that isn't listed (a duration such as `o:model-live-debounce-500ms`, an event's modifiers) is accepted as
+ * written, and so is a misspelt one (`o:model-lvie`).
+ */
+type ModelTrigger = 'live' | 'blur' | 'change' | 'lazy';
+type ElementChange = 'remove' | 'class' | 'class-remove' | 'attr';
+/**
+ * The directives that aren't DOM events, by name: the value each takes (`boolean` for one that can be written bare,
+ * `<a o:navigate>`, or from an expression, `o:navigate={external}`: `false` leaves it out) and its modifier forms, the
+ * `-`-joined text after the name (`never` for none). A new directive adds a member here, and its name to the Live
+ * client's reserved directives.
+ */
+interface LiveDirectives {
+    /** o:model="title": binds an input to a public property, sent with the next request unless live, blur, change or lazy. */
+    model: {
+        value: string;
+        modifiers: ModelTrigger | 'number' | 'debounce' | 'live-debounce' | `${ModelTrigger}-number`;
+    };
+    /** o:loading: shown (or changed) while the component's request runs. */
+    loading: {
+        value: boolean | string;
+        modifiers: ElementChange | 'delay' | `delay-${ElementChange}`;
+    };
+    /** o:target="save,title": the actions or properties o:loading waits for. */
+    target: {
+        value: string;
+        modifiers: never;
+    };
+    /** o:poll="refresh": calls the method ($refresh without one) every 2.5 s, or every `o:poll-<n>s`. */
+    poll: {
+        value: boolean | string;
+        modifiers: 'keep-alive' | 'visible';
+    };
+    /** o:navigate on a link: fetches the page and swaps it in; `-hover` prefetches on hover. */
+    navigate: {
+        value: boolean;
+        modifiers: 'hover';
+    };
+    /** o:offline: shown (or changed) while the browser is offline. */
+    offline: {
+        value: boolean | string;
+        modifiers: ElementChange;
+    };
+    /** o:key: keeps an element's identity across re-renders. */
+    key: {
+        value: string | number;
+        modifiers: never;
+    };
+    /** o:confirm="Delete this tag?": asks before the element's action runs; `-prompt` asks for a typed answer. */
+    confirm: {
+        value: boolean | string;
+        modifiers: 'prompt';
+    };
+    /** o:announce on a status region: an action that leaves the same message announces it again. */
+    announce: {
+        value: boolean;
+        modifiers: never;
+    };
+}
+/**
+ * The DOM events `o:<event>` runs an action on. A name with a `-` can't be written in TSX (modifiers are `-`
+ * segments), and `offline` is the o:offline directive, not the event. An event this list doesn't have (a custom
+ * event a component dispatches) is spread: `<div {...{ 'o:saved': 'refresh' }} />`.
+ */
+type LiveEvent = 'click' | 'dblclick' | 'auxclick' | 'contextmenu' | 'mousedown' | 'mouseup' | 'mousemove' | 'mouseover' | 'mouseout' | 'mouseenter' | 'mouseleave' | 'wheel' | 'pointerdown' | 'pointerup' | 'pointermove' | 'pointerover' | 'pointerout' | 'pointerenter' | 'pointerleave' | 'pointercancel' | 'gotpointercapture' | 'lostpointercapture' | 'keydown' | 'keyup' | 'keypress' | 'input' | 'beforeinput' | 'change' | 'submit' | 'reset' | 'invalid' | 'select' | 'formdata' | 'search' | 'focus' | 'blur' | 'focusin' | 'focusout' | 'copy' | 'cut' | 'paste' | 'drag' | 'dragstart' | 'dragend' | 'dragenter' | 'dragleave' | 'dragover' | 'drop' | 'touchstart' | 'touchend' | 'touchmove' | 'touchcancel' | 'compositionstart' | 'compositionupdate' | 'compositionend' | 'play' | 'pause' | 'playing' | 'ended' | 'timeupdate' | 'volumechange' | 'ratechange' | 'durationchange' | 'loadstart' | 'loadeddata' | 'loadedmetadata' | 'canplay' | 'canplaythrough' | 'seeking' | 'seeked' | 'waiting' | 'stalled' | 'suspend' | 'emptied' | 'progress' | 'abort' | 'error' | 'load' | 'animationstart' | 'animationend' | 'animationiteration' | 'animationcancel' | 'transitionstart' | 'transitionend' | 'transitionrun' | 'transitioncancel' | 'scroll' | 'scrollend' | 'resize' | 'toggle' | 'beforetoggle' | 'close' | 'cancel' | 'online' | 'popstate' | 'hashchange' | 'beforeunload' | 'pagehide' | 'pageshow' | 'storage' | 'message' | 'visibilitychange' | 'selectionchange' | 'fullscreenchange' | 'slotchange' | 'cuechange';
+/** `o:model`, `o:model-live`, …: each directive and each of its modifier forms, with the directive's value. */
+type LiveDirectiveAttributes = {
+    [N in keyof LiveDirectives as `o:${N}` | `o:${N}-${LiveDirectives[N]['modifiers']}`]?: LiveDirectives[N]['value'];
+};
+/** `o:click="save"`: an action (a method, `method(args)`, `$refresh`, `$set(…)`, `$dispatch(…)`) on a DOM event. */
+type LiveEventAttributes = {
+    [E in LiveEvent as `o:${E}`]?: string;
+};
+type Letter = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z';
+type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
+/**
+ * Every other attribute, with any value: each name that doesn't start with `o:` (`o`, `href`, `onclick`, `open`,
+ * `xlink:href`, `viewBox`; names with a `-`, such as `data-*`, `aria-*` and `hx-post`, are never checked).
+ */
+type OtherAttributes = {
+    [K in 'o' | `${Exclude<Letter, 'o'> | Uppercase<Letter> | '_' | '$'}${string}` | `o${Letter | Uppercase<Letter> | Digit | '_' | '.' | '$'}${string}`]?: unknown;
+};
+
 /**
  * The automatic JSX runtime (`jsxImportSource: "@orieljs/view"`). jsx() only describes elements; rendering
  * (escaping, async components) happens in renderToString()/renderToStream().
@@ -105,8 +147,13 @@ declare function renderToStream(node: Renderable): ReadableStream<Uint8Array>;
 declare function jsx(type: ElementType, props: Props | null, key?: string | number): OrielElement;
 /** Same as jsx(); the compiler uses it when there are several static children. */
 declare const jsxs: typeof jsx;
-/** Attributes every intrinsic element accepts. Unknown attributes (hx-*, x-*, o:click, …) are allowed. */
-interface HtmlAttributes {
+/**
+ * Attributes every intrinsic element accepts. Any attribute is allowed (hx-*, x-*, data-*, …) except an `o:` name
+ * that isn't a Live directive or `o:<event>` (directives.ts), so a typo such as `o:clik` doesn't compile. An `o:` form
+ * with a `-` that the type doesn't list compiles unchecked (TypeScript doesn't check a hyphenated JSX name the type
+ * leaves out), and a custom event name is spread: `<div {...{ 'o:saved': 'refresh' }} />`.
+ */
+interface HtmlAttributes extends OtherAttributes, LiveDirectiveAttributes, LiveEventAttributes {
     children?: Renderable;
     class?: ClassValue;
     className?: ClassValue;
@@ -114,7 +161,6 @@ interface HtmlAttributes {
     dangerouslySetInnerHTML?: {
         __html: string;
     };
-    [attribute: string]: unknown;
 }
 declare namespace JSX {
     type Element = OrielElement;
@@ -251,4 +297,4 @@ declare class ViewServiceProvider extends ServiceProvider {
     register(): void;
 }
 
-export { type ClassValue as C, ELEMENT as E, FileViewFinder as F, type HtmlAttributes as H, InvalidViewError as I, JSX as J, type OrielElement as O, type Props as P, type Renderable as R, type StyleObject as S, TsxView as T, View as V, Fragment as a, HtmlString as b, type Component as c, type ViewEnvironment as d, Factory as e, ViewNotFoundError as f, ViewRenderError as g, ViewServiceProvider as h, classNames as i, createElement as j, csrfField as k, e as l, isElement as m, isHtmlable as n, methodField as o, renderToStream as p, renderToString as q, raw as r, styleString as s, jsx as t, jsxs as u, view as v };
+export { type ClassValue as C, ELEMENT as E, FileViewFinder as F, type HtmlAttributes as H, InvalidViewError as I, JSX as J, type LiveDirectives as L, type OrielElement as O, type Props as P, type Renderable as R, type StyleObject as S, TsxView as T, View as V, Fragment as a, HtmlString as b, type LiveEvent as c, type Component as d, type ViewEnvironment as e, Factory as f, ViewNotFoundError as g, ViewRenderError as h, ViewServiceProvider as i, classNames as j, createElement as k, csrfField as l, e as m, isElement as n, isHtmlable as o, methodField as p, renderToStream as q, raw as r, renderToString as s, styleString as t, jsx as u, view as v, jsxs as w };

package/dist/jsx-runtime.d.ts

@@ -1,3 +1,3 @@
-export { a as Fragment, H as HtmlAttributes, J as JSX, t as jsx, u as jsxs } from './jsx-runtime-WKTl3EEw.js';
+export { a as Fragment, H as HtmlAttributes, J as JSX, u as jsx, w as jsxs } from './jsx-runtime-6um4Mwfb.js';
 import './contracts.js';
-import './index.d-DOlTeG-8.js';
+import './index.d-WQpfdIbG.js';

package/dist/jsx-runtime.js

@@ -2,9 +2,9 @@ import {
   Fragment,
   jsx,
   jsxs
-} from "./chunk-A5XRLEWM.js";
-import "./chunk-PM5YTG57.js";
-import "./chunk-BSQKOLSK.js";
+} from "./chunk-VOYW3R5J.js";
+import "./chunk-7ZQZYDOC.js";
+import "./chunk-GVNLZZTN.js";
 export {
   Fragment,
   jsx,