@weatherboard/cms 0.1.0 → 0.3.0

package/dist/portable/sections.d.cts

@@ -0,0 +1,136 @@
+/**
+ * A-1915 (A-1739 M1c). The reader's half of the shared section set that
+ * `@weatherboard/sanity-schema-base` declares in `src/sections.ts` (A-1889):
+ * `page.sections[]`, drawn from the four home section types plus
+ * `textMediaBlock`, `faqBlock` (items `faqItem`), `galleryBlock` and
+ * `contactBlock`.
+ *
+ * ===========================================================================
+ * LAYOUTS ARE THE A-1876 VARIANT NAMES, EXACTLY
+ * ===========================================================================
+ *
+ * The three lists below are the composition variant names, spelled as A-1876
+ * spells them, so a contract test can import them and compare them with the
+ * UI package's. A missing or unknown stored `layout` resolves to the
+ * composition's default and records `section.layout.defaulted`, the rule cms
+ * 0.2.0 set for `siteHero.layout`. It never throws and never yields an empty
+ * section.
+ *
+ * ===========================================================================
+ * WARNINGS, NOT REFUSALS, FOR THREE THINGS
+ * ===========================================================================
+ *
+ * The rest of this reader refuses a malformed document by name. Three things
+ * in a section are warnings instead, each recorded with its path:
+ *
+ *   section.layout.defaulted    missing or unknown layout: the default renders
+ *   section.type.unknown        a section `_type` this reader does not know is
+ *                               skipped, so a newer model never breaks a page
+ *   section.image.missing-alt   an image without alt text is DROPPED, never
+ *                               rendered without it
+ *   section.image.missing-asset an image with no uploaded asset is dropped
+ *   section.empty.skipped       a section left with nothing to show (a gallery
+ *                               whose every photo was dropped, a contact
+ *                               section switched off and empty) is skipped
+ */
+import type { ActionInput, CompositionBlockInput, CopyInput } from "./site-content.cjs";
+/** `Split`: text with media. */
+export declare const SPLIT_LAYOUTS: readonly ["media-end", "media-start", "media-below"];
+/** `HeadingList`: a heading column and a list column. */
+export declare const HEADING_LIST_LAYOUTS: readonly ["beside", "stacked"];
+/** `StaggerRow`: a row of two to four items. */
+export declare const STAGGER_ROW_LAYOUTS: readonly ["staggered", "aligned"];
+export type SplitLayout = (typeof SPLIT_LAYOUTS)[number];
+export type HeadingListLayout = (typeof HEADING_LIST_LAYOUTS)[number];
+export type StaggerRowLayout = (typeof STAGGER_ROW_LAYOUTS)[number];
+/** What a missing or unknown `layout` resolves to, per composition. */
+export declare const SECTION_LAYOUT_DEFAULTS: {
+    readonly Split: "media-end";
+    readonly HeadingList: "beside";
+    readonly StaggerRow: "staggered";
+};
+/** Sanity `_type` on the left, the reader's `kind` on the right; the same rows as schema-base's `SECTION_CONTRACTS`. */
+export declare const READER_SECTION_KINDS: {
+    readonly featureStoriesBlock: "feature_stories";
+    readonly surfaceCardBlock: "cta";
+    readonly accentBandBlock: "accent_band";
+    readonly locationsBlock: "locations";
+    readonly textMediaBlock: "text_media";
+    readonly faqBlock: "faq";
+    readonly galleryBlock: "gallery";
+    readonly contactBlock: "contact";
+};
+/** A gallery is a `StaggerRow`, which holds two to four items. */
+export declare const READER_GALLERY_PHOTO_MIN = 2;
+export declare const READER_GALLERY_PHOTO_LIMIT = 4;
+export declare const SECTION_WARNINGS: {
+    readonly layoutDefaulted: "section.layout.defaulted";
+    readonly unknownType: "section.type.unknown";
+    readonly imageMissingAlt: "section.image.missing-alt";
+    readonly imageMissingAsset: "section.image.missing-asset";
+    readonly emptySkipped: "section.empty.skipped";
+};
+export type SectionWarningCode = (typeof SECTION_WARNINGS)[keyof typeof SECTION_WARNINGS];
+/** A named warning and the path in the stored document it is about. Never copy. */
+export type SectionWarning = {
+    readonly code: SectionWarningCode;
+    readonly where: string;
+};
+/** A Sanity image as a site needs it. `asset` is the image asset's id; `alt` is never empty. */
+export type SectionImageInput = {
+    readonly asset: string;
+    readonly alt: string;
+    readonly caption: string | null;
+    readonly hotspot: {
+        readonly x: number;
+        readonly y: number;
+    } | null;
+};
+export type TextMediaSectionInput = {
+    readonly kind: "text_media";
+    readonly anchor: string | null;
+    readonly layout: SplitLayout;
+    readonly heading: CopyInput;
+    readonly tail: CopyInput | null;
+    readonly body: CopyInput;
+    readonly action: ActionInput | null;
+    /** `null` only when the stored photo was dropped (no alt text or no asset); a warning names it. */
+    readonly image: SectionImageInput | null;
+};
+export type FaqSectionInput = {
+    readonly kind: "faq";
+    readonly anchor: string | null;
+    readonly layout: HeadingListLayout;
+    readonly heading: CopyInput;
+    readonly tail: CopyInput | null;
+    readonly intro: CopyInput | null;
+    readonly items: readonly {
+        readonly question: CopyInput;
+        readonly answer: CopyInput;
+    }[];
+};
+export type GallerySectionInput = {
+    readonly kind: "gallery";
+    readonly anchor: string | null;
+    readonly layout: StaggerRowLayout;
+    readonly heading: CopyInput | null;
+    readonly images: readonly SectionImageInput[];
+};
+export type ContactSectionInput = {
+    readonly kind: "contact";
+    readonly anchor: string | null;
+    readonly layout: SplitLayout;
+    readonly heading: CopyInput;
+    readonly body: CopyInput | null;
+    /** Show the site settings' email address. */
+    readonly showEmail: boolean;
+    /** Show the site settings' phone number. */
+    readonly showPhone: boolean;
+    readonly action: ActionInput | null;
+    readonly image: SectionImageInput | null;
+};
+export type NewSectionInput = TextMediaSectionInput | FaqSectionInput | GallerySectionInput | ContactSectionInput;
+/** One entry of `PageContent.sections`: a home section kind or one of the new kinds. */
+export type PageSectionInput = Exclude<CompositionBlockInput, {
+    readonly kind: "campaign";
+}> | NewSectionInput;

