@beabee/beabee-common 0.21.1-alpha.1 → 0.44.2

package/dist/utils/payments.js

@@ -0,0 +1,39 @@
+import { ContributionPeriod, PaymentMethod } from '../data/index.js';
+const stripeFees = {
+    gb: {
+        [PaymentMethod.StripeCard]: (amount) => 0.2 + 0.015 * amount,
+        [PaymentMethod.StripeSEPA]: () => 0.3,
+        [PaymentMethod.StripeBACS]: (amount) => Math.min(2, Math.max(0.2, 0.01 * amount)),
+        [PaymentMethod.StripePayPal]: (amount) => 0.1 + 0.02 * amount,
+        [PaymentMethod.StripeIdeal]: () => 0.3, // Becomes a SEPA so same fee
+    },
+    eu: {
+        [PaymentMethod.StripeCard]: (amount) => 0.25 + 0.015 * amount,
+        [PaymentMethod.StripeSEPA]: () => 0.35,
+        [PaymentMethod.StripeBACS]: () => 0, // Not available
+        [PaymentMethod.StripePayPal]: (amount) => 0.1 + 0.02 * amount,
+        [PaymentMethod.StripeIdeal]: () => 0.35, // Becomes a SEPA so same fee
+    },
+    ca: {
+        [PaymentMethod.StripeCard]: (amount) => 0.3 + 0.029 * amount,
+        [PaymentMethod.StripeSEPA]: () => 0, // Not available
+        [PaymentMethod.StripeBACS]: () => 0, // Not available
+        [PaymentMethod.StripePayPal]: () => 0, // Not available
+        [PaymentMethod.StripeIdeal]: () => 0, // Not available
+    },
+};
+const gcFee = (amount) => 0.2 + amount * 0.01;
+export function calcPaymentFee(feeable, country) {
+    const feeFn = feeable.paymentMethod === PaymentMethod.GoCardlessDirectDebit
+        ? gcFee
+        : stripeFees[country][feeable.paymentMethod];
+    if (!feeFn) {
+        const error = new Error(`No fee function found for "${feeable.paymentMethod}" in "${country}". Please check that the payment methods have been configured correctly.`);
+        console.error(error);
+        return 0;
+    }
+    return feeable.period === ContributionPeriod.Annually
+        ? 0
+        : feeFn(feeable.amount);
+}
+//# sourceMappingURL=payments.js.map

package/dist/utils/payments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payments.js","sourceRoot":"","sources":["../../src/utils/payments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGrE,MAAM,UAAU,GAAG;IACjB,EAAE,EAAE;QACF,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,GAAG,MAAM;QACpE,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG;QACrC,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC,MAAc,EAAE,EAAE,CAC7C,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,MAAM,CAAC,CAAC;QAC3C,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,GAAG,MAAM;QACrE,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,6BAA6B;KACtE;IACD,EAAE,EAAE;QACF,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,GAAG,KAAK,GAAG,MAAM;QACrE,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI;QACtC,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,gBAAgB;QACrD,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,GAAG,MAAM;QACrE,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,6BAA6B;KACvE;IACD,EAAE,EAAE;QACF,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,GAAG,MAAM;QACpE,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,gBAAgB;QACrD,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,gBAAgB;QACrD,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,gBAAgB;QACvD,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,gBAAgB;KACvD;CACO,CAAC;AAEX,MAAM,KAAK,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,GAAG,IAAI,CAAC;AAEtD,MAAM,UAAU,cAAc,CAC5B,OAAgB,EAChB,OAAyB;IAEzB,MAAM,KAAK,GACT,OAAO,CAAC,aAAa,KAAK,aAAa,CAAC,qBAAqB;QAC3D,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAEjD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,KAAK,GAAG,IAAI,KAAK,CACrB,8BAA8B,OAAO,CAAC,aAAa,SAAS,OAAO,0EAA0E,CAC9I,CAAC;QACF,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,OAAO,CAAC,MAAM,KAAK,kBAAkB,CAAC,QAAQ;QACnD,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC"}

package/dist/utils/rules.d.ts

