@beabee/beabee-common 0.21.1-alpha.2 → 0.45.0

package/dist/types/types/payment-source.d.ts

@@ -1,2 +0,0 @@
-import type { PaymentSourceGoCardlessDirectDebit, PaymentSourceManual, PaymentSourceStripeBACS, PaymentSourceStripeCard, PaymentSourceStripePayPal, PaymentSourceStripeSEPA } from "./index.ts";
-export type PaymentSource = PaymentSourceGoCardlessDirectDebit | PaymentSourceManual | PaymentSourceStripeBACS | PaymentSourceStripeCard | PaymentSourceStripePayPal | PaymentSourceStripeSEPA;

package/dist/types/types/role-type.d.ts

@@ -1,2 +0,0 @@
-import type { RoleTypes } from "../search/contacts.ts";
-export type RoleType = (typeof RoleTypes)[number];

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

@@ -1,5 +0,0 @@
-import type { Rule } from "./index.ts";
-export interface RuleGroup {
-    condition: "AND" | "OR";
-    rules: (RuleGroup | Rule)[];
-}

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

@@ -1,2 +0,0 @@
-import type { ruleOperators } from "../search/index.ts";
-export type RuleOperator = (typeof ruleOperators)[number];

package/dist/types/types/rule-opperator-params.d.ts

@@ -1,3 +0,0 @@
-export interface RuleOperatorParams {
-    args: number;
-}

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

@@ -1,6 +0,0 @@
-import { RuleOperator, RuleValue } from "./index.ts";
-export interface Rule {
-    field: string;
-    operator: RuleOperator;
-    value: RuleValue[];
-}

package/dist/types/types/segment-filter-name.d.ts

@@ -1,2 +0,0 @@
-import type { segmentFilters } from "../search/segments.ts";
-export type SegmentFilterName = keyof typeof segmentFilters;

package/dist/types/types/serial.d.ts

@@ -1,3 +0,0 @@
-export type Serial<T> = {
-    [P in keyof T]: Date extends T[P] ? string : Date | undefined extends T[P] ? string | undefined : Date | null extends T[P] ? string | null : T[P];
-};

package/dist/types/types/set-callout-form-schema.d.ts

@@ -1,4 +0,0 @@
-import { SetCalloutSlideSchema } from "../index.ts";
-export interface SetCalloutFormSchema {
-    slides: SetCalloutSlideSchema[];
-}

package/dist/types/types/set-callout-navigation-schema.d.ts

@@ -1,3 +0,0 @@
-export interface SetCalloutNavigationSchema {
-    nextSlideId: string;
-}

package/dist/types/types/set-callout-slide-schema.d.ts

@@ -1,7 +0,0 @@
-import { CalloutComponentSchema, SetCalloutNavigationSchema } from "./index.ts";
-export interface SetCalloutSlideSchema {
-    id: string;
-    title: string;
-    components: CalloutComponentSchema[];
-    navigation: SetCalloutNavigationSchema;
-}

package/dist/types/types/set-contribution-data.d.ts

@@ -1,7 +0,0 @@
-import type { ContributionPeriod } from "../data/index.ts";
-export interface SetContributionData {
-    amount: number;
-    payFee: boolean;
-    prorate: boolean;
-    period: ContributionPeriod;
-}

package/dist/types/types/start-contribution-data.d.ts

@@ -1,5 +0,0 @@
-import type { PaymentMethod } from "../data/index.ts";
-import type { SetContributionData } from "./index.ts";
-export interface StartContributionData extends SetContributionData {
-    paymentMethod: PaymentMethod;
-}

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

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

package/dist/types/types/text-case.d.ts

@@ -1 +0,0 @@
-export type TextCase = "uppercase" | "mixed" | "lowercase";

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

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

package/dist/types/types/update-callout-data.d.ts

@@ -1,2 +0,0 @@
-import type { CreateCalloutData } from "./index.ts";
-export type UpdateCalloutData = Partial<CreateCalloutData>;

package/dist/types/types/update-callout-response-comment-data.d.ts

@@ -1,3 +0,0 @@
-export interface UpdateCalloutResponseCommentData {
-    text: string;
-}

package/dist/types/types/update-callout-response-data.d.ts

@@ -1,2 +0,0 @@
-import type { CreateCalloutResponseData } from "./index.ts";
-export type UpdateCalloutResponseData = Partial<CreateCalloutResponseData>;

package/dist/types/types/update-callout-tag-data.d.ts

