@moku-labs/core 0.1.0-alpha.6 → 0.1.1

package/README.md

@@ -308,7 +308,7 @@ The full specification lives in [`specification/`](specification/):
 
 ## Status
 
-Alpha. API is stabilizing. Not yet published to npm.
+Early release (`0.1.x`). The public API — `createCoreConfig` → `createCore` → `createApp` — is stable; pre-1.0 means internals may still be refined. Published to npm: `bun add @moku-labs/core`.
 
 ## License
 

package/dist/index.cjs

@@ -1,5 +1,4 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/utilities.ts
 /**
 * Checks whether a value is a non-null, non-array object record.
@@ -141,7 +140,6 @@ function validateCorePlugins(id, corePlugins) {
 function checkCorePluginConflicts(id, plugins, corePluginNames) {
 	for (const plugin of plugins) if (corePluginNames.has(plugin.name)) throw new TypeError(`[${id}] Plugin name "${plugin.name}" conflicts with core plugin "${plugin.name}".\n  Choose a different plugin name.`);
 }
-
 //#endregion
 //#region src/app.ts
 /**
@@ -416,6 +414,14 @@ function buildApp(runtime, flatPlugins, buildPluginContext, corePluginData, cons
 	const appRequire = createRequire(runtime, (name) => `[${runtime.id}] app.require("${name}") failed: "${name}" is not registered.\n  Check your plugin list.`);
 	const appHas = createHas(runtime);
 	const app = {
+		/**
+		* Run onStart for all plugins, then consumer onStart.
+		*
+		* @example
+		* ```ts
+		* await app.start();
+		* ```
+		*/
 		start: async () => {
 			if (started) throw new Error(`[${runtime.id}] App already started.\n  start() can only be called once.`);
 			for (const plugin of corePluginData.plugins) if (plugin.spec.onStart) await plugin.spec.onStart({
@@ -426,6 +432,14 @@ function buildApp(runtime, flatPlugins, buildPluginContext, corePluginData, cons
 			if (consumer?.onStart) await consumer.onStart(buildCallbackContext(runtime));
 			started = true;
 		},
+		/**
+		* Run onStop for all plugins in reverse, then consumer onStop.
+		*
+		* @example
+		* ```ts
+		* await app.stop();
+		* ```
+		*/
 		stop: async () => {
 			if (!started) throw new Error(`[${runtime.id}] App not started.\n  Call start() before stop().`);
 			await executeStop(flatPlugins, runtime.globalConfig);
@@ -435,10 +449,40 @@ function buildApp(runtime, flatPlugins, buildPluginContext, corePluginData, cons
 			});
 			if (consumer?.onStop) await consumer.onStop(buildCallbackContext(runtime));
 		},
+		/**
+		* Emit an event with an optional payload.
+		*
+		* @param eventName - The event name to emit.
+		* @param payload - The optional event payload.
+		* @example
+		* ```ts
+		* app.emit("page:view", { path: "/" });
+		* ```
+		*/
 		emit: (eventName, payload) => {
 			runtime.emit(eventName, payload);
 		},
+		/**
+		* Look up a plugin API by instance reference.
+		*
+		* @param instance - The plugin instance to look up.
+		* @returns The plugin's API object.
+		* @example
+		* ```ts
+		* const routerApi = app.require(routerPlugin);
+		* ```
+		*/
 		require: (instance) => appRequire(instance),
+		/**
+		* Check if a plugin name is registered.
+		*
+		* @param name - The plugin name to check.
+		* @returns True if the plugin is registered.
+		* @example
+		* ```ts
+		* app.has("router"); // => true or false
+		* ```
+		*/
 		has: (name) => appHas(name)
 	};
 	for (const [name, api] of runtime.apis) app[name] = api;
@@ -544,7 +588,6 @@ function kernel(parameters) {
 		states: coreStates
 	}, consumer);
 }
