@markwharton/pwa-core 3.0.0 → 3.2.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/dist/server.d.ts

@@ -217,15 +217,28 @@ export declare function validateRequired(value: string | undefined, paramName: s
  */
 export type ErrorCallback = (operation: string, message: string) => void;
 /**
- * Sets a callback to be invoked when handleFunctionError is called.
+ * Initializes error handling configuration. Call once at application startup.
  * Use this to integrate with alerting or monitoring systems.
- * @param callback - The callback to invoke (fire-and-forget)
+ * @param config - Configuration object
+ * @param config.callback - Optional callback invoked when handleFunctionError is called (fire-and-forget)
  * @example
- * setErrorCallback((operation, message) => {
- *   sendAlert(operation, message); // Fire-and-forget
+ * initErrorHandling({
+ *   callback: (operation, message) => {
+ *     sendAlert(operation, message); // Fire-and-forget
+ *   }
  * });
  */
-export declare function setErrorCallback(callback: ErrorCallback | null): void;
+export declare function initErrorHandling(config?: {
+    callback?: ErrorCallback;
+}): void;
+/**
+ * Initializes error handling from environment variables.
+ * Currently a no-op but provides consistent API for future error config
+ * (e.g., ERROR_LOG_LEVEL, ERROR_INCLUDE_STACK).
+ * @example
+ * initErrorHandlingFromEnv(); // Uses process.env automatically
+ */
+export declare function initErrorHandlingFromEnv(): void;
 /**
  * Handles unexpected errors safely by logging details and returning a generic message.
  * Use in catch blocks to avoid exposing internal error details to clients.
@@ -287,6 +300,7 @@ export declare function isConflictError(error: unknown): boolean;
  * @param config - Storage configuration options
  * @param config.accountName - Azure Storage account name (for managed identity)
  * @param config.connectionString - Connection string (for local development)
+ * @throws Error if neither accountName nor connectionString is provided
  * @example
  * // Production (Azure with managed identity)
  * initStorage({ accountName: 'mystorageaccount' });

package/dist/server.js

@@ -28,7 +28,8 @@ exports.forbiddenResponse = forbiddenResponse;
 exports.notFoundResponse = notFoundResponse;
 exports.conflictResponse = conflictResponse;
 exports.validateRequired = validateRequired;
-exports.setErrorCallback = setErrorCallback;
+exports.initErrorHandling = initErrorHandling;
+exports.initErrorHandlingFromEnv = initErrorHandlingFromEnv;
 exports.handleFunctionError = handleFunctionError;
 exports.isTableStorageError = isTableStorageError;
 exports.isNotFoundError = isNotFoundError;
@@ -341,16 +342,30 @@ function validateRequired(value, paramName) {
 }
 let errorCallback = null;
 /**
- * Sets a callback to be invoked when handleFunctionError is called.
+ * Initializes error handling configuration. Call once at application startup.
  * Use this to integrate with alerting or monitoring systems.
- * @param callback - The callback to invoke (fire-and-forget)
+ * @param config - Configuration object
+ * @param config.callback - Optional callback invoked when handleFunctionError is called (fire-and-forget)
  * @example
- * setErrorCallback((operation, message) => {
- *   sendAlert(operation, message); // Fire-and-forget
+ * initErrorHandling({
+ *   callback: (operation, message) => {
+ *     sendAlert(operation, message); // Fire-and-forget
+ *   }
  * });
  */
-function setErrorCallback(callback) {
-    errorCallback = callback;
+function initErrorHandling(config = {}) {
+    errorCallback = config.callback ?? null;
+}
+/**
+ * Initializes error handling from environment variables.
+ * Currently a no-op but provides consistent API for future error config
+ * (e.g., ERROR_LOG_LEVEL, ERROR_INCLUDE_STACK).
+ * @example
+ * initErrorHandlingFromEnv(); // Uses process.env automatically
+ */
+function initErrorHandlingFromEnv() {
+    // Future: read ERROR_LOG_LEVEL, ERROR_INCLUDE_STACK, etc.
+    initErrorHandling({});
 }
 /**
  * Handles unexpected errors safely by logging details and returning a generic message.
@@ -453,6 +468,7 @@ let storageConnectionString;
  * @param config - Storage configuration options
  * @param config.accountName - Azure Storage account name (for managed identity)
  * @param config.connectionString - Connection string (for local development)
+ * @throws Error if neither accountName nor connectionString is provided
  * @example
  * // Production (Azure with managed identity)
  * initStorage({ accountName: 'mystorageaccount' });
@@ -461,8 +477,12 @@ let storageConnectionString;
  * initStorage({ connectionString: 'UseDevelopmentStorage=true' });
  */
 function initStorage(config) {
-    storageAccountName = config.accountName;
-    storageConnectionString = config.connectionString;
+    const { accountName, connectionString } = config;
+    if (!accountName && !connectionString) {
+        throw new Error('Storage requires either accountName (for managed identity) or connectionString');
+    }
+    storageAccountName = accountName;
+    storageConnectionString = connectionString;
 }
 /**
  * Initializes storage from environment variables.

package/package.json

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