@meeovi/layer-commerce 1.0.10 → 1.0.13

package/app/composables/methods/cart.ts

@@ -0,0 +1,119 @@
+import type { Simplify } from "type-fest";
+import type { Maybe, SfCart } from "../models";
+
+export interface GetCartExtendedArgs {}
+export interface GetCartCustomArgs {}
+
+export type GetCartArgs = {
+  /**
+   * Unique identifier of cart
+   */
+  cartId?: string;
+  //$extended?: GetCartExtendedArgs;
+  //$custom?: GetCartCustomArgs;
+};
+
+export interface AddCartLineItemExtendedArgs {}
+export interface AddCartLineItemCustomArgs {}
+
+export type AddCartLineItemArgs = {
+  /**
+   * Product unique identifier - for commercetools it's a SKU, for sap it's a product code
+   */
+  productId: string;
+  sku: Maybe<string>;
+  /**
+   * Quantity of product to add to cart
+   * @default 1
+   */
+  quantity?: number;
+  /**
+   * Unique identifier of cart
+   */
+  cartId?: string;
+  //$extended?: AddCartLineItemExtendedArgs;
+  //$custom?: AddCartLineItemCustomArgs;
+};
+
+export interface UpdateCartLineItemExtendedArgs {}
+export interface UpdateCartLineItemCustomArgs {}
+
+export type UpdateCartLineItemArgs = {
+  lineItemId: string;
+  quantity: number;
+  /**
+   * Unique identifier of cart
+   */
+  cartId?: string;
+  //$extended?: UpdateCartLineItemExtendedArgs;
+  //$custom?: UpdateCartLineItemCustomArgs;
+};
+
+export interface RemoveCartLineItemExtendedArgs {}
+export interface RemoveCartLineItemCustomArgs {}
+
+export type RemoveCartLineItemArgs = {
+  lineItemId: string;
+  /**
+   * Unique identifier of cart
+   */
+  cartId?: string;
+  //$extended?: RemoveCartLineItemExtendedArgs;
+  //$custom?: RemoveCartLineItemCustomArgs;
+};
+
+export interface ApplyCouponToCartExtendedArgs {}
+export interface ApplyCouponToCartCustomArgs {}
+
+export type ApplyCouponToCartArgs = {
+  couponCode: string;
+  /**
+   * Unique identifier of cart
+   */
+  cartId?: string;
+  //$extended?: ApplyCouponToCartExtendedArgs;
+  //$custom?: ApplyCouponToCartCustomArgs;
+};
+
+export interface RemoveCouponFromCartExtendedArgs {}
+export interface RemoveCouponFromCartCustomArgs {}
+
+export type RemoveCouponFromCartArgs = {
+  /**
+   * Don't confuse it with coupon code. It can be retrieved from cart.appliedCoupons
+   */
+  couponId: string;
+  /**
+   * Unique identifier of cart
+   */
+  cartId?: string;
+  //$extended?: RemoveCouponFromCartExtendedArgs;
+  //$custom?: RemoveCouponFromCartCustomArgs;
+};
+
+/**
+ * Get all information about customer's cart
+ */
+export type GetCart = (args?: Simplify<GetCartArgs>) => Promise<SfCart>;
+
+/**
+ * Add product to cart
+ */
+export type AddCartLineItem = (args: Simplify<AddCartLineItemArgs>) => Promise<SfCart>;
+
+/**
+ * Update product quantity in cart
+ */
+export type UpdateCartLineItem = (args: Simplify<UpdateCartLineItemArgs>) => Promise<SfCart>;
+
+/**
+ * Remove product from cart
+ */
+export type RemoveCartLineItem = (args: Simplify<RemoveCartLineItemArgs>) => Promise<SfCart>;
+
+/**
+ * Apply a coupon to cart to get a discount
+ */
+export type ApplyCouponToCart = (args: Simplify<ApplyCouponToCartArgs>) => Promise<SfCart>;
+
+export type RemoveCouponFromCart = (args: Simplify<RemoveCouponFromCartArgs>) => Promise<SfCart>;

