@jjlmoya/utils-aquarium 1.58.0 → 1.59.0

package/src/tool/aquariumLightingPhotoperiodPlanner/bibliography.astro

@@ -0,0 +1,6 @@
+---
+import { Bibliography as SharedBibliography } from '@jjlmoya/utils-shared';
+import { bibliography } from './bibliography';
+---
+
+<SharedBibliography links={bibliography} />

package/src/tool/aquariumLightingPhotoperiodPlanner/bibliography.ts

@@ -0,0 +1,12 @@
+import type { BibliographyEntry } from "../../types";
+
+export const bibliography: BibliographyEntry[] = [
+  {
+    name: "OATA, How to set up a planted aquarium",
+    url: "https://ornamentalfish.org/what-we-do/advice-information/care-sheets/caresheets-tropical-freshwater-fish/how-to-set-up-a-planted-aquarium/",
+  },
+  {
+    name: "Deutscher Tierschutzbund, Die Haltung von Aquarienfischen",
+    url: "https://www.tierschutzbund.de/fileadmin/Seiten/tierschutzbund.de/Downloads/Broschueren/Broschuere_Aquarienfische_Haltung.pdf",
+  },
+];

package/src/tool/aquariumLightingPhotoperiodPlanner/component.astro

@@ -0,0 +1,92 @@
+---
+import type { AquariumLightingPhotoperiodPlannerUI } from './ui';
+import { calculateSchedule, DEFAULT_INPUT, getLightWindow } from './logic';
+import { getIntensityChartMarkers, getIntensityChartPaths } from './dom-views';
+import './aquarium-lighting-photoperiod-planner.css';
+
+interface Props { ui: AquariumLightingPhotoperiodPlannerUI; }
+
+const { ui } = Astro.props;
+const initial = calculateSchedule(DEFAULT_INPUT);
+const initialWindow = getLightWindow(initial);
+const initialChart = getIntensityChartPaths(initial);
+const initialMarkers = getIntensityChartMarkers(initial);
+const initialFullPhase = initial.phases.find((phase) => phase.phase === 'full');
+---
+
+<div class="aqlp-shell" data-aqlp-root>
+  <section class="aqlp-output" aria-label={ui.lightWindowLabel}>
+    <div class="aqlp-output-header">
+      <div class="aqlp-answer-copy">
+        <span class="aqlp-overline">{ui.lightWindowLabel}</span>
+        <strong class="aqlp-window-answer" data-light-window>{initialWindow.startTime} → {initialWindow.endTime}</strong>
+        <span class="aqlp-answer-subline"><strong data-photoperiod-value>{initial.input.photoperiodHours} {ui.hoursUnit}</strong> {ui.dailyRepeatLabel}</span>
+      </div>
+      <span class="aqlp-status" data-status-badge>{ui.statusInside}</span>
+    </div>
+
+    <div class="aqlp-visual-card">
+      <div class="aqlp-timeline-heading"><strong>{ui.dayNightLabel}</strong><span>{ui.fullDayLabel}</span></div>
+      <div class="aqlp-chart-wrap">
+        <svg class="aqlp-chart" viewBox="0 0 960 260" preserveAspectRatio="none" role="img" aria-label={ui.dayNightLabel}>
+          <line class="aqlp-chart-grid" x1="0" y1="40" x2="960" y2="40"></line>
+          <line class="aqlp-chart-grid" x1="0" y1="130" x2="960" y2="130"></line>
+          <line class="aqlp-chart-grid" x1="0" y1="220" x2="960" y2="220"></line>
+          <line class="aqlp-chart-tick" x1="0" y1="32" x2="0" y2="228"></line>
+          <line class="aqlp-chart-tick" x1="240" y1="32" x2="240" y2="228"></line>
+          <line class="aqlp-chart-tick" x1="480" y1="32" x2="480" y2="228"></line>
+          <line class="aqlp-chart-tick" x1="720" y1="32" x2="720" y2="228"></line>
+          <line class="aqlp-chart-tick" x1="960" y1="32" x2="960" y2="228"></line>
+          <path class="aqlp-chart-fill" data-chart-fill d={initialChart.fill}></path>
+          <path class="aqlp-chart-line" data-chart-line d={initialChart.line}></path>
+          <circle class="aqlp-chart-marker aqlp-chart-marker-edge" data-chart-marker-start cx={(initialMarkers.start / 1440) * 960} cy="220" r="8"></circle>
+          <circle class="aqlp-chart-marker aqlp-chart-marker-full" data-chart-marker-full cx={(initialMarkers.full / 1440) * 960} cy="40" r="8"></circle>
+          <circle class="aqlp-chart-marker aqlp-chart-marker-edge" data-chart-marker-end cx={(initialMarkers.end / 1440) * 960} cy="220" r="8"></circle>
+          <text class="aqlp-chart-y-label" x="12" y="27">100%</text>
+          <text class="aqlp-chart-y-label" x="12" y="126">50%</text>
+          <text class="aqlp-chart-y-label" x="38" y="216">0%</text>
+          <text class="aqlp-chart-x-label" x="0" y="258">00:00</text>
+          <text class="aqlp-chart-x-label" x="240" y="258">06:00</text>
+          <text class="aqlp-chart-x-label" x="480" y="258">12:00</text>
+          <text class="aqlp-chart-x-label" x="720" y="258">18:00</text>
+          <text class="aqlp-chart-x-label" x="960" y="258" text-anchor="end">24:00</text>
+        </svg>
+      </div>
+      <div class="aqlp-event-row" aria-live="polite">
+        <span><i class="aqlp-event-dot aqlp-event-start"></i><strong data-event-start>{initialWindow.startTime} {ui.lightsOnLabel}</strong></span>
+        <span><i class="aqlp-event-dot aqlp-event-full"></i><strong data-event-full>{initialFullPhase?.startTime ?? initialWindow.startTime} {ui.fullLightLabel}</strong></span>
+        <span><i class="aqlp-event-dot aqlp-event-end"></i><strong data-event-end>{initialWindow.endTime} {ui.lightsOffLabel}</strong></span>
+      </div>
+    </div>
+
+    <div class="aqlp-summary-row">
+      <div><span>{ui.targetBandLabel}</span><strong data-target-band>7 to 9 {ui.hoursUnit}</strong></div>
+      <div><span>{ui.fullIntensityLabel}</span><strong data-full-intensity>7 {ui.hoursUnit}</strong></div>
+    </div>
+    <div class="aqlp-co2-row" data-co2-row><span class="aqlp-co2-mark">CO₂</span><span><strong>{ui.co2Label}</strong><small>{ui.co2Hint}</small></span><strong data-co2-window>07:00 → 15:00</strong></div>
+    <div class="aqlp-signal" aria-live="polite"><span class="aqlp-signal-mark" aria-hidden="true"></span><p data-adjustment>{ui.adjustmentInside}</p></div>
+    <div class="aqlp-legend"><span><i class="aqlp-legend-swatch aqlp-legend-ramp"></i>{ui.phaseRampUp}</span><span><i class="aqlp-legend-swatch aqlp-legend-full"></i>{ui.phaseFull}</span><span><i class="aqlp-legend-swatch aqlp-legend-dark"></i>{ui.phaseDark}</span></div>
+    <p class="aqlp-footnote">{ui.limitsText}</p>
+  </section>
+
+  <section class="aqlp-controls" aria-label={ui.controlsLabel}>
+    <div class="aqlp-controls-heading"><span class="aqlp-overline">{ui.controlsLabel}</span></div>
+    <div class="aqlp-control-stack">
+      <fieldset class="aqlp-control aqlp-choice-control"><legend>{ui.aquariumTypeLabel}</legend><div class="aqlp-choice-group" data-choice-group="aquariumType" role="group" aria-label={ui.aquariumTypeLabel}><button type="button" class="aqlp-choice" data-choice="aquariumType" data-value="tropical" aria-pressed="true">{ui.aquariumTypeTropical}</button><button type="button" class="aqlp-choice" data-choice="aquariumType" data-value="coldwater" aria-pressed="false">{ui.aquariumTypeColdwater}</button><button type="button" class="aqlp-choice" data-choice="aquariumType" data-value="marine" aria-pressed="false">{ui.aquariumTypeMarine}</button></div></fieldset>
+      <fieldset class="aqlp-control aqlp-choice-control"><legend>{ui.plantProfileLabel}</legend><div class="aqlp-choice-group" data-choice-group="plantProfile" role="group" aria-label={ui.plantProfileLabel}><button type="button" class="aqlp-choice" data-choice="plantProfile" data-value="none" aria-pressed="false">{ui.plantProfileNone}</button><button type="button" class="aqlp-choice" data-choice="plantProfile" data-value="low" aria-pressed="true">{ui.plantProfileLow}</button><button type="button" class="aqlp-choice" data-choice="plantProfile" data-value="high" aria-pressed="false">{ui.plantProfileHigh}</button></div></fieldset>
+      <div class="aqlp-control"><label for="aqlp-start-time">{ui.startTimeLabel}</label><input id="aqlp-start-time" class="aqlp-input" data-field="startTime" type="time" value={initial.input.startTime} /></div>
+      <div class="aqlp-control aqlp-range-control"><div class="aqlp-label-line"><label for="aqlp-photoperiod">{ui.photoperiodLabel}</label><output data-output="photoperiodHours">8 {ui.hoursUnit}</output></div><input id="aqlp-photoperiod" data-field="photoperiodHours" data-unit={ui.hoursUnit} type="range" min="6" max="12" step="0.5" value={initial.input.photoperiodHours} /></div>
+    </div>
+
+    <details class="aqlp-advanced"><summary class="aqlp-details-summary">{ui.optionalRampsLabel}<span>{ui.optionalRampsSummary}</span></summary><div class="aqlp-ramp-grid"><div class="aqlp-control aqlp-range-control"><div class="aqlp-label-line"><label for="aqlp-ramp-up">{ui.rampUpLabel}</label><output data-output="rampUpMinutes">30 {ui.minutesUnit}</output></div><input id="aqlp-ramp-up" data-field="rampUpMinutes" data-unit={ui.minutesUnit} type="range" min="0" max="180" step="15" value={initial.input.rampUpMinutes} /></div><div class="aqlp-control aqlp-range-control"><div class="aqlp-label-line"><label for="aqlp-ramp-down">{ui.rampDownLabel}</label><output data-output="rampDownMinutes">30 {ui.minutesUnit}</output></div><input id="aqlp-ramp-down" data-field="rampDownMinutes" data-unit={ui.minutesUnit} type="range" min="0" max="180" step="15" value={initial.input.rampDownMinutes} /></div></div></details>
+  </section>
+</div>
+
+<script is:inline type="application/json" id="aqlp-data" set:html={JSON.stringify({ ui })}></script>
+<script>
+  import { mountPlanner } from './controller';
+
+  const data = JSON.parse(document.getElementById('aqlp-data')?.textContent ?? '{}');
+  const root = document.querySelector<HTMLElement>('[data-aqlp-root]');
+  if (root && data.ui) mountPlanner(root, data.ui);
+</script>

