rapidoc 9.1.7 → 9.3.0

package/.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: rapidoc
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: ['paypal.me/mrin'] # Replace with up to 4 custom sponsorship URLs e.g., 

package/CONTRIBUTING.md

@@ -22,7 +22,7 @@
 
 For development 
 ```shell
-git clone https://github.com/mrin9/RapiDoc.git
+git clone https://github.com/rapi-doc/RapiDoc.git
 yarn install
 yarn serve
 # open http://localhost:8080

package/LICENSE.txt

@@ -1,5 +1,7 @@
 MIT License
 
+Copyright (c) 2022 Mrinmoy Majumdar
+
 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
@@ -17,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,10 +1,13 @@
-<img alt="MrinDoc logo" src="https://github.com/mrin9/RapiDoc/blob/master/logo.png" width="60px" />
+<img alt="MrinDoc logo" src="https://github.com/rapi-doc/RapiDoc/blob/master/logo.png" width="60px" />
 
 
 <p align="center">
     <img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square"/>
-    <img src="https://img.shields.io/github/size/mrin9/rapidoc/dist/rapidoc-min.js.svg?colorB=blue&label=minified&style=flat-square">
-    <img src="https://img.shields.io/github/size/mrin9/rapidoc/dist/rapidoc-min.js.gz.svg?colorB=blue&label=zip&style=flat-square">
+    <img src="https://img.shields.io/github/size/rapi-doc/rapidoc/dist/rapidoc-min.js.svg?colorB=blue&label=minified&style=flat-square">
+    <img src="https://img.shields.io/github/size/rapi-doc/rapidoc/dist/rapidoc-min.js.gz.svg?colorB=blue&label=zip&style=flat-square">
+    <a href="https://discord.gg/X9evUeFY" alt="Join us on Discord">
+        <img src="https://img.shields.io/discord/848913990360629268?style=flat-square" />
+    </a>
     <a href="https://www.webcomponents.org/element/rapidoc" alt="published on webcomponents.org">
         <img src="https://img.shields.io/badge/webcomponents.org-rapidoc-blue.svg?style=social"/>
     </a>
@@ -13,6 +16,10 @@
 # RapiDoc
 Custom Element for Open-API spec viewing
 
+Join the [RapiDoc community on Discord](https://discord.gg/X9evUeFY)
+
+Sponsored by [Zuplo](https://zuplo.link/rapidoc-2) - Get a Stripe-like API experience for your customers in minutes - documentation, rate-limiting and API-key auth in minutes. 
+
 ## Features
 - Supports Swagger 2.0, OpenAPI 3.x.x 
 - Works with any framework or with no framework
@@ -42,10 +49,10 @@ Custom Element for Open-API spec viewing
 
 
 ## Documentation
-[Check out the usage and demos](https://mrin9.github.io/RapiDoc/)
+[Check out the usage and demos](https://rapi-doc.github.io/RapiDoc/)
 
 ## Examples
-[Examples and Test cases](https://mrin9.github.io/RapiDoc/list.html)
+[Examples and Test cases](https://rapi-doc.github.io/RapiDoc/list.html)
 
 
 ## Build Process
@@ -61,4 +68,15 @@ npm run build
 npm run serve
 ```
 
-## Contribution
+## Roadmap
+- ✅ Upgrade to use `lit 2`
+- Pre Rendering / Server Side Rendering (SSR) of RapiDoc
+- Improve PDF generation of OpenAPI spec Using RapiPDF
+- Create a Command Line interface (CLI) to make it automation friendly
+- Add localization support
+- Follow Web Content Accessibility Guidelines (WCAG 2)
+- Improve Homepage, Documentation and Examples
+- Create groundwork for automated testing
+- Create a live playground (Something like swagger editor)
+- Create a short animation/video to show how RapiDoc/RapiPDF works
+

package/index.html

