nuxtseo-shared 0.1.8 → 0.2.0

package/dist/content.d.mts

@@ -1,15 +1,14 @@
-//#region src/content.d.ts
 interface ContentSchemaOptions {
-  /**
-   * Pass the `z` instance from `@nuxt/content` to ensure `.editor()` works
-   * across Zod versions. When omitted, the module's bundled `z` is used.
-   */
-  z?: any;
+    /**
+     * Pass the `z` instance from `@nuxt/content` to ensure `.editor()` works
+     * across Zod versions. When omitted, the module's bundled `z` is used.
+     */
+    z?: any;
 }
 interface ContentEditorConfig {
-  hidden?: boolean;
-  input?: 'media' | 'icon' | 'textarea';
-  iconLibraries?: string[];
+    hidden?: boolean;
+    input?: 'media' | 'icon' | 'textarea';
+    iconLibraries?: string[];
 }
 /**
  * Apply Nuxt Content `.editor()` metadata to a zod schema field.
@@ -21,28 +20,28 @@ declare function withEditor<T>(schema: T, config: ContentEditorConfig): T;
  */
 declare function withEditorHidden<T>(schema: T): T;
 interface DefineContentSchemaConfig<TSchema = any, TDefineOptions extends ContentSchemaOptions = ContentSchemaOptions> {
-  /**
-   * The field name used in frontmatter (e.g. 'robots', 'sitemap', 'ogImage').
-   */
-  fieldName: string;
-  /**
-   * Build the zod schema for this field. Receives the zod instance
-   * (either the user's `@nuxt/content` patched version or the module's bundled one).
-   */
-  buildSchema: (z: any) => TSchema;
-  /**
-   * Module label for deprecation warnings (e.g. 'robots', 'sitemap').
-   */
-  label: string;
-  /**
-   * Documentation URL for migration guidance.
-   */
-  docsUrl?: string;
-  /**
-   * Hook called when `defineSchema()` is invoked. Use for validation or
-   * registering module-specific side effects (e.g. sitemap filter/onUrl).
-   */
-  onDefineSchema?: (options: TDefineOptions) => void;
+    /**
+     * The field name used in frontmatter (e.g. 'robots', 'sitemap', 'ogImage').
+     */
+    fieldName: string;
+    /**
+     * Build the zod schema for this field. Receives the zod instance
+     * (either the user's `@nuxt/content` patched version or the module's bundled one).
+     */
+    buildSchema: (z: any) => TSchema;
+    /**
+     * Module label for deprecation warnings (e.g. 'robots', 'sitemap').
+     */
+    label: string;
+    /**
+     * Documentation URL for migration guidance.
+     */
+    docsUrl?: string;
+    /**
+     * Hook called when `defineSchema()` is invoked. Use for validation or
+     * registering module-specific side effects (e.g. sitemap filter/onUrl).
+     */
+    onDefineSchema?: (options: TDefineOptions) => void;
 }
 /**
  * Factory for creating a module's `define*Schema()` and deprecated `as*Collection()` exports.
@@ -66,10 +65,11 @@ interface DefineContentSchemaConfig<TSchema = any, TDefineOptions extends Conten
  * export { defineSchema as defineRobotsSchema, asCollection as asRobotsCollection, schema }
  */
 declare function createContentSchemaFactory<TSchema, TDefineOptions extends ContentSchemaOptions = ContentSchemaOptions>(config: DefineContentSchemaConfig<TSchema, TDefineOptions>, defaultZ: any): {
-  defineSchema: (options?: TDefineOptions) => TSchema;
-  asCollection: <T>(collection: any) => T;
-  schema: any;
-  fieldSchema: TSchema;
+    defineSchema: (options?: TDefineOptions) => TSchema;
+    asCollection: <T>(collection: any) => T;
+    schema: any;
+    fieldSchema: TSchema;
 };
-//#endregion
-export { ContentEditorConfig, ContentSchemaOptions, DefineContentSchemaConfig, createContentSchemaFactory, withEditor, withEditorHidden };
+
+export { createContentSchemaFactory, withEditor, withEditorHidden };
+export type { ContentEditorConfig, ContentSchemaOptions, DefineContentSchemaConfig };

package/dist/content.d.ts

