Skip to content

Commit 4f419f3

Browse files
feat(standard-server-peer): promote to stable (#766)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Refactor** * Removed the "experimental_" prefix from class, interface, and function names across the codebase and documentation, promoting them to stable APIs. * Updated all relevant import statements and code examples to use the new stable names. * No changes to functionality, control flow, or logic were introduced. * **Documentation** * Updated code examples in documentation to reflect the new stable API names, ensuring consistency and clarity for end-users. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent 9cd4eb7 commit 4f419f3

35 files changed

Lines changed: 84 additions & 90 deletions

File tree

apps/content/docs/adapters/browser.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The browser extension [Message Passing API](https://developer.chrome.com/docs/ex
1818
::: code-group
1919

2020
```ts [server]
21-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/message-port'
21+
import { RPCHandler } from '@orpc/server/message-port'
2222

2323
const handler = new RPCHandler(router)
2424

@@ -30,7 +30,7 @@ browser.runtime.onConnect.addListener((port) => {
3030
```
3131

3232
```ts [client]
33-
import { experimental_RPCLink as RPCLink } from '@orpc/client/message-port'
33+
import { RPCLink } from '@orpc/client/message-port'
3434

3535
const port = browser.runtime.connect()
3636

@@ -52,7 +52,7 @@ To enable communication between two window contexts (e.g. parent and popup), one
5252
::: code-group
5353

5454
```ts [opener]
55-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/message-port'
55+
import { RPCHandler } from '@orpc/server/message-port'
5656

5757
const handler = new RPCHandler(router)
5858

@@ -70,7 +70,7 @@ window.open('/example/popup', 'popup', 'width=680,height=520')
7070
```
7171

7272
```ts [popup]
73-
import { experimental_RPCLink as RPCLink } from '@orpc/client/message-port'
73+
import { RPCLink } from '@orpc/client/message-port'
7474

7575
const { port1: serverPort, port2: clientPort } = new MessageChannel()
7676

@@ -122,7 +122,7 @@ window.addEventListener('message', (event) => {
122122
```
123123

124124
```ts [server]
125-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/message-port'
125+
import { RPCHandler } from '@orpc/server/message-port'
126126

127127
const handler = new RPCHandler(router)
128128

@@ -134,7 +134,7 @@ browser.runtime.onConnect.addListener((port) => {
134134
```
135135

136136
```ts [client]
137-
import { experimental_RPCLink as RPCLink } from '@orpc/client/message-port'
137+
import { RPCLink } from '@orpc/client/message-port'
138138

139139
const { port1: serverPort, port2: clientPort } = new MessageChannel()
140140

apps/content/docs/adapters/electron.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Establish type-safe communication between processes in [Electron](https://www.el
1212
Listen for a port sent from the renderer, then upgrade it:
1313

1414
```ts
15-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/message-port'
15+
import { RPCHandler } from '@orpc/server/message-port'
1616
import { router } from './router'
1717

1818
const handler = new RPCHandler(router)

apps/content/docs/adapters/message-port.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ const clientPort = channel.port2
2424
```
2525

2626
```ts [server]
27-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/message-port'
27+
import { RPCHandler } from '@orpc/server/message-port'
2828

2929
const handler = new RPCHandler(router)
3030

@@ -36,7 +36,7 @@ serverPort.start()
3636
```
3737

3838
```ts [client]
39-
import { experimental_RPCLink as RPCLink } from '@orpc/client/message-port'
39+
import { RPCLink } from '@orpc/client/message-port'
4040

4141
const link = new RPCLink({
4242
port: clientPort,

apps/content/docs/adapters/websocket.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ oRPC provides built-in WebSocket support for low-latency, bidirectional RPC.
1919
::: code-group
2020

2121
```ts [Websocket]
22-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/websocket'
22+
import { RPCHandler } from '@orpc/server/websocket'
2323

2424
const handler = new RPCHandler(router)
2525

@@ -73,7 +73,7 @@ server.on('upgrade', (req, socket, head) => {
7373

7474
```ts [WS]
7575
import { WebSocketServer } from 'ws'
76-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/ws'
76+
import { RPCHandler } from '@orpc/server/ws'
7777

7878
const handler = new RPCHandler(router)
7979

@@ -87,7 +87,7 @@ wss.on('connection', (ws) => {
8787
```
8888

8989
```ts [Bun WebSocket]
90-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/bun-ws'
90+
import { RPCHandler } from '@orpc/server/bun-ws'
9191

9292
const handler = new RPCHandler(router)
9393

@@ -113,7 +113,7 @@ Bun.serve({
113113
```
114114

115115
```ts [Websocket Hibernation]
116-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/websocket'
116+
import { RPCHandler } from '@orpc/server/websocket'
117117

118118
const handler = new RPCHandler(router)
119119

@@ -154,7 +154,7 @@ export class ChatRoom extends DurableObject {
154154
| `websocket` | [MDN WebSocket API](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) (Browser, Node, Bun, Deno, etc.) |
155155

156156
```ts
157-
import { experimental_RPCLink as RPCLink } from '@orpc/client/websocket'
157+
import { RPCLink } from '@orpc/client/websocket'
158158

159159
const websocket = new WebSocket('ws://localhost:3000')
160160

apps/content/docs/adapters/worker-threads.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Listen for a `MessagePort` sent from the main thread and upgrade it:
1313

1414
```ts
1515
import { parentPort } from 'node:worker_threads'
16-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/message-port'
16+
import { RPCHandler } from '@orpc/server/message-port'
1717

1818
const handler = new RPCHandler(router)
1919

@@ -32,7 +32,7 @@ Create a `MessageChannel`, send one port to the thread worker, and use the other
3232

3333
```ts
3434
import { MessageChannel, Worker } from 'node:worker_threads'
35-
import { experimental_RPCLink as RPCLink } from '@orpc/client/message-port'
35+
import { RPCLink } from '@orpc/client/message-port'
3636

3737
const { port1: clientPort, port2: serverPort } = new MessageChannel()
3838

apps/content/docs/plugins/hibernation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This example demonstrates how to set up a chat room using [Cloudflare Durable Ob
6868
::: code-group
6969

7070
```ts [Durable Object]
71-
import { experimental_RPCHandler as RPCHandler } from '@orpc/server/websocket'
71+
import { RPCHandler } from '@orpc/server/websocket'
7272
import {
7373
experimental_encodeHibernationRPCEvent as encodeHibernationRPCEvent,
7474
experimental_HibernationEventIterator as HibernationEventIterator,
@@ -146,7 +146,7 @@ export class ChatRoom extends DurableObject {
146146
```
147147

148148
```ts [Client]
149-
import { experimental_RPCLink as RPCLink } from '@orpc/client/websocket'
149+
import { RPCLink } from '@orpc/client/websocket'
150150
import { createORPCClient } from '@orpc/client'
151151
import type { router } from '../../worker/dos/chat-room'
152152
import type { RouterClient } from '@orpc/server'

packages/arktype/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,10 @@ Provides `ArkTypeToJsonSchemaConverter` for generating OpenAPI specs from [ArkTy
6666
### Generate OpenAPI Spec
6767

6868
```ts
69+
import {
70+
experimental_ArkTypeToJsonSchemaConverter as ArkTypeToJsonSchemaConverter
71+
} from '@orpc/arktype'
6972
import { OpenAPIGenerator } from '@orpc/openapi'
70-
import { experimental_ArkTypeToJsonSchemaConverter as ArkTypeToJsonSchemaConverter } from '@orpc/valibot'
7173

7274
const openAPIGenerator = new OpenAPIGenerator({
7375
schemaConverters: [

packages/client/src/adapters/message-port/link-client.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ import type { SupportedMessagePort } from './message-port'
55
import { ClientPeer } from '@orpc/standard-server-peer'
66
import { onMessagePortClose, onMessagePortMessage, postMessagePortMessage } from './message-port'
77

8-
export interface experimental_LinkMessagePortClientOptions {
8+
export interface LinkMessagePortClientOptions {
99
port: SupportedMessagePort
1010
}
1111

12-
export class experimental_LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
12+
export class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
1313
private readonly peer: ClientPeer
1414

15-
constructor(options: experimental_LinkMessagePortClientOptions) {
15+
constructor(options: LinkMessagePortClientOptions) {
1616
this.peer = new ClientPeer((message) => {
1717
return postMessagePortMessage(options.port, message)
1818
})

packages/client/src/adapters/message-port/rpc-link.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { MessageChannel } from 'node:worker_threads'
22
import { decodeRequestMessage, encodeResponseMessage, MessageType } from '@orpc/standard-server-peer'
33
import { createORPCClient } from '../../client'
4-
import { experimental_RPCLink as RPCLink } from './rpc-link'
4+
import { RPCLink } from './rpc-link'
55

66
describe('rpcLink', () => {
77
let orpc: any

packages/client/src/adapters/message-port/rpc-link.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
import type { ClientContext } from '../../types'
22
import type { StandardRPCLinkOptions } from '../standard'
3-
import type { experimental_LinkMessagePortClientOptions } from './link-client'
3+
import type { LinkMessagePortClientOptions } from './link-client'
44
import { StandardRPCLink } from '../standard'
5-
import { experimental_LinkMessagePortClient as LinkMessagePortClient } from './link-client'
5+
import { LinkMessagePortClient } from './link-client'
66

7-
export interface experimental_RPCLinkOptions<T extends ClientContext>
8-
extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkMessagePortClientOptions {}
7+
export interface RPCLinkOptions<T extends ClientContext>
8+
extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkMessagePortClientOptions {}
99

1010
/**
1111
* The RPC Link for common message port implementations.
1212
*
1313
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
1414
* @see {@link https://orpc.unnoq.com/docs/adapters/message-port Message Port Adapter Docs}
1515
*/
16-
export class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
17-
constructor(options: experimental_RPCLinkOptions<T>) {
16+
export class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
17+
constructor(options: RPCLinkOptions<T>) {
1818
const linkClient = new LinkMessagePortClient(options)
1919
super(linkClient, { ...options, url: 'orpc:/' })
2020
}

0 commit comments

Comments
 (0)