@fluentcommerce/fc-connect-sdk 0.1.54 → 0.1.56

package/docs/04-REFERENCE/testing/examples/fluent-testing.ts

@@ -1,62 +1,62 @@
-/**
- * Fluent Commerce API Testing Example
- *
- * This example demonstrates comprehensive Fluent API connectivity testing.
- */
-
-import { FluentConnectionTester, createClient } from '@fluentcommerce/fc-connect-sdk';
-
-async function testFluentConnectivity() {
-  console.log('=== Fluent Commerce API Testing ===\n');
-
-  // Create Fluent client
-  console.log('Creating Fluent client...');
-  const client = await createClient({
-    baseUrl: process.env.FLUENT_BASE_URL!,
-    clientId: process.env.FLUENT_CLIENT_ID!,
-    clientSecret: process.env.FLUENT_CLIENT_SECRET!,
-    username: process.env.FLUENT_USERNAME!,
-    password: process.env.FLUENT_PASSWORD!,
-    retailerId: process.env.FLUENT_RETAILER_ID!
-  });
-
-  // Configure tester
-  const tester = new FluentConnectionTester(
-    client,
-    {
-      retailerId: process.env.FLUENT_RETAILER_ID!,
-      logger: console
-    }
-  );
-
-  // Step 1: Test authentication
-  console.log('1. Testing authentication...');
-  const authResult = await tester.testConnection();
-  console.log(`   Authentication: ${authResult.success ? '✅' : '❌'}`);
-
-  if (!authResult.success) {
-    console.error('   Authentication failed, stopping tests');
-    return false;
-  }
-
-  // Step 2: Test connection (FluentConnectionTester only has testConnection())
-  console.log('\n2. Testing Fluent API connection...');
-  const result = await tester.testConnection();
-
-  if (result.success) {
-    console.log('✅ Connection test passed!');
-    console.log(`   Duration: ${result.duration}ms`);
-
-  return result.success;
-}
-
-// Run tests
-testFluentConnectivity()
-  .then(success => {
-    console.log('\nFluent API testing completed:', success ? '✅' : '❌');
-    process.exit(success ? 0 : 1);
-  })
-  .catch(error => {
-    console.error('\nTest execution failed:', error);
-    process.exit(1);
-  });
+/**
+ * Fluent Commerce API Testing Example
+ *
+ * This example demonstrates comprehensive Fluent API connectivity testing.
+ */
+
+import { FluentConnectionTester, createClient } from '@fluentcommerce/fc-connect-sdk';
+
+async function testFluentConnectivity() {
+  console.log('=== Fluent Commerce API Testing ===\n');
+
+  // Create Fluent client
+  console.log('Creating Fluent client...');
+  const client = await createClient({
+    baseUrl: process.env.FLUENT_BASE_URL!,
+    clientId: process.env.FLUENT_CLIENT_ID!,
+    clientSecret: process.env.FLUENT_CLIENT_SECRET!,
+    username: process.env.FLUENT_USERNAME!,
+    password: process.env.FLUENT_PASSWORD!,
+    retailerId: process.env.FLUENT_RETAILER_ID!
+  });
+
+  // Configure tester
+  const tester = new FluentConnectionTester(
+    client,
+    {
+      retailerId: process.env.FLUENT_RETAILER_ID!,
+      logger: console
+    }
+  );
+
+  // Step 1: Test authentication
+  console.log('1. Testing authentication...');
+  const authResult = await tester.testConnection();
+  console.log(`   Authentication: ${authResult.success ? '✅' : '❌'}`);
+
+  if (!authResult.success) {
+    console.error('   Authentication failed, stopping tests');
+    return false;
+  }
+
+  // Step 2: Test connection (FluentConnectionTester only has testConnection())
+  console.log('\n2. Testing Fluent API connection...');
+  const result = await tester.testConnection();
+
+  if (result.success) {
+    console.log('✅ Connection test passed!');
+    console.log(`   Duration: ${result.duration}ms`);
+
+  return result.success;
+}
+
+// Run tests
+testFluentConnectivity()
+  .then(success => {
+    console.log('\nFluent API testing completed:', success ? '✅' : '❌');
+    process.exit(success ? 0 : 1);
+  })
+  .catch(error => {
+    console.error('\nTest execution failed:', error);
+    process.exit(1);
+  });

package/docs/04-REFERENCE/testing/examples/health-check.ts

@@ -1,155 +1,155 @@
-/**
- * Health Check Endpoint Example
- *
- * This example demonstrates implementing health check endpoints for monitoring.
- * From Module 3: Fluent Testing
- */
-
-import { FluentConnectionTester, createClient } from '@fluentcommerce/fc-connect-sdk';
-
-// Basic health check function
-async function healthCheck() {
-  try {
-    // Create client
-    const client = await createClient({
-      baseUrl: process.env.FLUENT_BASE_URL!,
-      clientId: process.env.FLUENT_CLIENT_ID!,
-      clientSecret: process.env.FLUENT_CLIENT_SECRET!,
-      username: process.env.FLUENT_USERNAME!,
-      password: process.env.FLUENT_PASSWORD!,
-      retailerId: process.env.FLUENT_RETAILER_ID!
-    });
-
-    // Configure tester
-    const tester = new FluentConnectionTester(
-      client,
-      {
-        retailerId: process.env.FLUENT_RETAILER_ID!,
-        logger: console
-      }
-    );
-
-    // Run tests
-    const result = await tester.testConnection();
-
-    // Return health status
-    return {
-      status: result.success ? 'healthy' : 'unhealthy',
-      fluent: {
-        connected: result.success,
-        duration: result.duration
-      },
-      timestamp: new Date().toISOString()
-    };
-  } catch (error: any) {
-    return {
-      status: 'unhealthy',
-      error: error.message,
-      timestamp: new Date().toISOString()
-    };
-  }
-}
-
-// Detailed health check with progressive testing
-async function detailedHealthCheck() {
-  const checks: any = {
-    status: 'healthy',
-    checks: {
-      authentication: { status: 'pending' },
-      graphql: { status: 'pending' },
-      events: { status: 'pending' },
-      jobs: { status: 'pending' },
-      batches: { status: 'pending' }
-    },
-    timestamp: new Date().toISOString()
-  };
-
-  try {
-    const client = await createClient({
-      baseUrl: process.env.FLUENT_BASE_URL!,
-      clientId: process.env.FLUENT_CLIENT_ID!,
-      clientSecret: process.env.FLUENT_CLIENT_SECRET!,
-      username: process.env.FLUENT_USERNAME!,
-      password: process.env.FLUENT_PASSWORD!,
-      retailerId: process.env.FLUENT_RETAILER_ID!
-    });
-
-    const tester = new FluentConnectionTester(
-      client,
-      {
-        retailerId: process.env.FLUENT_RETAILER_ID!
-      }
-    );
-
-    // Test connection
-    const authResult = await tester.testConnection();
-    checks.checks.authentication = {
-      status: authResult.success ? 'healthy' : 'unhealthy',
-      duration: authResult.duration
-    };
-
-    if (!authResult.success) {
-      checks.status = 'unhealthy';
-      return checks;
-    }
-
-    // Note: FluentConnectionTester only has testConnection() method
-    // Individual endpoint tests (testGraphQLQuery, testEventCreation, etc.) don't exist
-    // Use testConnection() which tests the 'me' query
-
-    // Determine overall status
-    const allHealthy = Object.values(checks.checks).every((c: any) => c.status === 'healthy');
-    const anyUnhealthy = Object.values(checks.checks).some((c: any) => c.status === 'unhealthy');
-
-    checks.status = anyUnhealthy ? 'unhealthy' : allHealthy ? 'healthy' : 'degraded';
-  } catch (error: any) {
-    checks.status = 'unhealthy';
-    checks.error = error.message;
-  }
-
-  return checks;
-}
-
-// Express.js example
-function createExpressHealthEndpoints() {
-  const express = require('express');
-  const app = express();
-
-  // Basic health check
-  app.get('/health', async (req, res) => {
-    const health = await healthCheck();
-    const statusCode = health.status === 'healthy' ? 200 : 503;
-    res.status(statusCode).json(health);
-  });
-
-  // Detailed health check
-  app.get('/health/detailed', async (req, res) => {
-    const health = await detailedHealthCheck();
-    const statusCode = health.status === 'healthy' ? 200 :
-                       health.status === 'degraded' ? 200 : 503;
-    res.status(statusCode).json(health);
-  });
-
-  app.listen(3000, () => {
-    console.log('Health check server running on port 3000');
-    console.log('  Basic: http://localhost:3000/health');
-    console.log('  Detailed: http://localhost:3000/health/detailed');
-  });
-}
-
-// Run health check
-if (require.main === module) {
-  // Command-line usage
-  detailedHealthCheck()
-    .then(health => {
-      console.log(JSON.stringify(health, null, 2));
-      process.exit(health.status === 'healthy' ? 0 : 1);
-    })
-    .catch(error => {
-      console.error('Health check failed:', error);
-      process.exit(1);
-    });
-}
-
-// Export for use in other modules
-export { healthCheck, detailedHealthCheck, createExpressHealthEndpoints };
+/**
+ * Health Check Endpoint Example
+ *
+ * This example demonstrates implementing health check endpoints for monitoring.
+ * From Module 3: Fluent Testing
+ */
+
+import { FluentConnectionTester, createClient } from '@fluentcommerce/fc-connect-sdk';
+
+// Basic health check function
+async function healthCheck() {
+  try {
+    // Create client
+    const client = await createClient({
+      baseUrl: process.env.FLUENT_BASE_URL!,
+      clientId: process.env.FLUENT_CLIENT_ID!,
+      clientSecret: process.env.FLUENT_CLIENT_SECRET!,
+      username: process.env.FLUENT_USERNAME!,
+      password: process.env.FLUENT_PASSWORD!,
+      retailerId: process.env.FLUENT_RETAILER_ID!
+    });
+
+    // Configure tester
+    const tester = new FluentConnectionTester(
+      client,
+      {
+        retailerId: process.env.FLUENT_RETAILER_ID!,
+        logger: console
+      }
+    );
+
+    // Run tests
+    const result = await tester.testConnection();
+
+    // Return health status
+    return {
+      status: result.success ? 'healthy' : 'unhealthy',
+      fluent: {
+        connected: result.success,
+        duration: result.duration
+      },
+      timestamp: new Date().toISOString()
+    };
+  } catch (error: any) {
+    return {
+      status: 'unhealthy',
+      error: error.message,
+      timestamp: new Date().toISOString()
+    };
+  }
+}
+
+// Detailed health check with progressive testing
+async function detailedHealthCheck() {
+  const checks: any = {
+    status: 'healthy',
+    checks: {
+      authentication: { status: 'pending' },
+      graphql: { status: 'pending' },
+      events: { status: 'pending' },
+      jobs: { status: 'pending' },
+      batches: { status: 'pending' }
+    },
+    timestamp: new Date().toISOString()
+  };
+
+  try {
+    const client = await createClient({
+      baseUrl: process.env.FLUENT_BASE_URL!,
+      clientId: process.env.FLUENT_CLIENT_ID!,
+      clientSecret: process.env.FLUENT_CLIENT_SECRET!,
+      username: process.env.FLUENT_USERNAME!,
+      password: process.env.FLUENT_PASSWORD!,
+      retailerId: process.env.FLUENT_RETAILER_ID!
+    });
+
+    const tester = new FluentConnectionTester(
+      client,
+      {
+        retailerId: process.env.FLUENT_RETAILER_ID!
+      }
+    );
+
+    // Test connection
+    const authResult = await tester.testConnection();
+    checks.checks.authentication = {
+      status: authResult.success ? 'healthy' : 'unhealthy',
+      duration: authResult.duration
+    };
+
+    if (!authResult.success) {
+      checks.status = 'unhealthy';
+      return checks;
+    }
+
+    // Note: FluentConnectionTester only has testConnection() method
+    // Individual endpoint tests (testGraphQLQuery, testEventCreation, etc.) don't exist
+    // Use testConnection() which tests the 'me' query
+
+    // Determine overall status
+    const allHealthy = Object.values(checks.checks).every((c: any) => c.status === 'healthy');
+    const anyUnhealthy = Object.values(checks.checks).some((c: any) => c.status === 'unhealthy');
+
+    checks.status = anyUnhealthy ? 'unhealthy' : allHealthy ? 'healthy' : 'degraded';
+  } catch (error: any) {
+    checks.status = 'unhealthy';
+    checks.error = error.message;
+  }
+
+  return checks;
+}
+
+// Express.js example
+function createExpressHealthEndpoints() {
+  const express = require('express');
+  const app = express();
+
+  // Basic health check
+  app.get('/health', async (req, res) => {
+    const health = await healthCheck();
+    const statusCode = health.status === 'healthy' ? 200 : 503;
+    res.status(statusCode).json(health);
+  });
+
+  // Detailed health check
+  app.get('/health/detailed', async (req, res) => {
+    const health = await detailedHealthCheck();
+    const statusCode = health.status === 'healthy' ? 200 :
+                       health.status === 'degraded' ? 200 : 503;
+    res.status(statusCode).json(health);
+  });
+
+  app.listen(3000, () => {
+    console.log('Health check server running on port 3000');
+    console.log('  Basic: http://localhost:3000/health');
+    console.log('  Detailed: http://localhost:3000/health/detailed');
+  });
+}
+
+// Run health check
+if (require.main === module) {
+  // Command-line usage
+  detailedHealthCheck()
+    .then(health => {
+      console.log(JSON.stringify(health, null, 2));
+      process.exit(health.status === 'healthy' ? 0 : 1);
+    })
+    .catch(error => {
+      console.error('Health check failed:', error);
+      process.exit(1);
+    });
+}
+
+// Export for use in other modules
+export { healthCheck, detailedHealthCheck, createExpressHealthEndpoints };

package/docs/04-REFERENCE/testing/examples/integration-test.ts

@@ -1,119 +1,119 @@
-/**
- * End-to-End Integration Test Example
- *
- * This example demonstrates a complete ingestion pipeline test from S3 to Fluent Commerce.
- * From Module 4: Integration Testing
- */
-
-import {
-  S3SDKTester,
-  FluentConnectionTester,
-  IngestionService,
-  createClient
-} from '@fluentcommerce/fc-connect-sdk';
-
-async function testIngestionPipeline() {
-  console.log('=== End-to-End Ingestion Test ===\n');
-
-  // Step 1: Test S3 connectivity
-  console.log('Step 1: Testing S3 connectivity...');
-  const s3Tester = new S3SDKTester({
-    accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
-    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
-    region: process.env.AWS_REGION || 'us-east-1',
-  });
-
-  const s3Result = await s3Tester.testAll(process.env.TEST_BUCKET!);
-  if (s3Result.summary.failed > 0) {
-    throw new Error('S3 connectivity test failed');
-  }
-  console.log('✅ S3 connectivity validated\n');
-
-  // Step 2: Test Fluent connectivity
-  console.log('Step 2: Testing Fluent API connectivity...');
-  const client = await createClient({
-    baseUrl: process.env.FLUENT_BASE_URL!,
-    clientId: process.env.FLUENT_CLIENT_ID!,
-    clientSecret: process.env.FLUENT_CLIENT_SECRET!,
-    username: process.env.FLUENT_USERNAME!,
-    password: process.env.FLUENT_PASSWORD!,
-    retailerId: process.env.FLUENT_RETAILER_ID!
-  });
-
-  const fluentTester = new FluentConnectionTester(
-    client,
-    {
-      retailerId: process.env.FLUENT_RETAILER_ID!,
-      logger: console
-    }
-  );
-
-  const fluentResult = await fluentTester.testConnection();
-  if (!fluentResult.success) {
-    throw new Error('Fluent connectivity test failed');
-  }
-  console.log('✅ Fluent API connectivity validated\n');
-
-  // Step 3: Upload test data to S3
-  console.log('Step 3: Uploading test inventory data...');
-  const testData = 'SKU,QTY,LOCATION\nTEST001,100,DC01\nTEST002,50,DC02\nTEST003,75,DC01';
-  await s3Tester.testWithFile('test-inventory.csv', testData);
-  console.log('✅ Test data uploaded\n');
-
-  // Step 4: Run ingestion
-  console.log('Step 4: Running ingestion service...');
-  const ingestionService = new IngestionService({
-    logger: console
-  });
-
-  const ingestionResult = await ingestionService.execute({
-    sourceType: 'S3',
-    s3Config: {
-      bucket: process.env.TEST_BUCKET!,
-      key: 'test-inventory.csv',
-      region: process.env.AWS_REGION || 'us-east-1',
-      accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
-      secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!
-    },
-    fieldMappings: [
-      { source: 'SKU', target: 'ref' },
-      { source: 'QTY', target: 'qty', transform: 'number' },
-      { source: 'LOCATION', target: 'locationRef' }
-    ],
-    client
-  });
-
-  // Step 5: Verify results
-  console.log('\nStep 5: Verifying ingestion results...');
-  if (ingestionResult.success) {
-    console.log('✅ End-to-end test passed!');
-    console.log(`   Records processed: ${ingestionResult.processedCount}`);
-    console.log(`   Duration: ${ingestionResult.duration}ms`);
-  } else {
-    console.error('❌ Ingestion failed:', ingestionResult.errors);
-  }
-
-  // Step 6: Cleanup
-  console.log('\nStep 6: Cleaning up test data...');
-  await s3Tester.cleanup();
-  console.log('✅ Cleanup complete');
-
-  // Summary
-  console.log('\n=== Test Summary ===');
-  console.log(`S3 Connectivity: ✅`);
-  console.log(`Fluent Connectivity: ✅`);
-  console.log(`Ingestion: ${ingestionResult.success ? '✅' : '❌'}`);
-
-  return ingestionResult;
-}
-
-// Run test
-testIngestionPipeline()
-  .then(result => {
-    console.log('\nIntegration test completed:', result.success ? '✅' : '❌');
-    process.exit(result.success ? 0 : 1);
-  })
-  .catch(error => {
-    console.error('\nIntegration test failed:', error);
-    process.exit(1);
-  });
+/**
+ * End-to-End Integration Test Example
+ *
+ * This example demonstrates a complete ingestion pipeline test from S3 to Fluent Commerce.
+ * From Module 4: Integration Testing
+ */
+
+import {
+  S3SDKTester,
+  FluentConnectionTester,
+  IngestionService,
+  createClient
+} from '@fluentcommerce/fc-connect-sdk';
+
+async function testIngestionPipeline() {
+  console.log('=== End-to-End Ingestion Test ===\n');
+
+  // Step 1: Test S3 connectivity
+  console.log('Step 1: Testing S3 connectivity...');
+  const s3Tester = new S3SDKTester({
+    accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
+    secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!,
+    region: process.env.AWS_REGION || 'us-east-1',
+  });
+
+  const s3Result = await s3Tester.testAll(process.env.TEST_BUCKET!);
+  if (s3Result.summary.failed > 0) {
+    throw new Error('S3 connectivity test failed');
+  }
+  console.log('✅ S3 connectivity validated\n');
+
+  // Step 2: Test Fluent connectivity
+  console.log('Step 2: Testing Fluent API connectivity...');
+  const client = await createClient({
+    baseUrl: process.env.FLUENT_BASE_URL!,
+    clientId: process.env.FLUENT_CLIENT_ID!,
+    clientSecret: process.env.FLUENT_CLIENT_SECRET!,
+    username: process.env.FLUENT_USERNAME!,
+    password: process.env.FLUENT_PASSWORD!,
+    retailerId: process.env.FLUENT_RETAILER_ID!
+  });
+
+  const fluentTester = new FluentConnectionTester(
+    client,
+    {
+      retailerId: process.env.FLUENT_RETAILER_ID!,
+      logger: console
+    }
+  );
+
+  const fluentResult = await fluentTester.testConnection();
+  if (!fluentResult.success) {
+    throw new Error('Fluent connectivity test failed');
+  }
+  console.log('✅ Fluent API connectivity validated\n');
+
+  // Step 3: Upload test data to S3
+  console.log('Step 3: Uploading test inventory data...');
+  const testData = 'SKU,QTY,LOCATION\nTEST001,100,DC01\nTEST002,50,DC02\nTEST003,75,DC01';
+  await s3Tester.testWithFile('test-inventory.csv', testData);
+  console.log('✅ Test data uploaded\n');
+
+  // Step 4: Run ingestion
+  console.log('Step 4: Running ingestion service...');
+  const ingestionService = new IngestionService({
+    logger: console
+  });
+
+  const ingestionResult = await ingestionService.execute({
+    sourceType: 'S3',
+    s3Config: {
+      bucket: process.env.TEST_BUCKET!,
+      key: 'test-inventory.csv',
+      region: process.env.AWS_REGION || 'us-east-1',
+      accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
+      secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY!
+    },
+    fieldMappings: [
+      { source: 'SKU', target: 'ref' },
+      { source: 'QTY', target: 'qty', transform: 'number' },
+      { source: 'LOCATION', target: 'locationRef' }
+    ],
+    client
+  });
+
+  // Step 5: Verify results
+  console.log('\nStep 5: Verifying ingestion results...');
+  if (ingestionResult.success) {
+    console.log('✅ End-to-end test passed!');
+    console.log(`   Records processed: ${ingestionResult.processedCount}`);
+    console.log(`   Duration: ${ingestionResult.duration}ms`);
+  } else {
+    console.error('❌ Ingestion failed:', ingestionResult.errors);
+  }
+
+  // Step 6: Cleanup
+  console.log('\nStep 6: Cleaning up test data...');
+  await s3Tester.cleanup();
+  console.log('✅ Cleanup complete');
+
+  // Summary
+  console.log('\n=== Test Summary ===');
+  console.log(`S3 Connectivity: ✅`);
+  console.log(`Fluent Connectivity: ✅`);
+  console.log(`Ingestion: ${ingestionResult.success ? '✅' : '❌'}`);
+
+  return ingestionResult;
+}
+
+// Run test
+testIngestionPipeline()
+  .then(result => {
+    console.log('\nIntegration test completed:', result.success ? '✅' : '❌');
+    process.exit(result.success ? 0 : 1);
+  })
+  .catch(error => {
+    console.error('\nIntegration test failed:', error);
+    process.exit(1);
+  });