Merge pull request #18 from shefing/readme-update

update packages readme

Author: michalklor

packages/authorization/README.md

@@ -7,8 +7,9 @@ This plugin enables to define roles based on basic permissions per collection. T
 There is a built-in role named administrator and users assigned to it (aka administrators) can create a Roles collection to define roles that will control access to the content. Each role contains a set of permissions that are composed of operation: read/write/publish and the collection(s) / global(s) they apply to.
 
 Note that:
+
 - write permission on a collection / global includes read permission on this collection / global
-- publish permission on a collection / global does not includes write either read permission on this collection / global
+- publish permission on a collection / global includes write either read permission on this collection / global
 
 Example:
 
@@ -18,7 +19,7 @@ Administrators can set as many permissions he/she wants within a role and as man
 
 ![img_1.png](./images/img_1.png)
 
- ### Setup
+### Setup
 
 - Install the [plugin](https://www.npmjs.com/package/@shefing/authorization) using your node package manager, e.g:
 
@@ -32,7 +33,7 @@ plugins: [
     addAccess({
       rolesCollection: 'roles', // name of the collection defining the roles
       permissionsField: 'permissions', // name of the field within the role collection
-      excludedCollections: ['posts', 'media'] // enable to exclude some collections from permission control 
+      excludedCollections: ['posts', 'media'] // enable to exclude some collections from permission control
     }),
 ```
 
@@ -44,11 +45,11 @@ You need to create the `roles` collection and it must have the following fields:
 fields: [
   {
     name: 'name',
-    type: 'text'
+    type: 'text',
   },
   {
     name: 'permissions',
-    saveToJWT: true, 
+    saveToJWT: true,
     interfaceName: 'RolePermissions',
     type: 'array',
     access: {
@@ -57,14 +58,14 @@ fields: [
     },
     fields: [
       {
-        type: 'row', 
+        type: 'row',
         fields: [
           {
             name: 'entity',
             label: 'Collection or Global',
             type: 'select',
             hasMany: true,
-            options: [], 
+            options: [],
             required: true,
           },
           {

packages/authorization/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shefing/authorization",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": false,
   "bugs": "https://github.com/shefing/payload-tools/issues",
   "repository": "https://github.com/shefing/payload-tools",

packages/authorization/src/access/general.ts

@@ -1,6 +1,12 @@
 import { Access, User, Payload } from 'payload';
 import { AuthorizationPluginConfig } from '../types.js';
 
+const PERMISSION_HIERARCHY: Record<string, string[]> = {
+  publish: ['write', 'read', 'publish'],
+  write: ['read', 'write'],
+  read: ['read'],
+};
+
 export const canUserAccessAction = async (
   user: User | null | undefined,
   slugName: string,
@@ -10,33 +16,31 @@ export const canUserAccessAction = async (
 ): Promise<boolean> => {
   if (!user) return false;
 
-  // Admin users always have access
   if (user.isAdmin) return true;
 
-  // No roles assigned to the user
   if (!user.userRoles || user.userRoles.length === 0) return false;
 
-  // Fetch roles from the defined collection
   const roles = await payload.find({
     collection: config.rolesCollection,
     where: {
-      id: { in: user.userRoles.map((role: any) => role.id) }, // Filter by user roles
+      id: { in: user.userRoles.map((role: any) => role.id) },
     },
   });
 
   if (!roles.docs || roles.docs.length === 0) return false;
 
-  // Check permissions for each role
+  const userAllowedActions = new Set<string>();
+
   for (const role of roles.docs) {
     const permissions = role[config.permissionsField];
     if (permissions) {
       for (const permission of permissions) {
-        if (permission.entity.includes(slugName) && permission.type.includes(action)) {
-          return true;
+        if (permission.entity.includes(slugName)) {
+          userAllowedActions.add(permission.type);
+          PERMISSION_HIERARCHY[permission.type]?.forEach((perm) => userAllowedActions.add(perm));
         }
       }
     }
   }
-
-  return false;
+  return userAllowedActions.has(action);
 };

packages/authorization/src/utilities/hasAccessToAction.ts

@@ -1,7 +1,6 @@
 import { Access, User } from 'payload';
 import { canUserAccessAction } from '../access/general.js';
-import { config } from 'process';
-import { AuthorizationPluginConfig } from '../types.js';
+
 
 export const hasAccessToAction =
   (slugName: string, action: string,pluginConfig:any): Access =>

packages/authors-info/README.md

@@ -1,13 +1,14 @@
 ## [Author Info plugin](./src/index.ts)
 
-- Payload 3.0 does not store authors informations, so we created this package to automatically store information about who created, updated and publish content, and this for all collections and globals. The package does add a new tab in the authoring user interface "Author Data".
+- This plugin provides an automated solution to track and store details about content creators, editors, and publishers across all collections and globals.
+  It also introduces an "Author Data" tab in the authoring interface.
 - Payload 3.0 is storing the creation and modification date of each document's collections but does not store publication date. So this package aslo stores the most recent publish date.
 
 ![img_1.png](./images/img_1.png)
 
 ### Setup
 
-In order to use this authors-info plugin install it using your prefered node package manager, e.g:
+Install the plugin using your node package manager, e.g:
 
 `npm add @shefing/authors-info`
 
@@ -17,19 +18,11 @@ In the payload.config.ts add the following:
 plugins: [
     ...plugins,
     addAuthorsFields({
-      excludedCollections: [],
-      usernameField: 'fullName',
+      excludedCollections: [],//array of collections names to exclude
+      excludedGlobals:[], // array of globals names to exclude
+      usernameField: 'fullName', //name field to use from Users collection, 'user' by default
     }),
 ```
 
-### Configuration
-
-- `excludedCollections`: array of collections names to exclude
-
-- `excludedGlobals`: array of globals names to exclude
-
-- `usernameField`: name field to use from Users collection, 'user' by default
-
-
-The dates are presented relatively using moment.js anywhere using CreatedAtCell type 
+The dates are presented relatively using moment.js anywhere using CreatedAtCell type
 ![img_2.png](./images/img_2.png)

packages/authors-info/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shefing/authors-info",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": false,
   "bugs": "https://github.com/shefing/payload-tools/issues",
   "repository": "https://github.com/shefing/payload-tools",

packages/authors-info/src/index.ts

@@ -78,7 +78,7 @@ const processFields = (fields: Field[], hasDraft: boolean): Field[] => {
         disableBulkEdit: true,
         hidden: true,
         components: {
-          Cell: '@rikifrank/authors-info/client#CreatedAtCell',
+          Cell: '@shefing/authors-info/client#CreatedAtCell',
         },
       },
       // The default sort for list view is createdAt. Thus, enabling indexing by default, is a major performance improvement, especially for large or a large amount of collections.
@@ -94,7 +94,7 @@ const processFields = (fields: Field[], hasDraft: boolean): Field[] => {
         disableBulkEdit: true,
         hidden: true,
         components: {
-          Cell: '@rikifrank/authors-info/client#CreatedAtCell',
+          Cell: '@shefing/authors-info/client#CreatedAtCell',
         },
       },
       label: ({ t }) => t('general:updatedAt'),
@@ -129,7 +129,7 @@ const processFields = (fields: Field[], hasDraft: boolean): Field[] => {
             pickerAppearance: 'dayAndTime',
             displayFormat: 'd MMM yyy: ,h:mm:ss a',
           },
-          components: { Cell: '@rikifrank/authors-info/client#CreatedAtCell' },
+          components: { Cell: '@shefing/authors-info/client#CreatedAtCell' },
         },
       },
       {

packages/authors-info/tsconfig.json

@@ -23,7 +23,7 @@
     "target": "ESNext"
   },
   "paths": {
-    "@rikifrank/authors-info/client": ["./packages/authors-info/src/exports/client.ts"]
+    "@shefing/authors-info/client": ["./packages/authors-info/src/exports/client.ts"]
   },
   "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.d.ts", "src/**/*.json"],
   "exclude": ["dist", "build", "node_modules"]

