Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5f52def422 | ||
|
|
532bda5c74 | ||
|
|
e38c7d6c9c | ||
|
|
05fbfee136 | ||
|
|
a1774cbe77 | ||
|
|
0c9f833863 | ||
|
|
52895199be |
@@ -1,5 +1,69 @@
|
||||
# NestQuest Release Notes
|
||||
|
||||
## Version 0.9.8 — 2026-09-30
|
||||
|
||||
### Scope
|
||||
|
||||
Owner-directed change: the application's timezone is now **manual-only and
|
||||
admin-authoritative**. Nothing sets it automatically any more; an admin sets it
|
||||
from the admin app, and the saved value is the single source of local time for
|
||||
the whole application. This reverses the automatic Home Assistant zone adoption
|
||||
shipped in 0.9.6 and the admin app's browser-zone auto-set, and supersedes
|
||||
decision D-018 with D-019. (PRs #282, #283, #285, #286; feature
|
||||
`a3cd8e27` "Manual application timezone control".)
|
||||
|
||||
### Behaviour
|
||||
|
||||
- **No automatic timezone setting.** Removed: the API's adoption of Home
|
||||
Assistant's reported zone (the `X-NestQuest-Timezone` request header and the
|
||||
`adopt_reported_timezone` path), the integration's reporting of
|
||||
`hass.config.time_zone`, the admin app's browser-zone auto-detect and
|
||||
automatic save, and the `timezone_configured` marker.
|
||||
- **The admin sets it manually**, in the admin app's Preferences: a curated IANA
|
||||
zone picker plus a free "Other IANA zone" entry, with an explicit choice for
|
||||
empty ("API host local time"). Nothing is auto-filled or auto-saved.
|
||||
- **The saved value is authoritative across the whole application**: the panel
|
||||
snapshot's overdue/today derivation, both panel cards' dates and clocks,
|
||||
completion timestamps, the missed-sweep scheduler, and the admin reads all use
|
||||
it. The API publishes the effective zone (`api/host_zone.effective_timezone`:
|
||||
the saved value, else the API host's own zone) on the panel snapshot and the
|
||||
admin settings response, so the panel and admin app render in the same zone.
|
||||
- **The kids' panel now follows the application zone, not the browser.** This
|
||||
supersedes the panel-local overdue behaviour from 0.9.7; a quest is overdue
|
||||
when the application clock says so, not when the panel device's clock does.
|
||||
- **An admin save of the timezone or the day-rollover time re-plans the running
|
||||
missed-sweep scheduler.**
|
||||
- The integration tolerates an API snapshot without the timezone field, so the
|
||||
integration and the API may be upgraded in either order.
|
||||
|
||||
### Requirements
|
||||
|
||||
- Home Assistant floor 2024.6.0 (unchanged).
|
||||
|
||||
### Breaking changes
|
||||
|
||||
- None to the database. The schema is unchanged at version 9: no migration and
|
||||
no database backup is required for this release.
|
||||
- Behavioural reversal: if a timezone had been auto-set by 0.9.6–0.9.7, the
|
||||
stored value persists after upgrading (it is simply no longer changed
|
||||
automatically), so no action is needed unless a different zone is wanted.
|
||||
- With no timezone saved, the API host's local zone applies (UTC on the standard
|
||||
deployment). Set the timezone in the admin Preferences for correct
|
||||
household-local behaviour. A previously auto-set value counts as saved and
|
||||
will be kept.
|
||||
|
||||
### Known limitations
|
||||
|
||||
- If no timezone has been saved, the API host zone applies; on the standard
|
||||
UTC-host deployment, overdue and day boundaries will be wrong until an admin
|
||||
sets the zone.
|
||||
- The admin app's timezone picker replaces any zone outside its curated list via
|
||||
the "Other IANA zone" entry; the value is validated as an IANA name.
|
||||
|
||||
### Rollback
|
||||
|
||||
- No schema change: rolling back to 0.9.7 requires no database restore.
|
||||
|
||||
## Version 0.9.7 — 2026-09-29
|
||||
|
||||
### Scope
|
||||
|
||||
@@ -614,3 +614,34 @@
|
||||
.defs-emoji {
|
||||
line-height: 1;
|
||||
}
|
||||
|
||||
/* Font Awesome search: glyph + label tiles, inline validation, paging */
|
||||
.defs-icon-grid--results {
|
||||
grid-template-columns: repeat(auto-fill, minmax(88px, 1fr));
|
||||
}
|
||||
|
||||
.defs-icon-result {
|
||||
flex-direction: column;
|
||||
gap: 4px;
|
||||
padding: 6px 4px;
|
||||
font-family: inherit;
|
||||
}
|
||||
|
||||
.defs-icon-label {
|
||||
max-width: 100%;
|
||||
overflow: hidden;
|
||||
font-size: 11px;
|
||||
font-weight: 600;
|
||||
text-overflow: ellipsis;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.defs-hint--error {
|
||||
color: var(--nq-a-danger-strong);
|
||||
}
|
||||
|
||||
.defs-show-more {
|
||||
align-self: flex-start;
|
||||
display: flex;
|
||||
gap: 8px;
|
||||
}
|
||||
|
||||
@@ -7,8 +7,10 @@ import {
|
||||
FA_DEFINITION_ICONS,
|
||||
emojiIconKey,
|
||||
faIconName,
|
||||
faTypedIconKey,
|
||||
findDefinitionIcon,
|
||||
normalizeDefinitionIconName,
|
||||
searchFaIcons,
|
||||
} from "./definitionIcons";
|
||||
import type { AdminChild, DefinitionRule, QuestDefinition } from "../api/definitions";
|
||||
import { storeTokens } from "../auth/oidc";
|
||||
@@ -1529,6 +1531,245 @@ describe("DefinitionsTab Font Awesome and emoji icons", () => {
|
||||
});
|
||||
});
|
||||
|
||||
/* ── Font Awesome search ────────────────────────────────────────────── */
|
||||
|
||||
describe("DefinitionsTab Font Awesome search", () => {
|
||||
beforeEach(() => {
|
||||
sessionStorage.clear();
|
||||
storeTokens({ access_token: "at-123", expires_in: 600 });
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
cleanup();
|
||||
vi.unstubAllGlobals();
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
const CURATED = new Set(FA_DEFINITION_ICONS.map((icon) => icon.name));
|
||||
|
||||
function searchInput(s: HTMLElement): HTMLInputElement {
|
||||
return within(s).getByRole("searchbox", { name: "Search Font Awesome icons" }) as HTMLInputElement;
|
||||
}
|
||||
|
||||
function results(s: HTMLElement): HTMLElement {
|
||||
return within(s).getByRole("radiogroup", { name: "Font Awesome search results" });
|
||||
}
|
||||
|
||||
function resultKeys(s: HTMLElement): string[] {
|
||||
return within(results(s))
|
||||
.getAllByRole("radio")
|
||||
.map((option) => option.getAttribute("data-icon-option")!);
|
||||
}
|
||||
|
||||
function rowFaIcon(row: HTMLElement): string | null {
|
||||
const svg = row.querySelector(".defs-row-glyph svg");
|
||||
return svg!.getAttribute("fill") === "none" ? null : svg!.getAttribute("data-icon");
|
||||
}
|
||||
|
||||
async function save(s: HTMLElement) {
|
||||
await act(async () => {
|
||||
fireEvent.click(within(s).getByRole("button", { name: "Save changes" }));
|
||||
});
|
||||
}
|
||||
|
||||
function fillNewTask(s: HTMLElement) {
|
||||
fireEvent.change(within(s).getByRole("textbox", { name: "Title" }), {
|
||||
target: { value: "Walk the dog" },
|
||||
});
|
||||
fireEvent.click(within(s).getByRole("button", { name: /Assigned children/ }));
|
||||
fireEvent.click(within(s).getByRole("checkbox", { name: "Declan" }));
|
||||
fireEvent.click(within(s).getByRole("button", { name: "Morning" }));
|
||||
}
|
||||
|
||||
it("searches the full Free Solid set by name or label, exact and prefix matches first", () => {
|
||||
expect(searchFaIcons("")).toEqual([]);
|
||||
expect(searchFaIcons(" ")).toEqual([]);
|
||||
const dog = searchFaIcons(" DOG ").map((icon) => icon.name);
|
||||
expect(dog[0]).toBe("dog");
|
||||
expect(dog).toEqual(expect.arrayContaining(["hotdog", "shield-dog"]));
|
||||
expect(dog.some((name) => !CURATED.has(name))).toBe(true);
|
||||
// A label match: "Shield Dog" contains "shield d" though no name does.
|
||||
expect(searchFaIcons("shield d").map((icon) => icon.name)).toContain("shield-dog");
|
||||
expect(searchFaIcons("dog-leashed")).toEqual([]);
|
||||
|
||||
expect(faTypedIconKey("dragon")).toBe("fa:dragon");
|
||||
expect(faTypedIconKey(" Dragon ")).toBe("fa:dragon");
|
||||
for (const bad of ["", "drag", "dgo", "dog-leashed", "github", "fa:dog"]) {
|
||||
expect(faTypedIconKey(bad), bad).toBeNull();
|
||||
}
|
||||
});
|
||||
|
||||
it("shows the curated quick picks while the search is empty", async () => {
|
||||
await renderReady();
|
||||
fireEvent.click(screen.getByRole("button", { name: "New" }));
|
||||
const s = sheet();
|
||||
expect(searchInput(s).value).toBe("");
|
||||
const quick = within(s).getByRole("radiogroup", { name: "Font Awesome" });
|
||||
expect(within(quick).getAllByRole("radio")).toHaveLength(FA_DEFINITION_ICONS.length);
|
||||
expect(within(s).queryByRole("radiogroup", { name: "Font Awesome search results" })).toBeNull();
|
||||
});
|
||||
|
||||
it("a query swaps the quick picks for one bounded, labelled page of results", async () => {
|
||||
await renderReady();
|
||||
fireEvent.click(screen.getByRole("button", { name: "New" }));
|
||||
const s = sheet();
|
||||
fireEvent.change(searchInput(s), { target: { value: "a" } });
|
||||
const total = searchFaIcons("a").length;
|
||||
expect(total).toBeGreaterThan(80);
|
||||
expect(within(s).queryByRole("radiogroup", { name: "Font Awesome" })).toBeNull();
|
||||
expect(resultKeys(s)).toHaveLength(40);
|
||||
expect(within(results(s)).getAllByRole("radio")[0].textContent).toBe(searchFaIcons("a")[0].label);
|
||||
expect(within(s).getByText(`Showing 1–40 of ${total}`)).toBeTruthy();
|
||||
expect(within(s).queryByRole("button", { name: "Previous" })).toBeNull();
|
||||
|
||||
// "Show more" replaces the page rather than appending to it.
|
||||
const firstPage = resultKeys(s);
|
||||
fireEvent.click(within(s).getByRole("button", { name: "Show more" }));
|
||||
expect(resultKeys(s)).toEqual(searchFaIcons("a").slice(40, 80).map((icon) => `fa:${icon.name}`));
|
||||
expect(resultKeys(s).some((key) => firstPage.includes(key))).toBe(false);
|
||||
expect(within(s).getByText(`Showing 41–80 of ${total}`)).toBeTruthy();
|
||||
fireEvent.click(within(s).getByRole("button", { name: "Previous" }));
|
||||
expect(resultKeys(s)).toEqual(firstPage);
|
||||
|
||||
// A new query starts again from the first page.
|
||||
fireEvent.change(searchInput(s), { target: { value: "dog" } });
|
||||
expect(resultKeys(s)[0]).toBe("fa:dog");
|
||||
expect(resultKeys(s)).toContain("fa:hotdog");
|
||||
expect(within(s).queryByRole("button", { name: "Show more" })).toBeNull();
|
||||
|
||||
fireEvent.change(searchInput(s), { target: { value: "" } });
|
||||
expect(within(s).getByRole("radiogroup", { name: "Font Awesome" })).toBeTruthy();
|
||||
});
|
||||
|
||||
it("paging through every match never mounts more than one page", async () => {
|
||||
await renderReady();
|
||||
fireEvent.click(screen.getByRole("button", { name: "New" }));
|
||||
const s = sheet();
|
||||
fireEvent.change(searchInput(s), { target: { value: "-" } });
|
||||
const all = searchFaIcons("-").map((icon) => `fa:${icon.name}`);
|
||||
expect(all.length).toBeGreaterThan(900);
|
||||
|
||||
const seen: string[] = [];
|
||||
for (;;) {
|
||||
expect(results(s).children.length).toBeGreaterThan(0);
|
||||
expect(results(s).children.length).toBeLessThanOrEqual(40);
|
||||
seen.push(...resultKeys(s));
|
||||
const more = within(s).queryByRole("button", { name: "Show more" });
|
||||
if (!more) break;
|
||||
fireEvent.click(more);
|
||||
}
|
||||
// Every match stays reachable, one page at a time, in order.
|
||||
expect(seen).toEqual(all);
|
||||
const lastStart = Math.floor((all.length - 1) / 40) * 40 + 1;
|
||||
expect(within(s).getByText(`Showing ${lastStart}–${all.length} of ${all.length}`)).toBeTruthy();
|
||||
});
|
||||
|
||||
it("selecting a search result POSTs fa:<name> and renders on its row", async () => {
|
||||
await renderReady();
|
||||
fireEvent.click(screen.getByRole("button", { name: "New" }));
|
||||
const s = sheet();
|
||||
fillNewTask(s);
|
||||
fireEvent.change(searchInput(s), { target: { value: "hot" } });
|
||||
expect(within(s).getByRole("alert").textContent).toMatch(/Select a Font Awesome icon from the results/);
|
||||
const hotdog = within(results(s)).getByRole("radio", { name: "Hotdog" });
|
||||
fireEvent.click(hotdog);
|
||||
expect(hotdog.getAttribute("aria-checked")).toBe("true");
|
||||
expect(within(s).queryByRole("alert")).toBeNull();
|
||||
expect(searchInput(s).value).toBe("hot");
|
||||
|
||||
await save(s);
|
||||
expect((api.writes()[0].body as { icon: string }).icon).toBe("fa:hotdog");
|
||||
await waitFor(() => expect(rowFaIcon(screen.getByTestId("definition-99"))).toBe("hotdog"));
|
||||
});
|
||||
|
||||
it("a typed non-curated Free Solid name is accepted and PATCHed", async () => {
|
||||
expect(CURATED.has("dragon")).toBe(false);
|
||||
await renderReady([{ ...BRUSH, id: 70, icon: "lucide:dog" }]);
|
||||
fireEvent.click(screen.getByTestId("definition-70"));
|
||||
const s = sheet();
|
||||
fireEvent.change(searchInput(s), { target: { value: "Dragon" } });
|
||||
expect(within(s).queryByRole("alert")).toBeNull();
|
||||
expect(within(results(s)).getByRole("radio", { name: "Dragon" }).getAttribute("aria-checked")).toBe(
|
||||
"true",
|
||||
);
|
||||
const lucide = within(s).getByRole("radiogroup", { name: "Icon" });
|
||||
expect(within(lucide).queryAllByRole("radio", { checked: true })).toHaveLength(0);
|
||||
|
||||
await save(s);
|
||||
expect((api.writes()[0].body as { icon: string }).icon).toBe("fa:dragon");
|
||||
await waitFor(() => expect(rowFaIcon(screen.getByTestId("definition-70"))).toBe("dragon"));
|
||||
});
|
||||
|
||||
for (const [typed, message] of [
|
||||
["do", /Select a Font Awesome icon from the results/],
|
||||
["dgo", /“dgo” is not a Font Awesome Free Solid icon/],
|
||||
["dog-leashed", /“dog-leashed” is not a Font Awesome Free Solid icon/],
|
||||
["github", /“github” is not a Font Awesome Free Solid icon/],
|
||||
] as const) {
|
||||
it(`typed ${JSON.stringify(typed)} is rejected with a message and nothing is saved`, async () => {
|
||||
await renderReady([{ ...BRUSH, id: 71, icon: "lucide:dog" }]);
|
||||
fireEvent.click(screen.getByTestId("definition-71"));
|
||||
const s = sheet();
|
||||
fireEvent.change(searchInput(s), { target: { value: typed } });
|
||||
expect(within(s).getByRole("alert").textContent).toMatch(message);
|
||||
expect(within(s).getByRole("radio", { name: "No icon" }).getAttribute("aria-checked")).toBe("false");
|
||||
|
||||
await save(s);
|
||||
expect(api.writes()).toHaveLength(0);
|
||||
expect(within(s).getByTestId("sheet-error").textContent).toMatch(message);
|
||||
expect(screen.getByRole("dialog")).toBe(s);
|
||||
});
|
||||
}
|
||||
|
||||
it("clearing the search, or No icon, removes the icon", async () => {
|
||||
await renderReady([
|
||||
{ ...BRUSH, id: 72, icon: "fa:dragon" },
|
||||
{ ...BRUSH, id: 73, title: "Task 73", icon: "fa:dragon" },
|
||||
]);
|
||||
fireEvent.click(screen.getByTestId("definition-72"));
|
||||
let s = sheet();
|
||||
fireEvent.change(searchInput(s), { target: { value: "" } });
|
||||
expect(within(s).getByRole("radio", { name: "No icon" }).getAttribute("aria-checked")).toBe("true");
|
||||
await save(s);
|
||||
expect((api.writes()[0].body as { icon: string | null }).icon).toBeNull();
|
||||
await waitFor(() => expect(screen.queryByRole("dialog")).toBeNull());
|
||||
|
||||
fireEvent.click(screen.getByTestId("definition-73"));
|
||||
s = sheet();
|
||||
fireEvent.click(within(s).getByRole("radio", { name: "No icon" }));
|
||||
expect(searchInput(s).value).toBe("");
|
||||
await save(s);
|
||||
expect((api.writes()[1].body as { icon: string | null }).icon).toBeNull();
|
||||
});
|
||||
|
||||
it("a saved non-curated fa:<name> renders on its row and opens selected in the results", async () => {
|
||||
await renderReady([{ ...BRUSH, id: 74, icon: "fa:dragon" }]);
|
||||
expect(rowFaIcon(screen.getByTestId("definition-74"))).toBe("dragon");
|
||||
fireEvent.click(screen.getByTestId("definition-74"));
|
||||
const s = sheet();
|
||||
expect(searchInput(s).value).toBe("dragon");
|
||||
expect(within(s).queryByRole("alert")).toBeNull();
|
||||
expect(within(results(s)).getByRole("radio", { name: "Dragon" }).getAttribute("aria-checked")).toBe(
|
||||
"true",
|
||||
);
|
||||
|
||||
fireEvent.change(within(s).getByRole("textbox", { name: "Title" }), {
|
||||
target: { value: "Feed the dragon" },
|
||||
});
|
||||
await save(s);
|
||||
expect(api.writes()[0].body).not.toHaveProperty("icon");
|
||||
});
|
||||
|
||||
it("a saved curated fa:<name> opens in the quick picks with an empty search", async () => {
|
||||
await renderReady([{ ...BRUSH, id: 75, icon: "fa:dog" }]);
|
||||
fireEvent.click(screen.getByTestId("definition-75"));
|
||||
const s = sheet();
|
||||
expect(searchInput(s).value).toBe("");
|
||||
const quick = within(s).getByRole("radiogroup", { name: "Font Awesome" });
|
||||
expect(within(quick).getByRole("radio", { name: "Dog" }).getAttribute("aria-checked")).toBe("true");
|
||||
});
|
||||
});
|
||||
|
||||
/* ── Legacy icons ───────────────────────────────────────────────────── */
|
||||
|
||||
describe("DefinitionsTab legacy icon edits", () => {
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
*/
|
||||
import {
|
||||
useEffect,
|
||||
useMemo,
|
||||
useRef,
|
||||
useState,
|
||||
type KeyboardEvent as ReactKeyboardEvent,
|
||||
@@ -53,8 +54,12 @@ import {
|
||||
emojiIconText,
|
||||
faIconKey,
|
||||
faIconName,
|
||||
faTextProblem,
|
||||
faTypedIconKey,
|
||||
findDefinitionIcon,
|
||||
lucideIconKey,
|
||||
normalizeDefinitionIconName,
|
||||
searchFaIcons,
|
||||
} from "./definitionIcons";
|
||||
import { GlyphSvg } from "../icons/GlyphSvg";
|
||||
import { weekdayOf } from "../schedule/cycle";
|
||||
@@ -87,6 +92,9 @@ const REPEATS_BY_RULE: Record<DefinitionRule["rule_type"], Repeats> = {
|
||||
/** How many upcoming dates the edit sheet previews. */
|
||||
const PREVIEW_COUNT = 5;
|
||||
|
||||
/** Font Awesome search results per page; only one page is ever mounted. */
|
||||
const FA_RESULTS_PAGE = 40;
|
||||
|
||||
/** Quiet period after the last rule edit before the preview is requested. */
|
||||
const PREVIEW_DEBOUNCE_MS = 300;
|
||||
|
||||
@@ -101,6 +109,11 @@ interface Draft {
|
||||
icon: string | null;
|
||||
/** The emoji field's text; typing in it sets `icon` to `emoji:<text>`. */
|
||||
emoji: string;
|
||||
/**
|
||||
* The Font Awesome search text; typing an exact Free Solid name sets
|
||||
* `icon` to `fa:<name>`, and picking a search result keeps the text.
|
||||
*/
|
||||
faText: string;
|
||||
assigneeIds: number[];
|
||||
repeats: Repeats;
|
||||
interval: string;
|
||||
@@ -135,6 +148,7 @@ function newDraft(activeChildren: AdminChild[], today: string): Draft {
|
||||
title: "",
|
||||
icon: null,
|
||||
emoji: "",
|
||||
faText: "",
|
||||
assigneeIds: activeChildren.length === 1 ? [activeChildren[0].id] : [],
|
||||
repeats: "daily",
|
||||
interval: "1",
|
||||
@@ -157,10 +171,13 @@ function draftFrom(definition: QuestDefinition, activeChildren: AdminChild[], to
|
||||
const active = new Set(activeChildren.map((child) => child.id));
|
||||
const dueTimes = emptyDueTimes();
|
||||
for (const w of definition.windows) dueTimes[w.window] = w.due_time ?? "";
|
||||
const fa = findDefinitionIcon(definition.icon);
|
||||
return {
|
||||
title: definition.title,
|
||||
icon: definition.icon,
|
||||
emoji: emojiIconText(definition.icon),
|
||||
// A Free Solid icon outside the quick picks opens as its search result.
|
||||
faText: fa?.kind === "fa" && !FA_DEFINITION_ICONS.includes(fa) ? fa.name : "",
|
||||
// Inactive children cannot be submitted (the API rejects them with 422).
|
||||
assigneeIds: definition.assignees.map((a) => a.id).filter((id) => active.has(id)),
|
||||
repeats: REPEATS_BY_RULE[rule.rule_type],
|
||||
@@ -250,6 +267,7 @@ function buildBody(draft: Draft, keepsAssignees = false): DefinitionCreateBody |
|
||||
if (draft.emoji && draft.icon === null) {
|
||||
return "Enter a single emoji (no spaces or < > &), or clear the emoji field.";
|
||||
}
|
||||
if (draft.faText.trim() && draft.icon === null) return faTextProblem(draft.faText);
|
||||
const rule = buildRule(draft);
|
||||
if (typeof rule === "string") return rule;
|
||||
const windows: WindowEntry[] = WINDOW_ORDER.filter((w) => draft.windows.includes(w)).map(
|
||||
@@ -479,6 +497,11 @@ function EditSheet({
|
||||
? []
|
||||
: target.assignees.filter((a) => !activeChildren.some((child) => child.id === a.id));
|
||||
const [pickerOpen, setPickerOpen] = useState(false);
|
||||
const faResults = useMemo(() => searchFaIcons(draft.faText), [draft.faText]);
|
||||
const [faPage, setFaPage] = useState(0);
|
||||
const faStart = faPage * FA_RESULTS_PAGE;
|
||||
const faEnd = Math.min(faStart + FA_RESULTS_PAGE, faResults.length);
|
||||
const noIcon = draft.icon === null && !draft.emoji && !draft.faText.trim();
|
||||
const [saving, setSaving] = useState(false);
|
||||
const [confirming, setConfirming] = useState(false);
|
||||
const [confirmingDelete, setConfirmingDelete] = useState(false);
|
||||
@@ -619,12 +642,10 @@ function EditSheet({
|
||||
<button
|
||||
type="button"
|
||||
role="radio"
|
||||
aria-checked={draft.icon === null && !draft.emoji}
|
||||
aria-checked={noIcon}
|
||||
aria-label="No icon"
|
||||
className={
|
||||
draft.icon === null && !draft.emoji ? "defs-icon defs-icon--on" : "defs-icon"
|
||||
}
|
||||
onClick={() => update({ icon: null, emoji: "" })}
|
||||
className={noIcon ? "defs-icon defs-icon--on" : "defs-icon"}
|
||||
onClick={() => update({ icon: null, emoji: "", faText: "" })}
|
||||
>
|
||||
<TaskGlyph size={18} />
|
||||
</button>
|
||||
@@ -640,7 +661,7 @@ function EditSheet({
|
||||
aria-label={label}
|
||||
data-icon-option={name}
|
||||
className={on ? "defs-icon defs-icon--on" : "defs-icon"}
|
||||
onClick={() => update({ icon: lucideIconKey(name), emoji: "" })}
|
||||
onClick={() => update({ icon: lucideIconKey(name), emoji: "", faText: "" })}
|
||||
>
|
||||
<GlyphSvg icon={icon} size={18} />
|
||||
</button>
|
||||
@@ -650,26 +671,93 @@ function EditSheet({
|
||||
<span className="defs-sublabel" id="defs-label-icon-fa">
|
||||
Font Awesome
|
||||
</span>
|
||||
<div className="defs-icon-grid" role="radiogroup" aria-labelledby="defs-label-icon-fa">
|
||||
{FA_DEFINITION_ICONS.map((icon) => {
|
||||
const { name, label } = icon;
|
||||
const on = faIconName(draft.icon) === name;
|
||||
return (
|
||||
<button
|
||||
key={name}
|
||||
type="button"
|
||||
role="radio"
|
||||
aria-checked={on}
|
||||
aria-label={label}
|
||||
data-icon-option={faIconKey(name)}
|
||||
className={on ? "defs-icon defs-icon--on" : "defs-icon"}
|
||||
onClick={() => update({ icon: faIconKey(name), emoji: "" })}
|
||||
<input
|
||||
className="defs-input"
|
||||
type="search"
|
||||
aria-label="Search Font Awesome icons"
|
||||
placeholder="Search or type an icon name, e.g. dog"
|
||||
value={draft.faText}
|
||||
onChange={(e) => {
|
||||
setFaPage(0);
|
||||
update({ faText: e.target.value, icon: faTypedIconKey(e.target.value), emoji: "" });
|
||||
}}
|
||||
/>
|
||||
{draft.faText.trim() && draft.icon === null ? (
|
||||
<p className="defs-hint defs-hint--error" role="alert">
|
||||
{faTextProblem(draft.faText)}
|
||||
</p>
|
||||
) : null}
|
||||
{draft.faText.trim() ? (
|
||||
faResults.length > 0 ? (
|
||||
<>
|
||||
<div
|
||||
className="defs-icon-grid defs-icon-grid--results"
|
||||
role="radiogroup"
|
||||
aria-label="Font Awesome search results"
|
||||
>
|
||||
<GlyphSvg icon={icon} size={18} />
|
||||
</button>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
{faResults.slice(faStart, faEnd).map((icon) => {
|
||||
const { name, label } = icon;
|
||||
const on = faIconName(draft.icon) === name;
|
||||
return (
|
||||
<button
|
||||
key={name}
|
||||
type="button"
|
||||
role="radio"
|
||||
aria-checked={on}
|
||||
aria-label={label}
|
||||
data-icon-option={faIconKey(name)}
|
||||
className={
|
||||
on ? "defs-icon defs-icon-result defs-icon--on" : "defs-icon defs-icon-result"
|
||||
}
|
||||
onClick={() => update({ icon: faIconKey(name), emoji: "" })}
|
||||
>
|
||||
<GlyphSvg icon={icon} size={18} />
|
||||
<span className="defs-icon-label">{label}</span>
|
||||
</button>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
<p className="defs-hint">
|
||||
Showing {faStart + 1}–{faEnd} of {faResults.length}
|
||||
</p>
|
||||
{faResults.length > FA_RESULTS_PAGE ? (
|
||||
<div className="defs-show-more">
|
||||
{faPage > 0 ? (
|
||||
<button type="button" className="defs-retry" onClick={() => setFaPage((page) => page - 1)}>
|
||||
Previous
|
||||
</button>
|
||||
) : null}
|
||||
{faEnd < faResults.length ? (
|
||||
<button type="button" className="defs-retry" onClick={() => setFaPage((page) => page + 1)}>
|
||||
Show more
|
||||
</button>
|
||||
) : null}
|
||||
</div>
|
||||
) : null}
|
||||
</>
|
||||
) : null
|
||||
) : (
|
||||
<div className="defs-icon-grid" role="radiogroup" aria-labelledby="defs-label-icon-fa">
|
||||
{FA_DEFINITION_ICONS.map((icon) => {
|
||||
const { name, label } = icon;
|
||||
const on = faIconName(draft.icon) === name;
|
||||
return (
|
||||
<button
|
||||
key={name}
|
||||
type="button"
|
||||
role="radio"
|
||||
aria-checked={on}
|
||||
aria-label={label}
|
||||
data-icon-option={faIconKey(name)}
|
||||
className={on ? "defs-icon defs-icon--on" : "defs-icon"}
|
||||
onClick={() => update({ icon: faIconKey(name), emoji: "", faText: "" })}
|
||||
>
|
||||
<GlyphSvg icon={icon} size={18} />
|
||||
</button>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
)}
|
||||
<label className="defs-due">
|
||||
<span>Emoji</span>
|
||||
<input
|
||||
@@ -677,7 +765,9 @@ function EditSheet({
|
||||
aria-label="Emoji"
|
||||
placeholder="e.g. 🐶"
|
||||
value={draft.emoji}
|
||||
onChange={(e) => update({ emoji: e.target.value, icon: emojiIconKey(e.target.value) })}
|
||||
onChange={(e) =>
|
||||
update({ emoji: e.target.value, icon: emojiIconKey(e.target.value), faText: "" })
|
||||
}
|
||||
/>
|
||||
</label>
|
||||
</Field>
|
||||
|
||||
@@ -8,7 +8,13 @@
|
||||
* and a legacy bare `<kebab-name>` still names the same Lucide entry.
|
||||
*/
|
||||
import { GlyphSvg } from "../icons/GlyphSvg";
|
||||
import { FA_ICONS, LUCIDE_ICONS, resolveIcon, type GlyphIcon } from "../icons/registry.generated";
|
||||
import {
|
||||
FA_ICONS,
|
||||
FA_SOLID_ICONS,
|
||||
LUCIDE_ICONS,
|
||||
resolveIcon,
|
||||
type GlyphIcon,
|
||||
} from "../icons/registry.generated";
|
||||
import { TaskGlyph } from "./glyphs";
|
||||
|
||||
export type DefinitionIconEntry = GlyphIcon;
|
||||
@@ -58,6 +64,41 @@ export function faIconName(value: string | null): string | null {
|
||||
return value?.startsWith(FA_PREFIX) ? value.slice(FA_PREFIX.length) : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* The Font Awesome Free Solid icons whose name or label contains `query`
|
||||
* (trimmed, case-insensitive): an exact name first, then name-prefix
|
||||
* matches, then the rest, each in registry (name) order. An empty query
|
||||
* gives no results — the curated quick picks cover that case.
|
||||
*/
|
||||
export function searchFaIcons(query: string): DefinitionIconEntry[] {
|
||||
const q = query.trim().toLowerCase();
|
||||
if (!q) return [];
|
||||
const rank = (icon: DefinitionIconEntry) => (icon.name === q ? 0 : icon.name.startsWith(q) ? 1 : 2);
|
||||
return FA_SOLID_ICONS.filter(
|
||||
(icon) => icon.name.includes(q) || icon.label.toLowerCase().includes(q),
|
||||
).sort((a, b) => rank(a) - rank(b));
|
||||
}
|
||||
|
||||
/**
|
||||
* The stored key for a typed Font Awesome name, e.g. `Dog` → `fa:dog`: the
|
||||
* trimmed, lower-cased text must be the exact name of a Free Solid icon,
|
||||
* else null (a misspelling, a partial search, or a Pro/Brands name).
|
||||
*/
|
||||
export function faTypedIconKey(text: string): string | null {
|
||||
const key = faIconKey(text.trim().toLowerCase());
|
||||
return resolveIcon(key).kind === "fa" ? key : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Why Font Awesome search text cannot be saved as it stands: it matches
|
||||
* icons but names none of them, or it matches nothing in the Free Solid set.
|
||||
*/
|
||||
export function faTextProblem(text: string): string {
|
||||
return searchFaIcons(text).length > 0
|
||||
? "Select a Font Awesome icon from the results, or type its full name."
|
||||
: `“${text.trim()}” is not a Font Awesome Free Solid icon.`;
|
||||
}
|
||||
|
||||
/** The emoji text an `emoji:<grapheme>` value holds; anything else gives "". */
|
||||
export function emojiIconText(value: string | null): string {
|
||||
return value?.startsWith(EMOJI_PREFIX) ? value.slice(EMOJI_PREFIX.length) : "";
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -3,7 +3,14 @@ import { join } from "node:path";
|
||||
import { describe, expect, it } from "vitest";
|
||||
// The offline generator is the only writer of both registry artefacts.
|
||||
import { OUTPUT_PATHS, REPO_ROOT, SOURCE_PATH, renderRegistry } from "../../../tools/icons/generate.mjs";
|
||||
import { EMOJI_MAX_CODE_POINTS, FALLBACK_ICON, FA_ICONS, LUCIDE_ICONS, resolveIcon } from "./registry.generated";
|
||||
import {
|
||||
EMOJI_MAX_CODE_POINTS,
|
||||
FALLBACK_ICON,
|
||||
FA_ICONS,
|
||||
FA_SOLID_ICONS,
|
||||
LUCIDE_ICONS,
|
||||
resolveIcon,
|
||||
} from "./registry.generated";
|
||||
|
||||
type Curated = { lucide: { name: string; label: string }[]; fa: { name: string; label: string }[] };
|
||||
|
||||
@@ -45,7 +52,18 @@ describe("shared icon registry — one source of truth", () => {
|
||||
expect(icon.viewBox).toMatch(/^0 0 \d+ 512$/);
|
||||
expect(icon.paths.length, icon.name).toBeGreaterThan(0);
|
||||
}
|
||||
for (const icon of [...LUCIDE_ICONS, ...FA_ICONS]) {
|
||||
const solidNames = FA_SOLID_ICONS.map((icon) => icon.name);
|
||||
expect(solidNames.length).toBeGreaterThanOrEqual(1400);
|
||||
expect(solidNames).toEqual([...solidNames].sort());
|
||||
expect(new Set(solidNames).size).toBe(solidNames.length);
|
||||
for (const { name } of FA_ICONS) expect(solidNames, name).toContain(name);
|
||||
for (const icon of FA_SOLID_ICONS) {
|
||||
expect(icon.kind).toBe("fa");
|
||||
expect(icon.key).toBe(`fa:${icon.name}`);
|
||||
expect(icon.viewBox).toMatch(/^0 0 \d+ 512$/);
|
||||
expect(icon.paths.length, icon.name).toBeGreaterThan(0);
|
||||
}
|
||||
for (const icon of [...LUCIDE_ICONS, ...FA_ICONS, ...FA_SOLID_ICONS]) {
|
||||
for (const d of icon.paths) expect(d, icon.key).toMatch(/^[Mm][-0-9.,\sA-Za-z]+$/);
|
||||
}
|
||||
});
|
||||
@@ -61,6 +79,12 @@ describe("resolveIcon", () => {
|
||||
expect(broom.kind).toBe("fa");
|
||||
expect(broom).toBe(FA_ICONS.find((icon) => icon.name === "broom"));
|
||||
|
||||
// Any Free Solid name resolves, not just the curated quick-pick set.
|
||||
const rocket = resolveIcon("fa:rocket");
|
||||
expect(rocket).toBe(FA_SOLID_ICONS.find((icon) => icon.name === "rocket"));
|
||||
expect(rocket).toMatchObject({ kind: "fa", key: "fa:rocket", label: "Rocket" });
|
||||
expect(resolveIcon("fa:person-dress-burst")).toMatchObject({ kind: "fa", label: "Person Dress Burst" });
|
||||
|
||||
expect(resolveIcon("emoji:🐶")).toEqual({ kind: "emoji", key: "emoji:🐶", text: "🐶" });
|
||||
expect(resolveIcon("emoji:👨👩👧")).toEqual({ kind: "emoji", key: "emoji:👨👩👧", text: "👨👩👧" });
|
||||
});
|
||||
|
||||
@@ -9,7 +9,7 @@ snapshot (the same ChildDaySnapshot the day sensors read):
|
||||
celebration automation must never fire on an empty day (the
|
||||
day-complete event carries the same rule, Feature 10 task 7).
|
||||
- ``binary_sensor.nestquest_<child>_present_today`` — ON when the
|
||||
presence engine resolves the child present on the HA-local date
|
||||
presence engine resolves the child present on the household-local date
|
||||
(schedules and overrides, D-004 anchor-date arithmetic).
|
||||
|
||||
Naming and registry identity follow the day sensors' contract: names
|
||||
|
||||
@@ -10,7 +10,7 @@ un-completing (no-op if already open) is :func:`uncomplete_instance`.
|
||||
Instance current state is derived from the latest event via
|
||||
:func:`instance_state` (``open`` / ``done`` / ``missed``); there is
|
||||
no status column. ``missed`` is derived for past-due open instances
|
||||
(``due_date`` before HA-local ``today``) and is never stored as an
|
||||
(``due_date`` before household-local ``today``) and is never stored as an
|
||||
event_type.
|
||||
|
||||
Actor policy matches the schema CHECKs (D-008): ``actor_source`` is
|
||||
@@ -71,10 +71,10 @@ def _completion_moment(
|
||||
now: datetime.datetime | None,
|
||||
today: datetime.date | None,
|
||||
) -> tuple[datetime.date, datetime.time | None]:
|
||||
"""Return the HA-local completion date and optional wall-clock time.
|
||||
"""Return the household-local completion date and optional wall-clock time.
|
||||
|
||||
``today`` is the HA-local calendar date when threaded (Feature 07
|
||||
style). ``now`` is a timezone-aware HA-local datetime; its wall
|
||||
``today`` is the household-local calendar date when threaded (Feature 07
|
||||
style). ``now`` is a timezone-aware household-local datetime; its wall
|
||||
clock is used as-is and is never converted to UTC. When ``today``
|
||||
is omitted the date comes from ``now``. When both are omitted the
|
||||
host calendar date is the Feature 07 fallback — never the UTC
|
||||
@@ -98,7 +98,7 @@ def _completion_moment(
|
||||
|
||||
|
||||
def _resolve_today(today: datetime.date | None) -> datetime.date:
|
||||
"""Return the threaded HA-local date, or the host calendar date."""
|
||||
"""Return the threaded household-local date, or the host calendar date."""
|
||||
if today is None:
|
||||
return datetime.date.today()
|
||||
return today
|
||||
@@ -138,7 +138,7 @@ def derive_state(
|
||||
Thin wrapper over :func:`_derived_state`: ``open``, ``done``, or
|
||||
``missed`` from the latest event plus the due date (``missed`` is
|
||||
derived, never an event_type). ``today`` is the caller-resolved
|
||||
HA-local date.
|
||||
household-local date.
|
||||
"""
|
||||
return _derived_state(instance, latest, today)
|
||||
|
||||
@@ -345,7 +345,7 @@ async def instance_state(
|
||||
"""Return ``open``, ``done``, or ``missed`` from the latest event.
|
||||
|
||||
No events, or a latest event of uncompleted, is ``open`` unless
|
||||
``due_date`` is before ``today`` (HA-local, threaded), in which
|
||||
``due_date`` is before ``today`` (household-local, threaded), in which
|
||||
case it is ``missed``. A latest event of completed is ``done``
|
||||
even when past due. ``missed`` is never stored as an event_type.
|
||||
Unknown ``instance_id`` raises ValueError naming the field.
|
||||
@@ -414,9 +414,9 @@ async def complete_instance(
|
||||
latest-event, and the append run under one connection lock so a
|
||||
concurrent complete cannot double-append.
|
||||
|
||||
``was_on_time`` is computed from the HA-local completion moment
|
||||
``was_on_time`` is computed from the household-local completion moment
|
||||
(threaded ``now`` / ``today``) against the instance ``due_date``
|
||||
and optional ``due_time``. ``now`` is the timezone-aware HA-local
|
||||
and optional ``due_time``. ``now`` is the timezone-aware household-local
|
||||
datetime; its wall clock is never converted to UTC. Same-day
|
||||
``due_time`` comparison requires ``now``.
|
||||
"""
|
||||
@@ -471,7 +471,7 @@ async def uncomplete_instance(
|
||||
"""Append an uncompleted event unless the instance is already open.
|
||||
|
||||
Returns the derived state ``open``, or ``missed`` when the instance
|
||||
is past due (``due_date`` before HA-local ``today``); ``appended``
|
||||
is past due (``due_date`` before household-local ``today``); ``appended``
|
||||
reports whether THIS call appended (False on an already-open
|
||||
no-op). Unknown ``instance_id`` raises ValueError naming the
|
||||
field. Existence, latest-event, and the append run under one
|
||||
@@ -529,7 +529,7 @@ async def list_missed_for_child(
|
||||
"""Return the child's missed instances due in the closed date range.
|
||||
|
||||
Missed means the latest event state is open and ``due_date`` is
|
||||
before ``today`` (HA-local, threaded). Uses
|
||||
before ``today`` (household-local, threaded). Uses
|
||||
:meth:`QuestInstancesDao.list_by_date_range` plus derived state.
|
||||
Never appends a missed event. Instances and latest events are
|
||||
read inside the connection lock so the list is one snapshot.
|
||||
|
||||
@@ -115,8 +115,12 @@ DEFAULT_AUTOMATION_ENABLED = True
|
||||
# The household's IANA time zone (e.g. ``America/New_York``) the API
|
||||
# service reads its clock in. The empty string is the API host's own
|
||||
# local time. Only an admin sets it (manually, from the admin app);
|
||||
# nothing sets it automatically. The integration itself always uses
|
||||
# Home Assistant's ``time_zone`` and ignores this field.
|
||||
# nothing sets it automatically. The integration relays the API's
|
||||
# effective application timezone (the coordinator carries it and the
|
||||
# household sensor publishes it for the panel cards) and never derives
|
||||
# the application clock from Home Assistant's configuration; the Home
|
||||
# Assistant / browser zone applies only when the API publishes no zone
|
||||
# (e.g. an older API).
|
||||
CONF_TIMEZONE = "timezone"
|
||||
DEFAULT_TIMEZONE = ""
|
||||
|
||||
|
||||
@@ -68,7 +68,7 @@ def _resolve_today(today: datetime.date | None) -> datetime.date:
|
||||
around midnight, so when the caller has already resolved the local
|
||||
date (``today``) that anchor is authoritative; ``None`` falls back to
|
||||
the host clock (:func:`_today`), which is exactly the previous
|
||||
behavior for callers with no HA-local date.
|
||||
behavior for callers with no household-local date.
|
||||
"""
|
||||
return _today() if today is None else today
|
||||
|
||||
@@ -225,7 +225,7 @@ class QuestInstancesDao:
|
||||
- ``due_date`` must be TODAY or later: instances are never
|
||||
generated in the past (Feature 07). The caller's
|
||||
materialization horizon is future-dated by definition.
|
||||
``today`` optionally pins the resolved HA-local date the
|
||||
``today`` optionally pins the resolved household-local date the
|
||||
guard compares against (falling back to the host clock when
|
||||
omitted) so a household time zone behind the host around
|
||||
midnight is not misread as "past".
|
||||
@@ -248,7 +248,7 @@ class QuestInstancesDao:
|
||||
# check runs after the lock is acquired, because a caller can
|
||||
# wait on the lock across midnight — a date that was "today"
|
||||
# at call time may be "yesterday" by the time the INSERT runs.
|
||||
# A caller-supplied ``today`` (HA-local) is used for BOTH
|
||||
# A caller-supplied ``today`` (household-local) is used for BOTH
|
||||
# checks and never re-read, since it is already the anchor the
|
||||
# batch runs against.
|
||||
today_date = _resolve_today(today)
|
||||
@@ -257,7 +257,7 @@ class QuestInstancesDao:
|
||||
async with self._database.transaction():
|
||||
# Re-read "today" under the lock: this is the date the
|
||||
# insert actually executes on, so the no-past rule
|
||||
# holds across midnight rollovers. A pinned HA-local
|
||||
# holds across midnight rollovers. A pinned household-local
|
||||
# anchor is exempt from the re-read (see above).
|
||||
if today is None:
|
||||
today_date = _today()
|
||||
@@ -364,7 +364,7 @@ class QuestInstancesDao:
|
||||
rather than raising, so the rest of the batch is unaffected. The
|
||||
no-past rule (instances are never generated in the past) is
|
||||
preserved from :meth:`upsert` and still raises ValueError; ``today``
|
||||
optionally pins the HA-local anchor it compares against. An
|
||||
optionally pins the household-local anchor it compares against. An
|
||||
instance that ALREADY has a completion event is also skipped
|
||||
(returns ``None``) rather than raised: it is immutable, so the
|
||||
walk leaves it untouched instead of failing the batch — the
|
||||
@@ -504,7 +504,7 @@ class QuestInstancesDao:
|
||||
append-only contract: an instance that was ever completed is
|
||||
never reported missed, even when later reversed — history keeps
|
||||
both rows and the sweep never mutates any). The watermark is
|
||||
the HA-local date the sweep last ran, and the window is
|
||||
the household-local date the sweep last ran, and the window is
|
||||
``[watermark, today)``: the nightly run entering day D+1 sweeps
|
||||
exactly day D's instances, so every day's quests are announced
|
||||
once — at the midnight after their due date — and a same-night
|
||||
@@ -544,9 +544,10 @@ class QuestInstancesDao:
|
||||
rolling horizon from now), so a caller cannot use this to
|
||||
rewrite past open instances either — the day-rollover missed
|
||||
sweep (Feature 11) handles past-due instances instead. ``today``
|
||||
optionally pins the HA-local anchor the clamp compares against
|
||||
(falling back to the host clock when omitted). Any instance with
|
||||
a completion event is never touched, regardless of its date.
|
||||
optionally pins the household-local anchor the clamp compares
|
||||
against (falling back to the host clock when omitted). Any
|
||||
instance with a completion event is never touched, regardless of
|
||||
its date.
|
||||
Returns the number deleted.
|
||||
"""
|
||||
_validate_date(cutoff_date, "cutoff_date")
|
||||
@@ -581,8 +582,9 @@ class QuestInstancesDao:
|
||||
one transaction — an instance that gains a completion event
|
||||
mid-flight cannot be deleted. The cutoff cannot be backdated below
|
||||
today, for the same reason as the definition-scoped method (see its
|
||||
docstring). ``today`` optionally pins the HA-local anchor the clamp
|
||||
compares against (falling back to the host clock when omitted).
|
||||
docstring). ``today`` optionally pins the household-local anchor
|
||||
the clamp compares against (falling back to the host clock when
|
||||
omitted).
|
||||
Any instance with a completion event is never touched, regardless
|
||||
of its date.
|
||||
|
||||
|
||||
@@ -39,10 +39,11 @@ ISO-8601 timestamp. Completion payloads additionally carry
|
||||
``was_on_time``. No other personal data: names and titles are the
|
||||
household's own records, and nothing beyond them leaks.
|
||||
|
||||
Timezone policy: the day-complete check needs the HA-local "today",
|
||||
which the caller passes in as a plain :class:`datetime.date`. Nothing
|
||||
here reads ``hass.config.time_zone`` — the integration owns HA
|
||||
timezone, the core owns the calendar arithmetic.
|
||||
Timezone policy: the day-complete check needs the household-local
|
||||
"today", which the caller passes in as a plain :class:`datetime.date`.
|
||||
Nothing here reads a timezone — the API owns the clock (the
|
||||
admin-stored application timezone, or the API host's local zone when
|
||||
none is stored), the core owns the calendar arithmetic.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
@@ -147,10 +148,10 @@ async def build_child_day_complete_event(
|
||||
completion of TODAY'S instance evaluates it: completing a
|
||||
back-dated or future instance must not announce a cleared day.
|
||||
|
||||
``today`` is the HA-local calendar date the day-complete rule is
|
||||
evaluated against; the integration reads it from
|
||||
``hass.config.time_zone`` and passes it in, so this module never
|
||||
touches HA config.
|
||||
``today`` is the household-local calendar date the day-complete
|
||||
rule is evaluated against; the API resolves it in the application
|
||||
timezone and passes it in, so this module never reads a clock or a
|
||||
timezone of its own.
|
||||
"""
|
||||
# Only a completion of TODAY'S instance evaluates the day-complete
|
||||
# rule: completing a back-dated or future instance must not
|
||||
|
||||
@@ -153,7 +153,7 @@ def _validate_range(start_date: str, end_date: str) -> tuple[str, str]:
|
||||
|
||||
|
||||
def _resolve_today(today: datetime.date | None) -> datetime.date:
|
||||
"""Return the threaded HA-local date, or the host calendar date."""
|
||||
"""Return the threaded household-local date, or the host calendar date."""
|
||||
if today is None:
|
||||
return datetime.date.today()
|
||||
return today
|
||||
@@ -283,7 +283,7 @@ async def query_history(
|
||||
|
||||
Rows are ordered deterministically by ``due_date``, then instance,
|
||||
then event id (the per-instance append order, so a completion and
|
||||
its reversal keep their order). ``today`` pins the HA-local date
|
||||
its reversal keep their order). ``today`` pins the household-local date
|
||||
the missed derivation compares due dates against (the host calendar
|
||||
date when omitted). The whole read runs under the task-reentrant
|
||||
connection lock — :func:`list_missed_for_child` re-enters it — so
|
||||
|
||||
@@ -255,12 +255,12 @@ async def materialize(
|
||||
after a presence change) cannot touch any unrelated child's rows.
|
||||
When omitted (or None) the walk covers every assignee as before.
|
||||
|
||||
``today`` optionally pins the resolved HA-local date the walk's
|
||||
``today`` optionally pins the resolved household-local date the walk's
|
||||
no-past guard compares against; it is threaded into every
|
||||
:meth:`~.dao_instances.QuestInstancesDao.upsert_if_valid` write. When
|
||||
omitted the host clock (``datetime.date.today``) is used, which is the
|
||||
historical default. A caller that computed the horizon in Home
|
||||
Assistant's configured time zone MUST pass that same date here so a
|
||||
historical default. A caller that computed the horizon in the
|
||||
household's application time zone MUST pass that same date here so a
|
||||
time zone behind the host around midnight is not rejected as "past".
|
||||
|
||||
``start_date`` is clamped up to the resolved "today" (the same
|
||||
@@ -298,8 +298,8 @@ async def materialize(
|
||||
start = datetime.datetime.strptime(start_date, "%Y-%m-%d").date()
|
||||
end = datetime.datetime.strptime(end_date, "%Y-%m-%d").date()
|
||||
|
||||
# Clamp a past start up to today (the HA-local anchor when the caller
|
||||
# pinned one, else the host clock) so the walk can never emit a
|
||||
# Clamp a past start up to today (the household-local anchor when the
|
||||
# caller pinned one, else the host clock) so the walk can never emit a
|
||||
# past-dated instance; the DAO's no-past guard remains the backstop.
|
||||
# A range entirely in the past therefore yields zero instances.
|
||||
today_date = _resolve_today(today)
|
||||
@@ -345,7 +345,7 @@ async def regenerate_for_definition(
|
||||
:func:`~.dao_instances._today` — so the delete cutoff and the
|
||||
re-materialization range share one anchor, and the walk's
|
||||
``upsert_if_valid`` no-past guard never rejects the regenerated
|
||||
range. ``today`` optionally pins a caller-resolved HA-local date
|
||||
range. ``today`` optionally pins a caller-resolved household-local date
|
||||
(threaded into both the delete cutoff and the re-materialization)
|
||||
so a household time zone behind the host around midnight stays
|
||||
consistent. ``horizon_days`` sizes the re-materialization window;
|
||||
@@ -413,9 +413,9 @@ async def regenerate_for_child(
|
||||
:meth:`~.dao_instances.QuestInstancesDao.delete_future_uncompleted_for_child`),
|
||||
so the delete cutoff and the re-materialization window share ONE
|
||||
execution-day anchor even when the call is queued across midnight.
|
||||
``today`` optionally pins a caller-resolved HA-local date, threaded
|
||||
``today`` optionally pins a caller-resolved household-local date, threaded
|
||||
into the delete cutoff and the re-materialization for the same
|
||||
host-vs-HA time-zone consistency. ``horizon_days`` sizes the
|
||||
host-vs-household time-zone consistency. ``horizon_days`` sizes the
|
||||
re-materialization window; when omitted it falls back to
|
||||
:data:`~.const.DEFAULT_HORIZON_DAYS`. A bool, non-int, or sub-1 value
|
||||
raises ValueError BEFORE any delete. Returns the number of instances
|
||||
|
||||
@@ -345,7 +345,7 @@ async def edit_quest_definition(
|
||||
future instances only; no ``quest_instances`` or
|
||||
``completion_events`` row is touched.
|
||||
|
||||
``today`` optionally pins the caller-resolved HA-local date the
|
||||
``today`` optionally pins the caller-resolved household-local date the
|
||||
regeneration's no-past guard and horizon are anchored to (threaded
|
||||
into :func:`~.materialize.regenerate_for_definition`); it is a plain
|
||||
``datetime.date`` with no HA import here — the Feature 09 service
|
||||
@@ -449,7 +449,7 @@ async def assign_child(
|
||||
``quest_definition_assignees`` link is written; existing instances
|
||||
and completion history are never touched.
|
||||
|
||||
``today`` optionally pins the caller-resolved HA-local date threaded
|
||||
``today`` optionally pins the caller-resolved household-local date threaded
|
||||
into the assignment's regeneration (see :func:`edit_quest_definition`).
|
||||
``horizon_days`` optionally sizes the regeneration's re-materialization
|
||||
window the same way.
|
||||
@@ -491,7 +491,7 @@ async def unassign_child(
|
||||
argument. Only the ``quest_definition_assignees`` link is written;
|
||||
existing instances and completion history are never touched.
|
||||
|
||||
``today`` optionally pins the caller-resolved HA-local date threaded
|
||||
``today`` optionally pins the caller-resolved household-local date threaded
|
||||
into the unassignment's regeneration (see :func:`edit_quest_definition`).
|
||||
``horizon_days`` optionally sizes the regeneration's re-materialization
|
||||
window the same way.
|
||||
@@ -548,7 +548,7 @@ async def set_quest_definition_active(
|
||||
connection-scoped lock, so the returned bundle is a consistent
|
||||
snapshot that a concurrent mutation cannot race.
|
||||
|
||||
``today`` optionally pins the caller-resolved HA-local date threaded
|
||||
``today`` optionally pins the caller-resolved household-local date threaded
|
||||
into the activation change's regeneration (see
|
||||
:func:`edit_quest_definition`). ``horizon_days`` optionally sizes the
|
||||
regeneration's re-materialization window the same way.
|
||||
|
||||
@@ -316,12 +316,11 @@ class NestQuestSettings:
|
||||
|
||||
The API service does not run inside Home Assistant, so its one
|
||||
clock read (an aware host-local ``now``) is converted here: with
|
||||
:attr:`timezone` set — the admin's choice, or else the zone the
|
||||
integration reports from Home Assistant — the SAME instant is
|
||||
re-expressed in that zone, so ``.date()`` and ``.time()`` are the
|
||||
household's wall clock even when the host runs UTC. With
|
||||
:attr:`timezone` empty the instant is returned unchanged (the
|
||||
host's local time).
|
||||
:attr:`timezone` set — only ever by an admin, from the admin
|
||||
app — the SAME instant is re-expressed in that zone, so
|
||||
``.date()`` and ``.time()`` are the household's wall clock even
|
||||
when the host runs UTC. With :attr:`timezone` empty the instant
|
||||
is returned unchanged (the host's local time).
|
||||
"""
|
||||
if not self.timezone:
|
||||
return instant
|
||||
@@ -341,7 +340,7 @@ class NestQuestSettings:
|
||||
"""Return the rolling horizon window ``[today, today + horizon_days]``.
|
||||
|
||||
``today`` is REQUIRED (there is no host-clock default): the
|
||||
integration passes the HA-local ``hass.config.time_zone`` date so
|
||||
API passes the household-local date (:meth:`household_now`) so
|
||||
the horizon tracks the household's own day, and a silent
|
||||
host-clock fallback would be a wrong-day footgun (a test or a
|
||||
caller that forgets to pass ``today`` would otherwise materialize
|
||||
|
||||
@@ -18,7 +18,7 @@ the panel payload shaper (:func:`instance_payload`), and the async
|
||||
service's panel snapshot route share ONE implementation of both the
|
||||
snapshot assembly and the entity-facing attribute payload shape.
|
||||
Nothing here imports :mod:`homeassistant`; the builder takes the
|
||||
database, the settings object, and the HA-local ``now`` (a single
|
||||
database, the settings object, and the household-local ``now`` (a single
|
||||
clock read the caller already resolved, from which it derives
|
||||
``today``) and returns the snapshot, mirroring exactly what the
|
||||
coordinator used to do inline.
|
||||
@@ -187,7 +187,7 @@ async def build_snapshot(
|
||||
:func:`instance_payload` layer — this builder produces the shared
|
||||
shape both consumers read.
|
||||
|
||||
``now`` is the HA-local timezone-aware datetime the caller already
|
||||
``now`` is the household-local timezone-aware datetime the caller already
|
||||
resolved (a SINGLE clock read); the overdue check compares
|
||||
``now.time()`` against the instance's ``due_time`` for today's open
|
||||
instances. The builder performs NO internal clock read — it never
|
||||
|
||||
@@ -39,9 +39,10 @@ lets exactly one of them win the claim — the loser returns [] and
|
||||
announces nothing.
|
||||
|
||||
The caller supplies ``today`` as a plain :class:`datetime.date`: the
|
||||
household-local calendar date, read from ``hass.config.time_zone`` by
|
||||
the integration or from the configured household timezone by the API.
|
||||
This module never reads a timezone database or config of its own.
|
||||
household-local calendar date, which the API reads in the
|
||||
admin-stored application timezone (the API host's local zone when none
|
||||
is stored). This module never reads a timezone database or config of
|
||||
its own.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
@@ -97,9 +98,9 @@ async def run_missed_sweep(
|
||||
"""Build one missed event per unswept past-due open instance.
|
||||
|
||||
``today`` is the household-local calendar date the sweep runs for
|
||||
(the caller owns the clock: the integration reads it from
|
||||
``hass.config.time_zone``, the API from the configured household
|
||||
timezone, falling back to its host's local time when unset).
|
||||
(the caller owns the clock: the API reads it in the admin-stored
|
||||
application timezone, falling back to its host's local time when
|
||||
unset).
|
||||
Returns the ``(event_type, payload)`` tuples to announce, EMPTY
|
||||
when the watermark already covers ``today`` (a same-night rerun) —
|
||||
the caller decides how to publish them and announces nothing on
|
||||
|
||||
@@ -15,5 +15,5 @@
|
||||
"iot_class": "local_polling",
|
||||
"issue_tracker": "https://github.com/Maniacs-Mansion/NestQuest/issues",
|
||||
"requirements": [],
|
||||
"version": "0.9.7"
|
||||
"version": "0.9.8"
|
||||
}
|
||||
|
||||
@@ -99,6 +99,38 @@ A lone `home` pattern answers exactly as the old schedule did, so no
|
||||
child's presence changes. The drop is one-way and 0.7.1 refuses a
|
||||
version-9 database; see the rollback step in `deploy/RUNBOOK.md` §11.
|
||||
|
||||
### Application timezone (manual, admin-set)
|
||||
|
||||
The application timezone is set **manually by an admin from the admin
|
||||
app** — the Settings screen's timezone picker, which reads and writes the
|
||||
`timezone` field of `GET`/`PATCH /api/v1/admin/settings`. Nothing sets it
|
||||
automatically: there is no Home Assistant zone adoption, no browser-zone
|
||||
auto-detect, and no auto-save when a screen loads. Only an admin's `PATCH`
|
||||
ever changes the stored value.
|
||||
|
||||
The stored value is the **single source of local-time truth for the whole
|
||||
application.** The API reads its one clock and re-expresses it in that zone
|
||||
(`NestQuestSettings.household_now`), so every local date and time comes
|
||||
from it:
|
||||
|
||||
- the panel snapshot's today and overdue state, and both panel cards'
|
||||
visible dates and clocks (the snapshot publishes the zone as `timezone`,
|
||||
which the integration exposes on the household rollup sensor);
|
||||
- completion timestamps (the local completion date and the on-time check);
|
||||
- the missed-sweep scheduler's household rollover;
|
||||
- every admin read, and the admin app's local-time formatting.
|
||||
|
||||
**Empty means the API host's local zone.** While `timezone` is empty the
|
||||
API reads its clock in the host's local time, and publishes that zone as
|
||||
the effective zone (`api/host_zone.py`: the `effective_timezone` field of
|
||||
the admin settings response and the snapshot's `timezone`) until an admin
|
||||
sets one. No code fills the empty value in.
|
||||
|
||||
**A save re-plans the sweep.** An admin save that changes `timezone` or
|
||||
`day_rollover_time` notifies the running missed-sweep scheduler
|
||||
(`MissedSweepScheduler.settings_changed`, under its settings lock), which
|
||||
re-plans its next sweep for the new household rollover.
|
||||
|
||||
## 4. Authentication: two planes
|
||||
|
||||
The kid panel and the admin PWA have opposite trust levels, so they use
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
+1
-1
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "nestquest"
|
||||
version = "0.9.7"
|
||||
version = "0.9.8"
|
||||
description = "NestQuest Home Assistant Integration"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.11"
|
||||
|
||||
+2
-2
@@ -1017,8 +1017,8 @@ def make_hass() -> tuple:
|
||||
hass.bus = EventBus()
|
||||
hass.http = HttpRegistry()
|
||||
hass.extra_js_urls: list[str] = []
|
||||
# A valid IANA time zone (the day-rollover listener reads it to
|
||||
# compute "today" in HA local time).
|
||||
# A valid IANA time zone for the fake Home Assistant config (the
|
||||
# NestQuest application timezone is the admin-set setting, not this).
|
||||
hass.config.time_zone = "UTC"
|
||||
|
||||
# The minimal entity registry: entities self-register through
|
||||
|
||||
@@ -834,7 +834,7 @@ def test_complete_instance_no_due_time_after_due_date_is_late(
|
||||
|
||||
|
||||
def test_complete_instance_ha_local_wall_clock_not_utc(tmp_path) -> None:
|
||||
"""HA-local 11:00 with due_time 12:00 is on time even when UTC is 19:00.
|
||||
"""Household-local 11:00, due 12:00, is on time even when UTC is 19:00.
|
||||
|
||||
The helper's zone is UTC-8, so 11:00 local is 19:00 UTC. Converting
|
||||
to UTC before comparing would mark this late.
|
||||
|
||||
@@ -136,7 +136,7 @@ async def test_build_snapshot_explicit_values(hass, make_entry, tmp_path) -> Non
|
||||
|
||||
# Single clock read for the seed/snapshot anchor (no midnight skew);
|
||||
# the coordinator no longer owns a clock read (the API serves the
|
||||
# snapshot), so the test resolves the HA-local zone directly.
|
||||
# snapshot), so the test resolves its own local zone directly.
|
||||
time_zone = ZoneInfo(hass.config.time_zone)
|
||||
today = datetime.datetime.now(time_zone).date()
|
||||
# Pin the build instant at 12:00 local: past Ada's 10:00 due time
|
||||
|
||||
@@ -63,6 +63,75 @@ def test_artefacts_carry_exactly_the_curated_names_and_labels() -> None:
|
||||
assert 15 <= len(curated["fa"]) <= 25
|
||||
|
||||
|
||||
def test_artefacts_carry_the_full_font_awesome_free_solid_set() -> None:
|
||||
text = ARTEFACTS[0].read_text(encoding="utf-8")
|
||||
solid = _generated_set(text, "FA_SOLID_ICONS")
|
||||
names = [entry["name"] for entry in solid]
|
||||
assert names == sorted(names)
|
||||
assert len(set(names)) == len(names)
|
||||
# The complete Free Solid set, not a curated pick (7.x ships ~1,400).
|
||||
assert len(solid) >= 1400
|
||||
for entry in solid:
|
||||
assert set(entry) == {"kind", "key", "name", "label", "viewBox", "paths"}
|
||||
assert entry["kind"] == "fa"
|
||||
assert entry["key"] == f"fa:{entry['name']}"
|
||||
assert entry["label"] == " ".join(
|
||||
part[0].upper() + part[1:] for part in entry["name"].split("-")
|
||||
)
|
||||
assert re.fullmatch(r"0 0 \d+ \d+", entry["viewBox"])
|
||||
assert entry["paths"] and all(entry["paths"])
|
||||
# A well-known glyph, a barely-known one, and every curated quick-pick.
|
||||
assert {"rocket", "mug-hot", "person-dress-burst"} <= set(names)
|
||||
assert {e["name"] for e in _curated()["fa"]} <= set(names)
|
||||
assert "rocket-ship-9000" not in names
|
||||
|
||||
|
||||
def test_resolve_icon_resolves_any_free_solid_name() -> None:
|
||||
node = shutil.which("node")
|
||||
if node is None:
|
||||
pytest.skip("needs node")
|
||||
script = (
|
||||
"const m = await import(process.argv[1]);"
|
||||
"const out = {};"
|
||||
"for (const v of JSON.parse(process.argv[2])) {"
|
||||
" const r = m.resolveIcon(v); out[v] = [r.kind, r.label ?? null]; }"
|
||||
"console.log(JSON.stringify(out));"
|
||||
)
|
||||
values = [
|
||||
"fa:rocket",
|
||||
"fa:mug-hot",
|
||||
"fa:person-dress-burst",
|
||||
"fa:paw",
|
||||
"fa:rocket-ship-9000",
|
||||
"fa:Rocket",
|
||||
"fa:",
|
||||
"lucide:dog",
|
||||
"dog",
|
||||
"lucide:rocket",
|
||||
]
|
||||
result = subprocess.run(
|
||||
[node, "--input-type=module", "-e", script,
|
||||
ARTEFACTS[0].as_uri(), json.dumps(values)],
|
||||
cwd=REPO_ROOT,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
check=False,
|
||||
)
|
||||
if result.returncode != 0 and "Unknown file extension" in result.stderr:
|
||||
pytest.skip("node cannot strip TypeScript types (needs Node 22.18+)")
|
||||
assert result.returncode == 0, result.stderr
|
||||
resolved = json.loads(result.stdout)
|
||||
assert resolved["fa:rocket"] == ["fa", "Rocket"]
|
||||
assert resolved["fa:mug-hot"] == ["fa", "Mug Hot"]
|
||||
assert resolved["fa:person-dress-burst"] == ["fa", "Person Dress Burst"]
|
||||
# Curated entries keep their quick-pick label.
|
||||
assert resolved["fa:paw"] == ["fa", "Pets"]
|
||||
assert resolved["lucide:dog"][0] == "lucide"
|
||||
assert resolved["dog"][0] == "lucide"
|
||||
for unknown in ("fa:rocket-ship-9000", "fa:Rocket", "fa:", "lucide:rocket"):
|
||||
assert resolved[unknown] == ["fallback", None], unknown
|
||||
|
||||
|
||||
def test_registry_has_no_remote_url_cdn_or_lucide_runtime() -> None:
|
||||
for path in (SOURCE, GENERATOR, *ARTEFACTS):
|
||||
text = path.read_text(encoding="utf-8")
|
||||
|
||||
@@ -940,14 +940,15 @@ def test_materialize_rejects_malformed_or_inverted_bounds(tmp_path) -> None:
|
||||
|
||||
|
||||
def test_materialize_accepts_ha_local_today_behind_host(tmp_path) -> None:
|
||||
"""The clamp and no-past guard compare against a caller-supplied HA-local today.
|
||||
"""The clamp and no-past guard compare against a caller-supplied today.
|
||||
|
||||
A household time zone behind the host clock around midnight resolves a
|
||||
HA-local "today" one calendar day earlier than the host's
|
||||
household-local "today" one calendar day earlier than the host's
|
||||
``date.today()``. The walk clamps its start to that anchor: without
|
||||
a pinned HA-local date the effective start is the host's today (one
|
||||
day after ha_today), so the now-past day is skipped rather than
|
||||
rejected, and only the host-today-onward days materialize.
|
||||
a pinned household-local date the effective start is the host's
|
||||
today (one day after ha_today), so the now-past day is skipped
|
||||
rather than rejected, and only the host-today-onward days
|
||||
materialize.
|
||||
"""
|
||||
async def _body(database):
|
||||
children = ChildrenDao(database)
|
||||
@@ -963,9 +964,9 @@ def test_materialize_accepts_ha_local_today_behind_host(tmp_path) -> None:
|
||||
["morning"],
|
||||
)
|
||||
|
||||
# Without a pinned HA-local today, the walk clamps its start to the
|
||||
# host's today (one day after ha_today); the past day is dropped and
|
||||
# the 14 host-today-onward days materialize.
|
||||
# Without a pinned household-local today, the walk clamps its start
|
||||
# to the host's today (one day after ha_today); the past day is
|
||||
# dropped and the 14 host-today-onward days materialize.
|
||||
without_pin = await materialize(database, start_iso, end_iso)
|
||||
assert without_pin == 14
|
||||
|
||||
|
||||
+58
-10
@@ -2,9 +2,10 @@
|
||||
* Offline generator for the shared quest-icon registry.
|
||||
*
|
||||
* Reads the curated names + labels in `curated-icons.json` (the one source of
|
||||
* truth), pulls each glyph's SVG path data from locally installed packages in
|
||||
* `admin/node_modules` (lucide-react and @fortawesome/free-solid-svg-icons —
|
||||
* no network), and writes the same TypeScript module into both bundles:
|
||||
* truth for the quick-pick lists), pulls each glyph's SVG path data from
|
||||
* locally installed packages in `admin/node_modules` (lucide-react and
|
||||
* @fortawesome/free-solid-svg-icons — no network), and writes the same
|
||||
* TypeScript module into both bundles:
|
||||
*
|
||||
* admin/src/icons/registry.generated.ts
|
||||
* frontend/src/icons/registry.generated.ts
|
||||
@@ -14,6 +15,14 @@
|
||||
*
|
||||
* Lucide circles, rects and lines are converted to path `d` strings so every
|
||||
* glyph is plain `{ viewBox, paths }` data any renderer can draw.
|
||||
*
|
||||
* Besides the curated sets, the module embeds the complete Font Awesome Free
|
||||
* Solid set (`FA_SOLID_ICONS`). Its source is the installed
|
||||
* @fortawesome/free-solid-svg-icons package itself: every exported icon
|
||||
* definition, de-duplicated by canonical `iconName` (the package also exports
|
||||
* each legacy alias, e.g. faHome for `house`, as the same definition). The
|
||||
* package carries no human labels, so each label is the kebab name in Title
|
||||
* Case (`spray-can-sparkles` → "Spray Can Sparkles").
|
||||
*/
|
||||
import { readFileSync, writeFileSync, mkdirSync } from "node:fs";
|
||||
import { createRequire } from "node:module";
|
||||
@@ -89,6 +98,37 @@ function faExportName(name) {
|
||||
return "fa" + name.split("-").map((part) => part[0].toUpperCase() + part.slice(1)).join("");
|
||||
}
|
||||
|
||||
function faGlyph(definition, label) {
|
||||
const { iconName: name } = definition;
|
||||
const [width, height, , , pathData] = definition.icon;
|
||||
const paths = Array.isArray(pathData) ? pathData.filter(Boolean) : [pathData];
|
||||
return { kind: "fa", key: `fa:${name}`, name, label, viewBox: `0 0 ${width} ${height}`, paths };
|
||||
}
|
||||
|
||||
function titleCase(name) {
|
||||
return name.split("-").map((part) => part[0].toUpperCase() + part.slice(1)).join(" ");
|
||||
}
|
||||
|
||||
/** Every Free Solid glyph, one per canonical name, sorted by name. */
|
||||
function allSolidGlyphs(faPackage) {
|
||||
const byName = new Map();
|
||||
for (const definition of Object.values(faPackage)) {
|
||||
if (!definition || typeof definition !== "object" || !Array.isArray(definition.icon)) continue;
|
||||
if (definition.prefix !== "fas") throw new Error(`fa ${definition.iconName}: unexpected prefix ${definition.prefix}`);
|
||||
const name = definition.iconName;
|
||||
if (!/^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/.test(name)) throw new Error(`fa ${name}: not a kebab name`);
|
||||
const seen = byName.get(name);
|
||||
if (seen && JSON.stringify(seen.icon) !== JSON.stringify(definition.icon)) {
|
||||
throw new Error(`fa ${name}: two exports disagree on the glyph`);
|
||||
}
|
||||
byName.set(name, definition);
|
||||
}
|
||||
if (byName.size === 0) throw new Error("fa: no icons found in @fortawesome/free-solid-svg-icons");
|
||||
return [...byName.keys()]
|
||||
.sort((a, b) => (a < b ? -1 : a > b ? 1 : 0))
|
||||
.map((name) => faGlyph(byName.get(name), titleCase(name)));
|
||||
}
|
||||
|
||||
function checkCurated(list, namespace) {
|
||||
const seen = new Set();
|
||||
for (const { name, label } of list) {
|
||||
@@ -116,11 +156,9 @@ async function buildEntries() {
|
||||
for (const { name, label } of curated.fa) {
|
||||
const definition = faPackage[faExportName(name)];
|
||||
if (!definition || definition.iconName !== name) throw new Error(`fa ${name}: not in @fortawesome/free-solid-svg-icons`);
|
||||
const [width, height, , , pathData] = definition.icon;
|
||||
const paths = Array.isArray(pathData) ? pathData.filter(Boolean) : [pathData];
|
||||
fa.push({ kind: "fa", key: `fa:${name}`, name, label, viewBox: `0 0 ${width} ${height}`, paths });
|
||||
fa.push(faGlyph(definition, label));
|
||||
}
|
||||
return { lucide, fa };
|
||||
return { lucide, fa, faSolid: allSolidGlyphs(faPackage) };
|
||||
}
|
||||
|
||||
const RESOLVER = `
|
||||
@@ -130,7 +168,10 @@ export const FALLBACK_ICON: FallbackIcon = { kind: "fallback", key: null };
|
||||
export const EMOJI_MAX_CODE_POINTS = 8;
|
||||
|
||||
const LUCIDE_BY_NAME: ReadonlyMap<string, GlyphIcon> = new Map(LUCIDE_ICONS.map((icon) => [icon.name, icon]));
|
||||
const FA_BY_NAME: ReadonlyMap<string, GlyphIcon> = new Map(FA_ICONS.map((icon) => [icon.name, icon]));
|
||||
/** The full Free Solid set, with each curated entry (and its quick-pick label) taking precedence. */
|
||||
const FA_BY_NAME: ReadonlyMap<string, GlyphIcon> = new Map(
|
||||
[...FA_SOLID_ICONS, ...FA_ICONS].map((icon) => [icon.name, icon]),
|
||||
);
|
||||
|
||||
function isEmojiPayload(text: string): boolean {
|
||||
const codePoints = [...text];
|
||||
@@ -142,7 +183,8 @@ function isEmojiPayload(text: string): boolean {
|
||||
* The renderable icon for a stored definition \`icon\` value.
|
||||
*
|
||||
* \`lucide:<name>\` and a legacy bare \`<name>\` resolve against the curated
|
||||
* Lucide set, \`fa:<name>\` against the curated Font Awesome set, and
|
||||
* Lucide set, \`fa:<name>\` against the full Font Awesome Free Solid set
|
||||
* (curated entries keep their quick-pick labels), and
|
||||
* \`emoji:<grapheme>\` to its text. Like the backend's
|
||||
* normalize_icon_for_read, nothing here throws: null, empty, an unknown
|
||||
* namespace or name, or a malformed emoji all resolve to FALLBACK_ICON.
|
||||
@@ -162,7 +204,7 @@ export function resolveIcon(value: string | null | undefined): ResolvedIcon {
|
||||
|
||||
/** The generated module's full text (identical for both bundles). */
|
||||
export async function renderRegistry() {
|
||||
const { lucide, fa } = await buildEntries();
|
||||
const { lucide, fa, faSolid } = await buildEntries();
|
||||
const source = relative(REPO_ROOT, SOURCE_PATH);
|
||||
return `// GENERATED by tools/icons/generate.mjs from ${source} — do not edit.
|
||||
// Regenerate with \`node tools/icons/generate.mjs\` (the drift tests fail if this
|
||||
@@ -202,7 +244,13 @@ export type ResolvedIcon = GlyphIcon | EmojiIcon | FallbackIcon;
|
||||
|
||||
export const LUCIDE_ICONS: readonly GlyphIcon[] = ${JSON.stringify(lucide, null, 2)};
|
||||
|
||||
/** The curated Font Awesome quick-pick set. */
|
||||
export const FA_ICONS: readonly GlyphIcon[] = ${JSON.stringify(fa, null, 2)};
|
||||
|
||||
/** Every Font Awesome Free Solid glyph (${faSolid.length}), sorted by name; one entry per line. */
|
||||
export const FA_SOLID_ICONS: readonly GlyphIcon[] = [
|
||||
${faSolid.map((icon) => JSON.stringify(icon)).join(",\n")}
|
||||
];
|
||||
${RESOLVER}`;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user