@lacagnottedesproches/lcdp-js-lite 1.6.0

package/dist/types.d.ts

@@ -0,0 +1,269 @@
+import { Stripe } from "@stripe/stripe-js";
+import { UUID } from "crypto";
+export declare enum AfinaError {
+    Verify = "Fail to verify origin request",
+    Stripe = "Stripe is not available",
+    ClientSide = "Should be on Client Side",
+    Key = "A publishable key is mandatory"
+}
+export declare enum TokenObjectType {
+    Account = "account",
+    Pot = "pot",
+    Wizard = "wizard"
+}
+export interface Country {
+    id: string;
+    name: string;
+}
+export interface Category {
+    id: string;
+    name: string;
+    slug: string;
+    icon: string | null;
+    icon_url: string | null;
+}
+export interface TokenObject {
+    id: string;
+    type: TokenObjectType;
+    client_ip: string;
+}
+interface Pagination {
+    has_next: boolean;
+    has_prev: boolean;
+    page: number;
+    pages: number;
+    per_page: number;
+    total: number;
+}
+export interface ProfitAccount {
+    entity_name: string | null;
+    entity_url: string | null;
+}
+export interface Pot {
+    id: string;
+    date_created_ts: number;
+    slug: string;
+    name: string;
+    date_end_ts: number | null;
+    objectif: number | null;
+    status_online: boolean;
+    status_public: boolean;
+    status_closed: boolean;
+    amount_collected_hidden: boolean;
+    public_pot_url: string;
+    public_donation_url: string;
+    stat_amount_donation: number | null;
+    stat_nb_donation: number;
+    profit_acct: ProfitAccount | null;
+    profit_ghost: ProfitAccount | null;
+    description: string | null;
+    video: string | null;
+    visual_main_url: string | null;
+    visual_secondary_url: string | null;
+    with_tax_receipt: boolean;
+}
+export interface PotsPagination extends Pagination {
+    items: Pot[];
+}
+export interface PayloadAccount {
+    email: string;
+    password?: string | null;
+    first_name: string;
+    last_name: string;
+    birth_date: Date;
+    address: string;
+    postcode: string;
+    city: string;
+    phone_number: string;
+    country_code: string;
+    tags?: string[] | undefined;
+}
+interface PayloadPotBase {
+    name: string;
+    category_id: string;
+    amount_target?: number | undefined;
+    ts_end?: number | undefined;
+    status_public?: boolean | undefined;
+    total_amount_hidden?: boolean | undefined;
+    description?: string | undefined;
+    assoid?: string | undefined;
+}
+export interface PayloadPot extends PayloadPotBase {
+    acct_id: string;
+}
+export interface PayloadPotUpdate {
+    pot_id: UUID;
+    name?: string | undefined;
+    category_id?: UUID | undefined;
+    objectif?: number | undefined;
+    date_end_ts?: number | undefined;
+    status_public?: boolean | undefined;
+    amount_collected_hidden?: boolean | undefined;
+    description?: string | undefined;
+}
+export interface PayloadAccountAndPot extends PayloadAccount, PayloadPotBase {
+}
+export interface DataDonation {
+    first_name: string;
+    last_name: string;
+    email: string;
+    pot_id: UUID;
+    return_url: string;
+    message?: string | null | undefined;
+    stay_anonymous?: boolean | null | undefined;
+    hide_amount_donation?: boolean | null | undefined;
+    is_newsletter?: boolean | null | undefined;
+    address?: string | null | undefined;
+    postcode?: string | null | undefined;
+    city?: string | null | undefined;
+    country?: string | null | undefined;
+    org_name?: string | null | undefined;
+    org_siren?: string | null | undefined;
+    org_status?: string | null | undefined;
+}
+export interface PayloadDonation extends DataDonation {
+    confirmation_token_id: string;
+    idempotency_key: string;
+    amount_donation: number;
+    amount_tip: number;
+}
+export interface DonationResult {
+    error?: string;
+    status: string | "requires_action";
+    client_secret: string;
+    donation_id?: UUID;
+}
+export interface AccountCreated {
+    acct_id: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+}
+export interface PotCreated {
+    pot_id: string;
+    name: string;
+    slug: string;
+}
+export interface AccountAndPotCreated {
+    account: AccountCreated;
+    pot: PotCreated;
+}
+export interface StatMetric {
+    nb_pots: number;
+    amount_donations: number;
+    amount_moy_donations: number;
+    nb_donations: number;
+}
+export interface StatMetricTips {
+    nb_tips: number;
+    amount: number;
+    amount_real: number;
+}
+export interface StatDashboard {
+    total: StatMetric;
+    date_range: StatMetric;
+    tips?: {
+        total: StatMetricTips;
+        date_range: StatMetricTips;
+    };
+}
+export interface StatsPot {
+    id: string;
+    date_created_ts: number;
+    slug: string;
+    name: string;
+    status_online: boolean;
+    status_public: boolean;
+    status_closed: boolean;
+    owner_first_name: string | null;
+    owner_last_name: string | null;
+    tags?: string | null;
+    nb_donations: number;
+    amount_donations: number | null;
+    amount_moy_donations: number | null;
+    nb_tips?: number;
+    amount_tips?: number;
+    amount_real_tips?: number;
+}
+export interface StatsPotsPagination extends Pagination {
+    items: StatsPot[];
+}
+export interface Association {
+    id: string;
+    nom: string;
+    recu_fiscal: 0 | 1;
+    mise_en_avant: 0 | 1;
+    categories?: string[];
+    description_courte?: string;
+    link_logo: string;
+    alt_logo: string;
+    link_cta_pot: string;
+    lien_page_wordpress: string;
+    assoid: string;
+}
+export interface Associations {
+    hits: Association[];
+    offset: number;
+    limit: number;
+    query: string;
+}
+export interface PayloadQueryAssociations {
+    q?: string;
+    limit?: number;
+    offset?: number;
+    filter?: string[][];
+}
+export interface AssociationCategory {
+    id: string;
+    name: string;
+    picto?: string;
+}
+/**
+ * Represents available features from Afina API.
+ */
+export interface LCDP {
+    stripe: Stripe | undefined | null;
+    init: () => Promise<LCDP>;
+    createTokenAccount: (payload: PayloadAccount) => Promise<TokenObject>;
+    createTokenPot: (payload: PayloadPot) => Promise<TokenObject>;
+    createTokenAccountAndPot: (payload: PayloadAccountAndPot) => Promise<TokenObject>;
+    createTokenPotUpdate: (payload: PayloadPotUpdate) => Promise<TokenObject>;
+    createDonation: (payload: PayloadDonation) => Promise<DonationResult>;
+    getAvailableCountries: () => Promise<Country[]>;
+    getCategories: () => Promise<Category[]>;
+    getPots: (params?: ParamsPagination) => Promise<PotsPagination>;
+    getPot: (potId: string) => Promise<Pot>;
+    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>;
+    getAssociation: (id: string) => Promise<Association>;
+    getAssociationCategories: () => Promise<AssociationCategory[]>;
+}
+export interface LCDPApi {
+    createAccount: (payload: TokenObject) => Promise<AccountCreated>;
+    createPot: (payload: TokenObject) => Promise<PotCreated>;
+    createAccountAndPot: (payload: TokenObject) => Promise<AccountAndPotCreated>;
+    updatePot: (payload: TokenObject) => Promise<void>;
+}
+export type LCDPOpts = {
+    api_url?: string;
+};
+export interface LCDPConstructor {
+    (lcdpPubKey: string, options?: LCDPOpts): LCDP;
+}
+export type LoadLCDP = (...args: Parameters<LCDPConstructor>) => Promise<LCDP | null>;
+export interface ParamsPagination {
+    page?: number;
+    per_page?: number;
+}
+declare global {
+    interface Window {
+        lcdp?: {
+            Afina: LCDPConstructor;
+        };
+    }
+}
+export interface DataAccount extends Omit<PayloadAccount, "birth_date"> {
+    birth_date: number;
+}
+export {};

