@reblu/site-blocks 0.29.0 → 0.31.0

package/dist/client.d.cts

@@ -1,9 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import { ReactNode } from 'react';
-import { ShopProductListItem, AcademyModulePublic, AcademyLessonPublic, DataRequestType, DataRequestInput, DataRequestSubmission, WithdrawalRequestInput, WithdrawalRequestSubmission } from '@reblu/site-contracts';
+import { ShopProductListItem, AcademyModulePublic, AcademyLessonPublic, DataRequestType, DataRequestInput, DataRequestSubmission, WithdrawalRequestInput, WithdrawalRequestSubmission, ShopCheckoutCopy, AcademyCourseDetail, AcademyCheckoutRequest, AcademyCheckoutSession, AcademyCheckoutErrorCode } from '@reblu/site-contracts';
 export { DATA_REQUEST_TYPES } from '@reblu/site-contracts';
-import { H as HeadingLevel } from './_heading-BsNbc1wc.cjs';
+import { H as HeadingLevel, C as CheckoutTermsCopy, F as FullInvoiceFieldsLabels } from './full-invoice-fields-DMX0sjPG.cjs';
 
 /**
  * `useCollection` — the headless heart of `@reblu/site-blocks`.
@@ -544,4 +544,106 @@ interface WithdrawalRequestFormProps {
 }
 declare function WithdrawalRequestForm({ getCaptchaToken, submit, endpoint, onInteract, onSubmitted, labels, locale, className, }: WithdrawalRequestFormProps): react_jsx_runtime.JSX.Element;
 
-export { AddToCartButton, type AddToCartButtonLabels, type AddToCartButtonProps, type AddToCartButtonStatus, CartIcon, type CartIconLabels, type CartIconProps, Collection, type CollectionFacet, type CollectionFacetOption, type CollectionFilter, type CollectionLabels, type CollectionProps, CourseSyllabus, type CourseSyllabusLabels, type CourseSyllabusModule, type CourseSyllabusProps, DATA_REQUEST_FIELD_LIMITS, DEFAULT_COURSE_SYLLABUS_LABELS, DEFAULT_DATA_REQUEST_FORM_LABELS, DEFAULT_PRODUCT_CAROUSEL_LABELS, DEFAULT_WITHDRAWAL_REQUEST_FORM_LABELS, DataRequestForm, type DataRequestFormLabels, type DataRequestFormProps, type DataRequestSubmitResult, ProductCarousel, type ProductCarouselCustomCardProps, type ProductCarouselDefaultCardProps, type ProductCarouselLabels, type ProductCarouselProps, ShareButtons, type ShareButtonsLabels, type ShareButtonsProps, type UseCollectionOptions, type UseCollectionResult, WITHDRAWAL_REQUEST_FIELD_LIMITS, WithdrawalRequestForm, type WithdrawalRequestFormLabels, type WithdrawalRequestFormProps, type WithdrawalRequestSubmitResult, useCollection };
+/**
+ * `CourseGuestCheckoutForm` (REB-1264) — drop-in guest checkout of a course
+ * that needs no validation, over `POST /api/site/academy/checkout`: name,
+ * surname, email, the tenant's terms box, the course's consent box
+ * (`AcademyCourseDetail.withdrawalConsent`), the optional full invoice, the
+ * total and the pay notice. On success the buyer goes to Stripe; the account
+ * is created after payment.
+ *
+ * Stateful (client-only — ships from `./client`) but transport-agnostic, like
+ * `WithdrawalRequestForm`: `submit` sends the body; by default it POSTs JSON
+ * to the SITE's own Route Handler (`endpoint`, default `/api/academy/checkout`
+ * — mount `createAcademyCheckoutRoute()` from `@reblu/site-next/route-handlers`
+ * there), which adds the return URLs and the API key.
+ *
+ * When the server answers `ENROLLMENT_REQUEST_REQUIRED` (the course needs a
+ * validation, or is free), the form gives way to `requestForm`, the SITE's
+ * enrollment request form. Render `requestForm` straight away for a course
+ * `courseSellsAsGuest` rejects.
+ *
+ * No enumeration: the form says the same for every email and never mentions
+ * an account (REB-834). The copy is Spanish and neutral; replace any text
+ * with `labels` / `errorMessages`.
+ */
+type CourseGuestCheckoutInput = Omit<AcademyCheckoutRequest, 'successUrl' | 'cancelUrl'> & Partial<Pick<AcademyCheckoutRequest, 'successUrl' | 'cancelUrl'>>;
+type CourseGuestCheckoutResult = {
+    ok: true;
+    data: AcademyCheckoutSession;
+}
+/** `status` is the HTTP status, or `0` when the request never got an answer. */
+ | {
+    ok: false;
+    status: number;
+    code?: string;
+    details?: unknown;
+};
+/** The tenant's checkout copy (`ShopConfig.checkout`): terms box, button, notice and invoice texts. */
+type CourseGuestCheckoutCopy = CheckoutTermsCopy & Partial<Pick<ShopCheckoutCopy, 'continueToPaymentLabel' | 'payNotice' | 'fullInvoiceCheckboxLabel' | 'fullInvoiceHelpText'>>;
+interface CourseGuestCheckoutFormLabels {
+    firstNameLabel: string;
+    lastNameLabel: string;
+    emailLabel: string;
+    /** The total line; receives the formatted price. */
+    total: (formattedTotal: string) => ReactNode;
+    /** Button text when the copy carries none. */
+    submit: string;
+    submitting: string;
+    firstNameRequired: string;
+    lastNameRequired: string;
+    emailInvalid: string;
+    termsRequired: string;
+    consentRequired: string;
+    /** Shown above `requestForm` after `ENROLLMENT_REQUEST_REQUIRED`. `null` hides it. */
+    requestRequiredNotice: ReactNode;
+    genericError: string;
+}
+declare const DEFAULT_COURSE_GUEST_CHECKOUT_FORM_LABELS: CourseGuestCheckoutFormLabels;
+/** Default copy for every `AcademyCheckoutErrorCode`; override any subset with `errorMessages`. */
+declare const DEFAULT_COURSE_GUEST_CHECKOUT_ERROR_MESSAGES: Record<AcademyCheckoutErrorCode, string>;
+interface CourseGuestCheckoutFormProps {
+    /**
+     * The fields of `AcademyCourseDetail` the form reads. `withdrawalConsent` is
+     * REQUIRED (pass `null` when the course has no box): omitting it for a
+     * course that has one would send no version, and the server would refuse
+     * every try with `CONSENT_VERSION_CHANGED`. The contract field is optional
+     * (older APIs), so pass `course.withdrawalConsent ?? null`.
+     */
+    course: Pick<AcademyCourseDetail, 'slug' | 'priceCents'> & {
+        withdrawalConsent: NonNullable<AcademyCourseDetail['withdrawalConsent']> | null;
+    };
+    /** The tenant's checkout copy — pass `ShopConfig.checkout`. */
+    copy: CourseGuestCheckoutCopy;
+    /** The SITE's terms page, used when the tenant set no `termsLinkUrl`. */
+    termsHref: string;
+    /** The SITE's enrollment request form, shown on `ENROLLMENT_REQUEST_REQUIRED`. */
+    requestForm: ReactNode;
+    /** `false` when the tenant issues no invoices: no full-invoice opt-in. @default true */
+    issuesInvoices?: boolean;
+    /** The tenant's simplified-invoice cap in cents (`ShopConfig.simplifiedInvoiceCapCents`). */
+    simplifiedInvoiceCapCents?: number | null;
+    /** Sends the body. Defaults to a JSON POST to `endpoint`. */
+    submit?: (input: CourseGuestCheckoutInput) => Promise<CourseGuestCheckoutResult>;
+    /** The SITE's Route Handler used by the default `submit`. @default '/api/academy/checkout' */
+    endpoint?: string;
+    /** Called with the Stripe URL. @default `window.location.assign(url)` */
+    onRedirect?: (url: string) => void;
+    /** Called with every refusal, e.g. to reload the page on a `*_VERSION_CHANGED`. */
+    onError?: (result: Extract<CourseGuestCheckoutResult, {
+        ok: false;
+    }>) => void;
+    labels?: Partial<CourseGuestCheckoutFormLabels>;
+    errorMessages?: Partial<Record<AcademyCheckoutErrorCode, string>>;
+    invoiceLabels?: Partial<FullInvoiceFieldsLabels>;
+    invoiceCountries?: ReadonlyArray<{
+        code: string;
+        name: string;
+    }>;
+    currencyCode?: string;
+    locale?: string;
+    className?: string;
+}
+declare function CourseGuestCheckoutForm({ course, copy, termsHref, requestForm, issuesInvoices, simplifiedInvoiceCapCents, submit, endpoint, onRedirect, onError, labels, errorMessages, invoiceLabels, invoiceCountries, currencyCode, locale, className, }: CourseGuestCheckoutFormProps): react_jsx_runtime.JSX.Element;
+
+export { AddToCartButton, type AddToCartButtonLabels, type AddToCartButtonProps, type AddToCartButtonStatus, CartIcon, type CartIconLabels, type CartIconProps, Collection, type CollectionFacet, type CollectionFacetOption, type CollectionFilter, type CollectionLabels, type CollectionProps, type CourseGuestCheckoutCopy, CourseGuestCheckoutForm, type CourseGuestCheckoutFormLabels, type CourseGuestCheckoutFormProps, type CourseGuestCheckoutInput, type CourseGuestCheckoutResult, CourseSyllabus, type CourseSyllabusLabels, type CourseSyllabusModule, type CourseSyllabusProps, DATA_REQUEST_FIELD_LIMITS, DEFAULT_COURSE_GUEST_CHECKOUT_ERROR_MESSAGES, DEFAULT_COURSE_GUEST_CHECKOUT_FORM_LABELS, DEFAULT_COURSE_SYLLABUS_LABELS, DEFAULT_DATA_REQUEST_FORM_LABELS, DEFAULT_PRODUCT_CAROUSEL_LABELS, DEFAULT_WITHDRAWAL_REQUEST_FORM_LABELS, DataRequestForm, type DataRequestFormLabels, type DataRequestFormProps, type DataRequestSubmitResult, ProductCarousel, type ProductCarouselCustomCardProps, type ProductCarouselDefaultCardProps, type ProductCarouselLabels, type ProductCarouselProps, ShareButtons, type ShareButtonsLabels, type ShareButtonsProps, type UseCollectionOptions, type UseCollectionResult, WITHDRAWAL_REQUEST_FIELD_LIMITS, WithdrawalRequestForm, type WithdrawalRequestFormLabels, type WithdrawalRequestFormProps, type WithdrawalRequestSubmitResult, useCollection };

