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

package/dist/cjs/Banners/bannerModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bannerModels.js","sources":["../../../Banners/bannerModels.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ReadOnlyReason, SeatStanding, SeatStatus, SuspensionCause } from '@cratis/showrunner.boxoffice';\nimport { Entitlements } from '../Entitlements/entitlementModel.js';\nimport { BoxOfficeLabels, format } from '../Labels/index.js';\n\n/** How loud a banner is. */\nexport type BannerSeverity = 'info' | 'warn' | 'error';\n\n/**\n * What the trial banner says.\n */\nexport interface TrialBannerModel {\n    /** How loud the banner is. */\n    readonly severity: BannerSeverity;\n\n    /** What it says. */\n    readonly text: string;\n}\n\n/** How many days before a trial ends the banner turns into a warning. */\nexport const trialWarningDays = 7;\n\n/**\n * Works out what the trial banner says.\n * @param entitlements What the tenant may do.\n * @param labels The labels to show.\n * @returns What to say; undefined when the tenant is not on a trial, or the trial is not what makes it read-only.\n */\nexport function trialBannerModel(entitlements: Entitlements, labels: BoxOfficeLabels): TrialBannerModel | undefined {\n    if (entitlements.state === 'trialClosed') {\n        return { severity: 'error', text: labels.trialBanner.closed };\n    }\n\n    if (entitlements.state !== 'trial' || !entitlements.trial) {\n        return undefined;\n    }\n\n    const { daysLeft } = entitlements.trial;\n    if (daysLeft <= 0) {\n        return { severity: 'warn', text: labels.trialBanner.lastDay };\n    }\n\n    return {\n        severity: daysLeft <= trialWarningDays ? 'warn' : 'info',\n        text: format(labels.trialBanner.running, { days: daysLeft })\n    };\n}\n\n/**\n * Says why the operator suspended a tenant.\n * @param cause The cause the operator gave.\n * @param labels The labels to show.\n * @returns The reason, in words.\n */\nexport function suspensionReason(cause: SuspensionCause | undefined, labels: BoxOfficeLabels): string {\n    switch (cause) {\n        case SuspensionCause.trialEndedWithoutSeats:\n            return labels.suspension.trialEndedWithoutSeats;\n        case SuspensionCause.paymentOverdue:\n            return labels.suspension.paymentOverdue;\n        case SuspensionCause.administratorDecision:\n            return labels.suspension.administratorDecision;\n        default:\n            return '';\n    }\n}\n\n/** Why a user is told they have no license. */\nexport type NoLicenseReason = 'suspended' | 'trialClosed' | 'noSeat' | 'overCapacity';\n\n/**\n * What a user without a license is told.\n */\nexport interface NoLicenseModel {\n    /** Why the user has no license. */\n    readonly reason: NoLicenseReason;\n\n    /** The title. */\n    readonly title: string;\n\n    /** What to do about it. */\n    readonly text: string;\n}\n\n/**\n * Works out whether the user has a license, and what to tell them if not. The tenant being read-only comes first,\n * because it holds for everyone in it.\n * @param entitlements What the tenant may do.\n * @param seat Where the user stands with the tenant's seats; nothing while it loads.\n * @param labels The labels to show.\n * @returns What to tell the user; undefined when they have a license, or it is not known yet.\n */\nexport function noLicenseModel(entitlements: Entitlements, seat: SeatStanding | undefined, labels: BoxOfficeLabels): NoLicenseModel | undefined {\n    if (entitlements.isLoading) {\n        return undefined;\n    }\n\n    if (entitlements.readOnlyReason === ReadOnlyReason.tenantSuspended) {\n        return { reason: 'suspended', title: labels.noLicense.suspendedTitle, text: labels.noLicense.suspended };\n    }\n\n    if (entitlements.readOnlyReason === ReadOnlyReason.trialClosed) {\n        return { reason: 'trialClosed', title: labels.noLicense.trialClosedTitle, text: labels.noLicense.trialClosed };\n    }\n\n    if (seat?.status === SeatStatus.noSeat) {\n        return { reason: 'noSeat', title: labels.noLicense.noSeatTitle, text: labels.noLicense.noSeat };\n    }\n\n    if (seat?.status === SeatStatus.overCapacity) {\n        return { reason: 'overCapacity', title: labels.noLicense.overCapacityTitle, text: labels.noLicense.overCapacity };\n    }\n\n    return undefined;\n}\n"],"names":["trialWarningDays","trialBannerModel","entitlements","labels","state","severity","text","trialBanner","closed","trial","undefined","daysLeft","lastDay","format","running","days","suspensionReason","cause","SuspensionCause","trialEndedWithoutSeats","suspension","paymentOverdue","administratorDecision","noLicenseModel","seat","isLoading","readOnlyReason","ReadOnlyReason","tenantSuspended","reason","title","noLicense","suspendedTitle","suspended","trialClosed","trialClosedTitle","status","SeatStatus","noSeat","noSeatTitle","overCapacity","overCapacityTitle"],"mappings":";;;;;AAAA;AACA;AAoBA,0EACO,MAAMA,gBAAAA,GAAmB;AAEhC;;;;;AAKC,IACM,SAASC,gBAAAA,CAAiBC,YAA0B,EAAEC,MAAuB,EAAA;IAChF,IAAID,YAAAA,CAAaE,KAAK,KAAK,aAAA,EAAe;QACtC,OAAO;YAAEC,QAAAA,EAAU,OAAA;YAASC,IAAAA,EAAMH,MAAAA,CAAOI,WAAW,CAACC;AAAO,SAAA;AAChE,IAAA;AAEA,IAAA,IAAIN,aAAaE,KAAK,KAAK,WAAW,CAACF,YAAAA,CAAaO,KAAK,EAAE;QACvD,OAAOC,SAAAA;AACX,IAAA;AAEA,IAAA,MAAM,EAAEC,QAAQ,EAAE,GAAGT,aAAaO,KAAK;AACvC,IAAA,IAAIE,YAAY,CAAA,EAAG;QACf,OAAO;YAAEN,QAAAA,EAAU,MAAA;YAAQC,IAAAA,EAAMH,MAAAA,CAAOI,WAAW,CAACK;AAAQ,SAAA;AAChE,IAAA;IAEA,OAAO;QACHP,QAAAA,EAAUM,QAAAA,IAAYX,mBAAmB,MAAA,GAAS,MAAA;AAClDM,QAAAA,IAAAA,EAAMO,aAAAA,CAAOV,MAAAA,CAAOI,WAAW,CAACO,OAAO,EAAE;YAAEC,IAAAA,EAAMJ;AAAS,SAAA;AAC9D,KAAA;AACJ;AAEA;;;;;AAKC,IACM,SAASK,gBAAAA,CAAiBC,KAAkC,EAAEd,MAAuB,EAAA;IACxF,OAAQc,KAAAA;AACJ,QAAA,KAAKC,qCAAgBC,sBAAsB;YACvC,OAAOhB,MAAAA,CAAOiB,UAAU,CAACD,sBAAsB;AACnD,QAAA,KAAKD,qCAAgBG,cAAc;YAC/B,OAAOlB,MAAAA,CAAOiB,UAAU,CAACC,cAAc;AAC3C,QAAA,KAAKH,qCAAgBI,qBAAqB;YACtC,OAAOnB,MAAAA,CAAOiB,UAAU,CAACE,qBAAqB;AAClD,QAAA;YACI,OAAO,EAAA;AACf;AACJ;AAmBA;;;;;;;AAOC,IACM,SAASC,cAAAA,CAAerB,YAA0B,EAAEsB,IAA8B,EAAErB,MAAuB,EAAA;IAC9G,IAAID,YAAAA,CAAauB,SAAS,EAAE;QACxB,OAAOf,SAAAA;AACX,IAAA;AAEA,IAAA,IAAIR,YAAAA,CAAawB,cAAc,KAAKC,mCAAAA,CAAeC,eAAe,EAAE;QAChE,OAAO;YAAEC,MAAAA,EAAQ,WAAA;YAAaC,KAAAA,EAAO3B,MAAAA,CAAO4B,SAAS,CAACC,cAAc;YAAE1B,IAAAA,EAAMH,MAAAA,CAAO4B,SAAS,CAACE;AAAU,SAAA;AAC3G,IAAA;AAEA,IAAA,IAAI/B,YAAAA,CAAawB,cAAc,KAAKC,mCAAAA,CAAeO,WAAW,EAAE;QAC5D,OAAO;YAAEL,MAAAA,EAAQ,aAAA;YAAeC,KAAAA,EAAO3B,MAAAA,CAAO4B,SAAS,CAACI,gBAAgB;YAAE7B,IAAAA,EAAMH,MAAAA,CAAO4B,SAAS,CAACG;AAAY,SAAA;AACjH,IAAA;AAEA,IAAA,IAAIV,IAAAA,EAAMY,MAAAA,KAAWC,+BAAAA,CAAWC,MAAM,EAAE;QACpC,OAAO;YAAET,MAAAA,EAAQ,QAAA;YAAUC,KAAAA,EAAO3B,MAAAA,CAAO4B,SAAS,CAACQ,WAAW;YAAEjC,IAAAA,EAAMH,MAAAA,CAAO4B,SAAS,CAACO;AAAO,SAAA;AAClG,IAAA;AAEA,IAAA,IAAId,IAAAA,EAAMY,MAAAA,KAAWC,+BAAAA,CAAWG,YAAY,EAAE;QAC1C,OAAO;YAAEX,MAAAA,EAAQ,cAAA;YAAgBC,KAAAA,EAAO3B,MAAAA,CAAO4B,SAAS,CAACU,iBAAiB;YAAEnC,IAAAA,EAAMH,MAAAA,CAAO4B,SAAS,CAACS;AAAa,SAAA;AACpH,IAAA;IAEA,OAAO9B,SAAAA;AACX;;;;;"}

