@fluentcommerce/fc-connect-sdk 0.1.54 → 0.1.56

package/docs/04-REFERENCE/platforms/versori/readme.md

@@ -1,108 +1,108 @@
-# Versori Platform Guide
-
-> **Complete guide for deploying FC Connect SDK on Versori platform**
-> Versori-specific patterns, KV storage, connections, and best practices
-
-For complete documentation, see [platforms-versori-readme.md](./platforms-versori-readme.md)
-
-## Overview
-
-The FC Connect SDK is fully optimized for the Versori integration platform. This guide covers Versori-specific features, patterns, and best practices.
-
-## Navigation
-
-- [Complete Documentation](./platforms-versori-readme.md) - Full Versori guide
-- [Modules](./modules/) - Progressive learning modules
-- [Quick References](.) - Multiple quick reference guides
-
-## Key Features
-
-### Context API
-
-Access Versori platform features through context:
-
-```typescript
-import { schedule } from '@versori/run';
-import { Buffer } from 'node:buffer'; // Always required!
-
-export const task = schedule('task', '0 2 * * *', async (ctx) => {
-  const { log, connections, openKv, secrets } = ctx;
-
-  // Use Versori logger
-  log.info('Starting task');
-
-  // Access connections
-  const fluentConnection = connections['fluent'];
-
-  // Use KV storage
-  const kv = openKv(':project:');
-  await kv.set(['key'], 'value');
-});
-```
-
-### KV Storage
-
-State management with Versori KV:
-
-```typescript
-const kv = openKv(':project:');
-
-// Check if file processed
-const processed = await kv.get(['files', fileName]);
-if (processed.value) {
-  return; // Skip duplicate
-}
-
-// Mark as processed
-await kv.set(['files', fileName], { processed: true, timestamp: Date.now() });
-```
-
-### Connection Management
-
-Pre-configured connections in Versori UI:
-
-```typescript
-// Connections are injected via context
-const client = await createClient({ ...ctx, log });
-```
-
-## Learning Path
-
-| Module | Topic | Level |
-|--------|-------|-------|
-| [Module 1](./modules/platforms-versori-01-introduction.md) | Introduction | Beginner |
-| [Module 2](./modules/platforms-versori-02-quick-start.md) | Quick Start | Beginner |
-| [Module 3](./modules/platforms-versori-03-authentication.md) | Authentication | Intermediate |
-| [Module 4](./modules/platforms-versori-04-workflows.md) | Workflows | Intermediate |
-| [Module 5](./modules/platforms-versori-05-connections.md) | Connections | Intermediate |
-| [Module 6](./modules/platforms-versori-06-kv-storage.md) | KV Storage | Intermediate |
-| [Module 7](./modules/platforms-versori-07-deployment.md) | Deployment | Intermediate |
-| [Module 8](./modules/platforms-versori-08-best-practices.md) | Best Practices | All Levels |
-| [Module 9](./modules/platforms-versori-09-signature-reference.md) | Signature Reference | Reference |
-
-## Quick References
-
-- [Quick Reference](./platforms-versori-readme.md) - Complete guide
-- [Webhook Auth](./platforms-versori-webhook-auth-quick-reference.md) - Webhook authentication patterns
-- [S3/SFTP Configuration](./platforms-versori-s3-sftp-configuration-guide.md) - Data source setup
-- [Workflow Task Types](./platforms-versori-workflow-task-types.md) - Webhook vs scheduled workflows
-
-## Critical: Buffer Import
-
-Always import Buffer in Versori runtime:
-
-```typescript
-// ✅ CORRECT
-import { Buffer } from 'node:buffer';
-
-// ❌ WRONG - Runtime error
-const content = Buffer.from(xmlString); // Buffer is not defined
-```
-
-## Related Documentation
-
-- [Versori Templates](../../../01-TEMPLATES/versori/) - Complete Versori templates
-- [Versori Business Examples](../../../01-TEMPLATES/versori/business-examples/) - Real-world scenarios
-- [Versori Patterns](../../../01-TEMPLATES/versori/patterns/) - Reusable patterns
-
-See [platforms-versori-readme.md](./platforms-versori-readme.md) for complete details.
+# Versori Platform Guide
+
+> **Complete guide for deploying FC Connect SDK on Versori platform**
+> Versori-specific patterns, KV storage, connections, and best practices
+
+For complete documentation, see [platforms-versori-readme.md](./platforms-versori-readme.md)
+
+## Overview
+
+The FC Connect SDK is fully optimized for the Versori integration platform. This guide covers Versori-specific features, patterns, and best practices.
+
+## Navigation
+
+- [Complete Documentation](./platforms-versori-readme.md) - Full Versori guide
+- [Modules](./modules/) - Progressive learning modules
+- [Quick References](.) - Multiple quick reference guides
+
+## Key Features
+
+### Context API
+
+Access Versori platform features through context:
+
+```typescript
+import { schedule } from '@versori/run';
+import { Buffer } from 'node:buffer'; // Always required!
+
+export const task = schedule('task', '0 2 * * *', async (ctx) => {
+  const { log, connections, openKv, secrets } = ctx;
+
+  // Use Versori logger
+  log.info('Starting task');
+
+  // Access connections
+  const fluentConnection = connections['fluent'];
+
+  // Use KV storage
+  const kv = openKv(':project:');
+  await kv.set(['key'], 'value');
+});
+```
+
+### KV Storage
+
+State management with Versori KV:
+
+```typescript
+const kv = openKv(':project:');
+
+// Check if file processed
+const processed = await kv.get(['files', fileName]);
+if (processed.value) {
+  return; // Skip duplicate
+}
+
+// Mark as processed
+await kv.set(['files', fileName], { processed: true, timestamp: Date.now() });
+```
+
+### Connection Management
+
+Pre-configured connections in Versori UI:
+
+```typescript
+// Connections are injected via context
+const client = await createClient({ ...ctx, log });
+```
+
+## Learning Path
+
+| Module | Topic | Level |
+|--------|-------|-------|
+| [Module 1](./modules/platforms-versori-01-introduction.md) | Introduction | Beginner |
+| [Module 2](./modules/platforms-versori-02-quick-start.md) | Quick Start | Beginner |
+| [Module 3](./modules/platforms-versori-03-authentication.md) | Authentication | Intermediate |
+| [Module 4](./modules/platforms-versori-04-workflows.md) | Workflows | Intermediate |
+| [Module 5](./modules/platforms-versori-05-connections.md) | Connections | Intermediate |
+| [Module 6](./modules/platforms-versori-06-kv-storage.md) | KV Storage | Intermediate |
+| [Module 7](./modules/platforms-versori-07-deployment.md) | Deployment | Intermediate |
+| [Module 8](./modules/platforms-versori-08-best-practices.md) | Best Practices | All Levels |
+| [Module 9](./modules/platforms-versori-09-signature-reference.md) | Signature Reference | Reference |
+
+## Quick References
+
+- [Quick Reference](./platforms-versori-readme.md) - Complete guide
+- [Webhook Auth](./platforms-versori-webhook-auth-quick-reference.md) - Webhook authentication patterns
+- [S3/SFTP Configuration](./platforms-versori-s3-sftp-configuration-guide.md) - Data source setup
+- [Workflow Task Types](./platforms-versori-workflow-task-types.md) - Webhook vs scheduled workflows
+
+## Critical: Buffer Import
+
+Always import Buffer in Versori runtime:
+
+```typescript
+// ✅ CORRECT
+import { Buffer } from 'node:buffer';
+
+// ❌ WRONG - Runtime error
+const content = Buffer.from(xmlString); // Buffer is not defined
+```
+
+## Related Documentation
+
+- [Versori Templates](../../../01-TEMPLATES/versori/) - Complete Versori templates
+- [Versori Business Examples](../../../01-TEMPLATES/versori/business-examples/) - Real-world scenarios
+- [Versori Patterns](../../../01-TEMPLATES/versori/patterns/) - Reusable patterns
+
+See [platforms-versori-readme.md](./platforms-versori-readme.md) for complete details.

