@weaverse/hydrogen 5.13.1 → 5.14.0

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { SelectedOptionInput } from '@shopify/hydrogen/storefront-api-types';
 import { Weaverse, WeaverseItemStore, ElementData, WeaverseElement, WeaverseProjectDataType, WeaverseCoreParams, WeaverseResourcePickerData } from '@weaverse/react';
 export { PositionInputValue, WeaverseImage, WeaverseVideo, isBrowser, isIframe, useChildInstances, useItemInstance, useParentInstance, useWeaverse } from '@weaverse/react';
-import { PageType, InspectorGroup, SchemaType, ComponentPresets, SchemaValidationResult } from '@weaverse/schema';
+import { PageType, InspectorGroup, SchemaType, PageSEOData, ComponentPresets, SchemaValidationResult } from '@weaverse/schema';
 export * from '@weaverse/schema';
 export { BasicInput, HeadingInput, InputType, InspectorGroup, PageType, SchemaValidationIssue, SchemaValidationResult } from '@weaverse/schema';
 import { createWithCache, CachingStrategy, I18nBase, HydrogenContext, HydrogenEnv } from '@shopify/hydrogen';
@@ -9,7 +9,7 @@ export { CachingStrategy } from '@shopify/hydrogen';
 import { LoaderFunctionArgs, AppLoadContext } from '@shopify/remix-oxygen';
 import * as React$1 from 'react';
 import { ReactNode, ComponentType, JSX, ForwardRefExoticComponent } from 'react';
