chore: update typings exports

.changeset/lemon-wasps-tease.md

@@ -0,0 +1,5 @@
+---
+"@hyperse-io/paypal-node-sdk": patch
+---
+
+update typings exports

src/core/PayPalHttpClient.ts

@@ -1,5 +1,5 @@
+import { readFileSync } from 'fs';
 import paypalhttp, { type HttpRequest } from '@paypal/paypalhttp';
-import packageJson from '../../package.json' with { type: 'json' };
 import { AccessToken } from './AccessToken.js';
 import { AccessTokenRequest } from './AccessTokenRequest.js';
 import { type HttpRequestBase } from './HttpRequestBase.js';
@@ -15,8 +15,8 @@ import { TokenCache } from './TokenCache.js';
 
 export class PayPalHttpClient extends paypalhttp.HttpClient {
   private _cache: TokenCache;
-
   public refreshToken?: string;
+  private package: { version: string };
 
   /**
    * @param  environment - The environment for this client
@@ -27,6 +27,7 @@ export class PayPalHttpClient extends paypalhttp.HttpClient {
     this._cache = TokenCache.cacheForEnvironment(environment, refreshToken);
     this.refreshToken = refreshToken;
     this.addInjector(this.authInjector);
+    this.package = JSON.parse(readFileSync('../../package.json', 'utf8'));
     this.addInjector(function (req) {
       req.headers['Accept-Encoding'] = 'gzip';
       req.headers['sdk_name'] = 'Checkout SDK';
@@ -65,7 +66,7 @@ export class PayPalHttpClient extends paypalhttp.HttpClient {
   getUserAgent() {
     return (
       'PayPalSDK/PayPal-node-SDK ' +
-      packageJson.version +
+      this.package.version +
       ' (node ' +
       process.version +
       '-' +

src/index.ts

@@ -3,3 +3,4 @@ export * as orders from './orders/index.js';
 export * as payments from './payments/index.js';
 export * as customers from './customers/index.js';
 export * as webhook from './webhook/index.js';
+export * from './types/index.js';

src/orders/ordersAuthorizeRequest.ts

@@ -3,7 +3,6 @@ import { HttpRequestBase } from '../core/HttpRequestBase.js';
 import {
   type PaymentSource,
   type BaseOrderHeaders,
-  type Order,
 } from '../types/type-order.js';
 
 export type OrdersAuthorizeRequestBody = {
@@ -59,8 +58,3 @@ export class OrdersAuthorizeRequest extends HttpRequestBase<
     return this;
   }
 }
-
-/**
- * The response body contains the authorization details.
- */
-export type OrdersAuthorizeRequestResult = Order;

src/orders/ordersCaptureRequest.ts

@@ -1,7 +1,6 @@
 import querystring from 'querystring';
 import { HttpRequestBase } from '../core/HttpRequestBase.js';
 import {
-  type Order,
   type BaseOrderHeaders,
   type PaymentSource,
 } from '../types/type-order.js';
@@ -60,8 +59,3 @@ export class OrdersCaptureRequest extends HttpRequestBase<
     return this;
   }
 }
-
-/**
- * The response from capturing a payment for an order.
- */
-export type OrdersCaptureRequestResult = Order;

src/orders/ordersCreateRequest.ts

@@ -5,7 +5,6 @@ import {
   type Payer,
   type PurchaseUnitRequest,
   type OrderApplicationContext,
-  type Order,
 } from '../types/type-order.js';
 
 export type OrdersCreateRequestBody = {
@@ -57,8 +56,3 @@ export class OrdersCreateRequest extends HttpRequestBase<
     return this;
   }
 }
-
-/**
- * The response body of the OrdersCreateRequest.
- */
-export type OrdersCreateRequestResult = Order;

src/orders/ordersGetRequest.ts

@@ -1,6 +1,6 @@
 import querystring from 'querystring';
 import { HttpRequestBase } from '../core/HttpRequestBase.js';
-import { type Order, type BaseOrderHeaders } from '../types/type-order.js';
+import { type BaseOrderHeaders } from '../types/type-order.js';
 
 /**
  * Shows details for an order, by ID.
@@ -17,8 +17,3 @@ export class OrdersGetRequest extends HttpRequestBase<BaseOrderHeaders> {
     };
   }
 }
-
-/**
- * The response body of the OrdersGetRequest.
- */
-export type OrdersGetRequestResult = Order;

src/orders/ordersPatchRequest.ts