package/dist/client.d.ts

@@ -1,9 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import { ReactNode } from 'react';
-import { ShopProductListItem, AcademyModulePublic, AcademyLessonPublic, DataRequestType, DataRequestInput, DataRequestSubmission, WithdrawalRequestInput, WithdrawalRequestSubmission } from '@reblu/site-contracts';
+import { ShopProductListItem, AcademyModulePublic, AcademyLessonPublic, DataRequestType, DataRequestInput, DataRequestSubmission, WithdrawalRequestInput, WithdrawalRequestSubmission, ShopCheckoutCopy, AcademyCourseDetail, AcademyCheckoutRequest, AcademyCheckoutSession, AcademyCheckoutErrorCode } from '@reblu/site-contracts';
 export { DATA_REQUEST_TYPES } from '@reblu/site-contracts';
-import { H as HeadingLevel } from './_heading-BsNbc1wc.js';
+import { H as HeadingLevel, C as CheckoutTermsCopy, F as FullInvoiceFieldsLabels } from './full-invoice-fields-DMX0sjPG.js';
 
 /**
  * `useCollection` — the headless heart of `@reblu/site-blocks`.
@@ -544,4 +544,106 @@ interface WithdrawalRequestFormProps {
 }
 declare function WithdrawalRequestForm({ getCaptchaToken, submit, endpoint, onInteract, onSubmitted, labels, locale, className, }: WithdrawalRequestFormProps): react_jsx_runtime.JSX.Element;
 
-export { AddToCartButton, type AddToCartButtonLabels, type AddToCartButtonProps, type AddToCartButtonStatus, CartIcon, type CartIconLabels, type CartIconProps, Collection, type CollectionFacet, type CollectionFacetOption, type CollectionFilter, type CollectionLabels, type CollectionProps, CourseSyllabus, type CourseSyllabusLabels, type CourseSyllabusModule, type CourseSyllabusProps, DATA_REQUEST_FIELD_LIMITS, DEFAULT_COURSE_SYLLABUS_LABELS, DEFAULT_DATA_REQUEST_FORM_LABELS, DEFAULT_PRODUCT_CAROUSEL_LABELS, DEFAULT_WITHDRAWAL_REQUEST_FORM_LABELS, DataRequestForm, type DataRequestFormLabels, type DataRequestFormProps, type DataRequestSubmitResult, ProductCarousel, type ProductCarouselCustomCardProps, type ProductCarouselDefaultCardProps, type ProductCarouselLabels, type ProductCarouselProps, ShareButtons, type ShareButtonsLabels, type ShareButtonsProps, type UseCollectionOptions, type UseCollectionResult, WITHDRAWAL_REQUEST_FIELD_LIMITS, WithdrawalRequestForm, type WithdrawalRequestFormLabels, type WithdrawalRequestFormProps, type WithdrawalRequestSubmitResult, useCollection };
+/**
+ * `CourseGuestCheckoutForm` (REB-1264) — drop-in guest checkout of a course
+ * that needs no validation, over `POST /api/site/academy/checkout`: name,
+ * surname, email, the tenant's terms box, the course's consent box
+ * (`AcademyCourseDetail.withdrawalConsent`), the optional full invoice, the
+ * total and the pay notice. On success the buyer goes to Stripe; the account
+ * is created after payment.
+ *
+ * Stateful (client-only — ships from `./client`) but transport-agnostic, like
+ * `WithdrawalRequestForm`: `submit` sends the body; by default it POSTs JSON
+ * to the SITE's own Route Handler (`endpoint`, default `/api/academy/checkout`
+ * — mount `createAcademyCheckoutRoute()` from `@reblu/site-next/route-handlers`
+ * there), which adds the return URLs and the API key.
+ *
+ * When the server answers `ENROLLMENT_REQUEST_REQUIRED` (the course needs a
+ * validation, or is free), the form gives way to `requestForm`, the SITE's
+ * enrollment request form. Render `requestForm` straight away for a course
+ * `courseSellsAsGuest` rejects.
+ *
+ * No enumeration: the form says the same for every email and never mentions
+ * an account (REB-834). The copy is Spanish and neutral; replace any text
+ * with `labels` / `errorMessages`.
+ */
+type CourseGuestCheckoutInput = Omit<AcademyCheckoutRequest, 'successUrl' | 'cancelUrl'> & Partial<Pick<AcademyCheckoutRequest, 'successUrl' | 'cancelUrl'>>;
+type CourseGuestCheckoutResult = {
+    ok: true;
+    data: AcademyCheckoutSession;
+}
+/** `status` is the HTTP status, or `0` when the request never got an answer. */
+ | {
+    ok: false;
+    status: number;
+    code?: string;
+    details?: unknown;
+};
+/** The tenant's checkout copy (`ShopConfig.checkout`): terms box, button, notice and invoice texts. */
+type CourseGuestCheckoutCopy = CheckoutTermsCopy & Partial<Pick<ShopCheckoutCopy, 'continueToPaymentLabel' | 'payNotice' | 'fullInvoiceCheckboxLabel' | 'fullInvoiceHelpText'>>;
+interface CourseGuestCheckoutFormLabels {
+    firstNameLabel: string;
+    lastNameLabel: string;
+    emailLabel: string;
+    /** The total line; receives the formatted price. */
+    total: (formattedTotal: string) => ReactNode;
+    /** Button text when the copy carries none. */
+    submit: string;
+    submitting: string;
+    firstNameRequired: string;
+    lastNameRequired: string;
+    emailInvalid: string;
+    termsRequired: string;
+    consentRequired: string;
+    /** Shown above `requestForm` after `ENROLLMENT_REQUEST_REQUIRED`. `null` hides it. */
+    requestRequiredNotice: ReactNode;
+    genericError: string;
+}
+declare const DEFAULT_COURSE_GUEST_CHECKOUT_FORM_LABELS: CourseGuestCheckoutFormLabels;
+/** Default copy for every `AcademyCheckoutErrorCode`; override any subset with `errorMessages`. */
+declare const DEFAULT_COURSE_GUEST_CHECKOUT_ERROR_MESSAGES: Record<AcademyCheckoutErrorCode, string>;
+interface CourseGuestCheckoutFormProps {
+    /**
+     * The fields of `AcademyCourseDetail` the form reads. `withdrawalConsent` is
+     * REQUIRED (pass `null` when the course has no box): omitting it for a
+     * course that has one would send no version, and the server would refuse
+     * every try with `CONSENT_VERSION_CHANGED`. The contract field is optional
+     * (older APIs), so pass `course.withdrawalConsent ?? null`.
+     */
+    course: Pick<AcademyCourseDetail, 'slug' | 'priceCents'> & {
+        withdrawalConsent: NonNullable<AcademyCourseDetail['withdrawalConsent']> | null;
+    };
+    /** The tenant's checkout copy — pass `ShopConfig.checkout`. */
+    copy: CourseGuestCheckoutCopy;
+    /** The SITE's terms page, used when the tenant set no `termsLinkUrl`. */
+    termsHref: string;
+    /** The SITE's enrollment request form, shown on `ENROLLMENT_REQUEST_REQUIRED`. */
+    requestForm: ReactNode;
+    /** `false` when the tenant issues no invoices: no full-invoice opt-in. @default true */
+    issuesInvoices?: boolean;
+    /** The tenant's simplified-invoice cap in cents (`ShopConfig.simplifiedInvoiceCapCents`). */
+    simplifiedInvoiceCapCents?: number | null;
+    /** Sends the body. Defaults to a JSON POST to `endpoint`. */
+    submit?: (input: CourseGuestCheckoutInput) => Promise<CourseGuestCheckoutResult>;
+    /** The SITE's Route Handler used by the default `submit`. @default '/api/academy/checkout' */
+    endpoint?: string;
+    /** Called with the Stripe URL. @default `window.location.assign(url)` */
+    onRedirect?: (url: string) => void;
+    /** Called with every refusal, e.g. to reload the page on a `*_VERSION_CHANGED`. */
+    onError?: (result: Extract<CourseGuestCheckoutResult, {
+        ok: false;
+    }>) => void;
+    labels?: Partial<CourseGuestCheckoutFormLabels>;
+    errorMessages?: Partial<Record<AcademyCheckoutErrorCode, string>>;
+    invoiceLabels?: Partial<FullInvoiceFieldsLabels>;
+    invoiceCountries?: ReadonlyArray<{
+        code: string;
+        name: string;
+    }>;
+    currencyCode?: string;
+    locale?: string;
+    className?: string;
+}
+declare function CourseGuestCheckoutForm({ course, copy, termsHref, requestForm, issuesInvoices, simplifiedInvoiceCapCents, submit, endpoint, onRedirect, onError, labels, errorMessages, invoiceLabels, invoiceCountries, currencyCode, locale, className, }: CourseGuestCheckoutFormProps): react_jsx_runtime.JSX.Element;
+
+export { AddToCartButton, type AddToCartButtonLabels, type AddToCartButtonProps, type AddToCartButtonStatus, CartIcon, type CartIconLabels, type CartIconProps, Collection, type CollectionFacet, type CollectionFacetOption, type CollectionFilter, type CollectionLabels, type CollectionProps, type CourseGuestCheckoutCopy, CourseGuestCheckoutForm, type CourseGuestCheckoutFormLabels, type CourseGuestCheckoutFormProps, type CourseGuestCheckoutInput, type CourseGuestCheckoutResult, CourseSyllabus, type CourseSyllabusLabels, type CourseSyllabusModule, type CourseSyllabusProps, DATA_REQUEST_FIELD_LIMITS, DEFAULT_COURSE_GUEST_CHECKOUT_ERROR_MESSAGES, DEFAULT_COURSE_GUEST_CHECKOUT_FORM_LABELS, DEFAULT_COURSE_SYLLABUS_LABELS, DEFAULT_DATA_REQUEST_FORM_LABELS, DEFAULT_PRODUCT_CAROUSEL_LABELS, DEFAULT_WITHDRAWAL_REQUEST_FORM_LABELS, DataRequestForm, type DataRequestFormLabels, type DataRequestFormProps, type DataRequestSubmitResult, ProductCarousel, type ProductCarouselCustomCardProps, type ProductCarouselDefaultCardProps, type ProductCarouselLabels, type ProductCarouselProps, ShareButtons, type ShareButtonsLabels, type ShareButtonsProps, type UseCollectionOptions, type UseCollectionResult, WITHDRAWAL_REQUEST_FIELD_LIMITS, WithdrawalRequestForm, type WithdrawalRequestFormLabels, type WithdrawalRequestFormProps, type WithdrawalRequestSubmitResult, useCollection };