appstore-connect-sdk 0.0.9 → 1.0.0-beta.1

package/README.md

@@ -17,8 +17,7 @@ The `appstore-connect-sdk` module includes the following features:
 - [x] Configuration with API Key and JWT Logic to sign requests
 - [x] Support for custom network libraries for making requests, such as fetch/node-fetch/axios...
 - [x] Support for _all_ requests due to OpenAPI generated requests and entities
-- [x] Compatibility with both Node.js and **Deno** environments (_please note that certain features of the appstore-connect-sdk module that rely on the Node crypto module may not work as expected in Deno, as described in the "Deno Compatibility" section above_)
-- [] ESM Support
+- [x] Compatibility with both Node.js and **Deno** environments
 
 ## Examples
 
@@ -41,7 +40,7 @@ import AppStoreConnectAPI from "appstore-connect-sdk";
 
 #### 2. Create your API Configuration
 
-Go to [App Sotre Connect -> Users and Access -> Keys](https://appstoreconnect.apple.com/access/api) and create your own key. This is also the page to find your `private key ID` and the `issuer ID`.
+Go to [App Store Connect -> Users and Access -> Keys](https://appstoreconnect.apple.com/access/api) and create your own key. This is also the page to find your `private key ID` and the `issuer ID`.
 
 After downloading your private key, open the `.p8` file containing the private key in a text editor. It should look like this:
 
@@ -57,7 +56,7 @@ nNdXXbA4
 Now use this `Private Key` together with the `isuer ID` and the `private key ID` to create your configuration:
 
 ```typescript
-const appStoreConnect = new AppStoreConnectAPI({
+const client = new AppStoreConnectAPI({
   issuerId: "<YOUR ISSUER ID>",
   privateKeyId: "<YOUR PRIVATE KEY ID>",
   privateKey: "<YOUR PRIVATE KEY>",
@@ -75,7 +74,8 @@ For more information on how JWT works with the App Store Connect API, check out
 You can find all available APIs in [src/openapi/apis](https://github.com/isaced/appstore-connect-sdk/tree/main/src/openapi/apis), these classes are generated according to [App Store Connect API - OpenAPI specification](https://developer.apple.com/sample-code/app-store-connect/app-store-connect-openapi-specification.zip), If you encounter any problems, please open an [issue](https://github.com/isaced/appstore-connect-sdk/issues).
 
 ```typescript
-const res = await client.call(AppsApi).appsGetCollection();
+const api = await client.create(AppsApi);
+const res = await api.appsGetCollection();
 console.log(res);
 ```
 
@@ -88,13 +88,14 @@ import {
   AppEventLocalizationsApi,
 } from "appstore-connect-sdk/dist/openapi/apis";
 
-const appStoreConnect = new AppStoreConnectAPI({
+const client = new AppStoreConnectAPI({
   issuerId: "<YOUR ISSUER ID>",
   privateKeyId: "<YOUR PRIVATE KEY ID>",
   privateKey: "<YOUR PRIVATE KEY>",
 });
 
-const res = await client.call(AppsApi).appsGetCollection();
+const api = await client.create(AppsApi);
+const res = await api.appsGetCollection();
 console.log(res);
 ```
 
@@ -126,13 +127,7 @@ This will generate Typescript code through [OpenAPI Generator](https://openapi-g
 
 ## Deno Compatibility
 
-The appstore-connect-sdk module is mostly compatible with Deno, but there are some limitations to its usage in a Deno environment. Currently, Deno does not provide full support for the [Node crypto module](https://github.com/denoland/deno_std/issues/3149), which means that certain features of the appstore-connect-sdk module that rely on this module may not work as expected in Deno.
-
-One specific limitation is that the `jsonwebtoken` package, which is used by the appstore-connect-sdk module to generate JSON Web Tokens (JWTs), is not fully compatible with Deno. As a result, it is not possible to use `jsonwebtoken` in a Deno environment to generate JWTs for use with the App Store Connect API.
-
-To work around this limitation, you can manually generate JWTs using a library that is fully compatible with Deno, such as `djwt`. You can then pass the manually generated JWT to the `appstore-connect-sdk` module to authenticate with the App Store Connect API.
-
-An example of using the `appstore-connect-sdk` module in a Deno environment can be found in the [deno_example](https://github.com/isaced/appstore-connect-sdk/tree/deno_example).
+The `appstore-connect-sdk` module is fully compatible with Deno, An example of using the `appstore-connect-sdk` module in a Deno environment can be found in the [deno_example](https://github.com/isaced/appstore-connect-sdk/tree/deno_example).
 
 We are committed to ensuring that the `appstore-connect-sdk` module remains fully compatible with both Node.js and Deno, and we will continue to work on improving its compatibility with Deno as the Deno runtime evolves.
 

package/dist/auth.d.ts

@@ -4,5 +4,5 @@ interface GenerateAuthTokenOptions {
     privateKey: string;
     expirationTime?: number;
 }
-export declare function generateAuthToken({ apiKeyId, issuerId, privateKey, expirationTime }: GenerateAuthTokenOptions): string;
+export declare function generateAuthToken({ apiKeyId, issuerId, privateKey, expirationTime }: GenerateAuthTokenOptions): Promise<string>;
 export {};

package/dist/auth.js

@@ -1,28 +1,59 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateAuthToken = void 0;
-const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const jose = __importStar(require("jose"));
 // Generates a JWT token for use with the App Store Connect API
 function generateAuthToken({ apiKeyId, issuerId, privateKey, expirationTime }) {
-    // Generate the token using the provided options
-    const token = jsonwebtoken_1.default.sign({}, privateKey, {
-        algorithm: "ES256",
-        expiresIn: expirationTime,
-        issuer: issuerId,
-        audience: "appstoreconnect-v1",
-        header: {
+    return __awaiter(this, void 0, void 0, function* () {
+        const alg = "ES256";
+        const key = yield jose.importPKCS8(privateKey, alg);
+        const token = yield new jose.SignJWT({})
+            .setProtectedHeader({
             // The algorithm used to sign the token (ECDSA with SHA-256)
-            alg: "ES256",
+            alg,
             // The ID of the private key used to sign the token
             kid: apiKeyId,
             // The type of the token (JWT)
             typ: "JWT",
-        },
+        })
+            .setIssuer(issuerId)
+            .setAudience("appstoreconnect-v1")
+            .setExpirationTime(expirationTime !== null && expirationTime !== void 0 ? expirationTime : new Date().getTime() / 1000)
+            .sign(key);
+        // Return the generated token
+        return token;
     });
-    // Return the generated token
-    return token;
 }
 exports.generateAuthToken = generateAuthToken;

package/dist/main.d.ts

@@ -54,20 +54,20 @@ export default class AppStoreConnectAPI {
     /**
      * Generates a new bearer token.
      */
-    genToken(): string;
+    genToken(): Promise<string>;
     /**
      * Create a Configuration object with the authentication token and any provided FetchAPI implementation.
      */
-    genConfiguration(): void;
+    genConfiguration(): Promise<void>;
     /**
      * Returns the current bearer token, generating a new one if necessary.
      */
-    getConfiguration(): Configuration | undefined;
+    getConfiguration(): Promise<Configuration | undefined>;
     /**
-    * Calls the specified API class using the current Configuration object.
-    * @param apiClass - The API class to instantiate.
-    * @returns An instance of the specified API class.
-    */
-    call<T extends BaseAPI>(apiClass: new (configuration?: Configuration) => T): T;
+     * Creates an instance of the specified API class.
+     * @param apiClass - The API class to instantiate.
+     * @returns An instance of the specified API class.
+     */
+    create<T extends BaseAPI>(apiClass: new (configuration?: Configuration) => T): Promise<T>;
 }
 export {};

package/dist/main.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const openapi_1 = require("./openapi");
 const auth_1 = require("./auth");
@@ -22,57 +31,66 @@ class AppStoreConnectAPI {
      */
     constructor(options) {
         this.bearerTokenGeneratedAt = 0;
-        options.expirationTime = options.expirationTime || 60 * 10;
+        if (options.expirationTime)
+            options.expirationTime = options.expirationTime;
         this.options = options;
     }
     /**
      * Generates a new bearer token.
      */
     genToken() {
-        if (this.options.bearerToken) {
-            return this.options.bearerToken;
-        }
-        else if (this.options.privateKeyId && this.options.issuerId && this.options.privateKey) {
-            return (0, auth_1.generateAuthToken)({
-                apiKeyId: this.options.privateKeyId,
-                issuerId: this.options.issuerId,
-                privateKey: this.options.privateKey,
-                expirationTime: this.options.expirationTime,
-            });
-        }
-        else {
-            throw 'No bearerToken!!!';
-        }
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.options.bearerToken) {
+                return this.options.bearerToken;
+            }
+            else if (this.options.privateKeyId && this.options.issuerId && this.options.privateKey) {
+                return yield (0, auth_1.generateAuthToken)({
+                    apiKeyId: this.options.privateKeyId,
+                    issuerId: this.options.issuerId,
+                    privateKey: this.options.privateKey,
+                    expirationTime: this.options.expirationTime,
+                });
+            }
+            else {
+                throw "No bearerToken!!!";
+            }
+        });
     }
     /**
      * Create a Configuration object with the authentication token and any provided FetchAPI implementation.
      */
     genConfiguration() {
-        this.configuration = new openapi_1.Configuration({
-            headers: {
-                Authorization: `Bearer ${this.genToken()}`,
-            },
-            fetchApi: this.options.fetchApi,
+        return __awaiter(this, void 0, void 0, function* () {
+            this.configuration = new openapi_1.Configuration({
+                headers: {
+                    Authorization: `Bearer ${yield this.genToken()}`,
+                },
+                fetchApi: this.options.fetchApi,
+            });
+            this.bearerTokenGeneratedAt = Date.now();
         });
-        this.bearerTokenGeneratedAt = Date.now();
     }
     /**
      * Returns the current bearer token, generating a new one if necessary.
      */
     getConfiguration() {
-        const hasExpired = this.bearerTokenGeneratedAt && (Date.now() - this.bearerTokenGeneratedAt) > (1000 * this.options.expirationTime);
-        if (!this.configuration || hasExpired) {
-            this.genConfiguration();
-        }
-        return this.configuration;
+        return __awaiter(this, void 0, void 0, function* () {
+            const hasExpired = this.bearerTokenGeneratedAt && Date.now() - this.bearerTokenGeneratedAt > 1000 * this.options.expirationTime;
+            if (!this.configuration || hasExpired) {
+                yield this.genConfiguration();
+            }
+            return this.configuration;
+        });
     }
     /**
-    * Calls the specified API class using the current Configuration object.
-    * @param apiClass - The API class to instantiate.
-    * @returns An instance of the specified API class.
-    */
-    call(apiClass) {
-        return new apiClass(this.getConfiguration());
+     * Creates an instance of the specified API class.
+     * @param apiClass - The API class to instantiate.
+     * @returns An instance of the specified API class.
+     */
+    create(apiClass) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new apiClass(yield this.getConfiguration());
+        });
     }
 }
 exports.default = AppStoreConnectAPI;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appstore-connect-sdk",
-  "version": "0.0.9",
+  "version": "1.0.0-beta.1",
   "description": "An App Store Connect API client for Node.js",
   "keywords": [
     "appstore connect",
@@ -19,7 +19,6 @@
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.5.2",
     "@types/jest": "^29.4.0",
-    "@types/jsonwebtoken": "^9.0.1",
     "@types/node-fetch": "^2.0.0",
     "dotenv": "^16.0.3",
     "jest": "^29.4.2",
@@ -27,9 +26,6 @@
     "ts-jest": "^29.0.5",
     "typescript": "^4.9.5"
   },
-  "dependencies": {
-    "jsonwebtoken": "^9.0.0"
-  },
   "author": "isaced",
   "license": "MIT",
   "repository": {
@@ -40,5 +36,8 @@
     "url": "https://github.com/isaced/appstore-connect-sdk/issues",
     "email": "isaced@163.com"
   },
-  "homepage": "https://github.com/isaced/appstore-connect-sdk"
+  "homepage": "https://github.com/isaced/appstore-connect-sdk",
+  "dependencies": {
+    "jose": "^4.14.4"
+  }
 }