@gitbook/react-openapi 1.4.3 → 1.5.2

package/dist/common/OpenAPIColumnSpec.js

@@ -0,0 +1,23 @@
+import { t } from "../translate.js";
+import { getOpenAPIClientContext } from "../context.js";
+import { OpenAPISpec } from "../OpenAPISpec.js";
+import { OpenAPIOperationDescription } from "./OpenAPIOperationDescription.js";
+
+//#region src/common/OpenAPIColumnSpec.tsx
+function OpenAPIColumnSpec(props) {
+	const { data, context } = props;
+	const { operation } = data;
+	const clientContext = getOpenAPIClientContext(context);
+	return <div className="openapi-column-spec">
+            {operation["x-deprecated-sunset"] ? <div className="openapi-deprecated-sunset openapi-description openapi-markdown">
+                    {t(context.translation, "deprecated_and_sunset_on", [<span key="date" className="openapi-deprecated-sunset-date">
+                            {operation["x-deprecated-sunset"]}
+                        </span>])}
+                </div> : null}
+            <OpenAPIOperationDescription operation={operation} context={context} />
+            <OpenAPISpec data={data} context={clientContext} />
+        </div>;
+}
+
+//#endregion
+export { OpenAPIColumnSpec };

package/dist/common/OpenAPIOperationDescription.js

@@ -0,0 +1,18 @@
+import { Markdown } from "../Markdown.js";
+import { resolveDescription } from "../utils.js";
+
+//#region src/common/OpenAPIOperationDescription.tsx
+function OpenAPIOperationDescription(props) {
+	const { operation } = props;
+	if (operation["x-gitbook-description-document"]) return <div className="openapi-intro">
+                {props.context.renderDocument({ document: operation["x-gitbook-description-document"] })}
+            </div>;
+	const description = resolveDescription(operation);
+	if (!description) return null;
+	return <div className="openapi-intro">
+            <Markdown className="openapi-description" source={description} />
+        </div>;
+}
+
+//#endregion
+export { OpenAPIOperationDescription };

package/dist/common/OpenAPIStability.js

@@ -0,0 +1,17 @@
+//#region src/common/OpenAPIStability.tsx
+const stabilityEnum = {
+	experimental: "Experimental",
+	alpha: "Alpha",
+	beta: "Beta"
+};
+function OpenAPIStability(props) {
+	const { stability } = props;
+	const foundStability = stabilityEnum[stability];
+	if (!foundStability) return null;
+	return <div className={`openapi-stability openapi-stability-${foundStability.toLowerCase()}`}>
+            {foundStability}
+        </div>;
+}
+
+//#endregion
+export { OpenAPIStability };

package/dist/common/OpenAPISummary.js

@@ -0,0 +1,27 @@
+import { OpenAPIPath } from "../OpenAPIPath.js";
+import { OpenAPIStability } from "./OpenAPIStability.js";
+
+//#region src/common/OpenAPISummary.tsx
+function OpenAPISummary(props) {
+	const { data, context } = props;
+	const { operation } = data;
+	const title = (() => {
+		if (operation.summary) return operation.summary;
+		if ("name" in data) return data.name;
+	})();
+	return <div className="openapi-summary" id={operation.summary ? void 0 : context.id}>
+            {(operation.deprecated || operation["x-stability"]) && <div className="openapi-summary-tags">
+                    {operation.deprecated && <div className="openapi-deprecated">Deprecated</div>}
+                    {operation["x-stability"] && <OpenAPIStability stability={operation["x-stability"]} />}
+                </div>}
+            {title ? context.renderHeading({
+		deprecated: operation.deprecated ?? false,
+		stability: operation["x-stability"],
+		title
+	}) : null}
+            {"path" in data ? <OpenAPIPath data={data} context={context} /> : null}
+        </div>;
+}
+
+//#endregion
+export { OpenAPISummary };

package/dist/contentTypeChecks.js

