@uappi/public-sdk 1.0.0

package/modules/Api/endpoints/SearchComposable.ts

@@ -0,0 +1,27 @@
+import { usePublicApi } from '..';
+
+import type {
+  ApiParams,
+  ProductFields,
+  ProductConditionFields,
+  ProductSortFields,
+  Search,
+} from '../types';
+
+export function getSearch(
+  term: string,
+  options?: Pick<
+    ApiParams<ProductFields, ProductSortFields, ProductConditionFields>,
+    'condition' | 'fields' | 'limit' | 'meta' | 'offset' | 'order'
+  >,
+) {
+  return usePublicApi<
+    Search,
+    ProductFields,
+    ProductSortFields,
+    ProductConditionFields
+  >({
+    endpoint: `/publics/products/search/${term}`,
+    params: options,
+  });
+}

package/modules/Api/endpoints/ShowcaseComposable.ts

@@ -0,0 +1,45 @@
+import { usePublicApi } from '..';
+
+import type { Showcase, ApiParams, ProductFields } from '../types';
+
+export function listShowcase(
+  codes: string,
+  options?: Pick<
+    ApiParams<ProductFields>,
+    'condition' | 'fields' | 'meta' | 'order'
+  >,
+): Promise<Showcase>;
+
+export function listShowcase(
+  codes: Array<string>,
+  options?: Pick<
+    ApiParams<ProductFields>,
+    'condition' | 'fields' | 'meta' | 'order'
+  >,
+): Promise<Array<Showcase>>;
+
+export function listShowcase(
+  codes: Array<string> | string,
+  options?: Pick<
+    ApiParams<ProductFields>,
+    'condition' | 'fields' | 'meta' | 'order'
+  >,
+) {
+  if (Array.isArray(codes)) {
+    return usePublicApi<Array<Showcase>, ProductFields>({
+      endpoint: '/publics/template/showcases/',
+      params: {
+        codes,
+        ...options,
+      },
+    });
+  }
+
+  return usePublicApi<Array<Showcase>, ProductFields>({
+    endpoint: '/publics/template/showcases/',
+    params: {
+      codes: [codes],
+      ...options,
+    },
+  }).then(data => data[0]);
+}

package/modules/Api/endpoints/TemplateComposable.ts

@@ -0,0 +1,8 @@
+import { usePublicApi } from '..';
+import type { TemplateResponse } from "../types";
+
+export function listTemplateSettings<Setting>(uri: string) {
+  return usePublicApi<TemplateResponse<Setting>>({
+    endpoint: `/publics/template/custom-settings?uri=${uri}`,
+  });
+}

package/modules/Api/endpoints/ThirdPartyComposable.ts

@@ -0,0 +1,14 @@
+import { usePublicApi } from '..';
+
+import type {
+  RedirectRequest,
+  OauthType,
+} from '../types';
+
+export function oauthRedirect(type: OauthType, payload: RedirectRequest) {
+  return usePublicApi<string, RedirectRequest>({
+    endpoint: `/third-party/${type}/oauth/redirect`,
+    method: 'GET',
+    params: payload,
+  });
+}

package/modules/Api/endpoints/UpsellComposable.ts

@@ -0,0 +1,18 @@
+import { usePublicApi } from '..';
+
+import type {
+  ApiParams,
+  ProductFields,
+  UpsellResponse,
+} from '../types';
+
+export function upsells(
+  location: string,
+  options?: Pick<ApiParams<ProductFields>, 'fields'>,
+) {
+  options
+  return usePublicApi<UpsellResponse, ProductFields>({
+    endpoint: `/cart/upsell/${location}`,
+    params: options,
+  });
+}

package/modules/Api/endpoints/UrlComposable.ts

