egg 4.0.10 → 4.1.0-beta.11

package/dist/lib/loader/index.d.ts

@@ -0,0 +1,4 @@
+import { EggApplicationLoader } from "./EggApplicationLoader.js";
+import { AppWorkerLoader } from "./AppWorkerLoader.js";
+import { AgentWorkerLoader } from "./AgentWorkerLoader.js";
+export { AgentWorkerLoader, AppWorkerLoader, EggApplicationLoader };

package/dist/lib/loader/index.js

@@ -0,0 +1,5 @@
+import { EggApplicationLoader } from "./EggApplicationLoader.js";
+import { AppWorkerLoader } from "./AppWorkerLoader.js";
+import { AgentWorkerLoader } from "./AgentWorkerLoader.js";
+
+export { AgentWorkerLoader, AppWorkerLoader, EggApplicationLoader };

package/dist/lib/start.d.ts

@@ -0,0 +1,28 @@
+import { Agent } from "./agent.js";
+import { Application } from "./application.js";
+import { EggPlugin } from "./types.js";
+
+//#region src/lib/start.d.ts
+interface StartEggOptions {
+  /** specify framework that can be absolute path or npm package */
+  framework?: string;
+  /** directory of application, default to `process.cwd()` */
+  baseDir?: string;
+  /** ignore single process mode warning */
+  ignoreWarning?: boolean;
+  mode?: 'single';
+  env?: string;
+  plugins?: EggPlugin;
+}
+interface SingleModeApplication extends Application {
+  agent: SingleModeAgent;
+}
+interface SingleModeAgent extends Agent {
+  app: SingleModeApplication;
+}
+/**
+ * Start egg with single process
+ */
+declare function startEgg(options?: StartEggOptions): Promise<SingleModeApplication>;
+//#endregion
+export { SingleModeAgent, SingleModeApplication, StartEggOptions, startEgg };

package/dist/lib/start.js

@@ -0,0 +1,36 @@
+import { Agent } from "./agent.js";
+import { Application } from "./application.js";
+import "./types.js";
+import path from "node:path";
+import { readJSON } from "utility";
+import { importModule } from "@eggjs/utils";
+
+//#region src/lib/start.ts
+/**
+* Start egg with single process
+*/
+async function startEgg(options = {}) {
+	options.baseDir = options.baseDir ?? process.cwd();
+	options.mode = "single";
+	if (!options.framework) try {
+		options.framework = (await readJSON(path.join(options.baseDir, "package.json"))).egg.framework;
+	} catch {}
+	let AgentClass = Agent;
+	let ApplicationClass = Application;
+	if (options.framework) {
+		const framework = await importModule(options.framework, { paths: [options.baseDir] });
+		AgentClass = framework.Agent;
+		ApplicationClass = framework.Application;
+	}
+	const agent = new AgentClass({ ...options });
+	await agent.ready();
+	const application = new ApplicationClass({ ...options });
+	application.agent = agent;
+	agent.application = application;
+	await application.ready();
+	application.messenger.broadcast("egg-ready");
+	return application;
+}
+
+//#endregion
+export { startEgg };

package/{src/lib/types.ts → dist/lib/types.d.ts}

