@hubspot/ui-extensions-dev-server 1.0.2 → 1.1.0

package/dist/lib/__tests__/extensionsService.spec.js

@@ -1,150 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import path from 'path';
-vi.mock('../utils', () => ({
-    loadManifest: vi.fn(() => {
-        return {
-            name: 'fake manifest file',
-        };
-    }),
-}));
-import { EXTENSIONS_MESSAGE_VERSION, PLATFORM_VERSION } from "../constants.js";
-import extensionsService from "../extensionsService.js";
-import { loadManifest } from "../utils.js";
-import { DevServerState } from "../DevServerState.js";
-import { createMockLogger, createDevServerConfig } from "./factories.js";
-describe('extensionsService', () => {
-    let devServerState;
-    let logger;
-    beforeEach(() => {
-        logger = createMockLogger();
-        devServerState = new DevServerState(createDevServerConfig(logger));
-    });
-    describe('add', () => {
-        it('should add a GET endpoint to /extensions', () => {
-            const server = {
-                get: vi.fn(),
-            };
-            extensionsService.add(
-            // TypeScript wants us to mock the entire Express Application object which is excessive
-            server, devServerState, []);
-            expect(server.get).toHaveBeenCalledTimes(1);
-            expect(server.get).toHaveBeenCalledWith('/extensions', expect.any(Function));
-        });
-    });
-    describe('generateExtensionsHandler', () => {
-        it('should return a handler method', () => {
-            const result = extensionsService.generateExtensionsHandler(devServerState);
-            expect(result).toStrictEqual(expect.any(Function));
-        });
-        it('should return a handler that returns data about which extensions are running', () => {
-            const capabilities = ['capability-1', 'capability-2'];
-            const handler = extensionsService.generateExtensionsHandler(devServerState, capabilities);
-            const jsonMethod = vi.fn();
-            const response = {
-                status: vi.fn(() => {
-                    return {
-                        json: jsonMethod,
-                    };
-                }),
-            };
-            // Don't want to mock full express types because they are huge, so type assert
-            handler({}, response);
-            const { outputDir, expressPort, portalId, extensionsMetadata } = devServerState;
-            expect(loadManifest).toHaveBeenCalledTimes(1);
-            expect(loadManifest).toHaveBeenCalledWith(outputDir, path.parse(extensionsMetadata[0].config.output).name);
-            expect(response.status).toHaveBeenCalledTimes(1);
-            expect(response.status).toBeCalledWith(200);
-            expect(jsonMethod).toHaveBeenCalledTimes(1);
-            expect(jsonMethod).toBeCalledWith({
-                extensions: [
-                    {
-                        manifest: {
-                            name: 'fake manifest file',
-                        },
-                        ...extensionsMetadata[0].baseMessage,
-                    },
-                ],
-                portalId,
-                version: EXTENSIONS_MESSAGE_VERSION,
-                websocket: `ws://localhost:${expressPort}`,
-                capabilities,
-                platformVersion: PLATFORM_VERSION.V20231,
-            });
-        });
-        it('should return a handler that includes platform version in response', () => {
-            const capabilities = ['capability-1', 'capability-2'];
-            const handler = extensionsService.generateExtensionsHandler(devServerState, capabilities);
-            const jsonMethod = vi.fn();
-            const response = {
-                status: vi.fn(() => {
-                    return {
-                        json: jsonMethod,
-                    };
-                }),
-            };
-            handler({}, response);
-            expect(jsonMethod).toHaveBeenCalledWith(expect.objectContaining({
-                platformVersion: PLATFORM_VERSION.V20231,
-            }));
-        });
-        it('should work when platform version is undefined', () => {
-            const mockDevServerState = {
-                extensionsMetadata: [
-                    {
-                        baseMessage: {
-                            appName: 'Test App',
-                            title: 'Test Extension',
-                            callback: 'test.js',
-                        },
-                    },
-                ],
-                outputDir: '/test/output',
-                webSocketPort: 2345,
-                portalId: 12345,
-                functionsConfig: {
-                    platformVersion: undefined,
-                },
-            };
-            const capabilities = ['capability-1', 'capability-2'];
-            const handler = extensionsService.generateExtensionsHandler(
-            // @ts-expect-error - we need to test the undefined state
-            mockDevServerState, capabilities);
-            const jsonMethod = vi.fn();
-            const response = {
-                status: vi.fn(() => {
-                    return {
-                        json: jsonMethod,
-                    };
-                }),
-            };
-            handler({}, response);
-            const callArgs = jsonMethod.mock.calls[0][0];
-            expect(callArgs).not.toHaveProperty('platformVersion');
-        });
-        it('should return a handler that sends error responses when something goes wrong', () => {
-            const handler = extensionsService.generateExtensionsHandler(devServerState);
-            const jsonMethod = vi.fn();
-            const response = {
-                status: vi.fn(() => {
-                    return {
-                        json: jsonMethod,
-                    };
-                }),
-            };
-            // @ts-expect-error TS thinks mockImplementationOnce doesn't exist
-            loadManifest.mockImplementationOnce(() => {
-                throw new Error('YOU SHALL NOT PASS');
-            });
-            // Don't want to mock full express types because they are huge, so type assert
-            handler({}, response);
-            expect(response.status).toHaveBeenCalledTimes(1);
-            expect(response.status).toBeCalledWith(500);
-            expect(jsonMethod).toHaveBeenCalledTimes(1);
-            expect(jsonMethod).toBeCalledWith({
-                message: 'Unable to determine which extensions are running',
-            });
-            expect(logger.error).toHaveBeenCalledTimes(1);
-            expect(logger.error).toHaveBeenCalledWith(expect.stringContaining('Error in /extensions endpoint:'));
-        });
-    });
-});

