@rindo/core 2.17.0 → 2.17.1

package/internal/rindo-public-compiler.d.ts

@@ -1,5 +1,6 @@
 import type { JsonDocs } from './rindo-public-docs';
 import type { PrerenderUrlResults } from '../internal';
+import type { ConfigFlags } from '../cli/config-flags';
 export * from './rindo-public-docs';
 /**
  * https://rindojs.web.app/docs/config/
@@ -356,6 +357,29 @@ declare type Loose<T extends Object> = Record<string, any> & Partial<T>;
  * and have type information carry though as we construct an object which is a valid `Config`.
  */
 export declare type UnvalidatedConfig = Loose<Config>;
+/**
+ * Helper type to strip optional markers from keys in a type, while preserving other type information for the key.
+ * This type takes a union of keys, K, in type T to allow for the type T to be gradually updated.
+ *
+ * ```typescript
+ * type Foo { bar?: number, baz?: string }
+ * type ReqFieldFoo = RequireFields<Foo, 'bar'>; // { bar: number, baz?: string }
+ * ```
+ */
+declare type RequireFields<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+/**
+ * Fields in {@link Config} to make required for {@link ValidatedConfig}
+ */
+declare type StrictConfigFields = 'flags' | 'logger';
+/**
+ * A version of {@link Config} that makes certain fields required. This type represents a valid configuration entity.
+ * When a configuration is received by the user, it is a bag of unverified data. In order to make stricter guarantees
+ * about the data from a type-safety perspective, this type is intended to be used throughout the codebase once
+ * validations have occurred at runtime.
+ */
+export declare type ValidatedConfig = RequireFields<Config, StrictConfigFields>;
 export interface HydratedFlag {
     /**
      * Defaults to `hydrated`.
@@ -505,51 +529,6 @@ export interface DevServerEditor {
     supported?: boolean;
     priority?: number;
 }
-export interface ConfigFlags {
-    task?: TaskCommand;
-    args?: string[];
-    knownArgs?: string[];
-    unknownArgs?: string[];
-    address?: string;
-    build?: boolean;
-    cache?: boolean;
-    checkVersion?: boolean;
-    ci?: boolean;
-    compare?: boolean;
-    config?: string;
-    debug?: boolean;
-    dev?: boolean;
-    docs?: boolean;
-    docsApi?: string;
-    docsJson?: string;
-    e2e?: boolean;
-    emulate?: string;
-    es5?: boolean;
-    esm?: boolean;
-    headless?: boolean;
-    help?: boolean;
-    log?: boolean;
-    logLevel?: LogLevel;
-    verbose?: boolean;
-    maxWorkers?: number;
-    open?: boolean;
-    port?: number;
-    prerender?: boolean;
-    prod?: boolean;
-    profile?: boolean;
-    root?: string;
-    screenshot?: boolean;
-    screenshotConnector?: string;
-    serve?: boolean;
-    serviceWorker?: boolean;
-    spec?: boolean;
-    ssr?: boolean;
-    stats?: boolean;
-    updateScreenshot?: boolean;
-    version?: boolean;
-    watch?: boolean;
-    devtools?: boolean;
-}
 export declare type TaskCommand = 'build' | 'docs' | 'generate' | 'g' | 'help' | 'info' | 'prerender' | 'serve' | 'telemetry' | 'test' | 'version';
 export declare type PageReloadStrategy = 'hmr' | 'pageReload' | null;
 /**
@@ -1653,7 +1632,29 @@ export interface EmulateViewport {
      */
     isLandscape?: boolean;
 }
