@fire-spark/payments-clisitef-pinpad-rn 0.7.1 → 0.7.2

package/dist/index.d.ts

@@ -24,10 +24,11 @@ type ClisitefPinPadOptions = {
   timeoutMs?: number;
 };
 /**
- * CliSiTef (Software Express) on the kiosk pinpad, Brazil. One adapter per
- * modality payment (DEBIT / CREDIT / VOUCHER in `payments.config`). The
- * pinpad waits on the customer, so the deadline is `timeoutMs` instead of
- * the 30 s library default.
+ * CliSiTef (Software Express) on the kiosk pinpad, Brazil. The payment lists
+ * its `modalities` (DEBIT / CREDIT / VOUCHER); with more than one the
+ * customer picks it before the pinpad starts. The pinpad waits on the
+ * customer, so the deadline is `timeoutMs` instead of the 30 s library
+ * default.
  */
 declare const clisitefPinPadPayments: (options?: ClisitefPinPadOptions) => PaymentAdapter;
 //#endregion
@@ -127,14 +128,20 @@ declare const clisitefPinPadErrors: Readonly<Record<string, PaymentErrorEntry>>
 //#endregion
 //#region src/settings.d.ts
 declare const CLISITEF_PINPAD_TYPES: readonly ["ANDROID_USB", "ANDROID_BT", "ANDROID_AUTO"];
-/** Ficha §6: filled per kiosk in the device settings. */
+/**
+ * Ficha §6: filled per kiosk in the device settings. SiTef IP, store code
+ * and store CNPJ come from the payment's store settings (`config.stores`);
+ * the device values only override them.
+ */
 declare const clisitefPinPadDeviceFields: DeviceField[];
 type ClisitefModality = keyof typeof CLISITEF_MODALITY;
+type ClisitefCardModality = Exclude<ClisitefModality, "PIX">;
 type ClisitefPinPadSettings = {
   configure: ClisitefConfigureParams;
-  modality: Exclude<ClisitefModality, "PIX">;
+  /** Asked to the customer when there is more than one. */
+  modalities: ClisitefCardModality[];
   operator: string;
-  restrictions: string;
+  restrictions: Partial<Record<ClisitefCardModality, string>>;
   terminalNumber: string;
 };
 /** `payments.config` (merchant) + device settings; throws when incomplete. */