package/jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testPathIgnorePatterns: [".*\\.test-d\\.ts$"],
+  setupFilesAfterEnv: ["<rootDir>/jest.setup.ts"],
+};

package/jest.setup.ts

@@ -0,0 +1,39 @@
+import fetchMock from "jest-fetch-mock";
+
+fetchMock.enableMocks();
+
+// Utility to safely assign to globalThis
+const setGlobalProp = (key: string, value: unknown) => {
+  (globalThis as any)[key] = value;
+};
+
+setGlobalProp("fetch", fetchMock);
+
+const mockScript = {
+  src: "",
+  addEventListener: jest.fn(),
+  removeEventListener: jest.fn(),
+  parentNode: { removeChild: jest.fn() },
+};
+
+const mockDocument = {
+  head: {
+    appendChild: jest.fn(),
+  },
+  body: {
+    appendChild: jest.fn(),
+  },
+  createElement: jest.fn((tag: string) => {
+    if (tag === "script") return mockScript;
+    return { id: "", appendChild: jest.fn() };
+  }),
+  querySelectorAll: jest.fn(() => []),
+};
+
+// window mock
+const mockWindow: Record<string, any> = {
+  lcdp: undefined,
+};
+
+setGlobalProp("window", mockWindow);
+setGlobalProp("document", mockDocument);

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@lacagnottedesproches/lcdp-js-lite",
+  "version": "1.6.0",
+  "description": "LCDP JS Lite",
+  "scripts": {
+    "build": "rm -rf dist/ && rollup -c",
+    "dev": "rollup -c -w",
+    "test": "jest --verbose",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --verbose --coverage",
+    "test:coverage:watch": "jest --coverage --watch",
+    "test:ci": "jest --ci --coverage --watchAll=false",
+    "test:unit": "jest --testPathPattern=unit",
+    "test:integration": "jest --testPathPattern=integration",
+    "test:types": "tsd",
+    "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand",
+    "test:update-snapshots": "jest --updateSnapshot",
+    "test:clear-cache": "jest --clearCache"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "browser": "dist/index.umd.js",
+  "browser:min": "dist/index.umd.min.js",
+  "types": "dist/index.d.ts",
+  "typings": "dist/index.d.ts",
+  "keywords": [],
+  "author": "La Cagnotte des Proches (https://lacagnottedesproches.fr)",
+  "license": "GPL-3.0-only",
+  "devDependencies": {
+    "@babel/core": "^7.24.6",
+    "@babel/preset-env": "^7.24.6",
+    "@jest/globals": "^29.7.0",
+    "@rollup/plugin-babel": "^6.1.0",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-replace": "^6.0.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.12.12",
+    "autoprefixer": "^10.4.19",
+    "generate-changelog": "^1.8.0",
+    "jest": "^29.7.0",
+    "jest-fetch-mock": "^3.0.3",
+    "prettier": "^3.2.5",
+    "rollup": "^4.53.3",
+    "ts-jest": "^29.4.5",
+    "tsd": "^0.33.0",
+    "tslib": "^2.8.1",
+    "typedoc": "^0.27.4",
+    "typescript": "^5.4.5"
+  },
+  "peerDependencies": {
+    "@stripe/stripe-js": "^3.0.0"
+  }
+}