package/dist/cjs/Banners/index.d.ts

@@ -0,0 +1,5 @@
+export * from './bannerModels.js';
+export * from './NoLicense.js';
+export * from './SuspensionBanner.js';
+export * from './TrialBanner.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/Banners/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../Banners/index.ts"],"names":[],"mappings":"AAGA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC"}

package/dist/cjs/Entitlements/EntitlementsContext.d.ts

@@ -0,0 +1,4 @@
+import { Entitlements } from './entitlementModel.js';
+export declare const EntitlementsContext: import("react").Context<Entitlements>;
+export declare const useEntitlementsContext: () => Entitlements;
+//# sourceMappingURL=EntitlementsContext.d.ts.map

package/dist/cjs/Entitlements/EntitlementsContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntitlementsContext.d.ts","sourceRoot":"","sources":["../../../Entitlements/EntitlementsContext.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAkB,MAAM,uBAAuB,CAAC;AAMrE,eAAO,MAAM,mBAAmB,uCAAyD,CAAC;AAM1F,eAAO,MAAM,sBAAsB,QAAO,YAA+C,CAAC"}

package/dist/cjs/Entitlements/EntitlementsContext.js

@@ -0,0 +1,19 @@
+'use strict';
+
+var react = require('react');
+var entitlementModel = require('./entitlementModel.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * The React context {@link BoxOfficeProvider} provides the entitlements through. Without a provider nothing is
+ * known, so nothing that belongs to a module is shown.
+ */ const EntitlementsContext = react.createContext(entitlementModel.entitlementsOf(undefined));
+/**
+ * Gets what the tenant may do.
+ * @returns The {@link Entitlements}.
+ */ const useEntitlementsContext = ()=>react.useContext(EntitlementsContext);
+
+exports.EntitlementsContext = EntitlementsContext;
+exports.useEntitlementsContext = useEntitlementsContext;
+//# sourceMappingURL=EntitlementsContext.js.map

package/dist/cjs/Entitlements/EntitlementsContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntitlementsContext.js","sources":["../../../Entitlements/EntitlementsContext.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { createContext, useContext } from 'react';\nimport { Entitlements, entitlementsOf } from './entitlementModel.js';\n\n/**\n * The React context {@link BoxOfficeProvider} provides the entitlements through. Without a provider nothing is\n * known, so nothing that belongs to a module is shown.\n */\nexport const EntitlementsContext = createContext<Entitlements>(entitlementsOf(undefined));\n\n/**\n * Gets what the tenant may do.\n * @returns The {@link Entitlements}.\n */\nexport const useEntitlementsContext = (): Entitlements => useContext(EntitlementsContext);\n"],"names":["EntitlementsContext","createContext","entitlementsOf","undefined","useEntitlementsContext","useContext"],"mappings":";;;;;AAAA;AACA;AAKA;;;AAGC,IACM,MAAMA,mBAAAA,GAAsBC,mBAAAA,CAA4BC,gCAAeC,SAAAA,CAAAA;AAE9E;;;AAGC,IACM,MAAMC,sBAAAA,GAAyB,IAAoBC,iBAAWL,mBAAAA;;;"}

package/dist/cjs/Entitlements/RequiresModule.d.ts

@@ -0,0 +1,9 @@
+import { ReactNode } from 'react';
+export interface RequiresModuleProps {
+    module: string;
+    mode?: 'hide' | 'explain';
+    fallback?: ReactNode;
+    children?: ReactNode;
+}
+export declare const RequiresModule: ({ module, mode, fallback, children }: RequiresModuleProps) => import("react").JSX.Element | null;
+//# sourceMappingURL=RequiresModule.d.ts.map

package/dist/cjs/Entitlements/RequiresModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequiresModule.d.ts","sourceRoot":"","sources":["../../../Entitlements/RequiresModule.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AASlC,MAAM,WAAW,mBAAmB;IAEhC,MAAM,EAAE,MAAM,CAAC;IAMf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAG1B,QAAQ,CAAC,EAAE,SAAS,CAAC;IAGrB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACxB;AAOD,eAAO,MAAM,cAAc,GAAI,sCAA+C,mBAAmB,uCA+BhG,CAAC"}

package/dist/cjs/Entitlements/RequiresModule.js

@@ -0,0 +1,68 @@
+'use strict';
+
+var jsxRuntime = require('react/jsx-runtime');
+var Display = require('@cratis/components/Display');
+var showrunner_boxoffice = require('@cratis/showrunner.boxoffice');
+var PortalButton = require('../Portal/PortalButton.js');
+var BoxOfficeContext = require('../Provider/BoxOfficeContext.js');
+var EntitlementsContext = require('./EntitlementsContext.js');
+var requiresModuleModel = require('./requiresModuleModel.js');
+
+/**
+ * Shows its content only when the tenant has the module, in full or on trial. Nothing is shown while the entitlements
+ * load, so the content never flashes up and is taken away. The backend refuses the module's commands and queries on its
+ * own; this is what keeps the user from meeting the refusal.
+ */ const RequiresModule = ({ module, mode = 'hide', fallback, children })=>{
+    const entitlements = EntitlementsContext.useEntitlementsContext();
+    const labels = BoxOfficeContext.useBoxOfficeLabels();
+    if (entitlements.isLoading) {
+        return null;
+    }
+    const model = requiresModuleModel.requiresModuleModel(entitlements, module, labels);
+    if (model.hasModule) {
+        return /*#__PURE__*/ jsxRuntime.jsx(jsxRuntime.Fragment, {
+            children: children
+        });
+    }
+    if (mode === 'hide') {
+        return /*#__PURE__*/ jsxRuntime.jsx(jsxRuntime.Fragment, {
+            children: fallback
+        });
+    }
+    return /*#__PURE__*/ jsxRuntime.jsxs("div", {
+        className: "boxoffice-requires-module",
+        children: [
+            /*#__PURE__*/ jsxRuntime.jsx(Display.Message, {
+                severity: "info",
+                children: /*#__PURE__*/ jsxRuntime.jsxs("div", {
+                    className: "boxoffice-requires-module__text",
+                    children: [
+                        /*#__PURE__*/ jsxRuntime.jsx("strong", {
+                            children: model.title
+                        }),
+                        /*#__PURE__*/ jsxRuntime.jsx("span", {
+                            children: model.text
+                        })
+                    ]
+                })
+            }),
+            /*#__PURE__*/ jsxRuntime.jsxs("div", {
+                className: "boxoffice-requires-module__actions",
+                children: [
+                    model.canTry && /*#__PURE__*/ jsxRuntime.jsx(PortalButton.PortalButton, {
+                        intent: showrunner_boxoffice.PortalIntent.try,
+                        label: labels.requiresModule.try,
+                        variant: "outline"
+                    }),
+                    /*#__PURE__*/ jsxRuntime.jsx(PortalButton.PortalButton, {
+                        intent: showrunner_boxoffice.PortalIntent.buy,
+                        label: labels.requiresModule.buy
+                    })
+                ]
+            })
+        ]
+    });
+};
+
+exports.RequiresModule = RequiresModule;
+//# sourceMappingURL=RequiresModule.js.map

package/dist/cjs/Entitlements/RequiresModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequiresModule.js","sources":["../../../Entitlements/RequiresModule.tsx"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { Message } from '@cratis/components/Display';\nimport { PortalIntent } from '@cratis/showrunner.boxoffice';\nimport { ReactNode } from 'react';\nimport { PortalButton } from '../Portal/PortalButton.js';\nimport { useBoxOfficeLabels } from '../Provider/BoxOfficeContext.js';\nimport { useEntitlementsContext } from './EntitlementsContext.js';\nimport { requiresModuleModel } from './requiresModuleModel.js';\n\n/**\n * Props for {@link RequiresModule}.\n */\nexport interface RequiresModuleProps {\n    /** The module whose content this is. */\n    module: string;\n\n    /**\n     * What to do when the tenant does not have the module: `hide` shows the fallback, which is nothing unless given;\n     * `explain` says why it is not there, and offers to try or buy it. Defaults to `hide`.\n     */\n    mode?: 'hide' | 'explain';\n\n    /** What to show instead of the content in `hide` mode. Nothing when not given. */\n    fallback?: ReactNode;\n\n    /** The content of the module. */\n    children?: ReactNode;\n}\n\n/**\n * Shows its content only when the tenant has the module, in full or on trial. Nothing is shown while the entitlements\n * load, so the content never flashes up and is taken away. The backend refuses the module's commands and queries on its\n * own; this is what keeps the user from meeting the refusal.\n */\nexport const RequiresModule = ({ module, mode = 'hide', fallback, children }: RequiresModuleProps) => {\n    const entitlements = useEntitlementsContext();\n    const labels = useBoxOfficeLabels();\n\n    if (entitlements.isLoading) {\n        return null;\n    }\n\n    const model = requiresModuleModel(entitlements, module, labels);\n    if (model.hasModule) {\n        return <>{children}</>;\n    }\n\n    if (mode === 'hide') {\n        return <>{fallback}</>;\n    }\n\n    return (\n        <div className='boxoffice-requires-module'>\n            <Message severity='info'>\n                <div className='boxoffice-requires-module__text'>\n                    <strong>{model.title}</strong>\n                    <span>{model.text}</span>\n                </div>\n            </Message>\n            <div className='boxoffice-requires-module__actions'>\n                {model.canTry && <PortalButton intent={PortalIntent.try} label={labels.requiresModule.try} variant='outline' />}\n                <PortalButton intent={PortalIntent.buy} label={labels.requiresModule.buy} />\n            </div>\n        </div>\n    );\n};\n"],"names":["RequiresModule","module","mode","fallback","children","entitlements","useEntitlementsContext","labels","useBoxOfficeLabels","isLoading","model","requiresModuleModel","hasModule","_jsx","_Fragment","_jsxs","div","className","Message","severity","strong","title","span","text","canTry","PortalButton","intent","PortalIntent","try","label","requiresModule","variant","buy"],"mappings":";;;;;;;;;;AA+BA;;;;AAIC,IACM,MAAMA,cAAAA,GAAiB,CAAC,EAAEC,MAAM,EAAEC,IAAAA,GAAO,MAAM,EAAEC,QAAQ,EAAEC,QAAQ,EAAuB,GAAA;AAC7F,IAAA,MAAMC,YAAAA,GAAeC,0CAAAA,EAAAA;AACrB,IAAA,MAAMC,MAAAA,GAASC,mCAAAA,EAAAA;IAEf,IAAIH,YAAAA,CAAaI,SAAS,EAAE;QACxB,OAAO,IAAA;AACX,IAAA;IAEA,MAAMC,KAAAA,GAAQC,uCAAAA,CAAoBN,YAAAA,EAAcJ,MAAAA,EAAQM,MAAAA,CAAAA;IACxD,IAAIG,KAAAA,CAAME,SAAS,EAAE;QACjB,qBAAOC,cAAA,CAAAC,mBAAA,EAAA;AAAGV,YAAAA,QAAAA,EAAAA;;AACd,IAAA;AAEA,IAAA,IAAIF,SAAS,MAAA,EAAQ;QACjB,qBAAOW,cAAA,CAAAC,mBAAA,EAAA;AAAGX,YAAAA,QAAAA,EAAAA;;AACd,IAAA;AAEA,IAAA,qBACIY,eAAA,CAACC,KAAAA,EAAAA;QAAIC,SAAAA,EAAU,2BAAA;;0BACXJ,cAAA,CAACK,eAAAA,EAAAA;gBAAQC,QAAAA,EAAS,MAAA;AACd,gBAAA,QAAA,gBAAAJ,eAAA,CAACC,KAAAA,EAAAA;oBAAIC,SAAAA,EAAU,iCAAA;;sCACXJ,cAAA,CAACO,QAAAA,EAAAA;AAAQV,4BAAAA,QAAAA,EAAAA,KAAAA,CAAMW;;sCACfR,cAAA,CAACS,MAAAA,EAAAA;AAAMZ,4BAAAA,QAAAA,EAAAA,KAAAA,CAAMa;;;;;0BAGrBR,eAAA,CAACC,KAAAA,EAAAA;gBAAIC,SAAAA,EAAU,oCAAA;;oBACVP,KAAAA,CAAMc,MAAM,kBAAIX,cAAA,CAACY,yBAAAA,EAAAA;AAAaC,wBAAAA,MAAAA,EAAQC,kCAAaC,GAAG;wBAAEC,KAAAA,EAAOtB,MAAAA,CAAOuB,cAAc,CAACF,GAAG;wBAAEG,OAAAA,EAAQ;;kCACnGlB,cAAA,CAACY,yBAAAA,EAAAA;AAAaC,wBAAAA,MAAAA,EAAQC,kCAAaK,GAAG;wBAAEH,KAAAA,EAAOtB,MAAAA,CAAOuB,cAAc,CAACE;;;;;;AAIrF;;"}

