orionplace-nuxt 0.1.2 → 0.2.0

package/templates/app/interfaces/orionplace/products/IProduct.ts

@@ -0,0 +1,262 @@
+import type { ITransformValue } from '@/interfaces/orionplace/shared/ITransformValue';
+
+export interface IProduct {
+  id: number;
+  product_group_id: number;
+  whishlist_id?: number | null;
+  main_category?: number | null;
+  subscription_id?: number | null;
+  is_digital?: boolean;
+  locale: Record<string, Partial<IProductLocale>>;
+  discount: number;
+  cart_counts?: IProductCartCounts | null;
+  base_price_dict: Record<string, ITransformValue>;
+  product_price_dict: Record<string, ITransformValue>;
+  images?: IProductImages | null;
+  weight_dict?: Record<string, ITransformValue>;
+  length_dict?: IProductDimensions;
+  variants: IProductVariants;
+  flags: IProductFlags;
+  seller: IProductSeller;
+  status: IProductStatus;
+  c_real_left: number;
+  date_updated?: string | null;
+  feedback_stat: IProductFeedbackStat;
+  related?: IProductRelated | null;
+  secondary_variants?: IProductSecondaryVariants | null;
+  feedback_allowed?: boolean;
+  attributes?: IProductAttribute[] | Record<string, IProductAttribute>;
+  videos?: IProductVideo[];
+  manufacture?: IProductManufacture | null;
+  refunds?: IProductRefunds | null;
+  feedbacks?: IProductFeedbacks | null;
+}
+
+export type IAppLoadProduct = Omit<IProduct, 'seller'> & {
+  seller_id: number;
+};
+
+export interface IProductAttribute {
+  id: number;
+  names: IProductAttributeName[];
+  locales: Record<string, string>;
+}
+
+export interface IProductAttributeName {
+  id: number;
+  locale: Record<string, Record<string, string>>;
+}
+
+export interface IProductVideo {
+  id: number;
+  product_video: string | null;
+  product: number;
+  preview: string | null;
+}
+
+export interface IProductManufacture {
+  id: number;
+  name: string;
+  image: string | null;
+  small_image: string | null;
+}
+
+export interface IProductRefunds {
+  customer_max_refund_days: number;
+  max_refund_days_with_defect: number;
+}
+
+export interface IProductFeedbacks {
+  feedbacks?: {
+    data: IProductFeedback[];
+    rpag?: IProductPagination;
+  };
+  stats?: Record<string, number>;
+  c_feedback_images?: number;
+  image_row?: { data: unknown[]; rpag?: IProductPagination };
+  our_feedback_id?: number | null;
+}
+
+export interface IProductFeedback {
+  id: number;
+  rating?: number;
+  text?: string;
+  date_created?: IProductFeedbackDate | null;
+  user?: IProductFeedbackUser;
+  images?: IProductFeedbackImage[];
+  [key: string]: unknown;
+}
+
+export interface IProductFeedbackDate {
+  date: string;
+  time: string;
+  days_ago: number | string;
+  word: [number, string] | string;
+  minutes_ago?: number | string;
+}
+
+export interface IProductFeedbackUser {
+  id: number;
+  first_name: string;
+  last_name: string;
+  logo: string | null;
+}
+
+export interface IProductFeedbackImage {
+  id: number;
+  image: string;
+}
+
+export interface IProductPagination {
+  has_next?: boolean;
+  has_previous?: boolean;
+  page?: number;
+  pages?: number;
+  total_count?: number;
+  selected_count?: number;
+}
+
+export interface IProductFeedbackStat {
+  c_feedbacks: number;
+  avg_raiting: number | string;
+}
+
+export interface IProductStatus {
+  status: EProductStatus;
+  status_display: string;
+}
+
+export const EProductStatus = {
+  PUBLISHED: 2,
+  PUBLISHED_AS_OPTION: 1,
+  UNPUBLISHED: 0,
+  TEMPORARY_STOPPED: -1,
+  LOW_SALE_STOCK: -2,
+  LOW_STOCK: -3,
+  INCOMPLETE: -4,
+  ON_MODERATION: -5,
+} as const;
+export type EProductStatus =
+  (typeof EProductStatus)[keyof typeof EProductStatus];
+
+export interface IProductSeller {
+  id: number;
+  name: string;
+  raiting: number | string;
+  avatar?: string | null;
+  is_accepting_preorders?: boolean;
+}
+
+export interface IProductSearchSeller {
+  id: number;
+  is_accepting_preorders?: boolean;
+}
+
+export interface IProductFlags {
+  flag_is_new?: boolean | null;
+  flag_is_soon_be_out?: boolean;
+  flag_is_popular?: boolean | null;
+  flag_is_good_deal?: boolean | null;
+}
+
+export interface IProductVariants {
+  main_variant?: IProductVariant;
+}
+
+export interface IProductVariant {
+  id: number;
+  value: IProductVariantValue[];
+  locale: Record<string, string>;
+  is_color: boolean;
+  second_exists: boolean;
+}
+
+export interface IProductVariantValue {
+  id: number;
+  color: string;
+  locale: Record<string, string>;
+  c_published: number;
+  reload_product?: number | null;
+}
+
+export interface IProductDimensions {
+  length: Record<string, ITransformValue>;
+  width: Record<string, ITransformValue>;
+  height: Record<string, ITransformValue>;
+}
+
+export interface IProductImages {
+  small: string[];
+  full: string[];
+}
+
+export interface IProductCartCounts {
+  modal_quantity?: number | null;
+  cart_id?: number | null;
+  cart_item_price_no_discount?: Record<string, ITransformValue>;
+  cart_item_price_after_promo?: Record<string, ITransformValue>;
+  quantity?: number | null;
+  c_can_not_ship?: number | null;
+  c_stock_left?: number | null;
+  cart_item_price_before_promo?: Record<string, ITransformValue>;
+  regular_discount_value?: Record<string, ITransformValue>;
+  promo_discount_value?: Record<string, ITransformValue>;
+  discount_total?: Record<string, ITransformValue>;
+}
+
+export interface IProductRelated {
+  data: IProduct[];
+}
+
+export interface IProductSecondaryVariants {
+  secondary: IProductSecondaryVariantInfo;
+  variants: IProductSecondaryVariant[];
+}
+
+export interface IProductSecondaryVariantInfo {
+  id: number;
+  is_color: boolean;
+  locale: Record<string, string>;
+  value: null;
+}
+
+export interface IProductSecondaryVariant {
+  product: IProduct;
+  value: IProductSecondaryVariantValue;
+}
+
+export interface IProductSecondaryVariantValue {
+  id: number;
+  locale: Record<string, string>;
+  color: string;
+}
+
+export interface IProductLocale {
+  id?: number;
+  product_name?: string;
+  product_title?: string;
+  product_slug?: string;
+  meta_description?: string;
+  meta_keywords?: string;
+  product_description?: string;
+  short_description?: string;
+}
+
+export type IProductsListNames =
+  | 'main'
+  | 'new'
+  | 'featured'
+  | 'seller'
+  | 'manufacturer'
+  | 'productAlerts'
+  | 'productAlertsRelated'
+  | 'cart'
+  | 'cartPreview'
+  | 'cartUndeliverable'
+  | 'orders'
+  | 'feedbacks';
+
+export interface IProcessingProduct {
+  id: number;
+  listName: IProductsListNames;
+}

