From b015e10743a364c6ba560848a1a6a93a5afca2b7 Mon Sep 17 00:00:00 2001 From: Marshall Sorenson Date: Wed, 3 Jul 2024 19:19:52 -0400 Subject: [PATCH 1/2] feat: add jsdoc lint --- .eslintrc.js | 10 ++ package.json | 1 + .../access-control-create-many.decorator.ts | 3 +- .../access-control-create-one.decorator.ts | 3 +- .../access-control-delete-one.decorator.ts | 5 +- .../access-control-grant.decorator.ts | 1 - .../access-control-query.decorator.ts | 1 - .../access-control-read-many.decorator.ts | 3 +- .../access-control-read-one.decorator.ts | 3 +- .../access-control-recover-one.decorator.ts | 3 +- .../access-control-replace-one.decorator.ts | 5 +- .../access-control-update-one.decorator.ts | 5 +- .../nestjs-auth-jwt/src/auth-jwt.strategy.ts | 1 - .../src/auth-local.strategy.ts | 5 +- .../src/services/auth-recovery.service.ts | 5 - .../src/auth-refresh.strategy.ts | 1 - .../src/services/issue-token.service.ts | 3 +- .../src/services/verify-token.service.ts | 1 - .../src/controllers/cache-crud.controller.ts | 10 +- .../src/services/cache-crud.service.ts | 1 - .../src/services/cache.service.ts | 6 - .../photo/photo.controller.fixture.ts | 10 -- .../crud-init-api-query.decorator.ts | 1 - .../routes/crud-validate.decorator.ts | 1 - packages/nestjs-event/src/events/event.ts | 6 - .../src/listeners/event-listener-on.ts | 2 - .../src/listeners/event-listener.ts | 1 - .../interfaces/event-listener.interface.ts | 2 - .../src/services/event-dispatch.service.ts | 53 ++++----- .../src/services/event-listen.service.ts | 22 ++-- .../src/utils/map-http-status.util.ts | 1 - .../src/services/federated-mutate.service.ts | 1 - .../src/services/federated-oauth.service.ts | 4 - .../services/invitation-acceptance.service.ts | 3 - .../services/invitation-revocation.service.ts | 3 - .../src/services/invitation.service.ts | 1 - .../nestjs-logger/src/config/logger.config.ts | 1 - .../interfaces/logger-service.interface.ts | 7 -- .../interfaces/logger-transport.interface.ts | 1 - .../src/logger-exception.filter.ts | 2 - .../src/logger-request.interceptor.ts | 5 - .../src/logger-transport.service.ts | 3 - packages/nestjs-logger/src/logger.service.ts | 8 -- .../src/transports/logger-sentry.transport.ts | 2 - .../src/utils/config-parser.util.ts | 1 - .../src/utils/message-format.util.ts | 5 - packages/nestjs-org/src/org.controller.ts | 8 -- .../src/services/org-crud.service.ts | 1 - .../src/services/org-lookup.service.ts | 2 - .../src/services/org-mutate.service.ts | 1 - .../nestjs-otp/src/services/otp.service.ts | 7 -- .../password-creation-service.interface.ts | 4 - .../password-storage-service.interface.ts | 2 - .../password-strength-service.interface.ts | 1 - .../password-validation-service.interface.ts | 2 - .../src/services/password-creation.service.ts | 4 - .../src/services/password-storage.service.ts | 4 - .../src/services/password-strength.service.ts | 1 - .../nestjs-password/src/utils/crypt.util.ts | 4 +- .../src/interfaces/role-service.interface.ts | 3 - .../src/role-assignment.controller.ts | 8 +- packages/nestjs-role/src/role.controller.ts | 7 -- .../services/role-assignment-crud.service.ts | 1 - .../src/services/role-crud.service.ts | 1 - .../src/services/role-lookup.service.ts | 1 - .../src/services/role-mutate.service.ts | 1 - .../nestjs-role/src/services/role.service.ts | 4 - .../src/swagger-ui.service.ts | 2 - .../create-dynamic-repository-provider.ts | 1 - .../create-entity-repository-provider.ts | 1 - .../user-password-service.interface.ts | 2 - .../src/services/user-crud.service.ts | 1 - .../src/services/user-lookup.service.ts | 4 - .../src/services/user-mutate.service.ts | 1 - .../src/services/user-password.service.ts | 1 - packages/nestjs-user/src/user.controller.ts | 8 -- packages/nestjs-user/src/user.seeder.ts | 1 - .../cache/interfaces/cache-clear.interface.ts | 1 - .../interfaces/cache-create.interface.ts | 1 - .../src/otp/interfaces/otp-clear.interface.ts | 1 - .../otp/interfaces/otp-create.interface.ts | 1 - .../otp/interfaces/otp-delete.interface.ts | 1 - .../otp/interfaces/otp-validate.interface.ts | 1 - .../interfaces/reference-id.interface.ts | 1 - .../src/services/base.service.ts | 4 - .../src/services/lookup.service.ts | 2 - .../src/services/mutate.service.ts | 5 - .../src/utils/safe-transaction.util.ts | 1 - yarn.lock | 112 +++++++++++++++++- 89 files changed, 174 insertions(+), 268 deletions(-) diff --git a/.eslintrc.js b/.eslintrc.js index ffe9866a8..a17f5c622 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -11,6 +11,7 @@ module.exports = { ], extends: [ '@concepta/eslint-config/nest', + 'plugin:jsdoc/recommended-typescript', ], ignorePatterns: [ 'packages/*/dist/**', @@ -40,11 +41,20 @@ module.exports = { jsonSyntax: 'JSON', }, }, + { + files: ['*.ts'], + rules: { + 'jsdoc/require-jsdoc': 'off', + 'jsdoc/require-param': 'off', + 'jsdoc/require-returns': 'off', + }, + }, { files: ['*.spec.ts', '*.fixture.ts'], rules: { '@darraghor/nestjs-typed/controllers-should-supply-api-tags': 'off', '@darraghor/nestjs-typed/api-method-should-specify-api-response': 'off', + 'plugin:jsdoc/recommended-typescript': 'off', 'tsdoc/syntax': 'off', }, }, diff --git a/package.json b/package.json index b872b35cf..ff6cf46c7 100644 --- a/package.json +++ b/package.json @@ -29,6 +29,7 @@ "eslint": "^8.6.0", "eslint-config-prettier": "^8.3.0", "eslint-plugin-import": "^2.25.4", + "eslint-plugin-jsdoc": "^48.5.0", "eslint-plugin-node": "^11.1.0", "eslint-plugin-prettier": "^4.0.0", "eslint-plugin-tsdoc": "^0.3.0", diff --git a/packages/nestjs-access-control/src/decorators/access-control-create-many.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-create-many.decorator.ts index f14f1f8fb..f65bfb0c2 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-create-many.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-create-many.decorator.ts @@ -2,8 +2,7 @@ import { AccessControlCreateOne } from './access-control-create-one.decorator'; /** * Create many resource grant shortcut. - * - * @param string - resource The grant resource. + * @param resource - The grant resource. */ export const AccessControlCreateMany = (resource: string) => AccessControlCreateOne(resource); diff --git a/packages/nestjs-access-control/src/decorators/access-control-create-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-create-one.decorator.ts index 8ff6545bc..520cfe959 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-create-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-create-one.decorator.ts @@ -4,8 +4,7 @@ import { applyDecorators } from '@nestjs/common'; /** * Create one resource grant shortcut. - * - * @param string - resource The grant resource. + * @param resource - The grant resource. * @returns Decorator function */ export const AccessControlCreateOne = ( diff --git a/packages/nestjs-access-control/src/decorators/access-control-delete-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-delete-one.decorator.ts index 4d48c7116..aeaeccbc1 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-delete-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-delete-one.decorator.ts @@ -3,9 +3,8 @@ import { applyDecorators } from '@nestjs/common'; import { ActionEnum } from '../enums/action.enum'; /** - * Delete one resource grant shortcut - * - * @param string - resource The grant resource. + * Delete one resource grant shortcut. + * @param resource - The grant resource. * @returns Decorator function */ export const AccessControlDeleteOne = ( diff --git a/packages/nestjs-access-control/src/decorators/access-control-grant.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-grant.decorator.ts index 922a171e5..4503d9699 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-grant.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-grant.decorator.ts @@ -4,7 +4,6 @@ import { ACCESS_CONTROL_MODULE_GRANT_METADATA } from '../constants'; /** * Define access control grants required for this route. - * * @param acGrants - Array of access control grants. * @returns Decorator function. */ diff --git a/packages/nestjs-access-control/src/decorators/access-control-query.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-query.decorator.ts index 25b2a4572..1ba8cae0f 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-query.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-query.decorator.ts @@ -4,7 +4,6 @@ import { ACCESS_CONTROL_MODULE_QUERY_METADATA } from '../constants'; /** * Define access query options for this route. - * * @param queryOptions - Array of access control query options. * @returns Decorator function. */ diff --git a/packages/nestjs-access-control/src/decorators/access-control-read-many.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-read-many.decorator.ts index 239d7f79a..7030bab49 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-read-many.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-read-many.decorator.ts @@ -4,8 +4,7 @@ import { AccessControlGrant } from './access-control-grant.decorator'; /** * Read many resource grant shortcut. - * - * @param string - resource The grant resource. + * @param resource - The grant resource. * @returns Decorator function */ export const AccessControlReadMany = ( diff --git a/packages/nestjs-access-control/src/decorators/access-control-read-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-read-one.decorator.ts index 3ef237850..bbea7067e 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-read-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-read-one.decorator.ts @@ -4,8 +4,7 @@ import { AccessControlGrant } from './access-control-grant.decorator'; /** * Read one resource grant shortcut - * - * @param string - resource The grant resource. + * @param resource - The grant resource. * @returns Decorator function */ export const AccessControlReadOne = ( diff --git a/packages/nestjs-access-control/src/decorators/access-control-recover-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-recover-one.decorator.ts index 64a000419..874965546 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-recover-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-recover-one.decorator.ts @@ -2,8 +2,7 @@ import { AccessControlCreateOne } from './access-control-create-one.decorator'; /** * Recover one resource grant shortcut. - * - * @param string - resource The grant resource. + * @param resource - The grant resource. */ export const AccessControlRecoverOne = (resource: string) => AccessControlCreateOne(resource); diff --git a/packages/nestjs-access-control/src/decorators/access-control-replace-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-replace-one.decorator.ts index 690cd0511..232feadc9 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-replace-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-replace-one.decorator.ts @@ -1,9 +1,8 @@ import { AccessControlUpdateOne } from './access-control-update-one.decorator'; /** - * Update one resource grant shortcut - * - * @param string - resource The grant resource. + * Update one resource grant shortcut. + * @param resource - The grant resource. */ export const AccessControlReplaceOne = (resource: string) => AccessControlUpdateOne(resource); diff --git a/packages/nestjs-access-control/src/decorators/access-control-update-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-update-one.decorator.ts index 4f06cc66a..ac65234f0 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-update-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-update-one.decorator.ts @@ -3,9 +3,8 @@ import { ActionEnum } from '../enums/action.enum'; import { AccessControlGrant } from './access-control-grant.decorator'; /** - * Update one resource grant shortcut - * - * @param string - resource The grant resource. + * Update one resource grant shortcut. + * @param resource - The grant resource. * @returns Decorator function */ export const AccessControlUpdateOne = ( diff --git a/packages/nestjs-auth-jwt/src/auth-jwt.strategy.ts b/packages/nestjs-auth-jwt/src/auth-jwt.strategy.ts index 2c73f2799..c54cbabd1 100644 --- a/packages/nestjs-auth-jwt/src/auth-jwt.strategy.ts +++ b/packages/nestjs-auth-jwt/src/auth-jwt.strategy.ts @@ -45,7 +45,6 @@ export class AuthJwtStrategy extends PassportStrategyFactory( /** * Validate the user based on payload sub - * * @param payload - The payload to validate */ async validate( diff --git a/packages/nestjs-auth-local/src/auth-local.strategy.ts b/packages/nestjs-auth-local/src/auth-local.strategy.ts index 2b5575f89..20a8b0a0d 100644 --- a/packages/nestjs-auth-local/src/auth-local.strategy.ts +++ b/packages/nestjs-auth-local/src/auth-local.strategy.ts @@ -30,10 +30,8 @@ export class AuthLocalStrategy extends PassportStrategyFactory( AUTH_LOCAL_STRATEGY_NAME, ) { /** - * - * @param userLookupService - The service used to get the user * @param settings - The settings for the local strategy - * @param passwordStorageService - The service used to hash and validate passwords + * @param validateUserService - The service used validate passwords */ constructor( @Inject(AUTH_LOCAL_MODULE_SETTINGS_TOKEN) @@ -50,7 +48,6 @@ export class AuthLocalStrategy extends PassportStrategyFactory( /** * Validate the user based on the username and password * from the request body - * * @param username - The username to authenticate * @param password - The plain text password */ diff --git a/packages/nestjs-auth-recovery/src/services/auth-recovery.service.ts b/packages/nestjs-auth-recovery/src/services/auth-recovery.service.ts index 3382a7a44..601f06cfd 100644 --- a/packages/nestjs-auth-recovery/src/services/auth-recovery.service.ts +++ b/packages/nestjs-auth-recovery/src/services/auth-recovery.service.ts @@ -40,7 +40,6 @@ export class AuthRecoveryService implements AuthRecoveryServiceInterface { /** * Recover lost username providing an email and send the username by email. - * * @param email - user email */ async recoverLogin( @@ -65,7 +64,6 @@ export class AuthRecoveryService implements AuthRecoveryServiceInterface { /** * Recover lost password providing an email and send the passcode token by email. - * * @param email - user email */ async recoverPassword( @@ -107,7 +105,6 @@ export class AuthRecoveryService implements AuthRecoveryServiceInterface { /** * Validate passcode and return it's user. - * * @param passcode - user's passcode * @param deleteIfValid - flag to delete if valid or not */ @@ -130,7 +127,6 @@ export class AuthRecoveryService implements AuthRecoveryServiceInterface { /** * Change user's password by providing it's OTP passcode and the new password. - * * @param passcode - OTP user's passcode * @param newPassword - new user password */ @@ -184,7 +180,6 @@ export class AuthRecoveryService implements AuthRecoveryServiceInterface { /** * Recover lost password providing an email and send the passcode token by email. - * * @param email - user email */ async revokeAllUserPasswordRecoveries( diff --git a/packages/nestjs-auth-refresh/src/auth-refresh.strategy.ts b/packages/nestjs-auth-refresh/src/auth-refresh.strategy.ts index b28205cdd..e409f2646 100644 --- a/packages/nestjs-auth-refresh/src/auth-refresh.strategy.ts +++ b/packages/nestjs-auth-refresh/src/auth-refresh.strategy.ts @@ -43,7 +43,6 @@ export class AuthRefreshStrategy extends PassportStrategyFactory( /** * Validate the user sub from the verified token - * * @param payload - Authorization payload */ async validate( diff --git a/packages/nestjs-authentication/src/services/issue-token.service.ts b/packages/nestjs-authentication/src/services/issue-token.service.ts index e07bc8b5a..b00a995e1 100644 --- a/packages/nestjs-authentication/src/services/issue-token.service.ts +++ b/packages/nestjs-authentication/src/services/issue-token.service.ts @@ -25,8 +25,7 @@ export class IssueTokenService implements IssueTokenServiceInterface { /** * Generate the response payload. - * - * @param identifier - user id or name for `sub` claim + * @param id - user id or name for `sub` claim */ async responsePayload( id: ReferenceId, diff --git a/packages/nestjs-authentication/src/services/verify-token.service.ts b/packages/nestjs-authentication/src/services/verify-token.service.ts index 20c17d29f..b60b0f324 100644 --- a/packages/nestjs-authentication/src/services/verify-token.service.ts +++ b/packages/nestjs-authentication/src/services/verify-token.service.ts @@ -56,7 +56,6 @@ export class VerifyTokenService implements VerifyTokenServiceInterface { * Further validate the authenticity of a token. * * For example, You may want to check if it's id exists in a database or some other source. - * * @param payload - Payload object */ private async validateToken( diff --git a/packages/nestjs-cache/src/controllers/cache-crud.controller.ts b/packages/nestjs-cache/src/controllers/cache-crud.controller.ts index 5827a9263..fff2ce64d 100644 --- a/packages/nestjs-cache/src/controllers/cache-crud.controller.ts +++ b/packages/nestjs-cache/src/controllers/cache-crud.controller.ts @@ -69,8 +69,9 @@ export class CacheCrudController { /** * Constructor. - * + * @param settings - cache settings * @param allCrudServices - instances of all crud services + * @param cacheService - instance of cache service */ constructor( @Inject(CACHE_MODULE_SETTINGS_TOKEN) @@ -82,7 +83,6 @@ export class CacheCrudController /** * Get many - * * @param crudRequest - the CRUD request object * @param assignment - the assignment */ @@ -97,7 +97,6 @@ export class CacheCrudController /** * Get one - * * @param crudRequest - the CRUD request object * @param assignment - The cache assignment */ @@ -112,7 +111,6 @@ export class CacheCrudController /** * Create one - * * @param crudRequest - the CRUD request object * @param cacheCreateDto - cache create dto * @param assignment - The cache assignment @@ -161,7 +159,6 @@ export class CacheCrudController /** * Create one - * * @param crudRequest - the CRUD request object * @param cacheUpdateDto - cache create dto * @param assignment - The cache assignment @@ -186,7 +183,6 @@ export class CacheCrudController /** * Delete one - * * @param crudRequest - the CRUD request object * @param assignment - The cache assignment */ @@ -201,7 +197,6 @@ export class CacheCrudController /** * Get the crud service for the given assignment. - * * @internal * @param assignment - The cache assignment */ @@ -219,7 +214,6 @@ export class CacheCrudController /** * Get the entity key for the given assignment. - * * @param assignment - The cache assignment */ protected getEntityKey(assignment: ReferenceAssignment): string { diff --git a/packages/nestjs-cache/src/services/cache-crud.service.ts b/packages/nestjs-cache/src/services/cache-crud.service.ts index 5547abcbf..916fb0c00 100644 --- a/packages/nestjs-cache/src/services/cache-crud.service.ts +++ b/packages/nestjs-cache/src/services/cache-crud.service.ts @@ -10,7 +10,6 @@ import { CacheInterface } from '@concepta/ts-common'; export class CacheCrudService extends TypeOrmCrudService { /** * Constructor - * * @param repo - instance of the cache repository. */ constructor(repo: Repository) { diff --git a/packages/nestjs-cache/src/services/cache.service.ts b/packages/nestjs-cache/src/services/cache.service.ts index ac10b6172..5cc6ac8cb 100644 --- a/packages/nestjs-cache/src/services/cache.service.ts +++ b/packages/nestjs-cache/src/services/cache.service.ts @@ -34,7 +34,6 @@ export class CacheService implements CacheServiceInterface { /** * Create a cache with a for the given assignee. - * * @param assignment - The cache assignment * @param cache - The data to create */ @@ -119,7 +118,6 @@ export class CacheService implements CacheServiceInterface { /** * Delete a cache based on params - * * @param assignment - The cache assignment * @param cache - The cache to delete */ @@ -138,7 +136,6 @@ export class CacheService implements CacheServiceInterface { /** * Get all CACHEs for assignee. - * * @param assignment - The assignment of the check * @param cache - The cache to get assignments */ @@ -189,7 +186,6 @@ export class CacheService implements CacheServiceInterface { /** * Clear all caches for a given assignee. - * * @param assignment - The assignment of the repository * @param cache - The cache to clear */ @@ -216,7 +212,6 @@ export class CacheService implements CacheServiceInterface { /** * Delete CACHE based on assignment - * * @internal * @param assignment - The assignment to delete id from * @param id - The id or ids to delete @@ -292,7 +287,6 @@ export class CacheService implements CacheServiceInterface { /** * Get the assignment repo for the given assignment. - * * @internal * @param assignment - The cache assignment */ diff --git a/packages/nestjs-crud/src/__fixtures__/photo/photo.controller.fixture.ts b/packages/nestjs-crud/src/__fixtures__/photo/photo.controller.fixture.ts index a43f8f6cc..4b2ba5f34 100644 --- a/packages/nestjs-crud/src/__fixtures__/photo/photo.controller.fixture.ts +++ b/packages/nestjs-crud/src/__fixtures__/photo/photo.controller.fixture.ts @@ -42,14 +42,12 @@ export class PhotoControllerFixture { /** * Constructor. - * * @param photoService instance of the photo crud service */ constructor(private photoService: PhotoServiceFixture) {} /** * Get many - * * @param crudRequest the CRUD request object */ @CrudReadAll() @@ -59,7 +57,6 @@ export class PhotoControllerFixture /** * Get one - * * @param crudRequest the CRUD request object */ @CrudReadOne() @@ -69,7 +66,6 @@ export class PhotoControllerFixture /** * Create many - * * @param crudRequest the CRUD request object * @param photoCreateManyDto photo create many dto */ @@ -83,7 +79,6 @@ export class PhotoControllerFixture /** * Create one - * * @param crudRequest the CRUD request object * @param photoCreateDto photo create dto */ @@ -97,7 +92,6 @@ export class PhotoControllerFixture /** * Update one - * * @param crudRequest the CRUD request object * @param photoUpdateDto photo update dto */ @@ -111,7 +105,6 @@ export class PhotoControllerFixture /** * Replace one - * * @param crudRequest the CRUD request object */ @CrudReplaceOne() @@ -124,7 +117,6 @@ export class PhotoControllerFixture /** * Delete one - * * @param crudRequest the CRUD request object */ @CrudDeleteOne() @@ -134,7 +126,6 @@ export class PhotoControllerFixture /** * Delete one (soft) - * * @param crudRequest the CRUD request object */ @CrudDeleteOne({ path: 'soft/:id' }) @@ -145,7 +136,6 @@ export class PhotoControllerFixture /** * Recover one - * * @param crudRequest the CRUD request object */ @CrudRecoverOne() diff --git a/packages/nestjs-crud/src/decorators/controller/crud-init-api-query.decorator.ts b/packages/nestjs-crud/src/decorators/controller/crud-init-api-query.decorator.ts index eff228fae..80a4ab4cc 100644 --- a/packages/nestjs-crud/src/decorators/controller/crud-init-api-query.decorator.ts +++ b/packages/nestjs-crud/src/decorators/controller/crud-init-api-query.decorator.ts @@ -79,7 +79,6 @@ export const CrudInitApiQuery = /** * Map crud action name to queryable base name. - * * @param action - The crud action we are mapping. */ function mapActionNameToQueryableBaseName( diff --git a/packages/nestjs-crud/src/decorators/routes/crud-validate.decorator.ts b/packages/nestjs-crud/src/decorators/routes/crud-validate.decorator.ts index 78b8c7455..0966e8df0 100644 --- a/packages/nestjs-crud/src/decorators/routes/crud-validate.decorator.ts +++ b/packages/nestjs-crud/src/decorators/routes/crud-validate.decorator.ts @@ -13,7 +13,6 @@ import { CrudValidationOptions } from '../../crud.types'; * * If this decorator is used on a method, it will use the given options for * every Crud parameter on the method that does NOT have validations explicitly set. - * * @param options - crud validation options */ export const CrudValidate = (options?: CrudValidationOptions) => diff --git a/packages/nestjs-event/src/events/event.ts b/packages/nestjs-event/src/events/event.ts index 194f455b8..15c3fb756 100644 --- a/packages/nestjs-event/src/events/event.ts +++ b/packages/nestjs-event/src/events/event.ts @@ -33,14 +33,12 @@ export abstract class Event

{ /** * Expects return of payload - * * @internal */ readonly expectsReturnOf!: R; /** * Event key. - * * @returns The event key string. */ static get key(): string { @@ -49,7 +47,6 @@ export abstract class Event

/** * Event key. - * * @returns The event key string. */ get key(): string { @@ -63,14 +60,12 @@ export abstract class Event

/** * Constructor - * * @param payload - Payload to emit when the event is dispatched. */ constructor(payload?: EventPayload

); /** * Constructor - * * @param payload - Payload to emit when the event is dispatched. */ constructor(payload: EventPayload

) { @@ -79,7 +74,6 @@ export abstract class Event

/** * Returns payload that was passed to the Event constructor. - * * @returns The event payload. */ get payload(): EventPayload

{ diff --git a/packages/nestjs-event/src/listeners/event-listener-on.ts b/packages/nestjs-event/src/listeners/event-listener-on.ts index 37cb7a1e8..f15163fd4 100644 --- a/packages/nestjs-event/src/listeners/event-listener-on.ts +++ b/packages/nestjs-event/src/listeners/event-listener-on.ts @@ -41,7 +41,6 @@ export abstract class EventListenerOn { /** * Constructor - * * @param _options - Listener options */ constructor(private _options: EventListenOnOptionsInterface = {}) { @@ -50,7 +49,6 @@ export abstract class EventListenerOn /** * Default listener options. - * * @returns The default listener options. */ get options(): EventListenOnOptionsInterface { diff --git a/packages/nestjs-event/src/listeners/event-listener.ts b/packages/nestjs-event/src/listeners/event-listener.ts index c0b8f7e55..05569ab0d 100644 --- a/packages/nestjs-event/src/listeners/event-listener.ts +++ b/packages/nestjs-event/src/listeners/event-listener.ts @@ -61,7 +61,6 @@ export abstract class EventListener implements EventListenerInterface { /** * Called after successful subscription. - * * @internal * @param emitterListener - The Listener object returned by EventEmitter2 */ diff --git a/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts b/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts index 2652ce4fa..3939a0b04 100644 --- a/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts +++ b/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts @@ -7,14 +7,12 @@ import { EventInstance, EventReturnType } from '../../event-types'; export interface EventListenerInterface { /** * Listener handler. - * * @param event - An event instance */ listen(event: EventInstance): EventReturnType; /** * Called after successful subscription. - * * @param emitterListener - The Listener object returned by EventEmitter2 */ subscription(emitterListener: EmitterListener): void; diff --git a/packages/nestjs-event/src/services/event-dispatch.service.ts b/packages/nestjs-event/src/services/event-dispatch.service.ts index 0c618bade..e80cc2ab0 100644 --- a/packages/nestjs-event/src/services/event-dispatch.service.ts +++ b/packages/nestjs-event/src/services/event-dispatch.service.ts @@ -14,7 +14,6 @@ import { EVENT_MODULE_EMITTER_SERVICE_TOKEN } from '../event-constants'; export class EventDispatchService { /** * Constructor - * * @param eventEmitter - Injected event emitter instance */ constructor( @@ -41,17 +40,16 @@ export class EventDispatchService { * * @Injectable() * class MyClass { - * constructor(private eventDispatchService: EventDispatchService) {} + * constructor(private eventDispatchService: EventDispatchService) {} * - * didSomething() { - * // event instance - * const myEvent = new MyEvent({id: 1234}); - * // dispatch the event - * this.eventDispatchService.sync(myEvent); - * } + * didSomething() { + * // event instance + * const myEvent = new MyEvent({id: 1234}); + * // dispatch the event + * this.eventDispatchService.sync(myEvent); + * } * } * ``` - * * @param event - The event being dispatched. * @returns boolean Returns true if the event had listeners, false otherwise. */ @@ -82,28 +80,27 @@ export class EventDispatchService { * * @Injectable() * class MyClass { - * constructor(private eventDispatchService: EventDispatchService) {} + * constructor(private eventDispatchService: EventDispatchService) {} * - * // allow any listener to activate object - * async maybeActivate(myPayloadType: MyPayloadType): MyPayloadType { - * // event instance - * const myEvent = new MyEvent({...myPayloadType, active: false}); - * // dispatch the event - * const allPayloads: MyPayloadType[] = - * await this.eventDispatchService.async(myEvent); - * // merge it - * allPayloads.forEach((payload) => { - * // did any listener set it to true? - * if (payload.active) { - * myPayloadType.active = true; - * } - * }); - * // return possibly modified object - * return myPayloadType; - * } + * // allow any listener to activate object + * async maybeActivate(myPayloadType: MyPayloadType): MyPayloadType { + * // event instance + * const myEvent = new MyEvent({...myPayloadType, active: false}); + * // dispatch the event + * const allPayloads: MyPayloadType[] = + * await this.eventDispatchService.async(myEvent); + * // merge it + * allPayloads.forEach((payload) => { + * // did any listener set it to true? + * if (payload.active) { + * myPayloadType.active = true; + * } + * }); + * // return possibly modified object + * return myPayloadType; + * } * } * ``` - * * @param event - The event being dispatched. * @returns An array of return payloads, one for each listener that subscribed to the event. */ diff --git a/packages/nestjs-event/src/services/event-listen.service.ts b/packages/nestjs-event/src/services/event-listen.service.ts index 61497205f..0d7a8be11 100644 --- a/packages/nestjs-event/src/services/event-listen.service.ts +++ b/packages/nestjs-event/src/services/event-listen.service.ts @@ -20,7 +20,6 @@ import { EventInstance } from '../event-types'; export class EventListenService { /** * Constructor - * * @param eventEmitter - Injected event emitter instance */ constructor( @@ -41,24 +40,23 @@ export class EventListenService { * import { TargetEvent } from 'target-module'; * * class MyListener extends EventListenerOn { - * listen(event: TargetEvent) { - * console.log(event.payload); - * } + * listen(event: TargetEvent) { + * console.log(event.payload); + * } * } * * @Injectable() * class MyClass implements OnModuleInit { - * constructor(private eventListenService: EventListenService) {} + * constructor(private eventListenService: EventListenService) {} * - * onModuleInit() { - * // listener instance - * const listener = new MyListener(); - * // register the listener - * this.eventListenService.on(TargetEvent, listener); - * } + * onModuleInit() { + * // listener instance + * const listener = new MyListener(); + * // register the listener + * this.eventListenService.on(TargetEvent, listener); + * } * } * ``` - * * @param eventClass - The event class to subscribe to. This is the class, NOT an instance. * @param listener - Instance of the event listener class to attach to the event. * @param options - Overriding options. diff --git a/packages/nestjs-exception/src/utils/map-http-status.util.ts b/packages/nestjs-exception/src/utils/map-http-status.util.ts index 608b5beef..4ed3f59cc 100644 --- a/packages/nestjs-exception/src/utils/map-http-status.util.ts +++ b/packages/nestjs-exception/src/utils/map-http-status.util.ts @@ -5,7 +5,6 @@ import { /** * Map http status to error codes. - * * @param statusCode - The HTTP status code to look up. */ export function mapHttpStatus(statusCode: number) { diff --git a/packages/nestjs-federated/src/services/federated-mutate.service.ts b/packages/nestjs-federated/src/services/federated-mutate.service.ts index b5c93983f..4ecb93623 100644 --- a/packages/nestjs-federated/src/services/federated-mutate.service.ts +++ b/packages/nestjs-federated/src/services/federated-mutate.service.ts @@ -29,7 +29,6 @@ export class FederatedMutateService /** * Constructor - * * @param repo - instance of the federated repo */ constructor( diff --git a/packages/nestjs-federated/src/services/federated-oauth.service.ts b/packages/nestjs-federated/src/services/federated-oauth.service.ts index 90130ad5b..d631cdb97 100644 --- a/packages/nestjs-federated/src/services/federated-oauth.service.ts +++ b/packages/nestjs-federated/src/services/federated-oauth.service.ts @@ -32,7 +32,6 @@ export class FederatedOAuthService implements FederatedOAuthServiceInterface { /** * Sign in with federated creating a user if it doesn't exist - * * @param provider - provider name (github, facebook, google) * @param email - email account * @param subject - subject (user id/ profile id from provider) @@ -76,7 +75,6 @@ export class FederatedOAuthService implements FederatedOAuthServiceInterface { /** * Logic to create user and federated - * * @internal */ protected async createUserWithFederated( @@ -99,7 +97,6 @@ export class FederatedOAuthService implements FederatedOAuthServiceInterface { /** * Create a user - * * @internal */ protected async createUser( @@ -134,7 +131,6 @@ export class FederatedOAuthService implements FederatedOAuthServiceInterface { /** * Create federated credentials - * * @internal */ private async createFederated( diff --git a/packages/nestjs-invitation/src/services/invitation-acceptance.service.ts b/packages/nestjs-invitation/src/services/invitation-acceptance.service.ts index 3b7c0044d..e0e97eca1 100644 --- a/packages/nestjs-invitation/src/services/invitation-acceptance.service.ts +++ b/packages/nestjs-invitation/src/services/invitation-acceptance.service.ts @@ -114,7 +114,6 @@ export class InvitationAcceptanceService extends BaseService { @@ -136,7 +135,6 @@ export class InvitationAcceptanceService extends BaseService LoggerSettingsInterface) & /** * Mapping from log level to sentry severity - * * @param logLevel - Log level * @returns SentryLogSeverity */ diff --git a/packages/nestjs-logger/src/interfaces/logger-service.interface.ts b/packages/nestjs-logger/src/interfaces/logger-service.interface.ts index c2455cfd4..0b1e60ea9 100644 --- a/packages/nestjs-logger/src/interfaces/logger-service.interface.ts +++ b/packages/nestjs-logger/src/interfaces/logger-service.interface.ts @@ -9,14 +9,12 @@ import { LoggerTransportInterface } from './logger-transport.interface'; export interface LoggerServiceInterface { /** * Add the transport that will be used. - * * @param transport - Transport */ addTransport(transport: LoggerTransportInterface): void; /** * Method to log an exception. - * * @param error - The error to be logged * @param message - The Error Message to be logged * @param context - The Context of the message @@ -25,7 +23,6 @@ export interface LoggerServiceInterface { /** * Method to log message as a error log level. - * * @param message - Method to log message as an error * @param trace - Stack trace * @param context - The Context of the message @@ -38,7 +35,6 @@ export interface LoggerServiceInterface { /** * Method to log message as a warn log level. - * * @param message - Method to log message as a warning * @param context - The Context of the message */ @@ -46,7 +42,6 @@ export interface LoggerServiceInterface { /** * Debug method. - * * @param message - Method to log message as a debug * @param context - The Context of the message */ @@ -54,7 +49,6 @@ export interface LoggerServiceInterface { /** * Log method. - * * @param message - Method to log message as a Log * @param context - The Context of the message */ @@ -62,7 +56,6 @@ export interface LoggerServiceInterface { /** * Verbose method. - * * @param message - Method to log message as a Verbose * @param context - The Context of the message */ diff --git a/packages/nestjs-logger/src/interfaces/logger-transport.interface.ts b/packages/nestjs-logger/src/interfaces/logger-transport.interface.ts index ecfa3281d..b8c2d7c77 100644 --- a/packages/nestjs-logger/src/interfaces/logger-transport.interface.ts +++ b/packages/nestjs-logger/src/interfaces/logger-transport.interface.ts @@ -24,7 +24,6 @@ import { LogLevel } from '@nestjs/common'; export interface LoggerTransportInterface { /** * Transport log method - * * @param message - Message to be logged * @param logLevel - The log level that logger should consider * @param error - an optional error that can be sent diff --git a/packages/nestjs-logger/src/logger-exception.filter.ts b/packages/nestjs-logger/src/logger-exception.filter.ts index 207f7d94b..18f4b714e 100644 --- a/packages/nestjs-logger/src/logger-exception.filter.ts +++ b/packages/nestjs-logger/src/logger-exception.filter.ts @@ -15,7 +15,6 @@ import { LoggerService } from './logger.service'; export class LoggerExceptionFilter extends BaseExceptionFilter { /** * Constructor - * * @param loggerService - instance of the Logger Service */ constructor( @@ -27,7 +26,6 @@ export class LoggerExceptionFilter extends BaseExceptionFilter { /** * Override catch to log before returning exception. - * * @param exception - Error instance * @param host - Arguments Host instance */ diff --git a/packages/nestjs-logger/src/logger-request.interceptor.ts b/packages/nestjs-logger/src/logger-request.interceptor.ts index b354f8da9..c31330723 100644 --- a/packages/nestjs-logger/src/logger-request.interceptor.ts +++ b/packages/nestjs-logger/src/logger-request.interceptor.ts @@ -23,14 +23,12 @@ import { MessageFormatUtil } from './utils/message-format.util'; export class LoggerRequestInterceptor implements NestInterceptor { /** * Constructor - * * @param loggerService - The logger service that implements ConsoleLogger */ constructor(private loggerService: LoggerService) {} /** * Method to implement a custom intercept - * * @param context - Execution context * @param next - Call handler */ @@ -58,7 +56,6 @@ export class LoggerRequestInterceptor implements NestInterceptor { /** * Method to log response success - * * @param req - Request * @param res - Response * @param startDate - the date for the message @@ -77,12 +74,10 @@ export class LoggerRequestInterceptor implements NestInterceptor { /** * Format exception error - * * @param req - Request * @param res - Response * @param startDate - Start date * @param error - Error instance - * @returns */ responseError(req: Request, res: Response, startDate: Date, error: Error) { // format the message diff --git a/packages/nestjs-logger/src/logger-transport.service.ts b/packages/nestjs-logger/src/logger-transport.service.ts index ab4837b4c..4ecd43a9e 100644 --- a/packages/nestjs-logger/src/logger-transport.service.ts +++ b/packages/nestjs-logger/src/logger-transport.service.ts @@ -41,7 +41,6 @@ export class LoggerTransportService { /** * Constructor - * * @param settings - logger settings */ constructor( @@ -55,7 +54,6 @@ export class LoggerTransportService { /** * Method to add the transport that will be used - * * @param transport - Instance of a logger transport */ public addTransport(transport: LoggerTransportInterface): void { @@ -64,7 +62,6 @@ export class LoggerTransportService { /** * Method to log message to the transport based on the log level - * * @param message - message * @param logLevel - log level * @param error - error diff --git a/packages/nestjs-logger/src/logger.service.ts b/packages/nestjs-logger/src/logger.service.ts index 58cd40370..27d86cc6a 100644 --- a/packages/nestjs-logger/src/logger.service.ts +++ b/packages/nestjs-logger/src/logger.service.ts @@ -43,7 +43,6 @@ export class LoggerService { /** * Constructor - * * @param transportService - transport service */ constructor(protected readonly transportService: LoggerTransportService) { @@ -52,7 +51,6 @@ export class LoggerService /** * Add a transport to be used for every log, it can be multiples - * * @param transport - The transport that will be used beside the system logger */ addTransport(transport: LoggerTransportInterface): void { @@ -64,7 +62,6 @@ export class LoggerService * * If the exception is between 400 and 500 status code * it will be logged as a debug log level, otherwise it will be logged as an error. - * * @param error - Error to be registered * @param message - Error Message * @param context - Context of current error @@ -100,7 +97,6 @@ export class LoggerService /** * Method to be called when an error should be logged. - * * @param message - Error Message * @param trace - Stack trace error * @param context - Context of current Message @@ -126,7 +122,6 @@ export class LoggerService /** * Method to be used when a warn message should be logged. - * * @param message - Warn Message * @param context - Context of Message */ @@ -137,7 +132,6 @@ export class LoggerService /** * Method to be used when a debug message should be logged. - * * @param message - Debug Message * @param context - Context of Message */ @@ -148,7 +142,6 @@ export class LoggerService /** * Method to be used when a simple log message should be logged. - * * @param message - Log message * @param context - Context of Message */ @@ -159,7 +152,6 @@ export class LoggerService /** * Method to be used when a verbose message should be logged. - * * @param message - Verbose Message * @param context - Context Message */ diff --git a/packages/nestjs-logger/src/transports/logger-sentry.transport.ts b/packages/nestjs-logger/src/transports/logger-sentry.transport.ts index 8c062619b..146e4f2a8 100644 --- a/packages/nestjs-logger/src/transports/logger-sentry.transport.ts +++ b/packages/nestjs-logger/src/transports/logger-sentry.transport.ts @@ -20,7 +20,6 @@ import { LoggerTransportInterface } from '../interfaces/logger-transport.interfa export class LoggerSentryTransport implements LoggerTransportInterface { /** * Constructor - * * @param config - configuration file injected */ constructor(protected readonly config: LoggerSentryConfigInterface) { @@ -34,7 +33,6 @@ export class LoggerSentryTransport implements LoggerTransportInterface { /** * Method to log message to Sentry transport - * * @param message - message * @param logLevel - log level * @param error - error diff --git a/packages/nestjs-logger/src/utils/config-parser.util.ts b/packages/nestjs-logger/src/utils/config-parser.util.ts index 0c6697751..87b8d3dc3 100644 --- a/packages/nestjs-logger/src/utils/config-parser.util.ts +++ b/packages/nestjs-logger/src/utils/config-parser.util.ts @@ -3,7 +3,6 @@ import { LOGGER_VALID_LOG_LEVELS } from '../config/logger.config'; /** * Helper to split log level string and assign to correct log level type. - * * @internal * @param levels - Log levels to split */ diff --git a/packages/nestjs-logger/src/utils/message-format.util.ts b/packages/nestjs-logger/src/utils/message-format.util.ts index a1eb6e0a3..62946d1e9 100644 --- a/packages/nestjs-logger/src/utils/message-format.util.ts +++ b/packages/nestjs-logger/src/utils/message-format.util.ts @@ -5,15 +5,12 @@ import { /** * Message formatting utility - * * @internal */ export class MessageFormatUtil { /** * Function to format message from request. - * * @param req - request - * @returns */ static formatRequestMessage(req: Request): string { const { method, url } = req; @@ -24,12 +21,10 @@ export class MessageFormatUtil { /** * Function to format message for response. - * * @param req - request * @param res - response * @param startDate - start date * @param error - error - * @returns */ static formatResponseMessage( req: Request, diff --git a/packages/nestjs-org/src/org.controller.ts b/packages/nestjs-org/src/org.controller.ts index 6c8d90fa8..ffcd5078e 100644 --- a/packages/nestjs-org/src/org.controller.ts +++ b/packages/nestjs-org/src/org.controller.ts @@ -56,14 +56,12 @@ export class OrgController { /** * Constructor. - * * @param orgCrudService - instance of the Org crud service */ constructor(private orgCrudService: OrgCrudService) {} /** * Get many - * * @param crudRequest - the CRUD request object */ @CrudReadMany() @@ -74,7 +72,6 @@ export class OrgController /** * Get one - * * @param crudRequest - the CRUD request object */ @CrudReadOne() @@ -85,7 +82,6 @@ export class OrgController /** * Create many - * * @param crudRequest - the CRUD request object * @param orgCreateManyDto - org create many dto */ @@ -101,7 +97,6 @@ export class OrgController /** * Create one - * * @param crudRequest - the CRUD request object * @param orgCreateDto - org create dto */ @@ -117,7 +112,6 @@ export class OrgController /** * Update one - * * @param crudRequest - the CRUD request object * @param orgUpdateDto - org update dto */ @@ -132,7 +126,6 @@ export class OrgController /** * Delete one - * * @param crudRequest - the CRUD request object */ @CrudDeleteOne() @@ -143,7 +136,6 @@ export class OrgController /** * Recover one - * * @param crudRequest - the CRUD request object */ @CrudRecoverOne() diff --git a/packages/nestjs-org/src/services/org-crud.service.ts b/packages/nestjs-org/src/services/org-crud.service.ts index fb8ddc3a4..9f04e0a8a 100644 --- a/packages/nestjs-org/src/services/org-crud.service.ts +++ b/packages/nestjs-org/src/services/org-crud.service.ts @@ -12,7 +12,6 @@ import { OrgEntityInterface } from '../interfaces/org-entity.interface'; export class OrgCrudService extends TypeOrmCrudService { /** * Constructor - * * @param orgRepo - instance of the org repository. */ constructor( diff --git a/packages/nestjs-org/src/services/org-lookup.service.ts b/packages/nestjs-org/src/services/org-lookup.service.ts index 2271acbc6..47d2bd098 100644 --- a/packages/nestjs-org/src/services/org-lookup.service.ts +++ b/packages/nestjs-org/src/services/org-lookup.service.ts @@ -23,7 +23,6 @@ export class OrgLookupService { /** * Constructor - * * @param repo - instance of the org repo */ constructor( @@ -37,7 +36,6 @@ export class OrgLookupService /** * Get owner for the given org. - * * @param org - The org of which owner to retrieve. */ async getOwner(org: OrgOwnerInterface, queryOptions?: QueryOptionsInterface) { diff --git a/packages/nestjs-org/src/services/org-mutate.service.ts b/packages/nestjs-org/src/services/org-mutate.service.ts index 15ae40c06..b5783c2c5 100644 --- a/packages/nestjs-org/src/services/org-mutate.service.ts +++ b/packages/nestjs-org/src/services/org-mutate.service.ts @@ -29,7 +29,6 @@ export class OrgMutateService /** * Constructor - * * @param repo - instance of the org repo */ constructor( diff --git a/packages/nestjs-otp/src/services/otp.service.ts b/packages/nestjs-otp/src/services/otp.service.ts index 87fba9119..62f2918c4 100644 --- a/packages/nestjs-otp/src/services/otp.service.ts +++ b/packages/nestjs-otp/src/services/otp.service.ts @@ -37,7 +37,6 @@ export class OtpService implements OtpServiceInterface { /** * Create a otp with a for the given assignee. - * * @param assignment - The otp assignment * @param otp - The data to create */ @@ -84,7 +83,6 @@ export class OtpService implements OtpServiceInterface { /** * Check if otp is valid - * * @param assignment - The otp assignment * @param otp - The otp to validate * @param deleteIfValid - If true, delete the otp if it is valid @@ -115,7 +113,6 @@ export class OtpService implements OtpServiceInterface { /** * Delete a otp based on params - * * @param assignment - The otp assignment * @param otp - The otp to delete */ @@ -134,7 +131,6 @@ export class OtpService implements OtpServiceInterface { /** * Clear all otps for assign in given category. - * * @param assignment - The assignment of the repository * @param otp - The otp to clear */ @@ -159,7 +155,6 @@ export class OtpService implements OtpServiceInterface { /** * Delete OTP based on assignment - * * @internal * @param assignment - The assignment to delete id from * @param id - The id or ids to delete @@ -184,7 +179,6 @@ export class OtpService implements OtpServiceInterface { /** * Get all OTPs for assignee. - * * @param assignment - The assignment of the check * @param otp - The otp to get assignments */ @@ -254,7 +248,6 @@ export class OtpService implements OtpServiceInterface { /** * Get the assignment repo for the given assignment. - * * @internal * @param assignment - The otp assignment */ diff --git a/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts b/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts index fedcb6770..cedec9d60 100644 --- a/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts +++ b/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts @@ -9,7 +9,6 @@ import { PasswordCreateObjectOptionsInterface } from './password-create-object-o export interface PasswordCreationServiceInterface { /** * Create password for an object (optionally). - * * @param object - An object containing the new password to hash. * @param options - Password create options. * @returns A new object with the password hashed, with salt added. @@ -23,7 +22,6 @@ export interface PasswordCreationServiceInterface { /** * Validate the current password for the targeted object. - * * @param options - Validate current options. * @returns boolean */ @@ -33,14 +31,12 @@ export interface PasswordCreationServiceInterface { /** * Check if attempt is valid. - * * @returns Number of attempts user has to try */ checkAttempt(numOfAttempts: number): boolean; /** * Check number of attempts of using password - * * @param numOfAttempts - number of attempts * @returns number of attempts left */ diff --git a/packages/nestjs-password/src/interfaces/password-storage-service.interface.ts b/packages/nestjs-password/src/interfaces/password-storage-service.interface.ts index 41fb83847..ebe0be326 100644 --- a/packages/nestjs-password/src/interfaces/password-storage-service.interface.ts +++ b/packages/nestjs-password/src/interfaces/password-storage-service.interface.ts @@ -15,7 +15,6 @@ export interface PasswordStorageServiceInterface { /** * Hash a password using a salt, if no * was passed, then generate one automatically. - * * @param password - Password to be hashed * @param options - Hash options */ @@ -26,7 +25,6 @@ export interface PasswordStorageServiceInterface { /** * Hash password for an object. - * * @param object - An object containing the new password to hash. * @param options - Hash object options * @returns A new object with the password hashed, with salt added. diff --git a/packages/nestjs-password/src/interfaces/password-strength-service.interface.ts b/packages/nestjs-password/src/interfaces/password-strength-service.interface.ts index 360106d9e..96af91096 100644 --- a/packages/nestjs-password/src/interfaces/password-strength-service.interface.ts +++ b/packages/nestjs-password/src/interfaces/password-strength-service.interface.ts @@ -4,7 +4,6 @@ export interface PasswordStrengthServiceInterface { /** * Check if Password is strong - * * @param password - The plain text password */ isStrong(password: string): boolean; diff --git a/packages/nestjs-password/src/interfaces/password-validation-service.interface.ts b/packages/nestjs-password/src/interfaces/password-validation-service.interface.ts index 2776bb184..36b637aaa 100644 --- a/packages/nestjs-password/src/interfaces/password-validation-service.interface.ts +++ b/packages/nestjs-password/src/interfaces/password-validation-service.interface.ts @@ -7,14 +7,12 @@ import { PasswordValidateOptionsInterface } from './password-validate-options.in export interface PasswordValidationServiceInterface { /** * Validate if password matches and its valid. - * * @param options - Validation options */ validate(options: PasswordValidateOptionsInterface): Promise; /** * Validate password on an object. - * * @param passwordPlain - Plain text password * @param object - The object on which the password and salt are stored */ diff --git a/packages/nestjs-password/src/services/password-creation.service.ts b/packages/nestjs-password/src/services/password-creation.service.ts index 7e7e71f73..0dfdb7dbe 100644 --- a/packages/nestjs-password/src/services/password-creation.service.ts +++ b/packages/nestjs-password/src/services/password-creation.service.ts @@ -32,7 +32,6 @@ export class PasswordCreationService /** * Create password for an object. - * * @param object - An object containing the new password to hash. * @param options - Password create options. * @returns A new object with the password hashed, with salt added. @@ -44,7 +43,6 @@ export class PasswordCreationService /** * Create password for an object. - * * @param object - An object containing the new password to hash. * @param options - Password create options. * @returns A new object with the password hashed, with salt added. @@ -59,7 +57,6 @@ export class PasswordCreationService /** * Create password for an object. - * * @param object - An object containing the new password to hash. * @param options - Password create options. * @returns A new object with the password hashed, with salt added. @@ -122,7 +119,6 @@ export class PasswordCreationService /** * Check number of attempts of using password * @param numOfAttempts - number of attempts - * @returns */ checkAttemptLeft(numOfAttempts = 0): number { // Get number of max attempts allowed diff --git a/packages/nestjs-password/src/services/password-storage.service.ts b/packages/nestjs-password/src/services/password-storage.service.ts index ecdcc9fdd..fa80d99f9 100644 --- a/packages/nestjs-password/src/services/password-storage.service.ts +++ b/packages/nestjs-password/src/services/password-storage.service.ts @@ -21,7 +21,6 @@ export class PasswordStorageService implements PasswordStorageServiceInterface { /** * Hash a password using a salt, if no * was passed, then one will be generated. - * * @param password - Password to be hashed * @param options - Hash options */ @@ -40,7 +39,6 @@ export class PasswordStorageService implements PasswordStorageServiceInterface { /** * Hash password for an object. - * * @param object - An object containing the new password to hash. * @param options - Hash object options * @returns A new object with the password hashed, with salt added. @@ -52,7 +50,6 @@ export class PasswordStorageService implements PasswordStorageServiceInterface { /** * Hash password for an object if the password property exists. - * * @param object - An object containing the new password to hash. * @param options - Hash object options * @returns A new object with the password hashed, with salt added. @@ -66,7 +63,6 @@ export class PasswordStorageService implements PasswordStorageServiceInterface { /** * Hash password for an object. - * * @param object - An object containing the new password to hash. * @param options - Hash object options * @returns A new object with the password hashed, with salt added. diff --git a/packages/nestjs-password/src/services/password-strength.service.ts b/packages/nestjs-password/src/services/password-strength.service.ts index 51dd41b20..13e198538 100644 --- a/packages/nestjs-password/src/services/password-strength.service.ts +++ b/packages/nestjs-password/src/services/password-strength.service.ts @@ -24,7 +24,6 @@ export class PasswordStrengthService /** * Method to check if password is strong - * * @param password - the plain text password * @returns password strength */ diff --git a/packages/nestjs-password/src/utils/crypt.util.ts b/packages/nestjs-password/src/utils/crypt.util.ts index 68a6663db..a3b9dc08b 100644 --- a/packages/nestjs-password/src/utils/crypt.util.ts +++ b/packages/nestjs-password/src/utils/crypt.util.ts @@ -15,7 +15,6 @@ export abstract class CryptUtil { /** * @param password - The plain text password to hash * @param salt - The salt to use when hashing the password - * @returns */ static async hashPassword(password: string, salt: string): Promise { // must have a password @@ -31,9 +30,8 @@ export abstract class CryptUtil { /** * Validate password with the hash password * @param passwordPlain - The plain password - * @param passwordCrypt - The encrypted password + * @param passwordHash - The encrypted password * @param passwordSalt - The salt - * @returns */ static async validatePassword( passwordPlain: string, diff --git a/packages/nestjs-role/src/interfaces/role-service.interface.ts b/packages/nestjs-role/src/interfaces/role-service.interface.ts index 078b7abd6..c8d198e76 100644 --- a/packages/nestjs-role/src/interfaces/role-service.interface.ts +++ b/packages/nestjs-role/src/interfaces/role-service.interface.ts @@ -7,7 +7,6 @@ import { RoleEntityInterface } from './role-entity.interface'; export interface RoleServiceInterface { /** * Get all roles for assignee. - * * @param assignment - The assignment of the check (same as entity key) * @param assignee - The assignee to check */ @@ -19,7 +18,6 @@ export interface RoleServiceInterface { /** * Check if the assignee is a member of one role. - * * @param assignment - The assignment of the check * @param role - The role to check * @param assignee - The assignee to check @@ -33,7 +31,6 @@ export interface RoleServiceInterface { /** * Check if the assignee is a member of every role. - * * @param assignment - The assignment of the check * @param roles - The roles to check * @param assignee - The assignee to check diff --git a/packages/nestjs-role/src/role-assignment.controller.ts b/packages/nestjs-role/src/role-assignment.controller.ts index cc4412b0e..610746ffa 100644 --- a/packages/nestjs-role/src/role-assignment.controller.ts +++ b/packages/nestjs-role/src/role-assignment.controller.ts @@ -68,7 +68,7 @@ export class RoleAssignmentController { /** * Constructor. - * + * @param settings - role settings * @param allCrudServices - instances of all crud services */ constructor( @@ -80,7 +80,6 @@ export class RoleAssignmentController /** * Get many - * * @param crudRequest - the CRUD request object * @param assignment - the assignment */ @@ -95,7 +94,6 @@ export class RoleAssignmentController /** * Get one - * * @param crudRequest - the CRUD request object * @param assignment - The role assignment */ @@ -110,7 +108,6 @@ export class RoleAssignmentController /** * Create many - * * @param crudRequest - the CRUD request object * @param roleAssignmentCreateDto - role create many dto * @param assignment - The role assignment @@ -139,7 +136,6 @@ export class RoleAssignmentController /** * Create one - * * @param crudRequest - the CRUD request object * @param roleAssignmentCreateDto - role create dto * @param assignment - The role assignment @@ -160,7 +156,6 @@ export class RoleAssignmentController /** * Delete one - * * @param crudRequest - the CRUD request object * @param assignment - The role assignment */ @@ -175,7 +170,6 @@ export class RoleAssignmentController /** * Get the crud service for the given assignment. - * * @internal * @param assignment - The role assignment */ diff --git a/packages/nestjs-role/src/role.controller.ts b/packages/nestjs-role/src/role.controller.ts index 53f420d1b..8be35a295 100644 --- a/packages/nestjs-role/src/role.controller.ts +++ b/packages/nestjs-role/src/role.controller.ts @@ -54,14 +54,12 @@ export class RoleController { /** * Constructor. - * * @param roleCrudService - instance of the Role crud service */ constructor(private roleCrudService: RoleCrudService) {} /** * Get many - * * @param crudRequest - the CRUD request object */ @CrudReadMany() @@ -72,7 +70,6 @@ export class RoleController /** * Get one - * * @param crudRequest - the CRUD request object */ @CrudReadOne() @@ -83,7 +80,6 @@ export class RoleController /** * Create many - * * @param crudRequest - the CRUD request object * @param roleCreateManyDto - role create many dto */ @@ -108,7 +104,6 @@ export class RoleController /** * Create one - * * @param crudRequest - the CRUD request object * @param roleCreateDto - role create dto */ @@ -124,7 +119,6 @@ export class RoleController /** * Update one - * * @param crudRequest - the CRUD request object * @param roleUpdateDto - role update dto */ @@ -139,7 +133,6 @@ export class RoleController /** * Delete one - * * @param crudRequest - the CRUD request object */ @CrudDeleteOne() diff --git a/packages/nestjs-role/src/services/role-assignment-crud.service.ts b/packages/nestjs-role/src/services/role-assignment-crud.service.ts index 51dc27f33..928e80d36 100644 --- a/packages/nestjs-role/src/services/role-assignment-crud.service.ts +++ b/packages/nestjs-role/src/services/role-assignment-crud.service.ts @@ -8,7 +8,6 @@ import { RoleAssignmentInterface } from '@concepta/ts-common'; export class RoleAssignmentCrudService extends TypeOrmCrudService { /** * Constructor - * * @param repo - instance of a role assignment repository. */ constructor(repo: Repository) { diff --git a/packages/nestjs-role/src/services/role-crud.service.ts b/packages/nestjs-role/src/services/role-crud.service.ts index 1d5c0e29d..d586beaf8 100644 --- a/packages/nestjs-role/src/services/role-crud.service.ts +++ b/packages/nestjs-role/src/services/role-crud.service.ts @@ -12,7 +12,6 @@ import { RoleEntityInterface } from '../interfaces/role-entity.interface'; export class RoleCrudService extends TypeOrmCrudService { /** * Constructor - * * @param roleRepo - instance of the role repository. */ constructor( diff --git a/packages/nestjs-role/src/services/role-lookup.service.ts b/packages/nestjs-role/src/services/role-lookup.service.ts index 7370981c0..637daf058 100644 --- a/packages/nestjs-role/src/services/role-lookup.service.ts +++ b/packages/nestjs-role/src/services/role-lookup.service.ts @@ -16,7 +16,6 @@ export class RoleLookupService { /** * Constructor - * * @param repo - instance of the role repo */ constructor( diff --git a/packages/nestjs-role/src/services/role-mutate.service.ts b/packages/nestjs-role/src/services/role-mutate.service.ts index 5d6d135ca..c165017e7 100644 --- a/packages/nestjs-role/src/services/role-mutate.service.ts +++ b/packages/nestjs-role/src/services/role-mutate.service.ts @@ -29,7 +29,6 @@ export class RoleMutateService /** * Constructor - * * @param repo - instance of the role repo */ constructor( diff --git a/packages/nestjs-role/src/services/role.service.ts b/packages/nestjs-role/src/services/role.service.ts index d4256b01f..051012081 100644 --- a/packages/nestjs-role/src/services/role.service.ts +++ b/packages/nestjs-role/src/services/role.service.ts @@ -31,7 +31,6 @@ export class RoleService implements RoleServiceInterface { /** * Get all roles for assignee. - * * @param assignment - The assignment of the check (same as entity key) * @param assignee - The assignee to check */ @@ -67,7 +66,6 @@ export class RoleService implements RoleServiceInterface { /** * Check if the assignee is a member of one role. - * * @param assignment - The assignment of the check * @param role - The role to check * @param assignee - The assignee to check @@ -105,7 +103,6 @@ export class RoleService implements RoleServiceInterface { /** * Check if the assignee is a member of every role. - * * @param assignment - The assignment of the check * @param roles - The roles to check * @param assignee - The assignee to check @@ -141,7 +138,6 @@ export class RoleService implements RoleServiceInterface { /** * Get the assignment repo for the given assignment. - * * @internal * @param assignment - The role assignment */ diff --git a/packages/nestjs-swagger-ui/src/swagger-ui.service.ts b/packages/nestjs-swagger-ui/src/swagger-ui.service.ts index 7e8d820cf..65421c1dc 100644 --- a/packages/nestjs-swagger-ui/src/swagger-ui.service.ts +++ b/packages/nestjs-swagger-ui/src/swagger-ui.service.ts @@ -10,7 +10,6 @@ import { export class SwaggerUiService { /** * Constructor. - * * @param settings - swagger ui settings */ constructor( @@ -29,7 +28,6 @@ export class SwaggerUiService { /** * Setup. - * * @param app - Nest application instance */ setup(app: INestApplication) { diff --git a/packages/nestjs-typeorm-ext/src/utils/create-dynamic-repository-provider.ts b/packages/nestjs-typeorm-ext/src/utils/create-dynamic-repository-provider.ts index ef5441ce2..8b0846b35 100644 --- a/packages/nestjs-typeorm-ext/src/utils/create-dynamic-repository-provider.ts +++ b/packages/nestjs-typeorm-ext/src/utils/create-dynamic-repository-provider.ts @@ -9,7 +9,6 @@ import { TypeOrmExtEntityOptionInterface } from '../interfaces/typeorm-ext-entit /** * Create dynamic repository provider function - * * @param key - repository key * @param entity - the entity * @param repositoryFactory - the repository diff --git a/packages/nestjs-typeorm-ext/src/utils/create-entity-repository-provider.ts b/packages/nestjs-typeorm-ext/src/utils/create-entity-repository-provider.ts index 2820c9ed7..b434d3fcf 100644 --- a/packages/nestjs-typeorm-ext/src/utils/create-entity-repository-provider.ts +++ b/packages/nestjs-typeorm-ext/src/utils/create-entity-repository-provider.ts @@ -7,7 +7,6 @@ import { EntityClassOrSchema } from '@nestjs/typeorm/dist/interfaces/entity-clas /** * Create an entity repository provider function - * * @param key - Entity key * @param entity - The entity * @param dataSource - The data source diff --git a/packages/nestjs-user/src/interfaces/user-password-service.interface.ts b/packages/nestjs-user/src/interfaces/user-password-service.interface.ts index 18823f8be..2494b2e00 100644 --- a/packages/nestjs-user/src/interfaces/user-password-service.interface.ts +++ b/packages/nestjs-user/src/interfaces/user-password-service.interface.ts @@ -14,7 +14,6 @@ export interface UserPasswordServiceInterface { * Get the user being updated by id. * * Object must have reference id and password storage interface. - * * @param userId - The id of the user that is being updated * @returns The user being updated */ @@ -24,7 +23,6 @@ export interface UserPasswordServiceInterface { /** * Set the password (hash) on the user object. - * * @param passwordDto - The object containing the password, and optionally the current password. * @param userToUpdateId - The id of the user being updated. * @param authorizedUser - The authorized user diff --git a/packages/nestjs-user/src/services/user-crud.service.ts b/packages/nestjs-user/src/services/user-crud.service.ts index b6758b8fd..bc53ebfe9 100644 --- a/packages/nestjs-user/src/services/user-crud.service.ts +++ b/packages/nestjs-user/src/services/user-crud.service.ts @@ -12,7 +12,6 @@ import { UserEntityInterface } from '../interfaces/user-entity.interface'; export class UserCrudService extends TypeOrmCrudService { /** * Constructor - * * @param userRepo - instance of the user repository. */ constructor( diff --git a/packages/nestjs-user/src/services/user-lookup.service.ts b/packages/nestjs-user/src/services/user-lookup.service.ts index 1ae6304a3..e9278b9db 100644 --- a/packages/nestjs-user/src/services/user-lookup.service.ts +++ b/packages/nestjs-user/src/services/user-lookup.service.ts @@ -22,7 +22,6 @@ export class UserLookupService { /** * Constructor - * * @param repo - instance of the user repo */ constructor( @@ -34,7 +33,6 @@ export class UserLookupService /** * Get user for the given email. - * * @param email - the email */ async byEmail( @@ -46,7 +44,6 @@ export class UserLookupService /** * Get user for the given subject. - * * @param subject - the subject */ async bySubject( @@ -58,7 +55,6 @@ export class UserLookupService /** * Get user for the given username. - * * @param username - the username */ async byUsername( diff --git a/packages/nestjs-user/src/services/user-mutate.service.ts b/packages/nestjs-user/src/services/user-mutate.service.ts index f15b423aa..0070178dd 100644 --- a/packages/nestjs-user/src/services/user-mutate.service.ts +++ b/packages/nestjs-user/src/services/user-mutate.service.ts @@ -32,7 +32,6 @@ export class UserMutateService /** * Constructor - * * @param repo - instance of the user repo * @param userPasswordService - instance of a user password service */ diff --git a/packages/nestjs-user/src/services/user-password.service.ts b/packages/nestjs-user/src/services/user-password.service.ts index cc499746d..711499e2a 100644 --- a/packages/nestjs-user/src/services/user-password.service.ts +++ b/packages/nestjs-user/src/services/user-password.service.ts @@ -24,7 +24,6 @@ import { UserNotFoundException } from '../exceptions/user-not-found-exception'; export class UserPasswordService implements UserPasswordServiceInterface { /** * Constructor - * * @param userLookupService - user lookup service * @param passwordCreationService - password creation service */ diff --git a/packages/nestjs-user/src/user.controller.ts b/packages/nestjs-user/src/user.controller.ts index 68e8a03ee..6dadfdbbd 100644 --- a/packages/nestjs-user/src/user.controller.ts +++ b/packages/nestjs-user/src/user.controller.ts @@ -67,7 +67,6 @@ export class UserController { /** * Constructor. - * * @param userCrudService - instance of the user crud service * @param userPasswordService - instance of user password service */ @@ -78,7 +77,6 @@ export class UserController /** * Get many - * * @param crudRequest - the CRUD request object */ @CrudReadMany() @@ -89,7 +87,6 @@ export class UserController /** * Get one - * * @param crudRequest - the CRUD request object */ @CrudReadOne() @@ -100,7 +97,6 @@ export class UserController /** * Create many - * * @param crudRequest - the CRUD request object * @param userCreateManyDto - user create many dto */ @@ -125,7 +121,6 @@ export class UserController /** * Create one - * * @param crudRequest - the CRUD request object * @param userCreateDto - user create dto */ @@ -144,7 +139,6 @@ export class UserController /** * Update one - * * @param crudRequest - the CRUD request object * @param userUpdateDto - user update dto */ @@ -173,7 +167,6 @@ export class UserController /** * Delete one - * * @param crudRequest - the CRUD request object */ @CrudDeleteOne() @@ -184,7 +177,6 @@ export class UserController /** * Recover one - * * @param crudRequest - the CRUD request object */ @CrudRecoverOne() diff --git a/packages/nestjs-user/src/user.seeder.ts b/packages/nestjs-user/src/user.seeder.ts index 97814c5e9..df4f6bb79 100644 --- a/packages/nestjs-user/src/user.seeder.ts +++ b/packages/nestjs-user/src/user.seeder.ts @@ -44,7 +44,6 @@ export class UserSeeder extends Seeder { /** * Set a password for the given user. - * * @param user - Object implementing the required interface. * @param password - The password to set. */ diff --git a/packages/ts-common/src/cache/interfaces/cache-clear.interface.ts b/packages/ts-common/src/cache/interfaces/cache-clear.interface.ts index 4a664eb79..3a5fa0c00 100644 --- a/packages/ts-common/src/cache/interfaces/cache-clear.interface.ts +++ b/packages/ts-common/src/cache/interfaces/cache-clear.interface.ts @@ -9,7 +9,6 @@ export interface CacheClearInterface< > { /** * Clear all caches for assign in given category. - * * @param assignment - The assignment of the repository * @param cache - The cache to clear */ diff --git a/packages/ts-common/src/cache/interfaces/cache-create.interface.ts b/packages/ts-common/src/cache/interfaces/cache-create.interface.ts index 406ceaa45..d684050e2 100644 --- a/packages/ts-common/src/cache/interfaces/cache-create.interface.ts +++ b/packages/ts-common/src/cache/interfaces/cache-create.interface.ts @@ -11,7 +11,6 @@ export interface CacheCreateInterface< > { /** * Create a cache with a for the given assignee. - * * @param assignment - The cache assignment * @param cache - The CACHE to create */ diff --git a/packages/ts-common/src/otp/interfaces/otp-clear.interface.ts b/packages/ts-common/src/otp/interfaces/otp-clear.interface.ts index 0c0d1fd4e..158d1abab 100644 --- a/packages/ts-common/src/otp/interfaces/otp-clear.interface.ts +++ b/packages/ts-common/src/otp/interfaces/otp-clear.interface.ts @@ -9,7 +9,6 @@ export interface OtpClearInterface< > { /** * Clear all otps for assign in given category. - * * @param assignment - The assignment of the repository * @param otp - The otp to clear */ diff --git a/packages/ts-common/src/otp/interfaces/otp-create.interface.ts b/packages/ts-common/src/otp/interfaces/otp-create.interface.ts index 999926031..762a9146a 100644 --- a/packages/ts-common/src/otp/interfaces/otp-create.interface.ts +++ b/packages/ts-common/src/otp/interfaces/otp-create.interface.ts @@ -11,7 +11,6 @@ export interface OtpCreateInterface< > { /** * Create a otp with a for the given assignee. - * * @param assignment - The otp assignment * @param otp - The OTP to create */ diff --git a/packages/ts-common/src/otp/interfaces/otp-delete.interface.ts b/packages/ts-common/src/otp/interfaces/otp-delete.interface.ts index d80c3e840..1bd7ab8c2 100644 --- a/packages/ts-common/src/otp/interfaces/otp-delete.interface.ts +++ b/packages/ts-common/src/otp/interfaces/otp-delete.interface.ts @@ -9,7 +9,6 @@ export interface OtpDeleteInterface< > { /** * Delete a otp based on params - * * @param assignment - The otp assignment * @param otp - The otp to delete */ diff --git a/packages/ts-common/src/otp/interfaces/otp-validate.interface.ts b/packages/ts-common/src/otp/interfaces/otp-validate.interface.ts index 9470f3e6d..dc5ff0279 100644 --- a/packages/ts-common/src/otp/interfaces/otp-validate.interface.ts +++ b/packages/ts-common/src/otp/interfaces/otp-validate.interface.ts @@ -10,7 +10,6 @@ export interface OtpValidateInterface< > { /** * Check if otp is valid - * * @param assignment - The otp assignment * @param otp - The otp to validate * @param deleteIfValid - If true, delete the otp if it is valid diff --git a/packages/ts-core/src/references/interfaces/reference-id.interface.ts b/packages/ts-core/src/references/interfaces/reference-id.interface.ts index 9ccfb7d7d..f5fde8b57 100644 --- a/packages/ts-core/src/references/interfaces/reference-id.interface.ts +++ b/packages/ts-core/src/references/interfaces/reference-id.interface.ts @@ -2,7 +2,6 @@ import { ReferenceId } from '../reference.types'; /** * Identifiable by id. - * * @see https://en.wikipedia.org/wiki/Reference_(computer_science) */ export interface ReferenceIdInterface { diff --git a/packages/typeorm-common/src/services/base.service.ts b/packages/typeorm-common/src/services/base.service.ts index 5cd2c1ef4..7eeb9bb05 100644 --- a/packages/typeorm-common/src/services/base.service.ts +++ b/packages/typeorm-common/src/services/base.service.ts @@ -16,7 +16,6 @@ export abstract class BaseService { /** * Constructor - * * @param repo - instance of the repo */ constructor(private repo: Repository) { @@ -25,7 +24,6 @@ export abstract class BaseService { /** * Find One wrapper. - * * @param findOneOptions - Find options * @param queryOptions - Query options */ @@ -44,7 +42,6 @@ export abstract class BaseService { /** * Return the correct repository instance. - * * @param queryOptions - Options */ public repository(queryOptions?: QueryOptionsInterface): Repository { @@ -53,7 +50,6 @@ export abstract class BaseService { /** * Return a transaction instance. - * * @param options - Options */ public transaction( diff --git a/packages/typeorm-common/src/services/lookup.service.ts b/packages/typeorm-common/src/services/lookup.service.ts index 507f1f9c0..89a7963b5 100644 --- a/packages/typeorm-common/src/services/lookup.service.ts +++ b/packages/typeorm-common/src/services/lookup.service.ts @@ -16,7 +16,6 @@ export abstract class LookupService { /** * Constructor - * * @param repo - instance of the repo */ constructor(repo: Repository) { @@ -25,7 +24,6 @@ export abstract class LookupService /** * Get entity for the given id. - * * @param id - the id * @param queryOptions - query options */ diff --git a/packages/typeorm-common/src/services/mutate.service.ts b/packages/typeorm-common/src/services/mutate.service.ts index 635c98283..c0ab1e3fc 100644 --- a/packages/typeorm-common/src/services/mutate.service.ts +++ b/packages/typeorm-common/src/services/mutate.service.ts @@ -38,7 +38,6 @@ export abstract class MutateService< /** * Constructor - * * @param repo - instance of the repo */ constructor(repo: Repository) { @@ -47,7 +46,6 @@ export abstract class MutateService< /** * Create one - * * @param data - the reference to create * @returns the created reference */ @@ -67,7 +65,6 @@ export abstract class MutateService< /** * Update one - * * @param data - the reference data to update * @returns the updated reference */ @@ -92,7 +89,6 @@ export abstract class MutateService< /** * Replace one - * * @param data - the reference data to replace * @returns the replaced reference */ @@ -117,7 +113,6 @@ export abstract class MutateService< /** * Remove one - * * @param data - the reference data to remove * @param queryOptions - query options * @returns the removed reference diff --git a/packages/typeorm-common/src/utils/safe-transaction.util.ts b/packages/typeorm-common/src/utils/safe-transaction.util.ts index 534100d55..9b80032f7 100644 --- a/packages/typeorm-common/src/utils/safe-transaction.util.ts +++ b/packages/typeorm-common/src/utils/safe-transaction.util.ts @@ -12,7 +12,6 @@ import { RunInTransactionCallback } from '../typeorm-common.types'; * To silently ignore drivers that don't support transactions, set strict mode to false. * In this case, your `runInTransaction` callback will receive `undefined` for the value * of `entityManager`. - * * @param entityManager - Entity manager instance * @param runInTransaction - Transaction callback * @param options - Options diff --git a/yarn.lock b/yarn.lock index 07698a573..b09655bf0 100644 --- a/yarn.lock +++ b/yarn.lock @@ -536,6 +536,18 @@ eslint-module-utils "2.8.0" reflect-metadata "0.1.13" +"@es-joy/jsdoccomment@~0.43.1": + version "0.43.1" + resolved "https://registry.yarnpkg.com/@es-joy/jsdoccomment/-/jsdoccomment-0.43.1.tgz#4b1979b7b4ff8b596fb19a3aa696a438e44608d7" + integrity sha512-I238eDtOolvCuvtxrnqtlBaw0BwdQuYqK7eA6XIonicMdOOOb75mqdIzkGDUbS04+1Di007rgm9snFRNeVrOog== + dependencies: + "@types/eslint" "^8.56.5" + "@types/estree" "^1.0.5" + "@typescript-eslint/types" "^7.2.0" + comment-parser "1.4.1" + esquery "^1.5.0" + jsdoc-type-pratt-parser "~4.0.0" + "@eslint-community/eslint-utils@^4.2.0", "@eslint-community/eslint-utils@^4.4.0": version "4.4.0" resolved "https://registry.yarnpkg.com/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz#a23514e8fb9af1269d5f7788aa556798d61c6b59" @@ -2062,6 +2074,11 @@ resolved "https://registry.yarnpkg.com/@pkgjs/parseargs/-/parseargs-0.11.0.tgz#a77ea742fab25775145434eb1d2328cf5013ac33" integrity sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg== +"@pkgr/core@^0.1.0": + version "0.1.1" + resolved "https://registry.yarnpkg.com/@pkgr/core/-/core-0.1.1.tgz#1ec17e2edbec25c8306d424ecfbf13c7de1aaa31" + integrity sha512-cq8o4cWH0ibXh9VGi5P20Tu9XF/0fFXl9EUinr9QfTM7a7p0oTA4iJRCQWppXR1Pg8dSM0UCItCkPwsk9qWWYA== + "@selderee/plugin-htmlparser2@^0.11.0": version "0.11.0" resolved "https://registry.yarnpkg.com/@selderee/plugin-htmlparser2/-/plugin-htmlparser2-0.11.0.tgz#d5b5e29a7ba6d3958a1972c7be16f4b2c188c517" @@ -2251,11 +2268,24 @@ "@types/estree" "*" "@types/json-schema" "*" +"@types/eslint@^8.56.5": + version "8.56.10" + resolved "https://registry.yarnpkg.com/@types/eslint/-/eslint-8.56.10.tgz#eb2370a73bf04a901eeba8f22595c7ee0f7eb58d" + integrity sha512-Shavhk87gCtY2fhXDctcfS3e6FdxWkCx1iUZ9eEUbh7rTqlZT0/IzOkCOVt0fCjcFuZ9FPYfuezTBImfHCDBGQ== + dependencies: + "@types/estree" "*" + "@types/json-schema" "*" + "@types/estree@*", "@types/estree@^1.0.0": version "1.0.1" resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.1.tgz#aa22750962f3bf0e79d753d3cc067f010c95f194" integrity sha512-LG4opVs2ANWZ1TJoKc937iMmNstM/d0ae1vNbnBvBhqCSezgVUOzcLCqbI5elV8Vy6WKwKjaqR+zO9VKirBBCA== +"@types/estree@^1.0.5": + version "1.0.5" + resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.5.tgz#a6ce3e556e00fd9895dd872dd172ad0d4bd687f4" + integrity sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw== + "@types/express-serve-static-core@^4.17.33": version "4.17.35" resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-4.17.35.tgz#c95dd4424f0d32e525d23812aa8ab8e4d3906c4f" @@ -2640,6 +2670,11 @@ resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-6.14.0.tgz#935307f7a931016b7a5eb25d494ea3e1f613e929" integrity sha512-uty9H2K4Xs8E47z3SnXEPRNDfsis8JO27amp2GNCnzGETEW3yTqEIVg5+AI7U276oGF/tw6ZA+UesxeQ104ceA== +"@typescript-eslint/types@^7.2.0": + version "7.15.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-7.15.0.tgz#fb894373a6e3882cbb37671ffddce44f934f62fc" + integrity sha512-aV1+B1+ySXbQH0pLK0rx66I3IkiZNidYobyfn0WFsdGhSXw+P3YOqeTq5GED458SfB24tg+ux3S+9g118hjlTw== + "@typescript-eslint/typescript-estree@5.62.0": version "5.62.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-5.62.0.tgz#7d17794b77fabcac615d6a48fb143330d962eb9b" @@ -3119,6 +3154,11 @@ archy@^1.0.0: resolved "https://registry.yarnpkg.com/archy/-/archy-1.0.0.tgz#f9c8c13757cc1dd7bc379ac77b2c62a5c2868c40" integrity sha512-Xg+9RwCg/0p32teKdGMPTPnVXKD0w3DfHnFTficozsAgsvq2XenPJq/MYpzzQ/v8zrOyJn6Ds39VA4JIDwFfqw== +are-docs-informative@^0.0.2: + version "0.0.2" + resolved "https://registry.yarnpkg.com/are-docs-informative/-/are-docs-informative-0.0.2.tgz#387f0e93f5d45280373d387a59d34c96db321963" + integrity sha512-ixiS0nLNNG5jNQzgZJNoUpBKdo9yTYZMGJ+QgT2jmjR7G7+QHRCc4v6LQ3NgE7EBJq+o0ams3waJwkrlBom8Ig== + are-we-there-yet@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/are-we-there-yet/-/are-we-there-yet-2.0.0.tgz#372e0e7bd279d8e94c653aaa1f67200884bf3e1c" @@ -4152,6 +4192,11 @@ commander@^6.1.0: resolved "https://registry.yarnpkg.com/commander/-/commander-6.2.1.tgz#0792eb682dfbc325999bb2b84fddddba110ac73c" integrity sha512-U7VdrJFnJgo4xjrHpTzu0yrHPGImdsmD95ZlgYSEajAn2JKzDhDTPG9kBTefmObL2w/ngeZnilk+OV9CG3d7UA== +comment-parser@1.4.1: + version "1.4.1" + resolved "https://registry.yarnpkg.com/comment-parser/-/comment-parser-1.4.1.tgz#bdafead37961ac079be11eb7ec65c4d021eaf9cc" + integrity sha512-buhp5kePrmda3vhc5B9t7pUQXAb2Tnd0qgpkIhPhkHXxJpiPJ11H0ZEU0oBpJ2QztSbzG/ZxMj/CHsYJqRHmyg== + compare-func@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/compare-func/-/compare-func-2.0.0.tgz#fb65e75edbddfd2e568554e8b5b05fff7a51fcb3" @@ -5205,6 +5250,11 @@ es-module-lexer@^1.2.1: resolved "https://registry.yarnpkg.com/es-module-lexer/-/es-module-lexer-1.3.0.tgz#6be9c9e0b4543a60cd166ff6f8b4e9dae0b0c16f" integrity sha512-vZK7T0N2CBmBOixhmjdqx2gWVbFZ4DXZ/NyRMZVlJXPa7CyFS+/a4QQsDGDQy9ZfEzxFuNEsMLeQJnKP2p5/JA== +es-module-lexer@^1.5.3: + version "1.5.4" + resolved "https://registry.yarnpkg.com/es-module-lexer/-/es-module-lexer-1.5.4.tgz#a8efec3a3da991e60efa6b633a7cad6ab8d26b78" + integrity sha512-MVNK56NiMrOwitFB7cqDwq0CQutbw+0BvLshJSse0MUNU+y1FC3bUS/AQg7oUng+/wKrrki7JfmwtVHkVfPLlw== + es-set-tostringtag@^2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/es-set-tostringtag/-/es-set-tostringtag-2.0.1.tgz#338d502f6f674301d710b80c8592de8a15f09cd8" @@ -5353,6 +5403,22 @@ eslint-plugin-import@^2.25.4: semver "^6.3.1" tsconfig-paths "^3.14.2" +eslint-plugin-jsdoc@^48.5.0: + version "48.5.0" + resolved "https://registry.yarnpkg.com/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-48.5.0.tgz#24e2026d1e7ba97214ee21bb16fd5162cd6487c8" + integrity sha512-ukXPNpGby3KjCveCizIS8t1EbuJEHYEu/tBg8GCbn/YbHcXwphyvYCdvRZ/oMRfTscGSSzfsWoZ+ZkAP0/6YMQ== + dependencies: + "@es-joy/jsdoccomment" "~0.43.1" + are-docs-informative "^0.0.2" + comment-parser "1.4.1" + debug "^4.3.4" + escape-string-regexp "^4.0.0" + esquery "^1.5.0" + parse-imports "^2.1.0" + semver "^7.6.2" + spdx-expression-parse "^4.0.0" + synckit "^0.9.0" + eslint-plugin-node@^11.1.0: version "11.1.0" resolved "https://registry.yarnpkg.com/eslint-plugin-node/-/eslint-plugin-node-11.1.0.tgz#c95544416ee4ada26740a30474eefc5402dc671d" @@ -5475,7 +5541,7 @@ esprima@^4.0.0, esprima@^4.0.1: resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71" integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== -esquery@^1.4.2: +esquery@^1.4.2, esquery@^1.5.0: version "1.5.0" resolved "https://registry.yarnpkg.com/esquery/-/esquery-1.5.0.tgz#6ce17738de8577694edd7361c57182ac8cb0db0b" integrity sha512-YQLXUplAwJgCydQ78IMJywZCceoqk1oH01OERdSAJc/7U2AylwjhSCLDEtqwg811idIS/9fIU5GjG73IgjKMVg== @@ -8061,6 +8127,11 @@ jsbn@~0.1.0: resolved "https://registry.yarnpkg.com/jsbn/-/jsbn-0.1.1.tgz#a5e654c2e5a2deb5f201d96cefbca80c0ef2f513" integrity sha512-UVU9dibq2JcFWxQPA6KCqj5O42VOmAY3zQUfEKxU0KpTGXwNoCjkX1e13eHNvw/xPynt6pU0rZ1htjWTNTSXsg== +jsdoc-type-pratt-parser@~4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz#136f0571a99c184d84ec84662c45c29ceff71114" + integrity sha512-YtOli5Cmzy3q4dP26GraSOeAhqecewG04hoO8DY56CH4KJ9Fvv5qKWUCCo3HZob7esJQHCv6/+bnTy72xZZaVQ== + jsdom@^16.6.0: version "16.7.0" resolved "https://registry.yarnpkg.com/jsdom/-/jsdom-16.7.0.tgz#918ae71965424b197c819f8183a754e18977b710" @@ -10180,6 +10251,14 @@ parse-github-repo-url@^1.3.0: resolved "https://registry.yarnpkg.com/parse-github-repo-url/-/parse-github-repo-url-1.4.1.tgz#9e7d8bb252a6cb6ba42595060b7bf6df3dbc1f50" integrity sha512-bSWyzBKqcSL4RrncTpGsEKoJ7H8a4L3++ifTAbTFeMHyq2wRV+42DGmQcHIrJIvdcacjIOxEuKH/w4tthF17gg== +parse-imports@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/parse-imports/-/parse-imports-2.1.0.tgz#22a152f4503da34e8fb89c902383895f59e93d2d" + integrity sha512-JQWgmK2o4w8leUkZeZPatWdAny6vXGU/3siIUvMF6J2rDCud9aTt8h/px9oZJ6U3EcfhngBJ635uPFI0q0VAeA== + dependencies: + es-module-lexer "^1.5.3" + slashes "^3.0.12" + parse-json@^2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/parse-json/-/parse-json-2.2.0.tgz#f480f40434ef80741f8469099f8dea18f55a4dc9" @@ -11507,6 +11586,11 @@ semver@^6.0.0, semver@^6.1.0, semver@^6.2.0, semver@^6.3.0, semver@^6.3.1: resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.1.tgz#556d2ef8689146e46dcea4bfdd095f3434dffcb4" integrity sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA== +semver@^7.6.2: + version "7.6.2" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.6.2.tgz#1e3b34759f896e8f14d6134732ce798aeb0c6e13" + integrity sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w== + send@0.18.0: version "0.18.0" resolved "https://registry.yarnpkg.com/send/-/send-0.18.0.tgz#670167cc654b05f5aa4a767f9113bb371bc706be" @@ -11660,6 +11744,11 @@ slash@^3.0.0: resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634" integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q== +slashes@^3.0.12: + version "3.0.12" + resolved "https://registry.yarnpkg.com/slashes/-/slashes-3.0.12.tgz#3d664c877ad542dc1509eaf2c50f38d483a6435a" + integrity sha512-Q9VME8WyGkc7pJf6QEkj3wE+2CnvZMI+XJhwdTPR8Z/kWQRXi7boAWLDibRPyHRTUTPx5FaU7MsyrjI3yLB4HA== + slick@^1.12.2: version "1.12.2" resolved "https://registry.yarnpkg.com/slick/-/slick-1.12.2.tgz#bd048ddb74de7d1ca6915faa4a57570b3550c2d7" @@ -11820,6 +11909,14 @@ spdx-expression-parse@^3.0.0: spdx-exceptions "^2.1.0" spdx-license-ids "^3.0.0" +spdx-expression-parse@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/spdx-expression-parse/-/spdx-expression-parse-4.0.0.tgz#a23af9f3132115465dac215c099303e4ceac5794" + integrity sha512-Clya5JIij/7C6bRR22+tnGXbc4VKlibKSVj2iHvVeX5iMW7s1SIQlqu699JkODJJIhh/pUu8L0/VLh8xflD+LQ== + dependencies: + spdx-exceptions "^2.1.0" + spdx-license-ids "^3.0.0" + spdx-license-ids@^3.0.0: version "3.0.13" resolved "https://registry.yarnpkg.com/spdx-license-ids/-/spdx-license-ids-3.0.13.tgz#7189a474c46f8d47c7b0da4b987bb45e908bd2d5" @@ -12264,6 +12361,14 @@ symbol-tree@^3.2.4: resolved "https://registry.yarnpkg.com/symbol-tree/-/symbol-tree-3.2.4.tgz#430637d248ba77e078883951fb9aa0eed7c63fa2" integrity sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw== +synckit@^0.9.0: + version "0.9.0" + resolved "https://registry.yarnpkg.com/synckit/-/synckit-0.9.0.tgz#5b33b458b3775e4466a5b377fba69c63572ae449" + integrity sha512-7RnqIMq572L8PeEzKeBINYEJDDxpcH8JEgLwUqBd3TkofhFRbkq4QLR0u+36avGAhCRbk2nnmjcW9SE531hPDg== + dependencies: + "@pkgr/core" "^0.1.0" + tslib "^2.6.2" + tapable@^2.1.1, tapable@^2.2.0, tapable@^2.2.1: version "2.2.1" resolved "https://registry.yarnpkg.com/tapable/-/tapable-2.2.1.tgz#1967a73ef4060a82f12ab96af86d52fdb76eeca0" @@ -12640,6 +12745,11 @@ tslib@^2.0.1, tslib@^2.1.0, tslib@^2.5.0: resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.6.1.tgz#fd8c9a0ff42590b25703c0acb3de3d3f4ede0410" integrity sha512-t0hLfiEKfMUoqhG+U1oid7Pva4bbDPHYfJNiB7BiIjRkj1pyC++4N3huJfqY6aRH6VTB0rvtzQwjM4K6qpfOig== +tslib@^2.6.2: + version "2.6.3" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.6.3.tgz#0438f810ad7a9edcde7a241c3d80db693c8cbfe0" + integrity sha512-xNvxJEOUiWPGhUuUdQgAJPKOOJfGnIyKySOc09XkKsgdUV/3E2zvwZYdejjmRgPCgcym1juLH3226yA7sEFJKQ== + tsutils@^3.21.0: version "3.21.0" resolved "https://registry.yarnpkg.com/tsutils/-/tsutils-3.21.0.tgz#b48717d394cea6c1e096983eed58e9d61715b623" From f6b7c8dbd492228af59ffe0639fa634a85f99780 Mon Sep 17 00:00:00 2001 From: Marshall Sorenson Date: Wed, 3 Jul 2024 19:45:17 -0400 Subject: [PATCH 2/2] feat: jsdoc lint, enforce one line after description block --- .eslintrc.js | 4 +++- .../decorators/access-control-create-many.decorator.ts | 1 + .../src/decorators/access-control-create-one.decorator.ts | 1 + .../src/decorators/access-control-delete-one.decorator.ts | 1 + .../src/decorators/access-control-grant.decorator.ts | 1 + .../src/decorators/access-control-query.decorator.ts | 1 + .../src/decorators/access-control-read-many.decorator.ts | 1 + .../src/decorators/access-control-read-one.decorator.ts | 1 + .../decorators/access-control-recover-one.decorator.ts | 1 + .../decorators/access-control-replace-one.decorator.ts | 1 + .../src/decorators/access-control-update-one.decorator.ts | 1 + packages/nestjs-auth-jwt/src/auth-jwt.strategy.ts | 1 + packages/nestjs-auth-local/src/auth-local.strategy.ts | 1 + .../src/services/auth-recovery.service.ts | 5 +++++ packages/nestjs-auth-refresh/src/auth-refresh.strategy.ts | 1 + .../src/services/issue-token.service.ts | 1 + .../src/services/verify-token.service.ts | 1 + .../nestjs-cache/src/controllers/cache-crud.controller.ts | 8 ++++++++ packages/nestjs-cache/src/services/cache-crud.service.ts | 1 + packages/nestjs-cache/src/services/cache.service.ts | 6 ++++++ .../controller/crud-init-api-query.decorator.ts | 1 + .../src/decorators/routes/crud-validate.decorator.ts | 1 + packages/nestjs-event/src/events/event.ts | 6 ++++++ packages/nestjs-event/src/listeners/event-listener-on.ts | 2 ++ packages/nestjs-event/src/listeners/event-listener.ts | 1 + .../src/listeners/interfaces/event-listener.interface.ts | 2 ++ .../nestjs-event/src/services/event-dispatch.service.ts | 3 +++ .../nestjs-event/src/services/event-listen.service.ts | 2 ++ .../nestjs-exception/src/utils/map-http-status.util.ts | 1 + .../src/services/federated-mutate.service.ts | 1 + .../src/services/federated-oauth.service.ts | 4 ++++ .../src/services/invitation-acceptance.service.ts | 3 +++ .../src/services/invitation-revocation.service.ts | 3 +++ .../nestjs-invitation/src/services/invitation.service.ts | 1 + packages/nestjs-logger/src/config/logger.config.ts | 1 + .../src/interfaces/logger-service.interface.ts | 7 +++++++ .../src/interfaces/logger-transport.interface.ts | 1 + packages/nestjs-logger/src/logger-exception.filter.ts | 2 ++ packages/nestjs-logger/src/logger-request.interceptor.ts | 4 ++++ packages/nestjs-logger/src/logger-transport.service.ts | 3 +++ packages/nestjs-logger/src/logger.service.ts | 8 ++++++++ .../src/transports/logger-sentry.transport.ts | 2 ++ packages/nestjs-logger/src/utils/config-parser.util.ts | 1 + packages/nestjs-logger/src/utils/message-format.util.ts | 3 +++ packages/nestjs-org/src/org.controller.ts | 8 ++++++++ packages/nestjs-org/src/services/org-crud.service.ts | 1 + packages/nestjs-org/src/services/org-lookup.service.ts | 2 ++ packages/nestjs-org/src/services/org-mutate.service.ts | 1 + packages/nestjs-otp/src/services/otp.service.ts | 7 +++++++ .../src/interfaces/password-creation-service.interface.ts | 4 ++++ .../src/interfaces/password-storage-service.interface.ts | 2 ++ .../src/interfaces/password-strength-service.interface.ts | 1 + .../interfaces/password-validation-service.interface.ts | 2 ++ .../src/services/password-creation.service.ts | 5 +++++ .../src/services/password-storage.service.ts | 4 ++++ .../src/services/password-strength.service.ts | 1 + packages/nestjs-password/src/utils/crypt.util.ts | 2 ++ .../nestjs-role/src/interfaces/role-service.interface.ts | 3 +++ packages/nestjs-role/src/role-assignment.controller.ts | 7 +++++++ packages/nestjs-role/src/role.controller.ts | 7 +++++++ .../src/services/role-assignment-crud.service.ts | 1 + packages/nestjs-role/src/services/role-crud.service.ts | 1 + packages/nestjs-role/src/services/role-lookup.service.ts | 1 + packages/nestjs-role/src/services/role-mutate.service.ts | 1 + packages/nestjs-role/src/services/role.service.ts | 4 ++++ packages/nestjs-swagger-ui/src/swagger-ui.service.ts | 2 ++ .../src/utils/create-dynamic-repository-provider.ts | 1 + .../src/utils/create-entity-repository-provider.ts | 1 + .../src/interfaces/user-password-service.interface.ts | 2 ++ packages/nestjs-user/src/services/user-crud.service.ts | 1 + packages/nestjs-user/src/services/user-lookup.service.ts | 4 ++++ packages/nestjs-user/src/services/user-mutate.service.ts | 1 + .../nestjs-user/src/services/user-password.service.ts | 1 + packages/nestjs-user/src/user.controller.ts | 8 ++++++++ packages/nestjs-user/src/user.seeder.ts | 1 + .../src/cache/interfaces/cache-clear.interface.ts | 1 + .../src/cache/interfaces/cache-create.interface.ts | 1 + .../src/cache/interfaces/cache-delete.interface.ts | 1 + .../src/cache/interfaces/cache-get-one.interface.ts | 1 + .../src/cache/interfaces/cache-update.interface.ts | 1 + .../ts-common/src/otp/interfaces/otp-clear.interface.ts | 1 + .../ts-common/src/otp/interfaces/otp-create.interface.ts | 1 + .../ts-common/src/otp/interfaces/otp-delete.interface.ts | 1 + .../src/otp/interfaces/otp-validate.interface.ts | 1 + .../src/references/interfaces/reference-id.interface.ts | 1 + packages/typeorm-common/src/services/base.service.ts | 4 ++++ packages/typeorm-common/src/services/lookup.service.ts | 2 ++ packages/typeorm-common/src/services/mutate.service.ts | 5 +++++ .../typeorm-common/src/utils/safe-transaction.util.ts | 1 + 89 files changed, 210 insertions(+), 1 deletion(-) diff --git a/.eslintrc.js b/.eslintrc.js index a17f5c622..b16c5637f 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -31,7 +31,8 @@ module.exports = { rules: { 'import/no-extraneous-dependencies': 'error', '@darraghor/nestjs-typed/param-decorator-name-matches-route-param': 'off', - 'tsdoc/syntax': 'warn', + 'jsdoc/tag-lines': ['error', 'any', { startLines: 1 }], + 'tsdoc/syntax': 'error', }, overrides: [ { @@ -55,6 +56,7 @@ module.exports = { '@darraghor/nestjs-typed/controllers-should-supply-api-tags': 'off', '@darraghor/nestjs-typed/api-method-should-specify-api-response': 'off', 'plugin:jsdoc/recommended-typescript': 'off', + 'jsdoc/tag-lines': 'off', 'tsdoc/syntax': 'off', }, }, diff --git a/packages/nestjs-access-control/src/decorators/access-control-create-many.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-create-many.decorator.ts index f65bfb0c2..98b35d2ac 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-create-many.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-create-many.decorator.ts @@ -2,6 +2,7 @@ import { AccessControlCreateOne } from './access-control-create-one.decorator'; /** * Create many resource grant shortcut. + * * @param resource - The grant resource. */ export const AccessControlCreateMany = (resource: string) => diff --git a/packages/nestjs-access-control/src/decorators/access-control-create-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-create-one.decorator.ts index 520cfe959..fea99f716 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-create-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-create-one.decorator.ts @@ -4,6 +4,7 @@ import { applyDecorators } from '@nestjs/common'; /** * Create one resource grant shortcut. + * * @param resource - The grant resource. * @returns Decorator function */ diff --git a/packages/nestjs-access-control/src/decorators/access-control-delete-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-delete-one.decorator.ts index aeaeccbc1..80374d2b7 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-delete-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-delete-one.decorator.ts @@ -4,6 +4,7 @@ import { ActionEnum } from '../enums/action.enum'; /** * Delete one resource grant shortcut. + * * @param resource - The grant resource. * @returns Decorator function */ diff --git a/packages/nestjs-access-control/src/decorators/access-control-grant.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-grant.decorator.ts index 4503d9699..922a171e5 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-grant.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-grant.decorator.ts @@ -4,6 +4,7 @@ import { ACCESS_CONTROL_MODULE_GRANT_METADATA } from '../constants'; /** * Define access control grants required for this route. + * * @param acGrants - Array of access control grants. * @returns Decorator function. */ diff --git a/packages/nestjs-access-control/src/decorators/access-control-query.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-query.decorator.ts index 1ba8cae0f..25b2a4572 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-query.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-query.decorator.ts @@ -4,6 +4,7 @@ import { ACCESS_CONTROL_MODULE_QUERY_METADATA } from '../constants'; /** * Define access query options for this route. + * * @param queryOptions - Array of access control query options. * @returns Decorator function. */ diff --git a/packages/nestjs-access-control/src/decorators/access-control-read-many.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-read-many.decorator.ts index 7030bab49..82fd7075b 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-read-many.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-read-many.decorator.ts @@ -4,6 +4,7 @@ import { AccessControlGrant } from './access-control-grant.decorator'; /** * Read many resource grant shortcut. + * * @param resource - The grant resource. * @returns Decorator function */ diff --git a/packages/nestjs-access-control/src/decorators/access-control-read-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-read-one.decorator.ts index bbea7067e..52fa28e6c 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-read-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-read-one.decorator.ts @@ -4,6 +4,7 @@ import { AccessControlGrant } from './access-control-grant.decorator'; /** * Read one resource grant shortcut + * * @param resource - The grant resource. * @returns Decorator function */ diff --git a/packages/nestjs-access-control/src/decorators/access-control-recover-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-recover-one.decorator.ts index 874965546..c2c735eee 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-recover-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-recover-one.decorator.ts @@ -2,6 +2,7 @@ import { AccessControlCreateOne } from './access-control-create-one.decorator'; /** * Recover one resource grant shortcut. + * * @param resource - The grant resource. */ export const AccessControlRecoverOne = (resource: string) => diff --git a/packages/nestjs-access-control/src/decorators/access-control-replace-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-replace-one.decorator.ts index 232feadc9..f53c7054a 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-replace-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-replace-one.decorator.ts @@ -2,6 +2,7 @@ import { AccessControlUpdateOne } from './access-control-update-one.decorator'; /** * Update one resource grant shortcut. + * * @param resource - The grant resource. */ export const AccessControlReplaceOne = (resource: string) => diff --git a/packages/nestjs-access-control/src/decorators/access-control-update-one.decorator.ts b/packages/nestjs-access-control/src/decorators/access-control-update-one.decorator.ts index ac65234f0..e82f2a04d 100644 --- a/packages/nestjs-access-control/src/decorators/access-control-update-one.decorator.ts +++ b/packages/nestjs-access-control/src/decorators/access-control-update-one.decorator.ts @@ -4,6 +4,7 @@ import { AccessControlGrant } from './access-control-grant.decorator'; /** * Update one resource grant shortcut. + * * @param resource - The grant resource. * @returns Decorator function */ diff --git a/packages/nestjs-auth-jwt/src/auth-jwt.strategy.ts b/packages/nestjs-auth-jwt/src/auth-jwt.strategy.ts index c54cbabd1..2c73f2799 100644 --- a/packages/nestjs-auth-jwt/src/auth-jwt.strategy.ts +++ b/packages/nestjs-auth-jwt/src/auth-jwt.strategy.ts @@ -45,6 +45,7 @@ export class AuthJwtStrategy extends PassportStrategyFactory( /** * Validate the user based on payload sub + * * @param payload - The payload to validate */ async validate( diff --git a/packages/nestjs-auth-local/src/auth-local.strategy.ts b/packages/nestjs-auth-local/src/auth-local.strategy.ts index 20a8b0a0d..14429979e 100644 --- a/packages/nestjs-auth-local/src/auth-local.strategy.ts +++ b/packages/nestjs-auth-local/src/auth-local.strategy.ts @@ -48,6 +48,7 @@ export class AuthLocalStrategy extends PassportStrategyFactory( /** * Validate the user based on the username and password * from the request body + * * @param username - The username to authenticate * @param password - The plain text password */ diff --git a/packages/nestjs-auth-recovery/src/services/auth-recovery.service.ts b/packages/nestjs-auth-recovery/src/services/auth-recovery.service.ts index 601f06cfd..3382a7a44 100644 --- a/packages/nestjs-auth-recovery/src/services/auth-recovery.service.ts +++ b/packages/nestjs-auth-recovery/src/services/auth-recovery.service.ts @@ -40,6 +40,7 @@ export class AuthRecoveryService implements AuthRecoveryServiceInterface { /** * Recover lost username providing an email and send the username by email. + * * @param email - user email */ async recoverLogin( @@ -64,6 +65,7 @@ export class AuthRecoveryService implements AuthRecoveryServiceInterface { /** * Recover lost password providing an email and send the passcode token by email. + * * @param email - user email */ async recoverPassword( @@ -105,6 +107,7 @@ export class AuthRecoveryService implements AuthRecoveryServiceInterface { /** * Validate passcode and return it's user. + * * @param passcode - user's passcode * @param deleteIfValid - flag to delete if valid or not */ @@ -127,6 +130,7 @@ export class AuthRecoveryService implements AuthRecoveryServiceInterface { /** * Change user's password by providing it's OTP passcode and the new password. + * * @param passcode - OTP user's passcode * @param newPassword - new user password */ @@ -180,6 +184,7 @@ export class AuthRecoveryService implements AuthRecoveryServiceInterface { /** * Recover lost password providing an email and send the passcode token by email. + * * @param email - user email */ async revokeAllUserPasswordRecoveries( diff --git a/packages/nestjs-auth-refresh/src/auth-refresh.strategy.ts b/packages/nestjs-auth-refresh/src/auth-refresh.strategy.ts index e409f2646..b28205cdd 100644 --- a/packages/nestjs-auth-refresh/src/auth-refresh.strategy.ts +++ b/packages/nestjs-auth-refresh/src/auth-refresh.strategy.ts @@ -43,6 +43,7 @@ export class AuthRefreshStrategy extends PassportStrategyFactory( /** * Validate the user sub from the verified token + * * @param payload - Authorization payload */ async validate( diff --git a/packages/nestjs-authentication/src/services/issue-token.service.ts b/packages/nestjs-authentication/src/services/issue-token.service.ts index b00a995e1..6666494d2 100644 --- a/packages/nestjs-authentication/src/services/issue-token.service.ts +++ b/packages/nestjs-authentication/src/services/issue-token.service.ts @@ -25,6 +25,7 @@ export class IssueTokenService implements IssueTokenServiceInterface { /** * Generate the response payload. + * * @param id - user id or name for `sub` claim */ async responsePayload( diff --git a/packages/nestjs-authentication/src/services/verify-token.service.ts b/packages/nestjs-authentication/src/services/verify-token.service.ts index b60b0f324..20c17d29f 100644 --- a/packages/nestjs-authentication/src/services/verify-token.service.ts +++ b/packages/nestjs-authentication/src/services/verify-token.service.ts @@ -56,6 +56,7 @@ export class VerifyTokenService implements VerifyTokenServiceInterface { * Further validate the authenticity of a token. * * For example, You may want to check if it's id exists in a database or some other source. + * * @param payload - Payload object */ private async validateToken( diff --git a/packages/nestjs-cache/src/controllers/cache-crud.controller.ts b/packages/nestjs-cache/src/controllers/cache-crud.controller.ts index fff2ce64d..31df075cf 100644 --- a/packages/nestjs-cache/src/controllers/cache-crud.controller.ts +++ b/packages/nestjs-cache/src/controllers/cache-crud.controller.ts @@ -69,6 +69,7 @@ export class CacheCrudController { /** * Constructor. + * * @param settings - cache settings * @param allCrudServices - instances of all crud services * @param cacheService - instance of cache service @@ -83,6 +84,7 @@ export class CacheCrudController /** * Get many + * * @param crudRequest - the CRUD request object * @param assignment - the assignment */ @@ -97,6 +99,7 @@ export class CacheCrudController /** * Get one + * * @param crudRequest - the CRUD request object * @param assignment - The cache assignment */ @@ -111,6 +114,7 @@ export class CacheCrudController /** * Create one + * * @param crudRequest - the CRUD request object * @param cacheCreateDto - cache create dto * @param assignment - The cache assignment @@ -159,6 +163,7 @@ export class CacheCrudController /** * Create one + * * @param crudRequest - the CRUD request object * @param cacheUpdateDto - cache create dto * @param assignment - The cache assignment @@ -183,6 +188,7 @@ export class CacheCrudController /** * Delete one + * * @param crudRequest - the CRUD request object * @param assignment - The cache assignment */ @@ -197,6 +203,7 @@ export class CacheCrudController /** * Get the crud service for the given assignment. + * * @internal * @param assignment - The cache assignment */ @@ -214,6 +221,7 @@ export class CacheCrudController /** * Get the entity key for the given assignment. + * * @param assignment - The cache assignment */ protected getEntityKey(assignment: ReferenceAssignment): string { diff --git a/packages/nestjs-cache/src/services/cache-crud.service.ts b/packages/nestjs-cache/src/services/cache-crud.service.ts index 916fb0c00..5547abcbf 100644 --- a/packages/nestjs-cache/src/services/cache-crud.service.ts +++ b/packages/nestjs-cache/src/services/cache-crud.service.ts @@ -10,6 +10,7 @@ import { CacheInterface } from '@concepta/ts-common'; export class CacheCrudService extends TypeOrmCrudService { /** * Constructor + * * @param repo - instance of the cache repository. */ constructor(repo: Repository) { diff --git a/packages/nestjs-cache/src/services/cache.service.ts b/packages/nestjs-cache/src/services/cache.service.ts index 5cc6ac8cb..ac10b6172 100644 --- a/packages/nestjs-cache/src/services/cache.service.ts +++ b/packages/nestjs-cache/src/services/cache.service.ts @@ -34,6 +34,7 @@ export class CacheService implements CacheServiceInterface { /** * Create a cache with a for the given assignee. + * * @param assignment - The cache assignment * @param cache - The data to create */ @@ -118,6 +119,7 @@ export class CacheService implements CacheServiceInterface { /** * Delete a cache based on params + * * @param assignment - The cache assignment * @param cache - The cache to delete */ @@ -136,6 +138,7 @@ export class CacheService implements CacheServiceInterface { /** * Get all CACHEs for assignee. + * * @param assignment - The assignment of the check * @param cache - The cache to get assignments */ @@ -186,6 +189,7 @@ export class CacheService implements CacheServiceInterface { /** * Clear all caches for a given assignee. + * * @param assignment - The assignment of the repository * @param cache - The cache to clear */ @@ -212,6 +216,7 @@ export class CacheService implements CacheServiceInterface { /** * Delete CACHE based on assignment + * * @internal * @param assignment - The assignment to delete id from * @param id - The id or ids to delete @@ -287,6 +292,7 @@ export class CacheService implements CacheServiceInterface { /** * Get the assignment repo for the given assignment. + * * @internal * @param assignment - The cache assignment */ diff --git a/packages/nestjs-crud/src/decorators/controller/crud-init-api-query.decorator.ts b/packages/nestjs-crud/src/decorators/controller/crud-init-api-query.decorator.ts index 80a4ab4cc..eff228fae 100644 --- a/packages/nestjs-crud/src/decorators/controller/crud-init-api-query.decorator.ts +++ b/packages/nestjs-crud/src/decorators/controller/crud-init-api-query.decorator.ts @@ -79,6 +79,7 @@ export const CrudInitApiQuery = /** * Map crud action name to queryable base name. + * * @param action - The crud action we are mapping. */ function mapActionNameToQueryableBaseName( diff --git a/packages/nestjs-crud/src/decorators/routes/crud-validate.decorator.ts b/packages/nestjs-crud/src/decorators/routes/crud-validate.decorator.ts index 0966e8df0..78b8c7455 100644 --- a/packages/nestjs-crud/src/decorators/routes/crud-validate.decorator.ts +++ b/packages/nestjs-crud/src/decorators/routes/crud-validate.decorator.ts @@ -13,6 +13,7 @@ import { CrudValidationOptions } from '../../crud.types'; * * If this decorator is used on a method, it will use the given options for * every Crud parameter on the method that does NOT have validations explicitly set. + * * @param options - crud validation options */ export const CrudValidate = (options?: CrudValidationOptions) => diff --git a/packages/nestjs-event/src/events/event.ts b/packages/nestjs-event/src/events/event.ts index 15c3fb756..194f455b8 100644 --- a/packages/nestjs-event/src/events/event.ts +++ b/packages/nestjs-event/src/events/event.ts @@ -33,12 +33,14 @@ export abstract class Event

{ /** * Expects return of payload + * * @internal */ readonly expectsReturnOf!: R; /** * Event key. + * * @returns The event key string. */ static get key(): string { @@ -47,6 +49,7 @@ export abstract class Event

/** * Event key. + * * @returns The event key string. */ get key(): string { @@ -60,12 +63,14 @@ export abstract class Event

/** * Constructor + * * @param payload - Payload to emit when the event is dispatched. */ constructor(payload?: EventPayload

); /** * Constructor + * * @param payload - Payload to emit when the event is dispatched. */ constructor(payload: EventPayload

) { @@ -74,6 +79,7 @@ export abstract class Event

/** * Returns payload that was passed to the Event constructor. + * * @returns The event payload. */ get payload(): EventPayload

{ diff --git a/packages/nestjs-event/src/listeners/event-listener-on.ts b/packages/nestjs-event/src/listeners/event-listener-on.ts index f15163fd4..37cb7a1e8 100644 --- a/packages/nestjs-event/src/listeners/event-listener-on.ts +++ b/packages/nestjs-event/src/listeners/event-listener-on.ts @@ -41,6 +41,7 @@ export abstract class EventListenerOn { /** * Constructor + * * @param _options - Listener options */ constructor(private _options: EventListenOnOptionsInterface = {}) { @@ -49,6 +50,7 @@ export abstract class EventListenerOn /** * Default listener options. + * * @returns The default listener options. */ get options(): EventListenOnOptionsInterface { diff --git a/packages/nestjs-event/src/listeners/event-listener.ts b/packages/nestjs-event/src/listeners/event-listener.ts index 05569ab0d..c0b8f7e55 100644 --- a/packages/nestjs-event/src/listeners/event-listener.ts +++ b/packages/nestjs-event/src/listeners/event-listener.ts @@ -61,6 +61,7 @@ export abstract class EventListener implements EventListenerInterface { /** * Called after successful subscription. + * * @internal * @param emitterListener - The Listener object returned by EventEmitter2 */ diff --git a/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts b/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts index 3939a0b04..2652ce4fa 100644 --- a/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts +++ b/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts @@ -7,12 +7,14 @@ import { EventInstance, EventReturnType } from '../../event-types'; export interface EventListenerInterface { /** * Listener handler. + * * @param event - An event instance */ listen(event: EventInstance): EventReturnType; /** * Called after successful subscription. + * * @param emitterListener - The Listener object returned by EventEmitter2 */ subscription(emitterListener: EmitterListener): void; diff --git a/packages/nestjs-event/src/services/event-dispatch.service.ts b/packages/nestjs-event/src/services/event-dispatch.service.ts index e80cc2ab0..70e663662 100644 --- a/packages/nestjs-event/src/services/event-dispatch.service.ts +++ b/packages/nestjs-event/src/services/event-dispatch.service.ts @@ -14,6 +14,7 @@ import { EVENT_MODULE_EMITTER_SERVICE_TOKEN } from '../event-constants'; export class EventDispatchService { /** * Constructor + * * @param eventEmitter - Injected event emitter instance */ constructor( @@ -50,6 +51,7 @@ export class EventDispatchService { * } * } * ``` + * * @param event - The event being dispatched. * @returns boolean Returns true if the event had listeners, false otherwise. */ @@ -101,6 +103,7 @@ export class EventDispatchService { * } * } * ``` + * * @param event - The event being dispatched. * @returns An array of return payloads, one for each listener that subscribed to the event. */ diff --git a/packages/nestjs-event/src/services/event-listen.service.ts b/packages/nestjs-event/src/services/event-listen.service.ts index 0d7a8be11..918ae9326 100644 --- a/packages/nestjs-event/src/services/event-listen.service.ts +++ b/packages/nestjs-event/src/services/event-listen.service.ts @@ -20,6 +20,7 @@ import { EventInstance } from '../event-types'; export class EventListenService { /** * Constructor + * * @param eventEmitter - Injected event emitter instance */ constructor( @@ -57,6 +58,7 @@ export class EventListenService { * } * } * ``` + * * @param eventClass - The event class to subscribe to. This is the class, NOT an instance. * @param listener - Instance of the event listener class to attach to the event. * @param options - Overriding options. diff --git a/packages/nestjs-exception/src/utils/map-http-status.util.ts b/packages/nestjs-exception/src/utils/map-http-status.util.ts index 4ed3f59cc..608b5beef 100644 --- a/packages/nestjs-exception/src/utils/map-http-status.util.ts +++ b/packages/nestjs-exception/src/utils/map-http-status.util.ts @@ -5,6 +5,7 @@ import { /** * Map http status to error codes. + * * @param statusCode - The HTTP status code to look up. */ export function mapHttpStatus(statusCode: number) { diff --git a/packages/nestjs-federated/src/services/federated-mutate.service.ts b/packages/nestjs-federated/src/services/federated-mutate.service.ts index 4ecb93623..b5c93983f 100644 --- a/packages/nestjs-federated/src/services/federated-mutate.service.ts +++ b/packages/nestjs-federated/src/services/federated-mutate.service.ts @@ -29,6 +29,7 @@ export class FederatedMutateService /** * Constructor + * * @param repo - instance of the federated repo */ constructor( diff --git a/packages/nestjs-federated/src/services/federated-oauth.service.ts b/packages/nestjs-federated/src/services/federated-oauth.service.ts index d631cdb97..90130ad5b 100644 --- a/packages/nestjs-federated/src/services/federated-oauth.service.ts +++ b/packages/nestjs-federated/src/services/federated-oauth.service.ts @@ -32,6 +32,7 @@ export class FederatedOAuthService implements FederatedOAuthServiceInterface { /** * Sign in with federated creating a user if it doesn't exist + * * @param provider - provider name (github, facebook, google) * @param email - email account * @param subject - subject (user id/ profile id from provider) @@ -75,6 +76,7 @@ export class FederatedOAuthService implements FederatedOAuthServiceInterface { /** * Logic to create user and federated + * * @internal */ protected async createUserWithFederated( @@ -97,6 +99,7 @@ export class FederatedOAuthService implements FederatedOAuthServiceInterface { /** * Create a user + * * @internal */ protected async createUser( @@ -131,6 +134,7 @@ export class FederatedOAuthService implements FederatedOAuthServiceInterface { /** * Create federated credentials + * * @internal */ private async createFederated( diff --git a/packages/nestjs-invitation/src/services/invitation-acceptance.service.ts b/packages/nestjs-invitation/src/services/invitation-acceptance.service.ts index e0e97eca1..3b7c0044d 100644 --- a/packages/nestjs-invitation/src/services/invitation-acceptance.service.ts +++ b/packages/nestjs-invitation/src/services/invitation-acceptance.service.ts @@ -114,6 +114,7 @@ export class InvitationAcceptanceService extends BaseService { @@ -135,6 +136,7 @@ export class InvitationAcceptanceService extends BaseService LoggerSettingsInterface) & /** * Mapping from log level to sentry severity + * * @param logLevel - Log level * @returns SentryLogSeverity */ diff --git a/packages/nestjs-logger/src/interfaces/logger-service.interface.ts b/packages/nestjs-logger/src/interfaces/logger-service.interface.ts index 0b1e60ea9..c2455cfd4 100644 --- a/packages/nestjs-logger/src/interfaces/logger-service.interface.ts +++ b/packages/nestjs-logger/src/interfaces/logger-service.interface.ts @@ -9,12 +9,14 @@ import { LoggerTransportInterface } from './logger-transport.interface'; export interface LoggerServiceInterface { /** * Add the transport that will be used. + * * @param transport - Transport */ addTransport(transport: LoggerTransportInterface): void; /** * Method to log an exception. + * * @param error - The error to be logged * @param message - The Error Message to be logged * @param context - The Context of the message @@ -23,6 +25,7 @@ export interface LoggerServiceInterface { /** * Method to log message as a error log level. + * * @param message - Method to log message as an error * @param trace - Stack trace * @param context - The Context of the message @@ -35,6 +38,7 @@ export interface LoggerServiceInterface { /** * Method to log message as a warn log level. + * * @param message - Method to log message as a warning * @param context - The Context of the message */ @@ -42,6 +46,7 @@ export interface LoggerServiceInterface { /** * Debug method. + * * @param message - Method to log message as a debug * @param context - The Context of the message */ @@ -49,6 +54,7 @@ export interface LoggerServiceInterface { /** * Log method. + * * @param message - Method to log message as a Log * @param context - The Context of the message */ @@ -56,6 +62,7 @@ export interface LoggerServiceInterface { /** * Verbose method. + * * @param message - Method to log message as a Verbose * @param context - The Context of the message */ diff --git a/packages/nestjs-logger/src/interfaces/logger-transport.interface.ts b/packages/nestjs-logger/src/interfaces/logger-transport.interface.ts index b8c2d7c77..ecfa3281d 100644 --- a/packages/nestjs-logger/src/interfaces/logger-transport.interface.ts +++ b/packages/nestjs-logger/src/interfaces/logger-transport.interface.ts @@ -24,6 +24,7 @@ import { LogLevel } from '@nestjs/common'; export interface LoggerTransportInterface { /** * Transport log method + * * @param message - Message to be logged * @param logLevel - The log level that logger should consider * @param error - an optional error that can be sent diff --git a/packages/nestjs-logger/src/logger-exception.filter.ts b/packages/nestjs-logger/src/logger-exception.filter.ts index 18f4b714e..207f7d94b 100644 --- a/packages/nestjs-logger/src/logger-exception.filter.ts +++ b/packages/nestjs-logger/src/logger-exception.filter.ts @@ -15,6 +15,7 @@ import { LoggerService } from './logger.service'; export class LoggerExceptionFilter extends BaseExceptionFilter { /** * Constructor + * * @param loggerService - instance of the Logger Service */ constructor( @@ -26,6 +27,7 @@ export class LoggerExceptionFilter extends BaseExceptionFilter { /** * Override catch to log before returning exception. + * * @param exception - Error instance * @param host - Arguments Host instance */ diff --git a/packages/nestjs-logger/src/logger-request.interceptor.ts b/packages/nestjs-logger/src/logger-request.interceptor.ts index c31330723..95f280a7d 100644 --- a/packages/nestjs-logger/src/logger-request.interceptor.ts +++ b/packages/nestjs-logger/src/logger-request.interceptor.ts @@ -23,12 +23,14 @@ import { MessageFormatUtil } from './utils/message-format.util'; export class LoggerRequestInterceptor implements NestInterceptor { /** * Constructor + * * @param loggerService - The logger service that implements ConsoleLogger */ constructor(private loggerService: LoggerService) {} /** * Method to implement a custom intercept + * * @param context - Execution context * @param next - Call handler */ @@ -56,6 +58,7 @@ export class LoggerRequestInterceptor implements NestInterceptor { /** * Method to log response success + * * @param req - Request * @param res - Response * @param startDate - the date for the message @@ -74,6 +77,7 @@ export class LoggerRequestInterceptor implements NestInterceptor { /** * Format exception error + * * @param req - Request * @param res - Response * @param startDate - Start date diff --git a/packages/nestjs-logger/src/logger-transport.service.ts b/packages/nestjs-logger/src/logger-transport.service.ts index 4ecd43a9e..ab4837b4c 100644 --- a/packages/nestjs-logger/src/logger-transport.service.ts +++ b/packages/nestjs-logger/src/logger-transport.service.ts @@ -41,6 +41,7 @@ export class LoggerTransportService { /** * Constructor + * * @param settings - logger settings */ constructor( @@ -54,6 +55,7 @@ export class LoggerTransportService { /** * Method to add the transport that will be used + * * @param transport - Instance of a logger transport */ public addTransport(transport: LoggerTransportInterface): void { @@ -62,6 +64,7 @@ export class LoggerTransportService { /** * Method to log message to the transport based on the log level + * * @param message - message * @param logLevel - log level * @param error - error diff --git a/packages/nestjs-logger/src/logger.service.ts b/packages/nestjs-logger/src/logger.service.ts index 27d86cc6a..58cd40370 100644 --- a/packages/nestjs-logger/src/logger.service.ts +++ b/packages/nestjs-logger/src/logger.service.ts @@ -43,6 +43,7 @@ export class LoggerService { /** * Constructor + * * @param transportService - transport service */ constructor(protected readonly transportService: LoggerTransportService) { @@ -51,6 +52,7 @@ export class LoggerService /** * Add a transport to be used for every log, it can be multiples + * * @param transport - The transport that will be used beside the system logger */ addTransport(transport: LoggerTransportInterface): void { @@ -62,6 +64,7 @@ export class LoggerService * * If the exception is between 400 and 500 status code * it will be logged as a debug log level, otherwise it will be logged as an error. + * * @param error - Error to be registered * @param message - Error Message * @param context - Context of current error @@ -97,6 +100,7 @@ export class LoggerService /** * Method to be called when an error should be logged. + * * @param message - Error Message * @param trace - Stack trace error * @param context - Context of current Message @@ -122,6 +126,7 @@ export class LoggerService /** * Method to be used when a warn message should be logged. + * * @param message - Warn Message * @param context - Context of Message */ @@ -132,6 +137,7 @@ export class LoggerService /** * Method to be used when a debug message should be logged. + * * @param message - Debug Message * @param context - Context of Message */ @@ -142,6 +148,7 @@ export class LoggerService /** * Method to be used when a simple log message should be logged. + * * @param message - Log message * @param context - Context of Message */ @@ -152,6 +159,7 @@ export class LoggerService /** * Method to be used when a verbose message should be logged. + * * @param message - Verbose Message * @param context - Context Message */ diff --git a/packages/nestjs-logger/src/transports/logger-sentry.transport.ts b/packages/nestjs-logger/src/transports/logger-sentry.transport.ts index 146e4f2a8..8c062619b 100644 --- a/packages/nestjs-logger/src/transports/logger-sentry.transport.ts +++ b/packages/nestjs-logger/src/transports/logger-sentry.transport.ts @@ -20,6 +20,7 @@ import { LoggerTransportInterface } from '../interfaces/logger-transport.interfa export class LoggerSentryTransport implements LoggerTransportInterface { /** * Constructor + * * @param config - configuration file injected */ constructor(protected readonly config: LoggerSentryConfigInterface) { @@ -33,6 +34,7 @@ export class LoggerSentryTransport implements LoggerTransportInterface { /** * Method to log message to Sentry transport + * * @param message - message * @param logLevel - log level * @param error - error diff --git a/packages/nestjs-logger/src/utils/config-parser.util.ts b/packages/nestjs-logger/src/utils/config-parser.util.ts index 87b8d3dc3..0c6697751 100644 --- a/packages/nestjs-logger/src/utils/config-parser.util.ts +++ b/packages/nestjs-logger/src/utils/config-parser.util.ts @@ -3,6 +3,7 @@ import { LOGGER_VALID_LOG_LEVELS } from '../config/logger.config'; /** * Helper to split log level string and assign to correct log level type. + * * @internal * @param levels - Log levels to split */ diff --git a/packages/nestjs-logger/src/utils/message-format.util.ts b/packages/nestjs-logger/src/utils/message-format.util.ts index 62946d1e9..0f22aa793 100644 --- a/packages/nestjs-logger/src/utils/message-format.util.ts +++ b/packages/nestjs-logger/src/utils/message-format.util.ts @@ -5,11 +5,13 @@ import { /** * Message formatting utility + * * @internal */ export class MessageFormatUtil { /** * Function to format message from request. + * * @param req - request */ static formatRequestMessage(req: Request): string { @@ -21,6 +23,7 @@ export class MessageFormatUtil { /** * Function to format message for response. + * * @param req - request * @param res - response * @param startDate - start date diff --git a/packages/nestjs-org/src/org.controller.ts b/packages/nestjs-org/src/org.controller.ts index ffcd5078e..6c8d90fa8 100644 --- a/packages/nestjs-org/src/org.controller.ts +++ b/packages/nestjs-org/src/org.controller.ts @@ -56,12 +56,14 @@ export class OrgController { /** * Constructor. + * * @param orgCrudService - instance of the Org crud service */ constructor(private orgCrudService: OrgCrudService) {} /** * Get many + * * @param crudRequest - the CRUD request object */ @CrudReadMany() @@ -72,6 +74,7 @@ export class OrgController /** * Get one + * * @param crudRequest - the CRUD request object */ @CrudReadOne() @@ -82,6 +85,7 @@ export class OrgController /** * Create many + * * @param crudRequest - the CRUD request object * @param orgCreateManyDto - org create many dto */ @@ -97,6 +101,7 @@ export class OrgController /** * Create one + * * @param crudRequest - the CRUD request object * @param orgCreateDto - org create dto */ @@ -112,6 +117,7 @@ export class OrgController /** * Update one + * * @param crudRequest - the CRUD request object * @param orgUpdateDto - org update dto */ @@ -126,6 +132,7 @@ export class OrgController /** * Delete one + * * @param crudRequest - the CRUD request object */ @CrudDeleteOne() @@ -136,6 +143,7 @@ export class OrgController /** * Recover one + * * @param crudRequest - the CRUD request object */ @CrudRecoverOne() diff --git a/packages/nestjs-org/src/services/org-crud.service.ts b/packages/nestjs-org/src/services/org-crud.service.ts index 9f04e0a8a..fb8ddc3a4 100644 --- a/packages/nestjs-org/src/services/org-crud.service.ts +++ b/packages/nestjs-org/src/services/org-crud.service.ts @@ -12,6 +12,7 @@ import { OrgEntityInterface } from '../interfaces/org-entity.interface'; export class OrgCrudService extends TypeOrmCrudService { /** * Constructor + * * @param orgRepo - instance of the org repository. */ constructor( diff --git a/packages/nestjs-org/src/services/org-lookup.service.ts b/packages/nestjs-org/src/services/org-lookup.service.ts index 47d2bd098..2271acbc6 100644 --- a/packages/nestjs-org/src/services/org-lookup.service.ts +++ b/packages/nestjs-org/src/services/org-lookup.service.ts @@ -23,6 +23,7 @@ export class OrgLookupService { /** * Constructor + * * @param repo - instance of the org repo */ constructor( @@ -36,6 +37,7 @@ export class OrgLookupService /** * Get owner for the given org. + * * @param org - The org of which owner to retrieve. */ async getOwner(org: OrgOwnerInterface, queryOptions?: QueryOptionsInterface) { diff --git a/packages/nestjs-org/src/services/org-mutate.service.ts b/packages/nestjs-org/src/services/org-mutate.service.ts index b5783c2c5..15ae40c06 100644 --- a/packages/nestjs-org/src/services/org-mutate.service.ts +++ b/packages/nestjs-org/src/services/org-mutate.service.ts @@ -29,6 +29,7 @@ export class OrgMutateService /** * Constructor + * * @param repo - instance of the org repo */ constructor( diff --git a/packages/nestjs-otp/src/services/otp.service.ts b/packages/nestjs-otp/src/services/otp.service.ts index 62f2918c4..87fba9119 100644 --- a/packages/nestjs-otp/src/services/otp.service.ts +++ b/packages/nestjs-otp/src/services/otp.service.ts @@ -37,6 +37,7 @@ export class OtpService implements OtpServiceInterface { /** * Create a otp with a for the given assignee. + * * @param assignment - The otp assignment * @param otp - The data to create */ @@ -83,6 +84,7 @@ export class OtpService implements OtpServiceInterface { /** * Check if otp is valid + * * @param assignment - The otp assignment * @param otp - The otp to validate * @param deleteIfValid - If true, delete the otp if it is valid @@ -113,6 +115,7 @@ export class OtpService implements OtpServiceInterface { /** * Delete a otp based on params + * * @param assignment - The otp assignment * @param otp - The otp to delete */ @@ -131,6 +134,7 @@ export class OtpService implements OtpServiceInterface { /** * Clear all otps for assign in given category. + * * @param assignment - The assignment of the repository * @param otp - The otp to clear */ @@ -155,6 +159,7 @@ export class OtpService implements OtpServiceInterface { /** * Delete OTP based on assignment + * * @internal * @param assignment - The assignment to delete id from * @param id - The id or ids to delete @@ -179,6 +184,7 @@ export class OtpService implements OtpServiceInterface { /** * Get all OTPs for assignee. + * * @param assignment - The assignment of the check * @param otp - The otp to get assignments */ @@ -248,6 +254,7 @@ export class OtpService implements OtpServiceInterface { /** * Get the assignment repo for the given assignment. + * * @internal * @param assignment - The otp assignment */ diff --git a/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts b/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts index cedec9d60..fedcb6770 100644 --- a/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts +++ b/packages/nestjs-password/src/interfaces/password-creation-service.interface.ts @@ -9,6 +9,7 @@ import { PasswordCreateObjectOptionsInterface } from './password-create-object-o export interface PasswordCreationServiceInterface { /** * Create password for an object (optionally). + * * @param object - An object containing the new password to hash. * @param options - Password create options. * @returns A new object with the password hashed, with salt added. @@ -22,6 +23,7 @@ export interface PasswordCreationServiceInterface { /** * Validate the current password for the targeted object. + * * @param options - Validate current options. * @returns boolean */ @@ -31,12 +33,14 @@ export interface PasswordCreationServiceInterface { /** * Check if attempt is valid. + * * @returns Number of attempts user has to try */ checkAttempt(numOfAttempts: number): boolean; /** * Check number of attempts of using password + * * @param numOfAttempts - number of attempts * @returns number of attempts left */ diff --git a/packages/nestjs-password/src/interfaces/password-storage-service.interface.ts b/packages/nestjs-password/src/interfaces/password-storage-service.interface.ts index ebe0be326..41fb83847 100644 --- a/packages/nestjs-password/src/interfaces/password-storage-service.interface.ts +++ b/packages/nestjs-password/src/interfaces/password-storage-service.interface.ts @@ -15,6 +15,7 @@ export interface PasswordStorageServiceInterface { /** * Hash a password using a salt, if no * was passed, then generate one automatically. + * * @param password - Password to be hashed * @param options - Hash options */ @@ -25,6 +26,7 @@ export interface PasswordStorageServiceInterface { /** * Hash password for an object. + * * @param object - An object containing the new password to hash. * @param options - Hash object options * @returns A new object with the password hashed, with salt added. diff --git a/packages/nestjs-password/src/interfaces/password-strength-service.interface.ts b/packages/nestjs-password/src/interfaces/password-strength-service.interface.ts index 96af91096..360106d9e 100644 --- a/packages/nestjs-password/src/interfaces/password-strength-service.interface.ts +++ b/packages/nestjs-password/src/interfaces/password-strength-service.interface.ts @@ -4,6 +4,7 @@ export interface PasswordStrengthServiceInterface { /** * Check if Password is strong + * * @param password - The plain text password */ isStrong(password: string): boolean; diff --git a/packages/nestjs-password/src/interfaces/password-validation-service.interface.ts b/packages/nestjs-password/src/interfaces/password-validation-service.interface.ts index 36b637aaa..2776bb184 100644 --- a/packages/nestjs-password/src/interfaces/password-validation-service.interface.ts +++ b/packages/nestjs-password/src/interfaces/password-validation-service.interface.ts @@ -7,12 +7,14 @@ import { PasswordValidateOptionsInterface } from './password-validate-options.in export interface PasswordValidationServiceInterface { /** * Validate if password matches and its valid. + * * @param options - Validation options */ validate(options: PasswordValidateOptionsInterface): Promise; /** * Validate password on an object. + * * @param passwordPlain - Plain text password * @param object - The object on which the password and salt are stored */ diff --git a/packages/nestjs-password/src/services/password-creation.service.ts b/packages/nestjs-password/src/services/password-creation.service.ts index 0dfdb7dbe..7c1694e67 100644 --- a/packages/nestjs-password/src/services/password-creation.service.ts +++ b/packages/nestjs-password/src/services/password-creation.service.ts @@ -32,6 +32,7 @@ export class PasswordCreationService /** * Create password for an object. + * * @param object - An object containing the new password to hash. * @param options - Password create options. * @returns A new object with the password hashed, with salt added. @@ -43,6 +44,7 @@ export class PasswordCreationService /** * Create password for an object. + * * @param object - An object containing the new password to hash. * @param options - Password create options. * @returns A new object with the password hashed, with salt added. @@ -57,6 +59,7 @@ export class PasswordCreationService /** * Create password for an object. + * * @param object - An object containing the new password to hash. * @param options - Password create options. * @returns A new object with the password hashed, with salt added. @@ -110,6 +113,7 @@ export class PasswordCreationService /** * Check if number of current attempt is allowed based on the amount of attempts left * if the number of attempts left is greater then + * * @returns Number of attempts user has to try */ checkAttempt(numOfAttempts = 0): boolean { @@ -118,6 +122,7 @@ export class PasswordCreationService /** * Check number of attempts of using password + * * @param numOfAttempts - number of attempts */ checkAttemptLeft(numOfAttempts = 0): number { diff --git a/packages/nestjs-password/src/services/password-storage.service.ts b/packages/nestjs-password/src/services/password-storage.service.ts index fa80d99f9..ecdcc9fdd 100644 --- a/packages/nestjs-password/src/services/password-storage.service.ts +++ b/packages/nestjs-password/src/services/password-storage.service.ts @@ -21,6 +21,7 @@ export class PasswordStorageService implements PasswordStorageServiceInterface { /** * Hash a password using a salt, if no * was passed, then one will be generated. + * * @param password - Password to be hashed * @param options - Hash options */ @@ -39,6 +40,7 @@ export class PasswordStorageService implements PasswordStorageServiceInterface { /** * Hash password for an object. + * * @param object - An object containing the new password to hash. * @param options - Hash object options * @returns A new object with the password hashed, with salt added. @@ -50,6 +52,7 @@ export class PasswordStorageService implements PasswordStorageServiceInterface { /** * Hash password for an object if the password property exists. + * * @param object - An object containing the new password to hash. * @param options - Hash object options * @returns A new object with the password hashed, with salt added. @@ -63,6 +66,7 @@ export class PasswordStorageService implements PasswordStorageServiceInterface { /** * Hash password for an object. + * * @param object - An object containing the new password to hash. * @param options - Hash object options * @returns A new object with the password hashed, with salt added. diff --git a/packages/nestjs-password/src/services/password-strength.service.ts b/packages/nestjs-password/src/services/password-strength.service.ts index 13e198538..51dd41b20 100644 --- a/packages/nestjs-password/src/services/password-strength.service.ts +++ b/packages/nestjs-password/src/services/password-strength.service.ts @@ -24,6 +24,7 @@ export class PasswordStrengthService /** * Method to check if password is strong + * * @param password - the plain text password * @returns password strength */ diff --git a/packages/nestjs-password/src/utils/crypt.util.ts b/packages/nestjs-password/src/utils/crypt.util.ts index a3b9dc08b..537da5c69 100644 --- a/packages/nestjs-password/src/utils/crypt.util.ts +++ b/packages/nestjs-password/src/utils/crypt.util.ts @@ -6,6 +6,7 @@ import * as bcrypt from 'bcrypt'; export abstract class CryptUtil { /** * Generate Salt + * * @returns Generate */ static async generateSalt(): Promise { @@ -29,6 +30,7 @@ export abstract class CryptUtil { /** * Validate password with the hash password + * * @param passwordPlain - The plain password * @param passwordHash - The encrypted password * @param passwordSalt - The salt diff --git a/packages/nestjs-role/src/interfaces/role-service.interface.ts b/packages/nestjs-role/src/interfaces/role-service.interface.ts index c8d198e76..078b7abd6 100644 --- a/packages/nestjs-role/src/interfaces/role-service.interface.ts +++ b/packages/nestjs-role/src/interfaces/role-service.interface.ts @@ -7,6 +7,7 @@ import { RoleEntityInterface } from './role-entity.interface'; export interface RoleServiceInterface { /** * Get all roles for assignee. + * * @param assignment - The assignment of the check (same as entity key) * @param assignee - The assignee to check */ @@ -18,6 +19,7 @@ export interface RoleServiceInterface { /** * Check if the assignee is a member of one role. + * * @param assignment - The assignment of the check * @param role - The role to check * @param assignee - The assignee to check @@ -31,6 +33,7 @@ export interface RoleServiceInterface { /** * Check if the assignee is a member of every role. + * * @param assignment - The assignment of the check * @param roles - The roles to check * @param assignee - The assignee to check diff --git a/packages/nestjs-role/src/role-assignment.controller.ts b/packages/nestjs-role/src/role-assignment.controller.ts index 610746ffa..0a30496c1 100644 --- a/packages/nestjs-role/src/role-assignment.controller.ts +++ b/packages/nestjs-role/src/role-assignment.controller.ts @@ -68,6 +68,7 @@ export class RoleAssignmentController { /** * Constructor. + * * @param settings - role settings * @param allCrudServices - instances of all crud services */ @@ -80,6 +81,7 @@ export class RoleAssignmentController /** * Get many + * * @param crudRequest - the CRUD request object * @param assignment - the assignment */ @@ -94,6 +96,7 @@ export class RoleAssignmentController /** * Get one + * * @param crudRequest - the CRUD request object * @param assignment - The role assignment */ @@ -108,6 +111,7 @@ export class RoleAssignmentController /** * Create many + * * @param crudRequest - the CRUD request object * @param roleAssignmentCreateDto - role create many dto * @param assignment - The role assignment @@ -136,6 +140,7 @@ export class RoleAssignmentController /** * Create one + * * @param crudRequest - the CRUD request object * @param roleAssignmentCreateDto - role create dto * @param assignment - The role assignment @@ -156,6 +161,7 @@ export class RoleAssignmentController /** * Delete one + * * @param crudRequest - the CRUD request object * @param assignment - The role assignment */ @@ -170,6 +176,7 @@ export class RoleAssignmentController /** * Get the crud service for the given assignment. + * * @internal * @param assignment - The role assignment */ diff --git a/packages/nestjs-role/src/role.controller.ts b/packages/nestjs-role/src/role.controller.ts index 8be35a295..53f420d1b 100644 --- a/packages/nestjs-role/src/role.controller.ts +++ b/packages/nestjs-role/src/role.controller.ts @@ -54,12 +54,14 @@ export class RoleController { /** * Constructor. + * * @param roleCrudService - instance of the Role crud service */ constructor(private roleCrudService: RoleCrudService) {} /** * Get many + * * @param crudRequest - the CRUD request object */ @CrudReadMany() @@ -70,6 +72,7 @@ export class RoleController /** * Get one + * * @param crudRequest - the CRUD request object */ @CrudReadOne() @@ -80,6 +83,7 @@ export class RoleController /** * Create many + * * @param crudRequest - the CRUD request object * @param roleCreateManyDto - role create many dto */ @@ -104,6 +108,7 @@ export class RoleController /** * Create one + * * @param crudRequest - the CRUD request object * @param roleCreateDto - role create dto */ @@ -119,6 +124,7 @@ export class RoleController /** * Update one + * * @param crudRequest - the CRUD request object * @param roleUpdateDto - role update dto */ @@ -133,6 +139,7 @@ export class RoleController /** * Delete one + * * @param crudRequest - the CRUD request object */ @CrudDeleteOne() diff --git a/packages/nestjs-role/src/services/role-assignment-crud.service.ts b/packages/nestjs-role/src/services/role-assignment-crud.service.ts index 928e80d36..51dc27f33 100644 --- a/packages/nestjs-role/src/services/role-assignment-crud.service.ts +++ b/packages/nestjs-role/src/services/role-assignment-crud.service.ts @@ -8,6 +8,7 @@ import { RoleAssignmentInterface } from '@concepta/ts-common'; export class RoleAssignmentCrudService extends TypeOrmCrudService { /** * Constructor + * * @param repo - instance of a role assignment repository. */ constructor(repo: Repository) { diff --git a/packages/nestjs-role/src/services/role-crud.service.ts b/packages/nestjs-role/src/services/role-crud.service.ts index d586beaf8..1d5c0e29d 100644 --- a/packages/nestjs-role/src/services/role-crud.service.ts +++ b/packages/nestjs-role/src/services/role-crud.service.ts @@ -12,6 +12,7 @@ import { RoleEntityInterface } from '../interfaces/role-entity.interface'; export class RoleCrudService extends TypeOrmCrudService { /** * Constructor + * * @param roleRepo - instance of the role repository. */ constructor( diff --git a/packages/nestjs-role/src/services/role-lookup.service.ts b/packages/nestjs-role/src/services/role-lookup.service.ts index 637daf058..7370981c0 100644 --- a/packages/nestjs-role/src/services/role-lookup.service.ts +++ b/packages/nestjs-role/src/services/role-lookup.service.ts @@ -16,6 +16,7 @@ export class RoleLookupService { /** * Constructor + * * @param repo - instance of the role repo */ constructor( diff --git a/packages/nestjs-role/src/services/role-mutate.service.ts b/packages/nestjs-role/src/services/role-mutate.service.ts index c165017e7..5d6d135ca 100644 --- a/packages/nestjs-role/src/services/role-mutate.service.ts +++ b/packages/nestjs-role/src/services/role-mutate.service.ts @@ -29,6 +29,7 @@ export class RoleMutateService /** * Constructor + * * @param repo - instance of the role repo */ constructor( diff --git a/packages/nestjs-role/src/services/role.service.ts b/packages/nestjs-role/src/services/role.service.ts index 051012081..d4256b01f 100644 --- a/packages/nestjs-role/src/services/role.service.ts +++ b/packages/nestjs-role/src/services/role.service.ts @@ -31,6 +31,7 @@ export class RoleService implements RoleServiceInterface { /** * Get all roles for assignee. + * * @param assignment - The assignment of the check (same as entity key) * @param assignee - The assignee to check */ @@ -66,6 +67,7 @@ export class RoleService implements RoleServiceInterface { /** * Check if the assignee is a member of one role. + * * @param assignment - The assignment of the check * @param role - The role to check * @param assignee - The assignee to check @@ -103,6 +105,7 @@ export class RoleService implements RoleServiceInterface { /** * Check if the assignee is a member of every role. + * * @param assignment - The assignment of the check * @param roles - The roles to check * @param assignee - The assignee to check @@ -138,6 +141,7 @@ export class RoleService implements RoleServiceInterface { /** * Get the assignment repo for the given assignment. + * * @internal * @param assignment - The role assignment */ diff --git a/packages/nestjs-swagger-ui/src/swagger-ui.service.ts b/packages/nestjs-swagger-ui/src/swagger-ui.service.ts index 65421c1dc..7e8d820cf 100644 --- a/packages/nestjs-swagger-ui/src/swagger-ui.service.ts +++ b/packages/nestjs-swagger-ui/src/swagger-ui.service.ts @@ -10,6 +10,7 @@ import { export class SwaggerUiService { /** * Constructor. + * * @param settings - swagger ui settings */ constructor( @@ -28,6 +29,7 @@ export class SwaggerUiService { /** * Setup. + * * @param app - Nest application instance */ setup(app: INestApplication) { diff --git a/packages/nestjs-typeorm-ext/src/utils/create-dynamic-repository-provider.ts b/packages/nestjs-typeorm-ext/src/utils/create-dynamic-repository-provider.ts index 8b0846b35..ef5441ce2 100644 --- a/packages/nestjs-typeorm-ext/src/utils/create-dynamic-repository-provider.ts +++ b/packages/nestjs-typeorm-ext/src/utils/create-dynamic-repository-provider.ts @@ -9,6 +9,7 @@ import { TypeOrmExtEntityOptionInterface } from '../interfaces/typeorm-ext-entit /** * Create dynamic repository provider function + * * @param key - repository key * @param entity - the entity * @param repositoryFactory - the repository diff --git a/packages/nestjs-typeorm-ext/src/utils/create-entity-repository-provider.ts b/packages/nestjs-typeorm-ext/src/utils/create-entity-repository-provider.ts index b434d3fcf..2820c9ed7 100644 --- a/packages/nestjs-typeorm-ext/src/utils/create-entity-repository-provider.ts +++ b/packages/nestjs-typeorm-ext/src/utils/create-entity-repository-provider.ts @@ -7,6 +7,7 @@ import { EntityClassOrSchema } from '@nestjs/typeorm/dist/interfaces/entity-clas /** * Create an entity repository provider function + * * @param key - Entity key * @param entity - The entity * @param dataSource - The data source diff --git a/packages/nestjs-user/src/interfaces/user-password-service.interface.ts b/packages/nestjs-user/src/interfaces/user-password-service.interface.ts index 2494b2e00..18823f8be 100644 --- a/packages/nestjs-user/src/interfaces/user-password-service.interface.ts +++ b/packages/nestjs-user/src/interfaces/user-password-service.interface.ts @@ -14,6 +14,7 @@ export interface UserPasswordServiceInterface { * Get the user being updated by id. * * Object must have reference id and password storage interface. + * * @param userId - The id of the user that is being updated * @returns The user being updated */ @@ -23,6 +24,7 @@ export interface UserPasswordServiceInterface { /** * Set the password (hash) on the user object. + * * @param passwordDto - The object containing the password, and optionally the current password. * @param userToUpdateId - The id of the user being updated. * @param authorizedUser - The authorized user diff --git a/packages/nestjs-user/src/services/user-crud.service.ts b/packages/nestjs-user/src/services/user-crud.service.ts index bc53ebfe9..b6758b8fd 100644 --- a/packages/nestjs-user/src/services/user-crud.service.ts +++ b/packages/nestjs-user/src/services/user-crud.service.ts @@ -12,6 +12,7 @@ import { UserEntityInterface } from '../interfaces/user-entity.interface'; export class UserCrudService extends TypeOrmCrudService { /** * Constructor + * * @param userRepo - instance of the user repository. */ constructor( diff --git a/packages/nestjs-user/src/services/user-lookup.service.ts b/packages/nestjs-user/src/services/user-lookup.service.ts index e9278b9db..1ae6304a3 100644 --- a/packages/nestjs-user/src/services/user-lookup.service.ts +++ b/packages/nestjs-user/src/services/user-lookup.service.ts @@ -22,6 +22,7 @@ export class UserLookupService { /** * Constructor + * * @param repo - instance of the user repo */ constructor( @@ -33,6 +34,7 @@ export class UserLookupService /** * Get user for the given email. + * * @param email - the email */ async byEmail( @@ -44,6 +46,7 @@ export class UserLookupService /** * Get user for the given subject. + * * @param subject - the subject */ async bySubject( @@ -55,6 +58,7 @@ export class UserLookupService /** * Get user for the given username. + * * @param username - the username */ async byUsername( diff --git a/packages/nestjs-user/src/services/user-mutate.service.ts b/packages/nestjs-user/src/services/user-mutate.service.ts index 0070178dd..f15b423aa 100644 --- a/packages/nestjs-user/src/services/user-mutate.service.ts +++ b/packages/nestjs-user/src/services/user-mutate.service.ts @@ -32,6 +32,7 @@ export class UserMutateService /** * Constructor + * * @param repo - instance of the user repo * @param userPasswordService - instance of a user password service */ diff --git a/packages/nestjs-user/src/services/user-password.service.ts b/packages/nestjs-user/src/services/user-password.service.ts index 711499e2a..cc499746d 100644 --- a/packages/nestjs-user/src/services/user-password.service.ts +++ b/packages/nestjs-user/src/services/user-password.service.ts @@ -24,6 +24,7 @@ import { UserNotFoundException } from '../exceptions/user-not-found-exception'; export class UserPasswordService implements UserPasswordServiceInterface { /** * Constructor + * * @param userLookupService - user lookup service * @param passwordCreationService - password creation service */ diff --git a/packages/nestjs-user/src/user.controller.ts b/packages/nestjs-user/src/user.controller.ts index 6dadfdbbd..68e8a03ee 100644 --- a/packages/nestjs-user/src/user.controller.ts +++ b/packages/nestjs-user/src/user.controller.ts @@ -67,6 +67,7 @@ export class UserController { /** * Constructor. + * * @param userCrudService - instance of the user crud service * @param userPasswordService - instance of user password service */ @@ -77,6 +78,7 @@ export class UserController /** * Get many + * * @param crudRequest - the CRUD request object */ @CrudReadMany() @@ -87,6 +89,7 @@ export class UserController /** * Get one + * * @param crudRequest - the CRUD request object */ @CrudReadOne() @@ -97,6 +100,7 @@ export class UserController /** * Create many + * * @param crudRequest - the CRUD request object * @param userCreateManyDto - user create many dto */ @@ -121,6 +125,7 @@ export class UserController /** * Create one + * * @param crudRequest - the CRUD request object * @param userCreateDto - user create dto */ @@ -139,6 +144,7 @@ export class UserController /** * Update one + * * @param crudRequest - the CRUD request object * @param userUpdateDto - user update dto */ @@ -167,6 +173,7 @@ export class UserController /** * Delete one + * * @param crudRequest - the CRUD request object */ @CrudDeleteOne() @@ -177,6 +184,7 @@ export class UserController /** * Recover one + * * @param crudRequest - the CRUD request object */ @CrudRecoverOne() diff --git a/packages/nestjs-user/src/user.seeder.ts b/packages/nestjs-user/src/user.seeder.ts index df4f6bb79..97814c5e9 100644 --- a/packages/nestjs-user/src/user.seeder.ts +++ b/packages/nestjs-user/src/user.seeder.ts @@ -44,6 +44,7 @@ export class UserSeeder extends Seeder { /** * Set a password for the given user. + * * @param user - Object implementing the required interface. * @param password - The password to set. */ diff --git a/packages/ts-common/src/cache/interfaces/cache-clear.interface.ts b/packages/ts-common/src/cache/interfaces/cache-clear.interface.ts index 3a5fa0c00..4a664eb79 100644 --- a/packages/ts-common/src/cache/interfaces/cache-clear.interface.ts +++ b/packages/ts-common/src/cache/interfaces/cache-clear.interface.ts @@ -9,6 +9,7 @@ export interface CacheClearInterface< > { /** * Clear all caches for assign in given category. + * * @param assignment - The assignment of the repository * @param cache - The cache to clear */ diff --git a/packages/ts-common/src/cache/interfaces/cache-create.interface.ts b/packages/ts-common/src/cache/interfaces/cache-create.interface.ts index d684050e2..406ceaa45 100644 --- a/packages/ts-common/src/cache/interfaces/cache-create.interface.ts +++ b/packages/ts-common/src/cache/interfaces/cache-create.interface.ts @@ -11,6 +11,7 @@ export interface CacheCreateInterface< > { /** * Create a cache with a for the given assignee. + * * @param assignment - The cache assignment * @param cache - The CACHE to create */ diff --git a/packages/ts-common/src/cache/interfaces/cache-delete.interface.ts b/packages/ts-common/src/cache/interfaces/cache-delete.interface.ts index d6cb7bb8c..dd605e8db 100644 --- a/packages/ts-common/src/cache/interfaces/cache-delete.interface.ts +++ b/packages/ts-common/src/cache/interfaces/cache-delete.interface.ts @@ -9,6 +9,7 @@ export interface CacheDeleteInterface< > { /** * Delete a cache based on params + * * @param assignment - The cache assignment * @param cache - The dto with unique keys to delete */ diff --git a/packages/ts-common/src/cache/interfaces/cache-get-one.interface.ts b/packages/ts-common/src/cache/interfaces/cache-get-one.interface.ts index 4ae3ca4fd..3dd51376d 100644 --- a/packages/ts-common/src/cache/interfaces/cache-get-one.interface.ts +++ b/packages/ts-common/src/cache/interfaces/cache-get-one.interface.ts @@ -9,6 +9,7 @@ export interface CacheGetOneInterface< > { /** * Get One cache based on params + * * @param assignment - The cache assignment * @param cache - The dto with unique keys to delete */ diff --git a/packages/ts-common/src/cache/interfaces/cache-update.interface.ts b/packages/ts-common/src/cache/interfaces/cache-update.interface.ts index a50a7469b..5d2bfb5df 100644 --- a/packages/ts-common/src/cache/interfaces/cache-update.interface.ts +++ b/packages/ts-common/src/cache/interfaces/cache-update.interface.ts @@ -10,6 +10,7 @@ export interface CacheUpdateInterface< > { /** * Update a cache based on params + * * @param assignment - The cache assignment * @param cache - The dto with unique keys to delete */ diff --git a/packages/ts-common/src/otp/interfaces/otp-clear.interface.ts b/packages/ts-common/src/otp/interfaces/otp-clear.interface.ts index 158d1abab..0c0d1fd4e 100644 --- a/packages/ts-common/src/otp/interfaces/otp-clear.interface.ts +++ b/packages/ts-common/src/otp/interfaces/otp-clear.interface.ts @@ -9,6 +9,7 @@ export interface OtpClearInterface< > { /** * Clear all otps for assign in given category. + * * @param assignment - The assignment of the repository * @param otp - The otp to clear */ diff --git a/packages/ts-common/src/otp/interfaces/otp-create.interface.ts b/packages/ts-common/src/otp/interfaces/otp-create.interface.ts index 762a9146a..999926031 100644 --- a/packages/ts-common/src/otp/interfaces/otp-create.interface.ts +++ b/packages/ts-common/src/otp/interfaces/otp-create.interface.ts @@ -11,6 +11,7 @@ export interface OtpCreateInterface< > { /** * Create a otp with a for the given assignee. + * * @param assignment - The otp assignment * @param otp - The OTP to create */ diff --git a/packages/ts-common/src/otp/interfaces/otp-delete.interface.ts b/packages/ts-common/src/otp/interfaces/otp-delete.interface.ts index 1bd7ab8c2..d80c3e840 100644 --- a/packages/ts-common/src/otp/interfaces/otp-delete.interface.ts +++ b/packages/ts-common/src/otp/interfaces/otp-delete.interface.ts @@ -9,6 +9,7 @@ export interface OtpDeleteInterface< > { /** * Delete a otp based on params + * * @param assignment - The otp assignment * @param otp - The otp to delete */ diff --git a/packages/ts-common/src/otp/interfaces/otp-validate.interface.ts b/packages/ts-common/src/otp/interfaces/otp-validate.interface.ts index dc5ff0279..9470f3e6d 100644 --- a/packages/ts-common/src/otp/interfaces/otp-validate.interface.ts +++ b/packages/ts-common/src/otp/interfaces/otp-validate.interface.ts @@ -10,6 +10,7 @@ export interface OtpValidateInterface< > { /** * Check if otp is valid + * * @param assignment - The otp assignment * @param otp - The otp to validate * @param deleteIfValid - If true, delete the otp if it is valid diff --git a/packages/ts-core/src/references/interfaces/reference-id.interface.ts b/packages/ts-core/src/references/interfaces/reference-id.interface.ts index f5fde8b57..9ccfb7d7d 100644 --- a/packages/ts-core/src/references/interfaces/reference-id.interface.ts +++ b/packages/ts-core/src/references/interfaces/reference-id.interface.ts @@ -2,6 +2,7 @@ import { ReferenceId } from '../reference.types'; /** * Identifiable by id. + * * @see https://en.wikipedia.org/wiki/Reference_(computer_science) */ export interface ReferenceIdInterface { diff --git a/packages/typeorm-common/src/services/base.service.ts b/packages/typeorm-common/src/services/base.service.ts index 7eeb9bb05..5cd2c1ef4 100644 --- a/packages/typeorm-common/src/services/base.service.ts +++ b/packages/typeorm-common/src/services/base.service.ts @@ -16,6 +16,7 @@ export abstract class BaseService { /** * Constructor + * * @param repo - instance of the repo */ constructor(private repo: Repository) { @@ -24,6 +25,7 @@ export abstract class BaseService { /** * Find One wrapper. + * * @param findOneOptions - Find options * @param queryOptions - Query options */ @@ -42,6 +44,7 @@ export abstract class BaseService { /** * Return the correct repository instance. + * * @param queryOptions - Options */ public repository(queryOptions?: QueryOptionsInterface): Repository { @@ -50,6 +53,7 @@ export abstract class BaseService { /** * Return a transaction instance. + * * @param options - Options */ public transaction( diff --git a/packages/typeorm-common/src/services/lookup.service.ts b/packages/typeorm-common/src/services/lookup.service.ts index 89a7963b5..507f1f9c0 100644 --- a/packages/typeorm-common/src/services/lookup.service.ts +++ b/packages/typeorm-common/src/services/lookup.service.ts @@ -16,6 +16,7 @@ export abstract class LookupService { /** * Constructor + * * @param repo - instance of the repo */ constructor(repo: Repository) { @@ -24,6 +25,7 @@ export abstract class LookupService /** * Get entity for the given id. + * * @param id - the id * @param queryOptions - query options */ diff --git a/packages/typeorm-common/src/services/mutate.service.ts b/packages/typeorm-common/src/services/mutate.service.ts index c0ab1e3fc..635c98283 100644 --- a/packages/typeorm-common/src/services/mutate.service.ts +++ b/packages/typeorm-common/src/services/mutate.service.ts @@ -38,6 +38,7 @@ export abstract class MutateService< /** * Constructor + * * @param repo - instance of the repo */ constructor(repo: Repository) { @@ -46,6 +47,7 @@ export abstract class MutateService< /** * Create one + * * @param data - the reference to create * @returns the created reference */ @@ -65,6 +67,7 @@ export abstract class MutateService< /** * Update one + * * @param data - the reference data to update * @returns the updated reference */ @@ -89,6 +92,7 @@ export abstract class MutateService< /** * Replace one + * * @param data - the reference data to replace * @returns the replaced reference */ @@ -113,6 +117,7 @@ export abstract class MutateService< /** * Remove one + * * @param data - the reference data to remove * @param queryOptions - query options * @returns the removed reference diff --git a/packages/typeorm-common/src/utils/safe-transaction.util.ts b/packages/typeorm-common/src/utils/safe-transaction.util.ts index 9b80032f7..534100d55 100644 --- a/packages/typeorm-common/src/utils/safe-transaction.util.ts +++ b/packages/typeorm-common/src/utils/safe-transaction.util.ts @@ -12,6 +12,7 @@ import { RunInTransactionCallback } from '../typeorm-common.types'; * To silently ignore drivers that don't support transactions, set strict mode to false. * In this case, your `runInTransaction` callback will receive `undefined` for the value * of `entityManager`. + * * @param entityManager - Entity manager instance * @param runInTransaction - Transaction callback * @param options - Options