@careflair/common 1.0.43 → 1.0.45

package/dist/abilities/index.d.ts

@@ -1,29 +1,19 @@
-import { PureAbility, MongoQuery } from "@casl/ability";
+import { PureAbility } from "@casl/ability";
 import { UserRole } from "../enums";
 /**
  * Actions that users can perform
  */
 export type Actions = "create" | "read" | "update" | "delete" | "apply" | "initiate" | "respond" | "submit" | "manage";
-/**
- * Subject types with their fields for conditional checks
- */
-type Job = {
-    postedBy: string;
-};
-type Profile = {
-    user: string;
-};
 /**
  * Subjects/resources that users act upon
- * Includes both string literals (for rule definition) and object types (for instance checking)
  */
-export type Subjects = "Job" | "Chat" | "NDISScreening" | "WorkingWithChildren" | "Profile" | "all" | Job | Profile;
+export type Subjects = "Job" | "Chat" | "NDISScreening" | "WorkingWithChildren" | "Profile" | "Onboarding" | "all";
 /**
  * AppAbility type for type-safe permission checks
  * Uses PureAbility (modern API) + mongoQueryMatcher so we can define conditional rules
  * (e.g. { postedBy: user.id }) without runtime errors.
  */
-export type AppAbility = PureAbility<[Actions, Subjects], MongoQuery>;
+export type AppAbility = PureAbility<[Actions, Subjects], any>;
 /**
  * User type for ability definition
  * Only requires id and role - minimal interface for permission checks
@@ -41,4 +31,3 @@ export type UserForAbility = {
  * @returns AppAbility instance with user's permissions
  */
 export declare function defineAbilitiesFor(user: UserForAbility): AppAbility;
-export {};

package/dist/abilities/index.js

@@ -45,6 +45,8 @@ function defineAbilitiesFor(user) {
         // Profile
         can("read", "Profile", { user: user.id });
         can("update", "Profile", { user: user.id });
+        // Onboarding (role-based check, no resource condition)
+        can("update", "Onboarding");
     }
     // ============================================
     // WORKERS: PROVIDER
