Prepare release v0.7.0 (#268)

techwritermat · web-flow · commit 43aa76d20c49 · 2023-12-14T10:34:02.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,20 @@
+## 0.7.0 (Dec 13, 2023)
+
+High-level enhancements
+
+- Docusaurus v3 support ([#266](https://github.com/cloud-annotations/docusaurus-openapi/pull/266))
+- Allow pressing enter to perform the 'Execute' action ([#255](https://github.com/cloud-annotations/docusaurus-openapi/pull/255))
+- Render examples in a `<code>` block ([#256](https://github.com/cloud-annotations/docusaurus-openapi/pull/256))
+
+Other enhancements and bug fixes
+
+- Wrap code examples tabs in narrow browser windows ([#250](https://github.com/cloud-annotations/docusaurus-openapi/pull/250))
+- Add border to form inputs when using light theme ([#252](https://github.com/cloud-annotations/docusaurus-openapi/pull/252))
+- Fix: Page crash on half surrogate pair ([#261](https://github.com/cloud-annotations/docusaurus-openapi/pull/261))
+
 ## 0.6.4 (Mar 15, 2023)
 
-High level enhancements
+High-level enhancements
 
 - Fixes and enhancements for array query param handling ([#241](https://github.com/cloud-annotations/docusaurus-openapi/pull/241))
   - Respect the `maxItems` property for array query params
@@ -18,7 +32,7 @@ Other enhancements and bug fixes
 
 ## 0.6.3 (Nov 7, 2022)
 
-High level enhancements
+High-level enhancements
 
 - Compatibility with Docusaurus 2.2.0 ([#223](https://github.com/cloud-annotations/docusaurus-openapi/pull/223))
 - Support for loading custom Markdown Files: ([#193](https://github.com/cloud-annotations/docusaurus-openapi/pull/193))
@@ -30,7 +44,7 @@ Other enhancements and bug fixes
 
 ## 0.6.2 (Aug 11, 2022)
 
-High level enhancements
+High-level enhancements
 
 - Authorize with api keys in header
 
@@ -54,7 +68,7 @@ Other enhancements and bug fixes
 
 ## 0.6.0 (Jun 23, 2022)
 
-High level enhancements
+High-level enhancements
 
 - Compatibility with Docusaurus 2.0.0-beta.21
 
@@ -68,7 +82,7 @@ Other enhancements and bug fixes
 
 ## 0.5.0 (Jan 9, 2022)
 
-High level enhancements
+High-level enhancements
 
 - All theme components are now TypeScript 🎉
 
@@ -97,7 +111,7 @@ Enhancements and bug fixes
 
 ## 0.4.0 (Dec 23, 2021)
 
-High level enhancements
+High-level enhancements
 
 - Docusaurus beta.14 support
 
@@ -156,7 +170,7 @@ Other enhancements and bug fixes
 
 ## 0.3.1 (Dec 21, 2021)
 
-High level enhancements
+High-level enhancements
 
 - Added support for more schema qualifiers:
 
@@ -203,7 +217,7 @@ Other enhancements and bug fixes
 
 ## 0.3.0 (Dec 16, 2021)
 
-High level enhancements
+High-level enhancements
 
 - Docusaurus beta.13 support (Thanks @Josh-Cena!)
 
@@ -281,7 +295,7 @@ Fix broken package
 
 ## 0.2.1 (Dec 5, 2021)
 
-High level enhancements
+High-level enhancements
 
 - The demo panel now allows you to choose the security scheme from a dropdown that is populated by the OpenAPI definition (only showing the dropdown if more than one is listed)
 - Adds support for using multiple auth modes simultaneously (Eg: `(BearerAuth) OR (ApiKeyAuth AND BasicAuth)`)
diff --git a/demo/package.json b/demo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "demo",
-  "version": "0.6.4",
+  "version": "0.7.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -17,7 +17,7 @@
     "@docusaurus/core": "^3.0.0",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.2.1",
-    "docusaurus-preset-openapi": "^0.6.4",
+    "docusaurus-preset-openapi": "^0.7.0",
     "file-loader": "^6.2.0",
     "prism-react-renderer": "^2.1.0",
     "react": "^18.0.0",
diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.6.4",
+  "version": "0.7.0",
   "npmClient": "yarn",
   "useWorkspaces": true
 }
diff --git a/packages/create-docusaurus-openapi/package.json b/packages/create-docusaurus-openapi/package.json
@@ -1,6 +1,6 @@
 {
   "name": "create-docusaurus-openapi",
-  "version": "0.6.4",
+  "version": "0.7.0",
   "description": "Create Docusaurus apps easily.",
   "repository": {
     "type": "git",
diff --git a/packages/docusaurus-plugin-openapi/package.json b/packages/docusaurus-plugin-openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.6.4",
+  "version": "0.7.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
diff --git a/packages/docusaurus-plugin-openapi/src/markdown/createParamsTable.ts b/packages/docusaurus-plugin-openapi/src/markdown/createParamsTable.ts
@@ -7,11 +7,11 @@
 
 import { escape } from "lodash";
 
-import { ApiItem } from "../types";
 import { createDescription } from "./createDescription";
 import { createFullWidthTable } from "./createFullWidthTable";
 import { getQualifierMessage, getSchemaName } from "./schema";
 import { create, guard } from "./utils";
+import { ApiItem } from "../types";
 
 interface Props {
   parameters: ApiItem["parameters"];
diff --git a/packages/docusaurus-plugin-openapi/src/markdown/createSchemaTable.ts b/packages/docusaurus-plugin-openapi/src/markdown/createSchemaTable.ts
@@ -7,11 +7,11 @@
 
 import { escape } from "lodash";
 
-import { MediaTypeObject, SchemaObject } from "../openapi/types";
 import { createDescription } from "./createDescription";
 import { createFullWidthTable } from "./createFullWidthTable";
 import { getQualifierMessage, getSchemaName } from "./schema";
 import { create, guard } from "./utils";
+import { MediaTypeObject, SchemaObject } from "../openapi/types";
 
 function resolveAllOf(allOf: SchemaObject[]) {
   // TODO: naive implementation (only supports objects, no directly nested allOf)
diff --git a/packages/docusaurus-plugin-openapi/src/markdown/createStatusCodesTable.ts b/packages/docusaurus-plugin-openapi/src/markdown/createStatusCodesTable.ts
@@ -5,11 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { ApiItem } from "../types";
 import { createDescription } from "./createDescription";
 import { createFullWidthTable } from "./createFullWidthTable";
 import { createSchemaTable } from "./createSchemaTable";
 import { create } from "./utils";
+import { ApiItem } from "../types";
 
 interface Props {
   responses: ApiItem["responses"];
diff --git a/packages/docusaurus-plugin-openapi/src/markdown/index.ts b/packages/docusaurus-plugin-openapi/src/markdown/index.ts
@@ -7,14 +7,14 @@
 
 import { escape } from "lodash";
 
-import { ApiPageMetadata, InfoPageMetadata } from "../types";
 import { createDeprecationNotice } from "./createDeprecationNotice";
 import { createDescription } from "./createDescription";
 import { createParamsTable } from "./createParamsTable";
 import { createRequestBodyTable } from "./createRequestBodyTable";
 import { createStatusCodesTable } from "./createStatusCodesTable";
 import { createVersionBadge } from "./createVersionBadge";
 import { render } from "./utils";
+import { ApiPageMetadata, InfoPageMetadata } from "../types";
 
 export function createApiPageMD({
   title,
diff --git a/packages/docusaurus-plugin-openapi/src/openapi/openapi.ts b/packages/docusaurus-plugin-openapi/src/openapi/openapi.ts
@@ -18,10 +18,10 @@ import { kebabCase } from "lodash";
 import Converter from "openapi-to-postmanv2";
 import sdk, { Collection } from "postman-collection";
 
-import { ApiMetadata, ApiPageMetadata, InfoPageMetadata } from "../types";
-import { isURL } from "../util";
 import { sampleFromSchema } from "./createExample";
 import { OpenApiObject, OpenApiObjectWithRef, TagObject } from "./types";
+import { ApiMetadata, ApiPageMetadata, InfoPageMetadata } from "../types";
+import { isURL } from "../util";
 
 /**
  * Finds any reference objects in the OpenAPI definition and resolves them to a finalized value.
diff --git a/packages/docusaurus-preset-openapi/package.json b/packages/docusaurus-preset-openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-preset-openapi",
   "description": "OpenAPI preset for Docusaurus.",
-  "version": "0.6.4",
+  "version": "0.7.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -32,9 +32,9 @@
   },
   "dependencies": {
     "@docusaurus/preset-classic": "^3.0.0",
-    "docusaurus-plugin-openapi": "^0.6.4",
+    "docusaurus-plugin-openapi": "^0.7.0",
     "docusaurus-plugin-proxy": "^0.6.3",
-    "docusaurus-theme-openapi": "^0.6.4"
+    "docusaurus-theme-openapi": "^0.7.0"
   },
   "peerDependencies": {
     "react": "^18.0.0",
diff --git a/packages/docusaurus-template-openapi/package.json b/packages/docusaurus-template-openapi/package.json
@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-template-openapi",
-  "version": "0.6.4",
+  "version": "0.7.0",
   "keywords": [
     "react",
     "create-docusaurus",
diff --git a/packages/docusaurus-template-openapi/template.json b/packages/docusaurus-template-openapi/template.json
@@ -1,7 +1,7 @@
 {
   "package": {
     "name": "demo",
-    "version": "0.6.4",
+    "version": "0.7.0",
     "private": true,
     "scripts": {
       "docusaurus": "docusaurus",
diff --git a/packages/docusaurus-theme-openapi/package.json b/packages/docusaurus-theme-openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.6.4",
+  "version": "0.7.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -42,7 +42,7 @@
     "buffer": "^6.0.3",
     "clsx": "^1.2.1",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi": "^0.6.4",
+    "docusaurus-plugin-openapi": "^0.7.0",
     "immer": "^9.0.7",
     "lodash": "^4.17.20",
     "monaco-editor": "^0.31.1",
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Accept/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Accept/index.tsx
@@ -7,10 +7,10 @@
 
 import React from "react";
 
-import { useTypedDispatch, useTypedSelector } from "../hooks";
 import FormItem from "./../FormItem";
 import FormSelect from "./../FormSelect";
 import { setAccept } from "./slice";
+import { useTypedDispatch, useTypedSelector } from "../hooks";
 
 function Accept() {
   const value = useTypedSelector((state) => state.accept.value);
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Authorization/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Authorization/index.tsx
@@ -9,12 +9,12 @@ import React, { useState } from "react";
 
 import clsx from "clsx";
 
+import { AuthState, Scheme, setAuthData, setSelectedAuth } from "./slice";
 import FormItem from "../FormItem";
 import FormSelect from "../FormSelect";
 import FormTextInput from "../FormTextInput";
 import { useTypedDispatch, useTypedSelector } from "../hooks";
 import styles from "../styles.module.css";
-import { AuthState, Scheme, setAuthData, setSelectedAuth } from "./slice";
 
 type Props = {
   mode: "locked" | "unlocked";
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Authorization/slice.ts b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Authorization/slice.ts
@@ -11,9 +11,9 @@ import {
   SecuritySchemeObject,
 } from "docusaurus-plugin-openapi/src/openapi/types";
 
+import { getAuthDataKeys } from "./auth-types";
 import { ThemeConfig } from "../../../types";
 import { createStorage, hashArray } from "../storage-utils";
-import { getAuthDataKeys } from "./auth-types";
 
 // The global definitions
 // "securitySchemes": {
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Body/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Body/index.tsx
@@ -9,10 +9,6 @@ import React from "react";
 
 import { RequestBodyObject } from "docusaurus-plugin-openapi/src/openapi/types";
 
-import ContentType from "../ContentType";
-import FormMultiSelect from "../FormMultiSelect";
-import FormSelect from "../FormSelect";
-import { useTypedDispatch, useTypedSelector } from "../hooks";
 import FormFileUpload from "./../FormFileUpload";
 import FormItem from "./../FormItem";
 import FormTextInput from "./../FormTextInput";
@@ -26,6 +22,10 @@ import {
   setArrayFormBody,
   setStringRawBody,
 } from "./slice";
+import ContentType from "../ContentType";
+import FormMultiSelect from "../FormMultiSelect";
+import FormSelect from "../FormSelect";
+import { useTypedDispatch, useTypedSelector } from "../hooks";
 
 interface Props {
   jsonRequestBodyExample: string;
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/ContentType/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/ContentType/index.tsx
@@ -7,10 +7,10 @@
 
 import React from "react";
 
-import { useTypedDispatch, useTypedSelector } from "../hooks";
 import FormItem from "./../FormItem";
 import FormSelect from "./../FormSelect";
 import { setContentType } from "./slice";
+import { useTypedDispatch, useTypedSelector } from "../hooks";
 
 function ContentType() {
   const value = useTypedSelector((state) => state.contentType.value);
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Curl/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Curl/index.tsx
@@ -14,10 +14,10 @@ import clsx from "clsx";
 import codegen from "postman-code-generators";
 import { Highlight } from "prism-react-renderer";
 
-import { useTypedSelector } from "../hooks";
 import buildPostmanRequest from "./../buildPostmanRequest";
 import FloatingButton from "./../FloatingButton";
 import styles from "./styles.module.css";
+import { useTypedSelector } from "../hooks";
 
 interface Language {
   tabName: string;
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Execute/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Execute/index.tsx
@@ -9,11 +9,11 @@ import React from "react";
 
 import sdk from "postman-collection";
 
+import buildPostmanRequest from "./../buildPostmanRequest";
+import makeRequest from "./makeRequest";
 import { useTypedDispatch, useTypedSelector } from "../hooks";
 import { Param } from "../ParamOptions/slice";
 import { setResponse } from "../Response/slice";
-import buildPostmanRequest from "./../buildPostmanRequest";
-import makeRequest from "./makeRequest";
 
 function validateRequest(params: {
   path: Param[];
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/FormFileUpload/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/FormFileUpload/index.tsx
@@ -10,8 +10,8 @@ import React, { useState } from "react";
 // @ts-ignore
 import MagicDropzone from "react-magic-dropzone";
 
-import FloatingButton from "../FloatingButton";
 import styles from "./styles.module.css";
+import FloatingButton from "../FloatingButton";
 
 type PreviewFile = { preview: string } & File;
 
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/ParamOptions/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/ParamOptions/index.tsx
@@ -9,13 +9,13 @@ import React, { useState } from "react";
 
 import { nanoid } from "@reduxjs/toolkit";
 
-import { useTypedDispatch, useTypedSelector } from "../hooks";
 import FormItem from "./../FormItem";
 import FormMultiSelect from "./../FormMultiSelect";
 import FormSelect from "./../FormSelect";
 import FormTextInput from "./../FormTextInput";
 import { Param, setParam } from "./slice";
 import styles from "./styles.module.css";
+import { useTypedDispatch, useTypedSelector } from "../hooks";
 
 interface ParamProps {
   param: Param;
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Response/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Response/index.tsx
@@ -7,9 +7,9 @@
 
 import React from "react";
 
-import { useTypedDispatch, useTypedSelector } from "../hooks";
 import FloatingButton from "./../FloatingButton";
 import { clearResponse } from "./slice";
+import { useTypedDispatch, useTypedSelector } from "../hooks";
 
 // TODO: We probably shouldn't attempt to format XML...
 function formatXml(xml: string) {
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Server/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/Server/index.tsx
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/index.tsx b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/index.tsx
diff --git a/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/persistanceMiddleware.ts b/packages/docusaurus-theme-openapi/src/theme/ApiDemoPanel/persistanceMiddleware.ts
diff --git a/scripts/changelog.ts b/scripts/changelog.ts
diff --git a/scripts/check-pr-title.ts b/scripts/check-pr-title.ts
diff --git a/scripts/publish.ts b/scripts/publish.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "version": "0.6.4",`
	`2`	`+ "version": "0.7.0",`
`3`	`3`	`"npmClient": "yarn",`
`4`	`4`	`"useWorkspaces": true`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "create-docusaurus-openapi",`
`3`		`- "version": "0.6.4",`
	`3`	`+ "version": "0.7.0",`
`4`	`4`	`"description": "Create Docusaurus apps easily.",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "docusaurus-plugin-openapi",`
`3`	`3`	`"description": "OpenAPI plugin for Docusaurus.",`
`4`		`- "version": "0.6.4",`
	`4`	`+ "version": "0.7.0",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"publishConfig": {`
`7`	`7`	`"access": "public"`