@xosen/site-sdk 0.0.8 → 0.0.9

package/dist/composables/useLivePreview.d.ts

@@ -0,0 +1,54 @@
+import type { Router } from 'vue-router';
+export interface PreviewMessage {
+    type: 'xosen-preview-update';
+    page: {
+        slug: string;
+        locale: string;
+        title?: string;
+        blocks?: any[];
+        meta?: Record<string, any>;
+        layout?: string;
+        /** Page-level context fields (author, featuredImage, excerpt, etc.) */
+        [key: string]: any;
+    };
+}
+/** Check if running inside an iframe (preview mode) */
+export declare function isInPreview(): boolean;
+/**
+ * Install a router guard that blocks all navigation in preview mode.
+ * Call this once during app setup (e.g. in App.vue or router config).
+ */
+export declare function setupPreviewRouter(router: Router): void;
+/**
+ * Listen for live preview messages from the admin UI.
+ * When the admin sends page data via postMessage, this composable
+ * provides reactive access to the preview data.
+ */
+export declare function useLivePreview(): {
+    previewPage: import("vue").Ref<{
+        [x: string]: any;
+        slug: string;
+        locale: string;
+        title?: string | undefined;
+        blocks?: any[] | undefined;
+        meta?: Record<string, any> | undefined;
+        layout?: string | undefined;
+    } | null, {
+        [key: string]: any;
+        slug: string;
+        locale: string;
+        title?: string;
+        blocks?: any[];
+        meta?: Record<string, any>;
+        layout?: string;
+    } | {
+        [x: string]: any;
+        slug: string;
+        locale: string;
+        title?: string | undefined;
+        blocks?: any[] | undefined;
+        meta?: Record<string, any> | undefined;
+        layout?: string | undefined;
+    } | null>;
+    isPreviewMode: import("vue").Ref<boolean, boolean>;
+};

package/dist/composables/useSiteApi.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Fetch data from the Xosen org API (for live data like tariffs, products).
+ * Uses the API base URL from site config.
+ */
+export declare function useSiteApi(): {
+    get: <T>(path: string) => Promise<T>;
+    getTariffs: () => Promise<any[]>;
+    getProducts: () => Promise<any[]>;
+};

package/dist/composables/useSiteConfig.d.ts

@@ -0,0 +1,25 @@
+import type { SiteConfig } from '../types/config.js';
+/**
+ * Access the site configuration injected by the CF Worker.
+ */
+export declare function useSiteConfig(): {
+    config: import("vue").ComputedRef<SiteConfig | null>;
+    components: import("vue").ComputedRef<Record<string, any>>;
+    navigation: import("vue").ComputedRef<import("../index.js").NavItem[]>;
+    locales: import("vue").ComputedRef<string[]>;
+    defaultLocale: import("vue").ComputedRef<string>;
+    branding: import("vue").ComputedRef<{
+        logo?: string;
+        favicon?: string;
+        siteName?: string;
+    }>;
+    footer: import("vue").ComputedRef<{
+        copyright?: string;
+        links?: Array<{
+            text: string;
+            url: string;
+        }>;
+    }>;
+    features: import("vue").ComputedRef<Record<string, boolean | Record<string, any>>>;
+    hasFeature: (key: string) => boolean;
+};

package/dist/composables/useSiteData.d.ts

@@ -0,0 +1,8 @@
+import { type Ref } from 'vue';
+/**
+ * Read preloaded site data from window.__SITE_DATA__ or fetch from API.
+ *
+ * @param key - Key in __SITE_DATA__ object (e.g. 'tariffs', 'contacts:offices')
+ * @param kvKey - KV key suffix for API fallback (e.g. 'tariffs', 'contacts:offices')
+ */
+export declare function useSiteData<T>(key: string, kvKey: string): Ref<T | null>;

package/dist/composables/useSkin.d.ts

