@servicenow/sdk-build-plugins 3.0.3 → 4.0.1

package/src/aclAndRole/Util.ts

@@ -1,113 +0,0 @@
-import { isEqual } from 'lodash'
-import { ts, tsc } from '@servicenow/sdk-project'
-import {
-    Document,
-    Context,
-    getNodeId,
-    getOrCreatePropertyAssignment,
-    ArrayIterator,
-    stringify,
-    Data,
-    isGUID,
-} from '@servicenow/sdk-build-core'
-
-const getElementKey = (element: ts.Expression, context: Context): string => {
-    const result = context.extractAst(element)
-    if (result.handled && result.data) {
-        const data = result.data
-        if (Data.isString(data)) {
-            return data.getValue()
-        }
-        if (Data.isEntity(data) && data.getKind() === 'role') {
-            return data.getProperty('$id') ? `${data.getProperty('$id').getValue()}` : ''
-        }
-    }
-    return ''
-}
-
-export function addObjectToArrayById(document: Document, name: string, roleId: string, context: Context) {
-    const arg = document.node?.asKind(ts.SyntaxKind.CallExpression)?.getArguments()[0] as ts.ObjectLiteralExpression
-    const table = document.data!['table']
-    const primaryKey = getNodeId(arg)
-    const propertyAssignment = getOrCreatePropertyAssignment(arg, name, '[]')
-
-    let handled = false
-    const rolesIterator = new ArrayIterator(propertyAssignment)
-    const primaryKeyName = table === 'sys_security_acl_role' ? 'sys_security_acl' : 'role'
-    const secondaryKeyName = table === 'sys_security_acl_role' ? 'sys_user_role' : 'contains'
-
-    while (rolesIterator.hasNext()) {
-        const element = rolesIterator.next()
-        const secondaryKey = getElementKey(element, context)
-        const secondaryKeySysId =
-            secondaryKey && isGUID(secondaryKey) ? secondaryKey : context.getIdUsingExplicitKey(secondaryKey) || ''
-        if (secondaryKeySysId === roleId) {
-            return
-        }
-
-        const foundIdx = context.keys.composite.findIndex((k) =>
-            isEqual(k.key, {
-                [primaryKeyName]: primaryKey,
-                [secondaryKeyName]: secondaryKey,
-            })
-        )
-        if (foundIdx !== -1 && context.keys.composite[foundIdx]?.id == document.guid) {
-            if (context.keys.explicit[secondaryKey]?.id === roleId || secondaryKey === roleId) {
-                return
-            }
-            element?.replaceWithText(stringify(roleId))
-            context.keys.composite.splice(foundIdx, 1)
-            handled = true
-        }
-    }
-
-    if (!handled) {
-        const stringValue = stringify(roleId)
-        rolesIterator.getExpression().addElement(stringValue)
-    }
-    context.keys.registerCompositeId(
-        table,
-        {
-            [primaryKeyName]: primaryKey!,
-            [secondaryKeyName]: roleId,
-        },
-        document.guid
-    )
-}
-
-export function removeObjectFromArrayById(document: Document, name: string, context: Context) {
-    const arg = document.node?.asKind(ts.SyntaxKind.CallExpression)?.getArguments()[0] as ts.ObjectLiteralExpression
-    const table = document.data!['table']
-    const argId = getNodeId(arg)
-    const property = arg.getProperty(name)
-    if (!property) {
-        return
-    }
-
-    const propertyAssignment = property.asKind(tsc.SyntaxKind.PropertyAssignment)
-    if (!propertyAssignment) {
-        return
-    }
-
-    const rolesIterator = new ArrayIterator(propertyAssignment)
-    while (rolesIterator.hasNext()) {
-        const element = rolesIterator.next()
-        const secKey = getElementKey(element, context)
-        const primaryKey = table === 'sys_security_acl_role' ? 'sys_security_acl' : 'role'
-        const secondKey = table === 'sys_security_acl_role' ? 'sys_user_role' : 'contains'
-        const foundIdx = context.keys.composite.findIndex((k) =>
-            isEqual(k.key, {
-                [primaryKey]: argId,
-                [secondKey]: secKey,
-            })
-        )
-        if (foundIdx !== -1 && context.keys.composite[foundIdx]?.id === document.guid) {
-            rolesIterator.getExpression().removeElement(element)
-        }
-
-        if (!element.wasForgotten() && element.asKind(ts.SyntaxKind.Identifier) && !element.getSymbol()) {
-            //remove if the identifier doesn't have symbol, happens when the identifier declaration is removed prior to this
-            rolesIterator.getExpression().removeElement(element)
-        }
-    }
-}