package/dist/cjs/Entitlements/entitlementModel.d.ts

@@ -0,0 +1,25 @@
+import { DateOnly } from '@cratis/fundamentals';
+import { EntitlementSummary, ModuleAccess, ModuleStanding, ReadOnlyReason } from '@cratis/showrunner.boxoffice';
+export type LicenseState = 'loading' | 'suspended' | 'trialClosed' | 'trial' | 'licensed' | 'unlicensed';
+export interface TrialStanding {
+    readonly ends: Date;
+    readonly daysLeft: number;
+    readonly isClosed: boolean;
+}
+export interface Entitlements {
+    readonly isLoading: boolean;
+    readonly state: LicenseState;
+    readonly isReadOnly: boolean;
+    readonly readOnlyReason: ReadOnlyReason;
+    readonly seats: number;
+    readonly trial?: TrialStanding;
+    readonly canOpenPortal: boolean;
+    readonly modules: readonly ModuleStanding[];
+    has(module: string): boolean;
+    accessTo(module: string): ModuleAccess;
+    standingOf(module: string): ModuleStanding | undefined;
+}
+export declare function toDate(day: DateOnly | Date | string | undefined): Date | undefined;
+export declare function daysBetween(from: Date, to: Date): number;
+export declare function entitlementsOf(summary: EntitlementSummary | undefined, today?: Date): Entitlements;
+//# sourceMappingURL=entitlementModel.d.ts.map

