n8n-nodes-couchbase 0.1.5 → 1.0.0

package/README.md

@@ -1,66 +1,134 @@
-N8N Nodes Couchbase
+# n8n-nodes-couchbase
 
-The Couchbase node allows you to automate documents in Couchbase. n8n has built-in support for a wide range of Couchbase features, including executing, inserting, updating, removing, importing, querying and finding documents. n8n is a free and source-available workflow automation platform.
-
-Use this connector
-
-To install a community node in your n8n instance :
-
-    		•	Go to Settings > Community Nodes :
-    		•	Select 'Install a community node'
-    		•	Type in "n8n-nodes-couchbase" and hit Install
-
-For more information on installing community nodes, visit the Community nodes docs page.
-
-Features
-
-    		•	Create documents
-    		•	Read documents
-    		•	Update documents
-    		•	Delete documents
-    		•	Import documents
-    		•	Query documents
-
-
-Couchbase Credentials
-
-Create a Couchbase account and you will need to input the following:
-
-    		•	Connection String
-
-    			1.	Couchbase Server, you can use this connection string couchbase://127.0.0.1/?connectionTimeout=1200
-
-    			2.	Couchbase Capella, you can navigate to the tab named Connect and copy the connection string.
-
-    		•	Username
-    		•	Password
-    		•	Bucket
-    		•	Scope
-    		•	Collection
-
-Those credentials are needed in order for you to connect to Couchbase.
-
-Example Usage
-
-This workflow allows you to insert a document into a Couchbase. This example usage workflow would use the following three nodes. - Start - Set - Couchbase
-
-The final workflow should look like the following image.
-
-<img width="468" alt="image" src="https://github.com/maruakinu/n8n-nodes-couchbase/assets/100325935/b7947dde-af19-4b40-9c85-b1c5716fa332">
-
-1.  Start node
-    The start node exists by default when you create a new workflow.
-
-2.  Set node
-
-        	1.	Click on the Add Value button and select 'String' from the dropdown list.
-        	2.	Enter the Property Name of the Value in the Name field.
-        	3.	Enter the value for the name in the Value field.
-        	4.	Click on Execute Node to run the node.
-
-3.  Couchbase node (Inserting Data)
-
-        	1.	Select 'Insert' from the Operation dropdown list.
-        	2.	You will have to enter credentials for the Couchbase. Click the Couchbase Node and enter your credentials.
-        	3.	At the bottom, enter the value that you want to insert in Couchbase.
-        	4.	Click on Execute Node to run the node.
+This is an n8n community node. It lets you use Couchbase in your n8n workflows.
+
+Couchbase is a distributed NoSQL cloud database that offers the robustness of a relational database with the flexibility of a JSON document database, featuring key-value operations, SQL++ querying, and powerful search capabilities.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
+
+[Installation](#installation)  
+[Operations](#operations)  
+[Credentials](#credentials)  
+[Compatibility](#compatibility)  
+[Usage](#usage)  
+[Resources](#resources)
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+## Operations
+
+The Couchbase node supports operations across two main resources:
+
+### Document & Key-Value Operations
+- **Create**: Insert a document with a specified or auto-generated ID
+- **Query**: Execute SQL++ queries to retrieve or manipulate documents
+- **Read**: Retrieve a document by its ID
+- **Upsert**: Modify an existing document identified by its ID, or create a new one if it does not exist
+- **Delete**: Remove a document by its ID
+
+### Search Operations
+- **Create Index**: Create a new search index
+- **Search & Retrieve**: Perform full-text search with multiple options:
+	- Basic search with query, fields, and limit
+	- Advanced mode with raw JSON query capabilities
+
+## Credentials
+
+To use the Couchbase node, you'll need to set up Couchbase credentials in n8n:
+
+1. **Prerequisites**:
+	- A running Couchbase cluster (using [Couchbase Capella](https://cloud.couchbase.com/) in the cloud, or Couchbase Server)
+	- [Database credentials](https://docs.couchbase.com/cloud/clusters/manage-database-users.html#create-database-credentials) with appropriate permissions for the operations you want to perform
+   - [Allow IP address](https://docs.couchbase.com/cloud/clusters/allow-ip-address.html) for your n8n instance
+
+2. **Credential Parameters**:
+	- **Connection String**: The connection string to your Couchbase server (e.g., `couchbase://localhost`)
+	- **Username**: Database access username
+	- **Password**: Database access password
+
+## Compatibility
+
+This node has been tested with n8n version 1.86.0.
+
+## Usage
+
+### Document Operations
+
+#### Creating Documents
+1. Select the **Document & Key-Value** resource
+2. Choose the **Create** operation
+3. Select your target bucket, scope, and collection
+4. You can either:
+	- Use a generated UUID for your document
+	- Specify your own document ID
+5. Enter your document content in JSON format
+
+#### Reading Documents
+1. Select the **Document & Key-Value** resource
+2. Choose the **Read** operation
+3. Select your target bucket, scope, and collection
+4. Enter the document ID to retrieve
+5. The node will return the document content if found
+
+#### Upserting Documents
+1. Select the **Document & Key-Value** resource
+2. Choose the **Upsert** operation
+3. Select your target bucket, scope, and collection
+4. Enter the document ID
+5. Provide the new JSON document content
+6. The document will be created if it doesn't exist, or updated if it does
+
+#### Deleting Documents
+1. Select the **Document & Key-Value** resource
+2. Choose the **Delete** operation
+3. Select your target bucket, scope, and collection
+4. Enter the document ID to delete
+5. The node will remove the document from the collection
+
+#### Querying Documents with SQL++
+1. Select the **Document & Key-Value** resource
+2. Choose the **Query** operation
+3. Optionally select a bucket and scope context
+4. Enter your SQL++ query
+	 ```sql
+	 SELECT * FROM `travel-sample`.inventory.hotel WHERE country = "United States"
+	 ```
+
+### Search Operations
+
+#### Full-Text Search
+1. Select the **Search** resource
+2. Choose the **Search & Retrieve** operation
+3. Enter the index name (format: `bucket.scope.index-name`)
+4. Enter your search query
+5. Configure optional parameters:
+	- Fields to return (comma-separated)
+	- Results limit
+	- Include term locations option
+
+#### Advanced Search
+1. Enable **Advanced Mode**
+2. Enter a raw JSON query for more complex search requirements:
+	 ```json
+	 {
+		 "query": {
+			 "match": "California"
+		 },
+		 "size": 5,
+		 "from": 0
+	 }
+	 ```
+
+#### Creating Search Indexes
+1. Select the **Search** resource
+2. Choose the **Create Index** operation
+3. Enter the index definition as a JSON object
+
+## Resources
+
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
+* [Couchbase Documentation](https://docs.couchbase.com/)
+* [Couchbase Node.js SDK](https://docs.couchbase.com/nodejs-sdk/current/hello-world/start-using-sdk.html)
+* [Couchbase Search Service](https://docs.couchbase.com/server/current/search/search-intro.html)

package/dist/credentials/CouchbaseApi.credentials.d.ts

@@ -0,0 +1,8 @@
+import { Icon, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class CouchbaseApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    icon: Icon;
+    properties: INodeProperties[];
+}

package/dist/credentials/CouchbaseApi.credentials.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CouchbaseApi = void 0;
+class CouchbaseApi {
+    constructor() {
+        this.name = 'couchbaseApi';
+        this.displayName = 'Couchbase Credentials API';
+        this.documentationUrl = 'https://github.com/Couchbase-Ecosystem/n8n-nodes-couchbase?tab=readme-ov-file#credentials';
+        this.icon = {
+            light: 'file:../nodes/Couchbase/couchbase.svg',
+            dark: 'file:../nodes/Couchbase/couchbase.dark.svg',
+        };
+        this.properties = [
+            {
+                displayName: 'Connection String',
+                name: 'couchbaseConnectionString',
+                type: 'string',
+                default: '',
+            },
+            {
+                displayName: 'Username',
+                name: 'couchbaseUsername',
+                type: 'string',
+                default: '',
+            },
+            {
+                displayName: 'Password',
+                name: 'couchbasePassword',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+            },
+        ];
+    }
+}
+exports.CouchbaseApi = CouchbaseApi;
+//# sourceMappingURL=CouchbaseApi.credentials.js.map

package/dist/credentials/CouchbaseApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CouchbaseApi.credentials.js","sourceRoot":"","sources":["../../credentials/CouchbaseApi.credentials.ts"],"names":[],"mappings":";;;AAEA,MAAa,YAAY;IAAzB;QACC,SAAI,GAAG,cAAc,CAAC;QACtB,gBAAW,GAAG,2BAA2B,CAAC;QAC1C,qBAAgB,GACf,2FAA2F,CAAC;QAC7F,SAAI,GAAS;YACZ,KAAK,EAAE,uCAAuC;YAC9C,IAAI,EAAE,4CAA4C;SAClD,CAAC;QACF,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,mBAAmB;gBAChC,IAAI,EAAE,2BAA2B;gBACjC,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACX;YACD;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACX;YACD;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;aACX;SACD,CAAC;IACH,CAAC;CAAA;AAhCD,oCAgCC"}

package/dist/credentials/ExampleCredentialsApi.credentials.d.ts

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

package/dist/credentials/ExampleCredentialsApi.credentials.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExampleCredentialsApi = void 0;
+class ExampleCredentialsApi {
+    constructor() {
+        this.name = 'exampleCredentialsApi';
+        this.displayName = 'Example Credentials API';
+        this.properties = [
+            {
+                displayName: 'User Name',
+                name: 'username',
+                type: 'string',
+                default: '',
+            },
+            {
+                displayName: 'Password',
+                name: 'password',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                auth: {
+                    username: '={{ $credentials.username }}',
+                    password: '={{ $credentials.password }}',
+                },
+                qs: {
+                    n8n: 'rocks',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: 'https://example.com/',
+                url: '',
+            },
+        };
+    }
+}
+exports.ExampleCredentialsApi = ExampleCredentialsApi;
+//# sourceMappingURL=ExampleCredentialsApi.credentials.js.map

package/dist/credentials/ExampleCredentialsApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleCredentialsApi.credentials.js","sourceRoot":"","sources":["../../credentials/ExampleCredentialsApi.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,qBAAqB;IAAlC;QACC,SAAI,GAAG,uBAAuB,CAAC;QAC/B,gBAAW,GAAG,yBAAyB,CAAC;QACxC,eAAU,GAAsB;YAI/B;gBACC,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACX;YACD;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;gBACD,OAAO,EAAE,EAAE;aACX;SACD,CAAC;QAKF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,IAAI,EAAE;oBACL,QAAQ,EAAE,8BAA8B;oBACxC,QAAQ,EAAE,8BAA8B;iBACxC;gBACD,EAAE,EAAE;oBAEH,GAAG,EAAE,OAAO;iBACZ;aACD;SACD,CAAC;QAGF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,sBAAsB;gBAC/B,GAAG,EAAE,EAAE;aACP;SACD,CAAC;IACH,CAAC;CAAA;AAhDD,sDAgDC"}

package/dist/credentials/HttpBinApi.credentials.d.ts

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

package/dist/credentials/HttpBinApi.credentials.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpBinApi = void 0;
+class HttpBinApi {
+    constructor() {
+        this.name = 'httpbinApi';
+        this.displayName = 'HttpBin API';
+        this.documentationUrl = 'https://example.com/docs';
+        this.properties = [
+            {
+                displayName: 'Token',
+                name: 'token',
+                type: 'string',
+                default: '',
+                typeOptions: {
+                    password: true,
+                }
+            },
+            {
+                displayName: 'Domain',
+                name: 'domain',
+                type: 'string',
+                default: 'https://httpbin.org',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '={{"Bearer " + $credentials.token}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials?.domain}}',
+                url: '/bearer',
+            },
+        };
+    }
+}
+exports.HttpBinApi = HttpBinApi;
+//# sourceMappingURL=HttpBinApi.credentials.js.map

package/dist/credentials/HttpBinApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpBinApi.credentials.js","sourceRoot":"","sources":["../../credentials/HttpBinApi.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,UAAU;IAAvB;QACC,SAAI,GAAG,YAAY,CAAC;QACpB,gBAAW,GAAG,aAAa,CAAC;QAC5B,qBAAgB,GAAG,0BAA0B,CAAC;QAC9C,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,OAAO;gBACpB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE;oBACZ,QAAQ,EAAE,IAAI;iBACd;aACD;YACD;gBACC,WAAW,EAAE,QAAQ;gBACrB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,qBAAqB;aAC9B;SACD,CAAC;QAMF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,aAAa,EAAE,qCAAqC;iBACpD;aACD;SACD,CAAC;QAGF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,OAAO,EAAE,2BAA2B;gBACpC,GAAG,EAAE,SAAS;aACd;SACD,CAAC;IACH,CAAC;CAAA;AA1CD,gCA0CC"}

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

@@ -0,0 +1,35 @@
+import { ICredentialsDecrypted, ICredentialTestFunctions, IExecuteFunctions, ILoadOptionsFunctions, INodeCredentialTestResult, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+declare function couchbaseBucketSearch(this: ILoadOptionsFunctions): Promise<{
+    results: {
+        name: string;
+        value: string;
+    }[];
+}>;
+declare function couchbaseScopeSearch(this: ILoadOptionsFunctions): Promise<{
+    results: {
+        name: string;
+        value: string;
+    }[];
+}>;
+declare function couchbaseCollectionSearch(this: ILoadOptionsFunctions): Promise<{
+    results: {
+        name: string;
+        value: string;
+    }[];
+}>;
+declare function couchbaseCredentialTest(this: ICredentialTestFunctions, credential: ICredentialsDecrypted): Promise<INodeCredentialTestResult>;
+export declare class Couchbase implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        credentialTest: {
+            couchbaseCredentialTest: typeof couchbaseCredentialTest;
+        };
+        listSearch: {
+            couchbaseBucketSearch: typeof couchbaseBucketSearch;
+            couchbaseScopeSearch: typeof couchbaseScopeSearch;
+            couchbaseCollectionSearch: typeof couchbaseCollectionSearch;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+export {};