@lacagnottedesproches/lcdp-js-lite 1.12.1 → 1.13.0

package/dist/types.d.ts

@@ -177,6 +177,34 @@ export interface PayloadDonation extends DataDonation {
     amount_donation: number;
     amount_tip: number;
 }
+/**
+ * Donor edit of a donation, sent to `updateDonation`. `token` is the edit
+ * token from the link v4 puts in the donation email. Only the fields you set
+ * are changed; `message: null` clears the message.
+ */
+export interface PayloadDonationUpdate {
+    token: string;
+    first_name?: string | undefined;
+    message?: string | null | undefined;
+    stay_anonymous_checked?: boolean | undefined;
+    hide_amount_donation_checked?: boolean | undefined;
+    private_message_checked?: boolean | undefined;
+}
+/**
+ * Current values of a donation for the donor edit form, from `getDonationForEdit`.
+ * `first_name` and `message` are the real values, even for an anonymous
+ * donation or a private message.
+ */
+export interface DonationForEdit {
+    id: UUID;
+    first_name: string | null;
+    message: string | null;
+    stay_anonymous_checked: boolean;
+    hide_amount_donation_checked: boolean;
+    private_message_checked: boolean;
+    pot_id: UUID;
+    pot_name: string;
+}
 export interface DonationResult {
     error?: string;
     status: string | "requires_action";
@@ -246,6 +274,25 @@ export interface StatsPot {
     amount_tips?: number;
     amount_real_tips?: number;
 }
+/**
+ * Public view of a donation in a pot donations list. The API already hides
+ * what the donor chose to hide: names are null when anonymous, the amount
+ * is null when hidden, the message is null when private.
+ */
+export interface PotDonation {
+    id: UUID;
+    date_created_ts: number;
+    amount_donation: number | null;
+    stay_anonymous_checked: boolean;
+    hide_amount_donation_checked: boolean;
+    private_message_checked: boolean;
+    message: string | null;
+    first_name: string | null;
+    last_name: string | null;
+}
+export interface PotDonationsPagination extends Pagination {
+    items: PotDonation[];
+}
 export interface StatsPotsPagination extends Pagination {
     items: StatsPot[];
 }
@@ -303,10 +350,14 @@ export interface LCDP {
     createTokenPersonVerification: (payload: PayloadVerification) => Promise<ExternalTokenObject>;
     createTokenAccountBank(payload: PayloadAccountBank): Promise<ExternalTokenObject>;
     createDonation: (payload: PayloadDonation) => Promise<DonationResult>;
+    /** `getDonationForEdit` and `updateDonation` need SDK 1.7.0 or later. */
+    getDonationForEdit: (token: string) => Promise<DonationForEdit>;
+    updateDonation: (donationId: string, payload: PayloadDonationUpdate) => Promise<void>;
     getAvailableCountries: () => Promise<Country[]>;
     getCategories: () => Promise<Category[]>;
     getPots: (params?: ParamsPagination) => Promise<PotsPagination>;
     getPot: (potId: string) => Promise<Pot>;
+    getPotDonations: (potId: string, params?: ParamsPagination) => Promise<PotDonationsPagination>;
     getStatsDashboard: (ts_start?: number, ts_end?: number) => Promise<StatDashboard>;
     getStatsPots: (ts_start?: number, ts_end?: number, page?: number, per_page?: number) => Promise<StatsPotsPagination>;
     retrieveAssociations: (payload?: PayloadQueryAssociations) => Promise<Associations>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lacagnottedesproches/lcdp-js-lite",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "LCDP JS Lite",
   "scripts": {
     "build": "rm -rf dist/ && rollup -c",
@@ -16,7 +16,7 @@
     "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand",
     "test:update-snapshots": "jest --updateSnapshot",
     "test:clear-cache": "jest --clearCache",
-    "docs": "typedoc src/index.ts --out docs"
+    "docs": "typedoc"
   },
   "main": "dist/index.js",
   "module": "dist/index.mjs",