docusaurus-theme-openapi-docs 1.4.2 → 1.4.4

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 (128) hide show
  1. package/lib/index.js +5 -8
  2. package/lib/markdown/createDescription.js +1 -2
  3. package/lib/markdown/schema.js +7 -42
  4. package/lib/markdown/utils.js +1 -7
  5. package/lib/theme/ApiDemoPanel/Accept/index.js +1 -10
  6. package/lib/theme/ApiDemoPanel/Accept/slice.js +1 -2
  7. package/lib/theme/ApiDemoPanel/Authorization/auth-types.js +7 -8
  8. package/lib/theme/ApiDemoPanel/Authorization/index.js +1 -19
  9. package/lib/theme/ApiDemoPanel/Authorization/slice.js +7 -21
  10. package/lib/theme/ApiDemoPanel/Body/index.js +14 -47
  11. package/lib/theme/ApiDemoPanel/Body/slice.js +1 -4
  12. package/lib/theme/ApiDemoPanel/CodeTabs/index.js +14 -46
  13. package/lib/theme/ApiDemoPanel/ContentType/index.js +1 -10
  14. package/lib/theme/ApiDemoPanel/ContentType/slice.js +1 -2
  15. package/lib/theme/ApiDemoPanel/Curl/index.js +9 -29
  16. package/lib/theme/ApiDemoPanel/Execute/index.js +6 -23
  17. package/lib/theme/ApiDemoPanel/Execute/makeRequest.js +4 -27
  18. package/lib/theme/ApiDemoPanel/Export/index.js +1 -8
  19. package/lib/theme/ApiDemoPanel/FloatingButton/index.js +1 -5
  20. package/lib/theme/ApiDemoPanel/FormFileUpload/index.js +1 -14
  21. package/lib/theme/ApiDemoPanel/FormItem/index.js +1 -5
  22. package/lib/theme/ApiDemoPanel/FormMultiSelect/index.js +1 -8
  23. package/lib/theme/ApiDemoPanel/FormSelect/index.js +1 -6
  24. package/lib/theme/ApiDemoPanel/FormTextInput/index.js +1 -6
  25. package/lib/theme/ApiDemoPanel/LiveEditor/index.js +3 -17
  26. package/lib/theme/ApiDemoPanel/MethodEndpoint/index.js +1 -12
  27. package/lib/theme/ApiDemoPanel/ParamOptions/index.js +20 -52
  28. package/lib/theme/ApiDemoPanel/ParamOptions/slice.js +1 -2
  29. package/lib/theme/ApiDemoPanel/Request/index.js +1 -15
  30. package/lib/theme/ApiDemoPanel/Response/index.js +1 -14
  31. package/lib/theme/ApiDemoPanel/Response/slice.js +1 -2
  32. package/lib/theme/ApiDemoPanel/SecuritySchemes/index.js +1 -9
  33. package/lib/theme/ApiDemoPanel/Server/index.js +3 -27
  34. package/lib/theme/ApiDemoPanel/Server/slice.js +1 -3
  35. package/lib/theme/ApiDemoPanel/buildPostmanRequest.js +11 -62
  36. package/lib/theme/ApiDemoPanel/index.js +2 -14
  37. package/lib/theme/ApiDemoPanel/persistanceMiddleware.js +5 -11
  38. package/lib/theme/ApiDemoPanel/storage-utils.js +1 -7
  39. package/lib/theme/ApiItem/Layout/index.js +5 -22
  40. package/lib/theme/ApiItem/Layout/styles.module.css +0 -403
  41. package/lib/theme/ApiItem/hooks.js +1 -3
  42. package/lib/theme/ApiItem/index.js +14 -30
  43. package/lib/theme/ApiItem/store.js +1 -14
  44. package/lib/theme/ApiLogo/index.js +1 -4
  45. package/lib/theme/styles.css +428 -0
  46. package/lib/theme-classic.d.ts +5 -0
  47. package/lib-next/index.js +5 -3
  48. package/lib-next/markdown/createDescription.js +1 -1
  49. package/lib-next/markdown/schema.js +7 -35
  50. package/lib-next/markdown/utils.js +1 -4
  51. package/lib-next/theme/ApiDemoPanel/Accept/index.js +1 -4
  52. package/lib-next/theme/ApiDemoPanel/Accept/slice.js +1 -0
  53. package/lib-next/theme/ApiDemoPanel/Authorization/auth-types.js +7 -4
  54. package/lib-next/theme/ApiDemoPanel/Authorization/index.js +1 -8
  55. package/lib-next/theme/ApiDemoPanel/Authorization/slice.js +12 -14
  56. package/lib-next/theme/ApiDemoPanel/Body/index.js +16 -34
  57. package/lib-next/theme/ApiDemoPanel/Body/slice.js +1 -2
  58. package/lib-next/theme/ApiDemoPanel/CodeTabs/index.js +12 -26
  59. package/lib-next/theme/ApiDemoPanel/ContentType/index.js +1 -4
  60. package/lib-next/theme/ApiDemoPanel/ContentType/slice.js +1 -0
  61. package/lib-next/theme/ApiDemoPanel/Curl/index.js +11 -12
  62. package/lib-next/theme/ApiDemoPanel/Execute/index.js +10 -13
  63. package/lib-next/theme/ApiDemoPanel/Execute/makeRequest.js +4 -22
  64. package/lib-next/theme/ApiDemoPanel/Export/index.js +1 -5
  65. package/lib-next/theme/ApiDemoPanel/FloatingButton/index.js +1 -2
  66. package/lib-next/theme/ApiDemoPanel/FormFileUpload/index.js +1 -7
  67. package/lib-next/theme/ApiDemoPanel/FormItem/index.js +1 -2
  68. package/lib-next/theme/ApiDemoPanel/FormMultiSelect/index.js +1 -5
  69. package/lib-next/theme/ApiDemoPanel/FormSelect/index.js +1 -3
  70. package/lib-next/theme/ApiDemoPanel/FormTextInput/index.js +1 -2
  71. package/lib-next/theme/ApiDemoPanel/LiveEditor/index.js +3 -6
  72. package/lib-next/theme/ApiDemoPanel/MethodEndpoint/index.js +1 -9
  73. package/lib-next/theme/ApiDemoPanel/ParamOptions/index.js +34 -29
  74. package/lib-next/theme/ApiDemoPanel/ParamOptions/slice.js +1 -0
  75. package/lib-next/theme/ApiDemoPanel/Request/index.js +1 -2
  76. package/lib-next/theme/ApiDemoPanel/Response/index.js +3 -9
  77. package/lib-next/theme/ApiDemoPanel/Response/slice.js +1 -0
  78. package/lib-next/theme/ApiDemoPanel/SecuritySchemes/index.js +1 -5
  79. package/lib-next/theme/ApiDemoPanel/Server/index.js +3 -13
  80. package/lib-next/theme/ApiDemoPanel/Server/slice.js +1 -0
  81. package/lib-next/theme/ApiDemoPanel/buildPostmanRequest.js +12 -49
  82. package/lib-next/theme/ApiDemoPanel/index.js +2 -4
  83. package/lib-next/theme/ApiDemoPanel/persistanceMiddleware.js +5 -6
  84. package/lib-next/theme/ApiDemoPanel/storage-utils.js +1 -3
  85. package/lib-next/theme/ApiItem/Layout/index.js +8 -9
  86. package/lib-next/theme/ApiItem/Layout/styles.module.css +0 -403
  87. package/lib-next/theme/ApiItem/hooks.js +1 -0
  88. package/lib-next/theme/ApiItem/index.js +14 -13
  89. package/lib-next/theme/ApiItem/store.js +1 -0
  90. package/lib-next/theme/ApiLogo/index.js +1 -0
  91. package/lib-next/theme/styles.css +428 -0
  92. package/lib-next/theme-classic.d.ts +5 -0
  93. package/package.json +5 -5
  94. package/src/index.ts +5 -0
  95. package/src/theme/ApiDemoPanel/Execute/index.tsx +1 -0
  96. package/src/theme/ApiDemoPanel/index.tsx +1 -2
  97. package/src/theme/ApiItem/Layout/index.tsx +5 -6
  98. package/src/theme/ApiItem/Layout/styles.module.css +0 -403
  99. package/src/theme/ApiItem/index.tsx +5 -4
  100. package/src/theme/styles.css +428 -0
  101. package/src/theme-classic.d.ts +5 -0
  102. package/lib/theme/ApiDemoPanel/styles.module.css +0 -44
  103. package/lib/theme/ApiItem/Content/index.js +0 -65
  104. package/lib/theme/ApiItem/Footer/index.js +0 -78
  105. package/lib/theme/ApiItem/Footer/styles.module.css +0 -18
  106. package/lib/theme/ApiItem/Metadata/index.js +0 -32
  107. package/lib/theme/ApiItem/Paginator/index.js +0 -33
  108. package/lib/theme/ApiItem/TOC/Desktop/index.js +0 -31
  109. package/lib/theme/ApiItem/TOC/Mobile/index.js +0 -35
  110. package/lib/theme/ApiItem/TOC/Mobile/styles.module.css +0 -19
  111. package/lib-next/theme/ApiDemoPanel/styles.module.css +0 -44
  112. package/lib-next/theme/ApiItem/Content/index.js +0 -55
  113. package/lib-next/theme/ApiItem/Footer/index.js +0 -88
  114. package/lib-next/theme/ApiItem/Footer/styles.module.css +0 -18
  115. package/lib-next/theme/ApiItem/Metadata/index.js +0 -21
  116. package/lib-next/theme/ApiItem/Paginator/index.js +0 -19
  117. package/lib-next/theme/ApiItem/TOC/Desktop/index.js +0 -22
  118. package/lib-next/theme/ApiItem/TOC/Mobile/index.js +0 -24
  119. package/lib-next/theme/ApiItem/TOC/Mobile/styles.module.css +0 -19
  120. package/src/theme/ApiDemoPanel/styles.module.css +0 -44
  121. package/src/theme/ApiItem/Content/index.tsx +0 -57
  122. package/src/theme/ApiItem/Footer/index.tsx +0 -101
  123. package/src/theme/ApiItem/Footer/styles.module.css +0 -18
  124. package/src/theme/ApiItem/Metadata/index.tsx +0 -24
  125. package/src/theme/ApiItem/Paginator/index.tsx +0 -21
  126. package/src/theme/ApiItem/TOC/Desktop/index.tsx +0 -25
  127. package/src/theme/ApiItem/TOC/Mobile/index.tsx +0 -28
  128. package/src/theme/ApiItem/TOC/Mobile/styles.module.css +0 -19
