n8n-nodes-mammouth 0.1.0

package/README.md

@@ -0,0 +1,99 @@
+# Mammouth pour n8n
+
+Node privé d'actions Chat / Image / Text pour une API compatible avec le protocole
+OpenAI. Ce n'est pas un sous-node Chat Model pour AI Agent.
+
+## Compilation et vérification
+
+Node.js 24 ou supérieur et npm sont nécessaires (une dépendance du SDK n8n
+exige Node.js 24). Respecter également la version
+Node.js requise par votre installation n8n. Le paquet est compilé et testé avec
+`n8n-workflow` 2.42.1 ; la compatibilité avec votre version exacte de n8n reste
+à vérifier sur votre instance.
+
+```bash
+cd /home/mathieu/delivery/Projets/n8n-integration
+npm ci
+npm test
+```
+
+La compilation produit `/home/mathieu/delivery/Projets/n8n-integration/dist`,
+avec le node, ses credentials, ses icônes et ses métadonnées.
+
+## Chargement dans n8n installé avec npm / Node.js
+
+Sur la machine qui exécute n8n, après compilation, définir le répertoire
+d'extensions personnalisées au démarrage :
+
+```bash
+export N8N_CUSTOM_EXTENSIONS="/home/mathieu/delivery/Projets/n8n-integration/dist"
+n8n start
+```
+
+Arrêter préalablement l'instance existante : ne pas lancer un deuxième processus
+sur le même port. Si n8n est géré par systemd ou PM2, ajouter cette variable à
+la configuration de ce service, puis le redémarrer avec son gestionnaire.
+Un simple `export` dans un terminal ne modifie pas l'environnement d'un service.
+
+- Exécuter n8n avec son utilisateur habituel pour conserver ses données.
+- Le chemin ci-dessus est celui de ce projet : l'adapter si n8n tourne ailleurs.
+- Conserver les dépendances installées dans ce projet et rendre le projet lisible
+  par l'utilisateur du service n8n.
+- Si `N8N_CUSTOM_EXTENSIONS` contient déjà des chemins, ajouter ce répertoire en
+  les séparant par `;`, sans supprimer les extensions existantes.
+- Recompiler puis redémarrer n8n après chaque modification.
+- Recharger l'interface et chercher **Mammouth** dans le sélecteur de nodes.
+
+Cette installation reste privée : aucune publication npm n'est nécessaire.
+`npm pack` produit aussi une archive installable pour un déploiement en paquet
+communautaire privé. Ne pas charger simultanément le même node comme extension
+personnalisée et comme paquet communautaire ; leurs identifiants de workflow
+diffèrent (`CUSTOM.mammouth` et `n8n-nodes-mammouth.mammouth`).
+
+## Configuration de l'API
+
+Créer des credentials **Mammouth API** et renseigner :
+
+- **API Base URL** : URL complète de la base API, avec `/v1` si votre serveur
+  l'exige. Par exemple, `https://api.example.com/v1` est un exemple fictif, pas
+  l'adresse de votre entreprise. Un préfixe tel que `/proxy/v1` est conservé.
+- **API Key** : clé envoyée dans `Authorization: Bearer …`.
+
+Aucune URL d'API n'est préremplie et aucun repli vers OpenAI n'est effectué.
+Utiliser HTTPS hors tests locaux. Le bouton de test des credentials appelle
+`GET /models` ; il exige que cet endpoint soit disponible et autorisé.
+
+Pour un premier essai : sélectionner **Chat → Complete**, choisir un modèle,
+ajouter un message de rôle **User**, puis exécuter le node.
+
+## Endpoints et limites
+
+Les chemins suivants sont ajoutés à l'URL de base :
+
+| Fonction | Méthode et chemin |
+| --- | --- |
+| Liste des modèles et test des credentials | `GET /models` |
+| Chat | `POST /chat/completions` |
+| Image | `POST /images/generations` |
+| Complétion texte | `POST /completions` |
+| Édition texte | `POST /edits` |
+| Modération | `POST /moderations` |
+
+La liste des modèles attend `{ "data": [{ "id": "identifiant-du-modele" }] }`.
+Elle n'applique aucun filtre de marque : choisir un modèle compatible avec
+l'opération. L'édition et la modération demandent un identifiant saisi manuellement.
+
+Les opérations et options sont héritées du node d'origine. Une compatibilité
+Chat Completions ne garantit pas les endpoints historiques d'édition, de texte,
+de modération, ni les paramètres image. Les options spécifiques DALL-E restent
+conditionnées à ces modèles. Seules les fonctions effectivement exposées par
+votre API pourront fonctionner ; aucun support supplémentaire n'est présumé.
+
+Les tests vérifient la compilation, les exports, les assets, les expressions n8n,
+l'authentification, les modèles et les erreurs HTTP. Un serveur HTTP local simule
+les endpoints modèles et chat à partir de la configuration du node ; ce test
+ne remplace pas une exécution du moteur de routage n8n ni un appel à votre API.
+
+Ce paquet est marqué `private: true` et `UNLICENSED` pour éviter une publication
+accidentelle. Cela ne remplace pas la licence du code amont : vérifier les
+obligations de licence et d'attribution du code repris avant toute distribution.

