@monocloud/auth-core 0.1.4 → 0.1.5

package/dist/index.d.cts

@@ -1,274 +0,0 @@
-import { A as ResponseTypes, C as ParResponse, D as RefreshGrantOptions, E as RefetchUserInfoOptions, M as UserinfoResponse, O as RefreshSessionOptions, S as OnSessionCreating, T as PushedAuthorizationParams, _ as Jwks, a as Authenticators, b as MonoCloudSession, c as ClientAuthMethod, d as EndSessionParameters, f as Group, g as Jwk, h as JWSAlgorithm, i as AuthenticateOptions, j as Tokens, k as ResponseModes, l as CodeChallengeMethod, m as IssuerMetadata, n as Address, o as AuthorizationParams, p as IdTokenClaims, r as AuthState, s as CallbackParams, t as AccessToken, u as DisplayOptions, v as JwsHeaderParameters, w as Prompt, x as MonoCloudUser, y as MonoCloudClientOptions } from "./types-BAE9nCpJ.cjs";
-
-//#region src/errors/monocloud-auth-base-error.d.ts
-declare class MonoCloudAuthBaseError extends Error {}
-//#endregion
-//#region src/errors/monocloud-op-error.d.ts
-declare class MonoCloudOPError extends MonoCloudAuthBaseError {
-  error: string;
-  errorDescription?: string;
-  constructor(error: string, errorDescription?: string);
-}
-//#endregion
-//#region src/errors/monocloud-http-error.d.ts
-declare class MonoCloudHttpError extends MonoCloudAuthBaseError {}
-//#endregion
-//#region src/errors/monocloud-token-error.d.ts
-declare class MonoCloudTokenError extends MonoCloudAuthBaseError {}
-//#endregion
-//#region src/errors/monocloud-validation-error.d.ts
-declare class MonoCloudValidationError extends MonoCloudAuthBaseError {}
-//#endregion
-//#region src/monocloud-oidc-client.d.ts
-declare class MonoCloudOidcClient {
-  private readonly tenantDomain;
-  private readonly clientId;
-  private readonly clientSecret?;
-  private readonly authMethod;
-  private readonly idTokenSigningAlgorithm;
-  private jwks?;
-  private jwksCacheExpiry;
-  private jwksCacheDuration;
-  private metadata?;
-  private metadataCacheExpiry;
-  private metadataCacheDuration;
-  constructor(tenantDomain: string, clientId: string, options?: MonoCloudClientOptions);
-  /**
-   * Generates an authorization URL with specified parameters.
-   *
-   * If no values are provided for `responseType`, or `codeChallengeMethod`, they default to `code`, and `S256`, respectively.
-   *
-   * @param params Authorization URL parameters
-   *
-   * @returns Tenant's authorization url.
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   */
-  authorizationUrl(params: AuthorizationParams): Promise<string>;
-  /**
-   * Fetches the authorization server metadata from the .well-known endpoint.
-   * The metadata is cached for 1 minute.
-   *
-   * @param forceRefresh - If `true`, bypasses the cache and fetches fresh metadata from the server.
-   *
-   * @returns The issuer metadata for the tenant, retrieved from the OpenID Connect discovery endpoint.
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   */
-  getMetadata(forceRefresh?: boolean): Promise<IssuerMetadata>;
-  /**
-   * Fetches the JSON Web Keys used to sign the id token.
-   * The JWKS is cached for 1 minute.
-   *
-   * @param forceRefresh - If `true`, bypasses the cache and fetches fresh set of JWKS from the server.
-   *
-   * @returns The JSON Web Key Set containing the public keys for token verification.
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   */
-  getJwks(forceRefresh?: boolean): Promise<Jwks>;
-  /**
-   * Performs a pushed authorization request.
-   *
-   * @param params - Authorization Parameters
-   *
-   * @returns Response from Pushed Authorization Request (PAR) endpoint
-   *
-   * @throws {@link MonoCloudOPError} - When the request is invalid.
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   */
-  pushedAuthorizationRequest(params: PushedAuthorizationParams): Promise<ParResponse>;
-  /**
-   * Fetches userinfo associated with the provided access token.
-   *
-   * @param accessToken - A valid access token used to retrieve userinfo.
-   *
-   * @returns The authenticated user's claims.
-   *
-   * @throws {@link MonoCloudOPError} - When the OpenID Provider returns a standardized
-   * OAuth 2.0 error (e.g., 'invalid_token') in the 'WWW-Authenticate' header
-   * following a 401 Unauthorized response.
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   * @throws {@link MonoCloudValidationError} - When the access token is invalid.
-   *
-   */
-  userinfo(accessToken: string): Promise<UserinfoResponse>;
-  /**
-   * Generates OpenID end session url for signing out.
-   *
-   * Note - The `state` is added only when `postLogoutRedirectUri` is present.
-   *
-   * @param params - Parameters to build end session url
-   *
-   * @returns Tenant's end session url
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   */
-  endSessionUrl(params: EndSessionParameters): Promise<string>;
-  /**
-   * Exchanges an authorization code for tokens.
-   *
-   * @param code - The authorization code received from the authorization server.
-   * @param redirectUri - The redirect URI used in the initial authorization request.
-   * @param codeVerifier - Code verifier for PKCE.
-   * @param resource - Space-separated list of resources the access token should be scoped to
-   *
-   * @returns Tokens obtained by exchanging an authorization code at the token endpoint.
-   *
-   * @throws {@link MonoCloudOPError} - When the OpenID Provider returns a standardized
-   * OAuth 2.0 error response.
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   */
-  exchangeAuthorizationCode(code: string, redirectUri: string, codeVerifier?: string, resource?: string): Promise<Tokens>;
-  /**
-   * Exchanges a refresh token for new tokens.
-   *
-   * @param refreshToken - The refresh token used to request new tokens.
-   * @param options - Refresh grant options.
-   *
-   * @returns Tokens obtained by exchanging a refresh token at the token endpoint.
-   *
-   * @throws {@link MonoCloudOPError} - When the OpenID Provider returns a standardized
-   * OAuth 2.0 error response.
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   */
-  refreshGrant(refreshToken: string, options?: RefreshGrantOptions): Promise<Tokens>;
-  /**
-   * Generates a session with user and tokens by exchanging authorization code from callback params.
-   *
-   * @param code - The authorization code received from the callback
-   * @param redirectUri - The redirect URI that was used in the authorization request
-   * @param requestedScopes - A space-separated list of scopes originally requested via the `/authorize` endpoint.
-   * This is stored in the session to ensure the correct access token can be identified and refreshed during `refreshSession()`.
-   * @param resource - A space-separated list of resource indicators originally requested via the `/authorize` endpoint.
-   * Used alongside scopes to uniquely identify and refresh the specific access token associated with these resources.
-   * @param options - Options for authenticating a user with authorization code
-   *
-   * @returns The user's session containing authentication tokens and user information.
-   *
-   * @throws {@link MonoCloudValidationError} - When the token scope does not contain the openid scope,
-   * or if 'expires_in' or 'scope' is missing from the token response.
-   *
-   * @throws {@link MonoCloudOPError} - When the OpenID Provider returns a standardized
-   * OAuth 2.0 error response.
-   *
-   * @throws {@link MonoCloudTokenError} - If ID Token validation fails
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   */
-  authenticate(code: string, redirectUri: string, requestedScopes: string, resource?: string, options?: AuthenticateOptions): Promise<MonoCloudSession>;
-  /**
-   * Refetches user information for an existing session using the userinfo endpoint.
-   * Updates the session's user object with the latest user information while preserving existing properties.
-   *
-   * @param accessToken - Access token used to fetch the userinfo
-   * @param session - The current MonoCloudSession
-   * @param options - Userinfo refetch options
-   *
-   * @returns Updated session with the latest userinfo
-   *
-   * @throws {@link MonoCloudValidationError} - When the token scope does not contain openid scope
-   *
-   * @throws {@link MonoCloudOPError} - When the OpenID Provider returns a standardized
-   * OAuth 2.0 error response.
-   *
-   * @throws {@link MonoCloudTokenError} - If ID Token validation fails
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   */
-  refetchUserInfo(accessToken: AccessToken, session: MonoCloudSession, options?: RefetchUserInfoOptions): Promise<MonoCloudSession>;
-  /**
-   * Refreshes an existing session using the refresh token.
-   * This function requests new tokens using the refresh token and optionally updates user information.
-   *
-   * @param session - The current MonoCloudSession containing the refresh token
-   * @param options - Session refresh options
-   *
-   * @returns User's session containing refreshed authentication tokens and user information.
-   *
-   * @throws {@link MonoCloudValidationError} - If the refresh token is not present in the session,
-   * or if 'expires_in' or 'scope' (including the openid scope) is missing from the token response.
-   *
-   * @throws {@link MonoCloudOPError} - When the OpenID Provider returns a standardized
-   * OAuth 2.0 error response.
-   *
-   * @throws {@link MonoCloudTokenError} - If ID Token validation fails
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   *
-   */
-  refreshSession(session: MonoCloudSession, options?: RefreshSessionOptions): Promise<MonoCloudSession>;
-  /**
-   * Revokes an access token or refresh token, rendering it invalid for future use.
-   *
-   * @param token - The token string to be revoked
-   * @param tokenType - Hint about the token type ('access_token' or 'refresh_token')
-   *
-   * @returns If token revocation succeeded
-   *
-   * @throws {@link MonoCloudValidationError} - If token is invalid or unsupported token type
-   *
-   * @throws {@link MonoCloudOPError} - When the OpenID Provider returns a standardized
-   * OAuth 2.0 error response.
-   *
-   * @throws {@link MonoCloudHttpError} - Thrown if there is a network error during the request or
-   * unexpected status code during the request or a serialization error while processing the response.
-   */
-  revokeToken(token: string, tokenType?: string): Promise<void>;
-  /**
-   * Validates an ID Token.
-   *
-   * @param idToken - The ID Token JWT string to validate
-   * @param jwks - Array of JSON Web Keys (JWK) used to verify the token's signature
-   * @param clockSkew - Number of seconds to adjust the current time to account for clock differences
-   * @param clockTolerance - Additional time tolerance in seconds for time-based claim validation
-   * @param maxAge - maximum authentication age in seconds
-   * @param nonce - nonce value to validate against the token's nonce claim
-   *
-   * @returns Validated ID Token claims
-   *
-   * @throws {@link MonoCloudTokenError} - If ID Token validation fails
-   *
-   */
-  validateIdToken(idToken: string, jwks: Jwk[], clockSkew: number, clockTolerance: number, maxAge?: number, nonce?: string): Promise<IdTokenClaims>;
-  /**
-   * Decodes the payload of a JSON Web Token (JWT) and returns it as an object.
-   * **THIS METHOD DOES NOT VERIFY JWT TOKENS**.
-   *
-   * @param jwt - JWT to decode
-   *
-   * @returns Decoded payload
-   *
-   * @throws {@link MonoCloudTokenError} - If decoding fails
-   *
-   */
-  static decodeJwt(jwt: string): IdTokenClaims;
-}
-//#endregion
-export { type AccessToken, type Address, type AuthState, type AuthenticateOptions, type Authenticators, type AuthorizationParams, type CallbackParams, type ClientAuthMethod, type CodeChallengeMethod, type DisplayOptions, type EndSessionParameters, type Group, type IdTokenClaims, type IssuerMetadata, type JWSAlgorithm, type Jwk, type Jwks, type JwsHeaderParameters, MonoCloudAuthBaseError, type MonoCloudClientOptions, MonoCloudHttpError, MonoCloudOPError, MonoCloudOidcClient, type MonoCloudSession, MonoCloudTokenError, type MonoCloudUser, MonoCloudValidationError, type OnSessionCreating, type ParResponse, type Prompt, type PushedAuthorizationParams, type RefetchUserInfoOptions, type RefreshGrantOptions, type RefreshSessionOptions, type ResponseModes, type ResponseTypes, type Tokens, type UserinfoResponse };
-//# sourceMappingURL=index.d.cts.map