@@ -0,0 +1,75 @@
+interface ContentSchemaOptions {
+    /**
+     * Pass the `z` instance from `@nuxt/content` to ensure `.editor()` works
+     * across Zod versions. When omitted, the module's bundled `z` is used.
+     */
+    z?: any;
+}
+interface ContentEditorConfig {
+    hidden?: boolean;
+    input?: 'media' | 'icon' | 'textarea';
+    iconLibraries?: string[];
+}
+/**
+ * Apply Nuxt Content `.editor()` metadata to a zod schema field.
+ * No-ops gracefully when `.editor()` is not patched onto ZodType (outside Nuxt Content).
+ */
+declare function withEditor<T>(schema: T, config: ContentEditorConfig): T;
+/**
+ * Hide a zod schema field from the Nuxt Content / Studio editor.
+ */
+declare function withEditorHidden<T>(schema: T): T;
+interface DefineContentSchemaConfig<TSchema = any, TDefineOptions extends ContentSchemaOptions = ContentSchemaOptions> {
+    /**
+     * The field name used in frontmatter (e.g. 'robots', 'sitemap', 'ogImage').
+     */
+    fieldName: string;
+    /**
+     * Build the zod schema for this field. Receives the zod instance
+     * (either the user's `@nuxt/content` patched version or the module's bundled one).
+     */
+    buildSchema: (z: any) => TSchema;
+    /**
+     * Module label for deprecation warnings (e.g. 'robots', 'sitemap').
+     */
+    label: string;
+    /**
+     * Documentation URL for migration guidance.
+     */
+    docsUrl?: string;
+    /**
+     * Hook called when `defineSchema()` is invoked. Use for validation or
+     * registering module-specific side effects (e.g. sitemap filter/onUrl).
+     */
+    onDefineSchema?: (options: TDefineOptions) => void;
+}
+/**
+ * Factory for creating a module's `define*Schema()` and deprecated `as*Collection()` exports.
+ *
+ * Each module provides its own schema builder. The factory handles:
+ * - Zod instance passthrough for `@nuxt/content` version compatibility
+ * - Consistent `DefineSchemaOptions` interface
+ * - Deprecated `asXxxCollection()` wrapper with migration warning
+ *
+ * @example
+ * import { z } from 'zod'
+ * import { createContentSchemaFactory } from 'nuxtseo-shared/content'
+ *
+ * const { defineSchema, asCollection, schema } = createContentSchemaFactory({
+ *   fieldName: 'robots',
+ *   label: 'robots',
+ *   docsUrl: 'https://nuxtseo.com/robots/guides/content',
+ *   buildSchema: (z) => z.union([z.string(), z.boolean()]).optional(),
+ * }, z)
+ *
+ * export { defineSchema as defineRobotsSchema, asCollection as asRobotsCollection, schema }
+ */
+declare function createContentSchemaFactory<TSchema, TDefineOptions extends ContentSchemaOptions = ContentSchemaOptions>(config: DefineContentSchemaConfig<TSchema, TDefineOptions>, defaultZ: any): {
+    defineSchema: (options?: TDefineOptions) => TSchema;
+    asCollection: <T>(collection: any) => T;
+    schema: any;
+    fieldSchema: TSchema;
+};
+
+export { createContentSchemaFactory, withEditor, withEditorHidden };
+export type { ContentEditorConfig, ContentSchemaOptions, DefineContentSchemaConfig };

package/dist/content.mjs

@@ -1,64 +1,40 @@
-//#region src/content.ts
-/**
-* Apply Nuxt Content `.editor()` metadata to a zod schema field.
-* No-ops gracefully when `.editor()` is not patched onto ZodType (outside Nuxt Content).
-*/
 function withEditor(schema, config) {
-	if (typeof schema.editor === "function") return schema.editor(config);
-	return schema;
+  if (typeof schema.editor === "function")
+    return schema.editor(config);
+  return schema;
 }
-/**
-* Hide a zod schema field from the Nuxt Content / Studio editor.
-*/
 function withEditorHidden(schema) {
-	return withEditor(schema, { hidden: true });
+  return withEditor(schema, { hidden: true });
 }
