@zoiq.io/dev-kit 0.1.0 → 0.1.2

package/README.md

@@ -31,11 +31,11 @@ function App() {
 
 ## ZOIQProvider
 
-| Prop | Type | Description |
-|------|------|-------------|
-| `projectKey` | `string` | **Required.** Project ID or public front-end key used to fetch theme and config. |
-| `apiBaseUrl` | `string` | Optional. Base URL for the project config API. Defaults to `window.location.origin` (same origin). |
-| `fetchProjectConfig` | `(key: string) => Promise<ProjectSettings \| null>` | Optional. Custom fetcher; if provided, `apiBaseUrl` is ignored for config. |
+| Prop                 | Type                                                | Description                                                                                        |
+| -------------------- | --------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| `projectKey`         | `string`                                            | **Required.** Project ID or public front-end key used to fetch theme and config.                   |
+| `apiBaseUrl`         | `string`                                            | Optional. Base URL for the project config API. Defaults to `window.location.origin` (same origin). |
+| `fetchProjectConfig` | `(key: string) => Promise<ProjectSettings \| null>` | Optional. Custom fetcher; if provided, `apiBaseUrl` is ignored for config.                         |
 
 The provider:
 

package/dist/client.d.mts

@@ -0,0 +1,120 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import { P as ProjectSettings } from './types-DaSMeWe9.mjs';
+export { S as SectionFlag, a as SectionFlagsData } from './types-DaSMeWe9.mjs';
+export { Z as ZOIQProvider, u as useZOIQContext, a as useZOIQEntity } from './useZOIQEntity-Cv9WBq8W.mjs';
+
+interface ScrollButtonProps {
+    className?: string;
+    /** Scroll Y threshold above which the button is shown (default 200) */
+    threshold?: number;
+}
+declare const ScrollButton: ({ className, threshold }: ScrollButtonProps) => react_jsx_runtime.JSX.Element;
+
+interface SubtitleProps {
+    children?: React.ReactNode;
+    className?: string;
+}
+declare const Subtitle: ({ children, className }: SubtitleProps) => react_jsx_runtime.JSX.Element;
+
+interface TextProps extends React.HTMLAttributes<HTMLElement> {
+    children?: React.ReactNode;
+    className?: string;
+    as?: 'span' | 'p' | 'div';
+}
+declare const Text: ({ children, className, as: As, ...props }: TextProps) => react_jsx_runtime.JSX.Element;
+
+interface TitleProps {
+    children?: React.ReactNode;
+    className?: string;
+}
+declare const Title: ({ children, className }: TitleProps) => react_jsx_runtime.JSX.Element;
+
+interface ToggleThemeProps {
+    className?: string;
+    /** Callback when user requests theme toggle; host app controls actual theme state */
+    onToggle?: () => void;
+    /** Optional current theme name for rendering (e.g. "light" | "dark") */
+    theme?: string;
+    /** Content to show (e.g. icon). If not provided, shows "Theme" */
+    children?: React.ReactNode;
+}
+declare const ToggleTheme: ({ className, onToggle, theme, children }: ToggleThemeProps) => react_jsx_runtime.JSX.Element;
+
+interface FooterProps {
+    children?: React.ReactNode;
+    className?: string;
+}
+declare const Footer: ({ children, className }: FooterProps) => react_jsx_runtime.JSX.Element;
+
+interface HeaderProps {
+    children?: React.ReactNode;
+    className?: string;
+    /** Optional left slot (e.g. logo, nav) */
+    left?: React.ReactNode;
+    /** Optional right slot (e.g. user menu, theme toggle) */
+    right?: React.ReactNode;
+}
+declare const Header: ({ children, className, left, right }: HeaderProps) => react_jsx_runtime.JSX.Element;
+
+interface PageProps {
+    children?: React.ReactNode;
+    className?: string;
+    /** Optional full-width layout (no horizontal padding) */
+    fullWidth?: boolean;
+}
+declare const Page: ({ children, className, fullWidth }: PageProps) => react_jsx_runtime.JSX.Element;
+
+interface SecondarySidebarItem {
+    label: string;
+    href: string;
+    icon?: React.ReactNode;
+}
+interface SecondarySidebarProps {
+    items: SecondarySidebarItem[];
+    className?: string;
+    /** Optional: return true if item is active (e.g. from pathname) */
+    isActive?: (item: SecondarySidebarItem) => boolean;
+    /** Optional: custom link renderer (e.g. Next.js Link). Default: <a> */
+    renderLink?: (item: SecondarySidebarItem, children: React.ReactNode) => React.ReactNode;
+}
+declare const SecondarySidebar: ({ items, className, isActive, renderLink }: SecondarySidebarProps) => react_jsx_runtime.JSX.Element;
+
+interface SectionProps {
+    children?: React.ReactNode;
+    className?: string;
+}
+declare const Section: ({ children, className }: SectionProps) => react_jsx_runtime.JSX.Element;
+
+/**
+ * Placeholder for toast container. Host app should render Toaster from "sonner" (or similar)
+ * inside the app; ZOIQ does not bundle a toast library.
+ */
+declare const ToastContainer: () => null;
+
+interface UseProjectSettingsResult {
+    data: ProjectSettings | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Returns the full project theme/settings for the current project key.
+ * Must be used within ZOIQProvider. Data is the same that the provider used to apply theme.
+ */
+declare function useProjectSettings(): UseProjectSettingsResult;
+
+interface UseSectionFlagsResult {
+    enabledIds: Set<string>;
+    disabledIds: Set<string>;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Returns which section IDs are enabled or disabled for the current project.
+ * Must be used within ZOIQProvider. Uses the same apiBaseUrl as the provider.
+ */
+declare function useSectionFlags(): UseSectionFlagsResult;
+
+export { Footer, Header, Page, ProjectSettings, ScrollButton, SecondarySidebar, type SecondarySidebarItem, type SecondarySidebarProps, Section, Subtitle, Text, Title, ToastContainer, ToggleTheme, useProjectSettings, useSectionFlags };

package/dist/client.d.ts

@@ -0,0 +1,120 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import { P as ProjectSettings } from './types-DaSMeWe9.js';
+export { S as SectionFlag, a as SectionFlagsData } from './types-DaSMeWe9.js';
+export { Z as ZOIQProvider, u as useZOIQContext, a as useZOIQEntity } from './useZOIQEntity-CfY8Ag40.js';
+
+interface ScrollButtonProps {
+    className?: string;
+    /** Scroll Y threshold above which the button is shown (default 200) */
+    threshold?: number;
+}
+declare const ScrollButton: ({ className, threshold }: ScrollButtonProps) => react_jsx_runtime.JSX.Element;
+
+interface SubtitleProps {
+    children?: React.ReactNode;
+    className?: string;
+}
+declare const Subtitle: ({ children, className }: SubtitleProps) => react_jsx_runtime.JSX.Element;
+
+interface TextProps extends React.HTMLAttributes<HTMLElement> {
+    children?: React.ReactNode;
+    className?: string;
+    as?: 'span' | 'p' | 'div';
+}
+declare const Text: ({ children, className, as: As, ...props }: TextProps) => react_jsx_runtime.JSX.Element;
+
+interface TitleProps {
+    children?: React.ReactNode;
+    className?: string;
+}
+declare const Title: ({ children, className }: TitleProps) => react_jsx_runtime.JSX.Element;
+
+interface ToggleThemeProps {
+    className?: string;
+    /** Callback when user requests theme toggle; host app controls actual theme state */
+    onToggle?: () => void;
+    /** Optional current theme name for rendering (e.g. "light" | "dark") */
+    theme?: string;
+    /** Content to show (e.g. icon). If not provided, shows "Theme" */
+    children?: React.ReactNode;
+}
+declare const ToggleTheme: ({ className, onToggle, theme, children }: ToggleThemeProps) => react_jsx_runtime.JSX.Element;
+
+interface FooterProps {
+    children?: React.ReactNode;
+    className?: string;
+}
+declare const Footer: ({ children, className }: FooterProps) => react_jsx_runtime.JSX.Element;
+
+interface HeaderProps {
+    children?: React.ReactNode;
+    className?: string;
+    /** Optional left slot (e.g. logo, nav) */
+    left?: React.ReactNode;
+    /** Optional right slot (e.g. user menu, theme toggle) */
+    right?: React.ReactNode;
+}
+declare const Header: ({ children, className, left, right }: HeaderProps) => react_jsx_runtime.JSX.Element;
+
+interface PageProps {
+    children?: React.ReactNode;
+    className?: string;
+    /** Optional full-width layout (no horizontal padding) */
+    fullWidth?: boolean;
+}
+declare const Page: ({ children, className, fullWidth }: PageProps) => react_jsx_runtime.JSX.Element;
+
+interface SecondarySidebarItem {
+    label: string;
+    href: string;
+    icon?: React.ReactNode;
+}
+interface SecondarySidebarProps {
+    items: SecondarySidebarItem[];
+    className?: string;
+    /** Optional: return true if item is active (e.g. from pathname) */
+    isActive?: (item: SecondarySidebarItem) => boolean;
+    /** Optional: custom link renderer (e.g. Next.js Link). Default: <a> */
+    renderLink?: (item: SecondarySidebarItem, children: React.ReactNode) => React.ReactNode;
+}
+declare const SecondarySidebar: ({ items, className, isActive, renderLink }: SecondarySidebarProps) => react_jsx_runtime.JSX.Element;
+
+interface SectionProps {
+    children?: React.ReactNode;
+    className?: string;
+}
+declare const Section: ({ children, className }: SectionProps) => react_jsx_runtime.JSX.Element;
+
+/**
+ * Placeholder for toast container. Host app should render Toaster from "sonner" (or similar)
+ * inside the app; ZOIQ does not bundle a toast library.
+ */
+declare const ToastContainer: () => null;
+
+interface UseProjectSettingsResult {
+    data: ProjectSettings | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Returns the full project theme/settings for the current project key.
+ * Must be used within ZOIQProvider. Data is the same that the provider used to apply theme.
+ */
+declare function useProjectSettings(): UseProjectSettingsResult;
+
+interface UseSectionFlagsResult {
+    enabledIds: Set<string>;
+    disabledIds: Set<string>;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+/**
+ * Returns which section IDs are enabled or disabled for the current project.
+ * Must be used within ZOIQProvider. Uses the same apiBaseUrl as the provider.
+ */
+declare function useSectionFlags(): UseSectionFlagsResult;
+
+export { Footer, Header, Page, ProjectSettings, ScrollButton, SecondarySidebar, type SecondarySidebarItem, type SecondarySidebarProps, Section, Subtitle, Text, Title, ToastContainer, ToggleTheme, useProjectSettings, useSectionFlags };