datacontract-editor 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -8
- package/dist/{cssMode-CzVfCu2q.js → cssMode-BoVWulKV.js} +1 -1
- package/dist/datacontract-editor.css +1 -1
- package/dist/datacontract-editor.es.js +1 -1
- package/dist/{embed-BE-6FjUW.js → embed-yrOtk_lG.js} +21910 -21708
- package/dist/{freemarker2-DuISTfha.js → freemarker2-C4Imb4UF.js} +1 -1
- package/dist/{handlebars-CF6nf90Y.js → handlebars-Dpgc8rzt.js} +1 -1
- package/dist/{html-Bd2leUjH.js → html-xjtrvWbc.js} +1 -1
- package/dist/{htmlMode-D5ZCqfos.js → htmlMode-BoHcn1kx.js} +1 -1
- package/dist/index.html +7 -3
- package/dist/{javascript-DM0zQPyb.js → javascript-CnjotNG-.js} +1 -1
- package/dist/{jsonMode-kmlqwbu7.js → jsonMode-DTcm72fY.js} +1 -1
- package/dist/{liquid-BqQPT6Qf.js → liquid-BONgCFz5.js} +1 -1
- package/dist/{mdx-8KgfCRJw.js → mdx-EGJ0P1ky.js} +1 -1
- package/dist/{python-CmHenqwx.js → python-h_TnfyN_.js} +1 -1
- package/dist/{razor-D0q5qc6y.js → razor-DnDxOyC_.js} +1 -1
- package/dist/{tsMode-DiTuI5n4.js → tsMode-TqmC4AwV.js} +1 -1
- package/dist/{typescript-ozsvnTYx.js → typescript-DLRq2sRy.js} +1 -1
- package/dist/{xml-oViOWYBd.js → xml-Du2bjeJj.js} +1 -1
- package/dist/{yaml-BdXw910y.js → yaml-CKc6p_JG.js} +1 -1
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -2,34 +2,55 @@
|
|
|
2
2
|
|
|
3
3
|
A web-based editor for creating and managing data contracts using the [Open Data Contract Standard](https://bitol-io.github.io/open-data-contract-standard/latest/) (ODCS).
|
|
4
4
|
|
|
5
|
-

|
|
5
|
+

|
|
6
6
|
|
|
7
7
|
## Features
|
|
8
8
|
|
|
9
|
+
- **Open Data Contract Standard**: ODCS is the industry-standard for data contracts. Now with support for v3.1.0.
|
|
9
10
|
- **Editing Modes**:
|
|
10
11
|
- **Visual Editor**: Define data models and relationships using a visual interface
|
|
11
|
-
- **Form Editor**: Get guided input
|
|
12
|
-
- **YAML Editor**: Edit data contracts in YAML format
|
|
13
|
-
- **
|
|
12
|
+
- **Form Editor**: Get guided input with a simple form interface
|
|
13
|
+
- **YAML Editor**: Edit data contracts directly in YAML format with code completion
|
|
14
|
+
- **Preview**: Live preview of data contracts as HTML
|
|
14
15
|
- **Validation**: Get instant feedback on your data contracts
|
|
15
|
-
- **
|
|
16
|
+
- **Test**: Test your data contract directly against your data using the Data Contract CLI API Server.
|
|
16
17
|
|
|
17
18
|
|
|
18
19
|
## Usage
|
|
19
20
|
|
|
20
21
|
### Web Editor
|
|
21
22
|
|
|
23
|
+
Open the editor as web application:
|
|
24
|
+
|
|
22
25
|
https://editor.datacontract.com
|
|
23
26
|
|
|
24
27
|
|
|
25
28
|
### Standalone Application
|
|
26
29
|
|
|
27
|
-
|
|
30
|
+
You can start the editor locally using the following command:
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
npx datacontract-editor
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Or edit a data contract file directly:
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
npx datacontract-editor mydatacontract.odcs.yaml
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
### Docker
|
|
45
|
+
|
|
46
|
+
Run the editor locally in a Docker container:
|
|
28
47
|
|
|
29
48
|
```
|
|
30
|
-
|
|
49
|
+
docker run -d -p 4173:4173 datacontract/editor
|
|
31
50
|
```
|
|
32
51
|
|
|
52
|
+
Then open http://localhost:4173
|
|
53
|
+
|
|
33
54
|
|
|
34
55
|
### Data Contract CLI
|
|
35
56
|
|
|
@@ -45,7 +66,7 @@ datacontract editor datacontract.yaml
|
|
|
45
66
|
|
|
46
67
|
### Entropy Data
|
|
47
68
|
|
|
48
|
-
[Entropy Data](https://entropy-data.com)
|
|
69
|
+
The Data Contract Editor is fully integrated in our commercial product [Entropy Data](https://entropy-data.com) to manage multiple data contracts in a single application.
|
|
49
70
|
|
|
50
71
|
|
|
51
72
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { m as tt } from "./embed-
|
|
1
|
+
import { m as tt } from "./embed-yrOtk_lG.js";
|
|
2
2
|
var rt = Object.defineProperty, nt = Object.getOwnPropertyDescriptor, it = Object.getOwnPropertyNames, ot = Object.prototype.hasOwnProperty, at = (e, n, i, r) => {
|
|
3
3
|
if (n && typeof n == "object" || typeof n == "function")
|
|
4
4
|
for (let t of it(n))
|