@_mustachio/openauth 0.9.2 → 0.10.0

package/dist/types/provider/m2m.d.ts

@@ -1,34 +0,0 @@
-import { Provider } from "./provider.js";
-export interface M2MProviderConfig {
-    /**
-     * Callback to verify client credentials.
-     * Should return data about the client (e.g., associated User or Org ID).
-     * Returning undefined or throwing indicates invalid credentials.
-     */
-    verify: (clientID: string, clientSecret: string, params: Record<string, string>) => Promise<{
-        id: string;
-        [key: string]: any;
-    } | undefined>;
-}
-/**
- * Creates a provider for Machine-to-Machine (M2M) authentication using the
- * OAuth 2.0 `client_credentials` grant type.
- *
- * This provider does not have a UI and is intended for service-to-service
- * communication where the client can securely store a secret.
- *
- * @example
- * ```ts
- * const m2m = M2MProvider({
- *   verify: async (clientID, clientSecret) => {
- *     const client = await db.clients.findUnique({ where: { clientID } })
- *     if (client && client.secret === clientSecret) return client
- *   }
- * })
- * ```
- */
-export declare function M2MProvider(config: M2MProviderConfig): Provider<{
-    id: string;
-    [key: string]: any;
-}>;
-//# sourceMappingURL=m2m.d.ts.map

package/dist/types/provider/m2m.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"m2m.d.ts","sourceRoot":"","sources":["../../../src/provider/m2m.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,MAAM,EAAE,CACN,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAC3B,OAAO,CACR;QACE,EAAE,EAAE,MAAM,CAAA;QACV,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB,GACD,SAAS,CACZ,CAAA;CACF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,QAAQ,CAAC;IAC/D,EAAE,EAAE,MAAM,CAAA;IACV,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB,CAAC,CAcD"}

package/dist/types/provider/microsoft.d.ts

@@ -1,89 +0,0 @@
-/**
- * Use this provider to authenticate with Microsoft. Supports both OAuth2 and OIDC.
- *
- * #### Using OAuth
- *
- * ```ts {5-9}
- * import { MicrosoftProvider } from "@openauthjs/openauth/provider/microsoft"
- *
- * export default issuer({
- *   providers: {
- *     microsoft: MicrosoftProvider({
- *       tenant: "1234567890",
- *       clientID: "1234567890",
- *       clientSecret: "0987654321"
- *     })
- *   }
- * })
- * ```
- *
- * #### Using OIDC
- *
- * ```ts {5-7}
- * import { MicrosoftOidcProvider } from "@openauthjs/openauth/provider/microsoft"
- *
- * export default issuer({
- *   providers: {
- *     microsoft: MicrosoftOidcProvider({
- *       clientID: "1234567890"
- *     })
- *   }
- * })
- * ```
- *
- * @packageDocumentation
- */
-import { Oauth2WrappedConfig } from "./oauth2.js";
-import { OidcWrappedConfig } from "./oidc.js";
-export interface MicrosoftConfig extends Oauth2WrappedConfig {
-    /**
-     * The tenant ID of the Microsoft account.
-     *
-     * This is usually the same as the client ID.
-     *
-     * @example
-     * ```ts
-     * {
-     *   tenant: "1234567890"
-     * }
-     * ```
-     */
-    tenant: string;
-}
-export interface MicrosoftOidcConfig extends OidcWrappedConfig {
-}
-/**
- * Create a Microsoft OAuth2 provider.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * MicrosoftProvider({
- *   tenant: "1234567890",
- *   clientID: "1234567890",
- *   clientSecret: "0987654321"
- * })
- * ```
- */
-export declare function MicrosoftProvider(config: MicrosoftConfig): import("./provider.js").Provider<{
-    tokenset: import("./oauth2.js").Oauth2Token;
-    clientID: string;
-}>;
-/**
- * Create a Microsoft OIDC provider.
- *
- * This is useful if you just want to verify the user's email address.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * MicrosoftOidcProvider({
- *   clientID: "1234567890"
- * })
- * ```
- */
-export declare function MicrosoftOidcProvider(config: MicrosoftOidcConfig): import("./provider.js").Provider<{
-    id: import("hono/utils/jwt/types").JWTPayload;
-    clientID: string;
-}>;
-//# sourceMappingURL=microsoft.d.ts.map

