types: export FastifyHelmetOptions to TypeScript users (#165)

fastify · Jan 9, 2022 · 186fba4 · 186fba4
1 parent f752e6c
commit 186fba4
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 9 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -10,9 +10,9 @@ declare module 'fastify' {
   }
 }
 
-type FastifyHelmetOptions = Parameters<typeof helmet>[0] & { enableCSPNonces?: boolean };
+export type FastifyHelmetOptions = NonNullable<Parameters<typeof helmet>[0] & { enableCSPNonces?: boolean }>;
 
-export const fastifyHelmet: FastifyPluginCallback<NonNullable<FastifyHelmetOptions>> & {
+export const fastifyHelmet: FastifyPluginCallback<FastifyHelmetOptions> & {
   contentSecurityPolicy: typeof helmet.contentSecurityPolicy;
 };
 

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -1,13 +1,14 @@
-import fastify from "fastify";
-import { expectType } from "tsd";
+import fastify, { FastifyPluginCallback } from "fastify";
+import { expectAssignable, expectType } from "tsd";
 import helmet from "helmet";
-import fastifyHelmet from ".";
+import fastifyHelmet, { FastifyHelmetOptions } from ".";
 
 const app = fastify();
 
 app.register(fastifyHelmet);
 app.register(fastifyHelmet, {});
-app.register(fastifyHelmet, {
+
+const helmetOptions = {
   contentSecurityPolicy: false,
   dnsPrefetchControl: false,
   expectCt: false,
@@ -19,7 +20,10 @@ app.register(fastifyHelmet, {
   permittedCrossDomainPolicies: false,
   referrerPolicy: false,
   xssFilter: false
-});
+};
+
+expectAssignable<FastifyHelmetOptions>(helmetOptions);
+app.register(fastifyHelmet, helmetOptions);
 
 app.register(fastifyHelmet, {
   contentSecurityPolicy: {
@@ -51,15 +55,15 @@ app.register(fastifyHelmet, {
     policy: 'foo'
   },
   // these options are false or never
-  // hidePoweredBy: false 
+  // hidePoweredBy: false
   // ieNoOpen: false,
   // noSniff: false,
   // xssFilter: false
 });
 
 
 app.register(fastifyHelmet, { enableCSPNonces: true });
-app.register(fastifyHelmet, { 
+app.register(fastifyHelmet, {
   enableCSPNonces: true,
   contentSecurityPolicy: {
     directives: {
@@ -77,3 +81,8 @@ app.get('/', function(request, reply) {
 
 const csp = fastifyHelmet.contentSecurityPolicy;
 expectType<typeof helmet.contentSecurityPolicy>(csp);
+
+// fastify-helmet instance is using the FastifyHelmetOptions options
+expectType<FastifyPluginCallback<FastifyHelmetOptions> & {
+  contentSecurityPolicy: typeof helmet.contentSecurityPolicy;
+}>(fastifyHelmet);