@jet-w/astro-blog 0.1.6 → 0.2.1

package/dist/i18n-PgMCFBw0.d.ts

@@ -0,0 +1,222 @@
+import { SiteConfig, NavigationItem } from './types/index.js';
+import { b as SidebarConfig } from './sidebar-Da-W_4Lr.js';
+
+/**
+ * 社交链接配置
+ */
+interface SocialLink {
+    type: string;
+    url: string;
+    label?: string;
+    icon?: string;
+}
+declare const defaultIcons: Record<string, string>;
+declare const socialLinks: SocialLink[];
+declare const defaultSocialLinks: SocialLink[];
+/**
+ * Define social links
+ */
+declare function defineSocialLinks(links: SocialLink[]): SocialLink[];
+
+/**
+ * Footer 配置
+ */
+
+interface FooterLink {
+    name: string;
+    href: string;
+}
+interface FooterConfig {
+    quickLinksTitle: string;
+    quickLinks: FooterLink[];
+    contactTitle: string;
+    socialLinks: SocialLink[];
+    showRss: boolean;
+    rssUrl: string;
+    copyright: string;
+    poweredBy: {
+        text: string;
+        url: string;
+    };
+}
+declare const footerConfig: FooterConfig;
+/**
+ * Define footer configuration
+ */
+declare function defineFooterConfig(config: Partial<FooterConfig>): FooterConfig;
+declare const defaultFooterConfig: FooterConfig;
+
+/**
+ * i18n Configuration Module
+ *
+ * Provides multi-language support configuration for the blog.
+ */
+
+/**
+ * Locale definition
+ */
+interface Locale {
+    /** Language code (e.g., 'en', 'zh-CN', 'ja') */
+    code: string;
+    /** Display name (e.g., 'English', '中文') */
+    name: string;
+    /** HTML lang attribute value */
+    htmlLang: string;
+    /** Locale for Intl.DateTimeFormat */
+    dateLocale: string;
+    /** Text direction */
+    direction?: 'ltr' | 'rtl';
+}
+/**
+ * UI translation strings
+ */
+interface UITranslations {
+    home: string;
+    blog: string;
+    about: string;
+    search: string;
+    posts: string;
+    postList: string;
+    noPostsFound: string;
+    readMore: string;
+    readingTime: string;
+    minuteRead: string;
+    tags: string;
+    categories: string;
+    allTags: string;
+    allCategories: string;
+    taggedWith: string;
+    inCategory: string;
+    archives: string;
+    postsInArchive: string;
+    recentPosts: string;
+    popularTags: string;
+    friendLinks: string;
+    documentTree: string;
+    quickLinks: string;
+    contact: string;
+    searchPlaceholder: string;
+    searchResults: string;
+    noResults: string;
+    searching: string;
+    searchArticles: string;
+    searchInAllArticles: string;
+    searchTips: string;
+    basicSearch: string;
+    advancedFeatures: string;
+    searchTipKeyword: string;
+    searchTipMixedLang: string;
+    searchTipCaseInsensitive: string;
+    searchTipRealtime: string;
+    searchTipFilter: string;
+    searchTipFuzzy: string;
+    browsePosts: string;
+    aboutMe: string;
+    previousPage: string;
+    nextPage: string;
+    page: string;
+    of: string;
+    publishedOn: string;
+    updatedOn: string;
+    author: string;
+    tableOfContents: string;
+    readingProgress: string;
+    relatedPosts: string;
+    sharePost: string;
+    previousPost: string;
+    nextPost: string;
+    backToTop: string;
+    copyCode: string;
+    copied: string;
+    expand: string;
+    collapse: string;
+    expandCode: string;
+    collapseCode: string;
+    lines: string;
+    viewMode: string;
+    cardView: string;
+    listView: string;
+    sortBy: string;
+    sortByDate: string;
+    sortByTitle: string;
+    filterByTag: string;
+    filterByCategory: string;
+    clearFilter: string;
+    allPosts: string;
+    draft: string;
+    slides: string;
+    slidesList: string;
+    rssFeed: string;
+    quickNavigation: string;
+    timeline: string;
+    viewAllTimeline: string;
+    postsCount: string;
+}
+/**
+ * Locale-specific configuration
+ */
+interface LocaleConfig {
+    /** Site configuration overrides */
+    site?: Partial<SiteConfig>;
+    /** Navigation menu items */
+    menu?: NavigationItem[];
+    /** Footer configuration overrides */
+    footer?: Partial<FooterConfig>;
+    /** Sidebar configuration overrides */
+    sidebar?: Partial<SidebarConfig>;
+    /** UI translation overrides */
+    ui?: Partial<UITranslations>;
+    /** Content path prefix for filtering posts by locale (e.g., 'blog_docs_en' for English) */
+    contentPathPrefix?: string;
+}
+/**
+ * i18n routing configuration
+ */
+interface I18nRoutingConfig {
+    /** Whether to add prefix for default locale (e.g., /zh-CN/posts vs /posts) */
+    prefixDefaultLocale: boolean;
+}
+/**
+ * Complete i18n configuration
+ */
+interface I18nConfig {
+    /** Default locale code */
+    defaultLocale: string;
+    /** Available locales */
+    locales: Locale[];
+    /** Locale-specific configurations */
+    localeConfigs: Record<string, LocaleConfig>;
+    /** Routing configuration */
+    routing: I18nRoutingConfig;
+}
+/**
+ * Default Chinese (Simplified) UI translations
+ */
+declare const zhCNTranslations: UITranslations;
+/**
+ * Default English UI translations
+ */
+declare const enTranslations: UITranslations;
+/**
+ * Built-in translations for common languages
+ */
+declare const builtInTranslations: Record<string, UITranslations>;
+/**
+ * Default locales
+ */
+declare const defaultLocales: Locale[];
+/**
+ * Default i18n configuration (Chinese only, backward compatible)
+ */
+declare const defaultI18nConfig: I18nConfig;
+/**
+ * Helper function to define i18n configuration with type safety
+ */
+declare function defineI18nConfig(config: Partial<I18nConfig>): I18nConfig;
+/**
+ * Get UI translations for a specific locale
+ * Falls back to built-in translations, then to English
+ */
+declare function getUITranslations(locale: string, config?: I18nConfig): UITranslations;
+
+export { type FooterConfig as F, type I18nConfig as I, type Locale as L, type SocialLink as S, type UITranslations as U, defaultSocialLinks as a, defineSocialLinks as b, defaultFooterConfig as c, defaultIcons as d, defineFooterConfig as e, footerConfig as f, defaultI18nConfig as g, defineI18nConfig as h, getUITranslations as i, builtInTranslations as j, enTranslations as k, defaultLocales as l, type FooterLink as m, type LocaleConfig as n, type I18nRoutingConfig as o, socialLinks as s, zhCNTranslations as z };

