@easyflow/javascript-sdk 2.1.8 → 2.1.10

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.8-blue.svg)](https://easyflow-sdk.pages.dev)
+[![Version](https://img.shields.io/badge/version-2.1.10-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)
@@ -84,7 +84,30 @@ 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.8
+## What's New in v2.1.10
+
+### 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
+- **Build Process**: Streamlined build and deployment pipeline
+
+### 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
+- **Better UX**: Easy discovery via NPM, secure usage via CDN
+
+### 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
 
 ### Security & Privacy Improvements
 
@@ -135,10 +158,30 @@ The **Easyflow JavaScript SDK** is the official tool for developers to integrate
 
 ### Installation
 
+#### Option 1: CDN Script (Recommended)
+
+Add this script tag to your HTML:
+
+```html
+<!-- Latest version -->
+<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.10.min.js"></script>
+```
+
+#### Option 2: NPM Package (Documentation Only)
+
 ```bash
 npm install @easyflow/javascript-sdk
 ```
 
+**Note**: The NPM package contains only documentation. For production use, use the CDN script above.
+
+#### Option 3: Direct Download
+
+Download the latest obfuscated build from [GitHub Releases](https://github.com/easyflow-cash/easyflow-javascript-sdk/releases).
+
 ### Basic Usage
 
 ```javascript
@@ -191,6 +234,8 @@ console.log('Order created:', orderId)
 - **Fingerprinting**: Advanced fraud detection
 - **Rate Limiting**: Protection against abuse
 - **Input Validation**: Comprehensive data validation
+- **Obfuscated Builds**: Production builds are obfuscated for enhanced security
+- **Controlled Distribution**: Secure distribution via CDN and GitHub Releases
 
 ## API Reference
 
@@ -469,12 +514,33 @@ const bankBillet = await sdk.getBankBillet(orderId)
 console.log('Bank Billet Link:', bankBillet.link)
 ```
 
-## Browser Support
+## Distribution & Security
+
+### Why CDN Scripts?
+
+- **Obfuscated Builds**: Production code is obfuscated for security
+- **Controlled Access**: Secure distribution via Cloudflare Pages
+- **Version Control**: Specific versions available for stability
+- **Performance**: Global CDN for fast loading
+
+### Available CDN URLs
+
+```html
+<!-- Latest version -->
+<script src="https://easyflow-sdk.pages.dev/easyflow-sdk.min.js"></script>
 
-- **Chrome**: 88+
-- **Firefox**: 85+
-- **Safari**: 14+
-- **Edge**: 88+
+<!-- Versioned (recommended for production) -->
+<script src="https://easyflow-sdk.pages.dev/easyflow-sdk.v2.1.8.min.js"></script>
+
+<!-- With SRI (Subresource Integrity) -->
+<script
+    src="https://easyflow-sdk.pages.dev/easyflow-sdk.v2.1.10.min.js"
+    integrity="sha384-[hash]"
+    crossorigin="anonymous"
+></script>
+```
+
+## Browser Support
 
 ## Node.js Support
 
@@ -498,6 +564,20 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## Changelog
 
+### v2.1.10
+
+- **Workflow Fixed**: Resolved GitHub Actions permissions and SRI hash generation
+- **CDN Automation**: Automated deployment to Cloudflare Pages working correctly
+- **Release Process**: GitHub releases created automatically with proper SRI hashes
+- **Build Pipeline**: Streamlined build and deployment process
+
+### v2.1.9
+
+- **Hybrid Distribution**: NPM for docs, CDN for secure obfuscated code
+- **Enhanced Security**: Code source protected while maintaining accessibility
+- **Better UX**: Easy discovery via NPM, secure usage via CDN
+- **Documentation**: Complete setup and usage instructions
+
 ### v2.1.8
 
 - **Security & Privacy**: Anonymized README.md for safe NPM publication

package/dist/index.d.ts

@@ -0,0 +1,421 @@
+declare module '@easyflow/javascript-sdk' {
+    export interface EasyflowSDKConfig {
+        businessId: string
+        environment?: 'production' | 'sandbox'
+        debug?: boolean
+        timeout?: number
+    }
+
+    export interface CustomerData {
+        name: string
+        email: string
+        document: {
+            type: 'CPF' | 'CNPJ'
+            number: string
+        }
+        phone?: {
+            areaCode: string
+            ddd: string
+            number: string
+            isMobile: boolean
+        }
+        address?: {
+            zipCode: string
+            street: string
+            number: string
+            complement?: string
+            neighborhood: string
+            city: string
+            state: string
+        }
+        deliveryAddress?: {
+            zipCode: string
+            street: string
+            number: string
+            complement?: string
+            neighborhood: string
+            city: string
+            state: string
+        }
+    }
+
+    export interface PaymentMethod {
+        method: 'credit-card' | 'pix' | 'bank-billet'
+        numberInstallments: number
+        creditCard?: {
+            number: string
+            holderName: string
+            month: string
+            year: string
+            cvv: string
+        }
+        creditCardId?: string
+    }
+
+    export interface OrderData {
+        customer: CustomerData
+        payments: PaymentMethod[]
+        items?: Array<{
+            name: string
+            price: number
+            quantity?: number
+        }>
+        metadata?: Record<string, any>
+    }
+
+    export interface CreditCardData {
+        number: string
+        holderName: string
+        month: string
+        year: string
+        cvv: string
+    }
+
+    export interface Customer {
+        id: string
+        name: string
+        email: string
+        document: {
+            type: 'CPF' | 'CNPJ'
+            number: string
+        }
+        phone?: {
+            areaCode: string
+            ddd: string
+            number: string
+            isMobile: boolean
+        }
+        address?: {
+            zipCode: string
+            street: string
+            number: string
+            complement?: string
+            neighborhood: string
+            city: string
+            state: string
+        }
+        deliveryAddress?: {
+            zipCode: string
+            street: string
+            number: string
+            complement?: string
+            neighborhood: string
+            city: string
+            state: string
+        }
+        createdAt?: string
+        updatedAt?: string
+    }
+
+    export interface CreditCard {
+        creditCardId: string
+        brand?: string
+        last4Numbers?: string
+        expiresAtMonth?: string
+        expiresAtYear?: string
+        holderName?: string
+    }
+
+    export interface Order {
+        id: string
+        status: string
+        total: number
+        customer: Customer
+        payments: PaymentMethod[]
+        items?: Array<{
+            name: string
+            price: number
+            quantity: number
+        }>
+        createdAt?: string
+        updatedAt?: string
+    }
+
+    export interface Offer {
+        id: string
+        name: string
+        price: number
+        description?: string
+        items: Array<{
+            name: string
+            price: number
+            quantity: number
+        }>
+    }
+
+    export interface PixData {
+        qrCode: string
+        copyAndPasteCode: string
+        expirationDate: string
+    }
+
+    export interface BankBilletData {
+        link: string
+        line: string
+        barCode: string
+        expirationDate: string
+    }
+
+    export interface ValidationResult {
+        isValid: boolean
+        errors?: string[]
+    }
+
+    export class EasyflowSDK {
+        static readonly version: string
+
+        constructor(config: EasyflowSDKConfig | string)
+
+        // Core Methods
+        placeOrder(
+            offerId: string,
+            data: OrderData,
+            headers?: Record<string, string>
+        ): Promise<string>
+        charge(
+            data: OrderData,
+            headers?: Record<string, string>
+        ): Promise<string>
+        encrypt(
+            creditCardData: CreditCardData,
+            headers?: Record<string, string>
+        ): Promise<string>
+
+        // Offer & Order Management
+        getOffer(
+            offerId: string,
+            headers?: Record<string, string>
+        ): Promise<Offer>
+        getOrder(
+            orderId: string,
+            headers?: Record<string, string>
+        ): Promise<Order>
+
+        // Payment Methods
+        getPix(
+            orderId: string,
+            headers?: Record<string, string>
+        ): Promise<PixData | null>
+        getBankBillet(
+            orderId: string,
+            headers?: Record<string, string>
+        ): Promise<BankBilletData | null>
+
+        // Customer Management
+        createCustomer(
+            customerData: CustomerData,
+            headers?: Record<string, string>
+        ): Promise<Customer>
+        getCustomer(
+            customerId: string,
+            headers?: Record<string, string>
+        ): Promise<Customer>
+        updateCustomer(
+            customerId: string,
+            updateData: Partial<CustomerData>,
+            headers?: Record<string, string>
+        ): Promise<ValidationResult>
+
+        // Credit Card Management
+        addCreditCard(
+            customerId: string,
+            creditCardToken: string,
+            headers?: Record<string, string>
+        ): Promise<CreditCard>
+        getCreditCard(
+            customerId: string,
+            creditCardId: string,
+            headers?: Record<string, string>
+        ): Promise<CreditCard>
+        removeCreditCard(
+            customerId: string,
+            creditCardId: string,
+            headers?: Record<string, string>
+        ): Promise<ValidationResult>
+
+        // Event System
+        on(
+            event: 'customerCreated' | 'orderPlaced' | 'paymentProcessed',
+            callback: (data: any) => void
+        ): void
+        off(
+            event: 'customerCreated' | 'orderPlaced' | 'paymentProcessed',
+            callback: (data: any) => void
+        ): void
+    }
+
+    // Validator Class
+    export class Validator {
+        static validateEmail(email: string): boolean
+        static validateCPF(cpf: string): boolean
+        static validateCNPJ(cnpj: string): boolean
+        static validateLegalDocument(document: {
+            type: 'CPF' | 'CNPJ'
+            number: string
+        }): boolean
+        static validatePhone(phone: {
+            areaCode: string
+            ddd: string
+            number: string
+            isMobile: boolean
+        }): boolean
+        static validateAddress(address: {
+            zipCode: string
+            street: string
+            number: string
+            complement?: string
+            neighborhood: string
+            city: string
+            state: string
+        }): boolean
+        static validateCustomer(customer: CustomerData): boolean
+        static validatePagination(page: number, limit: number): boolean
+        static validateBusinessId(businessId: string): boolean
+        static validateCreditCardToken(token: string): boolean
+        static validateOrderId(orderId: string): boolean
+        static validateOfferId(offerId: string): boolean
+        static validateCustomerId(customerId: string): boolean
+        static validateCreditCardId(creditCardId: string): boolean
+        static validateOrderData(orderData: OrderData): boolean
+    }
+
+    // Constants
+    export const PAYMENT_METHODS: {
+        readonly CREDIT_CARD: 'credit-card'
+        readonly PIX: 'pix'
+        readonly BANK_BILLET: 'bank-billet'
+    }
+
+    export const TARGETS: {
+        readonly CHARGE: 'charge'
+        readonly PLACE_ORDER: 'place-order'
+        readonly ENCRYPT: 'encrypt'
+        readonly GET_OFFER: 'get-offer'
+        readonly GET_ORDER: 'get-order'
+    }
+
+    export const HTTP_STATUS_CODES: {
+        readonly OK: 200
+        readonly CREATED: 201
+        readonly BAD_REQUEST: 400
+        readonly UNAUTHORIZED: 401
+        readonly FORBIDDEN: 403
+        readonly NOT_FOUND: 404
+        readonly INTERNAL_SERVER_ERROR: 500
+    }
+
+    export const HTTP_REQUEST_METHODS: {
+        readonly GET: 'GET'
+        readonly POST: 'POST'
+        readonly PUT: 'PUT'
+        readonly DELETE: 'DELETE'
+    }
+
+    // Error Classes
+    export class EasyflowError extends Error {
+        constructor(message: string, status?: number, code?: string)
+        status: number
+        code: string
+    }
+
+    export class SecurityError extends EasyflowError {
+        constructor(message: string)
+    }
+
+    export class ValidationError extends EasyflowError {
+        constructor(message: string)
+    }
+
+    export class NetworkError extends EasyflowError {
+        constructor(message: string)
+    }
+
+    export const ERROR_CODES: {
+        readonly VALIDATION_ERROR: 'VALIDATION_ERROR'
+        readonly SECURITY_ERROR: 'SECURITY_ERROR'
+        readonly NETWORK_ERROR: 'NETWORK_ERROR'
+        readonly UNKNOWN_ERROR: 'UNKNOWN_ERROR'
+    }
+
+    // Default export
+    export default EasyflowSDK
+}
+
+// Global instance for browser environments
+declare global {
+    interface Window {
+        easyflowSDK: {
+            on(event: string, callback: (data: any) => void): void
+            off(event: string, callback: (data: any) => void): void
+            placeOrder(
+                offerId: string,
+                data: any,
+                headers?: Record<string, string>
+            ): Promise<string>
+            charge(data: any, headers?: Record<string, string>): Promise<string>
+            encrypt(
+                creditCardData: any,
+                headers?: Record<string, string>
+            ): Promise<string>
+            getOffer(
+                offerId: string,
+                headers?: Record<string, string>
+            ): Promise<any>
+            getOrder(
+                orderId: string,
+                headers?: Record<string, string>
+            ): Promise<any>
+            getPix(
+                orderId: string,
+                headers?: Record<string, string>
+            ): Promise<any>
+            getBankBillet(
+                orderId: string,
+                headers?: Record<string, string>
+            ): Promise<any>
+            createCustomer(
+                customerData: any,
+                headers?: Record<string, string>
+            ): Promise<any>
+            getCustomer(
+                customerId: string,
+                headers?: Record<string, string>
+            ): Promise<any>
+            updateCustomer(
+                customerId: string,
+                updateData: any,
+                headers?: Record<string, string>
+            ): Promise<any>
+            addCreditCard(
+                customerId: string,
+                creditCardToken: string,
+                headers?: Record<string, string>
+            ): Promise<any>
+            getCreditCard(
+                customerId: string,
+                creditCardId: string,
+                headers?: Record<string, string>
+            ): Promise<any>
+            removeCreditCard(
+                customerId: string,
+                creditCardId: string,
+                headers?: Record<string, string>
+            ): Promise<any>
+            validate: {
+                email(email: string): boolean
+                cpf(cpf: string): boolean
+                cnpj(cnpj: string): boolean
+                phone(phone: any): boolean
+                address(address: any): boolean
+                customer(customer: any): boolean
+                orderId(orderId: string): boolean
+                offerId(offerId: string): boolean
+                customerId(customerId: string): boolean
+                creditCardId(creditCardId: string): boolean
+            }
+            version: string
+            PAYMENT_METHODS: any
+        }
+        EasyflowSDK: typeof import('@easyflow/javascript-sdk').EasyflowSDK
+    }
+}

package/package.json

@@ -1,16 +1,27 @@
 {
     "name": "@easyflow/javascript-sdk",
-    "version": "2.1.8",
-    "description": "Easyflow javascript SDK to be used on client side applications",
-    "main": "dist/easyflow-sdk.min.js",
+    "version": "2.1.10",
+    "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",
     "type": "module",
     "types": "./dist/index.d.ts",
+    "files": [
+        "README.md",
+        "LICENSE",
+        "dist/index.d.ts"
+    ],
     "exports": {
-        "import": "./dist/index.mjs",
-        "require": "./dist/index.cjs"
+        ".": {
+            "import": "./dist/easyflow-sdk.min.js",
+            "require": "./dist/easyflow-sdk.min.js",
+            "types": "./dist/index.d.ts"
+        },
+        "./package.json": "./package.json"
     },
     "scripts": {
-        "build": "npm run generate-version && npx webpack --config webpack.config.cjs",
+        "build": "npm run generate-version && npm run build:types && npx webpack --config webpack.config.cjs",
+        "build:types": "npx tsc --project tsconfig.json",
         "generate-version": "node -e \"const pkg=require('./package.json'); const fs=require('fs'); const content='export const SDK_VERSION = \\'' + pkg.version + '\\';'; fs.writeFileSync('./version.mjs', content);\"",
         "server:up": "rm -rf ./dist && npm run build && npx http-server . -p 8080 -o",
         "dev": "npm run build && npx http-server . -p 8080 -o --cors",
@@ -38,12 +49,14 @@
         "@babel/cli": "^7.26.4",
         "@babel/core": "^7.26.8",
         "@babel/preset-env": "^7.26.8",
+        "@types/node": "^20.19.11",
         "babel-loader": "^9.2.1",
         "http-server": "^14.1.1",
         "javascript-obfuscator": "^4.1.1",
         "jest": "^29.7.0",
         "prettier": "^3.4.2",
         "terser-webpack-plugin": "^5.3.11",
+        "typescript": "^5.9.2",
         "webpack": "^5.97.1",
         "webpack-cli": "^6.0.1",
         "webpack-obfuscator": "^3.5.1"

package/.babelrc

@@ -1,5 +0,0 @@
-{
-  "presets": [
-    "@babel/preset-env"
-  ]
-}

package/.github/workflows/deploy-sdk-cf.yml

@@ -1,49 +0,0 @@
-name: Deploy Easyflow SDK to Cloudflare Pages
-
-on:
-    push:
-        branches: [main]
-    workflow_dispatch:
-
-jobs:
-    build-and-deploy:
-        runs-on: ubuntu-latest
-
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v4
-
-            - name: Setup Node.js
-              uses: actions/setup-node@v4
-              with:
-                  node-version: '18'
-                  cache: 'npm'
-
-            - name: Install dependencies
-              run: npm ci
-
-            - name: Build SDK
-              run: npm run build
-
-            - name: Copy Documentation to Build
-              run: |
-                  # Copiar apenas o index.html da documentação
-                  cp docs/index.html dist/
-                  echo "📚 Documentação copiada para build (apenas index.html)"
-
-            - name: Deploy to Cloudflare Pages
-              uses: cloudflare/pages-action@v1
-              with:
-                  apiToken: ${{ secrets.CF_API_TOKEN }}
-                  accountId: ${{ secrets.CF_ACCOUNT_ID }}
-                  projectName: easyflow-sdk
-                  directory: dist
-
-            - name: Success Message
-              run: |
-                  echo "🚀 SDK e Documentação Deployados com sucesso!"
-                  echo "📦 SDK + Docs: https://easyflow-sdk.pages.dev"
-                  echo "🌐 jsDelivr: https://cdn.jsdelivr.net/npm/@easyflow/javascript-sdk@latest/dist/easyflow-sdk.min.js"
-                  echo ""
-                  echo "✅ Documentação agora está disponível em:"
-                  echo "   https://easyflow-sdk.pages.dev"