mirror of
https://github.com/microsoft/playwright.git
synced 2024-12-15 06:02:57 +03:00
88 lines
2.9 KiB
TypeScript
88 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 { JsonObject } from '@playwright/experimental-ct-core/types/component';
|
|
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 Slot = string | string[];
|
|
type ComponentSlots = Record<string, Slot> & { default?: Slot };
|
|
|
|
type ComponentEvents = Record<string, Function>;
|
|
|
|
// Copied from: https://github.com/vuejs/language-tools/blob/master/packages/vue-component-type-helpers/index.d.ts#L10-L13
|
|
type ComponentProps<T> =
|
|
T extends new () => { $props: infer P; } ? NonNullable<P> :
|
|
T extends (props: infer P, ...args: any) => any ? P :
|
|
{};
|
|
|
|
export interface MountOptions<HooksConfig extends JsonObject, Component> {
|
|
props?: ComponentProps<Component>;
|
|
slots?: ComponentSlots;
|
|
on?: ComponentEvents;
|
|
hooksConfig?: HooksConfig;
|
|
}
|
|
|
|
interface MountResult<Component> extends Locator {
|
|
unmount(): Promise<void>;
|
|
update(options: {
|
|
props?: Partial<ComponentProps<Component>>;
|
|
slots?: Partial<ComponentSlots>;
|
|
on?: Partial<ComponentEvents>;
|
|
}): 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 = unknown>(
|
|
component: Component,
|
|
options?: MountOptions<HooksConfig, Component>
|
|
): Promise<MountResult<Component>>;
|
|
}
|
|
|
|
export const test: TestType<
|
|
PlaywrightTestArgs & PlaywrightTestOptions & ComponentFixtures,
|
|
PlaywrightWorkerArgs & PlaywrightWorkerOptions
|
|
>;
|
|
|
|
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';
|