package/src/tool/aquariumLightingPhotoperiodPlanner/controller.ts

@@ -0,0 +1,179 @@
+import {
+  calculateSchedule,
+  DEFAULT_INPUT,
+  type AquariumType,
+  type LightingInput,
+  type PlantProfile,
+} from "./logic";
+import { renderSchedule } from "./dom-views";
+import { loadInput, saveInput } from "./storage";
+import type { AquariumLightingPhotoperiodPlannerUI } from "./ui";
+
+type ControllerRoot = HTMLElement;
+
+function readNumber(
+  root: ControllerRoot,
+  field: string,
+  fallback: number,
+): number {
+  const input = root.querySelector<HTMLInputElement>(`[data-field="${field}"]`);
+  const value = Number(input?.value);
+  return Number.isFinite(value) ? value : fallback;
+}
+
+function readInput(root: ControllerRoot): LightingInput {
+  const aquariumType = root.querySelector<HTMLButtonElement>(
+    '[data-choice-group="aquariumType"] [aria-pressed="true"]',
+  )?.dataset.value as AquariumType | undefined;
+  const plantProfile = root.querySelector<HTMLButtonElement>(
+    '[data-choice-group="plantProfile"] [aria-pressed="true"]',
+  )?.dataset.value as PlantProfile | undefined;
+  return {
+    aquariumType: aquariumType ?? DEFAULT_INPUT.aquariumType,
+    plantProfile: plantProfile ?? DEFAULT_INPUT.plantProfile,
+    startTime:
+      root.querySelector<HTMLInputElement>('[data-field="startTime"]')?.value ??
+      DEFAULT_INPUT.startTime,
+    photoperiodHours: readNumber(
+      root,
+      "photoperiodHours",
+      DEFAULT_INPUT.photoperiodHours,
+    ),
+    rampUpMinutes: readNumber(
+      root,
+      "rampUpMinutes",
+      DEFAULT_INPUT.rampUpMinutes,
+    ),
+    rampDownMinutes: readNumber(
+      root,
+      "rampDownMinutes",
+      DEFAULT_INPUT.rampDownMinutes,
+    ),
+  };
+}
+
+function updateSliderOutput(
+  root: ControllerRoot,
+  field: string,
+  value: string,
+  unit: string,
+): void {
+  const output = root.querySelector(`[data-output="${field}"]`);
+  if (output) output.textContent = `${value} ${unit}`;
+}
+
+function setFields(root: ControllerRoot, input: LightingInput): void {
+  const fields = [
+    "startTime",
+    "photoperiodHours",
+    "rampUpMinutes",
+    "rampDownMinutes",
+  ] as const;
+  fields.forEach((field) => {
+    const element = root.querySelector<HTMLInputElement>(
+      `[data-field="${field}"]`,
+    );
+    if (element) element.value = String(input[field]);
+  });
+}
+
+function setSliderOutputs(
+  root: ControllerRoot,
+  input: LightingInput,
+  ui: AquariumLightingPhotoperiodPlannerUI,
+): void {
+  updateSliderOutput(
+    root,
+    "photoperiodHours",
+    String(input.photoperiodHours),
+    ui.hoursUnit,
+  );
+  updateSliderOutput(
+    root,
+    "rampUpMinutes",
+    String(input.rampUpMinutes),
+    ui.minutesUnit,
+  );
+  updateSliderOutput(
+    root,
+    "rampDownMinutes",
+    String(input.rampDownMinutes),
+    ui.minutesUnit,
+  );
+}
+
+function setInputValues(
+  root: ControllerRoot,
+  input: LightingInput,
+  ui: AquariumLightingPhotoperiodPlannerUI,
+): void {
+  setFields(root, input);
+  setSliderOutputs(root, input, ui);
+  selectChoice(root, "aquariumType", input.aquariumType);
+  selectChoice(root, "plantProfile", input.plantProfile);
+}
+
+function selectChoice(
+  root: ControllerRoot,
+  field: string,
+  value: string,
+): void {
+  root
+    .querySelectorAll<HTMLButtonElement>(
+      `[data-choice-group="${field}"] [data-choice]`,
+    )
+    .forEach((item) => {
+      item.setAttribute("aria-pressed", String(item.dataset.value === value));
+    });
+}
+
+function bindChoices(root: ControllerRoot, refresh: () => void): void {
+  root
+    .querySelectorAll<HTMLButtonElement>("[data-choice]")
+    .forEach((choice) => {
+      choice.addEventListener("click", () => {
+        selectChoice(
+          root,
+          choice.dataset.choice ?? "",
+          choice.dataset.value ?? "",
+        );
+        refresh();
+      });
+    });
+}
+
+function bindInputs(
+  root: ControllerRoot,
+  refresh: () => void,
+  ui: AquariumLightingPhotoperiodPlannerUI,
+): void {
+  root.querySelectorAll<HTMLInputElement>("[data-field]").forEach((input) => {
+    input.addEventListener("input", () => {
+      if (input.type === "range")
+        updateSliderOutput(
+          root,
+          input.dataset.field ?? "",
+          input.value,
+          input.dataset.unit ?? ui.hoursUnit,
+        );
+      refresh();
+    });
+    input.addEventListener("change", refresh);
+  });
+}
+
+export function mountPlanner(
+  root: ControllerRoot,
+  ui: AquariumLightingPhotoperiodPlannerUI,
+): void {
+  const saved = loadInput() ?? DEFAULT_INPUT;
+  setInputValues(root, saved, ui);
+  const refresh = () => {
+    const input = readInput(root);
+    saveInput(input);
+    renderSchedule(root, calculateSchedule(input), ui);
+  };
+  bindChoices(root, refresh);
+  bindInputs(root, refresh, ui);
+  refresh();
+}