package/dist/ChatDescription.d.ts

@@ -0,0 +1,3 @@
+import type { INodeProperties } from 'n8n-workflow';
+export declare const chatOperations: INodeProperties[];
+export declare const chatFields: INodeProperties[];

package/dist/ChatDescription.js

@@ -0,0 +1,385 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chatFields = exports.chatOperations = void 0;
+const GenericFunctions_1 = require("./GenericFunctions");
+exports.chatOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: {
+            show: {
+                resource: ['chat'],
+            },
+        },
+        options: [
+            {
+                name: 'Complete',
+                value: 'complete',
+                action: 'Create a Completion',
+                description: 'Create one or more completions for a given text',
+                routing: {
+                    request: {
+                        method: 'POST',
+                        url: '/chat/completions',
+                    },
+                    output: { postReceive: [GenericFunctions_1.sendErrorPostReceive] },
+                },
+            },
+        ],
+        default: 'complete',
+    },
+];
+const completeOperations = [
+    {
+        displayName: 'Model',
+        name: 'model',
+        type: 'options',
+        description: 'The model available on your Mammouth API which will generate the completion',
+        displayOptions: {
+            show: {
+                operation: ['complete'],
+                resource: ['chat'],
+                '@version': [1],
+            },
+        },
+        typeOptions: {
+            loadOptions: {
+                routing: {
+                    request: {
+                        method: 'GET',
+                        url: '/models',
+                    },
+                    output: {
+                        postReceive: [
+                            {
+                                type: 'rootProperty',
+                                properties: {
+                                    property: 'data',
+                                },
+                            },
+                            {
+                                type: 'setKeyValue',
+                                properties: {
+                                    name: '={{$responseItem.id}}',
+                                    value: '={{$responseItem.id}}',
+                                },
+                            },
+                            {
+                                type: 'sort',
+                                properties: {
+                                    key: 'name',
+                                },
+                            },
+                        ],
+                    },
+                },
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'model',
+            },
+        },
+        required: true,
+        default: '',
+    },
+    {
+        displayName: 'Model',
+        name: 'chatModel',
+        type: 'options',
+        description: 'The model available on your Mammouth API which will generate the completion',
+        displayOptions: {
+            show: {
+                operation: ['complete'],
+                resource: ['chat'],
+            },
+            hide: {
+                '@version': [1],
+            },
+        },
+        typeOptions: {
+            loadOptions: {
+                routing: {
+                    request: {
+                        method: 'GET',
+                        url: '/models',
+                    },
+                    output: {
+                        postReceive: [
+                            {
+                                type: 'rootProperty',
+                                properties: {
+                                    property: 'data',
+                                },
+                            },
+                            {
+                                type: 'setKeyValue',
+                                properties: {
+                                    name: '={{$responseItem.id}}',
+                                    value: '={{$responseItem.id}}',
+                                },
+                            },
+                            {
+                                type: 'sort',
+                                properties: {
+                                    key: 'name',
+                                },
+                            },
+                        ],
+                    },
+                },
+            },
+        },
+        routing: {
+            send: {
+                type: 'body',
+                property: 'model',
+            },
+        },
+        required: true,
+        default: '',
+    },
+    {
+        displayName: 'Prompt',
+        name: 'prompt',
+        type: 'fixedCollection',
+        typeOptions: {
+            sortable: true,
+            multipleValues: true,
+        },
+        displayOptions: {
+            show: {
+                resource: ['chat'],
+                operation: ['complete'],
+            },
+        },
+        placeholder: 'Add Message',
+        default: {},
+        options: [
+            {
+                displayName: 'Messages',
+                name: 'messages',
+                values: [
+                    {
+                        displayName: 'Role',
+                        name: 'role',
+                        type: 'options',
+                        options: [
+                            {
+                                name: 'Assistant',
+                                value: 'assistant',
+                            },
+                            {
+                                name: 'System',
+                                value: 'system',
+                            },
+                            {
+                                name: 'User',
+                                value: 'user',
+                            },
+                        ],
+                        default: 'user',
+                    },
+                    {
+                        displayName: 'Content',
+                        name: 'content',
+                        type: 'string',
+                        default: '',
+                    },
+                ],
+            },
+        ],
+        routing: {
+            send: {
+                type: 'body',
+                property: 'messages',
+                value: '={{ $value.messages }}',
+            },
+        },
+    },
+];
+const sharedOperations = [
+    {
+        displayName: 'Simplify',
+        name: 'simplifyOutput',
+        type: 'boolean',
+        default: true,
+        displayOptions: {
+            show: {
+                operation: ['complete'],
+                resource: ['chat'],
+            },
+        },
+        routing: {
+            output: {
+                postReceive: [
+                    {
+                        type: 'set',
+                        enabled: '={{$value}}',
+                        properties: {
+                            value: '={{ { "data": $response.body.choices } }}',
+                        },
+                    },
+                    {
+                        type: 'rootProperty',
+                        enabled: '={{$value}}',
+                        properties: {
+                            property: 'data',
+                        },
+                    },
+                    async function (items) {
+                        if (this.getNode().parameters.simplifyOutput === false) {
+                            return items;
+                        }
+                        return items.map((item) => {
+                            return {
+                                json: {
+                                    ...item.json,
+                                    message: item.json.message,
+                                },
+                            };
+                        });
+                    },
+                ],
+            },
+        },
+        description: 'Whether to return a simplified version of the response instead of the raw data',
+    },
+    {
+        displayName: 'Options',
+        name: 'options',
+        placeholder: 'Add option',
+        description: 'Additional options to add',
+        type: 'collection',
+        default: {},
+        displayOptions: {
+            show: {
+                operation: ['complete'],
+                resource: ['chat'],
+            },
+        },
+        options: [
+            {
+                displayName: 'Echo Prompt',
+                name: 'echo',
+                type: 'boolean',
+                description: 'Whether the prompt should be echo back in addition to the completion',
+                default: false,
+                displayOptions: {
+                    show: {
+                        '/operation': ['complete'],
+                    },
+                },
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'echo',
+                    },
+                },
+            },
+            {
+                displayName: 'Frequency Penalty',
+                name: 'frequency_penalty',
+                default: 0,
+                typeOptions: { maxValue: 2, minValue: -2, numberPrecision: 1 },
+                description: "Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim",
+                type: 'number',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'frequency_penalty',
+                    },
+                },
+            },
+            {
+                displayName: 'Maximum Number of Tokens',
+                name: 'maxTokens',
+                default: 16,
+                description: 'The maximum number of tokens to generate in the completion. Most models have a context length of 2048 tokens (except for the newest models, which support 32,768).',
+                type: 'number',
+                displayOptions: {
+                    show: {
+                        '/operation': ['complete'],
+                    },
+                },
+                typeOptions: {
+                    maxValue: 32768,
+                },
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'max_tokens',
+                    },
+                },
+            },
+            {
+                displayName: 'Number of Completions',
+                name: 'n',
+                default: 1,
+                description: 'How many completions to generate for each prompt. Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.',
+                type: 'number',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'n',
+                    },
+                },
+            },
+            {
+                displayName: 'Presence Penalty',
+                name: 'presence_penalty',
+                default: 0,
+                typeOptions: { maxValue: 2, minValue: -2, numberPrecision: 1 },
+                description: "Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics",
+                type: 'number',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'presence_penalty',
+                    },
+                },
+            },
+            {
+                displayName: 'Sampling Temperature',
+                name: 'temperature',
+                default: 1,
+                typeOptions: { maxValue: 1, minValue: 0, numberPrecision: 1 },
+                description: 'Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.',
+                type: 'number',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'temperature',
+                    },
+                },
+            },
+            {
+                displayName: 'Top P',
+                name: 'topP',
+                default: 1,
+                typeOptions: { maxValue: 1, minValue: 0, numberPrecision: 1 },
+                description: 'Controls diversity via nucleus sampling: 0.5 means half of all likelihood-weighted options are considered. We generally recommend altering this or temperature but not both.',
+                type: 'number',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'top_p',
+                    },
+                },
+            },
+        ],
+    },
+];
+exports.chatFields = [
+    /* -------------------------------------------------------------------------- */
+    /*                               chat:complete                        */
+    /* -------------------------------------------------------------------------- */
+    ...completeOperations,
+    /* -------------------------------------------------------------------------- */
+    /*                                chat:ALL                                    */
+    /* -------------------------------------------------------------------------- */
+    ...sharedOperations,
+];

package/dist/GenericFunctions.d.ts

@@ -0,0 +1,2 @@
+import type { IExecuteSingleFunctions, IN8nHttpFullResponse, INodeExecutionData } from 'n8n-workflow';
+export declare function sendErrorPostReceive(this: IExecuteSingleFunctions, data: INodeExecutionData[], response: IN8nHttpFullResponse): Promise<INodeExecutionData[]>;

package/dist/GenericFunctions.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendErrorPostReceive = sendErrorPostReceive;
+const n8n_workflow_1 = require("n8n-workflow");
+async function sendErrorPostReceive(data, response) {
+    if (String(response.statusCode).startsWith('4') || String(response.statusCode).startsWith('5')) {
+        throw new n8n_workflow_1.NodeApiError(this.getNode(), response);
+    }
+    return data;
+}

package/dist/ImageDescription.d.ts

@@ -0,0 +1,3 @@
+import type { INodeProperties } from 'n8n-workflow';
+export declare const imageOperations: INodeProperties[];
+export declare const imageFields: INodeProperties[];