@cratis/showrunner.boxoffice.react 0.0.0-stage → 1.9.0

package/Labels/BoxOfficeLabels.ts

@@ -0,0 +1,239 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/**
+ * Every text the Box Office components show or announce. Placeholders in braces, such as `{days}`, are filled in by
+ * the components.
+ */
+export interface BoxOfficeLabels {
+    /** Texts shared by several components. */
+    common: {
+        /** The cancel button. */
+        cancel: string;
+        /** The accessible name of a dialog's close button. */
+        close: string;
+        /** Shown while something loads. */
+        loading: string;
+        /** Shown when something could not be loaded. */
+        failed: string;
+        /** Shown when the user may not see something. */
+        unauthorized: string;
+        /** Shown when the customer portal could not be opened. */
+        portalFailed: string;
+        /** Shown instead of a portal button when the product has no customer portal. */
+        noPortal: string;
+    };
+
+    /** What a module's access is called. */
+    moduleAccess: {
+        /** The tenant has no access. */
+        none: string;
+        /** The tenant may look at the module but not use it. */
+        preview: string;
+        /** The tenant has the module on trial. */
+        trial: string;
+        /** The tenant has the module. */
+        full: string;
+        /** Says when access ends. `{date}` is the last day. */
+        until: string;
+    };
+
+    /** The banner that follows a trial. */
+    trialBanner: {
+        /** A trial that runs. `{days}` is how many days are left. */
+        running: string;
+        /** A trial that ends today. */
+        lastDay: string;
+        /** A trial that has closed. */
+        closed: string;
+        /** The button that opens the customer portal to buy. */
+        buy: string;
+    };
+
+    /** The banner for a suspended tenant. */
+    suspension: {
+        /** The title. */
+        title: string;
+        /** Why, when the trial ended without seats. */
+        trialEndedWithoutSeats: string;
+        /** Why, when a payment is overdue. */
+        paymentOverdue: string;
+        /** Why, when an administrator decided it. */
+        administratorDecision: string;
+        /** What to do about it. */
+        resolve: string;
+        /** The button that opens the customer portal. */
+        openPortal: string;
+    };
+
+    /** What a user without a license is told. */
+    noLicense: {
+        /** The title when the user has no seat. */
+        noSeatTitle: string;
+        /** What to do when the user has no seat. */
+        noSeat: string;
+        /** The title when more people hold seats than the tenant has. */
+        overCapacityTitle: string;
+        /** What to do when more people hold seats than the tenant has. */
+        overCapacity: string;
+        /** The title when the trial has closed. */
+        trialClosedTitle: string;
+        /** What to do when the trial has closed. */
+        trialClosed: string;
+        /** The title when the tenant is suspended. */
+        suspendedTitle: string;
+        /** What to do when the tenant is suspended. */
+        suspended: string;
+        /** The button that opens the customer portal. */
+        openPortal: string;
+    };
+
+    /** What the user sees where a module they do not have would be. */
+    requiresModule: {
+        /** The title. `{module}` is the module. */
+        title: string;
+        /** The explanation when the tenant has no access. */
+        none: string;
+        /** The explanation when the tenant may only preview the module. */
+        preview: string;
+        /** The button that opens the customer portal to try the module. */
+        try: string;
+        /** The button that opens the customer portal to buy the module. */
+        buy: string;
+    };
+
+    /** The seats page. */
+    seats: {
+        /** The title. */
+        title: string;
+        /** How many seats are used. `{held}` and `{capacity}` are the numbers. */
+        summary: string;
+        /** Shown when more people hold seats than the tenant has. `{over}` is how many are over. */
+        overCapacity: string;
+        /** Shown when the tenant has no seats at all. */
+        noCapacity: string;
+        /** Shown when nobody holds a seat. */
+        empty: string;
+        /** The column of names. */
+        holderColumn: string;
+        /** The column of email addresses. */
+        emailColumn: string;
+        /** The column of when a seat was assigned. */
+        assignedColumn: string;
+        /** The column of seat status. */
+        statusColumn: string;
+        /** A seat that is licensed. */
+        licensed: string;
+        /** A seat the tenant has no room for. */
+        overCapacityStatus: string;
+        /** The button that assigns a seat. */
+        assign: string;
+        /** The text of the button that releases a seat. */
+        releaseShort: string;
+        /** The accessible name of the button that releases a seat. `{name}` is the person. */
+        release: string;
+        /** The title of the assign dialog. */
+        assignTitle: string;
+        /** The assign dialog's confirm button. */
+        assignConfirm: string;
+        /** The person's name field. */
+        name: string;
+        /** The person's email field. */
+        email: string;
+        /** The identity provider field. */
+        identityProvider: string;
+        /** The person's subject at the identity provider. */
+        subject: string;
+        /** The title of the confirmation to release a seat. */
+        releaseTitle: string;
+        /** The message of the confirmation to release a seat. `{name}` is the person. */
+        releaseMessage: string;
+        /** Said when seats cannot be changed because the tenant is read-only. */
+        readOnly: string;
+    };
+
+    /** The usage page. */
+    usage: {
+        /** The title. */
+        title: string;
+        /** Shown when the product measures nothing. */
+        empty: string;
+        /** The column of meters. */
+        meterColumn: string;
+        /** The column of what is used. */
+        usedColumn: string;
+        /** The column of the allowance. */
+        allowanceColumn: string;
+        /** The column of the budget. */
+        budgetColumn: string;
+        /** The column of concurrency limits. */
+        concurrencyColumn: string;
+        /** How much is used of the allowance. `{used}`, `{allowance}` and `{unit}` are the values. */
+        usedOfAllowance: string;
+        /** Said when the operator set no allowance. `{used}` and `{unit}` are the values. */
+        noAllowance: string;
+        /** The period of an allowance that counts per day. */
+        day: string;
+        /** The period of an allowance that counts per month. */
+        month: string;
+        /** Says when the period starts over. `{date}` is the day. */
+        resets: string;
+        /** Said when the allowance is used up. */
+        atAllowance: string;
+        /** Said when the budget is reached. */
+        atBudget: string;
+        /** Said of work beyond the allowance that is turned away. */
+        block: string;
+        /** Said of work beyond the allowance that waits for the next period. */
+        park: string;
+        /** Shown for a budget or limit nobody set. */
+        notSet: string;
+        /** The accessible name of a meter's progress bar. `{meter}` is the meter. */
+        progress: string;
+    };
+
+    /** The plan and modules page. */
+    plan: {
+        /** The title. */
+        title: string;
+        /** The heading of the modules. */
+        modulesTitle: string;
+        /** The heading of the offers. */
+        offersTitle: string;
+        /** Shown when no module is declared. */
+        noModules: string;
+        /** Shown when nothing is on sale. */
+        noOffers: string;
+        /** The seats an offer includes. `{count}` is the number. */
+        includedSeats: string;
+        /** The modules an offer includes. */
+        includedModules: string;
+        /** A price per month. `{price}` is the amount with its currency. */
+        perMonth: string;
+        /** A price per year. `{price}` is the amount with its currency. */
+        perYear: string;
+        /** The button that opens the customer portal to buy an offer. */
+        buy: string;
+        /** The button that opens the customer portal to try a module. */
+        try: string;
+        /** The button that opens the customer portal to change plan. */
+        changePlan: string;
+        /** Shown for a tenant on a trial. `{days}` is how many days are left. */
+        onTrial: string;
+        /** Shown for a tenant with seats. `{seats}` is how many. */
+        withSeats: string;
+    };
+}
+
+/**
+ * Makes every property of a type optional, all the way down.
+ */
+export type DeepPartial<T> = {
+    [TKey in keyof T]?: T[TKey] extends object ? DeepPartial<T[TKey]> : T[TKey];
+};
+
+/**
+ * The labels of the Box Office components that a solution replaces, for instance to localize them. Labels left out
+ * keep their English defaults.
+ */
+export type BoxOfficeLabelOverrides = DeepPartial<BoxOfficeLabels>;

