neaps 0.6.0 → 0.6.1

package/dist/index.cjs

@@ -1,7 +1,6 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+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";
@@ -144,7 +143,6 @@ function toPreferredUnits(prediction, units) {
 		level
 	};
 }
-
 //#endregion
 exports.findStation = findStation;
 exports.getExtremesPrediction = getExtremesPrediction;
@@ -153,4 +151,5 @@ 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,yCAAe,QAAQ;AAC7B,KAAI,CAAC,KAAM,OAAM,IAAI,MAAM,mCAAmC,KAAK,UAAU,QAAQ,GAAG;AACxF,QAAO,WAAW,GAAG,KAAK;;;;;;AAO5B,SAAgB,aAAa,SAAsB;AACjD,uCAAY,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;AAEjC,MAAK,MAAM,UAAU,UAAU;AAC7B,UAAQA,8BAAS,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;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,wDAA2B,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,CAAC;IAEW;;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,CAAC;IAEW;;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,MACD;IAEwD;;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 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"}

package/dist/index.d.cts

@@ -1,6 +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 * as _$_neaps_tide_database0 from "@neaps/tide-database";
+import { NearOptions, NearestOptions, Station } from "@neaps/tide-database";
 
 //#region src/index.d.ts
 type Units = "meters" | "feet";
@@ -30,33 +31,41 @@ type WaterLevelOptions = {
  * })
  */
 declare function getExtremesPrediction(options: NearestOptions & ExtremesOptions): {
-  datum: any;
-  units: any;
+  datum: string | undefined;
+  units: Units;
   station: Station;
   distance: number | undefined;
-  extremes: any;
+  extremes: _$_neaps_tide_predictor0.Extreme[];
 };
 /**
  * Get timeline prediction using the nearest station to the given position.
  */
 declare function getTimelinePrediction(options: NearestOptions & TimelineOptions): {
-  datum: any;
-  units: any;
+  datum: string | undefined;
+  units: Units;
   station: Station;
   distance: number | undefined;
-  timeline: any;
+  timeline: _$_neaps_tide_predictor0.TimelinePoint[];
 };
 /**
  * Get water level at a specific time using the nearest station to the given position.
  */
