Merge branch 'ServiceNowDevProgram:main' into Hacktoberfest-2025-(1st-Pull-Request)

Author: Sriharsha19

.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({

CONTRIBUTING.md

@@ -31,10 +31,25 @@ If you plan to submit another pull request while your original is still pending,
 - **Descriptive Pull Request Titles**: Your pull request must have explicit and descriptive titles that accurately represent the changes made.
 - **Scope Adherence**: Changes that fall outside the described scope will result in the entire pull request being rejected.
 - **Quality Over Quantity**: Low-effort or spam pull requests will be marked accordingly.
-- **Expanded Snippets**: Code snippets reused from the [ServiceNow Documentation](https://docs.servicenow.com/) or [API References](https://developer.servicenow.com/dev.do#!/reference/) are acceptable only if they are expanded in a meaningful way (e.g., with additional context, documentation, or variations). Remember: *“QUANTITY IS FUN, QUALITY IS KEY.”*
+- **Expanded Snippets**: Code snippets reused from the [ServiceNow Documentation](https://docs.servicenow.com/) or [API References](https://developer.servicenow.com/dev.do#!/reference/) are acceptable only if they are expanded in a meaningful way (e.g., with additional context, documentation, or variations). Remember: *"QUANTITY IS FUN, QUALITY IS KEY."*
 - **Relevance**: Code should be relevant to ServiceNow Developers.
 - **ES2021 Compatibility**: While ES2021 is allowed, we encourage you to disclose if your code is using ES2021 features, as not everyone may be working with ES2021-enabled applications.
 
+## Core Documentation File Changes
+
+**IMPORTANT**: For changes to core documentation files (README.md, CONTRIBUTING.md, LICENSE, etc.), contributors must:
+
+1. **Submit an Issue First**: Before making any changes to core documentation files, create an issue describing:
+   - What you intend to edit
+   - Why the change is needed
+   - Your proposed approach
+
+2. **Get Assignment**: Wait to be assigned to the issue by a maintainer before submitting a PR.
+
+3. **Reference the Issue**: Include the issue number in your PR title and description.
+
+This process helps prevent merge conflicts when multiple contributors want to update the same documentation files and ensures all changes align with the project's direction.
+
 ## Repository Structure
 
 **IMPORTANT**: The repository has been reorganized into major categories. All new contributions MUST follow this structure for PR approval.

Client-Side Components/Catalog Client Script/Auto Save Draft Feature/README.md

@@ -0,0 +1,114 @@
+# Auto Save Draft Feature for Catalog Items
+
+This snippet provides automatic draft saving functionality for ServiceNow Catalog Items, helping prevent data loss by automatically saving form data at regular intervals.
+
+## Overview
+
+The feature includes two implementations:
+1. Basic Implementation (`basic_implementation.js`)
+2. Advanced Implementation (`advanced_implementation.js`)
+
+## Basic Implementation
+
+### Features
+- Auto-saves form data every minute
+- Stores single draft in sessionStorage
+- Provides draft restoration on form load
+- Basic error handling and user feedback
+
+### Usage
+```javascript
+// Apply in Catalog Client Script
+// Select "onLoad" for "Client script runs"
+// Copy content from basic_implementation.js
+```
+
+## Advanced Implementation
+
+### Enhanced Features
+- Multiple draft support (keeps last 3 drafts)
+- Advanced draft management
+- Draft selection dialog
+- Detailed metadata tracking
+- Improved error handling
+- User-friendly notifications
+
+### Usage
+```javascript
+// Apply in Catalog Client Script
+// Select "onLoad" for "Client script runs"
+// Copy content from advanced_implementation.js
+```
+
+## Technical Details
+
+### Dependencies
+- ServiceNow Platform UI Framework
+- GlideForm API
+- GlideModal (advanced implementation only)
+
+### Browser Support
+- Modern browsers with sessionStorage support
+- ES5+ compatible
+
+### Security Considerations
+- Uses browser's sessionStorage (cleared on session end)
+- No sensitive data transmission
+- Instance-specific storage
+
+## Implementation Guide
+
+1. Create a new Catalog Client Script:
+   - Table: Catalog Client Script [catalog_script_client]
+   - Type: onLoad
+   - Active: true
+
+2. Choose implementation:
+   - For basic needs: Copy `basic_implementation.js`
+   - For advanced features: Copy `advanced_implementation.js`
+
+3. Apply to desired Catalog Items:
+   - Select applicable Catalog Items
+   - Test in dev environment first
+
+## Best Practices
+
+1. Testing:
+   - Test with various form states
+   - Verify draft restoration
+   - Check browser storage limits
+
+2. Performance:
+   - Default 60-second interval is recommended
+   - Adjust based on form complexity
+   - Monitor browser memory usage
+
+3. User Experience:
+   - Clear feedback messages
+   - Confirmation dialogs
+   - Error notifications
+
+## Limitations
+
+- Browser session dependent
+- Storage size limits
+- Form field compatibility varies
+
+## Troubleshooting
+
+Common issues and solutions:
+1. Draft not saving
+   - Check browser console for errors
+   - Verify sessionStorage availability
+   - Check form modification detection
+
+2. Restoration fails
+   - Validate stored data format
+   - Check browser storage permissions
+   - Verify form field compatibility
+
+## Version Information
+
+- Compatible with ServiceNow: Rome and later
+- Browser Requirements: Modern browsers with ES5+ support
+- Last Updated: October 2025

Client-Side Components/Catalog Client Script/Auto Save Draft Feature/advanced_implementation.js

@@ -0,0 +1,125 @@
+/**
+ * Advanced Auto-save Draft Implementation with Enhanced Features
+ * This version adds multi-draft support and advanced error handling
+ */
+
+function onLoad() {
+    var autosaveInterval = 60000; // 1 minute
+    var maxDrafts = 3; // Maximum number of drafts to keep
+    
+    // Initialize draft manager
+    initializeDraftManager();
+    
+    // Try to restore previous draft
+    restoreLastDraft();
+    
+    // Set up auto-save interval
+    setInterval(function() {
+        if (g_form.isModified()) {
+            saveAdvancedDraft();
+        }
+    }, autosaveInterval);
+}
+
+function initializeDraftManager() {
+    window.draftManager = {
+        maxDrafts: 3,
+        draftPrefix: 'catalogDraft_' + g_form.getUniqueValue() + '_',
+        
+        getAllDrafts: function() {
+            var drafts = [];
+            for (var i = 0; i < sessionStorage.length; i++) {
+                var key = sessionStorage.key(i);
+                if (key.startsWith(this.draftPrefix)) {
+                    drafts.push({
+                        key: key,
+                        data: JSON.parse(sessionStorage.getItem(key))
+                    });
+                }
+            }
+            return drafts.sort((a, b) => b.data.timestamp - a.data.timestamp);
+        },
+        
+        cleanup: function() {
+            var drafts = this.getAllDrafts();
+            if (drafts.length > this.maxDrafts) {
+                drafts.slice(this.maxDrafts).forEach(function(draft) {
+                    sessionStorage.removeItem(draft.key);
+                });
+            }
+        }
+    };
+}
+
+function saveAdvancedDraft() {
+    try {
+        var draftData = {};
+        g_form.serialize(draftData);
+        
+        // Add metadata
+        var draftKey = window.draftManager.draftPrefix + new Date().getTime();
+        var draftInfo = {
+            timestamp: new Date().getTime(),
+            data: draftData,
+            user: g_user.userName,
+            catalog_item: g_form.getTableName(),
+            fields_modified: g_form.getModifiedFields()
+        };
+        
+        sessionStorage.setItem(draftKey, JSON.stringify(draftInfo));
+        window.draftManager.cleanup();
+        
+        // Show success message with draft count
+        var remainingDrafts = window.draftManager.getAllDrafts().length;
+        g_form.addInfoMessage('Draft saved. You have ' + remainingDrafts + ' saved draft(s).');
+        
+    } catch (e) {
+        console.error('Error saving draft: ' + e);
+        g_form.addErrorMessage('Failed to save draft: ' + e.message);
+    }
+}
+
+function restoreLastDraft() {
+    try {
+        var drafts = window.draftManager.getAllDrafts();
+        
+        if (drafts.length > 0) {
+            // If multiple drafts exist, show selection dialog
+            if (drafts.length > 1) {
+                showDraftSelectionDialog(drafts);
+            } else {
+                promptToRestoreDraft(drafts[0].data);
+            }
+        }
+    } catch (e) {
+        console.error('Error restoring draft: ' + e);
+        g_form.addErrorMessage('Failed to restore draft: ' + e.message);
+    }
+}
+
+function showDraftSelectionDialog(drafts) {
+    var dialog = new GlideModal('select_draft_dialog');
+    dialog.setTitle('Available Drafts');
+    
+    var html = '<div class="draft-list">';
+    drafts.forEach(function(draft, index) {
+        var date = new Date(draft.data.timestamp).toLocaleString();
+        html += '<div class="draft-item" onclick="selectDraft(' + index + ')">';
+        html += '<strong>Draft ' + (index + 1) + '</strong> - ' + date;
+        html += '<br>Modified fields: ' + draft.data.fields_modified.join(', ');
+        html += '</div>';
+    });
+    html += '</div>';
+    
+    dialog.renderWithContent(html);
+}
+
+function promptToRestoreDraft(draftInfo) {
+    var timestamp = new Date(draftInfo.timestamp);
+    if (confirm('A draft from ' + timestamp.toLocaleString() + ' was found. Would you like to restore it?')) {
+        Object.keys(draftInfo.data).forEach(function(field) {
+            g_form.setValue(field, draftInfo.data[field]);
+        });
+        g_form.addInfoMessage('Draft restored from ' + timestamp.toLocaleString());
+    }
+}