package/app/composables/methods/category.ts

@@ -0,0 +1,27 @@
+import type { Simplify } from "type-fest";
+import type { SfCategory } from "../models";
+
+export interface GetCategoriesExtendedArgs {}
+export interface GetCategoriesCustomArgs {}
+
+export type GetCategoriesArgs = {
+  ids?: string[];
+  slugs?: string[];
+  //$extended?: GetCategoriesExtendedArgs;
+  //$custom?: GetCategoriesCustomArgs;
+};
+
+export type GetCategories = (args?: Simplify<GetCategoriesArgs>) => Promise<SfCategory[]>;
+
+export interface GetCategoryExtendedArgs {}
+export interface GetCategoryCustomArgs {}
+export type GetCategoryArgs = {
+  id: string;
+  //$extended?: GetCategoryExtendedArgs;
+  //$custom?: GetCategoryCustomArgs;
+};
+
+export type GetCategory = (args: Simplify<GetCategoryArgs>) => Promise<{
+  ancestors: SfCategory[];
+  category: SfCategory;
+}>;

package/app/composables/methods/checkout.ts

@@ -0,0 +1,54 @@
+import type { Simplify } from "type-fest";
+import type { SfCart, SfCreateAddressBody, SfCustomerAddress, SfShippingMethods } from "../models";
+
+export interface SetCustomerEmailExtendedArgs {}
+export interface SetCustomerEmailCustomArgs {}
+
+export type SetCustomerEmailArgs = {
+  email: string;
+  //$extended?: SetCustomerEmailExtendedArgs;
+  //$custom?: SetCustomerEmailCustomArgs;
+};
+
+export type SetShippingAddress = {
+  shippingAddress: SfCreateAddressBody | SfCustomerAddress;
+};
+
+export interface SetCartAddressExtendedArgs {}
+export interface SetCartAddressCustomArgs {}
+
+export type SetCartAddressArgs = SetShippingAddress & {
+  //$extended?: SetCartAddressExtendedArgs;
+  //$custom?: SetCartAddressCustomArgs;
+};
+
+export interface SetShippingMethodExtendedArgs {}
+export interface SetShippingMethodCustomArgs {}
+
+export type SetShippingMethodArgs = {
+  shippingMethodId: string;
+  //$extended?: SetShippingMethodExtendedArgs;
+  //$custom?: SetShippingMethodCustomArgs;
+};
+
+/**
+ * Set an email of active customer
+ */
+export type SetCustomerEmail = (args: Simplify<SetCustomerEmailArgs>) => Promise<SfCart>;
+
+/**
+ * Set customers adddress
+ * @example Set shipping address first
+ * setCartAddress({ shippingAddress: { ... } })
+ */
+export type SetCartAddress = (args: Simplify<SetCartAddressArgs>) => Promise<SfCart>;
+
+/**
+ * Get available shipping methods based on customer's shipping address
+ */
+export type GetAvailableShippingMethods = () => Promise<SfShippingMethods>;
+
+/**
+ * Choose a one shipping method from available shipping methods
+ */
+export type SetShippingMethod = (args: Simplify<SetShippingMethodArgs>) => Promise<SfCart>;

package/app/composables/methods/customer.ts

