bcchapi 1.0.2 → 1.0.3

package/README.md

@@ -78,7 +78,7 @@ _Output_
 
 ### 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
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bcchapi",
-  "version": "1.0.2",
+  "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('-');
-}