bcchapi 1.0.0 → 1.0.1

package/test/mocks/fetch.mock.ts

@@ -1,5 +1,5 @@
-import { Frequency } from '../../src/response';
-import { reverseDate } from '../../src/helpers';
+import { Frequency } from '../../src/client';
+import reverseDate from '../../src/helpers/reverse-date';
 import fixtures from '../fixtures';
 
 export default (input: string | URL | Request) => {
@@ -11,7 +11,7 @@ export default (input: string | URL | Request) => {
       json: () => Promise.resolve(fixtures.response.credentialsInvalid),
     } as Response);
   }
-  
+
   if (func === 'GetSeries') {
     if (fixtures.response.getSeriesSuccess.Series.seriesId !== params.get('timeseries')) {
       return Promise.resolve({
@@ -21,15 +21,17 @@ export default (input: string | URL | Request) => {
 
     const firstDate = params.get('firstdate');
     const lastDate = params.get('lastdate');
-    const obs = fixtures.response.getSeriesSuccess.Series.Obs.filter((obs) => {
+    const obs = fixtures.response.getSeriesSuccess.Series.Obs.filter((o) => {
       if (firstDate && lastDate) {
-        return reverseDate(obs.indexDateString) >= firstDate && reverseDate(obs.indexDateString) <= lastDate;
+        return (
+          reverseDate(o.indexDateString) >= firstDate && reverseDate(o.indexDateString) <= lastDate
+        );
       }
       if (firstDate) {
-        return reverseDate(obs.indexDateString) >= firstDate;
+        return reverseDate(o.indexDateString) >= firstDate;
       }
       if (lastDate) {
-        return reverseDate(obs.indexDateString) <= lastDate;
+        return reverseDate(o.indexDateString) <= lastDate;
       }
       return true;
     });
@@ -39,10 +41,11 @@ export default (input: string | URL | Request) => {
     };
 
     return Promise.resolve({
-      json: () => Promise.resolve({
-        ...fixtures.response.getSeriesSuccess,
-        Series: series,
-      }),
+      json: () =>
+        Promise.resolve({
+          ...fixtures.response.getSeriesSuccess,
+          Series: series,
+        }),
     } as Response);
   }
 
@@ -57,7 +60,9 @@ export default (input: string | URL | Request) => {
 
     const response = {
       ...fixtures.response.searchSeriesSuccess,
-      SeriesInfo: fixtures.response.searchSeriesSuccess.SeriesInfos.filter((series) => series.frequencyCode === frequency),
+      SeriesInfo: fixtures.response.searchSeriesSuccess.SeriesInfos.filter(
+        (series) => series.frequencyCode === frequency,
+      ),
     };
 
     return Promise.resolve({
@@ -68,4 +73,4 @@ export default (input: string | URL | Request) => {
   return Promise.resolve({
     json: () => Promise.resolve({}),
   } as Response);
-}
+};

package/tsconfig.eslint.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {},
+  "include": ["./src", "./test"]
+}

package/tsconfig.json

@@ -3,7 +3,7 @@
   "compilerOptions": {
     "outDir": "dist",
     "resolveJsonModule": true,
-    "declaration": true,
+    "declaration": true
   },
   "include": ["src/**/*"]
 }

package/src/helpers.ts

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

package/src/response.ts

@@ -1,175 +0,0 @@
-import {
-  ErrorCodes,
-  InvalidFrequencyError,
-  InvalidCredentialsError,
-  InvalidSeriesError,
-  WebServiceError,
-} from './errors';
-import { reverseDate } from './helpers';
-
-export enum Frequency {
-  Daily = 'DAILY',
-  Monthly = 'MONTHLY',
-  Quarterly = 'QUARTERLY',
-  Annual = 'ANNUAL',
-}
-
-interface SeriesValue {
-  /**
-   * 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';
-}
-
-interface SeriesHistory {
-  /**
-   * Series identifier.
-   */
-  seriesId: string;
-  /**
-   * Series name in Spanish.
-   */
-  descripEsp: string;
-  /**
-   * Series name in English.
-   */
-  descripIng: string;
-  /**
-   * List of series observed values.
-   */
-  Obs: SeriesValue[];
-}
-
-interface SeriesMetadata {
-  /**
-   * Series identifier.
-   */
-  seriesId: string;
-  /**
-   * Series frequency (DAILY, MONTHLY, QUARTERLY, ANNUAL).
-   */
-  frequencyCode: Frequency;
-  /**
-   * 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 | {
-    [key in keyof SeriesHistory]: null;
-  };
-  /**
-   * Series metadata information.
-   */
-  SeriesInfos: SeriesMetadata[];
-}
-
-export interface ErrorResponse extends ApiResponse {
-  Series: {
-    [key in keyof SeriesHistory]: null;
-  };
-  SeriesInfos: never[];
-}
-
-export type GetSeriesResponse = {
-  seriesId: string;
-  description: string;
-  data: ReadonlyArray<{ date: string; value: number; }>;
-}
-
-export type SearchSeriesResponse = ReadonlyArray<{
-  seriesId: string;
-  frequency: Frequency;
-  title: string;
-  firstObservedAt: string;
-  lastObservedAt: string;
-  updatedAt: string;
-  createdAt: string;
-}>;
-
-export function parseGetSeriesResponse<T extends ApiResponse>(response: T): GetSeriesResponse {
-  if (response.Codigo !== 0) {
-    switch (response.Codigo) {
-      case ErrorCodes.InvalidCredentials:
-        throw new InvalidCredentialsError();
-      case ErrorCodes.InvalidSeries:
-        throw new InvalidSeriesError();
-      default:
-        throw new WebServiceError(response as ApiResponse as ErrorResponse);
-    }
-  }
-
-  return {
-    seriesId: response.Series.seriesId || '',
-    description: response.Series.descripIng || '',
-    data: (response.Series.Obs || []).map((obs) => ({
-      date: reverseDate(obs.indexDateString),
-      value: parseFloat(obs.value),
-    })),
-  };
-}
-
-export function parseSearchSeriesResponse<T extends ApiResponse>(response: T): SearchSeriesResponse {
-  if (response.Codigo !== 0) {
-    switch (response.Codigo) {
-      case ErrorCodes.InvalidCredentials:
-        throw new InvalidCredentialsError();
-      case ErrorCodes.InvalidFrequency:
-        throw new InvalidFrequencyError();
-      default:
-        throw new WebServiceError(response as ApiResponse as ErrorResponse);
-    }
-  }
-  console.log(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),
-  }));
-}

package/test/response.test.ts

@@ -1,71 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import * as Errors from '../src/errors';
-import {
-  ApiResponse,
-  parseGetSeriesResponse,
-  parseSearchSeriesResponse,
-} from '../src/response';
-import fixtures from './fixtures';
-
-describe('parseGetSeriesResponse', () => {
-  it('should parse correctly a valid response', () => {
-    const parsed = parseGetSeriesResponse(fixtures.response.getSeriesSuccess as unknown as ApiResponse);
-
-    expect(parsed).toBeDefined();
-    expect(parsed.seriesId).toBe(fixtures.response.getSeriesSuccess.Series.seriesId);
-    expect(parsed.description).toBe(fixtures.response.getSeriesSuccess.Series.descripIng);
-    expect(parsed.data).toHaveLength(fixtures.response.getSeriesSuccess.Series.Obs.length);
-    
-    for (let i = 0; i < parsed.data.length; i += 1) {
-      expect(parsed.data[i].date).toMatch(/^\d{4}-\d{2}-\d{2}$/);
-      expect(parsed.data[i].value.toFixed(2)).toBe(fixtures.response.getSeriesSuccess.Series.Obs[i].value);
-
-      if (Number.isNaN(parsed.data[i].value)) {
-        expect(fixtures.response.getSeriesSuccess.Series.Obs[i].statusCode).toBe('ND');
-      }
-    }
-  });
-
-  it('should throw an InvalidCredentialsError if the response code is -5', () => {
-    expect(() => parseGetSeriesResponse(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)).toThrow(Errors.InvalidSeriesError);
-  });
-
-  it('should throw a ResponseError if the response code is unknown', () => {
-    expect(() => parseGetSeriesResponse({} as ApiResponse)).toThrow(Errors.WebServiceError);
-  });
-});
-
-describe('parseSearchSeriesResponse', () => {
-  it('should parse correctly a valid response', () => {
-    const parsed = parseSearchSeriesResponse(fixtures.response.searchSeriesSuccess as unknown as ApiResponse);
-
-    expect(parsed).toBeInstanceOf(Array);
-    expect(parsed).toHaveLength(fixtures.response.searchSeriesSuccess.SeriesInfos.length);
-
-    for (let i = 0; i < parsed.length; i += 1) {
-      expect(parsed[i].seriesId).toBe(fixtures.response.searchSeriesSuccess.SeriesInfos[i].seriesId);
-      expect(parsed[i].frequency).toBe(fixtures.response.searchSeriesSuccess.SeriesInfos[i].frequencyCode);
-      expect(parsed[i].title).toBe(fixtures.response.searchSeriesSuccess.SeriesInfos[i].englishTitle);
-      expect(parsed[i].firstObservedAt).toMatch(/^\d{4}-\d{2}-\d{2}$/);
-      expect(parsed[i].lastObservedAt).toMatch(/^\d{4}-\d{2}-\d{2}$/);
-      expect(parsed[i].updatedAt).toMatch(/^\d{4}-\d{2}-\d{2}$/);
-      expect(parsed[i].createdAt).toMatch(/^\d{4}-\d{2}-\d{2}$/);
-    }
-  });
-
-  it('should throw an InvalidCredentialsError if the response code is -5', () => {
-    expect(() => parseSearchSeriesResponse(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)).toThrow(Errors.InvalidFrequencyError);
-  });
-
-  it('should throw a ResponseError if the response code is unknown', () => {
-    expect(() => parseSearchSeriesResponse({} as ApiResponse)).toThrow(Errors.WebServiceError);
-  });
-});