webiny-api-system-catalog

Catalogs Webiny system installation use cases and event handler abstractions.

8.0k|673|Updated Jan 9, 2018

Search Tags:#api #use case #typeScript #event handler #webiny #system installation #abstraction catalog

One-click install

npx skills add https://github.com/webiny/webiny-js --skill webiny-api-system-catalog

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: webiny-api-system-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/system
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-system-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers extending the Webiny API often struggle to locate the correct system-level abstractions for installation workflows. This Skill provides a curated catalog of the System feature's abstractions so you can quickly find the right interface, its import path, and its source file.

Core Features & Use Cases

Abstraction Catalog: Lists the InstallSystemUseCase and SystemInstalledEventHandler abstractions with exact import paths and source file locations.
Implementation Guidance: Points to related pattern skills (webiny-use-case-pattern, webiny-event-handler-pattern) for correct implementation.
Use Case: When building a Webiny extension that must run logic after the system is installed, look up SystemInstalledEventHandler, read its source at @webiny/api-core/features/system/InstallSystem/index.ts, and implement the handler using the documented pattern.

Quick Start

Ask the AI to show you the Webiny system installation abstractions and how to implement a handler that runs after the system is installed.

Frequently Asked Questions about webiny-api-system-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I run logic after Webiny system installation?▼

Implement the SystemInstalledEventHandler abstraction, which hooks into the system lifecycle after installation completes. Import it from "webiny/api/system" and follow the webiny-event-handler-pattern skill for the implementation structure.

What is the InstallSystemUseCase in Webiny?▼

InstallSystemUseCase is the abstraction for running system-wide installation in Webiny. It is imported from "webiny/api/system" and its source is located at @webiny/api-core/features/system/InstallSystem/index.ts.

Where do I find the source code for Webiny system abstractions?▼

Both system abstractions live in @webiny/api-core/features/system/InstallSystem/index.ts. You must read the source file to get the exact interface and types before implementing.

Does this catalog include implementation patterns for Webiny abstractions?▼

No, it only lists abstractions with imports and source locations. For implementation patterns, refer to the companion webiny-use-case-pattern and webiny-event-handler-pattern skills.