@modern-js/core 1.9.1 → 1.9.2

package/dist/types/config/types/ssg.d.ts

@@ -0,0 +1,13 @@
+export declare type SSGRouteOptions = string | {
+  url: string;
+  output?: string;
+  params?: Record<string, any>[];
+  headers?: Record<string, any>;
+};
+export declare type SSGSingleEntryOptions = boolean | {
+  preventDefault?: string[];
+  headers?: Record<string, any>;
+  routes?: SSGRouteOptions[];
+};
+export declare type SSGMultiEntryOptions = Record<string, SSGSingleEntryOptions>;
+export declare type SSGConfig = boolean | SSGSingleEntryOptions | SSGMultiEntryOptions | ((entryName: string) => SSGSingleEntryOptions);

package/dist/types/config/types/test.d.ts

@@ -0,0 +1,15 @@
+import type { Config as JestConfigTypes } from '@jest/types';
+export declare type JestConfig = JestConfigTypes.InitialOptions;
+export interface TestConfig {
+  /**
+   * Decide which transformer will be used to compile file
+   * Default: babel-jest
+   */
+  transformer?: 'babel-jest' | 'ts-jest';
+  /**
+   * Original jest config
+   * Doc: https://jestjs.io/docs/configuration
+   */
+
+  jest?: JestConfig | ((jestConfig: JestConfig) => JestConfig);
+}

package/dist/types/config/types/unbundle.d.ts

@@ -0,0 +1,28 @@
+export declare type UnbundleConfig = {
+  /**
+   * Some package A may require another package B that is intended for Node.js
+   * use only. In such a case, if package B cannot be converted to ESM, it will
+   * cause package A to fail during unbundle development, even though package B
+   * is not really required. Package B can thus be safely ignored via this option
+   * to ensure transpilation of package A to ESM
+   */
+  ignore?: string | string[];
+  /**
+   * ignores cached esm modules and recompiles dependencies not available
+   * from PDN host on dev start.
+   * default: false
+   */
+
+  ignoreModuleCache?: boolean;
+  /**
+   * clears cache of downloaded esm modules (from PDN) on dev start.
+   * default: false
+   */
+
+  clearPdnCache?: boolean;
+  /**
+   * modifies host to attempt to download esm modules from
+   */
+
+  pdnHost?: string;
+};

package/dist/types/context.d.ts

@@ -0,0 +1,47 @@
+import type { IAppContext } from '@modern-js/types';
+import { UserConfig } from './config';
+import { NormalizedConfig } from './config/mergeConfig';
+import type { LoadedPlugin } from './loadPlugins';
+export type { IAppContext };
+export declare const AppContext: import("@modern-js/plugin").Context<IAppContext>;
+export declare const ConfigContext: import("@modern-js/plugin").Context<UserConfig>;
+export declare const ResolvedConfigContext: import("@modern-js/plugin").Context<NormalizedConfig>;
+/**
+ * Set app context.
+ * @param value new app context. It will override previous app context.
+ */
+
+export declare const setAppContext: (value: IAppContext) => void;
+/**
+ * Get app context, including directories, plugins and some static infos.
+ */
+
+export declare const useAppContext: () => IAppContext;
+/**
+ * Get original content of user config.
+ */
+
+export declare const useConfigContext: () => UserConfig;
+/**
+ * Get normalized content of user config.
+ */
+
+export declare const useResolvedConfigContext: () => NormalizedConfig;
+export declare const initAppContext: ({
+  appDirectory,
+  plugins,
+  configFile,
+  options,
+  serverConfigFile
+}: {
+  appDirectory: string;
+  plugins: LoadedPlugin[];
+  configFile: string | false;
+  options?: {
+    metaName?: string | undefined;
+    srcDir?: string | undefined;
+    distDir?: string | undefined;
+    sharedDir?: string | undefined;
+  } | undefined;
+  serverConfigFile: string;
+}) => IAppContext;

