@servicenow/sdk-build-plugins 4.0.1 → 4.1.0

package/src/static-content-plugin.ts

@@ -1,6 +1,6 @@
 import MD5 from 'md5.js'
 import * as mime from 'mime-types'
-import { Shape, Plugin, type Record, unloadBuilder, gzipSync } from '@servicenow/sdk-build-core'
+import { Shape, Plugin, type Record, unloadBuilder, gzipSync, type RecordContext } from '@servicenow/sdk-build-core'
 import { path as pathModule } from '@servicenow/sdk-build-core'
 import { INVALID_XML_CHARACTERS } from './utils'
 
@@ -8,15 +8,15 @@ import { INVALID_XML_CHARACTERS } from './utils'
 // https://code.devsnc.com/dev/sn-tectonic/blob/b3ab42ce742158cb5a0d00efd540b97eeafcbdd7/core/metadata-transform-san-diego/utils/index.js#L66
 const MAX_INLINE_CONTENT_SIZE = 4194304
 // https://code.devsnc.com/dev/sn-tectonic/blob/b3ab42ce742158cb5a0d00efd540b97eeafcbdd7/core/metadata-transform-san-diego/attachment/index.js#L7
-const CHUNK_SIZE = 933336
+export const CHUNK_SIZE = 933336
 
 const base64 = (data: Uint8Array | Buffer | string): string => Buffer.from(data).toString('base64')
 
