docusaurus-plugin-openapi-docs 1.0.4 → 1.1.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.
Files changed (56) hide show
  1. package/README.md +5 -4
  2. package/lib/index.js +3 -3
  3. package/lib/markdown/createSchemaDetails.js +325 -132
  4. package/lib/markdown/index.js +1 -0
  5. package/lib/markdown/schema.js +25 -9
  6. package/lib/markdown/utils.d.ts +1 -1
  7. package/lib/markdown/utils.js +4 -1
  8. package/lib/openapi/openapi.d.ts +5 -5
  9. package/lib/openapi/openapi.js +27 -23
  10. package/lib/openapi/openapi.test.js +1 -1
  11. package/lib/openapi/types.d.ts +2 -1
  12. package/lib/openapi/utils/loadAndResolveSpec.d.ts +2 -0
  13. package/lib/openapi/utils/loadAndResolveSpec.js +112 -0
  14. package/lib/openapi/utils/services/OpenAPIParser.d.ts +52 -0
  15. package/lib/openapi/utils/services/OpenAPIParser.js +342 -0
  16. package/lib/openapi/utils/services/RedocNormalizedOptions.d.ts +100 -0
  17. package/lib/openapi/utils/services/RedocNormalizedOptions.js +170 -0
  18. package/lib/openapi/utils/types/index.d.ts +2 -0
  19. package/lib/openapi/utils/types/index.js +23 -0
  20. package/lib/openapi/utils/types/open-api.d.ts +305 -0
  21. package/lib/openapi/utils/types/open-api.js +8 -0
  22. package/lib/openapi/utils/utils/JsonPointer.d.ts +51 -0
  23. package/lib/openapi/utils/utils/JsonPointer.js +95 -0
  24. package/lib/openapi/utils/utils/helpers.d.ts +43 -0
  25. package/lib/openapi/utils/utils/helpers.js +230 -0
  26. package/lib/openapi/utils/utils/index.d.ts +3 -0
  27. package/lib/openapi/utils/utils/index.js +25 -0
  28. package/lib/openapi/utils/utils/openapi.d.ts +40 -0
  29. package/lib/openapi/utils/utils/openapi.js +605 -0
  30. package/lib/options.js +1 -1
  31. package/lib/sidebars/index.js +9 -5
  32. package/lib/types.d.ts +1 -1
  33. package/package.json +16 -11
  34. package/src/index.ts +3 -3
  35. package/src/markdown/createSchemaDetails.ts +405 -159
  36. package/src/markdown/index.ts +1 -0
  37. package/src/markdown/schema.ts +28 -8
  38. package/src/markdown/utils.ts +5 -2
  39. package/src/openapi/openapi.test.ts +1 -1
  40. package/src/openapi/openapi.ts +39 -29
  41. package/src/openapi/types.ts +2 -1
  42. package/src/openapi/utils/loadAndResolveSpec.ts +123 -0
  43. package/src/openapi/utils/services/OpenAPIParser.ts +433 -0
  44. package/src/openapi/utils/services/RedocNormalizedOptions.ts +330 -0
  45. package/src/openapi/utils/types/index.ts +10 -0
  46. package/src/openapi/utils/types/open-api.ts +303 -0
  47. package/src/openapi/utils/utils/JsonPointer.ts +99 -0
  48. package/src/openapi/utils/utils/helpers.ts +239 -0
  49. package/src/openapi/utils/utils/index.ts +11 -0
  50. package/src/openapi/utils/utils/openapi.ts +771 -0
  51. package/src/options.ts +1 -1
  52. package/src/sidebars/index.ts +11 -6
  53. package/src/types.ts +1 -1
  54. package/lib/openapi/utils/loadAndBundleSpec.d.ts +0 -3
  55. package/lib/openapi/utils/loadAndBundleSpec.js +0 -44
  56. package/src/openapi/utils/loadAndBundleSpec.ts +0 -62
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "docusaurus-plugin-openapi-docs",
3
3
  "description": "OpenAPI plugin for Docusaurus.",
4
- "version": "1.0.4",
4
+ "version": "1.1.0",
5
5
  "license": "MIT",
6
6
  "keywords": [
7
7
  "openapi",
@@ -28,32 +28,37 @@
28
28
  "watch": "tsc --watch"
29
29
  },
