specra 0.1.13 → 0.2.0

package/dist/mdx-ColN3Cyg.d.ts

@@ -1,352 +0,0 @@
-/**
- * Configuration schema for Specra documentation system
- */
-/**
- * Site metadata and branding
- */
-interface SiteConfig {
-    /** The title of the documentation site */
-    title: string;
-    /** Short description of the documentation */
-    description?: string;
-    /** URL where the documentation is hosted */
-    url?: string;
-    /** Base URL path for the documentation (e.g., '/docs') */
-    baseUrl?: string;
-    /** Path to the site logo - can be a string or an object with light/dark variants */
-    logo?: string | {
-        light: string;
-        dark: string;
-    };
-    /** Path to the favicon */
-    favicon?: string;
-    /** Default language for the documentation */
-    language?: string;
-    /** Organization or author name */
-    organizationName?: string;
-    /** Project name */
-    projectName?: string;
-    /** Active/default version for the documentation */
-    activeVersion?: string;
-    /** Whether to hide the site title in the header */
-    hideTitle?: boolean;
-    /** Whether to hide the site logo in the header */
-    hideLogo?: boolean;
-}
-/**
- * Theme and appearance settings
- */
-interface ThemeConfig {
-    /** Primary color for the theme */
-    primaryColor?: string;
-    /** Default theme mode */
-    defaultMode?: "light" | "dark" | "system";
-    /** Whether to respect system preferences */
-    respectPrefersColorScheme?: boolean;
-    /** Custom CSS file path */
-    customCss?: string;
-}
-/**
- * Tab group for organizing documentation
- */
-interface TabGroup {
-    /** Unique identifier for the tab group */
-    id: string;
-    /** Display label for the tab */
-    label: string;
-    /** Optional icon name (lucide-react icon) */
-    icon?: string;
-}
-/**
- * Navigation and sidebar configuration
- */
-interface NavigationConfig {
-    /** Whether to show the sidebar by default */
-    showSidebar?: boolean;
-    /** Whether the sidebar is collapsible */
-    collapsibleSidebar?: boolean;
-    /** Whether to show breadcrumbs */
-    showBreadcrumbs?: boolean;
-    /** Whether to show table of contents */
-    showTableOfContents?: boolean;
-    /** Position of table of contents */
-    tocPosition?: "left" | "right";
-    /** Maximum depth for table of contents */
-    tocMaxDepth?: number;
-    /** Tab groups for organizing documentation sections */
-    tabGroups?: TabGroup[];
-}
-/**
- * Social and external links
- */
-interface SocialLinks {
-    /** GitHub repository URL */
-    github?: string;
-    /** Twitter/X handle or URL */
-    twitter?: string;
-    /** Discord invite URL */
-    discord?: string;
-    /** LinkedIn profile or company page */
-    linkedin?: string;
-    /** YouTube channel URL */
-    youtube?: string;
-    /** Custom social links */
-    custom?: Array<{
-        label: string;
-        url: string;
-        icon?: string;
-    }>;
-}
-/**
- * Search configuration
- */
-interface SearchConfig {
-    /** Enable/disable search functionality */
-    enabled?: boolean;
-    /** Placeholder text for search input */
-    placeholder?: string;
-    /** Search provider type */
-    provider?: "meilisearch" | "algolia" | "local";
-    /** Meilisearch configuration */
-    meilisearch?: {
-        /** Meilisearch server URL */
-        host: string;
-        /** API key for Meilisearch */
-        apiKey?: string;
-        /** Index name */
-        indexName: string;
-    };
-}
-/**
- * Analytics configuration
- */
-interface AnalyticsConfig {
-    /** Google Analytics tracking ID */
-    googleAnalytics?: string;
-    /** Google Tag Manager ID */
-    googleTagManager?: string;
-    /** Plausible Analytics domain */
-    plausible?: string;
-    /** Custom analytics scripts */
-    custom?: Array<{
-        src: string;
-        async?: boolean;
-        defer?: boolean;
-    }>;
-}
-/**
- * Footer branding configuration
- */
-interface FooterBranding {
-    /** Whether to show the branding */
-    showBranding?: boolean;
-    /** Logo for the branding - can be a string or an object with light/dark variants */
-    logo?: string | {
-        light: string;
-        dark: string;
-    };
-    /** Title text for the branding */
-    title?: string;
-    /** URL to link to when branding is clicked */
-    url?: string;
-}
-/**
- * Footer configuration
- */
-interface FooterConfig {
-    /** Copyright text */
-    copyright?: string;
-    /** Footer links organized by columns */
-    links?: Array<{
-        title: string;
-        items: Array<{
-            label: string;
-            href: string;
-        }>;
-    }>;
-    /** Custom footer content */
-    customContent?: string;
-    /** Branding configuration for "Powered by" section */
-    branding?: FooterBranding;
-}
-/**
- * Documentation features
- */
-interface FeaturesConfig {
-    /**
-     * Enable/disable edit this page links.
-     * Provide a URL template (e.g., "https://github.com/user/repo/edit/main/docs") or false to disable
-     */
-    editUrl?: string | boolean;
-    /** Show last updated timestamp */
-    showLastUpdated?: boolean;
-    /** Show reading time estimate */
-    showReadingTime?: boolean;
-    /** Show author information */
-    showAuthors?: boolean;
-    /** Show tags */
-    showTags?: boolean;
-    /** Enable version dropdown */
-    versioning?: boolean;
-    /**
-     * Internationalization (i18n) configuration
-     * Set to true to enable with defaults, or provide configuration object
-     */
-    i18n?: boolean | I18nConfig;
-}
-/**
- * Internationalization configuration
- */
-interface I18nConfig {
-    /** The default locale (e.g. 'en') - used when no locale is present in URL */
-    defaultLocale: string;
-    /** List of supported locales (e.g. ['en', 'fr', 'es']) */
-    locales: string[];
-    /** Map of locale codes to display names (e.g. { en: "English", fr: "Français" }) */
-    localeNames?: Record<string, string>;
-    /** Whether to use locale subpaths for default locale (default: false) */
-    prefixDefault?: boolean;
-}
-/**
- * Site-wide banner configuration
- */
-interface BannerConfig {
-    /** Whether the banner is enabled */
-    enabled?: boolean;
-    /** Banner message */
-    message?: string;
-    /** Banner type */
-    type?: "info" | "warning" | "success" | "error";
-    /** Whether the banner can be dismissed */
-    dismissible?: boolean;
-}
-/**
- * Environment variables that can be used in documentation
- * These will be replaced at build time or runtime
- */
-interface EnvironmentVariables {
-    /** API base URL */
-    API_BASE_URL?: string;
-    /** API version */
-    API_VERSION?: string;
-    /** CDN URL */
-    CDN_URL?: string;
-    /** Custom environment variables */
-    [key: string]: string | undefined;
-}
-/**
- * Deployment configuration for different hosting scenarios
- */
-interface DeploymentConfig {
-    /**
-     * Deployment target
-     * - 'vercel': For Vercel or similar Node.js hosting (uses 'standalone' output)
-     * - 'github-pages': For GitHub Pages static hosting (uses 'export' output)
-     * - 'static': For any static hosting like Netlify, Cloudflare Pages, etc.
-     * - 'custom-domain-static': For static hosting with custom domain (no basePath needed)
-     */
-    target?: "vercel" | "github-pages" | "static" | "custom-domain-static";
-    /**
-     * Base path for assets when deploying to GitHub Pages without custom domain
-     * This should be your repository name (e.g., 'my-repo')
-     * Only used when target is 'github-pages' and no custom domain is configured
-     */
-    basePath?: string;
-    /**
-     * Whether a custom domain is configured
-     * When true, basePath will be ignored even for GitHub Pages
-     */
-    customDomain?: boolean;
-}
-/**
- * Main configuration interface
- */
-interface SpecraConfig {
-    /** JSON Schema reference (for IDE support) */
-    $schema?: string;
-    /** Site metadata and branding */
-    site: SiteConfig;
-    /** Theme and appearance settings */
-    theme?: ThemeConfig;
-    /** Navigation and sidebar configuration */
-    navigation?: NavigationConfig;
-    /** Social and external links */
-    social?: SocialLinks;
-    /** Search configuration */
-    search?: SearchConfig;
-    /** Analytics configuration */
-    analytics?: AnalyticsConfig;
-    /** Footer configuration */
-    footer?: FooterConfig;
-    /** Site-wide banner */
-    banner?: BannerConfig;
-    /** Documentation features */
-    features?: FeaturesConfig;
-    /** Environment variables for use in docs */
-    env?: EnvironmentVariables;
-    /** Deployment configuration */
-    deployment?: DeploymentConfig;
-}
-/**
- * Default configuration values
- */
-declare const defaultConfig: SpecraConfig;
-
-interface DocMeta {
-    title: string;
-    description?: string;
-    slug?: string;
-    section?: string;
-    group?: string;
-    sidebar?: string;
-    order?: number;
-    sidebar_position?: number;
-    content?: string;
-    last_updated?: string;
-    draft?: boolean;
-    authors?: Array<{
-        id: string;
-        name?: string;
-    }>;
-    tags?: string[];
-    redirect_from?: string[];
-    reading_time?: number;
-    word_count?: number;
-    icon?: string;
-    tab_group?: string;
-    locale?: string;
-}
-interface Doc {
-    slug: string;
-    filePath: string;
-    title: string;
-    meta: DocMeta;
-    content: string;
-    categoryLabel?: string;
-    categoryPosition?: number;
-    categoryCollapsible?: boolean;
-    categoryCollapsed?: boolean;
-    categoryIcon?: string;
-    categoryTabGroup?: string;
-    locale?: string;
-}
-interface TocItem {
-    id: string;
-    title: string;
-    level: number;
-}
-declare function getVersions(): string[];
-declare function getI18nConfig(): I18nConfig | null;
-declare function getDocBySlug(slug: string, version?: string, locale?: string): Promise<Doc | null>;
-declare function getAllDocs(version?: string, locale?: string): Promise<Doc[]>;
-declare function getAdjacentDocs(currentSlug: string, allDocs: Doc[]): {
-    previous?: Doc;
-    next?: Doc;
-};
-declare function extractTableOfContents(content: string): TocItem[];
-/**
- * Check if a slug represents a category (has child documents)
- */
-declare function isCategoryPage(slug: string, allDocs: Doc[]): boolean;
-
-export { type AnalyticsConfig as A, type BannerConfig as B, type DocMeta as D, type EnvironmentVariables as E, type FooterBranding as F, type I18nConfig as I, type NavigationConfig as N, type SpecraConfig as S, type TocItem as T, type Doc as a, getI18nConfig as b, getDocBySlug as c, getAllDocs as d, getAdjacentDocs as e, extractTableOfContents as f, getVersions as g, defaultConfig as h, isCategoryPage as i, type SiteConfig as j, type ThemeConfig as k, type TabGroup as l, type SocialLinks as m, type SearchConfig as n, type FooterConfig as o, type FeaturesConfig as p, type DeploymentConfig as q };

