neaps 0.6.1 → 0.7.0

package/dist/index.cjs

@@ -2,8 +2,6 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 let _neaps_tide_database = require("@neaps/tide-database");
 let _neaps_tide_predictor = require("@neaps/tide-predictor");
 //#region src/index.ts
-const feetPerMeter = 3.2808399;
-const defaultUnits = "meters";
 /**
 * Get extremes prediction using the nearest station to the given position.
 *
@@ -40,14 +38,14 @@ function getWaterLevelAtTime(options) {
 function nearestStation(options) {
 	const data = (0, _neaps_tide_database.nearest)(options);
 	if (!data) throw new Error(`No stations found with options: ${JSON.stringify(options)}`);
-	return useStation(...data);
+	return (0, _neaps_tide_predictor.useStation)(...data);
 }
 /**
 * Find stations near the given position.
 * @param limit Maximum number of stations to return (default: 10)
 */
 function stationsNear(options) {
-	return (0, _neaps_tide_database.near)(options).map(([station, distance]) => useStation(station, distance));
+	return (0, _neaps_tide_database.near)(options).map(([station, distance]) => (0, _neaps_tide_predictor.useStation)(station, distance));
 }
 /**
 * Find a specific station by its ID or source ID.
@@ -60,88 +58,7 @@ function findStation(query) {
 		if (found) break;
 	}
 	if (!found) throw new Error(`Station not found: ${query}`);
-	return useStation(found);
-}
-function useStation(station, distance) {
-	let reference = station;
-	if (station.type === "subordinate" && station.offsets?.reference) reference = findStation(station.offsets?.reference);
-	const { datums, harmonic_constituents } = reference;
-	const defaultDatum = station.chart_datum in datums ? station.chart_datum : void 0;
-	function getPredictor({ datum = defaultDatum, nodeCorrections } = {}) {
-		let offset = 0;
-		if (datum) {
-			const datumOffset = datums?.[datum];
-			const mslOffset = datums?.["MSL"];
-			if (typeof datumOffset !== "number") throw new Error(`Station ${station.id} missing ${datum} datum. Available datums: ${Object.keys(datums).join(", ")}`);
-			if (typeof mslOffset !== "number") throw new Error(`Station ${station.id} missing MSL datum, so predictions can't be given in ${datum}.`);
-			offset = mslOffset - datumOffset;
-		}
-		return (0, _neaps_tide_predictor.createTidePredictor)(harmonic_constituents, {
-			offset,
-			nodeCorrections
-		});
-	}
-	return {
-		...station,
-		distance,
-		datums,
-		harmonic_constituents,
-		defaultDatum,
-		getExtremesPrediction({ datum = defaultDatum, units = defaultUnits, nodeCorrections, ...options }) {
-			return {
-				datum,
-				units,
-				station,
-				distance,
-				extremes: getPredictor({
-					datum,
-					nodeCorrections
-				}).getExtremesPrediction({
-					...options,
-					offsets: station.offsets
-				}).map((e) => toPreferredUnits(e, units))
-			};
-		},
-		getTimelinePrediction({ datum = defaultDatum, units = defaultUnits, nodeCorrections, ...options }) {
-			return {
-				datum,
-				units,
-				station,
-				distance,
-				timeline: getPredictor({
-					datum,
-					nodeCorrections
-				}).getTimelinePrediction({
-					...options,
-					offsets: station.offsets
-				}).map((e) => toPreferredUnits(e, units))
-			};
-		},
-		getWaterLevelAtTime({ time, datum = defaultDatum, units = defaultUnits, nodeCorrections }) {
-			return {
-				datum,
-				units,
-				station,
-				distance,
-				...toPreferredUnits(getPredictor({
-					datum,
-					nodeCorrections
-				}).getWaterLevelAtTime({
-					time,
-					offsets: station.offsets
-				}), units)
-			};
-		}
-	};
-}
-function toPreferredUnits(prediction, units) {
-	let { level } = prediction;
-	if (units === "feet") level *= feetPerMeter;
-	else if (units !== "meters") throw new Error(`Unsupported units: ${units}`);
-	return {
-		...prediction,
-		level
-	};
+	return (0, _neaps_tide_predictor.useStation)(found);
 }
 //#endregion
 exports.findStation = findStation;
@@ -150,6 +67,5 @@ exports.getTimelinePrediction = getTimelinePrediction;
 exports.getWaterLevelAtTime = getWaterLevelAtTime;
 exports.nearestStation = nearestStation;
 exports.stationsNear = stationsNear;
-exports.useStation = useStation;
 
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["stations"],"sources":["../src/index.ts"],"sourcesContent":["import {\n  stations,\n  near,\n  nearest,\n  type Station,\n  type NearOptions,\n  type NearestOptions,\n} from \"@neaps/tide-database\";\nimport { createTidePredictor, type ExtremesInput, type TimelineInput } from \"@neaps/tide-predictor\";\n\ntype Units = \"meters\" | \"feet\";\ntype PredictionOptions = {\n  /** Datum to return predictions in. Defaults to the nearest station's datum. */\n  datum?: string;\n\n  /** Units for returned water levels. Defaults to 'meters'. */\n  units?: Units;\n\n  /** Nodal correction fundamentals. Defaults to 'iho'. */\n  nodeCorrections?: \"iho\" | \"schureman\";\n};\n\nexport type ExtremesOptions = ExtremesInput & PredictionOptions;\nexport type TimelineOptions = TimelineInput & PredictionOptions;\nexport type WaterLevelOptions = { time: Date } & PredictionOptions;\n\nconst feetPerMeter = 3.2808399;\nconst defaultUnits: Units = \"meters\";\n\n/**\n * Get extremes prediction using the nearest station to the given position.\n *\n * @example\n * ```ts\n * import { getExtremesPrediction } from 'neaps'\n *\n * const prediction = getExtremesPrediction({\n *   latitude: 26.7, // or `lat`\n *   longitude: -80.05, // or `lng` or `lon`\n *   start: new Date('2025-12-17'),\n *   end: new Date('2025-12-18'),\n *   datum: 'MLLW', // optional, defaults to station's datum\n * })\n */\nexport function getExtremesPrediction(options: NearestOptions & ExtremesOptions) {\n  return nearestStation(options).getExtremesPrediction(options);\n}\n\n/**\n * Get timeline prediction using the nearest station to the given position.\n */\nexport function getTimelinePrediction(options: NearestOptions & TimelineOptions) {\n  return nearestStation(options).getTimelinePrediction(options);\n}\n\n/**\n * Get water level at a specific time using the nearest station to the given position.\n */\nexport function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions) {\n  return nearestStation(options).getWaterLevelAtTime(options);\n}\n\n/**\n * Find the nearest station to the given position.\n */\nexport function nearestStation(options: NearestOptions) {\n  const data = nearest(options);\n  if (!data) throw new Error(`No stations found with options: ${JSON.stringify(options)}`);\n  return useStation(...data);\n}\n\n/**\n * Find stations near the given position.\n * @param limit Maximum number of stations to return (default: 10)\n */\nexport function stationsNear(options: NearOptions) {\n  return near(options).map(([station, distance]) => useStation(station, distance));\n}\n\n/**\n * Find a specific station by its ID or source ID.\n */\nexport function findStation(query: string) {\n  const searches = [(s: Station) => s.id === query, (s: Station) => s.source.id === query];\n\n  let found: Station | undefined = undefined;\n\n  for (const search of searches) {\n    found = stations.find(search);\n    if (found) break;\n  }\n\n  if (!found) throw new Error(`Station not found: ${query}`);\n\n  return useStation(found);\n}\n\nexport function useStation(station: Station, distance?: number) {\n  // If subordinate station, use the reference station for datums and constituents\n  let reference = station;\n  if (station.type === \"subordinate\" && station.offsets?.reference) {\n    reference = findStation(station.offsets?.reference);\n  }\n  const { datums, harmonic_constituents } = reference;\n\n  // Use station chart datum as the default datum if available\n  const defaultDatum = station.chart_datum in datums ? station.chart_datum : undefined;\n\n  function getPredictor({ datum = defaultDatum, nodeCorrections }: PredictionOptions = {}) {\n    let offset = 0;\n\n    if (datum) {\n      const datumOffset = datums?.[datum];\n      const mslOffset = datums?.[\"MSL\"];\n\n      if (typeof datumOffset !== \"number\") {\n        throw new Error(\n          `Station ${station.id} missing ${datum} datum. Available datums: ${Object.keys(datums).join(\", \")}`,\n        );\n      }\n\n      if (typeof mslOffset !== \"number\") {\n        throw new Error(\n          `Station ${station.id} missing MSL datum, so predictions can't be given in ${datum}.`,\n        );\n      }\n\n      offset = mslOffset - datumOffset;\n    }\n\n    return createTidePredictor(harmonic_constituents, { offset, nodeCorrections });\n  }\n\n  return {\n    ...station,\n    distance,\n    datums,\n    harmonic_constituents,\n    defaultDatum,\n    getExtremesPrediction({\n      datum = defaultDatum,\n      units = defaultUnits,\n      nodeCorrections,\n      ...options\n    }: ExtremesOptions) {\n      const extremes = getPredictor({ datum, nodeCorrections })\n        .getExtremesPrediction({ ...options, offsets: station.offsets })\n        .map((e) => toPreferredUnits(e, units));\n\n      return { datum, units, station, distance, extremes };\n    },\n\n    getTimelinePrediction({\n      datum = defaultDatum,\n      units = defaultUnits,\n      nodeCorrections,\n      ...options\n    }: TimelineOptions) {\n      const timeline = getPredictor({ datum, nodeCorrections })\n        .getTimelinePrediction({ ...options, offsets: station.offsets })\n        .map((e) => toPreferredUnits(e, units));\n\n      return { datum, units, station, distance, timeline };\n    },\n\n    getWaterLevelAtTime({\n      time,\n      datum = defaultDatum,\n      units = defaultUnits,\n      nodeCorrections,\n    }: WaterLevelOptions) {\n      const prediction = toPreferredUnits(\n        getPredictor({ datum, nodeCorrections }).getWaterLevelAtTime({\n          time,\n          offsets: station.offsets,\n        }),\n        units,\n      );\n\n      return { datum, units, station, distance, ...prediction };\n    },\n  };\n}\n\nfunction toPreferredUnits<T extends { level: number }>(prediction: T, units: Units): T {\n  let { level } = prediction;\n  if (units === \"feet\") level *= feetPerMeter;\n  else if (units !== \"meters\") throw new Error(`Unsupported units: ${units}`);\n  return { ...prediction, level };\n}\n"],"mappings":";;;;AA0BA,MAAM,eAAe;AACrB,MAAM,eAAsB;;;;;;;;;;;;;;;;AAiB5B,SAAgB,sBAAsB,SAA2C;AAC/E,QAAO,eAAe,QAAQ,CAAC,sBAAsB,QAAQ;;;;;AAM/D,SAAgB,sBAAsB,SAA2C;AAC/E,QAAO,eAAe,QAAQ,CAAC,sBAAsB,QAAQ;;;;;AAM/D,SAAgB,oBAAoB,SAA6C;AAC/E,QAAO,eAAe,QAAQ,CAAC,oBAAoB,QAAQ;;;;;AAM7D,SAAgB,eAAe,SAAyB;CACtD,MAAM,QAAA,GAAA,qBAAA,SAAe,QAAQ;AAC7B,KAAI,CAAC,KAAM,OAAM,IAAI,MAAM,mCAAmC,KAAK,UAAU,QAAQ,GAAG;AACxF,QAAO,WAAW,GAAG,KAAK;;;;;;AAO5B,SAAgB,aAAa,SAAsB;AACjD,SAAA,GAAA,qBAAA,MAAY,QAAQ,CAAC,KAAK,CAAC,SAAS,cAAc,WAAW,SAAS,SAAS,CAAC;;;;;AAMlF,SAAgB,YAAY,OAAe;CACzC,MAAM,WAAW,EAAE,MAAe,EAAE,OAAO,QAAQ,MAAe,EAAE,OAAO,OAAO,MAAM;CAExF,IAAI,QAA6B,KAAA;AAEjC,MAAK,MAAM,UAAU,UAAU;AAC7B,UAAQA,qBAAAA,SAAS,KAAK,OAAO;AAC7B,MAAI,MAAO;;AAGb,KAAI,CAAC,MAAO,OAAM,IAAI,MAAM,sBAAsB,QAAQ;AAE1D,QAAO,WAAW,MAAM;;AAG1B,SAAgB,WAAW,SAAkB,UAAmB;CAE9D,IAAI,YAAY;AAChB,KAAI,QAAQ,SAAS,iBAAiB,QAAQ,SAAS,UACrD,aAAY,YAAY,QAAQ,SAAS,UAAU;CAErD,MAAM,EAAE,QAAQ,0BAA0B;CAG1C,MAAM,eAAe,QAAQ,eAAe,SAAS,QAAQ,cAAc,KAAA;CAE3E,SAAS,aAAa,EAAE,QAAQ,cAAc,oBAAuC,EAAE,EAAE;EACvF,IAAI,SAAS;AAEb,MAAI,OAAO;GACT,MAAM,cAAc,SAAS;GAC7B,MAAM,YAAY,SAAS;AAE3B,OAAI,OAAO,gBAAgB,SACzB,OAAM,IAAI,MACR,WAAW,QAAQ,GAAG,WAAW,MAAM,4BAA4B,OAAO,KAAK,OAAO,CAAC,KAAK,KAAK,GAClG;AAGH,OAAI,OAAO,cAAc,SACvB,OAAM,IAAI,MACR,WAAW,QAAQ,GAAG,uDAAuD,MAAM,GACpF;AAGH,YAAS,YAAY;;AAGvB,UAAA,GAAA,sBAAA,qBAA2B,uBAAuB;GAAE;GAAQ;GAAiB,CAAC;;AAGhF,QAAO;EACL,GAAG;EACH;EACA;EACA;EACA;EACA,sBAAsB,EACpB,QAAQ,cACR,QAAQ,cACR,iBACA,GAAG,WACe;AAKlB,UAAO;IAAE;IAAO;IAAO;IAAS;IAAU,UAJzB,aAAa;KAAE;KAAO;KAAiB,CAAC,CACtD,sBAAsB;KAAE,GAAG;KAAS,SAAS,QAAQ;KAAS,CAAC,CAC/D,KAAK,MAAM,iBAAiB,GAAG,MAAM,CAEU;IAAE;;EAGtD,sBAAsB,EACpB,QAAQ,cACR,QAAQ,cACR,iBACA,GAAG,WACe;AAKlB,UAAO;IAAE;IAAO;IAAO;IAAS;IAAU,UAJzB,aAAa;KAAE;KAAO;KAAiB,CAAC,CACtD,sBAAsB;KAAE,GAAG;KAAS,SAAS,QAAQ;KAAS,CAAC,CAC/D,KAAK,MAAM,iBAAiB,GAAG,MAAM,CAEU;IAAE;;EAGtD,oBAAoB,EAClB,MACA,QAAQ,cACR,QAAQ,cACR,mBACoB;AASpB,UAAO;IAAE;IAAO;IAAO;IAAS;IAAU,GARvB,iBACjB,aAAa;KAAE;KAAO;KAAiB,CAAC,CAAC,oBAAoB;KAC3D;KACA,SAAS,QAAQ;KAClB,CAAC,EACF,MAGqD;IAAE;;EAE5D;;AAGH,SAAS,iBAA8C,YAAe,OAAiB;CACrF,IAAI,EAAE,UAAU;AAChB,KAAI,UAAU,OAAQ,UAAS;UACtB,UAAU,SAAU,OAAM,IAAI,MAAM,sBAAsB,QAAQ;AAC3E,QAAO;EAAE,GAAG;EAAY;EAAO"}
+{"version":3,"file":"index.cjs","names":["stations"],"sources":["../src/index.ts"],"sourcesContent":["import {\n  stations,\n  near,\n  nearest,\n  type NearOptions,\n  type NearestOptions,\n} from \"@neaps/tide-database\";\nimport {\n  useStation,\n  type Station,\n  type StationPredictor,\n  type StationExtremesOptions,\n  type StationTimelineOptions,\n  type StationWaterLevelOptions,\n} from \"@neaps/tide-predictor\";\n\n/**\n * Get extremes prediction using the nearest station to the given position.\n *\n * @example\n * ```ts\n * import { getExtremesPrediction } from 'neaps'\n *\n * const prediction = getExtremesPrediction({\n *   latitude: 26.7, // or `lat`\n *   longitude: -80.05, // or `lng` or `lon`\n *   start: new Date('2025-12-17'),\n *   end: new Date('2025-12-18'),\n *   datum: 'MLLW', // optional, defaults to station's datum\n * })\n */\nexport function getExtremesPrediction(options: NearestOptions & StationExtremesOptions) {\n  return nearestStation(options).getExtremesPrediction(options);\n}\n\n/**\n * Get timeline prediction using the nearest station to the given position.\n */\nexport function getTimelinePrediction(options: NearestOptions & StationTimelineOptions) {\n  return nearestStation(options).getTimelinePrediction(options);\n}\n\n/**\n * Get water level at a specific time using the nearest station to the given position.\n */\nexport function getWaterLevelAtTime(options: NearestOptions & StationWaterLevelOptions) {\n  return nearestStation(options).getWaterLevelAtTime(options);\n}\n\n/**\n * Find the nearest station to the given position.\n */\nexport function nearestStation(options: NearestOptions) {\n  const data = nearest(options);\n  if (!data) throw new Error(`No stations found with options: ${JSON.stringify(options)}`);\n  return useStation(...data);\n}\n\n/**\n * Find stations near the given position.\n * @param limit Maximum number of stations to return (default: 10)\n */\nexport function stationsNear(options: NearOptions) {\n  return near(options).map(([station, distance]) => useStation(station, distance));\n}\n\n/**\n * Find a specific station by its ID or source ID.\n */\nexport function findStation(query: string): StationPredictor {\n  const searches = [(s: Station) => s.id === query, (s: Station) => s.source.id === query];\n\n  let found: Station | undefined = undefined;\n\n  for (const search of searches) {\n    found = stations.find(search);\n    if (found) break;\n  }\n\n  if (!found) throw new Error(`Station not found: ${query}`);\n  return useStation(found);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AA+BA,SAAgB,sBAAsB,SAAkD;CACtF,OAAO,eAAe,OAAO,CAAC,CAAC,sBAAsB,OAAO;AAC9D;;;;AAKA,SAAgB,sBAAsB,SAAkD;CACtF,OAAO,eAAe,OAAO,CAAC,CAAC,sBAAsB,OAAO;AAC9D;;;;AAKA,SAAgB,oBAAoB,SAAoD;CACtF,OAAO,eAAe,OAAO,CAAC,CAAC,oBAAoB,OAAO;AAC5D;;;;AAKA,SAAgB,eAAe,SAAyB;CACtD,MAAM,QAAA,GAAA,qBAAA,QAAA,CAAe,OAAO;CAC5B,IAAI,CAAC,MAAM,MAAM,IAAI,MAAM,mCAAmC,KAAK,UAAU,OAAO,GAAG;CACvF,QAAA,GAAA,sBAAA,WAAA,CAAkB,GAAG,IAAI;AAC3B;;;;;AAMA,SAAgB,aAAa,SAAsB;CACjD,QAAA,GAAA,qBAAA,KAAA,CAAY,OAAO,CAAC,CAAC,KAAK,CAAC,SAAS,eAAA,GAAA,sBAAA,WAAA,CAAyB,SAAS,QAAQ,CAAC;AACjF;;;;AAKA,SAAgB,YAAY,OAAiC;CAC3D,MAAM,WAAW,EAAE,MAAe,EAAE,OAAO,QAAQ,MAAe,EAAE,OAAO,OAAO,KAAK;CAEvF,IAAI,QAA6B,KAAA;CAEjC,KAAK,MAAM,UAAU,UAAU;EAC7B,QAAQA,qBAAAA,SAAS,KAAK,MAAM;EAC5B,IAAI,OAAO;CACb;CAEA,IAAI,CAAC,OAAO,MAAM,IAAI,MAAM,sBAAsB,OAAO;CACzD,QAAA,GAAA,sBAAA,WAAA,CAAkB,KAAK;AACzB"}

package/dist/index.d.cts

@@ -1,20 +1,7 @@
-import * as _$_neaps_tide_predictor0 from "@neaps/tide-predictor";
-import { ExtremesInput, TimelineInput } from "@neaps/tide-predictor";
-import * as _$_neaps_tide_database0 from "@neaps/tide-database";
-import { NearOptions, NearestOptions, Station } from "@neaps/tide-database";
+import { NearOptions, NearestOptions } from "@neaps/tide-database";
+import { StationExtremesOptions, StationPredictor, StationTimelineOptions, StationWaterLevelOptions } from "@neaps/tide-predictor";
 
 //#region src/index.d.ts
-type Units = "meters" | "feet";
-type PredictionOptions = {
-  /** Datum to return predictions in. Defaults to the nearest station's datum. */datum?: string; /** Units for returned water levels. Defaults to 'meters'. */
-  units?: Units; /** Nodal correction fundamentals. Defaults to 'iho'. */
-  nodeCorrections?: "iho" | "schureman";
-};
-type ExtremesOptions = ExtremesInput & PredictionOptions;
-type TimelineOptions = TimelineInput & PredictionOptions;
-type WaterLevelOptions = {
-  time: Date;
-} & PredictionOptions;
 /**
  * Get extremes prediction using the nearest station to the given position.
  *
@@ -30,377 +17,28 @@ type WaterLevelOptions = {
  *   datum: 'MLLW', // optional, defaults to station's datum
  * })
  */
-declare function getExtremesPrediction(options: NearestOptions & ExtremesOptions): {
-  datum: string | undefined;
-  units: Units;
-  station: Station;
-  distance: number | undefined;
-  extremes: _$_neaps_tide_predictor0.Extreme[];
-};
+declare function getExtremesPrediction(options: NearestOptions & StationExtremesOptions): import("@neaps/tide-predictor").StationExtremesPrediction;
 /**
  * Get timeline prediction using the nearest station to the given position.
  */
-declare function getTimelinePrediction(options: NearestOptions & TimelineOptions): {
-  datum: string | undefined;
-  units: Units;
-  station: Station;
-  distance: number | undefined;
-  timeline: _$_neaps_tide_predictor0.TimelinePoint[];
-};
+declare function getTimelinePrediction(options: NearestOptions & StationTimelineOptions): import("@neaps/tide-predictor").StationTimelinePrediction;
 /**
  * Get water level at a specific time using the nearest station to the given position.
  */
-declare function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions): {
-  time: Date;
-  hour: number;
-  level: number;
-  datum: string | undefined;
-  units: Units;
-  station: Station;
-  distance: number | undefined;
-};
+declare function getWaterLevelAtTime(options: NearestOptions & StationWaterLevelOptions): import("@neaps/tide-predictor").StationWaterLevelPrediction;
 /**
  * Find the nearest station to the given position.
  */
