@modern-js/utils 2.12.1-alpha.0 → 2.12.1-alpha.2

package/dist/types/compiled/webpack-dev-middleware/types/index.d.ts

@@ -0,0 +1,262 @@
+/// <reference types="node" />
+/// <reference types="node" />
+export = wdm;
+/** @typedef {import('../schema-utils3/declarations/validate').Schema} Schema */
+/** @typedef {import('webpack').Compiler} Compiler */
+/** @typedef {import('webpack').MultiCompiler} MultiCompiler */
+/** @typedef {import('webpack').Configuration} Configuration */
+/** @typedef {import('webpack').Stats} Stats */
+/** @typedef {import('webpack').MultiStats} MultiStats */
+/**
+ * @typedef {Object} ExtendedServerResponse
+ * @property {{ webpack?: { devMiddleware?: Context<IncomingMessage, ServerResponse> } }} [locals]
+ */
+/** @typedef {import('http').IncomingMessage} IncomingMessage */
+/** @typedef {import('http').ServerResponse & ExtendedServerResponse} ServerResponse */
+/**
+ * @callback NextFunction
+ * @param {any} [err]
+ * @return {void}
+ */
+/**
+ * @typedef {NonNullable<Configuration["watchOptions"]>} WatchOptions
+ */
+/**
+ * @typedef {Compiler["watching"]} Watching
+ */
+/**
+ * @typedef {ReturnType<Compiler["watch"]>} MultiWatching
+ */
+/**
+ * @typedef {Compiler["outputFileSystem"] & { createReadStream?: import('fs').createReadStream, statSync?: import('fs').statSync, lstat?: import('fs').lstat, readFileSync?: import('fs').readFileSync }} OutputFileSystem
+ */
+/** @typedef {ReturnType<Compiler["getInfrastructureLogger"]>} Logger */
+/**
+ * @callback Callback
+ * @param {Stats | MultiStats} [stats]
+ */
+/**
+ * @template {IncomingMessage} RequestInternal
+ * @template {ServerResponse} ResponseInternal
+ * @typedef {Object} Context
+ * @property {boolean} state
+ * @property {Stats | MultiStats | undefined} stats
+ * @property {Callback[]} callbacks
+ * @property {Options<RequestInternal, ResponseInternal>} options
+ * @property {Compiler | MultiCompiler} compiler
+ * @property {Watching | MultiWatching} watching
+ * @property {Logger} logger
+ * @property {OutputFileSystem} outputFileSystem
+ */
+/**
+ * @template {IncomingMessage} RequestInternal
+ * @template {ServerResponse} ResponseInternal
+ * @typedef {Record<string, string | number> | Array<{ key: string, value: number | string }> | ((req: RequestInternal, res: ResponseInternal, context: Context<RequestInternal, ResponseInternal>) =>  void | undefined | Record<string, string | number>) | undefined} Headers
+ */
+/**
+ * @template {IncomingMessage} RequestInternal
+ * @template {ServerResponse} ResponseInternal
+ * @typedef {Object} Options
+ * @property {{[key: string]: string}} [mimeTypes]
+ * @property {boolean | ((targetPath: string) => boolean)} [writeToDisk]
+ * @property {string} [methods]
+ * @property {Headers<RequestInternal, ResponseInternal>} [headers]
+ * @property {NonNullable<Configuration["output"]>["publicPath"]} [publicPath]
+ * @property {Configuration["stats"]} [stats]
+ * @property {boolean} [serverSideRender]
+ * @property {OutputFileSystem} [outputFileSystem]
+ * @property {boolean | string} [index]
+ */
+/**
+ * @template {IncomingMessage} RequestInternal
+ * @template {ServerResponse} ResponseInternal
+ * @callback Middleware
+ * @param {RequestInternal} req
+ * @param {ResponseInternal} res
+ * @param {NextFunction} next
+ * @return {Promise<void>}
+ */
+/**
+ * @callback GetFilenameFromUrl
+ * @param {string} url
+ * @returns {string | undefined}
+ */
+/**
+ * @callback WaitUntilValid
+ * @param {Callback} callback
+ */
+/**
+ * @callback Invalidate
+ * @param {Callback} callback
+ */
+/**
+ * @callback Close
+ * @param {(err: Error | null | undefined) => void} callback
+ */
+/**
+ * @template {IncomingMessage} RequestInternal
+ * @template {ServerResponse} ResponseInternal
+ * @typedef {Object} AdditionalMethods
+ * @property {GetFilenameFromUrl} getFilenameFromUrl
+ * @property {WaitUntilValid} waitUntilValid
+ * @property {Invalidate} invalidate
+ * @property {Close} close
+ * @property {Context<RequestInternal, ResponseInternal>} context
+ */
+/**
+ * @template {IncomingMessage} RequestInternal
+ * @template {ServerResponse} ResponseInternal
+ * @typedef {Middleware<RequestInternal, ResponseInternal> & AdditionalMethods<RequestInternal, ResponseInternal>} API
+ */
+/**
+ * @template {IncomingMessage} RequestInternal
+ * @template {ServerResponse} ResponseInternal
+ * @param {Compiler | MultiCompiler} compiler
+ * @param {Options<RequestInternal, ResponseInternal>} [options]
+ * @returns {API<RequestInternal, ResponseInternal>}
+ */
+declare function wdm<
+  RequestInternal extends import('http').IncomingMessage,
+  ResponseInternal extends ServerResponse
+>(
+  compiler: Compiler | MultiCompiler,
+  options?: Options<RequestInternal, ResponseInternal> | undefined
+): API<RequestInternal, ResponseInternal>;
+declare namespace wdm {
+  export {
+    Schema,
+    Compiler,
+    MultiCompiler,
+    Configuration,
+    Stats,
+    MultiStats,
+    ExtendedServerResponse,
+    IncomingMessage,
+    ServerResponse,
+    NextFunction,
+    WatchOptions,
+    Watching,
+    MultiWatching,
+    OutputFileSystem,
+    Logger,
+    Callback,
+    Context,
+    Headers,
+    Options,
+    Middleware,
+    GetFilenameFromUrl,
+    WaitUntilValid,
+    Invalidate,
+    Close,
+    AdditionalMethods,
+    API,
+  };
+}
+type ServerResponse = import('http').ServerResponse & ExtendedServerResponse;
+type Compiler = import('webpack').Compiler;
+type MultiCompiler = import('webpack').MultiCompiler;
+type Options<
+  RequestInternal extends import('http').IncomingMessage,
+  ResponseInternal extends ServerResponse
+> = {
+  mimeTypes?:
+    | {
+        [key: string]: string;
+      }
+    | undefined;
+  writeToDisk?: boolean | ((targetPath: string) => boolean) | undefined;
+  methods?: string | undefined;
+  headers?: Headers<RequestInternal, ResponseInternal>;
+  publicPath?: NonNullable<Configuration["output"]>["publicPath"];
+  stats?: Configuration["stats"];
+  serverSideRender?: boolean | undefined;
+  outputFileSystem?: OutputFileSystem | undefined;
+  index?: string | boolean | undefined;
+};
+type API<
+  RequestInternal extends import('http').IncomingMessage,
+  ResponseInternal extends ServerResponse
+> = Middleware<RequestInternal, ResponseInternal> &
+  AdditionalMethods<RequestInternal, ResponseInternal>;
+type Schema = import('../schema-utils3/declarations/validate').Schema;
+type Configuration = import('webpack').Configuration;
+type Stats = import('webpack').Stats;
+type MultiStats = import('webpack').MultiStats;
+type ExtendedServerResponse = {
+  locals?:
+    | {
+        webpack?:
+          | {
+              devMiddleware?:
+                | Context<import('http').IncomingMessage, ServerResponse>
+                | undefined;
+            }
+          | undefined;
+      }
+    | undefined;
+};
+type IncomingMessage = import('http').IncomingMessage;
+type NextFunction = (err?: any) => void;
+type WatchOptions = NonNullable<Configuration["watchOptions"]>;
+type Watching = Compiler["watching"];
+type MultiWatching = ReturnType<Compiler["watch"]>;
+type OutputFileSystem = Compiler["outputFileSystem"] & {
+  createReadStream?: typeof import('fs').createReadStream;
+  statSync?: import('fs').StatSyncFn;
+  lstat?: typeof import('fs').lstat;
+  readFileSync?: typeof import('fs').readFileSync;
+};
+type Logger = ReturnType<Compiler["getInfrastructureLogger"]>;
+type Callback = (
+  stats?: import('webpack').Stats | import('webpack').MultiStats | undefined
+) => any;
+type Context<
+  RequestInternal extends import('http').IncomingMessage,
+  ResponseInternal extends ServerResponse
+> = {
+  state: boolean;
+  stats: Stats | MultiStats | undefined;
+  callbacks: Callback[];
+  options: Options<RequestInternal, ResponseInternal>;
+  compiler: Compiler | MultiCompiler;
+  watching: Watching | MultiWatching;
+  logger: Logger;
+  outputFileSystem: OutputFileSystem;
+};
+type Headers<
+  RequestInternal extends import('http').IncomingMessage,
+  ResponseInternal extends ServerResponse
+> =
+  | Record<string, string | number>
+  | {
+      key: string;
+      value: number | string;
+    }[]
+  | ((
+      req: RequestInternal,
+      res: ResponseInternal,
+      context: Context<RequestInternal, ResponseInternal>
+    ) => void | undefined | Record<string, string | number>)
+  | undefined;
+type Middleware<
+  RequestInternal extends import('http').IncomingMessage,
+  ResponseInternal extends ServerResponse
+> = (
+  req: RequestInternal,
+  res: ResponseInternal,
+  next: NextFunction
+) => Promise<void>;
+type GetFilenameFromUrl = (url: string) => string | undefined;
+type WaitUntilValid = (callback: Callback) => any;
+type Invalidate = (callback: Callback) => any;
+type Close = (callback: (err: Error | null | undefined) => void) => any;
+type AdditionalMethods<
+  RequestInternal extends import('http').IncomingMessage,
+  ResponseInternal extends ServerResponse
+> = {
+  getFilenameFromUrl: GetFilenameFromUrl;
+  waitUntilValid: WaitUntilValid;
+  invalidate: Invalidate;
+  close: Close;
+  context: Context<RequestInternal, ResponseInternal>;
+};

