Sign upLogin

RocketChat/Rocket.Chat

View on GitHub
Star
packages/rest-typings/src/v1/rooms.ts

Summary

Maintainability
F
3 days
Test Coverage

File rooms.ts has 593 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import type { IMessage, IRoom, IUser, RoomAdminFieldsType, IUpload } from '@rocket.chat/core-typings';
import Ajv from 'ajv';

import type { PaginatedRequest } from '../helpers/PaginatedRequest';
import type { PaginatedResult } from '../helpers/PaginatedResult';
Severity: Major
Found in packages/rest-typings/src/v1/rooms.ts - About 1 day to fix

    Similar blocks of code found in 10 locations. Consider refactoring.
    Open

    const RoomsAutocompleteChannelAndPrivateWithPaginationSchema = {
    type: 'object',
    properties: {
        selector: {
            type: 'string',
    Severity: Major
    Found in packages/rest-typings/src/v1/rooms.ts and 9 other locations - About 3 hrs to fix
    packages/rest-typings/src/v1/channels/ChannelsGetAllUserMentionsByChannelProps.ts on lines 9..35
    packages/rest-typings/src/v1/channels/ChannelsMessagesProps.ts on lines 11..37
    packages/rest-typings/src/v1/chat.ts on lines 262..287
    packages/rest-typings/src/v1/omnichannel.ts on lines 319..344
    packages/rest-typings/src/v1/omnichannel.ts on lines 443..468
    packages/rest-typings/src/v1/omnichannel.ts on lines 694..719
    packages/rest-typings/src/v1/omnichannel.ts on lines 725..750
    packages/rest-typings/src/v1/omnichannel.ts on lines 810..835
    packages/rest-typings/src/v1/roles.ts on lines 67..92

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 106.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 7 locations. Consider refactoring.
    Open

    const roomsImagesPropsSchema = {
    type: 'object',
    properties: {
        roomId: {
            type: 'string',
    Severity: Major
    Found in packages/rest-typings/src/v1/rooms.ts and 6 other locations - About 2 hrs to fix
    packages/rest-typings/src/v1/chat.ts on lines 210..231
    packages/rest-typings/src/v1/chat.ts on lines 503..524
    packages/rest-typings/src/v1/chat.ts on lines 535..556
    packages/rest-typings/src/v1/chat.ts on lines 567..588
    packages/rest-typings/src/v1/chat.ts on lines 650..671
    packages/rest-typings/src/v1/roles.ts on lines 33..54

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 90.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 9 locations. Consider refactoring.
    Open

    const RoomsInfoSchema = {
    oneOf: [
        {
            type: 'object',
            properties: {
    Severity: Major
    Found in packages/rest-typings/src/v1/rooms.ts and 8 other locations - About 2 hrs to fix
    packages/rest-typings/src/v1/channels/ChannelsArchiveProps.ts on lines 6..29
    packages/rest-typings/src/v1/channels/ChannelsConvertToTeamProps.ts on lines 10..29
    packages/rest-typings/src/v1/channels/ChannelsDeleteProps.ts on lines 7..30
    packages/rest-typings/src/v1/channels/ChannelsLeaveProps.ts on lines 7..30
    packages/rest-typings/src/v1/channels/ChannelsRolesProps.ts on lines 6..29
    packages/rest-typings/src/v1/channels/ChannelsUnarchiveProps.ts on lines 6..29
    packages/rest-typings/src/v1/dm/DmLeaveProps.ts on lines 13..36
    packages/rest-typings/src/v1/omnichannel.ts on lines 1254..1277

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 86.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 3 locations. Consider refactoring.
    Open

    const RoomsChangeArchivationStateSchema = {
    type: 'object',
    properties: {
        rid: {
            type: 'string',
    Severity: Major
    Found in packages/rest-typings/src/v1/rooms.ts and 2 other locations - About 1 hr to fix
    packages/rest-typings/src/v1/autotranslate/AutotranslateTranslateMessageParamsPOST.ts on lines 12..25
    packages/rest-typings/src/v1/emojiCustom.ts on lines 33..46

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 58.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

    export type Notifications = {
    disableNotifications: string;
    muteGroupMentions: string;
    hideUnreadStatus: string;
    desktopNotifications: string;
    Severity: Major
    Found in packages/rest-typings/src/v1/rooms.ts and 1 other location - About 1 hr to fix
    packages/core-typings/src/Apps.ts on lines 3..11

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 58.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

            {
            properties: {
                userId: {
                    type: 'string',
                    minLength: 1,
    Severity: Minor
    Found in packages/rest-typings/src/v1/rooms.ts and 1 other location - About 55 mins to fix
    packages/rest-typings/src/v1/rooms.ts on lines 458..471

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 53.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

            {
            properties: {
                username: {
                    type: 'string',
                    minLength: 1,
    Severity: Minor
    Found in packages/rest-typings/src/v1/rooms.ts and 1 other location - About 55 mins to fix
    packages/rest-typings/src/v1/rooms.ts on lines 444..457

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 53.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 6 locations. Consider refactoring.
    Open

    const RoomsAdminRoomsGetRoomSchema = {
    type: 'object',
    properties: {
        rid: {
            type: 'string',
    Severity: Major
    Found in packages/rest-typings/src/v1/rooms.ts and 5 other locations - About 35 mins to fix
    packages/rest-typings/src/v1/channels/ChannelsOnlineProps.ts on lines 8..18
    packages/rest-typings/src/v1/groups/GroupsOnlineProps.ts on lines 8..18
    packages/rest-typings/src/v1/permissions.ts on lines 12..22
    packages/rest-typings/src/v1/statistics.ts on lines 31..41
    packages/rest-typings/src/v1/subscriptionsEndpoints.ts on lines 16..26

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 46.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 4 locations. Consider refactoring.
    Open

        '/v1/rooms.autocomplete.channelAndPrivate.withPagination': {
        GET: (params: RoomsAutocompleteChannelAndPrivateWithPaginationProps) => {
            items: IRoom[];
            total: number;
        };
    Severity: Major
    Found in packages/rest-typings/src/v1/rooms.ts and 3 other locations - About 35 mins to fix
    packages/rest-typings/src/v1/chat.ts on lines 880..885
    packages/rest-typings/src/v1/chat.ts on lines 886..891
    packages/rest-typings/src/v1/roles.ts on lines 159..164

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 46.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 38 locations. Consider refactoring.
    Open

        '/v1/rooms.images': {
        GET: (params: RoomsImagesProps) => PaginatedResult<{
            files: IUpload[];
        }>;
    };
    Severity: Major
    Found in packages/rest-typings/src/v1/rooms.ts and 37 other locations - About 30 mins to fix
    packages/rest-typings/src/v1/channels/channels.ts on lines 42..46
    packages/rest-typings/src/v1/channels/channels.ts on lines 56..60
    packages/rest-typings/src/v1/channels/channels.ts on lines 133..137
    packages/rest-typings/src/v1/channels/channels.ts on lines 161..165
    packages/rest-typings/src/v1/customSounds.ts on lines 39..43
    packages/rest-typings/src/v1/customUserStatus.ts on lines 39..43
    packages/rest-typings/src/v1/dm/im.ts on lines 43..47
    packages/rest-typings/src/v1/dm/im.ts on lines 59..63
    packages/rest-typings/src/v1/email-inbox.ts on lines 160..162
    packages/rest-typings/src/v1/federation/rooms.ts on lines 17..21
    packages/rest-typings/src/v1/groups/groups.ts on lines 43..47
    packages/rest-typings/src/v1/groups/groups.ts on lines 56..60
    packages/rest-typings/src/v1/groups/groups.ts on lines 101..105
    packages/rest-typings/src/v1/omnichannel.ts on lines 3393..3397
    packages/rest-typings/src/v1/omnichannel.ts on lines 3401..3405
    packages/rest-typings/src/v1/omnichannel.ts on lines 3432..3436
    packages/rest-typings/src/v1/omnichannel.ts on lines 3453..3457
    packages/rest-typings/src/v1/omnichannel.ts on lines 3458..3462
    packages/rest-typings/src/v1/omnichannel.ts on lines 3464..3468
    packages/rest-typings/src/v1/omnichannel.ts on lines 3480..3484
    packages/rest-typings/src/v1/omnichannel.ts on lines 3488..3492
    packages/rest-typings/src/v1/omnichannel.ts on lines 3622..3624
    packages/rest-typings/src/v1/omnichannel.ts on lines 3713..3715
    packages/rest-typings/src/v1/omnichannel.ts on lines 3716..3718
    packages/rest-typings/src/v1/omnichannel.ts on lines 3719..3723
    packages/rest-typings/src/v1/omnichannel.ts on lines 3745..3747
    packages/rest-typings/src/v1/omnichannel.ts on lines 3768..3770
    packages/rest-typings/src/v1/omnichannel.ts on lines 3774..3776
    packages/rest-typings/src/v1/omnichannel.ts on lines 3777..3779
    packages/rest-typings/src/v1/omnichannel.ts on lines 3878..3882
    packages/rest-typings/src/v1/omnichannel.ts on lines 3883..3887
    packages/rest-typings/src/v1/rooms.ts on lines 640..644
    packages/rest-typings/src/v1/users.ts on lines 153..157
    packages/rest-typings/src/v1/videoConference/index.ts on lines 33..35
    packages/rest-typings/src/v1/voip.ts on lines 543..545
    packages/rest-typings/src/v1/voip.ts on lines 558..560
    packages/rest-typings/src/v1/voip.ts on lines 576..578

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 45.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 38 locations. Consider refactoring.
    Open

        '/v1/rooms.getDiscussions': {
        GET: (params: RoomsGetDiscussionsProps) => PaginatedResult<{
            discussions: IRoom[];
        }>;
    };
    Severity: Major
    Found in packages/rest-typings/src/v1/rooms.ts and 37 other locations - About 30 mins to fix
    packages/rest-typings/src/v1/channels/channels.ts on lines 42..46
    packages/rest-typings/src/v1/channels/channels.ts on lines 56..60
    packages/rest-typings/src/v1/channels/channels.ts on lines 133..137
    packages/rest-typings/src/v1/channels/channels.ts on lines 161..165
    packages/rest-typings/src/v1/customSounds.ts on lines 39..43
    packages/rest-typings/src/v1/customUserStatus.ts on lines 39..43
    packages/rest-typings/src/v1/dm/im.ts on lines 43..47
    packages/rest-typings/src/v1/dm/im.ts on lines 59..63
    packages/rest-typings/src/v1/email-inbox.ts on lines 160..162
    packages/rest-typings/src/v1/federation/rooms.ts on lines 17..21
    packages/rest-typings/src/v1/groups/groups.ts on lines 43..47
    packages/rest-typings/src/v1/groups/groups.ts on lines 56..60
    packages/rest-typings/src/v1/groups/groups.ts on lines 101..105
    packages/rest-typings/src/v1/omnichannel.ts on lines 3393..3397
    packages/rest-typings/src/v1/omnichannel.ts on lines 3401..3405
    packages/rest-typings/src/v1/omnichannel.ts on lines 3432..3436
    packages/rest-typings/src/v1/omnichannel.ts on lines 3453..3457
    packages/rest-typings/src/v1/omnichannel.ts on lines 3458..3462
    packages/rest-typings/src/v1/omnichannel.ts on lines 3464..3468
    packages/rest-typings/src/v1/omnichannel.ts on lines 3480..3484
    packages/rest-typings/src/v1/omnichannel.ts on lines 3488..3492
    packages/rest-typings/src/v1/omnichannel.ts on lines 3622..3624
    packages/rest-typings/src/v1/omnichannel.ts on lines 3713..3715
    packages/rest-typings/src/v1/omnichannel.ts on lines 3716..3718
    packages/rest-typings/src/v1/omnichannel.ts on lines 3719..3723
    packages/rest-typings/src/v1/omnichannel.ts on lines 3745..3747
    packages/rest-typings/src/v1/omnichannel.ts on lines 3768..3770
    packages/rest-typings/src/v1/omnichannel.ts on lines 3774..3776
    packages/rest-typings/src/v1/omnichannel.ts on lines 3777..3779
    packages/rest-typings/src/v1/omnichannel.ts on lines 3878..3882
    packages/rest-typings/src/v1/omnichannel.ts on lines 3883..3887
    packages/rest-typings/src/v1/rooms.ts on lines 654..658
    packages/rest-typings/src/v1/users.ts on lines 153..157
    packages/rest-typings/src/v1/videoConference/index.ts on lines 33..35
    packages/rest-typings/src/v1/voip.ts on lines 543..545
    packages/rest-typings/src/v1/voip.ts on lines 558..560
    packages/rest-typings/src/v1/voip.ts on lines 576..578

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 45.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    There are no issues that match your filters.

    Category
    Status