@markwharton/pwa-core 1.7.0 → 2.0.0

package/dist/{client/api.d.ts → client.d.ts}

@@ -1,11 +1,80 @@
-import { ApiResponse } from './types';
+/**
+ * pwa-core/client - Browser-side API client utilities
+ *
+ * This module has NO Node.js dependencies and is designed for browser use.
+ */
+/**
+ * API response wrapper for safe calls
+ */
+export interface ApiResponse<T> {
+    ok: boolean;
+    status: number;
+    data?: T;
+    error?: string;
+}
+/**
+ * Configuration for initApiClient
+ */
+export interface ApiClientConfig {
+    /** Function that returns the current auth token (or null) */
+    getToken: () => string | null;
+    /** Optional callback for 401 responses (e.g., redirect to login) */
+    onUnauthorized?: () => void;
+    /** Optional request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+}
+/**
+ * Custom error class for API errors.
+ * Preserves HTTP status code and error message from the server.
+ * @example
+ * try {
+ *   await apiGet('/users/123');
+ * } catch (error) {
+ *   if (error instanceof ApiError && error.isNotFound()) {
+ *     console.log('User not found');
+ *   }
+ * }
+ */
+export declare class ApiError extends Error {
+    status: number;
+    details?: string | undefined;
+    /**
+     * Creates a new ApiError instance.
+     * @param status - The HTTP status code
+     * @param message - The error message
+     * @param details - Optional additional error details
+     */
+    constructor(status: number, message: string, details?: string | undefined);
+    /**
+     * Checks if this is a 401 Unauthorized error.
+     * @returns True if status is 401
+     */
+    isUnauthorized(): boolean;
+    /**
+     * Checks if this is a 404 Not Found error.
+     * @returns True if status is 404
+     */
+    isNotFound(): boolean;
+    /**
+     * Checks if this is a 400 Bad Request error.
+     * @returns True if status is 400
+     */
+    isBadRequest(): boolean;
+    /**
+     * Checks if this is a client error (4xx status).
+     * @returns True if status is 400-499
+     */
+    isClientError(): boolean;
+    /**
+     * Checks if this is a server error (5xx status).
+     * @returns True if status is 500-599
+     */
+    isServerError(): boolean;
+}
 /**
  * Initializes the API client with token retrieval and optional configuration.
  * Call once at application startup.
  * @param config - Client configuration
- * @param config.getToken - Function that returns the current auth token (or null)
- * @param config.onUnauthorized - Optional callback for 401 responses (e.g., redirect to login)
- * @param config.timeout - Optional request timeout in milliseconds (default: 30000)
  * @example
  * initApiClient({
  *   getToken: () => localStorage.getItem('token'),
@@ -13,11 +82,7 @@ import { ApiResponse } from './types';
  *   timeout: 60000  // 60 seconds
  * });
  */
-export declare function initApiClient(config: {
-    getToken: () => string | null;
-    onUnauthorized?: () => void;
-    timeout?: number;
-}): void;
+export declare function initApiClient(config: ApiClientConfig): void;
 /**
  * Makes an authenticated API call. Throws ApiError on non-2xx responses.
  * @typeParam T - The expected response data type
@@ -82,6 +147,17 @@ export declare function apiPatch<T>(url: string, body?: unknown): Promise<T>;
  * await apiDelete('/api/users/123');
  */
 export declare function apiDelete<T>(url: string): Promise<T>;
+/**
+ * Makes an authenticated API call expecting no response body.
+ * Use for DELETE, POST, or PUT actions that return 204 No Content.
+ * @param url - The API endpoint URL
+ * @param options - Optional fetch options (method, body, headers)
+ * @throws ApiError on non-2xx HTTP status or timeout
+ * @example
+ * await apiCallVoid('/api/users/123', { method: 'DELETE' });
+ * await apiCallVoid('/api/action', { method: 'POST' });
+ */
+export declare function apiCallVoid(url: string, options?: RequestInit): Promise<void>;
 /**
  * Makes an authenticated API call with Result-style error handling.
  * Unlike apiCall, this never throws - errors are returned in the response.

package/dist/{client/api.js → client.js}

@@ -1,5 +1,11 @@
 "use strict";
+/**
+ * pwa-core/client - Browser-side API client utilities
+ *
+ * This module has NO Node.js dependencies and is designed for browser use.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiError = void 0;
 exports.initApiClient = initApiClient;
 exports.apiCall = apiCall;
 exports.apiGet = apiGet;
@@ -7,24 +13,130 @@ exports.apiPost = apiPost;
 exports.apiPut = apiPut;
 exports.apiPatch = apiPatch;
 exports.apiDelete = apiDelete;
+exports.apiCallVoid = apiCallVoid;
 exports.apiCallSafe = apiCallSafe;
-const apiError_1 = require("./apiError");
+// =============================================================================
+// ApiError Class
+// =============================================================================
 /**
- * Client-side API utilities for authenticated requests
+ * Custom error class for API errors.
+ * Preserves HTTP status code and error message from the server.
+ * @example
+ * try {
+ *   await apiGet('/users/123');
+ * } catch (error) {
+ *   if (error instanceof ApiError && error.isNotFound()) {
+ *     console.log('User not found');
+ *   }
+ * }
  */
+class ApiError extends Error {
+    /**
+     * Creates a new ApiError instance.
+     * @param status - The HTTP status code
+     * @param message - The error message
+     * @param details - Optional additional error details
+     */
+    constructor(status, message, details) {
+        super(message);
+        this.status = status;
+        this.details = details;
+        this.name = 'ApiError';
+    }
+    /**
+     * Checks if this is a 401 Unauthorized error.
+     * @returns True if status is 401
+     */
+    isUnauthorized() {
+        return this.status === 401;
+    }
+    /**
+     * Checks if this is a 404 Not Found error.
+     * @returns True if status is 404
+     */
+    isNotFound() {
+        return this.status === 404;
+    }
+    /**
+     * Checks if this is a 400 Bad Request error.
+     * @returns True if status is 400
+     */
+    isBadRequest() {
+        return this.status === 400;
+    }
+    /**
+     * Checks if this is a client error (4xx status).
+     * @returns True if status is 400-499
+     */
+    isClientError() {
+        return this.status >= 400 && this.status < 500;
+    }
+    /**
+     * Checks if this is a server error (5xx status).
+     * @returns True if status is 500-599
+     */
+    isServerError() {
+        return this.status >= 500 && this.status < 600;
+    }
+}
+exports.ApiError = ApiError;
+// =============================================================================
+// Module State
+// =============================================================================
 // Token getter function - set by consuming app
 let getToken = null;
 // Callback for 401 responses (e.g., redirect to login)
 let onUnauthorized = null;
 // Request timeout in milliseconds (default: 30 seconds)
 let requestTimeout = 30000;
+// =============================================================================
+// Internal Helpers
+// =============================================================================
+/** Prepare headers with optional auth token */
+function prepareHeaders(options) {
+    const token = getToken?.();
+    const headers = {
+        'Content-Type': 'application/json',
+        ...options.headers
+    };
+    if (token) {
+        headers['Authorization'] = `Bearer ${token}`;
+    }
+    return headers;
+}
+/** Extract error message from failed response */
+async function extractErrorMessage(response) {
+    try {
+        const errorData = (await response.json());
+        return errorData.error || 'Request failed';
+    }
+    catch {
+        return 'Request failed';
+    }
+}
+/** Handle 401 unauthorized callback */
+function handleUnauthorized(status) {
+    if (status === 401 && onUnauthorized) {
+        onUnauthorized();
+    }
+}
+/** Handle catch block for throwing API functions */
+function handleApiError(error) {
+    if (error instanceof ApiError) {
+        throw error;
+    }
+    if (error instanceof Error && error.name === 'AbortError') {
+        throw new ApiError(0, 'Request timeout');
+    }
+    throw error;
+}
+// =============================================================================
+// Public API
+// =============================================================================
 /**
  * Initializes the API client with token retrieval and optional configuration.
  * Call once at application startup.
  * @param config - Client configuration
- * @param config.getToken - Function that returns the current auth token (or null)
- * @param config.onUnauthorized - Optional callback for 401 responses (e.g., redirect to login)
- * @param config.timeout - Optional request timeout in milliseconds (default: 30000)
  * @example
  * initApiClient({
  *   getToken: () => localStorage.getItem('token'),
@@ -48,15 +160,7 @@ function initApiClient(config) {
  * const user = await apiCall<User>('/api/users/123');
  */
 async function apiCall(url, options = {}) {
-    const token = getToken?.();
-    const headers = {
-        'Content-Type': 'application/json',
-        ...options.headers
-    };
-    if (token) {
-        headers['Authorization'] = `Bearer ${token}`;
-    }
-    // Setup timeout with AbortController
+    const headers = prepareHeaders(options);
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), requestTimeout);
     try {
@@ -66,34 +170,18 @@ async function apiCall(url, options = {}) {
             signal: controller.signal
         });
         if (!response.ok) {
-            if (response.status === 401 && onUnauthorized) {
-                onUnauthorized();
-            }
-            let errorMessage = 'Request failed';
-            try {
-                const errorData = (await response.json());
-                errorMessage = errorData.error || errorMessage;
-            }
-            catch {
-                // Ignore JSON parse errors
-            }
-            throw new apiError_1.ApiError(response.status, errorMessage);
+            handleUnauthorized(response.status);
+            const errorMessage = await extractErrorMessage(response);
+            throw new ApiError(response.status, errorMessage);
         }