package/dist/portable/sections.d.mts

@@ -0,0 +1,136 @@
+/**
+ * A-1915 (A-1739 M1c). The reader's half of the shared section set that
+ * `@weatherboard/sanity-schema-base` declares in `src/sections.ts` (A-1889):
+ * `page.sections[]`, drawn from the four home section types plus
+ * `textMediaBlock`, `faqBlock` (items `faqItem`), `galleryBlock` and
+ * `contactBlock`.
+ *
+ * ===========================================================================
+ * LAYOUTS ARE THE A-1876 VARIANT NAMES, EXACTLY
+ * ===========================================================================
+ *
+ * The three lists below are the composition variant names, spelled as A-1876
+ * spells them, so a contract test can import them and compare them with the
+ * UI package's. A missing or unknown stored `layout` resolves to the
+ * composition's default and records `section.layout.defaulted`, the rule cms
+ * 0.2.0 set for `siteHero.layout`. It never throws and never yields an empty
+ * section.
+ *
+ * ===========================================================================
+ * WARNINGS, NOT REFUSALS, FOR THREE THINGS
+ * ===========================================================================
+ *
+ * The rest of this reader refuses a malformed document by name. Three things
+ * in a section are warnings instead, each recorded with its path:
+ *
+ *   section.layout.defaulted    missing or unknown layout: the default renders
+ *   section.type.unknown        a section `_type` this reader does not know is
+ *                               skipped, so a newer model never breaks a page
+ *   section.image.missing-alt   an image without alt text is DROPPED, never
+ *                               rendered without it
+ *   section.image.missing-asset an image with no uploaded asset is dropped
+ *   section.empty.skipped       a section left with nothing to show (a gallery
+ *                               whose every photo was dropped, a contact
+ *                               section switched off and empty) is skipped
+ */
+import type { ActionInput, CompositionBlockInput, CopyInput } from "./site-content.mjs";
+/** `Split`: text with media. */
+export declare const SPLIT_LAYOUTS: readonly ["media-end", "media-start", "media-below"];
+/** `HeadingList`: a heading column and a list column. */
+export declare const HEADING_LIST_LAYOUTS: readonly ["beside", "stacked"];
+/** `StaggerRow`: a row of two to four items. */
+export declare const STAGGER_ROW_LAYOUTS: readonly ["staggered", "aligned"];
+export type SplitLayout = (typeof SPLIT_LAYOUTS)[number];
+export type HeadingListLayout = (typeof HEADING_LIST_LAYOUTS)[number];
+export type StaggerRowLayout = (typeof STAGGER_ROW_LAYOUTS)[number];
+/** What a missing or unknown `layout` resolves to, per composition. */
+export declare const SECTION_LAYOUT_DEFAULTS: {
+    readonly Split: "media-end";
+    readonly HeadingList: "beside";
+    readonly StaggerRow: "staggered";
+};
+/** Sanity `_type` on the left, the reader's `kind` on the right; the same rows as schema-base's `SECTION_CONTRACTS`. */
+export declare const READER_SECTION_KINDS: {
+    readonly featureStoriesBlock: "feature_stories";
+    readonly surfaceCardBlock: "cta";
+    readonly accentBandBlock: "accent_band";
+    readonly locationsBlock: "locations";
+    readonly textMediaBlock: "text_media";
+    readonly faqBlock: "faq";
+    readonly galleryBlock: "gallery";
+    readonly contactBlock: "contact";
+};
+/** A gallery is a `StaggerRow`, which holds two to four items. */
+export declare const READER_GALLERY_PHOTO_MIN = 2;
+export declare const READER_GALLERY_PHOTO_LIMIT = 4;
+export declare const SECTION_WARNINGS: {
+    readonly layoutDefaulted: "section.layout.defaulted";
+    readonly unknownType: "section.type.unknown";
+    readonly imageMissingAlt: "section.image.missing-alt";
+    readonly imageMissingAsset: "section.image.missing-asset";
+    readonly emptySkipped: "section.empty.skipped";
+};
+export type SectionWarningCode = (typeof SECTION_WARNINGS)[keyof typeof SECTION_WARNINGS];
+/** A named warning and the path in the stored document it is about. Never copy. */
+export type SectionWarning = {
+    readonly code: SectionWarningCode;
+    readonly where: string;
+};
+/** A Sanity image as a site needs it. `asset` is the image asset's id; `alt` is never empty. */
+export type SectionImageInput = {
+    readonly asset: string;
+    readonly alt: string;
+    readonly caption: string | null;
+    readonly hotspot: {
+        readonly x: number;
+        readonly y: number;
+    } | null;
+};
+export type TextMediaSectionInput = {
+    readonly kind: "text_media";
+    readonly anchor: string | null;
+    readonly layout: SplitLayout;
+    readonly heading: CopyInput;
+    readonly tail: CopyInput | null;
+    readonly body: CopyInput;
+    readonly action: ActionInput | null;
+    /** `null` only when the stored photo was dropped (no alt text or no asset); a warning names it. */
+    readonly image: SectionImageInput | null;
+};
+export type FaqSectionInput = {
+    readonly kind: "faq";
+    readonly anchor: string | null;
+    readonly layout: HeadingListLayout;
+    readonly heading: CopyInput;
+    readonly tail: CopyInput | null;
+    readonly intro: CopyInput | null;
+    readonly items: readonly {
+        readonly question: CopyInput;
+        readonly answer: CopyInput;
+    }[];
+};
+export type GallerySectionInput = {
+    readonly kind: "gallery";
+    readonly anchor: string | null;
+    readonly layout: StaggerRowLayout;
+    readonly heading: CopyInput | null;
+    readonly images: readonly SectionImageInput[];
+};
+export type ContactSectionInput = {
+    readonly kind: "contact";
+    readonly anchor: string | null;
+    readonly layout: SplitLayout;
+    readonly heading: CopyInput;
+    readonly body: CopyInput | null;
+    /** Show the site settings' email address. */
+    readonly showEmail: boolean;
+    /** Show the site settings' phone number. */
+    readonly showPhone: boolean;
+    readonly action: ActionInput | null;
+    readonly image: SectionImageInput | null;
+};
+export type NewSectionInput = TextMediaSectionInput | FaqSectionInput | GallerySectionInput | ContactSectionInput;
+/** One entry of `PageContent.sections`: a home section kind or one of the new kinds. */
+export type PageSectionInput = Exclude<CompositionBlockInput, {
+    readonly kind: "campaign";
+}> | NewSectionInput;

