@servicenow/sdk-build-plugins 4.2.0 → 4.4.0

package/src/flow/utils/flow-constants.ts

@@ -0,0 +1,285 @@
+import { CallExpressionShape, type Diagnostics, type Factory, type Record } from '@servicenow/sdk-build-core'
+import { getDocumentationRecords } from '../../column/column-to-record'
+import { formatComplexObjectAttributes } from './complex-objects'
+
+//Flow tables
+export const TRIGGER_INSTANCE_TABLE = 'sys_hub_trigger_instance'
+export const ACTION_INSTANCE_TABLE = 'sys_hub_action_instance'
+export const SUBFLOW_INSTANCE_TABLE = 'sys_hub_sub_flow_instance'
+export const SUBFLOW_INSTANCE_TABLE_V2 = 'sys_hub_sub_flow_instance_v2'
+export const FLOW_LOGIC_INSTANCE_TABLE = 'sys_hub_flow_logic'
+export const FLOW_STAGE_TABLE = 'sys_hub_flow_stage'
+export const PILL_COMPOUND_TABLE = 'sys_hub_pill_compound'
+export const CATALOG_ITEM_TABLE = 'sc_cat_item'
+export const CATALOG_VARIABLE_TABLE = 'item_option_new'
+export const CATALOG_VARIABLE_SET_TABLE = 'io_set_item'
+
+export const UNSUPPORTED_FLOW_DESCENDANTS = [
+    FLOW_STAGE_TABLE,
+    PILL_COMPOUND_TABLE,
+    TRIGGER_INSTANCE_TABLE,
+    ACTION_INSTANCE_TABLE,
+    SUBFLOW_INSTANCE_TABLE,
+    FLOW_LOGIC_INSTANCE_TABLE,
+    SUBFLOW_INSTANCE_TABLE_V2,
+]
+
+//Plugins callee names
+export const FLOW_API_NAME = 'Flow'
+export const SUBFLOW_API_NAME = 'Subflow'
+export const ACTION_DEFINITION_API_NAME = 'ActionDefinition'
+export const TRIGGER_DEFINITION_API_NAME = 'TriggerDefinition'
+
+export const TRIGGER_INSTANCE_API_NAME = 'wfa.trigger'
+export const ACTION_INSTANCE_API_NAME = 'wfa.action'
+export const SUBFLOW_INSTANCE_API_NAME = 'wfa.subflow'
+export const ACTION_STEP_INSTANCE_API_NAME = 'wfa.action_step'
+export const APPROVAL_RULES_API_NAME = 'wfa.approvalRules'
+export const APPROVAL_DUE_DATE_API_NAME = 'wfa.approvalDueDate'
+
+export const ELEMENT_MAPPING_PROVIDER = 'com.glide.flow_design.action.data.FlowDesignVariableMapper'
+
+export const TRIGGER_TYPE_KEY_NAME = 'trigger_type'
+export const ACTION_TYPE_KEY_NAME = 'action_type'
+
+export const APPROVAL_RULES_INTERNAL_TYPE = 'approval_rules'
+export const APPROVAL_ACTION_TYPE_APPROVE_VALUE = 'Approves'
+export const APPROVAL_ACTION_TYPES = ['Approves', 'Rejects', 'ApprovesRejects']
+
+export const STRING_API_NAME = 'StringColumn'
+export const STRING_FULL_UTF8_ATTRIBUTE_NAME = 'isFullUTF8'
+export const STRING_FULL_UTF8_DATA_TYPE_VALUE = 'string_full_utf8'
+
+export const TIME_DATA_TYPE_VALUE = 'glide_time'
+export const DURATION_DATA_TYPE_VALUE = 'glide_duration'
+export const TEMPLATE_DATA_TYPE_VALUE = 'template_value'
+export const APPROVAL_RULES_DATA_TYPE_VALUE = 'approval_rules'
+export const APPROVAL_DUE_DATE_DATA_TYPE_VALUE = 'schedule_date_time'
+
+export const UTC_TIMEZONE_VALUE = 'UTC'
+
+export const UNSUPPORTED_DATA_TYPES = ['dynamic_choice', 'dynamic_inputs']
+
+export const ACTION_DEF_COLUMN_NAME = 'action_type'
+
+export const CORE_ACTIONS_PREFIX = 'action.core'
+
+export const RUN_ON_EXTENDED = 'run_on_extended'
+
+export const APPROVAL_DUE_DATE_INPUT_FIELD_ACTIONS = [
+    'f8f2e9920b10030085c083eb37673abd',
+    'cd04ac7573011010791f94596bf6a716',
+]
+
+export const CORE_ACTIONS_SYS_ID_NAME_MAP: { [sysId: string]: string } = {
+    fd4a0fb70f003300ecf0cc52ff767e2a: 'addWorknoteLinkToContext',
+    f8f2e9920b10030085c083eb37673abd: 'askForApproval',
+    '7b95a4c0a73133008299b39f087901b4': 'associateRecordToEmail',
+    '30fe6cdb0f973300dfd3694e68767e5a': 'copyAttachment',
+    af51fd0e73141300612c273ffff6a785: 'createCatalogTask',
+    ab575ae253b3230034c6ddeeff7b12f1: 'createOrUpdateRecord',
+    '2de05916c31332002841b63b12d3aee1': 'createRecord',
+    '2b3a6335531003003bf1d9109ec58759': 'createTask',
+    bdc2a0170f973300dfd3694e68767e47: 'deleteAttachment',
+    c3e09916c31332002841b63b12d3aedf: 'deleteRecord',
+    '80a30edeff30311077a95dac793bf19b': 'fireEvent',
+    '082e70db0f4273003788001ea8767e02': 'getAttachmentsOnRecord',
+    '330ba3abc31013002841b63b12d3aee8': 'getCatalogVariables',
+    a8cfa3efa70223008299b39f0879018b: 'getEmailHeader',
+    a159d7820f13101051218e8ebc767eea: 'getLatestResponseTextFromEmail',
+    '5bc1bcc6531003003bf1d9109ec587d4': 'log',
+    '2dbeaf29c7322300f4eba1425a976340': 'lookUpEmailAttachments',
+    '9d09f99587003300663ca1bb36cb0ba3': 'lookUpRecord',
+    '43400a1587003300663ca1bb36cb0b4b': 'lookUpRecords',
+    '6ecdee36935023005e69925cf67ffb47': 'lookupAttachment',
+    '7159823353cc10103a33ddeeff7b1216': 'moveAttachment',
+    bd8fcd48a73133008299b39f087901fc: 'moveEmailAttachmentsToRecord',
+    '87a397837333001098e194596bf6a7bc': 'recordProducer',
+    c1806bf4a70323008299b39f087901cb: 'sendEmail',
+    '0d8dd9f10f11101051218e8ebc767e27': 'sendNotification',
+    '027499be7333001099792f163cf6a7a7': 'sendSms',
+    a1a50c4573873300d70877186bf6a762: 'slaPercentageTimer',
+    c7a04c4607312001098e194596bf6a72a: 'submitCatalogItemRequest',
+    '9daf2a72c75100105312134c95c26073': 'updateMultipleRecords',
+    f9d01dd2c31332002841b63b12d3aea1: 'updateRecord',
+    '89ce8a4187120010663ca1bb36cb0be3': 'waitForCondition',
+    '8e38de067f0312108e688c90ac866501': 'waitForEmailReply',
+    '605d0ab8931012105cd18166448918db': 'waitForMessage',
+}
+
+export const COLUMN_DEFAULTS = {
+    string: '',
+    boolean: false,
+    integer: 0,
+}
+
+export enum ChoiceDropdown {
+    DROPDOWN_WITH_NONE = 1,
+    DROPDOWN_WITHOUT_NONE = 3,
+}
+
+const actionStatusProps = {
+    name: '__action_status__',
+    label: 'Action Status',
+}
+const actionErrorProps = {
+    name: '__dont_treat_as_error__',
+    label: `Don't Treat as Error`,
+}
+
+function getActionOutputAttributes(actionId: string, key: 'action_status' | 'action_error') {
+    const commonProps = {
+        element_mapping_provider: ELEMENT_MAPPING_PROVIDER,
+        action_error_output: true,
+    }
+
+    const props = {
+        action_status: {
+            ...commonProps,
+            uiType: 'object',
+            uiTypeLabel: 'Object',
+            uiUniqueId: `${actionId}-action-status`,
+            co_type_name: 'FDACTIONSTATUS',
+        },
+        action_error: {
+            ...commonProps,
+            uiType: 'boolean',
+            uiTypeLabel: 'True/False',
+            uiUniqueId: `${actionId}-action-error`,
+            visible_in_ui: false,
+        },
+    }
+
+    return formatComplexObjectAttributes(props[key])
+}
+
+// action_error_output=true,co_type_name=FDACTIONSTATUS,element_mapping_provider=com.glide.flow_design.action.data.FlowDesignVariableMapper,uiType=object,uiTypeLabel=Object,uiUniqueId=2e98ff63-bb27-4fa1-ba86-9f0a3893b656</attributes>
+// action_error_output=true,element_mapping_provider=com.glide.flow_design.action.data.FlowDesignVariableMapper,uiType=boolean,uiTypeLabel=True/False,uiUniqueId=ec7915fc-9e29-4c47-8674-dc6d0d67e32b,visible_in_ui=false
+export async function createActionErrorAndStatusRecords(
+    source: Record,
+    tableName: string,
+    varTable: string,
+    factory: Factory,
+    diagnostics: Diagnostics
+) {
+    const records: Record[] = []
+
+    const actionStatus = new CallExpressionShape({
+        source,
+        callee: 'StringColumn',
+        args: [
+            {
+                table: tableName,
+                ...actionStatusProps,
+            },
+        ],
+    })
+
+    const actionError = new CallExpressionShape({
+        source,
+        callee: 'StringColumn',
+        args: [
+            {
+                table: tableName,
+                ...actionErrorProps,
+            },
+        ],
+    })
+
+    const actionStatusRecords = await getDocumentationRecords(actionStatus, {}, factory, diagnostics, true)
+    const actionErrorRecords = await getDocumentationRecords(actionError, {}, factory, diagnostics, true)
+
+    records.push(...actionStatusRecords)
+    records.push(...actionErrorRecords)
+    const actionTypeId = source.getId().getValue()
+    const props = {
+        active: true,
+        model: actionTypeId,
+        model_id: actionTypeId,
+        model_table: source.getTable(),
+        name: tableName,
+        internal_type: 'string',
+        mandatory: false,
+    }
+
+    const statusVarRecord = await factory.createRecord({
+        source: source,
+        table: varTable,
+        properties: {
+            element: actionStatusProps['name'],
+            label: actionStatusProps['label'],
+            order: 1,
+            max_length: 65000,
+            ...props,
+            attributes: getActionOutputAttributes(actionTypeId, 'action_status'),
+        },
+    })
+
+    const errorVarRecord = await factory.createRecord({
+        source: source,
+        table: varTable,
+        properties: {
+            element: actionErrorProps['name'],
+            label: actionErrorProps['label'],
+            order: 2,
+            max_length: 40,
+            ...props,
+            attributes: getActionOutputAttributes(actionTypeId, 'action_error'),
+        },
+    })
+
+    records.push(statusVarRecord)
+    records.push(errorVarRecord)
+
+    return records
+}
+
+// -------------------------------------------------------------
+// slugifyName
+// -------------------------------------------------------------
+/**
+ * Converts arbitrary strings to snake_case slugs suitable for internal_name, etc.
+ * Handles:
+ *  • Unicode accents (café → cafe)
+ *  • Multiple / leading / trailing separators
+ *  • Leading digits (prefixes with underscore)
+ *  • Empty results (returns `fallback`)
+ */
+export interface SlugifyOptions {
+    prefixIfDigit?: string
+    fallback?: string
+}
+
+export function slugifyString(value: unknown, opts: SlugifyOptions = {}): string {
+    const { prefixIfDigit = '_', fallback = '' } = opts
+
+    let str = value == null ? '' : String(value)
+
+    // Trim & normalize
+    str = str
+        .trim()
+        .normalize('NFKD')
+        .replace(/\p{Diacritic}/gu, '')
+
+    // Replace non-alphanumerics with underscore
+    str = str.replace(/[^a-zA-Z0-9]+/g, '_')
+
+    // Collapse and trim underscores
+    str = str.replace(/_+/g, '_').replace(/^_+|_+$/g, '')
+
+    // Prefix if starts with digit
+    if (/^[0-9]/.test(str)) {
+        str = `${prefixIfDigit}${str}`
+    }
+
+    if (str === '') {
+        return fallback
+    }
+
+    return str.toLowerCase()
+}
+
+/**
+ * Core actions that require special catalog variable handling
+ */
+export const CATALOG_VARIABLE_ACTIONS = ['getCatalogVariables', 'createCatalogTask']