@uappi/public-sdk 1.0.0

package/modules/Api/types/index.ts

@@ -0,0 +1,459 @@
+// Response de API
+import type {
+  ApiResponse,
+  ApiStatus,
+  ApiMethod,
+  ApiContext,
+  ApiError,
+  ApiErrorData,
+} from './context/api-config.types';
+import type {
+  ApiParams,
+  ApiParamsCondition,
+  ApiParamsConditionGroup,
+  ApiParamsMeta,
+  ApiParamsOrder,
+} from './context/api-params.types';
+import type {
+  Attribute,
+  AttributeValue,
+  Combination,
+  ValueList,
+  Variations,
+  CurrentAttribute,
+} from './endpoints/attribute/attribute.interfaces';
+import type { Banner, Banners } from './endpoints/banner/banner.interfaces';
+import type {
+  BrandFields,
+  BrandConditions,
+  BrandOrders,
+} from './endpoints/brand/brand-field.types';
+import type { Brand, BrandItem } from './endpoints/brand/brand.interfaces';
+import type {
+  CartCustomer,
+  CartResponse,
+  DeleteCartRequest,
+  UpsertCartRequest,
+  UpsertCartItem,
+  AddressToCartRequest,
+  AddressesToCartRequest,
+  AddressToCartResponse,
+  BuyCartRequest,
+  BuyCartResponse,
+} from './endpoints/cart/cart.interfaces';
+import type {
+  AddressToCartType,
+  CartErrorCode,
+} from './endpoints/cart/cart.types';
+import type { CountryResponse } from './endpoints/common/common.interfaces';
+import type { ContextType } from './endpoints/context/context.types';
+import type {
+  CountryAlpha2,
+  CountryAlpha3,
+  CountryName,
+  CountryPhoneCode,
+  StateCode,
+  StateName,
+} from './endpoints/country/country.types';
+import type {
+  AddCouponRequest,
+  Coupon,
+} from './endpoints/coupon/coupon.interfaces';
+import type { CustomerErrorCode } from './endpoints/customer/customer-erros';
+import type {
+  CustomerConditionFields,
+  CustomerFields,
+  CustomerSortFields,
+  CustomerOrderGroupConditionFields,
+  CustomerOrderGroupFields,
+  CustomerOrderGroupSortFields,
+  CustomerOrderItemHistoryConditionFields,
+  CustomerOrderItemHistorySortFields,
+  CustomerHistoryConditionFields,
+  CustomerHistorySortFields,
+} from './endpoints/customer/customer-obsearch';
+import type {
+  UpdateCustomer,
+  ChangePasswordCustomerAuthenticated,
+  ChangePasswordCustomerByCode,
+  CheckCustomer,
+  CheckCustomerResponse,
+  PasswordRecoveryCustomer,
+  CustomerResponse,
+  SigninCustomerByDocument,
+  SigninCustomerByEmail,
+  SignupCustomer,
+  ResponseSigninCustomer,
+  CustomerDocument,
+  UpsertCustomerAddressRequest,
+  CustomerAddressResponse,
+  CustomerAddressesResponse,
+  CustomerOrderPayment,
+  CustomerOrderResponse,
+  CustomerOrderItem,
+  CustomerOrderItemHistoriesResponse,
+  CustomerOrderItemHistoryResponse,
+  CustomerOrdersResponse,
+  CustomerHistory,
+  CustomerHistoryResponse,
+  AddCustomerToNewsletterRequest,
+  AddCustomerToNewsletterResponse,
+  UpdateCustomerDocument,
+  UpdateCustomerDocumentResponse
+} from './endpoints/customer/customer.interfaces';
+import type {
+  CustomerGender,
+  CustomerOrigin,
+} from './endpoints/customer/customer.types';
+import type { Descriptions } from './endpoints/description/description.interfaces';
+import type { Discount } from './endpoints/discounts/discounts.interfaces';
+import type { DiscountType } from './endpoints/discounts/discounts.types';
+import type { TypeFilter } from './endpoints/filters/filter.type';
+import type {
+  Filter,
+  PriceFilter,
+  FilterValue,
+} from './endpoints/filters/filters.interfaces';
+import type {
+  InterestType,
+  RequestInterest,
+  ResponseInterest,
+} from './endpoints/interest/interest.interfaces';
+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 { Page } from './endpoints/page/page.interfaces';
+import type { Pagination } from './endpoints/pagination/pagination.interfaces';
+import type {
+  PairOffer,
+  PairOfferResponse,
+} from './endpoints/pair-offer/pair-offer.interfaces';
+import type {
+  Payment,
+  PaymentConfiguration,
+  PaymentOption,
+  PaymentResponse,
+  PaymentType,
+  CardFlags,
+  PaymentConditionsRequest,
+  PaymentConditionsResponse,
+} from './endpoints/payment/payment.interfaces';
+import type {
+  ConfigurationCode,
+  PaymentCode,
+} from './endpoints/payment/payment.types';
+import type {
+  ProductFields,
+  ProductConditionFields,
+  ProductSortFields,
+} from './endpoints/product/product-obsearch.types';
+import type {
+  Product,
+  ProductCategory,
+  ProductDimension,
+  ProductFlags,
+  ProductPrice,
+  Stock,
+  ProductInstallment,
+} from './endpoints/product/product.interfaces';
+import type {
+  ProductStatus,
+  ProductType,
+} from './endpoints/product/product.types';
+import type {
+  ProductCommentConditionFields,
+  ProductCommentFields,
+  ProductCommentSortFields,
+} from './endpoints/product-comment/product-comment-obsearch.types';
+import type {
+  ProductComment,
+  CreateProductComment,
+  ProductCommentsResponse,
+} from './endpoints/product-comment/product-comment.interfaces';
+import type { Redirect } from './endpoints/redirect/redirect.interfaces';
+import type {
+  ReviewConditionFields,
+  ReviewSortFields,
+  ReviewFields,
+} from './endpoints/review/review-obsearch.types';
+import type {
+  ProductReviewRequest,
+  ProductReviewResponse,
+  ProductReview,
+} from './endpoints/review/review.interfaces';
+import type { Seal, SealSetting } from './endpoints/seal/seal.interfaces';
+import type { Seals } from './endpoints/seal/seal.types';
+import type { Search } from './endpoints/search/search.interfaces';
+import type { Seo } from './endpoints/seo/seo.interfaces';
+import type {
+  ShippingOption,
+  QuoteGroupProduct,
+  ShippingOptionProduct,
+  QuoteGroupProductItem,
+  ShipmentQuoteCartRequest,
+  ShipmentQuoteProductRequest,
+  ShipmentQuoteProductResponse,
+  SelectShipimentRequest,
+} from './endpoints/shipment/shipment.interfaces';
+import type { TitleType } from './endpoints/showcase/showcase.enums';
+import type { Showcase } from './endpoints/showcase/showcase.interfaces';
+import type { SimpleProduct } from './endpoints/simple-product/simple-product.interfaces';
+import type { Storage } from './endpoints/storage/storage.interfaces';
+import type {
+  UrlBrand,
+  UrlListing,
+  UrlMenu,
+  UrlPage,
+  UrlProduct,
+} from './endpoints/url/url.interfaces';
+import type {
+  WalletConditionFields,
+  WalletSortFields,
+} from './endpoints/wallet/wallet-obsearch';
+import type {
+  WalletTransaction,
+  WalletTransactionResponse,
+  ClaimGiftCardRequest,
+  ClaimGiftCardResponse,
+} from './endpoints/wallet/wallet.interfaces';
+import type { ZipcodeResponse } from './endpoints/zipcode/zipcode.interfaces';
+
+import type { TemplateResponse } from './endpoints/template/template.interfaces';
+
+import type { UpsellResponse, Upsell } from './endpoints/upsell/upsell.interfaces';
+import type { PriceRule } from './endpoints/price/price.interfaces';
+
+import type { RedirectRequest, OauthType } from './endpoints/third-party/oauth.interfaces';
+
+export type {
+  // Config da useApi
+  ApiResponse,
+  ApiStatus,
+  ApiMethod,
+  ApiError,
+  ApiErrorData,
+  ApiContext,
+  ApiParams,
+  ApiParamsCondition,
+  ApiParamsConditionGroup,
+  ApiParamsMeta,
+  ApiParamsOrder,
+
+  // Endpoints
+  TemplateResponse,
+
+  // TODO organizar por modulos
+  ContextType,
+  DiscountType,
+  Discount,
+
+  // Types
+  Target,
+  Type,
+  ProductStatus,
+  ProductType,
+  TitleType,
+
+  // Interfaces
+
+  // Atributos
+  Attribute,
+  AttributeValue,
+  Combination,
+  ValueList,
+  Variations,
+  CurrentAttribute,
+  WalletConditionFields,
+  WalletSortFields,
+  WalletTransaction,
+  WalletTransactionResponse,
+  ClaimGiftCardRequest,
+  ClaimGiftCardResponse,
+  RedirectRequest,
+  OauthType,
+
+  // banner
+  Banner,
+  Banners,
+  Seo,
+  Media,
+  Menu,
+  MenuItem,
+  Descriptions,
+  Showcase,
+
+  // Marcas
+  Brand,
+  BrandItem,
+  BrandFields,
+  BrandConditions,
+  BrandOrders,
+
+  // Pagination
+  Pagination,
+
+  // Selos
+  Seal,
+  SealSetting,
+  Seals,
+
+  // Shipment
+  ShippingOption,
+  QuoteGroupProduct,
+  ShippingOptionProduct,
+  QuoteGroupProductItem,
+  ShipmentQuoteCartRequest,
+  ShipmentQuoteProductRequest,
+  ShipmentQuoteProductResponse,
+  SelectShipimentRequest,
+
+  // Avise-me/Sobconsulta = Interests
+  InterestType,
+  RequestInterest,
+  ResponseInterest,
+
+  // Compre junto
+  PairOffer,
+  PairOfferResponse,
+
+  // Avaliaçoes
+  ProductReviewRequest,
+  ProductReviewResponse,
+  ProductReview,
+  ReviewConditionFields,
+  ReviewSortFields,
+  ReviewFields,
+
+  // Filtros de listagem
+  TypeFilter,
+  Filter,
+  PriceFilter,
+  FilterValue,
+
+  // Institutional page
+  Page,
+
+  // Redirects
+  Redirect,
+
+  // Product
+  ProductFields,
+  ProductConditionFields,
+  ProductSortFields,
+  Product,
+  ProductCategory,
+  ProductDimension,
+  ProductFlags,
+  ProductPrice,
+  ProductInstallment,
+  Stock,
+  SimpleProduct,
+
+  // Product comment
+  ProductComment,
+  CreateProductComment,
+  ProductCommentsResponse,
+  ProductCommentConditionFields,
+  ProductCommentFields,
+  ProductCommentSortFields,
+
+  // Request das páginas
+  UrlMenu,
+  UrlBrand,
+  UrlListing,
+  UrlPage,
+  UrlProduct,
+
+  // Busca de produto
+  Search,
+
+  // Cart
+  CartCustomer,
+  CartResponse,
+  DeleteCartRequest,
+  UpsertCartRequest,
+  UpsertCartItem,
+  AddressToCartRequest,
+  AddressesToCartRequest,
+  AddressToCartType,
+  CartErrorCode,
+  AddressToCartResponse,
+  BuyCartRequest,
+  BuyCartResponse,
+
+  // Payment
+  ConfigurationCode,
+  PaymentCode,
+  Payment,
+  PaymentConfiguration,
+  PaymentOption,
+  PaymentResponse,
+  PaymentType,
+  CardFlags,
+  PaymentConditionsRequest,
+  PaymentConditionsResponse,
+
+  // Customer
+  UpdateCustomer,
+  ChangePasswordCustomerAuthenticated,
+  ChangePasswordCustomerByCode,
+  CheckCustomer,
+  CheckCustomerResponse,
+  PasswordRecoveryCustomer,
+  CustomerResponse,
+  SigninCustomerByDocument,
+  SigninCustomerByEmail,
+  ResponseSigninCustomer,
+  CustomerDocument,
+  SignupCustomer,
+  CustomerGender,
+  CustomerOrigin,
+  CustomerConditionFields,
+  CustomerFields,
+  CustomerSortFields,
+  CustomerOrderGroupConditionFields,
+  CustomerOrderGroupFields,
+  CustomerOrderGroupSortFields,
+  CustomerOrderItemHistoryConditionFields,
+  CustomerOrderItemHistorySortFields,
+  CustomerHistoryConditionFields,
+  CustomerHistorySortFields,
+  CustomerErrorCode,
+  UpsertCustomerAddressRequest,
+  CustomerAddressResponse,
+  CustomerAddressesResponse,
+  CustomerOrderPayment,
+  CustomerOrderResponse,
+  CustomerOrderItem,
+  CustomerOrderItemHistoriesResponse,
+  CustomerOrderItemHistoryResponse,
+  CustomerOrdersResponse,
+  CustomerHistory,
+  CustomerHistoryResponse,
+  AddCustomerToNewsletterRequest,
+  AddCustomerToNewsletterResponse,
+  UpdateCustomerDocument,
+  UpdateCustomerDocumentResponse,
+
+  // Order
+  Order,
+  OrderItem,
+  Storage,
+
+  // COUNTRY TYPES
+  CountryAlpha2,
+  CountryAlpha3,
+  CountryName,
+  CountryPhoneCode,
+  StateCode,
+  StateName,
+  ZipcodeResponse,
+  CountryResponse,
+  AddCouponRequest,
+  Coupon,
+
+  UpsellResponse,
+  Upsell,
+  PriceRule
+};