package/dist/portable/sections.d.ts

@@ -0,0 +1,136 @@
+/**
+ * A-1915 (A-1739 M1c). The reader's half of the shared section set that
+ * `@weatherboard/sanity-schema-base` declares in `src/sections.ts` (A-1889):
+ * `page.sections[]`, drawn from the four home section types plus
+ * `textMediaBlock`, `faqBlock` (items `faqItem`), `galleryBlock` and
+ * `contactBlock`.
+ *
+ * ===========================================================================
+ * LAYOUTS ARE THE A-1876 VARIANT NAMES, EXACTLY
+ * ===========================================================================
+ *
+ * The three lists below are the composition variant names, spelled as A-1876
+ * spells them, so a contract test can import them and compare them with the
+ * UI package's. A missing or unknown stored `layout` resolves to the
+ * composition's default and records `section.layout.defaulted`, the rule cms
+ * 0.2.0 set for `siteHero.layout`. It never throws and never yields an empty
+ * section.
+ *
+ * ===========================================================================
+ * WARNINGS, NOT REFUSALS, FOR THREE THINGS
+ * ===========================================================================
+ *
+ * The rest of this reader refuses a malformed document by name. Three things
+ * in a section are warnings instead, each recorded with its path:
+ *
+ *   section.layout.defaulted    missing or unknown layout: the default renders
+ *   section.type.unknown        a section `_type` this reader does not know is
+ *                               skipped, so a newer model never breaks a page
+ *   section.image.missing-alt   an image without alt text is DROPPED, never
+ *                               rendered without it
+ *   section.image.missing-asset an image with no uploaded asset is dropped
+ *   section.empty.skipped       a section left with nothing to show (a gallery
+ *                               whose every photo was dropped, a contact
+ *                               section switched off and empty) is skipped
+ */
+import type { ActionInput, CompositionBlockInput, CopyInput } from "./site-content.js";
+/** `Split`: text with media. */
+export declare const SPLIT_LAYOUTS: readonly ["media-end", "media-start", "media-below"];
+/** `HeadingList`: a heading column and a list column. */
+export declare const HEADING_LIST_LAYOUTS: readonly ["beside", "stacked"];
+/** `StaggerRow`: a row of two to four items. */
+export declare const STAGGER_ROW_LAYOUTS: readonly ["staggered", "aligned"];
+export type SplitLayout = (typeof SPLIT_LAYOUTS)[number];
+export type HeadingListLayout = (typeof HEADING_LIST_LAYOUTS)[number];
+export type StaggerRowLayout = (typeof STAGGER_ROW_LAYOUTS)[number];
+/** What a missing or unknown `layout` resolves to, per composition. */
+export declare const SECTION_LAYOUT_DEFAULTS: {
+    readonly Split: "media-end";
+    readonly HeadingList: "beside";
+    readonly StaggerRow: "staggered";
+};
+/** Sanity `_type` on the left, the reader's `kind` on the right; the same rows as schema-base's `SECTION_CONTRACTS`. */
+export declare const READER_SECTION_KINDS: {
+    readonly featureStoriesBlock: "feature_stories";
+    readonly surfaceCardBlock: "cta";
+    readonly accentBandBlock: "accent_band";
+    readonly locationsBlock: "locations";
+    readonly textMediaBlock: "text_media";
+    readonly faqBlock: "faq";
+    readonly galleryBlock: "gallery";
+    readonly contactBlock: "contact";
+};
+/** A gallery is a `StaggerRow`, which holds two to four items. */
+export declare const READER_GALLERY_PHOTO_MIN = 2;
+export declare const READER_GALLERY_PHOTO_LIMIT = 4;
+export declare const SECTION_WARNINGS: {
+    readonly layoutDefaulted: "section.layout.defaulted";
+    readonly unknownType: "section.type.unknown";
+    readonly imageMissingAlt: "section.image.missing-alt";
+    readonly imageMissingAsset: "section.image.missing-asset";
+    readonly emptySkipped: "section.empty.skipped";
+};
+export type SectionWarningCode = (typeof SECTION_WARNINGS)[keyof typeof SECTION_WARNINGS];
+/** A named warning and the path in the stored document it is about. Never copy. */
+export type SectionWarning = {
+    readonly code: SectionWarningCode;
+    readonly where: string;
+};
+/** A Sanity image as a site needs it. `asset` is the image asset's id; `alt` is never empty. */
+export type SectionImageInput = {
+    readonly asset: string;
+    readonly alt: string;
+    readonly caption: string | null;
+    readonly hotspot: {
+        readonly x: number;
+        readonly y: number;
+    } | null;
+};
+export type TextMediaSectionInput = {
+    readonly kind: "text_media";
+    readonly anchor: string | null;
+    readonly layout: SplitLayout;
+    readonly heading: CopyInput;
+    readonly tail: CopyInput | null;
+    readonly body: CopyInput;
+    readonly action: ActionInput | null;
+    /** `null` only when the stored photo was dropped (no alt text or no asset); a warning names it. */
+    readonly image: SectionImageInput | null;
+};
+export type FaqSectionInput = {
+    readonly kind: "faq";
+    readonly anchor: string | null;
+    readonly layout: HeadingListLayout;
+    readonly heading: CopyInput;
+    readonly tail: CopyInput | null;
+    readonly intro: CopyInput | null;
+    readonly items: readonly {
+        readonly question: CopyInput;
+        readonly answer: CopyInput;
+    }[];
+};
+export type GallerySectionInput = {
+    readonly kind: "gallery";
+    readonly anchor: string | null;
+    readonly layout: StaggerRowLayout;
+    readonly heading: CopyInput | null;
+    readonly images: readonly SectionImageInput[];
+};
+export type ContactSectionInput = {
+    readonly kind: "contact";
+    readonly anchor: string | null;
+    readonly layout: SplitLayout;
+    readonly heading: CopyInput;
+    readonly body: CopyInput | null;
+    /** Show the site settings' email address. */
+    readonly showEmail: boolean;
+    /** Show the site settings' phone number. */
+    readonly showPhone: boolean;
+    readonly action: ActionInput | null;
+    readonly image: SectionImageInput | null;
+};
+export type NewSectionInput = TextMediaSectionInput | FaqSectionInput | GallerySectionInput | ContactSectionInput;
+/** One entry of `PageContent.sections`: a home section kind or one of the new kinds. */
+export type PageSectionInput = Exclude<CompositionBlockInput, {
+    readonly kind: "campaign";
+}> | NewSectionInput;

