@gitbook/react-openapi 1.5.2 → 1.5.4

package/dist/generateSchemaExample.js

@@ -1,4 +1,5 @@
 import { checkIsReference } from "./utils.js";
+import { isPlainObject } from "./contentTypeChecks.js";
 
 //#region src/generateSchemaExample.ts
 /**
@@ -81,6 +82,10 @@ const getExampleFromSchema = (schema, options, level = 0, parentSchema, name, re
 		resultCache.set(schema$1, result);
 		return result;
 	}
+	function mergeAllOfIntoResponse(allOfItems, response, parent) {
+		const allOfResults = allOfItems.map((item) => getExampleFromSchema(item, options, level + 1, parent, void 0, resultCache)).filter(isPlainObject);
+		if (allOfResults.length > 0) Object.assign(response, ...allOfResults);
+	}
 	if (resultCache.has(schema)) return resultCache.get(schema);
 	if (level === MAX_LEVELS_DEEP + 1) try {
 		JSON.stringify(schema);
@@ -129,9 +134,21 @@ const getExampleFromSchema = (schema, options, level = 0, parentSchema, name, re
 			if (schema.additionalProperties === true || typeof schema.additionalProperties === "object" && !Object.keys(schema.additionalProperties).length) response.ANY_ADDITIONAL_PROPERTY = "anything";
 			else if (schema.additionalProperties !== false) response.ANY_ADDITIONAL_PROPERTY = getExampleFromSchema(schema.additionalProperties, options, level + 1, void 0, void 0, resultCache);
 		}
-		if (schema.anyOf !== void 0) Object.assign(response, getExampleFromSchema(schema.anyOf[0], options, level + 1, void 0, void 0, resultCache));
-		else if (schema.oneOf !== void 0) Object.assign(response, getExampleFromSchema(schema.oneOf[0], options, level + 1, void 0, void 0, resultCache));
-		else if (schema.allOf !== void 0) Object.assign(response, ...schema.allOf.map((item) => getExampleFromSchema(item, options, level + 1, schema, void 0, resultCache)).filter((item) => item !== void 0));
+		if (schema.anyOf !== void 0) {
+			const anyOfItem = schema.anyOf[0];
+			if (anyOfItem) if (anyOfItem?.allOf !== void 0 && Array.isArray(anyOfItem.allOf)) mergeAllOfIntoResponse(anyOfItem.allOf, response, anyOfItem);
+			else {
+				const anyOfResult = getExampleFromSchema(anyOfItem, options, level + 1, void 0, void 0, resultCache);
+				if (isPlainObject(anyOfResult)) Object.assign(response, anyOfResult);
+			}
+		} else if (schema.oneOf !== void 0) {
+			const oneOfItem = schema.oneOf[0];
+			if (oneOfItem) if (oneOfItem?.allOf !== void 0 && Array.isArray(oneOfItem.allOf)) mergeAllOfIntoResponse(oneOfItem.allOf, response, oneOfItem);
+			else {
+				const oneOfResult = getExampleFromSchema(oneOfItem, options, level + 1, void 0, void 0, resultCache);
+				if (isPlainObject(oneOfResult)) Object.assign(response, oneOfResult);
+			}
+		} else if (schema.allOf !== void 0) mergeAllOfIntoResponse(schema.allOf, response, schema);
 		return cache(schema, response);
 	}
 	if (schema.type === "array" || schema.items !== void 0) {

package/dist/getOrCreateDisclosureStoreByKey.js

@@ -0,0 +1,31 @@
+import { createStore } from "zustand";
+
+//#region src/getOrCreateDisclosureStoreByKey.ts
+const createDisclosureStore = (initialKeys) => {
+	return createStore()((set) => ({
+		expandedKeys: initialKeys ? new Set(initialKeys) : /* @__PURE__ */ new Set(),
+		setExpandedKeys: (keys) => {
+			set(() => ({ expandedKeys: keys }));
+		},
+		toggleKey: (key) => {
+			set((state) => {
+				const newKeys = new Set(state.expandedKeys);
+				if (newKeys.has(key)) newKeys.delete(key);
+				else newKeys.add(key);
+				return { expandedKeys: newKeys };
+			});
+		}
+	}));
+};
+const defaultDisclosureStores = /* @__PURE__ */ new Map();
+const createDisclosureStoreFactory = (stores) => {
+	return (storeKey, initialKeys) => {
+		if (!stores.has(storeKey)) stores.set(storeKey, createDisclosureStore(initialKeys));
+		if (!stores.get(storeKey)) throw new Error(`Failed to get or create store for key: ${storeKey}`);
+		return stores.get(storeKey);
+	};
+};
+const getOrCreateDisclosureStoreByKey = createDisclosureStoreFactory(defaultDisclosureStores);
+
+//#endregion
+export { getOrCreateDisclosureStoreByKey };