@@ -0,0 +1,26 @@
+import { usePublicApi } from '..';
+
+import type {
+  ApiParams,
+  ProductFields,
+  ProductConditionFields,
+  ProductSortFields,
+} from '../types';
+
+export function getUrl<UrlType>(
+  path: string,
+  options?: Pick<
+    ApiParams<ProductFields, ProductSortFields, ProductConditionFields>,
+    'condition' | 'fields' | 'limit' | 'offset' | 'meta' | 'order'
+  >,
+) {
+  return usePublicApi<
+    UrlType,
+    ProductFields,
+    ProductSortFields,
+    ProductConditionFields
+  >({
+    endpoint: `/publics/url/?url=${path}`,
+    params: options,
+  });
+}

package/modules/Api/endpoints/VariationComposable.ts

@@ -0,0 +1,36 @@
+import { usePublicApi } from '..';
+
+import type {
+  ProductFields,
+  ProductSortFields,
+  ProductConditionFields,
+  ApiParams,
+  Product,
+} from '../types';
+
+interface VariationData {
+  productId: number;
+  variations: Array<number> | number;
+}
+
+export function listVariation(
+  variationData: VariationData,
+  options?: Pick<
+    ApiParams<ProductFields, ProductSortFields, ProductConditionFields>,
+    'condition' | 'fields' | 'meta'
+  >,
+) {
+  const variationIds: string = Array.isArray(variationData.variations)
+    ? variationData.variations.join('-')
+    : variationData.variations.toString();
+
+  return usePublicApi<
+    Product,
+    ProductFields,
+    ProductSortFields,
+    ProductConditionFields
+  >({
+    endpoint: `/publics/products/${variationData.productId}/variation/${variationIds}`,
+    params: options,
+  });
+}

package/modules/Api/endpoints/WalletComposable.ts

@@ -0,0 +1,36 @@
+import { usePublicApi } from '../usePublicApi';
+
+import type {
+  ApiParams,
+  ClaimGiftCardRequest,
+  ClaimGiftCardResponse,
+  WalletConditionFields,
+  WalletSortFields,
+  WalletTransactionResponse,
+} from '../types';
+
+export function listWalletTransaction(
+  options?: Pick<
+    ApiParams<'', WalletSortFields, WalletConditionFields>,
+    'condition' | 'order' | 'limit' | 'offset'
+  >,
+) {
+  return usePublicApi<
+    WalletTransactionResponse,
+    '',
+    WalletSortFields,
+    WalletConditionFields
+  >({
+    endpoint: '/customer/wallet/transaction',
+    method: 'GET',
+    params: options,
+  });
+}
+
+export function claimGiftCard(payload: ClaimGiftCardRequest) {
+  return usePublicApi<ClaimGiftCardResponse>({
+    endpoint: '/customer/gift-cards/link',
+    method: 'POST',
+    payload,
+  });
+}

package/modules/Api/endpoints/ZipcodeComposable.ts

@@ -0,0 +1,10 @@
+import { usePublicApi } from '..';
+
+import type { ZipcodeResponse } from '../types';
+
+export function listZipcode(zipcode: string) {
+  return usePublicApi<ZipcodeResponse>({
+    endpoint: `/shipping/zipcode/consult/BRA/${zipcode}`,
+    method: 'GET',
+  });
+}

package/modules/Api/index.ts

