@decocms/apps 0.23.3 → 0.24.0

package/vtex/actions/misc.ts

@@ -7,7 +7,7 @@
  *   - vtex/actions/payment/deletePaymentToken.ts
  * @see https://developers.vtex.com/docs/api-reference
  */
-import { vtexFetch, getVtexConfig } from "../client";
+import { getVtexConfig, vtexFetch } from "../client";
 import { buildAuthCookieHeader, VTEX_AUTH_COOKIE } from "../utils/vtexId";
 
 // ---------------------------------------------------------------------------
@@ -15,62 +15,62 @@ import { buildAuthCookieHeader, VTEX_AUTH_COOKIE } from "../utils/vtexId";
 // ---------------------------------------------------------------------------
 
 export interface NotifyMeProps {
-  email: string;
-  skuId: string;
-  name?: string;
+	email: string;
+	skuId: string;
+	name?: string;
 }
 
 export interface ReviewData {
-  productId: string;
-  rating: number;
-  title: string;
-  text: string;
-  reviewerName: string;
-  approved: boolean;
+	productId: string;
+	rating: number;
+	title: string;
+	text: string;
+	reviewerName: string;
+	approved: boolean;
 }
 
 export type AnalyticsEvent =
-  | {
-      type: "session.ping";
-      url: string;
-    }
-  | {
-      type: "page.cart";
-      products: { productId: string; quantity: number }[];
-    }
-  | {
-      type: "page.empty_cart";
-      products: Record<string, never>;
-    }
-  | {
-      type: "page.confirmation";
-      order: string;
-      products: { productId: string; quantity: number; price: number }[];
-    }
-  | {
-      type: "search.click";
-      position: number;
-      text: string;
-      productId: string;
-      url: string;
-    }
-  | {
-      type: "search.query";
-      url: string;
-      text: string;
-      misspelled: boolean;
-      match: number;
-      operator: string;
-      locale: string;
-    };
+	| {
+			type: "session.ping";
+			url: string;
+	  }
+	| {
+			type: "page.cart";
+			products: { productId: string; quantity: number }[];
+	  }
+	| {
+			type: "page.empty_cart";
+			products: Record<string, never>;
+	  }
+	| {
+			type: "page.confirmation";
+			order: string;
+			products: { productId: string; quantity: number; price: number }[];
+	  }
+	| {
+			type: "search.click";
+			position: number;
+			text: string;
+			productId: string;
+			url: string;
+	  }
+	| {
+			type: "search.query";
+			url: string;
+			text: string;
+			misspelled: boolean;
+			match: number;
+			operator: string;
+			locale: string;
+	  };
 
 export interface ISCookies {
-  anonymous: string;
-  session: string;
+	anonymous: string;
+	session: string;
 }
 
 export interface DeletePaymentTokenResult {
-  deletePaymentToken: boolean;
+	deletePaymentToken: boolean;
 }
 
 // ---------------------------------------------------------------------------
