@rindo/core 3.0.0 → 3.1.0

package/testing/matchers/events.d.ts

@@ -1,21 +1,21 @@
-import type * as d from '@rindo/core/internal';
-export declare function toHaveReceivedEvent(eventSpy: d.EventSpy): {
-    message: () => string;
-    pass: boolean;
-};
-export declare function toHaveReceivedEventTimes(eventSpy: d.EventSpy, count: number): {
-    message: () => string;
-    pass: boolean;
-};
-export declare function toHaveReceivedEventDetail(eventSpy: d.EventSpy, eventDetail: any): {
-    message: () => string;
-    pass: boolean;
-};
-export declare function toHaveFirstReceivedEventDetail(eventSpy: d.EventSpy, eventDetail: any): {
-    message: () => string;
-    pass: boolean;
-};
-export declare function toHaveNthReceivedEventDetail(eventSpy: d.EventSpy, index: number, eventDetail: any): {
-    message: () => string;
-    pass: boolean;
-};
+import type * as d from '@rindo/core/internal';
+export declare function toHaveReceivedEvent(eventSpy: d.EventSpy): {
+    message: () => string;
+    pass: boolean;
+};
+export declare function toHaveReceivedEventTimes(eventSpy: d.EventSpy, count: number): {
+    message: () => string;
+    pass: boolean;
+};
+export declare function toHaveReceivedEventDetail(eventSpy: d.EventSpy, eventDetail: any): {
+    message: () => string;
+    pass: boolean;
+};
+export declare function toHaveFirstReceivedEventDetail(eventSpy: d.EventSpy, eventDetail: any): {
+    message: () => string;
+    pass: boolean;
+};
+export declare function toHaveNthReceivedEventDetail(eventSpy: d.EventSpy, index: number, eventDetail: any): {
+    message: () => string;
+    pass: boolean;
+};

package/testing/matchers/html.d.ts

@@ -1,12 +1,12 @@
-export declare function toEqualHtml(input: string | HTMLElement | ShadowRoot, shouldEqual: string): {
-    message: () => string;
-    pass: boolean;
-};
-export declare function toEqualLightHtml(input: string | HTMLElement | ShadowRoot, shouldEqual: string): {
-    message: () => string;
-    pass: boolean;
-};
-export declare function compareHtml(input: string | HTMLElement | ShadowRoot, shouldEqual: string, serializeShadowRoot: boolean): {
-    message: () => string;
-    pass: boolean;
-};
+export declare function toEqualHtml(input: string | HTMLElement | ShadowRoot, shouldEqual: string): {
+    message: () => string;
+    pass: boolean;
+};
+export declare function toEqualLightHtml(input: string | HTMLElement | ShadowRoot, shouldEqual: string): {
+    message: () => string;
+    pass: boolean;
+};
+export declare function compareHtml(input: string | HTMLElement | ShadowRoot, shouldEqual: string, serializeShadowRoot: boolean): {
+    message: () => string;
+    pass: boolean;
+};

package/testing/matchers/index.d.ts