package/dist/types/index.d.ts

@@ -0,0 +1,64 @@
+import { INTERNAL_PLUGINS } from '@modern-js/utils';
+import type { Hooks } from '@modern-js/types';
+import { ErrorObject } from 'ajv';
+import { TransformPlugin } from './loadPlugins';
+import { IAppContext, initAppContext } from './context';
+import type { NormalizedConfig } from './config/mergeConfig';
+export type { Hooks };
+export * from './config';
+export * from '@modern-js/plugin';
+export * from '@modern-js/plugin/node';
+export { manager, mountHook, usePlugins, createPlugin, registerHook } from './manager';
+export type { CliHooks, CliPlugin, CliHookCallbacks } from './manager';
+export { AppContext, ConfigContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext } from './pluginAPI';
+export type { PluginAPI } from './pluginAPI';
+export type { NormalizedConfig, IAppContext };
+declare const initAppDir: (cwd?: string | undefined) => Promise<string>;
+export interface CoreOptions {
+  configFile?: string;
+  serverConfigFile?: string;
+  packageJsonConfig?: string;
+  plugins?: typeof INTERNAL_PLUGINS;
+  transformPlugin?: TransformPlugin;
+  onSchemaError?: (error: ErrorObject) => void;
+  options?: {
+    metaName?: string;
+    srcDir?: string;
+    distDir?: string;
+    sharedDir?: string;
+  };
+}
+export declare const mergeOptions: (options?: CoreOptions | undefined) => {
+  configFile?: string | undefined;
+  serverConfigFile: string;
+  packageJsonConfig?: string | undefined;
+  plugins?: {
+    [name: string]: {
+      cli?: string | undefined;
+      server?: string | undefined;
+    };
+  } | undefined;
+  transformPlugin?: TransformPlugin | undefined;
+  onSchemaError?: ((error: ErrorObject) => void) | undefined;
+  options?: {
+    metaName?: string | undefined;
+    srcDir?: string | undefined;
+    distDir?: string | undefined;
+    sharedDir?: string | undefined;
+  } | undefined;
+};
+export declare const cli: {
+  init: (argv?: string[], options?: CoreOptions | undefined) => Promise<{
+    loadedConfig: import("./config").LoadedConfig;
+    appContext: IAppContext;
+    resolved: NormalizedConfig;
+  }>;
+  run: (argv: string[], options?: CoreOptions | undefined) => Promise<void>;
+  restart: () => Promise<void>;
+};
+export { initAppDir, initAppContext };
+declare module '@modern-js/utils/compiled/commander' {
+  interface Command {
+    commandsMap: Map<string, Command>;
+  }
+}

package/dist/types/initWatcher.d.ts

@@ -0,0 +1,3 @@
+import { LoadedConfig } from './config';
+import { HooksRunner } from './manager';
+export declare const initWatcher: (loaded: LoadedConfig, appDirectory: string, configDir: string | undefined, hooksRunner: HooksRunner, argv: string[]) => Promise<import("@modern-js/utils").FSWatcher | undefined>;

package/dist/types/loadEnv.d.ts

@@ -0,0 +1 @@
+export declare const loadEnv: (appDirectory: string, mode?: string) => void;

package/dist/types/loadPlugins.d.ts

