shutro-erp 0.3.4 → 0.3.6

package/dist/payment/index.js

@@ -13,6 +13,8 @@
  * - `GET|POST /api/v1/payment/return/:reference`             back from the provider: on to the portal
  *
  * The callbacks arrive at `POST /api/v1/hooks/<token>` (the provider's endpoint, made with its first payment).
+ * Other apps start payments with `startPayment` (`website_sale`: a shop's checkout) and say what a transaction pays by
+ * overriding `payable()` on `payment.transaction`.
  */
 import { accountPortal } from '../account_portal/index.js';
 import { accounting } from '../accounting/index.js';
@@ -21,7 +23,7 @@ import { defineModule } from '../modules-sdk/index.js';
 import { portalDocuments } from '../portal/index.js';
 import { HttpProblem } from '../server/index.js';
 import { orm } from '../server/orm.js';
-import { action, form, list } from '../views/index.js';
+import { action, form, list, search } from '../views/index.js';
 import { bkashFromEnvironment } from './bkash.js';
 import { PaymentProvider, PaymentTransaction, paymentShutro } from './module.js';
 import { ADAPTERS, FAKE_SIGNATURE, fakeAdapter } from './providers.js';
@@ -56,6 +58,102 @@ function callbackHooks(adapters) {
         },
     }));
 }
