docusaurus-theme-openapi-docs 0.0.0-701 → 0.0.0-703

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 (34) hide show
  1. package/lib/markdown/utils.d.ts +2 -2
  2. package/lib/theme/ApiExplorer/Accept/index.d.ts +2 -2
  3. package/lib/theme/ApiExplorer/Authorization/index.d.ts +2 -2
  4. package/lib/theme/ApiExplorer/Authorization/slice.d.ts +1 -1
  5. package/lib/theme/ApiExplorer/Body/index.d.ts +2 -2
  6. package/lib/theme/ApiExplorer/Body/slice.d.ts +3 -3
  7. package/lib/theme/ApiExplorer/CodeSnippets/code-snippets-types.d.ts +1 -1
  8. package/lib/theme/ApiExplorer/CodeSnippets/index.d.ts +2 -2
  9. package/lib/theme/ApiExplorer/ContentType/index.d.ts +2 -2
  10. package/lib/theme/ApiExplorer/Export/index.d.ts +2 -2
  11. package/lib/theme/ApiExplorer/FloatingButton/index.d.ts +1 -1
  12. package/lib/theme/ApiExplorer/FormFileUpload/index.d.ts +2 -2
  13. package/lib/theme/ApiExplorer/FormItem/index.d.ts +1 -1
  14. package/lib/theme/ApiExplorer/FormMultiSelect/index.d.ts +1 -1
  15. package/lib/theme/ApiExplorer/FormSelect/index.d.ts +1 -1
  16. package/lib/theme/ApiExplorer/FormTextInput/index.d.ts +1 -1
  17. package/lib/theme/ApiExplorer/MethodEndpoint/index.d.ts +2 -2
  18. package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.d.ts +2 -2
  19. package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.d.ts +2 -2
  20. package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.d.ts +2 -2
  21. package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.d.ts +2 -2
  22. package/lib/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.d.ts +2 -2
  23. package/lib/theme/ApiExplorer/ParamOptions/index.d.ts +2 -2
  24. package/lib/theme/ApiExplorer/ParamOptions/slice.d.ts +1 -1
  25. package/lib/theme/ApiExplorer/Request/index.d.ts +2 -2
  26. package/lib/theme/ApiExplorer/Response/index.d.ts +2 -2
  27. package/lib/theme/ApiExplorer/SecuritySchemes/index.d.ts +2 -2
  28. package/lib/theme/ApiExplorer/Server/index.d.ts +2 -2
  29. package/lib/theme/ApiExplorer/buildPostmanRequest.d.ts +1 -1
  30. package/lib/theme/ApiExplorer/index.d.ts +2 -2
  31. package/lib/theme/ApiExplorer/storage-utils.d.ts +1 -1
  32. package/lib/theme/ApiItem/store.d.ts +6 -6
  33. package/lib/types.d.ts +4 -4
  34. package/package.json +3 -3
@@ -1,5 +1,5 @@
1
- export declare type Children = string | undefined | (string | undefined)[];
2
- export declare type Props = Record<string, any> & {
1
+ export type Children = string | undefined | (string | undefined)[];
2
+ export type Props = Record<string, any> & {
3
3
  children?: Children;
4
4
  };
5
5
  export declare function create(tag: string, props: Props): string;
@@ -1,3 +1,3 @@
1
- /// <reference types="react" />
2
- declare function Accept(): JSX.Element | null;
1
+ import React from "react";
2
+ declare function Accept(): React.JSX.Element | null;
3
3
  export default Accept;
@@ -1,3 +1,3 @@
1
- /// <reference types="react" />
2
- declare function Authorization(): JSX.Element | null;
1
+ import React from "react";
2
+ declare function Authorization(): React.JSX.Element | null;
3
3
  export default Authorization;
@@ -8,7 +8,7 @@ export declare function createAuth({ security, securitySchemes, options, }: {
8
8
  };
9
9
  options?: ThemeConfig["api"];
10
10
  }): AuthState;
