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

package/dist/contracts.d.ts

@@ -640,6 +640,8 @@ interface ModelInstance {
     getTable(): string;
     getRouteKey(): unknown;
     getRouteKeyName(): string;
+    /** The value stored in a polymorphic `*_type` column for this model: its morph map alias, else its class name. */
+    getMorphClass(): string;
     getAttribute<T = unknown>(key: string): T;
     setAttribute(key: string, value: unknown): this;
     fill(attributes: Row): this;
@@ -655,6 +657,19 @@ interface ModelStatic<M extends ModelInstance = ModelInstance> {
     find(id: unknown): Promise<M | undefined>;
     findOrFail(id: unknown): Promise<M>;
 }
+/**
+ * What decides a paginator's page and the path of its links when the request doesn't (Laravel's
+ * Paginator::currentPageResolver and currentPathResolver, which Livewire's WithPagination replaces). Live binds one for
+ * the application, which answers while a WithPagination component mounts, runs an update's hooks and actions, or
+ * renders. Unbound, or `undefined` from a method, the paginators read the request (`?page=` and its URL).
+ */
+interface PaginationState {
+    /** The page to show for `pageName` ('page' by default). */
+    currentPage(pageName: string): number | undefined;
+    /** The base path of the page links. */
+    currentPath(): string | undefined;
+}
+declare const PaginationState: Token<PaginationState>;
 
 interface Authenticatable {
     getAuthIdentifierName(): string;
@@ -723,6 +738,11 @@ interface MustVerifyEmail {
 
 /** Options a job class may declare as public fields. Their presence (or implementing ShouldQueue) makes things queueable. */
 interface ShouldQueue {
+    /**
+     * Marks the class as queued at run time: `implements ShouldQueue` leaves no trace once compiled, so the interface
+     * asks for `readonly shouldQueue = true`. Jobs, listeners, mailables and notifications carrying it are queued.
+     */
+    readonly shouldQueue: true;
     connection?: string;
     queue?: string;
     /** Seconds. */
@@ -1057,6 +1077,28 @@ interface NotificationDispatcher {
     extend(channel: string, factory: () => NotificationChannel): void;
 }
 declare const NotificationDispatcher: Token<NotificationDispatcher>;
+/**
+ * A stored database notification (Laravel's DatabaseNotification model): one row of the `notifications` table, with
+ * its snake_case columns. `user.notifications()`, `unreadNotifications()` and `readNotifications()` query these,
+ * newest first.
+ */
+interface DatabaseNotification extends ModelInstance {
+    /** A UUID. */
+    readonly id: string;
+    /** The notification's class name. */
+    readonly type: string;
+    /** What the notification's toDatabase() (or toArray()) returned. */
+    readonly data: Record<string, unknown>;
+    read_at: Date | null;
+    readonly created_at: Date | null;
+    readonly updated_at: Date | null;
+    /** Sets read_at to now and saves, unless it is already read. */
+    markAsRead(): Promise<void>;
+    /** Clears read_at and saves, unless it is already unread. */
+    markAsUnread(): Promise<void>;
+    read(): boolean;
+    unread(): boolean;
+}
 
 interface Lock {
     /** Tries once. Returns whether it was acquired. */
@@ -1322,4 +1364,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 InertiaOnceProp, type InertiaPage, type InertiaResponse, type InertiaScrollProp, InertiaSsrGateway, type InertiaSsrResponse, type InvokableClass, 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, RateLimiter, 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 };
+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 DatabaseNotification, 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 InvokableClass, 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, PaginationState, 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, RateLimiter, 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

@@ -28,6 +28,7 @@ import {
   MailManager,
   MiddlewareCallbacks,
   NotificationDispatcher,
+  PaginationState,
   PasswordBroker,
   PipelineFactory,
   QueueManager,
@@ -43,7 +44,7 @@ import {
   ValidationFactory,
   ViewFactory,
   token
-} from "./chunk-WSGWYXAO.js";
+} from "./chunk-BSQKOLSK.js";
 export {
   Application,
   AuthFactory,
@@ -74,6 +75,7 @@ export {
   MailManager,
   MiddlewareCallbacks,
   NotificationDispatcher,
+  PaginationState,
   PasswordBroker,
   PipelineFactory,
   QueueManager,