milkio 0.8.0 → 0.8.1

package/.publish/releases/0.8.0.md

@@ -1,4 +1,4 @@
-# 0.7.0 - 某章节名
+# 0.8.0 - 不再抛弃的承诺
 
 > 黑川讨厌自己，讨厌那个因为害怕而当胆小鬼的自己。
 > 爱丽丝把自己当做了唯一，是他，带她见到了这个色彩斑斓的世界，却又在短短数天后把她给抛弃。
@@ -63,11 +63,11 @@ async action(
 ```ts
 ⬇️ Meta
 ⬇️ Action
-    step: Step 1
-		step: Step 2
-		step: Step 3
+	step: Step 1
+	step: Step 2
+	step: Step 3
 ⬇️ Tests
-    test: Basic
+	test: Basic
 ```
 
 ## VS Code：同时启动前端工程
@@ -123,6 +123,6 @@ Electron: https://milkio.fun/runtime/electron/
 使用新版本时，请务必也一同升级你的客户端包的版本。
 
 ```
-bun i milkio@0.7.0
+bun i milkio@0.8.0
 cd packages/client && bun i milkio-client
 ```

package/.publish/releases-github/0.8.0.md

@@ -0,0 +1,126 @@
+# 0.8.0 - A Promise Kept
+
+> Kurokawa hated himself, hated the cowardly version of himself that acted out of fear.
+> Alice treated herself as the only one, it was him who showed her this colorful world, only to abandon her a few days later.
+> Whenever Kurokawa closed his eyes, the image of Alice leaning on his arm would appear in his mind, laughing so happily, with traces of ice cream still on the corners of her mouth.
+> Finally, trembling, Kurokawa pressed the elevator button leading to the top floor.
+> "No matter what... I won't abandon you..." Kurokawa took a deep breath, and as the elevator doors slowly opened, his eyes gradually hardened like steel.
+
+## Feature: Milkio Steps
+
+In Milkio, a new mental model for writing APIs has been introduced: Steps. It allows you to break down long API code into several small steps, which can enhance the readability of complex API code.
+
+```ts
+async action(
+	params: {
+		by: string & typia.tags.MinLength<2> & typia.tags.MaxLength<16>;
+	},
+	context,
+) {
+	const result = await context
+		/**
+		 * Step 1
+		 */
+		.step(async (stages) => {
+			const message1 = `Step 1`;
+
+			return { message1 };
+		})
+		/**
+		 * Step 2
+		 */
+		.step(async (stage) => {
+			const $message2 = `Step 2`;
+
+			return { $message2 };
+		})
+		/**
+		 * Step 3
+		 */
+		.step(async (stage) => {
+			if (!stage.message1) throw reject("INTERNAL_SERVER_ERROR", undefined);
+			if (!stage.$message2) throw reject("INTERNAL_SERVER_ERROR", undefined);
+			return {};
+		})
+		.run();
+
+	return result;
+}
+```
+
+Each `step` is a function that returns an object, which will be merged into the next `stage`.
+
+If an attribute in the object starts with `$`, Milkio treats it as a private property. Although it is always accessible in `stage`, it will be removed in `result`.
+
+To avoid modifying attributes in `stage`, making it difficult to know when certain values are changed, the properties are designed to be immutable.
+
+## VS Code: Milkio Structure
+
+> Note: Ensure your Milkio VS Code Extension is up to date
+
+Now, the bottom of your VS Code Explorer will display the structure of your Milkio API. You can use it to navigate through longer API codes.
+
+```ts
+⬇️ Meta
+⬇️ Action
+    step: Step 1
+    step: Step 2
+    step: Step 3
+⬇️ Tests
+    test: Basic
+```
+
+## VS Code: Simultaneously Launch Frontend Projects
+
+> Note: Ensure your Milkio VS Code Extension is up to date
+
+Milkio now supports associating with your frontend projects and synchronously launching them when starting Milkio. Configure it in `milkio.toml` as shown below.
+
+```toml
+[link]
+projects = [
+  { name = 'YourViteProject', cwd = '../your-project-path', script = 'bun run dev' },
+]
+```
+
+## VS Code: Workspace Optimization
+
+> Note: Ensure your Milkio VS Code Extension is up to date
+
+Previously, when using a workspace, the Milkio menu bar would only appear if the files open on the screen were part of a Milkio project.
+
+Now, if there is only one Milkio project in the workspace, the Milkio menu bar will always appear, assuming that you want to operate on that specific Milkio project.
+
+## Configuration: Automatic Environment-Based Switching
+
+Now, the configuration supports automatically reading different configurations based on different environments.
+
+https://milkio.fun/essentials/config
+
+## Testing: Support for Testing with Real Requests
+
+Testing now includes a `client` object that allows you to use a real client package to send actual requests.
+
+https://milkio.fun/essentials/api-test
+
+## Templates: Cloudflare Workers Support
+
+Milkio now supports Cloudflare Workers. You can create a Cloudflare Workers project by selecting the `cloudflare` option when running `bun create milkio`.
+
+## Documentation: Runtime Documentation Improvements
+
+I have written documentation for each runtime, detailing important points and deployment procedures.
+
+Bun: https://milkio.fun/runtime/bun/
+Node.js: https://milkio.fun/runtime/node/
+Cloudflare: https://milkio.fun/runtime/cloudflare/
+Electron: https://milkio.fun/runtime/electron/
+
+## Upgrading
+
+When using the new version, make sure to also upgrade your client package version.
+
+```
+bun i milkio@0.8.0
+cd packages/client && bun i milkio-client
+```

package/README.md

@@ -1,15 +1,3 @@
-# bao
+# Milkio
 
-To install dependencies:
-
-```bash
-bun install
-```
-
-To run:
-
-```bash
-bun run index.ts
-```
-
-This project was created using `bun init` in bun v1.0.3. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+Document: [milkio.fun](https://milkio.fun)

package/api-test/index.ts

@@ -31,7 +31,7 @@ export const executeApiTests = async <Path extends Array<keyof (typeof schema)["
 		for (let index = 0; index < 160; index++) {
 			let response;
 			try {
-				response = await fetch(typeof clientPackage.options.baseUrl === "string" ? clientPackage.options.baseUrl : await clientPackage.options.baseUrl(), { method: "HEAD" });
+				response = await fetch(typeof clientPackage.options.baseUrl === "string" ? clientPackage.options.baseUrl : await clientPackage.options.baseUrl(), { method: "GET" });
 			} catch (error: any) {
 				if (error?.status && error.status < 500) {
 					done = true;
@@ -39,6 +39,8 @@ export const executeApiTests = async <Path extends Array<keyof (typeof schema)["
 				}
 			}
 			if (response?.status && response.status < 500) {
+				console.warn(response, response.status);
+
 				done = true;
 				break;
 			}
@@ -46,7 +48,7 @@ export const executeApiTests = async <Path extends Array<keyof (typeof schema)["
 			continue;
 		}
 		if (!done) {
-			console.log(`🚨 The server startup exceeded the maximum waiting time (1600ms).`);
+			console.log(`🚨 The server startup exceeded the maximum waiting time (16000ms).`);
 			console.log(`This is likely an error encountered during the startup of the Milkio Server. Please check the 'Milkio Run & Watch' tab in your VS Code terminal panel. This is only a warning, and the tests will continue, but there is a chance they might fail due to network issues.\n`);
 		}
 	}

package/c.ts

@@ -26,14 +26,14 @@ const commands = {
 	async EAR(commandBase64ed: string) {
 		try {
 			console.clear();
-		} catch (e) { }
+		} catch (e) {}
 		const command = Buffer.from(commandBase64ed, "base64").toString("utf-8");
 		console.log("\x1B[2m%s\x1B[0m", `$ ${command}`);
 		console.log(``);
 		try {
 			await $`${{ raw: command }}`.env({ ...env, FORCE_COLOR: "3" });
-		} catch (e) { }
-		process.on("SIGINT", () => { }); // prevent users from exiting by pressing ctrl + c
+		} catch (e) {}
+		process.on("SIGINT", () => {}); // prevent users from exiting by pressing ctrl + c
 		while (true) await new Promise((resolve) => process.stdin.on("keypress", resolve));
 	},
 };

package/defines/define-command-handler.ts

@@ -27,13 +27,13 @@ export function defineCommandHandler(app: MilkioApp, options: CommandOptions = {
 			}
 		}
 		if (argv.length === 2) params.path = `$/default`;
-		else params.path = `$/${argv[2] ?? 'default'}`;
+		else params.path = `$/${argv[2] ?? "default"}`;
 
 		// @ts-ignore
 		const result = await app.execute(params.path as any, { params: params });
 		if (!result.success) {
 			if (result.fail.code === "NOT_FOUND") {
-				if (options.notFoundHandler) await options.notFoundHandler({ ...params, name: argv.length === 2 ? "default" : (argv[2] ?? 'default') });
+				if (options.notFoundHandler) await options.notFoundHandler({ ...params, name: argv.length === 2 ? "default" : argv[2] ?? "default" });
 				return;
 			}
 			if (result.fail.code !== "INTERNAL_SERVER_ERROR") {

package/defines/define-config.ts

@@ -2,7 +2,7 @@ export function defineConfig<T>(handler: (options: { config: typeof configFn })
 	const result = handler({ config: configFn });
 	if (!result) throw new Error("defineConfig must return a value, Did you forget to add a return statement?");
 	if (typeof result !== "object" || Array.isArray(result)) throw new Error("defineConfig must return an object.");
-	if ("environment" in result && "done" in result && typeof result["environment"] === "function" && typeof result["done"] === "function") throw new Error("Did you accidentally return the config method without adding \`.done()\`?");
+	if ("environment" in result && "done" in result && typeof result["environment"] === "function" && typeof result["done"] === "function") throw new Error("Did you accidentally return the config method without adding `.done()`?");
 	return result;
 }
 
@@ -29,4 +29,4 @@ export type Config = Record<string, unknown>;
 export type ConfigMore<ConfigT extends Config> = {
 	environment: (when: () => boolean, config: Partial<ConfigT>) => ConfigMore<ConfigT>;
 	done: () => ConfigT;
-};
+};

package/defines/define-http-handler.ts

@@ -137,7 +137,7 @@ export function defineHttpHandler(app: MilkioApp, options: ExecuteHttpServerOpti
 				else params = undefined;
 				// Doing so may pose security risks, as attackers may trigger your requests through link redirection without being protected by browser CORS.
 				// Therefore, this feature was commented out after v0.3.0.
-				// else if (request.request.method === 'GET' && fullurl.searchParams.get('params')) {	params = JSON.parse(decodeURIComponent(fullurl.searchParams.get('params')!)); }
+				// else if (request.request.method === 'GET' && fullurl.searchParams.get('params')) {  params = JSON.parse(decodeURIComponent(fullurl.searchParams.get('params')!)); }
 			} catch (error) {
 				const logger = useLogger(executeId);
 				logger.log("TIP: body is not json, the content is not empty, but the content is not in a valid JSON format. The original content value can be retrieved via request.request.text()");

package/kernel/logger.ts

@@ -40,7 +40,7 @@ export type Logger = {
 };
 
 export const loggerController = (() => {
-	const logs = new Map<ExecuteId, { __LOG_DETAIL__: Array<LoggerItem>;[key: string]: any }>();
+	const logs = new Map<ExecuteId, { __LOG_DETAIL__: Array<LoggerItem>; [key: string]: any }>();
 
 	const loggerPushTags = (executeId: ExecuteId, tags: Partial<MilkioLoggerTags & LoggerTags>) => {
 		if (!logs.has(executeId)) logs.set(executeId, { __LOG_DETAIL__: [] });

package/kernel/validate.ts

@@ -5,8 +5,8 @@ export function _validate(validator: IValidation.IFailure | IValidation.ISuccess
 	if (validator.success) return validator.data;
 	const error = validator.errors[0];
 
-	if ((error.value) === undefined) error.value === "undefined";
-	if ((error.value) === null) error.value === "null";
+	if (error.value === undefined) error.value === "undefined";
+	if (error.value === null) error.value === "null";
 
 	throw reject("TYPE_SAFE_ERROR", {
 		path: error.path,

package/package.json

@@ -2,7 +2,7 @@
   "name": "milkio",
   "type": "module",
   "module": "index.ts",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "peerDependencies": {
     "typescript": "^5.4.2"
   },

package/types.ts

@@ -53,8 +53,8 @@ export type MilkioConfig = {
 export type ExecuteResult<Result> = ExecuteResultSuccess<Result> | ExecuteResultFail;
 
 export type ExecuteStreamResult<Path, Result> = {
-	getResult: () => ExecuteResultSuccess<Result> | ExecuteResultFail,
-	stream: AsyncGenerator<MilkioEvent<Path>>
+	getResult: () => ExecuteResultSuccess<Result> | ExecuteResultFail;
+	stream: AsyncGenerator<MilkioEvent<Path>>;
 };
 
 export type ExecuteResultSuccess<Result> = {
@@ -94,13 +94,8 @@ export type ExecuteCoreOptions = Mixin<
 
 export type MilkioEvent<Result> = Awaited<GeneratorGeneric<ExecuteResultSuccess<Result>["data"] extends { $type: any } ? ExecuteResultSuccess<Result>["data"]["$type"] : never>>;
 
-
-export type ToEmptyObject<T> = T extends undefined | null | never
-	? {}
-	: T extends object
-	? T
-	: {};
+export type ToEmptyObject<T> = T extends undefined | null | never ? {} : T extends object ? T : {};
 
 export type Remove$<T> = {
 	[K in keyof T as K extends `$${string}` ? never : K]: T[K];
-};
+};

package/utils/handle-catch-error.ts

@@ -45,7 +45,7 @@ export function handleCatchError(error: any, executeId: ExecuteId): ExecuteResul
 	}
 
 	loggerPushTags(executeId, {
-		fail: result
+		fail: result,
 	});
 
 	return result;