@explorer02/cfm-survey-sdk 0.0.1 → 0.0.2

package/src/analytics/analyticsTracker.ts

@@ -1,48 +0,0 @@
-import { sdkLogger } from '../logger/logger';
-import type { AnalyticsEvent } from './types';
-
-export function trackEvent(event: AnalyticsEvent) {
-  if (event.eventName === 'survey_session_summary') {
-    const {
-      completed,
-      totalDurationMs,
-      maxVisitedPageIndex,
-      totalQuestionsCount,
-      answeredQuestionsCount,
-      skippedQuestionsCount,
-      skippedQuestionIds,
-      validationErrorsCount,
-      backtrackCount,
-    } = event.metadata;
-
-    // Always log to console with Heading as ANALYTICS
-    sdkLogger.analytics(`Event: ${event.eventName} - SESSION SUMMARY TABLE:`);
-
-    const summaryTable = [
-      { Metric: 'Completion Status', Value: completed ? 'COMPLETED ✅' : 'ABANDONED ❌' },
-      { Metric: 'Total Time Spent', Value: `${(totalDurationMs / 1000).toFixed(2)} seconds` },
-      { Metric: 'Max Page Index Reached', Value: `${maxVisitedPageIndex}` },
-      { Metric: 'Total Questions', Value: totalQuestionsCount },
-      { Metric: 'Answered Questions', Value: answeredQuestionsCount },
-      { Metric: 'Skipped Optional Questions', Value: skippedQuestionsCount },
-      { Metric: 'Skipped Question IDs', Value: skippedQuestionIds.join(', ') || 'None' },
-      { Metric: 'Validation Errors Triggered', Value: validationErrorsCount },
-      { Metric: 'Backtrack Count', Value: backtrackCount },
-      {
-        Metric: 'Validation Error History',
-        Value:
-          event.metadata.validationHistory
-            ?.map(
-              h =>
-                `[Page ${h.pageIndex}] Attempt ${h.attemptNumber}: ${Object.keys(h.errors).join(', ')}`
-            )
-            .join(' | ') || 'NO Validation Erros Occurred',
-      },
-    ];
-
-    console.table(summaryTable);
-  } else {
-    // Always log to console with Heading as ANALYTICS
-    sdkLogger.analytics(`Event: ${event.eventName}`, event.metadata);
-  }
-}

package/src/analytics/types.ts

@@ -1,80 +0,0 @@
-export type AnalyticsEvent =
-  | {
-      eventName: 'survey_fetch_latency';
-      metadata: {
-        durationMs: number;
-        status: number | string;
-        success: boolean;
-        url: string;
-        payloadSize?: string;
-      };
-    }
-  | {
-      eventName: 'survey_submit_latency';
-      metadata: {
-        durationMs: number;
-        status: number | string;
-        success: boolean;
-        url: string;
-        requestSize?: string;
-        responseSize?: string;
-      };
-    }
-  | {
-      eventName: 'api_error';
-      metadata: {
-        apiName: string;
-        status: number | string;
-        url: string;
-        errorMessage: string;
-      };
-    }
-  | {
-      eventName: 'optional_question_skipped';
-      metadata: {
-        questionId: string;
-        pageIndex: number;
-      };
-    }
-  | {
-      eventName: 'backtrack_revisited';
-      metadata: {
-        fromPageIndex: number;
-        toPageIndex: number;
-        changedAnswers: Record<string, { oldValue: any; newValue: any }>;
-      };
-    }
-  | {
-      eventName: 'validation_error';
-      metadata: {
-        pageIndex: number;
-        errors: Record<string, string>;
-        attemptNumber: number;
-      };
-    }
-  | {
-      eventName: 'page_time_spent';
-      metadata: {
-        pageIndex: number;
-        durationMs: number;
-      };
-    }
-  | {
-      eventName: 'survey_session_summary';
-      metadata: {
-        maxVisitedPageIndex: number;
-        totalDurationMs: number;
-        completed: boolean;
-        totalQuestionsCount: number;
-        answeredQuestionsCount: number;
-        skippedQuestionsCount: number;
-        skippedQuestionIds: string[];
-        validationErrorsCount: number;
-        backtrackCount: number;
-        validationHistory: Array<{
-          pageIndex: number;
-          errors: Record<string, string>;
-          attemptNumber: number;
-        }>;
-      };
-    };

package/src/cli/deploy.ts