-declare function nearestStation(options: NearestOptions): {
-  distance: number | undefined;
-  datums: Record<string, number>;
-  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
-  defaultDatum: string | undefined;
-  getExtremesPrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: ExtremesOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    extremes: _$_neaps_tide_predictor0.Extreme[];
-  };
-  getTimelinePrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: TimelineOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
-  };
-  getWaterLevelAtTime({
-    time,
-    datum,
-    units,
-    nodeCorrections
-  }: WaterLevelOptions): {
-    time: Date;
-    hour: number;
-    level: number;
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-  };
-  id: string;
-  name: string;
-  continent: string;
-  country: string;
-  region?: string;
-  timezone: string;
-  disclaimers: string;
-  type: "reference" | "subordinate";
-  latitude: number;
-  longitude: number;
-  source: {
-    name: string;
-    id: string;
-    published_harmonics: boolean;
-    url: string;
-  };
-  license: {
-    type: string;
-    commercial_use: boolean;
-    url: string;
-    notes?: string;
-  };
-  offsets?: {
-    reference: string;
-    height: {
-      high: number;
-      low: number;
-      type: "ratio" | "fixed";
-    };
-    time: {
-      high: number;
-      low: number;
-    };
-  };
-  chart_datum: string;
-  epoch?: {
-    start: string;
-    end: string;
-  };
-};
+declare function nearestStation(options: NearestOptions): StationPredictor;
 /**
  * Find stations near the given position.
  * @param limit Maximum number of stations to return (default: 10)
  */
