[DO] Adding Durable Object base class (#18423)

* Adding a new

* Adding Durable Object Base Class chapter. Adding cross-references.

* Adding link to related resources.

* Adding extended methods to DO State page.

* Adding fetch and alarm. Actioning PR comments.

* Revert "Adding fetch and alarm. Actioning PR comments."

This reverts commit 6088c07.

* Adding fetch and alarm to base class chapter.
Actioning other PR comments.

* Adding alarm handler method into DO base class.

* Importing missing package.

* Adding missing component x2

* Clarifying language on serializeAttachment method.

* Apply suggestions from code review

Co-authored-by: marciocloudflare <[email protected]>

---------

Co-authored-by: marciocloudflare <[email protected]>

Author: Oxyjun

src/content/docs/durable-objects/api/alarms.mdx

@@ -2,7 +2,7 @@
 title: Alarms
 pcx_content_type: concept
 sidebar:
-  order: 7
+  order: 8
 ---
 
 import { Type, GlossaryTooltip } from "~/components";

src/content/docs/durable-objects/api/base.mdx

@@ -0,0 +1,86 @@
+---
+title: Durable Object Base Class
+pcx_content_type: concept
+sidebar:
+  order: 1
+---
+
+import { Render, Tabs, TabItem, GlossaryTooltip, Type, MetaInfo, TypeScriptExample } from "~/components";
+
+The `DurableObject` base class is an abstract class which all Durable Objects inherit from. This base class provides a set of optional methods, frequently referred to as handler methods, which can respond to events, for example a webSocketMessage when using the [WebSocket Hibernation API](#/durable-objects/best-practices/websockets/#websocket-hibernation-api). To provide a concrete example, here is a Durable Object `MyDurableObject` which extends `DurableObject` and implements the fetch handler to return "Hello, World!" to the calling Worker.
+
+<TypeScriptExample>
+```ts
+export class MyDurableObject extends DurableObject {
+	constructor(ctx: DurableObjectState, env: Env) {
+		super(ctx, env);
+	}
+
+	async fetch(request: Request) {
+		return new Response("Hello, World!");
+	}
+}
+```
+</TypeScriptExample>
+
+## Methods
+
+### `fetch`
+
+- <code>fetch(<Type text="Request"/>)</code>: <Type text="Response"/> | <Type text="Promise <Response>"/>
+
+  - Takes an HTTP request object and returns an HTTP response object. This method allows the Durable Object to emulate an HTTP server where a Worker with a binding to that object is the client.
+
+  - This method can be `async`.
+
+### `alarm`
+
+- <code>alarm()</code>: <Type text="Promise <void>"/>
+
+  - Called by the system when a scheduled alarm time is reached.
+
+  - The `alarm()` handler has guaranteed at-least-once execution and will be retried upon failure using exponential backoff, starting at two second delays for up to six retries. Retries will be performed if the method fails with an uncaught exception.
+
+  - This method can be `async`.
+
+  - Refer to [`alarm`](/durable-objects/api/alarms/#alarm) for more information.
+
+### `webSocketMessage`
+
+- <code> webSocketMessage(ws <Type text="WebSocket" />, message{" "} <Type text="string | ArrayBuffer" />)</code>: <Type text="void" />
+
+  - Called by the system when an accepted WebSocket receives a message.
+
+  - This method can be `async`.
+
+  - This method is not called for WebSocket control frames. The system will respond to an incoming [WebSocket protocol ping](https://www.rfc-editor.org/rfc/rfc6455#section-5.5.2) automatically without interrupting hibernation.
+
+### `webSocketClose`
+
+- <code> webSocketClose(ws <Type text="WebSocket" />, code <Type text="number" />, reason <Type text="string" />, wasClean <Type text="boolean" />)</code>: <Type text="void" />
+
+  - Called by the system when a WebSocket is closed. `wasClean()` is true if the connection closed cleanly, false otherwise.
+
+  - This method can be `async`.
+
+### `webSocketError`
+
+- <code> webSocketError(ws <Type text="WebSocket" />, error <Type text="any" />)</code> : <Type text="void" />
+
+  - Called by the system when any non-disconnection related errors occur.
+
+  - This method can be `async`.
+
+## Properties
+
+### `DurableObjectState`
+
+See [`DurableObjectState` documentation](/durable-objects/api/state/).
+
+### `Env`
+
+A list of bindings which are available to the Durable Object.
+
+## Related resources
+
+- Refer to [Use WebSockets](/durable-objects/best-practices/websockets/) for more information on examples of WebSocket methods and best practices.

src/content/docs/durable-objects/api/id.mdx

@@ -2,7 +2,7 @@
 title: Durable Object ID
 pcx_content_type: concept
 sidebar:
-  order: 2
+  order: 3
 ---
 
 import { Render, Tabs, TabItem, GlossaryTooltip } from "~/components";

src/content/docs/durable-objects/api/namespace.mdx

@@ -2,7 +2,7 @@
 title: Durable Object Namespace
 pcx_content_type: concept
 sidebar:
-  order: 1
+  order: 2
 ---
 
 import { Render, Tabs, TabItem, GlossaryTooltip } from "~/components";

src/content/docs/durable-objects/api/sql-storage.mdx

@@ -2,7 +2,7 @@
 title: SQL Storage
 pcx_content_type: concept
 sidebar:
-  order: 5
+  order: 6
 
 ---
 

src/content/docs/durable-objects/api/state.mdx

@@ -2,10 +2,10 @@
 title: Durable Object State
 pcx_content_type: concept
 sidebar:
-  order: 4
+  order: 5
 ---
 
-import { Tabs, TabItem, GlossaryTooltip } from "~/components";
+import { Tabs, TabItem, GlossaryTooltip, Type, MetaInfo } from "~/components";
 
 ## Description
 

src/content/docs/durable-objects/api/storage-api.mdx

@@ -2,7 +2,7 @@
 title: Durable Object Storage
 pcx_content_type: concept
 sidebar:
-  order: 5
+  order: 6
 ---
 
 import { Render, Type, MetaInfo, GlossaryTooltip } from "~/components";

src/content/docs/durable-objects/api/stub.mdx

@@ -2,7 +2,7 @@
 title: Durable Object Stub
 pcx_content_type: concept
 sidebar:
-  order: 3
+  order: 4
 ---
 
 import { Render, GlossaryTooltip } from "~/components";

src/content/docs/durable-objects/api/webgpu.mdx

@@ -2,7 +2,7 @@
 pcx_content_type: configuration
 title: WebGPU
 sidebar:
-  order: 8
+  order: 9
 ---
 
 :::caution

src/content/docs/durable-objects/api/workers-rs.mdx

@@ -3,6 +3,6 @@ pcx_content_type: navigation
 title: Rust API
 external_link: https://github.com/cloudflare/workers-rs?tab=readme-ov-file#durable-objects
 sidebar:
-  order: 10
+  order: 11
 
 ---