@machfivetechchicago/machvive-neodigm55-ux 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 MachFiveTech Chicago
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,122 @@
-# Temporary Holding Version
+<h1 align="center">machvive-neodigm55-ux</h1>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<p align="center">
+  <strong>Remember when the Web was fun?</strong><br>
+  The UX for those that think for themselves — Neodigm 55 as dependency-free
+  Web Components, by <a href="https://github.com/Mach-Five-Group">MachFiveTech Chicago</a>.
+</p>
+
+<p align="center">
+  <img alt="dependencies" src="https://img.shields.io/badge/dependencies-0-brightgreen.svg">
+  <img alt="types" src="https://img.shields.io/badge/types-included-blue.svg">
+</p>
+
+Most component libraries give you parts. [Neodigm 55](https://www.thescottkrause.com/emerging_tech/neodigm55_ux_library/)
+does something else: it is **aware of every themed element on the page** and can move
+colour and attention across all of them at once — to pull a visitor toward a call to
+action, to acknowledge that something happened, to make a page feel alive.
+
+This package is that idea rebuilt as standards-based custom elements, with the
+choreography kept as the product rather than discarded as an implementation detail.
+
+```js
+import { robinTheme } from '@machfivetechchicago/machvive-neodigm55-ux/conductor';
+
+await robinTheme('brand');   // a wave of colour crosses every themed element, then recedes
+```
+
+## Two layers, one contract
+
+**The conductor** owns the palette, the motion gate and the choreography. It has no
+custom elements and never touches `HTMLElement`, so it imports in bare Node — a build
+step, a CI check or a theme builder can use it with no DOM at all.
+
+**The components** are instruments. They opt into choreography the same way anything
+else does: by carrying `data-n55-theme` on the host.
+
+That attribute is the entire contract, which is what keeps this open-ended:
+
+```html
+<button data-n55-theme="brand">          <!-- plain HTML        -->
+<neodigm-toast data-n55-theme="brand">   <!-- a component here   -->
+<my-lit-card data-n55-theme="brand">     <!-- a Lit component    -->
+<div data-n55-theme="brand">             <!-- React output       -->
+```
+
+All four are swept by the same call. Nothing in the conductor knows what a Neodigm
+component is, so adopting it never means adopting a framework.
+
+> **Shadow DOM is deliberately out of reach.** `querySelectorAll` does not cross a
+> shadow boundary, so a component is swept by its *host* attribute and styles its
+> internals from that (`:host([data-n55-theme="brand"])`) or from the inherited
+> custom properties. A test pins this, because it is the one way to use it wrong.
+
+## Install
+
+```bash
+npm i @machfivetechchicago/machvive-neodigm55-ux
+```
+
+```js
+import '@machfivetechchicago/machvive-neodigm55-ux';            // everything
+import '@machfivetechchicago/machvive-neodigm55-ux/toast';      // one component
+import { robinTheme } from '@machfivetechchicago/machvive-neodigm55-ux/conductor';
+```
+
+## The palette
+
+Thirteen themes, carried over unchanged: `brand`, `primary`, `secondary`, `success`,
+`white`, `ghost`, `danger`, `warning`, `info`, `disabled`, `night`, `marcom`, `party`.
+
+They install as CSS custom properties rather than living in a JavaScript object, which
+is the difference that makes a theme builder possible:
+
+```js
+import { installTheme, themeCss } from '@machfivetechchicago/machvive-neodigm55-ux/conductor';
+
+installTheme();                    // --n55-brand, --n55-brand-deep, --n55-brand-glyph, …
+themeCss(myPalette, '.promo');     // or emit a stylesheet for a section, or for a build
+```
+
+Override `--n55-brand` on a page and every component follows, with no rebuild and no
+component aware it happened. `disabled` doubles as the opt-out: an element themed
+`disabled` is never choreographed.
+
+## Toast
+
+```html
+<neodigm-toast></neodigm-toast>
+<button data-n55-toast="Saved ✨" data-n55-theme="success">Save</button>
+```
+
+```js
+document.querySelector('neodigm-toast')
+  .show('Saved ✨', { theme: 'success' })
+  .show('Queued behind it', { duration: 3000 });
+```
+
+Queued, with the original's debounce — the same message twice in a row is the same
+notification. `|` breaks the line. **Message text is never parsed as HTML**, unlike the
+original's `innerHTML`, because toast text is routinely built from user input.
+
+## What changed in the port
+
+| | Original | Here |
+| --- | --- | --- |
+| Markup | required `<div id="js-snackbar__id">` on the page | the element renders its own |
+| Styling | global `.snackbar__cont--*` classes | scoped to a shadow root |
+| Theme | hex values in a JS object | CSS custom properties |
+| Sound, haptics, GTM | always on, via four other modules | opt-in, none wired by default |
+| Reduced motion | a `// TODO` above `robinTheme` | respected; the sweep is suppressed, the signal is not |
+| Sweep timing | each element held the colour for `index × 56ms`, so the first never visibly changed | constant `hold`, so the wave keeps its shape |
+| Message text | `innerHTML` | text nodes |
+
+## Browser support
+
+Anywhere `customElements`, Shadow DOM and CSS custom properties work. No build step, no
+framework, no runtime dependencies — the files published are the files that run.
+
+## Licence
+
+[Apache-2.0](LICENSE) © MachFiveTech Chicago. Ported from
+[neodigm55](https://github.com/arcanus55/neodigm55) by Arcanus 55, Inc.

package/index.d.ts

@@ -0,0 +1,7 @@
+export { NeodigmToast, DEFAULT_DURATION } from './src/wc/neodigm-toast/neodigm-toast.js';
+export type { ToastOptions, QueuedToast } from './src/wc/neodigm-toast/neodigm-toast.js';
+export { NeodigmMarquee, DEFAULT_SPEED, parseRuns, plainText } from './src/wc/neodigm-marquee/neodigm-marquee.js';
+export type { MarqueeCell } from './src/wc/neodigm-marquee/neodigm-marquee.js';
+export { NeodigmTulip, TULIP_DEFAULTS, readConfig, configFrom } from './src/wc/neodigm-tulip/neodigm-tulip.js';
+export type { TulipConfig } from './src/wc/neodigm-tulip/neodigm-tulip.js';
+export * from './src/conductor/index.js';

package/index.js

@@ -0,0 +1,22 @@
+/**
+ * Bulk entry point: imports every component (registering its tag) and
+ * re-exports the conductor.
+ *
+ * Importing this evaluates `class extends HTMLElement`, so it needs a DOM.
+ * For a build step, a CI check or a theme-builder script, import
+ * `@machfivetechchicago/machvive-neodigm55-ux/conductor` instead — it has no
+ * DOM dependency and loads in bare Node.
+ */
+import { NeodigmToast, DEFAULT_DURATION } from './src/wc/neodigm-toast/neodigm-toast.js';
+import { NeodigmMarquee, DEFAULT_SPEED, parseRuns, plainText } from './src/wc/neodigm-marquee/neodigm-marquee.js';
+import { NeodigmTulip, TULIP_DEFAULTS, readConfig, configFrom } from './src/wc/neodigm-tulip/neodigm-tulip.js';
+
+export { NeodigmToast, DEFAULT_DURATION };
+export { NeodigmMarquee, DEFAULT_SPEED, parseRuns, plainText };
+export { NeodigmTulip, TULIP_DEFAULTS, readConfig, configFrom };
+export {
+  THEMES, THEME_NAMES, OPT_OUT, THEME_ATTR, PULSE_ATTR,
+  themeCss, installTheme, resolveTheme,
+  motionAllowed, setMotionAllowed, pause, play, onMotionChange, resetMotion,
+  robinTheme, pulseTheme, flashTitle, resetTitle
+} from './src/conductor/index.js';

package/package.json

@@ -1,6 +1,76 @@
 {
   "name": "@machfivetechchicago/machvive-neodigm55-ux",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "Neodigm 55 as dependency-free Web Components — a page-level choreographer that moves colour and attention across every themed element, plus the components it conducts.",
+  "keywords": [
+    "web-components",
+    "webcomponents",
+    "custom-elements",
+    "ux",
+    "ui",
+    "design-system",
+    "theme",
+    "toast",
+    "snackbar",
+    "neodigm",
+    "no-dependencies",
+    "esm"
+  ],
+  "type": "module",
+  "main": "index.js",
+  "module": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./conductor": {
+      "types": "./src/conductor/index.d.ts",
+      "default": "./src/conductor/index.js"
+    },
+    "./toast": {
+      "types": "./src/wc/neodigm-toast/neodigm-toast.d.ts",
+      "default": "./src/wc/neodigm-toast/neodigm-toast.js"
+    },
+    "./marquee": {
+      "types": "./src/wc/neodigm-marquee/neodigm-marquee.d.ts",
+      "default": "./src/wc/neodigm-marquee/neodigm-marquee.js"
+    },
+    "./tulip": {
+      "types": "./src/wc/neodigm-tulip/neodigm-tulip.d.ts",
+      "default": "./src/wc/neodigm-tulip/neodigm-tulip.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": true,
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "src"
+  ],
+  "scripts": {
+    "test": "node --test --import ./test/setup.js \"test/*.test.js\"",
+    "test:watch": "node --test --watch --import ./test/setup.js \"test/*.test.js\"",
+    "prepublishOnly": "npm test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Mach-Five-Group/machvive-neodigm55-ux.git"
+  },
+  "homepage": "https://github.com/Mach-Five-Group/machvive-neodigm55-ux#readme",
+  "bugs": {
+    "url": "https://github.com/Mach-Five-Group/machvive-neodigm55-ux/issues"
+  },
+  "author": "MachFiveTech Chicago",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "jsdom": "^29.1.1"
+  }
+}