-declare function stationsNear(options: NearOptions): {
-  distance: number | undefined;
-  datums: Record<string, number>;
-  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
-  defaultDatum: string | undefined;
-  getExtremesPrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: ExtremesOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    extremes: _$_neaps_tide_predictor0.Extreme[];
-  };
-  getTimelinePrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: TimelineOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
-  };
-  getWaterLevelAtTime({
-    time,
-    datum,
-    units,
-    nodeCorrections
-  }: WaterLevelOptions): {
-    time: Date;
-    hour: number;
-    level: number;
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-  };
-  id: string;
-  name: string;
-  continent: string;
-  country: string;
-  region?: string;
-  timezone: string;
-  disclaimers: string;
-  type: "reference" | "subordinate";
-  latitude: number;
-  longitude: number;
-  source: {
-    name: string;
-    id: string;
-    published_harmonics: boolean;
-    url: string;
-  };
-  license: {
-    type: string;
-    commercial_use: boolean;
-    url: string;
-    notes?: string;
-  };
-  offsets?: {
-    reference: string;
-    height: {
-      high: number;
-      low: number;
-      type: "ratio" | "fixed";
-    };
-    time: {
-      high: number;
-      low: number;
-    };
-  };
-  chart_datum: string;
-  epoch?: {
-    start: string;
-    end: string;
-  };
-}[];
+declare function stationsNear(options: NearOptions): StationPredictor[];
 /**
  * Find a specific station by its ID or source ID.
  */
