@servicenow/sdk-build-plugins 4.4.1 → 4.6.0

package/src/flow/plugins/trigger-plugin.ts

@@ -1,9 +1,11 @@
 import { CallExpressionShape, Plugin } from '@servicenow/sdk-build-core'
 import { buildVariableShapes, complexObjectMatchesIoRecord } from '../utils/flow-io-to-record'
 import { NowIdShape } from '../../now-id-plugin'
+import { createSdkDocEntry } from '../../utils'
 
 export const TriggerPlugin = Plugin.create({
     name: 'TriggerPlugin',
+    docs: [createSdkDocEntry('TriggerDefinition', ['sys_hub_trigger_definition'])],
     records: {
         sys_hub_trigger_definition: {
             relationships: {

package/src/flow/plugins/wfa-datapill-plugin.ts

@@ -117,6 +117,7 @@ function extractMetadataFromType(node: ts.Node): {
  */
 export const WfaDataPillPlugin = Plugin.create({
     name: 'WfaDataPillPlugin',
+    docs: [],
     nodes: [
         {
             node: 'CallExpression',
@@ -129,10 +130,13 @@ export const WfaDataPillPlugin = Plugin.create({
                     return { success: false }
                 }
 
-                // Validate wfa.dataPill is inside a Flow or Subflow call expression
-                const ancestorFlowOrSubflow = findAncestorByCalleeName(node, 'Flow', 'Subflow')
-                if (!ancestorFlowOrSubflow) {
-                    diagnostics.error(node, 'wfa.dataPill() cannot be used outside of a Flow or Subflow context.')
+                // Validate wfa.dataPill is inside a Flow or Subflow or action call expression
+                const isDataPillAncestorValid = findAncestorByCalleeName(node, 'Flow', 'Subflow', 'Action')
+                if (!isDataPillAncestorValid) {
+                    diagnostics.error(
+                        node,
+                        'wfa.dataPill() cannot be used outside of a Flow, Subflow, or Action context.'
+                    )
                     return { success: false }
                 }
 
@@ -204,7 +208,24 @@ export const WfaDataPillPlugin = Plugin.create({
                         return { success: true, value: shapeResult.value }
                     }
                 }
-                diagnostics.error(expressionArg, 'wfa.dataPill: failed to resolve expression or type')
+                // Inside Action() bodies, step output datapills (e.g., create_record_step.record)
+                // reference local const variables that can't be resolved during the shape phase.
+                // These are handled by the ActionDefinitionPlugin's toRecord handler for Action() instead.
+                // Action input pills (params.inputs.xxx) DO resolve here — only step variable
+                // references fail, so an unresolved pill in an Action body is expected for step refs
+                // but could indicate a typo for other cases. Emit a hint (not error) to surface
+                // potential issues without blocking the build.
+                const actionAncestor = findAncestorByCalleeName(node, 'Action')
+                if (actionAncestor) {
+                    diagnostics.hint(
+                        expressionArg,
+                        'wfa.dataPill: expression could not be resolved at compile time. ' +
+                            'If this references a step output variable, it will be resolved during build. ' +
+                            'Otherwise, check for typos in the property path.'
+                    )
+                } else {
+                    diagnostics.error(expressionArg, 'wfa.dataPill: failed to resolve expression or type')
+                }
                 return { success: false }
             },
         },

package/src/flow/post-install.ts

@@ -0,0 +1,93 @@
+import type { PostInstallTask, PostInstallContext } from '@servicenow/sdk-build-core'
+
+type ActivateFlowsResult = {
+    status: string
+    summary: {
+        total: number
+        succeeded: number
+        failed: number
+    }
+    results: Array<{
+        sys_id: string
+        flow_name?: string
+        status: string
+        message?: string
+        errorMessage?: string
+    }>
+}
+
+async function activateFlows(context: PostInstallContext): Promise<void> {
+    const { instanceClient, logger, config } = context
+    const { scopeId } = config
+
+    if (!instanceClient) {
+        logger.debug('No instance connection available, skipping flow activation')
+        return
+    }
+
+    logger.debug('Activating flows...')
+
+    const response = await instanceClient.fetch(
+        'api/now/wfa_fluent/activate_flows',
+        {
+            method: 'POST',
+            headers: { Accept: 'application/json' },
+        },
+        new URLSearchParams({ sysparm_transaction_scope: scopeId })
+    )
+
+    // 422 = all flows failed — still returns a valid result body
+    // Any other non-OK status (400, 401, 403, 500, etc.) is an error
+    if (!response.ok && response.status !== 422) {
+        const body = await response.json().catch(() => null)
+        const msg = body?.error?.message ?? body?.message ?? response.statusText
+
+        // Instances without the endpoint return 400 with "does not represent any resource"
+        if (msg.includes('does not represent any resource')) {
+            logger.debug(
+                'Flow activation endpoint not found. Make sure you have the latest ServiceNow IDE installed on your instance.'
+            )
+            return
+        }
+
+        throw new Error(`Failed to activate flows: ${msg}`)
+    }
+
+    const body = (await response.json()) as { result: ActivateFlowsResult }
+    const { summary, results } = body.result
+
+    if (summary.total === 0) {
+        logger.debug('No flows to activate')
+        return
+    }
+
+    if (summary.failed === 0) {
+        logger.info(`Flow activation complete: ${summary.succeeded}/${summary.total} succeeded`)
+        return
+    }
+
+    const failures = results.filter((r) => r.status !== 'success')
+    const MAX_LOGGED_FAILURES = 5
+    for (const r of failures.slice(0, MAX_LOGGED_FAILURES)) {
+        logger.warn(
+            `  Failed: ${r.flow_name ?? r.sys_id} — ${r.message ?? ''}${r.errorMessage ? `: ${r.errorMessage}` : ''}`
+        )
+    }
+    if (failures.length > MAX_LOGGED_FAILURES) {
+        logger.warn(`  ... and ${failures.length - MAX_LOGGED_FAILURES} more`)
+    }
+
+    const msg = `Flow activation complete: ${summary.succeeded}/${summary.total} succeeded, ${summary.failed} failed`
+    if (summary.succeeded === 0) {
+        throw new Error(msg)
+    }
+    logger.warn(msg)
+}
+
+export const FlowActivationTask: PostInstallTask = {
+    name: 'flow-activation',
+    skipFlag: 'skipFlowActivation',
+    skipFlagDescription: 'Skip activating (publishing) flows after install',
+    runFor: 'both',
+    run: activateFlows,
+}

package/src/flow/utils/complex-object-resolver.ts

@@ -824,7 +824,10 @@ function buildChildrenArray(
         } else if (typeof fieldType === 'string') {
             // Primitive field with value
             if (shouldIncludeField(fieldValue)) {
-                const value = isDataPill(fieldValue) ? stripDataPillType(fieldValue) : ''
+                // DEF0792627: Preserve the |type annotation so extractDataPillsFromChildren()
+                // uses the developer-specified type instead of injecting parameter.type.
+                // The annotation is stripped later by STRIP_DATATYPE_FROM_PILL_REGEX after extraction.
+                const value = isDataPill(fieldValue) ? String(fieldValue) : ''
                 const parameter = createChildParameter(
                     key,
                     fieldType.toLowerCase(),

package/src/flow/utils/complex-objects.ts

@@ -25,6 +25,8 @@ const COLUMN_TYPE_TO_SCHEMA_TYPE = {
     'array.boolean': 'Boolean',
     'array.datetime': 'Date',
     reference: 'Reference',
+    float: 'Float',
+    json: 'Json',
 }
 
 /**
@@ -84,7 +86,7 @@ const buildFieldFacet = ({
     const additionalProperties: globalThis.Record<string, unknown> = {}
 
     // Handle reference columns - extract reference table
-    if (uiType === 'reference') {
+    if (uiType === 'reference' || uiType === 'records') {
         const referenceTable = config.get('referenceTable')?.ifString()?.getValue()
         if (referenceTable) {
             additionalProperties['reference'] = referenceTable
@@ -641,7 +643,10 @@ function validateArrayElementType(
     diagnostics: Diagnostics
 ) {
     if (!ALLOWED_ARRAY_TYPES.includes(elementTypeString)) {
-        diagnostics.error(elementType, 'Invalid array element type')
+        diagnostics.error(
+            elementType,
+            `'${elementTypeString}' type fields are not allowed inside FlowArray structures. Allowed types are: ${ALLOWED_ARRAY_TYPES.join(', ')}.`
+        )
     }
 }
 
@@ -651,6 +656,9 @@ function validateObjectElementType(
     diagnostics: Diagnostics
 ) {
     if (!ALLOWED_OBJECT_TYPES.includes(elementTypeString)) {
-        diagnostics.error(elementType, 'Invalid array element type')
+        diagnostics.error(
+            elementType,
+            `'${elementTypeString}' type fields are not allowed inside FlowObject or FlowArray structures. Allowed types are: ${ALLOWED_OBJECT_TYPES.join(', ')}.`
+        )
     }
 }