@servicenow/sdk-build-plugins 4.0.2 → 4.1.1

package/src/application-menu-plugin.ts

@@ -1,4 +1,4 @@
-import { CallExpressionShape, Plugin } from '@servicenow/sdk-build-core'
+import { CallExpressionShape, Plugin, type RecordId } from '@servicenow/sdk-build-core'
 import { NowIdShape } from './now-id-plugin'
 
 /**
@@ -31,7 +31,21 @@ export const ApplicationMenuPlugin = Plugin.create({
                     inverse: true,
                 },
             },
-            toShape(record, { factory }) {
+            async toShape(record, { factory }) {
+                const roles = record.get('roles')
+                const roleNames = roles.ifString()?.ifNotEmpty()?.split(',') ?? []
+                const roleReferences: RecordId[] = []
+
+                for (const roleName of roleNames) {
+                    roleReferences.push(
+                        await factory.createReference({
+                            source: roles,
+                            table: 'sys_user_role',
+                            keys: { name: roleName },
+                        })
+                    )
+                }
+
                 return {
                     success: true,
                     value: new CallExpressionShape({
@@ -47,17 +61,7 @@ export const ApplicationMenuPlugin = Plugin.create({
                                 name: $.def(''),
                                 active: $.toBoolean().def(true),
                                 order: $.map((v) => v.ifString()?.ifNotEmpty()?.toNumber()).def(100),
-                                roles: $.map((v) => {
-                                    const roleNames =
-                                        v.isString() && v.asString().getValue() !== '' ? v.asString().split(',') : []
-                                    return roleNames.map((roleName) =>
-                                        factory.createReference({
-                                            source: v,
-                                            table: 'sys_user_role',
-                                            keys: { name: roleName },
-                                        })
-                                    )
-                                }).def([]),
+                                roles: $.val(roleReferences).def([]),
                             })),
                         ],
                     }),
@@ -74,34 +78,30 @@ export const ApplicationMenuPlugin = Plugin.create({
                     return { success: false }
                 }
 
+                const menu = callExpression.getArgument(0).asObject()
                 return {
                     success: true,
-                    value: callExpression
-                        .getArgument(0)
-                        .asObject()
-                        .pipe((menu) =>
-                            factory.createRecord({
-                                source: callExpression,
-                                table: 'sys_app_application',
-                                explicitId: menu.get('$id'),
-                                properties: menu.transform(({ $ }) => ({
-                                    title: $,
-                                    hint: $.def(''),
-                                    description: $.def(''),
-                                    name: $.def(''),
-                                    active: $.def(true),
-                                    order: $.def(100),
-                                    device_type: $.val('browser'),
-                                    roles: $.map((v) =>
-                                        v
-                                            .ifArray()
-                                            ?.map((r) => (r.ifRecord()?.get('name') ?? r.asString()).getValue())
-                                            .join(',')
-                                    ).def(''),
-                                    category: $,
-                                })),
-                            })
-                        ),
+                    value: await factory.createRecord({
+                        source: callExpression,
+                        table: 'sys_app_application',
+                        explicitId: menu.get('$id'),
+                        properties: menu.transform(({ $ }) => ({
+                            title: $,
+                            hint: $.def(''),
+                            description: $.def(''),
+                            name: $.def(''),
+                            active: $.def(true),
+                            order: $.def(100),
+                            device_type: $.val('browser'),
+                            roles: $.map((v) =>
+                                v
+                                    .ifArray()
+                                    ?.map((r) => (r.ifRecord()?.get('name') ?? r.asString()).getValue())
+                                    .join(',')
+                            ).def(''),
+                            category: $,
+                        })),
+                    }),
                 }
             },
         },

package/src/atf/test-plugin.ts

@@ -171,15 +171,17 @@ export const TestPlugin = Plugin.create({
             coalesce: ['document', 'document_key', 'variable'],
         },
         sys_atf_step: {
-            toFile(step, { database }) {
+            composite: true,
+            toFile(step, { database, config }) {
                 const recordUpdate = create().ele('record_update', { table: 'sys_atf_step' })
-                const stepElement = recordUpdate.ele('sys_atf_step', { action: 'INSERT_OR_UPDATE' })
+                const stepElement = recordUpdate.ele('sys_atf_step', { action: step.getAction() })
                 const stepId = step.getId().getValue()
                 if (!stepId) {
                     throw new Error('Invalid step id')
                 }
 
                 stepElement.ele('sys_id').txt(stepId)
+                stepElement.ele('sys_scope', { display_value: config.scope }).txt(config.scopeId)
 
                 Object.entries(step.properties()).forEach(([key, value]) => {
                     stepElement.ele(key).txt(value.ifDefined()?.toString()?.getValue() ?? '')
@@ -196,7 +198,7 @@ export const TestPlugin = Plugin.create({
                 })
 
                 variableValues.forEach((varRecord) => {
-                    const variableElement = recordUpdate.ele('sys_variable_value', { action: 'INSERT_OR_UPDATE' })
+                    const variableElement = recordUpdate.ele('sys_variable_value', { action: step.getAction() })
                     variableElement.ele('sys_id').txt(varRecord.getId().getValue())
                     Object.entries(varRecord.properties()).forEach(([key, value]) => {
                         variableElement.ele(key).txt(value instanceof UndefinedShape ? '' : value.toString().getValue())
@@ -213,7 +215,7 @@ export const TestPlugin = Plugin.create({
 
                 elementMappingRecords.forEach((record) => {
                     const elementMappingElement = recordUpdate.ele('sys_element_mapping', {
-                        action: 'INSERT_OR_UPDATE',
+                        action: step.getAction(),
                     })
                     elementMappingElement.ele('sys_id').txt(record.getId().getValue())
                     Object.entries(record.properties()).forEach(([key, value]) => {
@@ -224,6 +226,7 @@ export const TestPlugin = Plugin.create({
                 return {
                     success: true,
                     value: {
+                        source: step,
                         name: `sys_atf_step_${step.getId().getValue()}.xml`,
                         category: step.getInstallCategory(),
                         content: recordUpdate.end({ prettyPrint: true }),
@@ -253,7 +256,7 @@ export const TestPlugin = Plugin.create({
                     return { success: false }
                 }
 
-                const testRecord = factory.createRecord({
+                const testRecord = await factory.createRecord({
                     source: callExpression,
                     table: 'sys_atf_test',
                     explicitId: testId,
@@ -265,85 +268,83 @@ export const TestPlugin = Plugin.create({
                     })),
                 })
 
-                const stepRecords = steps.map((step, index) => {
-                    const rawTimeout = step.values.get('timeout')
-                    const timeout = rawTimeout.isUndefined()
-                        ? step.defaultTimeout
-                        : convertTimeoutToSystemFormat(rawTimeout)
-
-                    return factory.createRecord({
-                        table: 'sys_atf_step',
-                        source: step.source,
-                        explicitId: step.values.get('$id'),
-                        properties: step.values.transform(({ $ }) => ({
-                            active: $.toBoolean().def(true),
-                            description: $,
-                            display_name: $.val(step.displayName),
-                            notes: $,
-                            order: $.val(index + 1),
-                            step_config: $.val(step.stepConfigId),
-                            table: $.val(step.table),
-                            test: $.val(testRecord.getId()),
-                            timeout: $.val(timeout),
-                            warning_message: $.from('warning'),
-                        })),
+                const stepRecords = await Promise.all(
+                    steps.map(async (step, index) => {
+                        const rawTimeout = step.values.get('timeout')
+                        const timeout = rawTimeout.isUndefined()
+                            ? step.defaultTimeout
+                            : convertTimeoutToSystemFormat(rawTimeout)
+
+                        return await factory.createRecord({
+                            table: 'sys_atf_step',
+                            source: step.source,
+                            explicitId: step.values.get('$id'),
+                            properties: step.values.transform(({ $ }) => ({
+                                active: $.toBoolean().def(true),
+                                description: $,
+                                display_name: $.val(step.displayName),
+                                notes: $,
+                                order: $.val(index + 1),
+                                step_config: $.val(step.stepConfigId),
+                                table: $.val(step.table),
+                                test: $.val(testRecord.getId()),
+                                timeout: $.val(timeout),
+                                warning_message: $.from('warning'),
+                            })),
+                        })
                     })
-                })
-
-                const stepAndVariableValueRecords = steps.flatMap((step, index) => {
-                    const variableRecords: RecordShape[] = Object.entries(step.variables).flatMap(
-                        ([varName, atfVariableInfo]) => {
-                            const valueShape = step.values.get(varName, false)
-
-                            let elementMappingRecord: RecordShape | undefined
-
-                            const value = createGemExpressionsFromShape(valueShape, stepRecords, diagnostics)
-                            if (value !== undefined) {
-                                elementMappingRecord = factory.createRecord({
-                                    table: 'sys_element_mapping',
-                                    source: step.source,
-                                    properties: {
-                                        field: atfVariableInfo.field,
-                                        id: stepRecords[index]?.getId(),
-                                        table: `var__m_atf_input_variable_${step.stepConfigId}`,
-                                        value: serializeValueToRecord(
-                                            value,
-                                            atfVariableInfo.type,
-                                            atfVariableInfo.default
-                                        ),
-                                    },
-                                })
-                            }
-
-                            return [
-                                factory.createRecord({
-                                    table: 'sys_variable_value',
-                                    source: step.source,
-                                    properties: {
-                                        document: 'sys_atf_step',
-                                        document_key: stepRecords[index]?.getId(),
-                                        value: serializeValueToRecord(
-                                            value ??
-                                                valueShape
-                                                    .ifArray()
-                                                    ?.getElements()
-                                                    .map((v) => v.ifRecord()?.getId().getValue() ?? v.getValue()) ??
-                                                valueShape.ifResolvable()?.resolve().ifRecord()?.getId().getValue() ??
-                                                valueShape.getValue(),
-                                            atfVariableInfo.type,
-                                            atfVariableInfo.default
-                                        ),
-                                        variable: atfVariableInfo.inputVariableId,
-                                        order: atfVariableInfo.order,
-                                    },
-                                }),
-                                ...(elementMappingRecord ? [elementMappingRecord] : []),
-                            ]
+                )
+
+                const stepAndVariableValueRecords: RecordShape[] = []
+                for (const [index, step] of steps.entries()) {
+                    for (const [varName, atfVariableInfo] of Object.entries(step.variables)) {
+                        const valueShape = step.values.get(varName, false)
+
+                        let elementMappingRecord: RecordShape | undefined
+
+                        const value = createGemExpressionsFromShape(valueShape, stepRecords, diagnostics)
+                        if (value !== undefined) {
+                            elementMappingRecord = await factory.createRecord({
+                                table: 'sys_element_mapping',
+                                source: step.source,
+                                properties: {
+                                    field: atfVariableInfo.field,
+                                    id: stepRecords[index]?.getId(),
+                                    table: `var__m_atf_input_variable_${step.stepConfigId}`,
+                                    value: serializeValueToRecord(value, atfVariableInfo.type, atfVariableInfo.default),
+                                },
+                            })
                         }
-                    )
 
-                    return variableRecords
-                })
+                        stepAndVariableValueRecords.push(
+                            await factory.createRecord({
+                                table: 'sys_variable_value',
+                                source: step.source,
+                                properties: {
+                                    document: 'sys_atf_step',
+                                    document_key: stepRecords[index]?.getId(),
+                                    value: serializeValueToRecord(
+                                        value ??
+                                            valueShape
+                                                .ifArray()
+                                                ?.getElements()
+                                                .map((v) => v.ifRecord()?.getId().getValue() ?? v.getValue()) ??
+                                            valueShape.ifResolvable()?.resolve().ifRecord()?.getId().getValue() ??
+                                            valueShape.getValue(),
+                                        atfVariableInfo.type,
+                                        atfVariableInfo.default
+                                    ),
+                                    variable: atfVariableInfo.inputVariableId,
+                                    order: atfVariableInfo.order,
+                                },
+                            })
+                        )
+
+                        if (elementMappingRecord) {
+                            stepAndVariableValueRecords.push(elementMappingRecord)
+                        }
+                    }
+                }
 
                 return {
                     success: true,

package/src/basic-syntax-plugin.ts

@@ -23,6 +23,7 @@ import {
     removeReferences,
     remove,
     isFluentFile,
+    path as pathModule,
 } from '@servicenow/sdk-build-core'
 
 export const BasicSyntaxPlugin = Plugin.create({
@@ -34,6 +35,53 @@ export const BasicSyntaxPlugin = Plugin.create({
         },
     ],
     shapes: [
+        {
+            shape: SourceFileShape,
+            getTarget(shape, { compiler, project }) {
+                const source = shape.getOriginalSource()
+                return {
+                    success: true,
+                    value: ts.Node.isNode(source)
+                        ? source
+                        : compiler.getOrCreateSourceFile(project.resolvePath(shape.getPath())),
+                }
+            },
+            commit(shape, _target, { project }) {
+                const file = project.getFileIfExists(shape.getPath())
+                if (file) {
+                    file.setContent(shape.getContent())
+                } else {
+                    project.addFile({ path: shape.getPath(), content: shape.getContent() })
+                }
+
+                return { success: true }
+            },
+        },
+        {
+            shape: Shape,
+            getTarget(shape, { compiler, project, config }) {
+                const source = shape.getOriginalSource()
+                if (ts.Node.isNode(source)) {
+                    return { success: true, value: source }
+                }
+
+                // Avoid creating empty files with undefined shapes or deleted records
+                if (shape.isNoOp() || shape.isUndefined() || (shape.isRecord() && shape.isDeleted())) {
+                    return { success: false }
+                }
+
+                const name = pathModule.basename(source.path).replace(RegExp(`${pathModule.extname(source.path)}$`), '')
+                const file = compiler.getOrCreateSourceFile(project.resolvePath(config.generatedDir, `${name}.now.ts`))
+                const statement = project
+                    .addFile(file.getFilePath(), { resolveDependencies: false })
+                    .addStatement(shape.getCode())
+
+                return {
+                    success: true,
+                    value: statement.isKind(ts.SyntaxKind.ExpressionStatement) ? statement.getExpression() : statement,
+                }
+            },
+        },
         {
             shape: DeletedShape,
             commit(_, target) {
@@ -271,6 +319,11 @@ export const BasicSyntaxPlugin = Plugin.create({
             shape: VariableStatementShape,
             async commit(shape, target, { commit }) {
                 if (!ts.Node.isVariableStatement(target)) {
+                    const parentStatement = target.getParentIfKind(ts.SyntaxKind.ExpressionStatement)
+                    if (ts.Node.isCallExpression(target) && parentStatement) {
+                        parentStatement.replaceWithText(shape.getCode())
+                        return { success: true }
+                    }
                     target.replaceWithText(shape.getCode())
                     return { success: true }
                 }
@@ -325,7 +378,7 @@ export const BasicSyntaxPlugin = Plugin.create({
 
                 return {
                     success: true,
-                    value: new SourceFileShape({ file }),
+                    value: new SourceFileShape({ source: file, path: file.getFilePath(), content: file.getFullText() }),
                 }
             },
         },

package/src/business-rule-plugin.ts

@@ -2,6 +2,7 @@ import { CallExpressionShape, type ObjectShape, Plugin, type ArrayShape, type Sh
 import { ModuleFunctionShape } from './server-module-plugin'
 import { NowIdShape } from './now-id-plugin'
 import { generateDeprecatedDiagnostics } from './utils'
+import { NowIncludeShape } from './now-include-plugin'
 
 // Similar to lodash's groupBy, but simply stores the last element of each group
 function groupByExistence<T>(collection: T[] | undefined, keyProvider: (element: T) => string): { [key: string]: T } {
@@ -43,7 +44,9 @@ export const BusinessRulePlugin = Plugin.create({
     name: 'BusinessRulePlugin',
     records: {
         sys_script: {
-            toShape(record) {
+            async toShape(record, { transform }) {
+                const script = await NowIncludeShape.fromRecord(record, record.get('script'), transform)
+
                 return {
                     success: true,
                     value: new CallExpressionShape({
@@ -71,8 +74,8 @@ export const BusinessRulePlugin = Plugin.create({
                                     roleConditions: $.from('role_conditions').map((v) =>
                                         v.ifString()?.ifNotEmpty()?.getValue().split(',')
                                     ),
-                                    script: $.def(DEFAULT_SCRIPT),
-                                    priority: $.map((p) => p.ifNumber()?.asNumber()).def(100),
+                                    script: $.val(script).def(DEFAULT_SCRIPT),
+                                    priority: $.map((p) => p.ifString()?.ifNotEmpty()?.toNumber()).def(100),
 
                                     changeFields: $.from('change_fields').toBoolean().def(false),
                                     clientCallable: $.from('client_callable').toBoolean().def(false),
@@ -131,89 +134,87 @@ export const BusinessRulePlugin = Plugin.create({
                     return { success: false }
                 }
 
-                const arg = callExpression.getArgument(0).asObject().withAliasedKeys(brAliases)
-                const rest = arg.get('rest').ifDefined()?.asObject()
+                const br = callExpression.getArgument(0).asObject().withAliasedKeys(brAliases)
+                const rest = br.get('rest').ifDefined()?.asObject()
 
-                generateDeprecatedDiagnostics(arg, diagnostics)
+                generateDeprecatedDiagnostics(br, diagnostics)
 
-                if (arg.get('script').isUnresolved()) {
+                if (br.get('script').isUnresolved()) {
                     diagnostics.error(
-                        arg.get('script').getOriginalNode(),
+                        br.get('script').getOriginalNode(),
                         `Unable to resolve the script reference, ensure the imported module is within the ${config.serverModulesDir} directory.`
                     )
                 }
 
                 return {
                     success: true,
-                    value: arg.pipe((br) =>
-                        factory.createRecord({
-                            source: callExpression,
-                            table: 'sys_script',
-                            explicitId: br.get('$id'),
-                            properties: br.transform(({ $, merge }) => ({
-                                name: $,
-                                order: $.def(100),
-                                active: $.def(true),
-                                message: $,
-                                add_message: $.from('addMessage').map((v) => {
-                                    return (
-                                        v.ifBoolean()?.getValue() ??
-                                        (($._('message').val as Shape).getValue() !== undefined ? true : false)
-                                    )
-                                }),
-                                condition: $,
-                                filter_condition: $.from('filterCondition'),
-                                description: $,
-                                advanced: $.val(
-                                    br
-                                        .get('script')
-                                        .pipe((script) => script.isDefined() && script.getValue() !== DEFAULT_SCRIPT)
-                                ),
-                                script: $.map(
-                                    (v) =>
-                                        v
-                                            .if(ModuleFunctionShape)
-                                            ?.toString((n) => `${n}({{PARAMS}})`, ['current', 'previous']) ?? v
+                    value: await factory.createRecord({
+                        source: callExpression,
+                        table: 'sys_script',
+                        explicitId: br.get('$id'),
+                        properties: br.transform(({ $, merge }) => ({
+                            name: $,
+                            order: $.def(100),
+                            active: $.def(true),
+                            message: $,
+                            add_message: $.from('addMessage').map((v) => {
+                                return (
+                                    v.ifBoolean()?.getValue() ??
+                                    (($._('message').val as Shape).getValue() !== undefined ? true : false)
+                                )
+                            }),
+                            condition: $,
+                            filter_condition: $.from('filterCondition'),
+                            description: $,
+                            advanced: $.val(
+                                br
+                                    .get('script')
+                                    .pipe((script) => script.isDefined() && script.getValue() !== DEFAULT_SCRIPT)
+                            ),
+                            script: $.map(
+                                (v) =>
+                                    v
+                                        .if(ModuleFunctionShape)
+                                        ?.toString((n) => `${n}({{PARAMS}})`, ['current', 'previous']) ?? v
+                            )
+                                .toCdata()
+                                .def(DEFAULT_SCRIPT),
+                            collection: $.from('table'),
+                            when: $.map((v) => (v.ifString() ? whenBidiMap.get(v.asString().getValue()) : v)).def(
+                                'before'
+                            ),
+                            [merge]: $.from('action').map((v) => {
+                                const { insertAction, updateAction, deleteAction, queryAction } = groupByExistence(
+                                    v.ifArray()?.getElements(),
+                                    (action) => `${action.asString().getValue()}Action`
                                 )
-                                    .toCdata()
-                                    .def(DEFAULT_SCRIPT),
-                                collection: $.from('table'),
-                                when: $.map((v) => (v.ifString() ? whenBidiMap.get(v.asString().getValue()) : v)).def(
-                                    'before'
-                                ),
-                                [merge]: $.from('action').map((v) => {
-                                    const { insertAction, updateAction, deleteAction, queryAction } = groupByExistence(
-                                        v.ifArray()?.getElements(),
-                                        (action) => `${action.asString().getValue()}Action`
-                                    )
 
-                                    return {
-                                        action_insert: !!insertAction,
-                                        action_update: !!updateAction,
-                                        action_query: !!queryAction,
-                                        action_delete: !!deleteAction,
-                                    }
-                                }),
-                                template: $.from('setFieldValue'),
-                                role_conditions: $.from('roleConditions').map((v) => getRolesString(v.ifArray())),
-                                abort_action: $.from('abortAction').def(false),
-                                priority: $.def(100),
+                                return {
+                                    action_insert: !!insertAction,
+                                    action_update: !!updateAction,
+                                    action_query: !!queryAction,
+                                    action_delete: !!deleteAction,
+                                }
+                            }),
+                            template: $.from('setFieldValue'),
+                            role_conditions: $.from('roleConditions').map((v) => getRolesString(v.ifArray())),
+                            abort_action: $.from('abortAction').def(false),
+                            priority: $.def(100),
 
-                                is_rest: $.val(rest?.get('webService')).def(false),
-                                rest_variables: $.val(rest?.get('variables')),
-                                rest_method: $.val(rest?.get('method')),
-                                rest_method_text: $.val(rest?.get('methodText')),
-                                rest_service: $.val(rest?.get('service')),
-                                rest_service_text: $.val(rest?.get('serviceText')),
+                            is_rest: $.val(rest?.get('webService')).def(false),
+                            rest_variables: $.val(rest?.get('variables')),
+                            rest_method: $.val(rest?.get('method')),
+                            rest_method_text: $.val(rest?.get('methodText')),
+                            rest_service: $.val(rest?.get('service')),
+                            rest_service_text: $.val(rest?.get('serviceText')),
 
-                                change_fields: $.from('changeFields').def(false),
-                                client_callable: $.from('clientCallable').def(false),
-                                execute_function: $.from('executeFunction').def(false),
-                                access: $.def('package_private'),
-                                sys_policy: $.from('protectionPolicy'),
-                            })),
-                        })
-                    ),
+                            change_fields: $.from('changeFields').def(false),
+                            client_callable: $.from('clientCallable').def(false),
+                            execute_function: $.from('executeFunction').def(false),
+                            access: $.def('package_private'),
+                            sys_policy: $.from('protectionPolicy'),
+                        })),
+                    }),
                 }
             },
         },