@tamtamchik/app-store-receipt-parser 1.0.0-pre.0

package/.eslintrc

@@ -0,0 +1,23 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "extends": "plugin:@typescript-eslint/recommended",
+  "parserOptions": {
+    "ecmaVersion": 2021,
+    "sourceType": "module"
+  },
+  "rules": {
+    "indent": [ "error", 2, { "SwitchCase": 1 } ],
+    "semi": "off",
+    "quotes": "off",
+    "object-curly-spacing": "off",
+    "@typescript-eslint/array-type": [ "error", { "default": "array" } ],
+    "@typescript-eslint/ban-ts-comment": 0,
+    "@typescript-eslint/comma-dangle": [ "error", "always-multiline" ],
+    "@typescript-eslint/quotes": [ "error", "single" ],
+    "@typescript-eslint/semi": [ "error", "never" ],
+    "@typescript-eslint/object-curly-spacing": [ "error", "always" ]
+  },
+  "env": {
+    "node": true
+  }
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Yuri Tkachenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.js

@@ -0,0 +1,103 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  ReceiptParser: () => ReceiptParser
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/ReceiptParser.ts
+var import_asn1js = require("asn1js");
+var ReceiptParser = class _ReceiptParser {
+  constructor(receiptString) {
+    this.receiptString = receiptString;
+  }
+  static getTransactionIdsFromBlock(block) {
+    const { valueBlock } = block;
+    if (!valueBlock || !Array.isArray(valueBlock.value)) {
+      return null;
+    }
+    if (valueBlock.value.length === 3) {
+      const result2 = this.extractTransactionIds(valueBlock.value);
+      if (result2)
+        return result2;
+    }
+    const result = { transactionIds: [], originalTransactionIds: [] };
+    for (const innerBlock of valueBlock.value) {
+      const innerIds = this.getTransactionIdsFromBlock(innerBlock);
+      if (innerIds) {
+        result.transactionIds.push(...innerIds.transactionIds);
+        result.originalTransactionIds.push(...innerIds.originalTransactionIds);
+      }
+    }
+    result.transactionIds = [...new Set(result.transactionIds)];
+    result.originalTransactionIds = [...new Set(result.originalTransactionIds)];
+    return result;
+  }
+  static getTransactionIdsFromReceiptString(receiptString) {
+    const { result } = (0, import_asn1js.fromBER)(Buffer.from(receiptString, "base64"));
+    return this.getTransactionIdsFromBlock(result.toJSON());
+  }
+  /**
+   * The transaction ID is encoded as an INTEGER with the value 0x06a7
+   */
+  static isTransactionIdBlock(block) {
+    return block.blockName === "INTEGER" && block.valueBlock.valueHex === "06a7";
+  }
+  /**
+   * The original transaction ID is encoded as an INTEGER with the value 0x06a9
+   */
+  static isOriginalTransactionIdBlock(block) {
+    return block.blockName === "INTEGER" && block.valueBlock.valueHex === "06a9";
+  }
+  static extractIdFromBlock(block) {
+    if (!Array.isArray(block.valueBlock.value)) {
+      return null;
+    }
+    if (block.blockName === "OCTET STRING" && block.valueBlock.value[0].blockName === "UTF8String") {
+      return block.valueBlock.value[0].valueBlock.value;
+    }
+    return null;
+  }
+  static extractTransactionIds(blocks) {
+    const [firstBlock, , lastBlock] = blocks;
+    const result = { transactionIds: [], originalTransactionIds: [] };
+    if (this.isTransactionIdBlock(firstBlock)) {
+      const id = this.extractIdFromBlock(lastBlock);
+      if (id)
+        result.transactionIds.push(id);
+    } else if (this.isOriginalTransactionIdBlock(firstBlock)) {
+      const id = this.extractIdFromBlock(lastBlock);
+      if (id)
+        result.originalTransactionIds.push(id);
+    } else {
+      return null;
+    }
+    return result;
+  }
+  getTransactionIds() {
+    return _ReceiptParser.getTransactionIdsFromReceiptString(this.receiptString);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ReceiptParser
+});

