@pinooxhq/auth 0.1.0

package/dist/createAuth-LO46VVEW.d.cts

@@ -0,0 +1,176 @@
+type AuthMode = 'jwt' | 'cookie' | 'session';
+type AuthStrategy = 'local' | 'remote';
+type AuthEvent = 'unauthorized' | 'mismatch' | 'error' | 'login' | 'logout' | 'config';
+interface BootAuthConfig {
+    mode?: string;
+    key?: string;
+    provider?: string | null;
+    source?: string | null;
+    strategy?: AuthStrategy | string;
+    loginUrl?: string;
+    /** Prefix for relative endpoint paths (e.g. `/account/api/v1`). */
+    baseUrl?: string | null;
+    endpoints?: AuthEndpoints;
+}
+interface PinooxBootstrap {
+    url?: {
+        API?: string;
+        APP?: string;
+        BASE?: string;
+        SITE?: string;
+        [key: string]: string | undefined;
+    };
+    locale?: string;
+    auth?: BootAuthConfig;
+    [key: string]: unknown;
+}
+interface AuthEndpoints {
+    login?: string;
+    logout?: string;
+    me?: string;
+}
+interface ResolvedAuthConfig {
+    mode: AuthMode;
+    key: string;
+    provider: string | null;
+    source: string | null;
+    strategy: AuthStrategy;
+    loginUrl: string | null;
+    /** Optional prefix used to resolve relative endpoint paths. */
+    baseUrl: string | null;
+    endpoints: Required<AuthEndpoints>;
+    apiBase: string;
+    /** Site origin from __PINOOX__.url.SITE (for Vite HMR absolute redirects). */
+    siteOrigin: string | null;
+    /** App path prefix e.g. /account — blocked as post-login return target. */
+    appPath: string | null;
+    debug: boolean;
+}
+interface LoginCredentials {
+    username?: string;
+    email?: string;
+    mobile?: string;
+    password: string;
+    remember?: boolean;
+    [key: string]: unknown;
+}
+interface AuthUser {
+    [key: string]: unknown;
+}
+interface LoginResult {
+    token: string | null;
+    user: AuthUser | null;
+    raw: unknown;
+}
+interface AuthRequestAuth {
+    header: string | null;
+    credentials: RequestCredentials;
+    mode: AuthMode;
+    key: string;
+}
+interface AuthLogEvent {
+    level: 'debug' | 'info' | 'warn' | 'error';
+    code: string;
+    message: string;
+    context?: Record<string, unknown>;
+}
+type AuthEventHandler = (payload?: unknown) => void;
+type AuthLogSink = (event: AuthLogEvent) => void;
+
+interface AuthLogger {
+    emit: (event: AuthLogEvent) => void;
+    debug: (code: string, message: string, context?: Record<string, unknown>) => void;
+    info: (code: string, message: string, context?: Record<string, unknown>) => void;
+    warn: (code: string, message: string, context?: Record<string, unknown>) => void;
+    error: (code: string, message: string, context?: Record<string, unknown>) => void;
+    setSink: (sink: AuthLogSink | null) => void;
+}
+declare function createLogger(debug?: boolean, sink?: AuthLogSink | null): AuthLogger;
+
+interface CreateAuthOptions {
+    mode?: AuthMode;
+    key?: string;
+    strategy?: AuthStrategy;
+    loginUrl?: string;
+    /** Prefix for relative endpoint paths (e.g. `/account/api/v1`). */
+    baseUrl?: string | null;
+    endpoints?: AuthEndpoints;
+    apiBase?: string;
+    /** Override site origin (defaults to __PINOOX__.url.SITE). */
+    siteOrigin?: string | null;
+    debug?: boolean;
+    boot?: PinooxBootstrap | null;
+}
+/** Join base + relative path. Absolute http(s) or leading-/ paths pass through. */
+declare function joinUrl(base: string, path: string): string;
+/**
+ * Resolve an endpoint against optional baseUrl.
+ * - absolute URL or site path (`/…`) → unchanged
+ * - relative (`auth/get`) + baseUrl → joined
+ * - relative without baseUrl → returned as-is (caller should prefer absolute defaults)
+ */
+declare function resolveEndpoint(path: string | undefined, fallback: string, baseUrl?: string | null): string;
+declare function resolveConfig(options?: CreateAuthOptions, logger?: AuthLogger): ResolvedAuthConfig;
+
+interface HttpRequestInput {
+    url: string;
+    method?: string;
+    headers?: Record<string, string>;
+    body?: unknown;
+    credentials?: RequestCredentials;
+}
+interface HttpResponse<T = unknown> {
+    status: number;
+    data: T;
+    headers: Headers;
+    ok: boolean;
+}
+interface HttpClient {
+    request: <T = unknown>(input: HttpRequestInput) => Promise<HttpResponse<T>>;
+}
+declare function createFetchProvider(): HttpClient;
+
+interface AuthInstance {
+    readonly config: ResolvedAuthConfig;
+    readonly logger: AuthLogger;
+    user: AuthUser | null;
+    token: string | null;
+    isAuthenticated: boolean;
+    login: (credentials?: LoginCredentials) => Promise<LoginResult | void>;
+    logout: () => Promise<void>;
+    me: () => Promise<AuthUser | null>;
+    getToken: () => string | null;
+    setToken: (token: string | null) => void;
+    clearToken: () => void;
+    getAuthHeader: () => string | null;
+    authorize: (headers?: Record<string, string>) => AuthRequestAuth & {
+        headers: Record<string, string>;
+    };
+    getRequestAuth: () => AuthRequestAuth;
+    setHttp: (client: HttpClient) => void;
+    loginFromResponse: (payload: unknown) => LoginResult;
+    redirectToLogin: (returnPath?: string) => void;
+    /** Safe path from ?redirect= (or query object). */
+    getReturnPath: (queryOrPath?: unknown, fallback?: string) => string;
+    /** Absolute return URL (uses SITE origin when Vite origin differs). */
+    getReturnUrl: (queryOrPath?: unknown, fallback?: string) => string;
+    /** Navigate to post-login return URL. */
+    redirectBack: (queryOrPath?: unknown, fallback?: string) => void;
+    /** `{ redirect }` for router-link query preservation. */
+    getRedirectQuery: (queryOrPath?: unknown, fallback?: string) => {
+        redirect: string;
+    };
+    /** Clear session and emit `unauthorized` (e.g. from HTTP 401). */
+    notifyUnauthorized: (payload?: unknown) => void;
+    on: (event: AuthEvent, handler: AuthEventHandler) => () => void;
+    off: (event: AuthEvent, handler: AuthEventHandler) => void;
+}
+interface CreateAuthConfig extends CreateAuthOptions {
+    http?: HttpClient;
+    logger?: AuthLogger;
+}
+declare function getAuth(): AuthInstance;
+declare function createAuth(options?: CreateAuthConfig): AuthInstance;
+declare function buildLoginRedirectUrl(returnPath?: string): string;
+
+export { type AuthLogger as A, type BootAuthConfig as B, type CreateAuthConfig as C, type HttpClient as H, type LoginCredentials as L, type PinooxBootstrap as P, type ResolvedAuthConfig as R, type AuthInstance as a, type AuthEndpoints as b, type AuthEvent as c, type AuthLogEvent as d, type AuthMode as e, type AuthRequestAuth as f, type AuthStrategy as g, type AuthUser as h, type CreateAuthOptions as i, type HttpRequestInput as j, type HttpResponse as k, type LoginResult as l, buildLoginRedirectUrl as m, createAuth as n, createFetchProvider as o, createLogger as p, getAuth as q, joinUrl as r, resolveConfig as s, resolveEndpoint as t };