-        // Handle empty responses
         const text = await response.text();
         if (!text) {
-            return {};
+            throw new ApiError(response.status, 'Empty response body');
         }
         return JSON.parse(text);
     }
     catch (error) {
-        if (error instanceof apiError_1.ApiError) {
-            throw error;
-        }
-        if (error instanceof Error && error.name === 'AbortError') {
-            throw new apiError_1.ApiError(0, 'Request timeout');
-        }
-        throw error;
+        handleApiError(error);
     }
     finally {
         clearTimeout(timeoutId);
@@ -171,6 +259,39 @@ async function apiPatch(url, body) {
 async function apiDelete(url) {
     return apiCall(url, { method: 'DELETE' });
 }
+/**
+ * Makes an authenticated API call expecting no response body.
+ * Use for DELETE, POST, or PUT actions that return 204 No Content.
+ * @param url - The API endpoint URL
+ * @param options - Optional fetch options (method, body, headers)
+ * @throws ApiError on non-2xx HTTP status or timeout
+ * @example
+ * await apiCallVoid('/api/users/123', { method: 'DELETE' });
+ * await apiCallVoid('/api/action', { method: 'POST' });
+ */
+async function apiCallVoid(url, options = {}) {
+    const headers = prepareHeaders(options);
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), requestTimeout);
+    try {
+        const response = await fetch(url, {
+            ...options,
+            headers,
+            signal: controller.signal
+        });
+        if (!response.ok) {
+            handleUnauthorized(response.status);
+            const errorMessage = await extractErrorMessage(response);
+            throw new ApiError(response.status, errorMessage);
+        }
+    }
+    catch (error) {
+        handleApiError(error);
+    }
+    finally {
+        clearTimeout(timeoutId);
+    }
+}
 /**
  * Makes an authenticated API call with Result-style error handling.
  * Unlike apiCall, this never throws - errors are returned in the response.
@@ -188,15 +309,7 @@ async function apiDelete(url) {
  * }
  */
 async function apiCallSafe(url, options = {}) {
-    const token = getToken?.();
-    const headers = {
-        'Content-Type': 'application/json',
-        ...options.headers
-    };
-    if (token) {
-        headers['Authorization'] = `Bearer ${token}`;
-    }
-    // Setup timeout with AbortController
+    const headers = prepareHeaders(options);
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), requestTimeout);
     try {
@@ -206,20 +319,10 @@ async function apiCallSafe(url, options = {}) {
             signal: controller.signal
         });
         if (!response.ok) {
-            if (response.status === 401 && onUnauthorized) {
-                onUnauthorized();
-            }
-            let errorMessage = 'Request failed';
-            try {
-                const errorData = (await response.json());
-                errorMessage = errorData.error || errorMessage;
-            }
-            catch {
-                // Ignore JSON parse errors
-            }
+            handleUnauthorized(response.status);
+            const errorMessage = await extractErrorMessage(response);
             return { ok: false, status: response.status, error: errorMessage };
         }
