chore: Update main typings

Author: 3y3

src/includer/constants.ts

@@ -1,4 +1,4 @@
-import type {OpenJSONSchema} from './models';
+import type {OpenAPIV3} from 'openapi-types';
 
 export enum LeadingPageMode {
     Section = 'section',
@@ -30,7 +30,7 @@ export const DEPRECATED_ANNOTATION = 'Deprecated';
 export const DEPRECATED_POPUP_TEXT =
     'No longer supported, please use an alternative and newer version.';
 export const SUPPORTED_ENUM_TYPES = ['string', 'number'] as const;
-export const PRIMITIVE_JSON6_SCHEMA_TYPES = new Set<OpenJSONSchema['type']>([
+export const PRIMITIVE_JSON6_SCHEMA_TYPES = new Set<OpenAPIV3.SchemaObject['type'] | 'null'>([
     'string',
     'boolean',
     'null',

src/includer/index.ts

@@ -1,12 +1,11 @@
+import type {OpenAPIV3} from 'openapi-types';
 import type {
-    OpenAPISpec,
+    Dereference,
     OpenApiIncluderParams,
-    OpenJSONSchema,
     Run,
     V3Endpoint,
     V3Info,
     YfmPreset,
-    YfmToc,
     YfmTocItem,
 } from './models';
 
@@ -111,7 +110,10 @@ function assertLeadingPageMode(mode: string) {
     );
 }
 
-async function generateToc(data: OpenAPISpec, ctx: Context): Promise<YfmToc> {
+async function generateToc(
+    data: Dereference<OpenAPIV3.Document>,
+    ctx: Context,
+): Promise<YfmTocItem> {
     const {vars, params} = ctx;
     const {leadingPage, filter} = params;
     const leadingPageName = leadingPage?.name ?? LEADING_PAGE_NAME_DEFAULT;
@@ -166,7 +168,7 @@ async function generateToc(data: OpenAPISpec, ctx: Context): Promise<YfmToc> {
         addLeadingPage(toc, leadingPageMode, rootLadingPageName, 'index.md');
     }
 
-    return toc as YfmToc;
+    return toc;
 }
 
 function addLeadingPage(section: YfmTocItem, mode: LeadingPageMode, name: string, href: string) {
@@ -185,7 +187,10 @@ type EndpointRoute = {
     content: string;
 };
 
-async function generateContent(data: OpenAPISpec, ctx: Context): Promise<EndpointRoute[]> {
+async function generateContent(
+    data: Dereference<OpenAPIV3.Document>,
+    ctx: Context,
+): Promise<EndpointRoute[]> {
     const {vars, params} = ctx;
     const {input, leadingPage, filter, noindex, hidden, sandbox} = params;
     const contentPath = ctx.relative(input);
@@ -274,17 +279,18 @@ function handleEndpointIncluder(
     return {path, content};
 }
 
-function handleEndpointRender(endpoint: V3Endpoint, pathPrefix?: string): YfmToc {
+function handleEndpointRender(endpoint: V3Endpoint, pathPrefix?: string): YfmTocItem {
     let path = mdPath(endpoint);
     if (pathPrefix) {
         path = join(pathPrefix, path);
     }
+
     return {
         href: path,
         name: sectionName(endpoint),
         hidden: endpoint.hidden,
         deprecated: endpoint.deprecated,
-    } as YfmToc;
+    };
 }
 
 export function sectionName(e: V3Endpoint): string {

src/includer/models.ts

@@ -1,23 +1,29 @@
-import type {JSONSchema6, JSONSchema6Definition} from 'json-schema';
-import type {
-    LeadingPageMode,
-    SPEC_RENDER_MODE_DEFAULT,
-    SPEC_RENDER_MODE_HIDDEN,
-    SUPPORTED_ENUM_TYPES,
-} from './constants';
+import type {OpenAPIV3} from 'openapi-types';
+import type {LeadingPageMode, SPEC_RENDER_MODE_DEFAULT, SPEC_RENDER_MODE_HIDDEN} from './constants';
 
-export type VarsPreset = 'internal' | 'external';
+export type Dereference<T> = T extends OpenAPIV3.ReferenceObject
+    ? never
+    : T extends object
+      ? T extends OpenAPIV3.ReferenceObject
+          ? never
+          : // eslint-disable-next-line
+            T extends any[]
+            ? DereferenceArray<T[number]>
+            : DereferenceObject<T>
+      : T;
+
+type DereferenceArray<T> = Array<Dereference<T>>;
+
+type DereferenceObject<T extends object> = {
+    [K in keyof T]: Dereference<T[K]>;
+};
+
+export type TableRef = string;
 
 export type YfmPreset = Record<string, string>;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type Metadata = Record<string, any>;
 
-export enum IncludeMode {
-    ROOT_MERGE = 'root_merge',
-    MERGE = 'merge',
-    LINK = 'link',
-}
-
 export interface Filter {
     when?: boolean | string;
     [key: string]: unknown;
@@ -29,68 +35,14 @@ export interface TextItem extends Filter {
 
 export type TextItems = string | (TextItem | string)[];
 
-export interface YfmToc extends Filter {
-    name: string;
-    href: string;
-    items: YfmToc[];
-    stage?: Stage;
-    base?: string;
-    title?: TextItems;
-    include?: YfmTocInclude;
-    id?: string;
-    singlePage?: boolean;
-    hidden?: boolean;
-    deprecated?: boolean;
-}
-
 export interface YfmTocItem extends Filter {
     name: string;
     href?: string;
     items?: YfmTocItem[];
-    include?: YfmTocInclude;
-    id?: string;
-}
-
-export interface YfmTocInclude {
-    repo: string;
-    path: string;
-    mode?: IncludeMode;
-    includers?: YfmTocIncluders;
+    hidden?: boolean;
+    deprecated?: boolean;
 }
 
-export type YfmTocIncluders = YfmTocIncluder[];
-
-export type YfmTocIncluder = {
-    name: 'openapi';
-    // arbitrary includer parameters
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-} & Record<string, unknown>;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type Includer<FnParams = any> = {
-    name: 'openapi';
-    includerFunction: IncluderFunction<FnParams>;
-};
-
-export type IncluderFunction<PassedParams> = (
-    args: IncluderFunctionParams<PassedParams>,
-) => Promise<void>;
-
-export type IncluderFunctionParams<PassedParams> = {
-    /** item that contains include that uses includer */
-    item: YfmToc;
-    /** base read directory path */
-    readBasePath: string;
-    /** base write directory path */
-    writeBasePath: string;
-    /** toc with includer path */
-    tocPath: string;
-    vars: YfmPreset;
-    /** arbitrary includer parameters */
-    passedParams: PassedParams;
-    index: number;
-};
-
 export const titleDepths = [1, 2, 3, 4, 5, 6] as const;
 
 export type TitleDepth = (typeof titleDepths)[number];
@@ -99,22 +51,16 @@ export type SandboxProps = {
     path: string;
     host?: string;
     method: Method;
-    pathParams?: V3Parameters;
-    searchParams?: V3Parameters;
-    headers?: V3Parameters;
+    pathParams?: Dereference<OpenAPIV3.ParameterObject>[];
+    searchParams?: Dereference<OpenAPIV3.ParameterObject>[];
+    headers?: Dereference<OpenAPIV3.ParameterObject>[];
     body?: string;
     bodyType?: string;
-    schema?: OpenJSONSchema;
+    schema?: Dereference<OpenAPIV3.SchemaObject>;
     security?: V3Security[];
     projectName: string;
 };
 
-export type OpenAPISpec = {
-    /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
-    [key: string]: any;
-    security?: Array<Record<string, V3Security>>;
-};
-
 export type V3SecurityApiKey = {
     type: 'apiKey';
     description: string;
@@ -145,24 +91,6 @@ export type V3Security = V3SecurityApiKey | V3SecurityOAuth2 | {type: string; de
 
 export type V3SecurityType = V3Security['type'];
 
-export type OpenAPIOperation = {
-    summary?: string;
-    description?: string;
-    operationId?: string;
-    deprecated?: boolean;
-    tags?: string[];
-    servers?: V3Servers;
-    parameters?: V3Parameters;
-    responses?: {};
-    requestBody?: {
-        required?: boolean;
-        description?: string;
-        content: {[ContentType: string]: {schema: OpenJSONSchema}};
-    };
-    security?: Array<Record<string, V3Security>>;
-    'x-navtitle': string[];
-};
-
 export type V3Info = {
     name: string;
     version: string;
@@ -198,14 +126,14 @@ export type V3Endpoints = V3Endpoint[];
 export type V3Endpoint = {
     id: string;
     operationId?: string;
-    method: Method;
+    method: string;
     path: string;
     tags: string[];
     summary?: string;
     description?: string;
     servers: V3Servers;
-    parameters?: V3Parameters;
-    responses?: V3Responses;
+    parameters: Dereference<OpenAPIV3.ParameterObject>[];
+    responses: V3Responses;
     requestBody?: V3Schema;
     security: V3Security[];
     noindex?: boolean;
@@ -238,28 +166,10 @@ export type V3Server = {
     description?: string;
 };
 
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export type V3Parameters = V3Parameter[];
-
 export type In = 'path' | 'query' | 'header' | 'cookie';
 
 export type Primitive = string | number | boolean;
 
-export type V3Parameter = {
-    name: string;
-    in: In;
-    required: boolean;
-    description?: string;
-    example?: Primitive;
-    default?: Primitive;
-    schema: OpenJSONSchema;
-
-    readOnly?: boolean;
-    writeOnly?: boolean;
-    // vendor extensions
-    'x-hidden'?: boolean;
-};
-
 export type V3Responses = V3Response[];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
@@ -268,41 +178,21 @@ export type V3Response = {
     code: string;
     statusText: string;
     description: string;
-    schemas?: V3Schemas;
+    schemas?: V3Schema[];
+    deprecated?: boolean;
 };
 
-export type V3Schemas = V3Schema[];
-
 export type V3Schema = {
     type: string;
-    schema: OpenJSONSchema;
+    schema: OpenAPIV3.SchemaObject;
 };
 
-export type Refs = {[typeName: string]: OpenJSONSchema};
-
-export type JsType =
-    | 'string'
-    | 'number'
-    | 'bigint'
-    | 'boolean'
-    | 'symbol'
-    | 'undefined'
-    | 'object'
-    | 'function';
+export type Refs = {[typeName: string]: OpenAPIV3.SchemaObject};
 
 export type LeadingPageSpecRenderMode =
     | typeof SPEC_RENDER_MODE_DEFAULT
     | typeof SPEC_RENDER_MODE_HIDDEN;
 
-export type SupportedEnumType = (typeof SUPPORTED_ENUM_TYPES)[number];
-
-export enum Stage {
-    NEW = 'new',
-    PREVIEW = 'preview',
-    TECH_PREVIEW = 'tech-preview',
-    SKIP = 'skip',
-}
-
 export type LeadingPageParams = {
     name?: string;
     mode?: LeadingPageMode;
@@ -340,32 +230,6 @@ export type OpenApiIncluderParams = {
     };
 };
 
-export type OpenJSONSchema = JSONSchema6 & {
-    _runtime?: true;
-    _emptyDescription?: true;
-    example?: unknown;
-    deprecated?: boolean;
-    properties?: {
-        [key: string]: JSONSchema6Definition & {
-            readOnly?: boolean;
-            writeOnly?: boolean;
-            'x-hidden'?: boolean;
-        };
-    };
-};
-export type OpenJSONSchemaDefinition = OpenJSONSchema | boolean;
-
-export type FoundRefType = {
-    ref: string;
-};
-export type BaseJSONSchemaType = Exclude<OpenJSONSchema['type'], undefined>;
-export type JSONSchemaUnionType = {
-    ref?: string;
-    /* Not oneOf because of collision with OpenJSONSchema['oneOf'] */
-    unionOf: JSONSchemaType[];
-};
-export type JSONSchemaType = BaseJSONSchemaType | JSONSchemaUnionType | FoundRefType;
-
 export type Run = {
     input: string;
     vars: {