npm - @zoyth/simple-site-framework - Versions diffs - 1.0.0 - Mend

@zoyth/simple-site-framework 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (166) hide show

package/LICENSE +21 -0
package/README.md +572 -0
package/bin/create-simple-site.js +390 -0
package/bin/simple-site.js +664 -0
package/dist/client.js +135 -0
package/dist/client.js.map +1 -0
package/dist/client.mjs +107 -0
package/dist/client.mjs.map +1 -0
package/dist/components/index.d.mts +3936 -0
package/dist/components/index.d.ts +3936 -0
package/dist/components/index.js +38265 -0
package/dist/components/index.js.map +1 -0
package/dist/components/index.mjs +38173 -0
package/dist/components/index.mjs.map +1 -0
package/dist/config/index.d.mts +298 -0
package/dist/config/index.d.ts +298 -0
package/dist/config/index.js +19 -0
package/dist/config/index.js.map +1 -0
package/dist/config/index.mjs +1 -0
package/dist/config/index.mjs.map +1 -0
package/dist/index.d.mts +2184 -0
package/dist/index.d.ts +2184 -0
package/dist/index.js +1713 -0
package/dist/index.js.map +1 -0
package/dist/index.mjs +1605 -0
package/dist/index.mjs.map +1 -0
package/dist/lib/i18n/index.js +665 -0
package/dist/lib/i18n/index.js.map +1 -0
package/dist/lib/i18n/index.mjs +621 -0
package/dist/lib/i18n/index.mjs.map +1 -0
package/docs/DOCUMENTATION-STRUCTURE.md +1156 -0
package/docs/EXPORTS.md +125 -0
package/docs/PERFORMANCE.md +757 -0
package/docs/POLICY-PAGES.md +867 -0
package/docs/ROADMAP.md +334 -0
package/docs/SEO.md +455 -0
package/docs/SITEMAP.md +708 -0
package/docs/STRUCTURED-DATA.md +671 -0
package/docs/accessibility/common-patterns.md +529 -0
package/docs/accessibility/keyboard-navigation.md +263 -0
package/docs/accessibility/overview.md +122 -0
package/docs/accessibility/screen-readers.md +311 -0
package/docs/accessibility/wcag-compliance.md +159 -0
package/docs/api/README.md +164 -0
package/docs/api/components/Accessibility.md +356 -0
package/docs/api/components/Button.md +240 -0
package/docs/api/components/HeroSection.md +306 -0
package/docs/architecture/decisions.md +449 -0
package/docs/components/AnalyticsTracker.md +58 -0
package/docs/components/AnimatedCounter.md +48 -0
package/docs/components/AnimatedSection.md +56 -0
package/docs/components/BlogCard.md +42 -0
package/docs/components/Checkbox.md +56 -0
package/docs/components/CodeBlock.md +52 -0
package/docs/components/ComparisonTable.md +40 -0
package/docs/components/ComponentDemo.md +38 -0
package/docs/components/CountdownTimer.md +51 -0
package/docs/components/ExitIntentModal.md +56 -0
package/docs/components/FAQAccordion.md +66 -0
package/docs/components/FeaturesGrid.md +55 -0
package/docs/components/FileUpload.md +54 -0
package/docs/components/I18nMetaTags.md +55 -0
package/docs/components/Icon.md +53 -0
package/docs/components/LazySection.md +46 -0
package/docs/components/LiveProof.md +53 -0
package/docs/components/LoadingSpinner.md +46 -0
package/docs/components/MultiStepForm.md +48 -0
package/docs/components/PolicyLayout.md +55 -0
package/docs/components/PricingTable.md +49 -0
package/docs/components/Radio.md +59 -0
package/docs/components/SEOMetaTags.md +58 -0
package/docs/components/ScriptInjector.md +50 -0
package/docs/components/Select.md +72 -0
package/docs/components/Skeleton.md +47 -0
package/docs/components/StatsSection.md +48 -0
package/docs/components/StickyBar.md +62 -0
package/docs/components/StructuredData.md +99 -0
package/docs/components/StyleGuide.md +46 -0
package/docs/components/TableOfContents.md +47 -0
package/docs/components/TestimonialCarousel.md +42 -0
package/docs/components/Timeline.md +51 -0
package/docs/components/Toast.md +59 -0
package/docs/components/TrackedLink.md +62 -0
package/docs/components/TrustBadges.md +44 -0
package/docs/components/conversion/MobileCTA.md +363 -0
package/docs/components/forms/ContactForm.md +75 -0
package/docs/components/forms/FormField.md +74 -0
package/docs/components/layout/Footer.md +601 -0
package/docs/components/layout/Header.md +549 -0
package/docs/components/layout/LanguageSelector.md +54 -0
package/docs/components/layout/LanguageSwitcher.md +24 -0
package/docs/components/overview.md +447 -0
package/docs/components/sections/AboutSection.md +48 -0
package/docs/components/sections/CTASection.md +596 -0
package/docs/components/sections/CaseStudySection.md +47 -0
package/docs/components/sections/ContactSection.md +599 -0
package/docs/components/sections/FeatureSection.md +44 -0
package/docs/components/sections/HeroSection.md +404 -0
package/docs/components/sections/LogosSection.md +47 -0
package/docs/components/sections/PersonalTaxesSection.md +23 -0
package/docs/components/sections/RecruitingSection.md +23 -0
package/docs/components/sections/SecurePortalSection.md +23 -0
package/docs/components/sections/ServicePageLayout.md +52 -0
package/docs/components/sections/ServicesSection.md +49 -0
package/docs/components/sections/TestimonialSection.md +44 -0
package/docs/components/sections/WhyChooseUsSection.md +54 -0
package/docs/components/ui/Breadcrumb.md +70 -0
package/docs/components/ui/Button.md +514 -0
package/docs/components/ui/Card.md +501 -0
package/docs/components/ui/Input.md +54 -0
package/docs/components/ui/MobileLinks.md +43 -0
package/docs/components/ui/Modal.md +60 -0
package/docs/components/ui/Tabs.md +62 -0
package/docs/components/ui/Textarea.md +52 -0
package/docs/core-concepts/configuration-driven.md +552 -0
package/docs/core-concepts/overview.md +351 -0
package/docs/features/accessibility/README.md +73 -0
package/docs/features/accessibility/aria-support.md +177 -0
package/docs/features/accessibility/color-contrast.md +155 -0
package/docs/features/accessibility/focus-management.md +187 -0
package/docs/features/accessibility/testing.md +196 -0
package/docs/features/analytics/README.md +51 -0
package/docs/features/analytics/ab-testing.md +171 -0
package/docs/features/analytics/conversion-tracking.md +207 -0
package/docs/features/analytics/custom-events.md +219 -0
package/docs/features/analytics/privacy.md +198 -0
package/docs/features/analytics/setup.md +114 -0
package/docs/features/analytics/tracking-events.md +224 -0
package/docs/features/i18n/README.md +51 -0
package/docs/features/i18n/best-practices.md +273 -0
package/docs/features/i18n/configuration.md +84 -0
package/docs/features/i18n/formatting.md +133 -0
package/docs/features/i18n/locale-detection.md +122 -0
package/docs/features/i18n/routing.md +99 -0
package/docs/features/i18n/rtl-support.md +191 -0
package/docs/features/i18n/translations.md +129 -0
package/docs/features/internationalization.md +595 -0
package/docs/features/performance/README.md +77 -0
package/docs/features/performance/bundle-size.md +134 -0
package/docs/features/performance/caching.md +131 -0
package/docs/features/performance/code-splitting.md +121 -0
package/docs/features/performance/image-optimization.md +110 -0
package/docs/features/performance/lazy-loading.md +92 -0
package/docs/features/performance/monitoring.md +148 -0
package/docs/features/seo/README.md +51 -0
package/docs/features/seo/best-practices.md +184 -0
package/docs/features/seo/canonical-urls.md +182 -0
package/docs/features/seo/meta-tags.md +126 -0
package/docs/features/seo/open-graph.md +166 -0
package/docs/features/seo/robots-txt.md +146 -0
package/docs/features/seo/sitemaps.md +162 -0
package/docs/features/seo/structured-data.md +166 -0
package/docs/getting-started/installation.md +292 -0
package/docs/getting-started/introduction.md +195 -0
package/docs/getting-started/quick-start.md +460 -0
package/docs/guides/analytics-setup.md +616 -0
package/docs/i18n/CONFIGURATION.md +353 -0
package/docs/i18n/EXAMPLES.md +402 -0
package/docs/i18n/MIGRATION.md +260 -0
package/docs/i18n/SEO.md +392 -0
package/docs/i18n/STATIC-GENERATION-FIX.md +71 -0
package/docs/migration/changelog.md +136 -0
package/docs/migration/overview.md +233 -0
package/docs/recipes/adding-animations.md +475 -0
package/docs/recipes/forms-with-validation.md +393 -0
package/package.json +152 -0

