@faststore/api 1.2.23

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@faststore/api",
+  "version": "1.2.23",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "module": "dist/api.esm.js",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=10"
+  },
+  "scripts": {
+    "develop": "concurrently \"yarn generate -w\" \"tsdx watch\"",
+    "build": "graphql-codegen --config codegen.yml && tsdx build",
+    "test": "tsdx test",
+    "lint": "tsdx lint",
+    "generate": "graphql-codegen --config codegen.yml"
+  },
+  "dependencies": {
+    "@graphql-tools/schema": "^8.2.0",
+    "dataloader": "^2.0.0",
+    "fast-deep-equal": "^3.1.3",
+    "isomorphic-unfetch": "^3.1.0",
+    "rollup-plugin-graphql": "^0.1.0",
+    "slugify": "^1.6.0"
+  },
+  "devDependencies": {
+    "@graphql-codegen/cli": "2.2.0",
+    "@graphql-codegen/typescript": "2.2.2",
+    "babel-jest": "^27.1.1",
+    "concurrently": "^6.2.1",
+    "jest-transform-graphql": "^2.1.0",
+    "ts-jest": "25.5.1",
+    "tsdx": "^0.14.1",
+    "tslib": "^2.3.1",
+    "typescript": "^4.4.2"
+  },
+  "peerDependencies": {
+    "graphql": "^15.6.0"
+  }
+}

package/src/__generated__/schema.ts

