@faststore/api 1.3.1 → 1.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -42,5 +42,5 @@
   "peerDependencies": {
     "graphql": "^15.6.0"
   },
-  "gitHead": "f960dad9561b64f519e9cdeb0560af422b11022f"
+  "gitHead": "bf541af67cee88f3489d37f6855b7310fc37eb60"
 }

package/src/__generated__/schema.ts

@@ -62,6 +62,7 @@ export type Query = {
   __typename?: 'Query';
   allCollections: StoreCollectionConnection;
   allProducts: StoreProductConnection;
+  collection: StoreCollection;
   product: StoreProduct;
   search: StoreSearchResult;
 };
@@ -79,6 +80,11 @@ export type QueryAllProductsArgs = {
 };
 
 
+export type QueryCollectionArgs = {
+  slug: Scalars['String'];
+};
+
+
 export type QueryProductArgs = {
   locator: Array<IStoreSelectedFacet>;
 };

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

@@ -1,13 +1,14 @@
 import type { Context, Options } from '../../index'
 import { fetchAPI } from '../fetch'
+import type { Brand } from './types/Brand'
+import type { CategoryTree } from './types/CategoryTree'
+import type { OrderForm, OrderFormInputItem } from './types/OrderForm'
+import type { PortalPagetype } from './types/Portal'
 import type {
   Simulation,
   SimulationArgs,
   SimulationOptions,
 } from './types/Simulation'
-import type { CategoryTree } from './types/CategoryTree'
-import type { Brand } from './types/Brand'
-import type { OrderForm, OrderFormInputItem } from './types/OrderForm'
 
 const BASE_INIT = {
   method: 'POST',
@@ -32,6 +33,10 @@ export const VtexCommerce = (
         tree: (depth = 3): Promise<CategoryTree[]> =>
           fetchAPI(`${base}/api/catalog_system/pub/category/tree/${depth}`),
       },
+      portal: {
+        pagetype: (slug: string): Promise<PortalPagetype> =>
+          fetchAPI(`${base}/api/catalog_system/pub/portal/pagetype/${slug}`),
+      },
     },
     checkout: {
       simulation: (

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

@@ -0,0 +1,8 @@
+export interface PortalPagetype {
+  id: number
+  name: string
+  url: string
+  title: string
+  metaTagDescription: string
+  pageType: 'Brand' | 'Category' | 'Department' | 'Subcategory' | 'FullText'
+}

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

@@ -1,17 +1,21 @@
-import { slugify } from '../utils/slugify'
 import type { Resolver } from '..'
 import type { Brand } from '../clients/commerce/types/Brand'
 import type { CategoryTree } from '../clients/commerce/types/CategoryTree'
+import type { PortalPagetype } from '../clients/commerce/types/Portal'
+import { slugify } from '../utils/slugify'
 
-type Root = Brand | (CategoryTree & { level: number })
+type Root = Brand | (CategoryTree & { level: number }) | PortalPagetype
 
 const isBrand = (x: any): x is Brand => x.type === 'brand'
 
+const isPortalPageType = (x: any): x is PortalPagetype =>
+  typeof x.pageType === 'string'
+
 export const StoreCollection: Record<string, Resolver<Root>> = {
   id: ({ id }) => id.toString(),
   slug: ({ name }) => slugify(name),
   seo: (root) =>
-    isBrand(root)
+    isBrand(root) || isPortalPageType(root)
       ? {
           title: root.title,
           description: root.metaTagDescription,
@@ -21,14 +25,22 @@ export const StoreCollection: Record<string, Resolver<Root>> = {
           description: root.MetaTagDescription,
         },
   type: (root) =>
-    isBrand(root) ? 'Brand' : root.level === 0 ? 'Department' : 'Category',
+    isBrand(root)
+      ? 'Brand'
+      : isPortalPageType(root)
+      ? root.pageType
+      : root.level === 0
+      ? 'Department'
+      : 'Category',
   meta: (root) =>
     isBrand(root)
       ? {
           selectedFacets: [{ key: 'brand', value: slugify(root.name) }],
         }
       : {
-          selectedFacets: new URL(root.url).pathname
+          selectedFacets: new URL(
+            isPortalPageType(root) ? `https://${root.url}` : root.url
+          ).pathname
             .slice(1)
             .split('/')
             .map((segment, index) => ({

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

@@ -7,6 +7,7 @@ import type {
   QueryAllCollectionsArgs,
   QueryAllProductsArgs,
   QuerySearchArgs,
+  QueryCollectionArgs,
 } from '../../../__generated__/schema'
 import type { CategoryTree } from '../clients/commerce/types/CategoryTree'
 import type { Context } from '../index'
@@ -27,6 +28,17 @@ export const Query = {
 
     return skuLoader.load(locator.map(transformSelectedFacet))
   },
+  collection: async (
+    _: unknown,
+    { slug }: QueryCollectionArgs,
+    ctx: Context
+  ) => {
+    const {
+      clients: { commerce },
+    } = ctx
+
+    return commerce.catalog.portal.pagetype(slug)
+  },
   search: async (
     _: unknown,
     { first, after: maybeAfter, sort, term, selectedFacets }: QuerySearchArgs,

package/src/typeDefs/query.graphql

@@ -8,7 +8,6 @@ type StoreProductConnection {
   edges: [StoreProductEdge!]!
 }
 
-
 type StoreCollectionEdge {
   node: StoreCollection!
   cursor: String!
@@ -48,10 +47,10 @@ type StoreSearchResult {
 type Query {
   product(locator: [IStoreSelectedFacet!]!): StoreProduct!
 
+  collection(slug: String!): StoreCollection!
+
   search(
-    # Relay style pagination args. To know more: https://relay.dev/graphql/connections.htm
     first: Int!
-     # Relay style pagination args. To know more: https://relay.dev/graphql/connections.htm
     after: String
     sort: StoreSort = score_desc
     term: String = ""