@graphql-yoga/plugin-jwt 3.2.0 → 3.2.1-alpha-20241105140439-edc38246

package/cjs/config.js

@@ -3,8 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeConfig = normalizeConfig;
 const utils_js_1 = require("./utils.js");
 function normalizeConfig(input) {
-    if (input.singingKeyProviders.length === 0) {
-        throw new TypeError('You must provide at least one signing key provider. Please verify your `singingKeyProviders` configuration.');
+    // TODO: remove this on next major version.
+    if (input.singingKeyProviders) {
+        if (input.signingKeyProviders) {
+            throw new TypeError('You are using both deprecated `singingKeyProviders` and its new replacement `signingKeyProviders` configuration. Please use only `signingKeyProviders`');
+        }
+        input.signingKeyProviders = input.singingKeyProviders;
+    }
+    if (!input.signingKeyProviders) {
+        throw new TypeError('You must provide at least one signing key provider. Please verify your `signingKeyProviders` configuration.');
     }
     const extendContextFieldName = input.extendContext === false
         ? null
@@ -19,7 +26,7 @@ function normalizeConfig(input) {
         }));
     }
     return {
-        singingKeyProviders: input.singingKeyProviders,
+        signingKeyProviders: input.signingKeyProviders,
         tokenLookupLocations,
         tokenVerification: input.tokenVerification ?? {
             algorithms: ['RS256', 'HS256'],

package/cjs/plugin.js

@@ -21,7 +21,7 @@ function useJWT(options) {
         return null;
     };
     const getSigningKey = async (kid) => {
-        for (const provider of normalizedOptions.singingKeyProviders) {
+        for (const provider of normalizedOptions.signingKeyProviders) {
             try {
                 const key = await provider(kid);
                 if (key) {

package/esm/config.js

@@ -1,7 +1,14 @@
 import { extractFromHeader } from './utils.js';
 export function normalizeConfig(input) {
-    if (input.singingKeyProviders.length === 0) {
-        throw new TypeError('You must provide at least one signing key provider. Please verify your `singingKeyProviders` configuration.');
+    // TODO: remove this on next major version.
+    if (input.singingKeyProviders) {
+        if (input.signingKeyProviders) {
+            throw new TypeError('You are using both deprecated `singingKeyProviders` and its new replacement `signingKeyProviders` configuration. Please use only `signingKeyProviders`');
+        }
+        input.signingKeyProviders = input.singingKeyProviders;
+    }
+    if (!input.signingKeyProviders) {
+        throw new TypeError('You must provide at least one signing key provider. Please verify your `signingKeyProviders` configuration.');
     }
     const extendContextFieldName = input.extendContext === false
         ? null
@@ -16,7 +23,7 @@ export function normalizeConfig(input) {
         }));
     }
     return {
-        singingKeyProviders: input.singingKeyProviders,
+        signingKeyProviders: input.signingKeyProviders,
         tokenLookupLocations,
         tokenVerification: input.tokenVerification ?? {
             algorithms: ['RS256', 'HS256'],

package/esm/plugin.js

@@ -17,7 +17,7 @@ export function useJWT(options) {
         return null;
     };
     const getSigningKey = async (kid) => {
-        for (const provider of normalizedOptions.singingKeyProviders) {
+        for (const provider of normalizedOptions.signingKeyProviders) {
             try {
                 const key = await provider(kid);
                 if (key) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-yoga/plugin-jwt",
-  "version": "3.2.0",
+  "version": "3.2.1-alpha-20241105140439-edc38246",
   "description": "jwt plugin for GraphQL Yoga.",
   "peerDependencies": {
     "graphql": "^16.5.0",

package/typings/config.d.cts

@@ -10,7 +10,7 @@ export type ExtractTokenFunction = (params: {
     prefix?: string;
 }>;
 export type GetSigningKeyFunction = (kid?: string) => Promise<string> | string;
-export type JwtPluginOptions = {
+export type JwtPluginOptions = ({
     /**
      * List of configurations for the signin-key providers. You can configure multiple signin-key providers to allow for key rotation, fallbacks, etc.
      *
@@ -21,7 +21,15 @@ export type JwtPluginOptions = {
      * If the first provider fails to fetch the keys, the plugin will try the next provider in the list.
      *
      */
+    signingKeyProviders: AtleastOneItem<GetSigningKeyFunction>;
+    singingKeyProviders?: never;
+} | {
+    /**
+     * @deprecated: please use `signingKeyProviders` instead.
+     */
     singingKeyProviders: AtleastOneItem<GetSigningKeyFunction>;
+    signingKeyProviders?: never;
+}) & {
     /**
      * List of locations to look for the token in the incoming request.
      *
@@ -74,7 +82,7 @@ export type JwtPluginOptions = {
     extendContext?: string | boolean;
 };
 export declare function normalizeConfig(input: JwtPluginOptions): {
-    singingKeyProviders: AtleastOneItem<GetSigningKeyFunction>;
+    signingKeyProviders: AtleastOneItem<GetSigningKeyFunction>;
     tokenLookupLocations: ExtractTokenFunction[];
     tokenVerification: VerifyOptions;
     reject: {

package/typings/config.d.ts

@@ -10,7 +10,7 @@ export type ExtractTokenFunction = (params: {
     prefix?: string;
 }>;
 export type GetSigningKeyFunction = (kid?: string) => Promise<string> | string;
-export type JwtPluginOptions = {
+export type JwtPluginOptions = ({
     /**
      * List of configurations for the signin-key providers. You can configure multiple signin-key providers to allow for key rotation, fallbacks, etc.
      *
@@ -21,7 +21,15 @@ export type JwtPluginOptions = {
      * If the first provider fails to fetch the keys, the plugin will try the next provider in the list.
      *
      */
+    signingKeyProviders: AtleastOneItem<GetSigningKeyFunction>;
+    singingKeyProviders?: never;
+} | {
+    /**
+     * @deprecated: please use `signingKeyProviders` instead.
+     */
     singingKeyProviders: AtleastOneItem<GetSigningKeyFunction>;
+    signingKeyProviders?: never;
+}) & {
     /**
      * List of locations to look for the token in the incoming request.
      *
@@ -74,7 +82,7 @@ export type JwtPluginOptions = {
     extendContext?: string | boolean;
 };
 export declare function normalizeConfig(input: JwtPluginOptions): {
-    singingKeyProviders: AtleastOneItem<GetSigningKeyFunction>;
+    signingKeyProviders: AtleastOneItem<GetSigningKeyFunction>;
     tokenLookupLocations: ExtractTokenFunction[];
     tokenVerification: VerifyOptions;
     reject: {