Skip to content

Commit b9f3cae

Browse files
committed
lint
1 parent 96fe664 commit b9f3cae

22 files changed

+61
-166
lines changed

packages/openapi-metadata/src/decorators/api-body.ts

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
import type { SetOptional } from "type-fest";
2-
import {
3-
type OperationBodyMetadata,
4-
OperationBodyMetadataStorage,
5-
} from "../metadata/operation-body.js";
2+
import { type OperationBodyMetadata, OperationBodyMetadataStorage } from "../metadata/operation-body.js";
63

74
export type ApiBodyOptions = SetOptional<OperationBodyMetadata, "mediaType">;
85

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
import {
2-
type OperationParameterMetadata,
3-
OperationParameterMetadataStorage,
4-
} from "../metadata/operation-parameter.js";
1+
import { type OperationParameterMetadata, OperationParameterMetadataStorage } from "../metadata/operation-parameter.js";
52

63
export type ApiCookieOptions = Omit<OperationParameterMetadata, "in">;
74

85
export function ApiCookie(options: ApiCookieOptions) {
96
return (target: Object, propertyKey?: string | symbol) => {
10-
OperationParameterMetadataStorage.mergeMetadata(
11-
target,
12-
[{ in: "cookie", ...options }],
13-
propertyKey,
14-
);
7+
OperationParameterMetadataStorage.mergeMetadata(target, [{ in: "cookie", ...options }], propertyKey);
158
};
169
}
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
import {
2-
type OperationParameterMetadata,
3-
OperationParameterMetadataStorage,
4-
} from "../metadata/operation-parameter.js";
1+
import { type OperationParameterMetadata, OperationParameterMetadataStorage } from "../metadata/operation-parameter.js";
52

63
export type ApiHeaderOptions = Omit<OperationParameterMetadata, "in">;
74

85
export function ApiHeader(options: ApiHeaderOptions) {
96
return (target: Object, propertyKey?: string | symbol) => {
10-
OperationParameterMetadataStorage.mergeMetadata(
11-
target,
12-
[{ in: "header", ...options }],
13-
propertyKey,
14-
);
7+
OperationParameterMetadataStorage.mergeMetadata(target, [{ in: "header", ...options }], propertyKey);
158
};
169
}

packages/openapi-metadata/src/decorators/api-operation.ts

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
import {
2-
type OperationMetadata,
3-
OperationMetadataStorage,
4-
} from "../metadata/operation.js";
1+
import { type OperationMetadata, OperationMetadataStorage } from "../metadata/operation.js";
52

63
export type ApiOperationOptions = OperationMetadata;
74

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
import {
2-
type OperationParameterMetadata,
3-
OperationParameterMetadataStorage,
4-
} from "../metadata/operation-parameter.js";
1+
import { type OperationParameterMetadata, OperationParameterMetadataStorage } from "../metadata/operation-parameter.js";
52

63
export type ApiParamOptions = Omit<OperationParameterMetadata, "in">;
74

85
export function ApiParam(options: ApiParamOptions) {
96
return function (target: Object, propertyKey?: string | symbol) {
10-
OperationParameterMetadataStorage.mergeMetadata(
11-
target,
12-
[{ in: "path", ...options }],
13-
propertyKey,
14-
);
7+
OperationParameterMetadataStorage.mergeMetadata(target, [{ in: "path", ...options }], propertyKey);
158
};
169
}

packages/openapi-metadata/src/decorators/api-property.ts

+4-13
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,13 @@
11
import type { Context } from "../context.js";
22
import { SymbolKeysNotSupportedError } from "../errors/symbol-keys-not-supported.js";
3-
import {
4-
type PropertyMetadata,
5-
PropertyMetadataStorage,
6-
} from "../metadata/property.js";
3+
import { type PropertyMetadata, PropertyMetadataStorage } from "../metadata/property.js";
74
import { findType } from "../utils/metadata.js";
85

96
export type ApiPropertyOptions = Partial<PropertyMetadata>;
107

