@becollective/utils 1.10.2 → 2.0.0

package/lib/constants/locales.js

@@ -0,0 +1,191 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const distancesUnits_1 = __importDefault(require("./distancesUnits"));
+const insuranceTypes_1 = __importDefault(require("./insuranceTypes"));
+exports.default = {
+    europeanCountryCodes: [
+        'AL',
+        'AD',
+        'AM',
+        'AT',
+        'BY',
+        'BE',
+        'BA',
+        'BG',
+        'CH',
+        'CY',
+        'CZ',
+        'DE',
+        'DK',
+        'EE',
+        'ES',
+        'FO',
+        'FI',
+        'FR',
+        'GE',
+        'VA',
+        'GI',
+        'GR',
+        'HU',
+        'HR',
+        'IE',
+        'IS',
+        'IT',
+        'LT',
+        'LU',
+        'LV',
+        'MC',
+        'MK',
+        'MT',
+        'NO',
+        'NL',
+        'PO',
+        'PT',
+        'RO',
+        'RU',
+        'SE',
+        'SI',
+        'SK',
+        'SM',
+        'TR',
+        'UA',
+    ],
+    regionOptions: {
+        au: {
+            name: 'Australia',
+            domain: 'https://app.becollective.com',
+            hostname: 'app.becollective.com',
+            trademark: 'Be Collective International Limited',
+            twitter: 'https://twitter.com/BeCollective_',
+            facebook: 'https://www.facebook.com/becollectiveintl/',
+            instagram: 'https://www.instagram.com/becollective_',
+            linkedin: 'https://www.linkedin.com/company/becollectiveintl',
+            privacyPolicyUrl: 'https://www.becollective.com/documents/Be-Collective-Global-Privacy-Policy-September-2021.pdf',
+            termsAndConditionsUrl: 'https://www.becollective.com/documents/Be-Collective-Global-General-Terms-February-2023.pdf',
+            privacyPolicyVersion: 2,
+            termsAndConditionsVersion: 6,
+            address: 'Level 16, 300 Flinders Street, Melbourne, VIC 3000',
+        },
+        nz: {
+            name: 'New Zealand',
+            domain: 'https://nz.becollective.com',
+            hostname: 'nz.becollective.com',
+            trademark: 'Be Collective New Zealand Limited',
+            twitter: 'https://twitter.com/BeCollective_',
+            facebook: 'https://www.facebook.com/becollectivenz/',
+            instagram: 'https://www.instagram.com/becollective_',
+            linkedin: 'https://www.linkedin.com/company/becollectiveintl',
+            privacyPolicyUrl: 'https://www.becollective.com/documents/Be-Collective-Global-Privacy-Policy-September-2021.pdf',
+            termsAndConditionsUrl: 'https://www.becollective.com/documents/Be-Collective-Global-General-Terms-February-2023.pdf',
+            privacyPolicyVersion: 2,
+            termsAndConditionsVersion: 6,
+            address: 'Level 3 Zephyr House, 82 Willis Street, Wellington',
+        },
+        // eu: {
+        //   name: 'Europe',
+        //   domain: 'https://eu.becollective.com',
+        //   hostname: 'eu.becollective.com',
+        //   trademark: 'Be Collective Europe Limited',
+        //   twitter: 'https://twitter.com/BeCollective_',
+        //   facebook: 'https://www.facebook.com/Be-Collective-Europe-2168455776525016/',
+        //   instagram: 'https://www.instagram.com/becollective_',
+        //   linkedin: 'https://www.linkedin.com/company/becollectiveintl',
+        //   privacyPolicyUrl: 'https://www.becollective.com/documents/Be-Collective-Europe-Privacy-Notice-December-2020.pdf',
+        //   termsAndConditionsUrl: 'https://www.becollective.com/documents/Be-Collective-Europe-General-Terms-May-2023.pdf',
+        //   privacyPolicyVersion: 2,
+        //   termsAndConditionsVersion: 4,
+        //   address: 'Tintagel House, 92 Albert Embankment, Lambeth, London, SE1 7TY',
+        // },
+        uk: {
+            name: 'United Kingdom',
+            domain: 'https://uk.becollective.com',
+            hostname: 'uk.becollective.com',
+            trademark: 'Be Collective Europe Limited',
+            twitter: 'https://twitter.com/BeCollective_',
+            facebook: 'https://www.facebook.com/Be-Collective-Europe-2168455776525016/',
+            instagram: 'https://www.instagram.com/becollective_',
+            linkedin: 'https://www.linkedin.com/company/becollectiveintl',
+            privacyPolicyUrl: 'https://www.becollective.com/documents/Be-Collective-Europe-Privacy-Notice-December-2020.pdf',
+            termsAndConditionsUrl: 'https://www.becollective.com/documents/Be-Collective-Europe-General-Terms-May-2023.pdf',
+            privacyPolicyVersion: 2,
+            termsAndConditionsVersion: 4,
+            address: 'Tintagel House, 92 Albert Embankment, Lambeth, London, SE1 7TY',
+        },
+    },
+    // Financial years from https://www.cia.gov/library/publications/the-world-factbook/fields/228.html
+    countryOptions: {
+        AU: {
+            financialYearEndDate: {
+                month: 5,
+                date: 30,
+            },
+            distanceUnit: distancesUnits_1.default.km,
+            regions: [
+                {
+                    long: 'Australian Capital Territory',
+                    short: 'ACT',
+                },
+                {
+                    long: 'New South Wales',
+                    short: 'NSW',
+                },
+                {
+                    long: 'Northern Territory',
+                    short: 'NT',
+                },
+                {
+                    long: 'Queensland',
+                    short: 'QLD',
+                },
+                {
+                    long: 'South Australia',
+                    short: 'SA',
+                },
+                {
+                    long: 'Tasmania',
+                    short: 'TAS',
+                },
+                {
+                    long: 'Victoria',
+                    short: 'VIC',
+                },
+                {
+                    long: 'Western Australia',
+                    short: 'WA',
+                },
+            ],
+            insuranceTypes: [insuranceTypes_1.default.publicLiabilityAU, insuranceTypes_1.default.volunteerAccidentAU],
+        },
+        NZ: {
+            financialYearEndDate: {
+                month: 2,
+                date: 31,
+            },
+            distanceUnit: distancesUnits_1.default.km,
+            insuranceTypes: [insuranceTypes_1.default.publicLiabilityNZ, insuranceTypes_1.default.volunteerAccidentNZ],
+        },
+        GB: {
+            financialYearEndDate: {
+                month: 3,
+                date: 5,
+            },
+            distanceUnit: distancesUnits_1.default.mi,
+            insuranceTypes: [insuranceTypes_1.default.publicLiabilityGB, insuranceTypes_1.default.volunteerAccidentGB],
+        },
+        // Reminder: this is Republic of Ireland. Northern Ireland is within GB.
+        IE: {
+            financialYearEndDate: {
+                month: 11,
+                date: 31,
+            },
+            distanceUnit: distancesUnits_1.default.km,
+            insuranceTypes: [insuranceTypes_1.default.publicLiabilityOthers, insuranceTypes_1.default.volunteerAccidentOthers],
+        },
+        Others: {
+            insuranceTypes: [insuranceTypes_1.default.publicLiabilityOthers, insuranceTypes_1.default.volunteerAccidentOthers],
+        },
+    },
+};

