Skip to content

Test option compatibility with @types/simple-oauth2 #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcollina merged 1 commit into from
Sep 4, 2023
Merged

Test option compatibility with @types/simple-oauth2 #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
"devDependencies": {
"@fastify/pre-commit": "^2.0.2",
"@types/node": "^20.5.3",
"@types/simple-oauth2": "^5.0.4",
"fastify": "^4.21.0",
"nock": "^13.3.3",
"simple-get": "^4.0.1",
Expand Down
16 changes: 16 additions & 0 deletions types/index.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import fastifyOauth2, {
OAuth2Token,
ProviderConfiguration
} from '..';
import type { ModuleOptions } from 'simple-oauth2';

/**
* Preparing some data for testing.
Expand All @@ -22,6 +23,14 @@ const credentials: Credentials = {
auth: auth,
};

const simpleOauth2Options: ModuleOptions = {
client: {
id: 'test_id',
secret: 'test_secret',
},
auth: auth,
};

const OAuth2NoneOptional: FastifyOAuth2Options = {
name: 'testOAuthName',
credentials: credentials,
Expand Down Expand Up @@ -84,6 +93,13 @@ expectType<string[]>(scope);
expectType<string[]>(tags);
expectType<Credentials>(credentials);

// Ensure duplicayed simple-oauth2 are compatible with simple-oauth2
expectAssignable<ModuleOptions<string>>(credentials);
expectAssignable<ModuleOptions["auth"]>(auth);
// Ensure published types of simple-oauth2 are accepted
expectAssignable<Credentials>(simpleOauth2Options);
expectAssignable<ProviderConfiguration>(simpleOauth2Options.auth);

expectError(fastifyOauth2()); // error because missing required arguments
expectError(fastifyOauth2(server, {}, () => {
})); // error because missing required options
Expand Down