11
- export declare type Scheme = {
11
+ export type Scheme = {
12
12
  key: string;
13
13
  scopes: string[];
14
14
  } & SecuritySchemeObject;
@@ -1,4 +1,4 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import { RequestBodyObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
3
3
  export interface Props {
4
4
  jsonRequestBodyExample: string;
@@ -6,5 +6,5 @@ export interface Props {
6
6
  methods?: any;
7
7
  required?: boolean;
8
8
  }
9
- declare function BodyWrap({ requestBodyMetadata, jsonRequestBodyExample, methods, required, }: Props): JSX.Element | null;
9
+ declare function BodyWrap({ requestBodyMetadata, jsonRequestBodyExample, methods, required, }: Props): React.JSX.Element | null;
10
10
  export default BodyWrap;
@@ -10,7 +10,7 @@ export interface StringContent {
10
10
  type: "string";
11
11
  value?: string;
12
12
  }
13
- export declare type Content = FileContent | StringContent | undefined;
13
+ export type Content = FileContent | StringContent | undefined;
14
14
  export interface FormBody {
15
15
  type: "form";
16
16
  content: {
@@ -24,8 +24,8 @@ export interface RawBody {
24
24
  export interface EmptyBody {
25
25
  type: "empty";
26
26
  }
27
- export declare type Body = EmptyBody | FormBody | RawBody;
28
- export declare type State = Body;
27
+ export type Body = EmptyBody | FormBody | RawBody;
28
+ export type State = Body;
29
29
  export declare const slice: import("@reduxjs/toolkit").Slice<EmptyBody | FormBody | RawBody, {
30
30
  clearRawBody: (_state: import("immer/dist/internal").WritableDraft<EmptyBody> | import("immer/dist/internal").WritableDraft<FormBody> | import("immer/dist/internal").WritableDraft<RawBody>) => {
31
31
  type: "empty";
@@ -1,4 +1,4 @@
1
- export declare type CodeSampleLanguage = "C" | "C#" | "C++" | "CoffeeScript" | "CSS" | "Dart" | "DM" | "Elixir" | "Go" | "Groovy" | "HTML" | "Java" | "JavaScript" | "Kotlin" | "Objective-C" | "Perl" | "PHP" | "PowerShell" | "Python" | "Ruby" | "Rust" | "Scala" | "Shell" | "Swift" | "TypeScript";
1
+ export type CodeSampleLanguage = "C" | "C#" | "C++" | "CoffeeScript" | "CSS" | "Dart" | "DM" | "Elixir" | "Go" | "Groovy" | "HTML" | "Java" | "JavaScript" | "Kotlin" | "Objective-C" | "Perl" | "PHP" | "PowerShell" | "Python" | "Ruby" | "Rust" | "Scala" | "Shell" | "Swift" | "TypeScript";
2
2
  export interface Language {
3
3
  highlight: string;
4
4
  language: string;
@@ -1,4 +1,4 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import sdk from "@paloaltonetworks/postman-collection";
3
3
  import { CodeSample, Language } from "./code-snippets-types";
4
4
  export declare const languageSet: Language[];
@@ -6,5 +6,5 @@ export interface Props {
6
6
  postman: sdk.Request;
7
7
  codeSamples: CodeSample[];
8
8
  }
9
- declare function CodeSnippets({ postman, codeSamples }: Props): JSX.Element | null;
9
+ declare function CodeSnippets({ postman, codeSamples }: Props): React.JSX.Element | null;
10
10
  export default CodeSnippets;
@@ -1,3 +1,3 @@
1
- /// <reference types="react" />
2
- declare function ContentType(): JSX.Element | null;
1
+ import React from "react";
2
+ declare function ContentType(): React.JSX.Element | null;
3
3
  export default ContentType;
@@ -1,3 +1,3 @@
1
- /// <reference types="react" />
2
- declare function Export({ url, proxy }: any): JSX.Element;
1
+ import React from "react";
2
+ declare function Export({ url, proxy }: any): React.JSX.Element;
3
3
  export default Export;
@@ -4,5 +4,5 @@ export interface Props {
4
4
  onClick?: React.MouseEventHandler<HTMLButtonElement>;
5
5
  children?: React.ReactNode;
6
6
  }
7
- declare function FloatingButton({ label, onClick, children }: Props): JSX.Element;
7
+ declare function FloatingButton({ label, onClick, children }: Props): React.JSX.Element;
8
8
  export default FloatingButton;
@@ -1,7 +1,7 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  export interface Props {
3
3
  placeholder: string;
4
4
  onChange?(file?: File): any;
5
5
  }
6
- declare function FormFileUpload({ placeholder, onChange }: Props): JSX.Element;
6
+ declare function FormFileUpload({ placeholder, onChange }: Props): React.JSX.Element;
7
7
  export default FormFileUpload;
@@ -6,5 +6,5 @@ export interface Props {
6
6
  children?: React.ReactNode;
7
7
  className?: string;
8
8
  }
9
- declare function FormItem({ label, type, required, children, className }: Props): JSX.Element;
9
+ declare function FormItem({ label, type, required, children, className }: Props): React.JSX.Element;
10
10
  export default FormItem;
@@ -5,5 +5,5 @@ export interface Props {
5
5
  onChange?: React.ChangeEventHandler<HTMLSelectElement>;
6
6
  showErrors?: boolean;
7
7
  }
8
- declare function FormMultiSelect({ value, options, onChange, showErrors }: Props): JSX.Element | null;
8
+ declare function FormMultiSelect({ value, options, onChange, showErrors }: Props): React.JSX.Element | null;
9
9
  export default FormMultiSelect;
@@ -4,5 +4,5 @@ export interface Props {
4
4
  options?: string[];
5
5
  onChange?: React.ChangeEventHandler<HTMLSelectElement>;
6
6
  }
7
- declare function FormSelect({ value, options, onChange }: Props): JSX.Element | null;
7
+ declare function FormSelect({ value, options, onChange }: Props): React.JSX.Element | null;
8
8
  export default FormSelect;
@@ -5,5 +5,5 @@ export interface Props {
5
5
  password?: boolean;
6
6
  onChange?: React.ChangeEventHandler<HTMLInputElement>;
7
7
  }
8
- declare function FormTextInput({ isRequired, value, placeholder, password, onChange, paramName, }: Props): JSX.Element;
8
+ declare function FormTextInput({ isRequired, value, placeholder, password, onChange, paramName, }: Props): React.JSX.Element;
9
9
  export default FormTextInput;
@@ -1,7 +1,7 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  export interface Props {
3
3
  method: string;
4
4
  path: string;
5
5
  }
6
- declare function MethodEndpoint({ method, path }: Props): JSX.Element;
6
+ declare function MethodEndpoint({ method, path }: Props): React.JSX.Element;
7
7
  export default MethodEndpoint;
@@ -1,6 +1,6 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
3
3
  export interface ParamProps {
4
4
  param: Param;
5
5
  }
6
- export default function ParamArrayFormItem({ param }: ParamProps): JSX.Element;
6
+ export default function ParamArrayFormItem({ param }: ParamProps): React.JSX.Element;
@@ -1,6 +1,6 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
3
3
  export interface ParamProps {
4
4
  param: Param;
5
5
  }
6
- export default function ParamBooleanFormItem({ param }: ParamProps): JSX.Element;
6
+ export default function ParamBooleanFormItem({ param }: ParamProps): React.JSX.Element;
@@ -1,6 +1,6 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
3
3
  export interface ParamProps {
4
4
  param: Param;
5
5
  }
6
- export default function ParamMultiSelectFormItem({ param }: ParamProps): JSX.Element;
6
+ export default function ParamMultiSelectFormItem({ param }: ParamProps): React.JSX.Element;
@@ -1,6 +1,6 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
3
3
  export interface ParamProps {
4
4
  param: Param;
5
5
  }
6
- export default function ParamSelectFormItem({ param }: ParamProps): JSX.Element;
6
+ export default function ParamSelectFormItem({ param }: ParamProps): React.JSX.Element;
@@ -1,6 +1,6 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import { Param } from "@theme/ApiExplorer/ParamOptions/slice";
3
3
  export interface ParamProps {
4
4
  param: Param;
5
5
  }
6
- export default function ParamTextFormItem({ param }: ParamProps): JSX.Element;
6
+ export default function ParamTextFormItem({ param }: ParamProps): React.JSX.Element;
@@ -1,7 +1,7 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import { Param } from "./slice";
3
3
  export interface ParamProps {
4
4
  param: Param;
5
5
  }
6
- declare function ParamOptions(): JSX.Element;
6
+ declare function ParamOptions(): React.JSX.Element;
7
7
  export default ParamOptions;
@@ -1,6 +1,6 @@
1
1
  import { PayloadAction } from "@reduxjs/toolkit";
2
2
  import { ParameterObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
3
- export declare type Param = ParameterObject & {
3
+ export type Param = ParameterObject & {
4
4
  value?: string[] | string;
5
5
  };
6
6
  export interface State {
@@ -1,6 +1,6 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
3
3
  declare function Request({ item }: {
4
4
  item: NonNullable<ApiItem>;
5
- }): JSX.Element | null;
5
+ }): React.JSX.Element | null;
6
6
  export default Request;
@@ -1,6 +1,6 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
3
3
  declare function Response({ item }: {
4
4
  item: NonNullable<ApiItem>;
5
- }): JSX.Element | null;
5
+ }): React.JSX.Element | null;
6
6
  export default Response;
@@ -1,3 +1,3 @@
1
- /// <reference types="react" />
2
- declare function SecuritySchemes(props: any): JSX.Element | null;
1
+ import React from "react";
2
+ declare function SecuritySchemes(props: any): React.JSX.Element | null;
3
3
  export default SecuritySchemes;
@@ -1,3 +1,3 @@
1
- /// <reference types="react" />
2
- declare function Server(): JSX.Element | null;
1
+ import React from "react";
2
+ declare function Server(): React.JSX.Element | null;
3
3
  export default Server;
@@ -2,7 +2,7 @@ import sdk from "@paloaltonetworks/postman-collection";
2
2
  import { AuthState } from "@theme/ApiExplorer/Authorization/slice";
3
3
  import { Body } from "@theme/ApiExplorer/Body/slice";
4
4
  import { ParameterObject, ServerObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
5
- declare type Param = {
5
+ type Param = {
6
6
  value?: string | string[];
7
7
  } & ParameterObject;
8
8
  interface Options {
@@ -1,7 +1,7 @@
1
- /// <reference types="react" />
1
+ import React from "react";
2
2
  import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
3
3
  declare function ApiExplorer({ item, infoPath, }: {
4
4
  item: NonNullable<ApiItem>;
5
5
  infoPath: string;
6
- }): JSX.Element;
6
+ }): React.JSX.Element;
7
7
  export default ApiExplorer;
@@ -1,4 +1,4 @@
1
1
  export declare function hashArray(arr: string[]): string;
2
- declare type Persistance = false | "localStorage" | "sessionStorage" | undefined;
2
+ type Persistance = false | "localStorage" | "sessionStorage" | undefined;
3
3
  export declare function createStorage(persistance: Persistance): Storage;
4
4
  export {};
@@ -7,8 +7,8 @@ declare const rootReducer: import("redux").Reducer<import("redux").CombinedState
7
7
  params: unknown;
8
8
  auth: unknown;
9
9
  }>, import("redux").Action<any>>;
10
- export declare type RootState = ReturnType<typeof rootReducer>;
11
- export declare const createStoreWithState: (preloadedState: RootState, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").CombinedState<{
10
+ export type RootState = ReturnType<typeof rootReducer>;
11
+ export declare const createStoreWithState: (preloadedState: RootState, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").EmptyObject & {
12
12
  accept: unknown;
13
13
  contentType: unknown;
14
14
  response: unknown;
@@ -16,7 +16,7 @@ export declare const createStoreWithState: (preloadedState: RootState, middlewar
16
16
  body: unknown;
17
17
  params: unknown;
18
18
  auth: unknown;
19
- }>, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
19
+ }, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
20
20
  accept: unknown;
21
21
  contentType: unknown;
22
22
  response: unknown;
@@ -25,7 +25,7 @@ export declare const createStoreWithState: (preloadedState: RootState, middlewar
25
25
  params: unknown;
26
26
  auth: unknown;
27
27
  }>, import("redux").AnyAction, undefined>, ...any[]]>>;
28
- export declare const createStoreWithoutState: (preloadedState: {}, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").CombinedState<{
28
+ export declare const createStoreWithoutState: (preloadedState: {}, middlewares: any[]) => import("@reduxjs/toolkit/dist/configureStore").ToolkitStore<import("redux").EmptyObject & {
29
29
  accept: unknown;
30
30
  contentType: unknown;
31
31
  response: unknown;
@@ -33,7 +33,7 @@ export declare const createStoreWithoutState: (preloadedState: {}, middlewares:
33
33
  body: unknown;
34
34
  params: unknown;
35
35
  auth: unknown;
36
- }>, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
36
+ }, import("redux").Action<any>, import("@reduxjs/toolkit").MiddlewareArray<[import("@reduxjs/toolkit").ThunkMiddleware<import("redux").CombinedState<{
37
37
  accept: unknown;
38
38
  contentType: unknown;
39
39
  response: unknown;
@@ -42,5 +42,5 @@ export declare const createStoreWithoutState: (preloadedState: {}, middlewares:
42
42
  params: unknown;
43
43
  auth: unknown;
44
44
  }>, import("redux").AnyAction, undefined>, ...any[]]>>;
45
- export declare type AppDispatch = ReturnType<typeof createStoreWithState>["dispatch"];
45
+ export type AppDispatch = ReturnType<typeof createStoreWithState>["dispatch"];
46
46
  export {};
package/lib/types.d.ts CHANGED
@@ -9,8 +9,8 @@ export interface ThemeConfig {
9
9
  interface Map<T> {
10
10
  [key: string]: T;
11
11
  }
12
- export declare type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
13
- export declare type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
12
+ export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
13
+ export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
14
14
  type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
15
15
  allOf?: SchemaObject[];
16
16
  oneOf?: SchemaObject[];
@@ -43,14 +43,14 @@ export interface ExternalDocumentationObject {
43
43
  description?: string;
44
44
  url: string;
45
45
  }
46
- export declare type FileChange = {
46
+ export type FileChange = {
47
47
  author?: string;
48
48
  /** Date can be any
49
49
  * [parsable date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
50
50
  */
51
51
  date?: Date | string;
52
52
  };
53
- export declare type DocFrontMatter = {
53
+ export type DocFrontMatter = {
54
54
  /**
55
55
  * The last part of the doc ID (will be refactored in the future to be the
56
56
  * full ID instead)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "docusaurus-theme-openapi-docs",
3
3
  "description": "OpenAPI theme for Docusaurus.",
4
- "version": "0.0.0-701",
4
+ "version": "0.0.0-703",
5
5
  "license": "MIT",
6
6
  "keywords": [
7
7
  "openapi",
@@ -43,7 +43,7 @@
43
43
  "clsx": "^1.1.1",
44
44
  "copy-text-to-clipboard": "^3.1.0",
45
45
  "crypto-js": "^4.1.1",
46
- "docusaurus-plugin-openapi-docs": "0.0.0-701",
46
+ "docusaurus-plugin-openapi-docs": "0.0.0-703",
47
47
  "docusaurus-plugin-sass": "^0.2.3",
48
48
  "file-saver": "^2.0.5",
49
49
  "lodash": "^4.17.20",
@@ -68,5 +68,5 @@
68
68
  "engines": {
69
69
  "node": ">=14"
70
70
  },
71
- "gitHead": "19fb5921275de6a9c0b91fbc4103f0b1c930e1ec"
71
+ "gitHead": "091f57323887bc2491bfdb3b81a964edae7b9832"
72
72
  }