@decocms/apps 0.23.3 → 0.24.0

package/vtex/actions/address.ts

@@ -6,7 +6,7 @@
  *   - vtex/actions/address/update.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";
 
 // ---------------------------------------------------------------------------
@@ -14,50 +14,50 @@ import { buildAuthCookieHeader } from "../utils/vtexId";
 // ---------------------------------------------------------------------------
 
 export interface AddressInput {
-  addressName: string;
-  addressType?: string;
-  city?: string;
-  complement?: string;
-  country?: string;
-  geoCoordinates?: number[];
-  neighborhood?: string;
-  number?: string;
-  postalCode?: string;
-  receiverName?: string;
-  reference?: string;
-  state?: string;
-  street?: string;
+	addressName: string;
+	addressType?: string;
+	city?: string;
+	complement?: string;
+	country?: string;
+	geoCoordinates?: number[];
+	neighborhood?: string;
+	number?: string;
+	postalCode?: string;
+	receiverName?: string;
+	reference?: string;
+	state?: string;
+	street?: string;
 }
 
 export interface SavedAddress {
-  id: string;
-  cacheId: string;
-  addressId: string;
-  userId?: string;
-  addressName: string;
-  addressType: string | null;
-  city: string | null;
-  complement: string | null;
-  country: string | null;
-  geoCoordinates: number[] | null;
-  neighborhood: string | null;
-  number: string | null;
-  postalCode: string | null;
-  receiverName: string | null;
-  reference: string | null;
-  state: string | null;
-  street: string | null;
-  name?: string;
+	id: string;
+	cacheId: string;
+	addressId: string;
+	userId?: string;
+	addressName: string;
+	addressType: string | null;
+	city: string | null;
+	complement: string | null;
+	country: string | null;
+	geoCoordinates: number[] | null;
+	neighborhood: string | null;
+	number: string | null;
+	postalCode: string | null;
+	receiverName: string | null;
+	reference: string | null;
+	state: string | null;
+	street: string | null;
+	name?: string;
 }
 
 export interface DeleteAddressResult {
-  cacheId: string;
-  addresses: SavedAddress[];
+	cacheId: string;
+	addresses: SavedAddress[];
 }
 
 export interface UpdateAddressResult {
-  cacheId: string;
-  addresses: SavedAddress;
+	cacheId: string;
+	addresses: SavedAddress;
 }
 
 // ---------------------------------------------------------------------------
@@ -65,28 +65,28 @@ export interface UpdateAddressResult {
 // ---------------------------------------------------------------------------
 
 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;
 }
 
 // ---------------------------------------------------------------------------