-declare function findStation(query: string): {
-  distance: number | undefined;
-  datums: Record<string, number>;
-  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
-  defaultDatum: string | undefined;
-  getExtremesPrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: ExtremesOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    extremes: _$_neaps_tide_predictor0.Extreme[];
-  };
-  getTimelinePrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: TimelineOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
-  };
-  getWaterLevelAtTime({
-    time,
-    datum,
-    units,
-    nodeCorrections
-  }: WaterLevelOptions): {
-    time: Date;
-    hour: number;
-    level: number;
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-  };
-  id: string;
-  name: string;
-  continent: string;
-  country: string;
-  region?: string;
-  timezone: string;
-  disclaimers: string;
-  type: "reference" | "subordinate";
-  latitude: number;
-  longitude: number;
-  source: {
-    name: string;
-    id: string;
-    published_harmonics: boolean;
-    url: string;
-  };
-  license: {
-    type: string;
-    commercial_use: boolean;
-    url: string;
-    notes?: string;
-  };
-  offsets?: {
-    reference: string;
-    height: {
-      high: number;
-      low: number;
-      type: "ratio" | "fixed";
-    };
-    time: {
-      high: number;
-      low: number;
-    };
-  };
-  chart_datum: string;
-  epoch?: {
-    start: string;
-    end: string;
-  };
-};
-declare function useStation(station: Station, distance?: number): {
-  distance: number | undefined;
-  datums: Record<string, number>;
-  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
-  defaultDatum: string | undefined;
-  getExtremesPrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: ExtremesOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    extremes: _$_neaps_tide_predictor0.Extreme[];
-  };
-  getTimelinePrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: TimelineOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
-  };
-  getWaterLevelAtTime({
-    time,
-    datum,
-    units,
-    nodeCorrections
-  }: WaterLevelOptions): {
-    time: Date;
-    hour: number;
-    level: number;
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-  };
-  id: string;
-  name: string;
-  continent: string;
-  country: string;
-  region?: string;
-  timezone: string;
-  disclaimers: string;
-  type: "reference" | "subordinate";
-  latitude: number;
-  longitude: number;
-  source: {
-    name: string;
-    id: string;
-    published_harmonics: boolean;
-    url: string;
-  };
-  license: {
-    type: string;
-    commercial_use: boolean;
-    url: string;
-    notes?: string;
-  };
-  offsets?: {
-    reference: string;
-    height: {
-      high: number;
-      low: number;
-      type: "ratio" | "fixed";
-    };
-    time: {
-      high: number;
-      low: number;
-    };
-  };
-  chart_datum: string;
-  epoch?: {
-    start: string;
-    end: string;
-  };
-};
+declare function findStation(query: string): StationPredictor;
 //#endregion