@@ -1,2 +0,0 @@
-import { CreateCalloutTagData } from "./index.ts";
-export type UpdateCalloutTagData = Partial<CreateCalloutTagData>;

package/dist/types/types/update-contact-data.d.ts

@@ -1,5 +0,0 @@
-import type { ContactData, UpdateContactProfileData } from "./index.ts";
-export interface UpdateContactData extends Partial<ContactData> {
-    password?: string;
-    profile?: UpdateContactProfileData;
-}

package/dist/types/types/update-contact-profile-data.d.ts

@@ -1,2 +0,0 @@
-import type { ContactProfileData } from "./index.ts";
-export type UpdateContactProfileData = Partial<ContactProfileData>;

package/dist/types/types/update-contact-role-data.d.ts

@@ -1,4 +0,0 @@
-export interface UpdateContactRoleData {
-    dateAdded: Date;
-    dateExpires: Date | null;
-}

package/dist/types/types/update-email-data.d.ts

@@ -1,2 +0,0 @@
-import { GetEmailData } from "./index.ts";
-export type UpdateEmailData = GetEmailData;

package/dist/types/types/update-reset-password-data.d.ts

@@ -1,5 +0,0 @@
-export interface UpdateResetPasswordData {
-    password: string;
-    /** If MFA is enabled, we need to provide the token */
-    token?: string;
-}

package/dist/types/types/update-segment-data.d.ts

@@ -1,2 +0,0 @@
-import { CreateSegmentData } from "./index.ts";
-export type UpdateSegmentData = Partial<CreateSegmentData>;

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

@@ -1,2 +0,0 @@
-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

@@ -1,2 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

@@ -1,2 +0,0 @@
-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

@@ -1,2 +0,0 @@
-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

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

package/dist/types/types/validator-callout-component.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentBaseSchema, CalloutResponseAnswer } from "./index.ts";
-export type ValidatorCalloutComponent<S extends CalloutComponentBaseSchema, A = CalloutResponseAnswer> = (schema: S, answer: A) => boolean;

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

@@ -1,30 +0,0 @@
-import { CalloutComponentBaseType, CalloutComponentType } from "../data/index.ts";
-import type { CalloutComponentBaseMap, CalloutComponentBaseSchema, CalloutComponentMap, CalloutComponentSchema, CalloutResponseAnswer, CalloutResponseAnswerAddress, CalloutResponseAnswerFileUpload, FilterArgs, SetCalloutFormSchema } from "../types/index.ts";
-/**
- * Check if a component is a specific component type
- *
- * @param component The component to check
- * @param type The type of component to check
- * @returns Ensure that the component is of the specific type
- */
-export declare function isCalloutComponentOfType<T extends CalloutComponentType>(component: CalloutComponentBaseSchema, type: T): component is CalloutComponentMap[T];
-/**
- * Check if a component is a specific base component type
- *
- * @param component The component to check
- * @param type The type of component to check
- * @returns Ensure that the component is of the specific base type
- */
-export declare function isCalloutComponentOfBaseType<T extends CalloutComponentBaseType>(component: CalloutComponentBaseSchema, type: T): component is CalloutComponentBaseMap[T];
-export declare function flattenComponents(components: CalloutComponentSchema[]): CalloutComponentSchema[];
-export declare function filterComponents(components: CalloutComponentSchema[], filterFn: (component: CalloutComponentSchema) => boolean): CalloutComponentSchema[];
-export declare function getCalloutComponents(formSchema: SetCalloutFormSchema): (CalloutComponentSchema & {
-    slideId: string;
-    fullKey: string;
-})[];
-export declare function getCalloutFilters(formSchema: SetCalloutFormSchema): Record<string, FilterArgs & {
-    label: string;
-}>;
-export declare function isAddressAnswer(answer: CalloutResponseAnswer): answer is CalloutResponseAnswerAddress;
-export declare function isFileUploadAnswer(answer: CalloutResponseAnswer | undefined): answer is CalloutResponseAnswerFileUpload;
-export declare function stringifyAnswer(component: CalloutComponentSchema, answer: CalloutResponseAnswer | CalloutResponseAnswer[] | undefined): string;

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

