@careflair/common 1.0.14 → 1.0.15

package/dist/utils/index.d.ts

@@ -1,6 +1,2 @@
-export * from "./phone";
-export * from "./date";
-export * from "./time";
-export * from "./debounce";
-export * from "./enum";
-export * from "./video";
+export * from "./onboarding";
+export * from "./utils";

package/dist/utils/index.js

@@ -14,15 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-// Phone validation utilities
-__exportStar(require("./phone"), exports);
-// Date formatting utilities
-__exportStar(require("./date"), exports);
-// Time/shift utilities
-__exportStar(require("./time"), exports);
-// Functional utilities
-__exportStar(require("./debounce"), exports);
-// Enum utilities
-__exportStar(require("./enum"), exports);
-// Video validation utilities
-__exportStar(require("./video"), exports);
+__exportStar(require("./onboarding"), exports);
+__exportStar(require("./utils"), exports);

package/dist/utils/onboarding.d.ts

@@ -0,0 +1,141 @@
+import { OnboardingSteps } from "../enums";
+export declare const getCurrentOnboardingStep: (completedSteps: OnboardingSteps[]) => {
+    readonly id: OnboardingSteps.ABN_AND_BUSINESS_NAME;
+    readonly isRequired: true;
+    readonly title: "ABN and Business Name";
+    readonly description: "Enter your ABN and business name to get started";
+    readonly url: "/onboarding/business-info/abn-and-business-name";
+} | {
+    readonly id: OnboardingSteps.SERVICES;
+    readonly isRequired: true;
+    readonly title: "Services";
+    readonly description: "Select the services you offer";
+    readonly url: "/onboarding/business-info/services";
+} | {
+    readonly id: OnboardingSteps.LOCATIONS;
+    readonly isRequired: true;
+    readonly title: "Locations";
+    readonly description: "Select the locations you offer";
+    readonly url: "/onboarding/business-info/locations";
+} | {
+    readonly id: OnboardingSteps.SUPPORTED_AGES;
+    readonly isRequired: false;
+    readonly title: "Supported Ages";
+    readonly description: "Select the ages you support";
+    readonly url: "/onboarding/business-info/supported-ages";
+} | {
+    readonly id: OnboardingSteps.EXPERIENCE;
+    readonly isRequired: false;
+    readonly title: "Experience";
+    readonly description: "Enter your experience";
+    readonly url: "/onboarding/personal-info/experience";
+} | {
+    readonly id: OnboardingSteps.HOURLY_RATE;
+    readonly isRequired: false;
+    readonly title: "Hourly Rate";
+    readonly description: "Enter your hourly rate";
+    readonly url: "/onboarding/personal-info/hourly-rate";
+} | {
+    readonly id: OnboardingSteps.GENDER;
+    readonly isRequired: true;
+    readonly title: "Gender";
+    readonly description: "Select your gender";
+    readonly url: "/onboarding/personal-info/gender";
+} | {
+    readonly id: OnboardingSteps.LANGUAGES;
+    readonly isRequired: false;
+    readonly title: "Languages";
+    readonly description: "Select the languages you speak";
+    readonly url: "/onboarding/personal-info/languages";
+} | {
+    readonly id: OnboardingSteps.PHONE;
+    readonly isRequired: false;
+    readonly title: "Phone";
+    readonly description: "Provides participants a direct way to reach you for jobs you apply to.";
+    readonly url: "/onboarding/personal-info/phone";
+} | {
+    readonly id: OnboardingSteps.OVERVIEW;
+    readonly isRequired: false;
+    readonly title: "Overview";
+    readonly description: "Introduce yourself to your potential clients";
+    readonly url: "/onboarding/personal-info/overview";
+} | {
+    readonly id: OnboardingSteps.PHOTO;
+    readonly isRequired: true;
+    readonly title: "Photo";
+    readonly description: "Upload a photo of yourself";
+    readonly url: "/onboarding/personal-info/photo";
+} | {
+    url: string;
+};
+export declare const getNextOnboardingStep: (currentStep: OnboardingSteps) => {
+    readonly id: OnboardingSteps.ABN_AND_BUSINESS_NAME;
+    readonly isRequired: true;
+    readonly title: "ABN and Business Name";
+    readonly description: "Enter your ABN and business name to get started";
+    readonly url: "/onboarding/business-info/abn-and-business-name";
+} | {
+    readonly id: OnboardingSteps.SERVICES;
+    readonly isRequired: true;
+    readonly title: "Services";
+    readonly description: "Select the services you offer";
+    readonly url: "/onboarding/business-info/services";
+} | {
+    readonly id: OnboardingSteps.LOCATIONS;
+    readonly isRequired: true;
+    readonly title: "Locations";
+    readonly description: "Select the locations you offer";
+    readonly url: "/onboarding/business-info/locations";
+} | {
+    readonly id: OnboardingSteps.SUPPORTED_AGES;
+    readonly isRequired: false;
+    readonly title: "Supported Ages";
+    readonly description: "Select the ages you support";
+    readonly url: "/onboarding/business-info/supported-ages";
+} | {
+    readonly id: OnboardingSteps.EXPERIENCE;
+    readonly isRequired: false;
+    readonly title: "Experience";
+    readonly description: "Enter your experience";
+    readonly url: "/onboarding/personal-info/experience";
+} | {
+    readonly id: OnboardingSteps.HOURLY_RATE;
+    readonly isRequired: false;
+    readonly title: "Hourly Rate";
+    readonly description: "Enter your hourly rate";
+    readonly url: "/onboarding/personal-info/hourly-rate";
+} | {
+    readonly id: OnboardingSteps.GENDER;
+    readonly isRequired: true;
+    readonly title: "Gender";
+    readonly description: "Select your gender";
+    readonly url: "/onboarding/personal-info/gender";
+} | {
+    readonly id: OnboardingSteps.LANGUAGES;
+    readonly isRequired: false;
+    readonly title: "Languages";
+    readonly description: "Select the languages you speak";
+    readonly url: "/onboarding/personal-info/languages";
+} | {
+    readonly id: OnboardingSteps.PHONE;
+    readonly isRequired: false;
+    readonly title: "Phone";
+    readonly description: "Provides participants a direct way to reach you for jobs you apply to.";
+    readonly url: "/onboarding/personal-info/phone";
+} | {
+    readonly id: OnboardingSteps.OVERVIEW;
+    readonly isRequired: false;
+    readonly title: "Overview";
+    readonly description: "Introduce yourself to your potential clients";
+    readonly url: "/onboarding/personal-info/overview";
+} | {
+    readonly id: OnboardingSteps.PHOTO;
+    readonly isRequired: true;
+    readonly title: "Photo";
+    readonly description: "Upload a photo of yourself";
+    readonly url: "/onboarding/personal-info/photo";
+} | null;
+export declare const getStepIndex: (stepUrl: string) => number;
+export declare const getStepFromUrl: (url: string) => OnboardingSteps;
+export declare const isStepAccessible: (stepUrl: string, completedSteps: OnboardingSteps[]) => boolean;
+export declare const isStepMandatory: (step: OnboardingSteps) => boolean | undefined;