@@ -1,10 +1,6 @@
 import querystring from 'querystring';
 import { HttpRequestBase } from '../core/HttpRequestBase.js';
-import {
-  type Order,
-  type BaseOrderHeaders,
-  type Patch,
-} from '../types/type-order.js';
+import { type BaseOrderHeaders, type Patch } from '../types/type-order.js';
 
 type OrderPatchRequestBody = Patch[];
 
@@ -32,8 +28,3 @@ export class OrdersPatchRequest extends HttpRequestBase<
     return this;
   }
 }
-
-/**
- * The response body of the OrdersPatchRequest.
- */
-export type OrdersPatchRequestResult = Order;

src/payments/authorizationsCaptureRequest.ts

@@ -4,7 +4,6 @@ import {
   type PaymentInstruction,
   type Money,
   type BasePaymentHeaders,
-  type Capture,
 } from '../types/type-payment.js';
 
 type AuthorizationsCaptureRequestBody = {
@@ -61,8 +60,3 @@ export class AuthorizationsCaptureRequest extends HttpRequestBase<
     return this;
   }
 }
-
-/**
- * The response body of the AuthorizationsCaptureRequest.
- */
-export type AuthorizationsCaptureRequestResult = Capture;

src/payments/authorizationsGetRequest.ts

@@ -1,9 +1,6 @@
 import querystring from 'querystring';
 import { HttpRequestBase } from '../core/HttpRequestBase.js';
-import {
-  type Capture,
-  type BasePaymentHeaders,
-} from '../types/type-payment.js';
+import { type BasePaymentHeaders } from '../types/type-payment.js';
 
 /**
  * Shows details for an authorized payment, by ID.
@@ -23,8 +20,3 @@ export class AuthorizationsGetRequest extends HttpRequestBase<BasePaymentHeaders
     };
   }
 }
-
-/**
- * The response body of the AuthorizationsGetRequest.
- */
-export type AuthorizationsGetRequestResult = Capture;

src/payments/authorizationsReauthorizeRequest.ts

@@ -1,10 +1,6 @@
 import querystring from 'querystring';
 import { HttpRequestBase } from '../core/HttpRequestBase.js';
-import {
-  type Money,
-  type BasePaymentHeaders,
-  type Capture,
-} from '../types/type-payment.js';
+import { type Money, type BasePaymentHeaders } from '../types/type-payment.js';
 
 type AuthorizationsReauthorizeRequestBody = {
   amount: Money;
@@ -56,8 +52,3 @@ export class AuthorizationsReauthorizeRequest extends HttpRequestBase<
     return this;
   }
 }
-
-/**
- * The response for reauthorizing a payment, by ID.
- */
-export type AuthorizationsReauthorizeRequestResult = Capture;

src/payments/authorizationsVoidRequest.ts

@@ -1,9 +1,6 @@
 import querystring from 'querystring';
 import { HttpRequestBase } from '../core/HttpRequestBase.js';
-import {
-  type Capture,
-  type BasePaymentHeaders,
-} from '../types/type-payment.js';
+import { type BasePaymentHeaders } from '../types/type-payment.js';
 
 interface AuthorizationsVoidRequestHeaders extends BasePaymentHeaders {
   'PayPal-Auth-Assertion'?: string;
@@ -27,8 +24,3 @@ export class AuthorizationsVoidRequest extends HttpRequestBase<AuthorizationsVoi
     };
   }
 }
-
-/**
- * The response for voiding an authorized payment, by ID.
- */
-export type AuthorizationsVoidRequestResult = Capture;

src/payments/capturesGetRequest.ts

@@ -1,9 +1,6 @@
 import querystring from 'querystring';
 import { HttpRequestBase } from '../core/HttpRequestBase.js';
-import {
-  type Capture,
-  type BasePaymentHeaders,
-} from '../types/type-payment.js';
+import { type BasePaymentHeaders } from '../types/type-payment.js';
 
 /**
  * Captures Get
@@ -24,8 +21,3 @@ export class CapturesGetRequest extends HttpRequestBase<BasePaymentHeaders> {
     };
   }
 }
-
-/**
- * The response body of the CapturesGetRequest.
- */
-export type CapturesGetRequestResult = Capture;

src/payments/capturesRefundRequest.ts

@@ -1,10 +1,6 @@
 import querystring from 'querystring';
 import { HttpRequestBase } from '../core/HttpRequestBase.js';