package/Labels/defaultBoxOfficeLabels.ts

@@ -0,0 +1,119 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { BoxOfficeLabels } from './BoxOfficeLabels.js';
+
+/**
+ * The English labels of the Box Office components.
+ */
+export const defaultBoxOfficeLabels: BoxOfficeLabels = {
+    common: {
+        cancel: 'Cancel',
+        close: 'Close',
+        loading: 'Loading…',
+        failed: 'This could not be loaded.',
+        unauthorized: 'You are not allowed to see this.',
+        portalFailed: 'The customer portal could not be opened. Try again in a moment.',
+        noPortal: 'Contact the people who run this product to change your plan.'
+    },
+    moduleAccess: {
+        none: 'Not included',
+        preview: 'Preview',
+        trial: 'Trial',
+        full: 'Included',
+        until: 'until {date}'
+    },
+    trialBanner: {
+        running: 'Your trial ends in {days} days.',
+        lastDay: 'Your trial ends today.',
+        closed: 'Your trial has ended. Your data is kept, and you can read it, but nothing can be changed until you buy.',
+        buy: 'Buy'
+    },
+    suspension: {
+        title: 'Your organization is suspended',
+        trialEndedWithoutSeats: 'Your trial ended without any seats being bought.',
+        paymentOverdue: 'A payment is overdue.',
+        administratorDecision: 'The people who run this product suspended it.',
+        resolve: 'You can read everything, but nothing can be changed until the suspension is lifted.',
+        openPortal: 'Open the customer portal'
+    },
+    noLicense: {
+        noSeatTitle: 'You do not have a seat',
+        noSeat: 'Ask an administrator of your organization to give you a seat.',
+        overCapacityTitle: 'Your seat is not covered',
+        overCapacity: 'Your organization has more people with seats than it has bought. Ask an administrator to buy more seats or release some.',
+        trialClosedTitle: 'The trial has ended',
+        trialClosed: 'Your organization can read what it has, but nothing can be changed until it buys.',
+        suspendedTitle: 'Your organization is suspended',
+        suspended: 'Your organization can read what it has, but nothing can be changed until the suspension is lifted.',
+        openPortal: 'Open the customer portal'
+    },
+    requiresModule: {
+        title: '{module} is not part of your plan',
+        none: 'Your organization does not have {module}.',
+        preview: 'Your organization can look at {module}, but not use it yet.',
+        try: 'Try it',
+        buy: 'Buy'
+    },
+    seats: {
+        title: 'Seats',
+        summary: '{held} of {capacity} seats in use',
+        overCapacity: 'Your organization has {over} more people with seats than it has bought.',
+        noCapacity: 'Your organization has no seats.',
+        empty: 'Nobody holds a seat yet.',
+        holderColumn: 'Name',
+        emailColumn: 'Email',
+        assignedColumn: 'Assigned',
+        statusColumn: 'Status',
+        licensed: 'Licensed',
+        overCapacityStatus: 'Not covered',
+        assign: 'Assign a seat',
+        releaseShort: 'Release',
+        release: 'Release the seat of {name}',
+        assignTitle: 'Assign a seat',
+        assignConfirm: 'Assign',
+        name: 'Name',
+        email: 'Email',
+        identityProvider: 'Identity provider',
+        subject: 'Subject at the identity provider',
+        releaseTitle: 'Release the seat',
+        releaseMessage: '{name} can no longer use the product until they are given a seat again. Release the seat?',
+        readOnly: 'Seats cannot be changed while your organization is read-only.'
+    },
+    usage: {
+        title: 'Usage',
+        empty: 'This product measures nothing.',
+        meterColumn: 'Meter',
+        usedColumn: 'Used',
+        allowanceColumn: 'Allowance',
+        budgetColumn: 'Budget',
+        concurrencyColumn: 'At the same time',
+        usedOfAllowance: '{used} of {allowance} {unit}',
+        noAllowance: '{used} {unit}, with no allowance',
+        day: 'per day',
+        month: 'per month',
+        resets: 'starts over {date}',
+        atAllowance: 'Allowance used up',
+        atBudget: 'Budget reached',
+        block: 'Work beyond the allowance is turned away.',
+        park: 'Work beyond the allowance waits for the next period.',
+        notSet: 'Not set',
+        progress: 'Use of {meter}'
+    },
+    plan: {
+        title: 'Plan and modules',
+        modulesTitle: 'Modules',
+        offersTitle: 'Plans and offers',
+        noModules: 'This product has no modules.',
+        noOffers: 'Nothing is on sale right now.',
+        includedSeats: '{count} seats included',
+        includedModules: 'Includes',
+        perMonth: '{price} per month',
+        perYear: '{price} per year',
+        buy: 'Buy',
+        try: 'Try',
+        changePlan: 'Change plan',
+        onTrial: 'You are on a trial with {days} days left.',
+        withSeats: 'Your plan has {seats} seats.'
+    }
+};