package/lib/constants/notifications.d.ts

@@ -0,0 +1,47 @@
+declare const _default: {
+    types: (string | {
+        messengerUpdates: string;
+        volunteerUpdates: string;
+        groupMemberUpdates: string;
+        groupInvitations: string;
+        opportunityInvitations: string;
+        opportunitiesSharedWithMe: string;
+        licenseCertificateExpiryNotice: string;
+        certificates: string;
+    } | {
+        membershipApplications: string;
+        volunteerApplications: string;
+        opportunityUpdates: string;
+        timesheets: string;
+        partnerships: string;
+        endorsements: string;
+        socialCurrency: string;
+        groupUpdates: string;
+        licenseCertificateExpiryNotice: string;
+    })[];
+    typesMap: {
+        volunteer: {
+            messengerUpdates: string;
+            volunteerUpdates: string;
+            groupMemberUpdates: string;
+            groupInvitations: string;
+            opportunityInvitations: string;
+            opportunitiesSharedWithMe: string;
+            licenseCertificateExpiryNotice: string;
+            certificates: string;
+        };
+        manager: {
+            membershipApplications: string;
+            volunteerApplications: string;
+            opportunityUpdates: string;
+            timesheets: string;
+            partnerships: string;
+            endorsements: string;
+            socialCurrency: string;
+            groupUpdates: string;
+            licenseCertificateExpiryNotice: string;
+        };
+        acquired: string;
+    };
+};
+export default _default;

