@growsalesai/n8n-nodes-supermemory 0.1.3 → 0.2.0

package/dist/nodes/Supermemory/descriptions/DocumentDescription.js

@@ -16,33 +16,117 @@ exports.documentOperations = [
             {
                 name: 'Add',
                 value: 'add',
-                description: 'Add a new document to Supermemory',
+                description: 'Add a single document (text, URL, PDF, image, or video)',
                 action: 'Add a document',
             },
             {
-                name: 'Update',
-                value: 'update',
-                description: 'Update an existing document by ID',
-                action: 'Update a document',
+                name: 'Batch Add',
+                value: 'batchAdd',
+                description: 'Add multiple documents in a single request — each input item becomes one document (up to 600)',
+                action: 'Batch add documents',
+            },
+            {
+                name: 'Batch Delete',
+                value: 'batchDelete',
+                description: 'Delete multiple documents — each input item\'s Document ID gets deleted',
+                action: 'Batch delete documents',
+            },
+            {
+                name: 'Batch Update',
+                value: 'batchUpdate',
+                description: 'Update multiple documents — each input item is updated independently',
+                action: 'Batch update documents',
+            },
+            {
+                name: 'Copy',
+                value: 'copy',
+                description: 'Copy a document to a different container tag',
+                action: 'Copy a document',
+            },
+            {
+                name: 'Delete',
+                value: 'delete',
+                description: 'Permanently delete a document by ID',
+                action: 'Delete a document',
+            },
+            {
+                name: 'Get',
+                value: 'get',
+                description: 'Retrieve a single document by ID with full content',
+                action: 'Get a document',
+            },
+            {
+                name: 'Get Chunks',
+                value: 'getChunks',
+                description: 'Retrieve all semantic chunks for one or all documents',
+                action: 'Get document chunks',
             },
             {
                 name: 'List',
                 value: 'list',
-                description: 'List all documents with optional filtering',
+                description: 'List all documents with optional filtering and pagination',
                 action: 'List documents',
             },
             {
                 name: 'Search',
                 value: 'search',
-                description: 'Semantic search across stored documents',
+                description: 'Semantic search across stored documents using natural language',
                 action: 'Search documents',
             },
+            {
+                name: 'Update',
+                value: 'update',
+                description: 'Update content, container tag, or metadata of an existing document',
+                action: 'Update a document',
+            },
         ],
         default: 'add',
     },
 ];