@@ -0,0 +1,44 @@
+import { INTERNAL_PLUGINS } from '@modern-js/utils';
+import type { UserConfig } from './config';
+import { CliPlugin } from './manager';
+declare type PluginItem = string | [string, any];
+export declare type LoadedPlugin = {
+  cli?: CliPlugin;
+  server?: string;
+  serverPkg?: string;
+};
+export declare type TransformPlugin = (plugin: PluginConfig, resolvedConfig: UserConfig, pluginOptions?: any) => PluginConfig;
+/**
+ * @deprecated
+ * Using NewPluginConfig insteand.
+ */
+
+declare type OldPluginConfig = Array<PluginItem | {
+  cli?: PluginItem;
+  server?: PluginItem;
+}>;
+declare type NewPluginConfig = CliPlugin[] | {
+  cli?: CliPlugin[];
+  /** Custom server plugin is not supported yet. */
+
+  server?: never;
+};
+export declare type PluginConfig = OldPluginConfig | NewPluginConfig;
+export declare function getAppPlugins(appDirectory: string, oldPluginConfig: OldPluginConfig, internalPlugins?: typeof INTERNAL_PLUGINS): (PluginItem | {
+  cli?: PluginItem | undefined;
+  server?: PluginItem | undefined;
+})[];
+/**
+ * Load internal plugins which in @modern-js scope and user's custom plugins.
+ * @param appDirectory - Application root directory.
+ * @param userConfig - Resolved user config.
+ * @param options.internalPlugins - Internal plugins.
+ * @param options.transformPlugin - transform plugin before using it. Used for compatible with legacy jupiter plugins.
+ * @returns Plugin Objects has been required.
+ */
+
+export declare const loadPlugins: (appDirectory: string, userConfig: UserConfig, options?: {
+  internalPlugins?: typeof INTERNAL_PLUGINS;
+  transformPlugin?: TransformPlugin;
+}) => LoadedPlugin[];
+export {};

package/dist/types/manager.d.ts

@@ -0,0 +1,75 @@
+import { ToThreads, ToRunners, AsyncSetup, PluginOptions, AsyncWorkflow, AsyncWaterfall, ParallelWorkflow } from '@modern-js/plugin';
+import type { Hooks } from '@modern-js/types';
+import type { Command } from './utils/commander';
+import type { NormalizedConfig } from './config/mergeConfig';
+import type { UserConfig } from './config';
+import { pluginAPI } from './pluginAPI';
+export declare type HooksRunner = ToRunners<{
+  config: ParallelWorkflow<void, UserConfig>;
+  resolvedConfig: AsyncWaterfall<{
+    resolved: NormalizedConfig;
+  }>;
+  validateSchema: ParallelWorkflow<void>;
+  prepare: AsyncWorkflow<void, void>;
+  commands: AsyncWorkflow<{
+    program: Command;
+  }, void>;
+  watchFiles: ParallelWorkflow<void>;
+  fileChange: AsyncWorkflow<{
+    filename: string;
+    eventType: 'add' | 'change' | 'unlink';
+  }, void>;
+  beforeExit: AsyncWorkflow<void, void>;
+  beforeRestart: AsyncWorkflow<void, void>;
+}>;
+declare const baseHooks: {
+  config: ParallelWorkflow<void, UserConfig>;
+  resolvedConfig: AsyncWaterfall<{
+    resolved: NormalizedConfig;
+  }>;
+  validateSchema: ParallelWorkflow<void, unknown>;
+  prepare: AsyncWorkflow<void, void>;
+  commands: AsyncWorkflow<{
+    program: Command;
+  }, void>;
+  watchFiles: ParallelWorkflow<void, unknown>;
+  fileChange: AsyncWorkflow<{
+    filename: string;
+    eventType: 'add' | 'change' | 'unlink';
+  }, void>;
+  beforeExit: AsyncWorkflow<void, void>;
+  beforeRestart: AsyncWorkflow<void, void>;
+};
+/** All hooks of cli plugin. */
+
+export declare type CliHooks = typeof baseHooks & Hooks;
+/** All hook callbacks of cli plugin. */
+
+export declare type CliHookCallbacks = ToThreads<CliHooks>;
+export declare const manager: import("@modern-js/plugin").AsyncManager<CliHooks, {
+  setAppContext: (value: import("@modern-js/types").IAppContext) => void;
+  useAppContext: () => import("@modern-js/types").IAppContext;
+  useConfigContext: () => UserConfig;
+  useResolvedConfigContext: () => NormalizedConfig;
+}>;
+/** Plugin options of a cli plugin. */
+
+export declare type CliPlugin = PluginOptions<CliHooks, AsyncSetup<CliHooks, typeof pluginAPI>>;
+export declare const createPlugin: (setup?: AsyncSetup<CliHooks, {
+  setAppContext: (value: import("@modern-js/types").IAppContext) => void;
+  useAppContext: () => import("@modern-js/types").IAppContext;
+  useConfigContext: () => UserConfig;
+  useResolvedConfigContext: () => NormalizedConfig;
+}> | undefined, options?: PluginOptions<CliHooks, AsyncSetup<CliHooks, {
+  setAppContext: (value: import("@modern-js/types").IAppContext) => void;
+  useAppContext: () => import("@modern-js/types").IAppContext;
+  useConfigContext: () => UserConfig;
+  useResolvedConfigContext: () => NormalizedConfig;
+}>> | undefined) => import("@modern-js/plugin").AsyncPlugin<CliHooks, {
+  setAppContext: (value: import("@modern-js/types").IAppContext) => void;
+  useAppContext: () => import("@modern-js/types").IAppContext;
+  useConfigContext: () => UserConfig;
+  useResolvedConfigContext: () => NormalizedConfig;
+}>, registerHook: (newHooks: Partial<CliHooks>) => void, mountHook: () => ToRunners<CliHooks>;
+export declare const usePlugins: (plugins: string[]) => void;
+export {};