package/dist/types/compiled.d.ts

@@ -1,43 +1,43 @@
-export { default as fs } from '../compiled/fs-extra';
-export { default as ora } from '../compiled/ora';
-export { default as glob } from '../compiled/glob';
-export { default as yaml } from '../compiled/js-yaml';
-export { default as chalk } from '../compiled/chalk';
-export { default as debug } from '../compiled/debug';
-export { default as slash } from '../compiled/slash';
-export { default as execa } from '../compiled/execa';
-export { default as json5 } from '../compiled/json5';
-export { default as upath } from '../compiled/upath';
-export { default as pkgUp } from '../compiled/pkg-up';
-export { nanoid } from '../compiled/nanoid';
-export { default as semver } from '../compiled/semver';
-export { default as dotenv } from '../compiled/dotenv';
-export { default as lodash } from '../compiled/lodash';
-export { default as globby } from '../compiled/globby';
-export { default as address } from '../compiled/address';
-export { default as signale } from '../compiled/signale';
-export { default as urlJoin } from '../compiled/url-join';
-export { default as minimist } from '../compiled/minimist';
-export { default as fastGlob } from '../compiled/fast-glob';
-export { default as filesize } from '../compiled/filesize';
-export { default as gzipSize } from '../compiled/gzip-size';
-export { default as stripAnsi } from '../compiled/strip-ansi';
-export { default as dotenvExpand } from '../compiled/dotenv-expand';
-export { default as browserslist } from '../compiled/browserslist';
-export { default as recursiveReaddir } from '../compiled/recursive-readdir';
-export { program, Command } from '../compiled/commander';
-export { Signale } from '../compiled/signale';
-export type { SignaleOptions } from '../compiled/signale';
-export type { IOptions as GlobOptions } from '../compiled/glob';
-export type { GlobbyOptions } from '../compiled/globby';
-export type { FSWatcher, WatchOptions } from '../compiled/chokidar';
-export type { ExecaError } from '../compiled/execa';
-export type { default as WebpackChain } from '../compiled/webpack-chain';
+export { default as fs } from '@compiled/fs-extra';
+export { default as ora } from '@compiled/ora';
+export { default as glob } from '@compiled/glob';
+export { default as yaml } from '@compiled/js-yaml';
+export { default as chalk } from '@compiled/chalk';
+export { default as debug } from '@compiled/debug';
+export { default as slash } from '@compiled/slash';
+export { default as execa } from '@compiled/execa';
+export { default as json5 } from '@compiled/json5';
+export { default as upath } from '@compiled/upath';
+export { default as pkgUp } from '@compiled/pkg-up';
+export { nanoid } from '@compiled/nanoid';
+export { default as semver } from '@compiled/semver';
+export { default as dotenv } from '@compiled/dotenv';
+export { default as lodash } from '@compiled/lodash';
+export { default as globby } from '@compiled/globby';
+export { default as address } from '@compiled/address';
+export { default as signale } from '@compiled/signale';
+export { default as urlJoin } from '@compiled/url-join';
+export { default as minimist } from '@compiled/minimist';
+export { default as fastGlob } from '@compiled/fast-glob';
+export { default as filesize } from '@compiled/filesize';
+export { default as gzipSize } from '@compiled/gzip-size';
+export { default as stripAnsi } from '@compiled/strip-ansi';
+export { default as dotenvExpand } from '@compiled/dotenv-expand';
+export { default as browserslist } from '@compiled/browserslist';
+export { default as recursiveReaddir } from '@compiled/recursive-readdir';
+export { program, Command } from '@compiled/commander';
+export { Signale } from '@compiled/signale';
+export type { SignaleOptions } from '@compiled/signale';
+export type { IOptions as GlobOptions } from '@compiled/glob';
+export type { GlobbyOptions } from '@compiled/globby';
+export type { FSWatcher, WatchOptions } from '@compiled/chokidar';
+export type { ExecaError } from '@compiled/execa';
+export type { default as WebpackChain } from '@compiled/webpack-chain';
 /**
  * Lazy import some expensive modules that will slow down startup speed.
  * Notice that `csmith-tools build` can not bundle lazy imported modules.
  */
 
