@dugararchit/cdk 0.0.0-dugararchit

package/types/stagefright5-cdk-testing-protractor.d.ts

@@ -0,0 +1,146 @@
+import { TestElement, ModifierKeys, TestKey, TextOptions, ElementDimensions, EventData, HarnessEnvironment, HarnessLoader } from '@dugararchit/cdk/testing';
+import { ElementFinder, ElementArrayFinder } from 'protractor';
+
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+/**
+ * A `TestElement` implementation for Protractor.
+ * @deprecated
+ * @breaking-change 13.0.0
+ */
+declare class ProtractorElement implements TestElement {
+    readonly element: ElementFinder;
+    constructor(element: ElementFinder);
+    /** Blur the element. */
+    blur(): Promise<void>;
+    /** Clear the element's input (for input and textarea elements only). */
+    clear(): Promise<void>;
+    /**
+     * Click the element at the default location for the current environment. If you need to guarantee
+     * the element is clicked at a specific location, consider using `click('center')` or
+     * `click(x, y)` instead.
+     */
+    click(modifiers?: ModifierKeys): Promise<void>;
+    /** Click the element at the element's center. */
+    click(location: 'center', modifiers?: ModifierKeys): Promise<void>;
+    /**
+     * Click the element at the specified coordinates relative to the top-left of the element.
+     * @param relativeX Coordinate within the element, along the X-axis at which to click.
+     * @param relativeY Coordinate within the element, along the Y-axis at which to click.
+     * @param modifiers Modifier keys held while clicking
+     */
+    click(relativeX: number, relativeY: number, modifiers?: ModifierKeys): Promise<void>;
+    /**
+     * Right clicks on the element at the specified coordinates relative to the top-left of it.
+     * @param relativeX Coordinate within the element, along the X-axis at which to click.
+     * @param relativeY Coordinate within the element, along the Y-axis at which to click.
+     * @param modifiers Modifier keys held while clicking
+     */
+    rightClick(relativeX: number, relativeY: number, modifiers?: ModifierKeys): Promise<void>;
+    /** Focus the element. */
+    focus(): Promise<void>;
+    /** Get the computed value of the given CSS property for the element. */
+    getCssValue(property: string): Promise<string>;
+    /** Hovers the mouse over the element. */
+    hover(): Promise<void>;
+    /** Moves the mouse away from the element. */
+    mouseAway(): Promise<void>;
+    /**
+     * Sends the given string to the input as a series of key presses. Also fires input events
+     * and attempts to add the string to the Element's value.
+     */
+    sendKeys(...keys: (string | TestKey)[]): Promise<void>;
+    /**
+     * Sends the given string to the input as a series of key presses. Also fires input events
+     * and attempts to add the string to the Element's value.
+     */
+    sendKeys(modifiers: ModifierKeys, ...keys: (string | TestKey)[]): Promise<void>;
+    /**
+     * Gets the text from the element.
+     * @param options Options that affect what text is included.
+     */
+    text(options?: TextOptions): Promise<string>;
+    /** Gets the value for the given attribute from the element. */
+    getAttribute(name: string): Promise<string | null>;
+    /** Checks whether the element has the given class. */
+    hasClass(name: string): Promise<boolean>;
+    /** Gets the dimensions of the element. */
+    getDimensions(): Promise<ElementDimensions>;
+    /** Gets the value of a property of an element. */
+    getProperty<T = any>(name: string): Promise<T>;
+    /** Sets the value of a property of an input. */
+    setInputValue(value: string): Promise<void>;
+    /** Selects the options at the specified indexes inside of a native `select` element. */
+    selectOptions(...optionIndexes: number[]): Promise<void>;
+    /** Checks whether this element matches the given selector. */
+    matchesSelector(selector: string): Promise<boolean>;
+    /** Checks whether the element is focused. */
+    isFocused(): Promise<boolean>;
+    /**
+     * Dispatches an event with a particular name.
+     * @param name Name of the event to be dispatched.
+     */
+    dispatchEvent(name: string, data?: Record<string, EventData>): Promise<void>;
+    /** Dispatches all the events that are part of a click event sequence. */
+    private _dispatchClickEventSequence;
+}
+
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+/**
+ * Options to configure the environment.
+ * @deprecated
+ * @breaking-change 13.0.0
+ */
+interface ProtractorHarnessEnvironmentOptions {
+    /** The query function used to find DOM elements. */
+    queryFn: (selector: string, root: ElementFinder) => ElementArrayFinder;
+}
+/**
+ * A `HarnessEnvironment` implementation for Protractor.
+ * @deprecated As of v13.0.0, this environment no longer works, as it is not
+ * compatible with the new [Angular Package Format](https://angular.io/guide/angular-package-format).
+ * @breaking-change 13.0.0
+ */
+declare class ProtractorHarnessEnvironment extends HarnessEnvironment<ElementFinder> {
+    /** The options for this environment. */
+    private _options;
+    protected constructor(rawRootElement: ElementFinder, options?: ProtractorHarnessEnvironmentOptions);
+    /** Creates a `HarnessLoader` rooted at the document root. */
+    static loader(options?: ProtractorHarnessEnvironmentOptions): HarnessLoader;
+    /** Gets the ElementFinder corresponding to the given TestElement. */
+    static getNativeElement(el: TestElement): ElementFinder;
+    /**
+     * Flushes change detection and async tasks captured in the Angular zone.
+     * In most cases it should not be necessary to call this manually. However, there may be some edge
+     * cases where it is needed to fully flush animation events.
+     */
+    forceStabilize(): Promise<void>;
+    /** @docs-private */
+    waitForTasksOutsideAngular(): Promise<void>;
+    /** Gets the root element for the document. */
+    protected getDocumentRoot(): ElementFinder;
+    /** Creates a `TestElement` from a raw element. */
+    protected createTestElement(element: ElementFinder): TestElement;
+    /** Creates a `HarnessLoader` rooted at the given raw element. */
+    protected createEnvironment(element: ElementFinder): HarnessEnvironment<ElementFinder>;
+    /**
+     * Gets a list of all elements matching the given selector under this environment's root element.
+     */
+    protected getAllRawElements(selector: string): Promise<ElementFinder[]>;
+}
+
+export { ProtractorElement, ProtractorHarnessEnvironment };
+export type { ProtractorHarnessEnvironmentOptions };

