@beabee/beabee-common 0.0.2 → 1.1.0

package/dist/cjs/data/index.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentMethod = exports.NewsletterStatus = exports.MembershipStatus = 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 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["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 = {}));

package/dist/cjs/index.js

@@ -1,7 +1,18 @@
 "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.add = void 0;
-function add(a, b) {
-    return a + b;
-}
-exports.add = add;
+__exportStar(require("./search"), exports);
+__exportStar(require("./data"), exports);

package/dist/cjs/search/contacts.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.contactFilters = exports.contactFilterNames = void 0;
+const data_1 = require("../data");
+exports.contactFilterNames = [
+    "firstname",
+    "lastname",
+    "email",
+    "joined",
+    "contributionType",
+    "contributionMonthlyAmount",
+    "contributionPeriod",
+    "deliveryOptIn",
+    "newsletterStatus",
+    "activePermission",
+    "activeMembership",
+    "membershipStarts",
+    "membershipExpires",
+    "manualPaymentSource",
+    "tags",
+];
+exports.contactFilters = {
+    firstname: {
+        type: "text",
+    },
+    lastname: {
+        type: "text",
+    },
+    email: {
+        type: "text",
+    },
+    joined: {
+        type: "date",
+    },
+    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.None,
+        ],
+    },
+    activePermission: {
+        type: "enum",
+        options: ["member", "admin", "superadmin"],
+    },
+    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

@@ -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 __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.convertFiltersToRules = exports.convertRulesToFilters = exports.operators = exports.nullableOperators = void 0;
+const equal = { args: 1 };
+const equalityOperators = { equal, not_equal: { 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 },
+};
+exports.nullableOperators = {
+    is_empty: { args: 0 },
+    is_not_empty: { args: 0 },
+};
+exports.operators = {
+    text: {
+        ...equalityOperators,
+        ...arrayOperators,
+        begins_with: { args: 1 },
+        ends_with: { args: 1 },
+        not_begins_with: { args: 1 },
+        not_ends_with: { args: 1 },
+    },
+    date: numericOperators,
+    number: numericOperators,
+    boolean: { equal },
+    array: arrayOperators,
+    enum: equalityOperators,
+};
+function convertRulesToFilters(rules) {
+    if (!rules) {
+        return null;
+    }
+    // TODO: how to handle groups?
+    const rulesWithoutGroups = rules.rules.filter((rule) => "operator" in rule);
+    return rulesWithoutGroups.map((rule) => ({
+        id: rule.field,
+        operator: rule.operator,
+        values: Array.isArray(rule.value) ? [...rule.value] : [rule.value],
+    }));
+}
+exports.convertRulesToFilters = convertRulesToFilters;
+function convertFiltersToRules(matchType, filters) {
+    return {
+        condition: matchType === "all" ? "AND" : "OR",
+        rules: filters.map((filter) => ({
+            field: filter.id,
+            operator: filter.operator,
+            value: filter.values,
+        })),
+    };
+}
+exports.convertFiltersToRules = convertFiltersToRules;
+__exportStar(require("./contacts"), exports);

package/dist/esm/data/index.js

@@ -0,0 +1,33 @@
+export var ContributionPeriod;
+(function (ContributionPeriod) {
+    ContributionPeriod["Monthly"] = "monthly";
+    ContributionPeriod["Annually"] = "annually";
+})(ContributionPeriod || (ContributionPeriod = {}));
+export var ContributionType;
+(function (ContributionType) {
+    ContributionType["Automatic"] = "Automatic";
+    ContributionType["Manual"] = "Manual";
+    ContributionType["Gift"] = "Gift";
+    ContributionType["None"] = "None";
+})(ContributionType || (ContributionType = {}));
+export var MembershipStatus;
+(function (MembershipStatus) {
+    MembershipStatus["Active"] = "active";
+    MembershipStatus["Expiring"] = "expiring";
+    MembershipStatus["Expired"] = "expired";
+    MembershipStatus["None"] = "none";
+})(MembershipStatus || (MembershipStatus = {}));
+export var NewsletterStatus;
+(function (NewsletterStatus) {
+    NewsletterStatus["Subscribed"] = "subscribed";
+    NewsletterStatus["Unsubscribed"] = "unsubscribed";
+    NewsletterStatus["Cleaned"] = "cleaned";
+    NewsletterStatus["None"] = "none";
+})(NewsletterStatus || (NewsletterStatus = {}));
+export var PaymentMethod;
+(function (PaymentMethod) {
+    PaymentMethod["StripeCard"] = "s_card";
+    PaymentMethod["StripeSEPA"] = "s_sepa";
+    PaymentMethod["StripeBACS"] = "s_bacs";
+    PaymentMethod["GoCardlessDirectDebit"] = "gc_direct-debit";
+})(PaymentMethod || (PaymentMethod = {}));

package/dist/esm/index.js

@@ -1,3 +1,2 @@
-export function add(a, b) {
-    return a + b;
-}
+export * from "./search";
+export * from "./data";

