@servicenow/sdk-build-plugins 4.2.0 → 4.4.0

package/src/service-catalog/variable-helper.ts

@@ -0,0 +1,135 @@
+import {
+    SingleLineTextVariable,
+    MultiLineTextVariable,
+    WideSingleLineTextVariable,
+    HtmlVariable,
+    MaskedVariable,
+    EmailVariable,
+    UrlVariable,
+    IpAddressVariable,
+    RichTextLabelVariable,
+    LabelVariable,
+    // Choice Variables
+    SelectBoxVariable,
+    MultipleChoiceVariable,
+    LookupSelectBoxVariable,
+    LookupMultipleChoiceVariable,
+    NumericScaleVariable,
+    YesNoVariable,
+    // Date/Time Variables
+    DateVariable,
+    DateTimeVariable,
+    DurationVariable,
+    // Reference Variables
+    ReferenceVariable,
+    RequestedForVariable,
+    // Special Variables
+    AttachmentVariable,
+    ListCollectorVariable,
+    UIPageVariable,
+    // Layout Variables
+    ContainerStartVariable,
+    ContainerEndVariable,
+    ContainerSplitVariable,
+    BreakVariable,
+    // Custom Variables
+    CustomVariable,
+    CustomWithLabelVariable,
+    CheckboxVariable,
+} from '@servicenow/sdk-core/runtime/service-catalog'
+
+// Map variable type codes to their corresponding component classes
+export const VARIABLE_TYPE_TO_NAME: Record<string, string> = {
+    '1': YesNoVariable.name,
+    '2': MultiLineTextVariable.name,
+    '3': MultipleChoiceVariable.name,
+    '4': NumericScaleVariable.name,
+    '5': SelectBoxVariable.name,
+    '6': SingleLineTextVariable.name,
+    '7': CheckboxVariable.name,
+    '8': ReferenceVariable.name,
+    '9': DateVariable.name,
+    '10': DateTimeVariable.name,
+    '11': LabelVariable.name,
+    '12': BreakVariable.name,
+    '14': CustomVariable.name,
+    '15': UIPageVariable.name,
+    '16': WideSingleLineTextVariable.name,
+    '17': CustomWithLabelVariable.name,
+    '18': LookupSelectBoxVariable.name,
+    '19': ContainerStartVariable.name,
+    '20': ContainerEndVariable.name,
+    '21': ListCollectorVariable.name,
+    '22': LookupMultipleChoiceVariable.name,
+    '23': HtmlVariable.name,
+    '24': ContainerSplitVariable.name,
+    '25': MaskedVariable.name,
+    '26': EmailVariable.name,
+    '27': UrlVariable.name,
+    '28': IpAddressVariable.name,
+    '29': DurationVariable.name,
+    '31': RequestedForVariable.name,
+    '32': RichTextLabelVariable.name,
+    '33': AttachmentVariable.name,
+}
+
+// Reverse mapping from API name to type code
+export const VARIABLE_TYPE_TO_API: Record<string, string> = Object.fromEntries(
+    Object.entries(VARIABLE_TYPE_TO_NAME).map(([key, value]) => [value, key])
+)
+
+export const VARIABLE_NAME_TO_TYPE = Object.fromEntries(
+    Object.entries(VARIABLE_TYPE_TO_NAME).map(([key, value]) => [value, key])
+) as Record<keyof typeof VARIABLE_TYPE_TO_NAME, string>
+
+/**
+ * Gets the variable type code from its class name
+ * @param className - The class name of the variable (e.g., 'ReferenceVariable')
+ * @returns The corresponding type code or '6' (SingleLineText) as default
+ */
+export function getVariableTypeFromName(className: string): string {
+    return VARIABLE_NAME_TO_TYPE[className] || '6' // Default to SingleLineText if not found
+}
+
+// Define the default template constant
+export const DEFAULT_SAVE_SCRIPT = `/** This script is executed before the Record is generated
+* \`current\`- GlideRecord produced by Record Producer
+* Don't use \`current.update()\` or \`current.insert()\` as the record is generated by Record Producer
+* Don't use \`current.setValue('sys_class_name', 'xxx')\` as this will trigger reparent flow and can cause data loss
+* Avoid \`current.setAbortAction()\` and generate a separate record
+* Use \`producer.var1\` to access variables
+*/`
+
+export const VariableTypeName = {
+    YES_NO: YesNoVariable.name,
+    MULTI_LINE_TEXT: MultiLineTextVariable.name,
+    MULTIPLE_CHOICE: MultipleChoiceVariable.name,
+    NUMERIC_SCALE: NumericScaleVariable.name,
+    SELECT_BOX: SelectBoxVariable.name,
+    SINGLE_LINE_TEXT: SingleLineTextVariable.name,
+    CHECKBOX: CheckboxVariable.name,
+    REFERENCE: ReferenceVariable.name,
+    DATE: DateVariable.name,
+    DATE_TIME: DateTimeVariable.name,
+    LABEL: LabelVariable.name,
+    BREAK: BreakVariable.name,
+    CUSTOM: CustomVariable.name,
+    UI_PAGE: UIPageVariable.name,
+    WIDE_SINGLE_LINE_TEXT: WideSingleLineTextVariable.name,
+    CUSTOM_WITH_LABEL: CustomWithLabelVariable.name,
+    LOOKUP_SELECT_BOX: LookupSelectBoxVariable.name,
+    CONTAINER_START: ContainerStartVariable.name,
+    CONTAINER_END: ContainerEndVariable.name,
+    LIST_COLLECTOR: ListCollectorVariable.name,
+    LOOKUP_MULTIPLE_CHOICE: LookupMultipleChoiceVariable.name,
+    HTML: HtmlVariable.name,
+    CONTAINER_SPLIT: ContainerSplitVariable.name,
+    MASKED: MaskedVariable.name,
+    EMAIL: EmailVariable.name,
+    URL: UrlVariable.name,
+    IP_ADDRESS: IpAddressVariable.name,
+    DURATION: DurationVariable.name,
+    REQUESTED_FOR: RequestedForVariable.name,
+    RICH_TEXT_LABEL: RichTextLabelVariable.name,
+    ATTACHMENT: AttachmentVariable.name,
+} as const

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