package/Labels/format.ts

@@ -0,0 +1,13 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/**
+ * Fills the placeholders of a label, such as `{count}`, with values. A placeholder without a value is left as it is.
+ * @param template The label.
+ * @param values The values by placeholder name.
+ * @returns The label with its placeholders filled in.
+ */
+export function format(template: string, values: Record<string, string | number>): string {
+    return template.replace(/\{(\w+)\}/g, (placeholder, name: string) =>
+        Object.hasOwn(values, name) ? String(values[name]) : placeholder);
+}

package/Labels/index.ts

@@ -0,0 +1,7 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './BoxOfficeLabels.js';
+export * from './defaultBoxOfficeLabels.js';
+export * from './resolveLabels.js';
+export * from './format.js';

package/Labels/resolveLabels.ts

@@ -0,0 +1,36 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { defaultBoxOfficeLabels } from './defaultBoxOfficeLabels.js';
+import { BoxOfficeLabelOverrides, BoxOfficeLabels } from './BoxOfficeLabels.js';
+
+/**
+ * Resolves the labels to show: the overrides given, and the English default for every label left out.
+ * @param overrides The labels a solution replaces.
+ * @returns The {@link BoxOfficeLabels}.
+ */
+export function resolveLabels(overrides?: BoxOfficeLabelOverrides): BoxOfficeLabels {
+    return merge(defaultBoxOfficeLabels, overrides) as BoxOfficeLabels;
+}
+
+function merge(defaults: object, overrides?: object): object {
+    if (!overrides) {
+        return defaults;
+    }
+
+    const merged: Record<string, unknown> = { ...defaults };
+    for (const [key, value] of Object.entries(overrides)) {
+        if (value === undefined) {
+            continue;
+        }
+
+        const defaultValue = (defaults as Record<string, unknown>)[key];
+        merged[key] = isObject(defaultValue) && isObject(value) ? merge(defaultValue, value) : value;
+    }
+
+    return merged;
+}
+
+function isObject(value: unknown): value is object {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}

