@maschinenlesbar.org/govdata-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,49 @@
+export type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export type JsonObject = {
+    [key: string]: JsonValue;
+};
+/** The envelope CKAN wraps every Action API response in. */
+export interface CkanEnvelope<T> {
+    help: string;
+    success: boolean;
+    result?: T;
+    error?: JsonObject;
+}
+/** Result of `package_search`. */
+export interface PackageSearchResult {
+    count: number;
+    results: JsonObject[];
+    facets?: JsonObject;
+    search_facets?: JsonObject;
+    sort?: string;
+}
+/** A dataset ("package"). */
+export type Package = JsonObject;
+/** An organization or group. */
+export type Organization = JsonObject;
+export type Group = JsonObject;
+/** A resource (a single distributable file within a dataset). */
+export type Resource = JsonObject;
+/** Parameters for `package_search`. */
+export interface PackageSearchParams {
+    /** Solr query string, e.g. `title:Haushalt`. */
+    q?: string;
+    /** Filter queries, e.g. `["organization:destatis"]`. */
+    fq?: string[];
+    rows?: number;
+    start?: number;
+    /** e.g. `"metadata_modified desc"`. */
+    sort?: string;
+    /** Facet fields to compute. */
+    facet_field?: string[];
+}
+/** Parameters for the `*_list` endpoints. */
+export interface ListParams {
+    limit?: number;
+    offset?: number;
+    /** Return full objects instead of just names (organization/group lists). */
+    all_fields?: boolean;
+}
+//# 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":"AAMA,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,4DAA4D;AAC5D,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,CAAC,CAAC;IACX,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AAED,kCAAkC;AAClC,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,aAAa,CAAC,EAAE,UAAU,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,6BAA6B;AAC7B,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC;AACjC,gCAAgC;AAChC,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC;AACtC,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC;AAC/B,iEAAiE;AACjE,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC;AAElC,uCAAuC;AACvC,MAAM,WAAW,mBAAmB;IAClC,gDAAgD;IAChD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,wDAAwD;IACxD,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,6CAA6C;AAC7C,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/dist/src/client/types.js

@@ -0,0 +1,7 @@
+// Domain types for the GovData CKAN Action API (ckan.govdata.de).
+//
+// CKAN wraps every response in `{ help, success, result }` (or an `error` object
+// when `success` is false). The client unwraps `result`; datasets are deeply
+// nested and CKAN-version-specific, so they are exposed as raw `JsonObject`s.
+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,kEAAkE;AAClE,EAAE;AACF,iFAAiF;AACjF,6EAA6E;AAC7E,8EAA8E"}

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 govdata-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,yEAAyE;AACzE,cAAc,mBAAmB,CAAC"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@maschinenlesbar.org/govdata-cli",
+  "version": "0.0.1",
+  "description": "TypeScript API client and CLI for the open GovData CKAN catalogue API (ckan.govdata.de)",
+  "type": "module",
+  "bin": {
+    "govdata": "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": [
+    "govdata",
+    "ckan",
+    "open-data",
+    "opendata",
+    "catalogue",
+    "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/govdata-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/maschinenlesbar-org/govdata-cli/issues"
+  },
+  "homepage": "https://github.com/maschinenlesbar-org/govdata-cli#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "commander": "15.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.19",
+    "typedoc": "0.28.19",
+    "typescript": "6.0.3"
+  }
+}