@zerotal/admin 1.9.0 → 1.11.0

package/api-surface.md

@@ -1115,31 +1115,31 @@ interface ActionContext = {
 }
 
 interface AdminAuthConfig = {
-  authMiddleware?: MiddlewareClass[]
-  authenticateWhen?: (user: unknown) => boolean | Promise<boolean>
-  emailVerification?: {    isVerified(user: unknown): boolean;    resend(user: unknown): Promise<void> | void;}
-  enabled?: boolean
-  guestMiddleware?: MiddlewareClass[]
-  heading?: string
-  identifier?: string
-  loginPath?: string
-  passwordReset?: {    sendResetLink(email: string): Promise<boolean> | boolean;    reset(input: {        email: string;        token: string;        password: string;    }): Promise<boolean> | boolean;}
-  profilePath?: string
-  redirectTo?: string
-  remember?: boolean
-  updateProfile?: (user: unknown, data: Record<string, unknown>) => Promise<void> | void
+  authMiddleware?: MiddlewareClass[] | undefined
+  authenticateWhen?: ((user: unknown) => boolean | Promise<boolean>) | undefined
+  emailVerification?: {    isVerified(user: unknown): boolean;    resend(user: unknown): Promise<void> | void;} | undefined
+  enabled?: boolean | undefined
+  guestMiddleware?: MiddlewareClass[] | undefined
+  heading?: string | undefined
+  identifier?: string | undefined
+  loginPath?: string | undefined
+  passwordReset?: {    sendResetLink(email: string): Promise<boolean> | boolean;    reset(input: {        email: string;        token: string;        password: string;    }): Promise<boolean> | boolean;} | undefined
+  profilePath?: string | undefined
+  redirectTo?: string | undefined
+  remember?: boolean | undefined
+  updateProfile?: ((user: unknown, data: Record<string, unknown>) => Promise<void> | void) | undefined
 }
 
 interface AdminConfigShape = {
-  auth?: AdminAuthConfig
-  authorize?: AdminAuthorizer
+  auth?: AdminAuthConfig | undefined
+  authorize?: AdminAuthorizer | undefined
   brand: string
-  middleware?: MiddlewareClass[]
+  middleware?: MiddlewareClass[] | undefined
   path: string
-  plugins?: Record<string, boolean>
-  tagline?: string
-  theme?: AdminThemeConfig
-  userMenu?: UserMenu
+  plugins?: Record<string, boolean> | undefined
+  tagline?: string | undefined
+  theme?: AdminThemeConfig | undefined
+  userMenu?: UserMenu | undefined
 }
 
 interface AdminModel = {
@@ -1202,15 +1202,15 @@ interface AdminRecord = {
 }
 
 interface AdminThemeConfig = {
-  cdn?: boolean
-  noFonts?: boolean
-  stylesheet?: string
-  tokensCss?: string
+  cdn?: boolean | undefined
+  noFonts?: boolean | undefined
+  stylesheet?: string | undefined
+  tokensCss?: string | undefined
 }
 
 interface AuthRolesOptions = {
-  guard?: string
-  superusers?: string[]
+  guard?: string | undefined
+  superusers?: string[] | undefined
 }
 
 interface ChartData = {
@@ -1312,15 +1312,15 @@ interface DashboardLayoutStore = {
 }
 
 interface DatabaseMediaOptions = {
-  columns?: Partial<Record<keyof MediaItem, string>>
-  table?: string
+  columns?: Partial<Record<keyof MediaItem, string>> | undefined
+  table?: string | undefined
 }
 
 interface DatabaseNotificationOptions = {
-  limit?: number
-  notifiable?: () => Promise<unknown> | unknown
-  present?: (row: StoredNotification, data: Record<string, unknown>) => AdminNotification
-  table?: string
+  limit?: number | undefined
+  notifiable?: (() => Promise<unknown> | unknown) | undefined
+  present?: ((row: StoredNotification, data: Record<string, unknown>) => AdminNotification) | undefined
+  table?: string | undefined
 }
 
 interface EmptyState = {
@@ -1378,8 +1378,8 @@ interface HistoryEntry = {
 
 interface HistoryOptions = {
   id: unknown
-  limit?: number
-  resolveActor?: (id: number) => Promise<string | null> | string | null
+  limit?: number | undefined
+  resolveActor?: ((id: number) => Promise<string | null> | string | null) | undefined
   type: string
 }
 
@@ -1396,12 +1396,12 @@ interface ImportResult = {
 }
 
 interface ListOptions = {
-  modifyQuery?: QueryModifier
-  page?: number
-  perPage?: number
+  modifyQuery?: QueryModifier | undefined
+  page?: number | undefined
+  perPage?: number | undefined
   search?: string | undefined
   sortBy?: string | undefined
-  sortDir?: 'asc' | 'desc'
+  sortDir?: 'asc' | 'desc' | undefined
   thenSort?: readonly {    column: string;    direction: 'asc' | 'desc';}[] | undefined
   trashed?: 'with' | 'only' | undefined
 }
@@ -1550,10 +1550,10 @@ interface StoredNotification = {
 }
 
 interface StoreMediaOptions = {
-  accept?: string[]
-  disk?: string
-  folder?: string
-  maxBytes?: number
+  accept?: string[] | undefined
+  disk?: string | undefined
+  folder?: string | undefined
+  maxBytes?: number | undefined
   provider: MediaProvider
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zerotal/admin",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "license": "MIT",
   "maturity": "stable",
   "private": false,
@@ -32,16 +32,16 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@zerotal/cache": "1.9.0",
-    "@zerotal/core": "1.9.0",
-    "@zerotal/flow": "1.9.0",
-    "@zerotal/flow-ui": "1.9.0",
-    "@zerotal/validator": "1.9.0"
+    "@zerotal/cache": "1.11.0",
+    "@zerotal/core": "1.11.0",
+    "@zerotal/flow": "1.11.0",
+    "@zerotal/flow-ui": "1.11.0",
+    "@zerotal/validator": "1.11.0"
   },
   "devDependencies": {
-    "@zerotal/orm": "1.9.0",
-    "@zerotal/auth": "1.9.0",
-    "@zerotal/queue": "1.9.0"
+    "@zerotal/orm": "1.11.0",
+    "@zerotal/auth": "1.11.0",
+    "@zerotal/queue": "1.11.0"
   },
   "peerDependencies": {
     "@zerotal/orm": "^1.0.0",

package/src/Resource.ts

@@ -124,13 +124,13 @@ export interface RecordPage {
 }
 
 export interface ListOptions {
-  page?: number;
-  perPage?: number;
+  page?: number | undefined;
+  perPage?: number | undefined;
   search?: string | undefined;
   sortBy?: string | undefined;
-  sortDir?: "asc" | "desc";
+  sortDir?: "asc" | "desc" | undefined;
   /** Scope the base query before search/sort/pagination (e.g. the active tab). */
-  modifyQuery?: QueryModifier;
+  modifyQuery?: QueryModifier | undefined;
   /** Soft-delete scope: include trashed (`with`) or only trashed (`only`). */
   trashed?: "with" | "only" | undefined;
   /**

package/src/authRoles.ts

@@ -24,7 +24,7 @@ export interface AuthRolesOptions {
    * Guard the roles belong to. Defaults to `"web"`, matching the framework's
    * own default, so most apps need not think about it.
    */
-  guard?: string;
+  guard?: string | undefined;
   /**
    * Role names that hold every permission.
    *
@@ -32,7 +32,7 @@ export interface AuthRolesOptions {
    * something the data can tell you. A superuser role is shown as holding
    * everything and cannot be edited or deleted from the panel.
    */
-  superusers?: string[];
+  superusers?: string[] | undefined;
 }
 
 /** The role surface this needs, kept structural so `auth` stays optional. */

package/src/config.ts

@@ -26,37 +26,46 @@ export interface UserMenu {
  */
 export interface AdminAuthConfig {
   /** Mount the auth pages. */
-  enabled?: boolean;
+  enabled?: boolean | undefined;
   /** Login route (relative to the panel path). Default `/login`. */
-  loginPath?: string;
+  loginPath?: string | undefined;
   /** Profile route (relative to the panel path). Default `/profile`. */
-  profilePath?: string;
+  profilePath?: string | undefined;
   /** Where to send the user after a successful login. Default the panel root. */
-  redirectTo?: string;
+  redirectTo?: string | undefined;
   /** The credential column users log in with. Default `"email"`. */
-  identifier?: string;
+  identifier?: string | undefined;
   /** Show a "remember me" checkbox. Default `true`. */
-  remember?: boolean;
+  remember?: boolean | undefined;
   /** Heading on the auth screens. Defaults to the panel brand. */
-  heading?: string;
+  heading?: string | undefined;
   /** Extra gate after the password check (e.g. "is the account active?"). */
-  authenticateWhen?: (user: unknown) => boolean | Promise<boolean>;
+  authenticateWhen?: ((user: unknown) => boolean | Promise<boolean>) | undefined;
   /** Persist profile edits (name/email). Defaults to `user.fill(data); user.save()`. */
-  updateProfile?: (user: unknown, data: Record<string, unknown>) => Promise<void> | void;
+  updateProfile?:
+    ((user: unknown, data: Record<string, unknown>) => Promise<void> | void) | undefined;
   /** Middleware guarding the guest screens (login/forgot/reset). Default none. */
-  guestMiddleware?: MiddlewareClass[];
+  guestMiddleware?: MiddlewareClass[] | undefined;
   /** Middleware guarding the profile/verify screens. Defaults to the panel guard. */
-  authMiddleware?: MiddlewareClass[];
+  authMiddleware?: MiddlewareClass[] | undefined;
   /** Password-reset broker — mounting the forgot/reset pages when provided. */
-  passwordReset?: {
-    sendResetLink(email: string): Promise<boolean> | boolean;
-    reset(input: { email: string; token: string; password: string }): Promise<boolean> | boolean;
-  };
+  passwordReset?:
+    | {
+        sendResetLink(email: string): Promise<boolean> | boolean;
+        reset(input: {
+          email: string;
+          token: string;
+          password: string;
+        }): Promise<boolean> | boolean;
+      }
+    | undefined;
   /** Email-verification hooks — mounting the verify page when provided. */
-  emailVerification?: {
-    isVerified(user: unknown): boolean;
-    resend(user: unknown): Promise<void> | void;
-  };
+  emailVerification?:
+    | {
+        isVerified(user: unknown): boolean;
+        resend(user: unknown): Promise<void> | void;
+      }
+    | undefined;
 }
 
 /** Admin panel configuration (read from `config/admin.ts`, with defaults). */
@@ -66,7 +75,7 @@ export interface AdminConfigShape {
   /** Brand name shown in the sidebar. */
   brand: string;
   /** Optional short tagline under the brand. */
-  tagline?: string;
+  tagline?: string | undefined;
   /**
    * Middleware guarding every panel route. When left empty, the panel is
    * default-denied in production-like environments (fail closed) and open only
@@ -75,13 +84,13 @@ export interface AdminConfigShape {
    * `[AuthMiddleware.with({ ... })]`. To deliberately expose it without auth,
    * pass an explicit pass-through middleware.
    */
-  middleware?: MiddlewareClass[];
+  middleware?: MiddlewareClass[] | undefined;
   /** Optional top-bar user menu (Profile / Logout / …). */
-  userMenu?: UserMenu;
+  userMenu?: UserMenu | undefined;
   /** Styling source — Tailwind Play CDN (default) or a prebuilt stylesheet. */
-  theme?: AdminThemeConfig;
+  theme?: AdminThemeConfig | undefined;
   /** Auth pages (login / profile / password-reset / email-verification). */
-  auth?: AdminAuthConfig;
+  auth?: AdminAuthConfig | undefined;
   /**
    * Decide the abilities named by pages, widgets, nav entries and search
    * providers. Set this when the app models permissions itself; leave it unset to
@@ -90,13 +99,13 @@ export interface AdminConfigShape {
    * With neither configured, every ability is denied outside a development
    * environment — a panel with no authorization wired stays closed in production.
    */
-  authorize?: AdminAuthorizer;
+  authorize?: AdminAuthorizer | undefined;
   /**
    * Switch contributing packages off by id — `{ monitor: false }` keeps the
    * monitor provider installed but drops its pages, widgets and nav entries from
    * the panel. Anything absent here is on.
    */
-  plugins?: Record<string, boolean>;
+  plugins?: Record<string, boolean> | undefined;
 }
 
 /**

package/src/databaseMedia.ts

@@ -21,9 +21,9 @@ import type { MediaItem, MediaProvider } from "./media.ts";
 
 export interface DatabaseMediaOptions {
   /** Table holding the catalogue. Defaults to `"media"`. */
-  table?: string;
+  table?: string | undefined;
   /** Map the panel's fields onto your column names. */
-  columns?: Partial<Record<keyof MediaItem, string>>;
+  columns?: Partial<Record<keyof MediaItem, string>> | undefined;
 }
 
 const DEFAULT_COLUMNS: Record<keyof MediaItem, string> = {

package/src/databaseNotifications.ts

@@ -32,21 +32,22 @@ export interface StoredNotification {
 
 export interface DatabaseNotificationOptions {
   /** Table holding the notifications. Defaults to `"notifications"`. */
-  table?: string;
+  table?: string | undefined;
   /**
    * Who the bell is showing. Defaults to the signed-in user from
    * `@zerotal/auth`; returning `null` shows nothing, which is the right answer
    * for a guest.
    */
-  notifiable?: () => Promise<unknown> | unknown;
+  notifiable?: (() => Promise<unknown> | unknown) | undefined;
   /** How many to show. Defaults to 20 — a bell is not an archive. */
-  limit?: number;
+  limit?: number | undefined;
   /**
    * Turn a stored row into what the panel renders. The default reads `title`,
    * `body`/`message`, `url`/`href` and `icon` out of the payload, which is what
    * most notifications carry.
    */
-  present?: (row: StoredNotification, data: Record<string, unknown>) => AdminNotification;
+  present?:
+    ((row: StoredNotification, data: Record<string, unknown>) => AdminNotification) | undefined;
 }
 
 /** Parse a row's JSON payload, tolerating a payload that was never JSON. */

package/src/history.ts

@@ -50,9 +50,9 @@ export interface HistoryOptions {
   type: string;
   id: unknown;
   /** How many entries to show. Defaults to 25 — a record page is not an archive. */
-  limit?: number;
+  limit?: number | undefined;
   /** Turn an actor id into a name. Defaults to `#<id>`. */
-  resolveActor?: (id: number) => Promise<string | null> | string | null;
+  resolveActor?: ((id: number) => Promise<string | null> | string | null) | undefined;
 }
 
 /** Fields that change on every write and say nothing about intent. */

package/src/media.ts

@@ -220,12 +220,12 @@ export function isUpload(value: unknown): value is UploadedFileLike {
 export interface StoreMediaOptions {
   provider: MediaProvider;
   /** Disk to write to; the default disk when omitted. */
-  disk?: string;
-  folder?: string;
+  disk?: string | undefined;
+  folder?: string | undefined;
   /** Refuse anything larger, in bytes. */
-  maxBytes?: number;
+  maxBytes?: number | undefined;
   /** Accepted MIME types; anything goes when omitted. */
-  accept?: string[];
+  accept?: string[] | undefined;
 }
 
 /**

package/src/theme.ts

@@ -38,13 +38,13 @@ export const THEME_TOGGLE_SCRIPT = FLOW_THEME_TOGGLE_SCRIPT;
  */
 export interface AdminThemeConfig {
   /** A prebuilt stylesheet URL/path to link instead of (or alongside) the CDN. */
-  stylesheet?: string;
+  stylesheet?: string | undefined;
   /** Keep loading the Tailwind Play CDN. Defaults to `true` unless `stylesheet` is set. */
-  cdn?: boolean;
+  cdn?: boolean | undefined;
   /** Extra design-token CSS appended after the defaults (override `:root` / `.dark`). */
-  tokensCss?: string;
+  tokensCss?: string | undefined;
   /** Skip the bundled Google Fonts links (e.g. you self-host Inter). */
-  noFonts?: boolean;
+  noFonts?: boolean | undefined;
 }
 
 /** The design-token CSS (`:root` + `.dark` custom properties + base styles). */