package/dist/mdx-components.d.mts

@@ -1,86 +0,0 @@
-import { MDXComponents } from 'mdx/types';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as react from 'react';
-import { CodeBlock, Callout, Accordion, AccordionItem, Tabs, Tab, Image, Video, Card, CardGrid, ImageCard, ImageCardGrid, Steps, Step, Icon, Mermaid, Math, Columns, Column, Badge, Tooltip, Frame, ApiEndpoint, ApiParams, ApiResponse, ApiPlayground, ApiReference } from './components/index';
-
-declare const mdxComponents: {
-    CodeBlock: typeof CodeBlock;
-    Callout: typeof Callout;
-    Accordion: typeof Accordion;
-    AccordionItem: typeof AccordionItem;
-    Tabs: typeof Tabs;
-    Tab: typeof Tab;
-    Image: typeof Image;
-    Video: typeof Video;
-    Card: typeof Card;
-    CardGrid: typeof CardGrid;
-    ImageCard: typeof ImageCard;
-    ImageCardGrid: typeof ImageCardGrid;
-    Steps: typeof Steps;
-    Step: typeof Step;
-    Icon: typeof Icon;
-    Mermaid: typeof Mermaid;
-    Math: typeof Math;
-    Columns: typeof Columns;
-    Column: typeof Column;
-    Badge: typeof Badge;
-    Tooltip: typeof Tooltip;
-    Frame: typeof Frame;
-    ApiEndpoint: typeof ApiEndpoint;
-    ApiParams: typeof ApiParams;
-    ApiResponse: typeof ApiResponse;
-    ApiPlayground: typeof ApiPlayground;
-    ApiReference: typeof ApiReference;
-    h1: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    h2: ({ children, id }: {
-        children: react.ReactNode;
-        id?: string;
-    }) => react_jsx_runtime.JSX.Element;
-    h3: ({ children, id }: {
-        children: react.ReactNode;
-        id?: string;
-    }) => react_jsx_runtime.JSX.Element;
-    p: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    code: ({ children, className, meta, ...props }: {
-        children: react.ReactNode;
-        className?: string;
-        meta?: string;
-        [key: string]: any;
-    }) => react_jsx_runtime.JSX.Element;
-    pre: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    ul: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    ol: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    li: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    a: ({ children, href }: {
-        children: react.ReactNode;
-        href?: string;
-    }) => react_jsx_runtime.JSX.Element;
-    blockquote: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    table: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    th: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    td: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-};
-
-declare function useMDXComponents(components: MDXComponents): MDXComponents;
-
-export { mdxComponents, useMDXComponents };

