@genesislcap/foundation-testing 14.408.0 → 14.409.0

package/docs/api/foundation-testing.fixtureoptions.parent.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [FixtureOptions](./foundation-testing.fixtureoptions.md) &gt; [parent](./foundation-testing.fixtureoptions.parent.md)
-
-## FixtureOptions.parent property
-
-The parent element to append the fixture to.
-
-**Signature:**
-
-```typescript
-parent?: HTMLElement;
-```

package/docs/api/foundation-testing.fixtureoptions.source.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [FixtureOptions](./foundation-testing.fixtureoptions.md) &gt; [source](./foundation-testing.fixtureoptions.source.md)
-
-## FixtureOptions.source property
-
-The data source to bind the HTML to.
-
-**Signature:**
-
-```typescript
-source?: any;
-```

package/docs/api/foundation-testing.logger.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [logger](./foundation-testing.logger.md)
-
-## logger variable
-
-Test logger
-
-**Signature:**
-
-```typescript
-logger: import("@genesislcap/foundation-logger").Logger
-```
-
-## Remarks
-
-Exported so you can set log levels differently across packages when needed.
-

package/docs/api/foundation-testing.logiccontext.md

@@ -1,40 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [LogicContext](./foundation-testing.logiccontext.md)
-
-## LogicContext interface
-
-Logic suite context interface
-
-**Signature:**
-
-```typescript
-export interface LogicContext 
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[runCases(fn, cases)?](./foundation-testing.logiccontext.runcases.md)
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-testing.logiccontext.runcases.md

@@ -1,64 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [LogicContext](./foundation-testing.logiccontext.md) &gt; [runCases](./foundation-testing.logiccontext.runcases.md)
-
-## LogicContext.runCases() method
-
-**Signature:**
-
-```typescript
-runCases?(fn: (value: any) => any, cases: [any, any, assert.Message?][]): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-fn
-
-
-</td><td>
-
-(value: any) =&gt; any
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-cases
-
-
-</td><td>
-
-\[any, any, assert.Message?\]\[\]
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-testing.md