package/dist/utils/onboarding.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isStepMandatory = exports.isStepAccessible = exports.getStepFromUrl = exports.getStepIndex = exports.getNextOnboardingStep = exports.getCurrentOnboardingStep = void 0;
+const constants_1 = require("../constants");
+const getCurrentOnboardingStep = (completedSteps) => {
+    // Find the first step that hasn't been completed
+    const nextStep = constants_1.onboardingStepsDetails.find((step) => !completedSteps.includes(step.id));
+    // If all required steps are completed, return the celebrate page
+    if (!nextStep) {
+        return {
+            url: "/onboarding/celebrate",
+        };
+    }
+    return nextStep;
+};
+exports.getCurrentOnboardingStep = getCurrentOnboardingStep;
+const getNextOnboardingStep = (currentStep) => {
+    const currentIndex = constants_1.onboardingStepsDetails.findIndex((step) => step.id === currentStep);
+    if (currentIndex === -1 ||
+        currentIndex === constants_1.onboardingStepsDetails.length - 1) {
+        return null;
+    }
+    return constants_1.onboardingStepsDetails[currentIndex + 1];
+};
+exports.getNextOnboardingStep = getNextOnboardingStep;
+// Get the index of a step in the onboarding flow
+const getStepIndex = (stepUrl) => {
+    return constants_1.onboardingStepsDetails.findIndex((step) => step.url === stepUrl);
+};
+exports.getStepIndex = getStepIndex;
+// Get the step ID from a URL
+const getStepFromUrl = (url) => {
+    // Find the step that matches the URL
+    const step = constants_1.onboardingStepsDetails.find((step) => step.url === url);
+    // If no step matches, return the first step as default
+    if (!step) {
+        // Special case for celebrate page
+        if (url === "/onboarding/celebrate") {
+            // Return the last step for the celebrate page
+            return constants_1.onboardingStepsDetails[constants_1.onboardingStepsDetails.length - 1].id;
+        }
+        return constants_1.onboardingStepsDetails[0].id;
+    }
+    return step.id;
+};
+exports.getStepFromUrl = getStepFromUrl;
+// Check if a step is accessible based on completed steps
+const isStepAccessible = (stepUrl, completedSteps) => {
+    // Special case for the celebrate page - only accessible if all required steps are completed
+    if (stepUrl === "/onboarding/celebrate") {
+        return constants_1.onboardingStepsDetails.every((step) => completedSteps.includes(step.id) || !step.isRequired);
+    }
+    // Find the index of the current step and the next allowed step
+    const stepIndex = (0, exports.getStepIndex)(stepUrl);
+    const nextStepIndex = (0, exports.getStepIndex)((0, exports.getCurrentOnboardingStep)(completedSteps).url);
+    // Step is accessible if:
+    // 1. It's a valid step in the flow
+    // 2. Either it's the next step or a step that's already been completed
+    return (stepIndex !== -1 &&
+        (stepIndex <= nextStepIndex ||
+            completedSteps.includes(constants_1.onboardingStepsDetails[stepIndex].id)));
+};
+exports.isStepAccessible = isStepAccessible;
+const isStepMandatory = (step) => {
+    return constants_1.onboardingStepsDetails.find((s) => s.id === step)?.isRequired;
+};
+exports.isStepMandatory = isStepMandatory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@careflair/common",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "description": "Shared assets for CareFlair",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,8 +9,8 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "typescript": "^5.7.4",
-    "zod": "^3.23.8"
+    "typescript": "^5.9.3",
+    "zod": "^3.25.76"
   },
   "keywords": [
     "pnp-zod"