@servicenow/sdk-build-plugins 4.6.1 → 4.7.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 { createSdkDocEntry, generateDeprecatedDiagnostics, generateChoiceSetFile } from './utils'
+import { generateDeprecatedDiagnostics, generateChoiceSetFile } from './utils'
 import isEqual from 'lodash/isEqual'
 
 type GlobalRecord<T extends string | number | symbol, U> = globalThis.Record<T, U>
@@ -229,6 +229,8 @@ type TableDefinition = {
     actionsAccess: boolean | undefined
     readAccess: boolean | undefined
     isExtendable: boolean | undefined
+    createAccessControls: boolean | undefined
+    userRole: string | undefined
     scriptableTable: boolean | undefined
     attributes: string | undefined
     display: string | undefined
@@ -240,6 +242,8 @@ type SysDbObjectProperties = {
     label: string | undefined
     super_class: string | undefined
     is_extendable: boolean | undefined
+    create_access_controls: boolean | undefined
+    user_role: string | undefined
     scriptable_table: boolean | undefined
     client_scripts_access: boolean | undefined
     ws_access: boolean | undefined
@@ -396,7 +400,6 @@ const licensingAliases = {
 
 export const TablePlugin = Plugin.create({
     name: 'TablePlugin',
-    docs: [createSdkDocEntry('Table', ['sys_db_object'])],
     files: [
         {
             matcher: /\.xml$/,
@@ -505,7 +508,7 @@ export const TablePlugin = Plugin.create({
                     via: 'super_class',
                 },
             },
-            toShape(record, { descendants, config }) {
+            toShape(record, { descendants, config, compiler }) {
                 const schema: { [key: string]: CallExpressionShape } = {}
                 let displayColumn: string | undefined
                 const columns = descendants.query('sys_dictionary')
@@ -652,6 +655,7 @@ export const TablePlugin = Plugin.create({
                             })),
                         ],
                     })
+                    registerBootstrappedTable(augmentsExpression, schema, compiler)
                     return {
                         success: true,
                         value: writeAsCallExpression
@@ -758,18 +762,24 @@ export const TablePlugin = Plugin.create({
                                 ),
                                 callerAccess: $.from('caller_access')
                                     .map((callerAccess) => {
+                                        // An empty <caller_access/> element arrives as '', not 0 — guard before
+                                        // '' and 0 both mean "none" on the platform — omit from generated Fluent.
+                                        if (callerAccess.isString() && callerAccess.getValue() === '') {
+                                            return ''
+                                        }
                                         if (callerAccess.isNumber()) {
-                                            return callerAccessLevels[callerAccess.getValue()]
+                                            const value = callerAccess.getValue()
+                                            return value === 0 ? '' : callerAccessLevels[value]
                                         }
                                         if (callerAccess.isString()) {
-                                            const callerAccessString = callerAccess.getValue()
-                                            if (!isNaN(Number(callerAccessString))) {
-                                                return callerAccessLevels[Number(callerAccessString)]
+                                            const parsed = Number(callerAccess.getValue())
+                                            if (!isNaN(parsed)) {
+                                                return parsed === 0 ? '' : callerAccessLevels[parsed]
                                             }
                                         }
-                                        return 'none'
+                                        return ''
                                     })
-                                    .def('none'),
+                                    .def(''),
                                 display: displayColumn ? $.val(displayColumn) : undefined,
                                 extends: $.from('super_class').def(''),
                                 extensible: $.from('is_extendable').toBoolean().def(false),
@@ -847,12 +857,24 @@ export const TablePlugin = Plugin.create({
                                 name: $,
                                 readOnly: $.val(collectionRecord?.get('read_only')).toBoolean().def(false),
                                 schema: $.val(schema),
+                                // create_access_controls and user_role only ever arrive here from the
+                                // sys_db_object record. The platform's bootstrap XML pipeline does not
+                                // touch either field (no references in /glide/db/bootstrap/xml/ or
+                                // TableDescriptorProvider.createTableLevelMetaData), and the SDK's own
+                                // bootstrap output is always paired with sys_db_object_<id>.xml that
+                                // carries the record values. So the bootstrap-only string path through
+                                // tableDefToRecordProperties is unreachable for these two fields.
+                                createAccessControls: $.from('create_access_controls').toBoolean().def(false),
+                                userRole: $.from('user_role')
+                                    .map((v) => v.ifRecordId()?.getPrimaryKey())
+                                    .def(''),
                                 scriptableTable: $.from('scriptable_table').toBoolean().def(false),
                                 textIndex: $.val(collectionRecord?.get('text_index')).toBoolean().def(false),
                             }))
                             .withAliasedKeys(tableAliases),
                     ],
                 })
+                registerBootstrappedTable(callExpression, schema, compiler)
                 return {
                     success: true,
                     value: writeAsCallExpression
@@ -990,7 +1012,10 @@ export const TablePlugin = Plugin.create({
                         ['read_only_option', column.get('read_only_option').ifString()?.getValue()],
                         ['reference_cascade_rule', column.get('reference_cascade_rule').ifString()?.getValue()],
                         ['calculation', column.get('calculation').ifString()?.getValue()],
-                        ['choice', column.get('choice').ifNumber()?.getValue().toString()],
+                        // Bootstrap convention: emit `choice="0"` for the platform default ("none").
+                        // The component (install) path uses an empty `<choice/>` element instead, but
+                        // bootstrap files conventionally include the literal "0" attribute.
+                        ['choice', (column.get('choice').ifNumber()?.getValue() ?? 0).toString()],
                         ['choice_table', column.get('choice_table').ifString()?.getValue()],
                         ['choice_field', column.get('choice_field').ifString()?.getValue()],
                         ['display', displayValue?.toString()],
@@ -1106,7 +1131,9 @@ export const TablePlugin = Plugin.create({
                     ['audit', collectionRecord?.get('audit').ifBoolean()?.getValue().toString()],
                     ['display', displayColumn],
                     ['access', record.get('access').ifString()?.getValue()],
-                    ['caller_access', record.get('caller_access').ifNumber()?.getValue().toString()],
+                    // Bootstrap convention: emit `caller_access="0"` for the platform default ("none").
+                    // The component (install) path uses an empty `<caller_access/>` element instead.
+                    ['caller_access', (record.get('caller_access').ifNumber()?.getValue() ?? 0).toString()],
                     ['ws_access', record.get('ws_access').ifBoolean()?.getValue().toString()],
                     ['read_access', record.get('read_access').ifBoolean()?.getValue().toString()],
                     ['alter_access', record.get('alter_access').ifBoolean()?.getValue().toString()],
@@ -1115,6 +1142,8 @@ export const TablePlugin = Plugin.create({
                     ['delete_access', record.get('delete_access').ifBoolean()?.getValue().toString()],
                     ['actions_access', record.get('actions_access').ifBoolean()?.getValue().toString()],
                     ['client_scripts_access', record.get('client_scripts_access').ifBoolean()?.getValue().toString()],
+                    // create_access_controls and user_role are omitted: the platform's bootstrap
+                    // pipeline doesn't read them. They're carried by the paired sys_db_object_<id>.xml.
                     ['scriptable_table', record.get('scriptable_table').ifBoolean()?.getValue().toString()],
                     ['attributes', collectionRecord?.get('attributes').ifString()?.getValue()],
                 ]
@@ -1600,6 +1629,17 @@ export const TablePlugin = Plugin.create({
                       })
                     : ext.ifDefined()?.toRecordId()
 
+                const userRoleField = table.get('userRole')
+                const userRoleReference = userRoleField.isString()
+                    ? userRoleField.getValue() === ''
+                        ? undefined
+                        : await factory.createReference({
+                              source: userRoleField,
+                              table: 'sys_user_role',
+                              keys: { name: userRoleField },
+                          })
+                    : userRoleField.ifDefined()?.toRecordId()
+
                 // sys_db_object
                 const tableRecord = await factory.createRecord({
                     source: statement ?? callExpression,
@@ -1611,11 +1651,15 @@ export const TablePlugin = Plugin.create({
                         ws_access: $.from('allowWebServiceAccess').toBoolean().def(false),
                         number_ref: $.val(numberRef),
                         access: $.from('accessibleFrom').def('public'),
-                        caller_access: $.from('callerAccess').map((callerAccess) =>
-                            callerAccessLevels.indexOf(
-                                (callerAccess.ifString()?.getValue() ?? 'none') as 'none' | 'tracking' | 'restricted'
-                            )
-                        ),
+                        caller_access: $.from('callerAccess').map((callerAccess) => {
+                            const value = callerAccess.ifString()?.getValue()
+                            if (!value) {
+                                return undefined
+                            }
+                            const index = callerAccessLevels.indexOf(value as 'none' | 'tracking' | 'restricted')
+                            // index 0 ('none') is the platform default — emit empty <caller_access/>, matching stock.
+                            return index > 0 ? index : undefined
+                        }),
                         super_class: $.val(parentReference),
                         read_access: $.from('actions')
                             .map((actions) => hasAction('read', actions))
@@ -1635,6 +1679,8 @@ export const TablePlugin = Plugin.create({
                         name: $.from('name', 'augments').map(
                             (nameVal, augmentsVal) => augmentsVal.ifString() ?? nameVal
                         ),
+                        create_access_controls: $.from('createAccessControls').toBoolean().def(false),
+                        user_role: $.val(userRoleReference),
                         scriptable_table: $.from('scriptableTable').toBoolean().def(false),
                         // Controls toFile output, not written to record XML
                         augments: $.from('augments'),
@@ -1809,6 +1855,8 @@ function parseTableBootstrapXml(xml: unknown): TableDefinition | null {
         actionsAccess: table['@_actions_access'],
         readAccess: table['@_read_access'],
         isExtendable: table['@_is_extendable'],
+        createAccessControls: table['@_create_access_controls'],
+        userRole: table['@_user_role'],
         scriptableTable: table['@_scriptable_table'],
         attributes: table['@_attributes'],
     }
@@ -1830,6 +1878,8 @@ function tableDefToRecordProperties(
         label: tableDef.label,
         super_class: tableDef.extends,
         is_extendable: tableDef.isExtendable,
+        create_access_controls: tableDef.createAccessControls,
+        user_role: tableDef.userRole,
         scriptable_table: tableDef.scriptableTable,
         client_scripts_access: tableDef.clientScriptsAccess,
         ws_access: tableDef.wsAccess,
@@ -2085,6 +2135,58 @@ function addTableToGlobalGeneratedFile(tableArg: ObjectShape, sourceFilePath: st
     }
 }
 
+/**
+ * Records a bootstrap-derived Table() shape into $$GENERATED$$_bootstrapped_tables.ts so that other plugins (e.g. RecordPlugin)
+ * can resolve Data<T> column types via TypeScript during the same transform pass — no sys_dictionary query needed.
+ *
+ * The `declare global` augmentation lives inside the bootstrapped file (referencing its LOCAL `typeof tableName` export) rather
+ * than the common table file. That avoids the duplicate-import error when a pre-existing Fluent Table() of the same name was
+ * already wired into the common file, and TypeScript still merges the two TableSchemas interface declarations so both
+ * contribute their columns to the resolved Data<T>.
+ */
+function registerBootstrappedTable(
+    tableCall: CallExpressionShape,
+    schema: { [key: string]: CallExpressionShape },
+    compiler: Compiler
+): void {
+    const file = compiler.getGeneratedBootstrappedTablesFile()
+    if (!file || Object.keys(schema).length === 0) {
+        return
+    }
+
+    const tableArg = tableCall.getArgument(0).asObject()
+    const tableName = tableArg.get('augments').ifString()?.getValue() ?? tableArg.get('name').asString().getValue()
+
+    const tableSchemas = file.getModule('global')?.getModule('Now')?.getModule('Internal')?.getModule('TableSchemas')
+    const tables = file.getModule('global')?.getModule('Now')?.getModule('Internal')?.getInterface('Tables')
+    if (!tableSchemas || !tables) {
+        return
+    }
+
+    const coreImport = file.getImportDeclaration('@servicenow/sdk/core')
+    const existingImports = new Set(coreImport?.getNamedImports().map((n) => n.getName()))
+    for (const callee of new Set(Object.values(schema).map((s) => s.getCallee()))) {
+        if (!existingImports.has(callee)) {
+            coreImport?.addNamedImport(callee)
+        }
+    }
+
+    // Replace any existing export (re-transform of same XML), then write the shape's rendered code.
+    file.getVariableDeclaration(tableName)?.getVariableStatement()?.remove()
+    file.addVariableStatement({
+        isExported: true,
+        declarationKind: ts.VariableDeclarationKind.Const,
+        declarations: [{ name: tableName, initializer: tableCall.getCode() }],
+    })
+
+    if (!tableSchemas.getInterface(tableName)) {
+        tableSchemas.addInterface({ name: tableName, extends: [`Helper<typeof ${tableName}>`] })
+    }
+    if (!tables.getProperty(tableName)) {
+        tables.addProperty({ name: tableName, type: `Table<TableSchemas.${tableName}>` })
+    }
+}
+
 function filterUndefinedProperties<T extends object>(obj: T): T {
     return Object.fromEntries(Object.entries(obj).filter(([_, value]) => value !== undefined)) as T
 }

package/src/ui-action-plugin.ts

@@ -6,13 +6,12 @@ import {
     type Shape,
     type StringShape,
 } from '@servicenow/sdk-build-core'
+import type { UiAction } from '@servicenow/sdk-core/runtime/ui'
 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: {
@@ -161,7 +160,7 @@ export const UiActionPlugin = Plugin.create({
                                 order: $.map((o) => (o.ifString()?.getValue() === '' ? 100 : o))
                                     .toNumber()
                                     .def(100),
-                                overrides: $.def(''),
+                                overrides: $.from('sys_overrides').def(''),
                                 showQuery: $.from('show_query').toBoolean().def(false),
                                 showUpdate: $.from('show_update').toBoolean(),
                                 showInsert: $.from('show_insert').toBoolean(),
@@ -195,6 +194,18 @@ export const UiActionPlugin = Plugin.create({
                 const arg = callExpression.getArgument(0).asObject()
                 const isClient = arg.get(['client', 'isClient'])
 
+                const form = arg.get('form')?.getValue() as UiAction<string>['form']
+                const isFormAction = form?.showButton || form?.showLink || form?.showContextMenu
+
+                const list = arg.get('list').getValue() as UiAction<string>['list']
+                const isListAction =
+                    list?.showButton ||
+                    list?.showBannerButton ||
+                    list?.showContextMenu ||
+                    list?.showListChoice ||
+                    list?.showLink ||
+                    list?.showSaveWithFormButton
+
                 const uiAction = await factory.createRecord({
                     source: callExpression,
                     table: 'sys_ui_action',
@@ -212,8 +223,8 @@ export const UiActionPlugin = Plugin.create({
                                 ? arg.get('messages').asArray().getValue().join('\n')
                                 : arg.get('messages')
                         ).def([]),
-                        list_style: $.val(arg.get(['list', 'style'])),
-                        form_style: $.val(arg.get(['form', 'style'])),
+                        list_style: $.val(list?.style),
+                        form_style: $.val(form?.style),
                         condition: $.def(''),
                         script: $.map(
                             (v) => v.if(ModuleFunctionShape)?.toString((n) => `${n}({{PARAMS}})`, ['current']) ?? v
@@ -222,24 +233,26 @@ export const UiActionPlugin = Plugin.create({
                             .toCdata(),
                         hint: $.def(''),
                         order: $.toNumber().def(100),
-                        overrides: $.def(''),
-                        form_button: $.val(arg.get(['form', 'showButton'])).def(false),
-                        list_button: $.val(arg.get(['list', 'showButton'])).def(false),
-                        form_link: $.val(arg.get(['form', 'showLink'])).def(false),
-                        list_link: $.val(arg.get(['list', 'showLink'])).def(false),
-                        form_context_menu: $.val(arg.get(['form', 'showContextMenu'])).def(false),
-                        list_context_menu: $.val(arg.get(['list', 'showContextMenu'])).def(false),
+                        sys_overrides: $.from('overrides').def(''),
+                        form_action: $.val(isFormAction).def(false),
+                        list_action: $.val(isListAction).def(false),
+                        form_button: $.val(form?.showButton).def(false),
+                        list_button: $.val(list?.showButton).def(false),
+                        form_link: $.val(form?.showLink).def(false),
+                        list_link: $.val(list?.showLink).def(false),
+                        form_context_menu: $.val(form?.showContextMenu).def(false),
+                        list_context_menu: $.val(list?.showContextMenu).def(false),
                         show_query: $.from('showQuery').toBoolean().def(false),
                         show_insert: $.from('showInsert').toBoolean().def(false).def(true),
                         show_multiple_update: $.from('showMultipleUpdate').toBoolean().def(false),
                         show_update: $.from('showUpdate').toBoolean().def(true),
-                        list_choice: $.val(arg.get(['list', 'showListChoice'])).def(false),
-                        list_banner_button: $.val(arg.get(['list', 'showBannerButton'])).def(false),
-                        list_save_with_form_button: $.val(arg.get(['list', 'showSaveWithFormButton'])).def(false),
+                        list_choice: $.val(list?.showListChoice).def(false),
+                        list_banner_button: $.val(list?.showBannerButton).def(false),
+                        list_save_with_form_button: $.val(list?.showSaveWithFormButton).def(false),
                         isolate_script: $.from('isolateScript').toBoolean().def(false),
                         ui11_compatible: $.val(arg.get(['client', 'isUi11Compatible'])).def(false),
-                        ui16_compatible: $.val(arg.get(['client', 'isUi16Compatible'])),
-                        client_script_v2: $.val(arg.get(['workspace', 'clientScriptV2'])),
+                        ui16_compatible: $.val(arg.get(['client', 'isUi16Compatible'])).def(false),
+                        client_script_v2: $.val(arg.get(['workspace', 'clientScriptV2'])).toCdata(),
                         form_button_v2: $.val(arg.get(['workspace', 'showFormButtonV2'])).def(false),
                         form_menu_button_v2: $.val(arg.get(['workspace', 'showFormMenuButtonV2'])).def(false),
                         format_for_configurable_workspace: $.val(arg.get(['workspace', 'isConfigurableWorkspace'])).def(