@tamtamchik/app-store-receipt-parser 2.2.3 → 2.3.0

package/CHANGELOG.md

@@ -0,0 +1,115 @@
+# Changelog
+
+## 2.3.0 - 2026-05-27
+
+### Added
+
+- Added `IN_APP_RECEIPTS` to parsed receipts, exposing each supported in-app purchase receipt as a structured object.
+- Exported the `InAppReceipt` type from the package entrypoint.
+
+### Changed
+
+- Updated package metadata and documentation to describe selected receipt field parsing beyond transaction ID extraction.
+- Updated the package version to `2.3.0`.
+
+### Maintenance
+
+- Updated dependency lockfile entries already merged into `main`.
+- Updated transitive development dependency resolution for `brace-expansion` to clear npm audit findings.
+- Pinned GitHub Actions workflow actions by commit SHA and constrained Dependabot update cadence.
+
+## 2.2.3 - 2026-04-15
+
+### Added
+
+- Added a security policy.
+- Added GitHub Actions CI for linting, building, and testing.
+
+### Changed
+
+- Migrated tests from Jest to the Node.js test runner.
+- Split linting into `lint` and `lint:fix` scripts.
+
+### Fixed
+
+- Upgraded `asn1js` from `3.0.6` to `3.0.7`.
+
+### Maintenance
+
+- Updated development dependencies and GitHub Actions versions.
+- Consolidated ESLint dependencies.
+
+## 2.2.2 - 2025-05-02
+
+### Fixed
+
+- Upgraded `asn1js` from `3.0.5` to `3.0.6`.
+
+### Maintenance
+
+- Updated dependencies.
+
+## 2.2.1 - 2024-09-25
+
+### Fixed
+
+- Fixed exported TypeScript types.
+
+## 2.2.0 - 2024-09-25
+
+### Changed
+
+- Refactored parser and verifier internals into classes.
+- Updated TypeScript and ESLint configuration.
+
+### Maintenance
+
+- Updated dependencies.
+
+## 2.1.2 - 2024-05-20
+
+### Maintenance
+
+- Updated the Scrutinizer Node.js version.
+
+## 2.1.1 - 2024-05-06
+
+### Maintenance
+
+- Updated dependencies.
+
+## 2.1.0 - 2024-04-11
+
+### Added
+
+- Added mapping for the `ENVIRONMENT` receipt field.
+- Added `Production` as the default parsed environment.
+
+### Fixed
+
+- Fixed parsed receipt completeness checks for the `ENVIRONMENT` field.
+
+### Maintenance
+
+- Updated dependencies and documentation.
+
+## 2.0.0 - 2024-01-10
+
+### Changed
+
+- Refactored the parser implementation for the `2.x` release line.
+- Updated documentation and project structure.
+
+## 1.0.1 - 2023-11-14
+
+### Maintenance
+
+- Simplified tests.
+- Moved CI from CircleCI to Scrutinizer.
+
+## 1.0.0 - 2023-08-19
+
+### Added
+
+- Added the initial receipt parsing functionality.
+- Added tests, publishing configuration, and README documentation.

package/README.md

@@ -7,11 +7,11 @@
 [![Software License][ico-license]](./LICENSE)
 [![Total Downloads][ico-downloads]][link-downloads]
 
-A lightweight TypeScript library for extracting transaction IDs from Apple's ASN.1 encoded Unified Receipts.
+A lightweight TypeScript library for extracting selected fields from Apple's ASN.1 encoded Unified Receipts.
 
 > [!IMPORTANT]
 > This library is not a full-fledged receipt parser. 
-> It only extracts some information from Apple's ASN.1 encoded Unified Receipts.
+> It extracts supported fields from Apple's ASN.1 encoded Unified Receipts, including in-app purchase receipts.
 > It does not work with the old-style transaction receipts.
 
 > [!NOTE]
@@ -33,6 +33,9 @@ yarn add @tamtamchik/app-store-receipt-parser
 
 ## Usage
 
