chore(protocol): split channel and dispatcher types

.claude/skills/playwright-dev/library.md

@@ -7,12 +7,12 @@ Playwright uses a client-server architecture connected by a protocol layer. The
 ```
 packages/protocol/src/
   protocol.yml              — RPC protocol definition (source of truth)
-  channels.d.ts             — generated TypeScript channel interfaces
-  callMetadata.d.ts         — call metadata types
 
 packages/playwright-core/src/
   client/                   — public API objects (ChannelOwner subclasses)
+    channels.d.ts           — generated client channel interfaces
   server/                   — browser automation implementation (SdkObject subclasses)
+    channels.d.ts           — generated server channel interfaces
   server/dispatchers/       — protocol bridge (Dispatcher subclasses)
   protocol/                 — validators (generated + primitives)
   utils/isomorphic/         — shared code used by both client and server

packages/dashboard/vite.config.ts

@@ -27,7 +27,6 @@ export default defineConfig({
   resolve: {
     alias: {
       '@isomorphic': path.resolve(__dirname, '../isomorphic'),
-      '@protocol': path.resolve(__dirname, '../protocol/src'),
       '@web': path.resolve(__dirname, '../web/src'),
       '@trace-viewer': path.resolve(__dirname, '../trace-viewer/src'),
     },

packages/injected/src/injectedScript.ts

@@ -37,7 +37,6 @@ import type { AriaTemplateNode } from '@isomorphic/ariaSnapshot';
 import type { CSSComplexSelectorList } from '@isomorphic/cssParser';
 import type { Language } from '@isomorphic/locatorGenerators';
 import type { AttributeSelectorPart, NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';
-import type * as channels from '@protocol/channels';
 import type { AriaSnapshot, AriaTreeOptions } from './ariaSnapshot';
 import type { LayoutSelectorName } from './layoutSelectorUtils';
 import type { SelectorEngine, SelectorRoot } from './selectorEngine';
@@ -46,8 +45,28 @@ import type { ElementText, TextMatcher } from './selectorUtils';
 import type { Builtins } from './utilityScript';
 
 
-export type FrameExpectParams = Omit<channels.FrameExpectParams, 'expectedValue' | 'timeout'> & {
-  expectedValue?: any;
+type ExpectedTextValue = {
+  string?: string,
+  regexSource?: string,
+  regexFlags?: string,
+  matchSubstring?: boolean,
+  ignoreCase?: boolean,
+  normalizeWhiteSpace?: boolean,
+};
+
+type Point = { x: number, y: number };
+type Rect = Point & { width: number, height: number };
+
+export type FrameExpectParams = {
+  selector?: string,
+  expression: string,
+  expressionArg?: any,
+  pseudo?: 'before' | 'after',
+  expectedText?: ExpectedTextValue[],
+  expectedNumber?: number,
+  expectedValue?: any,
+  useInnerText?: boolean,
+  isNot: boolean,
 };
 
 export type ElementState = 'visible' | 'hidden' | 'enabled' | 'disabled' | 'editable' | 'checked' | 'unchecked' | 'indeterminate' | 'stable';
@@ -1337,7 +1356,7 @@ export class InjectedScript {
     highlight.removeElementHighlight(selector);
   }
 
-  setScreencastAnnotation(annotation: { point?: channels.Point, box?: channels.Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
+  setScreencastAnnotation(annotation: { point?: Point, box?: Rect, actionTitle?: string, duration?: number, position?: string, fontSize?: number, cursor?: 'none' | 'pointer' } | null) {
     const highlight = this._ensureHighlight();
     if (!annotation) {
       highlight.updateHighlight([]);
@@ -1722,7 +1741,7 @@ export class InjectedScript {
   }
 
   private _matchSequentially<T>(
-    expectedText: channels.ExpectedTextValue[],
+    expectedText: ExpectedTextValue[],
     received: T[],
     matchFn: (matcher: ExpectedTextMatcher, received: T) => boolean
   ): boolean {
@@ -1811,7 +1830,7 @@ class ExpectedTextMatcher {
   private _normalizeWhiteSpace: boolean | undefined;
   private _ignoreCase: boolean | undefined;
 
-  constructor(expected: channels.ExpectedTextValue) {
+  constructor(expected: ExpectedTextValue) {
     this._normalizeWhiteSpace = expected.normalizeWhiteSpace;
     this._ignoreCase = expected.ignoreCase;
     this._string = expected.matchSubstring ? undefined : this.normalize(expected.string);

packages/injected/src/storageScript.ts

@@ -16,9 +16,42 @@
 
 import { parseEvaluationResultValue, serializeAsCallArgument } from '@isomorphic/utilityScriptSerializers';
 
-import type * as channels from '@protocol/channels';
-
-export type SerializedStorage = Omit<channels.OriginStorage, 'origin'>;
+type NameValue = { name: string, value: string };
+
+type IndexedDBDatabase = {
+  name: string,
+  version: number,
+  stores: {
+    name: string,
+    autoIncrement: boolean,
+    keyPath?: string,
+    keyPathArray?: string[],
+    records: {
+      key?: any,
+      keyEncoded?: any,
+      value?: any,
+      valueEncoded?: any,
+    }[],
+    indexes: {
+      name: string,
+      keyPath?: string,
+      keyPathArray?: string[],
+      multiEntry: boolean,
+      unique: boolean,
+    }[],
+  }[],
+};
+
+type SetOriginStorage = {
+  origin: string,
+  localStorage: NameValue[],
+  indexedDB?: IndexedDBDatabase[],
+};
+
+export type SerializedStorage = {
+  localStorage: NameValue[],
+  indexedDB?: IndexedDBDatabase[],
+};
 
 export class StorageScript {
   private _isFirefox: boolean;
@@ -85,7 +118,7 @@ export class StorageScript {
 
       const keys = await this._idbRequestToPromise(objectStore.getAllKeys());
       const records = await Promise.all(keys.map(async key => {
-        const record: channels.IndexedDBDatabase['stores'][0]['records'][0] = {};
+        const record: IndexedDBDatabase['stores'][0]['records'][0] = {};
 
         if (objectStore.keyPath === null) {
           const { encoded, trivial } = this._trySerialize(key);
@@ -146,7 +179,7 @@ export class StorageScript {
     }
   }
 
-  private async _restoreDB(dbInfo: channels.IndexedDBDatabase) {
+  private async _restoreDB(dbInfo: IndexedDBDatabase) {
     const openRequest = this._global.indexedDB.open(dbInfo.name, dbInfo.version);
     openRequest.addEventListener('upgradeneeded', () => {
       const db = openRequest.result;
@@ -176,7 +209,7 @@ export class StorageScript {
     }));
   }
 
-  async restore(originState: channels.SetOriginStorage | undefined) {
+  async restore(originState: SetOriginStorage | undefined) {
     // Clean Service Workers.
     const registrations = this._global.navigator.serviceWorker ? await this._global.navigator.serviceWorker.getRegistrations() : [];
     await Promise.all(registrations.map(async r => {

packages/isomorphic/index.ts

@@ -15,7 +15,6 @@
  */
 
 export * from './ariaSnapshot';
-export * from './expectUtils';
 export * from './assert';
 export * from './base64';
 export * from './colors';

packages/isomorphic/platform.ts

@@ -20,7 +20,6 @@ import type * as fs from 'fs';
 import type * as path from 'path';
 import type { Readable, Writable } from 'stream';
 import type { Colors } from '@isomorphic/colors';
-import type * as channels from '@protocol/channels';
 
 export type Zone = {
   push(data: unknown): Zone;
@@ -29,6 +28,16 @@ export type Zone = {
   data<T>(): T | undefined;
 };
 
+export type StreamChannel = {
+  read(params: { size?: number }): Promise<{ binary: Buffer }>;
+  close(params?: {}): Promise<any>;
+};
+
+export type WritableStreamChannel = {
+  write(params: { binary: Buffer }): Promise<any>;
+  close(params?: {}): Promise<any>;
+};
+
 const noopZone: Zone = {
   push: () => noopZone,
   pop: () => noopZone,
@@ -57,8 +66,8 @@ export type Platform = {
   pathSeparator: string;
   showInternalStackFrames: () => boolean,
   streamFile: (path: string, writable: Writable) => Promise<void>,
-  streamReadable: (channel: channels.StreamChannel) => Readable,
-  streamWritable: (channel: channels.WritableStreamChannel) => Writable,
+  streamReadable: (channel: StreamChannel) => Readable,
+  streamWritable: (channel: WritableStreamChannel) => Writable,
   zones: { empty: Zone, current: () => Zone; };
 };
 
@@ -111,11 +120,11 @@ export const emptyPlatform: Platform = {
     throw new Error('Streams are not available');
   },
 
-  streamReadable: (channel: channels.StreamChannel) => {
+  streamReadable: (channel: StreamChannel) => {
     throw new Error('Streams are not available');
   },
 
-  streamWritable: (channel: channels.WritableStreamChannel) => {
+  streamWritable: (channel: WritableStreamChannel) => {
     throw new Error('Streams are not available');
   },
 

packages/isomorphic/trace/traceModel.ts

@@ -16,12 +16,12 @@
 
 import { getActionGroup, renderTitleForCall } from '../protocolFormatter';
 
+import type { StackFrame } from '../stackTrace';
 import type { Language } from '../locatorGenerators';
 import type { ResourceSnapshot } from '@trace/snapshot';
 import type * as trace from '@trace/trace';
 import type { ActionTraceEvent } from '@trace/trace';
 import type { ActionEntry, ContextEntry, PageEntry } from './entries';
-import type { StackFrame } from '@protocol/channels';
 import type { ActionGroup } from '../protocolFormatter';
 
 const contextSymbol = Symbol('context');

packages/isomorphic/trace/traceUtils.ts

@@ -14,7 +14,12 @@
  * limitations under the License.
  */
 
-import type { ClientSideCallMetadata, StackFrame } from '@protocol/channels';
+import type { StackFrame } from '../stackTrace';
+
+type ClientSideCallMetadata = {
+  id: number,
+  stack?: StackFrame[],
+};
 
 export type SerializedStackFrame = [number, number, number, string];
 export type SerializedStack = [number, SerializedStackFrame[]];

packages/playwright-core/src/client/android.ts

@@ -31,7 +31,7 @@ import type * as types from './types';
 import type * as api from '../../types/types';
 import type { AndroidServerLauncherImpl } from '../androidServerImpl';
 import type { Platform } from '@isomorphic/platform';
-import type * as channels from '@protocol/channels';
+import type * as channels from './channels';
 import type { Playwright } from './playwright';
 
 type Direction = 'down' | 'up' | 'left' | 'right';

packages/playwright-core/src/client/artifact.ts

@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';
 import { Stream } from './stream';
 import { mkdirIfNeeded } from './fileUtils';
 
-import type * as channels from '@protocol/channels';
+import type * as channels from './channels';
 import type { Readable } from 'stream';
 
 export class Artifact extends ChannelOwner<channels.ArtifactChannel> {

packages/playwright-core/src/client/browser.ts

@@ -26,7 +26,7 @@ import type { BrowserType } from './browserType';
 import type { Page } from './page';
 import type { BrowserContextOptions, LaunchOptions, Logger } from './types';
 import type * as api from '../../types/types';
-import type * as channels from '@protocol/channels';
+import type * as channels from './channels';
 
 export class Browser extends ChannelOwner<channels.BrowserChannel> implements api.Browser {
   readonly _contexts = new Set<BrowserContext>();

packages/playwright-core/src/client/browserContext.ts

@@ -48,7 +48,7 @@ import type * as structs from '../../types/structs';
 import type * as api from '../../types/types';
 import type { URLMatch } from '@isomorphic/urlMatch';
 import type { Platform } from '@isomorphic/platform';
-import type * as channels from '@protocol/channels';
+import type * as channels from './channels';
 import type * as actions from '@recorder/actions';
 
 interface RecorderEventSink {

packages/playwright-core/src/client/browserType.ts

@@ -27,7 +27,7 @@ import { Worker } from './worker';
 import type { Playwright } from './playwright';
 import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, LaunchServerOptions } from './types';
 import type * as api from '../../types/types';
-import type * as channels from '@protocol/channels';
+import type * as channels from './channels';
 import type { ChildProcess } from 'child_process';
 
 export interface BrowserServerLauncher {

packages/playwright-core/src/client/cdpSession.ts

@@ -18,7 +18,7 @@ import { ChannelOwner } from './channelOwner';
 
 import type * as api from '../../types/types';
 import type { Protocol } from '../server/chromium/protocol';
-import type * as channels from '@protocol/channels';
+import type * as channels from './channels';
 
 export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> implements api.CDPSession {
   static from(cdpSession: channels.CDPSessionChannel): CDPSession {

packages/playwright-core/src/client/channelOwner.ts

@@ -25,7 +25,7 @@ import type { Connection } from './connection';
 import type { Logger } from './types';
 import type { ValidatorContext } from '../protocol/validator';
 import type { Platform } from '@isomorphic/platform';
-import type * as channels from '@protocol/channels';
+import type * as channels from './channels';
 
 type Listener = (...args: any[]) => void;