@modern-js/main-doc 2.0.3-alpha.0 → 2.2.0

package/en/configure/app/tools/styled-components.mdx

@@ -0,0 +1,12 @@
+---
+title: tools.styledComponents
+sidebar_label: styledComponents
+---
+
+:::info BUILDER
+This configuration is Modern.js Builder configuration, more detail can see [tools.styledComponents](https://modernjs.dev/builder/en/api/config-tools.html#tools-styledcomponents)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/tools/styledComponents.md'
+
+<Main />

package/en/configure/app/tools/swc.mdx

@@ -0,0 +1,54 @@
+---
+title: tools.swc
+sidebar_label: swc
+---
+# swc
+
+- Type: `Object`
+- Default: `undefined`
+
+## Introduction
+
+[SWC](https://SWC.rs/) (Speedy Web Compiler) is a transformer and minimizer for JavaScript and TypeScript based on `Rust`. SWC can provide the same abilities with Babel, and it's more than 10x faster than Babel.
+
+Modern.js Builder has a out-of-box plugin for SWC, power your Web application with Polyfill and minification, we also port some common used Babel plugins to SWC.
+
+## Install
+
+The `@modern-js/plugin-swc` plugin needs to be installed before use.
+
+```bash
+pnpm add @modern-js/plugin-swc -D
+```
+
+After the installation，please register the SWC plugin in the `modern.config.ts` file, then the SWC compilation and compression will be enabled.
+
+```ts title="modern.config.ts"
+import appTools, { defineConfig } from '@modern-js/app-tools';
+import swcPlugin from '@modern-js/plugin-swc';
+
+export default defineConfig({
+  plugins: [appTools(), swcPlugin()],
+});
+```
+
+## Config
+
+You can set the SWC compilation behavior through the `tools.swc` config.
+
+```js title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+
+export default defineConfig({
+  tools: {
+    swc: {
+      jsMinify: {
+        compress: {},
+        mangle: true,
+      },
+    },
+  },
+});
+```
+
+For config details, please refer to [Modern.js Builder - SWC Plugin Configuration](https://modernjs.dev/builder/en/plugins/plugin-swc.html#config).

package/en/configure/app/tools/tailwindcss.mdx

@@ -0,0 +1,43 @@
+---
+title: tools.tailwindcss
+
+sidebar_label: tailwindcss
+---
+# tailwindcss
+
+- Type: `Object | Function`
+- Default: See configuration details below.
+
+<details>
+  <summary>TailwindCSS configuration details</summary>
+
+```js
+const tailwind = {
+  content: [
+    './config/html/**/*.html',
+    './config/html/**/*.ejs',
+    './config/html/**/*.hbs',
+    './src/**/*.js',
+    './src/**/*.jsx',
+    './src/**/*.ts',
+    './src/**/*.tsx',
+    './storybook/**/*',
+  ],
+  theme: source.designSystem, // Use source.design System configuration as Tailwind CSS Theme configuration
+};
+```
+
+:::tip Tips
+More about: <a href="https://tailwindcss.com/docs/configuration" target="_blank">TailwindCSS configuration</a>。
+
+:::
+
+</details>
+
+When the value is of type `Object`, rhe configuration corresponding to [TailwindCSS](https://tailwindcss.com/docs/configuration) is merged with the default configuration through `Object.assign`.
+
+When the value is of type `Function`, the object returned by the function is merged with the default configuration by `Object.assign`.
+
+The `theme` attribute is not allowed, otherwise the build will fail. Modern.js use [`source.designSystem`](/configure/app/source/design-system) as the Tailwind CSS Theme configuration.
+
+Other uses are consistent with [Tailwind CSS](https://tailwindcss.com/docs/configuration)。

package/en/configure/app/tools/terser.mdx

@@ -0,0 +1,12 @@
+---
+title: tools.terser
+sidebar_label: terser
+---
+
+:::info BUILDER
+This configuration is Modern.js Builder configuration, more detail can see [tools.terser](https://modernjs.dev/builder/en/api/config-tools.html#tools-terser)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/tools/terser.md'
+
+<Main />

package/en/configure/app/tools/ts-checker.mdx

@@ -0,0 +1,12 @@
+---
+title: tools.tsChecker
+sidebar_label: tsChecker
+---
+
+:::info BUILDER
+This configuration is Modern.js Builder configuration, more detail can see [tools.tsChecker](https://modernjs.dev/builder/en/api/config-tools.html#tools-tschecker)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/tools/tsChecker.md'
+
+<Main />

package/en/configure/app/tools/ts-loader.mdx

@@ -0,0 +1,12 @@
+---
+title: tools.tsLoader
+sidebar_label: tsLoader
+---
+
+:::info BUILDER
+This configuration is Modern.js Builder configuration, more detail can see [tools.tsLoader](https://modernjs.dev/builder/en/api/config-tools.html#tools-tsloader)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/tools/tsLoader.md'
+
+<Main />

package/en/configure/app/tools/webpack-chain.mdx

@@ -0,0 +1,12 @@
+---
+title: tools.webpackChain
+sidebar_label: webpackChain
+---
+
+:::info BUILDER
+This configuration is Modern.js Builder configuration, more detail can see [tools.webpackChain](https://modernjs.dev/builder/en/api/config-tools.html#tools-webpackchain)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/tools/webpackChain.md'
+
+<Main />

package/en/configure/app/tools/webpack.mdx

@@ -0,0 +1,12 @@
+---
+title: tools.webpack
+sidebar_label: webpack
+---
+
+:::info BUILDER
+This configuration is Modern.js Builder configuration, more detail can see [tools.webpack](https://modernjs.dev/builder/en/api/config-tools.html#tools-webpack)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/tools/webpack.md'
+
+<Main />

package/en/configure/app/usage.mdx

@@ -0,0 +1,93 @@
+---
+sidebar_position: 0
+---
+
+# Configure to use
+
+There are two configurations in the Modern.js, a compile configuration and a server runtime configuration.
+
+The compile configuration can be configured in two places:
+
+- `package.json` file
+- `modern.config.t(j)s` file in the root path
+
+:::warning Warning
+Configurations in both `package.json` and `modern.config.t(j)s` file are not supported for the same configuration. Configuration in `modern.config. t(j)s` is recommended.
+
+:::
+
+Server runtime configuration can be configured in the `modern.server-runtime.config.t(j)s` file in the root path.
+
+## Configure in the configuration file
+
+Modern.js configuration files are defined in the root path of the project, and both `.js` and `.ts` formats are supported:
+
+- `modern.config.js`
+- `modern.config.ts`
+
+### modern.config.js
+
+You can use JavaScript syntax in the `modern.config.js` file and it is more flexible than in the `package.json` file.
+
+For example, you can define configuration options for function types in `modern.config.js`:
+
+```js title="modern.config.js"
+export default {
+  source: {
+    alias: opts => {
+      opts['@common'] = './src/common';
+    },
+  },
+};
+```
+
+You can also dynamically set it with `process.env.NODE _ENV`:
+
+```js title="modern.config.js"
+export default {
+  server: {
+    ssr: process.env.NODE_ENV === 'development',
+  },
+};
+```
+
+### modern.config.ts
+
+We recommend using configuration files in `.ts` format, which provides friendly TypeScript type hints to help you avoid configuration errors.
+
+Import the `defineConfig` tool function from `@modern-js/app-tools`, which will help you with configuration type derivation and type completion:
+
+```ts title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+
+export default defineConfig({
+  source: {
+    alias: {
+      '@common': './src/common',
+    },
+  },
+});
+```
+
+## Configure in package.json (not recommended)
+
+In addition to configuration files, configuration options can also be set the `modernConfig` field in the `package.json`, such as:
+
+```json title="package.json"
+{
+  "modernConfig": {
+    "source": {
+      "alias": {
+        "@common": "./src/common"
+      }
+    }
+  }
+}
+```
+
+Due to the limitation of the JSON file format, only simple types such as numbers, strings, boolean values, arrays, etc. can be defined in `package.json`. When we need to set the value of the function type, it is recommended to set it in the Modern.js configuration file.
+
+## Note
+
+- It is not recommended to use both `package.json` and `modern.config.t[j]s` for configuration. If both are used and a configuration conflict occurs, Modern.js will prompt error on the command line.
+- `@modern-js/runtime` exports the [defineConfig](/apis/app/runtime/app/define-config) API of the same name, please pay attention to the distinction.

package/en/guides/advanced-features/bff/bff-proxy.mdx

@@ -0,0 +1,30 @@
+---
+sidebar_position: 5
+title: Use Proxy
+---
+# Use Proxy
+
+By configuring the BFF proxy, API requests can be forwarded without manual coding
+
+:::caution
+Using a BFF proxy ensures that requests can enter the BFF handler. (eg the request path must contain a bff prefix)
+
+:::
+
+Writing the following BFF proxy configuration in the `modern.server-runtime.config.js` file will proxy requests sent to `http://localhost:8080/api/v1/topics` to `https://cnodejs.org/api/v1/topics`.
+
+```js title="modern.server-runtime.config.js"
+import { defineConfig } from '@modern-js/app-tools/server';
+export default defineConfig({
+  bff: {
+    proxy: {
+      '/api/v1/topics': 'https://cnodejs.org',
+    },
+  },
+};
+```
+
+:::note
+For more detail, see [bff.proxy](/configure/app/bff/proxy)。For more proxy info, see [Proxy](/guides/basic-features/proxy)。
+
+:::

package/en/guides/advanced-features/bff/frameworks.mdx

@@ -0,0 +1,152 @@
+---
+sidebar_position: 3
+title: Frameworks
+---
+# Frameworks
+
+Modern.js's BFF supports different runtime frameworks, currently Modern.js's BFF supports two runtime frameworks[Express.js](https://expressjs.com/) 和 [Koa.js](https://koajs.com/).
+
+## Function Writing
+
+Under the function writing, only the middleware writing method of various runtime frameworks is different, and other implementations are basically the same. Take Express as an example to introduce how to write a middleware by hand in the `api/_ app.ts` and add permission verification:
+
+```ts
+import { hook } from '@modern-js/runtime/server';
+import { Request, Response, NextFunction } from 'express';
+
+export default hook(({ addMiddleware }) => {
+  addMiddleware(async (req: Request, res: Response, next: NextFunction) => {
+    if (req.url !== '/api/login') {
+      const sid = req?.cookies?.sid;
+      if (!sid) {
+        res.status(400);
+        res.json({ code: -1, message: 'need login' });
+      } else {
+        next();
+      }
+    } else {
+      next();
+    }
+  });
+});
+```
+
+然后添加一个普通的 BFF 函数 `/api/hello.ts`:
+
+```ts
+export default async () => {
+  return 'Hello Modern.js';
+};
+```
+
+Finally, add the access code of the interface in the front-end `src/App.tsx`, and call it directly in an integrated way:
+
+```ts
+import { useState, useEffect } from 'react';
+import { get as hello } from '@api/hello';
+
+export default () => {
+  const [text, setText] = useState('');
+
+  useEffect(() => {
+    async function fetchMyApi() {
+      const { message } = await hello();
+      setText(message);
+    }
+
+    fetchMyApi();
+  }, []);
+
+  return <p>{text}</p>;
+};
+```
+
+Then exec `pnpm run dev` starts the project, and accessing `http://localhost:8080/` will find that the request for'/api/hello 'is blocked:
+
+![Network](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/network2.png)
+
+Finally, modify the front-end code `src/App.tsx` to call the login interface before accessing `/api/hello`:
+
+```ts
+import { useState, useEffect } from 'react';
+import { get as hello } from '@api/hello';
+import { post as login } from '@api/login';
+
+export default () => {
+  const [text, setText] = useState('');
+
+  useEffect(() => {
+    async function fetchAfterLogin() {
+      const { code } = await login();
+      if (code === 0) {
+        const { message } = await hello();
+        setText(message);
+      }
+    }
+    fetchAfterLogin();
+  }, []);
+
+  return <p>{text}</p>;
+};
+```
+
+Refresh the page and you can see that `/api/hello` was accessed successfully:
+
+![Network](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/network3.png)
+
+The above code simulates the way to add middleware to the `/api/_app.ts` to achieve an easy login function. Also, other functions can be implemented in this hook file to extend BFF Server.
+
+## Framework Writing
+
+Under the framework writing, Modern.js does not collect middleware in the `api/_app.ts`, and the running process is controlled by the plugin itself.
+
+### Express
+
+The framework writing of Express supports defining the startup logic of API Server in `api/app.[tj]s`. performing the initialization work of the application, adding global middleware, declaring routes, and even extending the original framework.
+
+The route defined by the BFF function will be registered after the route defined by the `app.ts` file, so here you can also intercept the route defined by the BFF function, preprocess or respond in advance.
+
+```ts title="api/app.ts"
+import express from 'express';
+
+const app = express();
+
+app.put('/user', function (req, res) {
+  res.send('Got a PUT request at /user');
+});
+
+app.use(async (req, res, next) => {
+  console.info(`access url: ${req.url}`);
+  next();
+});
+
+export default app;
+```
+
+### Koa
+
+The Koa framework is written in a similar way to Express. It supports defining the startup logic of API Server in `app.[tj]s`, performing the initialization work of the application, adding global middleware, declaring routes, extending the original framework, etc.
+
+The route defined by the BFF function will be registered after the route defined by the `app.ts` file, so here you can also intercept the route defined by the BFF function, preprocess or respond in advance.
+
+:::caution
+Use the framework writing, when there is no `app.ts`, Modern.js will add koa-body by default. When there is `app.ts`, if the developer wants to use the BFF function with Body, he needs to ensure that the koa-body middleware has been added.
+
+:::
+
+```ts title=api/app.ts
+import koa from 'koa';
+
+const app = new Koa();
+
+app.put('/user', function (req, res) {
+  res.send('Got a PUT request at /user');
+});
+
+app.use(async (ctx, next) => {
+  console.info(`access url: ${ctx.url}`);
+  await next();
+});
+
+export default app;
+```

package/en/guides/advanced-features/bff/function.mdx

@@ -0,0 +1,233 @@
+---
+sidebar_position: 1
+title: Basic Usage
+---
+# Basic Usage
+
+Applications developed with Modern.js can define API functions in the `api/` directory, which can be called by the front-end to send requests without writing front and back-end glue layer code, At the same time, it ensures the type safety of the front and back end
+
+## Enable BFF
+
+import EnableBFF from "@site-docs-en/components/enable-bff"
+
+<EnableBFF/>
+
+## BFF Function
+
+The functions that are allowed to be called through integration are called **BFF functions**. Here is the simplest BFF function to write, creating an `api/hello.ts` file:
+
+```ts title="api/hello.ts"
+export const get = async () => 'Hello Modern.js';
+```
+
+Then directly import the function in `src/App.tsx` and call:
+
+```tsx title=src/App.tsx
+import { useState, useEffect } from 'react';
+import { get as hello } from '@api/hello';
+
+export default () => {
+  const [text, setText] = useState('');
+
+  useEffect(() => {
+    hello().then(setText);
+  }, []);
+  return <div>{text}</div>;
+};
+```
+
+:::info
+Modern.js generator has already configured the `@api` alias in tsconfig.json, so you can import functions directly by aliases.
+
+:::
+
+The functions import in `src/App.tsx` will be automatically converted into interface calls, so there is no need to call the interface through fetch.
+
+Execute `pnpm run dev`, then open `http://localhost:8080/` to see that the page has displayed the content returned by the BFF function. In Network, you can see that the page sent a request to `http://localhost:8080/api/hello`.
+
+![Network](https://p6-piu.byteimg.com/tos-cn-i-8jisjyls3a/fd41750f8d414179a9b4ecb519919b36~tplv-8jisjyls3a-3:0:0:q75.png)
+
+## API Routes
+
+In Modern.js, the BFF function routing system is implemented based on the file system, and it is also a conventional routing system.
+
+In **Function Writing**, All files under `api/` will map to an interface. In **Framework Writing**, All files under `api/lambda` will map to an interface
+
+:::note
+Function Writing & Framework Writing will introduce soon.
+
+:::
+
+All routes generated by BFF functions have a prefix, and the default value is `/api`. The prefix can be set through [bff.prefix] (/docs/configure/app/bff/prefix).
+
+Several routing conventions are described as follow.
+
+### Default Route
+
+Files named `index.[jt]s` are mapped to the previous directory.
+
+- `api/index.ts` -> `{prefix}/`
+- `api/user/index.ts` -> `{prefix}/user`
+
+### Multi-layer Route
+
+Supports parsing nested files, if you create a nested folder structure, the files will still automatically parse routes in the same way.
+
+- `api/hello.ts` -> `{prefix}/hello`
+- `api/user/list.ts` -> `{prefix}/user/list`
+
+### Dynamic Route
+
+Create folders or files named with `[xxx]` to support dynamic named routing parameters.
+
+- `api/user/[username]/info.ts` -> `{prefix}/user/:username/info`
+- `api/user/username/[action].ts` -> `{prefix}/user/username/:action`
+
+### Allow List
+
+By default, all files in the'api/'directory will be parsed as BFF function files, but the following files will not be parsed:
+
+- file name start with `_`, for example `_utils.ts`.
+- files in directory which name start with `_`, for example `_utils/index.ts`、`_utils/cp.ts`.
+- test files, for example `foo.test.ts`.
+- type files, for example `hello.d.ts`.
+- files in `node_module`.
+
+## RESTful API
+
+Modern.js BFF functions need to be defined according to the RESTful API standard, follow the HTTP Method specification, and do not allow free parameter definition.
+
+:::info
+Assuming that the function allows free definition of parameters, the resulting route must be called by the **private protocol** (the reason is that the request parameters cannot be distinguished from the request body), and cannot implement any RESTful API.
+
+If the service is only used for the application itself, there is no problem. but its **non-standard interface definition** cannot be integrated into the larger system. In the case of multiple systems working together (such as BFF low-code construction), other systems also need to follow the **private protocol**.
+
+:::
+
+### Function Named Export
+
+Modern.js the export name of the BFF function determines the Method of the corresponding interface of the function, such as `get`, `post` and so on.
+
+For example, following the example, a `GET` interface can be exported.
+
+```ts
+export const get = async () => {
+  return {
+    name: 'Modern.js',
+    desc: '现代 web 工程方案',
+  };
+};
+```
+
+Following the example below, a `POST` interface can be exported.
+
+```ts
+export const post = async () => {
+  return {
+    name: 'Modern.js',
+    desc: '现代 web 工程方案',
+  };
+};
+```
+
+- Modern.js supports 9 definitions for HTTP Method: `GET`、`POST`、`PUT`、`DELETE`、`CONNECT`、`TRACE`、`PATCH`、`OPTION`、`HEAD`, can be exported using these methods as functions。
+
+- The name is size insensitive，if `GET`，can write `get`、`Get`、`GEt`、`GET`，can be accurately identified. But default export as `export default xxx` will be map to `Get`。
+
+- Multiple functions of different Methods can be defined in one file, but if multiple functions of the same Method are defined, only the first will take effect.
+
+:::info
+It should be noted that the defined functions should all be asynchronous, which is related to the type when the function is called, which will be mentioned later.
+
+:::
+
+### Function Parameter Rule
+
+As mentioned above, in order to meet the design criteria of RESTful APIs, the BFF function in Modern.js needs to follow certain imported parameter rules.
+
+The function parameters are divided into two parts, the dynamic part in the request path and the request option `RequestOption`.
+
+#### Dynamic Path
+
+Dynamic routing will be used as imported parameters in the first part of the function, and each imported parameter corresponds to a dynamic route. For example, in the following example, uid will be passed into the function as the first two parameters:
+
+```ts title="api/[level]/[id].ts"
+export default async (level: number, id: number) => {
+  const userData = await queryUser(level, uid);
+  return userData;
+};
+```
+
+Pass dynamic parameters directly when calling:
+
+```ts title="App.tsx"
+import { useState, useEffect } from 'react';
+import { get as getUser } from '@api/[level]/[id]';
+
+export default () => {
+  const [name, setName] = useState('');
+
+  useEffect(() => {
+    getUser(6, 001).then(userData => setName(userData.name));
+  }, []);
+
+  return <div>{name}</div>;
+};
+```
+
+#### RequestOption
+
+The parameter after Dynamic Path is the object `RequestOption` containing querystring and request body, which is used to define the types of `data` and `query`.
+
+In normal functions without dynamic routing, the incoming `data` and `query` can be obtained from the first imported parameter, for example:
+
+```ts title="api/hello.ts"
+import type { RequestOption } from '@modern-js/runtime/server';
+
+export async function post({
+  query,
+  data,
+}: RequestOption<Record<string, string>, Record<string, string>>) {
+  // do somethings
+}
+```
+
+When a function file uses dynamic routing rules, dynamic routing before the `RequestOption` parameter.
+
+```ts title="api/[sku]/[id]/item.ts"
+export async function post(
+  sku: string,
+  id: string,
+  {
+    data,
+    query,
+  }: RequestOption<Record<string, string>, Record<string, string>>,
+) {
+  // do somethings
+}
+```
+
+Also pass in the parameters according to the function definition:
+
+```ts title="App.tsx"
+import { post } from '@api/[sku]/[id]/item';
+
+export default () => {
+  const addSku = () => {
+    post('0001' /* sku */, '1234' /* id */, {
+      query: {
+        /* ... */
+      },
+      data: {
+        /* ... */
+      },
+    });
+  };
+
+  return <div onClick={addSku}>添加 SKU</div>;
+};
+```
+
+As mentioned earlier, the defined functions should be asynchronous because they are automatically converted to HTTP interface calls when called by the front end.
+
+so in order to keep the type definition consistent with the actual calling, it is necessary to set the BFF function to asynchronous when defining it.