@@ -1,23 +1,23 @@
-import { toEqualAttribute, toEqualAttributes, toHaveAttribute } from './attributes';
-import { toHaveClass, toHaveClasses, toMatchClasses } from './class-list';
-import { toHaveFirstReceivedEventDetail, toHaveNthReceivedEventDetail, toHaveReceivedEvent, toHaveReceivedEventDetail, toHaveReceivedEventTimes } from './events';
-import { toEqualHtml, toEqualLightHtml } from './html';
-import { toMatchScreenshot } from './screenshot';
-import { toEqualText } from './text';
-export declare const expectExtend: {
-    toEqualAttribute: typeof toEqualAttribute;
-    toEqualAttributes: typeof toEqualAttributes;
-    toEqualHtml: typeof toEqualHtml;
-    toEqualLightHtml: typeof toEqualLightHtml;
-    toEqualText: typeof toEqualText;
-    toHaveAttribute: typeof toHaveAttribute;
-    toHaveClass: typeof toHaveClass;
-    toHaveClasses: typeof toHaveClasses;
-    toMatchClasses: typeof toMatchClasses;
-    toHaveReceivedEvent: typeof toHaveReceivedEvent;
-    toHaveReceivedEventDetail: typeof toHaveReceivedEventDetail;
-    toHaveReceivedEventTimes: typeof toHaveReceivedEventTimes;
-    toHaveFirstReceivedEventDetail: typeof toHaveFirstReceivedEventDetail;
-    toHaveNthReceivedEventDetail: typeof toHaveNthReceivedEventDetail;
-    toMatchScreenshot: typeof toMatchScreenshot;
-};
+import { toEqualAttribute, toEqualAttributes, toHaveAttribute } from './attributes';
+import { toHaveClass, toHaveClasses, toMatchClasses } from './class-list';
+import { toHaveFirstReceivedEventDetail, toHaveNthReceivedEventDetail, toHaveReceivedEvent, toHaveReceivedEventDetail, toHaveReceivedEventTimes } from './events';
+import { toEqualHtml, toEqualLightHtml } from './html';
+import { toMatchScreenshot } from './screenshot';
+import { toEqualText } from './text';
+export declare const expectExtend: {
+    toEqualAttribute: typeof toEqualAttribute;
+    toEqualAttributes: typeof toEqualAttributes;
+    toEqualHtml: typeof toEqualHtml;
+    toEqualLightHtml: typeof toEqualLightHtml;
+    toEqualText: typeof toEqualText;
+    toHaveAttribute: typeof toHaveAttribute;
+    toHaveClass: typeof toHaveClass;
+    toHaveClasses: typeof toHaveClasses;
+    toMatchClasses: typeof toMatchClasses;
+    toHaveReceivedEvent: typeof toHaveReceivedEvent;
+    toHaveReceivedEventDetail: typeof toHaveReceivedEventDetail;
+    toHaveReceivedEventTimes: typeof toHaveReceivedEventTimes;
+    toHaveFirstReceivedEventDetail: typeof toHaveFirstReceivedEventDetail;
+    toHaveNthReceivedEventDetail: typeof toHaveNthReceivedEventDetail;
+    toMatchScreenshot: typeof toMatchScreenshot;
+};

package/testing/matchers/screenshot.d.ts

@@ -1,5 +1,5 @@
-import type * as d from '@rindo/core/internal';
-export declare function toMatchScreenshot(compare: d.ScreenshotDiff, opts?: d.MatchScreenshotOptions): {
-    message: () => string;
-    pass: boolean;
-};
+import type * as d from '@rindo/core/internal';
+export declare function toMatchScreenshot(compare: d.ScreenshotDiff, opts?: d.MatchScreenshotOptions): {
+    message: () => string;
+    pass: boolean;
+};

package/testing/matchers/text.d.ts

@@ -1,4 +1,4 @@
-export declare function toEqualText(input: HTMLElement | string, expectTextContent: string): {
-    message: () => string;
-    pass: boolean;
-};
+export declare function toEqualText(input: HTMLElement | string, expectTextContent: string): {
+    message: () => string;
+    pass: boolean;
+};

package/testing/mock-fetch.d.ts

@@ -1,11 +1,11 @@
-import { MockResponse } from '../mock-doc';
-export declare function setupMockFetch(global: any): void;
-export declare function mockFetchReset(): void;
-export declare const mockFetch: {
-    json(data: any, url?: string): void;
-    text(data: string, url?: string): void;
-    response(rsp: MockResponse, url?: string): void;
-    reject(rsp?: MockResponse, url?: string): void;
-    reset: typeof mockFetchReset;
-};
-export { MockHeaders, MockRequest, MockRequestInfo, MockRequestInit, MockResponse, MockResponseInit, } from '../mock-doc';
+import { MockResponse } from '../mock-doc';
+export declare function setupMockFetch(global: any): void;
+export declare function mockFetchReset(): void;
+export declare const mockFetch: {
+    json(data: any, url?: string): void;
+    text(data: string, url?: string): void;
+    response(rsp: MockResponse, url?: string): void;
+    reject(rsp?: MockResponse, url?: string): void;
+    reset: typeof mockFetchReset;
+};
+export { MockHeaders, MockRequest, MockRequestInfo, MockRequestInit, MockResponse, MockResponseInit, } from '../mock-doc';

