@jjlmoya/utils-aquarium 1.56.0 → 1.58.0

package/src/tool/aquariumFilterTurnoverStockingPlanner/logic.ts

@@ -0,0 +1,99 @@
+export type AquariumSetup = 'community' | 'planted' | 'highWaste';
+export type StockingLoad = 'light' | 'moderate' | 'heavy';
+export type TurnoverStatus = 'under' | 'target' | 'high';
+
+export interface AquariumPlannerInput {
+  tankVolumeLiters: number;
+  ratedFlowLitersPerHour: number;
+  flowLossPercent: number;
+  fishCount: number;
+  averageAdultLengthCm: number;
+  setup: AquariumSetup;
+}
+
+export interface AquariumPlannerResult {
+  effectiveFlowLitersPerHour: number;
+  ratedTurnover: number;
+  effectiveTurnover: number;
+  targetMinTurnover: number;
+  targetMaxTurnover: number;
+  targetMinFlowLitersPerHour: number;
+  targetMaxFlowLitersPerHour: number;
+  stockingProxyCmPerLiter: number;
+  stockingLoad: StockingLoad;
+  turnoverStatus: TurnoverStatus;
+  flowGapLitersPerHour: number;
+  flowAboveTargetLitersPerHour: number;
+}
+
+interface SetupProfile {
+  min: number;
+  max: number;
+}
+
+const SETUP_PROFILES: Record<AquariumSetup, SetupProfile> = {
+  community: { min: 4, max: 6 },
+  planted: { min: 3, max: 5 },
+  highWaste: { min: 6, max: 10 },
+};
+
+function positive(value: number, fallback: number): number {
+  return Number.isFinite(value) && value > 0 ? value : fallback;
+}
+
+function bounded(value: number, min: number, max: number): number {
+  return Math.min(max, Math.max(min, Number.isFinite(value) ? value : min));
+}
+
+export function normalizeInput(input: AquariumPlannerInput): AquariumPlannerInput {
+  return {
+    tankVolumeLiters: positive(input.tankVolumeLiters, 1),
+    ratedFlowLitersPerHour: positive(input.ratedFlowLitersPerHour, 1),
+    flowLossPercent: bounded(input.flowLossPercent, 0, 90),
+    fishCount: bounded(input.fishCount, 0, 200),
+    averageAdultLengthCm: bounded(input.averageAdultLengthCm, 0, 80),
+    setup: input.setup in SETUP_PROFILES ? input.setup : 'community',
+  };
+}
+
+function getStockingLoad(proxy: number): StockingLoad {
+  if (proxy <= 0.6) return 'light';
+  if (proxy <= 1.2) return 'moderate';
+  return 'heavy';
+}
+
+function getTurnoverStatus(turnover: number, profile: SetupProfile): TurnoverStatus {
+  if (turnover < profile.min) return 'under';
+  if (turnover > profile.max) return 'high';
+  return 'target';
+}
+
+export function calculatePlanner(input: AquariumPlannerInput): AquariumPlannerResult {
+  const values = normalizeInput(input);
+  const profile = SETUP_PROFILES[values.setup];
+  const effectiveFlow = values.ratedFlowLitersPerHour * (1 - values.flowLossPercent / 100);
+  const ratedTurnover = values.ratedFlowLitersPerHour / values.tankVolumeLiters;
+  const effectiveTurnover = effectiveFlow / values.tankVolumeLiters;
+  const stockingProxy = (values.fishCount * values.averageAdultLengthCm) / values.tankVolumeLiters;
+  const flowGap = Math.max(0, profile.min * values.tankVolumeLiters - effectiveFlow);
+  const flowAbove = Math.max(0, effectiveFlow - profile.max * values.tankVolumeLiters);
+
+  return {
+    effectiveFlowLitersPerHour: effectiveFlow,
+    ratedTurnover,
+    effectiveTurnover,
+    targetMinTurnover: profile.min,
+    targetMaxTurnover: profile.max,
+    targetMinFlowLitersPerHour: profile.min * values.tankVolumeLiters,
+    targetMaxFlowLitersPerHour: profile.max * values.tankVolumeLiters,
+    stockingProxyCmPerLiter: stockingProxy,
+    stockingLoad: getStockingLoad(stockingProxy),
+    turnoverStatus: getTurnoverStatus(effectiveTurnover, profile),
+    flowGapLitersPerHour: flowGap,
+    flowAboveTargetLitersPerHour: flowAbove,
+  };
+}
+
+export function getSetupProfile(setup: AquariumSetup): SetupProfile {
+  return SETUP_PROFILES[setup];
+}

