@servicenow/sdk-build-plugins 4.6.1 → 4.7.0

package/src/schedule-script/scheduled-script-plugin.ts

@@ -10,7 +10,7 @@ import {
 import { NowIdShape } from '../now-id-plugin'
 import { NowIncludeShape } from '../now-include-plugin'
 import { ModuleFunctionShape } from '../server-module-plugin'
-import { createSdkDocEntry, toReference } from '../utils'
+import { toReference } from '../utils'
 import { dateTimeFieldToXML, convertXMLToDateTime, formatTimeDataToDateTime, formatToUTC } from './timeZoneConverter'
 
 const DEFAULT_DATE_TIME = '1970-01-01 00:00:00'
@@ -289,7 +289,6 @@ function validateRecurringJobSchedule(
 
 export const ScheduledScriptPlugin = Plugin.create({
     name: 'ScheduledScriptPlugin',
-    docs: [createSdkDocEntry('ScheduledScript', ['sysauto_script'])],
     records: {
         sysauto_script: {
             async toShape(record, { transform }) {
@@ -469,9 +468,16 @@ export const ScheduledScriptPlugin = Plugin.create({
                     )
                 }
 
-                // Validate daysOfWeek is defined when frequency is 'weekly'
-                if (frequency === 'weekly' && args.get('daysOfWeek').isUndefined()) {
-                    diagnostics.error(args.get('frequency'), `daysOfWeek must be defined when frequency is 'weekly'`)
+                // Validate dayOfWeek or daysOfWeek is defined when frequency is 'weekly'
+                if (
+                    frequency === 'weekly' &&
+                    args.get('daysOfWeek').isUndefined() &&
+                    args.get('dayOfWeek').isUndefined()
+                ) {
+                    diagnostics.error(
+                        args.get('frequency'),
+                        `dayOfWeek or daysOfWeek must be defined when frequency is 'weekly'`
+                    )
                 }
 
                 // Validate businessCalendar is not empty when frequency is business calendar related

package/src/script-action-plugin.ts

@@ -1,11 +1,9 @@
 import { CallExpressionShape, Plugin } from '@servicenow/sdk-build-core'
 import { NowIdShape } from './now-id-plugin'
 import { ModuleFunctionShape } from './server-module-plugin'
-import { createSdkDocEntry } from './utils'
 
 export const ScriptActionPlugin = Plugin.create({
     name: 'ScriptActionPlugin',
-    docs: [createSdkDocEntry('ScriptAction', ['sysevent_script_action'])],
     records: {
         sysevent_script_action: {
             toShape(record) {

package/src/script-include-plugin.ts

@@ -1,13 +1,11 @@
 import { CallExpressionShape, isSNScope, Plugin } from '@servicenow/sdk-build-core'
 import { NowIdShape } from './now-id-plugin'
 import { NowIncludeShape } from './now-include-plugin'
-import { createSdkDocEntry } from './utils'
 
 const nameRegex = /^[a-zA-Z_$][0-9a-zA-Z_$]+$/
 
 export const ScriptIncludePlugin = Plugin.create({
     name: `ScriptIncludePlugin`,
-    docs: [createSdkDocEntry('ScriptInclude', ['sys_script_include'])],
     records: {
         sys_script_include: {
             async toShape(record, { transform }) {
@@ -37,7 +35,6 @@ export const ScriptIncludePlugin = Plugin.create({
                                 sandboxCallable: $.from('sandbox_callable').toBoolean(),
                                 accessibleFrom: $.from('access').def('package_private'),
                                 active: $.toBoolean(),
-                                protectionPolicy: $.from('sys_policy').def(''),
                             })),
                         ],
                     }),
@@ -112,7 +109,6 @@ export const ScriptIncludePlugin = Plugin.create({
                                 sandbox_callable: $.from('sandboxCallable').def(false),
                                 access: $.from('accessibleFrom').def('package_private'),
                                 active: $.def(true),
-                                sys_policy: $.from('protectionPolicy'),
                             }
                         }),
                     }),

package/src/server-module-plugin/index.ts

@@ -351,7 +351,6 @@ function getModuleDependencyPath(
 
 export const ServerModulePlugin = Plugin.create({
     name: 'ServerModulePlugin',
-    docs: [],
     files: [
         {
             entryPoint: true,
@@ -434,7 +433,7 @@ export const ServerModulePlugin = Plugin.create({
                 }
 
                 // Lint local module for Rhino compatibility (no Glide restrictions)
-                if (/\.(js|cjs|mjs|ts)$/.test(pathModule.extname(resolvedPath))) {
+                if (config.linter.module.enabled && /\.(js|cjs|mjs|ts)$/.test(pathModule.extname(resolvedPath))) {
                     const { LocalModuleLint } = await import('../repack/lint/index.js')
                     const lint = new LocalModuleLint()
                     const lintResult = lint.check(content)
@@ -511,7 +510,7 @@ export const ServerModulePlugin = Plugin.create({
                     )
                     for (const file of files) {
                         const fileContent = fs.readFileSync(pathModule.join(packagePath, file)).toString('utf-8')
-                        if (/\.(js|cjs|mjs)$/.test(pathModule.extname(file))) {
+                        if (config.linter.module.enabled && /\.(js|cjs|mjs)$/.test(pathModule.extname(file))) {
                             const result = lint.check(fileContent)
                             if (result) {
                                 logger.warn(`Use of unsupported APIs detected in npm dependency ${name}`)

package/src/service-catalog/catalog-clientscript-plugin.ts

@@ -11,11 +11,9 @@ import {
     resolveAndValidateVariableId,
 } from './utils'
 import { validateCatalogItemVariableSetExclusivity } from './service-catalog-diagnostics'
-import { createSdkDocEntry } from '../utils'
 
 export const CatalogClientScriptPlugin = Plugin.create({
     name: 'CatalogClientScriptPlugin',
-    docs: [createSdkDocEntry('CatalogClientScript', ['catalog_script_client'])],
     records: {
         catalog_script_client: {
             async toShape(record, { database, transform }) {

package/src/service-catalog/catalog-item-plugin.ts

@@ -14,7 +14,6 @@ import {
     createScript,
 } from './utils'
 import { validateFulfillmentProcessExclusivity, validateCategoriesRequireCatalogs } from './service-catalog-diagnostics'
-import { createSdkDocEntry } from '../utils'
 import {
     buildVariablesSchema,
     CatalogItemBaseRelationships,
@@ -28,7 +27,6 @@ import {
 
 export const CatalogItemPlugin = Plugin.create({
     name: 'CatalogItemPlugin',
-    docs: [createSdkDocEntry('CatalogItem', ['sc_cat_item'])],
     records: {
         sc_cat_item: {
             relationships: CatalogItemBaseRelationships,

package/src/service-catalog/catalog-ui-policy-plugin.ts

@@ -25,7 +25,6 @@ import {
     getValueActionToDb,
 } from './utils'
 import { validateCatalogItemVariableSetExclusivity, validateUiPolicyActionMessage } from './service-catalog-diagnostics'
-import { createSdkDocEntry } from '../utils'
 
 // Define table names as constants since they're not exported from the core tables
 const CATALOG_UI_POLICY = 'catalog_ui_policy'
@@ -51,7 +50,6 @@ const stripIOPrefix = (value: string): string => {
 
 export const CatalogUiPolicyPlugin = Plugin.create({
     name: 'CatalogUiPolicyPlugin',
-    docs: [createSdkDocEntry('CatalogUiPolicy', ['catalog_ui_policy'])],
     records: {
         [CATALOG_UI_POLICY]: {
             relationships: {

package/src/service-catalog/sc-record-producer-plugin.ts

@@ -28,11 +28,9 @@ import {
 } from './service-catalog-base'
 import { validateFulfillmentProcessExclusivity, validateCategoriesRequireCatalogs } from './service-catalog-diagnostics'
 import { ModuleFunctionShape } from '../server-module-plugin'
-import { createSdkDocEntry } from '../utils'
 
 export const CatalogItemRecordProducerPlugin = Plugin.create({
     name: 'CatalogItemRecordProducerPlugin',
-    docs: [createSdkDocEntry('CatalogItemRecordProducer', ['sc_cat_item_producer'])],
     records: {
         sc_cat_item_producer: {
             relationships: CatalogItemBaseRelationships,

package/src/service-catalog/variable-set-plugin.ts

@@ -20,11 +20,9 @@ import {
     getVariableSetTypeFromDb,
     getVariableSetTypeToDb,
 } from './utils'
-import { createSdkDocEntry } from '../utils'
 
 export const VariableSetPlugin = Plugin.create({
     name: 'VariableSetPlugin',
-    docs: [createSdkDocEntry('VariableSet', ['item_option_new_set'])],
     records: {
         item_option_new_set: {
             relationships: {

package/src/service-portal/angular-provider-plugin.ts

@@ -1,10 +1,8 @@
 import { CallExpressionShape, Plugin } from '@servicenow/sdk-build-core'
 import { NowIdShape } from '../now-id-plugin'
-import { createSdkDocEntry } from '../utils'
 
 export const SPAngularProviderPlugin = Plugin.create({
     name: 'SPAngularProviderPlugin',
-    docs: [createSdkDocEntry('SPAngularProvider', ['sp_angular_provider'])],
     records: {
         sp_angular_provider: {
             relationships: {

package/src/service-portal/dependency-plugin.ts

@@ -1,12 +1,10 @@
 import { CallExpressionShape, Plugin } from '@servicenow/sdk-build-core'
 import { toReference } from '../utils'
 import { NowIdShape } from '../now-id-plugin'
-import { createSdkDocEntry } from '../utils'
 import { getIncludeRecords } from './utils'
 
 export const SPWidgetDependencyPlugin = Plugin.create({
     name: 'SPWidgetDependencyPlugin',
-    docs: [createSdkDocEntry('SPWidgetDependency', ['sp_dependency'])],
     records: {
         sp_dependency: {
             relationships: {

package/src/service-portal/header-footer-plugin.ts

@@ -1,5 +1,4 @@
 import { CallExpressionShape, Plugin } from '@servicenow/sdk-build-core'
-import { createSdkDocEntry } from '../utils'
 import { createWidgetToRecord, createWidgetToShape } from './utils'
 import {
     getDefaultClientScript,
@@ -10,7 +9,6 @@ import {
 
 export const SPHeaderFooterPlugin = Plugin.create({
     name: 'SPHeaderFooterPlugin',
-    docs: [createSdkDocEntry('SPHeaderFooter', ['sp_header_footer'])],
     records: {
         sp_header_footer: {
             relationships: {

package/src/service-portal/menu-plugin.ts

@@ -9,7 +9,7 @@ import {
 } from '@servicenow/sdk-build-core'
 import { NowIdShape } from '../now-id-plugin'
 import { NowIncludeShape } from '../now-include-plugin'
-import { toReference, getFieldAsNumber, noThrow, createSdkDocEntry } from '../utils'
+import { toReference, getFieldAsNumber, noThrow } from '../utils'
 import { getRolesString } from './utils'
 
 const default_placeholder_dimensions = `{
@@ -219,7 +219,6 @@ async function createItemRecords(
 
 export const SPMenuPlugin = Plugin.create({
     name: 'SPMenuPlugin',
-    docs: [createSdkDocEntry('SPMenu', ['sp_instance_menu'])],
     records: {
         sp_instance_menu: {
             relationships: {

package/src/service-portal/page-plugin.ts

@@ -9,7 +9,7 @@ import {
     type ObjectShape,
 } from '@servicenow/sdk-build-core'
 import isEmpty from 'lodash/isEmpty'
-import { toReference, getFieldAsNumber, createSdkDocEntry } from '../utils'
+import { toReference, getFieldAsNumber } from '../utils'
 import { getRolesString } from './utils'
 
 type Dict = { [key: string]: unknown }
@@ -566,7 +566,6 @@ async function createInstanceRecords(instancesArray: Shape[], columnId: RecordId
 
 export const SPPagePlugin = Plugin.create({
     name: 'SPPagePlugin',
-    docs: [createSdkDocEntry('SPPage', ['sp_page'])],
     records: {
         sp_page: {
             coalesce: ['id'],

package/src/service-portal/page-route-map-plugin.ts

@@ -1,6 +1,6 @@
 import { CallExpressionShape, Plugin, type Shape } from '@servicenow/sdk-build-core'
 import { NowIdShape } from '../now-id-plugin'
-import { toReference, createSdkDocEntry } from '../utils'
+import { toReference } from '../utils'
 import { getRolesString } from './utils'
 
 function getPortalsString(portalsShape: Shape): string {
@@ -21,7 +21,6 @@ function getPortalsString(portalsShape: Shape): string {
 
 export const SPPageRouteMapPlugin = Plugin.create({
     name: 'SPPageRouteMapPlugin',
-    docs: [createSdkDocEntry('SPPageRouteMap', ['sp_page_route_map'])],
     records: {
         sp_page_route_map: {
             coalesce: ['route_from_page', 'portals'],

package/src/service-portal/portal-plugin.ts

@@ -1,6 +1,5 @@
 import { Plugin, CallExpressionShape, type Record, type Shape } from '@servicenow/sdk-build-core'
 import { NowIdShape } from '../now-id-plugin'
-import { createSdkDocEntry } from '../utils'
 
 function convertToNumber(value: Shape, defaultValue: number = 0): number {
     if (!value || value.isUndefined() || value.ifString()?.isEmpty()) {
@@ -11,7 +10,6 @@ function convertToNumber(value: Shape, defaultValue: number = 0): number {
 
 export const ServicePortalPlugin = Plugin.create({
     name: 'ServicePortalPlugin',
-    docs: [createSdkDocEntry('ServicePortal', ['sp_portal'])],
     records: {
         sp_portal: {
             relationships: {

package/src/service-portal/theme-plugin.ts

@@ -1,11 +1,9 @@
 import { CallExpressionShape, Plugin } from '@servicenow/sdk-build-core'
 import { NowIdShape } from '../now-id-plugin'
 import { DEFAULT_ORDER, getIncludeRecords } from './utils'
-import { createSdkDocEntry } from '../utils'
 
 export const SPThemePlugin = Plugin.create({
     name: 'SPThemePlugin',
-    docs: [createSdkDocEntry('SPTheme', ['sp_theme'])],
     records: {
         sp_theme: {
             relationships: {

package/src/service-portal/widget-plugin.ts

@@ -1,10 +1,8 @@
 import { CallExpressionShape, Plugin } from '@servicenow/sdk-build-core'
-import { createSdkDocEntry } from '../utils'
 import { createWidgetToRecord, createWidgetToShape } from './utils'
 
 export const SPWidgetPlugin = Plugin.create({
     name: 'SPWidgetPlugin',
-    docs: [createSdkDocEntry('SPWidget', ['sp_widget'])],
     records: {
         sp_widget: {
             relationships: {

package/src/sla-plugin.ts

@@ -1,6 +1,5 @@
 import { CallExpressionShape, Plugin, DurationShape } from '@servicenow/sdk-build-core'
 import { NowIdShape } from './now-id-plugin'
-import { createSdkDocEntry } from './utils'
 import {
     validateUserSpecifiedDuration,
     validateRelativeDuration,
@@ -37,7 +36,6 @@ const DEFAULT_DURATION_ON_PLATFORM = '1970-01-01 00:00:00'
  */
 export const SLAPlugin = Plugin.create({
     name: 'SLAPlugin',
-    docs: [createSdkDocEntry('Sla', ['contract_sla'])],
 
     records: {
         contract_sla: {

package/src/static-content-plugin.ts

@@ -3,7 +3,7 @@ import * as mime from 'mime-types'
 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'
-import { TRANSLATIONS_ASSET_NAME } from '@servicenow/isomorphic-rollup'
+import { TRANSLATIONS_SUFFIX } from '@servicenow/isomorphic-rollup'
 
 // based on tectonic code for attachments
 // https://code.devsnc.com/dev/sn-tectonic/blob/b3ab42ce742158cb5a0d00efd540b97eeafcbdd7/core/metadata-transform-san-diego/utils/index.js#L66
@@ -92,7 +92,6 @@ const toNoOpShape = (record: Record) => {
 
 export const StaticContentPlugin = Plugin.create({
     name: 'StaticContentPlugin',
-    docs: [],
     records: {
         // TODO: remove when we have generic attachment support
         sys_attachment: {
@@ -102,6 +101,9 @@ export const StaticContentPlugin = Plugin.create({
         sys_attachment_doc: {
             toShape: toNoOpShape,
         },
+        sys_ui_message: {
+            toShape: toNoOpShape,
+        },
         sys_ux_lib_asset: {
             coalesce: ['name'],
             relationships: { ...attachmentRelationships, ...sourceArtifactRelationships },
@@ -167,8 +169,39 @@ export const StaticContentPlugin = Plugin.create({
                     // Build-time manifest produced by the uiPageSourceManifest rollup plugin.
                     // Consumed by UiPage during build to determine which source files to include
                     // in the source artifact record. Not a deployable asset.
-                } else if (relativePath === TRANSLATIONS_ASSET_NAME) {
-                    logger.debug('translations not supported yet')
+                } else if (relativePath.endsWith(TRANSLATIONS_SUFFIX)) {
+                    // Build-time asset produced by collectSnTranslate() rollup plugin.
+                    // Create sys_ui_message records for each collected translation message key.
+                    // Messages can be plain strings (t('key')) or objects (t({ code, message, ... })).
+                    const parsed = JSON.parse(stringFileContent) as {
+                        messages: Array<string | { [key: string]: string }>
+                    }
+                    const { messages } = parsed
+                    if (messages.length > 0) {
+                        const messageRecords = await Promise.all(
+                            messages.map((entry) => {
+                                const key = typeof entry === 'string' ? entry : (entry['code'] ?? '')
+                                const messageText = typeof entry === 'string' ? entry : (entry['message'] ?? key)
+                                return factory.createRecord({
+                                    source: file,
+                                    explicitId: key,
+                                    table: 'sys_ui_message',
+                                    properties: {
+                                        code: config.scope,
+                                        key,
+                                        language: config.defaultLanguage,
+                                        message: messageText,
+                                    },
+                                })
+                            })
+                        )
+                        const [first, ...rest] = messageRecords
+                        if (!first) {
+                            return { success: false }
+                        }
+                        return { success: true, value: first.with(...rest) }
+                    }
+                    return { success: false }
                 } else if (mimeType === 'application/javascript') {
                     tableName = 'sys_ux_lib_asset'
                     assetName = pathModule.join(