@@ -1,14 +0,0 @@
-/**
- * Convert the value to a valid phone number
- * @param value The value to convert
- * @returns The valid phone number or null if the value is not a valid phone number
- */
-export declare const toPhoneNumber: (value: unknown) => string | false;
-/**
- * Convert the value to a valid bytes number.
- * Note: This method ignores the text case of the unit, so b is always the same as B which means Byte and makes no different between Bytes and bits.
- * This method can be used to convert `fileMinSize` and `fileMaxSize` of a callout file component to bytes.
- * @param value E.g. "0KB", "1GB"
- * @returns The valid bytes number or null if the value is not a valid bytes number.
- */
-export declare const toBytes: (value: unknown) => number | null;

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

@@ -1,8 +0,0 @@
-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 | Date): boolean;
-export declare function isDateBetween(date: string | Date, start?: string | Date | null, end?: string | Date | null): boolean;

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

@@ -1,7 +0,0 @@
-export * from "./callouts.ts";
-export * from "./conversions.ts";
-export * from "./date.ts";
-export * from "./payments.ts";
-export * from "./rules.ts";
-export * from "./slug.ts";
-export * from "./validations.ts";

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

@@ -1,2 +0,0 @@
-import type { Feeable, StripeFeeCountry } from "../types/index.ts";
-export declare function calcPaymentFee(feeable: Feeable, country: StripeFeeCountry): number;

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

@@ -1,4 +0,0 @@
-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/dist/types/utils/slug.d.ts

@@ -1,16 +0,0 @@
-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 {};

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

@@ -1,90 +0,0 @@
-import { ContributionPeriod } from "../data/index.ts";
-/**
- * Check if the value is a valid angle.
- * @param value The value to check
- */
-export declare const isAngle: (value: unknown, span?: number) => value is number;
-/**
- * Check if the value is a valid email address.
- * @param value The value to check
- * @param span The span of the angle
- */
-export declare const isEmail: (value: unknown) => value is string;
-/**
- * Check if the value is a valid longitude/latitude pair.
- * @param value The value to check
- */
-export declare const isLngLat: (value: unknown) => value is [number, number];
-/**
- * Check if the value is a valid map bounds.
- * @param value The value to check
- */
-export declare const isMapBounds: (value: unknown) => value is [[number, number], [number, number]];
-/**
- * Check if the value is a valid password.
- * @param value The value to check
- */
-export declare const isPassword: (value: unknown) => value is string;
-/**
- * Check if the value is a valid period.
- * @param value The value to check
- */
-export declare const isPeriod: (value: unknown) => value is ContributionPeriod;
-/**
- * Check if the value is a valid slug.
- * @param value The value to check
- * @returns
- */
-export declare const isSlug: (value: unknown) => value is string;
-/**
- * Check if the value is one of the given types
- * @param types The valid types
- * @param value The value to check
- */
-export declare function isType(types: Array<"string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function">, value: unknown): boolean;
-/**
- * Check if the value is a valid URL string
- * @param value The value to check
- */
-export declare const isURL: (value: unknown) => value is string;
-/**
- * Check if the value is a valid number
- * @param value The value to check
- */
-export declare const isNumber: (value: unknown) => value is number;
-export declare const isAmountOfMoney: (value: unknown) => value is number;
-/**
- * Check if the value is a valid phone number with the following rules:
- * * Only uses numbers
- * * Optionally starts with a `+`
- * * Maximal length is 15 characters
- * * Minimal length is 5 characters
- * Note: This method is very generalised to work for as many countries as possible
- * and does not take into whitespace, brackets or other characters commonly used
- * in telephone number notation. To remove these, use `toPhoneNumber` instead.
- * @param value The value to check
- */
-export declare const isPhoneNumber: (value: unknown) => value is string;
-/**
- * Check if the the pay fee value is correct for the given amount and period
- *
- * @param value The value to check
- * @param amount The amount
- * @param period The period
- */
-export declare const isValidPayFee: (value: unknown, amount: unknown, period: unknown) => value is boolean;
-export declare const isNumberInRange: (value: unknown, min?: number, max?: number) => boolean;
-/**
- * Checks if a value is a string and its length is in a range
- * @param value The value to check
- * @param minLength The minimum length
- * @param maxLength The maximum length
- */
-export declare const isTextInRange: (value: unknown, minLength?: number, maxLength?: number) => boolean;
-/**
- * Checks if a value is a string and its word length is in a range
- * @param value The value to check
- * @param minWordLength The minimum word length
- * @param maxWordLength The maximum word length
- */
-export declare const isTextInWordRange: (value: unknown, minWordLength?: number, maxWordLength?: number) => boolean;

package/dist/types/validators/callout-component-content.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentContentSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentContentValidator: ValidatorCalloutComponent<CalloutComponentContentSchema, unknown>;

