kirby-types 1.1.1 → 1.2.0

package/README.md

@@ -1,10 +1,15 @@
+<div align="center">
+  <img src="./.github/favicon.svg" alt="kirby-types logo" width="144">
+
 # kirby-types
 
-A collection of TypeScript types for [Kirby CMS](https://getkirby.com), covering:
+A collection of TypeScript types for [Kirby CMS](https://getkirby.com).
+
+[Panel types](#panel-types) •
+[Backend API types](#backend-types) •
+[Block and layout types](#layouts)
 
-- 🪟 **Panel types** for Kirby Panel plugin development
-- 🔌 **Backend API types** for headless Kirby usage and KQL
-- 🧱 **Block and layout types** for page builder content
+</div>
 
 ## Setup
 
@@ -21,7 +26,13 @@ yarn add -D kirby-types
 
 ## Features
 
-### Panel Types
+<table>
+<tr>
+<th>🪟 Panel Types</th>
+<th>🔌 Backend Types</th>
+</tr>
+<tr>
+<td>
 
 - **Panel API**: Complete API client method types.
 - **State Management**: State, Feature, and Modal hierarchies.
@@ -30,7 +41,8 @@ yarn add -D kirby-types
 - **Libraries**: Color manipulation, dayjs, and autosize types.
 - **Writer**: ProseMirror-based rich text editor utilities.
 
-### Backend Types
+</td>
+<td>
 
 - **API Response**: Type-safe API responses.
 - **Blocks**: All 11 default block types with content structures.
@@ -38,6 +50,10 @@ yarn add -D kirby-types
 - **KQL**: Query Language request/response types.
 - **Query Parsing**: Parse query strings into structured objects at the type level.
 
+</td>
+</tr>
+</table>
+
 ## Basic Usage
 
 ### Panel Types
@@ -87,25 +103,6 @@ const user = window.panel.user;
 console.log(user.email, user.role);
 ```
 
-### Writer Extensions
-
-For ProseMirror-based Writer extensions (requires optional ProseMirror peer dependencies):
-
-```ts
-import type { WriterMarkContext } from "kirby-types";
-
-// In a Writer mark extension
-class Bold {
-  commands({ type, utils }: WriterMarkContext) {
-    return () => utils.toggleMark(type);
-  }
-
-  inputRules({ type, utils }: WriterMarkContext) {
-    return [utils.markInputRule(/\*\*([^*]+)\*\*$/, type)];
-  }
-}
-```
-
 ### API Responses
 
 ```ts
@@ -227,6 +224,25 @@ type Parsed = ParseKirbyQuery<'page.children.filterBy("status", "published")'>;
 // }
 ```
 
+### Writer Extensions
+
+For ProseMirror-based Writer extensions (requires optional ProseMirror peer dependencies):
+
+```ts
+import type { WriterMarkContext } from "kirby-types";
+
+// In a Writer mark extension
+class Bold {
+  commands({ type, utils }: WriterMarkContext) {
+    return () => utils.toggleMark(type);
+  }
+
+  inputRules({ type, utils }: WriterMarkContext) {
+    return [utils.markInputRule(/\*\*([^*]+)\*\*$/, type)];
+  }
+}
+```
+
 ## API Reference
 
 ### Panel

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "kirby-types",
   "type": "module",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "packageManager": "pnpm@10.27.0",
-  "description": "A collection of TypeScript types for the Kirby CMS",
+  "description": "TypeScript types for Kirby Panel plugins and headless CMS usage",
   "author": "Johann Schopplich <hello@johannschopplich.com>",
   "license": "MIT",
   "homepage": "https://github.com/johannschopplich/kirby-types#readme",
@@ -43,14 +43,18 @@
     "test": "tsd -f \"test/**/*.test-d.ts\""
   },
   "peerDependencies": {
-    "prosemirror-commands": "^1.0.0",
-    "prosemirror-inputrules": "^1.0.0",
-    "prosemirror-model": "^1.0.0",
-    "prosemirror-schema-list": "^1.0.0",
-    "prosemirror-state": "^1.0.0",
+    "dayjs": "^1.0.0",
+    "prosemirror-commands": "^1.7.1",
+    "prosemirror-inputrules": "^1.5.1",
+    "prosemirror-model": "^1.25.4",
+    "prosemirror-schema-list": "^1.5.1",
+    "prosemirror-state": "^1.4.4",
     "vue": "^2.7.0"
   },
   "peerDependenciesMeta": {
+    "dayjs": {
+      "optional": true
+    },
     "prosemirror-commands": {
       "optional": true
     },
@@ -73,6 +77,7 @@
   "devDependencies": {
     "@antfu/eslint-config": "^6.7.3",
     "bumpp": "^10.3.2",
+    "dayjs": "^1.11.13",
     "eslint": "^9.39.2",
     "prettier": "^3.7.4",
     "tsd": "^0.33.0",

package/src/blocks.d.ts

@@ -166,7 +166,7 @@ export interface KirbyDefaultBlocks {
    * Table block for tabular data.
    * Content structure is dynamic based on rows/columns.
    */
-  table: Record<string, unknown>;
+  table: Record<string, any>;
 
   /**
    * Rich text block (WYSIWYG editor).
@@ -242,13 +242,13 @@ export interface KirbyDefaultBlocks {
  */
 export interface KirbyBlock<
   T extends string = keyof KirbyDefaultBlocks,
-  U extends Record<string, unknown> | undefined = undefined,
+  U extends Record<string, any> | undefined = undefined,
 > {
   /**
    * The block's content fields.
    * Structure depends on the block type or custom content definition.
    */
-  content: U extends Record<string, unknown>
+  content: U extends Record<string, any>
     ? U
     : T extends keyof KirbyDefaultBlocks
       ? KirbyDefaultBlocks[T]