Change the justification API shape to prevent swapping arguments by mistake.

PiperOrigin-RevId: 591276650

Author: neuracr

src/restricted/reviewed.ts

@@ -59,10 +59,10 @@ function assertValidJustification(justification: string) {
  */
 export function htmlSafeByReview(
   html: string,
-  justification: string,
+  options: {justification: string},
 ): SafeHtml {
   if (process.env.NODE_ENV !== 'production') {
-    assertValidJustification(justification);
+    assertValidJustification(options.justification);
   }
   return createHtmlInternal(html);
 }
@@ -78,10 +78,10 @@ export function htmlSafeByReview(
  */
 export function scriptSafeByReview(
   script: string,
-  justification: string,
+  options: {justification: string},
 ): SafeScript {
   if (process.env.NODE_ENV !== 'production') {
-    assertValidJustification(justification);
+    assertValidJustification(options.justification);
   }
   return createScriptInternal(script);
 }
@@ -97,10 +97,10 @@ export function scriptSafeByReview(
  */
 export function resourceUrlSafeByReview(
   url: string,
-  justification: string,
+  options: {justification: string},
 ): TrustedResourceUrl {
   if (process.env.NODE_ENV !== 'production') {
-    assertValidJustification(justification);
+    assertValidJustification(options.justification);
   }
   return createResourceUrlInternal(url);
 }
@@ -117,10 +117,10 @@ export function resourceUrlSafeByReview(
  */
 export function styleSheetSafeByReview(
   stylesheet: string,
-  justification: string,
+  options: {justification: string},
 ): SafeStyleSheet {
   if (process.env.NODE_ENV !== 'production') {
-    assertValidJustification(justification);
+    assertValidJustification(options.justification);
   }
   return createStyleSheetInternal(stylesheet);
 }

test/restricted/reviewed_test.ts

@@ -8,15 +8,21 @@ import {htmlSafeByReview} from '../../src/restricted/reviewed';
 describe('reviewed conversions', () => {
   it('require a justification', () => {
     expect(() => {
-      htmlSafeByReview('aaa', null as unknown as string);
+      htmlSafeByReview('aaa', null as unknown as {justification: string});
+    }).toThrowError();
+
+    expect(() => {
+      htmlSafeByReview('aaa', {justification: '   '});
     }).toThrowError(/A justification must be provided/);
 
     expect(() => {
-      htmlSafeByReview('aaa', '   ');
+      htmlSafeByReview('aaa', {justification: undefined as unknown as string});
     }).toThrowError(/A justification must be provided/);
 
-    expect(htmlSafeByReview('aaa', 'This is just a test').toString()).toEqual(
-      'aaa',
-    );
+    expect(
+      htmlSafeByReview('aaa', {
+        justification: 'This is just a test',
+      }).toString(),
+    ).toEqual('aaa');
   });
 });