@ksp-gonogo/ui-kit 1.0.0-rc.21 → 1.0.0-rc.27

package/dist/tokens.css

@@ -792,6 +792,8 @@ textarea {
   --inset-jog-wheel-label: 0 var(--space-2);
   /* The room a Meter figure keeps for the held mark drawn outside it. */
   --inset-meter-mark: var(--space-6);
+  /* The room an avatar keeps from the edge of the control it sits in, on each side. */
+  --inset-avatar: var(--space-4);
 
   /* Fields. */
   --inset-field: var(--space-6) var(--space-8);

package/dist/{units-Cl-8ZdJc.d.ts → units-Bd3X3vsA.d.ts}

@@ -7,23 +7,34 @@ import { DeclaredUnit, UnitDeclarations, UnitRung } from '@ksp-gonogo/sitrep-sdk
  * Every type in this module reads `UnitDeclarations` and nothing else, which is
  * what makes a unit an Uplink merges into it indistinguishable here from a
  * first-party one.
+ *
+ * @category Unit
  */
 type KindOfSymbol<Unit extends string> = Unit extends DeclaredUnit ? UnitDeclarations[Unit] extends {
     kind: infer Kind;
 } ? Kind : never : never;
-/** Every declared symbol that measures `Kind`. */
+/**
+ * Every declared symbol that measures `Kind`.
+ *
+ * @category Unit
+ */
 type SymbolsOfKind<Kind> = {
     [Unit in DeclaredUnit]: KindOfSymbol<Unit> extends Kind ? Unit : never;
 }[DeclaredUnit];
-/** The ladder `Unit` is declared on, or `never` for a unit that climbs none. */
+/**
+ * The ladder `Unit` is declared on, or `never` for a unit that climbs none.
+ *
+ * @category Unit
+ */
 type LadderOfSymbol<Unit extends string> = Unit extends DeclaredUnit ? UnitDeclarations[Unit] extends {
     ladder: infer Ladder extends string;
 } ? Ladder : never : never;
 /**
- * Every symbol of kind `Kind` that exists only as a conversion TARGET (`°C`),
- * which the declarations do not name and {@link kindOfConversion} still
- * resolves. A pair whose source is itself undeclared is skipped, or `°C→K`
+ * Every symbol of kind `Kind` that exists only as a conversion target (`°C`),
+ * which the declarations do not name but a conversion still reaches. A pair whose source is itself undeclared is skipped, or `°C→K`
  * would make every kind accept `K`.
+ *
+ * @category Unit
  */
 type ConversionTargetsOfKind<Kind> = {
     [Conversion in keyof typeof CONVERSIONS]: Conversion extends `${infer Source}→${infer Target}` ? [KindOfSymbol<Source>] extends [never] ? never : [KindOfSymbol<Source>] extends [Kind] ? Target : never : never;
@@ -42,14 +53,14 @@ type ConversionTargetsOfKind<Kind> = {
  */
 type FormatsFor<Unit extends string> = string extends Unit ? string : FormatsForKind<KindOfSymbol<Unit>>;
 /**
- * {@link FormatsFor}, asked of the KIND rather than of one of its units, for a
+ * {@link FormatsFor}, asked of the kind rather than of one of its units, for a
  * pin addressed to a whole group that has no single unit to check against.
  *
  * @category Unit
  */
 type FormatsForKind<Kind> = SymbolsOfKind<Kind>;
 /**
- * Every unit a value in `Unit` may be SHOWN as, which is every unit of its kind
+ * Every unit a value in `Unit` may be shown as, which is every unit of its kind
  * plus the presentation-only ones the conversion table reaches.
  *
  * Wider than {@link FormatsFor} by exactly the symbols that are not on the
@@ -60,7 +71,7 @@ type FormatsForKind<Kind> = SymbolsOfKind<Kind>;
  */
 type PresentableAs<Unit extends string> = string extends Unit ? string : PresentableAsKind<KindOfSymbol<Unit>>;
 /**
- * {@link PresentableAs}, asked of the KIND. See {@link FormatsForKind}.
+ * {@link PresentableAs}, asked of the kind. See {@link FormatsForKind}.
  *
  * @category Unit
  */
@@ -70,11 +81,15 @@ type PresentableAsKind<Kind> = SymbolsOfKind<Kind> | ConversionTargetsOfKind<Kin
  * `m` and `km` are interchangeable and `m` and `m/s` are not, and it selects
  * the ladder and the precision rule.
  *
+ * A kind names a dimension, never a unit symbol: `length` is what `m` and `km`
+ * measure, `planeAngle` is what `°` measures and `universalTime` is what `ut`
+ * measures.
+ *
  * @category Unit
  */
 type KnownQuantityKind = "length" | "speed" | "acceleration" | "mass" | "force" | "pressure" | "temperature" | "time" | "universalTime" | "specificImpulse" | "irlTime" | "planeAngle" | "power" | "data" | "dataRate" | "doseRate" | "irradiance" | "level" | "density" | "massFlow" | "gravParameter" | "dimensionless" | "percent" | "scienceData" | "scienceRate" | "ratio" | "area" | "volume" | "angularSpeed" | "funds" | "science" | "reputation" | "fundsRate" | "reputationRate" | "count" | "id" | "resourceUnits" | "resourceFlow" | "text" | "flag" | "enum" | "n/a";
 /**
- * A quantity kind, OPEN to kinds this package has never heard of.
+ * A quantity kind, open to kinds this package has never heard of.
  *
  * The `string & {}` member lets a third-party Uplink introduce its own dimension
  * while the known kinds still autocomplete.
@@ -101,7 +116,7 @@ type LadderName = {
     [Unit in DeclaredUnit]: LadderOfSymbol<Unit>;
 }[DeclaredUnit];
 /**
- * What a pin may be addressed to: one GROUP, named the way the group is formed.
+ * What a pin may be addressed to: one group, named the way the group is formed.
  *
  * A unit on a ladder is named by the ladder, because every unit of it settles
  * together and `m`, `km` and `Mm` are one thing to pin. Everything else is named
@@ -161,13 +176,13 @@ declare const CONVERSIONS: {
     };
 };
 /**
- * A quantity as a screen reader should hear it: the value followed by the
- * unit's WORD rather than its symbol.
- *
- * For the places that cannot take a node (`aria-label`, `title`, an SVG
- * `aria-valuetext`), so an accessible name reads "250.0 kilometres" rather
- * than "kay em". If the result is going to be rendered, use {@link Unit} or
- * {@link writeQuantity}. Falls back to the symbol for a unit with no word.
+ * A quantity as text for a screen reader: the value followed by the unit's
+ * word, so an accessible name reads "250.0 kilometres" where the symbol would
+ * be spoken as "kay em". Useful in the places that cannot take a node
+ * (`aria-label`, `title`, an SVG `aria-valuetext`). Used by {@link Dial} and
+ * {@link Meter} for their accessible values. To render a quantity, use
+ * {@link Unit} or {@link writeQuantity}. Falls back to the symbol for a unit
+ * with no word.
  *
  * @category Unit
  */
@@ -176,7 +191,7 @@ declare function speakQuantity(quantity: {
     unit: string;
 } | null | undefined, opts?: FormatQuantityOptions): string;
 /**
- * A quantity as it is WRITTEN: the value and the unit's symbol, `250.0 km`.
+ * A quantity as it is written: the value and the unit's symbol, `250.0 km`.
  *
  * For visible text that cannot take a node: an SVG `<text>`, a canvas label, a
  * chart annotation measured before it is drawn. Anywhere a node fits, use
@@ -191,6 +206,11 @@ declare function writeQuantity(quantity: {
     magnitude: number;
     unit: string;
 } | null | undefined, opts?: FormatQuantityOptions): string;
+/**
+ * How a quantity is written: the unit to pin, the number of decimals, and the scale to draw it against.
+ *
+ * @category Unit
+ */
 interface FormatQuantityOptions {
     /**
      * Pin the unit rather than letting the ladder choose, for where convention
@@ -219,7 +239,13 @@ interface FormatQuantityOptions {
     as?: string;
     /** Override the kind's decimal places. */
     decimals?: number;
-    /** The rung the value was last shown at, so a value hovering on a boundary does not flicker. */
+    /**
+     * The unit the last render settled on, read from the formatted quantity's `rung`.
+     * Pass it back so a value hovering on a boundary between two units does not
+     * flicker between them. Nothing keeps it for you: {@link Unit} formats each
+     * render from its props alone, so a caller that wants the steadiness holds
+     * the last rung and passes it here.
+     */
     heldSymbol?: string;
 }
 /**
@@ -256,7 +282,7 @@ interface QuantityScale {
 /**
  * Build a {@link QuantityScale} whose rung is taken from `reference`.
  *
- * `reference` is the value that DEFINES the scale rather than a value on it:
+ * `reference` is the value that defines the scale rather than a value on it:
  * the top of an altimeter strip, an axis maximum. `opts.format` pins the rung
  * outright.
  *
@@ -267,4 +293,4 @@ declare function quantityScale(reference: {
     unit: string;
 } | null | undefined, opts?: FormatQuantityOptions): QuantityScale;
 
-export { type FormatQuantityOptions as F, type KindOfGroup as K, type LadderName as L, type PresentableAs as P, type QuantityKind as Q, type Rung as R, type UnitGroupKey as U, type FormatsFor as a, type FormatsForKind as b, type PresentableAsKind as c, type KnownQuantityKind as d, type QuantityScale as e, speakQuantity as f, quantityScale as q, setQuantityLocale as s, writeQuantity as w };
+export { type ConversionTargetsOfKind as C, type FormatQuantityOptions as F, type KindOfGroup as K, type LadderName as L, type PresentableAs as P, type QuantityKind as Q, type Rung as R, type SymbolsOfKind as S, type UnitGroupKey as U, type FormatsFor as a, type FormatsForKind as b, type PresentableAsKind as c, type KindOfSymbol as d, type KnownQuantityKind as e, type LadderOfSymbol as f, type QuantityScale as g, speakQuantity as h, quantityScale as q, setQuantityLocale as s, writeQuantity as w };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@ksp-gonogo/ui-kit",
   "description": "Export-safe design system for Gonogo mission-control widgets and third-party Uplinks",
   "license": "MIT",
-  "version": "1.0.0-rc.21",
+  "version": "1.0.0-rc.27",
   "type": "module",
   "repository": {
     "type": "git",
@@ -33,14 +33,15 @@
     "./guards": {
       "types": "./dist/guards.d.ts",
       "import": "./dist/guards.js"
-    }
+    },
+    "./reads-index.json": "./dist/reads-index.json"
   },
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsup && node scripts/extend-package-specifiers.mjs && cp node_modules/@ksp-gonogo/theme/dist/tokens.css dist/tokens.css",
+    "build": "tsup && node scripts/extend-package-specifiers.mjs && cp node_modules/@ksp-gonogo/theme/dist/tokens.css dist/tokens.css && node ../../scripts/build-reads-index.mjs @ksp-gonogo/ui-kit src/index.ts,src/guards.ts,src/gridUnits.ts",
     "dev": "tsup --watch",
     "lint": "tsc --noEmit",
     "render:markers": "node scripts/render-markers.ts",
@@ -75,23 +76,15 @@
   },
   "peerDependencies": {
     "@fontsource/jetbrains-mono": "^5.0.0",
-    "esbuild": "^0.25.0 || ^0.28.0",
     "jest-axe": "^10.0.0",
-    "playwright": "^1.50.0",
     "react": "^18.0.0",
     "styled-components": "^6.0.0",
-    "@ksp-gonogo/sitrep-sdk": "1.0.0-rc.21"
+    "@ksp-gonogo/sitrep-sdk": "1.0.0-rc.27"
   },
   "peerDependenciesMeta": {
     "jest-axe": {
       "optional": true
     },
-    "esbuild": {
-      "optional": true
-    },
-    "playwright": {
-      "optional": true
-    },
     "@fontsource/jetbrains-mono": {
       "optional": true
     }