@bajustone/fortress 1.0.0-rc.1

package/dist/plugins/social-login.d.cts

@@ -0,0 +1,114 @@
+import { F as FortressPlugin } from '../config-GtlVt6ZD.cjs';
+import { F as FortressUser } from '../types-et0R8tsC.cjs';
+import '../index-CxEkfCA0.cjs';
+import '../jwt.cjs';
+import '../auth-service-BcyQ2PuZ.cjs';
+
+/** Normalized user profile returned by all providers */
+interface ProviderProfile {
+    /** Provider's unique user ID */
+    id: string;
+    email: string;
+    /** Whether the provider has verified ownership of `email`. */
+    emailVerified: boolean;
+    name?: string;
+    displayName?: string;
+    avatar?: string;
+    /** Full raw response from the provider (for custom mapping) */
+    raw: Record<string, unknown>;
+}
+/** User-facing config for a single provider (passed to socialLogin plugin) */
+interface ProviderConfig {
+    name: string;
+    clientId: string;
+    clientSecret: string;
+    scopes?: string[];
+    /** Microsoft: tenant ID, 'common', or 'organizations' */
+    tenant?: string;
+    /** Restrict registration to specific email domains */
+    allowedDomains?: string[];
+    /** Generic OIDC: issuer URL for discovery */
+    issuer?: string;
+    /** Override discovered authorization endpoint for custom OIDC providers. */
+    authorizationUrl?: string;
+    /** Override discovered token endpoint for custom OIDC providers. */
+    tokenUrl?: string;
+    /** Override discovered userinfo endpoint for custom OIDC providers. */
+    userInfoUrl?: string;
+    /** Override discovered JWKS endpoint for custom OIDC providers. */
+    jwksUri?: string;
+    /** Apple Sign In: team ID used to generate the ES256 client-secret JWT. */
+    teamId?: string;
+    /** Apple Sign In: key ID used to generate the ES256 client-secret JWT. */
+    keyId?: string;
+    /** Apple Sign In: PKCS#8 private key used to generate the ES256 client-secret JWT. */
+    privateKey?: string;
+}
+/** Plugin-level config for the social login plugin */
+interface SocialLoginConfig {
+    providers: ProviderConfig[];
+    /** Auto-create user on first social login (default: true) */
+    autoRegister?: boolean;
+    /** Link social identity to existing user by email (default: true) */
+    linkAccounts?: boolean;
+    /** Map provider profile fields to Fortress user fields */
+    mapProfile?: (provider: string, profile: ProviderProfile) => {
+        email: string;
+        name: string;
+    };
+    /** Called on first-ever login for a social user */
+    onFirstLogin?: (user: {
+        id: string;
+    }, provider: string, profile: ProviderProfile) => Promise<void>;
+    /** Persist encrypted provider access/refresh tokens. Default: false (explicit opt-in). */
+    persistTokens?: boolean;
+    /** 32-byte AES-256-GCM key (raw bytes as base64/base64url/hex, or a UTF-8 string of at least 32 bytes). */
+    tokenEncryptionKey?: string;
+}
+
+/**
+ * Social login (OAuth/OIDC consumer) plugin for fortress.
+ *
+ * Supports Microsoft, Google, GitHub, Discord, Apple, and any generic OIDC
+ * provider. Handles the authorization-code flow, exchanges tokens, links
+ * provider accounts to fortress users, and issues fortress refresh tokens
+ * on success.
+ *
+ * @module
+ */
+
+interface SocialLoginMethods {
+    getAuthorizationUrl: (providerName: string, redirectUri: string) => Promise<{
+        url: string;
+        state: string;
+        codeVerifier: string;
+        nonce: string;
+    }>;
+    handleCallback: (providerName: string, code: string, redirectUri: string, codeVerifier: string, returnedState: string, storedState: string, storedNonce: string) => Promise<{
+        user: FortressUser;
+        profile: ProviderProfile;
+        isNewUser: boolean;
+    }>;
+    getLinkedAccounts: (userId: string) => Promise<{
+        provider: string;
+        providerAccountId: string;
+        email: string | null;
+    }[]>;
+    getProviderTokens: (userId: string, provider: string) => Promise<{
+        accessToken: string | null;
+        refreshToken: string | null;
+        tokenExpiresAt: Date | null;
+    }>;
+    unlinkAccount: (userId: string, provider: string) => Promise<void>;
+    getProviders: () => string[];
+}
+/**
+ * Social login plugin factory. Returns a {@link FortressPlugin} that handles
+ * the OAuth/OIDC authorization-code flow against the configured providers,
+ * links provider accounts to fortress users, and issues fortress tokens.
+ */
+declare function socialLogin(config: SocialLoginConfig): FortressPlugin & {
+    readonly name: 'social-login';
+};
+
+export { type ProviderConfig, type ProviderProfile, type SocialLoginConfig, type SocialLoginMethods, socialLogin };

