@faststore/api 1.7.30 → 1.7.33

package/dist/platforms/vtex/clients/search/types/AttributeSearchResult.d.ts

@@ -1,56 +1,30 @@
-export interface AttributeSearchResult {
-    total: number;
-    pagination: Pagination;
-    sampling: boolean;
-    translated: boolean;
-    locale: string;
-    query: string;
-    operator: string;
-    fuzzy: string;
-    attributes: Attribute[] | null;
+declare type FilterType = 'PRICERANGE' | 'TEXT' | 'NUMBER' | 'CATEGORYTREE';
+export interface FacetSearchResult {
+    facets: Facet[];
+    breadcrumb: Breadcrumb;
 }
-export interface Attribute {
-    ids: string[];
-    visible: boolean;
-    values: Value[];
-    active: boolean;
-    key: string;
-    originalKey: string;
-    label: string;
-    originalLabel: string;
-    type: string;
-    minValue?: number;
-    maxValue?: number;
-    templateURL?: string;
-    proxyURL?: string;
+export interface Facet {
+    type: FilterType;
+    name: string;
+    hidden: boolean;
+    values: FacetValue[];
+    quantity?: number;
 }
-export interface Value {
-    count: number;
-    active: boolean;
-    key?: string;
-    label?: string;
+interface FacetValue {
+    quantity: number;
+    name: string;
+    key: string;
+    value: string;
+    selected?: boolean;
+    range?: {
+        from: number;
+        to: number;
+    };
+    children?: FacetValue[];
     id?: string;
-    originalKey?: string;
-    originalLabel?: string;
-    proxyURL: string;
-    from?: string;
-    to?: string;
-}
-export interface Pagination {
-    count: number;
-    current: Current;
-    before: any[];
-    after: any[];
-    perPage: number;
-    next: First;
-    previous: First;
-    first: First;
-    last: First;
-}
-export interface Current {
-    index: number;
-    proxyURL: string;
 }
-export interface First {
-    index: number;
+interface Breadcrumb {
+    href: string;
+    name: string;
 }
+export {};

package/dist/platforms/vtex/clients/search/types/FacetSearchResult.d.ts

@@ -0,0 +1,31 @@
+declare type FilterType = 'PRICERANGE' | 'TEXT' | 'NUMBER' | 'CATEGORYTREE';
+export interface FacetSearchResult {
+    facets: Facet[];
+    breadcrumb: Breadcrumb;
+}
+export interface Facet {
+    type: FilterType;
+    name: string;
+    hidden: boolean;
+    values: FacetValue[];
+    quantity?: number;
+    key?: string;
+}
+export interface FacetValue {
+    quantity: number;
+    name: string;
+    key: string;
+    value: string;
+    selected?: boolean;
+    range?: {
+        from: number;
+        to: number;
+    };
+    children?: FacetValue[];
+    id?: string;
+}
+interface Breadcrumb {
+    href: string;
+    name: string;
+}
+export {};

package/dist/platforms/vtex/clients/search/types/ProductSearchResult.d.ts

@@ -1,5 +1,8 @@
 export interface ProductSearchResult {
-    total: number;
+    /**
+     * @description Total of products.
+     */
+    recordsFiltered: number;
     products: Product[];
     pagination: Pagination;
     sampling: boolean;
@@ -7,193 +10,182 @@ export interface ProductSearchResult {
     translated: boolean;
     locale: string;
     query: string;
-    operator: string;
+    operator: 'and' | 'or';
     fuzzy: string;
     correction: Correction;
 }
-export interface Correction {
+interface Correction {
     misspelled: boolean;
 }
-export interface Options {
+interface Options {
     sorts: Sort[];
     counts: Count[];
 }
-export interface Count {
+interface Count {
     count: number;
     proxyURL: string;
 }
-export interface Sort {
+interface Sort {
     field: string;
     order: string;
     active?: boolean;
     proxyURL: string;
 }
-export interface Pagination {
+interface Pagination {
     count: number;
-    current: Current;
-    before: any[];
-    after: Current[];
+    current: Page;
+    before: Page[];
+    after: Page[];
     perPage: number;
-    next: Current;
-    previous: First;
-    first: First;
-    last: Current;
+    next: Page;
+    previous: Page;
+    first: Page;
+    last: Page;
 }
-export interface Current {
+interface Page {
     index: number;
     proxyURL: string;
 }
-export interface First {
-    index: number;
-}
 export interface Product {
-    unitMultiplier: number;
-    year: number;
-    extraData: ExtraDatum[];
-    release: number;
-    discount: number;
-    reference: string;
-    split: Split;
-    collections: Collection[];
-    price: number;
-    customSort: number;
-    stickers: Sticker[];
-    id: string;
-    stock: number;
+    productId: string;
+    productName: string;
     brand: string;
-    availableTradePolicies: string[];
-    categoryTrees: CategoryTree[];
-    images: Image[];
-    locationAttributes: any[];
-    tax: number;
-    productScore: number;
-    storeSplitAttribute: string;
-    brandID: string;
-    installment: Installment;
-    name: string;
-    boost: Boost;
-    skus: Sku[];
+    brandId: number;
+    cacheId?: string;
+    linkText: string;
+    productReference: string;
+    categoryId: string;
+    clusterHighlights: Record<string, any>;
+    productClusters: Record<string, string>;
+    categories: string[];
+    categoriesIds: string[];
     link: string;
-    wear: number;
     description: string;
-    showIfNotAvailable: boolean;
-    clusterHighlights: ClusterHighlights;
-    categories: string[];
-    timestamp: number;
-    product: string;
-    oldPrice: number;
-    productSpecifications: string[];
-    url: string;
-    measurementUnit: string;
-    categoryIDS: string[];
-    textAttributes: TextAttribute[];
-    numberAttributes: NumberAttribute[];
-    headSku: string;
-    specificationGroups: string;
-    extraInfo: ExtraInfo;
-    oldPriceText: string;
-    priceText: string;
-}
-export interface Boost {
-    newness: number;
-    image: number;
-    revenue: number;
-    discount: number;
-    productScore: number;
-    click: number;
-    availableSpecsCount: number;
-    promotion: number;
-    order: number;
-}
-export interface CategoryTree {
-    categoryNames: string[];
-    categoryIDS: string[];
-}
-export interface ClusterHighlights {
-    the140: string;
-}
-export interface Collection {
-    id: string;
-    position: number;
-}
-export interface ExtraDatum {
-    value: string;
-    key: string;
-}
-export interface ExtraInfo {
-    sellerID: string;
-}
-export interface Image {
+    /**
+     * @description Product SKUs.
+     */
+    items: Item[];
+    skuSpecifications?: SkuSpecification[];
+    priceRange: PriceRange;
+    specificationGroups: SpecificationGroup;
+    properties: Array<{
+        name: string;
+        values: string[];
+    }>;
+    selectedProperties: Array<{
+        key: string;
+        value: string;
+    }>;
+}
+interface Image {
+    imageId: string;
+    imageLabel: string | null;
+    imageTag: string;
+    imageUrl: string;
+    imageText: string;
+}
+interface Installment {
+    Value: number;
+    InterestRate: number;
+    TotalValuePlusInterestRate: number;
+    NumberOfInstallments: number;
+    PaymentSystemName: string;
+    PaymentSystemGroupName: string;
+    Name: string;
+}
+export interface Item {
+    itemId: string;
     name: string;
-    value: string;
-}
-export interface Installment {
-    interest: boolean;
-    count: number;
-    paymentGroupName: string;
-    value: number;
-    paymentName: string;
-    valueText?: string;
-}
-export interface NumberAttribute {
-    labelKey: string;
-    value: number;
-    key: string;
-}
-export interface Sku {
-    images: Image[];
     nameComplete: string;
     complementName: string;
-    policies: Policy[];
-    videos: any[];
-    reference: string;
-    idWithSplit: string;
     ean: string;
-    name: string;
-    attributes: ExtraDatum[];
-    id: string;
-    sellers: Seller[];
-}
-export interface Policy {
-    id: string;
+    referenceId: Array<{
+        Key: string;
+        Value: string;
+    }>;
+    measurementUnit: string;
+    unitMultiplier: number;
+    modalType: any | null;
+    images: Image[];
+    Videos: string[];
+    variations: string[];
     sellers: Seller[];
+    attachments: Array<{
+        id: number;
+        name: string;
+        required: boolean;
+        domainValues: string;
+    }>;
+    isKit: boolean;
+    kitItems?: Array<{
+        itemId: string;
+        amount: number;
+    }>;
+}
+export interface CommertialOffer {
+    DeliverySlaSamplesPerRegion: Record<string, {
+        DeliverySlaPerTypes: any[];
+        Region: any | null;
+    }>;
+    Installments: Installment[];
+    DiscountHighLight: any[];
+    GiftSkuIds: string[];
+    Teasers: Array<Record<string, unknown>>;
+    teasers?: Array<Record<string, unknown>>;
+    BuyTogether: any[];
+    ItemMetadataAttachment: any[];
+    Price: number;
+    ListPrice: number;
+    spotPrice?: number;
+    PriceWithoutDiscount: number;
+    RewardValue: number;
+    PriceValidUntil: string;
+    AvailableQuantity: number;
+    Tax: number;
+    DeliverySlaSamples: Array<{
+        DeliverySlaPerTypes: any[];
+        Region: any | null;
+    }>;
+    GetInfoErrorMessage: any | null;
+    CacheVersionUsedToCallCheckout: string;
 }
 export interface Seller {
-    default: boolean;
-    oldPrice?: number;
-    price?: number;
-    installment?: Installment;
-    name: string;
-    tax: number;
-    teasers: any[];
-    id: string;
+    sellerId: string;
+    sellerName: string;
+    addToCartLink: string;
+    sellerDefault: boolean;
+    commertialOffer: CommertialOffer;
+}
+interface SkuSpecification {
+    field: SKUSpecificationField;
+    values: SKUSpecificationValue[];
 }
-export interface Split {
-    labelValue: string;
-    labelKey: string;
+interface SKUSpecificationValue {
+    name: string;
+    id?: string;
+    fieldId?: string;
+    originalName?: string;
 }
-export interface Sticker {
-    image: string;
+interface SKUSpecificationField {
     name: string;
-    location: string;
-    target: string;
-}
-export interface TextAttribute {
-    joinedValue: string;
-    isSku: boolean;
-    joinedKey: string;
-    joinedKeyTranslations: JoinedTranslations;
-    isFilter: boolean;
-    labelValue: string;
-    id: string[];
-    labelKey: string;
-    value: string;
-    key: string;
-    joinedValueTranslations: JoinedTranslations;
-    valueID?: string;
-}
-export interface JoinedTranslations {
-    spanish: string;
-    english: string;
-    italian: string;
+    originalName?: string;
+    id?: string;
 }
+interface Price {
+    highPrice: number | null;
+    lowPrice: number | null;
+}
+interface PriceRange {
+    sellingPrice: Price;
+    listPrice: Price;
+}
+interface SpecificationGroup {
+    name: string;
+    originalName: string;
+    specifications: {
+        name: string;
+        originalName: string;
+        values: string[];
+    };
+}
+export {};

package/dist/platforms/vtex/clients/sp/index.d.ts

@@ -0,0 +1,13 @@
+import type { Options, Context } from '../../index';
+export declare type SearchEvent = {
+    type: 'search.query';
+    text: string;
+    misspelled: boolean;
+    match: number;
+    operator: 'and' | 'or';
+    session?: string;
+    anonymous?: string;
+};
+export declare const SP: ({ account }: Options, _: Context) => {
+    sendEvent: (options: SearchEvent) => Promise<any>;
+};

package/dist/platforms/vtex/index.d.ts

@@ -22,31 +22,45 @@ export interface Context {
     };
     headers: Record<string, string>;
 }
-export declare type Resolver<R = unknown, A = unknown> = (root: R, args: A, ctx: Context, info: any) => any;
+export declare type Resolver<R = unknown, A = unknown, Return = any> = (root: R, args: A, ctx: Context, info: any) => Return;
 export declare const getContextFactory: (options: Options) => (ctx: any) => Context;
 export declare const getResolvers: (_: Options) => {
     StoreCollection: Record<string, Resolver<import("./clients/commerce/types/Brand").Brand | import("./clients/commerce/types/Portal").CollectionPageType | (import("./clients/commerce/types/CategoryTree").CategoryTree & {
         level: number;
-    }), unknown>>;
-    StoreAggregateOffer: Record<string, (root: import("./clients/commerce/types/Simulation").Simulation & {
+    }), unknown, any>>;
+    StoreAggregateOffer: Record<string, Resolver<{
+        items: import("./clients/search/types/ProductSearchResult").Item[];
         product: import("./utils/enhanceSku").EnhancedSku;
-    }) => unknown>;
-    StoreProduct: Record<string, Resolver<import("./utils/enhanceSku").EnhancedSku, unknown>>;
+    }, unknown, any>> & {
+        offers: Resolver<{
+            items: import("./clients/search/types/ProductSearchResult").Item[];
+            product: import("./utils/enhanceSku").EnhancedSku;
+        }, any, (import("./clients/search/types/ProductSearchResult").Item & {
+            product: import("./utils/enhanceSku").EnhancedSku;
+        })[]>;
+    };
+    StoreProduct: Record<string, Resolver<import("./utils/enhanceSku").EnhancedSku, unknown, any>> & {
+        offers: Resolver<import("./utils/enhanceSku").EnhancedSku, any, {
+            items: import("./clients/search/types/ProductSearchResult").Item[];
+            product: import("./utils/enhanceSku").EnhancedSku;
+        }>;
+        isVariantOf: Resolver<import("./utils/enhanceSku").EnhancedSku, any, import("./utils/enhanceSku").EnhancedSku>;
+    };
     StoreSeo: Record<string, Resolver<{
         title?: string | undefined;
         description?: string | undefined;
-    }, unknown>>;
-    StoreFacet: Record<string, Resolver<import("./clients/search/types/AttributeSearchResult").Attribute, unknown>>;
-    StoreFacetValue: Record<string, Resolver<import("./clients/search/types/AttributeSearchResult").Value, unknown>>;
-    StoreOffer: Record<string, Resolver<(import("./clients/commerce/types/Simulation").Item & {
+    }, unknown, any>>;
+    StoreFacet: Record<string, Resolver<import("./clients/search/types/FacetSearchResult").Facet, unknown, any>>;
+    StoreFacetValue: Record<string, Resolver<import("./clients/search/types/FacetSearchResult").FacetValue, unknown, any>>;
+    StoreOffer: Record<string, Resolver<(import("./clients/search/types/ProductSearchResult").Item & {
         product: import("./utils/enhanceSku").EnhancedSku;
     }) | (import("./clients/commerce/types/OrderForm").OrderFormItem & {
         product: Promise<import("./utils/enhanceSku").EnhancedSku>;
-    }), unknown>>;
-    StoreAggregateRating: Record<string, Resolver<unknown, unknown>>;
-    StoreReview: Record<string, Resolver<unknown, unknown>>;
-    StoreProductGroup: Record<string, Resolver<import("./clients/search/types/ProductSearchResult").Product, unknown>>;
-    StoreSearchResult: Record<string, Resolver<Pick<import("./clients/search").SearchArgs, "hideUnavailableItems" | "query" | "page" | "count" | "sort" | "selectedFacets" | "fuzzy">, unknown>>;
+    }), unknown, any>>;
+    StoreAggregateRating: Record<string, Resolver<unknown, unknown, any>>;
+    StoreReview: Record<string, Resolver<unknown, unknown, any>>;
+    StoreProductGroup: Record<string, Resolver<import("./utils/enhanceSku").EnhancedSku, unknown, any>>;
+    StoreSearchResult: Record<string, Resolver<Pick<import("./clients/search").SearchArgs, "hideUnavailableItems" | "query" | "page" | "count" | "sort" | "selectedFacets" | "fuzzy">, unknown, any>>;
     Query: {
         product: (_: unknown, { locator }: import("../..").QueryProductArgs, ctx: Context) => Promise<import("./utils/enhanceSku").EnhancedSku>;
         collection: (_: unknown, { slug }: import("../..").QueryCollectionArgs, ctx: Context) => Promise<import("./clients/commerce/types/Portal").CollectionPageType>;

package/dist/platforms/vtex/resolvers/aggregateOffer.d.ts

@@ -1,8 +1,12 @@
+import type { Item } from '../clients/search/types/ProductSearchResult';
+import type { StoreProduct } from './product';
+import type { PromiseType } from '../../../typings';
+import type { Resolver } from '..';
 import type { EnhancedSku } from '../utils/enhanceSku';
-import type { Simulation } from '../clients/commerce/types/Simulation';
-declare type Resolvers = (root: Simulation & {
-    product: EnhancedSku;
-}) => unknown;
-export declare const sortOfferByPrice: (items: Simulation['items']) => Simulation['items'];
-export declare const StoreAggregateOffer: Record<string, Resolvers>;
+declare type Root = PromiseType<ReturnType<typeof StoreProduct.offers>>;
+export declare const StoreAggregateOffer: Record<string, Resolver<Root>> & {
+    offers: Resolver<Root, any, Array<Item & {
+        product: EnhancedSku;
+    }>>;
+};
 export {};

package/dist/platforms/vtex/resolvers/facet.d.ts

@@ -1,5 +1,5 @@
 import type { Resolver } from '..';
-import type { Attribute } from '../clients/search/types/AttributeSearchResult';
-declare type Root = Attribute;
+import type { Facet } from '../clients/search/types/FacetSearchResult';
+declare type Root = Facet;
 export declare const StoreFacet: Record<string, Resolver<Root>>;
 export {};

package/dist/platforms/vtex/resolvers/facetValue.d.ts

@@ -1,5 +1,5 @@
 import type { Resolver } from '..';
-import type { Value } from '../clients/search/types/AttributeSearchResult';
-declare type Root = Value;
+import type { FacetValue } from '../clients/search/types/FacetSearchResult';
+declare type Root = FacetValue;
 export declare const StoreFacetValue: Record<string, Resolver<Root>>;
 export {};

package/dist/platforms/vtex/resolvers/offer.d.ts

@@ -1,11 +1,12 @@
-import type { EnhancedSku } from '../utils/enhanceSku';
 import type { Resolver } from '..';
-import type { Item } from '../clients/commerce/types/Simulation';
+import type { StoreAggregateOffer } from './aggregateOffer';
+import type { ArrayElementType } from '../../../typings';
+import type { EnhancedSku } from '../utils/enhanceSku';
 import type { OrderFormItem } from '../clients/commerce/types/OrderForm';
-declare type Root = (Item & {
-    product: EnhancedSku;
-}) | (OrderFormItem & {
+declare type OrderFormProduct = OrderFormItem & {
     product: Promise<EnhancedSku>;
-});
+};
+declare type SearchProduct = ArrayElementType<ReturnType<typeof StoreAggregateOffer.offers>>;
+declare type Root = SearchProduct | OrderFormProduct;
 export declare const StoreOffer: Record<string, Resolver<Root>>;
 export {};

package/dist/platforms/vtex/resolvers/product.d.ts

@@ -1,5 +1,14 @@
 import type { Resolver } from '..';
+import type { PromiseType } from '../../../typings';
+import type { Query } from './query';
+import type { Item } from '../clients/search/types/ProductSearchResult';
 import type { EnhancedSku } from '../utils/enhanceSku';
-declare type Root = EnhancedSku;
-export declare const StoreProduct: Record<string, Resolver<Root>>;
+declare type Root = PromiseType<ReturnType<typeof Query.product>>;
+export declare const StoreProduct: Record<string, Resolver<Root>> & {
+    offers: Resolver<Root, any, {
+        items: Item[];
+        product: EnhancedSku;
+    }>;
+    isVariantOf: Resolver<Root, any, Root>;
+};
 export {};

package/dist/platforms/vtex/resolvers/productGroup.d.ts

@@ -1,3 +1,6 @@
-import type { Product } from '../clients/search/types/ProductSearchResult';
 import type { Resolver } from '..';
-export declare const StoreProductGroup: Record<string, Resolver<Product>>;
+import type { PromiseType } from '../../../typings';
+import type { StoreProduct } from './product';
+declare type Root = PromiseType<ReturnType<typeof StoreProduct.isVariantOf>>;
+export declare const StoreProductGroup: Record<string, Resolver<Root>>;
+export {};

package/dist/platforms/vtex/utils/enhanceSku.d.ts

@@ -1,5 +1,5 @@
-import type { Product, Sku } from '../clients/search/types/ProductSearchResult';
-export declare type EnhancedSku = Sku & {
+import type { Product, Item } from '../clients/search/types/ProductSearchResult';
+export declare type EnhancedSku = Item & {
     isVariantOf: Product;
 };
-export declare const enhanceSku: (sku: Sku, product: Product) => EnhancedSku;
+export declare const enhanceSku: (item: Item, product: Product) => EnhancedSku;

package/dist/platforms/vtex/utils/price.d.ts

@@ -0,0 +1,2 @@
+import type { CommertialOffer, Item } from '../clients/search/types/ProductSearchResult';
+export declare const getItemPriceByKey: (item: Item, key: keyof CommertialOffer) => number;

package/dist/platforms/vtex/utils/productStock.d.ts

@@ -0,0 +1,5 @@
+import type { Item, Seller } from '../clients/search/types/ProductSearchResult';
+export declare const inStock: (item: Item) => Seller | undefined;
+export declare const getFirstSeller: (sellers: Seller[]) => Seller | undefined;
+export declare const sortOfferByPrice: (items: Item[]) => Item[];
+export declare const inStockOrderFormItem: (availability: string) => boolean;

package/dist/typings/index.d.ts

@@ -1 +1,3 @@
 export declare type Platform = 'vtex';
+export declare type PromiseType<T> = T extends Promise<infer U> ? U : T;
+export declare type ArrayElementType<T> = T extends Array<infer U> ? U : T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.7.30",
+  "version": "1.7.33",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -45,5 +45,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "e0f577efbcbde827619bc66e6b3b237fc98c625c"
+  "gitHead": "bd144e2b299386767a92897c71d5b07223a5df23"
 }