rapipdf 2.2.1 → 3.0.0
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 +66 -14
- package/dist/chunks/generate-BQLGaRvK.js +386 -0
- package/dist/chunks/generate-BQLGaRvK.js.LICENSE.txt +224 -0
- package/dist/chunks/localize-CRvDVkIz.js +8 -0
- package/dist/node.js +13096 -0
- package/dist/node.js.LICENSE.txt +195 -0
- package/dist/rapipdf-min.js +352 -90
- package/dist/rapipdf-min.js.LICENSE.txt +224 -0
- package/dist/rapipdf.js +69 -0
- package/package.json +58 -52
- package/src/node.d.ts +82 -0
- package/src/rapipdf.d.ts +50 -0
- package/.babelrc +0 -11
- package/.eslintrc +0 -28
- package/dist/index.html +0 -7
- package/dist/index.html.gz +0 -0
- package/dist/rapipdf-min.js.gz +0 -0
- package/dist/rapipdf-min.js.map +0 -1
- package/dist/rapipdf-min.js.map.gz +0 -0
- package/dist/report.html +0 -53
- package/docs/api.html +0 -285
- package/docs/examples/example1.html +0 -68
- package/docs/examples/list.html +0 -27
- package/docs/examples/rapidoc-regular.woff2 +0 -0
- package/docs/examples/rapidoc-semi-bold.woff2 +0 -0
- package/docs/examples/roboto-mono-bold.woff2 +0 -0
- package/docs/examples/roboto-mono-regular.woff2 +0 -0
- package/docs/highlight/CHANGES.md +0 -1803
- package/docs/highlight/LICENSE +0 -24
- package/docs/highlight/README.md +0 -188
- package/docs/highlight/README.ru.md +0 -142
- package/docs/highlight/highlight.pack.js +0 -2
- package/docs/highlight/styles/a11y-dark.css +0 -99
- package/docs/highlight/styles/a11y-light.css +0 -99
- package/docs/highlight/styles/agate.css +0 -108
- package/docs/highlight/styles/an-old-hope.css +0 -89
- package/docs/highlight/styles/androidstudio.css +0 -66
- package/docs/highlight/styles/arduino-light.css +0 -88
- package/docs/highlight/styles/arta.css +0 -73
- package/docs/highlight/styles/ascetic.css +0 -45
- package/docs/highlight/styles/atelier-cave-dark.css +0 -83
- package/docs/highlight/styles/atelier-cave-light.css +0 -85
- package/docs/highlight/styles/atelier-dune-dark.css +0 -69
- package/docs/highlight/styles/atelier-dune-light.css +0 -69
- package/docs/highlight/styles/atelier-estuary-dark.css +0 -84
- package/docs/highlight/styles/atelier-estuary-light.css +0 -84
- package/docs/highlight/styles/atelier-forest-dark.css +0 -69
- package/docs/highlight/styles/atelier-forest-light.css +0 -69
- package/docs/highlight/styles/atelier-heath-dark.css +0 -69
- package/docs/highlight/styles/atelier-heath-light.css +0 -69
- package/docs/highlight/styles/atelier-lakeside-dark.css +0 -69
- package/docs/highlight/styles/atelier-lakeside-light.css +0 -69
- package/docs/highlight/styles/atelier-plateau-dark.css +0 -84
- package/docs/highlight/styles/atelier-plateau-light.css +0 -84
- package/docs/highlight/styles/atelier-savanna-dark.css +0 -84
- package/docs/highlight/styles/atelier-savanna-light.css +0 -84
- package/docs/highlight/styles/atelier-seaside-dark.css +0 -69
- package/docs/highlight/styles/atelier-seaside-light.css +0 -69
- package/docs/highlight/styles/atelier-sulphurpool-dark.css +0 -69
- package/docs/highlight/styles/atelier-sulphurpool-light.css +0 -69
- package/docs/highlight/styles/atom-one-dark-reasonable.css +0 -77
- package/docs/highlight/styles/atom-one-dark.css +0 -96
- package/docs/highlight/styles/atom-one-light.css +0 -96
- package/docs/highlight/styles/brown-paper.css +0 -64
- package/docs/highlight/styles/brown-papersq.png +0 -0
- package/docs/highlight/styles/codepen-embed.css +0 -60
- package/docs/highlight/styles/color-brewer.css +0 -71
- package/docs/highlight/styles/darcula.css +0 -77
- package/docs/highlight/styles/dark.css +0 -63
- package/docs/highlight/styles/darkula.css +0 -6
- package/docs/highlight/styles/default.css +0 -99
- package/docs/highlight/styles/docco.css +0 -97
- package/docs/highlight/styles/dracula.css +0 -76
- package/docs/highlight/styles/far.css +0 -71
- package/docs/highlight/styles/foundation.css +0 -88
- package/docs/highlight/styles/github-gist.css +0 -71
- package/docs/highlight/styles/github.css +0 -99
- package/docs/highlight/styles/gml.css +0 -78
- package/docs/highlight/styles/googlecode.css +0 -89
- package/docs/highlight/styles/grayscale.css +0 -101
- package/docs/highlight/styles/gruvbox-dark.css +0 -108
- package/docs/highlight/styles/gruvbox-light.css +0 -108
- package/docs/highlight/styles/hopscotch.css +0 -83
- package/docs/highlight/styles/hybrid.css +0 -102
- package/docs/highlight/styles/idea.css +0 -97
- package/docs/highlight/styles/ir-black.css +0 -73
- package/docs/highlight/styles/isbl-editor-dark.css +0 -112
- package/docs/highlight/styles/isbl-editor-light.css +0 -112
- package/docs/highlight/styles/kimbie.dark.css +0 -74
- package/docs/highlight/styles/kimbie.light.css +0 -74
- package/docs/highlight/styles/lightfair.css +0 -87
- package/docs/highlight/styles/magula.css +0 -70
- package/docs/highlight/styles/mono-blue.css +0 -59
- package/docs/highlight/styles/monokai-sublime.css +0 -83
- package/docs/highlight/styles/monokai.css +0 -70
- package/docs/highlight/styles/nord.css +0 -309
- package/docs/highlight/styles/obsidian.css +0 -88
- package/docs/highlight/styles/ocean.css +0 -74
- package/docs/highlight/styles/paraiso-dark.css +0 -72
- package/docs/highlight/styles/paraiso-light.css +0 -72
- package/docs/highlight/styles/pojoaque.css +0 -83
- package/docs/highlight/styles/pojoaque.jpg +0 -0
- package/docs/highlight/styles/purebasic.css +0 -96
- package/docs/highlight/styles/qtcreator_dark.css +0 -83
- package/docs/highlight/styles/qtcreator_light.css +0 -83
- package/docs/highlight/styles/railscasts.css +0 -106
- package/docs/highlight/styles/rainbow.css +0 -85
- package/docs/highlight/styles/routeros.css +0 -108
- package/docs/highlight/styles/school-book.css +0 -72
- package/docs/highlight/styles/school-book.png +0 -0
- package/docs/highlight/styles/shades-of-purple.css +0 -97
- package/docs/highlight/styles/solarized-dark.css +0 -84
- package/docs/highlight/styles/solarized-light.css +0 -84
- package/docs/highlight/styles/sunburst.css +0 -102
- package/docs/highlight/styles/tomorrow-night-blue.css +0 -75
- package/docs/highlight/styles/tomorrow-night-bright.css +0 -74
- package/docs/highlight/styles/tomorrow-night-eighties.css +0 -74
- package/docs/highlight/styles/tomorrow-night.css +0 -75
- package/docs/highlight/styles/tomorrow.css +0 -72
- package/docs/highlight/styles/vs.css +0 -68
- package/docs/highlight/styles/vs2015.css +0 -115
- package/docs/highlight/styles/xcode.css +0 -104
- package/docs/highlight/styles/xt256.css +0 -92
- package/docs/highlight/styles/zenburn.css +0 -80
- package/docs/images/console.svg +0 -12
- package/docs/images/dark_ss.png +0 -0
- package/docs/images/easy.svg +0 -14
- package/docs/images/fast.svg +0 -8
- package/docs/images/gears.svg +0 -11
- package/docs/images/light_ss.png +0 -0
- package/docs/images/logo-outline.png +0 -0
- package/docs/images/logo.png +0 -0
- package/docs/images/love.svg +0 -8
- package/docs/images/mask.svg +0 -16
- package/docs/images/mouse.svg +0 -7
- package/docs/images/pdf_sample1.png +0 -0
- package/docs/images/pdf_sample2.png +0 -0
- package/docs/images/webcomponent.svg +0 -13
- package/docs/index.css +0 -257
- package/docs/index.html +0 -186
- package/docs/rapipdf-min.js +0 -95
- package/docs/specs/allof-primitives.json +0 -80
- package/docs/specs/allof.json +0 -73
- package/docs/specs/anyof.json +0 -84
- package/docs/specs/basic.json +0 -75
- package/docs/specs/bitbucket.json +0 -12916
- package/docs/specs/data-types.yaml +0 -168
- package/docs/specs/gcloud.json +0 -1347
- package/docs/specs/no-server.json +0 -1
- package/docs/specs/oneof.json +0 -64
- package/docs/specs/petstore.json +0 -1042
- package/docs/specs/petstore_extended.yaml +0 -889
- package/docs/specs/temp.json +0 -53
- package/docs/specs/test-specs/large-models.json +0 -5998
- package/docs/specs/test-specs/long-descriptions.json +0 -5443
- package/docs/specs/test-specs/long-paths.json +0 -9562
- package/docs/specs/test-specs/oneof-allof-nested.yaml +0 -105
- package/docs/specs/test-specs/partial-spec-main.json +0 -29
- package/docs/specs/test-specs/partial.json +0 -17
- package/docs/specs/test-specs/petstore_complex_request.yaml +0 -335
- package/docs/specs/test-specs/petstore_experimental.yaml +0 -167
- package/docs/specs/test-specs/xxx-of-with-primitives-and-recursive-model.yaml +0 -952
- package/docs/welcome.html +0 -186
- package/index.html +0 -48
- package/logo.png +0 -0
- package/src/index.js +0 -3
- package/src/markdown.js +0 -120
- package/src/object-tree-gen.js +0 -370
- package/src/pdf-gen.js +0 -113
- package/src/pdf-parts-gen.js +0 -488
- package/src/rapipdf.js +0 -246
- package/src/spec-parser.js +0 -178
- package/src/table-layouts.js +0 -35
- package/src/vfs_fonts.js +0 -7
- package/webpack.config.js +0 -118
package/README.md
CHANGED
|
@@ -1,35 +1,87 @@
|
|
|
1
1
|
<img alt="MrinDoc logo" src="https://github.com/mrin9/RapiPdf/blob/master/logo.png" width="60px" />
|
|
2
2
|
|
|
3
|
-
|
|
4
3
|
<p align="center">
|
|
5
4
|
<img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square"/>
|
|
6
5
|
<img src="https://img.shields.io/github/size/mrin9/rapipdf/dist/rapipdf-min.js.svg?colorB=blue&label=minified&style=flat-square">
|
|
7
6
|
<img src="https://img.shields.io/github/size/mrin9/rapipdf/dist/rapipdf-min.js.gz.svg?colorB=blue&label=zip&style=flat-square">
|
|
8
|
-
</p>
|
|
7
|
+
</p>
|
|
9
8
|
|
|
10
9
|
# RapiPDF
|
|
11
|
-
|
|
10
|
+
|
|
11
|
+
Custom element for Open-API to PDF generation
|
|
12
12
|
|
|
13
13
|
## Features
|
|
14
|
-
|
|
15
|
-
-
|
|
14
|
+
|
|
15
|
+
- Supports Swagger 2.0 and OpenAPI 3.0
|
|
16
|
+
- Generate PDF using Web-Component
|
|
16
17
|
- Works with any framework or with no framework
|
|
17
18
|
- Plenty of customizing options, including selection of brand colors
|
|
18
19
|
- Supported on Chrome, FireFox and Safari. (Not yet tested on Edge)
|
|
19
20
|
|
|
20
21
|
## Documentation
|
|
22
|
+
|
|
21
23
|
[Check out the usage and examples](https://mrin9.github.io/RapiPdf/)
|
|
22
24
|
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
One file, from a CDN or your own server:
|
|
28
|
+
|
|
29
|
+
```html
|
|
30
|
+
<script src="https://unpkg.com/rapipdf/dist/rapipdf-min.js"></script>
|
|
31
|
+
<rapi-pdf spec-url="https://petstore.swagger.io/v2/swagger.json"></rapi-pdf>
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
With a bundler, `import "rapipdf"` registers the element. This build is a few kilobytes and fetches the PDF generator the first time a PDF is asked for.
|
|
35
|
+
|
|
36
|
+
| Attribute | What it does |
|
|
37
|
+
| :----------------------------------------------------------------------------------- | :--------------------------------------------------------------- |
|
|
38
|
+
| `spec-url` | The spec: OpenAPI 3.x or Swagger 2.0, JSON or YAML |
|
|
39
|
+
| `output` | `open` (default) shows the PDF in a new tab; `download` saves it |
|
|
40
|
+
| `file-name` | Name of the downloaded file (default `api-reference.pdf`) |
|
|
41
|
+
| `pdf-title`, `pdf-footer-text` | Cover title and page footer |
|
|
42
|
+
| `pdf-primary-color`, `pdf-alternate-color` | The two colors of the PDF |
|
|
43
|
+
| `pdf-schema-style` | `object` (default) or `table` |
|
|
44
|
+
| `pdf-sort-tags` | `false` keeps the tags in the spec's order |
|
|
45
|
+
| `include-info`, `include-toc`, `include-security`, `include-api-details` | `false` leaves the section out |
|
|
46
|
+
| `include-example`, `include-api-list` | `true` adds examples, and a closing list of operations |
|
|
47
|
+
| `button-label`, `button-bg`, `button-color`, `input-bg`, `input-color`, `hide-input` | The element's own look |
|
|
48
|
+
|
|
49
|
+
```js
|
|
50
|
+
const el = document.querySelector("rapi-pdf");
|
|
51
|
+
await el.generatePdf(); // open or download, as `output` says
|
|
52
|
+
await el.generatePdf(specObject); // a spec object or spec text instead of spec-url
|
|
53
|
+
const blob = await el.getPdfBlob(); // the PDF itself, nothing opened or downloaded
|
|
54
|
+
|
|
55
|
+
el.addEventListener("pdf-generated", (e) => console.log(e.detail.output));
|
|
56
|
+
el.addEventListener("pdf-error", (e) => console.error(e.detail.error));
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
While a PDF is being made the element has the `generating` attribute and its button is disabled. If the browser blocks the new tab, the PDF is downloaded instead.
|
|
60
|
+
|
|
61
|
+
## In Node and on the command line
|
|
62
|
+
|
|
63
|
+
```js
|
|
64
|
+
import { writeFile } from "node:fs/promises";
|
|
65
|
+
import { generatePdf } from "rapipdf/node";
|
|
66
|
+
|
|
67
|
+
await writeFile("reference.pdf", await generatePdf("openapi.yaml", { pdfTitle: "Orders API" }));
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
The [`rapidoc`](https://www.npmjs.com/package/@rapidoc/cli) command does the same: `npx rapidoc pdf openapi.yaml`.
|
|
71
|
+
|
|
23
72
|
## Build Process
|
|
24
|
-
|
|
73
|
+
|
|
74
|
+
RapiPdf is built in the [RapiDoc monorepo](https://github.com/rapi-doc/RapiDoc) (`packages/rapipdf`), from its root:
|
|
75
|
+
|
|
25
76
|
```bash
|
|
26
|
-
|
|
27
|
-
|
|
77
|
+
npm install
|
|
78
|
+
|
|
79
|
+
# builds packages/rapipdf/dist: rapipdf-min.js (one file), rapipdf.js (ES module) and node.js
|
|
80
|
+
npm run build:rapipdf
|
|
28
81
|
|
|
29
|
-
#
|
|
30
|
-
|
|
31
|
-
yarn build
|
|
82
|
+
# builds, then checks the generated PDFs against the baseline (needs Chrome)
|
|
83
|
+
npm run test:rapipdf
|
|
32
84
|
|
|
33
|
-
#
|
|
34
|
-
|
|
35
|
-
```
|
|
85
|
+
# development page on a Vite dev server
|
|
86
|
+
npm run dev --workspace=rapipdf
|
|
87
|
+
```
|