@pxp-nd/flow 1.1.30 → 1.1.31

package/dist/controllers/Action.d.ts

@@ -9,7 +9,7 @@
  * @author Favio Figueroa
  *
  * Created at     : 2021-07-08 12:55:38
- * Last modified  :
+ * Last modified  : 2026-11-06 — Rensi Arteaga — @ApiDoc for OpenAPI (spec 04)
  */
 import { EntityManager } from 'typeorm';
 import { Controller } from '@pxp-nd/core';

package/dist/controllers/Action.js

@@ -10,7 +10,7 @@
  * @author Favio Figueroa
  *
  * Created at     : 2021-07-08 12:55:38
- * Last modified  :
+ * Last modified  : 2026-11-06 — Rensi Arteaga — @ApiDoc for OpenAPI (spec 04)
  */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
@@ -30,9 +30,13 @@ const core_1 = require("@pxp-nd/core");
 const Action_1 = __importDefault(require("../entity/Action"));
 const FieldMap_1 = __importDefault(require("../entity/FieldMap"));
 const OriginName_1 = __importDefault(require("../entity/OriginName"));
+const FlowNdApiDocs_1 = require("../helpers/FlowNdApiDocs");
 let Action = class Action extends core_1.Controller {
     async getFieldMapByAction(params, manager) {
         const { originName } = params;
+        if (originName == null || String(originName).trim() === '') {
+            throw new core_1.PxpError(400, 'originName is required');
+        }
         const fieldMapData = await (0, core_1.__)(manager.createQueryBuilder(FieldMap_1.default, 'fm')
             .innerJoin(OriginName_1.default, 'on', 'on.originNameId = fm.originNameId')
             .where("on.name = :n ", { n: originName })
@@ -61,8 +65,9 @@ let Action = class Action extends core_1.Controller {
 __decorate([
     (0, core_1.Get)(),
     (0, core_1.DbSettings)('Orm'),
-    (0, core_1.ReadOnly)(false),
+    (0, core_1.ReadOnly)(true),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.actionGetFieldMapByActionDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, typeorm_1.EntityManager]),
     __metadata("design:returntype", Promise)
@@ -72,6 +77,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(true),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.actionGetActionsDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, typeorm_1.EntityManager]),
     __metadata("design:returntype", Promise)

package/dist/controllers/Flow.d.ts

@@ -19,6 +19,7 @@
  * 28-Sep-2023    SP06OCT23     Mercedes Zambrana      Add Validation when change off status (validateFlow, deleteflow, saveFlow, saveflowName)
  * 07-Feb-2025    8353064698    Mercedes Zambrana      Add validation for opt in page when flow si funnel change
  * 18-Feb-2025    8501163144    Mercedes Zambrana      Add publish filter
+ * 06-Nov-2026                     Rensi Arteaga         @ApiDoc for OpenAPI (spec 04)
  * ******************************************************************************
  */
 import { EntityManager } from 'typeorm';

package/dist/controllers/Flow.js

@@ -20,6 +20,7 @@
  * 28-Sep-2023    SP06OCT23     Mercedes Zambrana      Add Validation when change off status (validateFlow, deleteflow, saveFlow, saveflowName)
  * 07-Feb-2025    8353064698    Mercedes Zambrana      Add validation for opt in page when flow si funnel change
  * 18-Feb-2025    8501163144    Mercedes Zambrana      Add publish filter
+ * 06-Nov-2026                     Rensi Arteaga         @ApiDoc for OpenAPI (spec 04)
  * ******************************************************************************
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -69,8 +70,13 @@ const FlowInstance_1 = __importDefault(require("../entity/FlowInstance"));
 const Node_2 = __importDefault(require("./Node"));
 const axios_1 = __importDefault(require("axios"));
 //import {configFacebookStrategy} from "./passport-facebook";
+const FlowNdApiDocs_1 = require("../helpers/FlowNdApiDocs");
 let Flow = class Flow extends core_1.Controller {
     async get(params) {
+        const fid = Number(params.flowId);
+        if (!Number.isInteger(fid) || fid < 1) {
+            throw new core_1.PxpError(400, 'flowId is required and must be a positive integer');
+        }
         const nodes = await Node_1.default.find({ flowId: params.flowId });
         const restNodes = [];
         for (let node of nodes) {
@@ -477,6 +483,10 @@ let Flow = class Flow extends core_1.Controller {
     }
     async getFlowRender(params) {
         var _a;
+        const fid = Number(params.flowId);
+        if (!Number.isInteger(fid) || fid < 1) {
+            throw new core_1.PxpError(400, 'flowId is required and must be a positive integer');
+        }
         const flow = await (0, typeorm_1.getManager)().findOne(Flow_1.default, params.flowId);
         const totalNodes = await (0, typeorm_1.getManager)()
             .createQueryBuilder(Node_1.default, "n")
@@ -782,6 +792,15 @@ let Flow = class Flow extends core_1.Controller {
         const filter = (params === null || params === void 0 ? void 0 : params.filter) ? JSON.parse(params === null || params === void 0 ? void 0 : params.filter) : null;
         const filters = (filter === null || filter === void 0 ? void 0 : filter.items) || [];
         const logicOperator = ((_a = filter === null || filter === void 0 ? void 0 : filter.logicOperator) === null || _a === void 0 ? void 0 : _a.toUpperCase()) || 'AND';
+        const allowedSort = ['flowId', 'name', 'createdAt', 'modifiedAt'];
+        const allowedDir = ['ASC', 'DESC'];
+        const sortCol = params.sort != null && params.sort !== '' ? String(params.sort) : 'flowId';
+        const dirVal = params.dir != null && params.dir !== ''
+            ? String(params.dir).toUpperCase()
+            : 'ASC';
+        if (!allowedSort.includes(sortCol) || !allowedDir.includes(dirVal)) {
+            throw new core_1.PxpError(400, 'sort and dir must be allowed values (whitelist for SQL orderBy)');
+        }
         const queryBuilder = await (0, typeorm_1.getManager)()
             .createQueryBuilder()
             .select([
@@ -888,7 +907,7 @@ let Flow = class Flow extends core_1.Controller {
         // Sorting and pagination
         //queryBuilder.orderBy(`f.${params.sort}`, params.dir).skip(params.start).take(params.limit);
         // Sorting and pagination
-        queryBuilder.orderBy(`f.${params.sort}`, params.dir);
+        queryBuilder.orderBy(`f.${sortCol}`, dirVal);
         // Agrega manualmente la cláusula LIMIT y OFFSET
         queryBuilder.limit(params.limit).offset(params.start);
         const data = await queryBuilder.getRawMany();
@@ -929,6 +948,15 @@ let Flow = class Flow extends core_1.Controller {
         const filters = (filter === null || filter === void 0 ? void 0 : filter.items) || [];
         const logicOperator = ((_a = filter === null || filter === void 0 ? void 0 : filter.logicOperator) === null || _a === void 0 ? void 0 : _a.toUpperCase()) || "AND";
         const publish = params._publish;
+        const allowedSort = ["flowId", "name", "createdAt", "modifiedAt"];
+        const allowedDir = ["ASC", "DESC"];
+        const sortCol = params.sort != null && params.sort !== "" ? String(params.sort) : "flowId";
+        const dirVal = params.dir != null && params.dir !== ""
+            ? String(params.dir).toUpperCase()
+            : "ASC";
+        if (!allowedSort.includes(sortCol) || !allowedDir.includes(dirVal)) {
+            throw new core_1.PxpError(400, "sort and dir must be allowed values (whitelist for SQL orderBy)");
+        }
         const queryBuilder = await (0, typeorm_1.getManager)()
             .createQueryBuilder()
             .select([
@@ -1040,7 +1068,7 @@ let Flow = class Flow extends core_1.Controller {
             "f.status",
         ]);
         // Ordenamiento y paginación
-        queryBuilder.orderBy(`f.${params.sort || "flowId"}`, params.dir || "ASC");
+        queryBuilder.orderBy(`f.${sortCol}`, dirVal);
         queryBuilder.limit(params.limit || 50).offset(params.start || 0);
         // Obtener los datos
         const data = await queryBuilder.getRawMany();
@@ -1117,6 +1145,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(true),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.flowGetDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", Promise)
@@ -1135,6 +1164,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(false),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.flowDeleteFlowDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, typeorm_1.EntityManager]),
     __metadata("design:returntype", Promise)
@@ -1144,6 +1174,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(false),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.flowSaveFlowNameDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, typeorm_1.EntityManager]),
     __metadata("design:returntype", Promise)
@@ -1162,6 +1193,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(false),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.flowSaveFlowDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, typeorm_1.EntityManager]),
     __metadata("design:returntype", Promise)
@@ -1172,6 +1204,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(true),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.flowGetFlowRenderDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", Promise)
@@ -1181,6 +1214,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(false),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.flowInsertEventFlowDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, typeorm_1.EntityManager]),
     __metadata("design:returntype", Promise)
@@ -1199,6 +1233,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(false),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.flowChangeStatusFlowDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, typeorm_1.EntityManager]),
     __metadata("design:returntype", Promise)
@@ -1217,6 +1252,7 @@ __decorate([
     (0, core_1.DbSettings)("Orm"),
     (0, core_1.ReadOnly)(true),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.flowListTemplatesDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", Promise)
@@ -1231,6 +1267,7 @@ __decorate([
     __metadata("design:returntype", Promise)
 ], Flow.prototype, "changePublishTemplate", null);
 Flow = __decorate([
+    (0, core_1.ApiDocFor)('add', FlowNdApiDocs_1.flowAddDoc),
     (0, core_1.Model)('flow-nd/Flow')
 ], Flow);
 exports.default = Flow;

package/dist/controllers/Node.d.ts

@@ -10,6 +10,7 @@
  * 04-Sep-2023    SP08SEP23     Rensi Arteaga           add modifiedAt for flows
  * 29-Sep-2023    SP06OCT23     Mercedes Zambrana       Add validation when flow is on
  * 19-Jan-2025    8201489097    Favio Figueroa          Add Controller Validation
+ * 06-Nov-2026                     Rensi Arteaga         @ApiDoc for OpenAPI (spec 04)
  * ******************************************************************************
  */
 import { EntityManager } from 'typeorm';

package/dist/controllers/Node.js

@@ -11,6 +11,7 @@
  * 04-Sep-2023    SP08SEP23     Rensi Arteaga           add modifiedAt for flows
  * 29-Sep-2023    SP06OCT23     Mercedes Zambrana       Add validation when flow is on
  * 19-Jan-2025    8201489097    Favio Figueroa          Add Controller Validation
+ * 06-Nov-2026                     Rensi Arteaga         @ApiDoc for OpenAPI (spec 04)
  * ******************************************************************************
  */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
@@ -35,6 +36,7 @@ const FieldMap_1 = __importDefault(require("../entity/FieldMap"));
 const OriginName_1 = __importDefault(require("../entity/OriginName"));
 const axios_1 = __importDefault(require("axios"));
 const Flow_1 = __importDefault(require("../entity/Flow"));
+const FlowNdApiDocs_1 = require("../helpers/FlowNdApiDocs");
 let Node = class Node extends core_1.Controller {
     async getNodeData(node, dataId, manager) {
         const { action: { originName, originKey } } = node;
@@ -113,6 +115,10 @@ let Node = class Node extends core_1.Controller {
     }
     async getParameterizedNode(params, manager) {
         lodash_1.default.templateSettings.interpolate = /{{([\s\S]+?)}}/g;
+        const nid = Number(params.nodeId);
+        if (!Number.isInteger(nid) || nid < 1) {
+            throw new core_1.PxpError(400, 'nodeId is required and must be a positive integer');
+        }
         const { nodeId, flowId, substitutionsSchemaJson = {} } = params;
         const tNodeData = (0, core_1.__)(Node_1.default.findOne(nodeId));
         const nodeData = await tNodeData;
@@ -298,6 +304,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(false),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.nodeAddDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, typeorm_1.EntityManager]),
     __metadata("design:returntype", Promise)
@@ -307,6 +314,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(false),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.nodeAddActionConfigJsonDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, typeorm_1.EntityManager]),
     __metadata("design:returntype", Promise)
@@ -316,6 +324,7 @@ __decorate([
     (0, core_1.DbSettings)('Orm'),
     (0, core_1.ReadOnly)(false),
     (0, core_1.Log)(true),
+    (0, core_1.ApiDoc)(FlowNdApiDocs_1.nodeGetParameterizedNodeDoc),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, typeorm_1.EntityManager]),
     __metadata("design:returntype", Promise)

package/dist/helpers/FlowNdApiDocs.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @pxp-nd/flow — OpenAPI (@ApiDoc) payloads for flow-nd controllers (spec tempo-04).
+ * Vendor is session-scoped; do not document vendorId / _vendorId as inputs.
+ */
+import { ApiDocSpec } from '@pxp-nd/core';
+export declare const flowListTemplatesDoc: ApiDocSpec;
+export declare const flowGetDoc: ApiDocSpec;
+export declare const flowGetFlowRenderDoc: ApiDocSpec;
+export declare const flowAddDoc: ApiDocSpec;
+export declare const flowSaveFlowDoc: ApiDocSpec;
+export declare const flowSaveFlowNameDoc: ApiDocSpec;
+export declare const flowInsertEventFlowDoc: ApiDocSpec;
+export declare const flowChangeStatusFlowDoc: ApiDocSpec;
+export declare const flowDeleteFlowDoc: ApiDocSpec;
+export declare const nodeAddDoc: ApiDocSpec;
+export declare const nodeAddActionConfigJsonDoc: ApiDocSpec;
+export declare const nodeGetParameterizedNodeDoc: ApiDocSpec;
+export declare const actionGetActionsDoc: ApiDocSpec;
+export declare const actionGetFieldMapByActionDoc: ApiDocSpec;

package/dist/helpers/FlowNdApiDocs.js

@@ -0,0 +1,299 @@
+"use strict";
+/**
+ * @pxp-nd/flow — OpenAPI (@ApiDoc) payloads for flow-nd controllers (spec tempo-04).
+ * Vendor is session-scoped; do not document vendorId / _vendorId as inputs.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.actionGetFieldMapByActionDoc = exports.actionGetActionsDoc = exports.nodeGetParameterizedNodeDoc = exports.nodeAddActionConfigJsonDoc = exports.nodeAddDoc = exports.flowDeleteFlowDoc = exports.flowChangeStatusFlowDoc = exports.flowInsertEventFlowDoc = exports.flowSaveFlowNameDoc = exports.flowSaveFlowDoc = exports.flowAddDoc = exports.flowGetFlowRenderDoc = exports.flowGetDoc = exports.flowListTemplatesDoc = void 0;
+exports.flowListTemplatesDoc = {
+    operationId: 'flow-nd.Flow.listTemplates',
+    summary: 'List templates',
+    description: 'Lists templates the session vendor can use: its own and the shared ones. Returns { data, count }. Defaults: _type \'template\', sort \'flowId\', dir \'ASC\', limit 50.',
+    params: {
+        type: 'object',
+        properties: {
+            _templateType: { type: 'string', enum: ['flow', 'funnel'] },
+            _type: { type: 'string', enum: ['template'] },
+            _publish: { type: 'string', enum: ['Y', 'N'], description: 'Y = only published templates.' },
+            _isActive: { type: 'integer', enum: [0, 1] },
+            genericFilterFields: { type: 'string', enum: ['name', 'description'] },
+            genericFilterValue: { type: 'string' },
+            filter: { type: 'string', description: 'JSON string { items, logicOperator }, as for the flow list.' },
+            start: { type: 'integer', minimum: 0 },
+            limit: { type: 'integer', minimum: 1 },
+            sort: { type: 'string', enum: ['flowId', 'name', 'createdAt', 'modifiedAt'] },
+            dir: { type: 'string', enum: ['ASC', 'DESC'] },
+        },
+        additionalProperties: false,
+    },
+    readOnly: true,
+    permission: null,
+};
+exports.flowGetDoc = {
+    operationId: 'flow-nd.Flow.get',
+    summary: 'Nodes of a flow',
+    description: 'Returns the nodes of one flow as an array of { node, connections }: connections are the IDs of child nodes, node.valuesForShowingInNode holds the main configured values.',
+    params: {
+        type: 'object',
+        properties: { flowId: { type: 'integer', minimum: 1 } },
+        required: ['flowId'],
+        additionalProperties: false,
+    },
+    readOnly: true,
+    permission: null,
+};
+exports.flowGetFlowRenderDoc = {
+    operationId: 'flow-nd.Flow.getFlowRender',
+    summary: 'Editor board of a flow',
+    description: 'Returns { flow, board } as used by the flow editor. board.columns[\'2-column-nodes-configured\'].taskIds is the current node order (\'node-<nodeId>\'); board.columns[\'1-column-config-nodes\'].taskIds are the steps that can be added next. Same behaviour for GET and POST.',
+    params: {
+        type: 'object',
+        properties: { flowId: { type: 'integer', minimum: 1 } },
+        required: ['flowId'],
+        additionalProperties: false,
+    },
+    readOnly: true,
+    permission: null,
+};
+exports.flowAddDoc = {
+    operationId: 'flow-nd.Flow.add',
+    summary: 'Create a flow',
+    description: 'Creates a flow for the session vendor. This is the default create route of the Flow model: it saves the fields it receives. Returns the saved flow row, including flowId.',
+    params: {
+        type: 'object',
+        properties: {
+            name: { type: 'string', minLength: 1, maxLength: 255 },
+            description: { type: 'string' },
+            templateType: { type: 'string', enum: ['flow', 'funnel'] },
+            type: { type: 'string', enum: ['custom', 'template'] },
+            status: { type: 'string', enum: ['off', 'on'] },
+        },
+        required: ['name', 'templateType', 'type'],
+        additionalProperties: false,
+    },
+    readOnly: false,
+    permission: null,
+};
+exports.flowSaveFlowDoc = {
+    operationId: 'flow-nd.Flow.saveFlow',
+    summary: 'Add or remove a step',
+    description: 'Adds or removes a step in a flow, as the flow editor does. The flow must be off, otherwise 400 \'Please turn off the flow before make a change\'. To add a step (origin \'cloneTask\'): taskIds is the full new order with \'new\' at the position of the new step, and tasks.new holds the flow ID and the action code. To remove a step (origin \'deleteTask\'): taskIds is the order without that node and deleteId is its ID. Other keys of tasks are ignored. Returns { success: true, nodeId } (the new node ID, or null).',
+    params: {
+        type: 'object',
+        properties: {
+            board: {
+                type: 'object',
+                properties: {
+                    origin: { type: 'string', enum: ['cloneTask', 'deleteTask'] },
+                    deleteId: { type: 'string', pattern: '^node-[0-9]+$', description: 'Only for deleteTask.' },
+                    columns: {
+                        type: 'object',
+                        properties: {
+                            '2-column-nodes-configured': {
+                                type: 'object',
+                                properties: {
+                                    taskIds: {
+                                        type: 'array',
+                                        items: { type: 'string', pattern: '^(new|node-[0-9]+)$' },
+                                        description: 'Node order. Existing nodes are \'node-<nodeId>\'; for cloneTask \'new\' once.',
+                                    },
+                                },
+                                required: ['taskIds'],
+                            },
+                        },
+                        required: ['2-column-nodes-configured'],
+                    },
+                    tasks: {
+                        type: 'object',
+                        properties: {
+                            new: {
+                                type: 'object',
+                                properties: {
+                                    flowId: { type: 'integer', minimum: 1 },
+                                    action: {
+                                        type: 'object',
+                                        properties: { code: { type: 'string', description: 'Action code from Action/getActions.' } },
+                                        required: ['code'],
+                                    },
+                                },
+                                required: ['flowId', 'action'],
+                            },
+                        },
+                    },
+                },
+                required: ['origin', 'columns'],
+            },
+        },
+        required: ['board'],
+        additionalProperties: false,
+    },
+    readOnly: false,
+    permission: null,
+};
+exports.flowSaveFlowNameDoc = {
+    operationId: 'flow-nd.Flow.saveFlowName',
+    summary: 'Rename a flow',
+    description: 'Renames a flow. The flow must be off (400 otherwise). For a template it also saves code, description, icon and flowType. Returns { success: true } or { success: false }.',
+    params: {
+        type: 'object',
+        properties: {
+            flowId: { type: 'integer', minimum: 1 },
+            name: { type: 'string', minLength: 1, maxLength: 255 },
+            code: { type: 'string', description: 'Templates only.' },
+            description: { type: 'string', description: 'Templates only.' },
+            icon: { type: 'string', description: 'Templates only.' },
+            flowType: { type: 'string', description: 'Templates only.' },
+        },
+        required: ['flowId', 'name'],
+        additionalProperties: false,
+    },
+    readOnly: false,
+    permission: null,
+};
+exports.flowInsertEventFlowDoc = {
+    operationId: 'flow-nd.Flow.insertEventFlow',
+    summary: 'Add the trigger of a flow',
+    description: 'Creates the first node (isInit = \'Y\') of a flow from an EVENT action. Returns { success: true, nodeId } or { success: false, msg }.',
+    params: {
+        type: 'object',
+        properties: {
+            flowId: { type: 'integer', minimum: 1 },
+            actionId: { type: 'integer', minimum: 1, description: 'An active EVENT action (Action/getActions with actionTypeName \'EVENT\').' },
+        },
+        required: ['flowId', 'actionId'],
+        additionalProperties: false,
+    },
+    readOnly: false,
+    permission: null,
+};
+exports.flowChangeStatusFlowDoc = {
+    operationId: 'flow-nd.Flow.changeStatusFlow',
+    summary: 'Turn a flow on or off',
+    description: 'Toggles the flow status between \'off\' and \'on\'. A flow that is on runs for real contacts (sends emails and messages). Turning on needs at least 2 active steps (400 otherwise). Returns { success: true } or { success: false }.',
+    params: {
+        type: 'object',
+        properties: { flowId: { type: 'integer', minimum: 1 } },
+        required: ['flowId'],
+        additionalProperties: false,
+    },
+    readOnly: false,
+    permission: null,
+};
+exports.flowDeleteFlowDoc = {
+    operationId: 'flow-nd.Flow.deleteFlow',
+    summary: 'Delete a flow',
+    description: 'Soft-deletes a flow: the flow, its instances, nodes and connections become inactive. The flow must be off (400 otherwise). Returns { success: true } or { success: false }.',
+    params: {
+        type: 'object',
+        properties: { flowId: { type: 'integer', minimum: 1 } },
+        required: ['flowId'],
+        additionalProperties: false,
+    },
+    readOnly: false,
+    permission: null,
+};
+exports.nodeAddDoc = {
+    operationId: 'flow-nd.Node.add',
+    summary: 'Create a node with parent connections',
+    description: 'Creates a node in a flow. For each parent, the parent\'s existing child connections are moved to the new node and a connection parent → new node is added. Every parentId must be a node of the same flow. The flow editor uses Flow/saveFlow instead. Returns the saved node row, including nodeId.',
+    params: {
+        type: 'object',
+        properties: {
+            flowId: { type: 'integer', minimum: 1 },
+            actionId: { type: 'integer', minimum: 1 },
+            isInit: { type: 'string', enum: ['Y', 'N'] },
+            isEnd: { type: 'string', enum: ['Y', 'N'] },
+            parents: {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    properties: {
+                        parentId: { type: 'integer', minimum: 1 },
+                        condition: { type: 'string' },
+                    },
+                    required: ['parentId'],
+                    additionalProperties: false,
+                },
+            },
+        },
+        required: ['flowId', 'actionId', 'isInit', 'isEnd'],
+        additionalProperties: false,
+    },
+    readOnly: false,
+    permission: null,
+};
+exports.nodeAddActionConfigJsonDoc = {
+    operationId: 'flow-nd.Node.AddActionConfigJson',
+    summary: 'Save the configuration of a step',
+    description: 'Saves the configuration of one node. The flow must be off (400 otherwise). The step fields are sent as top-level keys next to nodeId. __metadata maps a field name to { name } for fields that hold a merge variable; such a field is stored as \'{{ <name> }}\'. The step\'s validation controller runs before saving. Returns { actionConfigJson, success: true, nodeId, msg }.',
+    params: {
+        type: 'object',
+        properties: {
+            nodeId: { type: 'integer', minimum: 1 },
+            __metadata: {
+                type: 'object',
+                additionalProperties: {
+                    type: 'object',
+                    properties: { name: { type: 'string' } },
+                    required: ['name'],
+                },
+            },
+        },
+        required: ['nodeId', '__metadata'],
+        additionalProperties: true,
+    },
+    readOnly: false,
+    permission: null,
+};
+exports.nodeGetParameterizedNodeDoc = {
+    operationId: 'flow-nd.Node.getParameterizedNode',
+    summary: 'Step with its field schema',
+    description: 'Returns a node with what is needed to configure it: the node, its merged current values, schemaJsonObject (the field schema of the step, with substitutions applied) and the merge fields available from the trigger of the flow. Does not change data.',
+    params: {
+        type: 'object',
+        properties: {
+            nodeId: { type: 'integer', minimum: 1 },
+            substitutionsSchemaJson: {
+                type: 'object',
+                description: 'Values substituted into the step\'s schema template.',
+                properties: {
+                    locationId: { type: 'integer', minimum: 1 },
+                    keyword: { type: 'string' },
+                },
+                additionalProperties: false,
+            },
+        },
+        required: ['nodeId'],
+        additionalProperties: false,
+    },
+    readOnly: true,
+    permission: null,
+};
+exports.actionGetActionsDoc = {
+    operationId: 'flow-nd.Action.getActions',
+    summary: 'Catalog of step types',
+    description: 'Returns { data: Action[] }; each action has actionId, code, name, schemaJson (field schema of the step), configJsonTemplate and actionType. Filter by actionTypeName, for example \'EVENT\' for triggers.',
+    params: {
+        type: 'object',
+        properties: {
+            actionTypeName: { type: 'string', description: 'For example EVENT, PAGE, CHAINED FLOW.' },
+            actionId: { type: 'integer', minimum: 1 },
+        },
+        additionalProperties: false,
+    },
+    readOnly: true,
+    permission: null,
+};
+exports.actionGetFieldMapByActionDoc = {
+    operationId: 'flow-nd.Action.getFieldMapByAction',
+    summary: 'Merge fields of an origin',
+    description: 'Returns the field-map rows (merge fields) of an origin, the data source of a trigger (Action.originName).',
+    params: {
+        type: 'object',
+        properties: { originName: { type: 'string', minLength: 1 } },
+        required: ['originName'],
+        additionalProperties: false,
+    },
+    readOnly: true,
+    permission: null,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pxp-nd/flow",
-  "version": "1.1.30",
+  "version": "1.1.31",
   "description": "Workflow module for pxp-nd framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "@pxp-nd/common": "^1.1.4",
-    "@pxp-nd/core": "^1.1.13",
+    "@pxp-nd/core": "^1.2.94",
     "axios": "^0.21.1",
     "lodash": "^4.17.21",
     "typeorm": "^0.2.36"