@emesoft_company/playwright-core 2.1.0

package/dist/schema-y5w2hbT-.d.ts

@@ -0,0 +1,292 @@
+import { z } from 'zod';
+
+/** Environments seen most often across projects — autocompleted, but any string is accepted. */
+declare const KNOWN_ENVIRONMENTS: readonly ["local", "dev", "qa", "uat", "staging", "prod"];
+/**
+ * Free-form on purpose: teams run `uat`, `qa`, `sit`, per-tenant envs and so on. The union
+ * below keeps editor autocomplete for the common ones without rejecting anything else
+ * (`(string & {})` is the TS idiom that preserves suggestions on an open string type).
+ */
+type Environment = (typeof KNOWN_ENVIRONMENTS)[number] | (string & {});
+declare const EnvironmentSchema: z.ZodString;
+declare const TimeoutsSchema: z.ZodObject<{
+    actionMs: z.ZodDefault<z.ZodNumber>;
+    navigationMs: z.ZodDefault<z.ZodNumber>;
+    testMs: z.ZodDefault<z.ZodNumber>;
+    /** Default budget for `waitForCondition` and other non-locator polling. */
+    waitMs: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    actionMs: number;
+    navigationMs: number;
+    testMs: number;
+    waitMs: number;
+}, {
+    actionMs?: number | undefined;
+    navigationMs?: number | undefined;
+    testMs?: number | undefined;
+    waitMs?: number | undefined;
+}>;
+declare const AuthConfigSchema: z.ZodDefault<z.ZodObject<{
+    tokenUrl: z.ZodOptional<z.ZodString>;
+    clientId: z.ZodOptional<z.ZodString>;
+    clientSecret: z.ZodOptional<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    password: z.ZodOptional<z.ZodString>;
+    /** Single-session storage state file (see `buildGlobalSetup`). */
+    storageStatePath: z.ZodOptional<z.ZodString>;
+    /** Directory used for per-role storage state files in multi-role setups. */
+    storageStateDir: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    storageStateDir: string;
+    tokenUrl?: string | undefined;
+    clientId?: string | undefined;
+    clientSecret?: string | undefined;
+    username?: string | undefined;
+    password?: string | undefined;
+    storageStatePath?: string | undefined;
+}, {
+    tokenUrl?: string | undefined;
+    clientId?: string | undefined;
+    clientSecret?: string | undefined;
+    username?: string | undefined;
+    password?: string | undefined;
+    storageStatePath?: string | undefined;
+    storageStateDir?: string | undefined;
+}>>;
+declare const ReportingConfigSchema: z.ZodDefault<z.ZodObject<{
+    allureEnabled: z.ZodDefault<z.ZodBoolean>;
+    resultsDir: z.ZodDefault<z.ZodString>;
+    /** `{id}` is replaced with a test-case id — see `meta()` in `@emesoft_company/playwright-core/reporting`. */
+    testCaseUrlTemplate: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    allureEnabled: boolean;
+    resultsDir: string;
+    testCaseUrlTemplate?: string | undefined;
+}, {
+    allureEnabled?: boolean | undefined;
+    resultsDir?: string | undefined;
+    testCaseUrlTemplate?: string | undefined;
+}>>;
+declare const RetryConfigSchema: z.ZodDefault<z.ZodObject<{
+    retries: z.ZodDefault<z.ZodNumber>;
+    minDelayMs: z.ZodDefault<z.ZodNumber>;
+    maxDelayMs: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    retries: number;
+    minDelayMs: number;
+    maxDelayMs: number;
+}, {
+    retries?: number | undefined;
+    minDelayMs?: number | undefined;
+    maxDelayMs?: number | undefined;
+}>>;
+declare const DiagnosticsConfigSchema: z.ZodDefault<z.ZodObject<{
+    /** Collect browser console errors + failed requests and attach them to the report. */
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    /** Fail the test if the page logged a console error. Off by default — many apps are noisy. */
+    failOnConsoleError: z.ZodDefault<z.ZodBoolean>;
+    /** Fail the test on an uncaught page exception. */
+    failOnPageError: z.ZodDefault<z.ZodBoolean>;
+    /** Console messages matching any of these substrings are ignored entirely. */
+    ignoreConsolePatterns: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    enabled: boolean;
+    failOnConsoleError: boolean;
+    failOnPageError: boolean;
+    ignoreConsolePatterns: string[];
+}, {
+    enabled?: boolean | undefined;
+    failOnConsoleError?: boolean | undefined;
+    failOnPageError?: boolean | undefined;
+    ignoreConsolePatterns?: string[] | undefined;
+}>>;
+/**
+ * Base config schema shared by every project. Projects extend this via
+ * `AppConfigSchema.extend({ ... })` or by nesting project-specific fields
+ * under `custom` — core never hardcodes project business fields here.
+ */
+declare const AppConfigSchema: z.ZodObject<{
+    environment: z.ZodString;
+    baseUrl: z.ZodString;
+    apiBaseUrl: z.ZodOptional<z.ZodString>;
+    tenant: z.ZodOptional<z.ZodString>;
+    timeouts: z.ZodDefault<z.ZodObject<{
+        actionMs: z.ZodDefault<z.ZodNumber>;
+        navigationMs: z.ZodDefault<z.ZodNumber>;
+        testMs: z.ZodDefault<z.ZodNumber>;
+        /** Default budget for `waitForCondition` and other non-locator polling. */
+        waitMs: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        actionMs: number;
+        navigationMs: number;
+        testMs: number;
+        waitMs: number;
+    }, {
+        actionMs?: number | undefined;
+        navigationMs?: number | undefined;
+        testMs?: number | undefined;
+        waitMs?: number | undefined;
+    }>>;
+    auth: z.ZodDefault<z.ZodObject<{
+        tokenUrl: z.ZodOptional<z.ZodString>;
+        clientId: z.ZodOptional<z.ZodString>;
+        clientSecret: z.ZodOptional<z.ZodString>;
+        username: z.ZodOptional<z.ZodString>;
+        password: z.ZodOptional<z.ZodString>;
+        /** Single-session storage state file (see `buildGlobalSetup`). */
+        storageStatePath: z.ZodOptional<z.ZodString>;
+        /** Directory used for per-role storage state files in multi-role setups. */
+        storageStateDir: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        storageStateDir: string;
+        tokenUrl?: string | undefined;
+        clientId?: string | undefined;
+        clientSecret?: string | undefined;
+        username?: string | undefined;
+        password?: string | undefined;
+        storageStatePath?: string | undefined;
+    }, {
+        tokenUrl?: string | undefined;
+        clientId?: string | undefined;
+        clientSecret?: string | undefined;
+        username?: string | undefined;
+        password?: string | undefined;
+        storageStatePath?: string | undefined;
+        storageStateDir?: string | undefined;
+    }>>;
+    reporting: z.ZodDefault<z.ZodObject<{
+        allureEnabled: z.ZodDefault<z.ZodBoolean>;
+        resultsDir: z.ZodDefault<z.ZodString>;
+        /** `{id}` is replaced with a test-case id — see `meta()` in `@emesoft_company/playwright-core/reporting`. */
+        testCaseUrlTemplate: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        allureEnabled: boolean;
+        resultsDir: string;
+        testCaseUrlTemplate?: string | undefined;
+    }, {
+        allureEnabled?: boolean | undefined;
+        resultsDir?: string | undefined;
+        testCaseUrlTemplate?: string | undefined;
+    }>>;
+    retry: z.ZodDefault<z.ZodObject<{
+        retries: z.ZodDefault<z.ZodNumber>;
+        minDelayMs: z.ZodDefault<z.ZodNumber>;
+        maxDelayMs: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        retries: number;
+        minDelayMs: number;
+        maxDelayMs: number;
+    }, {
+        retries?: number | undefined;
+        minDelayMs?: number | undefined;
+        maxDelayMs?: number | undefined;
+    }>>;
+    diagnostics: z.ZodDefault<z.ZodObject<{
+        /** Collect browser console errors + failed requests and attach them to the report. */
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        /** Fail the test if the page logged a console error. Off by default — many apps are noisy. */
+        failOnConsoleError: z.ZodDefault<z.ZodBoolean>;
+        /** Fail the test on an uncaught page exception. */
+        failOnPageError: z.ZodDefault<z.ZodBoolean>;
+        /** Console messages matching any of these substrings are ignored entirely. */
+        ignoreConsolePatterns: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        failOnConsoleError: boolean;
+        failOnPageError: boolean;
+        ignoreConsolePatterns: string[];
+    }, {
+        enabled?: boolean | undefined;
+        failOnConsoleError?: boolean | undefined;
+        failOnPageError?: boolean | undefined;
+        ignoreConsolePatterns?: string[] | undefined;
+    }>>;
+    logLevel: z.ZodDefault<z.ZodEnum<["fatal", "error", "warn", "info", "debug", "trace", "silent"]>>;
+    custom: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    environment: string;
+    baseUrl: string;
+    timeouts: {
+        actionMs: number;
+        navigationMs: number;
+        testMs: number;
+        waitMs: number;
+    };
+    auth: {
+        storageStateDir: string;
+        tokenUrl?: string | undefined;
+        clientId?: string | undefined;
+        clientSecret?: string | undefined;
+        username?: string | undefined;
+        password?: string | undefined;
+        storageStatePath?: string | undefined;
+    };
+    reporting: {
+        allureEnabled: boolean;
+        resultsDir: string;
+        testCaseUrlTemplate?: string | undefined;
+    };
+    retry: {
+        retries: number;
+        minDelayMs: number;
+        maxDelayMs: number;
+    };
+    diagnostics: {
+        enabled: boolean;
+        failOnConsoleError: boolean;
+        failOnPageError: boolean;
+        ignoreConsolePatterns: string[];
+    };
+    logLevel: "fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent";
+    custom: Record<string, unknown>;
+    apiBaseUrl?: string | undefined;
+    tenant?: string | undefined;
+}, {
+    environment: string;
+    baseUrl: string;
+    apiBaseUrl?: string | undefined;
+    tenant?: string | undefined;
+    timeouts?: {
+        actionMs?: number | undefined;
+        navigationMs?: number | undefined;
+        testMs?: number | undefined;
+        waitMs?: number | undefined;
+    } | undefined;
+    auth?: {
+        tokenUrl?: string | undefined;
+        clientId?: string | undefined;
+        clientSecret?: string | undefined;
+        username?: string | undefined;
+        password?: string | undefined;
+        storageStatePath?: string | undefined;
+        storageStateDir?: string | undefined;
+    } | undefined;
+    reporting?: {
+        allureEnabled?: boolean | undefined;
+        resultsDir?: string | undefined;
+        testCaseUrlTemplate?: string | undefined;
+    } | undefined;
+    retry?: {
+        retries?: number | undefined;
+        minDelayMs?: number | undefined;
+        maxDelayMs?: number | undefined;
+    } | undefined;
+    diagnostics?: {
+        enabled?: boolean | undefined;
+        failOnConsoleError?: boolean | undefined;
+        failOnPageError?: boolean | undefined;
+        ignoreConsolePatterns?: string[] | undefined;
+    } | undefined;
+    logLevel?: "fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent" | undefined;
+    custom?: Record<string, unknown> | undefined;
+}>;
+type AppConfig = Omit<z.infer<typeof AppConfigSchema>, "environment"> & {
+    environment: Environment;
+};
+type TimeoutsConfig = z.infer<typeof TimeoutsSchema>;
+type AuthConfig = z.infer<typeof AuthConfigSchema>;
+type ReportingConfig = z.infer<typeof ReportingConfigSchema>;
+type RetryConfig = z.infer<typeof RetryConfigSchema>;
+type DiagnosticsConfig = z.infer<typeof DiagnosticsConfigSchema>;
+
+export { type AppConfig as A, type DiagnosticsConfig as D, type Environment as E, KNOWN_ENVIRONMENTS as K, type ReportingConfig as R, type TimeoutsConfig as T, AppConfigSchema as a, type AuthConfig as b, AuthConfigSchema as c, DiagnosticsConfigSchema as d, EnvironmentSchema as e, ReportingConfigSchema as f, type RetryConfig as g, RetryConfigSchema as h, TimeoutsSchema as i };