@@ -214,4 +221,4 @@ type ClisitefTransactionInput = {
  */
 declare const runClisitefTransaction: (input: ClisitefTransactionInput) => Promise<ClisitefOutcome>;
 //#endregion
-export { CLISITEF_CANCEL_CODES, CLISITEF_CAPTURE_FIELDS, CLISITEF_COMMAND, CLISITEF_CONFIRMATION_TIMEOUT_MS, CLISITEF_DEFAULT_OPERATOR, CLISITEF_FIELD, CLISITEF_INCONCLUSIVE_CODES, CLISITEF_NO, CLISITEF_PAYMENT_TIMEOUT_MS, CLISITEF_PINPAD_TYPES, CLISITEF_STORAGE_KEY, CLISITEF_YES, ClisitefFields, ClisitefModality, ClisitefOutcome, ClisitefOutcomeStatus, ClisitefPinPadOptions, ClisitefPinPadSettings, ClisitefTransactionInput, ClisitefTransactionRecord, ClisitefTransactionState, clisitefDetails, clisitefLast4, clisitefMetadata, clisitefPinPadCapabilities, clisitefPinPadDeviceFields, clisitefPinPadErrors, clisitefPinPadPayments, isOpen, readClisitefPinPadSettings, readTransaction, runClisitefTransaction, writeTransaction };
+export { CLISITEF_CANCEL_CODES, CLISITEF_CAPTURE_FIELDS, CLISITEF_COMMAND, CLISITEF_CONFIRMATION_TIMEOUT_MS, CLISITEF_DEFAULT_OPERATOR, CLISITEF_FIELD, CLISITEF_INCONCLUSIVE_CODES, CLISITEF_NO, CLISITEF_PAYMENT_TIMEOUT_MS, CLISITEF_PINPAD_TYPES, CLISITEF_STORAGE_KEY, CLISITEF_YES, ClisitefCardModality, ClisitefFields, ClisitefModality, ClisitefOutcome, ClisitefOutcomeStatus, ClisitefPinPadOptions, ClisitefPinPadSettings, ClisitefTransactionInput, ClisitefTransactionRecord, ClisitefTransactionState, clisitefDetails, clisitefLast4, clisitefMetadata, clisitefPinPadCapabilities, clisitefPinPadDeviceFields, clisitefPinPadErrors, clisitefPinPadPayments, isOpen, readClisitefPinPadSettings, readTransaction, runClisitefTransaction, writeTransaction };

package/dist/index.js

@@ -231,40 +231,29 @@ const CLISITEF_PINPAD_TYPES = [
 	"ANDROID_BT",
 	"ANDROID_AUTO"
 ];
-/** Ficha §6: filled per kiosk in the device settings. */
-const clisitefPinPadDeviceFields = [
-	{
-		key: "sitef_ip",
-		label: "SiTef server IP",
-		type: "text",
-		required: true
-	},
-	{
-		key: "store_code",
-		label: "SiTef store code",
-		type: "text",
-		required: true
-	},
-	{
-		key: "terminal_number",
-		label: "SiTef terminal number",
-		type: "text",
-		required: true
-	},
-	{
-		key: "cnpj_store",
-		label: "Store CNPJ",
-		type: "text",
-		required: true
-	},
-	{
-		key: "pinpad_type",
-		label: "Pinpad connection",
-		type: "select",
-		required: true,
-		options: [...CLISITEF_PINPAD_TYPES]
-	}
-];
+/**
+* Ficha §6: filled per kiosk in the device settings. SiTef IP, store code
+* and store CNPJ come from the payment's store settings (`config.stores`);
+* the device values only override them.
+*/
+const clisitefPinPadDeviceFields = [{
+	key: "terminal_number",
+	label: "SiTef terminal number",
+	type: "text",
+	required: true
+}, {
+	key: "pinpad_type",
+	label: "Pinpad connection",
+	type: "select",
+	options: [...CLISITEF_PINPAD_TYPES]
+}];
+/** The API only sends the entry of the kiosk's store. */
+const storeSettingsOf = (config) => {
+	const stores = config.stores;
+	if (!stores || typeof stores !== "object") return {};
+	const [first] = Object.values(stores);
+	return first && typeof first === "object" ? first : {};
+};
 const text = (value) => {
 	return typeof value === "string" ? value.trim() : "";
 };
@@ -274,17 +263,33 @@ const notConfigured = (missing) => {
 const isModality = (value) => {
 	return value === "DEBIT" || value === "CREDIT" || value === "VOUCHER";
 };
+/** `modalities`, or the legacy single `modality` of older configs. */
+const listModalities = (config) => {
+	const listed = Array.isArray(config.modalities) ? config.modalities : [];
+	return (listed.length ? listed : [config.modality]).map(text).filter(Boolean);
+};
+/** Per modality; the legacy `restrictions` applies to all of them. */
+const readRestrictions = (config, modalities) => {
+	const raw = config.restrictions_by_modality;
+	const byModality = raw && typeof raw === "object" ? raw : {};
+	const legacy = text(config.restrictions);
+	const entries = modalities.map((modality) => {
+		return [modality, text(byModality[modality]) || legacy];
+	});
+	return Object.fromEntries(entries.filter(([, value]) => value));
+};
 /** `payments.config` (merchant) + device settings; throws when incomplete. */
 const readClisitefPinPadSettings = (config, device) => {
-	const modality = text(config.modality);
+	const listed = listModalities(config);
 	const cnpjEnterprise = text(config.cnpj_enterprise);
-	const serverIp = text(device.sitef_ip);
-	const storeCode = text(device.store_code);
+	const store = storeSettingsOf(config);
+	const serverIp = text(device.sitef_ip) || text(store.sitef_ip);
+	const storeCode = text(device.store_code) || text(store.store_code);
 	const terminalNumber = text(device.terminal_number);
-	const cnpjStore = text(device.cnpj_store).replace(/\D/g, "");
+	const cnpjStore = (text(device.cnpj_store) || text(store.cnpj_store)).replace(/\D/g, "");
 	const pinpadType = text(device.pinpad_type) || void 0;
 	const required = {
-		modality,
+		modalities: listed.join(","),
 		cnpj_enterprise: cnpjEnterprise
 	};
 	const fromDevice = {
@@ -307,21 +312,24 @@ const readClisitefPinPadSettings = (config, device) => {
 		missing
 	});
 	if (missing.length) throw notConfigured(missing);
-	if (!isModality(modality)) throw notConfigured(["a valid modality"]);
+	if (!listed.every(isModality)) throw notConfigured(["a valid modality"]);
+	const configure = {
+		serverIp,
+		storeCode,
+		terminalNumber,
+		additionalParams: clisitefAdditionalParams({
+			cnpjStore,
+			cnpjEnterprise,
+			pinpadType
+		})
+	};
+	const operator = text(config.operator) || "KIOSKO_BR";
+	const unique = [...new Set(listed)];
 	return {
-		configure: {
-			serverIp,
-			storeCode,
-			terminalNumber,
-			additionalParams: clisitefAdditionalParams({
-				cnpjStore,
-				cnpjEnterprise,
-				pinpadType
-			})
-		},
-		modality,
-		operator: text(config.operator) || "KIOSKO_BR",
-		restrictions: text(config.restrictions),
+		configure,
+		modalities: unique,
+		operator,
+		restrictions: readRestrictions(config, unique),
 		terminalNumber
 	};
 };
@@ -733,6 +741,26 @@ const outcomeError = (outcome, attempt) => {
 		fallback
 	});
 };
