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

package/src/search/operators.ts

@@ -0,0 +1,78 @@
+import type { OperatorsByType } from '../types/index.js';
+
+const equalityOperators = {
+  equal: { args: 1 },
+  not_equal: { args: 1 },
+} as const;
+
+const orderedOperators = {
+  between: { args: 2 },
+  not_between: { args: 2 },
+  less: { args: 1 },
+  greater: { args: 1 },
+  less_or_equal: { args: 1 },
+  greater_or_equal: { args: 1 },
+} as const;
+
+const stringOperators = {
+  begins_with: { args: 1 },
+  ends_with: { args: 1 },
+  not_begins_with: { args: 1 },
+  not_ends_with: { args: 1 },
+} as const;
+
+const numericOperators = {
+  ...equalityOperators,
+  ...orderedOperators,
+} as typeof orderedOperators & typeof equalityOperators;
+
+const arrayOperators = {
+  contains: { args: 1 },
+  not_contains: { args: 1 },
+} as const;
+
+// Special operator can be applied across all fields if they are nullable
+export const nullableOperators = {
+  is_empty: { args: 0 },
+  is_not_empty: { args: 0 },
+} as const;
+
+export const operatorsByType = {
+  text: {
+    ...equalityOperators,
+    ...arrayOperators,
+    ...stringOperators,
+  } as typeof equalityOperators &
+    typeof stringOperators &
+    typeof arrayOperators,
+  blob: arrayOperators as typeof arrayOperators,
+  date: numericOperators as typeof numericOperators,
+  number: numericOperators as typeof numericOperators,
+  boolean: { equal: equalityOperators.equal as typeof equalityOperators.equal },
+  array: { ...arrayOperators, ...nullableOperators } as typeof arrayOperators &
+    typeof nullableOperators,
+  enum: equalityOperators as typeof equalityOperators,
+  contact: equalityOperators as typeof equalityOperators,
+} as const;
+
+// More general type to allow mapping while maintaining full type above
+export const operatorsByTypeMap: OperatorsByType = operatorsByType;
+
+export const 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',
+] as const;

package/src/search/payments.ts

@@ -0,0 +1,38 @@
+import { PaymentStatus } from '../data/index.js';
+import { PaymentType } from '../data/payment-type.js';
+import type { Filters } from '../types/index.js';
+
+export const paymentFilters = {
+  id: {
+    type: 'text',
+  },
+  contact: {
+    type: 'contact',
+  },
+  chargeDate: {
+    type: 'date',
+  },
+  amount: {
+    type: 'number',
+  },
+  status: {
+    type: 'enum',
+    options: [
+      PaymentStatus.Draft,
+      PaymentStatus.Pending,
+      PaymentStatus.Successful,
+      PaymentStatus.Failed,
+      PaymentStatus.Cancelled,
+    ] satisfies readonly PaymentStatus[] as readonly PaymentStatus[],
+  },
+  type: {
+    type: 'enum',
+    options: [
+      PaymentType.Prorated,
+      PaymentType.Recurring,
+      PaymentType.OneTime,
+      PaymentType.Unknown,
+    ] satisfies readonly PaymentType[] as readonly PaymentType[],
+  },
+} as const;
+paymentFilters satisfies Filters;

package/src/search/segments.ts

@@ -0,0 +1,14 @@
+import type { Filters } from '../types/index.js';
+
+export const segmentFilters = {
+  id: {
+    type: 'text',
+  },
+  name: {
+    type: 'text',
+  },
+  description: {
+    type: 'text',
+  },
+} as const;
+segmentFilters satisfies Filters;

package/src/search/tags.ts

@@ -0,0 +1,16 @@
+import type { Filters } from '../types/index.js';
+
+export const tagFilters = {
+  id: {
+    type: 'text',
+  },
+  name: {
+    type: 'text',
+  },
+  description: {
+    type: 'text',
+  },
+} as const;
+tagFilters satisfies Filters;
+
+export type TagFiltersType = typeof tagFilters;

package/src/types/address.ts

@@ -0,0 +1,6 @@
+export interface Address {
+  line1: string;
+  line2?: string | undefined;
+  city: string;
+  postcode: string;
+}

package/src/types/allow-null.ts

