@input/pen-types 0.1.3 → 0.1.5

package/dist/index.d.cts

@@ -1051,21 +1051,21 @@ interface BlockAuthoring {
     flowCapability?: FlowBlockCapability;
     selectionRole?: BlockSelectionRole;
 }
-interface BlockSchema<Type extends string = string, Props extends Record<string, PropSchema> = Record<string, PropSchema>, Content extends ContentType = "inline"> {
+interface BlockSchema<Type extends string = string, Props extends Record<string, PropSchema> = Record<string, PropSchema>, Content extends ContentType = ContentType> {
     type: Type;
     propSchema: Props;
     content: Content;
     layout?: LayoutSchema;
     serialize: {
-        toMarkdown?: (block: Block<Type, InferProps<Props>>) => string;
-        fromMarkdown?: (node: MarkdownNode) => BlockImportMatch<Type, InferProps<Props>> | null;
-        toHTML?: (block: Block<Type, InferProps<Props>>) => string;
-        fromHTML?: (element: HTMLImportElement) => BlockImportMatch<Type, InferProps<Props>> | null;
-        toXML?: (block: Block<Type, InferProps<Props>>) => string;
-        fromXML?: (element: XMLElement) => Block<Type, InferProps<Props>> | null;
+        toMarkdown?(block: Block<Type, InferProps<Props>>): string;
+        fromMarkdown?(node: MarkdownNode): BlockImportMatch<Type, InferProps<Props>> | null;
+        toHTML?(block: Block<Type, InferProps<Props>>): string;
+        fromHTML?(element: HTMLImportElement): BlockImportMatch<Type, InferProps<Props>> | null;
+        toXML?(block: Block<Type, InferProps<Props>>): string;
+        fromXML?(element: XMLElement): Block<Type, InferProps<Props>> | null;
     };
-    normalize?: (block: Block<Type, InferProps<Props>>) => Block<Type, InferProps<Props>>;
-    validateProps?: (raw: Record<string, unknown>) => InferProps<Props>;
+    normalize?(block: Block<Type, InferProps<Props>>): Block<Type, InferProps<Props>>;
+    validateProps?(raw: Record<string, unknown>): InferProps<Props>;
     fieldEditor?: FieldEditorType;
     keyBindings?: readonly KeyBinding[];
     placeholder?: string;
@@ -1084,6 +1084,8 @@ interface InlineSchema<Type extends string = string, Props extends Record<string
         fromMarkdown?: (node: MarkdownNode) => Record<string, unknown> | null;
         toHTML?: (text: string, props: Record<string, unknown>) => string;
         toXML?: (text: string, props: Record<string, unknown>) => string;
+        /** Plain-text interchange for inline atoms (`kind: "node"`). Marks ignore this. */
+        toText?: (props: Record<string, unknown>) => string;
     };
     apply?(content: unknown, range: Range, value: unknown): void;
     remove?(content: unknown, range: Range): void;
@@ -2410,6 +2412,11 @@ interface BlockRenderContext {
 }
 type BlockRenderer<Props = Record<string, unknown>> = (block: BlockHandle, ctx: BlockRenderContext) => unknown;
 
+/**
+ * Contract-layer block-suggestion shape. Runtime review items use
+ * `PersistentBlockSuggestion` on `@input/pen-ai`, which also admits
+ * `split-block` and `format-text` actions and a `format` previousState.
+ */
 interface BlockSuggestion {
     id: string;
     action: "insert-block" | "delete-block" | "move-block" | "convert-block";

package/dist/index.d.ts

@@ -1051,21 +1051,21 @@ interface BlockAuthoring {
     flowCapability?: FlowBlockCapability;
     selectionRole?: BlockSelectionRole;
 }
-interface BlockSchema<Type extends string = string, Props extends Record<string, PropSchema> = Record<string, PropSchema>, Content extends ContentType = "inline"> {
+interface BlockSchema<Type extends string = string, Props extends Record<string, PropSchema> = Record<string, PropSchema>, Content extends ContentType = ContentType> {
     type: Type;
     propSchema: Props;
     content: Content;
     layout?: LayoutSchema;
     serialize: {
-        toMarkdown?: (block: Block<Type, InferProps<Props>>) => string;
-        fromMarkdown?: (node: MarkdownNode) => BlockImportMatch<Type, InferProps<Props>> | null;
-        toHTML?: (block: Block<Type, InferProps<Props>>) => string;
-        fromHTML?: (element: HTMLImportElement) => BlockImportMatch<Type, InferProps<Props>> | null;
-        toXML?: (block: Block<Type, InferProps<Props>>) => string;
-        fromXML?: (element: XMLElement) => Block<Type, InferProps<Props>> | null;
+        toMarkdown?(block: Block<Type, InferProps<Props>>): string;
+        fromMarkdown?(node: MarkdownNode): BlockImportMatch<Type, InferProps<Props>> | null;
+        toHTML?(block: Block<Type, InferProps<Props>>): string;
+        fromHTML?(element: HTMLImportElement): BlockImportMatch<Type, InferProps<Props>> | null;
+        toXML?(block: Block<Type, InferProps<Props>>): string;
+        fromXML?(element: XMLElement): Block<Type, InferProps<Props>> | null;
     };
-    normalize?: (block: Block<Type, InferProps<Props>>) => Block<Type, InferProps<Props>>;
-    validateProps?: (raw: Record<string, unknown>) => InferProps<Props>;
+    normalize?(block: Block<Type, InferProps<Props>>): Block<Type, InferProps<Props>>;
+    validateProps?(raw: Record<string, unknown>): InferProps<Props>;
     fieldEditor?: FieldEditorType;
     keyBindings?: readonly KeyBinding[];
     placeholder?: string;
@@ -1084,6 +1084,8 @@ interface InlineSchema<Type extends string = string, Props extends Record<string
         fromMarkdown?: (node: MarkdownNode) => Record<string, unknown> | null;
         toHTML?: (text: string, props: Record<string, unknown>) => string;
         toXML?: (text: string, props: Record<string, unknown>) => string;
+        /** Plain-text interchange for inline atoms (`kind: "node"`). Marks ignore this. */
+        toText?: (props: Record<string, unknown>) => string;
     };
     apply?(content: unknown, range: Range, value: unknown): void;
     remove?(content: unknown, range: Range): void;
@@ -2410,6 +2412,11 @@ interface BlockRenderContext {
 }
 type BlockRenderer<Props = Record<string, unknown>> = (block: BlockHandle, ctx: BlockRenderContext) => unknown;
 
+/**
+ * Contract-layer block-suggestion shape. Runtime review items use
+ * `PersistentBlockSuggestion` on `@input/pen-ai`, which also admits
+ * `split-block` and `format-text` actions and a `format` previousState.
+ */
 interface BlockSuggestion {
     id: string;
     action: "insert-block" | "delete-block" | "move-block" | "convert-block";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@input/pen-types",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Type definitions and lightweight runtime helpers for Pen",
   "license": "MIT",
   "homepage": "https://github.com/input-systems/pen#readme",