@webiny/mcp 6.0.0 → 6.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/agents/claude.d.ts +2 -2
- package/agents/claude.js.map +1 -1
- package/agents/cline.d.ts +2 -2
- package/agents/cline.js.map +1 -1
- package/agents/copilot.d.ts +2 -2
- package/agents/copilot.js +1 -1
- package/agents/copilot.js.map +1 -1
- package/agents/cursor.d.ts +2 -2
- package/agents/cursor.js.map +1 -1
- package/agents/instructions.js +1 -1
- package/agents/instructions.js.map +1 -1
- package/agents/kiro.d.ts +15 -0
- package/agents/kiro.js +33 -0
- package/agents/kiro.js.map +1 -0
- package/agents/opencode.d.ts +22 -0
- package/agents/opencode.js +76 -0
- package/agents/opencode.js.map +1 -0
- package/agents/shared.d.ts +5 -5
- package/agents/shared.js +3 -3
- package/agents/shared.js.map +1 -1
- package/agents/windsurf.d.ts +2 -2
- package/agents/windsurf.js.map +1 -1
- package/bin.d.ts +2 -0
- package/bin.js +4 -0
- package/bin.js.map +1 -0
- package/cli/ConfigureMcp.d.ts +7 -14
- package/cli/ConfigureMcp.js +24 -52
- package/cli/ConfigureMcp.js.map +1 -1
- package/cli/McpServer.d.ts +3 -10
- package/cli/McpServer.js +83 -109
- package/cli/McpServer.js.map +1 -1
- package/cli.d.ts +1 -0
- package/cli.js +60 -0
- package/cli.js.map +1 -0
- package/index.d.ts +6 -1
- package/index.js +7 -1
- package/index.js.map +1 -1
- package/package.json +11 -23
- package/skills/admin/admin-architect/SKILL.md +389 -0
- package/skills/admin/ui-extensions/SKILL.md +268 -0
- package/skills/api/api-architect/SKILL.md +189 -0
- package/skills/api/custom-field-type/SKILL.md +263 -0
- package/skills/api/event-handler-pattern/SKILL.md +131 -0
- package/skills/{custom-graphql-api → api/graphql-api}/SKILL.md +3 -3
- package/skills/api/use-case-pattern/SKILL.md +102 -0
- package/skills/cli-extensions/SKILL.md +45 -47
- package/skills/configure-auth0/SKILL.md +4 -4
- package/skills/configure-okta/SKILL.md +3 -3
- package/skills/content-models/SKILL.md +197 -196
- package/skills/dependency-injection/SKILL.md +9 -219
- package/skills/full-stack-architect/SKILL.md +195 -0
- package/skills/generated/admin/SKILL.md +119 -0
- package/skills/generated/admin/aco/SKILL.md +28 -0
- package/skills/generated/admin/build-params/SKILL.md +33 -0
- package/skills/generated/admin/cms/SKILL.md +342 -0
- package/skills/generated/admin/configs/SKILL.md +23 -0
- package/skills/generated/admin/env-config/SKILL.md +30 -0
- package/skills/generated/admin/form/SKILL.md +88 -0
- package/skills/generated/admin/graphql-client/SKILL.md +23 -0
- package/skills/generated/admin/lexical/SKILL.md +105 -0
- package/skills/generated/admin/local-storage/SKILL.md +42 -0
- package/skills/generated/admin/router/SKILL.md +48 -0
- package/skills/generated/admin/security/SKILL.md +63 -0
- package/skills/generated/admin/tenancy/SKILL.md +64 -0
- package/skills/generated/admin/ui/SKILL.md +468 -0
- package/skills/generated/admin/website-builder/SKILL.md +318 -0
- package/skills/generated/api/SKILL.md +40 -0
- package/skills/generated/api/aco/SKILL.md +202 -0
- package/skills/generated/api/build-params/SKILL.md +31 -0
- package/skills/generated/api/cms/SKILL.md +646 -0
- package/skills/generated/api/event-publisher/SKILL.md +31 -0
- package/skills/generated/api/file-manager/SKILL.md +189 -0
- package/skills/generated/api/graphql/SKILL.md +61 -0
- package/skills/generated/api/key-value-store/SKILL.md +31 -0
- package/skills/generated/api/logger/SKILL.md +25 -0
- package/skills/generated/api/opensearch/SKILL.md +39 -0
- package/skills/generated/api/scheduler/SKILL.md +112 -0
- package/skills/generated/api/security/SKILL.md +317 -0
- package/skills/generated/api/system/SKILL.md +34 -0
- package/skills/generated/api/tasks/SKILL.md +31 -0
- package/skills/generated/api/tenancy/SKILL.md +124 -0
- package/skills/generated/api/tenant-manager/SKILL.md +34 -0
- package/skills/generated/api/website-builder/SKILL.md +356 -0
- package/skills/generated/cli/SKILL.md +28 -0
- package/skills/generated/cli/command/SKILL.md +24 -0
- package/skills/generated/extensions/SKILL.md +43 -0
- package/skills/generated/infra/SKILL.md +190 -0
- package/skills/infrastructure-extensions/SKILL.md +3 -2
- package/skills/local-development/SKILL.md +2 -28
- package/skills/project-structure/SKILL.md +78 -56
- package/skills/webiny-sdk/SKILL.md +77 -76
- package/skills/website-builder/SKILL.md +143 -149
- package/ui.d.ts +24 -0
- package/ui.js +31 -0
- package/ui.js.map +1 -0
- package/Extension.d.ts +0 -2
- package/Extension.js +0 -11
- package/Extension.js.map +0 -1
- package/skills/admin-ui-extensions/SKILL.md +0 -267
- package/skills/api-custom-feature/SKILL.md +0 -195
- package/skills/lifecycle-events/SKILL.md +0 -348
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-file-manager-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
API — File Manager — 28 abstractions.
|
|
6
|
+
File event handlers and use cases.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# API — File Manager
|
|
10
|
+
|
|
11
|
+
File event handlers and use cases.
|
|
12
|
+
|
|
13
|
+
## How to Use
|
|
14
|
+
|
|
15
|
+
1. Find the abstraction you need below
|
|
16
|
+
2. Read the source file to get the exact interface and types
|
|
17
|
+
3. Import: `import { Name } from "<importPath>";`
|
|
18
|
+
4. See `webiny-use-case-pattern` or `webiny-event-handler-pattern` skills for implementation patterns
|
|
19
|
+
|
|
20
|
+
## Abstractions
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
**Name:** `CreateFileRepository`
|
|
24
|
+
**Import:** `import { CreateFileRepository } from "webiny/api/file-manager/file"`
|
|
25
|
+
**Source:** `@webiny/api-file-manager/features/file/CreateFile/abstractions.ts`
|
|
26
|
+
**Description:** Persist a newly created file.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
**Name:** `CreateFilesInBatchRepository`
|
|
30
|
+
**Import:** `import { CreateFilesInBatchRepository } from "webiny/api/file-manager/file"`
|
|
31
|
+
**Source:** `@webiny/api-file-manager/features/file/CreateFilesInBatch/abstractions.ts`
|
|
32
|
+
**Description:** Persist multiple files created in batch.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
**Name:** `CreateFilesInBatchUseCase`
|
|
36
|
+
**Import:** `import { CreateFilesInBatchUseCase } from "webiny/api/file-manager/file"`
|
|
37
|
+
**Source:** `@webiny/api-file-manager/features/file/CreateFilesInBatch/abstractions.ts`
|
|
38
|
+
**Description:** Upload and create multiple files in batch.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
**Name:** `CreateFileUseCase`
|
|
42
|
+
**Import:** `import { CreateFileUseCase } from "webiny/api/file-manager/file"`
|
|
43
|
+
**Source:** `@webiny/api-file-manager/features/file/CreateFile/abstractions.ts`
|
|
44
|
+
**Description:** Upload and create a new file.
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
**Name:** `DeleteFileRepository`
|
|
48
|
+
**Import:** `import { DeleteFileRepository } from "webiny/api/file-manager/file"`
|
|
49
|
+
**Source:** `@webiny/api-file-manager/features/file/DeleteFile/abstractions.ts`
|
|
50
|
+
**Description:** Persist file deletion.
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
**Name:** `DeleteFileUseCase`
|
|
54
|
+
**Import:** `import { DeleteFileUseCase } from "webiny/api/file-manager/file"`
|
|
55
|
+
**Source:** `@webiny/api-file-manager/features/file/DeleteFile/abstractions.ts`
|
|
56
|
+
**Description:** Delete a file.
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
**Name:** `FileAfterBatchCreateEventHandler`
|
|
60
|
+
**Import:** `import { FileAfterBatchCreateEventHandler } from "webiny/api/file-manager/file"`
|
|
61
|
+
**Source:** `@webiny/api-file-manager/features/file/CreateFilesInBatch/events.ts`
|
|
62
|
+
**Description:** Hook into file lifecycle after files are created in batch.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
**Name:** `FileAfterCreateEventHandler`
|
|
66
|
+
**Import:** `import { FileAfterCreateEventHandler } from "webiny/api/file-manager/file"`
|
|
67
|
+
**Source:** `@webiny/api-file-manager/features/file/CreateFile/events.ts`
|
|
68
|
+
**Description:** Hook into file lifecycle after a file is created.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
**Name:** `FileAfterDeleteEventHandler`
|
|
72
|
+
**Import:** `import { FileAfterDeleteEventHandler } from "webiny/api/file-manager/file"`
|
|
73
|
+
**Source:** `@webiny/api-file-manager/features/file/DeleteFile/events.ts`
|
|
74
|
+
**Description:** Hook into file lifecycle after a file is deleted.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
**Name:** `FileAfterUpdateEventHandler`
|
|
78
|
+
**Import:** `import { FileAfterUpdateEventHandler } from "webiny/api/file-manager/file"`
|
|
79
|
+
**Source:** `@webiny/api-file-manager/features/file/UpdateFile/events.ts`
|
|
80
|
+
**Description:** Hook into file lifecycle after a file is updated.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
**Name:** `FileBeforeBatchCreateEventHandler`
|
|
84
|
+
**Import:** `import { FileBeforeBatchCreateEventHandler } from "webiny/api/file-manager/file"`
|
|
85
|
+
**Source:** `@webiny/api-file-manager/features/file/CreateFilesInBatch/events.ts`
|
|
86
|
+
**Description:** Hook into file lifecycle before files are created in batch.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
**Name:** `FileBeforeCreateEventHandler`
|
|
90
|
+
**Import:** `import { FileBeforeCreateEventHandler } from "webiny/api/file-manager/file"`
|
|
91
|
+
**Source:** `@webiny/api-file-manager/features/file/CreateFile/events.ts`
|
|
92
|
+
**Description:** Hook into file lifecycle before a file is created.
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
**Name:** `FileBeforeDeleteEventHandler`
|
|
96
|
+
**Import:** `import { FileBeforeDeleteEventHandler } from "webiny/api/file-manager/file"`
|
|
97
|
+
**Source:** `@webiny/api-file-manager/features/file/DeleteFile/events.ts`
|
|
98
|
+
**Description:** Hook into file lifecycle before a file is deleted.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
**Name:** `FileBeforeUpdateEventHandler`
|
|
102
|
+
**Import:** `import { FileBeforeUpdateEventHandler } from "webiny/api/file-manager/file"`
|
|
103
|
+
**Source:** `@webiny/api-file-manager/features/file/UpdateFile/events.ts`
|
|
104
|
+
**Description:** Hook into file lifecycle before a file is updated.
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
**Name:** `FileUrlGenerator`
|
|
108
|
+
**Import:** `import { FileUrlGenerator } from "webiny/api/file-manager/file"`
|
|
109
|
+
**Source:** `@webiny/api-file-manager/features/file/FileUrlGenerator/abstractions.ts`
|
|
110
|
+
**Description:** Generate URLs for uploaded files.
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
**Name:** `FmPermissions`
|
|
114
|
+
**Import:** `import { FmPermissions } from "webiny/api/file-manager/permissions"`
|
|
115
|
+
**Source:** `@webiny/api-file-manager/features/shared/abstractions.ts`
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
**Name:** `GetFileRepository`
|
|
119
|
+
**Import:** `import { GetFileRepository } from "webiny/api/file-manager/file"`
|
|
120
|
+
**Source:** `@webiny/api-file-manager/features/file/GetFile/abstractions.ts`
|
|
121
|
+
**Description:** Fetch a file from storage.
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
**Name:** `GetFileUseCase`
|
|
125
|
+
**Import:** `import { GetFileUseCase } from "webiny/api/file-manager/file"`
|
|
126
|
+
**Source:** `@webiny/api-file-manager/features/file/GetFile/abstractions.ts`
|
|
127
|
+
**Description:** Retrieve a file by ID.
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
**Name:** `GetSettingsUseCase`
|
|
131
|
+
**Import:** `import { GetSettingsUseCase } from "webiny/api/file-manager/settings"`
|
|
132
|
+
**Source:** `@webiny/api-file-manager/features/settings/GetSettings/abstractions.ts`
|
|
133
|
+
**Description:** Retrieve file manager settings.
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
**Name:** `ListFilesRepository`
|
|
137
|
+
**Import:** `import { ListFilesRepository } from "webiny/api/file-manager/file"`
|
|
138
|
+
**Source:** `@webiny/api-file-manager/features/file/ListFiles/abstractions.ts`
|
|
139
|
+
**Description:** Fetch files from storage with filtering.
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
**Name:** `ListFilesUseCase`
|
|
143
|
+
**Import:** `import { ListFilesUseCase } from "webiny/api/file-manager/file"`
|
|
144
|
+
**Source:** `@webiny/api-file-manager/features/file/ListFiles/abstractions.ts`
|
|
145
|
+
**Description:** List files with filtering and pagination.
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
**Name:** `ListTagsRepository`
|
|
149
|
+
**Import:** `import { ListTagsRepository } from "webiny/api/file-manager/file"`
|
|
150
|
+
**Source:** `@webiny/api-file-manager/features/file/ListTags/abstractions.ts`
|
|
151
|
+
**Description:** Fetch file tags from storage.
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
**Name:** `ListTagsUseCase`
|
|
155
|
+
**Import:** `import { ListTagsUseCase } from "webiny/api/file-manager/file"`
|
|
156
|
+
**Source:** `@webiny/api-file-manager/features/file/ListTags/abstractions.ts`
|
|
157
|
+
**Description:** List all file tags.
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
**Name:** `SettingsAfterUpdateEventHandler`
|
|
161
|
+
**Import:** `import { SettingsAfterUpdateEventHandler } from "webiny/api/file-manager/settings"`
|
|
162
|
+
**Source:** `@webiny/api-file-manager/features/settings/UpdateSettings/events.ts`
|
|
163
|
+
**Description:** Hook into settings lifecycle after settings are updated.
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
**Name:** `SettingsBeforeUpdateEventHandler`
|
|
167
|
+
**Import:** `import { SettingsBeforeUpdateEventHandler } from "webiny/api/file-manager/settings"`
|
|
168
|
+
**Source:** `@webiny/api-file-manager/features/settings/UpdateSettings/events.ts`
|
|
169
|
+
**Description:** Hook into settings lifecycle before settings are updated.
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
**Name:** `UpdateFileRepository`
|
|
173
|
+
**Import:** `import { UpdateFileRepository } from "webiny/api/file-manager/file"`
|
|
174
|
+
**Source:** `@webiny/api-file-manager/features/file/UpdateFile/abstractions.ts`
|
|
175
|
+
**Description:** Persist file metadata updates.
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
**Name:** `UpdateFileUseCase`
|
|
179
|
+
**Import:** `import { UpdateFileUseCase } from "webiny/api/file-manager/file"`
|
|
180
|
+
**Source:** `@webiny/api-file-manager/features/file/UpdateFile/abstractions.ts`
|
|
181
|
+
**Description:** Update file metadata.
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
**Name:** `UpdateSettingsUseCase`
|
|
185
|
+
**Import:** `import { UpdateSettingsUseCase } from "webiny/api/file-manager/settings"`
|
|
186
|
+
**Source:** `@webiny/api-file-manager/features/settings/UpdateSettings/abstractions.ts`
|
|
187
|
+
**Description:** Update file manager settings.
|
|
188
|
+
|
|
189
|
+
---
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-graphql-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
api/graphql — 7 abstractions.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# api/graphql
|
|
9
|
+
|
|
10
|
+
## How to Use
|
|
11
|
+
|
|
12
|
+
1. Find the abstraction you need below
|
|
13
|
+
2. Read the source file to get the exact interface and types
|
|
14
|
+
3. Import: `import { Name } from "<importPath>";`
|
|
15
|
+
4. See `webiny-use-case-pattern` or `webiny-event-handler-pattern` skills for implementation patterns
|
|
16
|
+
|
|
17
|
+
## Abstractions
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
**Name:** `ErrorResponse`
|
|
21
|
+
**Import:** `import { ErrorResponse } from "webiny/api/graphql"`
|
|
22
|
+
**Source:** `@webiny/handler-graphql/responses.ts`
|
|
23
|
+
**Description:** GraphQL error response helper.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
**Name:** `GraphQLSchemaFactory`
|
|
27
|
+
**Import:** `import { GraphQLSchemaFactory } from "webiny/api/graphql"`
|
|
28
|
+
**Source:** `@webiny/handler-graphql/graphql/abstractions.ts`
|
|
29
|
+
**Description:** Define custom GraphQL schema extensions.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
**Name:** `ListErrorResponse`
|
|
33
|
+
**Import:** `import { ListErrorResponse } from "webiny/api/graphql"`
|
|
34
|
+
**Source:** `@webiny/handler-graphql/responses.ts`
|
|
35
|
+
**Description:** GraphQL list error response helper.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
**Name:** `ListResponse`
|
|
39
|
+
**Import:** `import { ListResponse } from "webiny/api/graphql"`
|
|
40
|
+
**Source:** `@webiny/handler-graphql/responses.ts`
|
|
41
|
+
**Description:** GraphQL list response helper.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
**Name:** `NotAuthorizedResponse`
|
|
45
|
+
**Import:** `import { NotAuthorizedResponse } from "webiny/api/graphql"`
|
|
46
|
+
**Source:** `@webiny/api-core/graphql/security/NotAuthorizedResponse.ts`
|
|
47
|
+
**Description:** GraphQL not-authorized response helper.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
**Name:** `NotFoundResponse`
|
|
51
|
+
**Import:** `import { NotFoundResponse } from "webiny/api/graphql"`
|
|
52
|
+
**Source:** `@webiny/handler-graphql/responses.ts`
|
|
53
|
+
**Description:** GraphQL not-found response helper.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
**Name:** `Response`
|
|
57
|
+
**Import:** `import { Response } from "webiny/api/graphql"`
|
|
58
|
+
**Source:** `@webiny/handler-graphql/responses.ts`
|
|
59
|
+
**Description:** GraphQL response helper.
|
|
60
|
+
|
|
61
|
+
---
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-key-value-store-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
api/key-value-store — 2 abstractions.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# api/key-value-store
|
|
9
|
+
|
|
10
|
+
## How to Use
|
|
11
|
+
|
|
12
|
+
1. Find the abstraction you need below
|
|
13
|
+
2. Read the source file to get the exact interface and types
|
|
14
|
+
3. Import: `import { Name } from "<importPath>";`
|
|
15
|
+
4. See `webiny-use-case-pattern` or `webiny-event-handler-pattern` skills for implementation patterns
|
|
16
|
+
|
|
17
|
+
## Abstractions
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
**Name:** `GlobalKeyValueStore`
|
|
21
|
+
**Import:** `import { GlobalKeyValueStore } from "webiny/api/key-value-store"`
|
|
22
|
+
**Source:** `@webiny/api-core/features/keyValueStore/index.ts`
|
|
23
|
+
**Description:** Global (non-tenant-scoped) key-value store.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
**Name:** `KeyValueStore`
|
|
27
|
+
**Import:** `import { KeyValueStore } from "webiny/api/key-value-store"`
|
|
28
|
+
**Source:** `@webiny/api-core/features/keyValueStore/index.ts`
|
|
29
|
+
**Description:** Tenant-scoped key-value store.
|
|
30
|
+
|
|
31
|
+
---
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-logger-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
api/logger — 1 abstractions.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# api/logger
|
|
9
|
+
|
|
10
|
+
## How to Use
|
|
11
|
+
|
|
12
|
+
1. Find the abstraction you need below
|
|
13
|
+
2. Read the source file to get the exact interface and types
|
|
14
|
+
3. Import: `import { Name } from "<importPath>";`
|
|
15
|
+
4. See `webiny-use-case-pattern` or `webiny-event-handler-pattern` skills for implementation patterns
|
|
16
|
+
|
|
17
|
+
## Abstractions
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
**Name:** `Logger`
|
|
21
|
+
**Import:** `import { Logger } from "webiny/api/logger"`
|
|
22
|
+
**Source:** `@webiny/api-core/features/logger/index.ts`
|
|
23
|
+
**Description:** Structured logging with multiple log levels.
|
|
24
|
+
|
|
25
|
+
---
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-opensearch-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
api/opensearch — 4 abstractions.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# api/opensearch
|
|
9
|
+
|
|
10
|
+
## How to Use
|
|
11
|
+
|
|
12
|
+
1. Find the abstraction you need below
|
|
13
|
+
2. Read the source file to get the exact interface and types
|
|
14
|
+
3. Import: `import { Name } from "<importPath>";`
|
|
15
|
+
4. See `webiny-use-case-pattern` or `webiny-event-handler-pattern` skills for implementation patterns
|
|
16
|
+
|
|
17
|
+
## Abstractions
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
**Name:** `createOpenSearchClient`
|
|
21
|
+
**Import:** `import { createOpenSearchClient } from "webiny/api/opensearch"`
|
|
22
|
+
**Source:** `@webiny/api-opensearch/client.ts`
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
**Name:** `OpenSearchClient`
|
|
26
|
+
**Import:** `import { OpenSearchClient } from "webiny/api/opensearch"`
|
|
27
|
+
**Source:** `@webiny/api-opensearch/features/OpenSearchClient/abstraction.ts`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
**Name:** `OpenSearchClientFactory`
|
|
31
|
+
**Import:** `import { OpenSearchClientFactory } from "webiny/api/opensearch"`
|
|
32
|
+
**Source:** `@webiny/api-opensearch/features/OpenSearchClientFactory/abstraction.ts`
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
**Name:** `OpenSearchContext`
|
|
36
|
+
**Import:** `import { OpenSearchContext } from "webiny/api/opensearch"`
|
|
37
|
+
**Source:** `@webiny/api-opensearch/features/OpenSearchContext/abstraction.ts`
|
|
38
|
+
|
|
39
|
+
---
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-scheduler-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
API — Scheduler — 15 abstractions.
|
|
6
|
+
Scheduled action use cases.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# API — Scheduler
|
|
10
|
+
|
|
11
|
+
Scheduled action use cases.
|
|
12
|
+
|
|
13
|
+
## How to Use
|
|
14
|
+
|
|
15
|
+
1. Find the abstraction you need below
|
|
16
|
+
2. Read the source file to get the exact interface and types
|
|
17
|
+
3. Import: `import { Name } from "<importPath>";`
|
|
18
|
+
4. See `webiny-use-case-pattern` or `webiny-event-handler-pattern` skills for implementation patterns
|
|
19
|
+
|
|
20
|
+
## Abstractions
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
**Name:** `CancelScheduledActionUseCase`
|
|
24
|
+
**Import:** `import { CancelScheduledActionUseCase } from "webiny/api/scheduler"`
|
|
25
|
+
**Source:** `@webiny/api-scheduler/features/CancelScheduledAction/index.ts`
|
|
26
|
+
**Description:** Cancel a scheduled action.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
**Name:** `ExecuteScheduledActionUseCase`
|
|
30
|
+
**Import:** `import { ExecuteScheduledActionUseCase } from "webiny/api/scheduler"`
|
|
31
|
+
**Source:** `@webiny/api-scheduler/features/ExecuteScheduledAction/index.ts`
|
|
32
|
+
**Description:** Execute a scheduled action immediately.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
**Name:** `GetScheduledActionUseCase`
|
|
36
|
+
**Import:** `import { GetScheduledActionUseCase } from "webiny/api/scheduler"`
|
|
37
|
+
**Source:** `@webiny/api-scheduler/features/GetScheduledAction/index.ts`
|
|
38
|
+
**Description:** Retrieve a scheduled action.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
**Name:** `IScheduledAction`
|
|
42
|
+
**Kind:** type
|
|
43
|
+
**Import:** `import type { IScheduledAction } from "webiny/api/scheduler"`
|
|
44
|
+
**Source:** `@webiny/api-scheduler/shared/abstractions.ts`
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
**Name:** `IScheduledActionEntry`
|
|
48
|
+
**Kind:** type
|
|
49
|
+
**Import:** `import type { IScheduledActionEntry } from "webiny/api/scheduler"`
|
|
50
|
+
**Source:** `@webiny/api-scheduler/shared/abstractions.ts`
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
**Name:** `ListScheduledActionsUseCase`
|
|
54
|
+
**Import:** `import { ListScheduledActionsUseCase } from "webiny/api/scheduler"`
|
|
55
|
+
**Source:** `@webiny/api-scheduler/features/ListScheduledActions/index.ts`
|
|
56
|
+
**Description:** List scheduled actions.
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
**Name:** `NamespaceHandler`
|
|
60
|
+
**Import:** `import { NamespaceHandler } from "webiny/api/scheduler"`
|
|
61
|
+
**Source:** `@webiny/api-scheduler/features/NamespaceHandler/index.ts`
|
|
62
|
+
**Description:** Handle namespace-specific scheduled action logic.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
**Name:** `ScheduleActionError`
|
|
66
|
+
**Kind:** type
|
|
67
|
+
**Import:** `import type { ScheduleActionError } from "webiny/api/scheduler"`
|
|
68
|
+
**Source:** `@webiny/api-scheduler/features/ScheduleAction/index.ts`
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
**Name:** `ScheduleActionUseCase`
|
|
72
|
+
**Import:** `import { ScheduleActionUseCase } from "webiny/api/scheduler"`
|
|
73
|
+
**Source:** `@webiny/api-scheduler/features/ScheduleAction/index.ts`
|
|
74
|
+
**Description:** Schedule an action for future execution.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
**Name:** `SCHEDULED_ACTION_PUBLISH`
|
|
78
|
+
**Import:** `import { SCHEDULED_ACTION_PUBLISH } from "webiny/api/scheduler"`
|
|
79
|
+
**Source:** `@webiny/api-scheduler/constants.ts`
|
|
80
|
+
**Description:** Constant identifier for the publish scheduled action type.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
**Name:** `SCHEDULED_ACTION_UNPUBLISH`
|
|
84
|
+
**Import:** `import { SCHEDULED_ACTION_UNPUBLISH } from "webiny/api/scheduler"`
|
|
85
|
+
**Source:** `@webiny/api-scheduler/constants.ts`
|
|
86
|
+
**Description:** Constant identifier for the unpublish scheduled action type.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
**Name:** `ScheduledActionHandler`
|
|
90
|
+
**Import:** `import { ScheduledActionHandler } from "webiny/api/scheduler"`
|
|
91
|
+
**Source:** `@webiny/api-scheduler/shared/abstractions.ts`
|
|
92
|
+
**Description:** Handle execution of a scheduled action.
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
**Name:** `ScheduledActionModel`
|
|
96
|
+
**Import:** `import { ScheduledActionModel } from "webiny/api/scheduler"`
|
|
97
|
+
**Source:** `@webiny/api-scheduler/shared/abstractions.ts`
|
|
98
|
+
**Description:** ScheduledActionModel - A CMS model used by the scheduler for persistence.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
**Name:** `ScheduledActionType`
|
|
102
|
+
**Kind:** type
|
|
103
|
+
**Import:** `import type { ScheduledActionType } from "webiny/api/scheduler"`
|
|
104
|
+
**Source:** `@webiny/api-scheduler/shared/abstractions.ts`
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
**Name:** `SchedulerService`
|
|
108
|
+
**Import:** `import { SchedulerService } from "webiny/api/scheduler"`
|
|
109
|
+
**Source:** `@webiny/api-scheduler/shared/abstractions.ts`
|
|
110
|
+
**Description:** Core service for managing scheduled actions.
|
|
111
|
+
|
|
112
|
+
---
|