@gitbook/react-openapi 1.0.4 → 1.1.0

package/dist/dereference.js

@@ -0,0 +1,68 @@
+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();
+/**
+ * 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;
+}
+/**
+ * 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];
+            }
+        });
+    });
+}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export * from './resolveOpenAPIOperation';
+export * from './models';
 export * from './OpenAPIOperation';
 export * from './OpenAPIOperationContext';
-export type { OpenAPIOperationData } from './types';
+export * from './resolveOpenAPIOperation';
+export type { OpenAPIModelsData, OpenAPIOperationData } from './types';

package/dist/index.js

@@ -1,3 +1,4 @@
-export * from './resolveOpenAPIOperation';
+export * from './models';
 export * from './OpenAPIOperation';
 export * from './OpenAPIOperationContext';
+export * from './resolveOpenAPIOperation';

package/dist/models/OpenAPIModels.d.ts

@@ -0,0 +1,9 @@
+import type { OpenAPIContextProps, OpenAPIModelsData } from '../types';
+/**
+ * Display OpenAPI Models.
+ */
+export declare function OpenAPIModels(props: {
+    className?: string;
+    data: OpenAPIModelsData;
+    context: OpenAPIContextProps;
+}): import("react").JSX.Element | null;

package/dist/models/OpenAPIModels.jsx

@@ -0,0 +1,62 @@
+import clsx from 'clsx';
+import { OpenAPIDisclosureGroup } from '../OpenAPIDisclosureGroup';
+import { OpenAPIRootSchema } from '../OpenAPISchema';
+import { Section, SectionBody } from '../StaticSection';
+/**
+ * Display OpenAPI Models.
+ */
+export function OpenAPIModels(props) {
+    var className = props.className, data = props.data, context = props.context;
+    var models = data.models;
+    var clientContext = {
+        defaultInteractiveOpened: context.defaultInteractiveOpened,
+        icons: context.icons,
+        blockKey: context.blockKey,
+    };
+    if (!models.length) {
+        return null;
+    }
+    return (<div className={clsx('openapi-models', className)}>
+            <OpenAPIRootModelsSchema models={models} context={clientContext}/>
+        </div>);
+}
+/**
+ * Root schema for OpenAPI models.
+ * It displays a single model or a disclosure group for multiple models.
+ */
+function OpenAPIRootModelsSchema(props) {
+    var _a;
+    var models = props.models, context = props.context;
+    // If there is only one model, we show it directly.
+    if (models.length === 1) {
+        var schema = (_a = models === null || models === void 0 ? void 0 : models[0]) === null || _a === void 0 ? void 0 : _a.schema;
+        if (!schema) {
+            return null;
+        }
+        return (<Section>
+                <SectionBody>
+                    <OpenAPIRootSchema schema={schema} context={context}/>
+                </SectionBody>
+            </Section>);
+    }
+    // If there are multiple models, we use a disclosure group to show them all.
+    return (<OpenAPIDisclosureGroup allowsMultipleExpanded icon={context.icons.chevronRight} groups={models.map(function (_a) {
+            var name = _a.name, schema = _a.schema;
+            return ({
+                id: name,
+                label: (<div className="openapi-response-tab-content" key={"model-".concat(name)}>
+                        <span className="openapi-response-statuscode">{name}</span>
+                    </div>),
+                tabs: [
+                    {
+                        id: 'model',
+                        body: (<Section className="openapi-section-models">
+                                <SectionBody>
+                                    <OpenAPIRootSchema schema={schema} context={context}/>
+                                </SectionBody>
+                            </Section>),
+                    },
+                ],
+            });
+        })}/>);
+}

package/dist/models/index.d.ts

@@ -0,0 +1,2 @@
+export * from './OpenAPIModels';
+export * from './resolveOpenAPIModels';

package/dist/models/index.js

@@ -0,0 +1,2 @@
+export * from './OpenAPIModels';
+export * from './resolveOpenAPIModels';

package/dist/models/resolveOpenAPIModels.d.ts

