AACsearch
Changelog

SDK changelog

[TODO i18n — see issue #76] Release notes for @aacsearch/client (TypeScript), @aacsearch/react, and the Python SDK (aacsearch). Use this page if you build against an AACSearch SDK and want a slice of the changelog without API or widget noise.

This page covers the AACSearch SDK packages. Format follows Changelog format; versioning rules are in Versioning and deprecation policy.

Packages tracked

PackageSurfaceLatest
@aacsearch/clientTypeScript browser + server REST client0.1.x
@aacsearch/reactReact hooks (useAACsearch, etc.)0.1.x
aacsearch (Python)Python REST client0.1.x

(Numbers are placeholders — subscribe to npm/pypi for ground truth.)

@aacsearch/client

SemVer. MAJOR breaks the client API or the underlying REST major it targets. MINOR adds methods/optional args. PATCH ships fixes only.

Latest release notes: npm.

Migration

When a major bumps, the migration delta lives at /migration/sdk/v<n>-to-v<n+1>. The previous major stays installable from npm for 6 months.

@aacsearch/react

React hooks built on top of @aacsearch/client. Tracks @aacsearch/client majors — bumping the React package usually corresponds to a peer-dep bump on the underlying client.

Hook contract:

import { useAACsearch, useAACSuggest, useAACFacet } from '@aacsearch/react'

Breaking renames in the hook surface ship under ⚠ Breaking in this page and trigger a major.

aacsearch (Python)

Python client. Independent SemVer track from the TypeScript client (it targets the same REST API but ships a different language surface).

Module layout:

from aacsearch import SearchClient, AdminClient

Breaking changes follow the same notice rules as the TypeScript client.

Notes

  • A new SDK release does not automatically imply a REST API change. SDKs may ship cosmetic renames or internal refactors without touching the public REST surface.
  • A REST API change always implies an SDK release on the same day if the SDK exposed the affected surface.
  • Widget changelog lives separately at /changelog/widget.

On this page