@forgerock/oidc-client 1.2.0 → 2.0.0

package/dist/src/lib/authorize.request.utils.js

@@ -0,0 +1,101 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+import { createAuthorizeUrl } from '@forgerock/sdk-oidc';
+import { Micro } from 'effect';
+/**
+ * @function buildAuthorizeOptionsµ
+ * @description Builds the authorization options for the OIDC client.
+ * @param {WellknownResponse} wellknown - The well-known configuration for the OIDC server.
+ * @param {OptionalAuthorizeOptions} options - Optional parameters for the authorization request.
+ * @returns {Micro.Micro<BuildAuthorizationData, AuthorizationError, never>}
+ */
+export function buildAuthorizeOptionsµ(wellknown, config, options) {
+    const isPiFlow = wellknown.response_modes_supported?.includes('pi.flow');
+    return Micro.sync(() => [
+        wellknown.authorization_endpoint,
+        {
+            clientId: config.clientId,
+            redirectUri: config.redirectUri,
+            scope: config.scope || 'openid',
+            responseType: config.responseType || 'code',
+            ...(isPiFlow && { responseMode: 'pi.flow' }),
+            ...options,
+        },
+    ]);
+}
+/**
+ * @function createAuthorizeErrorµ
+ * @description Creates an error response with new Authorize URL for the authorization request.
+ * @param { error: string; error_description: string } res - The error response from the authorization request.
+ * @param {WellknownResponse} wellknown- The well-known configuration for the OIDC server.
+ * @param { OidcConfig } config- The OIDC client configuration.
+ * @param { GetAuthorizationUrlOptions } options- Optional parameters for the authorization request.
+ * @returns { Micro.Micro<never, AuthorizationError, never> }
+ */
+export function createAuthorizeErrorµ(res, wellknown, options) {
+    return Micro.tryPromise({
+        try: () => createAuthorizeUrl(wellknown.authorization_endpoint, {
+            ...options,
+        }),
+        catch: (error) => {
+            let message = 'Error creating authorization URL';
+            if (error instanceof Error) {
+                message = error.message;
+            }
+            return {
+                error: 'AuthorizationUrlError',
+                error_description: message,
+                type: 'auth_error',
+            };
+        },
+    }).pipe(Micro.flatMap((url) => {
+        return Micro.fail({
+            error: res.error,
+            error_description: res.error_description,
+            type: 'auth_error',
+            redirectUrl: url,
+        });
+    }));
+}
+/**
+ * @function createAuthorizeUrlµ
+ * @description Creates an authorization URL and related options/config for the Authorize request.
+ * @param {string} path - The path to the authorization endpoint.
+ * @param { GetAuthorizationUrlOptions } options - Optional parameters for the authorization request.
+ * @returns { Micro.Micro<[string, GetAuthorizationUrlOptions], AuthorizationError, never> }
+ */
+export function createAuthorizeUrlµ(path, options) {
+    return Micro.tryPromise({
+        try: async () => [
+            await createAuthorizeUrl(path, {
+                ...options,
+                prompt: 'none',
+            }),
+            options,
+        ],
+        catch: (error) => {
+            let message = 'Error creating authorization URL';
+            if (error instanceof Error) {
+                message = error.message;
+            }
+            return {
+                error: 'AuthorizationUrlError',
+                error_description: message,
+                type: 'auth_error',
+            };
+        },
+    });
+}
+export function handleResponseµ(response, wellknown, options) {
+    if ('code' in response) {
+        return Micro.sync(() => response);
+    }
+    else {
+        return createAuthorizeErrorµ(response, wellknown, options);
+    }
+}
+//# sourceMappingURL=authorize.request.utils.js.map

