@rindo/core 2.16.0-beta.0

package/testing/jest/jest-config.d.ts

@@ -0,0 +1,16 @@
+import type * as d from '@rindo/core/internal';
+import type { Config } from '@jest/types';
+/**
+ * Builds the `argv` to be used when programmatically invoking the Jest CLI
+ * @param config the Rindo config to use while generating Jest CLI arguments
+ * @returns the arguments to pass to the Jest CLI, wrapped in an object
+ */
+export declare function buildJestArgv(config: d.Config): Config.Argv;
+/**
+ * Generate a Jest run configuration to be used as a part of the `argv` passed to the Jest CLI when it is invoked
+ * programmatically
+ * @param config the Rindo config to use while generating Jest CLI arguments
+ * @returns the Jest Config to attach to the `argv` argument
+ */
+export declare function buildJestConfig(config: d.Config): string;
+export declare function getProjectListFromCLIArgs(config: d.Config, argv: Config.Argv): Config.Path[];

package/testing/jest/jest-environment.d.ts

@@ -0,0 +1,15 @@
+import type { JestEnvironmentGlobal } from '@rindo/core/internal';
+export declare function createJestPuppeteerEnvironment(): {
+    new (config: any): {
+        [x: string]: any;
+        global: JestEnvironmentGlobal;
+        browser: any;
+        pages: any[];
+        setup(): Promise<void>;
+        newPuppeteerPage(): Promise<import("puppeteer").Page>;
+        closeOpenPages(): Promise<void>;
+        teardown(): Promise<void>;
+        getVmContext(): any;
+    };
+    [x: string]: any;
+};

package/testing/jest/jest-preprocessor.d.ts

@@ -0,0 +1,59 @@
+declare type Jest26CacheKeyOptions = {
+    instrument: boolean;
+    rootDir: string;
+};
+declare type Jest26Config = {
+    instrument: boolean;
+    rootDir: string;
+};
+declare type Jest27TransformOptions = {
+    config: Jest26Config;
+};
+export declare const jestPreprocessor: {
+    /**
+     * Transforms a file to CommonJS to be used by Jest. The API for `process` is described in the
+     * ["Writing custom transformers"](https://jestjs.io/docs/code-transformation#writing-custom-transformers)
+     * documentation on the jest site. Unfortunately, the URL is not versioned at the time of this writing. For
+     * reference, the v27.2 docs were referenced (the most recent available).
+     *
+     * This function attempts to support several versions of Jest (v23 through v27). Support for earlier versions of Jest
+     * will be removed in a future major version of Rindo.
+     *
+     * @param sourceText the contents of the source file
+     * @param sourcePath the path to the source file
+     * @param jestConfig the jest configuration when called by Jest 26 and lower. This parameter is folded into
+     * `transformOptions` when called by Jest 27+ as a top level `config` property. Calls to this function from Jest 27+
+     * will have a `Jest27TransformOptions` shape
+     * @param transformOptions an object containing the various transformation options. In Jest 27+ this parameter occurs
+     * third in this function signature (and no fourth parameter is formally accepted)
+     * @returns the transformed file contents if the file should be transformed. returns the original source otherwise
+     */
+    process(sourceText: string, sourcePath: string, jestConfig: Jest26Config | Jest27TransformOptions, transformOptions?: Jest26Config): string;
+    /**
+     * Generates a key used to cache the results of transforming a file. This helps avoid re-processing a file via the
+     * `transform` function unnecessarily (when no changes have occurred). The API for `getCacheKey` is described in the
+     * ["Writing custom transformers"](https://jestjs.io/docs/code-transformation#writing-custom-transformers)
+     * documentation on the jest site. Unfortunately, the URL is not versioned at the time of this writing. For
+     * reference, the v27.2 docs were referenced (the most recent available).
+     *
+     * This function attempts to support several versions of Jest (v23 through v27). Support for earlier versions of Jest
+     * will be removed in a future major version of Rindo.
+     *
+     * @param sourceText the contents of the source file
+     * @param sourcePath the path to the source file
+     * @param jestConfigStr a stringified version of the jest configuration when called by Jest 26 and lower. This
+     * parameter takes the shape of `transformOptions` when called by Jest 27+.
+     * @param transformOptions an object containing the various transformation options. In Jest 27+ this parameter occurs
+     * third in this function signature (and no fourth parameter is formally accepted)
+     * @returns the key to cache a file with
+     */
+    getCacheKey(sourceText: string, sourcePath: string, jestConfigStr: string | Jest27TransformOptions, transformOptions?: Jest26CacheKeyOptions): string;
+};
+/**
+ * Determines if a file should be transformed prior to being consumed by Jest, based on the file name and its contents
+ * @param filePath the path of the file
+ * @param sourceText the contents of the file
+ * @returns `true` if the file should be transformed, `false` otherwise
+ */
+export declare function shouldTransform(filePath: string, sourceText: string): boolean;
+export {};