package/dist/esm/search/contacts.js

@@ -0,0 +1,81 @@
+import { ContributionPeriod, ContributionType, NewsletterStatus, } from "../data";
+export const contactFilterNames = [
+    "firstname",
+    "lastname",
+    "email",
+    "joined",
+    "contributionType",
+    "contributionMonthlyAmount",
+    "contributionPeriod",
+    "deliveryOptIn",
+    "newsletterStatus",
+    "activePermission",
+    "activeMembership",
+    "membershipStarts",
+    "membershipExpires",
+    "manualPaymentSource",
+    "tags",
+];
+export const contactFilters = {
+    firstname: {
+        type: "text",
+    },
+    lastname: {
+        type: "text",
+    },
+    email: {
+        type: "text",
+    },
+    joined: {
+        type: "date",
+    },
+    contributionType: {
+        type: "enum",
+        options: [
+            ContributionType.Automatic,
+            ContributionType.Gift,
+            ContributionType.Manual,
+            ContributionType.None,
+        ],
+    },
+    contributionMonthlyAmount: {
+        type: "number",
+    },
+    contributionPeriod: {
+        type: "enum",
+        options: [ContributionPeriod.Monthly, ContributionPeriod.Annually],
+    },
+    deliveryOptIn: {
+        type: "boolean",
+    },
+    newsletterStatus: {
+        type: "enum",
+        options: [
+            NewsletterStatus.Subscribed,
+            NewsletterStatus.Unsubscribed,
+            NewsletterStatus.Cleaned,
+            NewsletterStatus.None,
+        ],
+    },
+    activePermission: {
+        type: "enum",
+        options: ["member", "admin", "superadmin"],
+    },
+    activeMembership: {
+        type: "boolean",
+    },
+    membershipStarts: {
+        type: "date",
+    },
+    membershipExpires: {
+        type: "date",
+    },
+    manualPaymentSource: {
+        type: "text",
+        nullable: true,
+    },
+    tags: {
+        type: "array",
+        nullable: true,
+    },
+};

package/dist/esm/search/index.js

@@ -0,0 +1,57 @@
+const equal = { args: 1 };
+const equalityOperators = { equal, not_equal: { 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 },
+};
+export const nullableOperators = {
+    is_empty: { args: 0 },
+    is_not_empty: { args: 0 },
+};
+export const operators = {
+    text: {
+        ...equalityOperators,
+        ...arrayOperators,
+        begins_with: { args: 1 },
+        ends_with: { args: 1 },
+        not_begins_with: { args: 1 },
+        not_ends_with: { args: 1 },
+    },
+    date: numericOperators,
+    number: numericOperators,
+    boolean: { equal },
+    array: arrayOperators,
+    enum: equalityOperators,
+};
+export function convertRulesToFilters(rules) {
+    if (!rules) {
+        return null;
+    }
+    // TODO: how to handle groups?
+    const rulesWithoutGroups = rules.rules.filter((rule) => "operator" in rule);
+    return rulesWithoutGroups.map((rule) => ({
+        id: rule.field,
+        operator: rule.operator,
+        values: Array.isArray(rule.value) ? [...rule.value] : [rule.value],
+    }));
+}
+export function convertFiltersToRules(matchType, filters) {
+    return {
+        condition: matchType === "all" ? "AND" : "OR",
+        rules: filters.map((filter) => ({
+            field: filter.id,
+            operator: filter.operator,
+            value: filter.values,
+        })),
+    };
+}
+export * from "./contacts";

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

@@ -0,0 +1,28 @@
+export declare enum ContributionPeriod {
+    Monthly = "monthly",
+    Annually = "annually"
+}
+export declare enum ContributionType {
+    Automatic = "Automatic",
+    Manual = "Manual",
+    Gift = "Gift",
+    None = "None"
+}
+export declare enum MembershipStatus {
+    Active = "active",
+    Expiring = "expiring",
+    Expired = "expired",
+    None = "none"
+}
+export declare enum NewsletterStatus {
+    Subscribed = "subscribed",
+    Unsubscribed = "unsubscribed",
+    Cleaned = "cleaned",
+    None = "none"
+}
+export declare enum PaymentMethod {
+    StripeCard = "s_card",
+    StripeSEPA = "s_sepa",
+    StripeBACS = "s_bacs",
+    GoCardlessDirectDebit = "gc_direct-debit"
+}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./search";
+export * from "./data";

package/dist/types/search/contacts.d.ts