package/docs/04-REFERENCE/readme.md

@@ -1,148 +1,148 @@
-# Reference Documentation
-
-> **Technical reference and platform-specific guides**
-> Architecture, testing, schema, and platform documentation
-
-## Overview
-
-The Reference section provides technical reference documentation, architectural deep dives, platform-specific guides, and testing strategies.
-
-## Available References
-
-### Architecture & Design
-
-| Reference | Description | Audience |
-|-----------|-------------|----------|
-| **[Architecture](./architecture/)** | SDK architecture and design patterns | Developers, Architects |
-| **[Schema](./schema/)** | Fluent Commerce GraphQL schema reference | All Users |
-| **[Resolver Signature](./resolver-signature/)** | Resolver function signatures and parameters | Advanced Users |
-
-### Platform Guides
-
-| Platform | Description | Runtime |
-|----------|-------------|---------|
-| **[Versori](./platforms/versori/)** | Complete Versori platform guide | Versori |
-| **[Node.js](./platforms/nodejs/)** | Node.js-specific patterns | Node.js |
-| **[Deno](./platforms/deno/)** | Deno runtime compatibility | Deno |
-
-### Quality & Testing
-
-| Reference | Description | Audience |
-|-----------|-------------|----------|
-| **[Testing](./testing/)** | Testing strategies and utilities | All Users |
-| **[Troubleshooting](./troubleshooting/)** | Common issues and solutions | All Users |
-
-## Quick Navigation
-
-### By Use Case
-
-| I Want To... | Reference | Audience |
-|--|--|--|
-| **Understand SDK architecture** | [Architecture](./architecture/) | Developers |
-| **Deploy to Versori** | [Versori Platform](./platforms/versori/) | Versori Users |
-| **Test my integration** | [Testing Guide](./testing/) | All Users |
-| **Validate GraphQL queries** | [Schema Reference](./schema/) | All Users |
-| **Build custom resolvers** | [Resolver Signature](./resolver-signature/) | Advanced Users |
-| **Troubleshoot issues** | [Troubleshooting](./troubleshooting/) | All Users |
-
-### By Audience
-
-**All Users**
-- [Schema Reference](./schema/) - GraphQL schema
-- [Testing Guide](./testing/) - Testing strategies
-- [Troubleshooting](./troubleshooting/) - Common issues
-
-**Developers**
-- [Architecture](./architecture/) - SDK design
-- [Testing](./testing/) - Test patterns
-- Platform guides ([Versori](./platforms/versori/), [Node.js](./platforms/nodejs/), [Deno](./platforms/deno/))
-
-**Advanced Users**
-- [Resolver Signature](./resolver-signature/) - Custom resolvers
-- [Architecture](./architecture/) - Deep dives
-
-## Architecture
-
-### SDK Design
-- [Architecture Overview](./architecture/architecture-01-overview.md) - High-level design
-- [Client Architecture](./architecture/architecture-02-client-architecture.md) - Client design patterns
-- [Data Flow](./architecture/architecture-03-data-flow.md) - Data processing pipeline
-- [Service Layer](./architecture/architecture-04-service-layer.md) - Service architecture
-- [Integration Architecture](./architecture/architecture-05-integration-architecture.md) - Integration patterns
-- [State Management](./architecture/architecture-06-state-management.md) - State handling
-
-### Platform Support
-
-**Node.js**
-- Native support for Node.js ≥18.0.0
-- Full ES modules and CommonJS support
-- See [Node.js Platform Guide](./platforms/nodejs/)
-
-**Deno**
-- Full Deno runtime compatibility
-- Buffer import patterns
-- See [Deno Platform Guide](./platforms/deno/)
-
-**Versori**
-- KV storage integration
-- Connection management
-- Context API access
-- See [Versori Platform Guide](./platforms/versori/)
-
-## Testing
-
-### Testing Strategies
-- Unit testing with fixtures
-- Integration testing with live API
-- Deno compatibility testing
-- Performance testing
-
-See [Testing Guide](./testing/) for complete testing documentation.
-
-## Schema Reference
-
-### GraphQL Schema
-- Complete Fluent Commerce schema
-- Field validation
-- Type definitions
-- Introspection guide
-
-See [Schema Reference](./schema/) for schema documentation.
-
-## Troubleshooting
-
-### Common Issues
-- Connection errors
-- Authentication failures
-- Parsing errors
-- Performance issues
-- Platform-specific problems
-
-See [Troubleshooting Guide](./troubleshooting/) for solutions.
-
-## Related Documentation
-
-### SDK Documentation
-- [Core Guides](../02-CORE-GUIDES/) - SDK fundamentals
-- [Templates](../01-TEMPLATES/) - Production templates
-- [Pattern Guides](../03-PATTERN-GUIDES/) - Integration patterns
-
-### External Resources
-- [npm Package](https://www.npmjs.com/package/@fluentcommerce/fc-connect-sdk)
-- [Fluent Commerce Docs](https://docs.fluentcommerce.com/)
-
-## Support
-
-Need technical reference help?
-- Review architecture documentation
-- Check platform-specific guides
-- See testing strategies
-- Browse troubleshooting guides
-- Contact support@fluentcommerce.com
-
----
-
-**Next Steps:**
-- Understand architecture? See [Architecture](./architecture/)
-- Deploy to Versori? Check [Versori Platform](./platforms/versori/)
-- Need to test? Review [Testing Guide](./testing/)
+# Reference Documentation
+
+> **Technical reference and platform-specific guides**
+> Architecture, testing, schema, and platform documentation
+
+## Overview
+
+The Reference section provides technical reference documentation, architectural deep dives, platform-specific guides, and testing strategies.
+
+## Available References
+
+### Architecture & Design
+
+| Reference | Description | Audience |
+|-----------|-------------|----------|
+| **[Architecture](./architecture/)** | SDK architecture and design patterns | Developers, Architects |
+| **[Schema](./schema/)** | Fluent Commerce GraphQL schema reference | All Users |
+| **[Resolver Signature](./resolver-signature/)** | Resolver function signatures and parameters | Advanced Users |
+
+### Platform Guides
+
+| Platform | Description | Runtime |
+|----------|-------------|---------|
+| **[Versori](./platforms/versori/)** | Complete Versori platform guide | Versori |
+| **[Node.js](./platforms/nodejs/)** | Node.js-specific patterns | Node.js |
+| **[Deno](./platforms/deno/)** | Deno runtime compatibility | Deno |
+
+### Quality & Testing
+
+| Reference | Description | Audience |
+|-----------|-------------|----------|
+| **[Testing](./testing/)** | Testing strategies and utilities | All Users |
+| **[Troubleshooting](./troubleshooting/)** | Common issues and solutions | All Users |
+
+## Quick Navigation
+
+### By Use Case
+
+| I Want To... | Reference | Audience |
+|--|--|--|
+| **Understand SDK architecture** | [Architecture](./architecture/) | Developers |
+| **Deploy to Versori** | [Versori Platform](./platforms/versori/) | Versori Users |
+| **Test my integration** | [Testing Guide](./testing/) | All Users |
+| **Validate GraphQL queries** | [Schema Reference](./schema/) | All Users |
+| **Build custom resolvers** | [Resolver Signature](./resolver-signature/) | Advanced Users |
+| **Troubleshoot issues** | [Troubleshooting](./troubleshooting/) | All Users |
+
+### By Audience
+
+**All Users**
+- [Schema Reference](./schema/) - GraphQL schema
+- [Testing Guide](./testing/) - Testing strategies
+- [Troubleshooting](./troubleshooting/) - Common issues
+
+**Developers**
+- [Architecture](./architecture/) - SDK design
+- [Testing](./testing/) - Test patterns
+- Platform guides ([Versori](./platforms/versori/), [Node.js](./platforms/nodejs/), [Deno](./platforms/deno/))
+
+**Advanced Users**
+- [Resolver Signature](./resolver-signature/) - Custom resolvers
+- [Architecture](./architecture/) - Deep dives
+
+## Architecture
+
+### SDK Design
+- [Architecture Overview](./architecture/architecture-01-overview.md) - High-level design
+- [Client Architecture](./architecture/architecture-02-client-architecture.md) - Client design patterns
+- [Data Flow](./architecture/architecture-03-data-flow.md) - Data processing pipeline
+- [Service Layer](./architecture/architecture-04-service-layer.md) - Service architecture
+- [Integration Architecture](./architecture/architecture-05-integration-architecture.md) - Integration patterns
+- [State Management](./architecture/architecture-06-state-management.md) - State handling
+
+### Platform Support
+
+**Node.js**
+- Native support for Node.js ≥18.0.0
+- Full ES modules and CommonJS support
+- See [Node.js Platform Guide](./platforms/nodejs/)
+
+**Deno**
+- Full Deno runtime compatibility
+- Buffer import patterns
+- See [Deno Platform Guide](./platforms/deno/)
+
+**Versori**
+- KV storage integration
+- Connection management
+- Context API access
+- See [Versori Platform Guide](./platforms/versori/)
+
+## Testing
+
+### Testing Strategies
+- Unit testing with fixtures
+- Integration testing with live API
+- Deno compatibility testing
+- Performance testing
+
+See [Testing Guide](./testing/) for complete testing documentation.
+
+## Schema Reference
+
+### GraphQL Schema
+- Complete Fluent Commerce schema
+- Field validation
+- Type definitions
+- Introspection guide
+
+See [Schema Reference](./schema/) for schema documentation.
+
+## Troubleshooting
+
+### Common Issues
+- Connection errors
+- Authentication failures
+- Parsing errors
+- Performance issues
+- Platform-specific problems
+
+See [Troubleshooting Guide](./troubleshooting/) for solutions.
+
+## Related Documentation
+
+### SDK Documentation
+- [Core Guides](../02-CORE-GUIDES/) - SDK fundamentals
+- [Templates](../01-TEMPLATES/) - Production templates
+- [Pattern Guides](../03-PATTERN-GUIDES/) - Integration patterns
+
+### External Resources
+- [npm Package](https://www.npmjs.com/package/@fluentcommerce/fc-connect-sdk)
+- [Fluent Commerce Docs](https://docs.fluentcommerce.com/)
+
+## Support
+
+Need technical reference help?
+- Review architecture documentation
+- Check platform-specific guides
+- See testing strategies
+- Browse troubleshooting guides
+- Contact support@fluentcommerce.com
+
+---
+
+**Next Steps:**
+- Understand architecture? See [Architecture](./architecture/)
+- Deploy to Versori? Check [Versori Platform](./platforms/versori/)
+- Need to test? Review [Testing Guide](./testing/)