package/templates/app/interfaces/orionplace/products/IProductFeedbackApi.ts

@@ -0,0 +1,218 @@
+import type { ApiFormError } from '@/interfaces/orionplace/transport';
+import type {
+  IApiDateTime,
+  IApiPagination,
+  IApiPaginationRequest,
+} from '@/interfaces/orionplace/accounts/IProfileData';
+import type {
+  IProduct,
+  IProductFeedback,
+  IProductFeedbackImage,
+  IProductFeedbackUser,
+} from '@/interfaces/orionplace/products/IProduct';
+
+export const EProductFeedbackStatus = {
+  DENIED: -1,
+  PENDING: 0,
+  APROOVED: 1,
+} as const;
+export type EProductFeedbackStatus =
+  (typeof EProductFeedbackStatus)[keyof typeof EProductFeedbackStatus];
+
+export interface IProductReview extends IProductFeedback {
+  text: string;
+  rating: number;
+  user: IProductFeedbackUser;
+  status: {
+    int: EProductFeedbackStatus;
+    text: string;
+  };
+  date_created: IApiDateTime;
+  total_c_likes: number;
+  total_c_dislikes: number;
+  // A root review: approved replies in its whole discussion; a reply: its approved direct replies.
+  total_c_approved_replies: number;
+  // Approved direct replies in this store group: the list reply_of_parent opens.
+  total_c_approved_direct_replies?: number;
+  total_c_replies: number;
+  images: IProductFeedbackImage[];
+  c_images: number;
+  user_like?: boolean | null;
+  my_reply_exist?: boolean;
+  replies?: IProductReview[];
+  reply_info: {
+    main_reply: number | null;
+    reply_to: number | null;
+  };
+  product?: IProduct | null;
+}
+
+export interface IProductFeedbackListRequest {
+  filters?: {
+    id?: number;
+    self_id?: number;
+    id_in?: number[] | string;
+    for_product?: number;
+    rating?: number[];
+    status?: EProductFeedbackStatus;
+    c_images_gte?: number;
+    product_seller?: number;
+    single_category?: number;
+    reply_of_parent?: number;
+    main_parent?: number;
+    ordering?:
+      | 'date_created'
+      | '-date_created'
+      | 'status'
+      | '-status'
+      | 'rating'
+      | '-rating'
+      | 'feedback_importance'
+      | '-feedback_importance'
+      | 'id'
+      | '-id';
+  };
+  paginate?: IApiPaginationRequest;
+}
+
+export interface IProductFeedbackListResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    feedbacks: {
+      data: IProductReview[];
+      rpag: IApiPagination;
+    };
+    stats?: Record<string, number>;
+    image_row?: {
+      images: {
+        data: IProductReviewImage[];
+        rpag: IApiPagination;
+      };
+    };
+  } | null;
+}
+
+export interface IMyProductFeedbacksResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    feedbacks: {
+      data: IProductReview[];
+      rpag: IApiPagination;
+    };
+    parents?: IProductReview[];
+  } | null;
+}
+
+export interface IProductFeedbackCreateRequest {
+  for_product: number;
+  text: string;
+  rating?: number;
+  reply_to?: number | null;
+}
+
+export interface IProductFeedbackEditRequest {
+  text: string;
+  rating?: number;
+  images_to_delete?: number[] | null;
+}
+
+export interface IProductFeedbackCreateResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    id: number;
+    state: {
+      int: EProductFeedbackStatus;
+      text: string;
+    };
+    feedback: IProductReview[];
+  } | null;
+}
+
+export interface IProductFeedbackEditResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    state: {
+      int: EProductFeedbackStatus;
+      text: string;
+    };
+    feedback: IProductReview[];
+  } | null;
+}
+
+export interface IProductFeedbackPreloadRequest {
+  reply_id: number;
+}
+
+export interface IProductFeedbackPreloadResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    id: number;
+    text: string;
+    rating: number;
+    status: {
+      int: EProductFeedbackStatus;
+      text: string;
+    };
+    got_reply: boolean;
+    // True for a reply: replies have no rating (0) and no stars to choose.
+    is_reply?: boolean;
+    images: IProductFeedbackImage[];
+  } | null;
+}
+
+export interface IProductFeedbackReactionRequest {
+  feedback: number;
+  like_or_dislike?: boolean;
+}
+
+export interface IProductFeedbackReactionResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    likes: number;
+    dislikes: number;
+  } | null;
+}
+
+export interface IProductFeedbackCountersResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    total_c_likes: number;
+    total_c_dislikes: number;
+    total_c_replies: number;
+    // Correctly spelled copy of total_c_aprooved_replies in newer backends.
+    total_c_approved_replies?: number;
+    total_c_approved_direct_replies?: number;
+    total_c_aprooved_replies: number;
+  } | null;
+}
+
+export interface IProductReviewImage extends IProductFeedbackImage {
+  feedback_id: number;
+  feedback_rating: number;
+}
+
+export interface IProductFeedbackImagesRequest {
+  filters?: {
+    product?: number;
+    feedback?: number;
+    product_seller?: number;
+    product_manufacture?: number;
+  };
+  paginate?: IApiPaginationRequest;
+}
+
+export interface IProductFeedbackImagesResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    data: IProductReviewImage[];
+    rpag: IApiPagination;
+  } | null;
+}