@@ -0,0 +1,33 @@
+import type { Filters, Rule, RuleGroup, ValidatedRule, ValidatedRuleGroup } from '../types/index.js';
+/**
+ * Type guard to check if a rule or group is a rule group
+ * @param ruleOrGroup The rule or group to check
+ * @returns True if the input is a rule group, false otherwise
+ */
+export declare function isRuleGroup(ruleOrGroup: Rule | RuleGroup): ruleOrGroup is RuleGroup;
+/**
+ * Validates a rule against a set of valid filters.  This method checks that the
+ * rule field exists, that it is using a valid operator for the field type, and
+ * that it has the correct number and type of arguments.
+ *
+ * @param filters The valid filters
+ * @param rule The rule to validate
+ * @returns The validated rule
+ */
+export declare function validateRule<Field extends string>(filters: Filters<Field>, rule: Rule): ValidatedRule<Field>;
+/**
+ * Validates a rule group and its rules recursively against a set of valid
+ * filters
+ *
+ * @param filters The valid filters
+ * @param ruleGroup The rule group to validate
+ * @returns The validated rule group
+ */
+export declare function validateRuleGroup<Field extends string>(filters: Filters<Field>, ruleGroup: RuleGroup): ValidatedRuleGroup<Field>;
+/**
+ * Flattens a rule group into an simple array of rules
+ * @param ruleGroup The rule group to flatten
+ * @returns An array of rules
+ */
+export declare function flattenRules(ruleGroup: RuleGroup): Rule[];
+//# sourceMappingURL=rules.d.ts.map

package/dist/utils/rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../../src/utils/rules.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,OAAO,EACP,IAAI,EACJ,SAAS,EACT,aAAa,EACb,kBAAkB,EACnB,MAAM,mBAAmB,CAAC;AAG3B;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,WAAW,EAAE,IAAI,GAAG,SAAS,GAC5B,WAAW,IAAI,SAAS,CAE1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,KAAK,SAAS,MAAM,EAC/C,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,EACvB,IAAI,EAAE,IAAI,GACT,aAAa,CAAC,KAAK,CAAC,CAyEtB;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,SAAS,MAAM,EACpD,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,EACvB,SAAS,EAAE,SAAS,GACnB,kBAAkB,CAAC,KAAK,CAAC,CAa3B;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,EAAE,CAIzD"}

package/dist/utils/rules.js

@@ -0,0 +1,94 @@
+import { InvalidRule } from '../error/index.js';
+import { nullableOperators, operatorsByTypeMap } from '../search/index.js';
+import { isValidDate } from './date.js';
+/**
+ * Type guard to check if a rule or group is a rule group
+ * @param ruleOrGroup The rule or group to check
+ * @returns True if the input is a rule group, false otherwise
+ */
+export function isRuleGroup(ruleOrGroup) {
+    return 'condition' in ruleOrGroup;
+}
+/**
+ * Validates a rule against a set of valid filters.  This method checks that the
+ * rule field exists, that it is using a valid operator for the field type, and
+ * that it has the correct number and type of arguments.
+ *
+ * @param filters The valid filters
+ * @param rule The rule to validate
+ * @returns The validated rule
+ */
+export function validateRule(filters, rule) {
+    const filter = filters[rule.field];
+    if (!filter) {
+        throw new InvalidRule(rule, `Invalid field: ${rule.field}`);
+    }
+    let expectedArgs = 0;
+    if (rule.operator in nullableOperators) {
+        // Field cannot be empty (except text which can always be empty)
+        if (!filter.nullable && filter.type !== 'text' && filter.type !== 'array') {
+            throw new InvalidRule(rule, `Invalid nullable operator: field is not nullable`);
+        }
+    }
+    else {
+        const operator = operatorsByTypeMap[filter.type][rule.operator];
+        if (!operator) {
+            throw new InvalidRule(rule, `Invalid operator for type: ${filter.type} type doesn't define ${rule.operator}`);
+        }
+        expectedArgs = operator.args;
+    }
+    if (expectedArgs !== rule.value.length) {
+        throw new InvalidRule(rule, `Invalid operator argument count: ${rule.operator} needs ${expectedArgs}, ${rule.value.length} given`);
+    }
+    const expectedType = filter.type === 'boolean' || filter.type === 'number'
+        ? filter.type
+        : 'string';
+    if (rule.value.some((v) => typeof v !== expectedType)) {
+        throw new InvalidRule(rule, `Invalid operator argument type: ${rule.operator} needs ${expectedType}, ${rule.value.map((v) => typeof v)} given`);
+    }
+    if (filter.type === 'date' &&
+        rule.value.some((v) => !isValidDate(v))) {
+        throw new InvalidRule(rule, `Invalid operator argument: date type needs valid absolute or relative date, ${rule.value} given`);
+    }
+    if ((filter.type === 'enum' || filter.type === 'array') &&
+        rule.value.some((v) => filter.options?.indexOf(v) === -1)) {
+        throw new InvalidRule(rule, `Invalid operator argument: ${filter.type} type expected ${filter.options}, ${rule.value} given`);
+    }
+    return {
+        field: rule.field,
+        type: filter.type,
+        nullable: !!filter.nullable,
+        operator: rule.operator,
+        value: rule.value,
+    };
+}
+/**
+ * Validates a rule group and its rules recursively against a set of valid
+ * filters
+ *
+ * @param filters The valid filters
+ * @param ruleGroup The rule group to validate
+ * @returns The validated rule group
+ */
+export function validateRuleGroup(filters, ruleGroup) {
+    const validatedRuleGroup = {
+        condition: ruleGroup.condition,
+        rules: [],
+    };
+    for (const rule of ruleGroup.rules) {
+        const valid = isRuleGroup(rule)
+            ? validateRuleGroup(filters, rule)
+            : validateRule(filters, rule);
+        validatedRuleGroup.rules.push(valid);
+    }
+    return validatedRuleGroup;
+}
+/**
+ * Flattens a rule group into an simple array of rules
+ * @param ruleGroup The rule group to flatten
+ * @returns An array of rules
+ */
+export function flattenRules(ruleGroup) {
+    return ruleGroup.rules.flatMap((rule) => isRuleGroup(rule) ? flattenRules(rule) : rule);
+}
+//# sourceMappingURL=rules.js.map

