@amazon/vinyl-util 1.0.0

package/dist/testUtil/types/current/util/initializeUncaughtErrorLogging.js

@@ -0,0 +1,20 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+let loggingUncaughtErrors = false;
+/**
+ * Logs uncaught errors and promise rejections to the console, to be emitted to the report api.
+ * Jasmine catches uncaught errors and only reports the message in the test failure, not the whole error event.
+ */
+export function initializeUncaughtErrorLogging() {
+    if (loggingUncaughtErrors)
+        return;
+    loggingUncaughtErrors = true;
+    window.addEventListener('error', (event) => {
+        console.error('uncaught error event:', event);
+    });
+    window.addEventListener('unhandledrejection', (event) => {
+        console.error('unhandled rejection:', event);
+    });
+}

package/dist/testUtil/types/ts3.7/error/uncaughtErrorUtil.d.ts

@@ -0,0 +1,15 @@
+import { CodeRange } from '@amazon/vinyl-util';
+import { MockEventTarget } from '@amazon/vinyl-util/browserTestUtil';
+/**
+ * Creates a code range object surrounding the given error.
+ */
+export declare function createRangeSurrounding(error: Error): CodeRange;
+/**
+ * Simulates an uncaught error event.
+ */
+export declare function throwMockError(target: MockEventTarget, error: any): void;
+/**
+ * Simulates an unhandled rejection to be caught by the global unhandled promise handler.
+ */
+export declare function rejectMockPromise(target: MockEventTarget, reason: any): void;
+//# sourceMappingURL=uncaughtErrorUtil.d.ts.map

package/dist/testUtil/types/ts3.7/global/overrideGlobalInit.d.ts

@@ -0,0 +1,5 @@
+import { GlobalRef } from '@amazon/vinyl-util';
+export declare function overrideGlobalInit<T, U extends T>(initHandle: GlobalRef<T>, initOverride: () => U): {
+    readonly value: U;
+};
+//# sourceMappingURL=overrideGlobalInit.d.ts.map

package/dist/testUtil/types/ts3.7/index.d.ts

@@ -0,0 +1,20 @@
+/** Auto-generated from build scripts */
+export * from './util/initializeUncaughtErrorLogging';
+export * from './util/event/createEventSpy';
+export * from './reporters/RestApiReporter';
+export * from './reporters/LogReporter';
+export * from './patch/addPatchTests';
+export * from './mock/util/spyOnPropertySafe';
+export * from './mock/persistence/MockPersistence';
+export * from './mock/network/emptyRequestInfo';
+export * from './mock/network/MockRequester';
+export * from './mock/network/MockNetworkState';
+export * from './mock/network/MockNetworkMetricsController';
+export * from './mock/network/MockNetworkInformation';
+export * from './mock/navigator/setMockNavigator';
+export * from './mock/logging/MockLogger';
+export * from './mock/event/emptyLogTarget';
+export * from './mock/event/MockEventHost';
+export * from './global/overrideGlobalInit';
+export * from './error/uncaughtErrorUtil';
+//# sourceMappingURL=index.d.ts.map

package/dist/testUtil/types/ts3.7/mock/event/MockEventHost.d.ts

@@ -0,0 +1,15 @@
+import { EventHostImpl } from '@amazon/vinyl-util';
+/**
+ * MockEventHost creates spies with pass-through calls to the EventHost implementation.
+ * While this is not a true mock, events become easier to test when using a real event dispatcher.
+ */
+export declare class MockEventHost<EventMap = any> extends EventHostImpl<EventMap> {
+    private readonly spyFactory;
+    logPrefix: string;
+    hasAnyListeners: import("@amazon/vinyl-util/browserTestUtil").Spy2<(() => boolean) & (() => any)>;
+    hasListeners: import("@amazon/vinyl-util/browserTestUtil").Spy2<((type: keyof EventMap) => boolean) & ((type: keyof EventMap) => any)>;
+    dispatch: import("@amazon/vinyl-util/browserTestUtil").Spy2<(<K extends keyof EventMap>(type: K, event: EventMap[K]) => void)>;
+    on: import("@amazon/vinyl-util/browserTestUtil").Spy2<(<K extends keyof EventMap>(type: K, handler: import("@amazon/vinyl-util").EventHandler<EventMap[K]>, options?: import("@amazon/vinyl-util").SignalOptions) => import("@amazon/vinyl-util").Unsubscribe) & ((type: keyof EventMap, handler: import("@amazon/vinyl-util").EventHandler<EventMap[keyof EventMap]>, options?: import("@amazon/vinyl-util").SignalOptions | undefined) => any)>;
+    dispose: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;
+}
+//# sourceMappingURL=MockEventHost.d.ts.map