package/dist/cjs/Entitlements/entitlementModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlementModel.d.ts","sourceRoot":"","sources":["../../../Entitlements/entitlementModel.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAYhH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,aAAa,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,CAAC;AAKzG,MAAM,WAAW,aAAa;IAE1B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAGpB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAG1B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC9B;AAKD,MAAM,WAAW,YAAY;IAEzB,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAG5B,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAG7B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAG7B,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAGxC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAGvB,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC;IAG/B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAGhC,QAAQ,CAAC,OAAO,EAAE,SAAS,cAAc,EAAE,CAAC;IAO5C,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IAO7B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC;IAOvC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAAC;CAC1D;AASD,wBAAgB,MAAM,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,SAAS,CAWlF;AAQD,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,GAAG,MAAM,CAIxD;AAwBD,wBAAgB,cAAc,CAAC,OAAO,EAAE,kBAAkB,GAAG,SAAS,EAAE,KAAK,GAAE,IAAiB,GAAG,YAAY,CAsC9G"}

package/dist/cjs/Entitlements/entitlementModel.js

@@ -0,0 +1,93 @@
+'use strict';
+
+var fundamentals = require('@cratis/fundamentals');
+var showrunner_boxoffice = require('@cratis/showrunner.boxoffice');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+const millisecondsInADay = 24 * 60 * 60 * 1000;
+/**
+ * Turns a day from a proxy into a date.
+ * @param day The day: a `DateOnly`, a `yyyy-mm-dd` text, or a date.
+ * @returns The date at midnight local time; undefined when there is no day.
+ */ function toDate(day) {
+    if (day === undefined || day === null) {
+        return undefined;
+    }
+    if (day instanceof Date) {
+        return new Date(day.getFullYear(), day.getMonth(), day.getDate());
+    }
+    const dateOnly = typeof day === 'string' ? fundamentals.DateOnly.parse(day.substring(0, 10)) : day;
+    return dateOnly.toDate();
+}
+/**
+ * Counts the days from one day to another, ignoring the time of day.
+ * @param from The day to count from.
+ * @param to The day to count to.
+ * @returns How many days `to` is after `from`; less than zero when it is before.
+ */ function daysBetween(from, to) {
+    const start = Date.UTC(from.getFullYear(), from.getMonth(), from.getDate());
+    const end = Date.UTC(to.getFullYear(), to.getMonth(), to.getDate());
+    return Math.round((end - start) / millisecondsInADay);
+}
+function stateOf(summary, trial) {
+    if (summary.readOnlyReason === showrunner_boxoffice.ReadOnlyReason.tenantSuspended) {
+        return 'suspended';
+    }
+    if (summary.readOnlyReason === showrunner_boxoffice.ReadOnlyReason.trialClosed) {
+        return 'trialClosed';
+    }
+    if (summary.isTrial && trial && !trial.isClosed) {
+        return 'trial';
+    }
+    return summary.seats > 0 ? 'licensed' : 'unlicensed';
+}
+/**
+ * Works out what a tenant may do from what the backend says.
+ * @param summary The entitlement summary; nothing while it loads.
+ * @param today The day it is. Defaults to today.
+ * @returns The {@link Entitlements}.
+ */ function entitlementsOf(summary, today = new Date()) {
+    if (!summary) {
+        return {
+            isLoading: true,
+            state: 'loading',
+            isReadOnly: false,
+            readOnlyReason: showrunner_boxoffice.ReadOnlyReason.none,
+            seats: 0,
+            canOpenPortal: false,
+            modules: [],
+            has: ()=>false,
+            accessTo: ()=>showrunner_boxoffice.ModuleAccess.none,
+            standingOf: ()=>undefined
+        };
+    }
+    const modules = summary.modules ?? [];
+    const ends = summary.isTrial ? toDate(summary.trialEnds) : undefined;
+    const daysLeft = ends ? daysBetween(today, ends) : 0;
+    const trial = ends ? {
+        ends,
+        daysLeft,
+        isClosed: daysLeft < 0 || summary.readOnlyReason === showrunner_boxoffice.ReadOnlyReason.trialClosed
+    } : undefined;
+    const standingOf = (module)=>modules.find((_)=>_.module === module);
+    const accessTo = (module)=>standingOf(module)?.access ?? showrunner_boxoffice.ModuleAccess.none;
+    return {
+        isLoading: false,
+        state: stateOf(summary, trial),
+        isReadOnly: summary.readOnlyReason !== showrunner_boxoffice.ReadOnlyReason.none,
+        readOnlyReason: summary.readOnlyReason,
+        seats: summary.seats,
+        trial,
+        canOpenPortal: summary.canOpenPortal,
+        modules,
+        has: (module)=>accessTo(module) === showrunner_boxoffice.ModuleAccess.trial || accessTo(module) === showrunner_boxoffice.ModuleAccess.full,
+        accessTo,
+        standingOf
+    };
+}
+
+exports.daysBetween = daysBetween;
+exports.entitlementsOf = entitlementsOf;
+exports.toDate = toDate;
+//# sourceMappingURL=entitlementModel.js.map