30
30
  "devDependencies": {
31
- "@docusaurus/module-type-aliases": "2.0.0-beta.21",
32
- "@docusaurus/types": "2.0.0-beta.21",
31
+ "@docusaurus/module-type-aliases": "2.0.0-beta.22",
32
+ "@docusaurus/types": "2.0.0-beta.22",
33
33
  "@types/fs-extra": "^9.0.13",
34
+ "@types/js-yaml": "^4.0.5",
35
+ "@types/json-pointer": "^1.0.31",
34
36
  "@types/json-schema": "^7.0.9",
35
37
  "@types/lodash": "^4.14.176",
38
+ "@types/mustache": "^4.1.2",
36
39
  "utility-types": "^3.10.0"
37
40
  },
38
41
  "dependencies": {
39
- "@docusaurus/mdx-loader": "2.0.0-beta.21",
40
- "@docusaurus/plugin-content-docs": "2.0.0-beta.21",
41
- "@docusaurus/utils": "2.0.0-beta.21",
42
- "@docusaurus/utils-validation": "2.0.0-beta.21",
42
+ "@apidevtools/json-schema-ref-parser": "^9.0.9",
43
+ "@docusaurus/mdx-loader": "2.0.0-beta.22",
44
+ "@docusaurus/plugin-content-docs": "2.0.0-beta.22",
45
+ "@docusaurus/utils": "2.0.0-beta.22",
46
+ "@docusaurus/utils-validation": "2.0.0-beta.22",
43
47
  "@paloaltonetworks/openapi-to-postmanv2": "3.1.0-hotfix.1",
44
48
  "@paloaltonetworks/postman-collection": "^4.1.0",
45
- "@redocly/openapi-core": "^1.0.0-beta.100",
46
- "@types/js-yaml": "^4.0.5",
47
- "@types/mustache": "^4.1.2",
49
+ "@redocly/openapi-core": "^1.0.0-beta.103",
48
50
  "chalk": "^4.1.2",
49
51
  "clsx": "^1.1.1",
50
52
  "fs-extra": "^9.0.1",
51
53
  "js-yaml": "^4.1.0",
54
+ "json-pointer": "^0.6.2",
52
55
  "json-refs": "^3.0.15",
53
56
  "json-schema-merge-allof": "^0.8.1",
54
57
  "lodash": "^4.17.20",
55
58
  "mustache": "^4.2.0",
59
+ "slugify": "^1.6.5",
56
60
  "swagger2openapi": "^7.0.8",
61
+ "url-template": "^3.0.0",
57
62
  "webpack": "^5.61.0"
58
63
  },
59
64
  "peerDependencies": {
@@ -62,5 +67,5 @@
62
67
  "engines": {
63
68
  "node": ">=14"
64
69
  },
65
- "gitHead": "0a590e8aaaff087d13adb7b4be75aa0112b9a2b5"
70
+ "gitHead": "31b50e968a9cc66b1c3cb078a0fed772054f8246"
66
71
  }
package/src/index.ts CHANGED
@@ -62,14 +62,14 @@ export default function pluginOpenAPIDocs(
62
62
  context: LoadContext,
63
63
  options: PluginOptions
64
64
  ): Plugin<LoadedContent> {
65
- const { config, docPluginId } = options;
65
+ const { config, docsPluginId } = options;
66
66
  const { siteDir, siteConfig } = context;
67
67
 
68
68
  // Get routeBasePath and path from plugin-content-docs or preset
69
69
  const presets: any = siteConfig.presets;
70
70
  const plugins: any = siteConfig.plugins;
71
71
  const presetsPlugins = presets.concat(plugins);
72
- const docData: any = getDocsData(presetsPlugins, docPluginId);
72
+ const docData: any = getDocsData(presetsPlugins, docsPluginId);
73
73
  const docRouteBasePath = docData ? docData.routeBasePath : undefined;
74
74
  const docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
75
75
 
@@ -81,7 +81,7 @@ export default function pluginOpenAPIDocs(
81
81
  : path.resolve(siteDir, specPath);
82
82
 
83
83
  try {
84
- const openapiFiles = await readOpenapiFiles(contentPath, {});
84
+ const openapiFiles = await readOpenapiFiles(contentPath, options);
85
85
  const [loadedApi, tags] = await processOpenapiFiles(
86
86
  openapiFiles,
87
87
  sidebarOptions!