packages/color-picker/README.md

@@ -1,28 +1,28 @@
 ## [Color Picker Field ](./src/index.ts)
 
-In the default Payload CMS, there was no built-in color picker field. We've added a custom Color Picker field that allows users to easily select colors directly within the CMS interface. This field uses the Flowbite color palette, bringing in all available colors from Flowbite. Users can search for a specific color by name or select it from the palette. To use it, simply select a color from the picker, enter a hex code, or search for the color name, and it will be applied to your content.
+Payload CMS does not include a built-in color picker, so we added a custom field that integrates Tailwind's color palette. Users can select a color, enter a hex code, or search by name directly within the CMS.
 
-This implementation integrates Flowbite with ShadCN UI, combining Flowbite's extensive design system with ShadCN's modern component library for an effective experience
+This integrates Tailwind design system with ShadCN's component library for a seamless experience.
 
 ![img1.png](./images/img1.png)
 
 ### Setup
 
-In order to use this color-picker field install it using your prefered node package manager, e.g:
+Install the field using your node package manager, e.g:
 
-` npm install @shefing/color-picker`
+    ` npm install @shefing/color-picker`
 
-In the collection add the following:
+In the target collection add the following:
 
 ```typescript
 import { createColorField } from '@shefing/color-picker';
 
-fields: [createColorField({ name: 'color', label: 'font-color' })];
+fields: [
+  createColorField({
+    name: 'color', //The name of the field.
+    label: 'font-color', //The label of the field.
+  }),
+];
 ```
 
 To use this package, make sure Tailwind CSS is installed in your project.
-
-### Configuration
-
-- `name`: The name of the field. This is the key used to store and retrieve the field's value.
-- `label`: The label of the field. This is the text displayed in the admin interface to represent the field.

packages/color-picker/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shefing/color-picker",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": false,
   "bugs": "https://github.com/shefing/payload-tools/issues",
   "repository": "https://github.com/shefing/payload-tools",