package/lib/theme/ApiDemoPanel/Body/index.js CHANGED
@@ -4,70 +4,59 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.default = void 0;
7
-
8
7
  var _react = _interopRequireDefault(require("react"));
9
-
10
8
  var _TabItem = _interopRequireDefault(require("@theme/TabItem"));
11
-
12
9
  var _xmlFormatter = _interopRequireDefault(require("xml-formatter"));
13
-
14
10
  var _hooks = require("../../ApiItem/hooks");
15
-
16
11
  var _SchemaTabs = _interopRequireDefault(require("../../SchemaTabs"));
17
-
18
12
  var _ContentType = _interopRequireDefault(require("../ContentType"));
19
-
20
13
  var _FormSelect = _interopRequireDefault(require("../FormSelect"));
21
-
22
14
  var _LiveEditor = _interopRequireDefault(require("../LiveEditor"));
23
-
24
15
  var _FormFileUpload = _interopRequireDefault(require("./../FormFileUpload"));
25
-
26
16
  var _FormItem = _interopRequireDefault(require("./../FormItem"));
27
-
28
17
  var _FormTextInput = _interopRequireDefault(require("./../FormTextInput"));
29
-
30
18
  var _json2xml = _interopRequireDefault(require("./json2xml"));
31
-
32
19
  var _slice = require("./slice");
