@oxyhq/services 6.3.0 → 6.4.0

package/lib/typescript/commonjs/ui/utils/authHelpers.d.ts

@@ -1,99 +0,0 @@
-/**
- * Authentication helper utilities to reduce code duplication across hooks and utilities.
- * These functions handle common token validation and authentication error patterns.
- */
-import type { OxyServices } from '@oxyhq/core';
-/**
- * Error thrown when session sync is required
- */
-export declare class SessionSyncRequiredError extends Error {
-    constructor(message?: string);
-}
-/**
- * Error thrown when authentication fails
- */
-export declare class AuthenticationFailedError extends Error {
-    constructor(message?: string);
-}
-/**
- * Ensures a valid token exists before making authenticated API calls.
- * If no valid token exists and an active session ID is available,
- * attempts to refresh the token using the session.
- *
- * @param oxyServices - The OxyServices instance
- * @param activeSessionId - The active session ID (if available)
- * @throws {SessionSyncRequiredError} If the session needs to be synced (offline session)
- * @throws {Error} If token refresh fails for other reasons
- *
- * @example
- * ```ts
- * // In a mutation or query function:
- * await ensureValidToken(oxyServices, activeSessionId);
- * return await oxyServices.updateProfile(updates);
- * ```
- */
-export declare function ensureValidToken(oxyServices: OxyServices, activeSessionId: string | null | undefined): Promise<void>;
-/**
- * Options for handling API authentication errors
- */
-export interface HandleApiErrorOptions {
-    /** Optional callback to attempt session sync and retry */
-    syncSession?: () => Promise<unknown>;
-    /** The active session ID for retry attempts */
-    activeSessionId?: string | null;
-    /** The OxyServices instance for retry attempts */
-    oxyServices?: OxyServices;
-}
-/**
- * Checks if an error is an authentication error (401 or auth-related message)
- *
- * @param error - The error to check
- * @returns True if the error is an authentication error
- */
-export declare function isAuthenticationError(error: unknown): boolean;
-/**
- * Wraps an API call with authentication error handling.
- * If an authentication error occurs, it can optionally attempt to sync the session and retry.
- *
- * @param apiCall - The API call function to execute
- * @param options - Optional error handling configuration
- * @returns The result of the API call
- * @throws {AuthenticationFailedError} If authentication fails and cannot be recovered
- * @throws {Error} If the API call fails for non-auth reasons
- *
- * @example
- * ```ts
- * // Simple usage:
- * const result = await withAuthErrorHandling(
- *   () => oxyServices.updateProfile(updates)
- * );
- *
- * // With retry on auth failure:
- * const result = await withAuthErrorHandling(
- *   () => oxyServices.updateProfile(updates),
- *   { syncSession, activeSessionId, oxyServices }
- * );
- * ```
- */
-export declare function withAuthErrorHandling<T>(apiCall: () => Promise<T>, options?: HandleApiErrorOptions): Promise<T>;
-/**
- * Combines token validation and auth error handling for a complete authenticated API call.
- * This is the recommended helper for most authenticated API operations.
- *
- * @param oxyServices - The OxyServices instance
- * @param activeSessionId - The active session ID
- * @param apiCall - The API call function to execute
- * @param syncSession - Optional callback to sync session on auth failure
- * @returns The result of the API call
- *
- * @example
- * ```ts
- * return await authenticatedApiCall(
- *   oxyServices,
- *   activeSessionId,
- *   () => oxyServices.updateProfile(updates)
- * );
- * ```
- */
-export declare function authenticatedApiCall<T>(oxyServices: OxyServices, activeSessionId: string | null | undefined, apiCall: () => Promise<T>, syncSession?: () => Promise<unknown>): Promise<T>;
-//# sourceMappingURL=authHelpers.d.ts.map

package/lib/typescript/commonjs/ui/utils/authHelpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"authHelpers.d.ts","sourceRoot":"","sources":["../../../../../src/ui/utils/authHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;gBACrC,OAAO,SAAkD;CAItE;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,KAAK;gBACtC,OAAO,SAAiD;CAIrE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GACzC,OAAO,CAAC,IAAI,CAAC,CAgBf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IACrC,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,kDAAkD;IAClD,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAc7D;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,qBAAqB,CAAC,CAAC,EAC3C,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACzB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,CAAC,CAAC,CAsBZ;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,oBAAoB,CAAC,CAAC,EAC1C,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAC1C,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACzB,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GACnC,OAAO,CAAC,CAAC,CAAC,CAQZ"}

package/lib/typescript/module/ui/utils/authHelpers.d.ts