package/src/tool/aquariumLightingPhotoperiodPlanner/dom-views.test.ts

@@ -0,0 +1,26 @@
+import { describe, expect, it } from "vitest";
+import { getIntensityChartMarkers, getIntensityChartPaths } from "./dom-views";
+import { calculateSchedule, DEFAULT_INPUT } from "./logic";
+
+describe("aquarium lighting photoperiod planner chart", () => {
+  it("anchors chart markers to the calculated light phases", () => {
+    const schedule = calculateSchedule(DEFAULT_INPUT);
+
+    expect(getIntensityChartMarkers(schedule)).toEqual({
+      start: 480,
+      full: 510,
+      end: 960,
+    });
+  });
+
+  it("returns a filled trapecio path with the daily clock boundaries", () => {
+    const schedule = calculateSchedule(DEFAULT_INPUT);
+    const paths = getIntensityChartPaths(schedule);
+
+    expect(paths.line).toMatch(/^M 0\.00 220\.00/);
+    expect(paths.line).toContain("320.00 220.00");
+    expect(paths.line).toContain("340.00 40.00");
+    expect(paths.line).toContain("640.00 220.00");
+    expect(paths.fill).toMatch(/L 960 220 L 0 220 Z$/);
+  });
+});

package/src/tool/aquariumLightingPhotoperiodPlanner/dom-views.ts