-declare function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions): any;
+declare function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions): {
+  time: Date;
+  hour: number;
+  level: number;
+  datum: string | undefined;
+  units: Units;
+  station: Station;
+  distance: number | undefined;
+};
 /**
  * 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[];
+  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
   defaultDatum: string | undefined;
   getExtremesPrediction({
     datum,
@@ -64,11 +73,11 @@ declare function nearestStation(options: NearestOptions): {
     nodeCorrections,
     ...options
   }: ExtremesOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    extremes: any;
+    extremes: _$_neaps_tide_predictor0.Extreme[];
   };
   getTimelinePrediction({
     datum,
@@ -76,18 +85,26 @@ declare function nearestStation(options: NearestOptions): {
     nodeCorrections,
     ...options
   }: TimelineOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    timeline: any;
+    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
   };
   getWaterLevelAtTime({
     time,
     datum,
     units,
     nodeCorrections
-  }: WaterLevelOptions): any;
+  }: WaterLevelOptions): {
+    time: Date;
+    hour: number;
+    level: number;
+    datum: string | undefined;
+    units: Units;
+    station: Station;
+    distance: number | undefined;
+  };
   id: string;
   name: string;
   continent: string;
@@ -135,7 +152,7 @@ declare function nearestStation(options: NearestOptions): {
 declare function stationsNear(options: NearOptions): {
   distance: number | undefined;
   datums: Record<string, number>;
-  harmonic_constituents: _neaps_tide_database0.HarmonicConstituent[];
+  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
   defaultDatum: string | undefined;
   getExtremesPrediction({
     datum,
@@ -143,11 +160,11 @@ declare function stationsNear(options: NearOptions): {
     nodeCorrections,
     ...options
   }: ExtremesOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    extremes: any;
+    extremes: _$_neaps_tide_predictor0.Extreme[];
   };
   getTimelinePrediction({
     datum,
@@ -155,18 +172,26 @@ declare function stationsNear(options: NearOptions): {
     nodeCorrections,
     ...options
   }: TimelineOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    timeline: any;
+    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
   };
   getWaterLevelAtTime({
     time,
     datum,
     units,
     nodeCorrections
-  }: WaterLevelOptions): any;
+  }: WaterLevelOptions): {
+    time: Date;
+    hour: number;
+    level: number;
+    datum: string | undefined;
+    units: Units;
+    station: Station;
+    distance: number | undefined;
+  };
   id: string;
   name: string;
   continent: string;
@@ -213,7 +238,7 @@ declare function stationsNear(options: NearOptions): {
 declare function findStation(query: string): {
   distance: number | undefined;
   datums: Record<string, number>;
-  harmonic_constituents: _neaps_tide_database0.HarmonicConstituent[];
+  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
   defaultDatum: string | undefined;
   getExtremesPrediction({
     datum,
@@ -221,11 +246,11 @@ declare function findStation(query: string): {
     nodeCorrections,
     ...options
   }: ExtremesOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    extremes: any;
+    extremes: _$_neaps_tide_predictor0.Extreme[];
   };
   getTimelinePrediction({
     datum,
@@ -233,18 +258,26 @@ declare function findStation(query: string): {
     nodeCorrections,
     ...options
   }: TimelineOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    timeline: any;
+    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
   };
   getWaterLevelAtTime({
     time,
     datum,
     units,
     nodeCorrections
-  }: WaterLevelOptions): any;
+  }: WaterLevelOptions): {
+    time: Date;
+    hour: number;
+    level: number;
+    datum: string | undefined;
+    units: Units;
+    station: Station;
+    distance: number | undefined;
+  };
   id: string;
   name: string;
   continent: string;
@@ -288,7 +321,7 @@ declare function findStation(query: string): {
 declare function useStation(station: Station, distance?: number): {
   distance: number | undefined;
   datums: Record<string, number>;
-  harmonic_constituents: _neaps_tide_database0.HarmonicConstituent[];
+  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
   defaultDatum: string | undefined;
   getExtremesPrediction({
     datum,
@@ -296,11 +329,11 @@ declare function useStation(station: Station, distance?: number): {
     nodeCorrections,
     ...options
   }: ExtremesOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    extremes: any;
+    extremes: _$_neaps_tide_predictor0.Extreme[];
   };
   getTimelinePrediction({
     datum,
@@ -308,18 +341,26 @@ declare function useStation(station: Station, distance?: number): {
     nodeCorrections,
     ...options
   }: TimelineOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    timeline: any;
+    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
   };
   getWaterLevelAtTime({
     time,
     datum,
     units,
     nodeCorrections
-  }: WaterLevelOptions): any;
+  }: WaterLevelOptions): {
+    time: Date;
+    hour: number;
+    level: number;
+    datum: string | undefined;
+    units: Units;
+    station: Station;
+    distance: number | undefined;
+  };
   id: string;
   name: string;
   continent: string;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import * as _neaps_tide_database0 from "@neaps/tide-database";
+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";
 
 //#region src/index.d.ts
@@ -30,33 +31,41 @@ type WaterLevelOptions = {
  * })
  */
 declare function getExtremesPrediction(options: NearestOptions & ExtremesOptions): {
-  datum: any;
-  units: any;
+  datum: string | undefined;
+  units: Units;
   station: Station;
   distance: number | undefined;
-  extremes: any;
+  extremes: _$_neaps_tide_predictor0.Extreme[];
 };
 /**
  * Get timeline prediction using the nearest station to the given position.
  */
 declare function getTimelinePrediction(options: NearestOptions & TimelineOptions): {
-  datum: any;
-  units: any;
+  datum: string | undefined;
+  units: Units;
   station: Station;
   distance: number | undefined;
-  timeline: any;
+  timeline: _$_neaps_tide_predictor0.TimelinePoint[];
 };
 /**
  * Get water level at a specific time using the nearest station to the given position.
  */
