@datocms/astro 0.5.1 → 0.6.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.5.1",
+  "version": "0.6.0",
   "sideEffects": false,
   "repository": {
     "type": "git",
@@ -45,8 +45,8 @@
   "dependencies": {
     "@0no-co/graphql.web": "^1.0.7",
     "datocms-listen": "^1.0.1",
-    "datocms-structured-text-generic-html-renderer": "^4.1.2",
-    "datocms-structured-text-utils": "^4.1.2"
+    "datocms-structured-text-generic-html-renderer": "^5.0.0",
+    "datocms-structured-text-utils": "^5.0.0"
   },
   "peerDependencies": {
     "astro": "*"

package/src/Image/Image.astro

@@ -14,7 +14,7 @@ const {
   usePlaceholder = true,
   sizes,
   srcSetCandidates = [0.25, 0.5, 0.75, 1, 1.5, 2, 3, 4],
-  referrerPolicy = 'strict-origin',
+  referrerPolicy = 'no-referrer-when-downgrade',
 } = Astro.props;
 
 const placeholderStyle =

package/src/Image/README.md

@@ -122,4 +122,4 @@ Here's a complete recap of what `responsiveImage` offers:
 | sizes            | string                   | undefined                          | :x:                | The HTML5 [`sizes`](https://web.dev/learn/design/responsive-images/#sizes) attribute for the image (will be used `data.sizes` as a fallback)         |
 | usePlaceholder   | Boolean                  | true                               | :x:                | Whether the image should use a blurred image placeholder                                                                                             |
 | srcSetCandidates | Array<number>            | [0.25, 0.5, 0.75, 1, 1.5, 2, 3, 4] | :x:                | If `data` does not contain `srcSet`, the candidates for the `srcset` attribute of the image will be auto-generated based on these width multipliers  |
-| referrerPolicy   | string                   | `strict-origin`                    | :x:                | Defines which referrer is sent when fetching the image. Defaults to `strict-origin` to give more useful stats in DatoCMS Project Usages              |
+| referrerPolicy   | string                   | `no-referrer-when-downgrade`       | :x:                | Defines which referrer is sent when fetching the image. Defaults to `no-referrer-when-downgrade` to give more useful stats in DatoCMS Project Usages |

package/src/Image/types.ts

@@ -67,7 +67,7 @@ export type ImageProps = {
    * Defines which referrer is sent when fetching the image
    * Read more: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#referrerpolicy
    *
-   * Defaults to `strict-origin` to give more useful stats in DatoCMS Project Usages
+   * Defaults to `no-referrer-when-downgrade` to give more useful stats in DatoCMS Project Usages
    **/
   referrerPolicy?: JSX.HTMLAttributeReferrerPolicy;
 };

package/src/StructuredText/README.md

@@ -94,6 +94,12 @@ const query = gql`
             label
             url
           }
+        }
+        inlineBlocks {
+          ... on RecordInterface {
+            id
+            __typename
+          }
           ... on NewsletterSignupRecord {
             title
           }
@@ -122,6 +128,8 @@ const { blogPost } = await executeQuery(query, { token: '<YOUR-API-TOKEN>' });
     data={blogPost.content}
     blockComponents={{
       CtaRecord: Cta,
+    }}
+    inlineBlockComponents={{
       NewsletterSignupRecord: NewsletterSignup,
     }}
     inlineRecordComponents={{
@@ -176,6 +184,8 @@ import { StructuredText, ensureValidStructuredTextProps } from '@datocms/astro/S
     data: blogPost.content,
     blockComponents: {
       CtaRecord: Cta,
+    },
+    inlineBlockComponents: {
       NewsletterSignupRecord: NewsletterSignup,
     },
     inlineRecordComponents: {

package/src/StructuredText/StructuredText.astro

@@ -22,7 +22,7 @@ import type { NodeOverrides, MarkOverrides, AstroComponent } from './types';
 
 interface Props {
   /** The actual [field value](https://www.datocms.com/docs/structured-text/dast) you get from a DatoCMS Structured Text field */
-  data: StructuredText<DatocmsRecord, DatocmsRecord> | Document | DastNode | null | undefined;
+  data: StructuredText | Document | DastNode | 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?: Record<string, AstroComponent>;

package/src/StructuredText/ensureValidStructuredTextProps.ts

@@ -4,14 +4,9 @@ import {
   type Document,
   type StructuredText,
 } from 'datocms-structured-text-utils';
-import type {
-  BlockComponents,
-  InlineBlockComponents,
-  InlineRecordComponents,
-  LinkToRecordComponents,
-} from './types';
+import type { BlockComponents, InlineRecordComponents, LinkToRecordComponents } from './types';
 
-type Props<R1 extends DatocmsRecord, R2 extends DatocmsRecord> =
+type Props<B extends DatocmsRecord, L extends DatocmsRecord, I 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;
@@ -23,57 +18,129 @@ 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:
-        | (Omit<StructuredText<R1, R2>, 'blocks' | 'links'> & { blocks: R1[]; links: R2[] })
+        | (Omit<StructuredText<B, L, I>, 'blocks' | 'links' | 'inlineBlocks'> & {
+            blocks: B[];
+            links: never;
+            inlineBlocks: 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>;
-      /** An object in which the keys are the `__typename` of the inline blocks to be rendered, and the values are the Astro components  */
-      inlineBlockComponents: BlockComponents<R1, R2>;
+      blockComponents: BlockComponents<B, L, I>;
+      inlineBlockComponents?: 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<B, L, I>, 'blocks' | 'links' | 'inlineBlocks'> & {
+            blocks: never;
+            links: L[];
+            inlineBlocks: never;
+          })
+        | null
+        | undefined;
+      blockComponents?: never;
+      inlineBlockComponents?: 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>;
+      linkToRecordComponents: LinkToRecordComponents<B, L, I>;
       /** 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>;
+      inlineRecordComponents: InlineRecordComponents<B, L, I>;
     }
   | {
       /** 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 })
+        | (Omit<StructuredText<B, L, I>, 'blocks' | 'links' | 'inlineBlocks'> & {
+            blocks: never;
+            links: never;
+            inlineBlocks: I[];
+          })
         | 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>;
-      inlineBlockComponents: InlineBlockComponents<R1, R2>;
+      blockComponents?: never;
+      /** An object in which the keys are the `__typename` of the inline blocks to be rendered, and the values are the Astro components  */
+      inlineBlockComponents: BlockComponents<B, L, I>;
       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[] })
+        | (Omit<StructuredText<B, L, I>, 'blocks' | 'links' | 'inlineBlocks'> & {
+            blocks: never;
+            links: L[];
+            inlineBlocks: I[];
+          })
         | null
         | undefined;
       blockComponents?: never;
-      inlineBlockComponents?: never;
+      /** An object in which the keys are the `__typename` of the inline blocks to be rendered, and the values are the Astro components  */
+      inlineBlockComponents: BlockComponents<B, L, I>;
       /** 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>;
+      linkToRecordComponents: LinkToRecordComponents<B, L, I>;
       /** 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>;
+      inlineRecordComponents: InlineRecordComponents<B, L, I>;
     }
   | {
       /** 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 })
+        | (Omit<StructuredText<B, L, I>, 'blocks' | 'links' | 'inlineBlocks'> & {
+            blocks: B[];
+            links: never;
+            inlineBlocks: I[];
+          })
         | null
         | undefined;
-      blockComponents?: never;
-      inlineBlockComponents?: never;
+      /** An object in which the keys are the `__typename` of the blocks to be rendered, and the values are the Astro components  */
+      blockComponents: BlockComponents<B, L, I>;
+      /** An object in which the keys are the `__typename` of the inline blocks to be rendered, and the values are the Astro components  */
+      inlineBlockComponents: BlockComponents<B, L, I>;
       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<B, L, I>, 'blocks' | 'links' | 'inlineBlocks'> & {
+            blocks: B[];
+            links: L[];
+            inlineBlocks: 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<B, L, I>;
+      inlineBlockComponents?: 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<B, L, I>;
+      /** An object in which the keys are the `__typename` of the records to be rendered, and the values are the Astro components */
+      inlineRecordComponents: InlineRecordComponents<B, L, I>;
+    }
+  | {
+      /** The actual [field value](https://www.datocms.com/docs/structured-text/dast) you get from a DatoCMS Structured Text field */
+      data:
+        | (Omit<StructuredText<B, L, I>, 'blocks' | 'links' | 'inlineBlocks'> & {
+            blocks: B[];
+            links: L[];
+            inlineBlocks: I[];
+          })
+        | 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<B, L, I>;
+      /** An object in which the keys are the `__typename` of the inline blocks to be rendered, and the values are the Astro components  */
+      inlineBlockComponents: BlockComponents<B, L, I>;
+      /** An object in which the keys are the `__typename` of the records to be rendered, and the values are the Astro components */
+      linkToRecordComponents: LinkToRecordComponents<B, L, I>;
+      /** An object in which the keys are the `__typename` of the records to be rendered, and the values are the Astro components */
+      inlineRecordComponents: InlineRecordComponents<B, L, I>;
     };
 
-export function ensureValidStructuredTextProps<R1 extends DatocmsRecord, R2 extends DatocmsRecord>(
-  props: Props<R1, R2>,
-): Props<R1, R2> {
+export function ensureValidStructuredTextProps<
+  B extends DatocmsRecord,
+  L extends DatocmsRecord,
+  I extends DatocmsRecord,
+>(props: Props<B, L, I>): Props<B, L, I> {
   return props;
 }

package/src/StructuredText/types.ts

@@ -13,24 +13,40 @@ import type {
 // biome-ignore lint/suspicious/noExplicitAny: <explanation>
 export type AstroComponent<P = any> = (props: P) => any;
 
-export type BlockComponents<R1 extends DatocmsRecord, _R2 extends DatocmsRecord> = {
-  [R in R1 as R['__typename']]: AstroComponent<{ block: R }>;
+export type BlockComponents<
+  B extends DatocmsRecord,
+  _L extends DatocmsRecord,
+  _I extends DatocmsRecord,
+> = {
+  [R in B as R['__typename']]: AstroComponent<{ block: R }>;
 };
 
-export type InlineBlockComponents<R1 extends DatocmsRecord, _R2 extends DatocmsRecord> = {
-  [R in R1 as R['__typename']]: AstroComponent<{ block: R }>;
+export type InlineBlockComponents<
+  _B extends DatocmsRecord,
+  _L extends DatocmsRecord,
+  I extends DatocmsRecord,
+> = {
+  [R in I as R['__typename']]: AstroComponent<{ block: R }>;
 };
 
-export type LinkToRecordComponents<_R1 extends DatocmsRecord, R2 extends DatocmsRecord> = {
-  [R in R2 as R['__typename']]: AstroComponent<{
+export type LinkToRecordComponents<
+  _B extends DatocmsRecord,
+  L extends DatocmsRecord,
+  _I extends DatocmsRecord,
+> = {
+  [R in L as R['__typename']]: AstroComponent<{
     node: ItemLink;
     attrs: TransformedMeta;
     record: R;
   }>;
 };
 
-export type InlineRecordComponents<_R1 extends DatocmsRecord, R2 extends DatocmsRecord> = {
-  [R in R2 as R['__typename']]: AstroComponent<{ record: R }>;
+export type InlineRecordComponents<
+  _B extends DatocmsRecord,
+  L extends DatocmsRecord,
+  _I extends DatocmsRecord,
+> = {
+  [R in L as R['__typename']]: AstroComponent<{ record: R }>;
 };
 
 export type NodeOverrides = Partial<{
@@ -39,19 +55,27 @@ export type NodeOverrides = Partial<{
       ? {
           node: ItemLink;
           record: DatocmsRecord;
-          linkToRecordComponents?: LinkToRecordComponents<DatocmsRecord, DatocmsRecord>;
+          linkToRecordComponents?: LinkToRecordComponents<
+            DatocmsRecord,
+            DatocmsRecord,
+            DatocmsRecord
+          >;
         }
       : N extends InlineItem
         ? {
             node: InlineItem;
             record: DatocmsRecord;
-            inlineRecordComponents?: InlineRecordComponents<DatocmsRecord, DatocmsRecord>;
+            inlineRecordComponents?: InlineRecordComponents<
+              DatocmsRecord,
+              DatocmsRecord,
+              DatocmsRecord
+            >;
           }
         : N extends Block
           ? {
               node: Block;
               block: DatocmsRecord;
-              blockComponents?: BlockComponents<DatocmsRecord, DatocmsRecord>;
+              blockComponents?: BlockComponents<DatocmsRecord, DatocmsRecord, DatocmsRecord>;
             }
           : N extends Span
             ? {
@@ -62,7 +86,11 @@ export type NodeOverrides = Partial<{
               ? {
                   node: N;
                   block: DatocmsRecord;
-                  inlineBlockComponents: InlineBlockComponents<DatocmsRecord, DatocmsRecord>;
+                  inlineBlockComponents: InlineBlockComponents<
+                    DatocmsRecord,
+                    DatocmsRecord,
+                    DatocmsRecord
+                  >;
                 }
               : { node: N }
   >;