@@ -1,99 +0,0 @@
-/**
- * Authentication helper utilities to reduce code duplication across hooks and utilities.
- * These functions handle common token validation and authentication error patterns.
- */
-import type { OxyServices } from '@oxyhq/core';
-/**
- * Error thrown when session sync is required
- */
-export declare class SessionSyncRequiredError extends Error {
-    constructor(message?: string);
-}
-/**
- * Error thrown when authentication fails
- */
-export declare class AuthenticationFailedError extends Error {
-    constructor(message?: string);
-}
-/**
- * Ensures a valid token exists before making authenticated API calls.
- * If no valid token exists and an active session ID is available,
- * attempts to refresh the token using the session.
- *
- * @param oxyServices - The OxyServices instance
- * @param activeSessionId - The active session ID (if available)
- * @throws {SessionSyncRequiredError} If the session needs to be synced (offline session)
- * @throws {Error} If token refresh fails for other reasons
- *
- * @example
- * ```ts
- * // In a mutation or query function:
- * await ensureValidToken(oxyServices, activeSessionId);
- * return await oxyServices.updateProfile(updates);
- * ```
- */
-export declare function ensureValidToken(oxyServices: OxyServices, activeSessionId: string | null | undefined): Promise<void>;
-/**
- * Options for handling API authentication errors
- */
-export interface HandleApiErrorOptions {
-    /** Optional callback to attempt session sync and retry */
-    syncSession?: () => Promise<unknown>;
-    /** The active session ID for retry attempts */
-    activeSessionId?: string | null;
-    /** The OxyServices instance for retry attempts */
-    oxyServices?: OxyServices;
-}
-/**
- * Checks if an error is an authentication error (401 or auth-related message)
- *
- * @param error - The error to check
- * @returns True if the error is an authentication error
- */
-export declare function isAuthenticationError(error: unknown): boolean;
-/**
- * Wraps an API call with authentication error handling.
- * If an authentication error occurs, it can optionally attempt to sync the session and retry.
- *
- * @param apiCall - The API call function to execute
- * @param options - Optional error handling configuration
- * @returns The result of the API call
- * @throws {AuthenticationFailedError} If authentication fails and cannot be recovered
- * @throws {Error} If the API call fails for non-auth reasons
- *
- * @example
- * ```ts
- * // Simple usage:
- * const result = await withAuthErrorHandling(
- *   () => oxyServices.updateProfile(updates)
- * );
- *
- * // With retry on auth failure:
- * const result = await withAuthErrorHandling(
- *   () => oxyServices.updateProfile(updates),
- *   { syncSession, activeSessionId, oxyServices }
- * );
- * ```
- */
-export declare function withAuthErrorHandling<T>(apiCall: () => Promise<T>, options?: HandleApiErrorOptions): Promise<T>;
-/**
- * Combines token validation and auth error handling for a complete authenticated API call.
- * This is the recommended helper for most authenticated API operations.
- *
- * @param oxyServices - The OxyServices instance
- * @param activeSessionId - The active session ID
- * @param apiCall - The API call function to execute
- * @param syncSession - Optional callback to sync session on auth failure
- * @returns The result of the API call
- *
- * @example
- * ```ts
- * return await authenticatedApiCall(
- *   oxyServices,
- *   activeSessionId,
- *   () => oxyServices.updateProfile(updates)
- * );
- * ```
- */
-export declare function authenticatedApiCall<T>(oxyServices: OxyServices, activeSessionId: string | null | undefined, apiCall: () => Promise<T>, syncSession?: () => Promise<unknown>): Promise<T>;
-//# sourceMappingURL=authHelpers.d.ts.map

package/lib/typescript/module/ui/utils/authHelpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"authHelpers.d.ts","sourceRoot":"","sources":["../../../../../src/ui/utils/authHelpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;gBACrC,OAAO,SAAkD;CAItE;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,KAAK;gBACtC,OAAO,SAAiD;CAIrE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GACzC,OAAO,CAAC,IAAI,CAAC,CAgBf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IACrC,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,kDAAkD;IAClD,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAc7D;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,qBAAqB,CAAC,CAAC,EAC3C,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACzB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,CAAC,CAAC,CAsBZ;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,oBAAoB,CAAC,CAAC,EAC1C,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAC1C,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACzB,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GACnC,OAAO,CAAC,CAAC,CAAC,CAQZ"}

package/src/ui/utils/authHelpers.ts