@@ -0,0 +1,194 @@
+import { listBanners } from './endpoints/BannerComposable';
+import { listBrands } from './endpoints/BrandComposable';
+import {
+  addProduct,
+  deleteProduct,
+  listDetail,
+  shipmentQuote,
+  upsertProduct,
+  selectShipment,
+  applyAddresses,
+  applyWallet,
+  deleteWallet,
+  listPayments,
+  buy,
+  applyPoint,
+  deletePoint,
+  recovery
+} from './endpoints/CartComposable';
+import {
+  listContries,
+  listCardFlags,
+  countryDetail,
+} from './endpoints/CommonComposable';
+import { addCoupon, deleteCoupon } from './endpoints/CouponComposable';
+import {
+  changePasswordByAuthenticated,
+  changePasswordByCode,
+  check,
+  createAddress,
+  deleteAddress,
+  detail,
+  listAddress,
+  passwordRecovery,
+  signinByDocument,
+  signinByEmail,
+  signup,
+  update,
+  updatePrimaryAddress,
+  updateAddress,
+  detailOrderGroup,
+  listOrderGroups,
+  deleteNewsletter,
+  listOrderItemHistory,
+  listCustomerHistory,
+  addNewsletter,
+  updateDocument
+} from './endpoints/CustomerComposable';
+import { createInterest } from './endpoints/InterestComposable';
+import { loggout } from './endpoints/LoggoutComposable';
+import { listMenu } from './endpoints/MenuComposable';
+import { listPairOffers } from './endpoints/PairOfferComposable';
+import { paymentConditions } from './endpoints/PaymentComposable';
+import {
+  deleteProductComment,
+  createProductComment,
+  listProductComments,
+} from './endpoints/ProductCommentComposable';
+import { listShipmentQuoteProduct } from './endpoints/ProductQuoteShipment';
+import {
+  createProductReview,
+  listProductReview,
+  listStoreReview,
+  listCustomerReview,
+} from './endpoints/ReviewComposable';
+import { getSearch } from './endpoints/SearchComposable';
+import { listShowcase } from './endpoints/ShowcaseComposable';
+import { getUrl } from './endpoints/UrlComposable';
+import { listVariation } from './endpoints/VariationComposable';
+import {
+  listWalletTransaction,
+  claimGiftCard,
+} from './endpoints/WalletComposable';
+import { listZipcode } from './endpoints/ZipcodeComposable';
+import { listTemplateSettings } from './endpoints/TemplateComposable';
+import { upsells } from './endpoints/UpsellComposable'
+import { contact } from './endpoints/PublicComposable'
+import { oauthRedirect } from './endpoints/ThirdPartyComposable';
+
+
+import { usePublicApi } from './usePublicApi';
+
+const thirdParty = {
+  oauthRedirect
+}
+
+const customization = {
+  listShowcase,
+  listBanners,
+  listMenu,
+  listTemplateSettings
+};
+
+const customer = {
+  addNewsletter,
+  createProductReview,
+  listProductReview,
+  listStoreReview,
+  createInterest,
+  changePasswordByAuthenticated,
+  changePasswordByCode,
+  check,
+  createAddress,
+  deleteAddress,
+  detail,
+  listAddress,
+  passwordRecovery,
+  signinByDocument,
+  signinByEmail,
+  signup,
+  update,
+  updatePrimaryAddress,
+  updateAddress,
+  loggout,
+  detailOrderGroup,
+  listOrderGroups,
+  deleteNewsletter,
+  listOrderItemHistory,
+  listCustomerHistory,
+  listCustomerReview,
+  listWalletTransaction,
+  claimGiftCard,
+  updateDocument,
+};
+
+const cart = {
+  addProduct,
+  deleteProduct,
+  listDetail,
+  shipmentQuote,
+  upsertProduct,
+  selectShipment,
+  applyAddresses,
+  listPayments,
+  buy,
+  paymentConditions,
+  upsells,
+  recovery
+};
+
+const product = {
+  listBrands,
+  listVariation,
+  getUrl,
+  getSearch,
+  listShipmentQuoteProduct,
+  deleteProductComment,
+  createProductComment,
+  listProductComments,
+};
+
+const common = {
+  listZipcode,
+  listContries,
+  countryDetail,
+  listCardFlags,
+};
+
+const promotional = {
+  listPairOffers,
+  addCoupon,
+  deleteCoupon,
+  applyWallet,
+  deleteWallet,
+  applyPoint,
+  deletePoint,
+};
+
+const notify = {
+  contact
+}
+
+export {
+  usePublicApi,
+  common,
+  customer,
+  customization,
+  cart,
+  product,
+  promotional,
+  notify,
+  thirdParty
+};
+export default {
+  usePublicApi,
+
+  common,
+  customer,
+  customization,
+  cart,
+  product,
+  promotional,
+  notify,
+  thirdParty
+};

package/modules/Api/paramsSerializer/encodeWafNormalizer.ts

