upstream-twenty/packages/twenty-docs/scripts/ui/__tests__/documentation-imports.spec.ts

import ts from 'typescript';
import { describe, expect, it } from 'vitest';

import { getDocumentationImportDiagnostics } from '../../../../twenty-ui/docs/getDocumentationImportDiagnostics';

const allowedModules = new Set([
  'twenty-ui',
  'twenty-ui/primitives/input',
  'twenty-ui/style.css',
  'react',
]);

const checkImports = (content: string) =>
  getDocumentationImportDiagnostics({
    source: ts.createSourceFile(
      'example.tsx',
      content,
      ts.ScriptTarget.Latest,
      true,
      ts.ScriptKind.TSX,
    ),
    allowedModules,
  });

describe('documentation imports', () => {
  it('allows public entry points, exported CSS, and peer dependencies', () => {
    expect(
      checkImports(`
      import { Input } from 'twenty-ui/primitives/input';
      import 'twenty-ui/style.css';
      export { Text } from 'twenty-ui';
      import { useState } from 'react';
    `),
    ).toEqual([]);
  });

  it.each([
    "import { Internal } from 'twenty-ui/internal';",
    "import 'twenty-ui/private.css';",
    "export { Internal } from 'twenty-ui/internal';",
    "const component = import('twenty-ui/internal');",
    "type Internal = import('twenty-ui/internal').Internal;",
    "const component = require('twenty-ui/internal');",
  ])('rejects an unpublished subpath in %s', (content) => {
    const diagnostics = checkImports(content);

    expect(diagnostics).toHaveLength(1);
    expect(diagnostics[0].category).toBe(ts.DiagnosticCategory.Error);
    expect(diagnostics[0].messageText).toContain(
      'is not exported by twenty-ui/package.json',
    );
  });

  it.each([
    "import { Checkbox } from '@ui/primitives/input/Checkbox/Checkbox';",
    "import { Input } from '../../twenty-ui/src/input';",
    "import { vi } from 'vitest';",
  ])('rejects a module outside the public surface in %s', (content) => {
    const diagnostics = checkImports(content);

    expect(diagnostics).toHaveLength(1);
    expect(diagnostics[0].messageText).toContain(
      'is not a twenty-ui entry point or peer dependency',
    );
  });
});