package/dist/src/lib/authorize.request.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorize.request.utils.js","sourceRoot":"","sources":["../../../src/lib/authorize.request.utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAW/B;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CACpC,SAA4B,EAC5B,MAAkB,EAClB,OAAkC;IAElC,MAAM,QAAQ,GAAG,SAAS,CAAC,wBAAwB,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IACzE,OAAO,KAAK,CAAC,IAAI,CACf,GAA2B,EAAE,CAAC;QAC5B,SAAS,CAAC,sBAAsB;QAChC;YACE,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,QAAQ;YAC/B,YAAY,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM;YAC3C,GAAG,CAAC,QAAQ,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC;YAC5C,GAAG,OAAO;SACX;KACF,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,qBAAqB,CACnC,GAAiD,EACjD,SAA4B,EAC5B,OAAmC;IAEnC,OAAO,KAAK,CAAC,UAAU,CAAC;QACtB,GAAG,EAAE,GAAG,EAAE,CACR,kBAAkB,CAAC,SAAS,CAAC,sBAAsB,EAAE;YACnD,GAAG,OAAO;SACX,CAAC;QACJ,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,OAAO,GAAG,kCAAkC,CAAC;YACjD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;YAC1B,CAAC;YACD,OAAO;gBACL,KAAK,EAAE,uBAAuB;gBAC9B,iBAAiB,EAAE,OAAO;gBAC1B,IAAI,EAAE,YAAY;aACV,CAAC;QACb,CAAC;KACF,CAAC,CAAC,IAAI,CACL,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACpB,OAAO,KAAK,CAAC,IAAI,CAAC;YAChB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,iBAAiB,EAAE,GAAG,CAAC,iBAAiB;YACxC,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,GAAG;SACR,CAAC,CAAC;IACd,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAY,EACZ,OAAmC;IAEnC,OAAO,KAAK,CAAC,UAAU,CAAC;QACtB,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC;YACf,MAAM,kBAAkB,CAAC,IAAI,EAAE;gBAC7B,GAAG,OAAO;gBACV,MAAM,EAAE,MAAM;aACf,CAAC;YACF,OAAO;SACR;QACD,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,OAAO,GAAG,kCAAkC,CAAC;YACjD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;YAC1B,CAAC;YACD,OAAO;gBACL,KAAK,EAAE,uBAAuB;gBAC9B,iBAAiB,EAAE,OAAO;gBAC1B,IAAI,EAAE,YAAY;aACV,CAAC;QACb,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,QAAmD,EACnD,SAA4B,EAC5B,OAAmC;IAEnC,IAAI,MAAM,IAAI,QAAQ,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;SAAM,CAAC;QACN,OAAO,qBAAqB,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC"}

package/dist/src/lib/authorize.slice.d.ts

@@ -0,0 +1,5 @@
+declare const authorizeSlice: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, {
+    handleAuthorize: import("@reduxjs/toolkit/query").QueryDefinition<string, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {}, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, string, "authorizeSlice", unknown>;
+}, "authorizeSlice", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
+export { authorizeSlice };
+//# sourceMappingURL=authorize.slice.d.ts.map

package/dist/src/lib/authorize.slice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorize.slice.d.ts","sourceRoot":"","sources":["../../../src/lib/authorize.slice.ts"],"names":[],"mappings":"AAQA,QAAA,MAAM,cAAc;;mFAkBlB,CAAC;AAEH,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/src/lib/authorize.slice.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query';
+const authorizeSlice = createApi({
+    reducerPath: 'authorizeSlice',
+    baseQuery: fetchBaseQuery({
+        credentials: 'include',
+        prepareHeaders: (headers) => {
+            headers.set('Content-Type', 'application/json');
+            headers.set('Accept', 'application/json');
+            headers.set('x-requested-with', 'ping-sdk');
+            headers.set('x-requested-platform', 'javascript');
+            return headers;
+        },
+    }),
+    endpoints: (builder) => ({
+        handleAuthorize: builder.query({
+            query: (authorizeUrl) => authorizeUrl,
+        }),
+    }),
+});
+export { authorizeSlice };
+//# sourceMappingURL=authorize.slice.js.map

package/dist/src/lib/authorize.slice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorize.slice.js","sourceRoot":"","sources":["../../../src/lib/authorize.slice.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAEnE,MAAM,cAAc,GAAG,SAAS,CAAC;IAC/B,WAAW,EAAE,gBAAgB;IAC7B,SAAS,EAAE,cAAc,CAAC;QACxB,WAAW,EAAE,SAAS;QACtB,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE;YAC1B,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;YAChD,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;YAC1C,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC;YAC5C,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,YAAY,CAAC,CAAC;YAElD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;IACF,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACvB,eAAe,EAAE,OAAO,CAAC,KAAK,CAAiB;YAC7C,KAAK,EAAE,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY;SACtC,CAAC;KACH,CAAC;CACH,CAAC,CAAC;AAEH,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/src/lib/client.store.d.ts

