Skill UI

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.

This module provides multiple standardized abstractions for interacting with the OpenSearch API. It includes dedicated abstractions for clients, factories, and operational contexts, allowing developers to implement robust, scalable, and type-safe interactions with OpenSearch within the webiny ecosystem. Use these patterns to ensure consistent data access regardless of the specific usage pattern.

This skill provides a robust, schema-based system for handling API authorization and access control. It enables developers to define detailed permission schemas (the domain layer) and create injectable, type-safe permissions abstractions (the feature layer). Use this system when implementing complex access control logic, checking granular read/write/delete permissions, or enforcing resource ownership scoping (`own` records) across API use cases.

This API module provides comprehensive tools and abstractions for managing scheduled actions within the webiny ecosystem. It covers the entire lifecycle of asynchronous tasks, including scheduling actions for future execution, retrieving details, listing existing tasks, executing them immediately, and canceling them. Key components include dedicated Use Cases and a core SchedulerService, enabling robust background processing and reliable task management for enterprise applications.

This comprehensive catalog provides essential abstractions for securing web APIs. It covers the entire lifecycle of authentication, including handling roles, users, and teams. Features include robust mechanisms for managing API keys (before/after events) and dedicated use cases for user and role creation/deletion, ensuring highly scalable and secure backend development.

This API provides core abstractions for managing system initialization and lifecycle events. It includes `InstallSystemUseCase` for running system-wide setup logic, and `SystemInstalledEventHandler` for implementing hooks that execute immediately after the system is successfully installed. It is essential for developing robust, modular, and reliable large-scale applications requiring structured bootstrapping.