package/templates/app/interfaces/orionplace/products/IProductSearchApi.ts

@@ -0,0 +1,146 @@
+import type { ApiFormError } from '@/interfaces/orionplace/transport';
+import type {
+  IApiPagination,
+  IApiPaginationRequest,
+} from '@/interfaces/orionplace/accounts/IProfileData';
+import type {
+  IProduct,
+  IProductSecondaryVariantInfo,
+  IProductSecondaryVariantValue,
+} from '@/interfaces/orionplace/products/IProduct';
+import type {
+  ICurrencyAmounts,
+  IUnitValues,
+  ICategoryDirectoryEntry,
+  IPromoDefinition,
+} from '@/interfaces/orionplace/cart/ICartData';
+import type { IManufacturer } from '@/interfaces/orionplace/catalog/ICatalogDirectory';
+import type { ISellerDirectoryEntry } from '@/interfaces/orionplace/sellers/ISellerDirectory';
+
+export interface IProductSearchFilters {
+  search_string?: string;
+  id?: number;
+  id_in?: number[] | string;
+  categories?: number[];
+  product_group?: number[];
+  product_owner?: number[];
+  product_owner_name?: string;
+  product_manufacture?: number[];
+  physical_store?: number;
+  is_related_for?: number;
+  show_whishlist?: boolean;
+  subscription_exists?: boolean;
+  only_featured?: boolean;
+  only_new?: boolean;
+  with_discount?: boolean;
+  is_good_for_promo?: number;
+  price_currency?: number;
+  price_from?: number;
+  price_to?: number;
+  avg_raiting_from?: number;
+  avg_raiting_to?: number;
+  c_aprooved_feedbacks_from?: number;
+  c_aprooved_feedbacks_to?: number;
+  price_discount_from?: number;
+  price_discount_to?: number;
+  owner_rating_from?: number;
+  // weight_from and weight_to are read in this unit, as the length, width and
+  // height bounds are read in length_search_by.
+  weight_search_by?: number;
+  weight_from?: number;
+  weight_to?: number;
+  length_search_by?: number;
+  length_from?: number;
+  length_to?: number;
+  width_from?: number;
+  width_to?: number;
+  height_from?: number;
+  height_to?: number;
+  from_modal?: true | string;
+  ordering?:
+    | 'popularity'
+    | '-popularity'
+    | 'avg_raiting'
+    | '-avg_raiting'
+    | 'real_price_usd'
+    | '-real_price_usd'
+    | 'flag_is_new'
+    | '-flag_is_new'
+    | 'flag_is_good_deal'
+    | '-flag_is_good_deal';
+  [key: `variant_${number}`]: number[] | undefined;
+}
+
+export interface IProductSearchRequest {
+  filters?: IProductSearchFilters;
+  paginate?: IApiPaginationRequest;
+}
+
+export interface IProductVariantFilter {
+  id: number;
+  locale: Record<string, {
+    variant_type_name?: string;
+  }>;
+  options: (IProductSecondaryVariantValue & {
+    count: number;
+  })[];
+}
+
+export interface IProductSearchRanges {
+  min_price: ICurrencyAmounts;
+  max_price: ICurrencyAmounts;
+  min_weight: IUnitValues;
+  max_weight: IUnitValues;
+  min_length: IUnitValues;
+  max_length: IUnitValues;
+  min_width: IUnitValues;
+  max_width: IUnitValues;
+  min_height: IUnitValues;
+  max_height: IUnitValues;
+}
+
+export interface IProductSearchChoices {
+  manufacture: (IManufacturer & {
+    count?: number;
+  })[];
+  sellers: ISellerDirectoryEntry[];
+  categories: ICategoryDirectoryEntry[];
+  measures: IProductSearchRanges;
+  discounts: {
+    any: number;
+  };
+  raiting_above_45: number;
+}
+
+export interface IProductSearchResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    products?: {
+      data: IProduct[];
+      rpag: IApiPagination;
+    };
+    min_max?: IProductSearchRanges;
+    variants?: Record<string, IProductVariantFilter>;
+    selects?: IProductSearchChoices;
+    c_cat_products?: number;
+    promo?: IPromoDefinition | null;
+  } | null;
+}
+
+export interface IProductSecondaryVariantsRequest {
+  product_group: number;
+  main_variant_value: number;
+}
+
+export interface IProductSecondaryVariantsResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    secondary: IProductSecondaryVariantInfo | Record<string, never>;
+    variants: {
+      product: IProduct | null;
+      value: IProductSecondaryVariantValue | null;
+    }[];
+  } | null;
+}

