@easyflow/javascript-sdk 2.1.11 → 2.1.13

package/README.md

@@ -1,7 +1,7 @@
 # Easyflow JavaScript SDK
 
 [![Build Status](https://github.com/easyflow-cash/easyflow-javascript-sdk/workflows/Build%20&%20Deploy%20Easyflow%20SDK/badge.svg)](https://github.com/easyflow-cash/easyflow-javascript-sdk/actions)
-[![Version](https://img.shields.io/badge/version-2.1.11-blue.svg)](https://easyflow-sdk.pages.dev)
+[![Version](https://img.shields.io/badge/version-2.1.13-blue.svg)](https://easyflow-sdk.pages.dev)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
 [![Tests](https://img.shields.io/badge/tests-250%20passing-brightgreen.svg)](https://github.com/easyflow-cash/easyflow-javascript-sdk)
 [![Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen.svg)](https://github.com/easyflow-cash/easyflow-javascript-sdk)
@@ -12,7 +12,8 @@
 
 **Freedom to sell more, better and longer**
 
-> **Enterprise-grade JavaScript SDK** for integration with the Easyflow payment processing platform with robust validation, comprehensive security and Brazilian compliance
+> **Enterprise-grade JavaScript SDK** for integration with the Easyflow payment processing platform with robust
+> validation, comprehensive security and Brazilian compliance
 
 [![Website](https://img.shields.io/badge/Website-Easyflow.digital-667eea?style=for-the-badge)](https://www.easyflow.digital/)
 [![Start Free](https://img.shields.io/badge/Start_Free-22c55e?style=for-the-badge&logo=rocket&logoColor=white)](https://www.easyflow.digital/)
@@ -22,7 +23,9 @@
 
 ## About Easyflow
 
-[Easyflow](https://www.easyflow.digital/) is a payment platform that **facilitates the sales process** of digital products and services in a simple and intuitive way. Our mission is to transform Digital Commerce by offering a complete sales structure to maximize your LTV.
+[Easyflow](https://www.easyflow.digital/) is a payment platform that **facilitates the sales process** of digital
+products and services in a simple and intuitive way. Our mission is to transform Digital Commerce by offering a complete
+sales structure to maximize your LTV.
 
 ### Why Choose Easyflow?
 
@@ -68,7 +71,8 @@
 
 ## What is the Easyflow JavaScript SDK?
 
-The **Easyflow JavaScript SDK** is the official tool for developers to integrate their applications with the Easyflow platform. With this SDK, you can:
+The **Easyflow JavaScript SDK** is the official tool for developers to integrate their applications with the Easyflow
+platform. With this SDK, you can:
 
 - **Process payments** securely and reliably
 - **Manage customers** with complete Brazilian data validation
@@ -84,7 +88,15 @@ The **Easyflow JavaScript SDK** is the official tool for developers to integrate
 - **High Performance**: Optimized for production
 - **Complete Documentation**: Practical examples for all use cases
 
-## What's New in v2.1.11
+## What's New in v2.1.13
+
+### Complete Implementation Examples
+
+- **Full Data Models**: Comprehensive examples for placeOrder, charge, createCustomer, and addCreditCard
+- **Real-World Scenarios**: Complete workflows with all available data fields
+- **Brazilian Data**: Realistic Brazilian addresses, phone numbers, and document formats
+- **End-to-End Workflows**: Complete customer → credit card → order examples
+- **Code Quality**: Improved formatting and consistency across all examples
 
 ### Credit Card Token Validation Fix
 
@@ -96,8 +108,6 @@ The **Easyflow JavaScript SDK** is the official tool for developers to integrate
 
 ### Workflow Corrections
 
-### Workflow Corrections
-
 - **GitHub Actions Fixed**: Resolved release workflow permissions and SRI hash generation
 - **CDN Deployment**: Automated deployment to Cloudflare Pages working correctly
 - **Release Automation**: GitHub releases created automatically with proper SRI hashes
@@ -105,8 +115,6 @@ The **Easyflow JavaScript SDK** is the official tool for developers to integrate
 
 ### Hybrid Distribution Strategy
 
-### Hybrid Distribution Strategy
-
 - **NPM Package**: Contains only documentation and TypeScript definitions
 - **CDN Scripts**: Production-ready obfuscated builds via Cloudflare Pages
 - **Enhanced Security**: Code source protected while maintaining accessibility
@@ -119,21 +127,6 @@ The **Easyflow JavaScript SDK** is the official tool for developers to integrate
 - **Professional Documentation**: Clean, business-focused documentation
 - **NPM Safety**: Safe for public NPM publication
 
-### Security & Privacy Improvements
-
-- **README Anonymization**: Removed all personal information and sensitive data
-- **Privacy Protection**: No personal emails, URLs, or contact information exposed
-- **Professional Documentation**: Clean, business-focused documentation
-- **NPM Safety**: Safe for public NPM publication
-
-### Test Suite Improvements
-
-- **Test Coverage Optimization**: Fixed all failing unit tests for complete 250 test coverage
-- **Mock Structure Corrections**: Updated test mocks to align with actual API response patterns
-- **Customer Management Tests**: Corrected mock structures for `createCustomer` and `getCustomer` methods
-- **Credit Card Tests**: Fixed mock data structures for `addCreditCard` and `getCreditCard` methods
-- **Consistent Test Patterns**: Standardized mock response structures across all endpoints
-
 ### Test Suite Improvements
 
 - **Test Coverage Optimization**: Fixed all failing unit tests for complete 250 test coverage
@@ -177,7 +170,7 @@ Add this script tag to your HTML:
 <script src="https://easyflow-sdk.pages.dev/easyflow-sdk.min.js"></script>
 
 <!-- Specific version -->
-<script src="https://easyflow-sdk.pages.dev/easyflow-sdk.v2.1.11.min.js"></script>
+<script src="https://easyflow-sdk.pages.dev/easyflow-sdk.v2.1.12.min.js"></script>
 ```
 
 #### Option 2: NPM Package (Documentation Only)
@@ -190,7 +183,8 @@ npm install @easyflow/javascript-sdk
 
 #### Option 3: Direct Download
 
-Download the latest obfuscated build from [GitHub Releases](https://github.com/easyflow-cash/easyflow-javascript-sdk/releases).
+Download the latest obfuscated build
+from [GitHub Releases](https://github.com/easyflow-cash/easyflow-javascript-sdk/releases).
 
 ### Basic Usage
 
@@ -594,6 +588,426 @@ const bankBillet = await easyflowSDK.getBankBillet(orderId)
 console.log('Bank Billet Link:', bankBillet.link)
 ```
 
+## Complete Implementation Examples
+
+### 1. placeOrder - Complete Data Model
+
+#### placeOrder com PIX
+
+```javascript
+// Configure SDK
+easyflowSDK.configure({
+    businessId: 'demo-business-12345',
+})
+
+// Complete placeOrder example with PIX payment
+const orderId = await easyflowSDK.placeOrder(
+    '3df92ac7-9d7f-4948-b54f-7e082492f6d2',
+    {
+        buyer: {
+            name: 'João Silva Santos',
+            email: 'joao.silva@exemplo.com',
+            document: {
+                number: '12345678901',
+                type: 'CPF',
+            },
+            phone: {
+                areaCode: '+55',
+                ddd: '11',
+                number: '9988776655',
+                isMobile: true,
+            },
+            address: {
+                zipCode: '01234567',
+                street: 'Rua das Flores',
+                complement: 'Apto 101',
+                neighborhood: 'Centro',
+                city: 'São Paulo',
+                state: 'SP',
+                number: '123',
+            },
+        },
+        payments: [
+            {
+                method: 'pix',
+                numberInstallments: 1,
+            },
+        ],
+        offerItems: [
+            {
+                offerItemId: '3df92ac7-9d7f-4948-b54f-7e082492f6d2',
+                quantity: 1,
+            },
+        ],
+        metadata: [],
+    }
+)
+
+console.log('Order created with PIX payment:', orderId)
+```
+
+#### placeOrder com Cartão de Crédito
+
+```javascript
+// Complete placeOrder example with credit card payment
+const orderId = await easyflowSDK.placeOrder(
+    '3df92ac7-9d7f-4948-b54f-7e082492f6d2',
+    {
+        buyer: {
+            name: 'João Silva Santos',
+            email: 'joao.silva@exemplo.com',
+            document: {
+                number: '12345678901',
+                type: 'CPF',
+            },
+            phone: {
+                areaCode: '+55',
+                ddd: '11',
+                number: '9988776655',
+                isMobile: true,
+            },
+            address: {
+                zipCode: '01234567',
+                street: 'Rua das Flores',
+                complement: 'Apto 101',
+                neighborhood: 'Centro',
+                city: 'São Paulo',
+                state: 'SP',
+                number: '123',
+            },
+        },
+        payments: [
+            {
+                method: 'credit-card',
+                numberInstallments: 1,
+                creditCard: {
+                    cardId: 'demo-credit-card-67890', // cardId e token são opcionais, mas pelo menos 1 deve ser fornecido
+                    token: 'demo-credit-card-token-here',
+                    last4Numbers: '1234',
+                    holderName: 'JOAO SILVA SANTOS',
+                    expiresAtMonth: '12',
+                    expiresAtYear: '2025',
+                    flag: 'visa',
+                },
+            },
+        ],
+        offerItems: [
+            {
+                offerItemId: '3df92ac7-9d7f-4948-b54f-7e082492f6d2',
+                quantity: 1,
+            },
+        ],
+        metadata: [],
+    }
+)
+
+console.log('Order created with credit card payment:', orderId)
+```
+
+### 2. charge - Complete Data Model
+
+#### charge com Cartão de Crédito
+
+```javascript
+// Complete charge example with credit card payment
+const orderId = await easyflowSDK.charge({
+    buyer: {
+        name: 'João Silva Santos',
+        email: 'joao.silva@exemplo.com',
+        document: {
+            number: '12345678901',
+            type: 'CPF',
+        },
+        phone: {
+            areaCode: '+55',
+            ddd: '11',
+            number: '9988776655',
+            isMobile: true,
+        },
+        address: {
+            zipCode: '01234567',
+            street: 'Rua das Flores',
+            complement: 'Apto 101',
+            neighborhood: 'Centro',
+            city: 'São Paulo',
+            state: 'SP',
+            number: '123',
+        },
+        customerId: 'demo-customer-12345', // ID do cliente existente (opcional)
+    },
+    payments: [
+        {
+            method: 'credit-card',
+            numberInstallments: 1,
+            valueInCents: 500,
+            creditCard: {
+                cardId: 'demo-card-id-here', // cardId e token são opcionais, mas pelo menos 1 deve ser fornecido
+                token: 'demo-token-credit-card-here',
+            },
+        },
+    ],
+    items: [
+        {
+            description: 'Carregador de celular com cabo USB-C',
+            name: 'Carregador de Celular',
+            quantity: 1,
+            priceInCents: 500,
+        },
+    ],
+    businessId: 'demo-business-12345',
+})
+
+console.log('Charge processed with credit card:', orderId)
+```
+
+#### charge com PIX
+
+```javascript
+// Complete charge example with PIX payment
+const orderId = await easyflowSDK.charge({
+    buyer: {
+        name: 'João Silva Santos',
+        email: 'joao.silva@exemplo.com',
+        document: {
+            number: '12345678901',
+            type: 'CPF',
+        },
+        phone: {
+            areaCode: '+55',
+            ddd: '11',
+            number: '9988776655',
+            isMobile: true,
+        },
+        address: {
+            zipCode: '01234567',
+            street: 'Rua das Flores',
+            complement: 'Apto 101',
+            neighborhood: 'Centro',
+            city: 'São Paulo',
+            state: 'SP',
+            number: '123',
+        },
+        customerId: 'demo-customer-12345', // ID do cliente existente (opcional)
+    },
+    payments: [
+        {
+            method: 'pix',
+            numberInstallments: 1,
+            valueInCents: 500,
+        },
+    ],
+    items: [
+        {
+            description: 'Carregador de celular com cabo USB-C',
+            name: 'Carregador de Celular',
+            quantity: 1,
+            priceInCents: 500,
+        },
+    ],
+    businessId: 'demo-business-12345',
+})
+
+console.log('Charge processed with PIX:', orderId)
+```
+
+### 3. createCustomer - Complete Data Model
+
+```javascript
+// Complete createCustomer example with all available fields
+const customer = await easyflowSDK.createCustomer({
+    businessId: 'demo-business-12345',
+    name: 'João Silva Santos',
+    email: 'joao.silva@exemplo.com',
+    document: {
+        type: 'CPF',
+        number: '12345678901',
+    },
+    phone: {
+        areaCode: '+55',
+        ddd: '11',
+        number: '9988776655',
+        isMobile: true,
+    },
+    address: {
+        zipCode: '01234567',
+        street: 'Rua das Flores',
+        complement: 'Apto 101',
+        neighborhood: 'Centro',
+        city: 'São Paulo',
+        state: 'SP',
+        number: '123',
+    },
+    deliveryAddress: {
+        zipCode: '01234567',
+        street: 'Rua das Flores',
+        complement: 'Apto 101',
+        neighborhood: 'Centro',
+        city: 'São Paulo',
+        state: 'SP',
+        number: '123',
+    },
+    birthDate: '1990-05-15',
+    gender: 'M',
+    maritalStatus: 'single',
+    occupation: 'Desenvolvedor',
+    company: 'Tech Solutions Ltda',
+    website: 'https://joaosilva.com',
+    notes: 'Cliente preferencial com histórico de compras',
+    tags: ['premium', 'tech-savvy', 'early-adopter'],
+    preferences: {
+        newsletter: true,
+        marketing: false,
+        language: 'pt-BR',
+        currency: 'BRL',
+    },
+})
+
+console.log('Customer created with complete data:', customer)
+```
+
+### 4. addCreditCard - Complete Data Model
+
+```javascript
+// First, encrypt the credit card data
+const encryptedToken = await easyflowSDK.encrypt({
+    cardNumber: '4111111111111111',
+    cvv: '123',
+    month: '12',
+    year: '2025',
+    holderName: 'PEDRO OLIVEIRA LIMA',
+})
+
+console.log('Credit card encrypted:', encryptedToken)
+
+// Then add the encrypted token to the customer
+const creditCard = await easyflowSDK.addCreditCard(
+    customer.id, // customer ID from createCustomer
+    encryptedToken
+)
+
+console.log('Credit card added successfully:', creditCard)
+
+// Now you can use the credit card for payments
+const orderWithSavedCard = await easyflowSDK.placeOrder(
+    '3df92ac7-9d7f-4948-b54f-7e082492f6d2',
+    {
+        buyer: {
+            customerId: customer.id, // Use existing customer
+            name: 'João Silva Santos',
+            email: 'joao.silva@exemplo.com',
+            document: {
+                number: '12345678901',
+                type: 'CPF',
+            },
+        },
+        payments: [
+            {
+                method: 'credit-card',
+                numberInstallments: 6,
+                creditCard: {
+                    cardId: creditCard.id, // Use saved credit card
+                },
+            },
+        ],
+        offerItems: [
+            {
+                offerItemId: '3df92ac7-9d7f-4948-b54f-7e082492f6d2',
+                quantity: 1,
+            },
+        ],
+        metadata: [],
+    }
+)
+
+console.log('Order with saved credit card:', orderWithSavedCard)
+```
+
+### 5. Complete Workflow Example
+
+```javascript
+// Complete workflow: Customer → Credit Card → Order
+async function completeWorkflow() {
+    try {
+        // 1. Configure SDK
+        easyflowSDK.configure({
+            businessId: 'demo-business-12345',
+        })
+
+        // 2. Create customer with complete data
+        const customer = await easyflowSDK.createCustomer({
+            businessId: 'demo-business-12345',
+            name: 'Ana Silva Costa',
+            email: 'ana.silva@exemplo.com',
+            document: { type: 'CPF', number: '55566677788' },
+            phone: {
+                areaCode: '+55',
+                ddd: '41',
+                number: '765432109',
+                isMobile: true,
+            },
+            address: {
+                zipCode: '80000000',
+                street: 'Rua das Palmeiras',
+                complement: 'Apto 202',
+                neighborhood: 'Batel',
+                city: 'Curitiba',
+                state: 'PR',
+                number: '321',
+            },
+        })
+
+        // 3. Encrypt and add credit card
+        const token = await easyflowSDK.encrypt({
+            cardNumber: '5555555555554444',
+            cvv: '321',
+            month: '10',
+            year: '2026',
+            holderName: 'ANA SILVA COSTA',
+        })
+
+        const creditCard = await easyflowSDK.addCreditCard(customer.id, token)
+
+        // 4. Create order using saved customer and credit card
+        const orderId = await easyflowSDK.placeOrder(
+            '3df92ac7-9d7f-4948-b54f-7e082492f6d2',
+            {
+                buyer: {
+                    customerId: customer.id,
+                    name: customer.name,
+                    email: customer.email,
+                    document: customer.document,
+                },
+                payments: [
+                    {
+                        method: 'credit-card',
+                        numberInstallments: 12,
+                        creditCard: { cardId: creditCard.id },
+                    },
+                ],
+                offerItems: [
+                    {
+                        offerItemId: '3df92ac7-9d7f-4948-b54f-7e082492f6d2',
+                        quantity: 1,
+                    },
+                ],
+                metadata: [],
+            }
+        )
+
+        console.log('Complete workflow successful:', {
+            customer: customer.id,
+            creditCard: creditCard.id,
+            order: orderId,
+        })
+    } catch (error) {
+        console.error('Workflow failed:', error.message)
+    }
+}
+
+// Execute the complete workflow
+completeWorkflow()
+```
+
 ## Distribution & Security
 
 ### Why CDN Scripts?
@@ -610,11 +1024,11 @@ console.log('Bank Billet Link:', bankBillet.link)
 <script src="https://easyflow-sdk.pages.dev/easyflow-sdk.min.js"></script>
 
 <!-- Versioned (recommended for production) -->
-<script src="https://easyflow-sdk.pages.dev/easyflow-sdk.v2.1.8.min.js"></script>
+<script src="https://easyflow-sdk.pages.dev/easyflow-sdk.v2.1.13.min.js"></script>
 
 <!-- With SRI (Subresource Integrity) -->
 <script
-    src="https://easyflow-sdk.pages.dev/easyflow-sdk.v2.1.11.min.js"
+    src="https://easyflow-sdk.pages.dev/easyflow-sdk.v2.1.12.min.js"
     integrity="sha384-[hash]"
     crossorigin="anonymous"
 ></script>
@@ -635,7 +1049,8 @@ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) f
 ## Support
 
 - **Documentation**: [https://docs.easyflow.digital](https://docs.easyflow.digital)
-- **GitHub Issues**: [https://github.com/easyflow-cash/easyflow-javascript-sdk/issues](https://github.com/easyflow-cash/easyflow-javascript-sdk/issues)
+- **GitHub Issues
+  **: [https://github.com/easyflow-cash/easyflow-javascript-sdk/issues](https://github.com/easyflow-cash/easyflow-javascript-sdk/issues)
 - **Website**: [https://www.easyflow.digital](https://www.easyflow.digital)
 
 ## License
@@ -644,6 +1059,22 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## Changelog
 
+### v2.1.13
+
+- **Code Formatting**: Improved readability of placeOrder examples with better line breaks
+- **Documentation**: Enhanced formatting for complex method calls
+- **Examples**: Better visual structure for placeOrder, charge, and workflow examples
+- **Consistency**: Unified formatting across all code examples
+
+### v2.1.12
+
+- **Complete Implementation Examples**: Added comprehensive examples for all major methods
+- **Full Data Models**: Examples showing all available fields for placeOrder, charge, createCustomer, addCreditCard
+- **Brazilian Data Examples**: Realistic Brazilian addresses, phone numbers, and document formats
+- **End-to-End Workflows**: Complete customer → credit card → order workflow examples
+- **Code Quality**: Improved formatting, consistency, and readability across all examples
+- **Documentation**: Fixed duplicate sections and improved overall structure
+
 ### v2.1.11
 
 - **Credit Card Token Fix**: Accepts real encrypted/ciphered tokens from vault services

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@easyflow/javascript-sdk",
-    "version": "2.1.11",
+    "version": "2.1.13",
     "description": "Easyflow JavaScript SDK - Documentation and TypeScript definitions. For production use, use the CDN script: https://easyflow-sdk.pages.dev/easyflow-sdk.min.js",
     "main": "README.md",
     "module": "README.md",