@markwharton/pwa-core 3.0.0 → 3.1.0

package/dist/client.d.ts

@@ -83,6 +83,20 @@ export declare class ApiError extends Error {
  * });
  */
 export declare function initApiClient(config: ApiClientConfig): void;
+/**
+ * Extract a user-friendly error message from an API error.
+ * Use in catch blocks to convert errors to displayable strings.
+ * @param error - The caught error (typically ApiError or Error)
+ * @param fallback - Message to use if error is not recognized
+ * @returns A user-friendly error message
+ * @example
+ * try {
+ *   await apiGet('/users');
+ * } catch (error) {
+ *   showToast(getApiErrorMessage(error, 'Failed to load users'), 'error');
+ * }
+ */
+export declare function getApiErrorMessage(error: unknown, fallback: string): string;
 /**
  * Makes an authenticated API call. Throws ApiError on non-2xx responses.
  * @typeParam T - The expected response data type

package/dist/client.js

@@ -7,6 +7,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiError = void 0;
 exports.initApiClient = initApiClient;
+exports.getApiErrorMessage = getApiErrorMessage;
 exports.apiCall = apiCall;
 exports.apiGet = apiGet;
 exports.apiPost = apiPost;
@@ -149,6 +150,28 @@ function initApiClient(config) {
     onUnauthorized = config.onUnauthorized ?? null;
     requestTimeout = config.timeout ?? 30000;
 }
+/**
+ * Extract a user-friendly error message from an API error.
+ * Use in catch blocks to convert errors to displayable strings.
+ * @param error - The caught error (typically ApiError or Error)
+ * @param fallback - Message to use if error is not recognized
+ * @returns A user-friendly error message
+ * @example
+ * try {
+ *   await apiGet('/users');
+ * } catch (error) {
+ *   showToast(getApiErrorMessage(error, 'Failed to load users'), 'error');
+ * }
+ */
+function getApiErrorMessage(error, fallback) {
+    if (error instanceof ApiError) {
+        return error.message || `${fallback} (${error.status})`;
+    }
+    if (error instanceof Error) {
+        return error.message;
+    }
+    return fallback;
+}
 /**
  * Makes an authenticated API call. Throws ApiError on non-2xx responses.
  * @typeParam T - The expected response data type

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/pwa-core",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Shared patterns for Azure PWA projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",