skills.rest
gear-foundation
gear-foundationOFFICIAL
Explore all skills by this author →
Website𝕏@VaraNetworkGitHub

sails-idl-client

Align Gear/Vara Sails IDL and generated Rust and TypeScript clients.

17|23|Updated Mar 12, 2026
Search Tags:#codegen#client-generation#sails-idl#gear-vara#rust-client#typescript-client#contract-evolution
One-click install
npx skills add https://github.com/gear-foundation/vara-skills --skill sails-idl-client
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sails-idl-client
Source: https://github.com/gear-foundation/vara-skills/tree/main/skills/sails-idl-client
Command: npx skills add https://github.com/gear-foundation/vara-skills --skill sails-idl-client

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the friction of broken or misaligned IDL and generated client pipelines for Gear/Vara Sails applications, which commonly cause integration failures between Rust backends, TypeScript frontends, and test suites when contracts are updated or codegen is misconfigured.

Core Features & Use Cases

  • Typed Pipeline Alignment: Keeps IDL generation, Rust client generation, and frontend integration wiring consistent with deployed Sails contract versions.
  • Contract Cutover Management: Supports smooth transitions when contract versions change, ensuring old and new generated clients coexist for frontends, tests, and migration tooling that rely on previous versions.
  • Common Pitfall Mitigation: Prevents frequent issues like custom BTreeMap key decoding failures in generated clients and incorrect codegen artifact output paths.
  • Use Case: When a Sails contract is updated and the existing TypeScript client stops working, this Skill guides you to verify the IDL, regenerate compatible clients, update frontend IDL snapshots, and adjust test setups without breaking existing integrations.

Quick Start

Use the sails-idl-client skill to fix a broken generated client pipeline for your Sails app after a recent contract update.

Frequently Asked Questions about sails-idl-client

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

FAQPage Schema
How do I fix a broken TypeScript client after updating a Sails contract on Gear?▼

To fix a broken TypeScript client after a Sails contract update, verify the deployed IDL, regenerate compatible Rust and TypeScript clients, and update frontend IDL snapshots to maintain pipeline alignment and restore functionality.

What causes BTreeMap key decoding failures in generated Sails clients?▼

BTreeMap key decoding failures in generated Sails clients are common pitfalls caused by misaligned IDL pipelines, which can be mitigated by ensuring consistent IDL generation and typed client codegen output paths.

How do I manage contract cutover periods when upgrading Vara Sails programs?▼

Managing contract cutover periods for Vara Sails programs involves maintaining compatible IDL snapshots so that old and newly generated Rust and TypeScript clients can coexist during the transition for tests and migration tooling.

Does the sails-idl-client skill support both Rust backends and TypeScript frontends?▼

Yes, the skill resolves misalignment and breakage across the Sails IDL pipeline, generating aligned typed clients for both Rust backends and TypeScript frontends to ensure consistent contract integration.

Why is my Sails codegen output writing artifacts to the wrong paths?▼

Incorrect codegen artifact output paths occur when the IDL and client generation pipeline is misconfigured, requiring pipeline realignment to ensure generated Rust and TypeScript clients are output to their correct project directories.

When should I use generated typed clients instead of raw payloads in Sails test suites?▼

You should use generated typed clients instead of raw payloads in test suites to prevent client decoding pitfalls and ensure your tests remain aligned with the actual Sails IDL definitions during contract evolution.

Related Skills

Explore More Software Engineering Skills→
gear-foundationgear-foundation
17

sails-dev-env

Automate cross-platform setup of Rust toolchains, Sails CLI, and Gear binary.

Official
Intermediate
btabaskabtabaska
1

API Contract Test

Generate contract tests validating API endpoints against OpenAPI and TypeScript types.

Community
Intermediate
gear-foundationgear-foundation
17

gear-architecture-planner

Translate Gear and Vara feature specifications into structured architecture and service boundary definitions.

Official
Intermediate
gear-foundationgear-foundation
17

sails-indexer

Build event-driven Postgres read models with GraphQL APIs for Sails apps.

Official
Advanced