@black-duty/sing-box-schema 1.11.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Black Duty Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,168 @@
+<div align="center">
+
+# Sing-box Schema <br> ✍️ 📦
+
+> Provides type-safe [**sing-box**](https://sing-box.sagernet.org/) configuration syntax support for code editors / TypeScript projects
+
+[![Version - v1.11.1](https://img.shields.io/badge/Version-v1.11.1-yellow?style=for-the-badge&logo=task&logoColor=white)](https://github.com/SagerNet/sing-box/tree/v1.11.1) [![JSON Schema - Draft 2020-12](/badges/JSON_Schema-Draft_2020--12-white.svg)](https://json-schema.org/draft/2020-12) [![Typescript - 5](https://img.shields.io/badge/typescript-5-grey.svg?style=for-the-badge&logo=typescript&logoColor=white&labelColor=007ACC)]([https://](https://www.typescriptlang.org/)) [![Zod - 4](https://img.shields.io/badge/Zod-4-grey.svg?style=for-the-badge&logo=zod&logoColor=white&labelColor=408AFE)](https://zod.dev)
+
+**English** | [**中文**](/README_ZH.md)
+
+</div>
+
+## Adapted Version
+
+Sing-box v1.11.x
+
+This project's tags correspond to the `sing-box` project's versions. Switch to different tags to get configuration formats compatible with different `sing-box` versions.
+
+## Branch Description
+
+This project has the following branches, each adapted to different versions of `sing-box`:
+
+-   **main**: The main branch with the latest commits.
+-   **stable**: Adapts to the stable version of `sing-box` (currently v1.12.x).
+-   **legacy**: Adapts to older versions of `sing-box` (e.g., older versions in the Play Store / App Store that cannot be updated), currently v1.11.x.
+-   **🚧 next**: \[WIP\] Adapts to the actively developed version of `sing-box` (currently v1.13.x).
+
+Developers can switch between different branches to adapt to their progress. For regular users, it is recommended to use tags to locate specific versions.
+
+## Usage
+
+### JSON Schema / For Users
+
+You can use it in Visual Studio Code or other JSON Schema-supported editors. Open the `sing-box` configuration JSON file and add the following at the top of the file:
+
+```json
+{
+  "$schema": "https://unpkg.com/@black-duty/sing-box-schema@1.11.1/schema.json"
+}
+```
+
+Or use the Chinese version:
+
+```json
+{
+  "$schema": "https://unpkg.com/@black-duty/sing-box-schema@1.11.1/schema.zh.json"
+}
+```
+
+In addition to Unpkg's npm mirror, you can use:
+
+<details>
+<summary>GitHub Repository</summary>
+
+```json
+{
+  "$schema": "https://raw.githubusercontent.com/BlackDuty/sing-box-schema/refs/tags/v1.11.1/schema.json"
+}
+```
+
+Or use the Chinese version:
+
+```json
+{
+  "$schema": "https://raw.githubusercontent.com/BlackDuty/sing-box-schema/refs/tags/v1.11.1/schema.zh.json"
+}
+```
+</details>
+<details>
+<summary>Github Release</summary>
+
+```json
+{
+  "$schema": "https://github.com/BlackDuty/sing-box-schema/releases/download/v1.11.1/schema.json"
+}
+```
+
+Or use the Chinese version:
+
+```json
+{
+  "$schema": "https://github.com/BlackDuty/sing-box-schema/releases/download/v1.11.1/schema.zh.json"
+}
+```
+</details>
+
+### Zod Schema / For Developers
+
+If you are a developer working with `sing-box` configurations in a TypeScript or JavaScript project, you can use the `Configuration` Schema to validate your configuration objects programmatically.
+
+```typescript
+import { Configuration } from '@black-duty/sing-box-schema';
+
+// Your sing-box configuration object
+const myConfig = {
+  "log": {
+    "level": "info"
+  },
+  "inbounds": [
+    {
+      "type": "socks",
+      "listen": "127.0.0.1",
+      "listen_port": 1080
+    }
+  ],
+  "outbounds": [
+    {
+      "type": "direct"
+    }
+  ]
+
+  // ... more configurations
+};
+
+try {
+  const validatedConfig = Configuration.parse(myConfig);
+  console.log('Configuration is valid!', validatedConfig);
+} catch (error) {
+  console.error('Configuration is invalid:', error);
+  // 'error' will be a ZodError instance with detailed validation issues.
+}
+```
+
+## Installation
+
+Install this library using your favorite package manager:
+
+```bash
+bun add @black-duty/sing-box-schema
+# or
+npm install @black-duty/sing-box-schema
+# or
+yarn add @black-duty/sing-box-schema
+```
+
+### Local Development and Contributions
+
+If you wish to contribute to the `sing-box-schema` project or develop locally, please follow these steps:
+
+1.  **Clone the repository**:
+```bash
+git clone https://github.com/BlackDuty/sing-box-schema.git
+cd sing-box-schema
+```
+2.  **Install dependencies**:
+```bash
+bun install
+```
+3.  **Build the project**:
+```bash
+bun run build
+```
+This will compile the TypeScript code and generate the JSON Schema files in the `dist` directory.
+4.  **Code Linting and Formatting**:
+```bash
+bun run lint
+```
+5.  **Manually Generate JSON Schema**:
+```bash
+bun run generate
+```
+This command is automatically run during the `build` process, but you can run it manually if needed.
+
+Contributions are welcome! Feel free to open an issue or submit a pull request.
+
+## License
+
+This project is licensed under the MIT License.