Are.na SDK

This repository contains the official TypeScript SDK for the Are.na API.

Published packages:

• @aredotna/sdk: generated from the Are.na OpenAPI specification with a small ergonomic facade for OAuth, pagination, uploads, and error handling.
• @aredotna/react-query: TanStack Query hooks over the stable SDK facade.

Development

corepack enable
pnpm install
pnpm gen:fetch
pnpm gen
pnpm test
pnpm build

The OpenAPI snapshot lives in spec/openapi.json so builds are reproducible offline.

Releases

This monorepo uses fixed versions: @aredotna/sdk and @aredotna/react-query always share the same version, and releases are tagged as vX.Y.Z.

Release flow:

1. Label a PR with exactly one of patch, minor, or major.
2. Merge the PR into main.
3. The Release workflow bumps the root package and both package versions, commits release: vX.Y.Z, and pushes tag vX.Y.Z.
4. The Publish workflow runs from that tag, publishing @aredotna/sdk first and then @aredotna/react-query.
5. The Publish workflow creates a GitHub Release if one does not already exist.

Required secrets:

• NPM_TOKEN: npm token with publish access to the @aredotna scope.
• RELEASE_TOKEN (optional): token used by the Release workflow so the release commit can re-trigger CI on main.

Local release checks:

pnpm check
pnpm typecheck
pnpm test
pnpm build
node scripts/version-all.mjs patch --dry-run
pnpm -r --filter './packages/*' publish --dry-run

Do not publish manually unless recovering from a workflow failure.