@@ -0,0 +1,115 @@
+import type { ActionTypes, RequestMiddleware } from '@forgerock/sdk-request-middleware';
+import type { GenericError, GetAuthorizationUrlOptions } from '@forgerock/sdk-types';
+import type { CustomLogger, LogLevel } from '@forgerock/sdk-logger';
+import type { StorageConfig } from '@forgerock/storage';
+import type { GetTokensOptions, LogoutErrorResult, LogoutSuccessResult, RevokeErrorResult, RevokeSuccessResult, UserInfoResponse } from './client.types.js';
+import type { OauthTokens, OidcConfig } from './config.types.js';
+import type { AuthorizationError, AuthorizationSuccess } from './authorize.request.types.js';
+import type { TokenExchangeErrorResponse } from './exchange.types.js';
+/**
+ * @function oidc
+ * @description Factory function to create an OIDC client with methods for authorization, token exchange,
+ *              user info retrieval, and logout. It initializes the client with the provided configuration,
+ *              request middleware, logger, and storage options.
+ * @param param - configuration object containing the OIDC client configuration, request middleware, logger,
+ * @param {OidcConfig} param.config - OIDC configuration including server details, client ID, redirect URI,
+ *              storage options, scope, and response type.
+ * @param {RequestMiddleware} param.requestMiddleware - optional array of request middleware functions to process requests.
+ * @param {{ level: LogLevel, custom: CustomLogger }} param.logger - optional logger configuration with log level and custom logger.
+ * @param {Partial<StorageConfig>} param.storage - optional storage configuration for persisting OIDC tokens.
+ * @returns {ReturnType<typeof oidc>} - Returns an object with methods for authorization, token exchange, user info retrieval, and logout.
+ */
+export declare function oidc<ActionType extends ActionTypes = ActionTypes>({ config, requestMiddleware, logger, storage, }: {
+    config: OidcConfig;
+    requestMiddleware?: RequestMiddleware<ActionType>[];
+    logger?: {
+        level: LogLevel;
+        custom?: CustomLogger;
+    };
+    storage?: Partial<StorageConfig>;
+}): Promise<{
+    error: string;
+    type: string;
+    /**
+     * An object containing methods for the creation, and background use, of the authorization URL
+     */
+    authorize?: undefined;
+    /**
+     * An object containing methods for token management
+     */
+    token?: undefined;
+    /**
+     * An object containing methods for user info retrieval and logout
+     */
+    user?: undefined;
+} | {
+    /**
+     * An object containing methods for the creation, and background use, of the authorization URL
+     */
+    authorize: {
+        /**
+         * @method url
+         * @description Creates an authorization URL with the provided options or defaults from the configuration.
+         * @param {GetAuthorizationUrlOptions} options - Optional parameters to customize the authorization URL.
+         * @returns {Promise<string | GenericError>} - Returns a promise that resolves to the authorization URL or an error.
+         */
+        url: (options?: GetAuthorizationUrlOptions) => Promise<string | GenericError>;
+        /**
+         * @function background - Initiates the authorization process in the background, returning code and state or an error.
+         * @param {GetAuthorizationUrlOptions} options - Optional parameters to customize the authorization URL.
+         * @returns {Promise<AuthorizeErrorResponse | AuthorizeSuccessResponse>} - Returns a promise that resolves to code and state or an error response.
+         */
+        background: (options?: GetAuthorizationUrlOptions) => Promise<AuthorizationSuccess | AuthorizationError>;
+    };
+    /**
+     * An object containing methods for token management
+     */
+    token: {
+        /**
+         * @method exchange
+         * @description Exchanges an authorization code for tokens using the token endpoint from the wellknown
+         *              configuration and stores them in the configured storage.
+         * @param {string} code - The authorization code received from the authorization server.
+         * @param {string} state - The state parameter from the authorization URL creation.
+         * @param {Partial<StorageConfig>} options - Optional storage configuration for persisting tokens.
+         * @returns {Promise<OauthTokens | GenericError | TokenExchangeErrorResponse>}
+         */
+        exchange: (code: string, state: string, options?: Partial<StorageConfig>) => Promise<OauthTokens | TokenExchangeErrorResponse | GenericError>;
+        /**
+         * @method get
+         * @description Retrieves the current OAuth tokens from storage, or auto-renew if backgroundRenew is true.
+         * @param {GetTokensOptions} param - An object containing options for the token retrieval.
+         * @returns {Promise<OauthTokens | TokenExchangeErrorResponse | AuthorizationError | GenericError>}
+         */
+        get: (options?: GetTokensOptions) => Promise<OauthTokens | TokenExchangeErrorResponse | AuthorizationError | GenericError>;
+        /**
+         * @method revoke
+         * @description Revokes an access token using the revocation endpoint from the wellknown configuration.
+         *              It requires an access token stored in the configured storage.
+         * @returns {Promise<GenericError | RevokeSuccessResult | RevokeErrorResult>} - Returns a promise that resolves to the revoke response or an error response.
+         */
+        revoke: () => Promise<GenericError | RevokeSuccessResult | RevokeErrorResult>;
+    };
+    /**
+     * An object containing methods for user info retrieval and logout
+     */
+    user: {
+        /**
+         * @method info
+         * @description Retrieves user information using the userinfo endpoint from the wellknown configuration.
+         *              It requires an access token stored in the configured storage.
+         * @returns {Promise<GenericError | UserInfoResponse>} - Returns a promise that resolves to user information or an error response.
+         */
+        info: () => Promise<GenericError | UserInfoResponse>;
+        /**
+         * @method logout
+         * @description Logs out the user by revoking tokens and clearing the storage.
+         *              It uses the end session endpoint from the wellknown configuration.
+         * @returns {Promise<GenericError | LogoutSuccessResult | LogoutErrorResult>} - Returns a promise that resolves to the logout response or an error.
+         */
+        logout: () => Promise<GenericError | LogoutSuccessResult | LogoutErrorResult>;
+    };
+    error?: undefined;
+    type?: undefined;
+}>;
+//# sourceMappingURL=client.store.d.ts.map

