webiny-api-file-manager-catalog

Catalogs 48 Webiny File Manager API abstractions including use cases, repositories, and event handlers.

8.0k|673|Updated Jan 9, 2018
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-file-manager-catalog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: webiny-api-file-manager-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/file-manager
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-file-manager-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers extending Webiny's File Manager on AWS need to locate the correct abstraction (use case, repository, or event handler) and its exact import path without digging through the monorepo source tree.

Core Features & Use Cases

  • Abstraction Catalog: Lists 48 abstractions from @webiny/api-file-manager covering file CRUD, batch creation, tags, settings, and asset delivery.
  • Import Paths and Sources: Each entry provides the exact import statement and source file location so you can read the real interface before coding.
  • Lifecycle Event Handlers: Documents before/after hooks for file create, update, delete, batch create, and settings update operations.
  • Use Case: When you need to hook into file lifecycle events, look up FileAfterCreateEventHandler, read its source file, and implement the handler following the referenced event-handler pattern skill.

Quick Start

Ask the AI to find the File Manager abstraction for listing files with filtering and show its import path and source file.

Frequently Asked Questions about webiny-api-file-manager-catalog

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

FAQPage Schema
How do I hook into file lifecycle events in Webiny?

Use the file lifecycle event handler abstractions such as FileBeforeCreateEventHandler or FileAfterDeleteEventHandler from webiny/api/file-manager/file. Read the referenced source file for the exact interface, then implement it following the event handler pattern skill.

How to list files with filtering in Webiny File Manager API?

Use the ListFilesUseCase abstraction imported from webiny/api/file-manager/file, which lists files with filtering and pagination. Its source is at @webiny/api-file-manager/features/file/ListFiles/abstractions.ts.

What abstractions exist for batch file uploads in Webiny?

Webiny provides CreateFilesInBatchUseCase to upload and create multiple files, CreateFilesInBatchRepository to persist them, and FileBeforeBatchCreateEventHandler plus FileAfterBatchCreateEventHandler for lifecycle hooks.

Does Webiny File Manager support custom asset delivery logic?

Yes, the assetDelivery module exposes abstractions like AssetProcessor, AssetOutputStrategy, AssetResolver, and StreamAssetReply for customizing how assets are resolved, processed, and streamed to clients.

Where are Webiny File Manager settings managed in the API?

Settings are managed through GetSettingsUseCase and UpdateSettingsUseCase from webiny/api/file-manager/settings, with SettingsBeforeUpdateEventHandler and SettingsAfterUpdateEventHandler available for update lifecycle hooks.