@@ -0,0 +1,7 @@
+/**
+ * Normalizador de parametros/filtros para transpassar a regra EVA081 do Sucuri Web Firewall
+ *
+ */
+export function encodeWafNormalizer(param: string) {
+  return String(param).replace(/\[/g, '_:').replace(/\]/g, ':_');
+}

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

@@ -0,0 +1,68 @@
+import type { Ref } from 'vue';
+
+import type { ApiParams, CustomerErrorCode } from '..';
+
+export type ApiStatus = 'pending' | 'success' | 'error';
+
+export type ApiMethod =
+  | 'POST'
+  | 'GET'
+  | 'PUT'
+  | 'PATCH'
+  | 'DELETE'
+  | 'post'
+  | 'get'
+  | 'put'
+  | 'patch'
+  | 'delete';
+
+export interface ApiResponse<ResponseType> {
+  data: Ref<ResponseType | undefined>;
+  status: Ref<ApiStatus>;
+  //eslint-disable-next-line
+  error: Ref<any | null>;
+  fetchData: () => Promise<void>;
+}
+export interface ApiContext<
+  RequestType,
+  FieldOptions = '',
+  OrderOptions = FieldOptions,
+  ConditionOptions = FieldOptions,
+> {
+  endpoint: string;
+  method?: ApiMethod;
+  payload?: RequestType;
+  params?: ApiParams<FieldOptions, OrderOptions, ConditionOptions>;
+}
+
+export interface ApiError {
+  message: string;
+  errorCode: ApiErrorData['errorCode'];
+  status: number;
+}
+
+export interface ApiErrorData {
+  code: number;
+  datails: [];
+  errorCode:
+    | 'BAD_REQUEST'
+    | 'UNAUTHORIZED'
+    | 'PAYMENT_REQUIRED'
+    | 'FORBIDDEN'
+    | 'NOT_FOUND'
+    | 'METHOD_NOT_ALLOWED	Método não permitido'
+    | 'NOT_ACCEPTABLE'
+    | 'PROXY_AUTHENTICATION_REQUIRED'
+    | 'REQUEST_TIME_OUT'
+    | 'CONFLICT'
+    | 'UNSUPPORTED_MIDIA_TYPE'
+    | 'INTERNAL_SERVER_ERROR'
+    | 'NOT_IMPLEMENTED'
+    | 'BAD_GATEWAY'
+    | 'SERVICE_UNAVAILABLE'
+    | 'GATEWAY_TIME_OUT'
+    | 'UAPPI_TOOLS_ITEM_EVALUATED'
+    | 'UAPPI_TOOLS_REVIEW_NOT_FOUND'
+    | CustomerErrorCode;
+  message: string;
+}

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

@@ -0,0 +1,74 @@
+export interface ApiParams<
+  FieldOptions = '',
+  OrderOptions = '',
+  ConditionOptions = '',
+> {
+  codes?: Array<string>;
+  limit?: number;
+  offset?: number;
+  fields?: Array<FieldOptions>;
+  order?: Array<ApiParamsOrder<OrderOptions>>;
+  condition?: ApiParamsConditionGroup<ConditionOptions>;
+  meta?: ApiParamsMeta;
+
+  // for product quote
+  targetZipCode?: string;
+  targetCountryCode?: string;
+  items?: Array<{ productId: number; quantity: number }>;
+
+  variationMap?: Record<string, number>;
+
+  loginUrl?: string;
+  registerUrl?: string;
+}
+
+export interface ApiParamsOrder<FieldOptions> {
+  field: FieldOptions;
+  order: 'ASC' | 'DESC';
+}
+
+export interface ApiParamsConditionGroup<FieldOptions> {
+  type: 'AND' | 'OR';
+  conditions: Array<
+    ApiParamsConditionGroup<FieldOptions> | ApiParamsCondition<FieldOptions>
+  >;
+}
+
+export interface ApiParamsCondition<FieldOptions> {
+  field: FieldOptions;
+  type?: undefined;
+  value:
+    | boolean
+    | string
+    | number
+    | Array<string>
+    | Array<number>
+    | null
+    | undefined;
+  operator?:
+    | '='
+    | '!='
+    | '>'
+    | '>='
+    | '<'
+    | '<='
+    | 'in'
+    | 'notIn'
+    | 'like'
+    | 'between';
+}
+
+export interface ApiParamsMeta {
+  dimensions?: {
+    size?: 'Meter' | 'Centimeter';
+    weight?: 'Gram' | 'Kilogram';
+  };
+  priceParameters?: {
+    [productId: string]: {
+      code?: string;
+      quantity?: number;
+      upsellId?: number;
+      productPairOfferId?: number;
+    };
+  };
+}

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