package/testing/jest/jest-runner.d.ts

@@ -0,0 +1,9 @@
+import type * as d from '@rindo/core/internal';
+export declare function runJest(config: d.Config, env: d.E2EProcessEnv): Promise<boolean>;
+/**
+ * Creates a Rindo test runner
+ * @returns the test runner
+ */
+export declare function createTestRunner(): any;
+export declare function includeTestFile(testPath: string, env: d.E2EProcessEnv): boolean;
+export declare function getEmulateConfigs(testing: d.TestingConfig, flags: d.ConfigFlags): d.EmulateConfig[];

package/testing/jest/jest-screenshot.d.ts

@@ -0,0 +1,2 @@
+import type * as d from '@rindo/core/internal';
+export declare function runJestScreenshot(config: d.Config, env: d.E2EProcessEnv): Promise<boolean>;

package/testing/jest/jest-serializer.d.ts

@@ -0,0 +1,5 @@
+import { MockNode } from '@rindo/core/mock-doc';
+export declare const HtmlSerializer: {
+    print: (val: HTMLElement | MockNode) => string;
+    test: (val: any) => boolean;
+};

package/testing/jest/jest-setup-test-framework.d.ts

@@ -0,0 +1 @@
+export declare function jestSetupTestFramework(): void;

package/testing/jest-environment.js

@@ -0,0 +1,3 @@
+const { createJestPuppeteerEnvironment } = require('./index.js');
+
+module.exports = createJestPuppeteerEnvironment();

package/testing/jest-preprocessor.js

@@ -0,0 +1,3 @@
+const { jestPreprocessor } = require('./index.js');
+
+module.exports = jestPreprocessor;

package/testing/jest-preset.js

@@ -0,0 +1,37 @@
+/**
+ * The path's declared below are relative. Specifically, they are relative to the location of this file after
+ * compilation of the Rindo compiler has completed. See `scripts/bundles/testing` for the location of this file
+ * following compilation.
+ */
+const path = require('path');
+const testingDir = __dirname;
+const rootDir = path.join(testingDir, '..');
+const internalDir = path.join(rootDir, 'internal');
+
+// NOTE: if you change this, also change compiler/transpile.ts
+const moduleExtensions = ['ts', 'tsx', 'js', 'mjs', 'jsx'];
+const moduleExtensionRegexp = '(' + moduleExtensions.join('|') + ')';
+
+module.exports = {
+  moduleFileExtensions: [...moduleExtensions, 'json', 'd.ts'],
+  moduleNameMapper: {
+    '^@rindo/core/cli$': path.join(rootDir, 'cli', 'index.js'),
+    '^@rindo/core/compiler$': path.join(rootDir, 'compiler', 'rindo.js'),
+    '^@rindo/core/internal$': path.join(internalDir, 'testing', 'index.js'),
+    '^@rindo/core/internal/app-data$': path.join(internalDir, 'app-data', 'index.cjs'),
+    '^@rindo/core/internal/app-globals$': path.join(internalDir, 'app-globals', 'index.js'),
+    '^@rindo/core/internal/testing$': path.join(internalDir, 'testing', 'index.js'),
+    '^@rindo/core/mock-doc$': path.join(rootDir, 'mock-doc', 'index.cjs'),
+    '^@rindo/core/sys$': path.join(rootDir, 'sys', 'node', 'index.js'),
+    '^@rindo/core/testing$': path.join(testingDir, 'index.js'),
+    '^@rindo/core$': path.join(internalDir, 'testing', 'index.js'),
+  },
+  setupFilesAfterEnv: [path.join(testingDir, 'jest-setuptestframework.js')],
+  testEnvironment: path.join(testingDir, 'jest-environment.js'),
+  testPathIgnorePatterns: ['/.cache', '/.rindo', '/.vscode', '/dist', '/node_modules', '/www'],
+  testRegex: '(/__tests__/.*|\\.?(test|spec))\\.' + moduleExtensionRegexp + '$',
+  transform: {
+    '^.+\\.(ts|tsx|jsx|css)$': path.join(testingDir, 'jest-preprocessor.js'),
+  },
+  watchPathIgnorePatterns: ['^.+\\.d\\.ts$'],
+};

