@orieljs/live 0.1.0-alpha.3

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,47 @@
+# @orieljs/live
+
+Server-side Live components for Oriel: Livewire-style components written in TSX, with signed snapshots, actions, events and `Live.test()`. Live is part of `@orieljs/framework`, which every Oriel app already installs, and is re-exported from it. Its semantics follow Livewire 3. In an app, import it from `@orieljs/framework` only: `@orieljs/live` is also published on its own, but a separate copy doesn't share the framework's per-request state.
+
+```bash
+npm install @orieljs/framework
+```
+
+```tsx
+// app/Live/Counter.tsx
+import { Component } from '@orieljs/framework'
+
+export default class Counter extends Component {
+  count = 0
+
+  increment() {
+    this.count++
+  }
+
+  render() {
+    return <button o:click="increment">{this.count}</button>
+  }
+}
+```
+
+```ts
+// routes/web.ts
+import { Route } from '@orieljs/framework'
+import Counter from '../app/Live/Counter'
+
+Route.get('/counter', Counter)
+```
+
+Embed a component in any view with `<Live component={Counter} />`. In the browser, components are driven by `@orieljs/live-client`.
+
+Known limitations:
+
+- `o:navigate` does not run scripts in the new page.
+- A DOM event whose name contains `-` can't be written as `o:<event>` in TSX, because modifiers are `-` segments (for example `o:model-live`).
+
+Status: early alpha. APIs will change.
+
+## License
+
+Oriel is open-source software licensed under the Apache License 2.0 (Apache-2.0; see `LICENSE` and `NOTICE`). The Oriel name and logo are trademarks; see [`TRADEMARKS.md`](https://github.com/orieljs/framework/blob/main/TRADEMARKS.md).
+
+Website: https://orieljs.vercel.app

package/dist/index.d.ts

@@ -0,0 +1,258 @@
+import { Class, Rules, MessageBag, LiveEffects, Htmlable, LiveSnapshot, LiveManager, Application, HttpRequest, LiveUpdateRequest, LiveUpdateResponse, OrielError, ErrorKind } from '@orieljs/contracts';
+import { ServiceProvider } from '@orieljs/support';
+
+/** Marks Live component classes (Symbol.for, so two copies of the package agree). */
+declare const COMPONENT: unique symbol;
+/** A browser event queued by dispatch(). `to` is resolved to a component name when the effects are built. */
+interface QueuedDispatch {
+    name: string;
+    params: Record<string, unknown>;
+    self?: true;
+    to?: string | Class<Component>;
+}
+/** The validation errors of a component (Laravel's MessageBag), for render(): `this.errors.first('title')`. */
+declare class ErrorBag implements MessageBag {
+    private readonly messages;
+    constructor(messages: Record<string, string[]>);
+    has(key: string): boolean;
+    first(key?: string): string | undefined;
+    get(key: string): string[];
+    all(): string[];
+    any(): boolean;
+    isEmpty(): boolean;
+    count(): number;
+    toObject(): Record<string, string[]>;
+}
+/** What dispatch() returns: `this.dispatch('saved').self()` or `.to(Sidebar)`. */
+declare class PendingEvent {
+    private readonly event;
+    constructor(event: QueuedDispatch);
+    /** Only this component's own listeners receive the event. */
+    self(): this;
+    /** Only components of this class (or registered name) receive the event. */
+    to(component: string | Class<Component>): this;
+}
+/**
+ * A Live component (Livewire 3): public fields are its state, public methods are actions the browser can call, and
+ * render() returns its TSX. Lifecycle hooks, all optional: `boot()`, `mount(params)`, `hydrate()`, `dehydrate()`,
+ * `updating(name, value)`/`updated(name, value)` and per property `updatingTitle(value)`/`updatedTitle(value)`,
+ * `rendering()`/`rendered(html)`. Fields that must not be state use `#private` syntax.
+ */
+declare abstract class Component {
+    static readonly [COMPONENT] = true;
+    /** The view that wraps a full-page component (default: config `live.layout`). */
+    static layout?: string;
+    /** The page title passed to the layout as `title`. */
+    static title?: string;
+    /** Static fallbacks for runtimes without decorators: { event: 'method' }, locked names, computed getter names. */
+    static listeners?: Record<string, string>;
+    static locked?: string[];
+    static computed?: string[];
+    abstract render(): unknown;
+    getId(): string;
+    getName(): string;
+    /** Dispatches a browser event; every component listening for it (@On) runs its handler. */
+    dispatch(name: string, params?: Record<string, unknown>): PendingEvent;
+    /** Sends the browser to `url` after this request; `navigate` uses o:navigate instead of a full page load. */
+    redirect(url: string, options?: {
+        navigate?: boolean;
+    }): void;
+    redirectRoute(name: string, parameters?: unknown, options?: {
+        navigate?: boolean;
+    }): void;
+    /**
+     * Validates the public state. On success clears the error bag and returns the validated data; on failure fills the
+     * error bag and throws (the rest of the action is skipped and the component re-renders with `errors`).
+     */
+    validate<T = Record<string, unknown>>(rules: Rules, messages?: Record<string, string>, attributes?: Record<string, string>): Promise<T>;
+    addError(key: string, message: string): void;
+    /** Clears every error, or only those of `keys`. */
+    resetErrorBag(...keys: string[]): void;
+    get errors(): ErrorBag;
+    /** Puts public properties (all of them when none are named) back to their initial values. */
+    reset(...properties: string[]): void;
+    /** Keeps the current HTML: the response carries the new state but no `html` effect. */
+    skipRender(): void;
+    /** A full-page component as a route action: Route.get('/counter', Counter). Route parameters go to mount(). */
+    __invoke(): Promise<unknown>;
+}
+
+/** @On('post-created'): calls the method when the event is dispatched (by this or any component, or the browser). */
+declare function On(event: string): (_method: unknown, context: ClassMethodDecoratorContext) => void;
+/** @Locked: a property the browser can't change, or a method the browser can't call. */
+declare function Locked(_target: unknown, context: ClassFieldDecoratorContext | ClassMethodDecoratorContext): void;
+/** @Computed: a getter cached for the rest of the request, never part of the component's state. */
+declare function Computed<T>(getter: (this: object) => T, context: ClassGetterDecoratorContext): (this: object) => T;
+
+/**
+ * Livewire's Livewire::test(): drives one component through the real mount → snapshot → checksum → update pipeline
+ * (no HTTP). Actions are async (`await counter.call('increment')`); assertions are sync and return `this`.
+ */
+declare class Testable<C extends Component = Component> {
+    #private;
+    private readonly manager;
+    private constructor();
+    /** Mounts `component` with `params`, as `<Live component={…} {...params} />` would. */
+    static create<C extends Component>(component: Class<C> | string, params?: Record<string, unknown>): Promise<Testable<C>>;
+    /** The component instance after the last request. */
+    instance(): C;
+    /** A public property (dotted paths reach into arrays and objects). */
+    get<T = unknown>(path: string): T;
+    /** The last rendered HTML, without the o:id, o:snapshot and o:effects attributes (Livewire strips them too). */
+    html(): string;
+    /** The effects of the last request. */
+    effects(): LiveEffects;
+    set(path: string | Record<string, unknown>, value?: unknown): Promise<this>;
+    call(method: string, ...params: unknown[]): Promise<this>;
+    toggle(path: string): Promise<this>;
+    /** Dispatches an event to this component, as the browser does for its listeners. */
+    dispatch(event: string, params?: Record<string, unknown>): Promise<this>;
+    refresh(): Promise<this>;
+    assertSet(path: string, value: unknown): this;
+    assertNotSet(path: string, value: unknown): this;
+    /** Each value, HTML-escaped, appears in the rendered HTML. */
+    assertSee(...values: string[]): this;
+    assertDontSee(...values: string[]): this;
+    /** Each value appears in the rendered HTML as written (not escaped). */
+    assertSeeHtml(...values: string[]): this;
+    assertDispatched(name: string, params?: Record<string, unknown>): this;
+    assertNotDispatched(name: string): this;
+    /** The error bag has errors for every key given (or any error at all with no keys). */
+    assertHasErrors(keys?: string | string[]): this;
+    /** No errors for the keys given (or none at all with no keys). */
+    assertHasNoErrors(keys?: string | string[]): this;
+    assertRedirect(url?: string): this;
+    assertNoRedirect(): this;
+    /** The last call returned `value`. */
+    assertReturned(value: unknown): this;
+}
+
+/** Props of `<Live component={Counter} count={3} o:key="c1" />`: the rest become mount params. */
+interface LiveProps {
+    component: Class<Component> | string;
+    /** Identifies a child inside its parent across re-renders (Livewire's :key / wire:key). */
+    'o:key'?: string | number;
+    [param: string]: unknown;
+}
+/** Blade's @livewire('counter', ['count' => 3], key('c1')): the component's first render, as trusted HTML. */
+declare function live(component: Class<Component> | string, params?: Record<string, unknown>, key?: string | number): Promise<Htmlable>;
+/** `<Live component={Counter} />` in any view or component. */
+declare function LiveComponent({ component, 'o:key': key, children: _children, ...params }: LiveProps): Promise<Htmlable>;
+/** The `<Live />` element, and the Live facade: Live.component(name, Class), Live.test(Component). */
+declare const Live: typeof LiveComponent & {
+    /** Registers a component under a name (components in app/Live are registered at boot). */
+    component(name: string, component: Class<Component>): void;
+    /** Livewire::test(): mounts `component` for assertions. */
+    test<C extends Component>(component: Class<C> | string, params?: Record<string, unknown>): Promise<Testable<C>>;
+};
+
+type Call = {
+    method: string;
+    params: unknown[];
+};
+/** One component after a mount or an update: the live instance (for Live.test), its snapshot, effects and HTML. */
+interface ComponentResult {
+    instance: Component;
+    snapshot: LiveSnapshot;
+    effects: LiveEffects;
+    /** The rendered HTML with o:id (and, after a mount, o:snapshot/o:effects); undefined after skipRender(). */
+    html?: string;
+    tag?: string;
+}
+/** Livewire's update request handling and first render, on Oriel's contracts. */
+declare class LiveComponentManager implements LiveManager {
+    private readonly app;
+    constructor(app: Application);
+    /** The request scope when there is one (sessions, the current route), else the application. */
+    private container;
+    private registry;
+    /** Live.component('counter', Counter): registers a component under a name the snapshots use. */
+    register(component: Class<unknown>, name?: string): void;
+    /** The registered name of a component class, registering it under its kebab-case class name the first time. */
+    nameOf(component: Class<Component>): string;
+    resolve(name: string): Class<Component>;
+    isLiveRequest(request: HttpRequest): boolean;
+    /** The first render: HTML with o:id, o:snapshot and o:effects on the root element. */
+    mount(component: string | Class<unknown>, params?: Record<string, unknown>, key?: string): Promise<string>;
+    mountComponent(component: string | Class<unknown>, params?: Record<string, unknown>, existing?: Component): Promise<ComponentResult>;
+    /** Applies each component's updates and calls, re-renders it and returns its new snapshot and effects. */
+    update(request: LiveUpdateRequest): Promise<LiveUpdateResponse>;
+    updateComponent(snapshotJson: string, updates: Record<string, unknown>, calls: Call[]): Promise<ComponentResult>;
+    /** The route action of POST /oriel/live/update. */
+    handle(request: HttpRequest): Promise<LiveUpdateResponse>;
+    /** A full-page component (Route.get('/counter', Counter)): mounted with the route parameters, inside the layout. */
+    page(component: Component): Promise<unknown>;
+    /** Parses and checks a snapshot: a bad checksum throws before anything is hydrated. */
+    private verify;
+    private key;
+    /** The request body, read from the raw JSON when the request has it, so TrimStrings can't alter typed values. */
+    private payload;
+    /** Makes every computed getter (static `computed` too) cache its value for the rest of the request. */
+    private prepareComputed;
+    private applyUpdate;
+    /** Runs one call from the browser: a magic action, an event, or a public method. Returns its return value. */
+    private call;
+    /** Renders the component (rendering/rendered hooks, nested children tracked) and checks for a single root. */
+    private render;
+    /** Dispatches, redirects: the effects every response carries. */
+    private effects;
+    /** dehydrate() hook, then the state as snapshot data, the error bag, and the checksum over both. */
+    private snapshot;
+}
+
+/** The URI the client runtime posts updates to. */
+declare const UPDATE_URI = "/oriel/live/update";
+/**
+ * Binds the LiveManager, merges the `live` config, registers POST /oriel/live/update (named `live.update`, in the `web`
+ * group: sessions and CSRF apply), the make:live command, and the components under app/Live.
+ */
+declare class LiveServiceProvider extends ServiceProvider {
+    register(): void;
+    boot(): Promise<void>;
+}
+
+/** A component's Livewire name from its path under app/Live: Posts/CreatePost.tsx → posts.create-post. */
+declare function componentName(file: string): string;
+
+/** A Live programming error (unsupported state, a missing root element, an unknown component): a 500. */
+declare class LiveError extends Error implements OrielError {
+    readonly name: string;
+    readonly kind: ErrorKind;
+    readonly status: number;
+}
+/** A snapshot whose checksum doesn't match (tampered with, or signed with another APP_KEY). Nothing is hydrated. */
+declare class CorruptComponentPayloadError extends LiveError {
+    readonly name: string;
+    readonly kind: ErrorKind;
+    readonly status: number;
+    constructor(component?: string);
+}
+/** The browser asked for a method that isn't a public action of the component. */
+declare class MethodNotCallableError extends LiveError {
+    readonly name: string;
+    readonly kind: ErrorKind;
+    readonly status: number;
+    constructor(method: string, component: string);
+}
+/** The browser tried to set a property that is locked, computed, private (`_x`) or not declared. */
+declare class PropertyNotUpdatableError extends LiveError {
+    readonly name: string;
+    readonly kind: ErrorKind;
+    readonly status: number;
+    constructor(path: string, component: string);
+}
+/** A snapshot names a component that isn't registered. */
+declare class LiveComponentNotFoundError extends LiveError {
+    readonly name: string;
+    readonly kind: ErrorKind;
+    readonly status: number;
+    constructor(component: string);
+}
+/** An update request without the X-Oriel-Live header or with a malformed body. */
+declare class InvalidLiveRequestError extends LiveError {
+    readonly name: string;
+    readonly kind: ErrorKind;
+    readonly status: number;
+}
+
+export { Component, type ComponentResult, Computed, CorruptComponentPayloadError, ErrorBag, InvalidLiveRequestError, Live, LiveComponentManager, LiveComponentNotFoundError, LiveError, type LiveProps, LiveServiceProvider, Locked, MethodNotCallableError, On, PendingEvent, PropertyNotUpdatableError, Testable, UPDATE_URI, componentName, live };