@webiny/mcp 6.0.0-rc.7 → 6.1.0-beta.0
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,317 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-security-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
API — Security & Auth — 49 abstractions.
|
|
6
|
+
Authentication, API keys, roles, users, teams event handlers and use cases.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# API — Security & Auth
|
|
10
|
+
|
|
11
|
+
Authentication, API keys, roles, users, teams 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:** `AfterAuthenticationEventHandler`
|
|
24
|
+
**Import:** `import { AfterAuthenticationEventHandler } from "webiny/api/security/authentication"`
|
|
25
|
+
**Source:** `@webiny/api-core/features/security/authentication/AuthenticationContext/index.ts`
|
|
26
|
+
**Description:** Hook into authentication lifecycle after authentication occurs.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
**Name:** `ApiKeyAfterCreateEventHandler`
|
|
30
|
+
**Import:** `import { ApiKeyAfterCreateEventHandler } from "webiny/api/security/api-key"`
|
|
31
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/CreateApiKey/index.ts`
|
|
32
|
+
**Description:** Hook into API key lifecycle after an API key is created.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
**Name:** `ApiKeyAfterDeleteEventHandler`
|
|
36
|
+
**Import:** `import { ApiKeyAfterDeleteEventHandler } from "webiny/api/security/api-key"`
|
|
37
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/DeleteApiKey/index.ts`
|
|
38
|
+
**Description:** Hook into API key lifecycle after an API key is deleted.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
**Name:** `ApiKeyAfterUpdateEventHandler`
|
|
42
|
+
**Import:** `import { ApiKeyAfterUpdateEventHandler } from "webiny/api/security/api-key"`
|
|
43
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/UpdateApiKey/index.ts`
|
|
44
|
+
**Description:** Hook into API key lifecycle after an API key is updated.
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
**Name:** `ApiKeyBeforeCreateEventHandler`
|
|
48
|
+
**Import:** `import { ApiKeyBeforeCreateEventHandler } from "webiny/api/security/api-key"`
|
|
49
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/CreateApiKey/index.ts`
|
|
50
|
+
**Description:** Hook into API key lifecycle before an API key is created.
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
**Name:** `ApiKeyBeforeDeleteEventHandler`
|
|
54
|
+
**Import:** `import { ApiKeyBeforeDeleteEventHandler } from "webiny/api/security/api-key"`
|
|
55
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/DeleteApiKey/index.ts`
|
|
56
|
+
**Description:** Hook into API key lifecycle before an API key is deleted.
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
**Name:** `ApiKeyBeforeUpdateEventHandler`
|
|
60
|
+
**Import:** `import { ApiKeyBeforeUpdateEventHandler } from "webiny/api/security/api-key"`
|
|
61
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/UpdateApiKey/index.ts`
|
|
62
|
+
**Description:** Hook into API key lifecycle before an API key is updated.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
**Name:** `ApiKeyFactory`
|
|
66
|
+
**Import:** `import { ApiKeyFactory } from "webiny/api/security/api-key"`
|
|
67
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/shared/abstractions.ts`
|
|
68
|
+
**Description:** Provide code-defined API keys.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
**Name:** `ApiKeyFactory`
|
|
72
|
+
**Import:** `import { ApiKeyFactory } from "webiny/api/security"`
|
|
73
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/shared/abstractions.ts`
|
|
74
|
+
**Description:** Provide code-defined API keys.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
**Name:** `ApiToken`
|
|
78
|
+
**Import:** `import { ApiToken } from "webiny/api/security"`
|
|
79
|
+
**Source:** `@webiny/api-core/domain/security/ApiToken.ts`
|
|
80
|
+
**Description:** Represents an API token identity.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
**Name:** `Authenticator`
|
|
84
|
+
**Import:** `import { Authenticator } from "webiny/api/security"`
|
|
85
|
+
**Source:** `@webiny/api-core/features/security/authentication/Authenticator/abstractions.ts`
|
|
86
|
+
**Description:** Convert an authentication token into identity data.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
**Name:** `Authorizer`
|
|
90
|
+
**Import:** `import { Authorizer } from "webiny/api/security"`
|
|
91
|
+
**Source:** `@webiny/api-core/features/security/authorization/Authorizer/index.ts`
|
|
92
|
+
**Description:** Retrieve permissions for an identity.
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
**Name:** `BeforeAuthenticationEventHandler`
|
|
96
|
+
**Import:** `import { BeforeAuthenticationEventHandler } from "webiny/api/security/authentication"`
|
|
97
|
+
**Source:** `@webiny/api-core/features/security/authentication/AuthenticationContext/index.ts`
|
|
98
|
+
**Description:** Hook into authentication lifecycle before authentication occurs.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
**Name:** `CreateApiKeyUseCase`
|
|
102
|
+
**Import:** `import { CreateApiKeyUseCase } from "webiny/api/security/api-key"`
|
|
103
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/CreateApiKey/index.ts`
|
|
104
|
+
**Description:** Create a new API key.
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
**Name:** `CreateRoleUseCase`
|
|
108
|
+
**Import:** `import { CreateRoleUseCase } from "webiny/api/security/role"`
|
|
109
|
+
**Source:** `@webiny/api-core/features/security/roles/CreateRole/index.ts`
|
|
110
|
+
**Description:** Create a new security role.
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
**Name:** `CreateUserUseCase`
|
|
114
|
+
**Import:** `import { CreateUserUseCase } from "webiny/api/security/user"`
|
|
115
|
+
**Source:** `@webiny/api-core/features/users/CreateUser/index.ts`
|
|
116
|
+
**Description:** Create a new admin user.
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
**Name:** `DeleteApiKeyUseCase`
|
|
120
|
+
**Import:** `import { DeleteApiKeyUseCase } from "webiny/api/security/api-key"`
|
|
121
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/DeleteApiKey/index.ts`
|
|
122
|
+
**Description:** Delete an API key.
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
**Name:** `DeleteRoleUseCase`
|
|
126
|
+
**Import:** `import { DeleteRoleUseCase } from "webiny/api/security/role"`
|
|
127
|
+
**Source:** `@webiny/api-core/features/security/roles/DeleteRole/index.ts`
|
|
128
|
+
**Description:** Delete a security role.
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
**Name:** `DeleteUserUseCase`
|
|
132
|
+
**Import:** `import { DeleteUserUseCase } from "webiny/api/security/user"`
|
|
133
|
+
**Source:** `@webiny/api-core/features/users/DeleteUser/index.ts`
|
|
134
|
+
**Description:** Delete an admin user.
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
**Name:** `GetApiKeyByTokenUseCase`
|
|
138
|
+
**Import:** `import { GetApiKeyByTokenUseCase } from "webiny/api/security/api-key"`
|
|
139
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/GetApiKeyByToken/index.ts`
|
|
140
|
+
**Description:** Retrieve an API key by its token value.
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
**Name:** `GetApiKeyUseCase`
|
|
144
|
+
**Import:** `import { GetApiKeyUseCase } from "webiny/api/security/api-key"`
|
|
145
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/GetApiKey/index.ts`
|
|
146
|
+
**Description:** Retrieve an API key by ID.
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
**Name:** `GetRoleUseCase`
|
|
150
|
+
**Import:** `import { GetRoleUseCase } from "webiny/api/security/role"`
|
|
151
|
+
**Source:** `@webiny/api-core/features/security/roles/GetRole/index.ts`
|
|
152
|
+
**Description:** Retrieve a security role.
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
**Name:** `GetUserUseCase`
|
|
156
|
+
**Import:** `import { GetUserUseCase } from "webiny/api/security/user"`
|
|
157
|
+
**Source:** `@webiny/api-core/features/users/GetUser/index.ts`
|
|
158
|
+
**Description:** Retrieve an admin user.
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
**Name:** `Identity`
|
|
162
|
+
**Import:** `import { Identity } from "webiny/api/security"`
|
|
163
|
+
**Source:** `@webiny/api-core/features/security/IdentityContext/index.ts`
|
|
164
|
+
**Description:** Abstract base class for all identity types.
|
|
165
|
+
Provides a common interface for identity checks across the codebase.
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
**Name:** `IdentityContext`
|
|
169
|
+
**Import:** `import { IdentityContext } from "webiny/api/security"`
|
|
170
|
+
**Source:** `@webiny/api-core/features/security/IdentityContext/index.ts`
|
|
171
|
+
**Description:** Provides access to the current identity and its permissions.
|
|
172
|
+
|
|
173
|
+
---
|
|
174
|
+
**Name:** `IdentityProvider`
|
|
175
|
+
**Import:** `import { IdentityProvider } from "webiny/api/security"`
|
|
176
|
+
**Source:** `@webiny/api-core/idp/index.ts`
|
|
177
|
+
**Description:** Generic identity provider for token-based authentication.
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
**Name:** `JwtIdentityProvider`
|
|
181
|
+
**Import:** `import { JwtIdentityProvider } from "webiny/api/security"`
|
|
182
|
+
**Source:** `@webiny/api-core/idp/index.ts`
|
|
183
|
+
**Description:** JWT-specific identity provider for token validation.
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
**Name:** `ListApiKeysUseCase`
|
|
187
|
+
**Import:** `import { ListApiKeysUseCase } from "webiny/api/security/api-key"`
|
|
188
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/ListApiKeys/index.ts`
|
|
189
|
+
**Description:** List all API keys.
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
**Name:** `ListRolesUseCase`
|
|
193
|
+
**Import:** `import { ListRolesUseCase } from "webiny/api/security/role"`
|
|
194
|
+
**Source:** `@webiny/api-core/features/security/roles/ListRoles/index.ts`
|
|
195
|
+
**Description:** List all security roles.
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
**Name:** `ListUsersUseCase`
|
|
199
|
+
**Import:** `import { ListUsersUseCase } from "webiny/api/security/user"`
|
|
200
|
+
**Source:** `@webiny/api-core/features/users/ListUsers/index.ts`
|
|
201
|
+
**Description:** List all admin users.
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
**Name:** `ListUserTeamsUseCase`
|
|
205
|
+
**Import:** `import { ListUserTeamsUseCase } from "webiny/api/security/user"`
|
|
206
|
+
**Source:** `@webiny/api-core/features/users/ListUserTeams/index.ts`
|
|
207
|
+
**Description:** List teams assigned to a user.
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
**Name:** `OidcIdentityProvider`
|
|
211
|
+
**Import:** `import { OidcIdentityProvider } from "webiny/api/security"`
|
|
212
|
+
**Source:** `@webiny/api-core/idp/index.ts`
|
|
213
|
+
**Description:** OIDC-compliant identity provider with issuer validation.
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
**Name:** `RoleAfterCreateEventHandler`
|
|
217
|
+
**Import:** `import { RoleAfterCreateEventHandler } from "webiny/api/security/role"`
|
|
218
|
+
**Source:** `@webiny/api-core/features/security/roles/CreateRole/index.ts`
|
|
219
|
+
**Description:** Hook into role lifecycle after a role is created.
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
**Name:** `RoleAfterDeleteEventHandler`
|
|
223
|
+
**Import:** `import { RoleAfterDeleteEventHandler } from "webiny/api/security/role"`
|
|
224
|
+
**Source:** `@webiny/api-core/features/security/roles/DeleteRole/index.ts`
|
|
225
|
+
**Description:** Hook into role lifecycle after a role is deleted.
|
|
226
|
+
|
|
227
|
+
---
|
|
228
|
+
**Name:** `RoleAfterUpdateEventHandler`
|
|
229
|
+
**Import:** `import { RoleAfterUpdateEventHandler } from "webiny/api/security/role"`
|
|
230
|
+
**Source:** `@webiny/api-core/features/security/roles/UpdateRole/index.ts`
|
|
231
|
+
**Description:** Hook into role lifecycle after a role is updated.
|
|
232
|
+
|
|
233
|
+
---
|
|
234
|
+
**Name:** `RoleBeforeCreateEventHandler`
|
|
235
|
+
**Import:** `import { RoleBeforeCreateEventHandler } from "webiny/api/security/role"`
|
|
236
|
+
**Source:** `@webiny/api-core/features/security/roles/CreateRole/index.ts`
|
|
237
|
+
**Description:** Hook into role lifecycle before a role is created.
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
**Name:** `RoleBeforeDeleteEventHandler`
|
|
241
|
+
**Import:** `import { RoleBeforeDeleteEventHandler } from "webiny/api/security/role"`
|
|
242
|
+
**Source:** `@webiny/api-core/features/security/roles/DeleteRole/index.ts`
|
|
243
|
+
**Description:** Hook into role lifecycle before a role is deleted.
|
|
244
|
+
|
|
245
|
+
---
|
|
246
|
+
**Name:** `RoleBeforeUpdateEventHandler`
|
|
247
|
+
**Import:** `import { RoleBeforeUpdateEventHandler } from "webiny/api/security/role"`
|
|
248
|
+
**Source:** `@webiny/api-core/features/security/roles/UpdateRole/index.ts`
|
|
249
|
+
**Description:** Hook into role lifecycle before a role is updated.
|
|
250
|
+
|
|
251
|
+
---
|
|
252
|
+
**Name:** `RoleFactory`
|
|
253
|
+
**Import:** `import { RoleFactory } from "webiny/api/security"`
|
|
254
|
+
**Source:** `@webiny/api-core/features/security/roles/shared/abstractions.ts`
|
|
255
|
+
**Description:** Provide code-defined security roles with permissions.
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
**Name:** `TeamFactory`
|
|
259
|
+
**Import:** `import { TeamFactory } from "webiny/api/security"`
|
|
260
|
+
**Source:** `@webiny/api-core/features/security/teams/shared/abstractions.ts`
|
|
261
|
+
**Description:** Provide code-defined teams.
|
|
262
|
+
|
|
263
|
+
---
|
|
264
|
+
**Name:** `UpdateApiKeyUseCase`
|
|
265
|
+
**Import:** `import { UpdateApiKeyUseCase } from "webiny/api/security/api-key"`
|
|
266
|
+
**Source:** `@webiny/api-core/features/security/apiKeys/UpdateApiKey/index.ts`
|
|
267
|
+
**Description:** Update an existing API key.
|
|
268
|
+
|
|
269
|
+
---
|
|
270
|
+
**Name:** `UpdateRoleUseCase`
|
|
271
|
+
**Import:** `import { UpdateRoleUseCase } from "webiny/api/security/role"`
|
|
272
|
+
**Source:** `@webiny/api-core/features/security/roles/UpdateRole/index.ts`
|
|
273
|
+
**Description:** Update an existing security role.
|
|
274
|
+
|
|
275
|
+
---
|
|
276
|
+
**Name:** `UpdateUserUseCase`
|
|
277
|
+
**Import:** `import { UpdateUserUseCase } from "webiny/api/security/user"`
|
|
278
|
+
**Source:** `@webiny/api-core/features/users/UpdateUser/index.ts`
|
|
279
|
+
**Description:** Update an existing admin user.
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
**Name:** `UserAfterCreateEventHandler`
|
|
283
|
+
**Import:** `import { UserAfterCreateEventHandler } from "webiny/api/security/user"`
|
|
284
|
+
**Source:** `@webiny/api-core/features/users/CreateUser/index.ts`
|
|
285
|
+
**Description:** Hook into user lifecycle after a user is created.
|
|
286
|
+
|
|
287
|
+
---
|
|
288
|
+
**Name:** `UserAfterDeleteEventHandler`
|
|
289
|
+
**Import:** `import { UserAfterDeleteEventHandler } from "webiny/api/security/user"`
|
|
290
|
+
**Source:** `@webiny/api-core/features/users/DeleteUser/index.ts`
|
|
291
|
+
**Description:** Hook into user lifecycle after a user is deleted.
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
**Name:** `UserAfterUpdateEventHandler`
|
|
295
|
+
**Import:** `import { UserAfterUpdateEventHandler } from "webiny/api/security/user"`
|
|
296
|
+
**Source:** `@webiny/api-core/features/users/UpdateUser/index.ts`
|
|
297
|
+
**Description:** Hook into user lifecycle after a user is updated.
|
|
298
|
+
|
|
299
|
+
---
|
|
300
|
+
**Name:** `UserBeforeCreateEventHandler`
|
|
301
|
+
**Import:** `import { UserBeforeCreateEventHandler } from "webiny/api/security/user"`
|
|
302
|
+
**Source:** `@webiny/api-core/features/users/CreateUser/index.ts`
|
|
303
|
+
**Description:** Hook into user lifecycle before a user is created.
|
|
304
|
+
|
|
305
|
+
---
|
|
306
|
+
**Name:** `UserBeforeDeleteEventHandler`
|
|
307
|
+
**Import:** `import { UserBeforeDeleteEventHandler } from "webiny/api/security/user"`
|
|
308
|
+
**Source:** `@webiny/api-core/features/users/DeleteUser/index.ts`
|
|
309
|
+
**Description:** Hook into user lifecycle before a user is deleted.
|
|
310
|
+
|
|
311
|
+
---
|
|
312
|
+
**Name:** `UserBeforeUpdateEventHandler`
|
|
313
|
+
**Import:** `import { UserBeforeUpdateEventHandler } from "webiny/api/security/user"`
|
|
314
|
+
**Source:** `@webiny/api-core/features/users/UpdateUser/index.ts`
|
|
315
|
+
**Description:** Hook into user lifecycle before a user is updated.
|
|
316
|
+
|
|
317
|
+
---
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-system-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
API — System — 2 abstractions.
|
|
6
|
+
System installation event handlers and use cases.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# API — System
|
|
10
|
+
|
|
11
|
+
System installation 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:** `InstallSystemUseCase`
|
|
24
|
+
**Import:** `import { InstallSystemUseCase } from "webiny/api/system"`
|
|
25
|
+
**Source:** `@webiny/api-core/features/system/InstallSystem/index.ts`
|
|
26
|
+
**Description:** Run system-wide installation.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
**Name:** `SystemInstalledEventHandler`
|
|
30
|
+
**Import:** `import { SystemInstalledEventHandler } from "webiny/api/system"`
|
|
31
|
+
**Source:** `@webiny/api-core/features/system/InstallSystem/index.ts`
|
|
32
|
+
**Description:** Hook into system lifecycle after the system is installed.
|
|
33
|
+
|
|
34
|
+
---
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-tasks-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
api/tasks — 2 abstractions.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# api/tasks
|
|
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:** `TaskDefinition`
|
|
21
|
+
**Import:** `import { TaskDefinition } from "webiny/api/tasks"`
|
|
22
|
+
**Source:** `@webiny/api-core/features/task/TaskDefinition/index.ts`
|
|
23
|
+
**Description:** Define a long-running background task with lifecycle hooks.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
**Name:** `TaskService`
|
|
27
|
+
**Import:** `import { TaskService } from "webiny/api/tasks"`
|
|
28
|
+
**Source:** `@webiny/api-core/features/task/TaskService/index.ts`
|
|
29
|
+
**Description:** Trigger and manage long-running background tasks.
|
|
30
|
+
|
|
31
|
+
---
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-tenancy-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
API — Tenancy — 17 abstractions.
|
|
6
|
+
Tenant lifecycle and installation event handlers and use cases.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# API — Tenancy
|
|
10
|
+
|
|
11
|
+
Tenant lifecycle and installation 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:** `AppInstaller`
|
|
24
|
+
**Import:** `import { AppInstaller } from "webiny/api/tenancy"`
|
|
25
|
+
**Source:** `@webiny/api-core/features/tenancy/InstallTenant/index.ts`
|
|
26
|
+
**Description:** Install an application on a tenant with rollback support.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
**Name:** `CreateTenantRepository`
|
|
30
|
+
**Import:** `import { CreateTenantRepository } from "webiny/api/tenancy"`
|
|
31
|
+
**Source:** `@webiny/api-core/features/tenancy/CreateTenant/index.ts`
|
|
32
|
+
**Description:** Persist a newly created tenant.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
**Name:** `CreateTenantUseCase`
|
|
36
|
+
**Import:** `import { CreateTenantUseCase } from "webiny/api/tenancy"`
|
|
37
|
+
**Source:** `@webiny/api-core/features/tenancy/CreateTenant/index.ts`
|
|
38
|
+
**Description:** Create a new tenant.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
**Name:** `DeleteTenantRepository`
|
|
42
|
+
**Import:** `import { DeleteTenantRepository } from "webiny/api/tenancy"`
|
|
43
|
+
**Source:** `@webiny/api-core/features/tenancy/DeleteTenant/index.ts`
|
|
44
|
+
**Description:** Persist tenant deletion.
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
**Name:** `DeleteTenantUseCase`
|
|
48
|
+
**Import:** `import { DeleteTenantUseCase } from "webiny/api/tenancy"`
|
|
49
|
+
**Source:** `@webiny/api-core/features/tenancy/DeleteTenant/index.ts`
|
|
50
|
+
**Description:** Delete a tenant.
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
**Name:** `GetTenantByIdUseCase`
|
|
54
|
+
**Import:** `import { GetTenantByIdUseCase } from "webiny/api/tenancy"`
|
|
55
|
+
**Source:** `@webiny/api-core/features/tenancy/GetTenantById/index.ts`
|
|
56
|
+
**Description:** Retrieve a tenant by its ID.
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
**Name:** `InstallTenantUseCase`
|
|
60
|
+
**Import:** `import { InstallTenantUseCase } from "webiny/api/tenancy"`
|
|
61
|
+
**Source:** `@webiny/api-core/features/tenancy/InstallTenant/index.ts`
|
|
62
|
+
**Description:** Run all app installers for a tenant.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
**Name:** `TenantAfterCreateEventHandler`
|
|
66
|
+
**Import:** `import { TenantAfterCreateEventHandler } from "webiny/api/tenancy"`
|
|
67
|
+
**Source:** `@webiny/api-core/features/tenancy/CreateTenant/index.ts`
|
|
68
|
+
**Description:** Hook into tenant lifecycle after a tenant is created.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
**Name:** `TenantAfterDeleteEventHandler`
|
|
72
|
+
**Import:** `import { TenantAfterDeleteEventHandler } from "webiny/api/tenancy"`
|
|
73
|
+
**Source:** `@webiny/api-core/features/tenancy/DeleteTenant/index.ts`
|
|
74
|
+
**Description:** Hook into tenant lifecycle after a tenant is deleted.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
**Name:** `TenantAfterUpdateEventHandler`
|
|
78
|
+
**Import:** `import { TenantAfterUpdateEventHandler } from "webiny/api/tenancy"`
|
|
79
|
+
**Source:** `@webiny/api-core/features/tenancy/UpdateTenant/index.ts`
|
|
80
|
+
**Description:** Hook into tenant lifecycle after a tenant is updated.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
**Name:** `TenantBeforeCreateEventHandler`
|
|
84
|
+
**Import:** `import { TenantBeforeCreateEventHandler } from "webiny/api/tenancy"`
|
|
85
|
+
**Source:** `@webiny/api-core/features/tenancy/CreateTenant/index.ts`
|
|
86
|
+
**Description:** Hook into tenant lifecycle before a tenant is created.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
**Name:** `TenantBeforeDeleteEventHandler`
|
|
90
|
+
**Import:** `import { TenantBeforeDeleteEventHandler } from "webiny/api/tenancy"`
|
|
91
|
+
**Source:** `@webiny/api-core/features/tenancy/DeleteTenant/index.ts`
|
|
92
|
+
**Description:** Hook into tenant lifecycle before a tenant is deleted.
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
**Name:** `TenantBeforeUpdateEventHandler`
|
|
96
|
+
**Import:** `import { TenantBeforeUpdateEventHandler } from "webiny/api/tenancy"`
|
|
97
|
+
**Source:** `@webiny/api-core/features/tenancy/UpdateTenant/index.ts`
|
|
98
|
+
**Description:** Hook into tenant lifecycle before a tenant is updated.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
**Name:** `TenantContext`
|
|
102
|
+
**Import:** `import { TenantContext } from "webiny/api/tenancy"`
|
|
103
|
+
**Source:** `@webiny/api-core/features/tenancy/TenantContext/index.ts`
|
|
104
|
+
**Description:** Provides access to the current tenant and tenant-scoped execution.
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
**Name:** `TenantInstalledEventHandler`
|
|
108
|
+
**Import:** `import { TenantInstalledEventHandler } from "webiny/api/tenancy"`
|
|
109
|
+
**Source:** `@webiny/api-core/features/tenancy/InstallTenant/index.ts`
|
|
110
|
+
**Description:** Hook into tenant lifecycle after a tenant is installed.
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
**Name:** `UpdateTenantRepository`
|
|
114
|
+
**Import:** `import { UpdateTenantRepository } from "webiny/api/tenancy"`
|
|
115
|
+
**Source:** `@webiny/api-core/features/tenancy/UpdateTenant/index.ts`
|
|
116
|
+
**Description:** Persist tenant updates.
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
**Name:** `UpdateTenantUseCase`
|
|
120
|
+
**Import:** `import { UpdateTenantUseCase } from "webiny/api/tenancy"`
|
|
121
|
+
**Source:** `@webiny/api-core/features/tenancy/UpdateTenant/index.ts`
|
|
122
|
+
**Description:** Update an existing tenant.
|
|
123
|
+
|
|
124
|
+
---
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-tenant-manager-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
API — Tenant Manager — 2 abstractions.
|
|
6
|
+
Tenant management event handlers and use cases.
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# API — Tenant Manager
|
|
10
|
+
|
|
11
|
+
Tenant management 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:** `TenantExtensions`
|
|
24
|
+
**Kind:** type
|
|
25
|
+
**Import:** `import type { TenantExtensions } from "webiny/api/tenant-manager"`
|
|
26
|
+
**Source:** `@webiny/tenant-manager/shared/Tenant.ts`
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
**Name:** `TenantModelExtension`
|
|
30
|
+
**Import:** `import { TenantModelExtension } from "webiny/api/tenant-manager"`
|
|
31
|
+
**Source:** `@webiny/tenant-manager/api/domain/TenantModelExtension.ts`
|
|
32
|
+
**Description:** Extend the tenant content model with custom fields.
|
|
33
|
+
|
|
34
|
+
---
|