package/src/app/ApplicationMenuPlugin.ts

@@ -1,165 +0,0 @@
-import { z } from 'zod'
-import { ApplicationMenu, ApplicationMenuSchema, getRolesArray } from '@servicenow/sdk-core/runtime/app'
-import {
-    Plugin,
-    extractCallExpression,
-    generateCallExpressionExportForDocument,
-    getSysUpdateName,
-    getCallExpressionName,
-    getOrCreateEntitySourceFile,
-    linkDocument,
-    removeNode,
-    transformFunctionArguments,
-    writeArrayPropertyAsReference,
-    EntityData,
-    ObjectData,
-    transformCustomizedProperties,
-} from '@servicenow/sdk-build-core'
-import { RecordPlugin } from '../db/RecordPlugin'
-import { Record } from '@servicenow/sdk-core/runtime/db'
-import { Diagnostic, ts } from '@servicenow/sdk-project'
-import { getRolesString } from '../aclAndRole/RolePlugin'
-
-type AppMenuDocumentSchema = z.output<typeof AppMenuDocumentSchema>
-
-const AppMenuDocumentSchema = z.object({
-    table: z.literal('sys_app_application'),
-    data: ApplicationMenuSchema.omit({ roles: true, category: true, $id: true }).extend({
-        roles: z.string().optional(),
-        category: z.coerce.string().optional(),
-        device_type: z.coerce.string().optional(),
-        view_name: z.coerce.string().optional(),
-    }),
-})
-
-const AppMenuDocumentTransformer = AppMenuDocumentSchema.transform(
-    ({ data: data }): Partial<typeof ApplicationMenuSchema> => {
-        const { roles, category, device_type, view_name, ...rest } = data
-
-        return {
-            ...rest,
-        }
-    }
-)
-
-export default Plugin({
-    name: 'ApplicationMenu',
-    ownedTables: {
-        sys_app_application: { diagnosticLevel: Diagnostic.Level.Warn },
-    },
-    extractors: {
-        entity: {
-            fluent: {
-                CallExpression: (node, context) =>
-                    extractCallExpression(ApplicationMenu, 'appMenu', node, context, (menu) =>
-                        context.registerExplicitId('sys_app_application', menu.$id as string)
-                    ),
-            },
-        },
-    },
-    composers: {
-        entity: {
-            appMenu(entity, context) {
-                const appMenuData = ApplicationMenuSchema.and(z.any()).safeParse(entity.getValue())
-                if (!appMenuData.success) {
-                    return Promise.resolve(undefined)
-                }
-                const { $id, category, ...props } = appMenuData.data
-                const roles = entity.getProperty('roles', 'array')
-                const rolesString = roles ? getRolesString(roles) : ''
-
-                const recordEntity = Record({
-                    $id,
-                    table: 'sys_app_application',
-                    data: {
-                        ...props,
-                        roles: rolesString,
-                        category: (category as string) ?? '',
-                        device_type: 'browser',
-                        view_name: '',
-                    },
-                })
-                return context.composeEntities(
-                    [
-                        new EntityData(
-                            'record',
-                            entity.getGuid(),
-                            ObjectData.fromObjectValue(recordEntity, entity.getNode()),
-                            entity.getNode(),
-                            entity.getInstallMethod()
-                        ),
-                    ],
-                    [RecordPlugin]
-                )
-            },
-        },
-    },
-
-    generators: {
-        record(document, context) {
-            const tableName = document.data!['table']
-            if (tableName !== 'sys_app_application') {
-                return undefined
-            }
-            return linkDocument(
-                document,
-                generateCallExpressionExportForDocument(
-                    context,
-                    {
-                        sourceFile: getOrCreateEntitySourceFile(
-                            context,
-                            getSysUpdateName(document, 'sys_app_application')
-                        ),
-                        moduleSpecifier: '@servicenow/sdk/core',
-                    },
-                    ApplicationMenu,
-                    { $id: document.guid }
-                ).getExpressionIfKindOrThrow(ts.SyntaxKind.CallExpression)
-            )
-        },
-    },
-    transformers: {
-        record: {
-            CallExpression(document, _context) {
-                if (getCallExpressionName(document.node) !== ApplicationMenu.name) {
-                    return false
-                }
-
-                if (document.action === 'DELETE') {
-                    removeNode(document.node)
-                    return true
-                }
-                if (!document.changedData) {
-                    return false
-                }
-
-                const menu = AppMenuDocumentTransformer.safeParse(document.data)
-                if (!menu.success) {
-                    return false
-                }
-                const { roles } = (document.xmlData as AppMenuDocumentSchema).data
-                const [args] = document.node.getArguments()
-                if (!ts.Node.isObjectLiteralExpression(args)) {
-                    return false
-                }
-
-                if (roles && document.changedData?.['data']['roles']) {
-                    writeArrayPropertyAsReference(args, 'roles', '[]', getRolesArray(roles))
-                }
-
-                const {
-                    roles: _roles,
-                    device_type: _device_type,
-                    ...data
-                } = (AppMenuDocumentSchema.deepPartial().parse(document.changedData) as AppMenuDocumentSchema).data
-
-                transformCustomizedProperties(ApplicationMenu, document.node, (document.changedData as any).data, {
-                    roles: _roles,
-                    device_type: _device_type,
-                    ...data,
-                })
-                return transformFunctionArguments(document.node, ApplicationMenu, data as any)
-            },
-        },
-    },
-})