package/dist/testUtil/types/ts3.7/mock/event/emptyLogTarget.d.ts

@@ -0,0 +1,3 @@
+import { LogTarget } from '@amazon/vinyl-util';
+export declare const emptyLogTarget: LogTarget;
+//# sourceMappingURL=emptyLogTarget.d.ts.map

package/dist/testUtil/types/ts3.7/mock/logging/MockLogger.d.ts

@@ -0,0 +1,18 @@
+import { LogEventMap, Logger, LogTarget } from '@amazon/vinyl-util';
+import { LogLevel } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+type LogFilterFun = (target: LogTarget, ...messages: any[]) => void;
+export declare class MockLogger extends MockEventHost<LogEventMap> implements Logger {
+    logLevel: LogLevel;
+    log: jasmine.Spy<(target: LogTarget, level: LogLevel, ...messages: readonly any[]) => void>;
+    verbose: jasmine.Spy<LogFilterFun>;
+    debug: jasmine.Spy<LogFilterFun>;
+    info: jasmine.Spy<LogFilterFun>;
+    warn: jasmine.Spy<LogFilterFun>;
+    error: jasmine.Spy<LogFilterFun>;
+}
+export declare function useMockLogger(): {
+    readonly value: MockLogger;
+};
+export {};
+//# sourceMappingURL=MockLogger.d.ts.map

package/dist/testUtil/types/ts3.7/mock/navigator/setMockNavigator.d.ts

@@ -0,0 +1,7 @@
+import { MockNavigator } from '@amazon/vinyl-util/browserTestUtil';
+/**
+ * Sets the global navigator to a Mock
+ * Returns the new MockNavigator instance.
+ */
+export declare function setMockNavigator(): MockNavigator;
+//# sourceMappingURL=setMockNavigator.d.ts.map

package/dist/testUtil/types/ts3.7/mock/network/MockNetworkInformation.d.ts

@@ -0,0 +1,10 @@
+import { NetworkInformation, NetworkInformationEffectiveType, NetworkInformationType } from '@amazon/vinyl-util';
+import { MockEventTarget } from '@amazon/vinyl-util/browserTestUtil';
+export declare class MockNetworkInformation extends MockEventTarget implements NetworkInformation {
+    downlink: number | undefined;
+    effectiveType: NetworkInformationEffectiveType;
+    rtt: number;
+    saveData: boolean;
+    type?: NetworkInformationType;
+}
+//# sourceMappingURL=MockNetworkInformation.d.ts.map

package/dist/testUtil/types/ts3.7/mock/network/MockNetworkMetricsController.d.ts

@@ -0,0 +1,10 @@
+import { NetworkMetrics, NetworkMetricsController, NetworkMetricsEventMap } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+export declare class MockNetworkMetricsController extends MockEventHost<NetworkMetricsEventMap> implements NetworkMetricsController {
+    maxHistorySize: number;
+    metrics: NetworkMetrics;
+    addMetricsEntry: import("@amazon/vinyl-util/browserTestUtil").Spy2<(entry: import("@amazon/vinyl-util").NetworkMetricsEntry) => void>;
+    getServiceMetrics: import("@amazon/vinyl-util/browserTestUtil").Spy2<((serviceId: import("@amazon/vinyl-util").Maybe<string>) => import("@amazon/vinyl-util").ServiceMetrics) & ((serviceId: import("@amazon/vinyl-util").Maybe<string>) => any)>;
+    addDownlinkTransferEntry: import("@amazon/vinyl-util/browserTestUtil").Spy2<(entry: import("@amazon/vinyl-util").NetworkTransferEntry) => void>;
+}
+//# sourceMappingURL=MockNetworkMetricsController.d.ts.map

package/dist/testUtil/types/ts3.7/mock/network/MockNetworkState.d.ts