@@ -1,53 +1,40 @@
-import type { Socket } from 'node:net';
-import type {
-  RequestOptions as HttpClientRequestOptions,
-} from 'urllib';
-import type {
-  EggLoggerOptions, EggLoggersOptions,
-} from 'egg-logger';
-import type {
-  FileLoaderOptions,
-  EggAppConfig as EggCoreAppConfig,
-} from '@eggjs/core';
-import type {
-  EggApplicationCore, Context,
-} from './egg.js';
-import type { MetaMiddlewareOptions } from '../app/middleware/meta.js';
-import type { NotFoundMiddlewareOptions } from '../app/middleware/notfound.js';
-import type { SiteFileMiddlewareOptions } from '../app/middleware/site_file.js';
-
-// import plugins types
-import '@eggjs/watcher';
-import '@eggjs/development';
-import '@eggjs/jsonp';
-import '@eggjs/i18n';
-import '@eggjs/static';
-import '@eggjs/security';
-import '@eggjs/schedule';
-import '@eggjs/session';
-import '@eggjs/onerror';
-import '@eggjs/logrotator';
-import '@eggjs/multipart';
-import '@eggjs/view';
-
-export type {
-  EggAppInfo,
-} from '@eggjs/core';
-
-type IgnoreItem = string | RegExp | ((ctx: Context) => boolean);
+import Context$1 from "../app/extend/context.js";
+import { MetaMiddlewareOptions } from "../app/middleware/meta.js";
+import { NotFoundMiddlewareOptions } from "../app/middleware/notfound.js";
+import { SiteFileMiddlewareOptions } from "../app/middleware/site_file.js";
+import { EggApplicationCore } from "./egg.js";
+import { EggAppConfig as EggAppConfig$1, EggAppInfo, FileLoaderOptions } from "@eggjs/core";
+import { EggLoggerOptions, EggLoggersOptions } from "egg-logger";
+import { RequestOptions } from "urllib";
+import { Socket } from "node:net";
+import "@eggjs/watcher";
+import "@eggjs/development";
+import "@eggjs/jsonp";
+import "@eggjs/i18n";
+import "@eggjs/static";
+import "@eggjs/security";
+import "@eggjs/schedule";
+import "@eggjs/session";
+import "@eggjs/onerror";
+import "@eggjs/logrotator";
+import "@eggjs/multipart";
+import "@eggjs/view";
+import { PartialDeep } from "type-fest";
+
+//#region src/lib/types.d.ts
+type IgnoreItem = string | RegExp | ((ctx: Context$1) => boolean);
 type IgnoreOrMatch = IgnoreItem | IgnoreItem[];
