added typescript types

.github/workflows/ci.yml

@@ -26,6 +26,8 @@ jobs:
         run: yarn install
       - name: Lint
         run: yarn lint
+      - name: Types
+        run: yarn types
       - name: Test
         run: yarn test --coverage
       - name: Coveralls

README.md

@@ -14,7 +14,7 @@
 </div>
 
 ## About
-The App Attest service, offers a method for confirming that connections to your server originate from authentic instances of your app. While generating assertions and attestations within your app is relatively straightforward, the process of verifying them on the server side is a bit of a challenge. This library provides two methods for verifying attestations and assertions on the server side for JavaScript based backends.
+The App Attest service, offers a method for confirming that connections to your server originate from authentic instances of your app. While generating assertions and attestations within your app is relatively straightforward, the process of verifying them on the server side is a bit of a challenge. This library provides two methods for verifying attestations and assertions on the server side for JavaScript or TypeScript based backends.
 
 See https://developer.apple.com/documentation/devicecheck/establishing_your_app_s_integrity for details.
 

package.json

@@ -1,12 +1,13 @@
 {
   "name": "node-app-attest",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "A JavaScript implementation of the App Attest protocol, which checks whether clients connecting to your server are valid instances of your app.",
   "repository": "https://github.com/uebelack/node-app-attest",
   "author": "David Übelacker",
   "license": "MIT",
   "type": "module",
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "keywords": [
     "apple",
     "mobile",
@@ -19,14 +20,16 @@
   ],
   "scripts": {
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "types": "tsc",
     "lint": "eslint ."
   },
   "devDependencies": {
     "eslint": "^8.56.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jest": "^27.6.3",
-    "jest": "^29.7.0"
+    "jest": "^29.7.0",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
     "asn1js": "^3.0.5",

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "allowJs": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "types",
+    "declarationMap": true,
+  }
+}

types/index.d.ts

@@ -0,0 +1,4 @@
+import verifyAttestation from './verifyAttestation.js';
+import verifyAssertion from './verifyAssertion.js';
+export { verifyAttestation, verifyAssertion };
+//# sourceMappingURL=index.d.ts.map

types/verifyAssertion.d.ts

@@ -0,0 +1,5 @@
+export default verifyAssertion;
+declare function verifyAssertion(params: any): {
+    signCount: any;
+};
+//# sourceMappingURL=verifyAssertion.d.ts.map

types/verifyAttestation.d.ts

@@ -0,0 +1,7 @@
+export default verifyAttestation;
+declare function verifyAttestation(params: any): {
+    keyId: any;
+    publicKey: any;
+    environment: string;
+};
+//# sourceMappingURL=verifyAttestation.d.ts.map

yarn.lock

@@ -3328,6 +3328,11 @@ typed-array-length@^1.0.4:
     for-each "^0.3.3"
     is-typed-array "^1.1.9"
 
+typescript@^5.3.3:
+  version "5.3.3"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.3.3.tgz#b3ce6ba258e72e6305ba66f5c9b452aaee3ffe37"
+  integrity sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==
+
 unbox-primitive@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/unbox-primitive/-/unbox-primitive-1.0.2.tgz#29032021057d5e6cdbd08c5129c226dff8ed6f9e"