orionplace-react 0.1.0 → 0.2.0

package/templates/interfaces/orionplace/cart/ICartData.ts

@@ -0,0 +1,382 @@
+import type { ApiFormError } from '@/interfaces/orionplace/transport';
+import type { ITransformValue } from '@/interfaces/orionplace/shared/ITransformValue';
+import type { IApiDateTime } from '@/interfaces/orionplace/accounts/IProfileData';
+import type { IProduct } from '@/interfaces/orionplace/products/IProduct';
+import type { ICategoryLocale } from '@/interfaces/orionplace/category/ICategory';
+import type {
+  IAddressCountry,
+  IUserAddress,
+} from '@/interfaces/orionplace/address/IUserAddress';
+import type { IAddressRegion } from '@/interfaces/orionplace/address/IAddressRegionSearch';
+import type { IPhysicalStore } from '@/interfaces/orionplace/stores/IStoreDirectory';
+import type { ISellerDirectoryEntry } from '@/interfaces/orionplace/sellers/ISellerDirectory';
+import type { ECartState } from '@/interfaces/orionplace/cart/ICartActions';
+
+export type ICurrencyAmounts = Record<string, ITransformValue>;
+export type IUnitValues = Record<string, ITransformValue>;
+
+export const EPromoType            = {
+  FIXED: 'FIXED',
+  PERCENTAGE: 'PERCENTAGE',
+  FREE_SHIPPING: 'FREE_SHIPPING',
+} as const;
+export type EPromoType = (typeof EPromoType)[keyof typeof EPromoType];
+
+export const EPromoProductDiscount = {
+  UNKNOWN: '',
+  NOT_ALLOW_WITH_PRODUCT_DISCOUNT: 0,
+  ALLOW_WITH_PRODUCT_DISCOUNT: 1,
+} as const;
+export type EPromoProductDiscount =
+  (typeof EPromoProductDiscount)[keyof typeof EPromoProductDiscount];
+
+export interface IPaymentMethod {
+  id: number;
+  locale: Record<
+    string,
+    {
+      payment_name?: string;
+      payment_description?: string;
+    }
+  >;
+  logo: string | null;
+  is_payment_on_delivery: boolean;
+  is_from_balance_payment: boolean;
+}
+
+export interface ICategoryDirectoryEntry {
+  id: number;
+  value: number;
+  ordering: number;
+  locale: Record<string, ICategoryLocale>;
+  logo_image: string | null;
+  logo_image_id: number | null;
+  menu_image: string | null;
+  menu_image_id: number | null;
+  category_image_bg: string;
+  use_localized_banner: boolean;
+  c_groups: number;
+  count?: number;
+}
+
+export interface IPromoDefinition {
+  id: number;
+  locale: Record<string, {
+    name?: string;
+  }>;
+  promo_value: number | ICurrencyAmounts;
+  promo_type: EPromoType;
+  products?: IProduct[];
+  categories?: ICategoryDirectoryEntry[];
+  sellers?: ISellerDirectoryEntry[];
+  /**
+   * Minimum order amount: the products the code covers must cost at least
+   * this much together in one order (the whole cart when the promotion names
+   * no products, categories or sellers). Present only when the promotion has
+   * a minimum.
+   */
+  minimum_order_amount?: ICurrencyAmounts;
+  /**
+   * @deprecated Alias of `minimum_order_amount` with the same value; read it
+   * only when `minimum_order_amount` is absent (older backends).
+   */
+  min_price?: ICurrencyAmounts;
+  /**
+   * Largest discount a percentage code gives on one order. Present only when
+   * the promotion has a maximum discount.
+   */
+  maximum_discount?: ICurrencyAmounts;
+  /** The code works only on the customer's first purchase in the store. */
+  first_order_only?: boolean;
+  behaviour_with_product_discount: {
+    int: EPromoProductDiscount;
+    text: string;
+  };
+  date_start: IApiDateTime | null;
+  date_finish: IApiDateTime | null;
+  promo_type_is_active: boolean;
+}
+
+/**
+ * Why `promo_notice` was set. The first group (through `nothing_to_ship`)
+ * is about the cart's items: the code stays attached without a discount
+ * (`is_removed: false`), or it was refused when applied (`is_removed:
+ * true`). The second group removes the code.
+ */
+export const ECartPromoNoticeReason = {
+  NO_LINES: 'no_lines',
+  NOT_MATCHED: 'not_matched',
+  PRODUCT_DISCOUNTED: 'product_discounted',
+  BELOW_MINIMUM: 'below_minimum',
+  SUBSCRIPTIONS_ONLY: 'subscriptions_only',
+  TOO_SMALL: 'too_small',
+  NOTHING_TO_SHIP: 'nothing_to_ship',
+  EXPIRED: 'expired',
+  NOT_ACTIVE: 'not_active',
+  NOT_STARTED: 'not_started',
+  USAGE_LIMIT: 'usage_limit',
+  PROMOTION_LIMIT: 'promotion_limit',
+  NOT_YOURS: 'not_yours',
+  PERSONAL_LIMIT: 'personal_limit',
+  FIRST_ORDER_ONLY: 'first_order_only',
+  WRONG_DOMAIN: 'wrong_domain',
+} as const;
+export type ECartPromoNoticeReason =
+  (typeof ECartPromoNoticeReason)[keyof typeof ECartPromoNoticeReason];
+
+/**
+ * A promo code that gives the cart no discount now (`is_removed: false`),
+ * or a code the cart removed or refused (`is_removed: true`).
+ */
+export interface ICartPromoNotice {
+  reason: ECartPromoNoticeReason | string;
+  /** The reason in the request language. */
+  message: string;
+  promocode: string | null;
+  is_removed: boolean;
+  /**
+   * Minimum order amount per currency; set only for `below_minimum`. The
+   * dollar amount decides (catalog dollar prices); the other currencies
+   * are its conversion.
+   */
+  minimum_order_amount: ICurrencyAmounts | null;
+  /**
+   * The currency ids the notice is about; `null` means every currency.
+   * Show the notice only when the selected currency id is in the list, for
+   * example a fixed code that takes $10 off in dollars and 0 ₽ in rubles
+   * (`too_small`). Absent on older backends.
+   */
+  currency_ids?: Array<number | string> | null;
+  /**
+   * For `below_minimum`: how much more the products the code covers must
+   * cost, per currency (dollars decide). `null` otherwise; absent on older
+   * backends.
+   */
+  missing_amount?: ICurrencyAmounts | null;
+}
+
+export interface ICartPrices {
+  total_price_no_discount: ICurrencyAmounts;
+  discount_value: ICurrencyAmounts;
+  total_price_before_promo: ICurrencyAmounts;
+  promo_value: ICurrencyAmounts;
+  total_price_after_promo: ICurrencyAmounts;
+  total_delivery_price_before_promo: ICurrencyAmounts;
+  total_delivery_price_after_promo: ICurrencyAmounts;
+  delivery_discount: ICurrencyAmounts;
+  discount_total: ICurrencyAmounts;
+  summary_price: ICurrencyAmounts;
+  delivery_price_is_estimate: boolean;
+}
+
+export interface ICartLinePrices {
+  products_price_no_discount: ICurrencyAmounts;
+  products_regular_discount_value: ICurrencyAmounts;
+  products_price_before_promo: ICurrencyAmounts;
+  products_promo_discount_value: ICurrencyAmounts;
+  products_price_after_promo: ICurrencyAmounts;
+  products_discount_total: ICurrencyAmounts;
+  options_price_no_discount: ICurrencyAmounts;
+  option_discount_value: ICurrencyAmounts;
+  options_price_before_promo: ICurrencyAmounts;
+  option_promo_discount_value: ICurrencyAmounts;
+  options_price_after_promo: ICurrencyAmounts;
+  options_discount_total: ICurrencyAmounts;
+  total_price_no_discount: ICurrencyAmounts;
+  total_price_before_promo: ICurrencyAmounts;
+  total_price_after_promo: ICurrencyAmounts;
+}
+
+export interface ICartDeliveryPrices extends ICartLinePrices {
+  delivery_price_no_promo: ICurrencyAmounts;
+  delivery_price_after_promo: ICurrencyAmounts;
+}
+
+export interface ICartAddressLocation {
+  latitude: number;
+  longitude: number;
+}
+
+export interface ICartAddress {
+  address_label: string;
+  line1: string;
+  line2: string;
+  city: string;
+  house_number: string;
+  entrance: string;
+  intercom: string;
+  floor: string;
+  apt_number: string;
+  postcode: string;
+  state: IAddressRegion | null;
+  country: IAddressCountry | null;
+  location: ICartAddressLocation | null;
+}
+
+export interface ICartContact {
+  phone: string;
+  full_name: string;
+}
+
+export interface ICartSummary {
+  id: number;
+  state: ECartState;
+  prices: ICartPrices;
+  c_cart_positions: number;
+  c_cart_items: number;
+  c_digital_pos: number;
+  c_physical_pos: number;
+  c_dlf: number;
+  address_list: IUserAddress[] | null;
+  payment_methods: Record<string, IPaymentMethod>;
+  selected_payment: number | null;
+  cart_address: ICartAddress | null;
+  attached_promo: IPromoDefinition | null;
+  promocode: string | null;
+  /** Absent on backends without the whole-cart promo rules. */
+  promo_notice?: ICartPromoNotice | null;
+  comment: string;
+  contact: {
+    client?: ICartContact;
+    receiver?: ICartContact;
+  };
+  cart_stock_was_modifed: boolean;
+}
+
+export interface ICarrierBox {
+  id: number;
+  box_name: string;
+  length: IUnitValues;
+  width: IUnitValues;
+  height: IUnitValues;
+  measures: {
+    volume: IUnitValues;
+    weight: IUnitValues;
+  };
+}
+
+export interface IDeliveryType {
+  id: number;
+  locales: Record<
+    string,
+    {
+      tariff_name?: string;
+      tariff_desc_external?: string;
+    }
+  >;
+  delivery_to_carrier_point: boolean;
+  carrier: {
+    id: number;
+    locale: Record<string, {
+      carrier_name?: string;
+    }>;
+    carrier_logo: string | null;
+  } | null;
+  max_weight_kg: number;
+  box: ICarrierBox | null;
+}
+
+export interface ICartStore extends Omit<IPhysicalStore, 'virtual_goods'> {
+  virtual_goods: boolean;
+  c_delivery_types: number;
+  deliveries: Record<string, IDeliveryType>;
+}
+
+export interface ICartDeliveryData {
+  method: number | null;
+  delivery_error: string;
+  delivery_date_from: IApiDateTime | null;
+  delivery_date_to: IApiDateTime | null;
+  delivery_is_changed: boolean;
+  delivery_address: string;
+  delivery_to_code?: string;
+  delivery_to_city_code?: string;
+}
+
+export interface ICartOptionType {
+  id: number;
+  option_type: string;
+  multiple_choices: boolean;
+  locale: Record<string, {
+    option_type_human_alias?: string;
+  }>;
+}
+
+export interface ICartOptionPrices {
+  options_price_no_discount: ICurrencyAmounts;
+  option_regular_discount_value: ICurrencyAmounts;
+  options_price_before_promo: ICurrencyAmounts;
+  option_promo_discount_value: ICurrencyAmounts;
+  options_price_after_promo: ICurrencyAmounts;
+  options_discount_total: ICurrencyAmounts;
+}
+
+export interface ICartOption {
+  id: number;
+  quantity: number;
+  quantity_left: number;
+  option_price: ICartOptionPrices;
+  product: IProduct | null;
+}
+
+export interface ICartOptionGroup {
+  id: number;
+  option_text_data: string;
+  option_file_data: string;
+  option_name: Record<
+    string,
+    {
+      id?: number;
+      option_group_display_name?: string;
+    }
+  >;
+  option_type: ICartOptionType | null;
+  option_group_required: boolean;
+  image_url: string | null;
+  option_image: string | null;
+  limits: {
+    c_max_products_quantity_for_group: number;
+    c_max_product_quantity_in_group: number;
+    /** Upload limit in MB (domain setting `cart_option_file_max_mb`); 0 means no limit. */
+    file_max_mb?: number;
+  };
+  delivery_from_list?: number;
+  cart_item?: number;
+  options?: ICartOption[];
+}
+
+export interface ICartCheckoutProduct extends IProduct {
+  dlf_id: number;
+  dlf_count: number;
+  dlf_count_left: number;
+  dlf_prices: ICartLinePrices;
+  option_group: ICartOptionGroup[] | null;
+}
+
+export interface ICartDelivery {
+  delivery_from_id: number;
+  delivery_price_is_estimate: boolean;
+  from_store: ICartStore | null;
+  prices: ICartDeliveryPrices;
+  measures: {
+    package_weight: IUnitValues;
+    package_volume_cm: IUnitValues;
+  };
+  delivery_data: ICartDeliveryData;
+  total_quantity: number;
+  product_items: Array<ICartCheckoutProduct | null>;
+}
+
+export interface ICartGetRequest {
+  id?: number;
+}
+
+export interface ICartGetResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    cart: ICartSummary;
+    cart_data: IProduct[] | ICartDelivery[];
+    will_not_ship: IProduct[];
+  } | null;
+}

