@beabee/beabee-common 1.19.5 → 1.19.7

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

@@ -1,194 +1,6 @@
-export declare const ruleOperators: readonly ["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 type RuleOperator = (typeof ruleOperators)[number];
-export type RuleValue = string | number | boolean;
-export interface Rule {
-    field: string;
-    operator: RuleOperator;
-    value: RuleValue[];
-}
-export interface RuleGroup {
-    condition: "AND" | "OR";
-    rules: (RuleGroup | Rule)[];
-}
-export type ValidatedRuleValue<T extends FilterType> = T extends "number" ? number : T extends "boolean" ? boolean : string;
-interface BaseValidatedRule<T extends FilterType, F extends string> {
-    type: T;
-    field: F;
-    nullable: boolean;
-    operator: keyof (typeof operatorsByType)[T];
-    value: ValidatedRuleValue<T>[];
-}
-type ValidatedNumberRule<Field extends string> = BaseValidatedRule<"number", Field>;
-type ValidatedStringRule<Field extends string> = BaseValidatedRule<Exclude<FilterType, "number" | "boolean">, Field>;
-type ValidatedBooleanRule<Field extends string> = BaseValidatedRule<"boolean", Field>;
-export type ValidatedRule<Field extends string> = ValidatedNumberRule<Field> | ValidatedStringRule<Field> | ValidatedBooleanRule<Field>;
-export interface ValidatedRuleGroup<Field extends string> {
-    condition: "AND" | "OR";
-    rules: (ValidatedRuleGroup<Field> | ValidatedRule<Field>)[];
-}
-export type FilterType = "text" | "blob" | "date" | "number" | "boolean" | "array" | "enum" | "contact";
-interface BaseFilterArgs {
-    type: FilterType;
-    nullable?: boolean;
-}
-export interface ArrayFilterArgs<T extends readonly string[] | undefined> extends BaseFilterArgs {
-    type: "array";
-    options?: T;
-}
-export interface EnumFilterArgs<T extends readonly string[]> extends BaseFilterArgs {
-    type: "enum";
-    options: T;
-}
-export interface OtherFilterArgs extends BaseFilterArgs {
-    type: Exclude<FilterType, "array" | "enum">;
-}
-export type FilterArgs = ArrayFilterArgs<readonly string[] | undefined> | EnumFilterArgs<readonly string[]> | OtherFilterArgs;
-export type Filters<T extends string = string> = Record<T, FilterArgs>;
-export interface RuleOperatorParams {
-    args: number;
-}
-export declare const nullableOperators: {
-    is_empty: {
-        args: number;
-    };
-    is_not_empty: {
-        args: number;
-    };
-};
-type OperatorsByType = Record<FilterType, Partial<Record<RuleOperator, RuleOperatorParams>>>;
-export declare const operatorsByType: {
-    readonly text: {
-        readonly begins_with: {
-            args: number;
-        };
-        readonly ends_with: {
-            args: number;
-        };
-        readonly not_begins_with: {
-            args: number;
-        };
-        readonly not_ends_with: {
-            args: number;
-        };
-        readonly contains: {
-            args: number;
-        };
-        readonly not_contains: {
-            args: number;
-        };
-        readonly equal: {
-            args: number;
-        };
-        readonly not_equal: {
-            args: number;
-        };
-    };
-    readonly blob: {
-        contains: {
-            args: number;
-        };
-        not_contains: {
-            args: number;
-        };
-    };
-    readonly date: {
-        between: {
-            args: number;
-        };
-        not_between: {
-            args: number;
-        };
-        less: {
-            args: number;
-        };
-        greater: {
-            args: number;
-        };
-        less_or_equal: {
-            args: number;
-        };
-        greater_or_equal: {
-            args: number;
-        };
-        equal: {
-            args: number;
-        };
-        not_equal: {
-            args: number;
-        };
-    };
-    readonly number: {
-        between: {
-            args: number;
-        };
-        not_between: {
-            args: number;
-        };
-        less: {
-            args: number;
-        };
-        greater: {
-            args: number;
-        };
-        less_or_equal: {
-            args: number;
-        };
-        greater_or_equal: {
-            args: number;
-        };
-        equal: {
-            args: number;
-        };
-        not_equal: {
-            args: number;
-        };
-    };
-    readonly boolean: {
-        readonly equal: {
-            args: number;
-        };
-    };
-    readonly array: {
-        contains: {
-            args: number;
-        };
-        not_contains: {
-            args: number;
-        };
-    };
-    readonly enum: {
-        equal: {
-            args: number;
-        };
-        not_equal: {
-            args: number;
-        };
-    };
-    readonly contact: {
-        equal: {
-            args: number;
-        };
-        not_equal: {
-            args: number;
-        };
-    };
-};
-export declare const operatorsByTypeMap: OperatorsByType;
-export interface Paginated<T> {
-    items: T[];
-    offset: number;
-    count: number;
-    total: number;
-}
-export interface PaginatedQuery {
-    limit?: number;
-    offset?: number;
-    sort?: string;
-    order?: "ASC" | "DESC";
-    rules?: RuleGroup;
-}
-export * from "./api-keys";
-export * from "./callouts";
-export * from "./contacts";
-export * from "./notices";
-export * from "./payments";
+export * from "./api-keys.ts";
+export * from "./callouts.ts";
+export * from "./contacts.ts";
+export * from "./notices.ts";
+export * from "./operators.ts";
+export * from "./payments.ts";

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

@@ -1,4 +1,4 @@
-import { ItemStatus } from "../data";
+import { ItemStatus } from "../data/index.ts";
 export declare const noticeFilters: {
     readonly id: {
         readonly type: "text";
@@ -27,4 +27,3 @@ export declare const noticeFilters: {
         readonly options: readonly [ItemStatus.Draft, ItemStatus.Scheduled, ItemStatus.Open, ItemStatus.Ended];
     };
 };
-export type NoticeFilterName = keyof typeof noticeFilters;

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

@@ -0,0 +1,128 @@
+import type { OperatorsByType } from "../types/index.ts";
+export declare const nullableOperators: {
+    is_empty: {
+        args: number;
+    };
+    is_not_empty: {
+        args: number;
+    };
+};
+export declare const operatorsByType: {
+    readonly text: {
+        readonly begins_with: {
+            args: number;
+        };
+        readonly ends_with: {
+            args: number;
+        };
+        readonly not_begins_with: {
+            args: number;
+        };
+        readonly not_ends_with: {
+            args: number;
+        };
+        readonly contains: {
+            args: number;
+        };
+        readonly not_contains: {
+            args: number;
+        };
+        readonly equal: {
+            args: number;
+        };
+        readonly not_equal: {
+            args: number;
+        };
+    };
+    readonly blob: {
+        contains: {
+            args: number;
+        };
+        not_contains: {
+            args: number;
+        };
+    };
+    readonly date: {
+        between: {
+            args: number;
+        };
+        not_between: {
+            args: number;
+        };
+        less: {
+            args: number;
+        };
+        greater: {
+            args: number;
+        };
+        less_or_equal: {
+            args: number;
+        };
+        greater_or_equal: {
+            args: number;
+        };
+        equal: {
+            args: number;
+        };
+        not_equal: {
+            args: number;
+        };
+    };
+    readonly number: {
+        between: {
+            args: number;
+        };
+        not_between: {
+            args: number;
+        };
+        less: {
+            args: number;
+        };
+        greater: {
+            args: number;
+        };
+        less_or_equal: {
+            args: number;
+        };
+        greater_or_equal: {
+            args: number;
+        };
+        equal: {
+            args: number;
+        };
+        not_equal: {
+            args: number;
+        };
+    };
+    readonly boolean: {
+        readonly equal: {
+            args: number;
+        };
+    };
+    readonly array: {
+        contains: {
+            args: number;
+        };
+        not_contains: {
+            args: number;
+        };
+    };
+    readonly enum: {
+        equal: {
+            args: number;
+        };
+        not_equal: {
+            args: number;
+        };
+    };
+    readonly contact: {
+        equal: {
+            args: number;
+        };
+        not_equal: {
+            args: number;
+        };
+    };
+};
+export declare const operatorsByTypeMap: OperatorsByType;
+export declare const ruleOperators: readonly ["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"];

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

@@ -1,4 +1,4 @@
-import { PaymentStatus } from "../data";
+import { PaymentStatus } from "../data/index.ts";
 export declare const paymentFilters: {
     readonly id: {
         readonly type: "text";
@@ -17,4 +17,3 @@ export declare const paymentFilters: {
         readonly options: readonly [PaymentStatus.Successful, PaymentStatus.Pending, PaymentStatus.Failed, PaymentStatus.Cancelled];
     };
 };
-export type PaymentFilterName = keyof typeof paymentFilters;

package/dist/types/types/api-key-filter-name.d.ts

@@ -0,0 +1,2 @@
+import type { apiKeyFilters } from "../search/api-keys.ts";
+export type ApiKeyFilterName = keyof typeof apiKeyFilters;

package/dist/types/types/array-filter-args.d.ts

@@ -0,0 +1,5 @@
+import type { BaseFilterArgs } from "./index.ts";
+export interface ArrayFilterArgs<T extends readonly string[] | undefined> extends BaseFilterArgs {
+    type: "array";
+    options?: T;
+}

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

@@ -0,0 +1,9 @@
+export interface BaseCalloutComponentSchema {
+    id: string;
+    type: string;
+    key: string;
+    label?: string;
+    input?: boolean;
+    adminOnly?: boolean;
+    [key: string]: unknown;
+}

package/dist/types/types/base-filter-args.d.ts

@@ -0,0 +1,5 @@
+import type { FilterType } from "./index.ts";
+export interface BaseFilterArgs {
+    type: FilterType;
+    nullable?: boolean;
+}

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

@@ -0,0 +1,9 @@
+import type { FilterType, ValidatedRuleValue } from "./index.ts";
+import type { operatorsByType } from "../search/operators.ts";
+export interface BaseValidatedRule<T extends FilterType, F extends string> {
+    type: T;
+    field: F;
+    nullable: boolean;
+    operator: keyof (typeof operatorsByType)[T];
+    value: ValidatedRuleValue<T>[];
+}

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

@@ -0,0 +1,2 @@
+import type { ContentCalloutComponentSchema, InputCalloutComponentSchema, NestableCalloutComponentSchema, RadioCalloutComponentSchema, SelectCalloutComponentSchema } from "./index.ts";
+export type CalloutComponentSchema = ContentCalloutComponentSchema | SelectCalloutComponentSchema | RadioCalloutComponentSchema | InputCalloutComponentSchema | NestableCalloutComponentSchema;

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

@@ -0,0 +1,2 @@
+import type { calloutFilters } from "../search/callouts.ts";
+export type CalloutFilterName = keyof typeof calloutFilters;

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

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

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

@@ -0,0 +1,6 @@
+export interface CalloutNavigationSchema {
+    prevText: string;
+    nextText: string;
+    nextSlideId: string;
+    submitText: string;
+}

package/dist/types/types/callout-response-answer-address.d.ts

@@ -0,0 +1,9 @@
+export interface CalloutResponseAnswerAddress {
+    formatted_address: string;
+    geometry: {
+        location: {
+            lat: number;
+            lng: number;
+        };
+    };
+}

package/dist/types/types/callout-response-answer-file-upload.d.ts

@@ -0,0 +1,3 @@
+export interface CalloutResponseAnswerFileUpload {
+    url: string;
+}

package/dist/types/types/callout-response-answer.d.ts

@@ -0,0 +1,2 @@
+import type { CalloutResponseAnswerAddress, CalloutResponseAnswerFileUpload } from "./index.ts";
+export type CalloutResponseAnswer = string | boolean | number | null | undefined | Record<string, boolean> | CalloutResponseAnswerAddress | CalloutResponseAnswerFileUpload;

package/dist/types/types/callout-response-answers.d.ts

@@ -0,0 +1,5 @@
+import type { CalloutResponseAnswer } from "./index.ts";
+/**
+ * Answers are grouped by slide key: {[slideId]: {[componentKey]: answer | answer[]}}
+ */
+export type CalloutResponseAnswers = Record<string, Record<string, CalloutResponseAnswer | CalloutResponseAnswer[]> | undefined>;

package/dist/types/types/callout-response-comment-filter-name.d.ts

@@ -0,0 +1,2 @@
+import type { calloutResponseCommentFilters } from "../search/callouts.ts";
+export type CalloutResponseCommentFilterName = keyof typeof calloutResponseCommentFilters;

package/dist/types/types/callout-response-filter-name.d.ts

@@ -0,0 +1,2 @@
+import { calloutResponseFilters } from "../search/callouts.ts";
+export type CalloutResponseFilterName = keyof typeof calloutResponseFilters;

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

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

package/dist/types/types/callout-tag-filter-name.d.ts

@@ -0,0 +1,2 @@
+import type { calloutTagFilters } from "../search/callouts.ts";
+export type CalloutTagFilterName = keyof typeof calloutTagFilters;

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

@@ -0,0 +1,5 @@
+import { BaseCalloutComponentSchema } from "./index.ts";
+export interface ContentCalloutComponentSchema extends BaseCalloutComponentSchema {
+    type: "content";
+    input: false;
+}

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

@@ -0,0 +1,2 @@
+import type { dateUnits } from "../utils/date.ts";
+export type DateUnit = (typeof dateUnits)[number];

package/dist/types/types/duration.d.ts

@@ -0,0 +1 @@
+export type { Duration } from "date-fns";

package/dist/types/types/enum-filter-args.d.ts

@@ -0,0 +1,5 @@
+import type { BaseFilterArgs } from "./index.ts";
+export interface EnumFilterArgs<T extends readonly string[]> extends BaseFilterArgs {
+    type: "enum";
+    options: T;
+}

package/dist/types/types/feeable.d.ts

@@ -0,0 +1,6 @@
+import type { ContributionPeriod, PaymentMethod } from "../data/index.ts";
+export interface Feeable {
+    amount: number;
+    period: ContributionPeriod;
+    paymentMethod: PaymentMethod;
+}

package/dist/types/types/filter-args.d.ts

@@ -0,0 +1,2 @@
+import type { ArrayFilterArgs, EnumFilterArgs, OtherFilterArgs } from "./index.ts";
+export type FilterArgs = ArrayFilterArgs<readonly string[] | undefined> | EnumFilterArgs<readonly string[]> | OtherFilterArgs;

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

@@ -0,0 +1 @@
+export type FilterType = "text" | "blob" | "date" | "number" | "boolean" | "array" | "enum" | "contact";

package/dist/types/types/filters.d.ts

@@ -0,0 +1,2 @@
+import { FilterArgs } from "../types/index.ts";
+export type Filters<T extends string = string> = Record<T, FilterArgs>;

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

@@ -0,0 +1,50 @@
+export * from "./api-key-filter-name.ts";
+export * from "./array-filter-args.ts";
+export * from "./base-callout-component-schema.ts";
+export * from "./base-filter-args.ts";
+export * from "./base-validated-rule.ts";
+export * from "./callout-component-schema.ts";
+export * from "./callout-filter-name.ts";
+export * from "./callout-form-schema.ts";
+export * from "./callout-navigation-schema.ts";
+export * from "./callout-response-answer-address.ts";
+export * from "./callout-response-answer-file-upload.ts";
+export * from "./callout-response-answer.ts";
+export * from "./callout-response-answers.ts";
+export * from "./callout-response-comment-filter-name.ts";
+export * from "./callout-response-filter-name.ts";
+export * from "./callout-slide-schema.ts";
+export * from "./callout-tag-filter-name.ts";
+export * from "./content-callout-component-schema.ts";
+export * from "./date-unit.ts";
+export * from "./duration.ts";
+export * from "./enum-filter-args.ts";
+export * from "./feeable.ts";
+export * from "./filter-args.ts";
+export * from "./filter-type.ts";
+export * from "./filters.ts";
+export * from "./input-callout-component-schema.ts";
+export * from "./input-file-callout-component-schema.ts";
+export * from "./nestable-callout-component-schema.ts";
+export * from "./notice-filter-name.ts";
+export * from "./operators-by-type.ts";
+export * from "./other-filter-args.ts";
+export * from "./paginated-query.ts";
+export * from "./paginated.ts";
+export * from "./payment-filter-name.ts";
+export * from "./radio-callout-component-schema.ts";
+export * from "./role-type.ts";
+export * from "./rule-group.ts";
+export * from "./rule-operator.ts";
+export * from "./rule-opperator-params.ts";
+export * from "./rule-value.ts";
+export * from "./rule.ts";
+export * from "./select-callout-component-schema.ts";
+export * from "./stripe-fee-country.ts";
+export * from "./unit-matches.ts";
+export * from "./validated-boolean-rule.ts";
+export * from "./validated-number-rule.ts";
+export * from "./validated-rule-group.ts";
+export * from "./validated-rule-value.ts";
+export * from "./validated-rule.ts";
+export * from "./validated-string-rule.ts";

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

@@ -0,0 +1,6 @@
+import type { BaseCalloutComponentSchema } from "./index.ts";
+export interface InputCalloutComponentSchema extends BaseCalloutComponentSchema {
+    type: "address" | "button" | "checkbox" | "email" | "file" | "number" | "password" | "textfield" | "textarea" | "content" | "phoneNumber" | "currency" | "datetime" | "time" | "url" | "signature";
+    input: true;
+    placeholder?: string;
+}

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

@@ -0,0 +1,5 @@
+import type { InputCalloutComponentSchema } from "./index.ts";
+export interface InputFileCalloutComponentSchema extends InputCalloutComponentSchema {
+    type: "file";
+    filePattern: string;
+}

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

@@ -0,0 +1,6 @@
+import type { BaseCalloutComponentSchema, CalloutComponentSchema } from "./index.ts";
+export interface NestableCalloutComponentSchema extends BaseCalloutComponentSchema {
+    type: "panel" | "well" | "tabs";
+    input: false;
+    components: CalloutComponentSchema[];
+}

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

@@ -0,0 +1,2 @@
+import { noticeFilters } from "../search/notices.ts";
+export type NoticeFilterName = keyof typeof noticeFilters;

package/dist/types/types/operators-by-type.d.ts

@@ -0,0 +1,2 @@
+import type { FilterType, RuleOperator, RuleOperatorParams } from "./index.ts";
+export type OperatorsByType = Record<FilterType, Partial<Record<RuleOperator, RuleOperatorParams>>>;

package/dist/types/types/other-filter-args.d.ts

@@ -0,0 +1,4 @@
+import type { BaseFilterArgs, FilterType } from "./index.ts";
+export interface OtherFilterArgs extends BaseFilterArgs {
+    type: Exclude<FilterType, "array" | "enum">;
+}

package/dist/types/types/paginated-query.d.ts

@@ -0,0 +1,8 @@
+import type { RuleGroup } from "./index.ts";
+export interface PaginatedQuery {
+    limit?: number;
+    offset?: number;
+    sort?: string;
+    order?: "ASC" | "DESC";
+    rules?: RuleGroup;
+}

package/dist/types/types/paginated.d.ts

@@ -0,0 +1,6 @@
+export interface Paginated<T> {
+    items: T[];
+    offset: number;
+    count: number;
+    total: number;
+}

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

@@ -0,0 +1,2 @@
+import { paymentFilters } from "../search/payments.ts";
+export type PaymentFilterName = keyof typeof paymentFilters;

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

@@ -0,0 +1,10 @@
+import type { BaseCalloutComponentSchema } from "./index.ts";
+export interface RadioCalloutComponentSchema extends BaseCalloutComponentSchema {
+    type: "radio" | "selectboxes";
+    input: true;
+    values: {
+        label: string;
+        value: string;
+        nextSlideId: string;
+    }[];
+}

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

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

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+export type RuleValue = string | number | boolean;

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

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