package/types/stagefright5-cdk-testing-selenium-webdriver.d.ts

@@ -0,0 +1,161 @@
+import { TestElement, ModifierKeys, TestKey, TextOptions, ElementDimensions, EventData, HarnessEnvironment, HarnessLoader } from '@dugararchit/cdk/testing';
+import * as webdriver from 'selenium-webdriver';
+
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+/** A `TestElement` implementation for WebDriver. */
+declare class SeleniumWebDriverElement implements TestElement {
+    readonly element: () => webdriver.WebElement;
+    private _stabilize;
+    constructor(element: () => webdriver.WebElement, _stabilize: () => Promise<void>);
+    /** Blur the element. */
+    blur(): Promise<void>;
+    /** Clear the element's input (for input and textarea elements only). */
+    clear(): Promise<void>;
+    /**
+     * Click the element at the default location for the current environment. If you need to guarantee
+     * the element is clicked at a specific location, consider using `click('center')` or
+     * `click(x, y)` instead.
+     */
+    click(modifiers?: ModifierKeys): Promise<void>;
+    /** Click the element at the element's center. */
+    click(location: 'center', modifiers?: ModifierKeys): Promise<void>;
+    /**
+     * Click the element at the specified coordinates relative to the top-left of the element.
+     * @param relativeX Coordinate within the element, along the X-axis at which to click.
+     * @param relativeY Coordinate within the element, along the Y-axis at which to click.
+     * @param modifiers Modifier keys held while clicking
+     */
+    click(relativeX: number, relativeY: number, modifiers?: ModifierKeys): Promise<void>;
+    /**
+     * Right clicks on the element at the specified coordinates relative to the top-left of it.
+     * @param relativeX Coordinate within the element, along the X-axis at which to click.
+     * @param relativeY Coordinate within the element, along the Y-axis at which to click.
+     * @param modifiers Modifier keys held while clicking
+     */
+    rightClick(relativeX: number, relativeY: number, modifiers?: ModifierKeys): Promise<void>;
+    /** Focus the element. */
+    focus(): Promise<void>;
+    /** Get the computed value of the given CSS property for the element. */
+    getCssValue(property: string): Promise<string>;
+    /** Hovers the mouse over the element. */
+    hover(): Promise<void>;
+    /** Moves the mouse away from the element. */
+    mouseAway(): Promise<void>;
+    /**
+     * Sends the given string to the input as a series of key presses. Also fires input events
+     * and attempts to add the string to the Element's value.
+     */
+    sendKeys(...keys: (string | TestKey)[]): Promise<void>;
+    /**
+     * Sends the given string to the input as a series of key presses. Also fires input events
+     * and attempts to add the string to the Element's value.
+     */
+    sendKeys(modifiers: ModifierKeys, ...keys: (string | TestKey)[]): Promise<void>;
+    /**
+     * Gets the text from the element.
+     * @param options Options that affect what text is included.
+     */
+    text(options?: TextOptions): Promise<string>;
+    /** Gets the value for the given attribute from the element. */
+    getAttribute(name: string): Promise<string | null>;
+    /** Checks whether the element has the given class. */
+    hasClass(name: string): Promise<boolean>;
+    /** Gets the dimensions of the element. */
+    getDimensions(): Promise<ElementDimensions>;
+    /** Gets the value of a property of an element. */
+    getProperty<T = any>(name: string): Promise<T>;
+    /** Sets the value of a property of an input. */
+    setInputValue(newValue: string): Promise<void>;
+    /** Selects the options at the specified indexes inside of a native `select` element. */
+    selectOptions(...optionIndexes: number[]): Promise<void>;
+    /** Checks whether this element matches the given selector. */
+    matchesSelector(selector: string): Promise<boolean>;
+    /** Checks whether the element is focused. */
+    isFocused(): Promise<boolean>;
+    /**
+     * Dispatches an event with a particular name.
+     * @param name Name of the event to be dispatched.
+     */
+    dispatchEvent(name: string, data?: Record<string, EventData>): Promise<void>;
+    /** Gets the webdriver action sequence. */
+    private _actions;
+    /** Executes a function in the browser. */
+    private _executeScript;
+    /** Dispatches all the events that are part of a click event sequence. */
+    private _dispatchClickEventSequence;
+}
+
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+/**
+ * An Angular framework stabilizer function that takes a callback and calls it when the application
+ * is stable, passing a boolean indicating if any work was done.
+ */
+declare interface FrameworkStabilizer {
+    (callback: (didWork: boolean) => void): void;
+}
+declare global {
+    interface Window {
+        /**
+         * These hooks are exposed by Angular to register a callback for when the application is stable
+         * (no more pending tasks).
+         *
+         * For the implementation, see: https://github.com/
+         *  angular/angular/blob/main/packages/platform-browser/src/browser/testability.ts#L30-L49
+         */
+        frameworkStabilizers: FrameworkStabilizer[];
+    }
+}
+/** Options to configure the environment. */
+interface WebDriverHarnessEnvironmentOptions {
+    /** The query function used to find DOM elements. */
+    queryFn: (selector: string, root: () => webdriver.WebElement) => Promise<webdriver.WebElement[]>;
+}
+/** Waits for angular to be ready after the page load. */
+declare function waitForAngularReady(wd: webdriver.WebDriver): Promise<void>;
+/** A `HarnessEnvironment` implementation for WebDriver. */
+declare class SeleniumWebDriverHarnessEnvironment extends HarnessEnvironment<() => webdriver.WebElement> {
+    /** The options for this environment. */
+    private _options;
+    /** Environment stabilization callback passed to the created test elements. */
+    private _stabilizeCallback;
+    protected constructor(rawRootElement: () => webdriver.WebElement, options?: WebDriverHarnessEnvironmentOptions);
+    /** Gets the ElementFinder corresponding to the given TestElement. */
+    static getNativeElement(el: TestElement): webdriver.WebElement;
+    /** Creates a `HarnessLoader` rooted at the document root. */
+    static loader(driver: webdriver.WebDriver, options?: WebDriverHarnessEnvironmentOptions): HarnessLoader;
+    /**
+     * Flushes change detection and async tasks captured in the Angular zone.
+     * In most cases it should not be necessary to call this manually. However, there may be some edge
+     * cases where it is needed to fully flush animation events.
+     */
+    forceStabilize(): Promise<void>;
+    /** @docs-private */
+    waitForTasksOutsideAngular(): Promise<void>;
+    /** Gets the root element for the document. */
+    protected getDocumentRoot(): () => webdriver.WebElement;
+    /** Creates a `TestElement` from a raw element. */
+    protected createTestElement(element: () => webdriver.WebElement): TestElement;
+    /** Creates a `HarnessLoader` rooted at the given raw element. */
+    protected createEnvironment(element: () => webdriver.WebElement): HarnessEnvironment<() => webdriver.WebElement>;
+    /**
+     * Gets a list of all elements matching the given selector under this environment's root element.
+     */
+    protected getAllRawElements(selector: string): Promise<(() => webdriver.WebElement)[]>;
+}
+
+export { SeleniumWebDriverElement, SeleniumWebDriverHarnessEnvironment, waitForAngularReady };
+export type { WebDriverHarnessEnvironmentOptions };