package/dist/utils/rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../src/utils/rules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAQ3E,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC;;;;GAIG;AACH,MAAM,UAAU,WAAW,CACzB,WAA6B;IAE7B,OAAO,WAAW,IAAI,WAAW,CAAC;AACpC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAuB,EACvB,IAAU;IAEV,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,KAAc,CAAC,CAAC;IAC5C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,WAAW,CAAC,IAAI,EAAE,kBAAkB,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,IAAI,IAAI,CAAC,QAAQ,IAAI,iBAAiB,EAAE,CAAC;QACvC,gEAAgE;QAChE,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1E,MAAM,IAAI,WAAW,CACnB,IAAI,EACJ,kDAAkD,CACnD,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,WAAW,CACnB,IAAI,EACJ,8BAA8B,MAAM,CAAC,IAAI,wBAAwB,IAAI,CAAC,QAAQ,EAAE,CACjF,CAAC;QACJ,CAAC;QACD,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IAAI,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QACvC,MAAM,IAAI,WAAW,CACnB,IAAI,EACJ,oCAAoC,IAAI,CAAC,QAAQ,UAAU,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CACtG,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAChB,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ;QACnD,CAAC,CAAC,MAAM,CAAC,IAAI;QACb,CAAC,CAAC,QAAQ,CAAC;IAEf,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,YAAY,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,WAAW,CACnB,IAAI,EACJ,mCAAmC,IAAI,CAAC,QAAQ,UAAU,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,CACvF,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAChB,QAAQ,CACV,CAAC;IACJ,CAAC;IACD,IACE,MAAM,CAAC,IAAI,KAAK,MAAM;QACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,CAAW,CAAC,CAAC,EACjD,CAAC;QACD,MAAM,IAAI,WAAW,CACnB,IAAI,EACJ,+EAA+E,IAAI,CAAC,KAAK,QAAQ,CAClG,CAAC;IACJ,CAAC;IAED,IACE,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC;QACnD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EACnE,CAAC;QACD,MAAM,IAAI,WAAW,CACnB,IAAI,EACJ,8BAA8B,MAAM,CAAC,IAAI,kBAAkB,MAAM,CAAC,OAAO,KAAK,IAAI,CAAC,KAAK,QAAQ,CACjG,CAAC;IACJ,CAAC;IAED,OAAO;QACL,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ;QAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,KAAK,EAAE,IAAI,CAAC,KAAK;KACM,CAAC;AAC5B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAuB,EACvB,SAAoB;IAEpB,MAAM,kBAAkB,GAA8B;QACpD,SAAS,EAAE,SAAS,CAAC,SAAS;QAC9B,KAAK,EAAE,EAAE;KACV,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC;YAC7B,CAAC,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC;YAClC,CAAC,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAChC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,SAAoB;IAC/C,OAAO,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CACtC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAC9C,CAAC;AACJ,CAAC"}

package/dist/utils/slug.d.ts

@@ -0,0 +1,17 @@
+type CharMap = Record<string, string>;
+interface Mode {
+    charmap: CharMap;
+    lower: boolean;
+    multicharmap: CharMap;
+    remove: RegExp | null;
+    replacement: string;
+    trim: boolean;
+}
+interface Options {
+    locale: string;
+    mode: 'pretty' | 'rfc3986';
+    fallback: boolean;
+}
+export declare function slug(s: string, opts?: Partial<Options & Mode>): string;
+export {};
+//# sourceMappingURL=slug.d.ts.map

package/dist/utils/slug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slug.d.ts","sourceRoot":"","sources":["../../src/utils/slug.ts"],"names":[],"mappings":"AAIA,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEtC,UAAU,IAAI;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,OAAO,CAAC;CACf;AAED,UAAU,OAAO;IACf,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;CACnB;AAiED,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,MAAM,CAgBtE"}