@opencraw/studio 0.0.8 → 0.0.10

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.
Files changed (23) hide show
  1. package/README.md +31 -5
  2. package/dist/index.esm.js +1362 -1072
  3. package/dist/src/browser-provisioning/ensure-browser-launch.use-case.d.ts +12 -0
  4. package/dist/src/browser-provisioning/index.d.ts +2 -0
  5. package/dist/src/browser-provisioning/install-chromium.use-case.d.ts +2 -0
  6. package/dist/src/browser-provisioning/missing-browser.policy.d.ts +3 -0
  7. package/dist/src/document-view/index.d.ts +2 -0
  8. package/dist/src/document-view/region-preview.use-case.d.ts +30 -0
  9. package/dist/src/index.d.ts +4 -3
  10. package/dist/src/recipe-workspace/import-document.use-case.d.ts +22 -0
  11. package/dist/src/recipe-workspace/index.d.ts +2 -0
  12. package/dist/src/studio-api/command.contract.d.ts +41 -0
  13. package/dist/src/studio-api/import-document-view.contract.d.ts +8 -0
  14. package/dist/src/studio-api/index.d.ts +6 -2
  15. package/dist/src/studio-api/region-preview-view.contract.d.ts +53 -0
  16. package/dist/src/studio-server/import-document.handler.d.ts +14 -0
  17. package/dist/src/studio-server/open-workspace.handler.d.ts +8 -1
  18. package/dist/src/studio-server/region-preview.handler.d.ts +17 -0
  19. package/dist/ui/assets/index-CxiFCU_G.js +37 -0
  20. package/dist/ui/assets/{pdf-lqXfRfkR.js → pdf-4CYQHobd.js} +1 -1
  21. package/dist/ui/index.html +1 -1
  22. package/package.json +3 -3
  23. package/dist/ui/assets/index-DdiGdaTN.js +0 -13
package/README.md CHANGED
@@ -1,11 +1,37 @@
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/russoedu/open.craw/main/docs/assets/opencraw-logo.svg" alt="OpenCraw" width="360">
3
+ </p>
4
+
1
5
  # @opencraw/studio
2
6
 
3
- Generated by [MoNecromanCI](https://github.com/russoedu/MoNecromanCi).
7
+ A visual editor for [OpenCraw](https://github.com/russoedu/open.craw) recipes: open a site or a document,
8
+ click the data you want, and get a recipe that runs — the same engine, the same JSON files, no hidden state.
9
+
10
+ ## Install
11
+
12
+ ```sh
13
+ npm install -g @opencraw/cli @opencraw/studio
14
+ ```
15
+
16
+ ## Start
17
+
18
+ ```sh
19
+ opencraw studio recipes/ # the cli delegates to this package when it's installed
20
+ npx @opencraw/studio recipes/ # or run it directly, without the cli
21
+ ```
22
+
23
+ Either opens a local server (`127.0.0.1` only, behind a random access token) and prints the URL to open:
4
24
 
5
- ## Building
25
+ ```text
26
+ OpenCraw Studio: http://127.0.0.1:52341/?token=8f2a1c9e4b7d3f6a0e5c8b1d2a4f7e9c
27
+ Workspace: /home/you/project/recipes
28
+ ```
6
29
 
7
- Run `nx build @opencraw/studio` to build this project.
30
+ `recipes/` can already have `.input.json`/`.output.json` files in it, or be empty — the studio's own
31
+ **+ New recipe** writes a minimal, valid pair to start from.
8
32
 
9
- ## Running unit tests
33
+ ## Learn more
10
34
 
11
- Run `nx test @opencraw/studio` to execute the unit tests via [Jest](https://jestjs.io).
35
+ [**The OpenCraw Studio manual**](https://github.com/russoedu/open.craw/blob/main/docs/studio/manual.md)
36
+ builds one real recipe end to end, tab by tab: picking on a live page, the Record tab's mapping, the
37
+ document canvases (JSON, PDF, Excel/CSV, PowerPoint), recording a login, and the JSON editor.