package/templates/interfaces/orionplace/cart/ICartDeliveryActions.ts

@@ -0,0 +1,68 @@
+import type { ApiFormError } from '@/interfaces/orionplace/transport';
+
+export interface ICartDeliverySelectionRequest {
+  delivery_from: number;
+  delivery_type: number;
+}
+
+export interface ICartDeliveryPointsRequest extends ICartDeliverySelectionRequest {
+  page?: number;
+  size?: number;
+}
+
+export interface ICartDeliveryPoint {
+  code: string;
+  city_code: string | null;
+  address: string | null;
+  longitude: number | string | null;
+  latitude: number | string | null;
+  postal_code: string | null;
+  comment: string | null;
+  work_time: string | null;
+}
+
+export interface ICartDeliveryPointsResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    items: ICartDeliveryPoint[];
+  } | null;
+}
+
+export interface ICartPickupSelectionRequest extends ICartDeliverySelectionRequest {
+  point?: Partial<ICartDeliveryPoint>;
+  code?: string;
+  city_code?: string;
+  address?: string;
+  delivery_to_code?: string;
+  delivery_to_city_code?: string;
+  delivery_to_code_full_address?: string;
+}
+
+export interface ICartDeliverySelectionResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    delivery_price_is_estimate: boolean;
+  } | null;
+}
+
+export interface ICartOptionQuantityRequest {
+  quantity: number;
+}
+
+export interface ICartOptionUploadRequest {
+  data: {
+    option_text_data?: string;
+  };
+  option_file_data?: File;
+}
+
+export interface ICartOptionDataResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    text: string;
+    file: string;
+  } | null;
+}

