@tamtamchik/app-store-receipt-parser 2.0.0 → 2.1.1

package/README.md

@@ -1,6 +1,5 @@
 # Apple Receipt Parser
 
-[![Buy Me A Coffee][ico-coffee]][link-coffee]
 [![Latest Version on NPM][ico-version]][link-npm]
 [![Scrutinizer build][ico-scrutinizer-build]][link-scrutinizer]
 [![Scrutinizer quality][ico-scrutinizer-quality]][link-scrutinizer]
@@ -10,11 +9,13 @@
 
 A lightweight TypeScript library for extracting transaction IDs from Apple's ASN.1 encoded Unified Receipts.
 
-> **Warning!** This library is not a full-fledged receipt parser. 
-> It only extracts some information from the Apple's ASN.1 encoded Unified Receipts.
-> It does not work with the old style transactions 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 does not work with the old-style transaction receipts.
 
-> **Documentation for the version 1.x of the library can be found [here](https://github.com/tamtamchik/app-store-receipt-parser/tree/1.x/README.md).**
+> [!NOTE]
+> Documentation for the version 1.x of the library can be found [here](https://github.com/tamtamchik/app-store-receipt-parser/tree/1.x/README.md).
 
 ## Installation
 
@@ -41,6 +42,7 @@ const data = parseReceipt(receiptString);
 
 console.log(data);
 // {
+//   ENVIRONMENT: 'ProductionSandbox',
 //   APP_VERSION: '1',
 //   ORIGINAL_APP_VERSION: '1.0',
 //   OPAQUE_VALUE: 'c4dd4054b0b61a07beb585f6a842e048',
@@ -76,10 +78,11 @@ console.log(data);
 ## Special Thanks
 
 - [@Jurajzovinec](https://github.com/Jurajzovinec) for his superb contribution to the project.
+- [@fechy](https://github.com/fechy) for bringing environment variable support to the lib.
 
 ## Contributing
 
-Pull requests are always welcome. If you have bigger changes in mind, please open an issue first to discuss your ideas.
+Pull requests are always welcome. If you have bigger changes, please open an issue first to discuss your ideas.
 
 ## License
 
@@ -87,7 +90,10 @@ Apple Receipt Parser is [MIT licensed](./LICENSE).
 
 ## Third-Party Licenses
 
-This project uses `ASN1.js`, which is licensed under the BSD-3-Clause License. The license text can be found in [LICENSE](./LICENSE).
+This project uses `ASN1.js`, licensed under the BSD-3-Clause License. The license text can be found in [LICENSE](./LICENSE).
+
+---
+[![Buy Me A Coffee][ico-coffee]][link-coffee]
 
 [ico-coffee]: https://img.shields.io/badge/Buy%20Me%20A-Coffee-%236F4E37.svg?style=flat-square
 [ico-version]: https://img.shields.io/npm/v/@tamtamchik/app-store-receipt-parser.svg?style=flat-square

package/dist/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -25,10 +35,11 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/parser.ts
-var import_asn1js2 = require("asn1js");
+var ASN1 = __toESM(require("asn1js"));
 
 // src/mappings.ts
 var RECEIPT_FIELDS_MAP = /* @__PURE__ */ new Map([
+  [0, "ENVIRONMENT"],
   [2, "BUNDLE_ID"],
   [3, "APP_VERSION"],
   [4, "OPAQUE_VALUE"],
@@ -108,12 +119,10 @@ function verifyFieldSchema(sequence) {
   return fieldVerification;
 }
 
-// src/utils.ts
-var uniqueArrayValues = (array) => Array.from(new Set(array));
-
 // src/parser.ts
+var uniqueArrayValues = (array) => Array.from(new Set(array));
 function isReceiptFieldKey(value) {
-  return Boolean(value && typeof value === "number" && RECEIPT_FIELDS_MAP.has(value));
+  return Boolean(typeof value === "number" && RECEIPT_FIELDS_MAP.has(value));
 }
 function isParsedReceiptContentComplete(data) {
   for (const fieldKey of RECEIPT_FIELDS_MAP.values()) {
@@ -125,7 +134,7 @@ function isParsedReceiptContentComplete(data) {
 }
 function extractFieldValue(field) {
   const [fieldValue] = field.valueBlock.value;
-  if (fieldValue instanceof import_asn1js2.IA5String || fieldValue instanceof import_asn1js2.Utf8String) {
+  if (fieldValue instanceof ASN1.IA5String || fieldValue instanceof ASN1.Utf8String) {
     return fieldValue.valueBlock.value;
   }
   return field.toJSON().valueBlock.valueHex;
@@ -152,7 +161,7 @@ function processField(parsed, fieldKey, fieldValue) {
 }
 function parseOctetStringContent(parsed, content) {
   const [contentSet] = content.valueBlock.value;
-  const contentSetSequences = contentSet.valueBlock.value.filter((v) => v instanceof import_asn1js2.Sequence);
+  const contentSetSequences = contentSet.valueBlock.value.filter((v) => v instanceof ASN1.Sequence);
   for (const sequence of contentSetSequences) {
     const verifiedSequence = verifyFieldSchema(sequence);
     if (verifiedSequence) {
@@ -170,6 +179,7 @@ function parseReceipt(receipt) {
   const rootSchemaVerification = verifyReceiptSchema(receipt);
   const content = rootSchemaVerification.result[CONTENT_ID];
   const parsed = {
+    ENVIRONMENT: "Production",
     IN_APP_ORIGINAL_TRANSACTION_IDS: [],
     IN_APP_TRANSACTION_IDS: []
   };

package/dist/index.mjs

@@ -1,8 +1,9 @@
 // src/parser.ts
-import { IA5String, Sequence as Sequence2, Utf8String } from "asn1js";
+import * as ASN1 from "asn1js";
 
 // src/mappings.ts
 var RECEIPT_FIELDS_MAP = /* @__PURE__ */ new Map([
+  [0, "ENVIRONMENT"],
   [2, "BUNDLE_ID"],
   [3, "APP_VERSION"],
   [4, "OPAQUE_VALUE"],
@@ -82,12 +83,10 @@ function verifyFieldSchema(sequence) {
   return fieldVerification;
 }
 
-// src/utils.ts
-var uniqueArrayValues = (array) => Array.from(new Set(array));
-
 // src/parser.ts
+var uniqueArrayValues = (array) => Array.from(new Set(array));
 function isReceiptFieldKey(value) {
-  return Boolean(value && typeof value === "number" && RECEIPT_FIELDS_MAP.has(value));
+  return Boolean(typeof value === "number" && RECEIPT_FIELDS_MAP.has(value));
 }
 function isParsedReceiptContentComplete(data) {
   for (const fieldKey of RECEIPT_FIELDS_MAP.values()) {
@@ -99,7 +98,7 @@ function isParsedReceiptContentComplete(data) {
 }
 function extractFieldValue(field) {
   const [fieldValue] = field.valueBlock.value;
-  if (fieldValue instanceof IA5String || fieldValue instanceof Utf8String) {
+  if (fieldValue instanceof ASN1.IA5String || fieldValue instanceof ASN1.Utf8String) {
     return fieldValue.valueBlock.value;
   }
   return field.toJSON().valueBlock.valueHex;
@@ -126,7 +125,7 @@ function processField(parsed, fieldKey, fieldValue) {
 }
 function parseOctetStringContent(parsed, content) {
   const [contentSet] = content.valueBlock.value;
-  const contentSetSequences = contentSet.valueBlock.value.filter((v) => v instanceof Sequence2);
+  const contentSetSequences = contentSet.valueBlock.value.filter((v) => v instanceof ASN1.Sequence);
   for (const sequence of contentSetSequences) {
     const verifiedSequence = verifyFieldSchema(sequence);
     if (verifiedSequence) {
@@ -144,6 +143,7 @@ function parseReceipt(receipt) {
   const rootSchemaVerification = verifyReceiptSchema(receipt);
   const content = rootSchemaVerification.result[CONTENT_ID];
   const parsed = {
+    ENVIRONMENT: "Production",
     IN_APP_ORIGINAL_TRANSACTION_IDS: [],
     IN_APP_TRANSACTION_IDS: []
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tamtamchik/app-store-receipt-parser",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "A lightweight TypeScript library for extracting transaction IDs from Apple's ASN.1 encoded receipts.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -34,15 +34,15 @@
     "asn1js": "3.0.5"
   },
   "devDependencies": {
-    "@types/jest": "29.5.11",
-    "@types/node": "20.10.6",
-    "@typescript-eslint/eslint-plugin": "6.17.0",
-    "@typescript-eslint/parser": "6.17.0",
-    "eslint": "8.56.0",
+    "@types/jest": "29.5.12",
+    "@types/node": "^20.12.8",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
+    "@typescript-eslint/parser": "^7.8.0",
+    "eslint": "8.57.0",
     "jest": "29.7.0",
-    "ts-jest": "29.1.1",
-    "tsup": "8.0.1",
-    "typescript": "5.3.3"
+    "ts-jest": "29.1.2",
+    "tsup": "8.0.2",
+    "typescript": "5.4.5"
   },
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --clean",

package/src/mappings.ts

@@ -1,22 +1,24 @@
 export type ReceiptFieldsKeyValues =
-  | 2
-  | 3
-  | 4
-  | 5
-  | 12
-  | 18
-  | 19
-  | 1701
-  | 1702
-  | 1703
-  | 1704
-  | 1705
-  | 1706
-  | 1708
-  | 1711
-  | 1712
+  | 0     // Environment
+  | 2     // Bundle ID
+  | 3     // App version
+  | 4     // Opaque value
+  | 5     // SHA-1 hash
+  | 12    // Receipt creation date
+  | 18    // Original purchase date
+  | 19    // Original app version
+  | 1701  // In-app quantity
+  | 1702  // In-app product ID
+  | 1703  // In-app transaction ID
+  | 1704  // In-app purchase date
+  | 1705  // In-app original transaction ID
+  | 1706  // In-app original purchase date
+  | 1708  // In-app expires date
+  | 1711  // In-app web order line item ID
+  | 1712  // In-app cancellation date
 
 export type ReceiptFieldsKeyNames =
+  | 'ENVIRONMENT'
   | 'BUNDLE_ID'
   | 'APP_VERSION'
   | 'OPAQUE_VALUE'
@@ -39,6 +41,7 @@ export type ReceiptFieldsKeyNames =
  * @see https://developer.apple.com/library/archive/releasenotes/General/ValidateAppStoreReceipt/Chapters/ReceiptFields.html
  */
 export const RECEIPT_FIELDS_MAP: ReadonlyMap<ReceiptFieldsKeyValues, ReceiptFieldsKeyNames> = new Map([
+  [0, 'ENVIRONMENT'],
   [2, 'BUNDLE_ID'],
   [3, 'APP_VERSION'],
   [4, 'OPAQUE_VALUE'],
@@ -55,5 +58,4 @@ export const RECEIPT_FIELDS_MAP: ReadonlyMap<ReceiptFieldsKeyValues, ReceiptFiel
   [1708, 'IN_APP_EXPIRES_DATE'],
   [1711, 'IN_APP_WEB_ORDER_LINE_ITEM_ID'],
   [1712, 'IN_APP_CANCELLATION_DATE'],
-])
-
+])

package/src/parser.ts

@@ -1,17 +1,21 @@
-import { IA5String, Integer, OctetString, Sequence, Set, Utf8String } from 'asn1js'
+import * as ASN1 from 'asn1js'
 
 import { RECEIPT_FIELDS_MAP, ReceiptFieldsKeyNames, ReceiptFieldsKeyValues } from './mappings'
 import { CONTENT_ID, FIELD_TYPE_ID, FIELD_VALUE_ID, IN_APP } from './constants'
 import { verifyFieldSchema, verifyReceiptSchema } from './verifications'
-import { uniqueArrayValues } from './utils'
+
+export type Environment = 'Production' | 'ProductionSandbox' | string
+
+const uniqueArrayValues = (array: string[]) => Array.from(new Set(array))
 
 export type ParsedReceipt = Partial<Record<ReceiptFieldsKeyNames, string>> & {
+  ENVIRONMENT: Environment
   IN_APP_ORIGINAL_TRANSACTION_IDS: string[]
   IN_APP_TRANSACTION_IDS: string[]
 }
 
 function isReceiptFieldKey (value: unknown): value is ReceiptFieldsKeyValues {
-  return Boolean(value && typeof value === 'number' && RECEIPT_FIELDS_MAP.has(value as ReceiptFieldsKeyValues))
+  return Boolean(typeof value === 'number' && RECEIPT_FIELDS_MAP.has(value as ReceiptFieldsKeyValues))
 }
 
 function isParsedReceiptContentComplete (data: ParsedReceipt): data is ParsedReceipt {
@@ -24,10 +28,10 @@ function isParsedReceiptContentComplete (data: ParsedReceipt): data is ParsedRec
   return true
 }
 
-function extractFieldValue (field: OctetString): string {
+function extractFieldValue (field: ASN1.OctetString): string {
   const [fieldValue] = field.valueBlock.value
 
-  if (fieldValue instanceof IA5String || fieldValue instanceof Utf8String) {
+  if (fieldValue instanceof ASN1.IA5String || fieldValue instanceof ASN1.Utf8String) {
     return fieldValue.valueBlock.value
   }
 
@@ -46,7 +50,7 @@ function appendField (parsed: ParsedReceipt, name: ReceiptFieldsKeyNames, value:
   parsed[name] = value
 }
 
-function processField (parsed: ParsedReceipt, fieldKey: number, fieldValue: OctetString) {
+function processField (parsed: ParsedReceipt, fieldKey: number, fieldValue: ASN1.OctetString) {
   if (fieldKey === IN_APP) {
     parseOctetStringContent(parsed, fieldValue)
     return
@@ -60,16 +64,17 @@ function processField (parsed: ParsedReceipt, fieldKey: number, fieldValue: Octe
   appendField(parsed, name, extractFieldValue(fieldValue))
 }
 
-function parseOctetStringContent (parsed: ParsedReceipt, content: OctetString) {
-  const [contentSet] = content.valueBlock.value as Set[]
-  const contentSetSequences = contentSet.valueBlock.value.filter(v => v instanceof Sequence) as Sequence[]
+function parseOctetStringContent (parsed: ParsedReceipt, content: ASN1.OctetString) {
+  const [contentSet] = content.valueBlock.value as ASN1.Set[]
+  const contentSetSequences = contentSet.valueBlock.value
+    .filter(v => v instanceof ASN1.Sequence) as ASN1.Sequence[]
 
   for (const sequence of contentSetSequences) {
     const verifiedSequence = verifyFieldSchema(sequence)
     if (verifiedSequence) {
       // We are confident to use "as" assertion because Integer type is guaranteed by positive verification above
-      const fieldKey = (verifiedSequence.result[FIELD_TYPE_ID] as Integer).valueBlock.valueDec
-      const fieldValueOctetString = verifiedSequence.result[FIELD_VALUE_ID] as OctetString
+      const fieldKey = (verifiedSequence.result[FIELD_TYPE_ID] as ASN1.Integer).valueBlock.valueDec
+      const fieldValueOctetString = verifiedSequence.result[FIELD_VALUE_ID] as ASN1.OctetString
 
       processField(parsed, fieldKey, fieldValueOctetString)
     }
@@ -84,8 +89,9 @@ function postprocessParsedReceipt (parsed: ParsedReceipt) {
 export function parseReceipt (receipt: string): ParsedReceipt {
   const rootSchemaVerification = verifyReceiptSchema(receipt)
 
-  const content = rootSchemaVerification.result[CONTENT_ID] as OctetString
+  const content = rootSchemaVerification.result[CONTENT_ID] as ASN1.OctetString
   const parsed: ParsedReceipt = {
+    ENVIRONMENT: 'Production',
     IN_APP_ORIGINAL_TRANSACTION_IDS: [],
     IN_APP_TRANSACTION_IDS: [],
   }

package/src/utils.ts

@@ -1 +1 @@
-export const uniqueArrayValues = (array: string[]) => Array.from(new Set(array))
+

package/src/verifications.ts

@@ -38,7 +38,7 @@ const fieldSchema = new Sequence({
   value: [
     new Integer({ name: FIELD_TYPE_ID }),
     new Integer(),
-    new OctetString({ name: FIELD_VALUE_ID })
+    new OctetString({ name: FIELD_VALUE_ID }),
   ],
 })