convex-helpers-guide

Implements reusable Convex backend patterns with convex-helpers utilities.

Updated Jun 8, 2024
One-click install
npx skills add https://github.com/shadeiskndr/portfolio --skill convex-helpers-guide-shadeiskndr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-helpers-guide
Source: https://github.com/shadeiskndr/portfolio/tree/main/.agents/skills/convex-helpers-guide
Command: npx skills add https://github.com/shadeiskndr/portfolio --skill convex-helpers-guide-shadeiskndr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex backends can become repetitive when you need relationships, auth wrappers, filtering, sessions, validation, migrations, or triggers, so this guide helps you apply ready-made convex-helpers utilities consistently instead of reinventing patterns.

Core Features & Use Cases

  • Relationship Helpers: Load related data across tables in a type-safe way, including many-to-many via junction tables.
  • Custom Functions for Data Protection (Primary Use Case): Implement Convex-wide auth/access control using custom query/mutation wrappers instead of database policies.
  • Filtering, Sessions, and Zod Validation: Handle computed filters, track anonymous users, and use Zod schemas for stronger validation.
  • Operations Power-Ups: Use migrations for safe backfills, triggers for reactive updates, and aggregations for efficient summary stats.

Quick Start

Ask the AI to recommend which convex-helpers utilities to use for your Convex backend given that you need auth-scoped queries, nested related data loading, and Zod-based input validation.

Frequently Asked Questions about convex-helpers-guide

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

FAQPage Schema
How do I implement auth wrappers for Convex queries and mutations?

Auth wrappers for Convex queries are implemented using custom functions from convex-helpers. This pattern applies reusable query and mutation wrappers to enforce access control and type-safe data protection across your backend.

What is the best way to load related data across Convex tables?

Loading related data across Convex tables is handled by relationship helpers in convex-helpers. These utilities provide type-safe relationship traversal for nested data loading, including many-to-many structures managed via junction tables.

How do I add Zod validation to Convex backend functions?

Zod validation is added to Convex backend functions by importing validation utilities from convex-helpers. This allows you to define Zod schemas for stronger input validation and safe data handling within your queries and mutations.

Can I run database migrations and triggers in Convex?

Database migrations and triggers are supported in Convex using operations power-ups from convex-helpers. Migrations enable safe data backfills, while triggers facilitate reactive updates to maintain efficient summary aggregations.

Do I need to install convex-helpers to use custom query wrappers?

Installing convex-helpers is required to use custom query wrappers for data protection. You must also ensure you are using the correct server and client imports to satisfy typed access control and reusable wrapper patterns.