feat: extend functionality of usePortableText

.changeset/giant-mugs-look.md

@@ -0,0 +1,22 @@
+---
+"astro-portabletext": minor
+---
+
+Feat: `usePortableText(node)` utility function returns new properties and some have been deprecated.
+
+Refer to the `utils docs` for usage.
+
+**Added**
+
+| Property                        | Type       | Description                                                                                                                      |
+| :------------------------------ | :--------- | :------------------------------------------------------------------------------------------------------------------------------- |
+| getDefaultComponent             | `function` | Returns the `default` component related to the passed in `node`. Use this when you need to fall back to the `default` component. |
+| getUnknownComponent             | `function` | Returns the counterpart `unknown(Block\|List\|ListItem\|Mark\|Type)` component related to the passed in `node`.                  |
+| notifyMissingComponentHandler   | `function` | Calls `onMissingComponent` handler. Pass in a `string` to override `default` message.                                            |
+
+**Deprecated**
+
+| Property                        | Type       | Description                                                                                                                      |
+| :------------------------------ | :--------- | :------------------------------------------------------------------------------------------------------------------------------- |
+| next | `function` | Use `getDefaultComponent`                                                                                                        |
+| onMissingComponent | `function` | Use `notifyMissingComponentHandler`                                                                                              |

.prettierignore

@@ -10,4 +10,3 @@ pnpm-lock.yaml
 # Components
 astro-portabletext/components/Block.astro
 astro-portabletext/components/Mark.astro
-astro-portabletext/components/Raw.astro

astro-portabletext/components/Block.astro

@@ -6,9 +6,11 @@ export type Props = $<Block>;
 
 const props = Astro.props;
 const { node, index, isInline, ...attrs } = props;
-const { next } = usePortableText(node);
 const styleIs = (style: string) => style === node.style;
-const Next = next();
+
+const { getUnknownComponent } = usePortableText(node);
+
+const UnknownStyle = getUnknownComponent();
 ---
 
 {
@@ -29,6 +31,6 @@ const Next = next();
   ) : styleIs("normal") ? (
     <p {...attrs}><slot /></p>
   ) : (
-    <Next {...props}><slot /></Next>
+    <UnknownStyle {...props}><slot /></UnknownStyle>
   )
 }

astro-portabletext/components/Mark.astro

@@ -6,9 +6,11 @@ export type Props = $<Mark>;
 
 const props = Astro.props;
 const { node, index, isInline, ...attrs } = props;
-const { next } = usePortableText(node);
 const markTypeIs = (markType: string) => markType === node.markType;
-const Next = next();
+
+const { getUnknownComponent } = usePortableText(node);
+
+const UnknownMarkType = getUnknownComponent();
 ---
 
 {
@@ -25,6 +27,6 @@ const Next = next();
   ) : markTypeIs("underline") ? (
     <span style="text-decoration: underline;" {...attrs}><slot /></span>
   ) : (
-    <Next {...props}><slot /></Next>
+    <UnknownMarkType {...props}><slot /></UnknownMarkType>
   )
 }