-
-export interface ClientErrorResponse {
+interface ClientErrorResponse {
   body: string | Buffer;
   status: number;
-  headers: { [key: string]: string };
+  headers: {
+    [key: string]: string;
+  };
 }
-
 /** egg env type */
-export type EggEnvType = 'local' | 'unittest' | 'prod' | string;
-
+type EggEnvType = 'local' | 'unittest' | 'prod' | string;
 /** logger config of egg */
-export interface EggLoggerConfig extends Omit<EggLoggersOptions, 'type'> {
+interface EggLoggerConfig extends Omit<EggLoggersOptions, 'type'> {
   /** custom config of coreLogger */
   coreLogger?: Partial<EggLoggerOptions>;
   /** allow debug log at prod, defaults to `false` */
@@ -59,9 +46,8 @@ export interface EggLoggerConfig extends Omit<EggLoggersOptions, 'type'> {
   /** using the app logger instead of EggContextLogger, defaults to `false` */
   enableFastContextLogger?: boolean;
 }
-
 /** Custom Loader Configuration */
-export interface CustomLoaderConfig extends Omit<FileLoaderOptions, 'inject' | 'target'> {
+interface CustomLoaderConfig extends Omit<FileLoaderOptions, 'inject' | 'target'> {
   /**
    * an object you wanner load to, value can only be 'ctx' or 'app'. default to app
    */
@@ -71,12 +57,11 @@ export interface CustomLoaderConfig extends Omit<FileLoaderOptions, 'inject' | '
    */
   loadunit?: boolean;
 }
-
-export interface HttpClientConfig {
+interface HttpClientConfig {
   /** Request timeout */
   timeout?: number;
   /** Default request args for httpclient */
-  request?: HttpClientRequestOptions;
+  request?: RequestOptions;
   /**
    * @deprecated keep compatible with egg 3.x, no more used
    */
@@ -86,7 +71,6 @@ export interface HttpClientConfig {
    */
   allowH2?: boolean;
 }
-
 /**
  * Powerful Partial, Support adding ? modifier to a mapped property in deep level
  * @example
@@ -94,19 +78,40 @@ export interface HttpClientConfig {
  *
  * // { view: { defaultEngines: string } } => { view?: { defaultEngines?: string } }
  * type EggConfig = PowerPartial<EggAppConfig>
+ *
+ * @deprecated use `PartialDeep` instead
  */
-export type PowerPartial<T> = {
-  [U in keyof T]?: T[U] extends object
-    ? PowerPartial<T[U]>
-    : T[U]
-};
-
-export interface EggAppConfig extends EggCoreAppConfig {
+type PowerPartial<T> = PartialDeep<T>;
+/**
+ * Partial EggAppConfig
+ */
+type PartialEggConfig = PartialDeep<EggAppConfig>;
+/**
+ * Configuration factory function return type
+ */
+type EggConfigFactory = (appInfo: EggAppInfo) => PartialEggConfig;
+/**
+ * Define configuration with type safety
+ * @example
+ * import { defineConfig } from 'egg';
+ *
+ * export default defineConfig({
+ *   keys: 'my-keys',
+ *   middleware: []
+ * });
+ *
+ * // or with function
+ * export default defineConfig((appInfo) => ({
+ *   keys: appInfo.name + '_keys',
+ *   middleware: []
+ * }));
+ */
+declare function defineConfig<T extends PartialEggConfig | EggConfigFactory>(config: T): T;
+interface EggAppConfig extends EggAppConfig$1 {
   workerStartTimeout: number;
   baseDir: string;
   middleware: string[];
   coreMiddleware: string[];
-
   /**
    * The option of `bodyParser` middleware
    *
@@ -148,9 +153,8 @@ export interface EggAppConfig extends EggCoreAppConfig {
     };
     /** Default is `'error'`, it will return `400` response when `Prototype-Poisoning` happen. */
     onProtoPoisoning: 'error' | 'remove' | 'ignore';
-    onerror(err: any, ctx: Context): void;
+    onerror(err: any, ctx: Context$1): void;
   };
-
   /**
    * logger options
    * @member Config#logger
@@ -169,22 +173,15 @@ export interface EggAppConfig extends EggCoreAppConfig {
    * @property {Boolean} enableFastContextLogger - using the app logger instead of EggContextLogger, defaults to false
    */
   logger: EggLoggerConfig;
-
   /** custom logger of egg */
   customLogger: {
     [key: string]: EggLoggerOptions;
   };
-
   /** Configuration of httpclient in egg. */
   httpclient: HttpClientConfig;
-
   /**
    * customLoader config
    */
-  // customLoader: {
-  //   [key: string]: CustomLoaderConfig;
-  // };
-
   /**
    * It will ignore special keys when dumpConfig
    */
@@ -194,24 +191,19 @@ export interface EggAppConfig extends EggCoreAppConfig {
       slowBootActionMinDuration: number;
     };
   };
-
   /**
    * The environment of egg
    */
   env: EggEnvType;
-
   /**
    * The current HOME directory
    */
   HOME: string;
-
   hostHeaders: string;
-
   /**
    * Detect request' ip from specified headers, not case-sensitive. Only worked when config.proxy set to true.
    */
   ipHeaders: string;
-
   protocolHeaders: string;
   maxProxyCount: number;
   maxIpsCount: number;
@@ -220,24 +212,19 @@ export interface EggAppConfig extends EggCoreAppConfig {
     sameSite?: string;
     httpOnly?: boolean;
   };
-
   /**
    * The key that signing cookies. It can contain multiple keys separated by .
    */
   keys: string;
-
   /**
    * The name of the application
    */
   name: string;
-
   /**
    * package.json
    */
   pkg: Record<string, any>;
-
   rundir: string;
-
   siteFile: SiteFileMiddlewareOptions;
   meta: MetaMiddlewareOptions;
   notfound: NotFoundMiddlewareOptions;
@@ -245,9 +232,7 @@ export interface EggAppConfig extends EggCoreAppConfig {
     enable: boolean;
     allowedMethods: string[];
   };
-
   onClientError?(err: Error, socket: Socket, app: EggApplicationCore): ClientErrorResponse | Promise<ClientErrorResponse>;
-
   /**
    * server timeout in milliseconds, default to 0 (no timeout).
    *
@@ -256,41 +241,34 @@ export interface EggAppConfig extends EggCoreAppConfig {
    * @see https://nodejs.org/api/http.html#http_server_timeout
    */
   serverTimeout: number | null;
-
   cluster: {
     listen: {
-      path: string,
-      port: number,
-      hostname: string,
+      path: string;
+      port: number;
+      hostname: string;
     };
   };
-
   clusterClient: {
     maxWaitTime: number;
     responseTimeout: number;
   };
-
   [prop: string]: any;
 }
-
-export type RequestObjectBody = Record<string, any>;
-
+type RequestObjectBody = Record<string, any>;
 /**
  * plugin config item interface
  */
-export interface IEggPluginItem {
+interface IEggPluginItem {
   env?: EggEnvType[];
   path?: string;
   package?: string;
   enable?: boolean;
 }
-
-export type EggPluginItem = IEggPluginItem | boolean;
-
+type EggPluginItem = IEggPluginItem | boolean;
 /**
  * build-in plugin list
  */
-export interface EggPlugin {
+interface EggPlugin {
   [key: string]: EggPluginItem | undefined;
   onerror?: EggPluginItem;
   session?: EggPluginItem;
@@ -305,4 +283,5 @@ export interface EggPlugin {
   jsonp?: EggPluginItem;
   view?: EggPluginItem;
 }
-
+//#endregion
+export { ClientErrorResponse, CustomLoaderConfig, EggAppConfig, type EggAppInfo, EggConfigFactory, EggEnvType, EggLoggerConfig, EggPlugin, EggPluginItem, HttpClientConfig, IEggPluginItem, type PartialDeep, PartialEggConfig, PowerPartial, RequestObjectBody, defineConfig };

package/dist/lib/types.js

@@ -0,0 +1,36 @@
+import "@eggjs/watcher";
+import "@eggjs/development";
+import "@eggjs/jsonp";
+import "@eggjs/i18n";
+import "@eggjs/static";
+import "@eggjs/security";
+import "@eggjs/schedule";
+import "@eggjs/session";
+import "@eggjs/onerror";
+import "@eggjs/logrotator";
+import "@eggjs/multipart";
+import "@eggjs/view";
+
+//#region src/lib/types.ts
+/**
+* Define configuration with type safety
+* @example
+* import { defineConfig } from 'egg';
+*
+* export default defineConfig({
+*   keys: 'my-keys',
+*   middleware: []
+* });
+*
+* // or with function
+* export default defineConfig((appInfo) => ({
+*   keys: appInfo.name + '_keys',
+*   middleware: []
+* }));
+*/
+function defineConfig(config) {
+	return config;
+}
+
+//#endregion
+export { defineConfig };

package/dist/lib/utils.d.ts

@@ -0,0 +1,5 @@
+//#region src/lib/utils.d.ts
+declare function getSourceDirname(): string;
+declare function getSourceFile(filename: string): string;
+//#endregion
+export { getSourceDirname, getSourceFile };

package/dist/lib/utils.js

@@ -0,0 +1,14 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+//#region src/lib/utils.ts
+function getSourceDirname() {
+	if (typeof __dirname !== "undefined") return path.dirname(__dirname);
+	return path.dirname(path.dirname(fileURLToPath(import.meta.url)));
+}
+function getSourceFile(filename) {
+	return path.join(getSourceDirname(), filename);
+}
+
+//#endregion
+export { getSourceDirname, getSourceFile };

package/dist/urllib.d.ts

@@ -0,0 +1 @@
+export * from "urllib";

package/dist/urllib.js

@@ -0,0 +1,3 @@
+export * from "urllib"
+
+export {  };