package/templates/interfaces/orionplace/cart/ICartModal.ts

@@ -0,0 +1,22 @@
+import type { ApiFormError } from '@/interfaces/orionplace/transport';
+import type { IProduct } from '@/interfaces/orionplace/products/IProduct';
+
+export interface ICartModalResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    cart: {
+      c_cart_positions: number;
+    };
+    cart_data: IProduct[];
+  } | null;
+}
+
+export interface ICartPreviewState {
+  open: boolean;
+  pending: boolean;
+  products: IProduct[];
+  error: string;
+  removing: number[];
+  removeError: string;
+}

package/templates/interfaces/orionplace/cart/IDeliveryMap.ts

@@ -0,0 +1,29 @@
+export interface IDeliveryMapPosition {
+  latitude: number;
+  longitude: number;
+}
+
+export interface IDeliveryMapMarker extends IDeliveryMapPosition {
+  id: string;
+  title: string;
+}
+
+export interface IDeliveryMapOptions {
+  container: HTMLElement;
+  apiKey: string;
+  language: string;
+  center: IDeliveryMapPosition;
+  markers: IDeliveryMapMarker[];
+  activeId?: string;
+  onSelect: (id: string) => void;
+}
+
+export interface IDeliveryMapView {
+  setMarkers: (markers: IDeliveryMapMarker[]) => void;
+  setActive: (id?: string) => void;
+  destroy: () => void;
+}
+
+export type DeliveryMapFactory = (
+  options: IDeliveryMapOptions,
+) => Promise<IDeliveryMapView>;

