@chipmobilesdk/rn-payment 0.4.0 → 0.5.0

package/src/diagnostics/errors.ts

@@ -1,117 +1,124 @@
-/**
- * Normalized public errors.
- *
- * Error codes are **public API**: renaming one is a breaking change (FR-078,
- * LIB-008). They are the vocabulary an app branches on, so they must outlive any
- * internal refactor and must never leak a store's own code.
- */
-
-export const PAYMENT_ERROR_CODES = [
-	'PAYMENT_NOT_CONFIGURED',
-	'PAYMENT_INVALID_CATALOG',
-	'PAYMENT_NOT_READY',
-	'PAYMENT_DISABLED',
-	'PAYMENT_UNAVAILABLE',
-	'PAYMENT_UNSUPPORTED_PLATFORM',
-	'PAYMENT_ENVIRONMENT_BLOCKED',
-	'PAYMENT_PRODUCTION_CONFIG_IN_NON_PRODUCTION_BUILD',
-	'PAYMENT_PURCHASE_IN_PROGRESS',
-	'PAYMENT_USER_CANCELLED',
-	'PAYMENT_PENDING',
-	'PAYMENT_ALREADY_OWNED',
-	'PAYMENT_INELIGIBLE',
-	'PAYMENT_UNKNOWN_PRODUCT',
-	'PAYMENT_PRODUCT_UNAVAILABLE_IN_REGION',
-	'PAYMENT_TIMEOUT',
-	'PAYMENT_NETWORK_ERROR',
-	'PAYMENT_STORE_ERROR',
-	'PAYMENT_FINALIZE_FAILED',
-	'PAYMENT_VALIDATION_REJECTED',
-	'PAYMENT_VALIDATION_UNAVAILABLE',
-	'PAYMENT_STORAGE_UNAVAILABLE',
-	/** `consume` on a transaction that is not a consumable, added in 0.3.2. */
-	'PAYMENT_NOT_CONSUMABLE',
-] as const;
-
-export type PaymentErrorCode = (typeof PAYMENT_ERROR_CODES)[number];
-
-/** Which operation produced an error. Part of the public error shape (FR-078). */
-export type PaymentOperation =
-	| 'configure'
-	| 'initialize'
-	| 'getProducts'
-	| 'purchase'
-	| 'finalize'
-	| 'consume'
-	| 'sync'
-	| 'restore'
-	| 'changePlan'
-	| 'validate'
-	| 'persist';
-
-export class PaymentError extends Error {
-	readonly code: PaymentErrorCode;
-	readonly operation: PaymentOperation;
-	readonly retryable: boolean;
-	/** Redacted where appropriate — never a raw receipt, token, or store object (FR-074). */
-	readonly cause?: string;
-
-	constructor(init: {
-		code: PaymentErrorCode;
-		message: string;
-		operation: PaymentOperation;
-		retryable?: boolean;
-		cause?: string;
-	}) {
-		super(init.message);
-		this.name = 'PaymentError';
-		this.code = init.code;
-		this.operation = init.operation;
-		this.retryable = init.retryable ?? false;
-		this.cause = init.cause;
-	}
-}
-
-/**
- * A configuration problem the app can act on.
- *
- * Separate from `PaymentError` because configuration faults are developer-facing
- * and must never be shown to an end user — the message-key map keeps that
- * separation explicit (FR-085).
- */
-export class PaymentConfigError extends PaymentError {
-	/** The offending catalog entries or entitlement keys, named (FR-011). */
-	readonly offenders: string[];
-
-	constructor(init: {
-		code: PaymentErrorCode;
-		message: string;
-		operation: PaymentOperation;
-		offenders?: string[];
-	}) {
-		super({ ...init, retryable: false });
-		this.name = 'PaymentConfigError';
-		this.offenders = init.offenders ?? [];
-	}
-}
-
-/**
- * Strips anything that must never reach a log or event.
- *
- * Applied at the boundary rather than trusted to call sites: a single forgotten
- * interpolation is how receipts end up in logs (NFR-006).
- *
- * Identifier-only: what survives is what code defined, never what data carried.
- * A `PaymentError` keeps its code and an `Error` its class name; every message
- * and every string is dropped, because a store or consumer message can embed a
- * purchase token or an account id and nothing here can tell which.
- */
-export function redact(value: unknown): string {
-	if (value instanceof PaymentError) {
-		return value.code;
-	}
-	if (value instanceof Error) {
-		return value.name;
-	}
-	return '[redacted]';
-}
+/**
+ * Normalized public errors.
+ *
+ * Error codes are **public API**: renaming one is a breaking change (FR-078,
+ * LIB-008). They are the vocabulary an app branches on, so they must outlive any
+ * internal refactor and must never leak a store's own code.
+ */
+
+import { REDACTED, SdkError, createRedactor } from '@chipmobilesdk/rn-core';
+
+const identifiers = createRedactor();
+
+export const PAYMENT_ERROR_CODES = [
+	'PAYMENT_NOT_CONFIGURED',
+	'PAYMENT_INVALID_CATALOG',
+	'PAYMENT_NOT_READY',
+	'PAYMENT_DISABLED',
+	'PAYMENT_UNAVAILABLE',
+	'PAYMENT_UNSUPPORTED_PLATFORM',
+	'PAYMENT_ENVIRONMENT_BLOCKED',
+	'PAYMENT_PRODUCTION_CONFIG_IN_NON_PRODUCTION_BUILD',
+	'PAYMENT_PURCHASE_IN_PROGRESS',
+	'PAYMENT_USER_CANCELLED',
+	'PAYMENT_PENDING',
+	'PAYMENT_ALREADY_OWNED',
+	'PAYMENT_INELIGIBLE',
+	'PAYMENT_UNKNOWN_PRODUCT',
+	'PAYMENT_PRODUCT_UNAVAILABLE_IN_REGION',
+	'PAYMENT_TIMEOUT',
+	'PAYMENT_NETWORK_ERROR',
+	'PAYMENT_STORE_ERROR',
+	'PAYMENT_FINALIZE_FAILED',
+	'PAYMENT_VALIDATION_REJECTED',
+	'PAYMENT_VALIDATION_UNAVAILABLE',
+	'PAYMENT_STORAGE_UNAVAILABLE',
+	/** `consume` on a transaction that is not a consumable, added in 0.3.2. */
+	'PAYMENT_NOT_CONSUMABLE',
+	/**
+	 * A timeout, backoff or interval outside its bounds, added in 0.5.0. These
+	 * used to be reported as `PAYMENT_INVALID_CATALOG`, which is about products.
+	 */
+	'PAYMENT_INVALID_CONFIG',
+] as const;
+
+export type PaymentErrorCode = (typeof PAYMENT_ERROR_CODES)[number];
+
+/** Which operation produced an error. Part of the public error shape (FR-078). */
+export type PaymentOperation =
+	| 'configure'
+	| 'initialize'
+	| 'getProducts'
+	| 'purchase'
+	| 'finalize'
+	| 'consume'
+	| 'sync'
+	| 'restore'
+	| 'changePlan'
+	| 'validate'
+	| 'persist';
+
+/** The package's error; an `SdkError` (`@chipmobilesdk/rn-core`) with `pkg: 'rn-payment'`. */
+export class PaymentError extends SdkError<PaymentErrorCode> {
+	readonly operation: PaymentOperation;
+	/** Redacted where appropriate — never a raw receipt, token, or store object (FR-074). */
+	readonly cause?: string;
+
+	constructor(init: {
+		code: PaymentErrorCode;
+		message: string;
+		operation: PaymentOperation;
+		retryable?: boolean;
+		cause?: string;
+	}) {
+		super('rn-payment', init.code, {
+			message: init.message,
+			retryable: init.retryable ?? false,
+			redactedCause: init.cause,
+		});
+		this.name = 'PaymentError';
+		this.operation = init.operation;
+		this.cause = init.cause;
+	}
+}
+
+/**
+ * A configuration problem the app can act on.
+ *
+ * Separate from `PaymentError` because configuration faults are developer-facing
+ * and must never be shown to an end user — the message-key map keeps that
+ * separation explicit (FR-085).
+ */
+export class PaymentConfigError extends PaymentError {
+	/** The offending catalog entries or entitlement keys, named (FR-011). */
+	readonly offenders: string[];
+
+	constructor(init: {
+		code: PaymentErrorCode;
+		message: string;
+		operation: PaymentOperation;
+		offenders?: string[];
+	}) {
+		super({ ...init, retryable: false });
+		this.name = 'PaymentConfigError';
+		this.offenders = init.offenders ?? [];
+	}
+}
+
+/**
+ * Strips anything that must never reach a log or event.
+ *
+ * Applied at the boundary rather than trusted to call sites: a single forgotten
+ * interpolation is how receipts end up in logs (NFR-006).
+ *
+ * Identifier-only: what survives is what code defined, never what data carried.
+ * A `PaymentError` keeps its code and an `Error` its class name; every message
+ * and every string is dropped, because a store or consumer message can embed a
+ * purchase token or an account id and nothing here can tell which.
+ */
+export function redact(value: unknown): string {
+	// An SDK error reduces to its code and any other Error to its class name
+	// (rn-core's identifier-only redactor). Strings never survive here, not even
+	// a leading constant: a store message is free text from a payments SDK.
+	return value instanceof Error ? identifiers.text(value) : REDACTED;
+}