Merge branch 'main' into detect-oldvalue-newvalue-in-cs

Author: SrijanPatwa

.github/pull_request_template.md

@@ -1,3 +1,6 @@
+# PR Description: 
+
+
 # Pull Request Checklist
 
 ## Overview

.github/scripts/validate-structure.js

@@ -49,6 +49,34 @@ function validateFilePath(filePath) {
   const normalized = filePath.replace(/\\/g, '/');
   const segments = normalized.split('/');
 
+  // Check for invalid characters that break local file systems
+  for (let i = 0; i < segments.length; i++) {
+    const segment = segments[i];
+
+    // Check for trailing periods (invalid on Windows)
+    if (segment.endsWith('.')) {
+      return `Invalid folder/file name '${segment}' in path '${normalized}': Names cannot end with a period (.) as this breaks local file system sync on Windows.`;
+    }
+
+    // Check for trailing spaces (invalid on Windows)
+    if (segment.endsWith(' ')) {
+      return `Invalid folder/file name '${segment}' in path '${normalized}': Names cannot end with a space as this breaks local file system sync on Windows.`;
+    }
+
+    // Check for reserved Windows names
+    const reservedNames = ['CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9'];
+    const nameWithoutExt = segment.split('.')[0].toUpperCase();
+    if (reservedNames.includes(nameWithoutExt)) {
+      return `Invalid folder/file name '${segment}' in path '${normalized}': '${nameWithoutExt}' is a reserved name on Windows and will break local file system sync.`;
+    }
+
+    // Check for invalid characters (Windows and general file system restrictions)
+    const invalidChars = /[<>:"|?*\x00-\x1F]/;
+    if (invalidChars.test(segment)) {
+      return `Invalid folder/file name '${segment}' in path '${normalized}': Contains characters that are invalid on Windows file systems (< > : " | ? * or control characters).`;
+    }
+  }
+
   if (!allowedCategories.has(segments[0])) {
     return null;
   }

.github/workflows/validate-structure.yml

@@ -65,6 +65,8 @@ jobs:
           cat "$tmp_error" >&2
 
           if grep -q 'Folder structure violations found' "$tmp_output" "$tmp_error"; then
+            # Save validation output for use in PR comment
+            cat "$tmp_output" "$tmp_error" > "$RUNNER_TEMP/validation_output.txt"
             echo "status=failed" >> "$GITHUB_OUTPUT"
             exit 0
           fi
@@ -87,11 +89,37 @@ jobs:
             const owner = context.repo.owner;
             const repo = context.repo.repo;
 
+            const fs = require('fs');
+            const output = fs.readFileSync(process.env.RUNNER_TEMP + '/validation_output.txt', 'utf8');
+
+            let commentBody = `Thank you for your contribution. However, it doesn't comply with our contributing guidelines.\n\n`;
+
+            // Check if the error is about invalid file/folder names
+            if (output.includes('Names cannot end with a period') ||
+                output.includes('Names cannot end with a space') ||
+                output.includes('is a reserved name on Windows') ||
+                output.includes('Contains characters that are invalid')) {
+              commentBody += `**❌ Invalid File/Folder Names Detected**\n\n`;
+              commentBody += `Your contribution contains file or folder names that will break when syncing to local file systems (especially Windows):\n\n`;
+              commentBody += `\`\`\`\n${output}\n\`\`\`\n\n`;
+              commentBody += `**Common issues:**\n`;
+              commentBody += `- Folder/file names ending with a period (.) - not allowed on Windows\n`;
+              commentBody += `- Folder/file names ending with spaces - not allowed on Windows\n`;
+              commentBody += `- Reserved names like CON, PRN, AUX, NUL, COM1-9, LPT1-9 - not allowed on Windows\n`;
+              commentBody += `- Invalid characters: < > : " | ? * or control characters\n\n`;
+              commentBody += `Please rename these files/folders to be compatible with all operating systems.\n\n`;
+            } else {
+              commentBody += `As a reminder, the general requirements (as outlined in the [CONTRIBUTING.md file](https://github.com/ServiceNowDevProgram/code-snippets/blob/main/CONTRIBUTING.md)) are the following: follow the folder+subfolder guidelines and include a README.md file explaining what the code snippet does.\n\n`;
+              commentBody += `**Validation errors:**\n\`\`\`\n${output}\n\`\`\`\n\n`;
+            }
+
+            commentBody += `Review your contribution against the guidelines and make the necessary adjustments. Closing this for now. Once you make additional changes, feel free to re-open this Pull Request or create a new one.`;
+
             await github.rest.issues.createComment({
               owner,
               repo,
               issue_number: pullNumber,
-              body: `Thank you for your contribution. However, it doesn't comply with our contributing guidelines. As a reminder, the general requirements (as outlined in the [CONTRIBUTING.md file](https://github.com/ServiceNowDevProgram/code-snippets/blob/main/CONTRIBUTING.md)) are the following: follow the folder+subfolder guidelines and include a README.md file explaining what the code snippet does. Review your contribution against the guidelines and make the necessary adjustments. Closing this for now. Once you make additional changes, feel free to re-open this Pull Request or create a new one.`.trim()
+              body: commentBody.trim()
             });
 
             await github.rest.pulls.update({

Client-Side Components/Catalog Client Script/spModal for Sweet Alerts/readme.md

@@ -0,0 +1,27 @@
+In ServiceNow, Open catalog client Scripts [catalog_script_client] and paste the code snippet of [spModalSweetAlerts.js] file.
+
+Setup:
+1. A catalog item having variable name Rewards[rewards] of type 'Select Box'(include none as true) and 2 choices(Yes and No)
+2. A Single line type field named 'Reward Selected' [reward_selected] which will hold the value selected by user from the spModal popup.
+3. The onLoad catalog client script setup as below:
+4. Type: onChange
+5. Variable: rewards (as per step 1)
+6. Script: [[spModalSweetAlerts.js]]
+   
+
+
+Screenshots:
+
+
+<img width="1338" height="268" alt="image" src="https://github.com/user-attachments/assets/f7f22b83-7e0e-47bb-bbed-2a8f38783a4d" />
+
+
+Rewards selected as 'Yes'
+
+<img width="1353" height="327" alt="image" src="https://github.com/user-attachments/assets/1bb55339-36b4-4a9c-8b65-2b254b87cf5b" />
+
+From the spModal popup select anyone of the reward, it should be populated in the Reward Selected field.
+Along with that a message shows the same of the selection.
+
+<img width="1350" height="319" alt="image" src="https://github.com/user-attachments/assets/1b23c766-51f8-4b01-9073-f836f390deb2" />
+

Client-Side Components/Catalog Client Script/spModal for Sweet Alerts/spModalSweetAlerts.js

@@ -0,0 +1,32 @@
+function onChange(control, oldValue, newValue) {
+    if (newValue == 'Yes') {
+        spModal.open({
+            title: "Reward Type",
+            message: "Please select the category of Reward",
+            buttons: [{
+                    label: "Star Performer",
+                    value: "Star Performer"
+                },
+                {
+                    label: "Emerging Player",
+                    value: "Emerging Player"
+                },
+                {
+                    label: "High Five Award",
+                    value: "High Five Award"
+                },
+                {
+                    label: "Rising Star",
+                    value: "Rising Star"
+                }
+            ]
+        }).then(function(choice) {
+            if (choice && choice.value) {
+				g_form.addInfoMessage('Selected Reward: '+ choice.label);
+                g_form.setValue('reward_selected', choice.value);
+            }
+        });
+    } else {
+        g_form.clearValue('reward_selected');
+    }
+}

Client-Side Components/Client Scripts/Dynamically Switch Form View Based on Field Value/README.md

@@ -0,0 +1,20 @@
+## Dynamically Switch Form View Based on Field Value
+
+This client script demonstrates how to **automatically switch form views** based on the value of a field.
+
+**Use case:**  
+For example, if the **Category** field is set to *Hardware*, the form view switches to **ess**.  
+You can extend this by updating the mapping object to support additional fields and values (e.g., *Software → itil*, *Network → support*).
+
+**Benefit:**  
+Improves user experience by guiding users to the **most relevant form view**, ensuring the right fields are shown for the right scenario.
+
+**Test:**  
+- Change the **Category** field to *Hardware* → Form view should switch to **ess**.  
+- Update mapping to add new conditions (e.g., *Software → itil*) and verify the view switches accordingly.
+
+**How to Use:**  
+1. **Modify the table name** in the `switchView` function to match your target table:
+   ```javascript
+   switchView("section", "<your_table_name>", targetView);
+2. **Modify the view mapping**

Client-Side Components/Client Scripts/Dynamically Switch Form View Based on Field Value/dynamic-form-view-onchange.js

@@ -0,0 +1,33 @@
+/**
+ * dynamic-form-view-onchange.js
+ *
+ * Dynamically switches the form view automatically depending on the value of a specific field.
+ * Example: If Category = Hardware → switch to ess view.
+ * Extendable by modifying the mapping object for different fields/values.
+ *
+ */
+
+function onChange(control, oldValue, newValue, isLoading) {
+  if (isLoading || !newValue) {
+    return;
+  }
+
+  // Field value → view name mapping
+  var viewMapping = {
+    "hardware": "ess",
+    "software": "itil",
+    "network": "support"
+  };
+
+  var fieldValue = newValue.toLowerCase();
+  var targetView = viewMapping[fieldValue];
+
+  if (targetView) {
+    try {
+      // Here for example the table name is incident
+      switchView("section", "incident", targetView);
+    } catch (e) {
+      console.error("View switch failed: ", e);
+    }
+  }
+}

Client-Side Components/Client Scripts/Field Completion Counter/README.md

@@ -0,0 +1,18 @@
+# Field Completion Counter
+
+## Use Case / Requirement
+Display a simple message showing how many fields are completed vs total fields on a form. This helps users track their progress while filling out forms.
+
+## Solution
+A simple onLoad client script that:
+- Counts filled vs empty fields
+- Shows completion status in an info message
+- Updates when fields are modified
+
+## Implementation
+Add this as an **onLoad** client script on any form.
+
+## Notes
+- Excludes system fields and read-only fields
+- Updates in real-time as users fill fields
+- Simple and lightweight solution

Client-Side Components/Client Scripts/Field Completion Counter/script.js

@@ -0,0 +1,54 @@
+function onLoad() {
+    // Display field completion counter
+    showFieldProgress();
+    
+    // Set up listener for field changes
+    setupProgressUpdater();
+    
+    function showFieldProgress() {
+        var allFields = g_form.getFieldNames();
+        var visibleFields = [];
+        var filledFields = 0;
+        
+        // Count visible, editable fields
+        for (var i = 0; i < allFields.length; i++) {
+            var fieldName = allFields[i];
+            
+            // Skip system fields and hidden/readonly fields
+            if (fieldName.indexOf('sys_') === 0 || 
+                !g_form.isVisible(fieldName) || 
+                g_form.isReadOnly(fieldName)) {
+                continue;
+            }
+            visibleFields.push(fieldName);
+            
+            // Check if field has value
+            if (g_form.getValue(fieldName)) {
+                filledFields++;
+            }
+        }
+        var totalFields = visibleFields.length;
+        var percentage = totalFields > 0 ? Math.round((filledFields / totalFields) * 100) : 0;
+        
+        g_form.addInfoMessage('Form Progress: ' + filledFields + '/' + totalFields + ' fields completed (' + percentage + '%)');
+    }
+    
+    function setupProgressUpdater() {
+        // Simple debounced update
+        var updateTimer;
+        
+        function updateProgress() {
+            clearTimeout(updateTimer);
+            updateTimer = setTimeout(function() {
+                g_form.clearMessages();
+                showFieldProgress();
+            }, 500);
+        }
+        
+        // Listen for any field change
+        var allFields = g_form.getFieldNames();
+        for (var i = 0; i < allFields.length; i++) {
+            g_form.addElementChangeListener(allFields[i], updateProgress);
+        }
+    }
+}

Client-Side Components/Client Scripts/Get Logged in User Information/README.md

@@ -0,0 +1,16 @@
+# The Glide User (g_user) is a global object available within the client side. It provides information about the logged-in  user.
+
+Property                   Description
+
+g_user.userID              Sys ID of the currently logged-in user
+g_user.name                User's Full name
+g_user.firstName           User's First name
+g_user.lastName            User's Last name
+
+# It also has some methods available within the client side.
+
+Method                     Description
+
+g_user.hasRole()           Determine whether the logged-in user has a specific role
+g_user.hasRoleExactly()    Do not consider the admin role while evaluating the method
+g_user.hasRoles()          You can pass two or more roles in a single method