-/**
-* Factory for creating a module's `define*Schema()` and deprecated `as*Collection()` exports.
-*
-* Each module provides its own schema builder. The factory handles:
-* - Zod instance passthrough for `@nuxt/content` version compatibility
-* - Consistent `DefineSchemaOptions` interface
-* - Deprecated `asXxxCollection()` wrapper with migration warning
-*
-* @example
-* import { z } from 'zod'
-* import { createContentSchemaFactory } from 'nuxtseo-shared/content'
-*
-* const { defineSchema, asCollection, schema } = createContentSchemaFactory({
-*   fieldName: 'robots',
-*   label: 'robots',
-*   docsUrl: 'https://nuxtseo.com/robots/guides/content',
-*   buildSchema: (z) => z.union([z.string(), z.boolean()]).optional(),
-* }, z)
-*
-* export { defineSchema as defineRobotsSchema, asCollection as asRobotsCollection, schema }
-*/
 function createContentSchemaFactory(config, defaultZ) {
-	const { fieldName, buildSchema, label, docsUrl, onDefineSchema } = config;
-	const defaultSchema = buildSchema(defaultZ);
-	const schemaObject = defaultZ.object({ [fieldName]: defaultSchema });
-	function defineSchema(options) {
-		if (options && onDefineSchema) onDefineSchema(options);
-		const _z = options?.z ?? defaultZ;
-		if (_z === defaultZ) return defaultSchema;
-		return buildSchema(_z);
-	}
-	function asCollection(collection) {
-		const migrationHint = docsUrl ? ` See ${docsUrl}` : "";
-		console.warn(`[${label}] \`as${capitalize(label)}Collection()\` is deprecated. Use \`define${capitalize(label)}Schema()\` in your collection schema instead.${migrationHint}`);
-		if (collection.type === "page") collection.schema = collection.schema ? schemaObject.extend(collection.schema.shape) : schemaObject;
-		return collection;
-	}
-	return {
-		defineSchema,
-		asCollection,
-		schema: schemaObject,
-		fieldSchema: defaultSchema
-	};
+  const { fieldName, buildSchema, label, docsUrl, onDefineSchema } = config;
+  const defaultSchema = buildSchema(defaultZ);
+  const schemaObject = defaultZ.object({ [fieldName]: defaultSchema });
+  function defineSchema(options) {
+    if (options && onDefineSchema)
+      onDefineSchema(options);
+    const _z = options?.z ?? defaultZ;
+    if (_z === defaultZ)
+      return defaultSchema;
+    return buildSchema(_z);
+  }
+  function asCollection(collection) {
+    const migrationHint = docsUrl ? ` See ${docsUrl}` : "";
+    console.warn(`[${label}] \`as${capitalize(label)}Collection()\` is deprecated. Use \`define${capitalize(label)}Schema()\` in your collection schema instead.${migrationHint}`);
+    if (collection.type === "page") {
+      collection.schema = collection.schema ? schemaObject.extend(collection.schema.shape) : schemaObject;
+    }
+    return collection;
+  }
+  return {
+    defineSchema,
+    asCollection,
+    schema: schemaObject,
+    fieldSchema: defaultSchema
+  };
 }
 function capitalize(s) {
-	return s.charAt(0).toUpperCase() + s.slice(1);
+  return s.charAt(0).toUpperCase() + s.slice(1);
 }
-//#endregion
+
 export { createContentSchemaFactory, withEditor, withEditorHidden };

package/dist/devtools.d.mts

@@ -1,14 +1,14 @@
-import { Resolver } from "@nuxt/kit";
-import { Nuxt } from "nuxt/schema";
+import { Resolver } from '@nuxt/kit';
+import { Nuxt } from 'nuxt/schema';
 
-//#region src/devtools.d.ts
 interface DevToolsUIConfig {
-  route: string;
-  name: string;
-  title: string;
-  icon: string;
-  devPort?: number;
+    route: string;
+    name: string;
+    title: string;
+    icon: string;
+    devPort?: number;
 }
 declare function setupDevToolsUI(config: DevToolsUIConfig, resolve: Resolver['resolve'], nuxt?: Nuxt): void;
-//#endregion
-export { DevToolsUIConfig, setupDevToolsUI };
+
+export { setupDevToolsUI };
+export type { DevToolsUIConfig };

package/dist/devtools.d.ts

