@webiny/mcp 6.1.0 → 6.2.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/index.d.ts +2 -0
- package/index.js +2 -0
- package/index.js.map +1 -1
- package/package.json +4 -4
- package/skills/admin/admin-permissions/SKILL.md +227 -73
- package/skills/admin/ui-extensions/SKILL.md +11 -42
- package/skills/api/api-architect/SKILL.md +2 -1
- package/skills/api/http-route/SKILL.md +176 -0
- package/skills/api/permissions/SKILL.md +141 -59
- package/skills/dependency-injection/SKILL.md +200 -2
- package/skills/generated/admin/SKILL.md +6 -16
- package/skills/generated/admin/cms/SKILL.md +39 -1
- package/skills/generated/admin/languages/SKILL.md +29 -0
- package/skills/generated/admin/security/SKILL.md +34 -1
- package/skills/generated/admin/ui/SKILL.md +21 -1
- package/skills/generated/admin/website-builder/SKILL.md +16 -1
- package/skills/generated/api/SKILL.md +58 -1
- package/skills/generated/api/cms/SKILL.md +111 -1
- package/skills/generated/api/db/SKILL.md +34 -0
- package/skills/generated/api/languages/SKILL.md +31 -0
- package/skills/generated/api/security/SKILL.md +26 -1
- package/skills/local-development/SKILL.md +1 -1
- package/skills/webiny-sdk/SKILL.md +174 -60
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: webiny-admin-cms-catalog
|
|
3
3
|
context: webiny-api
|
|
4
4
|
description: >
|
|
5
|
-
admin/cms —
|
|
5
|
+
admin/cms — 69 abstractions.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# admin/cms
|
|
@@ -26,6 +26,11 @@ description: >
|
|
|
26
26
|
**Import:** `import { CmsContentFormRenderer } from "webiny/admin/cms"`
|
|
27
27
|
**Source:** `@webiny/app-headless-cms/legacyPluginAdapters/CmsContentFormRenderer.tsx`
|
|
28
28
|
|
|
29
|
+
---
|
|
30
|
+
**Name:** `CmsGraphQLClient`
|
|
31
|
+
**Import:** `import { CmsGraphQLClient } from "webiny/admin/cms"`
|
|
32
|
+
**Source:** `@webiny/app-headless-cms/features/graphQLClient/index.ts`
|
|
33
|
+
|
|
29
34
|
---
|
|
30
35
|
**Name:** `CmsIdentity`
|
|
31
36
|
**Kind:** type
|
|
@@ -135,6 +140,39 @@ description: >
|
|
|
135
140
|
**Import:** `import { DynamicZoneContainer } from "webiny/admin/cms/field-renderers/dynamic-zone"`
|
|
136
141
|
**Source:** `@webiny/app-headless-cms/admin/plugins/fieldRenderers/dynamicZone/index.tsx`
|
|
137
142
|
|
|
143
|
+
---
|
|
144
|
+
**Name:** `EntryAfterCreateEventHandler`
|
|
145
|
+
**Import:** `import { EntryAfterCreateEventHandler } from "webiny/admin/cms"`
|
|
146
|
+
**Source:** `@webiny/app-headless-cms/features/contentEntry/events/index.ts`
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
**Name:** `EntryAfterCreatePayload`
|
|
150
|
+
**Kind:** type
|
|
151
|
+
**Import:** `import type { EntryAfterCreatePayload } from "webiny/admin/cms"`
|
|
152
|
+
**Source:** `@webiny/app-headless-cms/features/contentEntry/events/index.ts`
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
**Name:** `EntryAfterDeleteEventHandler`
|
|
156
|
+
**Import:** `import { EntryAfterDeleteEventHandler } from "webiny/admin/cms"`
|
|
157
|
+
**Source:** `@webiny/app-headless-cms/features/contentEntry/events/index.ts`
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
**Name:** `EntryAfterDeletePayload`
|
|
161
|
+
**Kind:** type
|
|
162
|
+
**Import:** `import type { EntryAfterDeletePayload } from "webiny/admin/cms"`
|
|
163
|
+
**Source:** `@webiny/app-headless-cms/features/contentEntry/events/index.ts`
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
**Name:** `EntryAfterUpdateEventHandler`
|
|
167
|
+
**Import:** `import { EntryAfterUpdateEventHandler } from "webiny/admin/cms"`
|
|
168
|
+
**Source:** `@webiny/app-headless-cms/features/contentEntry/events/index.ts`
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
**Name:** `EntryAfterUpdatePayload`
|
|
172
|
+
**Kind:** type
|
|
173
|
+
**Import:** `import type { EntryAfterUpdatePayload } from "webiny/admin/cms"`
|
|
174
|
+
**Source:** `@webiny/app-headless-cms/features/contentEntry/events/index.ts`
|
|
175
|
+
|
|
138
176
|
---
|
|
139
177
|
**Name:** `getNodeFromSelection`
|
|
140
178
|
**Import:** `import { getNodeFromSelection } from "webiny/admin/cms/lexical"`
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-admin-languages-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
admin/languages — 2 abstractions.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# admin/languages
|
|
9
|
+
|
|
10
|
+
## How to Use
|
|
11
|
+
|
|
12
|
+
1. Find the abstraction you need below
|
|
13
|
+
2. You MUST read the source file to get the exact interface and types!
|
|
14
|
+
3. Import: `import { Name } from "<importPath>";`
|
|
15
|
+
|
|
16
|
+
## Abstractions
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
**Name:** `LanguageDto`
|
|
20
|
+
**Kind:** type
|
|
21
|
+
**Import:** `import type { LanguageDto } from "webiny/admin/languages"`
|
|
22
|
+
**Source:** `@webiny/languages/admin/features/listLanguages/index.ts`
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
**Name:** `useLanguages`
|
|
26
|
+
**Import:** `import { useLanguages } from "webiny/admin/languages"`
|
|
27
|
+
**Source:** `@webiny/languages/admin/presentation/hooks/useLanguages.tsx`
|
|
28
|
+
|
|
29
|
+
---
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: webiny-admin-security-catalog
|
|
3
3
|
context: webiny-api
|
|
4
4
|
description: >
|
|
5
|
-
admin/security —
|
|
5
|
+
admin/security — 15 abstractions.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# admin/security
|
|
@@ -25,6 +25,31 @@ description: >
|
|
|
25
25
|
**Import:** `import { AuthenticationErrorEventHandler } from "webiny/admin/security"`
|
|
26
26
|
**Source:** `@webiny/app/errors/abstractions.ts`
|
|
27
27
|
|
|
28
|
+
---
|
|
29
|
+
**Name:** `createHasPermission`
|
|
30
|
+
**Import:** `import { createHasPermission } from "webiny/admin/security"`
|
|
31
|
+
**Source:** `@webiny/app-admin/permissions/index.ts`
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
**Name:** `createPermissionsAbstraction`
|
|
35
|
+
**Import:** `import { createPermissionsAbstraction } from "webiny/admin/security"`
|
|
36
|
+
**Source:** `@webiny/app-admin/permissions/index.ts`
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
**Name:** `createPermissionSchema`
|
|
40
|
+
**Import:** `import { createPermissionSchema } from "webiny/admin/security"`
|
|
41
|
+
**Source:** `@webiny/app-admin/permissions/index.ts`
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
**Name:** `createPermissionsFeature`
|
|
45
|
+
**Import:** `import { createPermissionsFeature } from "webiny/admin/security"`
|
|
46
|
+
**Source:** `@webiny/app-admin/permissions/index.ts`
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
**Name:** `createUsePermissions`
|
|
50
|
+
**Import:** `import { createUsePermissions } from "webiny/admin/security"`
|
|
51
|
+
**Source:** `@webiny/app-admin/permissions/index.ts`
|
|
52
|
+
|
|
28
53
|
---
|
|
29
54
|
**Name:** `HasPermissionComponent`
|
|
30
55
|
**Import:** `import { HasPermissionComponent } from "webiny/admin/security"`
|
|
@@ -50,6 +75,14 @@ description: >
|
|
|
50
75
|
**Import:** `import { LogOutUseCase } from "webiny/admin/security"`
|
|
51
76
|
**Source:** `@webiny/app-admin/features/security/LogOut/index.ts`
|
|
52
77
|
|
|
78
|
+
---
|
|
79
|
+
**Name:** `Permissions`
|
|
80
|
+
**Kind:** type
|
|
81
|
+
**Import:** `import type { Permissions } from "webiny/admin/security"`
|
|
82
|
+
**Source:** `@webiny/app-admin/permissions/types.ts`
|
|
83
|
+
**Description:** Canonical type for DI-resolved permissions.
|
|
84
|
+
Same underlying type as `UsePermissionsResult<S>`.
|
|
85
|
+
|
|
53
86
|
---
|
|
54
87
|
**Name:** `useAuthentication`
|
|
55
88
|
**Import:** `import { useAuthentication } from "webiny/admin/security"`
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: webiny-admin-ui-catalog
|
|
3
3
|
context: webiny-api
|
|
4
4
|
description: >
|
|
5
|
-
admin/ui —
|
|
5
|
+
admin/ui — 94 abstractions.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# admin/ui
|
|
@@ -160,6 +160,16 @@ description: >
|
|
|
160
160
|
**Import:** `import { FilterIcon } from "webiny/admin/ui"`
|
|
161
161
|
**Source:** `@webiny/admin-ui/DataList/index.ts`
|
|
162
162
|
|
|
163
|
+
---
|
|
164
|
+
**Name:** `FolderPicker`
|
|
165
|
+
**Import:** `import { FolderPicker } from "webiny/admin/ui"`
|
|
166
|
+
**Source:** `@webiny/app-aco/components/FolderPicker/FolderPicker.tsx`
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
**Name:** `FolderTree`
|
|
170
|
+
**Import:** `import { FolderTree } from "webiny/admin/ui"`
|
|
171
|
+
**Source:** `@webiny/app-aco/components/FolderTree/index.tsx`
|
|
172
|
+
|
|
163
173
|
---
|
|
164
174
|
**Name:** `generateId`
|
|
165
175
|
**Import:** `import { generateId } from "webiny/admin/ui"`
|
|
@@ -435,6 +445,11 @@ description: >
|
|
|
435
445
|
**Import:** `import { UploadIcon } from "webiny/admin/ui"`
|
|
436
446
|
**Source:** `@webiny/admin-ui/DataList/index.ts`
|
|
437
447
|
|
|
448
|
+
---
|
|
449
|
+
**Name:** `useDialog`
|
|
450
|
+
**Import:** `import { useDialog } from "webiny/admin/ui"`
|
|
451
|
+
**Source:** `@webiny/app-admin/hooks/index.ts`
|
|
452
|
+
|
|
438
453
|
---
|
|
439
454
|
**Name:** `useDialogs`
|
|
440
455
|
**Import:** `import { useDialogs } from "webiny/admin/ui"`
|
|
@@ -450,6 +465,11 @@ description: >
|
|
|
450
465
|
**Import:** `import { useHotkeys } from "webiny/admin/ui"`
|
|
451
466
|
**Source:** `@webiny/app-admin/hooks/useHotkeys.ts`
|
|
452
467
|
|
|
468
|
+
---
|
|
469
|
+
**Name:** `useOpenDialog`
|
|
470
|
+
**Import:** `import { useOpenDialog } from "webiny/admin/ui"`
|
|
471
|
+
**Source:** `@webiny/app-admin/hooks/index.ts`
|
|
472
|
+
|
|
453
473
|
---
|
|
454
474
|
**Name:** `useSidebar`
|
|
455
475
|
**Import:** `import { useSidebar } from "webiny/admin/ui"`
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: webiny-admin-website-builder-catalog
|
|
3
3
|
context: webiny-api
|
|
4
4
|
description: >
|
|
5
|
-
admin/website-builder —
|
|
5
|
+
admin/website-builder — 61 abstractions.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# admin/website-builder
|
|
@@ -155,6 +155,11 @@ which can be mutated in place.
|
|
|
155
155
|
**Import:** `import { getNodeFromSelection } from "webiny/admin/website-builder/lexical"`
|
|
156
156
|
**Source:** `@webiny/lexical-editor/exports/admin/lexical.ts`
|
|
157
157
|
|
|
158
|
+
---
|
|
159
|
+
**Name:** `HasPermission`
|
|
160
|
+
**Import:** `import { HasPermission } from "webiny/admin/website-builder"`
|
|
161
|
+
**Source:** `@webiny/app-website-builder/presentation/security/HasPermission.tsx`
|
|
162
|
+
|
|
158
163
|
---
|
|
159
164
|
**Name:** `Klass`
|
|
160
165
|
**Kind:** type
|
|
@@ -187,6 +192,16 @@ which can be mutated in place.
|
|
|
187
192
|
**Import:** `import { pagePathFromTitle } from "webiny/admin/website-builder"`
|
|
188
193
|
**Source:** `@webiny/app-website-builder/index.ts`
|
|
189
194
|
|
|
195
|
+
---
|
|
196
|
+
**Name:** `PageType`
|
|
197
|
+
**Import:** `import { PageType } from "webiny/admin/website-builder"`
|
|
198
|
+
**Source:** `@webiny/app-website-builder/presentation/pages/CreatePage/abstractions.ts`
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
**Name:** `PageTypeProvider`
|
|
202
|
+
**Import:** `import { PageTypeProvider } from "webiny/admin/website-builder"`
|
|
203
|
+
**Source:** `@webiny/app-website-builder/presentation/pages/CreatePage/abstractions.ts`
|
|
204
|
+
|
|
190
205
|
---
|
|
191
206
|
**Name:** `RedirectListConfig`
|
|
192
207
|
**Import:** `import { RedirectListConfig } from "webiny/admin/website-builder/redirect/list"`
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: webiny-api-catalog
|
|
3
3
|
context: webiny-api
|
|
4
4
|
description: >
|
|
5
|
-
api —
|
|
5
|
+
api — 14 abstractions.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# api
|
|
@@ -20,6 +20,28 @@ description: >
|
|
|
20
20
|
**Import:** `import { BaseError } from "webiny/api"`
|
|
21
21
|
**Source:** `@webiny/feature/api/index.ts`
|
|
22
22
|
|
|
23
|
+
---
|
|
24
|
+
**Name:** `BuildParam`
|
|
25
|
+
**Import:** `import { BuildParam } from "webiny/api"`
|
|
26
|
+
**Source:** `@webiny/api-core/features/buildParams/index.ts`
|
|
27
|
+
**Description:** A single build-time configuration parameter.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
**Name:** `BuildParams`
|
|
31
|
+
**Import:** `import { BuildParams } from "webiny/api"`
|
|
32
|
+
**Source:** `@webiny/api-core/features/buildParams/index.ts`
|
|
33
|
+
**Description:** Access build-time configuration parameters.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
**Name:** `Compression`
|
|
37
|
+
**Import:** `import { Compression } from "webiny/api"`
|
|
38
|
+
**Source:** `@webiny/utils/features/compression/abstractions/Compression.ts`
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
**Name:** `CompressionHandler`
|
|
42
|
+
**Import:** `import { CompressionHandler } from "webiny/api"`
|
|
43
|
+
**Source:** `@webiny/utils/features/compression/abstractions/CompressionHandler.ts`
|
|
44
|
+
|
|
23
45
|
---
|
|
24
46
|
**Name:** `createAbstraction`
|
|
25
47
|
**Import:** `import { createAbstraction } from "webiny/api"`
|
|
@@ -30,6 +52,36 @@ description: >
|
|
|
30
52
|
**Import:** `import { createFeature } from "webiny/api"`
|
|
31
53
|
**Source:** `@webiny/feature/api/index.ts`
|
|
32
54
|
|
|
55
|
+
---
|
|
56
|
+
**Name:** `DomainEvent`
|
|
57
|
+
**Import:** `import { DomainEvent } from "webiny/api"`
|
|
58
|
+
**Source:** `@webiny/api-core/features/eventPublisher/index.ts`
|
|
59
|
+
**Description:** Base class for all domain events.
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
**Name:** `EventPublisher`
|
|
63
|
+
**Import:** `import { EventPublisher } from "webiny/api"`
|
|
64
|
+
**Source:** `@webiny/api-core/features/eventPublisher/index.ts`
|
|
65
|
+
**Description:** Publish domain events to registered handlers.
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
**Name:** `GlobalKeyValueStore`
|
|
69
|
+
**Import:** `import { GlobalKeyValueStore } from "webiny/api"`
|
|
70
|
+
**Source:** `@webiny/api-core/features/keyValueStore/index.ts`
|
|
71
|
+
**Description:** Global (non-tenant-scoped) key-value store.
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
**Name:** `KeyValueStore`
|
|
75
|
+
**Import:** `import { KeyValueStore } from "webiny/api"`
|
|
76
|
+
**Source:** `@webiny/api-core/features/keyValueStore/index.ts`
|
|
77
|
+
**Description:** Tenant-scoped key-value store.
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
**Name:** `Logger`
|
|
81
|
+
**Import:** `import { Logger } from "webiny/api"`
|
|
82
|
+
**Source:** `@webiny/api-core/features/logger/index.ts`
|
|
83
|
+
**Description:** Structured logging with multiple log levels.
|
|
84
|
+
|
|
33
85
|
---
|
|
34
86
|
**Name:** `Result`
|
|
35
87
|
**Import:** `import { Result } from "webiny/api"`
|
|
@@ -38,3 +90,8 @@ description: >
|
|
|
38
90
|
Inspired by functional programming constructs like `Either` or `Result` in other languages.
|
|
39
91
|
|
|
40
92
|
---
|
|
93
|
+
**Name:** `Route`
|
|
94
|
+
**Import:** `import { Route } from "webiny/api"`
|
|
95
|
+
**Source:** `@webiny/handler/abstractions/Route.ts`
|
|
96
|
+
|
|
97
|
+
---
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: webiny-api-cms-catalog
|
|
3
3
|
context: webiny-api
|
|
4
4
|
description: >
|
|
5
|
-
API — Headless CMS —
|
|
5
|
+
API — Headless CMS — 124 abstractions.
|
|
6
6
|
Entry, model, and group event handlers and use cases.
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -26,6 +26,66 @@ Entry, model, and group event handlers and use cases.
|
|
|
26
26
|
**Source:** `@webiny/api-headless-cms/types/types.ts`
|
|
27
27
|
**Description:** A content entry definition for and from the database.
|
|
28
28
|
|
|
29
|
+
---
|
|
30
|
+
**Name:** `CmsEntryOpenSearchBodyModifier`
|
|
31
|
+
**Import:** `import { CmsEntryOpenSearchBodyModifier } from "webiny/api/cms/opensearch"`
|
|
32
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchBodyModifier/index.ts`
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
**Name:** `CmsEntryOpenSearchFieldIndex`
|
|
36
|
+
**Import:** `import { CmsEntryOpenSearchFieldIndex } from "webiny/api/cms/opensearch"`
|
|
37
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchFieldIndex/index.ts`
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
**Name:** `CmsEntryOpenSearchFieldIndexRegistry`
|
|
41
|
+
**Import:** `import { CmsEntryOpenSearchFieldIndexRegistry } from "webiny/api/cms/opensearch"`
|
|
42
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchFieldIndex/index.ts`
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
**Name:** `CmsEntryOpenSearchFilter`
|
|
46
|
+
**Import:** `import { CmsEntryOpenSearchFilter } from "webiny/api/cms/opensearch"`
|
|
47
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchFilter/index.ts`
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
**Name:** `CmsEntryOpenSearchFilterRegistry`
|
|
51
|
+
**Import:** `import { CmsEntryOpenSearchFilterRegistry } from "webiny/api/cms/opensearch"`
|
|
52
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchFilter/index.ts`
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
**Name:** `CmsEntryOpenSearchFullTextSearch`
|
|
56
|
+
**Import:** `import { CmsEntryOpenSearchFullTextSearch } from "webiny/api/cms/opensearch"`
|
|
57
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchFullTextSearch/index.ts`
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
**Name:** `CmsEntryOpenSearchIndex`
|
|
61
|
+
**Import:** `import { CmsEntryOpenSearchIndex } from "webiny/api/cms/opensearch"`
|
|
62
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchIndex/index.ts`
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
**Name:** `CmsEntryOpenSearchQueryModifier`
|
|
66
|
+
**Import:** `import { CmsEntryOpenSearchQueryModifier } from "webiny/api/cms/opensearch"`
|
|
67
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchQueryModifier/index.ts`
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
**Name:** `CmsEntryOpenSearchSortModifier`
|
|
71
|
+
**Import:** `import { CmsEntryOpenSearchSortModifier } from "webiny/api/cms/opensearch"`
|
|
72
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchSortModifier/index.ts`
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
**Name:** `CmsEntryOpenSearchValueSearch`
|
|
76
|
+
**Import:** `import { CmsEntryOpenSearchValueSearch } from "webiny/api/cms/opensearch"`
|
|
77
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchValueSearch/index.ts`
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
**Name:** `CmsEntryOpenSearchValueSearchRegistry`
|
|
81
|
+
**Import:** `import { CmsEntryOpenSearchValueSearchRegistry } from "webiny/api/cms/opensearch"`
|
|
82
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchValueSearch/index.ts`
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
**Name:** `CmsEntryOpenSearchValuesModifier`
|
|
86
|
+
**Import:** `import { CmsEntryOpenSearchValuesModifier } from "webiny/api/cms/opensearch"`
|
|
87
|
+
**Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchValuesModifier/index.ts`
|
|
88
|
+
|
|
29
89
|
---
|
|
30
90
|
**Name:** `CmsEntryValues`
|
|
31
91
|
**Kind:** type
|
|
@@ -33,6 +93,11 @@ Entry, model, and group event handlers and use cases.
|
|
|
33
93
|
**Source:** `@webiny/api-headless-cms/types/types.ts`
|
|
34
94
|
**Description:** A content entry values definition for and from the database.
|
|
35
95
|
|
|
96
|
+
---
|
|
97
|
+
**Name:** `CmsGraphQLSchemaSorter`
|
|
98
|
+
**Import:** `import { CmsGraphQLSchemaSorter } from "webiny/api/cms/graphql"`
|
|
99
|
+
**Source:** `@webiny/api-headless-cms/features/graphql/index.ts`
|
|
100
|
+
|
|
36
101
|
---
|
|
37
102
|
**Name:** `CmsGroup`
|
|
38
103
|
**Kind:** type
|
|
@@ -54,6 +119,36 @@ Entry, model, and group event handlers and use cases.
|
|
|
54
119
|
**Source:** `@webiny/api-headless-cms/types/modelField.ts`
|
|
55
120
|
**Description:** A definition for content model field. This type exists on the app side as well.
|
|
56
121
|
|
|
122
|
+
---
|
|
123
|
+
**Name:** `CmsModelFieldPatternValidator`
|
|
124
|
+
**Import:** `import { CmsModelFieldPatternValidator } from "webiny/api/cms/validation"`
|
|
125
|
+
**Source:** `@webiny/api-headless-cms/features/validation/abstractions/CmsModelFieldPatternValidator.ts`
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
**Name:** `CmsModelFieldPatternValidatorRegistry`
|
|
129
|
+
**Import:** `import { CmsModelFieldPatternValidatorRegistry } from "webiny/api/cms/validation"`
|
|
130
|
+
**Source:** `@webiny/api-headless-cms/features/validation/abstractions/CmsModelFieldPatternValidatorRegistry.ts`
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
**Name:** `CmsModelFieldToGraphQL`
|
|
134
|
+
**Import:** `import { CmsModelFieldToGraphQL } from "webiny/api/cms/graphql"`
|
|
135
|
+
**Source:** `@webiny/api-headless-cms/features/graphql/index.ts`
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
**Name:** `CmsModelFieldToGraphQLRegistry`
|
|
139
|
+
**Import:** `import { CmsModelFieldToGraphQLRegistry } from "webiny/api/cms/graphql"`
|
|
140
|
+
**Source:** `@webiny/api-headless-cms/features/graphql/index.ts`
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
**Name:** `CmsModelFieldValidator`
|
|
144
|
+
**Import:** `import { CmsModelFieldValidator } from "webiny/api/cms/validation"`
|
|
145
|
+
**Source:** `@webiny/api-headless-cms/features/validation/abstractions/CmsModelFieldValidator.ts`
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
**Name:** `CmsModelFieldValidatorRegistry`
|
|
149
|
+
**Import:** `import { CmsModelFieldValidatorRegistry } from "webiny/api/cms/validation"`
|
|
150
|
+
**Source:** `@webiny/api-headless-cms/features/validation/abstractions/CmsModelFieldValidatorRegistry.ts`
|
|
151
|
+
|
|
57
152
|
---
|
|
58
153
|
**Name:** `CmsModelGroup`
|
|
59
154
|
**Kind:** type
|
|
@@ -607,6 +702,21 @@ Call .private() or .public() to get the appropriate typed builder.
|
|
|
607
702
|
**Source:** `@webiny/api-headless-cms-scheduler/features/ScheduleUnpublishEntryUseCase/abstractions.ts`
|
|
608
703
|
**Description:** Schedule an entry for future unpublishing.
|
|
609
704
|
|
|
705
|
+
---
|
|
706
|
+
**Name:** `StorageOperationsFactory`
|
|
707
|
+
**Import:** `import { StorageOperationsFactory } from "webiny/api/cms/storage"`
|
|
708
|
+
**Source:** `@webiny/api-headless-cms/features/shared/abstractions.ts`
|
|
709
|
+
|
|
710
|
+
---
|
|
711
|
+
**Name:** `StorageTransform`
|
|
712
|
+
**Import:** `import { StorageTransform } from "webiny/api/cms/storage"`
|
|
713
|
+
**Source:** `@webiny/api-headless-cms/features/storage/abstractions/StorageTransform.ts`
|
|
714
|
+
|
|
715
|
+
---
|
|
716
|
+
**Name:** `StorageTransformRegistry`
|
|
717
|
+
**Import:** `import { StorageTransformRegistry } from "webiny/api/cms/storage"`
|
|
718
|
+
**Source:** `@webiny/api-headless-cms/features/storage/abstractions/StorageTransformRegistry.ts`
|
|
719
|
+
|
|
610
720
|
---
|
|
611
721
|
**Name:** `UnpublishEntryUseCase`
|
|
612
722
|
**Import:** `import { UnpublishEntryUseCase } from "webiny/api/cms/entry"`
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-db-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
api/db — 3 abstractions.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# api/db
|
|
9
|
+
|
|
10
|
+
## How to Use
|
|
11
|
+
|
|
12
|
+
1. Find the abstraction you need below
|
|
13
|
+
2. You MUST 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:** `FilterUtil`
|
|
21
|
+
**Import:** `import { FilterUtil } from "webiny/api/db"`
|
|
22
|
+
**Source:** `@webiny/db-dynamodb/feature/FilterUtil/index.ts`
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
**Name:** `ValueFilter`
|
|
26
|
+
**Import:** `import { ValueFilter } from "webiny/api/db"`
|
|
27
|
+
**Source:** `@webiny/db-dynamodb/feature/ValueFilter/index.ts`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
**Name:** `ValueFilterRegistry`
|
|
31
|
+
**Import:** `import { ValueFilterRegistry } from "webiny/api/db"`
|
|
32
|
+
**Source:** `@webiny/db-dynamodb/feature/ValueFilter/index.ts`
|
|
33
|
+
|
|
34
|
+
---
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: webiny-api-languages-catalog
|
|
3
|
+
context: webiny-api
|
|
4
|
+
description: >
|
|
5
|
+
api/languages — 2 abstractions.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# api/languages
|
|
9
|
+
|
|
10
|
+
## How to Use
|
|
11
|
+
|
|
12
|
+
1. Find the abstraction you need below
|
|
13
|
+
2. You MUST 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:** `GetLanguageByCodeUseCase`
|
|
21
|
+
**Import:** `import { GetLanguageByCodeUseCase } from "webiny/api/languages"`
|
|
22
|
+
**Source:** `@webiny/languages/api/features/GetLanguageByCode/index.ts`
|
|
23
|
+
**Description:** Get a language entry by its code.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
**Name:** `ListLanguagesUseCase`
|
|
27
|
+
**Import:** `import { ListLanguagesUseCase } from "webiny/api/languages"`
|
|
28
|
+
**Source:** `@webiny/languages/api/features/ListLanguages/index.ts`
|
|
29
|
+
**Description:** List all language entries.
|
|
30
|
+
|
|
31
|
+
---
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: webiny-api-security-catalog
|
|
3
3
|
context: webiny-api
|
|
4
4
|
description: >
|
|
5
|
-
API — Security & Auth —
|
|
5
|
+
API — Security & Auth — 53 abstractions.
|
|
6
6
|
Authentication, API keys, roles, users, teams event handlers and use cases.
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -103,6 +103,21 @@ Authentication, API keys, roles, users, teams event handlers and use cases.
|
|
|
103
103
|
**Source:** `@webiny/api-core/features/security/apiKeys/CreateApiKey/index.ts`
|
|
104
104
|
**Description:** Create a new API key.
|
|
105
105
|
|
|
106
|
+
---
|
|
107
|
+
**Name:** `createPermissionsAbstraction`
|
|
108
|
+
**Import:** `import { createPermissionsAbstraction } from "webiny/api/security"`
|
|
109
|
+
**Source:** `@webiny/api-core/features/security/permissions/index.ts`
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
**Name:** `createPermissionSchema`
|
|
113
|
+
**Import:** `import { createPermissionSchema } from "webiny/api/security"`
|
|
114
|
+
**Source:** `@webiny/api-core/features/security/permissions/index.ts`
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
**Name:** `createPermissionsFeature`
|
|
118
|
+
**Import:** `import { createPermissionsFeature } from "webiny/api/security"`
|
|
119
|
+
**Source:** `@webiny/api-core/features/security/permissions/index.ts`
|
|
120
|
+
|
|
106
121
|
---
|
|
107
122
|
**Name:** `CreateRoleUseCase`
|
|
108
123
|
**Import:** `import { CreateRoleUseCase } from "webiny/api/security/role"`
|
|
@@ -212,6 +227,16 @@ Provides a common interface for identity checks across the codebase.
|
|
|
212
227
|
**Source:** `@webiny/api-core/idp/index.ts`
|
|
213
228
|
**Description:** OIDC-compliant identity provider with issuer validation.
|
|
214
229
|
|
|
230
|
+
---
|
|
231
|
+
**Name:** `Permissions`
|
|
232
|
+
**Kind:** type
|
|
233
|
+
**Import:** `import type { Permissions } from "webiny/api/security"`
|
|
234
|
+
**Source:** `@webiny/api-core/features/security/permissions/index.ts`
|
|
235
|
+
**Description:** Typed permissions interface for a given schema.
|
|
236
|
+
|
|
237
|
+
When the schema has literal entity types, methods are narrowed to only accept valid entity IDs.
|
|
238
|
+
When the schema is dynamically typed, all methods accept `string`.
|
|
239
|
+
|
|
215
240
|
---
|
|
216
241
|
**Name:** `RoleAfterCreateEventHandler`
|
|
217
242
|
**Import:** `import { RoleAfterCreateEventHandler } from "webiny/api/security/role"`
|
|
@@ -170,7 +170,7 @@ During `yarn webiny watch api`:
|
|
|
170
170
|
- Use `Logger` (DI-injected) for production logging to CloudWatch
|
|
171
171
|
|
|
172
172
|
```typescript
|
|
173
|
-
import { Logger } from "webiny/api
|
|
173
|
+
import { Logger } from "webiny/api";
|
|
174
174
|
|
|
175
175
|
// In your extension class
|
|
176
176
|
this.logger.info("Processing request...");
|