package/src/conductor/anchor.d.ts

@@ -0,0 +1,26 @@
+export interface Rect { x: number; y: number; width: number; height: number }
+export type Side = 'top' | 'right' | 'bottom' | 'left';
+
+export interface Placement {
+  x: number;
+  y: number;
+  /** The side actually used, which may differ from the one asked for. */
+  side: Side;
+  /** True when the preferred side did not fit and another was chosen. */
+  flipped: boolean;
+  /** True when no side fitted and the surface was pulled back on screen. */
+  clamped: boolean;
+}
+
+/** Chooses a side and position for a floating surface. Pure: no DOM. */
+export function place(options: {
+  trigger: Rect;
+  surface: Rect;
+  viewport: { width: number; height: number };
+  position?: Side;
+  gap?: number;
+  pad?: number;
+}): Placement;
+
+/** Reads an element's rectangle in the shape `place` expects. */
+export function rectOf(el: Element): Rect;

package/src/conductor/anchor.js

@@ -0,0 +1,102 @@
+/**
+ * Placing a floating surface next to the thing it describes.
+ *
+ * Deliberately pure: it takes rectangles and returns coordinates, reads nothing
+ * from the DOM and touches nothing. That keeps it in the headless conductor —
+ * testable in Node, and shared by every floating surface rather than
+ * reimplemented in each. The components do the measuring; this does the
+ * deciding.
+ *
+ * The original computed `left` inline inside Tulip's `open()` from
+ * `getBoundingClientRect()` and never checked whether the result fitted on
+ * screen, so a tip on a trigger near the right edge rendered off the viewport.
+ */
+
+/** @typedef {{ x: number, y: number, width: number, height: number }} Rect */
+/** @typedef {'top'|'right'|'bottom'|'left'} Side */
+
+/** The order to try when a preferred side does not fit: its opposite first. */
+const FALLBACKS = {
+  top: ['top', 'bottom', 'right', 'left'],
+  bottom: ['bottom', 'top', 'right', 'left'],
+  left: ['left', 'right', 'top', 'bottom'],
+  right: ['right', 'left', 'top', 'bottom']
+};
+
+/** Where the surface would sit on a given side, before any clamping. */
+function sideOffset(trigger, surface, side, gap) {
+  const midX = trigger.x + trigger.width / 2 - surface.width / 2;
+  const midY = trigger.y + trigger.height / 2 - surface.height / 2;
+  switch (side) {
+    case 'top':    return { x: midX, y: trigger.y - surface.height - gap };
+    case 'bottom': return { x: midX, y: trigger.y + trigger.height + gap };
+    case 'left':   return { x: trigger.x - surface.width - gap, y: midY };
+    default:       return { x: trigger.x + trigger.width + gap, y: midY };
+  }
+}
+
+const fits = (at, surface, viewport, pad) =>
+  at.x >= pad && at.y >= pad &&
+  at.x + surface.width <= viewport.width - pad &&
+  at.y + surface.height <= viewport.height - pad;
+
+/**
+ * Chooses a side and position for a floating surface.
+ *
+ * Tries the preferred side, then its opposite, then the two perpendicular ones,
+ * and takes the first that fits the viewport. If none fits — a surface larger
+ * than the space available — it keeps the preferred side and clamps, because
+ * a tip half off-screen is still readable and one placed somewhere arbitrary is
+ * confusing.
+ *
+ * @param {object} options
+ * @param {Rect} options.trigger The element being described, in viewport coordinates.
+ * @param {Rect} options.surface The floating surface's own size.
+ * @param {{ width: number, height: number }} options.viewport
+ * @param {Side} [options.position] Preferred side.
+ * @param {number} [options.gap] Space between trigger and surface.
+ * @param {number} [options.pad] Minimum distance from the viewport edge.
+ * @returns {{ x: number, y: number, side: Side, flipped: boolean, clamped: boolean }}
+ */
+export function place({ trigger, surface, viewport, position = 'top', gap = 8, pad = 4 }) {
+  const order = FALLBACKS[position] ?? FALLBACKS.top;
+
+  for (const side of order) {
+    const at = sideOffset(trigger, surface, side, gap);
+    if (fits(at, surface, viewport, pad)) {
+      return { ...at, side, flipped: side !== position, clamped: false };
+    }
+  }
+
+  // Nothing fitted. Keep the author's chosen side and pull it back on screen.
+  const at = sideOffset(trigger, surface, position, gap);
+  const maxX = Math.max(pad, viewport.width - surface.width - pad);
+  const maxY = Math.max(pad, viewport.height - surface.height - pad);
+  return {
+    x: Math.min(Math.max(at.x, pad), maxX),
+    y: Math.min(Math.max(at.y, pad), maxY),
+    side: position,
+    flipped: false,
+    clamped: true
+  };
+}
+
+/**
+ * Reads a DOM element's rectangle in the shape `place` expects.
+ *
+ * The one DOM-touching function here, kept beside the maths so a component does
+ * not have to remember which coordinate space `place` works in. Returns zeroes
+ * where there is no layout engine, which is what jsdom reports anyway.
+ *
+ * @param {Element} el
+ * @returns {Rect}
+ */
+export function rectOf(el) {
+  const r = el?.getBoundingClientRect?.();
+  return {
+    x: r?.left ?? 0,
+    y: r?.top ?? 0,
+    width: r?.width ?? 0,
+    height: r?.height ?? 0
+  };
+}

