@base316/react 0.2.0 → 0.5.0

package/dist/manifest.json

@@ -44,6 +44,11 @@
 					"summary": "Colours, radius and font as tokens. Restyles everything at once.",
 					"required": false
 				},
+				{
+					"name": "tenant",
+					"summary": "White-label everything inside for one tenant — `{ organizationId }` or `{ organizationExternalId }`. A firm's name, logo and colours on the screens it runs its clients on; its own branding, then its parent's, then the environment's. Change it when the user switches team.",
+					"required": false
+				},
 				{
 					"name": "className",
 					"summary": "Your own classes on the wrapper.",
@@ -82,7 +87,7 @@
 		{
 			"name": "SignIn",
 			"kind": "component",
-			"summary": "Password, passkey and magic-link sign-in in one form.",
+			"summary": "Password, passkey, magic-link and text-message sign-in in one form.",
 			"useWhen": "The application renders its own sign-in rather than redirecting to the hosted page.",
 			"requires": [],
 			"props": [
@@ -101,6 +106,16 @@
 					"summary": "Where an emailed link lands, which must be registered on the environment. Without it, magic link is not offered at all.",
 					"required": false
 				},
+				{
+					"name": "phone",
+					"summary": "Offer signing in with a code sent by text message. Needs text messages switched on for the environment, and its own Twilio account in production.",
+					"required": false
+				},
+				{
+					"name": "secondFactorLabels",
+					"summary": "Wording for the second-factor step (code box, or enrolment when the environment requires a factor and the user has none), for translation. English when omitted.",
+					"required": false
+				},
 				{
 					"name": "className",
 					"summary": "Your own classes on the wrapper.",
@@ -114,19 +129,84 @@
 			],
 			"seeAlso": [
 				"SignUp",
-				"ForgotPassword"
+				"ForgotPassword",
+				"SecondFactorStep"
 			]
 		},
 		{
 			"name": "SignUp",
 			"kind": "component",
-			"summary": "Create an account with an email and a password.",
+			"summary": "Create an account with an email and a password, showing the environment's password rules, then sign in — through the second-factor step when one is owed or must be enrolled.",
 			"useWhen": "Alongside SignIn, on a page that registers new users.",
 			"requires": [],
 			"props": [
 				{
 					"name": "onSignedUp",
-					"summary": "Called after the account is created.",
+					"summary": "Called once the account is created and signed in, or created and waiting on email confirmation.",
+					"required": false
+				},
+				{
+					"name": "invitationToken",
+					"summary": "The invitation this sign-up accepts; read from `?invitation=` when omitted, `null` to ignore the URL. The account joins the inviting team instead of getting a personal workspace, and its address counts as verified.",
+					"required": false
+				},
+				{
+					"name": "onJoined",
+					"summary": "Called with the team's organizationId when the sign-up accepted an invitation.",
+					"required": false
+				},
+				{
+					"name": "labels",
+					"summary": "Wording for the form, for translation.",
+					"required": false
+				},
+				{
+					"name": "secondFactorLabels",
+					"summary": "Wording for the second-factor step, for translation.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"seeAlso": [
+				"SignIn",
+				"VerifyEmail",
+				"SecondFactorStep"
+			]
+		},
+		{
+			"name": "SecondFactorStep",
+			"kind": "component",
+			"summary": "The second half of a sign-in that returned `mfaRequired`: a code box for an existing factor, or — when the environment requires a factor and the user has none — choosing an authenticator app (QR code and key), an emailed code or a text, confirming it, and showing the recovery codes once.",
+			"useWhen": "Your own first step (a custom form, a magic-link landing) got a `SignInPending` back. SignIn and SignUp already include it.",
+			"requires": [],
+			"props": [
+				{
+					"name": "pending",
+					"summary": "The `SignInPending` from signIn, magicLink.verify or phone.verify.",
+					"required": true
+				},
+				{
+					"name": "onSignedIn",
+					"summary": "Called once the session is handed to the provider.",
+					"required": false
+				},
+				{
+					"name": "onRestart",
+					"summary": "Back to the start, for a challenge that expired or ran out of attempts. Without it no Start over button is drawn.",
+					"required": false
+				},
+				{
+					"name": "labels",
+					"summary": "Wording, for translation. English when omitted.",
 					"required": false
 				},
 				{
@@ -142,7 +222,7 @@
 			],
 			"seeAlso": [
 				"SignIn",
-				"VerifyEmail"
+				"TwoFactorManager"
 			]
 		},
 		{
@@ -373,8 +453,8 @@
 		{
 			"name": "TwoFactorManager",
 			"kind": "component",
-			"summary": "Turn two-factor authentication on or off, by authenticator app or a code to the inbox.",
-			"useWhen": "A security settings page. Offers both factors; the app is stronger, the emailed code is the one people who will not install an app actually use.",
+			"summary": "Turn two-factor authentication on or off, by authenticator app, a code to the inbox or a code by text message.",
+			"useWhen": "A security settings page. The app is strongest; the emailed or texted code is the one people who will not install an app actually use.",
 			"requires": [
 				"session"
 			],
@@ -384,6 +464,11 @@
 					"summary": "Whether a factor already exists, which decides which side is shown.",
 					"required": false
 				},
+				{
+					"name": "allowSms",
+					"summary": "Offer a code by text message. Off by default: it only works once the environment can send one.",
+					"required": false
+				},
 				{
 					"name": "onEnabled",
 					"summary": "Called once a factor is confirmed.",
@@ -444,7 +529,7 @@
 		{
 			"name": "Branding",
 			"kind": "component",
-			"summary": "The environment's logo, name and tagline.",
+			"summary": "The logo, name and tagline — the environment's, or the tenant's when the provider is given a `tenant`.",
 			"useWhen": "Above a sign-in form, so your pages match the hosted ones.",
 			"requires": [],
 			"props": [
@@ -468,7 +553,7 @@
 		{
 			"name": "TeamMembers",
 			"kind": "component",
-			"summary": "Who is in a team, who has been invited, and the way in and out.",
+			"summary": "Who is in a team, who has been invited, and the way in and out. A team reached only through the organization that manages it says so, and offers nothing to leave.",
 			"useWhen": "A Team or Members settings page. One component covers the list, the pending invitations, the invite box and leaving.",
 			"requires": [
 				"session"
@@ -529,7 +614,7 @@
 				},
 				{
 					"name": "signUpUrl",
-					"summary": "For somebody with no account yet.",
+					"summary": "For somebody with no account yet: a page with SignUp. The link carries `?invitation=`, so the account is created inside this team without a personal workspace.",
 					"required": false
 				},
 				{
@@ -617,14 +702,31 @@
 		{
 			"name": "SubscriptionManager",
 			"kind": "component",
-			"summary": "The current plan, its renewal date, and cancelling.",
+			"summary": "The current plan, its renewal date, a scheduled plan change with its undo, cancelling at the period end (confirmed in the page) and resuming a cancelled one.",
 			"useWhen": "A billing settings page.",
 			"requires": [
 				"session"
 			],
-			"props": [],
+			"props": [
+				{
+					"name": "onChange",
+					"summary": "Called after a cancel, a resume or an undone plan change, so a sibling showing the same subscription can refresh.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
 			"whenUnmet": "Renders nothing without a session.",
 			"seeAlso": [
+				"BillingPortal",
 				"PricingTable",
 				"Invoices"
 			]
@@ -632,17 +734,297 @@
 		{
 			"name": "Invoices",
 			"kind": "component",
-			"summary": "The signed-in user's invoices, newest first.",
+			"summary": "The signed-in user's invoices, newest first: view one, download its PDF, and pay one that is still open on the hosted pay page.",
 			"useWhen": "A billing settings page.",
 			"requires": [
 				"session"
 			],
-			"props": [],
+			"props": [
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
 			"whenUnmet": "Renders nothing without a session.",
 			"seeAlso": [
+				"BillingPortal",
+				"SubscriptionManager",
+				"UpcomingInvoice"
+			]
+		},
+		{
+			"name": "BillingPortal",
+			"kind": "component",
+			"summary": "A whole billing page for the signed-in user: plan and status, next invoice, scheduled change with undo, plan change with a review step, seats, credit balances with auto-recharge, saved cards, invoices with PDFs and pay, cancel and resume, and a Billing details slot.",
+			"useWhen": "You want a complete self-service billing screen inside your own application. For a page you do not host at all, mint a hosted billing portal session from your server instead (`billingPortal.createSession`). For a different layout, compose the pieces it is made of.",
+			"requires": [
+				"session",
+				"plans"
+			],
+			"props": [
+				{
+					"name": "returnUrl",
+					"summary": "Where the browser comes back to after updating the card on Stripe's page. Must be an environment redirect URI. The current page when omitted.",
+					"required": false
+				},
+				{
+					"name": "featuredPlanKey",
+					"summary": "The plan to present as the default choice in the plan picker.",
+					"required": false
+				},
+				{
+					"name": "unitLabel",
+					"summary": "What a seat is called, plural. \"seats\" by default.",
+					"required": false
+				},
+				{
+					"name": "billingDetails",
+					"summary": "Your own Billing details section (address, tax IDs). By default it is BillingDetailsForm — the address and tax IDs, EU VAT numbers checked with VIES; pass null to leave it out.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Asks the user to sign in without a session. With no subscription it offers the plans through checkout. A managed tenant sees the firm's plan read-only and its own invoices.",
+			"seeAlso": [
+				"SubscriptionManager",
+				"UpcomingInvoice",
+				"PlanChangeReview",
+				"SeatManager",
+				"CreditBalances",
+				"PaymentMethod",
+				"Invoices"
+			]
+		},
+		{
+			"name": "CreditBalances",
+			"kind": "component",
+			"summary": "The signed-in user's credit balances: what is left of each metered feature sold in packs, buying a pack now, and auto-recharge (threshold, pack, monthly maximum).",
+			"useWhen": "A billing or usage page in a product that sells credit packs. `BillingPortal` includes it. Buying goes to the hosted pay page; auto-recharge charges the card on file.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "onChange",
+					"summary": "Called after auto-recharge is saved.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Renders nothing without a session or when no credit packs are on sale. A managed tenant sees the balance it spends, read-only.",
+			"seeAlso": [
+				"BillingPortal",
+				"PaymentMethod"
+			]
+		},
+		{
+			"name": "PlanChangeReview",
+			"kind": "component",
+			"summary": "The review step before a plan change: features gained and lost, the prorated credit and charge or the date it waits for, then confirm.",
+			"useWhen": "Your own plan picker, between choosing a plan and changing to it. `BillingPortal` opens it when a subscriber picks a plan.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "planVersionId",
+					"summary": "The plan version to move to — a PublicPlan's planVersionId. Required in practice.",
+					"required": false
+				},
+				{
+					"name": "onDone",
+					"summary": "Called once the change is made or scheduled.",
+					"required": false
+				},
+				{
+					"name": "onCancel",
+					"summary": "Called when the user keeps their plan. Without it there is no back button.",
+					"required": false
+				},
+				{
+					"name": "onNeedsCard",
+					"summary": "Called when a change now needs a card the account lacks. Without it the review starts a card update itself.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Says the change is not available when the plan cannot be moved to, and that the plan is provided by their organization for a managed tenant.",
+			"seeAlso": [
+				"BillingPortal",
+				"PricingTable",
+				"usePlans"
+			]
+		},
+		{
+			"name": "PaymentMethod",
+			"kind": "component",
+			"summary": "The card the signed-in user's invoices are charged against, a button that replaces it on a Stripe-hosted page, and their other saved cards to make default or remove.",
+			"useWhen": "A billing page. The card is entered on Stripe's page on your connected account, never in your page or Base316, so it adds nothing to your PCI scope.",
+			"requires": [
+				"session",
+				"paymentAccount"
+			],
+			"props": [
+				{
+					"name": "returnUrl",
+					"summary": "Where the browser comes back to once the card is stored. Must be an environment redirect URI. The current page when omitted.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Asks the user to sign in without a session; says cards cannot be updated when the environment has no connected payment account; says the plan is paid for by their organization for a managed tenant.",
+			"seeAlso": [
+				"BillingPortal",
+				"Invoices"
+			]
+		},
+		{
+			"name": "UpcomingInvoice",
+			"kind": "component",
+			"summary": "The signed-in user's next bill: when it is issued, its lines, discount, tax, wallet balance and the amount due.",
+			"useWhen": "A billing or account page that answers 'what will I be charged next'. Computed on request and stored nowhere, so it is safe to show on every visit.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "showLines",
+					"summary": "Show the breakdown. Off gives one line: the amount due and the date. On by default.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Asks the user to sign in without a session; says there is no upcoming invoice when nothing will bill them; says the plan is provided by their organization for a managed tenant.",
+			"seeAlso": [
+				"Invoices",
+				"SubscriptionManager"
+			]
+		},
+		{
+			"name": "BillingDetailsForm",
+			"kind": "component",
+			"summary": "The signed-in user's billing address and tax ids, with EU VAT numbers checked against VIES as they are saved.",
+			"useWhen": "A billing or account page where a business customer enters the address its invoices are made out to and its VAT, GST or similar number. Saved against the session's own account only.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "taxIdTypes",
+					"summary": "The tax id types to offer, as Stripe type names with a label and example. Defaults to the EU, UK, Switzerland, Norway, Australia, New Zealand, Canada, India and the US.",
+					"required": false
+				},
+				{
+					"name": "onSave",
+					"summary": "Called after a save, with the details as stored — each tax id with its check result.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Asks the user to sign in without a session; says there is no billing account when the user has none; says billing is managed by their organization for a managed tenant, and offers nothing to change.",
+			"seeAlso": [
+				"Invoices",
+				"UpcomingInvoice",
 				"SubscriptionManager"
 			]
 		},
+		{
+			"name": "SeatManager",
+			"kind": "component",
+			"summary": "Change how many seats the signed-in user's subscription is for, with the prorated price previewed before anything is charged.",
+			"useWhen": "A billing or team page on a plan sold per seat. Adding seats is charged now for the rest of the period; removing them takes effect at the period end with no refund. The user picks only the number.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "unitLabel",
+					"summary": "What a unit is called, plural. \"seats\" by default.",
+					"required": false
+				},
+				{
+					"name": "onChange",
+					"summary": "Called after a change is made, with what it did (amount, invoice, when it applies).",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Asks the user to sign in without a session; says there is no plan when they have no subscription; says the plan is provided by their organization for a managed tenant, and offers no change.",
+			"seeAlso": [
+				"SubscriptionManager",
+				"UpcomingInvoice",
+				"TeamMembers"
+			]
+		},
 		{
 			"name": "PayInvoice",
 			"kind": "component",

package/dist/src/AcceptInvitation.d.ts

@@ -13,11 +13,25 @@ import { type CSSProperties } from "react";
  * means the page survives a sign-in round trip that navigates away and back —
  * which is the normal path for somebody who has just created an account.
  */
+/**
+ * The sign-up link, carrying the invitation.
+ *
+ * `<SignUp />` reads `?invitation=` and sends it with the sign-up, which is
+ * what creates the account inside this team instead of in a personal
+ * workspace nobody asked for. A link the caller already gave a token is left
+ * alone; a fragment stays at the end, where it belongs.
+ */
+export declare function signUpUrlWithInvitation(url: string, token: string): string;
 export interface AcceptInvitationProps {
     /** Supply the token directly. Read from `?invitation=` when omitted. */
     token?: string;
     onAccepted?: (organizationId: string) => void;
-    /** Where to send somebody who needs an account first. */
+    /**
+     * Where to send somebody who needs an account first — a page with
+     * `<SignUp />`. The invitation is appended as `?invitation=`, so the
+     * account is created inside this team rather than in a workspace of its
+     * own.
+     */
     signUpUrl?: string;
     signInUrl?: string;
     className?: string;

package/dist/src/AcceptInvitation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcceptInvitation.d.ts","sourceRoot":"","sources":["../../src/AcceptInvitation.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAuB,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC;AAKhE;;;;;;;;;;;;;GAaG;AAEH,MAAM,WAAW,qBAAqB;IACrC,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9C,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC;CACtB;AAED,wBAAgB,gBAAgB,CAAC,EAChC,KAAK,EAAE,QAAQ,EACf,UAAU,EACV,SAAS,EACT,SAAS,EACT,SAAS,EACT,KAAK,GACL,EAAE,qBAAqB,+BA0IvB"}
+{"version":3,"file":"AcceptInvitation.d.ts","sourceRoot":"","sources":["../../src/AcceptInvitation.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAuB,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC;AAKhE;;;;;;;;;;;;;GAaG;AAEH;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAW1E;AAED,MAAM,WAAW,qBAAqB;IACrC,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9C;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC;CACtB;AAED,wBAAgB,gBAAgB,CAAC,EAChC,KAAK,EAAE,QAAQ,EACf,UAAU,EACV,SAAS,EACT,SAAS,EACT,SAAS,EACT,KAAK,GACL,EAAE,qBAAqB,+BA+IvB"}

package/dist/src/BillingDetailsForm.d.ts

@@ -0,0 +1,33 @@
+import type { BillingDetails } from "@base316/sdk";
+import { type CSSProperties } from "react";
+export interface BillingDetailsFormProps {
+    /**
+     * The tax id types to offer, in order. Stripe's type names; the defaults
+     * cover the EU, UK, Switzerland, Norway, Australia, New Zealand, Canada,
+     * India and the US.
+     */
+    taxIdTypes?: {
+        type: string;
+        label: string;
+        example: string;
+    }[];
+    /** Called after a save, with the details as stored — tax ids with their check result. */
+    onSave?: (details: BillingDetails) => void;
+    className?: string;
+    style?: CSSProperties;
+}
+/**
+ * The signed-in user's billing address and tax ids.
+ *
+ * Saved against their own account only — the session decides which, never
+ * anything the page sends. An EU VAT number is checked with the EU's VIES
+ * service as it is saved, and its result shown: a number VIES does not know is
+ * kept and marked, never silently dropped, and one VIES cannot reach right now
+ * is checked again later. Invoices are made out to this address, and a valid
+ * EU VAT number lets a cross-border business purchase be reverse charged.
+ *
+ * A client company whose plan a firm pays for is told so instead: the firm's
+ * account is the one invoiced.
+ */
+export declare function BillingDetailsForm({ taxIdTypes, onSave, className, style, }: BillingDetailsFormProps): import("react").JSX.Element;
+//# sourceMappingURL=BillingDetailsForm.d.ts.map

package/dist/src/BillingDetailsForm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BillingDetailsForm.d.ts","sourceRoot":"","sources":["../../src/BillingDetailsForm.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAA+B,MAAM,cAAc,CAAC;AAChF,OAAO,EAAoC,KAAK,aAAa,EAAkB,MAAM,OAAO,CAAC;AAgD7F,MAAM,WAAW,uBAAuB;IACvC;;;;OAIG;IACH,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAChE,yFAAyF;IACzF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC;CACtB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,EAClC,UAAiC,EACjC,MAAM,EACN,SAAS,EACT,KAAK,GACL,EAAE,uBAAuB,+BAiOzB"}

package/dist/src/BillingPortal.d.ts

@@ -0,0 +1,45 @@
+import { type CSSProperties, type ReactNode } from "react";
+export interface BillingPortalProps {
+    /**
+     * Where the browser comes back to after updating the card on Stripe's page.
+     * Must be one of the environment's redirect URIs. Defaults to the current
+     * page.
+     */
+    returnUrl?: string;
+    /** The plan to present as the default choice in the plan picker, by key. */
+    featuredPlanKey?: string;
+    /** What a seat is called, plural. "seats" by default. */
+    unitLabel?: string;
+    /**
+     * The "Billing details" section: the billing address and tax IDs.
+     *
+     * Replace it with your own form, or pass `null` to leave it out. By default
+     * it is `<BillingDetailsForm />`: the address invoices are made out to and
+     * the tax IDs on them, EU VAT numbers checked with VIES as they are saved.
+     */
+    billingDetails?: ReactNode;
+    className?: string;
+    style?: CSSProperties;
+}
+/**
+ * A whole billing page for the signed-in user, in one component.
+ *
+ * The embeddable counterpart to the hosted billing portal: plan and status,
+ * the next invoice, a scheduled change with its undo, a plan picker whose
+ * choice opens a review step, seats when the plan is priced per seat, credit
+ * balances with buying and auto-recharge when the product sells credit packs,
+ * the saved cards, invoices with their PDFs and a way to pay an open one, and cancel
+ * and resume. Everything goes through the signed-in user's session and the
+ * `/v1/me` routes, which apply the same rules as the hosted page.
+ *
+ * It is the existing pieces composed — `SubscriptionManager`,
+ * `UpcomingInvoice`, `PricingTable`, `PlanChangeReview`, `SeatManager`,
+ * `CreditBalances`, `PaymentMethod` and `Invoices` — so a page that wants a different layout
+ * uses those directly. After any change the pieces are re-read together, so
+ * the invoice preview never disagrees with the plan above it.
+ *
+ * A client company billed by the firm that manages it sees the firm's plan,
+ * read-only and named, and its own invoices — nothing it could change.
+ */
+export declare function BillingPortal({ returnUrl, featuredPlanKey, unitLabel, billingDetails, className, style, }: BillingPortalProps): import("react").JSX.Element;
+//# sourceMappingURL=BillingPortal.d.ts.map

package/dist/src/BillingPortal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BillingPortal.d.ts","sourceRoot":"","sources":["../../src/BillingPortal.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAoC,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAc7F,MAAM,WAAW,kBAAkB;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC;CACtB;AASD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CAAC,EAC7B,SAAS,EACT,eAAe,EACf,SAAS,EACT,cAAc,EACd,SAAS,EACT,KAAK,GACL,EAAE,kBAAkB,+BAsIpB"}

package/dist/src/CreditBalances.d.ts

@@ -0,0 +1,19 @@
+import { type CSSProperties } from "react";
+export interface CreditBalancesProps {
+    /** Called after auto-recharge is saved. */
+    onChange?: () => void;
+    className?: string;
+    style?: CSSProperties;
+}
+/**
+ * The signed-in user's credit balances: what is left of each metered feature
+ * sold in packs, a way to buy a pack now, and auto-recharge — a threshold, the
+ * pack to buy, and a monthly maximum.
+ *
+ * Buying goes to the hosted pay page; auto-recharge charges the card on file
+ * (`PaymentMethod`). A client company whose credits a firm pays for sees the
+ * pool it spends, with nothing to change. Renders nothing when the product
+ * sells no credit packs.
+ */
+export declare function CreditBalances({ onChange, className, style }: CreditBalancesProps): import("react").JSX.Element | null;
+//# sourceMappingURL=CreditBalances.d.ts.map

package/dist/src/CreditBalances.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreditBalances.d.ts","sourceRoot":"","sources":["../../src/CreditBalances.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAuB,KAAK,aAAa,EAAkC,MAAM,OAAO,CAAC;AAOhG,MAAM,WAAW,mBAAmB;IACnC,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC;CACtB;AAsOD;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,mBAAmB,sCAoEjF"}