API Contracts and Shared Types

Learning Objectives

After completing this lesson, you will be able to:

• Explain API Contracts and Shared Types in terms of published .d.ts, schema versions, and additive change policy.
• Model web, mobile, and jobs agreeing on enrollment commands without weakening the contract to any.
• Trace what the compiler checks and what JavaScript remains at runtime.
• Recognize and correct this recurring failure mode: a kitchen-sink types package that every team imports for everything.
• Defend when to use API Contracts and Shared Types and when a simpler design is clearer.
• Distinguish the compile-time guarantees of API Contracts and Shared Types from runtime behavior.
• Read and explain compiler diagnostics related to API Contracts and Shared Types.
• Choose a simpler alternative when API Contracts and Shared Types would add unnecessary complexity.
• Apply API Contracts and Shared Types without weakening untrusted input to any.
• Review API Contracts and Shared Types for maintainability in a multi-team codebase.
• Test both accepted and intentionally rejected type scenarios.
• Identify the trust boundaries around code that uses API Contracts and Shared Types.
• Evaluate checker, build, bundle, and runtime costs separately.
• Explain the security limitations of erased TypeScript types.
• Use API Contracts and Shared Types in a production-oriented TechLearningPro design.

Introduction

A growing TechLearningPro codebase must support web, mobile, and jobs agreeing on enrollment commands. Copying loosely related types makes valid changes expensive and lets assumptions drift between the UI, application services, and API adapters. The team needs a design that expresses the relationship explicitly while remaining understandable to reviewers.

This lesson approaches API Contracts and Shared Types as an engineering decision rather than syntax to memorize. You will connect the developer experience to the TypeScript compiler, emitted JavaScript, production boundaries, and the maintenance costs paid by a team over time.

What Is This Concept?

In simple language: A shared contract package is a product with owners and compatibility rules.

Professional explanation: API Contracts and Shared Types is a compile-time modeling technique based on published .d.ts, schema versions, and additive change policy. It lets the checker preserve domain relationships, reject inconsistent programs, and communicate intent without claiming that a TypeScript type validates values at runtime.

Why Do We Need It?

Without API Contracts and Shared Types
        │
        ▼
Ambiguous intent and defects discovered late
        │
        ▼
TypeScript models the contract
        │
        ▼
Earlier feedback, safer change, clearer design

• It makes the relationship behind web, mobile, and jobs agreeing on enrollment commands visible in the program.
• It moves many integration mistakes into editor and CI feedback.
• It reduces duplicated contracts that can drift during refactoring.
• It gives maintainers a precise vocabulary for reviewing design changes.
• It supports the key engineering decision: share stable commands and events; keep UI view models local.

Real-World Analogy

A treaty has numbered articles; it is not a shared junk drawer.

How It Works

Compile time

The checker applies published .d.ts, schema versions, and additive change policy, resolves the resulting relationships, and reports assignments or operations that violate them. These checks happen during editing or compilation and are erased from ordinary JavaScript output.

Runtime

At runtime, API Contracts and Shared Types has no independent type-level behavior: emitted JavaScript follows ordinary JavaScript semantics. External data still requires runtime validation.

1. 1. Identify the invariant in the requirement: web, mobile, and jobs agreeing on enrollment commands.
2. 2. Represent only the information the compiler needs to preserve that invariant.
3. 3. Apply published .d.ts, schema versions, and additive change policy and inspect inference rather than guessing it.
4. 4. Compile under strict mode and test both accepted and rejected calls.
5. 5. Inspect emitted JavaScript when runtime behavior matters.
6. 6. Validate unknown input before it enters the trusted typed core.

Architecture / Flow Diagram

Domain requirement: web, mobile, and jobs agreeing on enrollment commands
        │
        ▼
Type model: API Contracts and Shared Types
        │  compiler applies published .d.ts, schema versions, and additive change policy
        ▼
Accepted program ──or── precise diagnostic
        │
        ▼
Emitted JavaScript (types erased)
        │
        ▼
Runtime validation at every untrusted boundary

Code Examples

export type EnrollCommandV1 = { learnerId: string; courseId: string };

export type EnrollEventV1 = { type: "enrolled"; at: string; command: EnrollCommandV1 };

export type ContractVersion = "v1";

Enterprise Example

TechLearningPro uses API Contracts and Shared Types while implementing web, mobile, and jobs agreeing on enrollment commands. A boundary adapter first validates HTTP or queue payloads as unknown. The application layer then relies on the static contract, and the domain layer stays independent of transport details. Reviewers can distinguish a compile-time guarantee from authorization, validation, and other runtime controls.

Student
   │
   ▼
React / Angular UI
   │ typed command
   ▼
Application service
   │ validated DTO
   ▼
API client ─────► Runtime schema at trust boundary
   │
   ▼
Backend API

Deep Dive

published .d.ts, schema versions, and additive change policy is useful because it preserves a relationship rather than merely replacing a long annotation with a short name. If no meaningful relationship is being enforced, the abstraction may be ceremony.

The principal design risk is a kitchen-sink types package that every team imports for everything. A strong design keeps diagnostics readable, exposes a small public surface, and documents the invariant in domain language.

API Contracts and Shared Types should end at a trust boundary. Parsed JSON, storage records, environment variables, and third-party SDK values begin as unknown; validation creates runtime evidence before a typed domain value is constructed.

