@n8n/n8n-nodes-langchain 2.5.1 → 2.6.0

package/dist/nodes/Guardrails/description.js

@@ -1,415 +1,377 @@
 "use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var description_exports = {};
-__export(description_exports, {
-  propertiesDescription: () => propertiesDescription
-});
-module.exports = __toCommonJS(description_exports);
-var import_jailbreak = require("./actions/checks/jailbreak");
-var import_nsfw = require("./actions/checks/nsfw");
-var import_pii = require("./actions/checks/pii");
-var import_topicalAlignment = require("./actions/checks/topicalAlignment");
-var import_model = require("./helpers/model");
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.propertiesDescription = void 0;
+const jailbreak_1 = require("./actions/checks/jailbreak");
+const nsfw_1 = require("./actions/checks/nsfw");
+const pii_1 = require("./actions/checks/pii");
+const topicalAlignment_1 = require("./actions/checks/topicalAlignment");
+const model_1 = require("./helpers/model");
 const THRESHOLD_OPTION = {
-  displayName: "Threshold",
-  name: "threshold",
-  type: "number",
-  default: "",
-  description: "Minimum confidence threshold to trigger the guardrail (0.0 to 1.0)",
-  hint: "Inputs scoring less than this will be treated as violations"
+    displayName: 'Threshold',
+    name: 'threshold',
+    type: 'number',
+    default: '',
+    description: 'Minimum confidence threshold to trigger the guardrail (0.0 to 1.0)',
+    hint: 'Inputs scoring less than this will be treated as violations',
 };
 const getPromptOption = (defaultPrompt, collapsible = true, hint) => {
-  const promptParameters = {
-    displayName: "Prompt",
-    name: "prompt",
-    type: "string",
-    default: defaultPrompt,
-    description: "The system prompt used by the guardrail. Thresholds and JSON output are enforced by the node automatically.",
-    hint,
-    typeOptions: {
-      rows: 6
+    const promptParameters = {
+        displayName: 'Prompt',
+        name: 'prompt',
+        type: 'string',
+        default: defaultPrompt,
+        description: 'The system prompt used by the guardrail. Thresholds and JSON output are enforced by the node automatically.',
+        hint,
+        typeOptions: {
+            rows: 6,
+        },
+    };
+    if (collapsible) {
+        return [
+            { displayName: 'Customize Prompt', name: 'customizePrompt', type: 'boolean', default: false },
+            { ...promptParameters, displayOptions: { show: { customizePrompt: [true] } } },
+        ];
     }
-  };
-  if (collapsible) {
-    return [
-      { displayName: "Customize Prompt", name: "customizePrompt", type: "boolean", default: false },
-      { ...promptParameters, displayOptions: { show: { customizePrompt: [true] } } }
-    ];
-  }
-  return [promptParameters];
+    return [promptParameters];
 };
 const wrapValue = (properties) => ({
-  displayName: "Value",
-  name: "value",
-  values: properties
+    displayName: 'Value',
+    name: 'value',
+    values: properties,
 });
-const propertiesDescription = [
-  {
-    displayName: "Use guardrails to validate text against a set of policies (e.g. NSFW, prompt injection) or to sanitize it (e.g. personal data, secret keys)",
-    name: "guardrailsUsage",
-    type: "notice",
-    default: ""
-  },
-  {
-    displayName: "Operation",
-    name: "operation",
-    type: "options",
-    noDataExpression: true,
-    options: [
-      {
-        name: "Check Text for Violations",
-        value: "classify",
-        action: "Check text for violations",
-        description: "Validate text against a set of policies (e.g. NSFW, prompt injection)"
-      },
-      {
-        name: "Sanitize Text",
-        value: "sanitize",
-        action: "Sanitize text",
-        // eslint-disable-next-line n8n-nodes-base/node-param-description-excess-final-period
-        description: "Redact text to mask personal data, secret keys, URLs, etc."
-      }
-    ],
-    default: "classify"
-  },
-  {
-    displayName: "Text To Check",
-    name: "text",
-    type: "string",
-    required: true,
-    default: "",
-    typeOptions: {
-      rows: 1
-    }
-  },
-  {
-    displayName: "Guardrails",
-    name: "guardrails",
-    placeholder: "Add Guardrail",
-    type: "collection",
-    default: {},
-    options: [
-      {
-        displayName: "Keywords",
-        name: "keywords",
-        type: "string",
-        default: "",
-        description: "This guardrail checks if specified keywords appear in the input text and can be configured to trigger tripwires based on keyword matches. Multiple keywords can be added separated by comma.",
-        displayOptions: {
-          show: {
-            "/operation": ["classify"]
-          }
-        }
-      },
-      {
-        displayName: "Jailbreak",
-        name: "jailbreak",
-        type: "fixedCollection",
-        default: { value: { threshold: 0.7 } },
-        description: "Detects attempts to jailbreak or bypass AI safety measures",
-        options: [wrapValue([THRESHOLD_OPTION, ...getPromptOption(import_jailbreak.JAILBREAK_PROMPT)])],
-        displayOptions: {
-          show: {
-            "/operation": ["classify"]
-          }
-        }
-      },
-      {
-        displayName: "NSFW",
-        name: "nsfw",
-        type: "fixedCollection",
-        default: { value: { threshold: 0.7 } },
-        description: "Detects attempts to generate NSFW content",
-        options: [wrapValue([THRESHOLD_OPTION, ...getPromptOption(import_nsfw.NSFW_SYSTEM_PROMPT)])],
-        displayOptions: {
-          show: {
-            "/operation": ["classify"]
-          }
-        }
-      },
-      {
-        displayName: "Personal Data (PII)",
-        name: "pii",
-        type: "fixedCollection",
-        default: { value: { type: "all" } },
-        description: "Detects attempts to use personal data content",
+exports.propertiesDescription = [
+    {
+        displayName: 'Use guardrails to validate text against a set of policies (e.g. NSFW, prompt injection) or to sanitize it (e.g. personal data, secret keys)',
+        name: 'guardrailsUsage',
+        type: 'notice',
+        default: '',
+    },
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
         options: [
-          wrapValue([
             {
-              displayName: "Type",
-              name: "type",
-              type: "options",
-              default: "",
-              options: [
-                { name: "All", value: "all" },
-                { name: "Selected", value: "selected" }
-              ]
+                name: 'Check Text for Violations',
+                value: 'classify',
+                action: 'Check text for violations',
+                description: 'Validate text against a set of policies (e.g. NSFW, prompt injection)',
             },
             {
-              displayName: "Entities",
-              name: "entities",
-              type: "multiOptions",
-              default: [],
-              displayOptions: {
-                show: {
-                  type: ["selected"]
-                }
-              },
-              options: Object.values(import_pii.PIIEntity).map((entity) => ({
-                name: import_pii.PII_NAME_MAP[entity],
-                value: entity
-              }))
-            }
-          ])
-        ]
-      },
-      {
-        displayName: "Secret Keys",
-        name: "secretKeys",
-        type: "fixedCollection",
-        default: { value: { permissiveness: "balanced" } },
-        description: "Detects attempts to use secret keys in the input text. Scans text for common patterns, applies entropy analysis to detect random-looking strings.",
+                name: 'Sanitize Text',
+                value: 'sanitize',
+                action: 'Sanitize text',
+                description: 'Redact text to mask personal data, secret keys, URLs, etc.',
+            },
+        ],
+        default: 'classify',
+    },
+    {
+        displayName: 'Text To Check',
+        name: 'text',
+        type: 'string',
+        required: true,
+        default: '',
+        typeOptions: {
+            rows: 1,
+        },
+    },
+    {
+        displayName: 'Guardrails',
+        name: 'guardrails',
+        placeholder: 'Add Guardrail',
+        type: 'collection',
+        default: {},
         options: [
-          wrapValue([
             {
-              displayName: "Permissiveness",
-              name: "permissiveness",
-              type: "options",
-              default: "",
-              options: [
-                {
-                  name: "Strict",
-                  value: "strict",
-                  description: "Most sensitive, may have more false positives (commonly flag high entropy filenames or code)"
+                displayName: 'Keywords',
+                name: 'keywords',
+                type: 'string',
+                default: '',
+                description: 'This guardrail checks if specified keywords appear in the input text and can be configured to trigger tripwires based on keyword matches. Multiple keywords can be added separated by comma.',
+                displayOptions: {
+                    show: {
+                        '/operation': ['classify'],
+                    },
                 },
-                {
-                  name: "Balanced",
-                  value: "balanced",
-                  description: "Balanced between sensitivity and specificity"
+            },
+            {
+                displayName: 'Jailbreak',
+                name: 'jailbreak',
+                type: 'fixedCollection',
+                default: { value: { threshold: 0.7 } },
+                description: 'Detects attempts to jailbreak or bypass AI safety measures',
+                options: [wrapValue([THRESHOLD_OPTION, ...getPromptOption(jailbreak_1.JAILBREAK_PROMPT)])],
+                displayOptions: {
+                    show: {
+                        '/operation': ['classify'],
+                    },
                 },
-                {
-                  name: "Permissive",
-                  value: "permissive",
-                  description: "Least sensitive, may miss some secret keys (but also reduces false positives)"
-                }
-              ]
-            }
-          ])
-        ]
-      },
-      {
-        displayName: "Topical Alignment",
-        name: "topicalAlignment",
-        type: "fixedCollection",
-        default: { value: { threshold: 0.7 } },
-        description: "Detects attempts to stray from the business scope",
-        options: [
-          wrapValue([
-            THRESHOLD_OPTION,
-            ...getPromptOption(
-              import_topicalAlignment.TOPICAL_ALIGNMENT_SYSTEM_PROMPT,
-              false,
-              "Make sure you replace the placeholder."
-            )
-          ])
-        ],
-        displayOptions: {
-          show: {
-            "/operation": ["classify"]
-          }
-        }
-      },
-      {
-        displayName: "URLs",
-        name: "urls",
-        type: "fixedCollection",
-        default: { value: { allowedSchemes: ["https"], allowedUrls: "" } },
-        description: "Blocks URLs that are not in the allowed list",
-        options: [
-          wrapValue([
+            },
             {
-              displayName: "Block All URLs Except",
-              name: "allowedUrls",
-              type: "string",
-              // keep placeholder to avoid limitation that removes collections with unchanged default values
-              default: "PLACEHOLDER",
-              description: "Multiple URLs can be added separated by comma. Leave empty to block all URLs."
+                displayName: 'NSFW',
+                name: 'nsfw',
+                type: 'fixedCollection',
+                default: { value: { threshold: 0.7 } },
+                description: 'Detects attempts to generate NSFW content',
+                options: [wrapValue([THRESHOLD_OPTION, ...getPromptOption(nsfw_1.NSFW_SYSTEM_PROMPT)])],
+                displayOptions: {
+                    show: {
+                        '/operation': ['classify'],
+                    },
+                },
             },
             {
-              displayName: "Allowed Schemes",
-              name: "allowedSchemes",
-              type: "multiOptions",
-              default: ["https"],
-              // eslint-disable-next-line n8n-nodes-base/node-param-multi-options-type-unsorted-items
-              options: [
-                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                { name: "https", value: "https" },
-                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                { name: "http", value: "http" },
-                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                { name: "ftp", value: "ftp" },
-                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                { name: "data", value: "data" },
-                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                { name: "javascript", value: "javascript" },
-                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                { name: "vbscript", value: "vbscript" },
-                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                { name: "mailto", value: "mailto" }
-              ]
+                displayName: 'Personal Data (PII)',
+                name: 'pii',
+                type: 'fixedCollection',
+                default: { value: { type: 'all' } },
+                description: 'Detects attempts to use personal data content',
+                options: [
+                    wrapValue([
+                        {
+                            displayName: 'Type',
+                            name: 'type',
+                            type: 'options',
+                            default: '',
+                            options: [
+                                { name: 'All', value: 'all' },
+                                { name: 'Selected', value: 'selected' },
+                            ],
+                        },
+                        {
+                            displayName: 'Entities',
+                            name: 'entities',
+                            type: 'multiOptions',
+                            default: [],
+                            displayOptions: {
+                                show: {
+                                    type: ['selected'],
+                                },
+                            },
+                            options: Object.values(pii_1.PIIEntity).map((entity) => ({
+                                name: pii_1.PII_NAME_MAP[entity],
+                                value: entity,
+                            })),
+                        },
+                    ]),
+                ],
             },
             {
-              displayName: "Block Userinfo",
-              name: "blockUserinfo",
-              type: "boolean",
-              default: true,
-              description: "Whether to block URLs with userinfo (user:pass@domain) to prevent credential injection",
-              displayOptions: {
-                show: {
-                  "/operation": ["classify"]
-                }
-              }
+                displayName: 'Secret Keys',
+                name: 'secretKeys',
+                type: 'fixedCollection',
+                default: { value: { permissiveness: 'balanced' } },
+                description: 'Detects attempts to use secret keys in the input text. Scans text for common patterns, applies entropy analysis to detect random-looking strings.',
+                options: [
+                    wrapValue([
+                        {
+                            displayName: 'Permissiveness',
+                            name: 'permissiveness',
+                            type: 'options',
+                            default: '',
+                            options: [
+                                {
+                                    name: 'Strict',
+                                    value: 'strict',
+                                    description: 'Most sensitive, may have more false positives (commonly flag high entropy filenames or code)',
+                                },
+                                {
+                                    name: 'Balanced',
+                                    value: 'balanced',
+                                    description: 'Balanced between sensitivity and specificity',
+                                },
+                                {
+                                    name: 'Permissive',
+                                    value: 'permissive',
+                                    description: 'Least sensitive, may miss some secret keys (but also reduces false positives)',
+                                },
+                            ],
+                        },
+                    ]),
+                ],
             },
             {
-              displayName: "Sanitize Userinfo",
-              name: "blockUserinfo",
-              type: "boolean",
-              default: true,
-              description: "Whether to sanitize URLs with userinfo (user:pass@domain) to prevent credential injection",
-              displayOptions: {
-                show: {
-                  "/operation": ["sanitize"]
-                }
-              }
+                displayName: 'Topical Alignment',
+                name: 'topicalAlignment',
+                type: 'fixedCollection',
+                default: { value: { threshold: 0.7 } },
+                description: 'Detects attempts to stray from the business scope',
+                options: [
+                    wrapValue([
+                        THRESHOLD_OPTION,
+                        ...getPromptOption(topicalAlignment_1.TOPICAL_ALIGNMENT_SYSTEM_PROMPT, false, 'Make sure you replace the placeholder.'),
+                    ]),
+                ],
+                displayOptions: {
+                    show: {
+                        '/operation': ['classify'],
+                    },
+                },
             },
             {
-              displayName: "Allow Subdomains",
-              name: "allowSubdomains",
-              type: "boolean",
-              default: true,
-              description: "Whether to allow subdomains (e.g. sub.domain.com if domain.com is allowed)"
-            }
-          ])
-        ]
-      },
-      {
-        displayName: "Custom",
-        name: "custom",
-        type: "fixedCollection",
-        typeOptions: {
-          sortable: true,
-          multipleValues: true
-        },
-        placeholder: "Add Custom Guardrail",
-        default: {
-          guardrail: [{ name: "Custom Guardrail" }]
-        },
-        options: [
-          {
-            displayName: "Guardrail",
-            name: "guardrail",
-            values: [
-              {
-                displayName: "Name",
-                name: "name",
-                type: "string",
-                default: "",
-                description: "Name of the custom guardrail"
-              },
-              THRESHOLD_OPTION,
-              ...getPromptOption("", false)
-            ]
-          }
+                displayName: 'URLs',
+                name: 'urls',
+                type: 'fixedCollection',
+                default: { value: { allowedSchemes: ['https'], allowedUrls: '' } },
+                description: 'Blocks URLs that are not in the allowed list',
+                options: [
+                    wrapValue([
+                        {
+                            displayName: 'Block All URLs Except',
+                            name: 'allowedUrls',
+                            type: 'string',
+                            default: 'PLACEHOLDER',
+                            description: 'Multiple URLs can be added separated by comma. Leave empty to block all URLs.',
+                        },
+                        {
+                            displayName: 'Allowed Schemes',
+                            name: 'allowedSchemes',
+                            type: 'multiOptions',
+                            default: ['https'],
+                            options: [
+                                { name: 'https', value: 'https' },
+                                { name: 'http', value: 'http' },
+                                { name: 'ftp', value: 'ftp' },
+                                { name: 'data', value: 'data' },
+                                { name: 'javascript', value: 'javascript' },
+                                { name: 'vbscript', value: 'vbscript' },
+                                { name: 'mailto', value: 'mailto' },
+                            ],
+                        },
+                        {
+                            displayName: 'Block Userinfo',
+                            name: 'blockUserinfo',
+                            type: 'boolean',
+                            default: true,
+                            description: 'Whether to block URLs with userinfo (user:pass@domain) to prevent credential injection',
+                            displayOptions: {
+                                show: {
+                                    '/operation': ['classify'],
+                                },
+                            },
+                        },
+                        {
+                            displayName: 'Sanitize Userinfo',
+                            name: 'blockUserinfo',
+                            type: 'boolean',
+                            default: true,
+                            description: 'Whether to sanitize URLs with userinfo (user:pass@domain) to prevent credential injection',
+                            displayOptions: {
+                                show: {
+                                    '/operation': ['sanitize'],
+                                },
+                            },
+                        },
+                        {
+                            displayName: 'Allow Subdomains',
+                            name: 'allowSubdomains',
+                            type: 'boolean',
+                            default: true,
+                            description: 'Whether to allow subdomains (e.g. sub.domain.com if domain.com is allowed)',
+                        },
+                    ]),
+                ],
+            },
+            {
+                displayName: 'Custom',
+                name: 'custom',
+                type: 'fixedCollection',
+                typeOptions: {
+                    sortable: true,
+                    multipleValues: true,
+                },
+                placeholder: 'Add Custom Guardrail',
+                default: {
+                    guardrail: [{ name: 'Custom Guardrail' }],
+                },
+                options: [
+                    {
+                        displayName: 'Guardrail',
+                        name: 'guardrail',
+                        values: [
+                            {
+                                displayName: 'Name',
+                                name: 'name',
+                                type: 'string',
+                                default: '',
+                                description: 'Name of the custom guardrail',
+                            },
+                            THRESHOLD_OPTION,
+                            ...getPromptOption('', false),
+                        ],
+                    },
+                ],
+                displayOptions: {
+                    show: {
+                        '/operation': ['classify'],
+                    },
+                },
+            },
+            {
+                displayName: 'Custom Regex',
+                name: 'customRegex',
+                type: 'fixedCollection',
+                typeOptions: {
+                    sortable: true,
+                    multipleValues: true,
+                },
+                placeholder: 'Add Custom Regex',
+                default: {},
+                options: [
+                    {
+                        displayName: 'Regex',
+                        name: 'regex',
+                        values: [
+                            {
+                                displayName: 'Name',
+                                name: 'name',
+                                type: 'string',
+                                default: '',
+                                description: 'Name of the custom regex. Will be used for replacement when sanitizing.',
+                            },
+                            {
+                                displayName: 'Regex',
+                                name: 'value',
+                                type: 'string',
+                                default: '',
+                                description: 'Regex to match the input text',
+                                placeholder: '/text/gi',
+                            },
+                        ],
+                    },
+                ],
+            },
         ],
+    },
+    {
+        displayName: 'Customize System Message',
+        name: 'customizeSystemMessage',
+        description: 'Whether to customize the system message used by the guardrail to specify the output format',
+        type: 'boolean',
+        default: false,
         displayOptions: {
-          show: {
-            "/operation": ["classify"]
-          }
-        }
-      },
-      {
-        displayName: "Custom Regex",
-        name: "customRegex",
-        type: "fixedCollection",
+            show: {
+                '/operation': ['classify'],
+            },
+        },
+    },
+    {
+        displayName: 'System Message',
+        name: 'systemMessage',
+        type: 'string',
+        description: 'The system message used by the guardrail to enforce thresholds and JSON output according to schema',
+        hint: 'This message is appended after prompts defined by guardrails',
+        default: model_1.LLM_SYSTEM_RULES,
         typeOptions: {
-          sortable: true,
-          multipleValues: true
+            rows: 6,
+        },
+        displayOptions: {
+            show: {
+                '/customizeSystemMessage': [true],
+            },
         },
-        placeholder: "Add Custom Regex",
-        default: {},
-        options: [
-          {
-            displayName: "Regex",
-            name: "regex",
-            values: [
-              {
-                displayName: "Name",
-                name: "name",
-                type: "string",
-                default: "",
-                description: "Name of the custom regex. Will be used for replacement when sanitizing."
-              },
-              {
-                displayName: "Regex",
-                name: "value",
-                type: "string",
-                default: "",
-                description: "Regex to match the input text",
-                placeholder: "/text/gi"
-              }
-            ]
-          }
-        ]
-      }
-    ]
-  },
-  {
-    displayName: "Customize System Message",
-    name: "customizeSystemMessage",
-    description: "Whether to customize the system message used by the guardrail to specify the output format",
-    type: "boolean",
-    default: false,
-    displayOptions: {
-      show: {
-        "/operation": ["classify"]
-      }
-    }
-  },
-  {
-    displayName: "System Message",
-    name: "systemMessage",
-    type: "string",
-    description: "The system message used by the guardrail to enforce thresholds and JSON output according to schema",
-    hint: "This message is appended after prompts defined by guardrails",
-    default: import_model.LLM_SYSTEM_RULES,
-    typeOptions: {
-      rows: 6
     },
-    displayOptions: {
-      show: {
-        "/customizeSystemMessage": [true]
-      }
-    }
-  }
 ];
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  propertiesDescription
-});
 //# sourceMappingURL=description.js.map