@@ -1,205 +0,0 @@
-import { execSync, spawn } from 'child_process';
-import readline from 'readline/promises';
-import { stdin as input, stdout as output } from 'process';
-import path from 'path';
-
-const colors = {
-  reset: '\x1b[0m',
-  bold: '\x1b[1m',
-  green: '\x1b[32m',
-  red: '\x1b[31m',
-  cyan: '\x1b[36m',
-  yellow: '\x1b[33m',
-  dim: '\x1b[2m',
-};
-
-// Simple interactive prompt using Node.js built-in readline
-async function askQuestion(query: string): Promise<string> {
-  const rl = readline.createInterface({ input, output });
-  try {
-    return (await rl.question(query)).trim();
-  } finally {
-    rl.close();
-  }
-}
-
-// Check if a shell executable is available in the user's system PATH
-function hasCommand(cmd: string): boolean {
-  try {
-    const checkCmd = process.platform === 'win32' ? `where ${cmd}` : `command -v ${cmd}`;
-    execSync(checkCmd, { stdio: 'ignore' });
-    return true;
-  } catch {
-    return false;
-  }
-}
-
-// Execute a command synchronously and capture output/return code
-function runCommandSync(cmd: string, args: string[]): boolean {
-  try {
-    const fullCmd = `${cmd} ${args.join(' ')}`;
-    execSync(fullCmd, { stdio: 'inherit', shell: true } as any);
-    return true;
-  } catch {
-    return false;
-  }
-}
-
-// Spawn an interactive command that inherits stdin/stdout/stderr
-function runCommandInteractive(cmd: string, args: string[]): Promise<number | null> {
-  return new Promise((resolve) => {
-    const child = spawn(cmd, args, {
-      stdio: 'inherit',
-      shell: true,
-    });
-
-    child.on('close', (code) => {
-      resolve(code);
-    });
-  });
-}
-
-// Main deployment wrapper
-export async function runDeployment() {
-  console.log(`\n${colors.bold}${colors.cyan}🚀 Starting CFM Vercel Deployment...${colors.reset}\n`);
-
-  // --- STEP 1: NODE.JS VERSION CHECK & AUTOMATED UPGRADE ---
-  const majorVersion = parseInt(process.version.slice(1).split('.')[0], 10);
-  console.log(`${colors.dim}Step 1/4: Checking Node.js version (current: ${process.version})...${colors.reset}`);
-
-  if (majorVersion < 18) {
-    console.log(`⚠️  ${colors.yellow}Outdated Node.js version detected. v18.0.0 or higher is required.${colors.reset}`);
-    
-    const isWin = process.platform === 'win32';
-    const isMac = process.platform === 'darwin';
-
-    if (isWin) {
-      if (hasCommand('winget')) {
-        console.log(`\n📦 ${colors.green}winget package manager found! Installing Node.js v18+ in background...${colors.reset}`);
-        const success = runCommandSync('winget', ['upgrade', 'OpenJS.NodeJS', '--silent', '--accept-package-agreements', '--accept-source-agreements']);
-        if (success) {
-          console.log(`\n✔ ${colors.green}Node.js installation triggered successfully. Please restart your terminal/command-prompt for changes to take effect.${colors.reset}\n`);
-          process.exit(0);
-        } else {
-          console.log(`\n❌ ${colors.red}winget update failed. Please update Node.js manually at https://nodejs.org/${colors.reset}\n`);
-          process.exit(1);
-        }
-      } else {
-        console.log(`\n❌ ${colors.red}winget package manager is not installed on this system.${colors.reset}`);
-        console.log(`${colors.bold}👉 To proceed, please either:${colors.reset}`);
-        console.log(`   1. Install winget (App Installer) from the Microsoft Store.`);
-        console.log(`   2. Or manually download and install Node.js (v18+) from: https://nodejs.org/\n`);
-        process.exit(1);
-      }
-    } else if (isMac) {
-      if (hasCommand('brew')) {
-        console.log(`\n📦 ${colors.green}Homebrew package manager found! Installing Node.js v18+ in background...${colors.reset}`);
-        const success = runCommandSync('brew', ['install', 'node']);
-        if (success) {
-          console.log(`\n✔ ${colors.green}Node.js installed successfully via Homebrew.${colors.reset}\n`);
-        } else {
-          console.log(`\n❌ ${colors.red}Homebrew installation failed. Please install Node.js manually at https://nodejs.org/${colors.reset}\n`);
-          process.exit(1);
-        }
-      } else {
-        console.log(`\n❌ ${colors.red}Homebrew package manager (brew) is not installed on this system.${colors.reset}`);
-        console.log(`${colors.bold}👉 To proceed, please either:${colors.reset}`);
-        console.log(`   1. Install Homebrew by running the following command in your terminal:`);
-        console.log(`      ${colors.cyan}/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"${colors.reset}`);
-        console.log(`   2. Or manually download and install Node.js (v18+) from: https://nodejs.org/\n`);
-        process.exit(1);
-      }
-    } else {
-      console.log(`\n❌ ${colors.red}Please install or update Node.js to v18+ using your system's package manager.${colors.reset}\n`);
-      process.exit(1);
-    }
-  } else {
-    console.log(`✔ ${colors.green}Node.js version (v${majorVersion}) is sufficient.${colors.reset}`);
-  }
-
-  // --- STEP 2: VERCEL CLI VERIFICATION ---
-  console.log(`\n${colors.dim}Step 2/4: Checking Vercel CLI...${colors.reset}`);
-  let vercelCmd = 'vercel';
-  let useNpx = false;
-
-  if (!hasCommand('vercel')) {
-    console.log(`❓ ${colors.yellow}Vercel CLI was not found on your system.${colors.reset}`);
-    const answer = await askQuestion(`👉 Would you like to install Vercel CLI globally? (Y/n): `);
-    
-    if (answer.toLowerCase() === 'y' || answer === '') {
-      console.log(`\n📥 ${colors.cyan}Installing Vercel CLI globally... (npm install -g vercel)${colors.reset}`);
-      const success = runCommandSync('npm', ['install', '-g', 'vercel']);
-      if (success && hasCommand('vercel')) {
-        console.log(`✔ ${colors.green}Vercel CLI installed successfully!${colors.reset}`);
-      } else {
-        console.log(`\n⚠️  ${colors.yellow}Global installation failed or permissions restricted.${colors.reset}`);
-        console.log(`ℹ ${colors.dim}Falling back: Running Vercel dynamically via npx.${colors.reset}`);
-        vercelCmd = 'npx --yes vercel';
-        useNpx = true;
-      }
-    } else {
-      console.log(`ℹ ${colors.dim}Skipping global installation. Running Vercel dynamically via npx.${colors.reset}`);
-      vercelCmd = 'npx --yes vercel';
-      useNpx = true;
-    }
-  } else {
-    console.log(`✔ ${colors.green}Vercel CLI is installed!${colors.reset}`);
-  }
-
-  // --- STEP 3: VERCEL LOGIN CHECK ---
-  console.log(`\n${colors.dim}Step 3/4: Checking Vercel Login...${colors.reset}`);
-  
-  // Use VERCEL_TOKEN if available
-  const hasToken = !!process.env.VERCEL_TOKEN;
-  let loggedIn = false;
-
-  if (hasToken) {
-    console.log(`✔ ${colors.green}VERCEL_TOKEN environment variable detected. Skipping login check.${colors.reset}`);
-    loggedIn = true;
-  } else {
-    try {
-      // Execute vercel whoami to check active session
-      const checkCmd = useNpx ? 'npx --yes vercel whoami' : 'vercel whoami';
-      execSync(checkCmd, { stdio: 'ignore', shell: true } as any);
-      loggedIn = true;
-      console.log(`✔ ${colors.green}Logged in!${colors.reset}`);
-    } catch {
-      loggedIn = false;
-    }
-  }
-
-  if (!loggedIn) {
-    console.log(`🔑 ${colors.yellow}Not logged in to Vercel.${colors.reset}`);
-    await askQuestion(`👉 Press [Enter] to login to Vercel... `);
-
-    const loginArgs = ['login'];
-    const loginCmd = useNpx ? 'npx' : 'vercel';
-    const finalArgs = useNpx ? ['--yes', 'vercel', ...loginArgs] : loginArgs;
-
-    const exitCode = await runCommandInteractive(loginCmd, finalArgs);
-    if (exitCode !== 0) {
-      throw new Error('Vercel login failed or was aborted.');
-    }
-    console.log(`\n✔ ${colors.green}Logged in successfully!${colors.reset}`);
-  }
-
-  // --- STEP 4: PRODUCTION DEPLOYMENT ---
-  console.log(`\n${colors.dim}Step 4/4: Deploying project to production...${colors.reset}`);
-  
-  const deployArgs = ['--prod', '--yes'];
-  if (hasToken) {
-    deployArgs.push('--token', process.env.VERCEL_TOKEN!);
-  }
-
-  const deployCmd = useNpx ? 'npx' : 'vercel';
-  const finalDeployArgs = useNpx ? ['--yes', 'vercel', ...deployArgs] : deployArgs;
-
-  console.log(`${colors.cyan}⚡ Running deployment in: ${process.cwd()}${colors.reset}\n`);
-
-  const deployExitCode = await runCommandInteractive(deployCmd, finalDeployArgs);
-  if (deployExitCode !== 0) {
-    throw new Error('Vercel deployment failed.');
-  }
-
-  console.log(`\n${colors.bold}${colors.green}🎉 Deployment completed successfully!${colors.reset}\n`);
-}