@@ -0,0 +1,6 @@
+import type { Skin } from '../types/skin.js';
+/**
+ * Apply skin CSS custom properties to :root.
+ * Reads skin from __SITE_DATA__.skin or accepts explicit skin object.
+ */
+export declare function useSkin(skinOverride?: Skin): void;

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export { useSiteData } from './composables/useSiteData.js';
+export { useSiteConfig } from './composables/useSiteConfig.js';
+export { useSkin } from './composables/useSkin.js';
+export { useSiteApi } from './composables/useSiteApi.js';
+export { useLivePreview, setupPreviewRouter, isInPreview } from './composables/useLivePreview.js';
+export type { PreviewMessage } from './composables/useLivePreview.js';
+export { createSiteWorker } from './worker/index.js';
+export type { WorkerEnv, WorkerConfig, PageData } from './worker/index.js';
+export type { Block, BlockSettings, HeroBlockData, HtmlBlockData, CardsBlockData, ImageTextBlockData, PricingBlockData, PricingPlan, ContactsBlockData, Office, GalleryBlockData, MapBlockData, } from './types/blocks.js';
+export type { SiteConfig, NavItem, PageConfig, SiteData, PageContext } from './types/config.js';
+export { PAGE_CONTEXT_KEY } from './types/config.js';
+export type { Skin } from './types/skin.js';

package/dist/types/blocks.d.ts

@@ -0,0 +1,103 @@
+export interface BlockSettings {
+    id?: string;
+    visible?: boolean;
+    className?: string;
+    spacing?: 'none' | 'sm' | 'md' | 'lg';
+}
+export interface Block<T = any> {
+    type: string;
+    data?: T;
+    /** Alias for data — accepted for convenience */
+    props?: T;
+    settings?: BlockSettings & Record<string, any>;
+}
+export interface HeroBlockData {
+    title: string;
+    subtitle?: string;
+    image?: string;
+    overlay?: boolean;
+    buttons?: Array<{
+        text: string;
+        url: string;
+        variant?: 'primary' | 'outline' | 'white';
+    }>;
+    stats?: Array<{
+        value: string;
+        label: string;
+    }>;
+}
+export interface HtmlBlockData {
+    content: string;
+}
+export interface CardsBlockData {
+    title?: string;
+    subtitle?: string;
+    cards: Array<{
+        title: string;
+        desc: string;
+        icon?: string;
+        image?: string;
+        link?: string;
+    }>;
+}
+export interface ImageTextBlockData {
+    title?: string;
+    content?: string;
+    image?: string;
+    items?: Array<{
+        text: string;
+        icon?: string;
+    }>;
+}
+export interface PricingPlan {
+    id?: string;
+    name: string;
+    description?: string;
+    price: string | number;
+    period?: string;
+    features?: string[];
+    actionUrl?: string;
+    actionText?: string;
+    tariffGroupName?: string;
+}
+export interface PricingBlockData {
+    title?: string;
+    subtitle?: string;
+    plans?: PricingPlan[];
+}
+export interface Office {
+    name: string;
+    address?: string;
+    phone?: string;
+    email?: string;
+    hours?: string;
+    isMain?: boolean;
+}
+export interface ContactsBlockData {
+    title?: string;
+    subtitle?: string;
+    showBankDetails?: boolean;
+    showForm?: boolean;
+    offices?: Office[];
+}
+export interface GalleryBlockData {
+    title?: string;
+    images: Array<{
+        url: string;
+        alt?: string;
+        caption?: string;
+    }>;
+}
+export interface MapBlockData {
+    title?: string;
+    center: {
+        lat: number;
+        lng: number;
+    };
+    zoom?: number;
+    markers?: Array<{
+        lat: number;
+        lng: number;
+        label?: string;
+    }>;
+}

package/dist/types/config.d.ts

@@ -0,0 +1,56 @@
+import type { InjectionKey, Ref } from 'vue';
+import type { Block } from './blocks.js';
+export interface PageContext {
+    title?: string;
+    type?: string;
+    author?: string;
+    featuredImage?: string;
+    excerpt?: string;
+    isGated?: boolean;
+    termIds?: string[];
+    layout?: string;
+    publishedAt?: string;
+}
+export declare const PAGE_CONTEXT_KEY: InjectionKey<Ref<PageContext>>;
+export interface SiteConfig {
+    template: string;
+    version: string;
+    skin: string;
+    autoUpdate?: boolean;
+    branding: {
+        logo?: string;
+        favicon?: string;
+        siteName?: string;
+    };
+    navigation: NavItem[];
+    locales: string[];
+    defaultLocale: string;
+    footer?: {
+        copyright?: string;
+        links?: Array<{
+            text: string;
+            url: string;
+        }>;
+    };
+    features?: Record<string, boolean | Record<string, any>>;
+}
+export interface NavItem {
+    text: string | Record<string, string>;
+    url: string;
+    external?: boolean;
+    children?: NavItem[];
+}
+export interface PageConfig {
+    title: string;
+    blocks: Block[];
+    meta?: {
+        description?: string;
+        ogTitle?: string;
+        ogImage?: string;
+    };
+}
+export interface SiteData {
+    config: SiteConfig;
+    locale: string;
+    [key: string]: any;
+}

