@faststore/api 1.10.8 → 1.10.19

package/dist/index.d.ts

@@ -181,6 +181,7 @@ export declare const getResolvers: (options: Options) => {
             }[];
         } | null>;
         validateSession: (_: any, { session: oldSession, search }: import("./__generated__/schema").MutationValidateSessionArgs, { clients }: import("./platforms/vtex").Context) => Promise<import("./__generated__/schema").StoreSession | null>;
+        subscribeToNewsletter: (_: any, { data }: import("./__generated__/schema").MutationSubscribeToNewsletterArgs, { clients: { commerce } }: import("./platforms/vtex").Context) => Promise<import("./__generated__/schema").PersonNewsletter | null>;
     };
 };
 export declare const getContextFactory: (options: Options) => (ctx: any) => import("./platforms/vtex").Context;

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

@@ -10,6 +10,7 @@ import type { Simulation, SimulationArgs, SimulationOptions } from './types/Simu
 import type { Session } from './types/Session';
 import type { Channel } from '../../utils/channel';
 import type { SalesChannel } from './types/SalesChannel';
+import { MasterDataResponse } from './types/Newsletter';
 declare type ValueOf<T> = T extends Record<string, infer K> ? K : never;
 export declare const VtexCommerce: ({ account, environment }: Options, ctx: Context) => {
     catalog: {
@@ -53,5 +54,9 @@ export declare const VtexCommerce: ({ account, environment }: Options, ctx: Cont
         region: ({ postalCode, country, salesChannel, }: RegionInput) => Promise<Region>;
     };
     session: (search: string) => Promise<Session>;
+    subscribeToNewsletter: (data: {
+        name: string;
+        email: string;
+    }) => Promise<MasterDataResponse>;
 };
 export {};

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

@@ -0,0 +1,4 @@
+export interface MasterDataResponse {
+    Id: string;
+    Href: string;
+}

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/index.d.ts

@@ -49,6 +49,10 @@ export declare const getClients: (options: Options, ctx: Context) => {
             region: ({ postalCode, country, salesChannel, }: import("./commerce/types/Region").RegionInput) => Promise<import("./commerce/types/Region").Region>;
         };
         session: (search: string) => Promise<import("./commerce/types/Session").Session>;
+        subscribeToNewsletter: (data: {
+            name: string;
+            email: string;
+        }) => Promise<import("./commerce/types/Newsletter").MasterDataResponse>;
     };
     sp: {
         sendEvent: (options: import("./sp").SearchEvent) => Promise<any>;

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

@@ -211,6 +211,7 @@ export declare const getResolvers: (_: Options) => {
             }[];
         } | null>;
         validateSession: (_: any, { session: oldSession, search }: import("../..").MutationValidateSessionArgs, { clients }: Context) => Promise<import("../..").StoreSession | null>;
+        subscribeToNewsletter: (_: any, { data }: import("../..").MutationSubscribeToNewsletterArgs, { clients: { commerce } }: Context) => Promise<import("../..").PersonNewsletter | null>;
     };
 };
 export {};

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

@@ -57,4 +57,5 @@ export declare const Mutation: {
         }[];
     } | null>;
     validateSession: (_: any, { session: oldSession, search }: import("../../..").MutationValidateSessionArgs, { clients }: import("..").Context) => Promise<import("../../..").StoreSession | null>;
+    subscribeToNewsletter: (_: any, { data }: import("../../..").MutationSubscribeToNewsletterArgs, { clients: { commerce } }: import("..").Context) => Promise<import("../../..").PersonNewsletter | null>;
 };

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

@@ -0,0 +1,3 @@
+import type { Context } from '..';
+import type { MutationSubscribeToNewsletterArgs, PersonNewsletter } from '../../../__generated__/schema';
+export declare const subscribeToNewsletter: (_: any, { data }: MutationSubscribeToNewsletterArgs, { clients: { commerce } }: Context) => Promise<PersonNewsletter | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faststore/api",
-  "version": "1.10.8",
+  "version": "1.10.19",
   "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": "a1cee56b400b1309489843f7be6d1cf1b0eab65e"
+  "gitHead": "9678f28100f7829663fddb743835a4ea1f60a0da"
 }

package/src/__generated__/schema.ts

@@ -12,6 +12,14 @@ export type Scalars = {
   ObjectOrString: any;
 };
 
