@servicenow/sdk-build-plugins 2.1.4 → 2.2.2

package/src/scriptedRESTAPI/RESTDeserializationUtils.ts

@@ -11,9 +11,8 @@ import {
     ArrayIterator,
 } from '@servicenow/sdk-build-core'
 import { RouteSchema, RestApiSchema } from '@servicenow/sdk-core/runtime/rest'
-import * as ts from 'ts-morph'
+import { ts } from '@servicenow/sdk-project'
 import * as z from 'zod'
-import { SyntaxKind } from 'ts-morph'
 import { processScript } from '../ScriptTemplatePlugin'
 import {
     RestDefinitionTransformer,
@@ -76,7 +75,7 @@ function transformEnforceAcl(args: ts.ObjectLiteralExpression, enforce_acl: stri
     while (enforceAclIterator.hasNext()) {
         const aclElement = enforceAclIterator.next()
         let aclSysId: string | undefined = undefined
-        if (aclElement.isKind(SyntaxKind.StringLiteral)) {
+        if (aclElement.isKind(ts.SyntaxKind.StringLiteral)) {
             aclSysId = aclElement.getLiteralValue()
         } else {
             const varDec = (aclElement.getSymbol()?.getValueDeclaration() ??
@@ -84,7 +83,7 @@ function transformEnforceAcl(args: ts.ObjectLiteralExpression, enforce_acl: stri
             if (varDec) {
                 const nodeID = getNodeId(
                     varDec
-                        .getInitializerIfKind(SyntaxKind.CallExpression)
+                        .getInitializerIfKind(ts.SyntaxKind.CallExpression)
                         ?.getArguments()[0] as ts.ObjectLiteralExpression
                 )!
                 aclSysId = context.keys.explicit[nodeID]?.id
@@ -120,13 +119,13 @@ export function transformRestAttrs(document: Document, context: Context) {
     let isHandled = false
     while (versionArrayIterator.hasNext() && !isHandled) {
         const element = versionArrayIterator.next()
-        const verId = getNodeId(element.asKindOrThrow(SyntaxKind.ObjectLiteralExpression))!
+        const verId = getNodeId(element.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression))!
         const verSysId = context.keys.explicit[verId]?.id
         if (verSysId === document.guid) {
             if (document.action === 'DELETE') {
                 expression.removeElement(element)
             } else {
-                const eleObj = element.asKindOrThrow(SyntaxKind.ObjectLiteralExpression)
+                const eleObj = element.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression)
                 cleanUpDefault(VersionWithOutIdSchema, cData, eleObj)
                 mergeDataIntoObjectLiteral(eleObj, cData)
             }
@@ -135,7 +134,7 @@ export function transformRestAttrs(document: Document, context: Context) {
     }
     if (!isHandled && document.action !== 'DELETE') {
         cleanUpDefault(VersionWithOutIdSchema, cData)
-        const element = expression.addElement(stringify(cData)).asKindOrThrow(SyntaxKind.ObjectLiteralExpression)
+        const element = expression.addElement(stringify(cData)).asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression)
         transformId(element, '$id', document.guid, 'sys_ws_version', context)
         return true
     }
@@ -155,7 +154,7 @@ export function transformRouteAttrs(document: Document, context: Context, argNam
     while (routeArrayIterator.hasNext()) {
         const element = routeArrayIterator.next()
         const routeAttrsNode = getOrCreatePropertyAssignment(
-            element.asKindOrThrow(SyntaxKind.ObjectLiteralExpression),
+            element.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression),
             argName,
             '[]'
         )
@@ -163,13 +162,13 @@ export function transformRouteAttrs(document: Document, context: Context, argNam
         const arrayExpression = routeAttrIterator.getExpression()
         while (routeAttrIterator.hasNext()) {
             const attrElement = routeAttrIterator.next()
-            const attrId = getNodeId(attrElement.asKindOrThrow(SyntaxKind.ObjectLiteralExpression))
+            const attrId = getNodeId(attrElement.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression))
             const attrSysId = context.keys.explicit[attrId!]?.id
             if (attrSysId === document.guid) {
                 if (document.action === 'DELETE') {
                     arrayExpression.removeElement(attrElement)
                 } else {
-                    const attrEleObj = attrElement.asKindOrThrow(SyntaxKind.ObjectLiteralExpression)
+                    const attrEleObj = attrElement.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression)
                     cleanUpDefault(RouteAttrWithOutIdSchema, routeAttrData, attrEleObj)
                     mergeDataIntoObjectLiteral(attrEleObj, routeAttrData)
                 }
@@ -197,7 +196,7 @@ function getDefaults<Schema extends z.AnyZodObject>(schema: Schema) {
     )
 }
 
-export function cleanUpDefault<Schema extends z.AnyZodObject>(
+function cleanUpDefault<Schema extends z.AnyZodObject>(
     schema: Schema,
     targetObj: any,
     node?: ts.ObjectLiteralExpression
@@ -235,13 +234,13 @@ export function transformRoutes(document: Document, context: Context, documentMa
     let isHandled = false
     while (routeArrayIterator.hasNext() && !isHandled) {
         const element = routeArrayIterator.next()
-        const routeId = getNodeId(element.asKindOrThrow(SyntaxKind.ObjectLiteralExpression))!
+        const routeId = getNodeId(element.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression))!
         const routeSysId = context.keys.explicit[routeId]?.id
         if (routeSysId === document.guid) {
             if (document.action === 'DELETE') {
                 expression.removeElement(element)
             } else {
-                const eleObj = element.asKindOrThrow(SyntaxKind.ObjectLiteralExpression)
+                const eleObj = element.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression)
                 transformEnforceAcl(eleObj, enforce_acl, context)
                 if (script !== undefined) {
                     processScript(eleObj, 'script', script)
@@ -257,7 +256,7 @@ export function transformRoutes(document: Document, context: Context, documentMa
         cleanUpDefault(RouteSchema, parsedRouteData)
         const element = expression
             .addElement(stringify(parsedRouteData))
-            .asKindOrThrow(SyntaxKind.ObjectLiteralExpression)
+            .asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression)
         transformEnforceAcl(element, enforce_acl, context)
         if (script !== undefined) {
             processScript(element, 'script', script)
@@ -330,11 +329,11 @@ export function transformRouteAttrsMap<T>(
     const routeArrayIterator = new ArrayIterator(routesArrayNode)
     while (routeArrayIterator.hasNext()) {
         const element = routeArrayIterator.next()
-        const routeId = getNodeId(element.asKindOrThrow(SyntaxKind.ObjectLiteralExpression))!
+        const routeId = getNodeId(element.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression))!
         const routeSysId = context.keys.explicit[routeId]?.id
         if (routeSysId === operationId || (removalKey && removalKey.route === routeId)) {
             const routeAttrsNode = getOrCreatePropertyAssignment(
-                element.asKindOrThrow(SyntaxKind.ObjectLiteralExpression),
+                element.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression),
                 argName,
                 '[]'
             )
@@ -343,7 +342,7 @@ export function transformRouteAttrsMap<T>(
             let isHandled = false
             while (routeAttrIterator.hasNext()) {
                 const attrElement = routeAttrIterator.next()
-                const attrNodeId = getNodeId(attrElement.asKindOrThrow(SyntaxKind.ObjectLiteralExpression))
+                const attrNodeId = getNodeId(attrElement.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression))
                 const attrMapId = context.keys.composite.find((k) =>
                     isEqual(k.key, {
                         attr: attrNodeId!,
@@ -360,7 +359,7 @@ export function transformRouteAttrsMap<T>(
                         deletedParamID = attrId
                         attrExpression.removeElement(attrElement)
                     } else {
-                        const attrEleObj = attrElement.asKindOrThrow(SyntaxKind.ObjectLiteralExpression)
+                        const attrEleObj = attrElement.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression)
                         cleanUpDefault(RouteAttrWithOutIdSchema, parsedAttrData, attrEleObj)
                         mergeDataIntoObjectLiteral(attrEleObj, parsedAttrData)
                     }
@@ -371,7 +370,7 @@ export function transformRouteAttrsMap<T>(
                 cleanUpDefault(RouteAttrWithOutIdSchema, parsedAttrData)
                 const element = attrExpression
                     .addElement(stringify({}))
-                    .asKindOrThrow(SyntaxKind.ObjectLiteralExpression)
+                    .asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression)
                 mergeDataIntoObjectLiteral(element, parsedAttrData)
                 const table = argName === 'headers' ? 'sys_ws_header' : 'sys_ws_query_parameter'
                 const foundAttrId = context.keys.findExplicitKeyById(attrId)

package/src/scriptedRESTAPI/RESTSerializationUtils.ts

@@ -52,7 +52,7 @@ export function generateVersionRecords(
     }
 }
 
-export function generateRouteAttributesRecords<T extends TableName, M extends TableName>(
+function generateRouteAttributesRecords<T extends TableName, M extends TableName>(
     context: Context,
     restId: string | number,
     routeId: string | number,

package/src/scriptedRESTAPI/RestApiPlugin.ts

@@ -22,7 +22,6 @@ import {
     generateVersionRecords,
     generateRoutesAndRouteAttrRecords,
 } from './RESTSerializationUtils'
-import * as ts from 'ts-morph'
 import {
     transformDefinition,
     transformRestAttrs,
@@ -47,7 +46,7 @@ import {
     potentialRecordCallRouteParams,
 } from './RestUtils'
 import * as z from 'zod'
-import { Diagnostic } from '@servicenow/sdk-project'
+import { Diagnostic, ts, tsc } from '@servicenow/sdk-project'
 import { ModuleFunctionData } from '../ServerModulePlugin'
 
 const methodsAllowedToOverrideRequests = ['PUT', 'PATCH', 'POST']
@@ -118,11 +117,11 @@ export default Plugin({
                         context.registerExplicitId('sys_ws_definition', restApi.$id as string)
                     )
 
-                    if (!result.handled || !(0 in result.data)) {
+                    if (!result.handled || !result.data) {
                         return result
                     }
 
-                    const restApiEntity = result.data[0]
+                    const restApiEntity = result.data
                     const entityData = RestApiSchema.parse(restApiEntity.getValue())
                     const { routes, enforce_acl, consumes, produces } = entityData
                     const routesData = restApiEntity.getProperty('routes', 'array')?.getElements() ?? []
@@ -160,20 +159,18 @@ export default Plugin({
                     return {
                         handled: true,
                         diagnostics: result.diagnostics,
-                        data: [
-                            new EntityData(
-                                restApiEntity.getKind(),
-                                restApiEntity.getGuid(),
-                                ObjectData.fromObjectValue(
-                                    {
-                                        ...entityData,
-                                        enforce_acl: parseAcls(enforce_acl, context),
-                                    },
-                                    restApiEntity.getNode()
-                                ),
+                        data: new EntityData(
+                            restApiEntity.getKind(),
+                            restApiEntity.getGuid(),
+                            ObjectData.fromObjectValue(
+                                {
+                                    ...entityData,
+                                    enforce_acl: parseAcls(enforce_acl, context),
+                                },
                                 restApiEntity.getNode()
                             ),
-                        ],
+                            restApiEntity.getNode()
+                        ),
                     }
                 },
             },
@@ -366,7 +363,7 @@ export default Plugin({
                     if (!o_v_node) {
                         return undefined
                     }
-                    return linkDocument(document, o_v_node as ts.CallExpression<ts.ts.CallExpression>)
+                    return linkDocument(document, o_v_node as ts.CallExpression<tsc.CallExpression>)
                 case 'sys_ws_header_map':
                 case 'sys_ws_query_parameter_map':
                     // eslint-disable-next-line no-case-declarations
@@ -380,7 +377,7 @@ export default Plugin({
                     if (!h_q_node) {
                         return undefined
                     }
-                    return linkDocument(document, h_q_node as ts.CallExpression<ts.ts.CallExpression>)
+                    return linkDocument(document, h_q_node as ts.CallExpression<tsc.CallExpression>)
             }
             return undefined
         },

package/src/scriptedRESTAPI/RestUtils.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-case-declarations */
-import * as ts from 'ts-morph'
+import { ts, tsc } from '@servicenow/sdk-project'
 import {
     Context,
     Document,
@@ -72,7 +72,7 @@ export const getArgs = (document: Document) => {
  * utility function that iterates over all the headers or parameters of all routes
  * inside a rest api and calls the provided callback function.
  */
-export function iterateAllRouteAttrNode(
+function iterateAllRouteAttrNode(
     document: Document,
     eleAttrName: string,
     callback: (
@@ -85,16 +85,16 @@ export function iterateAllRouteAttrNode(
     const restId = getNodeId(argsNode)!
     argsNode
         .getProperty('routes')
-        ?.asKind(ts.ts.SyntaxKind.PropertyAssignment)
-        ?.getInitializerIfKindOrThrow(ts.ts.SyntaxKind.ArrayLiteralExpression)
+        ?.asKind(tsc.SyntaxKind.PropertyAssignment)
+        ?.getInitializerIfKindOrThrow(tsc.SyntaxKind.ArrayLiteralExpression)
         ?.getElements()
         .forEach((element) => {
             const routeId = getNodeId(element.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression))!
             const arrayExpression = element
-                .asKind(ts.ts.SyntaxKind.ObjectLiteralExpression)
+                .asKind(tsc.SyntaxKind.ObjectLiteralExpression)
                 ?.getProperty(eleAttrName)
-                ?.asKind(ts.ts.SyntaxKind.PropertyAssignment)
-                ?.getInitializerIfKindOrThrow(ts.ts.SyntaxKind.ArrayLiteralExpression)
+                ?.asKind(tsc.SyntaxKind.PropertyAssignment)
+                ?.getInitializerIfKindOrThrow(tsc.SyntaxKind.ArrayLiteralExpression)
 
             arrayExpression?.getElements().forEach((element) => {
                 const attrId = getNodeId(element.asKindOrThrow(ts.SyntaxKind.ObjectLiteralExpression))!

package/src/scripts/ClientScriptPlugin.ts

@@ -19,7 +19,7 @@ import {
 import { Record } from '@servicenow/sdk-core/runtime/db'
 import { ClientScriptSchema } from '@servicenow/sdk-core/runtime/clientscript'
 import { z } from 'zod'
-import * as ts from 'ts-morph'
+import { ts } from '@servicenow/sdk-project'
 import { processScript } from '../ScriptTemplatePlugin'
 import { Diagnostic } from '@servicenow/sdk-project'
 import { except } from './scriptUtils'
@@ -52,11 +52,11 @@ export default Plugin({
                         context.registerExplicitId('sys_script_client', script.$id as string)
                     )
 
-                    if (!result.handled || !(0 in result.data)) {
+                    if (!result.handled || !result.data) {
                         return result
                     }
 
-                    const clientScriptEntityData = result.data[0]
+                    const clientScriptEntityData = result.data
                     const args = node.getArguments()[0] as ts.ObjectLiteralExpression
 
                     if (!args) {
@@ -104,14 +104,12 @@ export default Plugin({
                     return {
                         handled: true,
                         diagnostics,
-                        data: [
-                            new EntityData(
-                                'record',
-                                clientScriptEntityData.getGuid(),
-                                ObjectData.fromObjectValue(record, node),
-                                node
-                            ),
-                        ],
+                        data: new EntityData(
+                            'record',
+                            clientScriptEntityData.getGuid(),
+                            ObjectData.fromObjectValue(record, node),
+                            node
+                        ),
                     }
                 },
             },
@@ -241,7 +239,7 @@ function getUITypeId(value: string) {
     throw Error('Invalid ui_type found in xml')
 }
 
-export function isRequire(callExpression: ts.CallExpression): boolean {
+function isRequire(callExpression: ts.CallExpression): boolean {
     const expression = callExpression.getExpression()
     return ts.Node.isIdentifier(expression) && expression.getText() === 'require'
 }

package/src/uxf/RoutesPlugin.ts

@@ -1,6 +1,5 @@
 import { BaseUXRouteSchema, ExperienceSchema, Routes } from '@servicenow/sdk-core/runtime/experience'
 import { Record } from '@servicenow/sdk-core/runtime/db'
-import { SdkError } from '@servicenow/sdk-metrics'
 import { Plugin, extractCallExpression } from '@servicenow/sdk-build-core'
 import { parser as uxValueParser, cleanUxValue } from './UxfFormulaParser'
 import { idGenerator } from './tectonicIdGenerator'
@@ -21,7 +20,7 @@ type RouteParts = {
 function getRouteParts(route: string): RouteParts {
     const chunks = route.split('/').filter((chunk) => chunk && chunk.length > 0)
     if (chunks.length === 0) {
-        throw new SdkError('Invalid route - routes may not be empty', { type: 'plugin_error' })
+        throw new Error('Invalid route - routes may not be empty')
     }
 
     const parts: RouteParts = {
@@ -66,7 +65,7 @@ const createComposition = (component: Component) => {
     const propertyValues = Object.keys(properties).reduce((newObj, key) => {
         const parseResult = UxfFormulaParser.parse(properties[key])
         if (parseResult.errors.length) {
-            throw new SdkError('Failed to parse formula.', { type: 'plugin_error' })
+            throw new Error('Failed to parse formula.')
         }
         newObj[key] = cleanUxValue(parseResult.result.uxValue)
         return newObj

package/src/uxf/tectonicIdGenerator.ts

@@ -10,18 +10,15 @@
  *  STRY56098244
  */
 
-import * as crypto from 'crypto'
+import md5 from 'md5.js'
 import { join } from 'lodash'
 
-const HASH_ALGORITHM = 'md5'
-const HASH_DIGEST = 'hex'
 const HASH_SEPARATOR = ':'
 const ID_PREFIX = 'tectonic-mvp'
 
 const hash = (parts: string[]) => {
-    const hash = crypto.createHash(HASH_ALGORITHM)
-    hash.update(join(parts, HASH_SEPARATOR))
-    return hash.digest(HASH_DIGEST)
+    const hash = new md5().update(join(parts, HASH_SEPARATOR))
+    return hash.digest('hex')
 }
 
 const componentAliasTable = {