package/dist/index.mjs

@@ -0,0 +1,76 @@
+// src/ReceiptParser.ts
+import { fromBER } from "asn1js";
+var ReceiptParser = class _ReceiptParser {
+  constructor(receiptString) {
+    this.receiptString = receiptString;
+  }
+  static getTransactionIdsFromBlock(block) {
+    const { valueBlock } = block;
+    if (!valueBlock || !Array.isArray(valueBlock.value)) {
+      return null;
+    }
+    if (valueBlock.value.length === 3) {
+      const result2 = this.extractTransactionIds(valueBlock.value);
+      if (result2)
+        return result2;
+    }
+    const result = { transactionIds: [], originalTransactionIds: [] };
+    for (const innerBlock of valueBlock.value) {
+      const innerIds = this.getTransactionIdsFromBlock(innerBlock);
+      if (innerIds) {
+        result.transactionIds.push(...innerIds.transactionIds);
+        result.originalTransactionIds.push(...innerIds.originalTransactionIds);
+      }
+    }
+    result.transactionIds = [...new Set(result.transactionIds)];
+    result.originalTransactionIds = [...new Set(result.originalTransactionIds)];
+    return result;
+  }
+  static getTransactionIdsFromReceiptString(receiptString) {
+    const { result } = fromBER(Buffer.from(receiptString, "base64"));
+    return this.getTransactionIdsFromBlock(result.toJSON());
+  }
+  /**
+   * The transaction ID is encoded as an INTEGER with the value 0x06a7
+   */
+  static isTransactionIdBlock(block) {
+    return block.blockName === "INTEGER" && block.valueBlock.valueHex === "06a7";
+  }
+  /**
+   * The original transaction ID is encoded as an INTEGER with the value 0x06a9
+   */
+  static isOriginalTransactionIdBlock(block) {
+    return block.blockName === "INTEGER" && block.valueBlock.valueHex === "06a9";
+  }
+  static extractIdFromBlock(block) {
+    if (!Array.isArray(block.valueBlock.value)) {
+      return null;
+    }
+    if (block.blockName === "OCTET STRING" && block.valueBlock.value[0].blockName === "UTF8String") {
+      return block.valueBlock.value[0].valueBlock.value;
+    }
+    return null;
+  }
+  static extractTransactionIds(blocks) {
+    const [firstBlock, , lastBlock] = blocks;
+    const result = { transactionIds: [], originalTransactionIds: [] };
+    if (this.isTransactionIdBlock(firstBlock)) {
+      const id = this.extractIdFromBlock(lastBlock);
+      if (id)
+        result.transactionIds.push(id);
+    } else if (this.isOriginalTransactionIdBlock(firstBlock)) {
+      const id = this.extractIdFromBlock(lastBlock);
+      if (id)
+        result.originalTransactionIds.push(id);
+    } else {
+      return null;
+    }
+    return result;
+  }
+  getTransactionIds() {
+    return _ReceiptParser.getTransactionIdsFromReceiptString(this.receiptString);
+  }
+};
+export {
+  ReceiptParser
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@tamtamchik/app-store-receipt-parser",
+  "version": "1.0.0-pre.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",
+  "types": "./src/index.ts",
+  "author": "Yuri Tkachenko <yuri.tam.tkachenko@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/tamtamchik/app-store-receipt-parser#readme",
+  "bugs": {
+    "url": "https://github.com/tamtamchik/app-store-receipt-parser/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/tamtamchik/app-store-receipt-parser.git"
+  },
+  "keywords": [
+    "apple",
+    "receipt",
+    "parser",
+    "ASN.1",
+    "transaction",
+    "typescript"
+  ],
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./src/index.ts"
+    }
+  },
+  "dependencies": {
+    "asn1js": "3.0.5"
+  },
+  "devDependencies": {
+    "@types/node": "20.5.1",
+    "@typescript-eslint/eslint-plugin": "6.4.0",
+    "@typescript-eslint/parser": "6.4.0",
+    "eslint": "8.47.0",
+    "tsup": "7.2.0",
+    "typescript": "5.1.6"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --clean",
+    "dev": "npm run build -- --watch src",
+    "lint": "eslint src --fix",
+    "prepublishOnly": "npm run build"
+  }
+}

