@zealamic/payload-auth-rbac-plugin 1.0.0 → 1.0.1

package/src/collections/permission-features/index.ts

@@ -0,0 +1,122 @@
+import type { CollectionConfig } from "payload";
+import { STATUS } from "../../lib/constants/permission-feature.js";
+import {
+  getArrayOfMergedFieldAffectingData,
+  getSuperAdminAccess,
+  toLocaleRecord,
+  toSelectPlaceholder,
+} from "../../lib/utils/index.js";
+import type { PermissionFeaturesCollectionParams } from "./types.js";
+
+export const getPermissionFeaturesCollection = (
+  params: PermissionFeaturesCollectionParams,
+) => {
+  const {
+    translations = {},
+    access = {},
+    fields = [],
+    labels = {},
+    admin = {},
+  } = params || {};
+  const arrTranslationsKeys = Object.keys(translations);
+  const permissionFeatures: CollectionConfig = {
+    slug: "permission-features",
+    labels: {
+      singular: toLocaleRecord(
+        arrTranslationsKeys,
+        (locale) => translations[locale]?.labels?.singular,
+      ),
+      plural: toLocaleRecord(
+        arrTranslationsKeys,
+        (locale) => translations[locale]?.labels?.plural,
+      ),
+      ...labels,
+    },
+    admin: {
+      group: toLocaleRecord(
+        arrTranslationsKeys,
+        (locale) => translations[locale]?.admin?.group,
+      ),
+      useAsTitle: "code",
+      defaultColumns: ["code", "status", "updatedAt"],
+      ...admin,
+    },
+    access: {
+      create: getSuperAdminAccess,
+      update: getSuperAdminAccess,
+      delete: getSuperAdminAccess,
+      read: getSuperAdminAccess,
+      readVersions: getSuperAdminAccess,
+      unlock: getSuperAdminAccess,
+      admin: ({ req }) => {
+        return getSuperAdminAccess({ req });
+      },
+      ...access,
+    },
+    fields: getArrayOfMergedFieldAffectingData({
+      fields,
+      defaultFields: [
+        {
+          name: "code",
+          type: "text",
+          required: true,
+          unique: true,
+          index: true,
+          label: toLocaleRecord(
+            arrTranslationsKeys,
+            (locale) => translations[locale]?.fields?.code?.label,
+          ),
+          admin: {
+            placeholder: toLocaleRecord(
+              arrTranslationsKeys,
+              (locale) => translations[locale]?.fields?.code?.placeholder,
+            ),
+          },
+        },
+        {
+          name: "sortOrder",
+          type: "number",
+          required: false,
+          defaultValue: 0,
+          label: toLocaleRecord(
+            arrTranslationsKeys,
+            (locale) => translations[locale]?.fields?.sortOrder?.label,
+          ),
+          admin: {
+            placeholder: toLocaleRecord(
+              arrTranslationsKeys,
+              (locale) => translations[locale]?.fields?.sortOrder?.placeholder,
+            ),
+          },
+        },
+        {
+          name: "status",
+          type: "select",
+          required: true,
+          label: toLocaleRecord(
+            arrTranslationsKeys,
+            (locale) => translations[locale]?.fields?.status?.label,
+          ),
+          defaultValue: STATUS.ACTIVE,
+          options: Object.values(STATUS).map((status) => ({
+            label: toLocaleRecord(
+              arrTranslationsKeys,
+              (locale) =>
+                translations[locale]?.fields?.status?.[`${status}Label`],
+            ),
+            value: status,
+          })),
+          admin: {
+            placeholder: toSelectPlaceholder(
+              arrTranslationsKeys,
+              (locale) => translations[locale]?.fields?.status?.placeholder,
+            ),
+          },
+        },
+      ],
+    }),
+    timestamps: true,
+  };
+
+  return permissionFeatures;
+};

package/src/collections/permission-features/types.ts