package/Plan/PlanPage.tsx

@@ -0,0 +1,24 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { OnSale } from '@cratis/showrunner.boxoffice';
+import { useEntitlementsContext } from '../Entitlements/EntitlementsContext.js';
+import { PlanView } from './PlanView.js';
+
+/**
+ * The plan and modules page: where the tenant stands with its plan, which modules it has, and the offers the operator
+ * sells, with buttons that open the customer portal to buy, try or change plan. Render it inside a
+ * {@link BoxOfficeProvider}.
+ */
+export const PlanPage = () => {
+    const entitlements = useEntitlementsContext();
+    const [offers] = OnSale.use();
+
+    return (
+        <PlanView
+            entitlements={entitlements}
+            offers={offers.isSuccess ? (offers.data ?? []) : []}
+            isLoading={offers.isPerforming && !offers.isSuccess}
+            hasFailed={!offers.isPerforming && !offers.isSuccess} />
+    );
+};

package/Plan/PlanView.tsx

@@ -0,0 +1,80 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { Message, Tag } from '@cratis/components/Display';
+import { Offer, PortalIntent } from '@cratis/showrunner.boxoffice';
+import { Entitlements } from '../Entitlements/entitlementModel.js';
+import { PortalButton } from '../Portal/PortalButton.js';
+import { useBoxOfficeContext } from '../Provider/BoxOfficeContext.js';
+import { moduleRows, offerRows, planSummary } from './planModels.js';
+
+/**
+ * Props for {@link PlanView}.
+ */
+export interface PlanViewProps {
+    /** What the tenant may do. */
+    entitlements: Entitlements;
+
+    /** The offers on sale. */
+    offers: readonly Offer[];
+
+    /** Whether the offers are still loading. */
+    isLoading?: boolean;
+
+    /** Whether the offers could not be loaded. */
+    hasFailed?: boolean;
+}
+
+/**
+ * The plan and modules of the tenant: where it stands, which modules it has, and what it can buy, with buttons that
+ * open the customer portal.
+ */
+export const PlanView = ({ entitlements, offers, isLoading, hasFailed }: PlanViewProps) => {
+    const { labels, locale } = useBoxOfficeContext();
+    const modules = moduleRows(entitlements, labels, locale);
+    const offerList = offerRows(offers, entitlements, labels, locale);
+    const summary = planSummary(entitlements, labels);
+
+    return (
+        <section className='boxoffice-plan' aria-labelledby='boxoffice-plan-title'>
+            <header className='boxoffice-page__header'>
+                <h2 id='boxoffice-plan-title' className='boxoffice-page__title'>{labels.plan.title}</h2>
+            </header>
+            {summary && <p className='boxoffice-plan__summary'>{summary}</p>}
+            {!entitlements.isLoading && !entitlements.canOpenPortal && <Message severity='info'>{labels.common.noPortal}</Message>}
+
+            <h3 className='boxoffice-plan__heading'>{labels.plan.modulesTitle}</h3>
+            {modules.length === 0
+                ? <p className='boxoffice-plan__empty'>{entitlements.isLoading ? labels.common.loading : labels.plan.noModules}</p>
+                : (
+                    <ul className='boxoffice-plan__modules'>
+                        {modules.map(module => (
+                            <li key={module.standing.module} className='boxoffice-plan__module'>
+                                <span className='boxoffice-plan__name'>{module.standing.name}</span>
+                                <Tag severity={module.severity} value={module.accessText} />
+                                {module.untilText && <span className='boxoffice-plan__until'>{module.untilText}</span>}
+                                {module.canTry && <PortalButton intent={PortalIntent.try} label={labels.plan.try} variant='outline' size='small' />}
+                            </li>
+                        ))}
+                    </ul>
+                )}
+
+            <h3 className='boxoffice-plan__heading'>{labels.plan.offersTitle}</h3>
+            {hasFailed && <Message severity='error'>{labels.common.failed}</Message>}
+            {!hasFailed && offerList.length === 0 && <p className='boxoffice-plan__empty'>{isLoading ? labels.common.loading : labels.plan.noOffers}</p>}
+            <ul className='boxoffice-plan__offers'>
+                {offerList.map(row => (
+                    <li key={row.offer.id.toString()} className='boxoffice-plan__offer'>
+                        <div className='boxoffice-plan__offer-text'>
+                            <strong>{row.offer.name}</strong>
+                            {row.seatsText && <span>{row.seatsText}</span>}
+                            {row.moduleNames.length > 0 && <span>{labels.plan.includedModules}: {row.moduleNames.join(', ')}</span>}
+                            {row.prices.map(price => <span key={price} className='boxoffice-plan__price'>{price}</span>)}
+                        </div>
+                        <PortalButton intent={row.intent} offer={row.offer.id} label={row.buttonLabel} />
+                    </li>
+                ))}
+            </ul>
+        </section>
+    );
+};

