docusaurus-plugin-openapi-docs 0.0.0-1014 → 0.0.0-1016

package/lib/openapi/types.d.ts

@@ -1,7 +1,4 @@
 import type { JSONSchema4, JSONSchema6, JSONSchema7, JSONSchema7TypeName } from "json-schema";
-interface Map<T> {
-    [key: string]: T;
-}
 export interface OpenApiObject {
     openapi: string;
     info: InfoObject;
@@ -54,7 +51,7 @@ export interface LicenseObject {
 export interface ServerObject {
     url: string;
     description?: string;
-    variables?: Map<ServerVariable>;
+    variables?: Record<string, ServerVariable>;
 }
 export interface ServerVariable {
     enum?: string[];
@@ -62,29 +59,29 @@ export interface ServerVariable {
     description?: string;
 }
 export interface ComponentsObject {
-    schemas?: Map<SchemaObject>;
-    responses?: Map<ResponseObject>;
-    parameters?: Map<ParameterObject>;
-    examples?: Map<ExampleObject>;
-    requestBodies?: Map<RequestBodyObject>;
-    headers?: Map<HeaderObject>;
-    securitySchemes?: Map<SecuritySchemeObject>;
-    links?: Map<LinkObject>;
-    callbacks?: Map<CallbackObject>;
+    schemas?: Record<string, SchemaObject>;
+    responses?: Record<string, ResponseObject>;
+    parameters?: Record<string, ParameterObject>;
+    examples?: Record<string, ExampleObject>;
+    requestBodies?: Record<string, RequestBodyObject>;
+    headers?: Record<string, HeaderObject>;
+    securitySchemes?: Record<string, SecuritySchemeObject>;
+    links?: Record<string, LinkObject>;
+    callbacks?: Record<string, CallbackObject>;
 }
 export interface ComponentsObjectWithRef {
-    schemas?: Map<SchemaObjectWithRef | ReferenceObject>;
-    responses?: Map<ResponseObjectWithRef | ReferenceObject>;
-    parameters?: Map<ParameterObjectWithRef | ReferenceObject>;
-    examples?: Map<ExampleObject | ReferenceObject>;
-    requestBodies?: Map<RequestBodyObjectWithRef | ReferenceObject>;
-    headers?: Map<HeaderObjectWithRef | ReferenceObject>;
-    securitySchemes?: Map<SecuritySchemeObject | ReferenceObject>;
-    links?: Map<LinkObject | ReferenceObject>;
-    callbacks?: Map<CallbackObjectWithRef | ReferenceObject>;
-}
-export type PathsObject = Map<PathItemObject>;
-export type PathsObjectWithRef = Map<PathItemObjectWithRef>;
+    schemas?: Record<string, SchemaObjectWithRef | ReferenceObject>;
+    responses?: Record<string, ResponseObjectWithRef | ReferenceObject>;
+    parameters?: Record<string, ParameterObjectWithRef | ReferenceObject>;
+    examples?: Record<string, ExampleObject | ReferenceObject>;
+    requestBodies?: Record<string, RequestBodyObjectWithRef | ReferenceObject>;
+    headers?: Record<string, HeaderObjectWithRef | ReferenceObject>;
+    securitySchemes?: Record<string, SecuritySchemeObject | ReferenceObject>;
+    links?: Record<string, LinkObject | ReferenceObject>;
+    callbacks?: Record<string, CallbackObjectWithRef | ReferenceObject>;
+}
+export type PathsObject = Record<string, PathItemObject>;
+export type PathsObjectWithRef = Record<string, PathItemObjectWithRef>;
 export interface PathItemObject {
     $ref?: string;
     summary?: string;
@@ -124,7 +121,7 @@ export interface OperationObject {
     parameters?: ParameterObject[];
     requestBody?: RequestBodyObject;
     responses: ResponsesObject;
-    callbacks?: Map<CallbackObject>;
+    callbacks?: Record<string, CallbackObject>;
     deprecated?: boolean;
     security?: SecurityRequirementObject[];
     servers?: ServerObject[];
@@ -140,7 +137,7 @@ export interface OperationObjectWithRef {
     parameters?: (ParameterObjectWithRef | ReferenceObject)[];
     requestBody?: RequestBodyObjectWithRef | ReferenceObject;
     responses: ResponsesObjectWithRef;
-    callbacks?: Map<CallbackObjectWithRef | ReferenceObject>;
+    callbacks?: Record<string, CallbackObjectWithRef | ReferenceObject>;
     deprecated?: boolean;
     security?: SecurityRequirementObject[];
     servers?: ServerObject[];
@@ -162,8 +159,8 @@ export interface ParameterObject {
     allowReserved?: boolean;
     schema?: SchemaObject;
     example?: any;
-    examples?: Map<ExampleObject>;
-    content?: Map<MediaTypeObject>;
+    examples?: Record<string, ExampleObject>;
+    content?: Record<string, MediaTypeObject>;
     param?: Object;
     "x-enumDescriptions"?: Record<string, string>;
 }
@@ -179,62 +176,62 @@ export interface ParameterObjectWithRef {
     allowReserved?: boolean;
     schema?: SchemaObjectWithRef | ReferenceObject;
     example?: any;
-    examples?: Map<ExampleObject | ReferenceObject>;
-    content?: Map<MediaTypeObjectWithRef>;
+    examples?: Record<string, ExampleObject | ReferenceObject>;
+    content?: Record<string, MediaTypeObjectWithRef>;
 }
 export interface RequestBodyObject {
     description?: string;
-    content: Map<MediaTypeObject>;
+    content: Record<string, MediaTypeObject>;
     required?: boolean;
 }
 export interface RequestBodyObjectWithRef {
     description?: string;
-    content: Map<MediaTypeObjectWithRef>;
+    content: Record<string, MediaTypeObjectWithRef>;
     required?: boolean;
 }
 export interface MediaTypeObject {
     schema?: SchemaObject;
     example?: any;
-    examples?: Map<ExampleObject>;
-    encoding?: Map<EncodingObject>;
+    examples?: Record<string, ExampleObject>;
+    encoding?: Record<string, EncodingObject>;
     type?: any;
 }
 export interface MediaTypeObjectWithRef {
     schema?: SchemaObjectWithRef | ReferenceObject;
     example?: any;
-    examples?: Map<ExampleObject | ReferenceObject>;
-    encoding?: Map<EncodingObjectWithRef>;
+    examples?: Record<string, ExampleObject | ReferenceObject>;
+    encoding?: Record<string, EncodingObjectWithRef>;
 }
 export interface EncodingObject {
     contentType?: string;
-    headers?: Map<HeaderObject>;
+    headers?: Record<string, HeaderObject>;
     style?: string;
     explode?: boolean;
     allowReserved?: boolean;
 }
 export interface EncodingObjectWithRef {
     contentType?: string;
-    headers?: Map<HeaderObjectWithRef | ReferenceObject>;
+    headers?: Record<string, HeaderObjectWithRef | ReferenceObject>;
     style?: string;
     explode?: boolean;
     allowReserved?: boolean;
 }
-export type ResponsesObject = Map<ResponseObject>;
-export type ResponsesObjectWithRef = Map<ResponseObjectWithRef | ReferenceObject>;
+export type ResponsesObject = Record<string, ResponseObject>;
+export type ResponsesObjectWithRef = Record<string, ResponseObjectWithRef | ReferenceObject>;
 export interface ResponseObject {
     description: string;
-    headers?: Map<HeaderObject>;
-    content?: Map<MediaTypeObject>;
-    links?: Map<LinkObject>;
+    headers?: Record<string, HeaderObject>;
+    content?: Record<string, MediaTypeObject>;
+    links?: Record<string, LinkObject>;
 }
 export interface ResponseObjectWithRef {
     description: string;
-    headers?: Map<HeaderObjectWithRef | ReferenceObject>;
-    content?: Map<MediaTypeObjectWithRef>;
-    links?: Map<LinkObject | ReferenceObject>;
+    headers?: Record<string, HeaderObjectWithRef | ReferenceObject>;
+    content?: Record<string, MediaTypeObjectWithRef>;
+    links?: Record<string, LinkObject | ReferenceObject>;
 }
-export type CallbackObject = Map<PathItemObject>;
-export type CallbackObjectWithRef = Map<PathItemObjectWithRef>;
+export type CallbackObject = Record<string, PathItemObject>;
+export type CallbackObjectWithRef = Record<string, PathItemObjectWithRef>;
 export interface ExampleObject {
     summary?: string;
     description?: string;
@@ -244,7 +241,7 @@ export interface ExampleObject {
 export interface LinkObject {
     operationRef?: string;
     operationId?: string;
-    parameters?: Map<any>;
+    parameters?: Record<string, any>;
     requestBody?: any;
     description?: string;
     server?: ServerObject;
@@ -273,7 +270,7 @@ export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf"
     anyOf?: SchemaObject[];
     not?: SchemaObject;
     items?: SchemaObject;
-    properties?: Map<SchemaObject>;
+    properties?: Record<string, SchemaObject>;
     additionalProperties?: boolean | SchemaObject;
     nullable?: boolean;
     discriminator?: DiscriminatorObject;
@@ -293,7 +290,7 @@ export type SchemaObjectWithRef = Omit<JSONSchema, "type" | "allOf" | "oneOf" |
     anyOf?: (SchemaObject | ReferenceObject)[];
     not?: SchemaObject | ReferenceObject;
     items?: SchemaObject | ReferenceObject;
-    properties?: Map<SchemaObject | ReferenceObject>;
+    properties?: Record<string, SchemaObject | ReferenceObject>;
     additionalProperties?: boolean | SchemaObject | ReferenceObject;
     nullable?: boolean;
     discriminator?: DiscriminatorObject;
@@ -306,7 +303,7 @@ export type SchemaObjectWithRef = Omit<JSONSchema, "type" | "allOf" | "oneOf" |
 };
 export interface DiscriminatorObject {
     propertyName: string;
-    mapping?: Map<string>;
+    mapping?: Record<string, string>;
 }
 export interface XMLObject {
     name?: string;
@@ -350,7 +347,6 @@ export interface OAuthFlowObject {
     authorizationUrl?: string;
     tokenUrl?: string;
     refreshUrl?: string;
-    scopes: Map<string>;
+    scopes: Record<string, string>;
 }
-export type SecurityRequirementObject = Map<string[]>;
-export {};
+export type SecurityRequirementObject = Record<string, string[]>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-1014",
+  "version": "0.0.0-1016",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -65,5 +65,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "66c116555c5002e121f65a3db9800bad20ca8ae1"
+  "gitHead": "c6ced382c6fb3ee6efd7e1b7b9a11c33355131c5"
 }

package/src/openapi/types.ts

@@ -12,10 +12,6 @@ import type {
   JSONSchema7TypeName,
 } from "json-schema";
 
-interface Map<T> {
-  [key: string]: T;
-}
-
 export interface OpenApiObject {
   openapi: string;
   info: InfoObject;
@@ -74,7 +70,7 @@ export interface LicenseObject {
 export interface ServerObject {
   url: string;
   description?: string;
-  variables?: Map<ServerVariable>;
+  variables?: Record<string, ServerVariable>;
 }
 
 export interface ServerVariable {
@@ -84,32 +80,32 @@ export interface ServerVariable {
 }
 
 export interface ComponentsObject {
-  schemas?: Map<SchemaObject>;
-  responses?: Map<ResponseObject>;
-  parameters?: Map<ParameterObject>;
-  examples?: Map<ExampleObject>;
-  requestBodies?: Map<RequestBodyObject>;
-  headers?: Map<HeaderObject>;
-  securitySchemes?: Map<SecuritySchemeObject>;
-  links?: Map<LinkObject>;
-  callbacks?: Map<CallbackObject>;
+  schemas?: Record<string, SchemaObject>;
+  responses?: Record<string, ResponseObject>;
+  parameters?: Record<string, ParameterObject>;
+  examples?: Record<string, ExampleObject>;
+  requestBodies?: Record<string, RequestBodyObject>;
+  headers?: Record<string, HeaderObject>;
+  securitySchemes?: Record<string, SecuritySchemeObject>;
+  links?: Record<string, LinkObject>;
+  callbacks?: Record<string, CallbackObject>;
 }
 
 export interface ComponentsObjectWithRef {
-  schemas?: Map<SchemaObjectWithRef | ReferenceObject>;
-  responses?: Map<ResponseObjectWithRef | ReferenceObject>;
-  parameters?: Map<ParameterObjectWithRef | ReferenceObject>;
-  examples?: Map<ExampleObject | ReferenceObject>;
-  requestBodies?: Map<RequestBodyObjectWithRef | ReferenceObject>;
-  headers?: Map<HeaderObjectWithRef | ReferenceObject>;
-  securitySchemes?: Map<SecuritySchemeObject | ReferenceObject>;
-  links?: Map<LinkObject | ReferenceObject>;
-  callbacks?: Map<CallbackObjectWithRef | ReferenceObject>;
+  schemas?: Record<string, SchemaObjectWithRef | ReferenceObject>;
+  responses?: Record<string, ResponseObjectWithRef | ReferenceObject>;
+  parameters?: Record<string, ParameterObjectWithRef | ReferenceObject>;
+  examples?: Record<string, ExampleObject | ReferenceObject>;
+  requestBodies?: Record<string, RequestBodyObjectWithRef | ReferenceObject>;
+  headers?: Record<string, HeaderObjectWithRef | ReferenceObject>;
+  securitySchemes?: Record<string, SecuritySchemeObject | ReferenceObject>;
+  links?: Record<string, LinkObject | ReferenceObject>;
+  callbacks?: Record<string, CallbackObjectWithRef | ReferenceObject>;
 }
 
-export type PathsObject = Map<PathItemObject>;
+export type PathsObject = Record<string, PathItemObject>;
 
-export type PathsObjectWithRef = Map<PathItemObjectWithRef>;
+export type PathsObjectWithRef = Record<string, PathItemObjectWithRef>;
 
 export interface PathItemObject {
   $ref?: string;
@@ -152,7 +148,7 @@ export interface OperationObject {
   parameters?: ParameterObject[];
   requestBody?: RequestBodyObject;
   responses: ResponsesObject;
-  callbacks?: Map<CallbackObject>;
+  callbacks?: Record<string, CallbackObject>;
   deprecated?: boolean;
   security?: SecurityRequirementObject[];
   servers?: ServerObject[];
@@ -170,7 +166,7 @@ export interface OperationObjectWithRef {
   parameters?: (ParameterObjectWithRef | ReferenceObject)[];
   requestBody?: RequestBodyObjectWithRef | ReferenceObject;
   responses: ResponsesObjectWithRef;
-  callbacks?: Map<CallbackObjectWithRef | ReferenceObject>;
+  callbacks?: Record<string, CallbackObjectWithRef | ReferenceObject>;
   deprecated?: boolean;
   security?: SecurityRequirementObject[];
   servers?: ServerObject[];
@@ -197,9 +193,9 @@ export interface ParameterObject {
   allowReserved?: boolean;
   schema?: SchemaObject;
   example?: any;
-  examples?: Map<ExampleObject>;
+  examples?: Record<string, ExampleObject>;
   //
-  content?: Map<MediaTypeObject>;
+  content?: Record<string, MediaTypeObject>;
   param?: Object;
   // ignoring stylings: matrix, label, form, simple, spaceDelimited,
   // pipeDelimited and deepObject
@@ -219,43 +215,43 @@ export interface ParameterObjectWithRef {
   allowReserved?: boolean;
   schema?: SchemaObjectWithRef | ReferenceObject;
   example?: any;
-  examples?: Map<ExampleObject | ReferenceObject>;
+  examples?: Record<string, ExampleObject | ReferenceObject>;
   //
-  content?: Map<MediaTypeObjectWithRef>;
+  content?: Record<string, MediaTypeObjectWithRef>;
   // ignoring stylings: matrix, label, form, simple, spaceDelimited,
   // pipeDelimited and deepObject
 }
 
 export interface RequestBodyObject {
   description?: string;
-  content: Map<MediaTypeObject>;
+  content: Record<string, MediaTypeObject>;
   required?: boolean;
 }
 
 export interface RequestBodyObjectWithRef {
   description?: string;
-  content: Map<MediaTypeObjectWithRef>;
+  content: Record<string, MediaTypeObjectWithRef>;
   required?: boolean;
 }
 
 export interface MediaTypeObject {
   schema?: SchemaObject;
   example?: any;
-  examples?: Map<ExampleObject>;
-  encoding?: Map<EncodingObject>;
+  examples?: Record<string, ExampleObject>;
+  encoding?: Record<string, EncodingObject>;
   type?: any;
 }
 
 export interface MediaTypeObjectWithRef {
   schema?: SchemaObjectWithRef | ReferenceObject;
   example?: any;
-  examples?: Map<ExampleObject | ReferenceObject>;
-  encoding?: Map<EncodingObjectWithRef>;
+  examples?: Record<string, ExampleObject | ReferenceObject>;
+  encoding?: Record<string, EncodingObjectWithRef>;
 }
 
 export interface EncodingObject {
   contentType?: string;
-  headers?: Map<HeaderObject>;
+  headers?: Record<string, HeaderObject>;
   style?: string;
   explode?: boolean;
   allowReserved?: boolean;
@@ -263,35 +259,36 @@ export interface EncodingObject {
 
 export interface EncodingObjectWithRef {
   contentType?: string;
-  headers?: Map<HeaderObjectWithRef | ReferenceObject>;
+  headers?: Record<string, HeaderObjectWithRef | ReferenceObject>;
   style?: string;
   explode?: boolean;
   allowReserved?: boolean;
 }
 
-export type ResponsesObject = Map<ResponseObject>;
+export type ResponsesObject = Record<string, ResponseObject>;
 
-export type ResponsesObjectWithRef = Map<
+export type ResponsesObjectWithRef = Record<
+  string,
   ResponseObjectWithRef | ReferenceObject
 >;
 
 export interface ResponseObject {
   description: string;
-  headers?: Map<HeaderObject>;
-  content?: Map<MediaTypeObject>;
-  links?: Map<LinkObject>;
+  headers?: Record<string, HeaderObject>;
+  content?: Record<string, MediaTypeObject>;
+  links?: Record<string, LinkObject>;
 }
 
 export interface ResponseObjectWithRef {
   description: string;
-  headers?: Map<HeaderObjectWithRef | ReferenceObject>;
-  content?: Map<MediaTypeObjectWithRef>;
-  links?: Map<LinkObject | ReferenceObject>;
+  headers?: Record<string, HeaderObjectWithRef | ReferenceObject>;
+  content?: Record<string, MediaTypeObjectWithRef>;
+  links?: Record<string, LinkObject | ReferenceObject>;
 }
 
-export type CallbackObject = Map<PathItemObject>;
+export type CallbackObject = Record<string, PathItemObject>;
 
-export type CallbackObjectWithRef = Map<PathItemObjectWithRef>;
+export type CallbackObjectWithRef = Record<string, PathItemObjectWithRef>;
 
 export interface ExampleObject {
   summary?: string;
@@ -303,7 +300,7 @@ export interface ExampleObject {
 export interface LinkObject {
   operationRef?: string;
   operationId?: string;
-  parameters?: Map<any>;
+  parameters?: Record<string, any>;
   requestBody?: any;
   description?: string;
   server?: ServerObject;
@@ -349,7 +346,7 @@ export type SchemaObject = Omit<
   anyOf?: SchemaObject[];
   not?: SchemaObject;
   items?: SchemaObject;
-  properties?: Map<SchemaObject>;
+  properties?: Record<string, SchemaObject>;
   additionalProperties?: boolean | SchemaObject;
 
   // OpenAPI additions
@@ -383,7 +380,7 @@ export type SchemaObjectWithRef = Omit<
   anyOf?: (SchemaObject | ReferenceObject)[];
   not?: SchemaObject | ReferenceObject;
   items?: SchemaObject | ReferenceObject;
-  properties?: Map<SchemaObject | ReferenceObject>;
+  properties?: Record<string, SchemaObject | ReferenceObject>;
   additionalProperties?: boolean | SchemaObject | ReferenceObject;
 
   // OpenAPI additions
@@ -399,7 +396,7 @@ export type SchemaObjectWithRef = Omit<
 
 export interface DiscriminatorObject {
   propertyName: string;
-  mapping?: Map<string>;
+  mapping?: Record<string, string>;
 }
 
 export interface XMLObject {
@@ -455,7 +452,7 @@ export interface OAuthFlowObject {
   authorizationUrl?: string; // required for some
   tokenUrl?: string; // required for some
   refreshUrl?: string;
-  scopes: Map<string>;
+  scopes: Record<string, string>;
 }
 
-export type SecurityRequirementObject = Map<string[]>;
+export type SecurityRequirementObject = Record<string, string[]>;

package/src/plugin-openapi.d.ts

@@ -5,10 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
+import type { TOCItem } from "@docusaurus/mdx-loader";
+import type { VersionBanner } from "@docusaurus/plugin-content-docs";
 import type { FrontMatter as DocsFrontMatter } from "@docusaurus/types";
 import type { Props as DocsProps } from "@docusaurus/types";
 
-// TODO: figure out how to import this
 declare module "docusaurus-plugin-openapi-docs" {
   import type { PropSidebars } from "@docusaurus/plugin-content-docs-types";
 
@@ -77,7 +78,7 @@ declare module "@theme/ApiItem" {
       readonly frontMatter: FrontMatter;
       readonly metadata: Metadata;
       readonly contentTitle: string | undefined;
-      readonly toc: array | undefined;
+      readonly toc: readonly TOCItem[] | undefined;
       (): JSX.Element;
     };
   }