@neaps/tide-predictor 0.4.0 → 0.5.0

package/dist/index.js

@@ -60,16 +60,16 @@ var coefficients_default = coefficients;
 
 //#endregion
 //#region src/astronomy/index.ts
-const polynomial = (coefficients$1, argument) => {
+const polynomial = (coefficients, argument) => {
 	const result = [];
-	coefficients$1.forEach((coefficient, index) => {
+	coefficients.forEach((coefficient, index) => {
 		result.push(coefficient * Math.pow(argument, index));
 	});
 	return result.reduce((a, b) => a + b);
 };
-const derivativePolynomial = (coefficients$1, argument) => {
+const derivativePolynomial = (coefficients, argument) => {
 	const result = [];
-	coefficients$1.forEach((coefficient, index) => {
+	coefficients.forEach((coefficient, index) => {
 		result.push(coefficient * index * Math.pow(argument, index - 1));
 	});
 	return result.reduce((a, b) => a + b);
@@ -304,57 +304,57 @@ var node_corrections_default = corrections;
 
 //#endregion
 //#region src/constituents/definition.ts
-function defineConstituent(name, coefficients$1, u, f) {
-	if (!coefficients$1) throw new Error("Coefficient must be defined for a constituent");
+function defineConstituent(names, coefficients, u, f) {
+	if (!coefficients) throw new Error("Coefficient must be defined for a constituent");
 	return Object.freeze({
-		name,
-		coefficients: coefficients$1,
-		value: (astro$1) => {
-			return dotArray(coefficients$1, astronomicValues(astro$1));
+		names: Array.isArray(names) ? names : [names],
+		coefficients,
+		value: (astro) => {
+			return dotArray(coefficients, astronomicValues(astro));
 		},
-		speed(astro$1) {
-			return dotArray(coefficients$1, astronomicSpeed(astro$1));
+		speed(astro) {
+			return dotArray(coefficients, astronomicSpeed(astro));
 		},
 		u: typeof u !== "undefined" ? u : node_corrections_default.uZero,
 		f: typeof f !== "undefined" ? f : node_corrections_default.fUnity
 	});
 }
-function defineCompoundConstituent(name, members) {
-	const coefficients$1 = [];
+function defineCompoundConstituent(names, members) {
+	const coefficients = [];
 	members.forEach(({ constituent, factor }) => {
 		constituent.coefficients.forEach((coefficient, index) => {
-			if (typeof coefficients$1[index] === "undefined") coefficients$1[index] = 0;
-			coefficients$1[index] += coefficient * factor;
+			if (typeof coefficients[index] === "undefined") coefficients[index] = 0;
+			coefficients[index] += coefficient * factor;
 		});
 	});
 	return Object.freeze({
-		name,
-		coefficients: coefficients$1,
-		speed: (astro$1) => {
+		names: Array.isArray(names) ? names : [names],
+		coefficients,
+		speed: (astro) => {
 			let speed = 0;
 			members.forEach(({ constituent, factor }) => {
-				speed += constituent.speed(astro$1) * factor;
+				speed += constituent.speed(astro) * factor;
 			});
 			return speed;
 		},
-		value: (astro$1) => {
+		value: (astro) => {
 			let value = 0;
 			members.forEach(({ constituent, factor }) => {
-				value += constituent.value(astro$1) * factor;
+				value += constituent.value(astro) * factor;
 			});
 			return value;
 		},
-		u: (astro$1) => {
+		u: (astro) => {
 			let u = 0;
 			members.forEach(({ constituent, factor }) => {
-				u += constituent.u(astro$1) * factor;
+				u += constituent.u(astro) * factor;
 			});
 			return u;
 		},
-		f: (astro$1) => {
+		f: (astro) => {
 			const f = [];
 			members.forEach(({ constituent, factor }) => {
-				f.push(Math.pow(constituent.f(astro$1), Math.abs(factor)));
+				f.push(Math.pow(constituent.f(astro), Math.abs(factor)));
 			});
 			return f.reduce((previous, value) => previous * value);
 		}
@@ -370,27 +370,27 @@ function dotArray(a, b) {
 	});
 	return results.reduce((total, value) => total + value);
 }
-function astronimicDoodsonNumber(astro$1) {
+function astronimicDoodsonNumber(astro) {
 	return [
-		astro$1["T+h-s"],
-		astro$1.s,
-		astro$1.h,
-		astro$1.p,
-		astro$1.N,
-		astro$1.pp,
-		astro$1["90"]
+		astro["T+h-s"],
+		astro.s,
+		astro.h,
+		astro.p,
+		astro.N,
+		astro.pp,
+		astro["90"]
 	];
 }
-function astronomicSpeed(astro$1) {
+function astronomicSpeed(astro) {
 	const results = [];
-	astronimicDoodsonNumber(astro$1).forEach((number) => {
+	astronimicDoodsonNumber(astro).forEach((number) => {
 		results.push(number.speed);
 	});
 	return results;
 }
-function astronomicValues(astro$1) {
+function astronomicValues(astro) {
 	const results = [];
-	astronimicDoodsonNumber(astro$1).forEach((number) => {
+	astronimicDoodsonNumber(astro).forEach((number) => {
 		results.push(number.value);
 	});
 	return results;
@@ -712,7 +712,7 @@ var K2_default = defineConstituent("K2", [
 * Amplitude typically <5% of M2; important in detailed constituent analysis.
 * IHO standard designation (previously abbreviated as LAM2).
 */
-var LAMBDA2_default = defineConstituent("LAMBDA2", [
+var LAMBDA2_default = defineConstituent(["LAM2", "LAMBDA2"], [
 	2,
 	1,
 	-2,
@@ -722,15 +722,6 @@ var LAMBDA2_default = defineConstituent("LAMBDA2", [
 	2
 ], node_corrections_default.uM2, node_corrections_default.fM2);
 
-//#endregion
-//#region src/constituents/LAM2.ts
-/**
-* Alias for compatibility between NOAA and IHO
-*
-* @see LAMBDA2
-*/
-var LAM2_default = LAMBDA2_default;
-
 //#endregion
 //#region src/constituents/M1.ts
 /**
@@ -948,6 +939,40 @@ var MN4_default = defineCompoundConstituent("MN4", [{
 	factor: 1
 }]);
 
+//#endregion
+//#region src/constituents/P1.ts
+/**
+* Solar diurnal (P1).
+* Principal solar diurnal constituent; one-per-solar-day oscillation.
+* Amplitude typically 1/3 of K1; varies with latitude.
+* Forms key component of diurnal tidal analysis alongside K1 and O1.
+*/
+var P1_default = defineConstituent("P1", [
+	1,
+	1,
+	-2,
+	0,
+	0,
+	0,
+	1
+], node_corrections_default.uZero, node_corrections_default.fUnity);
+
+//#endregion
+//#region src/constituents/MP1.ts
+/**
+* Solar-lunar diurnal (MP1 = M2 - P1).
+* Combined solar and lunar diurnal constituent from solar-lunar interaction.
+* Amplitude typically small; usually <5% of K1.
+* Rarely significant except in specialized harmonic analyses.
+*/
+var MP1_default = defineCompoundConstituent("MP1", [{
+	constituent: M2_default,
+	factor: 1
+}, {
+	constituent: P1_default,
+	factor: -1
+}]);
+
 //#endregion
 //#region src/constituents/MS4.ts
 /**
@@ -1112,24 +1137,6 @@ var OO1_default = defineConstituent("OO1", [
 	-1
 ], node_corrections_default.uOO1, node_corrections_default.fOO1);
 
-//#endregion
-//#region src/constituents/P1.ts
-/**
-* Solar diurnal (P1).
-* Principal solar diurnal constituent; one-per-solar-day oscillation.
-* Amplitude typically 1/3 of K1; varies with latitude.
-* Forms key component of diurnal tidal analysis alongside K1 and O1.
-*/
-var P1_default = defineConstituent("P1", [
-	1,
-	1,
-	-2,
-	0,
-	0,
-	0,
-	1
-], node_corrections_default.uZero, node_corrections_default.fUnity);
-
 //#endregion
 //#region src/constituents/Q1.ts
 /**
@@ -1189,7 +1196,7 @@ var R3_default = defineCompoundConstituent("R3", [{
 * Amplitude typically very small; rarely significant.
 * Found only in shallow-water regions with strong tidal distortion.
 */
-var RHO1_default = defineCompoundConstituent("RHO1", [{
+var RHO1_default = defineCompoundConstituent(["RHO", "RHO1"], [{
 	constituent: NU2_default,
 	factor: 1
 }, {
@@ -1197,15 +1204,6 @@ var RHO1_default = defineCompoundConstituent("RHO1", [{
 	factor: -1
 }]);
 
-//#endregion
-//#region src/constituents/RHO.ts
-/**
-* Alias for compatibility between NOAA and IHO
-*
-* @see RHO1
-*/
-var RHO_default = RHO1_default;
-
 //#endregion
 //#region src/constituents/S1.ts
 /**
@@ -1273,7 +1271,7 @@ var S6_default = defineCompoundConstituent("S6", [{
 * Solar annual (Sa).
 * Long-term constituent driven by solar declination variations over the year.
 */
-var SA_default = defineConstituent("Sa", [
+var SA_default = defineConstituent(["SA", "Sa"], [
 	0,
 	0,
 	1,
@@ -1291,7 +1289,7 @@ var SA_default = defineConstituent("Sa", [
 *
 * Note: Often has small amplitude; closely related to K1 and O1 variations.
 */
-var SGM_default = defineConstituent("SGM", [
+var SGM_default = defineConstituent(["SGM", "SIGMA1"], [
 	1,
 	-3,
 	2,
@@ -1307,7 +1305,7 @@ var SGM_default = defineConstituent("SGM", [
 * Solar semi-annual (Ssa).
 * Semi-annual constituent from solar declination with twice-yearly periodicity.
 */
-var SSA_default = defineConstituent("Ssa", [
+var SSA_default = defineConstituent(["Ssa", "SSA"], [
 	0,
 	0,
 	2,
@@ -1367,7 +1365,6 @@ const constituentModules = {
 	"./K1.ts": K1_default,
 	"./K2.ts": K2_default,
 	"./L2.ts": L2_default,
-	"./LAM2.ts": LAM2_default,
 	"./LAMBDA2.ts": LAMBDA2_default,
 	"./M1.ts": M1_default,
 	"./M2.ts": M2_default,
@@ -1382,6 +1379,7 @@ const constituentModules = {
 	"./MKS2.ts": MKS2_default,
 	"./MM.ts": MM_default,
 	"./MN4.ts": MN4_default,
+	"./MP1.ts": MP1_default,
 	"./MS4.ts": MS4_default,
 	"./MSF.ts": MSF_default,
 	"./MSQM.ts": MSQM_default,
@@ -1396,7 +1394,6 @@ const constituentModules = {
 	"./Q1.ts": Q1_default,
 	"./R2.ts": R2_default,
 	"./R3.ts": R3_default,
-	"./RHO.ts": RHO_default,
 	"./RHO1.ts": RHO1_default,
 	"./S1.ts": S1_default,
 	"./S2.ts": S2_default,
@@ -1413,10 +1410,10 @@ const constituentModules = {
 };
 const constituents = {};
 for (const [path, module] of Object.entries(constituentModules)) {
-	if (path.includes("index.ts")) continue;
-	const name = path.split("/").pop()?.replace(/\..*$/, "") ?? "";
-	if (name === "definition") continue;
-	constituents[name] = module;
+	if (path.match(/index|definition/)) continue;
+	module.names.forEach((name) => {
+		constituents[name] = module;
+	});
 }
 var constituents_default = constituents;
 
@@ -1442,11 +1439,11 @@ const getExtremeLabel = (label, highLowLabels) => {
 		low: "Low"
 	}[label];
 };
-const predictionFactory = ({ timeline, constituents: constituents$1, start }) => {
+const predictionFactory = ({ timeline, constituents, start }) => {
 	const getLevel = (hour, modelBaseSpeed, modelU, modelF, modelBaseValue) => {
 		const amplitudes = [];
 		let result = 0;
-		constituents$1.forEach((constituent) => {
+		constituents.forEach((constituent) => {
 			const amplitude = constituent.amplitude;
 			const phase = constituent.phase;
 			const f = modelF[constituent.name];
@@ -1502,12 +1499,12 @@ const predictionFactory = ({ timeline, constituents: constituents$1, start }) =>
 		const { baseSpeed, u, f, baseValue } = prepare();
 		timeline.items.forEach((time, index) => {
 			const hour = timeline.hours[index];
-			const prediction$1 = {
+			const prediction = {
 				time,
 				hour,
 				level: getLevel(hour, baseSpeed, u[index], f[index], baseValue)
 			};
-			results.push(prediction$1);
+			results.push(prediction);
 		});
 		return results;
 	};
@@ -1517,7 +1514,7 @@ const predictionFactory = ({ timeline, constituents: constituents$1, start }) =>
 		const baseSpeed = {};
 		const u = [];
 		const f = [];
-		constituents$1.forEach((constituent) => {
+		constituents.forEach((constituent) => {
 			const model = constituents_default[constituent.name];
 			if (!model) return;
 			const value = model.value(baseAstro);
@@ -1529,7 +1526,7 @@ const predictionFactory = ({ timeline, constituents: constituents$1, start }) =>
 			const uItem = {};
 			const fItem = {};
 			const itemAstro = astronomy_default(time);
-			constituents$1.forEach((constituent) => {
+			constituents.forEach((constituent) => {
 				const model = constituents_default[constituent.name];
 				if (!model) return;
 				const constituentU = modulus(model.u(itemAstro), 360);
@@ -1575,15 +1572,15 @@ const getTimeline = (start, end, seconds = 600) => {
 };
 const harmonicsFactory = ({ harmonicConstituents, offset }) => {
 	if (!Array.isArray(harmonicConstituents)) throw new Error("Harmonic constituents are not an array");
-	const constituents$1 = [];
+	const constituents = [];
 	harmonicConstituents.forEach((constituent) => {
 		if (typeof constituent.name === "undefined") throw new Error("Harmonic constituents must have a name property");
-		if (constituents_default[constituent.name] !== void 0) constituents$1.push({
+		if (constituents_default[constituent.name] !== void 0) constituents.push({
 			...constituent,
 			phase: d2r * constituent.phase
 		});
 	});
-	if (offset !== false) constituents$1.push({
+	if (offset !== false) constituents.push({
 		name: "Z0",
 		phase: 0,
 		amplitude: offset
@@ -1600,7 +1597,7 @@ const harmonicsFactory = ({ harmonicConstituents, offset }) => {
 	harmonics.prediction = (options) => {
 		return prediction_default({
 			timeline: getTimeline(start, end, (typeof options !== "undefined" ? options : { timeFidelity: 600 }).timeFidelity),
-			constituents: constituents$1,
+			constituents,
 			start
 		});
 	};
@@ -1610,9 +1607,9 @@ var harmonics_default = harmonicsFactory;
 
 //#endregion
 //#region src/index.ts
-const tidePredictionFactory = (constituents$1, options = {}) => {
+const tidePredictionFactory = (constituents, options = {}) => {
 	const harmonicsOptions = {
-		harmonicConstituents: constituents$1,
+		harmonicConstituents: constituents,
 		offset: false,
 		...options
 	};