@@ -0,0 +1,47 @@
+import type { CollectionConfig, Field } from "payload";
+import { STATUS } from "../../lib/constants/permission-feature.js";
+
+export type PermissionFeaturesCollectionTranslations = {
+  [locale: string]: {
+    labels?: {
+      singular?: string;
+      plural?: string;
+    };
+    admin?: {
+      group?: string;
+    };
+    fields?: {
+      code?: {
+        label?: string;
+        placeholder?: string;
+      };
+      sortOrder?: {
+        label?: string;
+        placeholder?: string;
+      };
+      status?: {
+        label?: string;
+        placeholder?: string;
+        activeLabel?: string;
+        inactiveLabel?: string;
+      };
+    };
+  };
+};
+
+export type PermissionFeaturesCollectionParams = {
+  translations?: PermissionFeaturesCollectionTranslations;
+  fields?: Field[];
+  access?: CollectionConfig["access"];
+  labels?: CollectionConfig["labels"];
+  admin?: CollectionConfig["admin"];
+};
+
+export type PermissionFeatureStatus = (typeof STATUS)[keyof typeof STATUS];
+
+export type PermissionFeature = {
+  id: string | number;
+  code?: string | null;
+  sortOrder?: number | null;
+  status?: PermissionFeatureStatus | null;
+};

package/src/collections/permissions/default-data.ts

@@ -0,0 +1,38 @@
+import type { PermissionsCollectionTranslations } from "./types.js";
+
+export const permissionsDefaultTranslations: PermissionsCollectionTranslations =
+  {
+    en: {
+      labels: {
+        singular: "Permission",
+        plural: "Permissions",
+      },
+      admin: {
+        group: "System",
+      },
+      fields: {
+        name: {
+          label: "Name",
+          placeholder: "Enter name",
+        },
+        permissionFeature: {
+          label: "Permission Feature",
+          placeholder: "Select permission feature",
+        },
+        permissionAction: {
+          label: "Permission Action",
+          placeholder: "Select permission action",
+        },
+        sortOrder: {
+          label: "Sort Order",
+          placeholder: "Enter sort order",
+        },
+        status: {
+          label: "Status",
+          placeholder: "Select status",
+          activeLabel: "Active",
+          inactiveLabel: "Inactive",
+        },
+      },
+    },
+  };

package/src/collections/permissions/index.ts

