@homebound/beam 2.334.3 → 2.335.0

package/dist/forms/BoundSelectField.d.ts

@@ -1,21 +1,30 @@
 /// <reference types="react" />
 import { FieldState } from "@homebound/form-state";
 import { SelectFieldProps, Value } from "../inputs";
-import { HasIdAndName, Optional } from "../types";
+import { HasIdIsh, HasNameIsh, Optional } from "../types";
 export type BoundSelectFieldProps<O, V extends Value> = Omit<SelectFieldProps<O, V>, "value" | "onSelect" | "label"> & {
+    /** Optional, to allow `onSelect` to be overridden to do more than just `field.set`. */
     onSelect?: (value: V | undefined, opt: O | undefined) => void;
+    /** The field we'll read/write data from. */
     field: FieldState<V | null | undefined>;
+    /** An optional label, defaults to the humanized field key, i.e. `authorId` -> `Author`. */
     label?: string;
 };
 /**
  * Wraps `SelectField` and binds it to a form field.
  *
- * To ease integration with "select this fooId" inputs, we can take a list
- * of objects, `T` (i.e. `TradePartner[]`), but accept a field of type `V`
- * (i.e. `string`).
+ * To ease integration with GraphQL inputs that want to put `{ authorId: "a:1" }` on
+ * the wire, we generally expect the FieldState type to be a string/tagged id, but the
+ * `options` prop to be the full list of id+name options like `AuthorFragment[]`.
  *
- * The caller has to tell us how to turn `T` into `V`, which is usually a
- * lambda like `t => t.id`.
+ * If `AuthorFragment` type matches `HasIdIsh` and `HasNameIsh`, we'll automatically use
+ * the `id` and `name` fields from it, otherwise callers need to provide `getOptionValue`
+ * and `getOptionLabel` to adapt the option, i.e. `getOptionLabel={(author) => author.otherName}`.
+ *
+ * Note: there are four overloads here to handle each combination of "HasIdIsh and HasNameId",
+ * "only has HasIdIsh", "only has HasNameIsh", and "neither".
  */
+export declare function BoundSelectField<T extends HasIdIsh<V> & HasNameIsh, V extends Value>(props: Optional<BoundSelectFieldProps<T, V>, "getOptionLabel" | "getOptionValue">): JSX.Element;
+export declare function BoundSelectField<T extends HasIdIsh<V>, V extends Value>(props: Optional<BoundSelectFieldProps<T, V>, "getOptionValue">): JSX.Element;
+export declare function BoundSelectField<T extends HasNameIsh, V extends Value>(props: Optional<BoundSelectFieldProps<T, V>, "getOptionLabel">): JSX.Element;
 export declare function BoundSelectField<T, V extends Value>(props: BoundSelectFieldProps<T, V>): JSX.Element;
-export declare function BoundSelectField<T extends HasIdAndName<V>, V extends Value>(props: Optional<BoundSelectFieldProps<T, V>, "getOptionLabel" | "getOptionValue">): JSX.Element;

package/dist/forms/BoundSelectField.js

@@ -7,10 +7,9 @@ const inputs_1 = require("../inputs");
 const utils_1 = require("../utils");
 const defaultLabel_1 = require("../utils/defaultLabel");
 const useTestIds_1 = require("../utils/useTestIds");
