@paykit-sdk/paypal 1.0.1 → 1.0.3

package/src/schema.ts

@@ -1,230 +0,0 @@
-import {
-  lazy,
-  object,
-  Schema,
-  number,
-  string,
-  stringEnum,
-  boolean,
-} from '@paypal/paypal-server-sdk/dist/types/schema';
-
-export interface ShippingAmount {
-  /**
-   * The currency code.
-   */
-  currency_code: string;
-
-  /**
-   * The value which might be an integer for currencies like JPY that are not typically fractional.
-   */
-  value: string;
-}
-
-export const shippingAmountSchema: Schema<ShippingAmount> = object({
-  currency_code: ['currency_code', string()],
-  value: ['value', string()],
-});
-
-export interface CreateSubscriptionSchema {
-  /**
-   * The ID of the plan, maps to `item_id` in the Paykit SDK.
-   */
-  plan_id: string;
-
-  /**
-   * The quantity of the plan.
-   */
-  quantity: number;
-
-  /**
-   * The custom ID of the subscription.
-   */
-  custom_id: string;
-
-  /**
-   * The start time of the subscription.
-   */
-  start_time: string;
-
-  /**
-   * The subscriber of the subscription.
-   */
-  subscriber: {
-    email_address: string;
-    name: { given_name: string; surname: string };
-    phone: { phone_number: string };
-  };
-}
-
-export const createSubscriptionApticSchema: Schema<CreateSubscriptionSchema> = object({
-  plan_id: ['plan_id', string()],
-  quantity: ['quantity', number()],
-  custom_id: ['custom_id', string()],
-  start_time: ['start_time', string()],
-  subscriber: [
-    'subscriber',
-    lazy(() =>
-      object({
-        email_address: ['email_address', string()],
-        name: [
-          'name',
-          lazy(() =>
-            object({
-              given_name: ['given_name', string()],
-              surname: ['surname', string()],
-            }),
-          ),
-        ],
-        phone: [
-          'phone',
-          lazy(() => object({ phone_number: ['phone_number', string()] })),
-        ],
-      }),
-    ),
-  ],
-});
-
-enum SubscriptionStatus {
-  APPROVAL_PENDING = 'APPROVAL_PENDING',
-  APPROVED = 'APPROVED',
-  ACTIVE = 'ACTIVE',
-  SUSPENDED = 'SUSPENDED',
-  CANCELLED = 'CANCELLED',
-  EXPIRED = 'EXPIRED',
-}
-
-export interface Subscription {
-  /**
-   * The ID of the subscription.
-   */
-  id: string;
-
-  /**
-   * The ID of the plan.
-   */
-  plan_id: string;
-
-  /**
-   * The quantity of the subscription.
-   */
-  quantity: number;
-
-  /**
-   * The status of the subscription.
-   */
-  status: SubscriptionStatus;
-
-  /**
-   * The time the status was updated.
-   */
-  status_update_time: string;
-
-  /**
-   * The note for the status change.
-   */
-  status_change_note: string;
-
-  /**
-   * The time the subscription started.
-   */
-  start_time: string;
-
-  /**
-   * The subscriber of the subscription.
-   */
-  subscriber: {
-    /**
-     * The email address of the subscriber.
-     */
-    email_address: string;
-
-    /**
-     * The name of the subscriber.
-     */
-    name: {
-      /**
-       * The given name of the subscriber.
-       */
-      given_name: string;
-      /**
-       * The surname of the subscriber.
-       */
-      surname: string;
-    };
-
-    /**
-     * The ID of the payer.
-     */
-    payer_id: string;
-  };
-
-  /**
-   * Whether the plan was overridden.
-   */
-  plan_overridden: boolean;
-
-  /**
-   * The custom ID of the subscription.
-   */
-  custom_id: string;
-}
-
-export const subscriptionApticSchema: Schema<Subscription> = object({
-  id: ['id', string()],
-  plan_id: ['plan_id', string()],
-  quantity: ['quantity', number()],
-  custom_id: ['custom_id', string()],
-  plan_overridden: ['plan_overridden', boolean()],
-  start_time: ['start_time', string()],
-  subscriber: [
-    'subscriber',
-    lazy(() =>
-      object({
-        email_address: ['email_address', string()],
-        name: [
-          'name',
-          lazy(() =>
-            object({
-              given_name: ['given_name', string()],
-              surname: ['surname', string()],
-            }),
-          ),
-        ],
-        payer_id: ['payer_id', string()],
-      }),
-    ),
-  ],
-  status: ['status', stringEnum(SubscriptionStatus)],
-  status_change_note: ['status_change_note', string()],
-  status_update_time: ['status_update_time', string()],
-});
-
-interface ResumeSubscriptionSchema {
-  /**
-   * The reason for resuming the subscription.
-   */
-  reason: string;
-}
-
-export const resumeSubscriptionApticSchemaRequest: Schema<ResumeSubscriptionSchema> =
-  object({
-    reason: ['reason', string()],
-  });
-
-// WEBHOOK
-
-export enum VerifyWebhookStatus {
-  SUCCESS = 'SUCCESS',
-  FAILURE = 'FAILURE',
-}
-
-export interface VerifyWebhookSchema {
-  /**
-   * The status of the verification.
-   */
-  verification_status: VerifyWebhookStatus;
-}
-
-export const verifyWebhookSchema: Schema<VerifyWebhookSchema> = object({
-  verification_status: ['verification_status', stringEnum(VerifyWebhookStatus)],
-});

