@maschinenlesbar.org/pegel-online-cli 0.0.1

package/dist/src/client/query.d.ts

@@ -0,0 +1,9 @@
+export type QueryPrimitive = string | number | boolean | Date | null | undefined;
+export type QueryValue = QueryPrimitive | QueryPrimitive[];
+export type QueryParams = Record<string, QueryValue>;
+/**
+ * Build a query string (without a leading `?`) from a params object.
+ * Returns an empty string when no parameters survive filtering.
+ */
+export declare function buildQueryString(params: QueryParams): string;
+//# sourceMappingURL=query.d.ts.map

package/dist/src/client/query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../../src/client/query.ts"],"names":[],"mappings":"AAOA,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;AACjF,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,cAAc,EAAE,CAAC;AAC3D,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAQrD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAe5D"}

package/dist/src/client/query.js

@@ -0,0 +1,33 @@
+// Tiny, dependency-free query-string builder.
+//   - `undefined` / `null` values are omitted entirely
+//   - arrays are serialised as repeated keys (`?id=a&id=b`)
+//   - booleans become the strings "true"/"false"
+//   - Date values become full ISO-8601 strings
+//   - everything else is coerced with String()
+function serializeScalar(value) {
+    if (value instanceof Date)
+        return value.toISOString();
+    if (typeof value === "boolean")
+        return value ? "true" : "false";
+    return String(value);
+}
+/**
+ * Build a query string (without a leading `?`) from a params object.
+ * Returns an empty string when no parameters survive filtering.
+ */
+export function buildQueryString(params) {
+    const search = new URLSearchParams();
+    for (const [key, raw] of Object.entries(params)) {
+        if (raw === undefined || raw === null)
+            continue;
+        const values = Array.isArray(raw) ? raw : [raw];
+        for (const value of values) {
+            if (value === undefined || value === null)
+                continue;
+            search.append(key, serializeScalar(value));
+        }
+    }
+    // URLSearchParams encodes spaces as "+"; "%20" is more broadly interoperable.
+    return search.toString().replace(/\+/g, "%20");
+}
+//# sourceMappingURL=query.js.map

package/dist/src/client/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../src/client/query.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,uDAAuD;AACvD,4DAA4D;AAC5D,iDAAiD;AACjD,+CAA+C;AAC/C,+CAA+C;AAM/C,SAAS,eAAe,CAAC,KAAgD;IACvE,IAAI,KAAK,YAAY,IAAI;QAAE,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IACtD,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;IAChE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAmB;IAClD,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IAErC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI;YAAE,SAAS;QAEhD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAChD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;gBAAE,SAAS;YACpD,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AACjD,CAAC"}

package/dist/src/client/types.d.ts

@@ -0,0 +1,71 @@
+export type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export type JsonObject = {
+    [key: string]: JsonValue;
+};
+/** A body of water (Gewässer). */
+export interface Water {
+    shortname: string;
+    longname: string;
+}
+/** A measuring station. Timeseries/current measurement appear only when requested. */
+export interface Station {
+    uuid: string;
+    number: string;
+    shortname: string;
+    longname: string;
+    km?: number;
+    agency?: string;
+    longitude?: number;
+    latitude?: number;
+    water?: Water;
+    timeseries?: TimeseriesInfo[];
+}
+/** A measurement value plus the API's state classifications. */
+export interface CurrentMeasurement {
+    timestamp: string;
+    value: number;
+    /** Classification vs. the mean low/high water marks. */
+    stateMnwMhw?: string;
+    /** Classification vs. the lowest/highest navigable water marks. */
+    stateNswHsw?: string;
+}
+/** Metadata for one timeseries of a station (e.g. "W" water level, "Q" flow). */
+export interface TimeseriesInfo {
+    shortname: string;
+    longname: string;
+    unit: string;
+    equidistance?: number;
+    currentMeasurement?: CurrentMeasurement;
+    /** Characteristic values (gauge marks), present only when requested. */
+    characteristicValues?: JsonObject[] | null;
+}
+/** One point of a measurements series. */
+export interface Measurement {
+    timestamp: string;
+    value: number;
+}
+/** Parameters for the stations listing. */
+export interface StationListParams {
+    /** Station identifiers (uuid/number/shortname/longname); sent comma-separated. */
+    ids?: string[];
+    /** Water shortname filter. */
+    waters?: string;
+    fuzzyId?: string;
+    includeTimeseries?: boolean;
+    includeCurrentMeasurement?: boolean;
+    includeCharacteristicValues?: boolean;
+}
+/** Optional includes for a single-station or single-timeseries request. */
+export interface IncludeParams {
+    includeTimeseries?: boolean;
+    includeCurrentMeasurement?: boolean;
+    includeCharacteristicValues?: boolean;
+}
+/** Time window for a measurements request (ISO-8601 instants or periods, e.g. "P7D"). */
+export interface MeasurementsParams {
+    start?: string;
+    end?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/src/client/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/client/types.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,EAAE,GACX;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AACjC,MAAM,MAAM,UAAU,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEtD,kCAAkC;AAClC,MAAM,WAAW,KAAK;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,sFAAsF;AACtF,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;CAC/B;AAED,gEAAgE;AAChE,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,iFAAiF;AACjF,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,wEAAwE;IACxE,oBAAoB,CAAC,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;CAC5C;AAED,0CAA0C;AAC1C,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,2CAA2C;AAC3C,MAAM,WAAW,iBAAiB;IAChC,kFAAkF;IAClF,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,8BAA8B;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;AAED,2EAA2E;AAC3E,MAAM,WAAW,aAAa;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;AAED,yFAAyF;AACzF,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CACd"}

package/dist/src/client/types.js

@@ -0,0 +1,4 @@
+// Domain types for the PEGELONLINE REST API v2 (pegelonline.wsv.de), the
+// Wasserstraßen- und Schifffahrtsverwaltung's water-level web service.
+export {};
+//# sourceMappingURL=types.js.map

package/dist/src/client/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/client/types.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,uEAAuE"}

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,cAAc,mBAAmB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,3 @@
+// Library root. Import from here when using pegel-online-cli as a dependency.
+export * from "./client/index.js";
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,cAAc,mBAAmB,CAAC"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@maschinenlesbar.org/pegel-online-cli",
+  "version": "0.0.1",
+  "description": "TypeScript API client and CLI for the open PEGELONLINE water-level REST API (pegelonline.wsv.de)",
+  "type": "module",
+  "bin": {
+    "pegel": "dist/src/cli/index.js"
+  },
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    }
+  },
+  "files": [
+    "dist/src",
+    "LICENSING.md",
+    "CONTRIBUTING.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "clean": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\"",
+    "build": "tsc -p tsconfig.json",
+    "prepack": "npm run build",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "pretest": "npm run build",
+    "test": "node --test dist/test/*.test.js",
+    "docs": "typedoc src/index.ts --out out",
+    "start": "node dist/src/cli/index.js"
+  },
+  "keywords": [
+    "pegelonline",
+    "wsv",
+    "wasserstand",
+    "water-level",
+    "hydrology",
+    "germany",
+    "cli",
+    "api-client"
+  ],
+  "author": "Sebastian Schürmann <sebs@2xs.org>",
+  "license": "AGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/maschinenlesbar-org/pegel-online-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/maschinenlesbar-org/pegel-online-cli/issues"
+  },
+  "homepage": "https://github.com/maschinenlesbar-org/pegel-online-cli#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "commander": "15.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.19",
+    "typedoc": "0.28.19",
+    "typescript": "6.0.3"
+  }
+}