Skip to content

feat: Re-design of the Preprocessor to Reach and Strip all Examples in the Schema #1051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

feat: Re-design of the Preprocessor to Reach and Strip all Examples in the Schema #1051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
fda99f0
feat: initial implementation with bugs
max-at-silverflow Mar 4, 2025
997940d
improved state tracking
max-at-silverflow Mar 4, 2025
5623da5
fix schema replacement
max-at-silverflow Mar 4, 2025
ee41b3f
fix path naming for path items
max-at-silverflow Mar 4, 2025
5e8b5dc
small fix to document parsing order
max-at-silverflow Mar 4, 2025
8528ff2
make sure all schemas are unreferenced
max-at-silverflow Mar 4, 2025
bdf6315
remove old code
max-at-silverflow Mar 4, 2025
127a606
fix incorrect reference back-filling
max-at-silverflow Mar 4, 2025
1de5b2c
fix circular references
max-at-silverflow Mar 4, 2025
347e306
properly process discriminators
max-at-silverflow Mar 5, 2025
e14103f
fix circular reference detection
max-at-silverflow Mar 5, 2025
10c787d
refactored preprocessor
max-at-silverflow Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 42 additions & 27 deletions src/framework/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import AjvDraft4 from 'ajv-draft-04';
import Ajv2020 from 'ajv/dist/2020';
export { OpenAPIFrameworkArgs };

export type AjvInstance = AjvDraft4 | Ajv2020
export type AjvInstance = AjvDraft4 | Ajv2020;

export type BodySchema =
| OpenAPIV3.ReferenceObject
Expand Down Expand Up @@ -48,7 +48,7 @@ export interface Options extends ajv.Options {
ajvFormats?: FormatsPluginOptions;
}

export interface RequestValidatorOptions extends Options, ValidateRequestOpts { }
export interface RequestValidatorOptions extends Options, ValidateRequestOpts {}

export type ValidateRequestOpts = {
/**
Expand Down Expand Up @@ -125,32 +125,42 @@ export class SerDesSingleton implements SerDes {
serialize: param.serialize,
};
}
};
}

export type SerDesMap = {
[format: string]: SerDes
[format: string]: SerDes;
};

type Primitive = undefined | null | boolean | string | number | Function
type Primitive = undefined | null | boolean | string | number | Function;

type Immutable<T> =
T extends Primitive ? T :
T extends Array<infer U> ? ReadonlyArray<U> :
T extends Map<infer K, infer V> ? ReadonlyMap<K, V> : Readonly<T>
type Immutable<T> = T extends Primitive
? T
: T extends Array<infer U>
? ReadonlyArray<U>
: T extends Map<infer K, infer V>
? ReadonlyMap<K, V>
: Readonly<T>;

type DeepImmutable<T> =
T extends Primitive ? T :
T extends Array<infer U> ? DeepImmutableArray<U> :
T extends Map<infer K, infer V> ? DeepImmutableMap<K, V> : DeepImmutableObject<T>
type DeepImmutable<T> = T extends Primitive
? T
: T extends Array<infer U>
? DeepImmutableArray<U>
: T extends Map<infer K, infer V>
? DeepImmutableMap<K, V>
: DeepImmutableObject<T>;

interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {}
interface DeepImmutableMap<K, V> extends ReadonlyMap<DeepImmutable<K>, DeepImmutable<V>> {}
interface DeepImmutableMap<K, V>
extends ReadonlyMap<DeepImmutable<K>, DeepImmutable<V>> {}
type DeepImmutableObject<T> = {
readonly [K in keyof T]: DeepImmutable<T[K]>
}
readonly [K in keyof T]: DeepImmutable<T[K]>;
};

export interface OpenApiValidatorOpts {
apiSpec: DeepImmutable<OpenAPIV3.DocumentV3> | DeepImmutable<OpenAPIV3.DocumentV3_1> | string;
apiSpec:
| DeepImmutable<OpenAPIV3.DocumentV3>
| DeepImmutable<OpenAPIV3.DocumentV3_1>
| string;
validateApiSpec?: boolean;
validateResponses?: boolean | ValidateResponseOpts;
validateRequests?: boolean | ValidateRequestOpts;
Expand Down Expand Up @@ -204,18 +214,19 @@ export namespace OpenAPIV3 {
externalDocs?: ExternalDocumentationObject;
}

interface ComponentsV3_1 extends ComponentsObject {
pathItems?: { [path: string]: PathItemObject | ReferenceObject }
export interface ComponentsV3_1 extends ComponentsObject {
pathItems?: { [path: string]: PathItemObject | ReferenceObject };
}

export interface DocumentV3_1 extends Omit<DocumentV3, 'paths' | 'info' | 'components'| "openapi" > {
export interface DocumentV3_1
extends Omit<DocumentV3, 'paths' | 'info' | 'components' | 'openapi'> {
openapi: `3.1.${string}`;
paths?: DocumentV3['paths'];
info: InfoObjectV3_1;
components: ComponentsV3_1;
webhooks: {
[name: string]: PathItemObject | ReferenceObject
}
[name: string]: PathItemObject | ReferenceObject;
};
}

export interface InfoObject {
Expand Down Expand Up @@ -299,7 +310,7 @@ export namespace OpenAPIV3 {
in: string;
}

export interface HeaderObject extends ParameterBaseObject { }
export interface HeaderObject extends ParameterBaseObject {}

interface ParameterBaseObject {
description?: string;
Expand All @@ -323,14 +334,18 @@ export namespace OpenAPIV3 {
| 'integer';
export type ArraySchemaObjectType = 'array';

export type SchemaObject = ArraySchemaObject | NonArraySchemaObject | CompositionSchemaObject;
export type SchemaObject =
| ArraySchemaObject
| NonArraySchemaObject
| CompositionSchemaObject;

export interface ArraySchemaObject extends BaseSchemaObject<ArraySchemaObjectType> {
export interface ArraySchemaObject
extends BaseSchemaObject<ArraySchemaObjectType> {
items: ReferenceObject | SchemaObject;
}

export interface NonArraySchemaObject extends BaseSchemaObject<NonArraySchemaObjectType> {
}
export interface NonArraySchemaObject
extends BaseSchemaObject<NonArraySchemaObjectType> {}

export interface CompositionSchemaObject extends BaseSchemaObject<undefined> {
// JSON schema allowed properties, adjusted for OpenAPI
Expand Down
Loading