@orieljs/framework 0.1.0-alpha.0 → 0.1.0-alpha.10

package/dist/jsx-runtime-6um4Mwfb.d.ts

@@ -0,0 +1,300 @@
+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;
+type Props = Record<string, unknown>;
+/** Anything that can appear as a child: text is escaped, Htmlable is emitted as-is, promises are awaited. */
+type Renderable = OrielElement | string | number | bigint | boolean | null | undefined | Htmlable | Promise<Renderable> | Iterable<Renderable>;
+/** A function component. It may be async: the renderer awaits it. */
+type Component<P = Props> = (props: P) => Renderable | Promise<Renderable>;
+/**
+ * `<>…</>` and `<Fragment>`: renders its children only. A symbol at runtime; typed as a component so that
+ * `<Fragment>` type-checks as a JSX tag.
+ */
+declare const Fragment: (props: {
+    children?: Renderable;
+}) => Renderable;
+type ElementType = string | Component<never>;
+/** What `<div />` evaluates to: an inert description, rendered later by renderToString()/renderToStream(). */
+interface OrielElement {
+    readonly [ELEMENT]: true;
+    readonly type: ElementType;
+    readonly props: Props;
+    readonly key: string | number | undefined;
+}
+declare function createElement(type: ElementType, props: Props | null | undefined, key?: string | number): OrielElement;
+declare function isElement(value: unknown): value is OrielElement;
+
+/** Markup that must not be escaped again (Laravel's Illuminate\Support\HtmlString). */
+declare class HtmlString implements Htmlable {
+    private readonly html;
+    constructor(html?: string);
+    toHtml(): string;
+    toString(): string;
+    isEmpty(): boolean;
+}
+/** Marks trusted markup so the renderer emits it unescaped: {raw(markdownHtml)}. Never pass user input. */
+declare function raw(html: string): HtmlString;
+declare function isHtmlable(value: unknown): value is Htmlable;
+/** Laravel's e(): htmlspecialchars(ENT_QUOTES, double-encode). Htmlable values pass through; null is ''. */
+declare function e(value: unknown): string;
+
+type ClassValue = string | number | null | undefined | false | ClassValue[] | Record<string, unknown>;
+type StyleObject = Record<string, string | number | null | undefined | false>;
+/** `class` accepts strings, arrays and `{ name: condition }` objects, like Blade's @class. */
+declare function classNames(value: ClassValue): string;
+/** `{ marginTop: 4, '--gap': '1rem' }` → `margin-top:4px;--gap:1rem`. */
+declare function styleString(style: StyleObject): string;
+
+/** Renders JSX (or any Renderable) to an HTML string. Async components and promises are awaited in order. */
+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().
+ */
+
+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. 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;
+    style?: string | StyleObject;
+    dangerouslySetInnerHTML?: {
+        __html: string;
+    };
+}
+declare namespace JSX {
+    type Element = OrielElement;
+    /** Lets components be async: `async function Posts() { … }` is a valid element type. */
+    type ElementType = string | Component<never>;
+    interface ElementChildrenAttribute {
+        children: unknown;
+    }
+    interface IntrinsicAttributes {
+        key?: string | number;
+    }
+    interface IntrinsicElements {
+        [element: string]: HtmlAttributes;
+    }
+}
+
+/**
+ * Programmer errors (Laravel throws InvalidArgumentException for these). Not an HTTP condition, so kind 'Server':
+ * the exception handler reports them and renders a 500 whose message is hidden unless app.debug is on.
+ */
+declare class ViewRenderError extends Error implements OrielError {
+    readonly name: string;
+    readonly kind: ErrorKind;
+    readonly status = 500;
+}
+/** Laravel's "View [x] not found." (InvalidArgumentException). */
+declare class ViewNotFoundError extends Error implements OrielError {
+    readonly view: string;
+    readonly searched: string[];
+    readonly name: string;
+    readonly kind: ErrorKind;
+    readonly status = 500;
+    constructor(view: string, searched?: string[]);
+}
+/** A view file that doesn't default-export a component. */
+declare class InvalidViewError extends Error implements OrielError {
+    readonly name: string;
+    readonly kind: ErrorKind;
+    readonly status = 500;
+}
+
+/**
+ * Laravel's FileViewFinder: 'posts.index' → <location>/posts/index.<ext> for the first location and extension
+ * that exist. Found paths are cached; misses are not, so a view created later is found.
+ */
+declare class FileViewFinder {
+    private readonly extensions;
+    static readonly defaultExtensions: string[];
+    private readonly locations;
+    private readonly hints;
+    private readonly views;
+    constructor(paths: string[], extensions?: string[]);
+    /** The absolute path of the view file. Throws ViewNotFoundError. */
+    find(name: string): string;
+    addLocation(path: string): void;
+    prependLocation(path: string): void;
+    /** Views under a namespace: addNamespace('mail', dir) makes 'mail::message' resolve to <dir>/message.tsx. */
+    addNamespace(namespace: string, hints: string | string[]): void;
+    replaceNamespace(namespace: string, hints: string | string[]): void;
+    getPaths(): string[];
+    getHints(): Record<string, string[]>;
+    /** Forget cached lookups. */
+    flush(): void;
+    /** [locations to search, relative file stem]. Dots become directories, so '..' can't climb out of a location. */
+    private parse;
+}
+
+/** What TsxView needs from its factory. */
+interface ViewEnvironment {
+    getShared(): Record<string, unknown>;
+    callComposer(view: View$1): Promise<void>;
+    load(path: string, name: string): Promise<Component>;
+}
+/**
+ * One view: its name, file and data. render() runs the composers, imports the file and renders its default
+ * export with { ...shared, ...data } as props. toHtml() returns the HTML of the last render().
+ */
+declare class TsxView implements View$1 {
+    private readonly environment;
+    readonly name: string;
+    readonly path: string;
+    private data;
+    private html;
+    constructor(environment: ViewEnvironment, name: string, path: string, data?: Record<string, unknown>);
+    with(key: string | Record<string, unknown>, value?: unknown): this;
+    /** The view's own data (Laravel's getData()). */
+    getData(): Record<string, unknown>;
+    /** Shared data overlaid with the view's data: exactly the props the component receives. */
+    gatherData(): Record<string, unknown>;
+    render(): Promise<string>;
+    toHtml(): string;
+}
+
+type Composer = (view: View$1) => void | Promise<void>;
+/** Laravel's view Factory: finds views by dotted name, shares data app-wide and runs view composers. */
+declare class Factory implements ViewFactory, ViewEnvironment {
+    private readonly finder;
+    private readonly shared;
+    private readonly composers;
+    constructor(finder: FileViewFinder);
+    /** Throws ViewNotFoundError ("View [x] not found.") when no file matches. */
+    make(name: string, data?: Record<string, unknown>): TsxView;
+    /** The first view that exists (Laravel's View::first()). */
+    first(names: string[], data?: Record<string, unknown>): TsxView;
+    exists(name: string): boolean;
+    /** App-wide data every view receives as props (view data wins on conflicts). */
+    share(key: string | Record<string, unknown>, value?: unknown): void;
+    getShared(): Record<string, unknown>;
+    /** Runs before matching views render. Patterns use `*` wildcards: 'posts.*', '*'. */
+    composer(views: string | string[], composer: Composer): void;
+    callComposer(view: View$1): Promise<void>;
+    /** Renders TSX, a string, an Htmlable or a View (or promises of them) to HTML, like Laravel's Blade::render(). */
+    renderToString(node: unknown): Promise<string>;
+    /** Imports the view file (Node's module cache keeps it) and returns its default-export component. */
+    load(path: string, name: string): Promise<Component>;
+    addLocation(path: string): void;
+    addNamespace(namespace: string, hints: string | string[]): this;
+    getFinder(): FileViewFinder;
+}
+
+/** view() → the ViewFactory; view('posts.index', data) → a View to return from a route or render. */
+declare function view(): ViewFactory;
+declare function view(name: string, data?: Record<string, unknown>): View$1;
+/** Blade's @csrf / csrf_field(): the hidden _token input for the current request's session. */
+declare function csrfField(): HtmlString;
+/** Blade's @method('PUT') / method_field(): spoofs PUT/PATCH/DELETE from an HTML form. */
+declare function methodField(method: string): HtmlString;
+
+/** The View facade: View.make(), View.exists(), View.share(), View.composer(), View.first(), View.addNamespace(). */
+declare const View: Facade<Factory, object>;
+
+/** Binds the ViewFactory (resources/views by default) and merges the `view` config, like Laravel's config/view.php. */
+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 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

@@ -0,0 +1,3 @@
+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-WQpfdIbG.js';

package/dist/jsx-runtime.js

@@ -0,0 +1,13 @@
+import {
+  Fragment,
+  jsx,
+  jsxs
+} from "./chunk-VOYW3R5J.js";
+import "./chunk-7ZQZYDOC.js";
+import "./chunk-GVNLZZTN.js";
+export {
+  Fragment,
+  jsx,
+  jsxs
+};
+//# sourceMappingURL=jsx-runtime.js.map

package/dist/jsx-runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}