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

package/src/index.ts

@@ -0,0 +1,249 @@
+import type { Config } from "payload";
+import { permissionActionsDefaultTranslations } from "./collections/permission-actions/default-data.js";
+import { getPermissionActionsCollection } from "./collections/permission-actions/index.js";
+import { permissionFeaturesDefaultTranslations } from "./collections/permission-features/default-data.js";
+import { getPermissionFeaturesCollection } from "./collections/permission-features/index.js";
+import { permissionsDefaultTranslations } from "./collections/permissions/default-data.js";
+import { getPermissionsCollection } from "./collections/permissions/index.js";
+import { rolesDefaultTranslations } from "./collections/roles/default-data.js";
+import { getRolesCollection } from "./collections/roles/index.js";
+import { rolesPermissionsDefaultTranslations } from "./collections/roles-permissions/default-data.js";
+import { getRolesPermissionsCollection } from "./collections/roles-permissions/index.js";
+import { usersDefaultTranslations } from "./collections/users/default-data.js";
+import { modifyUsersCollection } from "./collections/users/index.js";
+import { rolePermissionMatrixClientDefaultTranslations } from "./components/role-permission-matrix-client/default-data.js";
+
+import {
+  getAllTranslationsOfSpecificObject,
+  getMergedTranslations,
+} from "./lib/utils/index.js";
+import type {
+  PayloadAuthRbacPluginConfig,
+  PermissionActionsCollectionTranslations,
+  PermissionFeaturesCollectionTranslations,
+  PermissionsCollectionTranslations,
+  RolesCollectionTranslations,
+  RolesPermissionsCollectionTranslations,
+  UsersModificationTranslations,
+} from "./types.js";
+
+export * from "./lib/constants/index.js";
+export * from "./lib/utils/index.js";
+
+export const payloadAuthRbacPlugin =
+  (pluginOptions: PayloadAuthRbacPluginConfig) =>
+  (config: Config): Config => {
+    if (!config.collections) {
+      config.collections = [];
+    }
+
+    if (!pluginOptions.translations) {
+      pluginOptions.translations = {};
+    }
+
+    config.collections.push(
+      getPermissionActionsCollection({
+        ...pluginOptions.collections?.permissionActions,
+        translations: getMergedTranslations({
+          defaultTranslations: permissionActionsDefaultTranslations,
+          translations:
+            getAllTranslationsOfSpecificObject<PermissionActionsCollectionTranslations>(
+              {
+                translations: pluginOptions.translations,
+                path: "collections.permissionActions",
+              },
+            ),
+        }),
+      }),
+    );
+    config.collections.push(
+      getPermissionFeaturesCollection({
+        ...pluginOptions.collections?.permissionFeatures,
+        translations: getMergedTranslations({
+          defaultTranslations: permissionFeaturesDefaultTranslations,
+          translations:
+            getAllTranslationsOfSpecificObject<PermissionFeaturesCollectionTranslations>(
+              {
+                translations: pluginOptions.translations,
+                path: "collections.permissionFeatures",
+              },
+            ),
+        }),
+      }),
+    );
+    config.collections.push(
+      getPermissionsCollection({
+        ...pluginOptions.collections?.permissions,
+        translations: getMergedTranslations({
+          defaultTranslations: permissionsDefaultTranslations,
+          translations:
+            getAllTranslationsOfSpecificObject<PermissionsCollectionTranslations>(
+              {
+                translations: pluginOptions.translations,
+                path: "collections.permissions",
+              },
+            ),
+        }),
+      }),
+    );
+    config.collections.push(
+      getRolesCollection({
+        ...pluginOptions.collections?.roles,
+        translations: getMergedTranslations({
+          defaultTranslations: rolesDefaultTranslations,
+          translations:
+            getAllTranslationsOfSpecificObject<RolesCollectionTranslations>({
+              translations: pluginOptions.translations,
+              path: "collections.roles",
+            }),
+        }),
+      }),
+    );
+    config.collections.push(
+      getRolesPermissionsCollection({
+        ...pluginOptions.collections?.rolesPermissions,
+        translations: getMergedTranslations({
+          defaultTranslations: rolesPermissionsDefaultTranslations,
+          translations:
+            getAllTranslationsOfSpecificObject<RolesPermissionsCollectionTranslations>(
+              {
+                translations: pluginOptions.translations,
+                path: "collections.rolesPermissions",
+              },
+            ),
+        }),
+      }),
+    );
+
+    if (pluginOptions.autoModifyUsersCollection !== false) {
+      config = modifyUsersCollection({
+        translations: getMergedTranslations({
+          defaultTranslations: usersDefaultTranslations,
+          translations:
+            getAllTranslationsOfSpecificObject<UsersModificationTranslations>({
+              translations: pluginOptions.translations,
+              path: "collections.users",
+            }),
+        }),
+      })(config);
+    }
+    // if (pluginOptions.collections) {
+    //   for (const collectionSlug in pluginOptions.collections) {
+    //     const collection = config.collections.find(
+    //       (collection) => collection.slug === collectionSlug,
+    //     );
+
+    //     if (collection) {
+    //       collection.fields.push({
+    //         name: "addedByPlugin",
+    //         type: "text",
+    //         admin: {
+    //           position: "sidebar",
+    //         },
+    //       });
+    //     }
+    //   }
+    // }
+
+    /**
+     * If the plugin is disabled, we still want to keep added collections/fields so the database schema is consistent which is important for migrations.
+     * If your plugin heavily modifies the database schema, you may want to remove this property.
+     */
+    if (pluginOptions.disabled) {
+      return config;
+    }
+
+    if (!config.endpoints) {
+      config.endpoints = [];
+    }
+
+    if (!config.admin) {
+      config.admin = {};
+    }
+
+    if (!config.admin.components) {
+      config.admin.components = {};
+    }
+
+    // if (!config.admin.components.beforeDashboard) {
+    //   config.admin.components.beforeDashboard = []
+    // }
+
+    // config.admin.components.beforeDashboard.push(
+    //   `payload-auth-rbac-plugin/rsc#BeforeDashboardServer`,
+    // )
+
+    // config.endpoints.push({
+    //   handler: customEndpointHandler,
+    //   method: "get",
+    //   path: "/my-plugin-endpoint",
+    // })
+
+    const incomingOnInit = config.onInit;
+
+    config.onInit = async (payload) => {
+      // Ensure we are executing any existing onInit functions before running our own.
+      if (incomingOnInit) {
+        await incomingOnInit(payload);
+      }
+
+      // const { totalDocs } = await payload.count({
+      //   collection: "plugin-collection",
+      //   where: {
+      //     id: {
+      //       equals: "seeded-by-plugin",
+      //     },
+      //   },
+      // });
+
+      // if (totalDocs === 0) {
+      //   await payload.create({
+      //     collection: "plugin-collection",
+      //     data: {
+      //       id: "seeded-by-plugin",
+      //     },
+      //   });
+      // }
+    };
+
+    if (!config.i18n) {
+      config.i18n = {};
+    }
+    const existingTranslations =
+      (config.i18n?.translations as
+        | Record<string, Record<string, unknown>>
+        | undefined) || {};
+
+    const defaultRBACTranslations = {
+      en: {
+        collections: {
+          permissionActions: permissionActionsDefaultTranslations.en,
+          permissionFeatures: permissionFeaturesDefaultTranslations.en,
+          permissions: permissionsDefaultTranslations.en,
+          roles: rolesDefaultTranslations.en,
+          rolesPermissions: rolesPermissionsDefaultTranslations.en,
+          users: usersDefaultTranslations.en,
+        },
+        components: {
+          rolePermissionMatrix:
+            rolePermissionMatrixClientDefaultTranslations.en,
+        },
+      },
+    };
+
+    const mergedRBACTranslations = getMergedTranslations({
+      defaultTranslations: defaultRBACTranslations,
+      translations: pluginOptions.translations,
+    });
+
+    const finalTranslations = getMergedTranslations({
+      defaultTranslations: existingTranslations as Record<string, any>,
+      translations: mergedRBACTranslations,
+    });
+
+    config.i18n = {
+      ...config.i18n,
+      translations: finalTranslations,
+    };
+    return config;
+  };