package/modules/Api/usePublicApi.ts

@@ -0,0 +1,68 @@
+import axios, { type AxiosError, AxiosHeaders } from 'axios';
+
+import type { ApiContext, ApiError, ApiErrorData } from './types';
+
+import { encodeWafNormalizer } from './paramsSerializer/encodeWafNormalizer';
+
+export async function usePublicApi<
+  ResponseType,
+  FieldOptions = '',
+  OrderOptions = '',
+  ConditionOptions = '',
+>(
+  apiContext: ApiContext<any, FieldOptions, OrderOptions, ConditionOptions>,
+): Promise<ResponseType>;
+
+export async function usePublicApi<
+  ResponseType,
+  RequestType = object,
+  FieldOptions = '',
+  OrderOptions = FieldOptions,
+  ConditionOptions = FieldOptions,
+>({
+  endpoint,
+  method = 'GET',
+  payload,
+  params,
+}: ApiContext<RequestType, FieldOptions, OrderOptions, ConditionOptions>) {
+  const headers = new AxiosHeaders({
+    'Uappi-Cookie-Name': 'token',
+    Accept: 'application/json',
+  });
+
+  if (
+    window.location.hostname === 'localhost' ||
+    window.location.hostname === '127.0.0.1'
+  )
+    headers.set('uappi-environment', 'development');
+
+  const axiosInstance = axios.create({
+    baseURL: `${window.location.protocol}//${window.location.host}/api/v3`,
+    headers,
+    paramsSerializer: {
+      encode: encodeWafNormalizer,
+    },
+  });
+
+  return axiosInstance<{ data: ResponseType; status: boolean }>(endpoint, {
+    method,
+    data: payload || undefined,
+    params,
+    withCredentials: true,
+  })
+    .then(({ data }) => {
+      return data.data;
+    })
+    .catch(e => {
+      const axiosError = e as AxiosError;
+      const apiErrorData = (
+        axiosError.response!.data as { data: ApiErrorData; status: boolean }
+      ).data;
+
+      throw {
+        message: apiErrorData.message || '',
+        errorCode: apiErrorData.errorCode,
+        status: axiosError.status,
+      } as ApiError;
+    });
+}