-export { ExtremesOptions, TimelineOptions, WaterLevelOptions, findStation, getExtremesPrediction, getTimelinePrediction, getWaterLevelAtTime, nearestStation, stationsNear, useStation };
+export { findStation, getExtremesPrediction, getTimelinePrediction, getWaterLevelAtTime, nearestStation, stationsNear };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,20 +1,7 @@
-import * as _$_neaps_tide_database0 from "@neaps/tide-database";
-import { NearOptions, NearestOptions, Station } from "@neaps/tide-database";
-import * as _$_neaps_tide_predictor0 from "@neaps/tide-predictor";
-import { ExtremesInput, TimelineInput } from "@neaps/tide-predictor";
+import { NearOptions, NearestOptions } from "@neaps/tide-database";
+import { StationExtremesOptions, StationPredictor, StationTimelineOptions, StationWaterLevelOptions } from "@neaps/tide-predictor";
 
 //#region src/index.d.ts
-type Units = "meters" | "feet";
-type PredictionOptions = {
-  /** Datum to return predictions in. Defaults to the nearest station's datum. */datum?: string; /** Units for returned water levels. Defaults to 'meters'. */
-  units?: Units; /** Nodal correction fundamentals. Defaults to 'iho'. */
-  nodeCorrections?: "iho" | "schureman";
-};
-type ExtremesOptions = ExtremesInput & PredictionOptions;
-type TimelineOptions = TimelineInput & PredictionOptions;
-type WaterLevelOptions = {
-  time: Date;
-} & PredictionOptions;
 /**
  * Get extremes prediction using the nearest station to the given position.
  *
@@ -30,377 +17,28 @@ type WaterLevelOptions = {
  *   datum: 'MLLW', // optional, defaults to station's datum
  * })
  */
-declare function getExtremesPrediction(options: NearestOptions & ExtremesOptions): {
-  datum: string | undefined;
-  units: Units;
-  station: Station;
-  distance: number | undefined;
-  extremes: _$_neaps_tide_predictor0.Extreme[];
-};
+declare function getExtremesPrediction(options: NearestOptions & StationExtremesOptions): import("@neaps/tide-predictor").StationExtremesPrediction;
 /**
  * Get timeline prediction using the nearest station to the given position.
  */
-declare function getTimelinePrediction(options: NearestOptions & TimelineOptions): {
-  datum: string | undefined;
-  units: Units;
-  station: Station;
-  distance: number | undefined;
-  timeline: _$_neaps_tide_predictor0.TimelinePoint[];
-};
+declare function getTimelinePrediction(options: NearestOptions & StationTimelineOptions): import("@neaps/tide-predictor").StationTimelinePrediction;
 /**
  * Get water level at a specific time using the nearest station to the given position.
  */
-declare function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions): {
-  time: Date;
-  hour: number;
-  level: number;
-  datum: string | undefined;
-  units: Units;
-  station: Station;
-  distance: number | undefined;
-};
+declare function getWaterLevelAtTime(options: NearestOptions & StationWaterLevelOptions): import("@neaps/tide-predictor").StationWaterLevelPrediction;
 /**
  * Find the nearest station to the given position.
  */
-declare function nearestStation(options: NearestOptions): {
-  distance: number | undefined;
-  datums: Record<string, number>;
-  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
-  defaultDatum: string | undefined;
-  getExtremesPrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: ExtremesOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    extremes: _$_neaps_tide_predictor0.Extreme[];
-  };
-  getTimelinePrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: TimelineOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
-  };
-  getWaterLevelAtTime({
-    time,
-    datum,
-    units,
-    nodeCorrections
-  }: WaterLevelOptions): {
-    time: Date;
-    hour: number;
-    level: number;
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-  };
-  id: string;
-  name: string;
-  continent: string;
-  country: string;
-  region?: string;
-  timezone: string;
-  disclaimers: string;
-  type: "reference" | "subordinate";
-  latitude: number;
-  longitude: number;
-  source: {
-    name: string;
-    id: string;
-    published_harmonics: boolean;
-    url: string;
-  };
-  license: {
-    type: string;
-    commercial_use: boolean;
-    url: string;
-    notes?: string;
-  };
-  offsets?: {
-    reference: string;
-    height: {
-      high: number;
-      low: number;
-      type: "ratio" | "fixed";
-    };
-    time: {
-      high: number;
-      low: number;
-    };
-  };
-  chart_datum: string;
-  epoch?: {
-    start: string;
-    end: string;
-  };
-};
+declare function nearestStation(options: NearestOptions): StationPredictor;
 /**
  * Find stations near the given position.
  * @param limit Maximum number of stations to return (default: 10)
  */
-declare function stationsNear(options: NearOptions): {
-  distance: number | undefined;
-  datums: Record<string, number>;
-  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
-  defaultDatum: string | undefined;
-  getExtremesPrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: ExtremesOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    extremes: _$_neaps_tide_predictor0.Extreme[];
-  };
-  getTimelinePrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: TimelineOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
-  };
-  getWaterLevelAtTime({
-    time,
-    datum,
-    units,
-    nodeCorrections
-  }: WaterLevelOptions): {
-    time: Date;
-    hour: number;
-    level: number;
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-  };
-  id: string;
-  name: string;
-  continent: string;
-  country: string;
-  region?: string;
-  timezone: string;
-  disclaimers: string;
-  type: "reference" | "subordinate";
-  latitude: number;
-  longitude: number;
-  source: {
-    name: string;
-    id: string;
-    published_harmonics: boolean;
-    url: string;
-  };
-  license: {
-    type: string;
-    commercial_use: boolean;
-    url: string;
-    notes?: string;
-  };
-  offsets?: {
-    reference: string;
-    height: {
-      high: number;
-      low: number;
-      type: "ratio" | "fixed";
-    };
-    time: {
-      high: number;
-      low: number;
-    };
-  };
-  chart_datum: string;
-  epoch?: {
-    start: string;
-    end: string;
-  };
-}[];
+declare function stationsNear(options: NearOptions): StationPredictor[];
 /**
  * Find a specific station by its ID or source ID.
  */