package/src/tool/aquariumFilterTurnoverStockingPlanner/seo.astro

@@ -0,0 +1,14 @@
+---
+import { SEORenderer } from '@jjlmoya/utils-shared';
+import { aquariumFilterTurnoverStockingPlanner } from './entry';
+import type { KnownLocale } from '../../types';
+
+interface Props { locale?: KnownLocale; }
+
+const { locale = 'en' } = Astro.props;
+const loader = aquariumFilterTurnoverStockingPlanner.i18n[locale] ?? aquariumFilterTurnoverStockingPlanner.i18n.en;
+const content = loader === undefined ? undefined : await loader();
+
+---
+
+{content && <SEORenderer content={{ locale, sections: content.seo }} />}

package/src/tool/aquariumFilterTurnoverStockingPlanner/storage.ts

@@ -0,0 +1,21 @@
+import type { AquariumPlannerInput } from './logic';
+
+const STORAGE_KEY = 'jjlmoya-aquarium-filter-turnover-planner';
+
+export function loadPlannerState(): AquariumPlannerInput | undefined {
+  try {
+    const raw = window.localStorage.getItem(STORAGE_KEY);
+    if (!raw) return undefined;
+    return JSON.parse(raw) as AquariumPlannerInput;
+  } catch {
+    return undefined;
+  }
+}
+
+export function savePlannerState(input: AquariumPlannerInput): void {
+  try {
+    window.localStorage.setItem(STORAGE_KEY, JSON.stringify(input));
+  } catch {
+    return;
+  }
+}

package/src/tool/aquariumFilterTurnoverStockingPlanner/ui.ts

@@ -0,0 +1,40 @@
+export interface AquariumFilterTurnoverStockingPlannerUI extends Record<string, string> {
+  presetsLabel: string;
+  presetCommunity: string;
+  presetPlanted: string;
+  presetHighWaste: string;
+  tankVolumeLabel: string;
+  tankVolumeHint: string;
+  ratedFlowLabel: string;
+  ratedFlowHint: string;
+  flowLossLabel: string;
+  flowLossHint: string;
+  fishCountLabel: string;
+  averageLengthLabel: string;
+  setupLabel: string;
+  setupCommunity: string;
+  setupPlanted: string;
+  setupHighWaste: string;
+  resultEyebrow: string;
+  effectiveTurnoverLabel: string;
+  targetLabel: string;
+  effectiveFlowLabel: string;
+  stockingProxyLabel: string;
+  currentTitle: string;
+  currentDescription: string;
+  statusUnder: string;
+  statusTarget: string;
+  statusHigh: string;
+  loadLight: string;
+  loadModerate: string;
+  loadHeavy: string;
+  cautionTitle: string;
+  bandSignalInside: string;
+  bandSignalBelow: string;
+  bandSignalAbove: string;
+  maintenanceText: string;
+  useTestKits: string;
+  metricLiters: string;
+  metricPerHour: string;
+  metricCentimetersPerLiter: string;
+}

package/src/tools.ts

@@ -1,9 +1,15 @@
 export { ALL_ENTRIES } from './entries';
 import { aquariumTankVolumeWaterChangeCalculator } from './tool/aquariumTankVolumeWaterChangeCalculator/entry';
+import { aquariumFilterTurnoverStockingPlanner } from './tool/aquariumFilterTurnoverStockingPlanner/entry';
 
 export const ALL_TOOLS = [{
   entry: aquariumTankVolumeWaterChangeCalculator,
   Component: () => import('./tool/aquariumTankVolumeWaterChangeCalculator/component.astro'),
   SEOComponent: () => import('./tool/aquariumTankVolumeWaterChangeCalculator/seo.astro'),
   BibliographyComponent: () => import('./tool/aquariumTankVolumeWaterChangeCalculator/bibliography.astro'),
+}, {
+  entry: aquariumFilterTurnoverStockingPlanner,
+  Component: () => import('./tool/aquariumFilterTurnoverStockingPlanner/component.astro'),
+  SEOComponent: () => import('./tool/aquariumFilterTurnoverStockingPlanner/seo.astro'),
+  BibliographyComponent: () => import('./tool/aquariumFilterTurnoverStockingPlanner/bibliography.astro'),
 }];