package/lib/constants/notifications.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const notificationTypes = {
+    volunteer: {
+        messengerUpdates: 'messengerUpdates',
+        volunteerUpdates: 'volunteerUpdates',
+        groupMemberUpdates: 'groupMemberUpdates',
+        groupInvitations: 'groupInvitations',
+        opportunityInvitations: 'opportunityInvitations',
+        opportunitiesSharedWithMe: 'opportunitiesSharedWithMe',
+        licenseCertificateExpiryNotice: 'licenseCertificateExpiryNotice',
+        certificates: 'certificates',
+    },
+    manager: {
+        membershipApplications: 'membershipApplications',
+        volunteerApplications: 'volunteerApplications',
+        opportunityUpdates: 'opportunityUpdates',
+        timesheets: 'timesheets',
+        partnerships: 'partnerships',
+        endorsements: 'endorsements',
+        socialCurrency: 'socialCurrency',
+        groupUpdates: 'groupUpdates',
+        licenseCertificateExpiryNotice: 'licenseCertificateExpiryNotice',
+    },
+    acquired: 'acquired',
+};
+exports.default = {
+    // Filter out acquired, as backend model does not use it.
+    types: Object.values(notificationTypes).filter((x) => x !== notificationTypes.acquired),
+    typesMap: notificationTypes,
+};

package/lib/constants/opportunities.d.ts

@@ -0,0 +1,72 @@
+declare const _default: {
+    types: string[];
+    typesMap: {
+        roleFixed: string;
+        roleFlexible: string;
+        ongoing: string;
+    };
+    typesV2: string[];
+    typesMapV2: {
+        shift: string;
+        flexible: string;
+    };
+    statuses: string[];
+    volunteer: {
+        shiftStatus: {
+            approved: string;
+            cancelled: string;
+            left: string;
+        };
+        ruleStatus: {
+            approved: string;
+            cancelled: string;
+        };
+        volunteerStatus: {
+            approved: string;
+            pending: string;
+            invited: string;
+            declined: string;
+            left: string;
+        };
+    };
+    checklist: {
+        key: string;
+        value: string;
+    }[];
+    defaultOptions: {
+        details: {
+            currentJobTitle: string;
+            dateOfBirth: string;
+            emergencyContactDetails: string;
+            gender: string;
+            homeAddress: string;
+            phoneNumber: string;
+        };
+        requirements: {
+            driversLicense: string;
+            firstAidCertificate: string;
+            orientation: string;
+            policeCheck: string;
+            training: string;
+            workingWithChildrenCheck: string;
+        };
+        suitability: {
+            families: string;
+            deafHardOfHearing: string;
+            intellectuallyDisabled: string;
+            largeGroups: string;
+            skilledVolunteers: string;
+            travellingShortTermVolunteers: string;
+            blindLowVision: string;
+            volunteersWithLimitedEnglish: string;
+            wheelchairUsers: string;
+            workingExperience: string;
+            employeeVolunteers: string;
+            socialPrescribing: string;
+            publicTransportUsers: string;
+            LGBTQIAPlusCommunity: string;
+            LongTermVolunteers: string;
+        };
+    };
+};
+export default _default;

