@servicenow/sdk-build-plugins 3.0.3 → 4.0.1

package/src/column/column-helper.ts

@@ -0,0 +1,119 @@
+import { CallExpressionShape, Shape } from '@servicenow/sdk-build-core'
+import {
+    BasicDateTimeColumn,
+    BasicImageColumn,
+    BooleanColumn,
+    CalendarDateTimeColumn,
+    ChoiceColumn,
+    ConditionsColumn,
+    DateColumn,
+    DateTimeColumn,
+    DecimalColumn,
+    DocumentIdColumn,
+    DomainIdColumn,
+    DomainPathColumn,
+    DueDateColumn,
+    FieldNameColumn,
+    IntegerColumn,
+    IntegerDateColumn,
+    ListColumn,
+    OtherDateColumn,
+    RadioColumn,
+    ReferenceColumn,
+    ScheduleDateTimeColumn,
+    ScriptColumn,
+    StringColumn,
+    SystemClassNameColumn,
+    TableNameColumn,
+    TranslatedFieldColumn,
+    TranslatedTextColumn,
+    UserRolesColumn,
+    VersionColumn,
+} from '@servicenow/sdk-core/runtime/db'
+
+export const COLUMN_TYPE_TO_API: Record<string, string> = {
+    string: StringColumn.name,
+    boolean: BooleanColumn.name,
+    choice: ChoiceColumn.name,
+    conditions: ConditionsColumn.name,
+    date: OtherDateColumn.name,
+    calendar_date_time: CalendarDateTimeColumn.name,
+    datetime: BasicDateTimeColumn.name,
+    due_date: DueDateColumn.name,
+    glide_date: DateColumn.name,
+    glide_date_time: DateTimeColumn.name,
+    integer_date: IntegerDateColumn.name,
+    schedule_date_time: ScheduleDateTimeColumn.name,
+    decimal: DecimalColumn.name,
+    document_id: DocumentIdColumn.name,
+    domain_id: DomainIdColumn.name,
+    domain_path: DomainPathColumn.name,
+    field_name: FieldNameColumn.name,
+    integer: IntegerColumn.name,
+    radio: RadioColumn.name,
+    reference: ReferenceColumn.name,
+    script: ScriptColumn.name,
+    sys_class_name: SystemClassNameColumn.name,
+    table_name: TableNameColumn.name,
+    translated_field: TranslatedFieldColumn.name,
+    translated_text: TranslatedTextColumn.name,
+    user_roles: UserRolesColumn.name,
+    version: VersionColumn.name,
+    glide_list: ListColumn.name,
+    image: BasicImageColumn.name,
+}
+
+export const COLUMN_API_TO_TYPE = Object.fromEntries(
+    Object.entries(COLUMN_TYPE_TO_API).map(([key, value]) => [value, key])
+)
+
+export const DEFAULT_COLUMN_CALCULATION = `(function calculatedFieldValue(current) {
+
+	// Add your code here
+	return '';  // return the calculated value
+
+})(current);`
+
+export function addFieldsToColumn(
+    fields: { name: string; table: string; display: boolean },
+    column: CallExpressionShape
+) {
+    const additionalFields = Shape.from(column, fields).asObject()
+
+    return new CallExpressionShape({
+        source: column.getSource(),
+        callee: column.getCallee(),
+        args: [column.getArgument(0).asObject().merge(additionalFields)],
+    })
+}
+
+export function getDefaultMaxLength(columnType: string): number {
+    switch (columnType) {
+        case 'conditions':
+        case 'glide_list':
+            return 4000
+        case 'decimal':
+            return 20
+        case 'domain_id':
+        case 'document_id':
+        case 'reference':
+            return 32
+        case 'domain_path':
+        case 'user_roles':
+            return 255
+        case 'script':
+            return 8000
+        case 'table_name':
+        case 'field_name':
+            return 80
+        default:
+            /**
+             * For types mentioned below it default to 40 on instance
+             * boolean | integer | image | choice | radio | sys_class_name | translated_field | translated_text | version | glide_date | glide_date_time | calendar_date_time
+             * datetime | due_date | integer_date | schedule_date_time | date | generic
+             *
+             * TODO::We need to request max_length from user for string column type because its mandatory on instance.
+             */
+            return 40
+    }
+}

package/src/column/column-to-record.ts

