apiRouting.ts

Go to the documentation of this file.

/**
 * API Request Routing Logic
 * 
 * Determines the correct API endpoint based on:
 * - Request type (openapi, gnap, elink)
 * - Current store context
 * - User session
 * 
 * Store URLs are built dynamically from environment variable:
 * NEXT_PUBLIC_FIELDPINE_STORE_DOMAIN (default: cwanz.online)
 * Format: https://{store-id}.{domain}
 * Examples: https://cowra.cwanz.online, https://iig.cwanz.online
 */
 
import { Store } from './stores';
 
export type RequestType = 'openapi' | 'gnap' | 'elink';
 
export interface RoutingContext {
  store: Store;
  requestType: RequestType;
}
 
/**
 * Get the appropriate endpoint URL based on request type and store
 * 
 * Rules:
 * - OpenAPI: Routes to store URL (e.g., cowra.cwanz.online/openapi)
 *   Only available for store types, NOT for management portal
 * 
 * - GNAP: Always routes to IIG management portal (iig.cwanz.online/GNAP/j)
 *   Used for central reporting and cross-store operations
 * 
 * - ELINK: Routes to store URL (e.g., cowra.cwanz.online/GNAP/j)
 *   Used for store-specific configuration
 */
export function getEndpointUrl(
  requestType: RequestType,
  store: Store
): string {
  switch (requestType) {
    case 'openapi':
      if (store.type === 'management') {
        throw new Error(
          'OpenAPI endpoints are not available when logged into the management portal. ' +
          'Please log into a specific store to access POS functions.'
        );
      }
      return `${store.url}/openapi`;
    
    case 'gnap':
      // GNAP requests always go to IIG management portal for central operations
      return 'https://iig.cwanz.online/GNAP/j';
    
    case 'elink':
      // ELINK requests go to the current store for store-specific config
      return `${store.url}/GNAP/j`;
    
    default:
      throw new Error(`Unknown request type: ${requestType}`);
  }
}
 
/**
 * Validate that a request is allowed for the current store context
 * 
 * Security Rules:
 * - Retail stores: Can ONLY access ELINK endpoints
 * - Management portal: Can access OpenAPI, GNAP, and ELINK
 * - OpenAPI: Management portal ONLY (for centralized POS operations)
 * - GNAP: Management portal ONLY (for reporting and analytics)
 * - ELINK: Both retail stores and management portal (store-specific operations)
 */
export function validateRequest(
  requestType: RequestType,
  store: Store
): { valid: boolean; error?: string } {
  // Management portal has full access
  if (store.type === 'management') {
    return { valid: true };
  }
 
  // Retail stores can ONLY use ELINK
  if (store.type === 'store') {
    if (requestType === 'openapi') {
      return {
        valid: false,
        error: 'Security: Retail stores cannot access OpenAPI. Use ELINK endpoints for store operations.'
      };
    }
 
    if (requestType === 'gnap') {
      return {
        valid: false,
        error: 'Security: Retail stores cannot access GNAP. This is restricted to management portal.'
      };
    }
 
    if (requestType === 'elink') {
      return { valid: true };
    }
  }
  
  return {
    valid: false,
    error: 'Invalid request type or store type'
  };
}
 
/**
 * Get the appropriate request type for common operations
 */
export function getRequestTypeForOperation(operation: string): RequestType {
  // POS Operations - OpenAPI
  if (operation.match(/^(products|sales|customers|inventory|stock)/i)) {
    return 'openapi';
  }
  
  // Reporting and cross-store - GNAP
  if (operation.match(/^(report|analytics|cross-store)/i)) {
    return 'gnap';
  }
  
  // Store configuration - ELINK
  if (operation.match(/^(config|settings|store-setup)/i)) {
    return 'elink';
  }
  
  // Default to GNAP for unknown operations
  return 'gnap';
}
 
/**
 * Build full API URL with query parameters
 */
export function buildApiUrl(
  baseUrl: string,
  path: string,
  params?: Record<string, string>
): string {
  const url = new URL(path, baseUrl);
  
  if (params) {
    Object.entries(params).forEach(([key, value]) => {
      url.searchParams.append(key, value);
    });
  }
  
  return url.toString();
}