@revenexx/integrations-node-sdk 1.4.2 → 1.5.1

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,6 +54,14 @@ 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 two 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;
     description?: LocalizedString;
@@ -64,6 +72,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;
     /**
@@ -207,6 +224,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.
@@ -214,6 +232,17 @@ interface INodeDescription {
      * pickers without it fall back to package/category grouping.
      */
     groups?: LocalizedString[];
+    /**
+     * Where this node stands inside its innermost palette folder, among the nodes
+     * of the same package: lower comes first. Optional — the editor draws nodes
+     * with a position before those without, and those without in the order the
+     * package lists them in `NODES`, so a package that lists its main node first
+     * needs no position at all. Use it when the array order is not the palette
+     * order, e.g. when `NODES` is sorted for another reason. It orders nodes only
+     * within one package; where a folder takes nodes from several packages, the
+     * order between packages is the editor's.
+     */
+    paletteOrder?: number;
     /** Associated images (screenshots, logos, banners) shipped with the package. */
     images?: IImage[];
     inputs: Record<string, IInputPort>;
@@ -468,6 +497,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[];
@@ -577,6 +607,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,6 +54,14 @@ 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 two 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;
     description?: LocalizedString;
@@ -64,6 +72,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;
     /**
@@ -207,6 +224,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.
@@ -214,6 +232,17 @@ interface INodeDescription {
      * pickers without it fall back to package/category grouping.
      */
     groups?: LocalizedString[];
+    /**
+     * Where this node stands inside its innermost palette folder, among the nodes
+     * of the same package: lower comes first. Optional — the editor draws nodes
+     * with a position before those without, and those without in the order the
+     * package lists them in `NODES`, so a package that lists its main node first
+     * needs no position at all. Use it when the array order is not the palette
+     * order, e.g. when `NODES` is sorted for another reason. It orders nodes only
+     * within one package; where a folder takes nodes from several packages, the
+     * order between packages is the editor's.
+     */
+    paletteOrder?: number;
     /** Associated images (screenshots, logos, banners) shipped with the package. */
     images?: IImage[];
     inputs: Record<string, IInputPort>;
@@ -468,6 +497,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[];
@@ -577,6 +607,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.4.2",
+  "version": "1.5.1",
   "description": "TypeScript interfaces and utilities for Revenexx integration nodes",
   "license": "MIT",
   "author": "revenexx GmbH",