@@ -28,24 +28,26 @@
     https://assets.zuora.com/zuora-documentation/swagger.yaml <<< Large spec with lot of markdown
     ./specs/petstore_anyof.yaml <<< contains complex one-of with inline primitives and recursive objects
     ./specs/oneof1.yaml  <<< nested oneof
+    https://cesdev.eng.sonicwall.com/api/q/openapi
 -->
 <rapi-doc 
-  spec-url = "./specs/temp.yaml" 
+  spec-url = "./specs/data-types.yaml" 
   id="thedoc" 
   theme = "dark"
   render-style="read" 
-  schema-style="tree"
-  use-path-in-nav-bar="true"
+  schema-style="table"
+  show-method-in-nav-bar = "true"
+  use-path-in-nav-bar = "true"
   show-components = "true"
   show-info = "true"
   show-header = "true"
   allow-search = "false"  
   allow-advanced-search = "true"
   allow-spec-url-load="false"
-  allow-spec-file-load="false"
   allow-spec-file-download="true"
   allow-server-selection = "true"
   allow-authentication	= "true"
+  use-summary-to-list-example = "true"
   update-route="false"
   match-type="regex"
   persist-auth="true"

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "rapidoc",
-  "version": "9.1.7",
+  "version": "9.3.0",
   "description": "RapiDoc - Open API spec viewer with built in console",
   "author": "Mrinmoy Majumdar <mrin9@yahoo.com>",
+  "homepage": "https://rapidocweb.com",
   "repository": {
     "type": "git",
-    "url": "https://github.com/mrin9/RapiDoc.git"
+    "url": "https://github.com/rapi-doc/RapiDoc.git"
   },
   "license": "MIT",
   "keywords": [
@@ -32,13 +33,12 @@
   "module": "dist/rapidoc-min.js",
   "mode": "production",
   "dependencies": {
-    "@apitools/openapi-parser": "^0.0.14",
+    "@apitools/openapi-parser": "^0.0.24",
     "base64-arraybuffer": "^1.0.2",
     "buffer": "^6.0.3",
-    "lit-element": "2.5.1",
-    "lit-html": "1.4.1",
-    "marked": "^4.0.12",
-    "prismjs": "^1.26.0"
+    "lit": "^2.2.4",
+    "marked": "^4.0.16",
+    "prismjs": "^1.28.0"
   },
   "scripts": {
     "build": "NODE_ENV=production webpack --mode=production",
@@ -50,18 +50,18 @@
     "lint-fix": "./node_modules/eslint/bin/eslint.js --fix ./src/**"
   },
   "devDependencies": {
-    "@babel/core": "^7.17.5",
+    "@babel/core": "^7.18.0",
     "@babel/eslint-parser": "^7.17.0",
-    "@babel/preset-env": "^7.16.11",
-    "babel-loader": "^8.2.3",
+    "@babel/preset-env": "^7.18.0",
+    "babel-loader": "^8.2.5",
     "babel-plugin-template-html-minifier": "^4.1.0",
     "clean-webpack-plugin": "^4.0.0",
-    "compression-webpack-plugin": "^9.2.0",
-    "css-loader": "^6.6.0",
-    "eslint": "^8.9.0",
+    "compression-webpack-plugin": "^10.0.0",
+    "css-loader": "^6.7.1",
+    "eslint": "^8.16.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-import-resolver-webpack": "^0.13.2",
-    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-webpack-plugin": "3.1.1",
     "file-loader": "^6.2.0",
     "filemanager-webpack-plugin": "^6.1.7",
@@ -70,10 +70,10 @@
     "style-loader": "^3.3.1",
     "terser-webpack-plugin": "^5.3.1",
     "unminified-webpack-plugin": "^3.0.0",
-    "webpack": "^5.69.1",
+    "webpack": "^5.72.1",
     "webpack-bundle-analyzer": "^4.5.0",
     "webpack-cli": "^4.9.2",
-    "webpack-dev-server": "^4.7.4"
+    "webpack-dev-server": "^4.9.0"
   },
   "engines": {
     "node": ">=10.21.0"