package/templates/interfaces/orionplace/catalog/ICatalogDirectory.ts

@@ -0,0 +1,75 @@
+import type { ApiFormError } from '@/interfaces/orionplace/transport';
+import type { ICategory } from '@/interfaces/orionplace/category/ICategory';
+import type {
+  IApiPagination,
+  IApiPaginationRequest,
+} from '@/interfaces/orionplace/accounts/IProfileData';
+
+export interface ICatalogLoadResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    tree: ICategory[];
+    childfree: number[];
+    unique_ids: number[];
+  } | null;
+}
+
+export interface IManufacturer {
+  id: number;
+  name: string;
+  image: string | null;
+  small_image: string | null;
+  locale: Record<string, {
+    brand_pitch?: string;
+  }>;
+  cats?: number[];
+}
+
+export interface IManufacturerIndexRequest {
+  filters?: {
+    id?: number;
+  };
+}
+
+export interface IManufacturerIndexGroup {
+  letter: string;
+  c_manufactures: number;
+  manufactures: IManufacturer[];
+}
+
+export interface IManufacturerIndexResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: IManufacturerIndexGroup[] | null;
+}
+
+export type TManufacturerAlphabet = 'en' | 'ru' | 'num';
+
+export interface IManufacturerIndexState {
+  pending: boolean;
+  loaded: boolean;
+  groups: IManufacturerIndexGroup[];
+  error: string;
+}
+
+export interface IManufacturerSearchRequest {
+  filters?: {
+    id?: number;
+    name?: string;
+    name_starts?: string;
+    ordering?: 'id' | '-id';
+  };
+  paginate?: IApiPaginationRequest;
+}
+
+export interface IManufacturerSearchResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    manufactures: {
+      data: IManufacturer[];
+      rpag: IApiPagination | null;
+    };
+  } | null;
+}