-export declare type LogLevel = 'debug' | 'info' | 'warn' | 'error';
+/**
+ * This sets the log level hierarchy for our terminal logger, ranging from
+ * most to least verbose.
+ *
+ * Ordering the levels like this lets us easily check whether we should log a
+ * message at a given time. For instance, if the log level is set to `'warn'`,
+ * then anything passed to the logger with level `'warn'` or `'error'` should
+ * be logged, but we should _not_ log anything with level `'info'` or `'debug'`.
+ *
+ * If we have a current log level `currentLevel` and a message with level
+ * `msgLevel` is passed to the logger, we can determine whether or not we should
+ * log it by checking if the log level on the message is further up or at the
+ * same level in the hierarchy than `currentLevel`, like so:
+ *
+ * ```ts
+ * LOG_LEVELS.indexOf(msgLevel) >= LOG_LEVELS.indexOf(currentLevel)
+ * ```
+ *
+ * NOTE: for the reasons described above, do not change the order of the entries
+ * in this array without good reason!
+ */
+export declare const LOG_LEVELS: readonly ["debug", "info", "warn", "error"];
+export declare type LogLevel = typeof LOG_LEVELS[number];
 /**
  * Common logger to be used by the compiler, dev-server and CLI. The CLI will use a
  * NodeJS based console logging and colors, and the web will use browser based
@@ -1980,7 +1981,7 @@ export interface LoadConfigInit {
  * operations around the codebase.
  */
 export interface LoadConfigResults {
-    config: UnvalidatedConfig;
+    config: ValidatedConfig;
     diagnostics: Diagnostic[];
     tsconfig: {
         path: string;
@@ -2048,14 +2049,32 @@ export interface PrerenderResults {
     duration: number;
     average: number;
 }
+/**
+ * Input for CSS optimization functions, including the input CSS
+ * string and a few boolean options which turn on or off various
+ * optimizations.
+ */
 export interface OptimizeCssInput {
     input: string;
     filePath?: string;
-    autoprefixer?: any;
+    autoprefixer?: boolean | null | AutoprefixerOptions;
     minify?: boolean;
     sourceMap?: boolean;
     resolveUrl?: (url: string) => Promise<string> | string;
 }
+/**
+ * This is not a real interface describing the options which can
+ * be passed to autoprefixer, for that see the docs, here:
+ * https://github.com/postcss/autoprefixer#options
+ *
+ * Instead, this basically just serves as a label type to track
+ * that arguments are being passed consistently.
+ */
+export declare type AutoprefixerOptions = Object;
+/**
+ * Output from CSS optimization functions, wrapping up optimized
+ * CSS and any diagnostics produced during optimization.
+ */
 export interface OptimizeCssOutput {
     output: string;
     diagnostics: Diagnostic[];

package/internal/testing/index.js

@@ -1089,5 +1089,5 @@ exports.setMode = e => modeResolutionChain.push(e), exports.setPlatformHelpers =
   }), 100));
  }));
 }, exports.stopAutoApplyChanges = stopAutoApplyChanges, exports.styles = styles, 
-exports.supportsConstructibleStylesheets = !1, exports.supportsListenerOptions = !0, 
+exports.supportsConstructableStylesheets = !1, exports.supportsListenerOptions = !0, 
 exports.win = win, exports.writeTask = writeTask;

package/internal/testing/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rindo/core/internal/testing",
-  "version": "2.17.0",
+  "version": "2.17.1",
   "description": "Rindo internal testing platform to be imported by the Rindo Compiler. Breaking changes can and will happen at any time.",
   "main": "./index.js",
   "private": true

package/mock-doc/index.cjs