package/src/cli/index.ts

@@ -1,33 +0,0 @@
-#!/usr/bin/env node
-
-import { runDeployment } from './deploy';
-
-const args = process.argv.slice(2);
-const command = args[0];
-
-const colors = {
-  reset: '\x1b[0m',
-  bold: '\x1b[1m',
-  green: '\x1b[32m',
-  red: '\x1b[31m',
-  cyan: '\x1b[36m',
-  yellow: '\x1b[33m',
-};
-
-async function main() {
-  if (command === 'deploy') {
-    try {
-      await runDeployment();
-    } catch (error: any) {
-      console.error(`\n${colors.red}❌ Error: ${error.message || error}${colors.reset}`);
-      process.exit(1);
-    }
-  } else {
-    console.log(`\n${colors.bold}${colors.cyan}CFM SDK CLI Tool${colors.reset}`);
-    console.log(`\nUsage:`);
-    console.log(`  npx cfm-sdk deploy   - Deploy the current project to Vercel`);
-    process.exit(0);
-  }
-}
-
-main();

package/src/fetchSurvey/internalTypes.ts

@@ -1,80 +0,0 @@
-/**
- * Raw API option/answer detail received from the remote survey config service.
- */
-export type ApiAnswerDetail = {
-  // Option text label
-  answerText?: string;
-  // Whether the option should be hidden from UI render
-  hidden?: boolean;
-  // Additional metadata, such as hint/label flags for the scale boundaries
-  additional?: { isHintText?: boolean };
-  // Translations keyed by language code
-  translations?: Record<
-    string,
-    {
-      answerText?: string;
-    }
-  >;
-};
-
-/**
- * Raw API question model representing the survey structure returned by the remote service.
- */
-export type ApiQuestion = {
-  // Backend question unique ID
-  id?: string;
-  // Type identifier from API (e.g. "RATING", "SCALE", "TEXTFIELD", "MCQ")
-  answerType?: string;
-  // Primary text string for the question
-  questionText?: string;
-  // Rich HTML content representing the question text (fallback)
-  questionRichText?: string;
-  // List of answer options and scale hints
-  answerDetails?: ApiAnswerDetail[];
-  // Translations keyed by language code
-  translations?: Record<
-    string,
-    {
-      questionText?: string;
-      questionRichText?: string;
-    }
-  >;
-  // Configuration details for validation and other key-value settings
-  questionConfigs?: {
-    key: string;
-    value?: string[];
-    childConfigs?: {
-      key: string;
-      value?: string[];
-    }[];
-    translations?: Record<
-      string,
-      {
-        value?: string[];
-        valueRichText?: string[];
-      }
-    >;
-  }[];
-};
-
-/**
- * Root envelope returned by the remote survey API endpoint.
- */
-export type ApiResponse = {
-  // Unique distribution instance token/identifier
-  instanceId?: string;
-  // Localized survey language code
-  surveyLanguage?: string;
-  // Flat questions list if provided directly
-  questions?: ApiQuestion[];
-  // Multi-page survey page/question configurations
-  pages?: { questions?: ApiQuestion[] }[];
-  // Direct Data Transfer Object wrapping the full details from custom survey service
-  cfmSurveyDTO?: {
-    id?: string;
-    baseLanguage?: string;
-    surveyPages?: {
-      questionHolders?: { question?: ApiQuestion }[];
-    }[];
-  };
-};