@@ -78,28 +78,28 @@ export interface DeletePaymentTokenResult {
 // ---------------------------------------------------------------------------
 
 interface GqlResponse<T> {
-  data: T;
-  errors?: Array<{ message: string }>;
+	data: T;
+	errors?: Array<{ message: string }>;
 }
 
 async function gql<T>(
-  query: string,
-  variables: Record<string, unknown>,
-  authCookie: string,
+	query: string,
+	variables: Record<string, unknown>,
+	authCookie: string,
 ): Promise<T> {
-  const { account } = getVtexConfig();
-  const result = await vtexFetch<GqlResponse<T>>(
-    `https://${account}.myvtex.com/_v/private/graphql/v1`,
-    {
-      method: "POST",
-      body: JSON.stringify({ query, variables }),
-      headers: { Cookie: buildAuthCookieHeader(authCookie, account) },
-    },
-  );
-  if (result.errors?.length) {
-    throw new Error(`GraphQL error: ${result.errors[0].message}`);
-  }
-  return result.data;
+	const { account } = getVtexConfig();
+	const result = await vtexFetch<GqlResponse<T>>(
+		`https://${account}.myvtex.com/_v/private/graphql/v1`,
+		{
+			method: "POST",
+			body: JSON.stringify({ query, variables }),
+			headers: { Cookie: buildAuthCookieHeader(authCookie, account) },
+		},
+	);
+	if (result.errors?.length) {
+		throw new Error(`GraphQL error: ${result.errors[0].message}`);
+	}
+	return result.data;
 }
 
 // ---------------------------------------------------------------------------
@@ -119,18 +119,18 @@ const DELETE_PAYMENT_TOKEN = `mutation DeleteCreditCardToken($tokenId: ID!) {
  * Uses the legacy VTEX .aspx form endpoint (FormData, not JSON).
  */
 export async function notifyMe(props: NotifyMeProps): Promise<void> {
-  const { account } = getVtexConfig();
-  const { email, skuId, name = "" } = props;
-
-  const form = new FormData();
-  form.append("notifymeClientName", name);
-  form.append("notifymeClientEmail", email);
-  form.append("notifymeIdSku", skuId);
-
-  await fetch(
-    `https://${account}.vtexcommercestable.com.br/no-cache/AviseMe.aspx`,
-    { method: "POST", body: form },
-  );
+	const { account } = getVtexConfig();
+	const { email, skuId, name = "" } = props;
+
+	const form = new FormData();
+	form.append("notifymeClientName", name);
+	form.append("notifymeClientEmail", email);
+	form.append("notifymeIdSku", skuId);
+
+	await fetch(`https://${account}.vtexcommercestable.com.br/no-cache/AviseMe.aspx`, {
+		method: "POST",
+		body: form,
+	});
 }
 
 /**
@@ -142,21 +142,21 @@ export async function notifyMe(props: NotifyMeProps): Promise<void> {
  * @param userAgent - Forwarded user-agent string.
  */
 export async function sendEvent(
-  event: AnalyticsEvent,
-  isCookies: ISCookies,
-  userAgent?: string,
+	event: AnalyticsEvent,
+	isCookies: ISCookies,
+	userAgent?: string,
 ): Promise<void> {
-  const { account } = getVtexConfig();
-
-  await fetch(`https://sp.vtex.com/event-api/v1/${account}/event`, {
-    method: "POST",
-    headers: { "Content-Type": "application/json" },
-    body: JSON.stringify({
-      ...event,
-      ...isCookies,
-      agent: userAgent || "deco-sites/apps",
-    }),
-  });
+	const { account } = getVtexConfig();
+
+	await fetch(`https://sp.vtex.com/event-api/v1/${account}/event`, {
+		method: "POST",
+		headers: { "Content-Type": "application/json" },
+		body: JSON.stringify({
+			...event,
+			...isCookies,
+			agent: userAgent || "deco-sites/apps",
+		}),
+	});
 }
 
 /**
@@ -164,20 +164,14 @@ export async function sendEvent(
  * Hits POST https://{account}.myvtex.com/reviews-and-ratings/api/review.
  * Auth is passed via the `VtexIdclientAutCookie` header (not a Cookie header).
  */
