refactor(chore): dist added (#2343)

BREAKING CHANGE:
YES

GH-2323-dist

Co-authored-by: Vaibhav  Bhalla <vaibhav.bhalla@SFSupports-MacBook-Air.local>

Author: vaibhavbhalla2505

packages/cache/src/services/cache.service.ts

@@ -224,6 +224,22 @@ export class CacheService implements ICacheService {
     return this.store.set(insertionKey, insertionValue, this.configuration.ttl);
   }
 
+  /**
+   * The function `verifyInsertionTime` checks if an insertion is valid based on insertion and deletion
+   * markers and tag deletion times.
+   * @param {string} prefix - The `prefix` parameter in the `verifyInsertionTime` function is a string
+   * that represents a prefix used in building keys for data storage.
+   * @param {string} key - The `key` parameter in the `verifyInsertionTime` function is a string that
+   * represents a unique identifier for the data being inserted. It is used to build keys for insertion
+   * and deletion markers in the data store.
+   * @param {string[]} tags - The `tags` parameter in the `verifyInsertionTime` function is an array of
+   * strings representing tags associated with a key.
+   * @returns The function `verifyInsertionTime` returns a boolean value. It returns `false` under the
+   * following conditions:
+   * 1. If `insertionValue` is falsy (null, undefined, 0, false).
+   * 2. If any of the `tagDeletionTimes` is not falsy and greater than or equal to `insertionValue`.
+   * 3. If `deletionValue` is
+   */
   private async verifyInsertionTime(
     prefix: string,
     key: string,

packages/core/src/components/bearer-verifier/providers/facades-bearer-token-verify.provider.ts

@@ -29,6 +29,14 @@ export class FacadesBearerTokenVerifyProvider
     public authUserModel?: Constructor<EntityWithIdentifier & IAuthUser>,
   ) {}
 
+  /**
+   * The function verifies a bearer token, checks for token revocation, expiration, and password
+   * expiry, and returns the authenticated user.
+   * @returns The `value()` function returns a BearerFn function that verifies a token. Inside the
+   * function, it first checks if the token is revoked, then verifies the token using a JWT secret key.
+   * If the token is valid, it checks for password expiry and returns either an instance of
+   * `authUserModel` or the user object based on the availability of `authUserModel`.
+   */
   value(): VerifyFunction.BearerFn {
     return async (token: string, req?: Request) => {
       try {

packages/feature-toggle/src/providers/feature-flag-action.provider.ts

@@ -152,6 +152,18 @@ export class FeatureFlagActionProvider implements Provider<FeatureFlagFn> {
     return true;
   }
 
+  /**
+   * The `getStrategy` function returns a filtering strategy based on the specified `operator` or
+   * defaults to an OR strategy.
+   * @param {FilterType | undefined} operator - The `operator` parameter in the `getStrategy` function
+   * is of type `FilterType | undefined`. It is used to determine the filtering strategy based on the
+   * specified `FilterType`. If no `operator` is provided, the function will default to using the OR
+   * filter strategy.
+   * @returns The `getStrategy` function returns a filtering strategy based on the `operator` specified
+   * in the decorator. It uses the `filterStrategyMapping` array to map the `FilterType` to the
+   * corresponding `FilterStrategy`. If the specified `operator` is found in the mapping, the
+   * corresponding strategy is returned. If not found, it defaults to using the `OrFilterStrategy`.
+   */
   getStrategy(operator: FilterType | undefined) {
     /* Filtering strategy based on the `operator` specified in the decorator. It uses the
     `filterStrategyMapping` array to map the `FilterType` to the corresponding `FilterStrategy`.

packages/file-utils/src/services/file-metadata.service.ts

@@ -20,6 +20,11 @@ export class FileMetadataProvider
     private readonly methodName: string,
   ) {}
 
+  /**
+   * This function retrieves file request metadata for a controller class method, ensuring only one
+   * file decorator is allowed.
+   * @returns The `value()` method returns an `IFileRequestMetadata` object or `undefined`.
+   */
   value(): IFileRequestMetadata | undefined {
     if (!this.controllerClass || !this.methodName) return;
     const metadata = getFileMetadata(this.controllerClass, this.methodName);

services/authentication-service/src/services/active-user-fliter-builder.service.ts

@@ -17,6 +17,17 @@ export class ActiveUserFilterBuilderService {
     public userTenantRepo: UserTenantRepository,
   ) {}
 
+  /**
+   * The function `buildActiveUsersFilter` asynchronously builds a filter based on active users,
+   * considering different user identities and inclusion/exclusion criteria.
+   * @param {ActiveUsersFilter} filter - The `buildActiveUsersFilter` function takes in a parameter
+   * `filter` of type `ActiveUsersFilter`. This filter object contains information about the users to
+   * be included or excluded from the filter.
+   * @returns The function `buildActiveUsersFilter` returns an object with the key "actor" containing
+   * an array of actor IDs based on the provided `ActiveUsersFilter` input. The array of actor IDs is
+   * determined based on the conditions specified in the function, including the user identity type,
+   * actor key, and inclusion/exclusion criteria.
+   */
   async buildActiveUsersFilter(filter: ActiveUsersFilter): Promise<AnyObject> {
     let actorIds: string[] = [];
     // sonarignore:start

services/bpmn-service/src/providers/execution-input-validator.provider.ts

@@ -11,6 +11,14 @@ import Ajv from 'ajv';
 export class ExecutionInputValidationProvider
   implements Provider<ExecutionInputValidator>
 {
+  /**
+   * The function `value` returns an asynchronous input validator that uses Ajv to validate input
+   * against a schema and throws an error if validation fails.
+   * @returns An asynchronous function that acts as an execution input validator. The function uses the
+   * Ajv library to compile and validate input data against a given schema. If the input is valid, the
+   * function returns `true`. If the input is invalid, it throws an error with a message indicating the
+   * validation errors.
+   */
   value(): ExecutionInputValidator {
     return async (schema, input) => {
       const ajv = new Ajv();

services/chat-service/src/controllers/message-recipient-message.controller.ts

@@ -40,6 +40,12 @@ export class MessageRecipientMessageController {
       },
     },
   })
+  /**
+   * This async function retrieves a message by its recipient ID.
+   * @param id - The `id` parameter is a string representing the unique identifier of a message
+   * recipient.
+   * @returns A Promise that resolves to a Message object.
+   */
   async getMessage(
     @param.path.string('id') id: typeof MessageRecipient.prototype.id,
   ): Promise<Message> {

services/feature-toggle-service/src/controllers/feature-values.controller.ts

@@ -56,6 +56,14 @@ export class FeatureValuesController {
       },
     },
   })
+  /**
+   * This function creates a new instance of FeatureValues and returns it after saving it to the
+   * database.
+   * @param {FeatureValues} featureValues - The `featureValues` parameter in the `create` function is
+   * of type `FeatureValues`. It is being passed as the request body and is used to create a new
+   * instance of `FeatureValues` in the database using the `featureValuesRepository.create` method.
+   * @returns The `create` method is returning a Promise that resolves to a `FeatureValues` object.
+   */
   async create(
     @requestBody({
       content: {

services/in-mail-service/src/controllers/collector.controller.ts

@@ -90,6 +90,21 @@ export class CollectorController {
       [STATUS_CODE.BAD_REQUEST]: {description: NOT_FOUND_MESSAGE},
     },
   })
+  /**
+   * This function fetches a thread by its ID, retrieves related messages, updates group visibility,
+   * and returns the thread view along with the message count.
+   * @param {string} threadId - The `threadId` parameter is a string that represents the unique
+   * identifier of a thread. It is used to fetch information related to a specific thread in the
+   * system.
+   * @param filter - The `filter` parameter in the `fetchThreadById` function is of type
+   * `Partial<Thread>`, which means it is an object that may contain some properties of the `Thread`
+   * type. This parameter is used to filter the threads based on certain criteria specified in the
+   * object. You can pass
+   * @returns The function `fetchThreadById` is returning an object with two properties: `items` and
+   * `messageCount`. The `items` property contains an array of thread views fetched from the
+   * `threadViewRepository`, while the `messageCount` property contains the length of the `threadView`
+   * array.
+   */
   async fetchThreadById(
     @param.path.string('threadId') threadId: string,
     @param.query.object('filter') filter: Partial<Thread>,

services/notification-service/src/providers/channel-manager.service.ts

@@ -7,6 +7,12 @@ import {IChannelManager} from '../types';
 
 @bind({scope: BindingScope.TRANSIENT})
 export class ChannelManagerProvider implements Provider<IChannelManager> {
+  /**
+   * The function `value` returns an object with a method `isChannelAccessAllowed` that always returns
+   * `true`.
+   * @returns The `value()` function is returning an object with a property `isChannelAccessAllowed`
+   * which is a function that always returns `true`.
+   */
   value() {
     return {
       isChannelAccessAllowed: () => true,