8 Commits
Author SHA1 Message Date
Filip Skokan d162246556 refactor(types): trim published declaration comments
Signed-off-by: Filip Skokan <[email protected]>
2026-07-30 00:37:15 +02:00
Filip Skokan 101557a764 docs: document consumer-supplied type parameters
Document PayloadType on JWT results and decoders, and KeyType on
dynamic key resolvers so consumers know what each explicit argument
controls. Correct ResolvedKey type-parameter tags in generated docs.

Signed-off-by: Filip Skokan <[email protected]>
2026-07-29 18:50:54 +02:00
Filip Skokan f7ef7912cd docs: correct subpaths and API documentation
Correct subpath names that otherwise lead users to unexported entries,
and fix examples, links, and missing descriptions in published JSDoc.

Use instanceof in JWKS recovery examples so strict TypeScript can
narrow caught errors.

Signed-off-by: Filip Skokan <[email protected]>
2026-07-29 18:50:54 +02:00
Filip Skokan acb2913e8e refactor(types): improve key and result inference
Thread resolver return types through verify and decrypt results. Add
overloads so wrappers can forward either keys or resolvers.

Infer importJWK and generateSecret results from their inputs. Keep JWT
payload generics unconstrained while rejecting known non-object shapes.

Signed-off-by: Filip Skokan <[email protected]>
2026-07-29 18:50:54 +02:00
Filip Skokan 8d9ece5c1a fix(types): correct JWK and CryptoKey types
Declare JWK shapes as aliases so they satisfy the implicit index
signatures used by host `JsonWebKey` types. Export the AKP variants,
add "oth", and exclude private members from embedded JWK headers.

Alias the host `CryptoKey` when available and use a checked fallback
otherwise, avoiding both a competing nominal type and an `any` result.
Narrow `KeyObject.type` to the values it can hold.

Signed-off-by: Filip Skokan <[email protected]>
2026-07-29 18:44:48 +02:00
Filip Skokan 1d6192bb27 chore: bump typedoc and typescript 2025-08-29 17:14:21 +02:00
Filip Skokan 7b88293564 docs: re-generate API reference docs 2025-02-22 15:16:04 +01:00
Filip Skokan f4dbf41a1c docs: update docs building dependencies 2024-10-19 14:02:59 +02:00