@nestjs-dash/core 0.0.1 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 nestjs-dash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -13,46 +13,46 @@ pnpm add @nestjs-dash/core
 ## Example resource
 
 ```ts
-import { Resource, TextColumn, TextInput, type Schema, type Table } from '@nestjs-dash/core';
+import { Resource, TextColumn, TextInput, type Schema, type Table } from "@nestjs-dash/core";
 
 export class UserResource extends Resource {
-  static override slug = 'users';
-  static override label = 'User';
+  static override slug = "users";
+  static override label = "User";
 
   static override table(table: Table) {
     return table.columns([
-      TextColumn.make('id').sortable(),
-      TextColumn.make('email').searchable().sortable(),
+      TextColumn.make("id").sortable(),
+      TextColumn.make("email").searchable().sortable(),
     ]);
   }
 
   static override form(form: Schema) {
-    return form.components([TextInput.make('email').email().required()]);
+    return form.components([TextInput.make("email").email().required()]);
   }
 }
 ```
 
 ## Field builders
 
-| Field | Notes |
-|-------|-------|
-| `TextInput` | text/email/password, `.icon()`/`.prefix()`/`.suffix()` |
-| `Textarea` | |
-| `Select` | static `.options()` or `.relationship()` (BelongsTo, loaded at runtime) |
-| `Radio` | same `.options()` shape as `Select`, rendered as a radio group |
-| `Checkbox` / `Toggle` | |
-| `DatePicker` / `DateTimePicker` | native `date` / `datetime-local` inputs |
-| `ColorPicker` | native `color` input |
-| `CodeEditor` | monospace textarea with a `.language()` caption (no syntax highlighting) |
-| `TagsInput` | chip input, submits a JSON array |
-| `RichEditor` | markdown-toolbar-over-textarea — not a WYSIWYG editor |
-| `ImageUpload` / `FileUpload` | share `disk()`/`directory()`/`visibility()`/`acceptedFileTypes()`/`maxSize()`; `ImageUpload` adds `shape()`/`croppable()`/`aspectRatio()`/`collection()` |
-| `Repeater` | repeatable field group (`.schema([...])` of `TextInput`/`Textarea`/`Select`/`Checkbox`/`Toggle`), with `.minItems()`/`.maxItems()` |
+| Field                           | Notes                                                                                                                                                    |
+| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `TextInput`                     | text/email/password, `.icon()`/`.prefix()`/`.suffix()`                                                                                                   |
+| `Textarea`                      |                                                                                                                                                          |
+| `Select`                        | static `.options()` or `.relationship()` (BelongsTo, loaded at runtime)                                                                                  |
+| `Radio`                         | same `.options()` shape as `Select`, rendered as a radio group                                                                                           |
+| `Checkbox` / `Toggle`           |                                                                                                                                                          |
+| `DatePicker` / `DateTimePicker` | native `date` / `datetime-local` inputs                                                                                                                  |
+| `ColorPicker`                   | native `color` input                                                                                                                                     |
+| `CodeEditor`                    | monospace textarea with a `.language()` caption (no syntax highlighting)                                                                                 |
+| `TagsInput`                     | chip input, submits a JSON array                                                                                                                         |
+| `RichEditor`                    | markdown-toolbar-over-textarea — not a WYSIWYG editor                                                                                                    |
+| `ImageUpload` / `FileUpload`    | share `disk()`/`directory()`/`visibility()`/`acceptedFileTypes()`/`maxSize()`; `ImageUpload` adds `shape()`/`croppable()`/`aspectRatio()`/`collection()` |
+| `Repeater`                      | repeatable field group (`.schema([...])` of `TextInput`/`Textarea`/`Select`/`Checkbox`/`Toggle`), with `.minItems()`/`.maxItems()`                       |
 
 Inputs accept an icon and text prefix/suffix:
 
 ```ts
-TextInput.make('price').icon('dollar-sign').prefix('$').suffix('USD');
+TextInput.make("price").icon("dollar-sign").prefix("$").suffix("USD");
 ```
 
 ## Actions
@@ -60,8 +60,8 @@ TextInput.make('price').icon('dollar-sign').prefix('$').suffix('USD');
 `Action` and its `EditAction`/`DeleteAction`/`BulkAction`/… subclasses support an icon position, a badge, a size, and an explicit variant — `.color()` maps to a Button variant (`primary`→`default`, `danger`→`destructive`, `gray`→`outline`, `success`/`warning`→matching variants):
 
 ```ts
-Action.make('promote').icon('star').iconPosition('end').badge(3, 'red').color('warning');
-Action.make('refresh').icon('refresh-cw').iconOnly(); // tooltip'd icon-only button
+Action.make("promote").icon("star").iconPosition("end").badge(3, "red").color("warning");
+Action.make("refresh").icon("refresh-cw").iconOnly(); // tooltip'd icon-only button
 ```
 
 ## Charts

package/dist/actions/handlers.d.ts

@@ -1,4 +1,4 @@
-import type { ResourceAdapter } from '@nestjs-dash/adapter';
+import type { ResourceAdapter } from "@nestjs-dash/adapter";
 export interface ActionHandlerContext {
     resourceSlug: string;
     record?: Record<string, unknown>;

package/dist/actions/index.d.ts

@@ -1,14 +1,14 @@
-import type { BadgeColor, SchemaNode } from '@nestjs-dash/support';
-import { ComponentBuilder } from '../schemas/index.js';
-import { type ActionHandler } from './handlers.js';
-export type ActionColor = 'primary' | 'danger' | 'gray' | 'success' | 'warning';
-export type ActionButtonVariant = 'default' | 'destructive' | 'outline' | 'secondary' | 'ghost' | 'link' | 'success' | 'warning';
-export type ActionButtonSize = 'xs' | 'sm' | 'default' | 'lg';
+import type { BadgeColor, SchemaNode } from "@nestjs-dash/support";
+import { ComponentBuilder } from "../schemas/index.js";
+import { type ActionHandler } from "./handlers.js";
+export type ActionColor = "primary" | "danger" | "gray" | "success" | "warning";
+export type ActionButtonVariant = "default" | "destructive" | "outline" | "secondary" | "ghost" | "link" | "success" | "warning";
+export type ActionButtonSize = "xs" | "sm" | "default" | "lg";
 export declare const ACTION_COLOR_VARIANT: Record<ActionColor, ActionButtonVariant>;
-export { resolveActionHandler } from './handlers.js';
-export type { ActionHandler, ActionHandlerContext, ActionHandlerResult } from './handlers.js';
+export { resolveActionHandler } from "./handlers.js";
+export type { ActionHandler, ActionHandlerContext, ActionHandlerResult } from "./handlers.js";
 export declare class Dialog extends ComponentBuilder {
-    readonly kind: 'dialog';
+    readonly kind: "dialog";
     static make(): Dialog;
     heading(value: string): this;
     description(value: string): this;
@@ -17,13 +17,13 @@ export declare class Dialog extends ComponentBuilder {
     form(components: ComponentBuilder[]): this;
 }
 export declare class Action extends ComponentBuilder {
-    readonly kind: SchemaNode['kind'];
+    readonly kind: SchemaNode["kind"];
     static make(name: string): Action;
     label(value: string): this;
     color(value: ActionColor): this;
     requiresConfirmation(value?: boolean): this;
     icon(value: string): this;
-    iconPosition(value: 'start' | 'end'): this;
+    iconPosition(value: "start" | "end"): this;
     iconOnly(value?: boolean): this;
     badge(value: string | number, color?: BadgeColor): this;
     size(value: ActionButtonSize): this;
@@ -37,59 +37,59 @@ export declare class Action extends ComponentBuilder {
     private patchDialog;
 }
 export declare class EditAction extends Action {
-    readonly kind: 'edit-action';
+    readonly kind: "edit-action";
     static make(name?: string): EditAction;
 }
 export declare class DeleteAction extends Action {
-    readonly kind: 'delete-action';
+    readonly kind: "delete-action";
     static make(name?: string): DeleteAction;
 }
 export declare class RestoreAction extends Action {
-    readonly kind: 'restore-action';
+    readonly kind: "restore-action";
     static make(name?: string): RestoreAction;
 }
 export declare class CreateAction extends Action {
-    readonly kind: 'create-action';
+    readonly kind: "create-action";
     static make(name?: string): CreateAction;
 }
 export declare class ViewAction extends Action {
-    readonly kind: 'view-action';
+    readonly kind: "view-action";
     static make(name?: string): ViewAction;
 }
 export declare class ListAction extends Action {
-    readonly kind: 'action';
+    readonly kind: "action";
     static make(name?: string): ListAction;
 }
 export declare class BulkAction extends Action {
-    readonly kind: 'bulk-action';
+    readonly kind: "bulk-action";
     static make(name: string): BulkAction;
 }
 export declare class BulkDeleteAction extends Action {
-    readonly kind: 'bulk-delete-action';
+    readonly kind: "bulk-delete-action";
     static make(name?: string): BulkDeleteAction;
 }
 export declare class AssociateAction extends Action {
-    readonly kind: 'associate-action';
+    readonly kind: "associate-action";
     static make(name?: string): AssociateAction;
 }
 export declare class DissociateAction extends Action {
-    readonly kind: 'dissociate-action';
+    readonly kind: "dissociate-action";
     static make(name?: string): DissociateAction;
 }
 export declare class AttachAction extends Action {
-    readonly kind: 'attach-action';
+    readonly kind: "attach-action";
     static make(name?: string): AttachAction;
 }
 export declare class DetachAction extends Action {
-    readonly kind: 'detach-action';
+    readonly kind: "detach-action";
     static make(name?: string): DetachAction;
 }
 export declare class BulkDissociateAction extends Action {
-    readonly kind: 'bulk-dissociate-action';
+    readonly kind: "bulk-dissociate-action";
     static make(name?: string): BulkDissociateAction;
 }
 export declare class BulkDetachAction extends Action {
-    readonly kind: 'bulk-detach-action';
+    readonly kind: "bulk-detach-action";
     static make(name?: string): BulkDetachAction;
 }
 export declare function resolveActionDialog(action: SchemaNode, defaults?: {

package/dist/actions/index.js

@@ -1,29 +1,29 @@
-import { ComponentBuilder } from '../schemas/index.js';
-import { registerActionHandler } from './handlers.js';
+import { ComponentBuilder } from "../schemas/index.js";
+import { registerActionHandler } from "./handlers.js";
 export const ACTION_COLOR_VARIANT = {
-    primary: 'default',
-    danger: 'destructive',
-    gray: 'outline',
-    success: 'success',
-    warning: 'warning',
+    primary: "default",
+    danger: "destructive",
+    gray: "outline",
+    success: "success",
+    warning: "warning",
 };
-export { resolveActionHandler } from './handlers.js';
+export { resolveActionHandler } from "./handlers.js";
 export class Dialog extends ComponentBuilder {
-    kind = 'dialog';
+    kind = "dialog";
     static make() {
         return new Dialog();
     }
     heading(value) {
-        return this.setProp('heading', value);
+        return this.setProp("heading", value);
     }
     description(value) {
-        return this.setProp('description', value);
+        return this.setProp("description", value);
     }
     submitLabel(value) {
-        return this.setProp('submitLabel', value);
+        return this.setProp("submitLabel", value);
     }
     cancelLabel(value) {
-        return this.setProp('cancelLabel', value);
+        return this.setProp("cancelLabel", value);
     }
     form(components) {
         this.children = components.map((component) => component.toSchema());
@@ -31,42 +31,42 @@ export class Dialog extends ComponentBuilder {
     }
 }
 export class Action extends ComponentBuilder {
-    kind = 'action';
+    kind = "action";
     static make(name) {
-        return new Action().setProp('name', name).setProp('label', name);
+        return new Action().setProp("name", name).setProp("label", name);
     }
     label(value) {
-        return this.setProp('label', value);
+        return this.setProp("label", value);
     }
     color(value) {
-        return this.setProp('color', value);
+        return this.setProp("color", value);
     }
     requiresConfirmation(value = true) {
-        return this.setProp('requiresConfirmation', value);
+        return this.setProp("requiresConfirmation", value);
     }
     icon(value) {
-        return this.setProp('icon', value);
+        return this.setProp("icon", value);
     }
     iconPosition(value) {
-        return this.setProp('iconPosition', value);
+        return this.setProp("iconPosition", value);
     }
     iconOnly(value = true) {
-        return this.setProp('iconOnly', value);
+        return this.setProp("iconOnly", value);
     }
     badge(value, color) {
-        return this.setProp('badge', { text: String(value), color });
+        return this.setProp("badge", { text: String(value), color });
     }
     size(value) {
-        return this.setProp('size', value);
+        return this.setProp("size", value);
     }
     variant(value) {
-        return this.setProp('variant', value);
+        return this.setProp("variant", value);
     }
     dialog(dialog) {
-        return this.setProp('dialog', dialog.toSchema()).requiresConfirmation(true);
+        return this.setProp("dialog", dialog.toSchema()).requiresConfirmation(true);
     }
     handler(fn) {
-        return this.setProp('handlerKey', registerActionHandler(fn));
+        return this.setProp("handlerKey", registerActionHandler(fn));
     }
     modalHeading(value) {
         return this.patchDialog({ heading: value });
@@ -82,135 +82,135 @@ export class Action extends ComponentBuilder {
     }
     patchDialog(partial) {
         const existing = this.props.dialog ?? {
-            kind: 'dialog',
+            kind: "dialog",
             props: {},
         };
         const next = {
-            kind: 'dialog',
+            kind: "dialog",
             props: { ...existing.props, ...partial },
             children: existing.children,
         };
-        return this.setProp('dialog', next).requiresConfirmation(true);
+        return this.setProp("dialog", next).requiresConfirmation(true);
     }
 }
 export class EditAction extends Action {
-    kind = 'edit-action';
-    static make(name = 'edit') {
-        return new EditAction().setProp('name', name).setProp('label', 'Edit');
+    kind = "edit-action";
+    static make(name = "edit") {
+        return new EditAction().setProp("name", name).setProp("label", "Edit");
     }
 }
 export class DeleteAction extends Action {
-    kind = 'delete-action';
-    static make(name = 'delete') {
+    kind = "delete-action";
+    static make(name = "delete") {
         return new DeleteAction()
-            .setProp('name', name)
-            .setProp('label', 'Delete')
-            .color('danger')
+            .setProp("name", name)
+            .setProp("label", "Delete")
+            .color("danger")
             .requiresConfirmation();
     }
 }
 export class RestoreAction extends Action {
-    kind = 'restore-action';
-    static make(name = 'restore') {
-        return new RestoreAction().setProp('name', name).setProp('label', 'Restore').color('success');
+    kind = "restore-action";
+    static make(name = "restore") {
+        return new RestoreAction().setProp("name", name).setProp("label", "Restore").color("success");
     }
 }
 export class CreateAction extends Action {
-    kind = 'create-action';
-    static make(name = 'create') {
-        return new CreateAction().setProp('name', name).setProp('label', 'Create');
+    kind = "create-action";
+    static make(name = "create") {
+        return new CreateAction().setProp("name", name).setProp("label", "Create");
     }
 }
 export class ViewAction extends Action {
-    kind = 'view-action';
-    static make(name = 'view') {
-        return new ViewAction().setProp('name', name).setProp('label', 'View');
+    kind = "view-action";
+    static make(name = "view") {
+        return new ViewAction().setProp("name", name).setProp("label", "View");
     }
 }
 export class ListAction extends Action {
-    kind = 'action';
-    static make(name = 'list') {
-        return new ListAction().setProp('name', name).setProp('label', 'List');
+    kind = "action";
+    static make(name = "list") {
+        return new ListAction().setProp("name", name).setProp("label", "List");
     }
 }
 export class BulkAction extends Action {
-    kind = 'bulk-action';
+    kind = "bulk-action";
     static make(name) {
-        return new BulkAction().setProp('name', name).setProp('label', name);
+        return new BulkAction().setProp("name", name).setProp("label", name);
     }
 }
 export class BulkDeleteAction extends Action {
-    kind = 'bulk-delete-action';
-    static make(name = 'bulk-delete') {
+    kind = "bulk-delete-action";
+    static make(name = "bulk-delete") {
         return new BulkDeleteAction()
-            .setProp('name', name)
-            .setProp('label', 'Delete selected')
-            .color('danger')
+            .setProp("name", name)
+            .setProp("label", "Delete selected")
+            .color("danger")
             .requiresConfirmation();
     }
 }
 export class AssociateAction extends Action {
-    kind = 'associate-action';
-    static make(name = 'associate') {
-        return new AssociateAction().setProp('name', name).setProp('label', 'Associate');
+    kind = "associate-action";
+    static make(name = "associate") {
+        return new AssociateAction().setProp("name", name).setProp("label", "Associate");
     }
 }
 export class DissociateAction extends Action {
-    kind = 'dissociate-action';
-    static make(name = 'dissociate') {
+    kind = "dissociate-action";
+    static make(name = "dissociate") {
         return new DissociateAction()
-            .setProp('name', name)
-            .setProp('label', 'Dissociate')
-            .color('gray')
+            .setProp("name", name)
+            .setProp("label", "Dissociate")
+            .color("gray")
             .requiresConfirmation();
     }
 }
 export class AttachAction extends Action {
-    kind = 'attach-action';
-    static make(name = 'attach') {
-        return new AttachAction().setProp('name', name).setProp('label', 'Attach');
+    kind = "attach-action";
+    static make(name = "attach") {
+        return new AttachAction().setProp("name", name).setProp("label", "Attach");
     }
 }
 export class DetachAction extends Action {
-    kind = 'detach-action';
-    static make(name = 'detach') {
+    kind = "detach-action";
+    static make(name = "detach") {
         return new DetachAction()
-            .setProp('name', name)
-            .setProp('label', 'Detach')
-            .color('gray')
+            .setProp("name", name)
+            .setProp("label", "Detach")
+            .color("gray")
             .requiresConfirmation();
     }
 }
 export class BulkDissociateAction extends Action {
-    kind = 'bulk-dissociate-action';
-    static make(name = 'bulk-dissociate') {
+    kind = "bulk-dissociate-action";
+    static make(name = "bulk-dissociate") {
         return new BulkDissociateAction()
-            .setProp('name', name)
-            .setProp('label', 'Dissociate selected')
-            .color('gray')
+            .setProp("name", name)
+            .setProp("label", "Dissociate selected")
+            .color("gray")
             .requiresConfirmation();
     }
 }
 export class BulkDetachAction extends Action {
-    kind = 'bulk-detach-action';
-    static make(name = 'bulk-detach') {
+    kind = "bulk-detach-action";
+    static make(name = "bulk-detach") {
         return new BulkDetachAction()
-            .setProp('name', name)
-            .setProp('label', 'Detach selected')
-            .color('gray')
+            .setProp("name", name)
+            .setProp("label", "Detach selected")
+            .color("gray")
             .requiresConfirmation();
     }
 }
 export function resolveActionDialog(action, defaults = {}) {
     const explicit = action.props.dialog;
-    if (explicit?.kind === 'dialog') {
+    if (explicit?.kind === "dialog") {
         return {
-            kind: 'dialog',
+            kind: "dialog",
             props: {
-                heading: defaults.heading ?? 'Confirm',
-                description: defaults.description ?? '',
-                submitLabel: defaults.submitLabel ?? 'Confirm',
-                cancelLabel: defaults.cancelLabel ?? 'Cancel',
+                heading: defaults.heading ?? "Confirm",
+                description: defaults.description ?? "",
+                submitLabel: defaults.submitLabel ?? "Confirm",
+                cancelLabel: defaults.cancelLabel ?? "Cancel",
                 ...explicit.props,
             },
             children: explicit.children,
@@ -220,12 +220,12 @@ export function resolveActionDialog(action, defaults = {}) {
         return null;
     }
     return {
-        kind: 'dialog',
+        kind: "dialog",
         props: {
-            heading: defaults.heading ?? 'Confirm',
-            description: defaults.description ?? 'Are you sure you want to continue?',
-            submitLabel: defaults.submitLabel ?? String(action.props.label ?? 'Confirm'),
-            cancelLabel: defaults.cancelLabel ?? 'Cancel',
+            heading: defaults.heading ?? "Confirm",
+            description: defaults.description ?? "Are you sure you want to continue?",
+            submitLabel: defaults.submitLabel ?? String(action.props.label ?? "Confirm"),
+            cancelLabel: defaults.cancelLabel ?? "Cancel",
         },
     };
 }

package/dist/charts/index.d.ts

@@ -1,11 +1,11 @@
-import type { ChartKind, ChartRow, ChartSeriesSpec, ChartSpec } from '@nestjs-dash/support';
-import type { AdminPolicyContext, DashboardWidget, PageRenderContext } from '../index.js';
-export type { ChartKind, ChartRow, ChartSeriesSpec, ChartSpec } from '@nestjs-dash/support';
+import type { ChartKind, ChartRow, ChartSeriesSpec, ChartSpec } from "@nestjs-dash/support";
+import type { AdminPolicyContext, DashboardWidget, PageRenderContext } from "../index.js";
+export type { ChartKind, ChartRow, ChartSeriesSpec, ChartSpec } from "@nestjs-dash/support";
 type DataInput = ChartRow[] | ((ctx: PageRenderContext) => ChartRow[] | Promise<ChartRow[]>);
 type AccessPredicate = (ctx: AdminPolicyContext) => boolean | Promise<boolean>;
 declare abstract class ChartWidgetBuilder implements DashboardWidget {
     private readonly kind;
-    slot: 'main' | 'side';
+    slot: "main" | "side";
     private categoryKeyValue;
     private seriesValue;
     private dataInput;
@@ -43,13 +43,13 @@ export declare class PieChart extends ChartWidgetBuilder {
 }
 type StatCardValueInput = string | number | ((ctx: PageRenderContext) => string | number | Promise<string | number>);
 type StatCardTrend = {
-    direction: 'up' | 'down';
+    direction: "up" | "down";
     label: string;
 };
 type StatCardTrendInput = StatCardTrend | undefined | ((ctx: PageRenderContext) => StatCardTrend | undefined | Promise<StatCardTrend | undefined>);
 export declare class StatCard implements DashboardWidget {
     private readonly labelValue;
-    slot: 'main' | 'side';
+    slot: "main" | "side";
     private valueInput;
     private trendInput;
     private accessPredicate?;