@burdenoff/website-sdk 0.0.0-dev

package/dist/components/contact.d.mts

@@ -0,0 +1,144 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+/**
+ * Contact Page Component
+ * Complete contact page with form submission via GraphQL, reCAPTCHA validation,
+ * contact information display, and additional contact options.
+ * Uses the WebSDKClient provider for API calls.
+ *
+ * @example
+ * ```tsx
+ * import { ContactPage } from '@burdenoff/website-sdk/components/contact'
+ *
+ * <ContactPage
+ *   productName="MyProduct"
+ *   recaptchaSiteKey="your-recaptcha-key"
+ *   contactEmail="contact@myproduct.com"
+ *   contactPhone="+1-234-567-8900"
+ *   officeAddress={{
+ *     line1: "123 Main St",
+ *     line2: "Suite 100",
+ *     line3: "City, State 12345",
+ *     country: "USA"
+ *   }}
+ * />
+ * ```
+ */
+interface OfficeAddress {
+    line1: string;
+    line2: string;
+    line3: string;
+    country: string;
+}
+interface ContactOption {
+    title: string;
+    description: string;
+    buttonText: string;
+    buttonLink: string;
+}
+/**
+ * One entry in the contact-form Category dropdown. Each product website
+ * supplies its own allow-list via the `categories` prop so the
+ * vocabulary stays product-appropriate (e.g. VibeControls uses
+ * `plugin-developer`, a manufacturing site uses `dealer`). The backend
+ * accepts whatever `value` string is sent and persists it directly.
+ *
+ * `value` flows to the backend; `label` is what the user sees.
+ */
+interface ContactCategory {
+    /** Stored on the server. Short, kebab-case is conventional. */
+    value: string;
+    /** Human-readable label shown in the dropdown. */
+    label: string;
+}
+/**
+ * Conservative starter category list — Burdenoff-generic vocabulary
+ * (General / Sales / Support / Partnership / Press / Careers / Security).
+ *
+ * **Not** applied by default: pass it explicitly to opt in:
+ *
+ * ```tsx
+ * <ContactPage
+ *   …
+ *   categories={DEFAULT_CONTACT_CATEGORIES}
+ * />
+ * ```
+ *
+ * The component default for `categories` is `[]` (no dropdown) so this
+ * SDK release is backward-compatible with existing consumers that
+ * don't yet know about the field — see the prop docs.
+ */
+declare const DEFAULT_CONTACT_CATEGORIES: ContactCategory[];
+interface ContactPageProps {
+    /** Product name. Falls back to SDK config productId if not provided. */
+    productName?: string;
+    /** reCAPTCHA site key (optional, falls back to SDK config) */
+    recaptchaSiteKey?: string;
+    /** Contact email */
+    contactEmail: string;
+    /** Contact phone number */
+    contactPhone: string;
+    /** Office address */
+    officeAddress: OfficeAddress;
+    /** Response time message */
+    responseTime?: string;
+    /** Hero title */
+    heroTitle?: string;
+    /** Hero description */
+    heroDescription?: string;
+    /**
+     * Heading level for the hero title. Defaults to `1` (a full page hero,
+     * `<h1>`). Pass `2` when embedding ContactPage inside another page that
+     * already owns the page `<h1>` (e.g. `PartnersPage`) — renders a compact
+     * `<h2>` section header instead of a competing hero, keeping one `<h1>`
+     * per page for SEO and a clean visual hierarchy.
+     */
+    headingLevel?: 1 | 2;
+    /** Additional contact options */
+    additionalOptions?: ContactOption[];
+    /**
+     * Inquiry-type dropdown allow-list. **Defaults to `[]`** — the
+     * dropdown does not render unless the consumer explicitly opts in.
+     *
+     * Two ways to opt in:
+     *
+     * ```tsx
+     * // 1. Provide a product-specific list
+     * <ContactPage categories={[{ value: 'sales', label: 'Sales' }, …]} />
+     *
+     * // 2. Or use the conservative SDK starter list
+     * <ContactPage categories={DEFAULT_CONTACT_CATEGORIES} />
+     * ```
+     *
+     * Default is intentionally empty (not `DEFAULT_CONTACT_CATEGORIES`)
+     * to keep this SDK release backward-compatible with existing
+     * consumers that don't yet wire `categories` — they get zero
+     * behavior change.
+     *
+     * Typed `readonly` because the component never mutates the array;
+     * lets product sites pass an `as const`-frozen config without an
+     * extra `[...spread]` at the call site.
+     */
+    categories?: readonly ContactCategory[];
+    /** Label shown above the category dropdown. */
+    categoryLabel?: string;
+    /** Placeholder text for the unselected state of the dropdown. */
+    categoryPlaceholder?: string;
+    /**
+     * Whether selecting a category is required to submit. Defaults to
+     * `true` — the whole point of the dropdown is routing, so users
+     * self-triage instead of pushing that work onto support.
+     */
+    categoryRequired?: boolean;
+    /** SEO metadata */
+    seo?: {
+        title?: string;
+        description?: string;
+        keywords?: string;
+        image?: string;
+        url?: string;
+    };
+}
+declare function ContactPage({ productName, recaptchaSiteKey, contactEmail, contactPhone, officeAddress, responseTime, heroTitle, heroDescription, headingLevel, categories, categoryLabel, categoryPlaceholder, categoryRequired, additionalOptions, seo, }: ContactPageProps): react_jsx_runtime.JSX.Element;
+
+export { type ContactCategory, ContactPage, type ContactPageProps, DEFAULT_CONTACT_CATEGORIES };