@@ -1,5 +1,5 @@
 /*!
- Rindo Mock Doc (CommonJS) v2.17.0 | MIT Licensed | https://rindojs.web.app
+ Rindo Mock Doc (CommonJS) v2.17.1 | MIT Licensed | https://rindojs.web.app
  */
 var mockDoc = (function(exports) {
 'use strict';

package/mock-doc/index.js

@@ -1,5 +1,5 @@
 /*!
- Rindo Mock Doc v2.17.0 | MIT Licensed | https://rindojs.web.app
+ Rindo Mock Doc v2.17.1 | MIT Licensed | https://rindojs.web.app
  */
 const CONTENT_REF_ID = 'r';
 const ORG_LOCATION_ID = 'o';

package/mock-doc/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rindo/core/mock-doc",
-  "version": "2.17.0",
+  "version": "2.17.1",
   "description": "Mock window, document and DOM outside of a browser environment.",
   "main": "./index.cjs",
   "module": "./index.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rindo/core",
-  "version": "2.17.0",
+  "version": "2.17.1",
   "license": "MIT",
   "main": "./internal/rindo-core/index.cjs",
   "module": "./internal/rindo-core/index.js",
@@ -26,8 +26,8 @@
   "scripts": {
     "build": "node scripts --prepare && npm run tsc.prod && npm run rollup.prod.ci",
     "changelog": "conventional-changelog -p angular -o -i CHANGELOG.md -s",
-    "clean": "rm -rf build/ cli/ compiler/ dev-server/ internal/ mock-doc/ sys/ testing/ && npm run clean-scripts",
-    "clean-scripts": "rm -rf scripts/build",
+    "clean": "rimraf build cli compiler dev-server internal mock-doc sys testing && npm run clean-scripts",
+    "clean-scripts": "rimraf scripts/build",
     "license": "node scripts --license",
     "lint": "eslint \"src/*.ts\" \"src/**/*.ts\"",
     "prettier": "npm run prettier.base -- --write",
@@ -87,6 +87,7 @@
     "dts-bundle-generator": "~5.3.0",
     "eslint": "^8.13.0",
     "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-jest": "^26.5.3",
     "eslint-plugin-jsdoc": "^39.3.1",
     "execa": "4.1.0",
     "exit": "^0.1.2",
@@ -116,6 +117,7 @@
     "puppeteer": "~10.0.0",
     "rollup": "2.42.3",
     "rollup-plugin-sourcemaps": "^0.6.3",
+    "rimraf": "^3.0.2",
     "semver": "7.3.4",
     "sizzle": "^2.3.6",
     "terser": "5.6.1",

package/screenshot/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rindo/core/screenshot",
-  "version": "2.17.0",
+  "version": "2.17.1",
   "description": "Rindo Screenshot.",
   "main": "./index.js",
   "types": "./index.d.ts",

package/sys/node/index.js

@@ -1,5 +1,5 @@
 /*!
- Rindo Node System v2.17.0 | MIT Licensed | https://rindojs.web.app
+ Rindo Node System v2.17.1 | MIT Licensed | https://rindojs.web.app
  */
 function _interopDefaultLegacy(e) {
  return e && "object" == typeof e && "default" in e ? e : {
@@ -274,7 +274,7 @@ Object.defineProperty(exports, "__esModule", {
  value: !0
 });
 
-const fs = require("./graceful-fs.js"), path = require("path"), require$$1 = require("util"), glob = require("./glob.js"), require$$6 = require("os"), require$$3 = require("crypto"), require$$2 = require("fs"), require$$4 = require("stream"), require$$5 = require("assert"), require$$7 = require("events"), require$$8 = require("buffer"), require$$9 = require("tty"), cp = require("child_process"), fs__default = _interopDefaultLegacy(fs), path__default = _interopDefaultLegacy(path), require$$1__default = _interopDefaultLegacy(require$$1), glob__default = _interopDefaultLegacy(glob), require$$6__default = _interopDefaultLegacy(require$$6), require$$6__namespace = _interopNamespace(require$$6), require$$3__default = _interopDefaultLegacy(require$$3), require$$2__default = _interopDefaultLegacy(require$$2), require$$4__default = _interopDefaultLegacy(require$$4), require$$5__default = _interopDefaultLegacy(require$$5), require$$7__default = _interopDefaultLegacy(require$$7), require$$8__default = _interopDefaultLegacy(require$$8), require$$9__default = _interopDefaultLegacy(require$$9), cp__namespace = _interopNamespace(cp);
+const fs = require("./graceful-fs.js"), path = require("path"), require$$1 = require("util"), glob = require("./glob.js"), require$$6 = require("os"), require$$3 = require("crypto"), require$$2 = require("fs"), require$$4 = require("stream"), require$$5 = require("assert"), require$$7 = require("events"), require$$8 = require("buffer"), require$$9 = require("tty"), cp = require("child_process"), fs__default = _interopDefaultLegacy(fs), path__default = _interopDefaultLegacy(path), require$$1__default = _interopDefaultLegacy(require$$1), glob__default = _interopDefaultLegacy(glob), require$$6__default = _interopDefaultLegacy(require$$6), require$$6__namespace = _interopNamespace(require$$6), require$$3__default = _interopDefaultLegacy(require$$3), require$$2__default = _interopDefaultLegacy(require$$2), require$$4__default = _interopDefaultLegacy(require$$4), require$$5__default = _interopDefaultLegacy(require$$5), require$$7__default = _interopDefaultLegacy(require$$7), require$$8__default = _interopDefaultLegacy(require$$8), require$$9__default = _interopDefaultLegacy(require$$9), cp__namespace = _interopNamespace(cp), LOG_LEVELS = [ "debug", "info", "warn", "error" ];
 
 symbols = createCommonjsModule((function(e) {
  const t = "Hyper" === process.env.TERM_PROGRAM, r = "win32" === process.platform, n = "linux" === process.platform, i = {
@@ -607,7 +607,7 @@ const createTerminalLogger = e => {
   red: ansiColors.red,
   yellow: ansiColors.yellow
  };
-}, LOG_LEVELS = [ "debug", "info", "warn", "error" ], shouldLog = (e, t) => LOG_LEVELS.indexOf(t) >= LOG_LEVELS.indexOf(e), formatPrefixTimestamp = () => {
+}, shouldLog = (e, t) => LOG_LEVELS.indexOf(t) >= LOG_LEVELS.indexOf(e), formatPrefixTimestamp = () => {
  const e = new Date;
  return `[${clampTwoDigits(e.getMinutes())}:${clampTwoDigits(e.getSeconds())}.${Math.floor(e.getMilliseconds() / 1e3 * 10)}]`;
 }, clampTwoDigits = e => ("0" + e.toString()).slice(-2), wordWrap = (e, t) => {
@@ -5632,7 +5632,7 @@ exports.createNodeLogger = e => {
    getColumns: () => {
     var t, r;
     const n = null !== (r = null === (t = null == e ? void 0 : e.stdout) || void 0 === t ? void 0 : t.columns) && void 0 !== r ? r : 80;
-    return Math.max(Math.min(120, n), 60);
+    return Math.max(Math.min(n, 120), 60);
    },
    memoryUsage: () => e.memoryUsage().rss,
    relativePath: (e, t) => path__default.default.relative(e, t),

package/sys/node/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rindo/core/sys/node",
-  "version": "2.17.0",
+  "version": "2.17.1",
   "description": "Rindo Node System.",
   "main": "./index.js",
   "types": "./index.d.ts",

package/sys/node/worker.js

@@ -1,5 +1,5 @@
 /*!
- Rindo Node System Worker v2.17.0 | MIT Licensed | https://rindojs.web.app
+ Rindo Node System Worker v2.17.1 | MIT Licensed | https://rindojs.web.app
  */
 function _interopNamespace(e) {
  if (e && e.__esModule) return e;

package/testing/index.d.ts

@@ -3,7 +3,7 @@ export { createTesting } from './testing';
 export { createTestRunner } from './jest/jest-runner';
 export { jestPreprocessor } from './jest/jest-preprocessor';
 export { jestSetupTestFramework } from './jest/jest-setup-test-framework';
-export { mockBuildCtx, mockConfig, mockCompilerCtx, mockDocument, mockLogger, mockCompilerSystem, mockWindow, mockModule, } from './mocks';
+export { mockBuildCtx, mockConfig, mockCompilerCtx, mockDocument, mockLoadConfigInit, mockValidatedConfig, mockLogger, mockCompilerSystem, mockWindow, mockModule, } from './mocks';
 export { MockHeaders, MockRequest, MockRequestInit, MockRequestInfo, MockResponse, MockResponseInit, mockFetch, } from './mock-fetch';
 export { newSpecPage } from './spec-page';
 export { shuffleArray } from './testing-utils';

package/testing/index.js

@@ -1,5 +1,5 @@
 /*!
- Rindo Testing v2.17.0 | MIT Licensed | https://rindojs.web.app
+ Rindo Testing v2.17.1 | MIT Licensed | https://rindojs.web.app
  */
 function _lazyRequire(e) {
  return new Proxy({}, {
@@ -817,6 +817,10 @@ function mockCompilerCtx(e) {
  }), t;
 }
 
+function mockLogger() {
+ return new TestingLogger;
+}
+
 function findRootComponent(e, t) {
  if (null != t) {
   const r = t.children, s = r.length;
@@ -2162,15 +2166,14 @@ const YELLOW = "#f39c12", RED = "#c0392b", BLUE = "#3498db", COMMON_DIR_MODULE_E
  let o = s.shift();
  o.startsWith("@") && (o += "/" + s.shift());
  const i = s.join("/");
- if ("@rindo/core" === o) {
-  return ((e, t) => {
-   let r = (t = normalizePath(t)).split("/");
-   const s = r.lastIndexOf("node_modules");
-   return s > -1 && s < r.length - 1 && (r = r.slice(s + 1), r = r[0].startsWith("@") ? r.slice(2) : r.slice(1), 
-   t = r.join("/")), new URL("./" + t, (e => new URL("../", e).href)(e)).href;
-  })(e.getCompilerExecutingPath(), i);
- }
- return e.getRemoteModuleUrl({
+ return "@rindo/core" === o ? ((e, t) => {
+  let r = (t = normalizePath(t)).split("/");
+  const s = r.lastIndexOf("node_modules");
+  s > -1 && s < r.length - 1 && (r = r.slice(s + 1), r = r[0].startsWith("@") ? r.slice(2) : r.slice(1), 
+  t = r.join("/"));
+  const n = new URL("../", e).href;
+  return new URL("./" + t, n).href;
+ })(e.getCompilerExecutingPath(), i) : e.getRemoteModuleUrl({
   moduleId: o,
   version: t.get(o),
   path: i
@@ -2182,7 +2185,7 @@ const YELLOW = "#f39c12", RED = "#c0392b", BLUE = "#3498db", COMMON_DIR_MODULE_E
   const r = e.split("/"), s = r[r.length - 2], n = r[r.length - 1];
   return !("node_modules" !== s || !isCommonDirModuleFile(n));
  })(n) || known404Urls.has(s) || (e => knownUrlSkips.some((t => e.endsWith(t))))(s))) try {
-  const o = await ((e, t, r) => (console.trace(t), e && isFunction(e.fetch) ? e.fetch(t, r) : fetch(t, r)))(e, s);
+  const o = await ((e, t, r) => e && isFunction(e.fetch) ? e.fetch(t, r) : fetch(t, r))(e, s);
   if (o) {
    if (o.ok) {
     const i = await o.clone().text();
@@ -3041,7 +3044,7 @@ const createSystem = e => {
  u("/");
  const D = {
   name: "in-memory",
-  version: "2.17.0",
+  version: "2.17.1",
   events: i,
   access: async e => c(e),
   accessSync: c,
@@ -3798,8 +3801,8 @@ exports.createJestPuppeteerEnvironment = function createJestPuppeteerEnvironment
 }, exports.createTesting = async e => {
  e = function t(e) {
   return e.buildEs5 = !1, e.devMode = !0, e.minifyCss = !1, e.minifyJs = !1, e.hashFileNames = !1, 
-  e.validateTypes = !1, e._isTesting = !0, e.buildDist = !0, e.flags = e.flags || {}, 
-  e.flags.serve = !1, e.flags.open = !1, e.outputTargets.forEach((e => {
+  e.validateTypes = !1, e._isTesting = !0, e.buildDist = !0, e.flags.serve = !1, e.flags.open = !1, 
+  e.outputTargets.forEach((e => {
    "www" === e.type && (e.serviceWorker = null);
   })), e.flags.args.includes("--watchAll") && (e.watch = !0), e;
  }(e);
@@ -3937,9 +3940,14 @@ exports.createJestPuppeteerEnvironment = function createJestPuppeteerEnvironment
  return createTestingSystem();
 }, exports.mockConfig = mockConfig, exports.mockDocument = function mockDocument(e = null) {
  return new index_cjs.MockWindow(e).document;
-}, exports.mockFetch = mockFetch, exports.mockLogger = function mockLogger() {
- return new TestingLogger;
-}, exports.mockModule = (e = {}) => ({
+}, exports.mockFetch = mockFetch, exports.mockLoadConfigInit = e => ({
+ config: {},
+ configPath: void 0,
+ initTsConfig: !0,
+ logger: void 0,
+ sys: void 0,
+ ...e
+}), exports.mockLogger = mockLogger, exports.mockModule = (e = {}) => ({
  cmps: [],
  coreRuntimeApis: [],
  collectionName: "",
@@ -3973,7 +3981,13 @@ exports.createJestPuppeteerEnvironment = function createJestPuppeteerEnvironment
  hasVdomText: !1,
  hasVdomXlink: !1,
  ...e
-}), exports.mockWindow = function mockWindow(e = null) {
+}), exports.mockValidatedConfig = function mockValidatedConfig(e) {
+ return {
+  ...mockConfig(e),
+  flags: {},
+  logger: mockLogger()
+ };
+}, exports.mockWindow = function mockWindow(e = null) {
  return new index_cjs.MockWindow(e);
 }, exports.newE2EPage = async function newE2EPage(e = {}) {
  if (!global.__NEW_TEST_PAGE__) throw new Error("newE2EPage() is only available from E2E tests, and ran with the --e2e cmd line flag.");
@@ -4076,26 +4090,28 @@ exports.createJestPuppeteerEnvironment = function createJestPuppeteerEnvironment
   };
   const o = !0 === e.failOnConsoleError, i = !0 === e.failOnNetworkError;
   t.on("console", (e => {
-   "error" === e.type() && (r.push({
+   if ("error" === e.type() && (r.push({
     type: "error",
     message: e.text(),
     location: e.location().url
-   }), o && fail(new Error(serializeConsoleMessage(e)))), function t(e) {
+   }), o)) throw new Error(serializeConsoleMessage(e));
+   !function t(e) {
     const t = serializeConsoleMessage(e), r = e.type(), s = "warning" === r ? "warn" : r;
     "debug" !== s && ("function" == typeof console[s] ? console[s](t) : console.log(r, t));
    }(e);
   })), t.on("pageerror", (e => {
-   r.push({
+   throw r.push({
     type: "pageerror",
     message: e.message,
     location: e.stack
-   }), fail(e);
+   }), e;
   })), t.on("requestfailed", (e => {
-   r.push({
+   if (r.push({
     type: "requestfailed",
     message: e.failure().errorText,
     location: e.url()
-   }), i ? fail(new Error(e.failure().errorText)) : console.error("requestfailed", e.url());
+   }), i) throw new Error(e.failure().errorText);
+   console.error("requestfailed", e.url());
   })), "string" == typeof e.html ? await e2eSetContent(t, e.html, {
    waitUntil: e.waitUntil
   }) : "string" == typeof e.url ? await e2eGoTo(t, e.url, {

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

@@ -5,7 +5,7 @@ import type { Config } from '@jest/types';
  * @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;
+export declare function buildJestArgv(config: d.ValidatedConfig): 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

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

@@ -1,9 +1,10 @@
 import type * as d from '@rindo/core/internal';
-export declare function runJest(config: d.Config, env: d.E2EProcessEnv): Promise<boolean>;
+import type { ConfigFlags } from '../../cli/config-flags';
+export declare function runJest(config: d.ValidatedConfig, 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[];
+export declare function getEmulateConfigs(testing: d.TestingConfig, flags: ConfigFlags): d.EmulateConfig[];

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

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

package/testing/mocks.d.ts

@@ -1,7 +1,32 @@
-import type { BuildCtx, Cache, CompilerCtx, CompilerSystem, Config, Module } from '@rindo/core/internal';
+import type { BuildCtx, Cache, CompilerCtx, CompilerSystem, Config, LoadConfigInit, ValidatedConfig, Module, UnvalidatedConfig } from '@rindo/core/internal';
 import { TestingSystem } from './testing-sys';
 import { TestingLogger } from './testing-logger';
-export declare function mockConfig(sys?: CompilerSystem): Config;
+/**
+ * Creates a mock instance of an internal, validated Rindo configuration object
+ * @param sys an optional compiler system to associate with the config. If one is not provided, one will be created for
+ * the caller
+ * @returns the mock Rindo configuration
+ */
+export declare function mockValidatedConfig(sys?: CompilerSystem): ValidatedConfig;
+/**
+ * Creates a mock instance of a Rindo configuration entity. The mocked configuration has no guarantees around the
+ * types/validity of its data.
+ * @param sys an optional compiler system to associate with the config. If one is not provided, one will be created for
+ * the caller
+ * @returns the mock Rindo configuration
+ */
+export declare function mockConfig(sys?: CompilerSystem): 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;

package/testing/package.json

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

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

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

package/testing/testing-utils.d.ts

@@ -1,6 +1,78 @@
+/// <reference types="jest" />
 import type * as d from '@rindo/core/internal';
 export declare function shuffleArray(array: any[]): any[];
-export declare function expectFiles(fs: d.InMemoryFileSystem, filePaths: string[]): void;
-export declare function doNotExpectFiles(fs: d.InMemoryFileSystem, filePaths: string[]): void;
+/**
+ * Testing utility to validate the existence of some provided file paths using a specific file system
+ *
+ * @param fs the file system to use to validate the existence of some files
+ * @param filePaths the paths to validate
+ * @throws when one or more of the provided file paths cannot be found
+ */
+export declare function expectFilesExist(fs: d.InMemoryFileSystem, filePaths: string[]): void;
+/**
+ * Testing utility to validate the non-existence of some provided file paths using a specific file system
+ *
+ * @param fs the file system to use to validate the non-existence of some files
+ * @param filePaths the paths to validate
+ * @throws when one or more of the provided file paths is found
+ */
+export declare function expectFilesDoNotExist(fs: d.InMemoryFileSystem, filePaths: string[]): void;
 export declare function getAppScriptUrl(config: d.Config, browserUrl: string): string;
 export declare function getAppStyleUrl(config: d.Config, browserUrl: string): string;
+/**
+ * Utility for silencing `console` functions in tests.
+ *
+ * When this function is first called it grabs a reference to the `log`,
+ * `error`, and `warn` functions on `console` and then returns a per-test setup
+ * function which sets up a fresh set of mocks (via `jest.fn()`) and then
+ * assigns them to each of these functions. This setup function will return a
+ * reference to each of the three mock functions so tests can make assertions
+ * about their calls and so on.
+ *
+ * Because references to the original `.log`, `.error`, and `.warn` functions
+ * exist in closure within the function, it can use an `afterAll` call to clean
+ * up after itself and ensure that the original implementations are restored
+ * after the test suite finishes.
+ *
+ * An example of using this to silence log statements in a single test could look
+ * like this:
+ *
+ * ```ts
+ * describe("my-test-suite", () => {
+ *   const setupConsoleMocks = setupConsoleMocker()
+ *
+ *   it("should log a message", () => {
+ *     const { logMock } = setupConsoleMocks();
+ *     myFunctionWhichLogs(foo, bar);
+ *     expect(logMock).toBeCalledWith('my log message');
+ *   })
+ * })
+ * ```
+ *
+ * @returns a per-test mock setup function
+ */
+export declare function setupConsoleMocker(): ConsoleMocker;
+interface ConsoleMocker {
+    (): {
+        logMock: jest.Mock<typeof console.log>;
+        warnMock: jest.Mock<typeof console.warn>;
+        errorMock: jest.Mock<typeof console.error>;
+    };
+}
+/**
+ * the callback that `withSilentWarn` expects to receive. Basically receives a mock
+ * as its argument and returns a `Promise`, the value of which is returns by `withSilentWarn`
+ * as well.
+ */
+declare type SilentWarnFunc<T> = (mock: jest.Mock<typeof console.warn>) => Promise<T>;
+/**
+ * Wrap a single callback with a silent `console.warn`. The callback passed in
+ * receives the mocking function as an argument, so you can easily make assertions
+ * that it is called if necessary.
+ *
+ * @param cb a callback which `withSilentWarn` will call after replacing `console.warn`
+ * with a mock.
+ * @returns a Promise wrapping the return value of the callback
+ */
+export declare function withSilentWarn<T>(cb: SilentWarnFunc<T>): Promise<T>;
+export {};

package/testing/testing.d.ts

@@ -1,2 +1,2 @@
-import type { Config, Testing } from '@rindo/core/internal';
-export declare const createTesting: (config: Config) => Promise<Testing>;
+import type { ValidatedConfig, Testing } from '@rindo/core/internal';
+export declare const createTesting: (config: ValidatedConfig) => Promise<Testing>;