@becollective/utils 2.0.0 → 2.0.2

package/lib/constants/currencies.d.ts

@@ -3,27 +3,27 @@ declare const _default: {
         code: string;
         name: string;
         minorUnit: number;
-        symbol: any;
+        symbol: string | undefined;
         prefix: string;
     };
     NZD: {
         code: string;
         name: string;
         minorUnit: number;
-        symbol: any;
+        symbol: string | undefined;
         prefix: string;
     };
     GBP: {
         code: string;
         name: string;
         minorUnit: number;
-        symbol: any;
+        symbol: string | undefined;
     };
     EUR: {
         code: string;
         name: string;
         minorUnit: number;
-        symbol: any;
+        symbol: string | undefined;
     };
 };
 export default _default;

package/lib/constants.d.ts

@@ -1 +1,677 @@
-export {};
+export declare const constants: {
+    allowedHtmlTags: {
+        allowedTags: string[];
+        allowedAttributes: {
+            a: string[];
+        };
+    };
+    avatarColours: {
+        watusi: {
+            backgroundColour: string;
+            textColour: string;
+        };
+        hawkesBlue: {
+            backgroundColour: string;
+            textColour: string;
+        };
+        botticelli: {
+            backgroundColour: string;
+            textColour: string;
+        };
+        surfCrest: {
+            backgroundColour: string;
+            textColour: string;
+        };
+        quarterSpanishWhite: {
+            backgroundColour: string;
+            textColour: string;
+        };
+        buttermilk: {
+            backgroundColour: string;
+            textColour: string;
+        };
+        fog: {
+            backgroundColour: string;
+            textColour: string;
+        };
+        mabel: {
+            backgroundColour: string;
+            textColour: string;
+        };
+    };
+    currencies: {
+        AUD: {
+            code: string;
+            name: string;
+            minorUnit: number;
+            symbol: string | undefined;
+            prefix: string;
+        };
+        NZD: {
+            code: string;
+            name: string;
+            minorUnit: number;
+            symbol: string | undefined;
+            prefix: string;
+        };
+        GBP: {
+            code: string;
+            name: string;
+            minorUnit: number;
+            symbol: string | undefined;
+        };
+        EUR: {
+            code: string;
+            name: string;
+            minorUnit: number;
+            symbol: string | undefined;
+        };
+    };
+    customFields: {
+        maxMongoStringLength: number;
+        maxFileSizeBytes: number;
+        emailReferenceHeadingString: string;
+        uploadBatchSize: number;
+        fNameReferenceHeadingString: string;
+        lNameReferenceHeadingString: string;
+        maxNumberOfRows: number;
+        templateFileName: string;
+    };
+    countries: {
+        BD: string;
+        BE: string;
+        BF: string;
+        BG: string;
+        BA: string;
+        BB: string;
+        WF: string;
+        BL: string;
+        BM: string;
+        BN: string;
+        BO: string;
+        BH: string;
+        BI: string;
+        BJ: string;
+        BT: string;
+        JM: string;
+        BV: string;
+        BW: string;
+        WS: string;
+        BQ: string;
+        BR: string;
+        BS: string;
+        JE: string;
+        BY: string;
+        BZ: string;
+        RU: string;
+        RW: string;
+        RS: string;
+        TL: string;
+        RE: string;
+        TM: string;
+        TJ: string;
+        RO: string;
+        TK: string;
+        GW: string;
+        GU: string;
+        GT: string;
+        GS: string;
+        GR: string;
+        GQ: string;
+        GP: string;
+        JP: string;
+        GY: string;
+        GG: string;
+        GF: string;
+        GE: string;
+        GD: string;
+        GB: string;
+        GA: string;
+        SV: string;
+        GN: string;
+        GM: string;
+        GL: string;
+        GI: string;
+        GH: string;
+        OM: string;
+        TN: string;
+        JO: string;
+        HR: string;
+        HT: string;
+        HU: string;
+        HK: string;
+        HN: string;
+        HM: string;
+        VE: string;
+        PR: string;
+        PS: string;
+        PW: string;
+        PT: string;
+        SJ: string;
+        PY: string;
+        IQ: string;
+        PA: string;
+        PF: string;
+        PG: string;
+        PE: string;
+        PK: string;
+        PH: string;
+        PN: string;
+        PL: string;
+        PM: string;
+        ZM: string;
+        EH: string;
+        EE: string;
+        EG: string;
+        ZA: string;
+        EC: string;
+        IT: string;
+        VN: string;
+        SB: string;
+        ET: string;
+        SO: string;
+        ZW: string;
+        SA: string;
+        ES: string;
+        ER: string;
+        ME: string;
+        MD: string;
+        MG: string;
+        MF: string;
+        MA: string;
+        MC: string;
+        UZ: string;
+        MM: string;
+        ML: string;
+        MO: string;
+        MN: string;
+        MH: string;
+        MK: string;
+        MU: string;
+        MT: string;
+        MW: string;
+        MV: string;
+        MQ: string;
+        MP: string;
+        MS: string;
+        MR: string;
+        IM: string;
+        UG: string;
+        TZ: string;
+        MY: string;
+        MX: string;
+        IL: string;
+        FR: string;
+        IO: string;
+        SH: string;
+        FI: string;
+        FJ: string;
+        FK: string;
+        FM: string;
+        FO: string;
+        NI: string;
+        NL: string;
+        NO: string;
+        NA: string;
+        VU: string;
+        NC: string;
+        NE: string;
+        NF: string;
+        NG: string;
+        NZ: string;
+        NP: string;
+        NR: string;
+        NU: string;
+        CK: string;
+        XK: string;
+        CI: string;
+        CH: string;
+        CO: string;
+        CN: string;
+        CM: string;
+        CL: string;
+        CC: string;
+        CA: string;
+        CG: string;
+        CF: string;
+        CD: string;
+        CZ: string;
+        CY: string;
+        CX: string;
+        CR: string;
+        CW: string;
+        CV: string;
+        CU: string;
+        SZ: string;
+        SY: string;
+        SX: string;
+        KG: string;
+        KE: string;
+        SS: string;
+        SR: string;
+        KI: string;
+        KH: string;
+        KN: string;
+        KM: string;
+        ST: string;
+        SK: string;
+        KR: string;
+        SI: string;
+        KP: string;
+        KW: string;
+        SN: string;
+        SM: string;
+        SL: string;
+        SC: string;
+        KZ: string;
+        KY: string;
+        SG: string;
+        SE: string;
+        SD: string;
+        DO: string;
+        DM: string;
+        DJ: string;
+        DK: string;
+        VG: string;
+        DE: string;
+        YE: string;
+        DZ: string;
+        US: string;
+        UY: string;
+        YT: string;
+        UM: string;
+        LB: string;
+        LC: string;
+        LA: string;
+        TV: string;
+        TW: string;
+        TT: string;
+        TR: string;
+        LK: string;
+        LI: string;
+        LV: string;
+        TO: string;
+        LT: string;
+        LU: string;
+        LR: string;
+        LS: string;
+        TH: string;
+        TF: string;
+        TG: string;
+        TD: string;
+        TC: string;
+        LY: string;
+        VA: string;
+        VC: string;
+        AE: string;
+        AD: string;
+        AG: string;
+        AF: string;
+        AI: string;
+        VI: string;
+        IS: string;
+        IR: string;
+        AM: string;
+        AL: string;
+        AO: string;
+        AQ: string;
+        AS: string;
+        AR: string;
+        AU: string;
+        AT: string;
+        AW: string;
+        IN: string;
+        AX: string;
+        AZ: string;
+        IE: string;
+        ID: string;
+        UA: string;
+        QA: string;
+        MZ: string;
+    };
+    languages: string[];
+    distanceUnits: {
+        km: {
+            long: string;
+            short: string;
+        };
+        mi: {
+            long: string;
+            short: string;
+        };
+    };
+    groups: {
+        maxNumberOfGroupMembers: number;
+        defaultOptions: {
+            details: string[];
+            requirements: string[];
+            industries: string[];
+        };
+        groupTypes: {
+            name: string;
+            value: string;
+        }[];
+    };
+    insuranceStatuses: {
+        INSURED: {
+            value: string;
+            label: string;
+        };
+        UNINSURED: {
+            value: string;
+            label: string;
+        };
+        AUSPICED: {
+            value: string;
+            label: string;
+        };
+    };
+    insuranceTypes: {
+        publicLiabilityAU: {
+            type: string;
+            label: string;
+        };
+        volunteerAccidentAU: {
+            type: string;
+            label: string;
+        };
+        publicLiabilityGB: {
+            type: string;
+            label: string;
+        };
+        volunteerAccidentGB: {
+            type: string;
+            label: string;
+        };
+        publicLiabilityNZ: {
+            type: string;
+            label: string;
+        };
+        volunteerAccidentNZ: {
+            type: string;
+            label: string;
+        };
+        publicLiabilityOthers: {
+            type: string;
+            label: string;
+        };
+        volunteerAccidentOthers: {
+            type: string;
+            label: string;
+        };
+    };
+    locales: {
+        europeanCountryCodes: string[];
+        regionOptions: {
+            au: {
+                name: string;
+                domain: string;
+                hostname: string;
+                trademark: string;
+                twitter: string;
+                facebook: string;
+                instagram: string;
+                linkedin: string;
+                privacyPolicyUrl: string;
+                termsAndConditionsUrl: string;
+                privacyPolicyVersion: number;
+                termsAndConditionsVersion: number;
+                address: string;
+            };
+            nz: {
+                name: string;
+                domain: string;
+                hostname: string;
+                trademark: string;
+                twitter: string;
+                facebook: string;
+                instagram: string;
+                linkedin: string;
+                privacyPolicyUrl: string;
+                termsAndConditionsUrl: string;
+                privacyPolicyVersion: number;
+                termsAndConditionsVersion: number;
+                address: string;
+            };
+            uk: {
+                name: string;
+                domain: string;
+                hostname: string;
+                trademark: string;
+                twitter: string;
+                facebook: string;
+                instagram: string;
+                linkedin: string;
+                privacyPolicyUrl: string;
+                termsAndConditionsUrl: string;
+                privacyPolicyVersion: number;
+                termsAndConditionsVersion: number;
+                address: string;
+            };
+        };
+        countryOptions: {
+            AU: {
+                financialYearEndDate: {
+                    month: number;
+                    date: number;
+                };
+                distanceUnit: {
+                    long: string;
+                    short: string;
+                };
+                regions: {
+                    long: string;
+                    short: string;
+                }[];
+                insuranceTypes: {
+                    type: string;
+                    label: string;
+                }[];
+            };
+            NZ: {
+                financialYearEndDate: {
+                    month: number;
+                    date: number;
+                };
+                distanceUnit: {
+                    long: string;
+                    short: string;
+                };
+                insuranceTypes: {
+                    type: string;
+                    label: string;
+                }[];
+            };
+            GB: {
+                financialYearEndDate: {
+                    month: number;
+                    date: number;
+                };
+                distanceUnit: {
+                    long: string;
+                    short: string;
+                };
+                insuranceTypes: {
+                    type: string;
+                    label: string;
+                }[];
+            };
+            IE: {
+                financialYearEndDate: {
+                    month: number;
+                    date: number;
+                };
+                distanceUnit: {
+                    long: string;
+                    short: string;
+                };
+                insuranceTypes: {
+                    type: string;
+                    label: string;
+                }[];
+            };
+            Others: {
+                insuranceTypes: {
+                    type: string;
+                    label: string;
+                }[];
+            };
+        };
+    };
+    notifications: {
+        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;
+        };
+    };
+    opportunities: {
+        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;
+            };
+        };
+    };
+    qualificationTypes: string[];
+    licencesAndCertifications: string[];
+    educationalQualifications: string[];
+    surveys: {
+        participantStatuses: {
+            notSent: string;
+            sent: string;
+            reSent: string;
+            responded: string;
+        };
+        subscriptionDowngradeReasons: {
+            featureLack: string;
+            expense: string;
+            difficulty: string;
+            technicalIssues: string;
+            other: string;
+        };
+    };
+    subscriptions: {
+        tierValues: {
+            none: number;
+            standard: number;
+            plus: number;
+            pro: number;
+        };
+    };
+    rules: {
+        daysOfTheWeek: {
+            label: string;
+            value: import("rrule").Weekday;
+            selected: boolean;
+        }[];
+        frequencyOptions: {
+            value: number;
+            label: string;
+            description: string;
+        }[];
+    };
+};
+export default constants;