package/dist/components/contact.d.ts

@@ -0,0 +1,144 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+/**
+ * Contact Page Component
+ * Complete contact page with form submission via GraphQL, reCAPTCHA validation,
+ * contact information display, and additional contact options.
+ * Uses the WebSDKClient provider for API calls.
+ *
+ * @example
+ * ```tsx
+ * import { ContactPage } from '@burdenoff/website-sdk/components/contact'
+ *
+ * <ContactPage
+ *   productName="MyProduct"
+ *   recaptchaSiteKey="your-recaptcha-key"
+ *   contactEmail="contact@myproduct.com"
+ *   contactPhone="+1-234-567-8900"
+ *   officeAddress={{
+ *     line1: "123 Main St",
+ *     line2: "Suite 100",
+ *     line3: "City, State 12345",
+ *     country: "USA"
+ *   }}
+ * />
+ * ```
+ */
+interface OfficeAddress {
+    line1: string;
+    line2: string;
+    line3: string;
+    country: string;
+}
+interface ContactOption {
+    title: string;
+    description: string;
+    buttonText: string;
+    buttonLink: string;
+}
+/**
+ * One entry in the contact-form Category dropdown. Each product website
+ * supplies its own allow-list via the `categories` prop so the
+ * vocabulary stays product-appropriate (e.g. VibeControls uses
+ * `plugin-developer`, a manufacturing site uses `dealer`). The backend
+ * accepts whatever `value` string is sent and persists it directly.
+ *
+ * `value` flows to the backend; `label` is what the user sees.
+ */
+interface ContactCategory {
+    /** Stored on the server. Short, kebab-case is conventional. */
+    value: string;
+    /** Human-readable label shown in the dropdown. */
+    label: string;
+}
+/**
+ * Conservative starter category list — Burdenoff-generic vocabulary
+ * (General / Sales / Support / Partnership / Press / Careers / Security).
+ *
+ * **Not** applied by default: pass it explicitly to opt in:
+ *
+ * ```tsx
+ * <ContactPage
+ *   …
+ *   categories={DEFAULT_CONTACT_CATEGORIES}
+ * />
+ * ```
+ *
+ * The component default for `categories` is `[]` (no dropdown) so this
+ * SDK release is backward-compatible with existing consumers that
+ * don't yet know about the field — see the prop docs.
+ */
+declare const DEFAULT_CONTACT_CATEGORIES: ContactCategory[];
+interface ContactPageProps {
+    /** Product name. Falls back to SDK config productId if not provided. */
+    productName?: string;
+    /** reCAPTCHA site key (optional, falls back to SDK config) */
+    recaptchaSiteKey?: string;
+    /** Contact email */
+    contactEmail: string;
+    /** Contact phone number */
+    contactPhone: string;
+    /** Office address */
+    officeAddress: OfficeAddress;
+    /** Response time message */
+    responseTime?: string;
+    /** Hero title */
+    heroTitle?: string;
+    /** Hero description */
+    heroDescription?: string;
+    /**
+     * Heading level for the hero title. Defaults to `1` (a full page hero,
+     * `<h1>`). Pass `2` when embedding ContactPage inside another page that
+     * already owns the page `<h1>` (e.g. `PartnersPage`) — renders a compact
+     * `<h2>` section header instead of a competing hero, keeping one `<h1>`
+     * per page for SEO and a clean visual hierarchy.
+     */
+    headingLevel?: 1 | 2;
+    /** Additional contact options */
+    additionalOptions?: ContactOption[];
+    /**
+     * Inquiry-type dropdown allow-list. **Defaults to `[]`** — the
+     * dropdown does not render unless the consumer explicitly opts in.
+     *
+     * Two ways to opt in:
+     *
+     * ```tsx
+     * // 1. Provide a product-specific list
+     * <ContactPage categories={[{ value: 'sales', label: 'Sales' }, …]} />
+     *
+     * // 2. Or use the conservative SDK starter list
+     * <ContactPage categories={DEFAULT_CONTACT_CATEGORIES} />
+     * ```
+     *
+     * Default is intentionally empty (not `DEFAULT_CONTACT_CATEGORIES`)
+     * to keep this SDK release backward-compatible with existing
+     * consumers that don't yet wire `categories` — they get zero
+     * behavior change.
+     *
+     * Typed `readonly` because the component never mutates the array;
+     * lets product sites pass an `as const`-frozen config without an
+     * extra `[...spread]` at the call site.
+     */
+    categories?: readonly ContactCategory[];
+    /** Label shown above the category dropdown. */
+    categoryLabel?: string;
+    /** Placeholder text for the unselected state of the dropdown. */
+    categoryPlaceholder?: string;
+    /**
+     * Whether selecting a category is required to submit. Defaults to
+     * `true` — the whole point of the dropdown is routing, so users
+     * self-triage instead of pushing that work onto support.
+     */
+    categoryRequired?: boolean;
+    /** SEO metadata */
+    seo?: {
+        title?: string;
+        description?: string;
+        keywords?: string;
+        image?: string;
+        url?: string;
+    };
+}
+declare function ContactPage({ productName, recaptchaSiteKey, contactEmail, contactPhone, officeAddress, responseTime, heroTitle, heroDescription, headingLevel, categories, categoryLabel, categoryPlaceholder, categoryRequired, additionalOptions, seo, }: ContactPageProps): react_jsx_runtime.JSX.Element;
+
+export { type ContactCategory, ContactPage, type ContactPageProps, DEFAULT_CONTACT_CATEGORIES };