@@ -0,0 +1,52 @@
+import type { Simplify } from "type-fest";
+import type { SfCreateAddressBody, SfCustomerAddress, SfId } from "../models";
+
+export interface CreateCustomerAddressExtendedArgs {}
+export interface CreateCustomerAddressCustomArgs {}
+
+export type CreateCustomerAddressArgs = {
+  address: SfCreateAddressBody;
+  //$extended?: CreateCustomerAddressExtendedArgs;
+  //$custom?: CreateCustomerAddressCustomArgs;
+};
+
+export type CreateCustomerAddress = (args: Simplify<CreateCustomerAddressArgs>) => Promise<{
+  address: SfCustomerAddress;
+}>;
+
+export interface UpdateCustomerAddressExtendedArgs {}
+export interface UpdateCustomerAddressCustomArgs {}
+
+export type UpdateCustomerAddressArgs = {
+  id: SfId;
+  address: SfCreateAddressBody;
+  //$extended?: UpdateCustomerAddressExtendedArgs;
+  //$custom?: UpdateCustomerAddressCustomArgs;
+};
+
+export type UpdateCustomerAddress = (args: Simplify<UpdateCustomerAddressArgs>) => Promise<{
+  address: SfCustomerAddress;
+}>;
+
+export interface DeleteCustomerAddressExtendedArgs {}
+export interface DeleteCustomerAddressCustomArgs {}
+
+export type DeleteCustomerAddressArgs = {
+  id: SfId;
+  //$extended?: DeleteCustomerAddressExtendedArgs;
+  //$custom?: DeleteCustomerAddressCustomArgs;
+};
+
+export type DeleteCustomerAddress = (args: Simplify<DeleteCustomerAddressArgs>) => Promise<void>;
+
+export interface GetCustomerAddressesExtendedArgs {}
+export interface GetCustomerAddressesCustomArgs {}
+
+export type GetCustomerAddressesArgs = {
+  //$extended?: GetCustomerAddressesExtendedArgs;
+  //$custom?: GetCustomerAddressesCustomArgs;
+};
+
+export type GetCustomerAddresses = (args?: Simplify<GetCustomerAddressesArgs>) => Promise<{
+  addresses: SfCustomerAddress[];
+}>;

package/app/composables/methods/helpers.ts

@@ -0,0 +1,5 @@
+import type { SetCartAddressArgs, SetShippingAddress } from "./checkout";
+
+export function isShippingAddress(args: SetCartAddressArgs): args is SetShippingAddress {
+  return (args as SetShippingAddress).shippingAddress !== undefined;
+}

package/app/composables/methods/index.ts

@@ -0,0 +1,75 @@
+import type {
+  GetCustomer,
+  LoginCustomer,
+  LogoutCustomer,
+  RegisterCustomer,
+  UpdateCustomer,
+  ChangeCustomerPassword,
+} from "./auth";
+import type {
+  GetCart,
+  AddCartLineItem,
+  UpdateCartLineItem,
+  RemoveCartLineItem,
+  ApplyCouponToCart,
+  RemoveCouponFromCart,
+} from "./cart";
+import type { GetCategories, GetCategory } from "./category";
+import type {
+  GetAvailableShippingMethods,
+  SetCartAddress,
+  SetCustomerEmail,
+  SetShippingMethod,
+} from "./checkout";
+import type {
+  CreateCustomerAddress,
+  DeleteCustomerAddress,
+  UpdateCustomerAddress,
+  GetCustomerAddresses,
+} from "./customer";
+import type { GetOrders, GetOrderDetails, PlaceOrder } from "./order";
+import type { GetProducts, GetProductDetails, GetProductReviews, SearchProducts } from "./product";
+import type { GetCurrencies } from "./settings";
+
+export * from "./auth";
+export * from "./cart";
+export * from "./category";
+export * from "./checkout";
+export * from "./customer";
+export * from "./helpers";
+export * from "./product";
+export * from "./settings";
+export * from "./order";
+
+export type UnifiedMethods = {
+  getCart: GetCart;
+  addCartLineItem: AddCartLineItem;
+  updateCartLineItem: UpdateCartLineItem;
+  removeCartLineItem: RemoveCartLineItem;
+  applyCouponToCart: ApplyCouponToCart;
+  removeCouponFromCart: RemoveCouponFromCart;
+  getCategories: GetCategories;
+  getCategory: GetCategory;
+  getCustomer: GetCustomer;
+  loginCustomer: LoginCustomer;
+  logoutCustomer: LogoutCustomer;
+  registerCustomer: RegisterCustomer;
+  updateCustomer: UpdateCustomer;
+  changeCustomerPassword: ChangeCustomerPassword;
+  getProducts: GetProducts;
+  getProductDetails: GetProductDetails;
+  getProductReviews: GetProductReviews;
+  searchProducts: SearchProducts;
+  getAvailableShippingMethods: GetAvailableShippingMethods;
+  setCartAddress: SetCartAddress;
+  setCustomerEmail: SetCustomerEmail;
+  setShippingMethod: SetShippingMethod;
+  createCustomerAddress: CreateCustomerAddress;
+  deleteCustomerAddress: DeleteCustomerAddress;
+  updateCustomerAddress: UpdateCustomerAddress;
+  getCustomerAddresses: GetCustomerAddresses;
+  getCurrencies: GetCurrencies;
+  getOrders: GetOrders;
+  getOrderDetails: GetOrderDetails;
+  placeOrder: PlaceOrder;
+};

