@questwork/q-utilities 0.1.20 → 0.1.21

package/dist/index.min.cjs

@@ -69,6 +69,7 @@ __webpack_require__.d(__webpack_exports__, {
   changeCreatorOwner: () => (/* reexport */ changeCreatorOwner),
   concatStringByArray: () => (/* reexport */ concatStringByArray),
   convertString: () => (/* reexport */ convertString),
+  detectControlCharacters: () => (/* reexport */ detectControlCharacters),
   escapeRegex: () => (/* reexport */ escapeRegex),
   expressHelper: () => (/* reexport */ expressHelper),
   extractEmails: () => (/* reexport */ extractEmails),
@@ -87,6 +88,7 @@ __webpack_require__.d(__webpack_exports__, {
   objectHelper: () => (/* reexport */ objectHelper),
   pReduce: () => (/* reexport */ pReduce),
   padZeros: () => (/* reexport */ padZeros),
+  printControlCharReport: () => (/* reexport */ printControlCharReport),
   replacePlaceholders: () => (/* reexport */ replacePlaceholders),
   sanitizeText: () => (/* reexport */ sanitizeText),
   shuffleArray: () => (/* reexport */ shuffleArray),
@@ -1605,6 +1607,107 @@ function convertString(string, patternMatch = /\$\{(.+?)\}/g, value, getValueByK
 ;// ./lib/helpers/convertString/index.js
 
 
+;// ./lib/helpers/detectControlCharacters/detectControlCharacters.js
+/**
+ * Detects and reports hidden/control characters in a string without modifying it.
+ * @param {string} input - The string to analyze.
+ * @param {Object} [options] - Configuration options.
+ * @param {boolean} [options.preserveBasicWhitespace=true] - Whether to consider basic whitespace as valid.
+ * @returns {Object} Report object with detection results.
+ */
+function detectControlCharacters(input, options = {}) {
+  const {
+    preserveBasicWhitespace = true,
+    removeNewlines = false
+  } = options
+
+  if (typeof input !== 'string') {
+    return {
+      hasControlChars: false,
+      matches: [],
+      inputType: typeof input,
+      message: 'Input is not a string'
+    }
+  }
+
+  const matches = []
+  let regex
+
+  if (preserveBasicWhitespace && !removeNewlines) {
+    // Same regex as Phase 1 preserve mode - keep tab (\t), newline (\n), carriage return (\r)
+    regex = /[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x9F\u200B-\u200D\uFEFF\u202A-\u202E]/g
+  } else {
+    // Same regex as Phase 1 full removal mode - use consistent escape sequences
+    regex = /[\x00-\x1F\x7F-\x9F\u200B-\u200D\uFEFF\u202A-\u202E]/g
+  }
+
+  // Use a replacer function to capture matches without modifying the string
+  input.replace(regex, (match, offset) => {
+    matches.push({
+      character: match,
+      code: match.charCodeAt(0),
+      hex: '0x' + match.charCodeAt(0).toString(16).toUpperCase().padStart(4, '0'),
+      position: offset,
+      context: getContext(input, offset, 10) // Show surrounding text
+    })
+    return '' // Return empty but we don't use the result
+  })
+
+  return {
+    hasControlChars: matches.length > 0,
+    matches: matches,
+    totalFound: matches.length,
+    inputPreview: input.length > 50 ? input.substring(0, 50) + '...' : input,
+    inputLength: input.length,
+    optionsUsed: { preserveBasicWhitespace },
+    regexPattern: regex.toString()
+  }
+}
+
+/**
+ * Helper function to get context around a match
+ */
+function getContext(str, position, contextLength = 10) {
+  const start = Math.max(0, position - contextLength)
+  const end = Math.min(str.length, position + contextLength + 1)
+  let context = str.substring(start, end)
+  
+  // Replace control characters with their escape sequences for readability
+  context = context.replace(/[\x00-\x1F\x7F-\x9F]/g, (match) => {
+    return '\\u' + match.charCodeAt(0).toString(16).toUpperCase().padStart(4, '0')
+  })
+  
+  return context
+}
+
+/**
+ * Pretty print the detection results to console
+ */
+function printControlCharReport(report) {
+  console.log('=== Control Character Detection Report ===')
+  console.log(`Input: "${report.inputPreview}" (${report.inputLength} chars)`)
+  console.log(`Options: preserveBasicWhitespace = ${report.optionsUsed.preserveBasicWhitespace}`)
+  console.log(`Regex pattern: ${report.regexPattern}`)
+  console.log(`Control characters found: ${report.totalFound}`)
+  
+  if (report.hasControlChars) {
+    console.log('\n📋 Matches found:')
+    report.matches.forEach((match, index) => {
+      console.log(`\n${index + 1}. Character: ${JSON.stringify(match.character)}`)
+      console.log(`   Code: ${match.code} (${match.hex})`)
+      console.log(`   Position: ${match.position}`)
+      console.log(`   Context: "...${match.context}..."`)
+    })
+  } else {
+    console.log('✅ No control characters detected in Phase 1 range')
+  }
+  
+  console.log('=== End Report ===')
+}
+
+;// ./lib/helpers/detectControlCharacters/index.js
+
+
 ;// ./lib/helpers/escapeRegex/escapeRegex.js
 function escapeRegex(string) {
   return String(string).replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&')
@@ -2953,6 +3056,7 @@ function tenantPlugin(schema, options) {
 
 
 
+
 
 
 ;// ./lib/models/apiResponse/index.js
@@ -3872,24 +3976,47 @@ class StatusDocument extends Status {
 
     this.archived = this._ActionRecord.init(options.archived)
     this.completed = this._ActionRecord.init(options.completed)
-    this.drafted = this._ActionRecord.init(options.drafted)
     this.discarded = this._ActionRecord.init(options.discarded)
+    this.drafted = this._ActionRecord.init(options.drafted)
     // this.statusType = 'StatusDocument'
   }
 
-  get isValid() {
-    return super.isValid
-  }
-
   static get _classname() {
     return 'StatusDocument'
   }
+  get _classname() {
+    return 'StatusDocument'
+  }
+  get isArchived() {
+    return this.created?.timestamp !== null
+  }
+  get isCompleted() {
+    return this.completed?.timestamp !== null
+  }
+  get isDiscarded() {
+    return this.discarded?.timestamp !== null
+  }
+  get isDrafted() {
+    return this.drafted?.timestamp !== null
+  }
+  get isValid() {
+    return super.isValid
+  }
   setArchived(value, actorCode) {
     // const timestamp = value || Date.now()
     // this.archived = this.archived instanceof this._ActionRecord ? this.archived.update({ actorCode, timestamp }) : this._ActionRecord.init({ actorCode, timestamp })
     // return this
     return this.setValue(value, actorCode, 'archived')
   }
+  setCompleted(value, actorCode) {
+    return this.setValue(value, actorCode, 'completed')
+  }
+  setDiscarded(value, actorCode) {
+    return this.setValue(value, actorCode, 'discarded')
+  }
+  setDrafted(value, actorCode) {
+    return this.setValue(value, actorCode, 'drafted')
+  }
 }
 
 ;// ./lib/models/status/index.js

package/dist/q-utilities.esm.js

@@ -1508,6 +1508,107 @@ function convertString(string, patternMatch = /\$\{(.+?)\}/g, value, getValueByK
 ;// ./lib/helpers/convertString/index.js
 
 
+;// ./lib/helpers/detectControlCharacters/detectControlCharacters.js
+/**
+ * Detects and reports hidden/control characters in a string without modifying it.
+ * @param {string} input - The string to analyze.
+ * @param {Object} [options] - Configuration options.
+ * @param {boolean} [options.preserveBasicWhitespace=true] - Whether to consider basic whitespace as valid.
+ * @returns {Object} Report object with detection results.
+ */
+function detectControlCharacters(input, options = {}) {
+  const {
+    preserveBasicWhitespace = true,
+    removeNewlines = false
+  } = options
+
+  if (typeof input !== 'string') {
+    return {
+      hasControlChars: false,
+      matches: [],
+      inputType: typeof input,
+      message: 'Input is not a string'
+    }
+  }
+
+  const matches = []
+  let regex
+
+  if (preserveBasicWhitespace && !removeNewlines) {
+    // Same regex as Phase 1 preserve mode - keep tab (\t), newline (\n), carriage return (\r)
+    regex = /[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x9F\u200B-\u200D\uFEFF\u202A-\u202E]/g
+  } else {
+    // Same regex as Phase 1 full removal mode - use consistent escape sequences
+    regex = /[\x00-\x1F\x7F-\x9F\u200B-\u200D\uFEFF\u202A-\u202E]/g
+  }
+
+  // Use a replacer function to capture matches without modifying the string
+  input.replace(regex, (match, offset) => {
+    matches.push({
+      character: match,
+      code: match.charCodeAt(0),
+      hex: '0x' + match.charCodeAt(0).toString(16).toUpperCase().padStart(4, '0'),
+      position: offset,
+      context: getContext(input, offset, 10) // Show surrounding text
+    })
+    return '' // Return empty but we don't use the result
+  })
+
+  return {
+    hasControlChars: matches.length > 0,
+    matches: matches,
+    totalFound: matches.length,
+    inputPreview: input.length > 50 ? input.substring(0, 50) + '...' : input,
+    inputLength: input.length,
+    optionsUsed: { preserveBasicWhitespace },
+    regexPattern: regex.toString()
+  }
+}
+
+/**
+ * Helper function to get context around a match
+ */
+function getContext(str, position, contextLength = 10) {
+  const start = Math.max(0, position - contextLength)
+  const end = Math.min(str.length, position + contextLength + 1)
+  let context = str.substring(start, end)
+  
+  // Replace control characters with their escape sequences for readability
+  context = context.replace(/[\x00-\x1F\x7F-\x9F]/g, (match) => {
+    return '\\u' + match.charCodeAt(0).toString(16).toUpperCase().padStart(4, '0')
+  })
+  
+  return context
+}
+
+/**
+ * Pretty print the detection results to console
+ */
+function printControlCharReport(report) {
+  console.log('=== Control Character Detection Report ===')
+  console.log(`Input: "${report.inputPreview}" (${report.inputLength} chars)`)
+  console.log(`Options: preserveBasicWhitespace = ${report.optionsUsed.preserveBasicWhitespace}`)
+  console.log(`Regex pattern: ${report.regexPattern}`)
+  console.log(`Control characters found: ${report.totalFound}`)
+  
+  if (report.hasControlChars) {
+    console.log('\n📋 Matches found:')
+    report.matches.forEach((match, index) => {
+      console.log(`\n${index + 1}. Character: ${JSON.stringify(match.character)}`)
+      console.log(`   Code: ${match.code} (${match.hex})`)
+      console.log(`   Position: ${match.position}`)
+      console.log(`   Context: "...${match.context}..."`)
+    })
+  } else {
+    console.log('✅ No control characters detected in Phase 1 range')
+  }
+  
+  console.log('=== End Report ===')
+}
+
+;// ./lib/helpers/detectControlCharacters/index.js
+
+
 ;// ./lib/helpers/escapeRegex/escapeRegex.js
 function escapeRegex(string) {
   return String(string).replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&')
@@ -2856,6 +2957,7 @@ function tenantPlugin(schema, options) {
 
 
 
+
 
 
 ;// ./lib/models/apiResponse/index.js
@@ -3775,24 +3877,47 @@ class StatusDocument extends Status {
 
     this.archived = this._ActionRecord.init(options.archived)
     this.completed = this._ActionRecord.init(options.completed)
-    this.drafted = this._ActionRecord.init(options.drafted)
     this.discarded = this._ActionRecord.init(options.discarded)
+    this.drafted = this._ActionRecord.init(options.drafted)
     // this.statusType = 'StatusDocument'
   }
 
-  get isValid() {
-    return super.isValid
-  }
-
   static get _classname() {
     return 'StatusDocument'
   }
+  get _classname() {
+    return 'StatusDocument'
+  }
+  get isArchived() {
+    return this.created?.timestamp !== null
+  }
+  get isCompleted() {
+    return this.completed?.timestamp !== null
+  }
+  get isDiscarded() {
+    return this.discarded?.timestamp !== null
+  }
+  get isDrafted() {
+    return this.drafted?.timestamp !== null
+  }
+  get isValid() {
+    return super.isValid
+  }
   setArchived(value, actorCode) {
     // const timestamp = value || Date.now()
     // this.archived = this.archived instanceof this._ActionRecord ? this.archived.update({ actorCode, timestamp }) : this._ActionRecord.init({ actorCode, timestamp })
     // return this
     return this.setValue(value, actorCode, 'archived')
   }
+  setCompleted(value, actorCode) {
+    return this.setValue(value, actorCode, 'completed')
+  }
+  setDiscarded(value, actorCode) {
+    return this.setValue(value, actorCode, 'discarded')
+  }
+  setDrafted(value, actorCode) {
+    return this.setValue(value, actorCode, 'drafted')
+  }
 }
 
 ;// ./lib/models/status/index.js
@@ -3948,4 +4073,4 @@ function _makeSetCode(fieldName, options) {
 ;// ./index.js
 
 
-export { ActionRecord, ApiResponse, AwsStsS3Client, KeyValueObject, Metadata, PushEnvelope, QMeta, Repo, Service, Status, StatusDocument, TemplateCompiler, TenantAwareEntity, TrackedEntity, UniqueKeyGenerator, authorize, calculateAge, changeCreatorOwner, concatStringByArray, convertString, escapeRegex, expressHelper, extractEmails, formatDate, generalPost, getValidation, getValueByKeys_getValueByKeys as getValueByKeys, groupArrayByKey, init, initFromArray, initOnlyValidFromArray, isConvertibleToNumber, makeApiResponse, makeService, mergeArraysByKey, objectHelper, pReduce, padZeros, replacePlaceholders, sanitizeText, shuffleArray, stringFormatter, stringHelper, tenantPlugin, trackingPlugin };
+export { ActionRecord, ApiResponse, AwsStsS3Client, KeyValueObject, Metadata, PushEnvelope, QMeta, Repo, Service, Status, StatusDocument, TemplateCompiler, TenantAwareEntity, TrackedEntity, UniqueKeyGenerator, authorize, calculateAge, changeCreatorOwner, concatStringByArray, convertString, detectControlCharacters, escapeRegex, expressHelper, extractEmails, formatDate, generalPost, getValidation, getValueByKeys_getValueByKeys as getValueByKeys, groupArrayByKey, init, initFromArray, initOnlyValidFromArray, isConvertibleToNumber, makeApiResponse, makeService, mergeArraysByKey, objectHelper, pReduce, padZeros, printControlCharReport, replacePlaceholders, sanitizeText, shuffleArray, stringFormatter, stringHelper, tenantPlugin, trackingPlugin };

package/dist/q-utilities.min.js

@@ -68,6 +68,7 @@ __webpack_require__.d(__webpack_exports__, {
   changeCreatorOwner: () => (/* reexport */ changeCreatorOwner),
   concatStringByArray: () => (/* reexport */ concatStringByArray),
   convertString: () => (/* reexport */ convertString),
+  detectControlCharacters: () => (/* reexport */ detectControlCharacters),
   escapeRegex: () => (/* reexport */ escapeRegex),
   expressHelper: () => (/* reexport */ expressHelper),
   extractEmails: () => (/* reexport */ extractEmails),
@@ -86,6 +87,7 @@ __webpack_require__.d(__webpack_exports__, {
   objectHelper: () => (/* reexport */ objectHelper),
   pReduce: () => (/* reexport */ pReduce),
   padZeros: () => (/* reexport */ padZeros),
+  printControlCharReport: () => (/* reexport */ printControlCharReport),
   replacePlaceholders: () => (/* reexport */ replacePlaceholders),
   sanitizeText: () => (/* reexport */ sanitizeText),
   shuffleArray: () => (/* reexport */ shuffleArray),
@@ -1604,6 +1606,107 @@ function convertString(string, patternMatch = /\$\{(.+?)\}/g, value, getValueByK
 ;// ./lib/helpers/convertString/index.js
 
 
+;// ./lib/helpers/detectControlCharacters/detectControlCharacters.js
+/**
+ * Detects and reports hidden/control characters in a string without modifying it.
+ * @param {string} input - The string to analyze.
+ * @param {Object} [options] - Configuration options.
+ * @param {boolean} [options.preserveBasicWhitespace=true] - Whether to consider basic whitespace as valid.
+ * @returns {Object} Report object with detection results.
+ */
+function detectControlCharacters(input, options = {}) {
+  const {
+    preserveBasicWhitespace = true,
+    removeNewlines = false
+  } = options
+
+  if (typeof input !== 'string') {
+    return {
+      hasControlChars: false,
+      matches: [],
+      inputType: typeof input,
+      message: 'Input is not a string'
+    }
+  }
+
+  const matches = []
+  let regex
+
+  if (preserveBasicWhitespace && !removeNewlines) {
+    // Same regex as Phase 1 preserve mode - keep tab (\t), newline (\n), carriage return (\r)
+    regex = /[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x9F\u200B-\u200D\uFEFF\u202A-\u202E]/g
+  } else {
+    // Same regex as Phase 1 full removal mode - use consistent escape sequences
+    regex = /[\x00-\x1F\x7F-\x9F\u200B-\u200D\uFEFF\u202A-\u202E]/g
+  }
+
+  // Use a replacer function to capture matches without modifying the string
+  input.replace(regex, (match, offset) => {
+    matches.push({
+      character: match,
+      code: match.charCodeAt(0),
+      hex: '0x' + match.charCodeAt(0).toString(16).toUpperCase().padStart(4, '0'),
+      position: offset,
+      context: getContext(input, offset, 10) // Show surrounding text
+    })
+    return '' // Return empty but we don't use the result
+  })
+
+  return {
+    hasControlChars: matches.length > 0,
+    matches: matches,
+    totalFound: matches.length,
+    inputPreview: input.length > 50 ? input.substring(0, 50) + '...' : input,
+    inputLength: input.length,
+    optionsUsed: { preserveBasicWhitespace },
+    regexPattern: regex.toString()
+  }
+}
+
+/**
+ * Helper function to get context around a match
+ */
+function getContext(str, position, contextLength = 10) {
+  const start = Math.max(0, position - contextLength)
+  const end = Math.min(str.length, position + contextLength + 1)
+  let context = str.substring(start, end)
+  
+  // Replace control characters with their escape sequences for readability
+  context = context.replace(/[\x00-\x1F\x7F-\x9F]/g, (match) => {
+    return '\\u' + match.charCodeAt(0).toString(16).toUpperCase().padStart(4, '0')
+  })
+  
+  return context
+}
+
+/**
+ * Pretty print the detection results to console
+ */
+function printControlCharReport(report) {
+  console.log('=== Control Character Detection Report ===')
+  console.log(`Input: "${report.inputPreview}" (${report.inputLength} chars)`)
+  console.log(`Options: preserveBasicWhitespace = ${report.optionsUsed.preserveBasicWhitespace}`)
+  console.log(`Regex pattern: ${report.regexPattern}`)
+  console.log(`Control characters found: ${report.totalFound}`)
+  
+  if (report.hasControlChars) {
+    console.log('\n📋 Matches found:')
+    report.matches.forEach((match, index) => {
+      console.log(`\n${index + 1}. Character: ${JSON.stringify(match.character)}`)
+      console.log(`   Code: ${match.code} (${match.hex})`)
+      console.log(`   Position: ${match.position}`)
+      console.log(`   Context: "...${match.context}..."`)
+    })
+  } else {
+    console.log('✅ No control characters detected in Phase 1 range')
+  }
+  
+  console.log('=== End Report ===')
+}
+
+;// ./lib/helpers/detectControlCharacters/index.js
+
+
 ;// ./lib/helpers/escapeRegex/escapeRegex.js
 function escapeRegex(string) {
   return String(string).replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&')
@@ -2952,6 +3055,7 @@ function tenantPlugin(schema, options) {
 
 
 
+
 
 
 ;// ./lib/models/apiResponse/index.js
@@ -3871,24 +3975,47 @@ class StatusDocument extends Status {
 
     this.archived = this._ActionRecord.init(options.archived)
     this.completed = this._ActionRecord.init(options.completed)
-    this.drafted = this._ActionRecord.init(options.drafted)
     this.discarded = this._ActionRecord.init(options.discarded)
+    this.drafted = this._ActionRecord.init(options.drafted)
     // this.statusType = 'StatusDocument'
   }
 
-  get isValid() {
-    return super.isValid
-  }
-
   static get _classname() {
     return 'StatusDocument'
   }
+  get _classname() {
+    return 'StatusDocument'
+  }
+  get isArchived() {
+    return this.created?.timestamp !== null
+  }
+  get isCompleted() {
+    return this.completed?.timestamp !== null
+  }
+  get isDiscarded() {
+    return this.discarded?.timestamp !== null
+  }
+  get isDrafted() {
+    return this.drafted?.timestamp !== null
+  }
+  get isValid() {
+    return super.isValid
+  }
   setArchived(value, actorCode) {
     // const timestamp = value || Date.now()
     // this.archived = this.archived instanceof this._ActionRecord ? this.archived.update({ actorCode, timestamp }) : this._ActionRecord.init({ actorCode, timestamp })
     // return this
     return this.setValue(value, actorCode, 'archived')
   }
+  setCompleted(value, actorCode) {
+    return this.setValue(value, actorCode, 'completed')
+  }
+  setDiscarded(value, actorCode) {
+    return this.setValue(value, actorCode, 'discarded')
+  }
+  setDrafted(value, actorCode) {
+    return this.setValue(value, actorCode, 'drafted')
+  }
 }
 
 ;// ./lib/models/status/index.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@questwork/q-utilities",
-  "version": "0.1.20",
+  "version": "0.1.21",
   "description": "Questwork QUtilities",
   "author": {
     "name": "Questwork Consulting Limited",