-declare function findStation(query: string): {
-  distance: number | undefined;
-  datums: Record<string, number>;
-  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
-  defaultDatum: string | undefined;
-  getExtremesPrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: ExtremesOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    extremes: _$_neaps_tide_predictor0.Extreme[];
-  };
-  getTimelinePrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: TimelineOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
-  };
-  getWaterLevelAtTime({
-    time,
-    datum,
-    units,
-    nodeCorrections
-  }: WaterLevelOptions): {
-    time: Date;
-    hour: number;
-    level: number;
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-  };
-  id: string;
-  name: string;
-  continent: string;
-  country: string;
-  region?: string;
-  timezone: string;
-  disclaimers: string;
-  type: "reference" | "subordinate";
-  latitude: number;
-  longitude: number;
-  source: {
-    name: string;
-    id: string;
-    published_harmonics: boolean;
-    url: string;
-  };
-  license: {
-    type: string;
-    commercial_use: boolean;
-    url: string;
-    notes?: string;
-  };
-  offsets?: {
-    reference: string;
-    height: {
-      high: number;
-      low: number;
-      type: "ratio" | "fixed";
-    };
-    time: {
-      high: number;
-      low: number;
-    };
-  };
-  chart_datum: string;
-  epoch?: {
-    start: string;
-    end: string;
-  };
-};
-declare function useStation(station: Station, distance?: number): {
-  distance: number | undefined;
-  datums: Record<string, number>;
-  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
-  defaultDatum: string | undefined;
-  getExtremesPrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: ExtremesOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    extremes: _$_neaps_tide_predictor0.Extreme[];
-  };
-  getTimelinePrediction({
-    datum,
-    units,
-    nodeCorrections,
-    ...options
-  }: TimelineOptions): {
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
-  };
-  getWaterLevelAtTime({
-    time,
-    datum,
-    units,
-    nodeCorrections
-  }: WaterLevelOptions): {
-    time: Date;
-    hour: number;
-    level: number;
-    datum: string | undefined;
-    units: Units;
-    station: Station;
-    distance: number | undefined;
-  };
-  id: string;
-  name: string;
-  continent: string;
-  country: string;
-  region?: string;
-  timezone: string;
-  disclaimers: string;
-  type: "reference" | "subordinate";
-  latitude: number;
-  longitude: number;
-  source: {
-    name: string;
-    id: string;
-    published_harmonics: boolean;
-    url: string;
-  };
-  license: {
-    type: string;
-    commercial_use: boolean;
-    url: string;
-    notes?: string;
-  };
-  offsets?: {
-    reference: string;
-    height: {
-      high: number;
-      low: number;
-      type: "ratio" | "fixed";
-    };
-    time: {
-      high: number;
-      low: number;
-    };
-  };
-  chart_datum: string;
-  epoch?: {
-    start: string;
-    end: string;
-  };
-};
+declare function findStation(query: string): StationPredictor;
 //#endregion
-export { ExtremesOptions, TimelineOptions, WaterLevelOptions, findStation, getExtremesPrediction, getTimelinePrediction, getWaterLevelAtTime, nearestStation, stationsNear, useStation };
+export { findStation, getExtremesPrediction, getTimelinePrediction, getWaterLevelAtTime, nearestStation, stationsNear };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,8 +1,6 @@
 import { near, nearest, stations } from "@neaps/tide-database";
-import { createTidePredictor } from "@neaps/tide-predictor";
+import { useStation } from "@neaps/tide-predictor";
 //#region src/index.ts