package/lib/constants/opportunities.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const typesMap = {
+    roleFixed: 'role-fixed',
+    roleFlexible: 'role-flexible',
+    ongoing: 'ongoing',
+};
+const typesMapV2 = {
+    shift: 'shift',
+    flexible: 'flexible',
+};
+const ruleStatus = {
+    approved: 'approved',
+    cancelled: 'cancelled',
+};
+const shiftStatus = {
+    approved: 'approved',
+    cancelled: 'cancelled',
+    left: 'left',
+};
+const volunteerStatus = {
+    approved: 'approved',
+    pending: 'pending',
+    invited: 'invited',
+    declined: 'declined',
+    left: 'left',
+};
+exports.default = {
+    types: Object.values(typesMap),
+    typesMap,
+    typesV2: Object.values(typesMapV2),
+    typesMapV2,
+    statuses: ['draft', 'pending', 'published', 'cancelled'],
+    volunteer: {
+        shiftStatus: shiftStatus,
+        ruleStatus: ruleStatus,
+        volunteerStatus: volunteerStatus,
+    },
+    checklist: [
+        { key: 'interview', value: 'Interview' },
+        { key: 'police-check', value: 'Police Check' },
+        { key: 'reference-check', value: 'Reference Check' },
+        { key: 'screening', value: 'Screening' },
+        { key: 'training', value: 'Training' },
+        { key: 'trial', value: 'Check' },
+    ],
+    defaultOptions: {
+        details: {
+            currentJobTitle: 'Current Job Title',
+            dateOfBirth: 'Date of Birth',
+            emergencyContactDetails: 'Emergency Contact Details',
+            gender: 'Gender',
+            homeAddress: 'Home Address',
+            phoneNumber: 'Phone Number',
+        },
+        requirements: {
+            driversLicense: 'Drivers License',
+            firstAidCertificate: 'First Aid Certificate',
+            orientation: 'Orientation',
+            policeCheck: 'Police Check',
+            training: 'Training',
+            workingWithChildrenCheck: 'Working with Children Check',
+        },
+        suitability: {
+            families: 'Families',
+            deafHardOfHearing: 'Deaf/hard of hearing',
+            intellectuallyDisabled: 'Intellectual/learning disabilities',
+            largeGroups: 'Large groups (10+)',
+            skilledVolunteers: 'Skilled volunteers',
+            travellingShortTermVolunteers: 'Travelling/short term volunteers',
+            blindLowVision: 'Blind/low vision',
+            volunteersWithLimitedEnglish: 'Volunteers with limited English',
+            wheelchairUsers: 'Wheelchair users',
+            workingExperience: 'Work experience',
+            employeeVolunteers: 'Employee volunteers',
+            socialPrescribing: 'Social prescribing',
+            publicTransportUsers: 'Public transport users',
+            LGBTQIAPlusCommunity: 'LGBTQIA+ community',
+            LongTermVolunteers: 'Long term volunteers',
+        },
+    },
+};

package/lib/constants/qualificationTypes.d.ts

@@ -0,0 +1,4 @@
+export declare const licencesAndCertifications: string[];
+export declare const educationalQualifications: string[];
+declare const _default: string[];
+export default _default;

package/lib/constants/qualificationTypes.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.educationalQualifications = exports.licencesAndCertifications = void 0;
+exports.licencesAndCertifications = [
+    'Drivers Licence',
+    'First Aid Certification',
+    'Working with Children Check',
+    'Other', // Other option should always be anchored to the bottom.
+];
+exports.educationalQualifications = [
+    'Secondary / High School',
+    'Certificate or equivalent',
+    'Diploma or equivalent',
+    'Advanced Diploma or equivalent',
+    "Bachelor's Degree / Undergraduate",
+    "Master's Degree / Postgraduate and above",
+];
+exports.default = [...exports.licencesAndCertifications, ...exports.educationalQualifications];

package/lib/constants/rules.d.ts

@@ -0,0 +1,13 @@
+declare const _default: {
+    daysOfTheWeek: {
+        label: string;
+        value: import("rrule").Weekday;
+        selected: boolean;
+    }[];
+    frequencyOptions: {
+        value: number;
+        label: string;
+        description: string;
+    }[];
+};
+export default _default;

package/lib/constants/rules.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const rrule_1 = require("rrule");
+const daysOfTheWeek = [
+    { label: 'Monday', value: rrule_1.RRule.MO, selected: false },
+    { label: 'Tuesday', value: rrule_1.RRule.TU, selected: false },
+    { label: 'Wednesday', value: rrule_1.RRule.WE, selected: false },
+    { label: 'Thursday', value: rrule_1.RRule.TH, selected: false },
+    { label: 'Friday', value: rrule_1.RRule.FR, selected: false },
+    { label: 'Saturday', value: rrule_1.RRule.SA, selected: false },
+    { label: 'Sunday', value: rrule_1.RRule.SU, selected: false },
+];
+const frequencyOptions = [
+    { value: 0, label: 'in total', description: '' },
+    { value: rrule_1.RRule.WEEKLY, label: 'per week', description: 'each week' },
+    { value: rrule_1.RRule.MONTHLY, label: 'per month', description: 'each month' },
+];
+exports.default = {
+    daysOfTheWeek,
+    frequencyOptions,
+};

package/lib/constants/subscriptions.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    tierValues: {
+        none: number;
+        standard: number;
+        plus: number;
+        pro: number;
+    };
+};
+export default _default;

package/lib/constants/subscriptions.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    tierValues: {
+        none: 0, // none of the below tiers
+        standard: 1,
+        plus: 2,
+        pro: 3,
+    },
+};

package/lib/constants/surveys.d.ts