package/templates/app/interfaces/orionplace/products/IProductSearchFacets.ts

@@ -0,0 +1,35 @@
+export interface IProductSearchFacets {
+  selects: {
+    categories?: {
+      id: number;
+      count: number;
+      locale: Record<string, { cg_name?: string }>;
+    }[];
+    sellers?: { id: number; seller_name: string; count: number }[];
+    measures?: {
+      min_price?: Record<string, { transform_value: number }>;
+      max_price?: Record<string, { transform_value: number }>;
+    };
+    discounts?: { any: number };
+    raiting_above_45?: number;
+    manufacture?: { id: number; name: string; count: number }[];
+  };
+  variants?: Record<
+    string,
+    {
+      id: number;
+      locale: Record<string, { variant_type_name?: string }>;
+      options: {
+        id: number;
+        locale: Record<string, string>;
+        color?: string;
+        count: number;
+      }[];
+    }
+  >;
+}
+
+export type ProductFacetSelection = Record<
+  string,
+  number[] | string | number | boolean | undefined
+>;

package/templates/app/interfaces/orionplace/products/IProductSecondaryVariantRequest.ts

@@ -0,0 +1,15 @@
+import type {
+  IProductSecondaryVariants,
+  IProductVariantValue,
+} from '@/interfaces/orionplace/products/IProduct';
+
+export interface IProductSecondaryVariantRequest {
+  product: number;
+  productGroup: number;
+  variant: IProductVariantValue;
+}
+
+export interface IProductSecondaryVariantState {
+  status: 'loading' | 'ready' | 'failed' | 'unavailable';
+  data?: IProductSecondaryVariants;
+}

package/templates/app/interfaces/orionplace/products/IProductSpecification.ts

@@ -0,0 +1,14 @@
+import type { IBreadcrumbTarget } from '@/interfaces/orionplace/shared/IBreadcrumb';
+
+export interface IProductSpecificationRow {
+  key: string;
+  label: string;
+  value: string;
+  to?: IBreadcrumbTarget;
+}
+
+export interface IProductSpecificationGroup {
+  key: string;
+  title: string;
+  rows: IProductSpecificationRow[];
+}

package/templates/app/interfaces/orionplace/products/IWishlist.ts

@@ -0,0 +1,22 @@
+import type { ApiFormError } from '@/interfaces/orionplace/transport';
+
+export interface IWishlistAddRequest {
+  product: number;
+}
+
+export interface IWishlistAddResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    wish_id?: number;
+    count: number;
+  } | null;
+}
+
+export interface IWishlistRemoveResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    count: number;
+  } | null;
+}