+/** The adapters and addresses of the running server (set when the routes are registered). */
+let current = null;
+const adapterOf = (code) => {
+    const adapter = current?.adapters.get(code);
+    if (adapter === undefined)
+        throw new HttpProblem(409, 'no-adapter', 'Provider unavailable', `The ${code} adapter is not installed.`);
+    return adapter;
+};
+/** The provider's callback endpoint (made on first use), with its token. */
+async function endpointOf(su, provider) {
+    const [p] = await su
+        .model('payment.provider')
+        .browse([provider.id])
+        .load({ endpoint: true });
+    if (p?.endpoint !== null && p?.endpoint !== undefined)
+        return p.endpoint.token;
+    const made = await su
+        .model('webhook.endpoint')
+        .create([{ name: `${provider.name} callbacks`, hook: `payment.${provider.code}` }]);
+    await su
+        .model('payment.provider')
+        .browse([provider.id])
+        .write({ endpoint: made.ids[0] });
+    const [e] = await made.load({});
+    return e?.token ?? '';
+}
+/**
+ * Starts a payment as the system: a pending transaction for `amount` with the provider, and where to send the
+ * customer. The provider must be enabled, configured on this server, and the fake never live.
+ */
+export async function startPayment(su, input) {
+    if (current === null)
+        throw new HttpProblem(503, 'no-payments', 'Payments unavailable', 'Payments are not set up.');
+    const urls = current.urls;
+    const [provider] = await (await su.model('payment.provider').search({
+        where: {
+            id: orm.asId(input.provider, 'payment.provider'),
+            state: { in: ['test', 'live'] },
+            company: orm.asId(input.company, 'res.company'),
+        },
+        limit: 1,
+    })).load({});
+    if (provider === undefined)
+        throw new HttpProblem(422, 'invalid-provider', 'No such provider', 'Choose one of the providers offered.');
+    const adapter = adapterOf(provider.code);
+    if (provider.code === 'fake' && provider.state === 'live')
+        throw new HttpProblem(409, 'fake-live', 'Test provider', 'The test provider moves no money: it cannot be live.');
+    if (!adapter.configured(provider.state === 'live' ? 'live' : 'test'))
+        throw new HttpProblem(409, 'not-configured', 'Provider not set up', `The ${provider.name} provider has no credentials for ${provider.state} payments on this server.`);
+    const token = await endpointOf(su, provider);
+    const created = await su.model('payment.transaction').create([
+        {
+            ...input.values,
+            provider: provider.id,
+            move: input.move ?? null,
+            partner: input.partner?.id ?? null,
+            currency: input.currency.id,
+            amount: input.amount.toFixed(),
+            company: input.company,
+            returnUrl: input.returnUrl ?? null,
+        },
+    ]);
+    await su.flush(); // company checks run in this superuser scope, not at commit (Shutro request #11)
+    const tx = su.model('payment.transaction').browse(created.ids);
+    const [t] = await tx.load({});
+    const reference = t?.reference ?? '';
+    const p = input.partner;
+    let started;
+    try {
+        started = await adapter.createPayment({
+            reference,
+            amount: input.amount.toFixed(input.currency.decimalPlaces ?? 2),
+            currency: input.currency.name,
+            description: input.description,
+            customer: {
+                name: p?.name ?? '',
+                email: p?.email ?? null,
+                phone: p?.phone ?? p?.mobile ?? null,
+                street: p?.street ?? null,
+                city: p?.city ?? null,
+                zip: p?.zip ?? null,
+                country: (p?.country ?? null),
+            },
+            returnUrl: `${urls.api}/api/v1/payment/return/${encodeURIComponent(reference)}`,
+            callbackUrl: `${urls.api}/api/v1/hooks/${token}`,
+            mode: provider.state === 'live' ? 'live' : 'test',
+        });
+    }
+    catch (error) {
+        throw new HttpProblem(502, 'provider-error', 'The payment could not start', error instanceof Error ? error.message : String(error));
+    }
+    if (started.providerReference !== undefined)
+        await tx.write({ providerReference: started.providerReference });
+    await su.flush();
+    return { reference, redirectUrl: started.redirectUrl };
+}
 function registerPaymentRoutes(context, adapters, urls) {
     const { app } = context;
     const documents = portalDocuments(context.registry);
@@ -63,30 +161,7 @@ function registerPaymentRoutes(context, adapters, urls) {
         if (!env.groups.has('portal.user') || env.groups.has('base.user'))
             throw new HttpProblem(403, 'portal-only', 'Portal users only', 'This is the portal’s API.');
     };
-    const adapterOf = (code) => {
-        const adapter = adapters.get(code);
-        if (adapter === undefined)
-            throw new HttpProblem(409, 'no-adapter', 'Provider unavailable', `The ${code} adapter is not installed.`);
-        return adapter;
-    };
-    /** The provider's callback endpoint (made on first use), with its token. */
-    const endpointOf = async (su, provider) => {
-        const [p] = await su
-            .model('payment.provider')
-            .browse([provider.id])
-            .load({ endpoint: true });
-        if (p?.endpoint !== null && p?.endpoint !== undefined)
-            return p.endpoint.token;
-        const made = await su
-            .model('webhook.endpoint')
-            .create([{ name: `${provider.name} callbacks`, hook: `payment.${provider.code}` }]);
-        await su
-            .model('payment.provider')
-            .browse([provider.id])
-            .write({ endpoint: made.ids[0] });
-        const [e] = await made.load({});
-        return e?.token ?? '';
-    };
+    current = { adapters, urls };
     app.get('/api/portal/v1/payments/providers', async (request) => request.env((env) => {
         portalOnly(env);
         return env.asSuperuser({ reason: 'portal: payment providers' }, async (su) => {
@@ -137,11 +212,6 @@ function registerPaymentRoutes(context, adapters, urls) {
             })).load({});
             if (provider === undefined)
                 throw new HttpProblem(422, 'invalid-provider', 'No such provider', 'Choose one of the providers offered.');
-            const adapter = adapterOf(provider.code);
-            if (provider.code === 'fake' && provider.state === 'live')
-                throw new HttpProblem(409, 'fake-live', 'Test provider', 'The test provider moves no money: it cannot be live.');
-            if (!adapter.configured(provider.state === 'live' ? 'live' : 'test'))
-                throw new HttpProblem(409, 'not-configured', 'Provider not set up', `The ${provider.name} provider has no credentials for ${provider.state} payments on this server.`);
             const [move] = await su
                 .model('account.move')
                 .browse([id])
@@ -151,48 +221,15 @@ function registerPaymentRoutes(context, adapters, urls) {
             const due = move.amountResidual?.amount;
             if (due === undefined || !due.gt(0))
                 throw new HttpProblem(409, 'not-payable', 'Nothing to pay', 'Nothing is due on this document.');
-            const token = await endpointOf(su, provider);
-            const created = await su.model('payment.transaction').create([
-                {
-                    provider: provider.id,
-                    move: move.id,
-                    partner: (move.partner?.id ?? null),
-                    currency: move.currency.id,
-                    amount: due.toFixed(),
-                    company: company,
-                },
-            ]);
-            await su.flush(); // company checks run in this superuser scope, not at commit (Shutro request #11)
-            const [tx] = await created.load({});
-            const reference = tx?.reference ?? '';
-            let started;
-            try {
-                started = await adapter.createPayment({
-                    reference,
-                    amount: due.toFixed(move.currency.decimalPlaces ?? 2),
-                    currency: move.currency.name,
-                    description: `${d.spec.label} ${move.name}`,
-                    customer: {
-                        name: move.partner?.name ?? '',
-                        email: move.partner?.email ?? null,
-                        phone: move.partner?.phone ?? move.partner?.mobile ?? null,
-                        street: move.partner?.street ?? null,
-                        city: move.partner?.city ?? null,
-                        zip: move.partner?.zip ?? null,
-                        country: move.partner?.country ?? null,
-                    },
-                    returnUrl: `${urls.api}/api/v1/payment/return/${encodeURIComponent(reference)}`,
-                    callbackUrl: `${urls.api}/api/v1/hooks/${token}`,
-                    mode: provider.state === 'live' ? 'live' : 'test',
-                });
-            }
-            catch (error) {
-                throw new HttpProblem(502, 'provider-error', 'The payment could not start', error instanceof Error ? error.message : String(error));
-            }
-            if (started.providerReference !== undefined)
-                await created.write({ providerReference: started.providerReference });
-            await su.flush();
-            return { reference, redirectUrl: started.redirectUrl };
+            return startPayment(su, {
+                provider: provider.id,
+                move: move.id,
+                partner: move.partner,
+                currency: move.currency,
+                amount: due,
+                company,
+                description: `${d.spec.label} ${move.name}`,
+            });
         });
         return reply.status(201).send(started);
     });
@@ -210,7 +247,7 @@ function registerPaymentRoutes(context, adapters, urls) {
                 return t === undefined
                     ? null
                     : {
-                        move: t.move.id,
+                        move: t.move?.id ?? 0,
                         state: t.state,
                         amount: t.amount.amount.toFixed(t.currency.decimalPlaces ?? 2),
                         currency: t.currency.name,
@@ -294,7 +331,8 @@ function registerPaymentRoutes(context, adapters, urls) {
                     return t === undefined
                         ? null
                         : {
-                            move: t.move.id,
+                            move: t.move?.id ?? null,
+                            returnUrl: t.returnUrl,
                             company: t.company.id,
                             state: t.state,
                             code: t.provider.code,
@@ -322,6 +360,8 @@ function registerPaymentRoutes(context, adapters, urls) {
                     }
                 }
                 const move = tx?.move ?? null;
+                if (tx?.returnUrl !== null && tx?.returnUrl !== undefined && tx.returnUrl !== '')
+                    return reply.redirect(`${tx.returnUrl}${tx.returnUrl.includes('?') ? '&' : '?'}payment=${encodeURIComponent(reference)}`, 303);
                 return reply.redirect(move === null
                     ? `${urls.portal}/`
                     : `${urls.portal}/d/${encodeURIComponent(payable)}/${move}?payment=${encodeURIComponent(reference)}`, 303);
@@ -391,11 +431,27 @@ export function paymentModule(options = {}) {
                 sequence: 3.7,
             },
         ],
+        search: {
+            'payment.provider': search(PaymentProvider, {
+                fields: ['name'],
+                groupBy: ['code', 'state'],
+            }),
+            'payment.transaction': search(PaymentTransaction, {
+                fields: ['reference', 'providerReference', 'partner.name'],
+                filters: {
+                    done: { label: 'Done', domain: { state: 'done' }, group: 'state' },
+                    pending: { label: 'Pending', domain: { state: 'pending' }, group: 'state' },
+                    failed: { label: 'Failed', domain: { state: 'failed' }, group: 'state' },
+                },
+                groupBy: ['provider', 'state', 'doneAt:month'],
+            }),
+        },
         views: {
             'payment.provider.list': list(PaymentProvider, {
                 columns: ['name', 'code', 'state', 'journal'],
             }),
             'payment.provider.form': form(PaymentProvider, (k) => ({
+                chatter: true,
                 sheet: [
                     k.group('main', ['name', 'code', 'state']),
                     k.group('accounting', ['journal', 'sequence', 'endpoint']),
@@ -405,6 +461,7 @@ export function paymentModule(options = {}) {
                 columns: ['reference', 'move', 'partner', 'provider', 'amount', 'state', 'doneAt'],
             }),
             'payment.transaction.form': form(PaymentTransaction, (k) => ({
+                chatter: true,
                 sheet: [
                     k.group('main', ['reference', 'move', 'partner', 'provider']),
                     k.group('outcome', [