@homebound/beam 4.55.0 → 4.56.0

package/dist/index.d.cts

@@ -8732,6 +8732,8 @@ type MenuSelectFieldBaseProps<O, V extends Value> = {
     getOptionMenuLabel?: (opt: O) => ReactNode;
     /** Extra text the menu search matches, in addition to `getOptionLabel`. */
     getOptionSearchText?: (opt: O) => string | readonly string[];
+    /** Sort options by `getOptionLabel`. On by default. `MenuTreeSelectField` defaults this to false. */
+    autoSort?: boolean;
     /** Debounced menu search text. The caller replaces `options` and should keep the current selection in that list. Closing calls this with `""`. */
     onSearch?: (search: string) => void;
     disabledOptions?: (V | {
@@ -10266,6 +10268,7 @@ type WorkflowDestructiveAction = {
     confirmTitle?: ReactNode;
     confirmMessage?: ReactNode;
 };
+type WorkflowCompleteLabel = "Create" | "Save" | "Publish";
 type WorkflowActionsProps = {
     /** Leaves the workflow without saving. Always shown. */
     onCancel: (e: PressEvent) => void;
@@ -10273,10 +10276,12 @@ type WorkflowActionsProps = {
     onSaveAndExit?: (e: PressEvent) => void | Promise<void>;
     /** Destructive action on the workflow, rendered as a `danger` button before Continue/Complete. */
     destructiveAction?: WorkflowDestructiveAction;
-    /** Label for the completion button shown on the last step (or when there is no next step). */
-    completeLabel: "Create" | "Save";
     /** Called when the completion button is clicked. */
     onComplete: (e: PressEvent) => void | Promise<void>;
+    /** `"Create"`, `"Save"`, or `"Publish"`. Defaults to `"Save"`. */
+    completeLabel?: WorkflowCompleteLabel;
+    /** One-off label. Wins over `completeLabel`. Confirm with product and/or design first. */
+    nonStandardCompleteLabel?: string;
     /** Continue/Complete is disabled. A ReactNode is shown in Beam's tooltip. */
     primaryDisabled?: boolean | ReactNode;
     /** When true, Continue/Complete use the `ai` button variant instead of `primary`. */
@@ -11638,14 +11643,14 @@ type RightPaneTrigger = {
 /** The pending in-app navigation, as React Router reports it (pathnames are basename-stripped). */
 type AllowNavigationArgs = Parameters<BlockerFunction>[0];
 
-type FocusedFormLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix" | "breadcrumbs"> & Pick<WorkflowActionsProps, "onCancel" | "completeLabel" | "onComplete" | "onSaveAndExit" | "destructiveAction"> & {
-    /** Create/Save is disabled. A ReactNode is shown in Beam's tooltip. */
+type FocusedFormLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix" | "breadcrumbs"> & Pick<WorkflowActionsProps, "onCancel" | "onComplete" | "onSaveAndExit" | "destructiveAction" | "completeLabel" | "nonStandardCompleteLabel"> & {
+    /** Create/Save/Publish is disabled. A ReactNode is shown in Beam's tooltip. */
     primaryDisabled?: WorkflowActionsProps["primaryDisabled"];
     /** Read on Cancel / leave — a callback so flipping dirty does not re-render. */
     isDirty?: () => boolean;
     /** Consulted only while dirty — return true to allow a route change that stays on this form. */
     allowNavigation?: (args: AllowNavigationArgs) => boolean;
-    /** Full-bleed AI wash on the body and the `ai` Create/Save variant. Pair with body `aiMode` (e.g. FormSectionLayout). */
+    /** Full-bleed AI wash on the body and the `ai` Create/Save/Publish variant. Pair with body `aiMode` (e.g. FormSectionLayout). */
     aiMode?: boolean;
     /** Icon triggers that open the document-scroll right pane. Hosts the pane — do not also set `withRightPane` on the body. */
     rightPaneTriggers?: RightPaneTrigger[];
@@ -11674,7 +11679,7 @@ type StepperLayoutStep = Omit<StepperTabsStep, "value" | "disabled"> & {
     /** Icon triggers for this step. Chrome is rendered by the workflow; the pane closes on step change. */
     rightPaneTriggers?: RightPaneTrigger[];
 };
-type StepperLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix" | "breadcrumbs"> & Pick<WorkflowActionsProps, "onCancel" | "completeLabel" | "onComplete" | "onSaveAndExit" | "destructiveAction"> & {
+type StepperLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix" | "breadcrumbs"> & Pick<WorkflowActionsProps, "onCancel" | "onComplete" | "onSaveAndExit" | "destructiveAction" | "completeLabel" | "nonStandardCompleteLabel"> & {
     /** The workflow's steps; the active step's `content` is the body, and it drives the header's tab strip. */
     steps: StepperLayoutStep[];
     /** The step shown initially (matched against `defaultTestId(step.label)`); falls back to the first step if omitted or if it doesn't match any step. Uncontrolled — the layout owns step navigation from here. */

package/dist/index.d.ts

@@ -8732,6 +8732,8 @@ type MenuSelectFieldBaseProps<O, V extends Value> = {
     getOptionMenuLabel?: (opt: O) => ReactNode;
     /** Extra text the menu search matches, in addition to `getOptionLabel`. */
     getOptionSearchText?: (opt: O) => string | readonly string[];
+    /** Sort options by `getOptionLabel`. On by default. `MenuTreeSelectField` defaults this to false. */
+    autoSort?: boolean;
     /** Debounced menu search text. The caller replaces `options` and should keep the current selection in that list. Closing calls this with `""`. */
     onSearch?: (search: string) => void;
     disabledOptions?: (V | {
@@ -10266,6 +10268,7 @@ type WorkflowDestructiveAction = {
     confirmTitle?: ReactNode;
     confirmMessage?: ReactNode;
 };
+type WorkflowCompleteLabel = "Create" | "Save" | "Publish";
 type WorkflowActionsProps = {
     /** Leaves the workflow without saving. Always shown. */
     onCancel: (e: PressEvent) => void;
@@ -10273,10 +10276,12 @@ type WorkflowActionsProps = {
     onSaveAndExit?: (e: PressEvent) => void | Promise<void>;
     /** Destructive action on the workflow, rendered as a `danger` button before Continue/Complete. */
     destructiveAction?: WorkflowDestructiveAction;
-    /** Label for the completion button shown on the last step (or when there is no next step). */
-    completeLabel: "Create" | "Save";
     /** Called when the completion button is clicked. */
     onComplete: (e: PressEvent) => void | Promise<void>;
+    /** `"Create"`, `"Save"`, or `"Publish"`. Defaults to `"Save"`. */
+    completeLabel?: WorkflowCompleteLabel;
+    /** One-off label. Wins over `completeLabel`. Confirm with product and/or design first. */
+    nonStandardCompleteLabel?: string;
     /** Continue/Complete is disabled. A ReactNode is shown in Beam's tooltip. */
     primaryDisabled?: boolean | ReactNode;
     /** When true, Continue/Complete use the `ai` button variant instead of `primary`. */
@@ -11638,14 +11643,14 @@ type RightPaneTrigger = {
 /** The pending in-app navigation, as React Router reports it (pathnames are basename-stripped). */
 type AllowNavigationArgs = Parameters<BlockerFunction>[0];
 
-type FocusedFormLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix" | "breadcrumbs"> & Pick<WorkflowActionsProps, "onCancel" | "completeLabel" | "onComplete" | "onSaveAndExit" | "destructiveAction"> & {
-    /** Create/Save is disabled. A ReactNode is shown in Beam's tooltip. */
+type FocusedFormLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix" | "breadcrumbs"> & Pick<WorkflowActionsProps, "onCancel" | "onComplete" | "onSaveAndExit" | "destructiveAction" | "completeLabel" | "nonStandardCompleteLabel"> & {
+    /** Create/Save/Publish is disabled. A ReactNode is shown in Beam's tooltip. */
     primaryDisabled?: WorkflowActionsProps["primaryDisabled"];
     /** Read on Cancel / leave — a callback so flipping dirty does not re-render. */
     isDirty?: () => boolean;
     /** Consulted only while dirty — return true to allow a route change that stays on this form. */
     allowNavigation?: (args: AllowNavigationArgs) => boolean;
-    /** Full-bleed AI wash on the body and the `ai` Create/Save variant. Pair with body `aiMode` (e.g. FormSectionLayout). */
+    /** Full-bleed AI wash on the body and the `ai` Create/Save/Publish variant. Pair with body `aiMode` (e.g. FormSectionLayout). */
     aiMode?: boolean;
     /** Icon triggers that open the document-scroll right pane. Hosts the pane — do not also set `withRightPane` on the body. */
     rightPaneTriggers?: RightPaneTrigger[];
@@ -11674,7 +11679,7 @@ type StepperLayoutStep = Omit<StepperTabsStep, "value" | "disabled"> & {
     /** Icon triggers for this step. Chrome is rendered by the workflow; the pane closes on step change. */
     rightPaneTriggers?: RightPaneTrigger[];
 };
-type StepperLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix" | "breadcrumbs"> & Pick<WorkflowActionsProps, "onCancel" | "completeLabel" | "onComplete" | "onSaveAndExit" | "destructiveAction"> & {
+type StepperLayoutProps = Pick<BaseHeaderProps, "title" | "documentTitleSuffix" | "breadcrumbs"> & Pick<WorkflowActionsProps, "onCancel" | "onComplete" | "onSaveAndExit" | "destructiveAction" | "completeLabel" | "nonStandardCompleteLabel"> & {
     /** The workflow's steps; the active step's `content` is the body, and it drives the header's tab strip. */
     steps: StepperLayoutStep[];
     /** The step shown initially (matched against `defaultTestId(step.label)`); falls back to the first step if omitted or if it doesn't match any step. Uncontrolled — the layout owns step navigation from here. */

package/dist/index.js

@@ -19919,6 +19919,7 @@ function useMenuSelectField(props) {
     getOptionLabel = defaultOptionLabel,
     getOptionMenuLabel,
     getOptionSearchText,
+    autoSort = true,
     onSearch,
     disabledOptions,
     nothingSelectedText = "",
@@ -19961,10 +19962,10 @@ function useMenuSelectField(props) {
   const [optionsLoading, setOptionsLoading] = useState31(false);
   const didRequestOptionsRef = useRef36(false);
   const options = useMemo28(
-    () => initializeOptions(optionsProp, getOptionValue, getOptionLabel, void 0, false),
+    () => initializeOptions(optionsProp, getOptionValue, getOptionLabel, void 0, autoSort),
     // getOptionValue and getOptionLabel are typically inline lambdas
     // oxlint-disable-next-line react-hooks/exhaustive-deps
-    [optionsProp]
+    [optionsProp, autoSort]
   );
   const { hoverProps, isHovered } = useHover13({});
   const { focusProps, isFocusVisible } = useFocusRing10();
@@ -21824,11 +21825,12 @@ import { Observer as Observer8 } from "mobx-react";
 // src/inputs/MenuSelectField/MenuTreeSelectField.tsx
 import { jsx as jsx140 } from "react/jsx-runtime";
 function MenuTreeSelectField(props) {
-  const { onSelect, selectionDisplay = "all", defaultExpanded = false, ...rest } = props;
+  const { onSelect, selectionDisplay = "all", defaultExpanded = false, autoSort = false, ...rest } = props;
   return /* @__PURE__ */ jsx140(
     BaseMenuSelectField,
     {
       ...rest,
+      autoSort,
       selectionMode: "multiple",
       tree: { getChildren: getNestedChildren, display: selectionDisplay, defaultExpanded },
       onCommit: (values, opts) => onSelect(treeSelectResponse(values, opts))
@@ -31508,14 +31510,19 @@ var SingleFilter = class extends BaseFilter {
     return resolveOptionSelectedFilterLabel(options, getOptionValue, getOptionLabel, value);
   }
   render(value, setValue, tid, inModal, vertical) {
-    const { label, defaultValue, options: maybeOptions, nothingSelectedText, ...props } = this.props;
+    const { label, defaultValue, options: maybeOptions, nothingSelectedText, autoSort, ...props } = this.props;
     const { getOptionValue, getOptionLabel } = optionReaders2(this.props);
     const unsetText = nothingSelectedText ?? "All";
-    const options = Array.isArray(maybeOptions) ? [allOption, ...maybeOptions] : { ...maybeOptions, current: maybeOptions.current };
+    const isStaticList = Array.isArray(maybeOptions);
+    const options = isStaticList ? [
+      allOption,
+      ...initializeOptions(maybeOptions, getOptionValue, getOptionLabel, void 0, autoSort ?? true)
+    ] : maybeOptions;
     return /* @__PURE__ */ jsx241(
       MenuSelectField,
       {
         ...props,
+        autoSort: isStaticList ? false : autoSort,
         options,
         getOptionValue: (option) => option === allOption ? void 0 : getOptionValue(option),
         getOptionLabel: (option) => option === allOption ? unsetText : getOptionLabel(option),
@@ -33938,26 +33945,28 @@ function WorkflowActions(props) {
     onCancel,
     onSaveAndExit,
     destructiveAction,
-    completeLabel,
     onComplete,
     primaryDisabled,
     aiMode = false,
     isFirstStep = true,
     isLastStep = true,
     onBack,
-    onContinue
+    onContinue,
+    completeLabel,
+    nonStandardCompleteLabel
   } = props;
   const {
     sm: isMobile
   } = useBreakpoint();
   const primaryVariant = aiMode ? "ai" : "primary";
+  const completeButtonLabel = nonStandardCompleteLabel ?? completeLabel ?? "Save";
   return /* @__PURE__ */ jsxs147("div", { className: "df aic jcsb sm_w100", children: [
     /* @__PURE__ */ jsx273("div", { className: "df aic", children: !isFirstStep && isMobile && onBack && /* @__PURE__ */ jsx273(IconButton, { icon: "arrowBack", label: "Back", onClick: onBack }) }),
     /* @__PURE__ */ jsxs147("div", { className: "df aic g_1", children: [
       /* @__PURE__ */ jsx273(Button, { label: "Cancel", variant: "quaternary", onClick: onCancel }),
       onSaveAndExit && /* @__PURE__ */ jsx273(Button, { label: "Save & Exit", variant: "secondary", onClick: onSaveAndExit }),
       destructiveAction && /* @__PURE__ */ jsx273(Button, { label: destructiveAction.label ?? "Remove", variant: "danger", onClick: destructiveAction.onConfirm }),
-      isLastStep ? /* @__PURE__ */ jsx273(Button, { label: completeLabel, variant: primaryVariant, onClick: onComplete, disabled: primaryDisabled }) : /* @__PURE__ */ jsx273(Button, { label: "Continue", variant: primaryVariant, onClick: async () => {
+      isLastStep ? /* @__PURE__ */ jsx273(Button, { label: completeButtonLabel, variant: primaryVariant, onClick: onComplete, disabled: primaryDisabled }) : /* @__PURE__ */ jsx273(Button, { label: "Continue", variant: primaryVariant, onClick: async () => {
         await onContinue?.();
       }, disabled: primaryDisabled })
     ] })
@@ -33985,7 +33994,15 @@ function WorkflowPageLayout(props) {
     destructiveAction,
     rightPaneTriggers,
     banner: bannerProp,
-    ...actionProps
+    onSaveAndExit,
+    onComplete,
+    primaryDisabled,
+    isFirstStep,
+    isLastStep,
+    onBack,
+    onContinue,
+    completeLabel,
+    nonStandardCompleteLabel
   } = props;
   const tid = useTestIds(props, "workflowPageLayout");
   const {
@@ -34005,7 +34022,7 @@ function WorkflowPageLayout(props) {
     onCancel,
     destructiveAction
   });
-  const actions = /* @__PURE__ */ jsx274(WorkflowActions, { ...actionProps, aiMode, onCancel: onCancelClick, destructiveAction: destructiveAction && {
+  const actions = /* @__PURE__ */ jsx274(WorkflowActions, { completeLabel, nonStandardCompleteLabel, onSaveAndExit, onComplete, primaryDisabled, isFirstStep, isLastStep, onBack, onContinue, aiMode, onCancel: onCancelClick, destructiveAction: destructiveAction && {
     ...destructiveAction,
     onConfirm: onDestructiveActionClick
   } });
@@ -34133,7 +34150,6 @@ import { jsx as jsx275 } from "react/jsx-runtime";
 function FocusedFormLayout(props) {
   const {
     onCancel,
-    completeLabel,
     onComplete,
     onSaveAndExit,
     destructiveAction,
@@ -34144,14 +34160,20 @@ function FocusedFormLayout(props) {
     rightPaneTriggers,
     banner,
     children,
-    ...headerProps
+    title,
+    documentTitleSuffix,
+    breadcrumbs,
+    completeLabel,
+    nonStandardCompleteLabel
   } = props;
   const tid = useTestIds(props, "focusedFormLayout");
   return /* @__PURE__ */ jsx275(
     WorkflowPageLayout,
     {
       ...tid,
-      ...headerProps,
+      title,
+      documentTitleSuffix,
+      breadcrumbs,
       banner,
       aiMode,
       isDirty,
@@ -34160,6 +34182,7 @@ function FocusedFormLayout(props) {
       onSaveAndExit,
       destructiveAction,
       completeLabel,
+      nonStandardCompleteLabel,
       onComplete,
       primaryDisabled,
       rightPaneTriggers,
@@ -34176,7 +34199,6 @@ function StepperLayout(props) {
     steps,
     defaultStep,
     onCancel,
-    completeLabel,
     onComplete,
     onSaveAndExit,
     destructiveAction,
@@ -34184,7 +34206,11 @@ function StepperLayout(props) {
     allowNavigation,
     aiMode,
     banner,
-    ...headerProps
+    title,
+    documentTitleSuffix,
+    breadcrumbs,
+    completeLabel,
+    nonStandardCompleteLabel
   } = props;
   const stepTabs = steps.map((step) => ({ ...step, value: defaultTestId(step.label) }));
   const [currentStep, setCurrentStep] = useState72(() => getInitialStep(stepTabs, defaultStep));
@@ -34201,7 +34227,9 @@ function StepperLayout(props) {
     WorkflowPageLayout,
     {
       ...tid,
-      ...headerProps,
+      title,
+      documentTitleSuffix,
+      breadcrumbs,
       banner,
       aiMode,
       stepperTabs: { steps: stepTabs, currentStep, onChange: goToStep },
@@ -34217,6 +34245,7 @@ function StepperLayout(props) {
       onSaveAndExit,
       destructiveAction,
       completeLabel,
+      nonStandardCompleteLabel,
       onComplete,
       primaryDisabled: activeStep?.primaryDisabled,
       rightPaneTriggers: activeStep?.rightPaneTriggers,