package/dist/index.d.ts

@@ -1,12 +1,208 @@
-import { FooterConfig, SocialLink } from './config/index.js';
-export { FooterLink, defaultFooterConfig, defaultIcons, defaultMenu, defaultSEO, defaultSiteConfig, defaultSocialLinks, defineFooterConfig, defineMenu, defineSiteConfig, defineSocialLinks, footerConfig, menu, siteConfig, socialLinks } from './config/index.js';
-import { S as SidebarConfig } from './sidebar-DNdiCKBw.js';
-export { D as DividerConfig, M as ManualConfig, f as MixedConfig, P as PathMatchConfig, e as ScanConfig, b as SidebarGroup, c as SidebarItem, d as defaultSidebarConfig, a as defineSidebarConfig, s as sidebarConfig } from './sidebar-DNdiCKBw.js';
-import { SiteConfig } from './types/index.js';
-export { BlogPost, Category, NavigationItem, PostFrontmatter, SEOProps, SearchResult, Tag } from './types/index.js';
+export { defaultMenu, defaultSEO, defaultSiteConfig, defineMenu, defineSiteConfig, menu, siteConfig } from './config/index.js';
+import { b as SidebarConfig } from './sidebar-Da-W_4Lr.js';
+export { D as DividerConfig, M as ManualConfig, f as MixedConfig, P as PathMatchConfig, e as ScanConfig, a as SidebarGroup, S as SidebarItem, d as defaultSidebarConfig, c as defineSidebarConfig, s as sidebarConfig } from './sidebar-Da-W_4Lr.js';
+import { I as I18nConfig, L as Locale, F as FooterConfig, U as UITranslations, S as SocialLink } from './i18n-PgMCFBw0.js';
+export { m as FooterLink, o as I18nRoutingConfig, n as LocaleConfig, j as builtInTranslations, c as defaultFooterConfig, g as defaultI18nConfig, d as defaultIcons, l as defaultLocales, a as defaultSocialLinks, e as defineFooterConfig, h as defineI18nConfig, b as defineSocialLinks, k as enTranslations, f as footerConfig, i as getUITranslations, s as socialLinks, z as zhCNTranslations } from './i18n-PgMCFBw0.js';
+import { SiteConfig, NavigationItem } from './types/index.js';
+export { BlogPost, Category, PostFrontmatter, SEOProps, SearchResult, Tag } from './types/index.js';
 export { AstroBlogIntegrationOptions, default as astroBlog, default as astroBlogIntegration } from './integration.js';
