diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 2ede5a638a2..2fbe6bf3838 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -257,7 +257,6 @@ module.exports = { "/tutorials/throw-http-exceptions", "/tutorials/not-found-page", "/tutorials/aws", - "/tutorials/jest", "/tutorials/seq", "/docs/controllers", "/docs/providers", diff --git a/packages/common/src/mvc/decorators/method/contentType.ts b/packages/common/src/mvc/decorators/method/contentType.ts index bae90d329ab..0a36e0c875a 100644 --- a/packages/common/src/mvc/decorators/method/contentType.ts +++ b/packages/common/src/mvc/decorators/method/contentType.ts @@ -19,6 +19,7 @@ import {Returns} from "@tsed/schema"; * @response * @headers * @deprecated Since v6. Use @Returns().ContentType() instead. + * @ignore */ export function ContentType(type: string) { return Returns().ContentType(type); diff --git a/packages/common/src/mvc/decorators/method/returnType.ts b/packages/common/src/mvc/decorators/method/returnType.ts index d9e832ad0ae..ce0a3b3a48d 100644 --- a/packages/common/src/mvc/decorators/method/returnType.ts +++ b/packages/common/src/mvc/decorators/method/returnType.ts @@ -3,6 +3,7 @@ import {Returns as R, ReturnsChainedDecorators} from "@tsed/schema"; /** * @deprecated Since v6. + * @ignore */ export interface ReturnTypeHeader { value?: string | number; @@ -10,6 +11,7 @@ export interface ReturnTypeHeader { /** * @deprecated Since v6. + * @ignore */ export interface ReturnTypeOptions extends Partial { code?: number; diff --git a/packages/common/src/mvc/decorators/required.ts b/packages/common/src/mvc/decorators/required.ts index d938cd0a99c..a1ddbff2172 100644 --- a/packages/common/src/mvc/decorators/required.ts +++ b/packages/common/src/mvc/decorators/required.ts @@ -45,6 +45,7 @@ import {Allow} from "@tsed/schema"; * @schema * @validation * @deprecated Since v6. Use @Allow decorator from @tsed/schema instead of. + * @ignore */ export function Required(...allowedRequiredValues: any[]): any { return Allow(...allowedRequiredValues); diff --git a/packages/common/src/mvc/interfaces/HandlerType.ts b/packages/common/src/mvc/interfaces/HandlerType.ts index 8a9f6957819..36db4e9bb14 100644 --- a/packages/common/src/mvc/interfaces/HandlerType.ts +++ b/packages/common/src/mvc/interfaces/HandlerType.ts @@ -1,3 +1,6 @@ +/** + * @ignore + */ export enum HandlerType { CUSTOM = "custom", ENDPOINT = "endpoint", diff --git a/packages/common/src/mvc/interfaces/IInjectableParamSettings.ts b/packages/common/src/mvc/interfaces/IInjectableParamSettings.ts index 64b1c262224..0c3fc60986c 100644 --- a/packages/common/src/mvc/interfaces/IInjectableParamSettings.ts +++ b/packages/common/src/mvc/interfaces/IInjectableParamSettings.ts @@ -2,7 +2,7 @@ import {Type} from "@tsed/core"; import {IParamOptions} from "./IParamOptions"; /** - * + * @ignore */ export interface IInjectableParamSettings extends IParamOptions { target: Type; diff --git a/packages/common/src/platform-builder/builder/PlatformBuilder.ts b/packages/common/src/platform-builder/builder/PlatformBuilder.ts index a514bec99c1..9afacd08c6f 100644 --- a/packages/common/src/platform-builder/builder/PlatformBuilder.ts +++ b/packages/common/src/platform-builder/builder/PlatformBuilder.ts @@ -27,10 +27,16 @@ import { setLoggerLevel } from "../utils"; +/** + * @ignore + */ export interface PlatformType extends Type { providers: IProvider[]; } +/** + * @ignore + */ export interface PlatformBootstrap { bootstrap(module: Type, settings?: Partial): Promise; } diff --git a/packages/common/src/platform/PlatformModule.ts b/packages/common/src/platform/PlatformModule.ts index cd638785f7a..4b09691e6e5 100644 --- a/packages/common/src/platform/PlatformModule.ts +++ b/packages/common/src/platform/PlatformModule.ts @@ -2,6 +2,9 @@ import {InjectorService, Module} from "@tsed/di"; import {ConverterService} from "../mvc"; import {Platform} from "./services/Platform"; +/** + * @ignore + */ @Module({ imports: [InjectorService, ConverterService, Platform] }) diff --git a/packages/common/src/platform/builder/PlatformControllerBuilder.ts b/packages/common/src/platform/builder/PlatformControllerBuilder.ts index 74f707de785..b21fd211d95 100644 --- a/packages/common/src/platform/builder/PlatformControllerBuilder.ts +++ b/packages/common/src/platform/builder/PlatformControllerBuilder.ts @@ -8,10 +8,16 @@ import {bindEndpointMiddleware} from "../middlewares/bindEndpointMiddleware"; import {PlatformRouter} from "../services/PlatformRouter"; import {useCtxHandler} from "../utils/useCtxHandler"; +/** + * @ignore + */ function formatMethod(method: string | undefined) { return (method === OperationMethods.CUSTOM ? "use" : method || "use").toLowerCase(); } +/** + * @ignore + */ export class PlatformControllerBuilder { constructor(private provider: ControllerProvider) {} diff --git a/packages/common/src/platform/domain/HandlerContext.ts b/packages/common/src/platform/domain/HandlerContext.ts index f278b7593b8..788b6204caf 100644 --- a/packages/common/src/platform/domain/HandlerContext.ts +++ b/packages/common/src/platform/domain/HandlerContext.ts @@ -3,10 +3,16 @@ import {InjectorService} from "@tsed/di"; import {HandlerMetadata} from "../../mvc/models/HandlerMetadata"; import {PlatformContext} from "./PlatformContext"; +/** + * @ignore + */ function isResponse(obj: any) { return obj.data && obj.headers && obj.status && obj.statusText; } +/** + * @ignore + */ export interface HandlerContextOptions { $ctx: PlatformContext; metadata: HandlerMetadata; @@ -14,6 +20,9 @@ export interface HandlerContextOptions { err?: any; } +/** + * @ignore + */ export enum HandlerContextStatus { PENDING = "pending", CANCELED = "canceled", diff --git a/packages/common/src/platform/interfaces/PlatformRouterMethods.ts b/packages/common/src/platform/interfaces/PlatformRouterMethods.ts index 40b8dc9afae..7bf47f17eef 100644 --- a/packages/common/src/platform/interfaces/PlatformRouterMethods.ts +++ b/packages/common/src/platform/interfaces/PlatformRouterMethods.ts @@ -1,5 +1,8 @@ import {PathParamsType} from "../../mvc"; +/** + * @ignore + */ export interface PlatformRouteOptions { method: string; path: PathParamsType; @@ -7,13 +10,20 @@ export interface PlatformRouteOptions { isFinal?: boolean; } +/** + * @ignore + */ export type PlatformRouteWithoutHandlers = Partial>; +/** + * @ignore + */ export interface PlatformRouterMethods { addRoute(routeOptions: PlatformRouteOptions): this; use(...handlers: any[]): this; callback(): any; + getRouter(): T; } diff --git a/packages/common/src/platform/services/PlatformRouter.ts b/packages/common/src/platform/services/PlatformRouter.ts index 15b56d9d418..39f5f87a369 100644 --- a/packages/common/src/platform/services/PlatformRouter.ts +++ b/packages/common/src/platform/services/PlatformRouter.ts @@ -1,5 +1,4 @@ -import {Env} from "@tsed/core"; -import {Constant, Inject, Injectable, InjectorService, ProviderScope} from "@tsed/di"; +import {Inject, Injectable, InjectorService, ProviderScope} from "@tsed/di"; import {promisify} from "util"; import {PlatformMulter, PlatformMulterSettings, PlatformStaticsOptions} from "../../config"; import {PathParamsType} from "../../mvc/interfaces/PathParamsType"; @@ -7,6 +6,9 @@ import {PlatformRouteOptions, PlatformRouteWithoutHandlers} from "../interfaces/ import {createFakeRawDriver} from "./FakeRawDriver"; import {PlatformHandler} from "./PlatformHandler"; +/** + * @ignore + */ export const PLATFORM_ROUTER_OPTIONS = Symbol.for("PlatformRouterOptions"); declare global { diff --git a/packages/common/src/platform/utils/createContext.ts b/packages/common/src/platform/utils/createContext.ts index 815cdf47798..1ac61d06383 100644 --- a/packages/common/src/platform/utils/createContext.ts +++ b/packages/common/src/platform/utils/createContext.ts @@ -11,6 +11,7 @@ const defaultReqIdBuilder = () => uuidv4().replace(/-/gi, ""); * @param injector * @param req * @param res + * @ignore */ export async function createContext(injector: InjectorService, req: any, res: any): Promise { const {level, ignoreUrlPatterns, maxStackSize, reqIdBuilder = defaultReqIdBuilder} = injector.settings.logger; diff --git a/packages/common/src/platform/utils/createHandlerMetadata.ts b/packages/common/src/platform/utils/createHandlerMetadata.ts index 66052812426..145cbcb54f9 100644 --- a/packages/common/src/platform/utils/createHandlerMetadata.ts +++ b/packages/common/src/platform/utils/createHandlerMetadata.ts @@ -8,6 +8,9 @@ function isMetadata(input: any) { return input instanceof HandlerMetadata; } +/** + * @ignore + */ export function createHandlerMetadata( injector: InjectorService, obj: any | EndpointMetadata, diff --git a/packages/common/src/platform/utils/renderView.ts b/packages/common/src/platform/utils/renderView.ts index b81a4b20f05..df13b07d250 100644 --- a/packages/common/src/platform/utils/renderView.ts +++ b/packages/common/src/platform/utils/renderView.ts @@ -1,6 +1,9 @@ import {TemplateRenderError} from "../errors/TemplateRenderError"; import {PlatformContext} from "../domain/PlatformContext"; +/** + * @ignore + */ export async function renderView(data: any, ctx: PlatformContext) { const {response, endpoint} = ctx; try { diff --git a/packages/common/src/platform/utils/setResponseContentType.ts b/packages/common/src/platform/utils/setResponseContentType.ts index bb3aff8af00..c0c5825667b 100644 --- a/packages/common/src/platform/utils/setResponseContentType.ts +++ b/packages/common/src/platform/utils/setResponseContentType.ts @@ -1,6 +1,9 @@ import {PlatformContext} from "../domain/PlatformContext"; import {isObject} from "@tsed/core"; +/** + * @ignore + */ export function setResponseContentType(data: any, ctx: PlatformContext) { const {endpoint, response} = ctx; const {operation} = endpoint; diff --git a/packages/common/src/platform/utils/setResponseHeaders.ts b/packages/common/src/platform/utils/setResponseHeaders.ts index 9eb23466a1b..b4a18fbd330 100644 --- a/packages/common/src/platform/utils/setResponseHeaders.ts +++ b/packages/common/src/platform/utils/setResponseHeaders.ts @@ -9,6 +9,9 @@ function toHeaders(headers: {[key: string]: any}) { }, {}); } +/** + * @ignore + */ export function setResponseHeaders(ctx: PlatformContext) { const {response, endpoint} = ctx; const {operation} = endpoint; diff --git a/packages/common/src/platform/utils/useCtxHandler.ts b/packages/common/src/platform/utils/useCtxHandler.ts index a4260b72a15..e518b8ae3e3 100644 --- a/packages/common/src/platform/utils/useCtxHandler.ts +++ b/packages/common/src/platform/utils/useCtxHandler.ts @@ -6,6 +6,7 @@ export type PlatformCtxHandler = ($ctx: PlatformContext) => any | Promise; /** * Create Ts.ED context handler * @param fn + * @ignore */ export function useCtxHandler(fn: PlatformCtxHandler & {type?: HandlerType}) { fn.type = HandlerType.CTX_FN; diff --git a/packages/core/src/class/Store.ts b/packages/core/src/class/Store.ts index dc64cf5653d..f47c9d7f51e 100644 --- a/packages/core/src/class/Store.ts +++ b/packages/core/src/class/Store.ts @@ -1,12 +1,25 @@ -import {DecoratorParameters} from "../interfaces"; import {deepClone, deepExtends, descriptorOf, getDecoratorType, isSymbol, nameOf} from "../utils"; import {Metadata} from "./Metadata"; +/** + * @ignore + */ export const CLASS_STORE = "tsed:class:store"; +/** + * @ignore + */ export const METHOD_STORE = "tsed:method:store"; +/** + * @ignore + */ export const PROPERTY_STORE = "tsed:property:store"; +/** + * @ignore + */ export const PARAM_STORE = "tsed:param:store"; - +/** + * @ignore + */ export type StoreMap = Map; const stores = new Map(); diff --git a/packages/core/src/utils/cleanObject.ts b/packages/core/src/utils/cleanObject.ts index ab1521effd4..7b1e8f86915 100644 --- a/packages/core/src/utils/cleanObject.ts +++ b/packages/core/src/utils/cleanObject.ts @@ -2,7 +2,6 @@ * Remove undefined value * @param obj */ - export function cleanObject(obj: any): any { return Object.entries(obj).reduce( (obj, [key, value]) => diff --git a/packages/core/src/utils/proxyDelegation.ts b/packages/core/src/utils/proxyDelegation.ts index 97ef585eaac..2e0b0af5770 100644 --- a/packages/core/src/utils/proxyDelegation.ts +++ b/packages/core/src/utils/proxyDelegation.ts @@ -1,8 +1,22 @@ +/** + * @ignore + */ export type ProxyDelegationGetter = (target: T, property: PropertyKey) => any | undefined; +/** + * @ignore + */ export type ProxyDelegationRemove = (target: T, property: PropertyKey) => any; +/** + * @ignore + */ export type ProxyDelegationSetter = (target: T, property: PropertyKey, value: any, receiver: any) => any; +/** + * @ignore + */ export type ProxyDelegationOwnKeys = (target: T) => PropertyKey[]; - +/** + * @ignore + */ export interface ProxyDelegation { handlers?: ProxyHandler; getter?: ProxyDelegationGetter; @@ -15,6 +29,7 @@ export interface ProxyDelegation { * Create a complete and iterable trap. * @param self * @param options + * @ignore */ export function proxyDelegation(self: any, options: ProxyDelegation = {}) { const {handlers = {}, remove, ownKeys} = options; diff --git a/packages/di/src/decorators/module.ts b/packages/di/src/decorators/module.ts index a22dc3775df..53a20297f36 100644 --- a/packages/di/src/decorators/module.ts +++ b/packages/di/src/decorators/module.ts @@ -3,7 +3,7 @@ import {IDIResolver, ProviderScope, ProviderType, TokenProvider} from "../interf import {Configuration} from "./configuration"; import {Injectable} from "./injectable"; -export interface IModuleOptions extends Omit { +export interface ModuleOptions extends Omit { /** * Provider scope */ @@ -38,7 +38,7 @@ export interface IModuleOptions extends Omit { * @param options * @decorator */ -export function Module(options: Partial = {}) { +export function Module(options: Partial = {}) { const {scopes, imports, resolvers, deps, scope, ...configuration} = options; return applyDecorators( diff --git a/packages/graphql/src/GraphQLModule.ts b/packages/graphql/src/GraphQLModule.ts index 2b7f183876c..1cf0291ae2f 100644 --- a/packages/graphql/src/GraphQLModule.ts +++ b/packages/graphql/src/GraphQLModule.ts @@ -2,6 +2,9 @@ import {AfterListen, Configuration, Constant, InjectorService, Module, OnInit} f import {GraphQLSettings} from "./interfaces/GraphQLSettings"; import {GraphQLService} from "./services/GraphQLService"; +/** + * @ignore + */ @Module() export class GraphQLModule implements OnInit, AfterListen { @Constant("graphql", {}) diff --git a/packages/mongoose/src/MongooseModule.ts b/packages/mongoose/src/MongooseModule.ts index 32b246713ed..be1912f4324 100644 --- a/packages/mongoose/src/MongooseModule.ts +++ b/packages/mongoose/src/MongooseModule.ts @@ -3,6 +3,9 @@ import {ValidationErrorMiddleware} from "./middlewares/ValidationErrorMiddleware import {MONGOOSE_CONNECTIONS} from "./services/MongooseConnections"; import {MongooseService} from "./services/MongooseService"; +/** + * @ignore + */ @Module({ imports: [MONGOOSE_CONNECTIONS] }) diff --git a/packages/mongoose/src/decorators/virtualRef.ts b/packages/mongoose/src/decorators/virtualRef.ts index 2b309cd1d93..9f9fec16715 100644 --- a/packages/mongoose/src/decorators/virtualRef.ts +++ b/packages/mongoose/src/decorators/virtualRef.ts @@ -6,8 +6,8 @@ export interface MongooseVirtualRefOptions { /** * @deprecated Since v6. Use ref instead. */ - type?: string | Type; - ref?: string | Type; + type?: string | Type | (() => Type); + ref?: string | Type | (() => Type); foreignField?: string; localField?: string; justOne?: boolean; diff --git a/packages/mongoose/src/interfaces/MongooseVirtualRefOptions.ts b/packages/mongoose/src/interfaces/MongooseVirtualRefOptions.ts deleted file mode 100644 index c09d3c84fce..00000000000 --- a/packages/mongoose/src/interfaces/MongooseVirtualRefOptions.ts +++ /dev/null @@ -1,9 +0,0 @@ -import {Type} from "@tsed/core"; - -export interface MongooseVirtualRefOptions { - type: string | Type | (() => Type); - foreignField: string; - localField?: string; - justOne?: boolean; - options?: object; -} diff --git a/packages/mongoose/src/services/MongooseConnections.ts b/packages/mongoose/src/services/MongooseConnections.ts index bf68af404b0..9cb953b9a6a 100644 --- a/packages/mongoose/src/services/MongooseConnections.ts +++ b/packages/mongoose/src/services/MongooseConnections.ts @@ -3,8 +3,14 @@ import {isArray} from "@tsed/core"; import {MDBConnection} from "../interfaces"; import {MongooseService} from "../services/MongooseService"; +/** + * @ignore + */ // tslint:disable-next-line:variable-name export const MONGOOSE_CONNECTIONS = Symbol.for("MONGOOSE_CONNECTIONS"); +/** + * @ignore + */ export type MONGOOSE_CONNECTIONS = MongooseService; function mapOptions(options: Omit | MDBConnection[]): MDBConnection[] { diff --git a/packages/mongoose/src/utils/cleanProps.ts b/packages/mongoose/src/utils/cleanProps.ts deleted file mode 100644 index 8bfbaeb11b3..00000000000 --- a/packages/mongoose/src/utils/cleanProps.ts +++ /dev/null @@ -1,11 +0,0 @@ -/** - * @ignore - */ -export const cleanProps = (src: any) => - Object.keys(src).reduce((obj: any, k: any) => { - if (src[k] !== undefined) { - obj[k] = src[k]; - } - - return obj; - }, {}); diff --git a/packages/mongoose/src/utils/createSchema.ts b/packages/mongoose/src/utils/createSchema.ts index 0f6073ab4ba..d90a62bd4dd 100644 --- a/packages/mongoose/src/utils/createSchema.ts +++ b/packages/mongoose/src/utils/createSchema.ts @@ -1,10 +1,9 @@ import {PropertyMetadata} from "@tsed/common"; -import {Store, Type} from "@tsed/core"; +import {cleanObject, Store, Type} from "@tsed/core"; import * as mongoose from "mongoose"; import {SchemaDefinition, SchemaTypeOpts} from "mongoose"; import {MONGOOSE_SCHEMA} from "../constants"; import {MongooseSchemaOptions} from "../interfaces"; -import {cleanProps} from "./cleanProps"; import {resolveRefType} from "./resolveRefType"; import {schemaOptions} from "./schemaOptions"; @@ -44,6 +43,11 @@ export function createSchema(target: Type, options: MongooseSchemaOptions = return schema; } +/** + * Get a schema already created. If the schema doesn't exists in registry, it'll be created. + * @param target + * @param options + */ export function getSchema(target: Type, options: MongooseSchemaOptions = {}): mongoose.Schema { const store = Store.from(target); @@ -128,7 +132,7 @@ export function createSchemaTypeOptions(propertyMetadata: PropertyMetadata): Sch schemaTypeOptions = {...schemaTypeOptions, type: getSchema(propertyMetadata.type)}; } - schemaTypeOptions = cleanProps({...schemaTypeOptions, ...rawMongooseSchema}); + schemaTypeOptions = cleanObject({...schemaTypeOptions, ...rawMongooseSchema}); if (propertyMetadata.isCollection) { if (propertyMetadata.isArray) { diff --git a/packages/mongoose/src/utils/resolveRefType.ts b/packages/mongoose/src/utils/resolveRefType.ts index 46243a1c6f0..ea708bba94e 100644 --- a/packages/mongoose/src/utils/resolveRefType.ts +++ b/packages/mongoose/src/utils/resolveRefType.ts @@ -1,6 +1,9 @@ import {isClass, isString, nameOf, Store, Type} from "@tsed/core"; import {MONGOOSE_MODEL_NAME} from "../constants"; +/** + * @ignore + */ export function resolveRefType(type: string | (() => Type) | Type): string { if (isString(type)) { return type; diff --git a/packages/passport/src/PassportModule.ts b/packages/passport/src/PassportModule.ts index a06d9f897c4..be493e00d04 100644 --- a/packages/passport/src/PassportModule.ts +++ b/packages/passport/src/PassportModule.ts @@ -3,6 +3,9 @@ import * as Passport from "passport"; import {PassportSerializerService} from "./services/PassportSerializerService"; import {ProtocolsService} from "./services/ProtocolsService"; +/** + * @ignore + */ @Module({ scope: ProviderScope.SINGLETON }) diff --git a/packages/platform-koa/src/middlewares/resourceNotFoundMiddleware.ts b/packages/platform-koa/src/middlewares/resourceNotFoundMiddleware.ts index f6310f80ba9..3f7d9ff8008 100644 --- a/packages/platform-koa/src/middlewares/resourceNotFoundMiddleware.ts +++ b/packages/platform-koa/src/middlewares/resourceNotFoundMiddleware.ts @@ -1,5 +1,10 @@ import {PlatformContext, PlatformExceptions} from "@tsed/common"; +/** + * @ignore + * @param ctx + * @param next + */ export async function resourceNotFoundMiddleware(ctx: any, next: any) { const $ctx: PlatformContext = ctx.request.$ctx; await next(); diff --git a/packages/platform-koa/src/middlewares/staticsMiddleware.ts b/packages/platform-koa/src/middlewares/staticsMiddleware.ts index 04260f258bb..059e237be00 100644 --- a/packages/platform-koa/src/middlewares/staticsMiddleware.ts +++ b/packages/platform-koa/src/middlewares/staticsMiddleware.ts @@ -2,6 +2,10 @@ import {PlatformStaticsOptions} from "@tsed/common"; import type {Context} from "koa"; import * as send from "koa-send"; +/** + * @ignore + * @param options + */ export function staticsMiddleware(options: PlatformStaticsOptions): any { if (options.index !== false) options.index = options.index || "index.html"; diff --git a/packages/platform-koa/src/utils/multer.ts b/packages/platform-koa/src/utils/multer.ts index c554e7d6124..d2d79e73871 100644 --- a/packages/platform-koa/src/utils/multer.ts +++ b/packages/platform-koa/src/utils/multer.ts @@ -1,6 +1,9 @@ import * as Koa from "koa"; import {promisify} from "util"; +/** + * @ignore + */ function createRawMiddleware(middleware: any) { return async (request: Koa.Request) => { const ctx: any = request.ctx; @@ -27,6 +30,9 @@ function createRawMiddleware(middleware: any) { }; } +/** + * @ignore + */ function makePromise(multer: any, name: string) { // istanbul ignore next if (!multer[name]) return; @@ -40,6 +46,9 @@ function makePromise(multer: any, name: string) { }; } +/** + * @ignore + */ export function getMulter(options: any) { const m = require("multer")(options); diff --git a/packages/schema/src/hooks/ignoreHook.ts b/packages/schema/src/hooks/ignoreHook.ts index 30c5f1ef9e0..f54ac0bce94 100644 --- a/packages/schema/src/hooks/ignoreHook.ts +++ b/packages/schema/src/hooks/ignoreHook.ts @@ -1,5 +1,10 @@ import {Hooks} from "@tsed/core"; +/** + * @ignore + * @param schema + * @param options + */ export function alterIgnore(schema: {$hooks: Hooks}, options: any) { return schema?.$hooks?.alter("ignore", false, [options]); } diff --git a/packages/schema/src/utils/generics.ts b/packages/schema/src/utils/generics.ts index 40ca4cb1556..97ee1ec9ed4 100644 --- a/packages/schema/src/utils/generics.ts +++ b/packages/schema/src/utils/generics.ts @@ -5,24 +5,36 @@ import {Type} from "@tsed/core"; */ export type GenericsMap = Map>; +/** + * @ignore + */ export interface GenericTypes { genericTypes: Type[]; [key: string]: any; } +/** + * @ignore + */ export interface GenericLabels { genericLabels: string[]; [key: string]: any; } +/** + * @ignore + */ export interface NestedGenerics { nestedGenerics: Type[][]; [key: string]: any; } +/** + * @ignore + */ export interface GenericsContext extends GenericTypes, GenericLabels, NestedGenerics { generics: GenericsMap; } diff --git a/packages/schema/src/utils/getComputedType.ts b/packages/schema/src/utils/getComputedType.ts index 554a2a8a9ca..e2b90515ef7 100644 --- a/packages/schema/src/utils/getComputedType.ts +++ b/packages/schema/src/utils/getComputedType.ts @@ -11,6 +11,9 @@ import { Type } from "@tsed/core"; +/** + * @ignore + */ export function getComputedType(target: any): Type { if (isPromise(target)) { return Object; diff --git a/packages/schema/src/utils/getJsonPathParameters.ts b/packages/schema/src/utils/getJsonPathParameters.ts index 335bf3ef801..1b6d484de36 100644 --- a/packages/schema/src/utils/getJsonPathParameters.ts +++ b/packages/schema/src/utils/getJsonPathParameters.ts @@ -1,3 +1,6 @@ +/** + * @ignore + */ function getVariable(subpath: string) { const splited = subpath.split("."); const name = splited.splice(0, 1)[0]; diff --git a/packages/schema/src/utils/getJsonSchema.ts b/packages/schema/src/utils/getJsonSchema.ts index d6b1de857b5..124926f3e68 100644 --- a/packages/schema/src/utils/getJsonSchema.ts +++ b/packages/schema/src/utils/getJsonSchema.ts @@ -4,12 +4,21 @@ import {SpecTypes} from "../domain/SpecTypes"; import {JsonSchemaOptions} from "../interfaces"; import {serializeJsonSchema} from "./serializeJsonSchema"; +/** + * @ignore + */ const CACHE_KEY = "$cache:schemes"; +/** + * @ignore + */ function getKey(options: any) { return JSON.stringify(options); } +/** + * @ignore + */ function get(entity: JsonEntityStore, options: any) { const cache: Map = entity.store.get(CACHE_KEY) || new Map(); const key = getKey(options); diff --git a/packages/schema/src/utils/getJsonType.ts b/packages/schema/src/utils/getJsonType.ts index 627ab74b1b4..6eac4097e26 100644 --- a/packages/schema/src/utils/getJsonType.ts +++ b/packages/schema/src/utils/getJsonType.ts @@ -1,8 +1,7 @@ import {isArrayOrArrayClass, isDate, isPrimitiveOrPrimitiveClass, primitiveOf} from "@tsed/core"; /** - * - * @type {string[]} + * @ignore */ export const JSON_TYPES = ["string", "number", "integer", "boolean", "object", "array", "null", "any"]; diff --git a/packages/schema/src/utils/getSpec.ts b/packages/schema/src/utils/getSpec.ts index 9aa1fd9da56..d606ea49f9b 100644 --- a/packages/schema/src/utils/getSpec.ts +++ b/packages/schema/src/utils/getSpec.ts @@ -42,8 +42,14 @@ export interface OS2SpecSerializerOptions extends SpecSerializerOptions { specType: SpecTypes.SWAGGER; } +/** + * @ignore + */ const caches: Map, Map> = new Map(); +/** + * @ignore + */ function get(model: Type, options: any, cb: any) { if (!caches.has(model)) { caches.set(model, new Map()); diff --git a/packages/schema/src/utils/isSuccessStatus.ts b/packages/schema/src/utils/isSuccessStatus.ts index b30aa1b7e4f..4a76231d6f4 100644 --- a/packages/schema/src/utils/isSuccessStatus.ts +++ b/packages/schema/src/utils/isSuccessStatus.ts @@ -1 +1 @@ -export const isSuccessStatus = (code: string | number | undefined) => !!(Number(code) && 200 <= Number(code) && Number(code) < 300); +export const isSuccessStatus = (code: string | number | undefined) => Number(code) && 200 <= Number(code) && Number(code) < 300; diff --git a/packages/schema/src/utils/serializeJsonSchema.ts b/packages/schema/src/utils/serializeJsonSchema.ts index 4c072a37379..8e70547bd05 100644 --- a/packages/schema/src/utils/serializeJsonSchema.ts +++ b/packages/schema/src/utils/serializeJsonSchema.ts @@ -1,23 +1,35 @@ import {classOf, deepExtends, isArray, isObject} from "@tsed/core"; -import {SpecTypes} from "../domain/SpecTypes"; import {mapAliasedProperties} from "../domain/JsonAliasMap"; import {JsonSchema} from "../domain/JsonSchema"; +import {SpecTypes} from "../domain/SpecTypes"; import {alterIgnore} from "../hooks/ignoreHook"; import {JsonSchemaOptions} from "../interfaces"; import {GenericsContext, mapGenericsOptions, popGenerics} from "./generics"; import {getInheritedStores} from "./getInheritedStores"; import {getJsonEntityStore} from "./getJsonEntityStore"; +/** + * @ignore + */ const IGNORES = ["name", "$required", "$hooks", "_nestedGenerics"]; +/** + * @ignore + */ function isEmptyProperties(key: string, value: any) { return typeof value === "object" && ["items", "properties", "additionalProperties"].includes(key) && Object.keys(value).length === 0; } +/** + * @ignore + */ function shouldMapAlias(key: string, value: any, useAlias: boolean) { return typeof value === "object" && useAlias && ["properties", "additionalProperties"].includes(key); } +/** + * @ignore + */ function getRequired(schema: any, useAlias: boolean) { return Array.from(schema.$required).map((key) => (useAlias ? (schema.alias.get(key) as string) || key : key)); } diff --git a/packages/socketio/src/SocketIOModule.ts b/packages/socketio/src/SocketIOModule.ts index 5d82c2fa027..28d7e9e8a33 100644 --- a/packages/socketio/src/SocketIOModule.ts +++ b/packages/socketio/src/SocketIOModule.ts @@ -6,6 +6,9 @@ import {ISocketProviderMetadata} from "./interfaces/ISocketProviderMetadata"; import {PROVIDER_TYPE_SOCKET_SERVICE} from "./registries/SocketServiceRegistry"; import {SocketIOService} from "./services/SocketIOService"; +/** + * @ignore + */ @Module() export class SocketIOModule implements AfterListen { @Constant("logger.disableRoutesSummary", false) diff --git a/packages/socketio/src/class/SocketHandlersBuilder.ts b/packages/socketio/src/class/SocketHandlersBuilder.ts index 2439e462fd9..008c94e8258 100644 --- a/packages/socketio/src/class/SocketHandlersBuilder.ts +++ b/packages/socketio/src/class/SocketHandlersBuilder.ts @@ -11,7 +11,7 @@ import {SocketReturnsTypes} from "../interfaces/SocketReturnsTypes"; import {getNspSession} from "../registries/NspSessionRegistry"; /** - * @experimental + * @ignore */ export class SocketHandlersBuilder { private socketProviderMetadata: ISocketProviderMetadata; diff --git a/packages/socketio/src/interfaces/SocketFilters.ts b/packages/socketio/src/interfaces/SocketFilters.ts index 9a96557580e..48fe29ccc13 100644 --- a/packages/socketio/src/interfaces/SocketFilters.ts +++ b/packages/socketio/src/interfaces/SocketFilters.ts @@ -1,5 +1,5 @@ /** - * + * @ignore */ export enum SocketFilters { ARGS = "args", diff --git a/packages/socketio/src/interfaces/SocketReturnsTypes.ts b/packages/socketio/src/interfaces/SocketReturnsTypes.ts index 661f32bb152..41927bec043 100644 --- a/packages/socketio/src/interfaces/SocketReturnsTypes.ts +++ b/packages/socketio/src/interfaces/SocketReturnsTypes.ts @@ -1,5 +1,5 @@ /** - * + * @ignore */ export enum SocketReturnsTypes { BROADCAST = "broadcast", diff --git a/packages/swagger/src/SwaggerModule.ts b/packages/swagger/src/SwaggerModule.ts index 2570ecd141f..e07775f01f8 100644 --- a/packages/swagger/src/SwaggerModule.ts +++ b/packages/swagger/src/SwaggerModule.ts @@ -21,6 +21,9 @@ import {SwaggerService} from "./services/SwaggerService"; const swaggerUiPath = require("swagger-ui-dist").absolutePath(); +/** + * @ignore + */ @Module() export class SwaggerModule implements BeforeRoutesInit, OnReady { @Inject() diff --git a/packages/swagger/src/middlewares/cssMiddleware.ts b/packages/swagger/src/middlewares/cssMiddleware.ts index 8e9349342d2..5e24609c11f 100644 --- a/packages/swagger/src/middlewares/cssMiddleware.ts +++ b/packages/swagger/src/middlewares/cssMiddleware.ts @@ -2,6 +2,10 @@ import {PlatformContext} from "@tsed/common"; import * as Fs from "fs"; import {resolve} from "path"; +/** + * @ignore + * @param path + */ export function cssMiddleware(path: string) { return (ctx: PlatformContext) => { const content = Fs.readFileSync(resolve(path), {encoding: "utf8"}); diff --git a/packages/swagger/src/middlewares/indexMiddleware.ts b/packages/swagger/src/middlewares/indexMiddleware.ts index bab2dbc16da..68653151835 100644 --- a/packages/swagger/src/middlewares/indexMiddleware.ts +++ b/packages/swagger/src/middlewares/indexMiddleware.ts @@ -1,6 +1,11 @@ import {PlatformContext} from "@tsed/common"; import {SwaggerSettings} from "../interfaces/SwaggerSettings"; +/** + * @ignore + * @param viewPath + * @param conf + */ export function indexMiddleware(viewPath: string, conf: SwaggerSettings & {urls: string[]}) { return async (ctx: PlatformContext) => { const {path = "/", options = {}, showExplorer, cssPath, jsPath, urls} = conf; diff --git a/packages/swagger/src/middlewares/jsMiddleware.ts b/packages/swagger/src/middlewares/jsMiddleware.ts index dc9def9c502..b936b65819c 100644 --- a/packages/swagger/src/middlewares/jsMiddleware.ts +++ b/packages/swagger/src/middlewares/jsMiddleware.ts @@ -2,6 +2,10 @@ import {PlatformContext} from "@tsed/common"; import * as Fs from "fs"; import {resolve} from "path"; +/** + * @ignore + * @param path + */ export function jsMiddleware(path: string) { return (ctx: PlatformContext) => { const content = Fs.readFileSync(resolve(path), {encoding: "utf8"}); diff --git a/packages/swagger/src/middlewares/redirectMiddleware.ts b/packages/swagger/src/middlewares/redirectMiddleware.ts index 822ee5ba63c..6f083dba077 100644 --- a/packages/swagger/src/middlewares/redirectMiddleware.ts +++ b/packages/swagger/src/middlewares/redirectMiddleware.ts @@ -1,5 +1,9 @@ import {PlatformContext} from "@tsed/common"; +/** + * @ignore + * @param path + */ export function redirectMiddleware(path: string) { return (ctx: PlatformContext) => { if (ctx.request.url === path && !ctx.request.url.match(/\/$/)) { diff --git a/packages/swagger/src/utils/getSpecType.ts b/packages/swagger/src/utils/getSpecType.ts index 0678ded3696..97fbbedc834 100644 --- a/packages/swagger/src/utils/getSpecType.ts +++ b/packages/swagger/src/utils/getSpecType.ts @@ -1,10 +1,18 @@ import {OpenSpec2, OpenSpec3} from "@tsed/openspec"; import {SpecTypes} from "@tsed/schema"; +/** + * @ignore + * @param version + */ export function getSpecType(version: string) { return version.startsWith("3.") ? SpecTypes.OPENAPI : SpecTypes.SWAGGER; } +/** + * @ignore + * @param spec + */ export function getSpecTypeFromSpec(spec: Partial) { return "openapi" in spec ? SpecTypes.OPENAPI : SpecTypes.SWAGGER; } diff --git a/packages/swagger/src/utils/mapOpenSpec.ts b/packages/swagger/src/utils/mapOpenSpec.ts index cf72d226c2c..1338a605962 100644 --- a/packages/swagger/src/utils/mapOpenSpec.ts +++ b/packages/swagger/src/utils/mapOpenSpec.ts @@ -5,6 +5,14 @@ import {getSpecType} from "./getSpecType"; import {mapOpenSpec2} from "./mapOpenSpec2"; import {mapOpenSpec3} from "./mapOpenSpec3"; +/** + * @ignore + * @param spec + * @param fileSpec + * @param version + * @param acceptMimes + * @param specVersion + */ export function mapOpenSpec(spec: any, {fileSpec, version, acceptMimes, specVersion}: any): Partial { specVersion = specVersion || getValue(spec, "openapi", getValue(spec, "swagger", "2.0")); diff --git a/packages/swagger/src/utils/mapOpenSpec2.ts b/packages/swagger/src/utils/mapOpenSpec2.ts index 604ab53fc25..b170970fcf7 100644 --- a/packages/swagger/src/utils/mapOpenSpec2.ts +++ b/packages/swagger/src/utils/mapOpenSpec2.ts @@ -2,6 +2,13 @@ import {getValue, uniq} from "@tsed/core"; import {OpenSpec2} from "@tsed/openspec"; import {mapOpenSpecInfo} from "./mapOpenSpecInfo"; +/** + * @ignore + * @param spec + * @param version + * @param specVersion + * @param acceptMimes + */ export function mapOpenSpec2( spec: Partial, {version, specVersion, acceptMimes = ["application/json"]}: any diff --git a/packages/swagger/src/utils/mapOpenSpec3.ts b/packages/swagger/src/utils/mapOpenSpec3.ts index e91491d4395..359f152ac8f 100644 --- a/packages/swagger/src/utils/mapOpenSpec3.ts +++ b/packages/swagger/src/utils/mapOpenSpec3.ts @@ -2,6 +2,12 @@ import {getValue} from "@tsed/core"; import {OpenSpec3} from "@tsed/openspec"; import {mapOpenSpecInfo} from "./mapOpenSpecInfo"; +/** + * @ignore + * @param spec + * @param version + * @param specVersion + */ export function mapOpenSpec3(spec: any, {version, specVersion}: any): Partial { const {servers, paths, components, security, tags, externalDocs} = spec; diff --git a/packages/swagger/src/utils/mapOpenSpecInfo.ts b/packages/swagger/src/utils/mapOpenSpecInfo.ts index 10e6dfefcea..e6ad7e9c993 100644 --- a/packages/swagger/src/utils/mapOpenSpecInfo.ts +++ b/packages/swagger/src/utils/mapOpenSpecInfo.ts @@ -1,5 +1,10 @@ import {OpenSpecInfo} from "@tsed/openspec"; +/** + * @ignore + * @param info + * @param defaultVersion + */ export function mapOpenSpecInfo(info: Partial, defaultVersion: string): OpenSpecInfo { const {title = "Api documentation", description = "", version: versionInfo, termsOfService = "", contact, license} = info; diff --git a/packages/typeorm/src/utils/createConnection.spec.ts b/packages/typeorm/src/utils/createConnection.spec.ts deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/packages/typeorm/src/utils/createConnection.ts b/packages/typeorm/src/utils/createConnection.ts index 9a636cc3195..1a71ffee5d0 100644 --- a/packages/typeorm/src/utils/createConnection.ts +++ b/packages/typeorm/src/utils/createConnection.ts @@ -2,9 +2,6 @@ import {ConnectionOptions, getConnectionManager} from "typeorm"; const connections = new Map(); -/** - * @ignore - */ export async function createConnection(connectionOptions: ConnectionOptions) { const connectionManager = getConnectionManager(); const name = connectionOptions.name!; diff --git a/tsdoc.config.js b/tsdoc.config.js index b5986f7f41b..9efb6e41036 100644 --- a/tsdoc.config.js +++ b/tsdoc.config.js @@ -4,27 +4,18 @@ module.exports = { scanPatterns: [ "/packages/**/lib/**/*.d.ts", "!/packages/**/lib/**/data/*.ts", - "!**/ProxyMap.ts", - "!**/ProxyRegistry.ts", - "!**/Storable.ts", + "!**/*.spec.ts", "!**/mvc/utils/**", "!**/mvc/constants/**", - "!**/converters/constants/**", - "!**/converters/decorators/**", - "!**/converters/components/**", - "!**/converters/errors/**", - "!**/converters/registries/**", "!**/jsonschema/**", - "!/packages/packages/seq", - "!/packages/packages/test-artillery", - "!/packages/packages/servestatic", - "!/packages/packages/testing", - "!/packages/integration", - "!/packages/integration-express", + "!/packages/*/src", + "!/packages/**/constants", + "!/packages/**/registries", + "!/packages/**/platform/utils", + "!/packages/**/platform-builder/utils", + "!/packages/seq", + "!/packages/testing", "!/packages/platform-test-utils", - "!/packages/swagger/lib/class", - "!/packages/swagger/lib/utils", - "!/packages/swagger/lib/decorators/{baseParameter,consumes,deprecated,description,example,name,produces,responses,returns,returnsArray,security,summary,operation,title}.ts", "!**/node_modules" ], outputDir: "/docs/api", @@ -32,18 +23,18 @@ module.exports = { jsonOutputDir: "/docs/.vuepress/public", scope: "@tsed", modules: { - "core": "core", - "di": "di", - "common": "common", - "exceptions": "exceptions", - "ajv": "ajv", - "mongoose": "mongoose", - "multipartfiles": "multipartfiles", - "passport": "passport", - "servestatic": "servestatic", - "socketio": "socketio", - "swagger": "swagger", - "typeorm": "typeorm", - "testing": "testing" + core: "core", + di: "di", + common: "common", + exceptions: "exceptions", + ajv: "ajv", + mongoose: "mongoose", + multipartfiles: "multipartfiles", + passport: "passport", + servestatic: "servestatic", + socketio: "socketio", + swagger: "swagger", + typeorm: "typeorm", + testing: "testing" } };