package/src/types.ts

@@ -1,126 +0,0 @@
-export type SubscriptionStatus =
-  | 'APPROVAL_PENDING'
-  | 'APPROVED'
-  | 'ACTIVE'
-  | 'SUSPENDED'
-  | 'CANCELLED'
-  | 'EXPIRED';
-
-export interface PayPalSubscription {
-  /**
-   * The ID of the subscription.
-   */
-  id: string;
-
-  /**
-   * The ID of the plan.
-   */
-  plan_id: string;
-
-  /**
-   * The status of the subscription.
-   */
-  status: SubscriptionStatus;
-
-  /**
-   * The time the status was updated.
-   */
-  status_update_time?: string;
-
-  /**
-   * The time the subscription started.
-   */
-  start_time?: string;
-
-  /**
-   * The time the subscription was created.
-   */
-  create_time?: string;
-
-  /**
-   * The subscriber of the subscription.
-   */
-  subscriber?: {
-    /**
-     * The email of the subscriber.
-     */
-    email_address?: string;
-
-    /**
-     * The name of the subscriber.
-     */
-    name?: {
-      /**
-       * The given name of the subscriber.
-       */
-      given_name?: string;
-      /**
-       * The surname of the subscriber.
-       */
-      surname?: string;
-    };
-  };
-
-  /**
-   * The billing info of the subscription.
-   */
-  billing_info?: {
-    /**
-     * The outstanding balance of the subscription.
-     */
-    outstanding_balance?: {
-      /**
-       * The currency code of the outstanding balance.
-       */
-      currency_code?: string;
-      /**
-       * The value of the outstanding balance.
-       */
-      value?: string;
-    };
-    cycle_executions?: Array<{
-      /**
-       * The tenure type of the cycle execution.
-       */
-      tenure_type?: string;
-
-      /**
-       * The sequence of the cycle execution.
-       */
-      sequence?: number;
-
-      /**
-       * The number of cycles completed.
-       */
-      cycles_completed?: number;
-
-      /**
-       * The total number of cycles.
-       */
-      total_cycles?: number;
-    }>;
-  };
-
-  /**
-   * The links of the subscription.
-   */
-  links?: Array<{
-    /**
-     * The href of the link.
-     */
-    href?: string;
-    /**
-     * The rel of the link.
-     */
-    rel?: string;
-    /**
-     * The method of the link.
-     */
-    method?: string;
-  }>;
-
-  /**
-   * The custom ID of the subscription, i.e metadata
-   */
-  customId?: string;
-}

package/src/utils/mapper.ts

@@ -1,111 +0,0 @@
-import {
-  Checkout,
-  omitInternalMetadata,
-  Payment,
-  Refund,
-  Subscription,
-} from '@paykit-sdk/core';
-import { Order, Refund as PayPalRefund } from '@paypal/paypal-server-sdk';
-import { PayPalSubscription } from '../types';
-
-/**
- * Refund
- */
-export const paykitRefund$InboundSchema = (refund: PayPalRefund): 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)) : {},
-    reason: refund.noteToPayer ?? null,
-  };
-};
-
-/**
- * Checkout
- */
-export const paykitCheckout$InboundSchema = (order: Order): Checkout => {
-  return {
-    id: order.id!,
-    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 ?? '' },
-    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))
-      : {},
-    subscription: null,
-  };
-};
-
-/**
- * Payment
- */
-export const paykitPayment$InboundSchema = (order: Order): Payment => {
-  const statusMap: Record<string, Payment['status']> = {
-    CREATED: 'pending',
-    SAVED: 'pending',
-    APPROVED: 'requires_capture',
-    VOIDED: 'canceled',
-    COMPLETED: 'succeeded',
-    PAYER_ACTION_REQUIRED: 'requires_action',
-  };
-
-  const status = statusMap[order.status ?? statusMap.CREATED];
-
-  return {
-    id: order.id!,
-    status,
-    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 || '',
-  };
-};
-
-/**
- * Subscription
- */
-export const paykitSubscription$InboundSchema = (
-  subscription: PayPalSubscription,
-): Subscription => {
-  const statusMap: Record<string, Subscription['status']> = {
-    APPROVAL_PENDING: 'pending',
-    APPROVED: 'active',
-    ACTIVE: 'active',
-    SUSPENDED: 'past_due',
-    CANCELLED: 'canceled',
-    EXPIRED: 'canceled',
-  };
-
-  const status = statusMap[subscription.status ?? statusMap.APPROVAL_PENDING];
-
-  return {
-    id: subscription.id,
-    customer: { email: subscription.subscriber?.email_address ?? '' },
-    status,
-    item_id: subscription.plan_id,
-    current_period_start: subscription.start_time
-      ? new Date(subscription.start_time)
-      : new Date(),
-    current_period_end: subscription.status_update_time
-      ? new Date(subscription.status_update_time)
-      : new Date(), // todo: Would need to calculate based on billing cycle
-    metadata: subscription.customId
-      ? omitInternalMetadata(JSON.parse(subscription.customId))
-      : {},
-    billing_interval: 'month',
-    amount: 0,
-    currency: 'USD',
-    custom_fields: null,
-  };
-};

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "declaration": true,
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}