@@ -0,0 +1,160 @@
+import type { CollectionConfig } from "payload";
+import { STATUS } from "../../lib/constants/permission.js";
+import {
+  getArrayOfMergedFieldAffectingData,
+  getSuperAdminAccess,
+  toLocaleRecord,
+  toSelectPlaceholder,
+} from "../../lib/utils/index.js";
+import type { PermissionsCollectionParams } from "./types.js";
+
+export const getPermissionsCollection = (
+  params: PermissionsCollectionParams,
+) => {
+  const {
+    translations = {},
+    access = {},
+    fields = [],
+    labels = {},
+    admin = {},
+  } = params || {};
+  const arrTranslationsKeys = Object.keys(translations);
+  const permissions: CollectionConfig = {
+    slug: "permissions",
+    labels: {
+      singular: toLocaleRecord(
+        arrTranslationsKeys,
+        (locale) => translations[locale]?.labels?.singular,
+      ),
+      plural: toLocaleRecord(
+        arrTranslationsKeys,
+        (locale) => translations[locale]?.labels?.plural,
+      ),
+      ...labels,
+    },
+    admin: {
+      group: toLocaleRecord(
+        arrTranslationsKeys,
+        (locale) => translations[locale]?.admin?.group,
+      ),
+      useAsTitle: "name",
+      defaultColumns: [
+        "name",
+        "permissionFeature",
+        "permissionAction",
+        "status",
+        "updatedAt",
+      ],
+      ...admin,
+    },
+    access: {
+      create: getSuperAdminAccess,
+      update: getSuperAdminAccess,
+      delete: getSuperAdminAccess,
+      read: getSuperAdminAccess,
+      readVersions: getSuperAdminAccess,
+      unlock: getSuperAdminAccess,
+      admin: ({ req }) => {
+        return getSuperAdminAccess({ req });
+      },
+      ...access,
+    },
+    fields: getArrayOfMergedFieldAffectingData({
+      fields,
+      defaultFields: [
+        {
+          name: "name",
+          type: "text",
+          required: true,
+          label: toLocaleRecord(
+            arrTranslationsKeys,
+            (locale) => translations[locale]?.fields?.name?.label,
+          ),
+          admin: {
+            placeholder: toLocaleRecord(
+              arrTranslationsKeys,
+              (locale) => translations[locale]?.fields?.name?.placeholder,
+            ),
+          },
+        },
+        {
+          name: "permissionFeature",
+          type: "relationship",
+          required: true,
+          relationTo: "permission-features",
+          label: toLocaleRecord(
+            arrTranslationsKeys,
+            (locale) => translations[locale]?.fields?.permissionFeature?.label,
+          ),
+          admin: {
+            placeholder: toSelectPlaceholder(
+              arrTranslationsKeys,
+              (locale) =>
+                translations[locale]?.fields?.permissionFeature?.placeholder,
+            ),
+          },
+        },
+        {
+          name: "permissionAction",
+          type: "relationship",
+          required: true,
+          relationTo: "permission-actions",
+          label: toLocaleRecord(
+            arrTranslationsKeys,
+            (locale) => translations[locale]?.fields?.permissionAction?.label,
+          ),
+          admin: {
+            placeholder: toSelectPlaceholder(
+              arrTranslationsKeys,
+              (locale) =>
+                translations[locale]?.fields?.permissionAction?.placeholder,
+            ),
+          },
+        },
+        {
+          name: "sortOrder",
+          type: "number",
+          required: false,
+          defaultValue: 0,
+          label: toLocaleRecord(
+            arrTranslationsKeys,
+            (locale) => translations[locale]?.fields?.sortOrder?.label,
+          ),
+          admin: {
+            placeholder: toLocaleRecord(
+              arrTranslationsKeys,
+              (locale) => translations[locale]?.fields?.sortOrder?.placeholder,
+            ),
+          },
+        },
+        {
+          name: "status",
+          type: "select",
+          required: true,
+          label: toLocaleRecord(
+            arrTranslationsKeys,
+            (locale) => translations[locale]?.fields?.status?.label,
+          ),
+          defaultValue: STATUS.ACTIVE,
+          options: Object.values(STATUS).map((status) => ({
+            label: toLocaleRecord(
+              arrTranslationsKeys,
+              (locale) =>
+                translations[locale]?.fields?.status?.[`${status}Label`],
+            ),
+            value: status,
+          })),
+          admin: {
+            placeholder: toSelectPlaceholder(
+              arrTranslationsKeys,
+              (locale) => translations[locale]?.fields?.status?.placeholder,
+            ),
+          },
+        },
+      ],
+    }),
+    timestamps: true,
+  };
+
+  return permissions;
+};

package/src/collections/permissions/types.ts