+The result includes selected top-level receipt fields, aggregate in-app transaction IDs,
+and structured in-app receipt data in `IN_APP_RECEIPTS`.
+
 ```typescript
 import { parseReceipt } from '@tamtamchik/app-store-receipt-parser';
 
@@ -65,6 +68,20 @@ console.log(data);
 //     '1000000166967484',
 //     '1000000166967782'
 //   ],
+//   IN_APP_RECEIPTS: [
+//     // ...
+//     {
+//       IN_APP_EXPIRES_DATE: '2015-08-10T07:19:32Z',
+//       IN_APP_CANCELLATION_DATE: '',
+//       IN_APP_QUANTITY: '020101',
+//       IN_APP_WEB_ORDER_LINE_ITEM_ID: '0207038d7ea69472c9',
+//       IN_APP_PRODUCT_ID: 'monthly',
+//       IN_APP_TRANSACTION_ID: '1000000166967782',
+//       IN_APP_ORIGINAL_TRANSACTION_ID: '1000000166965150',
+//       IN_APP_PURCHASE_DATE: '2015-08-10T07:14:32Z',
+//       IN_APP_ORIGINAL_PURCHASE_DATE: '2015-08-10T07:12:34Z'
+//     }
+//   ],
 //   IN_APP_ORIGINAL_TRANSACTION_ID: '1000000166965150',
 //   IN_APP_ORIGINAL_TRANSACTION_IDS: [
 //     '1000000166865231',

package/dist/index.js

@@ -145,38 +145,43 @@ var ReceiptParser = class {
   createInitialParsedReceipt() {
     return {
       ENVIRONMENT: "Production",
+      IN_APP_RECEIPTS: [],
       IN_APP_ORIGINAL_TRANSACTION_IDS: [],
       IN_APP_TRANSACTION_IDS: []
     };
   }
-  parseReceiptContent(content) {
+  parseReceiptContent(content, inAppReceipt) {
     const sequences = this.extractSequencesFromContent(content);
-    sequences.forEach(this.processSequence.bind(this));
+    sequences.forEach((sequence) => this.processSequence(sequence, inAppReceipt));
   }
   extractSequencesFromContent(content) {
     const [contentSet] = content.valueBlock.value;
     return contentSet.valueBlock.value.filter((v) => v instanceof ASN1.Sequence);
   }
-  processSequence(sequence) {
+  processSequence(sequence, inAppReceipt) {
     const verifiedSequence = this.receiptVerifier.verifyFieldSchema(sequence);
     if (verifiedSequence) {
-      this.handleVerifiedSequence(verifiedSequence);
+      this.handleVerifiedSequence(verifiedSequence, inAppReceipt);
     }
   }
-  handleVerifiedSequence(verifiedSequence) {
+  handleVerifiedSequence(verifiedSequence, inAppReceipt) {
     const fieldKey = verifiedSequence.result[FIELD_TYPE_ID].valueBlock.valueDec;
     const fieldValue = verifiedSequence.result[FIELD_VALUE_ID];
-    const handler = this.getFieldHandler(fieldKey);
+    const handler = this.getFieldHandler(fieldKey, inAppReceipt);
     handler(fieldValue);
   }
-  getFieldHandler(fieldKey) {
+  getFieldHandler(fieldKey, inAppReceipt) {
     if (fieldKey === IN_APP) {
-      return this.parseReceiptContent.bind(this);
+      return (fieldValue) => {
+        const parsedInAppReceipt = {};
+        this.parseReceiptContent(fieldValue, parsedInAppReceipt);
+        this.parsed.IN_APP_RECEIPTS.push(parsedInAppReceipt);
+      };
     }
     if (this.isValidReceiptFieldKey(fieldKey)) {
       const name = RECEIPT_FIELDS_MAP.get(fieldKey);
       return (fieldValue) => {
-        this.addFieldToReceipt(name, this.extractStringValue(fieldValue));
+        this.addFieldToReceipt(name, this.extractStringValue(fieldValue), inAppReceipt);
       };
     }
     return () => {
@@ -192,9 +197,12 @@ var ReceiptParser = class {
     }
     return field.toJSON().valueBlock.valueHex;
   }
-  addFieldToReceipt(name, value) {
+  addFieldToReceipt(name, value, inAppReceipt) {
     this.addToArrayFieldIfApplicable(name, value);
     this.parsed[name] = value;
+    if (inAppReceipt) {
+      inAppReceipt[name] = value;
+    }
   }
   addToArrayFieldIfApplicable(name, value) {
     const arrayFields = {

package/dist/index.mjs

@@ -109,38 +109,43 @@ var ReceiptParser = class {
   createInitialParsedReceipt() {
     return {
       ENVIRONMENT: "Production",
+      IN_APP_RECEIPTS: [],
       IN_APP_ORIGINAL_TRANSACTION_IDS: [],
       IN_APP_TRANSACTION_IDS: []
     };
   }
-  parseReceiptContent(content) {
+  parseReceiptContent(content, inAppReceipt) {
     const sequences = this.extractSequencesFromContent(content);
-    sequences.forEach(this.processSequence.bind(this));
+    sequences.forEach((sequence) => this.processSequence(sequence, inAppReceipt));
   }
   extractSequencesFromContent(content) {
     const [contentSet] = content.valueBlock.value;
     return contentSet.valueBlock.value.filter((v) => v instanceof ASN1.Sequence);
   }
-  processSequence(sequence) {
+  processSequence(sequence, inAppReceipt) {
     const verifiedSequence = this.receiptVerifier.verifyFieldSchema(sequence);
     if (verifiedSequence) {
-      this.handleVerifiedSequence(verifiedSequence);
+      this.handleVerifiedSequence(verifiedSequence, inAppReceipt);
     }
   }
-  handleVerifiedSequence(verifiedSequence) {
+  handleVerifiedSequence(verifiedSequence, inAppReceipt) {
     const fieldKey = verifiedSequence.result[FIELD_TYPE_ID].valueBlock.valueDec;
     const fieldValue = verifiedSequence.result[FIELD_VALUE_ID];
-    const handler = this.getFieldHandler(fieldKey);
+    const handler = this.getFieldHandler(fieldKey, inAppReceipt);
     handler(fieldValue);
   }
-  getFieldHandler(fieldKey) {
+  getFieldHandler(fieldKey, inAppReceipt) {
     if (fieldKey === IN_APP) {
-      return this.parseReceiptContent.bind(this);
+      return (fieldValue) => {
+        const parsedInAppReceipt = {};
+        this.parseReceiptContent(fieldValue, parsedInAppReceipt);
+        this.parsed.IN_APP_RECEIPTS.push(parsedInAppReceipt);
+      };
     }
     if (this.isValidReceiptFieldKey(fieldKey)) {
       const name = RECEIPT_FIELDS_MAP.get(fieldKey);
       return (fieldValue) => {
-        this.addFieldToReceipt(name, this.extractStringValue(fieldValue));
+        this.addFieldToReceipt(name, this.extractStringValue(fieldValue), inAppReceipt);
       };
     }
     return () => {
@@ -156,9 +161,12 @@ var ReceiptParser = class {
     }
     return field.toJSON().valueBlock.valueHex;
   }
-  addFieldToReceipt(name, value) {
+  addFieldToReceipt(name, value, inAppReceipt) {
     this.addToArrayFieldIfApplicable(name, value);
     this.parsed[name] = value;
+    if (inAppReceipt) {
+      inAppReceipt[name] = value;
+    }
   }
   addToArrayFieldIfApplicable(name, value) {
     const arrayFields = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tamtamchik/app-store-receipt-parser",
-  "version": "2.2.3",
-  "description": "A lightweight TypeScript library for extracting transaction IDs from Apple's ASN.1 encoded receipts.",
+  "version": "2.3.0",
+  "description": "A lightweight TypeScript library for extracting selected fields from Apple's ASN.1 encoded receipts.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./src/index.ts",
@@ -20,6 +20,7 @@
     "receipt",
     "parser",
     "ASN.1",
+    "in-app",
     "transaction",
     "typescript"
   ],

package/src/ReceiptParser.ts

@@ -13,8 +13,11 @@ import { ReceiptVerifier } from './ReceiptVerifier'
 
 export type Environment = 'Production' | 'ProductionSandbox' | string
 
+export type InAppReceipt = Partial<Record<ReceiptFieldsKeyNames, string>>
+
 export type ParsedReceipt = Partial<Record<ReceiptFieldsKeyNames, string>> & {
   ENVIRONMENT: Environment
+  IN_APP_RECEIPTS: InAppReceipt[]
   IN_APP_ORIGINAL_TRANSACTION_IDS: string[]
   IN_APP_TRANSACTION_IDS: string[]
 }
@@ -46,14 +49,15 @@ class ReceiptParser {
   private createInitialParsedReceipt(): ParsedReceipt {
     return {
       ENVIRONMENT: 'Production',
+      IN_APP_RECEIPTS: [],
       IN_APP_ORIGINAL_TRANSACTION_IDS: [],
       IN_APP_TRANSACTION_IDS: [],
     }
   }
 
-  private parseReceiptContent(content: ASN1.OctetString): void {
+  private parseReceiptContent(content: ASN1.OctetString, inAppReceipt?: InAppReceipt): void {
     const sequences = this.extractSequencesFromContent(content)
-    sequences.forEach(this.processSequence.bind(this))
+    sequences.forEach(sequence => this.processSequence(sequence, inAppReceipt))
   }
 
   private extractSequencesFromContent(content: ASN1.OctetString): ASN1.Sequence[] {
@@ -62,29 +66,39 @@ class ReceiptParser {
       .filter(v => v instanceof ASN1.Sequence) as ASN1.Sequence[]
   }
 
-  private processSequence(sequence: ASN1.Sequence): void {
+  private processSequence(sequence: ASN1.Sequence, inAppReceipt?: InAppReceipt): void {
     const verifiedSequence = this.receiptVerifier.verifyFieldSchema(sequence)
     if (verifiedSequence) {
-      this.handleVerifiedSequence(verifiedSequence)
+      this.handleVerifiedSequence(verifiedSequence, inAppReceipt)
     }
   }
 
-  private handleVerifiedSequence(verifiedSequence: ASN1.CompareSchemaSuccess): void {
+  private handleVerifiedSequence(
+    verifiedSequence: ASN1.CompareSchemaSuccess,
+    inAppReceipt?: InAppReceipt,
+  ): void {
     const fieldKey = (verifiedSequence.result[FIELD_TYPE_ID] as ASN1.Integer).valueBlock.valueDec
     const fieldValue = verifiedSequence.result[FIELD_VALUE_ID] as ASN1.OctetString
 
-    const handler = this.getFieldHandler(fieldKey)
+    const handler = this.getFieldHandler(fieldKey, inAppReceipt)
     handler(fieldValue)
   }
 
-  private getFieldHandler(fieldKey: number): (fieldValue: ASN1.OctetString) => void {
+  private getFieldHandler(
+    fieldKey: number,
+    inAppReceipt?: InAppReceipt,
+  ): (fieldValue: ASN1.OctetString) => void {
     if (fieldKey === IN_APP) {
-      return this.parseReceiptContent.bind(this)
+      return (fieldValue: ASN1.OctetString) => {
+        const parsedInAppReceipt: InAppReceipt = {}
+        this.parseReceiptContent(fieldValue, parsedInAppReceipt)
+        this.parsed.IN_APP_RECEIPTS.push(parsedInAppReceipt)
+      }
     }
     if (this.isValidReceiptFieldKey(fieldKey)) {
       const name = RECEIPT_FIELDS_MAP.get(fieldKey)!
       return (fieldValue: ASN1.OctetString) => {
-        this.addFieldToReceipt(name, this.extractStringValue(fieldValue))
+        this.addFieldToReceipt(name, this.extractStringValue(fieldValue), inAppReceipt)
       }
     }
     return () => {}
@@ -104,9 +118,12 @@ class ReceiptParser {
     return field.toJSON().valueBlock.valueHex
   }
 
-  private addFieldToReceipt(name: ReceiptFieldsKeyNames, value: string): void {
+  private addFieldToReceipt(name: ReceiptFieldsKeyNames, value: string, inAppReceipt?: InAppReceipt): void {
     this.addToArrayFieldIfApplicable(name, value)
     this.parsed[name] = value
+    if (inAppReceipt) {
+      inAppReceipt[name] = value
+    }
   }
 
   private addToArrayFieldIfApplicable(name: ReceiptFieldsKeyNames, value: string): void {

package/src/index.ts

@@ -1,2 +1,2 @@
-export type { ParsedReceipt } from './ReceiptParser'
+export type { InAppReceipt, ParsedReceipt } from './ReceiptParser'
 export { parseReceipt } from './ReceiptParser'