@@ -0,0 +1,56 @@
+import { ContributionPeriod, ContributionType, NewsletterStatus } from "../data";
+export declare const contactFilterNames: readonly ["firstname", "lastname", "email", "joined", "contributionType", "contributionMonthlyAmount", "contributionPeriod", "deliveryOptIn", "newsletterStatus", "activePermission", "activeMembership", "membershipStarts", "membershipExpires", "manualPaymentSource", "tags"];
+export declare type ContactFilterName = typeof contactFilterNames[number];
+export declare const contactFilters: {
+    readonly firstname: {
+        readonly type: "text";
+    };
+    readonly lastname: {
+        readonly type: "text";
+    };
+    readonly email: {
+        readonly type: "text";
+    };
+    readonly joined: {
+        readonly type: "date";
+    };
+    readonly contributionType: {
+        readonly type: "enum";
+        readonly options: readonly [ContributionType.Automatic, ContributionType.Gift, ContributionType.Manual, ContributionType.None];
+    };
+    readonly contributionMonthlyAmount: {
+        readonly type: "number";
+    };
+    readonly contributionPeriod: {
+        readonly type: "enum";
+        readonly options: readonly [ContributionPeriod.Monthly, ContributionPeriod.Annually];
+    };
+    readonly deliveryOptIn: {
+        readonly type: "boolean";
+    };
+    readonly newsletterStatus: {
+        readonly type: "enum";
+        readonly options: readonly [NewsletterStatus.Subscribed, NewsletterStatus.Unsubscribed, NewsletterStatus.Cleaned, NewsletterStatus.None];
+    };
+    readonly activePermission: {
+        readonly type: "enum";
+        readonly options: readonly ["member", "admin", "superadmin"];
+    };
+    readonly activeMembership: {
+        readonly type: "boolean";
+    };
+    readonly membershipStarts: {
+        readonly type: "date";
+    };
+    readonly membershipExpires: {
+        readonly type: "date";
+    };
+    readonly manualPaymentSource: {
+        readonly type: "text";
+        readonly nullable: true;
+    };
+    readonly tags: {
+        readonly type: "array";
+        readonly nullable: true;
+    };
+};

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

@@ -0,0 +1,54 @@
+export declare type GetPaginatedQueryRuleOperator = "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";
+export declare type GetPaginatedQueryRuleValue = string | number | boolean;
+export interface GetPaginatedQueryRule<T> {
+    field: T;
+    operator: GetPaginatedQueryRuleOperator;
+    value: GetPaginatedQueryRuleValue | GetPaginatedQueryRuleValue[];
+}
+export interface GetPaginatedQueryRuleGroup<T> {
+    condition: "AND" | "OR";
+    rules: (GetPaginatedQueryRuleGroup<T> | GetPaginatedQueryRule<T>)[];
+}
+export interface GetPaginatedQuery<T> {
+    limit?: number;
+    offset?: number;
+    sort?: string;
+    order?: "ASC" | "DESC";
+    rules?: GetPaginatedQueryRuleGroup<T>;
+}
+export declare type FilterType = "text" | "date" | "number" | "boolean" | "array" | "enum";
+export declare type FilterValue = GetPaginatedQueryRuleValue;
+export declare type FilterOperator = GetPaginatedQueryRuleOperator;
+export interface FilterOperatorParams {
+    args: number;
+}
+export declare const nullableOperators: {
+    is_empty: {
+        args: number;
+    };
+    is_not_empty: {
+        args: number;
+    };
+};
+export declare const operators: Record<FilterType, Partial<Record<FilterOperator, FilterOperatorParams>>>;
+interface BaseFilterArgs {
+    type: FilterType;
+    nullable?: boolean;
+}
+export interface EnumFilterArgs<T extends readonly string[] = string[]> extends BaseFilterArgs {
+    type: "enum";
+    options: T;
+}
+export interface OtherFilterArgs extends BaseFilterArgs {
+    type: Exclude<FilterType, "enum">;
+}
+export declare type FilterArgs = EnumFilterArgs | OtherFilterArgs;
+export declare type Filters<T extends string = string> = Record<T, FilterArgs>;
+export interface Filter {
+    id: string;
+    operator: FilterOperator;
+    values: FilterValue[];
+}
+export declare function convertRulesToFilters(rules: GetPaginatedQuery<string>["rules"]): Filter[] | null;
+export declare function convertFiltersToRules(matchType: "all" | "any", filters: Filter[]): GetPaginatedQuery<string>["rules"];
+export * from "./contacts";

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@beabee/beabee-common",
-  "version": "0.0.2",
+  "version": "1.1.0",
   "description": "",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
-  "types": "./dist/cjs/index.d.ts",
+  "types": "./dist/types/index.d.ts",
   "files": [
     "dist/"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "rimraf ./dist/ && tsc && tsc -p tsconfig-cjs.json",
+    "build": "rimraf ./dist/ && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && tsc -p tsconfig.types.json",
     "prepublishOnly": "npm run build"
   },
   "repository": {
@@ -25,6 +25,7 @@
   "homepage": "https://github.com/beabee-communityrm/beabee-common#readme",
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.1",
+    "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
     "typescript": "^4.8.4"
   }

package/dist/cjs/index.d.ts

@@ -1 +0,0 @@
-export declare function add(a: number, b: number): number;

package/dist/esm/index.d.ts

@@ -1 +0,0 @@
-export declare function add(a: number, b: number): number;