feat: change permissions names

apps/contrast-plugin/src/assets/manifest.json

@@ -3,5 +3,5 @@
   "description": "Measure contrast plugin",
   "code": "/assets/plugin.js",
   "icon": "/assets/icon.png",
-  "permissions": ["page:read", "file:read", "selection:read"]
+  "permissions": [ "content:read" ]
 }

apps/create-palette-plugin/public/assets/manifest.json

@@ -4,8 +4,8 @@
   "code": "/plugin.js",
   "icon": "/assets/icon.png",
   "permissions": [
-    "page:read",
-    "file:read",
-    "selection:read"
+    "content:read",
+    "content:write",
+    "library:read"
   ]
 }

apps/icons-plugin/src/assets/manifest.json

@@ -3,5 +3,8 @@
   "code": "/assets/plugin.js",
   "icon": "/assets/icon.png",
   "description": "Create icons from the Feather Icons set",
-  "permissions": ["page:read", "file:read", "selection:read"]
+  "permissions": [
+    "content:read",
+    "content:write"
+  ]
 }

apps/lorem-ipsum-plugin/src/assets/manifest.json

@@ -3,5 +3,8 @@
   "description": "Lorem ipsum text generator plugin",
   "code": "/assets/plugin.js",
   "icon": "/assets/icon.png",
-  "permissions": ["page:read", "file:read", "selection:read"]
+  "permissions": [
+    "content:read",
+    "content:write"
+  ]
 }

apps/poc-state-plugin/src/assets/manifest.json

@@ -3,8 +3,10 @@
   "description": "Sandbox plugin for plugins development",
   "code": "/assets/plugin.js",
   "permissions": [
-    "page:read",
-    "file:read",
-    "selection:read"
+    "content:read",
+    "content:write",
+    "library:read",
+    "library:write",
+    "user:read"
   ]
 }

apps/rename-layers-plugin/src/assets/manifest.json

@@ -3,5 +3,8 @@
   "description": "Change the name of one or several layers",
   "code": "/assets/plugin.js",
   "icon": "/assets/icon.png",
-  "permissions": ["page:read", "file:read", "selection:read"]
+  "permissions": [
+    "content:read",
+    "content:write"
+  ]
 }

apps/table-plugin/src/assets/manifest.json

@@ -3,5 +3,8 @@
   "description": "Table plugin to import or create tables",
   "code": "/assets/plugin.js",
   "icon": "/assets/icon.png",
-  "permissions": ["page:read", "file:read", "selection:read"]
+  "permissions": [
+    "content:read",
+    "content:write"
+  ]
 }

docs/create-angular-plugin.md

@@ -26,7 +26,13 @@ Next, create a `manifest.json` file inside the `/src/assets` directory. This fil
   "host": "http://localhost:4200",
   "code": "/assets/plugin.js",
   "icon": "/assets/icon.png",
-  "permissions": ["page:read", "file:read", "selection:read"]
+  "permissions": [
+    "content:read",
+    "content:write",
+    "library:read",
+    "library:write",
+    "user:read"
+  ]
 }
 ```
 

docs/create-plugin.md

@@ -26,7 +26,13 @@ Next, create a `manifest.json` file inside the `/public` directory. This file is
   "host": "http://localhost:4201",
   "code": "/plugin.js",
   "icon": "/icon.png",
-  "permissions": ["page:read", "file:read", "selection:read"]
+  "permissions": [
+    "content:read",
+    "content:write",
+    "library:read",
+    "library:write",
+    "user:read"
+  ]
 }
 ```
 

libs/plugins-runtime/src/lib/api/index.ts