@@ -165,47 +165,47 @@ const UPDATE_ADDRESS = `mutation UpdateAddress($addressId: String!, $addressFiel
 
 /** Create a new user address. Requires the user's VtexIdclientAutCookie token. */
 export async function createAddress(
-  input: AddressInput,
-  authCookie: string,
+	input: AddressInput,
+	authCookie: string,
 ): Promise<SavedAddress> {
-  const { saveAddress } = await gql<{ saveAddress: SavedAddress }>(
-    SAVE_ADDRESS,
-    { address: input },
-    authCookie,
-  );
-  return saveAddress;
+	const { saveAddress } = await gql<{ saveAddress: SavedAddress }>(
+		SAVE_ADDRESS,
+		{ address: input },
+		authCookie,
+	);
+	return saveAddress;
 }
 
 /** Delete an address by its ID. Returns remaining addresses. */
 export async function deleteAddress(
-  addressId: string,
-  authCookie: string,
+	addressId: string,
+	authCookie: string,
 ): Promise<DeleteAddressResult> {
-  const { deleteAddress: result } = await gql<{ deleteAddress: DeleteAddressResult }>(
-    DELETE_ADDRESS,
-    { addressId },
-    authCookie,
-  );
-  return result;
+	const { deleteAddress: result } = await gql<{ deleteAddress: DeleteAddressResult }>(
+		DELETE_ADDRESS,
+		{ addressId },
+		authCookie,
+	);
+	return result;
 }
 
 /** Update an existing address. Returns the updated address. */
 export async function updateAddress(
-  addressId: string,
-  fields: Partial<AddressInput>,
-  authCookie: string,
+	addressId: string,
+	fields: Partial<AddressInput>,
+	authCookie: string,
 ): Promise<UpdateAddressResult> {
-  const { updateAddress: result } = await gql<{ updateAddress: UpdateAddressResult }>(
-    UPDATE_ADDRESS,
-    {
-      addressId,
-      addressFields: {
-        ...fields,
-        receiverName: fields.receiverName ?? null,
-        complement: fields.complement ?? null,
-      },
-    },
-    authCookie,
-  );
-  return result;
+	const { updateAddress: result } = await gql<{ updateAddress: UpdateAddressResult }>(
+		UPDATE_ADDRESS,
+		{
+			addressId,
+			addressFields: {
+				...fields,
+				receiverName: fields.receiverName ?? null,
+				complement: fields.complement ?? null,
+			},
+		},
+		authCookie,
+	);
+	return result;
 }

package/vtex/actions/auth.ts

@@ -6,10 +6,7 @@
  */
 
 import type { VtexFetchResult } from "../client";
-import {
-	getVtexConfig,
-	vtexFetchWithCookies,
-} from "../client";
+import { getVtexConfig, vtexFetchWithCookies } from "../client";
 import { VTEX_AUTH_COOKIE } from "../utils/vtexId";
 
 // ---------------------------------------------------------------------------
@@ -77,9 +74,7 @@ const FORM_HEADERS = {
  * Extract login cookies from an AuthResponse.
  * Returns null if auth failed.
  */
-export function extractLoginCookies(
-	response: AuthResponse,
-): LoginCookies | null {
+export function extractLoginCookies(response: AuthResponse): LoginCookies | null {
 	if (response.authStatus !== "Success" || !response.authCookie) {
 		return null;
 	}
@@ -138,10 +133,7 @@ export async function classicSignIn(
 		const startResult = await startAuthentication();
 		token = startResult.data.authenticationToken ?? undefined;
 		startCookies = startResult.setCookies;
-		if (!token)
-			throw new Error(
-				"Failed to obtain authentication token from startAuthentication",
-			);
+		if (!token) throw new Error("Failed to obtain authentication token from startAuthentication");
 	}
 
 	const body = new URLSearchParams({
@@ -172,10 +164,11 @@ export async function accessKeySignIn(
 		authenticationToken,
 	});
 
-	return vtexFetchWithCookies<AuthResponse>(
-		"/api/vtexid/pub/authentication/accesskey/validate",
-		{ method: "POST", body, headers: FORM_HEADERS },
-	);
+	return vtexFetchWithCookies<AuthResponse>("/api/vtexid/pub/authentication/accesskey/validate", {
+		method: "POST",
+		body,
+		headers: FORM_HEADERS,
+	});
 }
 
 /**
@@ -201,14 +194,11 @@ export async function refreshToken(
 	cookieHeader: string,
 	fingerprint?: string,
 ): Promise<VtexFetchResult<RefreshTokenResponse>> {
-	return vtexFetchWithCookies<RefreshTokenResponse>(
-		"/api/vtexid/refreshtoken/webstore",
-		{
-			method: "POST",
-			body: JSON.stringify({ fingerprint }),
-			headers: { cookie: cookieHeader },
-		},
-	);
+	return vtexFetchWithCookies<RefreshTokenResponse>("/api/vtexid/refreshtoken/webstore", {
+		method: "POST",
+		body: JSON.stringify({ fingerprint }),
+		headers: { cookie: cookieHeader },
+	});
 }
 
 /**
@@ -260,10 +250,7 @@ export async function resetPassword(
 		const startResult = await startAuthentication({ locale });
 		token = startResult.data.authenticationToken ?? undefined;
 		startCookies = startResult.setCookies;
-		if (!token)
-			throw new Error(
-				"Failed to obtain authentication token from startAuthentication",
-			);
+		if (!token) throw new Error("Failed to obtain authentication token from startAuthentication");
 	}
 
 	const params = new URLSearchParams({

package/vtex/actions/checkout.ts

@@ -60,7 +60,7 @@ export async function getOrCreateCart(
 ): Promise<VtexFetchResult<OrderForm>> {
 	const sc = scParam();
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
+	if (cookieHeader) headers.cookie = cookieHeader;
 
 	if (orderFormId) {
 		const result = await vtexFetchWithCookies<OrderForm>(
@@ -99,7 +99,7 @@ export async function addItemsToCart(
 	const params = appendSc(new URLSearchParams());
 	for (const d of allowedOutdatedData) params.append("allowedOutdatedData", d);
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
+	if (cookieHeader) headers.cookie = cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/items?${params}`,
 		{ method: "POST", body: JSON.stringify({ orderItems }), headers },
