Skip to content

chore(release): 0.2.0-alpha.2 — challenges resource + doc fixes#2

Merged
akhilesharora merged 1 commit into
mainfrom
chore/alpha-2-doc-fixes
May 9, 2026
Merged

chore(release): 0.2.0-alpha.2 — challenges resource + doc fixes#2
akhilesharora merged 1 commit into
mainfrom
chore/alpha-2-doc-fixes

Conversation

@akhilesharora

Copy link
Copy Markdown
Collaborator

Summary

Adds the client.challenges resource (wraps /v1/challenges + /v1/challenges/:id from PR #345 server-side) and consolidates doc fixes surfaced by the post-publish review.

Added

  • client.challenges resourcelist({ status, language, limit, cursor }) + retrieve(id). Partners need this to discover available challenges in the customer's library before assigning them.
  • Challenge, ChallengeListParams, ChallengeStatus types re-exported.
  • challengeFromWire transform with unit-test coverage.

Documentation fixes

  • Audience framing. README intro now positions the SDK for any hiring workflow integration — not specifically ATS partners.
  • Resources table now includes client.account and client.challenges rows.
  • Error handling import list adds LangosConflictError and LangosSignatureVerificationError.
  • CHANGELOG. Moved security/correctness entries to [0.2.0-alpha.1] where they actually shipped. Removed misleading 'Challenge resource' line from alpha.1. Corrected the retry list (409 not retried) and error class list.
  • CLAUDE.md. Fixed broken for await examples (need await since list() returns Promise<AsyncIterablePage>). Corrected default baseUrl. Dropped stale monorepo path references. Documented the release.yml pipeline.
  • Generic example identifiers. Removed greenhouse-app-12345 / GreenhouseConnector/2.1.0 placeholders.

Validation

  • pnpm run lint clean
  • pnpm run build produces ESM + CJS + d.ts (21.56 KB d.ts now)
  • pnpm test71/71 passing (was 69; +2 challenge transform tests)
  • npm pack --dry-run — same 10-file tarball shape (no source/test/config leakage)

Release

After merge, tag v0.2.0-alpha.2 and push it — release.yml will publish to npm automatically. This will be the first real test of the release pipeline (alpha.1 was published manually before Actions was enabled at org level).

Follow-up

A separate monorepo PR will add an sdk-contract scenario exercising client.challenges.list/retrieve per paid tier, once 0.2.0-alpha.2 is live on npm.

### Added
- ChallengesResource (`client.challenges.list / retrieve`) wrapping `/v1/challenges`
  and `/v1/challenges/:id`. Partners can discover available coding challenges
  in the customer's library before assigning them to candidates.
- Challenge, ChallengeListParams, ChallengeStatus types re-exported.
- challengeFromWire transform + unit tests (71/71 passing).

### Documentation
- README intro broadened — SDK is for any hiring workflow integration, not
  just ATS partners.
- README Resources table now includes client.account and client.challenges.
- README error handling adds LangosConflictError and LangosSignatureVerificationError.
- CHANGELOG: moved security/correctness entries to [0.2.0-alpha.1] where they
  actually shipped. Removed misleading 'Challenge resource' line from alpha.1.
  Corrected the retry list (409 not retried) and error class list (added
  LangosConflictError + LangosSignatureVerificationError).
- CLAUDE.md: fixed broken `for await` examples (need `await` since list()
  returns Promise<AsyncIterablePage>), corrected default baseUrl, dropped
  stale monorepo path references, documented the release.yml pipeline.
- Genericized greenhouse-themed example identifiers in README.
@akhilesharora akhilesharora merged commit 395cb7c into main May 9, 2026
4 checks passed
@akhilesharora akhilesharora deleted the chore/alpha-2-doc-fixes branch May 9, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant