@servicenow/sdk-build-plugins 4.3.0 → 4.4.0

package/src/table-plugin.ts

@@ -16,10 +16,16 @@ import {
 } from '@servicenow/sdk-build-core'
 import { XMLParser } from 'fast-xml-parser'
 import { z } from 'zod'
-import { columnToCallExpression, generatePlural, isDefaultDocumentation } from './column-plugin'
+import {
+    BCP47_LANGUAGE_TAG_PATTERN,
+    columnToCallExpression,
+    generatePlural,
+    isDefaultDocumentation,
+} from './column-plugin'
 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 { generateDeprecatedDiagnostics } from './utils'
 import isEqual from 'lodash/isEqual'
 
@@ -367,7 +373,7 @@ export const TablePlugin = Plugin.create({
     files: [
         {
             matcher: /\.xml$/,
-            async toRecord(file, { factory }) {
+            async toRecord(file, { factory, config }) {
                 const xml = new XMLParser({
                     ignoreAttributes: false,
                     alwaysCreateTextNode: true,
@@ -383,7 +389,7 @@ export const TablePlugin = Plugin.create({
                     return { success: false }
                 }
 
-                const recordDefs = tableDefToRecordProperties(tableDef)
+                const recordDefs = tableDefToRecordProperties(tableDef, config.tableDefaultLanguage)
                 const records: Record[] = []
                 for (const [key, table] of [
                     ['sysDbObject', 'sys_db_object'],
@@ -463,7 +469,7 @@ export const TablePlugin = Plugin.create({
                     via: 'super_class',
                 },
             },
-            toShape(record, { descendants }) {
+            toShape(record, { descendants, config }) {
                 const schema: { [key: string]: CallExpressionShape } = {}
                 let displayColumn: string | undefined
                 const columns = descendants.query('sys_dictionary')
@@ -482,6 +488,7 @@ export const TablePlugin = Plugin.create({
                         documentation: documentation.filter(
                             (d) => d.get('element').ifString()?.getValue() === columnName
                         ),
+                        tableDefaultLanguage: config.tableDefaultLanguage,
                     })
                     if (column.get('display').ifDefined()?.toBoolean().getValue()) {
                         displayColumn = columnName
@@ -620,14 +627,15 @@ export const TablePlugin = Plugin.create({
                                 label: $.map(
                                     (label) =>
                                         label.ifString() ??
-                                        (tableDocumentation.length && !isDefaultDocumentation('', tableDocumentation)
+                                        (tableDocumentation.length &&
+                                        !isDefaultDocumentation('', tableDocumentation, config.tableDefaultLanguage)
                                             ? tableDocumentation.map((doc) =>
                                                   doc
                                                       .transform(({ $ }) => ({
                                                           label: $.def(''),
                                                           help: $.def(''),
                                                           hint: $.def(''),
-                                                          language: $.def(''),
+                                                          language: $.def(config.tableDefaultLanguage),
                                                           plural: $.def(''),
                                                           url: $.def(''),
                                                           urlTarget: $.from('url_target').def(''),
@@ -876,7 +884,12 @@ export const TablePlugin = Plugin.create({
 
                 const documentationFiles = await generateRecordXml(
                     documentation.filter(
-                        (doc) => !isDefaultDocumentation(doc.get('element')?.toString().getValue(), [doc])
+                        (doc) =>
+                            !isDefaultDocumentation(
+                                doc.get('element')?.toString().getValue(),
+                                [doc],
+                                config.tableDefaultLanguage
+                            )
                     ),
                     config,
                     transform
@@ -1142,10 +1155,10 @@ export const TablePlugin = Plugin.create({
                         generateDeprecatedDiagnostics(docObject, diagnostics)
                         const language = docObject.get('language').ifString()?.getValue()
                         if (language) {
-                            if (language.length !== 2) {
+                            if (!BCP47_LANGUAGE_TAG_PATTERN.test(language)) {
                                 diagnostics.error(
                                     doc.getOriginalNode(),
-                                    `'language' must be a 2 character identifier (Ex. 'en', 'es')`
+                                    `'language' must be a valid BCP 47 language tag (e.g., 'en', 'es', 'en-US', 'zh-Hans')`
                                 )
                             }
                             if (languages.has(language)) {
@@ -1179,7 +1192,7 @@ export const TablePlugin = Plugin.create({
                             properties: {
                                 name: tableName,
                                 element: undefined,
-                                language: 'en',
+                                language: config.tableDefaultLanguage,
                                 label: table.get('label').ifString() ?? tableName,
                                 plural: generatePlural(
                                     table.get('label')?.ifString()?.getValue() ?? tableName.getValue()
@@ -1278,7 +1291,7 @@ export const TablePlugin = Plugin.create({
                             .map((actions) => hasAction('create', actions))
                             .def(false),
                         is_extendable: $.from('extensible').toBoolean().def(false),
-                        label: $.map((label) => (label.isString() ? label.asString() : undefined)),
+                        label: $.map((label) => getLabelForDefaultLanguage(label, config.tableDefaultLanguage)),
                         live_feed_enabled: $.from('liveFeed').toBoolean().def(false),
                         name: $,
                         scriptable_table: $.from('scriptableTable').toBoolean().def(false),
@@ -1446,7 +1459,10 @@ function parseTableBootstrapXml(xml: unknown): TableDefinition | null {
     }
 }
 
-function tableDefToRecordProperties(tableDef: TableDefinition): {
+function tableDefToRecordProperties(
+    tableDef: TableDefinition,
+    tableDefaultLanguage: string = 'en'
+): {
     sysDbObject: SysDbObjectProperties
     sysDictionary: SysDictionaryProperties[]
     sysChoice: SysChoiceProperties[]
@@ -1481,7 +1497,7 @@ function tableDefToRecordProperties(tableDef: TableDefinition): {
             element: undefined,
             label: tableDef.label,
             plural: tableDef.plural,
-            language: 'en',
+            language: tableDefaultLanguage,
             hint: undefined,
             help: undefined,
         })
@@ -1558,7 +1574,7 @@ function tableDefToRecordProperties(tableDef: TableDefinition): {
             element: column.name,
             label: column.columnLabel || column.name,
             plural: column.plural || generatePlural(column.columnLabel || column.name),
-            language: 'en',
+            language: tableDefaultLanguage,
             hint: column.hint,
             help: column.help,
         })