package/dist/portable/site-content.d.cts

@@ -54,6 +54,11 @@
  *   accentBandBlock                     kind `accent_band`
  *   locationsBlock                      kind `locations` (jumpLink → anchor)
  *
+ * A content page's `sections[]` (A-1915) reads those four kinds plus
+ * `text_media`, `faq`, `gallery` and `contact` into `PageContent.sections`,
+ * with their named warnings in `PageContent.warnings`. `sections.ts` holds the
+ * kinds, the A-1876 layout names and the warning codes.
+ *
  * Two places the composition cannot carry a proposed marker: a `cta` block's
  * plain strings, and the campaign's title and body (which travel as Markdown).
  * There the text is returned plain and the line is still listed in
@@ -61,6 +66,7 @@
  * approval. Nothing is dropped silently.
  */
 import { type CmsQuery } from "../contracts/query.cjs";
+import { type PageSectionInput, type SectionWarning } from "./sections.cjs";
 export type CopyInput = string | {
     readonly text: string;
     readonly copySource: "captured" | "proposed";
@@ -142,6 +148,13 @@ export type PageContent = {
     readonly body: string;
     readonly migrated: boolean;
     readonly proposedCopy: readonly ProposedCopy[];
+    /**
+     * A-1915. Present only when the stored page has a `sections` list, so a page
+     * written before sections existed reads exactly as it did in 0.2.0.
+     */
+    readonly sections?: readonly PageSectionInput[];
+    /** A-1915. Present with `sections`: every named section warning, with its path. */
+    readonly warnings?: readonly SectionWarning[];
 };
 export type SiteSettingsContent = {
     readonly name: string;

package/dist/portable/site-content.d.mts

@@ -54,6 +54,11 @@
  *   accentBandBlock                     kind `accent_band`
  *   locationsBlock                      kind `locations` (jumpLink → anchor)
  *
+ * A content page's `sections[]` (A-1915) reads those four kinds plus
+ * `text_media`, `faq`, `gallery` and `contact` into `PageContent.sections`,
+ * with their named warnings in `PageContent.warnings`. `sections.ts` holds the
+ * kinds, the A-1876 layout names and the warning codes.
+ *
  * Two places the composition cannot carry a proposed marker: a `cta` block's
  * plain strings, and the campaign's title and body (which travel as Markdown).
  * There the text is returned plain and the line is still listed in
@@ -61,6 +66,7 @@
  * approval. Nothing is dropped silently.
  */
 import { type CmsQuery } from "../contracts/query.mjs";
+import { type PageSectionInput, type SectionWarning } from "./sections.mjs";
 export type CopyInput = string | {
     readonly text: string;
     readonly copySource: "captured" | "proposed";
@@ -142,6 +148,13 @@ export type PageContent = {
     readonly body: string;
     readonly migrated: boolean;
     readonly proposedCopy: readonly ProposedCopy[];
+    /**
+     * A-1915. Present only when the stored page has a `sections` list, so a page
+     * written before sections existed reads exactly as it did in 0.2.0.
+     */
+    readonly sections?: readonly PageSectionInput[];
+    /** A-1915. Present with `sections`: every named section warning, with its path. */
+    readonly warnings?: readonly SectionWarning[];
 };
 export type SiteSettingsContent = {
     readonly name: string;

package/dist/portable/site-content.d.ts

@@ -54,6 +54,11 @@
  *   accentBandBlock                     kind `accent_band`
  *   locationsBlock                      kind `locations` (jumpLink → anchor)
  *
+ * A content page's `sections[]` (A-1915) reads those four kinds plus
+ * `text_media`, `faq`, `gallery` and `contact` into `PageContent.sections`,
+ * with their named warnings in `PageContent.warnings`. `sections.ts` holds the
+ * kinds, the A-1876 layout names and the warning codes.
+ *
  * Two places the composition cannot carry a proposed marker: a `cta` block's
  * plain strings, and the campaign's title and body (which travel as Markdown).
  * There the text is returned plain and the line is still listed in
@@ -61,6 +66,7 @@
  * approval. Nothing is dropped silently.
  */
 import { type CmsQuery } from "../contracts/query.js";
+import { type PageSectionInput, type SectionWarning } from "./sections.js";
 export type CopyInput = string | {
     readonly text: string;
     readonly copySource: "captured" | "proposed";
@@ -142,6 +148,13 @@ export type PageContent = {
     readonly body: string;
     readonly migrated: boolean;
     readonly proposedCopy: readonly ProposedCopy[];
+    /**
+     * A-1915. Present only when the stored page has a `sections` list, so a page
+     * written before sections existed reads exactly as it did in 0.2.0.
+     */
+    readonly sections?: readonly PageSectionInput[];
+    /** A-1915. Present with `sections`: every named section warning, with its path. */
+    readonly warnings?: readonly SectionWarning[];
 };
 export type SiteSettingsContent = {
     readonly name: string;

package/dist/runtime/reader.d.cts

@@ -1,4 +1,4 @@
-import { type CmsQuery } from "../contracts/query.cjs";
+import { type CmsQuery, type CmsResolution } from "../contracts/query.cjs";
 export type CmsFailure = "configuration" | "network" | "timeout" | "rate-limit" | "upstream" | "plan-limit" | "permission" | "malformed";
 export type CmsDiagnostic = {
     readonly event: "cms.fallback" | "cms.partial-fallback" | "cms.refused";
@@ -6,6 +6,7 @@ export type CmsDiagnostic = {
     readonly reason: CmsFailure | "missing" | "invalid-field";
     readonly status?: number;
     readonly fields: readonly string[];
+    readonly warnings?: CmsResolution<unknown>["warnings"];
 };
 export type CmsFetch = (url: string, init: RequestInit & {
     next?: {
@@ -34,6 +35,7 @@ export type CmsReadResult<T> = {
     readonly source: "cms" | "mixed" | "fallback";
     readonly fallbackFields: readonly string[];
     readonly reason?: CmsFailure | "missing" | "invalid-field";
+    readonly warnings?: CmsResolution<unknown>["warnings"];
 };
 export type CmsReaderOptions = {
     readonly adapter: CmsAdapter;

package/dist/runtime/reader.d.mts

@@ -1,4 +1,4 @@
-import { type CmsQuery } from "../contracts/query.mjs";
+import { type CmsQuery, type CmsResolution } from "../contracts/query.mjs";
 export type CmsFailure = "configuration" | "network" | "timeout" | "rate-limit" | "upstream" | "plan-limit" | "permission" | "malformed";
 export type CmsDiagnostic = {
     readonly event: "cms.fallback" | "cms.partial-fallback" | "cms.refused";
@@ -6,6 +6,7 @@ export type CmsDiagnostic = {
     readonly reason: CmsFailure | "missing" | "invalid-field";
     readonly status?: number;
     readonly fields: readonly string[];
+    readonly warnings?: CmsResolution<unknown>["warnings"];
 };
 export type CmsFetch = (url: string, init: RequestInit & {
     next?: {
@@ -34,6 +35,7 @@ export type CmsReadResult<T> = {
     readonly source: "cms" | "mixed" | "fallback";
     readonly fallbackFields: readonly string[];
     readonly reason?: CmsFailure | "missing" | "invalid-field";
+    readonly warnings?: CmsResolution<unknown>["warnings"];
 };
 export type CmsReaderOptions = {
     readonly adapter: CmsAdapter;

package/dist/runtime/reader.d.ts

@@ -1,4 +1,4 @@
-import { type CmsQuery } from "../contracts/query.js";
+import { type CmsQuery, type CmsResolution } from "../contracts/query.js";
 export type CmsFailure = "configuration" | "network" | "timeout" | "rate-limit" | "upstream" | "plan-limit" | "permission" | "malformed";
 export type CmsDiagnostic = {
     readonly event: "cms.fallback" | "cms.partial-fallback" | "cms.refused";
@@ -6,6 +6,7 @@ export type CmsDiagnostic = {
     readonly reason: CmsFailure | "missing" | "invalid-field";
     readonly status?: number;
     readonly fields: readonly string[];
+    readonly warnings?: CmsResolution<unknown>["warnings"];
 };
 export type CmsFetch = (url: string, init: RequestInit & {
     next?: {
@@ -34,6 +35,7 @@ export type CmsReadResult<T> = {
     readonly source: "cms" | "mixed" | "fallback";
     readonly fallbackFields: readonly string[];
     readonly reason?: CmsFailure | "missing" | "invalid-field";
+    readonly warnings?: CmsResolution<unknown>["warnings"];
 };
 export type CmsReaderOptions = {
     readonly adapter: CmsAdapter;

package/dist/sanity.cjs

@@ -1,2 +1,2 @@
-"use strict";var w=Object.defineProperty;var E=Object.getOwnPropertyDescriptor;var z=Object.getOwnPropertyNames;var $=Object.prototype.hasOwnProperty;var R=(e,t)=>{for(var n in t)w(e,n,{get:t[n],enumerable:!0})},x=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of z(t))!$.call(e,s)&&s!==n&&w(e,s,{get:()=>t[s],enumerable:!(r=E(t,s))||r.enumerable});return e};var P=e=>x(w({},"__esModule",{value:!0}),e);var B={};R(B,{createSanityAdapter:()=>v,sanityBindingFromEnv:()=>I});module.exports=P(B);var Y=require("server-only");var M=/^[A-Za-z][A-Za-z0-9_]{0,63}$/,D=/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/,N=/^[a-z0-9]{6,12}\.[a-z][a-z0-9_-]{0,63}$/;function T(e){if(!e||!Array.isArray(e.types)||e.types.length===0)throw new TypeError("CMS dependencies require document types");let t=[...e.types];for(let r of t)if(typeof r!="string"||!M.test(r))throw new TypeError("Invalid CMS document type");if(e.ids!==void 0&&!Array.isArray(e.ids))throw new TypeError("Invalid CMS document IDs");let n=e.ids===void 0?void 0:[...e.ids];for(let r of n??[])if(typeof r!="string"||!D.test(r)||/^(drafts|versions)\./.test(r))throw new TypeError("Invalid CMS document ID");if(new Set(t).size+new Set(n).size>128)throw new TypeError("Too many CMS tags");return Object.freeze({types:Object.freeze(t),...n===void 0?{}:{ids:Object.freeze(n)}})}function b(e){if(!e||typeof e.name!="string"||!/^[A-Za-z][A-Za-z0-9_.-]{0,127}$/.test(e.name)||typeof e.query!="string"||e.query.trim()===""||typeof e.resolve!="function")throw new TypeError("Invalid CMS query configuration");let t=e.params;if(!t||typeof t!="object"||Object.getPrototypeOf(t)!==Object.prototype&&Object.getPrototypeOf(t)!==null)throw new TypeError("CMS params must be plain JSON scalars");let n={};for(let r of Reflect.ownKeys(t)){let s=Object.getOwnPropertyDescriptor(t,r);if(typeof r!="string"||!s||!Object.hasOwn(s,"value")||!s.enumerable)throw new TypeError("CMS params must be plain JSON scalars");let i=s.value;if(!(i===null||typeof i=="string"||typeof i=="boolean"||typeof i=="number"&&Number.isFinite(i)))throw new TypeError("CMS params must be plain JSON scalars");Object.defineProperty(n,r,{value:i,enumerable:!0})}return Object.freeze({name:e.name,query:e.query,params:Object.freeze(n),dependencies:T(e.dependencies),resolve:e.resolve})}function C(e,t){if(typeof e!="string"||e.length>77||!N.test(e))throw new TypeError("Invalid CMS scope");let n=T(t),r=[...[...new Set(n.types)].sort().map(s=>`cms:${e}:type:${s}`),...[...new Set(n.ids??[])].sort().map(s=>`cms:${e}:id:${s}`)];return Object.freeze(r)}var _=2*1024*1024;function A(e){if(!e||typeof e.projectId!="string"||!/^[a-z0-9]{6,12}$/.test(e.projectId)||typeof e.dataset!="string"||!/^[a-z][a-z0-9_-]{0,63}$/.test(e.dataset)||typeof e.apiVersion!="string"||!/^v?\d{4}-\d{2}-\d{2}$/.test(e.apiVersion))throw new TypeError("Invalid Sanity binding configuration");return Object.freeze({projectId:e.projectId,dataset:e.dataset,apiVersion:e.apiVersion.replace(/^v/,"")})}function v(e){let t=A(e?.binding),n=e.timeoutMs??1500,r=e.readToken;if(!Number.isSafeInteger(n)||n<=0||n>2147483647||e.fetchImpl!==void 0&&typeof e.fetchImpl!="function"||r!==void 0&&(typeof r!="string"||r.trim()===""||/[\r\n]/.test(r)))throw new TypeError("Invalid Sanity adapter configuration");let s=e.fetchImpl,i=`${t.projectId}.${t.dataset}`;return Object.freeze({scope:i,async read(O,c){let l;try{if(!c||!Number.isSafeInteger(c.revalidateSeconds)||c.revalidateSeconds<3600||!Array.isArray(c.tags))throw new TypeError;let o=[],p=[];for(let d of c.tags){if(typeof d!="string")throw new TypeError;if(d.startsWith(`cms:${i}:type:`))o.push(d.slice(`cms:${i}:type:`.length));else if(d.startsWith(`cms:${i}:id:`))p.push(d.slice(`cms:${i}:id:`.length));else throw new TypeError}let y=C(i,{types:o,ids:p});if(y.length!==c.tags.length||y.some((d,a)=>d!==c.tags[a]))throw new TypeError;l=b({...O,dependencies:{types:o,ids:p},resolve:d=>({data:d,fallbackFields:[]})})}catch{throw new TypeError("Invalid Sanity read configuration")}let f=new URL(`https://${t.projectId}.api.sanity.io/v${t.apiVersion}/data/query/${t.dataset}`);f.searchParams.set("query",l.query),f.searchParams.set("perspective","published");for(let o of Object.keys(l.params).sort())f.searchParams.set(`$${o}`,JSON.stringify(l.params[o]));let h=new AbortController,m,u=!1,g=()=>{h.abort(),m&&m.cancel().catch(()=>{})},S,k=new Promise(o=>{S=setTimeout(()=>{u=!0,g(),o({ok:!1,reason:"timeout"})},n)}),j=async()=>{try{let o=await(s??globalThis.fetch)(f.href,{method:"GET",redirect:"error",signal:h.signal,headers:r===void 0?{}:{Authorization:`Bearer ${r}`},next:{revalidate:c.revalidateSeconds,tags:[...c.tags]}});if(u)return o.body?.cancel().catch(()=>{}),{ok:!1,reason:"timeout"};if(!o.ok){o.body?.cancel().catch(()=>{});let a=o.status;return{ok:!1,reason:a===402?"plan-limit":a===401||a===403?"permission":a===429?"rate-limit":"upstream",status:a}}if(!o.body)return{ok:!1,reason:"malformed"};m=o.body.getReader();let p=0,y="",d=new TextDecoder("utf-8",{fatal:!0});for(;;){let a=await m.read();if(u)return{ok:!1,reason:"timeout"};if(a.done)break;if(p+=a.value.byteLength,p>_)return g(),{ok:!1,reason:"malformed"};try{y+=d.decode(a.value,{stream:!0})}catch{return g(),{ok:!1,reason:"malformed"}}}try{y+=d.decode();let a=JSON.parse(y);return!a||typeof a!="object"||Array.isArray(a)||!Object.hasOwn(a,"result")?{ok:!1,reason:"malformed"}:{ok:!0,value:a.result}}catch{return{ok:!1,reason:"malformed"}}}catch{return{ok:!1,reason:u?"timeout":"network"}}};try{return await Promise.race([j(),k])}finally{clearTimeout(S)}}})}function I(e){return A({projectId:e.SANITY_PROJECT_ID,dataset:e.SANITY_DATASET,apiVersion:e.SANITY_API_VERSION})}0&&(module.exports={createSanityAdapter,sanityBindingFromEnv});
+"use strict";var w=Object.defineProperty;var E=Object.getOwnPropertyDescriptor;var z=Object.getOwnPropertyNames;var $=Object.prototype.hasOwnProperty;var R=(e,t)=>{for(var n in t)w(e,n,{get:t[n],enumerable:!0})},x=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of z(t))!$.call(e,s)&&s!==n&&w(e,s,{get:()=>t[s],enumerable:!(r=E(t,s))||r.enumerable});return e};var P=e=>x(w({},"__esModule",{value:!0}),e);var B={};R(B,{createSanityAdapter:()=>v,sanityBindingFromEnv:()=>I});module.exports=P(B);var Y=require("server-only");var M=/^[A-Za-z][A-Za-z0-9_]{0,63}$/,D=/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/,N=/^[a-z0-9]{6,12}\.[a-z][a-z0-9_-]{0,63}$/;function T(e){if(!e||!Array.isArray(e.types)||e.types.length===0)throw new TypeError("CMS dependencies require document types");let t=[...e.types];for(let r of t)if(typeof r!="string"||!M.test(r))throw new TypeError("Invalid CMS document type");if(e.ids!==void 0&&!Array.isArray(e.ids))throw new TypeError("Invalid CMS document IDs");let n=e.ids===void 0?void 0:[...e.ids];for(let r of n??[])if(typeof r!="string"||!D.test(r)||/^(drafts|versions)\./.test(r))throw new TypeError("Invalid CMS document ID");if(new Set(t).size+new Set(n).size>128)throw new TypeError("Too many CMS tags");return Object.freeze({types:Object.freeze(t),...n===void 0?{}:{ids:Object.freeze(n)}})}function b(e){if(!e||typeof e.name!="string"||!/^[A-Za-z][A-Za-z0-9_.-]{0,127}$/.test(e.name)||typeof e.query!="string"||e.query.trim()===""||typeof e.resolve!="function")throw new TypeError("Invalid CMS query configuration");let t=e.params;if(!t||typeof t!="object"||Object.getPrototypeOf(t)!==Object.prototype&&Object.getPrototypeOf(t)!==null)throw new TypeError("CMS params must be plain JSON scalars");let n={};for(let r of Reflect.ownKeys(t)){let s=Object.getOwnPropertyDescriptor(t,r);if(typeof r!="string"||!s||!Object.hasOwn(s,"value")||!s.enumerable)throw new TypeError("CMS params must be plain JSON scalars");let i=s.value;if(!(i===null||typeof i=="string"||typeof i=="boolean"||typeof i=="number"&&Number.isFinite(i)))throw new TypeError("CMS params must be plain JSON scalars");Object.defineProperty(n,r,{value:i,enumerable:!0})}return Object.freeze({name:e.name,query:e.query,params:Object.freeze(n),dependencies:T(e.dependencies),resolve:e.resolve})}function C(e,t){if(typeof e!="string"||e.length>77||!N.test(e))throw new TypeError("Invalid CMS scope");let n=T(t),r=[...[...new Set(n.types)].sort().map(s=>`cms:${e}:type:${s}`),...[...new Set(n.ids??[])].sort().map(s=>`cms:${e}:id:${s}`)];return Object.freeze(r)}var _=2*1024*1024;function A(e){if(!e||typeof e.projectId!="string"||!/^[a-z0-9]{6,12}$/.test(e.projectId)||typeof e.dataset!="string"||!/^[a-z][a-z0-9_-]{0,63}$/.test(e.dataset)||typeof e.apiVersion!="string"||!/^v?\d{4}-\d{2}-\d{2}$/.test(e.apiVersion))throw new TypeError("Invalid Sanity binding configuration");return Object.freeze({projectId:e.projectId,dataset:e.dataset,apiVersion:e.apiVersion.replace(/^v/,"")})}function v(e){let t=A(e?.binding),n=e.timeoutMs??1500,r=e.readToken;if(!Number.isSafeInteger(n)||n<=0||n>2147483647||e.fetchImpl!==void 0&&typeof e.fetchImpl!="function"||r!==void 0&&(typeof r!="string"||r.trim()===""||/[\r\n]/.test(r)))throw new TypeError("Invalid Sanity adapter configuration");let s=e.fetchImpl,i=`${t.projectId}.${t.dataset}`;return Object.freeze({scope:i,async read(O,c){let y;try{if(!c||!Number.isSafeInteger(c.revalidateSeconds)||c.revalidateSeconds<3600||!Array.isArray(c.tags))throw new TypeError;let o=[],p=[];for(let d of c.tags){if(typeof d!="string")throw new TypeError;if(d.startsWith(`cms:${i}:type:`))o.push(d.slice(`cms:${i}:type:`.length));else if(d.startsWith(`cms:${i}:id:`))p.push(d.slice(`cms:${i}:id:`.length));else throw new TypeError}let l=C(i,{types:o,ids:p});if(l.length!==c.tags.length||l.some((d,a)=>d!==c.tags[a]))throw new TypeError;y=b({...O,dependencies:{types:o,ids:p},resolve:d=>({data:d,fallbackFields:[]})})}catch{throw new TypeError("Invalid Sanity read configuration")}let f=new URL(`https://${t.projectId}.api.sanity.io/v${t.apiVersion}/data/query/${t.dataset}`);f.searchParams.set("query",y.query),f.searchParams.set("perspective","published");for(let o of Object.keys(y.params).sort())f.searchParams.set(`$${o}`,JSON.stringify(y.params[o]));let h=new AbortController,m,u=!1,g=()=>{h.abort(),m&&m.cancel().catch(()=>{})},S,k=new Promise(o=>{S=setTimeout(()=>{u=!0,g(),o({ok:!1,reason:"timeout"})},n)}),j=async()=>{try{let o=await(s??globalThis.fetch)(f.href,{method:"GET",redirect:"error",signal:h.signal,headers:r===void 0?{}:{Authorization:`Bearer ${r}`},next:{revalidate:c.revalidateSeconds,tags:[...c.tags]}});if(u)return o.body?.cancel().catch(()=>{}),{ok:!1,reason:"timeout"};if(!o.ok){o.body?.cancel().catch(()=>{});let a=o.status;return{ok:!1,reason:a===402?"plan-limit":a===401||a===403?"permission":a===429?"rate-limit":"upstream",status:a}}if(!o.body)return{ok:!1,reason:"malformed"};m=o.body.getReader();let p=0,l="",d=new TextDecoder("utf-8",{fatal:!0});for(;;){let a=await m.read();if(u)return{ok:!1,reason:"timeout"};if(a.done)break;if(p+=a.value.byteLength,p>_)return g(),{ok:!1,reason:"malformed"};try{l+=d.decode(a.value,{stream:!0})}catch{return g(),{ok:!1,reason:"malformed"}}}try{l+=d.decode();let a=JSON.parse(l);return!a||typeof a!="object"||Array.isArray(a)||!Object.hasOwn(a,"result")?{ok:!1,reason:"malformed"}:{ok:!0,value:a.result}}catch{return{ok:!1,reason:"malformed"}}}catch{return{ok:!1,reason:u?"timeout":"network"}}};try{return await Promise.race([j(),k])}finally{clearTimeout(S)}}})}function I(e){return A({projectId:e.SANITY_PROJECT_ID,dataset:e.SANITY_DATASET,apiVersion:e.SANITY_API_VERSION})}0&&(module.exports={createSanityAdapter,sanityBindingFromEnv});
 //# sourceMappingURL=sanity.cjs.map