bcchapi 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.5] - 2024-04-24
+
+### Added
+
+- This CHANGELOG file to document changes to the project.
+
+### Changed
+
+- Updated the following dependencies:
+  - `@tsconfig/node20` from `20.1.2` to `20.1.4`
+  - `@types/node` from `20.11.5` to `2.12.7`
+  - `@typescript-eslint/eslint-plugin` from `6.19.0` to `6.21.0`
+  - `@typescript-eslint/parser` from `6.19.0` to `6.21.0`
+  - `@vitest/coverage-v8` from `1.2.1` to `1.5.1`
+  - `eslint` from `8.56.0` to `8.57.0`
+  - `prettier` from `3.2.4` to `3.2.5`
+  - `typescript` from `5.3.3` to `5.4.5`
+  - `vitest` from `1.2.1` to `1.5.1`

package/dist/client.js

@@ -22,15 +22,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = exports.Frequency = void 0;
 const querystring = __importStar(require("node:querystring"));
 const assert = __importStar(require("node:assert/strict"));
-const parsers_1 = require("./helpers/parsers");
-const is_valid_date_1 = __importDefault(require("./helpers/is-valid-date"));
+const utils_1 = require("./utils");
 var Frequency;
 (function (Frequency) {
     Frequency["Daily"] = "DAILY";
@@ -65,17 +61,17 @@ class Client {
             function: 'GetSeries',
         };
         if (since) {
-            assert.ok((0, is_valid_date_1.default)(since), '"since" is not a valid date string or Date object');
+            assert.ok((0, utils_1.isValidDate)(since), '"since" is not a valid date string or Date object');
             query.firstdate = typeof since === 'string' ? since : since.toISOString().slice(0, 10);
         }
         if (until) {
-            assert.ok((0, is_valid_date_1.default)(until), '"until" is not a valid date string or Date object');
+            assert.ok((0, utils_1.isValidDate)(until), '"until" is not a valid date string or Date object');
             query.lastdate = typeof until === 'string' ? until : until.toISOString().slice(0, 10);
         }
         if (query.firstdate && query.lastdate) {
             assert.ok(query.firstdate <= query.lastdate, 'invalid date range');
         }
-        return this.request(query).then(parsers_1.parseGetSeriesResponse);
+        return this.request(query).then(utils_1.parseGetSeriesResponse);
     }
     /**
      * Fetches the list of available series by frequency and their metadata.
@@ -87,7 +83,7 @@ class Client {
             frequency,
             function: 'SearchSeries',
         };
-        return this.request(query).then(parsers_1.parseSearchSeriesResponse);
+        return this.request(query).then(utils_1.parseSearchSeriesResponse);
     }
 }
 exports.Client = Client;

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-interface SeriesValue {
+export interface SeriesObservation {
     /**
      * Series observed date in DD-MM-YYYY format.
      */
@@ -12,7 +12,7 @@ interface SeriesValue {
      */
     statusCode: 'OK' | 'ND';
 }
-interface SeriesHistory {
+export interface SeriesHistory {
     /**
      * Series identifier.
      */
@@ -28,12 +28,12 @@ interface SeriesHistory {
     /**
      * List of series observed values.
      */
-    Obs: SeriesValue[];
+    Obs: SeriesObservation[];
 }
-type NullSeries = {
+export type NullSeries = {
     [key in keyof SeriesHistory]: null;
 };
-interface SeriesMetadata {
+export interface SeriesMetadata {
     /**
      * Series identifier.
      */
@@ -106,4 +106,3 @@ export type SearchSeriesResponse = ReadonlyArray<{
     updatedAt: string;
     createdAt: string;
 }>;
-export {};

package/dist/utils.d.ts

@@ -0,0 +1,17 @@
+import { ApiResponse, GetSeriesResponse, SearchSeriesResponse } from './types';
+/**
+ * Determines wether a given value can be parsed to a valid date.
+ */
+export declare function isValidDate(date: unknown): boolean;
+/**
+ * Reverses a date string from DD-MM-YYYY to YYYY-MM-DD format.
+ */
+export declare function reverseDate(date: string): string;
+/**
+ * Parses the GetSeries function API response.
+ */
+export declare function parseGetSeriesResponse<T extends ApiResponse>(response: T): GetSeriesResponse;
+/**
+ * Parses the SearchSeries function API response.
+ */
+export declare function parseSearchSeriesResponse<T extends ApiResponse>(response: T): SearchSeriesResponse;

package/dist/{helpers/parsers.js → utils.js}

@@ -1,18 +1,37 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseSearchSeriesResponse = exports.parseGetSeriesResponse = void 0;
-const reverse_date_1 = __importDefault(require("./reverse-date"));
-const errors_1 = require("../errors");
+exports.parseSearchSeriesResponse = exports.parseGetSeriesResponse = exports.reverseDate = exports.isValidDate = void 0;
+const errors_1 = require("./errors");
+/**
+ * Determines wether a given value can be parsed to a valid date.
+ */
+function isValidDate(date) {
+    if (typeof date === 'string') {
+        return !Number.isNaN(Date.parse(date));
+    }
+    if (date instanceof Date) {
+        return !Number.isNaN(date.getTime());
+    }
+    return false;
+}
+exports.isValidDate = isValidDate;
+/**
+ * Reverses a date string from DD-MM-YYYY to YYYY-MM-DD format.
+ */
+function reverseDate(date) {
+    return date.split('-').reverse().join('-');
+}
+exports.reverseDate = reverseDate;
+/**
+ * Parses the GetSeries function API response.
+ */
 function parseGetSeriesResponse(response) {
     if (response.Codigo !== 0) {
         switch (response.Codigo) {
             case errors_1.ErrorCodes.InvalidCredentials:
-                throw new errors_1.InvalidCredentialsError();
+                throw new errors_1.InvalidCredentialsError(response);
             case errors_1.ErrorCodes.InvalidSeries:
-                throw new errors_1.InvalidSeriesError();
+                throw new errors_1.InvalidSeriesError(response);
             default:
                 throw new errors_1.WebServiceError(response);
         }
@@ -21,19 +40,22 @@ function parseGetSeriesResponse(response) {
         seriesId: response.Series.seriesId || '',
         description: response.Series.descripIng || '',
         data: (response.Series.Obs || []).map((obs) => ({
-            date: (0, reverse_date_1.default)(obs.indexDateString),
+            date: reverseDate(obs.indexDateString),
             value: parseFloat(obs.value),
         })),
     };
 }
 exports.parseGetSeriesResponse = parseGetSeriesResponse;
+/**
+ * Parses the SearchSeries function API response.
+ */
 function parseSearchSeriesResponse(response) {
     if (response.Codigo !== 0) {
         switch (response.Codigo) {
             case errors_1.ErrorCodes.InvalidCredentials:
-                throw new errors_1.InvalidCredentialsError();
+                throw new errors_1.InvalidCredentialsError(response);
             case errors_1.ErrorCodes.InvalidFrequency:
-                throw new errors_1.InvalidFrequencyError();
+                throw new errors_1.InvalidFrequencyError(response);
             default:
                 throw new errors_1.WebServiceError(response);
         }
@@ -42,10 +64,10 @@ function parseSearchSeriesResponse(response) {
         seriesId: series.seriesId,
         frequency: series.frequencyCode,
         title: series.englishTitle,
-        firstObservedAt: (0, reverse_date_1.default)(series.firstObservation),
-        lastObservedAt: (0, reverse_date_1.default)(series.lastObservation),
-        updatedAt: (0, reverse_date_1.default)(series.updatedAt),
-        createdAt: (0, reverse_date_1.default)(series.createdAt),
+        firstObservedAt: reverseDate(series.firstObservation),
+        lastObservedAt: reverseDate(series.lastObservation),
+        updatedAt: reverseDate(series.updatedAt),
+        createdAt: reverseDate(series.createdAt),
     }));
 }
 exports.parseSearchSeriesResponse = parseSearchSeriesResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bcchapi",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "API para acceder al Web Service del Banco Central de Chile.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -28,19 +28,19 @@
   },
   "homepage": "https://github.com/airarrazaval/bcchapi#readme",
   "devDependencies": {
-    "@tsconfig/node20": "^20.1.2",
-    "@types/node": "^20.11.5",
-    "@typescript-eslint/eslint-plugin": "^6.19.0",
-    "@typescript-eslint/parser": "^6.19.0",
-    "@vitest/coverage-v8": "^1.2.1",
-    "eslint": "^8.56.0",
+    "@tsconfig/node20": "^20.1.4",
+    "@types/node": "^20.12.7",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "@vitest/coverage-v8": "^1.5.1",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
-    "prettier": "^3.2.4",
+    "prettier": "^3.2.5",
     "rimraf": "^5.0.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3",
-    "vitest": "^1.2.1"
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.1"
   },
   "engines": {
     "node": ">=18.19.0",

package/dist/helpers/is-valid-date.d.ts

@@ -1 +0,0 @@
-export default function isValidDate(date: unknown): boolean;

package/dist/helpers/is-valid-date.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function isValidDate(date) {
-    if (typeof date === 'string') {
-        return !Number.isNaN(Date.parse(date));
-    }
-    if (date instanceof Date) {
-        return !Number.isNaN(date.getTime());
-    }
-    return false;
-}
-exports.default = isValidDate;

package/dist/helpers/parsers.d.ts

@@ -1,3 +0,0 @@
-import { ApiResponse, GetSeriesResponse, SearchSeriesResponse } from '../types';
-export declare function parseGetSeriesResponse<T extends ApiResponse>(response: T): GetSeriesResponse;
-export declare function parseSearchSeriesResponse<T extends ApiResponse>(response: T): SearchSeriesResponse;

package/dist/helpers/reverse-date.d.ts

@@ -1 +0,0 @@
-export default function reverseDate(date: string): string;

package/dist/helpers/reverse-date.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function reverseDate(date) {
-    return date.split('-').reverse().join('-');
-}
-exports.default = reverseDate;