@beabee/beabee-common 1.19.5 → 1.19.7

package/dist/types/types/select-callout-component-schema.d.ts

@@ -0,0 +1,11 @@
+import type { BaseCalloutComponentSchema } from "./index.ts";
+export interface SelectCalloutComponentSchema extends BaseCalloutComponentSchema {
+    type: "select";
+    input: true;
+    data: {
+        values: {
+            label: string;
+            value: string;
+        }[];
+    };
+}

package/dist/types/types/stripe-fee-country.d.ts

@@ -0,0 +1 @@
+export type StripeFeeCountry = "eu" | "gb" | "ca";

package/dist/types/types/unit-matches.d.ts

@@ -0,0 +1,2 @@
+import { DateUnit } from "./index.ts";
+export type UnitMatches = IterableIterator<[string, DateUnit, string]>;

package/dist/types/types/validated-boolean-rule.d.ts

@@ -0,0 +1,2 @@
+import type { BaseValidatedRule } from "../types/index.ts";
+export type ValidatedBooleanRule<Field extends string> = BaseValidatedRule<"boolean", Field>;

package/dist/types/types/validated-number-rule.d.ts

@@ -0,0 +1,2 @@
+import type { BaseValidatedRule } from "../types/index.ts";
+export type ValidatedNumberRule<Field extends string> = BaseValidatedRule<"number", Field>;

package/dist/types/types/validated-rule-group.d.ts

@@ -0,0 +1,5 @@
+import type { ValidatedRule } from "../types/index.ts";
+export interface ValidatedRuleGroup<Field extends string> {
+    condition: "AND" | "OR";
+    rules: (ValidatedRuleGroup<Field> | ValidatedRule<Field>)[];
+}

package/dist/types/types/validated-rule-value.d.ts

@@ -0,0 +1,2 @@
+import type { FilterType } from "../types/index.ts";
+export type ValidatedRuleValue<T extends FilterType> = T extends "number" ? number : T extends "boolean" ? boolean : string;

package/dist/types/types/validated-rule.d.ts

@@ -0,0 +1,2 @@
+import type { ValidatedBooleanRule, ValidatedNumberRule, ValidatedStringRule } from "../types/index.ts";
+export type ValidatedRule<Field extends string> = ValidatedNumberRule<Field> | ValidatedStringRule<Field> | ValidatedBooleanRule<Field>;

package/dist/types/types/validated-string-rule.d.ts

@@ -0,0 +1,2 @@
+import type { BaseValidatedRule, FilterType } from "../types/index.ts";
+export type ValidatedStringRule<Field extends string> = BaseValidatedRule<Exclude<FilterType, "number" | "boolean">, Field>;

package/dist/types/utils/callouts.d.ts

