@servicenow/sdk-build-plugins 4.1.1 → 4.3.0

package/src/static-content-plugin.ts

@@ -22,7 +22,7 @@ export const chunkData = (data: string): string[] => {
     return chunks
 }
 
-const generateId = (...parts: Array<string | number>): string => new MD5().update(parts.join(':')).digest('hex')
+export const generateId = (...parts: Array<string | number>): string => new MD5().update(parts.join(':')).digest('hex')
 
 // based on tectonic code for validating XML content
 // https://code.devsnc.com/dev/sn-tectonic/blob/b3ab42ce742158cb5a0d00efd540b97eeafcbdd7/core/metadata-transform-san-diego/utils/index.js#L51-L63
@@ -71,7 +71,7 @@ const attachmentRelationships = {
     },
 }
 
-const toNoOpShape = (record) => {
+const toNoOpShape = (record: Record) => {
     return { success: true, value: Shape.noOp(record) }
 }
 

package/src/table-plugin.ts

@@ -63,6 +63,7 @@ const ColumnSchema = z
         '@_max_length': z.coerce.number().or(z.string()).optional(),
         '@_mandatory': BooleanFromString.optional(),
         '@_read_only': BooleanFromString.optional(),
+        '@_read_only_option': z.string().optional(),
         '@_reference_table': z.string().optional(),
         '@_reference_qual': z.string().optional(),
         '@_label': z.string().optional(),
@@ -150,6 +151,7 @@ type ColumnDefinition = {
     maxLength: number | string | undefined
     isMandatory: boolean | undefined
     isReadOnly: boolean | undefined
+    readOnlyOption: string | undefined
     referenceTable: string | undefined
     referenceQual: string | undefined
     columnLabel: string | undefined
@@ -245,6 +247,7 @@ type SysDictionaryProperties = {
     max_length: number | string | undefined
     mandatory: boolean | undefined
     read_only: boolean | undefined
+    read_only_option: string | undefined
     reference_table: string | undefined
     reference_qual: string | undefined
     column_label: string | undefined
@@ -461,7 +464,7 @@ export const TablePlugin = Plugin.create({
                 },
             },
             toShape(record, { descendants }) {
-                const schema = {}
+                const schema: { [key: string]: CallExpressionShape } = {}
                 let displayColumn: string | undefined
                 const columns = descendants.query('sys_dictionary')
                 let collectionRecord: Record
@@ -497,6 +500,7 @@ export const TablePlugin = Plugin.create({
                 const callExpression = new CallExpressionShape({
                     source: record,
                     callee: 'Table',
+                    exportName: record.get('name').ifString()?.getValue(),
                     args: [
                         record
                             .transform(({ $ }) => ({
@@ -545,7 +549,7 @@ export const TablePlugin = Plugin.create({
                                         if (!attributes?.isString()) {
                                             return undefined
                                         }
-                                        const result = {}
+                                        const result: { [key: string]: string | boolean } = {}
                                         attributes
                                             .toString()
                                             .getValue()
@@ -555,12 +559,15 @@ export const TablePlugin = Plugin.create({
                                                     return
                                                 }
                                                 const [key, value] = attr.split('=').map((s) => s.trim())
+                                                if (!key || value === undefined) {
+                                                    return
+                                                }
                                                 if (value === 'true') {
-                                                    result[key!] = true
+                                                    result[key] = true
                                                 } else if (value === 'false') {
-                                                    result[key!] = false
+                                                    result[key] = false
                                                 } else {
-                                                    result[key!] = value
+                                                    result[key] = value
                                                 }
                                             })
                                         return result
@@ -571,7 +578,9 @@ export const TablePlugin = Plugin.create({
                                     autoNumber[0]
                                         ?.transform(({ $ }) => ({
                                             number: $.toNumber().def(1000),
-                                            numberOfDigits: $.from('maximum_digits').toNumber().def(7),
+                                            numberOfDigits: $.from('maximum_digits')
+                                                .map((v) => v.ifString()?.ifNotEmpty()?.toNumber())
+                                                .def(7),
                                             prefix: $.def('PRE'),
                                         }))
                                         .withAliasedKeys(autoNumberAliases)
@@ -688,7 +697,7 @@ export const TablePlugin = Plugin.create({
                 }
             },
             async toFile(record, { descendants, config, transform }) {
-                if (config.tableOutputFormat !== 'bootstrap' || record.isDeleted()) {
+                if (config.tableOutputFormat !== 'bootstrap' || config.type === 'configuration' || record.isDeleted()) {
                     // Defer to record plugin
                     return { success: false }
                 }
@@ -739,6 +748,7 @@ export const TablePlugin = Plugin.create({
                         ['max_length', maxLength.ifNumber()?.getValue().toString() ?? maxLength.ifString()?.getValue()],
                         ['mandatory', column.get('mandatory').ifBoolean()?.getValue().toString()],
                         ['read_only', column.get('read_only').ifBoolean()?.getValue().toString()],
+                        ['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()],
@@ -947,6 +957,7 @@ export const TablePlugin = Plugin.create({
                 let ignoreColumnNameCheck = false
                 const scopeName = config.scope
                 const scopeRegex = new RegExp(`^${scopeName}_`)
+                const globalRegex = /^u_/
                 const tableNameMatch = tableName.getValue().match(scopeRegex)
                 if (!tableNameMatch && !isSNScope(scopeName) && scopeName !== 'global') {
                     const nameNode = tableName.getOriginalNode()
@@ -973,8 +984,32 @@ export const TablePlugin = Plugin.create({
                     )
                 }
 
+                const globalTableNameMatch = tableName.getValue().match(globalRegex)
+                let anyNonPrefixedGlobalColumn = false
+
+                if (scopeName === 'global' && !globalTableNameMatch) {
+                    const schema = table.get('schema').asObject()
+                    for (const [name, _] of schema.entries()) {
+                        if (!name.match(globalRegex)) {
+                            anyNonPrefixedGlobalColumn = true
+                            break
+                        }
+                    }
+
+                    if (anyNonPrefixedGlobalColumn) {
+                        diagnostics.error(
+                            table.get('name'),
+                            `Global table 'name' property should start with custom prefix 'u_'`
+                        )
+                    }
+                } else if (scopeName === 'global') {
+                    // Global table starts with custom prefix `u_`, allow any column name prefix
+                    ignoreColumnNameCheck = true
+                }
+
                 // sys_dictionary
                 const schema = table.get('schema').asObject()
+                const columnIdsMap = new Map<string, string>()
                 for (const [name, column] of schema.entries()) {
                     if (!name.match(columnNameRegex)) {
                         diagnostics.error(
@@ -994,6 +1029,11 @@ export const TablePlugin = Plugin.create({
                             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(
@@ -1007,6 +1047,7 @@ export const TablePlugin = Plugin.create({
                         return { success: false }
                     }
                     relatedRecords.push(result.value)
+                    columnIdsMap.set(name, result.value.getId().getValue())
                 }
 
                 // sys_index
@@ -1025,7 +1066,20 @@ export const TablePlugin = Plugin.create({
                                     index_name: indexObject['name'],
                                     col_name_string: colNames,
                                     unique_index: indexObject['unique'] === true,
-                                    logical_table_name: table.get('name').asString().getValue(),
+                                    logical_table_name: tableName.getValue(),
+                                    index_col_name: colNames
+                                        .split(',')
+                                        .map((colName) => {
+                                            if (!columnIdsMap.has(colName)) {
+                                                diagnostics.error(
+                                                    index,
+                                                    `Column '${colName}' not found in table '${tableName.getValue()}'`
+                                                )
+                                                return ''
+                                            }
+                                            return columnIdsMap.get(colName)
+                                        })
+                                        .join(','),
                                 },
                             })
                         )
@@ -1279,6 +1333,7 @@ function parseTableBootstrapXml(xml: unknown): TableDefinition | null {
             maxLength: column['@_max_length'],
             isMandatory: column['@_mandatory'],
             isReadOnly: column['@_read_only'],
+            readOnlyOption: column['@_read_only_option'],
             referenceTable: column['@_reference_table'],
             referenceQual: column['@_reference_qual'],
             columnLabel: column['@_label'],
@@ -1441,6 +1496,7 @@ function tableDefToRecordProperties(tableDef: TableDefinition): {
             max_length: column.maxLength,
             mandatory: column.isMandatory,
             read_only: column.isReadOnly,
+            read_only_option: column.readOnlyOption,
             reference_table: column.referenceTable,
             reference_qual: column.referenceQual,
             column_label: column.columnLabel,
@@ -1522,6 +1578,7 @@ function tableDefToRecordProperties(tableDef: TableDefinition): {
         default_value: undefined,
         max_length: undefined,
         mandatory: undefined,
+        read_only_option: undefined,
         reference_table: undefined,
         reference_qual: undefined,
         column_label: undefined,
@@ -1673,7 +1730,7 @@ async function generateRecordXml(
 ): Promise<OutputFile[]> {
     const files: OutputFile[] = []
     for (const record of records) {
-        const recordBuilder = unloadBuilder({ scope: config.scope, scopeId: config.scopeId })
+        const recordBuilder = unloadBuilder({ scope: config.scope, scopeId: config.scopeId, table: record.getTable() })
         const updateName = await transform.getUpdateName(record)
         const builder = recordBuilder.record(record, updateName)
 

package/src/ui-page-plugin.ts

@@ -22,7 +22,7 @@ const builderOptions: XmlBuilderOptions = {
     processEntities: true,
     // A valid but undocumented option
     // https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/src/xmlbuilder/json2xml.js#L26
-    // @ts-ignore
+    // @ts-expect-error
     entities: [
         // Match on &, &test, but not &, <, >, ', and "
         // See: https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references#Standard_public_entity_sets_for_characters for the list of default XML entities
@@ -70,6 +70,7 @@ window.g_ck = "$[gs.getSession().getSessionToken() || gs.getSessionToken()]";
  * @param nodes - parsed XML nodes
  * @returns - parsed XML nodes and any replacements of synthetic tags
  */
+// biome-ignore lint/suspicious/noExplicitAny: Fast-xml-parser types are not defined
 const nodeTransformer = (nodes: any[]) => {
     for (let i = 0; i < nodes.length; i++) {
         const node = nodes[i]