+import { ComputedRef } from 'vue';
 import 'astro';
 
+/**
+ * i18n Utility Functions
+ *
+ * Provides helper functions for multi-language support.
+ */
+
+/**
+ * Merged locale configuration with all defaults applied
+ */
+interface MergedLocaleConfig {
+    locale: Locale;
+    site: SiteConfig;
+    menu: NavigationItem[];
+    footer: FooterConfig;
+    sidebar: SidebarConfig;
+    ui: UITranslations;
+}
+/**
+ * Alternate link for SEO (hreflang)
+ */
+interface AlternateLink {
+    locale: string;
+    url: string;
+    hreflang: string;
+}
+/**
+ * Get current locale from URL pathname
+ *
+ * @example
+ * getLocaleFromPath('/en/posts', config) // 'en'
+ * getLocaleFromPath('/posts', config) // 'zh-CN' (default)
+ * getLocaleFromPath('/zh-CN/about', config) // 'zh-CN'
+ */
+declare function getLocaleFromPath(pathname: string, config?: I18nConfig): string;
+/**
+ * Get locale data by code
+ */
+declare function getLocaleByCode(code: string, config?: I18nConfig): Locale | undefined;
+/**
+ * Remove locale prefix from pathname
+ *
+ * @example
+ * removeLocalePrefix('/en/posts', config) // '/posts'
+ * removeLocalePrefix('/posts', config) // '/posts'
+ */
+declare function removeLocalePrefix(pathname: string, config?: I18nConfig): string;
+/**
+ * Get localized path for a given locale
+ *
+ * @example
+ * getLocalizedPath('/posts', 'en', config) // '/en/posts'
+ * getLocalizedPath('/en/posts', 'zh-CN', config) // '/posts' (if zh-CN is default)
+ */
+declare function getLocalizedPath(pathname: string, targetLocale: string, config?: I18nConfig): string;
+/**
+ * Get all alternate links for SEO (hreflang tags)
+ *
+ * @example
+ * getAlternateLinks('/posts', 'https://example.com', config)
+ * // Returns links for all locales
+ */
+declare function getAlternateLinks(pathname: string, baseUrl: string, config?: I18nConfig): AlternateLink[];
+/**
+ * Get merged configuration for a specific locale
+ * Combines default config with locale-specific overrides
+ */
+declare function getLocaleConfig(locale: string, config?: I18nConfig): MergedLocaleConfig;
+/**
+ * Translation function - get a UI translation string
+ *
+ * @example
+ * t('readMore', 'en') // 'Read more'
+ * t('readMore', 'zh-CN') // '阅读更多'
+ */
+declare function t(key: keyof UITranslations, locale: string, config?: I18nConfig): string;
+/**
+ * Format date according to locale
+ *
+ * @example
+ * formatDate(new Date(), 'en') // 'January 1, 2024'
+ * formatDate(new Date(), 'zh-CN') // '2024年1月1日'
+ */
+declare function formatDate(date: Date | string, locale: string, options?: Intl.DateTimeFormatOptions): string;
+/**
+ * Format date in short format
+ *
+ * @example
+ * formatDateShort(new Date(), 'en') // '1/1/2024'
+ * formatDateShort(new Date(), 'zh-CN') // '2024/1/1'
+ */
+declare function formatDateShort(date: Date | string, locale: string): string;
+/**
+ * Check if a locale is RTL (right-to-left)
+ */
+declare function isRTL(locale: string, config?: I18nConfig): boolean;
+/**
+ * Get the HTML dir attribute value
+ */
+declare function getTextDirection(locale: string, config?: I18nConfig): 'ltr' | 'rtl';
+/**
+ * Check if multi-language is enabled (more than one locale)
+ */
+declare function isMultiLanguageEnabled(config?: I18nConfig): boolean;
+/**
+ * Get prefix for a locale in routes
+ * Returns empty string for default locale if prefixDefaultLocale is false
+ */
+declare function getLocalePrefix(locale: string, config?: I18nConfig): string;
+/**
+ * Get content path prefix for a specific locale
+ * Returns the contentPathPrefix from locale config, or undefined if not set
+ */
+declare function getContentPathPrefix(locale: string, config?: I18nConfig): string | undefined;
+/**
+ * Filter posts by locale based on contentPathPrefix
+ * If contentPathPrefix is set, only return posts that start with that prefix
+ * If not set, return all posts (backward compatible)
+ *
+ * @example
+ * // If en locale has contentPathPrefix: 'blog_docs_en'
+ * filterPostsByLocale(posts, 'en', config)
+ * // Returns only posts with id starting with 'blog_docs_en/'
+ */
+declare function filterPostsByLocale<T extends {
+    id: string;
+}>(posts: T[], locale: string, config?: I18nConfig): T[];
+
+/**
+ * Vue Composable for i18n
+ *
+ * Provides i18n support for Vue components in the blog.
+ */
+
+/**
+ * i18n injection keys
+ */
+declare const I18N_LOCALE_KEY: unique symbol;
+declare const I18N_CONFIG_KEY: unique symbol;
+declare const I18N_TRANSLATIONS_KEY: unique symbol;
+/**
+ * i18n context provided to Vue components
+ */
+interface I18nContext {
+    locale: string;
+    translations: UITranslations;
+    config?: I18nConfig;
+}
+/**
+ * Return type of useI18n composable
+ */
+interface UseI18nReturn {
+    /** Current locale code */
+    locale: ComputedRef<string>;
+    /** Translation function */
+    t: (key: keyof UITranslations) => string;
+    /** Format date according to locale */
+    formatDate: (date: Date | string, options?: Intl.DateTimeFormatOptions) => string;
+    /** Format date in short format */
+    formatDateShort: (date: Date | string) => string;
+    /** All translations for current locale */
+    translations: ComputedRef<UITranslations>;
+}
+/**
+ * Vue composable for i18n support
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { useI18n } from '@jet-w/astro-blog/utils/useI18n';
+ *
+ * const { t, formatDate, locale } = useI18n();
+ * </script>
+ *
+ * <template>
+ *   <h1>{{ t('postList') }}</h1>
+ *   <span>{{ formatDate(post.pubDate) }}</span>
+ * </template>
+ * ```
+ */
+declare function useI18n(): UseI18nReturn;
+/**
+ * Create i18n context for providing to Vue components
+ *
+ * @example
+ * ```astro
+ * ---
+ * import { createI18nContext } from '@jet-w/astro-blog/utils/useI18n';
+ * const i18nContext = createI18nContext('en', i18nConfig);
+ * ---
+ * <Component client:load {...i18nContext} />
+ * ```
+ */
+declare function createI18nContext(locale: string, config?: I18nConfig): I18nContext;
+
 /**
  * Define blog configuration helper
  */
