Lokicoule / nestjs-cognito / 18258395424

92%

push

github

feat(auth,graphql): add specialized decorators for Cognito token types (#1454)

* feat(auth,graphql): add specialized decorators for Cognito token types

Add @CognitoAccessUser and @CognitoIdUser decorators with runtime validation for better type safety when working with different Cognito JWT token types.

Changes:
- Add CognitoAccessTokenPayload and CognitoIdTokenPayload types in @nestjs-cognito/core
- Add isAccessTokenPayload() and isIdTokenPayload() type guards
- Add @CognitoAccessUser and @CognitoIdUser decorators for REST controllers
- Add @GqlCognitoAccessUser and @GqlCognitoIdUser decorators for GraphQL resolvers
- Refactor decorator logic using shared createCognitoUserDecorator() factory
- Add CognitoTokenTypeMismatchError for token type validation errors
- Add comprehensive test coverage for token extraction and validation

Resolves #1445

* docs: update Cognito user decorators and GraphQL integration

Enhance documentation for Cognito user decorators, introducing specialized decorators for better type safety. Update usage examples for `@CognitoAccessUser` and `@CognitoIdUser`, and clarify the functionality of GraphQL decorators. Include runtime validation details and error handling for token type mismatches.

Changes:
- Revise descriptions and examples for `@CognitoUser`, `@CognitoAccessUser`, and `@CognitoIdUser` decorators.
- Add GraphQL support documentation for `@GqlCognitoAccessUser` and `@GqlCognitoIdUser`.
- Improve clarity on token retrieval patterns and error handling.

Resolves #1445

245 of 272 branches covered (90.07%)

Branch coverage included in aggregate %.

34 of 38 new or added lines in 7 files covered. (89.47%)

465 of 490 relevant lines covered (94.9%)

9.2 hits per line