@@ -0,0 +1,7 @@
+import { NetworkState, NetworkStateEventMap } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+export declare class MockNetworkState extends MockEventHost<NetworkStateEventMap> implements NetworkState {
+    onLine: boolean;
+    nextOnLine: import("@amazon/vinyl-util/browserTestUtil").Spy2<((abort?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").ReadonlyAbort>) => Promise<void>) & ((abort?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").ReadonlyAbort>) => any)>;
+}
+//# sourceMappingURL=MockNetworkState.d.ts.map

package/dist/testUtil/types/ts3.7/mock/network/MockRequester.d.ts

@@ -0,0 +1,6 @@
+import { Requester, RequesterImplEventMap } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+export declare class MockRequester extends MockEventHost<RequesterImplEventMap> implements Requester {
+    request: import("@amazon/vinyl-util/browserTestUtil").Spy2<((input: RequestInfo | Readonly<URL>, init?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").RequestInitOptions>, requestOptions?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").RequestOptions>) => Promise<Response>) & ((input: RequestInfo | Readonly<URL>, init?: import("@amazon/vinyl-util").Maybe<Readonly<Omit<RequestInit, "signal">>>, requestOptions?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").RequestOptions>) => any)>;
+}
+//# sourceMappingURL=MockRequester.d.ts.map

package/dist/testUtil/types/ts3.7/mock/network/emptyRequestInfo.d.ts

@@ -0,0 +1,10 @@
+import { FetchRequestInfo, RequestAttemptInfo, RequestCaughtErrorEvent, RequestNetworkErrorEvent, RequestResponseErrorEvent, RequestSuccessEvent, ResponseInfo } from '@amazon/vinyl-util';
+export declare const emptyRequestInfo: FetchRequestInfo;
+export declare const emptyRequestAttemptInfo: RequestAttemptInfo;
+export declare const emptyResponseInfo: ResponseInfo;
+export declare const emptyRequestSuccessEvent: RequestSuccessEvent;
+export declare const emptyInternalError: RequestCaughtErrorEvent;
+export declare const emptyNetworkError: RequestNetworkErrorEvent;
+export declare const emptyResponseError: RequestResponseErrorEvent;
+export declare const emptyAbortError: RequestCaughtErrorEvent;
+//# sourceMappingURL=emptyRequestInfo.d.ts.map

package/dist/testUtil/types/ts3.7/mock/persistence/MockPersistence.d.ts

@@ -0,0 +1,9 @@
+import { KeyValuePersistence } from '@amazon/vinyl-util';
+export declare class MockPersistence<T = any> implements KeyValuePersistence<T> {
+    private readonly spyFactory;
+    clear: import("@amazon/vinyl-util/browserTestUtil").Spy2<(() => Promise<void>) & (() => any)>;
+    get: import("@amazon/vinyl-util/browserTestUtil").Spy2<((key: string) => Promise<T | null>) & ((key: string) => any)>;
+    remove: import("@amazon/vinyl-util/browserTestUtil").Spy2<((key: string) => Promise<void>) & ((key: string) => any)>;
+    set: import("@amazon/vinyl-util/browserTestUtil").Spy2<((key: string, value: T) => Promise<void>) & ((key: string, value: T) => any)>;
+}
+//# sourceMappingURL=MockPersistence.d.ts.map

package/dist/testUtil/types/ts3.7/mock/util/spyOnPropertySafe.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A wrapper to jasmine spyOnProperty for property getters that will define property
+ * if it doesn't exist.
+ */
+export declare function spyOnPropertySafe<T extends object, K extends keyof T = keyof T>(object: T, property: K): jasmine.Spy<(this: T) => T[K]>;
+//# sourceMappingURL=spyOnPropertySafe.d.ts.map

package/dist/testUtil/types/ts3.7/patch/addPatchTests.d.ts

@@ -0,0 +1,35 @@
+import { PatchedRef } from '@amazon/vinyl-util';
+export interface PatchTestOptions<T> {
+    /**
+     * True if the patch is enabled by default.
+     */
+    actualFlag: boolean | undefined;
+    /**
+     * The target, not patched.
+     */
+    target: T;
+    /**
+     * The patched target.
+     */
+    patchedRef: PatchedRef<T>;
+    /**
+     * Runs the scenario to reproduce the issue on the target.
+     * @param target
+     */
+    canReproduce: (target: T) => Promise<boolean>;
+    /**
+     * If true and the tested flag is true but the issue cannot be reproduced, then only a
+     * warning is logged, if false, then the test will be marked as a failure.
+     */
+    allowFalseNegative: boolean;
+}
+/**
+ * Adds tests to ensure that a patch flag is enabled when the issue can be reproduced for the UA,
+ * and when the patch is applied the issue is no longer reproducible.
+ *
+ * @param flagName The flag name, used in test descriptions.
+ * @param description The condition which requires the patch to be enabled.
+ * @param optionsProvider
+ */
+export declare function addPatchTests<T>(flagName: string, description: string, optionsProvider: () => PatchTestOptions<T>): void;
+//# sourceMappingURL=addPatchTests.d.ts.map

package/dist/testUtil/types/ts3.7/reporters/LogReporter.d.ts

@@ -0,0 +1,57 @@
+import CustomReporter = jasmine.CustomReporter;
+import JasmineDoneInfo = jasmine.JasmineDoneInfo;
+import JasmineStartedInfo = jasmine.JasmineStartedInfo;
+import SpecResult = jasmine.SpecResult;
+import { LogLevel, ReadonlyDate } from '@amazon/vinyl-util';
+export interface LogReporterStartedEvent {
+    readonly totalSpecs: number;
+}
+export interface LogReporterProgressEvent {
+    readonly totalCompleted: number;
+    readonly totalSpecs: number;
+    readonly logs: readonly LogEntry[];
+}
+export interface LogReporterDoneEvent {
+    readonly overallStatus: 'passed' | 'failed';
+    readonly totalCompleted: number;
+    readonly totalSpecs: number;
+    readonly reason: string;
+}
+export interface LogEntry {
+    readonly timestamp: ReadonlyDate;
+    readonly messages: readonly any[];
+    readonly level: LogLevel;
+}
+export declare abstract class LogReporter implements CustomReporter {
+    /**
+     * The first failed spec.
+     *
+     * Jasmine's spec result in `jasmineDone` does not provide these correctly in
+     * failedExpectations, save this from `specDone`.
+     */
+    private failedResult;
+    private totalSpecs;
+    private totalCompleted;
+    /**
+     * The timestamp of the last progress update.
+     */
+    protected lastProgressTimestamp: number;
+    protected updateInterval: number;
+    protected maxLogsBuffer: number;
+    private consoleInterceptor;
+    private readonly logs;
+    protected constructor();
+    jasmineStarted(suiteInfo: JasmineStartedInfo): void;
+    protected abstract onStarted(action: LogReporterStartedEvent): Promise<void>;
+    specDone(result: SpecResult): void;
+    jasmineDone(runDetails: JasmineDoneInfo): void;
+    /**
+     * If there has not been a progress update within `updateInterval`, emit another progress
+     * event.
+     * @private
+     */
+    private maybeReportProgress;
+    protected abstract onProgress(action: LogReporterProgressEvent): Promise<void>;
+    protected abstract onDone(action: LogReporterDoneEvent): Promise<void>;
+}
+//# sourceMappingURL=LogReporter.d.ts.map

package/dist/testUtil/types/ts3.7/reporters/RestApiReporter.d.ts

@@ -0,0 +1,23 @@
+import { LogReporterProgressEvent, LogReporter, LogReporterDoneEvent, LogReporterStartedEvent } from '../reporters/LogReporter';
+export declare class RestApiReporter extends LogReporter {
+    private readonly reportApi;
+    /**
+     * Installs this reporter if this is a Browser environment and the report api has been provided as a query
+     * parameter.
+     * @param searchParam
+     */
+    static installFromSearchParam(searchParam?: string): void;
+    constructor(reportApi: string);
+    protected onStarted(action: LogReporterStartedEvent): Promise<void>;
+    protected onProgress(action: LogReporterProgressEvent): Promise<void>;
+    protected onDone(action: LogReporterDoneEvent): Promise<void>;
+    /**
+     * If the reportApi url was set in the URL parameters, report to that URL the test progress.
+     *
+     * @param action One of: 'started', 'progress', or 'done'
+     * @param body
+     * @private
+     */
+    private doRequest;
+}
+//# sourceMappingURL=RestApiReporter.d.ts.map

package/dist/testUtil/types/ts3.7/util/event/createEventSpy.d.ts

@@ -0,0 +1,31 @@
+import { Disposable, EventHandler, Fun, ReadonlyEventHost } from '@amazon/vinyl-util';
+import Spy = jasmine.Spy;
+/**
+ * A Spy that provides a way to promisify the next call and unsubscribe.
+ *
+ * Do not use `and` on an EventSpy, the callFake is used to provide the next promise.
+ */
+export interface EventSpy<EventMap, K extends keyof EventMap> extends Spy<EventHandler<EventMap[K]>>, Fun, Disposable {
+    /**
+     * Returns a promise that resolves when the event has next been dispatched, or rejects
+     * if timeout has elapsed.
+     *
+     * @param timeout The number of seconds before a timeout.
+     * @param timeoutMessage An optional timeout message to use instead of the default.
+     *  This may use two tokens:
+     *   {0} - The event type.
+     *   {1} - Number of seconds before the timeout.
+     */
+    next(timeout?: number, timeoutMessage?: string): Promise<EventMap[K]>;
+}
+/**
+ * Adds a listener to an event host, returning a spy for assertions.
+ *
+ * The returned spy provides a `next` function to promisify the next call and a `dispose` function
+ * to unsubscribe.
+ *
+ * @param host
+ * @param type
+ */
+export declare function createEventSpy<EventMap, K extends keyof EventMap>(host: ReadonlyEventHost<EventMap>, type: K): EventSpy<EventMap, K>;
+//# sourceMappingURL=createEventSpy.d.ts.map

package/dist/testUtil/types/ts3.7/util/initializeUncaughtErrorLogging.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Logs uncaught errors and promise rejections to the console, to be emitted to the report api.
+ * Jasmine catches uncaught errors and only reports the message in the test failure, not the whole error event.
+ */
+export declare function initializeUncaughtErrorLogging(): void;
+//# sourceMappingURL=initializeUncaughtErrorLogging.d.ts.map

package/dist/testUtil/types/ts4.1/error/uncaughtErrorUtil.d.ts

@@ -0,0 +1,15 @@
+import type { CodeRange } from '@amazon/vinyl-util';
+import type { MockEventTarget } from '@amazon/vinyl-util/browserTestUtil';
+/**
+ * Creates a code range object surrounding the given error.
+ */
+export declare function createRangeSurrounding(error: Error): CodeRange;
+/**
+ * Simulates an uncaught error event.
+ */
+export declare function throwMockError(target: MockEventTarget, error: any): void;
+/**
+ * Simulates an unhandled rejection to be caught by the global unhandled promise handler.
+ */
+export declare function rejectMockPromise(target: MockEventTarget, reason: any): void;
+//# sourceMappingURL=uncaughtErrorUtil.d.ts.map

package/dist/testUtil/types/ts4.1/global/overrideGlobalInit.d.ts

@@ -0,0 +1,5 @@
+import type { GlobalRef } from '@amazon/vinyl-util';
+export declare function overrideGlobalInit<T, U extends T>(initHandle: GlobalRef<T>, initOverride: () => U): {
+    readonly value: U;
+};
+//# sourceMappingURL=overrideGlobalInit.d.ts.map

package/dist/testUtil/types/ts4.1/index.d.ts

@@ -0,0 +1,20 @@
+/** Auto-generated from build scripts */
+export * from './util/initializeUncaughtErrorLogging';
+export * from './util/event/createEventSpy';
+export * from './reporters/RestApiReporter';
+export * from './reporters/LogReporter';
+export * from './patch/addPatchTests';
+export * from './mock/util/spyOnPropertySafe';
+export * from './mock/persistence/MockPersistence';
+export * from './mock/network/emptyRequestInfo';
+export * from './mock/network/MockRequester';
+export * from './mock/network/MockNetworkState';
+export * from './mock/network/MockNetworkMetricsController';
+export * from './mock/network/MockNetworkInformation';
+export * from './mock/navigator/setMockNavigator';
+export * from './mock/logging/MockLogger';
+export * from './mock/event/emptyLogTarget';
+export * from './mock/event/MockEventHost';
+export * from './global/overrideGlobalInit';
+export * from './error/uncaughtErrorUtil';
+//# sourceMappingURL=index.d.ts.map

package/dist/testUtil/types/ts4.1/mock/event/MockEventHost.d.ts

@@ -0,0 +1,15 @@
+import { EventHostImpl } from '@amazon/vinyl-util';
+/**
+ * MockEventHost creates spies with pass-through calls to the EventHost implementation.
+ * While this is not a true mock, events become easier to test when using a real event dispatcher.
+ */
+export declare class MockEventHost<EventMap = any> extends EventHostImpl<EventMap> {
+    private readonly spyFactory;
+    logPrefix: string;
+    hasAnyListeners: import("@amazon/vinyl-util/browserTestUtil").Spy2<(() => boolean) & (() => any)>;
+    hasListeners: import("@amazon/vinyl-util/browserTestUtil").Spy2<((type: keyof EventMap) => boolean) & ((type: keyof EventMap) => any)>;
+    dispatch: import("@amazon/vinyl-util/browserTestUtil").Spy2<(<K extends keyof EventMap>(type: K, event: EventMap[K]) => void)>;
+    on: import("@amazon/vinyl-util/browserTestUtil").Spy2<(<K extends keyof EventMap>(type: K, handler: import("@amazon/vinyl-util").EventHandler<EventMap[K]>, options?: import("@amazon/vinyl-util").SignalOptions) => import("@amazon/vinyl-util").Unsubscribe) & ((type: keyof EventMap, handler: import("@amazon/vinyl-util").EventHandler<EventMap[keyof EventMap]>, options?: import("@amazon/vinyl-util").SignalOptions | undefined) => any)>;
+    dispose: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;
+}
+//# sourceMappingURL=MockEventHost.d.ts.map

package/dist/testUtil/types/ts4.1/mock/event/emptyLogTarget.d.ts

@@ -0,0 +1,3 @@
+import type { LogTarget } from '@amazon/vinyl-util';
+export declare const emptyLogTarget: LogTarget;
+//# sourceMappingURL=emptyLogTarget.d.ts.map

package/dist/testUtil/types/ts4.1/mock/logging/MockLogger.d.ts

@@ -0,0 +1,18 @@
+import type { LogEventMap, Logger, LogTarget } from '@amazon/vinyl-util';
+import { LogLevel } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+type LogFilterFun = (target: LogTarget, ...messages: any[]) => void;
+export declare class MockLogger extends MockEventHost<LogEventMap> implements Logger {
+    logLevel: LogLevel;
+    log: jasmine.Spy<(target: LogTarget, level: LogLevel, ...messages: readonly any[]) => void>;
+    verbose: jasmine.Spy<LogFilterFun>;
+    debug: jasmine.Spy<LogFilterFun>;
+    info: jasmine.Spy<LogFilterFun>;
+    warn: jasmine.Spy<LogFilterFun>;
+    error: jasmine.Spy<LogFilterFun>;
+}
+export declare function useMockLogger(): {
+    readonly value: MockLogger;
+};
+export {};
+//# sourceMappingURL=MockLogger.d.ts.map

package/dist/testUtil/types/ts4.1/mock/navigator/setMockNavigator.d.ts

@@ -0,0 +1,7 @@
+import { MockNavigator } from '@amazon/vinyl-util/browserTestUtil';
+/**
+ * Sets the global navigator to a Mock
+ * Returns the new MockNavigator instance.
+ */
+export declare function setMockNavigator(): MockNavigator;
+//# sourceMappingURL=setMockNavigator.d.ts.map

package/dist/testUtil/types/ts4.1/mock/network/MockNetworkInformation.d.ts

@@ -0,0 +1,10 @@
+import type { NetworkInformation, NetworkInformationEffectiveType, NetworkInformationType } from '@amazon/vinyl-util';
+import { MockEventTarget } from '@amazon/vinyl-util/browserTestUtil';
+export declare class MockNetworkInformation extends MockEventTarget implements NetworkInformation {
+    downlink: number | undefined;
+    effectiveType: NetworkInformationEffectiveType;
+    rtt: number;
+    saveData: boolean;
+    type?: NetworkInformationType;
+}
+//# sourceMappingURL=MockNetworkInformation.d.ts.map

package/dist/testUtil/types/ts4.1/mock/network/MockNetworkMetricsController.d.ts

@@ -0,0 +1,10 @@
+import type { NetworkMetrics, NetworkMetricsController, NetworkMetricsEventMap } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+export declare class MockNetworkMetricsController extends MockEventHost<NetworkMetricsEventMap> implements NetworkMetricsController {
+    maxHistorySize: number;
+    metrics: NetworkMetrics;
+    addMetricsEntry: import("@amazon/vinyl-util/browserTestUtil").Spy2<(entry: import("@amazon/vinyl-util").NetworkMetricsEntry) => void>;
+    getServiceMetrics: import("@amazon/vinyl-util/browserTestUtil").Spy2<((serviceId: import("@amazon/vinyl-util").Maybe<string>) => import("@amazon/vinyl-util").ServiceMetrics) & ((serviceId: import("@amazon/vinyl-util").Maybe<string>) => any)>;
+    addDownlinkTransferEntry: import("@amazon/vinyl-util/browserTestUtil").Spy2<(entry: import("@amazon/vinyl-util").NetworkTransferEntry) => void>;
+}
+//# sourceMappingURL=MockNetworkMetricsController.d.ts.map

package/dist/testUtil/types/ts4.1/mock/network/MockNetworkState.d.ts

@@ -0,0 +1,7 @@
+import type { NetworkState, NetworkStateEventMap } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+export declare class MockNetworkState extends MockEventHost<NetworkStateEventMap> implements NetworkState {
+    onLine: boolean;
+    nextOnLine: import("@amazon/vinyl-util/browserTestUtil").Spy2<((abort?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").ReadonlyAbort>) => Promise<void>) & ((abort?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").ReadonlyAbort>) => any)>;
+}
+//# sourceMappingURL=MockNetworkState.d.ts.map

