@tyx1703/json-schema-editor-visual 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 YanxinTang
+
+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

@@ -2,13 +2,6 @@
 
 A React component for visually editing JSON Schema.
 
-## Peer Dependencies
-
-- `react` ^18 or ^19
-- `react-dom` ^18 or ^19
-- `antd` ^5 or ^6
-- `@ant-design/icons` ^5 or ^6
-
 ## Install
 
 ```bash
@@ -96,6 +89,80 @@ The component defaults to Chinese (`zh_CN`) when the antd locale starts with `zh
 | `format`     | `Format`                   | `[]`    | Custom format options (`{ name: string; title?: string }[]`)                                |
 | `mock`       | `MockSource`               | —       | Mock data source; when provided, a mock column appears (`{ name: string; mock: string }[]`) |
 
+## Migrating from json-schema-editor-visual
+
+This is a fork of [Open-Federation/json-schema-editor-visual](https://github.com/Open-Federation/json-schema-editor-visual) with a redesigned API.
+
+### Install
+
+```bash
+# old
+npm install json-schema-editor-visual
+
+# new
+pnpm add @tyx1703/json-schema-editor-visual
+```
+
+### Factory function → Component
+
+```jsx
+// old
+const schemaEditor = require('json-schema-editor-visual/dist/main.js');
+const SchemaEditor = schemaEditor({ lang: 'zh_CN' });
+
+// new
+import JsonSchemaEditorVisual from '@tyx1703/json-schema-editor-visual';
+```
+
+### Locale via ConfigProvider
+
+```jsx
+// old
+const SchemaEditor = schemaEditor({ lang: 'zh_CN' });
+
+// new
+import { ConfigProvider } from 'antd';
+import zhCN from 'antd/locale/zh_CN';
+
+<ConfigProvider locale={zhCN}>
+  <JsonSchemaEditorVisual />
+</ConfigProvider>;
+```
+
+### Mock & Format → Props
+
+```jsx
+// old
+const SchemaEditor = schemaEditor({ mock: MOCK, format: FORMAT });
+
+// new
+<JsonSchemaEditorVisual mock={MOCK} format={FORMAT} />;
+```
+
+### CSS — no longer needed
+
+```jsx
+// old — required
+import 'antd/dist/antd.css';
+require('json-schema-editor-visual/dist/main.css');
+
+// new — nothing to import
+```
+
+### Breaking changes summary
+
+| Change        | Old                            | New                                  |
+| ------------- | ------------------------------ | ------------------------------------ |
+| Package name  | `json-schema-editor-visual`    | `@tyx1703/json-schema-editor-visual` |
+| Export        | Factory `schemaEditor(config)` | Direct component                     |
+| Locale        | `{ lang: 'zh_CN' }`            | antd `ConfigProvider`                |
+| Mock / Format | Factory options                | Component props                      |
+| CSS import    | Manual `main.css`              | Not needed                           |
+| React         | >=16.9.0                       | ^18 or ^19                           |
+| antd          | 4                              | ^5 or ^6                             |
+| Editor        | Ace                            | Monaco                               |
+| Model API     | `Model.schema`                 | Removed                              |
+
 ## Development
 
 This project is a pnpm monorepo.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tyx1703/json-schema-editor-visual",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A React component for visually editing JSON Schema",
   "type": "module",
   "license": "MIT",
@@ -30,6 +30,7 @@
     "LICENSE"
   ],
   "scripts": {
+    "prepack": "node ../../scripts/prepare-package.mjs",
     "build": "rslib",
     "build:test": "cross-env NODE_ENV='test' rslib",
     "dev": "rslib --watch",