@@ -1,6 +1,4 @@
-import { CalloutComponentSchema, CalloutFormSchema, CalloutResponseAnswer } from "../data/callouts";
-import { FilterArgs } from "../search";
-import { CalloutResponseAnswerAddress, CalloutResponseAnswerFileUpload } from "../data/callouts";
+import type { CalloutComponentSchema, CalloutFormSchema, CalloutResponseAnswer, CalloutResponseAnswerAddress, CalloutResponseAnswerFileUpload, FilterArgs } from "../types/index.ts";
 export declare function flattenComponents(components: CalloutComponentSchema[]): CalloutComponentSchema[];
 export declare function filterComponents(components: CalloutComponentSchema[], filterFn: (component: CalloutComponentSchema) => boolean): CalloutComponentSchema[];
 export declare function getCalloutComponents(formSchema: CalloutFormSchema): (CalloutComponentSchema & {

package/dist/types/utils/date.d.ts

@@ -1,7 +1,7 @@
-declare const dateUnits: readonly ["s", "m", "h", "d", "M", "y"];
-type DateUnit = (typeof dateUnits)[number];
+import type { DateUnit, Duration } from "../types/index.ts";
+export declare const dateUnits: readonly ["s", "m", "h", "d", "M", "y"];
+export declare const dateUnitMap: Record<DateUnit, keyof Duration>;
 export declare function parseDate(value: string, now?: Date): [Date, DateUnit];
 export declare function getMinDateUnit(units: [DateUnit, ...DateUnit[]]): DateUnit;
 export declare function getMinDateUnit(units: DateUnit[]): DateUnit | undefined;
 export declare function isValidDate(s: string): boolean;
-export {};

package/dist/types/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./callouts.ts";
+export * from "./date.ts";
+export * from "./payments.ts";
+export * from "./rules.ts";

package/dist/types/utils/payments.d.ts

@@ -1,8 +1,2 @@
-import { ContributionPeriod, PaymentMethod, StripeFeeCountry } from "../data";
-interface Feeable {
-    amount: number;
-    period: ContributionPeriod;
-    paymentMethod: PaymentMethod;
-}
+import type { Feeable, StripeFeeCountry } from "../types/index.ts";
 export declare function calcPaymentFee(feeable: Feeable, country: StripeFeeCountry): number;
-export {};

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

@@ -1,4 +1,4 @@
-import { Filters, Rule, RuleGroup, ValidatedRule, ValidatedRuleGroup } from "../search";
+import type { Filters, Rule, RuleGroup, ValidatedRule, ValidatedRuleGroup } from "../types/index.ts";
 export declare function isRuleGroup(ruleOrGroup: Rule | RuleGroup): ruleOrGroup is RuleGroup;
 export declare function validateRule<Field extends string>(filters: Filters<Field>, rule: Rule): ValidatedRule<Field>;
 export declare function validateRuleGroup<Field extends string>(filters: Filters<Field>, ruleGroup: RuleGroup): ValidatedRuleGroup<Field>;

package/package.json

@@ -1,16 +1,38 @@
 {
   "name": "@beabee/beabee-common",
-  "version": "1.19.5",
-  "description": "",
-  "main": "./dist/cjs/index.js",
+  "version": "1.19.7",
+  "description": "Shared code between Beabee projects for Node.js, Deno and the browser",
+  "type": "module",
+  "main": "./dist/cjs/index.cjs",
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "files": [
     "dist/"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.cjs",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
-    "test": "jest",
-    "build": "rimraf ./dist/ && tsc -p tsconfig.build.esm.json && tsc -p tsconfig.build.cjs.json && tsc -p tsconfig.build.types.json",
+    "test": "npm run test:types && npm run test:node",
+    "test:deno": "deno task test",
+    "test:node": "npm run test:node:esm && npm run test:node:cjs",
+    "test:types": "tsc --noEmit --emitDeclarationOnly false",
+    "test:node:esm": "node test/node/import.mjs",
+    "test:node:cjs": "node test/node/require.cjs",
+    "clear": "rimraf ./dist/",
+    "build": "npm run clear && npm run generate:index && npm run sync:deps && npm run format && npm run build:types && npm run build:node",
+    "build:node": "npm run build:node:esm && npm run build:node:cjs",
+    "build:node:esm": "deno task build:node:esm",
+    "build:node:cjs": "deno task build:node:cjs",
+    "build:types": "tsc",
+    "generate:index": "deno task generate:index",
+    "sync:deps": "deno task sync:deps",
+    "format": "deno task format",
     "prepublishOnly": "npm run build"
   },
   "repository": {
@@ -24,14 +46,11 @@
   },
   "homepage": "https://github.com/beabee-communityrm/beabee-common#readme",
   "devDependencies": {
-    "@tsconfig/recommended": "^1.0.2",
-    "jest": "^29.3.1",
-    "prettier": "^2.8.3",
-    "rimraf": "^4.1.1",
-    "ts-jest": "^29.0.5",
-    "typescript": "^4.9.4"
+    "@tsconfig/recommended": "^1.0.3",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "date-fns": "^2.29.3"
+    "date-fns": "^3.2.0"
   }
 }

package/dist/cjs/data/callouts.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/data/index.js

@@ -1,67 +0,0 @@
-"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 __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 });
-exports.RoleTypes = exports.PaymentStatus = exports.PaymentMethod = exports.NewsletterStatus = exports.MembershipStatus = exports.ItemStatus = exports.ContributionType = exports.ContributionPeriod = void 0;
-var ContributionPeriod;
-(function (ContributionPeriod) {
-    ContributionPeriod["Monthly"] = "monthly";
-    ContributionPeriod["Annually"] = "annually";
-})(ContributionPeriod = exports.ContributionPeriod || (exports.ContributionPeriod = {}));
-var ContributionType;
-(function (ContributionType) {
-    ContributionType["Automatic"] = "Automatic";
-    ContributionType["Manual"] = "Manual";
-    ContributionType["Gift"] = "Gift";
-    ContributionType["None"] = "None";
-})(ContributionType = exports.ContributionType || (exports.ContributionType = {}));
-var ItemStatus;
-(function (ItemStatus) {
-    ItemStatus["Draft"] = "draft";
-    ItemStatus["Scheduled"] = "scheduled";
-    ItemStatus["Open"] = "open";
-    ItemStatus["Ended"] = "ended";
-})(ItemStatus = exports.ItemStatus || (exports.ItemStatus = {}));
-var MembershipStatus;
-(function (MembershipStatus) {
-    MembershipStatus["Active"] = "active";
-    MembershipStatus["Expiring"] = "expiring";
-    MembershipStatus["Expired"] = "expired";
-    MembershipStatus["None"] = "none";
-})(MembershipStatus = exports.MembershipStatus || (exports.MembershipStatus = {}));
-var NewsletterStatus;
-(function (NewsletterStatus) {
-    NewsletterStatus["Subscribed"] = "subscribed";
-    NewsletterStatus["Unsubscribed"] = "unsubscribed";
-    NewsletterStatus["Cleaned"] = "cleaned";
-    NewsletterStatus["Pending"] = "pending";
-    NewsletterStatus["None"] = "none";
-})(NewsletterStatus = exports.NewsletterStatus || (exports.NewsletterStatus = {}));
-var PaymentMethod;
-(function (PaymentMethod) {
-    PaymentMethod["StripeCard"] = "s_card";
-    PaymentMethod["StripeSEPA"] = "s_sepa";
-    PaymentMethod["StripeBACS"] = "s_bacs";
-    PaymentMethod["GoCardlessDirectDebit"] = "gc_direct-debit";
-})(PaymentMethod = exports.PaymentMethod || (exports.PaymentMethod = {}));
-var PaymentStatus;
-(function (PaymentStatus) {
-    PaymentStatus["Pending"] = "pending";
-    PaymentStatus["Successful"] = "successful";
-    PaymentStatus["Failed"] = "failed";
-    PaymentStatus["Cancelled"] = "cancelled";
-})(PaymentStatus = exports.PaymentStatus || (exports.PaymentStatus = {}));
-exports.RoleTypes = ["member", "admin", "superadmin"];
-__exportStar(require("./callouts"), exports);

package/dist/cjs/error/InvalidRule.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class InvalidRule extends Error {
-    constructor(rule, message) {
-        super();
-        this.rule = rule;
-        this.message = message;
-        Object.setPrototypeOf(this, InvalidRule.prototype);
-    }
-}
-exports.default = InvalidRule;

package/dist/cjs/error/index.js

@@ -1,8 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidRule = void 0;
-const InvalidRule_1 = __importDefault(require("./InvalidRule"));
-exports.InvalidRule = InvalidRule_1.default;

package/dist/cjs/index.js

@@ -1,23 +0,0 @@
-"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 __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 });
-__exportStar(require("./search"), exports);
-__exportStar(require("./data"), exports);
-__exportStar(require("./error"), exports);
-__exportStar(require("./utils/callouts"), exports);
-__exportStar(require("./utils/date"), exports);
-__exportStar(require("./utils/payments"), exports);
-__exportStar(require("./utils/rules"), exports);

package/dist/cjs/search/api-keys.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.apiKeyFilters = void 0;
-exports.apiKeyFilters = {
-    id: {
-        type: "text",
-    },
-    createdAt: {
-        type: "date",
-    },
-};

package/dist/cjs/search/callouts.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.calloutTagFilters = exports.calloutResponseCommentFilters = exports.calloutResponseFilters = exports.calloutFilters = void 0;
-const data_1 = require("../data");
-exports.calloutFilters = {
-    slug: {
-        type: "text",
-    },
-    title: {
-        type: "text",
-    },
-    status: {
-        type: "enum",
-        options: [
-            data_1.ItemStatus.Draft,
-            data_1.ItemStatus.Scheduled,
-            data_1.ItemStatus.Open,
-            data_1.ItemStatus.Ended,
-        ],
-    },
-    answeredBy: {
-        type: "contact",
-    },
-    starts: {
-        type: "date",
-        nullable: true,
-    },
-    expires: {
-        type: "date",
-        nullable: true,
-    },
-    hidden: {
-        type: "boolean",
-    },
-};
-exports.calloutResponseFilters = {
-    id: {
-        type: "text",
-    },
-    contact: {
-        type: "contact",
-        nullable: true,
-    },
-    callout: {
-        type: "text",
-    },
-    createdAt: {
-        type: "date",
-    },
-    updatedAt: {
-        type: "date",
-    },
-    bucket: {
-        type: "text",
-        nullable: true,
-    },
-    tags: {
-        type: "array",
-    },
-    assignee: {
-        type: "contact",
-        nullable: true,
-    },
-    answers: {
-        type: "blob",
-    },
-};
-exports.calloutResponseCommentFilters = {
-    id: {
-        type: "text",
-    },
-    responseId: {
-        type: "text",
-    },
-    contact: {
-        type: "contact",
-    },
-    createdAt: {
-        type: "date",
-    },
-    updatedAt: {
-        type: "date",
-    },
-    text: {
-        type: "text",
-    },
-};
-exports.calloutTagFilters = {
-    id: {
-        type: "text",
-    },
-    name: {
-        type: "text",
-    },
-    description: {
-        type: "text",
-    },
-    calloutSlug: {
-        type: "text",
-    },
-};

package/dist/cjs/search/contacts.js

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.contactFilters = void 0;
-const data_1 = require("../data");
-exports.contactFilters = {
-    id: {
-        type: "text",
-    },
-    firstname: {
-        type: "text",
-    },
-    lastname: {
-        type: "text",
-    },
-    email: {
-        type: "text",
-    },
-    joined: {
-        type: "date",
-    },
-    lastSeen: {
-        type: "date",
-    },
-    contributionCancelled: {
-        type: "date",
-        nullable: true,
-    },
-    contributionType: {
-        type: "enum",
-        options: [
-            data_1.ContributionType.Automatic,
-            data_1.ContributionType.Gift,
-            data_1.ContributionType.Manual,
-            data_1.ContributionType.None,
-        ],
-    },
-    contributionMonthlyAmount: {
-        type: "number",
-    },
-    contributionPeriod: {
-        type: "enum",
-        options: [data_1.ContributionPeriod.Monthly, data_1.ContributionPeriod.Annually],
-    },
-    deliveryOptIn: {
-        type: "boolean",
-    },
-    newsletterStatus: {
-        type: "enum",
-        options: [
-            data_1.NewsletterStatus.Subscribed,
-            data_1.NewsletterStatus.Unsubscribed,
-            data_1.NewsletterStatus.Cleaned,
-            data_1.NewsletterStatus.Pending,
-            data_1.NewsletterStatus.None,
-        ],
-    },
-    activePermission: {
-        type: "enum",
-        options: data_1.RoleTypes,
-    },
-    activeMembership: {
-        type: "boolean",
-    },
-    membershipStarts: {
-        type: "date",
-    },
-    membershipExpires: {
-        type: "date",
-    },
-    manualPaymentSource: {
-        type: "text",
-        nullable: true,
-    },
-    tags: {
-        type: "array",
-        nullable: true,
-    },
-};

package/dist/cjs/search/index.js

@@ -1,81 +0,0 @@
-"use strict";
-// *** Definitions for rules ***
-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 __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 });
-exports.operatorsByTypeMap = exports.operatorsByType = exports.nullableOperators = exports.ruleOperators = void 0;
-exports.ruleOperators = [
-    "equal",
-    "not_equal",
-    "less",
-    "less_or_equal",
-    "greater",
-    "greater_or_equal",
-    "between",
-    "not_between",
-    "begins_with",
-    "not_begins_with",
-    "contains",
-    "not_contains",
-    "ends_with",
-    "not_ends_with",
-    "is_empty",
-    "is_not_empty",
-];
-const equalityOperators = {
-    equal: { args: 1 },
-    not_equal: { args: 1 },
-};
-const stringOperators = {
-    begins_with: { args: 1 },
-    ends_with: { args: 1 },
-    not_begins_with: { args: 1 },
-    not_ends_with: { args: 1 },
-};
-const numericOperators = {
-    ...equalityOperators,
-    between: { args: 2 },
-    not_between: { args: 2 },
-    less: { args: 1 },
-    greater: { args: 1 },
-    less_or_equal: { args: 1 },
-    greater_or_equal: { args: 1 },
-};
-const arrayOperators = {
-    contains: { args: 1 },
-    not_contains: { args: 1 },
-};
-// Special operator can be applied across all fields if they are nullable
-exports.nullableOperators = {
-    is_empty: { args: 0 },
-    is_not_empty: { args: 0 },
-};
-exports.operatorsByType = {
-    text: { ...equalityOperators, ...arrayOperators, ...stringOperators },
-    blob: arrayOperators,
-    date: numericOperators,
-    number: numericOperators,
-    boolean: { equal: equalityOperators.equal },
-    array: arrayOperators,
-    enum: equalityOperators,
-    contact: equalityOperators,
-};
-// More general type to allow mapping while maintaining full type above
-exports.operatorsByTypeMap = exports.operatorsByType;
-__exportStar(require("./api-keys"), exports);
-__exportStar(require("./callouts"), exports);
-__exportStar(require("./contacts"), exports);
-__exportStar(require("./notices"), exports);
-__exportStar(require("./payments"), exports);

