@servicenow/sdk-build-plugins 4.4.1 → 4.6.0

package/src/table-plugin.ts

@@ -26,7 +26,7 @@ import { create } from 'xmlbuilder2'
 import type { XMLBuilder } from 'xmlbuilder2/lib/interfaces'
 import { addFieldsToColumn } from './column/column-helper'
 import { getLabelForDefaultLanguage } from './column/column-to-record'
-import { generateDeprecatedDiagnostics } from './utils'
+import { createSdkDocEntry, generateDeprecatedDiagnostics } from './utils'
 import isEqual from 'lodash/isEqual'
 
 type GlobalRecord<T extends string | number | symbol, U> = globalThis.Record<T, U>
@@ -321,6 +321,20 @@ type SysDocumentationProperties = {
     help: string | undefined
 }
 
+type SysDictionaryOverrideProperties = {
+    name: string
+    element: string
+    base_table: string | undefined
+    default: string | undefined
+    calculation: string | undefined
+    reference_qual: string | undefined
+    read_only_option: string | undefined
+    dependent: string | undefined
+    mandatory: boolean | undefined
+    display: boolean | undefined
+    attributes: string | undefined
+}
+
 /**
  * The access levels are mapped to the following values on the platform
  *
@@ -370,6 +384,7 @@ const licensingAliases = {
 
 export const TablePlugin = Plugin.create({
     name: 'TablePlugin',
+    docs: [createSdkDocEntry('Table', ['sys_db_object'])],
     files: [
         {
             matcher: /\.xml$/,
@@ -389,7 +404,7 @@ export const TablePlugin = Plugin.create({
                     return { success: false }
                 }
 
-                const recordDefs = tableDefToRecordProperties(tableDef, config.tableDefaultLanguage)
+                const recordDefs = tableDefToRecordProperties(tableDef, config.defaultLanguage)
                 const records: Record[] = []
                 for (const [key, table] of [
                     ['sysDbObject', 'sys_db_object'],
@@ -397,6 +412,7 @@ export const TablePlugin = Plugin.create({
                     ['sysChoice', 'sys_choice'],
                     ['sysIndex', 'sys_index'],
                     ['sysDocumentation', 'sys_documentation'],
+                    ['sysDictionaryOverride', 'sys_dictionary_override'],
                 ] as const) {
                     for (const rec of [recordDefs[key]].flat()) {
                         records.push(
@@ -448,6 +464,10 @@ export const TablePlugin = Plugin.create({
                         },
                     },
                 },
+                sys_dictionary_override: {
+                    via: { name: 'name' },
+                    descendant: true,
+                },
                 ua_table_licensing_config: {
                     descendant: true,
                     via: { name: 'name' },
@@ -473,9 +493,12 @@ export const TablePlugin = Plugin.create({
                 const schema: { [key: string]: CallExpressionShape } = {}
                 let displayColumn: string | undefined
                 const columns = descendants.query('sys_dictionary')
+                const overrides = descendants.query('sys_dictionary_override')
                 let collectionRecord: Record
                 const choices = descendants.query('sys_choice')
                 const documentation = descendants.query('sys_documentation')
+
+                // Process regular columns
                 for (const column of columns) {
                     if (column.get('internal_type').getValue() === 'collection') {
                         // 'collection' sys_dictionary record only has table properties
@@ -488,13 +511,89 @@ export const TablePlugin = Plugin.create({
                         documentation: documentation.filter(
                             (d) => d.get('element').ifString()?.getValue() === columnName
                         ),
-                        tableDefaultLanguage: config.tableDefaultLanguage,
+                        tableDefaultLanguage: config.defaultLanguage,
                     })
                     if (column.get('display').ifDefined()?.toBoolean().getValue()) {
                         displayColumn = columnName
                     }
                 }
 
+                // Process dictionary overrides as OverrideColumn
+                for (const override of overrides) {
+                    const columnName = override.get('element').asString().getValue()
+                    schema[columnName] = new CallExpressionShape({
+                        source: override,
+                        callee: 'OverrideColumn',
+                        args: [
+                            override.transform(({ $ }) => ({
+                                baseTable: $.from('base_table'),
+                                default: $.from('default_value_override', 'default_value').map((flag, value) => {
+                                    return flag.toBoolean()?.getValue() ? value.ifString()?.getValue() : undefined
+                                }),
+                                calculation: $.from('calculation_override', 'calculation').map((flag, value) => {
+                                    return flag.toBoolean()?.getValue() ? value.ifString()?.getValue() : undefined
+                                }),
+                                referenceQualifier: $.from('reference_qual_override', 'reference_qual').map(
+                                    (flag, value) => {
+                                        return flag.toBoolean()?.getValue() ? value.ifString()?.getValue() : undefined
+                                    }
+                                ),
+                                readOnlyOption: $.from('read_only_option_override', 'read_only_option').map(
+                                    (flag, value) => {
+                                        return flag.toBoolean()?.getValue() ? value.ifString()?.getValue() : undefined
+                                    }
+                                ),
+                                dependent: $.from('dependent_override', 'dependent').map((flag, value) => {
+                                    return flag.toBoolean()?.getValue() ? value.ifString()?.getValue() : undefined
+                                }),
+                                mandatory: $.from('mandatory_override', 'mandatory').map((flag, value) => {
+                                    return flag.toBoolean()?.getValue() ? value.toBoolean()?.getValue() : undefined
+                                }),
+                                attributes: $.from('attributes_override', 'attributes').map((flag, attrs) => {
+                                    if (!flag.toBoolean()?.getValue() || !attrs.isString()) {
+                                        return undefined
+                                    }
+                                    const result: { [key: string]: string | number | boolean } = {}
+                                    attrs
+                                        .toString()
+                                        .getValue()
+                                        .split(',')
+                                        .forEach((attr) => {
+                                            if (attr === '') {
+                                                return
+                                            }
+                                            const [key, value] = attr.split('=').map((s) => s.trim())
+                                            if (!key || value === undefined) {
+                                                return
+                                            }
+                                            if (value === 'true') {
+                                                result[key] = true
+                                            } else if (value === 'false') {
+                                                result[key] = false
+                                            } else {
+                                                // Try to parse as number
+                                                const numValue = Number(value)
+                                                if (!isNaN(numValue) && value !== '') {
+                                                    result[key] = numValue
+                                                } else {
+                                                    result[key] = value
+                                                }
+                                            }
+                                        })
+                                    return result
+                                }),
+                                display: $.from('display_override').map((v) => {
+                                    if (!v.ifDefined()) {
+                                        return undefined
+                                    }
+                                    const boolValue = v.toBoolean().getValue()
+                                    return boolValue === true ? true : undefined
+                                }),
+                            })),
+                        ],
+                    })
+                }
+
                 const tableDocumentation = documentation.filter((d) => !d.get('element').getValue())
                 const licensing = descendants.query('ua_table_licensing_config')
                 const autoNumber = descendants.query('sys_number')
@@ -628,14 +727,14 @@ export const TablePlugin = Plugin.create({
                                     (label) =>
                                         label.ifString() ??
                                         (tableDocumentation.length &&
-                                        !isDefaultDocumentation('', tableDocumentation, config.tableDefaultLanguage)
+                                        !isDefaultDocumentation('', tableDocumentation, config.defaultLanguage)
                                             ? tableDocumentation.map((doc) =>
                                                   doc
                                                       .transform(({ $ }) => ({
                                                           label: $.def(''),
                                                           help: $.def(''),
                                                           hint: $.def(''),
-                                                          language: $.def(config.tableDefaultLanguage),
+                                                          language: $.def(config.defaultLanguage),
                                                           plural: $.def(''),
                                                           url: $.def(''),
                                                           urlTarget: $.from('url_target').def(''),
@@ -717,8 +816,9 @@ export const TablePlugin = Plugin.create({
                 const documentation = descendants.query('sys_documentation')
                 const licensing = descendants.query('ua_table_licensing_config')
                 const autoNumber = descendants.query('sys_number')
-                let collectionRecord: Record | undefined
+                const overrides = descendants.query('sys_dictionary_override')
                 let displayColumn: string | undefined
+                let collectionRecord: Record | undefined
                 const elements: XMLBuilder[] = []
                 for (const column of columns) {
                     const displayValue = column.get('display').ifBoolean()?.getValue()
@@ -888,7 +988,7 @@ export const TablePlugin = Plugin.create({
                             !isDefaultDocumentation(
                                 doc.get('element')?.toString().getValue(),
                                 [doc],
-                                config.tableDefaultLanguage
+                                config.defaultLanguage
                             )
                     ),
                     config,
@@ -902,6 +1002,7 @@ export const TablePlugin = Plugin.create({
                 )
 
                 const autoNumberFiles = await generateRecordXml(autoNumber, config, transform)
+                const overrideFiles = await generateRecordXml(overrides, config, transform)
 
                 return {
                     success: true,
@@ -915,6 +1016,7 @@ export const TablePlugin = Plugin.create({
                         ...documentationFiles,
                         ...licensingFiles,
                         ...autoNumberFiles,
+                        ...overrideFiles,
                     ],
                 }
             },
@@ -926,6 +1028,13 @@ export const TablePlugin = Plugin.create({
                 value: `sys_dictionary_${record.get('name').getValue()}_${record.get('element').getValue() || 'null'}`,
             }),
         },
+        sys_dictionary_override: {
+            coalesce: ['name', 'element'],
+            getUpdateName: (record) => ({
+                success: true,
+                value: `sys_dictionary_override_${record.get('name').getValue()}_${record.get('element').getValue() || 'null'}`,
+            }),
+        },
         sys_documentation: {
             coalesce: ['name', 'element', 'language'],
             getUpdateName: (record) => ({
@@ -1020,7 +1129,7 @@ export const TablePlugin = Plugin.create({
                     ignoreColumnNameCheck = true
                 }
 
-                // sys_dictionary
+                // sys_dictionary and sys_dictionary_override
                 const schema = table.get('schema').asObject()
                 const columnIdsMap = new Map<string, string>()
                 for (const [name, column] of schema.entries()) {
@@ -1030,37 +1139,116 @@ export const TablePlugin = Plugin.create({
                             'Column name must only contain lowercase letters, numbers, and underscores'
                         )
                     }
+
+                    // Check if this is an OverrideColumn
                     if (
-                        !ignoreColumnNameCheck &&
-                        !tableNameMatch &&
-                        !isSNScope(scopeName) &&
-                        scopeName !== 'global' &&
-                        !name.match(scopeRegex)
+                        column.is(CallExpressionShape) &&
+                        column.as(CallExpressionShape).getCallee() === 'OverrideColumn'
                     ) {
-                        // 'sn' and 'now' scoped apps ignore this validation
-                        diagnostics.error(
-                            column.getOriginalNode().getParentIfKind(ts.SyntaxKind.PropertyAssignment) ?? column,
-                            `Column name should be prefixed with scope '${scopeName}_' if table name does not contain prefix`
-                        )
-                    } else if (scopeName === 'global' && !globalTableNameMatch && !name.match(globalRegex)) {
-                        diagnostics.error(
-                            column.getOriginalNode().getParentIfKind(ts.SyntaxKind.PropertyAssignment) ?? column,
-                            `Column name should be prefixed with 'u_' custom prefix if table name does not contain this prefix, such as when adding columns to an existing global table`
-                        )
-                    }
-                    const display = table.get('display').ifString()?.getValue() === name
-                    const result = await transform.toRecord(
-                        addFieldsToColumn(
-                            { name, table: tableName.getValue(), display },
-                            column.as(CallExpressionShape)
+                        // This is an OverrideColumn() call - get the object from its first argument
+                        const columnObj = column.as(CallExpressionShape).getArgument(0).asObject()
+
+                        // Handle OverrideColumn - create sys_dictionary_override record
+                        // Validate that the table extends another table
+                        const extendsTable = table.get('extends').ifString()?.getValue()
+                        if (!extendsTable) {
+                            diagnostics.error(
+                                column,
+                                `Cannot use OverrideColumn in table '${tableName.getValue()}' because it does not extend another table`
+                            )
+                            return { success: false }
+                        }
+
+                        // Use baseTable if provided, otherwise default to extends
+                        const baseTableValue = columnObj.get('baseTable')
+                        let baseTable: string
+
+                        if (baseTableValue.ifString()) {
+                            baseTable = baseTableValue.asString().getValue()
+                        } else {
+                            // Default to extends if baseTable not provided
+                            baseTable = extendsTable
+                        }
+
+                        // Create sys_dictionary_override record
+                        const overrideRecord = await factory.createRecord({
+                            source: statement ?? callExpression,
+                            table: 'sys_dictionary_override',
+                            properties: columnObj.transform(({ $ }) => ({
+                                name: $.val(tableName),
+                                element: $.val(name),
+                                base_table: $.val(baseTable),
+                                default_value: $.from('default'),
+                                default_value_override: $.from('default').map((v) => !!v.ifDefined()),
+                                calculation: $.from('calculation'),
+                                calculation_override: $.from('calculation').map((v) => !!v.ifDefined()),
+                                reference_qual: $.from('referenceQualifier'),
+                                reference_qual_override: $.from('referenceQualifier').map((v) => !!v.ifDefined()),
+                                read_only_option: $.from('readOnlyOption'),
+                                read_only_option_override: $.from('readOnlyOption').map((v) => !!v.ifDefined()),
+                                read_only: $.from('readOnlyOption').map((readOnlyOption) => {
+                                    // read_only should be true if readOnlyOption has a value
+                                    return !!readOnlyOption.ifDefined()
+                                }),
+                                read_only_override: $.from('readOnlyOption').map((v) => !!v.ifDefined()),
+                                dependent: $.from('dependent'),
+                                dependent_override: $.from('dependent').map((v) => !!v.ifDefined()),
+                                mandatory: $.from('mandatory').toBoolean().def(false),
+                                mandatory_override: $.from('mandatory').map((v) => !!v.ifDefined()),
+                                attributes: $.from('attributes').map((attrs) => {
+                                    if (!attrs.isObject()) {
+                                        return
+                                    }
+                                    const attrsObj = attrs.asObject().getValue()
+                                    return Object.entries(attrsObj)
+                                        .map(([key, value]) => `${key}=${value}`)
+                                        .join(',')
+                                }),
+                                attributes_override: $.from('attributes').map((v) => !!v.ifDefined()),
+                                display_override: $.from('display').map((v) => {
+                                    const boolShape = v.ifBoolean()
+                                    if (!boolShape) {
+                                        return false
+                                    }
+                                    return boolShape.getValue() === true
+                                }),
+                            })),
+                        })
+                        relatedRecords.push(overrideRecord)
+                    } else {
+                        // Handle regular column - create sys_dictionary record
+                        if (
+                            !ignoreColumnNameCheck &&
+                            !tableNameMatch &&
+                            !isSNScope(scopeName) &&
+                            scopeName !== 'global' &&
+                            !name.match(scopeRegex)
+                        ) {
+                            // 'sn' and 'now' scoped apps ignore this validation
+                            diagnostics.error(
+                                column.getOriginalNode().getParentIfKind(ts.SyntaxKind.PropertyAssignment) ?? column,
+                                `Column name should be prefixed with scope '${scopeName}_' if table name does not contain prefix`
+                            )
+                        } else if (scopeName === 'global' && !globalTableNameMatch && !name.match(globalRegex)) {
+                            diagnostics.error(
+                                column.getOriginalNode().getParentIfKind(ts.SyntaxKind.PropertyAssignment) ?? column,
+                                `Column name should be prefixed with 'u_' custom prefix if table name does not contain this prefix, such as when adding columns to an existing global table`
+                            )
+                        }
+                        const display = table.get('display').ifString()?.getValue() === name
+                        const result = await transform.toRecord(
+                            addFieldsToColumn(
+                                { name, table: tableName.getValue(), display },
+                                column.as(CallExpressionShape)
+                            )
                         )
-                    )
-                    if (!result.success) {
-                        diagnostics.error(column, 'Invalid column in table schema')
-                        return { success: false }
+                        if (!result.success) {
+                            diagnostics.error(column, 'Invalid column in table schema')
+                            return { success: false }
+                        }
+                        relatedRecords.push(result.value)
+                        columnIdsMap.set(name, result.value.getId().getValue())
                     }
-                    relatedRecords.push(result.value)
-                    columnIdsMap.set(name, result.value.getId().getValue())
                 }
 
                 // sys_index
@@ -1192,7 +1380,7 @@ export const TablePlugin = Plugin.create({
                             properties: {
                                 name: tableName,
                                 element: undefined,
-                                language: config.tableDefaultLanguage,
+                                language: config.defaultLanguage,
                                 label: table.get('label').ifString() ?? tableName,
                                 plural: generatePlural(
                                     table.get('label')?.ifString()?.getValue() ?? tableName.getValue()
@@ -1291,7 +1479,7 @@ export const TablePlugin = Plugin.create({
                             .map((actions) => hasAction('create', actions))
                             .def(false),
                         is_extendable: $.from('extensible').toBoolean().def(false),
-                        label: $.map((label) => getLabelForDefaultLanguage(label, config.tableDefaultLanguage)),
+                        label: $.map((label) => getLabelForDefaultLanguage(label, config.defaultLanguage)),
                         live_feed_enabled: $.from('liveFeed').toBoolean().def(false),
                         name: $,
                         scriptable_table: $.from('scriptableTable').toBoolean().def(false),
@@ -1468,6 +1656,7 @@ function tableDefToRecordProperties(
     sysChoice: SysChoiceProperties[]
     sysIndex: SysIndexProperties[]
     sysDocumentation: SysDocumentationProperties[]
+    sysDictionaryOverride: SysDictionaryOverrideProperties[]
 } {
     const sysDbObject: SysDbObjectProperties = {
         name: tableDef.name,
@@ -1489,6 +1678,7 @@ function tableDefToRecordProperties(
     const sysDictionary: SysDictionaryProperties[] = []
     const sysChoice: SysChoiceProperties[] = []
     const sysDocumentation: SysDocumentationProperties[] = []
+    const sysDictionaryOverride: SysDictionaryOverrideProperties[] = []
 
     // table documentation
     if (tableDef.label && tableDef.plural) {
@@ -1646,6 +1836,7 @@ function tableDefToRecordProperties(
         sysChoice,
         sysIndex,
         sysDocumentation,
+        sysDictionaryOverride,
     }
 }
 

package/src/ui-action-plugin.ts

@@ -8,9 +8,11 @@ import {
 } from '@servicenow/sdk-build-core'
 import { NowIdShape } from './now-id-plugin'
 import { ModuleFunctionShape } from './server-module-plugin'
+import { createSdkDocEntry } from './utils'
 
 export const UiActionPlugin = Plugin.create({
     name: 'UiActionPlugin',
+    docs: [createSdkDocEntry('UiAction', ['sys_ui_action'])],
     records: {
         sys_ui_action: {
             relationships: {
@@ -245,13 +247,6 @@ export const UiActionPlugin = Plugin.create({
                         ),
                     })),
                 })
-                const roles = arg.get('roles').ifArray()?.getElements() ?? []
-                if (!arg.get('condition').toString().getValue().trim() && roles.length === 0) {
-                    diagnostics.warn(
-                        arg.get('roles').ifDefined() ?? arg.get('condition').ifDefined() ?? arg,
-                        'UI Actions with an empty condition and no roles defined can be called by any logged-in users. Please restrict UI actions. The condition field should be specified to restrict execution of this UI Action to certain users. For example, current.canWrite() condition restricts the UI Action to the users who can modify the current record, gs.hasRole("admin") condition restricts the UI Action to the users with admin role.'
-                    )
-                }
 
                 if (arg.get('script').is(ModuleFunctionShape) && isClient.ifBoolean()?.getValue()) {
                     diagnostics.error(isClient, 'Module scripts (sys_module) cannot be used on client-side UI Actions')
@@ -307,7 +302,7 @@ export const UiActionPlugin = Plugin.create({
                         })
                     )
                 }
-
+                const roles = arg.get('roles').ifArray()?.getElements() ?? []
                 const roleRecords: Record[] = []
                 for (const role of roles) {
                     const roleReference = role.isString()