bcchapi 1.0.8 → 2.0.0

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

@@ -1,38 +0,0 @@
-# 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/.prettierrc.json

@@ -1,17 +0,0 @@
-{
-  "semi": true,
-  "singleQuote": true,
-  "arrowParens": "always",
-  "trailingComma": "all",
-  "tabWidth": 2,
-  "printWidth": 100,
-  "endOfLine": "lf",
-  "overrides": [
-    {
-      "files": "*.json",
-      "options": {
-        "trailingComma": "none"
-      }
-    }
-  ]
-}

package/.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-  "recommendations": ["esbenp.prettier-vscode"]
-}

package/.vscode/settings.json

@@ -1,4 +0,0 @@
-{
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true
-}

package/src/client.ts

@@ -1,109 +0,0 @@
-import * as querystring from 'node:querystring';
-import * as assert from 'node:assert/strict';
-import { GetSeriesResponse, SearchSeriesResponse, ApiResponse } from './types';
-import { handleGetSeriesResponse, handleSearchSeriesResponse } from './handlers';
-import { isValidDate } from './utils';
-
-export interface ClientConfig {
-  /**
-   * Client username (registered email).
-   */
-  user: string;
-  /**
-   * Client password.
-   */
-  pass: string;
-}
-
-export enum Frequency {
-  Daily = 'DAILY',
-  Monthly = 'MONTHLY',
-  Quarterly = 'QUARTERLY',
-  Annual = 'ANNUAL',
-}
-
-export class Client {
-  static apiURL = 'https://si3.bcentral.cl/SieteRestWS/SieteRestWS.ashx';
-
-  private username: string;
-  private password: string;
-
-  constructor(config: ClientConfig) {
-    this.username = config.user;
-    this.password = config.pass;
-  }
-
-  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<T>;
-  }
-
-  /**
-   * Fetches the list of observed values for a given series.
-   */
-  async 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> {
-    const { series, since, until } = params;
-
-    assert.ok(series && typeof series === 'string', 'series must be a non-empty string');
-
-    const query: Record<string, string> = {
-      timeseries: series,
-      function: 'GetSeries',
-    };
-
-    if (since) {
-      assert.ok(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(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(handleGetSeriesResponse);
-  }
-
-  /**
-   * Fetches the list of available series by frequency and their metadata.
-   */
-  async searchSeries(params: {
-    /**
-     * Frequency for which you want to consult the catalog of available series.
-     */
-    frequency: Frequency;
-  }): Promise<SearchSeriesResponse> {
-    const { frequency } = params;
-
-    assert.ok(frequency && typeof frequency === 'string', 'frequency must be a non-empty string');
-
-    const query: Record<string, string> = {
-      frequency,
-      function: 'SearchSeries',
-    };
-
-    return this.request(query).then(handleSearchSeriesResponse);
-  }
-}

package/src/errors.ts

@@ -1,36 +0,0 @@
-import { ErrorResponse } from './types';
-
-export enum ErrorCodes {
-  InvalidCredentials = -5,
-  InvalidFrequency = -1,
-  InvalidSeries = -50,
-  InvalidDateRange = -1,
-  Unknown = -1,
-}
-
-export class WebServiceError extends Error {
-  response?: ErrorResponse;
-
-  constructor(response?: ErrorResponse, message?: string) {
-    super(message || response?.Descripcion || 'Unknown service error');
-    this.response = response;
-  }
-}
-
-export class InvalidFrequencyError extends WebServiceError {
-  constructor(response?: ErrorResponse) {
-    super(response, 'Invalid frequency code (must be DAILY, MONTHLY, QUARTERLY or ANNUAL)');
-  }
-}
-
-export class InvalidCredentialsError extends WebServiceError {
-  constructor(response?: ErrorResponse) {
-    super(response, 'Invalid username or password');
-  }
-}
-
-export class InvalidSeriesError extends WebServiceError {
-  constructor(response?: ErrorResponse) {
-    super(response, 'Invalid series id');
-  }
-}

package/src/handlers.ts

@@ -1,69 +0,0 @@
-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/index.ts

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

package/src/types.ts

@@ -1,115 +0,0 @@
-export type StatusCode = 'OK' | 'ND';
-
-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: StatusCode;
-}
-
-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.
-   */
-  readonly Codigo: number;
-  /**
-   * Response status message.
-   */
-  readonly Descripcion: string;
-
-  /**
-   * Series historic information.
-   */
-  readonly Series: Readonly<SeriesHistory | NullSeries>;
-  /**
-   * Series metadata information.
-   */
-  readonly SeriesInfos: ReadonlyArray<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/src/utils.ts

@@ -1,37 +0,0 @@
-/**
- * Determines wether a given value can be parsed to a valid date.
- */
-export function isValidDate(date: unknown): boolean {
-  if (typeof date === 'string') {
-    // 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;
-}
-
-/**
- * Reverses a date string from DD-MM-YYYY to YYYY-MM-DD format.
- */
-export function reverseDate(date: string): string {
-  if (/^\d{4}-\d{2}-\d{2}$/.test(date)) {
-    return date;
-  }
-
-  if (!/^\d{2}-\d{2}-\d{4}$/.test(date)) {
-    throw new Error('Invalid date format. Expected DD-MM-YYYY');
-  }
-  return date.split('-').reverse().join('-');
-}

package/test/client.test.ts

@@ -1,226 +0,0 @@
-import { expect, describe, it, vi, afterEach, beforeEach } from 'vitest';
-import {
-  Client,
-  Frequency,
-  InvalidCredentialsError,
-  InvalidSeriesError,
-  InvalidFrequencyError,
-} from '../src';
-import { reverseDate } from '../src/utils';
-import fetchMock from './mocks/fetch.mock';
-import fixtures from './fixtures';
-
-const fetchSpy = vi.spyOn(global, 'fetch').mockImplementation(fetchMock);
-
-describe('Client', () => {
-  const client = new Client({
-    user: 'test',
-    pass: 'test',
-  });
-
-  const invalidClient = new Client({
-    user: '',
-    pass: '',
-  });
-
-  it('should create a Client instance', () => {
-    expect(client).toBeInstanceOf(Client);
-  });
-
-  describe('getSeries', () => {
-    beforeEach(() => {
-      fetchSpy.mockImplementation(fetchMock);
-    });
-    afterEach(() => {
-      fetchSpy.mockReset();
-    });
-
-    it('should throw an error if series is not a non-empty string', async () => {
-      await expect(
-        client.getSeries({
-          series: undefined as unknown as string,
-        }),
-      ).rejects.toThrow('series must be a non-empty string');
-      await expect(
-        client.getSeries({
-          series: '',
-        }),
-      ).rejects.toThrow('series must be a non-empty string');
-
-      expect(fetchSpy).not.toHaveBeenCalled();
-    });
-
-    it('should throw an error if date range is invalid', async () => {
-      await expect(
-        client.getSeries({
-          series: 'TEST',
-          since: 'invalid',
-        }),
-      ).rejects.toThrow('"since" is not a valid date string or Date object');
-      await expect(
-        client.getSeries({
-          series: 'TEST',
-          since: new Date('invalid'),
-        }),
-      ).rejects.toThrow('"since" is not a valid date string or Date object');
-
-      await expect(
-        client.getSeries({
-          series: 'TEST',
-          until: 'invalid',
-        }),
-      ).rejects.toThrow('"until" is not a valid date string or Date object');
-      await expect(
-        client.getSeries({
-          series: 'TEST',
-          until: new Date('invalid'),
-        }),
-      ).rejects.toThrow('"until" is not a valid date string or Date object');
-
-      await expect(
-        client.getSeries({
-          series: 'TEST',
-          since: new Date(2020, 0, 1),
-          until: new Date(2000, 0, 1),
-        }),
-      ).rejects.toThrow('invalid date range');
-
-      expect(fetchSpy).not.toHaveBeenCalled();
-    });
-
-    it('should throw error if credentials are invalid', async () => {
-      await expect(invalidClient.getSeries({ series: 'TEST' })).rejects.toThrow(
-        InvalidCredentialsError,
-      );
-      expect(fetchSpy).toHaveBeenCalledTimes(1);
-    });
-
-    it('should throw error if series does not exist', async () => {
-      await expect(client.getSeries({ series: 'invalid' })).rejects.toThrow(InvalidSeriesError);
-      expect(fetchSpy).toHaveBeenCalledTimes(1);
-    });
-
-    it('should return the series history information', async () => {
-      const series = await client.getSeries({ series: 'TEST' });
-
-      expect(fetchSpy).toHaveBeenCalledTimes(1);
-
-      expect(series).toBeDefined();
-      expect(series.seriesId).toBe('TEST');
-      expect(series.description).toBe('Test');
-      expect(series.data).toBeInstanceOf(Array);
-      expect(series.data).toHaveLength(15);
-
-      for (let i = 0; i < series.data.length; i += 1) {
-        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,
-        );
-
-        if (Number.isNaN(series.data[i].value)) {
-          expect(fixtures.response.getSeriesSuccess.Series.Obs[i].statusCode).toBe('ND');
-        }
-      }
-    });
-
-    it('should filter the series history by date range', async () => {
-      const series = await client.getSeries({
-        series: 'TEST',
-        until: '2020-12-05',
-      });
-
-      expect(fetchSpy).toHaveBeenCalledTimes(1);
-
-      expect(series).toBeDefined();
-      expect(series.seriesId).toBe('TEST');
-      expect(series.description).toBe('Test');
-      expect(series.data).toBeInstanceOf(Array);
-      expect(series.data).toHaveLength(5);
-
-      for (let i = 0; i < series.data.length; i += 1) {
-        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,
-        );
-
-        if (Number.isNaN(series.data[i].value)) {
-          expect(fixtures.response.getSeriesSuccess.Series.Obs[i].statusCode).toBe('ND');
-        }
-      }
-    });
-
-    it('should return empty results if series has no data', async () => {
-      const series = await client.getSeries({
-        series: 'TEST',
-        since: '2020-12-16',
-      });
-
-      expect(fetchSpy).toHaveBeenCalledTimes(1);
-
-      expect(series).toBeDefined();
-      expect(series.seriesId).toBe('TEST');
-      expect(series.description).toBe('Test');
-      expect(series.data).toBeInstanceOf(Array);
-      expect(series.data).toHaveLength(0);
-    });
-  });
-
-  describe('searchSeries', () => {
-    beforeEach(() => {
-      fetchSpy.mockImplementation(fetchMock);
-    });
-    afterEach(() => {
-      fetchSpy.mockReset();
-    });
-
-    it('should throw an error if frequency is not a non-empty string', async () => {
-      await expect(
-        client.searchSeries({
-          frequency: undefined as unknown as Frequency,
-        }),
-      ).rejects.toThrow('frequency must be a non-empty string');
-      await expect(
-        client.searchSeries({
-          frequency: '' as Frequency,
-        }),
-      ).rejects.toThrow('frequency must be a non-empty string');
-
-      expect(fetchSpy).not.toHaveBeenCalled();
-    });
-
-    it('should throw error if credentials are invalid', async () => {
-      await expect(
-        invalidClient.searchSeries({
-          frequency: Frequency.Daily,
-        }),
-      ).rejects.toThrow(InvalidCredentialsError);
-
-      expect(fetchSpy).toHaveBeenCalledTimes(1);
-    });
-
-    it('should throw error if frequency is invalid', async () => {
-      await expect(
-        client.searchSeries({
-          frequency: 'invalid' as Frequency,
-        }),
-      ).rejects.toThrow(InvalidFrequencyError);
-
-      expect(fetchSpy).toHaveBeenCalledTimes(1);
-    });
-
-    it('should return the series metadata information', async () => {
-      const series = await client.searchSeries({
-        frequency: Frequency.Daily,
-      });
-
-      expect(fetchSpy).toHaveBeenCalledTimes(1);
-
-      expect(series).toBeInstanceOf(Array);
-      expect(series).toHaveLength(1);
-    });
-  });
-});

package/test/fixtures/index.ts

@@ -1,15 +0,0 @@
-import getSeriesSuccess from './responses/getseries.success.json';
-import getSeriesInvalid from './responses/getseries.invalid.json';
-import searchSeriesSuccess from './responses/searchseries.success.json';
-import searchSeriesInvalid from './responses/searchseries.invalid.json';
-import credentialsInvalid from './responses/credentials.invalid.json';
-
-export default {
-  response: {
-    credentialsInvalid,
-    getSeriesInvalid,
-    getSeriesSuccess,
-    searchSeriesInvalid,
-    searchSeriesSuccess,
-  },
-};

package/test/fixtures/responses/credentials.invalid.json

@@ -1,11 +0,0 @@
-{
-  "Codigo": -5,
-  "Descripcion": "Invalid username or password",
-  "Series": {
-    "descripEsp": null,
-    "descripIng": null,
-    "seriesId": null,
-    "Obs": null
-  },
-  "SeriesInfos": []
-}