n8n-nodes-didomi 1.0.0

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright 2022 n8n
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,157 @@
+# n8n-nodes-didomi  
+
+This is an n8n community node. It lets you interact with Didomi in your n8n workflows.  
+
+Didomi specializes in privacy management solutions, enabling businesses to collect user consent, manage preferences, and ensure compliance while maintaining seamless digital experiences and building user trust.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.  
+
+[Installation](#installation)  
+[Credentials](#credentials)    
+[Operations](#operations)   
+[Using as a Tool](#using-as-a-tool)  
+[Compatibility](#compatibility)  
+[Resources](#resources)  
+
+## Installation  
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.  
+
+Alternatively, you can manually install it:  
+
+```sh  
+git clone https://github.com/elevate-agency-data/n8n-nodes-didomi.git 
+cd n8n-nodes-didomi 
+npm install  
+```  
+
+Then, place the node file in the `~/.n8n/custom-nodes` directory (or follow instructions specific to your n8n installation).   
+
+## Credentials  
+
+To use this node, you need an Didomi API key with access to Didomi.  
+
+## Operations  
+
+This node supports the following operations within Didomi:  
+
+* **Compliance Report**
+    - Creates a property
+    - Creates a report
+    - Deletes a property
+    - Gets a property
+    - Gets a report
+    - Lists all properties
+    - Lists all reports
+    - Updates a property
+* **Consent and Preference**
+    - Approves pending events
+    - Creates a consent event
+    - Creates a consent user
+    - Creates a secret
+    - Creates a token
+    - Delete a consent event
+    - Gets a consent user
+    - Gets a pending event
+    - Gets a proof
+    - Lists all consent users
+    - Lists all pending events
+    - Uploads a proof
+* **Data Manager**
+    - Adds a preference into your configuration tree
+    - Adds a purpose into your configuration tree
+    - Creates a preference
+    - Creates a purpose
+    - Deletes a preference
+    - Deletes a purpose
+    - Deletes a selected preference
+    - Deletes a selected purpose
+    - Gets a configuration tree
+    - Gets a preference
+    - Gets a purpose
+    - Gets available regulations and related information
+    - Lists all preferences
+    - Lists all purposes
+    - Lists all user rights
+    - Updates a preference
+    - Updates a purpose
+* **Privacy Request**
+    - Configures the recipients of an email
+    - Creates a link
+    - Creates a new template email
+    - Creates a note
+    - Creates a request
+    - Gets a note
+    - Gets a request
+    - Gets provider configuration schemas
+    - Lists all notes
+    - Lists all requests
+    - Updates a request
+* **Widget**
+    - Creates a consent notice
+    - Creates a widget
+    - Creates an authentication provider
+    - Deletes a widget
+    - Gets a custom theme
+    - Gets a deployment
+    - Gets a widget
+    - Gets an archived widget
+    - Gets an entity
+    - Gets the current draft configuration for a notice
+    - Lists all archived widget
+    - Lists all custom themes
+    - Lists all deployments
+    - Lists all entities
+    - Lists all widgets
+    - Publishes a widget
+    - Publishes the current draft configuration for a notice
+    - Sets a default authentication provider
+    - Updates a component
+    - Updates a custom theme
+    - Updates a widget
+    - Updates an entity
+    - Updates multiple components
+    - Updates multiple entities
+    - Updates the current draft configuration for a notice
+
+Retrieve information from the [Didomi API](https://developers.didomi.io/api/introduction). 
+
+## Using as a Tool
+
+This node can be used as a tool in n8n AI Agents. To enable community nodes as tools, you need to set the `N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE` environment variable to `true`.
+
+### Setting the Environment Variable
+
+**If you're using a bash/zsh shell:**
+```bash
+export N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
+n8n start
+```
+
+**If you're using Docker:**
+Add to your docker-compose.yml file:
+```yaml
+environment:
+  - N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
+```
+
+**If you're using the desktop app:**
+Create a `.env` file in the n8n directory:
+```
+N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
+```
+
+**If you want to set it permanently on Mac/Linux:**
+Add to your `~/.zshrc` or `~/.bash_profile`:
+```bash
+export N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
+```
+
+## Compatibility  
+
+- Tested with: 1.84.1 (Success)
+
+## Resources  
+
+- [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)  
+- [Didomi API documentation](https://developers.didomi.io/api/introduction)

package/dist/credentials/DidomiApi.credentials.d.ts

@@ -0,0 +1,10 @@
+import { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties, Icon } from 'n8n-workflow';
+export declare class DidomiApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    icon: Icon;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/DidomiApi.credentials.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DidomiApi = void 0;
+class DidomiApi {
+    constructor() {
+        this.name = 'didomiApi';
+        this.displayName = 'Didomi API';
+        this.documentationUrl = 'https://developers.didomi.io/api/introduction/authentication';
+        this.icon = 'file:icons/didomi.svg';
+        this.properties = [
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: {
+                    password: true
+                },
+                default: '',
+                required: true,
+                description: 'Private API key from the Didomi console'
+            },
+            {
+                displayName: 'API Secret',
+                name: 'apiSecret',
+                type: 'string',
+                typeOptions: {
+                    password: true
+                },
+                default: '',
+                required: true,
+                description: 'Secret API key from the Didomi console'
+            }
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+            },
+        };
+        this.test = {
+            request: {
+                method: 'POST',
+                url: 'https://api.didomi.io/v1/sessions',
+                headers: {
+                    'Content-Type': 'application/json'
+                },
+                body: {
+                    type: 'api-key',
+                    key: '={{$credentials.apiKey}}',
+                    secret: '={{$credentials.apiSecret}}'
+                },
+                json: true,
+            },
+        };
+    }
+}
+exports.DidomiApi = DidomiApi;
+//# sourceMappingURL=DidomiApi.credentials.js.map

package/dist/credentials/DidomiApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DidomiApi.credentials.js","sourceRoot":"","sources":["../../credentials/DidomiApi.credentials.ts"],"names":[],"mappings":";;;AAQA,MAAa,SAAS;IAAtB;QACC,SAAI,GAAG,WAAW,CAAC;QACnB,gBAAW,GAAG,YAAY,CAAC;QAC3B,qBAAgB,GAAG,8DAA8D,CAAC;QACjF,SAAI,GAAS,uBAAuB,CAAC;QACtC,eAAU,GAAsB;YAC7B;gBACD,WAAW,EAAE,SAAS;gBACtB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,yCAAyC;aACtD;YACD;gBACC,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,wCAAwC;aACrD;SACD,CAAC;QAEF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACJ,cAAc,EAAE,kBAAkB;iBACtC;aACD;SACD,CAAC;QAGF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACL,MAAM,EAAE,MAAM;gBACjB,GAAG,EAAE,mCAAmC;gBACxC,OAAO,EAAE;oBACJ,cAAc,EAAE,kBAAkB;iBACtC;gBACD,IAAI,EAAE;oBACL,IAAI,EAAE,SAAS;oBACf,GAAG,EAAE,0BAA0B;oBAC/B,MAAM,EAAE,6BAA6B;iBACrC;gBACD,IAAI,EAAE,IAAI;aACV;SACD,CAAC;IACH,CAAC;CAAA;AAvDD,8BAuDC"}

package/dist/credentials/icons/didomi.svg

@@ -0,0 +1,5 @@
+<svg width="132" height="132" viewBox="0 0 132 132" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect width="132" height="132" rx="66" fill="#2E62D6"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M36.5623 85.552C36.5623 85.909 36.8517 86.1984 37.2087 86.1984H54.9731C59.3008 86.1984 63.1446 85.3819 66.488 83.7294L66.4933 83.7268C69.8318 82.0383 72.4553 79.6887 74.3463 76.6785L74.3483 76.6754C76.2451 73.6172 77.1826 70.0508 77.1826 66C77.1826 61.9135 76.2458 58.3451 74.3463 55.3215C72.4549 52.3107 69.8305 49.979 66.4906 48.3277C63.1466 46.6371 59.3018 45.8015 54.9731 45.8015H37.2087C36.8517 45.8015 36.5623 46.0909 36.5623 46.4479V85.552ZM65.1984 72.095L65.1934 72.1035C64.2151 73.8156 62.8195 75.1446 60.9898 76.0951C59.1999 77.0071 57.0524 77.4759 54.5262 77.4759H46.9049V54.5241H54.5262C57.05 54.5241 59.1949 55.0105 60.9832 55.9573L60.9897 55.9607L60.9966 55.9642C62.8226 56.8772 64.216 58.1859 65.1934 59.8964L65.1969 59.9024L65.2014 59.91C66.2096 61.5787 66.7283 63.5995 66.7283 66C66.7283 68.3608 66.2106 70.3848 65.1984 72.095Z" fill="white"/>
+<path d="M85.0953 85.552C85.0953 85.909 85.3847 86.1984 85.7417 86.1984H94.7915C95.1485 86.1984 95.4379 85.909 95.4379 85.552V46.4479C95.4379 46.0909 95.1485 45.8015 94.7915 45.8015V45.8015C89.4358 45.8015 85.0936 50.142 85.0932 55.4977C85.0924 65.5158 85.0953 75.5339 85.0953 85.552Z" fill="white"/>
+</svg>

package/dist/nodes/Didomi/Didomi.node.d.ts

@@ -0,0 +1,5 @@
+import { INodeType, INodeTypeDescription, IExecuteFunctions } from 'n8n-workflow';
+export declare class Didomi implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<import("n8n-workflow").INodeExecutionData[][]>;
+}