package/dist/types/provider/microsoft.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"microsoft.d.ts","sourceRoot":"","sources":["../../../src/provider/microsoft.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH,OAAO,EAAkB,mBAAmB,EAAE,MAAM,aAAa,CAAA;AACjE,OAAO,EAAgB,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAE3D,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IAC1D;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AACD,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;CAAG;AAEjE;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,eAAe;;;GASxD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,mBAAmB;;;GAMhE"}

package/dist/types/provider/oauth2.d.ts

@@ -1,133 +0,0 @@
-/**
- * Use this to connect authentication providers that support OAuth 2.0.
- *
- * ```ts {5-12}
- * import { Oauth2Provider } from "@openauthjs/openauth/provider/oauth2"
- *
- * export default issuer({
- *   providers: {
- *     oauth2: Oauth2Provider({
- *       clientID: "1234567890",
- *       clientSecret: "0987654321",
- *       endpoint: {
- *         authorization: "https://auth.myserver.com/authorize",
- *         token: "https://auth.myserver.com/token"
- *       }
- *     })
- *   }
- * })
- * ```
- *
- *
- * @packageDocumentation
- */
-import { Provider } from "./provider.js";
-export interface Oauth2Config {
-    /**
-     * @internal
-     */
-    type?: string;
-    /**
-     * The client ID.
-     *
-     * This is just a string to identify your app.
-     *
-     * @example
-     * ```ts
-     * {
-     *   clientID: "my-client"
-     * }
-     * ```
-     */
-    clientID: string;
-    /**
-     * The client secret.
-     *
-     * This is a private key that's used to authenticate your app. It should be kept secret.
-     *
-     * @example
-     * ```ts
-     * {
-     *   clientSecret: "0987654321"
-     * }
-     * ```
-     */
-    clientSecret: string;
-    /**
-     * The URLs of the authorization and token endpoints.
-     *
-     * @example
-     * ```ts
-     * {
-     *   endpoint: {
-     *     authorization: "https://auth.myserver.com/authorize",
-     *     token: "https://auth.myserver.com/token",
-     *     jwks: "https://auth.myserver.com/auth/keys"
-     *   }
-     * }
-     * ```
-     */
-    endpoint: {
-        /**
-         * The URL of the authorization endpoint.
-         */
-        authorization: string;
-        /**
-         * The URL of the token endpoint.
-         */
-        token: string;
-        /**
-         * The URL of the JWKS endpoint.
-         */
-        jwks?: string;
-    };
-    /**
-     * A list of OAuth scopes that you want to request.
-     *
-     * @example
-     * ```ts
-     * {
-     *   scopes: ["email", "profile"]
-     * }
-     * ```
-     */
-    scopes: string[];
-    /**
-     * Whether to use PKCE (Proof Key for Code Exchange) for the authorization code flow.
-     * Some providers like x.com require this.
-     * @default false
-     */
-    pkce?: boolean;
-    /**
-     * Any additional parameters that you want to pass to the authorization endpoint.
-     * @example
-     * ```ts
-     * {
-     *   query: {
-     *     access_type: "offline",
-     *     prompt: "consent"
-     *   }
-     * }
-     * ```
-     */
-    query?: Record<string, string>;
-}
-/**
- * @internal
- */
-export type Oauth2WrappedConfig = Omit<Oauth2Config, "endpoint" | "name">;
-/**
- * @internal
- */
-export interface Oauth2Token {
-    access: string;
-    refresh: string;
-    expiry: number;
-    id?: Record<string, any>;
-    raw: Record<string, any>;
-}
-export declare function Oauth2Provider(config: Oauth2Config): Provider<{
-    tokenset: Oauth2Token;
-    clientID: string;
-}>;
-//# sourceMappingURL=oauth2.d.ts.map

package/dist/types/provider/oauth2.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"oauth2.d.ts","sourceRoot":"","sources":["../../../src/provider/oauth2.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAMH,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;;;;;;;OAWG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;;;;;;;OAWG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;;;;;;;;;;;;OAaG;IACH,QAAQ,EAAE;QACR;;WAEG;QACH,aAAa,EAAE,MAAM,CAAA;QACrB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;;;;;;;;OASG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,YAAY,EAAE,UAAU,GAAG,MAAM,CAAC,CAAA;AAEzE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACxB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACzB;AAQD,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,GACnB,QAAQ,CAAC;IAAE,QAAQ,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAuJvD"}