-import { NavigateFunction, UIMatch } from 'react-router';
+import { NavigateFunction, UIMatch, MetaDescriptor } from 'react-router';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
@@ -622,6 +622,13 @@ interface HydrogenPageData extends WeaverseProjectDataType {
     id: string;
     items: HydrogenComponentData[];
     name: string;
+    /**
+     * Page-level SEO metadata published by Weaverse Builder. `null` when
+     * the page has no `PageSeo` row; absent on revision snapshots that
+     * predate the SEO feature. Themes should treat both as "no Weaverse
+     * override".
+     */
+    seo?: PageSEOData | null;
     [key: string]: any;
 }
 type WeaverseI18n = I18nBase & {
@@ -1073,6 +1080,41 @@ declare function useWeaverseDataContext(): WeaverseDataContext;
  */
 declare function createWeaverseDataContext(matches: UIMatch<unknown, unknown>[]): WeaverseDataContext;
 
+/**
+ * Convert a Weaverse page-level SEO payload into React Router
+ * `MetaDescriptor[]`. Pure, synchronous, tree-shakeable — does not fetch.
+ *
+ * Behavior:
+ * - `title` → top-level `{ title }` descriptor.
+ * - `description` / `keywords` → `<meta name="...">`.
+ * - `canonicalUrl` → `<link rel="canonical">`.
+ * - `openGraph.*` → `<meta property="og:*">`. `og:type` defaults to
+ *   `'website'` when any other OG field is present.
+ * - `twitter.*` → `<meta name="twitter:*">`. `twitter:card` defaults to
+ *   `'summary'` when any other Twitter field is present.
+ * - `robots` is always emitted (defaults to `'index,follow'`) so themes
+ *   stacking multiple SEO sources have a deterministic last word on
+ *   indexing for Weaverse-managed pages.
+ * - Empty strings / missing fields are filtered before return so empty
+ *   descriptors don't override earlier sources (e.g. Hydrogen
+ *   `getSeoMeta`).
+ */
+declare function formatMetaDescriptors(seo: PageSEOData | null | undefined): MetaDescriptor[];
+/**
+ * Convenience accessor: pull `page.seo` out of a `WeaverseLoaderData`
+ * (or `HydrogenPageData`) and emit `MetaDescriptor[]`. Null-safe.
+ *
+ * @example
+ * ```ts
+ * export const meta: MetaFunction<typeof loader> = ({ data }) => {
+ *   return getWeaverseSeoMeta(data?.weaverseData)
+ * }
+ * ```
+ */
+declare function getWeaverseSeoMeta(data: WeaverseLoaderData | HydrogenPageData | {
+    page?: HydrogenPageData | null;
+} | null | undefined): MetaDescriptor[];
+
 /**
  * Extract and parse query parameters from a request URL.
  * Supports optional allowlist for security-sensitive applications.
@@ -1155,4 +1197,4 @@ declare const IMAGES_PLACEHOLDERS: {
     product_18: string;
 };
 
-export { type CacheResponseValidator, type ComponentDataValue, type ComponentLoaderArgs, type CreateHydrogenSchemaOptions, type CustomPageEntry, type DirectFetchResponse, type FetchProjectPayload, type FetchProjectRequestBody, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenSchemaValidationResult, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type LoadPageParams, type ProjectIdValidationResult, type ProjectIdValue, type PublicEnv, type RouteLoaderArgs, type ThemeSettingsResponse, ThemeTextProvider, type ThemeTextProviderProps, ThemeTextStore, type ThemeTextValue, type TranslateFunction, type TranslationChanges, type TranslationEntry, type TranslationItemEntry, type TranslationMap, type TranslationMapEntry, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, type WeaverseDataContext, WeaverseError, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, type WithCacheFetchResponse, type WithWeaverseOptions, createWeaverseDataContext, defaultComponents, generateDataFromSchema, getNestedKey, getPreviewData, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, hasError, hasWeaverseStudio, interpolate, isFetchProjectPayload, isProjectIdFunction, isThemeSettingsResponse, isValidHydrogenSchema, isWithCacheFetchResponse, registerComponent, useThemeSettings, useThemeText, useWeaverseDataContext, withWeaverse };
+export { type CacheResponseValidator, type ComponentDataValue, type ComponentLoaderArgs, type CreateHydrogenSchemaOptions, type CustomPageEntry, type DirectFetchResponse, type FetchProjectPayload, type FetchProjectRequestBody, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenSchemaValidationResult, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type LoadPageParams, type ProjectIdValidationResult, type ProjectIdValue, type PublicEnv, type RouteLoaderArgs, type ThemeSettingsResponse, ThemeTextProvider, type ThemeTextProviderProps, ThemeTextStore, type ThemeTextValue, type TranslateFunction, type TranslationChanges, type TranslationEntry, type TranslationItemEntry, type TranslationMap, type TranslationMapEntry, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, type WeaverseDataContext, WeaverseError, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, type WithCacheFetchResponse, type WithWeaverseOptions, createWeaverseDataContext, defaultComponents, formatMetaDescriptors, generateDataFromSchema, getNestedKey, getPreviewData, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, getWeaverseSeoMeta, hasError, hasWeaverseStudio, interpolate, isFetchProjectPayload, isProjectIdFunction, isThemeSettingsResponse, isValidHydrogenSchema, isWithCacheFetchResponse, registerComponent, useThemeSettings, useThemeText, useWeaverseDataContext, withWeaverse };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { SelectedOptionInput } from '@shopify/hydrogen/storefront-api-types';
 import { Weaverse, WeaverseItemStore, ElementData, WeaverseElement, WeaverseProjectDataType, WeaverseCoreParams, WeaverseResourcePickerData } from '@weaverse/react';
 export { PositionInputValue, WeaverseImage, WeaverseVideo, isBrowser, isIframe, useChildInstances, useItemInstance, useParentInstance, useWeaverse } from '@weaverse/react';
-import { PageType, InspectorGroup, SchemaType, ComponentPresets, SchemaValidationResult } from '@weaverse/schema';
+import { PageType, InspectorGroup, SchemaType, PageSEOData, ComponentPresets, SchemaValidationResult } from '@weaverse/schema';
 export * from '@weaverse/schema';
 export { BasicInput, HeadingInput, InputType, InspectorGroup, PageType, SchemaValidationIssue, SchemaValidationResult } from '@weaverse/schema';
 import { createWithCache, CachingStrategy, I18nBase, HydrogenContext, HydrogenEnv } from '@shopify/hydrogen';
@@ -9,7 +9,7 @@ export { CachingStrategy } from '@shopify/hydrogen';
 import { LoaderFunctionArgs, AppLoadContext } from '@shopify/remix-oxygen';
 import * as React$1 from 'react';
 import { ReactNode, ComponentType, JSX, ForwardRefExoticComponent } from 'react';
-import { NavigateFunction, UIMatch } from 'react-router';
+import { NavigateFunction, UIMatch, MetaDescriptor } from 'react-router';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
@@ -622,6 +622,13 @@ interface HydrogenPageData extends WeaverseProjectDataType {
     id: string;
     items: HydrogenComponentData[];
     name: string;
+    /**
+     * Page-level SEO metadata published by Weaverse Builder. `null` when
+     * the page has no `PageSeo` row; absent on revision snapshots that
+     * predate the SEO feature. Themes should treat both as "no Weaverse
+     * override".
+     */
+    seo?: PageSEOData | null;
     [key: string]: any;
 }
 type WeaverseI18n = I18nBase & {
@@ -1073,6 +1080,41 @@ declare function useWeaverseDataContext(): WeaverseDataContext;
  */
 declare function createWeaverseDataContext(matches: UIMatch<unknown, unknown>[]): WeaverseDataContext;
 
+/**
+ * Convert a Weaverse page-level SEO payload into React Router
+ * `MetaDescriptor[]`. Pure, synchronous, tree-shakeable — does not fetch.
+ *
+ * Behavior:
+ * - `title` → top-level `{ title }` descriptor.
+ * - `description` / `keywords` → `<meta name="...">`.
+ * - `canonicalUrl` → `<link rel="canonical">`.
+ * - `openGraph.*` → `<meta property="og:*">`. `og:type` defaults to
+ *   `'website'` when any other OG field is present.
+ * - `twitter.*` → `<meta name="twitter:*">`. `twitter:card` defaults to
+ *   `'summary'` when any other Twitter field is present.
+ * - `robots` is always emitted (defaults to `'index,follow'`) so themes
+ *   stacking multiple SEO sources have a deterministic last word on
+ *   indexing for Weaverse-managed pages.
+ * - Empty strings / missing fields are filtered before return so empty
+ *   descriptors don't override earlier sources (e.g. Hydrogen
+ *   `getSeoMeta`).
+ */
+declare function formatMetaDescriptors(seo: PageSEOData | null | undefined): MetaDescriptor[];
+/**
+ * Convenience accessor: pull `page.seo` out of a `WeaverseLoaderData`
+ * (or `HydrogenPageData`) and emit `MetaDescriptor[]`. Null-safe.
+ *
+ * @example
+ * ```ts
+ * export const meta: MetaFunction<typeof loader> = ({ data }) => {
+ *   return getWeaverseSeoMeta(data?.weaverseData)
+ * }
+ * ```
+ */
+declare function getWeaverseSeoMeta(data: WeaverseLoaderData | HydrogenPageData | {
+    page?: HydrogenPageData | null;
+} | null | undefined): MetaDescriptor[];
+
 /**
  * Extract and parse query parameters from a request URL.
  * Supports optional allowlist for security-sensitive applications.
@@ -1155,4 +1197,4 @@ declare const IMAGES_PLACEHOLDERS: {
     product_18: string;
 };
 
-export { type CacheResponseValidator, type ComponentDataValue, type ComponentLoaderArgs, type CreateHydrogenSchemaOptions, type CustomPageEntry, type DirectFetchResponse, type FetchProjectPayload, type FetchProjectRequestBody, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenSchemaValidationResult, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type LoadPageParams, type ProjectIdValidationResult, type ProjectIdValue, type PublicEnv, type RouteLoaderArgs, type ThemeSettingsResponse, ThemeTextProvider, type ThemeTextProviderProps, ThemeTextStore, type ThemeTextValue, type TranslateFunction, type TranslationChanges, type TranslationEntry, type TranslationItemEntry, type TranslationMap, type TranslationMapEntry, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, type WeaverseDataContext, WeaverseError, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, type WithCacheFetchResponse, type WithWeaverseOptions, createWeaverseDataContext, defaultComponents, generateDataFromSchema, getNestedKey, getPreviewData, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, hasError, hasWeaverseStudio, interpolate, isFetchProjectPayload, isProjectIdFunction, isThemeSettingsResponse, isValidHydrogenSchema, isWithCacheFetchResponse, registerComponent, useThemeSettings, useThemeText, useWeaverseDataContext, withWeaverse };
+export { type CacheResponseValidator, type ComponentDataValue, type ComponentLoaderArgs, type CreateHydrogenSchemaOptions, type CustomPageEntry, type DirectFetchResponse, type FetchProjectPayload, type FetchProjectRequestBody, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenSchemaValidationResult, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type LoadPageParams, type ProjectIdValidationResult, type ProjectIdValue, type PublicEnv, type RouteLoaderArgs, type ThemeSettingsResponse, ThemeTextProvider, type ThemeTextProviderProps, ThemeTextStore, type ThemeTextValue, type TranslateFunction, type TranslationChanges, type TranslationEntry, type TranslationItemEntry, type TranslationMap, type TranslationMapEntry, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, type WeaverseDataContext, WeaverseError, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, type WithCacheFetchResponse, type WithWeaverseOptions, createWeaverseDataContext, defaultComponents, formatMetaDescriptors, generateDataFromSchema, getNestedKey, getPreviewData, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, getWeaverseSeoMeta, hasError, hasWeaverseStudio, interpolate, isFetchProjectPayload, isProjectIdFunction, isThemeSettingsResponse, isValidHydrogenSchema, isWithCacheFetchResponse, registerComponent, useThemeSettings, useThemeText, useWeaverseDataContext, withWeaverse };

package/dist/index.js

@@ -143,6 +143,73 @@ function useWeaverseDataContext() {
 function createWeaverseDataContext(matches) {
   return createFlatDataContext(matches);
 }
+
+// src/seo.ts
+function formatMetaDescriptors(seo) {
+  if (!seo) {
+    return [{ name: "robots", content: "index,follow" }];
+  }
+  let descriptors = [];
+  if (seo.title) {
+    descriptors.push({ title: seo.title });
+  }
+  if (seo.description) {
+    descriptors.push({ name: "description", content: seo.description });
+  }
+  if (seo.keywords) {
+    descriptors.push({ name: "keywords", content: seo.keywords });
+  }
+  if (seo.canonicalUrl) {
+    descriptors.push({
+      tagName: "link",
+      rel: "canonical",
+      href: seo.canonicalUrl
+    });
+  }
+  let og = seo.openGraph;
+  if (og && (og.title || og.description || og.image || og.type)) {
+    if (og.title) {
+      descriptors.push({ property: "og:title", content: og.title });
+    }
+    if (og.description) {
+      descriptors.push({ property: "og:description", content: og.description });
+    }
+    if (og.image) {
+      descriptors.push({ property: "og:image", content: og.image });
+    }
+    descriptors.push({ property: "og:type", content: og.type || "website" });
+  }
+  let tw = seo.twitter;
+  if (tw && (tw.title || tw.description || tw.image || tw.cardType)) {
+    descriptors.push({
+      name: "twitter:card",
+      content: tw.cardType || "summary"
+    });
+    if (tw.title) {
+      descriptors.push({ name: "twitter:title", content: tw.title });
+    }
+    if (tw.description) {
+      descriptors.push({ name: "twitter:description", content: tw.description });
+    }
+    if (tw.image) {
+      descriptors.push({ name: "twitter:image", content: tw.image });
+    }
+  }
+  let index = seo.robots?.index !== false;
+  let follow = seo.robots?.follow !== false;
+  descriptors.push({
+    name: "robots",
+    content: `${index ? "index" : "noindex"},${follow ? "follow" : "nofollow"}`
+  });
+  return descriptors;
+}
+function getWeaverseSeoMeta(data) {
+  if (!data) {
+    return formatMetaDescriptors(null);
+  }
+  let page = "items" in data && "id" in data ? data : data.page ?? null;
+  return formatMetaDescriptors(page?.seo ?? null);
+}
 function isProjectIdFunction(projectId) {
   return typeof projectId === "function";
 }
@@ -1735,12 +1802,14 @@ exports.WeaverseHydrogenItem = WeaverseHydrogenItem;
 exports.WeaverseHydrogenRoot = WeaverseHydrogenRoot;
 exports.createWeaverseDataContext = createWeaverseDataContext;
 exports.defaultComponents = defaultComponents;
+exports.formatMetaDescriptors = formatMetaDescriptors;
 exports.generateDataFromSchema = generateDataFromSchema;
 exports.getNestedKey = getNestedKey;
 exports.getPreviewData = getPreviewData;
 exports.getRequestQueries = getRequestQueries;
 exports.getSelectedProductOptions = getSelectedProductOptions;
 exports.getWeaverseConfigs = getWeaverseConfigs;
+exports.getWeaverseSeoMeta = getWeaverseSeoMeta;
 exports.hasError = hasError;
 exports.hasWeaverseStudio = hasWeaverseStudio;
 exports.interpolate = interpolate;