package/types/stagefright5-cdk-testing-testbed.d.ts

@@ -0,0 +1,168 @@
+import { HarnessEnvironment, HarnessLoader, TestElement, ComponentHarness, ComponentHarnessConstructor, ModifierKeys, TestKey, TextOptions, ElementDimensions, EventData } from '@dugararchit/cdk/testing';
+import { ComponentFixture } from '@angular/core/testing';
+
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+/** Options to configure the environment. */
+interface TestbedHarnessEnvironmentOptions {
+    /** The query function used to find DOM elements. */
+    queryFn: (selector: string, root: Element) => Iterable<Element> | ArrayLike<Element>;
+}
+/** A `HarnessEnvironment` implementation for Angular's Testbed. */
+declare class TestbedHarnessEnvironment extends HarnessEnvironment<Element> {
+    private _fixture;
+    /** Whether the environment has been destroyed. */
+    private _destroyed;
+    /** Observable that emits whenever the test task state changes. */
+    private _taskState;
+    /** The options for this environment. */
+    private _options;
+    /** Environment stabilization callback passed to the created test elements. */
+    private _stabilizeCallback;
+    protected constructor(rawRootElement: Element, _fixture: ComponentFixture<unknown>, options?: TestbedHarnessEnvironmentOptions);
+    /** Creates a `HarnessLoader` rooted at the given fixture's root element. */
+    static loader(fixture: ComponentFixture<unknown>, options?: TestbedHarnessEnvironmentOptions): HarnessLoader;
+    /**
+     * Creates a `HarnessLoader` at the document root. This can be used if harnesses are
+     * located outside of a fixture (e.g. overlays appended to the document body).
+     */
+    static documentRootLoader(fixture: ComponentFixture<unknown>, options?: TestbedHarnessEnvironmentOptions): HarnessLoader;
+    /** Gets the native DOM element corresponding to the given TestElement. */
+    static getNativeElement(el: TestElement): Element;
+    /**
+     * Creates an instance of the given harness type, using the fixture's root element as the
+     * harness's host element. This method should be used when creating a harness for the root element
+     * of a fixture, as components do not have the correct selector when they are created as the root
+     * of the fixture.
+     */
+    static harnessForFixture<T extends ComponentHarness>(fixture: ComponentFixture<unknown>, harnessType: ComponentHarnessConstructor<T>, options?: TestbedHarnessEnvironmentOptions): Promise<T>;
+    /**
+     * Flushes change detection and async tasks captured in the Angular zone.
+     * In most cases it should not be necessary to call this manually. However, there may be some edge
+     * cases where it is needed to fully flush animation events.
+     */
+    forceStabilize(): Promise<void>;
+    /**
+     * Waits for all scheduled or running async tasks to complete. This allows harness
+     * authors to wait for async tasks outside of the Angular zone.
+     */
+    waitForTasksOutsideAngular(): Promise<void>;
+    /** Gets the root element for the document. */
+    protected getDocumentRoot(): Element;
+    /** Creates a `TestElement` from a raw element. */
+    protected createTestElement(element: Element): TestElement;
+    /** Creates a `HarnessLoader` rooted at the given raw element. */
+    protected createEnvironment(element: Element): HarnessEnvironment<Element>;
+    /**
+     * Gets a list of all elements matching the given selector under this environment's root element.
+     */
+    protected getAllRawElements(selector: string): Promise<Element[]>;
+}
+
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+/** A `TestElement` implementation for unit tests. */
+declare class UnitTestElement implements TestElement {
+    readonly element: Element;
+    private _stabilize;
+    constructor(element: Element, _stabilize: () => Promise<void>);
+    /** Blur the element. */
+    blur(): Promise<void>;
+    /** Clear the element's input (for input and textarea elements only). */
+    clear(): Promise<void>;
+    /**
+     * Click the element at the default location for the current environment. If you need to guarantee
+     * the element is clicked at a specific location, consider using `click('center')` or
+     * `click(x, y)` instead.
+     */
+    click(modifiers?: ModifierKeys): Promise<void>;
+    /** Click the element at the element's center. */
+    click(location: 'center', modifiers?: ModifierKeys): Promise<void>;
+    /**
+     * Click the element at the specified coordinates relative to the top-left of the element.
+     * @param relativeX Coordinate within the element, along the X-axis at which to click.
+     * @param relativeY Coordinate within the element, along the Y-axis at which to click.
+     * @param modifiers Modifier keys held while clicking
+     */
+    click(relativeX: number, relativeY: number, modifiers?: ModifierKeys): Promise<void>;
+    /**
+     * Right clicks on the element at the specified coordinates relative to the top-left of it.
+     * @param relativeX Coordinate within the element, along the X-axis at which to click.
+     * @param relativeY Coordinate within the element, along the Y-axis at which to click.
+     * @param modifiers Modifier keys held while clicking
+     */
+    rightClick(relativeX: number, relativeY: number, modifiers?: ModifierKeys): Promise<void>;
+    /** Focus the element. */
+    focus(): Promise<void>;
+    /** Get the computed value of the given CSS property for the element. */
+    getCssValue(property: string): Promise<string>;
+    /** Hovers the mouse over the element. */
+    hover(): Promise<void>;
+    /** Moves the mouse away from the element. */
+    mouseAway(): Promise<void>;
+    /**
+     * Sends the given string to the input as a series of key presses. Also fires input events
+     * and attempts to add the string to the Element's value. Note that this cannot
+     * reproduce native browser behavior for keyboard shortcuts such as Tab, Ctrl + A, etc.
+     */
+    sendKeys(...keys: (string | TestKey)[]): Promise<void>;
+    /**
+     * Sends the given string to the input as a series of key presses. Also fires input events
+     * and attempts to add the string to the Element's value.
+     */
+    sendKeys(modifiers: ModifierKeys, ...keys: (string | TestKey)[]): Promise<void>;
+    /**
+     * Gets the text from the element.
+     * @param options Options that affect what text is included.
+     */
+    text(options?: TextOptions): Promise<string>;
+    /** Gets the value for the given attribute from the element. */
+    getAttribute(name: string): Promise<string | null>;
+    /** Checks whether the element has the given class. */
+    hasClass(name: string): Promise<boolean>;
+    /** Gets the dimensions of the element. */
+    getDimensions(): Promise<ElementDimensions>;
+    /** Gets the value of a property of an element. */
+    getProperty<T = any>(name: string): Promise<T>;
+    /** Sets the value of a property of an input. */
+    setInputValue(value: string): Promise<void>;
+    /** Selects the options at the specified indexes inside of a native `select` element. */
+    selectOptions(...optionIndexes: number[]): Promise<void>;
+    /** Checks whether this element matches the given selector. */
+    matchesSelector(selector: string): Promise<boolean>;
+    /** Checks whether the element is focused. */
+    isFocused(): Promise<boolean>;
+    /**
+     * Dispatches an event with a particular name.
+     * @param name Name of the event to be dispatched.
+     */
+    dispatchEvent(name: string, data?: Record<string, EventData>): Promise<void>;
+    /**
+     * Dispatches a pointer event on the current element if the browser supports it.
+     * @param name Name of the pointer event to be dispatched.
+     * @param clientX Coordinate of the user's pointer along the X axis.
+     * @param clientY Coordinate of the user's pointer along the Y axis.
+     * @param button Mouse button that should be pressed when dispatching the event.
+     */
+    private _dispatchPointerEventIfSupported;
+    /**
+     * Dispatches all the events that are part of a mouse event sequence
+     * and then emits a given primary event at the end, if speciifed.
+     */
+    private _dispatchMouseEventSequence;
+}
+
+export { TestbedHarnessEnvironment, UnitTestElement };
+export type { TestbedHarnessEnvironmentOptions };