-export declare const mime: typeof import('../compiled/mime-types');
-export declare const chokidar: typeof import('../compiled/chokidar');
-export declare const inquirer: typeof import('../compiled/inquirer');
+export declare const mime: typeof import('@compiled/mime-types');
+export declare const chokidar: typeof import('@compiled/chokidar');
+export declare const inquirer: typeof import('@compiled/inquirer');

package/dist/types/debug.d.ts

@@ -3,4 +3,4 @@
  * @param scope - Custom module name of your debug function.
  * @returns Debug function which namespace start with modern-js:.
  */
-export declare const createDebugger: (scope: string) => import("../compiled/debug").Debugger;
+export declare const createDebugger: (scope: string) => import("@compiled/debug").Debugger;

package/dist/types/logger.d.ts

@@ -1,4 +1,4 @@
-import { Color } from '../compiled/chalk';
+import { Color } from '@compiled/chalk';
 type LogLevel = 'debug' | 'info' | 'warn' | 'error';
 type LogMsg = number | string | Error | null;
 interface LoggerConfiguration {

package/package.json

@@ -11,19 +11,33 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.12.1-alpha.0",
+  "version": "2.12.1-alpha.2",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "_comment": "Provide ESM and CJS exports, ESM is used by runtime package, for treeshaking",
   "exports": {
-    ".": "./dist/index.js",
-    "./ssr": "./dist/ssr.js",
-    "./babel": "./dist/babel.js",
-    "./logger": "./dist/logger.js",
-    "./chain-id": "./dist/chainId.js",
-    "./constants": "./dist/constants.js",
+    ".": {
+      "import": "./dist/esm/index.js",
+      "default": "./dist/cjs/index.js"
+    },
+    "./ssr": {
+      "import": "./dist/esm/ssr.js",
+      "default": "./dist/cjs/ssr.js"
+    },
+    "./logger": {
+      "import": "./dist/esm/logger.js",
+      "default": "./dist/cjs/logger.js"
+    },
+    "./constants": {
+      "import": "./dist/esm/constants.js",
+      "default": "./dist/cjs/constants.js"
+    },
+    "./babel": {
+      "import": "./dist/esm/babel.js",
+      "default": "./dist/cjs/babel.js"
+    },
     "./ajv": "./compiled/ajv/index.js",
     "./glob": "./compiled/glob/index.js",
     "./chalk": "./compiled/chalk/index.js",
@@ -42,11 +56,29 @@
     "./tsconfig-paths": "./compiled/tsconfig-paths/index.js",
     "./better-ajv-errors": "./compiled/better-ajv-errors/index.js",
     "./webpack-dev-middleware": "./compiled/webpack-dev-middleware/index.js",
-    "./universal/constants": "./dist/universal/constants.js",
-    "./universal/serialize": "./dist/universal/serialize.js",
-    "./universal/remix-router": "./dist/universal/remixRouter.js",
-    "./universal/format-webpack": "./dist/universal/formatWebpack.js",
-    "./universal/nestedRoutes": "./dist/universal/nestedRoutes.js"
+    "./chain-id": {
+      "default": "./dist/cjs/chainId.js"
+    },
+    "./universal/constants": {
+      "import": "./dist/esm/universal/constants.js",
+      "default": "./dist/cjs/universal/constants.js"
+    },
+    "./universal/serialize": {
+      "import": "./dist/esm/universal/serialize.js",
+      "default": "./dist/cjs/universal/serialize.js"
+    },
+    "./universal/remix-router": {
+      "import": "./dist/esm/universal/remixRouter.js",
+      "default": "./dist/cjs/universal/remixRouter.js"
+    },
+    "./universal/format-webpack": {
+      "import": "./dist/esm/universal/formatWebpack.js",
+      "default": "./dist/cjs/universal/formatWebpack.js"
+    },
+    "./universal/nestedRoutes": {
+      "import": "./dist/esm/universal/nestedRoutes.js",
+      "default": "./dist/cjs/universal/nestedRoutes.js"
+    }
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -144,10 +176,10 @@
     }
   },
   "dependencies": {
+    "@remix-run/router": "^1.3.2",
     "caniuse-lite": "^1.0.30001451",
     "lodash": "^4.17.21",
-    "serialize-javascript": "^6.0.0",
-    "@remix-run/router": "^1.3.2"
+    "serialize-javascript": "^6.0.0"
   },
   "peerDependencies": {
     "react": ">=17.0.0",
@@ -166,24 +198,24 @@
     }
   },
   "devDependencies": {
-    "react": ">=17.0.0",
-    "react-dom": ">=17.0.0",
-    "react-router-dom": "^6.8.1",
+    "@modern-js/module-tools": "^2.12.0",
     "@types/jest": "^29",
     "@types/node": "^14",
+    "@types/serialize-javascript": "^5.0.1",
     "jest": "^29",
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0",
+    "react-router-dom": "^6.8.1",
     "typescript": "^4",
     "webpack": "^5.76.2",
-    "@types/serialize-javascript": "^5.0.1",
-    "@scripts/build": "2.12.0",
     "@modern-js/types": "2.12.0",
     "@scripts/jest-config": "2.12.0"
   },
   "sideEffects": false,
   "scripts": {
     "new": "modern-lib new",
-    "dev": "modern-lib build --watch",
-    "build": "modern-lib build",
+    "dev": "modern build --watch",
+    "build": "modern build",
     "test": "jest --passWithNoTests"
   }
 }