-const feetPerMeter = 3.2808399;
-const defaultUnits = "meters";
 /**
 * Get extremes prediction using the nearest station to the given position.
 *
@@ -61,88 +59,7 @@ function findStation(query) {
 	if (!found) throw new Error(`Station not found: ${query}`);
 	return useStation(found);
 }
-function useStation(station, distance) {
-	let reference = station;
-	if (station.type === "subordinate" && station.offsets?.reference) reference = findStation(station.offsets?.reference);
-	const { datums, harmonic_constituents } = reference;
-	const defaultDatum = station.chart_datum in datums ? station.chart_datum : void 0;
-	function getPredictor({ datum = defaultDatum, nodeCorrections } = {}) {
-		let offset = 0;
-		if (datum) {
-			const datumOffset = datums?.[datum];
-			const mslOffset = datums?.["MSL"];
-			if (typeof datumOffset !== "number") throw new Error(`Station ${station.id} missing ${datum} datum. Available datums: ${Object.keys(datums).join(", ")}`);
-			if (typeof mslOffset !== "number") throw new Error(`Station ${station.id} missing MSL datum, so predictions can't be given in ${datum}.`);
-			offset = mslOffset - datumOffset;
-		}
-		return createTidePredictor(harmonic_constituents, {
-			offset,
-			nodeCorrections
-		});
-	}
-	return {
-		...station,
-		distance,
-		datums,
-		harmonic_constituents,
-		defaultDatum,
-		getExtremesPrediction({ datum = defaultDatum, units = defaultUnits, nodeCorrections, ...options }) {
-			return {
-				datum,
-				units,
-				station,
-				distance,
-				extremes: getPredictor({
-					datum,
-					nodeCorrections
-				}).getExtremesPrediction({
-					...options,
-					offsets: station.offsets
-				}).map((e) => toPreferredUnits(e, units))
-			};
-		},
-		getTimelinePrediction({ datum = defaultDatum, units = defaultUnits, nodeCorrections, ...options }) {
-			return {
-				datum,
-				units,
-				station,
-				distance,
-				timeline: getPredictor({
-					datum,
-					nodeCorrections
-				}).getTimelinePrediction({
-					...options,
-					offsets: station.offsets
-				}).map((e) => toPreferredUnits(e, units))
-			};
-		},
-		getWaterLevelAtTime({ time, datum = defaultDatum, units = defaultUnits, nodeCorrections }) {
-			return {
-				datum,
-				units,
-				station,
-				distance,
-				...toPreferredUnits(getPredictor({
-					datum,
-					nodeCorrections
-				}).getWaterLevelAtTime({
-					time,
-					offsets: station.offsets
-				}), units)
-			};
-		}
-	};
-}
-function toPreferredUnits(prediction, units) {
-	let { level } = prediction;
-	if (units === "feet") level *= feetPerMeter;
-	else if (units !== "meters") throw new Error(`Unsupported units: ${units}`);
-	return {
-		...prediction,
-		level
-	};
-}
 //#endregion
-export { findStation, getExtremesPrediction, getTimelinePrediction, getWaterLevelAtTime, nearestStation, stationsNear, useStation };
+export { findStation, getExtremesPrediction, getTimelinePrediction, getWaterLevelAtTime, nearestStation, stationsNear };
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import {\n  stations,\n  near,\n  nearest,\n  type Station,\n  type NearOptions,\n  type NearestOptions,\n} from \"@neaps/tide-database\";\nimport { createTidePredictor, type ExtremesInput, type TimelineInput } from \"@neaps/tide-predictor\";\n\ntype Units = \"meters\" | \"feet\";\ntype PredictionOptions = {\n  /** Datum to return predictions in. Defaults to the nearest station's datum. */\n  datum?: string;\n\n  /** Units for returned water levels. Defaults to 'meters'. */\n  units?: Units;\n\n  /** Nodal correction fundamentals. Defaults to 'iho'. */\n  nodeCorrections?: \"iho\" | \"schureman\";\n};\n\nexport type ExtremesOptions = ExtremesInput & PredictionOptions;\nexport type TimelineOptions = TimelineInput & PredictionOptions;\nexport type WaterLevelOptions = { time: Date } & PredictionOptions;\n\nconst feetPerMeter = 3.2808399;\nconst defaultUnits: Units = \"meters\";\n\n/**\n * Get extremes prediction using the nearest station to the given position.\n *\n * @example\n * ```ts\n * import { getExtremesPrediction } from 'neaps'\n *\n * const prediction = getExtremesPrediction({\n *   latitude: 26.7, // or `lat`\n *   longitude: -80.05, // or `lng` or `lon`\n *   start: new Date('2025-12-17'),\n *   end: new Date('2025-12-18'),\n *   datum: 'MLLW', // optional, defaults to station's datum\n * })\n */\nexport function getExtremesPrediction(options: NearestOptions & ExtremesOptions) {\n  return nearestStation(options).getExtremesPrediction(options);\n}\n\n/**\n * Get timeline prediction using the nearest station to the given position.\n */\nexport function getTimelinePrediction(options: NearestOptions & TimelineOptions) {\n  return nearestStation(options).getTimelinePrediction(options);\n}\n\n/**\n * Get water level at a specific time using the nearest station to the given position.\n */\nexport function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions) {\n  return nearestStation(options).getWaterLevelAtTime(options);\n}\n\n/**\n * Find the nearest station to the given position.\n */\nexport function nearestStation(options: NearestOptions) {\n  const data = nearest(options);\n  if (!data) throw new Error(`No stations found with options: ${JSON.stringify(options)}`);\n  return useStation(...data);\n}\n\n/**\n * Find stations near the given position.\n * @param limit Maximum number of stations to return (default: 10)\n */\nexport function stationsNear(options: NearOptions) {\n  return near(options).map(([station, distance]) => useStation(station, distance));\n}\n\n/**\n * Find a specific station by its ID or source ID.\n */\nexport function findStation(query: string) {\n  const searches = [(s: Station) => s.id === query, (s: Station) => s.source.id === query];\n\n  let found: Station | undefined = undefined;\n\n  for (const search of searches) {\n    found = stations.find(search);\n    if (found) break;\n  }\n\n  if (!found) throw new Error(`Station not found: ${query}`);\n\n  return useStation(found);\n}\n\nexport function useStation(station: Station, distance?: number) {\n  // If subordinate station, use the reference station for datums and constituents\n  let reference = station;\n  if (station.type === \"subordinate\" && station.offsets?.reference) {\n    reference = findStation(station.offsets?.reference);\n  }\n  const { datums, harmonic_constituents } = reference;\n\n  // Use station chart datum as the default datum if available\n  const defaultDatum = station.chart_datum in datums ? station.chart_datum : undefined;\n\n  function getPredictor({ datum = defaultDatum, nodeCorrections }: PredictionOptions = {}) {\n    let offset = 0;\n\n    if (datum) {\n      const datumOffset = datums?.[datum];\n      const mslOffset = datums?.[\"MSL\"];\n\n      if (typeof datumOffset !== \"number\") {\n        throw new Error(\n          `Station ${station.id} missing ${datum} datum. Available datums: ${Object.keys(datums).join(\", \")}`,\n        );\n      }\n\n      if (typeof mslOffset !== \"number\") {\n        throw new Error(\n          `Station ${station.id} missing MSL datum, so predictions can't be given in ${datum}.`,\n        );\n      }\n\n      offset = mslOffset - datumOffset;\n    }\n\n    return createTidePredictor(harmonic_constituents, { offset, nodeCorrections });\n  }\n\n  return {\n    ...station,\n    distance,\n    datums,\n    harmonic_constituents,\n    defaultDatum,\n    getExtremesPrediction({\n      datum = defaultDatum,\n      units = defaultUnits,\n      nodeCorrections,\n      ...options\n    }: ExtremesOptions) {\n      const extremes = getPredictor({ datum, nodeCorrections })\n        .getExtremesPrediction({ ...options, offsets: station.offsets })\n        .map((e) => toPreferredUnits(e, units));\n\n      return { datum, units, station, distance, extremes };\n    },\n\n    getTimelinePrediction({\n      datum = defaultDatum,\n      units = defaultUnits,\n      nodeCorrections,\n      ...options\n    }: TimelineOptions) {\n      const timeline = getPredictor({ datum, nodeCorrections })\n        .getTimelinePrediction({ ...options, offsets: station.offsets })\n        .map((e) => toPreferredUnits(e, units));\n\n      return { datum, units, station, distance, timeline };\n    },\n\n    getWaterLevelAtTime({\n      time,\n      datum = defaultDatum,\n      units = defaultUnits,\n      nodeCorrections,\n    }: WaterLevelOptions) {\n      const prediction = toPreferredUnits(\n        getPredictor({ datum, nodeCorrections }).getWaterLevelAtTime({\n          time,\n          offsets: station.offsets,\n        }),\n        units,\n      );\n\n      return { datum, units, station, distance, ...prediction };\n    },\n  };\n}\n\nfunction toPreferredUnits<T extends { level: number }>(prediction: T, units: Units): T {\n  let { level } = prediction;\n  if (units === \"feet\") level *= feetPerMeter;\n  else if (units !== \"meters\") throw new Error(`Unsupported units: ${units}`);\n  return { ...prediction, level };\n}\n"],"mappings":";;;AA0BA,MAAM,eAAe;AACrB,MAAM,eAAsB;;;;;;;;;;;;;;;;AAiB5B,SAAgB,sBAAsB,SAA2C;AAC/E,QAAO,eAAe,QAAQ,CAAC,sBAAsB,QAAQ;;;;;AAM/D,SAAgB,sBAAsB,SAA2C;AAC/E,QAAO,eAAe,QAAQ,CAAC,sBAAsB,QAAQ;;;;;AAM/D,SAAgB,oBAAoB,SAA6C;AAC/E,QAAO,eAAe,QAAQ,CAAC,oBAAoB,QAAQ;;;;;AAM7D,SAAgB,eAAe,SAAyB;CACtD,MAAM,OAAO,QAAQ,QAAQ;AAC7B,KAAI,CAAC,KAAM,OAAM,IAAI,MAAM,mCAAmC,KAAK,UAAU,QAAQ,GAAG;AACxF,QAAO,WAAW,GAAG,KAAK;;;;;;AAO5B,SAAgB,aAAa,SAAsB;AACjD,QAAO,KAAK,QAAQ,CAAC,KAAK,CAAC,SAAS,cAAc,WAAW,SAAS,SAAS,CAAC;;;;;AAMlF,SAAgB,YAAY,OAAe;CACzC,MAAM,WAAW,EAAE,MAAe,EAAE,OAAO,QAAQ,MAAe,EAAE,OAAO,OAAO,MAAM;CAExF,IAAI,QAA6B,KAAA;AAEjC,MAAK,MAAM,UAAU,UAAU;AAC7B,UAAQ,SAAS,KAAK,OAAO;AAC7B,MAAI,MAAO;;AAGb,KAAI,CAAC,MAAO,OAAM,IAAI,MAAM,sBAAsB,QAAQ;AAE1D,QAAO,WAAW,MAAM;;AAG1B,SAAgB,WAAW,SAAkB,UAAmB;CAE9D,IAAI,YAAY;AAChB,KAAI,QAAQ,SAAS,iBAAiB,QAAQ,SAAS,UACrD,aAAY,YAAY,QAAQ,SAAS,UAAU;CAErD,MAAM,EAAE,QAAQ,0BAA0B;CAG1C,MAAM,eAAe,QAAQ,eAAe,SAAS,QAAQ,cAAc,KAAA;CAE3E,SAAS,aAAa,EAAE,QAAQ,cAAc,oBAAuC,EAAE,EAAE;EACvF,IAAI,SAAS;AAEb,MAAI,OAAO;GACT,MAAM,cAAc,SAAS;GAC7B,MAAM,YAAY,SAAS;AAE3B,OAAI,OAAO,gBAAgB,SACzB,OAAM,IAAI,MACR,WAAW,QAAQ,GAAG,WAAW,MAAM,4BAA4B,OAAO,KAAK,OAAO,CAAC,KAAK,KAAK,GAClG;AAGH,OAAI,OAAO,cAAc,SACvB,OAAM,IAAI,MACR,WAAW,QAAQ,GAAG,uDAAuD,MAAM,GACpF;AAGH,YAAS,YAAY;;AAGvB,SAAO,oBAAoB,uBAAuB;GAAE;GAAQ;GAAiB,CAAC;;AAGhF,QAAO;EACL,GAAG;EACH;EACA;EACA;EACA;EACA,sBAAsB,EACpB,QAAQ,cACR,QAAQ,cACR,iBACA,GAAG,WACe;AAKlB,UAAO;IAAE;IAAO;IAAO;IAAS;IAAU,UAJzB,aAAa;KAAE;KAAO;KAAiB,CAAC,CACtD,sBAAsB;KAAE,GAAG;KAAS,SAAS,QAAQ;KAAS,CAAC,CAC/D,KAAK,MAAM,iBAAiB,GAAG,MAAM,CAEU;IAAE;;EAGtD,sBAAsB,EACpB,QAAQ,cACR,QAAQ,cACR,iBACA,GAAG,WACe;AAKlB,UAAO;IAAE;IAAO;IAAO;IAAS;IAAU,UAJzB,aAAa;KAAE;KAAO;KAAiB,CAAC,CACtD,sBAAsB;KAAE,GAAG;KAAS,SAAS,QAAQ;KAAS,CAAC,CAC/D,KAAK,MAAM,iBAAiB,GAAG,MAAM,CAEU;IAAE;;EAGtD,oBAAoB,EAClB,MACA,QAAQ,cACR,QAAQ,cACR,mBACoB;AASpB,UAAO;IAAE;IAAO;IAAO;IAAS;IAAU,GARvB,iBACjB,aAAa;KAAE;KAAO;KAAiB,CAAC,CAAC,oBAAoB;KAC3D;KACA,SAAS,QAAQ;KAClB,CAAC,EACF,MAGqD;IAAE;;EAE5D;;AAGH,SAAS,iBAA8C,YAAe,OAAiB;CACrF,IAAI,EAAE,UAAU;AAChB,KAAI,UAAU,OAAQ,UAAS;UACtB,UAAU,SAAU,OAAM,IAAI,MAAM,sBAAsB,QAAQ;AAC3E,QAAO;EAAE,GAAG;EAAY;EAAO"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import {\n  stations,\n  near,\n  nearest,\n  type NearOptions,\n  type NearestOptions,\n} from \"@neaps/tide-database\";\nimport {\n  useStation,\n  type Station,\n  type StationPredictor,\n  type StationExtremesOptions,\n  type StationTimelineOptions,\n  type StationWaterLevelOptions,\n} from \"@neaps/tide-predictor\";\n\n/**\n * Get extremes prediction using the nearest station to the given position.\n *\n * @example\n * ```ts\n * import { getExtremesPrediction } from 'neaps'\n *\n * const prediction = getExtremesPrediction({\n *   latitude: 26.7, // or `lat`\n *   longitude: -80.05, // or `lng` or `lon`\n *   start: new Date('2025-12-17'),\n *   end: new Date('2025-12-18'),\n *   datum: 'MLLW', // optional, defaults to station's datum\n * })\n */\nexport function getExtremesPrediction(options: NearestOptions & StationExtremesOptions) {\n  return nearestStation(options).getExtremesPrediction(options);\n}\n\n/**\n * Get timeline prediction using the nearest station to the given position.\n */\nexport function getTimelinePrediction(options: NearestOptions & StationTimelineOptions) {\n  return nearestStation(options).getTimelinePrediction(options);\n}\n\n/**\n * Get water level at a specific time using the nearest station to the given position.\n */\nexport function getWaterLevelAtTime(options: NearestOptions & StationWaterLevelOptions) {\n  return nearestStation(options).getWaterLevelAtTime(options);\n}\n\n/**\n * Find the nearest station to the given position.\n */\nexport function nearestStation(options: NearestOptions) {\n  const data = nearest(options);\n  if (!data) throw new Error(`No stations found with options: ${JSON.stringify(options)}`);\n  return useStation(...data);\n}\n\n/**\n * Find stations near the given position.\n * @param limit Maximum number of stations to return (default: 10)\n */\nexport function stationsNear(options: NearOptions) {\n  return near(options).map(([station, distance]) => useStation(station, distance));\n}\n\n/**\n * Find a specific station by its ID or source ID.\n */\nexport function findStation(query: string): StationPredictor {\n  const searches = [(s: Station) => s.id === query, (s: Station) => s.source.id === query];\n\n  let found: Station | undefined = undefined;\n\n  for (const search of searches) {\n    found = stations.find(search);\n    if (found) break;\n  }\n\n  if (!found) throw new Error(`Station not found: ${query}`);\n  return useStation(found);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA+BA,SAAgB,sBAAsB,SAAkD;CACtF,OAAO,eAAe,OAAO,CAAC,CAAC,sBAAsB,OAAO;AAC9D;;;;AAKA,SAAgB,sBAAsB,SAAkD;CACtF,OAAO,eAAe,OAAO,CAAC,CAAC,sBAAsB,OAAO;AAC9D;;;;AAKA,SAAgB,oBAAoB,SAAoD;CACtF,OAAO,eAAe,OAAO,CAAC,CAAC,oBAAoB,OAAO;AAC5D;;;;AAKA,SAAgB,eAAe,SAAyB;CACtD,MAAM,OAAO,QAAQ,OAAO;CAC5B,IAAI,CAAC,MAAM,MAAM,IAAI,MAAM,mCAAmC,KAAK,UAAU,OAAO,GAAG;CACvF,OAAO,WAAW,GAAG,IAAI;AAC3B;;;;;AAMA,SAAgB,aAAa,SAAsB;CACjD,OAAO,KAAK,OAAO,CAAC,CAAC,KAAK,CAAC,SAAS,cAAc,WAAW,SAAS,QAAQ,CAAC;AACjF;;;;AAKA,SAAgB,YAAY,OAAiC;CAC3D,MAAM,WAAW,EAAE,MAAe,EAAE,OAAO,QAAQ,MAAe,EAAE,OAAO,OAAO,KAAK;CAEvF,IAAI,QAA6B,KAAA;CAEjC,KAAK,MAAM,UAAU,UAAU;EAC7B,QAAQ,SAAS,KAAK,MAAM;EAC5B,IAAI,OAAO;CACb;CAEA,IAAI,CAAC,OAAO,MAAM,IAAI,MAAM,sBAAsB,OAAO;CACzD,OAAO,WAAW,KAAK;AACzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neaps",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Tide predictions",
   "keywords": [
     "tides",
@@ -34,7 +34,7 @@
     "prepack": "npm run build"
   },
   "dependencies": {
-    "@neaps/tide-database": "0.7",
-    "@neaps/tide-predictor": "^0.9.0"
+    "@neaps/tide-database": "0.8",
+    "@neaps/tide-predictor": "^0.10.0"
   }
 }