@evenicanpm/storefront-core 1.0.0-alpha → 1.0.0

package/src/api-manager/index.ts

@@ -4,6 +4,7 @@ import { D365Datasource } from "./datasources/d365/index";
 import rawConfig from "./api-manager.config.json";
 import { z } from "zod";
 import { getContextFromCookie } from "./datasources/d365/utils/get-context-cookie";
+
 type EntityNames = keyof DatasourceApis;
 
 interface Config {
@@ -18,9 +19,25 @@ const Config = z.object({
   overrides: z.record(z.string(), z.string()),
 });
 
+const OVERRIDES_FILE = "./overrides.datasource.ts";
+const CORE_DATASOURCES = [
+  "user",
+  "session",
+  "cart",
+  "product",
+  "categories",
+  "order",
+  "address",
+  "organization",
+];
 /**
  * Loads up all specified apis/datasources based on parsed config
- * and returns the ApiManager object.
+ * and returns the ApiManager object. Also handles "project" overrides
+ * by checking inside a specific folder for API's. Will grab default export
+ * from specified folder, validate the API schema and then prioritize returning
+ * that from api-manager.
+ *
+ * In this way, we have two levels of configuration of the api-manager.
  * @returns ApiManager object.
  */
 async function createApiManager() {
@@ -32,6 +49,26 @@ async function createApiManager() {
     }
   }
 
+  const storefrontOverrides: { [key: string]: any } = {};
+
+  // @ts-ignore
+  function importAll(r) {
+    r.keys().forEach(
+      (key: keyof typeof storefrontOverrides) =>
+        (storefrontOverrides[key] = r(key)),
+    );
+  }
+
+  // Arguments must be literals not variables.
+  importAll(
+    // @ts-ignore
+    require.context(
+      "@storefront/extensions/api-manager-overrides",
+      true,
+      /overrides\.datasource\.ts/,
+    ),
+  );
+
   const context = await getContextFromCookie();
   const datasourceMap: Record<string, Datasource> = {
     d365: new D365Datasource("d365", context),
@@ -46,6 +83,11 @@ async function createApiManager() {
   );
 
   const getDatasource = (entityName: EntityNames) => {
+    // Overrides from storefront
+    if (storefrontOverrides?.[OVERRIDES_FILE]?.["default"]?.[entityName]) {
+      return storefrontOverrides[OVERRIDES_FILE]["default"];
+    }
+
     const override = config?.overrides?.[entityName];
     if (override) {
       return (
@@ -55,17 +97,22 @@ async function createApiManager() {
     }
     return primaryDatasource;
   };
+  const datasources = {};
 
-  return {
-    user: getDatasource("user").user,
-    session: getDatasource("session").session,
-    cart: getDatasource("cart").cart,
-    product: getDatasource("product").product,
-    categories: getDatasource("categories").categories,
-    order: getDatasource("order").order,
-    address: getDatasource("address").address,
-    organization: getDatasource("organization").organization,
-  };
+  CORE_DATASOURCES.forEach((entityName) => {
+    const datasource = getDatasource(entityName as EntityNames);
+    datasources[entityName] = datasource[entityName];
+  });
+  storefrontOverrides[OVERRIDES_FILE]?.default &&
+    Object.keys(storefrontOverrides[OVERRIDES_FILE]["default"]).forEach(
+      (key) => {
+        if (!CORE_DATASOURCES.includes(key)) {
+          datasources[key] =
+            storefrontOverrides[OVERRIDES_FILE]["default"][key];
+        }
+      },
+    );
+  return datasources;
 }
 
 export default createApiManager;

package/src/api-manager/lib/get-graphql-client.ts

@@ -6,9 +6,6 @@ import { getServerSession } from "next-auth/next";
 // TODO: Get auth inside client packages
 import authOptions from "@/auth/auth-options";
 import { cookies } from "next/headers";
-
-const API_URL = process.env.REACT_APP_E4_API_ENDPOINT; //`https://api.e4.local/graphql`;
-
 /**
  * Initializes and returns a cached GraphQL client
  * @param withAuth (optional) - If true, includes the authorization token
@@ -41,10 +38,13 @@ const getGraphQLClient = async (withAuth = false) => {
 
   // Best Practice: Never reuse a GraphQL client that mutates headers across different requests in server environments.
   // When we resuse the client instance, sometimes the token is missing in e4 backend.
-  const client = new GraphQLClient(API_URL, {
-    headers,
-    credentials: "include",
-  });
+  const client = new GraphQLClient(
+    process.env.NEXT_PUBLIC_E4_API_ENDPOINT || "",
+    {
+      headers,
+      credentials: "include",
+    },
+  );
 
   client.setHeaders(headers);
   return getSdk(client);

package/src/api-manager/schemas/address.schema.ts

@@ -9,25 +9,6 @@ export const addressTypeSchema = z
   })
   .optional();
 
-// export const addressSchema = z.object({
-//     Id:z.string().optional(),
-//     Name:z.string().optional(),
-//     FirstName: z.string().optional(),
-//     LastName: z.string().optional(),
-//     IsPrimary:z.boolean().optional(),
-//     AddressType: addressTypeSchema,
-//     AddressLine1: z.string().optional(),
-//     AddressLine2: z.string().optional(),
-//     City: z.string().optional(),
-//     StateId: z.string().optional(),
-//     StateName: z.string().optional(),
-//     CountryId: z.string().optional(),
-//     CountryName: z.string().optional(),
-//     CountryCode: z.string().optional(),
-//     ZipCode: z.string().optional(),
-//     Phone: z.string().optional(),
-// });
-
 const getCountriesInput = z.object({
   locale: z.string().optional(),
 });
@@ -40,6 +21,7 @@ const getDeliveryOptionsInput = z.object({
   shippingAddress: addressSchema,
   cartLineIds: z.array(z.string()),
 });
+
 export type GetCountriesInput = z.infer<typeof getCountriesInput>;
 export type GetStatesInput = z.infer<typeof getStatesInput>;
 export type GetDeliveryOptionsInput = z.infer<typeof getDeliveryOptionsInput>;

package/src/api-manager/schemas/cart.schema.ts

@@ -4,6 +4,7 @@ import {
   cartLineSchema,
   cartSchema,
   retrievePaymentResultSettingsSchema,
+  searchAreaSchema,
   simpleProductSchema,
   tokenizedPaymentCardSchema,
 } from "./d365.schema";
@@ -67,6 +68,20 @@ export const removeCartLineDeliveryModeInput = z.object({
   cart: extendedCartSchema.partial(),
 });
 
+const SimpleCartLinesSearchCriteria = z.object({
+  productId: z.number(),
+  deliveryMode: z.string().optional(),
+  inventLocationId: z.string().optional(),
+});
+
+const InventorySearchCartLinesCriteriaInput = z.object({
+  searchCriteria: z.object({
+    cartLines: SimpleCartLinesSearchCriteria.array(),
+    searchArea: searchAreaSchema.optional(),
+  }),
+  allDimensionsSelected: z.boolean(),
+});
+
 // Typescript Types
 // export type Cart = z.infer<typeof cartSchema>;
 // export type CartLine = z.infer<typeof cartLineSchema>;
@@ -90,3 +105,6 @@ export type RemoveCartLineDeliveryModeInput = z.infer<
   typeof removeCartLineDeliveryModeInput
 >;
 export type CheckoutInput = z.infer<typeof checkoutInput>;
+export type InventorySearchCartLinesCriteriaInput = z.infer<
+  typeof InventorySearchCartLinesCriteriaInput
+>;

package/src/api-manager/schemas/product.schema.ts

@@ -6,6 +6,7 @@ import {
   productSearchResultSchema,
   queryResultSettingsSchema,
   searchAreaSchema,
+  productPriceSchema,
 } from "./d365.schema";
 import {
   AttributeValue,
@@ -117,6 +118,10 @@ const InventorySearchCriteriaInput = z.object({
   allDimensionsSelected: z.boolean(),
 });
 
+const productPriceInput = z.object({
+  productIds: z.number().array(),
+});
+
 // entities
 export type Product = z.infer<typeof productSchema>;
 export type ProductDetails = SimpleProduct & {
@@ -138,3 +143,5 @@ export type SearchByCriteriaResponse = z.infer<typeof searchByCriteriaResponse>;
 export type InventorySearchCriteriaInput = z.infer<
   typeof InventorySearchCriteriaInput
 >;
+export type ProductPrice = z.infer<typeof productPriceSchema>;
+export type ProductPriceInput = z.infer<typeof productPriceInput>;

package/src/api-manager/schemas/user.schema.ts

@@ -1,5 +1,10 @@
 import z from "zod";
-import { customerSchema } from "./d365.schema";
+import {
+  customerSchema,
+  productListLineSchema,
+  productListSchema,
+  simpleProductSchema,
+} from "./d365.schema";
 
 export const userCountsSchema = z.object({
   orderCount: z.number().optional(),
@@ -12,3 +17,49 @@ export const extendedCustomerSchema = customerSchema.extend({
 
 export type User = z.infer<typeof extendedCustomerSchema>;
 export type UserCounts = z.infer<typeof userCountsSchema>;
+
+// Wishlist
+
+export const extendedProductListLineSchema = productListLineSchema.extend({
+  Product: simpleProductSchema.optional(),
+});
+
+export const extendedWishlistSchema = productListSchema
+  .omit({ ProductListLines: true })
+  .extend({ ProductListLines: extendedProductListLineSchema.array() });
+
+const wishlistBaseInput = z.object({
+  Id: z.string(),
+});
+
+export const wishlistCreateInput = wishlistBaseInput.extend({
+  Name: z.string(),
+  Comment: z.string().optional(),
+  IsPublic: z.boolean().optional(),
+});
+
+const updateWishlistInput = wishlistBaseInput.extend({
+  Name: z.string(),
+});
+
+const wishlistLinesInput = wishlistBaseInput.extend({
+  ProductListLines: productListLineSchema.array(),
+});
+
+const copyCartToWishlistInput = z.object({
+  Id: z.string(),
+  CartID: z.string(),
+  IsRewrite: z.boolean(),
+  IsQuantityAggregate: z.boolean(),
+});
+
+export type Wishlist = z.infer<typeof productListSchema>;
+export type ExtendedWishlist = z.infer<typeof extendedWishlistSchema>;
+export type ExtendedProductListLine = z.infer<
+  typeof extendedProductListLineSchema
+>;
+export type WishlistDetailInput = z.infer<typeof wishlistBaseInput>;
+export type WishlistCreateInput = z.infer<typeof wishlistCreateInput>;
+export type UpdateWishlistInput = z.infer<typeof updateWishlistInput>;
+export type WishlistLinesInput = z.infer<typeof wishlistLinesInput>;
+export type CopyCartToWishlistInput = z.infer<typeof copyCartToWishlistInput>;

package/src/api-manager/services/address/queries/get-states.ts

@@ -5,7 +5,7 @@ import { createQuery, createApiPath } from "../../create-query";
 const apiPath = createApiPath("address", "getStates");
 const config = {
   queryKey: "states",
-  disablePropertis: ["countryId"],
+  disableProperties: ["countryId"],
 };
 
 const getStates = createQuery<GetStatesInput, StateProvinceInfo[]>(

package/src/api-manager/services/cart/mutations/checkout.ts

@@ -1,11 +1,26 @@
 import { Cart, CheckoutInput } from "@/api-manager/schemas/cart.schema";
 import { createApiPath } from "../../create-query";
 import { useCreateMutation } from "../../create-mutation";
+import { deleteCartCookie } from "@/api-manager/lib/cart-cookie-handler";
+import getCart from "../queries/get-cart";
+import { useQueryClient } from "@tanstack/react-query";
 
 const apiPath = createApiPath("cart", "checkout");
 
 const useCheckout = () => {
-  return useCreateMutation<CheckoutInput, Cart>(apiPath);
+  const queryClient = useQueryClient();
+  return useCreateMutation<CheckoutInput, Cart>(apiPath, {
+    onSuccess: async (_data, variables) => {
+      // Delete old cart cookie
+      await deleteCartCookie();
+
+      queryClient.invalidateQueries({ queryKey: ["cart"] });
+    },
+    onError: (error) => {
+      console.error("Checkout failed:", error);
+      // Handle error appropriately, e.g., show a notification
+    },
+  });
 };
 
 export default useCheckout;

package/src/api-manager/services/cart/queries/get-cart-lines-inventory.ts

@@ -0,0 +1,15 @@
+import { ProductWarehouseInventoryInformation } from "@msdyn365-commerce/retail-proxy";
+import { InventorySearchCartLinesCriteriaInput } from "@/api-manager/schemas/cart.schema";
+import { createApiPath, createQuery } from "../../create-query";
+
+const apiPath = createApiPath("cart", "getCartLinesInventory");
+
+const getCartLinesInventory = createQuery<
+  InventorySearchCartLinesCriteriaInput,
+  ProductWarehouseInventoryInformation
+>(apiPath, {
+  queryKey: "cart-lines-Inventory",
+  disableProperties: ["allDimensionsSelected", "searchCriteria"],
+});
+
+export default getCartLinesInventory;

package/src/api-manager/services/create-extension-query.ts

@@ -0,0 +1,26 @@
+import { QueryFunction } from "@tanstack/react-query";
+
+/**
+ * This is a wrapper function for building an extension query.
+ * We don't require full-blown api-manager instance for extensions,
+ * because there is no data switching. Also not exporting all the react-query
+ * methods to keep the code flexible and adaptable for projects. This wrapper
+ * handles client side mutex to prevent multiple requests firing after refresh
+ * token has been found to be expired.
+ *
+ * During development, any additional hooks, events and extensions can be added to
+ * this function without affecting project.
+ *
+ * @param queryKey
+ * @param queryFn
+ * @returns
+ */
+const buildQueryData = <TQueryFnData = unknown, TQueryFnInput = unknown>(
+  queryKey: string,
+  queryFn: QueryFunction<TQueryFnData>,
+) => {
+  // TODO: insert mutex stuff here
+  return { queryKey: [queryKey], queryFn };
+};
+
+export default buildQueryData;

package/src/api-manager/services/create-mutation.ts

@@ -31,7 +31,11 @@ export const useCreateMutation = <TInput, TOutput>(
         body: JSON.stringify({ input, apiManagerPath }),
       });
       if (!response.ok) {
-        throw new Error("Mutation failed");
+        const error = await response.json();
+        let errorMsg = `${error.error}`;
+        if (error.message) errorMsg += ` - ${error.message}`;
+
+        throw new Error(errorMsg);
       }
       return response.json();
     },

package/src/api-manager/services/create-query.ts

@@ -79,7 +79,6 @@ export const createQuery = <TInput, TOutput>(
       queryFn,
       enabled,
     };
-
     return data;
   };
 