118
export function ApiProperty(options?: ApiPropertyOptions): PropertyDecorator;
129
export function ApiProperty(options?: ApiPropertyOptions): MethodDecorator;
13-
export function ApiProperty(
14-
options?: ApiPropertyOptions,
15-
): PropertyDecorator | MethodDecorator {
10+
export function ApiProperty(options?: ApiPropertyOptions): PropertyDecorator | MethodDecorator {
1611
return (prototype, propertyKey, descriptor) => {
1712
const isMethod = Boolean(descriptor?.value);
1813

@@ -42,12 +37,8 @@ export function ApiProperty(
4237
};
4338
}
4439

45-
export function ApiPropertyOptional(
46-
options?: Omit<ApiPropertyOptions, "required">,
47-
): PropertyDecorator;
48-
export function ApiPropertyOptional(
49-
options?: Omit<ApiPropertyOptions, "required">,
50-
): MethodDecorator;
40+
export function ApiPropertyOptional(options?: Omit<ApiPropertyOptions, "required">): PropertyDecorator;
41+
export function ApiPropertyOptional(options?: Omit<ApiPropertyOptions, "required">): MethodDecorator;
5142
export function ApiPropertyOptional(
5243
options?: Omit<ApiPropertyOptions, "required">,
5344
): PropertyDecorator | MethodDecorator {
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
import {
2-
type OperationParameterMetadata,
3-
OperationParameterMetadataStorage,
4-
} from "../metadata/operation-parameter.js";
1+
import { type OperationParameterMetadata, OperationParameterMetadataStorage } from "../metadata/operation-parameter.js";
52

63
export type ApiQueryOptions = Omit<OperationParameterMetadata, "in">;
74

85
export function ApiQuery(options: ApiQueryOptions) {
96
return function (target: Object, propertyKey?: string | symbol) {
10-
OperationParameterMetadataStorage.mergeMetadata(
11-
target,
12-
[{ in: "query", ...options }],
13-
propertyKey,
14-
);
7+
OperationParameterMetadataStorage.mergeMetadata(target, [{ in: "query", ...options }], propertyKey);
158
};
169
}

packages/openapi-metadata/src/decorators/api-response.ts

+2-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
11
import type { SetOptional } from "type-fest";
2-
import {
3-
type OperationResponseMetadata,
4-
OperationResponseMetadataStorage,
5-
} from "../metadata/operation-response.js";
2+
import { type OperationResponseMetadata, OperationResponseMetadataStorage } from "../metadata/operation-response.js";
63

7-
export type ApiResponseOptions = SetOptional<
8-
OperationResponseMetadata,
9-
"status" | "mediaType"
10-
>;
4+
export type ApiResponseOptions = SetOptional<OperationResponseMetadata, "status" | "mediaType">;
115

126
export function ApiResponse(options: ApiResponseOptions) {
137
return function (target: Object, propertyKey?: string | symbol) {

packages/openapi-metadata/src/generators/document.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,7 @@ export type GenerateDocumentOptions = {
4040
/**
4141
* Generates a compliant OpenAPIV3 schema.
4242
*/
43-
export async function generateDocument(
44-
options: GenerateDocumentOptions,
45-
): Promise<OpenAPIDocument> {
43+
export async function generateDocument(options: GenerateDocumentOptions): Promise<OpenAPIDocument> {
4644
const context = new Context(options.customLogger, options.loaders);
4745

4846
return deepmerge(options.document, {

packages/openapi-metadata/src/generators/operation.ts

+5-20
Original file line numberDiff line numberDiff line change
@@ -30,33 +30,18 @@ export async function generateOperation(
3030
operation.requestBody = await generateOperationBody(context, body);
3131
}
3232

33-
const parameters = OperationParameterMetadataStorage.getMetadata(
34-
target,
35-
propertyKey,
36-
);
33+
const parameters = OperationParameterMetadataStorage.getMetadata(target, propertyKey);
3734
operation.parameters = [];
3835
for (const parameter of parameters) {
39-
operation.parameters.push(
40-
await generateOperationParameters(context, parameter),
41-
);
36+
operation.parameters.push(await generateOperationParameters(context, parameter));
4237
}
4338

44-
const responses = OperationResponseMetadataStorage.getMetadata(
45-
target,
46-
propertyKey,
47-
);
39+
const responses = OperationResponseMetadataStorage.getMetadata(target, propertyKey);
4840
for (const [status, response] of Object.entries(responses)) {
49-
operation.responses[status] = await generateOperationResponse(
50-
context,
51-
response,
52-
);
41+
operation.responses[status] = await generateOperationResponse(context, response);
5342
}
5443

55-
const security = OperationSecurityMetadataStorage.getMetadata(
56-
target,
57-
propertyKey,
58-
true,
59-
);
44+
const security = OperationSecurityMetadataStorage.getMetadata(target, propertyKey, true);
6045

6146
operation.security = [security];
6247

packages/openapi-metadata/src/generators/paths.ts

+4-13
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
11
import type { OpenAPIV3 } from "openapi-types";
22
import type { Context } from "../context.js";
33
import { generateOperation } from "./operation.js";
4-
import {
5-
ExcludeMetadataStorage,
6-
OperationMetadataStorage,
7-
} from "../metadata/index.js";
8-
9-
export async function generatePaths(
10-
context: Context,
11-
controllers: Function[],
12-
): Promise<OpenAPIV3.PathsObject> {
4+
import { ExcludeMetadataStorage, OperationMetadataStorage } from "../metadata/index.js";
5+
6+
export async function generatePaths(context: Context, controllers: Function[]): Promise<OpenAPIV3.PathsObject> {
137
const paths: OpenAPIV3.PathsObject = {};
148

159
for (const controller of controllers) {
@@ -31,10 +25,7 @@ export async function generatePaths(
3125
}
3226

3327
for (const method of metadata.methods) {
34-
const excludeOperation = ExcludeMetadataStorage.getMetadata(
35-
target,
36-
key,
37-
);
28+
const excludeOperation = ExcludeMetadataStorage.getMetadata(target, key);
3829

3930
if (excludeOperation === true) {
4031
continue;

packages/openapi-metadata/src/loaders/type.ts

+9-25
Original file line numberDiff line numberDiff line change
@@ -39,34 +39,24 @@ const ClassTypeLoader: TypeLoaderFn = async (context, value) => {
3939
return { $ref: schemaPath(model) };
4040
}
4141

42-
const schema: SetRequired<OpenAPIV3.SchemaObject, "properties" | "required"> =
43-
{
44-
type: "object",
45-
properties: {},
46-
required: [],
47-
};
42+
const schema: SetRequired<OpenAPIV3.SchemaObject, "properties" | "required"> = {
43+
type: "object",
44+
properties: {},
45+
required: [],
46+
};
4847

4948
const properties = PropertyMetadataStorage.getMetadata(value.prototype);
5049

5150
if (!properties) {
52-
context.logger.warn(
53-
`You tried to use '${model}' as a type but it does not contain any ApiProperty.`,
54-
);
51+
context.logger.warn(`You tried to use '${model}' as a type but it does not contain any ApiProperty.`);
5552

5653
return;
5754
}
5855

5956
context.schemas[model] = schema;
6057

6158
for (const [key, property] of Object.entries(properties)) {
62-
const {
63-
required,
64-
type,
65-
name,
66-
enum: e,
67-
schema: s,
68-
...metadata
69-
} = property as any;
59+
const { required, type, name, enum: e, schema: s, ...metadata } = property as any;
7060
schema.properties[key] = {
7161
...(await loadType(context, property)),
7262
...metadata,
@@ -106,18 +96,12 @@ export async function loadType(
10696
const thunk = isThunk(options.type);
10797
const value = thunk ? (options.type as Function)(context) : options.type;
10898

109-
for (const loader of [
110-
PrimitiveTypeLoader,
111-
...context.typeLoaders,
112-
ClassTypeLoader,
113-
]) {
99+
for (const loader of [PrimitiveTypeLoader, ...context.typeLoaders, ClassTypeLoader]) {
114100
const result = await loader(context, value, options.type);
115101
if (result) {
116102
return result;
117103
}
118104
}
119105

120-
context.logger.warn(
121-
`You tried to use '${options.type.toString()}' as a type but no loader supports it ${thunk}`,
122-
);
106+
context.logger.warn(`You tried to use '${options.type.toString()}' as a type but no loader supports it ${thunk}`);
123107
}

packages/openapi-metadata/src/metadata/exclude.ts

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,4 @@ import { createMetadataStorage } from "./factory.js";
22

33
export const ExcludeMetadataKey = Symbol("Exclude");
44

5-
export const ExcludeMetadataStorage = createMetadataStorage<boolean>(
6-
ExcludeMetadataKey,
7-
false,
8-
);
5+
export const ExcludeMetadataStorage = createMetadataStorage<boolean>(ExcludeMetadataKey, false);

packages/openapi-metadata/src/metadata/extra-models.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import { createMetadataStorage } from "./factory.js";
33

44
export const ExtraModelsMetadataKey = Symbol("ExtraModels");
55

6-
export const ExtraModelsMetadataStorage = createMetadataStorage<
7-
(TypeValue | Thunk<TypeValue>)[]
8-
>(ExtraModelsMetadataKey, []);
6+
export const ExtraModelsMetadataStorage = createMetadataStorage<(TypeValue | Thunk<TypeValue>)[]>(
7+
ExtraModelsMetadataKey,
8+
[],
9+
);

packages/openapi-metadata/src/metadata/operation-body.ts

+2-6
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,8 @@ import type { OpenAPIV3 } from "openapi-types";
22
import type { TypeOptions } from "../types.js";
33
import { createMetadataStorage } from "./factory.js";
44

5-
export type OperationBodyMetadata = Omit<
6-
OpenAPIV3.RequestBodyObject,
7-
"content"
8-
> & { mediaType: string } & TypeOptions;
5+
export type OperationBodyMetadata = Omit<OpenAPIV3.RequestBodyObject, "content"> & { mediaType: string } & TypeOptions;
96

107
export const OperationBodyMetadataKey = Symbol("OperationBody");
118

12-
export const OperationBodyMetadataStorage =
13-
createMetadataStorage<OperationBodyMetadata>(OperationBodyMetadataKey);
9+
export const OperationBodyMetadataStorage = createMetadataStorage<OperationBodyMetadata>(OperationBodyMetadataKey);

packages/openapi-metadata/src/metadata/operation-header.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,5 @@ export type OperationHeaderMetadata = Omit<OpenAPIV3.HeaderObject, "schema"> & {
88

99
export const OperationHeaderSymbol = Symbol("OperationHeader");
1010

11-
export const OperationHeaderMetadataStorage = createMetadataStorage<
12-
Record<string, OperationHeaderMetadata>
13-
>(OperationHeaderSymbol);
11+
export const OperationHeaderMetadataStorage =
12+
createMetadataStorage<Record<string, OperationHeaderMetadata>>(OperationHeaderSymbol);

packages/openapi-metadata/src/metadata/operation-parameter.ts

+5-7
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@ import type { OpenAPIV3 } from "openapi-types";
22
import type { TypeOptions } from "../types.js";
33
import { createMetadataStorage } from "./factory.js";
44

5-
export type OperationParameterMetadata = Omit<
6-
OpenAPIV3.ParameterObject,
7-
"in" | "schema"
8-
> & {
5+
export type OperationParameterMetadata = Omit<OpenAPIV3.ParameterObject, "in" | "schema"> & {
96
name: string;
107
in: "path" | "query" | "header" | "cookie";
118
} & Partial<TypeOptions>;
129

1310
export const OperationParameterMetadataKey = Symbol("OperationParameter");
1411

15-
export const OperationParameterMetadataStorage = createMetadataStorage<
16-
OperationParameterMetadata[]
17-
>(OperationParameterMetadataKey, []);
12+
export const OperationParameterMetadataStorage = createMetadataStorage<OperationParameterMetadata[]>(
13+
OperationParameterMetadataKey,
14+
[],
15+
);

packages/openapi-metadata/src/metadata/operation-response.ts

+5-7
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,14 @@ import type { TypeOptions } from "../types.js";
33
import type { SetOptional } from "type-fest";
44
import { createMetadataStorage } from "./factory.js";
55

6-
export type OperationResponseMetadata = Omit<
7-
SetOptional<OpenAPIV3.ResponseObject, "description">,
8-
"content"
9-
> & {
6+
export type OperationResponseMetadata = Omit<SetOptional<OpenAPIV3.ResponseObject, "description">, "content"> & {
107
status: number | "default";
118
mediaType: string;
129
} & TypeOptions;
1310

1411
export const OperationResponseMetadataKey = Symbol("OperationResponse");
1512

16-
export const OperationResponseMetadataStorage = createMetadataStorage<
17-
Record<string, OperationResponseMetadata>
18-
>(OperationResponseMetadataKey, {});
13+
export const OperationResponseMetadataStorage = createMetadataStorage<Record<string, OperationResponseMetadata>>(
14+
OperationResponseMetadataKey,
15+
{},
16+
);

packages/openapi-metadata/src/metadata/operation-security.ts

+4-5
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ export type OperationSecurityMetadata = OpenAPIV3.SecurityRequirementObject;
55

66
export const OperationSecurityMetadataKey = Symbol("OperationSecurity");
77

8-
export const OperationSecurityMetadataStorage =
9-
createMetadataStorage<OpenAPIV3.SecurityRequirementObject>(
10-
OperationSecurityMetadataKey,
11-
{},
12-
);
8+
export const OperationSecurityMetadataStorage = createMetadataStorage<OpenAPIV3.SecurityRequirementObject>(
9+
OperationSecurityMetadataKey,
10+
{},
11+
);

packages/openapi-metadata/src/metadata/operation.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,4 @@ export type OperationMetadata = Omit<OpenAPIV3.OperationObject, "responses"> & {
99

1010
export const OperationMetadataKey = Symbol("Operation");
1111

12-
export const OperationMetadataStorage =
13-
createMetadataStorage<OperationMetadata>(OperationMetadataKey, {});
12+
export const OperationMetadataStorage = createMetadataStorage<OperationMetadata>(OperationMetadataKey, {});

0 commit comments

Comments
 (0)