RocketChat/Rocket.Chat

import type { AppStatus } from '@rocket.chat/apps-engine/definition/AppStatus';
import type { IApiEndpointMetadata } from '@rocket.chat/apps-engine/definition/api';
import type { IExternalComponent } from '@rocket.chat/apps-engine/definition/externalComponent';
import type { IPermission } from '@rocket.chat/apps-engine/definition/permissions/IPermission';
import type { ISetting } from '@rocket.chat/apps-engine/definition/settings';
import type { IUIActionButton } from '@rocket.chat/apps-engine/definition/ui';
import type {
    AppScreenshot,
    App,
    FeaturedAppsSection,
    ILogItem,
    AppRequestFilter,
    AppRequestsStats,
    PaginatedAppRequests,
} from '@rocket.chat/core-typings';
import type * as UiKit from '@rocket.chat/ui-kit';

export type AppsEndpoints = {
    '/apps/count': {
        GET: () => { totalMarketplaceEnabled: number; totalPrivateEnabled: number; maxMarketplaceApps: number; maxPrivateApps: number };
    };

    '/apps/externalComponents': {
        GET: () => { externalComponents: IExternalComponent[] };
    };

    '/apps/incompatibleModal': {
        GET: (params: { appId: string; appVersion: string; action: string }) => { url: string };
    };

    '/apps/:id': {
        GET:
            | ((params: { marketplace?: 'true' | 'false'; version?: string; appVersion?: string; update?: 'true' | 'false' }) => {
                    app: App;
              })
            | (() => {
                    app: App;
              });
        DELETE: () => {
            app: App;
            success: boolean;
        };
        POST: (params: { marketplace: boolean; version: string; permissionsGranted?: IPermission[]; appId: string; url?: string }) => {
            app: App;
        };
    };

    '/apps/actionButtons': {
        GET: () => IUIActionButton[];
    };

    '/apps/languages': {
        GET: () => {
            apps: {
                id: string;
                languages: { [language: string]: { [key: string]: string } };
            }[];
        };
    };

    '/apps/public/:appId/get-sidebar-icon': {
        GET: (params: { icon: string }) => unknown;
    };

    '/apps/:id/settings': {
        GET: () => {
            settings: ISetting[];
        };
        POST: (params: { settings: ISetting[] }) => { updated: ISetting[]; success: boolean };
    };

    '/apps/:id/settings/:settingId': {
        GET: () => {
            setting: ISetting;
        };
        POST: (params: { setting: ISetting }) => { success: boolean };
    };

    '/apps/:id/screenshots': {
        GET: () => {
            screenshots: AppScreenshot[];
        };
    };

    '/apps/:id/languages': {
        GET: () => {
            languages: {
                [key: string]: {
                    Params: string;
                    Description: string;
                    Setting_Name: string;
                    Setting_Description: string;
                };
            };
        };
    };

    '/apps/:id/logs': {
        GET: () => {
            logs: ILogItem[];
        };
    };

    '/apps/:id/apis': {
        GET: () => {
            apis: IApiEndpointMetadata[];
        };
    };

    '/apps/bundles/:id/apps': {
        GET: () => {
            apps: App[];
        };
    };

    '/apps/:id/sync': {
        POST: () => {
            app: App;
        };
    };

    '/apps/:id/status': {
        GET: () => {
            status: string;
        };
        POST: (params: { status: AppStatus }) => {
            status: AppStatus;
        };
    };

    '/apps/:id/versions': {
        GET: () => {
            apps: App[];
        };
    };

    '/apps/:id/icon': {
        GET: () => {
            statusCode: 200;
            headers: {
                'Content-Length': number;
                'Content-Type': string;
            };
            body: Buffer;
        };
    };

    '/apps/featured-apps': {
        GET: () => {
            sections: FeaturedAppsSection[];
        };
    };

    '/apps/marketplace': {
        GET: (params: {
            purchaseType?: 'buy' | 'subscription';
            version?: string;
            appId?: string;
            details?: 'true' | 'false';
            isAdminUser?: string;
        }) => App[];
    };

    '/apps/categories': {
        GET: () => {
            createdDate: Date;
            description: string;
            id: string;
            modifiedDate: Date;
            title: string;
        }[];
    };

    '/apps/buildExternalUrl': {
        GET: (params: { purchaseType?: 'buy' | 'subscription'; appId?: string; details?: 'true' | 'false' }) => {
            url: string;
        };
    };

    '/apps/installed': {
        GET: () => { apps: App[] };
    };

    '/apps/buildExternalAppRequest': {
        GET: (params: { appId?: string }) => {
            url: string;
        };
    };

    '/apps/app-request': {
        GET: (params: { appId: string; q?: AppRequestFilter; sort?: string; limit?: number; offset?: number }) => PaginatedAppRequests;
    };

    '/apps/app-request/stats': {
        GET: () => AppRequestsStats;
    };

    '/apps/app-request/markAsSeen': {
        POST: (params: { unseenRequests: Array<string> }) => { succes: boolean };
    };

    '/apps/notify-admins': {
        POST: (params: { appId: string; appName: string; appVersion: string; message: string }) => void;
    };

    '/apps/externalComponentEvent': {
        POST: (params: { externalComponent: string; event: 'IPostExternalComponentOpened' | 'IPostExternalComponentClosed' }) => {
            result: any;
        };
    };

    '/apps': {
        GET:
            | ((params: { buildExternalUrl: 'true'; purchaseType?: 'buy' | 'subscription'; appId?: string; details?: 'true' | 'false' }) => {
                    url: string;
              })
            | ((params: {
                    purchaseType?: 'buy' | 'subscription';
                    marketplace?: 'false';
                    version?: string;
                    appId?: string;
                    details?: 'true' | 'false';
              }) => {
                    apps: App[];
              })
            | ((params: {
                    purchaseType?: 'buy' | 'subscription';
                    marketplace: 'true';
                    version?: string;
                    appId?: string;
                    details?: 'true' | 'false';
              }) => App[])
            | ((params: { categories: 'true' }) => {
                    createdDate: Date;
                    description: string;
                    id: string;
                    modifiedDate: Date;
                    title: string;
              }[])
            | (() => { apps: App[] });

        POST: {
            (
                params:
                    | {
                            appId: string;
                            marketplace: boolean;
                            version: string;
                            permissionsGranted?: IPermission[];
                            url?: string;
                            downloadOnly?: boolean;
                      }
                    | { url: string; downloadOnly?: boolean },
            ):
                | {
                        app: App;
                  }
                | {
                        buff: {
                            data: ArrayLike<number>;
                        };
                  };
        };
    };

    '/apps/ui.interaction/:id': {
        POST: (params: UiKit.UserInteraction) => any;
    };
};