-        // Handle empty responses
         const text = await response.text();
         const data = text ? JSON.parse(text) : undefined;
         return { ok: true, status: response.status, data };

package/dist/index.d.ts

@@ -1,3 +1,11 @@
-export * from './types';
-export * from './server';
+/**
+ * pwa-core - Shared patterns for Azure PWA projects
+ *
+ * Import paths:
+ * - '@markwharton/pwa-core/shared' - Types, HTTP_STATUS, Result pattern (browser-safe)
+ * - '@markwharton/pwa-core/server' - JWT, storage, HTTP responses (Node.js only)
+ * - '@markwharton/pwa-core/client' - API client utilities (browser only)
+ * - '@markwharton/pwa-core' - Server + shared (for convenience in Node.js)
+ */
 export * from './shared';
+export * from './server';

package/dist/index.js

@@ -1,4 +1,13 @@
 "use strict";
+/**
+ * pwa-core - Shared patterns for Azure PWA projects
+ *
+ * Import paths:
+ * - '@markwharton/pwa-core/shared' - Types, HTTP_STATUS, Result pattern (browser-safe)
+ * - '@markwharton/pwa-core/server' - JWT, storage, HTTP responses (Node.js only)
+ * - '@markwharton/pwa-core/client' - API client utilities (browser only)
+ * - '@markwharton/pwa-core' - Server + shared (for convenience in Node.js)
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,10 +23,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-// Core types (universal)
-__exportStar(require("./types"), exports);
-// Server utilities (for convenience, but prefer ./server)
-__exportStar(require("./server"), exports);
-// Shared utilities
+// Re-export shared (types, constants, utilities)
 __exportStar(require("./shared"), exports);
-// Note: Client utilities available via ./client subpath
+// Re-export server utilities (for backend convenience)
+__exportStar(require("./server"), exports);
+// Note: Client utilities should be imported from '@markwharton/pwa-core/client'
+// to avoid including browser-only code in Node.js bundles