@sinoia/hubdoc-tools 1.0.4 → 1.2.1

package/INSTALL.md

@@ -1,175 +0,0 @@
-# Installation Guide - @sinoia/hubdoc-tools
-
-## Requirements
-
-- **Node.js**: Version 16 or higher
-- **npm**: Version 7 or higher (included with Node.js)
-- **Operating System**: Windows, macOS, or Linux
-
-## Global Installation (Recommended)
-
-```bash
-# Install globally from npm registry
-npm install -g @sinoia/hubdoc-tools
-
-# Verify installation
-hubdoc-tool --version
-```
-
-## Local Development Installation
-
-For developers who want to contribute or modify the tool:
-
-```bash
-# Clone the repository
-git clone https://github.com/your-org/hubdoc-tools.git
-cd hubdoc-tools
-
-# Install dependencies
-npm install
-
-# Build the project
-npm run build
-
-# Link globally for development
-npm link
-
-# Or run directly with npm
-npm run dev -- --help
-```
-
-## First-Time Configuration
-
-After installation, configure your HubDoc API credentials:
-
-```bash
-# Run the configuration wizard
-hubdoc-tool config
-```
-
-The wizard will prompt you for:
-- **API URL**: Your HubDoc instance URL (e.g., `https://demo.hubdoc.sinoia.cloud/api/v1`)
-- **API Token**: Your HubDoc authentication token
-- **Storage Format**: Choose between JSON config file or environment variables
-
-## Quick Start
-
-### 1. Test Your Configuration
-
-```bash
-# Test API connection
-hubdoc-tool import --interactive
-```
-
-### 2. Generate a Mapping File
-
-```bash
-# Generate mapping from a directory
-hubdoc-tool generate-mapping ./documents
-```
-
-### 3. Import Documents
-
-```bash
-# Direct import from directory
-hubdoc-tool import --source ./documents
-
-# Or use the generated mapping
-hubdoc-tool import --mapping mapping.csv
-```
-
-## Troubleshooting
-
-### Permission Errors (Linux/macOS)
-
-If you get permission errors during global installation:
-
-```bash
-# Option 1: Use sudo (not recommended)
-sudo npm install -g @sinoia/hubdoc-tools
-
-# Option 2: Configure npm to use a different directory (recommended)
-mkdir ~/.npm-global
-npm config set prefix '~/.npm-global'
-echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.profile
-source ~/.profile
-npm install -g @sinoia/hubdoc-tools
-```
-
-### Node.js Version Issues
-
-If you get compatibility errors:
-
-```bash
-# Check your Node.js version
-node --version
-
-# Update Node.js (using nvm)
-nvm install 18
-nvm use 18
-```
-
-### Network/Proxy Issues
-
-If installation fails due to network issues:
-
-```bash
-# Configure npm for corporate proxy
-npm config set proxy http://your-proxy:8080
-npm config set https-proxy http://your-proxy:8080
-
-# Or use a different registry
-npm install -g @sinoia/hubdoc-tools --registry https://registry.npmjs.org
-```
-
-### Windows-Specific Issues
-
-On Windows, you might need:
-
-```bash
-# Install Windows Build Tools (if needed)
-npm install -g windows-build-tools
-
-# Or use PowerShell as Administrator
-```
-
-## Uninstallation
-
-```bash
-# Remove global installation
-npm uninstall -g @sinoia/hubdoc-tools
-
-# Clean npm cache (optional)
-npm cache clean --force
-```
-
-## Configuration Files
-
-The tool creates configuration files in your current directory:
-
-- `.hubdoc-config.json` - API credentials and settings
-- `.env` - Environment variables (alternative to JSON config)
-- `mapping.csv` - Generated mapping files for imports
-
-## Getting Help
-
-```bash
-# Show all available commands
-hubdoc-tool --help
-
-# Show help for specific command
-hubdoc-tool import --help
-hubdoc-tool generate-mapping --help
-```
-
-## Next Steps
-
-1. Read the [full documentation](./README-hubdoc-tool.md)
-2. Check out [connector documentation](./docs/README.md) for cloud sources
-3. Try the [interactive mode](./README-hubdoc-tool.md#interactive-mode) for guided workflows
-
-## Support
-
-- **Documentation**: [README-hubdoc-tool.md](./README-hubdoc-tool.md)
-- **Connectors**: [docs/README.md](./docs/README.md)
-- **Issues**: Report problems in the project repository

package/PACKAGING.md

@@ -1,206 +0,0 @@
-# Guide de Packaging HubDoc Tool
-
-Ce guide explique comment créer des packages distribubables pour les clients Windows.
-
-## 🎯 Options de Distribution
-
-### **Option 1: Exécutable Standalone (Recommandé)**
-- ✅ **Avantages** : Aucune installation requise, portable, pas besoin de Node.js
-- ✅ **Taille** : ~50MB (inclut Node.js embarqué)
-- ✅ **Utilisation** : Double-clic et ça marche
-- ❌ **Inconvénients** : Pas d'intégration système (PATH, menu démarrer)
-
-### **Option 2: Installateur Windows NSIS** 
-- ✅ **Avantages** : Installation professionnelle, ajout au PATH, menu démarrer
-- ✅ **Fonctionnalités** : Désinstallation propre, raccourcis, documentation intégrée
-- ❌ **Complexité** : Nécessite NSIS pour compiler
-
-## 🚀 Création des Packages
-
-### Méthode Rapide (Exécutable uniquement)
-
-```bash
-# 1. Build TypeScript
-npm run build
-
-# 2. Créer l'exécutable Windows
-npm run pkg
-
-# 3. Tester
-./build/hubdoc-tool-windows.exe --help
-```
-
-### Méthode Complète (Scripts automatisés)
-
-#### Sur macOS/Linux :
-```bash
-./scripts/build-windows-installer.sh
-```
-
-#### Sur Windows :
-```powershell
-.\scripts\build-windows-installer.ps1
-```
-
-#### Avec installateur NSIS :
-```powershell
-.\scripts\build-windows-installer.ps1 -BuildInstaller
-```
-
-## 📦 Contenu des Packages
-
-### Exécutable Standalone
-```
-hubdoc-tool-windows.exe  (50MB)
-├── Node.js runtime embarqué
-├── Application complète
-├── Tous les connecteurs
-└── Documentation intégrée
-```
-
-### Installateur Complet
-```
-HubDoc-Tool-1.0.0-Setup.exe
-├── hubdoc-tool.exe
-├── docs/ (documentation complète)
-├── config-examples/ (exemples de configuration)
-├── Raccourcis menu démarrer
-├── Ajout au PATH système
-└── Désinstallateur
-```
-
-## 🛠️ Prérequis pour Compilation
-
-### Pour l'Exécutable (pkg)
-```bash
-npm install pkg --save-dev
-```
-
-### Pour l'Installateur (NSIS)
-1. **Windows** : [Télécharger NSIS](https://nsis.sourceforge.io/Download)
-2. **macOS** : `brew install makensis`
-3. **Linux** : `sudo apt install nsis`
-
-## 📋 Scripts Disponibles
-
-```bash
-# Exécutables
-npm run pkg          # Windows x64 uniquement
-npm run pkg:all      # Windows + macOS + Linux
-npm run installer:win # Build + Package Windows
-
-# Tests
-npm run test-connectors  # Valider avant packaging
-npm run typecheck       # Vérifier TypeScript
-```
-
-## 🎯 Guide de Distribution Client
-
-### Pour un Client Technique
-**Recommandation** : Exécutable standalone
-
-```
-1. Télécharger: hubdoc-tool-windows.exe
-2. Placer dans: C:\Tools\HubDoc\
-3. Utiliser: hubdoc-tool-windows.exe --interactive
-```
-
-### Pour un Client Entreprise  
-**Recommandation** : Installateur complet
-
-```
-1. Télécharger: HubDoc-Tool-1.0.0-Setup.exe
-2. Exécuter en tant qu'administrateur
-3. Suivre l'assistant d'installation
-4. Utiliser: hubdoc-tool depuis n'importe où
-```
-
-## 🔧 Configuration Client
-
-### Après Installation
-1. **Créer config** : Copier les exemples depuis `config-examples/`
-2. **Éditer credentials** : Remplir les tokens/clés appropriés
-3. **Tester connexion** : `hubdoc-tool --engine [connecteur] --limit 5`
-
-### Exemple de Déploiement
-```bash
-# 1. Configuration Box
-copy config-examples\box-config.example.json box-config.json
-# Éditer box-config.json avec le vrai token
-
-# 2. Test de connexion
-hubdoc-tool --engine box --limit 5
-
-# 3. Import réel
-hubdoc-tool --engine box --limit 100
-```
-
-## 📊 Tailles des Packages
-
-| Package | Taille | Contenu |
-|---------|--------|---------|
-| **Standalone .exe** | ~50MB | Exécutable + Runtime |
-| **Installer .exe** | ~52MB | Installateur + Documentation |
-| **Sources complètes** | ~15MB | Code source + dépendances |
-
-## 🛡️ Sécurité
-
-### Signature de Code (Optionnel)
-Pour les déploiements entreprise, signer les exécutables :
-
-```bash
-# Avec un certificat code signing
-signtool sign /f certificate.pfx /p password hubdoc-tool-windows.exe
-```
-
-### Antivirus
-Les exécutables pkg peuvent déclencher des faux positifs. Solutions :
-- Signer le code avec un certificat valide
-- Soumettre à VirusTotal pour validation
-- Documenter pour les équipes IT client
-
-## 🔍 Résolution de Problèmes
-
-### Erreur "pkg: Failed to make bytecode"
-**Solution** : Ces warnings sont normaux et n'affectent pas le fonctionnement
-
-### Exécutable ne démarre pas
-**Vérifications** :
-1. Architecture correcte (x64)
-2. Windows 10+ requis
-3. Antivirus non bloquant
-4. Droits d'exécution
-
-### Taille de l'exécutable importante
-**Explication** : Inclut Node.js complet (~40MB) + application (~10MB)
-**Alternative** : Distribuer avec Node.js séparé (plus complexe)
-
-## 📚 Ressources
-
-- **PKG Documentation** : https://github.com/vercel/pkg
-- **NSIS Documentation** : https://nsis.sourceforge.io/Docs/
-- **Node.js Packaging** : https://nodejs.org/en/docs/guides/getting-started-guide/
-
-## 🎉 Déploiement Final
-
-### Checklist Avant Distribution
-- [ ] Build sans erreurs TypeScript
-- [ ] Tests connecteurs passent
-- [ ] Exécutable fonctionne (`--help`)
-- [ ] Documentation incluse
-- [ ] Exemples de config présents
-- [ ] LICENSE créé
-- [ ] README à jour
-
-### Livraison Client
-```
-📦 HubDoc-Tool-Package/
-├── 🚀 hubdoc-tool-windows.exe (standalone)
-├── 💿 HubDoc-Tool-1.0.0-Setup.exe (installer)
-├── 📚 docs/ (documentation)
-├── ⚙️ config-examples/ (exemples)
-├── 📋 README.md (guide utilisateur)
-└── 🧪 TESTING.md (guide de test)
-```
-
-**Le client peut choisir entre l'exécutable portable ou l'installateur complet selon ses besoins !** 🎯

package/PLUGINS.md

@@ -1,328 +0,0 @@
-# 🔌 HubDoc Tool - Plugin System
-
-Le système de plugins permet d'étendre HubDoc Tool pour importer des documents depuis des sources externes (cloud, GED, etc.).
-
-## 📦 Plugins Disponibles
-
-### ✅ Plugins Intégrés
-
-| Plugin | Description | Import | Export | Authentification |
-|--------|-------------|--------|--------|------------------|
-| **filesystem** | Système de fichiers local | ✅ | ✅ | Aucune |
-| **onedrive** | Microsoft OneDrive/SharePoint | ✅ | ✅ | OAuth2 + Azure App |
-| **googledrive** | Google Drive | ✅ | ✅ | OAuth2 + Google API |
-| **dropbox** | Dropbox | ✅ | ✅ | Access Token |
-
-### 🚧 Plugins Future (Roadmap)
-
-- **sharepoint** : Microsoft SharePoint Server
-- **box** : Box.com
-- **nextcloud** : Nextcloud/ownCloud
-- **alfresco** : Alfresco GED
-- **documentum** : OpenText Documentum
-- **sharefileS** : Citrix ShareFile
-
----
-
-## 🚀 Utilisation
-
-### 1. Lister les Plugins Disponibles
-
-```bash
-hubdoc-tool plugins
-```
-
-### 2. Créer une Connexion
-
-```bash
-# Configuration interactive
-hubdoc-tool connect onedrive --interactive --name "OneDrive-Corporate"
-
-# Configuration depuis fichier
-hubdoc-tool connect googledrive --config ./google-config.json --name "Google-Drive"
-```
-
-### 3. Scanner une Source Externe
-
-```bash
-# Scan complet
-hubdoc-tool plugin-scan conn_1234567890 --output onedrive-mapping.csv
-
-# Scan avec filtres
-hubdoc-tool plugin-scan conn_1234567890 \
-  --path "/Documents/2024" \
-  --max-size 52428800 \
-  --mime-types "application/pdf,image/jpeg" \
-  --output filtered-mapping.csv
-```
-
-### 4. Import depuis Source Externe
-
-```bash
-hubdoc-tool plugin-import plugin-mapping.csv --temp-dir ./temp
-```
-
----
-
-## ⚙️ Configuration des Plugins
-
-### OneDrive
-
-```json
-{
-  "clientId": "your-azure-app-client-id",
-  "clientSecret": "your-azure-app-client-secret", 
-  "tenantId": "your-tenant-id",
-  "accessToken": "obtained-via-oauth",
-  "rootPath": "/Documents"
-}
-```
-
-**Setup Azure App :**
-1. Azure Portal > App Registrations > New
-2. API Permissions : Files.Read.All, Sites.Read.All
-3. Authentication > Redirect URI : `http://localhost:3000/callback`
-
-### Google Drive
-
-```json
-{
-  "clientId": "your-google-client-id",
-  "clientSecret": "your-google-client-secret",
-  "redirectUri": "http://localhost:3000/callback", 
-  "accessToken": "obtained-via-oauth",
-  "rootFolderId": "folder-id-or-root"
-}
-```
-
-**Setup Google API :**
-1. Google Cloud Console > APIs & Services
-2. Enable Google Drive API
-3. Create OAuth2 Credentials
-4. Configure consent screen
-
-### Dropbox
-
-```json
-{
-  "accessToken": "your-dropbox-access-token",
-  "rootPath": "/Documents"
-}
-```
-
-**Setup Dropbox App :**
-1. Dropbox App Console > Create App
-2. Generate Access Token
-3. Permissions : files.metadata.read, files.content.read
-
-### Filesystem (Local)
-
-```json
-{
-  "basePath": "/path/to/documents",
-  "includeHidden": false,
-  "followSymlinks": false
-}
-```
-
----
-
-## 📋 Format du Mapping Plugin
-
-Le fichier CSV généré par `plugin-scan` contient :
-
-| Colonne | Description | Modifiable |
-|---------|-------------|------------|
-| Connection ID | ID de la connexion | ❌ |
-| Source ID | ID du document source | ❌ |
-| Source Name | Nom du fichier | ❌ |
-| Source Path | Chemin relatif | ❌ |
-| Target Folder | Dossier HubDoc | ✅ |
-| Workspace | Projet HubDoc | ✅ |
-| Domain | Domaine métier | ✅ |
-| Plan Classement | Plan de classification | ✅ |
-| Read/Write Permissions | Permissions | ✅ |
-
-### Exemple de Mapping
-
-```csv
-Connection ID,Source ID,Source Name,Target Folder (editable),Workspace (editable)
-conn_1234567890,/Documents/plans/facade.pdf,facade.pdf,Technique/Plans Architecture,Les Jardins de Meudon
-conn_1234567890,/Documents/contrats/marche.pdf,marche.pdf,Administrative/Marchés,Les Jardins de Meudon
-```
-
----
-
-## 🔧 Workflow Complet
-
-### Exemple : Import depuis OneDrive
-
-```bash
-# 1. Configurer la connexion OneDrive
-hubdoc-tool connect onedrive --interactive --name "OneDrive-Entreprise"
-
-# 2. Scanner les documents
-hubdoc-tool plugin-scan conn_1701234567 --output onedrive-docs.csv
-
-# 3. Éditer le CSV pour définir l'organisation HubDoc
-# (Excel, LibreOffice, etc.)
-
-# 4. Importer vers HubDoc
-hubdoc-tool plugin-import onedrive-docs.csv
-```
-
-### Workflow avec Filtres
-
-```bash
-# Scanner uniquement les PDFs de 2024 < 10MB
-hubdoc-tool plugin-scan conn_1701234567 \
-  --path "/Documents/2024" \
-  --max-size 10485760 \
-  --mime-types "application/pdf" \
-  --output pdfs-2024.csv
-```
-
----
-
-## 🛠️ Développement de Plugins
-
-### Structure d'un Plugin
-
-```
-plugins/
-└── myplugin/
-    ├── plugin.json          # Manifest
-    ├── index.ts             # Code principal  
-    └── README.md            # Documentation
-```
-
-### Manifest (plugin.json)
-
-```json
-{
-  "name": "myplugin",
-  "version": "1.0.0",
-  "description": "My custom document source plugin",
-  "author": "Your Name",
-  "main": "index.js",
-  "hubdocToolVersion": "^1.0.0",
-  "dependencies": {
-    "axios": "^1.5.0"
-  }
-}
-```
-
-### Interface Plugin
-
-```typescript
-export default class MyPlugin implements DocumentSourcePlugin {
-  readonly name = 'myplugin';
-  readonly version = '1.0.0';
-  readonly description = 'My custom plugin';
-  readonly supportedOperations = ['import', 'export'] as const;
-
-  async testConnection(config: PluginConfig): Promise<boolean> {
-    // Test de connectivité
-  }
-
-  async scan(config: PluginConfig, options?: PluginImportOptions): Promise<ScanResult> {
-    // Scanner les documents disponibles
-  }
-
-  async import(config: PluginConfig, sources: DocumentSource[], targetDir: string): Promise<ImportResult[]> {
-    // Télécharger les documents
-  }
-
-  async export?(config: PluginConfig, localSources: DocumentSource[]): Promise<ExportResult[]> {
-    // Upload vers la source externe
-  }
-
-  getConfigSchema(): Record<string, any> {
-    // Schema de configuration JSON
-  }
-
-  async initialize(config: PluginConfig): Promise<void> {
-    // Initialisation
-  }
-
-  async destroy(): Promise<void> {
-    // Nettoyage
-  }
-}
-```
-
-### Installation Plugin Personnalisé
-
-1. Créer le dossier plugin dans `./plugins/`
-2. Implémenter l'interface `DocumentSourcePlugin`
-3. Le plugin sera chargé automatiquement au démarrage
-
----
-
-## 🔍 Debug & Troubleshooting
-
-### Logs Plugin
-
-```bash
-# Activer les logs détaillés
-DEBUG=hubdoc-tool:plugins hubdoc-tool plugin-scan conn_123
-```
-
-### Tester une Connexion
-
-```bash
-hubdoc-tool plugins  # Voir l'état des connexions
-```
-
-### Erreurs Courantes
-
-**❌ Plugin not found**
-- Vérifier que le plugin est dans `./plugins/`
-- Vérifier le manifest `plugin.json`
-
-**❌ Authentication failed**
-- Renouveler les tokens OAuth2
-- Vérifier les permissions API
-
-**❌ Rate limit exceeded** 
-- Réduire `batchSize` dans les options
-- Ajouter des délais entre requêtes
-
----
-
-## 🚀 Exemples d'Usage Avancés
-
-### Import Massif Multi-Sources
-
-```bash
-# OneDrive Corporate
-hubdoc-tool plugin-scan conn_onedrive --path "/Shared Documents" -o onedrive.csv
-
-# Google Drive Personnel  
-hubdoc-tool plugin-scan conn_gdrive --path "/Work" -o gdrive.csv
-
-# Fusionner et importer
-hubdoc-tool plugin-import onedrive.csv
-hubdoc-tool plugin-import gdrive.csv
-```
-
-### Pipeline d'Import Automatisé
-
-```bash
-#!/bin/bash
-# Script d'import automatique
-
-# Scanner toutes les connexions
-for conn in conn_onedrive conn_gdrive conn_dropbox; do
-  hubdoc-tool plugin-scan $conn --output ${conn}-mapping.csv
-done
-
-# Import automatique (mapping pré-configuré)
-for mapping in *-mapping.csv; do
-  hubdoc-tool plugin-import $mapping
-done
-```
-
----
-
-*HubDoc Tool Plugin System v1.0.0 - Extension modulaire pour sources documentaires externes*