package/dist/cjs/Entitlements/entitlementModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlementModel.js","sources":["../../../Entitlements/entitlementModel.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { DateOnly } from '@cratis/fundamentals';\nimport { EntitlementSummary, ModuleAccess, ModuleStanding, ReadOnlyReason } from '@cratis/showrunner.boxoffice';\n\n/**\n * Where a tenant stands with its license, as one word.\n *\n * - `loading`: nothing is known yet.\n * - `suspended`: the operator suspended the tenant; it is read-only.\n * - `trialClosed`: the trial ended without seats being bought; the tenant is read-only.\n * - `trial`: the tenant is on a trial that runs.\n * - `licensed`: the tenant has bought seats.\n * - `unlicensed`: the tenant has no seats and is not on a trial.\n */\nexport type LicenseState = 'loading' | 'suspended' | 'trialClosed' | 'trial' | 'licensed' | 'unlicensed';\n\n/**\n * A trial that is running or has closed.\n */\nexport interface TrialStanding {\n    /** The last day of the trial. */\n    readonly ends: Date;\n\n    /** How many days are left; zero on the last day, and less than zero after it. */\n    readonly daysLeft: number;\n\n    /** Whether the trial has closed. */\n    readonly isClosed: boolean;\n}\n\n/**\n * What a tenant may do, for a component to decide what to show.\n */\nexport interface Entitlements {\n    /** Whether nothing is known about the tenant yet. */\n    readonly isLoading: boolean;\n\n    /** Where the tenant stands with its license. */\n    readonly state: LicenseState;\n\n    /** Whether the tenant can read but not change anything. */\n    readonly isReadOnly: boolean;\n\n    /** Why the tenant is read-only; none when it is not. */\n    readonly readOnlyReason: ReadOnlyReason;\n\n    /** How many seats the tenant has today. */\n    readonly seats: number;\n\n    /** The trial, when the tenant is on one or was. */\n    readonly trial?: TrialStanding;\n\n    /** Whether the product has a customer portal to buy, try and change plan in. */\n    readonly canOpenPortal: boolean;\n\n    /** Every module the product declares, and what the tenant may do with it. */\n    readonly modules: readonly ModuleStanding[];\n\n    /**\n     * Gets whether the tenant has a module: in full or on trial. A preview does not count.\n     * @param module The module.\n     * @returns True when the tenant has the module.\n     */\n    has(module: string): boolean;\n\n    /**\n     * Gets the access the tenant has to a module.\n     * @param module The module.\n     * @returns The access; none for a module the product does not declare.\n     */\n    accessTo(module: string): ModuleAccess;\n\n    /**\n     * Gets what the tenant may do with a module.\n     * @param module The module.\n     * @returns The standing, or undefined for a module the product does not declare.\n     */\n    standingOf(module: string): ModuleStanding | undefined;\n}\n\nconst millisecondsInADay = 24 * 60 * 60 * 1000;\n\n/**\n * Turns a day from a proxy into a date.\n * @param day The day: a `DateOnly`, a `yyyy-mm-dd` text, or a date.\n * @returns The date at midnight local time; undefined when there is no day.\n */\nexport function toDate(day: DateOnly | Date | string | undefined): Date | undefined {\n    if (day === undefined || day === null) {\n        return undefined;\n    }\n\n    if (day instanceof Date) {\n        return new Date(day.getFullYear(), day.getMonth(), day.getDate());\n    }\n\n    const dateOnly = typeof day === 'string' ? DateOnly.parse(day.substring(0, 10)) : day;\n    return dateOnly.toDate();\n}\n\n/**\n * Counts the days from one day to another, ignoring the time of day.\n * @param from The day to count from.\n * @param to The day to count to.\n * @returns How many days `to` is after `from`; less than zero when it is before.\n */\nexport function daysBetween(from: Date, to: Date): number {\n    const start = Date.UTC(from.getFullYear(), from.getMonth(), from.getDate());\n    const end = Date.UTC(to.getFullYear(), to.getMonth(), to.getDate());\n    return Math.round((end - start) / millisecondsInADay);\n}\n\nfunction stateOf(summary: EntitlementSummary, trial: TrialStanding | undefined): LicenseState {\n    if (summary.readOnlyReason === ReadOnlyReason.tenantSuspended) {\n        return 'suspended';\n    }\n\n    if (summary.readOnlyReason === ReadOnlyReason.trialClosed) {\n        return 'trialClosed';\n    }\n\n    if (summary.isTrial && trial && !trial.isClosed) {\n        return 'trial';\n    }\n\n    return summary.seats > 0 ? 'licensed' : 'unlicensed';\n}\n\n/**\n * Works out what a tenant may do from what the backend says.\n * @param summary The entitlement summary; nothing while it loads.\n * @param today The day it is. Defaults to today.\n * @returns The {@link Entitlements}.\n */\nexport function entitlementsOf(summary: EntitlementSummary | undefined, today: Date = new Date()): Entitlements {\n    if (!summary) {\n        return {\n            isLoading: true,\n            state: 'loading',\n            isReadOnly: false,\n            readOnlyReason: ReadOnlyReason.none,\n            seats: 0,\n            canOpenPortal: false,\n            modules: [],\n            has: () => false,\n            accessTo: () => ModuleAccess.none,\n            standingOf: () => undefined\n        };\n    }\n\n    const modules = summary.modules ?? [];\n    const ends = summary.isTrial ? toDate(summary.trialEnds) : undefined;\n    const daysLeft = ends ? daysBetween(today, ends) : 0;\n    const trial = ends\n        ? { ends, daysLeft, isClosed: daysLeft < 0 || summary.readOnlyReason === ReadOnlyReason.trialClosed }\n        : undefined;\n    const standingOf = (module: string) => modules.find(_ => _.module === module);\n    const accessTo = (module: string) => standingOf(module)?.access ?? ModuleAccess.none;\n\n    return {\n        isLoading: false,\n        state: stateOf(summary, trial),\n        isReadOnly: summary.readOnlyReason !== ReadOnlyReason.none,\n        readOnlyReason: summary.readOnlyReason,\n        seats: summary.seats,\n        trial,\n        canOpenPortal: summary.canOpenPortal,\n        modules,\n        has: module => accessTo(module) === ModuleAccess.trial || accessTo(module) === ModuleAccess.full,\n        accessTo,\n        standingOf\n    };\n}\n"],"names":["millisecondsInADay","toDate","day","undefined","Date","getFullYear","getMonth","getDate","dateOnly","DateOnly","parse","substring","daysBetween","from","to","start","UTC","end","Math","round","stateOf","summary","trial","readOnlyReason","ReadOnlyReason","tenantSuspended","trialClosed","isTrial","isClosed","seats","entitlementsOf","today","isLoading","state","isReadOnly","none","canOpenPortal","modules","has","accessTo","ModuleAccess","standingOf","ends","trialEnds","daysLeft","module","find","_","access","full"],"mappings":";;;;;AAAA;AACA;AAiFA,MAAMA,kBAAAA,GAAqB,EAAA,GAAK,EAAA,GAAK,EAAA,GAAK,IAAA;AAE1C;;;;IAKO,SAASC,MAAAA,CAAOC,GAAyC,EAAA;IAC5D,IAAIA,GAAAA,KAAQC,SAAAA,IAAaD,GAAAA,KAAQ,IAAA,EAAM;QACnC,OAAOC,SAAAA;AACX,IAAA;AAEA,IAAA,IAAID,eAAeE,IAAAA,EAAM;QACrB,OAAO,IAAIA,KAAKF,GAAAA,CAAIG,WAAW,IAAIH,GAAAA,CAAII,QAAQ,EAAA,EAAIJ,GAAAA,CAAIK,OAAO,EAAA,CAAA;AAClE,IAAA;IAEA,MAAMC,QAAAA,GAAW,OAAON,GAAAA,KAAQ,QAAA,GAAWO,qBAAAA,CAASC,KAAK,CAACR,GAAAA,CAAIS,SAAS,CAAC,CAAA,EAAG,EAAA,CAAA,CAAA,GAAOT,GAAAA;AAClF,IAAA,OAAOM,SAASP,MAAM,EAAA;AAC1B;AAEA;;;;;AAKC,IACM,SAASW,WAAAA,CAAYC,IAAU,EAAEC,EAAQ,EAAA;IAC5C,MAAMC,KAAAA,GAAQX,IAAAA,CAAKY,GAAG,CAACH,IAAAA,CAAKR,WAAW,EAAA,EAAIQ,IAAAA,CAAKP,QAAQ,EAAA,EAAIO,IAAAA,CAAKN,OAAO,EAAA,CAAA;IACxE,MAAMU,GAAAA,GAAMb,IAAAA,CAAKY,GAAG,CAACF,EAAAA,CAAGT,WAAW,EAAA,EAAIS,EAAAA,CAAGR,QAAQ,EAAA,EAAIQ,EAAAA,CAAGP,OAAO,EAAA,CAAA;AAChE,IAAA,OAAOW,KAAKC,KAAK,CAAC,CAACF,GAAAA,GAAMF,KAAI,IAAKf,kBAAAA,CAAAA;AACtC;AAEA,SAASoB,OAAAA,CAAQC,OAA2B,EAAEC,KAAgC,EAAA;AAC1E,IAAA,IAAID,OAAAA,CAAQE,cAAc,KAAKC,mCAAAA,CAAeC,eAAe,EAAE;QAC3D,OAAO,WAAA;AACX,IAAA;AAEA,IAAA,IAAIJ,OAAAA,CAAQE,cAAc,KAAKC,mCAAAA,CAAeE,WAAW,EAAE;QACvD,OAAO,aAAA;AACX,IAAA;AAEA,IAAA,IAAIL,QAAQM,OAAO,IAAIL,SAAS,CAACA,KAAAA,CAAMM,QAAQ,EAAE;QAC7C,OAAO,OAAA;AACX,IAAA;AAEA,IAAA,OAAOP,OAAAA,CAAQQ,KAAK,GAAG,CAAA,GAAI,UAAA,GAAa,YAAA;AAC5C;AAEA;;;;;AAKC,IACM,SAASC,cAAAA,CAAeT,OAAuC,EAAEU,KAAAA,GAAc,IAAI3B,IAAAA,EAAM,EAAA;AAC5F,IAAA,IAAI,CAACiB,OAAAA,EAAS;QACV,OAAO;YACHW,SAAAA,EAAW,IAAA;YACXC,KAAAA,EAAO,SAAA;YACPC,UAAAA,EAAY,KAAA;AACZX,YAAAA,cAAAA,EAAgBC,oCAAeW,IAAI;YACnCN,KAAAA,EAAO,CAAA;YACPO,aAAAA,EAAe,KAAA;AACfC,YAAAA,OAAAA,EAAS,EAAE;AACXC,YAAAA,GAAAA,EAAK,IAAM,KAAA;YACXC,QAAAA,EAAU,IAAMC,kCAAaL,IAAI;AACjCM,YAAAA,UAAAA,EAAY,IAAMtC;AACtB,SAAA;AACJ,IAAA;AAEA,IAAA,MAAMkC,OAAAA,GAAUhB,OAAAA,CAAQgB,OAAO,IAAI,EAAE;AACrC,IAAA,MAAMK,OAAOrB,OAAAA,CAAQM,OAAO,GAAG1B,MAAAA,CAAOoB,OAAAA,CAAQsB,SAAS,CAAA,GAAIxC,SAAAA;AAC3D,IAAA,MAAMyC,QAAAA,GAAWF,IAAAA,GAAO9B,WAAAA,CAAYmB,KAAAA,EAAOW,IAAAA,CAAAA,GAAQ,CAAA;AACnD,IAAA,MAAMpB,QAAQoB,IAAAA,GACR;AAAEA,QAAAA,IAAAA;AAAME,QAAAA,QAAAA;AAAUhB,QAAAA,QAAAA,EAAUgB,WAAW,CAAA,IAAKvB,OAAAA,CAAQE,cAAc,KAAKC,oCAAeE;KAAY,GAClGvB,SAAAA;IACN,MAAMsC,UAAAA,GAAa,CAACI,MAAAA,GAAmBR,OAAAA,CAAQS,IAAI,CAACC,CAAAA,CAAAA,GAAKA,CAAAA,CAAEF,MAAM,KAAKA,MAAAA,CAAAA;AACtE,IAAA,MAAMN,WAAW,CAACM,MAAAA,GAAmBJ,WAAWI,MAAAA,CAAAA,EAASG,MAAAA,IAAUR,kCAAaL,IAAI;IAEpF,OAAO;QACHH,SAAAA,EAAW,KAAA;AACXC,QAAAA,KAAAA,EAAOb,QAAQC,OAAAA,EAASC,KAAAA,CAAAA;AACxBY,QAAAA,UAAAA,EAAYb,OAAAA,CAAQE,cAAc,KAAKC,mCAAAA,CAAeW,IAAI;AAC1DZ,QAAAA,cAAAA,EAAgBF,QAAQE,cAAc;AACtCM,QAAAA,KAAAA,EAAOR,QAAQQ,KAAK;AACpBP,QAAAA,KAAAA;AACAc,QAAAA,aAAAA,EAAef,QAAQe,aAAa;AACpCC,QAAAA,OAAAA;QACAC,GAAAA,EAAKO,CAAAA,MAAAA,GAAUN,QAAAA,CAASM,MAAAA,CAAAA,KAAYL,iCAAAA,CAAalB,KAAK,IAAIiB,QAAAA,CAASM,MAAAA,CAAAA,KAAYL,iCAAAA,CAAaS,IAAI;AAChGV,QAAAA,QAAAA;AACAE,QAAAA;AACJ,KAAA;AACJ;;;;"}