@@ -0,0 +1,197 @@
+import {
+    CallExpressionShape,
+    Plugin,
+    type Record,
+    VariableStatementShape,
+    IdentifierShape,
+} from '@servicenow/sdk-build-core'
+import { NowIdShape } from '../now-id-plugin'
+import { buildVariableRecords } from './shape-to-record'
+import { buildVariablesSchema } from './service-catalog-base'
+import {
+    validateInternalName,
+    convertTitleToInternalName,
+    convertRolesToString,
+    parseString,
+    toValidIdentifier,
+    shouldWriteAsCallExpression,
+    convertToNumber,
+    validateVariableSetVariables,
+    getVariableSetTypeFromDb,
+    getVariableSetTypeToDb,
+} from './utils'
+
+export const VariableSetPlugin = Plugin.create({
+    name: 'VariableSetPlugin',
+    records: {
+        item_option_new_set: {
+            relationships: {
+                item_option_new: {
+                    via: 'variable_set',
+                    descendant: true,
+                    relationships: {
+                        question_choice: {
+                            via: 'question',
+                            descendant: true,
+                            relationships: {
+                                fx_price: {
+                                    via: 'id',
+                                    descendant: true,
+                                },
+                            },
+                        },
+                        fx_price: {
+                            via: 'id',
+                            descendant: true,
+                        },
+                    },
+                },
+            },
+            toShape(record, { descendants, logger }) {
+                const variablesSchema = buildVariablesSchema(descendants, logger)
+                const callExpression = new CallExpressionShape({
+                    source: record,
+                    callee: 'VariableSet',
+                    args: [
+                        record.transform(({ $ }) => ({
+                            $id: $.val(NowIdShape.from(record)),
+                            title: $.from('title'),
+                            internalName: $.from('internal_name'),
+                            name: $.from('name').def(''),
+                            description: $.from('description').def(''),
+                            type: $.from('type')
+                                .map((v) => getVariableSetTypeFromDb(v.toString().getValue()))
+                                .def('singleRow'),
+                            layout: $.from('layout').def('normal'),
+                            order: $.map((c) => convertToNumber(c, 100)).def(100),
+                            displayTitle: $.from('display_title').toBoolean().def(false),
+                            setAttributes: $.from('set_attributes').def(''),
+                            version: $.map((c) => convertToNumber(c, 1)).def(1),
+                            // Parse comma-separated role strings into arrays
+                            readRoles: $.from('read_roles')
+                                .map((v) => parseString(v))
+                                .def([]),
+                            writeRoles: $.from('write_roles')
+                                .map((v) => parseString(v))
+                                .def([]),
+                            createRoles: $.from('create_roles')
+                                .map((v) => parseString(v))
+                                .def([]),
+                            variables: $.val(variablesSchema).def({}),
+                        })),
+                    ],
+                })
+                return {
+                    success: true,
+                    value: shouldWriteAsCallExpression(record)
+                        ? callExpression
+                        : new VariableStatementShape({
+                              source: record,
+                              isExported: true,
+                              variableName: new IdentifierShape({
+                                  source: record,
+                                  name: toValidIdentifier(record.get('title').toString().getValue()),
+                              }),
+                              initializer: callExpression,
+                          }),
+                }
+            },
+        },
+        fx_price: {
+            coalesce: ['id', 'field'],
+        },
+        item_option_new: {
+            coalesce: ['cat_item', 'variable_set', 'name'],
+        },
+        question_choice: {
+            coalesce: ['question', 'value'],
+        },
+    },
+    shapes: [
+        {
+            shape: CallExpressionShape,
+            fileTypes: ['fluent'],
+            async toRecord(callExpression, { diagnostics, factory }) {
+                if (callExpression.getCallee() !== 'VariableSet') {
+                    return { success: false }
+                }
+
+                const arg = callExpression.getArgument(0).asObject()
+
+                // Determine and validate internalName
+                const providedInternalName = arg.get('internalName')
+                let internalName: string
+
+                if (providedInternalName.isDefined()) {
+                    // Use provided internalName and validate it
+                    internalName = providedInternalName.toString().getValue()
+                    const validation = validateInternalName(internalName)
+
+                    if (!validation.valid) {
+                        diagnostics.error(providedInternalName.getOriginalNode(), validation.error ?? '')
+                        return { success: false }
+                    }
+                } else {
+                    // Auto-generate internalName from title (already validated format)
+                    const title = arg.get('title')
+                    internalName = convertTitleToInternalName(title.toString().getValue())
+                }
+
+                // Get the variable set type for validation
+                const variableSetType = arg.get('type').isDefined()
+                    ? arg.get('type').toString().getValue()
+                    : 'singleRow' // default value
+
+                // Validate variables (RequestedForVariable count and multiRow restrictions)
+                if (arg.get('variables').isDefined()) {
+                    const variablesConfig = arg.get('variables').asObject()
+                    if (!validateVariableSetVariables(variablesConfig, variableSetType, diagnostics, 'VariableSet')) {
+                        return { success: false }
+                    }
+                }
+
+                // Create the variable set record
+                const variableSet = await factory.createRecord({
+                    explicitId: arg.get('$id'),
+                    source: callExpression,
+                    table: 'item_option_new_set',
+                    properties: arg.transform(({ $ }) => ({
+                        title: $,
+                        internal_name: $.val(internalName),
+                        name: $.def(''),
+                        description: $.def(''),
+                        type: $.from('type')
+                            .map((v) => getVariableSetTypeToDb(v.toString().getValue()))
+                            .def('one_to_one'),
+                        layout: $.def('normal'),
+                        order: $.def(100),
+                        display_title: $.from('displayTitle').toBoolean().def(false),
+                        set_attributes: $.from('setAttributes').def(''),
+                        version: $.def(1),
+                        // Convert role arrays to comma-separated strings for ServiceNow
+                        read_roles: $.from('readRoles').map(convertRolesToString).def(''),
+                        write_roles: $.from('writeRoles').map(convertRolesToString).def(''),
+                        create_roles: $.from('createRoles').map(convertRolesToString).def(''),
+                    })),
+                })
+
+                // Build child variable records if variables are defined
+                let variableRecords: Record[] = []
+                if (arg.get('variables').isDefined()) {
+                    const variablesConfig = arg.get('variables').asObject()
+                    variableRecords = await buildVariableRecords({
+                        variablesConfig,
+                        factory,
+                        parent: variableSet,
+                        diagnostics,
+                    })
+                }
+
+                return {
+                    success: true,
+                    value: variableSet.with(...variableRecords),
+                }
+            },
+        },
+    ],
+})