package/Plan/index.ts

@@ -0,0 +1,6 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+export * from './planModels.js';
+export * from './PlanPage.js';
+export * from './PlanView.js';

package/Plan/planModels.ts

@@ -0,0 +1,127 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { BillingInterval, ModuleAccess, ModuleStanding, Offer, OfferPrice, PortalIntent } from '@cratis/showrunner.boxoffice';
+import { Entitlements } from '../Entitlements/entitlementModel.js';
+import { formatDay, formatMoney } from '../formatting.js';
+import { BoxOfficeLabels, format } from '../Labels/index.js';
+
+/** How a module's access is shown. */
+export type AccessSeverity = 'success' | 'info' | 'warn' | 'secondary';
+
+/**
+ * What the plan page shows for one module.
+ */
+export interface ModuleRowModel {
+    /** The module's standing. */
+    readonly standing: ModuleStanding;
+
+    /** What the access is called. */
+    readonly accessText: string;
+
+    /** When the access ends, in words; empty when it does not. */
+    readonly untilText: string;
+
+    /** How the access is shown. */
+    readonly severity: AccessSeverity;
+
+    /** Whether to offer to try the module. */
+    readonly canTry: boolean;
+}
+
+/**
+ * What the plan page shows for one offer.
+ */
+export interface OfferRowModel {
+    /** The offer. */
+    readonly offer: Offer;
+
+    /** The prices, in words, monthly first. */
+    readonly prices: readonly string[];
+
+    /** The seats the offer includes, in words; empty when it includes none. */
+    readonly seatsText: string;
+
+    /** The names of the modules the offer includes. */
+    readonly moduleNames: readonly string[];
+
+    /** What the offer's button opens the customer portal for. */
+    readonly intent: PortalIntent;
+
+    /** The text of the offer's button. */
+    readonly buttonLabel: string;
+}
+
+/**
+ * Lays out the modules of the plan page.
+ * @param entitlements What the tenant may do.
+ * @param labels The labels to show.
+ * @param locale The locale to format for; the browser's when not given.
+ * @returns A row for every module the product declares.
+ */
+export function moduleRows(entitlements: Entitlements, labels: BoxOfficeLabels, locale?: string): ModuleRowModel[] {
+    return entitlements.modules.map(standing => {
+        const access = standing.access;
+        return {
+            standing,
+            accessText: access === ModuleAccess.full
+                ? labels.moduleAccess.full
+                : access === ModuleAccess.trial
+                    ? labels.moduleAccess.trial
+                    : access === ModuleAccess.preview ? labels.moduleAccess.preview : labels.moduleAccess.none,
+            untilText: standing.until && access !== ModuleAccess.none
+                ? format(labels.moduleAccess.until, { date: formatDay(standing.until, locale) })
+                : '',
+            severity: access === ModuleAccess.full ? 'success' : access === ModuleAccess.trial ? 'info' : access === ModuleAccess.preview ? 'warn' : 'secondary',
+            canTry: access === ModuleAccess.none || access === ModuleAccess.preview
+        };
+    });
+}
+
+/**
+ * Says what an offer's price is.
+ * @param price The price.
+ * @param labels The labels to show.
+ * @param locale The locale to format for; the browser's when not given.
+ * @returns The price, such as "$12.00 per month".
+ */
+export function priceText(price: OfferPrice, labels: BoxOfficeLabels, locale?: string): string {
+    const money = formatMoney(price.amount, price.currency, locale);
+    return format(price.interval === BillingInterval.yearly ? labels.plan.perYear : labels.plan.perMonth, { price: money });
+}
+
+/**
+ * Lays out the offers of the plan page.
+ * @param offers The offers on sale.
+ * @param entitlements What the tenant may do.
+ * @param labels The labels to show.
+ * @param locale The locale to format for; the browser's when not given.
+ * @returns A row for every offer.
+ */
+export function offerRows(offers: readonly Offer[], entitlements: Entitlements, labels: BoxOfficeLabels, locale?: string): OfferRowModel[] {
+    const changes = entitlements.state === 'licensed';
+    return offers.map(offer => ({
+        offer,
+        prices: [...offer.prices]
+            .sort((a, b) => a.interval - b.interval)
+            .map(price => priceText(price, labels, locale)),
+        seatsText: offer.includedSeats > 0 ? format(labels.plan.includedSeats, { count: offer.includedSeats }) : '',
+        moduleNames: offer.modules.map(module => entitlements.standingOf(module)?.name ?? module),
+        intent: changes ? PortalIntent.changePlan : PortalIntent.buy,
+        buttonLabel: changes ? labels.plan.changePlan : labels.plan.buy
+    }));
+}
+
+/**
+ * Says where the tenant stands with its plan.
+ * @param entitlements What the tenant may do.
+ * @param labels The labels to show.
+ * @returns A sentence; empty when there is nothing to say.
+ */
+export function planSummary(entitlements: Entitlements, labels: BoxOfficeLabels): string {
+    if (entitlements.state === 'trial' && entitlements.trial) {
+        return format(labels.plan.onTrial, { days: Math.max(entitlements.trial.daysLeft, 0) });
+    }
+
+    return entitlements.seats > 0 ? format(labels.plan.withSeats, { seats: entitlements.seats }) : '';
+}