btrz-api-client 8.32.0 → 8.33.0

package/lib/client.js

@@ -187,6 +187,8 @@ function createColtrane(_ref3) {
 
   return {
     docs: require("./endpoints/coltrane/docs.js")({ client: client }),
+    healthcheck: require("./endpoints/coltrane/healthcheck.js")({ client: client }),
+    info: require("./endpoints/coltrane/info.js")({ client: client }),
     paths: require("./endpoints/coltrane/paths.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     mergedFareTables: require("./endpoints/coltrane/merged-fare-tables.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     __test: {

package/lib/endpoints/coltrane/healthcheck.js

@@ -0,0 +1,35 @@
+"use strict";
+
+/**
+ * Factory for Coltrane healthcheck API (btrz-api-coltrane) — liveness probe.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
+function healthcheckFactory(_ref) {
+  var client = _ref.client;
+
+  /**
+   * GET /healthcheck — liveness probe. Returns 200 with empty body when the service is running. No authentication required.
+   * @param {Object} [opts]
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: {} }>>}
+   * @throws {import("axios").AxiosError} 500 Service unhealthy or shutting down
+   */
+  function get() {
+    var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+        headers = _ref2.headers;
+
+    return client({
+      url: "/healthcheck",
+      method: "get",
+      headers: headers || {}
+    });
+  }
+
+  return {
+    get: get
+  };
+}
+
+module.exports = healthcheckFactory;

package/lib/endpoints/coltrane/info.js

@@ -0,0 +1,35 @@
+"use strict";
+
+/* eslint-disable max-len */
+/**
+ * Factory for Coltrane info API (btrz-api-coltrane) — service and dependency status.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
+function infoFactory(_ref) {
+  var client = _ref.client;
+
+  /**
+   * GET /info — get Coltrane API service status and dependency health. No authentication required.
+   * @param {Object} [opts]
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { status: number, services: Array<{ name: string, status: number }>, build?: string, instanceId?: string, commit?: string } }>>}
+   * @throws {import("axios").AxiosError} 500 Internal server error or dependency check failure
+   */
+  function get() {
+    var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+        headers = _ref2.headers;
+
+    return client({
+      url: "/info",
+      headers: headers || {}
+    });
+  }
+
+  return {
+    get: get
+  };
+}
+
+module.exports = infoFactory;

package/lib/endpoints/coltrane/paths.js

@@ -5,15 +5,16 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for GET /paths (btrz-api-coltrane). See get-paths getSpec().
+ * Query params for GET /paths (btrz-api-coltrane). All except metrics and preferredAlgorithm are required by the API.
  * @typedef {Object} ColtranePathsListQuery
- * @property {string} [providerId] - Account ID of the travel provider (required by API)
- * @property {string} [productId] - Product ID belonging to the provider (required by API)
- * @property {string} [originId] - Origin station id (required by API)
- * @property {string} [destinationId] - Destination station id (required by API)
- * @property {string} [departureFromDate] - Start of search interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
- * @property {string} [departureToDate] - End of search interval; ISO 8601; interval max 25h
- * @property {string} [metrics] - If true, response includes metrics (debugging)
+ * @property {string} [providerId] - Account ID of the travel provider (24-char hex)
+ * @property {string} [productId] - Product ID belonging to the provider (24-char hex)
+ * @property {string} [originId] - Origin station ID (24-char hex); must differ from destinationId
+ * @property {string} [destinationId] - Destination station ID (24-char hex)
+ * @property {string} [departureFromDate] - Start of departure interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
+ * @property {string} [departureToDate] - End of departure interval; ISO 8601; interval max 25h, must be after departureFromDate
+ * @property {string} [preferredAlgorithm] - "search_algorithm_fast" or "search_algorithm_exhaustive"
+ * @property {string|boolean} [metrics] - If true, response includes metrics object (debugging)
  */
 
 /**
@@ -30,12 +31,15 @@ function coltraneFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /paths - list Coltrane paths.
+   * GET /paths — search for travel paths between two stations in a departure time interval.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {ColtranePathsListQuery} [opts.query] - Query params (providerId, productId, originId, destinationId, etc.)
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {ColtranePathsListQuery} [opts.query] - Query params; providerId, productId, originId, destinationId, departureFromDate, departureToDate required
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { paths: Array<{ segments: Array<{ scheduleId: string, manifestDay: string, fromLegIndex: number, toLegIndex: number }> }>, metrics?: object } }>>}
+   * @throws {import("axios").AxiosError} 400 INVALID_QUERY_PARAMETERS (invalid params, originId=destinationId, interval &gt; 25h, or invalid preferredAlgorithm)
+   * @throws {import("axios").AxiosError} 401 Unauthorized
+   * @throws {import("axios").AxiosError} 500 Internal server error
    */
   function all(_ref2) {
     var token = _ref2.token,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "8.32.0",
+  "version": "8.33.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

package/src/client.js

@@ -160,6 +160,8 @@ function createColtrane({baseURL, headers, timeout, overrideFn, internalAuthToke
 
   return {
     docs: require("./endpoints/coltrane/docs.js")({client}),
+    healthcheck: require("./endpoints/coltrane/healthcheck.js")({client}),
+    info: require("./endpoints/coltrane/info.js")({client}),
     paths: require("./endpoints/coltrane/paths.js")({client, internalAuthTokenProvider}),
     mergedFareTables: require("./endpoints/coltrane/merged-fare-tables.js")({client, internalAuthTokenProvider}),
     __test: {

package/src/endpoints/coltrane/healthcheck.js

@@ -0,0 +1,28 @@
+/**
+ * Factory for Coltrane healthcheck API (btrz-api-coltrane) — liveness probe.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
+function healthcheckFactory({client}) {
+  /**
+   * GET /healthcheck — liveness probe. Returns 200 with empty body when the service is running. No authentication required.
+   * @param {Object} [opts]
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: {} }>>}
+   * @throws {import("axios").AxiosError} 500 Service unhealthy or shutting down
+   */
+  function get({headers} = {}) {
+    return client({
+      url: "/healthcheck",
+      method: "get",
+      headers: headers || {}
+    });
+  }
+
+  return {
+    get
+  };
+}
+
+module.exports = healthcheckFactory;

package/src/endpoints/coltrane/info.js

@@ -0,0 +1,28 @@
+/* eslint-disable max-len */
+/**
+ * Factory for Coltrane info API (btrz-api-coltrane) — service and dependency status.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
+function infoFactory({client}) {
+  /**
+   * GET /info — get Coltrane API service status and dependency health. No authentication required.
+   * @param {Object} [opts]
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { status: number, services: Array<{ name: string, status: number }>, build?: string, instanceId?: string, commit?: string } }>>}
+   * @throws {import("axios").AxiosError} 500 Internal server error or dependency check failure
+   */
+  function get({headers} = {}) {
+    return client({
+      url: "/info",
+      headers: headers || {}
+    });
+  }
+
+  return {
+    get
+  };
+}
+
+module.exports = infoFactory;

package/src/endpoints/coltrane/paths.js

@@ -2,15 +2,16 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /paths (btrz-api-coltrane). See get-paths getSpec().
+ * Query params for GET /paths (btrz-api-coltrane). All except metrics and preferredAlgorithm are required by the API.
  * @typedef {Object} ColtranePathsListQuery
- * @property {string} [providerId] - Account ID of the travel provider (required by API)
- * @property {string} [productId] - Product ID belonging to the provider (required by API)
- * @property {string} [originId] - Origin station id (required by API)
- * @property {string} [destinationId] - Destination station id (required by API)
- * @property {string} [departureFromDate] - Start of search interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
- * @property {string} [departureToDate] - End of search interval; ISO 8601; interval max 25h
- * @property {string} [metrics] - If true, response includes metrics (debugging)
+ * @property {string} [providerId] - Account ID of the travel provider (24-char hex)
+ * @property {string} [productId] - Product ID belonging to the provider (24-char hex)
+ * @property {string} [originId] - Origin station ID (24-char hex); must differ from destinationId
+ * @property {string} [destinationId] - Destination station ID (24-char hex)
+ * @property {string} [departureFromDate] - Start of departure interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
+ * @property {string} [departureToDate] - End of departure interval; ISO 8601; interval max 25h, must be after departureFromDate
+ * @property {string} [preferredAlgorithm] - "search_algorithm_fast" or "search_algorithm_exhaustive"
+ * @property {string|boolean} [metrics] - If true, response includes metrics object (debugging)
  */
 
 /**
@@ -22,12 +23,15 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function coltraneFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /paths - list Coltrane paths.
+   * GET /paths — search for travel paths between two stations in a departure time interval.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {ColtranePathsListQuery} [opts.query] - Query params (providerId, productId, originId, destinationId, etc.)
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {ColtranePathsListQuery} [opts.query] - Query params; providerId, productId, originId, destinationId, departureFromDate, departureToDate required
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { paths: Array<{ segments: Array<{ scheduleId: string, manifestDay: string, fromLegIndex: number, toLegIndex: number }> }>, metrics?: object } }>>}
+   * @throws {import("axios").AxiosError} 400 INVALID_QUERY_PARAMETERS (invalid params, originId=destinationId, interval &gt; 25h, or invalid preferredAlgorithm)
+   * @throws {import("axios").AxiosError} 401 Unauthorized
+   * @throws {import("axios").AxiosError} 500 Internal server error
    */
   function all({token, query = {}, headers}) {
     return client({

package/test/endpoints/coltrane/healthcheck.test.js

@@ -0,0 +1,13 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("coltrane/healthcheck", () => {
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should get healthcheck (liveness)", () => {
+    axiosMock.onGet("/healthcheck").reply(expectRequest({statusCode: 200, withoutApiKey: true}));
+    return api.coltrane.healthcheck.get();
+  });
+});

package/test/endpoints/coltrane/info.test.js

@@ -0,0 +1,13 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("coltrane/info", () => {
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should get Coltrane service info (status and dependencies)", () => {
+    axiosMock.onGet("/info").reply(expectRequest({statusCode: 200, withoutApiKey: true}));
+    return api.coltrane.info.get();
+  });
+});