@@ -0,0 +1,187 @@
+import { evaluateSchedule } from "./evaluator";
+import {
+  formatHours,
+  getLightWindow,
+  type LightingSchedule,
+  type PhaseSegment,
+} from "./logic";
+import type { AquariumLightingPhotoperiodPlannerUI } from "./ui";
+
+interface RenderRoot extends HTMLElement {
+  querySelector(selector: string): HTMLElement | null;
+}
+
+function clockMinutes(value: string): number {
+  const [hourText = "0", minuteText = "0"] = value.split(":");
+  const hours = Number(hourText);
+  const minutes = Number(minuteText);
+  return hours * 60 + minutes;
+}
+
+function levelForPhase(phase: PhaseSegment["phase"], progress: number): number {
+  if (phase === "ramp-up") return progress;
+  if (phase === "ramp-down") return 1 - progress;
+  if (phase === "full") return 1;
+  return 0;
+}
+
+function chartSegment(
+  phase: PhaseSegment,
+): Array<{ time: number; level: number }> {
+  const start = clockMinutes(phase.startTime);
+  const firstDuration = Math.min(phase.duration, 1440 - start);
+  const end = start + firstDuration;
+  const startLevel = levelForPhase(phase.phase, 0);
+  const endProgress = phase.duration ? firstDuration / phase.duration : 1;
+  const endLevel = levelForPhase(phase.phase, endProgress);
+  const points = [
+    { time: start, level: startLevel },
+    { time: end, level: endLevel },
+  ];
+  const secondDuration = phase.duration - firstDuration;
+  if (secondDuration > 0) {
+    points.push(
+      { time: 0, level: endLevel },
+      { time: secondDuration, level: levelForPhase(phase.phase, 1) },
+    );
+  }
+  return points;
+}
+
+function chartCoordinate(point: { time: number; level: number }): string {
+  const x = (point.time / 1440) * 960;
+  const y = 220 - point.level * 180;
+  return `${x.toFixed(2)} ${y.toFixed(2)}`;
+}
+
+export function getIntensityChartPaths(schedule: LightingSchedule): {
+  fill: string;
+  line: string;
+} {
+  const points = schedule.phases
+    .flatMap(chartSegment)
+    .sort((left, right) => left.time - right.time);
+  const unique = points.filter(
+    (point, index) => index === 0 || point.time !== points[index - 1]?.time,
+  );
+  const line = unique.map(chartCoordinate).join(" L ");
+  return { line: `M ${line}`, fill: `M ${line} L 960 220 L 0 220 Z` };
+}
+
+export function getIntensityChartMarkers(schedule: LightingSchedule): {
+  start: number;
+  full: number;
+  end: number;
+} {
+  const lightWindow = getLightWindow(schedule);
+  const fullPhase = schedule.phases.find((phase) => phase.phase === "full");
+  return {
+    start: clockMinutes(lightWindow.startTime),
+    full: clockMinutes(fullPhase?.startTime ?? lightWindow.startTime),
+    end: clockMinutes(lightWindow.endTime),
+  };
+}
+
+function subtractHour(value: string): string {
+  const minutes = (clockMinutes(value) + 1380) % 1440;
+  const hour = Math.floor(minutes / 60)
+    .toString()
+    .padStart(2, "0");
+  const minute = (minutes % 60).toString().padStart(2, "0");
+  return `${hour}:${minute}`;
+}
+
+function updateText(root: RenderRoot, selector: string, value: string): void {
+  const element = root.querySelector(selector);
+  if (element) element.textContent = value;
+}
+
+function updateAnswer(
+  root: RenderRoot,
+  schedule: LightingSchedule,
+  ui: AquariumLightingPhotoperiodPlannerUI,
+): void {
+  const evaluation = evaluateSchedule(schedule, ui);
+  const lightWindow = getLightWindow(schedule);
+  updateText(root, "[data-status-badge]", evaluation.badge);
+  updateText(root, "[data-target-band]", evaluation.differenceLabel);
+  updateText(
+    root,
+    "[data-light-window]",
+    `${lightWindow.startTime} → ${lightWindow.endTime}`,
+  );
+  updateText(
+    root,
+    "[data-full-intensity]",
+    `${formatHours(schedule.fullIntensityMinutes / 60)} ${ui.hoursUnit}`,
+  );
+  updateText(root, "[data-adjustment]", evaluation.adjustment);
+  updateText(
+    root,
+    "[data-photoperiod-value]",
+    `${formatHours(schedule.input.photoperiodHours)} ${ui.hoursUnit}`,
+  );
+}
+
+function updateEvents(
+  root: RenderRoot,
+  schedule: LightingSchedule,
+  ui: AquariumLightingPhotoperiodPlannerUI,
+): void {
+  const lightWindow = getLightWindow(schedule);
+  const fullPhase = schedule.phases.find((phase) => phase.phase === "full");
+  updateText(
+    root,
+    "[data-event-start]",
+    `${lightWindow.startTime} ${ui.lightsOnLabel}`,
+  );
+  updateText(
+    root,
+    "[data-event-full]",
+    `${fullPhase?.startTime ?? lightWindow.startTime} ${ui.fullLightLabel}`,
+  );
+  updateText(
+    root,
+    "[data-event-end]",
+    `${lightWindow.endTime} ${ui.lightsOffLabel}`,
+  );
+  updateText(
+    root,
+    "[data-co2-window]",
+    `${subtractHour(lightWindow.startTime)} → ${subtractHour(lightWindow.endTime)}`,
+  );
+}
+
+function updateCo2(root: RenderRoot, schedule: LightingSchedule): void {
+  const co2Row = root.querySelector("[data-co2-row]");
+  if (co2Row) co2Row.hidden = schedule.input.plantProfile === "none";
+}
+
+function updateChart(root: RenderRoot, schedule: LightingSchedule): void {
+  const chartPaths = getIntensityChartPaths(schedule);
+  const chartFill = root.querySelector("[data-chart-fill]");
+  const chartLine = root.querySelector("[data-chart-line]");
+  if (chartFill) chartFill.setAttribute("d", chartPaths.fill);
+  if (chartLine) chartLine.setAttribute("d", chartPaths.line);
+  const markers = getIntensityChartMarkers(schedule);
+  const startMarker = root.querySelector("[data-chart-marker-start]");
+  const fullMarker = root.querySelector("[data-chart-marker-full]");
+  const endMarker = root.querySelector("[data-chart-marker-end]");
+  if (startMarker)
+    startMarker.setAttribute("cx", String((markers.start / 1440) * 960));
+  if (fullMarker)
+    fullMarker.setAttribute("cx", String((markers.full / 1440) * 960));
+  if (endMarker)
+    endMarker.setAttribute("cx", String((markers.end / 1440) * 960));
+}
+
+export function renderSchedule(
+  root: RenderRoot,
+  schedule: LightingSchedule,
+  ui: AquariumLightingPhotoperiodPlannerUI,
+): void {
+  updateAnswer(root, schedule, ui);
+  updateEvents(root, schedule, ui);
+  updateCo2(root, schedule);
+  updateChart(root, schedule);
+}

