@crossauth/sveltekit 0.0.15 → 0.0.16

package/dist/sveltekitoauthclient.d.ts

@@ -1,4 +1,4 @@
-import { CrossauthError, ErrorCode, OAuthTokenResponse, OAuthDeviceAuthorizationResponse } from '@crossauth/common';
+import { CrossauthError, ErrorCode, OAuthTokenResponse, OAuthDeviceAuthorizationResponse, User } from '@crossauth/common';
 import { OAuthClientBackend, OAuthClientOptions } from '@crossauth/backend';
 import { SvelteKitServer } from './sveltekitserver';
 import { RequestEvent, MaybePromise } from '@sveltejs/kit';
@@ -54,9 +54,13 @@ export interface SvelteKitOAuthClientOptions extends OAuthClientOptions {
      * @param client the OAuth client
      * @param event the SvelteKit request event
      * @param silent if true, don't return a Response, only JSON or undefined.
+     * @param setUserFn if implementing this function you should call this
+     *        when you receive a valid ID token
      * @returns a Response, JSON or undefined
      */
-    receiveTokenFn?: (oauthResponse: OAuthTokenResponse, client: SvelteKitOAuthClient, event: RequestEvent, silent: boolean) => Promise<Response | TokenReturn | undefined>;
+    receiveTokenFn?: (oauthResponse: OAuthTokenResponse, client: SvelteKitOAuthClient, event: RequestEvent, silent: boolean, setUserFn: (event: RequestEvent, token: {
+        [key: string]: any;
+    }) => Promise<void>) => Promise<Response | TokenReturn | undefined>;
     /**
      * The function to call when there is an OAuth error and
      * {@link SvelteKitOAuthClientOptions.errorResponseType}
@@ -354,6 +358,15 @@ export declare class SvelteKitOAuthClient extends OAuthClientBackend {
      * @param options See {@link SvelteKitOAuthClientOptions}
      */
     constructor(server: SvelteKitServer, authServerBaseUrl: string, options: SvelteKitOAuthClientOptions);
+    /**
+     * If you implement your own function to receive tokens and you use BFF,
+     * use this function to set `event.locals.user`.
+     * @param event the Sveltekit request event
+     * @param token the ID token
+     */
+    setEventLocalsUser(event: RequestEvent, token: {
+        [key: string]: any;
+    }): Promise<void>;
     private passwordPost;
     private passwordMfa;
     private passwordOtp;
@@ -470,6 +483,17 @@ export declare class SvelteKitOAuthClient extends OAuthClientBackend {
             access_token?: string | undefined;
             refresh_token?: string | undefined;
             id_token?: string | undefined;
+            /**
+             * This function is called after successful authorization to pass the
+             * new tokens to.
+             * @param oauthResponse the response from the OAuth `token` endpoint.
+             * @param client the OAuth client
+             * @param event the SvelteKit request event
+             * @param silent if true, don't return a Response, only JSON or undefined.
+             * @param setUserFn if implementing this function you should call this
+             *        when you receive a valid ID token
+             * @returns a Response, JSON or undefined
+             */
             token_type?: string | undefined;
             expires_in?: number | undefined;
             error?: string | undefined;
@@ -494,6 +518,17 @@ export declare class SvelteKitOAuthClient extends OAuthClientBackend {
             access_token?: string | undefined;
             refresh_token?: string | undefined;
             id_token?: string | undefined;
+            /**
+             * This function is called after successful authorization to pass the
+             * new tokens to.
+             * @param oauthResponse the response from the OAuth `token` endpoint.
+             * @param client the OAuth client
+             * @param event the SvelteKit request event
+             * @param silent if true, don't return a Response, only JSON or undefined.
+             * @param setUserFn if implementing this function you should call this
+             *        when you receive a valid ID token
+             * @returns a Response, JSON or undefined
+             */
             token_type?: string | undefined;
             expires_in?: number | undefined;
             error?: string | undefined;
@@ -516,6 +551,17 @@ export declare class SvelteKitOAuthClient extends OAuthClientBackend {
             access_token?: string | undefined;
             refresh_token?: string | undefined;
             id_token?: string | undefined;
+            /**
+             * This function is called after successful authorization to pass the
+             * new tokens to.
+             * @param oauthResponse the response from the OAuth `token` endpoint.
+             * @param client the OAuth client
+             * @param event the SvelteKit request event
+             * @param silent if true, don't return a Response, only JSON or undefined.
+             * @param setUserFn if implementing this function you should call this
+             *        when you receive a valid ID token
+             * @returns a Response, JSON or undefined
+             */
             token_type?: string | undefined;
             expires_in?: number | undefined;
             error?: string | undefined;
@@ -545,7 +591,7 @@ export declare class SvelteKitOAuthClient extends OAuthClientBackend {
                 errorMessage?: undefined;
             } | {
                 ok: boolean;
-                user: import('@crossauth/common').User | undefined;
+                user: User | undefined;
                 csrfToken: string | undefined;
                 errorCode: ErrorCode;
                 errorCodeName: string;

package/dist/tests/sveltekitoauthclient.test.d.ts

@@ -1,4 +1,4 @@
-export declare function oauthLogin(): Promise<{
+export declare function oauthLogin(options?: {}): Promise<{
     server: import('..').SvelteKitServer;
     authServer: import('@crossauth/backend').OAuthAuthorizationServer;
     sessionCookieValue: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crossauth/sveltekit",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "license": "Apache-2.0",
   "private": false,
   "type": "module",
@@ -46,8 +46,8 @@
     "minimatch": "^10.0.1",
     "qrcode": "^1.5.4",
     "vite-plugin-dts": "^3.6.4",
-    "@crossauth/common": "^0.0.15",
-    "@crossauth/backend": "^0.0.15"
+    "@crossauth/common": "^0.0.16",
+    "@crossauth/backend": "^0.0.16"
   },
   "scripts": {
     "dev": "vite dev",