package/dist/cjs/search/notices.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.noticeFilters = void 0;
-const data_1 = require("../data");
-exports.noticeFilters = {
-    id: {
-        type: "text",
-    },
-    createdAt: {
-        type: "date",
-    },
-    updatedAt: {
-        type: "date",
-    },
-    name: {
-        type: "text",
-    },
-    expires: {
-        type: "date",
-        nullable: true,
-    },
-    enabled: {
-        type: "boolean",
-    },
-    text: {
-        type: "text",
-    },
-    status: {
-        type: "enum",
-        options: [
-            data_1.ItemStatus.Draft,
-            data_1.ItemStatus.Scheduled,
-            data_1.ItemStatus.Open,
-            data_1.ItemStatus.Ended,
-        ],
-    },
-};

package/dist/cjs/search/payments.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.paymentFilters = void 0;
-const data_1 = require("../data");
-exports.paymentFilters = {
-    id: {
-        type: "text",
-    },
-    contact: {
-        type: "contact",
-    },
-    chargeDate: {
-        type: "date",
-    },
-    amount: {
-        type: "number",
-    },
-    status: {
-        type: "enum",
-        options: [
-            data_1.PaymentStatus.Successful,
-            data_1.PaymentStatus.Pending,
-            data_1.PaymentStatus.Failed,
-            data_1.PaymentStatus.Cancelled,
-        ],
-    },
-};