@servicenow/sdk-build-plugins 4.6.0 → 4.6.1

package/dist/table-plugin.js

@@ -59,6 +59,10 @@ const ColumnSchema = zod_1.z
     '@_use_dynamic_default': BooleanFromString.optional(),
     '@_reference': zod_1.z.string().optional(),
     '@_virtual': BooleanFromString.optional(),
+    '@_formula': zod_1.z.string().optional(),
+    '@_virtual_type': zod_1.z.string().optional(),
+    '@_use_reference_qualifier': zod_1.z.string().optional(),
+    '@_dynamic_ref_qual': zod_1.z.string().optional(),
     '@_calculation': zod_1.z.string().optional(),
     '@_choice_field': zod_1.z.string().optional(),
     '@_function_definition': zod_1.z.string().optional(),
@@ -188,7 +192,11 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                         records.push(await factory.createRecord({
                             source: file,
                             table,
-                            properties: filterUndefinedProperties(rec),
+                            properties: {
+                                ...filterUndefinedProperties(rec),
+                                // Decorate generated sys_db_object
+                                ...(key === 'sysDbObject' || key === 'sysDictionary' ? { _bootstrap: true } : {}),
+                            },
                         }));
                     }
                 }
@@ -291,25 +299,37 @@ exports.TablePlugin = sdk_build_core_1.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 = {};
@@ -362,6 +382,38 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                 const originalSource = record.getOriginalSource();
                 // Avoid replacing call expressions with variable statements
                 const writeAsCallExpression = sdk_build_core_1.ts.Node.isNode(originalSource) && originalSource.isKind(sdk_build_core_1.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 sdk_build_core_1.CallExpressionShape({
+                        source: record,
+                        callee: 'Table',
+                        exportName: tableName,
+                        args: [
+                            record.transform(({ $ }) => ({
+                                augments: $.val(tableName),
+                                schema: $.val(schema),
+                            })),
+                        ],
+                    });
+                    return {
+                        success: true,
+                        value: writeAsCallExpression
+                            ? augmentsExpression
+                            : new sdk_build_core_1.VariableStatementShape({
+                                source: record,
+                                isExported: true,
+                                variableName: new sdk_build_core_1.IdentifierShape({
+                                    source: record,
+                                    name: tableName,
+                                }),
+                                initializer: augmentsExpression,
+                            }),
+                    };
+                }
                 const callExpression = new sdk_build_core_1.CallExpressionShape({
                     source: record,
                     callee: 'Table',
@@ -468,7 +520,7 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                                     }),
                                 }));
                             })).def([]),
-                            label: $.map((label) => label.ifString() ??
+                            label: $.map((label) => label.ifString()?.ifNotEmpty() ??
                                 (tableDocumentation.length &&
                                     !(0, column_plugin_1.isDefaultDocumentation)('', tableDocumentation, config.defaultLanguage)
                                     ? tableDocumentation.map((doc) => doc
@@ -542,11 +594,12 @@ exports.TablePlugin = sdk_build_core_1.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');
@@ -554,6 +607,42 @@ exports.TablePlugin = sdk_build_core_1.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) => !(0, column_plugin_1.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 (0, utils_1.generateChoiceSetFile)(cs, csChoices, config, transform);
+                        })),
+                        generateRecordXml(indexes, config, transform),
+                    ]);
+                    return {
+                        success: true,
+                        value: [
+                            ...sysDictionaryFiles,
+                            ...choiceSetFiles,
+                            ...indexFiles,
+                            ...sysDbObjectFiles,
+                            ...documentationFiles,
+                            ...licensingFiles,
+                            ...autoNumberFiles,
+                            ...overrideFiles,
+                        ],
+                    };
+                }
                 let displayColumn;
                 let collectionRecord;
                 const elements = [];
@@ -626,6 +715,23 @@ exports.TablePlugin = sdk_build_core_1.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()],
@@ -692,10 +798,6 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                         ...indexElements,
                     ]),
                 ]).end({ prettyPrint: true });
-                const documentationFiles = await generateRecordXml(documentation.filter((doc) => !(0, column_plugin_1.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: [
@@ -709,6 +811,8 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                         ...licensingFiles,
                         ...autoNumberFiles,
                         ...overrideFiles,
+                        ...sysDictionaryFiles,
+                        ...sysDbObjectFiles,
                     ],
                 };
             },
@@ -759,20 +863,33 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                 const table = callExpression.getArgument(0).asObject().withAliasedKeys(tableAliases);
                 (0, utils_1.generateDeprecatedDiagnostics)(table, diagnostics);
                 const relatedRecords = [];
-                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'), 'Table name must only contain lowercase letters, numbers, and underscores and end with a letter or number');
                 }
                 let ignoreColumnNameCheck = false;
                 const scopeName = config.scope;