@@ -0,0 +1,324 @@
+export type Maybe<T> = T | null;
+export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
+export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
+/** All built-in and custom scalars, mapped to their actual values */
+export type Scalars = {
+  ID: string;
+  String: string;
+  Boolean: boolean;
+  Int: number;
+  Float: number;
+};
+
+export type IStoreCart = {
+  order: IStoreOrder;
+};
+
+export type IStoreImage = {
+  alternateName: Scalars['String'];
+  url: Scalars['String'];
+};
+
+export type IStoreOffer = {
+  itemOffered: IStoreProduct;
+  listPrice: Scalars['Float'];
+  price: Scalars['Float'];
+  quantity: Scalars['Int'];
+  seller: IStoreOrganization;
+};
+
+export type IStoreOrder = {
+  acceptedOffer: Array<IStoreOffer>;
+  orderNumber: Scalars['String'];
+};
+
+export type IStoreOrganization = {
+  identifier: Scalars['String'];
+};
+
+export type IStoreProduct = {
+  image: Array<IStoreImage>;
+  name: Scalars['String'];
+  sku: Scalars['String'];
+};
+
+export type IStoreSelectedFacet = {
+  key: Scalars['String'];
+  value: Scalars['String'];
+};
+
+export type Mutation = {
+  __typename?: 'Mutation';
+  validateCart?: Maybe<StoreCart>;
+};
+
+
+export type MutationValidateCartArgs = {
+  cart: IStoreCart;
+};
+
+export type Query = {
+  __typename?: 'Query';
+  allCollections: StoreCollectionConnection;
+  allProducts: StoreProductConnection;
+  product: StoreProduct;
+  search: StoreSearchResult;
+};
+
+
+export type QueryAllCollectionsArgs = {
+  after?: Maybe<Scalars['String']>;
+  first: Scalars['Int'];
+};
+
+
+export type QueryAllProductsArgs = {
+  after?: Maybe<Scalars['String']>;
+  first: Scalars['Int'];
+};
+
+
+export type QueryProductArgs = {
+  locator: Array<IStoreSelectedFacet>;
+};
+
+
+export type QuerySearchArgs = {
+  after?: Maybe<Scalars['String']>;
+  first: Scalars['Int'];
+  selectedFacets?: Maybe<Array<IStoreSelectedFacet>>;
+  sort?: Maybe<StoreSort>;
+  term?: Maybe<Scalars['String']>;
+};
+
+export type StoreAggregateOffer = {
+  __typename?: 'StoreAggregateOffer';
+  highPrice: Scalars['Float'];
+  lowPrice: Scalars['Float'];
+  offerCount: Scalars['Int'];
+  offers: Array<StoreOffer>;
+  priceCurrency: Scalars['String'];
+};
+
+export type StoreAggregateRating = {
+  __typename?: 'StoreAggregateRating';
+  ratingValue: Scalars['Float'];
+  reviewCount: Scalars['Int'];
+};
+
+export type StoreAuthor = {
+  __typename?: 'StoreAuthor';
+  name: Scalars['String'];
+};
+
+export type StoreBrand = {
+  __typename?: 'StoreBrand';
+  name: Scalars['String'];
+};
+
+export type StoreBreadcrumbList = {
+  __typename?: 'StoreBreadcrumbList';
+  itemListElement: Array<StoreListItem>;
+  numberOfItems: Scalars['Int'];
+};
+
+export type StoreCart = {
+  __typename?: 'StoreCart';
+  messages: Array<StoreCartMessage>;
+  order: StoreOrder;
+};
+
+export type StoreCartMessage = {
+  __typename?: 'StoreCartMessage';
+  status: StoreStatus;
+  text: Scalars['String'];
+};
+
+export type StoreCollection = {
+  __typename?: 'StoreCollection';
+  breadcrumbList: StoreBreadcrumbList;
+  id: Scalars['ID'];
+  meta: StoreCollectionMeta;
+  seo: StoreSeo;
+  slug: Scalars['String'];
+  type: StoreCollectionType;
+};
+
+export type StoreCollectionConnection = {
+  __typename?: 'StoreCollectionConnection';
+  edges: Array<StoreCollectionEdge>;
+  pageInfo: StorePageInfo;
+};
+
+export type StoreCollectionEdge = {
+  __typename?: 'StoreCollectionEdge';
+  cursor: Scalars['String'];
+  node: StoreCollection;
+};
+
+export type StoreCollectionFacet = {
+  __typename?: 'StoreCollectionFacet';
+  key: Scalars['String'];
+  value: Scalars['String'];
+};
+
+export type StoreCollectionMeta = {
+  __typename?: 'StoreCollectionMeta';
+  selectedFacets: Array<StoreCollectionFacet>;
+};
+
+export const enum StoreCollectionType {
+  Brand = 'Brand',
+  Category = 'Category',
+  Cluster = 'Cluster',
+  Department = 'Department'
+};
+
+export type StoreFacet = {
+  __typename?: 'StoreFacet';
+  key: Scalars['String'];
+  label: Scalars['String'];
+  type: StoreFacetType;
+  values: Array<StoreFacetValue>;
+};
+
+export const enum StoreFacetType {
+  Boolean = 'BOOLEAN',
+  Range = 'RANGE'
+};
+
+export type StoreFacetValue = {
+  __typename?: 'StoreFacetValue';
+  label: Scalars['String'];
+  quantity: Scalars['Int'];
+  selected: Scalars['Boolean'];
+  value: Scalars['String'];
+};
+
+export type StoreImage = {
+  __typename?: 'StoreImage';
+  alternateName: Scalars['String'];
+  url: Scalars['String'];
+};
+
+export type StoreListItem = {
+  __typename?: 'StoreListItem';
+  item: Scalars['String'];
+  name: Scalars['String'];
+  position: Scalars['Int'];
+};
+
+export type StoreOffer = {
+  __typename?: 'StoreOffer';
+  availability: Scalars['String'];
+  itemCondition: Scalars['String'];
+  itemOffered: StoreProduct;
+  listPrice: Scalars['Float'];
+  price: Scalars['Float'];
+  priceCurrency: Scalars['String'];
+  priceValidUntil: Scalars['String'];
+  quantity: Scalars['Int'];
+  seller: StoreOrganization;
+  sellingPrice: Scalars['Float'];
+};
+
+export type StoreOrder = {
+  __typename?: 'StoreOrder';
+  acceptedOffer: Array<StoreOffer>;
+  orderNumber: Scalars['String'];
+};
+
+export type StoreOrganization = {
+  __typename?: 'StoreOrganization';
+  identifier: Scalars['String'];
+};
+
+export type StorePageInfo = {
+  __typename?: 'StorePageInfo';
+  endCursor: Scalars['String'];
+  hasNextPage: Scalars['Boolean'];
+  hasPreviousPage: Scalars['Boolean'];
+  startCursor: Scalars['String'];
+  totalCount: Scalars['Int'];
+};
+
+export type StoreProduct = {
+  __typename?: 'StoreProduct';
+  aggregateRating: StoreAggregateRating;
+  brand: StoreBrand;
+  breadcrumbList: StoreBreadcrumbList;
+  description: Scalars['String'];
+  gtin: Scalars['String'];
+  image: Array<StoreImage>;
+  isVariantOf: StoreProductGroup;
+  name: Scalars['String'];
+  offers: StoreAggregateOffer;
+  productID: Scalars['String'];
+  review: Array<StoreReview>;
+  seo: StoreSeo;
+  sku: Scalars['String'];
+  slug: Scalars['String'];
+};
+
+export type StoreProductConnection = {
+  __typename?: 'StoreProductConnection';
+  edges: Array<StoreProductEdge>;
+  pageInfo: StorePageInfo;
+};
+
+export type StoreProductEdge = {
+  __typename?: 'StoreProductEdge';
+  cursor: Scalars['String'];
+  node: StoreProduct;
+};
+
+export type StoreProductGroup = {
+  __typename?: 'StoreProductGroup';
+  hasVariant: Array<StoreProduct>;
+  name: Scalars['String'];
+  productGroupID: Scalars['String'];
+};
+
+export type StoreReview = {
+  __typename?: 'StoreReview';
+  author: StoreAuthor;
+  reviewRating: StoreReviewRating;
+};
+
+export type StoreReviewRating = {
+  __typename?: 'StoreReviewRating';
+  bestRating: Scalars['Float'];
+  ratingValue: Scalars['Float'];
+};
+
+export type StoreSearchResult = {
+  __typename?: 'StoreSearchResult';
+  facets: Array<StoreFacet>;
+  products: StoreProductConnection;
+};
+
+export type StoreSeo = {
+  __typename?: 'StoreSeo';
+  canonical: Scalars['String'];
+  description: Scalars['String'];
+  title: Scalars['String'];
+  titleTemplate: Scalars['String'];
+};
+
+export const enum StoreSort {
+  DiscountDesc = 'discount_desc',
+  NameAsc = 'name_asc',
+  NameDesc = 'name_desc',
+  OrdersDesc = 'orders_desc',
+  PriceAsc = 'price_asc',
+  PriceDesc = 'price_desc',
+  ReleaseDesc = 'release_desc',
+  ScoreDesc = 'score_desc'
+};
+
+export const enum StoreStatus {
+  Error = 'ERROR',
+  Info = 'INFO',
+  Warning = 'WARNING'
+};

