@aglyn/plugins-commerce 1.0.0-beta.278 → 1.0.0-beta.282

package/src/lib/server/pos-terminal.js

@@ -173,6 +173,9 @@ export function posTerminalAddressProblem(address) {
     }, {
         merge: true
     });
+    // A new Location starts with the store's reader start-up screen (AGL-4048).
+    // Never fatal, and loaded only here: it draws images.
+    await import("./pos-reader-splash.js").then((splash)=>splash.applyPosReaderSplash(options.hostId)).catch((error)=>console.error('[pos-terminal] start-up screen not applied', options.hostId, error));
     return {
         ok: true,
         locationId: String(created.body.id)
@@ -182,49 +185,147 @@ export function posTerminalAddressProblem(address) {
     return settings.tippingEnabled ? settings.tipPercentages.slice(0, 3).join(',') : 'off';
 }
 /**
- * Keeps the site's reader tipping in step with the merchant's settings: one
- * Terminal Configuration per site, assigned to its Location, rewritten only
- * when the presets changed. Never fatal: a reader that keeps the previous
- * presets still takes the payment.
- */ export async function syncPosReaderTipping(hostId, settings) {
+ * Writes `params` onto the site's ONE Terminal Configuration, creating it and
+ * assigning it to the site's Location on first use. Reader tipping and the
+ * start-up screen (AGL-4048) both live on it, because a Location takes one
+ * configuration override: a second configuration assigned for the screen
+ * would silently drop the tipping presets, and the other way round. Stripe
+ * leaves every parameter an update does not name as it was, so each caller
+ * sends only its own.
+ *
+ * The first write is the only race. Tipping's runs as a payment starts, the
+ * screen's when the POS devices card saves, and two at once would each make a
+ * configuration. So the new id is CLAIMED in a transaction: the loser writes
+ * its parameters onto the winner's configuration and deletes its own.
+ *
+ * `createKey` keys only the create (`pos-configuration:{hostId}:{createKey}`),
+ * so a retried first write makes one configuration. An update is not keyed:
+ * it sets values, and repeating it changes nothing.
+ */ export async function savePosReaderConfiguration(hostId, params, createKey) {
     var _config_get, _config_get1;
-    var _saved_body;
-    if (!settings.tippingEnabled) return;
+    var _created_body;
     const ref = terminalConfigRef(hostId);
     const config = await ref.get();
     const locationId = String((_config_get = config.get('stripeLocationId')) != null ? _config_get : '');
-    if (!locationId) return;
+    if (!locationId) return {
+        ok: false,
+        error: 'no-location'
+    };
+    const known = String((_config_get1 = config.get('stripeConfigurationId')) != null ? _config_get1 : '');
+    if (known) {
+        var _ref;
+        var _updated_body_error, _updated_body;
+        const updated = await posStripe('POST', `terminal/configurations/${known}`, {
+            params
+        });
+        if (!updated.ok) return {
+            ok: false,
+            error: String((_ref = (_updated_body = updated.body) == null ? void 0 : (_updated_body_error = _updated_body.error) == null ? void 0 : _updated_body_error.code) != null ? _ref : updated.status)
+        };
+        // A configuration recorded before AGL-4048 was only ever recorded once
+        // it was assigned, so only an explicit `false` still owes the assignment.
+        if (config.get('stripeConfigurationAssigned') === false) {
+            const assigned = await assignPosReaderConfiguration(hostId, locationId, known);
+            if (!assigned) return {
+                ok: false,
+                error: 'assignment'
+            };
+        }
+        return {
+            ok: true,
+            configurationId: known
+        };
+    }
+    const created = await posStripe('POST', 'terminal/configurations', {
+        params,
+        idempotencyKey: `pos-configuration:${hostId}:${createKey}`
+    });
+    if (!created.ok || !((_created_body = created.body) == null ? void 0 : _created_body.id)) {
+        var _ref1;
+        var _created_body_error, _created_body1;
+        return {
+            ok: false,
+            error: String((_ref1 = (_created_body1 = created.body) == null ? void 0 : (_created_body_error = _created_body1.error) == null ? void 0 : _created_body_error.code) != null ? _ref1 : created.status)
+        };
+    }
+    const createdId = String(created.body.id);
+    const winner = await firebaseAdmin.app().firestore().runTransaction(async (transaction)=>{
+        var _fresh_get;
+        const fresh = await transaction.get(ref);
+        const existing = String((_fresh_get = fresh.get('stripeConfigurationId')) != null ? _fresh_get : '');
+        if (existing) return existing;
+        transaction.set(ref, {
+            stripeConfigurationId: createdId,
+            stripeConfigurationAssigned: false
+        }, {
+            merge: true
+        });
+        return createdId;
+    });
+    if (winner !== createdId) {
+        var _ref2;
+        var _updated_body_error1, _updated_body1;
+        const updated = await posStripe('POST', `terminal/configurations/${winner}`, {
+            params
+        });
+        await posStripe('DELETE', `terminal/configurations/${createdId}`).catch(()=>undefined);
+        if (!updated.ok) return {
+            ok: false,
+            error: String((_ref2 = (_updated_body1 = updated.body) == null ? void 0 : (_updated_body_error1 = _updated_body1.error) == null ? void 0 : _updated_body_error1.code) != null ? _ref2 : updated.status)
+        };
+        return {
+            ok: true,
+            configurationId: winner
+        };
+    }
+    const assigned = await assignPosReaderConfiguration(hostId, locationId, createdId);
+    return assigned ? {
+        ok: true,
+        configurationId: createdId
+    } : {
+        ok: false,
+        error: 'assignment'
+    };
+}
+async function assignPosReaderConfiguration(hostId, locationId, configurationId) {
+    const assigned = await posStripe('POST', `terminal/locations/${locationId}`, {
+        params: {
+            configuration_overrides: configurationId
+        }
+    });
+    if (!assigned.ok) {
+        var _assigned_body;
+        console.error('[pos-terminal] configuration assignment failed', hostId, (_assigned_body = assigned.body) == null ? void 0 : _assigned_body.error);
+        return false;
+    }
+    await terminalConfigRef(hostId).set({
+        stripeConfigurationAssigned: true
+    }, {
+        merge: true
+    });
+    return true;
+}
+/**
+ * Keeps the site's reader tipping in step with the merchant's settings, on
+ * the site's one Terminal Configuration ({@link savePosReaderConfiguration}),
+ * rewritten only when the presets changed. Never fatal: a reader that keeps
+ * the previous presets still takes the payment.
+ */ export async function syncPosReaderTipping(hostId, settings) {
+    if (!settings.tippingEnabled) return;
+    const ref = terminalConfigRef(hostId);
+    const config = await ref.get();
+    if (!config.get('stripeLocationId')) return;
     const key = posReaderTippingKey(settings);
     if (config.get('tippingKey') === key) return;
     const percentages = settings.tipPercentages.slice(0, 3);
-    const configurationId = String((_config_get1 = config.get('stripeConfigurationId')) != null ? _config_get1 : '');
-    const params = {
+    const saved = await savePosReaderConfiguration(hostId, {
         [`tipping[${POS_CURRENCY}][percentages]`]: percentages.map(String)
-    };
-    const saved = await posStripe('POST', configurationId ? `terminal/configurations/${configurationId}` : 'terminal/configurations', _extends({
-        params
-    }, configurationId ? {} : {
-        idempotencyKey: `pos-configuration:${hostId}:${key}`
-    }));
-    if (!saved.ok || !((_saved_body = saved.body) == null ? void 0 : _saved_body.id)) {
-        var _saved_body1;
-        console.error('[pos-terminal] tipping configuration failed', hostId, (_saved_body1 = saved.body) == null ? void 0 : _saved_body1.error);
+    }, key);
+    if ('error' in saved) {
+        console.error('[pos-terminal] tipping configuration failed', hostId, saved.error);
         return;
     }
-    if (!configurationId) {
-        const assigned = await posStripe('POST', `terminal/locations/${locationId}`, {
-            params: {
-                configuration_overrides: String(saved.body.id)
-            }
-        });
-        if (!assigned.ok) {
-            var _assigned_body;
-            console.error('[pos-terminal] configuration assignment failed', hostId, (_assigned_body = assigned.body) == null ? void 0 : _assigned_body.error);
-            return;
-        }
-    }
     await ref.set({
-        stripeConfigurationId: String(saved.body.id),
         tippingKey: key
     }, {
         merge: true
@@ -1089,5 +1190,111 @@ async function sendToReader(input) {
         hostId: ref.hostId
     };
 }
+function offlineCardIntent(body) {
+    var _ref, _ref1, _ref2, _ref3, _ref4, _ref5, _ref6, _ref7, _ref8, _ref9, _error_message;
+    var _charge_payment_method_details, _body_transfer_data;
+    const charge = (body == null ? void 0 : body.latest_charge) && typeof body.latest_charge === 'object' ? body.latest_charge : null;
+    const present = (_ref = charge == null ? void 0 : (_charge_payment_method_details = charge.payment_method_details) == null ? void 0 : _charge_payment_method_details.card_present) != null ? _ref : {};
+    const error = (_ref1 = body == null ? void 0 : body.last_payment_error) != null ? _ref1 : null;
+    return _extends({
+        id: String((_ref2 = body == null ? void 0 : body.id) != null ? _ref2 : ''),
+        status: String((_ref3 = body == null ? void 0 : body.status) != null ? _ref3 : ''),
+        amount: Number((_ref4 = body == null ? void 0 : body.amount) != null ? _ref4 : 0),
+        currency: String((_ref5 = body == null ? void 0 : body.currency) != null ? _ref5 : ''),
+        metadata: (_ref6 = body == null ? void 0 : body.metadata) != null ? _ref6 : {},
+        destination: String((_ref7 = body == null ? void 0 : (_body_transfer_data = body.transfer_data) == null ? void 0 : _body_transfer_data.destination) != null ? _ref7 : ''),
+        applicationFeeCents: Number((_ref8 = body == null ? void 0 : body.application_fee_amount) != null ? _ref8 : 0),
+        livemode: Boolean(body == null ? void 0 : body.livemode)
+    }, present.brand ? {
+        brand: String(present.brand)
+    } : {}, present.last4 ? {
+        last4: String(present.last4)
+    } : {}, error ? {
+        failureMessage: String((_ref9 = (_error_message = error.message) != null ? _error_message : error.decline_code) != null ? _ref9 : 'The card was declined.')
+    } : {});
+}
+/** Reads one offline card's PaymentIntent, with its charge's card details. */ export async function retrievePosOfflineCardIntent(paymentIntentId) {
+    const fetched = await posStripe('GET', `payment_intents/${encodeURIComponent(paymentIntentId)}`, {
+        params: {
+            'expand[]': [
+                'latest_charge'
+            ]
+        }
+    });
+    if (!fetched.ok) return {
+        ok: false,
+        error: posStripeErrorMessage(fetched.body, 'The card payment could not be read.')
+    };
+    return {
+        ok: true,
+        intent: offlineCardIntent(fetched.body)
+    };
+}
+/** Captures one authorized offline card with the platform's fee; a repeat finds the first capture. */ export async function capturePosOfflineCardIntent(paymentIntentId, applicationFeeCents, idempotencyKey) {
+    const captured = await posStripe('POST', `payment_intents/${encodeURIComponent(paymentIntentId)}/capture`, {
+        idempotencyKey,
+        params: _extends({}, applicationFeeCents > 0 ? {
+            application_fee_amount: applicationFeeCents
+        } : {}, {
+            'expand[]': [
+                'latest_charge'
+            ]
+        })
+    });
+    if (!captured.ok) return {
+        ok: false,
+        error: posStripeErrorMessage(captured.body, 'The card payment could not be captured.')
+    };
+    return {
+        ok: true,
+        intent: offlineCardIntent(captured.body)
+    };
+}
+/**
+ * Turns Stripe's offline mode on for the site's readers: the same per-site
+ * Terminal Configuration the reader tipping uses, with `offline[enabled]`,
+ * assigned to the site's Location. Done once; a reader picks it up the next
+ * time it connects online. False when Stripe refused it.
+ */ export async function ensurePosOfflineCardConfiguration(hostId) {
+    var _config_get, _config_get1;
+    var _saved_body;
+    const ref = terminalConfigRef(hostId);
+    const config = await ref.get();
+    if (config.get('offlineEnabled') === true) return true;
+    const locationId = String((_config_get = config.get('stripeLocationId')) != null ? _config_get : '');
+    if (!locationId) return false;
+    const configurationId = String((_config_get1 = config.get('stripeConfigurationId')) != null ? _config_get1 : '');
+    const saved = await posStripe('POST', configurationId ? `terminal/configurations/${configurationId}` : 'terminal/configurations', _extends({
+        params: {
+            'offline[enabled]': true
+        }
+    }, configurationId ? {} : {
+        idempotencyKey: `pos-configuration:${hostId}:offline`
+    }));
+    if (!saved.ok || !((_saved_body = saved.body) == null ? void 0 : _saved_body.id)) {
+        var _saved_body1;
+        console.error('[pos-terminal] offline configuration failed', hostId, (_saved_body1 = saved.body) == null ? void 0 : _saved_body1.error);
+        return false;
+    }
+    if (!configurationId) {
+        const assigned = await posStripe('POST', `terminal/locations/${locationId}`, {
+            params: {
+                configuration_overrides: String(saved.body.id)
+            }
+        });
+        if (!assigned.ok) {
+            var _assigned_body;
+            console.error('[pos-terminal] offline configuration assignment failed', hostId, (_assigned_body = assigned.body) == null ? void 0 : _assigned_body.error);
+            return false;
+        }
+    }
+    await ref.set({
+        stripeConfigurationId: String(saved.body.id),
+        offlineEnabled: true
+    }, {
+        merge: true
+    });
+    return true;
+}
 
 //# sourceMappingURL=pos-terminal.js.map