package/src/fetchSurvey/logger/fetchLogger.ts

@@ -1,34 +0,0 @@
-import { sdkLogger } from '../../logger/logger';
-
-export function logFetchStart(url: string): void {
-  sdkLogger.info('Starting survey layout API fetch...', { url });
-}
-
-export function logFetchPerfFailure(durationMs: number, status: number | string, url: string): void {
-  sdkLogger.perf({
-    apiName: 'GET Survey Layout',
-    durationMs,
-    status,
-    url,
-    success: false,
-  });
-}
-
-export function logFetchPerfSuccess(durationMs: number, status: number, url: string, payloadSize: string): void {
-  sdkLogger.perf({
-    apiName: 'GET Survey Layout',
-    durationMs,
-    status,
-    url,
-    payloadSize,
-    success: true,
-  });
-}
-
-export function logFetchSuccess(apiResponse: any): void {
-  sdkLogger.success('Raw survey layout fetched successfully', apiResponse);
-}
-
-export function logFetchError(err: any): void {
-  sdkLogger.error('Failed to fetch raw survey layout', err);
-}

package/src/fetchSurvey/logger/mapperLogger.ts

@@ -1,13 +0,0 @@
-import { sdkLogger } from '../../logger/logger';
-
-export function logMapWarning(): void {
-  sdkLogger.warn('Cannot map survey: apiResponse is null or undefined');
-}
-
-export function logMapSuccess(mappedSurvey: any): void {
-  sdkLogger.success('Mapped survey layout successfully', mappedSurvey);
-}
-
-export function logMapError(err: any): void {
-  sdkLogger.error('Failed to map survey layout', err);
-}