package/src/tool/aquariumLightingPhotoperiodPlanner/entry.ts

@@ -0,0 +1,29 @@
+import type { AquariumToolEntry, ToolLocaleContent } from "../../types";
+import type { AquariumLightingPhotoperiodPlannerUI } from "./ui";
+
+export type { AquariumLightingPhotoperiodPlannerUI };
+export type AquariumLightingPhotoperiodPlannerLocaleContent =
+  ToolLocaleContent<AquariumLightingPhotoperiodPlannerUI>;
+
+export const aquariumLightingPhotoperiodPlanner: AquariumToolEntry<AquariumLightingPhotoperiodPlannerUI> =
+  {
+    id: "aquarium-lighting-photoperiod-schedule-planner",
+    icons: { bg: "mdi:lightbulb-on-outline", fg: "mdi:fishbowl-outline" },
+  i18n: {
+    de: () => import('./i18n/de').then((m) => m.content),
+    en: () => import('./i18n/en').then((m) => m.content),
+    es: () => import('./i18n/es').then((m) => m.content),
+    fr: () => import('./i18n/fr').then((m) => m.content),
+    id: () => import('./i18n/id').then((m) => m.content),
+    it: () => import('./i18n/it').then((m) => m.content),
+    ja: () => import('./i18n/ja').then((m) => m.content),
+    ko: () => import('./i18n/ko').then((m) => m.content),
+    nl: () => import('./i18n/nl').then((m) => m.content),
+    pl: () => import('./i18n/pl').then((m) => m.content),
+    pt: () => import('./i18n/pt').then((m) => m.content),
+    ru: () => import('./i18n/ru').then((m) => m.content),
+    sv: () => import('./i18n/sv').then((m) => m.content),
+    tr: () => import('./i18n/tr').then((m) => m.content),
+    zh: () => import('./i18n/zh').then((m) => m.content),
+  },
+};