package/dist/types/provider/oidc.d.ts

@@ -1,91 +0,0 @@
-/**
- * Use this to connect authentication providers that support OIDC.
- *
- * ```ts {5-8}
- * import { OidcProvider } from "@openauthjs/openauth/provider/oidc"
- *
- * export default issuer({
- *   providers: {
- *     oauth2: OidcProvider({
- *       clientId: "1234567890",
- *       issuer: "https://auth.myserver.com"
- *     })
- *   }
- * })
- * ```
- *
- *
- * @packageDocumentation
- */
-import { Provider } from "./provider.js";
-import { JWTPayload } from "hono/utils/jwt/types";
-export interface OidcConfig {
-    /**
-     * @internal
-     */
-    type?: string;
-    /**
-     * The client ID.
-     *
-     * This is just a string to identify your app.
-     *
-     * @example
-     * ```ts
-     * {
-     *   clientID: "my-client"
-     * }
-     * ```
-     */
-    clientID: string;
-    /**
-     * The URL of your authorization server.
-     *
-     * @example
-     * ```ts
-     * {
-     *   issuer: "https://auth.myserver.com"
-     * }
-     * ```
-     */
-    issuer: string;
-    /**
-     * A list of OIDC scopes that you want to request.
-     *
-     * @example
-     * ```ts
-     * {
-     *   scopes: ["openid", "profile", "email"]
-     * }
-     * ```
-     */
-    scopes?: string[];
-    /**
-     * Any additional parameters that you want to pass to the authorization endpoint.
-     * @example
-     * ```ts
-     * {
-     *   query: {
-     *     prompt: "consent"
-     *   }
-     * }
-     * ```
-     */
-    query?: Record<string, string>;
-}
-/**
- * @internal
- */
-export type OidcWrappedConfig = Omit<OidcConfig, "issuer" | "name">;
-/**
- * @internal
- */
-export interface IdTokenResponse {
-    idToken: string;
-    claims: Record<string, any>;
-    raw: Record<string, any>;
-}
-export declare function OidcProvider(config: OidcConfig): Provider<{
-    id: JWTPayload;
-    clientID: string;
-}>;
-//# sourceMappingURL=oidc.d.ts.map

package/dist/types/provider/oidc.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"oidc.d.ts","sourceRoot":"","sources":["../../../src/provider/oidc.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAKH,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAGjD,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;;;;;;;OAWG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;;;;;OASG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM,CAAC,CAAA;AAQnE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC3B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACzB;AAED,wBAAgB,YAAY,CAC1B,MAAM,EAAE,UAAU,GACjB,QAAQ,CAAC;IAAE,EAAE,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CA2EhD"}

package/dist/types/provider/passkey.d.ts