-const chunkData = (data: string): string[] => {
+export const chunkData = (data: string): string[] => {
     const numChunks = Math.ceil(data.length / CHUNK_SIZE)
     const chunks: string[] = new Array(numChunks)
     for (let chunk = 0, offset = 0; chunk < numChunks; chunk += 1, offset += CHUNK_SIZE) {
-        chunks[chunk] = data.substring(offset, CHUNK_SIZE)
+        chunks[chunk] = data.substring(offset, offset + CHUNK_SIZE)
     }
 
     return chunks
@@ -36,10 +36,11 @@ function validateCdata(data: string): boolean {
     return true
 }
 
-const multipleRecordsToFile = (mainRecord, { config }) => {
+const multipleRecordsToFile = async (mainRecord: Record, { config, transform }: RecordContext) => {
     const recordBuilder = unloadBuilder(config)
     for (const record of mainRecord.flat()) {
-        const builder = recordBuilder.record(record)
+        const updateName = await transform.getUpdateName(record)
+        const builder = recordBuilder.record(record, updateName)
 
         record
             .entries()
@@ -49,6 +50,7 @@ const multipleRecordsToFile = (mainRecord, { config }) => {
     return {
         success: true,
         value: {
+            source: mainRecord,
             name: `${mainRecord.getTable()}_${mainRecord.getId().getValue()}.xml`,
             category: mainRecord.getInstallCategory(),
             content: recordBuilder.end(),
@@ -104,7 +106,7 @@ export const StaticContentPlugin = Plugin.create({
         {
             entryPoint: true,
             matcher: (path, { config, project }) => project.isInDir(config.staticContentDir, path),
-            toRecord(file, { project, config, factory, logger, fs }) {
+            async toRecord(file, { project, config, factory, logger, fs }) {
                 const { path } = file
                 const relativePath = pathModule.relative(project.resolvePath(config.staticContentDir), path)
                 const ext = pathModule.extname(relativePath)
@@ -187,7 +189,7 @@ export const StaticContentPlugin = Plugin.create({
                     logSkippedWithReason(`Unsupported content type ${mimeType}.`)
                 }
                 if (tableName && assetName) {
-                    const mainRecord = factory.createRecord({
+                    const mainRecord = await factory.createRecord({
                         source: file,
                         table: tableName,
                         explicitId: assetName,
@@ -199,7 +201,7 @@ export const StaticContentPlugin = Plugin.create({
                     if (useAttachment) {
                         const attachmentRecordId = generateId(mainRecordId, 'sys_attachment', assetName)
                         const zipEncodedContent = gzipSync(rawFileContent, { mtime: 0 })
-                        const attachmentRecord = factory.createRecord({
+                        const attachmentRecord = await factory.createRecord({
                             source: file,
                             table: 'sys_attachment',
                             properties: {
@@ -225,7 +227,7 @@ export const StaticContentPlugin = Plugin.create({
                         for (let i = 0; i < chunks.length; i++) {
                             const sysId = generateId(mainRecordId, 'sys_attachment_doc', assetName, i)
                             attachmentRecords.push(
-                                factory.createRecord({
+                                await factory.createRecord({
                                     source: file,
                                     table: 'sys_attachment_doc',
                                     properties: {

package/src/table-plugin.ts

@@ -12,6 +12,7 @@ import {
     VariableStatementShape,
     IdentifierShape,
     type ObjectShape,
+    type Transform,
 } from '@servicenow/sdk-build-core'
 import { XMLParser } from 'fast-xml-parser'
 import { z } from 'zod'
@@ -363,7 +364,7 @@ export const TablePlugin = Plugin.create({
     files: [
         {
             matcher: /\.xml$/,
-            toRecord(file, { factory }) {
+            async toRecord(file, { factory }) {
                 const xml = new XMLParser({
                     ignoreAttributes: false,
                     alwaysCreateTextNode: true,
@@ -380,24 +381,26 @@ export const TablePlugin = Plugin.create({
                 }
 
                 const recordDefs = tableDefToRecordProperties(tableDef)
-                const [sysDbRecord, ...relatedRecords] = (
-                    [
-                        ['sysDbObject', 'sys_db_object'],
-                        ['sysDictionary', 'sys_dictionary'],
-                        ['sysChoice', 'sys_choice'],
-                        ['sysIndex', 'sys_index'],
-                        ['sysDocumentation', 'sys_documentation'],
-                    ] as const
-                ).flatMap(([key, table]) => {
-                    return [recordDefs[key]].flat().map((rec) =>
-                        factory.createRecord({
-                            source: file,
-                            table,
-                            properties: filterUndefinedProperties(rec),
-                        })
-                    )
-                })
+                const records: Record[] = []
+                for (const [key, table] of [
+                    ['sysDbObject', 'sys_db_object'],
+                    ['sysDictionary', 'sys_dictionary'],
+                    ['sysChoice', 'sys_choice'],
+                    ['sysIndex', 'sys_index'],
+                    ['sysDocumentation', 'sys_documentation'],
+                ] as const) {
+                    for (const rec of [recordDefs[key]].flat()) {
+                        records.push(
+                            await factory.createRecord({
+                                source: file,
+                                table,
+                                properties: filterUndefinedProperties(rec),
+                            })
+                        )
+                    }
+                }
 
+                const [sysDbRecord, ...relatedRecords] = records
                 return {
                     success: true,
                     value: sysDbRecord!.with(...relatedRecords),
@@ -684,7 +687,7 @@ export const TablePlugin = Plugin.create({
                           }),
                 }
             },
-            toFile(record, { descendants, config }) {
+            async toFile(record, { descendants, config, transform }) {
                 if (config.tableOutputFormat !== 'bootstrap' || record.isDeleted()) {
                     // Defer to record plugin
                     return { success: false }
@@ -861,31 +864,27 @@ export const TablePlugin = Plugin.create({
                     ]
                 ).end({ prettyPrint: true })
 
-                const documentationFiles = generateRecordXml(
+                const documentationFiles = await generateRecordXml(
                     documentation.filter(
                         (doc) => !isDefaultDocumentation(doc.get('element')?.toString().getValue(), [doc])
                     ),
                     config,
-                    (doc) =>
-                        `sys_documentation_${tableName}${doc.get('element').isDefined() ? `_${doc.get('element').asString().getValue()}` : ''}_${doc.get('language').isDefined() ? doc.get('language').asString().getValue() : 'en'}.xml`
+                    transform
                 )
 
-                const licensingFiles = generateRecordXml(
+                const licensingFiles = await generateRecordXml(
                     licensing.filter((licensing) => !isDefaultLicenseConfig(tableName, licensing)),
                     config,
-                    (record) => `ua_table_licensing_config_${record.getId().getValue()}.xml`
+                    transform
                 )
 
-                const autoNumberFiles = generateRecordXml(
-                    autoNumber,
-                    config,
-                    (record) => `sys_number_${record.getId().getValue()}.xml`
-                )
+                const autoNumberFiles = await generateRecordXml(autoNumber, config, transform)
 
                 return {
                     success: true,
                     value: [
                         {
+                            source: record,
                             name: `${tableName}.xml`,
                             category: 'dictionary',
                             content: tableXml,
@@ -899,15 +898,24 @@ export const TablePlugin = Plugin.create({
         },
         sys_dictionary: {
             coalesce: ['name', 'element'],
+            getUpdateName: (record) => ({
+                success: true,
+                value: `sys_dictionary_${record.get('name').getValue()}_${record.get('element').getValue() || 'null'}`,
+            }),
         },
         sys_documentation: {
             coalesce: ['name', 'element', 'language'],
+            getUpdateName: (record) => ({
+                success: true,
+                value: `sys_documentation_${record.get('name').getValue()}_${record.get('element').ifDefined()?.getValue() || ''}_${record.get('language').ifDefined()?.getValue() || 'en'}`,
+            }),
         },
         ua_table_licensing_config: {
             coalesce: ['name'],
         },
         sys_index: {
             coalesce: ['logical_table_name', 'col_name_string'],
+            // TODO: Need to implement getUpdateName() but the platform logic is pretty wild. Will take some effort.
         },
         sys_number: {
             coalesce: ['category', 'prefix'],
@@ -1010,7 +1018,7 @@ export const TablePlugin = Plugin.create({
                             : (indexObject['element'] as string)
 
                         relatedRecords.push(
-                            factory.createRecord({
+                            await factory.createRecord({
                                 source: statement ?? callExpression,
                                 table: 'sys_index',
                                 properties: {
@@ -1028,7 +1036,7 @@ export const TablePlugin = Plugin.create({
                 if (table.get('licensingConfig').isObject()) {
                     const licenseObj = table.get('licensingConfig').asObject().withAliasedKeys(licensingAliases)
                     generateDeprecatedDiagnostics(licenseObj, diagnostics)
-                    const licenseRecord = factory.createRecord({
+                    const licenseRecord = await factory.createRecord({
                         source: statement ?? callExpression,
                         table: 'ua_table_licensing_config',
                         properties: licenseObj.transform(({ $ }) => ({
@@ -1056,7 +1064,7 @@ export const TablePlugin = Plugin.create({
                     relatedRecords.push(licenseRecord)
                 } else {
                     relatedRecords.push(
-                        factory.createRecord({
+                        await factory.createRecord({
                             source: statement ?? callExpression,
                             table: 'ua_table_licensing_config',
                             properties: {
@@ -1092,7 +1100,7 @@ export const TablePlugin = Plugin.create({
                             languages.add(language)
                         }
                         relatedRecords.push(
-                            factory.createRecord({
+                            await factory.createRecord({
                                 source: statement ?? callExpression,
                                 table: 'sys_documentation',
                                 properties: docObject.transform(({ $ }) => ({
@@ -1111,7 +1119,7 @@ export const TablePlugin = Plugin.create({
                     }
                 } else {
                     relatedRecords.push(
-                        factory.createRecord({
+                        await factory.createRecord({
                             source: statement ?? callExpression,
                             table: 'sys_documentation',
                             properties: {
@@ -1131,7 +1139,7 @@ export const TablePlugin = Plugin.create({
                 let numberRef: RecordId | undefined
                 if (table.get('autoNumber').isObject()) {
                     const autoNumber = table.get('autoNumber').asObject().withAliasedKeys(autoNumberAliases)
-                    const sysNumberRecord = factory.createRecord({
+                    const sysNumberRecord = await factory.createRecord({
                         source: statement ?? callExpression,
                         table: 'sys_number',
                         properties: autoNumber.transform(({ $ }) => ({
@@ -1147,7 +1155,7 @@ export const TablePlugin = Plugin.create({
 
                 // sys_dictionary (collection)
                 relatedRecords.push(
-                    factory.createRecord({
+                    await factory.createRecord({
                         source: statement ?? callExpression,
                         table: 'sys_dictionary',
                         properties: table.transform(({ $ }) => ({
@@ -1177,8 +1185,17 @@ export const TablePlugin = Plugin.create({
                         .some((action) => action.isString() && action.getValue() === actionName)
                 }
 
+                const ext = table.get('extends')
+                const parentReference = ext.isString()
+                    ? await factory.createReference({
+                          source: ext,
+                          table: 'sys_db_object',
+                          keys: { name: ext },
+                      })
+                    : ext.ifDefined()?.toRecordId()
+
                 // sys_db_object
-                const tableRecord = factory.createRecord({
+                const tableRecord = await factory.createRecord({
                     source: statement ?? callExpression,
                     table: 'sys_db_object',
                     properties: table.transform(({ $ }) => ({
@@ -1193,16 +1210,7 @@ export const TablePlugin = Plugin.create({
                                 (callerAccess.ifString()?.getValue() ?? 'none') as 'none' | 'tracking' | 'restricted'
                             )
                         ),
-                        super_class: $.from('extends').map(
-                            (v) =>
-                                v.ifString()?.pipe((parent) =>
-                                    factory.createReference({
-                                        source: parent,
-                                        table: 'sys_db_object',
-                                        keys: { name: parent.getValue() },
-                                    })
-                                ) ?? v.ifDefined()?.toRecordId()
-                        ),
+                        super_class: $.val(parentReference),
                         read_access: $.from('actions')
                             .map((actions) => hasAction('read', actions))
                             .def(true),
@@ -1658,24 +1666,31 @@ function createElement(name: string, attributes: [string, string][] = [], childr
     return element
 }
 
-function generateRecordXml(
+async function generateRecordXml(
     records: Record[],
     config: { scope: string; scopeId: string },
-    getFileName: (record: Record) => string
-): OutputFile[] {
-    return records.map((record) => {
+    transform: Transform
+): Promise<OutputFile[]> {
+    const files: OutputFile[] = []
+    for (const record of records) {
         const recordBuilder = unloadBuilder({ scope: config.scope, scopeId: config.scopeId })
-        const builder = recordBuilder.record(record)
+        const updateName = await transform.getUpdateName(record)
+        const builder = recordBuilder.record(record, updateName)
+
         record
             .entries()
             .sort(([a], [b]) => a.localeCompare(b))
             .forEach(([prop, shape]) => builder.field(prop, shape))
-        return {
-            name: getFileName(record),
+
+        files.push({
+            source: record,
+            name: `${updateName}.xml`,
             category: record.getInstallCategory(),
             content: recordBuilder.end(),
-        }
-    })
+        })
+    }
+
+    return files
 }
 
 export function isDefaultLicenseConfig(tableName: string, licenseRecord: Record): boolean {

package/src/ui-action-plugin.ts

@@ -1,4 +1,11 @@
-import { CallExpressionShape, Plugin, type RecordId, type Shape, type StringShape } from '@servicenow/sdk-build-core'
+import {
+    CallExpressionShape,
+    Plugin,
+    type Record,
+    type RecordId,
+    type Shape,
+    type StringShape,
+} from '@servicenow/sdk-build-core'
 import { NowIdShape } from './now-id-plugin'
 import { ModuleFunctionShape } from './server-module-plugin'
 
@@ -186,7 +193,7 @@ export const UiActionPlugin = Plugin.create({
                 const arg = callExpression.getArgument(0).asObject()
                 const isClient = arg.get(['client', 'isClient'])
 
-                const uiAction = factory.createRecord({
+                const uiAction = await factory.createRecord({
                     source: callExpression,
                     table: 'sys_ui_action',
                     explicitId: arg.get('$id'),
@@ -197,7 +204,7 @@ export const UiActionPlugin = Plugin.create({
                         comments: $.def(''),
                         active: $.def(true),
                         client: $.val(isClient),
-                        onClick: $.val(arg.get(['client', 'onClick'])),
+                        onclick: $.val(arg.get(['client', 'onClick'])),
                         messages: $.val(
                             arg.get('messages')?.isArray()
                                 ? arg.get('messages').asArray().getValue().join('\n')
@@ -263,60 +270,69 @@ export const UiActionPlugin = Plugin.create({
                         )
                     }
                 })
-                const uiActioneViews = [
-                    ...includeInViews.map((view) =>
-                        factory.createRecord({
+
+                const uiActionViews: Record[] = []
+                for (const view of includeInViews) {
+                    uiActionViews.push(
+                        await factory.createRecord({
                             source: callExpression,
                             table: 'sys_ui_action_view',
                             properties: {
                                 sys_ui_action: uiAction.getId(),
                                 visibility: 'include',
-                                sys_ui_view: factory.createReference({
+                                sys_ui_view: await factory.createReference({
                                     source: view,
                                     table: 'sys_ui_view',
                                     keys: { name: view },
                                 }),
                             },
                         })
-                    ),
-                    ...excludeFromViews.map((view) =>
-                        factory.createRecord({
+                    )
+                }
+
+                for (const view of excludeFromViews) {
+                    uiActionViews.push(
+                        await factory.createRecord({
                             source: callExpression,
                             table: 'sys_ui_action_view',
                             properties: {
                                 sys_ui_action: uiAction.getId(),
                                 visibility: 'exclude',
-                                sys_ui_view: factory.createReference({
+                                sys_ui_view: await factory.createReference({
                                     source: view,
                                     table: 'sys_ui_view',
                                     keys: { name: view },
                                 }),
                             },
                         })
-                    ),
-                ]
+                    )
+                }
+
+                const roleRecords: Record[] = []
+                for (const role of roles) {
+                    const roleReference = role.isString()
+                        ? await factory.createReference({
+                              source: role,
+                              table: 'sys_user_role',
+                              keys: { name: role },
+                          })
+                        : role
+
+                    roleRecords.push(
+                        await factory.createRecord({
+                            source: callExpression,
+                            table: 'sys_ui_action_role',
+                            properties: {
+                                sys_ui_action: uiAction.getId(),
+                                sys_user_role: roleReference,
+                            },
+                        })
+                    )
+                }
+
                 return {
                     success: true,
-                    value: uiAction.with(
-                        ...roles.map((role) =>
-                            factory.createRecord({
-                                source: callExpression,
-                                table: 'sys_ui_action_role',
-                                properties: {
-                                    sys_ui_action: uiAction.getId(),
-                                    sys_user_role:
-                                        role.ifString()?.pipe((roleName) =>
-                                            factory.createReference({
-                                                source: roleName,
-                                                table: 'sys_user_role',
-                                                keys: { name: roleName },
-                                            })
-                                        ) ?? role,
-                                },
-                            })
-                        ),
-                        ...uiActioneViews
-                    ),
+                    value: uiAction.with(...roleRecords, ...uiActionViews),
                 }
             },
         },

package/src/ui-page-plugin.ts

@@ -42,7 +42,9 @@ const nowUxGlobals = (themeId: string = POLARIS_APPSHELL_THEME_ID) => {
 window.NOW = {};
 window.NOW.user = {};
 window.NOW.batch_glide_ajax_requests = false;
-window.g_ck = "$[gs.getSession().getSessionToken()]";
+window.NOW.isUsingPolaris = true;
+window.NOW.exclude_dark_theme = "false";
+window.g_ck = "$[gs.getSession().getSessionToken() || gs.getSessionToken()]";
 </script>
 <!-- Include ServiceNow's required scripts -->
 <g:requires name="scripts/doctype/functions_bootstrap14.js" />
@@ -53,7 +55,8 @@ window.g_ck = "$[gs.getSession().getSessionToken()]";
 <g:requires name="scripts/classes/GlideUser.js" />
 <g2:client_script type="user" />
 <link rel="preload" href="/uxasset/set-cache-buster/$[UxFrameworkScriptables.getFlushTimestamp()].js" as="script"></link>
-<link data-source-id="glide-theme" rel="stylesheet" href="/$uxappimmutables.do?sysparm_request_type=ux_theme$[AMP]sysparm_app_sys_id=${themeId}$[AMP]uxpcb=$[UxFrameworkScriptables.getFlushTimestamp()]"></link>
+<g:requires name="scripts/polaris_theme_refresh_observer.js" />
+<link data-source-id="glide-theme" id="polarisberg_theme_variables" rel="stylesheet" href="/$uxappimmutables.do?sysparm_request_type=ux_theme$[AMP]sysparm_app_sys_id=${themeId}$[AMP]uxpcb=$[sn_ui.PolarisUI.getThemeVariableCssCacheKey()]"></link>
 <script type="module" src="/uxasset/externals/@devsnc/library-uxf/index.jsdbx"></script>
 <!-- @sdk:now-ux-globals -->
 `)
@@ -146,7 +149,7 @@ export const UiPagePlugin = Plugin.create({
 
                 return {
                     success: true,
-                    value: factory.createRecord({
+                    value: await factory.createRecord({
                         source: callExpression,
                         table: 'sys_ui_page',
                         explicitId: arg.get('$id'),

package/src/user-preference-plugin.ts

@@ -40,7 +40,7 @@ export const UserPreferencePlugin = Plugin.create({
         {
             shape: CallExpressionShape,
             fileTypes: ['fluent'],
-            toRecord(callExpression, { factory }) {
+            async toRecord(callExpression, { factory }) {
                 if (callExpression.getCallee() !== 'UserPreference') {
                     return { success: false }
                 }
@@ -49,7 +49,7 @@ export const UserPreferencePlugin = Plugin.create({
 
                 return {
                     success: true,
-                    value: factory.createRecord({
+                    value: await factory.createRecord({
                         source: callExpression,
                         table: 'sys_user_preference',
                         explicitId: pref.get('$id'),