@@ -15,6 +211,7 @@ interface BlogConfig {
     sidebar?: SidebarConfig;
     footer?: FooterConfig;
     social?: SocialLink[];
+    i18n?: I18nConfig;
 }
 declare function defineBlogConfig(config: BlogConfig): BlogConfig;
 /**
@@ -35,4 +232,4 @@ declare function getAstroConfig(options?: {
     };
 };
 
-export { type BlogConfig, FooterConfig, SidebarConfig, SiteConfig, SocialLink, defineBlogConfig, getAstroConfig };
+export { type AlternateLink, type BlogConfig, FooterConfig, I18N_CONFIG_KEY, I18N_LOCALE_KEY, I18N_TRANSLATIONS_KEY, I18nConfig, type I18nContext, Locale, type MergedLocaleConfig, NavigationItem, SidebarConfig, SiteConfig, SocialLink, UITranslations, type UseI18nReturn, createI18nContext, defineBlogConfig, filterPostsByLocale, formatDate, formatDateShort, getAlternateLinks, getAstroConfig, getContentPathPrefix, getLocaleByCode, getLocaleConfig, getLocaleFromPath, getLocalePrefix, getLocalizedPath, getTextDirection, isMultiLanguageEnabled, isRTL, removeLocalePrefix, t, useI18n };