package/src/index.ts

@@ -0,0 +1,33 @@
+import { makeExecutableSchema } from '@graphql-tools/schema'
+
+import {
+  getContextFactory as getContextFactoryVTEX,
+  getResolvers as getResolversVTEX,
+} from './platforms/vtex'
+import { typeDefs } from './typeDefs'
+import type { Options as OptionsVTEX } from './platforms/vtex'
+
+export * from './__generated__/schema'
+
+export type Options = OptionsVTEX
+
+const platforms = {
+  vtex: {
+    getResolvers: getResolversVTEX,
+    getContextFactory: getContextFactoryVTEX,
+  },
+}
+
+export const getTypeDefs = () => typeDefs
+
+export const getResolvers = (options: Options) =>
+  platforms[options.platform].getResolvers(options)
+
+export const getContextFactory = (options: Options) =>
+  platforms[options.platform].getContextFactory(options)
+
+export const getSchema = async (options: Options) =>
+  makeExecutableSchema({
+    resolvers: getResolvers(options),
+    typeDefs: getTypeDefs(),
+  })

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

@@ -0,0 +1,100 @@
+import { fetchAPI } from '../fetch'
+import type {
+  Simulation,
+  SimulationArgs,
+  SimulationOptions,
+} from './types/Simulation'
+import type { CategoryTree } from './types/CategoryTree'
+import type { Options } from '../..'
+import type { Brand } from './types/Brand'
+import type { OrderForm, OrderFormInputItem } from './types/OrderForm'
+
+const BASE_INIT = {
+  method: 'POST',
+  headers: {
+    'content-type': 'application/json',
+  },
+}
+
+const getBase = ({ account, environment }: Options) =>
+  `http://${account}.${environment}.com.br`
+
+export const VtexCommerce = (options: Options) => {
+  const { channel } = options
+  const base = getBase(options)
+
+  return {
+    catalog: {
+      brand: {
+        list: (): Promise<Brand[]> =>
+          fetchAPI(`${base}/api/catalog_system/pub/brand/list`),
+      },
+      category: {
+        tree: (depth = 3): Promise<CategoryTree[]> =>
+          fetchAPI(`${base}/api/catalog_system/pub/category/tree/${depth}`),
+      },
+    },
+    checkout: {
+      simulation: (
+        args: SimulationArgs,
+        { salesChannel }: SimulationOptions = { salesChannel: channel }
+      ): Promise<Simulation> => {
+        const params = new URLSearchParams({
+          sc: salesChannel,
+        })
+
+        return fetchAPI(
+          `${base}/api/checkout/pub/orderForms/simulation?${params.toString()}`,
+          {
+            ...BASE_INIT,
+            body: JSON.stringify(args),
+          }
+        )
+      },
+      orderForm: ({
+        id,
+        refreshOutdatedData = true,
+        salesChannel = channel,
+      }: {
+        id: string
+        refreshOutdatedData?: boolean
+        salesChannel?: string
+      }): Promise<OrderForm> => {
+        const params = new URLSearchParams({
+          refreshOutdatedData: refreshOutdatedData.toString(),
+          sc: salesChannel,
+        })
+
+        return fetchAPI(
+          `${base}/api/checkout/pub/orderForm/${id}?${params.toString()}`,
+          BASE_INIT
+        )
+      },
+      updateOrderFormItems: ({
+        id,
+        orderItems,
+        allowOutdatedData = 'paymentData',
+        salesChannel = channel,
+      }: {
+        id: string
+        orderItems: OrderFormInputItem[]
+        allowOutdatedData?: 'paymentData'
+        salesChannel?: string
+      }): Promise<OrderForm> => {
+        const params = new URLSearchParams({
+          allowOutdatedData,
+          sc: salesChannel,
+        })
+
+        return fetchAPI(
+          `${base}/api/checkout/pub/orderForm/${id}/items?${params}`,
+          {
+            ...BASE_INIT,
+            body: JSON.stringify({ orderItems }),
+            method: 'PATCH',
+          }
+        )
+      },
+    },
+  }
+}

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

@@ -0,0 +1,8 @@
+export interface Brand {
+  id: number
+  name: string
+  isActive: boolean
+  title: string
+  metaTagDescription: string
+  imageURL: null | string
+}

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

@@ -0,0 +1,9 @@
+export interface CategoryTree {
+  id: number
+  name: string
+  hasChildren: boolean
+  url: string
+  children: CategoryTree[]
+  Title: string
+  MetaTagDescription: string
+}