+const options_1 = require("../utils/options");
 function BoundSelectField(props) {
-    const { field, options, readOnly, getOptionValue = (opt) => opt.id, // if unset, assume O implements HasId
-    getOptionLabel = (opt) => opt.name, // if unset, assume O implements HasName
-    onSelect = (value) => field.set(value), label = (0, defaultLabel_1.defaultLabel)(field.key), onBlur, onFocus, ...others } = props;
+    const { field, options, readOnly, getOptionValue = options_1.defaultOptionValue, getOptionLabel = options_1.defaultOptionLabel, onSelect = (value) => field.set(value), label = (0, defaultLabel_1.defaultLabel)(field.key), onBlur, onFocus, ...others } = props;
     const testId = (0, useTestIds_1.useTestIds)(props, field.key);
     return ((0, jsx_runtime_1.jsx)(mobx_react_1.Observer, { children: () => {
             var _a;

package/dist/forms/formStateDomain.d.ts

@@ -6,8 +6,13 @@ export declare const jan19: Date;
 export declare const jan29: Date;
 export declare const dd100: DeweyDecimalClassification;
 export declare const dd200: DeweyDecimalClassification;
+export declare enum AuthorHeight {
+    SHORT = 0,
+    TALL = 1
+}
 export interface AuthorInput {
     id?: string | null;
+    height?: AuthorHeight | null;
     firstName?: string | null;
     middleInitial?: string | null;
     lastName?: string | null;

package/dist/forms/formStateDomain.js

@@ -3,7 +3,7 @@
 // by a GraphQL schema for a `saveAuthor` mutation that takes an author
 // plus the author's books.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DateOnly = exports.dd200 = exports.dd100 = exports.jan29 = exports.jan19 = exports.jan10 = exports.jan2 = exports.jan1 = void 0;
+exports.DateOnly = exports.AuthorHeight = exports.dd200 = exports.dd100 = exports.jan29 = exports.jan19 = exports.jan10 = exports.jan2 = exports.jan1 = void 0;
 exports.jan1 = new Date(2020, 0, 1);
 exports.jan2 = new Date(2020, 0, 2);
 exports.jan10 = new Date(2020, 0, 10);
@@ -11,6 +11,11 @@ exports.jan19 = new Date(2020, 0, 19);
 exports.jan29 = new Date(2020, 0, 29);
 exports.dd100 = { number: "100", category: "Philosophy" };
 exports.dd200 = { number: "200", category: "Religion" };
+var AuthorHeight;
+(function (AuthorHeight) {
+    AuthorHeight[AuthorHeight["SHORT"] = 0] = "SHORT";
+    AuthorHeight[AuthorHeight["TALL"] = 1] = "TALL";
+})(AuthorHeight = exports.AuthorHeight || (exports.AuthorHeight = {}));
 class DateOnly {
     constructor(date) {
         this.date = date;

package/dist/inputs/SelectField.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { Value } from "./";
 import { ComboBoxBaseProps } from "./internal/ComboBoxBase";
-import { HasIdAndName, Optional } from "../types";
+import { HasIdIsh, HasNameIsh, Optional } from "../types";
 export interface SelectFieldProps<O, V extends Value> extends Omit<ComboBoxBaseProps<O, V>, "values" | "onSelect" | "multiselect"> {
     /** The current value; it can be `undefined`, even if `V` cannot be. */
     value: V | undefined;
@@ -18,5 +18,7 @@ export interface SelectFieldProps<O, V extends Value> extends Omit<ComboBoxBaseP
  * The `O` type is a list of options to show, the `V` is the primitive value of a
  * given `O` (i.e. it's id) that you want to use as the current/selected value.
  */
+export declare function SelectField<O extends HasIdIsh<V> & HasNameIsh, V extends Value>(props: Optional<SelectFieldProps<O, V>, "getOptionValue" | "getOptionLabel">): JSX.Element;
+export declare function SelectField<O extends HasIdIsh<V>, V extends Value>(props: Optional<SelectFieldProps<O, V>, "getOptionValue">): JSX.Element;
+export declare function SelectField<O extends HasNameIsh, V extends Value>(props: Optional<SelectFieldProps<O, V>, "getOptionLabel">): JSX.Element;
 export declare function SelectField<O, V extends Value>(props: SelectFieldProps<O, V>): JSX.Element;
-export declare function SelectField<O extends HasIdAndName<V>, V extends Value>(props: Optional<SelectFieldProps<O, V>, "getOptionValue" | "getOptionLabel">): JSX.Element;

package/dist/inputs/SelectField.js

@@ -4,10 +4,9 @@ exports.SelectField = void 0;
 const jsx_runtime_1 = require("@emotion/react/jsx-runtime");
 const react_1 = require("react");
 const ComboBoxBase_1 = require("./internal/ComboBoxBase");
+const options_1 = require("../utils/options");
 function SelectField(props) {
-    const { getOptionValue = (opt) => opt.id, // if unset, assume O implements HasId
-    getOptionLabel = (opt) => opt.name, // if unset, assume O implements HasName
-    options, onSelect, value, ...otherProps } = props;
+    const { getOptionValue = options_1.defaultOptionValue, getOptionLabel = options_1.defaultOptionLabel, options, onSelect, value, ...otherProps } = props;
     const values = (0, react_1.useMemo)(() => [value], [value]);
     return ((0, jsx_runtime_1.jsx)(ComboBoxBase_1.ComboBoxBase, { ...otherProps, options: options, getOptionLabel: getOptionLabel, getOptionValue: getOptionValue, values: values, onSelect: (values, options) => {
             // If the user used `unsetLabel`, then values will be `[undefined]` and options `[unsetOption]`

package/dist/inputs/Value.d.ts

@@ -14,4 +14,4 @@ import { Key } from "react";
  */
 export type Value = string | number | null | undefined | boolean;
 export declare function keyToValue<V extends Value>(key: Key): V;
-export declare function valueToKey(value: Value): Key;
+export declare function valueToKey(value: Value): string;

package/dist/types.d.ts

@@ -1,6 +1,18 @@
 import React from "react";
 import { DateRange as _DateRange } from "react-day-picker";
 export type { _DateRange as DateRange };
+export type HasIdIsh<V = string> = {
+    id: V;
+} | {
+    code: V;
+};
+export type HasNameIsh = {
+    name: string;
+} | {
+    displayName: string;
+} | {
+    label: string;
+};
 export type HasIdAndName<V = string> = {
     id: V;
     name: string;

package/dist/utils/index.d.ts

@@ -1,5 +1,6 @@
 import { MutableRefObject } from "react";
 import type { CheckboxGroupState, ToggleState } from "react-stately";
+export declare function fail(message?: string): never;
 /** Adapts our state to what useToggleState returns in a stateless manner. */
 export declare function toToggleState(isSelected: boolean, onChange: (value: boolean) => void): ToggleState;
 /** Adapts our state to what use*Group returns in a stateless manner. */
@@ -17,7 +18,7 @@ export * from "./useTestIds";
 /** Casts `Object.keys` to "what it should be", as long as your instance doesn't have keys it shouldn't. */
 export declare function safeKeys<T>(instance: T): (keyof T)[];
 export declare const omitKey: <T, K extends keyof T>(key: K, { [key]: _, ...obj }: T) => T;
-export declare const noop: () => void;
+export declare const noop: (...args: any) => void;
 type Entries<T> = {
     [K in keyof T]: [K, T[K]];
 }[keyof T][];

package/dist/utils/index.js

@@ -14,7 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pluralize = exports.isDefined = exports.isFunction = exports.isPromise = exports.areArraysEqual = exports.isAbsoluteUrl = exports.EmptyRef = exports.safeEntries = exports.noop = exports.omitKey = exports.safeKeys = exports.maybeCall = exports.toGroupState = exports.toToggleState = void 0;
+exports.pluralize = exports.isDefined = exports.isFunction = exports.isPromise = exports.areArraysEqual = exports.isAbsoluteUrl = exports.EmptyRef = exports.safeEntries = exports.noop = exports.omitKey = exports.safeKeys = exports.maybeCall = exports.toGroupState = exports.toToggleState = exports.fail = void 0;
+function fail(message) {
+    throw new Error(message || "Failed");
+}
+exports.fail = fail;
 /** Adapts our state to what useToggleState returns in a stateless manner. */
 function toToggleState(isSelected, onChange) {
     return {
@@ -64,7 +68,7 @@ exports.safeKeys = safeKeys;
 // Returns object with specified key removed
 const omitKey = (key, { [key]: _, ...obj }) => obj;
 exports.omitKey = omitKey;
-const noop = () => { };
+const noop = (...args) => { };
 exports.noop = noop;
 function safeEntries(obj) {
     return Object.entries(obj);

package/dist/utils/options.d.ts

@@ -1,2 +1,2 @@
-export declare const defaultOptionValue: <O>(opt: O) => any;
-export declare const defaultOptionLabel: <O>(opt: O) => any;
+export declare function defaultOptionValue<O>(opt: O): any;
+export declare function defaultOptionLabel<O>(opt: O): any;

package/dist/utils/options.js

@@ -1,7 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultOptionLabel = exports.defaultOptionValue = void 0;
-const defaultOptionValue = (opt) => opt.id;
+const utils_1 = require("./");
+// This `any` is currently on purpose to ignore type errors in ChipSelectField
+function defaultOptionValue(opt) {
+    if (typeof opt !== "object" || !opt)
+        (0, utils_1.fail)(`Option ${opt} has no id or code`);
+    // Use `in` because returning undefined is fine
+    return "id" in opt ? opt.id : "code" in opt ? opt.code : (0, utils_1.fail)(`Option ${JSON.stringify(opt)} has no id or code`);
+}
 exports.defaultOptionValue = defaultOptionValue;
-const defaultOptionLabel = (opt) => opt.name;
+function defaultOptionLabel(opt) {
+    if (typeof opt !== "object" || !opt)
+        (0, utils_1.fail)(`Option ${opt} has no id or code`);
+    // Use `in` because returning undefined is fine
+    return "displayName" in opt
+        ? opt.displayName
+        : "label" in opt
+            ? opt.label
+            : "name" in opt
+                ? opt.name
+                : (0, utils_1.fail)(`Option ${JSON.stringify(opt)} has no displayName, label, or name`);
+}
 exports.defaultOptionLabel = defaultOptionLabel;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homebound/beam",
-  "version": "2.334.3",
+  "version": "2.335.0",
   "author": "Homebound",
   "license": "MIT",
   "main": "dist/index.js",