Add remove() and isRemoved in HTMLRewriterTypes.Doctype interface (#16031)

Devanand-Sharma · web-flow · commit 18ac7f9509b1 · 2024-12-28T22:57:25.000-08:00
diff --git a/packages/bun-types/html-rewriter.d.ts b/packages/bun-types/html-rewriter.d.ts
@@ -26,6 +26,8 @@ declare namespace HTMLRewriterTypes {
     readonly name: string | null;
     readonly publicId: string | null;
     readonly systemId: string | null;
+    readonly removed: boolean;
+    remove(): Doctype;
   }
 
   interface DocumentEnd {
diff --git a/src/bun.js/api/html_rewriter.classes.ts b/src/bun.js/api/html_rewriter.classes.ts
@@ -81,6 +81,13 @@ export default [
         getter: "publicId",
         cache: true,
       },
+      remove: {
+        fn: "remove",
+        length: 0,
+      },
+      removed: {
+        getter: "removed",
+      },
     },
   }),
   define({
diff --git a/src/bun.js/api/html_rewriter.zig b/src/bun.js/api/html_rewriter.zig
@@ -1157,6 +1157,26 @@ pub const DocType = struct {
             return JSValue.jsNull();
         return ZigString.init(str).toJS(globalObject);
     }
+
+    pub fn remove(
+        this: *DocType,
+        _: *JSGlobalObject,
+        callFrame: *JSC.CallFrame,
+    ) bun.JSError!JSValue {
+        if (this.doctype == null)
+            return JSValue.jsUndefined();
+        this.doctype.?.remove();
+        return callFrame.this();
+    }
+
+    pub fn removed(
+        this: *DocType,
+        _: *JSGlobalObject,
+    ) JSValue {
+        if (this.doctype == null)
+            return JSValue.jsUndefined();
+        return JSValue.jsBoolean(this.doctype.?.isRemoved());
+    }
 };
 
 pub const DocEnd = struct {
diff --git a/src/deps/lol-html.zig b/src/deps/lol-html.zig
@@ -796,6 +796,8 @@ pub const DocType = opaque {
     extern fn lol_html_doctype_system_id_get(doctype: *const DocType) HTMLString;
     extern fn lol_html_doctype_user_data_set(doctype: *const DocType, user_data: ?*anyopaque) void;
     extern fn lol_html_doctype_user_data_get(doctype: *const DocType) ?*anyopaque;
+    extern fn lol_html_doctype_remove(doctype: *DocType) void;
+    extern fn lol_html_doctype_is_removed(doctype: *const DocType) bool;
 
     pub const Callback = *const fn (*DocType, ?*anyopaque) callconv(.C) Directive;
 
@@ -811,6 +813,14 @@ pub const DocType = opaque {
         auto_disable();
         return this.lol_html_doctype_system_id_get();
     }
+    pub fn remove(this: *DocType) void {
+        auto_disable();
+        return this.lol_html_doctype_remove();
+    }
+    pub fn isRemoved(this: *const DocType) bool {
+        auto_disable();
+        return this.lol_html_doctype_is_removed();
+    }
 };
 
 pub const Encoding = enum {
diff --git a/test/js/web/html/html-rewriter-doctype.test.ts b/test/js/web/html/html-rewriter-doctype.test.ts
@@ -0,0 +1,24 @@
+import { expect, test, describe } from "bun:test";
+
+describe("HTMLRewriter DOCTYPE handler", () => {
+  test("remove and removed property work on DOCTYPE", () => {
+    const html = "<!DOCTYPE html><html><head></head><body>Hello</body></html>";
+    let sawDoctype = false;
+    let wasRemoved = false;
+
+    const rewriter = new HTMLRewriter().onDocument({
+      doctype(doctype) {
+        sawDoctype = true;
+        doctype.remove();
+        wasRemoved = doctype.removed;
+      },
+    });
+
+    const result = rewriter.transform(html);
+
+    expect(sawDoctype).toBe(true);
+    expect(wasRemoved).toBe(true);
+    expect(result).not.toContain("<!DOCTYPE");
+    expect(result).toContain("<html>");
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@ declare namespace HTMLRewriterTypes {`
`26`	`26`	`readonly name: string \| null;`
`27`	`27`	`readonly publicId: string \| null;`
`28`	`28`	`readonly systemId: string \| null;`
	`29`	`+ readonly removed: boolean;`
	`30`	`+ remove(): Doctype;`
`29`	`31`	`}`
`30`	`32`
`31`	`33`	`interface DocumentEnd {`