-import {
-  type Money,
-  type BasePaymentHeaders,
-  type Capture,
-} from '../types/type-payment.js';
+import { type Money, type BasePaymentHeaders } from '../types/type-payment.js';
 
 type CapturesRefundRequestBody = {
   amount: Money;
@@ -26,7 +22,7 @@ export class CapturesRefundRequest extends HttpRequestBase<
   CapturesRefundRequestHeaders,
   CapturesRefundRequestBody
 > {
-  constructor(captureId) {
+  constructor(captureId: string) {
     super();
     this.path = '/v2/payments/captures/{capture_id}/refund?';
     this.path = this.path.replace(
@@ -63,8 +59,3 @@ export class CapturesRefundRequest extends HttpRequestBase<
     return this;
   }
 }
-
-/**
- * The response body of the CapturesRefundRequest.
- */
-export type CapturesRefundRequestResult = Capture;

src/payments/refundsGetRequest.ts

@@ -1,9 +1,6 @@
 import querystring from 'querystring';
 import { HttpRequestBase } from '../core/HttpRequestBase.js';
-import {
-  type Capture,
-  type BasePaymentHeaders,
-} from '../types/type-payment.js';
+import { type BasePaymentHeaders } from '../types/type-payment.js';
 
 /**
  * Shows details for a refund, by ID.
@@ -20,8 +17,3 @@ export class RefundsGetRequest extends HttpRequestBase<BasePaymentHeaders> {
     };
   }
 }
-
-/**
- * The response body of the RefundsGetRequest.
- */
-export type RefundsGetRequestResult = Capture;

src/types/index.ts

@@ -0,0 +1,4 @@
+export * from './type-customer.js';
+export * from './type-order.js';
+export * from './type-payment.js';
+export * from './type-webhook.js';

src/types/type-order.ts

@@ -401,6 +401,11 @@ export interface PurchaseUnit {
 // https://developer.paypal.com/docs/api/orders/v2/#definition-purchase_unit_request
 export interface PurchaseUnitRequest {
   amount: AmountWithBreakdown;
+  /**
+   * [ 1 .. 127 ] characters
+   * The API caller-provided external ID. Used to reconcile client transactions with PayPal transactions.
+   * Appears in transaction and settlement reports but is not visible to the payer.
+   */
   custom_id?: string;
   description?: string;
   invoice_id?: string;

src/types/type-webhook.ts

@@ -86,3 +86,14 @@ export interface WebhookEvent {
 export interface BaseWebhookHeaders extends BaseHeaders {
   'Content-Type': 'application/json';
 }
+
+/**
+ * The response body of the VerifyWebhookSignature.
+ */
+export type VerifyWebhookSignatureResult = {
+  /**
+   * The status of the signature verification.
+   * Enum: "SUCCESS" "FAILURE"
+   */
+  verification_status: 'SUCCESS' | 'FAILURE';
+};

src/webhook/index.ts

@@ -1 +1,4 @@
-export { VerifyWebhookSignature } from './verifyWebhookSignature.js';
+export {
+  VerifyWebhookSignature,
+  type VerifyWebhookSignatureBody,
+} from './verifyWebhookSignature.js';

src/webhook/verifyWebhookSignature.ts

@@ -1,11 +1,10 @@
-import querystring from 'querystring';
 import { HttpRequestBase } from '../core/HttpRequestBase.js';
 import {
   type WebhookEvent,
   type BaseWebhookHeaders,
 } from '../types/type-webhook.js';
 
-type VerifyWebhookSignatureBody = {
+export type VerifyWebhookSignatureBody = {
   /**
    * The ID of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-ID header of the notification message.
    * '69cd13f0-d67a-11e5-baa3-778b53f4ae55';
@@ -49,13 +48,9 @@ export class VerifyWebhookSignature extends HttpRequestBase<
   BaseWebhookHeaders,
   VerifyWebhookSignatureBody
 > {
-  constructor(authorizationId) {
+  constructor() {
     super();
     this.path = '/v1/notifications/verify-webhook-signature?';
-    this.path = this.path.replace(
-      '{authorization_id}',
-      querystring.escape(authorizationId)
-    );
     this.verb = 'POST';
     this.headers = {
       'Content-Type': 'application/json',
@@ -81,14 +76,3 @@ export class VerifyWebhookSignature extends HttpRequestBase<
     return this;
   }
 }
-
-/**
- * The response body of the VerifyWebhookSignature.
- */
-export type VerifyWebhookSignatureResult = {
-  /**
-   * The status of the signature verification.
-   * Enum: "SUCCESS" "FAILURE"
-   */
-  verification_status: 'SUCCESS' | 'FAILURE';
-};