package/dist/types/validators/callout-component-input-address.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputAddressSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputAddressValidator: ValidatorCalloutComponent<CalloutComponentInputAddressSchema>;

package/dist/types/validators/callout-component-input-checkbox.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputCheckboxSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputCheckboxValidator: ValidatorCalloutComponent<CalloutComponentInputCheckboxSchema>;

package/dist/types/validators/callout-component-input-currency.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputCurrencySchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputCurrencyValidator: ValidatorCalloutComponent<CalloutComponentInputCurrencySchema>;

package/dist/types/validators/callout-component-input-date-time.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputDateTimeSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputDateTimeValidator: ValidatorCalloutComponent<CalloutComponentInputDateTimeSchema>;

package/dist/types/validators/callout-component-input-email.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputEmailSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputEmailValidator: ValidatorCalloutComponent<CalloutComponentInputEmailSchema>;

package/dist/types/validators/callout-component-input-file.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputFileSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputFileValidator: ValidatorCalloutComponent<CalloutComponentInputFileSchema>;

package/dist/types/validators/callout-component-input-number.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputNumberSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputNumberValidator: ValidatorCalloutComponent<CalloutComponentInputNumberSchema>;

package/dist/types/validators/callout-component-input-phone-number.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputPhoneNumberSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputPhoneNumberValidator: ValidatorCalloutComponent<CalloutComponentInputPhoneNumberSchema>;

package/dist/types/validators/callout-component-input-select.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputSelectSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputSelectValidator: ValidatorCalloutComponent<CalloutComponentInputSelectSchema>;

package/dist/types/validators/callout-component-input-selectable.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputSelectableSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputSelectableValidator: ValidatorCalloutComponent<CalloutComponentInputSelectableSchema>;

package/dist/types/validators/callout-component-input-signature.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputSignatureSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputSignatureValidator: ValidatorCalloutComponent<CalloutComponentInputSignatureSchema>;

package/dist/types/validators/callout-component-input-text.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputTextSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputTextValidator: ValidatorCalloutComponent<CalloutComponentInputTextSchema>;

package/dist/types/validators/callout-component-input-time.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputTimeSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputTimeValidator: ValidatorCalloutComponent<CalloutComponentInputTimeSchema>;

package/dist/types/validators/callout-component-input-url.validator.d.ts

@@ -1,2 +0,0 @@
-import type { CalloutComponentInputUrlSchema, ValidatorCalloutComponent } from "../types/index.ts";
-export declare const calloutComponentInputUrlValidator: ValidatorCalloutComponent<CalloutComponentInputUrlSchema>;

package/dist/types/validators/callout-component.validator.d.ts

@@ -1,5 +0,0 @@
-import type { CalloutComponentInputSchema, CalloutComponentNestableSchema, CalloutComponentSchema, CalloutResponseAnswer, CalloutResponseAnswers } from "../types/index.ts";
-export declare const calloutComponentNestableValidator: (schema: CalloutComponentNestableSchema, answers: CalloutResponseAnswers) => boolean;
-export declare function calloutComponentInputValidator(schema: CalloutComponentInputSchema, answer: CalloutResponseAnswer | CalloutResponseAnswer[] | undefined): boolean;
-export declare function calloutComponentValidator(schema: CalloutComponentSchema, answer: CalloutResponseAnswer | CalloutResponseAnswer[] | undefined): boolean;
-export declare function calloutComponentValidator(schema: CalloutComponentNestableSchema, answer: CalloutResponseAnswers): boolean;

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

@@ -1,16 +0,0 @@
-export * from "./callout-component-content.validator.ts";
-export * from "./callout-component-input-address.validator.ts";
-export * from "./callout-component-input-checkbox.validator.ts";
-export * from "./callout-component-input-currency.validator.ts";
-export * from "./callout-component-input-date-time.validator.ts";
-export * from "./callout-component-input-email.validator.ts";
-export * from "./callout-component-input-file.validator.ts";
-export * from "./callout-component-input-number.validator.ts";
-export * from "./callout-component-input-phone-number.validator.ts";
-export * from "./callout-component-input-select.validator.ts";
-export * from "./callout-component-input-selectable.validator.ts";
-export * from "./callout-component-input-signature.validator.ts";
-export * from "./callout-component-input-text.validator.ts";
-export * from "./callout-component-input-time.validator.ts";
-export * from "./callout-component-input-url.validator.ts";
-export * from "./callout-component.validator.ts";