strapi-plugin-magic-mark 3.4.0 β†’ 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/CHANGELOG.md +373 -0
  2. package/README.md +393 -618
  3. package/dist/admin/App-BIc-2qv8.mjs +580 -0
  4. package/dist/admin/App-DxALpMK_.js +580 -0
  5. package/dist/admin/PinnedBookmarksWidget-BWiAKlnA.mjs +55 -0
  6. package/dist/admin/PinnedBookmarksWidget-VM6buexr.js +55 -0
  7. package/dist/admin/de-BF0nCjGF.mjs +183 -0
  8. package/dist/admin/de-Cn90CcnC.js +183 -0
  9. package/dist/admin/en-D-EGHodf.mjs +183 -0
  10. package/dist/admin/en-GDfO_EfL.js +183 -0
  11. package/dist/admin/es-6o-_RABX.js +183 -0
  12. package/dist/admin/es-C33BufuB.mjs +183 -0
  13. package/dist/admin/fr-BOZS5mJT.js +183 -0
  14. package/dist/admin/fr-DJHTjkmb.mjs +183 -0
  15. package/dist/admin/index-BJ8l6K7P.mjs +1861 -0
  16. package/dist/admin/index-C9FMo0F_.js +1862 -0
  17. package/dist/admin/index.js +4 -2
  18. package/dist/admin/index.mjs +2 -1
  19. package/dist/admin/pt-D13SxuK2.js +183 -0
  20. package/dist/admin/pt-yoB1jrsq.mjs +183 -0
  21. package/dist/server/index.js +1129 -1542
  22. package/dist/server/index.mjs +1126 -1539
  23. package/package.json +90 -54
  24. package/strapi-admin.js +5 -0
  25. package/strapi-server.js +2 -1
  26. package/COPYRIGHT_NOTICE.txt +0 -20
  27. package/dist/_chunks/App-DNyxeldt.js +0 -1451
  28. package/dist/_chunks/App-D_Vllkur.mjs +0 -1449
  29. package/dist/_chunks/UpgradePage-DuyIskve.mjs +0 -351
  30. package/dist/_chunks/UpgradePage-SzlmS6po.js +0 -353
  31. package/dist/_chunks/de-Cs9dd3Mr.js +0 -138
  32. package/dist/_chunks/de-DOVki5VS.mjs +0 -138
  33. package/dist/_chunks/en-CE3r46Y2.js +0 -138
  34. package/dist/_chunks/en-Cf5-O03L.mjs +0 -138
  35. package/dist/_chunks/es-Ba6JcPIm.mjs +0 -138
  36. package/dist/_chunks/es-D4AOyJYJ.js +0 -138
  37. package/dist/_chunks/fr-CWSfoA8i.js +0 -138
  38. package/dist/_chunks/fr-CrMBXR3c.mjs +0 -138
  39. package/dist/_chunks/index-CBwb0AEf.js +0 -3618
  40. package/dist/_chunks/index-JirQF8zE.mjs +0 -328
  41. package/dist/_chunks/index-QkINaIgJ.mjs +0 -3614
  42. package/dist/_chunks/index-uUErgmi9.js +0 -330
  43. package/dist/_chunks/pt-BXxZ1Zym.mjs +0 -138
  44. package/dist/_chunks/pt-DW_6r_mP.js +0 -138
  45. package/pics/advancedFilters.png +0 -0
  46. package/pics/dashboard.png +0 -0
  47. package/pics/quickaccesinContentmanager.png +0 -0
  48. package/pics/saveAsMagicMark.png +0 -0
package/README.md CHANGED
@@ -1,656 +1,431 @@
1
- # MagicMark - Advanced Query Builder for Strapi v5 πŸ”–
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/Schero94/Magicmark/main/docs/site/img/icon.svg" alt="Magic Mark icon" width="96" height="96" />
3
+ </p>
2
4
 
3
- **Save and apply complex Content Manager queries with one click.** Professional bookmark management with role-based sharing, advanced filtering, and drag-and-drop organization for Strapi v5.
5
+ # Magic Mark
4
6
 