package/dist/createAuth-LO46VVEW.d.ts

@@ -0,0 +1,176 @@
+type AuthMode = 'jwt' | 'cookie' | 'session';
+type AuthStrategy = 'local' | 'remote';
+type AuthEvent = 'unauthorized' | 'mismatch' | 'error' | 'login' | 'logout' | 'config';
+interface BootAuthConfig {
+    mode?: string;
+    key?: string;
+    provider?: string | null;
+    source?: string | null;
+    strategy?: AuthStrategy | string;
+    loginUrl?: string;
+    /** Prefix for relative endpoint paths (e.g. `/account/api/v1`). */
+    baseUrl?: string | null;
+    endpoints?: AuthEndpoints;
+}
+interface PinooxBootstrap {
+    url?: {
+        API?: string;
+        APP?: string;
+        BASE?: string;
+        SITE?: string;
+        [key: string]: string | undefined;
+    };
+    locale?: string;
+    auth?: BootAuthConfig;
+    [key: string]: unknown;
+}
+interface AuthEndpoints {
+    login?: string;
+    logout?: string;
+    me?: string;
+}
+interface ResolvedAuthConfig {
+    mode: AuthMode;
+    key: string;
+    provider: string | null;
+    source: string | null;
+    strategy: AuthStrategy;
+    loginUrl: string | null;
+    /** Optional prefix used to resolve relative endpoint paths. */
+    baseUrl: string | null;
+    endpoints: Required<AuthEndpoints>;
+    apiBase: string;
+    /** Site origin from __PINOOX__.url.SITE (for Vite HMR absolute redirects). */
+    siteOrigin: string | null;
+    /** App path prefix e.g. /account — blocked as post-login return target. */
+    appPath: string | null;
+    debug: boolean;
+}
+interface LoginCredentials {
+    username?: string;
+    email?: string;
+    mobile?: string;
+    password: string;
+    remember?: boolean;
+    [key: string]: unknown;
+}
+interface AuthUser {
+    [key: string]: unknown;
+}
+interface LoginResult {
+    token: string | null;
+    user: AuthUser | null;
+    raw: unknown;
+}
+interface AuthRequestAuth {
+    header: string | null;
+    credentials: RequestCredentials;
+    mode: AuthMode;
+    key: string;
+}
+interface AuthLogEvent {
+    level: 'debug' | 'info' | 'warn' | 'error';
+    code: string;
+    message: string;
+    context?: Record<string, unknown>;
+}
+type AuthEventHandler = (payload?: unknown) => void;
+type AuthLogSink = (event: AuthLogEvent) => void;
+
+interface AuthLogger {
+    emit: (event: AuthLogEvent) => void;
+    debug: (code: string, message: string, context?: Record<string, unknown>) => void;
+    info: (code: string, message: string, context?: Record<string, unknown>) => void;
+    warn: (code: string, message: string, context?: Record<string, unknown>) => void;
+    error: (code: string, message: string, context?: Record<string, unknown>) => void;
+    setSink: (sink: AuthLogSink | null) => void;
+}
+declare function createLogger(debug?: boolean, sink?: AuthLogSink | null): AuthLogger;
+
+interface CreateAuthOptions {
+    mode?: AuthMode;
+    key?: string;
+    strategy?: AuthStrategy;
+    loginUrl?: string;
+    /** Prefix for relative endpoint paths (e.g. `/account/api/v1`). */
+    baseUrl?: string | null;
+    endpoints?: AuthEndpoints;
+    apiBase?: string;
+    /** Override site origin (defaults to __PINOOX__.url.SITE). */
+    siteOrigin?: string | null;
+    debug?: boolean;
+    boot?: PinooxBootstrap | null;
+}
+/** Join base + relative path. Absolute http(s) or leading-/ paths pass through. */
+declare function joinUrl(base: string, path: string): string;
+/**
+ * Resolve an endpoint against optional baseUrl.
+ * - absolute URL or site path (`/…`) → unchanged
+ * - relative (`auth/get`) + baseUrl → joined
+ * - relative without baseUrl → returned as-is (caller should prefer absolute defaults)
+ */
+declare function resolveEndpoint(path: string | undefined, fallback: string, baseUrl?: string | null): string;
+declare function resolveConfig(options?: CreateAuthOptions, logger?: AuthLogger): ResolvedAuthConfig;
+
+interface HttpRequestInput {
+    url: string;
+    method?: string;
+    headers?: Record<string, string>;
+    body?: unknown;
+    credentials?: RequestCredentials;
+}
+interface HttpResponse<T = unknown> {
+    status: number;
+    data: T;
+    headers: Headers;
+    ok: boolean;
+}
+interface HttpClient {
+    request: <T = unknown>(input: HttpRequestInput) => Promise<HttpResponse<T>>;
+}
+declare function createFetchProvider(): HttpClient;
+
+interface AuthInstance {
+    readonly config: ResolvedAuthConfig;
+    readonly logger: AuthLogger;
+    user: AuthUser | null;
+    token: string | null;
+    isAuthenticated: boolean;
+    login: (credentials?: LoginCredentials) => Promise<LoginResult | void>;
+    logout: () => Promise<void>;
+    me: () => Promise<AuthUser | null>;
+    getToken: () => string | null;
+    setToken: (token: string | null) => void;
+    clearToken: () => void;
+    getAuthHeader: () => string | null;
+    authorize: (headers?: Record<string, string>) => AuthRequestAuth & {
+        headers: Record<string, string>;
+    };
+    getRequestAuth: () => AuthRequestAuth;
+    setHttp: (client: HttpClient) => void;
+    loginFromResponse: (payload: unknown) => LoginResult;
+    redirectToLogin: (returnPath?: string) => void;
+    /** Safe path from ?redirect= (or query object). */
+    getReturnPath: (queryOrPath?: unknown, fallback?: string) => string;
+    /** Absolute return URL (uses SITE origin when Vite origin differs). */
+    getReturnUrl: (queryOrPath?: unknown, fallback?: string) => string;
+    /** Navigate to post-login return URL. */
+    redirectBack: (queryOrPath?: unknown, fallback?: string) => void;
+    /** `{ redirect }` for router-link query preservation. */
+    getRedirectQuery: (queryOrPath?: unknown, fallback?: string) => {
+        redirect: string;
+    };
+    /** Clear session and emit `unauthorized` (e.g. from HTTP 401). */
+    notifyUnauthorized: (payload?: unknown) => void;
+    on: (event: AuthEvent, handler: AuthEventHandler) => () => void;
+    off: (event: AuthEvent, handler: AuthEventHandler) => void;
+}
+interface CreateAuthConfig extends CreateAuthOptions {
+    http?: HttpClient;
+    logger?: AuthLogger;
+}
+declare function getAuth(): AuthInstance;
+declare function createAuth(options?: CreateAuthConfig): AuthInstance;
+declare function buildLoginRedirectUrl(returnPath?: string): string;
+
+export { type AuthLogger as A, type BootAuthConfig as B, type CreateAuthConfig as C, type HttpClient as H, type LoginCredentials as L, type PinooxBootstrap as P, type ResolvedAuthConfig as R, type AuthInstance as a, type AuthEndpoints as b, type AuthEvent as c, type AuthLogEvent as d, type AuthMode as e, type AuthRequestAuth as f, type AuthStrategy as g, type AuthUser as h, type CreateAuthOptions as i, type HttpRequestInput as j, type HttpResponse as k, type LoginResult as l, buildLoginRedirectUrl as m, createAuth as n, createFetchProvider as o, createLogger as p, getAuth as q, joinUrl as r, resolveConfig as s, resolveEndpoint as t };