@servicenow/sdk-build-plugins 4.7.2 → 4.8.1

package/src/form-plugin.ts

@@ -268,50 +268,51 @@ function getOptionalString(record: Record, field: string, defaultValue = ''): st
  * The name is needed as an attribute on the <view> XML element so the parser
  * can create a RecordId with proper coalesce keys when re-reading the XML.
  */
-function resolveView(view: ReturnType<Record['get']>, database: Database): { sysId: string; name: string } {
+function resolveView(
+    view: ReturnType<Record['get']>,
+    database: Database
+): { sysId: string; name: string; displayValue: string } {
     if (view.isRecordId() || view.isRecord()) {
         const viewId = view.isRecordId() ? view : view.getId()
         const sysId = viewId.getValue()
-        // Try to resolve the view record to get its name
+        // Try to resolve the view record to get its name and title
         const viewRecord = database.resolve(viewId)
         if (viewRecord) {
             const name = viewRecord.get('name').ifString()?.getValue() ?? ''
-            return { sysId, name }
+            const displayValue = viewRecord.get('title').ifString()?.getValue() ?? name
+            return { sysId, name, displayValue }
         }
         // Fall back to primary key (view name) if available
         if (view.isRecordId() && view.asRecordId().hasPrimaryKey()) {
             const pk = view.asRecordId().getPrimaryKey()
             if (pk && !isGUID(pk)) {
-                return { sysId, name: pk }
+                return { sysId, name: pk, displayValue: pk }
             }
         }
-        return { sysId, name: '' }
+        return { sysId, name: '', displayValue: '' }
     }
 
     const viewValue = view.getValue()
     if (viewValue === 'NULL' || viewValue === DEFAULT_VIEW) {
-        return { sysId: DEFAULT_VIEW, name: DEFAULT_VIEW }
+        return { sysId: DEFAULT_VIEW, name: DEFAULT_VIEW, displayValue: DEFAULT_VIEW }
     }
 
     // View is a string - try to resolve to record ID if it exists in database
     const viewNameStr = view.ifString()?.getValue() ?? ''
     if (!viewNameStr) {
-        return { sysId: '', name: '' }
+        return { sysId: '', name: '', displayValue: '' }
     }
 
     const viewRecord = database.query('sys_ui_view').find((v) => v.get('name').ifString()?.getValue() === viewNameStr)
     if (viewRecord) {
-        return { sysId: viewRecord.getId().getValue(), name: viewNameStr }
+        const displayValue = viewRecord.get('title').ifString()?.getValue() ?? viewNameStr
+        return { sysId: viewRecord.getId().getValue(), name: viewNameStr, displayValue }
+    }
+    return {
+        sysId: viewNameStr,
+        name: isGUID(viewNameStr) ? '' : viewNameStr,
+        displayValue: isGUID(viewNameStr) ? '' : viewNameStr,
     }
-    return { sysId: viewNameStr, name: isGUID(viewNameStr) ? '' : viewNameStr }
-}
-
-/**
- * Resolves a view value to its string representation (sys_id or name)
- * Handles RecordId, Record, string values, and database lookups
- */
-function resolveViewName(view: ReturnType<Record['get']>, database: Database): string {
-    return resolveView(view, database).sysId
 }
 
 type FormElement =
@@ -377,7 +378,11 @@ export const FormPlugin = Plugin.create({
                 const sectionName = section.get('name').asString().getValue()
                 const caption = getOptionalString(section, 'caption')
                 const sysDomain = getOptionalString(section, 'sys_domain', 'global')
-                const { sysId: viewName, name: viewDisplayName } = resolveView(section.get('view'), database)
+                const {
+                    sysId: viewSysId,
+                    name: viewName,
+                    displayValue: viewDisplayValue,
+                } = resolveView(section.get('view'), database)
 
                 const xml = create().ele('record_update')
                 const root = xml.ele('sys_ui_section', {
@@ -385,7 +390,7 @@ export const FormPlugin = Plugin.create({
                     section_id: section.getId().getValue(),
                     sys_domain: sysDomain,
                     table: sectionName,
-                    view: viewName,
+                    view: viewSysId === DEFAULT_VIEW ? '' : viewName,
                 })
 
                 // Add all sys_ui_annotation records for this section (excluding deleted ones)
@@ -427,7 +432,7 @@ export const FormPlugin = Plugin.create({
                             display_value: caption,
                             name: sectionName,
                             sys_domain: sysDomain,
-                            view: viewName,
+                            view: viewSysId,
                         })
                         .txt(section.getId().getValue())
                     child.ele('sys_user')
@@ -446,7 +451,13 @@ export const FormPlugin = Plugin.create({
                 sectionChild.ele('sys_user')
                 sectionChild.ele('title').txt(String(section.get('title').ifBoolean()?.getValue() ?? false))
                 sectionChild.ele('view_name')
-                sectionChild.ele('view', viewDisplayName ? { name: viewDisplayName } : {}).txt(viewName)
+                const isDefaultView = viewSysId === DEFAULT_VIEW
+                const sectionViewAttrs = isDefaultView
+                    ? { name: 'NULL', display_value: DEFAULT_VIEW }
+                    : viewName
+                      ? { name: viewName, display_value: viewDisplayValue || viewName }
+                      : {}
+                sectionChild.ele('view', sectionViewAttrs).txt(viewSysId)
 
                 return {
                     success: true,
@@ -702,7 +713,11 @@ export const FormPlugin = Plugin.create({
 
                 const formName = form.get('name').asString().getValue()
                 const formSysDomain = getOptionalString(form, 'sys_domain', 'global')
-                const { sysId: formViewName, name: formViewDisplayName } = resolveView(form.get('view'), database)
+                const {
+                    sysId: formViewSysId,
+                    name: formViewName,
+                    displayValue: formViewDisplayValue,
+                } = resolveView(form.get('view'), database)
 
                 const xml = create().ele('record_update')
                 const root = xml.ele('sys_ui_form_sections', {
@@ -727,7 +742,7 @@ export const FormPlugin = Plugin.create({
                             display_value: formName,
                             name: formName,
                             sys_domain: formSysDomain,
-                            view: formViewName,
+                            view: formViewSysId,
                         })
                         .txt(form.getId().getValue())
 
@@ -737,14 +752,14 @@ export const FormPlugin = Plugin.create({
 
                     if (section) {
                         const sectionCaption = getOptionalString(section, 'caption')
-                        const sectionViewName = resolveViewName(section.get('view'), database)
+                        const { sysId: sectionViewSysId } = resolveView(section.get('view'), database)
                         child
                             .ele('sys_ui_section', {
                                 caption: sectionCaption,
                                 display_value: sectionCaption,
                                 name: formName,
                                 sys_domain: getOptionalString(section, 'sys_domain', 'global'),
-                                view: sectionViewName,
+                                view: sectionViewSysId,
                             })
                             .txt(section.getId().getValue())
                     }
@@ -757,7 +772,13 @@ export const FormPlugin = Plugin.create({
                 formChild.ele('sys_id').txt(form.getId().getValue())
                 formChild.ele('sys_scope', { display_value: config.scope }).txt(config.scopeId)
                 formChild.ele('sys_user').txt(getOptionalString(form, 'sys_user'))
-                formChild.ele('view', formViewDisplayName ? { name: formViewDisplayName } : {}).txt(formViewName)
+                const isDefaultFormView = formViewSysId === DEFAULT_VIEW
+                const formViewAttrs = isDefaultFormView
+                    ? { name: 'NULL', display_value: DEFAULT_VIEW }
+                    : formViewName
+                      ? { name: formViewName, display_value: formViewDisplayValue || formViewName }
+                      : {}
+                formChild.ele('view', formViewAttrs).txt(formViewSysId)
                 formChild.ele('view_name')
 
                 return {

package/src/index.ts

@@ -6,6 +6,7 @@ export * from './cross-scope-privilege-plugin'
 export * from './record-plugin'
 export * from './now-id-plugin'
 export * from './now-ref-plugin'
+export * from './now-delete-plugin'
 export * from './now-unresolved-plugin'
 export * from './property-plugin'
 export * from './role-plugin'
@@ -21,6 +22,7 @@ export * from './now-include-plugin'
 export * from './table-plugin'
 export * from './column-plugin'
 export * from './data-plugin'
+export * from './data-lookup-plugin'
 export * from './ui-page-plugin'
 export * from './list-plugin'
 export * from './ui-action-plugin'
@@ -62,6 +64,7 @@ export * from './now-attach-plugin'
 export * from './sla-plugin'
 export * from './email-notification-plugin'
 export * from './inbound-email-action-plugin'
+export * from './rest-message-plugin'
 
 export * from './service-catalog'
 export * from './ux-list-menu-config-plugin'
@@ -69,6 +72,7 @@ export * from './workspace-plugin'
 export * from './dashboard/dashboard-plugin'
 export * from './applicability-plugin'
 export * from './instance-scan-plugin'
+export * from './alias'
 // non-plugins
 export * from './atf/step-configs'
 export { REPACK_OUTPUT_DIR, checkModuleExists, resolveModule } from './repack'
@@ -79,4 +83,4 @@ export {
     DO_IN_PARALLEL_BLOCK_SYS_ID,
     TRY_CATCH_CATCH_SYS_ID,
 } from './flow/flow-logic/flow-logic-constants'
-export { FlowActivationTask } from './flow/post-install'
+export { FlowActivationTask, getRecordIdsByTable } from './flow/post-install'

package/src/now-config-plugin.ts

@@ -787,6 +787,7 @@ export const NowConfigPlugin = Plugin.create({
                             packageResolverVersion: $.from('package_resolver_version').def(
                                 config.scope === 'global' ? MODULE_RESOLUTION.V2 : MODULE_RESOLUTION.V1
                             ),
+                            sysCode: $.from('sys_code').def(''),
                         })),
                     }),
                 }
@@ -936,7 +937,7 @@ export const NowConfigPlugin = Plugin.create({
                         package_resolver_version: $.from('packageResolverVersion').def(
                             scope === 'global' ? MODULE_RESOLUTION.V2 : MODULE_RESOLUTION.V1
                         ),
-                        sys_code: $.from('scope'),
+                        sys_code: $.from('sysCode'),
                     })),
                 })
 

package/src/now-delete-plugin.ts

@@ -0,0 +1,82 @@
+import {
+    Plugin,
+    CallExpressionShape,
+    StringShape,
+    ObjectShape,
+    Record,
+    RecordId,
+    GUID,
+} from '@servicenow/sdk-build-core'
+import { CallExpressionPlugin } from './call-expression-plugin'
+
+export const NowDeletePlugin = Plugin.create({
+    name: 'NowDeletePlugin',
+    nodes: [
+        {
+            node: 'CallExpression',
+            async toShape(node, { transform }) {
+                const result = await transform.toShape(node, CallExpressionPlugin)
+                if (
+                    !result.success ||
+                    !result.value.is(CallExpressionShape) ||
+                    result.value.getCallee() !== 'Now.del'
+                ) {
+                    return { success: false }
+                }
+
+                const callExpression = result.value
+                const table = callExpression
+                    .getArgument(0)
+                    .asString('The first argument to Now.del() must be a table name')
+                    .getValue()
+
+                const guidOrKeys = callExpression
+                    .getArgument(1)
+                    .as(
+                        [StringShape, ObjectShape],
+                        'The second argument to Now.del() must be a sys_id GUID or a coalesce keys object'
+                    )
+
+                const [guid, keysShape] = guidOrKeys.isString()
+                    ? [guidOrKeys.asString().getValue(), undefined] // Now.del(table, guid)
+                    : [undefined, guidOrKeys.asObject()] // Now.del(table, keys)
+
+                // Convert keysShape to plain object
+                const keys = keysShape
+                    ? Object.fromEntries(
+                          keysShape
+                              .entries()
+                              .map(([k, v]) => [
+                                  k,
+                                  typeof v === 'string'
+                                      ? v
+                                      : (v.ifRecord()?.getId() ??
+                                            v.ifRecordId() ??
+                                            v.ifDefined()?.toString().getValue()) ||
+                                        'NULL',
+                              ])
+                      )
+                    : undefined
+
+                // Create DELETE record directly (no factory needed)
+                const record = new Record({
+                    source: node,
+                    action: 'DELETE',
+                    installCategory: 'author_elective_update',
+                    properties: keys ?? {},
+                    id: new RecordId({
+                        source: node,
+                        table,
+                        guid: guid ?? GUID(),
+                        keys,
+                    }),
+                })
+
+                return {
+                    success: true,
+                    value: record,
+                }
+            },
+        },
+    ],
+})

package/src/record-plugin.ts

@@ -12,6 +12,7 @@ import {
     ApplicationMenu,
     BusinessRule,
     CrossScopePrivilege,
+    DataLookup,
     Property,
     Role,
     Test,
@@ -19,6 +20,7 @@ import {
     ImportSet,
     Sla,
 } from '@servicenow/sdk-core/runtime/app'
+import { RetryPolicy, AliasTemplate, Alias } from '@servicenow/sdk-core/runtime/alias'
 import {
     ServicePortal,
     SPWidget,
@@ -43,7 +45,7 @@ import { ClientScript } from '@servicenow/sdk-core/runtime/clientscript'
 import { ScriptAction, ScriptInclude, ScheduledScript } from '@servicenow/sdk-core/runtime/sys'
 import { List, Form } from '@servicenow/sdk-core/runtime/ui'
 import { Table } from '@servicenow/sdk-core/runtime/db'
-import { RestApi } from '@servicenow/sdk-core/runtime/rest'
+import { RestApi, RestMessage } from '@servicenow/sdk-core/runtime/rest'
 import { EmailNotification, InboundEmailAction } from '@servicenow/sdk-core/runtime/notification'
 import { UiAction, UiPage, UiPolicy, DataPolicy } from '@servicenow/sdk-core/runtime/ui'
 import { ActionStepDefinition } from '@servicenow/sdk-core/runtime/flow'
@@ -71,6 +73,7 @@ export const RecordPlugin = Plugin.create({
             async toShape(record, { compiler }) {
                 const tableName = record.getTable()
                 const columnTypes = compiler.getTableColumnTypes(tableName)
+                const mandatoryColumns = compiler.getMandatoryColumns(tableName)
 
                 const dataProperties = record.transform(({ $ }) =>
                     Object.fromEntries(
@@ -97,7 +100,9 @@ export const RecordPlugin = Plugin.create({
                                     }
                                 }
 
-                                return [key, shape?.isString() ? $.def('') : $] //to avoid writing empty string values to the code
+                                // Mandatory string fields must always be written to avoid build errors
+                                // from missing required properties in Data<T>.
+                                return [key, shape?.isString() ? (mandatoryColumns?.has(key) ? $ : $.def('')) : $]
                             })
                     )
                 )
@@ -225,7 +230,10 @@ export const RecordPlugin = Plugin.create({
 })
 
 export const TableOwnership = {
+    sys_alias: Alias.name,
+    sys_alias_templates: AliasTemplate.name,
     contract_sla: Sla.name,
+    sys_retry_policy: RetryPolicy.name,
     sys_security_acl: Acl.name,
     sys_security_acl_role: Acl.name,
     sys_app_application: ApplicationMenu.name,
@@ -271,6 +279,12 @@ export const TableOwnership = {
     sys_ws_version: RestApi.name,
     sys_ws_header: RestApi.name,
     sys_ws_query_parameter: RestApi.name,
+    sys_rest_message: RestMessage.name,
+    sys_rest_message_headers: RestMessage.name,
+    sys_rest_message_fn: RestMessage.name,
+    sys_rest_message_fn_headers: RestMessage.name,
+    sys_rest_message_fn_parameters: RestMessage.name,
+    sys_rest_message_fn_param_defs: RestMessage.name,
     sys_user_preference: UserPreference.name,
     sys_ui_page: UiPage.name,
     sys_ui_action: UiAction.name,
@@ -338,4 +352,5 @@ export const TableOwnership = {
     sn_aia_team_member: 'AiAgenticWorkflowPlugin',
     sn_nowassist_skill_config: 'NowAssistSkillPlugin',
     sys_one_extend_capability: 'NowAssistSkillPlugin',
+    dl_definition: DataLookup.name,
 }