package/dist/src/lib/client.store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.store.d.ts","sourceRoot":"","sources":["../../../src/lib/client.store.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACxF,OAAO,KAAK,EAAE,YAAY,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AACrF,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAExD,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAC7F,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAItE;;;;;;;;;;;;GAYG;AACH,wBAAsB,IAAI,CAAC,UAAU,SAAS,WAAW,GAAG,WAAW,EAAE,EACvE,MAAM,EACN,iBAAiB,EACjB,MAAM,EACN,OAAO,GACR,EAAE;IACD,MAAM,EAAE,UAAU,CAAC;IACnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;IACpD,MAAM,CAAC,EAAE;QACP,KAAK,EAAE,QAAQ,CAAC;QAChB,MAAM,CAAC,EAAE,YAAY,CAAC;KACvB,CAAC;IACF,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;CAClC;;;IAkCG;;OAEG;;IAkEH;;OAEG;;IA2PH;;OAEG;;;IAnUH;;OAEG;;QAED;;;;;WAKG;wBACmB,0BAA0B,KAAG,OAAO,CAAC,MAAM,GAAG,YAAY,CAAC;QAsBjF;;;;WAIG;+BAES,0BAA0B,KACnC,OAAO,CAAC,oBAAoB,GAAG,kBAAkB,CAAC;;IA6BvD;;OAEG;;QAED;;;;;;;;WAQG;yBAEK,MAAM,SACL,MAAM,YACH,OAAO,CAAC,aAAa,CAAC,KAC/B,OAAO,CAAC,WAAW,GAAG,0BAA0B,GAAG,YAAY,CAAC;QAwCnE;;;;;WAKG;wBAES,gBAAgB,KACzB,OAAO,CAAC,WAAW,GAAG,0BAA0B,GAAG,kBAAkB,GAAG,YAAY,CAAC;QA0FxF;;;;;WAKG;sBACe,OAAO,CAAC,YAAY,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;;IA4FnF;;OAEG;;QAED;;;;;WAKG;oBACa,OAAO,CAAC,YAAY,GAAG,gBAAgB,CAAC;QAgExD;;;;;WAKG;sBACe,OAAO,CAAC,YAAY,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;;;;GAkDtF"}