@fluentcommerce/fc-connect-sdk 0.1.54 → 0.1.56

package/docs/04-REFERENCE/schema/readme.md

@@ -1,141 +1,141 @@
-# Schema Reference
-
-> **Fluent Commerce GraphQL schema reference**
-> Complete schema documentation and validation guide
-
-## Overview
-
-This directory contains the Fluent Commerce GraphQL schema and validation utilities. Use these resources to validate your queries and mutations before deployment.
-
-## Schema Files
-
-| File | Description | Use Case |
-|------|-------------|----------|
-| `fluent-commerce-schema.json` | Complete GraphQL schema | Query validation, field discovery |
-
-## Schema Introspection
-
-### Introspect Your Schema
-
-```bash
-# Using SDK CLI tool
-npx @fluentcommerce/fc-connect-sdk introspect-schema \
-  --url https://YOUR_ACCOUNT.api.fluentcommerce.com/graphql \
-  --output schema.json
-```
-
-### Validate Queries
-
-```bash
-# Validate a GraphQL query
-npx @fluentcommerce/fc-connect-sdk validate-query \
-  --query query.graphql \
-  --schema schema.json
-```
-
-## Common Validation Errors
-
-### Wrong Field Names
-
-```typescript
-// ❌ WRONG - Field name doesn't exist
-query {
-  inventoryPositions(first: 10) {
-    edges {
-      node {
-        stockLevel  // ❌ Field doesn't exist
-      }
-    }
-  }
-}
-
-// ✅ CORRECT - Use schema-validated field
-query {
-  inventoryPositions(first: 10) {
-    edges {
-      node {
-        onHand  // ✅ Correct field name
-      }
-    }
-  }
-}
-```
-
-### Field Type Mismatch
-
-```typescript
-// ❌ WRONG - VirtualPosition uses 'quantity', not 'onHand'
-query {
-  virtualPositions(first: 10) {
-    edges {
-      node {
-        onHand  // ❌ Wrong field for VirtualPosition
-      }
-    }
-  }
-}
-
-// ✅ CORRECT - VirtualPosition field
-query {
-  virtualPositions(first: 10) {
-    edges {
-      node {
-        quantity  // ✅ Correct for VirtualPosition
-      }
-    }
-  }
-}
-```
-
-## Entity Field Differences
-
-**Critical:** Different entities have different field names!
-
-| Entity | Quantity Field | Reference Field |
-|--------|---------------|----------------|
-| **InventoryPosition** | `onHand` (Int!), `qty` (Int!) | `ref` (String!) |
-| **VirtualPosition** | `quantity` (Int!) | `ref` (String!) |
-| **InventoryQuantity** | `qty` (Int!) | `articleRef` (String!) |
-
-## Using the Schema
-
-### In SDK Code
-
-```typescript
-// All SDK examples use validated schema fields
-const result = await client.graphql({
-  query: `
-    query GetInventory($first: Int!, $after: String) {
-      inventoryPositions(first: $first, after: $after) {
-        edges {
-          node {
-            id
-            ref
-            productRef
-            locationRef
-            onHand      # ✅ Schema-validated field
-            qty         # ✅ Schema-validated field
-          }
-          cursor
-        }
-        pageInfo { hasNextPage }
-      }
-    }
-  `,
-  variables: { first: 100 }
-});
-```
-
-## Related Documentation
-
-- [Auto-Pagination](../../02-CORE-GUIDES/auto-pagination/) - Pagination with schema validation
-- [Extraction Guide](../../02-CORE-GUIDES/extraction/) - Schema-validated extraction queries
-- [Mapping Guide](../../02-CORE-GUIDES/mapping/) - Field mapping with schema validation
-
-## Support
-
-Need schema help?
-- Introspect your schema first
-- Validate queries before deployment
-- Check entity-specific field names
-- Contact support@fluentcommerce.com
+# Schema Reference
+
+> **Fluent Commerce GraphQL schema reference**
+> Complete schema documentation and validation guide
+
+## Overview
+
+This directory contains the Fluent Commerce GraphQL schema and validation utilities. Use these resources to validate your queries and mutations before deployment.
+
+## Schema Files
+
+| File | Description | Use Case |
+|------|-------------|----------|
+| `fluent-commerce-schema.json` | Complete GraphQL schema | Query validation, field discovery |
+
+## Schema Introspection
+
+### Introspect Your Schema
+
+```bash
+# Using SDK CLI tool
+npx @fluentcommerce/fc-connect-sdk introspect-schema \
+  --url https://YOUR_ACCOUNT.api.fluentcommerce.com/graphql \
+  --output schema.json
+```
+
+### Validate Queries
+
+```bash
+# Validate a GraphQL query
+npx @fluentcommerce/fc-connect-sdk validate-query \
+  --query query.graphql \
+  --schema schema.json
+```
+
+## Common Validation Errors
+
+### Wrong Field Names
+
+```typescript
+// ❌ WRONG - Field name doesn't exist
+query {
+  inventoryPositions(first: 10) {
+    edges {
+      node {
+        stockLevel  // ❌ Field doesn't exist
+      }
+    }
+  }
+}
+
+// ✅ CORRECT - Use schema-validated field
+query {
+  inventoryPositions(first: 10) {
+    edges {
+      node {
+        onHand  // ✅ Correct field name
+      }
+    }
+  }
+}
+```
+
+### Field Type Mismatch
+
+```typescript
+// ❌ WRONG - VirtualPosition uses 'quantity', not 'onHand'
+query {
+  virtualPositions(first: 10) {
+    edges {
+      node {
+        onHand  // ❌ Wrong field for VirtualPosition
+      }
+    }
+  }
+}
+
+// ✅ CORRECT - VirtualPosition field
+query {
+  virtualPositions(first: 10) {
+    edges {
+      node {
+        quantity  // ✅ Correct for VirtualPosition
+      }
+    }
+  }
+}
+```
+
+## Entity Field Differences
+
+**Critical:** Different entities have different field names!
+
+| Entity | Quantity Field | Reference Field |
+|--------|---------------|----------------|
+| **InventoryPosition** | `onHand` (Int!), `qty` (Int!) | `ref` (String!) |
+| **VirtualPosition** | `quantity` (Int!) | `ref` (String!) |
+| **InventoryQuantity** | `qty` (Int!) | `articleRef` (String!) |
+
+## Using the Schema
+
+### In SDK Code
+
+```typescript
+// All SDK examples use validated schema fields
+const result = await client.graphql({
+  query: `
+    query GetInventory($first: Int!, $after: String) {
+      inventoryPositions(first: $first, after: $after) {
+        edges {
+          node {
+            id
+            ref
+            productRef
+            locationRef
+            onHand      # ✅ Schema-validated field
+            qty         # ✅ Schema-validated field
+          }
+          cursor
+        }
+        pageInfo { hasNextPage }
+      }
+    }
+  `,
+  variables: { first: 100 }
+});
+```
+
+## Related Documentation
+
+- [Auto-Pagination](../../02-CORE-GUIDES/auto-pagination/) - Pagination with schema validation
+- [Extraction Guide](../../02-CORE-GUIDES/extraction/) - Schema-validated extraction queries
+- [Mapping Guide](../../02-CORE-GUIDES/mapping/) - Field mapping with schema validation
+
+## Support
+
+Need schema help?
+- Introspect your schema first
+- Validate queries before deployment
+- Check entity-specific field names
+- Contact support@fluentcommerce.com