-
 //#endregion
 //#region src/core.ts
 /**
@@ -628,7 +671,6 @@ function createCoreFactory(frameworkId, configDefaults, createPlugin, corePlugin
 	};
 	return createCore;
 }
-
 //#endregion
 //#region src/plugin.ts
 /**
@@ -816,7 +858,6 @@ function createPluginFactory(frameworkId) {
 	};
 	return createPlugin;
 }
-
 //#endregion
 //#region src/config.ts
 /**
@@ -852,7 +893,6 @@ function createCoreConfig(id, options) {
 		createCore: createCoreFactory(frameworkId, configDefaults, createPlugin, corePlugins, corePluginConfigs)
 	};
 }
-
 //#endregion
 //#region src/core-plugin.ts
 /**
@@ -973,7 +1013,6 @@ function createCorePlugin(name, spec) {
 		_phantom: {}
 	};
 }
-
 //#endregion
 exports.createCoreConfig = createCoreConfig;
-exports.createCorePlugin = createCorePlugin;
+exports.createCorePlugin = createCorePlugin;

package/dist/index.mjs

@@ -139,7 +139,6 @@ function validateCorePlugins(id, corePlugins) {
 function checkCorePluginConflicts(id, plugins, corePluginNames) {
 	for (const plugin of plugins) if (corePluginNames.has(plugin.name)) throw new TypeError(`[${id}] Plugin name "${plugin.name}" conflicts with core plugin "${plugin.name}".\n  Choose a different plugin name.`);
 }
-
 //#endregion
 //#region src/app.ts
 /**
@@ -414,6 +413,14 @@ function buildApp(runtime, flatPlugins, buildPluginContext, corePluginData, cons
 	const appRequire = createRequire(runtime, (name) => `[${runtime.id}] app.require("${name}") failed: "${name}" is not registered.\n  Check your plugin list.`);
 	const appHas = createHas(runtime);
 	const app = {
+		/**
+		* Run onStart for all plugins, then consumer onStart.
+		*
+		* @example
+		* ```ts
+		* await app.start();
+		* ```
+		*/
 		start: async () => {
 			if (started) throw new Error(`[${runtime.id}] App already started.\n  start() can only be called once.`);
 			for (const plugin of corePluginData.plugins) if (plugin.spec.onStart) await plugin.spec.onStart({
@@ -424,6 +431,14 @@ function buildApp(runtime, flatPlugins, buildPluginContext, corePluginData, cons
 			if (consumer?.onStart) await consumer.onStart(buildCallbackContext(runtime));
 			started = true;
 		},
+		/**
+		* Run onStop for all plugins in reverse, then consumer onStop.
+		*
+		* @example
+		* ```ts
+		* await app.stop();
+		* ```
+		*/
 		stop: async () => {
 			if (!started) throw new Error(`[${runtime.id}] App not started.\n  Call start() before stop().`);
 			await executeStop(flatPlugins, runtime.globalConfig);
@@ -433,10 +448,40 @@ function buildApp(runtime, flatPlugins, buildPluginContext, corePluginData, cons
 			});
 			if (consumer?.onStop) await consumer.onStop(buildCallbackContext(runtime));
 		},
+		/**
+		* Emit an event with an optional payload.
+		*
+		* @param eventName - The event name to emit.
+		* @param payload - The optional event payload.
+		* @example
+		* ```ts
+		* app.emit("page:view", { path: "/" });
+		* ```
+		*/
 		emit: (eventName, payload) => {
 			runtime.emit(eventName, payload);
 		},
+		/**
+		* Look up a plugin API by instance reference.
+		*
+		* @param instance - The plugin instance to look up.
+		* @returns The plugin's API object.
+		* @example
+		* ```ts
+		* const routerApi = app.require(routerPlugin);
+		* ```
+		*/
 		require: (instance) => appRequire(instance),
+		/**
+		* Check if a plugin name is registered.
+		*
+		* @param name - The plugin name to check.
+		* @returns True if the plugin is registered.
+		* @example
+		* ```ts
+		* app.has("router"); // => true or false
+		* ```
+		*/
 		has: (name) => appHas(name)
 	};
 	for (const [name, api] of runtime.apis) app[name] = api;
@@ -542,7 +587,6 @@ function kernel(parameters) {
 		states: coreStates
 	}, consumer);
 }
-
 //#endregion
 //#region src/core.ts
 /**
@@ -626,7 +670,6 @@ function createCoreFactory(frameworkId, configDefaults, createPlugin, corePlugin
 	};
 	return createCore;
 }
-
 //#endregion
 //#region src/plugin.ts
 /**
@@ -814,7 +857,6 @@ function createPluginFactory(frameworkId) {
 	};
 	return createPlugin;
 }
-
 //#endregion
 //#region src/config.ts
 /**
@@ -850,7 +892,6 @@ function createCoreConfig(id, options) {
 		createCore: createCoreFactory(frameworkId, configDefaults, createPlugin, corePlugins, corePluginConfigs)
 	};
 }
-
 //#endregion
 //#region src/core-plugin.ts
 /**
@@ -971,6 +1012,5 @@ function createCorePlugin(name, spec) {
 		_phantom: {}
 	};
 }
-
 //#endregion
-export { createCoreConfig, createCorePlugin };
+export { createCoreConfig, createCorePlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moku-labs/core",
-  "version": "0.1.0-alpha.6",
+  "version": "0.1.1",
   "author": "Alex Kucherenko",
   "repository": {
     "type": "git",
@@ -23,9 +23,9 @@
     "jiti": "2.6.1",
     "lefthook": "2.1.1",
     "publint": "0.3.17",
-    "tsdown": "0.20.3",
-    "typescript": "5.9.3",
-    "typescript-eslint": "8.56.0",
+    "tsdown": "0.22.1",
+    "typescript": "6.0.3",
+    "typescript-eslint": "8.58.0",
     "vitest": "4.0.18"
   },
   "exports": {
@@ -40,6 +40,7 @@
       }
     }
   },
+  "sideEffects": false,
   "bugs": {
     "url": "https://github.com/moku-labs/core/issues"
   },