@@ -0,0 +1,42 @@
+export interface Variations {
+  attributes: Array<Attribute>;
+  combinations: Array<Combination>;
+  valueList: ValueList;
+}
+
+export type ValueList = Array<number>;
+export interface Combination {
+  active: boolean;
+  stock: number;
+  combination: Array<number>;
+  comparisonPrice: number;
+  medias: Array<never>;
+  name: string;
+  productId: number;
+  sku: string;
+  url: string;
+  currentAttributes: Array<CurrentAttribute>;
+}
+export interface Attribute {
+  displayName: string;
+  id: number;
+  includeSample: boolean;
+  name: string;
+  sampleAsProductImage: boolean;
+  values: Array<AttributeValue>;
+}
+
+export interface AttributeValue {
+  color: null;
+  id: number;
+  image: null | string;
+  label: string;
+  order: number;
+  originalImage: null | string;
+}
+
+export interface CurrentAttribute {
+  id: number;
+  name: string;
+  value: AttributeValue;
+}

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

@@ -0,0 +1,45 @@
+export interface Banners<AdditionalParameters = []> {
+  id: number;
+  code: string;
+  title: string;
+  description: string;
+  desktopWidth: string;
+  desktopHeight: string;
+  tabletWidth: string;
+  tabletHeight: string;
+  mobileWidth: string;
+  mobileHeight: string;
+  createdAt: string;
+  additionalParameter: Array<string>;
+  banners: [] | Array<Banner<AdditionalParameters>>;
+}
+export interface Banner<AdditionalParameters> {
+  id: number;
+  templateBannerGroupId: number;
+  name: string;
+  alt: string;
+  desktopImage: string;
+  desktopOriginalImage: string;
+  tabletImage: string;
+  tabletOriginalImage: string;
+  mobileImage: string;
+  mobileOriginalImage: string;
+  desktopUrl: string;
+  tabletUrl: string;
+  mobileUrl: string;
+  desktopWidth: string;
+  desktopHeight: string;
+  tabletWidth: string;
+  tabletHeight: string;
+  mobileWidth: string;
+  mobileHeight: string;
+  active: boolean;
+  order: number;
+  scheduling: {
+    startDate: string;
+    endDate: null | string;
+    id: number;
+  };
+  createdAt: string;
+  additionalParameter: AdditionalParameters;
+}

package/modules/Api/types/endpoints/brand/brand-field.types.ts

@@ -0,0 +1,3 @@
+export type BrandFields = 'bannerGroups' | 'linkedTradePolicies' | 'urls';
+export type BrandOrders = 'id' | 'name';
+export type BrandConditions = 'name' | 'code' | 'active';

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

@@ -0,0 +1,23 @@
+import type { Descriptions, Redirect, Pagination } from '../..';
+
+export interface Brand {
+  registers: Array<BrandItem>;
+  pagination: Pagination;
+}
+
+export interface BrandItem {
+  id: number;
+  code: string;
+  name: string;
+  logo: string;
+  originalLogo: string;
+  productOrdering: string;
+  active: boolean;
+  createdAt: string;
+  updatedAt: Date;
+  linkedTradePolicies: Array<number>;
+  url: null | string;
+  urls: null | Array<Redirect>;
+  urlsRemove: null | Array<string>;
+  description: null | Descriptions;
+}