@flightdev/seo 0.2.0

package/dist/types-BBIMJIqz.d.ts

@@ -0,0 +1,433 @@
+/**
+ * @flightdev/seo - Type Definitions
+ *
+ * Core type definitions for SEO, meta tags, Open Graph, Twitter Cards,
+ * and structured data. All types are designed for strict TypeScript usage.
+ */
+/**
+ * Robots meta directives
+ */
+interface RobotsMeta {
+    /** Allow indexing of this page */
+    index?: boolean;
+    /** Allow following links on this page */
+    follow?: boolean;
+    /** Prevent caching of this page */
+    noarchive?: boolean;
+    /** Prevent snippet generation */
+    nosnippet?: boolean;
+    /** Prevent translation */
+    notranslate?: boolean;
+    /** Maximum snippet length (-1 for unlimited, 0 for none) */
+    maxSnippet?: number;
+    /** Maximum image preview size ('none', 'standard', 'large') */
+    maxImagePreview?: 'none' | 'standard' | 'large';
+    /** Maximum video preview length in seconds (-1 for unlimited, 0 for none) */
+    maxVideoPreview?: number;
+    /** Prevent showing in Google News */
+    nosnippetFromNews?: boolean;
+    /** Unavailable after date (ISO 8601) */
+    unavailableAfter?: string;
+}
+/**
+ * Alternate link for internationalization or formats
+ */
+interface AlternateLink {
+    /** Language/region code (e.g., 'en-US', 'es') or 'x-default' */
+    hreflang?: string;
+    /** Alternate URL */
+    href: string;
+    /** Media query for responsive alternates */
+    media?: string;
+    /** MIME type for format alternates */
+    type?: string;
+    /** Title for the alternate */
+    title?: string;
+}
+/**
+ * Verification meta tags for search engines
+ */
+interface VerificationMeta {
+    google?: string;
+    bing?: string;
+    yandex?: string;
+    pinterest?: string;
+    norton?: string;
+}
+/**
+ * Open Graph image definition
+ */
+interface OpenGraphImage {
+    /** Image URL (must be absolute) */
+    url: string;
+    /** Secure URL (https) */
+    secureUrl?: string;
+    /** Image width in pixels */
+    width?: number;
+    /** Image height in pixels */
+    height?: number;
+    /** Alt text for accessibility */
+    alt?: string;
+    /** MIME type */
+    type?: 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp' | string;
+}
+/**
+ * Open Graph video definition
+ */
+interface OpenGraphVideo {
+    /** Video URL */
+    url: string;
+    /** Secure URL (https) */
+    secureUrl?: string;
+    /** Video width in pixels */
+    width?: number;
+    /** Video height in pixels */
+    height?: number;
+    /** MIME type */
+    type?: 'video/mp4' | 'video/webm' | string;
+}
+/**
+ * Open Graph audio definition
+ */
+interface OpenGraphAudio {
+    /** Audio URL */
+    url: string;
+    /** Secure URL (https) */
+    secureUrl?: string;
+    /** MIME type */
+    type?: 'audio/mpeg' | 'audio/ogg' | string;
+}
+/**
+ * Open Graph article-specific properties
+ */
+interface OpenGraphArticle {
+    /** When the article was first published (ISO 8601) */
+    publishedTime?: string;
+    /** When the article was last modified (ISO 8601) */
+    modifiedTime?: string;
+    /** When the article expires (ISO 8601) */
+    expirationTime?: string;
+    /** Authors of the article */
+    authors?: string[];
+    /** Article section/category */
+    section?: string;
+    /** Article tags */
+    tags?: string[];
+}
+/**
+ * Open Graph profile properties
+ */
+interface OpenGraphProfile {
+    /** First name */
+    firstName?: string;
+    /** Last name */
+    lastName?: string;
+    /** Username */
+    username?: string;
+    /** Gender */
+    gender?: 'male' | 'female';
+}
+/**
+ * Open Graph book properties
+ */
+interface OpenGraphBook {
+    /** Authors of the book */
+    authors?: string[];
+    /** ISBN */
+    isbn?: string;
+    /** Release date (ISO 8601) */
+    releaseDate?: string;
+    /** Book tags */
+    tags?: string[];
+}
+/**
+ * Open Graph product properties
+ */
+interface OpenGraphProduct {
+    /** Product price amount */
+    priceAmount?: number;
+    /** Price currency (ISO 4217) */
+    priceCurrency?: string;
+    /** Product availability */
+    availability?: 'instock' | 'outofstock' | 'preorder' | 'pending';
+    /** Product condition */
+    condition?: 'new' | 'refurbished' | 'used';
+    /** Retailer item ID */
+    retailerItemId?: string;
+}
+/**
+ * Open Graph type
+ */
+type OpenGraphType = 'website' | 'article' | 'book' | 'profile' | 'music.song' | 'music.album' | 'music.playlist' | 'music.radio_station' | 'video.movie' | 'video.episode' | 'video.tv_show' | 'video.other' | 'product' | string;
+/**
+ * Complete Open Graph metadata
+ */
+interface OpenGraphMeta {
+    /** Content type */
+    type?: OpenGraphType;
+    /** Page title */
+    title?: string;
+    /** Page description */
+    description?: string;
+    /** Canonical URL */
+    url?: string;
+    /** Site name */
+    siteName?: string;
+    /** Locale (e.g., 'en_US') */
+    locale?: string;
+    /** Alternate locales */
+    alternateLocales?: string[];
+    /** Images */
+    images?: OpenGraphImage[];
+    /** Videos */
+    videos?: OpenGraphVideo[];
+    /** Audio */
+    audio?: OpenGraphAudio[];
+    /** Determiner ('a', 'an', 'the', '', 'auto') */
+    determiner?: 'a' | 'an' | 'the' | '' | 'auto';
+    /** Article-specific properties */
+    article?: OpenGraphArticle;
+    /** Profile-specific properties */
+    profile?: OpenGraphProfile;
+    /** Book-specific properties */
+    book?: OpenGraphBook;
+    /** Product-specific properties */
+    product?: OpenGraphProduct;
+}
+/**
+ * Twitter Card type
+ */
+type TwitterCardType = 'summary' | 'summary_large_image' | 'app' | 'player';
+/**
+ * Twitter Card image
+ */
+interface TwitterCardImage {
+    /** Image URL */
+    url: string;
+    /** Alt text */
+    alt?: string;
+}
+/**
+ * Twitter Card player (for player cards)
+ */
+interface TwitterCardPlayer {
+    /** Player URL */
+    url: string;
+    /** Player width */
+    width: number;
+    /** Player height */
+    height: number;
+    /** Stream URL */
+    stream?: string;
+}
+/**
+ * Twitter Card app (for app cards)
+ */
+interface TwitterCardApp {
+    /** App name */
+    name: string;
+    /** App ID */
+    id: {
+        iphone?: string;
+        ipad?: string;
+        googleplay?: string;
+    };
+    /** App URL */
+    url?: {
+        iphone?: string;
+        ipad?: string;
+        googleplay?: string;
+    };
+}
+/**
+ * Complete Twitter Card metadata
+ */
+interface TwitterCardMeta {
+    /** Card type */
+    card?: TwitterCardType;
+    /** Page title (max 70 chars) */
+    title?: string;
+    /** Page description (max 200 chars) */
+    description?: string;
+    /** Site Twitter handle (e.g., '@example') */
+    site?: string;
+    /** Site ID */
+    siteId?: string;
+    /** Creator Twitter handle */
+    creator?: string;
+    /** Creator ID */
+    creatorId?: string;
+    /** Card image */
+    image?: TwitterCardImage | string;
+    /** Additional images */
+    images?: TwitterCardImage[];
+    /** Player card data */
+    player?: TwitterCardPlayer;
+    /** App card data */
+    app?: TwitterCardApp;
+    /** Custom labels (for large image cards) */
+    label1?: string;
+    data1?: string;
+    label2?: string;
+    data2?: string;
+}
+/**
+ * Icon definition
+ */
+interface IconMeta {
+    /** Icon URL */
+    url: string;
+    /** Icon type */
+    type?: string;
+    /** Icon sizes (e.g., '32x32', '180x180') */
+    sizes?: string;
+    /** Icon purpose for web manifest */
+    purpose?: 'any' | 'maskable' | 'monochrome';
+}
+/**
+ * Complete page metadata
+ */
+interface Metadata {
+    /** Page title */
+    title?: string;
+    /** Title template (e.g., '%s | My Site') */
+    titleTemplate?: string;
+    /** Default title when page title is empty */
+    defaultTitle?: string;
+    /** Page description */
+    description?: string;
+    /** Keywords (generally not used by search engines anymore) */
+    keywords?: string | string[];
+    /** Author name */
+    author?: string;
+    /** Generator (e.g., 'Flight Framework') */
+    generator?: string;
+    /** Application name */
+    applicationName?: string;
+    /** Referrer policy */
+    referrer?: 'no-referrer' | 'origin' | 'no-referrer-when-downgrade' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url';
+    /** Theme color */
+    themeColor?: string | {
+        media: string;
+        color: string;
+    }[];
+    /** Color scheme */
+    colorScheme?: 'light' | 'dark' | 'light dark' | 'dark light' | 'only light';
+    /** Viewport configuration */
+    viewport?: string | {
+        width?: number | 'device-width';
+        height?: number | 'device-height';
+        initialScale?: number;
+        minimumScale?: number;
+        maximumScale?: number;
+        userScalable?: boolean;
+        viewportFit?: 'auto' | 'contain' | 'cover';
+    };
+    /** Charset (default: 'utf-8') */
+    charset?: string;
+    /** Canonical URL */
+    canonical?: string;
+    /** Alternate links (hreflang, RSS, etc.) */
+    alternates?: AlternateLink[];
+    /** Base URL for relative URLs */
+    base?: string;
+    /** Robots directives */
+    robots?: RobotsMeta | string;
+    /** Google-specific robots */
+    googleBot?: RobotsMeta | string;
+    /** Search engine verification */
+    verification?: VerificationMeta;
+    /** Open Graph metadata */
+    openGraph?: OpenGraphMeta;
+    /** Twitter Card metadata */
+    twitter?: TwitterCardMeta;
+    /** Apple-specific metadata */
+    apple?: {
+        /** Apple touch icon */
+        touchIcon?: string | IconMeta;
+        /** Web app capable */
+        mobileWebAppCapable?: boolean;
+        /** Status bar style */
+        statusBarStyle?: 'default' | 'black' | 'black-translucent';
+        /** App title */
+        title?: string;
+    };
+    /** Favicon */
+    icons?: {
+        icon?: string | IconMeta | (string | IconMeta)[];
+        shortcut?: string | IconMeta;
+        apple?: string | IconMeta | (string | IconMeta)[];
+        other?: IconMeta[];
+    };
+    /** Web manifest URL */
+    manifest?: string;
+    /** Additional meta tags */
+    other?: Record<string, string>;
+}
+/**
+ * Metadata with resolved values (after template processing)
+ */
+interface ResolvedMetadata extends Metadata {
+    /** Fully resolved title (after template application) */
+    resolvedTitle?: string;
+}
+/**
+ * HTML tag definition for rendering
+ */
+interface HtmlTag {
+    /** Tag name (e.g., 'meta', 'link', 'title') */
+    tag: 'title' | 'meta' | 'link' | 'script' | 'base';
+    /** Tag attributes */
+    attrs?: Record<string, string | boolean | undefined>;
+    /** Tag content (for title, script) */
+    content?: string;
+    /** Unique key for deduplication */
+    key?: string;
+}
+/**
+ * Rendered head result
+ */
+interface RenderedHead {
+    /** All generated HTML tags */
+    tags: HtmlTag[];
+    /** Rendered HTML string */
+    html: string;
+}
+/**
+ * SEO service configuration
+ */
+interface SEOConfig {
+    /** Base URL for canonical URLs */
+    baseUrl?: string;
+    /** Default title template */
+    titleTemplate?: string;
+    /** Default title */
+    defaultTitle?: string;
+    /** Default Open Graph data */
+    defaultOpenGraph?: Partial<OpenGraphMeta>;
+    /** Default Twitter Card data */
+    defaultTwitter?: Partial<TwitterCardMeta>;
+    /** Enable/disable specific features */
+    features?: {
+        openGraph?: boolean;
+        twitter?: boolean;
+        robots?: boolean;
+    };
+}
+/**
+ * SEO service interface
+ */
+interface SEOService {
+    /** Service configuration */
+    readonly config: SEOConfig;
+    /** Render metadata to HTML tags */
+    render(metadata: Metadata): RenderedHead;
+    /** Merge metadata (parent with child) */
+    merge(parent: Metadata, child: Metadata): Metadata;
+    /** Resolve title with template */
+    resolveTitle(metadata: Metadata): string;
+    /** Generate canonical URL */
+    canonical(path: string): string;
+}
+
+export type { AlternateLink as A, HtmlTag as H, IconMeta as I, Metadata as M, OpenGraphMeta as O, RenderedHead as R, SEOConfig as S, TwitterCardMeta as T, VerificationMeta as V, SEOService as a, ResolvedMetadata as b, RobotsMeta as c, OpenGraphType as d, OpenGraphImage as e, OpenGraphVideo as f, OpenGraphAudio as g, OpenGraphArticle as h, OpenGraphProfile as i, OpenGraphBook as j, OpenGraphProduct as k, TwitterCardType as l, TwitterCardImage as m, TwitterCardPlayer as n, TwitterCardApp as o };