package/src/fetchSurvey/telemetry/fetchTelemetry.ts

@@ -1,26 +0,0 @@
-import { trackEvent } from '../../analytics/analyticsTracker';
-
-export function trackFetchLatency(durationMs: number, status: number, url: string, payloadSize: string): void {
-  trackEvent({
-    eventName: 'survey_fetch_latency',
-    metadata: {
-      durationMs,
-      status,
-      success: true,
-      url,
-      payloadSize,
-    },
-  });
-}
-
-export function trackFetchError(status: number | string, url: string, errorMessage: string): void {
-  trackEvent({
-    eventName: 'api_error',
-    metadata: {
-      apiName: 'GET Survey Layout',
-      status,
-      url,
-      errorMessage,
-    },
-  });
-}

package/src/fetchSurvey/types.ts

@@ -1,82 +0,0 @@
-/**
- * Types representing survey option selections (e.g., choice options in a question).
- */
-export type SurveyOption = {
-  // The user-facing text for this option
-  label: string;
-  // The actual backend/value representation of this option
-  value: string | number;
-  // Optional background/text color associated with this option, used for ratings
-  color?: string;
-};
-
-/**
- * Types representing a processed question from the survey.
- */
-export type SurveyQuestion = {
-  // Unique identifier for the question
-  id: string;
-  // User-facing text or rich content of the question
-  text: string;
-  // The simplified input control/question type
-  type: 'rating' | 'radio' | 'text';
-  // The list of choices/options available to answer this question
-  options: SurveyOption[];
-  // Optional label representing the minimum bound (e.g., "Not Likely") for rating scales
-  minLabel?: string;
-  // Optional label representing the middle bound for rating scales
-  midLabel?: string;
-  // Optional label representing the maximum bound (e.g., "Extremely Likely") for rating scales
-  maxLabel?: string;
-  // Optional target index position for the middle label (e.g., 7.5)
-  midLabelIndex?: number;
-  // Optional max character count allowed for text input
-  maxCharacterCount?: number;
-  // Optional flag indicating if the question is required
-  required?: boolean;
-  // Optional custom error message when the required question is unanswered
-  requiredErrorMessage?: string;
-  // Optional placeholder text for text area inputs
-  placeholder?: string;
-};
-
-/**
- * Type representing a survey page.
- */
-export type SurveyPageData = {
-  // Unique identifier for the page
-  id: string;
-  // Optional page title
-  title?: string;
-  // List of questions on this page
-  questions: SurveyQuestion[];
-};
-
-export type SurveyLanguage = {
-  code: string;
-  name: string;
-};
-
-/**
- * Type representing the fully parsed and normalized Survey structure.
- */
-export type Survey = {
-  // Unique survey identifier
-  id: string;
-  // The locale/language string of this survey
-  language: string;
-  // All available languages in the survey
-  languages: SurveyLanguage[];
-  // The list of pages that form the survey
-  pages: SurveyPageData[];
-};
-
-/**
- * Type representing the session state for a survey response.
- */
-export type SurveySession = {
-  // The distribution/instance identifier from the survey configuration
-  instanceId: string;
-  // Language code of the active session
-  language: string;
-};