@revenexx/integrations-node-sdk 1.5.0 → 1.6.0

package/README.md

@@ -78,7 +78,7 @@ export class UppercaseNode implements INode {
     category: 'transform',
     name: { en: 'Uppercase', de: 'Großschreiben' },
     description: { en: 'Upper-cases a string read from the input.' },
-    icon: 'mdi:format-letter-case-upper',
+    icon: 'lucide:case-upper',
     inputs: { in: { dataType: 'string', required: true } },
     outputs: [{ name: 'out', kind: 'default', dataType: 'string', label: { en: 'Result', de: 'Ergebnis' } }],
   } satisfies INodeDescription;
@@ -107,7 +107,7 @@ export class ConditionIfNode implements INode {
     version: '1.0.0',
     category: 'control',
     name: { en: 'If condition', de: 'Wenn-Bedingung' },
-    icon: 'mdi:source-branch',
+    icon: 'lucide:git-branch',
     inputs: { in: { dataType: 'any', required: true } },
     outputs: [
       { name: 'true', kind: 'branch', dataType: 'any', label: { en: 'True', de: 'Wahr' } },
@@ -153,7 +153,7 @@ export class HttpRequestNode implements INode {
     version: '1.0.0',
     category: 'action',
     name: { en: 'HTTP Request', de: 'HTTP-Anfrage' },
-    icon: 'mdi:web',
+    icon: 'lucide:globe',
     inputs: { in: { dataType: 'object' } },
     outputs: [
       {

package/dist/index.d.cts

@@ -54,8 +54,22 @@ interface IInputPort {
     required?: boolean;
     description?: LocalizedString;
 }
+/**
+ * One value an output carries, as the editor offers it to the next step.
+ *
+ * Deliberately flat: there is no member describing what is inside the value,
+ * because the registry's manifest schema refuses any key beside these three and
+ * the studio reads none. What is inside a value is declared beside it, under a
+ * dotted name — see `IOutputPort.fields` (PO-408).
+ */
 interface IOutputField {
     dataType: DataType;
+    /**
+     * What the value is called, for an author picking it in the editor's `{ }` list —
+     * "Rechnungen" where the key is `invoices` (PO-594). Left out, the editor shows the
+     * key, as before.
+     */
+    label?: LocalizedString;
     description?: LocalizedString;
 }
 interface IOutputPort {
@@ -64,6 +78,15 @@ interface IOutputPort {
     name?: string;
     label?: LocalizedString;
     description?: LocalizedString;
+    /**
+     * The values this output carries, by name.
+     *
+     * A name containing `.` is a path into the value: `counts` as `object` and
+     * `counts.added` as `number`, side by side, offers both the object and the
+     * number inside it. The studio and the worker resolve that name as a path, so
+     * the record the node emits must really be nested — a record carrying a
+     * literal `"counts.added"` key is not reached by it (specs/output-fields.md).
+     */
     fields?: Record<string, IOutputField>;
     sourceFromConfig?: string;
     /**
@@ -154,6 +177,20 @@ interface IConfigFieldBase {
      * know the key.
      */
     showIf?: IShowIfCondition;
+    /**
+     * What a value mapped into this field from an earlier step has to be — `'array'`
+     * for a setting that wants the list a previous node produced (PO-594).
+     *
+     * The editor uses it to put the earlier steps' outputs of that kind first in the
+     * `{ }` list, mark them, and offer the single matching one as a one-click answer
+     * under an empty field. So the author does not have to know what a previous node
+     * returns, or which of its fields is the list.
+     *
+     * Not to be confused with `type: 'array'`, which draws the setting itself as
+     * repeating rows the author fills in by hand. Only meaningful together with
+     * `expressionAllowed`. Left unset, every output is offered alike, as before.
+     */
+    accepts?: DataType;
     /**
      * Only meaningful when `type === 'credentials-ref'`: the namespaced slug(s) of
      * the credential type(s) this field accepts (e.g. `revenexx:smtp`). The editor
@@ -207,6 +244,7 @@ interface INodeDescription {
     category: NodeCategory;
     name: LocalizedString;
     description?: LocalizedString;
+    /** A Lucide icon name, `lucide:<kebab-name>` as listed on lucide.dev (e.g. `lucide:globe`). The studio draws it as named; a name it cannot draw becomes a generic box. */
     icon?: string;
     /**
      * Curated node-picker group path, outermost first (max 4 levels), e.g.
@@ -479,6 +517,7 @@ interface ICredentialDescription {
     version: string;
     name: LocalizedString;
     description?: LocalizedString;
+    /** A Lucide icon name, `lucide:<kebab-name>` as listed on lucide.dev (e.g. `lucide:globe`). The studio draws it as named; a name it cannot draw becomes a generic box. */
     icon?: string;
     /** Associated images (screenshots, logos, banners) shipped with the package. */
     images?: IImage[];
@@ -588,6 +627,7 @@ interface ITemplateDescription {
     shortDescription?: LocalizedString;
     /** Long-form description in Markdown. */
     description?: LocalizedString;
+    /** A Lucide icon name, `lucide:<kebab-name>` as listed on lucide.dev (e.g. `lucide:globe`). The studio draws it as named; a name it cannot draw becomes a generic box. */
     icon?: string;
     /** Free-form industry tags (e.g. `any`, `medical`). */
     industries?: string[];

package/dist/index.d.ts

@@ -54,8 +54,22 @@ interface IInputPort {
     required?: boolean;
     description?: LocalizedString;
 }
+/**
+ * One value an output carries, as the editor offers it to the next step.
+ *
+ * Deliberately flat: there is no member describing what is inside the value,
+ * because the registry's manifest schema refuses any key beside these three and
+ * the studio reads none. What is inside a value is declared beside it, under a
+ * dotted name — see `IOutputPort.fields` (PO-408).
+ */
 interface IOutputField {
     dataType: DataType;
+    /**
+     * What the value is called, for an author picking it in the editor's `{ }` list —
+     * "Rechnungen" where the key is `invoices` (PO-594). Left out, the editor shows the
+     * key, as before.
+     */
+    label?: LocalizedString;
     description?: LocalizedString;
 }
 interface IOutputPort {
@@ -64,6 +78,15 @@ interface IOutputPort {
     name?: string;
     label?: LocalizedString;
     description?: LocalizedString;
+    /**
+     * The values this output carries, by name.
+     *
+     * A name containing `.` is a path into the value: `counts` as `object` and
+     * `counts.added` as `number`, side by side, offers both the object and the
+     * number inside it. The studio and the worker resolve that name as a path, so
+     * the record the node emits must really be nested — a record carrying a
+     * literal `"counts.added"` key is not reached by it (specs/output-fields.md).
+     */
     fields?: Record<string, IOutputField>;
     sourceFromConfig?: string;
     /**
@@ -154,6 +177,20 @@ interface IConfigFieldBase {
      * know the key.
      */
     showIf?: IShowIfCondition;
+    /**
+     * What a value mapped into this field from an earlier step has to be — `'array'`
+     * for a setting that wants the list a previous node produced (PO-594).
+     *
+     * The editor uses it to put the earlier steps' outputs of that kind first in the
+     * `{ }` list, mark them, and offer the single matching one as a one-click answer
+     * under an empty field. So the author does not have to know what a previous node
+     * returns, or which of its fields is the list.
+     *
+     * Not to be confused with `type: 'array'`, which draws the setting itself as
+     * repeating rows the author fills in by hand. Only meaningful together with
+     * `expressionAllowed`. Left unset, every output is offered alike, as before.
+     */
+    accepts?: DataType;
     /**
      * Only meaningful when `type === 'credentials-ref'`: the namespaced slug(s) of
      * the credential type(s) this field accepts (e.g. `revenexx:smtp`). The editor
@@ -207,6 +244,7 @@ interface INodeDescription {
     category: NodeCategory;
     name: LocalizedString;
     description?: LocalizedString;
+    /** A Lucide icon name, `lucide:<kebab-name>` as listed on lucide.dev (e.g. `lucide:globe`). The studio draws it as named; a name it cannot draw becomes a generic box. */
     icon?: string;
     /**
      * Curated node-picker group path, outermost first (max 4 levels), e.g.
@@ -479,6 +517,7 @@ interface ICredentialDescription {
     version: string;
     name: LocalizedString;
     description?: LocalizedString;
+    /** A Lucide icon name, `lucide:<kebab-name>` as listed on lucide.dev (e.g. `lucide:globe`). The studio draws it as named; a name it cannot draw becomes a generic box. */
     icon?: string;
     /** Associated images (screenshots, logos, banners) shipped with the package. */
     images?: IImage[];
@@ -588,6 +627,7 @@ interface ITemplateDescription {
     shortDescription?: LocalizedString;
     /** Long-form description in Markdown. */
     description?: LocalizedString;
+    /** A Lucide icon name, `lucide:<kebab-name>` as listed on lucide.dev (e.g. `lucide:globe`). The studio draws it as named; a name it cannot draw becomes a generic box. */
     icon?: string;
     /** Free-form industry tags (e.g. `any`, `medical`). */
     industries?: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenexx/integrations-node-sdk",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "TypeScript interfaces and utilities for Revenexx integration nodes",
   "license": "MIT",
   "author": "revenexx GmbH",