cwa-gnap-api.ts

Go to the documentation of this file.

/**
 * CWA Fieldpine GNAP API Integration
 * Based on real API analysis from iig.cwanz.online
 */
 
export interface CWAApiResponse<T = any> {
  data?: T;
  error?: string;
  status?: string;
}
 
export interface LocationData {
  id: string;
  name: string;
  address?: string;
  phone?: string;
  status?: string;
}
 
export interface StatsData {
  sales_today?: number;
  transactions_today?: number;
  last_updated?: string;
}
 
export interface SalesTotalsData {
  total?: number;
  count?: number;
  period?: string;
}
 
export class CWAGnapApi {
  private baseUrl: string;
  private apiKey?: string;
 
  constructor(baseUrl?: string) {
    this.baseUrl = baseUrl || process.env.NEXT_PUBLIC_FIELDPINE_GNAP_API_URL || 'https://iig.cwanz.online/GNAP/j';
  }
 
  /**
   * Set the API key for authenticated requests
   */
  setApiKey(apiKey: string) {
    this.apiKey = apiKey;
  }
 
  /**
   * Make a BUCK request to the GNAP API
   */
  private async buckRequest(service: string, params: Record<string, string | number> = {}): Promise<CWAApiResponse> {
    const url = new URL(`${this.baseUrl}/BUCK`);
    
    // Add the service parameter
    url.searchParams.set('3', service);
    
    // Add additional parameters
    Object.entries(params).forEach(([key, value]) => {
      url.searchParams.set(key, String(value));
    });
 
    const headers: HeadersInit = {
      'Accept': '*/*',
      'Cache-Control': 'no-cache',
    };
 
    // Add authentication if available
    if (this.apiKey) {
      headers['Cookie'] = `FieldpineApiKey=${this.apiKey}`;
    }
 
    try {
      const response = await fetch(url.toString(), {
        method: 'GET',
        headers,
      });
 
      if (!response.ok) {
        return {
          error: `HTTP ${response.status}: ${response.statusText}`,
          status: 'error'
        };
      }
 
      const data = await response.json();
      return {
        data,
        status: 'success'
      };
    } catch (error) {
      return {
        error: error instanceof Error ? error.message : 'Unknown error',
        status: 'error'
      };
    }
  }
 
  /**
   * Make a simple GET request to non-BUCK endpoints
   */
  private async simpleRequest(endpoint: string, params: Record<string, string | number> = {}): Promise<CWAApiResponse> {
    const baseUrl = this.baseUrl.replace('/GNAP/j', ''); // Use base domain for simple requests
    const url = new URL(`${baseUrl}/${endpoint}`);
    
    Object.entries(params).forEach(([key, value]) => {
      url.searchParams.set(key, String(value));
    });
 
    const headers: HeadersInit = {
      'Accept': '*/*',
      'Cache-Control': 'no-cache',
    };
 
    if (this.apiKey) {
      headers['Cookie'] = `FieldpineApiKey=${this.apiKey}`;
    }
 
    try {
      const response = await fetch(url.toString(), {
        method: 'GET',
        headers,
      });
 
      if (!response.ok) {
        return {
          error: `HTTP ${response.status}: ${response.statusText}`,
          status: 'error'
        };
      }
 
      const data = await response.text(); // Some endpoints return text, not JSON
      
      try {
        const jsonData = JSON.parse(data);
        return { data: jsonData, status: 'success' };
      } catch {
        return { data, status: 'success' };
      }
    } catch (error) {
      return {
        error: error instanceof Error ? error.message : 'Unknown error',
        status: 'error'
      };
    }
  }
 
  // Specific API methods based on discovered endpoints
 
  /**
   * Get locations list
   * BUCK?3=retailmax.elink.locations&101=1
   */
  async getLocations(includeAll = true): Promise<CWAApiResponse<LocationData[]>> {
    return this.buckRequest('retailmax.elink.locations', includeAll ? { '101': 1 } : undefined);
  }
 
  /**
   * Get specific locations by range
   * buck?3=retailmax.elink.locations&10=100-160,164,185,186
   */
  async getLocationsByRange(range: string): Promise<CWAApiResponse<LocationData[]>> {
    return this.buckRequest('retailmax.elink.locations', { '10': range });
  }
 
  /**
   * Get today's statistics
   * buck?3=retailmax.elink.stats.today
   */
  async getStatsToday(): Promise<CWAApiResponse<StatsData>> {
    return this.buckRequest('retailmax.elink.stats.today');
  }
 