package/dist/resolveOpenAPIOperation.js

@@ -88,8 +88,11 @@ function flattenSecurities(security) {
 * Resolve the scopes for a security scheme.
 */
 function resolveSecurityScopes({ securityScheme, operationScopes }) {
-	if (!securityScheme || checkIsReference(securityScheme) || isOAuthSecurityScheme(securityScheme)) return null;
-	return operationScopes?.map((scope) => [scope, void 0]) || [];
+	if (!operationScopes?.length || !securityScheme || checkIsReference(securityScheme)) return null;
+	if (isOAuthSecurityScheme(securityScheme)) return (securityScheme.flows ? Object.entries(securityScheme.flows) : []).flatMap(([_, flow]) => {
+		return Object.entries(flow.scopes ?? {}).filter(([scope]) => operationScopes.includes(scope));
+	});
+	return operationScopes.map((scope) => [scope, void 0]);
 }
 /**
 * Check if a security scheme is an OAuth or OpenID Connect security scheme.

package/dist/translate.js

@@ -1,4 +1,4 @@
-import React from "react";
+import React, { isValidElement } from "react";
 
 //#region src/translate.tsx
 /**
@@ -35,7 +35,7 @@ function reactToString(el) {
 	if (typeof el === "string" || typeof el === "number" || typeof el === "boolean") return `${el}`;
 	if (el === null || el === void 0) return "";
 	if (Array.isArray(el)) return el.map(reactToString).join("");
-	if (typeof el === "object" && "props" in el) return el.props.children.map(reactToString).join("");
+	if (isValidElement(el)) return el.props.children.map(reactToString).join("");
 	throw new Error(`Unsupported type ${typeof el}`);
 }
 

package/dist/translations/de.js

@@ -38,6 +38,8 @@ const de = {
 	hide: "Verstecke ${1}",
 	available_items: "Verfügbare Elemente",
 	required_scopes: "Erforderliche Scopes",
+	required_scopes_description: "Dieser Endpunkt erfordert die folgenden Scopes:",
+	available_scopes: "Verfügbare Scopes:",
 	properties: "Eigenschaften",
 	or: "oder",
 	and: "und",

package/dist/translations/en.d.ts

@@ -38,6 +38,8 @@ declare const en: {
   hide: string;
   available_items: string;
   required_scopes: string;
+  required_scopes_description: string;
+  available_scopes: string;
   possible_values: string;
   properties: string;
   or: string;

package/dist/translations/en.js

@@ -38,6 +38,8 @@ const en = {
 	hide: "Hide ${1}",
 	available_items: "Available items",
 	required_scopes: "Required scopes",
+	required_scopes_description: "This endpoint requires the following scopes:",
+	available_scopes: "Available scopes:",
 	possible_values: "Possible values",
 	properties: "Properties",
 	or: "or",

package/dist/translations/es.js

@@ -38,6 +38,8 @@ const es = {
 	hide: "Ocultar ${1}",
 	available_items: "Elementos disponibles",
 	required_scopes: "Scopes requeridos",
+	required_scopes_description: "Este endpoint requiere los siguientes scopes:",
+	available_scopes: "Scopes disponibles:",
 	properties: "Propiedades",
 	or: "o",
 	and: "y",

package/dist/translations/fr.js

@@ -38,6 +38,8 @@ const fr = {
 	hide: "Masquer ${1}",
 	available_items: "Éléments disponibles",
 	required_scopes: "Scopes requis",
+	required_scopes_description: "Cet endpoint nécessite les scopes suivants:",
+	available_scopes: "Scopes disponibles:",
 	properties: "Propriétés",
 	or: "ou",
 	and: "et",

package/dist/translations/index.d.ts

@@ -41,6 +41,8 @@ declare const translations: {
     hide: string;
     available_items: string;
     required_scopes: string;
+    required_scopes_description: string;
+    available_scopes: string;
     possible_values: string;
     properties: string;
     or: string;
@@ -85,6 +87,8 @@ declare const translations: {
     hide: string;
     available_items: string;
     required_scopes: string;
+    required_scopes_description: string;
+    available_scopes: string;
     properties: string;
     or: string;
     and: string;
@@ -129,6 +133,8 @@ declare const translations: {
     hide: string;
     available_items: string;
     required_scopes: string;
+    required_scopes_description: string;
+    available_scopes: string;
     properties: string;
     or: string;
     and: string;
@@ -173,6 +179,8 @@ declare const translations: {
     hide: string;
     available_items: string;
     required_scopes: string;
+    required_scopes_description: string;
+    available_scopes: string;
     properties: string;
     or: string;
     and: string;
@@ -217,6 +225,8 @@ declare const translations: {
     hide: string;
     available_items: string;
     required_scopes: string;
+    required_scopes_description: string;
+    available_scopes: string;
     properties: string;
     or: string;
     and: string;
@@ -261,6 +271,8 @@ declare const translations: {
     hide: string;
     available_items: string;
     required_scopes: string;
+    required_scopes_description: string;
+    available_scopes: string;
     properties: string;
     or: string;
     and: string;
@@ -305,6 +317,8 @@ declare const translations: {
     hide: string;
     available_items: string;
     required_scopes: string;
+    required_scopes_description: string;
+    available_scopes: string;
     properties: string;
     or: string;
     and: string;
@@ -349,6 +363,8 @@ declare const translations: {
     hide: string;
     available_items: string;
     required_scopes: string;
+    required_scopes_description: string;
+    available_scopes: string;
     properties: string;
     or: string;
     and: string;
@@ -393,6 +409,8 @@ declare const translations: {
     hide: string;
     available_items: string;
     required_scopes: string;
+    required_scopes_description: string;
+    available_scopes: string;
     properties: string;
     or: string;
     and: string;

package/dist/translations/ja.js

@@ -38,6 +38,8 @@ const ja = {
 	hide: "${1}を非表示",
 	available_items: "利用可能なアイテム",
 	required_scopes: "必須スコープ",
+	required_scopes_description: "このエンドポイントには次のスコープが必要です：",
+	available_scopes: "利用可能なスコープ：",
 	properties: "プロパティ",
 	or: "または",
 	and: "かつ",

package/dist/translations/nl.js

@@ -38,6 +38,8 @@ const nl = {
 	hide: "Verberg ${1}",
 	available_items: "Beschikbare items",
 	required_scopes: "Vereiste scopes",
+	required_scopes_description: "Dit endpoint vereist de volgende scopes:",
+	available_scopes: "Beschikbare scopes:",
 	properties: "Eigenschappen",
 	or: "of",
 	and: "en",

package/dist/translations/no.js

@@ -38,6 +38,8 @@ const no = {
 	hide: "Skjul ${1}",
 	available_items: "Tilgjengelige elementer",
 	required_scopes: "Påkrevde scopes",
+	required_scopes_description: "Dette endepunktet krever følgende scopes:",
+	available_scopes: "Tilgjengelige scopes:",
 	properties: "Egenskaper",
 	or: "eller",
 	and: "og",

package/dist/translations/pt-br.js

@@ -38,6 +38,8 @@ const pt_br = {
 	hide: "Ocultar ${1}",
 	available_items: "Itens disponíveis",
 	required_scopes: "Scopes obrigatórios",
+	required_scopes_description: "Este endpoint requer os seguintes scopes:",
+	available_scopes: "Scopes disponíveis:",
 	properties: "Propriedades",
 	or: "ou",
 	and: "e",

package/dist/translations/zh.js

@@ -38,6 +38,8 @@ const zh = {
 	hide: "隐藏${1}",
 	available_items: "可用项",
 	required_scopes: "必需范围",
+	required_scopes_description: "此端点需要以下范围：",
+	available_scopes: "可用范围：",
 	properties: "属性",
 	or: "或",
 	and: "和",

package/dist/types.d.ts

@@ -6,6 +6,7 @@ type OpenAPIServerVariableWithCustomProperties = OpenAPIV3.ServerVariableObject
  * OpenAPI ServerObject type extended to provide x-gitbook prefill custom properties at the variable level.
  */
 type OpenAPIServerWithCustomProperties = Omit<OpenAPIV3.ServerObject, 'variables'> & {
+  name?: string;
   variables?: {
     [variable: string]: OpenAPIServerVariableWithCustomProperties;
   };

package/dist/util/tryit-prefill.js

@@ -95,7 +95,10 @@ function resolveTryItPrefillServersForOperationServers(args) {
 function resolvePrefillCodePlaceholderFromSecurityScheme(args) {
 	const { security, defaultPlaceholderValue } = args;
 	const prefillExprParts = extractPrefillExpressionPartsFromSecurityScheme(security);
-	if (prefillExprParts.length === 0) return defaultPlaceholderValue ?? "";
+	if (prefillExprParts.length === 0) {
+		if (security["x-gitbook-token-placeholder"]) return security["x-gitbook-token-placeholder"];
+		return defaultPlaceholderValue ?? "";
+	}
 	return toPrefillCodePlaceholder(templatePartsToExpression(prefillExprParts), defaultPlaceholderValue);
 }
 function extractPrefillExpressionPartsFromSecurityScheme(security) {

package/dist/utils.js

@@ -122,20 +122,22 @@ function getStatusCodeCategory(statusCode) {
 	if (Number.isNaN(code) || code < 100 || code >= 600) return "unknown";
 	return Math.floor(code / 100);
 }
-function getSchemaTitle(schema) {
+function getSchemaTitle(schema, options) {
 	let type = "any";
 	if (schema.enum || schema["x-enumDescriptions"] || schema["x-gitbook-enum"]) type = `${schema.type} · enum`;
-	else if (schema.type === "array" && !!schema.items) type = `${getSchemaTitle(schema.items)}[]`;
+	else if (schema.type === "array" && !!schema.items) type = `${getSchemaTitle(schema.items, options)}[]`;
 	else if (Array.isArray(schema.type)) type = schema.type.join(" | ");
 	else if (schema.type || schema.properties) {
 		type = schema.type ?? "object";
 		if (schema.format) type += ` · ${schema.format}`;
 		if (type === "object" && schema.title) type += ` · ${schema.title.replaceAll(" ", "")}`;
 	}
-	if ("anyOf" in schema) type = "any of";
-	else if ("oneOf" in schema) type = "one of";
-	else if ("allOf" in schema) type = "all of";
-	else if ("not" in schema) type = "not";
+	if (!options?.ignoreAlternatives) {
+		if ("anyOf" in schema) type = "any of";
+		else if ("oneOf" in schema) type = "one of";
+		else if ("allOf" in schema) type = "all of";
+		else if ("not" in schema) type = "not";
+	}
 	return type;
 }
 /**

package/package.json

@@ -7,31 +7,40 @@
             "default": "./dist/index.js"
         }
     },
-    "version": "1.5.2",
+    "version": "1.5.4",
     "sideEffects": false,
     "dependencies": {
-        "@gitbook/expr": "1.2.3",
-        "@gitbook/openapi-parser": "3.0.4",
-        "@scalar/api-client-react": "^1.3.16",
-        "@scalar/oas-utils": "^0.2.130",
-        "@scalar/types": "^0.1.9",
+        "@gitbook/expr": "1.2.4",
+        "@gitbook/openapi-parser": "3.0.6",
+        "@scalar/api-client-react": "^1.3.46",
+        "@scalar/oas-utils": "^0.6.3",
+        "@scalar/types": "^0.4.0",
         "classnames": "^2.5.1",
         "flatted": "^3.2.9",
         "json-xml-parse": "^1.3.0",
         "react-aria-components": "^1.13.0",
         "react-aria": "^3.44.0",
-        "usehooks-ts": "^3.1.0",
+        "react-stately": "^3.42.0",
+        "usehooks-ts": "^3.1.1",
         "zustand": "^5.0.3",
         "js-yaml": "^4.1.0"
     },
     "devDependencies": {
         "@types/js-yaml": "^4.0.9",
+        "@types/react": "^19.0.0",
+        "@types/react-dom": "^19.0.0",
         "bun-types": "^1.1.20",
-        "react": "^19.0.0",
-        "react-dom": "^19.0.0",
+        "react": "^19.0.1",
+        "react-dom": "^19.0.1",
         "tsdown": "^0.15.6",
         "typescript": "^5.5.3"
     },
+    "overrides": {
+        "@types/react": "catalog:",
+        "@types/react-dom": "catalog:",
+        "react": "catalog:",
+        "react-dom": "catalog:"
+    },
     "peerDependencies": {
         "react": "*",
         "react-dom": "*"
@@ -41,11 +50,15 @@
         "typecheck": "tsc --noEmit",
         "unit": "bun test",
         "dev": "bun run build -- --watch ./src",
-        "clean": "rm -rf ./dist"
+        "clean": "rm -rf ./dist",
+        "publish-to-npm": "../../scripts/publish-if-new.sh"
     },
     "files": ["dist", "README.md", "CHANGELOG.md"],
     "publishConfig": {
         "access": "public",
         "registry": "https://registry.npmjs.org/"
+    },
+    "repository": {
+        "url": "https://github.com/GitbookIO/gitbook"
     }
 }