@beabee/beabee-common 0.20.5 → 0.21.0-alpha.1

package/dist/types/types/get-callout-response-data-with.d.ts

@@ -0,0 +1,17 @@
+import type { CalloutResponseAnswers, GetCalloutData, GetCalloutResponseCommentData, GetCalloutResponseData, GetCalloutResponseWith, GetContactData, Noop } from "./index.ts";
+export type GetCalloutResponseDataWith<With extends GetCalloutResponseWith> = GetCalloutResponseData & ("answers" extends With ? {
+    answers: CalloutResponseAnswers;
+} : Noop) & ("assignee" extends With ? {
+    assignee: GetContactData | null;
+} : Noop) & ("callout" extends With ? {
+    callout: GetCalloutData;
+} : Noop) & ("contact" extends With ? {
+    contact: GetContactData | null;
+} : Noop) & ("latestComment" extends With ? {
+    latestComment: GetCalloutResponseCommentData | null;
+} : Noop) & ("tags" extends With ? {
+    tags: {
+        id: string;
+        name: string;
+    }[];
+} : Noop);

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

@@ -0,0 +1,9 @@
+export interface GetCalloutResponseData {
+    id: string;
+    number: number;
+    createdAt: Date;
+    updatedAt: Date;
+    bucket: string;
+    guestName: string | null;
+    guestEmail: string | null;
+}

package/dist/types/types/get-callout-response-map-data.d.ts

@@ -0,0 +1,8 @@
+import type { CalloutResponseAnswerAddress, CalloutResponseAnswerFileUpload, CalloutResponseAnswers } from "./index.ts";
+export interface GetCalloutResponseMapData {
+    number: number;
+    answers: CalloutResponseAnswers;
+    title: string;
+    photos: CalloutResponseAnswerFileUpload[];
+    address?: CalloutResponseAnswerAddress;
+}

package/dist/types/types/get-callout-response-with.d.ts

@@ -0,0 +1 @@
+export type GetCalloutResponseWith = "answers" | "assignee" | "callout" | "contact" | "latestComment" | "tags" | void;

package/dist/types/types/get-callout-responses-query.d.ts

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

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

@@ -0,0 +1,4 @@
+export interface GetCalloutTagData {
+    id: string;
+    name: string;
+}

package/dist/types/types/get-callout-with.d.ts

@@ -0,0 +1 @@
+export type GetCalloutWith = "form" | "responseViewSchema" | "responseCount" | "hasAnswered" | void;

package/dist/types/types/get-callouts-query.d.ts

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

package/dist/types/types/get-contact-data-with.d.ts

@@ -0,0 +1,8 @@
+import type { ContactProfileData, ContactRoleData, ContributionInfo, GetContactData, GetContactWith, Noop } from "./index.ts";
+export type GetContactDataWith<With extends GetContactWith> = GetContactData & ("profile" extends With ? {
+    profile: ContactProfileData;
+} : Noop) & ("contribution" extends With ? {
+    contribution: ContributionInfo;
+} : Noop) & ("roles" extends With ? {
+    roles: ContactRoleData[];
+} : Noop);

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

@@ -0,0 +1,10 @@
+import type { ContributionPeriod } from "../data/index.ts";
+import type { ContactData, RoleType } from "./index.ts";
+export interface GetContactData extends ContactData {
+    id: string;
+    joined: Date;
+    lastSeen?: Date;
+    contributionAmount?: number;
+    contributionPeriod?: ContributionPeriod;
+    activeRoles: RoleType[];
+}

package/dist/types/types/get-contact-with.d.ts

@@ -0,0 +1 @@
+export type GetContactWith = "profile" | "contribution" | "roles" | void;

package/dist/types/types/get-contacts-query.d.ts

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

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

@@ -0,0 +1,4 @@
+export interface GetEmailData {
+    subject: string;
+    body: string;
+}

package/dist/types/types/get-notice-data.d.ts

@@ -0,0 +1,8 @@
+import { ItemStatus } from "../data/index.ts";
+import { NoticeData } from "./index.ts";
+export interface GetNoticeData extends NoticeData {
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    status: ItemStatus;
+}

package/dist/types/types/get-notices-query.d.ts

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

package/dist/types/types/get-payment-data-with.d.ts

