@orieljs/framework 0.1.0-alpha.1 → 0.1.0-alpha.2

package/dist/contracts.d.ts

@@ -379,6 +379,8 @@ interface Router {
     match<C>(methods: string[], uri: string, action: ControllerAction<C> | RouteClosure | string): Route;
     redirect(from: string, to: string, status?: number): Route;
     view(uri: string, view: string, data?: Record<string, unknown>): Route;
+    /** Route.inertia('/about', 'About', props): a GET route that renders an Inertia page (Laravel's Route::inertia). */
+    inertia(uri: string, component: string, props?: Record<string, unknown>): Route;
     resource(name: string, controller: Class<unknown>, options?: ResourceOptions): void;
     apiResource(name: string, controller: Class<unknown>, options?: ResourceOptions): void;
     fallback(action: RouteAction): Route;
@@ -414,6 +416,15 @@ interface RouteModelResolver {
     resolveExplicit(model: Class<unknown>, value: string, field?: string): Promise<unknown>;
 }
 declare const RouteModelResolver: Token<RouteModelResolver>;
+/**
+ * Route name → parameters, for the typed route() and redirect().route() helpers. Empty until `oriel route:types`
+ * augments it (types/routes.d.ts); while it is empty any string is accepted. The contracts themselves keep taking
+ * strings: the framework builds route names at run time.
+ */
+interface RouteList {
+}
+/** A route name: the generated ones, or any string before `oriel route:types` has run. */
+type RouteName = [keyof RouteList] extends [never] ? string : Extract<keyof RouteList, string>;
 interface UrlGenerator {
     to(path: string, query?: Record<string, unknown>, absolute?: boolean): string;
     route(name: string, parameters?: unknown, absolute?: boolean): string;
@@ -1124,38 +1135,99 @@ interface FilesystemManager extends Filesystem {
 }
 declare const FilesystemManager: Token<FilesystemManager>;
 
-/** The Inertia page object (protocol v2). */
+/** Infinite-scroll metadata for one prop (page.scrollProps[path]). */
+interface InertiaScrollProp {
+    pageName: string;
+    previousPage: string | number | null;
+    nextPage: string | number | null;
+    currentPage: string | number | null;
+    reset: boolean;
+}
+/** A once prop the client keeps between visits (page.onceProps[key]). `expiresAt` is epoch milliseconds. */
+interface InertiaOnceProp {
+    prop: string;
+    expiresAt: number | null;
+}
+/**
+ * The Inertia page object (protocol v3, @inertiajs/core 3.x). Only component, props, url and version are always
+ * present; the other fields are left out when empty or false.
+ */
 interface InertiaPage {
     component: string;
     props: Record<string, unknown>;
+    /** Path and query, never absolute: '/posts?page=2'. */
     url: string;
-    version: string | null;
-    encryptHistory?: boolean;
-    clearHistory?: boolean;
+    /** '' when the app has no asset version. */
+    version: string;
+    sharedProps?: string[];
     mergeProps?: string[];
+    prependProps?: string[];
+    deepMergeProps?: string[];
+    /** '<prop path>.<key field>', e.g. 'posts.data.id'. */
+    matchPropsOn?: string[];
+    /** Group name → prop paths loaded after the first render. */
     deferredProps?: Record<string, string[]>;
+    rescuedProps?: string[];
+    scrollProps?: Record<string, InertiaScrollProp>;
+    onceProps?: Record<string, InertiaOnceProp>;
+    clearHistory?: true;
+    encryptHistory?: true;
+    flash?: Record<string, unknown>;
+    preserveFragment?: true;
 }
 interface InertiaResponse extends Responsable {
     with(key: string | Record<string, unknown>, value?: unknown): this;
     withViewData(key: string | Record<string, unknown>, value?: unknown): this;
+    rootView(view: string): this;
+    /** Flash data for the next page (page.flash), stored in the session. */
+    flash(key: string | Record<string, unknown>, value?: unknown): this;
 }
 type PropCallback<T = unknown> = () => T | Promise<T>;
+/** The SSR result spliced into the root view: the `head` tags and the rendered `body`. */
+interface InertiaSsrResponse {
+    head: string;
+    body: string;
+}
+/** Sends a page to the SSR server. Resolves to undefined when SSR is off, unreachable or failing. */
+interface InertiaSsrGateway {
+    dispatch(page: InertiaPage): Promise<InertiaSsrResponse | undefined>;
+}
+declare const InertiaSsrGateway: Token<InertiaSsrGateway>;
 interface InertiaFactory {
     render(component: string, props?: Record<string, unknown>): InertiaResponse;
     share(key: string | Record<string, unknown>, value?: unknown): void;
+    /** A shared once prop: sent on the first visit, then kept by the client. */
+    shareOnce(key: string, callback: PropCallback): void;
     getShared(key?: string): unknown;
-    version(version: string | (() => string | Promise<string>)): void;
+    flushShared(): void;
+    version(version: string | null | (() => string | null | Promise<string | null>)): void;
+    getVersion(): Promise<string>;
+    setRootView(view: string): void;
     /** Only evaluated on partial reloads that ask for it. */
     optional<T>(callback: PropCallback<T>): unknown;
     /** Loaded in a follow-up request after the first render. */
     defer<T>(callback: PropCallback<T>, group?: string): unknown;
     /** Always included, even in partial reloads. */
     always<T>(value: T | PropCallback<T>): unknown;
-    /** Merged with the existing client-side value instead of replacing it. */
+    /** Appended to the existing client-side value instead of replacing it. */
     merge<T>(value: T | PropCallback<T>): unknown;
-    /** 409 + X-Inertia-Location for external redirects. */
+    /** Deep-merged with the existing client-side value. */
+    deepMerge<T>(value: T | PropCallback<T>): unknown;
+    /** Resolved once, then remembered by the client. */
+    once<T>(callback: PropCallback<T>): unknown;
+    /** Infinite scroll over a paginator: merged page by page, with scroll metadata. */
+    scroll<T>(value: T | PropCallback<T>, wrapper?: string): unknown;
+    /** Flash data for the next page (page.flash), stored in the session. */
+    flash(key: string | Record<string, unknown>, value?: unknown): this;
+    encryptHistory(encrypt?: boolean): void;
+    /** The next page tells the client to clear its encrypted history. */
+    clearHistory(): void;
+    /** The next page keeps the URL fragment of the request that redirected to it. */
+    preserveFragment(): void;
+    /** 409 + X-Inertia-Location for Inertia requests, a plain 302 otherwise. */
     location(url: string): Response;
-    setRootView(view: string): void;
+    /** Redirect back (Inertia.flash('saved', true).back()). */
+    back(fallback?: string, status?: number): RedirectResponse;
 }
 declare const InertiaFactory: Token<InertiaFactory>;
 
@@ -1209,4 +1281,4 @@ interface LiveManager {
 }
 declare const LiveManager: Token<LiveManager>;
 
-export { type AbilityCallback, type Abstract, type ActionMethods, type Address, Application, type Arrayable, type Attachment, AuthFactory, type Authenticatable, type AuthenticationError, type Batch, BatchRepository, type BodyInit, BusDispatcher, CacheManager, type CacheRepository, type Class, ClassRegistry, type ClosureCommand, type Command, type CommandContext, type Concrete, type ConfigCallbacks, ConfigRepository, ConsoleKernel, Container, type Content, type ControllerAction, type Cookie, CookieJar, type Credentials, CurrentRoute, type DatabaseConnection, DatabaseManager, type DriverName, Encrypter, type Enumerable, type Envelope, type ErrorKind, EventDispatcher, ExceptionCallbacks, ExceptionHandler, type ExceptionsConfigurator, type Factory, type FailedJob, FailedJobProvider, type Filesystem, FilesystemManager, Gate, type Guard, Hasher, type HeadersInit, type Htmlable, HttpKernel, HttpRequest, InertiaFactory, type InertiaPage, type InertiaResponse, type Job, type Jsonable, type Listener, type ListenerClass, type LiveEffects, LiveManager, type LiveSnapshot, type LiveUpdateRequest, type LiveUpdateResponse, type Lock, type LogLevel, LogManager, type Logger, MailManager, type MailRecipient, type MailTransport, type Mailable, type Mailer, type MessageBag, type Middleware, MiddlewareCallbacks, type MiddlewareClass, type MiddlewareConfigurator, type MiddlewareReference, type ModelInstance, type ModelNotFoundError, type ModelStatic, type MustVerifyEmail, type Next, type Notifiable, type Notification, type NotificationChannel, NotificationDispatcher, type Operator, type OptionValue, type OrielError, type OutgoingMessage, PasswordBroker, type PasswordStatus, type PendingBatch, type PendingBatchOptions, type PendingChain, type PendingMail, type Pipe, type PipeClosure, type PipeNext, type Pipeline, PipelineFactory, type PropCallback, type PutOptions, type QueryBuilder, type Queue, type QueueJob, QueueManager, type QueuePayload, type RedirectResponse, Redirector, type ResourceOptions, type Responsable, ResponseFactory, type Route, type RouteAction, type RouteClosure, RouteModelResolver, type RouteRegistrar, Router, RoutingPaths, type Row, type RuleCallback, type Rules, Schedule, type ScheduledEvent, type SentMessage, type ServiceProvider, type ServiceProviderClass, Session, type SessionHandler, type ShouldQueue, type StatefulGuard, type Token, type UploadedFile, UrlGenerator, type UserProvider, type ValidationError, ValidationFactory, type ValidationRule, type Validator, type View, ViewFactory, token };
+export { type AbilityCallback, type Abstract, type ActionMethods, type Address, Application, type Arrayable, type Attachment, AuthFactory, type Authenticatable, type AuthenticationError, type Batch, BatchRepository, type BodyInit, BusDispatcher, CacheManager, type CacheRepository, type Class, ClassRegistry, type ClosureCommand, type Command, type CommandContext, type Concrete, type ConfigCallbacks, ConfigRepository, ConsoleKernel, Container, type Content, type ControllerAction, type Cookie, CookieJar, type Credentials, CurrentRoute, type DatabaseConnection, DatabaseManager, type DriverName, Encrypter, type Enumerable, type Envelope, type ErrorKind, EventDispatcher, ExceptionCallbacks, ExceptionHandler, type ExceptionsConfigurator, type Factory, type FailedJob, FailedJobProvider, type Filesystem, FilesystemManager, Gate, type Guard, Hasher, type HeadersInit, type Htmlable, HttpKernel, HttpRequest, InertiaFactory, type InertiaOnceProp, type InertiaPage, type InertiaResponse, type InertiaScrollProp, InertiaSsrGateway, type InertiaSsrResponse, type Job, type Jsonable, type Listener, type ListenerClass, type LiveEffects, LiveManager, type LiveSnapshot, type LiveUpdateRequest, type LiveUpdateResponse, type Lock, type LogLevel, LogManager, type Logger, MailManager, type MailRecipient, type MailTransport, type Mailable, type Mailer, type MessageBag, type Middleware, MiddlewareCallbacks, type MiddlewareClass, type MiddlewareConfigurator, type MiddlewareReference, type ModelInstance, type ModelNotFoundError, type ModelStatic, type MustVerifyEmail, type Next, type Notifiable, type Notification, type NotificationChannel, NotificationDispatcher, type Operator, type OptionValue, type OrielError, type OutgoingMessage, PasswordBroker, type PasswordStatus, type PendingBatch, type PendingBatchOptions, type PendingChain, type PendingMail, type Pipe, type PipeClosure, type PipeNext, type Pipeline, PipelineFactory, type PropCallback, type PutOptions, type QueryBuilder, type Queue, type QueueJob, QueueManager, type QueuePayload, type RedirectResponse, Redirector, type ResourceOptions, type Responsable, ResponseFactory, type Route, type RouteAction, type RouteClosure, type RouteList, RouteModelResolver, type RouteName, type RouteRegistrar, Router, RoutingPaths, type Row, type RuleCallback, type Rules, Schedule, type ScheduledEvent, type SentMessage, type ServiceProvider, type ServiceProviderClass, Session, type SessionHandler, type ShouldQueue, type StatefulGuard, type Token, type UploadedFile, UrlGenerator, type UserProvider, type ValidationError, ValidationFactory, type ValidationRule, type Validator, type View, ViewFactory, token };

package/dist/contracts.js

@@ -22,6 +22,7 @@ import {
   HttpKernel,
   HttpRequest,
   InertiaFactory,
+  InertiaSsrGateway,
   LiveManager,
   LogManager,
   MailManager,
@@ -41,7 +42,7 @@ import {
   ValidationFactory,
   ViewFactory,
   token
-} from "./chunk-K6MAA3RM.js";
+} from "./chunk-3ZRPBRAE.js";
 export {
   Application,
   AuthFactory,
@@ -66,6 +67,7 @@ export {
   HttpKernel,
   HttpRequest,
   InertiaFactory,
+  InertiaSsrGateway,
   LiveManager,
   LogManager,
   MailManager,