@@ -0,0 +1,14 @@
+import { Resolver } from '@nuxt/kit';
+import { Nuxt } from 'nuxt/schema';
+
+interface DevToolsUIConfig {
+    route: string;
+    name: string;
+    title: string;
+    icon: string;
+    devPort?: number;
+}
+declare function setupDevToolsUI(config: DevToolsUIConfig, resolve: Resolver['resolve'], nuxt?: Nuxt): void;
+
+export { setupDevToolsUI };
+export type { DevToolsUIConfig };

package/dist/devtools.mjs

@@ -1,40 +1,46 @@
-import { existsSync } from "node:fs";
-import { addCustomTab } from "@nuxt/devtools-kit";
-import { useNuxt } from "@nuxt/kit";
-//#region src/devtools.ts
+import { existsSync } from 'node:fs';
+import { addCustomTab } from '@nuxt/devtools-kit';
+import { useNuxt } from '@nuxt/kit';
+import sirv from 'sirv';
+
 function setupDevToolsUI(config, resolve, nuxt = useNuxt()) {
-	const { route, name, title, icon, devPort = 3030 } = config;
-	const clientPath = resolve("./client");
-	if (existsSync(clientPath)) nuxt.hook("vite:serverCreated", async (server) => {
-		const sirv = await import("sirv").then((r) => r.default || r);
-		server.middlewares.use(route, sirv(clientPath, {
-			dev: true,
-			single: true
-		}));
-	});
-	else nuxt.hook("vite:extendConfig", (config) => {
-		Object.assign(config, { server: {
-			...config.server,
-			proxy: {
-				...config.server?.proxy,
-				[route]: {
-					target: `http://localhost:${devPort}${route}`,
-					changeOrigin: true,
-					followRedirects: true,
-					rewrite: (p) => p.replace(route, "")
-				}
-			}
-		} });
-	});
-	addCustomTab({
-		name,
-		title,
-		icon,
-		view: {
-			type: "iframe",
-			src: route
-		}
-	});
+  const { route, name, title, icon, devPort = 3030 } = config;
+  const clientPath = resolve("./client");
+  const isProductionBuild = existsSync(clientPath);
+  if (isProductionBuild) {
+    nuxt.hook("vite:serverCreated", (server) => {
+      server.middlewares.use(
+        route,
+        sirv(clientPath, { dev: true, single: true })
+      );
+    });
+  } else {
+    nuxt.hook("vite:extendConfig", (config2) => {
+      Object.assign(config2, {
+        server: {
+          ...config2.server,
+          proxy: {
+            ...config2.server?.proxy,
+            [route]: {
+              target: `http://localhost:${devPort}${route}`,
+              changeOrigin: true,
+              followRedirects: true,
+              rewrite: (p) => p.replace(route, "")
+            }
+          }
+        }
+      });
+    });
+  }
+  addCustomTab({
+    name,
+    title,
+    icon,
+    view: {
+      type: "iframe",
+      src: route
+    }
+  });
 }
-//#endregion
+
 export { setupDevToolsUI };

package/dist/i18n.d.mts

@@ -1,34 +1,33 @@
-import { LocaleObject, NuxtI18nOptions } from "@nuxtjs/i18n";
+import { LocaleObject, NuxtI18nOptions } from '@nuxtjs/i18n';
 
