@servicenow/sdk-build-plugins 4.1.1 → 4.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@servicenow/sdk-build-plugins",
-  "version": "4.1.1",
+  "version": "4.3.0",
   "description": "ServiceNow SDK Build System Plugins",
   "license": "MIT",
   "main": "./dist/index.js",
@@ -13,32 +13,30 @@
   },
   "dependencies": {
     "@cyclonedx/cyclonedx-library": "8.6.0",
-    "@servicenow/glide": "26.0.1",
+    "@servicenow/glide": "27.0.4",
     "eslint": "8.50.0",
     "eslint-formatter-stylish": "8.40.0",
     "eslint-plugin-es-x": "7.2.0",
-    "fast-xml-parser": "4.4.1",
+    "fast-xml-parser": "5.3.7",
     "globals": "13.23.0",
-    "jsonschema": "1.4.1",
-    "lodash": "4.17.21",
+    "lodash": "4.17.23",
     "md5.js": "1.3.5",
     "mime-types": "2.1.35",
-    "moo": "0.5.2",
-    "nearley": "2.20.1",
     "packageurl-js": "2.0.1",
     "xmlbuilder2": "3.1.1",
+    "xml-js": "1.6.11",
     "zod": "3.22.4",
-    "@servicenow/eslint-plugin-sdk-app-plugin": "4.1.1",
-    "@servicenow/sdk-repack": "4.1.1",
-    "@servicenow/sdk-build-core": "4.1.1",
-    "@servicenow/sdk-core": "4.1.1"
+    "@servicenow/eslint-plugin-sdk-app-plugin": "4.3.0",
+    "@servicenow/sdk-build-core": "4.3.0",
+    "@servicenow/sdk-repack": "4.3.0",
+    "@servicenow/sdk-core": "4.3.0"
   },
   "overrides": {
     "micromatch": "4.0.7"
   },
   "devDependencies": {
     "@types/eslint": "8.56.0",
-    "@types/lodash": "4.14.195",
+    "@types/lodash": "4.17.23",
     "@types/mime-types": "2.1.4"
   },
   "engines": {

package/src/_types/eslint-plugin-es-x.d.ts

@@ -0,0 +1,17 @@
+declare module 'eslint-plugin-es-x/lib/rules/no-dynamic-import.js' {
+    import type { Rule } from 'eslint'
+    const rule: Rule.RuleModule
+    export default rule
+}
+
+declare module 'eslint-plugin-es-x/lib/rules/no-regexp-lookbehind-assertions.js' {
+    import type { Rule } from 'eslint'
+    const rule: Rule.RuleModule
+    export default rule
+}
+
+declare module 'eslint-plugin-es-x/lib/rules/no-regexp-unicode-property-escapes.js' {
+    import type { Rule } from 'eslint'
+    const rule: Rule.RuleModule
+    export default rule
+}

package/src/_types/md5.js.d.ts

@@ -0,0 +1,8 @@
+declare module 'md5.js' {
+    class MD5 {
+        update(data: string | Buffer): this
+        digest(encoding: 'hex' | 'base64'): string
+        digest(): Buffer
+    }
+    export = MD5
+}

package/src/acl-plugin.ts

@@ -2,7 +2,7 @@ import { CallExpressionShape, isGUID, Plugin, type Record } from '@servicenow/sd
 import { AclTypes, AclOperations, AclAttributes, AclNamedTypes } from '@servicenow/sdk-core/runtime/app'
 import { ModuleFunctionShape } from './server-module-plugin'
 import { NowIdShape } from './now-id-plugin'
-import { generateDeprecatedDiagnostics } from './utils'
+import { createSdkDocEntry, generateDeprecatedDiagnostics } from './utils'
 
 const ExecuteOnlyTypes = new Set([
     'client_callable_flow_object',
@@ -39,6 +39,7 @@ const aclAliases = {
  */
 export const AclPlugin = Plugin.create({
     name: 'AclPlugin',
+    docs: [createSdkDocEntry('Acl', ['sys_security_acl'])],
     records: {
         sys_security_acl: {
             relationships: {
@@ -54,7 +55,7 @@ export const AclPlugin = Plugin.create({
                 },
             },
             toShape(record, { descendants }) {
-                const type = reverseLookup(AclTypes, record.get('type').getValue()) || record.get('type')
+                const type = reverseLookup(AclTypes, record.get('type').getValue() as string) || record.get('type')
                 const roles = descendants.query('sys_security_acl_role').map((m2m) => m2m.get('sys_user_role'))
 
                 return {
@@ -75,14 +76,14 @@ export const AclPlugin = Plugin.create({
                                     appliesTo: $.from('applies_to').def(''),
                                     type: $.val(type),
                                     securityAttribute: $.from('security_attribute')
-                                        .map((v) => reverseLookup(AclAttributes, v.getValue()) || v)
+                                        .map((v) => reverseLookup(AclAttributes, v.getValue() as string) || v)
                                         .def(''),
-                                    operation: $.map((v) => reverseLookup(AclOperations, v.getValue()) || v),
+                                    operation: $.map((v) => reverseLookup(AclOperations, v.getValue() as string) || v),
                                     script: $.map((v) => v.ifString()?.getValue()).def(''),
                                     roles: $.val(roles.length > 0 ? roles : undefined),
                                     [merge]: $.from('type', 'name').map((type, name) =>
                                         getTableOrName(
-                                            type.pipe((t) => reverseLookup(AclTypes, t.getValue())),
+                                            type.pipe((t) => reverseLookup(AclTypes, t.getValue() as string)),
                                             name.asString().getValue()
                                         )
                                     ),
@@ -128,6 +129,18 @@ export const AclPlugin = Plugin.create({
                     diagnostics.error(appliesTo, `ACL cannot set applies_to unless its type is 'record'`)
                 }
 
+                // Check for deprecated table/field properties on ux_route and ux_page ACLs
+                if (type.equals('ux_route') || type.equals('ux_page')) {
+                    const table = arg.get('table')
+                    const field = arg.get('field')
+                    if (!table.isUndefined() || !field.isUndefined()) {
+                        diagnostics.warn(
+                            table.isUndefined() ? field : table,
+                            `The 'table' and 'field' properties are deprecated for '${type.getValue()}' ACLs and will be ignored. Use the 'name' property instead.`
+                        )
+                    }
+                }
+
                 if (operation.equals('add_to_list')) {
                     const condition = arg.get('condition').ifString()
                     if (advanced) {
@@ -159,8 +172,14 @@ export const AclPlugin = Plugin.create({
                         name: $.from('name', 'table', 'field').map(
                             (n, t, f) => n.ifString() ?? (f.ifString() ? `${t.getValue()}.${f.getValue()}` : t)
                         ),
-                        type: $.map((type) => AclTypes[type.asString().getValue()] ?? type),
-                        operation: $.map((op) => AclOperations[op.asString().getValue()] ?? op),
+                        type: $.map((type) => {
+                            const typeKey = type.asString().getValue()
+                            return AclTypes[typeKey as keyof typeof AclTypes] ?? type
+                        }),
+                        operation: $.map((op) => {
+                            const opKey = op.asString().getValue()
+                            return AclOperations[opKey as keyof typeof AclOperations] ?? op
+                        }),
                         advanced: $.val(advanced),
                         script: $.map(
                             (v) =>
@@ -168,7 +187,11 @@ export const AclPlugin = Plugin.create({
                                 v
                         ).toCdata(),
                         security_attribute: $.from('securityAttribute').map(
-                            (v) => v.ifString()?.pipe((v) => AclAttributes[v.getValue()]) ?? v
+                            (v) =>
+                                v.ifString()?.pipe((v) => {
+                                    const attrKey = v.getValue()
+                                    return AclAttributes[attrKey as keyof typeof AclAttributes]
+                                }) ?? v
                         ),
                     })),
                 })
@@ -243,7 +266,7 @@ export const AclPlugin = Plugin.create({
 })
 
 function getTableOrName(type: keyof typeof AclTypes, name: string) {
-    if (AclNamedTypes[type]) {
+    if (type in AclNamedTypes) {
         return { name }
     }
     const split = name.indexOf('.')
@@ -253,7 +276,7 @@ function getTableOrName(type: keyof typeof AclTypes, name: string) {
     return { table, ...(field ? { field } : {}) }
 }
 
-function reverseLookup<T extends object>(obj: T, sysId): keyof T {
+function reverseLookup<T extends object>(obj: T, sysId: string): keyof T {
     return (Object.entries(obj)
         .filter(([_, id]) => id === sysId)
         .map(([key]) => key)[0] || '') as keyof T

package/src/applicability-plugin.ts

@@ -0,0 +1,82 @@
+import { Plugin, CallExpressionShape, type RecordId } from '@servicenow/sdk-build-core'
+import { NowIdShape } from './now-id-plugin'
+
+export const ApplicabilityPlugin = Plugin.create({
+    name: 'ApplicabilityPlugin',
+    records: {
+        // TODO Add relationship support for role_names?
+        sys_ux_applicability: {
+            async toShape(record, { factory }) {
+                const roles = record.get('roles')
+                const roleIds = roles.ifString()?.ifNotEmpty()?.split(',') ?? []
+                const roleRefs: RecordId[] = []
+
+                for (const roleId of roleIds) {
+                    roleRefs.push(
+                        await factory.createReference({
+                            source: record,
+                            table: 'sys_user_role',
+                            guid: roleId,
+                        })
+                    )
+                }
+                return {
+                    success: true,
+                    value: new CallExpressionShape({
+                        source: record,
+                        callee: 'Applicability',
+                        args: [
+                            record.transform(({ $ }) => {
+                                return {
+                                    $id: $.val(NowIdShape.from(record)),
+                                    name: $.def(''),
+                                    description: $.def(''),
+                                    active: $.toBoolean().def(true),
+                                    roles: $.val(roleRefs).def([]),
+                                    roleNames: $.from('role_names').def(''), // TODO Better support of this with references
+                                }
+                            }),
+                        ],
+                    }),
+                }
+            },
+        },
+    },
+    shapes: [
+        {
+            shape: CallExpressionShape,
+            fileTypes: ['fluent'],
+            async toRecord(source, { factory }) {
+                if (source.getCallee() !== 'Applicability') {
+                    return { success: false }
+                }
+
+                const arg = source.getArgument(0).asObject()
+                const applicability = await factory.createRecord({
+                    source: source,
+                    table: 'sys_ux_applicability',
+                    explicitId: arg.get('$id'),
+                    properties: arg.transform(({ $ }) => ({
+                        name: $,
+                        description: $.def(''),
+                        active: $.toBoolean().def(true),
+                        roles: $.def([]).map((v) =>
+                            v
+                                .ifArray()
+                                ?.pipe((r) =>
+                                    Array.from(
+                                        new Set(
+                                            r.getElements().map((r) => r.ifRecord()?.getId().getValue() ?? r.getValue())
+                                        )
+                                    ).join(',')
+                                )
+                        ),
+                        role_names: $.from('roleNames').def(''), // TODO Better support of this with references
+                    })),
+                })
+
+                return { success: true, value: applicability }
+            },
+        },
+    ],
+})

package/src/application-menu-plugin.ts

@@ -51,6 +51,7 @@ export const ApplicationMenuPlugin = Plugin.create({
                     value: new CallExpressionShape({
                         source: record,
                         callee: 'ApplicationMenu',
+                        exportName: record.get('sys_name')?.ifString()?.getValue(),
                         args: [
                             record.transform(({ $ }) => ({
                                 $id: $.val(NowIdShape.from(record)),

package/src/atf/step-configs.ts

@@ -5,28 +5,30 @@ export type ATFVariableInfo = {
     inputVariableId: string
     type: string
     order: number
-    default?: any
+    default?: unknown
     mandatory?: boolean
 }
 
 export type Category = keyof ATFType
 
-type FunctionParameters<F> = F extends (inputs: infer P) => any
+type FunctionParameters<F> = F extends (inputs: infer P) => unknown
     ? P extends object
         ? Exclude<keyof P, keyof StandardStepValues>
         : never
     : never
 
-type ToRecordStepMetadata = {
+export type StepMetadata<T extends FunctionParameters<unknown> = FunctionParameters<unknown>> = {
+    name: string
+    stepConfigId: string
+    variables: {
+        [K in T]: ATFVariableInfo
+    }
+    defaultTimeout?: string
+}
+
+export type ToRecordStepMetadata = {
     [C in keyof ATFType]: {
-        [FunctionName in keyof ATFType[C]]: {
-            name: string
-            stepConfigId: string
-            variables: {
-                [K in FunctionParameters<ATFType[C][FunctionName]>]: ATFVariableInfo
-            }
-            defaultTimeout?: string
-        }
+        [FunctionName in keyof ATFType[C]]: StepMetadata<FunctionParameters<ATFType[C][FunctionName]>>
     }
 }
 
@@ -2355,7 +2357,7 @@ export type ToShapeStepMetadata = Record<
                 field: string
                 type: string
                 mandatory: boolean
-                default?: any
+                default?: unknown
             }
         >
     }

package/src/atf/test-plugin.ts

@@ -1,5 +1,6 @@
 import {
     CallExpressionShape,
+    deleteMultipleDiff,
     type Diagnostics,
     IdentifierShape,
     ObjectShape,
@@ -20,9 +21,15 @@ import { NowIdShape } from '../now-id-plugin'
 import { ArrowFunctionShape } from '../arrow-function-plugin'
 import { create } from 'xmlbuilder2'
 import { Test } from '@servicenow/sdk-core/runtime/app'
-import { type ATFVariableInfo, type Category, ToShapeStepConfigs, ToRecordStepConfigs } from './step-configs'
+import {
+    type ATFVariableInfo,
+    type Category,
+    ToShapeStepConfigs,
+    ToRecordStepConfigs,
+    type StepMetadata,
+} from './step-configs'
 import { durationFieldToXML, formatDateToPlatformFormat, parseGlideDuration } from '@servicenow/sdk-build-core'
-import type { TimeDuration } from '@servicenow/sdk/core'
+import type { Duration } from '@servicenow/sdk/core'
 
 export const TestPlugin = Plugin.create({
     name: 'TestPlugin',
@@ -125,7 +132,7 @@ export const TestPlugin = Plugin.create({
                                     notes: $.def(''),
                                     warning: $.from('warning_message').def(''),
                                     timeout: $.val(timeout),
-                                    [merge]: $.val(variables),
+                                    [merge]: $.val(variables).def({}),
                                 })),
                             }),
                         ],
@@ -166,6 +173,9 @@ export const TestPlugin = Plugin.create({
                     }),
                 }
             },
+            async diff(existing, incoming, descendants, context) {
+                return deleteMultipleDiff(existing, incoming, descendants, context)
+            },
         },
         sys_variable_value: {
             coalesce: ['document', 'document_key', 'variable'],
@@ -369,7 +379,6 @@ const UNSUPPORTED_STEP_CONFIGS = {
     a69843f2531332007e7829cac2dc34d7: 'Apply Filter to List',
     c5f44934532332007e7829cac2dc342e: 'Click a List UI Action',
 }
-
 function getFieldValuesFromElementMappingRecords(elementMappingRecords: RecordShape[]) {
     return elementMappingRecords
         .filter((em) => em.get('value').getValue())
@@ -381,7 +390,7 @@ function getFieldValuesFromElementMappingRecords(elementMappingRecords: RecordSh
 }
 
 function convertTimeoutToSystemFormat(timeoutShape: Shape) {
-    const timeoutDuration = timeoutShape.ifObject()?.getValue() as TimeDuration | undefined
+    const timeoutDuration = timeoutShape.ifObject()?.getValue() as Duration | undefined
     const timeoutDate = timeoutDuration && durationFieldToXML(timeoutDuration)
     return timeoutDate && formatDateToPlatformFormat(timeoutDate)
 }
@@ -389,8 +398,9 @@ function convertTimeoutToSystemFormat(timeoutShape: Shape) {
 function anyStepsAreUnknown(stepRecords: RecordShape[], testName: string) {
     return stepRecords.some((stepRecord) => {
         const stepConfigId = stepRecord.get('step_config').toString().getValue()
-        if (!ToShapeStepConfigs[stepConfigId]) {
-            const stepConfigName = UNSUPPORTED_STEP_CONFIGS[stepConfigId] ?? stepConfigId
+        if (!ToShapeStepConfigs[stepConfigId as keyof typeof ToShapeStepConfigs]) {
+            const stepConfigName =
+                UNSUPPORTED_STEP_CONFIGS[stepConfigId as keyof typeof UNSUPPORTED_STEP_CONFIGS] ?? stepConfigId
             console.error(
                 `Unable to transform ATF test '${testName}' because of unsupported step_config: '${stepConfigName}'`
             )
@@ -436,7 +446,11 @@ function propertyAccessToGemExpression(
     return `{{step['${stepId}']${suffix}}}`
 }
 
-function createGemExpressionsFromShape(shape: Shape, stepRecords: RecordShape[], diagnostics: Diagnostics) {
+function createGemExpressionsFromShape(
+    shape: Shape,
+    stepRecords: RecordShape[],
+    diagnostics: Diagnostics
+): string | Record<string, unknown> | undefined {
     if (shape instanceof PropertyAccessShape) {
         return propertyAccessToGemExpression(shape, stepRecords, diagnostics)
     }
@@ -452,7 +466,7 @@ function createGemExpressionsFromShape(shape: Shape, stepRecords: RecordShape[],
     }
 
     if (shape instanceof ObjectShape) {
-        const obj = {}
+        const obj: Record<string, unknown> = {}
         let gemExpressionFound = false
         for (const key in shape.properties()) {
             const value = createGemExpressionsFromShape(shape.get(key, false), stepRecords, diagnostics)
@@ -499,23 +513,26 @@ function getStepInfoFromAtfCallExpression(
         return undefined
     }
 
-    const [, category, funcName] = callExpression.getCallee().split('.')
+    const [, category, funcName] = callExpression.getCallee().split('.') as [never, Category?, string?]
+
     if (!category || !funcName) {
         diagnostics.info(callExpression, 'Invalid ATF step')
         return undefined
     }
 
-    if (!ToRecordStepConfigs[category]) {
+    const categoryKey = category
+    if (!ToRecordStepConfigs[categoryKey]) {
         diagnostics.warn(callExpression, `Unknown category: ${category}`)
         return undefined
     }
 
-    if (!ToRecordStepConfigs[category][funcName]) {
+    const categorySteps = ToRecordStepConfigs[categoryKey]
+    if (!(funcName in categorySteps)) {
         diagnostics.warn(callExpression, `Unknown step: ${funcName}`)
         return undefined
     }
 
-    const stepConfig = ToRecordStepConfigs[category as Category][funcName]!
+    const stepConfig = categorySteps[funcName as keyof typeof categorySteps] as StepMetadata
     const values = callExpression.getArgument(0).asObject()
     return {
         displayName: stepConfig.name,
@@ -524,7 +541,7 @@ function getStepInfoFromAtfCallExpression(
         table: values.get('table')?.ifString(),
         source: callExpression,
         identifier,
-        defaultTimeout: stepConfig.defaultTimeout,
+        defaultTimeout: stepConfig.defaultTimeout as string,
         values,
     }
 }
@@ -566,14 +583,19 @@ function variableElementPathToPropertyAccess(source: Source, propertyAccessPath:
     })
 }
 
-function getElementMappingValues(source: Source, value: any, stepIdToVarName: Map<string, string>) {
+function getElementMappingValues(
+    source: Source,
+    value: unknown,
+    stepIdToVarName: Map<string, string>
+): object | object[] | string | undefined {
     if (typeof value === 'object' && value !== null) {
         if (Array.isArray(value)) {
             return value.map((v) => getElementMappingValues(source, v, stepIdToVarName))
         } else {
-            const obj = {}
-            for (const key in value) {
-                obj[key] = getElementMappingValues(source, value[key], stepIdToVarName)
+            const obj: Record<string, unknown> = {}
+            const valueObj = value
+            for (const key in valueObj) {
+                obj[key] = getElementMappingValues(source, valueObj[key as keyof typeof valueObj], stepIdToVarName)
             }
             return obj
         }
@@ -581,13 +603,13 @@ function getElementMappingValues(source: Source, value: any, stepIdToVarName: Ma
 
     const potentialGemExpression = typeof value === 'string' ? value : undefined
     if (!potentialGemExpression) {
-        return value
+        return value as string
     }
 
     const [matched] = Array.from(potentialGemExpression.matchAll(GemRegex))
     const simpleGemExpression = matched && matched[0] === potentialGemExpression
     if (!matched) {
-        return value
+        return value as string
     }
 
     // If the GEM expression is simple, it only contains the GEM
@@ -643,7 +665,7 @@ function getElementMappingValues(source: Source, value: any, stepIdToVarName: Ma
     })
 }
 
-function objectToEncodedQuery(objectShape: Record<string, any>) {
+function objectToEncodedQuery(objectShape: Record<string, object | string | number | boolean>) {
     return Object.entries(objectShape)
         .map(([key, value]) => {
             const escapedValue = value.toString().replaceAll('^', '^^')
@@ -653,7 +675,7 @@ function objectToEncodedQuery(objectShape: Record<string, any>) {
         .join('^')
 }
 
-export function serializeValueToRecord(value: any, type: string, defaultValue: any) {
+export function serializeValueToRecord(value: unknown, type: string, defaultValue: unknown) {
     value = value === undefined ? defaultValue : value
 
     switch (type) {
@@ -670,7 +692,7 @@ export function serializeValueToRecord(value: any, type: string, defaultValue: a
             return JSON.stringify(value)
         }
         case 'template_value':
-            return value && objectToEncodedQuery(value)
+            return value && objectToEncodedQuery(value as Record<string, object | string | number | boolean>)
         case 'boolean':
             return value ? 1 : 0
         default:
@@ -706,7 +728,7 @@ function queryToFieldValues(query: string) {
         .split('^')
         .filter((term) => term !== 'EQ')
         .map((term) => term.split('='))
-        .filter(([, value]) => value !== undefined)
+        .filter(([, value]) => value !== undefined && value !== '')
         .map(([key, value]) => ({ [key as string]: convertToPrimitiveValue(value!.replaceAll(caratReplacement, '^')) }))
         .reduce((acc, obj) => ({ ...acc, ...obj }), {})
 }