bcchapi 1.0.6 → 1.0.7

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,38 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Publish to NPM
+
+on:
+  push:
+    branches: main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test -- --run
+      - run: npm run build
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/CHANGELOG.md

@@ -5,7 +5,17 @@ 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.7] - 2025-02-19
+
+### Changed
+
+- Moved API response handlers from `utils.ts` to new `handlers.ts` file
+- Improved date handling in `utils.ts`
+- Fixed date validation in client test
+- Updated dependencies:
+  - `@vitest/coverage-v8` from `^1.6.0` to `^3.0.6`
+  - `rimraf` from `^5.0.7` to `^6.0.1`
+  - `vitest` from `^1.6.0` to `^3.0.6`
 
 ## [1.0.6] - 2024-06-13
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bcchapi",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "API para acceder al Web Service del Banco Central de Chile.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -32,15 +32,15 @@
     "@types/node": "^20.14.2",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "@typescript-eslint/parser": "^6.21.0",
-    "@vitest/coverage-v8": "^1.6.0",
+    "@vitest/coverage-v8": "^3.0.6",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
     "prettier": "^3.3.2",
-    "rimraf": "^5.0.7",
+    "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5",
-    "vitest": "^1.6.0"
+    "vitest": "^3.0.6"
   },
   "engines": {
     "node": ">=18.19.0",

package/src/client.ts

@@ -1,7 +1,8 @@
 import * as querystring from 'node:querystring';
 import * as assert from 'node:assert/strict';
 import { GetSeriesResponse, SearchSeriesResponse, ApiResponse } from './types';
-import { isValidDate, parseGetSeriesResponse, parseSearchSeriesResponse } from './utils';
+import { handleGetSeriesResponse, handleSearchSeriesResponse } from './handlers';
+import { isValidDate } from './utils';
 
 export interface ClientConfig {
   /**
@@ -25,7 +26,6 @@ export class Client {
   static apiURL = 'https://si3.bcentral.cl/SieteRestWS/SieteRestWS.ashx';
 
   private username: string;
-
   private password: string;
 
   constructor(config: ClientConfig) {
@@ -33,14 +33,14 @@ export class Client {
     this.password = config.pass;
   }
 
-  async request(query: Record<string, string>): Promise<ApiResponse> {
+  async request<T extends ApiResponse>(query: Record<string, string>): Promise<T> {
     const queryString = querystring.stringify({
       user: this.username,
       pass: this.password,
       ...query,
     });
 
-    return (await fetch(`${Client.apiURL}?${queryString}`)).json() as Promise<ApiResponse>;
+    return (await fetch(`${Client.apiURL}?${queryString}`)).json() as Promise<T>;
   }
 
   /**
@@ -83,7 +83,7 @@ export class Client {
       assert.ok(query.firstdate <= query.lastdate, 'invalid date range');
     }
 
-    return this.request(query).then(parseGetSeriesResponse);
+    return this.request(query).then(handleGetSeriesResponse);
   }
 
   /**
@@ -104,6 +104,6 @@ export class Client {
       function: 'SearchSeries',
     };
 
-    return this.request(query).then(parseSearchSeriesResponse);
+    return this.request(query).then(handleSearchSeriesResponse);
   }
 }

package/src/handlers.ts

@@ -0,0 +1,69 @@
+import {
+  ErrorCodes,
+  InvalidFrequencyError,
+  InvalidCredentialsError,
+  InvalidSeriesError,
+  WebServiceError,
+} from './errors';
+import {
+  ApiResponse,
+  SeriesObservation,
+  SeriesMetadata,
+  ErrorResponse,
+  GetSeriesResponse,
+  SearchSeriesResponse,
+} from './types';
+import { reverseDate } from './utils';
+
+/**
+ * Parses the GetSeries function API response.
+ */
+export function handleGetSeriesResponse<T extends ApiResponse>(response: T): GetSeriesResponse {
+  if (response.Codigo !== 0) {
+    switch (response.Codigo) {
+      case ErrorCodes.InvalidCredentials:
+        throw new InvalidCredentialsError(response as ApiResponse as ErrorResponse);
+      case ErrorCodes.InvalidSeries:
+        throw new InvalidSeriesError(response as ApiResponse as ErrorResponse);
+      default:
+        throw new WebServiceError(response as ApiResponse as ErrorResponse);
+    }
+  }
+
+  return {
+    seriesId: response.Series.seriesId || '',
+    description: response.Series.descripIng || '',
+    data: (response.Series.Obs || []).map((obs: SeriesObservation) => ({
+      date: reverseDate(obs.indexDateString),
+      value: parseFloat(obs.value),
+    })),
+  };
+}
+
+/**
+ * Parses the SearchSeries function API response.
+ */
+export function handleSearchSeriesResponse<T extends ApiResponse>(
+  response: T,
+): SearchSeriesResponse {
+  if (response.Codigo !== 0) {
+    switch (response.Codigo) {
+      case ErrorCodes.InvalidCredentials:
+        throw new InvalidCredentialsError(response as ApiResponse as ErrorResponse);
+      case ErrorCodes.InvalidFrequency:
+        throw new InvalidFrequencyError(response as ApiResponse as ErrorResponse);
+      default:
+        throw new WebServiceError(response as ApiResponse as ErrorResponse);
+    }
+  }
+
+  return response.SeriesInfos.map((series: SeriesMetadata) => ({
+    seriesId: series.seriesId,
+    frequency: series.frequencyCode,
+    title: series.englishTitle,
+    firstObservedAt: reverseDate(series.firstObservation),
+    lastObservedAt: reverseDate(series.lastObservation),
+    updatedAt: reverseDate(series.updatedAt),
+    createdAt: reverseDate(series.createdAt),
+  }));
+}

package/src/types.ts

@@ -1,3 +1,5 @@
+export type StatusCode = 'OK' | 'ND';
+
 export interface SeriesObservation {
   /**
    * Series observed date in DD-MM-YYYY format.
@@ -10,7 +12,7 @@ export interface SeriesObservation {
   /**
    * Series observed value status code (ND = no data recorded).
    */
-  statusCode: 'OK' | 'ND';
+  statusCode: StatusCode;
 }
 
 export interface SeriesHistory {
@@ -75,20 +77,20 @@ export interface ApiResponse {
   /**
    * Response status code.
    */
-  Codigo: number;
+  readonly Codigo: number;
   /**
    * Response status message.
    */
-  Descripcion: string;
+  readonly Descripcion: string;
 
   /**
    * Series historic information.
    */
-  Series: SeriesHistory | NullSeries;
+  readonly Series: Readonly<SeriesHistory | NullSeries>;
   /**
    * Series metadata information.
    */
-  SeriesInfos: SeriesMetadata[];
+  readonly SeriesInfos: ReadonlyArray<SeriesMetadata>;
 }
 
 export interface ErrorResponse extends ApiResponse {

package/src/utils.ts

@@ -1,29 +1,24 @@
-import {
-  ErrorCodes,
-  InvalidFrequencyError,
-  InvalidCredentialsError,
-  InvalidSeriesError,
-  WebServiceError,
-} from './errors';
-import {
-  ApiResponse,
-  SeriesObservation,
-  SeriesMetadata,
-  ErrorResponse,
-  GetSeriesResponse,
-  SearchSeriesResponse,
-} from './types';
-
 /**
  * Determines wether a given value can be parsed to a valid date.
  */
 export function isValidDate(date: unknown): boolean {
   if (typeof date === 'string') {
-    return !Number.isNaN(Date.parse(date));
-  }
-  if (date instanceof Date) {
+    // Validate format YYYY-MM-DD
+    const isISOString = date.match(/^\d{4}-\d{2}-\d{2}$/);
+
+    if (!isISOString) {
+      return false;
+    }
+
+    // Validate parsed date timestamp
+    const timestamp = Date.parse(date);
+
+    return !Number.isNaN(timestamp);
+  } else if (date instanceof Date) {
+    // Validate date object
     return !Number.isNaN(date.getTime());
   }
+  // Is invalid date
   return false;
 }
 
@@ -31,58 +26,12 @@ export function isValidDate(date: unknown): boolean {
  * Reverses a date string from DD-MM-YYYY to YYYY-MM-DD format.
  */
 export function reverseDate(date: string): string {
-  return date.split('-').reverse().join('-');
-}
-
-/**
- * Parses the GetSeries function API response.
- */
-export function parseGetSeriesResponse<T extends ApiResponse>(response: T): GetSeriesResponse {
-  if (response.Codigo !== 0) {
-    switch (response.Codigo) {
-      case ErrorCodes.InvalidCredentials:
-        throw new InvalidCredentialsError(response as ApiResponse as ErrorResponse);
-      case ErrorCodes.InvalidSeries:
-        throw new InvalidSeriesError(response as ApiResponse as ErrorResponse);
-      default:
-        throw new WebServiceError(response as ApiResponse as ErrorResponse);
-    }
+  if (/^\d{4}-\d{2}-\d{2}$/.test(date)) {
+    return date;
   }
 
-  return {
-    seriesId: response.Series.seriesId || '',
-    description: response.Series.descripIng || '',
-    data: (response.Series.Obs || []).map((obs: SeriesObservation) => ({
-      date: reverseDate(obs.indexDateString),
-      value: parseFloat(obs.value),
-    })),
-  };
-}
-
-/**
- * Parses the SearchSeries function API response.
- */
-export function parseSearchSeriesResponse<T extends ApiResponse>(
-  response: T,
-): SearchSeriesResponse {
-  if (response.Codigo !== 0) {
-    switch (response.Codigo) {
-      case ErrorCodes.InvalidCredentials:
-        throw new InvalidCredentialsError(response as ApiResponse as ErrorResponse);
-      case ErrorCodes.InvalidFrequency:
-        throw new InvalidFrequencyError(response as ApiResponse as ErrorResponse);
-      default:
-        throw new WebServiceError(response as ApiResponse as ErrorResponse);
-    }
+  if (!/^\d{2}-\d{2}-\d{4}$/.test(date)) {
+    throw new Error('Invalid date format. Expected DD-MM-YYYY');
   }
-
-  return response.SeriesInfos.map((series: SeriesMetadata) => ({
-    seriesId: series.seriesId,
-    frequency: series.frequencyCode,
-    title: series.englishTitle,
-    firstObservedAt: reverseDate(series.firstObservation),
-    lastObservedAt: reverseDate(series.lastObservation),
-    updatedAt: reverseDate(series.updatedAt),
-    createdAt: reverseDate(series.createdAt),
-  }));
+  return date.split('-').reverse().join('-');
 }

package/test/client.test.ts

@@ -112,8 +112,8 @@ describe('Client', () => {
       expect(series.data).toHaveLength(15);
 
       for (let i = 0; i < series.data.length; i += 1) {
-        expect(reverseDate(series.data[i].date)).toBe(
-          fixtures.response.getSeriesSuccess.Series.Obs[i].indexDateString,
+        expect(series.data[i].date).toBe(
+          reverseDate(fixtures.response.getSeriesSuccess.Series.Obs[i].indexDateString),
         );
         expect(series.data[i].value.toFixed(2)).toBe(
           fixtures.response.getSeriesSuccess.Series.Obs[i].value,
@@ -140,8 +140,8 @@ describe('Client', () => {
       expect(series.data).toHaveLength(5);
 
       for (let i = 0; i < series.data.length; i += 1) {
-        expect(reverseDate(series.data[i].date)).toBe(
-          fixtures.response.getSeriesSuccess.Series.Obs[i].indexDateString,
+        expect(series.data[i].date).toBe(
+          reverseDate(fixtures.response.getSeriesSuccess.Series.Obs[i].indexDateString),
         );
         expect(series.data[i].value.toFixed(2)).toBe(
           fixtures.response.getSeriesSuccess.Series.Obs[i].value,

package/test/{utils/parse-get-series.test.ts → handlers/handle-get-series.test.ts}

@@ -1,12 +1,12 @@
 import { describe, it, expect } from 'vitest';
 import * as Errors from '../../src/errors';
-import { parseGetSeriesResponse } from '../../src/utils';
+import { handleGetSeriesResponse } from '../../src/handlers';
 import { ApiResponse } from '../../src/types';
 import fixtures from '../fixtures';
 
-describe('parseGetSeriesResponse', () => {
+describe('handleGetSeriesResponse', () => {
   it('should parse correctly a valid response', () => {
-    const parsed = parseGetSeriesResponse(
+    const parsed = handleGetSeriesResponse(
       fixtures.response.getSeriesSuccess as unknown as ApiResponse,
     );
 
@@ -29,17 +29,17 @@ describe('parseGetSeriesResponse', () => {
 
   it('should throw an InvalidCredentialsError if the response code is -5', () => {
     expect(() =>
-      parseGetSeriesResponse(fixtures.response.credentialsInvalid as unknown as ApiResponse),
+      handleGetSeriesResponse(fixtures.response.credentialsInvalid as unknown as ApiResponse),
     ).toThrow(Errors.InvalidCredentialsError);
   });
 
   it('should throw an InvalidSeriesError if the response code is -50', () => {
     expect(() =>
-      parseGetSeriesResponse(fixtures.response.getSeriesInvalid as unknown as ApiResponse),
+      handleGetSeriesResponse(fixtures.response.getSeriesInvalid as unknown as ApiResponse),
     ).toThrow(Errors.InvalidSeriesError);
   });
 
   it('should throw a ResponseError if the response code is unknown', () => {
-    expect(() => parseGetSeriesResponse({} as ApiResponse)).toThrow(Errors.WebServiceError);
+    expect(() => handleGetSeriesResponse({} as ApiResponse)).toThrow(Errors.WebServiceError);
   });
 });

package/test/{utils/parse-search-series.test.ts → handlers/handle-search-series.test.ts}

@@ -1,12 +1,12 @@
 import { describe, it, expect } from 'vitest';
 import * as Errors from '../../src/errors';
 import { ApiResponse } from '../../src/types';
-import { parseSearchSeriesResponse } from '../../src/utils';
+import { handleSearchSeriesResponse } from '../../src/handlers';
 import fixtures from '../fixtures';
 
-describe('parseSearchSeriesResponse', () => {
+describe('handleSearchSeriesResponse', () => {
   it('should parse correctly a valid response', () => {
-    const parsed = parseSearchSeriesResponse(
+    const parsed = handleSearchSeriesResponse(
       fixtures.response.searchSeriesSuccess as unknown as ApiResponse,
     );
 
@@ -32,17 +32,17 @@ describe('parseSearchSeriesResponse', () => {
 
   it('should throw an InvalidCredentialsError if the response code is -5', () => {
     expect(() =>
-      parseSearchSeriesResponse(fixtures.response.credentialsInvalid as unknown as ApiResponse),
+      handleSearchSeriesResponse(fixtures.response.credentialsInvalid as unknown as ApiResponse),
     ).toThrow(Errors.InvalidCredentialsError);
   });
 
   it('should throw an InvalidFrequencyError if the response code is -1', () => {
     expect(() =>
-      parseSearchSeriesResponse(fixtures.response.searchSeriesInvalid as unknown as ApiResponse),
+      handleSearchSeriesResponse(fixtures.response.searchSeriesInvalid as unknown as ApiResponse),
     ).toThrow(Errors.InvalidFrequencyError);
   });
 
   it('should throw a ResponseError if the response code is unknown', () => {
-    expect(() => parseSearchSeriesResponse({} as ApiResponse)).toThrow(Errors.WebServiceError);
+    expect(() => handleSearchSeriesResponse({} as ApiResponse)).toThrow(Errors.WebServiceError);
   });
 });

package/dist/client.d.ts

@@ -1,50 +0,0 @@
-import { GetSeriesResponse, SearchSeriesResponse, ApiResponse } from './types';
-export interface ClientConfig {
-    /**
-     * Client username (registered email).
-     */
-    user: string;
-    /**
-     * Client password.
-     */
-    pass: string;
-}
-export declare enum Frequency {
-    Daily = "DAILY",
-    Monthly = "MONTHLY",
-    Quarterly = "QUARTERLY",
-    Annual = "ANNUAL"
-}
-export declare class Client {
-    static apiURL: string;
-    private username;
-    private password;
-    constructor(config: ClientConfig);
-    request(query: Record<string, string>): Promise<ApiResponse>;
-    /**
-     * Fetches the list of observed values for a given series.
-     */
-    getSeries(params: {
-        /**
-         * Series identifier.
-         */
-        series: string;
-        /**
-         * First date of the range to fetch.
-         */
-        since?: string | Date;
-        /**
-         * Last date of the range to fetch.
-         */
-        until?: string | Date;
-    }): Promise<GetSeriesResponse>;
-    /**
-     * Fetches the list of available series by frequency and their metadata.
-     */
-    searchSeries(params: {
-        /**
-         * Frequency for which you want to consult the catalog of available series.
-         */
-        frequency: Frequency;
-    }): Promise<SearchSeriesResponse>;
-}

package/dist/client.js

@@ -1,89 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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 utils_1 = require("./utils");
-var Frequency;
-(function (Frequency) {
-    Frequency["Daily"] = "DAILY";
-    Frequency["Monthly"] = "MONTHLY";
-    Frequency["Quarterly"] = "QUARTERLY";
-    Frequency["Annual"] = "ANNUAL";
-})(Frequency || (exports.Frequency = Frequency = {}));
-class Client {
-    static apiURL = 'https://si3.bcentral.cl/SieteRestWS/SieteRestWS.ashx';
-    username;
-    password;
-    constructor(config) {
-        this.username = config.user;
-        this.password = config.pass;
-    }
-    async request(query) {
-        const queryString = querystring.stringify({
-            user: this.username,
-            pass: this.password,
-            ...query,
-        });
-        return (await fetch(`${Client.apiURL}?${queryString}`)).json();
-    }
-    /**
-     * Fetches the list of observed values for a given series.
-     */
-    async getSeries(params) {
-        const { series, since, until } = params;
-        assert.ok(series && typeof series === 'string', 'series must be a non-empty string');
-        const query = {
-            timeseries: series,
-            function: 'GetSeries',
-        };
-        if (since) {
-            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, 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(utils_1.parseGetSeriesResponse);
-    }
-    /**
-     * Fetches the list of available series by frequency and their metadata.
-     */
-    async searchSeries(params) {
-        const { frequency } = params;
-        assert.ok(frequency && typeof frequency === 'string', 'frequency must be a non-empty string');
-        const query = {
-            frequency,
-            function: 'SearchSeries',
-        };
-        return this.request(query).then(utils_1.parseSearchSeriesResponse);
-    }
-}
-exports.Client = Client;

package/dist/errors.d.ts

@@ -1,21 +0,0 @@
-import { ErrorResponse } from './types';
-export declare enum ErrorCodes {
-    InvalidCredentials = -5,
-    InvalidFrequency = -1,
-    InvalidSeries = -50,
-    InvalidDateRange = -1,
-    Unknown = -1
-}
-export declare class WebServiceError extends Error {
-    response?: ErrorResponse;
-    constructor(response?: ErrorResponse, message?: string);
-}
-export declare class InvalidFrequencyError extends WebServiceError {
-    constructor(response?: ErrorResponse);
-}
-export declare class InvalidCredentialsError extends WebServiceError {
-    constructor(response?: ErrorResponse);
-}
-export declare class InvalidSeriesError extends WebServiceError {
-    constructor(response?: ErrorResponse);
-}

package/dist/errors.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidSeriesError = exports.InvalidCredentialsError = exports.InvalidFrequencyError = exports.WebServiceError = exports.ErrorCodes = void 0;
-var ErrorCodes;
-(function (ErrorCodes) {
-    ErrorCodes[ErrorCodes["InvalidCredentials"] = -5] = "InvalidCredentials";
-    ErrorCodes[ErrorCodes["InvalidFrequency"] = -1] = "InvalidFrequency";
-    ErrorCodes[ErrorCodes["InvalidSeries"] = -50] = "InvalidSeries";
-    ErrorCodes[ErrorCodes["InvalidDateRange"] = -1] = "InvalidDateRange";
-    ErrorCodes[ErrorCodes["Unknown"] = -1] = "Unknown";
-})(ErrorCodes || (exports.ErrorCodes = ErrorCodes = {}));
-class WebServiceError extends Error {
-    response;
-    constructor(response, message) {
-        super(message || response?.Descripcion || 'Unknown service error');
-        this.response = response;
-    }
-}
-exports.WebServiceError = WebServiceError;
-class InvalidFrequencyError extends WebServiceError {
-    constructor(response) {
-        super(response, 'Invalid frequency code (must be DAILY, MONTHLY, QUARTERLY or ANNUAL)');
-    }
-}
-exports.InvalidFrequencyError = InvalidFrequencyError;
-class InvalidCredentialsError extends WebServiceError {
-    constructor(response) {
-        super(response, 'Invalid username or password');
-    }
-}
-exports.InvalidCredentialsError = InvalidCredentialsError;
-class InvalidSeriesError extends WebServiceError {
-    constructor(response) {
-        super(response, 'Invalid series id');
-    }
-}
-exports.InvalidSeriesError = InvalidSeriesError;

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export { Client, ClientConfig, Frequency } from './client';
-export { ApiResponse, ErrorResponse, GetSeriesResponse, SearchSeriesResponse } from './types';
-export { WebServiceError, InvalidCredentialsError, InvalidFrequencyError, InvalidSeriesError, } from './errors';

package/dist/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidSeriesError = exports.InvalidFrequencyError = exports.InvalidCredentialsError = exports.WebServiceError = exports.Frequency = exports.Client = void 0;
-var client_1 = require("./client");
-Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
-Object.defineProperty(exports, "Frequency", { enumerable: true, get: function () { return client_1.Frequency; } });
-var errors_1 = require("./errors");
-Object.defineProperty(exports, "WebServiceError", { enumerable: true, get: function () { return errors_1.WebServiceError; } });
-Object.defineProperty(exports, "InvalidCredentialsError", { enumerable: true, get: function () { return errors_1.InvalidCredentialsError; } });
-Object.defineProperty(exports, "InvalidFrequencyError", { enumerable: true, get: function () { return errors_1.InvalidFrequencyError; } });
-Object.defineProperty(exports, "InvalidSeriesError", { enumerable: true, get: function () { return errors_1.InvalidSeriesError; } });

package/dist/types.d.ts

@@ -1,108 +0,0 @@
-export interface SeriesObservation {
-    /**
-     * Series observed date in DD-MM-YYYY format.
-     */
-    indexDateString: string;
-    /**
-     * Series observed value.
-     */
-    value: string;
-    /**
-     * Series observed value status code (ND = no data recorded).
-     */
-    statusCode: 'OK' | 'ND';
-}
-export interface SeriesHistory {
-    /**
-     * Series identifier.
-     */
-    seriesId: string;
-    /**
-     * Series name in Spanish.
-     */
-    descripEsp: string;
-    /**
-     * Series name in English.
-     */
-    descripIng: string;
-    /**
-     * List of series observed values.
-     */
-    Obs: SeriesObservation[];
-}
-export type NullSeries = {
-    [key in keyof SeriesHistory]: null;
-};
-export interface SeriesMetadata {
-    /**
-     * Series identifier.
-     */
-    seriesId: string;
-    /**
-     * Series frequency.
-     */
-    frequencyCode: string;
-    /**
-     * Series name in Spanish.
-     */
-    spanishTitle: string;
-    /**
-     * Series name in English.
-     */
-    englishTitle: string;
-    /**
-     * Date of first observation in DD-MM-YYYY format.
-     */
-    firstObservation: string;
-    /**
-     * Date of last observation in DD-MM-YYYY format.
-     */
-    lastObservation: string;
-    /**
-     * Date of last update in DD-MM-YYYY format.
-     */
-    updatedAt: string;
-    /**
-     * Date of creation in DD-MM-YYYY format.
-     */
-    createdAt: string;
-}
-export interface ApiResponse {
-    /**
-     * Response status code.
-     */
-    Codigo: number;
-    /**
-     * Response status message.
-     */
-    Descripcion: string;
-    /**
-     * Series historic information.
-     */
-    Series: SeriesHistory | NullSeries;
-    /**
-     * Series metadata information.
-     */
-    SeriesInfos: SeriesMetadata[];
-}
-export interface ErrorResponse extends ApiResponse {
-    Series: NullSeries;
-    SeriesInfos: never[];
-}
-export interface GetSeriesResponse {
-    seriesId: string;
-    description: string;
-    data: ReadonlyArray<{
-        date: string;
-        value: number;
-    }>;
-}
-export type SearchSeriesResponse = ReadonlyArray<{
-    seriesId: string;
-    frequency: string;
-    title: string;
-    firstObservedAt: string;
-    lastObservedAt: string;
-    updatedAt: string;
-    createdAt: string;
-}>;

package/dist/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.d.ts

@@ -1,17 +0,0 @@
-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/utils.js

@@ -1,73 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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(response);
-            case errors_1.ErrorCodes.InvalidSeries:
-                throw new errors_1.InvalidSeriesError(response);
-            default:
-                throw new errors_1.WebServiceError(response);
-        }
-    }
-    return {
-        seriesId: response.Series.seriesId || '',
-        description: response.Series.descripIng || '',
-        data: (response.Series.Obs || []).map((obs) => ({
-            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(response);
-            case errors_1.ErrorCodes.InvalidFrequency:
-                throw new errors_1.InvalidFrequencyError(response);
-            default:
-                throw new errors_1.WebServiceError(response);
-        }
-    }
-    return response.SeriesInfos.map((series) => ({
-        seriesId: series.seriesId,
-        frequency: series.frequencyCode,
-        title: series.englishTitle,
-        firstObservedAt: reverseDate(series.firstObservation),
-        lastObservedAt: reverseDate(series.lastObservation),
-        updatedAt: reverseDate(series.updatedAt),
-        createdAt: reverseDate(series.createdAt),
-    }));
-}
-exports.parseSearchSeriesResponse = parseSearchSeriesResponse;