package/app/composables/methods/order.ts

@@ -0,0 +1,39 @@
+import type { Simplify } from "type-fest";
+import type { SfPagination } from "../models";
+import type { SfOrder, SfOrderListItem } from "../models/order";
+
+export interface GetOrdersExtendedArgs {}
+export interface GetOrdersCustomArgs {}
+
+export type GetOrdersArgs = {
+  pageSize?: number;
+  currentPage?: number;
+  //$extended?: GetOrdersExtendedArgs;
+  //$custom?: GetOrdersCustomArgs;
+};
+
+export type GetOrders = (args?: Simplify<GetOrdersArgs>) => Promise<{
+  orders: SfOrderListItem[];
+  pagination: SfPagination;
+}>;
+
+export interface GetOrderExtendedArgs {}
+export interface GetOrderCustomArgs {}
+
+export type GetOrderArgs = {
+  id: string;
+  //$extended?: GetOrderExtendedArgs;
+  //$custom?: GetOrderCustomArgs;
+};
+
+export type GetOrderDetails = (args: Simplify<GetOrderArgs>) => Promise<SfOrder>;
+
+export interface PlaceOrderExtendedArgs {}
+export interface PlaceOrderCustomArgs {}
+
+export type PlaceOrderArgs = {
+  //$extended?: PlaceOrderExtendedArgs;
+  //$custom?: PlaceOrderCustomArgs;
+};
+
+export type PlaceOrder = (args?: Simplify<PlaceOrderArgs>) => Promise<SfOrder>;

package/app/composables/methods/product.ts