package/dist/types/pluginAPI.d.ts

@@ -0,0 +1,13 @@
+import type { CommonAPI } from '@modern-js/plugin';
+import type { CliHooks } from './manager';
+import { AppContext, ConfigContext, useAppContext, useConfigContext, ResolvedConfigContext, useResolvedConfigContext } from './context';
+export declare const pluginAPI: {
+  setAppContext: (value: import("@modern-js/types/cli").IAppContext) => void;
+  useAppContext: () => import("@modern-js/types/cli").IAppContext;
+  useConfigContext: () => import("./config").UserConfig;
+  useResolvedConfigContext: () => import(".").NormalizedConfig;
+};
+/** all apis for cli plugin */
+
+export declare type PluginAPI = typeof pluginAPI & CommonAPI<CliHooks>;
+export { AppContext, ConfigContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext };

package/dist/types/utils/commander.d.ts

@@ -0,0 +1,4 @@
+import { program, Command } from '@modern-js/utils';
+export declare function initCommandsMap(): void;
+export type { Command };
+export { program };

package/dist/types/utils/repeatKeyWarning.d.ts

@@ -0,0 +1,3 @@
+import { UserConfig } from '../config';
+export declare const deepGet: (obj: any, key: string) => any;
+export declare const repeatKeyWarning: (schema: any, jsConfig: UserConfig, pkgConfig: UserConfig) => void;

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.9.1",
+  "version": "1.9.2",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -69,13 +69,13 @@
   "sideEffects": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "types": "./dist/index.d.ts"
   },
   "scripts": {
     "new": "modern new",
     "build": "tsc",
     "dev": "tsc --watch",
     "test": "jest"
-  },
-  "readme": "\n<p align=\"center\">\n  <a href=\"https://modernjs.dev\" target=\"blank\"><img src=\"https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png\" width=\"300\" alt=\"Modern.js Logo\" /></a>\n</p>\n<p align=\"center\">\n现代 Web 工程体系\n  <br/>\n  <a href=\"https://modernjs.dev\" target=\"blank\">\n    modernjs.dev\n  </a>\n</p>\n<p align=\"center\">\n  The meta-framework suite designed from scratch for frontend-focused modern web development\n</p>\n\n# Introduction\n\n> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.\n\n- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)\n\n## Getting Started\n\n- [Quick Start](https://modernjs.dev/docs/start)\n- [Guides](https://modernjs.dev/docs/guides)\n- [API References](https://modernjs.dev/docs/apis)\n\n## Contributing\n\n- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)\n"
+  }
 }