Gathering detailed insights and metrics for directus-brazilian-pix
Gathering detailed insights and metrics for directus-brazilian-pix
Installations
npm install directus-brazilian-pixDeveloper Guide
BETA
Typescript
No
Module System
ESM
Min. Node Version
>=18.0.0
Node Version
24.0.1
NPM Version
11.3.0
Score
67.6
Supply Chain
98.6
Quality
83.4
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
1
Package Meta Information
Latest Version
1.0.1
Package Id
directus-brazilian-pix@1.0.1
Unpacked Size
27.44 kB
Size
9.59 kB
File Count
5
NPM Version
11.3.0
Node Version
24.0.1
Published on
Jun 20, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
1
Brazilian PIX Key Extension for Directus
A comprehensive Directus extension bundle for handling Brazilian PIX keys with validation, formatting, and beautiful displays.
🚀 Features
PIX Key Interface
- Multi-type Support: CPF, CNPJ, Phone numbers, and Email addresses
- Auto-detection: Automatically detects PIX key type based on input format
- Real-time Validation: Validates keys using official Brazilian algorithms
- Smart Formatting: Applies proper formatting as you type
- Type Selection: Dropdown to manually select PIX key type
- Configurable: Extensive configuration options for different use cases
PIX Key Display
- Type Badges: Visual indicators showing the PIX key type
- Copy to Clipboard: One-click copying with visual feedback
- Privacy Mode: Option to mask sensitive information (CPF/CNPJ)
- QR Code Generation: Generate QR codes for PIX keys (placeholder)
- Responsive Design: Works on all screen sizes
📦 Installation
From NPM (Recommended)
1npm install directus-brazilian-pix
Manual Installation
- Download the latest release
- Extract to your Directus extensions folder
- Restart your Directus instance
🔧 Usage
Interface Configuration
Add the Brazilian PIX Key interface to any string field:
- Go to Settings > Data Model
- Select your collection and field
- Choose "Brazilian PIX Key" as the interface
- Configure the options as needed
Interface Options
| Option | Type | Default | Description |
|---|---|---|---|
| Auto-detect Type | Boolean | true | Automatically detect PIX key type based on input |
| Allowed Types | Array | All types | Restrict which PIX key types are allowed |
| Default Type | String | cpf | Default type when creating new items |
| Validate Key | Boolean | true | Enable validation using official algorithms |
| Required | Boolean | false | Make the field required |
Display Configuration
Configure the display to show PIX keys with type badges:
- Go to your collection layout
- Select the PIX key field
- Choose "Brazilian PIX Key Display" as the display
- Configure the display options
Display Options
| Option | Type | Default | Description |
|---|---|---|---|
| Show Type Badge | Boolean | true | Display type badge (CPF, CNPJ, etc.) |
| Format Key | Boolean | true | Apply formatting to displayed keys |
| Hide Partial Key | Boolean | false | Mask part of the key for privacy |
| Copy to Clipboard | Boolean | true | Enable copy functionality |
| Show QR Code | Boolean | false | Show QR code generation button |
📋 PIX Key Types
Supported Types
| Type | Description | Format | Example |
|---|---|---|---|
| CPF | Individual taxpayer ID | XXX.XXX.XXX-XX | 123.456.789-01 |
| CNPJ | Company taxpayer ID | XX.XXX.XXX/XXXX-XX | 12.345.678/0001-90 |
| Phone | Mobile/landline number | (XX) XXXXX-XXXX | (11) 99999-9999 |
| Email address | user@domain.com | usuario@email.com |
Validation Rules
- CPF: Validates using the official Brazilian CPF algorithm
- CNPJ: Validates using the official Brazilian CNPJ algorithm
- Phone: Validates area codes and mobile number formats
- Email: Standard email format validation
🎨 Styling
The extension uses Directus design tokens and follows the system theme automatically.
Type Badge Colors
- CPF: Blue (
--blue) - CNPJ: Purple (
--purple) - Phone: Green (
--green) - Email: Orange (
--orange)
📊 Data Storage
PIX keys are stored as JSON strings containing both the key and its type:
1{ 2 "key": "12345678901", 3 "type": "cpf" 4}
This allows for:
- Proper validation based on type
- Correct formatting in displays
- Type-aware functionality
🔧 Development
Prerequisites
- Node.js 18+
- Directus 10+
Local Development
1# Clone the repository 2git clone https://github.com/brunribeiro/directus-brazilian-pix.git 3 4# Install dependencies 5cd directus-brazilian-pix 6npm install 7 8# Build the extension 9npm run build 10 11# Link for development 12npm run link
Building
1npm run build
Validation
1npm run validate
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Development Guidelines
- Follow the existing code style
- Add tests for new features
- Update documentation
- Ensure all validations pass
📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
🐛 Issues & Support
Found a bug or need help? Please open an issue on GitHub.
🙏 Acknowledgments
- Brazilian Central Bank for PIX key specifications
- Directus team for the amazing extension SDK
- The Brazilian development community
📈 Roadmap
- Real QR Code generation
- PIX key validation API integration
- Bulk PIX key operations
- Additional PIX key types (EVP - Random keys)
- Export/import functionality
No vulnerabilities found.
No security vulnerabilities found.