package/dist/lib/__tests__/factories.d.ts

@@ -1,48 +0,0 @@
-import { Logger } from '../types.ts';
-import { ViteDevServer } from 'vite';
-export declare function createMockLogger(): Logger;
-export declare function createMockViteDevServer(): ViteDevServer;
-export declare function createDevServerConfig(logger: Logger, overrides?: {}): {
-    urls: {
-        api: string;
-        web: string;
-    };
-    logger: Logger;
-    accountId: number;
-    platformVersion: "2023.1";
-    expressPort: number;
-    extensionConfigs: {
-        type: string;
-        data: {
-            title: string;
-            uid: string;
-            location: string;
-            module: {
-                file: string;
-            };
-            objectTypes: {
-                name: string;
-            }[];
-            appName: string;
-            sourceId: string;
-        };
-        output: string;
-        path: string;
-        extensionPath: string;
-        extensionConfigPath: string;
-        appConfig: {
-            name: string;
-            description: string;
-            uid: string;
-            scopes: string[];
-            public: boolean;
-            extensions: {
-                crm: {
-                    cards: {
-                        file: string;
-                    }[];
-                };
-            };
-        };
-    }[];
-};

package/dist/lib/__tests__/factories.js

@@ -1,32 +0,0 @@
-import { vi } from 'vitest';
-import { PLATFORM_VERSION } from "../constants.js";
-import { urls } from "../__tests__/fixtures/urls.js";
-import { cardConfig } from "../__tests__/fixtures/extensionConfig.js";
-export function createMockLogger() {
-    return {
-        info: vi.fn(),
-        debug: vi.fn(),
-        warn: vi.fn(),
-        error: vi.fn(),
-    };
-}
-export function createMockViteDevServer() {
-    return {
-        middlewares: vi.fn(),
-        pluginContainer: {
-            close: vi.fn(async () => { }),
-        },
-        close: vi.fn(async () => { }),
-    };
-}
-export function createDevServerConfig(logger, overrides = {}) {
-    return {
-        urls,
-        logger,
-        accountId: 12345,
-        platformVersion: PLATFORM_VERSION.V20231,
-        expressPort: 1234,
-        extensionConfigs: [cardConfig],
-        ...overrides,
-    };
-}

package/dist/lib/__tests__/fixtures/extensionConfig.d.ts