@@ -0,0 +1,7 @@
+/**
+ * Allow null in place of possibly undefined fields, useful for create/update as
+ * JSON serialisation removes undefined keys
+ */
+export type AllowNull<T> = {
+  [P in keyof T]: undefined extends T[P] ? T[P] | null : T[P];
+};

package/src/types/api-error-data.ts

@@ -0,0 +1,166 @@
+import type {
+  ApiErrorCode,
+  LOGIN_CODES,
+  RESET_SECURITY_FLOW_ERROR_CODE,
+} from '../data/index.js';
+import type { Rule } from './rule.js';
+
+interface BaseApiErrorData {
+  httpCode: number;
+  code: ApiErrorCode | LOGIN_CODES;
+  message: string;
+}
+
+export interface BadRequestErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.BAD_REQUEST;
+}
+
+export interface UnauthorizedErrorData extends BaseApiErrorData {
+  httpCode: 401;
+  code: LOGIN_CODES;
+}
+
+export interface NotFoundErrorData extends BaseApiErrorData {
+  httpCode: 404;
+  code: ApiErrorCode.NOT_FOUND;
+}
+
+export interface PaymentFailedErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.PAYMENT_FAILED;
+  subCode: string;
+}
+
+export interface PaymentRequiresActionErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.PAYMENT_REQUIRES_ACTION;
+  clientSecret: string;
+}
+
+export interface TooManyRequestsErrorData extends BaseApiErrorData {
+  httpCode: 429;
+  code: ApiErrorCode.TOO_MANY_REQUESTS;
+  retryAfter: number;
+}
+
+export interface FileTooLargeErrorData extends BaseApiErrorData {
+  httpCode: 413;
+  code: ApiErrorCode.FILE_TOO_LARGE;
+  maxSize: number | undefined;
+  maxSizeDisplay: string | undefined;
+}
+
+export interface UnsupportedFileTypeErrorData extends BaseApiErrorData {
+  httpCode: 415;
+  code: ApiErrorCode.UNSUPPORTED_FILE_TYPE;
+  type: string;
+  allowedTypes: string[] | undefined;
+}
+
+export interface DuplicateIdErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.DUPLICATE_ID;
+  id: string;
+}
+
+export interface DuplicateEmailErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.DUPLICATE_EMAIL;
+  email: string;
+}
+
+export interface DuplicateTagNameErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.DUPLICATE_TAG_NAME;
+  tagName: string;
+}
+
+export interface NoPaymentMethodErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.NO_PAYMENT_METHOD;
+}
+
+export interface CantUpdateContributionErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.CANT_UPDATE_CONTRIBUTION;
+}
+
+export type InvalidCalloutResponseCode =
+  | 'only-anonymous'
+  | 'expired-user'
+  | 'closed'
+  | 'cant-update'
+  | 'guest-fields-missing'
+  | 'logged-in-guest-fields'
+  | 'unknown-user';
+
+export interface InvalidCalloutResponseErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.INVALID_CALLOUT_RESPONSE;
+  subCode: InvalidCalloutResponseCode;
+}
+
+export interface InvalidRuleErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.INVALID_RULE;
+  rule: Rule;
+}
+
+export interface CaptchaFailedErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.CAPTCHA_FAILED;
+}
+
+export interface CaptchaRequiredErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.CAPTCHA_REQUIRED;
+}
+
+export interface InternalServerErrorData extends BaseApiErrorData {
+  httpCode: 500;
+  code: ApiErrorCode.INTERNAL_SERVER_ERROR;
+}
+
+export interface CantUpdateNewsletterContactErrorData extends BaseApiErrorData {
+  httpCode: 500;
+  code: ApiErrorCode.CANT_UPDATE_NEWSLETTER_CONTACT;
+  email: string;
+  status: number;
+  data: any;
+}
+
+export interface FileUploadErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.FILE_UPLOAD_ERROR;
+  subCode: string;
+}
+
+export interface ResetSecurityFlowErrorData extends BaseApiErrorData {
+  httpCode: 400;
+  code: ApiErrorCode.RESET_SECURITY_FLOW_ERROR;
+  subCode: RESET_SECURITY_FLOW_ERROR_CODE;
+}
+
+export type ApiErrorData =
+  | BadRequestErrorData
+  | UnauthorizedErrorData
+  | NotFoundErrorData
+  | NoPaymentMethodErrorData
+  | InvalidCalloutResponseErrorData
+  | InvalidRuleErrorData
+  | CaptchaFailedErrorData
+  | CaptchaRequiredErrorData
+  | PaymentFailedErrorData
+  | PaymentRequiresActionErrorData
+  | TooManyRequestsErrorData
+  | FileTooLargeErrorData
+  | UnsupportedFileTypeErrorData
+  | DuplicateIdErrorData
+  | DuplicateEmailErrorData
+  | DuplicateTagNameErrorData
+  | InternalServerErrorData
+  | CantUpdateContributionErrorData
+  | CantUpdateNewsletterContactErrorData
+  | FileUploadErrorData
+  | ResetSecurityFlowErrorData;

