convex-component-authoring

Create and publish self-contained Convex components with isolated schemas and exports.

Updated Feb 1, 2026
One-click install
npx skills add https://github.com/EricJamesCrow/smartpockets --skill convex-component-authoring-ericjamescrow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-component-authoring
Source: https://github.com/EricJamesCrow/smartpockets/tree/main/.claude/skills/convex-component-authoring
Command: npx skills add https://github.com/EricJamesCrow/smartpockets --skill convex-component-authoring-ericjamescrow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex Component Authoring provides a structured path to create, structure, and publish self-contained Convex components with clean isolation, exports, and dependency management, enabling teams to share reusable components across projects.

Core Features & Use Cases

  • Self-contained components with isolated data schemas, functions, and type definitions.
  • Clear export surface for consuming apps, including queries, mutations, and hooks.
  • Publishing-ready scaffolding with a recommended project layout and build configuration for npm.

Quick Start

Create a new convex component project, configure the component, and publish it to your package registry.

Frequently Asked Questions about convex-component-authoring

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

FAQPage Schema
How do I create and publish a reusable Convex component?

To publish a reusable Convex component, you structure a project with isolated schemas and functions, define a clear export surface for consuming apps, then use the recommended build configuration for npm publishing.

What does it mean to have isolated schemas in a Convex component?

Having isolated schemas in a Convex component means the data tables, functions, and type definitions are self-contained within the package. This ensures clean separation of concerns and prevents schema conflicts when consuming apps integrate the component.

How do I export queries and mutations from a Convex package?

You export queries and mutations from a Convex package by defining a clear export surface within your component configuration. This provides consuming apps with type-safe interfaces and direct access to the component's functions and hooks.

Can I use TypeScript to build type-safe interfaces for Convex components?

Yes, you can use TypeScript to build type-safe interfaces for Convex components. The authoring process enforces type definitions and isolated schemas, ensuring consuming apps receive strict type safety across projects.

What is the recommended project layout for publishing a Convex component to npm?

The recommended project layout for publishing a Convex component to npm includes publishing-ready scaffolding with specific build configurations. This layout enforces component configuration, schema definitions, and exports for dependency management.

Why do I need to configure exports when building reusable Convex packages?

You need to configure exports when building reusable Convex packages to establish a clear export surface for consuming apps. This enforces type-safe interfaces and isolates internal functions, preventing unauthorized access to component logic.