package/dist/types-CbWnSYEK.d.cts

@@ -0,0 +1,5 @@
+type DeepPartial<T> = T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+
+export type { DeepPartial as D };

package/dist/types-CbWnSYEK.d.ts

@@ -0,0 +1,5 @@
+type DeepPartial<T> = T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+
+export type { DeepPartial as D };

package/dist/types-CopwwpSW.d.cts

@@ -0,0 +1,8 @@
+interface TokenProvider {
+    /** Returns a valid access token, refreshing/caching internally as needed. */
+    getToken(): Promise<string>;
+    /** Drops any cached token, forcing the next `getToken()` to re-authenticate. */
+    invalidate(): void;
+}
+
+export type { TokenProvider as T };

package/dist/types-CopwwpSW.d.ts

@@ -0,0 +1,8 @@
+interface TokenProvider {
+    /** Returns a valid access token, refreshing/caching internally as needed. */
+    getToken(): Promise<string>;
+    /** Drops any cached token, forcing the next `getToken()` to re-authenticate. */
+    invalidate(): void;
+}
+
+export type { TokenProvider as T };

package/dist/types-hInbkPXf.d.cts

@@ -0,0 +1,59 @@
+import { ZodType } from 'zod';
+
+/** File payload for a multipart upload. */
+interface MultipartFile {
+    name: string;
+    mimeType: string;
+    buffer: Buffer;
+}
+interface ApiRequestOptions<T = unknown> {
+    headers?: Record<string, string>;
+    params?: Record<string, string | number | boolean | undefined>;
+    /** JSON body (objects are serialized by Playwright). */
+    data?: unknown;
+    /** `application/x-www-form-urlencoded` body. */
+    form?: Record<string, string | number | boolean>;
+    /** `multipart/form-data` body, for file uploads. */
+    multipart?: Record<string, string | number | boolean | MultipartFile>;
+    timeoutMs?: number;
+    /** Skip attaching the Authorization header for this call (e.g. public endpoints). */
+    skipAuth?: boolean;
+    /**
+     * Status code(s) to treat as success. Defaults to any 2xx. Set it to assert an exact
+     * contract (`expectStatus: 201`) or to accept an expected error (`expectStatus: [200, 404]`)
+     * without the call throwing.
+     */
+    expectStatus?: number | number[];
+    /**
+     * Validates (and types) the response body. When given, `T` is inferred from the schema and a
+     * shape mismatch fails the call with a clear error instead of surfacing later as `undefined`.
+     */
+    schema?: ZodType<T>;
+}
+/** Full response, for when the status/headers matter as much as the body. */
+interface ApiResponse<T = unknown> {
+    status: number;
+    ok: boolean;
+    headers: Record<string, string>;
+    data: T;
+    url: string;
+    method: string;
+}
+interface RequestContext {
+    method: string;
+    url: string;
+    headers: Record<string, string>;
+}
+interface ResponseContext {
+    method: string;
+    url: string;
+    status: number;
+}
+interface ApiClientInterceptors {
+    /** Runs right before the request is sent; return modified headers or void to leave them as-is. */
+    onRequest?: (ctx: RequestContext) => Record<string, string> | void | Promise<Record<string, string> | void>;
+    /** Runs after every response, success or failure, before retry/error handling. */
+    onResponse?: (ctx: ResponseContext) => void | Promise<void>;
+}
+
+export type { ApiClientInterceptors as A, MultipartFile as M, RequestContext as R, ApiRequestOptions as a, ApiResponse as b, ResponseContext as c };