package/dist/cjs/Entitlements/index.d.ts

@@ -0,0 +1,7 @@
+export * from './entitlementModel.js';
+export * from './EntitlementsContext.js';
+export * from './moduleFilter.js';
+export * from './requiresModuleModel.js';
+export * from './RequiresModule.js';
+export * from './useEntitlements.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/Entitlements/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../Entitlements/index.ts"],"names":[],"mappings":"AAGA,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC"}

package/dist/cjs/Entitlements/moduleFilter.d.ts

@@ -0,0 +1,6 @@
+import { Entitlements } from './entitlementModel.js';
+export interface ModuleOwned {
+    module?: string;
+}
+export declare function filterByModule<TItem extends ModuleOwned>(items: readonly TItem[], entitlements: Entitlements): TItem[];
+//# sourceMappingURL=moduleFilter.d.ts.map

package/dist/cjs/Entitlements/moduleFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"moduleFilter.d.ts","sourceRoot":"","sources":["../../../Entitlements/moduleFilter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAKrD,MAAM,WAAW,WAAW;IAExB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AASD,wBAAgB,cAAc,CAAC,KAAK,SAAS,WAAW,EAAE,KAAK,EAAE,SAAS,KAAK,EAAE,EAAE,YAAY,EAAE,YAAY,GAAG,KAAK,EAAE,CAEtH"}

package/dist/cjs/Entitlements/moduleFilter.js

@@ -0,0 +1,16 @@
+'use strict';
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Leaves out what belongs to a module the tenant does not have, so navigation and pages disappear without it. While
+ * the entitlements load, what belongs to a module is left out too, rather than shown and taken away.
+ * @param items The items, such as the entries of a sidebar.
+ * @param entitlements What the tenant may do.
+ * @returns The items the tenant may see.
+ */ function filterByModule(items, entitlements) {
+    return items.filter((item)=>item.module === undefined || entitlements.has(item.module));
+}
+
+exports.filterByModule = filterByModule;
+//# sourceMappingURL=moduleFilter.js.map

package/dist/cjs/Entitlements/moduleFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moduleFilter.js","sources":["../../../Entitlements/moduleFilter.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { Entitlements } from './entitlementModel.js';\n\n/**\n * Something that belongs to a module: a navigation entry, a page, a menu item or a route.\n */\nexport interface ModuleOwned {\n    /** The module that owns it; leave it out for what belongs to the product itself and is always shown. */\n    module?: string;\n}\n\n/**\n * Leaves out what belongs to a module the tenant does not have, so navigation and pages disappear without it. While\n * the entitlements load, what belongs to a module is left out too, rather than shown and taken away.\n * @param items The items, such as the entries of a sidebar.\n * @param entitlements What the tenant may do.\n * @returns The items the tenant may see.\n */\nexport function filterByModule<TItem extends ModuleOwned>(items: readonly TItem[], entitlements: Entitlements): TItem[] {\n    return items.filter(item => item.module === undefined || entitlements.has(item.module));\n}\n"],"names":["filterByModule","items","entitlements","filter","item","module","undefined","has"],"mappings":";;AAAA;AACA;AAYA;;;;;;AAMC,IACM,SAASA,cAAAA,CAA0CC,KAAuB,EAAEC,YAA0B,EAAA;AACzG,IAAA,OAAOD,KAAAA,CAAME,MAAM,CAACC,CAAAA,IAAAA,GAAQA,IAAAA,CAAKC,MAAM,KAAKC,SAAAA,IAAaJ,YAAAA,CAAaK,GAAG,CAACH,KAAKC,MAAM,CAAA,CAAA;AACzF;;"}

package/dist/cjs/Entitlements/requiresModuleModel.d.ts

@@ -0,0 +1,10 @@
+import { BoxOfficeLabels } from '../Labels/index.js';
+import { Entitlements } from './entitlementModel.js';
+export interface RequiresModuleModel {
+    readonly hasModule: boolean;
+    readonly title: string;
+    readonly text: string;
+    readonly canTry: boolean;
+}
+export declare function requiresModuleModel(entitlements: Entitlements, module: string, labels: BoxOfficeLabels): RequiresModuleModel;
+//# sourceMappingURL=requiresModuleModel.d.ts.map

package/dist/cjs/Entitlements/requiresModuleModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requiresModuleModel.d.ts","sourceRoot":"","sources":["../../../Entitlements/requiresModuleModel.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAU,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAKrD,MAAM,WAAW,mBAAmB;IAEhC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAG5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAGvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAGtB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC5B;AASD,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,GAAG,mBAAmB,CAY5H"}

package/dist/cjs/Entitlements/requiresModuleModel.js

