Feat(VTEX): Recommendations BFF API

vtex/actions/cart/updateCustomData.ts

@@ -0,0 +1,52 @@
+import { AppContext } from "../../mod.ts";
+import { proxySetCookie } from "../../utils/cookies.ts";
+import { parseCookie } from "../../utils/orderForm.ts";
+import type { OrderForm } from "../../utils/types.ts";
+
+export interface Props {
+  appId: string;
+  // deno-lint-ignore no-explicit-any
+  body: any;
+}
+
+/**
+ * @title Update Custom Data
+ * @description Update the custom data in the cart
+ */
+const action = async (
+  props: Props,
+  req: Request,
+  ctx: AppContext,
+): Promise<OrderForm> => {
+  const { vcsDeprecated } = ctx;
+  const {
+    appId,
+    body,
+  } = props;
+  const { orderFormId } = parseCookie(req.headers);
+
+  if (!orderFormId || orderFormId === "") {
+    throw new Error("Order form ID is required");
+  }
+
+  const cookie = req.headers.get("cookie") ?? "";
+
+  const response = await vcsDeprecated
+    ["PUT /api/checkout/pub/orderForm/:orderFormId/customData/:appId"]({
+      orderFormId,
+      appId,
+    }, {
+      body,
+      headers: {
+        accept: "application/json",
+        "content-type": "application/json",
+        cookie,
+      },
+    });
+
+  proxySetCookie(response.headers, ctx.response.headers, req.url);
+
+  return response.json();
+};
+
+export default action;

vtex/actions/events/productView.ts

@@ -0,0 +1,62 @@
+import type { AppContext } from "../../mod.ts";
+import { getOrigin, parseCookie } from "../../utils/recommendations.ts";
+import type { ProductViewSource } from "../../utils/types.ts";
+
+interface Props {
+  /**
+   * @title User ID
+   * @description The ID of the user who viewed the recommendation.
+   */
+  userId?: string;
+  /**
+   * @title Product ID
+   * @description The ID of the product that was clicked.
+   */
+  productId: string;
+  /**
+   * @title Source
+   * @description The source of the product view event.
+   */
+  source: ProductViewSource;
+  /**
+   * @description The origin of the recommendation request. E.g: apiexamples/storefront/vtex.recommendation-shelf@2.x
+   */
+  "x-vtex-rec-origin"?: string;
+}
+
+export default async function action(
+  props: Props,
+  req: Request,
+  ctx: AppContext,
+) {
+  const { bff } = ctx;
+
+  const origin = getOrigin(req, ctx.account, props["x-vtex-rec-origin"]);
+  if (!origin) {
+    throw new Error("x-vtex-rec-origin header is required");
+  }
+
+  const cookies = parseCookie(req.headers);
+  const userId = props.userId ?? cookies?.userId;
+
+  if (!userId) {
+    throw new Error("userId is required");
+  }
+
+  await bff["POST /api/recommend-bff/v2/events/product-view"]({
+    an: ctx.account,
+  }, {
+    body: {
+      userId,
+      product: props.productId,
+      source: props.source,
+    },
+    headers: {
+      "x-vtex-rec-origin": origin,
+      "user-agent": req.headers.get("user-agent") || "",
+      cookie: req.headers.get("cookie") || "",
+    },
+  });
+
+  return { ok: true };
+}

vtex/actions/events/recommendationClick.ts