package/dist/types-hInbkPXf.d.ts

@@ -0,0 +1,59 @@
+import { ZodType } from 'zod';
+
+/** File payload for a multipart upload. */
+interface MultipartFile {
+    name: string;
+    mimeType: string;
+    buffer: Buffer;
+}
+interface ApiRequestOptions<T = unknown> {
+    headers?: Record<string, string>;
+    params?: Record<string, string | number | boolean | undefined>;
+    /** JSON body (objects are serialized by Playwright). */
+    data?: unknown;
+    /** `application/x-www-form-urlencoded` body. */
+    form?: Record<string, string | number | boolean>;
+    /** `multipart/form-data` body, for file uploads. */
+    multipart?: Record<string, string | number | boolean | MultipartFile>;
+    timeoutMs?: number;
+    /** Skip attaching the Authorization header for this call (e.g. public endpoints). */
+    skipAuth?: boolean;
+    /**
+     * Status code(s) to treat as success. Defaults to any 2xx. Set it to assert an exact
+     * contract (`expectStatus: 201`) or to accept an expected error (`expectStatus: [200, 404]`)
+     * without the call throwing.
+     */
+    expectStatus?: number | number[];
+    /**
+     * Validates (and types) the response body. When given, `T` is inferred from the schema and a
+     * shape mismatch fails the call with a clear error instead of surfacing later as `undefined`.
+     */
+    schema?: ZodType<T>;
+}
+/** Full response, for when the status/headers matter as much as the body. */
+interface ApiResponse<T = unknown> {
+    status: number;
+    ok: boolean;
+    headers: Record<string, string>;
+    data: T;
+    url: string;
+    method: string;
+}
+interface RequestContext {
+    method: string;
+    url: string;
+    headers: Record<string, string>;
+}
+interface ResponseContext {
+    method: string;
+    url: string;
+    status: number;
+}
+interface ApiClientInterceptors {
+    /** Runs right before the request is sent; return modified headers or void to leave them as-is. */
+    onRequest?: (ctx: RequestContext) => Record<string, string> | void | Promise<Record<string, string> | void>;
+    /** Runs after every response, success or failure, before retry/error handling. */
+    onResponse?: (ctx: ResponseContext) => void | Promise<void>;
+}
+
+export type { ApiClientInterceptors as A, MultipartFile as M, RequestContext as R, ApiRequestOptions as a, ApiResponse as b, ResponseContext as c };