@@ -48,8 +48,12 @@ let modals = new Set<PluginModalElement>([]);
 const eventListeners: Map<string, Callback<unknown>[]> = new Map();
 
 window.addEventListener('message', (event) => {
-  for (const callback of uiMessagesCallbacks) {
-    callback(event.data);
+  try {
+    for (const callback of uiMessagesCallbacks) {
+      callback(event.data);
+    }
+  } catch (err) {
+    console.error(err);
   }
 });
 
@@ -168,13 +172,8 @@ export function createApi(context: PenpotContext, manifest: Manifest): Penpot {
       z.enum(validEvents).parse(type);
       z.function().parse(callback);
 
-      if (type === 'pagechange') {
-        checkPermission('page:read');
-      } else if (type === 'filechange') {
-        checkPermission('file:read');
-      } else if (type === 'selectionchange') {
-        checkPermission('selection:read');
-      }
+      // To suscribe to events needs the read permission
+      checkPermission('content:read');
 
       const listeners = eventListeners.get(type) || [];
       listeners.push(callback as Callback<unknown>);
@@ -199,69 +198,68 @@ export function createApi(context: PenpotContext, manifest: Manifest): Penpot {
     // Penpot State API
 
     get root(): PenpotShape {
-      checkPermission('page:read');
+      checkPermission('content:read');
       return context.root;
     },
 
     get currentPage(): PenpotPage {
-      checkPermission('page:read');
+      checkPermission('content:read');
       return context.currentPage;
     },
 
     get selection(): PenpotShape[] {
-      checkPermission('selection:read');
+      checkPermission('content:read');
       return context.selection;
     },
 
     get viewport(): PenpotViewport {
-      // checkPermission('viewport:read');
       return context.viewport;
     },
 
     get library(): PenpotLibraryContext {
-      // checkPermission('library:read');
+      checkPermission('library:read');
       return context.library;
     },
 
     get fonts(): PenpotFontsContext {
-      // checkPermission('viewport:read');
+      checkPermission('content:read');
       return context.fonts;
     },
 
     get currentUser(): PenpotUser {
-      // checkPermission('user:read');
+      checkPermission('user:read');
       return context.currentUser;
     },
 
     get activeUsers(): PenpotActiveUser {
-      // checkPermission('activeUsers:read');
+      checkPermission('user:read');
       return context.activeUsers;
     },
 
     getFile(): PenpotFile | null {
-      checkPermission('file:read');
+      checkPermission('content:read');
       return context.getFile();
     },
 
     getPage(): PenpotPage | null {
-      checkPermission('page:read');
+      checkPermission('content:read');
       return context.getPage();
     },
 
     getSelected(): string[] {
-      checkPermission('selection:read');
+      checkPermission('content:read');
       return context.getSelected();
     },
 
     getSelectedShapes(): PenpotShape[] {
-      checkPermission('selection:read');
+      checkPermission('content:read');
       return context.getSelectedShapes();
     },
 
     shapesColors(
       shapes: PenpotShape[]
     ): (PenpotColor & PenpotColorShapeInfo)[] {
-      // checkPermission('selection:read');
+      checkPermission('content:read');
       return context.shapesColors(shapes);
     },
 
@@ -270,7 +268,7 @@ export function createApi(context: PenpotContext, manifest: Manifest): Penpot {
       oldColor: PenpotColor,
       newColor: PenpotColor
     ) {
-      // checkPermission('selection:read');
+      checkPermission('content:write');
       return context.replaceColor(shapes, oldColor, newColor);
     },
 
@@ -279,27 +277,27 @@ export function createApi(context: PenpotContext, manifest: Manifest): Penpot {
     },
 
     createFrame(): PenpotFrame {
-      // checkPermission('page:write');
+      checkPermission('content:write');
       return context.createFrame();
     },
 
     createRectangle(): PenpotRectangle {
-      // checkPermission('page:write');
+      checkPermission('content:write');
       return context.createRectangle();
     },
 
     createEllipse(): PenpotEllipse {
-      // checkPermission('page:write');
+      checkPermission('content:write');
       return context.createEllipse();
     },
 
     createText(text: string): PenpotText | null {
-      // checkPermission('page:write');
+      checkPermission('content:write');
       return context.createText(text);
     },
 
     createPath(): PenpotPath {
-      // checkPermission('page:write');
+      checkPermission('content:write');
       return context.createPath();
     },
 
@@ -307,30 +305,32 @@ export function createApi(context: PenpotContext, manifest: Manifest): Penpot {
       boolType: PenpotBoolType,
       shapes: PenpotShape[]
     ): PenpotBool | null {
-      // checkPermission('page:write');
+      checkPermission('content:write');
       return context.createBoolean(boolType, shapes);
     },
 
     createShapeFromSvg(svgString: string): PenpotGroup | null {
-      // checkPermission('page:write');
+      checkPermission('content:write');
       return context.createShapeFromSvg(svgString);
     },
 
     group(shapes: PenpotShape[]): PenpotGroup | null {
-      // checkPermission('page:write');
+      checkPermission('content:write');
       return context.group(shapes);
     },
 
     ungroup(group: PenpotGroup, ...other: PenpotGroup[]): void {
-      // checkPermission('page:write');
+      checkPermission('content:write');
       context.ungroup(group, ...other);
     },
 
     uploadMediaUrl(name: string, url: string) {
+      checkPermission('content:write');
       return context.uploadMediaUrl(name, url);
     },
 
     uploadMediaData(name: string, data: Uint8Array, mimeType: string) {
+      checkPermission('content:write');
       return context.uploadMediaData(name, data, mimeType);
     },
 
@@ -338,7 +338,7 @@ export function createApi(context: PenpotContext, manifest: Manifest): Penpot {
       shapes: PenpotShape[],
       options?: { type?: 'html' | 'svg' }
     ): string {
-      // checkPermission('page:write');
+      checkPermission('content:read');
       return context.generateMarkup(shapes, options);
     },
 
@@ -350,7 +350,7 @@ export function createApi(context: PenpotContext, manifest: Manifest): Penpot {
         includeChildren?: boolean;
       }
     ): string {
-      // checkPermission('page:write');
+      checkPermission('content:read');
       return context.generateStyle(shapes, options);
     },
   };

libs/plugins-runtime/src/lib/api/plugin-api.spec.ts

@@ -35,7 +35,13 @@ describe('Plugin api', () => {
     name: 'test',
     code: '',
     host: 'http://fake.com',
-    permissions: ['page:read', 'file:read', 'selection:read'],
+    permissions: [
+      'content:read',
+      'content:write',
+      'library:read',
+      'library:write',
+      'user:read',
+    ],
   });
 
   const addEventListenerMock = vi.mocked(window.addEventListener);

libs/plugins-runtime/src/lib/models/manifest.schema.ts

@@ -9,11 +9,11 @@ export const manifestSchema = z.object({
   description: z.string().max(200).optional(),
   permissions: z.array(
     z.enum([
-      'page:read',
-      'page:write',
-      'file:read',
-      'file:write',
-      'selection:read',
+      'content:read',
+      'content:write',
+      'library:read',
+      'library:write',
+      'user:read',
     ])
   ),
 });