package/src/lib/constants/general.ts

@@ -0,0 +1 @@
+export const NAMESPACE = "plugin-rbac" as const

package/src/lib/constants/index.ts

@@ -0,0 +1,15 @@
+import * as general from "./general.js";
+import * as permission from "./permission.js";
+import * as permissionAction from "./permission-action.js";
+import * as permissionFeature from "./permission-feature.js";
+import * as role from "./role.js";
+import * as user from "./user.js";
+
+export const CONSTANTS = {
+  GENERAL: general,
+  PERMISSION: permission,
+  PERMISSION_FEATURE: permissionFeature,
+  PERMISSION_ACTION: permissionAction,
+  ROLE: role,
+  USER: user,
+} as const;

package/src/lib/constants/permission-action.ts

@@ -0,0 +1,9 @@
+export const STATUS = {
+  ACTIVE: "active",
+  INACTIVE: "inactive",
+} as const
+
+export const TYPE = {
+  MAIN: "main",
+  SUB: "sub",
+} as const

package/src/lib/constants/permission-feature.ts

@@ -0,0 +1,4 @@
+export const STATUS = {
+  ACTIVE: "active",
+  INACTIVE: "inactive",
+} as const

package/src/lib/constants/permission.ts

@@ -0,0 +1,4 @@
+export const STATUS = {
+  ACTIVE: "active",
+  INACTIVE: "inactive",
+} as const

package/src/lib/constants/role.ts

@@ -0,0 +1,10 @@
+export const STATUS = {
+  ACTIVE: "active",
+  INACTIVE: "inactive",
+} as const;
+
+export const DATA_SCOPE = {
+  ALL: "all",
+  OWN: "own",
+  HIERARCHY: "hierarchy",
+} as const;

package/src/lib/constants/user.ts

@@ -0,0 +1 @@
+export const PARENT_PATH_SEPARATOR = "," as const;