@centia-io/sdk 0.2.15 → 0.2.17

package/dist/centia-io-sdk.umd.js

@@ -3463,12 +3463,6 @@
 		relationPath(schema, relation, rest = "") {
 			return `api/v4/schemas/${encodeURIComponent(schema)}/relations/${encodeURIComponent(relation)}/snapshots${rest}`;
 		}
-		/**
-		* Queue a Parquet snapshot of a table or view. Returns 202 with the job id.
-		* Throws `CentiaApiError`: 403 (super-user only), 404 (relation not found),
-		* 409 (a snapshot of the relation is already pending or running),
-		* 501 (snapshot storage not configured).
-		*/
 		async postSnapshot(body) {
 			return this.client.request({
 				path: "api/v4/snapshots",
@@ -3477,10 +3471,11 @@
 				expectedStatus: 202
 			});
 		}
-		/** Get a snapshot job by id. Super-user only. */
 		async getSnapshot(id) {
-			return this.client.request({
-				path: `api/v4/snapshots/${encodeURIComponent(id)}`,
+			var _this2 = this;
+			const keys = Array.isArray(id) ? id : [id];
+			return _this2.client.request({
+				path: `api/v4/snapshots/${keys.map((k) => encodeURIComponent(k)).join(",")}`,
 				method: "GET"
 			});
 		}
@@ -3555,24 +3550,46 @@
 			return _this8.rawGet(_this8.relationPath(schema, relation, `/${encodeURIComponent(date)}/data`), "HEAD");
 		}
 		/**
+		* Absolute URL of one output format of the snapshot, without fetching it —
+		* for DuckDB/GDAL or a plain fetch.
+		*/
+		getRelationSnapshotDataFormatUrl(schema, relation, date, format) {
+			return `${this.client.baseUrl}/${this.relationPath(schema, relation, `/${encodeURIComponent(date)}/data/${encodeURIComponent(format)}`)}`;
+		}
+		/**
+		* Fetch one output format of the snapshot (Content-Type is the format's
+		* media type). Same redirect/range semantics as getRelationSnapshotData.
+		* Throws `CentiaApiError`: 400 (unknown format id), 404 (no snapshot for
+		* that date, or the format was skipped/not requested), 403, 416, 502.
+		*/
+		async getRelationSnapshotDataFormat(schema, relation, date, format, options) {
+			var _this9 = this;
+			return _this9.rawGet(_this9.relationPath(schema, relation, `/${encodeURIComponent(date)}/data/${encodeURIComponent(format)}`), "GET", options);
+		}
+		/** HEAD request for one output format of the snapshot. */
+		async headRelationSnapshotDataFormat(schema, relation, date, format) {
+			var _this10 = this;
+			return _this10.rawGet(_this10.relationPath(schema, relation, `/${encodeURIComponent(date)}/data/${encodeURIComponent(format)}`), "HEAD");
+		}
+		/**
 		* Fetch one file of the snapshot by catalog name (`data-<id>.parquet`,
 		* `metadata-<id>.json`). Same redirect/range semantics as
 		* getRelationSnapshotData.
 		*/
 		async getRelationSnapshotFile(schema, relation, date, file, options) {
-			var _this9 = this;
-			return _this9.rawGet(_this9.relationPath(schema, relation, `/${encodeURIComponent(date)}/files/${encodeURIComponent(file)}`), "GET", options);
+			var _this11 = this;
+			return _this11.rawGet(_this11.relationPath(schema, relation, `/${encodeURIComponent(date)}/files/${encodeURIComponent(file)}`), "GET", options);
 		}
 		/** HEAD request for one file of the snapshot. */
 		async headRelationSnapshotFile(schema, relation, date, file) {
-			var _this10 = this;
-			return _this10.rawGet(_this10.relationPath(schema, relation, `/${encodeURIComponent(date)}/files/${encodeURIComponent(file)}`), "HEAD");
+			var _this12 = this;
+			return _this12.rawGet(_this12.relationPath(schema, relation, `/${encodeURIComponent(date)}/files/${encodeURIComponent(file)}`), "HEAD");
 		}
 		async rawGet(path, method, options) {
-			var _this11 = this;
+			var _this13 = this;
 			const headers = {};
 			if (options === null || options === void 0 ? void 0 : options.range) headers["Range"] = `bytes=${options.range[0]}-${options.range[1]}`;
-			return _this11.client.requestRaw({
+			return _this13.client.requestRaw({
 				path,
 				method,
 				headers: Object.keys(headers).length > 0 ? headers : void 0,
@@ -3581,6 +3598,126 @@
 		}
 	};
 
+//#endregion
+//#region src/scheduler/Scheduler.ts
+	function idsPath(id) {
+		return (Array.isArray(id) ? id : [id]).map((k) => encodeURIComponent(String(k))).join(",");
+	}
+	/**
+	* Client for the scheduler API (`/api/v4/scheduler`). Super-user only.
+	*
+	* Jobs describe recurring data imports (cron-scheduled); runs are their
+	* executions. Starting a run is asynchronous — poll `getSchedulerRuns`
+	* (the `_links.runs` of the 202) until the run finishes.
+	*
+	* ```ts
+	* const scheduler = new Scheduler(createCentiaClient({ baseUrl, auth }));
+	* const { ids } = await scheduler.postSchedulerJob({ name, schema, url, schedule: '0 3 * * *' });
+	* await scheduler.postSchedulerRun({ job: ids[0] });
+	* ```
+	*/
+	var Scheduler = class {
+		constructor(client) {
+			this.client = client;
+		}
+		/** List all scheduler jobs. */
+		async getSchedulerJobs() {
+			return this.client.request({
+				path: "api/v4/scheduler/jobs",
+				method: "GET"
+			});
+		}
+		async getSchedulerJob(id) {
+			return this.client.request({
+				path: `api/v4/scheduler/jobs/${idsPath(id)}`,
+				method: "GET"
+			});
+		}
+		/**
+		* Create one or more jobs (201; all-or-nothing for arrays). Returns the
+		* Location header and the new ids parsed from it, in request order.
+		*/
+		async postSchedulerJob(body) {
+			var _this3 = this;
+			var _res$getHeader, _location$split$pop;
+			const location = (_res$getHeader = (await _this3.client.requestFull({
+				path: "api/v4/scheduler/jobs",
+				method: "POST",
+				body,
+				expectedStatus: 201
+			})).getHeader("Location")) !== null && _res$getHeader !== void 0 ? _res$getHeader : "";
+			return {
+				location,
+				ids: ((_location$split$pop = location.split("/").pop()) !== null && _location$split$pop !== void 0 ? _location$split$pop : "").split(",").map((s) => Number(s)).filter((n) => Number.isFinite(n))
+			};
+		}
+		/** Partially update a job (303 + Location). */
+		async patchSchedulerJob(id, body) {
+			var _this4 = this;
+			var _res$getHeader2;
+			return { location: (_res$getHeader2 = (await _this4.client.requestFull({
+				path: `api/v4/scheduler/jobs/${idsPath(id)}`,
+				method: "PATCH",
+				body,
+				expectedStatus: 303
+			})).getHeader("Location")) !== null && _res$getHeader2 !== void 0 ? _res$getHeader2 : "" };
+		}
+		/**
+		* Delete one or more jobs (204). Nothing is deleted if any id fails:
+		* throws 404 (unknown id) or 409 (a run is in progress).
+		*/
+		async deleteSchedulerJob(id) {
+			await this.client.request({
+				path: `api/v4/scheduler/jobs/${idsPath(id)}`,
+				method: "DELETE",
+				expectedStatus: 204
+			});
+		}
+		/** List runs (running plus the newest 50 finished), optionally filtered by job and status. */
+		async getSchedulerRuns(options) {
+			var _this6 = this;
+			const query = {};
+			if ((options === null || options === void 0 ? void 0 : options.job) !== void 0) query.job = String(options.job);
+			if ((options === null || options === void 0 ? void 0 : options.status) !== void 0) query.status = options.status;
+			return _this6.client.request({
+				path: "api/v4/scheduler/runs",
+				method: "GET",
+				query: Object.keys(query).length > 0 ? query : void 0
+			});
+		}
+		/** Get one run by uuid. */
+		async getSchedulerRun(uuid) {
+			return this.client.request({
+				path: `api/v4/scheduler/runs/${encodeURIComponent(uuid)}`,
+				method: "GET"
+			});
+		}
+		/**
+		* Start a run of a job (202). Throws 404 (unknown job) or 409 (a run of
+		* the job is already running).
+		*/
+		async postSchedulerRun(body) {
+			return this.client.request({
+				path: "api/v4/scheduler/runs",
+				method: "POST",
+				body,
+				expectedStatus: 202
+			});
+		}
+		/**
+		* Stop a running run: sends SIGINT, which the server escalates to SIGKILL
+		* after 30 s — the request itself can take up to ~30 s, so do not use a
+		* short timeout. Throws 404 (no running run with that uuid) or 409 (the
+		* run is on another host).
+		*/
+		async deleteSchedulerRun(uuid) {
+			return this.client.request({
+				path: `api/v4/scheduler/runs/${encodeURIComponent(uuid)}`,
+				method: "DELETE"
+			});
+		}
+	};
+
 //#endregion
 //#region src/auth/errors.ts
 /**
@@ -3718,6 +3855,7 @@ exports.Ogc = Ogc;
 exports.Ows = Ows;
 exports.PasswordFlow = PasswordFlow;
 exports.Rpc = Rpc;
+exports.Scheduler = Scheduler;
 exports.SessionExpiredError = SessionExpiredError;
 exports.SignUp = SignUp;
 exports.Snapshots = Snapshots;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@centia-io/sdk",
-  "version": "0.2.15",
+  "version": "0.2.17",
   "description": "Centia-io TypeScript SDK",
   "author": "Martin Høgh",
   "license": "MIT",