bcchapi 1.0.1 → 1.0.3

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Alfredo Irarrazaval
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -6,7 +6,7 @@ The Central Bank of Chile provides a web service that allows searching and extra
 
 The API currently supports only to functions: `GetSeries` (default) used for retrieveng historical data on a specific series, and `SearchSeries` used for searching series by frequency code (ie: daily, monthly, quearterly or yearly).
 
-For further information on how to use the API directly, please refer to the [official documentation](https://si3.bcentral.cl/estadisticas/Principal1/Web_Services/doc_en.htm).
+For further information on how to use the API directly, please refer to the [official documentation](https://si3.bcentral.cl/estadisticas/Principal1/Web_Services/doc_en.htm). Usage of the API is subject to the restrictions defined in the [Terms and Conditions](https://si3.bcentral.cl/estadisticas/Principal1/Web_Services/index_BDE_TC.htm) of the Statistical Data Base API of the Central Bank of Chile. As of January of 2024, **the API allows up to 5 requests per second per user**.
 
 ## Installation
 
@@ -18,10 +18,10 @@ npm i -S bcchapi
 
 ```javascript
 // ESM
-import Client from 'bcchapi';
+import { Client } from 'bcchapi';
 
 // CommonJS
-const Client = require('bcchapi');
+const { Client } = require('bcchapi');
 ```
 
 ### Authentication
@@ -35,20 +35,20 @@ const client = new Client({
 });
 ```
 
-
 ### GetSeries
 
 Allows you to retrieve historic data series.
 
+- Series Catalogue: [EN](https://si3.bcentral.cl/estadisticas/Principal1/Web_Services/Webservices/series_EN.xlsx) | [ES](https://si3.bcentral.cl/estadisticas/Principal1/Web_Services/Webservices/series.xlsx)
+
 #### Parameters
 
 | name   | type               | required | description                     | example                |
-|--------|--------------------|----------|---------------------------------|------------------------|
+| ------ | ------------------ | -------- | ------------------------------- | ---------------------- |
 | series | `string`           | Yes      | The series identifier           | `'F072.EUR.USD.N.O.D'` |
 | since  | `string` or `Date` | No       | The starting date of the series | `'2020-12-01'`         |
 | until  | `string` or `Date` | No       | The ending date of the series   | `'2020-12-02'`         |
 
-
 > **NOTE**: The API does not implements pagination, so if you need to retrieve a large amount of data, you should use the `since` and `until` parameters to split the request into smaller chunks.
 
 #### Example
@@ -63,7 +63,8 @@ const series = await client.getSeries({
 console.log(series);
 ```
 
-*Output*
+_Output_
+
 ```js
 {
   seriesId: 'F072.EUR.USD.N.O.D',
@@ -77,26 +78,26 @@ console.log(series);
 
 ### SearchSeries
 
-Allows you to search for series by their frequency code (ie: daily, weekly, monthly, yearly).
+Allows you to search for series by their frequency code (ie: daily, monthly, quarterly, yearly).
 
 #### Parameters
 
 | name      | type     | required | description                                                              | example   |
-|-----------|----------|----------|--------------------------------------------------------------------------|-----------|
+| --------- | -------- | -------- | ------------------------------------------------------------------------ | --------- |
 | frequency | `string` | Yes      | The frequency code to search (`DAILY`, `MONTHLY`, `QUARTERLY`, `ANNUAL`) | `'DAILY'` |
 
-
 #### Example
 
 ```js
-import { Frequency } from 'bcchapi';
+import { Frequency } from 'bcchapi';
 
 const result = await client.searchSeries({ frequency: Frequency.DAILY });
 
 console.log(result);
 ```
 
-*Output*
+_Output_
+
 ```js
 [
   ...
@@ -121,4 +122,3 @@ console.log(result);
   ...
 ]
 ```
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bcchapi",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "API para acceder al Web Service del Banco Central de Chile.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/client.ts

@@ -1,8 +1,7 @@
 import * as querystring from 'node:querystring';
 import * as assert from 'node:assert/strict';
 import { GetSeriesResponse, SearchSeriesResponse, ApiResponse } from './types';
-import { parseGetSeriesResponse, parseSearchSeriesResponse } from './helpers/parsers';
-import isValidDate from './helpers/is-valid-date';
+import { isValidDate, parseGetSeriesResponse, parseSearchSeriesResponse } from './utils';
 
 export interface ClientConfig {
   /**

package/src/types.ts

@@ -1,4 +1,4 @@
-interface SeriesValue {
+export interface SeriesObservation {
   /**
    * Series observed date in DD-MM-YYYY format.
    */
@@ -13,7 +13,7 @@ interface SeriesValue {
   statusCode: 'OK' | 'ND';
 }
 
-interface SeriesHistory {
+export interface SeriesHistory {
   /**
    * Series identifier.
    */
@@ -29,14 +29,14 @@ 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.
    */

package/src/{helpers/parsers.ts → utils.ts}

@@ -1,20 +1,49 @@
-import reverseDate from './reverse-date';
 import {
   ErrorCodes,
   InvalidFrequencyError,
   InvalidCredentialsError,
   InvalidSeriesError,
   WebServiceError,
-} from '../errors';
-import { ApiResponse, ErrorResponse, GetSeriesResponse, SearchSeriesResponse } from '../types';
+} 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) {
+    return !Number.isNaN(date.getTime());
+  }
+  return false;
+}
+
+/**
+ * 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();
+        throw new InvalidCredentialsError(response as ApiResponse as ErrorResponse);
       case ErrorCodes.InvalidSeries:
-        throw new InvalidSeriesError();
+        throw new InvalidSeriesError(response as ApiResponse as ErrorResponse);
       default:
         throw new WebServiceError(response as ApiResponse as ErrorResponse);
     }
@@ -23,28 +52,31 @@ export function parseGetSeriesResponse<T extends ApiResponse>(response: T): GetS
   return {
     seriesId: response.Series.seriesId || '',
     description: response.Series.descripIng || '',
-    data: (response.Series.Obs || []).map((obs) => ({
+    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();
+        throw new InvalidCredentialsError(response as ApiResponse as ErrorResponse);
       case ErrorCodes.InvalidFrequency:
-        throw new InvalidFrequencyError();
+        throw new InvalidFrequencyError(response as ApiResponse as ErrorResponse);
       default:
         throw new WebServiceError(response as ApiResponse as ErrorResponse);
     }
   }
 
-  return response.SeriesInfos.map((series) => ({
+  return response.SeriesInfos.map((series: SeriesMetadata) => ({
     seriesId: series.seriesId,
     frequency: series.frequencyCode,
     title: series.englishTitle,

package/test/client.test.ts

@@ -6,9 +6,9 @@ import {
   InvalidSeriesError,
   InvalidFrequencyError,
 } from '../src';
+import { reverseDate } from '../src/utils';
 import fetchMock from './mocks/fetch.mock';
 import fixtures from './fixtures';
-import reverseDate from '../src/helpers/reverse-date';
 
 const fetchSpy = vi.spyOn(global, 'fetch').mockImplementation(fetchMock);
 

package/test/mocks/fetch.mock.ts

@@ -1,5 +1,5 @@
 import { Frequency } from '../../src/client';
-import reverseDate from '../../src/helpers/reverse-date';
+import { reverseDate } from '../../src/utils';
 import fixtures from '../fixtures';
 
 export default (input: string | URL | Request) => {

package/test/{helpers → utils}/is-valid-date.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import isValidDate from '../../src/helpers/is-valid-date';
+import { isValidDate } from '../../src/utils';
 
 describe('isValidDate', () => {
   it('should return true if the date is valid', () => {

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

@@ -1,6 +1,6 @@
 import { describe, it, expect } from 'vitest';
 import * as Errors from '../../src/errors';
-import { parseGetSeriesResponse } from '../../src/helpers/parsers';
+import { parseGetSeriesResponse } from '../../src/utils';
 import { ApiResponse } from '../../src/types';
 import fixtures from '../fixtures';
 

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

@@ -1,7 +1,7 @@
 import { describe, it, expect } from 'vitest';
 import * as Errors from '../../src/errors';
 import { ApiResponse } from '../../src/types';
-import { parseSearchSeriesResponse } from '../../src/helpers/parsers';
+import { parseSearchSeriesResponse } from '../../src/utils';
 import fixtures from '../fixtures';
 
 describe('parseSearchSeriesResponse', () => {

package/test/{helpers → utils}/reverse-date.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import reverseDate from '../../src/helpers/reverse-date';
+import { reverseDate } from '../../src/utils';
 
 describe('reverseDate', () => {
   it('should reverse correctly a date in DD-MM-YYYY format', () => {

package/src/helpers/is-valid-date.ts

@@ -1,9 +0,0 @@
-export default function isValidDate(date: unknown): boolean {
-  if (typeof date === 'string') {
-    return !Number.isNaN(Date.parse(date));
-  }
-  if (date instanceof Date) {
-    return !Number.isNaN(date.getTime());
-  }
-  return false;
-}

package/src/helpers/reverse-date.ts

@@ -1,3 +0,0 @@
-export default function reverseDate(date: string): string {
-  return date.split('-').reverse().join('-');
-}