n8n-nodes-appwriten8n - npm Package Compare versions

Comparing version 0.1.4 to 0.1.5

dist/nodes/Appwrite/Appwrite.node.js

@@ -25,2 +25,8 @@ "use strict";
             outputs: ['main'],
+            credentials: [
+                {
+                    name: "appwriteApi",
+                    required: false,
+                },
+            ],
             properties: [
@@ -27,0 +33,0 @@ {

dist/nodes/Appwrite/DocumentDescription.js

@@ -145,3 +145,154 @@ "use strict";
     },
+    {
+        displayName: 'Queries',
+        name: 'queries',
+        type: 'fixedCollection',
+        placeholder: 'Add Query',
+        description: 'Queries to filter the documents by. [learn more about filtering](https://appwrite.io/docs/filters).',
+        typeOptions: {
+            multipleValues: true,
+        },
+        default: {},
+        displayOptions: {
+            show: {
+                operation: [
+                    'getAllDocs',
+                    'getDoc',
+                ],
+                resource: [
+                    'document',
+                ],
+            },
+        },
+        options: [
+            {
+                displayName: 'Index to Select',
+                name: 'index',
+                type: 'string',
+                default: '',
+                description: 'Index to select, if needed',
+                requiresDataPath: 'single',
+            },
+            {
+                displayName: 'Value 1',
+                name: 'value1',
+                type: 'string',
+                default: '',
+                requiresDataPath: 'multiple',
+                description: 'First value for queries, such as what the index is equal to, or the first value of a between',
+            },
+            {
+                displayName: 'Value 2',
+                name: 'value2',
+                type: 'string',
+                default: '',
+                requiresDataPath: 'single',
+                description: 'Second value for between and a few other queries, ignore if not needed',
+            },
+            {
+                displayName: 'Query',
+                name: 'query',
+                type: 'options',
+                default: 'equal',
+                options: [
+                    {
+                        name: 'Between',
+                        value: 'between',
+                        description: 'Returns document if attribute value falls between the two values. The boundary values are inclusive and can be strings or numbers.',
+                    },
+                    {
+                        name: 'Cursor After',
+                        value: 'cursor_after',
+                        description: 'Places the cursor after the specified resource ID. Used for pagination.',
+                    },
+                    {
+                        name: 'Cursor Before',
+                        value: 'cursor_before',
+                        description: 'Places the cursor before the specified resource ID. Used for pagination.',
+                    },
+                    {
+                        name: 'Ends With',
+                        value: 'ends_with',
+                        description: 'Returns documents if a string attributes ends with a substring',
+                    },
+                    {
+                        name: 'Equal',
+                        value: 'equal',
+                        description: 'Returns document if attribute is equal to any value in the provided array',
+                    },
+                    {
+                        name: 'Greater Than',
+                        value: 'greater_than',
+                        description: 'Returns document if attribute is greater than the provided value',
+                    },
+                    {
+                        name: 'Greater Than or Equal',
+                        value: 'greater_than_or_equal',
+                        description: 'Returns document if attribute is greater than or equal to the provided value',
+                    },
+                    {
+                        name: 'Is Not Null',
+                        value: 'is_not_null',
+                        description: 'Returns documents where attribute value is not null',
+                    },
+                    {
+                        name: 'Is Null',
+                        value: 'is_null',
+                        description: 'Returns documents where attribute value is null',
+                    },
+                    {
+                        name: 'Less Than',
+                        value: 'less_than',
+                        description: 'Returns document if attribute is less than the provided value',
+                    },
+                    {
+                        name: 'Less Than or Equal',
+                        value: 'less_than_or_equal',
+                        description: 'Returns document if attribute is less than or equal to the provided value',
+                    },
+                    {
+                        name: 'Limit',
+                        value: 'limit',
+                        description: 'Limits the number of results returned by the query. Used for pagination. If the limit query is not used, the limit defaults to 25 results.',
+                    },
+                    {
+                        name: 'Not Equal',
+                        value: 'not_equal',
+                        description: 'Returns document if attribute is not equal to any value in the provided array',
+                    },
+                    {
+                        name: 'Offset',
+                        value: 'offset',
+                        description: 'Offset the results returned by skipping some of the results. Used for pagination.',
+                    },
+                    {
+                        name: 'Order Ascending',
+                        value: 'order_ascending',
+                        description: 'Orders results in ascending order by attribute. Attribute must be indexed. Pass in an empty string to return in natural order.',
+                    },
+                    {
+                        name: 'Order Descending',
+                        value: 'order_descending',
+                        description: 'Orders results in descending order by attribute. Attribute must be indexed. Pass in an empty string to return in natural order.',
+                    },
+                    {
+                        name: 'Search',
+                        value: 'search',
+                        description: 'Searches string attributes for provided keywords. Requires a Full-text index on queried attributes.',
+                    },
+                    {
+                        name: 'Select',
+                        value: 'select',
+                        description: 'Select which attributes should be returned from a document',
+                    },
+                    {
+                        name: 'Starts With',
+                        value: 'starts_with',
+                        description: 'Returns documents if a string attributes starts with a substring',
+                    },
+                ],
+            },
+        ],
+    },
 ];
 //# sourceMappingURL=DocumentDescription.js.map

