kirby-types 1.2.0 → 1.3.1

package/README.md

@@ -45,6 +45,7 @@ yarn add -D kirby-types
 <td>
 
 - **API Response**: Type-safe API responses.
+- **Blueprints**: Field definitions, fieldsets, and field options.
 - **Blocks**: All 11 default block types with content structures.
 - **Layouts**: Layout and column types with width unions.
 - **KQL**: Query Language request/response types.
@@ -125,6 +126,73 @@ const response: KirbyApiResponse<PageData> = {
 };
 ```
 
+### Blueprints
+
+Types for field props and fieldsets as returned by Kirby's `Field->toArray()` and `Fieldset->toArray()`:
+
+```ts
+import type {
+  KirbyFieldProps,
+  KirbyFieldsetProps,
+  KirbyOption,
+  KirbyTextFieldProps,
+} from "kirby-types";
+
+// Base field props (returned by Field->toArray())
+const field: KirbyFieldProps = {
+  name: "title",
+  type: "text",
+  label: "Title",
+  required: true,
+  disabled: false,
+  hidden: false,
+  saveable: true,
+  translate: true,
+  autofocus: false,
+  width: "1/2",
+};
+
+// Type-specific field props
+const textField: KirbyTextFieldProps = {
+  ...field,
+  type: "text",
+  counter: true,
+  font: "sans-serif",
+  spellcheck: false,
+  maxlength: 100,
+};
+
+// Fieldset (block type definition from Fieldset->toArray())
+const fieldset: KirbyFieldsetProps = {
+  disabled: false,
+  editable: true,
+  icon: "text",
+  label: null,
+  name: "Heading",
+  preview: "fields",
+  tabs: {
+    content: {
+      name: "content",
+      label: "Content",
+      fields: { text: field },
+    },
+  },
+  translate: true,
+  type: "heading",
+  unset: false,
+  wysiwyg: false,
+};
+
+// Option (from Option->render())
+const option: KirbyOption = {
+  disabled: false,
+  icon: "page",
+  info: null,
+  text: "Draft",
+  value: "draft",
+};
+```
+
 ### Blocks
 
 ```ts
@@ -229,18 +297,25 @@ type Parsed = ParseKirbyQuery<'page.children.filterBy("status", "published")'>;
 For ProseMirror-based Writer extensions (requires optional ProseMirror peer dependencies):
 
 ```ts
-import type { WriterMarkContext } from "kirby-types";
+import type { WriterMarkExtension } from "kirby-types";
 
-// In a Writer mark extension
-class Bold {
-  commands({ type, utils }: WriterMarkContext) {
+// Define a custom mark extension
+const highlight: WriterMarkExtension = {
+  button: {
+    icon: "highlight",
+    label: "Highlight",
+  },
+  commands({ type, utils }) {
     return () => utils.toggleMark(type);
-  }
-
-  inputRules({ type, utils }: WriterMarkContext) {
+  },
+  inputRules({ type, utils }) {
     return [utils.markInputRule(/\*\*([^*]+)\*\*$/, type)];
-  }
-}
+  },
+  schema: {
+    parseDOM: [{ tag: "mark" }],
+    toDOM: () => ["mark", 0],
+  },
+};
 ```
 
 ## API Reference
