integration-patterns-skill

Implement Nango actions and syncs with strict schemas and explicit parameters.

45|32|Updated Sep 23, 2024
One-click install
npx skills add https://github.com/NangoHQ/integration-templates --skill integration-patterns-skill
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: integration-patterns-skill
Source: https://github.com/NangoHQ/integration-templates/tree/main/.claude/skills/integration-patterns-skill
Command: npx skills add https://github.com/NangoHQ/integration-templates --skill integration-patterns-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides a set of shared patterns to ensure reliability, type safety, and proper registration for Nango actions and syncs used across integrations.

Core Features & Use Cases

  • Inline schema conventions and explicit parameter naming
  • Static endpoint guidance and clear API documentation practices
  • Guidance for end-to-end integration patterns and code reviews

Quick Start

Integrate this skill as a dependency in your action or sync build to adopt its patterns.

Frequently Asked Questions about integration-patterns-skill

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

FAQPage Schema
How do I enforce type safety and strict schemas for Nango actions and syncs?

To enforce type safety for Nango actions and syncs, apply inline schemas, ensure null-safe optional fields, and avoid default values in schemas. These patterns guarantee strict validation and prevent runtime type mismatches.

What are the best coding standards for registering new Nango integration patterns?

The best coding standards for Nango integration patterns involve explicit parameter naming, mandatory index.ts imports, and static endpoint documentation. Following these registration patterns ensures integrations are reliable, type-safe, and easily maintainable.

How do I document API endpoints and parameter naming for Nango syncs?

To document API endpoints and parameter naming for Nango syncs, use static endpoint guidance and explicit parameter naming conventions. This practice ensures API endpoints are clearly documented and parameter mappings remain transparent during code reviews.

Does this integration patterns guidance apply to code reviews of existing Nango actions?

Yes, this integration patterns guidance applies to code reviews of existing Nango actions. It evaluates existing syncs against requirements like inline schemas, null-safe optional fields, and mandatory index.ts imports to ensure robust integration quality.

Why should I use inline schemas instead of default values in Nango integrations?

You should use inline schemas instead of default values in Nango integrations to maintain strict type safety and predictable parameter behavior. Avoiding default values in schemas prevents silent data masking and ensures explicit parameter registration.