package/src/types/api-key-filter-name.ts

@@ -0,0 +1,3 @@
+import type { apiKeyFilters } from '../search/api-keys.js';
+
+export type ApiKeyFilterName = keyof typeof apiKeyFilters;

package/src/types/array-filter-args.ts

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

package/src/types/auth-info-data.ts

@@ -0,0 +1,33 @@
+import { type RoleType } from '@beabee/beabee-common';
+
+import type { GetContactData } from './get-contact-data.js';
+
+interface AuthInfoNoneData {
+  method: 'none';
+  contact?: undefined;
+  roles: RoleType[]; // Should be empty
+}
+
+interface AuthInfoContactData {
+  method: 'user';
+  contact: GetContactData;
+  roles: RoleType[];
+}
+
+interface AuthInfoApiKeyData {
+  method: 'api-key';
+  contact?: GetContactData;
+  roles: RoleType[];
+}
+
+interface AuthInfoInternalData {
+  method: 'internal';
+  contact?: undefined;
+  roles: RoleType[];
+}
+
+export type AuthInfoData =
+  | AuthInfoNoneData
+  | AuthInfoContactData
+  | AuthInfoApiKeyData
+  | AuthInfoInternalData;

package/src/types/base-filter-args.ts

@@ -0,0 +1,6 @@
+import type { FilterType } from './index.js';
+
+export interface BaseFilterArgs {
+  type: FilterType;
+  nullable?: boolean;
+}

package/src/types/base-validated-rule.ts

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

package/src/types/callout-channel-filter-name.ts

@@ -0,0 +1,3 @@
+import type { calloutChannelFilters } from '../search/callouts.js';
+
+export type CalloutChannelFilterName = keyof typeof calloutChannelFilters;

package/src/types/callout-component-base-input-schema.ts

@@ -0,0 +1,31 @@
+import type { CalloutComponentType } from '../data/index.js';
+import type {
+  CalloutComponentBaseRules,
+  CalloutComponentBaseSchema,
+} from './index.js';
+
+export interface CalloutComponentBaseInputSchema extends CalloutComponentBaseSchema {
+  type:
+    | CalloutComponentType.INPUT_ADDRESS
+    | CalloutComponentType.INPUT_CHECKBOX
+    | CalloutComponentType.INPUT_CURRENCY
+    | CalloutComponentType.INPUT_DATE_TIME
+    | CalloutComponentType.INPUT_EMAIL
+    | CalloutComponentType.INPUT_FILE
+    | CalloutComponentType.INPUT_NUMBER
+    | CalloutComponentType.INPUT_PHONE_NUMBER
+    | CalloutComponentType.INPUT_SELECT
+    | CalloutComponentType.INPUT_SELECTABLE_RADIO
+    | CalloutComponentType.INPUT_SELECTABLE_SELECTBOXES
+    | CalloutComponentType.INPUT_SIGNATURE
+    | CalloutComponentType.INPUT_TEXT_AREA
+    | CalloutComponentType.INPUT_TEXT_FIELD
+    | CalloutComponentType.INPUT_TIME
+    | CalloutComponentType.INPUT_URL;
+  /** This is always true for input forms */
+  input: true;
+  /** The validation rules for input forms */
+  validate?: CalloutComponentBaseRules;
+  /** The description for the component */
+  description?: string;
+}

package/src/types/callout-component-base-input-selectable-schema.ts

