convex-component-authoring

Guide creation, structuring, and publishing of self-contained Convex components.

Updated Aug 30, 2025
One-click install
npx skills add https://github.com/kristofferaas/deep-stortinget --skill convex-component-authoring-kristofferaas
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-component-authoring
Source: https://github.com/kristofferaas/deep-stortinget/tree/main/.agents/skills/convex-component-authoring
Command: npx skills add https://github.com/kristofferaas/deep-stortinget --skill convex-component-authoring-kristofferaas

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of creating modular, reusable, and maintainable backend logic within the Convex framework by providing a structured approach to component authoring.

Core Features & Use Cases

  • Component Isolation: Define self-contained units with their own database tables, functions, and types.
  • Structured Development: Follow a clear directory structure and configuration pattern for components.
  • Publishing & Reusability: Package components for easy sharing and integration across different Convex applications.
  • Use Case: Develop a generic authentication component that can be easily plugged into multiple Convex projects, ensuring consistent security practices without code duplication.

Quick Start

Create a new Convex component by defining its schema, functions, and configuration in a dedicated directory.

Frequently Asked Questions about convex-component-authoring

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

FAQPage Schema
How do I build reusable Convex components in TypeScript?

To build reusable Convex components, define self-contained units with isolated database tables, exported functions, and TypeScript type definitions. Follow a structured directory pattern to modularize backend services for sharing across multiple Convex applications.

How do I isolate database tables when creating a Convex backend package?

Database table isolation in a Convex backend package is achieved by defining self-contained component units. This ensures each reusable component manages its own schema and tables without causing naming conflicts across different Convex projects.

What is the best way to structure a Convex component for npm publishing?

The best way to structure a Convex component for publishing is to organize its schema, functions, and configuration into a dedicated directory. This modular structure facilitates dependency management and integration across different Convex applications.

Can I share authentication logic across multiple Convex backend projects?

Yes, you can share authentication logic by developing a generic Convex component. Packaging your security functions and TypeScript types creates a reusable module that plugs into multiple projects without code duplication.

How do I export TypeScript type definitions from a Convex component?

Exporting TypeScript type definitions from a Convex component involves declaring them within the component's dedicated directory structure. This allows consuming applications to import and use the types for modular backend service integration.

Do I need any external dependencies to create reusable Convex components?

No external dependencies are required to create reusable Convex components. The Skill focuses on structuring self-contained units using native Convex features for database table isolation, function exports, and TypeScript type definitions.