@@ -63,6 +65,8 @@ function defineAbilitiesFor(user) {
         // Profile
         can("read", "Profile", { user: user.id });
         can("update", "Profile", { user: user.id });
+        // Onboarding (role-based check, no resource condition)
+        can("update", "Onboarding");
     }
     return build({
         conditionsMatcher: ability_1.mongoQueryMatcher,

package/dist/utils/index.d.ts

@@ -7,3 +7,5 @@ export * from "./video";
 export * from "./onboarding";
 export * from "./html";
 export * from "./labels";
+export * from "./user-role.utils";
+export * from "./role-fields.utils";

package/dist/utils/index.js

@@ -32,3 +32,7 @@ __exportStar(require("./onboarding"), exports);
 __exportStar(require("./html"), exports);
 // Label helper utilities
 __exportStar(require("./labels"), exports);
+// User role utilities
+__exportStar(require("./user-role.utils"), exports);
+// Role-based field restrictions utilities
+__exportStar(require("./role-fields.utils"), exports);

package/dist/utils/role-fields.utils.d.ts

@@ -0,0 +1,24 @@
+import { UserRole } from "../enums";
+/**
+ * Fields that are restricted for PROVIDER role
+ * These fields are only applicable to SUPPORT_WORKER
+ */
+export declare const PROVIDER_RESTRICTED_FIELDS: readonly ["yearsOfExperience", "hourlyRate", "genderOfAttendants", "languages", "availabilities"];
+/**
+ * Onboarding steps that are restricted for PROVIDER role
+ * These steps should be skipped in the onboarding flow for providers
+ */
+export declare const PROVIDER_RESTRICTED_ONBOARDING_STEPS: readonly ["EXPERIENCE", "HOURLY_RATE", "GENDER", "LANGUAGES"];
+/**
+ * Check if a field is restricted for the given role
+ */
+export declare function isFieldRestrictedForRole(fieldName: string, role: UserRole): boolean;
+/**
+ * Check if an onboarding step is restricted for the given role
+ */
+export declare function isOnboardingStepRestrictedForRole(step: string, role: UserRole): boolean;
+/**
+ * Get allowed onboarding steps for a role
+ * Filters out restricted steps based on role
+ */
+export declare function getAllowedOnboardingSteps(allSteps: string[], role: UserRole): string[];

package/dist/utils/role-fields.utils.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROVIDER_RESTRICTED_ONBOARDING_STEPS = exports.PROVIDER_RESTRICTED_FIELDS = void 0;
+exports.isFieldRestrictedForRole = isFieldRestrictedForRole;
+exports.isOnboardingStepRestrictedForRole = isOnboardingStepRestrictedForRole;
+exports.getAllowedOnboardingSteps = getAllowedOnboardingSteps;
+const enums_1 = require("../enums");
+/**
+ * Fields that are restricted for PROVIDER role
+ * These fields are only applicable to SUPPORT_WORKER
+ */
+exports.PROVIDER_RESTRICTED_FIELDS = [
+    "yearsOfExperience",
+    "hourlyRate",
+    "genderOfAttendants",
+    "languages",
+    "availabilities",
+    // Note: Education and Work History are in User schema, not Business
+];
+/**
+ * Onboarding steps that are restricted for PROVIDER role
+ * These steps should be skipped in the onboarding flow for providers
+ */
+exports.PROVIDER_RESTRICTED_ONBOARDING_STEPS = [
+    "EXPERIENCE",
+    "HOURLY_RATE",
+    "GENDER",
+    "LANGUAGES",
+    // Note: Education and Work History are separate user profile fields
+];
+/**
+ * Check if a field is restricted for the given role
+ */
+function isFieldRestrictedForRole(fieldName, role) {
+    if (role === enums_1.UserRole.PROVIDER) {
+        return exports.PROVIDER_RESTRICTED_FIELDS.includes(fieldName);
+    }
+    return false;
+}
+/**
+ * Check if an onboarding step is restricted for the given role
+ */
+function isOnboardingStepRestrictedForRole(step, role) {
+    if (role === enums_1.UserRole.PROVIDER) {
+        return exports.PROVIDER_RESTRICTED_ONBOARDING_STEPS.includes(step);
+    }
+    return false;
+}
+/**
+ * Get allowed onboarding steps for a role
+ * Filters out restricted steps based on role
+ */
+function getAllowedOnboardingSteps(allSteps, role) {
+    if (role === enums_1.UserRole.PROVIDER) {
+        return allSteps.filter((step) => !isOnboardingStepRestrictedForRole(step, role));
+    }
+    return allSteps;
+}

package/dist/utils/user-role.utils.d.ts

@@ -0,0 +1,35 @@
+import { UserRole } from "../enums";
+/**
+ * Check if user role is a worker (SUPPORT_WORKER or PROVIDER)
+ * Both roles have the same privileges and business logic
+ */
+export declare function isWorkerRole(role: UserRole): boolean;
+/**
+ * Check if user is a worker (SUPPORT_WORKER or PROVIDER)
+ * Accepts any object with a role property
+ */
+export declare function isWorker(user: {
+    role: UserRole;
+}): boolean;
+/**
+ * Get array of worker roles for MongoDB $in queries
+ * Use this in MongoDB queries to filter for both SUPPORT_WORKER and PROVIDER
+ */
+export declare function getWorkerRoles(): UserRole[];
+/**
+ * Check if user role is a hirer (PARTICIPANT or SUPPORT_PERSON)
+ * Hirers can create jobs and initiate conversations
+ */
+export declare function isHirerRole(role: UserRole): boolean;
+/**
+ * Check if user is a hirer (PARTICIPANT or SUPPORT_PERSON)
+ * Accepts any object with a role property
+ */
+export declare function isHirer(user: {
+    role: UserRole;
+}): boolean;
+/**
+ * Get array of hirer roles for MongoDB $in queries
+ * Use this in MongoDB queries to filter for both PARTICIPANT and SUPPORT_PERSON
+ */
+export declare function getHirerRoles(): UserRole[];

package/dist/utils/user-role.utils.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWorkerRole = isWorkerRole;
+exports.isWorker = isWorker;
+exports.getWorkerRoles = getWorkerRoles;
+exports.isHirerRole = isHirerRole;
+exports.isHirer = isHirer;
+exports.getHirerRoles = getHirerRoles;
+const enums_1 = require("../enums");
+// ============================================================================
+// WORKER ROLES (SUPPORT_WORKER and PROVIDER)
+// ============================================================================
+/**
+ * Check if user role is a worker (SUPPORT_WORKER or PROVIDER)
+ * Both roles have the same privileges and business logic
+ */
+function isWorkerRole(role) {
+    return role === enums_1.UserRole.SUPPORT_WORKER || role === enums_1.UserRole.PROVIDER;
+}
+/**
+ * Check if user is a worker (SUPPORT_WORKER or PROVIDER)
+ * Accepts any object with a role property
+ */
+function isWorker(user) {
+    return isWorkerRole(user.role);
+}
+/**
+ * Get array of worker roles for MongoDB $in queries
+ * Use this in MongoDB queries to filter for both SUPPORT_WORKER and PROVIDER
+ */
+function getWorkerRoles() {
+    return [enums_1.UserRole.SUPPORT_WORKER, enums_1.UserRole.PROVIDER];
+}
+// ============================================================================
+// HIRER ROLES (PARTICIPANT and SUPPORT_PERSON)
+// ============================================================================
+/**
+ * Check if user role is a hirer (PARTICIPANT or SUPPORT_PERSON)
+ * Hirers can create jobs and initiate conversations
+ */
+function isHirerRole(role) {
+    return role === enums_1.UserRole.PARTICIPANT || role === enums_1.UserRole.SUPPORT_PERSON;
+}
+/**
+ * Check if user is a hirer (PARTICIPANT or SUPPORT_PERSON)
+ * Accepts any object with a role property
+ */
+function isHirer(user) {
+    return isHirerRole(user.role);
+}
+/**
+ * Get array of hirer roles for MongoDB $in queries
+ * Use this in MongoDB queries to filter for both PARTICIPANT and SUPPORT_PERSON
+ */
+function getHirerRoles() {
+    return [enums_1.UserRole.PARTICIPANT, enums_1.UserRole.SUPPORT_PERSON];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@careflair/common",
-  "version": "1.0.43",
+  "version": "1.0.45",
   "description": "Shared assets for CareFlair",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",