@@ -1,182 +0,0 @@
-import { UnifiedAppComponent, UnifiedAppConfig, UnifiedExtensionComponent } from '../../types.ts';
-export declare const appComponent: {
-    config: {
-        name: string;
-        public: boolean;
-        scopes: never[];
-        description: string;
-        extensions: {
-            crm: {
-                cards: {
-                    file: string;
-                }[];
-            };
-        };
-    };
-    type: "private-app";
-    path: string;
-};
-export declare const appComponentTwoCards: any;
-export declare const appConfig: {
-    name: string;
-    description: string;
-    uid: string;
-    scopes: string[];
-    public: boolean;
-    extensions: {
-        crm: {
-            cards: {
-                file: string;
-            }[];
-        };
-    };
-};
-export declare const unifiedAppConfig: UnifiedAppComponent;
-export declare const transformedUnifiedAppConfig: UnifiedAppConfig;
-export declare const transformedUnifiedAppConfigTwoCards: UnifiedAppConfig;
-export declare const cardConfig: {
-    type: string;
-    data: {
-        title: string;
-        uid: string;
-        location: string;
-        module: {
-            file: string;
-        };
-        objectTypes: {
-            name: string;
-        }[];
-        appName: string;
-        sourceId: string;
-    };
-    output: string;
-    path: string;
-    extensionPath: string;
-    extensionConfigPath: string;
-    appConfig: {
-        name: string;
-        description: string;
-        uid: string;
-        scopes: string[];
-        public: boolean;
-        extensions: {
-            crm: {
-                cards: {
-                    file: string;
-                }[];
-            };
-        };
-    };
-};
-export declare const cardConfigTwo: {
-    type: string;
-    data: {
-        title: string;
-        uid: string;
-        location: string;
-        module: {
-            file: string;
-        };
-        objectTypes: {
-            name: string;
-        }[];
-        appName: string;
-        sourceId: string;
-    };
-    output: string;
-    path: string;
-    extensionPath: string;
-    extensionConfigPath: string;
-    appConfig: {
-        name: string;
-        description: string;
-        uid: string;
-        scopes: string[];
-        public: boolean;
-        extensions: {
-            crm: {
-                cards: {
-                    file: string;
-                }[];
-            };
-        };
-    };
-};
-export declare const unifiedCardOneConfig: UnifiedExtensionComponent;
-export declare const transformedUnifiedCardOneConfig: {
-    type: string;
-    data: {
-        title: string;
-        uid: string;
-        location: string;
-        module: {
-            file: string;
-        };
-        objectTypes: {
-            name: string;
-        }[];
-        appName: string;
-        sourceId: string;
-    };
-    output: string;
-    path: string;
-    extensionPath: string;
-    extensionConfigPath: string;
-};
-export declare const unifiedCardTwoConfig: UnifiedExtensionComponent;
-export declare const transformedUnifiedCardTwoConfig: {
-    type: string;
-    data: {
-        title: string;
-        uid: string;
-        location: string;
-        module: {
-            file: string;
-        };
-        objectTypes: {
-            name: string;
-        }[];
-        appName: string;
-        sourceId: string;
-    };
-    output: string;
-    path: string;
-    extensionPath: string;
-    extensionConfigPath: string;
-};
-export declare const settingsExtensionConfig: UnifiedExtensionComponent;
-export declare const settingsExtensionTransformedData: {
-    type: string;
-    data: {
-        title: string;
-        uid: string;
-        location: string;
-        module: {
-            file: string;
-        };
-        appName: string;
-        sourceId: string;
-    };
-    output: string;
-    path: string;
-    extensionPath: string;
-    extensionConfigPath: string;
-};
-export declare const appHomesConfig: UnifiedExtensionComponent;
-export declare const appHomesTransformedData: {
-    type: string;
-    data: {
-        title: string;
-        uid: string;
-        location: string;
-        module: {
-            file: string;
-        };
-        appName: string;
-        sourceId: string;
-    };
-    output: string;
-    path: string;
-    extensionPath: string;
-    extensionConfigPath: string;
-};