-declare function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions): any;
+declare function getWaterLevelAtTime(options: NearestOptions & WaterLevelOptions): {
+  time: Date;
+  hour: number;
+  level: number;
+  datum: string | undefined;
+  units: Units;
+  station: Station;
+  distance: number | undefined;
+};
 /**
  * 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[];
+  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
   defaultDatum: string | undefined;
   getExtremesPrediction({
     datum,
@@ -64,11 +73,11 @@ declare function nearestStation(options: NearestOptions): {
     nodeCorrections,
     ...options
   }: ExtremesOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    extremes: any;
+    extremes: _$_neaps_tide_predictor0.Extreme[];
   };
   getTimelinePrediction({
     datum,
@@ -76,18 +85,26 @@ declare function nearestStation(options: NearestOptions): {
     nodeCorrections,
     ...options
   }: TimelineOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    timeline: any;
+    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
   };
   getWaterLevelAtTime({
     time,
     datum,
     units,
     nodeCorrections
-  }: WaterLevelOptions): any;
+  }: WaterLevelOptions): {
+    time: Date;
+    hour: number;
+    level: number;
+    datum: string | undefined;
+    units: Units;
+    station: Station;
+    distance: number | undefined;
+  };
   id: string;
   name: string;
   continent: string;
@@ -135,7 +152,7 @@ declare function nearestStation(options: NearestOptions): {
 declare function stationsNear(options: NearOptions): {
   distance: number | undefined;
   datums: Record<string, number>;
-  harmonic_constituents: _neaps_tide_database0.HarmonicConstituent[];
+  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
   defaultDatum: string | undefined;
   getExtremesPrediction({
     datum,
@@ -143,11 +160,11 @@ declare function stationsNear(options: NearOptions): {
     nodeCorrections,
     ...options
   }: ExtremesOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    extremes: any;
+    extremes: _$_neaps_tide_predictor0.Extreme[];
   };
   getTimelinePrediction({
     datum,
@@ -155,18 +172,26 @@ declare function stationsNear(options: NearOptions): {
     nodeCorrections,
     ...options
   }: TimelineOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    timeline: any;
+    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
   };
   getWaterLevelAtTime({
     time,
     datum,
     units,
     nodeCorrections
-  }: WaterLevelOptions): any;
+  }: WaterLevelOptions): {
+    time: Date;
+    hour: number;
+    level: number;
+    datum: string | undefined;
+    units: Units;
+    station: Station;
+    distance: number | undefined;
+  };
   id: string;
   name: string;
   continent: string;
@@ -213,7 +238,7 @@ declare function stationsNear(options: NearOptions): {
 declare function findStation(query: string): {
   distance: number | undefined;
   datums: Record<string, number>;
-  harmonic_constituents: _neaps_tide_database0.HarmonicConstituent[];
+  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
   defaultDatum: string | undefined;
   getExtremesPrediction({
     datum,
@@ -221,11 +246,11 @@ declare function findStation(query: string): {
     nodeCorrections,
     ...options
   }: ExtremesOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    extremes: any;
+    extremes: _$_neaps_tide_predictor0.Extreme[];
   };
   getTimelinePrediction({
     datum,
@@ -233,18 +258,26 @@ declare function findStation(query: string): {
     nodeCorrections,
     ...options
   }: TimelineOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    timeline: any;
+    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
   };
   getWaterLevelAtTime({
     time,
     datum,
     units,
     nodeCorrections
-  }: WaterLevelOptions): any;
+  }: WaterLevelOptions): {
+    time: Date;
+    hour: number;
+    level: number;
+    datum: string | undefined;
+    units: Units;
+    station: Station;
+    distance: number | undefined;
+  };
   id: string;
   name: string;
   continent: string;
@@ -288,7 +321,7 @@ declare function findStation(query: string): {
 declare function useStation(station: Station, distance?: number): {
   distance: number | undefined;
   datums: Record<string, number>;
-  harmonic_constituents: _neaps_tide_database0.HarmonicConstituent[];
+  harmonic_constituents: _$_neaps_tide_database0.HarmonicConstituent[];
   defaultDatum: string | undefined;
   getExtremesPrediction({
     datum,
@@ -296,11 +329,11 @@ declare function useStation(station: Station, distance?: number): {
     nodeCorrections,
     ...options
   }: ExtremesOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    extremes: any;
+    extremes: _$_neaps_tide_predictor0.Extreme[];
   };
   getTimelinePrediction({
     datum,
@@ -308,18 +341,26 @@ declare function useStation(station: Station, distance?: number): {
     nodeCorrections,
     ...options
   }: TimelineOptions): {
-    datum: any;
-    units: any;
+    datum: string | undefined;
+    units: Units;
     station: Station;
     distance: number | undefined;
-    timeline: any;
+    timeline: _$_neaps_tide_predictor0.TimelinePoint[];
   };
   getWaterLevelAtTime({
     time,
     datum,
     units,
     nodeCorrections
-  }: WaterLevelOptions): any;
+  }: WaterLevelOptions): {
+    time: Date;
+    hour: number;
+    level: number;
+    datum: string | undefined;
+    units: Units;
+    station: Station;
+    distance: number | undefined;
+  };
   id: string;
   name: string;
   continent: string;

package/dist/index.js

@@ -1,6 +1,5 @@
 import { near, nearest, stations } from "@neaps/tide-database";
 import { createTidePredictor } from "@neaps/tide-predictor";
-
 //#region src/index.ts
 const feetPerMeter = 3.2808399;
 const defaultUnits = "meters";
@@ -143,7 +142,7 @@ function toPreferredUnits(prediction, units) {
 		level
 	};
 }
-
 //#endregion
 export { findStation, getExtremesPrediction, getTimelinePrediction, getWaterLevelAtTime, nearestStation, stationsNear, useStation };
+
 //# 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;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;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,CAAC;IAEW;;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,CAAC;IAEW;;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,MACD;IAEwD;;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 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"}

package/package.json

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