@@ -0,0 +1,95 @@
+import type { Simplify } from "type-fest";
+import type {
+  SfCategory,
+  SfFacet,
+  SfId,
+  SfPagination,
+  SfProduct,
+  SfProductCatalogItem,
+  SfProductReview,
+} from "../models";
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface SfSortBy {}
+
+export interface SearchProductsExtendedArgs {}
+export interface SearchProductsCustomArgs {}
+
+export type SearchProductsArgs = {
+  pageSize?: number;
+  currentPage?: number;
+  sortBy?: "relevant" | "price-low-to-high" | "price-high-to-low" | (string & {});
+  search?: string;
+  category?: SfCategory["id"];
+  facets?: {
+    [name: string]: string[];
+  };
+  //$extended?: SearchProductsExtendedArgs;
+  //$custom?: SearchProductsCustomArgs;
+} & SfSortBy;
+
+export type SearchProducts = (args: Simplify<SearchProductsArgs>) => Promise<{
+  products: SfProductCatalogItem[];
+  pagination: SfPagination;
+  facets: SfFacet[];
+}>;
+
+export interface GetProductsExtendedArgs {}
+export interface GetProductsCustomArgs {}
+
+export type GetProductsArgs = {
+  ids?: string[];
+  skus?: string[];
+  //$extended?: GetProductsExtendedArgs;
+  //$custom?: GetProductsCustomArgs;
+};
+
+export type GetProducts = (args: Simplify<GetProductsArgs>) => Promise<{
+  products: SfProductCatalogItem[];
+}>;
+
+export interface GetProductDetailsExtendedArgs {}
+export interface GetProductDetailsCustomArgs {}
+
+export type GetProductDetailsArgs = {
+  id: SfId;
+  sku?: string;
+  //$extended?: GetProductDetailsExtendedArgs;
+  //$custom?: GetProductDetailsCustomArgs;
+};
+
+export type GetProductDetails = (args: Simplify<GetProductDetailsArgs>) => Promise<{
+  product: SfProduct;
+  categoryHierarchy: SfCategory[];
+}>;
+
+export interface GetProductReviewsExtendedArgs {}
+export interface GetProductReviewsCustomArgs {}
+
+export type GetProductReviewsArgs = {
+  productId: SfId;
+  pageSize?: number;
+  currentPage?: number;
+  //$extended?: GetProductReviewsExtendedArgs;
+  //$custom?: GetProductReviewsCustomArgs;
+};
+
+export type GetProductReviews = (args: Simplify<GetProductReviewsArgs>) => Promise<{
+  reviews: SfProductReview[];
+  pagination: SfPagination;
+}>;
+
+export interface AddProductReviewExtendedArgs {}
+export interface AddProductReviewCustomArgs {}
+
+export type AddProductReviewArgs = {
+  productId: SfId;
+  productSku?: string;
+  review: Pick<SfProductReview, "title" | "text" | "rating" | "reviewer">;
+  //$extended?: AddProductReviewExtendedArgs;
+  //$custom?: AddProductReviewCustomArgs;
+};
+
+export type AddProductReview = (args: Simplify<AddProductReviewArgs>) => Promise<{
+  review: SfProductReview;
+}>;

package/app/composables/methods/settings.ts

@@ -0,0 +1,16 @@
+import type { Simplify } from "type-fest";
+import type { SfCurrency } from "../models";
+
+export interface GetCurrenciesExtendedArgs {}
+export interface GetCurrenciesCustomArgs {}
+
+export type GetCurrenciesArgs = {
+  //$extended?: GetCurrenciesExtendedArgs;
+  //$custom?: GetCurrenciesCustomArgs;
+};
+
+export type GetCurrencies = (args?: Simplify<GetCurrenciesArgs>) => Promise<{
+  currencies: SfCurrency[];
+  defaultCurrency: SfCurrency;
+  currentCurrency: SfCurrency;
+}>;

package/app/composables/models/cart.ts

@@ -0,0 +1,95 @@
+import type { InferCustom } from "../defs";
+import type { SfShippingMethod } from "./checkout";
+import type {
+  Maybe,
+  SfAddress,
+  SfAttribute,
+  SfDiscountablePrice,
+  SfId,
+  SfImage,
+  SfMoney,
+} from "./shared";
+
+export interface SfCartLineItemCustom extends InferCustom<"normalizeCartLineItem"> {}
+
+export interface SfCartLineItem {
+  attributes: SfAttribute[];
+  productId: SfId;
+  /**
+   * ID of the cart's line item
+   */
+  id: SfId;
+  image: Maybe<SfImage>;
+  name: Maybe<string>;
+  quantity: number;
+  sku: Maybe<string>;
+  slug: string;
+  /**
+   * Product of quantity and unitPrice
+   */
+  totalPrice: Maybe<SfMoney>;
+  unitPrice: Maybe<SfDiscountablePrice>;
+  quantityLimit: Maybe<number>;
+  $custom?: SfCartLineItemCustom;
+}
+
+export interface SfCartCouponCustom extends InferCustom<"normalizeCartCoupon"> {}
+
+export interface SfCartCoupon {
+  code: string;
+  id: string;
+  name: Maybe<string>;
+  $custom?: SfCartCouponCustom;
+}
+
+export interface SfCartCustom extends InferCustom<"normalizeCart"> {}
+
+export interface SfCart {
+  appliedCoupons: SfCartCoupon[];
+  /**
+   * @default null
+   */
+  billingAddress: Maybe<SfAddress>;
+  /**
+   * Active customer's email. Required to complete the checkout
+   * @default null
+   */
+  customerEmail: Maybe<string>;
+  id: SfId;
+  /**
+   * Shipping address is required to get available shipping methods
+   * @default null
+   */
+  lineItems: SfCartLineItem[];
+  shippingAddress: Maybe<SfAddress>;
+  /**
+   * Required to complete the checkout. To get available methods use `getAvailableShippingMethods`
+   * @default null
+   */
+  shippingMethod: Maybe<SfShippingMethod>;
+  /**
+   * Difference of `subtotalRegularPrice` and discounts applied to line items before providing coupons.
+   * If none of the products are discounted, price will be equal to `subtotalRegularPrice`
+   */
+  subtotalDiscountedPrice: SfMoney;
+  /**
+   * Total regular price of all line items (coupons, taxes, shipping excluded)
+   */
+  subtotalRegularPrice: SfMoney;
+  totalCouponDiscounts: SfMoney;
+  /**
+   * Total count of all line items and their's quantities in cart
+   */
+  totalItems: number;
+  /**
+   * Total cart price (discounts, taxes, shipping included)
+   */
+  totalPrice: SfMoney;
+  /**
+   * Calculated after applying shipping method
+   * @default null
+   */
+  totalShippingPrice: Maybe<SfMoney>;
+  totalTax: SfMoney;
+  $custom?: SfCartCustom;
+}