@@ -0,0 +1,4 @@
+import type { GetContactData, GetPaymentData, GetPaymentWith, Noop } from "./index.ts";
+export type GetPaymentDataWith<With extends GetPaymentWith> = GetPaymentData & ("contact" extends With ? {
+    contact: GetContactData | null;
+} : Noop);

package/dist/types/types/get-payment-data.d.ts

@@ -0,0 +1,6 @@
+import type { PaymentStatus } from "../data/index.ts";
+export interface GetPaymentData {
+    chargeDate: Date;
+    amount: number;
+    status: PaymentStatus;
+}

package/dist/types/types/get-payment-with.d.ts

@@ -0,0 +1 @@
+export type GetPaymentWith = "contact" | void;

package/dist/types/types/get-payments-query.d.ts

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

package/dist/types/types/get-segment-data-with.d.ts

@@ -0,0 +1,4 @@
+import { GetSegmentData, GetSegmentWith, Noop } from "./index.ts";
+export type GetSegmentDataWith<With extends GetSegmentWith> = GetSegmentData & ("contactCount" extends With ? {
+    contactCount: number;
+} : Noop);

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

@@ -0,0 +1,7 @@
+import type { RuleGroup } from "./index.ts";
+export interface GetSegmentData {
+    id: string;
+    name: string;
+    ruleGroup: RuleGroup;
+    order: number;
+}

package/dist/types/types/get-segment-with.d.ts

@@ -0,0 +1 @@
+export type GetSegmentWith = "contactCount" | void;

package/dist/types/types/get-stats-data.d.ts

@@ -0,0 +1,5 @@
+export interface GetStatsData {
+    newContacts: number;
+    averageContribution: number | null;
+    totalRevenue: number | null;
+}

package/dist/types/types/get-stats-query.d.ts

@@ -0,0 +1,4 @@
+export interface GetStatsQuery {
+    from: Date;
+    to: Date;
+}

package/dist/types/types/get-upload-flow-data.d.ts

@@ -0,0 +1,3 @@
+export interface GetUploadFlowData {
+    id: string;
+}

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

@@ -1,3 +1,5 @@
+export * from "./address.ts";
+export * from "./allow-null.ts";
 export * from "./api-key-filter-name.ts";
 export * from "./array-filter-args.ts";
 export * from "./base-filter-args.ts";
@@ -50,15 +52,44 @@ export * from "./callout-component-nestable-schema.ts";
 export * from "./callout-component-nestable-tabs-schema.ts";
 export * from "./callout-component-nestable-well-schema.ts";
 export * from "./callout-component-schema.ts";
+export * from "./callout-data.ts";
 export * from "./callout-filter-name.ts";
+export * from "./callout-map-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-slide.ts";
 export * from "./callout-response-answers.ts";
+export * from "./callout-response-comment-data.ts";
 export * from "./callout-response-comment-filter-name.ts";
 export * from "./callout-response-filter-name.ts";
+export * from "./callout-response-view-schema.ts";
 export * from "./callout-tag-filter-name.ts";
+export * from "./client-api-error-data.ts";
+export * from "./contact-data.ts";
+export * from "./contact-profile-data.ts";
+export * from "./contact-role-data.ts";
+export * from "./content-contacts-data.ts";
+export * from "./content-data.ts";
+export * from "./content-email-data.ts";
+export * from "./content-general-data.ts";
+export * from "./content-id.ts";
+export * from "./content-join-data.ts";
+export * from "./content-join-period-data.ts";
+export * from "./content-join-setup-data.ts";
+export * from "./content-payment-data.ts";
+export * from "./content-profile-data.ts";
+export * from "./content-share-data.ts";
+export * from "./content-telegram-data.ts";
+export * from "./contribution-info.ts";
+export * from "./create-api-key-data.ts";
+export * from "./create-callout-data.ts";
+export * from "./create-callout-response-comment-data.ts";
+export * from "./create-callout-response-data.ts";
+export * from "./create-callout-tag-data.ts";
+export * from "./create-contact-data.ts";
+export * from "./create-notice-data.ts";
+export * from "./create-segment-data.ts";
 export * from "./date-unit.ts";
 export * from "./duration.ts";
 export * from "./enum-filter-args.ts";
@@ -66,14 +97,51 @@ export * from "./feeable.ts";
 export * from "./filter-args.ts";
 export * from "./filter-type.ts";
 export * from "./filters.ts";