-export async function submitReview(
-  data: ReviewData,
-  authCookie: string,
-): Promise<unknown> {
-  const { account } = getVtexConfig();
-
-  return vtexFetch<unknown>(
-    `https://${account}.myvtex.com/reviews-and-ratings/api/review`,
-    {
-      method: "POST",
-      body: JSON.stringify(data),
-      headers: { [VTEX_AUTH_COOKIE]: authCookie },
-    },
-  );
+export async function submitReview(data: ReviewData, authCookie: string): Promise<unknown> {
+	const { account } = getVtexConfig();
+
+	return vtexFetch<unknown>(`https://${account}.myvtex.com/reviews-and-ratings/api/review`, {
+		method: "POST",
+		body: JSON.stringify(data),
+		headers: { [VTEX_AUTH_COOKIE]: authCookie },
+	});
 }
 
 /**
@@ -185,12 +179,8 @@ export async function submitReview(
  * Uses the my-cards-graphql VTEX IO app.
  */
 export async function deletePaymentToken(
-  tokenId: string,
-  authCookie: string,
+	tokenId: string,
+	authCookie: string,
 ): Promise<DeletePaymentTokenResult> {
-  return gql<DeletePaymentTokenResult>(
-    DELETE_PAYMENT_TOKEN,
-    { tokenId },
-    authCookie,
-  );
+	return gql<DeletePaymentTokenResult>(DELETE_PAYMENT_TOKEN, { tokenId }, authCookie);
 }

package/vtex/actions/newsletter.ts

@@ -5,7 +5,7 @@
  *   - vtex/actions/newsletter/updateNewsletterOptIn.ts
  * @see https://developers.vtex.com/docs/guides/newsletter
  */
-import { vtexFetch, getVtexConfig } from "../client";
+import { getVtexConfig, vtexFetch } from "../client";
 import { buildAuthCookieHeader } from "../utils/vtexId";
 
 // ---------------------------------------------------------------------------
@@ -13,12 +13,12 @@ import { buildAuthCookieHeader } from "../utils/vtexId";
 // ---------------------------------------------------------------------------
 
 export interface SubscribeProps {
-  email: string;
-  name?: string;
-  page?: string;
-  part?: string;
-  /** Intentionally preserving the original typo from the VTEX legacy form field. */
-  campaing?: string;
+	email: string;
+	name?: string;
+	page?: string;
+	part?: string;
+	/** Intentionally preserving the original typo from the VTEX legacy form field. */
+	campaing?: string;
 }
 
 // ---------------------------------------------------------------------------
@@ -26,28 +26,28 @@ export interface SubscribeProps {
 // ---------------------------------------------------------------------------
 
 interface GqlResponse<T> {
-  data: T;
-  errors?: Array<{ message: string }>;
+	data: T;
+	errors?: Array<{ message: string }>;
 }
 
 async function gql<T>(
-  query: string,
-  variables: Record<string, unknown>,
-  authCookie: string,
+	query: string,
+	variables: Record<string, unknown>,
+	authCookie: string,
 ): Promise<T> {
-  const { account } = getVtexConfig();
-  const result = await vtexFetch<GqlResponse<T>>(
-    `https://${account}.myvtex.com/_v/private/graphql/v1`,
-    {
-      method: "POST",
-      body: JSON.stringify({ query, variables }),
-      headers: { Cookie: buildAuthCookieHeader(authCookie, account) },
-    },
-  );
-  if (result.errors?.length) {
-    throw new Error(`GraphQL error: ${result.errors[0].message}`);
-  }
-  return result.data;
+	const { account } = getVtexConfig();
+	const result = await vtexFetch<GqlResponse<T>>(
+		`https://${account}.myvtex.com/_v/private/graphql/v1`,
+		{
+			method: "POST",
+			body: JSON.stringify({ query, variables }),
+			headers: { Cookie: buildAuthCookieHeader(authCookie, account) },
+		},
+	);
+	if (result.errors?.length) {
+		throw new Error(`GraphQL error: ${result.errors[0].message}`);
+	}
+	return result.data;
 }
 
 // ---------------------------------------------------------------------------
@@ -67,26 +67,26 @@ const SUBSCRIBE_NEWSLETTER = `mutation SubscribeNewsletter($email: String!, $isN
  * Uses raw fetch because the body is FormData (not JSON).
  */
 export async function subscribe(props: SubscribeProps): Promise<void> {
-  const { account } = getVtexConfig();
-  const {
-    email,
-    name = "",
-    part = "newsletter",
-    page = "_",
-    campaing = "newsletter:opt-in",
-  } = props;
+	const { account } = getVtexConfig();
+	const {
+		email,
+		name = "",
+		part = "newsletter",
+		page = "_",
+		campaing = "newsletter:opt-in",
+	} = props;
 
-  const form = new FormData();
-  form.append("newsletterClientName", name);
-  form.append("newsletterClientEmail", email);
-  form.append("newsInternalPage", page);
-  form.append("newsInternalPart", part);
-  form.append("newsInternalCampaign", campaing);
+	const form = new FormData();
+	form.append("newsletterClientName", name);
+	form.append("newsletterClientEmail", email);
+	form.append("newsInternalPage", page);
+	form.append("newsInternalPart", part);
+	form.append("newsInternalCampaign", campaing);
 
-  await fetch(
-    `https://${account}.vtexcommercestable.com.br/no-cache/Newsletter.aspx`,
-    { method: "POST", body: form },
-  );
+	await fetch(`https://${account}.vtexcommercestable.com.br/no-cache/Newsletter.aspx`, {
+		method: "POST",
+		body: form,
+	});
 }
 
 /**
@@ -95,14 +95,10 @@ export async function subscribe(props: SubscribeProps): Promise<void> {
  * Here the caller must provide it explicitly.
  */
 export async function updateNewsletterOptIn(
-  subscribed: boolean,
-  email: string,
-  authCookie: string,
+	subscribed: boolean,
+	email: string,
+	authCookie: string,
 ): Promise<{ subscribed: boolean }> {
-  await gql<unknown>(
-    SUBSCRIBE_NEWSLETTER,
-    { email, isNewsletterOptIn: subscribed },
-    authCookie,
-  );
-  return { subscribed };
+	await gql<unknown>(SUBSCRIBE_NEWSLETTER, { email, isNewsletterOptIn: subscribed }, authCookie);
+	return { subscribed };
 }