package/testing/jest-runner.js

@@ -0,0 +1,3 @@
+const { createTestRunner } = require('./index.js');
+
+module.exports = createTestRunner();

package/testing/jest-setuptestframework.js

@@ -0,0 +1,3 @@
+const { jestSetupTestFramework } = require('./index.js');
+
+jestSetupTestFramework();

package/testing/matchers/attributes.d.ts

@@ -0,0 +1,14 @@
+export declare function toEqualAttribute(elm: HTMLElement, expectAttrName: string, expectAttrValue: string): {
+    message: () => string;
+    pass: boolean;
+};
+export declare function toEqualAttributes(elm: HTMLElement, expectAttrs: {
+    [attrName: string]: any;
+}): {
+    message: () => string;
+    pass: boolean;
+};
+export declare function toHaveAttribute(elm: HTMLElement, expectAttrName: string): {
+    message: () => string;
+    pass: boolean;
+};

package/testing/matchers/class-list.d.ts

@@ -0,0 +1,12 @@
+export declare function toHaveClass(elm: HTMLElement, expectClassName: string): {
+    message: () => string;
+    pass: boolean;
+};
+export declare function toHaveClasses(elm: HTMLElement, expectClassNames: string[]): {
+    message: () => string;
+    pass: boolean;
+};
+export declare function toMatchClasses(elm: HTMLElement, expectClassNames: string[]): {
+    message: () => string;
+    pass: boolean;
+};

package/testing/matchers/events.d.ts

@@ -0,0 +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;
+};

package/testing/matchers/html.d.ts

@@ -0,0 +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;
+};

package/testing/matchers/index.d.ts

@@ -0,0 +1,23 @@
+import { toEqualAttribute, toEqualAttributes, toHaveAttribute } from './attributes';
+import { toHaveReceivedEvent, toHaveReceivedEventDetail, toHaveReceivedEventTimes, toHaveFirstReceivedEventDetail, toHaveNthReceivedEventDetail } from './events';
+import { toEqualHtml, toEqualLightHtml } from './html';
+import { toEqualText } from './text';
+import { toHaveClass, toHaveClasses, toMatchClasses } from './class-list';
+import { toMatchScreenshot } from './screenshot';
+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

@@ -0,0 +1,5 @@
+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

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

package/testing/mock-fetch.d.ts

@@ -0,0 +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, MockRequestInit, MockRequestInfo, MockResponse, MockResponseInit, } from '../mock-doc';

package/testing/mocks.d.ts

@@ -0,0 +1,10 @@
+import type { BuildCtx, Cache, CompilerCtx, CompilerSystem, Config } from '@rindo/core/internal';
+import { TestingLogger } from './testing-logger';
+export declare function mockConfig(sys?: CompilerSystem): Config;
+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;
+export declare function mockRindoSystem(): CompilerSystem;
+export declare function mockDocument(html?: string): Document;
+export declare function mockWindow(html?: string): Window;

package/testing/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@rindo/core/testing",
+  "version": "0.0.0-dev.20220810110141",
+  "description": "Rindo testing suite.",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "private": true
+}

package/testing/puppeteer/index.d.ts

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

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

@@ -0,0 +1,6 @@
+import type { Config } from '@rindo/core/internal';
+import type * as puppeteer from 'puppeteer';
+export declare function startPuppeteerBrowser(config: Config): 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>;