@i18n-micro/types 1.2.4 → 1.2.6

package/README.md

@@ -111,6 +111,21 @@ Represents global route configurations for different locales.
 
 Represents a key-value pair of translations.
 
+#### Page-level SEO head (`useI18nHead`)
+
+Types for per-page i18n SEO overrides: `I18nHeadInput`, `I18nHeadLink`, `I18nHeadMeta`, and `I18nHeadDisableGroup`. Use them in page helpers or when calling `useI18nHead` from `@i18n-micro/types` for typed `meta`, `link`, `replace`, and `disable` options.
+
+```typescript
+import type { I18nHeadInput } from '@i18n-micro/types'
+
+export function buildArticleHead(article: Article): I18nHeadInput {
+  return {
+    meta: [{ property: 'og:title', content: article.title }],
+    replace: { canonical: article.canonicalUrl, ogUrl: article.canonicalUrl },
+  }
+}
+```
+
 #### `Translation`
 
 Represents a translation value, which can be a string, number, boolean, nested translations, or `null`.

package/dist/index.d.cts

@@ -60,7 +60,8 @@ export interface Locale {
     iso?: string;
     /**
      * Open Graph locale for `og:locale` / `og:locale:alternate` meta `content` (e.g. `ar_AE`).
-     * If omitted or empty, `iso` is used (then `code`).
+     * When omitted, `iso` is converted to OG format when possible (`en-US` → `en_US`).
+     * If conversion is not possible, `og:locale` tags are not emitted (dev warning when `missingWarn` is enabled).
      */
     og?: string;
     /**
@@ -532,5 +533,39 @@ export type Translation = CleanTranslation | unknown;
 export interface Translations {
     [key: string]: Translation;
 }
+/** Link entry for page-level i18n head overrides (`useI18nHead`). */
+export interface I18nHeadLink {
+    rel: string;
+    href: string;
+    hreflang?: string;
+    [key: string]: string | undefined;
+}
+/** Meta entry for page-level i18n head overrides (`useI18nHead`). */
+export interface I18nHeadMeta {
+    [key: string]: string | undefined;
+}
+/** Groups of built-in i18n SEO tags that can be disabled per page. */
+export type I18nHeadDisableGroup = 'hreflang' | 'x-default' | 'canonical' | 'og' | 'og-alternates' | 'html';
+/** Page-level overrides merged on top of `useLocaleHead` output. */
+export interface I18nHeadInput {
+    /** Extra or overriding `<html>` attributes. */
+    htmlAttrs?: Record<string, string>;
+    /** Meta tags appended after base i18n tags (deduped by `id` / `property` / `name`). */
+    meta?: I18nHeadMeta[];
+    /** Link tags appended after base i18n tags (deduped by `id` / `rel` + `hreflang`). */
+    link?: I18nHeadLink[];
+    /** Replace or remove specific built-in i18n SEO tags. */
+    replace?: {
+        canonical?: string | false;
+        hreflang?: I18nHeadLink[] | false;
+        xDefault?: I18nHeadLink | false;
+        ogLocale?: string | false;
+        ogUrl?: string | false;
+        /** Locale codes for `og:locale:alternate` (resolved via `locale.og` / `iso`). */
+        ogAlternates?: string[] | false;
+    };
+    /** Disable built-in i18n SEO tag groups for this page. */
+    disable?: I18nHeadDisableGroup[];
+}
 declare const init: () => void;
 export { init };

package/dist/index.d.ts

@@ -60,7 +60,8 @@ export interface Locale {
     iso?: string;
     /**
      * Open Graph locale for `og:locale` / `og:locale:alternate` meta `content` (e.g. `ar_AE`).
-     * If omitted or empty, `iso` is used (then `code`).
+     * When omitted, `iso` is converted to OG format when possible (`en-US` → `en_US`).
+     * If conversion is not possible, `og:locale` tags are not emitted (dev warning when `missingWarn` is enabled).
      */
     og?: string;
     /**
@@ -532,5 +533,39 @@ export type Translation = CleanTranslation | unknown;
 export interface Translations {
     [key: string]: Translation;
 }
+/** Link entry for page-level i18n head overrides (`useI18nHead`). */
+export interface I18nHeadLink {
+    rel: string;
+    href: string;
+    hreflang?: string;
+    [key: string]: string | undefined;
+}
+/** Meta entry for page-level i18n head overrides (`useI18nHead`). */
+export interface I18nHeadMeta {
+    [key: string]: string | undefined;
+}
+/** Groups of built-in i18n SEO tags that can be disabled per page. */
+export type I18nHeadDisableGroup = 'hreflang' | 'x-default' | 'canonical' | 'og' | 'og-alternates' | 'html';
+/** Page-level overrides merged on top of `useLocaleHead` output. */
+export interface I18nHeadInput {
+    /** Extra or overriding `<html>` attributes. */
+    htmlAttrs?: Record<string, string>;
+    /** Meta tags appended after base i18n tags (deduped by `id` / `property` / `name`). */
+    meta?: I18nHeadMeta[];
+    /** Link tags appended after base i18n tags (deduped by `id` / `rel` + `hreflang`). */
+    link?: I18nHeadLink[];
+    /** Replace or remove specific built-in i18n SEO tags. */
+    replace?: {
+        canonical?: string | false;
+        hreflang?: I18nHeadLink[] | false;
+        xDefault?: I18nHeadLink | false;
+        ogLocale?: string | false;
+        ogUrl?: string | false;
+        /** Locale codes for `og:locale:alternate` (resolved via `locale.og` / `iso`). */
+        ogAlternates?: string[] | false;
+    };
+    /** Disable built-in i18n SEO tag groups for this page. */
+    disable?: I18nHeadDisableGroup[];
+}
 declare const init: () => void;
 export { init };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i18n-micro/types",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "description": "TypeScript definitions for the Nuxt I18n Micro ecosystem.",
   "keywords": [
     "i18n",