@stencil/core 2.17.0 → 2.17.2

package/testing/index.js

@@ -1,5 +1,5 @@
 /*!
- Stencil Testing v2.17.0 | MIT Licensed | https://stenciljs.com
+ Stencil Testing v2.17.2 | MIT Licensed | https://stenciljs.com
  */
 function _lazyRequire(e) {
  return new Proxy({}, {
@@ -449,38 +449,40 @@ function versionIncluded(e) {
  return matchesRange(e);
 }
 
-function mockConfig(e) {
+function mockConfig(e = {}) {
  const t = path__default.default.resolve("/");
- return e || (e = createTestingSystem()), e.getCurrentDirectory = () => t, {
+ let {sys: r} = e;
+ return r || (r = createTestingSystem()), r.getCurrentDirectory = () => t, {
   _isTesting: !0,
-  namespace: "Testing",
-  rootDir: t,
-  globalScript: null,
-  devMode: !0,
-  enableCache: !1,
   buildAppCore: !1,
   buildDist: !0,
-  flags: {},
-  bundles: null,
-  outputTargets: null,
   buildEs5: !1,
+  bundles: null,
+  devMode: !0,
+  enableCache: !1,
+  extras: {},
+  flags: createConfigFlags(),
+  globalScript: null,
   hashFileNames: !1,
   logger: new TestingLogger,
   maxConcurrentWorkers: 0,
   minifyCss: !1,
   minifyJs: !1,
-  sys: e,
-  testing: null,
-  validateTypes: !1,
-  extras: {},
+  namespace: "Testing",
   nodeResolve: {
    customResolveOptions: {}
   },
-  sourceMap: !0,
+  outputTargets: null,
   rollupPlugins: {
    before: [],
    after: []
-  }
+  },
+  rootDir: t,
+  sourceMap: !0,
+  sys: r,
+  testing: null,
+  validateTypes: !1,
+  ...e
  };
 }
 
@@ -817,6 +819,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 +2168,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 ("@stencil/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 "@stencil/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 +2187,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();
@@ -2890,7 +2895,7 @@ const createSystem = e => {
  u("/");
  const S = {
   name: "in-memory",
-  version: "2.17.0",
+  version: "2.17.2",
   events: i,
   access: async e => c(e),
   accessSync: c,
@@ -3262,6 +3267,14 @@ class TestingLogger {
  printDiagnostics(e) {}
 }
 
+const createConfigFlags = (e = {}) => ({
+ task: null,
+ args: [],
+ knownArgs: [],
+ unknownArgs: [],
+ ...e
+});
+
 class EventSpy {
  constructor(e) {
   this.eventName = e, this.events = [], this.cursor = 0, this.queuedHandler = [];
@@ -3647,8 +3660,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);
@@ -3786,9 +3799,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: "",
@@ -3822,7 +3840,18 @@ exports.createJestPuppeteerEnvironment = function createJestPuppeteerEnvironment
  hasVdomText: !1,
  hasVdomXlink: !1,
  ...e
-}), exports.mockWindow = function mockWindow(e = null) {
+}), exports.mockValidatedConfig = function mockValidatedConfig(e = {}) {
+ var t;
+ const r = mockConfig(e);
+ return {
+  ...r,
+  flags: createConfigFlags(),
+  logger: mockLogger(),
+  outputTargets: null !== (t = r.outputTargets) && void 0 !== t ? t : [],
+  sys: createTestingSystem(),
+  ...e
+ };
+}, 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.");
@@ -3925,26 +3954,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 Stencil 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 '@stencil/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 Stencil 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 '@stencil/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,33 @@
-import type { BuildCtx, Cache, CompilerCtx, CompilerSystem, Config, Module } from '@stencil/core/internal';
+import type { BuildCtx, Cache, CompilerCtx, Config, LoadConfigInit, ValidatedConfig, Module, UnvalidatedConfig } from '@stencil/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 Stencil 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 Stencil configuration
+ */
+export declare function mockValidatedConfig(overrides?: Partial<ValidatedConfig>): ValidatedConfig;
+/**
+ * Creates a mock instance of a Stencil 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 Stencil configuration
+ */
+export declare function mockConfig(overrides?: Partial<UnvalidatedConfig>): UnvalidatedConfig;
+/**
+ * Creates a configuration object used to bootstrap a Stencil 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": "@stencil/core/testing",
-  "version": "2.17.0",
+  "version": "2.17.2",
   "description": "Stencil testing suite.",
   "main": "./index.js",
   "types": "./index.d.ts",

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

@@ -1,6 +1,6 @@
-import type { Config } from '@stencil/core/internal';
+import type { ValidatedConfig } from '@stencil/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/test/testing-utils.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/testing/testing-utils.d.ts

@@ -1,6 +1,78 @@
+/// <reference types="jest" />
 import type * as d from '@stencil/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 '@stencil/core/internal';
-export declare const createTesting: (config: Config) => Promise<Testing>;
+import type { ValidatedConfig, Testing } from '@stencil/core/internal';
+export declare const createTesting: (config: ValidatedConfig) => Promise<Testing>;