@cedvict/http-guardian 0.0.1-next.6 → 0.0.1-next.7

package/dist/index.d.ts

@@ -1,322 +1,22 @@
-type BearerAuthConfig = {
-    mode: "bearer";
-    getToken: () => string | null | Promise<string | null>;
-    headerName?: string;
-    prefix?: string;
-};
-type CookieAuthConfig = {
-    mode: "cookie";
-    credentials?: RequestCredentials;
-    csrf?: {
-        headerName: string;
-        getToken: () => string | null | Promise<string | null>;
-    };
-};
-type NoneAuthConfig = {
-    mode: "none";
-};
-type AuthConfig = BearerAuthConfig | CookieAuthConfig | NoneAuthConfig;
-declare function bearerAuth(getToken: () => string | null | Promise<string | null>, opts?: {
-    headerName?: string;
-    prefix?: string;
-}): BearerAuthConfig;
-declare function cookieAuth(opts?: {
-    credentials?: RequestCredentials;
-    csrf?: {
-        headerName: string;
-        getToken: () => string | null | Promise<string | null>;
-    };
-}): CookieAuthConfig;
-declare function noAuth(): NoneAuthConfig;
-
-type AppError = {
-    message: string;
-    code?: string;
-    field?: string;
-    details?: unknown;
-};
-declare class NetworkError extends Error {
-    readonly cause?: unknown | undefined;
-    name: string;
-    constructor(message: string, cause?: unknown | undefined);
-}
-declare class TimeoutError extends Error {
-    name: string;
-    constructor(message?: string);
-}
-declare class RedirectError extends Error {
-    readonly fromUrl: string;
-    readonly toUrl?: string | undefined;
-    name: string;
-    constructor(message: string, fromUrl: string, toUrl?: string | undefined);
-}
-declare class ParseError extends Error {
-    readonly raw?: unknown | undefined;
-    readonly cause?: unknown | undefined;
-    name: string;
-    constructor(message: string, raw?: unknown | undefined, cause?: unknown | undefined);
-}
-declare const ILLEGAL_INVOCATION_HINT = "Detected a browser fetch invocation error (\"Illegal invocation\"). This usually happens when passing a detached reference to window.fetch. Fix by configuring the client with fetch: (input, init) => window.fetch(input, init) or fetch: window.fetch.bind(window).";
-
-type NotifyEvent = {
-    type: "http-error";
-    level: "error" | "warning";
-    title: string;
-    message: string;
-    status: number;
-    errors?: AppError[];
-    url: string;
-} | {
-    type: "network-error";
-    level: "error";
-    title: string;
-    message: string;
-    url: string;
-} | {
-    type: "parse-error";
-    level: "error";
-    title: string;
-    message: string;
-    url: string;
-};
-type Notifier = {
-    notify: (event: NotifyEvent) => void;
-};
-
-type RequestContext = {
-    method: HttpMethod;
-    url: string;
-    headers: Headers;
-    credentials?: RequestCredentials;
-    redirect?: RequestRedirect;
-    body?: BodyInit;
-    signal?: AbortSignal;
-    timeoutMs?: number;
-    attempt: number;
-    auth: AuthConfig;
-    noAuth?: boolean;
-    notifier?: Notifier;
-    idempotencyKey?: string;
-    _fetch: typeof fetch;
-};
-
-type Guard = (ctx: RequestContext, next: (ctx: RequestContext) => Promise<Response>) => Promise<Response>;
-
-type CacheEntry = {
-    expiresAt: number;
-    value: unknown;
-    tags?: string[];
-};
-type CacheStore = {
-    get: (key: string) => CacheEntry | undefined;
-    set: (key: string, entry: CacheEntry) => void;
-    delete: (key: string) => void;
-    invalidateByTag: (tag: string) => number;
-    clear: () => void;
-};
-
-type ShapeParser = {
-    isSuccess: (raw: unknown, status: number) => boolean;
-    getData: (raw: unknown) => unknown;
-    getErrors: (raw: unknown, status: number) => AppError[];
-};
-declare function createShapeParser(p: ShapeParser): ShapeParser;
-
-type Schema<T> = {
-    parse: (input: unknown) => T;
-};
-declare function schema<T>(impl: Schema<T>): Schema<T>;
-/**
- * Optional helper to wrap a zod-like schema without adding a dependency.
- */
-declare function fromZod<T>(zodSchema: {
-    parse?: (i: unknown) => T;
-    safeParse?: (i: unknown) => {
-        success: true;
-        data: T;
-    } | {
-        success: false;
-        error: unknown;
-    };
-}): Schema<T>;
-
-type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-type RedirectMode = "follow" | "manual" | "error";
-type RedirectPolicy = {
-    mode: RedirectMode;
-    maxHops?: number;
-    onRedirect?: (info: {
-        fromUrl: string;
-        toUrl: string;
-        status: number;
-        hop: number;
-        method: HttpMethod;
-    }) => {
-        action: "follow";
-    } | {
-        action: "deny";
-        reason?: string;
-    } | {
-        action: "modify";
-        url: string;
-    };
-};
-type CacheOptions = {
-    ttlMs: number;
-    key?: string;
-    tags?: string[];
-    policy?: "networkFirst" | "cacheFirst" | "cacheOnly" | "networkOnly" | "staleWhileRevalidate";
-    dedupe?: boolean;
-};
-type RequestOptions<T> = {
-    query?: Record<string, string | number | boolean | null | undefined>;
-    headers?: Record<string, string | undefined>;
-    json?: unknown;
-    body?: BodyInit;
-    signal?: AbortSignal;
-    timeoutMs?: number;
-    cache?: CacheOptions;
-    dataSchema?: Schema<T>;
-    notifier?: Notifier;
-    noAuth?: boolean;
-    idempotencyKey?: string;
-};
-type ClientResult<T> = {
-    ok: true;
-    status: number;
-    headers: Headers;
-    data: T;
-    raw: unknown;
-    url: string;
-} | {
-    ok: false;
-    status: number;
-    headers: Headers;
-    errors: AppError[];
-    raw: unknown;
-    url: string;
-};
-type HttpClientOptions = {
-    baseUrl: string;
-    fetch?: typeof fetch;
-    auth: AuthConfig;
-    parser: ShapeParser;
-    cache?: CacheStore;
-    notifier?: Notifier;
-    redirects?: RedirectPolicy;
-    defaults?: {
-        headers?: Record<string, string>;
-        timeoutMs?: number;
-        shouldNotify?: (result: {
-            ok: boolean;
-            status: number;
-        }) => boolean;
-    };
-    guards?: Guard[];
-};
-
-declare function createHttpClient(opts: HttpClientOptions): {
-    get: <T>(path: string, ro?: RequestOptions<T>) => Promise<ClientResult<T>>;
-    post: <T>(path: string, ro?: RequestOptions<T>) => Promise<ClientResult<T>>;
-    put: <T>(path: string, ro?: RequestOptions<T>) => Promise<ClientResult<T>>;
-    patch: <T>(path: string, ro?: RequestOptions<T>) => Promise<ClientResult<T>>;
-    delete: <T>(path: string, ro?: RequestOptions<T>) => Promise<ClientResult<T>>;
-    cache: {
-        invalidateByTag: (tag: string) => number;
-        clear: () => void | undefined;
-    };
-};
-
-/**
- * Simple retry guard for transient HTTP statuses.
- * Note: this doesn't retry network errors thrown by fetch itself (those are handled by the client wrapper).
- */
-declare function retryGuard(opts?: {
-    retries?: number;
-    retryOn?: number[];
-    baseDelayMs?: number;
-    maxDelayMs?: number;
-}): Guard;
-
-type CookieSafeRefreshGuardOptions = {
-    /**
-     * Endpoint refresh (absolu ou relatif)
-     * ex: "/api/v1/auth/refresh"
-     */
-    refreshPath: string;
-    /**
-     * Méthode refresh (souvent POST)
-     */
-    refreshMethod?: "POST" | "GET";
-    /**
-     * Statuts qui déclenchent refresh
-     * 401 classique, 419 (Laravel CSRF/session)
-     */
-    triggerStatuses?: number[];
-    /**
-     * On ne tente pas de refresh si la requête originale est déjà un refresh
-     * ou si on détecte une boucle.
-     */
-    maxRetry?: number;
-    /**
-     * Optionnel: si tu as un endpoint /me et tu veux explicitement l’exclure
-     * (souvent inutile)
-     */
-    excludePaths?: string[];
-    /**
-     * Si refresh renvoie 429 Too Many Requests
-     * on stoppe les refresh jusqu’à une date (cooldown).
-     * default: true
-     */
-    honorRetryAfter?: boolean;
-    /**
-     * Custom: décider si on refresh selon le ctx + status
-     */
-    shouldRefresh?: (ctx: RequestContext, status: number) => boolean;
-    /**
-     * Hook: appelé quand refresh échoue (utile pour redirect login)
-     */
-    onRefreshFailed?: (info: {
-        status?: number;
-        url: string;
-        reason?: string;
-    }) => void;
-    /**
-     * Hook: appelé quand refresh réussit
-     */
-    onRefreshSuccess?: (info: {
-        url: string;
-    }) => void;
-};
-declare function cookieSafeRefreshGuard(opts: CookieSafeRefreshGuardOptions): Guard;
-
-/**
- * Simple in-memory LRU-ish cache with tag invalidation.
- */
-declare function memoryCache(opts?: {
-    maxEntries?: number;
-}): CacheStore;
-
-declare function createApiParserRestClassic(opts?: {
-    successField?: string;
-    dataField?: string;
-    errorField?: string;
-    messageField?: string;
-}): ShapeParser;
-declare function createApiParserLaravel(opts?: {
-    dataField?: string;
-}): ShapeParser;
-declare function createApiParserNest(): ShapeParser;
-declare function createApiParserGraphQL(opts?: {
-    allowPartialData?: boolean;
-}): ShapeParser;
-
-declare const consoleNotifier: Notifier;
-declare const alertNotifier: Notifier;
-/**
- * Returns an HTML string you can inject in your own UI layer (Tailwind classes).
- * Note: this package does not manipulate the DOM by itself.
- */
-declare function tailwindAlertRenderer(event: NotifyEvent): string;
-
-export { type AppError, type AuthConfig, type BearerAuthConfig, type CacheEntry, type CacheOptions, type CacheStore, type ClientResult, type CookieAuthConfig, type CookieSafeRefreshGuardOptions, type Guard, type HttpClientOptions, type HttpMethod, ILLEGAL_INVOCATION_HINT, NetworkError, type NoneAuthConfig, type Notifier, type NotifyEvent, ParseError, RedirectError, type RedirectMode, type RedirectPolicy, type RequestContext, type RequestOptions, type Schema, type ShapeParser, TimeoutError, alertNotifier, bearerAuth, consoleNotifier, cookieAuth, cookieSafeRefreshGuard, createApiParserGraphQL, createApiParserLaravel, createApiParserNest, createApiParserRestClassic, createHttpClient, createShapeParser, fromZod, memoryCache, noAuth, retryGuard, schema, tailwindAlertRenderer };
+export * from "./client/httpClient.js";
+export * from "./client/types.js";
+export * from "./client/errors.js";
+export * from "./auth/authConfig.js";
+export * from "./guards/types.js";
+export * from "./guards/retryGuard.js";
+export * from "./guards/cookieSafeRefreshGuard.js";
+export * from "./guards/unauthorizedGuard.js";
+export * from "./guards/instrumentGuard.js";
+export * from "./cache/types.js";
+export * from "./cache/memoryCache.js";
+export * from "./parsing/shapeParser.js";
+export * from "./parsing/schemaAdapter.js";
+export * from "./parsing/presets.js";
+export * from "./notify/types.js";
+export * from "./notify/defaults.js";
+export * from "./presets/presetBuilder.js";
+export * from "./plugins/types.js";
+export * from "./aliases.js";
+export type { RequestContext } from "./internal/context.js";
+export type * from "./publicTypes.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,sBAAsB,CAAC;AAErC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oCAAoC,CAAC;AACnD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAE5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AAEvC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AAErC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AAErC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AAGnC,cAAc,cAAc,CAAC;AAG7B,YAAY,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,mBAAmB,kBAAkB,CAAC"}