@@ -1,317 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md)
-
-## foundation-testing package
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[createComponentSuite(title, elementNameOrGetter, context, registrations)](./foundation-testing.createcomponentsuite.md)
-
-
-</td><td>
-
-Create component test suite.
-
-
-</td></tr>
-<tr><td>
-
-[createLogicSuite(title, context)](./foundation-testing.createlogicsuite.md)
-
-
-</td><td>
-
-Create logic test suite.
-
-
-</td></tr>
-<tr><td>
-
-[delayedResolve(result, duration)](./foundation-testing.delayedresolve.md)
-
-
-</td><td>
-
-Delayed resolve utility.
-
-
-</td></tr>
-<tr><td>
-
-[fixture(templateNameOrRegistry, options)](./foundation-testing.fixture.md)
-
-
-</td><td>
-
-Creates a test fixture suitable for testing custom elements, templates, and bindings.
-
-
-</td></tr>
-<tr><td>
-
-[resetTestHarness(wrapper)](./foundation-testing.resettestharness.md)
-
-
-</td><td>
-
-Resets the history of the spied functions on the objects so previous running tests don't affect the current test. Must be called at the end of every test even if not asserting on the spies.
-
-
-</td></tr>
-<tr><td>
-
-[restoreTestHarness(wrapper)](./foundation-testing.restoretestharness.md)
-
-
-</td><td>
-
-Restores the spied functions back to the original functions without the spies.
-
-
-</td></tr>
-<tr><td>
-
-[runCases(fn, cases, assertion)](./foundation-testing.runcases.md)
-
-
-</td><td>
-
-Assert a set of test cases.
-
-
-</td></tr>
-<tr><td>
-
-[testSpy(constructor)](./foundation-testing.testspy.md)
-
-
-</td><td>
-
-Decorator: Used on a test harness class based on a `FoundationElement` to give it extra functionality which can be used during testing. \*Important\* this is to be used on a parent element compared to the element under test.
-
-
-</td></tr>
-<tr><td>
-
-[timeout(callback, duration)](./foundation-testing.timeout.md)
-
-
-</td><td>
-
-Timeout utility.
-
-
-</td></tr>
-</tbody></table>
-
-## Interfaces
-
-<table><thead><tr><th>
-
-Interface
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ComponentContext](./foundation-testing.componentcontext.md)
-
-
-</td><td>
-
-Component suite context interface
-
-
-</td></tr>
-<tr><td>
-
-[Fixture](./foundation-testing.fixture.md)
-
-
-</td><td>
-
-Unit test fixture.
-
-
-</td></tr>
-<tr><td>
-
-[FixtureOptions](./foundation-testing.fixtureoptions.md)
-
-
-</td><td>
-
-Options used to customize the creation of the unit test fixture.
-
-
-</td></tr>
-<tr><td>
-
-[LogicContext](./foundation-testing.logiccontext.md)
-
-
-</td><td>
-
-Logic suite context interface
-
-
-</td></tr>
-</tbody></table>
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[logger](./foundation-testing.logger.md)
-
-
-</td><td>
-
-Test logger
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ElementGetter](./foundation-testing.elementgetter.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[Equal](./foundation-testing.equal.md)
-
-
-</td><td>
-
-Expects that the type parameter X is equal to Y, returning true or false
-
-
-</td></tr>
-<tr><td>
-
-[Expect](./foundation-testing.expect.md)
-
-
-</td><td>
-
-Expects that the type parameter T resolves to true, or will be a typescript error
-
-
-</td></tr>
-<tr><td>
-
-[FilterConditionally](./foundation-testing.filterconditionally.md)
-
-
-</td><td>
-
-Filters out key/value pairs from an object where they value does not match a condition
-
-
-</td></tr>
-<tr><td>
-
-[RunCases](./foundation-testing.runcases.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[SinonWrapper](./foundation-testing.sinonwrapper.md)
-
-
-</td><td>
-
-Crates an object with a key value pair for each spied function where the key is the function name and the value is the sinon wrapped spy function
-
-
-</td></tr>
-<tr><td>
-
-[SpiedFunctions](./foundation-testing.spiedfunctions.md)
-
-
-</td><td>
-
-Filters out all key/value pairs which are not functions, and omits the constructor
-
-
-</td></tr>
-<tr><td>
-
-[SuiteCallback](./foundation-testing.suitecallback.md)
-
-
-</td><td>
-
-Defines the Generic type for a test Suite `T` the callback function required to assert on type `T`<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[WithTestHarness](./foundation-testing.withtestharness.md)
-
-
-</td><td>
-
-Type can be used to inform Typescript the object decorated with [testSpy()](./foundation-testing.testspy.md) has function spies which can be interacted upon their normal function reference
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-testing.resettestharness.md

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [resetTestHarness](./foundation-testing.resettestharness.md)
-
-## resetTestHarness() function
-
-Resets the history of the spied functions on the objects so previous running tests don't affect the current test. Must be called at the end of every test even if not asserting on the spies.
-
-**Signature:**
-
-```typescript
-export declare function resetTestHarness<T>(wrapper: WithTestHarness<T>): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-wrapper
-
-
-</td><td>
-
-[WithTestHarness](./foundation-testing.withtestharness.md)<!-- -->&lt;T&gt;
-
-
-</td><td>
-
-`WithTestHarness<T>` object to reset
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-testing.restoretestharness.md

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [restoreTestHarness](./foundation-testing.restoretestharness.md)
-
-## restoreTestHarness() function
-
-Restores the spied functions back to the original functions without the spies.
-
-**Signature:**
-
-```typescript
-export declare function restoreTestHarness<T>(wrapper: WithTestHarness<T>): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-wrapper
-
-
-</td><td>
-
-[WithTestHarness](./foundation-testing.withtestharness.md)<!-- -->&lt;T&gt;
-
-
-</td><td>
-
-`WithTestHarness<T>` object to restore
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-testing.runcases.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [RunCases](./foundation-testing.runcases.md)
-
-## RunCases type
-
-
-**Signature:**
-
-```typescript
-export type RunCases = (fn: (...args: unknown[]) => unknown, cases: [unknown[], unknown, string?][], assertion?: (...args: unknown[]) => void) => void;
-```

package/docs/api/foundation-testing.sinonwrapper.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [SinonWrapper](./foundation-testing.sinonwrapper.md)
-
-## SinonWrapper type
-
-Crates an object with a key value pair for each spied function where the key is the function name and the value is the sinon wrapped spy function
-
-**Signature:**
-
-```typescript
-export type SinonWrapper<T extends {
-    [K in keyof T]: (...args: any) => any;
-}> = {
-    [K in keyof T]: sinon.SinonSpy<Parameters<T[K]>, ReturnType<T[K]>>;
-};
-```

package/docs/api/foundation-testing.spiedfunctions.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [SpiedFunctions](./foundation-testing.spiedfunctions.md)
-
-## SpiedFunctions type
-
-Filters out all key/value pairs which are not functions, and omits the constructor
-
-**Signature:**
-
-```typescript
-export type SpiedFunctions<T> = Omit<FilterConditionally<T, (...args: any[]) => any>, 'constructor'>;
-```
-**References:** [FilterConditionally](./foundation-testing.filterconditionally.md)
-

package/docs/api/foundation-testing.suitecallback.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [SuiteCallback](./foundation-testing.suitecallback.md)
-
-## SuiteCallback type
-
-Defines the Generic type for a test Suite `T` the callback function required to assert on type `T`<!-- -->.
-
-**Signature:**
-
-```typescript
-export type SuiteCallback<T> = uvu.Callback<ComponentContext<T>>;
-```
-**References:** [ComponentContext](./foundation-testing.componentcontext.md)
-

package/docs/api/foundation-testing.testspy.md

@@ -1,66 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-testing](./foundation-testing.md) &gt; [testSpy](./foundation-testing.testspy.md)
-
-## testSpy() function
-
-Decorator: Used on a test harness class based on a `FoundationElement` to give it extra functionality which can be used during testing. \*Important\* this is to be used on a parent element compared to the element under test.
-
-**Signature:**
-
-```typescript
-export declare function testSpy(constructor: Function): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-constructor
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Remarks
-
-Access the test functionality using the type with [WithTestHarness](./foundation-testing.withtestharness.md)
-
-Reset after each test with [resetTestHarness()](./foundation-testing.resettestharness.md)
-
-## Example
-
-// Testing the first function call async (<!-- -->{ element }<!-- -->) =<!-- -->&gt; {
-
-assert.ok( element.layout.addItemFromChild.calledWith(<!-- -->{ type: 'component', componentType: 'test', title: `Item test`<!-- -->, reorderEnabled: true, isClosable: false, size: undefined, }<!-- -->) );
-
-// Reset the tester at the end of every test even if you don't assert on any of it! resetTestHarness(element.layout); }
-