@servicenow/sdk-build-plugins 4.6.0 → 4.6.1

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 } from './utils'
+import { createSdkDocEntry, generateDeprecatedDiagnostics, generateChoiceSetFile } from './utils'
 import isEqual from 'lodash/isEqual'
 
 type GlobalRecord<T extends string | number | symbol, U> = globalThis.Record<T, U>
@@ -80,6 +80,10 @@ const ColumnSchema = z
         '@_use_dynamic_default': BooleanFromString.optional(),
         '@_reference': z.string().optional(),
         '@_virtual': BooleanFromString.optional(),
+        '@_formula': z.string().optional(),
+        '@_virtual_type': z.string().optional(),
+        '@_use_reference_qualifier': z.string().optional(),
+        '@_dynamic_ref_qual': z.string().optional(),
         '@_calculation': z.string().optional(),
         '@_choice_field': z.string().optional(),
         '@_function_definition': z.string().optional(),
@@ -168,6 +172,10 @@ type ColumnDefinition = {
     useDynamicDefault: boolean | undefined
     reference: string | undefined
     isVirtual: boolean | undefined
+    formula: string | undefined
+    virtualType: 'script' | 'formula' | undefined
+    useReferenceQualifier: 'simple' | 'dynamic' | 'advanced' | undefined
+    dynamicRefQual: string | undefined
     calculation: string | undefined
     choiceField: string | undefined
     functionDefinition: string | undefined
@@ -263,6 +271,10 @@ type SysDictionaryProperties = {
     use_dynamic_default: boolean | undefined
     reference: string | undefined
     virtual: boolean | undefined
+    formula: string | undefined
+    virtual_type: 'script' | 'formula' | undefined
+    use_reference_qualifier: 'simple' | 'dynamic' | 'advanced' | undefined
+    dynamic_ref_qual: string | undefined
     default: string | undefined
     calculation: string | undefined
     choice_field: string | undefined
@@ -419,7 +431,11 @@ export const TablePlugin = Plugin.create({
                             await factory.createRecord({
                                 source: file,
                                 table,
-                                properties: filterUndefinedProperties(rec),
+                                properties: {
+                                    ...filterUndefinedProperties(rec),
+                                    // Decorate generated sys_db_object
+                                    ...(key === 'sysDbObject' || key === 'sysDictionary' ? { _bootstrap: true } : {}),
+                                },
                             })
                         )
                     }
@@ -528,29 +544,41 @@ export const TablePlugin = Plugin.create({
                             override.transform(({ $ }) => ({
                                 baseTable: $.from('base_table'),
                                 default: $.from('default_value_override', 'default_value').map((flag, value) => {
-                                    return flag.toBoolean()?.getValue() ? value.ifString()?.getValue() : undefined
+                                    return flag.ifDefined() && flag.toBoolean()?.getValue()
+                                        ? value.ifString()?.getValue()
+                                        : undefined
                                 }),
                                 calculation: $.from('calculation_override', 'calculation').map((flag, value) => {
-                                    return flag.toBoolean()?.getValue() ? value.ifString()?.getValue() : undefined
+                                    return flag.ifDefined() && 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
+                                        return flag.ifDefined() && 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
+                                        return flag.ifDefined() && flag.toBoolean()?.getValue()
+                                            ? value.ifString()?.getValue()
+                                            : undefined
                                     }
                                 ),
                                 dependent: $.from('dependent_override', 'dependent').map((flag, value) => {
-                                    return flag.toBoolean()?.getValue() ? value.ifString()?.getValue() : undefined
+                                    return flag.ifDefined() && flag.toBoolean()?.getValue()
+                                        ? value.ifString()?.getValue()
+                                        : undefined
                                 }),
                                 mandatory: $.from('mandatory_override', 'mandatory').map((flag, value) => {
-                                    return flag.toBoolean()?.getValue() ? value.toBoolean()?.getValue() : undefined
+                                    return flag.ifDefined() && flag.toBoolean()?.getValue()
+                                        ? value.toBoolean()?.getValue()
+                                        : undefined
                                 }),
                                 attributes: $.from('attributes_override', 'attributes').map((flag, attrs) => {
-                                    if (!flag.toBoolean()?.getValue() || !attrs.isString()) {
+                                    if (!flag.ifDefined() || !flag.toBoolean()?.getValue() || !attrs.isString()) {
                                         return undefined
                                     }
                                     const result: { [key: string]: string | number | boolean } = {}
@@ -603,6 +631,43 @@ export const TablePlugin = Plugin.create({
                 // Avoid replacing call expressions with variable statements
                 const writeAsCallExpression =
                     ts.Node.isNode(originalSource) && originalSource.isKind(ts.SyntaxKind.CallExpression)
+
+                const tableName = record.get('name').asString().getValue()
+                const isBootstrapDbObject = record.get('_bootstrap').ifBoolean()?.getValue() === true
+                const nonBootstrapColumns = columns.filter(
+                    (col) => col.get('_bootstrap').ifBoolean()?.getValue() !== true
+                )
+
+                // Write as augmentation if we have sys_db_object from bootstrap and columns from elsewhere
+                const isAugmentation = isBootstrapDbObject && nonBootstrapColumns.length > 0
+                if (isAugmentation) {
+                    const augmentsExpression = new CallExpressionShape({
+                        source: record,
+                        callee: 'Table',
+                        exportName: tableName,
+                        args: [
+                            record.transform(({ $ }) => ({
+                                augments: $.val(tableName),
+                                schema: $.val(schema),
+                            })),
+                        ],
+                    })
+                    return {
+                        success: true,
+                        value: writeAsCallExpression
+                            ? augmentsExpression
+                            : new VariableStatementShape({
+                                  source: record,
+                                  isExported: true,
+                                  variableName: new IdentifierShape({
+                                      source: record,
+                                      name: tableName,
+                                  }),
+                                  initializer: augmentsExpression,
+                              }),
+                    }
+                }
+
                 const callExpression = new CallExpressionShape({
                     source: record,
                     callee: 'Table',
@@ -725,7 +790,7 @@ export const TablePlugin = Plugin.create({
                                 ).def([]),
                                 label: $.map(
                                     (label) =>
-                                        label.ifString() ??
+                                        label.ifString()?.ifNotEmpty() ??
                                         (tableDocumentation.length &&
                                         !isDefaultDocumentation('', tableDocumentation, config.defaultLanguage)
                                             ? tableDocumentation.map((doc) =>
@@ -804,12 +869,13 @@ export const TablePlugin = Plugin.create({
                 }
             },
             async toFile(record, { descendants, config, transform }) {
-                if (config.tableOutputFormat !== 'bootstrap' || config.type === 'configuration' || record.isDeleted()) {
-                    // Defer to record plugin
+                if (record.isDeleted()) {
                     return { success: false }
                 }
 
-                const tableName = record.get('name').asString().getValue()
+                const augmentsValue = record.get('augments').ifString()?.getValue()
+                const isAugmentation = augmentsValue !== undefined
+                const tableName = augmentsValue ?? record.get('name').asString().getValue()
                 const columns = descendants.query('sys_dictionary')
                 const choices = descendants.query('sys_choice')
                 const indexes = descendants.query('sys_index')
@@ -817,6 +883,71 @@ export const TablePlugin = Plugin.create({
                 const licensing = descendants.query('ua_table_licensing_config')
                 const autoNumber = descendants.query('sys_number')
                 const overrides = descendants.query('sys_dictionary_override')
+
+                const [
+                    documentationFiles,
+                    licensingFiles,
+                    autoNumberFiles,
+                    overrideFiles,
+                    sysDictionaryFiles,
+                    sysDbObjectFiles,
+                ] = await Promise.all([
+                    generateRecordXml(
+                        documentation.filter(
+                            (doc) =>
+                                !isDefaultDocumentation(
+                                    doc.get('element')?.toString().getValue(),
+                                    [doc],
+                                    config.defaultLanguage
+                                )
+                        ),
+                        config,
+                        transform
+                    ),
+                    generateRecordXml(
+                        licensing.filter((l) => !isDefaultLicenseConfig(tableName, l)),
+                        config,
+                        transform
+                    ),
+                    generateRecordXml(autoNumber, config, transform),
+                    generateRecordXml(overrides, config, transform),
+                    generateRecordXml(columns, config, transform, ['_bootstrap']),
+                    isAugmentation
+                        ? Promise.resolve([])
+                        : generateRecordXml([record], config, transform, ['augments', '_bootstrap']),
+                ])
+
+                if (config.type === 'configuration') {
+                    // No bootstrap XML for configuration projects, just write independent record XML
+                    const choiceSets = descendants.query('sys_choice_set')
+                    const [choiceSetFiles, indexFiles] = await Promise.all([
+                        Promise.all(
+                            choiceSets.map((cs) => {
+                                const csChoices = choices.filter(
+                                    (c) =>
+                                        c.get('name').toString().getValue() === cs.get('name').toString().getValue() &&
+                                        c.get('element').toString().getValue() ===
+                                            cs.get('element').toString().getValue()
+                                )
+                                return generateChoiceSetFile(cs, csChoices, config, transform)
+                            })
+                        ),
+                        generateRecordXml(indexes, config, transform),
+                    ])
+                    return {
+                        success: true,
+                        value: [
+                            ...sysDictionaryFiles,
+                            ...choiceSetFiles,
+                            ...indexFiles,
+                            ...sysDbObjectFiles,
+                            ...documentationFiles,
+                            ...licensingFiles,
+                            ...autoNumberFiles,
+                            ...overrideFiles,
+                        ],
+                    }
+                }
                 let displayColumn: string | undefined
                 let collectionRecord: Record | undefined
                 const elements: XMLBuilder[] = []
@@ -890,6 +1021,23 @@ export const TablePlugin = Plugin.create({
                         ['hint', column.get('hint').ifString()?.getValue()],
                         ['help', column.get('help').ifString()?.getValue()],
                         ['virtual', column.get('virtual').ifBoolean()?.getValue().toString()],
+                        ['formula', column.get('formula').ifString()?.getValue() || undefined],
+                        [
+                            'virtual_type',
+                            column.get('virtual_type').ifString()?.getValue() === 'script'
+                                ? undefined
+                                : column.get('virtual_type').ifString()?.getValue(),
+                        ],
+                        [
+                            'use_reference_qualifier',
+                            column.get('use_reference_qualifier').ifString()?.getValue() === 'simple'
+                                ? undefined
+                                : column.get('use_reference_qualifier').ifString()?.getValue(),
+                        ],
+                        [
+                            'dynamic_ref_qual',
+                            column.get('dynamic_ref_qual').ifDefined()?.toString().getValue() || undefined,
+                        ],
                         ['widget', column.get('widget').ifString()?.getValue()],
                         ['reference_qual', column.get('reference_qual').ifString()?.getValue()],
                         ['reference_qual_condition', column.get('reference_qual_condition').ifString()?.getValue()],
@@ -982,28 +1130,6 @@ export const TablePlugin = Plugin.create({
                     ]
                 ).end({ prettyPrint: true })
 
-                const documentationFiles = await generateRecordXml(
-                    documentation.filter(
-                        (doc) =>
-                            !isDefaultDocumentation(
-                                doc.get('element')?.toString().getValue(),
-                                [doc],
-                                config.defaultLanguage
-                            )
-                    ),
-                    config,
-                    transform
-                )
-
-                const licensingFiles = await generateRecordXml(
-                    licensing.filter((licensing) => !isDefaultLicenseConfig(tableName, licensing)),
-                    config,
-                    transform
-                )
-
-                const autoNumberFiles = await generateRecordXml(autoNumber, config, transform)
-                const overrideFiles = await generateRecordXml(overrides, config, transform)
-
                 return {
                     success: true,
                     value: [
@@ -1017,6 +1143,8 @@ export const TablePlugin = Plugin.create({
                         ...licensingFiles,
                         ...autoNumberFiles,
                         ...overrideFiles,
+                        ...sysDictionaryFiles,
+                        ...sysDbObjectFiles,
                     ],
                 }
             },
@@ -1068,7 +1196,9 @@ export const TablePlugin = Plugin.create({
                 const table = callExpression.getArgument(0).asObject().withAliasedKeys(tableAliases)
                 generateDeprecatedDiagnostics(table, diagnostics)
                 const relatedRecords: Record[] = []
-                const tableName = table.get('name').asString()
+                const augments = table.get('augments').ifString()
+                const isAugmentation = augments !== undefined
+                const tableName = isAugmentation ? augments! : table.get('name').asString()
                 if (!tableName.getValue().match(tableNameRegex)) {
                     diagnostics.error(
                         table.get('name'),
@@ -1078,16 +1208,28 @@ 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 scopePrefix = scopeName === 'global' ? 'u_' : `${scopeName}_`
+                const prefixRegex = new RegExp(`^${scopePrefix}`)
+                const tableNameMatch = tableName.getValue().match(prefixRegex)
+                if (isAugmentation) {
+                    if (tableNameMatch && scopeName !== 'global') {
+                        const nameNode = tableName.getOriginalNode()
+                        if (!nameNode?.getParentIfKind(ts.SyntaxKind.AsExpression)) {
+                            diagnostics.error(
+                                table.get('augments'),
+                                `'augments' flag set on in-scope table '${tableName.getValue()}'`
+                            )
+                        } else {
+                            ignoreColumnNameCheck = true
+                        }
+                    }
+                } else if (!tableNameMatch && !isSNScope(scopeName) && scopeName !== 'global') {
                     const nameNode = tableName.getOriginalNode()
                     if (nameNode && !nameNode.getParentIfKind(ts.SyntaxKind.AsExpression)) {
                         // 'sn' and 'now' scoped apps ignore this validation
                         diagnostics.error(
                             table.get('name'),
-                            `'name' property should start with scope prefix '${scopeName}_'`
+                            `'name' property should start with scope prefix '${scopePrefix}'`
                         )
                     } else {
                         ignoreColumnNameCheck = true
@@ -1106,13 +1248,11 @@ export const TablePlugin = Plugin.create({
                     )
                 }
 
-                const globalTableNameMatch = tableName.getValue().match(globalRegex)
                 let anyNonPrefixedGlobalColumn = false
-
-                if (scopeName === 'global' && !globalTableNameMatch) {
+                if (!isAugmentation && scopeName === 'global' && !tableNameMatch) {
                     const schema = table.get('schema').asObject()
                     for (const [name, _] of schema.entries()) {
-                        if (!name.match(globalRegex)) {
+                        if (!name.match(prefixRegex)) {
                             anyNonPrefixedGlobalColumn = true
                             break
                         }
@@ -1124,7 +1264,7 @@ export const TablePlugin = Plugin.create({
                             `Global table 'name' property should start with custom prefix 'u_'`
                         )
                     }
-                } else if (scopeName === 'global') {
+                } else if (scopeName === 'global' && !isAugmentation) {
                     // Global table starts with custom prefix `u_`, allow any column name prefix
                     ignoreColumnNameCheck = true
                 }
@@ -1217,22 +1357,30 @@ export const TablePlugin = Plugin.create({
                         relatedRecords.push(overrideRecord)
                     } else {
                         // Handle regular column - create sys_dictionary record
-                        if (
+                        if (isAugmentation && !tableNameMatch) {
+                            if (!isSNScope(scopeName) && !name.match(prefixRegex)) {
+                                diagnostics.error(
+                                    column.getOriginalNode().getParentIfKind(ts.SyntaxKind.PropertyAssignment) ??
+                                        column,
+                                    `Column name '${name}' must be prefixed with '${scopePrefix}' when augmenting a table`
+                                )
+                            }
+                        } else if (
                             !ignoreColumnNameCheck &&
                             !tableNameMatch &&
                             !isSNScope(scopeName) &&
                             scopeName !== 'global' &&
-                            !name.match(scopeRegex)
+                            !name.match(prefixRegex)
                         ) {
                             // '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`
+                                `Column name should be prefixed with scope '${scopePrefix}' if table name does not contain prefix`
                             )
-                        } else if (scopeName === 'global' && !globalTableNameMatch && !name.match(globalRegex)) {
+                        } else if (scopeName === 'global' && !tableNameMatch && !name.match(prefixRegex)) {
                             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`
+                                `Column name should be prefixed with '${scopePrefix}' 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
@@ -1409,29 +1557,32 @@ export const TablePlugin = Plugin.create({
                 }
 
                 // sys_dictionary (collection)
-                relatedRecords.push(
-                    await factory.createRecord({
-                        source: statement ?? callExpression,
-                        table: 'sys_dictionary',
-                        properties: table.transform(({ $ }) => ({
-                            name: $,
-                            element: $.val(undefined),
-                            internal_type: $.def('collection'),
-                            attributes: $.map((attributes) => {
-                                if (!attributes.isObject()) {
-                                    return undefined
-                                }
-                                const attributesObj = attributes.asObject().getValue()
-                                return Object.entries(attributesObj)
-                                    .map(([key, value]) => `${key}=${value}`)
-                                    .join(',')
-                            }).def(''),
-                            audit: $.def(false),
-                            read_only: $.from('readOnly').def(false),
-                            text_index: $.from('textIndex').def(false),
-                        })),
-                    })
-                )
+                if (!isAugmentation) {
+                    relatedRecords.push(
+                        await factory.createRecord({
+                            source: statement ?? callExpression,
+                            table: 'sys_dictionary',
+                            properties: table.transform(({ $ }) => ({
+                                name: $,
+                                element: $.val(undefined),
+                                internal_type: $.def('collection'),
+                                active: $.val(true),
+                                attributes: $.map((attributes) => {
+                                    if (!attributes.isObject()) {
+                                        return undefined
+                                    }
+                                    const attributesObj = attributes.asObject().getValue()
+                                    return Object.entries(attributesObj)
+                                        .map(([key, value]) => `${key}=${value}`)
+                                        .join(',')
+                                }).def(''),
+                                audit: $.def(false),
+                                read_only: $.from('readOnly').def(false),
+                                text_index: $.from('textIndex').def(false),
+                            })),
+                        })
+                    )
+                }
 
                 const hasAction = (actionName: string, actions: Shape): boolean | undefined => {
                     return actions
@@ -1481,8 +1632,12 @@ export const TablePlugin = Plugin.create({
                         is_extendable: $.from('extensible').toBoolean().def(false),
                         label: $.map((label) => getLabelForDefaultLanguage(label, config.defaultLanguage)),
                         live_feed_enabled: $.from('liveFeed').toBoolean().def(false),
-                        name: $,
+                        name: $.from('name', 'augments').map(
+                            (nameVal, augmentsVal) => augmentsVal.ifString() ?? nameVal
+                        ),
                         scriptable_table: $.from('scriptableTable').toBoolean().def(false),
+                        // Controls toFile output, not written to record XML
+                        augments: $.from('augments'),
                     })),
                 })
 
@@ -1569,6 +1724,18 @@ function parseTableBootstrapXml(xml: unknown): TableDefinition | null {
             useDynamicDefault: column['@_use_dynamic_default'],
             reference: column['@_reference'],
             isVirtual: column['@_virtual'],
+            formula: column['@_formula'],
+            virtualType:
+                column['@_virtual_type'] === 'script' || column['@_virtual_type'] === 'formula'
+                    ? column['@_virtual_type']
+                    : undefined,
+            useReferenceQualifier:
+                column['@_use_reference_qualifier'] === 'simple' ||
+                column['@_use_reference_qualifier'] === 'dynamic' ||
+                column['@_use_reference_qualifier'] === 'advanced'
+                    ? column['@_use_reference_qualifier']
+                    : undefined,
+            dynamicRefQual: column['@_dynamic_ref_qual'],
             calculation: column['@_calculation'],
             choiceField: column['@_choice_field'],
             functionDefinition: column['@_function_definition'],
@@ -1712,6 +1879,10 @@ function tableDefToRecordProperties(
             use_dynamic_default: column.useDynamicDefault,
             reference: column.reference,
             virtual: column.isVirtual,
+            formula: column.formula,
+            virtual_type: column.virtualType,
+            use_reference_qualifier: column.useReferenceQualifier,
+            dynamic_ref_qual: column.dynamicRefQual,
             default: column.defaultValue,
             calculation: column.calculation,
             choice_field: column.choiceField,
@@ -1794,6 +1965,10 @@ function tableDefToRecordProperties(
         use_dynamic_default: undefined,
         reference: undefined,
         virtual: undefined,
+        formula: undefined,
+        virtual_type: undefined,
+        use_reference_qualifier: undefined,
+        dynamic_ref_qual: undefined,
         default: undefined,
         calculation: undefined,
         choice_field: undefined,
@@ -1852,7 +2027,7 @@ function addTableToGlobalGeneratedFile(tableArg: ObjectShape, sourceFilePath: st
         >,
     }
     const generatedTableFile: ts.SourceFile | undefined = compiler.getGeneratedTableFile()
-    const tableName = tableArg.get('name').asString().getValue()
+    const tableName = tableArg.get('augments').ifString()?.getValue() ?? tableArg.get('name').asString().getValue()
     if (!(tableName.trim().length > 0 && tableName.match(tableNameRegex))) {
         return
     }
@@ -1933,7 +2108,8 @@ function createElement(name: string, attributes: [string, string][] = [], childr
 async function generateRecordXml(
     records: Record[],
     config: { scope: string; scopeId: string },
-    transform: Transform
+    transform: Transform,
+    excludeFields: string[] = []
 ): Promise<OutputFile[]> {
     const files: OutputFile[] = []
     for (const record of records) {
@@ -1944,6 +2120,7 @@ async function generateRecordXml(
         record
             .entries()
             .sort(([a], [b]) => a.localeCompare(b))
+            .filter(([prop]) => excludeFields.length === 0 || !excludeFields.includes(prop))
             .forEach(([prop, shape]) => builder.field(prop, shape))
 
         files.push({