@servicenow/sdk-build-plugins 4.2.0 → 4.4.0

package/dist/flow/plugins/flow-data-pill-plugin.js

@@ -0,0 +1,212 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataPillPlugin = void 0;
+exports.determineRootIdentifierAndPath = determineRootIdentifierAndPath;
+const sdk_build_core_1 = require("@servicenow/sdk-build-core");
+const flow_shapes_1 = require("../utils/flow-shapes");
+const data_pill_shapes_1 = require("../utils/data-pill-shapes");
+const flow_logic_constants_1 = require("../flow-logic/flow-logic-constants");
+const utils_1 = require("../../utils");
+const utils_2 = require("../utils/utils");
+function handleRecordType(value, propertyAccessShape, propertyNames, diagnostics) {
+    if (!(value.getSource() instanceof flow_shapes_1.FDInstanceShape)) {
+        diagnostics.error(propertyAccessShape, 'Invalid data pill: Record references must come from a flow action or subflow output');
+        return { success: false };
+    }
+    const pathStr = propertyNames.slice(1).join('.');
+    return {
+        success: true,
+        value: new data_pill_shapes_1.PillShape({
+            source: propertyAccessShape,
+            uiId: value.as(sdk_build_core_1.Record).get('ui_id').asString().getValue(),
+            path: pathStr,
+        }),
+    };
+}
+function handleUnresolvedShape(value, propertyAccessShape, propertyNames, diagnostics) {
+    const source = value.getSource();
+    if (!(source instanceof sdk_build_core_1.ts.Node)) {
+        diagnostics.error(propertyAccessShape, 'Invalid root source for pill expression');
+        return { success: false };
+    }
+    // Todo: if it is any other, below code will take care of it
+    const { rootIdentifier, pathStr } = determineRootIdentifierAndPath(propertyNames, diagnostics, propertyAccessShape);
+    if (!rootIdentifier) {
+        const forEachParamName = getForEachParameterName(propertyAccessShape.getElement(0));
+        if (forEachParamName) {
+            return {
+                success: true,
+                value: new data_pill_shapes_1.PillShape({
+                    source: propertyAccessShape,
+                    uiId: 'forEach',
+                    path: [forEachParamName, ...propertyNames.slice(1)].join('.'),
+                }),
+            };
+        }
+        diagnostics.error(propertyAccessShape, 'Invalid pill reference');
+        return { success: false };
+    }
+    return {
+        success: true,
+        value: new data_pill_shapes_1.PillShape({
+            source: source,
+            uiId: rootIdentifier,
+            path: pathStr,
+        }),
+    };
+}
+function determineRootIdentifierAndPath(propertyNames, diagnostics, propertyAccessShape) {
+    let rootIdentifier = '';
+    let pathStr = '';
+    switch (propertyNames[1]) {
+        case 'inputs':
+            rootIdentifier = 'subflow'; // <-- Hardcoded: But need to handle if this input is in action/subflow body when we do action body impl.
+            pathStr = propertyNames.slice(2).join('.');
+            break;
+        case 'flowVariables':
+            // For params.flowVariables (schema reference), use 'flowVariables' as identifier with empty path
+            // For params.flowVariables.someVar (property access), use 'flow_variable' as identifier
+            if (propertyNames.length === 2) {
+                // Schema reference: params.flowVariables → {{flowVariables}}
+                rootIdentifier = 'flowVariables';
+                pathStr = '';
+            }
+            else {
+                // Property access: params.flowVariables.someVar → {{flow_variable.someVar}}
+                rootIdentifier = 'flow_variable';
+                pathStr = propertyNames.slice(2).join('.');
+            }
+            break;
+        case 'trigger':
+            rootIdentifier = 'trigger';
+            pathStr = propertyNames.slice(2).join('.');
+            break;
+        case 'outputs':
+            // For params.outputs (schema reference in assignSubflowOutputs context), allow it
+            // For params.outputs.someOutput (property access), reject it
+            if (propertyNames.length === 2) {
+                // Schema reference: params.outputs → {{outputs}}
+                rootIdentifier = 'outputs';
+                pathStr = '';
+            }
+            else {
+                // Property access: params.outputs.someOutput → error (not allowed)
+                diagnostics.error(propertyAccessShape, 'Invalid pill reference: Subflow outputs are not allowed as datapills');
+                return { rootIdentifier: null, pathStr: null };
+            }
+            break;
+        default:
+            return { rootIdentifier: null, pathStr: null };
+    }
+    return { rootIdentifier, pathStr };
+}
+/**
+ * Get the parameter name from a forEach arrow function
+ * Returns the actual parameter name (e.g., 'dept', 'category', 'item') instead of generic 'item'
+ * Returns null if the identifier is not a forEach parameter
+ */
+function getForEachParameterName(identifierShape) {
+    const param = identifierShape.getOriginalNode().asKind(sdk_build_core_1.ts.SyntaxKind.Identifier)?.getDefinitionNodes()?.[0];
+    const parentLogicNode = param
+        ?.getParentIfKind(sdk_build_core_1.ts.SyntaxKind.ArrowFunction)
+        ?.getParentIfKind(sdk_build_core_1.ts.SyntaxKind.CallExpression);
+    if (!parentLogicNode || (0, utils_1.getCallExpressionName)(parentLogicNode) !== flow_logic_constants_1.FLOW_LOGIC.FOR_EACH) {
+        return null;
+    }
+    // Get the actual parameter name from the identifier
+    return identifierShape.getName();
+}
+exports.DataPillPlugin = sdk_build_core_1.Plugin.create({
+    name: 'DataPillPlugin',
+    shapes: [
+        {
+            shape: sdk_build_core_1.PropertyAccessShape,
+            fileTypes: ['fluent'],
+            async toSubclass(propertyAccessShape, { diagnostics, transform }) {
+                // Decompose PropertyAccessExpression into root identifier and remaining path
+                const ancestor = (0, utils_2.findAncestorByCalleeName)(propertyAccessShape.getOriginalNode(), 'wfa.dataPill');
+                if (!ancestor) {
+                    diagnostics.error(propertyAccessShape, 'Datapill reference must be inside a wfa.dataPill call');
+                    return { success: false };
+                }
+                const propertyNames = [];
+                propertyAccessShape.getElements().forEach((element) => {
+                    if (element instanceof sdk_build_core_1.IdentifierShape) {
+                        propertyNames.push(element.getName());
+                    }
+                });
+                const value = propertyAccessShape.getElement(0).resolve();
+                if (value.is(sdk_build_core_1.UnresolvedShape)) {
+                    return handleUnresolvedShape(value, propertyAccessShape, propertyNames, diagnostics);
+                }
+                const record = await (0, utils_2.getRecordFromFlowInstaceShape)(value, transform);
+                if (record?.is(sdk_build_core_1.Record)) {
+                    return handleRecordType(record, propertyAccessShape, propertyNames, diagnostics);
+                }
+                return { success: false };
+            },
+        },
+        {
+            shape: sdk_build_core_1.TemplateExpressionShape,
+            fileTypes: ['fluent'],
+            async toSubclass(shape, { transform }) {
+                const parts = [];
+                const head = shape.getLiteralText();
+                const leadingText = head;
+                if (leadingText.length > 0) {
+                    parts.push(leadingText);
+                }
+                for (const span of shape.getSpans()) {
+                    const expr = span.getExpression();
+                    const literalText = span.getLiteralText();
+                    const pillShapeResult = expr.is([sdk_build_core_1.PropertyAccessShape, sdk_build_core_1.IdentifierShape])
+                        ? await transform.toSubclass(expr, exports.DataPillPlugin) // In case of PropertyAccessShape call the toSubclass() again, which calls above handler
+                        : { success: false, value: undefined };
+                    if (pillShapeResult.success) {
+                        const pillShape = pillShapeResult.value;
+                        if (pillShape instanceof data_pill_shapes_1.PillShape) {
+                            // do not call getValue() for trigger, as this will be handled in flow-instance-plugin
+                            if (pillShape.getRootIdentifier() === 'trigger') {
+                                parts.push(pillShape);
+                            }
+                            else {
+                                parts.push(pillShape.getValue());
+                            }
+                            parts.push(literalText);
+                        }
+                        if (pillShape instanceof data_pill_shapes_1.ForEachItemShape) {
+                            parts.push(pillShape.getValue());
+                            parts.push(literalText);
+                        }
+                    }
+                }
+                return {
+                    success: true,
+                    value: new data_pill_shapes_1.PillTemplateShape({
+                        source: shape,
+                        parts,
+                    }),
+                };
+            },
+        },
+        {
+            shape: sdk_build_core_1.IdentifierShape,
+            fileTypes: ['fluent'],
+            async toSubclass(identifierShape) {
+                const forEachParamName = getForEachParameterName(identifierShape);
+                if (!forEachParamName) {
+                    return { success: false };
+                }
+                return {
+                    success: true,
+                    value: new data_pill_shapes_1.ForEachItemShape({
+                        source: identifierShape,
+                        uiId: 'forEach',
+                        path: forEachParamName,
+                    }),
+                };
+            },
+        },
+    ],
+});
+//# sourceMappingURL=flow-data-pill-plugin.js.map