package/dist/plugins/social-login.d.ts

@@ -0,0 +1,114 @@
+import { F as FortressPlugin } from '../config-B2366s_G.js';
+import { F as FortressUser } from '../types-et0R8tsC.js';
+import '../index-CxEkfCA0.js';
+import '../jwt.js';
+import '../auth-service-BkzZkWfH.js';
+
+/** Normalized user profile returned by all providers */
+interface ProviderProfile {
+    /** Provider's unique user ID */
+    id: string;
+    email: string;
+    /** Whether the provider has verified ownership of `email`. */
+    emailVerified: boolean;
+    name?: string;
+    displayName?: string;
+    avatar?: string;
+    /** Full raw response from the provider (for custom mapping) */
+    raw: Record<string, unknown>;
+}
+/** User-facing config for a single provider (passed to socialLogin plugin) */
+interface ProviderConfig {
+    name: string;
+    clientId: string;
+    clientSecret: string;
+    scopes?: string[];
+    /** Microsoft: tenant ID, 'common', or 'organizations' */
+    tenant?: string;
+    /** Restrict registration to specific email domains */
+    allowedDomains?: string[];
+    /** Generic OIDC: issuer URL for discovery */
+    issuer?: string;
+    /** Override discovered authorization endpoint for custom OIDC providers. */
+    authorizationUrl?: string;
+    /** Override discovered token endpoint for custom OIDC providers. */
+    tokenUrl?: string;
+    /** Override discovered userinfo endpoint for custom OIDC providers. */
+    userInfoUrl?: string;
+    /** Override discovered JWKS endpoint for custom OIDC providers. */
+    jwksUri?: string;
+    /** Apple Sign In: team ID used to generate the ES256 client-secret JWT. */
+    teamId?: string;
+    /** Apple Sign In: key ID used to generate the ES256 client-secret JWT. */
+    keyId?: string;
+    /** Apple Sign In: PKCS#8 private key used to generate the ES256 client-secret JWT. */
+    privateKey?: string;
+}
+/** Plugin-level config for the social login plugin */
+interface SocialLoginConfig {
+    providers: ProviderConfig[];
+    /** Auto-create user on first social login (default: true) */
+    autoRegister?: boolean;
+    /** Link social identity to existing user by email (default: true) */
+    linkAccounts?: boolean;
+    /** Map provider profile fields to Fortress user fields */
+    mapProfile?: (provider: string, profile: ProviderProfile) => {
+        email: string;
+        name: string;
+    };
+    /** Called on first-ever login for a social user */
+    onFirstLogin?: (user: {
+        id: string;
+    }, provider: string, profile: ProviderProfile) => Promise<void>;
+    /** Persist encrypted provider access/refresh tokens. Default: false (explicit opt-in). */
+    persistTokens?: boolean;
+    /** 32-byte AES-256-GCM key (raw bytes as base64/base64url/hex, or a UTF-8 string of at least 32 bytes). */
+    tokenEncryptionKey?: string;
+}
+
+/**
+ * Social login (OAuth/OIDC consumer) plugin for fortress.
+ *
+ * Supports Microsoft, Google, GitHub, Discord, Apple, and any generic OIDC
+ * provider. Handles the authorization-code flow, exchanges tokens, links
+ * provider accounts to fortress users, and issues fortress refresh tokens
+ * on success.
+ *
+ * @module
+ */
+
+interface SocialLoginMethods {
+    getAuthorizationUrl: (providerName: string, redirectUri: string) => Promise<{
+        url: string;
+        state: string;
+        codeVerifier: string;
+        nonce: string;
+    }>;
+    handleCallback: (providerName: string, code: string, redirectUri: string, codeVerifier: string, returnedState: string, storedState: string, storedNonce: string) => Promise<{
+        user: FortressUser;
+        profile: ProviderProfile;
+        isNewUser: boolean;
+    }>;
+    getLinkedAccounts: (userId: string) => Promise<{
+        provider: string;
+        providerAccountId: string;
+        email: string | null;
+    }[]>;
+    getProviderTokens: (userId: string, provider: string) => Promise<{
+        accessToken: string | null;
+        refreshToken: string | null;
+        tokenExpiresAt: Date | null;
+    }>;
+    unlinkAccount: (userId: string, provider: string) => Promise<void>;
+    getProviders: () => string[];
+}
+/**
+ * Social login plugin factory. Returns a {@link FortressPlugin} that handles
+ * the OAuth/OIDC authorization-code flow against the configured providers,
+ * links provider accounts to fortress users, and issues fortress tokens.
+ */
+declare function socialLogin(config: SocialLoginConfig): FortressPlugin & {
+    readonly name: 'social-login';
+};
+
+export { type ProviderConfig, type ProviderProfile, type SocialLoginConfig, type SocialLoginMethods, socialLogin };