+/** Person data input to the newsletter. */
+export type IPersonNewsletter = {
+  /** Person's email. */
+  email: Scalars['String'];
+  /** Person's name. */
+  name: Scalars['String'];
+};
+
 /** Shopping cart input. */
 export type IStoreCart = {
   /** Order information, including `orderNumber` and `acceptedOffer`. */
@@ -122,6 +130,8 @@ export type IStoreSession = {
 
 export type Mutation = {
   __typename?: 'Mutation';
+  /** Subscribes a new person to the newsletter list. */
+  subscribeToNewsletter?: Maybe<PersonNewsletter>;
   /** Checks for changes between the cart presented in the UI and the cart stored in the ecommerce platform. If changes are detected, it returns the cart stored on the platform. Otherwise, it returns `null`. */
   validateCart?: Maybe<StoreCart>;
   /** Updates a web session with the specified values. */
@@ -129,6 +139,11 @@ export type Mutation = {
 };
 
 
+export type MutationSubscribeToNewsletterArgs = {
+  data: IPersonNewsletter;
+};
+
+
 export type MutationValidateCartArgs = {
   cart: IStoreCart;
 };
@@ -139,6 +154,13 @@ export type MutationValidateSessionArgs = {
   session: IStoreSession;
 };
 
+/** Newsletter information. */
+export type PersonNewsletter = {
+  __typename?: 'PersonNewsletter';
+  /** Person's ID in the newsletter list. */
+  id: Scalars['String'];
+};
+
 export type Query = {
   __typename?: 'Query';
   /** Returns information about all collections. */
@@ -300,7 +322,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 +330,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

@@ -16,6 +16,7 @@ import type {
 import type { Session } from './types/Session'
 import type { Channel } from '../../utils/channel'
 import type { SalesChannel } from './types/SalesChannel'
+import { MasterDataResponse } from './types/Newsletter'
 
 type ValueOf<T> = T extends Record<string, infer K> ? K : never
 
@@ -178,5 +179,15 @@ export const VtexCommerce = (
         body: '{}',
       })
     },
+    subscribeToNewsletter: (data: {
+      name: string
+      email: string
+    }): Promise<MasterDataResponse> => {
+      return fetchAPI(`${base}/api/dataentities/NL/documents/`, {
+        ...BASE_INIT,
+        body: JSON.stringify({ ...data, isNewsletterOptIn: true }),
+        method: 'PATCH',
+      })
+    },
   }
 }

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

@@ -0,0 +1,4 @@
+export interface MasterDataResponse {
+  Id: string
+  Href: string
+}

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/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/resolvers/mutation.ts

@@ -1,7 +1,9 @@
+import { subscribeToNewsletter } from './subscribeToNewsletter'
 import { validateCart } from './validateCart'
 import { validateSession } from './validateSession'
 
 export const Mutation = {
   validateCart,
   validateSession,
+  subscribeToNewsletter,
 }

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

@@ -0,0 +1,14 @@
+import type { Context } from '..'
+import type {
+  MutationSubscribeToNewsletterArgs,
+  PersonNewsletter,
+} from '../../../__generated__/schema'
+
+export const subscribeToNewsletter = async (
+  _: any,
+  { data }: MutationSubscribeToNewsletterArgs,
+  { clients: { commerce } }: Context
+): Promise<PersonNewsletter | null> => {
+  const response = await commerce.subscribeToNewsletter(data)
+  return { id: response?.Id }
+}

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
 }
 
 """

package/src/typeDefs/index.ts

@@ -24,6 +24,7 @@ import PropertyValue from './propertyValue.graphql'
 import Person from './person.graphql'
 import ObjectOrString from './objectOrString.graphql'
 import Session from './session.graphql'
+import Newsletter from './newsletter.graphql'
 
 export const typeDefs = [
   Query,
@@ -50,6 +51,7 @@ export const typeDefs = [
   Person,
   ObjectOrString,
   Session,
+  Newsletter
 ]
   .map(print)
   .join('\n')

package/src/typeDefs/mutation.graphql

@@ -7,4 +7,8 @@ type Mutation {
   Updates a web session with the specified values.
   """
   validateSession(session: IStoreSession!, search: String!): StoreSession
+  """
+  Subscribes a new person to the newsletter list.
+  """
+  subscribeToNewsletter(data: IPersonNewsletter!): PersonNewsletter
 }

package/src/typeDefs/newsletter.graphql

@@ -0,0 +1,24 @@
+"""
+Newsletter information.
+"""
+
+type PersonNewsletter {
+  """
+  Person's ID in the newsletter list.
+  """
+  id: String!
+}
+
+"""
+Person data input to the newsletter.
+"""
+input IPersonNewsletter {
+  """
+  Person's name.
+  """
+  name: String!
+  """
+  Person's email.
+  """
+  email: String!
+}