@gitbook/react-openapi 1.0.3 → 1.0.4

package/src/resolveOpenAPIOperation.test.ts

@@ -1,7 +1,7 @@
-import { it, expect, describe } from 'bun:test';
+import { describe, expect, it } from 'bun:test';
 
-import { resolveOpenAPIOperation } from './resolveOpenAPIOperation';
 import { parseOpenAPI, traverse } from '@gitbook/openapi-parser';
+import { resolveOpenAPIOperation } from './resolveOpenAPIOperation';
 
 async function fetchFilesystem(url: string) {
     const response = await fetch(url);
@@ -19,7 +19,7 @@ async function fetchFilesystem(url: string) {
 describe('#resolveOpenAPIOperation', () => {
     it('should resolve refs', async () => {
         const filesystem = await fetchFilesystem(
-            'https://petstore3.swagger.io/api/v3/openapi.json',
+            'https://petstore3.swagger.io/api/v3/openapi.json'
         );
         const resolved = await resolveOpenAPIOperation(filesystem, { method: 'put', path: '/pet' });
 
@@ -49,7 +49,7 @@ describe('#resolveOpenAPIOperation', () => {
 
     it('should support yaml', async () => {
         const filesystem = await fetchFilesystem(
-            'https://petstore3.swagger.io/api/v3/openapi.yaml',
+            'https://petstore3.swagger.io/api/v3/openapi.yaml'
         );
         const resolved = await resolveOpenAPIOperation(filesystem, { method: 'put', path: '/pet' });
 
@@ -98,7 +98,7 @@ describe('#resolveOpenAPIOperation', () => {
 
     it('should resolve to null if the method is not supported', async () => {
         const filesystem = await fetchFilesystem(
-            'https://petstore3.swagger.io/api/v3/openapi.json',
+            'https://petstore3.swagger.io/api/v3/openapi.json'
         );
         const resolved = await resolveOpenAPIOperation(filesystem, {
             method: 'dontexist',
@@ -144,7 +144,7 @@ describe('#resolveOpenAPIOperation', () => {
 
     it('should resolve a ref with whitespace', async () => {
         const filesystem = await fetchFilesystem(
-            ' https://petstore3.swagger.io/api/v3/openapi.json',
+            ' https://petstore3.swagger.io/api/v3/openapi.json'
         );
         const resolved = await resolveOpenAPIOperation(filesystem, {
             method: 'put',

package/src/resolveOpenAPIOperation.ts

@@ -1,13 +1,13 @@
-import { toJSON, fromJSON } from 'flatted';
+import { fromJSON, toJSON } from 'flatted';
 
 import {
-    type OpenAPIV3xDocument,
     type Filesystem,
     type OpenAPIV3,
     type OpenAPIV3_1,
+    type OpenAPIV3xDocument,
     dereference,
 } from '@gitbook/openapi-parser';
-import { OpenAPIOperationData } from './types';
+import type { OpenAPIOperationData } from './types';
 import { checkIsReference } from './utils';
 
 export { toJSON, fromJSON };
@@ -20,7 +20,7 @@ export async function resolveOpenAPIOperation(
     operationDescriptor: {
         path: string;
         method: string;
-    },
+    }
 ): Promise<OpenAPIOperationData | null> {
     const { path, method } = operationDescriptor;
     const schema = await memoDereferenceFilesystem(filesystem);
@@ -102,7 +102,7 @@ async function dereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3x
  */
 function getPathObject(
     schema: OpenAPIV3.Document | OpenAPIV3_1.Document,
-    path: string,
+    path: string
 ): OpenAPIV3.PathItemObject | OpenAPIV3_1.PathItemObject | null {
     if (schema.paths?.[path]) {
         return schema.paths[path];
@@ -115,7 +115,7 @@ function getPathObject(
  */
 function getPathObjectParameter(
     schema: OpenAPIV3.Document | OpenAPIV3_1.Document,
-    path: string,
+    path: string
 ):
     | (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[]
     | (OpenAPIV3.ParameterObject | OpenAPIV3_1.ReferenceObject)[]
@@ -133,7 +133,7 @@ function getPathObjectParameter(
 function getOperationByPathAndMethod(
     schema: OpenAPIV3.Document | OpenAPIV3_1.Document,
     path: string,
-    method: string,
+    method: string
 ): OpenAPIV3.OperationObject | null {
     // Types are buffy for OpenAPIV3_1.OperationObject, so we use v3
     const pathObject = getPathObject(schema, path);

package/src/stringifyOpenAPI.ts

@@ -12,6 +12,6 @@ export function stringifyOpenAPI(body: unknown, _?: null, indent?: number): stri
 
             return value;
         },
-        indent,
+        indent
     );
 }

package/src/util/server.test.ts

@@ -1,6 +1,6 @@
-import { describe, it, expect } from 'bun:test';
-import { interpolateServerURL, getDefaultServerURL } from './server';
-import { OpenAPIV3 } from '@gitbook/openapi-parser';
+import { describe, expect, it } from 'bun:test';
+import type { OpenAPIV3 } from '@gitbook/openapi-parser';
+import { getDefaultServerURL, interpolateServerURL } from './server';
 
 describe('#interpolateServerURL', () => {
     it('interpolates the server URL with the default values of the variables', () => {

package/src/util/server.ts

@@ -1,4 +1,4 @@
-import { OpenAPIV3 } from '@gitbook/openapi-parser';
+import type { OpenAPIV3 } from '@gitbook/openapi-parser';
 
 /**
  * Get the default URL for the server.
@@ -23,9 +23,8 @@ export function interpolateServerURL(server: OpenAPIV3.ServerObject) {
         .map((part) => {
             if (part.kind === 'text') {
                 return part.text;
-            } else {
-                return server.variables?.[part.name]?.default ?? `{${part.name}}`;
             }
+            return server.variables?.[part.name]?.default ?? `{${part.name}}`;
         })
         .join('');
 }

package/src/utils.ts

@@ -1,7 +1,7 @@
 import type { AnyObject, OpenAPIV3, OpenAPIV3_1 } from '@gitbook/openapi-parser';
 
 export function checkIsReference(
-    input: unknown,
+    input: unknown
 ): input is OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject {
     return typeof input === 'object' && !!input && '$ref' in input;
 }
@@ -32,7 +32,7 @@ export function resolveDescription(object: OpenAPIV3.SchemaObject | AnyObject) {
 export function extractDescriptions(object: AnyObject) {
     return {
         description: object.description,
-        ['x-gitbook-description-html']:
+        'x-gitbook-description-html':
             'x-gitbook-description-html' in object
                 ? object['x-gitbook-description-html']
                 : undefined,
@@ -61,7 +61,7 @@ export function resolveFirstExample(object: AnyObject) {
  * Extract the description, example and deprecated from parameter.
  */
 export function resolveParameterSchema(
-    parameter: OpenAPIV3.ParameterBaseObject,
+    parameter: OpenAPIV3.ParameterBaseObject
 ): OpenAPIV3.SchemaObject {
     const schema = checkIsReference(parameter.schema) ? undefined : parameter.schema;
     return {
@@ -79,7 +79,7 @@ export function resolveParameterSchema(
  * Transform a parameter object to a property object.
  */
 export function parameterToProperty(
-    parameter: OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject,
+    parameter: OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject
 ): {
     propertyName: string | undefined;
     schema: OpenAPIV3.SchemaObject;