@@ -1,143 +0,0 @@
-/**
- * Configures a provider that supports passkey (WebAuthn) authentication.
- *
- * ```ts
- * import { PasskeyProvider } from "@openauthjs/openauth/provider/passkey"
- *
- * export default issuer({
- *   providers: {
- *     passkey: PasskeyProvider({
- *       rpName: "My Application",
- *       rpID: "example.com", // optional - can also be passed in as a query parameter (see the UI)
- *       origin: "https://example.com", // optional - can also be passed in as a query parameter (see the UI)
- *       userCanRegisterPasskey: async (userId, req) => { // optional
- *         // Check if the user is allowed to register a passkey
- *         return true
- *       }
- *     })
- *   },
- *   // ...
- * })
- * ```
- *
- * PasskeyProvider implements WebAuthn (Web Authentication) to enable passwordless
- * authentication using biometrics, mobile devices, or security keys. It handles
- * the complete flow for registering new passkeys and authenticating with them.
- *
- * The provider requires configuration of:
- * - Relying Party information (rpName, rpID)
- * - Origin validation
- * - UI handlers for authorization and registration
- *
- * It automatically manages:
- * - Challenge generation
- * - Credential storage
- * - Registration verification
- * - Authentication verification
- *
- * This implementation is powered by [@simplewebauthn/server](https://simplewebauthn.dev),
- * which provides the core WebAuthn functionality for passkey authentication.
- *
- * @packageDocumentation
- */
-import type { AuthenticatorTransportFuture, CredentialDeviceType, Base64URLString, AuthenticatorSelectionCriteria } from "@simplewebauthn/server";
-import type { Provider } from "./provider.js";
-/**
- * User model for passkey authentication.
- * Contains the core user data needed for WebAuthn operations.
- */
-export type UserModel = {
-    id: string;
-    username: string;
-};
-/**
- * Original PasskeyModel structure for in-memory use.
- * Represents a registered credential with public key as Uint8Array.
- */
-export type PasskeyModel = {
-    id: string;
-    publicKey: Uint8Array;
-    userId: string;
-    webauthnUserID: string;
-    counter: number;
-    deviceType: CredentialDeviceType;
-    backedUp: boolean;
-    transports?: AuthenticatorTransportFuture[];
-};
-/**
- * PasskeyModel version for KV storage with publicKey as string.
- * Used for storing credentials in a key-value store.
- */
-export type PasskeyModelStored = Omit<PasskeyModel, "publicKey"> & {
-    publicKey: string;
-};
-declare const DEFAULT_COPY: {
-    error_user_not_allowed: string;
-};
-/**
- * Configuration for the PasskeyProvider.
- * Defines how the passkey authentication flow should behave.
- */
-export interface PasskeyProviderConfig {
-    /**
-     * Custom authorization handler that generates the UI for authorization.
-     */
-    authorize: (req: Request) => Promise<Response>;
-    /**
-     * Custom registration handler that generates the UI for registration.
-     */
-    register: (req: Request) => Promise<Response>;
-    /**
-     * The human-readable name of the relying party (your application).
-     */
-    rpName: string;
-    /**
-     * The ID of the relying party, typically the domain name without protocol.
-     */
-    rpID?: string;
-    /**
-     * The origin URL(s) that are allowed to initiate WebAuthn ceremonies.
-     */
-    origin?: string | string[];
-    /**
-     * Optional function to check if a user is allowed to register a passkey.
-     */
-    userCanRegisterPasskey?: (userId: string, req: Request) => Promise<boolean>;
-    /**
-     * Optional WebAuthn authenticator selection criteria.
-     */
-    authenticatorSelection?: AuthenticatorSelectionCriteria;
-    /**
-     * Optional attestation type.
-     */
-    attestationType?: "none" | "direct" | "enterprise";
-    /**
-     * Optional timeout for challenges in milliseconds.
-     */
-    timeout?: number;
-    /**
-     * Custom copy texts for error messages and UI elements.
-     */
-    copy?: Partial<typeof DEFAULT_COPY>;
-}
-/**
- * Creates a passkey (WebAuthn) authentication provider.
- *
- * This provider enables passwordless authentication using biometrics, hardware security
- * keys, or platform authenticators. It implements the Web Authentication (WebAuthn) standard.
- *
- * It handles:
- * - Passkey registration (creating new credentials)
- * - Authentication with existing passkeys
- * - Secure storage of credentials
- * - Challenge verification
- *
- * @param config Configuration options for the passkey provider
- * @returns A Provider instance configured for passkey authentication
- */
-export declare function PasskeyProvider(config: PasskeyProviderConfig): Provider<{
-    userId: string;
-    credentialId?: Base64URLString;
-}>;
-export {};
-//# sourceMappingURL=passkey.d.ts.map

package/dist/types/provider/passkey.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"passkey.d.ts","sourceRoot":"","sources":["../../../src/provider/passkey.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAEH,OAAO,KAAK,EACV,4BAA4B,EAC5B,oBAAoB,EACpB,eAAe,EACf,8BAA8B,EAM/B,MAAM,wBAAwB,CAAA;AAQ/B,OAAO,KAAK,EAAE,QAAQ,EAAkC,MAAM,eAAe,CAAA;AAyD7E;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;CAEjB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,UAAU,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,oBAAoB,CAAA;IAChC,QAAQ,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,4BAA4B,EAAE,CAAA;CAC5C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,GAAG;IACjE,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAqBD,QAAA,MAAM,YAAY;;CAGjB,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE9C;;OAEG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE7C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAE1B;;OAEG;IACH,sBAAsB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IAE3E;;OAEG;IACH,sBAAsB,CAAC,EAAE,8BAA8B,CAAA;IAEvD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAA;IAElD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,YAAY,CAAC,CAAA;CACpC;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,qBAAqB,GAC5B,QAAQ,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,eAAe,CAAA;CAAE,CAAC,CAsZ9D"}