@maschinenlesbar.org/marktstammdatenregister-cli 0.0.1

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

@@ -0,0 +1,103 @@
+/**
+ * A Microsoft-AJAX date string as MaStR returns them, e.g. `"/Date(1548979200000)/"`
+ * (milliseconds since the Unix epoch, UTC). Use `parseMsDate()` to convert, or the
+ * CLI's `--iso-dates` flag to rewrite every such field to ISO-8601.
+ */
+export type MastrDate = string;
+/** The four datasets the public search exposes. */
+export type UnitCategory = "stromerzeugung" | "stromverbrauch" | "gaserzeugung" | "gasverbrauch";
+/**
+ * A unit ("Einheit") record. The API returns a very wide row (~90 fields) whose
+ * populated columns vary by category (a solar unit carries module fields a gas
+ * consumer does not), so only the broadly-useful, category-independent fields are
+ * typed; the index signature carries the rest. Natural-person and confidential data
+ * are withheld upstream, so operator names may be anonymised (e.g.
+ * `"natürliche Person (ABR…)"`).
+ */
+export interface MastrUnit {
+    Id?: number;
+    /** The unit's MaStR number, e.g. `"SEE984033548619"`. */
+    MaStRNummer?: string;
+    /** Display name of the unit. */
+    EinheitName?: string;
+    /** Operating status name, e.g. `"In Betrieb"`. */
+    BetriebsStatusName?: string;
+    BetriebsStatusId?: number;
+    /** Energy carrier name, e.g. `"Solare Strahlungsenergie"`. */
+    EnergietraegerName?: string;
+    EnergietraegerId?: number;
+    /** Gross capacity in kW. */
+    Bruttoleistung?: number;
+    /** Net rated capacity in kW. */
+    Nettonennleistung?: number;
+    Bundesland?: string;
+    Landkreis?: string;
+    Gemeinde?: string;
+    Ort?: string;
+    Plz?: string;
+    /** Latitude (may be withheld for small units). */
+    Breitengrad?: number | null;
+    /** Longitude (may be withheld for small units). */
+    Laengengrad?: number | null;
+    /** Commissioning date. */
+    InbetriebnahmeDatum?: MastrDate | null;
+    /** Registration date in MaStR. */
+    EinheitRegistrierungsdatum?: MastrDate;
+    /** Final decommissioning date, if any. */
+    EndgueltigeStilllegungDatum?: MastrDate | null;
+    /** Operator name (often anonymised). */
+    AnlagenbetreiberName?: string;
+    AnlagenbetreiberMaStRNummer?: string;
+    /** Grid operator name(s). */
+    NetzbetreiberNamen?: string;
+    /** Everything else the row carries (category-specific columns, IDs, ...). */
+    [key: string]: unknown;
+}
+/** The raw response envelope of a data endpoint (Kendo UI Grid shape). */
+export interface UnitResponse {
+    Data: MastrUnit[] | null;
+    /** Total number of matching units (across all pages). */
+    Total: number;
+    AggregateResults?: unknown;
+    /** A logical error message (e.g. `"Die Anfrage ist Null."`); null on success. */
+    Errors?: string | null;
+}
+/** A page of units plus the total match count — what the client returns. */
+export interface UnitPage {
+    /** Total matching units across all pages (respects the filter). */
+    total: number;
+    /** The units on this page. */
+    data: MastrUnit[];
+}
+/** Query parameters for a unit search. `group` is always sent empty by the client. */
+export interface UnitQuery {
+    /** 1-based page number (default 1). */
+    page?: number;
+    /** Rows per page. */
+    pageSize?: number;
+    /** Sort spec: `FieldKey-asc` or `FieldKey-desc`, e.g. `"Bruttoleistung-desc"`. */
+    sort?: string;
+    /**
+     * Filter spec: `FilterName~op~'value'~[and|or]~…` with ops
+     * `eq|neq|sw|ct|nct|ew|null|nn`, e.g. `"Energieträger~eq~'2495'"`. Discover the
+     * `FilterName`s and dropdown codes via {@link MastrClient.filterColumns}.
+     */
+    filter?: string;
+}
+/** A filterable column, from a `GetFilterColumns…` endpoint. */
+export interface FilterColumn {
+    /** Human-readable filter name (used as the field in a filter spec). */
+    FilterName?: string;
+    /** Filter type. */
+    Type?: "text" | "number" | "multidropdown" | "date" | "boolean" | string;
+    /** For dropdown filters: the allowed `{ Name, Value }` options (Value is the code to send). */
+    ListObject?: {
+        Name?: string;
+        Value?: string;
+    }[];
+    CustomSelectString?: string | null;
+    FilterField?: string | null;
+    Position?: number | null;
+    OptionalFilterEntity?: unknown;
+}
+//# 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;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B,mDAAmD;AACnD,MAAM,MAAM,YAAY,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,cAAc,GAAG,cAAc,CAAC;AAEjG;;;;;;;GAOG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8DAA8D;IAC9D,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,4BAA4B;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gCAAgC;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,0BAA0B;IAC1B,mBAAmB,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IACvC,kCAAkC;IAClC,0BAA0B,CAAC,EAAE,SAAS,CAAC;IACvC,0CAA0C;IAC1C,2BAA2B,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC/C,wCAAwC;IACxC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,6BAA6B;IAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,6EAA6E;IAC7E,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,0EAA0E;AAC1E,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IACzB,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,4EAA4E;AAC5E,MAAM,WAAW,QAAQ;IACvB,mEAAmE;IACnE,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,IAAI,EAAE,SAAS,EAAE,CAAC;CACnB;AAED,sFAAsF;AACtF,MAAM,WAAW,SAAS;IACxB,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,gEAAgE;AAChE,MAAM,WAAW,YAAY;IAC3B,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,eAAe,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC;IACzE,+FAA+F;IAC/F,UAAU,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACjD,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC"}

package/dist/src/client/types.js

@@ -0,0 +1,4 @@
+// Domain types for the Marktstammdatenregister (MaStR) public unit-search API
+// (www.marktstammdatenregister.de/MaStR).
+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,8EAA8E;AAC9E,0CAA0C"}

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 marktstammdatenregister-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,yFAAyF;AACzF,cAAc,mBAAmB,CAAC"}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@maschinenlesbar.org/marktstammdatenregister-cli",
+  "version": "0.0.1",
+  "description": "TypeScript API client and CLI for the Marktstammdatenregister (MaStR) — the Bundesnetzagentur's register of German electricity & gas market units",
+  "type": "module",
+  "bin": {
+    "mastr": "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": [
+    "marktstammdatenregister",
+    "mastr",
+    "bundesnetzagentur",
+    "energie",
+    "strom",
+    "gas",
+    "photovoltaik",
+    "windkraft",
+    "energy",
+    "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/marktstammdatenregister-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/maschinenlesbar-org/marktstammdatenregister-cli/issues"
+  },
+  "homepage": "https://github.com/maschinenlesbar-org/marktstammdatenregister-cli#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "commander": "15.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.19",
+    "typedoc": "0.28.19",
+    "typescript": "6.0.3"
+  }
+}