@gitbook/react-openapi 1.4.3 → 1.5.2

package/dist/util/example.js

@@ -0,0 +1,84 @@
+import { tString } from "../translate.js";
+import { OpenAPIExample } from "../OpenAPIExample.js";
+import { checkIsReference } from "../utils.js";
+import { generateSchemaExample } from "../generateSchemaExample.js";
+
+//#region src/util/example.tsx
+/**
+* Generate an example from a reference object.
+*/
+function getExampleFromReference(ref, context) {
+	return {
+		summary: tString(context.translation, "unresolved_reference"),
+		value: { $ref: ref.$ref }
+	};
+}
+/**
+* Get examples from a media type object.
+*/
+function getExamplesFromMediaTypeObject(args) {
+	const { mediaTypeObject, mediaType, context } = args;
+	if (mediaTypeObject.examples) return Object.entries(mediaTypeObject.examples).map(([key, example]) => {
+		return {
+			key,
+			example: checkIsReference(example) ? getExampleFromReference(example, context) : example
+		};
+	});
+	if (mediaTypeObject.example) return [{
+		key: "default",
+		example: { value: mediaTypeObject.example }
+	}];
+	if (mediaTypeObject.schema) {
+		if (mediaType === "application/xml") return [{
+			key: "default",
+			example: { value: { [mediaTypeObject.schema.xml?.name ?? "object"]: generateSchemaExample(mediaTypeObject.schema, {
+				xml: mediaType === "application/xml",
+				mode: "read"
+			}) } }
+		}];
+		return [{
+			key: "default",
+			example: { value: generateSchemaExample(mediaTypeObject.schema, { mode: "read" }) }
+		}];
+	}
+	return [];
+}
+/**
+* Get example from a schema object.
+*/
+function getExampleFromSchema(args) {
+	const { schema } = args;
+	if (schema.example) return { value: schema.example };
+	return { value: generateSchemaExample(schema, { mode: "read" }) };
+}
+/**
+* Get the examples from a media type object.
+*/
+function getExamples(props) {
+	const { mediaTypeObject, mediaType, context } = props;
+	const examples = getExamplesFromMediaTypeObject({
+		mediaTypeObject,
+		mediaType,
+		context
+	});
+	const syntax = getSyntaxFromMediaType(mediaType);
+	return examples.map((example) => {
+		return {
+			key: example.key,
+			label: example.example.summary || example.key,
+			body: <OpenAPIExample example={example.example} context={props.context} syntax={syntax} />
+		};
+	});
+}
+/**
+* Get the syntax from a media type.
+*/
+function getSyntaxFromMediaType(mediaType) {
+	if (mediaType.includes("json")) return "json";
+	if (mediaType.includes("yaml")) return "yaml";
+	if (mediaType === "application/xml") return "xml";
+	return "text";
+}
+
+//#endregion
+export { getExampleFromReference, getExampleFromSchema, getExamples };

package/dist/util/server.js

@@ -1,44 +1,38 @@
+//#region src/util/server.ts
 /**
- * Get the default URL for the server.
- */
-export function getDefaultServerURL(servers) {
-    var server = servers[0];
-    if (!server) {
-        // Return empty string if no server is found to display nothing
-        return '';
-    }
-    return interpolateServerURL(server);
+* Get the default URL for the server.
+*/
+function getDefaultServerURL(servers) {
+	const server = servers[0];
+	if (!server) return "";
+	return interpolateServerURL(server);
 }
 /**
- * Interpolate the server URL with the default values of the variables.
- */
-export function interpolateServerURL(server) {
-    var _a;
-    var parts = parseServerURL((_a = server === null || server === void 0 ? void 0 : server.url) !== null && _a !== void 0 ? _a : '');
-    return parts
-        .map(function (part) {
-        var _a, _b, _c;
-        if (part.kind === 'text') {
-            return part.text;
-        }
-        return (_c = (_b = (_a = server.variables) === null || _a === void 0 ? void 0 : _a[part.name]) === null || _b === void 0 ? void 0 : _b.default) !== null && _c !== void 0 ? _c : "{".concat(part.name, "}");
-    })
-        .join('');
+* Interpolate the server URL with the default values of the variables.
+*/
+function interpolateServerURL(server) {
+	return parseServerURL(server?.url ?? "").map((part) => {
+		if (part.kind === "text") return part.text;
+		return server.variables?.[part.name]?.default ?? `{${part.name}}`;
+	}).join("");
 }
 function parseServerURL(url) {
-    var parts = url.split(/{([^}]+)}/g);
-    var result = [];
-    for (var i = 0; i < parts.length; i++) {
-        var part = parts[i];
-        if (!part) {
-            continue;
-        }
-        if (i % 2 === 0) {
-            result.push({ kind: 'text', text: part });
-        }
-        else {
-            result.push({ kind: 'variable', name: part });
-        }
-    }
-    return result;
+	const parts = url.split(/{([^}]+)}/g);
+	const result = [];
+	for (let i = 0; i < parts.length; i++) {
+		const part = parts[i];
+		if (!part) continue;
+		if (i % 2 === 0) result.push({
+			kind: "text",
+			text: part
+		});
+		else result.push({
+			kind: "variable",
+			name: part
+		});
+	}
+	return result;
 }
