@reblu/site-blocks 0.30.0 → 0.31.0

package/dist/full-invoice-fields-DMX0sjPG.d.cts

@@ -0,0 +1,140 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ShopCheckoutCopy, ShopCheckoutInput, ShopBillingInput } from '@reblu/site-contracts';
+
+/** A heading level a caller can configure — `h1`…`h6`. */
+type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
+
+/**
+ * `CheckoutTermsAcceptance` (REB-1198) — the mandatory, unticked box «He leído
+ * y acepto las {terms} de {tenant}» of the single-step checkout. Every text is
+ * the tenant's (`ShopConfig.checkout`, edited in nexus › Configuración ›
+ * Legal): `{terms}` becomes the link to the full document (text
+ * `termsLinkText`, target `termsLinkUrl` or the SITE's own `termsHref`, a new
+ * tab when `isTermsLinkNewTab`), `{tenant}` the site name. A label without
+ * `{terms}` gets the link appended.
+ *
+ * Renders nothing while the tenant has published no terms
+ * (`termsVersion: null`): there is nothing to accept and checkout does not
+ * ask. Send {@link toCheckoutTermsFields} with the checkout body; the server
+ * refuses without it (`TERMS_NOT_ACCEPTED`) or with an old version
+ * (`TERMS_VERSION_CHANGED`: reload the config and ask again).
+ */
+type CheckoutTermsCopy = Pick<ShopCheckoutCopy, 'tenantName' | 'termsCheckboxLabel' | 'termsLinkText' | 'termsLinkUrl' | 'isTermsLinkNewTab' | 'termsVersion'>;
+interface CheckoutTermsAcceptanceProps {
+    copy: CheckoutTermsCopy;
+    /** The SITE's route to its terms page, used when the tenant set no `termsLinkUrl`. */
+    termsHref: string;
+    checked: boolean;
+    onCheckedChange: (checked: boolean) => void;
+    /** E.g. «Debes aceptar las condiciones para continuar.» (the SITE's or the API's text). */
+    error?: string | null;
+    /** Appended inside the link when it opens a new tab (screen readers). @default '(se abre en una pestaña nueva)' */
+    newTabHint?: string;
+    /** The checkbox id (one box per page). @default 'checkout-terms' */
+    id?: string;
+    className?: string;
+}
+declare function CheckoutTermsAcceptance({ copy, termsHref, checked, onCheckedChange, error, newTabHint, id, className, }: CheckoutTermsAcceptanceProps): react_jsx_runtime.JSX.Element | null;
+/**
+ * The checkout body fields for the terms box: `acceptsTerms` and the version
+ * shown (`termsVersionId`), or nothing when the tenant published no terms.
+ */
+declare function toCheckoutTermsFields(copy: Pick<ShopCheckoutCopy, 'termsVersion'> | null | undefined, accepted: boolean): Pick<ShopCheckoutInput, 'acceptsTerms' | 'termsVersionId'>;
+
+/**
+ * `FullInvoiceFields` — the shop checkout's full-invoice request, drop-in
+ * (REB-73). Fully controlled (`value`/`onChange`), no hooks, no fetch: the
+ * SITE owns the state and sends `toCheckoutInvoiceFields(value, overCap)`
+ * with its checkout body.
+ *
+ * The rule it presents (owner decision 15-Oct-2026): «Si quieren factura
+ * completa, si o si deben aportar el NIF, si no lo aportan se emite factura
+ * simplificada». The identifier is a Spanish NIF/NIE/CIF or, for a foreign
+ * buyer, an EU VAT id, a passport or an ID document of their country — with
+ * the country that issued it. Over the shop's simplified-invoice cap
+ * (`ShopConfig.simplifiedInvoiceCapCents`, see `isOverSimplifiedInvoiceCap`)
+ * a full invoice is the only legal one: pass `overCap` and the fields become
+ * required, without a toggle. The server validates the identifier and
+ * refuses with `BILLING_DATA_REQUIRED` what this form cannot prevent.
+ *
+ * A shop that issues no invoices (`ShopConfig.simplifiedInvoiceCapCents` is
+ * `null`, see `shopIssuesInvoices`) offers no opt-in: pass
+ * `issuesInvoices={false}` and the block renders nothing — the server would
+ * refuse `wantsFullInvoice: true` with `FULL_INVOICE_UNAVAILABLE`.
+ */
+type FullInvoiceIdType = NonNullable<ShopBillingInput['billingIdType']>;
+interface FullInvoiceValue {
+    wantsFullInvoice: boolean;
+    billingIdType: FullInvoiceIdType;
+    /** ISO 3166-1 alpha-2 country that issued a foreign document. */
+    billingIdCountry: string;
+    billingNif: string;
+    billingName: string;
+    street: string;
+    postalCode: string;
+    city: string;
+    /** ISO 3166-1 alpha-2 country of the billing address. */
+    country: string;
+}
+declare const EMPTY_FULL_INVOICE_VALUE: FullInvoiceValue;
+type FullInvoiceErrors = Partial<Record<'billingIdType' | 'billingIdCountry' | 'billingNif' | 'billingName' | 'address', string>>;
+interface FullInvoiceFieldsLabels {
+    toggle: string;
+    underCapNotice: string;
+    overCapNotice: string;
+    idType: string;
+    idCountry: string;
+    chooseCountry: string;
+    spanishNif: string;
+    documentNumber: string;
+    name: string;
+    street: string;
+    postalCode: string;
+    city: string;
+    country: string;
+    idTypeOptions: Record<FullInvoiceIdType, string>;
+}
+/** ISO 3166-1 alpha-2 countries offered by default: Spain, the EU and frequent others. */
+declare const DEFAULT_INVOICE_COUNTRIES: ReadonlyArray<{
+    code: string;
+    name: string;
+}>;
+/**
+ * Whether the shop issues invoices at all, read from the field the contract
+ * defines for it: `ShopConfig.simplifiedInvoiceCapCents` is the effective cap
+ * while invoicing is on and `null` otherwise (absent on an older base-api,
+ * which accepts no opt-in either).
+ */
+declare function shopIssuesInvoices(config: {
+    simplifiedInvoiceCapCents?: number | null;
+}): boolean;
+/** Whether a cart total (cents) is over the shop's simplified-invoice cap; `null` cap = no gate. */
+declare function isOverSimplifiedInvoiceCap(totalCents: number, capCents: number | null): boolean;
+/**
+ * The checkout body fields for the request: `wantsFullInvoice` and the
+ * `billing` block (identifier, its type and country, name and address). Empty
+ * when the buyer asks for no full invoice within the cap, and always empty
+ * when the shop issues no invoices (`issuesInvoices` false).
+ */
+declare function toCheckoutInvoiceFields(value: FullInvoiceValue, overCap: boolean, issuesInvoices?: boolean): Pick<ShopCheckoutInput, 'wantsFullInvoice' | 'billing'>;
+interface FullInvoiceFieldsProps {
+    value: FullInvoiceValue;
+    onChange: (next: FullInvoiceValue) => void;
+    /** The cart total is over `ShopConfig.simplifiedInvoiceCapCents`. */
+    overCap: boolean;
+    /**
+     * `false` when the shop issues no invoices (`shopIssuesInvoices(config)`):
+     * the block renders nothing. Defaults to `true`.
+     */
+    issuesInvoices?: boolean;
+    errors?: FullInvoiceErrors;
+    countries?: ReadonlyArray<{
+        code: string;
+        name: string;
+    }>;
+    labels?: Partial<FullInvoiceFieldsLabels>;
+    className?: string;
+}
+declare function FullInvoiceFields({ value, onChange, overCap, issuesInvoices, errors, countries, labels, className, }: FullInvoiceFieldsProps): react_jsx_runtime.JSX.Element | null;
+
+export { type CheckoutTermsCopy as C, DEFAULT_INVOICE_COUNTRIES as D, EMPTY_FULL_INVOICE_VALUE as E, type FullInvoiceFieldsLabels as F, type HeadingLevel as H, type FullInvoiceValue as a, CheckoutTermsAcceptance as b, type CheckoutTermsAcceptanceProps as c, type FullInvoiceErrors as d, FullInvoiceFields as e, type FullInvoiceFieldsProps as f, type FullInvoiceIdType as g, toCheckoutTermsFields as h, isOverSimplifiedInvoiceCap as i, shopIssuesInvoices as s, toCheckoutInvoiceFields as t };