@@ -0,0 +1,32 @@
+'use strict';
+
+var showrunner_boxoffice = require('@cratis/showrunner.boxoffice');
+var format = require('../Labels/format.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Works out what to show where a module's content would be.
+ * @param entitlements What the tenant may do.
+ * @param module The module.
+ * @param labels The labels to show.
+ * @returns The {@link RequiresModuleModel}.
+ */ function requiresModuleModel(entitlements, module, labels) {
+    const standing = entitlements.standingOf(module);
+    const name = standing?.name ?? module;
+    const access = standing?.access ?? showrunner_boxoffice.ModuleAccess.none;
+    const text = access === showrunner_boxoffice.ModuleAccess.preview ? labels.requiresModule.preview : labels.requiresModule.none;
+    return {
+        hasModule: entitlements.has(module),
+        title: format.format(labels.requiresModule.title, {
+            module: name
+        }),
+        text: format.format(text, {
+            module: name
+        }),
+        canTry: access === showrunner_boxoffice.ModuleAccess.none || access === showrunner_boxoffice.ModuleAccess.preview
+    };
+}
+
+exports.requiresModuleModel = requiresModuleModel;
+//# sourceMappingURL=requiresModuleModel.js.map

package/dist/cjs/Entitlements/requiresModuleModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requiresModuleModel.js","sources":["../../../Entitlements/requiresModuleModel.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ModuleAccess, ModuleStanding } from '@cratis/showrunner.boxoffice';\nimport { BoxOfficeLabels, format } from '../Labels/index.js';\nimport { Entitlements } from './entitlementModel.js';\n\n/**\n * What to tell the user about a module they do not have.\n */\nexport interface RequiresModuleModel {\n    /** Whether the tenant has the module, so the content shows. */\n    readonly hasModule: boolean;\n\n    /** The title of the explanation. */\n    readonly title: string;\n\n    /** The explanation. */\n    readonly text: string;\n\n    /** Whether to offer to try the module. */\n    readonly canTry: boolean;\n}\n\n/**\n * Works out what to show where a module's content would be.\n * @param entitlements What the tenant may do.\n * @param module The module.\n * @param labels The labels to show.\n * @returns The {@link RequiresModuleModel}.\n */\nexport function requiresModuleModel(entitlements: Entitlements, module: string, labels: BoxOfficeLabels): RequiresModuleModel {\n    const standing: ModuleStanding | undefined = entitlements.standingOf(module);\n    const name = standing?.name ?? module;\n    const access = standing?.access ?? ModuleAccess.none;\n    const text = access === ModuleAccess.preview ? labels.requiresModule.preview : labels.requiresModule.none;\n\n    return {\n        hasModule: entitlements.has(module),\n        title: format(labels.requiresModule.title, { module: name }),\n        text: format(text, { module: name }),\n        canTry: access === ModuleAccess.none || access === ModuleAccess.preview\n    };\n}\n"],"names":["requiresModuleModel","entitlements","module","labels","standing","standingOf","name","access","ModuleAccess","none","text","preview","requiresModule","hasModule","has","title","format","canTry"],"mappings":";;;;;AAAA;AACA;AAuBA;;;;;;AAMC,IACM,SAASA,mBAAAA,CAAoBC,YAA0B,EAAEC,MAAc,EAAEC,MAAuB,EAAA;IACnG,MAAMC,QAAAA,GAAuCH,YAAAA,CAAaI,UAAU,CAACH,MAAAA,CAAAA;IACrE,MAAMI,IAAAA,GAAOF,UAAUE,IAAAA,IAAQJ,MAAAA;AAC/B,IAAA,MAAMK,MAAAA,GAASH,QAAAA,EAAUG,MAAAA,IAAUC,iCAAAA,CAAaC,IAAI;AACpD,IAAA,MAAMC,IAAAA,GAAOH,MAAAA,KAAWC,iCAAAA,CAAaG,OAAO,GAAGR,MAAAA,CAAOS,cAAc,CAACD,OAAO,GAAGR,MAAAA,CAAOS,cAAc,CAACH,IAAI;IAEzG,OAAO;QACHI,SAAAA,EAAWZ,YAAAA,CAAaa,GAAG,CAACZ,MAAAA,CAAAA;AAC5Ba,QAAAA,KAAAA,EAAOC,aAAAA,CAAOb,MAAAA,CAAOS,cAAc,CAACG,KAAK,EAAE;YAAEb,MAAAA,EAAQI;AAAK,SAAA,CAAA;AAC1DI,QAAAA,IAAAA,EAAMM,cAAON,IAAAA,EAAM;YAAER,MAAAA,EAAQI;AAAK,SAAA,CAAA;AAClCW,QAAAA,MAAAA,EAAQV,WAAWC,iCAAAA,CAAaC,IAAI,IAAIF,MAAAA,KAAWC,kCAAaG;AACpE,KAAA;AACJ;;"}

package/dist/cjs/Entitlements/useEntitlements.d.ts

@@ -0,0 +1,5 @@
+import { Entitlements } from './entitlementModel.js';
+import { ModuleOwned } from './moduleFilter.js';
+export declare function useEntitlements(): Entitlements;
+export declare function useModuleFilter<TItem extends ModuleOwned>(items: readonly TItem[]): TItem[];
+//# sourceMappingURL=useEntitlements.d.ts.map

package/dist/cjs/Entitlements/useEntitlements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useEntitlements.d.ts","sourceRoot":"","sources":["../../../Entitlements/useEntitlements.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,OAAO,EAAkB,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAOhE,wBAAgB,eAAe,IAAI,YAAY,CAE9C;AAQD,wBAAgB,eAAe,CAAC,KAAK,SAAS,WAAW,EAAE,KAAK,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,EAAE,CAE3F"}

package/dist/cjs/Entitlements/useEntitlements.js

@@ -0,0 +1,26 @@
+'use strict';
+
+var EntitlementsContext = require('./EntitlementsContext.js');
+var moduleFilter = require('./moduleFilter.js');
+
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * Gets what the signed-in user's tenant may do: whether it is on a trial, read-only or suspended, and which modules it
+ * has. Use it inside a {@link BoxOfficeProvider}.
+ * @returns The {@link Entitlements}.
+ */ function useEntitlements() {
+    return EntitlementsContext.useEntitlementsContext();
+}
+/**
+ * Leaves out what belongs to a module the tenant does not have, for the entries of a shell's navigation. Use it
+ * inside a {@link BoxOfficeProvider}.
+ * @param items The items, each optionally owned by a module.
+ * @returns The items the tenant may see.
+ */ function useModuleFilter(items) {
+    return moduleFilter.filterByModule(items, EntitlementsContext.useEntitlementsContext());
+}
+
+exports.useEntitlements = useEntitlements;
+exports.useModuleFilter = useModuleFilter;
+//# sourceMappingURL=useEntitlements.js.map

package/dist/cjs/Entitlements/useEntitlements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useEntitlements.js","sources":["../../../Entitlements/useEntitlements.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { Entitlements } from './entitlementModel.js';\nimport { useEntitlementsContext } from './EntitlementsContext.js';\nimport { filterByModule, ModuleOwned } from './moduleFilter.js';\n\n/**\n * Gets what the signed-in user's tenant may do: whether it is on a trial, read-only or suspended, and which modules it\n * has. Use it inside a {@link BoxOfficeProvider}.\n * @returns The {@link Entitlements}.\n */\nexport function useEntitlements(): Entitlements {\n    return useEntitlementsContext();\n}\n\n/**\n * Leaves out what belongs to a module the tenant does not have, for the entries of a shell's navigation. Use it\n * inside a {@link BoxOfficeProvider}.\n * @param items The items, each optionally owned by a module.\n * @returns The items the tenant may see.\n */\nexport function useModuleFilter<TItem extends ModuleOwned>(items: readonly TItem[]): TItem[] {\n    return filterByModule(items, useEntitlementsContext());\n}\n"],"names":["useEntitlements","useEntitlementsContext","useModuleFilter","items","filterByModule"],"mappings":";;;;;AAAA;AACA;AAMA;;;;AAIC,IACM,SAASA,eAAAA,GAAAA;IACZ,OAAOC,0CAAAA,EAAAA;AACX;AAEA;;;;;IAMO,SAASC,eAAAA,CAA2CC,KAAuB,EAAA;AAC9E,IAAA,OAAOC,4BAAeD,KAAAA,EAAOF,0CAAAA,EAAAA,CAAAA;AACjC;;;"}

package/dist/cjs/Labels/BoxOfficeLabels.d.ts

@@ -0,0 +1,116 @@
+export interface BoxOfficeLabels {
+    common: {
+        cancel: string;
+        close: string;
+        loading: string;
+        failed: string;
+        unauthorized: string;
+        portalFailed: string;
+        noPortal: string;
+    };
+    moduleAccess: {
+        none: string;
+        preview: string;
+        trial: string;
+        full: string;
+        until: string;
+    };
+    trialBanner: {
+        running: string;
+        lastDay: string;
+        closed: string;
+        buy: string;
+    };
+    suspension: {
+        title: string;
+        trialEndedWithoutSeats: string;
+        paymentOverdue: string;
+        administratorDecision: string;
+        resolve: string;
+        openPortal: string;
+    };
+    noLicense: {
+        noSeatTitle: string;
+        noSeat: string;
+        overCapacityTitle: string;
+        overCapacity: string;
+        trialClosedTitle: string;
+        trialClosed: string;
+        suspendedTitle: string;
+        suspended: string;
+        openPortal: string;
+    };
+    requiresModule: {
+        title: string;
+        none: string;
+        preview: string;
+        try: string;
+        buy: string;
+    };
+    seats: {
+        title: string;
+        summary: string;
+        overCapacity: string;
+        noCapacity: string;
+        empty: string;
+        holderColumn: string;
+        emailColumn: string;
+        assignedColumn: string;
+        statusColumn: string;
+        licensed: string;
+        overCapacityStatus: string;
+        assign: string;
+        releaseShort: string;
+        release: string;
+        assignTitle: string;
+        assignConfirm: string;
+        name: string;
+        email: string;
+        identityProvider: string;
+        subject: string;
+        releaseTitle: string;
+        releaseMessage: string;
+        readOnly: string;
+    };
+    usage: {
+        title: string;
+        empty: string;
+        meterColumn: string;
+        usedColumn: string;
+        allowanceColumn: string;
+        budgetColumn: string;
+        concurrencyColumn: string;
+        usedOfAllowance: string;
+        noAllowance: string;
+        day: string;
+        month: string;
+        resets: string;
+        atAllowance: string;
+        atBudget: string;
+        block: string;
+        park: string;
+        notSet: string;
+        progress: string;
+    };
+    plan: {
+        title: string;
+        modulesTitle: string;
+        offersTitle: string;
+        noModules: string;
+        noOffers: string;
+        includedSeats: string;
+        includedModules: string;
+        perMonth: string;
+        perYear: string;
+        buy: string;
+        try: string;
+        changePlan: string;
+        onTrial: string;
+        withSeats: string;
+    };
+}
+export type DeepPartial<T> = {
+    [TKey in keyof T]?: T[TKey] extends object ? DeepPartial<T[TKey]> : T[TKey];
+};
+export type BoxOfficeLabelOverrides = DeepPartial<BoxOfficeLabels>;
+//# sourceMappingURL=BoxOfficeLabels.d.ts.map