+export * from "./footer-link.ts";
+export * from "./force-update-contribution-data.ts";
+export * from "./get-api-key-data.ts";
+export * from "./get-api-keys-query.ts";
+export * from "./get-callout-data-with.ts";
+export * from "./get-callout-data.ts";
+export * from "./get-callout-form-data.ts";
 export * from "./get-callout-form-schema.ts";
 export * from "./get-callout-navigation-schema.ts";
+export * from "./get-callout-response-comment-data.ts";
+export * from "./get-callout-response-comments-query.ts";
+export * from "./get-callout-response-data-with.ts";
+export * from "./get-callout-response-data.ts";
+export * from "./get-callout-response-map-data.ts";
+export * from "./get-callout-response-with.ts";
+export * from "./get-callout-responses-query.ts";
 export * from "./get-callout-slide-schema.ts";
+export * from "./get-callout-tag-data.ts";
+export * from "./get-callout-with.ts";
+export * from "./get-callouts-query.ts";
+export * from "./get-contact-data-with.ts";
+export * from "./get-contact-data.ts";
+export * from "./get-contact-with.ts";
+export * from "./get-contacts-query.ts";
+export * from "./get-email-data.ts";
+export * from "./get-notice-data.ts";
+export * from "./get-notices-query.ts";
+export * from "./get-payment-data-with.ts";
+export * from "./get-payment-data.ts";
+export * from "./get-payment-with.ts";
+export * from "./get-payments-query.ts";
+export * from "./get-segment-data-with.ts";
+export * from "./get-segment-data.ts";
+export * from "./get-segment-with.ts";
+export * from "./get-stats-data.ts";
+export * from "./get-stats-query.ts";
+export * from "./get-upload-flow-data.ts";
+export * from "./noop.ts";
+export * from "./notice-data.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 "./parse-iso-options.ts";
 export * from "./payment-filter-name.ts";
 export * from "./payment-source-go-cardless-direct-debit.ts";
 export * from "./payment-source-manual.ts";
@@ -89,12 +157,25 @@ export * from "./rule-opperator-params.ts";
 export * from "./rule-value.ts";
 export * from "./rule.ts";
 export * from "./segment-filter-name.ts";
+export * from "./serial.ts";
 export * from "./set-callout-form-schema.ts";
 export * from "./set-callout-navigation-schema.ts";
 export * from "./set-callout-slide-schema.ts";
+export * from "./set-contribution-data.ts";
+export * from "./start-contribution-data.ts";
 export * from "./stripe-fee-country.ts";
 export * from "./text-case.ts";
 export * from "./unit-matches.ts";
+export * from "./update-callout-data.ts";
+export * from "./update-callout-response-comment-data.ts";
+export * from "./update-callout-response-data.ts";
+export * from "./update-callout-tag-data.ts";
+export * from "./update-contact-data.ts";
+export * from "./update-contact-profile-data.ts";
+export * from "./update-contact-role-data.ts";
+export * from "./update-email-data.ts";
+export * from "./update-reset-password-data.ts";
+export * from "./update-segment-data.ts";
 export * from "./validated-boolean-rule.ts";
 export * from "./validated-number-rule.ts";
 export * from "./validated-rule-group.ts";

package/dist/types/types/noop.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Not really sure why but this work for conditional intersections
+ * https://stackoverflow.com/questions/65549362/how-to-create-a-conditional-intersection-based-on-a-generic-parameter
+ */
+export type Noop = {};

package/dist/types/types/notice-data.d.ts

@@ -0,0 +1,8 @@
+export interface NoticeData {
+    name: string;
+    starts: Date | null;
+    expires: Date | null;
+    text: string;
+    buttonText?: string;
+    url?: string;
+}

package/dist/types/types/parse-iso-options.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The {@link parseISO} function options.
+ */
+export interface ParseISOOptions {
+    /** The additional number of digits in the extended year format */
+    additionalDigits?: 0 | 1 | 2;
+}

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

@@ -0,0 +1,3 @@
+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-contribution-data.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beabee/beabee-common",
-  "version": "0.20.5",
+  "version": "0.21.0-alpha.1",
   "description": "Shared code between Beabee projects for Node.js, Deno and the browser",
   "type": "module",
   "main": "./dist/cjs/index.cjs",