-                const scopeRegex = new RegExp(`^${scopeName}_`);
-                const globalRegex = /^u_/;
-                const tableNameMatch = tableName.getValue().match(scopeRegex);
-                if (!tableNameMatch && !(0, sdk_build_core_1.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(sdk_build_core_1.ts.SyntaxKind.AsExpression)) {
+                            diagnostics.error(table.get('augments'), `'augments' flag set on in-scope table '${tableName.getValue()}'`);
+                        }
+                        else {
+                            ignoreColumnNameCheck = true;
+                        }
+                    }
+                }
+                else if (!tableNameMatch && !(0, sdk_build_core_1.isSNScope)(scopeName) && scopeName !== 'global') {
                     const nameNode = tableName.getOriginalNode();
                     if (nameNode && !nameNode.getParentIfKind(sdk_build_core_1.ts.SyntaxKind.AsExpression)) {
                         // 'sn' and 'now' scoped apps ignore this validation
-                        diagnostics.error(table.get('name'), `'name' property should start with scope prefix '${scopeName}_'`);
+                        diagnostics.error(table.get('name'), `'name' property should start with scope prefix '${scopePrefix}'`);
                     }
                     else {
                         ignoreColumnNameCheck = true;
@@ -785,12 +902,11 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                 if (!exportedByName) {
                     diagnostics.error(callExpression, `Table definition should be exported as a named export with the name '${tableName.getValue()}'`);
                 }
-                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;
                         }
@@ -799,7 +915,7 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                         diagnostics.error(table.get('name'), `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;
                 }
@@ -880,16 +996,22 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                     }
                     else {
                         // Handle regular column - create sys_dictionary record
-                        if (!ignoreColumnNameCheck &&
+                        if (isAugmentation && !tableNameMatch) {
+                            if (!(0, sdk_build_core_1.isSNScope)(scopeName) && !name.match(prefixRegex)) {
+                                diagnostics.error(column.getOriginalNode().getParentIfKind(sdk_build_core_1.ts.SyntaxKind.PropertyAssignment) ??
+                                    column, `Column name '${name}' must be prefixed with '${scopePrefix}' when augmenting a table`);
+                            }
+                        }
+                        else if (!ignoreColumnNameCheck &&
                             !tableNameMatch &&
                             !(0, sdk_build_core_1.isSNScope)(scopeName) &&
                             scopeName !== 'global' &&
-                            !name.match(scopeRegex)) {
+                            !name.match(prefixRegex)) {
                             // 'sn' and 'now' scoped apps ignore this validation
-                            diagnostics.error(column.getOriginalNode().getParentIfKind(sdk_build_core_1.ts.SyntaxKind.PropertyAssignment) ?? column, `Column name should be prefixed with scope '${scopeName}_' if table name does not contain prefix`);
+                            diagnostics.error(column.getOriginalNode().getParentIfKind(sdk_build_core_1.ts.SyntaxKind.PropertyAssignment) ?? column, `Column name should be prefixed with scope '${scopePrefix}' if table name does not contain prefix`);
                         }
-                        else if (scopeName === 'global' && !globalTableNameMatch && !name.match(globalRegex)) {
-                            diagnostics.error(column.getOriginalNode().getParentIfKind(sdk_build_core_1.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`);
+                        else if (scopeName === 'global' && !tableNameMatch && !name.match(prefixRegex)) {
+                            diagnostics.error(column.getOriginalNode().getParentIfKind(sdk_build_core_1.ts.SyntaxKind.PropertyAssignment) ?? column, `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;
                         const result = await transform.toRecord((0, column_helper_1.addFieldsToColumn)({ name, table: tableName.getValue(), display }, column.as(sdk_build_core_1.CallExpressionShape)));
@@ -1038,27 +1160,30 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                     relatedRecords.push(sysNumberRecord);
                 }
                 // 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, actions) => {
                     return actions
                         .ifArray()
@@ -1101,8 +1226,10 @@ exports.TablePlugin = sdk_build_core_1.Plugin.create({
                         is_extendable: $.from('extensible').toBoolean().def(false),
                         label: $.map((label) => (0, column_to_record_1.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'),
                     })),
                 });
                 if (exportedByName) {
@@ -1186,6 +1313,16 @@ function parseTableBootstrapXml(xml) {
             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'],
@@ -1313,6 +1450,10 @@ function tableDefToRecordProperties(tableDef, tableDefaultLanguage = 'en') {
             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,
@@ -1392,6 +1533,10 @@ function tableDefToRecordProperties(tableDef, tableDefaultLanguage = 'en') {
         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,
@@ -1443,7 +1588,7 @@ function addTableToGlobalGeneratedFile(tableArg, sourceFilePath, compiler) {
         namedImports: [],
     };
     const generatedTableFile = 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;
     }
@@ -1519,7 +1664,7 @@ function createElement(name, attributes = [], children = []) {
     }
     return element;
 }
-async function generateRecordXml(records, config, transform) {
+async function generateRecordXml(records, config, transform, excludeFields = []) {
     const files = [];
     for (const record of records) {
         const recordBuilder = (0, sdk_build_core_1.unloadBuilder)({ scope: config.scope, scopeId: config.scopeId, table: record.getTable() });
@@ -1528,6 +1673,7 @@ async function generateRecordXml(records, config, transform) {
         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({
             source: record,