package/rollup.config.cjs

@@ -0,0 +1,55 @@
+const { babel } = require("@rollup/plugin-babel");
+const commonjs = require("@rollup/plugin-commonjs");
+const { nodeResolve } = require("@rollup/plugin-node-resolve");
+const typescript = require("@rollup/plugin-typescript");
+const terser = require("@rollup/plugin-terser");
+const replace = require("@rollup/plugin-replace");
+const json = require("@rollup/plugin-json");
+const pkg = require("./package.json");
+
+const plugins = [
+  typescript(),
+  json(),
+  commonjs(),
+  nodeResolve(),
+  babel({
+    extensions: [".ts", ".js"],
+    babelHelpers: "bundled",
+  }),
+  replace({
+    preventAssignment: true,
+    "process.env.NODE_ENV": JSON.stringify("production"),
+  }),
+];
+
+module.exports = {
+  input: "src/index.ts",
+  output: [
+    {
+      format: "cjs",
+      file: pkg.main,
+    },
+    {
+      format: "es",
+      file: pkg.module,
+    },
+    {
+      name: "lcdpjs",
+      format: "iife",
+      file: "dist/index.min.js",
+      plugins: [terser()],
+    },
+    {
+      name: "lcdpjs",
+      format: "umd",
+      file: pkg.browser,
+    },
+    {
+      name: "lcdpjs",
+      format: "umd",
+      file: pkg["browser:min"],
+      plugins: [terser()],
+    },
+  ],
+  plugins,
+};