package/templates/interfaces/orionplace/category/ICategory.ts

@@ -1,4 +1,4 @@
-import type { ISeoOg, ISeoTwitter } from '../appBase/ISEO';
+import type { ISeoOg, ISeoTwitter } from '@/interfaces/orionplace/appBase/ISEO';
 
 export interface ICategory {
 	id: number;
@@ -11,6 +11,7 @@ export interface ICategory {
 	logo_image_id?: number | null;
 	menu_image?: string | null;
 	menu_image_id?: number | null;
+	exclude_from_tree?: boolean; // Omit this branch from navigation; retain it for product category lookup.
 	separate_menu: boolean;
 	is_public: boolean;
 	c_images: number;

package/templates/interfaces/orionplace/domains/IDomain.ts

@@ -1,4 +1,4 @@
-import type { ITransformValue } from '../shared/ITransformValue';
+import type { ITransformValue } from '@/interfaces/orionplace/shared/ITransformValue';
 
 export interface IDomain {
 	id: number;
@@ -7,7 +7,7 @@ export interface IDomain {
 
 export interface IDomainExtras {
 	period_id: number;
-	option_cost_id: number;
+	option_cost_id: number | null;
 	amount: Record<string, ITransformValue>;
 	days: number;
 }

package/templates/interfaces/orionplace/forms/ICustomerSubfilter.ts

@@ -0,0 +1,19 @@
+import type { ApiFormError } from '@/interfaces/orionplace/transport';
+
+export interface ICustomerSubfilterRequest {
+  form: string;
+  field_name: string;
+  filters: Record<string, unknown>;
+}
+
+export interface ICustomerSubfilterOption {
+  key: string | number | Record<string, string | Record<string, string>>;
+  value: number | string;
+  [field: string]: unknown;
+}
+
+export interface ICustomerSubfilterResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: ICustomerSubfilterOption[] | null;
+}