Skill UI

This module provides core abstractions (BuildParam and BuildParams) for managing build-time configuration parameters within web APIs. Developers use these types to ensure type-safe access and definition of configuration settings, promoting cleaner and more reliable API development.

This catalog provides a comprehensive reference for the core API abstractions within the Webiny framework. It includes utilities for advanced AI interaction, state management (Key-Value Store), domain event publishing, data compression, and complex WebSocket handling. Developers can use these ready-to-use, structured components to build scalable, maintainable, and enterprise-grade applications.

A comprehensive catalog of API abstractions designed for building headless Content Management Systems (CMS). It provides core functionality for content entries, models, and groups, encompassing event handlers, use cases, and advanced integrations with search engines like OpenSearch and GraphQL.

This guide details how to programmatically define, configure, and extend Headless CMS content models using the ModelFactory pattern. It covers defining various field types (text, richText, asset, ref, object, etc.), applying advanced validation rules, setting up layouts, and managing API access control. It is essential for developers building custom content structures in a robust, code-driven manner.

This guide details how to implement a highly customized CMS field type within the Webiny framework. It covers extending DataFieldBuilder, defining complex validation logic, creating a FieldType.Factory, and proper registration using Dependency Injection (DI). Furthermore, it demonstrates module augmentation for enhancing TypeScript autocomplete in the fields registry, ensuring a complete, robust development workflow and exposing a fluent builder API.

This catalog provides core abstractions for implementing event-driven architectures (EDA). It includes `DomainEvent`, the base class for all business domain events, and `EventPublisher`, the mechanism used to publish these events to registered handlers. Use these components to effectively decouple services and build robust, reactive systems.

This catalog provides comprehensive abstractions and use cases for robust file and asset management. It covers the entire file lifecycle, including asset delivery, single and batch file creation, file deletion, and event handlers (e.g., post-creation, post-deletion hooks). Developers can use these components to build reliable, structured file management systems.

This module provides essential GraphQL response abstractions and helper types. It includes standardized structures for handling various API outcomes, such as general success responses, list data, common errors, and specific security statuses (e.g., Not Found, Not Authorized). Using these abstractions ensures that API interactions are robust, predictable, and adhere to consistent patterns.

Provides two distinct abstractions for key-value data storage: a global store for application-wide data access, and a tenant-scoped store for multi-tenant isolation. This module is fundamental for managing various types of non-relational configuration and data in a structured manner.

This module provides core abstractions for managing and retrieving language data using defined use case patterns. It includes specific use cases to fetch a single language entry by its unique code, and another to list all available language entries. Developers must import the required use case and read the source files to ensure they use the exact interface and types.

This API provides a standardized, structured logging abstraction layer for modern application development. It supports multiple log levels (e.g., info, warn, error) and ensures logs are captured in a consistent, machine-readable format. It is essential for building robust applications that require detailed monitoring, debugging, and scalable operational insights.

This module provides a comprehensive set of 10 key abstractions for interacting with OpenSearch. It includes structured components for client initialization, field definition, index management, and advanced query building operators. It serves as a foundational API layer, ensuring developers can integrate with OpenSearch in a standardized and reliable manner.