+const MODALITY_LABELS = {
+	DEBIT: "Débito",
+	CREDIT: "Crédito",
+	VOUCHER: "Voucher"
+};
+/** The only modality, or the one the customer picks. */
+const chooseModality = async (ui, modalities) => {
+	const [first] = modalities;
+	if (modalities.length === 1 && first) return first;
+	const options = modalities.map((value) => {
+		return {
+			label: MODALITY_LABELS[value],
+			value
+		};
+	});
+	return ui.select({
+		title: "Selecione a forma de pagamento",
+		options
+	});
+};
 const debugContext = (ctx) => {
 	const { attemptReference, attempt, amount, config, deviceSettings } = ctx;
 	return {
@@ -752,10 +780,11 @@ const terminalError = (error) => {
 	};
 };
 /**
-* CliSiTef (Software Express) on the kiosk pinpad, Brazil. One adapter per
-* modality payment (DEBIT / CREDIT / VOUCHER in `payments.config`). The
-* pinpad waits on the customer, so the deadline is `timeoutMs` instead of
-* the 30 s library default.
+* CliSiTef (Software Express) on the kiosk pinpad, Brazil. The payment lists
+* its `modalities` (DEBIT / CREDIT / VOUCHER); with more than one the
+* customer picks it before the pinpad starts. The pinpad waits on the
+* customer, so the deadline is `timeoutMs` instead of the 30 s library
+* default.
 */
 const clisitefPinPadPayments = (options = {}) => {
 	const client = options.client ?? clisitef;
@@ -879,6 +908,7 @@ const clisitefPinPadPayments = (options = {}) => {
 			const error = createPaymentError("TERMINAL_BUSY", { attempt: ctx.attempt });
 			return failed(empty, reference, error);
 		}
+		const chosen = await chooseModality(ctx.ui, settings.modalities);
 		const date = now();
 		const fiscal = clisitefFiscalDateTime(date, options.timeZone);
 		const fiscalCoupon = String(date.getTime());
@@ -895,18 +925,18 @@ const clisitefPinPadPayments = (options = {}) => {
 		};
 		await writeTransaction(storage, record);
 		const s1 = {
-			modality: CLISITEF_MODALITY[settings.modality],
+			modality: CLISITEF_MODALITY[chosen],
 			value: formatClisitefAmount(amount),
 			...finish
 		};
-		const s2 = { operator: settings.operator };
+		const restrictions = settings.restrictions[chosen] ?? "";
 		const start = {
 			...s1,
-			...s2,
-			restrictions: settings.restrictions
+			operator: settings.operator,
+			restrictions
 		};
 		const meta = {
-			modality: settings.modality,
+			modality: chosen,
 			fiscalCoupon
 		};
 		const m1 = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fire-spark/payments-clisitef-pinpad-rn",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "Fire Spark CliSiTef (Software Express) pinpad adapter for Brazil: debit, credit and voucher on Android kiosks",
   "type": "module",
   "sideEffects": false,
@@ -17,9 +17,9 @@
     }
   },
   "dependencies": {
-    "@fire-spark/payments": "^0.7.1",
-    "@fire-spark/payments-clisitef-client": "^0.7.1",
-    "@fire-spark/types": "^0.7.1"
+    "@fire-spark/payments": "^0.7.2",
+    "@fire-spark/payments-clisitef-client": "^0.7.2",
+    "@fire-spark/types": "^0.7.2"
   },
   "devDependencies": {
     "tsdown": "^0.22.14",