package/dist/mdx-components.d.ts

@@ -1,86 +0,0 @@
-import { MDXComponents } from 'mdx/types';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as react from 'react';
-import { CodeBlock, Callout, Accordion, AccordionItem, Tabs, Tab, Image, Video, Card, CardGrid, ImageCard, ImageCardGrid, Steps, Step, Icon, Mermaid, Math, Columns, Column, Badge, Tooltip, Frame, ApiEndpoint, ApiParams, ApiResponse, ApiPlayground, ApiReference } from './components/index';
-
-declare const mdxComponents: {
-    CodeBlock: typeof CodeBlock;
-    Callout: typeof Callout;
-    Accordion: typeof Accordion;
-    AccordionItem: typeof AccordionItem;
-    Tabs: typeof Tabs;
-    Tab: typeof Tab;
-    Image: typeof Image;
-    Video: typeof Video;
-    Card: typeof Card;
-    CardGrid: typeof CardGrid;
-    ImageCard: typeof ImageCard;
-    ImageCardGrid: typeof ImageCardGrid;
-    Steps: typeof Steps;
-    Step: typeof Step;
-    Icon: typeof Icon;
-    Mermaid: typeof Mermaid;
-    Math: typeof Math;
-    Columns: typeof Columns;
-    Column: typeof Column;
-    Badge: typeof Badge;
-    Tooltip: typeof Tooltip;
-    Frame: typeof Frame;
-    ApiEndpoint: typeof ApiEndpoint;
-    ApiParams: typeof ApiParams;
-    ApiResponse: typeof ApiResponse;
-    ApiPlayground: typeof ApiPlayground;
-    ApiReference: typeof ApiReference;
-    h1: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    h2: ({ children, id }: {
-        children: react.ReactNode;
-        id?: string;
-    }) => react_jsx_runtime.JSX.Element;
-    h3: ({ children, id }: {
-        children: react.ReactNode;
-        id?: string;
-    }) => react_jsx_runtime.JSX.Element;
-    p: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    code: ({ children, className, meta, ...props }: {
-        children: react.ReactNode;
-        className?: string;
-        meta?: string;
-        [key: string]: any;
-    }) => react_jsx_runtime.JSX.Element;
-    pre: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    ul: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    ol: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    li: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    a: ({ children, href }: {
-        children: react.ReactNode;
-        href?: string;
-    }) => react_jsx_runtime.JSX.Element;
-    blockquote: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    table: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    th: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-    td: ({ children }: {
-        children: react.ReactNode;
-    }) => react_jsx_runtime.JSX.Element;
-};
-
-declare function useMDXComponents(components: MDXComponents): MDXComponents;
-
-export { mdxComponents, useMDXComponents };