@@ -0,0 +1,57 @@
+import type { CollectionConfig, Field } from "payload";
+import { STATUS } from "src/lib/constants/permission.js";
+
+export type PermissionsCollectionTranslations = {
+  [locale: string]: {
+    labels?: {
+      singular?: string;
+      plural?: string;
+    };
+    admin?: {
+      group?: string;
+    };
+    fields?: {
+      name?: {
+        label?: string;
+        placeholder?: string;
+      };
+      permissionFeature?: {
+        label?: string;
+        placeholder?: string;
+      };
+      permissionAction?: {
+        label?: string;
+        placeholder?: string;
+      };
+      sortOrder?: {
+        label?: string;
+        placeholder?: string;
+      };
+      status?: {
+        label?: string;
+        placeholder?: string;
+        activeLabel?: string;
+        inactiveLabel?: string;
+      };
+    };
+  };
+};
+
+export type PermissionsCollectionParams = {
+  translations?: PermissionsCollectionTranslations;
+  fields?: Field[];
+  access?: CollectionConfig["access"];
+  labels?: CollectionConfig["labels"];
+  admin?: CollectionConfig["admin"];
+};
+
+export type PermissionItemRef = string | number | { id?: string | number };
+
+export type PermissionStatus = (typeof STATUS)[keyof typeof STATUS];
+
+export type Permission = {
+  id: string | number;
+  permissionFeature?: PermissionItemRef;
+  permissionAction?: PermissionItemRef;
+  status?: PermissionStatus | null;
+};

package/src/collections/roles/default-data.ts

@@ -0,0 +1,44 @@
+import type { RolesCollectionTranslations } from "./types.js"
+
+export const rolesDefaultTranslations: RolesCollectionTranslations = {
+  en: {
+    labels: {
+      singular: "Role",
+      plural: "Roles",
+    },
+    admin: {
+      group: "System",
+    },
+    fields: {
+      code: {
+        label: "Code",
+        placeholder: "Enter code",
+      },
+      name: {
+        label: "Name",
+        placeholder: "Enter name",
+      },
+      description: {
+        label: "Description",
+        placeholder: "Enter description",
+      },
+      status: {
+        label: "Status",
+        placeholder: "Select status",
+        activeLabel: "Active",
+        inactiveLabel: "Inactive",
+      },
+      dataScope: {
+        label: "Data Scope",
+        placeholder: "Select data scope",
+        ownLabel: "Own",
+        allLabel: "All",
+        hierarchyLabel: "Hierarchy",
+      },
+      permissionMatrix: {
+        label: "Permission Matrix",
+        placeholder: "Select permission matrix",
+      },
+    },
+  },
+}

package/src/collections/roles/hooks/sync-permission-matrix-draft.ts

@@ -0,0 +1,73 @@
+import type { CollectionAfterChangeHook } from "payload";
+
+type PermissionMatrixDraft = Record<string, boolean>;
+
+const isPermissionMatrixDraft = (
+  value: unknown,
+): value is PermissionMatrixDraft => {
+  if (!value || typeof value !== "object" || Array.isArray(value)) {
+    return false;
+  }
+
+  return Object.values(value).every((entry) => typeof entry === "boolean");
+};
+
+/**
+ * Persists `permissionMatrixDraft` on the role document into `roles-permissions` rows.
+ * RBAC checks use `roles-permissions`, not the JSON draft field.
+ */
+export const syncPermissionMatrixDraftAfterChange: CollectionAfterChangeHook =
+  async ({ doc, req }) => {
+    if (!doc.id || !isPermissionMatrixDraft(doc.permissionMatrixDraft)) {
+      return;
+    }
+
+    const roleID = doc.id;
+
+    for (const [permissionID, enabled] of Object.entries(
+      doc.permissionMatrixDraft,
+    )) {
+      if (!permissionID) {
+        continue;
+      }
+
+      const existing = await req.payload.find({
+        collection: "roles-permissions",
+        depth: 0,
+        limit: 1,
+        req,
+        where: {
+          and: [
+            { role: { equals: roleID } },
+            { permission: { equals: permissionID } },
+          ],
+        },
+      });
+
+      const row = existing.docs[0];
+
+      if (row?.id) {
+        if (row.enabled === enabled) {
+          continue;
+        }
+
+        await req.payload.update({
+          id: row.id,
+          collection: "roles-permissions",
+          data: { enabled },
+          req,
+        });
+        continue;
+      }
+
+      await req.payload.create({
+        collection: "roles-permissions",
+        data: {
+          role: roleID,
+          permission: permissionID,
+          enabled,
+        },
+        req,
+      });
+    }
+  };