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

@@ -8,13 +8,27 @@ import { TableClient } from '@azure/data-tables';
 import { Result, BaseJwtPayload, RoleTokenPayload } from './shared';
 /**
  * Initializes the JWT authentication system. Call once at application startup.
- * @param secret - The JWT secret key (from environment variable)
- * @param minLength - Minimum required secret length (default: 32)
+ * @param config - Configuration object
+ * @param config.secret - The JWT secret key (from environment variable)
+ * @param config.minLength - Minimum required secret length (default: 32)
  * @throws Error if secret is missing or too short
  * @example
- * initAuth(process.env.JWT_SECRET);
+ * initAuth({ secret: process.env.JWT_SECRET });
+ * initAuth({ secret: process.env.JWT_SECRET, minLength: 64 });
+ */
+export declare function initAuth(config: {
+    secret?: string;
+    minLength?: number;
+}): void;
+/**
+ * Initializes JWT authentication from environment variables.
+ * Reads JWT_SECRET from process.env.
+ * @param minLength - Minimum required secret length (default: 32)
+ * @throws Error if JWT_SECRET is missing or too short
+ * @example
+ * initAuthFromEnv(); // Uses process.env.JWT_SECRET
  */
-export declare function initAuth(secret: string | undefined, minLength?: number): void;
+export declare function initAuthFromEnv(minLength?: number): void;
 /**
  * Gets the configured JWT secret.
  * @returns The JWT secret string

package/dist/server.js

@@ -10,6 +10,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HTTP_STATUS = exports.isAdmin = exports.hasRole = exports.hasUsername = exports.getErrorMessage = exports.err = exports.okVoid = exports.ok = exports.DEFAULT_TOKEN_EXPIRY_SECONDS = exports.DEFAULT_TOKEN_EXPIRY = void 0;
 exports.initAuth = initAuth;
+exports.initAuthFromEnv = initAuthFromEnv;
 exports.getJwtSecret = getJwtSecret;
 exports.extractToken = extractToken;
 exports.validateToken = validateToken;
@@ -50,18 +51,35 @@ const shared_1 = require("./shared");
 let jwtSecret = null;
 /**
  * Initializes the JWT authentication system. Call once at application startup.
- * @param secret - The JWT secret key (from environment variable)
- * @param minLength - Minimum required secret length (default: 32)
+ * @param config - Configuration object
+ * @param config.secret - The JWT secret key (from environment variable)
+ * @param config.minLength - Minimum required secret length (default: 32)
  * @throws Error if secret is missing or too short
  * @example
- * initAuth(process.env.JWT_SECRET);
+ * initAuth({ secret: process.env.JWT_SECRET });
+ * initAuth({ secret: process.env.JWT_SECRET, minLength: 64 });
  */
-function initAuth(secret, minLength = 32) {
+function initAuth(config) {
+    const { secret, minLength = 32 } = config;
     if (!secret || secret.length < minLength) {
         throw new Error(`JWT_SECRET must be at least ${minLength} characters`);
     }
     jwtSecret = secret;
 }
+/**
+ * Initializes JWT authentication from environment variables.
+ * Reads JWT_SECRET from process.env.
+ * @param minLength - Minimum required secret length (default: 32)
+ * @throws Error if JWT_SECRET is missing or too short
+ * @example
+ * initAuthFromEnv(); // Uses process.env.JWT_SECRET
+ */
+function initAuthFromEnv(minLength = 32) {
+    initAuth({
+        secret: process.env.JWT_SECRET,
+        minLength
+    });
+}
 /**
  * Gets the configured JWT secret.
  * @returns The JWT secret string

package/package.json

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