kirby-types 1.2.0 → 1.3.0

package/src/panel/helpers.d.ts

@@ -55,7 +55,7 @@ export interface PanelHelpersArray {
    * Sorts array by field and direction.
    *
    * @param array - Array to sort
-   * @param sortBy - Sort specification (e.g., `'name asc'`, `'date desc'`)
+   * @param sortBy - Sort specification (e.g., `"name asc"`, `"date desc"`)
    * @returns Sorted array
    */
   sortBy: <T extends Record<string, any>>(array: T[], sortBy: string) => T[];
@@ -265,7 +265,7 @@ export interface PanelHelpersObject {
   ) => Partial<T>;
 
   /**
-   * Checks if value is empty (null, undefined, '', empty object/array).
+   * Checks if value is empty (`null`, `undefined`, `""`, empty object/array).
    *
    * @param value - Value to check
    * @returns True if empty
@@ -743,7 +743,7 @@ export interface PanelHelpersPage {
   /**
    * Returns props for page status button.
    *
-   * @param status - Page status ('draft', 'unlisted', 'listed')
+   * @param status - Page status (`"draft"`, `"unlisted"`, `"listed"`)
    * @param disabled - Whether to disable
    * @returns Button props
    */

package/src/panel/index.d.ts

@@ -6,11 +6,13 @@
  * This is the main entry point for all Panel type definitions.
  * Types are organized into modules for better maintainability:
  *
- * - `panel.base.ts` - State, Feature, Modal, History, Event Listeners
- * - `panel.features.ts` - View, Dialog, Drawer, Dropdown, Notification, etc.
- * - `panel.helpers.ts` - $helper.* utilities
- * - `panel.libraries.ts` - $library.* (colors, dayjs, autosize)
- * - `panel.api.ts` - API client methods
+ * - `base.d.ts` - State, Feature, Modal, History, Event Listeners
+ * - `features.d.ts` - View, Dialog, Drawer, Dropdown, Notification, etc.
+ * - `helpers.d.ts` - $helper.* utilities
+ * - `libraries.d.ts` - $library.* (colors, dayjs, autosize)
+ * - `api.d.ts` - API client methods
+ * - `writer.d.ts` - Writer (ProseMirror) editor and extensions
+ * - `textarea.d.ts` - Textarea toolbar buttons
  *
  * @see https://github.com/getkirby/kirby/tree/main/panel/src/panel
  * @since 4.0.0
@@ -26,56 +28,43 @@ import type {
 import type * as PanelFeatures from "./features";
 import type { PanelHelpers } from "./helpers";
 import type { PanelLibrary } from "./libraries";
+import type { TextareaButton } from "./textarea";
+import type { WriterMarkExtension, WriterNodeExtension } from "./writer";
 
 // =============================================================================
-// Re-exports from panel.api.ts
+// Re-exports from api.d.ts
 // =============================================================================
 
 export type {
-  // Request Types
-  PanelApiRequestOptions,
-  PanelApiPagination,
-  PanelApiSearchQuery,
   // Auth
-  PanelApiLoginData,
   PanelApiAuth,
   // Files
   PanelApiFiles,
   // Languages
-  PanelApiLanguageData,
   PanelApiLanguages,
   // Pages
-  PanelApiPageCreateData,
-  PanelApiPageDuplicateOptions,
   PanelApiPages,
   // Roles
   PanelApiRoles,
   // Site
   PanelApiSite,
   // System
-  PanelApiSystemInstallData,
-  PanelApiSystemRegisterData,
   PanelApiSystem,
   // Translations
   PanelApiTranslations,
   // Users
-  PanelApiUserCreateData,
   PanelApiUsers,
   // Main API Interface
   PanelApi,
 } from "./api";
 
 // =============================================================================
-// Re-exports from panel.base.ts
+// Re-exports from base.d.ts
 // =============================================================================
 
 export type {
   // State Management
   PanelState,
-  PanelStateBase,
-  PanelFeatureBase,
-  PanelModalBase,
-  PanelHistoryBase,
   // Event Listeners
   PanelEventCallback,
   PanelEventListenerMap,
@@ -102,55 +91,43 @@ export type {
 } from "./base";
 
 // =============================================================================
-// Re-exports from panel.features.ts
+// Re-exports from features.d.ts
 // =============================================================================
 
 export type {
   // Timer
   PanelTimer,
   // Activation
-  PanelActivationDefaults,
   PanelActivation,
   // Drag
-  PanelDragDefaults,
   PanelDrag,
   // Theme
-  PanelThemeDefaults,
   PanelThemeValue,
   PanelTheme,
   // Language
-  PanelLanguageDefaults,
   PanelLanguage,
   // Menu
   PanelMenuEntry,
-  PanelMenuDefaults,
   PanelMenu,
   // Notification
-  PanelNotificationDefaults,
   PanelNotificationOptions,
   PanelErrorObject,
   PanelNotification,
   // System
-  PanelSystemDefaults,
   PanelSystem,
   // Translation
-  PanelTranslationDefaults,
   PanelTranslation,
   // User
-  PanelUserDefaults,
   PanelUser,
   // View
   PanelBreadcrumbItem,
-  PanelViewDefaults,
   PanelView,
   // Dropdown
   PanelDropdownOption,
   PanelDropdown,
   // Dialog
-  PanelDialogDefaults,
   PanelDialog,
   // Drawer
-  PanelDrawerDefaults,
   PanelDrawer,
   // Content
   PanelContentVersion,
@@ -165,103 +142,61 @@ export type {
   PanelSearcher,
   // Upload
   PanelUploadFile,
-  PanelUploadDefaults,
   PanelUpload,
   // Events
-  PanelKeychain,
   PanelEventEmitter,
   PanelEvents,
 } from "./features";
 
 // =============================================================================
-// Re-exports from panel.helpers.ts
+// Re-exports from helpers.d.ts
 // =============================================================================
 
 export type {
-  // Array
-  PanelArraySearchOptions,
-  PanelHelpersArray,
-  // String
-  PanelSlugRules,
-  PanelHelpersString,
-  // Object
-  PanelHelpersObject,
-  // URL
-  PanelHelpersUrl,
-  // Clipboard
-  PanelHelpersClipboard,
-  // Embed
-  PanelHelpersEmbed,
-  // Field
-  PanelFieldDefinition,
-  PanelHelpersField,
-  // File
-  PanelHelpersFile,
-  // Keyboard
-  PanelHelpersKeyboard,
-  // Link
-  PanelLinkType,
-  PanelLinkDetection,
-  PanelLinkPreview,
-  PanelHelpersLink,
-  // Page
-  PanelPageStatusProps,
-  PanelHelpersPage,
-  // Upload
-  PanelUploadProgressCallback,
-  PanelUploadCompleteCallback,
-  PanelUploadParams,
-  // Utility Types
-  PanelDebounceOptions,
-  PanelThrottleOptions,
-  PanelDebouncedFunction,
-  PanelThrottledFunction,
-  PanelSortOptions,
-  PanelComparator,
   // Main Helpers Interface
   PanelHelpers,
 } from "./helpers";
 
 // =============================================================================
-// Re-exports from panel.libraries.ts
+// Re-exports from libraries.d.ts
 // =============================================================================
 
 export type {
-  // Color Types
-  PanelColorFormat,
-  PanelColorRGB,
-  PanelColorHSL,
-  PanelColorHSV,
-  PanelColorObject,
-  PanelColorInput,
-  PanelLibraryColors,
-  // Dayjs Types
-  PanelDayjsISOFormat,
-  PanelDayjsRoundUnit,
-  PanelDayjsMergeUnit,
-  PanelDayjsPatternPart,
-  PanelDayjsPattern,
-  PanelDayjsExtensions,
-  PanelDayjsInstance,
-  PanelDayjsStaticExtensions,
-  PanelLibraryDayjs,
-  // Autosize
-  PanelLibraryAutosize,
   // Main Library Interface
   PanelLibrary,
 } from "./libraries";
 
 // =============================================================================
-// Re-exports from panel.writer.ts
+// Re-exports from textarea.d.ts
+// =============================================================================
+
+export type {
+  // Textarea Toolbar
+  TextareaButton,
+  TextareaToolbarContext,
+} from "./textarea";
+
+// =============================================================================
+// Re-exports from writer.d.ts
 // =============================================================================
 
 export type {
+  // Writer Editor
+  WriterEditor,
+  // Writer Toolbar
+  WriterToolbarButton,
   // Writer Utilities
   WriterUtils,
   // Writer Contexts
   WriterMarkContext,
   WriterNodeContext,
   WriterExtensionContext,
+  // Writer Schemas
+  WriterMarkSchema,
+  WriterNodeSchema,
+  // Writer Extensions
+  WriterMarkExtension,
+  WriterNodeExtension,
 } from "./writer";
 
 // =============================================================================
@@ -293,14 +228,6 @@ export type PanelApp = InstanceType<VueConstructor> & {
 // Panel Configuration
 // =============================================================================
 
-/**
- * Panel API configuration.
- */
-export interface PanelConfigApi {
-  /** Whether to use method override for PUT/PATCH/DELETE */
-  methodOverride: boolean;
-}
-
 /**
  * Global Panel configuration.
  *
@@ -308,7 +235,10 @@ export interface PanelConfigApi {
  */
 export interface PanelConfig {
   /** API configuration */
-  api: PanelConfigApi;
+  api: {
+    /** Whether to use method override for PUT/PATCH/DELETE */
+    methodOverride: boolean;
+  };
   /** Whether debug mode is enabled */
   debug: boolean;
   /** Whether KirbyText is enabled */
@@ -328,7 +258,7 @@ export interface PanelConfig {
 /**
  * Access permissions for Panel areas.
  */
-export interface PanelPermissionsAccess {
+interface PanelPermissionsAccess {
   account: boolean;
   languages: boolean;
   panel: boolean;
@@ -340,7 +270,7 @@ export interface PanelPermissionsAccess {
 /**
  * File operation permissions.
  */
-export interface PanelPermissionsFiles {
+interface PanelPermissionsFiles {
   access: boolean;
   changeName: boolean;
   changeTemplate: boolean;
@@ -356,7 +286,7 @@ export interface PanelPermissionsFiles {
 /**
  * Language operation permissions.
  */
-export interface PanelPermissionsLanguages {
+interface PanelPermissionsLanguages {
   create: boolean;
   delete: boolean;
   update: boolean;
@@ -365,7 +295,7 @@ export interface PanelPermissionsLanguages {
 /**
  * Page operation permissions.
  */
-export interface PanelPermissionsPages {
+interface PanelPermissionsPages {
   access: boolean;
   changeSlug: boolean;
   changeStatus: boolean;
@@ -385,7 +315,7 @@ export interface PanelPermissionsPages {
 /**
  * Site operation permissions.
  */
-export interface PanelPermissionsSite {
+interface PanelPermissionsSite {
   changeTitle: boolean;
   update: boolean;
 }
@@ -393,7 +323,7 @@ export interface PanelPermissionsSite {
 /**
  * User management permissions (for other users).
  */
-export interface PanelPermissionsUsers {
+interface PanelPermissionsUsers {
   changeEmail: boolean;
   changeLanguage: boolean;
   changeName: boolean;
@@ -407,7 +337,7 @@ export interface PanelPermissionsUsers {
 /**
  * Current user permissions (for own account).
  */
-export interface PanelPermissionsUser {
+interface PanelPermissionsUser {
   changeEmail: boolean;
   changeLanguage: boolean;
   changeName: boolean;
@@ -497,29 +427,6 @@ export interface PanelRequestResponse {
 // Panel Plugins
 // =============================================================================
 
-/**
- * Third-party plugin data.
- */
-export type PanelPluginsThirdParty = Record<string, any>;
-
-/**
- * Custom view button definitions.
- */
-export type PanelPluginsViewButtons = Record<
-  string,
-  ComponentPublicInstance | Record<string, any>
->;
-
-/**
- * Custom writer node definitions.
- */
-export type PanelPluginsWriterNodes = Record<string, Record<string, any>>;
-
-/**
- * Custom view definitions.
- */
-export type PanelPluginsViews = Record<string, Record<string, any>>;
-
 /**
  * Panel plugin system.
  *
@@ -567,7 +474,7 @@ export interface PanelPlugins {
   components: Record<string, ComponentPublicInstance>;
 
   /** Callbacks to run after Panel creation */
-  created: Array<() => void>;
+  created: (() => void)[];
 
   /** Registered SVG icons */
   icons: Record<string, string>;
@@ -578,26 +485,35 @@ export interface PanelPlugins {
   /** Registered Panel routes */
   routes: Record<string, any>[];
 
-  /** Registered textarea toolbar buttons */
-  textareaButtons: Record<string, Record<string, any>>;
+  /**
+   * Registered textarea toolbar buttons.
+   * @see https://getkirby.com/docs/reference/plugins/extensions/textarea-buttons
+   */
+  textareaButtons: Record<string, TextareaButton>;
 
   /** Registered third-party plugin data */
-  thirdParty: PanelPluginsThirdParty;
+  thirdParty: Record<string, any>;
 
   /** Installed Vue plugins via `Vue.use()` */
   use: any[];
 
   /** Registered view buttons */
-  viewButtons: PanelPluginsViewButtons;
+  viewButtons: Record<string, ComponentPublicInstance | Record<string, any>>;
 
   /** Registered Panel views */
-  views: PanelPluginsViews;
+  views: Record<string, Record<string, any>>;
 
-  /** Registered writer marks */
-  writerMarks: Record<string, Record<string, any>>;
+  /**
+   * Registered writer marks.
+   * @see https://getkirby.com/docs/reference/plugins/extensions/writer-marks
+   */
+  writerMarks: Record<string, WriterMarkExtension>;
 
-  /** Registered writer nodes */
-  writerNodes: PanelPluginsWriterNodes;
+  /**
+   * Registered writer nodes.
+   * @see https://getkirby.com/docs/reference/plugins/extensions/writer-nodes
+   */
+  writerNodes: Record<string, WriterNodeExtension>;
 }
 
 // =============================================================================
@@ -906,7 +822,7 @@ export interface Panel {
    *
    * When called with a query, performs the search and returns results.
    *
-   * @param type - Search type ('pages', 'files', 'users')
+   * @param type - Search type (`"pages"`, `"files"`, `"users"`)
    * @param query - Search query string
    * @param options - Search options (page, limit)
    * @returns Search results when query provided, void otherwise
@@ -961,7 +877,7 @@ export interface Panel {
 /**
  * Lock information for content.
  */
-export interface PanelViewPropsLockUser {
+interface PanelViewPropsLockUser {
   id: string;
   email: string;
 }
@@ -969,7 +885,7 @@ export interface PanelViewPropsLockUser {
 /**
  * Content lock state.
  */
-export interface PanelViewPropsLock {
+interface PanelViewPropsLock {
   isLegacy: boolean;
   isLocked: boolean;
   modified: string | null;
@@ -979,7 +895,7 @@ export interface PanelViewPropsLock {
 /**
  * Content permissions for a view.
  */
-export interface PanelViewPropsPermissions {
+interface PanelViewPropsPermissions {
   access: boolean;
   changeSlug: boolean;
   changeStatus: boolean;
@@ -999,7 +915,7 @@ export interface PanelViewPropsPermissions {
 /**
  * Version information.
  */
-export interface PanelViewPropsVersions {
+interface PanelViewPropsVersions {
   latest: Record<string, any>;
   changes: Record<string, any>;
 }
@@ -1007,7 +923,7 @@ export interface PanelViewPropsVersions {
 /**
  * Tab definition.
  */
-export interface PanelViewPropsTab {
+interface PanelViewPropsTab {
   label: string;
   icon: string;
   columns: Record<string, any>[];
@@ -1018,7 +934,7 @@ export interface PanelViewPropsTab {
 /**
  * Navigation link (next/prev).
  */
-export interface PanelViewPropsNavigation {
+interface PanelViewPropsNavigation {
   link: string;
   title: string;
 }
@@ -1026,7 +942,7 @@ export interface PanelViewPropsNavigation {
 /**
  * Model information.
  */
-export interface PanelViewPropsModel {
+interface PanelViewPropsModel {
   id: string;
   link: string;
   parent: string;
@@ -1039,7 +955,7 @@ export interface PanelViewPropsModel {
 /**
  * Button definition.
  */
-export interface PanelViewPropsButton {
+interface PanelViewPropsButton {
   component: string;
   key: string;
   props: {

package/src/panel/libraries.d.ts

@@ -173,37 +173,6 @@ export interface PanelLibraryColors {
 // Dayjs Types
 // -----------------------------------------------------------------------------
 
-/**
- * ISO format type for Kirby's `toISO`/`iso` methods.
- */
-export type PanelDayjsISOFormat = "date" | "time" | "datetime";
-
-/**
- * Valid units for Kirby's `round()` method.
- *
- * Note: `day` is an alias for `date`. Units `week` and `millisecond`
- * are NOT supported by `round()` and will throw an error.
- */
-export type PanelDayjsRoundUnit =
-  | "second"
-  | "minute"
-  | "hour"
-  | "day"
-  | "date"
-  | "month"
-  | "year";
-
-/**
- * Valid units for Kirby's `merge()` method.
- */
-export type PanelDayjsMergeUnit =
-  | "year"
-  | "month"
-  | "date"
-  | "hour"
-  | "minute"
-  | "second";
-
 /**
  * Pattern part information.
  */
@@ -255,7 +224,7 @@ export interface PanelDayjsExtensions {
    * @param format - `"date"` → `"YYYY-MM-DD"`, `"time"` → `"HH:mm:ss"`, `"datetime"` → `"YYYY-MM-DD HH:mm:ss"`
    * @returns ISO formatted string
    */
-  toISO: (format?: PanelDayjsISOFormat) => string;
+  toISO: (format?: "date" | "time" | "datetime") => string;
 
   /**
    * Validates datetime against an upper or lower (min/max) boundary.
@@ -275,24 +244,30 @@ export interface PanelDayjsExtensions {
    * Merges date or time parts from another dayjs instance.
    *
    * @param dt - Dayjs instance to merge from
-   * @param units - `"date"`, `"time"`, or array of specific units
+   * @param units - `"date"`, `"time"`, or array of specific units (`"year"`, `"month"`, `"date"`, `"hour"`, `"minute"`, `"second"`)
    * @returns New dayjs instance (returns `this` if `dt` is invalid)
    */
   merge: (
     dt: Dayjs | null | undefined,
-    units?: "date" | "time" | PanelDayjsMergeUnit[],
+    units?:
+      | "date"
+      | "time"
+      | ("year" | "month" | "date" | "hour" | "minute" | "second")[],
   ) => Dayjs & PanelDayjsExtensions;
 
   /**
    * Rounds to nearest unit step.
    *
+   * Note: `day` is an alias for `date`. Units `week` and `millisecond`
+   * are NOT supported and will throw an error.
+   *
    * @param unit - Unit to round (default: `"date"`)
    * @param size - Step size (default: `1`). Must divide evenly into the unit's range.
    * @returns Rounded dayjs instance
    * @throws Error if unit is invalid or size doesn't divide evenly
    */
   round: (
-    unit?: PanelDayjsRoundUnit,
+    unit?: "second" | "minute" | "hour" | "day" | "date" | "month" | "year",
     size?: number,
   ) => Dayjs & PanelDayjsExtensions;
 }
@@ -330,7 +305,7 @@ export interface PanelDayjsStaticExtensions {
    */
   iso: (
     value: string,
-    format?: PanelDayjsISOFormat,
+    format?: "date" | "time" | "datetime",
   ) => PanelDayjsInstance | null;
 
   /**