appstore-connect-sdk 0.0.3 → 0.0.4

package/README.md

@@ -1,6 +1,8 @@
-# appstoreconnect-api [![@latest](https://img.shields.io/npm/v/appstore-connect-sdk.svg)](https://www.npmjs.com/package/appstore-connect-sdk)
+# Appstore Connect SDK [![@latest](https://img.shields.io/npm/v/appstore-connect-sdk.svg)](https://www.npmjs.com/package/appstore-connect-sdk)
 
-App Store Connect SDK for Nodejs, written in Typescript, supports all APIs based on OpenAPI Generator.
+The App Store Connect SDK for Node.js is written in TypeScript and supports all APIs based on OpenAPI Generator.
+
+English | [简体中文](https://github.com/isaced/appstore-connect-sdk/blob/main/README_zh.md)
 
 ## Kickstart information on the API
 
@@ -10,15 +12,14 @@ App Store Connect SDK for Nodejs, written in Typescript, supports all APIs based
 
 ## Included in this SDK
 
-- [x] Configuration with API Key
-- [x] JWT Logic to sign requests
-- [x] Support custom network libraries for making requests, such as fetch/node-fetch/axios...
-- [x] Supports _all_ requests due to OpenAPI generated requests and entities
+- [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
 
 ## Installation
 
 ```bash
-npm install appstoreconnect-api
+npm install appstore-connect-sdk
 ```
 
 ## Usage
@@ -26,14 +27,14 @@ npm install appstoreconnect-api
 #### 1. Import `appstore-connect-sdk`
 
 ```typescript
-import AppStoreConnectAPI from 'appstore-connect-sdk';
+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`.
 
-After downloading your private key, you can open the `.p8` file containing the private key in a text editor which will show like the following content:
+After downloading your private key, open the `.p8` file containing the private key in a text editor. It should look like this:
 
 ```
 -----BEGIN PRIVATE KEY-----
@@ -54,21 +55,29 @@ const appStoreConnect = new AppStoreConnectAPI({
 });
 ```
 
+For more information on how JWT works with the App Store Connect API, check out Apple's authentication guides:
+
+- [Creating API Keys for App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api)
+- [Generating Tokens for API Requests](https://developer.apple.com/documentation/appstoreconnectapi/generating_tokens_for_api_requests)
+- [Revoking API Keys](https://developer.apple.com/documentation/appstoreconnectapi/revoking_api_keys)
+
 #### 3. Create an API and perform a request
 
-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 missing or any problem, please open an [issue](https://github.com/isaced/appstore-connect-sdk/issues).
+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 api = new AppsApi(appStoreConnect.configuration);
-const res = await api.appsAppEventsGetToManyRelated({ id: APP_ID });
+const res = await client.call(AppsApi).appsGetCollection();
 console.log(res);
 ```
 
-#### The complete code example above
+Here's the complete code example:
 
 ```typescript
-import AppStoreConnectAPI from 'appstore-connect-sdk';
-import { AppsApi, AppEventLocalizationsApi } from 'appstore-connect-sdk/dist/openapi/apis';
+import AppStoreConnectAPI from "appstore-connect-sdk";
+import {
+  AppsApi,
+  AppEventLocalizationsApi,
+} from "appstore-connect-sdk/dist/openapi/apis";
 
 const appStoreConnect = new AppStoreConnectAPI({
   issuerId: "<YOUR ISSUER ID>",
@@ -76,29 +85,29 @@ const appStoreConnect = new AppStoreConnectAPI({
   privateKey: "<YOUR PRIVATE KEY>",
 });
 
-const api = new AppsApi(appStoreConnect.configuration);
-const res = await api.appsAppEventsGetToManyRelated({ id: APP_ID });
+const res = await client.call(AppsApi).appsGetCollection();
 console.log(res);
 ```
 
 ### Custom network libraries
 
-In order to adapt to different projects, it is supported to configure any network library to take over HTTP requests, just follow the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/fetch) standard specification and set `fetchApi` in the `AppStoreConnectAPI` option.
+By default, AppStoreConnectAPI uses its built-in `fetch` function for HTTP requests. Note that this function requires Node.js version **18.0.0** or higher.
+
+However, you can also configure any network library that adheres to the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/fetch) standard specification by setting the `fetchApi` option in the AppStoreConnectAPI constructor.
 
 ```typescript
-import AppStoreConnectAPI from 'appstore-connect-sdk';
-import { FetchAPI } from "./../src/openapi/runtime";
-import fetch from 'node-fetch';
+import AppStoreConnectAPI from "appstore-connect-sdk";
+import fetch from "node-fetch";
 
 new AppStoreConnectAPI({
-    // ...
-    fetchApi: fetch as FetchAPI,  // All network requests are made via node-fetch
+  // ...
+  fetchApi: fetch as unknown as FetchAPI, // All network requests are made via node-fetch
 });
 ```
 
-## Update OpenAPI generated code
+## Updating OpenAPI generated code
 
-Run the following:
+To update the OpenAPI-generated code, run the following command:
 
 ```bash
 $ sh gen-openapi.sh
@@ -108,8 +117,8 @@ This will generate Typescript code through [OpenAPI Generator](https://openapi-g
 
 ## License
 
-**appstore-connect-sdk** is available under the MIT license, and uses source code from open source projects. See the [LICENSE](https://github.com/isaced/appstore-connect-sdk/blob/main/LICENSE) file for more info.
+**appstore-connect-sdk** is available under the MIT license, and uses source code from open source projects. See the [LICENSE](https://github.com/isaced/appstore-connect-sdk/blob/main/LICENSE) file for more information.
 
 ## Author
 
-This project is originally created by [isaced](https://github.com/isaced) but has a lot of [great contributors](https://github.com/isaced/appstore-connect-sdk/graphs/contributors). We're open for contributions of any kind to make this project even better.
+This project was originally created by [isaced](https://github.com/isaced) but has had many [great contributors](https://github.com/isaced/appstore-connect-sdk/graphs/contributors). We're open to contributions of any kind to make this project even better.

package/dist/auth.js

@@ -5,20 +5,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateAuthToken = void 0;
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+// Generates a JWT token for use with the App Store Connect API
 function generateAuthToken({ apiKeyId, issuerId, privateKey, expirationTime }) {
+    // Default expiration time is 10 minutes (600 seconds)
     const EXPIRATION_TIME = expirationTime || 10 * 60;
+    // Generate the token using the provided options
     const token = jsonwebtoken_1.default.sign({}, privateKey, {
         algorithm: "ES256",
         expiresIn: EXPIRATION_TIME,
         issuer: issuerId,
         audience: "appstoreconnect-v1",
         header: {
+            // The algorithm used to sign the token (ECDSA with SHA-256)
             alg: "ES256",
+            // The ID of the private key used to sign the token
             kid: apiKeyId,
+            // The type of the token (JWT)
             typ: "JWT",
         },
     });
-    console.log("Gen JWT Token: ", token);
+    // Log the generated token to the console for debugging purposes
+    console.log("Generated JWT Token: ", token);
+    // Return the generated token
     return token;
 }
 exports.generateAuthToken = generateAuthToken;

package/dist/main.d.ts

@@ -1,14 +1,49 @@
-import { FetchAPI } from "./openapi/runtime";
+import { FetchAPI, BaseAPI } from "./openapi/runtime";
 import { Configuration } from "./openapi";
+/**
+ * Options for configuring the AppStoreConnectAPI instance.
+ */
 interface AppStoreConnectAPIOptions {
+    /**
+     * The issuer ID associated with the private key.
+     */
     issuerId: string;
+    /**
+     * The ID of the private key.
+     */
     privateKeyId: string;
+    /**
+     * The private key in PEM format.
+     */
     privateKey: string;
+    /**
+     * An optional FetchAPI instance to use for making HTTP requests.
+     */
     fetchApi?: FetchAPI;
 }
+/**
+ * The App Store Connect SDK for Node.js is written in TypeScript and supports all APIs
+ * based on OpenAPI Generator.
+ *
+ * https://github.com/isaced/appstore-connect-sdk
+ */
 export default class AppStoreConnectAPI {
     private bearerToken?;
     configuration?: Configuration;
+    /**
+     * Creates an instance of the AppStoreConnectAPI.
+     * @param options - The configuration options for the API.
+     * @param options.issuerId - The issuer ID for generating JWT token.
+     * @param options.privateKeyId - The ID of the private key used for generating JWT token.
+     * @param options.privateKey - The content of the private key used for generating JWT token.
+     * @param options.fetchApi - (Optional) The FetchAPI implementation to use for API requests.
+     */
     constructor(options: AppStoreConnectAPIOptions);
+    /**
+    * 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;
 }
 export {};

package/dist/main.js

@@ -2,13 +2,29 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const openapi_1 = require("./openapi");
 const auth_1 = require("./auth");
+/**
+ * The App Store Connect SDK for Node.js is written in TypeScript and supports all APIs
+ * based on OpenAPI Generator.
+ *
+ * https://github.com/isaced/appstore-connect-sdk
+ */
 class AppStoreConnectAPI {
+    /**
+     * Creates an instance of the AppStoreConnectAPI.
+     * @param options - The configuration options for the API.
+     * @param options.issuerId - The issuer ID for generating JWT token.
+     * @param options.privateKeyId - The ID of the private key used for generating JWT token.
+     * @param options.privateKey - The content of the private key used for generating JWT token.
+     * @param options.fetchApi - (Optional) The FetchAPI implementation to use for API requests.
+     */
     constructor(options) {
+        // Generate an authentication token using the provided options.
         this.bearerToken = (0, auth_1.generateAuthToken)({
             apiKeyId: options.privateKeyId,
             issuerId: options.issuerId,
             privateKey: options.privateKey,
         });
+        // Create a Configuration object with the authentication token and any provided FetchAPI implementation.
         this.configuration = new openapi_1.Configuration({
             headers: {
                 Authorization: `Bearer ${this.bearerToken}`,
@@ -16,5 +32,13 @@ class AppStoreConnectAPI {
             fetchApi: options.fetchApi,
         });
     }
+    /**
+    * 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.configuration);
+    }
 }
 exports.default = AppStoreConnectAPI;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appstore-connect-sdk",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "An App Store Connect API client for Node.js",
   "keywords": [
     "appstore connect",
@@ -20,6 +20,7 @@
     "@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",
     "node-fetch": "^2.0.0",