package/dist/testUtil/types/ts4.1/mock/network/MockRequester.d.ts

@@ -0,0 +1,6 @@
+import type { Requester, RequesterImplEventMap } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+export declare class MockRequester extends MockEventHost<RequesterImplEventMap> implements Requester {
+    request: import("@amazon/vinyl-util/browserTestUtil").Spy2<((input: RequestInfo | Readonly<URL>, init?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").RequestInitOptions>, requestOptions?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").RequestOptions>) => Promise<Response>) & ((input: RequestInfo | Readonly<URL>, init?: import("@amazon/vinyl-util").Maybe<Readonly<Omit<RequestInit, "signal">>>, requestOptions?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").RequestOptions>) => any)>;
+}
+//# sourceMappingURL=MockRequester.d.ts.map

package/dist/testUtil/types/ts4.1/mock/network/emptyRequestInfo.d.ts

@@ -0,0 +1,10 @@
+import type { FetchRequestInfo, RequestAttemptInfo, RequestCaughtErrorEvent, RequestNetworkErrorEvent, RequestResponseErrorEvent, RequestSuccessEvent, ResponseInfo } from '@amazon/vinyl-util';
+export declare const emptyRequestInfo: FetchRequestInfo;
+export declare const emptyRequestAttemptInfo: RequestAttemptInfo;
+export declare const emptyResponseInfo: ResponseInfo;
+export declare const emptyRequestSuccessEvent: RequestSuccessEvent;
+export declare const emptyInternalError: RequestCaughtErrorEvent;
+export declare const emptyNetworkError: RequestNetworkErrorEvent;
+export declare const emptyResponseError: RequestResponseErrorEvent;
+export declare const emptyAbortError: RequestCaughtErrorEvent;
+//# sourceMappingURL=emptyRequestInfo.d.ts.map

package/dist/testUtil/types/ts4.1/mock/persistence/MockPersistence.d.ts

@@ -0,0 +1,9 @@
+import type { KeyValuePersistence } from '@amazon/vinyl-util';
+export declare class MockPersistence<T = any> implements KeyValuePersistence<T> {
+    private readonly spyFactory;
+    clear: import("@amazon/vinyl-util/browserTestUtil").Spy2<(() => Promise<void>) & (() => any)>;
+    get: import("@amazon/vinyl-util/browserTestUtil").Spy2<((key: string) => Promise<T | null>) & ((key: string) => any)>;
+    remove: import("@amazon/vinyl-util/browserTestUtil").Spy2<((key: string) => Promise<void>) & ((key: string) => any)>;
+    set: import("@amazon/vinyl-util/browserTestUtil").Spy2<((key: string, value: T) => Promise<void>) & ((key: string, value: T) => any)>;
+}
+//# sourceMappingURL=MockPersistence.d.ts.map

package/dist/testUtil/types/ts4.1/mock/util/spyOnPropertySafe.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A wrapper to jasmine spyOnProperty for property getters that will define property
+ * if it doesn't exist.
+ */
+export declare function spyOnPropertySafe<T extends object, K extends keyof T = keyof T>(object: T, property: K): jasmine.Spy<(this: T) => T[K]>;
+//# sourceMappingURL=spyOnPropertySafe.d.ts.map

package/dist/testUtil/types/ts4.1/patch/addPatchTests.d.ts

@@ -0,0 +1,35 @@
+import type { PatchedRef } from '@amazon/vinyl-util';
+export interface PatchTestOptions<T> {
+    /**
+     * True if the patch is enabled by default.
+     */
+    actualFlag: boolean | undefined;
+    /**
+     * The target, not patched.
+     */
+    target: T;
+    /**
+     * The patched target.
+     */
+    patchedRef: PatchedRef<T>;
+    /**
+     * Runs the scenario to reproduce the issue on the target.
+     * @param target
+     */
+    canReproduce: (target: T) => Promise<boolean>;
+    /**
+     * If true and the tested flag is true but the issue cannot be reproduced, then only a
+     * warning is logged, if false, then the test will be marked as a failure.
+     */
+    allowFalseNegative: boolean;
+}
+/**
+ * Adds tests to ensure that a patch flag is enabled when the issue can be reproduced for the UA,
+ * and when the patch is applied the issue is no longer reproducible.
+ *
+ * @param flagName The flag name, used in test descriptions.
+ * @param description The condition which requires the patch to be enabled.
+ * @param optionsProvider
+ */
+export declare function addPatchTests<T>(flagName: string, description: string, optionsProvider: () => PatchTestOptions<T>): void;
+//# sourceMappingURL=addPatchTests.d.ts.map

package/dist/testUtil/types/ts4.1/reporters/LogReporter.d.ts

@@ -0,0 +1,58 @@
+import CustomReporter = jasmine.CustomReporter;
+import JasmineDoneInfo = jasmine.JasmineDoneInfo;
+import JasmineStartedInfo = jasmine.JasmineStartedInfo;
+import SpecResult = jasmine.SpecResult;
+import type { ReadonlyDate } from '@amazon/vinyl-util';
+import { LogLevel } from '@amazon/vinyl-util';
+export interface LogReporterStartedEvent {
+    readonly totalSpecs: number;
+}
+export interface LogReporterProgressEvent {
+    readonly totalCompleted: number;
+    readonly totalSpecs: number;
+    readonly logs: readonly LogEntry[];
+}
+export interface LogReporterDoneEvent {
+    readonly overallStatus: 'passed' | 'failed';
+    readonly totalCompleted: number;
+    readonly totalSpecs: number;
+    readonly reason: string;
+}
+export interface LogEntry {
+    readonly timestamp: ReadonlyDate;
+    readonly messages: readonly any[];
+    readonly level: LogLevel;
+}
+export declare abstract class LogReporter implements CustomReporter {
+    /**
+     * The first failed spec.
+     *
+     * Jasmine's spec result in `jasmineDone` does not provide these correctly in
+     * failedExpectations, save this from `specDone`.
+     */
+    private failedResult;
+    private totalSpecs;
+    private totalCompleted;
+    /**
+     * The timestamp of the last progress update.
+     */
+    protected lastProgressTimestamp: number;
+    protected updateInterval: number;
+    protected maxLogsBuffer: number;
+    private consoleInterceptor;
+    private readonly logs;
+    protected constructor();
+    jasmineStarted(suiteInfo: JasmineStartedInfo): void;
+    protected abstract onStarted(action: LogReporterStartedEvent): Promise<void>;
+    specDone(result: SpecResult): void;
+    jasmineDone(runDetails: JasmineDoneInfo): void;
+    /**
+     * If there has not been a progress update within `updateInterval`, emit another progress
+     * event.
+     * @private
+     */
+    private maybeReportProgress;
+    protected abstract onProgress(action: LogReporterProgressEvent): Promise<void>;
+    protected abstract onDone(action: LogReporterDoneEvent): Promise<void>;
+}
+//# sourceMappingURL=LogReporter.d.ts.map