@prairielearn/sanitize 2.0.9 → 2.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @prairielearn/sanitize
2
2
 
3
+ ## 2.0.11
4
+
5
+ ### Patch Changes
6
+
7
+ - 984dc62: Upgrade all JavaScript dependencies
8
+
9
+ ## 2.0.10
10
+
11
+ ### Patch Changes
12
+
13
+ - 49bb3fa: Upgrade all JavaScript dependencies
14
+
3
15
  ## 2.0.9
4
16
 
5
17
  ### Patch Changes
package/dist/index.js CHANGED
@@ -14,7 +14,7 @@ export function sanitizeObject(value) {
14
14
  return value.map(sanitizeObject);
15
15
  }
16
16
  else if (typeof value === 'string') {
17
- return value.replace('\u0000', '\\u0000');
17
+ return value.replaceAll('\u0000', '\\u0000');
18
18
  }
19
19
  else if (typeof value === 'object') {
20
20
  const sanitized = Object.entries(value).map(([key, value]) => {
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAI,KAAQ;IACxC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,IAAS,CAAC;IACnB,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC,GAAG,CAAC,cAAc,CAAM,CAAC;IACxC,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAM,CAAC;IACjD,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC3D,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QACH,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC5C,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACjB,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAS,CAAM,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,GAAG,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,0BAA0B,CAAI,KAAQ,EAAE,SAAiB;IACvE,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,IAAS,CAAC;IACnB,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,IAAI,KAAK,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG,gBAAgB,CAAM,CAAC;IACjE,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,0BAA0B,CAAC,KAAK,EAAE,SAAS,CAAC,CAAM,CAAC;IACjF,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACxD,GAAG,CAAC,GAAG,CAAC,GAAG,0BAA0B,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YACxD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAS,CAAM,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC","sourcesContent":["/**\n * Recursively traverse an object and replace null bytes (\\u0000) with the\n * literal string \"\\u0000\". This produces a new object and does not modify the\n * provided object.\n *\n * @param value The object to be sanitized.\n * @return The sanitized object.\n */\nexport function sanitizeObject<T>(value: T): T {\n if (value === null) {\n return null as T;\n } else if (Array.isArray(value)) {\n return value.map(sanitizeObject) as T;\n } else if (typeof value === 'string') {\n return value.replace('\\u0000', '\\\\u0000') as T;\n } else if (typeof value === 'object') {\n const sanitized = Object.entries(value).map(([key, value]) => {\n return [key, sanitizeObject(value)];\n });\n return sanitized.reduce((acc, [key, value]) => {\n acc[key] = value;\n return acc;\n }, {} as any) as T;\n } else {\n return value;\n }\n}\n\n/**\n * Escape special characters in a RegExp string\n * Source: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#Using_special_characters\n *\n * @param str A literal string to act as a match for RegExp objects\n * @return A string literal ready to match\n */\nexport function escapeRegExp(str: string) {\n return str.replace(/[.*+\\-?^${}()|[\\]\\\\/]/g, '\\\\$&');\n}\n\n/**\n * Recursively truncates all strings in a value to a maximum length.\n */\nexport function recursivelyTruncateStrings<T>(value: T, maxLength: number): T {\n if (value === null) {\n return null as T;\n } else if (typeof value === 'string') {\n if (value.length <= maxLength) {\n return value;\n }\n return (value.substring(0, maxLength) + '...[truncated]') as T;\n } else if (Array.isArray(value)) {\n return value.map((value) => recursivelyTruncateStrings(value, maxLength)) as T;\n } else if (typeof value === 'object') {\n return Object.entries(value).reduce((acc, [key, value]) => {\n acc[key] = recursivelyTruncateStrings(value, maxLength);\n return acc;\n }, {} as any) as T;\n } else {\n return value;\n }\n}\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAI,KAAQ;IACxC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,IAAS,CAAC;IACnB,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC,GAAG,CAAC,cAAc,CAAM,CAAC;IACxC,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,CAAM,CAAC;IACpD,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC3D,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QACH,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC5C,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACjB,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAS,CAAM,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,GAAG,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,0BAA0B,CAAI,KAAQ,EAAE,SAAiB;IACvE,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,IAAS,CAAC;IACnB,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,IAAI,KAAK,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG,gBAAgB,CAAM,CAAC;IACjE,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,0BAA0B,CAAC,KAAK,EAAE,SAAS,CAAC,CAAM,CAAC;IACjF,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACxD,GAAG,CAAC,GAAG,CAAC,GAAG,0BAA0B,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YACxD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAS,CAAM,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC","sourcesContent":["/**\n * Recursively traverse an object and replace null bytes (\\u0000) with the\n * literal string \"\\u0000\". This produces a new object and does not modify the\n * provided object.\n *\n * @param value The object to be sanitized.\n * @return The sanitized object.\n */\nexport function sanitizeObject<T>(value: T): T {\n if (value === null) {\n return null as T;\n } else if (Array.isArray(value)) {\n return value.map(sanitizeObject) as T;\n } else if (typeof value === 'string') {\n return value.replaceAll('\\u0000', '\\\\u0000') as T;\n } else if (typeof value === 'object') {\n const sanitized = Object.entries(value).map(([key, value]) => {\n return [key, sanitizeObject(value)];\n });\n return sanitized.reduce((acc, [key, value]) => {\n acc[key] = value;\n return acc;\n }, {} as any) as T;\n } else {\n return value;\n }\n}\n\n/**\n * Escape special characters in a RegExp string\n * Source: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#Using_special_characters\n *\n * @param str A literal string to act as a match for RegExp objects\n * @return A string literal ready to match\n */\nexport function escapeRegExp(str: string) {\n return str.replace(/[.*+\\-?^${}()|[\\]\\\\/]/g, '\\\\$&');\n}\n\n/**\n * Recursively truncates all strings in a value to a maximum length.\n */\nexport function recursivelyTruncateStrings<T>(value: T, maxLength: number): T {\n if (value === null) {\n return null as T;\n } else if (typeof value === 'string') {\n if (value.length <= maxLength) {\n return value;\n }\n return (value.substring(0, maxLength) + '...[truncated]') as T;\n } else if (Array.isArray(value)) {\n return value.map((value) => recursivelyTruncateStrings(value, maxLength)) as T;\n } else if (typeof value === 'object') {\n return Object.entries(value).reduce((acc, [key, value]) => {\n acc[key] = recursivelyTruncateStrings(value, maxLength);\n return acc;\n }, {} as any) as T;\n } else {\n return value;\n }\n}\n"]}
@@ -1,5 +1,5 @@
1
1
  import { assert } from 'chai';
2
- import { sanitizeObject, recursivelyTruncateStrings } from './index.js';
2
+ import { recursivelyTruncateStrings, sanitizeObject } from './index.js';
3
3
  describe('sanitizeObject', () => {
4
4
  it('sanitizes an empty object', () => {
5
5
  const input = {};
@@ -11,6 +11,11 @@ describe('sanitizeObject', () => {
11
11
  const expected = { test: 'test\\u0000ing' };
12
12
  assert.deepEqual(expected, sanitizeObject(input));
13
13
  });
14
+ it('handles multiple null bytes in top-level string', () => {
15
+ const input = { test: 'test\u0000ing\u0000' };
16
+ const expected = { test: 'test\\u0000ing\\u0000' };
17
+ assert.deepEqual(expected, sanitizeObject(input));
18
+ });
14
19
  it('handles null byte in nested string', () => {
15
20
  const input = {
16
21
  test: {
@@ -1 +1 @@
1
- {"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAExE,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;QAC5C,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE;gBACJ,UAAU,EAAE,eAAe;aAC5B;SACF,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE;gBACJ,UAAU,EAAE,gBAAgB;aAC7B;SACF,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC;SACnC,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC;SACpC,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE;gBACJ,KAAK,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC;aACpC;SACF,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE;gBACJ,KAAK,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC;aACrC;SACF,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe;YACrB,CAAC,EAAE,CAAC;YACJ,CAAC,EAAE,IAAI;SACR,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE,gBAAgB;YACtB,CAAC,EAAE,CAAC;YACJ,CAAC,EAAE,IAAI;SACR,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe;YACrB,CAAC,EAAE,IAAI;SACR,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE,gBAAgB;YACtB,CAAC,EAAE,IAAI;SACR,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACjF,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC7B,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC,EAAE;YACpE,IAAI,EAAE,oBAAoB;SAC3B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE;YACtE,IAAI,EAAE,CAAC,oBAAoB,CAAC;SAC7B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE;YAChF,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;SACvC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { assert } from 'chai';\n\nimport { sanitizeObject, recursivelyTruncateStrings } from './index.js';\n\ndescribe('sanitizeObject', () => {\n it('sanitizes an empty object', () => {\n const input = {};\n const expected = {};\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles null byte in top-level string', () => {\n const input = { test: 'test\\u0000ing' };\n const expected = { test: 'test\\\\u0000ing' };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles null byte in nested string', () => {\n const input = {\n test: {\n nestedTest: 'test\\u0000ing',\n },\n };\n const expected = {\n test: {\n nestedTest: 'test\\\\u0000ing',\n },\n };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles null byte in top-level array', () => {\n const input = {\n test: ['testing', 'test\\u0000ing'],\n };\n const expected = {\n test: ['testing', 'test\\\\u0000ing'],\n };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles null byte in nested array', () => {\n const input = {\n test: {\n test2: ['testing', 'test\\u0000ing'],\n },\n };\n const expected = {\n test: {\n test2: ['testing', 'test\\\\u0000ing'],\n },\n };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles numbers correctly', () => {\n const input = {\n test: 'test\\u0000ing',\n a: 1,\n b: 2.45,\n };\n const expected = {\n test: 'test\\\\u0000ing',\n a: 1,\n b: 2.45,\n };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles null values correctly', () => {\n const input = {\n test: 'test\\u0000ing',\n a: null,\n };\n const expected = {\n test: 'test\\\\u0000ing',\n a: null,\n };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n});\n\ndescribe('recursivelyTruncateStrings', () => {\n it('handles empty object', () => {\n assert.deepEqual(recursivelyTruncateStrings({}, 10), {});\n });\n\n it('handles null and undefined', () => {\n assert.deepEqual(recursivelyTruncateStrings({ test: null }, 10), { test: null });\n assert.deepEqual(recursivelyTruncateStrings({ test: undefined }, 10), { test: undefined });\n });\n\n it('handles legal string', () => {\n assert.deepEqual(recursivelyTruncateStrings({ test: 'test' }, 10), { test: 'test' });\n });\n\n it('handles long string', () => {\n assert.deepEqual(recursivelyTruncateStrings({ test: 'testtest' }, 4), {\n test: 'test...[truncated]',\n });\n });\n\n it('handles long string in array', () => {\n assert.deepEqual(recursivelyTruncateStrings({ test: ['testtest'] }, 4), {\n test: ['test...[truncated]'],\n });\n });\n\n it('handles long string in object in array', () => {\n assert.deepEqual(recursivelyTruncateStrings({ test: [{ test: 'testtest' }] }, 4), {\n test: [{ test: 'test...[truncated]' }],\n });\n });\n});\n"]}
1
+ {"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAExE,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;QAC5C,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;QAC9C,MAAM,QAAQ,GAAG,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;QACnD,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE;gBACJ,UAAU,EAAE,eAAe;aAC5B;SACF,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE;gBACJ,UAAU,EAAE,gBAAgB;aAC7B;SACF,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC;SACnC,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC;SACpC,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE;gBACJ,KAAK,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC;aACpC;SACF,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE;gBACJ,KAAK,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC;aACrC;SACF,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe;YACrB,CAAC,EAAE,CAAC;YACJ,CAAC,EAAE,IAAI;SACR,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE,gBAAgB;YACtB,CAAC,EAAE,CAAC;YACJ,CAAC,EAAE,IAAI;SACR,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe;YACrB,CAAC,EAAE,IAAI;SACR,CAAC;QACF,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE,gBAAgB;YACtB,CAAC,EAAE,IAAI;SACR,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACjF,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC7B,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC,EAAE;YACpE,IAAI,EAAE,oBAAoB;SAC3B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE;YACtE,IAAI,EAAE,CAAC,oBAAoB,CAAC;SAC7B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,CAAC,SAAS,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE;YAChF,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;SACvC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { assert } from 'chai';\n\nimport { recursivelyTruncateStrings, sanitizeObject } from './index.js';\n\ndescribe('sanitizeObject', () => {\n it('sanitizes an empty object', () => {\n const input = {};\n const expected = {};\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles null byte in top-level string', () => {\n const input = { test: 'test\\u0000ing' };\n const expected = { test: 'test\\\\u0000ing' };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles multiple null bytes in top-level string', () => {\n const input = { test: 'test\\u0000ing\\u0000' };\n const expected = { test: 'test\\\\u0000ing\\\\u0000' };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles null byte in nested string', () => {\n const input = {\n test: {\n nestedTest: 'test\\u0000ing',\n },\n };\n const expected = {\n test: {\n nestedTest: 'test\\\\u0000ing',\n },\n };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles null byte in top-level array', () => {\n const input = {\n test: ['testing', 'test\\u0000ing'],\n };\n const expected = {\n test: ['testing', 'test\\\\u0000ing'],\n };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles null byte in nested array', () => {\n const input = {\n test: {\n test2: ['testing', 'test\\u0000ing'],\n },\n };\n const expected = {\n test: {\n test2: ['testing', 'test\\\\u0000ing'],\n },\n };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles numbers correctly', () => {\n const input = {\n test: 'test\\u0000ing',\n a: 1,\n b: 2.45,\n };\n const expected = {\n test: 'test\\\\u0000ing',\n a: 1,\n b: 2.45,\n };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n\n it('handles null values correctly', () => {\n const input = {\n test: 'test\\u0000ing',\n a: null,\n };\n const expected = {\n test: 'test\\\\u0000ing',\n a: null,\n };\n assert.deepEqual(expected, sanitizeObject(input));\n });\n});\n\ndescribe('recursivelyTruncateStrings', () => {\n it('handles empty object', () => {\n assert.deepEqual(recursivelyTruncateStrings({}, 10), {});\n });\n\n it('handles null and undefined', () => {\n assert.deepEqual(recursivelyTruncateStrings({ test: null }, 10), { test: null });\n assert.deepEqual(recursivelyTruncateStrings({ test: undefined }, 10), { test: undefined });\n });\n\n it('handles legal string', () => {\n assert.deepEqual(recursivelyTruncateStrings({ test: 'test' }, 10), { test: 'test' });\n });\n\n it('handles long string', () => {\n assert.deepEqual(recursivelyTruncateStrings({ test: 'testtest' }, 4), {\n test: 'test...[truncated]',\n });\n });\n\n it('handles long string in array', () => {\n assert.deepEqual(recursivelyTruncateStrings({ test: ['testtest'] }, 4), {\n test: ['test...[truncated]'],\n });\n });\n\n it('handles long string in object in array', () => {\n assert.deepEqual(recursivelyTruncateStrings({ test: [{ test: 'testtest' }] }, 4), {\n test: [{ test: 'test...[truncated]' }],\n });\n });\n});\n"]}
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@prairielearn/sanitize",
3
- "version": "2.0.9",
3
+ "version": "2.0.11",
4
4
  "type": "module",
5
- "main": "./dist/index.js",
6
5
  "repository": {
7
6
  "type": "git",
8
7
  "url": "https://github.com/PrairieLearn/PrairieLearn.git",
9
8
  "directory": "packages/sanitize"
10
9
  },
10
+ "main": "./dist/index.js",
11
11
  "scripts": {
12
12
  "build": "tsc",
13
13
  "dev": "tsc --watch --preserveWatchOutput",
@@ -15,12 +15,12 @@
15
15
  },
16
16
  "devDependencies": {
17
17
  "@prairielearn/tsconfig": "^0.0.0",
18
- "@types/node": "^20.17.16",
18
+ "@types/node": "^20.17.28",
19
19
  "c8": "^10.1.3",
20
- "chai": "^5.1.2",
21
- "mocha": "^10.8.2",
22
- "tsx": "^4.19.2",
23
- "typescript": "^5.7.3"
20
+ "chai": "^5.2.0",
21
+ "mocha": "^11.1.0",
22
+ "tsx": "^4.19.3",
23
+ "typescript": "^5.8.2"
24
24
  },
25
25
  "c8": {
26
26
  "reporter": [
package/src/index.test.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { assert } from 'chai';
2
2
 
3
- import { sanitizeObject, recursivelyTruncateStrings } from './index.js';
3
+ import { recursivelyTruncateStrings, sanitizeObject } from './index.js';
4
4
 
5
5
  describe('sanitizeObject', () => {
6
6
  it('sanitizes an empty object', () => {
@@ -15,6 +15,12 @@ describe('sanitizeObject', () => {
15
15
  assert.deepEqual(expected, sanitizeObject(input));
16
16
  });
17
17
 
18
+ it('handles multiple null bytes in top-level string', () => {
19
+ const input = { test: 'test\u0000ing\u0000' };
20
+ const expected = { test: 'test\\u0000ing\\u0000' };
21
+ assert.deepEqual(expected, sanitizeObject(input));
22
+ });
23
+
18
24
  it('handles null byte in nested string', () => {
19
25
  const input = {
20
26
  test: {
package/src/index.ts CHANGED
@@ -12,7 +12,7 @@ export function sanitizeObject<T>(value: T): T {
12
12
  } else if (Array.isArray(value)) {
13
13
  return value.map(sanitizeObject) as T;
14
14
  } else if (typeof value === 'string') {
15
- return value.replace('\u0000', '\\u0000') as T;
15
+ return value.replaceAll('\u0000', '\\u0000') as T;
16
16
  } else if (typeof value === 'object') {
17
17
  const sanitized = Object.entries(value).map(([key, value]) => {
18
18
  return [key, sanitizeObject(value)];