📦 microsoft / playwright

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71/**
 * Copyright 2017 Google Inc. All rights reserved.
 * Modifications copyright (c) Microsoft Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { ChannelOwner } from './channelOwner';
import { Events } from './events';
import { Page } from './page';

import type * as api from '../../types/types';
import type * as channels from '@protocol/channels';

type PageAgentOptions = {
  maxTokens?: number;
  maxTurns?: number;
  cacheKey?: string;
};

export class PageAgent extends ChannelOwner<channels.PageAgentChannel> implements api.PageAgent {
  private _page: Page;

  static from(channel: channels.PageAgentChannel): PageAgent {
    return (channel as any)._object;
  }

  constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.PageAgentInitializer) {
    super(parent, type, guid, initializer);
    this._page = Page.from(initializer.page);
    this._channel.on('turn', params => this.emit(Events.Page.AgentTurn, params));
  }

  async expect(expectation: string, options: PageAgentOptions = {}) {
    await this._channel.expect({ expectation, ...options });
  }

  async perform(task: string, options: PageAgentOptions = {}) {
    const { usage } = await this._channel.perform({ task, ...options });
    return { usage };
  }

  async extract<Schema extends any>(query: string, schema: Schema, options: PageAgentOptions = {}): Promise<{ result: any, usage: channels.AgentUsage }> {
    const { result, usage } = await this._channel.extract({ query, schema: this._page._platform.zodToJsonSchema(schema), ...options });
    return { result, usage };
  }

  async usage() {
    const { usage } = await this._channel.usage({});
    return usage;
  }

  async dispose() {
    await this._channel.dispose();
  }

  async [Symbol.asyncDispose]() {
    await this.dispose();
  }
}