orionplace-react 0.1.0 → 0.2.0

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

@@ -1,235 +1,262 @@
-import type { ITransformValue } from '../shared/ITransformValue';
+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;
-	feedback_stat: IProductFeedbackStat;
-	related?: IProductRelated | null;
-	secondary_variants?: IProductSecondaryVariants;
-	feedback_allowed?: boolean;
-	attributes?: IProductAttribute[] | Record<string, IProductAttribute>;
-	videos?: IProductVideo[];
-	manufacture?: IProductManufacture | null;
-	refunds?: IProductRefunds | null;
-	feedbacks?: IProductFeedbacks | null;
-	promo?: IProductPromo | null;
-
+  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>;
+  id: number;
+  names: IProductAttributeName[];
+  locales: Record<string, string>;
 }
 
 export interface IProductAttributeName {
-	id: number;
-	locale: Record<string, Record<string, string>>;
+  id: number;
+  locale: Record<string, Record<string, string>>;
 }
 
 export interface IProductVideo {
-	id: number;
-	product_video: string;
-	product: number;
-	preview: string;
+  id: number;
+  product_video: string | null;
+  product: number;
+  preview: string | null;
 }
 
 export interface IProductManufacture {
-	id: number;
-	name: string;
-	image: string;
-	small_image: string;
+  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 IProductPromo {
-	id: number;
-	locale: Record<string, string | { promo_name?: string; name?: string }>;
-	promo_value: number | Record<string, ITransformValue>;
-	promo_type: 'FREE_SHIPPING' | 'FIXED' | 'PERCENTAGE';
+  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;
+  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;
-	created_at?: string;
-	date_created?: string;
-	user?: { id?: number; name?: string; avatar?: string };
-	customer?: { id?: number; name?: string; avatar?: string };
-	images?: Array<string | { image?: string; url?: string }>;
-	[key: string]: unknown;
+  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;
+  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;
+  c_feedbacks: number;
+  avg_raiting: number | string;
 }
 
 export interface IProductStatus {
-	status: EProductStatus;
-	status_display: string;
+  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,
+  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];
+  (typeof EProductStatus)[keyof typeof EProductStatus];
 
 export interface IProductSeller {
-	id: number;
-	name: string;
-	raiting: number | string;
-	avatar?: string;
+  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;
-	flag_is_soon_be_out?: boolean;
-	flag_is_popular?: boolean;
-	flag_is_good_deal?: boolean;
+  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;
+  main_variant?: IProductVariant;
 }
 
 export interface IProductVariant {
-	id: number;
-	value: IProductVariantValue[];
-	locale: Record<string, string>;
-	is_color: boolean;
-	second_exists: boolean;
+  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;
+  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>;
+  length: Record<string, ITransformValue>;
+  width: Record<string, ITransformValue>;
+  height: Record<string, ITransformValue>;
 }
 
 export interface IProductImages {
-	small: string[];
-	full: string[];
+  small: string[];
+  full: string[];
 }
 
 export interface IProductCartCounts {
-	modal_quantity?: number;
-	cart_id?: number;
-	cart_item_price_no_discount?: Record<string, ITransformValue>;
-	cart_item_price_after_promo?: Record<string, ITransformValue>;
+  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[];
+  data: IProduct[];
 }
 
 export interface IProductSecondaryVariants {
-	secondary: IProductSecondaryVariantInfo;
-	variants: IProductSecondaryVariant[];
+  secondary: IProductSecondaryVariantInfo;
+  variants: IProductSecondaryVariant[];
 }
 
 export interface IProductSecondaryVariantInfo {
-	id: number;
-	is_color: boolean;
-	locale: Record<string, string>;
-	value: null;
+  id: number;
+  is_color: boolean;
+  locale: Record<string, string>;
+  value: null;
 }
 
 export interface IProductSecondaryVariant {
-	product: IProduct;
-	value: IProductSecondaryVariantValue;
+  product: IProduct;
+  value: IProductSecondaryVariantValue;
 }
 
 export interface IProductSecondaryVariantValue {
-	id: number;
-	locale: Record<string, string>;
-	color: string;
+  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;
+  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';
+  | 'main'
+  | 'new'
+  | 'featured'
+  | 'seller'
+  | 'manufacturer'
+  | 'productAlerts'
+  | 'productAlertsRelated'
+  | 'cart'
+  | 'cartPreview'
+  | 'cartUndeliverable'
+  | 'orders'
+  | 'feedbacks';
 
 export interface IProcessingProduct {
-	id: number;
-	listName: IProductsListNames;
+  id: number;
+  listName: IProductsListNames;
 }

package/templates/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;
+}