ups.ts

import { Package } from "../package";
import { getPreferenceValues, Cache } from "@raycast/api";
import fetch from "node-fetch";
import { randomUUID } from "node:crypto";
import { Delivery } from "../delivery";

const cache = new Cache();
const cacheKey = "upsLogin";
const host = "onlinetools.ups.com";
const deliveredStatusCode = "011";

export async function ableToTrackUpsRemotely(): Promise<boolean> {
  const preferences = getPreferenceValues<Preferences.TrackDeliveries>();
  const clientId = preferences.upsClientId;
  const clientSecret = preferences.upsClientSecret;

  return Boolean(clientId && clientSecret);
}

export function urlToUpsTrackingWebpage(delivery: Delivery): string {
  return `https://www.ups.com/track?tracknum=${delivery.trackingNumber}`;
}

export async function updateUpsTracking(delivery: Delivery): Promise<Package[]> {
  const trackingNumber = delivery.trackingNumber;

  console.log(`Updating tracking for ${trackingNumber}`);

  const preferences = getPreferenceValues<Preferences.TrackDeliveries>();
  const clientId = preferences.upsClientId;
  const clientSecret = preferences.upsClientSecret;

  if (!clientId || !clientSecret) {
    console.log(`Unable to update tracking for ${trackingNumber} because clientId or clientSecret is missing`);
    throw new Error("UPS client ID or client secret is missing.  Ensure they are filled in this extension's settings.");
  }

  const loginResponse = await loginWithCachedData(clientId, clientSecret);

  console.log("Calling UPS tracking");
  const upsTrackingInfo = await track(trackingNumber, loginResponse.access_token);

  const packages = convertUpsTrackingToPackages(upsTrackingInfo);

  console.log(`Updated tracking for ${trackingNumber}`);

  return packages;
}

interface LoginResponseBody {
  token_type: string;
  issued_at: string;
  client_id: string;
  access_token: string;
  expires_in: string;
  status: string;
}

async function loginWithCachedData(clientId: string, clientSecret: string): Promise<LoginResponseBody> {
  let loginResponse: LoginResponseBody;

  if (!cache.has(cacheKey)) {
    console.log("Logging into UPS");
    loginResponse = await login(clientId, clientSecret);

    cache.set(cacheKey, JSON.stringify(loginResponse));
  } else {
    loginResponse = JSON.parse(cache.get(cacheKey) ?? "{}");

    if (Number(loginResponse.issued_at) + Number(loginResponse.expires_in) * 1000 < new Date().getTime() + 30 * 1000) {
      // we are less than 30 seconds from the access token expiring
      console.log("Access key expired; logging into UPS");
      loginResponse = await login(clientId, clientSecret);

      cache.set(cacheKey, JSON.stringify(loginResponse));
    }
  }

  return loginResponse;
}

async function login(clientId: string, clientSecret: string): Promise<LoginResponseBody> {
  const response = await fetch(`https://${host}/security/v1/oauth/token`, {
    method: "POST",
    headers: {
      Authorization: "Basic " + Buffer.from(clientId + ":" + clientSecret).toString("base64"),
      "Content-Type": "application/x-www-form-urlencoded",
    },
    body: new URLSearchParams({
      grant_type: "client_credentials",
    }),
  });

  if (!response.ok) {
    console.log("Failed to login to UPS", response.status, response.statusText, await response.text());
    throw new Error(
      `Failed to login to UPS with status ${response.statusText}.  Ensure client ID and client secret are correct.`,
    );
  }

  const loginResponse = (await response.json()) as LoginResponseBody;
  if (!loginResponse) {
    console.log("Failed to parse UPS login response");
    throw new Error("Failed to parse UPS login response.  Please file a bug report.");
  }

  return loginResponse;
}

interface UpsTrackingInfo {
  trackResponse: {
    shipment: {
      inquiryNumber: string;
      package: {
        trackingNumber: string;
        deliveryDate: {
          type: string;
          date: string;
        }[];
        activity: object[];
        currentStatus: {
          description: string;
          code: string;
        };
      }[];
    }[];
  };
}

async function track(trackingNumber: string, accessToken: string): Promise<UpsTrackingInfo> {
  const response = await fetch(
    `https://${host}/api/track/v1/details/${trackingNumber}?locale=en_US&returnSignature=false`,
    {
      method: "GET",
      headers: {
        Authorization: "Bearer " + accessToken,
        "Content-Type": "application/json",
        transactionSrc: "raycast",
        transId: randomUUID().toString(),
      },
    },
  );

  if (!response.ok) {
    console.log("Failed to get UPS tracking", response.status, response.statusText, await response.text());
    throw new Error(`Failed to get UPS tracking with status ${response.statusText}.`);
  }

  const trackingResponse = (await response.json()) as UpsTrackingInfo;
  if (!trackingResponse) {
    console.log("Failed to parse UPS tracking response");
    throw new Error("Failed to parse UPS track response.  Please file a bug report.");
  }

  return trackingResponse;
}

function convertUpsTrackingToPackages(upsTrackingInfo: UpsTrackingInfo): Package[] {
  return upsTrackingInfo.trackResponse.shipment
    .flatMap((shipment) => shipment.package)
    .map((aPackage) => {
      const deliveryDate = aPackage.deliveryDate.find((deliveryDate) => deliveryDate.type === "DEL")?.date;
      const rescheduledDeliveryDate = aPackage.deliveryDate.find((deliveryDate) => deliveryDate.type === "RDD")?.date;
      const scheduledDeliveryDate = aPackage.deliveryDate.find((deliveryDate) => deliveryDate.type === "SDD")?.date;

      return {
        delivered: aPackage.currentStatus.code === deliveredStatusCode,
        deliveryDate: convertUpsDateToDate(deliveryDate || rescheduledDeliveryDate || scheduledDeliveryDate),
        activity: [],
      };
    });
}

function convertUpsDateToDate(upsDate: string | undefined): Date | undefined {
  if (!upsDate) {
    return undefined;
  }

  const year = parseInt(upsDate.substring(0, 4), 10);
  const month = parseInt(upsDate.substring(4, 6), 10) - 1; // Months are 0-indexed in TypeScript
  const day = parseInt(upsDate.substring(6, 8), 10);

  return new Date(year, month, day);
}