@@ -1,183 +0,0 @@
-/**
- * Authentication helper utilities to reduce code duplication across hooks and utilities.
- * These functions handle common token validation and authentication error patterns.
- */
-
-import type { OxyServices } from '@oxyhq/core';
-
-/**
- * Error thrown when session sync is required
- */
-export class SessionSyncRequiredError extends Error {
-  constructor(message = 'Session needs to be synced. Please try again.') {
-    super(message);
-    this.name = 'SessionSyncRequiredError';
-  }
-}
-
-/**
- * Error thrown when authentication fails
- */
-export class AuthenticationFailedError extends Error {
-  constructor(message = 'Authentication failed. Please sign in again.') {
-    super(message);
-    this.name = 'AuthenticationFailedError';
-  }
-}
-
-/**
- * Ensures a valid token exists before making authenticated API calls.
- * If no valid token exists and an active session ID is available,
- * attempts to refresh the token using the session.
- *
- * @param oxyServices - The OxyServices instance
- * @param activeSessionId - The active session ID (if available)
- * @throws {SessionSyncRequiredError} If the session needs to be synced (offline session)
- * @throws {Error} If token refresh fails for other reasons
- *
- * @example
- * ```ts
- * // In a mutation or query function:
- * await ensureValidToken(oxyServices, activeSessionId);
- * return await oxyServices.updateProfile(updates);
- * ```
- */
-export async function ensureValidToken(
-  oxyServices: OxyServices,
-  activeSessionId: string | null | undefined
-): Promise<void> {
-  if (oxyServices.hasValidToken() || !activeSessionId) {
-    return;
-  }
-
-  try {
-    await oxyServices.getTokenBySession(activeSessionId);
-  } catch (tokenError) {
-    const errorMessage = tokenError instanceof Error ? tokenError.message : String(tokenError);
-
-    if (errorMessage.includes('AUTH_REQUIRED_OFFLINE_SESSION') || errorMessage.includes('offline')) {
-      throw new SessionSyncRequiredError();
-    }
-
-    throw tokenError;
-  }
-}
-
-/**
- * Options for handling API authentication errors
- */
-export interface HandleApiErrorOptions {
-  /** Optional callback to attempt session sync and retry */
-  syncSession?: () => Promise<unknown>;
-  /** The active session ID for retry attempts */
-  activeSessionId?: string | null;
-  /** The OxyServices instance for retry attempts */
-  oxyServices?: OxyServices;
-}
-
-/**
- * Checks if an error is an authentication error (401 or auth-related message)
- *
- * @param error - The error to check
- * @returns True if the error is an authentication error
- */
-export function isAuthenticationError(error: unknown): boolean {
-  if (!error || typeof error !== 'object') {
-    return false;
-  }
-
-  const errorObj = error as { message?: string; status?: number; response?: { status?: number } };
-  const errorMessage = errorObj.message || '';
-  const status = errorObj.status || errorObj.response?.status;
-
-  return (
-    status === 401 ||
-    errorMessage.includes('Authentication required') ||
-    errorMessage.includes('Invalid or missing authorization header')
-  );
-}
-
-/**
- * Wraps an API call with authentication error handling.
- * If an authentication error occurs, it can optionally attempt to sync the session and retry.
- *
- * @param apiCall - The API call function to execute
- * @param options - Optional error handling configuration
- * @returns The result of the API call
- * @throws {AuthenticationFailedError} If authentication fails and cannot be recovered
- * @throws {Error} If the API call fails for non-auth reasons
- *
- * @example
- * ```ts
- * // Simple usage:
- * const result = await withAuthErrorHandling(
- *   () => oxyServices.updateProfile(updates)
- * );
- *
- * // With retry on auth failure:
- * const result = await withAuthErrorHandling(
- *   () => oxyServices.updateProfile(updates),
- *   { syncSession, activeSessionId, oxyServices }
- * );
- * ```
- */
-export async function withAuthErrorHandling<T>(
-  apiCall: () => Promise<T>,
-  options?: HandleApiErrorOptions
-): Promise<T> {
-  try {
-    return await apiCall();
-  } catch (error) {
-    if (!isAuthenticationError(error)) {
-      throw error;
-    }
-
-    // If we have sync capabilities, try to recover
-    if (options?.syncSession && options?.activeSessionId && options?.oxyServices) {
-      try {
-        await options.syncSession();
-        await options.oxyServices.getTokenBySession(options.activeSessionId);
-        // Retry the API call after refreshing token
-        return await apiCall();
-      } catch {
-        throw new AuthenticationFailedError();
-      }
-    }
-
-    throw new AuthenticationFailedError();
-  }
-}
-
-/**
- * Combines token validation and auth error handling for a complete authenticated API call.
- * This is the recommended helper for most authenticated API operations.
- *
- * @param oxyServices - The OxyServices instance
- * @param activeSessionId - The active session ID
- * @param apiCall - The API call function to execute
- * @param syncSession - Optional callback to sync session on auth failure
- * @returns The result of the API call
- *
- * @example
- * ```ts
- * return await authenticatedApiCall(
- *   oxyServices,
- *   activeSessionId,
- *   () => oxyServices.updateProfile(updates)
- * );
- * ```
- */
-export async function authenticatedApiCall<T>(
-  oxyServices: OxyServices,
-  activeSessionId: string | null | undefined,
-  apiCall: () => Promise<T>,
-  syncSession?: () => Promise<unknown>
-): Promise<T> {
-  await ensureValidToken(oxyServices, activeSessionId);
-
-  return withAuthErrorHandling(apiCall, {
-    syncSession,
-    activeSessionId,
-    oxyServices,
-  });
-}