package/src/conductor/choreography.d.ts

@@ -0,0 +1,34 @@
+export interface SweepOptions {
+  /** Subtree to sweep. Defaults to the whole document. */
+  context?: ParentNode;
+  /** ms between each element starting. */
+  stagger?: number;
+  /** ms each element holds the colour. Constant, unlike the original. */
+  hold?: number;
+  /** Aborting restores every element immediately. */
+  signal?: AbortSignal;
+  /** Also flash the tab title. */
+  flashTab?: boolean;
+}
+
+/**
+ * Sweeps a colour across every `[data-n55-theme]` element, then restores each.
+ *
+ * Does not cross shadow boundaries: a component is swept by its host attribute
+ * and styles its internals from that.
+ *
+ * @returns how many elements were swept.
+ */
+export function robinTheme(theme?: string, options?: SweepOptions): Promise<number>;
+
+/** The slower `[data-n55-theme-pulse]` cycle. */
+export function pulseTheme(
+  theme?: string,
+  options?: Omit<SweepOptions, 'flashTab'>
+): Promise<number>;
+
+/** Prefixes the tab title with a theme's glyph, then restores it. */
+export function flashTitle(theme: string, ms?: number, options?: { doc?: Document }): boolean;
+
+/** Test seam: drops the captured title and any pending restore. */
+export function resetTitle(): void;