package/src/api.ts

@@ -0,0 +1,143 @@
+import {
+  AccountCreated,
+  LCDPApi,
+  PotCreated,
+  TokenObject,
+  AccountAndPotCreated,
+} from "./types";
+
+interface LCDPApiResponse {
+  [key: string]: string | LCDPApiResponse;
+}
+
+export class LCDPRequest implements LCDPApi {
+  _apiToken: string;
+  _apiUrl: string;
+
+  constructor(secret: string, apiUrl: string) {
+    if (typeof window !== "undefined") {
+      throw new Error("Must be used server side");
+    }
+    this._apiToken = secret;
+    this._apiUrl = apiUrl;
+  }
+
+  requestLCDPApi = (
+    endpoint: string,
+    payload: TokenObject,
+    authToken: string,
+    customMethod: "POST" | "PATCH" = "POST",
+  ): Promise<LCDPApiResponse | void> => {
+    if (typeof window !== "undefined") {
+      throw new Error("Must be used server side");
+    }
+    return new Promise(async (resolve, reject) => {
+      const url = `${this._apiUrl}/${endpoint}`;
+      try {
+        const response = await fetch(url, {
+          method: customMethod,
+          headers: {
+            "Content-Type": "application/json",
+            "User-Agent": "lcdp/v1",
+            Authorization: `Bearer ${authToken}`,
+          },
+          body: JSON.stringify(payload),
+        });
+        const status = response.status;
+        if (status >= 400) {
+          const { detail } = await response.json();
+          reject(detail);
+        } else if (status === 204) {
+          resolve();
+        } else {
+          const data = await response.json();
+          resolve(data);
+        }
+      } catch (error) {
+        reject(error);
+      }
+    });
+  };
+
+  createAccount = async (payload: TokenObject): Promise<AccountCreated> => {
+    return new Promise(async (resolve, reject) => {
+      const responsePromise = this.requestLCDPApi(
+        "accounts",
+        payload,
+        this._apiToken,
+      );
+      return responsePromise
+        .then((data) => {
+          try {
+            // TODO: may be improved
+            resolve(data as unknown as AccountCreated);
+          } catch (error) {
+            reject(error);
+          }
+        })
+        .catch((reason) => reject(reason));
+    });
+  };
+
+  createPot = async (payload: TokenObject): Promise<PotCreated> => {
+    return new Promise(async (resolve, reject) => {
+      const responsePromise = this.requestLCDPApi(
+        "pots",
+        payload,
+        this._apiToken,
+      );
+      return responsePromise
+        .then((data) => {
+          try {
+            // TODO: may be improved
+            resolve(data as unknown as PotCreated);
+          } catch (error) {
+            reject(error);
+          }
+        })
+        .catch((reason) => reject(reason));
+    });
+  };
+
+  createAccountAndPot = async (
+    payload: TokenObject,
+  ): Promise<AccountAndPotCreated> => {
+    return new Promise(async (resolve, reject) => {
+      const responsePromise = this.requestLCDPApi(
+        "wizards",
+        payload,
+        this._apiToken,
+      );
+      return responsePromise
+        .then((data) => {
+          try {
+            // TODO: may be improved
+            resolve(data as unknown as AccountAndPotCreated);
+          } catch (error) {
+            reject(error);
+          }
+        })
+        .catch((reason) => reject(reason));
+    });
+  };
+
+  updatePot = async (payload: TokenObject): Promise<void> => {
+    return new Promise(async (resolve, reject) => {
+      const responsePromise = this.requestLCDPApi(
+        "pots",
+        payload,
+        this._apiToken,
+        "PATCH",
+      );
+      return responsePromise
+        .then((_) => {
+          try {
+            resolve();
+          } catch (error) {
+            reject(error);
+          }
+        })
+        .catch((reason) => reject(reason));
+    });
+  };
+}