package/src/tool/aquariumLightingPhotoperiodPlanner/evaluator.ts

@@ -0,0 +1,47 @@
+import type { AquariumLightingPhotoperiodPlannerUI } from "./ui";
+import type { LightingSchedule, ScheduleStatus } from "./logic";
+import { formatHours } from "./logic";
+
+export interface ScheduleEvaluation {
+  badge: string;
+  adjustment: string;
+  differenceLabel: string;
+}
+
+function getStatusLabel(
+  status: ScheduleStatus,
+  ui: AquariumLightingPhotoperiodPlannerUI,
+): string {
+  if (status === "below") return ui.statusBelow;
+  if (status === "above") return ui.statusAbove;
+  return ui.statusInside;
+}
+
+function getAdjustment(
+  status: ScheduleStatus,
+  schedule: LightingSchedule,
+  ui: AquariumLightingPhotoperiodPlannerUI,
+): string {
+  if (status === "below")
+    return ui.adjustmentBelow.replace(
+      "{hours}",
+      formatHours(schedule.differenceHours),
+    );
+  if (status === "above")
+    return ui.adjustmentAbove.replace(
+      "{hours}",
+      formatHours(schedule.differenceHours),
+    );
+  return ui.adjustmentInside;
+}
+
+export function evaluateSchedule(
+  schedule: LightingSchedule,
+  ui: AquariumLightingPhotoperiodPlannerUI,
+): ScheduleEvaluation {
+  return {
+    badge: getStatusLabel(schedule.status, ui),
+    adjustment: getAdjustment(schedule.status, schedule, ui),
+    differenceLabel: `${formatHours(schedule.band.low)} to ${formatHours(schedule.band.high)} ${ui.hoursUnit}`,
+  };
+}