79 lines
2.8 KiB
TypeScript
79 lines
2.8 KiB
TypeScript
/**
|
|
* 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 { Browser } from './Browser';
|
|
import { BrowserFetcher, BrowserFetcherOptions, BrowserFetcherRevisionInfo, OnProgressCallback } from '../browserFetcher';
|
|
import { ConnectionTransport } from '../types';
|
|
import { DeviceDescriptors, DeviceDescriptor } from '../deviceDescriptors';
|
|
import * as Errors from '../errors';
|
|
import { Launcher, LauncherBrowserOptions, LauncherChromeArgOptions, LauncherLaunchOptions, createBrowserFetcher } from './Launcher';
|
|
|
|
type Devices = { [name: string]: DeviceDescriptor } & DeviceDescriptor[];
|
|
|
|
export class Playwright {
|
|
private _projectRoot: string;
|
|
private _launcher: Launcher;
|
|
readonly _revision: string;
|
|
|
|
constructor(projectRoot: string, preferredRevision: string) {
|
|
this._projectRoot = projectRoot;
|
|
this._launcher = new Launcher(projectRoot, preferredRevision);
|
|
this._revision = preferredRevision;
|
|
}
|
|
|
|
async downloadBrowser(options?: BrowserFetcherOptions & { onProgress?: OnProgressCallback }): Promise<BrowserFetcherRevisionInfo> {
|
|
const fetcher = this.createBrowserFetcher(options);
|
|
const revisionInfo = fetcher.revisionInfo(this._revision);
|
|
await fetcher.download(this._revision, options ? options.onProgress : undefined);
|
|
return revisionInfo;
|
|
}
|
|
|
|
launch(options?: (LauncherLaunchOptions & LauncherChromeArgOptions & LauncherBrowserOptions) | undefined): Promise<Browser> {
|
|
return this._launcher.launch(options);
|
|
}
|
|
|
|
connect(options: (LauncherBrowserOptions & {
|
|
browserWSEndpoint?: string;
|
|
browserURL?: string;
|
|
transport?: ConnectionTransport; })): Promise<Browser> {
|
|
return this._launcher.connect(options);
|
|
}
|
|
|
|
executablePath(): string {
|
|
return this._launcher.executablePath();
|
|
}
|
|
|
|
get devices(): Devices {
|
|
const result = DeviceDescriptors.slice() as Devices;
|
|
for (const device of DeviceDescriptors)
|
|
result[device.name] = device;
|
|
return result;
|
|
}
|
|
|
|
get errors(): any {
|
|
return Errors;
|
|
}
|
|
|
|
defaultArgs(options: LauncherChromeArgOptions | undefined): string[] {
|
|
return this._launcher.defaultArgs(options);
|
|
}
|
|
|
|
createBrowserFetcher(options?: BrowserFetcherOptions): BrowserFetcher {
|
|
return createBrowserFetcher(this._projectRoot, options);
|
|
}
|
|
}
|