  /**
   * Get today's statistics with specific fields
   * buck?3=retailmax.elink.stats.today&9=f112,0,1
   */
  async getStatsTodayWithFields(fields: string): Promise<CWAApiResponse<StatsData>> {
    return this.buckRequest('retailmax.elink.stats.today', { '9': fields });
  }
 
  /**
   * Get sales totals
   * buck?3=retailmax.elink.sale.totals&13=120&7=101&9=f110,4,month-0
   */
  async getSalesTotals(params: { 
    field13?: number, 
    field7?: number, 
    field9?: string 
  } = {}): Promise<CWAApiResponse<SalesTotalsData>> {
    const requestParams: Record<string, string | number> = {};
    if (params.field13) requestParams['13'] = params.field13;
    if (params.field7) requestParams['7'] = params.field7;
    if (params.field9) requestParams['9'] = params.field9;
    
    return this.buckRequest('retailmax.elink.sale.totals', requestParams);
  }
 
  /**
   * Get user interface components
   * buck?3=retailmax.elink.userinterface&100=sshome
   */
  async getUserInterface(component: string): Promise<CWAApiResponse> {
    return this.buckRequest('retailmax.elink.userinterface', { '100': component });
  }
 
  /**
   * Get printing pending list
   * buck?3=retailmax.elink.printingpending.list
   */
  async getPrintingPending(): Promise<CWAApiResponse> {
    return this.buckRequest('retailmax.elink.printingpending.list');
  }
 
  /**
   * Get contact log list
   * buck?3=retailmax.elink.contactlog.list&500=quicksummary
   */
  async getContactLog(filter?: string): Promise<CWAApiResponse> {
    const params = filter ? { '500': filter } : undefined;
    return this.buckRequest('retailmax.elink.contactlog.list', params);
  }
 
  /**
   * Get server status
   * buck?3=gds.server.status
   */
  async getServerStatus(): Promise<CWAApiResponse> {
    return this.buckRequest('gds.server.status');
  }
 
  /**
   * Get configuration settings
   * buck?3=retailmax.elink.config.setting&9=f100,0,RmSystem
   */
  async getConfigSetting(setting: string): Promise<CWAApiResponse> {
    return this.buckRequest('retailmax.elink.config.setting', { '9': setting });
  }
 
  /**
   * Get base configuration
   * BUCK?3=retailmax.elink.config.basesetting&112=1&112=999&9=f100,0,SaleSendRandomHost.1.Address
   */
  async getBaseSetting(setting: string, field112Values: number[] = [1, 999]): Promise<CWAApiResponse> {
    const params: Record<string, string | number> = { '9': setting };
    field112Values.forEach((value, index) => {
      params[`112`] = value; // Note: This will overwrite, but that's how the original API works
    });
    return this.buckRequest('retailmax.elink.config.basesetting', params);
  }
 
  /**
   * Get advisor event list
   * buck?3=retailmax.elink.advisor.eventlist&110=accou…other,products,staff,reference,security,technical
   */
  async getAdvisorEventList(categories: string): Promise<CWAApiResponse> {
    return this.buckRequest('retailmax.elink.advisor.eventlist', { '110': categories });
  }
 
  // Simple endpoint methods
 
  /**
   * Get membership information
   * membership?id=cartridgeworld
   */
  async getMembership(id: string): Promise<CWAApiResponse> {
    return this.simpleRequest('membership', { id });
  }
 
  /**
   * Get products
   * products?99=7
   */
  async getProducts(filter?: number): Promise<CWAApiResponse> {
    const params = filter ? { '99': filter } : undefined;
    return this.simpleRequest('products', params);
  }
 
  /**
   * Get locations (simple endpoint)
   * locations
   */
  async getLocationsSimple(): Promise<CWAApiResponse> {
    return this.simpleRequest('locations');
  }
 
  /**
   * Get retail configuration
   * RetailConfig
   */
  async getRetailConfig(): Promise<CWAApiResponse> {
    return this.simpleRequest('RetailConfig');
  }
 
  /**
   * Get echo response
   * echo.js
   */
  async getEcho(): Promise<CWAApiResponse> {
    return this.simpleRequest('echo.js');
  }
}
 
// Create singleton instance
export const cwaApi = new CWAGnapApi();
 
// Helper function to set API key globally
export function setCWAApiKey(apiKey: string) {
  cwaApi.setApiKey(apiKey);
}