package/modules/Tracking/endpoints/BannerComposable.ts

@@ -0,0 +1,33 @@
+import publicApi from '../../Api';
+
+import { viewPromotion } from '../events/views/viewPromotion';
+
+import type { Banners } from '../../Api/types';
+
+export function listBanners<AdditionalParameters = []>(
+  codes: string,
+): Promise<Banners<AdditionalParameters>>;
+
+export function listBanners<AdditionalParameters = []>(
+  codes: Array<string>,
+): Promise<Array<Banners<AdditionalParameters>>>;
+
+export function listBanners<AdditionalParameters = []>(
+  codes: Array<string> | string,
+) {
+  if (Array.isArray(codes)) {
+    return publicApi.customization
+      .listBanners<AdditionalParameters>(codes)
+      .then(data => {
+        viewPromotion<AdditionalParameters>(data);
+        return data;
+      });
+  }
+
+  return publicApi.customization
+    .listBanners<AdditionalParameters>([codes])
+    .then(data => {
+      viewPromotion(data);
+      return data[0];
+    });
+}

package/modules/Tracking/endpoints/CartComposable.ts

@@ -0,0 +1,75 @@
+import publicApi from '../../Api';
+
+import { addShippingInfoAction } from '../events/actions/addShippingInfo';
+import { addToCartAction } from '../events/actions/addToCart';
+import { purchaseAction } from '../events/actions/purchase';
+import { removeFromCartAction } from '../events/actions/removeFromCart';
+import { shippingCalculationAction } from '../events/actions/shippingCalculation';
+import { upsertToCartAction } from '../events/actions/upsertToCart';
+
+import type { UpsertTrackingCartRequest } from '../types';
+import type {
+  BuyCartRequest,
+  CartResponse,
+  DeleteCartRequest,
+  SelectShipimentRequest,
+  ShipmentQuoteCartRequest,
+  UpsertCartRequest,
+} from '../../Api/types';
+
+export function listDetail() {
+  return publicApi.cart.listDetail().then(data => {
+    return data;
+  });
+}
+
+export function addProduct(payload: UpsertTrackingCartRequest) {
+  return publicApi.cart.addProduct(payload as UpsertCartRequest).then(data => {
+    addToCartAction(payload, data);
+    return data;
+  });
+}
+
+export function upsertProduct(payload: UpsertTrackingCartRequest) {
+  return publicApi.cart
+    .upsertProduct(payload as UpsertCartRequest)
+    .then(data => {
+      upsertToCartAction(payload, data);
+      return data;
+    });
+}
+
+export function deleteProduct(
+  payload: DeleteCartRequest,
+  oldCartResponse: CartResponse,
+) {
+  return publicApi.cart.deleteProduct(payload).then(data => {
+    removeFromCartAction(payload, data, oldCartResponse);
+    return data;
+  });
+}
+
+export function selectShipment(payload: SelectShipimentRequest) {
+  return publicApi.cart.selectShipment(payload).then(data => {
+    addShippingInfoAction(data);
+    return data;
+  });
+}
+
+export function shipmentQuote(payload: ShipmentQuoteCartRequest) {
+  return publicApi.cart.shipmentQuote(payload).then(data => {
+    shippingCalculationAction();
+    return data;
+  });
+}
+
+export function buy(
+  payload: BuyCartRequest,
+  paymentMethod: string,
+  cartResponse: CartResponse,
+) {
+  return publicApi.cart.buy(payload).then(data => {
+    purchaseAction(paymentMethod, cartResponse);
+    return data;
+  });
+}

