@zealamic/payload-auth-rbac-plugin 1.0.0-beta.9 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zealamic/payload-auth-rbac-plugin",
-  "version": "1.0.0-beta.9",
+  "version": "1.0.1",
   "description": "A plugin for Payload CMS to manage authentication and authorization",
   "license": "MIT",
   "type": "module",
@@ -46,10 +46,13 @@
   "types": "./src/general.d.ts",
   "files": [
     "dist",
-    "docs/cover-photo.jpg"
+    "docs",
+    "assets",
+    "src"
   ],
   "scripts": {
-    "build": "yarn copyfiles && yarn build:types && yarn build:swc",
+    "copy:styles": "node -e \"require('fs').cpSync('src/styles', 'dist/styles', {recursive:true})\"",
+    "build": "yarn copyfiles && yarn build:types && yarn build:swc && yarn copy:styles",
     "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
     "build:types": "tsc --outDir dist --rootDir ./src",
     "clean": "rimraf {dist,*.tsbuildinfo}",
@@ -106,31 +109,7 @@
     "node": "^18.20.2 || >=20.9.0"
   },
   "publishConfig": {
-    "access": "public",
-    "main": "./dist/index.js",
-    "types": "./dist/index.d.ts",
-    "exports": {
-      ".": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "./client": {
-        "types": "./dist/exports/client.d.ts",
-        "default": "./dist/exports/client.js"
-      },
-      "./rsc": {
-        "types": "./dist/exports/rsc.d.ts",
-        "default": "./dist/exports/rsc.js"
-      },
-      "./types": {
-        "types": "./dist/types.d.ts",
-        "default": "./dist/types.js"
-      },
-      "./utils": {
-        "types": "./dist/lib/utils/index.d.ts",
-        "default": "./dist/lib/utils/index.js"
-      }
-    }
+    "access": "public"
   },
   "registry": "https://registry.npmjs.org/",
   "dependencies": {}

package/src/collections/permission-actions/default-data.ts

@@ -0,0 +1,36 @@
+import type { PermissionActionsCollectionTranslations } from "./types.js";
+
+export const permissionActionsDefaultTranslations: PermissionActionsCollectionTranslations =
+  {
+    en: {
+      labels: {
+        singular: "Permission Action",
+        plural: "Permission Actions",
+      },
+      admin: {
+        group: "System",
+      },
+      fields: {
+        code: {
+          label: "Code",
+          placeholder: "Enter code",
+        },
+        type: {
+          label: "Type",
+          placeholder: "Select type",
+          mainLabel: "Main",
+          subLabel: "Sub",
+        },
+        sortOrder: {
+          label: "Sort Order",
+          placeholder: "Enter sort order",
+        },
+        status: {
+          label: "Status",
+          placeholder: "Select status",
+          activeLabel: "Active",
+          inactiveLabel: "Inactive",
+        },
+      },
+    },
+  };

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

@@ -0,0 +1,144 @@
+import type { CollectionConfig } from "payload";
+import { STATUS, TYPE } from "../../lib/constants/permission-action.js";
+import {
+  getArrayOfMergedFieldAffectingData,
+  getSuperAdminAccess,
+  toLocaleRecord,
+  toSelectPlaceholder,
+} from "../../lib/utils/index.js";
+import type { PermissionActionsCollectionParams } from "./types.js";
+
+export const getPermissionActionsCollection = (
+  params: PermissionActionsCollectionParams,
+) => {
+  const {
+    translations = {},
+    access = {},
+    fields = [],
+    labels = {},
+    admin = {},
+  } = params || {};
+  const arrTranslationsKeys = Object.keys(translations);
+  const permissionActions: CollectionConfig = {
+    slug: "permission-actions",
+    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", "type", "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: "type",
+          type: "select",
+          required: true,
+          label: toLocaleRecord(
+            arrTranslationsKeys,
+            (locale) => translations[locale]?.fields?.type?.label,
+          ),
+          options: Object.values(TYPE).map((type) => ({
+            label: toLocaleRecord(
+              arrTranslationsKeys,
+              (locale) => translations[locale]?.fields?.type?.[`${type}Label`],
+            ),
+            value: type,
+          })),
+          admin: {
+            placeholder: toSelectPlaceholder(
+              arrTranslationsKeys,
+              (locale) => translations[locale]?.fields?.type?.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 permissionActions;
+};

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

@@ -0,0 +1,56 @@
+import type { CollectionConfig, Field } from "payload";
+import { STATUS, TYPE } from "../../lib/constants/permission-action.js";
+
+export type PermissionActionsCollectionTranslations = {
+  [locale: string]: {
+    labels?: {
+      singular?: string;
+      plural?: string;
+    };
+    admin?: {
+      group?: string;
+    };
+    fields?: {
+      code?: {
+        label?: string;
+        placeholder?: string;
+      };
+      type?: {
+        label?: string;
+        placeholder?: string;
+        mainLabel?: string;
+        subLabel?: string;
+      };
+      sortOrder?: {
+        label?: string;
+        placeholder?: string;
+      };
+      status?: {
+        label?: string;
+        placeholder?: string;
+        activeLabel?: string;
+        inactiveLabel?: string;
+      };
+    };
+  };
+};
+
+export type PermissionActionsCollectionParams = {
+  translations?: PermissionActionsCollectionTranslations;
+  fields?: Field[];
+  access?: CollectionConfig["access"];
+  labels?: CollectionConfig["labels"];
+  admin?: CollectionConfig["admin"];
+};
+
+export type PermissionActionStatus = (typeof STATUS)[keyof typeof STATUS];
+
+export type PermissionActionType = (typeof TYPE)[keyof typeof TYPE];
+
+export type PermissionAction = {
+  id: string | number;
+  code?: string | null;
+  sortOrder?: number | null;
+  type?: PermissionActionType | null;
+  status?: PermissionActionStatus | null;
+};

package/src/collections/permission-features/default-data.ts

@@ -0,0 +1,30 @@
+import type { PermissionFeaturesCollectionTranslations } from "./types.js";
+
+export const permissionFeaturesDefaultTranslations: PermissionFeaturesCollectionTranslations =
+  {
+    en: {
+      labels: {
+        singular: "Permission Feature",
+        plural: "Permission Features",
+      },
+      admin: {
+        group: "System",
+      },
+      fields: {
+        code: {
+          label: "Code",
+          placeholder: "Enter code",
+        },
+        sortOrder: {
+          label: "Sort Order",
+          placeholder: "Enter sort order",
+        },
+        status: {
+          label: "Status",
+          placeholder: "Select status",
+          activeLabel: "Active",
+          inactiveLabel: "Inactive",
+        },
+      },
+    },
+  };

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;
+};