33
-
34
20
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
35
-
36
21
  /* ============================================================================
37
22
  * Copyright (c) Palo Alto Networks
38
23
  *
39
24
  * This source code is licensed under the MIT license found in the
40
25
  * LICENSE file in the root directory of this source tree.
41
26
  * ========================================================================== */
27
+
42
28
  // @ts-ignore
29
+
43
30
  // @ts-ignore
31
+
44
32
  function BodyWrap({
45
33
  requestBodyMetadata,
46
34
  jsonRequestBodyExample
47
35
  }) {
48
- const contentType = (0, _hooks.useTypedSelector)(state => state.contentType.value); // NOTE: We used to check if body was required, but opted to always show the request body
36
+ const contentType = (0, _hooks.useTypedSelector)(state => state.contentType.value);
37
+
38
+ // NOTE: We used to check if body was required, but opted to always show the request body
49
39
  // to reduce confusion, see: https://github.com/cloud-annotations/docusaurus-openapi/issues/145
50
- // No body
51
40
 
41
+ // No body
52
42
  if (contentType === undefined) {
53
43
  return null;
54
44
  }
55
-
56
45
  return <>
57
46
  <_ContentType.default />
58
47
  <Body requestBodyMetadata={requestBodyMetadata} jsonRequestBodyExample={jsonRequestBodyExample} />
59
48
  </>;
60
49
  }
