Merge pull request #382 from Peefy/doc-wasm-api

docs: add wasm api reference documents

Author: Peefy

docs/reference/xlang-api/wasm-api.md

@@ -0,0 +1,83 @@
+---
+sidebar_position: 10
+---
+
+# WASM API
+
+The KCL core is written by Rust and can be compiled to the `wasm-wasi` target using toolchains such as cargo. With the help of WASM, we can also easily achieve multilingual and browser integration. Here is how we can use the KCL WASM module in node environment and rust.
+
+## Quick Start
+
+We can find and download KCL WASM module from [here](https://github.com/kcl-lang/lib/tree/main/wasm)
+
+## Node.js
+
+Install the dependency
+
+```shell
+npm install @kcl-lang/wasm-lib
+```
+
+Write the code
+
+```typescript
+import { load, invokeKCLRun } from '@kcl-lang/wasm-lib'
+
+async function main() {
+  const inst = await load();
+  const result = invokeKCLRun(inst, {
+    filename: "test.k",
+    source: `
+schema Person:
+  name: str
+
+p = Person {name = "Alice"}`,
+  });
+  console.log(result)
+}
+
+main()
+```
+
+The output is
+
+```yaml
+p:
+  name: Alice
+```
+
+## Rust
+
+In Rust, we use `wasmtime` as an example, and of course, you can also use other runtime that supports WASI to accomplish this.
+
+Install the dependency
+
+```shell
+cargo add kcl-wasm-lib --git https://github.com/kcl-lang/lib
+cargo add anyhow
+```
+
+Write the code
+
+```rust
+use anyhow::Result;
+use kcl_wasm_lib::{KCLModule, RunOptions};
+
+fn main() -> Result<()> {
+    let opts = RunOptions {
+        filename: "test.k".to_string(),
+        source: "a = 1".to_string(),
+    };
+    // Note replace your KCL wasm module path.
+    let mut module = KCLModule::from_path("path/to/kcl.wasm")?;
+    let result = module.run(&opts)?;
+    println!("{}", result);
+    Ok(())
+}
+```
+
+The output is
+
+```yaml
+a: 1
+```

docs/user_docs/support/faq-kcl.md

@@ -2683,7 +2683,7 @@ p:
 fullName: Alice White
 ```
 
-## 67. Does the use of mixed-in attributes outisde of mixin requires casting to `any` type  ?
+## 67. Does the use of mixed-in attributes outside of mixin requires casting to `any` type?
 
 You need to add specifically the type into the schema. An example code shown below: 
 
@@ -2711,4 +2711,3 @@ returns the output:
 ```bash
 foobar: foo.bar
 ```
-

i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/xlang-api/wasm-api.md

@@ -0,0 +1,83 @@
+---
+sidebar_position: 10
+---
+
+# WASM API
+
+KCL 核心用 Rust 编写，可以使用 cargo 等工具链编译到 `wasm-wasi` 目标。在 WASM 的帮助下，也可以轻松实现多语言和浏览器集成。以下是在 Node.js 环境和 Rust 中使用 KCL WASM 模块的方法。
+
+## 快速开始
+
+可以从[这里](https://github.com/kcl-lang/lib/tree/main/wasm)找到 KCL WASM 模块。
+
+## Node.js
+
+安装依赖：
+
+```shell
+npm install @kcl-lang/wasm-lib
+```
+
+编写代码：
+
+```typescript
+import { load, invokeKCLRun } from '@kcl-lang/wasm-lib'
+
+async function main() {
+  const inst = await load();
+  const result = invokeKCLRun(inst, {
+    filename: "test.k",
+    source: `
+schema Person:
+  name: str
+
+p = Person {name = "Alice"}`,
+  });
+  console.log(result)
+}
+
+main()
+```
+
+输出结果为：
+
+```yaml
+p:
+  name: Alice
+```
+
+## Rust
+
+在 Rust 中，我们以 `wasmtime` 为例，当然你也可以使用其他支持 WASI 的运行时来完成这一任务。
+
+安装依赖：
+
+```shell
+cargo add kcl-wasm-lib --git https://github.com/kcl-lang/lib
+cargo add anyhow
+```
+
+编写代码：
+
+```rust
+use anyhow::Result;
+use kcl_wasm_lib::{KCLModule, RunOptions};
+
+fn main() -> Result<()> {
+    let opts = RunOptions {
+        filename: "test.k".to_string(),
+        source: "a = 1".to_string(),
+    };
+    // 注意修改路径为你的 kcl.wasm 路径
+    let mut module = KCLModule::from_path("path/to/kcl.wasm")?;
+    let result = module.run(&opts)?;
+    println!("{}", result);
+    Ok(())
+}
+```
+
+输出结果为：
+
+```yaml
+a: 1
+```

i18n/zh-CN/docusaurus-plugin-content-docs/version-0.9/reference/xlang-api/wasm-api.md

@@ -0,0 +1,83 @@
+---
+sidebar_position: 10
+---
+
+# WASM API
+
+KCL 核心用 Rust 编写，可以使用 cargo 等工具链编译到 `wasm-wasi` 目标。在 WASM 的帮助下，也可以轻松实现多语言和浏览器集成。以下是在 Node.js 环境和 Rust 中使用 KCL WASM 模块的方法。
+
+## 快速开始
+
+可以从[这里](https://github.com/kcl-lang/lib/tree/main/wasm)找到 KCL WASM 模块。
+
+## Node.js
+
+安装依赖：
+
+```shell
+npm install @kcl-lang/wasm-lib
+```
+
+编写代码：
+
+```typescript
+import { load, invokeKCLRun } from '@kcl-lang/wasm-lib'
+
+async function main() {
+  const inst = await load();
+  const result = invokeKCLRun(inst, {
+    filename: "test.k",
+    source: `
+schema Person:
+  name: str
+
+p = Person {name = "Alice"}`,
+  });
+  console.log(result)
+}
+
+main()
+```
+
+输出结果为：
+
+```yaml
+p:
+  name: Alice
+```
+
+## Rust
+
+在 Rust 中，我们以 `wasmtime` 为例，当然你也可以使用其他支持 WASI 的运行时来完成这一任务。
+
+安装依赖：
+
+```shell
+cargo add kcl-wasm-lib --git https://github.com/kcl-lang/lib
+cargo add anyhow
+```
+
+编写代码：
+
+```rust
+use anyhow::Result;
+use kcl_wasm_lib::{KCLModule, RunOptions};
+
+fn main() -> Result<()> {
+    let opts = RunOptions {
+        filename: "test.k".to_string(),
+        source: "a = 1".to_string(),
+    };
+    // 注意修改路径为你的 kcl.wasm 路径
+    let mut module = KCLModule::from_path("path/to/kcl.wasm")?;
+    let result = module.run(&opts)?;
+    println!("{}", result);
+    Ok(())
+}
+```
+
+输出结果为：
+
+```yaml
+a: 1
+```

versioned_docs/version-0.9/reference/xlang-api/wasm-api.md

@@ -0,0 +1,83 @@
+---
+sidebar_position: 10
+---
+
+# WASM API
+
+The KCL core is written by Rust and can be compiled to the `wasm-wasi` target using toolchains such as cargo. With the help of WASM, we can also easily achieve multilingual and browser integration. Here is how we can use the KCL WASM module in node environment and rust.
+
+## Quick Start
+
+We can find and download KCL WASM module from [here](https://github.com/kcl-lang/lib/tree/main/wasm)
+
+## Node.js
+
+Install the dependency
+
+```shell
+npm install @kcl-lang/wasm-lib
+```
+
+Write the code
+
+```typescript
+import { load, invokeKCLRun } from '@kcl-lang/wasm-lib'
+
+async function main() {
+  const inst = await load();
+  const result = invokeKCLRun(inst, {
+    filename: "test.k",
+    source: `
+schema Person:
+  name: str
+
+p = Person {name = "Alice"}`,
+  });
+  console.log(result)
+}
+
+main()
+```
+
+The output is
+
+```yaml
+p:
+  name: Alice
+```
+
+## Rust
+
+In Rust, we use `wasmtime` as an example, and of course, you can also use other runtime that supports WASI to accomplish this.
+
+Install the dependency
+
+```shell
+cargo add kcl-wasm-lib --git https://github.com/kcl-lang/lib
+cargo add anyhow
+```
+
+Write the code
+
+```rust
+use anyhow::Result;
+use kcl_wasm_lib::{KCLModule, RunOptions};
+
+fn main() -> Result<()> {
+    let opts = RunOptions {
+        filename: "test.k".to_string(),
+        source: "a = 1".to_string(),
+    };
+    // Note replace your KCL wasm module path.
+    let mut module = KCLModule::from_path("path/to/kcl.wasm")?;
+    let result = module.run(&opts)?;
+    println!("{}", result);
+    Ok(())
+}
+```
+
+The output is
+
+```yaml
+a: 1
+```

versioned_docs/version-0.9/user_docs/support/faq-kcl.md

@@ -2683,3 +2683,32 @@ p:
 fullName: Alice White
 ```
 
+## 67. Does the use of mixed-in attributes outside of mixin requires casting to `any` type?
+
+You need to add specifically the type into the schema. An example code shown below: 
+
+```KCL
+schema FooBar:
+    mixin [
+        FooBarMixin
+    ]
+    foo: str = 'foo'
+    bar: str = 'bar'
+
+protocol FooBarProtocol:
+    foo: str
+    bar: str
+
+mixin FooBarMixin for FooBarProtocol:
+    foobar: str = "${foo}.${bar}" # Attribute with the annotation can be accessed outside the schema.
+
+_c = FooBar {}
+foobar = _c.foobar
+```
+
+returns the output:
+
+```bash
+foobar: foo.bar
+```
+