@@ -0,0 +1,59 @@
+import { AppContext } from "../../mod.ts";
+import { getOrigin, parseCookie } from "../../utils/recommendations.ts";
+
+interface Props {
+  /**
+   * @title User ID
+   * @description The ID of the user who viewed the recommendation.
+   */
+  userId?: string;
+  /**
+   * @title Product ID
+   * @description The ID of the product that was clicked.
+   */
+  productId: string;
+  /**
+   * @title Correlation ID
+   * @description The correlation ID of the recommendation request.
+   */
+  correlationId: string;
+  /**
+   * @description The origin of the recommendation request. E.g: apiexamples/storefront/vtex.recommendation-shelf@2.x
+   */
+  "x-vtex-rec-origin"?: string;
+}
+
+export default async function loader(
+  props: Props,
+  req: Request,
+  ctx: AppContext,
+) {
+  const { bff } = ctx;
+
+  const origin = getOrigin(req, ctx.account, props["x-vtex-rec-origin"]);
+  if (!origin) {
+    throw new Error("x-vtex-rec-origin header is required");
+  }
+
+  const cookies = parseCookie(req.headers);
+  const userId = props.userId ?? cookies?.userId;
+
+  if (!userId) {
+    throw new Error("userId is required");
+  }
+
+  await bff["POST /api/recommend-bff/v2/events/recommendation-click"]({
+    an: ctx.account,
+  }, {
+    body: {
+      correlationId: props.correlationId,
+      userId,
+      product: props.productId,
+    },
+    headers: {
+      "x-vtex-rec-origin": origin,
+    },
+  });
+
+  return { ok: true };
+}

vtex/actions/events/recommendationView.ts

@@ -0,0 +1,59 @@
+import { AppContext } from "../../mod.ts";
+import { getOrigin, parseCookie } from "../../utils/recommendations.ts";
+
+interface Props {
+  /**
+   * @title User ID
+   * @description The ID of the user who viewed the recommendation.
+   */
+  userId?: string;
+  /**
+   * @title Correlation ID
+   * @description The correlation ID of the recommendation request.
+   */
+  correlationId: string;
+  /**
+   * @title Products
+   * @description The products SKU IDs that were viewed.
+   */
+  products: string[];
+  /**
+   * @description The origin of the recommendation request. E.g: apiexamples/storefront/vtex.recommendation-shelf@2.x
+   */
+  "x-vtex-rec-origin"?: string;
+}
+
+export default async function loader(
+  props: Props,
+  req: Request,
+  ctx: AppContext,
+) {
+  const { bff } = ctx;
+
+  const origin = getOrigin(req, ctx.account, props["x-vtex-rec-origin"]);
+  if (!origin) {
+    throw new Error("x-vtex-rec-origin header is required");
+  }
+
+  const cookies = parseCookie(req.headers);
+  const userId = props.userId ?? cookies?.userId;
+
+  if (!userId) {
+    throw new Error("userId is required");
+  }
+
+  await bff["POST /api/recommend-bff/v2/events/recommendation-view"]({
+    an: ctx.account,
+  }, {
+    body: {
+      correlationId: props.correlationId,
+      userId,
+      products: props.products,
+    },
+    headers: {
+      "x-vtex-rec-origin": origin,
+    },
+  });
+
+  return { ok: true };
+}

vtex/actions/recommendation/startSession.ts

@@ -0,0 +1,46 @@
+import type { AppContext } from "../../mod.ts";
+import { proxySetCookie } from "../../utils/cookies.ts";
+import { parseCookie as parseOrderformCookie } from "../../utils/orderForm.ts";
+import { parseCookie as parseRecommendationsCookie } from "../../utils/recommendations.ts";
+
+export default async function action(
+  _: unknown,
+  req: Request,
+  ctx: AppContext,
+) {
+  const { bff } = ctx;
+  const { orderFormId } = parseOrderformCookie(req.headers);
+  const { userId } = parseRecommendationsCookie(req.headers);
+  if (userId) {
+    return { recommendationsUserId: userId };
+  }
+
+  const url = new URL(req.url);
+  const host = url.host;
+
+  const headers = new Headers();
+  headers.set(
+    "x-vtex-rec-origin",
+    `${ctx.account}/storefront/deco.recommendations@1.x`,
+  );
+  headers.set("x-forwarded-host", host);
+  headers.set("host", `${ctx.account}.vtexcommercestable.com.br`);
+
+  const cookie = req.headers.get("cookie");
+  if (cookie) {
+    headers.set("cookie", cookie);
+  }
+
+  const response = await bff["POST /api/recommend-bff/v2/users/start-session"]({
+    an: ctx.account,
+  }, {
+    body: { orderFormId },
+    headers,
+  });
+
+  const data = await response.json();
+
+  proxySetCookie(response.headers, ctx.response.headers, req.url);
+
+  return data;
+}