@ethlete/query 6.0.0-next.30 → 6.0.0-next.31

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/query",
-  "version": "6.0.0-next.30",
+  "version": "6.0.0-next.31",
   "license": "MIT",
   "sideEffects": false,
   "peerDependencies": {

package/types/ethlete-query-testing.d.ts

@@ -70,6 +70,8 @@ type AuthTestSetupConfig<TLoginArgs extends {
         accessToken: string;
         refreshToken: string;
     };
+    /** Builds the refresh request from the refresh token. See TokenRefreshQueryConfig for details */
+    buildRefreshArgs?: TokenRefreshQueryConfig<TRefreshArgs>['buildArgs'];
     /** Feature builders for additional auth functionality */
     features?: [...TFeatures];
     /** Custom bearer decrypt function for testing */

package/types/ethlete-query.d.ts

@@ -3449,6 +3449,19 @@ type AuthQueryConfig<TArgs extends QueryArgs> = {
     extractTokens?: (response: ResponseType<TArgs>) => BearerAuthProviderTokens;
 };
 type TokenRefreshQueryConfig<TArgs extends QueryArgs> = AuthQueryConfig<TArgs> & {
+    /**
+     * Builds the request the refresh query sends for the current refresh token. Set it whenever the
+     * API names that field anything other than `token`.
+     *
+     * @default (refreshToken) => ({ body: { token: refreshToken } })
+     *
+     * @example
+     * withRefreshQuery('refresh', {
+     *   queryCreator: refresh,
+     *   buildArgs: (refreshToken) => ({ body: { refresh_token: refreshToken } }),
+     * });
+     */
+    buildArgs?: (refreshToken: string) => RequestArgs<TArgs>;
     /**
      * The property name in the decoded JWT that contains the expiration time (in seconds).
      * @default 'exp'