package/testing/mocks.d.ts

@@ -1,56 +1,56 @@
-import type { BuildCtx, Cache, CompilerCtx, Config, LoadConfigInit, Module, UnvalidatedConfig, ValidatedConfig } from '@rindo/core/internal';
-import { TestingLogger } from './testing-logger';
-import { TestingSystem } from './testing-sys';
-/**
- * Creates a mock instance of an internal, validated Rindo configuration object
- * the caller
- * @param overrides a partial implementation of `ValidatedConfig`. Any provided fields will override the defaults
- * provided by this function.
- * @returns the mock Rindo configuration
- */
-export declare function mockValidatedConfig(overrides?: Partial<ValidatedConfig>): ValidatedConfig;
-/**
- * Creates a mock instance of a Rindo configuration entity. The mocked configuration has no guarantees around the
- * types/validity of its data.
- * @param overrides a partial implementation of `UnvalidatedConfig`. Any provided fields will override the defaults
- * provided by this function.
- * @returns the mock Rindo configuration
- */
-export declare function mockConfig(overrides?: Partial<UnvalidatedConfig>): UnvalidatedConfig;
-/**
- * Creates a configuration object used to bootstrap a Rindo task invocation
- *
- * Several fields are intentionally undefined for this entity. While it would be trivial to stub them out, this mock
- * generation function operates under the assumption that entities like loggers and compiler system abstractions will
- * be shared by multiple entities in a test suite, who should provide those entities to this function
- *
- * @param overrides the properties on the default entity to manually override
- * @returns the default configuration initialization object, with any overrides applied
- */
-export declare const mockLoadConfigInit: (overrides?: Partial<LoadConfigInit>) => LoadConfigInit;
-export declare function mockCompilerCtx(config?: Config): CompilerCtx;
-export declare function mockBuildCtx(config?: Config, compilerCtx?: CompilerCtx): BuildCtx;
-export declare function mockCache(config?: Config, compilerCtx?: CompilerCtx): Cache;
-export declare function mockLogger(): TestingLogger;
-/**
- * Create a {@link CompilerSystem} entity for testing the compiler.
- *
- * This function acts as a thin wrapper around a {@link TestingSystem} entity creation. It exists to provide a logical
- * place in the codebase where we might expect Rindo engineers to reach for when attempting to mock a
- * {@link CompilerSystem} base type. Should there prove to be usage of both this function and the one it wraps,
- * reconsider if this wrapper is necessary.
- *
- * @returns a System instance for testing purposes.
- */
-export declare function mockCompilerSystem(): TestingSystem;
-export declare function mockDocument(html?: string): Document;
-export declare function mockWindow(html?: string): Window;
-/**
- * This gives you a mock Module, an interface which is the internal compiler
- * representation of a module. It includes a bunch of information necessary for
- * compilation, this mock basically sets sane defaults for all those values.
- *
- * @param mod is an override module that you can supply to set particular values
- * @returns a module object ready to use in tests!
- */
-export declare const mockModule: (mod?: Partial<Module>) => Module;
+import type { BuildCtx, Cache, CompilerCtx, Config, LoadConfigInit, Module, UnvalidatedConfig, ValidatedConfig } from '@rindo/core/internal';
+import { TestingLogger } from './testing-logger';
+import { TestingSystem } from './testing-sys';
+/**
+ * Creates a mock instance of an internal, validated Rindo configuration object
+ * the caller
+ * @param overrides a partial implementation of `ValidatedConfig`. Any provided fields will override the defaults
+ * provided by this function.
+ * @returns the mock Rindo configuration
+ */
+export declare function mockValidatedConfig(overrides?: Partial<ValidatedConfig>): ValidatedConfig;
+/**
+ * Creates a mock instance of a Rindo configuration entity. The mocked configuration has no guarantees around the
+ * types/validity of its data.
+ * @param overrides a partial implementation of `UnvalidatedConfig`. Any provided fields will override the defaults
+ * provided by this function.
+ * @returns the mock Rindo configuration
+ */
+export declare function mockConfig(overrides?: Partial<UnvalidatedConfig>): UnvalidatedConfig;
+/**
+ * Creates a configuration object used to bootstrap a Rindo task invocation
+ *
+ * Several fields are intentionally undefined for this entity. While it would be trivial to stub them out, this mock
+ * generation function operates under the assumption that entities like loggers and compiler system abstractions will
+ * be shared by multiple entities in a test suite, who should provide those entities to this function
+ *
+ * @param overrides the properties on the default entity to manually override
+ * @returns the default configuration initialization object, with any overrides applied
+ */
+export declare const mockLoadConfigInit: (overrides?: Partial<LoadConfigInit>) => LoadConfigInit;
+export declare function mockCompilerCtx(config?: Config): CompilerCtx;
+export declare function mockBuildCtx(config?: Config, compilerCtx?: CompilerCtx): BuildCtx;
+export declare function mockCache(config?: Config, compilerCtx?: CompilerCtx): Cache;
+export declare function mockLogger(): TestingLogger;
+/**
+ * Create a {@link CompilerSystem} entity for testing the compiler.
+ *
+ * This function acts as a thin wrapper around a {@link TestingSystem} entity creation. It exists to provide a logical
+ * place in the codebase where we might expect Rindo engineers to reach for when attempting to mock a
+ * {@link CompilerSystem} base type. Should there prove to be usage of both this function and the one it wraps,
+ * reconsider if this wrapper is necessary.
+ *
+ * @returns a System instance for testing purposes.
+ */
+export declare function mockCompilerSystem(): TestingSystem;
+export declare function mockDocument(html?: string): Document;
+export declare function mockWindow(html?: string): Window;
+/**
+ * This gives you a mock Module, an interface which is the internal compiler
+ * representation of a module. It includes a bunch of information necessary for
+ * compilation, this mock basically sets sane defaults for all those values.
+ *
+ * @param mod is an override module that you can supply to set particular values
+ * @returns a module object ready to use in tests!
+ */
+export declare const mockModule: (mod?: Partial<Module>) => Module;