package/modules/Tracking/endpoints/CustomerComposable.ts

@@ -0,0 +1,68 @@
+import publicApi from '../../Api';
+
+import type { TrackingCustomerFields } from './types';
+
+import { customerProfileAction } from '../events/actions/customerProfile';
+import { generateLead } from '../events/actions/generateLead';
+import { loginAction } from '../events/actions/login';
+import { signupAction } from '../events/actions/signup';
+
+import type { CustomerLead } from '../types';
+import type {
+  ApiParams,
+  CustomerConditionFields,
+  CustomerSortFields,
+  SigninCustomerByDocument,
+  SigninCustomerByEmail,
+  SignupCustomer,
+} from '../../Api/types';
+
+export function detail(
+  options?: Pick<
+    ApiParams<
+      TrackingCustomerFields,
+      CustomerSortFields,
+      CustomerConditionFields
+    >,
+    'condition' | 'fields' | 'order'
+  >,
+) {
+  return publicApi.customer
+    .detail({
+      ...options,
+      fields: ['addresses', 'flags'],
+    })
+    .then(data => {
+      customerProfileAction(data);
+
+      return data;
+    });
+}
+
+export function signup(payload: SignupCustomer) {
+  return publicApi.customer.signup(payload).then(data => {
+    signupAction();
+    return data;
+  });
+}
+
+export function signinByEmail(payload: SigninCustomerByEmail) {
+  return publicApi.customer.signinByEmail(payload).then(data => {
+    loginAction();
+    return data;
+  });
+}
+
+export function signinByDocument(payload: SigninCustomerByDocument) {
+  return publicApi.customer.signinByDocument(payload).then(data => {
+    loginAction();
+    return data;
+  });
+}
+
+export function addNewsletter(payload: CustomerLead) {
+  return publicApi.customer.addNewsletter(payload).then(data => {
+    generateLead(payload);
+    return data;
+  });
+}

package/modules/Tracking/endpoints/ProductQuoteShipment.ts

@@ -0,0 +1,14 @@
+import publicApi from '../../Api';
+
+import { shippingCalculationAction } from '../events/actions/shippingCalculation';
+
+import type { ApiParams } from '../../Api/types';
+
+export async function listShipmentQuoteProduct(
+  payload: Pick<ApiParams, 'targetCountryCode' | 'targetZipCode' | 'items'>,
+) {
+  return publicApi.product.listShipmentQuoteProduct(payload).then(data => {
+    shippingCalculationAction();
+    return data;
+  });
+}