package/vtex/actions/orders.ts

@@ -4,7 +4,7 @@
  *   - vtex/actions/orders/cancel.ts
  * @see https://developers.vtex.com/docs/api-reference/orders-api
  */
-import { vtexFetch, getVtexConfig } from "../client";
+import { getVtexConfig, vtexFetch } from "../client";
 import { buildAuthCookieHeader } from "../utils/vtexId";
 
 // ---------------------------------------------------------------------------
@@ -17,21 +17,18 @@ import { buildAuthCookieHeader } from "../utils/vtexId";
  * on vtexcommercestable.com.br.
  */
 export async function cancelOrder(
-  orderId: string,
-  reason: string,
-  authCookie?: string,
+	orderId: string,
+	reason: string,
+	authCookie?: string,
 ): Promise<void> {
-  const headers: Record<string, string> = {};
-  if (authCookie) {
-    headers.Cookie = buildAuthCookieHeader(authCookie, getVtexConfig().account);
-  }
+	const headers: Record<string, string> = {};
+	if (authCookie) {
+		headers.Cookie = buildAuthCookieHeader(authCookie, getVtexConfig().account);
+	}
 
-  await vtexFetch<unknown>(
-    `/api/checkout/pub/orders/${orderId}/user-cancel-request`,
-    {
-      method: "POST",
-      body: JSON.stringify({ reason }),
-      headers,
-    },
-  );
+	await vtexFetch<unknown>(`/api/checkout/pub/orders/${orderId}/user-cancel-request`, {
+		method: "POST",
+		body: JSON.stringify({ reason }),
+		headers,
+	});
 }

package/vtex/actions/profile.ts

@@ -4,7 +4,7 @@
  *   - vtex/actions/profile/updateProfile.ts
  * @see https://developers.vtex.com/docs/guides/profile-system
  */
-import { vtexFetch, getVtexConfig } from "../client";
+import { getVtexConfig, vtexFetch } from "../client";
 import { buildAuthCookieHeader } from "../utils/vtexId";
 
 // ---------------------------------------------------------------------------