+// ─── Shared metadata collection sub-fields ──────────────────────────────────
+const metadataCollection = {
+    displayName: 'Metadata',
+    name: 'metadata',
+    type: 'fixedCollection',
+    typeOptions: { multipleValues: true },
+    placeholder: 'Add Metadata Field',
+    default: {},
+    description: 'Custom key-value metadata for filtering and context. Values are auto-cast to boolean, number, or string.',
+    options: [
+        {
+            name: 'metadataValues',
+            displayName: 'Metadata',
+            values: [
+                {
+                    displayName: 'Key',
+                    name: 'key',
+                    type: 'string',
+                    default: '',
+                    placeholder: 'e.g. category',
+                },
+                {
+                    displayName: 'Value',
+                    name: 'value',
+                    type: 'string',
+                    default: '',
+                    placeholder: 'e.g. blog',
+                },
+            ],
+        },
+    ],
+};
+const taskTypeOptions = [
+    {
+        name: 'Memory (Default) — Full Context Layer with SuperRAG',
+        value: 'memory',
+    },
+    {
+        name: 'SuperRAG — Managed RAG Service Only',
+        value: 'superrag',
+    },
+];
 exports.documentFields = [
-    // ─── ADD DOCUMENT ───────────────────────────────────────────────
+    // ─── ADD DOCUMENT ─────────────────────────────────────────────────
     {
         displayName: 'Content',
         name: 'content',
@@ -53,7 +137,8 @@ exports.documentFields = [
         displayOptions: {
             show: { resource: ['document'], operation: ['add'] },
         },
-        description: 'Content to process — can be text, a URL, a PDF link, an image URL, or a video URL',
+        description: 'The document to save. Can be plain text, a web URL, a PDF link, an image URL, or a video URL — Supermemory handles ingestion automatically.',
+        placeholder: 'Paste text or enter a URL (https://...)',
     },
     {
         displayName: 'Additional Fields',
@@ -66,12 +151,74 @@ exports.documentFields = [
         },
         options: [
             {
-                displayName: 'Container Tag',
+                displayName: 'Container Tag Name or ID',
                 name: 'containerTag',
+                type: 'options',
+                typeOptions: { loadOptionsMethod: 'getContainerTags' },
+                default: '',
+                description: 'Namespace to organise documents (e.g. a user ID, project name, or topic). Choose from the list or type a new value via expression. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
+            },
+            {
+                displayName: 'Custom ID',
+                name: 'customId',
                 type: 'string',
                 default: '',
-                description: 'Namespace to organise documents (alphanumeric, hyphens, underscores, dots — max 100 chars)',
-                placeholder: 'e.g. user-123 or project-abc',
+                description: 'Your own identifier for this document — useful for referencing it without storing the Supermemory ID (max 100 chars)',
+                placeholder: 'e.g. article-42 or user-123-note',
+            },
+            {
+                displayName: 'Entity Context',
+                name: 'entityContext',
+                type: 'string',
+                typeOptions: { rows: 3 },
+                default: '',
+                description: 'Processing guidance passed to the model when ingesting this document — describes the entity or user this document belongs to (max 1500 chars)',
+                placeholder: 'e.g. This document belongs to user John Doe, a software engineer who prefers concise answers.',
+            },
+            {
+                ...metadataCollection,
+            },
+            {
+                displayName: 'Task Type',
+                name: 'taskType',
+                type: 'options',
+                options: taskTypeOptions,
+                default: 'memory',
+                description: 'Processing pipeline to use for this document',
+            },
+        ],
+    },
+    // ─── BATCH ADD DOCUMENTS ─────────────────────────────────────────
+    {
+        displayName: 'Content',
+        name: 'content',
+        type: 'string',
+        typeOptions: { rows: 4 },
+        required: true,
+        default: '',
+        displayOptions: {
+            show: { resource: ['document'], operation: ['batchAdd'] },
+        },
+        description: 'Content for this document — text, URL, PDF link, image, or video URL. Each input item becomes one document in the batch (up to 600 items).',
+        placeholder: 'Paste text or enter a URL (https://...)',
+    },
+    {
+        displayName: 'Document Fields',
+        name: 'batchDocumentFields',
+        type: 'collection',
+        placeholder: 'Add Field',
+        default: {},
+        displayOptions: {
+            show: { resource: ['document'], operation: ['batchAdd'] },
+        },
+        options: [
+            {
+                displayName: 'Container Tag Name or ID',
+                name: 'containerTag',
+                type: 'options',
+                typeOptions: { loadOptionsMethod: 'getContainerTags' },
+                default: '',
+                description: 'Container tag for this document. Choose from the list or use an expression. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
             },
             {
                 displayName: 'Custom ID',
@@ -86,61 +233,155 @@ exports.documentFields = [
                 type: 'string',
                 typeOptions: { rows: 3 },
                 default: '',
-                description: 'Processing guidance passed to the model when ingesting this document (max 1500 chars)',
+                description: 'Processing guidance for the model (max 1500 chars)',
             },
             {
-                displayName: 'Metadata',
-                name: 'metadata',
-                type: 'fixedCollection',
-                typeOptions: { multipleValues: true },
-                placeholder: 'Add Metadata Field',
-                default: {},
-                options: [
-                    {
-                        name: 'metadataValues',
-                        displayName: 'Metadata',
-                        values: [
-                            {
-                                displayName: 'Key',
-                                name: 'key',
-                                type: 'string',
-                                default: '',
-                                description: 'Metadata field name',
-                            },
-                            {
-                                displayName: 'Value',
-                                name: 'value',
-                                type: 'string',
-                                default: '',
-                                description: 'Metadata field value (string, number, or boolean)',
-                            },
-                        ],
-                    },
-                ],
-                description: 'Custom key-value metadata for filtering and context',
+                ...metadataCollection,
             },
             {
                 displayName: 'Task Type',
                 name: 'taskType',
                 type: 'options',
-                options: [
-                    {
-                        name: 'Memory (Default)',
-                        value: 'memory',
-                        description: 'Full context layer with SuperRAG',
-                    },
-                    {
-                        name: 'SuperRAG',
-                        value: 'superrag',
-                        description: 'Managed RAG service only',
-                    },
-                ],
+                options: taskTypeOptions,
                 default: 'memory',
-                description: 'Processing pipeline to use for this document',
+                description: 'Processing pipeline for this document',
+            },
+        ],
+    },
+    // ─── BATCH DELETE DOCUMENTS ───────────────────────────────────────
+    {
+        displayName: 'Document ID',
+        name: 'documentId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: {
+            show: { resource: ['document'], operation: ['batchDelete'] },
+        },
+        description: 'Unique identifier of the document to delete. Each input item deletes one document — use an expression to map from upstream data.',
+    },
+    // ─── BATCH UPDATE DOCUMENTS ───────────────────────────────────────
+    {
+        displayName: 'Document ID',
+        name: 'documentId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: {
+            show: { resource: ['document'], operation: ['batchUpdate'] },
+        },
+        description: 'ID of the document to update. Each input item updates one document independently.',
+    },
+    {
+        displayName: 'Update Fields',
+        name: 'batchUpdateFields',
+        type: 'collection',
+        placeholder: 'Add Field',
+        default: {},
+        displayOptions: {
+            show: { resource: ['document'], operation: ['batchUpdate'] },
+        },
+        options: [
+            {
+                displayName: 'Container Tag Name or ID',
+                name: 'containerTag',
+                type: 'options',
+                typeOptions: { loadOptionsMethod: 'getContainerTags' },
+                default: '',
+                description: 'Move the document to this container tag. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
+            },
+            {
+                displayName: 'Content',
+                name: 'content',
+                type: 'string',
+                typeOptions: { rows: 4 },
+                default: '',
+                description: 'Replace the document content — text, URL, PDF, image, or video',
+            },
+            {
+                displayName: 'Custom ID',
+                name: 'customId',
+                type: 'string',
+                default: '',
+                description: 'New custom identifier for this document',
+            },
+            {
+                ...metadataCollection,
+            },
+            {
+                displayName: 'Task Type',
+                name: 'taskType',
+                type: 'options',
+                options: taskTypeOptions,
+                default: 'memory',
+            },
+        ],
+    },
+    // ─── COPY DOCUMENT ───────────────────────────────────────────────
+    {
+        displayName: 'Document ID',
+        name: 'documentId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: {
+            show: { resource: ['document'], operation: ['copy'] },
+        },
+        description: 'ID of the document to copy',
+    },
+    {
+        displayName: 'Target Container Tag Name or ID',
+        name: 'copyTargetTag',
+        type: 'options',
+        typeOptions: { loadOptionsMethod: 'getContainerTags' },
+        required: true,
+        default: '',
+        displayOptions: {
+            show: { resource: ['document'], operation: ['copy'] },
+        },
+        description: 'Container tag where the copy will be created. Choose from the list or use an expression. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
+    },
+    {
+        displayName: 'Options',
+        name: 'copyOptions',
+        type: 'collection',
+        placeholder: 'Add Option',
+        default: {},
+        displayOptions: {
+            show: { resource: ['document'], operation: ['copy'] },
+        },
+        options: [
+            {
+                displayName: 'Copy Metadata',
+                name: 'copyMetadata',
+                type: 'boolean',
+                default: true,
+                description: 'Whether to copy the source document\'s metadata to the new document',
+            },
+            {
+                displayName: 'Custom ID for Copy',
+                name: 'customId',
+                type: 'string',
+                default: '',
+                description: 'Custom ID for the copied document. Leave empty to auto-generate from the source ID.',
+                placeholder: 'e.g. copy-of-article-42',
             },
         ],
     },
