@jentic/arazzo-ui 1.0.0-alpha.18 → 1.0.0-alpha.20
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/CHANGELOG.md +17 -0
- package/README.md +19 -3
- package/bin/arazzo-ui.mjs +46 -0
- package/dist/arazzo-ui-standalone.js +27 -27
- package/dist/arazzo-ui-standalone.mjs +37 -29
- package/dist/arazzo-ui.js +26 -26
- package/dist/arazzo-ui.mjs +29 -26
- package/package.json +9 -5
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,23 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [1.0.0-alpha.20](https://github.com/jentic/jentic-arazzo-tools/compare/v1.0.0-alpha.19...v1.0.0-alpha.20) (2026-02-24)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @jentic/arazzo-ui
|
|
9
|
+
|
|
10
|
+
# [1.0.0-alpha.19](https://github.com/jentic/jentic-arazzo-tools/compare/v1.0.0-alpha.18...v1.0.0-alpha.19) (2026-02-23)
|
|
11
|
+
|
|
12
|
+
### Bug Fixes
|
|
13
|
+
|
|
14
|
+
- **arazzo-ui:** fix demo URL ([418982e](https://github.com/jentic/jentic-arazzo-tools/commit/418982e231e83e509e2e0705d9a2029ea639b6ae))
|
|
15
|
+
|
|
16
|
+
### Features
|
|
17
|
+
|
|
18
|
+
- **arazoo-ui:** align with Arazzo logo color scheme ([#101](https://github.com/jentic/jentic-arazzo-tools/issues/101)) ([850fdca](https://github.com/jentic/jentic-arazzo-tools/commit/850fdca3d067c28b79b6590ed1cbf449b7d510a1))
|
|
19
|
+
- **arazzo-ui:** add CLI for opening any URL from command cli ([#103](https://github.com/jentic/jentic-arazzo-tools/issues/103)) ([6923e7b](https://github.com/jentic/jentic-arazzo-tools/commit/6923e7bdcb62e86266789e18ef6af5dc27459110)), closes [#96](https://github.com/jentic/jentic-arazzo-tools/issues/96)
|
|
20
|
+
- **arazzo-ui:** add support for document url query param ([2a1aed6](https://github.com/jentic/jentic-arazzo-tools/commit/2a1aed6cb1f07bcbe9a0cd7fd9d2e04cc27cf599))
|
|
21
|
+
- **arazzo-ui:** provide Arazzo favicon ([019b45d](https://github.com/jentic/jentic-arazzo-tools/commit/019b45d42a8746b23e7328d5d03ce9328e82fb70))
|
|
22
|
+
|
|
6
23
|
# [1.0.0-alpha.18](https://github.com/jentic/jentic-arazzo-tools/compare/v1.0.0-alpha.17...v1.0.0-alpha.18) (2026-02-20)
|
|
7
24
|
|
|
8
25
|
**Note:** Version bump only for package @jentic/arazzo-ui
|
package/README.md
CHANGED
|
@@ -3,14 +3,20 @@
|
|
|
3
3
|
`@jentic/arazzo-ui` is a UI component for visualizing [Arazzo Specification](https://spec.openapis.org/arazzo/latest.html) workflows.
|
|
4
4
|
It provides interactive diagram views, documentation views, and a split view combining both.
|
|
5
5
|
|
|
6
|
-
[](https://arazzo-ui.jentic.com)
|
|
7
7
|
|
|
8
8
|
<p align="center">
|
|
9
|
-
<a href="https://jentic.
|
|
10
|
-
<img src="https://
|
|
9
|
+
<a href="https://arazzo-ui.jentic.com">
|
|
10
|
+
<img src="https://raw.githubusercontent.com/jentic/jentic-arazzo-tools/main/assets/arazzo-ui.png" alt="ArazzoUI Screenshot" />
|
|
11
11
|
</a>
|
|
12
12
|
</p>
|
|
13
13
|
|
|
14
|
+
Load any Arazzo Document by appending a `?document=` query parameter:
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
https://arazzo-ui.jentic.com?document=https://arazzo-ui.jentic.com/petstore-order-workflow.arazzo.yaml
|
|
18
|
+
```
|
|
19
|
+
|
|
14
20
|
**Supported Arazzo versions:**
|
|
15
21
|
- [Arazzo 1.0.0](https://spec.openapis.org/arazzo/v1.0.0)
|
|
16
22
|
- [Arazzo 1.0.1](https://spec.openapis.org/arazzo/v1.0.1)
|
|
@@ -25,6 +31,16 @@ npm install @jentic/arazzo-ui
|
|
|
25
31
|
|
|
26
32
|
**Peer dependencies:** React 18 or 19 ([react](https://www.npmjs.com/package/react) and [react-dom](https://www.npmjs.com/package/react-dom)).
|
|
27
33
|
|
|
34
|
+
## CLI
|
|
35
|
+
|
|
36
|
+
Open any Arazzo document in the browser without installing anything locally:
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
npx @jentic/arazzo-ui https://arazzo-ui.jentic.com/petstore-order-workflow.arazzo.yaml
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
This opens `https://arazzo-ui.jentic.com` with the document pre-loaded.
|
|
43
|
+
|
|
28
44
|
## Components
|
|
29
45
|
|
|
30
46
|
### ArazzoUI
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
import { execFile } from 'node:child_process';
|
|
4
|
+
|
|
5
|
+
const BASE_URL = 'https://arazzo-ui.jentic.com';
|
|
6
|
+
|
|
7
|
+
function openBrowser(url) {
|
|
8
|
+
const { platform } = process;
|
|
9
|
+
|
|
10
|
+
const onError = (error) => {
|
|
11
|
+
if (error) {
|
|
12
|
+
console.error(`Could not open browser. Visit the URL manually:\n${url}`);
|
|
13
|
+
}
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
if (platform === 'darwin') {
|
|
17
|
+
execFile('open', [url], onError);
|
|
18
|
+
} else if (platform === 'win32') {
|
|
19
|
+
execFile('cmd', ['/c', 'start', '', url], onError);
|
|
20
|
+
} else {
|
|
21
|
+
execFile('xdg-open', [url], onError);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
const url = process.argv[2];
|
|
26
|
+
|
|
27
|
+
if (!url || url === '--help' || url === '-h') {
|
|
28
|
+
console.log('Usage: arazzo-ui <url>\n');
|
|
29
|
+
console.log('Open an Arazzo document in the browser.\n');
|
|
30
|
+
console.log('Example:');
|
|
31
|
+
console.log(
|
|
32
|
+
' npx @jentic/arazzo-ui https://arazzo-ui.jentic.com/petstore-order-workflow.arazzo.yaml',
|
|
33
|
+
);
|
|
34
|
+
process.exit(url ? 0 : 1);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
try {
|
|
38
|
+
new URL(url);
|
|
39
|
+
} catch {
|
|
40
|
+
console.error(`Invalid URL: ${url}\nPlease provide a valid URL to an Arazzo document.`);
|
|
41
|
+
process.exit(1);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
const viewerURL = `${BASE_URL}?document=${encodeURIComponent(url)}`;
|
|
45
|
+
console.log(`Opening ${viewerURL}`);
|
|
46
|
+
openBrowser(viewerURL);
|