package/dist/cjs/Labels/BoxOfficeLabels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BoxOfficeLabels.d.ts","sourceRoot":"","sources":["../../../Labels/BoxOfficeLabels.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,eAAe;IAE5B,MAAM,EAAE;QAEJ,MAAM,EAAE,MAAM,CAAC;QAEf,KAAK,EAAE,MAAM,CAAC;QAEd,OAAO,EAAE,MAAM,CAAC;QAEhB,MAAM,EAAE,MAAM,CAAC;QAEf,YAAY,EAAE,MAAM,CAAC;QAErB,YAAY,EAAE,MAAM,CAAC;QAErB,QAAQ,EAAE,MAAM,CAAC;KACpB,CAAC;IAGF,YAAY,EAAE;QAEV,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,MAAM,CAAC;QAEhB,KAAK,EAAE,MAAM,CAAC;QAEd,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;IAGF,WAAW,EAAE;QAET,OAAO,EAAE,MAAM,CAAC;QAEhB,OAAO,EAAE,MAAM,CAAC;QAEhB,MAAM,EAAE,MAAM,CAAC;QAEf,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;IAGF,UAAU,EAAE;QAER,KAAK,EAAE,MAAM,CAAC;QAEd,sBAAsB,EAAE,MAAM,CAAC;QAE/B,cAAc,EAAE,MAAM,CAAC;QAEvB,qBAAqB,EAAE,MAAM,CAAC;QAE9B,OAAO,EAAE,MAAM,CAAC;QAEhB,UAAU,EAAE,MAAM,CAAC;KACtB,CAAC;IAGF,SAAS,EAAE;QAEP,WAAW,EAAE,MAAM,CAAC;QAEpB,MAAM,EAAE,MAAM,CAAC;QAEf,iBAAiB,EAAE,MAAM,CAAC;QAE1B,YAAY,EAAE,MAAM,CAAC;QAErB,gBAAgB,EAAE,MAAM,CAAC;QAEzB,WAAW,EAAE,MAAM,CAAC;QAEpB,cAAc,EAAE,MAAM,CAAC;QAEvB,SAAS,EAAE,MAAM,CAAC;QAElB,UAAU,EAAE,MAAM,CAAC;KACtB,CAAC;IAGF,cAAc,EAAE;QAEZ,KAAK,EAAE,MAAM,CAAC;QAEd,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,MAAM,CAAC;QAEhB,GAAG,EAAE,MAAM,CAAC;QAEZ,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;IAGF,KAAK,EAAE;QAEH,KAAK,EAAE,MAAM,CAAC;QAEd,OAAO,EAAE,MAAM,CAAC;QAEhB,YAAY,EAAE,MAAM,CAAC;QAErB,UAAU,EAAE,MAAM,CAAC;QAEnB,KAAK,EAAE,MAAM,CAAC;QAEd,YAAY,EAAE,MAAM,CAAC;QAErB,WAAW,EAAE,MAAM,CAAC;QAEpB,cAAc,EAAE,MAAM,CAAC;QAEvB,YAAY,EAAE,MAAM,CAAC;QAErB,QAAQ,EAAE,MAAM,CAAC;QAEjB,kBAAkB,EAAE,MAAM,CAAC;QAE3B,MAAM,EAAE,MAAM,CAAC;QAEf,YAAY,EAAE,MAAM,CAAC;QAErB,OAAO,EAAE,MAAM,CAAC;QAEhB,WAAW,EAAE,MAAM,CAAC;QAEpB,aAAa,EAAE,MAAM,CAAC;QAEtB,IAAI,EAAE,MAAM,CAAC;QAEb,KAAK,EAAE,MAAM,CAAC;QAEd,gBAAgB,EAAE,MAAM,CAAC;QAEzB,OAAO,EAAE,MAAM,CAAC;QAEhB,YAAY,EAAE,MAAM,CAAC;QAErB,cAAc,EAAE,MAAM,CAAC;QAEvB,QAAQ,EAAE,MAAM,CAAC;KACpB,CAAC;IAGF,KAAK,EAAE;QAEH,KAAK,EAAE,MAAM,CAAC;QAEd,KAAK,EAAE,MAAM,CAAC;QAEd,WAAW,EAAE,MAAM,CAAC;QAEpB,UAAU,EAAE,MAAM,CAAC;QAEnB,eAAe,EAAE,MAAM,CAAC;QAExB,YAAY,EAAE,MAAM,CAAC;QAErB,iBAAiB,EAAE,MAAM,CAAC;QAE1B,eAAe,EAAE,MAAM,CAAC;QAExB,WAAW,EAAE,MAAM,CAAC;QAEpB,GAAG,EAAE,MAAM,CAAC;QAEZ,KAAK,EAAE,MAAM,CAAC;QAEd,MAAM,EAAE,MAAM,CAAC;QAEf,WAAW,EAAE,MAAM,CAAC;QAEpB,QAAQ,EAAE,MAAM,CAAC;QAEjB,KAAK,EAAE,MAAM,CAAC;QAEd,IAAI,EAAE,MAAM,CAAC;QAEb,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,MAAM,CAAC;KACpB,CAAC;IAGF,IAAI,EAAE;QAEF,KAAK,EAAE,MAAM,CAAC;QAEd,YAAY,EAAE,MAAM,CAAC;QAErB,WAAW,EAAE,MAAM,CAAC;QAEpB,SAAS,EAAE,MAAM,CAAC;QAElB,QAAQ,EAAE,MAAM,CAAC;QAEjB,aAAa,EAAE,MAAM,CAAC;QAEtB,eAAe,EAAE,MAAM,CAAC;QAExB,QAAQ,EAAE,MAAM,CAAC;QAEjB,OAAO,EAAE,MAAM,CAAC;QAEhB,GAAG,EAAE,MAAM,CAAC;QAEZ,GAAG,EAAE,MAAM,CAAC;QAEZ,UAAU,EAAE,MAAM,CAAC;QAEnB,OAAO,EAAE,MAAM,CAAC;QAEhB,SAAS,EAAE,MAAM,CAAC;KACrB,CAAC;CACL;AAKD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;KACxB,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;CAC9E,CAAC;AAMF,MAAM,MAAM,uBAAuB,GAAG,WAAW,CAAC,eAAe,CAAC,CAAC"}

package/dist/cjs/Labels/defaultBoxOfficeLabels.d.ts

@@ -0,0 +1,3 @@
+import { BoxOfficeLabels } from './BoxOfficeLabels.js';
+export declare const defaultBoxOfficeLabels: BoxOfficeLabels;
+//# sourceMappingURL=defaultBoxOfficeLabels.d.ts.map

package/dist/cjs/Labels/defaultBoxOfficeLabels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultBoxOfficeLabels.d.ts","sourceRoot":"","sources":["../../../Labels/defaultBoxOfficeLabels.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAKvD,eAAO,MAAM,sBAAsB,EAAE,eA8GpC,CAAC"}