dist/package.json

 {
     "name": "n8n-nodes-appwriten8n",
-    "version": "0.1.4",
+    "version": "0.1.5",
     "description": "N8N Nodes for Appwrite starting at 1.4.X and up, will be updated.",
@@ -5,0 +5,0 @@ "keywords": [

package.json

 {
   "name": "n8n-nodes-appwriten8n",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "N8N Nodes for Appwrite starting at 1.4.X and up, will be updated.",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -23,32 +23,60 @@ # n8n-nodes-appwrite
 
-<p align="center">
-    <a href="https://n8n.io" target="_blank"><img width="600" height="" src="/n8n-appwrite-node.png" alt="appwrite-node"></a>
-    <br />
-    <br />
-</p>
+This is an n8n community node. It lets you use _Appwrite_ in your n8n workflows.
 
-## How to install
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
 
-For most, you'll install by simply going to your n8n instance, Settings -> Community Nodes, and then add
-this package name `n8n-nodes-appwriten8n`
+[Installation](#installation)
+[Operations](#operations)
+[Credentials](#credentials)  <!-- delete if no auth needed -->
+[Compatibility](#compatibility)
+[Resources](#resources)
 
-To get started install the package in your n8n root directory with
+## Installation
 
-`npm install n8n-nodes-appwriten8n`
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
 
+## Operations
 
-For docker add the following line before the font installation command in your [n8n Docker file](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/Dockerfile)
-`RUN cd /usr/local/lib/node_modules/n8n && npm install n8n-nodes-appwrite`
+- Documents
+  - Get (by ID or with Queries)
+  - Create
+  - Update
+  - Delete
+  - Get All (incl. with Queries)
+- Functions
+  - List All
+  - Get by ID
+  - Execute and Output Result
+- Storage
+  - Create Bucket
+  - Delete Bucket
+  - Get Bucket by ID
+  - List Buckets
+  - List Files
+  - Get File by ID
+  - Create File
+  - Delete File
 
-For existing N8N Installations simply go to Settings -> Community Packages and input `n8n-appwrite`
+## Credentials
 
-## 🔗 Connect with me
+1. Make sure you have an instance of Appwrite, either self-hosted or on Cloud at https://cloud.appwrite.io
+2. Once in, create a project, and then scroll down and create an API key
+3. Give it all securities you wish, only Functions, Databases, and Storage is required to use all functionality, however I will update it with more functionality as we go
+4. After creating your API key, go to Credentials and create a new Appwrite API credential, and paste in
+`https://cloud.appwrite.io/v1` for your endpoint URL if you used Appwrite Cloud, otherwise use your endpoint
+5. Put in your Project ID by copying it
+6. Paste in your API key
+7. You're good to go!
 
-[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/zachhandley)
+## Compatibility
 
-[My Website](https://zachhandley.com)
+- Currently up to date with N8N, Appwrite 1.4.x is required
 
+## Resources
 
-## License
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
+* [appwrite website and documentation](https://appwrite.io)
+* [github repository](https://github.com/zachhandley/n8n-nodes-appwrite)
+* [my website](https://zachhandley.com)
 
-[Apache 2.0 with Commons Clause](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/LICENSE.md)
+

No alert changes

Improved metrics

Total package byte prevSize

141803

increased by7.99%

Number of package files

26

increased by4%

Lines of code

1254

increased by15.26%

Number of lines in readme file

82

increased by51.85%

No dependency changes