package/src/api-manager/services/organization/queries/get-channel-configuration.ts

@@ -6,7 +6,7 @@ const config = {
   queryKey: "channelConfiguration",
 };
 
-const getChannelConfiguration = createQuery<null, ChannelConfiguration[]>(
+const getChannelConfiguration = createQuery<null, ChannelConfiguration>(
   apiPath,
   config,
 );

package/src/api-manager/services/product/queries/get-product-prices.ts

@@ -0,0 +1,16 @@
+import {
+  ProductPriceInput,
+  ProductPrice,
+} from "@/api-manager/schemas/product.schema";
+import { createApiPath, createQuery } from "../../create-query";
+
+const apiPath = createApiPath("product", "getProductPrices");
+
+const getProductPrices = createQuery<ProductPriceInput, ProductPrice[]>(
+  apiPath,
+  {
+    queryKey: "product-prices",
+  },
+);
+
+export default getProductPrices;

package/src/api-manager/services/product/queries/search-products.ts

@@ -5,6 +5,7 @@ import { createApiPath, createQuery } from "../../create-query";
 const apiPath = createApiPath("product", "searchProducts");
 const searchProducts = createQuery<searchProductsInput, ProductSearchResult[]>(
   apiPath,
+  { disableProperties: ["searchText"] },
 );
 
 export default searchProducts;

package/src/api-manager/services/user/mutations/add-to-wishlist.ts

@@ -0,0 +1,24 @@
+import { useQueryClient } from "@tanstack/react-query";
+import {
+  Wishlist,
+  WishlistLinesInput,
+} from "@/api-manager/schemas/user.schema";
+import { createApiPath } from "../../create-query";
+import { useCreateMutation } from "../../create-mutation";
+import { getWishlistsQueryKey } from "../queries/get-wishlists";
+
+const apiPath = createApiPath("user", "addProductsToWishlist");
+
+const useAddToWishlist = () => {
+  const queryClient = useQueryClient();
+
+  return useCreateMutation<WishlistLinesInput, Wishlist>(apiPath, {
+    onSuccess: (_data, variables) => {
+      queryClient.invalidateQueries({
+        queryKey: [getWishlistsQueryKey, variables.Id],
+      });
+    },
+  });
+};
+
+export default useAddToWishlist;

package/src/api-manager/services/user/mutations/copy-cart-to-wishlist.ts

@@ -0,0 +1,23 @@
+import { useQueryClient } from "@tanstack/react-query";
+import {
+  CopyCartToWishlistInput,
+  Wishlist,
+} from "@/api-manager/schemas/user.schema";
+import { createApiPath } from "../../create-query";
+import { useCreateMutation } from "../../create-mutation";
+
+const apiPath = createApiPath("user", "copyCartToWishlist");
+
+const useCopyCartToWishlist = () => {
+  const queryClient = useQueryClient();
+
+  return useCreateMutation<CopyCartToWishlistInput, Wishlist>(apiPath, {
+    onSuccess: (_data, _variables) => {
+      queryClient.invalidateQueries({
+        queryKey: ["wishlistDetails", _variables.Id],
+      });
+    },
+  });
+};
+
+export default useCopyCartToWishlist;

package/src/api-manager/services/user/mutations/create-wishlist.ts

@@ -2,16 +2,16 @@ import { useQueryClient } from "@tanstack/react-query";
 import { createApiPath } from "../../create-query";
 import { useCreateMutation } from "../../create-mutation";
 import {
-  CreateWishListInput,
-  WishList,
-} from "../../../datasources/e4/graphqlRequestSdk";
+  Wishlist,
+  WishlistCreateInput,
+} from "@/api-manager/schemas/user.schema";
 
 const apiPath = createApiPath("user", "createWishlist");
 
 const useCreateWishlist = () => {
   const queryClient = useQueryClient();
 
-  return useCreateMutation<CreateWishListInput, WishList>(apiPath, {
+  return useCreateMutation<WishlistCreateInput, Wishlist>(apiPath, {
     onSuccess: () => {
       queryClient.invalidateQueries({ queryKey: ["wishlists"] });
     },

package/src/api-manager/services/user/mutations/delete-wishlist.ts

@@ -1,17 +1,18 @@
 import { useQueryClient } from "@tanstack/react-query";
 import { createApiPath } from "../../create-query";
 import { useCreateMutation } from "../../create-mutation";
+import { WishlistDetailInput } from "@/api-manager/schemas/user.schema";
+import { getWishlistsQueryKey } from "../queries/get-wishlists";
 
 const apiPath = createApiPath("user", "deleteWishlist");
 
 const useDeleteWishlist = () => {
   const queryClient = useQueryClient();
 
-  return useCreateMutation<string, string>(apiPath, {
+  return useCreateMutation<WishlistDetailInput, void>(apiPath, {
     onSuccess: () => {
-      queryClient.invalidateQueries({ queryKey: ["wishlists"] });
+      queryClient.invalidateQueries({ queryKey: [getWishlistsQueryKey] });
     },
   });
 };
-
 export default useDeleteWishlist;

package/src/api-manager/services/user/mutations/remove-from-wishlist.ts

@@ -0,0 +1,21 @@
+import { useQueryClient } from "@tanstack/react-query";
+import { WishlistLinesInput } from "@/api-manager/schemas/user.schema";
+import { createApiPath } from "../../create-query";
+import { useCreateMutation } from "../../create-mutation";
+import { getWishlistDetailsQueryKey } from "../queries/get-wishlist-details";
+
+const apiPath = createApiPath("user", "removeProductsFromWishlist");
+
+const useRemoveFromWishlist = () => {
+  const queryClient = useQueryClient();
+
+  return useCreateMutation<WishlistLinesInput, void>(apiPath, {
+    onSuccess: (_data, _variables) => {
+      queryClient.invalidateQueries({
+        queryKey: [getWishlistDetailsQueryKey, { Id: _variables.Id }],
+      });
+    },
+  });
+};
+
+export default useRemoveFromWishlist;

package/src/api-manager/services/user/mutations/update-wishlist.ts

@@ -0,0 +1,23 @@
+import { useQueryClient } from "@tanstack/react-query";
+import {
+  Wishlist,
+  WishlistLinesInput,
+} from "@/api-manager/schemas/user.schema";
+import { useCreateMutation } from "../../create-mutation";
+import { createApiPath } from "../../create-query";
+
+const apiPath = createApiPath("user", "updateWishlist");
+
+const useUpdateWishlist = () => {
+  const queryClient = useQueryClient();
+
+  return useCreateMutation<WishlistLinesInput, Wishlist>(apiPath, {
+    onSuccess: (_data, _variables) => {
+      queryClient.invalidateQueries({
+        queryKey: ["wishlistDetails", _variables.Id],
+      });
+    },
+  });
+};
+
+export default useUpdateWishlist;

package/src/api-manager/services/user/queries/get-wishlist-details.ts

@@ -1,10 +1,17 @@
+import {
+  ExtendedWishlist,
+  WishlistDetailInput,
+} from "@/api-manager/schemas/user.schema";
 import { createApiPath, createQuery } from "../../create-query";
-import { WishList } from "../../../datasources/e4/graphqlRequestSdk";
 
+export const getWishlistDetailsQueryKey = "wish-list-details";
 const apiPath = createApiPath("user", "getWishlistDetails");
 
-const getWishListDetails = createQuery<string, WishList>(apiPath, {
-  queryKey: "wish-list-details",
-});
+const getWishListDetails = createQuery<WishlistDetailInput, ExtendedWishlist>(
+  apiPath,
+  {
+    queryKey: getWishlistDetailsQueryKey,
+  },
+);
 
 export default getWishListDetails;

package/src/api-manager/services/user/queries/get-wishlists.ts

@@ -1,10 +1,11 @@
-import { WishList } from "../../../datasources/e4/graphqlRequestSdk";
+import { Wishlist } from "@/api-manager/schemas/user.schema";
 import { createApiPath, createQuery } from "../../create-query";
 
+export const getWishlistsQueryKey = "wishlists";
 const apiPath = createApiPath("user", "getWishlists");
 
-const getWishlists = createQuery<null, WishList[]>(apiPath, {
-  queryKey: "wish-lists",
+const getWishlists = createQuery<null, Wishlist[]>(apiPath, {
+  queryKey: getWishlistsQueryKey,
 });
 
 export default getWishlists;