@@ -261,10 +336,15 @@ class Bold {
 
 | Type                                                | Description                        |
 | --------------------------------------------------- | ---------------------------------- |
-| [`WriterUtils`](./src/panel/writer.d.ts)            | ProseMirror commands and utilities |
+| [`WriterEditor`](./src/panel/writer.d.ts)           | Main editor instance               |
+| [`WriterExtensions`](./src/panel/writer.d.ts)       | Extensions manager                 |
+| [`WriterExtension`](./src/panel/writer.d.ts)        | Generic extension interface        |
+| [`WriterMarkExtension`](./src/panel/writer.d.ts)    | Mark extension interface           |
+| [`WriterNodeExtension`](./src/panel/writer.d.ts)    | Node extension interface           |
 | [`WriterMarkContext`](./src/panel/writer.d.ts)      | Context for mark extensions        |
 | [`WriterNodeContext`](./src/panel/writer.d.ts)      | Context for node extensions        |
 | [`WriterExtensionContext`](./src/panel/writer.d.ts) | Context for generic extensions     |
+| [`WriterUtils`](./src/panel/writer.d.ts)            | ProseMirror commands and utilities |
 
 ### API
 
@@ -272,6 +352,30 @@ class Bold {
 | --------------------------------------- | ------------------------------------- |
 | [`KirbyApiResponse<T>`](./src/api.d.ts) | Standard Kirby API response structure |
 
+### Blueprints
+
+| Type                                               | Description                                    |
+| -------------------------------------------------- | ---------------------------------------------- |
+| [`KirbyAnyFieldProps`](./src/blueprint.d.ts)       | Union of all field prop types                  |
+| [`KirbyBlocksFieldProps`](./src/blueprint.d.ts)    | Blocks field props with fieldsets              |
+| [`KirbyColorFieldProps`](./src/blueprint.d.ts)     | Color picker field props                       |
+| [`KirbyDateFieldProps`](./src/blueprint.d.ts)      | Date and time field props                      |
+| [`KirbyFieldProps`](./src/blueprint.d.ts)          | Base field props from `Field->toArray()`       |
+| [`KirbyFieldsetProps`](./src/blueprint.d.ts)       | Fieldset from `Fieldset->toArray()`            |
+| [`KirbyFilesFieldProps`](./src/blueprint.d.ts)     | Files/pages/users picker field props           |
+| [`KirbyLayoutFieldProps`](./src/blueprint.d.ts)    | Layout field props with fieldsets and settings |
+| [`KirbyLinkFieldProps`](./src/blueprint.d.ts)      | Link field props                               |
+| [`KirbyNumberFieldProps`](./src/blueprint.d.ts)    | Number field props                             |
+| [`KirbyObjectFieldProps`](./src/blueprint.d.ts)    | Object field props with nested fields          |
+| [`KirbyOption`](./src/blueprint.d.ts)              | Option from `Option->render()`                 |
+| [`KirbyOptionsFieldProps`](./src/blueprint.d.ts)   | Select/radio/checkboxes/multiselect/toggles    |
+| [`KirbyRangeFieldProps`](./src/blueprint.d.ts)     | Range slider field props                       |
+| [`KirbyStructureFieldProps`](./src/blueprint.d.ts) | Structure field props with nested fields       |
+| [`KirbyTagsFieldProps`](./src/blueprint.d.ts)      | Tags field props                               |
+| [`KirbyTextFieldProps`](./src/blueprint.d.ts)      | Text/textarea field props                      |
+| [`KirbyToggleFieldProps`](./src/blueprint.d.ts)    | Toggle (boolean) field props                   |
+| [`KirbyWriterFieldProps`](./src/blueprint.d.ts)    | Writer (rich text) field props                 |
+
 ### Blocks
 
 | Type                                         | Description                       |

package/index.d.ts

@@ -9,6 +9,28 @@ export type {
   KirbyDefaultBlockType,
 } from "./src/blocks";
 
+// Blueprint types
+export type {
+  KirbyAnyFieldProps,
+  KirbyBlocksFieldProps,
+  KirbyDateFieldProps,
+  KirbyFieldProps,
+  KirbyFieldsetGroup,
+  KirbyFieldsetProps,
+  KirbyFieldsetTab,
+  KirbyFilesFieldProps,
+  KirbyLayoutFieldProps,
+  KirbyNumberFieldProps,
+  KirbyObjectFieldProps,
+  KirbyOption,
+  KirbyOptionsFieldProps,
+  KirbyStructureColumn,
+  KirbyStructureFieldProps,
+  KirbyTextFieldProps,
+  KirbyToggleFieldProps,
+  KirbyWriterFieldProps,
+} from "./src/blueprint";
+
 // KQL types
 export type {
   KirbyQueryRequest,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kirby-types",
   "type": "module",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "packageManager": "pnpm@10.27.0",
   "description": "TypeScript types for Kirby Panel plugins and headless CMS usage",
   "author": "Johann Schopplich <hello@johannschopplich.com>",
@@ -43,13 +43,14 @@
     "test": "tsd -f \"test/**/*.test-d.ts\""
   },
   "peerDependencies": {
-    "dayjs": "^1.0.0",
+    "dayjs": "^1.11.13",
     "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"
+    "prosemirror-view": "^1.41.4",
+    "vue": "^2.7.16"
   },
   "peerDependenciesMeta": {
     "dayjs": {
@@ -70,6 +71,9 @@
     "prosemirror-state": {
       "optional": true
     },
+    "prosemirror-view": {
+      "optional": true
+    },
     "vue": {
       "optional": true
     }