package/dist/flow/plugins/flow-data-pill-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow-data-pill-plugin.js","sourceRoot":"","sources":["../../../src/flow/plugins/flow-data-pill-plugin.ts"],"names":[],"mappings":";;;AAoFA,wEAmDC;AAvID,+DAUmC;AACnC,sDAAsD;AACtD,gEAA0F;AAC1F,6EAA+D;AAC/D,uCAAmD;AACnD,0CAAwF;AAExF,SAAS,gBAAgB,CACrB,KAAa,EACb,mBAAwC,EACxC,aAAuB,EACvB,WAAwB;IAExB,IAAI,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,YAAY,6BAAe,CAAC,EAAE,CAAC;QAClD,WAAW,CAAC,KAAK,CACb,mBAAmB,EACnB,qFAAqF,CACxF,CAAA;QACD,OAAO,EAAE,OAAO,EAAE,KAAc,EAAE,CAAA;IACtC,CAAC;IACD,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAEhD,OAAO;QACH,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,IAAI,4BAAS,CAAC;YACjB,MAAM,EAAE,mBAAmB;YAC3B,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,uBAAM,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;YACzD,IAAI,EAAE,OAAO;SAChB,CAAC;KACL,CAAA;AACL,CAAC;AAED,SAAS,qBAAqB,CAC1B,KAAsB,EACtB,mBAAwC,EACxC,aAAuB,EACvB,WAAwB;IAExB,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAA;IAChC,IAAI,CAAC,CAAC,MAAM,YAAY,mBAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,WAAW,CAAC,KAAK,CAAC,mBAAmB,EAAE,yCAAyC,CAAC,CAAA;QACjF,OAAO,EAAE,OAAO,EAAE,KAAc,EAAE,CAAA;IACtC,CAAC;IAED,4DAA4D;IAC5D,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,8BAA8B,CAAC,aAAa,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAA;IAEnH,IAAI,CAAC,cAAc,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;QACnF,IAAI,gBAAgB,EAAE,CAAC;YACnB,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,KAAK,EAAE,IAAI,4BAAS,CAAC;oBACjB,MAAM,EAAE,mBAAmB;oBAC3B,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,CAAC,gBAAgB,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;iBAChE,CAAC;aACL,CAAA;QACL,CAAC;QAED,WAAW,CAAC,KAAK,CAAC,mBAAmB,EAAE,wBAAwB,CAAC,CAAA;QAChE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IAC7B,CAAC;IAED,OAAO;QACH,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,IAAI,4BAAS,CAAC;YACjB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,OAAO;SAChB,CAAC;KACL,CAAA;AACL,CAAC;AAED,SAAgB,8BAA8B,CAC1C,aAAuB,EACvB,WAAwB,EACxB,mBAAwC;IAExC,IAAI,cAAc,GAAG,EAAE,CAAA;IACvB,IAAI,OAAO,GAAG,EAAE,CAAA;IAEhB,QAAQ,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;QACvB,KAAK,QAAQ;YACT,cAAc,GAAG,SAAS,CAAA,CAAC,yGAAyG;YACpI,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC1C,MAAK;QACT,KAAK,eAAe;YAChB,iGAAiG;YACjG,wFAAwF;YACxF,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,6DAA6D;gBAC7D,cAAc,GAAG,eAAe,CAAA;gBAChC,OAAO,GAAG,EAAE,CAAA;YAChB,CAAC;iBAAM,CAAC;gBACJ,4EAA4E;gBAC5E,cAAc,GAAG,eAAe,CAAA;gBAChC,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC9C,CAAC;YACD,MAAK;QACT,KAAK,SAAS;YACV,cAAc,GAAG,SAAS,CAAA;YAC1B,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC1C,MAAK;QACT,KAAK,SAAS;YACV,kFAAkF;YAClF,6DAA6D;YAC7D,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,iDAAiD;gBACjD,cAAc,GAAG,SAAS,CAAA;gBAC1B,OAAO,GAAG,EAAE,CAAA;YAChB,CAAC;iBAAM,CAAC;gBACJ,mEAAmE;gBACnE,WAAW,CAAC,KAAK,CACb,mBAAmB,EACnB,sEAAsE,CACzE,CAAA;gBACD,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;YAClD,CAAC;YACD,MAAK;QACT;YACI,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IACtD,CAAC;IAED,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,CAAA;AACtC,CAAC;AAED;;;;GAIG;AACH,SAAS,uBAAuB,CAAC,eAAgC;IAC7D,MAAM,KAAK,GAAG,eAAe,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,mBAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;IAC3G,MAAM,eAAe,GAAG,KAAK;QACzB,EAAE,eAAe,CAAC,mBAAE,CAAC,UAAU,CAAC,aAAa,CAAC;QAC9C,EAAE,eAAe,CAAC,mBAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;IAEnD,IAAI,CAAC,eAAe,IAAI,IAAA,6BAAqB,EAAC,eAAe,CAAC,KAAK,iCAAU,CAAC,QAAQ,EAAE,CAAC;QACrF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,oDAAoD;IACpD,OAAO,eAAe,CAAC,OAAO,EAAE,CAAA;AACpC,CAAC;AAEY,QAAA,cAAc,GAAG,uBAAM,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,gBAAgB;IACtB,MAAM,EAAE;QACJ;YACI,KAAK,EAAE,oCAAmB;YAC1B,SAAS,EAAE,CAAC,QAAQ,CAAC;YACrB,KAAK,CAAC,UAAU,CAAC,mBAAmB,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE;gBAC5D,6EAA6E;gBAC7E,MAAM,QAAQ,GAAG,IAAA,gCAAwB,EAAC,mBAAmB,CAAC,eAAe,EAAE,EAAE,cAAc,CAAC,CAAA;gBAChG,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACZ,WAAW,CAAC,KAAK,CAAC,mBAAmB,EAAE,uDAAuD,CAAC,CAAA;oBAC/F,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;gBAC7B,CAAC;gBACD,MAAM,aAAa,GAAa,EAAE,CAAA;gBAClC,mBAAmB,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;oBAClD,IAAI,OAAO,YAAY,gCAAe,EAAE,CAAC;wBACrC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;oBACzC,CAAC;gBACL,CAAC,CAAC,CAAA;gBAEF,MAAM,KAAK,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAA;gBACzD,IAAI,KAAK,CAAC,EAAE,CAAC,gCAAe,CAAC,EAAE,CAAC;oBAC5B,OAAO,qBAAqB,CAAC,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;gBACxF,CAAC;gBACD,MAAM,MAAM,GAAG,MAAM,IAAA,qCAA6B,EAAC,KAAK,EAAE,SAAS,CAAC,CAAA;gBAEpE,IAAI,MAAM,EAAE,EAAE,CAAC,uBAAM,CAAC,EAAE,CAAC;oBACrB,OAAO,gBAAgB,CAAC,MAAM,EAAE,mBAAmB,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;gBACpF,CAAC;gBAED,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;YAC7B,CAAC;SACJ;QACD;YACI,KAAK,EAAE,wCAAuB;YAC9B,SAAS,EAAE,CAAC,QAAQ,CAAC;YACrB,KAAK,CAAC,UAAU,CAAC,KAA8B,EAAE,EAAE,SAAS,EAAE;gBAC1D,MAAM,KAAK,GAA2B,EAAE,CAAA;gBACxC,MAAM,IAAI,GAAG,KAAK,CAAC,cAAc,EAAE,CAAA;gBACnC,MAAM,WAAW,GAAG,IAAI,CAAA;gBAExB,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACzB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC3B,CAAC;gBAED,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;oBAClC,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;oBACjC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;oBAEzC,MAAM,eAAe,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,oCAAmB,EAAE,gCAAe,CAAC,CAAC;wBACnE,CAAC,CAAC,MAAM,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,sBAAc,CAAC,CAAC,wFAAwF;wBAC3I,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAA;oBAE1C,IAAI,eAAe,CAAC,OAAO,EAAE,CAAC;wBAC1B,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAA;wBACvC,IAAI,SAAS,YAAY,4BAAS,EAAE,CAAC;4BACjC,sFAAsF;4BACtF,IAAI,SAAS,CAAC,iBAAiB,EAAE,KAAK,SAAS,EAAE,CAAC;gCAC9C,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;4BACzB,CAAC;iCAAM,CAAC;gCACJ,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAA;4BACpC,CAAC;4BACD,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;wBAC3B,CAAC;wBAED,IAAI,SAAS,YAAY,mCAAgB,EAAE,CAAC;4BACxC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAA;4BAChC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;wBAC3B,CAAC;oBACL,CAAC;gBACL,CAAC;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,KAAK,EAAE,IAAI,oCAAiB,CAAC;wBACzB,MAAM,EAAE,KAAK;wBACb,KAAK;qBACR,CAAC;iBACL,CAAA;YACL,CAAC;SACJ;QACD;YACI,KAAK,EAAE,gCAAe;YACtB,SAAS,EAAE,CAAC,QAAQ,CAAC;YACrB,KAAK,CAAC,UAAU,CAAC,eAAe;gBAC5B,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,eAAe,CAAC,CAAA;gBACjE,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBACpB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;gBAC7B,CAAC;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,KAAK,EAAE,IAAI,mCAAgB,CAAC;wBACxB,MAAM,EAAE,eAAe;wBACvB,IAAI,EAAE,SAAS;wBACf,IAAI,EAAE,gBAAgB;qBACzB,CAAC;iBACL,CAAA;YACL,CAAC;SACJ;KACJ;CACJ,CAAC,CAAA"}

package/dist/flow/plugins/flow-definition-plugin.d.ts

@@ -0,0 +1,2 @@
+import { Plugin } from '@servicenow/sdk-build-core';
+export declare const FlowDefinitionPlugin: Plugin;