package/docs/i18n/CONFIGURATION.md ADDED Viewed

@@ -0,0 +1,353 @@
+# i18n Configuration Reference
+Complete reference for configuring internationalization in simple-site-framework.
+## I18nConfig Interface
+```typescript
+interface I18nConfig {
+  locales: readonly string[];
+  defaultLocale: string;
+  localePrefix?: LocalePrefix;
+  localeDetection?: boolean;
+  localeNames?: Record<string, string>;
+  localeLabels?: Record<string, string>;
+  rtlLocales?: readonly string[];
+  localeCookie?: LocaleCookieConfig;
+  slugTranslations?: SlugTranslations;
+}
+```
+## Required Fields
+### `locales`
+**Type:** `readonly string[]`
+**Required:** Yes
+Array of supported locale codes (ISO 639-1).
+```typescript
+locales: ['en', 'fr', 'es', 'de', 'ja']
+```
+### `defaultLocale`
+**Type:** `string`
+**Required:** Yes
+Default locale when none is specified. Must be included in `locales` array.
+```typescript
+defaultLocale: 'en'
+```
+## Optional Fields
+### `localePrefix`
+**Type:** `'always' | 'as-needed' | 'never'`
+**Default:** `'as-needed'`
+Controls how locale appears in URLs.
+#### `'always'` Mode
+All routes have locale prefix:
+- `/en/about`
+- `/fr/about`
+- `/` → redirects to `/en/` (or detected language)
+**Use when:**
+- You want explicit language in every URL
+- All languages are equal importance
+- Consistency across all locales matters
+```typescript
+localePrefix: 'always'
+```
+#### `'as-needed'` Mode (Recommended)
+Only non-default locales have prefix:
+- `/about` (default locale, no prefix)
+- `/fr/about` (non-default, with prefix)
+- `/` → stays at `/` (default locale)
+**Use when:**
+- You have a primary market/language
+- You want cleaner URLs for default language
+- Better SEO for primary market
+```typescript
+localePrefix: 'as-needed'
+```
+#### `'never'` Mode
+No locale in URLs, detection via cookie/header only:
+- `/about` (all languages)
+- `/` (all languages)
+**Use when:**
+- Single-language site with optional translations
+- You want simplest possible URLs
+- Not concerned about shareable language-specific links
+```typescript
+localePrefix: 'never'
+```
+### `localeDetection`
+**Type:** `boolean`
+**Default:** `true`
+Enable automatic locale detection from browser `Accept-Language` header.
+```typescript
+localeDetection: true  // Detect from browser
+localeDetection: false // Always use default locale
+```
+When enabled, middleware checks:
+1. Cookie (user's explicit preference)
+2. `Accept-Language` header (browser preference)
+3. Default locale (fallback)
+### `localeNames`
+**Type:** `Record<string, string>`
+**Default:** `{}`
+Full locale names for display in language selector and UI.
+```typescript
+localeNames: {
+  en: 'English',
+  fr: 'Français',
+  es: 'Español',
+  de: 'Deutsch',
+  ja: '日本語',
+  ar: 'العربية',
+}
+```
+**Best practice:** Use native language names (autonyms).
+### `localeLabels`
+**Type:** `Record<string, string>`
+**Default:** `{}`
+Short locale labels for compact display (e.g., language selector button).
+```typescript
+localeLabels: {
+  en: 'EN',
+  fr: 'FR',
+  es: 'ES',
+  de: 'DE',
+  ja: 'JA',
+  ar: 'AR',
+}
+```
+### `rtlLocales`
+**Type:** `readonly string[]`
+**Default:** `[]`
+Locales that use right-to-left text direction.
+```typescript
+rtlLocales: ['ar', 'he', 'fa', 'ur']
+```
+Common RTL languages:
+- `ar` - Arabic
+- `he` - Hebrew
+- `fa` - Persian/Farsi
+- `ur` - Urdu
+- `yi` - Yiddish
+Use with `getTextDirection()` in layout:
+```tsx
+<html lang={locale} dir={getTextDirection(locale)}>
+```
+### `localeCookie`
+**Type:** `LocaleCookieConfig`
+**Default:** See below
+Configuration for locale persistence cookie.
+```typescript
+localeCookie: {
+  name: 'NEXT_LOCALE',        // Cookie name
+  maxAge: 365 * 24 * 60 * 60, // 1 year in seconds
+  sameSite: 'lax',            // 'lax' | 'strict' | 'none'
+}
+```
+**Defaults:**
+- `name`: `'NEXT_LOCALE'`
+- `maxAge`: `31536000` (1 year)
+- `sameSite`: `'lax'`
+### `slugTranslations`
+**Type:** `SlugTranslations`
+**Default:** `{}`
+Custom slug translations for multilingual routes.
+```typescript
+slugTranslations: {
+  en: {
+    '/about': '/a-propos',
+    '/contact': '/nous-contacter',
+    '/pricing': '/tarifs',
+  },
+  fr: {
+    '/a-propos': '/about',
+    '/nous-contacter': '/contact',
+    '/tarifs': '/pricing',
+  },
+}
+```
+**Note:** Framework provides default French/English translations. Custom translations merge with and override defaults.
+## Complete Example
+```typescript
+// src/config/i18n.ts
+import type { I18nConfig } from 'simple-site-framework/lib/i18n';
+export const i18nConfig: I18nConfig = {
+  // Required
+  locales: ['en', 'fr', 'es', 'ar'],
+  defaultLocale: 'en',
+  // Routing
+  localePrefix: 'as-needed',
+  localeDetection: true,
+  // Display
+  localeNames: {
+    en: 'English',
+    fr: 'Français',
+    es: 'Español',
+    ar: 'العربية',
+  },
+  localeLabels: {
+    en: 'EN',
+    fr: 'FR',
+    es: 'ES',
+    ar: 'AR',
+  },
+  // RTL support
+  rtlLocales: ['ar'],
+  // Cookie config
+  localeCookie: {
+    name: 'MY_LOCALE',
+    maxAge: 90 * 24 * 60 * 60, // 90 days
+    sameSite: 'lax',
+  },
+  // Slug translations
+  slugTranslations: {
+    en: {
+      '/products': '/produits',
+      '/services': '/services',
+    },
+    fr: {
+      '/produits': '/products',
+      '/services': '/services',
+    },
+    es: {
+      '/products': '/productos',
+      '/services': '/servicios',
+    },
+  },
+};
+```
+## Helper Functions
+These functions read from your config after initialization:
+### Configuration Access
+- `getI18nConfig()` - Get full config
+- `getLocales()` - Get supported locales array
+- `getDefaultLocale()` - Get default locale
+- `getLocalePrefix()` - Get prefix mode
+- `getLocaleNames()` - Get locale names mapping
+- `getLocaleLabels()` - Get locale labels mapping
+- `getRtlLocales()` - Get RTL locales array
+### Validation
+- `isSupportedLocale(locale)` - Check if locale is supported
+- `validateLocale(locale)` - Alias for isSupportedLocale
+### Display
+- `getLocaleName(locale)` - Get full name for locale
+- `getLocaleLabel(locale)` - Get short label for locale
+- `getLocaleAutonym(locale)` - Get native name (fallback map)
+### Utilities
+- `isRtlLocale(locale)` - Check if locale is RTL
+- `getTextDirection(locale)` - Get 'ltr' or 'rtl'
+- `getAlternateLocales(currentLocale)` - Get all other locales
+- `normalizeLocale(locale)` - Handle variants (en-US → en)
+- `matchLocale(locale)` - Match with variant support
+## Environment-Specific Configs
+You can use different configs per environment:
+```typescript
+// src/config/i18n.ts
+import type { I18nConfig } from 'simple-site-framework/lib/i18n';
+const baseConfig: I18nConfig = {
+  locales: ['en', 'fr'],
+  defaultLocale: 'en',
+  localePrefix: 'as-needed',
+};
+export const i18nConfig: I18nConfig =
+  process.env.NODE_ENV === 'development'
+    ? {
+        ...baseConfig,
+        localeDetection: false, // Disable in dev
+      }
+    : baseConfig;
+```
+## TypeScript Tips
+### Type-Safe Locale Strings
+```typescript
+import { i18nConfig } from './config/i18n';
+type AppLocale = typeof i18nConfig.locales[number];
+// AppLocale = 'en' | 'fr' | 'es' | ...
+function myFunction(locale: AppLocale) {
+  // TypeScript ensures only valid locales
+}
+```
+### Extend Config Type
+```typescript
+interface MyI18nConfig extends I18nConfig {
+  customField: string;
+}
+export const i18nConfig: MyI18nConfig = {
+  locales: ['en', 'fr'],
+  defaultLocale: 'en',
+  customField: 'my-value',
+};
+```
+## See Also
+- [Migration Guide](./MIGRATION.md) - Upgrade from old system
+- [Examples](./EXAMPLES.md) - Usage examples
+- [SEO Guide](./SEO.md) - SEO best practices