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

package/README.md

@@ -0,0 +1,72 @@
+# Apple Receipt Parser
+
+[![Buy Me A Coffee][ico-coffee]][link-coffee]
+[![Latest Version on NPM][ico-version]][link-npm]
+[![CircleCI][ico-circleci]][link-circleci]
+[![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.
+
+> **Warning!** This library is not a full-fledged receipt parser. 
+> It only extracts transaction IDs from the Apple's ASN.1 encoded Unified Receipts.
+> It does not work with the old style transactions receipts.
+
+## Installation
+
+Using npm:
+
+```shell
+npm install @tamtamchik/apple-receipt-parser
+```
+
+Using yarn:
+
+```shell
+yarn add @tamtamchik/apple-receipt-parser
+```
+
+## Usage
+
+```typescript
+import { ReceiptParser } from '@tamtamchik/apple-receipt-parser';
+
+// Unified Receipt string 
+const receiptString = "MII...";
+
+// As an instance ...
+const parser = new ReceiptParser(receiptString);
+const ids = parser.getTransactionIds();
+console.log(ids);
+// { 
+//    transactionIds: ['1000000000000000'], 
+//    originalTransactionIds: ['1000000000000000'], 
+// }
+
+// ... or as a static method
+const ids = ReceiptParser.getTransactionIds(receiptString);
+console.log(ids);
+// { 
+//    transactionIds: ['1000000000000000'], 
+//    originalTransactionIds: ['1000000000000000'], 
+// }
+```
+
+## Contributing
+
+Pull requests are always welcome. If you have bigger changes in mind, please open an issue first to discuss your ideas.
+
+## License
+
+Apple Receipt Parser is [MIT licensed](./LICENSE).
+
+[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/apple-receipt-parser.svg?style=flat-square
+[ico-license]: https://img.shields.io/npm/l/@tamtamchik/apple-receipt-parser.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/npm/dt/@tamtamchik/apple-receipt-parser.svg?style=flat-square
+[ico-circleci]: https://img.shields.io/circleci/build/github/tamtamchik/apple-receipt-parser.svg?style=flat-square
+
+[link-coffee]: https://www.buymeacoffee.com/tamtamchik
+[link-npm]: https://www.npmjs.com/package/@tamtamchik/apple-receipt-parser
+[link-downloads]: https://www.npmjs.com/package/@tamtamchik/apple-receipt-parser
+[link-circleci]: https://app.circleci.com/pipelines/github/tamtamchik/apple-receipt-parser?branch=main

package/dist/index.js

@@ -54,6 +54,9 @@ var ReceiptParser = class _ReceiptParser {
   }
   static getTransactionIdsFromReceiptString(receiptString) {
     const { result } = (0, import_asn1js.fromBER)(Buffer.from(receiptString, "base64"));
+    if (result.error) {
+      throw new Error(`Error parsing receipt: ${result.error}`);
+    }
     return this.getTransactionIdsFromBlock(result.toJSON());
   }
   /**

package/dist/index.mjs

@@ -28,6 +28,9 @@ var ReceiptParser = class _ReceiptParser {
   }
   static getTransactionIdsFromReceiptString(receiptString) {
     const { result } = fromBER(Buffer.from(receiptString, "base64"));
+    if (result.error) {
+      throw new Error(`Error parsing receipt: ${result.error}`);
+    }
     return this.getTransactionIdsFromBlock(result.toJSON());
   }
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tamtamchik/app-store-receipt-parser",
-  "version": "1.0.0-pre.0",
+  "version": "1.0.0-pre.2",
   "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,10 +34,13 @@
     "asn1js": "3.0.5"
   },
   "devDependencies": {
+    "@types/jest": "29.5.3",
     "@types/node": "20.5.1",
     "@typescript-eslint/eslint-plugin": "6.4.0",
     "@typescript-eslint/parser": "6.4.0",
     "eslint": "8.47.0",
+    "jest": "29.6.2",
+    "ts-jest": "29.1.1",
     "tsup": "7.2.0",
     "typescript": "5.1.6"
   },
@@ -45,6 +48,8 @@
     "build": "tsup src/index.ts --format cjs,esm --clean",
     "dev": "npm run build -- --watch src",
     "lint": "eslint src --fix",
+    "test": "jest",
+    "coverage": "jest --coverage",
     "prepublishOnly": "npm run build"
   }
 }

package/src/ReceiptParser.ts

@@ -51,6 +51,11 @@ export class ReceiptParser {
 
   static getTransactionIdsFromReceiptString (receiptString: string): TransactionIds | null {
     const { result } = fromBER(Buffer.from(receiptString, 'base64'))
+
+    if (result.error) {
+      throw new Error(`Error parsing receipt: ${result.error}`)
+    }
+
     return this.getTransactionIdsFromBlock(result.toJSON() as Block)
   }
 
@@ -72,10 +77,12 @@ export class ReceiptParser {
     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
   }
 

package/.eslintrc

@@ -1,23 +0,0 @@
-{
-  "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/tsconfig.json

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