@paykit-sdk/paypal 1.0.4 → 1.0.6

package/dist/index.mjs

@@ -1,7 +1,7 @@
-import { schema, validateRequiredKeys, AbstractPayKitProvider, ConstraintViolationError, ProviderNotSupportedError, NotImplementedError, ResourceNotFoundError, WebhookError, paykitEvent$InboundSchema, omitInternalMetadata } from '@paykit-sdk/core';
-import { Environment, Client, LogLevel, OrdersController, PaymentsController, OrderApplicationContextUserAction, CheckoutPaymentIntent, CustomError } from '@paypal/paypal-server-sdk';
-import { BaseController } from '@paypal/paypal-server-sdk/dist/types/controllers/baseController';
-import { object, string, lazy, number, stringEnum, boolean } from '@paypal/paypal-server-sdk/dist/types/schema';
+import { schema, validateRequiredKeys, AbstractPayKitProvider, createCheckoutSchema, ValidationError, ConstraintViolationError, OperationFailedError, ResourceNotFoundError, ProviderNotSupportedError, NotImplementedError, WebhookError, paykitEvent$InboundSchema, omitInternalMetadata } from '@paykit-sdk/core';
+import { Environment, Client, LogLevel, OrdersController, PaymentsController, OrderApplicationContextUserAction, CheckoutPaymentIntent, CustomError, OrderStatus } from '@paypal/paypal-server-sdk';
+import { BaseController } from '@paypal/paypal-server-sdk/dist/cjs/controllers/baseController';
+import { object, string, lazy, number, stringEnum, boolean } from '@paypal/paypal-server-sdk/dist/cjs/schema';
 
 var __defProp = Object.defineProperty;
 var __export = (target, all) => {
@@ -4038,14 +4038,14 @@ var ostring = () => stringType().optional();
 var onumber = () => numberType().optional();
 var oboolean = () => booleanType().optional();
 var coerce = {
-  string: (arg) => ZodString.create({ ...arg, coerce: true }),
-  number: (arg) => ZodNumber.create({ ...arg, coerce: true }),
-  boolean: (arg) => ZodBoolean.create({
+  string: ((arg) => ZodString.create({ ...arg, coerce: true })),
+  number: ((arg) => ZodNumber.create({ ...arg, coerce: true })),
+  boolean: ((arg) => ZodBoolean.create({
     ...arg,
     coerce: true
-  }),
-  bigint: (arg) => ZodBigInt.create({ ...arg, coerce: true }),
-  date: (arg) => ZodDate.create({ ...arg, coerce: true })
+  })),
+  bigint: ((arg) => ZodBigInt.create({ ...arg, coerce: true })),
+  date: ((arg) => ZodDate.create({ ...arg, coerce: true }))
 };
 var NEVER = INVALID;
 object({
@@ -4249,12 +4249,18 @@ var WebhookController = class extends BaseController {
     return req.callAsJson(verifyWebhookSchema);
   }
 };
+var paykitPayee$InboundSchema = (payee) => {
+  let customer = { email: "" };
+  if (typeof payee === "string") customer = payee;
+  else if (payee?.emailAddress) customer = { email: payee?.emailAddress };
+  return customer;
+};
 var paykitRefund$InboundSchema = (refund) => {
   return {
     id: refund.id,
     amount: refund.amount?.value ? parseFloat(refund.amount.value) : 0,
     currency: refund.amount?.currencyCode || "USD",
-    metadata: refund.customId ? omitInternalMetadata(JSON.parse(refund.customId)) : {},
+    metadata: omitInternalMetadata(JSON.parse(refund.customId ?? "{}")),
     reason: refund.noteToPayer ?? null
   };
 };
@@ -4264,10 +4270,12 @@ var paykitCheckout$InboundSchema = (order) => {
     payment_url: order.links?.find((l) => l.rel === "approve")?.href || "",
     amount: parseFloat(order.purchaseUnits?.[0]?.amount?.value || "0"),
     currency: order.purchaseUnits?.[0]?.amount?.currencyCode || "USD",
-    customer: order.payer?.payerId ? order.payer?.payerId : { email: order.payer?.emailAddress ?? "" },
+    customer: paykitPayee$InboundSchema(order.payer ?? {}),
     session_type: "one_time",
     products: [{ id: order.purchaseUnits?.[0]?.items?.[0]?.sku || "", quantity: 1 }],
-    metadata: order.purchaseUnits?.[0]?.customId ? omitInternalMetadata(JSON.parse(order.purchaseUnits?.[0]?.customId)) : {},
+    metadata: omitInternalMetadata(
+      JSON.parse(order.purchaseUnits?.[0]?.customId ?? "{}")
+    ),
     subscription: null
   };
 };
@@ -4281,14 +4289,193 @@ var paykitPayment$InboundSchema = (order) => {
     PAYER_ACTION_REQUIRED: "requires_action"
   };
   const status = statusMap[order.status ?? statusMap.CREATED];
+  const approveLink = order.links?.find((l) => l.rel === "approve")?.href ?? "";
+  const requiresAction = [
+    OrderStatus.PayerActionRequired,
+    OrderStatus.Created,
+    OrderStatus.Saved
+  ].includes(order.status);
   return {
     id: order.id,
     status,
+    customer: paykitPayee$InboundSchema(order.payer ?? {}),
     amount: parseFloat(order.purchaseUnits?.[0]?.amount?.value || "0"),
     currency: order.purchaseUnits?.[0]?.amount?.currencyCode || "USD",
-    metadata: order.purchaseUnits?.[0]?.customId ? omitInternalMetadata(JSON.parse(order.purchaseUnits?.[0]?.customId)) : {},
-    customer: order.payer?.payerId ? order.payer?.payerId : { email: order.payer?.emailAddress ?? "" },
-    item_id: order.purchaseUnits?.[0]?.items?.[0]?.sku || ""
+    metadata: omitInternalMetadata(
+      JSON.parse(order.purchaseUnits?.[0]?.customId ?? "{}")
+    ),
+    item_id: order.purchaseUnits?.[0]?.items?.[0]?.sku || "",
+    requires_action: requiresAction,
+    payment_url: approveLink
+  };
+};
+var paykitPaymentWebhook$InboundSchema = (resource) => {
+  const statusMap = {
+    CREATED: "pending",
+    SAVED: "pending",
+    APPROVED: "requires_capture",
+    VOIDED: "canceled",
+    COMPLETED: "succeeded",
+    PAYER_ACTION_REQUIRED: "requires_action"
+  };
+  const status = statusMap[resource.status ?? "CREATED"] ?? "pending";
+  const payer = resource.payer;
+  let customer = { email: "" };
+  if (payer?.payer_id) {
+    customer = payer.payer_id;
+  } else if (payer?.email_address) {
+    customer = { email: payer.email_address };
+  }
+  const purchaseUnits = resource.purchase_units ?? [];
+  const firstUnit = purchaseUnits[0] ?? {};
+  const amount = firstUnit.amount;
+  const items = firstUnit.items ?? [];
+  const metadata = (() => {
+    try {
+      const customId = firstUnit?.custom_id;
+      return customId ? JSON.parse(customId) : {};
+    } catch {
+      return {};
+    }
+  })();
+  const itemId = items[0]?.sku ?? firstUnit.reference_id ?? "";
+  return {
+    id: resource.id,
+    status,
+    customer,
+    amount: parseFloat(amount?.value ?? "0"),
+    currency: amount?.currency_code ?? "USD",
+    metadata: omitInternalMetadata(metadata),
+    item_id: itemId,
+    requires_action: false,
+    payment_url: null
+  };
+};
+var paykitPaymentCaptureWebhook$InboundSchema = (capture) => {
+  const statusMap = {
+    COMPLETED: "succeeded",
+    PENDING: "pending",
+    REFUNDED: "succeeded",
+    // Refunded but was successful
+    PARTIALLY_REFUNDED: "succeeded"
+  };
+  const status = statusMap[capture.status ?? "PENDING"] ?? "pending";
+  const supplementaryData = capture.supplementary_data;
+  const relatedIds = supplementaryData?.related_ids;
+  const orderId = relatedIds?.order_id ?? capture.id;
+  const metadata = (() => {
+    try {
+      const customId = capture.custom_id;
+      return customId ? JSON.parse(customId) : {};
+    } catch {
+      return {};
+    }
+  })();
+  const amount = capture.amount;
+  return {
+    id: orderId,
+    status,
+    customer: { email: "" },
+    // Not available in capture event
+    amount: parseFloat(amount?.value ?? "0"),
+    currency: amount?.currency_code ?? "USD",
+    metadata: omitInternalMetadata(metadata),
+    item_id: "",
+    // Not available in capture event
+    requires_action: false,
+    payment_url: null
+  };
+};
+var paykitRefundWebhook$InboundSchema = (refund) => {
+  const amount = refund.amount;
+  const refundAmount = amount?.total ? Math.abs(parseFloat(amount.total)) : 0;
+  return {
+    id: refund.id,
+    amount: refundAmount,
+    currency: amount?.currency ?? "USD",
+    metadata: omitInternalMetadata({}),
+    // No metadata in webhook refund
+    reason: null
+    // No reason in webhook refund
+  };
+};
+var paykitSubscriptionWebhook$InboundSchema = (agreement) => {
+  const state = agreement.state ?? "Pending";
+  const statusMap = {
+    Pending: "pending",
+    Active: "active",
+    Suspended: "past_due",
+    Cancelled: "canceled",
+    Expired: "canceled",
+    Completed: "active"
+  };
+  const status = statusMap[state] ?? "pending";
+  const plan = agreement.plan;
+  const paymentDefinitions = plan?.payment_definitions ?? [];
+  const regularDefinition = paymentDefinitions.find((def) => def.type === "REGULAR") ?? paymentDefinitions[0];
+  const frequency = regularDefinition?.frequency ?? "Month";
+  const billingIntervalMap = {
+    Day: "day",
+    Days: "day",
+    Week: "week",
+    Weeks: "week",
+    Month: "month",
+    Months: "month",
+    Year: "year",
+    Years: "year"
+  };
+  const billingInterval = billingIntervalMap[frequency] ?? "month";
+  const startDate = agreement.start_date ?? (/* @__PURE__ */ new Date()).toISOString();
+  const periodStart = new Date(startDate);
+  const periodEnd = (() => {
+    const end = new Date(periodStart);
+    switch (billingInterval) {
+      case "day":
+        end.setDate(end.getDate() + 1);
+        break;
+      case "week":
+        end.setDate(end.getDate() + 7);
+        break;
+      case "month":
+        end.setMonth(end.getMonth() + 1);
+        break;
+      case "year":
+        end.setFullYear(end.getFullYear() + 1);
+        break;
+      default:
+        end.setMonth(end.getMonth() + 1);
+    }
+    return end;
+  })();
+  const payer = agreement.payer;
+  const payerInfo = payer?.payer_info;
+  const email = payerInfo?.email ?? "";
+  const planId = plan?.id ?? agreement.id;
+  const amount = regularDefinition?.amount;
+  const subscriptionAmount = amount?.value ? parseFloat(amount.value) : 0;
+  const currency = plan?.curr_code ?? "USD";
+  const metadata = (() => {
+    try {
+      const description = agreement.description;
+      return description ? JSON.parse(description) : {};
+    } catch {
+      return {};
+    }
+  })();
+  return {
+    id: agreement.id,
+    customer: { email },
+    status,
+    item_id: planId,
+    current_period_start: periodStart,
+    current_period_end: periodEnd,
+    metadata: omitInternalMetadata(metadata),
+    billing_interval: billingInterval,
+    amount: subscriptionAmount,
+    currency,
+    custom_fields: null,
+    requires_action: false,
+    payment_url: null
   };
 };
 