The governing trade-off is share stable commands and events; keep UI view models local. Prefer the least powerful construct that keeps invalid states unrepresentable and remains easy for another engineer to modify.

Common Mistakes

For each mistake, identify the false assumption and replace it with an explicit contract:

1. 1. Treating API Contracts and Shared Types as runtime validation; types are erased and hostile input is unchanged.
2. 2. Using any to silence a failure instead of understanding published .d.ts, schema versions, and additive change policy.
3. 3. Ignoring the central pitfall: a kitchen-sink types package that every team imports for everything.
4. 4. Adding assertions before proving the asserted fact.
5. 5. Designing from implementation shapes instead of domain invariants.
6. 6. Publishing an abstraction whose diagnostics are harder than the duplicated code.
7. 7. Testing only successful examples and never adding compile-time negative cases.
8. 8. Coupling domain contracts to a framework, transport, or generated client unnecessarily.
9. 9. Assuming a more sophisticated type improves runtime speed; it does not.
10. 10. Repeating a previously taught contract instead of composing the next layer of the design.

Best Practices

• Enable strict mode and keep strictNullChecks on.
• Start with a concrete domain example before extracting an abstraction.
• Name the invariant behind web, mobile, and jobs agreeing on enrollment commands.
• Document why published .d.ts, schema versions, and additive change policy is necessary.
• Prefer unknown to any at untrusted boundaries.
• Validate external values with runtime code or a schema library.
• Keep public contracts smaller than private implementation types.
• Let inference handle local details; annotate exported boundaries.
• Use type tests for both expected success and expected failure.
• Keep compiler diagnostics understandable to the consuming team.
• Avoid assertions unless runtime evidence or construction proves them.
• Inspect generated declarations for library-facing APIs.
• Measure checker latency before blaming an advanced construct.
• Separate domain types from wire-format DTOs.
• Review optionality, mutability, and nullability deliberately.
• Revisit the decision periodically: share stable commands and events; keep UI view models local.

Performance

Type annotations normally have no direct runtime cost because they are removed from emitted JavaScript. Performance work must separate editor/type-checking cost, compilation cost, bundle output, and actual JavaScript execution.

• API Contracts and Shared Types normally changes checker work, not JavaScript execution speed.
• Deep composition can increase editor and CI type-checking time; measure with compiler diagnostics before simplifying.
• Runtime performance depends on emitted algorithms, allocations, I/O, and validation—not on erased annotations.
• Type-driven refactoring may enable better code, but benchmark the emitted application rather than claiming a type-level speedup.

Security

Static types improve reviewability and make invalid internal states harder to express, but they are not a security boundary. Attackers interact with the emitted JavaScript and network interfaces, not your type declarations.

• Parse untrusted input as unknown and validate structure, ranges, formats, and size at runtime.
• Keep authentication and authorization checks in executable code.
• Do not let an assertion convert attacker-controlled data into a trusted domain value.
• Avoid exposing sensitive fields merely because a projected type hides them; the runtime object may still contain them.
• Use API Contracts and Shared Types to improve reviewability, while treating validation and policy enforcement as separate controls.

Real-World Architecture

Place API Contracts and Shared Types in the narrowest stable layer that owns its invariant. Transport adapters validate data and map DTOs; application services coordinate use cases; domain modules expose purposeful contracts; infrastructure implements those contracts.

Interview Questions & Answers

Practical Exercise

Problem: Publish three shared types and write a compatibility rule for adding a field.

Difficulty: Senior

Requirements

• Compile under strict mode.
• Keep untrusted input as unknown until validated.
• Avoid any except as a documented last resort.
• Show one accepted and one rejected type scenario.

Expected behavior: A small TechLearningPro module that uses API Contracts and Shared Types to protect web, mobile, and jobs agreeing on enrollment commands and documents the runtime boundary.

Hints

• Start from published .d.ts, schema versions, and additive change policy.
• Watch for a kitchen-sink types package that every team imports for everything.
• Inspect emitted JavaScript if runtime behavior is in doubt.

The complete solution is intentionally withheld. First model the contract, compile under strict mode, and explain every assertion or escape hatch during review.

Key Takeaways

• API Contracts and Shared Types models web, mobile, and jobs agreeing on enrollment commands through published .d.ts, schema versions, and additive change policy.
• Types are erased; they do not validate runtime data.
• Unknown external values require runtime validation.
• The main hazard is a kitchen-sink types package that every team imports for everything.
• The key trade-off is share stable commands and events; keep UI view models local.
• Strict mode and negative type tests make the contract more reliable.
• Small public surfaces improve diagnostics and maintainability.
• Type sophistication is valuable only when it preserves a real invariant.
• Security controls and performance claims require runtime evidence.
• Compose the next lesson instead of reteaching this contract from scratch.

Summary

API Contracts and Shared Types gives TechLearningPro a precise way to model web, mobile, and jobs agreeing on enrollment commands through published .d.ts, schema versions, and additive change policy. Used with strict checking, boundary validation, and deliberate ownership, it improves change safety without pretending that erased types enforce runtime policy.

Next Lesson Preview

Next, study Clean Architecture and DDD. The next lesson extends this foundation with another production modeling technique.