@@ -1,30 +1,34 @@
-export function isJSON(contentType) {
-    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/json')) || false;
+//#region src/contentTypeChecks.ts
+function isJSON(contentType) {
+	return contentType?.toLowerCase().includes("application/json") || false;
 }
-export function isXML(contentType) {
-    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/xml')) || false;
+function isXML(contentType) {
+	return contentType?.toLowerCase().includes("application/xml") || false;
 }
-export function isYAML(contentType) {
-    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/yaml')) || false;
+function isYAML(contentType) {
+	return contentType?.toLowerCase().includes("application/yaml") || false;
 }
-export function isGraphQL(contentType) {
-    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/graphql')) || false;
+function isGraphQL(contentType) {
+	return contentType?.toLowerCase().includes("application/graphql") || false;
 }
-export function isCSV(contentType) {
-    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('text/csv')) || false;
+function isCSV(contentType) {
+	return contentType?.toLowerCase().includes("text/csv") || false;
 }
-export function isPDF(contentType) {
-    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/pdf')) || false;
+function isPDF(contentType) {
+	return contentType?.toLowerCase().includes("application/pdf") || false;
 }
-export function isText(contentType) {
-    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('text/plain')) || false;
+function isText(contentType) {
+	return contentType?.toLowerCase().includes("text/plain") || false;
 }
-export function isFormUrlEncoded(contentType) {
-    return (contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes('application/x-www-form-urlencoded')) || false;
+function isFormUrlEncoded(contentType) {
+	return contentType?.toLowerCase().includes("application/x-www-form-urlencoded") || false;
 }
-export function isFormData(contentType) {
-    return !!contentType && contentType.toLowerCase().includes('multipart/form-data');
+function isFormData(contentType) {
+	return !!contentType && contentType.toLowerCase().includes("multipart/form-data");
 }
-export function isPlainObject(value) {
-    return typeof value === 'object' && value !== null && !Array.isArray(value);
+function isPlainObject(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
 }
+
+//#endregion
+export { isCSV, isFormData, isFormUrlEncoded, isGraphQL, isJSON, isPDF, isPlainObject, isText, isXML, isYAML };

package/dist/context.d.ts

@@ -1,75 +1,71 @@
-import { type Translation, type TranslationLocale } from './translations';
-export interface OpenAPIClientContext {
-    /**
-     * The translation language to use.
-     */
-    translation: Translation;
-    /**
-     * Icons used in the block.
-     */
-    icons: {
-        chevronDown: React.ReactNode;
-        chevronRight: React.ReactNode;
-        plus: React.ReactNode;
-    };
-    /**
-     * Force all sections to be opened by default.
-     * @default false
-     */
-    defaultInteractiveOpened?: boolean;
-    /**
-     * The key of the block
-     */
-    blockKey?: string;
-    /**
-     * Optional id attached to the heading and used as an anchor.
-     */
-    id?: string;
-    /**
-     * Mark the context as a client context.
-     */
-    $$isClientContext$$: true;
+import { Translation } from "./translations/types.js";
+import { TranslationLocale } from "./translations/index.js";
+
+//#region src/context.d.ts
+interface OpenAPIClientContext {
+  /**
+   * The translation language to use.
+   */
+  translation: Translation;
+  /**
+   * Icons used in the block.
+   */
+  icons: {
+    chevronDown: React.ReactNode;
+    chevronRight: React.ReactNode;
+    plus: React.ReactNode;
+  };
+  /**
+   * Force all sections to be opened by default.
+   * @default false
+   */
+  defaultInteractiveOpened?: boolean;
+  /**
+   * The key of the block
+   */
+  blockKey?: string;
+  /**
+   * Optional id attached to the heading and used as an anchor.
+   */
+  id?: string;
+  /**
+   * Mark the context as a client context.
+   */
+  $$isClientContext$$: true;
 }
-export interface OpenAPIContext extends Omit<OpenAPIClientContext, '$$isClientContext$$'> {
-    /**
-     * Render a code block.
-     */
-    renderCodeBlock: (props: {
-        code: string;
-        syntax: string;
-    }) => React.ReactNode;
-    /**
-     * Render the heading of the operation.
-     */
-    renderHeading: (props: {
-        deprecated: boolean;
-        title: string;
-        stability?: string;
-    }) => React.ReactNode;
-    /**
-     * Render the document of the operation.
-     */
-    renderDocument: (props: {
-        document: object;
-    }) => React.ReactNode;
-    /**
-     * Specification URL.
-     */
-    specUrl: string;
+interface OpenAPIContext extends Omit<OpenAPIClientContext, '$$isClientContext$$'> {
+  /**
+   * Render a code block.
+   */
+  renderCodeBlock: (props: {
+    code: string;
+    syntax: string;
+  }) => React.ReactNode;
+  /**
+   * Render the heading of the operation.
+   */
+  renderHeading: (props: {
+    deprecated: boolean;
+    title: string;
+    stability?: string;
+  }) => React.ReactNode;
+  /**
+   * Render the document of the operation.
+   */
+  renderDocument: (props: {
+    document: object;
+  }) => React.ReactNode;
+  /**
+   * Specification URL.
+   */
+  specUrl: string;
 }
-export type OpenAPIUniversalContext = OpenAPIClientContext | OpenAPIContext;
-export interface OpenAPIContextInput extends Omit<OpenAPIContext, 'translation'> {
-    /**
-     * The translation language to use.
-     * @default 'en'
-     */
-    locale?: TranslationLocale | undefined;
+interface OpenAPIContextInput extends Omit<OpenAPIContext, 'translation'> {
+  /**
+   * The translation language to use.
+   * @default 'en'
+   */
+  locale?: TranslationLocale | undefined;
 }
-/**
- * Resolve OpenAPI context from the input.
- */
-export declare function resolveOpenAPIContext(context: OpenAPIContextInput): OpenAPIContext;
-/**
- * Get the client context from the OpenAPI context.
- */
-export declare function getOpenAPIClientContext(context: OpenAPIUniversalContext): OpenAPIClientContext;
+//#endregion
+export { OpenAPIContextInput };

package/dist/context.js

@@ -1,43 +1,29 @@
-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 { translations } from './translations';
+import { translations } from "./translations/index.js";
+
+//#region src/context.ts
 /**
- * Resolve OpenAPI context from the input.
- */
-export function resolveOpenAPIContext(context) {
-    var locale = context.locale, rest = __rest(context, ["locale"]);
-    return __assign(__assign({}, rest), { translation: translations[locale !== null && locale !== void 0 ? locale : 'en'] });
+* Resolve OpenAPI context from the input.
+*/
+function resolveOpenAPIContext(context) {
+	const { locale,...rest } = context;
+	return {
+		...rest,
+		translation: translations[locale ?? "en"]
+	};
 }
 /**
- * Get the client context from the OpenAPI context.
- */
-export function getOpenAPIClientContext(context) {
-    return {
-        translation: context.translation,
-        icons: context.icons,
-        defaultInteractiveOpened: context.defaultInteractiveOpened,
-        blockKey: context.blockKey,
-        id: context.id,
-        $$isClientContext$$: true,
-    };
+* Get the client context from the OpenAPI context.
+*/
+function getOpenAPIClientContext(context) {
+	return {
+		translation: context.translation,
+		icons: context.icons,
+		defaultInteractiveOpened: context.defaultInteractiveOpened,
+		blockKey: context.blockKey,
+		id: context.id,
+		$$isClientContext$$: true
+	};
 }
+
+//#endregion
+export { getOpenAPIClientContext, resolveOpenAPIContext };

package/dist/decycle.js

@@ -1,70 +1,41 @@
-// Forked from: https://github.com/YChebotaev/json-decycle/blob/master/src/index.ts
-// Replaced `$ref` with `$reference` to avoid conflicts with OpenAPI
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
+//#region src/decycle.ts
+const isObject = (value) => typeof value === "object" && value != null && !(value instanceof Boolean) && !(value instanceof Date) && !(value instanceof Number) && !(value instanceof RegExp) && !(value instanceof String);
+const toPointer = (parts) => `#${parts.map((part) => String(part).replace(/~/g, "~0").replace(/\//g, "~1")).join("/")}`;
+const decycle = () => {
+	const paths = /* @__PURE__ */ new WeakMap();
+	return function replacer(key, value) {
+		if (key !== "$reference" && isObject(value)) {
+			if (paths.has(value)) return { $reference: toPointer(paths.get(value)) };
+			paths.set(value, [...paths.get(this) ?? [], key]);
+		}
+		return value;
+	};
 };
-var isObject = function (value) {
-    return typeof value === 'object' &&
-        value != null &&
-        !(value instanceof Boolean) &&
-        !(value instanceof Date) &&
-        !(value instanceof Number) &&
-        !(value instanceof RegExp) &&
-        !(value instanceof String);
-};
-var toPointer = function (parts) {
-    return "#".concat(parts.map(function (part) { return String(part).replace(/~/g, '~0').replace(/\//g, '~1'); }).join('/'));
-};
-export var decycle = function () {
-    var paths = new WeakMap();
-    return function replacer(key, value) {
-        var _a;
-        if (key !== '$reference' && isObject(value)) {
-            var seen = paths.has(value);
-            if (seen) {
-                return { $reference: toPointer(paths.get(value)) };
-            }
-            paths.set(value, __spreadArray(__spreadArray([], ((_a = paths.get(this)) !== null && _a !== void 0 ? _a : []), true), [key], false));
-        }
-        return value;
-    };
-};
-export function retrocycle() {
-    var parents = new WeakMap();
-    var keys = new WeakMap();
-    var refs = new Set();
-    function dereference(ref) {
-        var _a;
-        var parts = ref.$reference.slice(1).split('/');
-        var key;
-        var value = this;
-        for (var i = 0; i < parts.length; i++) {
-            key = (_a = parts[i]) === null || _a === void 0 ? void 0 : _a.replace(/~1/g, '/').replace(/~0/g, '~');
-            value = value[key];
-        }
-        var parent = parents.get(ref);
-        parent[keys.get(ref)] = value;
-    }
-    return function reviver(key, value) {
-        if (key === '$reference') {
-            refs.add(this);
-        }
-        else if (isObject(value)) {
-            var isRoot = key === '' && Object.keys(this).length === 1;
-            if (isRoot) {
-                refs.forEach(dereference, this);
-            }
-            else {
-                parents.set(value, this);
-                keys.set(value, key);
-            }
-        }
-        return value;
-    };
+function retrocycle() {
+	const parents = /* @__PURE__ */ new WeakMap();
+	const keys = /* @__PURE__ */ new WeakMap();
+	const refs = /* @__PURE__ */ new Set();
+	function dereference(ref) {
+		const parts = ref.$reference.slice(1).split("/");
+		let key;
+		let value = this;
+		for (let i = 0; i < parts.length; i++) {
+			key = parts[i]?.replace(/~1/g, "/").replace(/~0/g, "~");
+			value = value[key];
+		}
+		const parent = parents.get(ref);
+		parent[keys.get(ref)] = value;
+	}
+	return function reviver(key, value) {
+		if (key === "$reference") refs.add(this);
+		else if (isObject(value)) if (key === "" && Object.keys(this).length === 1) refs.forEach(dereference, this);
+		else {
+			parents.set(value, this);
+			keys.set(value, key);
+		}
+		return value;
+	};
 }
+
+//#endregion
+export { decycle, retrocycle };

package/dist/dereference.js

@@ -1,68 +1,24 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-import { dereference } from '@gitbook/openapi-parser';
-var dereferenceCache = new WeakMap();
+import { dereference } from "@gitbook/openapi-parser";
+
+//#region src/dereference.ts
+const dereferenceCache = /* @__PURE__ */ new WeakMap();
 /**
- * Memoized version of `dereferenceSchema`.
- */
-export function dereferenceFilesystem(filesystem) {
-    if (dereferenceCache.has(filesystem)) {
-        return dereferenceCache.get(filesystem);
-    }
-    var promise = baseDereferenceFilesystem(filesystem);
-    dereferenceCache.set(filesystem, promise);
-    return promise;
+* Memoized version of `dereferenceSchema`.
+*/
+function dereferenceFilesystem(filesystem) {
+	if (dereferenceCache.has(filesystem)) return dereferenceCache.get(filesystem);
+	const promise = baseDereferenceFilesystem(filesystem);
+	dereferenceCache.set(filesystem, promise);
+	return promise;
 }
 /**
- * Dereference an OpenAPI schema.
- */
-function baseDereferenceFilesystem(filesystem) {
-    return __awaiter(this, void 0, void 0, function () {
-        var result;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, dereference(filesystem)];
-                case 1:
-                    result = _a.sent();
-                    if (!result.schema) {
-                        throw new Error('Failed to dereference OpenAPI document');
-                    }
-                    return [2 /*return*/, result.schema];
-            }
-        });
-    });
+* Dereference an OpenAPI schema.
+*/
+async function baseDereferenceFilesystem(filesystem) {
+	const result = await dereference(filesystem);
+	if (!result.schema) throw new Error("Failed to dereference OpenAPI document");
+	return result.schema;
 }
+
+//#endregion
+export { dereferenceFilesystem };