@better-giving/donation 3.0.32 → 3.0.34

package/dist/helpers.d.mts

@@ -0,0 +1,12 @@
+import type { TFrequency } from "./schema.mjs";
+/**
+ * @description combines the new frequency field and legacy is_recurring flag
+ * @param freq
+ * @param is_recurring legacy flag
+ */
+export declare const is_recurring: (freq?: TFrequency, is_recurring?: boolean) => boolean;
+/**
+ * @description combines legacy is_recurring flag to frequency
+ * @param is_recurring
+ */
+export declare const freq: (freq?: TFrequency, is_recurring?: boolean) => TFrequency;

package/dist/helpers.mjs

@@ -0,0 +1,15 @@
+/**
+ * @description combines the new frequency field and legacy is_recurring flag
+ * @param freq
+ * @param is_recurring legacy flag
+ */
+export const is_recurring = (freq, is_recurring = false) => {
+    return freq ? freq !== "one-time" : is_recurring;
+};
+/**
+ * @description combines legacy is_recurring flag to frequency
+ * @param is_recurring
+ */
+export const freq = (freq, is_recurring = false) => {
+    return freq ?? (is_recurring ? "monthly" : "one-time");
+};

package/dist/interfaces.d.mts

@@ -1,5 +1,5 @@
 import type { Environment } from "@better-giving/types/list";
-import type { IAllocation, TDonationSource, TDonorTitle } from "./schema.mjs";
+import type { IAllocation, TDonationSource, TDonorTitle, TFrequency } from "./schema.mjs";
 interface IReferrerCommission {
     from_tip: number;
     from_fee: number;
@@ -46,7 +46,9 @@ export interface IDonationOnHoldAttr {
     "USD", "TRX", "karate-295", "BRL", "GBP", "USDC", "JPY", "ETH", "USDCMATIC", "EUR", "INR", "THB", "PHP",
     "XRP", "RUB", "CAD", "karate-1" ... */
     denomination: string;
+    /** @legacy */
     isRecurring?: boolean;
+    frequency?: TFrequency;
     title?: TDonorTitle;
     fullName: string;
     /** may be empty */
@@ -167,7 +169,9 @@ export interface IDonationFinalAttr {
     network?: Environment;
     amount?: number;
     usdValue?: number;
+    /** @legacy */
     isRecurring?: boolean;
+    frequency?: TFrequency;
     feeAllowance?: number;
     /**
     PHP", "UST", "USD", "LUNA", "ETH", "USDCMATIC", "axlUSDC", "LTC", undefined, "EUR", "NZD", "JUNO", "INR",

package/dist/schema.d.mts

@@ -1,6 +1,6 @@
 import * as v from "valibot";
-export declare const frequencies: readonly ["one-time", "recurring"];
-export declare const frequency: v.PicklistSchema<readonly ["one-time", "recurring"], "Please select donation frequency">;
+export declare const frequencies: readonly ["one-time", "monthly", "weekly"];
+export declare const frequency: v.PicklistSchema<readonly ["one-time", "monthly", "weekly"], "Please select donation frequency">;
 export type TFrequency = v.InferOutput<typeof frequency>;
 export declare const donation_sources: readonly ["bg-marketplace", "bg-widget"];
 export declare const donation_source: v.PicklistSchema<readonly ["bg-marketplace", "bg-widget"], undefined>;

package/dist/schema.mjs

@@ -1,7 +1,7 @@
 import { $int_gte1 } from "@better-giving/schemas";
 import { endOfDay, iso_date, startOfDay } from "@better-giving/schemas/date";
 import * as v from "valibot";
-export const frequencies = ["one-time", "recurring"];
+export const frequencies = ["one-time", "monthly", "weekly"];
 export const frequency = v.picklist(frequencies, "Please select donation frequency");
 export const donation_sources = ["bg-marketplace", "bg-widget"];
 export const donation_source = v.picklist(donation_sources);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@better-giving/donation",
-  "version": "3.0.32",
+  "version": "3.0.34",
   "devDependencies": {
     "@better-giving/config": "1.1.2"
   },

package/src/helpers.mts

@@ -0,0 +1,18 @@
+import type { TFrequency } from "./schema.mjs";
+
+/**
+ * @description combines the new frequency field and legacy is_recurring flag
+ * @param freq
+ * @param is_recurring legacy flag
+ */
+export const is_recurring = (freq?: TFrequency, is_recurring = false) => {
+  return freq ? freq !== "one-time" : is_recurring;
+};
+
+/**
+ * @description combines legacy is_recurring flag to frequency
+ * @param is_recurring
+ */
+export const freq = (freq?: TFrequency, is_recurring = false): TFrequency => {
+  return freq ?? (is_recurring ? "monthly" : "one-time");
+};

package/src/interfaces.mts

@@ -1,5 +1,10 @@
 import type { Environment } from "@better-giving/types/list";
-import type { IAllocation, TDonationSource, TDonorTitle } from "./schema.mjs";
+import type {
+  IAllocation,
+  TDonationSource,
+  TDonorTitle,
+  TFrequency,
+} from "./schema.mjs";
 
 interface IReferrerCommission {
   from_tip: number;
@@ -53,7 +58,9 @@ export interface IDonationOnHoldAttr {
   "USD", "TRX", "karate-295", "BRL", "GBP", "USDC", "JPY", "ETH", "USDCMATIC", "EUR", "INR", "THB", "PHP",
   "XRP", "RUB", "CAD", "karate-1" ... */
   denomination: string;
+  /** @legacy */
   isRecurring?: boolean;
+  frequency?: TFrequency;
 
   /// FROM ///
   title?: TDonorTitle;
@@ -187,7 +194,9 @@ export interface IDonationFinalAttr {
   network?: Environment;
   amount?: number;
   usdValue?: number;
+  /** @legacy */
   isRecurring?: boolean;
+  frequency?: TFrequency;
   feeAllowance?: number;
   /**
   PHP", "UST", "USD", "LUNA", "ETH", "USDCMATIC", "axlUSDC", "LTC", undefined, "EUR", "NZD", "JUNO", "INR",

package/src/schema.mts

@@ -1,7 +1,7 @@
 import { $int_gte1 } from "@better-giving/schemas";
 import { endOfDay, iso_date, startOfDay } from "@better-giving/schemas/date";
 import * as v from "valibot";
-export const frequencies = ["one-time", "recurring"] as const;
+export const frequencies = ["one-time", "monthly", "weekly"] as const;
 export const frequency = v.picklist(
   frequencies,
   "Please select donation frequency"