LibWeb: Add NavigationDestination, used for NavigateEvents

This class will be used in the algorithms for the navigate event firing
algorithms to populate the destination field of the NavigateEvent.

Meta/gn/secondary/Userland/Libraries/LibWeb/HTML/BUILD.gn

@@ -125,6 +125,7 @@ source_set("HTML") {
     "NavigableContainer.cpp",
     "Navigation.cpp",
     "NavigationCurrentEntryChangeEvent.cpp",
+    "NavigationDestination.cpp",
     "NavigationHistoryEntry.cpp",
     "Navigator.cpp",
     "NavigatorID.cpp",

Meta/gn/secondary/Userland/Libraries/LibWeb/idl_files.gni

@@ -184,6 +184,7 @@ standard_idl_files = [
   "//Userland/Libraries/LibWeb/HTML/MimeTypeArray.idl",
   "//Userland/Libraries/LibWeb/HTML/Navigation.idl",
   "//Userland/Libraries/LibWeb/HTML/NavigationCurrentEntryChangeEvent.idl",
+  "//Userland/Libraries/LibWeb/HTML/NavigationDestination.idl",
   "//Userland/Libraries/LibWeb/HTML/NavigationHistoryEntry.idl",
   "//Userland/Libraries/LibWeb/HTML/Navigator.idl",
   "//Userland/Libraries/LibWeb/HTML/PageTransitionEvent.idl",

Userland/Libraries/LibWeb/CMakeLists.txt

@@ -351,6 +351,7 @@ set(SOURCES
     HTML/Navigable.cpp
     HTML/NavigableContainer.cpp
     HTML/Navigation.cpp
+    HTML/NavigationDestination.cpp
     HTML/NavigationCurrentEntryChangeEvent.cpp
     HTML/NavigationHistoryEntry.cpp
     HTML/Navigator.cpp

Userland/Libraries/LibWeb/HTML/NavigationDestination.cpp

@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2023, Andrew Kaster <akaster@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <LibJS/Heap/Heap.h>
+#include <LibJS/Runtime/Realm.h>
+#include <LibWeb/Bindings/Intrinsics.h>
+#include <LibWeb/Bindings/NavigationDestinationPrototype.h>
+#include <LibWeb/HTML/NavigationDestination.h>
+#include <LibWeb/HTML/NavigationHistoryEntry.h>
+
+namespace Web::HTML {
+
+JS::NonnullGCPtr<NavigationDestination> NavigationDestination::create(JS::Realm& realm)
+{
+    return realm.heap().allocate<NavigationDestination>(realm, realm);
+}
+
+NavigationDestination::NavigationDestination(JS::Realm& realm)
+    : Bindings::PlatformObject(realm)
+{
+}
+
+NavigationDestination::~NavigationDestination() = default;
+
+void NavigationDestination::initialize(JS::Realm& realm)
+{
+    Base::initialize(realm);
+    set_prototype(&Bindings::ensure_web_prototype<Bindings::NavigationDestinationPrototype>(realm, "NavigationDestination"));
+}
+
+void NavigationDestination::visit_edges(JS::Cell::Visitor& visitor)
+{
+    Base::visit_edges(visitor);
+    visitor.visit(m_entry);
+}
+
+// https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigationdestination-url
+WebIDL::ExceptionOr<String> NavigationDestination::url() const
+{
+    // The url getter steps are to return this's URL, serialized.
+    return TRY_OR_THROW_OOM(vm(), String::from_deprecated_string(m_url.serialize()));
+}
+
+// https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigationdestination-key
+String NavigationDestination::key() const
+{
+    // The key getter steps are:
+
+    // 1. If this's entry is null, then return the empty string.
+    // 2. Return this's entry's key.
+    return (m_entry == nullptr) ? String {} : m_entry->key();
+}
+
+// https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigationdestination-id
+String NavigationDestination::id() const
+{
+    // The id getter steps are:
+
+    // 1. If this's entry is null, then return the empty string.
+    // 2. Return this's entry's ID.
+    return (m_entry == nullptr) ? String {} : m_entry->id();
+}
+
+// https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigationdestination-index
+i64 NavigationDestination::index() const
+{
+    // The index getter steps are:
+
+    // 1. If this's entry is null, then return -1.
+    // 2. Return this's entry's index.
+    return (m_entry == nullptr) ? -1 : m_entry->index();
+}
+
+// https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigationdestination-samedocument
+bool NavigationDestination::same_document() const
+{
+    // The sameDocument getter steps are to return this's is same document.
+    return m_is_same_document;
+}
+
+// https://html.spec.whatwg.org/multipage/nav-history-apis.html#dom-navigationdestination-getstate
+WebIDL::ExceptionOr<JS::Value> NavigationDestination::get_state()
+{
+    // The getState() method steps are to return StructuredDeserialize(this's state).
+    return structured_deserialize(vm(), m_state, realm(), {});
+}
+
+}

Userland/Libraries/LibWeb/HTML/NavigationDestination.h

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2023, Andrew Kaster <akaster@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <AK/URL.h>
+#include <LibWeb/Bindings/PlatformObject.h>
+#include <LibWeb/HTML/StructuredSerialize.h>
+
+namespace Web::HTML {
+
+// https://html.spec.whatwg.org/multipage/nav-history-apis.html#navigationdestination
+class NavigationDestination : public Bindings::PlatformObject {
+    WEB_PLATFORM_OBJECT(NavigationDestination, Bindings::PlatformObject);
+
+public:
+    [[nodiscard]] static JS::NonnullGCPtr<NavigationDestination> create(JS::Realm&);
+
+    WebIDL::ExceptionOr<String> url() const;
+    String key() const;
+    String id() const;
+    i64 index() const;
+    bool same_document() const;
+    WebIDL::ExceptionOr<JS::Value> get_state();
+
+    // Non-spec'd getter, not exposed to JS
+    JS::GCPtr<NavigationHistoryEntry> navigation_history_entry() const { return m_entry; }
+
+    // Setters are not available to JS, but expected in many spec algorithms
+    void set_url(AK::URL const& url) { m_url = url; }
+    void set_entry(JS::GCPtr<NavigationHistoryEntry> entry) { m_entry = entry; }
+    void set_state(SerializationRecord state) { m_state = move(state); }
+    void set_is_same_document(bool b) { m_is_same_document = b; }
+
+    virtual ~NavigationDestination() override;
+
+private:
+    NavigationDestination(JS::Realm&);
+
+    virtual void initialize(JS::Realm&) override;
+    virtual void visit_edges(JS::Cell::Visitor&) override;
+
+    // https://html.spec.whatwg.org/multipage/nav-history-apis.html#concept-navigationdestination-url
+    AK::URL m_url;
+
+    // https://html.spec.whatwg.org/multipage/nav-history-apis.html#concept-navigationdestination-url
+    JS::GCPtr<NavigationHistoryEntry> m_entry;
+
+    // https://html.spec.whatwg.org/multipage/nav-history-apis.html#concept-navigationdestination-state
+    SerializationRecord m_state;
+
+    // https://html.spec.whatwg.org/multipage/nav-history-apis.html#concept-navigationdestination-samedocument
+    bool m_is_same_document { false };
+};
+
+}

Userland/Libraries/LibWeb/HTML/NavigationDestination.idl

@@ -0,0 +1,11 @@
+// https://html.spec.whatwg.org/multipage/nav-history-apis.html#the-navigationdestination-interface
+[Exposed=Window, UseNewAKString]
+interface NavigationDestination {
+  readonly attribute USVString url;
+  readonly attribute DOMString key;
+  readonly attribute DOMString id;
+  readonly attribute long long index;
+  readonly attribute boolean sameDocument;
+
+  any getState();
+};

Userland/Libraries/LibWeb/idl_files.cmake

@@ -170,6 +170,7 @@ libweb_js_bindings(HTML/MimeType)
 libweb_js_bindings(HTML/MimeTypeArray)
 libweb_js_bindings(HTML/Navigation)
 libweb_js_bindings(HTML/NavigationCurrentEntryChangeEvent)
+libweb_js_bindings(HTML/NavigationDestination)
 libweb_js_bindings(HTML/NavigationHistoryEntry)
 libweb_js_bindings(HTML/Navigator)
 libweb_js_bindings(HTML/PageTransitionEvent)