package/testing/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rindo/core/testing",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Rindo testing suite.",
   "main": "./index.js",
   "types": "./index.d.ts",

package/testing/puppeteer/index.d.ts

@@ -1,2 +1,2 @@
-export type { E2EElement, E2EPage } from './puppeteer-declarations';
-export { newE2EPage } from './puppeteer-page';
+export type { E2EElement, E2EPage } from './puppeteer-declarations';
+export { newE2EPage } from './puppeteer-page';

package/testing/puppeteer/puppeteer-browser.d.ts

@@ -1,6 +1,6 @@
-import type { ValidatedConfig } from '@rindo/core/internal';
-import type * as puppeteer from 'puppeteer';
-export declare function startPuppeteerBrowser(config: ValidatedConfig): Promise<puppeteer.Browser>;
-export declare function connectBrowser(): Promise<any>;
-export declare function disconnectBrowser(browser: puppeteer.Browser): Promise<void>;
-export declare function newBrowserPage(browser: puppeteer.Browser): Promise<puppeteer.Page>;
+import type { ValidatedConfig } from '@rindo/core/internal';
+import type * as puppeteer from 'puppeteer';
+export declare function startPuppeteerBrowser(config: ValidatedConfig): Promise<puppeteer.Browser>;
+export declare function connectBrowser(): Promise<any>;
+export declare function disconnectBrowser(browser: puppeteer.Browser): Promise<void>;
+export declare function newBrowserPage(browser: puppeteer.Browser): Promise<puppeteer.Page>;