-    // ─── UPDATE DOCUMENT ────────────────────────────────────────────
+    // ─── GET DOCUMENT ─────────────────────────────────────────────────
+    {
+        displayName: 'Document ID',
+        name: 'documentId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: {
+            show: { resource: ['document'], operation: ['get'] },
+        },
+        description: 'Unique ID (or customId) of the document to retrieve',
+        placeholder: 'e.g. doc_abc123 or my-custom-ID',
+    },
+    // ─── UPDATE DOCUMENT ─────────────────────────────────────────────
     {
         displayName: 'Document ID',
         name: 'documentId',
@@ -150,7 +391,7 @@ exports.documentFields = [
         displayOptions: {
             show: { resource: ['document'], operation: ['update'] },
         },
-        description: 'Unique identifier of the document to update',
+        description: 'Unique ID of the document to update',
     },
     {
         displayName: 'Update Fields',
@@ -163,11 +404,12 @@ exports.documentFields = [
         },
         options: [
             {
-                displayName: 'Container Tag',
+                displayName: 'Container Tag Name or ID',
                 name: 'containerTag',
-                type: 'string',
+                type: 'options',
+                typeOptions: { loadOptionsMethod: 'getContainerTags' },
                 default: '',
-                description: 'New container tag for the document',
+                description: 'Move the document to this container tag. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
             },
             {
                 displayName: 'Content',
@@ -182,55 +424,71 @@ exports.documentFields = [
                 name: 'customId',
                 type: 'string',
                 default: '',
-                description: 'New custom identifier',
+                description: 'New custom identifier for this document',
             },
             {
-                displayName: 'Metadata',
-                name: 'metadata',
-                type: 'fixedCollection',
-                typeOptions: { multipleValues: true },
-                placeholder: 'Add Metadata Field',
-                default: {},
-                options: [
-                    {
-                        name: 'metadataValues',
-                        displayName: 'Metadata',
-                        values: [
-                            {
-                                displayName: 'Key',
-                                name: 'key',
-                                type: 'string',
-                                default: '',
-                            },
-                            {
-                                displayName: 'Value',
-                                name: 'value',
-                                type: 'string',
-                                default: '',
-                            },
-                        ],
-                    },
-                ],
+                ...metadataCollection,
             },
             {
                 displayName: 'Task Type',
                 name: 'taskType',
                 type: 'options',
-                options: [
-                    { name: 'Memory', value: 'memory' },
-                    { name: 'SuperRAG', value: 'superrag' },
-                ],
+                options: taskTypeOptions,
                 default: 'memory',
             },
         ],
     },
-    // ─── LIST DOCUMENTS ─────────────────────────────────────────────
+    // ─── DELETE DOCUMENT ─────────────────────────────────────────────
+    {
+        displayName: 'Document ID',
+        name: 'documentId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: {
+            show: { resource: ['document'], operation: ['delete'] },
+        },
+        description: 'Unique ID (or customId) of the document to permanently delete',
+    },
+    // ─── LIST DOCUMENTS ──────────────────────────────────────────────
+    {
+        displayName: 'Return All',
+        name: 'returnAll',
+        type: 'boolean',
+        default: false,
+        displayOptions: {
+            show: { resource: ['document'], operation: ['list'] },
+        },
+        description: 'Whether to return all results or only up to a given limit',
+    },
+    {
+        displayName: 'Limit',
+        name: 'limit',
+        type: 'number',
+        typeOptions: { minValue: 1 },
+        default: 50,
+        displayOptions: {
+            show: { resource: ['document'], operation: ['list'] },
+        },
+        description: 'Max number of results to return',
+    },
     {
-        displayName: 'Container Tags',
+        displayName: 'Page',
+        name: 'page',
+        type: 'number',
+        typeOptions: { minValue: 1 },
+        default: 1,
+        displayOptions: {
+            show: { resource: ['document'], operation: ['list'], returnAll: [false] },
+        },
+        description: 'Page number to retrieve (starts at 1)',
+    },
+    {
+        displayName: 'Filter by Container Tag(s)',
         name: 'containerTagsList',
         type: 'fixedCollection',
         typeOptions: { multipleValues: true },
-        placeholder: 'Add Container Tag',
+        placeholder: 'Add Container Tag Filter',
         default: {},
         displayOptions: {
             show: { resource: ['document'], operation: ['list'] },
@@ -241,29 +499,93 @@ exports.documentFields = [
                 displayName: 'Tags',
                 values: [
                     {
-                        displayName: 'Container Tag',
+                        displayName: 'Container Tag Name or ID',
                         name: 'tag',
-                        type: 'string',
+                        type: 'options',
+                        typeOptions: { loadOptionsMethod: 'getContainerTags' },
                         default: '',
-                        placeholder: 'e.g. user-123',
+                        description: 'Filter documents by this container tag. Choose from the list or use an expression. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
                     },
                 ],
             },
         ],
-        description: 'Filter documents by container tag(s)',
+        description: 'Show only documents from these container tag(s). Leave empty to list all.',
     },
     {
-        displayName: 'Filters (JSON)',
+        displayName: 'Advanced Filters (JSON)',
         name: 'filtersJson',
         type: 'json',
         default: '',
         displayOptions: {
             show: { resource: ['document'], operation: ['list'] },
         },
-        description: 'Advanced filters as JSON. Supports nested AND/OR logic with metadata, numeric, array_contains, and string_contains filter types.',
+        description: 'Filter documents by metadata using nested AND/OR logic',
+        hint: 'Supports metadata, numeric, array_contains, and string_contains filter types.',
         placeholder: '{"AND":[{"key":"category","value":"blog","filterType":"metadata"}]}',
     },
-    // ─── SEARCH DOCUMENTS ───────────────────────────────────────────
+    // ─── GET DOCUMENT CHUNKS ─────────────────────────────────────────
+    {
+        displayName: 'Source',
+        name: 'chunksSource',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: {
+            show: { resource: ['document'], operation: ['getChunks'] },
+        },
+        options: [
+            {
+                name: 'By Document ID',
+                value: 'byId',
+                description: 'Retrieve chunks for a single specific document',
+            },
+            {
+                name: 'All Documents',
+                value: 'allDocuments',
+                description: 'Fetch and aggregate chunks for every document in your account (or within a container tag)',
+            },
+        ],
+        default: 'byId',
+    },
+    {
+        displayName: 'Document ID',
+        name: 'documentId',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: {
+            show: { resource: ['document'], operation: ['getChunks'], chunksSource: ['byId'] },
+        },
+        description: 'ID of the document to retrieve chunks for',
+    },
+    {
+        displayName: 'Options',
+        name: 'chunksAllOptions',
+        type: 'collection',
+        placeholder: 'Add Option',
+        default: {},
+        displayOptions: {
+            show: { resource: ['document'], operation: ['getChunks'], chunksSource: ['allDocuments'] },
+        },
+        options: [
+            {
+                displayName: 'Container Tag Name or ID',
+                name: 'containerTag',
+                type: 'options',
+                typeOptions: { loadOptionsMethod: 'getContainerTags' },
+                default: '',
+                description: 'Limit chunk retrieval to documents within this container tag. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
+            },
+            {
+                displayName: 'Max Documents',
+                name: 'maxDocuments',
+                type: 'number',
+                typeOptions: { minValue: 1, maxValue: 1100 },
+                default: 100,
+                description: 'Maximum number of documents to fetch chunks for',
+            },
+        ],
+    },
+    // ─── SEARCH DOCUMENTS ────────────────────────────────────────────
     {
         displayName: 'Query',
         name: 'query',
@@ -273,8 +595,8 @@ exports.documentFields = [
         displayOptions: {
             show: { resource: ['document'], operation: ['search'] },
         },
-        description: 'Natural language query to search documents semantically',
-        placeholder: 'e.g. machine learning best practices',
+        description: 'Natural language query to find relevant documents by semantic meaning — not just keyword matches',
+        placeholder: 'e.g. machine learning best practices for production',
     },
     {
         displayName: 'Additional Fields',
@@ -287,11 +609,12 @@ exports.documentFields = [
         },
         options: [
             {
-                displayName: 'Container Tag',
-                name: 'containerTag',
-                type: 'string',
+                displayName: 'Advanced Filters (JSON)',
+                name: 'filtersJson',
+                type: 'json',
                 default: '',
-                description: 'Limit search to a single container tag',
+                description: 'Filter results by metadata using JSON. Supports AND/OR logic.',
+                placeholder: '{"AND":[{"key":"author","value":"john","filterType":"metadata"}]}',
             },
             {
                 displayName: 'Chunk Threshold',
@@ -299,22 +622,30 @@ exports.documentFields = [
                 type: 'number',
                 typeOptions: { minValue: 0, maxValue: 1, numberStepSize: 0.05 },
                 default: 0,
-                description: 'Score threshold for chunk selection (0–1). Only chunks above this score are returned.',
+                description: 'Minimum relevance score for returned chunks (0–1). Raise this to get fewer but higher-quality matches.',
+            },
+            {
+                displayName: 'Container Tag Name or ID',
+                name: 'containerTag',
+                type: 'options',
+                typeOptions: { loadOptionsMethod: 'getContainerTags' },
+                default: '',
+                description: 'Limit search to a single container tag. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
             },
             {
                 displayName: 'Document ID',
                 name: 'docId',
                 type: 'string',
                 default: '',
-                description: 'Restrict search to a specific document ID',
+                description: 'Restrict search to chunks from a specific document ID',
             },
             {
-                displayName: 'Filters (JSON)',
-                name: 'filtersJson',
-                type: 'json',
-                default: '',
-                description: 'Advanced metadata filters as JSON object',
-                placeholder: '{"AND":[{"key":"author","value":"john","filterType":"metadata"}]}',
+                displayName: 'Limit',
+                name: 'limit',
+                type: 'number',
+                typeOptions: { minValue: 1 },
+                default: 50,
+                description: 'Max number of results to return',
             },
         ],
     },