package/dist/full-invoice-fields-DMX0sjPG.d.ts

@@ -0,0 +1,140 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ShopCheckoutCopy, ShopCheckoutInput, ShopBillingInput } from '@reblu/site-contracts';
+
+/** A heading level a caller can configure — `h1`…`h6`. */
+type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
+
+/**
+ * `CheckoutTermsAcceptance` (REB-1198) — the mandatory, unticked box «He leído
+ * y acepto las {terms} de {tenant}» of the single-step checkout. Every text is
+ * the tenant's (`ShopConfig.checkout`, edited in nexus › Configuración ›
+ * Legal): `{terms}` becomes the link to the full document (text
+ * `termsLinkText`, target `termsLinkUrl` or the SITE's own `termsHref`, a new
+ * tab when `isTermsLinkNewTab`), `{tenant}` the site name. A label without
+ * `{terms}` gets the link appended.
+ *
+ * Renders nothing while the tenant has published no terms
+ * (`termsVersion: null`): there is nothing to accept and checkout does not
+ * ask. Send {@link toCheckoutTermsFields} with the checkout body; the server
+ * refuses without it (`TERMS_NOT_ACCEPTED`) or with an old version
+ * (`TERMS_VERSION_CHANGED`: reload the config and ask again).
+ */
+type CheckoutTermsCopy = Pick<ShopCheckoutCopy, 'tenantName' | 'termsCheckboxLabel' | 'termsLinkText' | 'termsLinkUrl' | 'isTermsLinkNewTab' | 'termsVersion'>;
+interface CheckoutTermsAcceptanceProps {
+    copy: CheckoutTermsCopy;
+    /** The SITE's route to its terms page, used when the tenant set no `termsLinkUrl`. */
+    termsHref: string;
+    checked: boolean;
+    onCheckedChange: (checked: boolean) => void;
+    /** E.g. «Debes aceptar las condiciones para continuar.» (the SITE's or the API's text). */
+    error?: string | null;
+    /** Appended inside the link when it opens a new tab (screen readers). @default '(se abre en una pestaña nueva)' */
+    newTabHint?: string;
+    /** The checkbox id (one box per page). @default 'checkout-terms' */
+    id?: string;
+    className?: string;
+}
+declare function CheckoutTermsAcceptance({ copy, termsHref, checked, onCheckedChange, error, newTabHint, id, className, }: CheckoutTermsAcceptanceProps): react_jsx_runtime.JSX.Element | null;
+/**
+ * The checkout body fields for the terms box: `acceptsTerms` and the version
+ * shown (`termsVersionId`), or nothing when the tenant published no terms.
+ */
+declare function toCheckoutTermsFields(copy: Pick<ShopCheckoutCopy, 'termsVersion'> | null | undefined, accepted: boolean): Pick<ShopCheckoutInput, 'acceptsTerms' | 'termsVersionId'>;
+
+/**
+ * `FullInvoiceFields` — the shop checkout's full-invoice request, drop-in
+ * (REB-73). Fully controlled (`value`/`onChange`), no hooks, no fetch: the
+ * SITE owns the state and sends `toCheckoutInvoiceFields(value, overCap)`
+ * with its checkout body.
+ *
+ * The rule it presents (owner decision 15-Oct-2026): «Si quieren factura
+ * completa, si o si deben aportar el NIF, si no lo aportan se emite factura
+ * simplificada». The identifier is a Spanish NIF/NIE/CIF or, for a foreign
+ * buyer, an EU VAT id, a passport or an ID document of their country — with
+ * the country that issued it. Over the shop's simplified-invoice cap
+ * (`ShopConfig.simplifiedInvoiceCapCents`, see `isOverSimplifiedInvoiceCap`)
+ * a full invoice is the only legal one: pass `overCap` and the fields become
+ * required, without a toggle. The server validates the identifier and
+ * refuses with `BILLING_DATA_REQUIRED` what this form cannot prevent.
+ *
+ * A shop that issues no invoices (`ShopConfig.simplifiedInvoiceCapCents` is
+ * `null`, see `shopIssuesInvoices`) offers no opt-in: pass
+ * `issuesInvoices={false}` and the block renders nothing — the server would
+ * refuse `wantsFullInvoice: true` with `FULL_INVOICE_UNAVAILABLE`.
+ */
+type FullInvoiceIdType = NonNullable<ShopBillingInput['billingIdType']>;
+interface FullInvoiceValue {
+    wantsFullInvoice: boolean;
+    billingIdType: FullInvoiceIdType;
+    /** ISO 3166-1 alpha-2 country that issued a foreign document. */
+    billingIdCountry: string;
+    billingNif: string;
+    billingName: string;
+    street: string;
+    postalCode: string;
+    city: string;
+    /** ISO 3166-1 alpha-2 country of the billing address. */
+    country: string;
+}
+declare const EMPTY_FULL_INVOICE_VALUE: FullInvoiceValue;
+type FullInvoiceErrors = Partial<Record<'billingIdType' | 'billingIdCountry' | 'billingNif' | 'billingName' | 'address', string>>;
+interface FullInvoiceFieldsLabels {
+    toggle: string;
+    underCapNotice: string;
+    overCapNotice: string;
+    idType: string;
+    idCountry: string;
+    chooseCountry: string;
+    spanishNif: string;
+    documentNumber: string;
+    name: string;
+    street: string;
+    postalCode: string;
+    city: string;
+    country: string;
+    idTypeOptions: Record<FullInvoiceIdType, string>;
+}
+/** ISO 3166-1 alpha-2 countries offered by default: Spain, the EU and frequent others. */
+declare const DEFAULT_INVOICE_COUNTRIES: ReadonlyArray<{
+    code: string;
+    name: string;
+}>;
+/**
+ * Whether the shop issues invoices at all, read from the field the contract
+ * defines for it: `ShopConfig.simplifiedInvoiceCapCents` is the effective cap
+ * while invoicing is on and `null` otherwise (absent on an older base-api,
+ * which accepts no opt-in either).
+ */
+declare function shopIssuesInvoices(config: {
+    simplifiedInvoiceCapCents?: number | null;
+}): boolean;
+/** Whether a cart total (cents) is over the shop's simplified-invoice cap; `null` cap = no gate. */
+declare function isOverSimplifiedInvoiceCap(totalCents: number, capCents: number | null): boolean;
+/**
+ * The checkout body fields for the request: `wantsFullInvoice` and the
+ * `billing` block (identifier, its type and country, name and address). Empty
+ * when the buyer asks for no full invoice within the cap, and always empty
+ * when the shop issues no invoices (`issuesInvoices` false).
+ */
+declare function toCheckoutInvoiceFields(value: FullInvoiceValue, overCap: boolean, issuesInvoices?: boolean): Pick<ShopCheckoutInput, 'wantsFullInvoice' | 'billing'>;
+interface FullInvoiceFieldsProps {
+    value: FullInvoiceValue;
+    onChange: (next: FullInvoiceValue) => void;
+    /** The cart total is over `ShopConfig.simplifiedInvoiceCapCents`. */
+    overCap: boolean;
+    /**
+     * `false` when the shop issues no invoices (`shopIssuesInvoices(config)`):
+     * the block renders nothing. Defaults to `true`.
+     */
+    issuesInvoices?: boolean;
+    errors?: FullInvoiceErrors;
+    countries?: ReadonlyArray<{
+        code: string;
+        name: string;
+    }>;
+    labels?: Partial<FullInvoiceFieldsLabels>;
+    className?: string;
+}
+declare function FullInvoiceFields({ value, onChange, overCap, issuesInvoices, errors, countries, labels, className, }: FullInvoiceFieldsProps): react_jsx_runtime.JSX.Element | null;
+
+export { type CheckoutTermsCopy as C, DEFAULT_INVOICE_COUNTRIES as D, EMPTY_FULL_INVOICE_VALUE as E, type FullInvoiceFieldsLabels as F, type HeadingLevel as H, type FullInvoiceValue as a, CheckoutTermsAcceptance as b, type CheckoutTermsAcceptanceProps as c, type FullInvoiceErrors as d, FullInvoiceFields as e, type FullInvoiceFieldsProps as f, type FullInvoiceIdType as g, toCheckoutTermsFields as h, isOverSimplifiedInvoiceCap as i, shopIssuesInvoices as s, toCheckoutInvoiceFields as t };