@datocms/astro 0.3.5 → 0.4.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@datocms/astro",
   "description": "A set of components and utilities to work faster with DatoCMS in Astro projects.",
   "type": "module",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "sideEffects": false,
   "repository": {
     "type": "git",

package/src/StructuredText/Node.astro

@@ -89,7 +89,7 @@ function findRecordInLinks(node: ItemLink | InlineItem) {
   return record;
 }
 
-const defaultComponents: Record<NodeType, AstroComponent> = {
+const defaultComponents: NodeOverrides = {
   paragraph: Paragraph,
   root: Root,
   span: Span,
@@ -106,11 +106,11 @@ const defaultComponents: Record<NodeType, AstroComponent> = {
 };
 
 const otherNodeComponents: Record<NodeType, AstroComponent> = {
-  ...defaultComponents,
+  ...(defaultComponents as Record<NodeType, AstroComponent>),
   ...nodeOverrides,
 };
 
-const Component = otherNodeComponents[node.type];
+const Component = otherNodeComponents[node.type] as AstroComponent;
 ---
 
 <>

package/src/StructuredText/StructuredText.astro

@@ -18,11 +18,13 @@ import type {
   MarkOverrides,
 } from './types';
 
-// It would be better to type this as:
+// It would be better to type this as a generic:
 //
 // interface Props<R1 extends DatocmsRecord = any, R2 extends DatocmsRecord = any>
 //
 // but it's currently not possible: https://github.com/withastro/roadmap/discussions/601#discussioncomment-10333959
+//
+// In the meantime, you can use ensureValidStructuredTextProps()
 
 interface Props {
   /** The actual [field value](https://www.datocms.com/docs/structured-text/dast) you get from a DatoCMS Structured Text field */

package/src/StructuredText/ensureValidStructuredTextProps.ts

@@ -0,0 +1,68 @@
+import {
+  type Node as DastNode,
+  type Record as DatocmsRecord,
+  type Document,
+  type StructuredText,
+} from 'datocms-structured-text-utils';
+import type { BlockComponents, InlineRecordComponents, LinkToRecordComponents } from './types';
+
+type Props<R1 extends DatocmsRecord, R2 extends DatocmsRecord> =
+  | {
+      /** The actual [field value](https://www.datocms.com/docs/structured-text/dast) you get from a DatoCMS Structured Text field */
+      data: Document | DastNode | null | undefined;
+      blockComponents?: never;
+      linkToRecordComponents?: never;
+      inlineRecordComponents?: never;
+    }
+  | {
+      /** The actual [field value](https://www.datocms.com/docs/structured-text/dast) you get from a DatoCMS Structured Text field */
+      data:
+        | (Omit<StructuredText<R1, R2>, 'blocks' | 'links'> & { blocks: R1[]; links: R2[] })
+        | null
+        | undefined;
+      /** An object in which the keys are the `__typename` of the blocks to be rendered, and the values are the Astro components  */
+      blockComponents: BlockComponents<R1, R2>;
+      /** An object in which the keys are the `__typename` of the records to be rendered, and the values are the Astro components */
+      linkToRecordComponents: LinkToRecordComponents<R1, R2>;
+      /** An object in which the keys are the `__typename` of the records to be rendered, and the values are the Astro components */
+      inlineRecordComponents: InlineRecordComponents<R1, R2>;
+    }
+  | {
+      /** The actual [field value](https://www.datocms.com/docs/structured-text/dast) you get from a DatoCMS Structured Text field */
+      data:
+        | (Omit<StructuredText<R1, R2>, 'blocks' | 'links'> & { blocks: R1[]; links?: never })
+        | null
+        | undefined;
+      /** An object in which the keys are the `__typename` of the blocks to be rendered, and the values are the Astro components  */
+      blockComponents: BlockComponents<R1, R2>;
+      linkToRecordComponents?: never;
+      inlineRecordComponents?: never;
+    }
+  | {
+      /** The actual [field value](https://www.datocms.com/docs/structured-text/dast) you get from a DatoCMS Structured Text field */
+      data:
+        | (Omit<StructuredText<R1, R2>, 'blocks' | 'links'> & { blocks?: never; links: R2[] })
+        | null
+        | undefined;
+      blockComponents?: never;
+      /** An object in which the keys are the `__typename` of the records to be rendered, and the values are the Astro components */
+      linkToRecordComponents: LinkToRecordComponents<R1, R2>;
+      /** An object in which the keys are the `__typename` of the records to be rendered, and the values are the Astro components */
+      inlineRecordComponents: InlineRecordComponents<R1, R2>;
+    }
+  | {
+      /** The actual [field value](https://www.datocms.com/docs/structured-text/dast) you get from a DatoCMS Structured Text field */
+      data:
+        | (Omit<StructuredText<R1, R2>, 'blocks' | 'links'> & { blocks?: never; links?: never })
+        | null
+        | undefined;
+      blockComponents?: never;
+      linkToRecordComponents?: never;
+      inlineRecordComponents?: never;
+    };
+
+export function ensureValidStructuredTextProps<R1 extends DatocmsRecord, R2 extends DatocmsRecord>(
+  props: Props<R1, R2>,
+): Props<R1, R2> {
+  return props;
+}

package/src/StructuredText/index.ts

@@ -5,4 +5,6 @@ export {
   type TransformedMeta,
 } from 'datocms-structured-text-generic-html-renderer';
 
+export { ensureValidStructuredTextProps } from './ensureValidStructuredTextProps';
+
 export { StructuredText };

package/src/StructuredText/types.ts

@@ -1,23 +1,60 @@
-import type { Record as DatocmsRecord, Mark, NodeType } from 'datocms-structured-text-utils';
+import type { TransformedMeta } from 'datocms-structured-text-generic-html-renderer';
+import type {
+  Block,
+  Record as DatocmsRecord,
+  InlineItem,
+  ItemLink,
+  Mark,
+  Node,
+  Span,
+} from 'datocms-structured-text-utils';
 
 // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-export type AstroComponent = (props: any) => any;
+export type AstroComponent<P = any> = (props: P) => any;
 
-export type BlockComponents<R1 extends DatocmsRecord, R2 extends DatocmsRecord> = Record<
-  R1['__typename'],
-  AstroComponent
->;
+export type BlockComponents<R1 extends DatocmsRecord, _R2 extends DatocmsRecord> = {
+  [R in R1 as R['__typename']]: AstroComponent<{ block: R }>;
+};
 
-export type LinkToRecordComponents<R1 extends DatocmsRecord, R2 extends DatocmsRecord> = Record<
-  R2['__typename'],
-  AstroComponent
->;
+export type LinkToRecordComponents<_R1 extends DatocmsRecord, R2 extends DatocmsRecord> = {
+  [R in R2 as R['__typename']]: AstroComponent<{
+    node: ItemLink;
+    attrs: TransformedMeta;
+    record: R;
+  }>;
+};
 
-export type InlineRecordComponents<R1 extends DatocmsRecord, R2 extends DatocmsRecord> = Record<
-  R2['__typename'],
-  AstroComponent
->;
+export type InlineRecordComponents<_R1 extends DatocmsRecord, R2 extends DatocmsRecord> = {
+  [R in R2 as R['__typename']]: AstroComponent<{ record: R }>;
+};
 
-export type NodeOverrides = Partial<Record<NodeType, AstroComponent>>;
+export type NodeOverrides = Partial<{
+  [N in Node as N['type']]: AstroComponent<
+    N extends ItemLink
+      ? {
+          node: ItemLink;
+          record: DatocmsRecord;
+          linkToRecordComponents?: LinkToRecordComponents<DatocmsRecord, DatocmsRecord>;
+        }
+      : N extends InlineItem
+        ? {
+            node: InlineItem;
+            record: DatocmsRecord;
+            inlineRecordComponents?: InlineRecordComponents<DatocmsRecord, DatocmsRecord>;
+          }
+        : N extends Block
+          ? {
+              node: Block;
+              block: DatocmsRecord;
+              blockComponents?: BlockComponents<DatocmsRecord, DatocmsRecord>;
+            }
+          : N extends Span
+            ? {
+                node: N;
+                markOverrides?: MarkOverrides;
+              }
+            : { node: N }
+  >;
+}>;
 
-export type MarkOverrides = Partial<Record<Mark, AstroComponent>>;
+export type MarkOverrides = Partial<Record<Mark, AstroComponent | string>>;