-//#region src/i18n.d.ts
 declare const I18N_MODULES: readonly ["@nuxtjs/i18n", "nuxt-i18n-micro"];
 type I18nModuleName = typeof I18N_MODULES[number];
 type Strategies = 'no_prefix' | 'prefix_except_default' | 'prefix' | 'prefix_and_default';
 type NormalisedLocale = LocaleObject & {
-  _sitemap: string;
-  _hreflang: string;
+    _sitemap: string;
+    _hreflang: string;
 };
 interface AutoI18nConfig {
-  locales: NormalisedLocale[];
-  defaultLocale: string;
-  strategy: Strategies;
-  differentDomains?: boolean;
-  pages?: Record<string, Record<string, string | false>>;
+    locales: NormalisedLocale[];
+    defaultLocale: string;
+    strategy: Strategies;
+    differentDomains?: boolean;
+    pages?: Record<string, Record<string, string | false>>;
 }
 interface StrategyProps {
-  localeCode: string;
-  pageLocales: string;
-  nuxtI18nConfig: NuxtI18nOptions;
-  forcedStrategy?: Strategies;
-  normalisedLocales: AutoI18nConfig['locales'];
+    localeCode: string;
+    pageLocales: string;
+    nuxtI18nConfig: NuxtI18nOptions;
+    forcedStrategy?: Strategies;
+    normalisedLocales: AutoI18nConfig['locales'];
 }
 declare function generatePathForI18nPages(ctx: StrategyProps): string;
 declare function splitPathForI18nLocales(path: string, autoI18n: AutoI18nConfig): string | string[];
 declare function normalizeLocales(nuxtI18nConfig: NuxtI18nOptions): AutoI18nConfig['locales'];
 declare function mapPathForI18nPages(path: string, autoI18n: AutoI18nConfig): string[] | false;
 interface I18nModuleResolution {
-  module: I18nModuleName;
-  isMicro: boolean;
+    module: I18nModuleName;
+    isMicro: boolean;
 }
 /**
  * Detect which i18n module is installed (@nuxtjs/i18n or nuxt-i18n-micro).
@@ -37,8 +36,9 @@ interface I18nModuleResolution {
  */
 declare function resolveI18nModule(): false | I18nModuleResolution;
 declare function resolveI18nConfig(logger?: {
-  warn: (msg: string) => void;
+    warn: (msg: string) => void;
 }): Promise<false | AutoI18nConfig>;
 declare function mergeOnKey<T extends Record<string, any>>(arr: T[], key: keyof T): T[];
-//#endregion
-export { AutoI18nConfig, I18nModuleResolution, NormalisedLocale, Strategies, StrategyProps, generatePathForI18nPages, mapPathForI18nPages, mergeOnKey, normalizeLocales, resolveI18nConfig, resolveI18nModule, splitPathForI18nLocales };
+
+export { generatePathForI18nPages, mapPathForI18nPages, mergeOnKey, normalizeLocales, resolveI18nConfig, resolveI18nModule, splitPathForI18nLocales };
+export type { AutoI18nConfig, I18nModuleResolution, NormalisedLocale, Strategies, StrategyProps };

package/dist/i18n.d.ts

@@ -0,0 +1,44 @@
+import { LocaleObject, NuxtI18nOptions } from '@nuxtjs/i18n';
+
+declare const I18N_MODULES: readonly ["@nuxtjs/i18n", "nuxt-i18n-micro"];
+type I18nModuleName = typeof I18N_MODULES[number];
+type Strategies = 'no_prefix' | 'prefix_except_default' | 'prefix' | 'prefix_and_default';
+type NormalisedLocale = LocaleObject & {
+    _sitemap: string;
+    _hreflang: string;
+};
+interface AutoI18nConfig {
+    locales: NormalisedLocale[];
+    defaultLocale: string;
+    strategy: Strategies;
+    differentDomains?: boolean;
+    pages?: Record<string, Record<string, string | false>>;
+}
+interface StrategyProps {
+    localeCode: string;
+    pageLocales: string;
+    nuxtI18nConfig: NuxtI18nOptions;
+    forcedStrategy?: Strategies;
+    normalisedLocales: AutoI18nConfig['locales'];
+}
+declare function generatePathForI18nPages(ctx: StrategyProps): string;
+declare function splitPathForI18nLocales(path: string, autoI18n: AutoI18nConfig): string | string[];
+declare function normalizeLocales(nuxtI18nConfig: NuxtI18nOptions): AutoI18nConfig['locales'];
+declare function mapPathForI18nPages(path: string, autoI18n: AutoI18nConfig): string[] | false;
+interface I18nModuleResolution {
+    module: I18nModuleName;
+    isMicro: boolean;
+}
+/**
+ * Detect which i18n module is installed (@nuxtjs/i18n or nuxt-i18n-micro).
+ *
+ * Returns `false` when neither is installed.
+ */
+declare function resolveI18nModule(): false | I18nModuleResolution;
+declare function resolveI18nConfig(logger?: {
+    warn: (msg: string) => void;
+}): Promise<false | AutoI18nConfig>;
+declare function mergeOnKey<T extends Record<string, any>>(arr: T[], key: keyof T): T[];
+
+export { generatePathForI18nPages, mapPathForI18nPages, mergeOnKey, normalizeLocales, resolveI18nConfig, resolveI18nModule, splitPathForI18nLocales };
+export type { AutoI18nConfig, I18nModuleResolution, NormalisedLocale, Strategies, StrategyProps };