@@ -0,0 +1,16 @@
+declare const _default: {
+    participantStatuses: {
+        notSent: string;
+        sent: string;
+        reSent: string;
+        responded: string;
+    };
+    subscriptionDowngradeReasons: {
+        featureLack: string;
+        expense: string;
+        difficulty: string;
+        technicalIssues: string;
+        other: string;
+    };
+};
+export default _default;

package/lib/constants/surveys.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    participantStatuses: {
+        notSent: 'not-sent',
+        sent: 'sent',
+        reSent: 're-sent',
+        responded: 'responded',
+    },
+    subscriptionDowngradeReasons: {
+        featureLack: 'Features not useful / missing features we need',
+        expense: 'Too expensive',
+        difficulty: 'Difficult to use',
+        technicalIssues: 'Technical issues',
+        other: 'Other',
+    },
+};

package/lib/constants.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/constants.js

@@ -0,0 +1,76 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const allowedHtmlTags_1 = __importDefault(require("./constants/allowedHtmlTags"));
+const avatarColours_1 = __importDefault(require("./constants/avatarColours"));
+const countries_1 = __importDefault(require("./constants/countries"));
+const customFields_1 = __importDefault(require("./constants/customFields"));
+const languages_1 = __importDefault(require("./constants/languages"));
+const currencies_1 = __importDefault(require("./constants/currencies"));
+const distancesUnits_1 = __importDefault(require("./constants/distancesUnits"));
+const groups_1 = __importDefault(require("./constants/groups"));
+const insuranceStatuses_1 = __importDefault(require("./constants/insuranceStatuses"));
+const insuranceTypes_1 = __importDefault(require("./constants/insuranceTypes"));
+const locales_1 = __importDefault(require("./constants/locales"));
+const notifications_1 = __importDefault(require("./constants/notifications"));
+const opportunities_1 = __importDefault(require("./constants/opportunities"));
+const rules_1 = __importDefault(require("./constants/rules"));
+const subscriptions_1 = __importDefault(require("./constants/subscriptions"));
+const surveys_1 = __importDefault(require("./constants/surveys"));
+const qualificationTypes_1 = __importStar(require("./constants/qualificationTypes"));
+module.exports = {
+    allowedHtmlTags: allowedHtmlTags_1.default,
+    avatarColours: avatarColours_1.default,
+    currencies: currencies_1.default,
+    customFields: customFields_1.default,
+    countries: countries_1.default,
+    languages: languages_1.default,
+    distanceUnits: distancesUnits_1.default,
+    groups: groups_1.default,
+    insuranceStatuses: insuranceStatuses_1.default,
+    insuranceTypes: insuranceTypes_1.default,
+    locales: locales_1.default,
+    notifications: notifications_1.default,
+    opportunities: opportunities_1.default,
+    qualificationTypes: qualificationTypes_1.default,
+    licencesAndCertifications: qualificationTypes_1.licencesAndCertifications,
+    educationalQualifications: qualificationTypes_1.educationalQualifications,
+    surveys: surveys_1.default,
+    subscriptions: subscriptions_1.default,
+    rules: rules_1.default,
+};

package/lib/date-time.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Get current age based on the given birth date
+ * @param {string} dateOfBirth
+ * @param {string} unit the measurement of the the difference
+ *  The supported measurements are:
+ *  years, months, weeks, days, hours, minutes, and seconds.
+ * @returns {number} age
+ */
+export declare const getAge: (dateOfBirth: any, unit?: string) => number;
+/**
+ * Check if a user requires parent(guardian) consent
+ * i.e. Is under the age of 16 years, based on GDPR
+ * https://gdpr-info.eu/art-8-gdpr/
+ * @param {string} dateOfBirth moment.js compatible date time
+ * @returns {boolean}
+ * NOTE:
+ * We used to not allow child (under 16) to register,
+ * and birthdate is not a required field for ghost user
+ * So an existing user could have no birthdate, we assume these users are adults
+ * TODO:
+ * Remove above logic after we migrated all legacy
+ * data to have a consistent birthdate property.
+ * Then we should throw error if birthdate is not valid
+ */
+export declare const isUnderSixteen: (dateOfBirth: any) => boolean;
+export declare const isUnderAge: (dateOfBirth: any, limit: any, maxAcknowledgedAge?: number | null) => boolean;
+export declare const datesByThemselves: (a: any, b: any) => number;
+export declare const getShiftText: (from: any, to: any, timezone: any) => string;