@n8n/workflow-sdk 0.11.2 → 0.12.0

package/dist/generate-types/generate-types.d.ts

@@ -23,6 +23,10 @@ export interface NodeProperty {
         show?: Record<string, unknown[]>;
         hide?: Record<string, unknown[]>;
     };
+    disabledOptions?: {
+        show?: Record<string, unknown[]>;
+        hide?: Record<string, unknown[]>;
+    };
     typeOptions?: Record<string, unknown>;
     noDataExpression?: boolean;
     modes?: Array<{
@@ -102,6 +106,10 @@ export interface DiscriminatedUnionResult {
     code: string;
     configTypes: ConfigTypeInfo[];
 }
+export declare function narrowDisplayOptionsByDisabled(prop: NodeProperty): {
+    displayOptions: NodeProperty['displayOptions'];
+    fullyDisabled: boolean;
+};
 export declare function mapPropertyType(prop: NodeProperty, discriminatorContext?: DiscriminatorCombination): string;
 export declare function extractDiscriminatorCombinations(node: NodeTypeDescription): DiscriminatorCombination[];
 export declare function getPropertiesForCombination(node: NodeTypeDescription, combination: DiscriminatorCombination): NodeProperty[];

package/dist/generate-types/generate-types.js

@@ -36,6 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.discoverSchemasForNode = discoverSchemasForNode;
 exports.jsonSchemaToTypeScript = jsonSchemaToTypeScript;
 exports.findSchemaForOperation = findSchemaForOperation;
+exports.narrowDisplayOptionsByDisabled = narrowDisplayOptionsByDisabled;
 exports.mapPropertyType = mapPropertyType;
 exports.extractDiscriminatorCombinations = extractDiscriminatorCombinations;
 exports.getPropertiesForCombination = getPropertiesForCombination;
@@ -87,6 +88,9 @@ const DEV_OUTPUT_PATH = path.resolve(__dirname, '../../dist/node-definitions');
 const NODES_BASE_DIST = path.resolve(__dirname, '../../../../nodes-base/dist/nodes');
 const DISCRIMINATOR_FIELDS = ['resource', 'operation', 'mode'];
 const CUSTOM_API_CALL_KEY = '__CUSTOM_API_CALL__';
+const DISPLAY_ONLY_PROPERTY_TYPES = new Set(['notice', 'curlImport', 'credentials', 'callout']);
+const ICON_TS_TYPE = "{ type: 'icon' | 'emoji'; value: string }";
+const WORKFLOW_SELECTOR_TS_TYPE = "{ __rl: true; mode: 'list' | 'id'; value: string | number; cachedResultName?: string; cachedResultUrl?: string } | Expression<string>";
 const ASSIGNMENT_TYPE_JSDOC = `/**
  * Assignment type determines how the value is interpreted.
  * - string: Direct string value or expression evaluating to string
@@ -533,7 +537,14 @@ function mapNestedPropertyTypeInner(prop, discriminatorContext) {
         case 'notice':
         case 'curlImport':
         case 'credentials':
+        case 'callout':
             return '';
+        case 'button':
+            return 'string | Expression<string>';
+        case 'icon':
+            return ICON_TS_TYPE;
+        case 'workflowSelector':
+            return WORKFLOW_SELECTOR_TS_TYPE;
         case 'credentialsSelect':
             return 'string | Expression<string>';
         default:
@@ -549,10 +560,6 @@ function quotePropertyName(name) {
     }
     return name;
 }
-function isPropertyOptional(prop) {
-    const hasDefault = 'default' in prop && prop.default !== undefined;
-    return !prop.required || hasDefault;
-}
 function generateNestedPropertyJSDoc(prop, indent, discriminatorContext) {
     const lines = [];
     const description = prop.description ?? prop.displayName;
@@ -656,7 +663,7 @@ function generateFixedCollectionType(prop, discriminatorContext) {
         const groupName = quotePropertyName(group.name);
         const nestedProps = [];
         for (const nestedProp of group.values) {
-            if (['notice', 'curlImport', 'credentials'].includes(nestedProp.type)) {
+            if (DISPLAY_ONLY_PROPERTY_TYPES.has(nestedProp.type)) {
                 continue;
             }
             const nestedType = mapNestedPropertyType(nestedProp, discriminatorContext);
@@ -668,7 +675,23 @@ function generateFixedCollectionType(prop, discriminatorContext) {
         }
         if (nestedProps.length > 0) {
             const innerType = `{\n${nestedProps.join(';\n')};\n${INDENT.repeat(2)}}`;
-            const groupType = isMultipleValues ? `Array<${innerType}>` : innerType;
+            const minRequired = prop.typeOptions?.minRequiredFields;
+            const maxAllowed = prop.typeOptions?.maxAllowedFields;
+            const hasMinRequired = typeof minRequired === 'number' && minRequired > 0;
+            let groupType;
+            if (isMultipleValues) {
+                if (hasMinRequired) {
+                    const requiredHead = Array(minRequired).fill(innerType).join(', ');
+                    groupType = `[${requiredHead}, ...Array<${innerType}>]`;
+                }
+                else {
+                    groupType = `Array<${innerType}>`;
+                }
+            }
+            else {
+                groupType = innerType;
+            }
+            const groupOptional = hasMinRequired ? '' : '?';
             const groupJsDocLines = [];
             if (group.displayName || group.description) {
                 const desc = (group.description ?? group.displayName ?? '')
@@ -687,12 +710,24 @@ function generateFixedCollectionType(prop, discriminatorContext) {
                 }
                 groupJsDocLines.push(`${INDENT.repeat(2)} * @builderHint ${safeBuilderHint}`);
             }
+            if (isMultipleValues && hasMinRequired) {
+                if (groupJsDocLines.length === 0) {
+                    groupJsDocLines.push(`${INDENT.repeat(2)}/**`);
+                }
+                groupJsDocLines.push(`${INDENT.repeat(2)} * @minItems ${minRequired}`);
+            }
+            if (isMultipleValues && typeof maxAllowed === 'number' && maxAllowed > 0) {
+                if (groupJsDocLines.length === 0) {
+                    groupJsDocLines.push(`${INDENT.repeat(2)}/**`);
+                }
+                groupJsDocLines.push(`${INDENT.repeat(2)} * @maxItems ${maxAllowed}`);
+            }
             if (groupJsDocLines.length > 0) {
                 groupJsDocLines.push(`${INDENT.repeat(2)} */`);
-                groups.push(`${groupJsDocLines.join('\n')}\n${INDENT.repeat(2)}${groupName}?: ${groupType}`);
+                groups.push(`${groupJsDocLines.join('\n')}\n${INDENT.repeat(2)}${groupName}${groupOptional}: ${groupType}`);
             }
             else {
-                groups.push(`${groupName}?: ${groupType}`);
+                groups.push(`${groupName}${groupOptional}: ${groupType}`);
             }
         }
     }
@@ -701,19 +736,71 @@ function generateFixedCollectionType(prop, discriminatorContext) {
     }
     return `{\n${INDENT.repeat(2)}${groups.join(`;\n${INDENT.repeat(2)}`)};\n${INDENT}}`;
 }
+function narrowDisplayOptionsByDisabled(prop) {
+    const { displayOptions, disabledOptions } = prop;
+    if (!disabledOptions?.show) {
+        return { displayOptions, fullyDisabled: false };
+    }
+    const currentShow = displayOptions?.show;
+    const narrowedShow = {};
+    const mergedHide = {};
+    for (const [key, values] of Object.entries(displayOptions?.hide ?? {})) {
+        mergedHide[key] = [...values];
+    }
+    if (currentShow) {
+        for (const [key, values] of Object.entries(currentShow)) {
+            const disabledValues = disabledOptions.show[key];
+            if (!disabledValues) {
+                narrowedShow[key] = values;
+                continue;
+            }
+            const remaining = values.filter((v) => !disabledValues.some((d) => JSON.stringify(d) === JSON.stringify(v)));
+            if (remaining.length === 0) {
+                return { displayOptions: undefined, fullyDisabled: true };
+            }
+            narrowedShow[key] = remaining;
+        }
+    }
+    for (const [key, values] of Object.entries(disabledOptions.show)) {
+        if (currentShow && key in currentShow)
+            continue;
+        const existing = mergedHide[key] ?? [];
+        const seen = new Set(existing.map((v) => JSON.stringify(v)));
+        for (const v of values) {
+            if (!seen.has(JSON.stringify(v))) {
+                existing.push(v);
+            }
+        }
+        mergedHide[key] = existing;
+    }
+    const result = {};
+    if (Object.keys(narrowedShow).length > 0)
+        result.show = narrowedShow;
+    if (Object.keys(mergedHide).length > 0)
+        result.hide = mergedHide;
+    return {
+        displayOptions: Object.keys(result).length > 0 ? result : undefined,
+        fullyDisabled: false,
+    };
+}
 function mergeCollectionProperties(properties) {
     const seenProps = new Map();
     for (const prop of properties) {
-        if (['notice', 'curlImport', 'credentials'].includes(prop.type)) {
+        if (DISPLAY_ONLY_PROPERTY_TYPES.has(prop.type)) {
+            continue;
+        }
+        const { displayOptions: narrowedDisplayOptions, fullyDisabled } = narrowDisplayOptionsByDisabled(prop);
+        if (fullyDisabled) {
             continue;
         }
-        if (seenProps.has(prop.name)) {
-            const existingProp = seenProps.get(prop.name);
-            if ((prop.type === 'collection' || prop.type === 'fixedCollection') &&
-                prop.options &&
+        const normalizedProp = { ...prop, displayOptions: narrowedDisplayOptions };
+        if (seenProps.has(normalizedProp.name)) {
+            const existingProp = seenProps.get(normalizedProp.name);
+            if ((normalizedProp.type === 'collection' || normalizedProp.type === 'fixedCollection') &&
+                normalizedProp.options &&
                 existingProp.options) {
                 const existingOptionNames = new Set(existingProp.options.map((o) => o.name));
-                for (const opt of prop.options) {
+                for (const opt of normalizedProp.options) {
                     if (!existingOptionNames.has(opt.name)) {
                         existingProp.options.push(opt);
                     }
@@ -721,9 +808,9 @@ function mergeCollectionProperties(properties) {
             }
             continue;
         }
-        seenProps.set(prop.name, {
-            ...prop,
-            options: prop.options ? [...prop.options] : undefined,
+        seenProps.set(normalizedProp.name, {
+            ...normalizedProp,
+            options: normalizedProp.options ? [...normalizedProp.options] : undefined,
         });
     }
     return Array.from(seenProps.values());
@@ -738,7 +825,7 @@ function generateCollectionType(prop, discriminatorContext) {
             continue;
         }
         const nestedType = nestedProp.type;
-        if (['notice', 'curlImport', 'credentials'].includes(nestedType)) {
+        if (DISPLAY_ONLY_PROPERTY_TYPES.has(nestedType)) {
             continue;
         }
         const propType = mapNestedPropertyType(nestedProp, discriminatorContext);
@@ -852,7 +939,14 @@ function mapPropertyTypeInner(prop, discriminatorContext) {
         case 'notice':
         case 'curlImport':
         case 'credentials':
+        case 'callout':
             return '';
+        case 'button':
+            return 'string | Expression<string>';
+        case 'icon':
+            return ICON_TS_TYPE;
+        case 'workflowSelector':
+            return WORKFLOW_SELECTOR_TS_TYPE;
         case 'credentialsSelect':
             return 'string | Expression<string>';
         default:
@@ -914,7 +1008,7 @@ function getPropertiesForCombination(node, combination) {
         if (DISCRIMINATOR_FIELDS.includes(prop.name)) {
             continue;
         }
-        if (['notice', 'curlImport', 'credentials'].includes(prop.type)) {
+        if (DISPLAY_ONLY_PROPERTY_TYPES.has(prop.type)) {
             continue;
         }
         if (prop.displayOptions?.show) {
@@ -1004,7 +1098,7 @@ function generateDiscriminatedUnion(node) {
         lines.push(`export interface ${configName} {`);
         const mergedProps = mergeCollectionProperties(node.properties);
         for (const prop of mergedProps) {
-            const propLine = generatePropertyLine(prop, isPropertyOptional(prop));
+            const propLine = generatePropertyLine(prop, (0, generate_zod_schemas_1.isPropertyOptional)(prop));
             if (propLine) {
                 lines.push(propLine);
             }
@@ -1046,7 +1140,7 @@ function generateDiscriminatedUnion(node) {
                 continue;
             }
             seenNames.add(prop.name);
-            const propLine = generatePropertyLine(prop, isPropertyOptional(prop), combo);
+            const propLine = generatePropertyLine(prop, (0, generate_zod_schemas_1.isPropertyOptional)(prop), combo);
             if (propLine) {
                 lines.push(propLine);
             }
@@ -1317,7 +1411,7 @@ function generateSharedFile(node, version, _importDepth = 5) {
     lines.push(' */');
     lines.push('');
     lines.push('');
-    const outputProps = filteredProperties.filter((p) => !['notice', 'curlImport', 'credentials'].includes(p.type));
+    const outputProps = filteredProperties.filter((p) => !DISPLAY_ONLY_PROPERTY_TYPES.has(p.type));
     const needsFilter = outputProps.some((p) => p.type === 'filter');
     const needsAssignment = outputProps.some((p) => p.type === 'assignmentCollection');
     if (needsFilter || needsAssignment) {
@@ -1454,7 +1548,7 @@ function generateDiscriminatorFile(node, version, combo, props, schema, _importD
         if (seenNames.has(prop.name))
             continue;
         seenNames.add(prop.name);
-        const propLine = generatePropertyLine(prop, isPropertyOptional(prop), combo);
+        const propLine = generatePropertyLine(prop, (0, generate_zod_schemas_1.isPropertyOptional)(prop), combo);
         if (propLine) {
             lines.push(propLine);
         }
@@ -1665,7 +1759,7 @@ function generateSingleVersionTypeFile(node, specificVersion) {
     lines.push('');
     const aiInputTypes = extractAIInputTypesFromBuilderHint(node);
     const subnodeConfigTypeName = aiInputTypes.length > 0 ? `${nodeName}${versionSuffix}SubnodeConfig` : undefined;
-    const outputProps = filteredProperties.filter((p) => !['notice', 'curlImport', 'credentials'].includes(p.type));
+    const outputProps = filteredProperties.filter((p) => !DISPLAY_ONLY_PROPERTY_TYPES.has(p.type));
     const needsFilter = outputProps.some((p) => p.type === 'filter');
     const needsAssignment = outputProps.some((p) => p.type === 'assignmentCollection');
     if (needsFilter || needsAssignment) {
@@ -1836,7 +1930,7 @@ function generateNodeTypeFile(nodes) {
     lines.push(generateNodeJSDoc(node));
     lines.push('');
     lines.push('');
-    const outputProps = nodeArray.flatMap((n) => n.properties.filter((p) => !['notice', 'curlImport', 'credentials'].includes(p.type)));
+    const outputProps = nodeArray.flatMap((n) => n.properties.filter((p) => !DISPLAY_ONLY_PROPERTY_TYPES.has(p.type)));
     const needsFilter = outputProps.some((p) => p.type === 'filter');
     const needsAssignment = outputProps.some((p) => p.type === 'assignmentCollection');
     if (needsFilter || needsAssignment) {
@@ -1937,7 +2031,7 @@ function generateDiscriminatedUnionForEntry(node, nodeName, versionSuffix) {
         lines.push(`export interface ${configName} {`);
         const mergedProps = mergeCollectionProperties(node.properties);
         for (const prop of mergedProps) {
-            const propLine = generatePropertyLine(prop, isPropertyOptional(prop));
+            const propLine = generatePropertyLine(prop, (0, generate_zod_schemas_1.isPropertyOptional)(prop));
             if (propLine) {
                 lines.push(propLine);
             }
@@ -1998,7 +2092,7 @@ function generateDiscriminatedUnionForEntry(node, nodeName, versionSuffix) {
                 continue;
             }
             seenNames.add(prop.name);
-            const propLine = generatePropertyLine(prop, isPropertyOptional(prop), combo);
+            const propLine = generatePropertyLine(prop, (0, generate_zod_schemas_1.isPropertyOptional)(prop), combo);
             if (propLine) {
                 lines.push(propLine);
             }