@@ -4337,7 +4524,10 @@ var PayPalProvider = class extends AbstractPayKitProvider {
    * In PayPal, Order IS the checkout
    */
   createCheckout = async (params) => {
-    const stringifiedMetadata = JSON.stringify(params.metadata);
+    const { error, data } = createCheckoutSchema.safeParse(params);
+    if (error)
+      throw ValidationError.fromZodError(error, this.providerName, "createCheckout");
+    const stringifiedMetadata = JSON.stringify(data.metadata);
     if (stringifiedMetadata.length > PAYPAL_METADATA_MAX_LENGTH) {
       throw new ConstraintViolationError("Metadata exceeds maximum length", {
         value: stringifiedMetadata.length,
@@ -4351,57 +4541,81 @@ var PayPalProvider = class extends AbstractPayKitProvider {
       itemName = "Untitled Item"
     } = validateRequiredKeys(
       ["currency", "amount", "itemName"],
-      params.provider_metadata,
-      "Missing required parameters: {keys}"
+      data.provider_metadata,
+      "Missing required parameters in provider_metadata: {keys}"
     );
+    const totalAmount = parseFloat(amount);
+    const quantity = data.quantity || 1;
+    const unitAmount = (totalAmount / quantity).toFixed(2);
     const orderOptionsBody = {
       intent: CheckoutPaymentIntent.Capture,
       payer: {
-        ...typeof params.customer === "string" && { payerId: params.customer },
-        ...typeof params.customer === "object" && "email" in params.customer && { emailAddress: params.customer.email }
+        ...typeof data.customer === "string" && { payerId: data.customer },
+        ...typeof data.customer === "object" && "email" in data.customer && { emailAddress: data.customer.email }
       },
       purchaseUnits: [
         {
-          amount: { currencyCode: currency, value: amount },
+          amount: {
+            currencyCode: currency,
+            value: amount,
+            breakdown: { itemTotal: { currencyCode: currency, value: amount } }
+          },
           customId: stringifiedMetadata,
           items: [
             {
-              sku: params.item_id,
-              quantity: params.quantity.toString(),
+              sku: data.item_id,
+              quantity: quantity.toString(),
               name: itemName,
-              unitAmount: { currencyCode: currency, value: amount }
+              unitAmount: { currencyCode: currency, value: unitAmount }
             }
           ]
         }
       ],
-      applicationContext: { userAction: OrderApplicationContextUserAction.PayNow },
-      ...params.provider_metadata && { ...params.provider_metadata }
+      applicationContext: {
+        userAction: OrderApplicationContextUserAction.PayNow,
+        returnUrl: data.success_url,
+        cancelUrl: data.cancel_url
+      },
+      ...data.provider_metadata && { ...data.provider_metadata }
     };
-    if (params.billing) {
+    if (data.billing) {
       orderOptionsBody.purchaseUnits[0].shipping = {
-        name: { fullName: params.billing.address.name },
+        name: { fullName: data.billing.address.name },
         address: {
-          addressLine1: params.billing.address.line1,
-          addressLine2: params.billing.address.line2,
-          adminArea1: params.billing.address.city,
-          adminArea2: params.billing.address.state,
-          postalCode: params.billing.address.postal_code,
-          countryCode: params.billing.address.country
+          addressLine1: data.billing.address.line1,
+          addressLine2: data.billing.address.line2,
+          adminArea1: data.billing.address.city,
+          adminArea2: data.billing.address.state,
+          postalCode: data.billing.address.postal_code,
+          countryCode: data.billing.address.country
         },
-        ...params.billing.address.phone && {
+        ...data.billing.address.phone && {
           phoneNumber: {
-            nationalNumber: params.billing.address.phone,
-            countryCode: params.billing.address.country
+            nationalNumber: data.billing.address.phone,
+            countryCode: data.billing.address.country
           }
         }
       };
     }
-    const order = await this.ordersController.createOrder({ body: orderOptionsBody });
-    return paykitCheckout$InboundSchema(order.result);
+    try {
+      const order = await this.ordersController.createOrder({ body: orderOptionsBody });
+      return paykitCheckout$InboundSchema(order.result);
+    } catch (error2) {
+      throw new OperationFailedError("createCheckout", this.providerName, {
+        cause: error2 instanceof Error ? error2 : new Error("Unknown error")
+      });
+    }
   };
   retrieveCheckout = async (id) => {
-    const order = await this.ordersController.getOrder({ id });
-    return paykitCheckout$InboundSchema(order.result);
+    try {
+      const order = await this.ordersController.getOrder({ id });
+      if (!order.result) throw new ResourceNotFoundError("Order", id);
+      return paykitCheckout$InboundSchema(order.result);
+    } catch (error) {
+      throw new OperationFailedError("retrieveCheckout", this.providerName, {
+        cause: error instanceof Error ? error : new Error("Unknown error")
+      });
+    }
   };
   updateCheckout = async (id, params) => {
     throw new ProviderNotSupportedError("updateCheckout", this.providerName, {
@@ -4522,8 +4736,14 @@ var PayPalProvider = class extends AbstractPayKitProvider {
         }
       };
     }
-    const order = await this.ordersController.createOrder({ body: orderOptionsBody });
-    return paykitPayment$InboundSchema(order.result);
+    try {
+      const order = await this.ordersController.createOrder({ body: orderOptionsBody });
+      return paykitPayment$InboundSchema(order.result);
+    } catch (error) {
+      throw new OperationFailedError("createPayment", this.providerName, {
+        cause: error instanceof Error ? error : new Error("Unknown error")
+      });
+    }
   };
   updatePayment = async (id, params) => {
     throw new ProviderNotSupportedError("updatePayment", this.providerName, {
@@ -4531,8 +4751,15 @@ var PayPalProvider = class extends AbstractPayKitProvider {
     });
   };
   retrievePayment = async (id) => {
-    const order = await this.ordersController.getOrder({ id });
-    return paykitPayment$InboundSchema(order.result);
+    try {
+      const order = await this.ordersController.getOrder({ id });
+      if (!order.result) throw new ResourceNotFoundError("Order", id);
+      return paykitPayment$InboundSchema(order.result);
+    } catch (error) {
+      throw new OperationFailedError("retrievePayment", this.providerName, {
+        cause: error instanceof Error ? error : new Error("Unknown error")
+      });
+    }
   };
   deletePayment = async (id) => {
     throw new ProviderNotSupportedError("deletePayment", this.providerName, {
@@ -4540,8 +4767,15 @@ var PayPalProvider = class extends AbstractPayKitProvider {
     });
   };
   capturePayment = async (id) => {
-    const captured = await this.ordersController.captureOrder({ id });
-    return paykitPayment$InboundSchema(captured.result);
+    try {
+      const captured = await this.ordersController.captureOrder({ id });
+      if (!captured.result) throw new ResourceNotFoundError("Order", id);
+      return paykitPayment$InboundSchema(captured.result);
+    } catch (error) {
+      throw new OperationFailedError("capturePayment", this.providerName, {
+        cause: error instanceof Error ? error : new Error("Unknown error")
+      });
+    }
   };
   cancelPayment = async (id) => {
     throw new ProviderNotSupportedError("cancelPayment", this.providerName, {
@@ -4552,18 +4786,26 @@ var PayPalProvider = class extends AbstractPayKitProvider {
    * Refund management
    */
   createRefund = async (params) => {
-    const order = await this.ordersController.getOrder({ id: params.payment_id });
-    const captureIds = order.result.purchaseUnits?.[0]?.payments?.captures?.map((c) => c.id) || [];
-    if (captureIds.length === 0) {
-      throw new ResourceNotFoundError("Capture", params.payment_id, this.providerName);
-    }
-    const currencyCode = order.result.purchaseUnits?.[0]?.amount?.currencyCode || "USD";
-    const amount = params.amount ? params.amount.toString() : order.result.purchaseUnits?.[0]?.amount?.value || "0";
-    const refund = await this.paymentsController.refundCapturedPayment({
-      captureId: captureIds[0],
-      body: { amount: { currencyCode, value: amount } }
-    });
-    return paykitRefund$InboundSchema(refund.result);
+    try {
+      const order = await this.ordersController.getOrder({ id: params.payment_id });
+      if (!order.result) throw new ResourceNotFoundError("Order", params.payment_id);
+      const captureIds = order.result.purchaseUnits?.[0]?.payments?.captures?.map((c) => c.id) || [];
+      if (captureIds.length === 0) {
+        throw new ResourceNotFoundError("Capture", params.payment_id, this.providerName);
+      }
+      const currencyCode = order.result.purchaseUnits?.[0]?.amount?.currencyCode || "USD";
+      const amount = params.amount ? params.amount.toString() : order.result.purchaseUnits?.[0]?.amount?.value || "0";
+      const refund = await this.paymentsController.refundCapturedPayment({
+        captureId: captureIds[0],
+        body: { amount: { currencyCode, value: amount } }
+      });
+      if (!refund.result) throw new ResourceNotFoundError("Refund", params.payment_id);
+      return paykitRefund$InboundSchema(refund.result);
+    } catch (error) {
+      throw new OperationFailedError("createRefund", this.providerName, {
+        cause: error instanceof Error ? error : new Error("Unknown error")
+      });
+    }
   };
   /**
    * Webhook management
@@ -4588,8 +4830,9 @@ var PayPalProvider = class extends AbstractPayKitProvider {
     const eventType = event.event_type;
     const webhookHandlers = {
       "CHECKOUT.ORDER.APPROVED": async () => {
-        const orderData = event.resource;
-        const payment = paykitPayment$InboundSchema(orderData);
+        const payment = paykitPaymentWebhook$InboundSchema(
+          event.resource
+        );
         return [
           paykitEvent$InboundSchema({
             type: "payment.created",
@@ -4600,8 +4843,9 @@ var PayPalProvider = class extends AbstractPayKitProvider {
         ];
       },
       "CHECKOUT.ORDER.COMPLETED": async () => {
-        const orderData = event.resource;
-        const payment = paykitPayment$InboundSchema(orderData);
+        const payment = paykitPaymentWebhook$InboundSchema(
+          event.resource
+        );
         return [
           paykitEvent$InboundSchema({
             type: "payment.updated",
@@ -4612,8 +4856,9 @@ var PayPalProvider = class extends AbstractPayKitProvider {
         ];
       },
       "PAYMENT.CAPTURE.COMPLETED": async () => {
-        const orderData = event.resource;
-        const payment = paykitPayment$InboundSchema(orderData);
+        const payment = paykitPaymentCaptureWebhook$InboundSchema(
+          event.resource
+        );
         return [
           paykitEvent$InboundSchema({
             type: "payment.updated",
@@ -4624,8 +4869,9 @@ var PayPalProvider = class extends AbstractPayKitProvider {
         ];
       },
       "PAYMENT.CAPTURE.REFUNDED": async () => {
-        const refundData = event.resource;
-        const refund = paykitRefund$InboundSchema(refundData);
+        const refund = paykitRefundWebhook$InboundSchema(
+          event.resource
+        );
         return [
           paykitEvent$InboundSchema({
             type: "refund.created",
@@ -4634,6 +4880,71 @@ var PayPalProvider = class extends AbstractPayKitProvider {
             data: refund
           })
         ];
+      },
+      "BILLING.SUBSCRIPTION.CREATED": async () => {
+        const subscription = paykitSubscriptionWebhook$InboundSchema(
+          event.resource
+        );
+        return [
+          paykitEvent$InboundSchema({
+            type: "subscription.created",
+            created: Date.now() / 1e3,
+            id: event.id,
+            data: subscription
+          })
+        ];
+      },
+      "BILLING.SUBSCRIPTION.UPDATED": async () => {
+        const subscription = paykitSubscriptionWebhook$InboundSchema(
+          event.resource
+        );
+        return [
+          paykitEvent$InboundSchema({
+            type: "subscription.updated",
+            created: Date.now() / 1e3,
+            id: event.id,
+            data: subscription
+          })
+        ];
+      },
+      "BILLING.SUBSCRIPTION.SUSPENDED": async () => {
+        const subscription = paykitSubscriptionWebhook$InboundSchema(
+          event.resource
+        );
+        return [
+          paykitEvent$InboundSchema({
+            type: "subscription.updated",
+            created: Date.now() / 1e3,
+            id: event.id,
+            data: subscription
+          })
+        ];
+      },
+      "BILLING.SUBSCRIPTION.CANCELLED": async () => {
+        const subscription = paykitSubscriptionWebhook$InboundSchema(
+          event.resource
+        );
+        return [
+          paykitEvent$InboundSchema({
+            type: "subscription.canceled",
+            created: Date.now() / 1e3,
+            id: event.id,
+            data: subscription
+          })
+        ];
+      },
+      "BILLING.SUBSCRIPTION.EXPIRED": async () => {
+        const subscription = paykitSubscriptionWebhook$InboundSchema(
+          event.resource
+        );
+        return [
+          paykitEvent$InboundSchema({
+            type: "subscription.canceled",
+            created: Date.now() / 1e3,
+            id: event.id,
+            data: subscription
+          })
+        ];
       }
     };
     const handler = webhookHandlers[eventType];