package/src/db/ColumnPlugins.ts

@@ -1,114 +0,0 @@
-import * as db from '@servicenow/sdk-core/runtime/db'
-import { FluentDiagnostic, ObjectData, Plugin, extractCallExpression } from '@servicenow/sdk-build-core'
-import { getLabelDiagnostics } from './DBUtils'
-
-const validFunctions = [
-    'add',
-    'coalesce',
-    'concat',
-    'datediff',
-    'dayofweek',
-    'distance_sphere',
-    'divide',
-    'greatest',
-    'least',
-    'length',
-    'multiply',
-    'position',
-    'substring',
-    'subtract',
-]
-
-const regExp = new RegExp(`^glidefunction:(${validFunctions.join('|')})[(].*?[)]$`, 'g')
-
-function ColumnPlugin<
-    const A extends unknown[],
-    const E extends A extends [infer T extends Record<string, unknown>] ? T : never,
-    const K extends string,
->(fn: (...args: A) => E, entityKind: K) {
-    return Plugin({
-        name: `${entityKind}Column`,
-        extractors: {
-            raw: {
-                fluent: {
-                    CallExpression(node, context) {
-                        const result = extractCallExpression(
-                            fn,
-                            `${entityKind}_column`,
-                            node,
-                            context,
-                            () => 'NO_GUID_GENERATED' // TODO: We shouldn't need to generate any GUID here but maybe should provide something unique to be on the safe side
-                        )
-                        if (!result.handled || !result.data) {
-                            return result
-                        }
-
-                        const entity = result.data
-                        const diagnostics = result.diagnostics
-                        diagnostics.push(...getLabelDiagnostics(entity))
-                        const functionDefinition = entity.getProperty('function_definition')?.getValue()
-                        if (functionDefinition) {
-                            if (typeof functionDefinition !== 'string' || !functionDefinition.match(regExp)) {
-                                diagnostics.push(
-                                    new FluentDiagnostic(
-                                        node,
-                                        `'function_definition' must start with 'glidefunction:' and include a single function call to a predefined function:\n${validFunctions.join(
-                                            '\n'
-                                        )}`
-                                    )
-                                )
-                            }
-                        }
-
-                        return {
-                            handled: true,
-                            diagnostics,
-                            data: ObjectData.fromObjectValue(
-                                {
-                                    ...entity.getValue(),
-                                    entityKind,
-                                },
-                                entity.getNode()
-                            ),
-                        }
-                    },
-                },
-            },
-        },
-    })
-}
-
-export const StringColumnPlugin = ColumnPlugin(db.StringColumn, 'string')
-export const BooleanColumnPlugin = ColumnPlugin(db.BooleanColumn, 'boolean')
-export const IntegerColumnPlugin = ColumnPlugin(db.IntegerColumn, 'integer')
-export const BasicImageColumnPlugin = ColumnPlugin(db.BasicImageColumn, 'image')
-export const ConditionsColumnPlugin = ColumnPlugin(db.ConditionsColumn, 'conditions')
-export const ChoiceColumnPlugin = ColumnPlugin(db.ChoiceColumn, 'choice')
-export const DecimalColumnPlugin = ColumnPlugin(db.DecimalColumn, 'decimal')
-export const DocumentIdColumnPlugin = ColumnPlugin(db.DocumentIdColumn, 'document_id')
-export const DomainIdColumnPlugin = ColumnPlugin(db.DomainIdColumn, 'domain_id')
-export const DomainPathColumnPlugin = ColumnPlugin(db.DomainPathColumn, 'domain_path')
-export const ListColumnPlugin = ColumnPlugin(db.ListColumn, 'glide_list')
-export const ReferenceColumnPlugin = ColumnPlugin(db.ReferenceColumn, 'reference')
-export const RadioColumnPlugin = ColumnPlugin(db.RadioColumn, 'radio')
-export const ScriptColumnPlugin = ColumnPlugin(db.ScriptColumn, 'script')
-export const SystemClassNameColumnPlugin = ColumnPlugin(db.SystemClassNameColumn, 'sys_class_name')
-export const TableNameColumnPlugin = ColumnPlugin(db.TableNameColumn, 'table_name')
-export const TranslatedFieldColumnPlugin = ColumnPlugin(db.TranslatedFieldColumn, 'translated_field')
-export const TranslatedTextColumnPlugin = ColumnPlugin(db.TranslatedTextColumn, 'translated_text')
-export const UserRolesColumnPlugin = ColumnPlugin(db.UserRolesColumn, 'user_roles')
-export const VersionColumnPlugin = ColumnPlugin(db.VersionColumn, 'version')
-export const FieldNameColumnPlugin = ColumnPlugin(db.FieldNameColumn, 'field_name')
-
-// Date columns
-export const DateColumnPlugin = ColumnPlugin(db.DateColumn, 'glide_date')
-export const DateTimeColumnPlugin = ColumnPlugin(db.DateTimeColumn, 'glide_date_time')
-export const CalendarDateTimeColumnPlugin = ColumnPlugin(db.CalendarDateTimeColumn, 'calendar_date_time')
-export const BasicDateTimeColumnPlugin = ColumnPlugin(db.BasicDateTimeColumn, 'datetime')
-export const DueDateColumnPlugin = ColumnPlugin(db.DueDateColumn, 'due_date')
-export const IntegerDateColumnPlugin = ColumnPlugin(db.IntegerDateColumn, 'integer_date')
-export const ScheduleDateTimeColumnPlugin = ColumnPlugin(db.ScheduleDateTimeColumn, 'schedule_date_time')
-export const OtherDateColumnPlugin = ColumnPlugin(db.OtherDateColumn, 'date')
-
-// Catch all column type which keys of off 'internal_type'
-export const GenericColumnPlugin = ColumnPlugin(db.GenericColumn, 'generic')