package/dist/vue/index.d.ts

@@ -0,0 +1,130 @@
+import { Ref } from 'vue';
+import { M as Metadata } from '../types-BBIMJIqz.js';
+import { JsonLdSchema } from '../json-ld/index.js';
+
+/**
+ * @flightdev/seo/vue
+ *
+ * Vue composables for SEO management.
+ * SSR-first with reactive client-side updates.
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { useSEO, useJsonLd } from '@flightdev/seo/vue';
+ *
+ * useSEO({
+ *   title: 'My Page',
+ *   description: 'Page description',
+ * });
+ *
+ * useJsonLd({
+ *   '@type': 'WebPage',
+ *   name: 'My Page',
+ * });
+ * </script>
+ * ```
+ */
+
+interface SEOState {
+    metadata: Metadata;
+    setMetadata: (metadata: Metadata) => void;
+    addMetadata: (metadata: Metadata) => void;
+}
+/**
+ * Provide SEO context for the component tree
+ */
+declare function provideSEO(defaultMetadata?: Metadata): SEOState;
+/**
+ * Inject SEO context
+ */
+declare function injectSEO(): SEOState | undefined;
+interface UseSEOOptions {
+    immediate?: boolean;
+}
+/**
+ * Composable for managing page SEO metadata
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { useSEO } from '@flightdev/seo/vue';
+ *
+ * useSEO({
+ *   title: 'Product Name',
+ *   description: 'Product description',
+ *   openGraph: {
+ *     type: 'product',
+ *     images: [{ url: '/product.jpg' }],
+ *   },
+ * });
+ * </script>
+ * ```
+ */
+declare function useSEO(metadata: Metadata | Ref<Metadata>, options?: UseSEOOptions): void;
+interface SeoMetaInput {
+    title?: string;
+    titleTemplate?: string;
+    description?: string;
+    keywords?: string | string[];
+    author?: string;
+    robots?: string;
+    canonical?: string;
+    ogTitle?: string;
+    ogDescription?: string;
+    ogImage?: string;
+    ogUrl?: string;
+    ogType?: string;
+    ogSiteName?: string;
+    ogLocale?: string;
+    twitterCard?: 'summary' | 'summary_large_image' | 'app' | 'player';
+    twitterTitle?: string;
+    twitterDescription?: string;
+    twitterImage?: string;
+    twitterSite?: string;
+    twitterCreator?: string;
+}
+/**
+ * Flat SEO meta composable (similar to useSeoMeta from unhead)
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { useSeoMeta } from '@flightdev/seo/vue';
+ *
+ * useSeoMeta({
+ *   title: 'Product Name',
+ *   description: 'Product description',
+ *   ogTitle: 'Product Name',
+ *   ogImage: '/product.jpg',
+ *   twitterCard: 'summary_large_image',
+ * });
+ * </script>
+ * ```
+ */
+declare function useSeoMeta(input: SeoMetaInput | Ref<SeoMetaInput>): void;
+/**
+ * Composable for JSON-LD structured data
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { useJsonLd } from '@flightdev/seo/vue';
+ *
+ * useJsonLd({
+ *   '@type': 'Product',
+ *   name: 'Widget',
+ *   offers: { price: 9.99, priceCurrency: 'USD' },
+ * });
+ * </script>
+ * ```
+ */
+declare function useJsonLd<T extends JsonLdSchema>(schema: T | Ref<T>, options?: {
+    id?: string;
+}): void;
+/**
+ * Render metadata to HTML string for SSR
+ */
+declare function renderMetadataToString(metadata: Metadata): string;
+
+export { type SEOState, type SeoMetaInput, type UseSEOOptions, injectSEO, provideSEO, renderMetadataToString, useJsonLd, useSEO, useSeoMeta };