@@ -0,0 +1,131 @@
+import {
+    ArrayShape,
+    type CallExpressionShape,
+    type Diagnostics,
+    type Factory,
+    StringShape,
+} from '@servicenow/sdk-build-core'
+import { generateDeprecatedDiagnostics } from '../utils'
+import { generatePlural } from '../column-plugin'
+
+export function getDocumentationRecords(
+    callExpression: CallExpressionShape,
+    aliasedKeys: globalThis.Record<string, string[]>,
+    factory: Factory,
+    diagnostics: Diagnostics,
+    generateDefaultDoc: boolean = false
+) {
+    const column = callExpression.getArgument(0).asObject()
+    const documentation = column.get('label')
+    const columnName = column.get('name')
+    if (!documentation.if([ArrayShape, StringShape])) {
+        return [
+            factory.createRecord({
+                source: callExpression,
+                table: 'sys_documentation',
+                properties: column.transform(({ $ }) => ({
+                    name: $.from('table'),
+                    element: $.val(columnName),
+                    language: $.def('en'),
+                    label: $.val(documentation.ifDefined() ?? columnName),
+                    plural: $.val(
+                        generatePlural(
+                            documentation.ifDefined()?.asString().getValue() ?? columnName.asString().getValue()
+                        )
+                    ),
+                })),
+            }),
+        ]
+    }
+
+    if (documentation.ifArray()) {
+        return (
+            documentation
+                .asArray()
+                .getElements()
+                .map((documentation) => {
+                    const docObject = documentation.asObject().withAliasedKeys(aliasedKeys)
+                    generateDeprecatedDiagnostics(docObject, diagnostics)
+                    return factory.createRecord({
+                        source: callExpression,
+                        table: 'sys_documentation',
+                        properties: docObject.transform(({ $ }) => ({
+                            name: $.val(column.get('table')),
+                            element: $.val(column.get('name')),
+                            language: $,
+                            hint: $,
+                            help: $,
+                            label: $,
+                            plural: $,
+                            url: $,
+                            url_target: $.from('urlTarget'),
+                        })),
+                    })
+                }) ?? []
+        )
+    }
+
+    if (!generateDefaultDoc) {
+        return []
+    }
+
+    return [
+        factory.createRecord({
+            source: callExpression,
+            table: 'sys_documentation',
+            properties: column.transform(({ $ }) => ({
+                name: $.from('table'),
+                element: $.val(columnName),
+                language: $.def('en'),
+                label: $.val(documentation.ifDefined() ?? columnName),
+                plural: $.val(
+                    generatePlural(documentation.ifDefined()?.asString().getValue() ?? columnName.asString().getValue())
+                ),
+            })),
+        }),
+    ]
+}
+
+export function getChoiceRecords(
+    callExpression: CallExpressionShape,
+    aliasedKeys: globalThis.Record<string, string[]>,
+    factory: Factory,
+    diagnostics: Diagnostics
+) {
+    const column = callExpression.getArgument(0).asObject()
+    const choiceArg = column.has('choices') ? column.get('choices').asObject().withAliasedKeys(aliasedKeys) : undefined
+    if (!choiceArg) {
+        return []
+    }
+
+    return Object.keys(choiceArg.getValue()).map((choiceValue) => {
+        // TODO Should have proper type here
+        const choice = choiceArg.get(choiceValue)
+        if (choice.isObject()) {
+            generateDeprecatedDiagnostics(choice.withAliasedKeys(aliasedKeys), diagnostics)
+        }
+        return factory.createRecord({
+            source: callExpression,
+            table: 'sys_choice',
+            properties: choice.isString()
+                ? {
+                      name: column.get('table').asString().getValue(),
+                      element: column.get('name').asString().getValue(),
+                      label: choice,
+                      value: choiceValue,
+                  }
+                : choice.asObject().transform(({ $ }) => ({
+                      name: $.val(column.get('table')),
+                      element: $.val(column.get('name')),
+                      label: $,
+                      value: $.val(choiceValue),
+                      sequence: $,
+                      dependent_value: $.from('dependentValue'),
+                      hint: $,
+                      inactive: $.toBoolean().def(false),
+                      inactive_on_update: $.from('inactiveOnUpdate').toBoolean().def(false),
+                      language: $.def('en'),
+                  })),
+        })
+    })
+}