package/lib/constants.js

@@ -36,6 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.constants = void 0;
 const allowedHtmlTags_1 = __importDefault(require("./constants/allowedHtmlTags"));
 const avatarColours_1 = __importDefault(require("./constants/avatarColours"));
 const countries_1 = __importDefault(require("./constants/countries"));
@@ -53,7 +54,7 @@ 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 = {
+exports.constants = {
     allowedHtmlTags: allowedHtmlTags_1.default,
     avatarColours: avatarColours_1.default,
     currencies: currencies_1.default,
@@ -74,3 +75,4 @@ module.exports = {
     subscriptions: subscriptions_1.default,
     rules: rules_1.default,
 };
+exports.default = exports.constants;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@becollective/utils",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Common utilities",
-  "main": "bundle.js",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
     "test": "npm run build && NODE_ENV=localtest jest --config jestconfig.json --detectOpenHandles --verbose --forceExit",
     "build": "tsc",
@@ -23,8 +24,8 @@
     "typescript": "^6.0.3"
   },
   "dependencies": {
-    "@becollective/constants": "^3.11.0",
     "ajv": "^8.20.0",
+    "currency-symbol-map": "^5.1.0",
     "libphonenumber-js": "^1.13.5",
     "luxon": "^3.7.2",
     "rrule": "^2.8.1"

package/src/constants.ts

@@ -17,7 +17,7 @@ import surveys from './constants/surveys';
 
 import qualificationTypes, { licencesAndCertifications, educationalQualifications } from './constants/qualificationTypes';
 
-module.exports = {
+export const constants = {
   allowedHtmlTags,
   avatarColours,
   currencies,
@@ -38,3 +38,5 @@ module.exports = {
   subscriptions,
   rules,
 };
+
+export default constants;