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 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 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 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.

This module provides essential API abstractions for managing core system functionality and lifecycles. It includes the `InstallSystemUseCase` for executing system-wide installation routines and the `SystemInstalledEventHandler` for hooking into the system lifecycle immediately after successful installation. It is crucial for developers building robust, modular systems that require proper setup and event-driven logic.

This module provides essential abstractions for managing long-running background tasks within an API context. It includes `TaskDefinition` for defining the complete lifecycle and logic of a background job, and `TaskService` for triggering, initiating, and managing these tasks programmatically. It is crucial for implementing reliable, asynchronous workflows in web applications.

This catalog serves as a central reference for essential service abstractions, including LoggerService and UiService, within the webiny CLI ecosystem. It guides developers on the correct import paths and source locations for utilizing core services. Developers must import these services using standard module imports and are advised to read the source code for precise interfaces and types.

This module provides the `CliCommandFactory` abstraction, enabling developers to easily implement custom and structured commands for the Webiny Command Line Interface (CLI). It serves as the core mechanism for extending and managing all CLI functionalities within the application.

This library provides comprehensive infrastructure abstractions for web applications. It offers standardized hooks and services allowing developers to inject custom logic during critical stages of the application lifecycle, including before, after, and during build, deployment, and watching. These abstractions cover core, admin, and API modules, ensuring modular, reliable, and scalable infrastructure extension.

This skill provides a comprehensive, structured process for creating and documenting new AI agent skills. It guides the user through gathering requirements, drafting structured files (like SKILL.md, REFERENCE.md), and optimizing descriptions to ensure the agent can correctly identify and utilize the new capability. Use when you need to build, write, or refine a complex, functional skill module for an AI agent.