@dskripchenko/laravel-admin 1.33.0 → 1.34.0

package/dist/components/dashboard/MarkdownWidget.vue.d.ts

@@ -1,8 +1,9 @@
 interface Props {
     title?: string;
-    content: string;
+    content?: string | null;
 }
 declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
     title: string;
+    content: string | null;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/components/dashboard/StatMarkdownWidgets.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/dashboard/StatWidget.vue.d.ts

@@ -1,14 +1,4 @@
 type SemanticTone = 'neutral' | 'positive' | 'negative' | 'warning' | 'info';
-/**
- * The backend's StatsOverviewWidget::data() returns an array of
- * `stats: [{label, value, change: {delta, direction}, color, icon}]`. This
- * StatWidget takes the first stat and renders a UidStat; several stats in one
- * widget are not supported yet, and a host that needs them declares several
- * StatWidgets.
- *
- * It also works with the older scalar values, where the widget sent `value`
- * directly, but stats[0] wins.
- */
 interface StatChange {
     delta?: number;
     direction?: 'up' | 'down' | 'flat';

package/dist/components/layouts/DrawerLayout.vue.d.ts

@@ -6,7 +6,7 @@ interface Props {
     title?: string | null;
     /** 'left' | 'right' | 'top' | 'bottom'. */
     position?: string | null;
-    /** sm | md | lg | xl or a CSS length: a side drawer's width, a bottom one's height. */
+    /** sm | md | lg | xl or a CSS length: a left/right drawer's width, a top/bottom one's height. */
     size?: string | null;
     dismissable?: boolean;
     footer?: ScreenActionLike[];

package/dist/components/layouts/ListenerLayout.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/layouts/ListenerLayout.vue.d.ts

@@ -0,0 +1,18 @@
+import type { LayoutNode } from '../render/LayoutRenderer.vue';
+interface Props {
+    id: string;
+    items?: LayoutNode[];
+    /** The watched field names. */
+    listen?: string[];
+    /** The quiet period before a request, in milliseconds. */
+    debounce?: number;
+    /** Whether the server rendered the children against the form's real state. */
+    primed?: boolean;
+}
+declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    items: LayoutNode[];
+    listen: string[];
+    debounce: number;
+    primed: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/layouts/overlay.d.ts

@@ -5,8 +5,8 @@
  * action anywhere on the screen can open the overlay (`Action::opens($id)` on
  * the backend). Outside a screen the overlay falls back to a local flag.
  *
- * A non-dismissable overlay ignores every close request coming from the UI kit
- * (the cross, the overlay click, Escape); only its own footer actions — a
+ * A non-dismissable overlay is rendered without the cross and with the kit's
+ * overlay click and Escape turned off; only its own footer actions — a
  * successful method, or an action named `close`/`cancel` — close it.
  */
 import { type ComputedRef, type WritableComputedRef } from 'vue';

package/dist/components/render/index.d.ts

@@ -12,6 +12,8 @@ export { provideFormState, useFormState, tryUseFormState, } from './formState';
 export type { FormStateContext } from './formState';
 export { createScreenContext, provideScreenContext, useScreenContext, } from './screenContext';
 export type { ScreenContext, ScreenContextOptions, ScreenActionLike } from './screenContext';
+export { provideListenerEndpoint, useListenerEndpoint } from './listenerContext';
+export type { ListenerEndpoint } from './listenerContext';
 export { default as TextField } from '../fields/TextField.vue';
 export { default as TextAreaField } from '../fields/TextAreaField.vue';
 export { default as NumberField } from '../fields/NumberField.vue';
@@ -32,3 +34,4 @@ export { default as ViewLayout } from '../layouts/ViewLayout.vue';
 export { default as WrapperLayout } from '../layouts/WrapperLayout.vue';
 export { default as InfolistLayout } from '../layouts/InfolistLayout.vue';
 export { default as AuditTrailLayout } from '../layouts/AuditTrailLayout.vue';
+export { default as ListenerLayout } from '../layouts/ListenerLayout.vue';

package/dist/components/render/listenerContext.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Where a Listener layout sends its requests.
+ *
+ * The page that owns the form provides it: ScreenPage points at the screen's
+ * `listener` action, ResourceFormPage at the resource's, adding the form's
+ * context and the record id. Without one — a settings page, a unit test — a
+ * listener simply draws its children as the server first sent them.
+ */
+import { type InjectionKey } from 'vue';
+export interface ListenerEndpoint {
+    /** The action's URL relative to the API root, e.g. `/contact/listener`. */
+    url: () => string;
+    /** Extra body fields sent along with `{listener, state}`. */
+    extra?: () => Record<string, unknown>;
+}
+declare const ListenerEndpointKey: InjectionKey<ListenerEndpoint>;
+export declare function provideListenerEndpoint(endpoint: ListenerEndpoint): void;
+/** The endpoint, or null when no page provides one. */
+export declare function useListenerEndpoint(): ListenerEndpoint | null;
+export { ListenerEndpointKey };

package/dist/components/render/screenContext.d.ts

@@ -54,7 +54,7 @@ declare const ScreenContextKey: InjectionKey<ScreenContext>;
 export interface ScreenContextOptions {
     running: Readonly<Ref<boolean>>;
     runMethod: (method: string) => Promise<boolean>;
-    /** The confirmation prompt; window.confirm by default. */
+    /** The confirmation prompt; the panel's confirmation dialog by default. */
     confirm?: (confirm: {
         message: string;
         title?: string;

package/dist/components/resource/ResourceIndexPage.vue.d.ts

@@ -13,11 +13,11 @@ interface Props {
 declare var __VLS_5: {}, __VLS_78: {}, __VLS_147: {
     filters: Record<string, unknown>;
     setFilter: (key: string, value: unknown) => Promise<void>;
-}, __VLS_213: `cell-${string}`, __VLS_214: {
+}, __VLS_228: `cell-${string}`, __VLS_229: {
     row: Record<string, unknown> | undefined;
 };
 type __VLS_Slots = {} & {
-    [K in NonNullable<typeof __VLS_213>]?: (props: typeof __VLS_214) => any;
+    [K in NonNullable<typeof __VLS_228>]?: (props: typeof __VLS_229) => any;
 } & {
     actions?: (props: typeof __VLS_5) => any;
 } & {

package/dist/components/shell/AdminConfirmDialog.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/composables/useActionRunner.d.ts

@@ -19,14 +19,25 @@ export interface AdminAction {
     /** The nested actions of a dropdown. */
     items: AdminAction[];
 }
+/** One run of an action. */
+export interface ActionRunOptions {
+    /**
+     * The record keys this run applies to — a row's own menu passes its row —
+     * instead of the context's `ids()` (the selection).
+     */
+    ids?: Array<string | number>;
+}
 /** How a page runs a server-side action in its own context. */
 export interface ActionExecutor {
-    /** Runs a button, bulk or modal action; `payload` is the modal form's values. */
-    execute: (action: AdminAction, payload?: Record<string, unknown>) => Promise<unknown>;
+    /**
+     * Runs a button, bulk or modal action; `payload` is the modal form's
+     * values, `options` what `run()` was given.
+     */
+    execute: (action: AdminAction, payload?: Record<string, unknown>, options?: ActionRunOptions) => Promise<unknown>;
     /** The record keys the actions apply to, when the context has any. */
     ids?: () => Array<string | number>;
     /** After a successful execute: a toast, a reload. */
-    onSuccess?: (action: AdminAction, result: unknown) => void | Promise<void>;
+    onSuccess?: (action: AdminAction, result: unknown, options?: ActionRunOptions) => void | Promise<void>;
     /** When execute fails; a toast with the error's message by default. */
     onError?: (action: AdminAction, err: unknown) => void;
     /** Reloads the context's data after an async action has finished. */
@@ -42,22 +53,28 @@ export interface DelayedStatus {
 /** Normalizes one serialized action; null when it has no name or label. */
 export declare function normalizeAction(raw: unknown): AdminAction | null;
 export declare function normalizeActions(raw: unknown): AdminAction[];
-/** Row and bulk actions apply to the selected records. */
+/**
+ * Whether the action applies to records: a BulkAction always does, an action
+ * marked `standalone()` never does, any other one does when it is placed in
+ * rows or in the bulk bar. The backend's Action::requiresSelection() answers
+ * the same way.
+ */
 export declare function needsSelection(action: AdminAction): boolean;
 /**
  * Whether a selection of `count` records satisfies the action's
  * requiresAtLeast / requiresAtMost (BulkAction).
  */
 export declare function selectionAllows(action: AdminAction, count: number): boolean;
+export type ModalSize = 'sm' | 'md' | 'lg' | 'xl' | 'full';
 /** The UidModal sizes; the backend's modalSize() is a free-form string. */
-export declare function modalSizeOf(raw: unknown): 'sm' | 'md' | 'lg' | 'xl';
+export declare function modalSizeOf(raw: unknown): ModalSize;
 /**
  * Turns an absolute href into a router path when it points inside the panel;
  * null when it has to be a full navigation.
  */
 export declare function toRouterPath(router: Router | undefined, href: string): string | null;
 export declare function useActionRunner(executor: ActionExecutor): {
-    run: (action: AdminAction) => Promise<boolean>;
+    run: (action: AdminAction, options?: ActionRunOptions) => Promise<boolean>;
     running: import("vue").Ref<boolean, boolean>;
     confirm: (opts: ActionConfirm | string, destructive?: boolean) => Promise<boolean>;
     confirmState: {
@@ -91,11 +108,14 @@ export declare function useActionRunner(executor: ActionExecutor): {
         } | null;
         title: string;
         submitLabel: string;
-        size: "sm" | "md" | "lg" | "xl";
+        size: ModalSize;
         fields: Array<Record<string, unknown>>;
         values: Record<string, unknown>;
         errors: Record<string, string[]>;
         submitting: boolean;
+        options: {
+            ids?: Array<string | number> | undefined;
+        } | undefined;
     };
     submitModal: () => Promise<void>;
     closeModal: () => void;

package/dist/composables/useConfirm.d.ts

@@ -0,0 +1,31 @@
+export interface ConfirmOptions {
+    message: string;
+    title?: string;
+    confirmLabel?: string;
+    cancelLabel?: string;
+    /** Paints the confirm button as dangerous. */
+    destructive?: boolean;
+}
+export interface ConfirmState {
+    open: boolean;
+    title: string;
+    message: string;
+    confirmLabel: string;
+    cancelLabel: string;
+    destructive: boolean;
+}
+export declare const confirmState: {
+    open: boolean;
+    title: string;
+    message: string;
+    confirmLabel: string;
+    cancelLabel: string;
+    destructive: boolean;
+};
+/** Asks a question; resolves to true when the user agreed. */
+export declare function confirmDialog(opts: ConfirmOptions | string): Promise<boolean>;
+/** Answers the open question (the dialog's buttons, its cross, Escape). */
+export declare function resolveConfirmDialog(ok: boolean): void;
+export declare function useConfirm(): {
+    confirm: typeof confirmDialog;
+};

package/dist/composables/useConfirm.test.d.ts

@@ -0,0 +1 @@
+export {};