package/src/ReceiptParser.ts

@@ -0,0 +1,102 @@
+import { fromBER } from 'asn1js'
+
+interface Block {
+  blockName: string
+  valueBlock: {
+    valueHex?: string
+    value?: Block[] | string
+  }
+}
+
+export interface TransactionIds {
+  transactionIds: string[]
+  originalTransactionIds: string[]
+}
+
+/**
+ * Parses a receipt string and extracts the transaction IDs from it.
+ * Warning! This class does not validate the receipt string, only extracts them.
+ */
+export class ReceiptParser {
+  constructor (private readonly receiptString: string) {}
+
+  static getTransactionIdsFromBlock (block: Block): TransactionIds | null {
+    const { valueBlock } = block
+
+    if (!valueBlock || !Array.isArray(valueBlock.value)) {
+      return null
+    }
+
+    if (valueBlock.value.length === 3) {
+      const result = this.extractTransactionIds(valueBlock.value)
+      if (result) return result
+    }
+
+    const result: TransactionIds = { transactionIds: [], originalTransactionIds: [] }
+
+    for (const innerBlock of valueBlock.value) {
+      const innerIds = this.getTransactionIdsFromBlock(innerBlock)
+      if (innerIds) {
+        result.transactionIds.push(...innerIds.transactionIds)
+        result.originalTransactionIds.push(...innerIds.originalTransactionIds)
+      }
+    }
+
+    // Deduplicate the IDs
+    result.transactionIds = [...new Set(result.transactionIds)]
+    result.originalTransactionIds = [...new Set(result.originalTransactionIds)]
+
+    return result
+  }
+
+  static getTransactionIdsFromReceiptString (receiptString: string): TransactionIds | null {
+    const { result } = fromBER(Buffer.from(receiptString, 'base64'))
+    return this.getTransactionIdsFromBlock(result.toJSON() as Block)
+  }
+
+  /**
+   * The transaction ID is encoded as an INTEGER with the value 0x06a7
+   */
+  private static isTransactionIdBlock (block: Block): boolean {
+    return block.blockName === 'INTEGER' && block.valueBlock.valueHex === '06a7'
+  }
+
+  /**
+   * The original transaction ID is encoded as an INTEGER with the value 0x06a9
+   */
+  private static isOriginalTransactionIdBlock (block: Block): boolean {
+    return block.blockName === 'INTEGER' && block.valueBlock.valueHex === '06a9'
+  }
+
+  private static extractIdFromBlock (block: Block): string | null {
+    if (!Array.isArray(block.valueBlock.value)) {
+      return null
+    }
+    // The transaction ID is encoded as an OCTET STRING containing a UTF8String
+    if (block.blockName === 'OCTET STRING' && block.valueBlock.value[0].blockName === 'UTF8String') {
+      return block.valueBlock.value[0].valueBlock.value as string
+    }
+    return null
+  }
+
+  private static extractTransactionIds (blocks: Block[]): TransactionIds | null {
+    const [firstBlock, , lastBlock] = blocks
+    const result: TransactionIds = { transactionIds: [], originalTransactionIds: [] }
+
+    if (this.isTransactionIdBlock(firstBlock)) {
+      const id = this.extractIdFromBlock(lastBlock)
+      if (id) result.transactionIds.push(id)
+    } else if (this.isOriginalTransactionIdBlock(firstBlock)) {
+      const id = this.extractIdFromBlock(lastBlock)
+      if (id) result.originalTransactionIds.push(id)
+    } else {
+      return null
+    }
+
+    return result
+  }
+
+  getTransactionIds (): TransactionIds | null {
+    return ReceiptParser.getTransactionIdsFromReceiptString(this.receiptString)
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export { ReceiptParser, TransactionIds } from './ReceiptParser'

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "strict": true,
+    "esModuleInterop": true,
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "moduleResolution": "node"
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}