STUTL-37: Add escapeCqlValueAllowAsterisk to only escape " \ ^ ? and not escape *.

CHANGELOG.md

@@ -6,6 +6,7 @@
 * Add `getSourceSuppressor` to build action suppressor based on an entry sources. Refs STUTL-34.
 * *BREAKING* Bump `react` to `v18`. Refs STUTL-35.
 * *BREAKING* `escapeCqlValue` escapes `" \ ^ * ?`. Refs STUTL-33.
+* Add `escapeCqlValueAllowAsterisk` to only escape `" \ ^ ?` and not escape `*`. Refs STUTL-37.
 
 ## [5.2.1](https://github.com/folio-org/stripes-util/tree/v5.2.1) (2023-01-30)
 [Full Changelog](https://github.com/folio-org/stripes-util/compare/v5.2.0...v5.2.1)

lib/escapeCqlValueAllowAsterisk.js

@@ -0,0 +1,10 @@
+/**
+ * Escape quote ("), backslash (\), caret(^), question mark (?) characters in a string
+ * by pre-pending them with a single backslash. Don't escape asterisk (*).
+ *
+ * @param string a string
+ * @return string the input string with the four special CQL characters masked
+ */
+export default function escapeCqlValueAllowAsterisk(str) {
+  return str.replace(/["\\^?]/g, c => '\\' + c);
+}

lib/escapeCqlValueAllowAsterisk.test.js

@@ -0,0 +1,14 @@
+import { describe, expect, test } from '@jest/globals';
+
+import escapeCqlValueAllowAsterisk from './escapeCqlValueAllowAsterisk';
+
+describe('escapeCqlValueAllowAsterisk only escapes four CQL special characters and does not escape asterisk', () => {
+  test.each([
+    ['', ''],
+    ['foo_bar baz%', 'foo_bar baz%'],
+    ['f"o\\o^b*a?r', 'f\\"o\\\\o\\^b*a\\?r'],
+    ['?*^\\"??**^^\\\\""', '\\?*\\^\\\\\\"\\?\\?**\\^\\^\\\\\\\\\\"\\"'],
+  ])('escapeCqlValue(%p) should be %p', (raw, expected) => {
+    expect(escapeCqlValueAllowAsterisk(raw)).toEqual(expected);
+  });
+});