@@ -0,0 +1,7 @@
+import { type Filesystem, type OpenAPIV3xDocument } from '@gitbook/openapi-parser';
+import type { OpenAPIModelsData } from '../types';
+/**
+ * Resolve an OpenAPI models from a file and compile it to a more usable format.
+ * Models are extracted from the OpenAPI components.schemas
+ */
+export declare function resolveOpenAPIModels(filesystem: Filesystem<OpenAPIV3xDocument>): Promise<OpenAPIModelsData | null>;

package/dist/models/resolveOpenAPIModels.js

@@ -0,0 +1,73 @@
+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 { shouldIgnoreEntity, } from '@gitbook/openapi-parser';
+import { dereferenceFilesystem } from '../dereference';
+//!!TODO: We should return only the models that are used in the block. Still a WIP awaiting future work.
+/**
+ * Resolve an OpenAPI models from a file and compile it to a more usable format.
+ * Models are extracted from the OpenAPI components.schemas
+ */
+export function resolveOpenAPIModels(filesystem) {
+    return __awaiter(this, void 0, void 0, function () {
+        var schema, models;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, dereferenceFilesystem(filesystem)];
+                case 1:
+                    schema = _a.sent();
+                    models = getOpenAPIComponents(schema);
+                    return [2 /*return*/, { models: models }];
+            }
+        });
+    });
+}
+/**
+ * Get OpenAPI components.schemas that are not ignored.
+ */
+function getOpenAPIComponents(schema) {
+    var _a, _b;
+    var schemas = (_b = (_a = schema.components) === null || _a === void 0 ? void 0 : _a.schemas) !== null && _b !== void 0 ? _b : {};
+    return Object.entries(schemas)
+        .filter(function (_a) {
+        var schema = _a[1];
+        return !shouldIgnoreEntity(schema);
+    })
+        .map(function (_a) {
+        var key = _a[0], schema = _a[1];
+        return ({ name: key, schema: schema });
+    });
+}

package/dist/resolveOpenAPIOperation.d.ts

@@ -1,7 +1,7 @@
 import { fromJSON, toJSON } from 'flatted';
-import { type Filesystem, type OpenAPIV3xDocument } from '@gitbook/openapi-parser';
+import type { Filesystem, OpenAPIV3xDocument } from '@gitbook/openapi-parser';
 import type { OpenAPIOperationData } from './types';
-export { toJSON, fromJSON };
+export { fromJSON, toJSON };
 /**
  * Resolve an OpenAPI operation in a file and compile it to a more usable format.
  */

package/dist/resolveOpenAPIOperation.js

@@ -55,9 +55,9 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 import { fromJSON, toJSON } from 'flatted';
-import { dereference, } from '@gitbook/openapi-parser';
+import { dereferenceFilesystem } from './dereference';
 import { checkIsReference } from './utils';
-export { toJSON, fromJSON };
+export { fromJSON, toJSON };
 /**
  * Resolve an OpenAPI operation in a file and compile it to a more usable format.
  */
@@ -69,7 +69,7 @@ export function resolveOpenAPIOperation(filesystem, operationDescriptor) {
             switch (_g.label) {
                 case 0:
                     path = operationDescriptor.path, method = operationDescriptor.method;
-                    return [4 /*yield*/, memoDereferenceFilesystem(filesystem)];
+                    return [4 /*yield*/, dereferenceFilesystem(filesystem)];
                 case 1:
                     schema = _g.sent();
                     operation = getOperationByPathAndMethod(schema, path, method);
@@ -108,37 +108,6 @@ export function resolveOpenAPIOperation(filesystem, operationDescriptor) {
         });
     });
 }
-var dereferenceCache = new WeakMap();
-/**
- * Memoized version of `dereferenceSchema`.
- */
-function memoDereferenceFilesystem(filesystem) {
-    if (dereferenceCache.has(filesystem)) {
-        return dereferenceCache.get(filesystem);
-    }
-    var promise = dereferenceFilesystem(filesystem);
-    dereferenceCache.set(filesystem, promise);
-    return promise;
-}
-/**
- * Dereference an OpenAPI schema.
- */
-function dereferenceFilesystem(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];
-            }
-        });
-    });
-}
 /**
  * Get a path object from its path.
  */