the-ipc-contract-audit

Audit IPC contract changes across TypeScript and Zod schemas.

3|1|Updated Mar 25, 2026
One-click install
npx skills add https://github.com/sendbird-playground/stave --skill the-ipc-contract-audit
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: the-ipc-contract-audit
Source: https://github.com/sendbird-playground/stave/tree/main/skills/the-ipc-contract-audit
Command: npx skills add https://github.com/sendbird-playground/stave --skill the-ipc-contract-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

IPC contracts and provider events are delicate and can drift across multiple files, leading to runtime failures if not audited consistently.

Core Features & Use Cases

  • Cross-file audit of IPC and provider-event changes, including TS types, Zod schemas, and host-service dispatch paths.
  • Guidance to keep electron/providers/types.ts, src/lib/providers/provider.types.ts, src/lib/providers/schemas.ts, src/types/window-api.d.ts, electron/preload.ts, electron/main/ipc/schemas.ts, and related call sites in sync.
  • Safety-focused checks for prompt injection, data exfiltration risk, and runtime option misconfigurations during IPC changes.

Quick Start

Run the IPC contract audit after modifying IPC or provider-event definitions to verify alignment across all touched files and paths.

Frequently Asked Questions about the-ipc-contract-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep TypeScript types and Zod schemas in sync across IPC files?▼

Maintain TS and Zod schema synchronization by auditing provider and consumer call sites across files like src/types/window-api.d.ts. This cross-file consistency check requires updating TS unions and Zod schemas together to prevent drift.

Why do my IPC provider events fail at runtime after schema updates?▼

IPC provider events fail at runtime when TypeScript unions and Zod schemas drift across files like src/lib/providers/provider.types.ts and electron/main/ipc/schemas.ts. Auditing these contract changes ensures alignment and prevents failures.

What is the best way to validate IPC contract changes across Electron preload and main processes?▼

The best way to validate IPC contract changes is a cross-file audit covering electron/preload.ts, electron/main/ipc/schemas.ts, and producer call sites. This mandates verification via type checks and end-to-end tests to ensure alignment.

Do I need end-to-end tests to verify IPC contract updates?▼

Yes, you need end-to-end tests to verify IPC contract updates. The audit process mandates verification via type checks and end-to-end tests to ensure TS and Zod schemas stay in sync across all touched files.