Skip to content

CHANGELOG.md

Latest commit

 

History

History
125 lines (71 loc) · 5.9 KB

CHANGELOG.md

File metadata and controls

125 lines (71 loc) · 5.9 KB

Changelog

2.0.1

Patch Changes

  • ce5f30a: Update the internal dependency and build/test toolchain to current compatible versions, including pinning Vite to 7.3.2 so Vitest resolves the patched release and the remaining Vite security advisories in the root lockfile are cleared.

2.0.0

Major Changes

  • 9a65f16: Rewrite as a single-package SDK built on @http-client-toolkit/core for HTTP requests, with toolkit-compatible caching, deduplication, and rate limiting stores.

    Breaking changes:

    • Package renamed from @comic-vine/client to comic-vine-sdk
    • Replaced the monorepo package layout with a single published SDK package
    • HTTP layer replaced: custom Axios-based client → @http-client-toolkit/core (fetch-based)
    • Store interfaces now use CacheStore, DedupeStore, and RateLimitStore from @http-client-toolkit/core
    • Constructor accepts a single ComicVineOptions object with apiKey, baseUrl, stores, and client fields
    • Resource properties are lazily loaded via Proxy

    New features:

    • Full code generation pipeline: types, resources, tests, and mock data generated from API samples
    • All 19 Comic Vine resources with typed list() and retrieve() methods
    • list() returns a dual Promise & AsyncIterable for automatic pagination
    • Utility methods: getAvailableResources, hasResource, clearCache, getCacheStats, getRateLimitStatus, resetRateLimit
    • Comprehensive build artifact tests: ESM, CJS, exports, functionality, browser bundleability, type contracts, bundle size gating

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.2.8] - 2024-01-01

Changed

  • Migrated from Projen to standard npm project structure
  • Updated GitHub Actions workflows to use artifact actions v4
  • Improved build process and release workflow

1.2.5 (2023-03-18)

Bug Fixes

  • upgrade zod from 3.20.2 to 3.20.5 (31755e7)
  • upgrade zod from 3.20.5 to 3.20.6 (4c32d5b)

1.2.4 (2023-01-31)

Bug Fixes

  • 📦 publish typings to npm (f132dd6)

1.2.3 (2023-01-22)

Bug Fixes

  • upgrade zod from 3.19.1 to 3.20.2 (4576f78)

1.2.2 (2022-12-04)

Bug Fixes

  • typo in pagination example: typo in pagination example (3b3d3c5)

1.2.1 (2022-12-04)

Bug Fixes

  • auto pagination example: fixes the autopagination example so limit is set to 50 (a198408)

1.2.0 (2022-12-04)

Features

  • auto pagination: add auto pagination to list methods (a5fa379)

1.1.1 (2022-10-15)

Bug Fixes

  • options docs: add missing documentation for setting baseUrl (6954695)

1.1.0 (2022-10-15)

Features

  • library options: allow setting baseUrl when initializing the library (07fe7e3)

1.0.4 (2022-10-08)

Bug Fixes

  • typings: improve the api response typings (e5bf556)

1.0.3 (2022-10-07)

Bug Fixes

  • tsconfig.json: remove comments so that the file can be parsed by snyk (fe715f7)

1.0.2 (2022-10-07)

Bug Fixes

  • character details typings: birth can be null or string, change any arrays to SiteResource array (5a69bd3)

1.0.1 (2022-10-05)

Bug Fixes

  • ts build: update typescript typings to remove false positives in vscode problems window (ece4080)

1.0.0 (2022-09-30)

Bug Fixes

  • npm publish: rename npm package (37eb3a1)
  • npm publish: rename npm package to comic-vine-sdk (26fe0d8)

Features

  • gh workflow: automate release to npm (efa0a07)