Files
PaperClipAI/ui/src/pages/useInstallTeamCatalogEntry.test.tsx
T
fff3832a01 [codex] Add teams catalog extraction (#7550)
Fixes #7551

## Thinking Path

> - Paperclip is the control plane for AI-agent companies, and reusable
company/team setup is part of making those companies faster to launch.
> - The teams catalog work introduces app-shipped team templates that
can be browsed, previewed, and installed into a company.
> - Catalog installation crosses several contracts: bundled package
contents, shared API types, server import/install behavior, CLI
workflows, and the board UI.
> - Agents also need a safe path through catalog installs: scoped
company selection, explicit source policy, approval fallback for agent
creation, and preserved catalog provenance.
> - This pull request extracts the completed teams catalog branch into
one reviewable PR on top of `public-gh/master`.
> - The benefit is a reusable teams catalog foundation with server, CLI,
package, docs, and hidden UI surfaces kept in sync.

## What Changed

- Added the `@paperclipai/teams-catalog` package with bundled/optional
team definitions, generated manifest, validators, catalog builder tests,
and migration notes.
- Added shared teams catalog types/validators plus server routes and
services for listing, previewing, and installing catalog teams.
- Integrated catalog install with company portability, skill/source
policy checks, provenance metadata, origin hashes, target-manager
reparenting, and installed/out-of-date detection.
- Added CLI `teams` commands and agent-safe company selection behavior,
including `company current` and approval fallback for forbidden
agent-run installs.
- Added hidden Team Catalog UI/API/query surfaces, Storybook fixtures,
and targeted UI tests while keeping the UI route out of primary
navigation.
- Added docs for CLI/company/teams catalog behavior and removed
generated screenshot artifacts from the PR diff.

## Verification

- `pnpm exec vitest run cli/src/__tests__/company.test.ts
cli/src/__tests__/teams.test.ts
packages/teams-catalog/src/catalog-builder.test.ts
packages/teams-catalog/src/shipped-catalog.test.ts
server/src/__tests__/agent-permissions-service.test.ts
server/src/__tests__/company-portability.test.ts
server/src/__tests__/company-skills-service.test.ts
server/src/__tests__/teams-catalog-routes.test.ts
server/src/__tests__/teams-catalog-service.test.ts
server/src/__tests__/teams-catalog-install-no-overrides.test.ts
ui/src/lib/company-routes.test.ts ui/src/pages/TeamCard.test.tsx
ui/src/pages/TeamCatalog.test.tsx
ui/src/pages/useInstallTeamCatalogEntry.test.tsx`
- `pnpm --filter @paperclipai/shared typecheck && pnpm --filter
@paperclipai/teams-catalog typecheck && pnpm --filter paperclipai
typecheck && pnpm --filter @paperclipai/server typecheck && pnpm
--filter @paperclipai/ui typecheck`
- Confirmed branch is rebased onto `public-gh/master` (`78dc3625a`) and
`public-gh/master` is an ancestor of `HEAD`.
- Confirmed PR diff excludes `pnpm-lock.yaml`, `.github/workflows/*`,
generated screenshot images, and screenshot helper scripts.

## Risks

- Medium review surface: this crosses package generation, shared
contracts, server install behavior, CLI, docs, and hidden UI code.
- Catalog install behavior creates agents/projects/tasks/skills and must
keep company scoping, permissions, source policy, and provenance checks
strict.
- `pnpm-lock.yaml` is intentionally excluded per repo policy;
CI/default-branch automation owns lockfile refresh.
- The Team Catalog UI is included but hidden from primary navigation, so
future enablement should re-check visual QA before exposure.

> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.
>
> ROADMAP checked: this aligns with reusable companies/templates and
plugin-adjacent onboarding work. This PR packages work already developed
on the Paperclip task branch for review.

## Model Used

- OpenAI Codex, GPT-5 series coding agent in this Paperclip session;
exact runtime context window was not exposed. Used shell, git, `gh`, and
local test/typecheck tooling.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots, or documented why screenshots are intentionally omitted
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-05 12:55:49 -05:00

144 lines
4.6 KiB
TypeScript

// @vitest-environment jsdom
import { flushSync } from "react-dom";
import { createRoot } from "react-dom/client";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import {
EMPTY_INSTALL_FORM,
useInstallTeamCatalogEntry,
type TeamInstallFormState,
type UseInstallTeamCatalogEntryResult,
} from "./TeamCatalog";
import { sampleTeam } from "./TeamCatalog.fixtures";
const mockTeamCatalogApi = vi.hoisted(() => ({
catalogList: vi.fn(),
catalogDetail: vi.fn(),
catalogFile: vi.fn(),
preview: vi.fn(),
install: vi.fn(),
}));
vi.mock("../api/teamCatalog", () => ({ teamCatalogApi: mockTeamCatalogApi }));
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(globalThis as any).IS_REACT_ACT_ENVIRONMENT = true;
async function act(callback: () => void | Promise<void>) {
let result: void | Promise<void> = undefined;
flushSync(() => {
result = callback();
});
await result;
}
async function flushReact() {
await act(async () => {
await Promise.resolve();
await new Promise((resolve) => window.setTimeout(resolve, 0));
});
}
// Capture the live hook result so assertions can read it and drive its actions.
let captured: UseInstallTeamCatalogEntryResult | null = null;
function Harness({ simplified }: { simplified: boolean }) {
captured = useInstallTeamCatalogEntry({
companyId: "company-1",
team: sampleTeam,
simplified,
});
return null;
}
async function renderHook(simplified: boolean) {
const container = document.createElement("div");
document.body.appendChild(container);
const root = createRoot(container);
const queryClient = new QueryClient({ defaultOptions: { queries: { retry: false } } });
await act(async () => {
root.render(
<QueryClientProvider client={queryClient}>
<Harness simplified={simplified} />
</QueryClientProvider>,
);
});
await flushReact();
return () => {
root.unmount();
container.remove();
};
}
describe("useInstallTeamCatalogEntry", () => {
beforeEach(() => {
captured = null;
mockTeamCatalogApi.preview.mockResolvedValue({});
mockTeamCatalogApi.install.mockResolvedValue({ portabilityImport: {}, skillPreparations: [], warnings: [] });
});
afterEach(() => {
vi.clearAllMocks();
document.body.innerHTML = "";
});
it("standard flow surfaces the target-manager and source-policy steps", async () => {
// sampleTeam has root agents + an unpinned external source.
const cleanup = await renderHook(false);
expect(captured!.steps).toContain("target_manager");
expect(captured!.steps).toContain("source_policy");
cleanup();
});
it("simplified flow drops target-manager and source-policy steps", async () => {
const cleanup = await renderHook(true);
expect(captured!.steps).not.toContain("target_manager");
expect(captured!.steps).not.toContain("source_policy");
// Required skills still resolve, preview is always last.
expect(captured!.steps[captured!.steps.length - 1]).toBe("preview");
cleanup();
});
it("simplified flow forces a full-company-equivalent target (null manager)", async () => {
const cleanup = await renderHook(true);
const form: TeamInstallFormState = {
...EMPTY_INSTALL_FORM,
targetManagerAgentId: "agent-should-be-ignored",
};
expect(captured!.buildPreviewOptions(form).targetManagerAgentId).toBeNull();
expect(captured!.buildInstallOptions(form).targetManagerAgentId).toBeNull();
cleanup();
});
it("standard flow honors the chosen target manager and adapter overrides", async () => {
const cleanup = await renderHook(false);
const form: TeamInstallFormState = {
...EMPTY_INSTALL_FORM,
targetManagerAgentId: "agent-7",
adapterOverrides: { ceo: "codex_local" },
};
const preview = captured!.buildPreviewOptions(form);
expect(preview.targetManagerAgentId).toBe("agent-7");
const install = captured!.buildInstallOptions(form);
expect(install.adapterOverrides).toEqual({ ceo: { adapterType: "codex_local" } });
cleanup();
});
it("runInstall calls the install API and resolves to the done phase", async () => {
const cleanup = await renderHook(true);
await act(async () => {
captured!.runInstall(EMPTY_INSTALL_FORM);
});
await flushReact();
expect(mockTeamCatalogApi.install).toHaveBeenCalledTimes(1);
expect(mockTeamCatalogApi.install).toHaveBeenCalledWith(
"company-1",
sampleTeam.id,
expect.objectContaining({ targetManagerAgentId: null }),
);
expect(captured!.phase).toBe("done");
cleanup();
});
});