61
-
62
50
  function Body({
63
51
  requestBodyMetadata,
64
52
  jsonRequestBodyExample
65
53
  }) {
66
54
  var _requestBodyMetadata$, _requestBodyMetadata$2, _requestBodyMetadata$3, _requestBodyMetadata$4, _requestBodyMetadata$5, _requestBodyMetadata$6;
67
-
68
55
  const contentType = (0, _hooks.useTypedSelector)(state => state.contentType.value);
69
56
  const required = requestBodyMetadata === null || requestBodyMetadata === void 0 ? void 0 : requestBodyMetadata.required;
70
- const dispatch = (0, _hooks.useTypedDispatch)(); // Lot's of possible content-types:
57
+ const dispatch = (0, _hooks.useTypedDispatch)();
58
+
59
+ // Lot's of possible content-types:
71
60
  // - application/json
72
61
  // - application/xml
73
62
  // - text/plain
@@ -78,10 +67,12 @@ function Body({
78
67
  // - multipart/form-data
79
68
  // - application/x-www-form-urlencoded
80
69
  // - image/svg+xml;charset=US-ASCII
70
+
81
71
  // Show editor:
82
72
  // - application/json
83
73
  // - application/xml
84
74
  // - */*
75
+
85
76
  // Show form:
86
77
  // - multipart/form-data
87
78
  // - application/x-www-form-urlencoded
@@ -89,7 +80,6 @@ function Body({
89
80
  const schema = requestBodyMetadata === null || requestBodyMetadata === void 0 ? void 0 : (_requestBodyMetadata$ = requestBodyMetadata.content) === null || _requestBodyMetadata$ === void 0 ? void 0 : (_requestBodyMetadata$2 = _requestBodyMetadata$[contentType]) === null || _requestBodyMetadata$2 === void 0 ? void 0 : _requestBodyMetadata$2.schema;
90
81
  const example = requestBodyMetadata === null || requestBodyMetadata === void 0 ? void 0 : (_requestBodyMetadata$3 = requestBodyMetadata.content) === null || _requestBodyMetadata$3 === void 0 ? void 0 : (_requestBodyMetadata$4 = _requestBodyMetadata$3[contentType]) === null || _requestBodyMetadata$4 === void 0 ? void 0 : _requestBodyMetadata$4.example;
91
82
  const examples = requestBodyMetadata === null || requestBodyMetadata === void 0 ? void 0 : (_requestBodyMetadata$5 = requestBodyMetadata.content) === null || _requestBodyMetadata$5 === void 0 ? void 0 : (_requestBodyMetadata$6 = _requestBodyMetadata$5[contentType]) === null || _requestBodyMetadata$6 === void 0 ? void 0 : _requestBodyMetadata$6.examples;
92
-
93
83
  if ((schema === null || schema === void 0 ? void 0 : schema.format) === "binary") {
94
84
  return <_FormItem.default label="Body" required={required}>
95
85
  <_FormFileUpload.default placeholder={schema.description || "Body"} onChange={file => {
@@ -97,7 +87,6 @@ function Body({
97
87
  dispatch((0, _slice.clearRawBody)());
98
88
  return;
99
89
  }
100
-
101
90
  dispatch((0, _slice.setFileRawBody)({
102
91
  src: `/path/to/${file.name}`,
103
92
  content: file
@@ -105,10 +94,8 @@ function Body({
105
94
  }} />
106
95
  </_FormItem.default>;
107
96
  }
108
-
109
97
  if ((contentType === "multipart/form-data" || contentType === "application/x-www-form-urlencoded") && (schema === null || schema === void 0 ? void 0 : schema.type) === "object") {
110
98
  var _schema$properties;
111
-
112
99
  return <_FormItem.default label="Body" required={required}>
113
100
  <div style={{
114
101
  marginTop: "calc(var(--ifm-pre-padding) / 2)",
@@ -124,7 +111,6 @@ function Body({
124
111
  dispatch((0, _slice.clearFormBodyKey)(key));
125
112
  return;
126
113
  }
127
-
128
114
  dispatch((0, _slice.setFileFormBody)({
129
115
  key: key,
130
116
  value: {
@@ -135,12 +121,10 @@ function Body({
135
121
  }} />
136
122
  </_FormItem.default>;
137
123
  }
138
-
139
124
  if (val.enum) {
140
125
  return <_FormItem.default key={key} label={key} required={Array.isArray(schema.required) && schema.required.includes(key)}>
141
126
  <_FormSelect.default options={["---", ...val.enum]} onChange={e => {
142
127
  const val = e.target.value;
143
-
144
128
  if (val === "---") {
145
129
  dispatch((0, _slice.clearFormBodyKey)(key));
146
130
  } else {
@@ -151,9 +135,8 @@ function Body({
151
135
  }
152
136
  }} />
153
137
  </_FormItem.default>;
154
- } // TODO: support all the other types.
155
-
156
-
138
+ }
139
+ // TODO: support all the other types.
157
140
  return <_FormItem.default key={key} label={key} required={Array.isArray(schema.required) && schema.required.includes(key)}>
158
141
  <_FormTextInput.default placeholder={val.description || key} onChange={e => {
159
142
  dispatch((0, _slice.setStringFormBody)({
@@ -166,22 +149,17 @@ function Body({
166
149
  </div>
167
150
  </_FormItem.default>;
168
151
  }
169
-
170
152
  let language = "plaintext";
171
153
  let defaultBody = ""; //"body content";
172
-
173
154
  let exampleBody;
174
155
  let examplesBodies = [];
175
-
176
156
  if (contentType === "application/json" || contentType.endsWith("+json")) {
177
157
  if (jsonRequestBodyExample) {
178
158
  defaultBody = JSON.stringify(jsonRequestBodyExample, null, 2);
179
159
  }
180
-
181
160
  if (example) {
182
161
  exampleBody = JSON.stringify(example, null, 2);
183
162
  }
184
-
185
163
  if (examples) {
186
164
  for (const [key, example] of Object.entries(examples)) {
187
165
  examplesBodies.push({
@@ -191,10 +169,8 @@ function Body({
191
169
  });
192
170
  }
193
171
  }
194
-
195
172
  language = "json";
196
173
  }
197
-
198
174
  if (contentType === "application/xml" || contentType.endsWith("+xml")) {
199
175
  if (jsonRequestBodyExample) {
200
176
  try {
@@ -207,7 +183,6 @@ function Body({
207
183
  defaultBody = (0, _json2xml.default)(jsonRequestBodyExample);
208
184
  }
209
185
  }
210
-
211
186
  if (example) {
212
187
  try {
213
188
  exampleBody = (0, _xmlFormatter.default)((0, _json2xml.default)(example, ""), {
@@ -219,11 +194,9 @@ function Body({
219
194
  exampleBody = (0, _json2xml.default)(example);
220
195
  }
221
196
  }
222
-
223
197
  if (examples) {
224
198
  for (const [key, example] of Object.entries(examples)) {
225
199
  let formattedXmlBody;
226
-
227
200
  try {
228
201
  formattedXmlBody = (0, _xmlFormatter.default)(example.value, {
229
202
  indentation: " ",
@@ -233,7 +206,6 @@ function Body({
233
206
  } catch {
234
207
  formattedXmlBody = example.value;
235
208
  }
236
-
237
209
  examplesBodies.push({
238
210
  label: key,
239
211
  body: formattedXmlBody,
@@ -241,10 +213,8 @@ function Body({
241
213
  });
242
214
  }
243
215
  }
244
-
245
216
  language = "xml";
246
217
  }
247
-
248
218
  if (exampleBody) {
249
219
  return <_FormItem.default label="Body" required={required}>
250
220
  <_SchemaTabs.default lazy>
@@ -261,7 +231,6 @@ function Body({
261
231
  </_SchemaTabs.default>
262
232
  </_FormItem.default>;
263
233
  }
264
-
265
234
  if (examplesBodies && examplesBodies.length > 0) {
266
235
  return <_FormItem.default label="Body" required={required}>
267
236
  <_SchemaTabs.default lazy>
@@ -281,13 +250,11 @@ function Body({
281
250
  </_SchemaTabs.default>
282
251
  </_FormItem.default>;
283
252
  }
284
-
285
253
  return <_FormItem.default label="Body" required={required}>
286
254
  <_LiveEditor.default action={dispatch} language={language}>
287
255
  {defaultBody}
288
256
  </_LiveEditor.default>
289
257
  </_FormItem.default>;
290
258
  }
291
-
292
259
  var _default = BodyWrap;
293
260
  exports.default = _default;
package/lib/theme/ApiDemoPanel/Body/slice.js CHANGED
@@ -4,15 +4,14 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.slice = exports.setStringRawBody = exports.setStringFormBody = exports.setFileRawBody = exports.setFileFormBody = exports.default = exports.clearRawBody = exports.clearFormBodyKey = void 0;
7
-
8
7
  var _toolkit = require("@reduxjs/toolkit");
9
-
10
8
  /* ============================================================================
11
9
  * Copyright (c) Palo Alto Networks
12
10
  *
13
11
  * This source code is licensed under the MIT license found in the
14
12
  * LICENSE file in the root directory of this source tree.
15
13
  * ========================================================================== */
14
+
16
15
  const initialState = {};
17
16
  const slice = (0, _toolkit.createSlice)({
18
17
  name: "body",
@@ -58,7 +57,6 @@ const slice = (0, _toolkit.createSlice)({
58
57
  }
59
58
  };
60
59
  }
61
-
62
60
  state.content[action.payload.key] = {
63
61
  type: "string",
64
62
  value: action.payload.value
@@ -77,7 +75,6 @@ const slice = (0, _toolkit.createSlice)({
77
75
  }
78
76
  };
79
77
  }
80
-
81
78
  state.content[action.payload.key] = {
82
79
  type: "file",
83
80
  value: action.payload.value
package/lib/theme/ApiDemoPanel/CodeTabs/index.js CHANGED
@@ -4,45 +4,34 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.default = CodeTabs;
7
-
8
7
  var _react = _interopRequireWildcard(require("react"));
9
-
10
8
  var _themeCommon = require("@docusaurus/theme-common");
11
-
12
9
  var _useIsBrowser = _interopRequireDefault(require("@docusaurus/useIsBrowser"));
13
-
14
10
  var _clsx = _interopRequireDefault(require("clsx"));
15
-
16
11
  var _Curl = require("../Curl");
17
-
18
12
  var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
19
-
20
13
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
21
-
22
14
  function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
23
-
24
15
  function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
25
-
26
16
  /* ============================================================================
27
17
  * Copyright (c) Palo Alto Networks
28
18
  *
29
19
  * This source code is licensed under the MIT license found in the
30
20
  * LICENSE file in the root directory of this source tree.
31
21
  * ========================================================================== */
22
+
32
23
  const {
33
24
  useScrollPositionBlocker,
34
25
  useTabGroupChoice
35
- } = require("@docusaurus/theme-common/internal"); // A very rough duck type, but good enough to guard against mistakes while
36
- // allowing customization
37
-
26
+ } = require("@docusaurus/theme-common/internal");
38
27
 
28
+ // A very rough duck type, but good enough to guard against mistakes while
29
+ // allowing customization
39
30
  function isTabItem(comp) {
40
31
  return "value" in comp.props;
41
32
  }
42
-
43
33
  function TabsComponent(props) {
44
34
  var _ref, _children$find;
45
-
46
35
  const {
47
36
  lazy,
48
37
  block,
@@ -52,19 +41,18 @@ function TabsComponent(props) {
52
41
  className,
53
42
  action
54
43
  } = props;
55
-
56
44
  const children = _react.default.Children.map(props.children, child => {
57
45
  if ((0, _react.isValidElement)(child) && isTabItem(child)) {
58
46
  return child;
59
- } // child.type.name will give non-sensical values in prod because of
47
+ }
48
+ // child.type.name will give non-sensical values in prod because of
60
49
  // minification, but we assume it won't throw in prod.
61
-
62
-
63
- throw new Error(`Docusaurus error: Bad <Tabs> child <${// @ts-expect-error: guarding against unexpected cases
50
+ throw new Error(`Docusaurus error: Bad <Tabs> child <${
51
+ // @ts-expect-error: guarding against unexpected cases
64
52
  typeof child.type === "string" ? child.type : child.type.name}>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`);
65
53
  });
66
-
67
- const values = valuesProp !== null && valuesProp !== void 0 ? valuesProp : // Only pick keys that we recognize. MDX would inject some keys by default
54
+ const values = valuesProp !== null && valuesProp !== void 0 ? valuesProp :
55
+ // Only pick keys that we recognize. MDX would inject some keys by default
68
56
  children.map(({
69
57
  props: {
70
58
  value,
@@ -77,18 +65,14 @@ function TabsComponent(props) {
77
65
  attributes
78
66
  }));
79
67
  const dup = (0, _themeCommon.duplicates)(values, (a, b) => a.value === b.value);
80
-
81
68
  if (dup.length > 0) {
82
69
  throw new Error(`Docusaurus error: Duplicate values "${dup.map(a => a.value).join(", ")}" found in <Tabs>. Every value needs to be unique.`);
83
- } // When defaultValueProp is null, don't show a default tab
84
-
85
-
70
+ }
71
+ // When defaultValueProp is null, don't show a default tab
86
72
  const defaultValue = defaultValueProp === null ? defaultValueProp : (_ref = defaultValueProp !== null && defaultValueProp !== void 0 ? defaultValueProp : (_children$find = children.find(child => child.props.default)) === null || _children$find === void 0 ? void 0 : _children$find.props.value) !== null && _ref !== void 0 ? _ref : children[0].props.value;
87
-
88
73
  if (defaultValue !== null && !values.some(a => a.value === defaultValue)) {
89
74
  throw new Error(`Docusaurus error: The <Tabs> has a defaultValue "${defaultValue}" but none of its children has the corresponding value. Available values are: ${values.map(a => a.value).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);
90
75
  }
91
-
92
76
  const {
93
77
  tabGroupChoices,
94
78
  setTabGroupChoices
@@ -98,67 +82,51 @@ function TabsComponent(props) {
98
82
  const {
99
83
  blockElementScrollPositionUntilNextRender
100
84
  } = useScrollPositionBlocker();
101
-
102
85
  if (groupId != null) {
103
86
  const relevantTabGroupChoice = tabGroupChoices[groupId];
104
-
105
87
  if (relevantTabGroupChoice != null && relevantTabGroupChoice !== selectedValue && values.some(value => value.value === relevantTabGroupChoice)) {
106
88
  setSelectedValue(relevantTabGroupChoice);
107
89
  }
108
90
  }
109
-
110
91
  const handleTabChange = event => {
111
92
  const newTab = event.currentTarget;
112
93
  const newTabIndex = tabRefs.indexOf(newTab);
113
94
  const newTabValue = values[newTabIndex].value;
114
-
115
95
  if (newTabValue !== selectedValue) {
116
96
  blockElementScrollPositionUntilNextRender(newTab);
117
97
  setSelectedValue(newTabValue);
118
-
119
98
  if (action) {
120
99
  const newLanguage = _Curl.languageSet.filter(lang => lang.language === newTabValue);
121
-
122
100
  action(newLanguage[0]);
123
101
  }
124
-
125
102
  if (groupId != null) {
126
103
  setTabGroupChoices(groupId, String(newTabValue));
127
104
  }
128
105
  }
129
106
  };
130
-
131
107
  const handleKeydown = event => {
132
108
  var _focusElement;
133
-
134
109
  let focusElement = null;
135
-
136
110
  switch (event.key) {
137
111
  case "ArrowRight":
138
112
  {
139
113
  var _tabRefs$nextTab;
140
-
141
114
  const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
142
115
  focusElement = (_tabRefs$nextTab = tabRefs[nextTab]) !== null && _tabRefs$nextTab !== void 0 ? _tabRefs$nextTab : tabRefs[0];
143
116
  break;
144
117
  }
145
-
146
118
  case "ArrowLeft":
147
119
  {
148
120
  var _tabRefs$prevTab;
149
-
150
121
  const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
151
122
  focusElement = (_tabRefs$prevTab = tabRefs[prevTab]) !== null && _tabRefs$prevTab !== void 0 ? _tabRefs$prevTab : tabRefs[tabRefs.length - 1];
152
123
  break;
153
124
  }
154
-
155
125
  default:
156
126
  break;
157
127
  }
158
-
159
128
  (_focusElement = focusElement) === null || _focusElement === void 0 ? void 0 : _focusElement.focus();
160
129
  };
161
-
162
130
  return <div className={(0, _clsx.default)("tabs-container", _stylesModule.default.tabList)}>
163
131
  <ul role="tablist" aria-orientation="horizontal" className={(0, _clsx.default)("tabs", {
164
132
  "tabs--block": block
@@ -184,10 +152,10 @@ function TabsComponent(props) {
184
152
  </div>}
185
153
  </div>;
186
154
  }
187
-
188
155
  function CodeTabs(props) {
189
156
  const isBrowser = (0, _useIsBrowser.default)();
190
- return <TabsComponent // Remount tabs after hydration
157
+ return <TabsComponent
158
+ // Remount tabs after hydration
191
159
  // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
192
160
  key={String(isBrowser)} {...props} />;
193
161
  }
package/lib/theme/ApiDemoPanel/ContentType/index.js CHANGED
@@ -4,38 +4,29 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.default = void 0;
7
-
8
7
  var _react = _interopRequireDefault(require("react"));
9
-
10
8
  var _hooks = require("../../ApiItem/hooks");
11
-
12
9
  var _FormItem = _interopRequireDefault(require("./../FormItem"));
13
-
14
10
  var _FormSelect = _interopRequireDefault(require("./../FormSelect"));
15
-
16
11
  var _slice = require("./slice");
17
-
18
12
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
19
-
20
13
  /* ============================================================================
21
14
  * Copyright (c) Palo Alto Networks
22
15
  *
23
16
  * This source code is licensed under the MIT license found in the
24
17
  * LICENSE file in the root directory of this source tree.
25
18
  * ========================================================================== */
19
+
26
20
  function ContentType() {
27
21
  const value = (0, _hooks.useTypedSelector)(state => state.contentType.value);
28
22
  const options = (0, _hooks.useTypedSelector)(state => state.contentType.options);
29
23
  const dispatch = (0, _hooks.useTypedDispatch)();
30
-
31
24
  if (options.length <= 1) {
32
25
  return null;
33
26
  }
34
-
35
27
  return <_FormItem.default label="Content-Type">
36
28
  <_FormSelect.default value={value} options={options} onChange={e => dispatch((0, _slice.setContentType)(e.target.value))} />
37
29
  </_FormItem.default>;
38
30
  }
39
-
40
31
  var _default = ContentType;
41
32
  exports.default = _default;
package/lib/theme/ApiDemoPanel/ContentType/slice.js CHANGED
@@ -4,15 +4,14 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.slice = exports.setContentType = exports.default = void 0;
7
-
8
7
  var _toolkit = require("@reduxjs/toolkit");
9
-
10
8
  /* ============================================================================
11
9
  * Copyright (c) Palo Alto Networks
12
10
  *
13
11
  * This source code is licensed under the MIT license found in the
14
12
  * LICENSE file in the root directory of this source tree.
15
13
  * ========================================================================== */
14
+
16
15
  const initialState = {};
17
16
  const slice = (0, _toolkit.createSlice)({
18
17
  name: "contentType",
package/lib/theme/ApiDemoPanel/Curl/index.js CHANGED
@@ -4,37 +4,25 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.languageSet = exports.default = void 0;
7
-
8
7
  var _react = _interopRequireWildcard(require("react"));
9
-
10
8
  var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
11
-
12
9
  var _postmanCodeGenerators = _interopRequireDefault(require("@paloaltonetworks/postman-code-generators"));
13
-
14
10
  var _CodeBlock = _interopRequireDefault(require("@theme/CodeBlock"));
15
-
16
11
  var _clsx = _interopRequireDefault(require("clsx"));
17
-
18
12
  var _hooks = require("../../ApiItem/hooks");
19
-
20
13
  var _CodeTabs = _interopRequireDefault(require("../CodeTabs"));
21
-
22
14
  var _buildPostmanRequest = _interopRequireDefault(require("./../buildPostmanRequest"));
23
-
24
15
  var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
25
-
26
16
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
27
-
28
17
  function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
29
-
30
18
  function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
31
-
32
19
  /* ============================================================================
33
20
  * Copyright (c) Palo Alto Networks
34
21
  *
35
22
  * This source code is licensed under the MIT license found in the
36
23
  * LICENSE file in the root directory of this source tree.
37
24
  * ========================================================================== */
25
+
38
26
  const languageSet = [{
39
27
  highlight: "bash",
40
28
  language: "curl",
@@ -102,7 +90,6 @@ const languageSet = [{
102
90
  variant: "cURL"
103
91
  }];
104
92
  exports.languageSet = languageSet;
105
-
106
93
  function CodeTab({
107
94
  children,
108
95
  hidden,
@@ -115,14 +102,13 @@ function CodeTab({
115
102
  {children}
116
103
  </div>;
117
104
  }
118
-
119
105
  function Curl({
120
106
  postman,
121
107
  codeSamples
122
108
  }) {
123
109
  var _ref, _siteConfig$themeConf;
124
-
125
110
  // TODO: match theme for vscode.
111
+
126
112
  const {
127
113
  siteConfig
128
114
  } = (0, _useDocusaurusContext.default)();
@@ -134,17 +120,16 @@ function Curl({
134
120
  const queryParams = (0, _hooks.useTypedSelector)(state => state.params.query);
135
121
  const cookieParams = (0, _hooks.useTypedSelector)(state => state.params.cookie);
136
122
  const headerParams = (0, _hooks.useTypedSelector)(state => state.params.header);
137
- const auth = (0, _hooks.useTypedSelector)(state => state.auth); // TODO
123
+ const auth = (0, _hooks.useTypedSelector)(state => state.auth);
138
124
 
125
+ // TODO
139
126
  const langs = [...((_ref = siteConfig === null || siteConfig === void 0 ? void 0 : (_siteConfig$themeConf = siteConfig.themeConfig) === null || _siteConfig$themeConf === void 0 ? void 0 : _siteConfig$themeConf.languageTabs) !== null && _ref !== void 0 ? _ref : languageSet), ...codeSamples];
140
127
  const defaultLang = languageSet.filter(lang => lang.language === localStorage.getItem("docusaurus.tab.code-samples"));
141
128
  const [language, setLanguage] = (0, _react.useState)(() => {
142
129
  var _defaultLang$;
143
-
144
130
  if (langs.length === 1) {
145
131
  return langs[0];
146
132
  }
147
-
148
133
  return (_defaultLang$ = defaultLang[0]) !== null && _defaultLang$ !== void 0 ? _defaultLang$ : langs[0];
149
134
  });
150
135
  const [codeText, setCodeText] = (0, _react.useState)("");
@@ -161,22 +146,22 @@ function Curl({
161
146
  server,
162
147
  auth
163
148
  });
164
-
165
149
  _postmanCodeGenerators.default.convert(language.language, language.variant, postmanRequest, language.options, (error, snippet) => {
166
150
  if (error) {
167
151
  return;
168
152
  }
169
-
170
153
  setCodeText(snippet);
171
154
  });
172
155
  } else if (language && !!language.source) {
173
156
  setCodeText(language.source);
174
157
  } else if (language && !language.options) {
175
- const langSource = languageSet.filter(lang => lang.language === language.language); // Merges user-defined language with default languageSet
158
+ const langSource = languageSet.filter(lang => lang.language === language.language);
159
+
160
+ // Merges user-defined language with default languageSet
176
161
  // This allows users to define only the minimal properties necessary in languageTabs
177
162
  // User-defined properties should override languageSet properties
178
-
179
- const mergedLanguage = { ...langSource[0],
163
+ const mergedLanguage = {
164
+ ...langSource[0],
180
165
  ...language
181
166
  };
182
167
  const postmanRequest = (0, _buildPostmanRequest.default)(postman, {
@@ -190,23 +175,19 @@ function Curl({
190
175
  server,
191
176
  auth
192
177
  });
193
-
194
178
  _postmanCodeGenerators.default.convert(mergedLanguage.language, mergedLanguage.variant, postmanRequest, mergedLanguage.options, (error, snippet) => {
195
179
  if (error) {
196
180
  return;
197
181
  }
198
-
199
182
  setCodeText(snippet);
200
183
  });
201
184
  } else {
202
185
  setCodeText("");
203
186
  }
204
187
  }, [accept, body, contentType, cookieParams, headerParams, language, pathParams, postman, queryParams, server, auth]);
205
-
206
188
  if (language === undefined) {
207
189
  return null;
208
190
  }
209
-
210
191
  return <>
211
192
  <_CodeTabs.default groupId="code-samples" action={setLanguage}>
212
193
  {langs.map(lang => {
@@ -219,6 +200,5 @@ function Curl({
219
200
  </_CodeTabs.default>
220
201
  </>;
221
202
  }
222
-
223
203
  var _default = Curl;
224
204
  exports.default = _default;