docusaurus-theme-openapi-docs 0.0.0-1104 → 0.0.0-1105
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.
- package/lib/theme/ApiExplorer/Request/index.js +3 -1
- package/lib/theme/ApiExplorer/Request/makeRequest.d.ts +1 -1
- package/lib/theme/ApiExplorer/Request/makeRequest.js +3 -1
- package/package.json +3 -3
- package/src/theme/ApiExplorer/Request/index.tsx +3 -1
- package/src/theme/ApiExplorer/Request/makeRequest.ts +3 -1
- package/src/types.d.ts +7 -0
|
@@ -103,6 +103,7 @@ function Request({ item }) {
|
|
|
103
103
|
const { siteConfig } = (0, useDocusaurusContext_1.default)();
|
|
104
104
|
const themeConfig = siteConfig.themeConfig;
|
|
105
105
|
const requestTimeout = themeConfig.api?.requestTimeout;
|
|
106
|
+
const requestCredentials = themeConfig.api?.requestCredentials;
|
|
106
107
|
// Frontmatter proxy (per-spec) takes precedence over theme config proxy (site-wide)
|
|
107
108
|
const proxy = frontMatterProxy ?? themeConfig.api?.proxy;
|
|
108
109
|
const pathParams = (0, hooks_1.useTypedSelector)(
|
|
@@ -233,7 +234,8 @@ function Request({ item }) {
|
|
|
233
234
|
postmanRequest,
|
|
234
235
|
proxy,
|
|
235
236
|
body,
|
|
236
|
-
requestTimeout
|
|
237
|
+
requestTimeout,
|
|
238
|
+
requestCredentials
|
|
237
239
|
);
|
|
238
240
|
if (res.headers.get("content-type")?.includes("text/event-stream")) {
|
|
239
241
|
await handleEventStream(res);
|
|
@@ -6,5 +6,5 @@ export declare class RequestError extends Error {
|
|
|
6
6
|
originalError?: Error;
|
|
7
7
|
constructor(type: RequestErrorType, message: string, originalError?: Error);
|
|
8
8
|
}
|
|
9
|
-
declare function makeRequest(request: sdk.Request, proxy: string | undefined, _body: Body, timeout?: number): Promise<Response>;
|
|
9
|
+
declare function makeRequest(request: sdk.Request, proxy: string | undefined, _body: Body, timeout?: number, credentials?: RequestCredentials): Promise<Response>;
|
|
10
10
|
export default makeRequest;
|
|
@@ -89,7 +89,8 @@ async function makeRequest(
|
|
|
89
89
|
request,
|
|
90
90
|
proxy,
|
|
91
91
|
_body,
|
|
92
|
-
timeout = DEFAULT_REQUEST_TIMEOUT
|
|
92
|
+
timeout = DEFAULT_REQUEST_TIMEOUT,
|
|
93
|
+
credentials
|
|
93
94
|
) {
|
|
94
95
|
const headers = request.toJSON().header;
|
|
95
96
|
let myHeaders = new Headers();
|
|
@@ -221,6 +222,7 @@ async function makeRequest(
|
|
|
221
222
|
method: request.method,
|
|
222
223
|
headers: myHeaders,
|
|
223
224
|
body: myBody,
|
|
225
|
+
...(credentials && { credentials }),
|
|
224
226
|
};
|
|
225
227
|
let finalUrl = request.url.toString();
|
|
226
228
|
if (proxy) {
|
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-
|
|
4
|
+
"version": "0.0.0-1105",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"openapi",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"@types/postman-collection": "^3.5.11",
|
|
39
39
|
"@types/react-modal": "^3.16.3",
|
|
40
40
|
"concurrently": "^9.2.0",
|
|
41
|
-
"docusaurus-plugin-openapi-docs": "0.0.0-
|
|
41
|
+
"docusaurus-plugin-openapi-docs": "0.0.0-1105",
|
|
42
42
|
"docusaurus-plugin-sass": "^0.2.6",
|
|
43
43
|
"eslint-plugin-prettier": "^5.5.1"
|
|
44
44
|
},
|
|
@@ -81,5 +81,5 @@
|
|
|
81
81
|
"engines": {
|
|
82
82
|
"node": ">=14"
|
|
83
83
|
},
|
|
84
|
-
"gitHead": "
|
|
84
|
+
"gitHead": "5a573d71d569e71efd1a08fc4abbd4c822533e55"
|
|
85
85
|
}
|
|
@@ -43,6 +43,7 @@ function Request({ item }: { item: ApiItem }) {
|
|
|
43
43
|
const { siteConfig } = useDocusaurusContext();
|
|
44
44
|
const themeConfig = siteConfig.themeConfig as ThemeConfig;
|
|
45
45
|
const requestTimeout = themeConfig.api?.requestTimeout;
|
|
46
|
+
const requestCredentials = themeConfig.api?.requestCredentials;
|
|
46
47
|
// Frontmatter proxy (per-spec) takes precedence over theme config proxy (site-wide)
|
|
47
48
|
const proxy = frontMatterProxy ?? themeConfig.api?.proxy;
|
|
48
49
|
|
|
@@ -171,7 +172,8 @@ function Request({ item }: { item: ApiItem }) {
|
|
|
171
172
|
postmanRequest,
|
|
172
173
|
proxy,
|
|
173
174
|
body,
|
|
174
|
-
requestTimeout
|
|
175
|
+
requestTimeout,
|
|
176
|
+
requestCredentials
|
|
175
177
|
);
|
|
176
178
|
if (res.headers.get("content-type")?.includes("text/event-stream")) {
|
|
177
179
|
await handleEventStream(res);
|
|
@@ -114,7 +114,8 @@ async function makeRequest(
|
|
|
114
114
|
request: sdk.Request,
|
|
115
115
|
proxy: string | undefined,
|
|
116
116
|
_body: Body,
|
|
117
|
-
timeout: number = DEFAULT_REQUEST_TIMEOUT
|
|
117
|
+
timeout: number = DEFAULT_REQUEST_TIMEOUT,
|
|
118
|
+
credentials?: RequestCredentials
|
|
118
119
|
) {
|
|
119
120
|
const headers = request.toJSON().header;
|
|
120
121
|
|
|
@@ -252,6 +253,7 @@ async function makeRequest(
|
|
|
252
253
|
method: request.method,
|
|
253
254
|
headers: myHeaders,
|
|
254
255
|
body: myBody,
|
|
256
|
+
...(credentials && { credentials }),
|
|
255
257
|
};
|
|
256
258
|
|
|
257
259
|
let finalUrl = request.url.toString();
|
package/src/types.d.ts
CHANGED
|
@@ -27,6 +27,13 @@ export interface ThemeConfig {
|
|
|
27
27
|
authPersistence?: false | "sessionStorage" | "localStorage";
|
|
28
28
|
/** Request timeout in milliseconds. Defaults to 30000 (30 seconds). */
|
|
29
29
|
requestTimeout?: number;
|
|
30
|
+
/**
|
|
31
|
+
* Controls whether cookies and credentials are sent with API requests.
|
|
32
|
+
* - `"omit"`: Never send cookies (useful when docs are on same domain as app)
|
|
33
|
+
* - `"same-origin"`: Send cookies for same-origin requests (default browser behavior)
|
|
34
|
+
* - `"include"`: Always send cookies, even for cross-origin requests
|
|
35
|
+
*/
|
|
36
|
+
requestCredentials?: "omit" | "same-origin" | "include";
|
|
30
37
|
};
|
|
31
38
|
}
|
|
32
39
|
|