package/docs/04-REFERENCE/testing/examples/04-reference-testing-readme.md

@@ -1,158 +1,158 @@
-# Testing Examples
-
-Complete, runnable examples for all testing utilities.
-
-## Available Examples
-
-| Example | Description | Complexity | Module |
-|---------|-------------|------------|--------|
-| [s3-testing.ts](./s3-testing.ts) | Complete S3 testing with all three testers | Medium | [Module 2](../modules/04-reference-testing-02-s3-testing.md) |
-| [fluent-testing.ts](./fluent-testing.ts) | Fluent API connectivity testing | Simple | [Module 3](../modules/04-reference-testing-03-fluent-testing.md) |
-| [integration-test.ts](./integration-test.ts) | End-to-end ingestion pipeline test | Complex | [Module 4](../modules/04-reference-testing-04-integration-testing.md) |
-| [performance-test.ts](./performance-test.ts) | Load testing S3 and Fluent operations | Medium | [Module 4](../modules/04-reference-testing-04-integration-testing.md) |
-| [health-check.ts](./health-check.ts) | Health check endpoint implementation | Simple | [Module 3](../modules/04-reference-testing-03-fluent-testing.md) |
-
-## Running Examples
-
-### Prerequisites
-
-1. Install dependencies:
-```bash
-npm install @fluentcommerce/fc-connect-sdk
-```
-
-2. Set environment variables (copy from `.env.example`):
-```bash
-# AWS
-export AWS_ACCESS_KEY_ID=xxx
-export AWS_SECRET_ACCESS_KEY=yyy
-export AWS_REGION=us-east-1
-export TEST_BUCKET=test-bucket
-
-# Fluent Commerce
-export FLUENT_BASE_URL=https://api.fluentcommerce.com
-export FLUENT_CLIENT_ID=xxx
-export FLUENT_CLIENT_SECRET=yyy
-export FLUENT_USERNAME=user
-export FLUENT_PASSWORD=pass
-export FLUENT_RETAILER_ID=1
-```
-
-### Run Individual Examples
-
-```bash
-# S3 testing
-npx ts-node examples/s3-testing.ts
-
-# Fluent testing
-npx ts-node examples/fluent-testing.ts
-
-# Integration test
-npx ts-node examples/integration-test.ts
-
-# Performance test
-npx ts-node examples/performance-test.ts
-
-# Health check
-npx ts-node examples/health-check.ts
-```
-
-## Example Output
-
-### Successful Test Output
-
-```
-Testing S3 connectivity...
-✅ All S3 SDK tests passed!
-Test duration: 1234 ms
-
-Testing Fluent API connectivity...
-✅ Fluent Commerce connection validated!
-API Version: 2.0
-Retailer: 1
-```
-
-### Failed Test Output
-
-```
-Testing S3 connectivity...
-❌ S3 SDK tests failed:
-  - AccessDenied: Access Denied for bucket 'test-bucket'
-  - Check IAM permissions for s3:GetObject
-```
-
-## Common Use Cases
-
-### 1. Pre-Deployment Validation
-
-Use `integration-test.ts` before deploying:
-```bash
-npm run test:integration || exit 1  # Fail deployment if tests fail
-```
-
-### 2. Health Monitoring
-
-Use `health-check.ts` in production:
-```bash
-# Add to cron or monitoring system
-*/5 * * * * node examples/health-check.ts >> /var/log/health.log
-```
-
-### 3. Performance Baseline
-
-Use `performance-test.ts` to establish baselines:
-```bash
-# Run monthly to track performance trends
-node examples/performance-test.ts > performance-$(date +%Y-%m).json
-```
-
-## Modifying Examples
-
-All examples are self-contained and can be modified:
-
-```typescript
-// Customize S3 testing
-const tester = new S3SDKTester({
-  accessKeyId: process.env.AWS_ACCESS_KEY_ID,
-  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
-  region: 'us-east-1'
-  // Note: testAll() always tests all operations - no filtering option
-});
-
-// Customize Fluent testing
-const tester = new FluentConnectionTester(
-  client,
-  {
-    retailerId: '1'
-  }
-);
-```
-
-## Troubleshooting Examples
-
-If examples fail, check:
-
-1. **Environment variables are set:**
-   ```bash
-   env | grep -E '(AWS|FLUENT)'
-   ```
-
-2. **Network connectivity:**
-   ```bash
-   curl https://api.fluentcommerce.com
-   ```
-
-3. **Credentials are valid:**
-   ```bash
-   aws s3 ls s3://test-bucket  # Test AWS credentials
-   ```
-
-## Additional Resources
-
-- [Quick Reference](../../../02-CORE-GUIDES/advanced-services/advanced-services-quick-reference.md) - Cheat sheet
-- [Module 5: Debugging](../modules/04-reference-testing-05-debugging.md) - Troubleshooting guide
-- [Module 7: Best Practices](../modules/04-reference-testing-07-best-practices.md) - Testing strategies
-
----
-
-**Need Help?** See [Module 5: Debugging](../modules/04-reference-testing-05-debugging.md) for troubleshooting techniques.
+# Testing Examples
+
+Complete, runnable examples for all testing utilities.
+
+## Available Examples
+
+| Example | Description | Complexity | Module |
+|---------|-------------|------------|--------|
+| [s3-testing.ts](./s3-testing.ts) | Complete S3 testing with all three testers | Medium | [Module 2](../modules/04-reference-testing-02-s3-testing.md) |
+| [fluent-testing.ts](./fluent-testing.ts) | Fluent API connectivity testing | Simple | [Module 3](../modules/04-reference-testing-03-fluent-testing.md) |
+| [integration-test.ts](./integration-test.ts) | End-to-end ingestion pipeline test | Complex | [Module 4](../modules/04-reference-testing-04-integration-testing.md) |
+| [performance-test.ts](./performance-test.ts) | Load testing S3 and Fluent operations | Medium | [Module 4](../modules/04-reference-testing-04-integration-testing.md) |
+| [health-check.ts](./health-check.ts) | Health check endpoint implementation | Simple | [Module 3](../modules/04-reference-testing-03-fluent-testing.md) |
+
+## Running Examples
+
+### Prerequisites
+
+1. Install dependencies:
+```bash
+npm install @fluentcommerce/fc-connect-sdk
+```
+
+2. Set environment variables (copy from `.env.example`):
+```bash
+# AWS
+export AWS_ACCESS_KEY_ID=xxx
+export AWS_SECRET_ACCESS_KEY=yyy
+export AWS_REGION=us-east-1
+export TEST_BUCKET=test-bucket
+
+# Fluent Commerce
+export FLUENT_BASE_URL=https://api.fluentcommerce.com
+export FLUENT_CLIENT_ID=xxx
+export FLUENT_CLIENT_SECRET=yyy
+export FLUENT_USERNAME=user
+export FLUENT_PASSWORD=pass
+export FLUENT_RETAILER_ID=1
+```
+
+### Run Individual Examples
+
+```bash
+# S3 testing
+npx ts-node examples/s3-testing.ts
+
+# Fluent testing
+npx ts-node examples/fluent-testing.ts
+
+# Integration test
+npx ts-node examples/integration-test.ts
+
+# Performance test
+npx ts-node examples/performance-test.ts
+
+# Health check
+npx ts-node examples/health-check.ts
+```
+
+## Example Output
+
+### Successful Test Output
+
+```
+Testing S3 connectivity...
+✅ All S3 SDK tests passed!
+Test duration: 1234 ms
+
+Testing Fluent API connectivity...
+✅ Fluent Commerce connection validated!
+API Version: 2.0
+Retailer: 1
+```
+
+### Failed Test Output
+
+```
+Testing S3 connectivity...
+❌ S3 SDK tests failed:
+  - AccessDenied: Access Denied for bucket 'test-bucket'
+  - Check IAM permissions for s3:GetObject
+```
+
+## Common Use Cases
+
+### 1. Pre-Deployment Validation
+
+Use `integration-test.ts` before deploying:
+```bash
+npm run test:integration || exit 1  # Fail deployment if tests fail
+```
+
+### 2. Health Monitoring
+
+Use `health-check.ts` in production:
+```bash
+# Add to cron or monitoring system
+*/5 * * * * node examples/health-check.ts >> /var/log/health.log
+```
+
+### 3. Performance Baseline
+
+Use `performance-test.ts` to establish baselines:
+```bash
+# Run monthly to track performance trends
+node examples/performance-test.ts > performance-$(date +%Y-%m).json
+```
+
+## Modifying Examples
+
+All examples are self-contained and can be modified:
+
+```typescript
+// Customize S3 testing
+const tester = new S3SDKTester({
+  accessKeyId: process.env.AWS_ACCESS_KEY_ID,
+  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
+  region: 'us-east-1'
+  // Note: testAll() always tests all operations - no filtering option
+});
+
+// Customize Fluent testing
+const tester = new FluentConnectionTester(
+  client,
+  {
+    retailerId: '1'
+  }
+);
+```
+
+## Troubleshooting Examples
+
+If examples fail, check:
+
+1. **Environment variables are set:**
+   ```bash
+   env | grep -E '(AWS|FLUENT)'
+   ```
+
+2. **Network connectivity:**
+   ```bash
+   curl https://api.fluentcommerce.com
+   ```
+
+3. **Credentials are valid:**
+   ```bash
+   aws s3 ls s3://test-bucket  # Test AWS credentials
+   ```
+
+## Additional Resources
+
+- [Quick Reference](../../../02-CORE-GUIDES/advanced-services/advanced-services-quick-reference.md) - Cheat sheet
+- [Module 5: Debugging](../modules/04-reference-testing-05-debugging.md) - Troubleshooting guide
+- [Module 7: Best Practices](../modules/04-reference-testing-07-best-practices.md) - Testing strategies
+
+---
+
+**Need Help?** See [Module 5: Debugging](../modules/04-reference-testing-05-debugging.md) for troubleshooting techniques.