@faststore/api 1.10.6 → 1.10.18

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

@@ -1,5 +1,5 @@
-import { FACET_CROSS_SELLING_MAP } from "../../utils/facets";
-import type { PortalProduct } from "./types/Product";
+import { FACET_CROSS_SELLING_MAP } from '../../utils/facets';
+import type { PortalProduct } from './types/Product';
 import type { Context, Options } from '../../index';
 import type { Brand } from './types/Brand';
 import type { CategoryTree } from './types/CategoryTree';
@@ -9,9 +9,11 @@ import type { Region, RegionInput } from './types/Region';
 import type { Simulation, SimulationArgs, SimulationOptions } from './types/Simulation';
 import type { Session } from './types/Session';
 import type { Channel } from '../../utils/channel';
+import type { SalesChannel } from './types/SalesChannel';
 declare type ValueOf<T> = T extends Record<string, infer K> ? K : never;
 export declare const VtexCommerce: ({ account, environment }: Options, ctx: Context) => {
     catalog: {
+        salesChannel: (sc: string) => Promise<SalesChannel>;
         brand: {
             list: () => Promise<Brand[]>;
         };

package/dist/platforms/vtex/clients/commerce/types/Portal.d.ts

@@ -5,7 +5,7 @@ export interface CollectionPageType {
     url: string;
     title: string;
     metaTagDescription: string;
-    pageType: 'Brand' | 'Category' | 'Department' | 'Subcategory' | 'Product';
+    pageType: 'Brand' | 'Category' | 'Department' | 'SubCategory' | 'Product' | 'Collection' | 'Cluster';
 }
 export interface FallbackPageType {
     id: null;

package/dist/platforms/vtex/clients/commerce/types/SalesChannel.d.ts

@@ -0,0 +1,24 @@
+export interface SalesChannel {
+    Id: number;
+    Name: string;
+    IsActive: boolean;
+    ProductClusterId: null;
+    CountryCode: string;
+    CultureInfo: string;
+    TimeZone: string;
+    CurrencyCode: string;
+    CurrencySymbol: string;
+    CurrencyLocale: number;
+    CurrencyFormatInfo: CurrencyFormatInfo;
+    Origin: null;
+    Position: number;
+    ConditionRule: null;
+    CurrencyDecimalDigits: null;
+}
+export interface CurrencyFormatInfo {
+    CurrencyDecimalDigits: number;
+    CurrencyDecimalSeparator: string;
+    CurrencyGroupSeparator: string;
+    CurrencyGroupSize: number;
+    StartsWithCurrencySymbol: boolean;
+}

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

@@ -9,6 +9,7 @@ export declare const getClients: (options: Options, ctx: Context) => {
     };
     commerce: {
         catalog: {
+            salesChannel: (sc: string) => Promise<import("./commerce/types/SalesChannel").SalesChannel>;
             brand: {
                 list: () => Promise<import("./commerce/types/Brand").Brand[]>;
             };

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

@@ -4,4 +4,5 @@ export declare const getLoaders: (options: Options, { clients }: Context) => {
     skuLoader: import("dataloader")<string, import("../utils/enhanceSku").EnhancedSku, string>;
     simulationLoader: import("dataloader")<import("../clients/commerce/types/Simulation").PayloadItem[], import("../clients/commerce/types/Simulation").Simulation, import("../clients/commerce/types/Simulation").PayloadItem[]>;
     collectionLoader: import("dataloader")<string, import("../clients/commerce/types/Portal").CollectionPageType, string>;
+    salesChannelLoader: import("dataloader")<string, import("../clients/commerce/types/SalesChannel").SalesChannel, string>;
 };

package/dist/platforms/vtex/loaders/salesChannel.d.ts

@@ -0,0 +1,5 @@
+import DataLoader from "dataloader";
+import { Options } from "..";
+import { Clients } from "../clients";
+import type { SalesChannel } from "./../clients/commerce/types/SalesChannel";
+export declare const getSalesChannelLoader: (_: Options, clients: Clients) => DataLoader<string, SalesChannel, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.10.6",
+  "version": "1.10.18",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -37,7 +37,7 @@
     "express-graphql": "^0.12.0",
     "graphql": "^15.6.0",
     "jest-transform-graphql": "^2.1.0",
-    "shared": "^1.10.6",
+    "shared": "^1.10.18",
     "ts-jest": "25.5.1",
     "tsdx": "^0.14.1",
     "tslib": "^2.3.1",
@@ -46,5 +46,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "654744a6c3b29afacbd83c4d9ebefe4270d1ae2a"
+  "gitHead": "a6f5e44b68bde5b811a345bffb7bec697e8f3933"
 }

package/src/__generated__/schema.ts

@@ -300,7 +300,7 @@ export type StoreCollectionMeta = {
   selectedFacets: Array<StoreCollectionFacet>;
 };
 
-/** Product collection type. Possible values are `Department`, `Category`, `Brand` or `Cluster`. */
+/** Product collection type. Possible values are `Department`, `Category`, `Brand`, `Cluster`, `SubCategory` or `Collection`. */
 export const enum StoreCollectionType {
   /** Product brand. */
   Brand = 'Brand',
@@ -308,8 +308,12 @@ export const enum StoreCollectionType {
   Category = 'Category',
   /** Product cluster. */
   Cluster = 'Cluster',
+  /** Product collection. */
+  Collection = 'Collection',
   /** First level of product categorization. */
-  Department = 'Department'
+  Department = 'Department',
+  /** Third level of product categorization. */
+  SubCategory = 'SubCategory'
 };
 
 /** Currency information. */

package/src/platforms/vtex/clients/commerce/index.ts

@@ -1,6 +1,7 @@
-import { FACET_CROSS_SELLING_MAP } from "../../utils/facets"
-import { fetchAPI } from "../fetch"
-import type { PortalProduct } from "./types/Product"
+import { FACET_CROSS_SELLING_MAP } from '../../utils/facets'
+import { fetchAPI } from '../fetch'
+
+import type { PortalProduct } from './types/Product'
 import type { Context, Options } from '../../index'
 import type { Brand } from './types/Brand'
 import type { CategoryTree } from './types/CategoryTree'
@@ -14,8 +15,9 @@ import type {
 } from './types/Simulation'
 import type { Session } from './types/Session'
 import type { Channel } from '../../utils/channel'
+import type { SalesChannel } from './types/SalesChannel'
 
-type ValueOf<T> = T extends Record<string, infer K> ? K : never;
+type ValueOf<T> = T extends Record<string, infer K> ? K : never
 
 const BASE_INIT = {
   method: 'POST',
@@ -32,6 +34,8 @@ export const VtexCommerce = (
 
   return {
     catalog: {
+      salesChannel: (sc: string): Promise<SalesChannel> =>
+        fetchAPI(`${base}/api/catalog_system/pub/saleschannel/${sc}`),
       brand: {
         list: (): Promise<Brand[]> =>
           fetchAPI(`${base}/api/catalog_system/pub/brand/list`),

package/src/platforms/vtex/clients/commerce/types/Portal.ts

@@ -6,7 +6,14 @@ export interface CollectionPageType {
   url: string
   title: string
   metaTagDescription: string
-  pageType: 'Brand' | 'Category' | 'Department' | 'Subcategory' | 'Product'
+  pageType:
+    | 'Brand'
+    | 'Category'
+    | 'Department'
+    | 'SubCategory'
+    | 'Product'
+    | 'Collection'
+    | 'Cluster'
 }
 
 export interface FallbackPageType {

package/src/platforms/vtex/clients/commerce/types/SalesChannel.ts

@@ -0,0 +1,25 @@
+export interface SalesChannel {
+  Id:                    number;
+  Name:                  string;
+  IsActive:              boolean;
+  ProductClusterId:      null;
+  CountryCode:           string;
+  CultureInfo:           string;
+  TimeZone:              string;
+  CurrencyCode:          string;
+  CurrencySymbol:        string;
+  CurrencyLocale:        number;
+  CurrencyFormatInfo:    CurrencyFormatInfo;
+  Origin:                null;
+  Position:              number;
+  ConditionRule:         null;
+  CurrencyDecimalDigits: null;
+}
+
+export interface CurrencyFormatInfo {
+  CurrencyDecimalDigits:    number;
+  CurrencyDecimalSeparator: string;
+  CurrencyGroupSeparator:   string;
+  CurrencyGroupSize:        number;
+  StartsWithCurrencySymbol: boolean;
+}

package/src/platforms/vtex/loaders/collection.ts

@@ -14,6 +14,8 @@ const collectionPageTypes = new Set([
   'category',
   'department',
   'subcategory',
+  'collection',
+  'cluster',
 ] as const)
 
 export const isCollectionPageType = (x: any): x is CollectionPageType =>

package/src/platforms/vtex/loaders/index.ts

@@ -1,3 +1,4 @@
+import { getSalesChannelLoader } from './salesChannel';
 import { getSimulationLoader } from './simulation'
 import { getSkuLoader } from './sku'
 import { getCollectionLoader } from './collection'
@@ -9,10 +10,12 @@ export const getLoaders = (options: Options, { clients }: Context) => {
   const skuLoader = getSkuLoader(options, clients)
   const simulationLoader = getSimulationLoader(options, clients)
   const collectionLoader = getCollectionLoader(options, clients)
+  const salesChannelLoader = getSalesChannelLoader(options, clients)
 
   return {
     skuLoader,
     simulationLoader,
     collectionLoader,
+    salesChannelLoader
   }
 }

package/src/platforms/vtex/loaders/salesChannel.ts

@@ -0,0 +1,15 @@
+import DataLoader from "dataloader";
+
+import { Options } from "..";
+import { Clients } from "../clients";
+
+import type { SalesChannel } from "./../clients/commerce/types/SalesChannel";
+
+export const getSalesChannelLoader = (_: Options, clients: Clients) => {
+  const loader = async (channels: readonly string[]) =>
+    Promise.all(
+      channels.map((sc) => clients.commerce.catalog.salesChannel(sc)),
+    );
+
+  return new DataLoader<string, SalesChannel>(loader);
+};

package/src/platforms/vtex/resolvers/aggregateOffer.ts

@@ -20,6 +20,15 @@ export const StoreAggregateOffer: Record<string, Resolver<Root>> & {
     return lowOffer ? price(lowOffer) : 0
   },
   offerCount: (offers) => offers.length,
-  priceCurrency: () => '',
+  priceCurrency: async (_, __, ctx) => {
+    const { 
+      loaders: { salesChannelLoader }, 
+      storage: { channel } 
+    } = ctx
+
+    const sc = await salesChannelLoader.load(channel.salesChannel);
+    
+    return sc.CurrencyCode ?? '';
+  },
   offers: (offers) => offers,
 }

package/src/platforms/vtex/resolvers/offer.ts

@@ -24,7 +24,16 @@ const isOrderFormItem = (item: Root): item is OrderFormProduct =>
   'skuName' in item
 
 export const StoreOffer: Record<string, Resolver<Root>> = {
-  priceCurrency: () => '',
+  priceCurrency: async (_, __, ctx) => {
+    const { 
+      loaders: { salesChannelLoader }, 
+      storage: { channel } 
+    } = ctx
+
+    const sc = await salesChannelLoader.load(channel.salesChannel);
+    
+    return sc.CurrencyCode ?? '';
+  },
   priceValidUntil: (root) => {
     if (isSearchItem(root)) {
       return root.PriceValidUntil ?? ''

package/src/typeDefs/collection.graphql

@@ -1,5 +1,5 @@
 """
-Product collection type. Possible values are `Department`, `Category`, `Brand` or `Cluster`.
+Product collection type. Possible values are `Department`, `Category`, `Brand`, `Cluster`, `SubCategory` or `Collection`.
 """
 enum StoreCollectionType {
   """
@@ -11,6 +11,10 @@ enum StoreCollectionType {
   """
   Category
   """
+  Third level of product categorization.
+  """
+  SubCategory
+  """
   Product brand.
   """
   Brand
@@ -18,6 +22,10 @@ enum StoreCollectionType {
   Product cluster.
   """
   Cluster
+  """
+  Product collection.
+  """
+  Collection
 }
 
 """