mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
94 lines
2.9 KiB
TypeScript
94 lines
2.9 KiB
TypeScript
/**
|
|
* 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 type {
|
|
TestType,
|
|
PlaywrightTestArgs,
|
|
PlaywrightTestConfig as BasePlaywrightTestConfig,
|
|
PlaywrightTestOptions,
|
|
PlaywrightWorkerArgs,
|
|
PlaywrightWorkerOptions,
|
|
Locator,
|
|
} from '@playwright/test';
|
|
import type { InlineConfig } from 'vite';
|
|
|
|
export type PlaywrightTestConfig<T = {}, W = {}> = Omit<BasePlaywrightTestConfig<T, W>, 'use'> & {
|
|
use?: BasePlaywrightTestConfig<T, W>['use'] & {
|
|
ctPort?: number;
|
|
ctTemplateDir?: string;
|
|
ctCacheDir?: string;
|
|
ctViteConfig?: InlineConfig | (() => Promise<InlineConfig>);
|
|
};
|
|
};
|
|
|
|
type JsonPrimitive = string | number | boolean | null;
|
|
type JsonValue = JsonPrimitive | JsonObject | JsonArray;
|
|
type JsonArray = JsonValue[];
|
|
type JsonObject = { [Key in string]?: JsonValue };
|
|
|
|
type Slot = string | string[];
|
|
|
|
export interface MountOptions<
|
|
HooksConfig extends JsonObject,
|
|
Props extends Record<string, unknown>
|
|
> {
|
|
props?: Props;
|
|
slots?: Record<string, Slot> & { default?: Slot };
|
|
on?: Record<string, Function>;
|
|
hooksConfig?: HooksConfig;
|
|
}
|
|
|
|
interface MountResult<
|
|
Props extends Record<string, unknown>
|
|
> extends Locator {
|
|
unmount(): Promise<void>;
|
|
update(options: Omit<MountOptions<never, Props>, 'hooksConfig'>): Promise<void>;
|
|
}
|
|
|
|
interface MountResultJsx extends Locator {
|
|
unmount(): Promise<void>;
|
|
update(component: JSX.Element): Promise<void>;
|
|
}
|
|
|
|
export interface ComponentFixtures {
|
|
mount(component: JSX.Element): Promise<MountResultJsx>;
|
|
mount<HooksConfig extends JsonObject>(
|
|
component: any,
|
|
options?: MountOptions<HooksConfig, Record<string, unknown>>
|
|
): Promise<MountResult<Record<string, unknown>>>;
|
|
mount<
|
|
HooksConfig extends JsonObject,
|
|
Props extends Record<string, unknown> = Record<string, unknown>
|
|
>(
|
|
component: any,
|
|
options: MountOptions<HooksConfig, never> & { props: Props }
|
|
): Promise<MountResult<Props>>;
|
|
}
|
|
|
|
export const test: TestType<
|
|
PlaywrightTestArgs & PlaywrightTestOptions & ComponentFixtures,
|
|
PlaywrightWorkerArgs & PlaywrightWorkerOptions
|
|
>;
|
|
|
|
/**
|
|
* Defines Playwright config
|
|
*/
|
|
export function defineConfig(config: PlaywrightTestConfig): PlaywrightTestConfig;
|
|
export function defineConfig<T>(config: PlaywrightTestConfig<T>): PlaywrightTestConfig<T>;
|
|
export function defineConfig<T, W>(config: PlaywrightTestConfig<T, W>): PlaywrightTestConfig<T, W>;
|
|
|
|
export { expect, devices } from '@playwright/test';
|