package/app/composables/models/category.ts

@@ -0,0 +1,13 @@
+import type { InferCustom } from "../defs";
+import type { Maybe, SfId } from "./shared";
+
+export interface SfCategoryCustom extends InferCustom<"normalizeCartCoupon"> {}
+
+export interface SfCategory {
+  id: SfId;
+  name: string;
+  slug: string;
+  subcategories: Maybe<SfCategory[]>;
+  parentCategoryId: Maybe<SfId>;
+  $custom?: SfCategoryCustom;
+}

package/app/composables/models/checkout.ts

@@ -0,0 +1,17 @@
+import type { InferCustom } from "../defs";
+import type { Maybe, SfMoney } from "./shared";
+
+export interface SfShippingMethodCustom extends InferCustom<"normalizeCartCoupon"> {}
+
+export interface SfShippingMethod {
+  description: Maybe<string>;
+  estimatedDelivery: Maybe<string>;
+  id: string;
+  name: string;
+  price: SfMoney;
+  $custom?: SfShippingMethodCustom;
+}
+
+export interface SfShippingMethods {
+  methods: SfShippingMethod[];
+}

package/app/composables/models/customer.ts

@@ -0,0 +1,16 @@
+import type { InferCustom } from "../defs";
+import type { SfAddress, SfId } from "./shared";
+
+export interface SfCustomerCustom extends InferCustom<"normalizeCustomer"> {}
+
+export interface SfCustomer {
+  id: SfId;
+  email: string;
+  firstName: string;
+  lastName: string;
+  $custom?: SfCustomerCustom;
+}
+
+export interface SfCustomerAddress extends SfAddress {
+  id: SfId;
+}

package/app/composables/models/facets.ts

@@ -0,0 +1,25 @@
+import type { InferCustom } from "../defs";
+import type { Maybe } from "./shared";
+
+export enum SfFacetTypes {
+  MULTI_SELECT = "MULTI_SELECT",
+  SINGLE_SELECT = "SINGLE_SELECT",
+}
+
+export type SfFacetType = `${SfFacetTypes}`;
+
+export interface SfFacetItem {
+  label: string;
+  value: string;
+  productCount: Maybe<number>;
+}
+
+export interface SfFacetCustom extends InferCustom<"normalizeFacet"> {}
+
+export interface SfFacet {
+  label: string;
+  name: string;
+  values: SfFacetItem[];
+  type: Maybe<SfFacetType | (string & Record<never, never>)>;
+  $custom?: SfFacetCustom;
+}