@uappi/public-sdk 1.20.1 → 1.22.0

package/README.md

@@ -65,3 +65,15 @@ git push origin v1.2.9
 ```
 
 Não repita esse passo — é só histórico de como o processo começou.
+
+## Nome do cookie de autenticação
+
+O SDK envia o header `Uappi-Cookie-Name` em toda requisição, com o valor `token` por padrão.
+
+Para usar outro cookie, acesse a loja com `?setCookieName=<nome>`. O SDK captura o valor, grava em `sessionStorage` sob a chave `uappi-cookie-name` e passa a enviá-lo no header a partir dali. Como `sessionStorage` é por aba, cada aba do navegador mantém sua própria sessão na mesma URL de projeto.
+
+Nomes aceitos: `^[A-Za-z0-9_-]{1,64}$`. Valor fora desse formato é ignorado e o SDK segue com o anterior (ou com `token`).
+
+Temas que compartilham a aba (iframe same-origin, ou navegação na mesma aba) leem o nome em uso por `Api.getCookieName()`, sem reimplementar a chave do storage.
+
+A captura da URL acontece sozinha na primeira requisição. Se o tema limpa a query string no boot — router SPA com `replace`, por exemplo — chame `Api.captureCookieName()` antes disso.

package/components/PaymentHosted/PaymentHosted.vue

@@ -3,7 +3,9 @@ import { ref, shallowRef, computed, onMounted, onUnmounted } from 'vue';
 
 import api from '../../modules/Api';
 import { purchaseAction } from '../../modules/Tracking/gtm/events/actions/purchase';
+import { purchaseOrderAction } from '../../modules/Tracking/gtm/events/actions/purchaseOrder';
 import { purchaseAction as facebookPurchaseAction } from '../../modules/Tracking/facebook/events/actions/purchase';
+import { purchaseOrderAction as facebookPurchaseOrderAction } from '../../modules/Tracking/facebook/events/actions/purchaseOrder';
 
 import type { Props, Emits, PaymentSuccessData, PaymentRedirectData } from './types';
 import type { CartResponse } from '../../modules/Api/types';
@@ -51,7 +53,10 @@ const iframeSrc = computed(() => {
 });
 
 async function requestPaymentToken(): Promise<string> {
-  const response = await api.cart.paymentToken({ paymentOptionId: props.option.id });
+  const response = await api.cart.paymentToken({
+    paymentOptionId: props.option.id,
+    ...(props.orderGroupPaymentCode ? { orderGroupPaymentCode: props.orderGroupPaymentCode } : {}),
+  });
 
   if (!response?.token) {
     console.error('[PaymentHosted] Token ausente na resposta:', response);
@@ -70,6 +75,7 @@ async function fetchPaymentToken(): Promise<void> {
     paymentToken.value = await requestPaymentToken();
   } catch (err) {
     console.error('[PaymentHosted] Erro ao buscar token de pagamento:', err);
+    emit('token-error', (err as { errorCode?: string })?.errorCode);
     tokenError.value = 'Não foi possível iniciar o formulário de pagamento.';
   } finally {
     loadingToken.value = false;
@@ -96,6 +102,10 @@ async function refreshPaymentToken(): Promise<void> {
 }
 
 async function fetchCartSnapshot(): Promise<void> {
+  // No fluxo de link o carrinho ativo não é a compra: o CartBroker devolveria um
+  // carrinho vazio recém-criado, e o evento sairia com itens que não existem
+  if (props.orderGroupPaymentCode) return;
+
   try {
     cartSnapshot.value = await api.cart.listDetail();
   } catch (err) {
@@ -131,7 +141,10 @@ function handleIframeMessage(event: MessageEvent): void {
       break;
 
     case 'UAPPI_PAYMENT_SUCCESS':
-      if (cartSnapshot.value) {
+      if (props.orderGroup) {
+        purchaseOrderAction(props.option.paymentType.code, props.orderGroup);
+        facebookPurchaseOrderAction(props.orderGroup.id, props.orderGroup.values?.totalValue ?? 0);
+      } else if (cartSnapshot.value) {
         purchaseAction(props.option.paymentType.code, cartSnapshot.value);
         facebookPurchaseAction(data.id, cartSnapshot.value);
       } else {

package/components/PaymentHosted/types.ts

@@ -1,4 +1,4 @@
-import type { PaymentOption, BuyCartResponse } from '../../modules/Api/types';
+import type { PaymentOption, BuyCartResponse, CustomerOrderResponse } from '../../modules/Api/types';
 
 export interface Props {
   /** Opção de pagamento selecionada (ex: item retornado por `api.cart.listPayments`). */
@@ -11,10 +11,15 @@ export interface Props {
   countryCode?: string;
   /** Host do serviço render.uappi. Sobrescreve `VITE_PAYMENT_IFRAME_HOST` quando informado. */
   iframeHost?: string;
+  /** Código do link de pagamento. Informado, o token sai para o pedido do link. */
+  orderGroupPaymentCode?: string;
+  /** Grupo de pedido do link. Obrigatório junto de `orderGroupPaymentCode`. */
+  orderGroup?: CustomerOrderResponse;
 }
 
 export interface Emits {
   (e: 'payment-ready'): void;
+  (e: 'token-error', errorCode: string | undefined): void;
   (e: 'payment-success', data: PaymentSuccessData): void;
   (e: 'payment-redirect', url: string, data: PaymentRedirectData): void;
   (e: 'payment-error', errorCode: string | undefined, message: string): void;

package/modules/Api/cookieName.ts

@@ -0,0 +1,23 @@
+const STORAGE_KEY = 'uappi-cookie-name';
+const DEFAULT_COOKIE_NAME = 'token';
+const VALID_COOKIE_NAME = /^[A-Za-z0-9_-]{1,64}$/;
+
+export function captureCookieName() {
+  const param = new URLSearchParams(window.location.search).get(
+    'setCookieName',
+  );
+
+  if (!param || !VALID_COOKIE_NAME.test(param)) return;
+
+  sessionStorage.setItem(STORAGE_KEY, param);
+}
+
+export function getCookieName() {
+  captureCookieName();
+
+  const stored = sessionStorage.getItem(STORAGE_KEY);
+
+  return stored && VALID_COOKIE_NAME.test(stored)
+    ? stored
+    : DEFAULT_COOKIE_NAME;
+}

package/modules/Api/endpoints/OrderPaymentCodeComposable.ts

@@ -0,0 +1,10 @@
+import { usePublicApi } from '..';
+
+import type { OrderPaymentCodeDetailResponse } from '../types';
+
+export function detailOrderPaymentCode(code: string) {
+  return usePublicApi<OrderPaymentCodeDetailResponse>({
+    endpoint: `/publics/order/payment-code/${code}`,
+    method: 'GET',
+  });
+}

package/modules/Api/index.ts

@@ -58,6 +58,7 @@ import { listMenu } from './endpoints/MenuComposable';
 import { listPairOffers } from './endpoints/PairOfferComposable';
 import { getPromotionalForecast } from './endpoints/PromotionalForecastComposable';
 import { paymentConditions } from './endpoints/PaymentComposable';
+import { detailOrderPaymentCode } from './endpoints/OrderPaymentCodeComposable';
 import {
   deleteProductComment,
   createProductComment,
@@ -102,6 +103,7 @@ import { sendMfa, confirmMfa, loginMfa, deleteMFA, mfaSetup } from './endpoints/
 
 
 import { usePublicApi } from './usePublicApi';
+import { captureCookieName, getCookieName } from './cookieName';
 
 const thirdParty = {
   oauthRedirect,
@@ -216,16 +218,23 @@ const promotional = {
   getPromotionalForecast,
 };
 
+const order = {
+  detailOrderPaymentCode
+};
+
 const notify = {
   contact
 }
 
 export {
   usePublicApi,
+  captureCookieName,
+  getCookieName,
   common,
   customer,
   customization,
   cart,
+  order,
   product,
   promotional,
   notify,
@@ -233,11 +242,14 @@ export {
 };
 export default {
   usePublicApi,
+  captureCookieName,
+  getCookieName,
 
   common,
   customer,
   customization,
   cart,
+  order,
   product,
   promotional,
   notify,

package/modules/Api/types/context/api-config.types.ts

@@ -1,6 +1,11 @@
 import type { Ref } from 'vue';
 
-import type { ApiParams, CustomerErrorCode, CustomerMFAErrorCode } from '..';
+import type {
+  ApiParams,
+  CustomerErrorCode,
+  CustomerMFAErrorCode,
+  OrderPaymentCodeErrorCode,
+} from '..';
 
 export type ApiStatus = 'pending' | 'success' | 'error';
 
@@ -63,6 +68,7 @@ export interface ApiErrorData {
     | 'UAPPI_TOOLS_ITEM_EVALUATED'
     | 'UAPPI_TOOLS_REVIEW_NOT_FOUND'
     | CustomerErrorCode
-    | CustomerMFAErrorCode;
+    | CustomerMFAErrorCode
+    | OrderPaymentCodeErrorCode;
   message: string;
 }

package/modules/Api/types/endpoints/cart/cart.interfaces.ts

@@ -162,6 +162,7 @@ export interface BuyCartResponse {
 
 export interface PaymentTokenCartRequest {
   paymentOptionId: number;
+  orderGroupPaymentCode?: string;
 }
 
 export interface PaymentTokenCartResponse {

package/modules/Api/types/endpoints/order/order-payment-code.interfaces.ts

@@ -0,0 +1,13 @@
+import type { CustomerOrderResponse, PaymentConfiguration, PaymentResponse } from '../..';
+
+export interface OrderPaymentCodeAvailableOption {
+  option: PaymentResponse[number];
+  settings: Array<PaymentConfiguration>;
+}
+
+export interface OrderPaymentCodeDetailResponse {
+  code: string;
+  expiresAt: string;
+  orderGroup: CustomerOrderResponse | null;
+  paymentOptions: Array<OrderPaymentCodeAvailableOption>;
+}

package/modules/Api/types/endpoints/order/order-payment-code.types.ts

@@ -0,0 +1,9 @@
+export type OrderPaymentCodeErrorCode =
+  | 'UAPPI_STORE_ORDER_PAYMENT_CODE_NOT_FOUND'
+  | 'UAPPI_STORE_ORDER_PAYMENT_CODE_EXPIRED'
+  | 'UAPPI_STORE_ORDER_PAYMENT_CODE_INVALID_ORDER_STATUS'
+  | 'UAPPI_STORE_ORDER_PAYMENT_CODE_ALREADY_PAID'
+  | 'UAPPI_STORE_ORDER_INVALID_PAYMENT_OPTION'
+  | 'UAPPI_STORE_ORDER_PAYMENT_FAIL'
+  | 'UAPPI_STORE_ORDER_ANTI_FRAUD_FAIL'
+  | 'UAPPI_RENDER_PAYMENT_EXPIRED_TOKEN';

package/modules/Api/types/index.ts

@@ -137,6 +137,11 @@ import type { Media } from './endpoints/media/media.interfaces';
 import type { Target, Type } from './endpoints/menu/menu.enums';
 import type { Menu, MenuItem } from './endpoints/menu/menu.interfaces';
 import type { Order, OrderItem } from './endpoints/order/order.interfaces';
+import type {
+  OrderPaymentCodeAvailableOption,
+  OrderPaymentCodeDetailResponse,
+} from './endpoints/order/order-payment-code.interfaces';
+import type { OrderPaymentCodeErrorCode } from './endpoints/order/order-payment-code.types';
 import type { Page } from './endpoints/page/page.interfaces';
 import type { Pagination } from './endpoints/pagination/pagination.interfaces';
 import type {
@@ -522,6 +527,9 @@ export type {
   // Order
   Order,
   OrderItem,
+  OrderPaymentCodeAvailableOption,
+  OrderPaymentCodeDetailResponse,
+  OrderPaymentCodeErrorCode,
   Storage,
 
   // COUNTRY TYPES

package/modules/Api/usePublicApi.ts

@@ -3,6 +3,7 @@ import axios, { type AxiosError, AxiosHeaders } from 'axios';
 import type { ApiContext, ApiError, ApiErrorData } from './types';
 
 import { encodeWafNormalizer } from './paramsSerializer/encodeWafNormalizer';
+import { getCookieName } from './cookieName';
 
 export async function usePublicApi<
   ResponseType,
@@ -26,7 +27,7 @@ export async function usePublicApi<
   params,
 }: ApiContext<RequestType, FieldOptions, OrderOptions, ConditionOptions>) {
   const headers = new AxiosHeaders({
-    'Uappi-Cookie-Name': 'token',
+    'Uappi-Cookie-Name': getCookieName(),
     Accept: 'application/json',
   });
 

package/modules/Tracking/facebook/events/actions/purchaseOrder.ts

@@ -0,0 +1,18 @@
+import api from '../../../../Api';
+import { pushFbq } from '../../../utils/pushFbq';
+
+export function purchaseOrderAction(orderGroupId: number, value: number) {
+  if (!window.fbq) return;
+
+  api.thirdParty
+    .facebookPurchase({ orderGroupId })
+    .then(eventId =>
+      pushFbq(
+        'track',
+        'Purchase',
+        { value, currency: 'BRL' },
+        { eventID: eventId },
+      ),
+    )
+    .catch(() => {});
+}

package/modules/Tracking/gtm/events/actions/purchaseOrder.ts

@@ -0,0 +1,49 @@
+import { pushDatalayer } from '../../../utils/pushDatalayer';
+
+import type { CustomerOrderResponse } from '../../../../Api/types';
+
+export function purchaseOrderAction(
+  paymentMethod: string,
+  orderGroup: CustomerOrderResponse,
+) {
+  const coupon =
+    orderGroup.discounts?.find(discount => discount.type === 'coupon')
+      ?.entityId ?? '';
+
+  pushDatalayer({
+    event: 'purchase',
+    ecommerce: {
+      currency: 'BRL',
+      affiliation: 'Loja Virtual',
+
+      payment_status: 'em aberto',
+      payment_type: paymentMethod,
+
+      shipping: orderGroup.values?.shippingValue ?? 0,
+      shipping_tier: orderGroup.orders[0]?.shipping?.label ?? '',
+      tax: 0,
+      transaction_id: orderGroup.code,
+
+      value: orderGroup.values?.totalValue ?? 0,
+      coupon,
+      items: orderGroup.orders
+        .flatMap(order => order.items)
+        .map(item => {
+          return {
+            item_category: '',
+            coupon,
+            // o item do pedido não carrega a marca, diferente do item do carrinho
+            item_brand: '',
+            item_id: item.productId,
+            item_name: item.name,
+            item_variant:
+              item.simpleProduct?.currentAttributes
+                ?.map(attribute => attribute.value.label)
+                .join(', ') ?? '',
+            price: item.unitValue,
+            quantity: item.quantity,
+          };
+        }),
+    },
+  });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uappi/public-sdk",
-  "version": "1.20.1",
+  "version": "1.22.0",
   "description": "Pacotes públicos para desenvolvimento do ecossistema Uappi",
   "main": "main.ts",
   "scripts": {