sitegen/framework/meta/nextjs/resolvers/resolve-basics.ts

import type {
  AlternateLinkDescriptor,
  ResolvedAlternateURLs,
} from "../types/alternative-urls-types";
import type { Metadata, ResolvedMetadata } from "../types/metadata-interface";
import type { ResolvedVerification } from "../types/metadata-types";
import type {
  FieldResolver,
  FieldResolverWithMetadataBase,
} from "../types/resolvers";
import type { Viewport } from "../types/extra-types";
import path from "path";
import { resolveAsArrayOrUndefined } from "../generate/utils";
import { resolveUrl } from "./resolve-url";
import { ViewPortKeys } from "../constants";

// Resolve with `metadataBase` if it's present, otherwise resolve with `pathname`.
// Resolve with `pathname` if `url` is a relative path.
function resolveAlternateUrl(
  url: string | URL,
  metadataBase: URL | null,
  pathname: string,
) {
  if (typeof url === "string" && url.startsWith("./")) {
    url = path.resolve(pathname, url);
  } else if (url instanceof URL) {
    url = new URL(pathname, url);
  }

  const result = metadataBase ? resolveUrl(url, metadataBase) : url;
  return result.toString();
}

export const resolveThemeColor: FieldResolver<"themeColor"> = (themeColor) => {
  if (!themeColor) return null;
  const themeColorDescriptors: ResolvedMetadata["themeColor"] = [];

  resolveAsArrayOrUndefined(themeColor)?.forEach((descriptor) => {
    if (typeof descriptor === "string") {
      themeColorDescriptors.push({ color: descriptor });
    } else if (typeof descriptor === "object") {
      themeColorDescriptors.push({
        color: descriptor.color,
        media: descriptor.media,
      });
    }
  });

  return themeColorDescriptors;
};

export const resolveViewport: FieldResolver<"viewport"> = (viewport) => {
  let resolved: ResolvedMetadata["viewport"] = null;

  if (typeof viewport === "string") {
    resolved = viewport;
  } else if (viewport) {
    resolved = "";
    for (const viewportKey_ in ViewPortKeys) {
      const viewportKey = viewportKey_ as keyof Viewport;
      if (viewportKey in viewport) {
        let value = viewport[viewportKey];
        if (typeof value === "boolean") value = value ? "yes" : "no";
        if (resolved) resolved += ", ";
        resolved += `${ViewPortKeys[viewportKey]}=${value}`;
      }
    }
  }
  return resolved;
};

function resolveUrlValuesOfObject(
  obj:
    | Record<string, string | URL | AlternateLinkDescriptor[] | null>
    | null
    | undefined,
  metadataBase: ResolvedMetadata["metadataBase"],
  pathname: string,
): null | Record<string, AlternateLinkDescriptor[]> {
  if (!obj) return null;

  const result: Record<string, AlternateLinkDescriptor[]> = {};
  for (const [key, value] of Object.entries(obj)) {
    if (typeof value === "string" || value instanceof URL) {
      result[key] = [
        {
          url: resolveAlternateUrl(value, metadataBase, pathname), // metadataBase ? resolveUrl(value, metadataBase)! : value,
        },
      ];
    } else {
      result[key] = [];
      value?.forEach((item, index) => {
        const url = resolveAlternateUrl(item.url, metadataBase, pathname);
        result[key][index] = {
          url,
          title: item.title,
        };
      });
    }
  }
  return result;
}

function resolveCanonicalUrl(
  urlOrDescriptor: string | URL | null | AlternateLinkDescriptor | undefined,
  metadataBase: URL | null,
  pathname: string,
): null | AlternateLinkDescriptor {
  if (!urlOrDescriptor) return null;

  const url =
    typeof urlOrDescriptor === "string" || urlOrDescriptor instanceof URL
      ? urlOrDescriptor
      : urlOrDescriptor.url;

  // Return string url because structureClone can't handle URL instance
  return {
    url: resolveAlternateUrl(url, metadataBase, pathname),
  };
}

export const resolveAlternates: FieldResolverWithMetadataBase<
  "alternates",
  { pathname: string }
> = (alternates, metadataBase, { pathname }) => {
  if (!alternates) return null;

  const canonical = resolveCanonicalUrl(
    alternates.canonical,
    metadataBase,
    pathname,
  );
  const languages = resolveUrlValuesOfObject(
    alternates.languages,
    metadataBase,
    pathname,
  );
  const media = resolveUrlValuesOfObject(
    alternates.media,
    metadataBase,
    pathname,
  );
  const types = resolveUrlValuesOfObject(
    alternates.types,
    metadataBase,
    pathname,
  );

  const result: ResolvedAlternateURLs = {
    canonical,
    languages,
    media,
    types,
  };

  return result;
};

const robotsKeys = [
  "noarchive",
  "nosnippet",
  "noimageindex",
  "nocache",
  "notranslate",
  "indexifembedded",
  "nositelinkssearchbox",
  "unavailable_after",
  "max-video-preview",
  "max-image-preview",
  "max-snippet",
] as const;
const resolveRobotsValue: (robots: Metadata["robots"]) => string | null = (
  robots,
) => {
  if (!robots) return null;
  if (typeof robots === "string") return robots;

  const values: string[] = [];

  if (robots.index) values.push("index");
  else if (typeof robots.index === "boolean") values.push("noindex");

  if (robots.follow) values.push("follow");
  else if (typeof robots.follow === "boolean") values.push("nofollow");

  for (const key of robotsKeys) {
    const value = robots[key];
    if (typeof value !== "undefined" && value !== false) {
      values.push(typeof value === "boolean" ? key : `${key}:${value}`);
    }
  }

  return values.join(", ");
};

export const resolveRobots: FieldResolver<"robots"> = (robots) => {
  if (!robots) return null;
  return {
    basic: resolveRobotsValue(robots),
    googleBot: typeof robots !== "string"
      ? resolveRobotsValue(robots.googleBot)
      : null,
  };
};

const VerificationKeys = ["google", "yahoo", "yandex", "me", "other"] as const;
export const resolveVerification: FieldResolver<"verification"> = (
  verification,
) => {
  if (!verification) return null;
  const res: ResolvedVerification = {};

  for (const key of VerificationKeys) {
    const value = verification[key];
    if (value) {
      if (key === "other") {
        res.other = {};
        for (const otherKey in verification.other) {
          const otherValue = resolveAsArrayOrUndefined(
            verification.other[otherKey],
          );
          if (otherValue) res.other[otherKey] = otherValue;
        }
      } else res[key] = resolveAsArrayOrUndefined(value) as (string | number)[];
    }
  }
  return res;
};

export const resolveAppleWebApp: FieldResolver<"appleWebApp"> = (appWebApp) => {
  if (!appWebApp) return null;
  if (appWebApp === true) {
    return {
      capable: true,
    };
  }

  const startupImages = appWebApp.startupImage
    ? resolveAsArrayOrUndefined(appWebApp.startupImage)?.map((item) =>
      typeof item === "string" ? { url: item } : item
    )
    : null;

  return {
    capable: "capable" in appWebApp ? !!appWebApp.capable : true,
    title: appWebApp.title || null,
    startupImage: startupImages,
    statusBarStyle: appWebApp.statusBarStyle || "default",
  };
};

export const resolveAppLinks: FieldResolver<"appLinks"> = (appLinks) => {
  if (!appLinks) return null;
  for (const key in appLinks) {
    // @ts-ignore // TODO: type infer
    appLinks[key] = resolveAsArrayOrUndefined(appLinks[key]);
  }
  return appLinks as ResolvedMetadata["appLinks"];
};