Restructure (#16)

* restructure modules under chrobot namespace

* regenerate protocol bindings

* prepare release

* adjust readme

CHANGELOG.md

@@ -1,4 +1,12 @@
-## [2.3.0] 2024-07
+## [3.0.0] 2024-08-07
+
+This update restructures the project to move all modules under the `chrobot` namespace.
+
+- All `protocol` modules are now under `chrobot/protocol`
+- `chrome` is now `chrobot/chrome`
+- `browser_install` is now `chrobot/install`
+
+## [2.3.0] 2024-08-07
 
 - Add query selectors that run on elements (Remote Objects)
 

README.md

@@ -50,7 +50,7 @@ Install as an Elixir dependency with mix
 # in your mix.exs
 defp deps do
   [
-    {:chrobot, "~> 2.2.3", app: false, manager: :rebar3}
+    {:chrobot, "~> 3.0.0", app: false, manager: :rebar3}
   ]
 end
 ```
@@ -70,16 +70,16 @@ Chrobot will automatically pick up this local installation when started via the
 You can run the browser installer tool from gleam like so:
 
 ```sh
-gleam run -m browser_install
+gleam run -m chrobot/install
 ```
 
 Or when using Elixir with Mix:
 
 ```sh
-mix run -e :browser_install.main
+mix run -e :chrobot@install.main
 ```
 
-Please [check the `install` docs for more information](https://hexdocs.pm/chrobot/browser_install.html) – this installation method will not work everywhere and comes with some caveats!
+Please [check the `install` docs for more information](https://hexdocs.pm/chrobot/chrobot/install.html) – this installation method will not work everywhere and comes with some caveats!
 
 #### GitHub Actions
 

gleam.toml

@@ -1,5 +1,5 @@
 name = "chrobot"
-version = "2.3.0"
+version = "3.0.0"
 
 description = "A browser automation tool and interface to the Chrome DevTools Protocol."
 licences = ["MIT"]

src/chrobot.gleam

@@ -26,25 +26,24 @@
 //// to treat the pages you are operating on as a secure context.
 //// 
 
+import chrobot/chrome.{type RequestError}
 import chrobot/internal/keymap
 import chrobot/internal/utils
-import chrome.{type RequestError}
+import chrobot/protocol
+import chrobot/protocol/input
+import chrobot/protocol/page
+import chrobot/protocol/runtime
+import chrobot/protocol/target
 import gleam/bit_array
 import gleam/bool
 import gleam/dynamic
 import gleam/erlang/process.{type Subject}
-import gleam/io
 import gleam/json
 import gleam/list
 import gleam/option.{type Option, None, Some}
 import gleam/otp/task
 import gleam/result
 import gleam/string
-import protocol
-import protocol/input
-import protocol/page
-import protocol/runtime
-import protocol/target
 import simplifile as file
 
 /// Holds information about the current page,
@@ -86,7 +85,7 @@ pub fn launch() -> Result(Subject(chrome.Message), chrome.LaunchError) {
       utils.hint(
         "You can install a local version of chrome for testing with this command:",
       )
-      utils.show_cmd("gleam run -m browser_install")
+      utils.show_cmd("gleam run -m chrobot/install")
       launch_result
     }
     other -> other
@@ -105,7 +104,7 @@ pub fn launch_window() -> Result(Subject(chrome.Message), chrome.LaunchError) {
       utils.hint(
         "You can install a local version of chrome for testing with this command:",
       )
-      utils.show_cmd("gleam run -m browser_install")
+      utils.show_cmd("gleam run -m chrobot/install")
       launch_result
     }
     other -> other
@@ -832,7 +831,7 @@ fn pass_session(session_id: target.SessionID) -> Option(String) {
 /// ```gleam
 /// import chrobot.{open, page_caller}
 /// import gleam/option.{None}
-/// import protocol/page
+/// import chrobot/protocol/page
 /// pub fn main() {
 ///   let assert Ok(browser) = chrobot.launch()
 ///   let assert Ok(page) = open(browser, "https://example.com", 5000)

src/browser_install.gleam → src/chrobot/install.gleam

@@ -6,7 +6,7 @@
 //// You may run browser installation directly with 
 //// 
 //// ```sh
-//// gleam run -m browser_install
+//// gleam run -m chrobot/install
 //// ```
 //// When running directly, you can configure the browser version to install by setting the `CHROBOT_TARGET_VERSION` environment variable,
 //// it will default to `latest`. 
@@ -81,8 +81,8 @@
 //// xdg-utils
 //// ```
 
+import chrobot/chrome
 import chrobot/internal/utils
-import chrome
 import filepath as path
 import gleam/dynamic
 import gleam/erlang/os

src/protocol.gleam → src/chrobot/protocol.gleam

@@ -77,7 +77,7 @@
 
 // ---------------------------------------------------------------------------
 // |  !!!!!!   This is an autogenerated file - Do not edit manually  !!!!!!  |
-// | Run ` gleam run -m scripts/generate_protocol_bindings.sh` to regenerate.|  
+// |                     Run `codegen.sh` to regenerate.                     |
 // ---------------------------------------------------------------------------
 
 const version_major = "1"

src/protocol/browser.gleam → src/chrobot/protocol/browser.gleam

@@ -7,11 +7,11 @@
 
 // ---------------------------------------------------------------------------
 // |  !!!!!!   This is an autogenerated file - Do not edit manually  !!!!!!  |
-// | Run ` gleam run -m scripts/generate_protocol_bindings.sh` to regenerate.|  
+// |                     Run `codegen.sh` to regenerate.                     |
 // ---------------------------------------------------------------------------
 
+import chrobot/chrome
 import chrobot/internal/utils
-import chrome
 import gleam/dynamic
 import gleam/json
 import gleam/option

src/protocol/debugger.gleam → src/chrobot/protocol/debugger.gleam

@@ -8,16 +8,16 @@
 
 // ---------------------------------------------------------------------------
 // |  !!!!!!   This is an autogenerated file - Do not edit manually  !!!!!!  |
-// | Run ` gleam run -m scripts/generate_protocol_bindings.sh` to regenerate.|  
+// |                     Run `codegen.sh` to regenerate.                     |
 // ---------------------------------------------------------------------------
 
+import chrobot/chrome
 import chrobot/internal/utils
-import chrome
+import chrobot/protocol/runtime
 import gleam/dynamic
 import gleam/json
 import gleam/option
 import gleam/result
-import protocol/runtime
 
 /// Breakpoint identifier.
 pub type BreakpointId {
@@ -33,8 +33,7 @@ pub fn encode__breakpoint_id(value__: BreakpointId) {
 
 @internal
 pub fn decode__breakpoint_id(value__: dynamic.Dynamic) {
-  value__
-  |> dynamic.decode1(BreakpointId, dynamic.string)
+  value__ |> dynamic.decode1(BreakpointId, dynamic.string)
 }
 
 /// Call frame identifier.
@@ -51,8 +50,7 @@ pub fn encode__call_frame_id(value__: CallFrameId) {
 
 @internal
 pub fn decode__call_frame_id(value__: dynamic.Dynamic) {
-  value__
-  |> dynamic.decode1(CallFrameId, dynamic.string)
+  value__ |> dynamic.decode1(CallFrameId, dynamic.string)
 }
 
 /// Location in the source code.

src/protocol/dom.gleam → src/chrobot/protocol/dom.gleam

@@ -13,16 +13,16 @@
 
 // ---------------------------------------------------------------------------
 // |  !!!!!!   This is an autogenerated file - Do not edit manually  !!!!!!  |
-// | Run ` gleam run -m scripts/generate_protocol_bindings.sh` to regenerate.|  
+// |                     Run `codegen.sh` to regenerate.                     |
 // ---------------------------------------------------------------------------
 
+import chrobot/chrome
 import chrobot/internal/utils
-import chrome
+import chrobot/protocol/runtime
 import gleam/dynamic
 import gleam/json
 import gleam/option
 import gleam/result
-import protocol/runtime
 
 /// Unique DOM node identifier.
 pub type NodeId {
@@ -38,8 +38,7 @@ pub fn encode__node_id(value__: NodeId) {
 
 @internal
 pub fn decode__node_id(value__: dynamic.Dynamic) {
-  value__
-  |> dynamic.decode1(NodeId, dynamic.int)
+  value__ |> dynamic.decode1(NodeId, dynamic.int)
 }
 
 /// Unique DOM node identifier used to reference a node that may not have been pushed to the
@@ -57,8 +56,7 @@ pub fn encode__backend_node_id(value__: BackendNodeId) {
 
 @internal
 pub fn decode__backend_node_id(value__: dynamic.Dynamic) {
-  value__
-  |> dynamic.decode1(BackendNodeId, dynamic.int)
+  value__ |> dynamic.decode1(BackendNodeId, dynamic.int)
 }
 
 /// Backend node with a friendly name.
@@ -719,8 +717,7 @@ pub fn encode__quad(value__: Quad) {
 
 @internal
 pub fn decode__quad(value__: dynamic.Dynamic) {
-  value__
-  |> dynamic.decode1(Quad, dynamic.list(dynamic.float))
+  value__ |> dynamic.decode1(Quad, dynamic.list(dynamic.float))
 }
 
 /// Box model.

src/protocol/dom_debugger.gleam → src/chrobot/protocol/dom_debugger.gleam

@@ -8,17 +8,17 @@
 
 // ---------------------------------------------------------------------------
 // |  !!!!!!   This is an autogenerated file - Do not edit manually  !!!!!!  |
-// | Run ` gleam run -m scripts/generate_protocol_bindings.sh` to regenerate.|  
+// |                     Run `codegen.sh` to regenerate.                     |
 // ---------------------------------------------------------------------------
 
+import chrobot/chrome
 import chrobot/internal/utils
-import chrome
+import chrobot/protocol/dom
+import chrobot/protocol/runtime
 import gleam/dynamic
 import gleam/json
 import gleam/option
 import gleam/result
-import protocol/dom
-import protocol/runtime
 
 /// DOM breakpoint type.
 pub type DOMBreakpointType {

src/protocol/emulation.gleam → src/chrobot/protocol/emulation.gleam

@@ -7,15 +7,15 @@
 
 // ---------------------------------------------------------------------------
 // |  !!!!!!   This is an autogenerated file - Do not edit manually  !!!!!!  |
-// | Run ` gleam run -m scripts/generate_protocol_bindings.sh` to regenerate.|  
+// |                     Run `codegen.sh` to regenerate.                     |
 // ---------------------------------------------------------------------------
 
 import chrobot/internal/utils
+import chrobot/protocol/dom
 import gleam/dynamic
 import gleam/json
 import gleam/option
 import gleam/result
-import protocol/dom
 
 /// Screen orientation.
 pub type ScreenOrientation {

src/protocol/fetch.gleam → src/chrobot/protocol/fetch.gleam

@@ -7,17 +7,17 @@
 
 // ---------------------------------------------------------------------------
 // |  !!!!!!   This is an autogenerated file - Do not edit manually  !!!!!!  |
-// | Run ` gleam run -m scripts/generate_protocol_bindings.sh` to regenerate.|  
+// |                     Run `codegen.sh` to regenerate.                     |
 // ---------------------------------------------------------------------------
 
+import chrobot/chrome
 import chrobot/internal/utils
-import chrome
+import chrobot/protocol/io
+import chrobot/protocol/network
 import gleam/dynamic
 import gleam/json
 import gleam/option
 import gleam/result
-import protocol/io
-import protocol/network
 
 /// Unique request identifier.
 pub type RequestId {
@@ -33,8 +33,7 @@ pub fn encode__request_id(value__: RequestId) {
 
 @internal
 pub fn decode__request_id(value__: dynamic.Dynamic) {
-  value__
-  |> dynamic.decode1(RequestId, dynamic.string)
+  value__ |> dynamic.decode1(RequestId, dynamic.string)
 }
 
 /// Stages of the request to handle. Request will intercept before the request is

src/protocol/input.gleam → src/chrobot/protocol/input.gleam

@@ -7,7 +7,7 @@
 
 // ---------------------------------------------------------------------------
 // |  !!!!!!   This is an autogenerated file - Do not edit manually  !!!!!!  |
-// | Run ` gleam run -m scripts/generate_protocol_bindings.sh` to regenerate.|  
+// |                     Run `codegen.sh` to regenerate.                     |
 // ---------------------------------------------------------------------------
 
 import chrobot/internal/utils
@@ -163,8 +163,7 @@ pub fn encode__time_since_epoch(value__: TimeSinceEpoch) {
 
 @internal
 pub fn decode__time_since_epoch(value__: dynamic.Dynamic) {
-  value__
-  |> dynamic.decode1(TimeSinceEpoch, dynamic.float)
+  value__ |> dynamic.decode1(TimeSinceEpoch, dynamic.float)
 }
 
 /// Dispatches a key event to the page.

src/protocol/io.gleam → src/chrobot/protocol/io.gleam

@@ -7,16 +7,16 @@
 
 // ---------------------------------------------------------------------------
 // |  !!!!!!   This is an autogenerated file - Do not edit manually  !!!!!!  |
-// | Run ` gleam run -m scripts/generate_protocol_bindings.sh` to regenerate.|  
+// |                     Run `codegen.sh` to regenerate.                     |
 // ---------------------------------------------------------------------------
 
+import chrobot/chrome
 import chrobot/internal/utils
-import chrome
+import chrobot/protocol/runtime
 import gleam/dynamic
 import gleam/json
 import gleam/option
 import gleam/result
-import protocol/runtime
 
 /// This is either obtained from another method or specified as `blob:<uuid>` where
 /// `<uuid>` is an UUID of a Blob.
@@ -33,8 +33,7 @@ pub fn encode__stream_handle(value__: StreamHandle) {
 
 @internal
 pub fn decode__stream_handle(value__: dynamic.Dynamic) {
-  value__
-  |> dynamic.decode1(StreamHandle, dynamic.string)
+  value__ |> dynamic.decode1(StreamHandle, dynamic.string)
 }
 
 /// This type is not part of the protocol spec, it has been generated dynamically

src/protocol/log.gleam → src/chrobot/protocol/log.gleam

@@ -7,16 +7,16 @@
 
 // ---------------------------------------------------------------------------
 // |  !!!!!!   This is an autogenerated file - Do not edit manually  !!!!!!  |
-// | Run ` gleam run -m scripts/generate_protocol_bindings.sh` to regenerate.|  
+// |                     Run `codegen.sh` to regenerate.                     |
 // ---------------------------------------------------------------------------
 
 import chrobot/internal/utils
+import chrobot/protocol/network
+import chrobot/protocol/runtime
 import gleam/dynamic
 import gleam/json
 import gleam/option
 import gleam/result
-import protocol/network
-import protocol/runtime
 
 /// Log entry.
 pub type LogEntry {