@rindo/core 3.1.0 → 3.2.0

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

@@ -272,8 +272,17 @@ export interface ConfigExtras {
      * loading components when using a bundler such as Wite or Parcel. Setting this flag to `true` will change how Rindo
      * lazily loads components in a way that works with additional bundlers. Setting this flag to `true` will increase
      * the size of the compiled output. Defaults to `false`.
+     * @deprecated This flag has been deprecated in favor of `enableImportInjection`, which provides the same
+     * functionality. `experimentalImportInjection` will be removed in a future major version of Rindo.
      */
     experimentalImportInjection?: boolean;
+    /**
+     * Projects that use a Rindo library built using the `dist` output target may have trouble lazily
+     * loading components when using a bundler such as Vite or Parcel. Setting this flag to `true` will change how Rindo
+     * lazily loads components in a way that works with additional bundlers. Setting this flag to `true` will increase
+     * the size of the compiled output. Defaults to `false`.
+     */
+    enableImportInjection?: boolean;
     /**
      * Dispatches component lifecycle events. Mainly used for testing. Defaults to `false`.
      */
@@ -1082,7 +1091,23 @@ export interface CompilerSystem {
     statSync(p: string): CompilerFsStats;
     tmpDirSync(): string;
     watchDirectory?(p: string, callback: CompilerFileWatcherCallback, recursive?: boolean): CompilerFileWatcher;
-    watchFile?(p: string, callback: CompilerFileWatcherCallback): CompilerFileWatcher;
+    /**
+     * A `watchFile` implementation in order to hook into the rest of the {@link CompilerSystem} implementation that is
+     * used when running Rindo's compiler in "watch mode".
+     *
+     * It is analogous to TypeScript's `watchFile`  implementation.
+     *
+     * Note, this function may be called for full builds of Rindo projects by the TypeScript compiler. It should not
+     * assume that it will only be called in watch mode.
+     *
+     * This function should not perform any file watcher registration itself. Each `path` provided to it when called
+     * should already have been registered as a file to watch.
+     *
+     * @param path the path to the file that is being watched
+     * @param callback a callback to invoke when a file that is being watched has changed in some way
+     * @returns an object with a method for unhooking the file watcher from the system
+     */
+    watchFile?(path: string, callback: CompilerFileWatcherCallback): CompilerFileWatcher;
     /**
      * How many milliseconds to wait after a change before calling watch callbacks.
      */
@@ -1259,7 +1284,16 @@ export interface CompilerBuildStart {
     buildId: number;
     timestamp: string;
 }
+/**
+ * A type describing a function to call when an event is emitted by a file watcher
+ * @param fileName the path of the file tied to event
+ * @param eventKind a variant describing the type of event that was emitter (added, edited, etc.)
+ */
 export type CompilerFileWatcherCallback = (fileName: string, eventKind: CompilerFileWatcherEvent) => void;
+/**
+ * A type describing the different types of events that Rindo expects may happen when a file being watched is altered
+ * in some way
+ */
 export type CompilerFileWatcherEvent = CompilerEventFileAdd | CompilerEventFileDelete | CompilerEventFileUpdate | CompilerEventDirAdd | CompilerEventDirDelete;
 export type CompilerEventName = CompilerEventFsChange | CompilerEventFileUpdate | CompilerEventFileAdd | CompilerEventFileDelete | CompilerEventDirAdd | CompilerEventDirDelete | CompilerEventBuildStart | CompilerEventBuildFinish | CompilerEventBuildNoChange | CompilerEventBuildLog;
 export type CompilerEventFsChange = 'fsChange';
@@ -1862,6 +1896,12 @@ export interface OutputTargetDocsReadme extends OutputTargetBase {
 export interface OutputTargetDocsJson extends OutputTargetBase {
     type: 'docs-json';
     file: string;
+    /**
+     * Set an optional file path where Rindo should write a `d.ts` file to disk
+     * at build-time containing type declarations for {@link JsonDocs} and related
+     * interfaces. If this is omitted or set to `null` Rindo will not write such
+     * a file.
+     */
     typesFile?: string | null;
     strict?: boolean;
 }
@@ -2180,9 +2220,17 @@ export interface LazyRequire {
     require(fromDir: string, moduleId: string): any;
     getModulePath(fromDir: string, moduleId: string): string;
 }
+/**
+ * @deprecated This interface is no longer used by Rindo
+ * TODO: Remove this interface
+ */
 export interface FsWatcherItem {
     close(): void;
 }
+/**
+ * @deprecated This interface is no longer used by Rindo
+ * TODO: Remove this interface
+ */
 export interface MakeDirectoryOptions {
     /**
      * Indicates whether parent folders should be created.
@@ -2195,6 +2243,10 @@ export interface MakeDirectoryOptions {
      */
     mode?: number;
 }
+/**
+ * @deprecated This interface is no longer used by Rindo
+ * TODO: Remove this interface
+ */
 export interface FsStats {
     isFile(): boolean;
     isDirectory(): boolean;

package/internal/testing/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rindo/core/internal/testing",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "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) v3.1.0 | MIT Licensed | https://rindojs.web.app
+ Rindo Mock Doc (CommonJS) v3.2.0 | MIT Licensed | https://rindojs.web.app
  */
 var mockDoc = (function(exports) {
 'use strict';

package/mock-doc/index.js

@@ -1,5 +1,5 @@
 /*!
- Rindo Mock Doc v3.1.0 | MIT Licensed | https://rindojs.web.app
+ Rindo Mock Doc v3.2.0 | 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": "3.1.0",
+  "version": "3.2.0",
   "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": "3.1.0",
+  "version": "3.2.0",
   "license": "MIT",
   "main": "./internal/rindo-core/index.cjs",
   "module": "./internal/rindo-core/index.js",
@@ -91,7 +91,7 @@
     "jest-cli": "^27.4.5",
     "jest-environment-node": "^27.4.4",
     "listr": "^0.14.3",
-    "magic-string": "^0.29.0",
+    "magic-string": "^0.30.0",
     "merge-source-map": "^1.1.0",
     "mime-db": "^1.46.0",
     "minimatch": "5.1.2",

package/screenshot/package.json

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

package/sys/node/index.js

@@ -1,5 +1,5 @@
 /*!
- Rindo Node System v3.1.0 | MIT Licensed | https://rindojs.web.app
+ Rindo Node System v3.2.0 | MIT Licensed | https://rindojs.web.app
  */
 function _interopDefaultLegacy(e) {
  return e && "object" == typeof e && "default" in e ? e : {
@@ -1282,7 +1282,7 @@ lockfile = createCommonjsModule((function(e) {
    }
   })), function e(t, r) {
    return R.apply(this, arguments);
-  }), z = t.walk = (N = (0, (d || n()).default)((function*(e, t, r = new Set) {
+  }), W = t.walk = (N = (0, (d || n()).default)((function*(e, t, r = new Set) {
    var n, i, o, a;
    let l = [], c = yield ne(e);
    for (r.size && (c = c.filter((function(e) {
@@ -1301,7 +1301,7 @@ lockfile = createCommonjsModule((function(e) {
      basename: c,
      absolute: f,
      mtime: +h.mtime
-    }), h.isDirectory() && (l = l.concat(yield z(f, u, r)));
+    }), h.isDirectory() && (l = l.concat(yield W(f, u, r)));
    }
    return l;
   })), function e(t, r) {
@@ -1313,7 +1313,7 @@ lockfile = createCommonjsModule((function(e) {
   })), function e(t) {
    return I.apply(this, arguments);
   });
-  let W = (P = (0, (d || n()).default)((function*(e) {
+  let z = (P = (0, (d || n()).default)((function*(e) {
    if (!(yield se(e))) return;
    const t = yield J(e);
    for (let e = 0; e < t.length; ++e) {
@@ -1324,7 +1324,7 @@ lockfile = createCommonjsModule((function(e) {
    return P.apply(this, arguments);
   });
   t.writeFilePreservingEol = (j = (0, (d || n()).default)((function*(e, t) {
-   const r = (yield W(e)) || (y || o()).default.EOL;
+   const r = (yield z(e)) || (y || o()).default.EOL;
    "\n" !== r && (t = t.replace(/\n/g, r)), yield ee(e, t);
   })), function e(t, r) {
    return j.apply(this, arguments);
@@ -5992,7 +5992,10 @@ exports.createNodeLogger = e => {
      e = normalizePath(e), n === t.FileWatcherEventKind.Created ? (r(e, "fileAdd"), f.events.emit("fileAdd", e)) : n === t.FileWatcherEventKind.Changed ? (r(e, "fileUpdate"), 
      f.events.emit("fileUpdate", e)) : n === t.FileWatcherEventKind.Deleted && (r(e, "fileDelete"), 
      f.events.emit("fileDelete", e));
-    })), o = () => {
+    }), 250, {
+     watchFile: t.WatchFileKind.FixedPollingInterval,
+     fallbackPolling: t.PollingWatchKind.FixedInterval
+    }), o = () => {
      i.close();
     };
     return f.addDestroy(o), {

package/sys/node/package.json

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

package/sys/node/worker.js

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

package/testing/index.js

@@ -1,5 +1,5 @@
 /*!
- Rindo Testing v3.1.0 | MIT Licensed | https://rindojs.web.app
+ Rindo Testing v3.2.0 | MIT Licensed | https://rindojs.web.app
  */
 function _lazyRequire(e) {
  return new Proxy({}, {
@@ -3154,7 +3154,7 @@ const COMMON_DIR_MODULE_EXTS = [ ".tsx", ".ts", ".mjs", ".js", ".jsx", ".json",
  d("/");
  const D = {
   name: "in-memory",
-  version: "3.1.0",
+  version: "3.2.0",
   events: a,
   access: async e => u(e),
   accessSync: u,

package/testing/jest-preset.js

@@ -31,7 +31,7 @@ module.exports = {
   testPathIgnorePatterns: ['/.cache', '/.rindo', '/.vscode', '/dist', '/node_modules', '/www'],
   testRegex: '(/__tests__/.*|\\.?(test|spec))\\.' + moduleExtensionRegexp + '$',
   transform: {
-    '^.+\\.(ts|tsx|jsx|css)$': path.join(testingDir, 'jest-preprocessor.js'),
+    '^.+\\.(ts|tsx|jsx|css|mjs)$': path.join(testingDir, 'jest-preprocessor.js'),
   },
   watchPathIgnorePatterns: ['^.+\\.d\\.ts$'],
 };

package/testing/package.json

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