@@ -0,0 +1,13 @@
+import type { CalloutComponentType } from '../data/index.js';
+import type {
+  CalloutComponentBaseInputSchema,
+  CalloutComponentBaseRules,
+} from './index.js';
+
+export interface CalloutComponentBaseInputSelectableSchema extends CalloutComponentBaseInputSchema {
+  type:
+    | CalloutComponentType.INPUT_SELECTABLE_RADIO
+    | CalloutComponentType.INPUT_SELECTABLE_SELECTBOXES;
+  values: { label: string; value: string; nextSlideId?: string }[];
+  validate?: CalloutComponentBaseRules;
+}

package/src/types/callout-component-base-input-text-schema.ts

@@ -0,0 +1,19 @@
+import type { CalloutComponentType } from '../data/index.js';
+import type {
+  CalloutComponentBaseInputSchema,
+  CalloutComponentInputTextRules,
+  TextCase,
+} from './index.js';
+
+/** The schema for input text forms */
+export interface CalloutComponentBaseInputTextSchema extends CalloutComponentBaseInputSchema {
+  type:
+    | CalloutComponentType.INPUT_TEXT_FIELD
+    | CalloutComponentType.INPUT_TEXT_AREA;
+  /** Placeholder for the form */
+  placeholder?: string;
+  /** The text case for the form */
+  case?: TextCase;
+  /** The validation rules for the form */
+  validate?: CalloutComponentInputTextRules;
+}

package/src/types/callout-component-base-map.ts

@@ -0,0 +1,24 @@
+import type { CalloutComponentBaseType } from '../data/index.js';
+import type {
+  CalloutComponentContentSchema,
+  CalloutComponentInputSchema,
+  CalloutComponentInputSelectableSchema,
+  CalloutComponentInputTextSchema,
+  CalloutComponentNestableSchema,
+} from './index.js';
+
+type CalloutComponentBaseSchemas = {
+  [CalloutComponentBaseType.CONTENT]: CalloutComponentContentSchema;
+
+  [CalloutComponentBaseType.INPUT]: CalloutComponentInputSchema;
+  [CalloutComponentBaseType.INPUT_TEXT]: CalloutComponentInputTextSchema;
+  [CalloutComponentBaseType.INPUT_SELECTABLE]: CalloutComponentInputSelectableSchema;
+  [CalloutComponentBaseType.NESTABLE]: CalloutComponentNestableSchema;
+};
+
+/**
+ * Each key is a CalloutComponentBaseType and the value is the corresponding schema from CalloutComponentBaseSchemas
+ */
+export type CalloutComponentBaseMap = {
+  [K in CalloutComponentBaseType]: CalloutComponentBaseSchemas[K];
+};

package/src/types/callout-component-base-nestable-schema.ts

@@ -0,0 +1,14 @@
+import type { CalloutComponentType } from '../data/index.js';
+import type {
+  CalloutComponentBaseSchema,
+  CalloutComponentSchema,
+} from './index.js';
+
+export interface CalloutComponentBaseNestableSchema extends CalloutComponentBaseSchema {
+  type:
+    | CalloutComponentType.NESTABLE_TABS
+    | CalloutComponentType.NESTABLE_PANEL
+    | CalloutComponentType.NESTABLE_WELL;
+  input: false;
+  components: CalloutComponentSchema[];
+}

package/src/types/callout-component-base-rules.ts

@@ -0,0 +1,6 @@
+export interface CalloutComponentBaseRules {
+  /** A required field must be filled in before the form can be submitted. */
+  required?: boolean;
+  /** Probably unused property from [formio](https://github.com/beabee-communityrm/formio.js) */
+  [key: string]: unknown;
+}

package/src/types/callout-component-base-schema.ts

@@ -0,0 +1,26 @@
+import type { CalloutComponentType } from '../data/index.js';
+import type {
+  CalloutComponentBaseRules,
+  CalloutResponseAnswer,
+} from './index.js';
+
+export interface CalloutComponentBaseSchema {
+  id: string;
+  type: CalloutComponentType;
+  key: string;
+  label?: string;
+  /** `true` if this is an input component */
+  input?: boolean;
+  /** `true` if the answer should only visible for admins */
+  adminOnly?: boolean;
+  /** Validation rules */
+  validate?: CalloutComponentBaseRules;
+  /** True if multiple responses / answers allowed */
+  multiple?: boolean;
+  /** If defined then this is the default value */
+  defaultValue?: CalloutResponseAnswer | CalloutResponseAnswer[] | null;
+  /** `true` if this component should be hidden */
+  hidden?: boolean;
+  /** Unused property */
+  [key: string]: unknown;
+}

