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

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]
@@ -11,8 +10,8 @@
 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.
+> It only extracts some information from Apple's ASN.1 encoded Unified Receipts.
+> It does not work with the old-style transactions 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).**
 
@@ -41,6 +40,7 @@ const data = parseReceipt(receiptString);
 
 console.log(data);
 // {
+//   ENVIRONMENT: 'ProductionSandbox',
 //   APP_VERSION: '1',
 //   ORIGINAL_APP_VERSION: '1.0',
 //   OPAQUE_VALUE: 'c4dd4054b0b61a07beb585f6a842e048',
@@ -89,6 +89,9 @@ Apple Receipt Parser is [MIT licensed](./LICENSE).
 
 This project uses `ASN1.js`, which is 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
 [ico-license]: https://img.shields.io/npm/l/@tamtamchik/app-store-receipt-parser.svg?style=flat-square

package/dist/index.js

@@ -29,6 +29,7 @@ var import_asn1js2 = require("asn1js");
 
 // src/mappings.ts
 var RECEIPT_FIELDS_MAP = /* @__PURE__ */ new Map([
+  [0, "ENVIRONMENT"],
   [2, "BUNDLE_ID"],
   [3, "APP_VERSION"],
   [4, "OPAQUE_VALUE"],
@@ -113,7 +114,7 @@ var uniqueArrayValues = (array) => Array.from(new Set(array));
 
 // src/parser.ts
 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()) {
@@ -170,6 +171,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

@@ -3,6 +3,7 @@ import { IA5String, Sequence as Sequence2, Utf8String } from "asn1js";
 
 // src/mappings.ts
 var RECEIPT_FIELDS_MAP = /* @__PURE__ */ new Map([
+  [0, "ENVIRONMENT"],
   [2, "BUNDLE_ID"],
   [3, "APP_VERSION"],
   [4, "OPAQUE_VALUE"],
@@ -87,7 +88,7 @@ var uniqueArrayValues = (array) => Array.from(new Set(array));
 
 // src/parser.ts
 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()) {
@@ -144,6 +145,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.0",
   "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.7",
+    "@typescript-eslint/eslint-plugin": "7.6.0",
+    "@typescript-eslint/parser": "7.6.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,4 +1,5 @@
 export type ReceiptFieldsKeyValues =
+  | 0
   | 2
   | 3
   | 4
@@ -17,6 +18,7 @@ export type ReceiptFieldsKeyValues =
   | 1712
 
 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'],

package/src/parser.ts

@@ -5,13 +5,16 @@ 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
+
 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 {
@@ -86,6 +89,7 @@ export function parseReceipt (receipt: string): ParsedReceipt {
 
   const content = rootSchemaVerification.result[CONTENT_ID] as OctetString
   const parsed: ParsedReceipt = {
+    ENVIRONMENT: 'Production',
     IN_APP_ORIGINAL_TRANSACTION_IDS: [],
     IN_APP_TRANSACTION_IDS: [],
   }

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 }),
   ],
 })