Engineering11 Server APIs Reference

Complete reference for all 47 Foundation Node.js/TypeScript server APIs.

Overview

This directory contains comprehensive documentation for all APIs that power the Foundation’s microservices. Each API provides specialized functionality for building cloud-native applications on Google Cloud Platform and Control Plane.

Complete API Index

All APIs are fully documented with detailed “What It Does”, “Key Capabilities”, “Heavy-Lifting Features”, and “What Customers Don’t Have to Build” sections.

Core Infrastructure (14 APIs)

1. Admin - Firebase Admin SDK wrapper with multi-project support
2. Datastores - Multi-database ORM (Firestore, SQL, BigQuery, Redis, Algolia, Typesense)
3. Storage - Multi-cloud storage abstraction (GCP/AWS S3)
4. Logging - Structured logging with error tracking and distributed tracing
5. Secrets - Secure credential management with GCP Secret Manager and KMS
6. Security - JWT management and threat intelligence (IPQS)
7. Tasks - Asynchronous task queue management with Google Cloud Tasks
8. PubSub - Google Cloud Pub/Sub wrapper with retries and archiving
9. Redis - Redis connection factory with GCP project namespacing
10. GCP - Google Cloud Platform utilities and integrations
11. Validation - Schema-based validation with custom decorators
12. Configuration - Decorator-driven config from environment variables
13. Error - Standardized error handling with E11Error
14. DI - Dependency injection container with type safety

REST & Communication (11 APIs)

15. REST - Enterprise NestJS framework with authentication and authorization
16. REST Client - HTTP client with auth, retry, and SSE support
17. REST Algolia - CQRS commands for Algolia search
18. REST Datastores - NestJS SQL connection management
19. REST GCP - NestJS GCP Project ID injection
20. Microservices Client - Type-safe microservice communication
21. Microservices Controller - CRUD controller factory
22. PubSub Service - Decorator-driven Pub/Sub handlers
23. Events - Event base classes for event-driven architecture
24. CQRS - Enhanced NestJS CQRS with event sagas
25. Cloud Functions - Builder pattern for Firebase Functions

AI & Advanced Services (2 APIs)

26. AI - OpenAI/LangChain with structured outputs and observability
27. Browser Client - Headless browser for PDF generation

Cloud Platform Services (6 APIs)

28. Cloud Messaging - Firebase Cloud Messaging for push notifications
29. Cloud Run Jobs - Execute background jobs on Cloud Run
30. Control Plane - URL construction for Control Plane infrastructure
31. Scheduler - Google Cloud Scheduler for cron jobs
32. Dynamic Link - Firebase Dynamic Links for deep linking
33. CDN - CDN cache purging (Cloudflare)

Data Processing & Utilities (8 APIs)

34. ETL - Extract-Transform-Load framework
35. Migration - Database migration framework
36. Organization - Multi-platform resource discovery
37. Node Stream - Stream utilities (size limits, buffering, merging)
38. i18n - Translation templates and localization
39. Crypto - Bcrypt hashing and secret generation
40. Models - Property decorators for model introspection
41. Types - NestJS DTOs for common backend types

Integration & External Services (4 APIs)

42. Stripe - Stripe payment processing wrapper
43. Stripe REST - NestJS Stripe module with DI
44. Video - Multi-platform video hosting (Mux/Cloudflare Stream)
45. Microservice Configuration - Centralized config management

Multi-Tenant & Testing (2 APIs)

46. Tenant Bootstrap - Multi-tenant initialization and configuration
47. SFTP Testing - Mock SFTP/FTP for testing

API Categories

By Primary Function

Authentication & Security (5 APIs)

• Admin, Security, Secrets, Validation, REST (auth features)

Data Persistence (4 APIs)

• Datastores, Storage, Redis, REST Datastores

Communication & Messaging (8 APIs)

• REST, PubSub, Tasks, Events, REST Client, Microservices Client/Controller, Cloud Messaging

Observability & Monitoring (2 APIs)

• Logging, AI (Langfuse integration)

Cloud Platform Integration (7 APIs)

• GCP, Cloud Functions, Cloud Run Jobs, Scheduler, Control Plane, REST GCP, Dynamic Link

Data Processing (5 APIs)

• ETL, Migration, Organization, Node Stream, CQRS

External Services (4 APIs)

• Stripe, Stripe REST, Video, CDN, Browser Client

Utilities & Frameworks (12 APIs)

• Error, Types, Models, Crypto, i18n, Configuration, DI, Validation, REST Algolia, PubSub Service, Microservice Configuration, Tenant Bootstrap, SFTP Testing

Common Patterns

Type Safety

All APIs provide full TypeScript support with generic types throughout.

Error Standardization

APIs use @engineering11/error-server-api for consistent error handling.

Caching Strategies

Many APIs implement intelligent caching:

• Secrets (process.env caching)
• Microservice Configuration (TTL caching)
• Tasks (Cloud Function URI caching)

Builder Patterns

Fluent APIs for complex construction:

• TaskBuilder, ErrorBuilder, MetricBuilder, PathBuilder, CloudFunctionGenerator

Dependency Injection

NestJS-compatible modules with .forRoot() pattern.

Multi-Provider Support

Strategy pattern for cloud provider flexibility:

• Storage (GCP/AWS), Datastores (Firestore/SQL), Video (Mux/Cloudflare)

Installation

Each API can be installed independently:

yarn add @engineering11/<api-name>

Examples:

yarn add @engineering11/admin-server-api
yarn add @engineering11/ai
yarn add @engineering11/datastores
yarn add @engineering11/rest

Documentation Structure

Each API documentation includes:

1. What It Does - Clear purpose and problem statement
2. Key Capabilities - Table of major features
3. How It Fits Together - Architecture diagram (where applicable)
4. Heavy-Lifting Features or streamlined features
5. Configuration - Environment variables and setup
6. Exports - Available imports
7. Common Use Cases - Real-world scenarios
8. What Customers Don’t Have to Build - Avoided complexity

Quick Reference by Use Case

Building REST APIs: REST, REST Client, Validation, Error, Security, Logging

Event-Driven Systems: Events, PubSub, Tasks, CQRS, Cloud Functions

Data Storage: Datastores, Storage, Redis, Migration

Multi-Tenant SaaS: Tenant Bootstrap, Microservice Configuration, Admin

Payment Processing: Stripe, Stripe REST

AI Integration: AI (OpenAI/LangChain)

Authentication: Admin, Security, Secrets

Testing: SFTP Testing, Models (decorators)

Cloud Infrastructure: GCP, Cloud Run Jobs, Scheduler, Control Plane

Media Processing: Video, CDN, Browser Client (PDF)

Support

• Repository: https://github.com/engineering11/sdks-nodejs 
• Issues: Report issues in the GitHub repository
• License: UNLICENSED - Engineering11 LLC proprietary software

Version Information

All APIs follow semantic versioning. Check individual package.json files for current versions.