kirby-types 0.5.0 → 0.6.1

package/README.md

@@ -2,7 +2,7 @@
 
 [![NPM version](https://img.shields.io/npm/v/kirby-types?color=a1b858&label=)](https://www.npmjs.com/package/kirby-types)
 
-A collection of TypeScript types to work with Kirby, mainly in the context of the Kirby Query Language.
+A collection of TypeScript types to work with [Kirby CMS](https://getkirby.com), mainly in the context of the Kirby Query Language.
 
 ## Setup
 
@@ -22,13 +22,19 @@ yarn add -D kirby-types
 ```ts
 import type { KirbyQuery } from "kirby-types";
 
-// Strictly typed query for the Kirby Query Language
-const query: KirbyQuery = 'kirby.page("about")';
+// Strictly typed query
+const query: KirbyQuery = 'page.children.filterBy("featured", true)';
+
+// Invalid queries will throw a type error
+let invalidQuery: KirbyQuery;
+invalidQuery = "unknown"; // Not a valid model
+invalidQuery = 'site("'; // Empty parentheses
+invalidQuery = 'site("value"'; // Missing closing parenthesis
 ```
 
 ## API
 
-Click the type names for complete docs.
+By clicking on a type name, you will be redirected to the corresponding TypeScript definition file.
 
 ### Query
 
@@ -37,8 +43,9 @@ Click the type names for complete docs.
 
 ### Blocks
 
-- [`KirbyBlockType`](./src/blocks.d.ts) - Matches any [Kirby block type](https://getkirby.com/docs/reference/panel/blocks).
 - [`KirbyBlock`](./src/blocks.d.ts) - Matches a [Kirby block](https://getkirby.com/docs/guide/page-builder).
+- [`KirbyDefaultBlockType`](./src/blocks.d.ts) - Matches any [Kirby default block type](https://getkirby.com/docs/reference/panel/blocks).
+- [`KirbyDefaultBlocks`](./src/blocks.d.ts) - Maps each of [Kirby's default block type](https://getkirby.com/docs/reference/panel/blocks) to its corresponding block content.
 
 ### Layout
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kirby-types",
   "type": "module",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "packageManager": "pnpm@8.7.0",
   "description": "A collection of TypeScript types for the Kirby CMS",
   "author": "Johann Schopplich <pkg@johannschopplich.com>",

package/src/blocks.d.ts

@@ -1,51 +1,36 @@
-export type KirbyBlockType =
-  | "code"
-  | "gallery"
-  | "heading"
-  | "image"
-  | "line"
-  | "list"
-  | "markdown"
-  | "quote"
-  | "table"
-  | "text"
-  | "video";
+export interface KirbyDefaultBlocks {
+  code: { code: string; language: string };
+  gallery: { images: string[] };
+  heading: { level: string; text: string };
+  image: {
+    location: string;
+    image: string[];
+    src: string;
+    alt: string;
+    caption: string;
+    link: string;
+    ratio: string;
+    crop: boolean;
+  };
+  list: { text: string };
+  markdown: { text: string };
+  quote: { text: string; citation: string };
+  text: { text: string };
+  video: { url: string; caption: string };
+}
 
 export interface KirbyBlock<
-  T extends string = KirbyBlockType,
-  U extends Record<string, any> | undefined = undefined,
+  T extends string = keyof KirbyDefaultBlocks,
+  U extends Record<string, unknown> = Record<never, never>,
 > {
-  content: U extends Record<string, any>
+  content: U extends Record<string, unknown>
     ? U
-    : T extends "code"
-    ? { code: string; language: string }
-    : T extends "gallery"
-    ? { images: string[] }
-    : T extends "heading"
-    ? { level: string; text: string }
-    : T extends "image"
-    ? {
-        location: string;
-        image: string[];
-        src: string;
-        alt: string;
-        caption: string;
-        link: string;
-        ratio: string;
-        crop: boolean;
-      }
-    : T extends "list"
-    ? { text: string }
-    : T extends "markdown"
-    ? { text: string }
-    : T extends "quote"
-    ? { text: string; citation: string }
-    : T extends "text"
-    ? { text: string }
-    : T extends "video"
-    ? { url: string; caption: string }
+    : T extends keyof KirbyDefaultBlocks
+    ? KirbyDefaultBlocks[T]
     : Record<string, never>;
   id: string;
   isHidden: boolean;
   type: T;
 }
+
+export type KirbyDefaultBlockType = keyof KirbyDefaultBlocks;