package/src/db/DBUtils.ts

@@ -1,36 +0,0 @@
-import { FluentDiagnostic } from '@servicenow/sdk-build-core'
-import { isArray } from 'lodash'
-import { Diagnostic } from '@servicenow/sdk-project'
-
-export function getLabelDiagnostics(entity) {
-    const diagnostics: FluentDiagnostic[] = []
-    const label = entity.getProperty('label')?.getValue()
-    if (label && isArray(label)) {
-        const languages = {}
-        label.forEach((l, i) => {
-            const language = l.language
-            if (languages[language] !== undefined) {
-                diagnostics.push(
-                    new FluentDiagnostic(
-                        entity.getProperty('label')!.getNode().getChildrenOfKind(210)![i]?.getProperty('language') ??
-                            entity.getProperty('label')!.getNode(),
-                        `'language' must be unique per table/column`,
-                        { level: Diagnostic.Level.Error }
-                    )
-                )
-            }
-            languages[language] = i
-            if (language === '' || (language && language.length !== 2)) {
-                diagnostics.push(
-                    new FluentDiagnostic(
-                        entity.getProperty('label')!.getNode().getChildrenOfKind(210)![i]?.getProperty('language') ??
-                            entity.getProperty('label')!.getNode(),
-                        `'language' must be a 2 character identifier (Ex. 'en', 'es')`,
-                        { level: Diagnostic.Level.Error }
-                    )
-                )
-            }
-        })
-    }
-    return diagnostics
-}