chore: Fix documentation. Limit amount of exported symbols

tsedio · Oct 11, 2020 · 8eac2de · 8eac2de
1 parent f3ad933
commit 8eac2de
Show file tree

Hide file tree

Showing 60 changed files with 272 additions and 75 deletions.
diff --git 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
@@ -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
@@ -3,13 +3,15 @@ import {Returns as R, ReturnsChainedDecorators} from "@tsed/schema";
 
 /**
  * @deprecated Since v6.
+ * @ignore
  */
 export interface ReturnTypeHeader {
   value?: string | number;
 }
 
 /**
  * @deprecated Since v6.
+ * @ignore
  */
 export interface ReturnTypeOptions extends Partial<MetadataTypes> {
   code?: number;

diff --git 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
@@ -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
@@ -2,7 +2,7 @@ import {Type} from "@tsed/core";
 import {IParamOptions} from "./IParamOptions";
 
 /**
- *
+ * @ignore
  */
 export interface IInjectableParamSettings<T> extends IParamOptions<T> {
   target: Type<T>;

diff --git 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<T = any> extends Type<T> {
   providers: IProvider[];
 }
 
+/**
+ * @ignore
+ */
 export interface PlatformBootstrap {
   bootstrap(module: Type<any>, settings?: Partial<TsED.Configuration>): Promise<PlatformBuilder>;
 }

diff --git 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
@@ -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
@@ -3,17 +3,26 @@ 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;
   args: any[];
   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
@@ -1,19 +1,29 @@
 import {PathParamsType} from "../../mvc";
 
+/**
+ * @ignore
+ */
 export interface PlatformRouteOptions {
   method: string;
   path: PathParamsType;
   handlers: any[];
   isFinal?: boolean;
 }
 
+/**
+ * @ignore
+ */
 export type PlatformRouteWithoutHandlers = Partial<Omit<PlatformRouteOptions, "handlers">>;
 
+/**
+ * @ignore
+ */
 export interface PlatformRouterMethods<T = any> {
   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
@@ -1,12 +1,14 @@
-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";
 import {PlatformRouteOptions, PlatformRouteWithoutHandlers} from "../interfaces/PlatformRouterMethods";
 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
@@ -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<PlatformContext> {
   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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -6,6 +6,7 @@ export type PlatformCtxHandler = ($ctx: PlatformContext) => any | Promise<any>;
 /**
  * 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
@@ -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<string, any>;
 
 const stores = new Map<symbol, any>();

diff --git 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
@@ -1,8 +1,22 @@
+/**
+ * @ignore
+ */
 export type ProxyDelegationGetter<T = any> = (target: T, property: PropertyKey) => any | undefined;
+/**
+ * @ignore
+ */
 export type ProxyDelegationRemove<T = any> = (target: T, property: PropertyKey) => any;
+/**
+ * @ignore
+ */
 export type ProxyDelegationSetter<T = any> = (target: T, property: PropertyKey, value: any, receiver: any) => any;
+/**
+ * @ignore
+ */
 export type ProxyDelegationOwnKeys<T = any> = (target: T) => PropertyKey[];
-
+/**
+ * @ignore
+ */
 export interface ProxyDelegation<T extends object> {
   handlers?: ProxyHandler<T>;
   getter?: ProxyDelegationGetter<T>;
@@ -15,6 +29,7 @@ export interface ProxyDelegation<T extends object> {
  * Create a complete and iterable trap.
  * @param self
  * @param options
+ * @ignore
  */
 export function proxyDelegation<T extends object = any>(self: any, options: ProxyDelegation<T> = {}) {
   const {handlers = {}, remove, ownKeys} = options;

diff --git 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<TsED.Configuration, "scopes"> {
+export interface ModuleOptions extends Omit<TsED.Configuration, "scopes"> {
   /**
    * Provider scope
    */
@@ -38,7 +38,7 @@ export interface IModuleOptions extends Omit<TsED.Configuration, "scopes"> {
  * @param options
  * @decorator
  */
-export function Module(options: Partial<IModuleOptions> = {}) {
+export function Module(options: Partial<ModuleOptions> = {}) {
   const {scopes, imports, resolvers, deps, scope, ...configuration} = options;
 
   return applyDecorators(

diff --git 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
@@ -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
@@ -6,8 +6,8 @@ export interface MongooseVirtualRefOptions {
   /**
    * @deprecated Since v6. Use ref instead.
    */
-  type?: string | Type<any>;
-  ref?: string | Type<any>;
+  type?: string | Type<any> | (() => Type<any>);
+  ref?: string | Type<any> | (() => Type<any>);
   foreignField?: string;
   localField?: string;
   justOne?: boolean;

diff --git a/packages/mongoose/src/interfaces/MongooseVirtualRefOptions.ts b/packages/mongoose/src/interfaces/MongooseVirtualRefOptions.ts
diff --git 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, "id"> | MDBConnection[]): MDBConnection[] {

diff --git a/packages/mongoose/src/utils/cleanProps.ts b/packages/mongoose/src/utils/cleanProps.ts