Skill UI

This skill guides developers on creating and managing Headless CMS content models programmatically using the ModelFactory pattern. It covers defining complex data structures, including various field types (text, richText, file, ref), implementing validators (required, unique), configuring layouts, and establishing relationships between models. It is essential for advanced, code-driven CMS customization and API integration.

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.

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

This module provides core abstractions for handling long-running, asynchronous background tasks within an API context. It introduces `TaskDefinition` to define the complete lifecycle and hooks for a background task, and `TaskService` to programmatically trigger and manage these operations. It is essential for backend development requiring robust, non-instantaneous processing.

This API provides essential abstractions and handlers for robust tenant management within web services. It covers both event handling patterns and use case patterns, allowing developers to easily extend the core tenant content model and manage the entire tenant lifecycle, ensuring scalable and structured multi-tenancy solutions.

This skill provides a detailed guide on extending the Webiny Command Line Interface (CLI) by implementing custom commands. It utilizes the `CliCommandFactory` pattern to define structured commands, manage typed parameters, and execute complex logic. Use cases include automating data migrations, generating boilerplate code, executing custom deployment workflows, and performing CMS content exports.

This guide details how to integrate Auth0 as an external Identity Provider (IDP) for Webiny, replacing the default Cognito authentication. It involves creating an API config class to map Auth0's JWT claims to Webiny identities and implementing a React extension component. Users must set environment variables (AUTH0_ISSUER, AUTH0_CLIENT_ID) and register the necessary extensions for successful OIDC authentication flow.