Skill UI

Comprehensive guide for designing robust backend APIs within the Webiny framework. It details best practices for structuring features, distinguishing between Services (multi-method, singleton) and UseCases (single-method orchestrators, transient), managing dependencies via the DI container, and implementing advanced patterns like ServiceProviders for asynchronous bootstrapping. Essential for all backend API development.

This catalog provides critical abstractions for managing build-time configuration parameters within the Webiny API context. It offers `BuildParam` for accessing single configuration values and `BuildParams` for handling multiple parameters, ensuring that all API interactions utilize a structured, type-safe approach for development.

This catalog provides a comprehensive set of foundational abstractions for building robust, scalable applications. It includes standardized interfaces for interacting with AI models, managing key-value data stores, publishing domain events, structured logging, and handling build parameters. Developers can rely on these abstractions to ensure modularity and consistency across different service layers.

A comprehensive collection of core abstractions, event handlers, and use cases for building applications with a Headless Content Management System (CMS). It provides types for content entries, models, and groups, along with specific integrations for advanced search features like OpenSearch.

This guide details how to programmatically define and manage Headless CMS content models using the ModelFactory pattern. Developers learn to declare fields (including complex types like richText, file, object), set validators (required, unique, regex), configure field layouts, and manage API naming conventions entirely through code. It is essential for extending and customizing CMS core functionality.

This guide details how to implement custom Content Management System (CMS) field types within a framework. It covers extending the core DataFieldBuilder, composing complex validator interfaces, creating a dedicated FieldTypeFactory, and ensuring proper registration via Dependency Injection (DI) and module augmentation for full TypeScript autocomplete support. Essential for adding fields with specialized validation or storage formats.

This module provides core abstractions for implementing event-driven architecture within APIs. It includes `DomainEvent`, the fundamental base class for all domain events, and `EventPublisher`, which facilitates the structured publishing of these events to registered handlers. It is crucial for building highly decoupled, scalable, and maintainable backend services.

A comprehensive API catalog providing robust abstractions for managing files. It includes core repositories and use cases for CRUD operations (Create, Read, Update, Delete), along with detailed event handlers (before/after hooks) to manage the entire file lifecycle. Essential for building scalable and maintainable backend systems that handle file storage and business logic.

A collection of core helper classes and abstractions designed for building robust and type-safe GraphQL APIs. These utilities standardize common response patterns (e.g., success, list, error, not found, unauthorized) and provide tools to define custom GraphQL schemas. Utilizing these abstractions ensures consistency, improves developer experience, and simplifies comprehensive error management across your backend services.

This API provides key-value store abstractions, enabling developers to manage persistent or temporary data within their web services. It offers two distinct scopes: a global (non-tenant-scoped) store and a tenant-scoped store. This is essential for applications requiring structured data management, such as application settings, caching mechanisms, or session data, while maintaining clear data isolation.

This module provides core use case abstractions for interacting with a standardized language catalog. It offers two key functionalities: retrieving a specific language entry using its unique code (GetLanguageByCodeUseCase), and listing all available language entries (ListLanguagesUseCase). These abstractions ensure consistent and structured data access across the application.

This module provides the core `Logger` abstraction for structured logging within the Webiny API context. It supports multiple logging levels (e.g., debug, info, warn, error), ensuring that developers can record application events and operational data systematically. Using this abstraction helps in centralized logging, which is crucial for debugging, monitoring, and maintaining system health.