@@ -12,36 +12,36 @@ import { buildAuthCookieHeader } from "../utils/vtexId";
 // ---------------------------------------------------------------------------
 
 export interface ProfileInput {
-  firstName?: string;
-  lastName?: string;
-  birthDate?: string;
-  gender?: string;
-  homePhone?: string;
-  businessPhone?: string;
-  document?: string;
-  email: string;
-  tradeName?: string;
-  corporateName?: string;
-  corporateDocument?: string;
-  stateRegistration?: string;
-  isCorporate?: boolean;
+	firstName?: string;
+	lastName?: string;
+	birthDate?: string;
+	gender?: string;
+	homePhone?: string;
+	businessPhone?: string;
+	document?: string;
+	email: string;
+	tradeName?: string;
+	corporateName?: string;
+	corporateDocument?: string;
+	stateRegistration?: string;
+	isCorporate?: boolean;
 }
 
 export interface Profile {
-  cacheId: string;
-  firstName: string;
-  lastName: string;
-  birthDate: string;
-  gender: string;
-  homePhone: string;
-  businessPhone: string;
-  document: string;
-  email: string;
-  tradeName: string;
-  corporateName: string;
-  corporateDocument: string;
-  stateRegistration: string;
-  isCorporate: boolean;
+	cacheId: string;
+	firstName: string;
+	lastName: string;
+	birthDate: string;
+	gender: string;
+	homePhone: string;
+	businessPhone: string;
+	document: string;
+	email: string;
+	tradeName: string;
+	corporateName: string;
+	corporateDocument: string;
+	stateRegistration: string;
+	isCorporate: boolean;
 }
 
 // ---------------------------------------------------------------------------
@@ -49,28 +49,28 @@ export interface Profile {
 // ---------------------------------------------------------------------------
 
 interface GqlResponse<T> {
-  data: T;
-  errors?: Array<{ message: string }>;
+	data: T;
+	errors?: Array<{ message: string }>;
 }
 
 async function gql<T>(
-  query: string,
-  variables: Record<string, unknown>,
-  authCookie: string,
+	query: string,
+	variables: Record<string, unknown>,
+	authCookie: string,
 ): Promise<T> {
-  const { account } = getVtexConfig();
-  const result = await vtexFetch<GqlResponse<T>>(
-    `https://${account}.myvtex.com/_v/private/graphql/v1`,
-    {
-      method: "POST",
-      body: JSON.stringify({ query, variables }),
-      headers: { Cookie: buildAuthCookieHeader(authCookie, account) },
-    },
-  );
-  if (result.errors?.length) {
-    throw new Error(`GraphQL error: ${result.errors[0].message}`);
-  }
-  return result.data;
+	const { account } = getVtexConfig();
+	const result = await vtexFetch<GqlResponse<T>>(
+		`https://${account}.myvtex.com/_v/private/graphql/v1`,
+		{
+			method: "POST",
+			body: JSON.stringify({ query, variables }),
+			headers: { Cookie: buildAuthCookieHeader(authCookie, account) },
+		},
+	);
+	if (result.errors?.length) {
+		throw new Error(`GraphQL error: ${result.errors[0].message}`);
+	}
+	return result.data;
 }
 
 // ---------------------------------------------------------------------------
@@ -106,14 +106,14 @@ const UPDATE_PROFILE = `mutation UpdateProfile($input: ProfileInput!) {
  * Here the caller must provide it explicitly.
  */
 export async function updateProfile(
-  fields: Omit<ProfileInput, "email">,
-  email: string,
-  authCookie: string,
+	fields: Omit<ProfileInput, "email">,
+	email: string,
+	authCookie: string,
 ): Promise<Profile> {
-  const { updateProfile: profile } = await gql<{ updateProfile: Profile }>(
-    UPDATE_PROFILE,
-    { input: { ...fields, email } },
-    authCookie,
-  );
-  return profile;
+	const { updateProfile: profile } = await gql<{ updateProfile: Profile }>(
+		UPDATE_PROFILE,
+		{ input: { ...fields, email } },
+		authCookie,
+	);
+	return profile;
 }