@@ -122,7 +122,7 @@ export async function updateCartItems(
 		params.append("allowedOutdatedData", d);
 	}
 	const headers: Record<string, string> = {};
-	if (opts?.cookieHeader) headers["cookie"] = opts.cookieHeader;
+	if (opts?.cookieHeader) headers.cookie = opts.cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/items/update?${params}`,
 		{
@@ -144,7 +144,7 @@ export async function removeAllItems(
 ): Promise<VtexFetchResult<OrderForm>> {
 	const sc = scParam();
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
+	if (cookieHeader) headers.cookie = cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/items/removeAll${sc ? `?${sc}` : ""}`,
 		{ method: "POST", body: JSON.stringify({}), headers },
@@ -160,7 +160,7 @@ export async function addCouponToCart(
 ): Promise<VtexFetchResult<OrderForm>> {
 	const sc = scParam();
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
+	if (cookieHeader) headers.cookie = cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/coupons${sc ? `?${sc}` : ""}`,
 		{ method: "POST", body: JSON.stringify({ text }), headers },
@@ -187,11 +187,9 @@ export async function simulateCart(
 	cookieHeader?: string,
 ) {
 	const config = getVtexConfig();
-	const params = appendSc(
-		new URLSearchParams({ RnbBehavior: String(RnbBehavior) }),
-	);
+	const params = appendSc(new URLSearchParams({ RnbBehavior: String(RnbBehavior) }));
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
+	if (cookieHeader) headers.cookie = cookieHeader;
 	return vtexFetch<any>(`/api/checkout/pub/orderForms/simulation?${params}`, {
 		method: "POST",
 		body: JSON.stringify({
@@ -215,7 +213,7 @@ export async function addOffering(
 	cookieHeader?: string,
 ): Promise<VtexFetchResult<OrderForm>> {
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
+	if (cookieHeader) headers.cookie = cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/items/${itemIndex}/offerings`,
 		{
@@ -240,7 +238,7 @@ export async function removeOffering(
 	cookieHeader?: string,
 ): Promise<VtexFetchResult<OrderForm>> {
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
+	if (cookieHeader) headers.cookie = cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/items/${itemIndex}/offerings/${offeringId}/remove`,
 		{
@@ -266,7 +264,7 @@ export async function updateOrderFormAttachment(
 ): Promise<VtexFetchResult<OrderForm>> {
 	if (!orderFormId) throw new Error("Order form ID is required");
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
+	if (cookieHeader) headers.cookie = cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/attachments/${attachment}`,
 		{
@@ -292,7 +290,7 @@ export async function updateItemAttachment(
 ): Promise<VtexFetchResult<OrderForm>> {
 	const sections = opts?.expectedOrderFormSections ?? DEFAULT_EXPECTED_SECTIONS;
 	const headers: Record<string, string> = {};
-	if (opts?.cookieHeader) headers["cookie"] = opts.cookieHeader;
+	if (opts?.cookieHeader) headers.cookie = opts.cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/items/${itemIndex}/attachments/${attachment}`,
 		{
@@ -322,7 +320,7 @@ export async function removeItemAttachment(
 ): Promise<VtexFetchResult<OrderForm>> {
 	const sections = opts?.expectedOrderFormSections ?? DEFAULT_EXPECTED_SECTIONS;
 	const headers: Record<string, string> = {};
-	if (opts?.cookieHeader) headers["cookie"] = opts.cookieHeader;
+	if (opts?.cookieHeader) headers.cookie = opts.cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/items/${itemIndex}/attachments/${attachment}`,
 		{
@@ -366,7 +364,7 @@ export async function updateSelectableGifts(
 	cookieHeader?: string,
 ): Promise<VtexFetchResult<OrderForm>> {
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
+	if (cookieHeader) headers.cookie = cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/selectable-gifts/${giftId}`,
 		{
@@ -395,11 +393,10 @@ export async function getInstallments(
 	const params = new URLSearchParams({ paymentSystem: String(paymentSystem) });
 	appendSc(params);
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
-	return vtexFetch<any>(
-		`/api/checkout/pub/orderForm/${orderFormId}/installments?${params}`,
-		{ headers },
-	);
+	if (cookieHeader) headers.cookie = cookieHeader;
+	return vtexFetch<any>(`/api/checkout/pub/orderForm/${orderFormId}/installments?${params}`, {
+		headers,
+	});
 }
 
 // ---------------------------------------------------------------------------
@@ -411,11 +408,9 @@ export async function updateOrderFormProfile(
 	fields: Record<string, unknown>,
 	opts?: { ignoreProfileData?: boolean; cookieHeader?: string },
 ): Promise<VtexFetchResult<OrderForm>> {
-	const body = opts?.ignoreProfileData
-		? { ...fields, ignoreProfileData: true }
-		: fields;
+	const body = opts?.ignoreProfileData ? { ...fields, ignoreProfileData: true } : fields;
 	const headers: Record<string, string> = {};
-	if (opts?.cookieHeader) headers["cookie"] = opts.cookieHeader;
+	if (opts?.cookieHeader) headers.cookie = opts.cookieHeader;
 	const result = await vtexFetchWithCookies<OrderForm>(
 		`/api/checkout/pub/orderForm/${orderFormId}/profile`,
 		{ method: "PATCH", body: JSON.stringify(body), headers },
@@ -424,12 +419,8 @@ export async function updateOrderFormProfile(
 	return result;
 }
 
-export async function changeToAnonymousUser(
-	orderFormId: string,
-): Promise<OrderForm> {
-	return vtexFetch<OrderForm>(
-		`/api/checkout/changeToAnonymousUser/${orderFormId}`,
-	);
+export async function changeToAnonymousUser(orderFormId: string): Promise<OrderForm> {
+	return vtexFetch<OrderForm>(`/api/checkout/changeToAnonymousUser/${orderFormId}`);
 }
 
 export async function clearOrderFormMessages(
@@ -437,11 +428,12 @@ export async function clearOrderFormMessages(
 	cookieHeader?: string,
 ): Promise<OrderForm> {
 	const headers: Record<string, string> = {};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
-	return vtexFetch<OrderForm>(
-		`/api/checkout/pub/orderForm/${orderFormId}/messages/clear`,
-		{ method: "POST", body: JSON.stringify({}), headers },
-	);
+	if (cookieHeader) headers.cookie = cookieHeader;
+	return vtexFetch<OrderForm>(`/api/checkout/pub/orderForm/${orderFormId}/messages/clear`, {
+		method: "POST",
+		body: JSON.stringify({}),
+		headers,
+	});
 }
 
 // ---------------------------------------------------------------------------
@@ -465,9 +457,7 @@ export async function getSellersByRegion(
 	const params = new URLSearchParams({ country: "BRA", postalCode });
 	const sc = salesChannel ?? getVtexConfig().salesChannel;
 	if (sc) params.set("sc", sc);
-	const resp = await vtexFetch<RegionResult[]>(
-		`/api/checkout/pub/regions/?${params}`,
-	);
+	const resp = await vtexFetch<RegionResult[]>(`/api/checkout/pub/regions/?${params}`);
 	return resp[0]?.sellers?.length > 0 ? resp[0] : null;
 }
 
@@ -479,17 +469,14 @@ export async function setShippingPostalCode(
 ): Promise<boolean> {
 	try {
 		const headers: Record<string, string> = {};
-		if (cookieHeader) headers["cookie"] = cookieHeader;
-		await vtexFetch<any>(
-			`/api/checkout/pub/orderForm/${orderFormId}/attachments/shippingData`,
-			{
-				method: "POST",
-				body: JSON.stringify({
-					selectedAddresses: [{ postalCode, country }],
-				}),
-				headers,
-			},
-		);
+		if (cookieHeader) headers.cookie = cookieHeader;
+		await vtexFetch<any>(`/api/checkout/pub/orderForm/${orderFormId}/attachments/shippingData`, {
+			method: "POST",
+			body: JSON.stringify({
+				selectedAddresses: [{ postalCode, country }],
+			}),
+			headers,
+		});
 		return true;
 	} catch {
 		return false;

package/vtex/actions/masterData.ts

@@ -20,16 +20,13 @@ export async function createDocument(
 	entity: string,
 	data: Record<string, any>,
 ): Promise<CreateDocumentResult> {
-	return vtexFetch<CreateDocumentResult>(
-		`/api/dataentities/${entity}/documents`,
-		{ method: "POST", body: JSON.stringify(removeEmptyFields(data)) },
-	);
+	return vtexFetch<CreateDocumentResult>(`/api/dataentities/${entity}/documents`, {
+		method: "POST",
+		body: JSON.stringify(removeEmptyFields(data)),
+	});
 }
 
-export async function getDocument<T = unknown>(
-	entity: string,
-	documentId: string,
-): Promise<T> {
+export async function getDocument<T = unknown>(entity: string, documentId: string): Promise<T> {
 	return vtexFetch<T>(`/api/dataentities/${entity}/documents/${documentId}`);
 }
 
@@ -59,9 +56,7 @@ export async function searchDocuments<T = MasterDataSearchResult>(
 	entity: string,
 	filter: string,
 ): Promise<T[]> {
-	return vtexFetch<T[]>(
-		`/api/dataentities/${entity}/search?_where=${encodeURIComponent(filter)}`,
-	);
+	return vtexFetch<T[]>(`/api/dataentities/${entity}/search?_where=${encodeURIComponent(filter)}`);
 }
 
 /**
@@ -86,15 +81,7 @@ export interface SearchDocumentsOpts {
 export async function searchDocumentsFull<T = Record<string, unknown>>(
 	opts: SearchDocumentsOpts,
 ): Promise<T[]> {
-	const {
-		acronym,
-		fields,
-		where,
-		sort,
-		skip = 0,
-		take = 10,
-		cookieHeader,
-	} = opts;
+	const { acronym, fields, where, sort, skip = 0, take = 10, cookieHeader } = opts;
 	const from = Math.max(skip, 0);
 	const to = from + Math.min(100, take);
 
@@ -108,7 +95,7 @@ export async function searchDocumentsFull<T = Record<string, unknown>>(
 		"content-type": "application/json",
 		"REST-Range": `resources=${from}-${to}`,
 	};
-	if (cookieHeader) headers["cookie"] = cookieHeader;
+	if (cookieHeader) headers.cookie = cookieHeader;
 
 	return vtexFetchResponse(`/api/dataentities/${acronym}/search?${params}`, {
 		headers,
@@ -133,9 +120,7 @@ export interface UploadAttachmentOpts {
  * Upload a file attachment to a MasterData document.
  * Uses the VTEX MasterData attachment API with appKey/appToken auth.
  */
-export async function uploadAttachment(
-	opts: UploadAttachmentOpts,
-): Promise<{ ok: true }> {
+export async function uploadAttachment(opts: UploadAttachmentOpts): Promise<{ ok: true }> {
 	const { entity, documentId, field, fileName, fileBase64, contentType } = opts;
 	const config = getVtexConfig();
 	const url = `https://${config.account}.vtexcommercestable.${config.domain ?? "com.br"}/api/dataentities/${entity}/documents/${documentId}/${field}/attachments`;
@@ -161,9 +146,7 @@ export async function uploadAttachment(
 	});
 
 	if (!response.ok) {
-		throw new Error(
-			`VTEX attachment upload failed: ${response.status} ${response.statusText}`,
-		);
+		throw new Error(`VTEX attachment upload failed: ${response.status} ${response.statusText}`);
 	}
 
 	return { ok: true };