strapi-plugin-magic-mark 1.3.1 → 3.0.0

package/dist/server/src/content-types/index.d.ts

@@ -59,6 +59,16 @@ declare const _default: {
                     type: string;
                     configurable: boolean;
                 };
+                creatorId: {
+                    type: string;
+                    configurable: boolean;
+                    description: string;
+                };
+                updaterId: {
+                    type: string;
+                    configurable: boolean;
+                    description: string;
+                };
                 sharedWithRoles: {
                     type: string;
                     configurable: boolean;

package/dist/server/src/controllers/controller.d.ts

@@ -1,11 +1,49 @@
+/**
+ * Bookmark Controller
+ * Handles HTTP requests for bookmark management
+ *
+ * Uses Document Service API (Strapi v5 Best Practice)
+ */
 declare const _default: ({ strapi }: any) => {
+    /**
+     * Get all bookmarks for current user
+     * GET /magic-mark/bookmarks
+     */
     getAll(ctx: any): Promise<any>;
+    /**
+     * Create a new bookmark
+     * POST /magic-mark/bookmarks
+     */
     create(ctx: any): Promise<any>;
+    /**
+     * Update an existing bookmark
+     * PUT /magic-mark/bookmarks/:id
+     */
     update(ctx: any): Promise<any>;
+    /**
+     * Delete a bookmark
+     * DELETE /magic-mark/bookmarks/:id
+     */
     delete(ctx: any): Promise<any>;
+    /**
+     * Pin or unpin a bookmark
+     * PUT /magic-mark/bookmarks/:id/pin
+     */
     pin(ctx: any): Promise<any>;
+    /**
+     * Reorder bookmarks
+     * PUT /magic-mark/bookmarks/reorder
+     */
     reorder(ctx: any): Promise<any>;
+    /**
+     * Get all admin roles for sharing
+     * GET /magic-mark/roles
+     */
     getRoles(ctx: any): Promise<any>;
+    /**
+     * Get all admin users for sharing
+     * GET /magic-mark/users
+     */
     getUsers(ctx: any): Promise<any>;
 };
 export default _default;

package/dist/server/src/index.d.ts

@@ -53,29 +53,17 @@ declare const _default: {
         bookmarks: ({ strapi }: {
             strapi: import("@strapi/types/dist/core").Strapi;
         }) => {
-            findAll(userId: number): Promise<any>;
-            create(name: string, path: string, query: string, emoji: string, description: string, userId: number, sharedWithRoles?: number[], sharedWithUsers?: number[], isPublic?: boolean): Promise<{
-                id: import("@strapi/types/dist/data").ID;
-            } & {
-                [key: string]: any;
-            }>;
-            update(id: string | number, data: any, userId: number): Promise<{
-                id: import("@strapi/types/dist/data").ID;
-            } & {
-                [key: string]: any;
+            findAll(userId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument[]>;
+            create(name: string, path: string, query: string, emoji: string, description: string, userId: string, sharedWithRoles?: string[], sharedWithUsers?: string[], isPublic?: boolean): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+            update(documentId: string, data: any, userId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+            delete(documentId: string): Promise<{
+                documentId: string;
+                entries: import("@strapi/types/dist/modules/documents").AnyDocument[];
             }>;
-            delete(id: string | number): Promise<{
-                id: import("@strapi/types/dist/data").ID;
-            } & {
-                [key: string]: any;
-            }>;
-            pin(id: string | number, isPinned: boolean, userId: number): Promise<{
-                id: import("@strapi/types/dist/data").ID;
-            } & {
-                [key: string]: any;
-            }>;
-            reorder(bookmarkIds: (string | number)[], userId: number): Promise<({
-                id: import("@strapi/types/dist/data").ID;
+            pin(documentId: string, isPinned: boolean, userId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+            reorder(bookmarkIds: string[], userId: string): Promise<({
+                documentId: string;
+                id: number;
             } & {
                 [key: string]: any;
             })[]>;
@@ -165,6 +153,16 @@ declare const _default: {
                         type: string;
                         configurable: boolean;
                     };
+                    creatorId: {
+                        type: string;
+                        configurable: boolean;
+                        description: string;
+                    };
+                    updaterId: {
+                        type: string;
+                        configurable: boolean;
+                        description: string;
+                    };
                     sharedWithRoles: {
                         type: string;
                         configurable: boolean;

package/dist/server/src/services/index.d.ts

@@ -3,29 +3,17 @@ declare const _default: {
     bookmarks: ({ strapi }: {
         strapi: import("@strapi/types/dist/core").Strapi;
     }) => {
-        findAll(userId: number): Promise<any>;
-        create(name: string, path: string, query: string, emoji: string, description: string, userId: number, sharedWithRoles?: number[], sharedWithUsers?: number[], isPublic?: boolean): Promise<{
-            id: import("@strapi/types/dist/data").ID;
-        } & {
-            [key: string]: any;
-        }>;
-        update(id: string | number, data: any, userId: number): Promise<{
-            id: import("@strapi/types/dist/data").ID;
-        } & {
-            [key: string]: any;
-        }>;
-        delete(id: string | number): Promise<{
-            id: import("@strapi/types/dist/data").ID;
-        } & {
-            [key: string]: any;
-        }>;
-        pin(id: string | number, isPinned: boolean, userId: number): Promise<{
-            id: import("@strapi/types/dist/data").ID;
-        } & {
-            [key: string]: any;
+        findAll(userId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument[]>;
+        create(name: string, path: string, query: string, emoji: string, description: string, userId: string, sharedWithRoles?: string[], sharedWithUsers?: string[], isPublic?: boolean): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+        update(documentId: string, data: any, userId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+        delete(documentId: string): Promise<{
+            documentId: string;
+            entries: import("@strapi/types/dist/modules/documents").AnyDocument[];
         }>;
-        reorder(bookmarkIds: (string | number)[], userId: number): Promise<({
-            id: import("@strapi/types/dist/data").ID;
+        pin(documentId: string, isPinned: boolean, userId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+        reorder(bookmarkIds: string[], userId: string): Promise<({
+            documentId: string;
+            id: number;
         } & {
             [key: string]: any;
         })[]>;

package/dist/server/src/services/service.d.ts

@@ -1,33 +1,78 @@
 import type { Core } from '@strapi/strapi';
+/**
+ * Bookmark Service
+ * Handles all bookmark-related database operations
+ *
+ * Uses Document Service API (Strapi v5 Best Practice)
+ *
+ * NOTE: We store creatorId/updaterId as strings (documentId) instead of relations
+ * to avoid permission issues with admin::user content-type.
+ */
 declare const bookmarkService: ({ strapi }: {
     strapi: Core.Strapi;
 }) => {
-    findAll(userId: number): Promise<any>;
-    create(name: string, path: string, query: string, emoji: string, description: string, userId: number, sharedWithRoles?: number[], sharedWithUsers?: number[], isPublic?: boolean): Promise<{
-        id: import("@strapi/types/dist/data").ID;
-    } & {
-        [key: string]: any;
-    }>;
-    update(id: string | number, data: any, userId: number): Promise<{
-        id: import("@strapi/types/dist/data").ID;
-    } & {
-        [key: string]: any;
-    }>;
-    delete(id: string | number): Promise<{
-        id: import("@strapi/types/dist/data").ID;
-    } & {
-        [key: string]: any;
-    }>;
-    pin(id: string | number, isPinned: boolean, userId: number): Promise<{
-        id: import("@strapi/types/dist/data").ID;
-    } & {
-        [key: string]: any;
+    /**
+     * Find all bookmarks accessible to a user
+     * @param userId - The admin user's documentId
+     * @returns Array of accessible bookmarks
+     */
+    findAll(userId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument[]>;
+    /**
+     * Create a new bookmark
+     * @param name - Bookmark name
+     * @param path - URL path
+     * @param query - Query string
+     * @param emoji - Emoji icon
+     * @param description - Description
+     * @param userId - Creator's documentId
+     * @param sharedWithRoles - Array of role documentIds
+     * @param sharedWithUsers - Array of user documentIds
+     * @param isPublic - Public visibility
+     * @returns Created bookmark
+     */
+    create(name: string, path: string, query: string, emoji: string, description: string, userId: string, sharedWithRoles?: string[], sharedWithUsers?: string[], isPublic?: boolean): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+    /**
+     * Update an existing bookmark
+     * @param documentId - Bookmark's documentId
+     * @param data - Update data
+     * @param userId - Editor's documentId
+     * @returns Updated bookmark
+     */
+    update(documentId: string, data: any, userId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+    /**
+     * Delete a bookmark
+     * @param documentId - Bookmark's documentId
+     * @returns Deleted bookmark
+     */
+    delete(documentId: string): Promise<{
+        documentId: string;
+        entries: import("@strapi/types/dist/modules/documents").AnyDocument[];
     }>;
-    reorder(bookmarkIds: (string | number)[], userId: number): Promise<({
-        id: import("@strapi/types/dist/data").ID;
+    /**
+     * Pin or unpin a bookmark
+     * @param documentId - Bookmark's documentId
+     * @param isPinned - Pin status
+     * @param userId - Editor's documentId
+     * @returns Updated bookmark
+     */
+    pin(documentId: string, isPinned: boolean, userId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+    /**
+     * Reorder bookmarks
+     * @param bookmarkIds - Array of bookmark documentIds in new order
+     * @param userId - Editor's documentId
+     * @returns Updated bookmarks
+     */
+    reorder(bookmarkIds: string[], userId: string): Promise<({
+        documentId: string;
+        id: number;
     } & {
         [key: string]: any;
     })[]>;
+    /**
+     * Validate URL format
+     * @param url - URL to validate
+     * @returns True if valid
+     */
     validateUrl(url: string): boolean;
 };
 export default bookmarkService;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.1",
+  "version": "3.0.0",
   "keywords": [
     "strapi",
     "strapi-plugin",
@@ -100,10 +100,10 @@
   "author": "Schero D.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/fame361/Magicmark.git"
+    "url": "https://github.com/Schero94/Magicmark.git"
   },
   "bugs": {
-    "url": "https://github.com/fame361/Magicmark/issues"
+    "url": "https://github.com/Schero94/Magicmark/issues"
   },
-  "homepage": "https://github.com/fame361/Magicmark#readme"
+  "homepage": "https://github.com/Schero94/Magicmark#readme"
 }