package/dist/types/skin.d.ts

@@ -0,0 +1,41 @@
+export interface Skin {
+    name: string;
+    colors: {
+        primary: string;
+        primaryDark?: string;
+        primaryLight?: string;
+        secondary?: string;
+        accent?: string;
+        background: string;
+        backgroundAlt?: string;
+        surface: string;
+        text: string;
+        textLight?: string;
+        border?: string;
+        success?: string;
+        error?: string;
+    };
+    typography: {
+        fontFamily: string;
+        headingFont?: string;
+        baseFontSize?: string;
+    };
+    shape: {
+        borderRadius: string;
+        cardElevation?: number;
+        maxWidth?: string;
+    };
+    components?: {
+        navbar?: {
+            variant?: 'fixed' | 'static';
+            transparent?: boolean;
+        };
+        footer?: {
+            variant?: 'dark' | 'light';
+        };
+        hero?: {
+            variant?: 'fullscreen' | 'compact';
+            overlay?: boolean;
+        };
+    };
+}

package/dist/worker/create-site-worker.d.ts

@@ -0,0 +1,14 @@
+import type { WorkerEnv, WorkerConfig } from './types.js';
+/**
+ * Create a Cloudflare Worker handler for an Xosen site template.
+ *
+ * The worker:
+ * - Serves static assets from ASSETS binding
+ * - Provides /api/content/:key endpoint for KV reads
+ * - Injects preloaded KV data as window.__SITE_DATA__ into HTML pages
+ * - Detects locale from query param or Accept-Language header
+ * - Preloads page-specific data for /p/:slug routes
+ */
+export declare function createSiteWorker(config: WorkerConfig): {
+    fetch: (request: Request, env: WorkerEnv) => Promise<Response>;
+};

package/dist/worker/index.d.ts

@@ -0,0 +1,2 @@
+export { createSiteWorker } from './create-site-worker.js';
+export type { WorkerEnv, WorkerConfig, PageData } from './types.js';

package/dist/worker/types.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Minimal CF Workers type declarations to avoid requiring @cloudflare/workers-types.
+ * These match the Cloudflare Workers runtime API.
+ */
+export interface CfKVNamespace {
+    get(key: string, options?: any): Promise<string | null>;
+    put(key: string, value: string | ArrayBuffer | ReadableStream, options?: any): Promise<void>;
+    delete(key: string): Promise<void>;
+    list(options?: any): Promise<any>;
+}
+export interface CfFetcher {
+    fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+}
+export interface WorkerEnv {
+    SITE_CONTENT: CfKVNamespace;
+    ASSETS: CfFetcher;
+}
+export interface WorkerConfig {
+    /** Default locale for the site */
+    defaultLocale: string;
+    /** Supported locales for Accept-Language detection */
+    supportedLocales?: string[];
+    /** Site name for meta title suffix, e.g. 'SWI' */
+    siteName?: string;
+}
+export interface PageData {
+    title?: string;
+    blocks?: unknown[];
+    html?: string;
+    meta?: {
+        description?: string;
+        ogTitle?: string;
+        ogImage?: string;
+    };
+    type?: string;
+    author?: string;
+    featuredImage?: string;
+    excerpt?: string;
+    termIds?: string[];
+    layout?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xosen/site-sdk",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "Shared Vue components and composables for Xosen site templates",
   "type": "module",
   "main": "./dist/index.js",
@@ -25,14 +25,14 @@
     "src"
   ],
   "scripts": {
-    "build": "vue-tsc --declaration --emitDeclarationOnly --outDir dist && vite build",
+    "build": "vite build && vue-tsc --declaration --emitDeclarationOnly --outDir dist",
     "dev": "vite build --watch",
     "clean": "rm -rf dist"
   },
   "peerDependencies": {
-    "vue": "catalog:",
-    "vue-i18n": "catalog:",
-    "vue-router": "catalog:"
+    "vue": "^3.5.0",
+    "vue-i18n": "^11.0.0",
+    "vue-router": "^5.0.0"
   },
   "devDependencies": {
     "vue": "catalog:",