package/src/types/callout-component-content-schema.ts

@@ -0,0 +1,13 @@
+import type { CalloutComponentType } from '../data/index.js';
+import type { CalloutComponentBaseSchema } from './index.js';
+
+/** A Callout content component only providing html content and accepts no answers. */
+export interface CalloutComponentContentSchema extends CalloutComponentBaseSchema {
+  type: CalloutComponentType.CONTENT;
+  /** The html content of the callout component. */
+  html: string;
+  /** The label for this field that will appear next to it. */
+  label: string;
+  /** This is always false for content components. */
+  input: false;
+}

package/src/types/callout-component-input-address-rules.ts

@@ -0,0 +1,3 @@
+import type { CalloutComponentBaseRules } from './index.js';
+
+export type CalloutComponentInputAddressRules = CalloutComponentBaseRules;

package/src/types/callout-component-input-address-schema.ts

@@ -0,0 +1,13 @@
+import type { CalloutComponentType } from '../data/index.js';
+import type {
+  CalloutComponentBaseInputSchema,
+  CalloutComponentInputAddressRules,
+} from './index.js';
+
+export interface CalloutComponentInputAddressSchema extends CalloutComponentBaseInputSchema {
+  type: CalloutComponentType.INPUT_ADDRESS;
+  /** The validation rules for the form */
+  validate?: CalloutComponentInputAddressRules;
+  /** Placeholder for the form */
+  placeholder?: string;
+}

package/src/types/callout-component-input-checkbox-rules.ts

@@ -0,0 +1,3 @@
+import type { CalloutComponentBaseRules } from './index.js';
+
+export type CalloutComponentInputCheckboxRules = CalloutComponentBaseRules;

package/src/types/callout-component-input-checkbox-schema.ts

@@ -0,0 +1,18 @@
+import type { CalloutComponentType } from '../data/index.js';
+import type {
+  CalloutComponentBaseInputSchema,
+  CalloutComponentInputCheckboxRules,
+} from './index.js';
+
+export interface CalloutComponentInputCheckboxSchema extends CalloutComponentBaseInputSchema {
+  type: CalloutComponentType.INPUT_CHECKBOX;
+
+  /** Can not be set to true for checkboxes */
+  multiple?: false;
+
+  /** The default value for the checkbox */
+  defaultValue?: boolean;
+
+  /** The validation rules for the form */
+  validate?: CalloutComponentInputCheckboxRules;
+}

package/src/types/callout-component-input-currency-rules.ts

@@ -0,0 +1,3 @@
+import type { CalloutComponentBaseRules } from './index.js';
+
+export type CalloutComponentInputCurrencyRules = CalloutComponentBaseRules;

package/src/types/callout-component-input-currency-schema.ts

@@ -0,0 +1,22 @@
+import type { CalloutComponentType } from '../data/index.js';
+import type {
+  CalloutComponentBaseInputSchema,
+  CalloutComponentInputCurrencyRules,
+  TextCase,
+} from './index.js';
+
+export interface CalloutComponentInputCurrencySchema extends CalloutComponentBaseInputSchema {
+  type: CalloutComponentType.INPUT_CURRENCY;
+  /** Placeholder for the form */
+  placeholder?: string;
+  /** The text case for the form */
+  case: TextCase;
+  /** If `true` multiple spaces will be truncated to a single space */
+  truncateMultipleSpaces?: boolean;
+  /** E.g. USD, EUR, GBP, etc. */
+  currency: string;
+  /** The default value for the form */
+  defaultValue?: number | number[];
+  /** The validation rules for the form */
+  validate?: CalloutComponentInputCurrencyRules;
+}

package/src/types/callout-component-input-date-time-rules.ts

@@ -0,0 +1,3 @@
+import type { CalloutComponentBaseRules } from './index.js';
+
+export type CalloutComponentInputDateTimeRules = CalloutComponentBaseRules;