Skip to content

Commit ce88cc9

Browse files
committed
Generic ResolveOpenAPIBlockResult type
1 parent dbb6817 commit ce88cc9

File tree

3 files changed

+11
-19
lines changed

3 files changed

+11
-19
lines changed

packages/gitbook/src/lib/openapi/resolveOpenAPIModelsBlock.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
import { fetchOpenAPIFilesystem } from '@/lib/openapi/fetch';
2-
import type { ResolveOpenAPIModelsBlockResult } from '@/lib/openapi/types';
2+
import type { ResolveOpenAPIBlockResult } from '@/lib/openapi/types';
33
import { OpenAPIParseError } from '@gitbook/openapi-parser';
4-
import { resolveOpenAPIModels } from '@gitbook/react-openapi';
4+
import { type OpenAPIModelsData, resolveOpenAPIModels } from '@gitbook/react-openapi';
55
import type { AnyOpenAPIBlock, ResolveOpenAPIBlockArgs } from './types';
66

7+
type ResolveOpenAPIModelsBlockResult = ResolveOpenAPIBlockResult<OpenAPIModelsData>;
8+
79
const weakmap = new WeakMap<AnyOpenAPIBlock, Promise<ResolveOpenAPIModelsBlockResult>>();
810

911
/**

packages/gitbook/src/lib/openapi/resolveOpenAPIOperationBlock.ts

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
import { fetchOpenAPIFilesystem } from '@/lib/openapi/fetch';
22
import { OpenAPIParseError } from '@gitbook/openapi-parser';
3-
import { resolveOpenAPIOperation } from '@gitbook/react-openapi';
4-
import type {
5-
AnyOpenAPIBlock,
6-
ResolveOpenAPIBlockArgs,
7-
ResolveOpenAPIOperationBlockResult,
8-
} from './types';
3+
import { type OpenAPIOperationData, resolveOpenAPIOperation } from '@gitbook/react-openapi';
4+
import type { AnyOpenAPIBlock, ResolveOpenAPIBlockArgs, ResolveOpenAPIBlockResult } from './types';
5+
6+
type ResolveOpenAPIOperationBlockResult = ResolveOpenAPIBlockResult<OpenAPIOperationData>;
97

108
const weakmap = new WeakMap<AnyOpenAPIBlock, Promise<ResolveOpenAPIOperationBlockResult>>();
119

packages/gitbook/src/lib/openapi/types.ts

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import type { DocumentBlockOpenAPI, DocumentBlockOpenAPIOperation } from '@gitbook/api';
22
import type { Filesystem, OpenAPIParseError, OpenAPIV3xDocument } from '@gitbook/openapi-parser';
3-
import type { OpenAPIModelsData, OpenAPIOperationData } from '@gitbook/react-openapi';
43
import type { GitBookAnyContext } from '@v2/lib/context';
54

65
//!!TODO: Add DocumentBlockOpenAPIModels when available in @gitbook/api
@@ -35,17 +34,10 @@ type FetchOpenAPIFilesystemError = {
3534
};
3635

3736
/**
38-
* Resolved OpenAPI models block result.
37+
* Resolved OpenAPI block result.
3938
*/
40-
export type ResolveOpenAPIModelsBlockResult =
41-
| { error?: undefined; data: OpenAPIModelsData | null; specUrl: string | null }
42-
| ResolveOpenAPIBlockError;
43-
44-
/**
45-
* Resolved OpenAPI operation block result.
46-
*/
47-
export type ResolveOpenAPIOperationBlockResult =
48-
| { error?: undefined; data: OpenAPIOperationData | null; specUrl: string | null }
39+
export type ResolveOpenAPIBlockResult<T> =
40+
| { error?: undefined; data: T | null; specUrl: string | null }
4941
| ResolveOpenAPIBlockError;
5042

5143
/**

0 commit comments

Comments
 (0)