5
- [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
6
- [![npm version](https://badge.fury.io/js/strapi-plugin-magic-mark.svg)](https://www.npmjs.com/package/strapi-plugin-magic-mark)
7
- [![GitHub release](https://img.shields.io/github/v/release/Schero94/Magicmark.svg)](https://github.com/Schero94/Magicmark/releases)
7
+ **Saved views for the Strapi 5 Content Manager.** Filter a list once, save it as a bookmark and
8
+ get back to exactly that list with one click. Share bookmarks with roles or single admin users,
9
+ pin your favourites to the Strapi homepage, and build filters the native filter bar cannot
10
+ express ("any condition", "is one of", "is between", relation and component fields).
8
11
 
9
- ---
12
+ Free and open source under the MIT license. No license key, no limits, no telemetry and no calls
13
+ to external servers.
10
14
 
11
- ## πŸ“Έ Screenshots
15
+ [![npm version](https://img.shields.io/npm/v/strapi-plugin-magic-mark.svg)](https://www.npmjs.com/package/strapi-plugin-magic-mark)
16
+ [![npm downloads](https://img.shields.io/npm/dm/strapi-plugin-magic-mark.svg)](https://www.npmjs.com/package/strapi-plugin-magic-mark)
17
+ [![Test & Verify](https://github.com/Schero94/Magicmark/actions/workflows/test.yml/badge.svg)](https://github.com/Schero94/Magicmark/actions/workflows/test.yml)
18
+ [![Strapi 5.57+](https://img.shields.io/badge/Strapi-5.57%2B-4945ff.svg)](#compatibility)
19
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
12
20
 
13
- ### MagicMark Dashboard
14
- Professional interface for managing query bookmarks with statistics and easy access.
21
+ Website: [schero94.github.io/Magicmark](https://schero94.github.io/Magicmark/) Β·
22
+ npm: [strapi-plugin-magic-mark](https://www.npmjs.com/package/strapi-plugin-magic-mark) Β·
23
+ Issues: [github.com/Schero94/Magicmark/issues](https://github.com/Schero94/Magicmark/issues)
15
24
 
16
- ![MagicMark Dashboard](pics/dashboard.png)
25
+ ![The Bookmarks popover next to View settings in the Content Manager list view](https://raw.githubusercontent.com/Schero94/Magicmark/main/pics/list-view-bookmarks.png)
17
26
 
18
- ### Save as MagicMark
19
- Create bookmarks with emoji, name, description, and sharing options directly from Content Manager.
20
-
21
- ![Save Bookmark](pics/saveAsMagicMark.png)
22
-
23
- ### Advanced Filter Builder
24
- Build complex queries with the advanced filter modal for precise content filtering.
25
-
26
- ![Advanced Filters](pics/advancedFilters.png)
27
-
28
- ### Quick Access in Content Manager
29
- Seamless integration - MagicMark button right in the Content Manager toolbar for instant bookmark access.
30
-
31
- ![Quick Access](pics/quickaccesinContentmanager.png)
32
-
33
- ---
34
-
35
- ## πŸ“‹ Table of Contents
27
+ ## Contents
36
28
 
29
+ - [Why Magic Mark](#why-magic-mark)
37
30
  - [Features](#features)
38
- - [Quick Start](#quick-start)
39
- - [How It Works](#how-it-works)
40
- - [Screenshots in Action](#screenshots-in-action)
41
- - [API Routes](#api-routes)
31
+ - [Quick start (1 minute)](#quick-start-1-minute)
32
+ - [Screenshots](#screenshots)
33
+ - [How it works](#how-it-works)
42
34
  - [Configuration](#configuration)
43
- - [Use Cases](#use-cases)
44
- - [Testing](#testing)
35
+ - [Permissions](#permissions)
36
+ - [Examples](#examples)
37
+ - [Admin API](#admin-api)
38
+ - [Security and privacy](#security-and-privacy)
39
+ - [Performance](#performance)
40
+ - [Running several instances (Railway replicas, pm2 cluster)](#running-several-instances-railway-replicas-pm2-cluster)
41
+ - [Compatibility](#compatibility)
42
+ - [Upgrading from 3.x](#upgrading-from-3x)
45
43
  - [Troubleshooting](#troubleshooting)
46
- - [Development](#development)
47
-
48
- ---
49
-
50
- ## ✨ Features
51
-
52
- ### Core Bookmark Management
53
- βœ… **Query Bookmarks** - Save complex Content Manager filters, sorts, and pagination
54
- βœ… **One-Click Apply** - Instantly restore entire query states
55
- βœ… **Emoji Identification** - Visual icons for quick bookmark recognition
56
- βœ… **Pin to Top** - Keep frequently used bookmarks always accessible
57
- βœ… **Drag & Drop** - Reorder bookmarks effortlessly
58
- βœ… **Mobile Optimized** - Fully responsive design
59
-
60
- ### Advanced Sharing
61
- βœ… **Role-Based Sharing** - Share with specific admin roles
62
- βœ… **User Sharing** - Share with individual admin users
63
- βœ… **Public Bookmarks** - Make bookmarks visible to all users
64
- βœ… **Permission Control** - Fine-grained access management
65
-
66
- ### User Experience
67
- βœ… **Quick Access** - Bookmark button in Content Manager toolbar
68
- βœ… **Filter Preview** - See exactly what's saved in each bookmark
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
44
+ - [FAQ](#faq)
45
+ - [Development and tests](#development-and-tests)
46
+ - [Contributing and support](#contributing-and-support)
47
+ - [License](#license)
48
+
49
+ ## Why Magic Mark
50
+
51
+ Editors open the same lists every day: drafts waiting for review, articles without an SEO title,
52
+ products of one category in one locale. In plain Strapi they rebuild those filters by hand or keep
53
+ long admin URLs in their browser bookmarks. Those break when the admin URL changes, and nobody can
54
+ share them by role.
55
+
56
+ Magic Mark stores the list view itself (content type, filters, sort order, page size, search text
57
+ and locale) inside Strapi, right next to the list it belongs to. Role permissions decide who may
58
+ read, create, edit, share or tidy up bookmarks, and the server checks every one of them.
59
+
60
+ ## Features
61
+
62
+ - **Save view** in the list view toolbar keeps the content type, filters, sort order, page size,
63
+ search text and locale of the list you are looking at.
64
+ - **One click to open.** A bookmark opens its list without a page reload. The Content Manager's
65
+ remembered settings for that content type are replaced, so old filters never mix in.
66
+ - **Sharing.** Keep a bookmark private, share it with roles and single admin users, or with all
67
+ admins. Recipients can open, pin and duplicate it; only the owner or a manager can change it.
68
+ - **Pins per user.** Pinned bookmarks come first in the toolbar and in the "Pinned bookmarks"
69
+ widget on the Strapi homepage. Pinning a shared bookmark changes only your own list.
70
+ - **Advanced filters** add "all conditions" or "any condition", the operators "is one of", "is
71
+ none of" and "is between", and fields of relations and non-repeatable components. "All
72
+ conditions" filters show up as native filter tags.
73
+ - **Keep views current.** "Update with current view" saves the list you are looking at into an
74
+ existing bookmark; its name and sharing stay.
75
+ - **Magic Mark page** with search, scope (created by me, shared with me, pinned, all shared),
76
+ content type filter, sorting and pagination. Row actions: pin, open, edit, duplicate, copy
77
+ link, delete.
78
+ - **Six role permissions**, checked on the server for every request.
79
+ - **Strapi-native UI.** Built only from Strapi Design System components, with light and dark
80
+ mode, layouts from 1440 px down to 320 px, full keyboard access and five languages (English,
81
+ German, French, Spanish, Portuguese).
82
+ - **Safe with several Strapi processes** on one database, tested with 8 processes on Postgres
83
+ (see [Running several instances](#running-several-instances-railway-replicas-pm2-cluster)).
84
+
85
+ ## Quick start (1 minute)
86
+
87
+ 1. Install the package in your Strapi 5 project:
88
+
89
+ ```bash
90
+ npm install strapi-plugin-magic-mark
91
+ # or
92
+ yarn add strapi-plugin-magic-mark
93
+ # or
94
+ pnpm add strapi-plugin-magic-mark
95
+ ```
96
+
97
+ 2. Rebuild the admin panel and start Strapi:
98
+
99
+ ```bash
100
+ npm run build
101
+ npm run develop
102
+ ```
103
+
104
+ Strapi enables installed plugins by itself. If your `config/plugins` file lists plugins
105
+ explicitly, add `'magic-mark': { enabled: true }`.
106
+
107
+ 3. Open any collection type in the Content Manager, set a filter, open **Bookmarks** next to
108
+ **View settings** and choose **Save view**. Give it a name and save.
109
+
110
+ Super Admins have every Magic Mark permission. For other roles, turn on what they need under
111
+ **Settings > Roles > (role) > Plugins > Magic Mark** (see [Permissions](#permissions)).
112
+
113
+ ## Screenshots
114
+
115
+ All screenshots use synthetic data on an isolated Strapi 5.61 host.
116
+
117
+ | Bookmarks in the list view | Advanced filters |
118
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
119
+ | ![Bookmarks popover next to View settings in the Content Manager list view](https://raw.githubusercontent.com/Schero94/Magicmark/main/pics/list-view-bookmarks.png) | ![Advanced filters dialog with two conditions](https://raw.githubusercontent.com/Schero94/Magicmark/main/pics/advanced-filters.png) |
120
+ | **Save view as bookmark** | **Magic Mark page** |
121
+ | ![Save view dialog with the captured filters and sharing options](https://raw.githubusercontent.com/Schero94/Magicmark/main/pics/save-view.png) | ![Bookmarks page with table, search and filters](https://raw.githubusercontent.com/Schero94/Magicmark/main/pics/bookmarks.png) |
122
+ | **Dark mode** | **Homepage widget** |
123
+ | ![Bookmarks page in dark mode](https://raw.githubusercontent.com/Schero94/Magicmark/main/pics/bookmarks-dark.png) | ![Pinned bookmarks widget on the Strapi homepage](https://raw.githubusercontent.com/Schero94/Magicmark/main/pics/homepage-widget.png) |
124
+ | **Delete confirmation** | **Mobile, 390 px** |
125
+ | ![Delete bookmark confirmation dialog](https://raw.githubusercontent.com/Schero94/Magicmark/main/pics/delete-bookmark.png) | ![Bookmarks page at 390 px width](https://raw.githubusercontent.com/Schero94/Magicmark/main/pics/mobile-bookmarks.png) |
126
+
127
+ ## How it works
128
+
129
+ | Term | Meaning |
130
+ | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
131
+ | 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. |
132
+ | Owner | The admin user who created the bookmark. The owner, or someone with **Manage shared bookmarks of others**, can edit or delete it. |
133
+ | Visibility | **Only me**, **Specific roles and users** or **All admin users**. Recipients can open, pin and duplicate a bookmark, but not change it. |
134
+ | Pin | Per user. Pinning a shared bookmark changes only your own toolbar list and homepage widget. |
135
+ | Advanced filters | A filter editor for the list view with "all conditions" or "any condition", extra operators, and relation and component fields. |
136
+
137
+ Where you find it:
138
+
139
+ | Screen | Where | Who sees it |
140
+ | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
141
+ | **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) |
142
+ | **Advanced filters** button | Same toolbar | Every admin who can open the list |
143
+ | **Magic Mark** page | Main menu | Read bookmarks |
144
+ | **Pinned bookmarks** widget | Strapi homepage | Read bookmarks |
145
+
146
+ With **All conditions** the filters use the same `$and` shape as Strapi's own filters, so they
147
+ appear as filter tags and can be removed one by one. With **Any condition** the list is filtered
148
+ correctly, but Strapi does not show those conditions as tags; open Advanced filters to change or
149
+ clear them.
150
+
151
+ ## Configuration
152
+
153
+ Magic Mark has no configuration options and reads no environment variables. Access is controlled
154
+ only with role permissions.
155
+
156
+ | Setting | Where | Default |
157
+ | ------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------- |
158
+ | Turn the plugin on or off | `config/plugins.js` or `.ts`: `'magic-mark': { enabled: true }` or `false` | On once installed |
159
+ | Who may do what | Settings > Roles > Plugins > Magic Mark | Super Admin: everything. Other roles: nothing until you grant it. |
160
+
161
+ ## Permissions
162
+
163
+ | Permission (Settings > Roles > Plugins) | Action id | Allows |
164
+ | --------------------------------------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
165
+ | Read bookmarks | `plugin::magic-mark.bookmarks.read` | See and open bookmarks, pin them, the Magic Mark page and the homepage widget |
166
+ | Create bookmarks | `plugin::magic-mark.bookmarks.create` | Save views, duplicate bookmarks |
167
+ | Edit own bookmarks | `plugin::magic-mark.bookmarks.update` | Rename, describe, change the icon and update the saved view of your bookmarks |
168
+ | Delete own bookmarks | `plugin::magic-mark.bookmarks.delete` | Delete your bookmarks |
169
+ | Share bookmarks | `plugin::magic-mark.bookmarks.share` | Share with roles, single admin users or all admins, and search admin users for sharing |
170
+ | 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. |
171
+
172
+ Private bookmarks of other users stay private, also for managers and Super Admins. The user
173
+ search shows email addresses only to admins who may read admin users (`admin::users.read`).
174
+
175
+ ## Examples
176
+
177
+ **A review queue for the editor team.** Filter Articles by `stage` is `review`, sort by
178
+ `updatedAt` descending, save the view as "Waiting for review" and share it with the Editor role.
179
+ Every editor finds it in the Bookmarks menu of Articles and can pin it to the homepage.
73
180
 
74
- ### Multi-Language Support
75
- βœ… **5 Languages** - English, Deutsch, FranΓ§ais, EspaΓ±ol, PortuguΓͺs
76
- βœ… **Auto-Detection** - Follows your Strapi admin language
77
- βœ… **Complete i18n** - All UI elements translated
181
+ **A personal working set.** In Advanced filters choose **Any condition**, add "stage is one of
182
+ idea, review" and "author is anna.beispiel", apply, then save the view as a private bookmark and
183
+ pin it.
78
184
 
79
- ---
185
+ **Keep a shared bookmark up to date.** Change the filters in the list, open Bookmarks and use the
186
+ refresh icon next to the bookmark. It now stores the current view; the name and the people it is
187
+ shared with stay the same.
80
188
 
81
- ## πŸš€ Quick Start
82
-
83
- ### 1. Install Plugin
189
+ **Read bookmarks from a script.** The routes are admin routes, so they need an admin JWT, like
190
+ every Strapi admin route:
84
191
 
85
192
  ```bash
86
- npm install strapi-plugin-magic-mark
87
- # or
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
193
+ curl -s "http://localhost:1337/magic-mark/bookmarks?contentType=api::article.article&scope=pinned" \
194
+ -H "Authorization: Bearer $ADMIN_JWT"
111
195
  ```
112
196
 
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
-
145
- ```
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
-
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:
197
+ ```json
238
198
  {
239
199
  "data": [
240
200
  {
241
- "id": 1,
242
- "attributes": {
243
- "name": "Published Articles",
244
- "emoji": "πŸ“°",
245
- "description": "Recent published content",
246
- "path": "/content-manager/collection-types/api::article.article",
247
- "query": "filters[$and][0][publishedAt][$notNull]=true",
248
- "isPinned": true,
249
- "isPublic": false,
250
- "createdAt": "2024-01-15T10:30:00Z"
251
- }
201
+ "documentId": "k3l0x9q2m8v7c1b4n6z5w0aa",
202
+ "name": "Waiting for review",
203
+ "description": "",
204
+ "icon": "pencil",
205
+ "path": "/content-manager/collection-types/api::article.article",
206
+ "contentType": "api::article.article",
207
+ "query": "filters[$and][0][stage][$eq]=review&sort=updatedAt:DESC",
208
+ "visibility": "shared",
209
+ "owner": { "name": "Anna Beispiel", "isDeleted": false },
210
+ "isOwner": true,
211
+ "isPinned": true,
212
+ "canEdit": true,
213
+ "createdAt": "2026-11-07T10:00:00.000Z",
214
+ "updatedAt": "2026-11-07T10:05:00.000Z"
252
215
  }
253
216
  ],
254
- "meta": { "count": 5 }
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]
217
+ "meta": {
218
+ "pagination": { "page": 1, "pageSize": 25, "pageCount": 1, "total": 1 },
219
+ "permissions": { "canShare": true, "canManage": false }
275
220
  }
276
221
  }
277
222
  ```
278
223
 
279
- #### Update Bookmark
280
-
281
- ```bash
282
- PUT /api/magic-mark/bookmarks/:id
283
- Authorization: Bearer JWT_TOKEN
284
- ```
285
-
286
- #### Delete Bookmark
224
+ ## Admin API
225
+
226
+ All routes are admin routes under `/magic-mark`. Each one requires an authenticated admin
227
+ (`admin::isAuthenticatedAdmin`) and every listed action (`admin::hasPermissions`). Owner checks
228
+ run in the service: a bookmark you cannot see answers `404`; a bookmark you can see but may not
229
+ change answers `403`. There are no Content API routes.
230
+
231
+ | Method and path | Required actions | Notes |
232
+ | ------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
233
+ | `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` |
234
+ | `POST /bookmarks` | read, create | Body: `name`, `path`, `query`, `description`, `icon`, `visibility` (`private`, `shared`, `public`), `roles`, `users`. Anything but private also needs share. |
235
+ | `GET /bookmarks/:id` | read | Owners and managers also get the sharing lists |
236
+ | `PUT /bookmarks/:id` | read, update | Name, description, icon and sharing. Owner or manage. |
237
+ | `DELETE /bookmarks/:id` | read, delete | Owner or manage. Also removes its shares and pins. |
238
+ | `PUT /bookmarks/:id/view` | read, update | Body `{ "query": "..." }`. Replaces the saved view. |
239
+ | `POST /bookmarks/:id/duplicate` | read, create | Optional body `{ "name": "..." }`. Private copy owned by the caller. |
240
+ | `PUT /bookmarks/:id/pin` | read | Body `{ "pinned": true }`. Per user. |
241
+ | `GET /sharing/roles` | share | `documentId` and name of every role |
242
+ | `GET /sharing/users` | share | Query `q`, `page`; 20 active users per page; email only with `admin::users.read` |
243
+
244
+ Errors use Strapi's format `{ "data": null, "error": { "status", "name", "message", "details" } }`.
245
+ Invalid input answers `400 ValidationError` with field details. Request bodies are strict, so
246
+ unknown fields are rejected.
247
+
248
+ ## Security and privacy
249
+
250
+ - No license system, no outbound requests, no timers and no telemetry. On the first start the
251
+ 3.x license keys are deleted from the plugin store.
252
+ - Every route checks authentication and permissions on the server. The menu and buttons only
253
+ follow those rules; they are not the security boundary.
254
+ - `path` must be a Content Manager list view (`/content-manager/collection-types/<uid>` or
255
+ `/content-manager/single-types/<uid>`), so a shared bookmark cannot send anyone to another
256
+ admin page or off-site.
257
+ - Saved queries are parsed with `qs` with prototype keys disabled, limited in size (8192
258
+ characters), filter depth (8) and value length (1000 characters), and stored without the page
259
+ number. Only `filters`, `sort`, `pageSize`, `_q` and the i18n locale are kept.
260
+ - Request bodies are validated with strict zod schemas. Share lists are capped at 200 targets,
261
+ and every target must exist (users must be active).
262
+ - Recipients never see who else a bookmark is shared with.
263
+ - Deleting an admin user removes their pins, the shares that point at them and their private
264
+ bookmarks. Their public or shared bookmarks stay and show "Deleted user"; a manager finds them
265
+ under **All shared bookmarks**. Deleting a role removes its shares.
266
+ - Logs contain no keys, emails, ids or request bodies, only error names.
267
+
268
+ Found a security problem? Please open an issue without exploit details and ask for a private
269
+ contact.
270
+
271
+ ## Performance
272
+
273
+ - Lists are filtered, searched, sorted and paginated in the database, at most 100 rows per
274
+ request. Owner names, pins and share flags of a page load with one query each, so a page costs
275
+ the same number of queries for 10 or 100 bookmarks.
276
+ - The user search for sharing is paginated (20 per page) and runs in the database.
277
+ - The plugin keeps nothing in memory between requests and starts no timers or background jobs.
278
+
279
+ ## Running several instances (Railway replicas, pm2 cluster)
280
+
281
+ Magic Mark keeps no state in the Node.js process, so any number of Strapi processes can serve the
282
+ same database: Railway replicas, Kubernetes pods, `pm2 start --instances 4`, or all of them
283
+ together.
284
+
285
+ How writes stay correct across processes:
286
+
287
+ - Every write to an existing bookmark (edit, share, update view, pin, delete) first locks the
288
+ bookmark row with `SELECT ... FOR UPDATE` inside its transaction. Strapi's admin uses the same
289
+ pattern for the first admin user. Two share edits never interleave, two pins never create two
290
+ rows, and a request that waited for a delete answers 404 instead of leaving share or pin rows
291
+ behind. SQLite ignores `FOR UPDATE` and runs one writer at a time anyway.
292
+ - The 3.x upgrade runs in every process at start-up. Each bookmark row is claimed with a guarded
293
+ update inside a transaction, and permissions are granted per role under a row lock, so shares,
294
+ pins and permissions are written once.
295
+ - The plugin gives the Super Admin role its permissions under a row lock before Strapi's own
296
+ Super Admin sync runs, so starting several processes at once does not duplicate permission
297
+ rows. Duplicates left by an earlier simultaneous start are removed at the next start.
298
+
299
+ Tested on Strapi 5.61.0 with Postgres 16: 8 processes in two groups of four, started at the same
300
+ moment on a database with 450 bookmarks in the 3.x format, then about 1,260 parallel create,
301
+ edit, share, update view, pin, duplicate and delete requests spread over all 8 processes. Result:
302
+ no lost or duplicated bookmark, share, pin or permission rows, no orphaned share or pin rows and
303
+ no server errors. The same run against the previous code found duplicated pins and permissions,
304
+ orphaned shares and a deadlock; those are fixed.
305
+
306
+ One thing to know for upgrades that change the database schema (3.x to 4.x adds two tables):
307
+ Strapi's own schema sync is not safe to run in several processes at the same moment. In the test
308
+ above, 7 of 8 processes stopped at the first start with `relation "magic_bookmark_shares" already
309
+ exists` and came up normally when restarted, with correct data. This comes from Strapi core and
310
+ happens with any plugin or content type that adds tables. Start one instance first and scale up
311
+ once it runs, or rely on your platform's restart policy (Railway restarts crashed replicas, pm2
312
+ restarts crashed workers).
313
+
314
+ ## Compatibility
315
+
316
+ | Magic Mark | Strapi | Node.js | Notes |
317
+ | ---------- | ------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
318
+ | 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.62.0 on SQLite and Postgres 16. 3.x data and permissions migrate on the first start. |
319
+ | 3.x | 5.x | 22 | Contained the license system. No longer maintained. |
320
+
321
+ Install with npm, yarn 1 or pnpm. The plugin's peers match what a new Strapi 5 app already has:
322
+ `@strapi/strapi`, `react` 18, `react-dom` 18, `react-router-dom` 6 and `styled-components` 6 are
323
+ required peers; `@strapi/design-system`, `@strapi/icons` and `react-intl` are optional peers,
324
+ because a Strapi app gets them through `@strapi/admin`. Installing the plugin into a new Strapi
325
+ 5.61 app with npm 11, yarn 1.22 or pnpm prints no warning caused by the plugin.
326
+
327
+ ## Upgrading from 3.x
328
+
329
+ There are no manual steps. Update the package, rebuild the admin (`npm run build`) and start
330
+ Strapi. On the first start:
331
+
332
+ - Roles with the 3.x permission **Read** (`settings.read`) get **Read bookmarks**. Roles with
333
+ **Edit** (`settings.update`) get Read, Create, Edit own, Delete own and Share bookmarks. Strapi
334
+ then removes the old permissions.
335
+ - Bookmarks shared with users or roles move to the new share table. Shares to users or roles that
336
+ no longer exist are dropped. Relative 3.x paths are fixed, saved queries are cleaned like new
337
+ ones (the page number and unknown keys are removed), and the content type of each bookmark is
338
+ filled in.
339
+ - A bookmark pinned in 3.x stays pinned for its owner. Pins are per user from now on.
340
+ - The custom order (move up and down) is gone; lists are sorted by name or by last update.
341
+ - The license key and its validation date are deleted. The Upgrade and License settings pages are
342
+ gone; every feature is available to everyone. Old browser bookmarks to those settings pages
343
+ open an empty settings area, which is how Strapi treats any unknown settings path.
344
+ - The 3.x icon ids are kept and shown with Strapi icons.
345
+
346
+ Breaking changes for code that called the plugin directly: the routes `/license/*`, `/roles`,
347
+ `/users` and `/bookmarks/reorder` were removed, and the sharing lookups moved to
348
+ `/sharing/roles` and `/sharing/users`. The plugin's own admin UI was their only consumer. The
349
+ plugin now needs Strapi 5.57 or newer. Give **Manage shared bookmarks of others** to roles that
350
+ should tidy up other users' shared bookmarks. If you run several instances, read the schema note
351
+ in [Running several instances](#running-several-instances-railway-replicas-pm2-cluster) before
352
+ you deploy the upgrade.
353
+
354
+ ## Troubleshooting
355
+
356
+ | Symptom | Cause and fix |
357
+ | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
358
+ | No Magic Mark menu entry, no Bookmarks button | The role lacks **Read bookmarks**. |
359
+ | **Save view** is missing | The role lacks **Create bookmarks**. |
360
+ | No sharing options in the dialog | The role lacks **Share bookmarks**. |
361
+ | Users are listed without email | Email is shown only to admins who can read admin users. |
362
+ | Advanced filters show only some fields | The role can read only those fields of the content type in the Content Manager. |
363
+ | "This bookmark does not point to a list view" | A 3.x bookmark had an unusual path. Delete it and save the view again. |
364
+ | 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). |
365
+ | The plugin does not show up after installing | Rebuild the admin panel (`npm run build`) and restart Strapi. |
366
+
367
+ ## FAQ
368
+
369
+ **Is Magic Mark free?** Yes. The 3.x license system is gone; every feature is available to
370
+ everyone under the MIT license.
371
+
372
+ **Does the plugin send data anywhere?** No. It makes no outbound requests and has no telemetry,
373
+ not even an installation ping.
374
+
375
+ **Can I see the private bookmarks of other admins?** No, also not as Super Admin. Managers see
376
+ public and shared bookmarks of everyone under **Show > All shared bookmarks**.
377
+
378
+ **What happens to bookmarks when an admin user is deleted?** Their private bookmarks, their pins
379
+ and the shares that point at them are removed. Their public and shared bookmarks stay and show
380
+ "Deleted user" until a manager removes them.
381
+
382
+ **Does a bookmark open on the page I saved it on?** No. The page number is not saved, so a
383
+ bookmark opens on page 1 with its filters, sort, page size, search and locale.
384
+
385
+ **Are the columns of the list view saved?** No. Columns are a per-user Content Manager setting
386
+ and stay as they are.
387
+
388
+ **Why do "Any condition" filters not show as filter tags?** Strapi shows only `$and` filters as
389
+ tags. The list is still filtered correctly; open Advanced filters to change or clear them.
390
+
391
+ **Does it work with a custom admin URL?** Yes. Bookmarks store the path inside the admin, not the
392
+ full URL.
393
+
394
+ **Can I run it on several Strapi instances?** Yes, see
395
+ [Running several instances](#running-several-instances-railway-replicas-pm2-cluster).
396
+
397
+ ## Development and tests
287
398
 
288
399
  ```bash
289
- DELETE /api/magic-mark/bookmarks/:id
290
- Authorization: Bearer JWT_TOKEN
291
- ```
292
-
293
- #### Reorder Bookmarks
294
-
295
- ```bash
296
- POST /api/magic-mark/bookmarks/reorder
297
- Authorization: Bearer JWT_TOKEN
298
-
299
- Request:
300
- {
301
- "bookmarkIds": [3, 1, 5, 2, 4]
302
- }
303
- ```
304
-
305
- ---
306
-
307
- ## βš™οΈ Configuration
308
-
309
- ### Basic Setup (Default)
310
-
311
- The plugin works out of the box with zero configuration!
312
-
313
- ```typescript
314
- // src/config/plugins.ts
315
- export default () => ({
316
- 'magic-mark': {
317
- enabled: true,
318
- },
319
- });
320
- ```
321
-
322
- ### Advanced Options (Optional)
323
-
324
- ```typescript
325
- export default () => ({
326
- 'magic-mark': {
327
- enabled: true,
328
- config: {
329
- // Maximum bookmarks per user
330
- maxBookmarksPerUser: 50,
331
-
332
- // Enable query history
333
- enableHistory: true,
334
-
335
- // Auto-cleanup old queries (days)
336
- autoCleanupDays: 90,
337
- },
338
- },
339
- });
340
- ```
341
-
342
- ---
343
-
344
- ## πŸ’‘ Use Cases
345
-
346
- ### Content Management
347
-
348
- **Published Articles** πŸ“°
349
- ```
350
- Filter: publishedAt is not empty
351
- Sort: createdAt DESC
352
- Result: Quick access to all published content
353
- ```
354
-
355
- **Draft Posts** πŸ“
356
- ```
357
- Filter: publishedAt is empty AND status = "draft"
358
- Sort: updatedAt DESC
359
- Result: Focus on work in progress
360
- ```
361
-
362
- **Recent Updates** πŸ•’
363
- ```
364
- Filter: updatedAt >= 7 days ago
365
- Sort: updatedAt DESC
366
- Result: See what changed recently
367
- ```
368
-
369
- **My Content** πŸ‘€
370
- ```
371
- Filter: createdBy = current user
372
- Sort: createdAt DESC
373
- Result: See all your creations
374
- ```
375
-
376
- ### Team Collaboration
377
-
378
- **Shared Queries** πŸ‘₯
379
- - Team members access same filtered views
380
- - No need to re-apply complex filters
381
- - Everyone sees consistent data
382
-
383
- **Role-Based Access** πŸ”
384
- - Editors see different bookmarks than Authors
385
- - Managers see different views than Contributors
386
- - Automatic based on admin roles
387
-
388
- **Public Bookmarks** 🌍
389
- - Common queries for entire team
390
- - New members immediately see them
391
- - Save time explaining filters
392
-
393
- ### Power Users
394
-
395
- **Complex Filters** 🎯
396
- ```
397
- Save multi-condition queries:
398
- - Status = "approved"
399
- - Category IN ["tech", "news"]
400
- - Priority >= "high"
401
- - CreatedAt >= "2024-01-01"
402
- ```
403
-
404
- **Sorted Views** πŸ“Š
405
- ```
406
- Different sort orders for different needs:
407
- - By date (newest first)
408
- - By title (A-Z)
409
- - By popularity (most viewed)
410
- ```
411
-
412
- ---
413
-
414
- ## πŸ§ͺ Testing
415
-
416
- ### 1. Install & Setup
417
-
418
- ```bash
419
- # Install in your Strapi project
420
- npm install strapi-plugin-magic-mark
421
-
422
- # Add to config/plugins.ts
423
- # Rebuild admin
424
- 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
- npm run verify
518
- ```
519
-
520
- ### Plugin Structure
521
-
522
- ```
523
- magic-mark/
524
- β”œβ”€β”€ admin/ # React admin UI
525
- β”‚ └── src/
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
400
+ npm ci --legacy-peer-deps
401
+ npm run lint
402
+ npm run format:check
403
+ npm test
404
+ npm run test:ts:front
405
+ npm run test:ts:back
560
406
  npm run build
561
-
562
- # Verify integrity
563
407
  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
408
+ npm run verify:runtime
570
409
  ```
571
410
 
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
- ---
411
+ `npm test` runs the Node test runner over the server services (access rules, sharing, pins,
412
+ concurrent writes with row locks), validation, routes with the real `admin::hasPermissions`
413
+ policy, lifecycles and the 3.x migrations (also with 8 parallel runs), the admin filter and list
414
+ view helpers, translation completeness and package rules. CI runs every command above on Node 22
415
+ and 24, and type-checks, tests and builds once more against the lowest supported Strapi version
416
+ (5.57.0).
644
417
 
645
- ## πŸ™ Acknowledgments
418
+ ## Contributing and support
646
419
 
647
- Built for the Strapi community.
420
+ - Bugs and feature requests: [open an issue](https://github.com/Schero94/Magicmark/issues/new/choose).
421
+ - Pull requests are welcome. Run the commands from [Development and tests](#development-and-tests)
422
+ first; CI runs the same ones. Use Conventional Commits (`fix:`, `feat:`, `docs:`), because the
423
+ release version is derived from them. Screenshots must use synthetic data only.
648
424
 
649
- Special thanks to:
650
- - Strapi team for the amazing CMS
651
- - Community contributors
652
- - All users providing feedback
425
+ Releases are published to npm by semantic-release from `main`. Dependabot proposes dependency
426
+ updates weekly; patch and minor updates are merged after lint, tests, type checks, build and
427
+ verify pass, and Strapi peer majors are updated by hand. See [CHANGELOG.md](./CHANGELOG.md).
653
428
 
654
- ---
429
+ ## License
655
430
 
656
- **Made with πŸ”– by Schero D.**
431
+ [MIT](./LICENSE)