+
+//#endregion
+export { getDefaultServerURL };

package/dist/util/tryit-prefill.js

@@ -1,129 +1,143 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-import { ExpressionRuntime, parseTemplate } from '@gitbook/expr';
+import { ExpressionRuntime, parseTemplate } from "@gitbook/expr";
+
+//#region src/util/tryit-prefill.ts
+const PREFILL_CUSTOM_PROPERTY = "x-gitbook-prefill";
 /**
- * Resolve the Scalar API client prefill configuration for a given OpenAPI operation.
- */
-export function resolveTryItPrefillForOperation(args) {
-    var _a = args.operation, securities = _a.securities, servers = _a.servers, prefillInputContext = args.prefillInputContext;
-    if (!prefillInputContext) {
-        return {};
-    }
-    var runtime = new ExpressionRuntime();
-    var resolveTryItPrefillExpression = function (expr) {
-        var parts = parseTemplate(expr);
-        if (!parts.length) {
-            return undefined;
-        }
-        return runtime.evaluateTemplate(expr, prefillInputContext);
-    };
-    var prefillAuth = securities
-        ? resolveTryItPrefillAuthForOperationSecurities({
-            securities: securities,
-            resolveTryItPrefillExpression: resolveTryItPrefillExpression,
-        })
-        : undefined;
-    var prefillServers = servers
-        ? resolveTryItPrefillServersForOperationServers({ servers: servers, resolveTryItPrefillExpression: resolveTryItPrefillExpression })
-        : [];
-    return __assign(__assign({}, (prefillAuth ? { authentication: prefillAuth } : {})), (prefillServers ? { servers: prefillServers } : {}));
+* Resolve the Scalar API client prefill configuration for a given OpenAPI operation.
+*/
+function resolveTryItPrefillForOperation(args) {
+	const { operation: { securities, servers }, prefillInputContext } = args;
+	if (!prefillInputContext) return {};
+	const runtime = new ExpressionRuntime();
+	const resolveTryItPrefillExpression = (expr) => {
+		if (!parseTemplate(expr).length) return;
+		return runtime.evaluateTemplate(expr, prefillInputContext);
+	};
+	const prefillAuth = securities ? resolveTryItPrefillAuthForOperationSecurities({
+		securities,
+		resolveTryItPrefillExpression
+	}) : void 0;
+	const prefillServers = servers ? resolveTryItPrefillServersForOperationServers({
+		servers,
+		resolveTryItPrefillExpression
+	}) : [];
+	return {
+		...prefillAuth ? { authentication: prefillAuth } : {},
+		...prefillServers ? { servers: prefillServers } : {}
+	};
 }
 /**
- * Resolve prefill authentication configuration for the security schemes defined for an operation.
- */
+* Resolve prefill authentication configuration for the security schemes defined for an operation.
+*/
 function resolveTryItPrefillAuthForOperationSecurities(args) {
-    var _a, _b;
-    var securities = args.securities, resolveTryItPrefillExpression = args.resolveTryItPrefillExpression;
-    var prefillAuthConfig = {};
-    for (var _i = 0, _c = Object.values(securities); _i < _c.length; _i++) {
-        var _d = _c[_i], schemeName = _d[0], security = _d[1];
-        var tryitPrefillAuthValue = security['x-gitbook-prefill']
-            ? resolveTryItPrefillExpression(security['x-gitbook-prefill'])
-            : undefined;
-        if (!tryitPrefillAuthValue) {
-            continue;
-        }
-        switch (security.type) {
-            case 'http': {
-                if ((_a = security.scheme) === null || _a === void 0 ? void 0 : _a.includes('bearer')) {
-                    prefillAuthConfig[schemeName] = { token: tryitPrefillAuthValue };
-                }
-                else if (((_b = security.scheme) === null || _b === void 0 ? void 0 : _b.includes('basic')) &&
-                    tryitPrefillAuthValue.includes(':')) {
-                    var _e = tryitPrefillAuthValue.split(':', 2), username = _e[0], password = _e[1];
-                    prefillAuthConfig[schemeName] = { username: username, password: password };
-                }
-                break;
-            }
-            case 'apiKey': {
-                prefillAuthConfig[schemeName] = {
-                    name: security.name,
-                    in: security.in,
-                    value: tryitPrefillAuthValue,
-                };
-                break;
-            }
-            case 'oauth2':
-            case 'openIdConnect': {
-                break;
-            }
-        }
-    }
-    return Object.keys(prefillAuthConfig).length > 0
-        ? { securitySchemes: prefillAuthConfig }
-        : undefined;
+	const { securities, resolveTryItPrefillExpression } = args;
+	const prefillAuthConfig = {};
+	for (const [schemeName, security] of Object.values(securities)) {
+		const tryitPrefillAuthValue = security[PREFILL_CUSTOM_PROPERTY] ? resolveTryItPrefillExpression(security[PREFILL_CUSTOM_PROPERTY]) : void 0;
+		if (!tryitPrefillAuthValue) continue;
+		switch (security.type) {
+			case "http":
+				if (security.scheme?.includes("bearer")) prefillAuthConfig[schemeName] = { token: tryitPrefillAuthValue };
+				else if (security.scheme?.includes("basic") && tryitPrefillAuthValue.includes(":")) {
+					const [username, password] = tryitPrefillAuthValue.split(":", 2);
+					prefillAuthConfig[schemeName] = {
+						username,
+						password
+					};
+				}
+				break;
+			case "apiKey":
+				prefillAuthConfig[schemeName] = {
+					name: security.name,
+					in: security.in,
+					value: tryitPrefillAuthValue
+				};
+				break;
+			case "oauth2":
+			case "openIdConnect": break;
+		}
+	}
+	return Object.keys(prefillAuthConfig).length > 0 ? { securitySchemes: prefillAuthConfig } : void 0;
 }
 /**
- * Resolve prefill server configuration for the servers defined for an operation.
- */
+* Resolve prefill server configuration for the servers defined for an operation.
+*/
 function resolveTryItPrefillServersForOperationServers(args) {
-    var servers = args.servers, resolveTryItPrefillExpression = args.resolveTryItPrefillExpression;
-    var resolvedServers = [];
-    for (var _i = 0, servers_1 = servers; _i < servers_1.length; _i++) {
-        var server = servers_1[_i];
-        // Url-level prefill
-        var tryItPrefillServerUrlExpr = server['x-gitbook-prefill'];
-        var tryItPrefillServerUrlValue = tryItPrefillServerUrlExpr
-            ? resolveTryItPrefillExpression(tryItPrefillServerUrlExpr)
-            : undefined;
-        var variables = server.variables
-            ? __assign({}, server.variables) : {};
-        // Variable-level prefill
-        if (server.variables) {
-            for (var _a = 0, _b = Object.entries(server.variables); _a < _b.length; _a++) {
-                var _c = _b[_a], varName = _c[0], variable = _c[1];
-                var tryItPrefillVarExpr = variable["x-gitbook-prefill"], variableProps = __rest(variable, ['x-gitbook-prefill']);
-                var tryItPrefillVarValue = tryItPrefillVarExpr
-                    ? resolveTryItPrefillExpression(tryItPrefillVarExpr)
-                    : undefined;
-                variables[varName] = __assign(__assign({}, variableProps), (tryItPrefillVarValue ? { default: String(tryItPrefillVarValue) } : {}));
-            }
-        }
-        var hasServerVariables = Object.keys(variables).length > 0;
-        if (server.url && (tryItPrefillServerUrlValue || hasServerVariables)) {
-            var resolvedServer = __assign(__assign({ url: tryItPrefillServerUrlValue !== null && tryItPrefillServerUrlValue !== void 0 ? tryItPrefillServerUrlValue : server.url }, (server.description ? { description: server.description } : {})), (hasServerVariables ? { variables: variables } : {}));
-            resolvedServers.push(resolvedServer);
-        }
-    }
-    return resolvedServers.length > 0 ? resolvedServers : undefined;
+	const { servers, resolveTryItPrefillExpression } = args;
+	const resolvedServers = [];
+	for (const server of servers) {
+		const tryItPrefillServerUrlExpr = server[PREFILL_CUSTOM_PROPERTY];
+		const tryItPrefillServerUrlValue = tryItPrefillServerUrlExpr ? resolveTryItPrefillExpression(tryItPrefillServerUrlExpr) : void 0;
+		const variables = server.variables ? { ...server.variables } : {};
+		if (server.variables) for (const [varName, variable] of Object.entries(server.variables)) {
+			const { [PREFILL_CUSTOM_PROPERTY]: tryItPrefillVarExpr,...variableProps } = variable;
+			const tryItPrefillVarValue = tryItPrefillVarExpr ? resolveTryItPrefillExpression(tryItPrefillVarExpr) : void 0;
+			variables[varName] = {
+				...variableProps,
+				...tryItPrefillVarValue ? { default: String(tryItPrefillVarValue) } : {}
+			};
+		}
+		const hasServerVariables = Object.keys(variables).length > 0;
+		if (server.url && (tryItPrefillServerUrlValue || hasServerVariables)) {
+			const resolvedServer = {
+				url: tryItPrefillServerUrlValue ?? server.url,
+				...server.description ? { description: server.description } : {},
+				...hasServerVariables ? { variables } : {}
+			};
+			resolvedServers.push(resolvedServer);
+		}
+	}
+	return resolvedServers.length > 0 ? resolvedServers : void 0;
 }
+/**
+* Return a X-GITBOOK-PREFILL placeholder based on the prefill custom property in the provided security scheme.
+*/
+function resolvePrefillCodePlaceholderFromSecurityScheme(args) {
+	const { security, defaultPlaceholderValue } = args;
+	const prefillExprParts = extractPrefillExpressionPartsFromSecurityScheme(security);
+	if (prefillExprParts.length === 0) return defaultPlaceholderValue ?? "";
+	return toPrefillCodePlaceholder(templatePartsToExpression(prefillExprParts), defaultPlaceholderValue);
+}
+function extractPrefillExpressionPartsFromSecurityScheme(security) {
+	const expression = security[PREFILL_CUSTOM_PROPERTY];
+	if (!expression || expression.length === 0) return [];
+	return parseTemplate(expression);
+}
+/**
+* Return a server URL with X-GITBOOK-PREFILL placeholders based on the prefill custom properties in the provided security scheme.
+*/
+function resolveURLWithPrefillCodePlaceholdersFromServer(server, defaultServerUrl) {
+	const serverVariables = server.variables ?? {};
+	const variableExprs = {};
+	let hasVariablePrefill = false;
+	for (const [name, variable] of Object.entries(serverVariables ?? {})) if (variable[PREFILL_CUSTOM_PROPERTY]) {
+		hasVariablePrefill = true;
+		variableExprs[name] = `(${templatePartsToExpression(parseTemplate(variable[PREFILL_CUSTOM_PROPERTY]))} ?? '${variable.default ?? ""}')`;
+	} else variableExprs[name] = String(variable.default) ?? "";
+	let interpolatedUrl = server.url ?? "";
+	interpolatedUrl = interpolatedUrl.replace(/{([^}]+)}/g, (_, varName) => {
+		const expr = variableExprs[varName];
+		if (serverVariables[varName]?.[PREFILL_CUSTOM_PROPERTY]) return `\${${expr ?? `'${varName}'`}}`;
+		return expr ?? `{${varName}}`;
+	});
+	const interpolatedUrlTemplate = hasVariablePrefill ? `\`${interpolatedUrl}\`` : interpolatedUrl;
+	const urlLevelExpr = server[PREFILL_CUSTOM_PROPERTY];
+	if (urlLevelExpr) return toPrefillCodePlaceholder(`${templatePartsToExpression(parseTemplate(urlLevelExpr))} ?? ${hasVariablePrefill ? interpolatedUrlTemplate : `'${interpolatedUrlTemplate}'`}`, defaultServerUrl);
+	if (hasVariablePrefill) return toPrefillCodePlaceholder(interpolatedUrlTemplate, defaultServerUrl);
+	return interpolatedUrl;
+}
+function templatePartsToExpression(parts) {
+	return parts.map((part) => {
+		switch (part.type) {
+			case "text": return `"${part.value}"`;
+			case "expression": return part.value;
+			default: return "";
+		}
+	}).join(" + ");
+}
+function toPrefillCodePlaceholder(expression, defaultValue) {
+	return `$$__X-GITBOOK-PREFILL[(${expression})${defaultValue ? ` ?? '${defaultValue}'` : ""}]__$$`;
+}
+
+//#endregion
+export { resolvePrefillCodePlaceholderFromSecurityScheme, resolveTryItPrefillForOperation, resolveURLWithPrefillCodePlaceholdersFromServer };