@faststore/api 2.2.42 → 2.2.44

package/dist/{platforms → cjs/src/platforms}/vtex/clients/search/types/ProductSearchResult.d.ts

@@ -1,206 +1,206 @@
-export interface ProductSearchResult {
-    /**
-     * @description Total of products.
-     */
-    recordsFiltered: number;
-    products: Product[];
-    pagination: Pagination;
-    sampling: boolean;
-    options: Options;
-    translated: boolean;
-    locale: string;
-    query: string;
-    operator: 'and' | 'or';
-    fuzzy: string;
-    correction?: Correction;
-    redirect?: string;
-}
-interface Correction {
-    misspelled: boolean;
-}
-interface Options {
-    sorts: Sort[];
-    counts: Count[];
-}
-interface Count {
-    count: number;
-    proxyURL: string;
-}
-interface Sort {
-    field: string;
-    order: string;
-    active?: boolean;
-    proxyURL: string;
-}
-interface Pagination {
-    count: number;
-    current: Page;
-    before: Page[];
-    after: Page[];
-    perPage: number;
-    next: Page;
-    previous: Page;
-    first: Page;
-    last: Page;
-}
-interface Page {
-    index: number;
-    proxyURL: string;
-}
-export interface First {
-    index: number;
-}
-export interface Suggestion {
-    searches: Search[];
-}
-export interface Search {
-    term: string;
-    count: number;
-}
-export interface Product {
-    productId: string;
-    productName: string;
-    brand: string;
-    brandId: number;
-    cacheId?: string;
-    linkText: string;
-    productReference: string;
-    categoryId: string;
-    clusterHighlights: Record<string, any>;
-    productClusters: Record<string, string>;
-    categories: string[];
-    categoriesIds: string[];
-    link: string;
-    description: string;
-    /**
-     * @description Product SKUs.
-     */
-    items: Item[];
-    skuSpecifications?: SkuSpecification[];
-    priceRange: PriceRange;
-    specificationGroups: SpecificationGroup[];
-    properties: Array<{
-        name: string;
-        values: string[];
-    }>;
-    selectedProperties: Array<{
-        key: string;
-        value: string;
-    }>;
-    releaseDate: 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;
-    nameComplete: string;
-    complementName: string;
-    ean: string;
-    referenceId: Array<{
-        Key: string;
-        Value: string;
-    }>;
-    measurementUnit: string;
-    unitMultiplier: number;
-    modalType: any | null;
-    images: Image[];
-    Videos: string[];
-    variations: Array<{
-        name: string;
-        values: 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 {
-    sellerId: string;
-    sellerName: string;
-    addToCartLink: string;
-    sellerDefault: boolean;
-    commertialOffer: CommertialOffer;
-}
-interface SkuSpecification {
-    field: SKUSpecificationField;
-    values: SKUSpecificationValue[];
-}
-interface SKUSpecificationValue {
-    name: string;
-    id?: string;
-    fieldId?: string;
-    originalName?: string;
-}
-interface SKUSpecificationField {
-    name: 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: Array<{
-        name: string;
-        originalName: string;
-        values: string[];
-    }>;
-}
-export {};
+export interface ProductSearchResult {
+    /**
+     * @description Total of products.
+     */
+    recordsFiltered: number;
+    products: Product[];
+    pagination: Pagination;
+    sampling: boolean;
+    options: Options;
+    translated: boolean;
+    locale: string;
+    query: string;
+    operator: 'and' | 'or';
+    fuzzy: string;
+    correction?: Correction;
+    redirect?: string;
+}
+interface Correction {
+    misspelled: boolean;
+}
+interface Options {
+    sorts: Sort[];
+    counts: Count[];
+}
+interface Count {
+    count: number;
+    proxyURL: string;
+}
+interface Sort {
+    field: string;
+    order: string;
+    active?: boolean;
+    proxyURL: string;
+}
+interface Pagination {
+    count: number;
+    current: Page;
+    before: Page[];
+    after: Page[];
+    perPage: number;
+    next: Page;
+    previous: Page;
+    first: Page;
+    last: Page;
+}
+interface Page {
+    index: number;
+    proxyURL: string;
+}
+export interface First {
+    index: number;
+}
+export interface Suggestion {
+    searches: Search[];
+}
+export interface Search {
+    term: string;
+    count: number;
+}
+export interface Product {
+    productId: string;
+    productName: string;
+    brand: string;
+    brandId: number;
+    cacheId?: string;
+    linkText: string;
+    productReference: string;
+    categoryId: string;
+    clusterHighlights: Record<string, any>;
+    productClusters: Record<string, string>;
+    categories: string[];
+    categoriesIds: string[];
+    link: string;
+    description: string;
+    /**
+     * @description Product SKUs.
+     */
+    items: Item[];
+    skuSpecifications?: SkuSpecification[];
+    priceRange: PriceRange;
+    specificationGroups: SpecificationGroup[];
+    properties: Array<{
+        name: string;
+        values: string[];
+    }>;
+    selectedProperties: Array<{
+        key: string;
+        value: string;
+    }>;
+    releaseDate: 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;
+    nameComplete: string;
+    complementName: string;
+    ean: string;
+    referenceId: Array<{
+        Key: string;
+        Value: string;
+    }>;
+    measurementUnit: string;
+    unitMultiplier: number;
+    modalType: any | null;
+    images: Image[];
+    Videos: string[];
+    variations: Array<{
+        name: string;
+        values: 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 {
+    sellerId: string;
+    sellerName: string;
+    addToCartLink: string;
+    sellerDefault: boolean;
+    commertialOffer: CommertialOffer;
+}
+interface SkuSpecification {
+    field: SKUSpecificationField;
+    values: SKUSpecificationValue[];
+}
+interface SKUSpecificationValue {
+    name: string;
+    id?: string;
+    fieldId?: string;
+    originalName?: string;
+}
+interface SKUSpecificationField {
+    name: 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: Array<{
+        name: string;
+        originalName: string;
+        values: string[];
+    }>;
+}
+export {};

package/dist/cjs/src/platforms/vtex/clients/search/types/ProductSearchResult.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ProductSearchResult.js.map

package/dist/cjs/src/platforms/vtex/clients/search/types/ProductSearchResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProductSearchResult.js","sourceRoot":"","sources":["../../../../../../../../src/platforms/vtex/clients/search/types/ProductSearchResult.ts"],"names":[],"mappings":""}

package/dist/{platforms → cjs/src/platforms}/vtex/clients/sp/index.d.ts

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

package/dist/cjs/src/platforms/vtex/clients/sp/index.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SP = void 0;
+/**
+ * Client for SP, Intelligent search's analytics event API
+ * More info at: https://www.notion.so/vtexhandbook/Event-API-Documentation-48eee26730cf4d7f80f8fd7262231f84
+ */
+const fetch_1 = require("../fetch");
+const THIRTY_MINUTES_S = 30 * 60;
+const ONE_YEAR_S = 365 * 24 * 3600;
+const randomUUID = () => (Math.random() * 1e6).toFixed(0);
+const timelapsed = (past) => (Date.now() - past) / 1e3;
+const createId = (expiresSecond) => {
+    let payload = randomUUID();
+    let createdAt = Date.now();
+    return () => {
+        if (timelapsed(createdAt) > expiresSecond) {
+            payload = randomUUID();
+            createdAt = Date.now();
+        }
+        return payload;
+    };
+};
+const user = {
+    anonymous: createId(ONE_YEAR_S),
+    session: createId(THIRTY_MINUTES_S),
+};
+const SP = ({ account }, _) => {
+    const base = `https://sp.vtex.com/event-api/v1/${account}/event`;
+    const sendEvent = (options) => {
+        return (0, fetch_1.fetchAPI)(base, {
+            method: 'POST',
+            body: JSON.stringify({
+                ...options,
+                agent: '@faststore/api',
+                anonymous: user.anonymous(), // 'zZlNhqz1vFJP6iPG5Oqtt'
+                session: user.session(), // 'Om1TNluGvgmSgU5OOTvkkd'
+            }),
+            headers: {
+                'content-type': 'application/json',
+            },
+        });
+    };
+    return {
+        sendEvent,
+    };
+};
+exports.SP = SP;
+//# sourceMappingURL=index.js.map

package/dist/cjs/src/platforms/vtex/clients/sp/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../src/platforms/vtex/clients/sp/index.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,oCAAmC;AAGnC,MAAM,gBAAgB,GAAG,EAAE,GAAG,EAAE,CAAA;AAChC,MAAM,UAAU,GAAG,GAAG,GAAG,EAAE,GAAG,IAAI,CAAA;AAElC,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;AAEzD,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,GAAG,CAAA;AAE9D,MAAM,QAAQ,GAAG,CAAC,aAAqB,EAAE,EAAE;IACzC,IAAI,OAAO,GAAG,UAAU,EAAE,CAAA;IAC1B,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IAE1B,OAAO,GAAG,EAAE;QACV,IAAI,UAAU,CAAC,SAAS,CAAC,GAAG,aAAa,EAAE,CAAC;YAC1C,OAAO,GAAG,UAAU,EAAE,CAAA;YACtB,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACxB,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC,CAAA;AACH,CAAC,CAAA;AAED,MAAM,IAAI,GAAG;IACX,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC;IAC/B,OAAO,EAAE,QAAQ,CAAC,gBAAgB,CAAC;CACpC,CAAA;AAaM,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,EAAW,EAAE,CAAU,EAAE,EAAE;IACrD,MAAM,IAAI,GAAG,oCAAoC,OAAO,QAAQ,CAAA;IAEhE,MAAM,SAAS,GAAG,CAAC,OAAoB,EAAE,EAAE;QACzC,OAAO,IAAA,gBAAQ,EAAC,IAAI,EAAE;YACpB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,GAAG,OAAO;gBACV,KAAK,EAAE,gBAAgB;gBACvB,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,0BAA0B;gBACvD,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,2BAA2B;aACrD,CAAC;YACF,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,OAAO;QACL,SAAS;KACV,CAAA;AACH,CAAC,CAAA;AArBY,QAAA,EAAE,MAqBd"}