strapi-plugin-magic-mark 3.4.0 β 4.0.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/CHANGELOG.md +366 -0
- package/README.md +390 -619
- package/dist/admin/App-C9PsvW9C.mjs +580 -0
- package/dist/admin/App-KJvUCwN1.js +580 -0
- package/dist/admin/PinnedBookmarksWidget-ClskVR1i.mjs +55 -0
- package/dist/admin/PinnedBookmarksWidget-DlD8lDhq.js +55 -0
- package/dist/admin/de-BF0nCjGF.mjs +183 -0
- package/dist/admin/de-Cn90CcnC.js +183 -0
- package/dist/admin/en-D-EGHodf.mjs +183 -0
- package/dist/admin/en-GDfO_EfL.js +183 -0
- package/dist/admin/es-6o-_RABX.js +183 -0
- package/dist/admin/es-C33BufuB.mjs +183 -0
- package/dist/admin/fr-BOZS5mJT.js +183 -0
- package/dist/admin/fr-DJHTjkmb.mjs +183 -0
- package/dist/admin/index-CLjQOzqv.js +1770 -0
- package/dist/admin/index-X8I03cOT.mjs +1769 -0
- package/dist/admin/index.js +4 -2
- package/dist/admin/index.mjs +2 -1
- package/dist/admin/pt-D13SxuK2.js +183 -0
- package/dist/admin/pt-yoB1jrsq.mjs +183 -0
- package/dist/server/index.js +1129 -1542
- package/dist/server/index.mjs +1126 -1539
- package/package.json +90 -54
- package/strapi-admin.js +5 -0
- package/strapi-server.js +2 -1
- package/COPYRIGHT_NOTICE.txt +0 -20
- package/dist/_chunks/App-DNyxeldt.js +0 -1451
- package/dist/_chunks/App-D_Vllkur.mjs +0 -1449
- package/dist/_chunks/UpgradePage-DuyIskve.mjs +0 -351
- package/dist/_chunks/UpgradePage-SzlmS6po.js +0 -353
- package/dist/_chunks/de-Cs9dd3Mr.js +0 -138
- package/dist/_chunks/de-DOVki5VS.mjs +0 -138
- package/dist/_chunks/en-CE3r46Y2.js +0 -138
- package/dist/_chunks/en-Cf5-O03L.mjs +0 -138
- package/dist/_chunks/es-Ba6JcPIm.mjs +0 -138
- package/dist/_chunks/es-D4AOyJYJ.js +0 -138
- package/dist/_chunks/fr-CWSfoA8i.js +0 -138
- package/dist/_chunks/fr-CrMBXR3c.mjs +0 -138
- package/dist/_chunks/index-CBwb0AEf.js +0 -3618
- package/dist/_chunks/index-JirQF8zE.mjs +0 -328
- package/dist/_chunks/index-QkINaIgJ.mjs +0 -3614
- package/dist/_chunks/index-uUErgmi9.js +0 -330
- package/dist/_chunks/pt-BXxZ1Zym.mjs +0 -138
- package/dist/_chunks/pt-DW_6r_mP.js +0 -138
- package/pics/advancedFilters.png +0 -0
- package/pics/dashboard.png +0 -0
- package/pics/quickaccesinContentmanager.png +0 -0
- package/pics/saveAsMagicMark.png +0 -0
package/README.md
CHANGED
|
@@ -1,656 +1,427 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Magic Mark
|
|
2
2
|
|
|
3
|
-
**
|
|
3
|
+
**Saved views for the Strapi 5 Content Manager.** Filter a list once, save it as a bookmark and
|
|
4
|
+
get back to exactly that list with one click. Share bookmarks with roles or single admin users,
|
|
5
|
+
pin your favourites to the Strapi homepage, and build filters the native filter bar cannot
|
|
6
|
+
express ("any condition", "is one of", "is between", relation and component fields).
|
|
4
7
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
[](https://github.com/Schero94/Magicmark/releases)
|
|
8
|
+
Free and open source under the MIT license. No license key, no limits, no telemetry and no calls
|
|
9
|
+
to external servers.
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
[](https://www.npmjs.com/package/strapi-plugin-magic-mark)
|
|
12
|
+
[](https://www.npmjs.com/package/strapi-plugin-magic-mark)
|
|
13
|
+
[](https://github.com/Schero94/Magicmark/actions/workflows/test.yml)
|
|
14
|
+
[](#compatibility)
|
|
15
|
+
[](./LICENSE)
|
|
10
16
|
|
|
11
|
-
|
|
17
|
+
Website: [schero94.github.io/Magicmark](https://schero94.github.io/Magicmark/) Β·
|
|
18
|
+
npm: [strapi-plugin-magic-mark](https://www.npmjs.com/package/strapi-plugin-magic-mark) Β·
|
|
19
|
+
Issues: [github.com/Schero94/Magicmark/issues](https://github.com/Schero94/Magicmark/issues)
|
|
12
20
|
|
|
13
|
-
|
|
14
|
-
Professional interface for managing query bookmarks with statistics and easy access.
|
|
21
|
+

|
|
15
22
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
### Save as MagicMark
|
|
19
|
-
Create bookmarks with emoji, name, description, and sharing options directly from Content Manager.
|
|
20
|
-
|
|
21
|
-

|
|
22
|
-
|
|
23
|
-
### Advanced Filter Builder
|
|
24
|
-
Build complex queries with the advanced filter modal for precise content filtering.
|
|
25
|
-
|
|
26
|
-

|
|
27
|
-
|
|
28
|
-
### Quick Access in Content Manager
|
|
29
|
-
Seamless integration - MagicMark button right in the Content Manager toolbar for instant bookmark access.
|
|
30
|
-
|
|
31
|
-

|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
## π Table of Contents
|
|
23
|
+
## Contents
|
|
36
24
|
|
|
25
|
+
- [Why Magic Mark](#why-magic-mark)
|
|
37
26
|
- [Features](#features)
|
|
38
|
-
- [Quick
|
|
39
|
-
- [
|
|
40
|
-
- [
|
|
41
|
-
- [API Routes](#api-routes)
|
|
27
|
+
- [Quick start (1 minute)](#quick-start-1-minute)
|
|
28
|
+
- [Screenshots](#screenshots)
|
|
29
|
+
- [How it works](#how-it-works)
|
|
42
30
|
- [Configuration](#configuration)
|
|
43
|
-
- [
|
|
44
|
-
- [
|
|
31
|
+
- [Permissions](#permissions)
|
|
32
|
+
- [Examples](#examples)
|
|
33
|
+
- [Admin API](#admin-api)
|
|
34
|
+
- [Security and privacy](#security-and-privacy)
|
|
35
|
+
- [Performance](#performance)
|
|
36
|
+
- [Running several instances (Railway replicas, pm2 cluster)](#running-several-instances-railway-replicas-pm2-cluster)
|
|
37
|
+
- [Compatibility](#compatibility)
|
|
38
|
+
- [Upgrading from 3.x](#upgrading-from-3x)
|
|
45
39
|
- [Troubleshooting](#troubleshooting)
|
|
46
|
-
- [
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
40
|
+
- [FAQ](#faq)
|
|
41
|
+
- [Development and tests](#development-and-tests)
|
|
42
|
+
- [Contributing and support](#contributing-and-support)
|
|
43
|
+
- [License](#license)
|
|
44
|
+
|
|
45
|
+
## Why Magic Mark
|
|
46
|
+
|
|
47
|
+
Editors open the same lists every day: drafts waiting for review, articles without an SEO title,
|
|
48
|
+
products of one category in one locale. In plain Strapi they rebuild those filters by hand or keep
|
|
49
|
+
long admin URLs in their browser bookmarks. Those break when the admin URL changes, and nobody can
|
|
50
|
+
share them by role.
|
|
51
|
+
|
|
52
|
+
Magic Mark stores the list view itself (content type, filters, sort order, page size, search text
|
|
53
|
+
and locale) inside Strapi, right next to the list it belongs to. Role permissions decide who may
|
|
54
|
+
read, create, edit, share or tidy up bookmarks, and the server checks every one of them.
|
|
55
|
+
|
|
56
|
+
## Features
|
|
57
|
+
|
|
58
|
+
- **Save view** in the list view toolbar keeps the content type, filters, sort order, page size,
|
|
59
|
+
search text and locale of the list you are looking at.
|
|
60
|
+
- **One click to open.** A bookmark opens its list without a page reload. The Content Manager's
|
|
61
|
+
remembered settings for that content type are replaced, so old filters never mix in.
|
|
62
|
+
- **Sharing.** Keep a bookmark private, share it with roles and single admin users, or with all
|
|
63
|
+
admins. Recipients can open, pin and duplicate it; only the owner or a manager can change it.
|
|
64
|
+
- **Pins per user.** Pinned bookmarks come first in the toolbar and in the "Pinned bookmarks"
|
|
65
|
+
widget on the Strapi homepage. Pinning a shared bookmark changes only your own list.
|
|
66
|
+
- **Advanced filters** add "all conditions" or "any condition", the operators "is one of", "is
|
|
67
|
+
none of" and "is between", and fields of relations and non-repeatable components. "All
|
|
68
|
+
conditions" filters show up as native filter tags.
|
|
69
|
+
- **Keep views current.** "Update with current view" saves the list you are looking at into an
|
|
70
|
+
existing bookmark; its name and sharing stay.
|
|
71
|
+
- **Magic Mark page** with search, scope (created by me, shared with me, pinned, all shared),
|
|
72
|
+
content type filter, sorting and pagination. Row actions: pin, open, edit, duplicate, copy
|
|
73
|
+
link, delete.
|
|
74
|
+
- **Six role permissions**, checked on the server for every request.
|
|
75
|
+
- **Strapi-native UI.** Built only from Strapi Design System components, with light and dark
|
|
76
|
+
mode, layouts from 1440 px down to 320 px, full keyboard access and five languages (English,
|
|
77
|
+
German, French, Spanish, Portuguese).
|
|
78
|
+
- **Safe with several Strapi processes** on one database, tested with 8 processes on Postgres
|
|
79
|
+
(see [Running several instances](#running-several-instances-railway-replicas-pm2-cluster)).
|
|
80
|
+
|
|
81
|
+
## Quick start (1 minute)
|
|
82
|
+
|
|
83
|
+
1. Install the package in your Strapi 5 project:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
npm install strapi-plugin-magic-mark
|
|
87
|
+
# or
|
|
88
|
+
yarn add strapi-plugin-magic-mark
|
|
89
|
+
# or
|
|
90
|
+
pnpm add strapi-plugin-magic-mark
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
2. Rebuild the admin panel and start Strapi:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
npm run build
|
|
97
|
+
npm run develop
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Strapi enables installed plugins by itself. If your `config/plugins` file lists plugins
|
|
101
|
+
explicitly, add `'magic-mark': { enabled: true }`.
|
|
102
|
+
|
|
103
|
+
3. Open any collection type in the Content Manager, set a filter, open **Bookmarks** next to
|
|
104
|
+
**View settings** and choose **Save view**. Give it a name and save.
|
|
105
|
+
|
|
106
|
+
Super Admins have every Magic Mark permission. For other roles, turn on what they need under
|
|
107
|
+
**Settings > Roles > (role) > Plugins > Magic Mark** (see [Permissions](#permissions)).
|
|
108
|
+
|
|
109
|
+
## Screenshots
|
|
110
|
+
|
|
111
|
+
All screenshots use synthetic data on an isolated Strapi 5.61 host.
|
|
112
|
+
|
|
113
|
+
| Bookmarks in the list view | Advanced filters |
|
|
114
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
|
115
|
+
|  |  |
|
|
116
|
+
| **Save view as bookmark** | **Magic Mark page** |
|
|
117
|
+
|  |  |
|
|
118
|
+
| **Dark mode** | **Homepage widget** |
|
|
119
|
+
|  |  |
|
|
120
|
+
| **Delete confirmation** | **Mobile, 390 px** |
|
|
121
|
+
|  |  |
|
|
122
|
+
|
|
123
|
+
## How it works
|
|
124
|
+
|
|
125
|
+
| Term | Meaning |
|
|
126
|
+
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
127
|
+
| Bookmark | A saved Content Manager list view: content type, filters, sort order, page size, search text and locale. The page number is not saved, so a bookmark always opens on page 1. |
|
|
128
|
+
| Owner | The admin user who created the bookmark. The owner, or someone with **Manage shared bookmarks of others**, can edit or delete it. |
|
|
129
|
+
| Visibility | **Only me**, **Specific roles and users** or **All admin users**. Recipients can open, pin and duplicate a bookmark, but not change it. |
|
|
130
|
+
| Pin | Per user. Pinning a shared bookmark changes only your own toolbar list and homepage widget. |
|
|
131
|
+
| Advanced filters | A filter editor for the list view with "all conditions" or "any condition", extra operators, and relation and component fields. |
|
|
132
|
+
|
|
133
|
+
Where you find it:
|
|
134
|
+
|
|
135
|
+
| Screen | Where | Who sees it |
|
|
136
|
+
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
|
|
137
|
+
| **Bookmarks** button | Content Manager list view toolbar, next to View settings. Lists the bookmarks of this content type, pinned first. Up to 100 are listed; a link opens the rest on the Magic Mark page. **Save view** captures the current list; the refresh icon saves the current view into an existing bookmark. | Read bookmarks (saving needs Create bookmarks) |
|
|
138
|
+
| **Advanced filters** button | Same toolbar | Every admin who can open the list |
|
|
139
|
+
| **Magic Mark** page | Main menu | Read bookmarks |
|
|
140
|
+
| **Pinned bookmarks** widget | Strapi homepage | Read bookmarks |
|
|
141
|
+
|
|
142
|
+
With **All conditions** the filters use the same `$and` shape as Strapi's own filters, so they
|
|
143
|
+
appear as filter tags and can be removed one by one. With **Any condition** the list is filtered
|
|
144
|
+
correctly, but Strapi does not show those conditions as tags; open Advanced filters to change or
|
|
145
|
+
clear them.
|
|
146
|
+
|
|
147
|
+
## Configuration
|
|
148
|
+
|
|
149
|
+
Magic Mark has no configuration options and reads no environment variables. Access is controlled
|
|
150
|
+
only with role permissions.
|
|
151
|
+
|
|
152
|
+
| Setting | Where | Default |
|
|
153
|
+
| ------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
154
|
+
| Turn the plugin on or off | `config/plugins.js` or `.ts`: `'magic-mark': { enabled: true }` or `false` | On once installed |
|
|
155
|
+
| Who may do what | Settings > Roles > Plugins > Magic Mark | Super Admin: everything. Other roles: nothing until you grant it. |
|
|
156
|
+
|
|
157
|
+
## Permissions
|
|
158
|
+
|
|
159
|
+
| Permission (Settings > Roles > Plugins) | Action id | Allows |
|
|
160
|
+
| --------------------------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
161
|
+
| Read bookmarks | `plugin::magic-mark.bookmarks.read` | See and open bookmarks, pin them, the Magic Mark page and the homepage widget |
|
|
162
|
+
| Create bookmarks | `plugin::magic-mark.bookmarks.create` | Save views, duplicate bookmarks |
|
|
163
|
+
| Edit own bookmarks | `plugin::magic-mark.bookmarks.update` | Rename, describe, change the icon and update the saved view of your bookmarks |
|
|
164
|
+
| Delete own bookmarks | `plugin::magic-mark.bookmarks.delete` | Delete your bookmarks |
|
|
165
|
+
| Share bookmarks | `plugin::magic-mark.bookmarks.share` | Share with roles, single admin users or all admins, and search admin users for sharing |
|
|
166
|
+
| Manage shared bookmarks of others | `plugin::magic-mark.bookmarks.manage` | See every public or shared bookmark under **Show > All shared bookmarks**, also when you are not a recipient or the owner was deleted. Editing and deleting them also need Edit own and Delete own. |
|
|
167
|
+
|
|
168
|
+
Private bookmarks of other users stay private, also for managers and Super Admins. The user
|
|
169
|
+
search shows email addresses only to admins who may read admin users (`admin::users.read`).
|
|
170
|
+
|
|
171
|
+
## Examples
|
|
172
|
+
|
|
173
|
+
**A review queue for the editor team.** Filter Articles by `stage` is `review`, sort by
|
|
174
|
+
`updatedAt` descending, save the view as "Waiting for review" and share it with the Editor role.
|
|
175
|
+
Every editor finds it in the Bookmarks menu of Articles and can pin it to the homepage.
|
|
65
176
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
β
**Descriptions** - Add notes to remember bookmark purpose
|
|
70
|
-
β
**Context Aware** - Automatically detects current content type
|
|
71
|
-
β
**Instant Save** - Capture current query state in one click
|
|
72
|
-
β
**Professional UI** - Beautiful gradient design with smooth animations
|
|
177
|
+
**A personal working set.** In Advanced filters choose **Any condition**, add "stage is one of
|
|
178
|
+
idea, review" and "author is anna.beispiel", apply, then save the view as a private bookmark and
|
|
179
|
+
pin it.
|
|
73
180
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
β
**Complete i18n** - All UI elements translated
|
|
181
|
+
**Keep a shared bookmark up to date.** Change the filters in the list, open Bookmarks and use the
|
|
182
|
+
refresh icon next to the bookmark. It now stores the current view; the name and the people it is
|
|
183
|
+
shared with stay the same.
|
|
78
184
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
## π Quick Start
|
|
82
|
-
|
|
83
|
-
### 1. Install Plugin
|
|
185
|
+
**Read bookmarks from a script.** The routes are admin routes, so they need an admin JWT, like
|
|
186
|
+
every Strapi admin route:
|
|
84
187
|
|
|
85
188
|
```bash
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
yarn add strapi-plugin-magic-mark
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
### 2. Register in Config
|
|
92
|
-
|
|
93
|
-
Add to `src/config/plugins.ts` (or `plugins.js`):
|
|
94
|
-
|
|
95
|
-
```typescript
|
|
96
|
-
export default () => ({
|
|
97
|
-
'magic-mark': {
|
|
98
|
-
enabled: true,
|
|
99
|
-
},
|
|
100
|
-
});
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
### 3. Build & Run
|
|
104
|
-
|
|
105
|
-
```bash
|
|
106
|
-
# Rebuild admin panel
|
|
107
|
-
npm run build
|
|
108
|
-
|
|
109
|
-
# Start Strapi
|
|
110
|
-
npm run develop
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
### 4. Activate License (First Use)
|
|
114
|
-
|
|
115
|
-
- Go to Admin β **MagicMark**
|
|
116
|
-
- Click **"Activate License"**
|
|
117
|
-
- Choose: Auto-create, Manual entry, or Existing key
|
|
118
|
-
- Done! Plugin is ready
|
|
119
|
-
|
|
120
|
-
### 5. Save Your First Bookmark
|
|
121
|
-
|
|
122
|
-
1. Navigate to any Content Manager collection
|
|
123
|
-
2. Apply filters, sorting, or search
|
|
124
|
-
3. Click the **MagicMark** button in the toolbar (see screenshot above)
|
|
125
|
-
4. Click **"Save Bookmark"**
|
|
126
|
-
5. Add:
|
|
127
|
-
- Name (e.g., "Published Articles")
|
|
128
|
-
- Emoji (e.g., π°)
|
|
129
|
-
- Description (optional)
|
|
130
|
-
- Sharing settings (optional)
|
|
131
|
-
6. Click **Save**
|
|
132
|
-
|
|
133
|
-
### 6. Use Bookmarks
|
|
134
|
-
|
|
135
|
-
- Click **MagicMark** β Select bookmark β Done!
|
|
136
|
-
- All filters are instantly applied
|
|
137
|
-
- Share with team members
|
|
138
|
-
|
|
139
|
-
---
|
|
140
|
-
|
|
141
|
-
## π How It Works
|
|
142
|
-
|
|
143
|
-
### Bookmark Save Flow
|
|
144
|
-
|
|
189
|
+
curl -s "http://localhost:1337/magic-mark/bookmarks?contentType=api::article.article&scope=pinned" \
|
|
190
|
+
-H "Authorization: Bearer $ADMIN_JWT"
|
|
145
191
|
```
|
|
146
|
-
User in Content Manager
|
|
147
|
-
β
|
|
148
|
-
Applies: Filters, Sort, Search, Pagination
|
|
149
|
-
β
|
|
150
|
-
[Click MagicMark Button] (See "Quick Access" screenshot)
|
|
151
|
-
β
|
|
152
|
-
"Save Bookmark" Modal opens (See "Save as MagicMark" screenshot)
|
|
153
|
-
β
|
|
154
|
-
User enters: Name, Emoji, Description, Sharing
|
|
155
|
-
β
|
|
156
|
-
[Save]
|
|
157
|
-
β
|
|
158
|
-
Query parameters captured:
|
|
159
|
-
- Path: /content-manager/collection-types/api::article.article
|
|
160
|
-
- Query: filters[$and][0][publishedAt][$notNull]=true&sort[0]=createdAt:desc
|
|
161
|
-
- Pagination: page=1&pageSize=25
|
|
162
|
-
β
|
|
163
|
-
Bookmark stored in database
|
|
164
|
-
β
|
|
165
|
-
Success! Bookmark appears in Dashboard (See "Dashboard" screenshot)
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
### Bookmark Apply Flow
|
|
169
|
-
|
|
170
|
-
```
|
|
171
|
-
User clicks MagicMark button
|
|
172
|
-
β
|
|
173
|
-
List of available bookmarks appears
|
|
174
|
-
(filtered by user permissions)
|
|
175
|
-
β
|
|
176
|
-
[User selects bookmark]
|
|
177
|
-
β
|
|
178
|
-
Navigation to content type happens
|
|
179
|
-
β
|
|
180
|
-
Query parameters applied:
|
|
181
|
-
- Filters restored (See "Advanced Filters" screenshot)
|
|
182
|
-
- Sort order set
|
|
183
|
-
- Pagination reset
|
|
184
|
-
- Search cleared
|
|
185
|
-
β
|
|
186
|
-
Content Manager displays filtered results
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
---
|
|
190
|
-
|
|
191
|
-
## π¬ Screenshots in Action
|
|
192
|
-
|
|
193
|
-
### 1. Dashboard View
|
|
194
|
-
The main **MagicMark Dashboard** (see first screenshot above) shows:
|
|
195
|
-
- All your bookmarks with emoji icons
|
|
196
|
-
- Pinned bookmarks at the top
|
|
197
|
-
- Quick actions: Edit, Delete, Share
|
|
198
|
-
- Search and filter capabilities
|
|
199
|
-
- Beautiful gradient design
|
|
200
|
-
|
|
201
|
-
### 2. Quick Access Button
|
|
202
|
-
The **Quick Access** button (see screenshot above) is integrated directly into:
|
|
203
|
-
- Content Manager toolbar
|
|
204
|
-
- Appears on all collection pages
|
|
205
|
-
- One-click access to bookmarks
|
|
206
|
-
- Context-aware (shows relevant bookmarks)
|
|
207
|
-
|
|
208
|
-
### 3. Save Bookmark Modal
|
|
209
|
-
The **Save Bookmark Modal** (see screenshot above) includes:
|
|
210
|
-
- Name field with emoji picker
|
|
211
|
-
- Description for notes
|
|
212
|
-
- Sharing options (Roles, Users, Public)
|
|
213
|
-
- Preview of current query
|
|
214
|
-
- Visual feedback
|
|
215
|
-
|
|
216
|
-
### 4. Advanced Filters
|
|
217
|
-
The **Advanced Filter Builder** (see screenshot above) lets you:
|
|
218
|
-
- Build complex filter conditions
|
|
219
|
-
- Combine AND/OR logic
|
|
220
|
-
- Save multi-level queries
|
|
221
|
-
- Preview filter results
|
|
222
|
-
- Edit existing filters
|
|
223
192
|
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
## π‘ API Routes
|
|
227
|
-
|
|
228
|
-
### Content API Routes
|
|
229
|
-
|
|
230
|
-
All routes require valid JWT authentication (except public bookmarks).
|
|
231
|
-
|
|
232
|
-
#### Get All Bookmarks
|
|
233
|
-
|
|
234
|
-
```bash
|
|
235
|
-
GET /api/magic-mark/bookmarks
|
|
236
|
-
|
|
237
|
-
Response:
|
|
193
|
+
```json
|
|
238
194
|
{
|
|
239
195
|
"data": [
|
|
240
196
|
{
|
|
241
|
-
"
|
|
242
|
-
"
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
197
|
+
"documentId": "k3l0x9q2m8v7c1b4n6z5w0aa",
|
|
198
|
+
"name": "Waiting for review",
|
|
199
|
+
"description": "",
|
|
200
|
+
"icon": "pencil",
|
|
201
|
+
"path": "/content-manager/collection-types/api::article.article",
|
|
202
|
+
"contentType": "api::article.article",
|
|
203
|
+
"query": "filters[$and][0][stage][$eq]=review&sort=updatedAt:DESC",
|
|
204
|
+
"visibility": "shared",
|
|
205
|
+
"owner": { "name": "Anna Beispiel", "isDeleted": false },
|
|
206
|
+
"isOwner": true,
|
|
207
|
+
"isPinned": true,
|
|
208
|
+
"canEdit": true,
|
|
209
|
+
"createdAt": "2026-11-07T10:00:00.000Z",
|
|
210
|
+
"updatedAt": "2026-11-07T10:05:00.000Z"
|
|
252
211
|
}
|
|
253
212
|
],
|
|
254
|
-
"meta": {
|
|
255
|
-
}
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
#### Create Bookmark
|
|
259
|
-
|
|
260
|
-
```bash
|
|
261
|
-
POST /api/magic-mark/bookmarks
|
|
262
|
-
Authorization: Bearer JWT_TOKEN
|
|
263
|
-
|
|
264
|
-
Request:
|
|
265
|
-
{
|
|
266
|
-
"data": {
|
|
267
|
-
"name": "Draft Posts",
|
|
268
|
-
"emoji": "π",
|
|
269
|
-
"description": "Unpublished drafts",
|
|
270
|
-
"path": "/content-manager/collection-types/api::article.article",
|
|
271
|
-
"query": "filters[0][publishedAt][$null]=true",
|
|
272
|
-
"isPublic": false,
|
|
273
|
-
"sharedWithRoles": [1, 2],
|
|
274
|
-
"sharedWithUsers": [3]
|
|
213
|
+
"meta": {
|
|
214
|
+
"pagination": { "page": 1, "pageSize": 25, "pageCount": 1, "total": 1 },
|
|
215
|
+
"permissions": { "canShare": true, "canManage": false }
|
|
275
216
|
}
|
|
276
217
|
}
|
|
277
218
|
```
|
|
278
219
|
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
**
|
|
389
|
-
|
|
390
|
-
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
**
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
220
|
+
## Admin API
|
|
221
|
+
|
|
222
|
+
All routes are admin routes under `/magic-mark`. Each one requires an authenticated admin
|
|
223
|
+
(`admin::isAuthenticatedAdmin`) and every listed action (`admin::hasPermissions`). Owner checks
|
|
224
|
+
run in the service: a bookmark you cannot see answers `404`; a bookmark you can see but may not
|
|
225
|
+
change answers `403`. There are no Content API routes.
|
|
226
|
+
|
|
227
|
+
| Method and path | Required actions | Notes |
|
|
228
|
+
| ------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
229
|
+
| `GET /bookmarks` | read | Query: `page`, `pageSize` (1 to 100), `q` (name search), `scope` (`all`, `mine`, `shared`, `pinned`, `managed`), `sort` (`name:asc`, `name:desc`, `updatedAt:desc`, `updatedAt:asc`), `contentType` |
|
|
230
|
+
| `POST /bookmarks` | read, create | Body: `name`, `path`, `query`, `description`, `icon`, `visibility` (`private`, `shared`, `public`), `roles`, `users`. Anything but private also needs share. |
|
|
231
|
+
| `GET /bookmarks/:id` | read | Owners and managers also get the sharing lists |
|
|
232
|
+
| `PUT /bookmarks/:id` | read, update | Name, description, icon and sharing. Owner or manage. |
|
|
233
|
+
| `DELETE /bookmarks/:id` | read, delete | Owner or manage. Also removes its shares and pins. |
|
|
234
|
+
| `PUT /bookmarks/:id/view` | read, update | Body `{ "query": "..." }`. Replaces the saved view. |
|
|
235
|
+
| `POST /bookmarks/:id/duplicate` | read, create | Optional body `{ "name": "..." }`. Private copy owned by the caller. |
|
|
236
|
+
| `PUT /bookmarks/:id/pin` | read | Body `{ "pinned": true }`. Per user. |
|
|
237
|
+
| `GET /sharing/roles` | share | `documentId` and name of every role |
|
|
238
|
+
| `GET /sharing/users` | share | Query `q`, `page`; 20 active users per page; email only with `admin::users.read` |
|
|
239
|
+
|
|
240
|
+
Errors use Strapi's format `{ "data": null, "error": { "status", "name", "message", "details" } }`.
|
|
241
|
+
Invalid input answers `400 ValidationError` with field details. Request bodies are strict, so
|
|
242
|
+
unknown fields are rejected.
|
|
243
|
+
|
|
244
|
+
## Security and privacy
|
|
245
|
+
|
|
246
|
+
- No license system, no outbound requests, no timers and no telemetry. On the first start the
|
|
247
|
+
3.x license keys are deleted from the plugin store.
|
|
248
|
+
- Every route checks authentication and permissions on the server. The menu and buttons only
|
|
249
|
+
follow those rules; they are not the security boundary.
|
|
250
|
+
- `path` must be a Content Manager list view (`/content-manager/collection-types/<uid>` or
|
|
251
|
+
`/content-manager/single-types/<uid>`), so a shared bookmark cannot send anyone to another
|
|
252
|
+
admin page or off-site.
|
|
253
|
+
- Saved queries are parsed with `qs` with prototype keys disabled, limited in size (8192
|
|
254
|
+
characters), filter depth (8) and value length (1000 characters), and stored without the page
|
|
255
|
+
number. Only `filters`, `sort`, `pageSize`, `_q` and the i18n locale are kept.
|
|
256
|
+
- Request bodies are validated with strict zod schemas. Share lists are capped at 200 targets,
|
|
257
|
+
and every target must exist (users must be active).
|
|
258
|
+
- Recipients never see who else a bookmark is shared with.
|
|
259
|
+
- Deleting an admin user removes their pins, the shares that point at them and their private
|
|
260
|
+
bookmarks. Their public or shared bookmarks stay and show "Deleted user"; a manager finds them
|
|
261
|
+
under **All shared bookmarks**. Deleting a role removes its shares.
|
|
262
|
+
- Logs contain no keys, emails, ids or request bodies, only error names.
|
|
263
|
+
|
|
264
|
+
Found a security problem? Please open an issue without exploit details and ask for a private
|
|
265
|
+
contact.
|
|
266
|
+
|
|
267
|
+
## Performance
|
|
268
|
+
|
|
269
|
+
- Lists are filtered, searched, sorted and paginated in the database, at most 100 rows per
|
|
270
|
+
request. Owner names, pins and share flags of a page load with one query each, so a page costs
|
|
271
|
+
the same number of queries for 10 or 100 bookmarks.
|
|
272
|
+
- The user search for sharing is paginated (20 per page) and runs in the database.
|
|
273
|
+
- The plugin keeps nothing in memory between requests and starts no timers or background jobs.
|
|
274
|
+
|
|
275
|
+
## Running several instances (Railway replicas, pm2 cluster)
|
|
276
|
+
|
|
277
|
+
Magic Mark keeps no state in the Node.js process, so any number of Strapi processes can serve the
|
|
278
|
+
same database: Railway replicas, Kubernetes pods, `pm2 start --instances 4`, or all of them
|
|
279
|
+
together.
|
|
280
|
+
|
|
281
|
+
How writes stay correct across processes:
|
|
282
|
+
|
|
283
|
+
- Every write to an existing bookmark (edit, share, update view, pin, delete) first locks the
|
|
284
|
+
bookmark row with `SELECT ... FOR UPDATE` inside its transaction. Strapi's admin uses the same
|
|
285
|
+
pattern for the first admin user. Two share edits never interleave, two pins never create two
|
|
286
|
+
rows, and a request that waited for a delete answers 404 instead of leaving share or pin rows
|
|
287
|
+
behind. SQLite ignores `FOR UPDATE` and runs one writer at a time anyway.
|
|
288
|
+
- The 3.x upgrade runs in every process at start-up. Each bookmark row is claimed with a guarded
|
|
289
|
+
update inside a transaction, and permissions are granted per role under a row lock, so shares,
|
|
290
|
+
pins and permissions are written once.
|
|
291
|
+
- The plugin gives the Super Admin role its permissions under a row lock before Strapi's own
|
|
292
|
+
Super Admin sync runs, so starting several processes at once does not duplicate permission
|
|
293
|
+
rows. Duplicates left by an earlier simultaneous start are removed at the next start.
|
|
294
|
+
|
|
295
|
+
Tested on Strapi 5.61.0 with Postgres 16: 8 processes in two groups of four, started at the same
|
|
296
|
+
moment on a database with 450 bookmarks in the 3.x format, then about 1,260 parallel create,
|
|
297
|
+
edit, share, update view, pin, duplicate and delete requests spread over all 8 processes. Result:
|
|
298
|
+
no lost or duplicated bookmark, share, pin or permission rows, no orphaned share or pin rows and
|
|
299
|
+
no server errors. The same run against the previous code found duplicated pins and permissions,
|
|
300
|
+
orphaned shares and a deadlock; those are fixed.
|
|
301
|
+
|
|
302
|
+
One thing to know for upgrades that change the database schema (3.x to 4.x adds two tables):
|
|
303
|
+
Strapi's own schema sync is not safe to run in several processes at the same moment. In the test
|
|
304
|
+
above, 7 of 8 processes stopped at the first start with `relation "magic_bookmark_shares" already
|
|
305
|
+
exists` and came up normally when restarted, with correct data. This comes from Strapi core and
|
|
306
|
+
happens with any plugin or content type that adds tables. Start one instance first and scale up
|
|
307
|
+
once it runs, or rely on your platform's restart policy (Railway restarts crashed replicas, pm2
|
|
308
|
+
restarts crashed workers).
|
|
309
|
+
|
|
310
|
+
## Compatibility
|
|
311
|
+
|
|
312
|
+
| Magic Mark | Strapi | Node.js | Notes |
|
|
313
|
+
| ---------- | ------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
314
|
+
| 4.x | 5.57.0 or newer 5.x | 22.22.2 or newer 22.x, 24.15.0 or newer | Free. Acceptance host: Strapi 5.61.0 on SQLite and Postgres 16. 3.x data and permissions migrate on the first start. |
|
|
315
|
+
| 3.x | 5.x | 22 | Contained the license system. No longer maintained. |
|
|
316
|
+
|
|
317
|
+
Install with npm, yarn 1 or pnpm. The plugin's peers match what a new Strapi 5 app already has:
|
|
318
|
+
`@strapi/strapi`, `react` 18, `react-dom` 18, `react-router-dom` 6 and `styled-components` 6 are
|
|
319
|
+
required peers; `@strapi/design-system`, `@strapi/icons` and `react-intl` are optional peers,
|
|
320
|
+
because a Strapi app gets them through `@strapi/admin`. Installing the plugin into a new Strapi
|
|
321
|
+
5.61 app with npm 11, yarn 1.22 or pnpm prints no warning caused by the plugin.
|
|
322
|
+
|
|
323
|
+
## Upgrading from 3.x
|
|
324
|
+
|
|
325
|
+
There are no manual steps. Update the package, rebuild the admin (`npm run build`) and start
|
|
326
|
+
Strapi. On the first start:
|
|
327
|
+
|
|
328
|
+
- Roles with the 3.x permission **Read** (`settings.read`) get **Read bookmarks**. Roles with
|
|
329
|
+
**Edit** (`settings.update`) get Read, Create, Edit own, Delete own and Share bookmarks. Strapi
|
|
330
|
+
then removes the old permissions.
|
|
331
|
+
- Bookmarks shared with users or roles move to the new share table. Shares to users or roles that
|
|
332
|
+
no longer exist are dropped. Relative 3.x paths are fixed, saved queries are cleaned like new
|
|
333
|
+
ones (the page number and unknown keys are removed), and the content type of each bookmark is
|
|
334
|
+
filled in.
|
|
335
|
+
- A bookmark pinned in 3.x stays pinned for its owner. Pins are per user from now on.
|
|
336
|
+
- The custom order (move up and down) is gone; lists are sorted by name or by last update.
|
|
337
|
+
- The license key and its validation date are deleted. The Upgrade and License settings pages are
|
|
338
|
+
gone; every feature is available to everyone. Old browser bookmarks to those settings pages
|
|
339
|
+
open an empty settings area, which is how Strapi treats any unknown settings path.
|
|
340
|
+
- The 3.x icon ids are kept and shown with Strapi icons.
|
|
341
|
+
|
|
342
|
+
Breaking changes for code that called the plugin directly: the routes `/license/*`, `/roles`,
|
|
343
|
+
`/users` and `/bookmarks/reorder` were removed, and the sharing lookups moved to
|
|
344
|
+
`/sharing/roles` and `/sharing/users`. The plugin's own admin UI was their only consumer. The
|
|
345
|
+
plugin now needs Strapi 5.57 or newer. Give **Manage shared bookmarks of others** to roles that
|
|
346
|
+
should tidy up other users' shared bookmarks. If you run several instances, read the schema note
|
|
347
|
+
in [Running several instances](#running-several-instances-railway-replicas-pm2-cluster) before
|
|
348
|
+
you deploy the upgrade.
|
|
349
|
+
|
|
350
|
+
## Troubleshooting
|
|
351
|
+
|
|
352
|
+
| Symptom | Cause and fix |
|
|
353
|
+
| ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
354
|
+
| No Magic Mark menu entry, no Bookmarks button | The role lacks **Read bookmarks**. |
|
|
355
|
+
| **Save view** is missing | The role lacks **Create bookmarks**. |
|
|
356
|
+
| No sharing options in the dialog | The role lacks **Share bookmarks**. |
|
|
357
|
+
| Users are listed without email | Email is shown only to admins who can read admin users. |
|
|
358
|
+
| Advanced filters show only some fields | The role can read only those fields of the content type in the Content Manager. |
|
|
359
|
+
| "This bookmark does not point to a list view" | A 3.x bookmark had an unusual path. Delete it and save the view again. |
|
|
360
|
+
| After an upgrade with several instances, some processes stopped with "already exists" | Strapi's schema sync ran in several processes at once. Restart them; see [Running several instances](#running-several-instances-railway-replicas-pm2-cluster). |
|
|
361
|
+
| The plugin does not show up after installing | Rebuild the admin panel (`npm run build`) and restart Strapi. |
|
|
362
|
+
|
|
363
|
+
## FAQ
|
|
364
|
+
|
|
365
|
+
**Is Magic Mark free?** Yes. The 3.x license system is gone; every feature is available to
|
|
366
|
+
everyone under the MIT license.
|
|
367
|
+
|
|
368
|
+
**Does the plugin send data anywhere?** No. It makes no outbound requests and has no telemetry,
|
|
369
|
+
not even an installation ping.
|
|
370
|
+
|
|
371
|
+
**Can I see the private bookmarks of other admins?** No, also not as Super Admin. Managers see
|
|
372
|
+
public and shared bookmarks of everyone under **Show > All shared bookmarks**.
|
|
373
|
+
|
|
374
|
+
**What happens to bookmarks when an admin user is deleted?** Their private bookmarks, their pins
|
|
375
|
+
and the shares that point at them are removed. Their public and shared bookmarks stay and show
|
|
376
|
+
"Deleted user" until a manager removes them.
|
|
377
|
+
|
|
378
|
+
**Does a bookmark open on the page I saved it on?** No. The page number is not saved, so a
|
|
379
|
+
bookmark opens on page 1 with its filters, sort, page size, search and locale.
|
|
380
|
+
|
|
381
|
+
**Are the columns of the list view saved?** No. Columns are a per-user Content Manager setting
|
|
382
|
+
and stay as they are.
|
|
383
|
+
|
|
384
|
+
**Why do "Any condition" filters not show as filter tags?** Strapi shows only `$and` filters as
|
|
385
|
+
tags. The list is still filtered correctly; open Advanced filters to change or clear them.
|
|
386
|
+
|
|
387
|
+
**Does it work with a custom admin URL?** Yes. Bookmarks store the path inside the admin, not the
|
|
388
|
+
full URL.
|
|
389
|
+
|
|
390
|
+
**Can I run it on several Strapi instances?** Yes, see
|
|
391
|
+
[Running several instances](#running-several-instances-railway-replicas-pm2-cluster).
|
|
392
|
+
|
|
393
|
+
## Development and tests
|
|
417
394
|
|
|
418
395
|
```bash
|
|
419
|
-
|
|
420
|
-
npm
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
396
|
+
npm ci --legacy-peer-deps
|
|
397
|
+
npm run lint
|
|
398
|
+
npm run format:check
|
|
399
|
+
npm test
|
|
400
|
+
npm run test:ts:front
|
|
401
|
+
npm run test:ts:back
|
|
424
402
|
npm run build
|
|
425
|
-
```
|
|
426
|
-
|
|
427
|
-
### 2. Test Basic Bookmark
|
|
428
|
-
|
|
429
|
-
1. Go to Content Manager β Any collection
|
|
430
|
-
2. Apply some filters
|
|
431
|
-
3. Click **MagicMark** button (see screenshot)
|
|
432
|
-
4. Save with name "Test Bookmark" and emoji π§ͺ
|
|
433
|
-
5. Verify it appears in dashboard
|
|
434
|
-
|
|
435
|
-
### 3. Test Bookmark Apply
|
|
436
|
-
|
|
437
|
-
1. Clear all filters
|
|
438
|
-
2. Click **MagicMark** β Select "Test Bookmark"
|
|
439
|
-
3. Verify filters are restored correctly
|
|
440
|
-
|
|
441
|
-
### 4. Test Sharing
|
|
442
|
-
|
|
443
|
-
1. Create bookmark
|
|
444
|
-
2. Share with specific role
|
|
445
|
-
3. Login as user with that role
|
|
446
|
-
4. Verify bookmark is visible
|
|
447
|
-
|
|
448
|
-
### 5. Test Advanced Filters
|
|
449
|
-
|
|
450
|
-
1. Use **Advanced Filter Builder** (see screenshot)
|
|
451
|
-
2. Create complex multi-condition filter
|
|
452
|
-
3. Save as bookmark
|
|
453
|
-
4. Apply and verify all conditions work
|
|
454
|
-
|
|
455
|
-
---
|
|
456
|
-
|
|
457
|
-
## π Troubleshooting
|
|
458
|
-
|
|
459
|
-
### MagicMark Button Not Appearing
|
|
460
|
-
|
|
461
|
-
**Problem:** No MagicMark button in Content Manager toolbar (see screenshot for where it should be).
|
|
462
|
-
|
|
463
|
-
**Solutions:**
|
|
464
|
-
1. Rebuild admin: `npm run build`
|
|
465
|
-
2. Clear browser cache (Cmd+Shift+R / Ctrl+Shift+R)
|
|
466
|
-
3. Check plugin is enabled in config
|
|
467
|
-
4. Check browser console for errors (F12)
|
|
468
|
-
|
|
469
|
-
### Bookmarks Not Saving
|
|
470
|
-
|
|
471
|
-
**Problem:** Click "Save Bookmark" but bookmark doesn't appear in dashboard.
|
|
472
|
-
|
|
473
|
-
**Solutions:**
|
|
474
|
-
1. Check Strapi logs for errors
|
|
475
|
-
2. Verify license is activated
|
|
476
|
-
3. Check database is writable
|
|
477
|
-
4. Try creating simpler bookmark first
|
|
478
|
-
|
|
479
|
-
### Bookmarks Not Applying
|
|
480
|
-
|
|
481
|
-
**Problem:** Select bookmark but filters don't apply.
|
|
482
|
-
|
|
483
|
-
**Solutions:**
|
|
484
|
-
1. Refresh page and try again
|
|
485
|
-
2. Check Content Manager path matches bookmark
|
|
486
|
-
3. Try creating new bookmark
|
|
487
|
-
4. Clear browser localStorage
|
|
488
|
-
|
|
489
|
-
### Advanced Filters Not Working
|
|
490
|
-
|
|
491
|
-
**Problem:** Complex filters from advanced builder don't apply correctly.
|
|
492
|
-
|
|
493
|
-
**Solutions:**
|
|
494
|
-
1. Check filter syntax in bookmark
|
|
495
|
-
2. Try simpler filter first
|
|
496
|
-
3. Verify content type supports the filters
|
|
497
|
-
4. Check browser console for errors
|
|
498
|
-
|
|
499
|
-
---
|
|
500
|
-
|
|
501
|
-
## π οΈ Development
|
|
502
|
-
|
|
503
|
-
### Local Development
|
|
504
|
-
|
|
505
|
-
```bash
|
|
506
|
-
# Watch mode - rebuilds on file changes
|
|
507
|
-
npm run watch
|
|
508
|
-
|
|
509
|
-
# Link to local Strapi
|
|
510
|
-
npm run watch:link
|
|
511
|
-
|
|
512
|
-
# Type checking
|
|
513
|
-
npm run test:ts:front # Frontend TypeScript
|
|
514
|
-
npm run test:ts:back # Backend TypeScript
|
|
515
|
-
|
|
516
|
-
# Verify plugin
|
|
517
403
|
npm run verify
|
|
404
|
+
npm run verify:runtime
|
|
518
405
|
```
|
|
519
406
|
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
β βββ components/
|
|
527
|
-
β β βββ BookmarkList.tsx
|
|
528
|
-
β β βββ SaveBookmarkModal.tsx
|
|
529
|
-
β β βββ BookmarkCard.tsx
|
|
530
|
-
β β βββ AdvancedFilterBuilder.tsx
|
|
531
|
-
β βββ pages/
|
|
532
|
-
β β βββ App.tsx
|
|
533
|
-
β β βββ HomePage.tsx (Dashboard - see screenshot)
|
|
534
|
-
β β βββ LicensePage.tsx
|
|
535
|
-
β βββ hooks/
|
|
536
|
-
β βββ translations/ # i18n (5 languages)
|
|
537
|
-
β βββ index.ts
|
|
538
|
-
βββ server/ # Backend (TypeScript)
|
|
539
|
-
β βββ src/
|
|
540
|
-
β βββ bootstrap.ts
|
|
541
|
-
β βββ controllers/
|
|
542
|
-
β βββ services/
|
|
543
|
-
β βββ routes/
|
|
544
|
-
β βββ content-types/
|
|
545
|
-
βββ pics/ # Screenshots
|
|
546
|
-
β βββ dashboard.png
|
|
547
|
-
β βββ saveAsMagicMark.png
|
|
548
|
-
β βββ advancedFilters.png
|
|
549
|
-
β βββ quickaccesinContentmanager.png
|
|
550
|
-
βββ .github/workflows/ # CI/CD
|
|
551
|
-
βββ package.json
|
|
552
|
-
βββ .releaserc.json
|
|
553
|
-
βββ README.md
|
|
554
|
-
```
|
|
555
|
-
|
|
556
|
-
### Build & Release
|
|
557
|
-
|
|
558
|
-
```bash
|
|
559
|
-
# Build plugin
|
|
560
|
-
npm run build
|
|
561
|
-
|
|
562
|
-
# Verify integrity
|
|
563
|
-
npm run verify
|
|
564
|
-
|
|
565
|
-
# Release (automatic via GitHub Actions)
|
|
566
|
-
# Just use semantic commits:
|
|
567
|
-
git commit -m "feat: add new feature" # β MINOR version
|
|
568
|
-
git commit -m "fix: fix bug" # β PATCH version
|
|
569
|
-
git commit -m "feat!: breaking change" # β MAJOR version
|
|
570
|
-
```
|
|
571
|
-
|
|
572
|
-
---
|
|
573
|
-
|
|
574
|
-
## π¦ NPM Release Process
|
|
575
|
-
|
|
576
|
-
This plugin uses **semantic-release** for automated versioning.
|
|
577
|
-
|
|
578
|
-
### Commit Message Format
|
|
579
|
-
|
|
580
|
-
```bash
|
|
581
|
-
# PATCH version (bug fix)
|
|
582
|
-
git commit -m "fix: correct bookmark save"
|
|
583
|
-
|
|
584
|
-
# MINOR version (new feature)
|
|
585
|
-
git commit -m "feat: add bookmark export"
|
|
586
|
-
|
|
587
|
-
# MAJOR version (breaking change)
|
|
588
|
-
git commit -m "feat!: change API format"
|
|
589
|
-
```
|
|
590
|
-
|
|
591
|
-
### Automatic Release
|
|
592
|
-
|
|
593
|
-
GitHub Actions automatically:
|
|
594
|
-
- Analyzes commits
|
|
595
|
-
- Bumps version
|
|
596
|
-
- Updates CHANGELOG
|
|
597
|
-
- Publishes to NPM
|
|
598
|
-
- Creates GitHub release
|
|
599
|
-
|
|
600
|
-
---
|
|
601
|
-
|
|
602
|
-
## π€ Contributing
|
|
603
|
-
|
|
604
|
-
Contributions are welcome!
|
|
605
|
-
|
|
606
|
-
1. Fork: https://github.com/Schero94/Magicmark
|
|
607
|
-
2. Create branch: `git checkout -b feature/amazing`
|
|
608
|
-
3. Commit: `git commit -m "feat: add amazing feature"`
|
|
609
|
-
4. Push: `git push origin feature/amazing`
|
|
610
|
-
5. Open Pull Request
|
|
611
|
-
|
|
612
|
-
---
|
|
613
|
-
|
|
614
|
-
## π Resources
|
|
615
|
-
|
|
616
|
-
- **NPM Package:** https://www.npmjs.com/package/strapi-plugin-magic-mark
|
|
617
|
-
- **GitHub:** https://github.com/Schero94/Magicmark
|
|
618
|
-
- **Issues:** https://github.com/Schero94/Magicmark/issues
|
|
619
|
-
- **Changelog:** [CHANGELOG.md](./CHANGELOG.md)
|
|
620
|
-
|
|
621
|
-
---
|
|
622
|
-
|
|
623
|
-
## π License
|
|
624
|
-
|
|
625
|
-
**MIT License** - Free for personal & commercial use
|
|
626
|
-
|
|
627
|
-
**Copyright (c) 2025 Schero D.**
|
|
628
|
-
|
|
629
|
-
See [LICENSE](./LICENSE) for full terms
|
|
630
|
-
|
|
631
|
-
---
|
|
632
|
-
|
|
633
|
-
## π Supported Languages
|
|
634
|
-
|
|
635
|
-
- π¬π§ **English** - Global standard
|
|
636
|
-
- π©πͺ **Deutsch** - German (DACH region)
|
|
637
|
-
- π«π· **FranΓ§ais** - French
|
|
638
|
-
- πͺπΈ **EspaΓ±ol** - Spanish (Spain & Latin America)
|
|
639
|
-
- π΅πΉ **PortuguΓͺs** - Portuguese (Brazil & Portugal)
|
|
640
|
-
|
|
641
|
-
Language automatically follows your Strapi admin interface setting.
|
|
642
|
-
|
|
643
|
-
---
|
|
407
|
+
`npm test` runs the Node test runner over the server services (access rules, sharing, pins,
|
|
408
|
+
concurrent writes with row locks), validation, routes with the real `admin::hasPermissions`
|
|
409
|
+
policy, lifecycles and the 3.x migrations (also with 8 parallel runs), the admin filter and list
|
|
410
|
+
view helpers, translation completeness and package rules. CI runs every command above on Node 22
|
|
411
|
+
and 24, and type-checks, tests and builds once more against the lowest supported Strapi version
|
|
412
|
+
(5.57.0).
|
|
644
413
|
|
|
645
|
-
##
|
|
414
|
+
## Contributing and support
|
|
646
415
|
|
|
647
|
-
|
|
416
|
+
- Bugs and feature requests: [open an issue](https://github.com/Schero94/Magicmark/issues/new/choose).
|
|
417
|
+
- Pull requests are welcome. Run the commands from [Development and tests](#development-and-tests)
|
|
418
|
+
first; CI runs the same ones. Use Conventional Commits (`fix:`, `feat:`, `docs:`), because the
|
|
419
|
+
release version is derived from them. Screenshots must use synthetic data only.
|
|
648
420
|
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
- All users providing feedback
|
|
421
|
+
Releases are published to npm by semantic-release from `main`. Dependabot proposes dependency
|
|
422
|
+
updates weekly; patch and minor updates are merged after lint, tests, type checks, build and
|
|
423
|
+
verify pass, and Strapi peer majors are updated by hand. See [CHANGELOG.md](./CHANGELOG.md).
|
|
653
424
|
|
|
654
|
-
|
|
425
|
+
## License
|
|
655
426
|
|
|
656
|
-
|
|
427
|
+
[MIT](./LICENSE)
|