orionplace-react 0.1.0 → 0.2.1

package/templates/interfaces/orionplace/tickets/ICustomerTicketApi.ts

@@ -0,0 +1,223 @@
+import type { ApiFormError } from '@/interfaces/orionplace/transport';
+import type {
+  IApiPagination,
+  IApiPaginationRequest,
+  IApiDateTime,
+} from '@/interfaces/orionplace/accounts/IProfileData';
+import type { IProduct } from '@/interfaces/orionplace/products/IProduct';
+import type { IOrder } from '@/interfaces/orionplace/orders/IOrderHistory';
+
+export const ECustomerTicketType        = {
+  COMMON: 0,
+  ORDER: 1,
+  SELLER: 2,
+  SUBSCRIPTION: 3,
+} as const;
+export type ECustomerTicketType =
+  (typeof ECustomerTicketType)[keyof typeof ECustomerTicketType];
+
+export const ECustomerTicketStatus      = { CLOSED: 0, OPEN: 1 } as const;
+export type ECustomerTicketStatus =
+  (typeof ECustomerTicketStatus)[keyof typeof ECustomerTicketStatus];
+
+export const ECustomerTicketSolution    = {
+  SOLUTION_NO_DECISION: 0,
+  SOLUTION_APROOVED: 1,
+  SOLUTION_DENIED: -1,
+} as const;
+export type ECustomerTicketSolution =
+  (typeof ECustomerTicketSolution)[keyof typeof ECustomerTicketSolution];
+
+export const ETicketReplyDirection      = {
+  TO_MANAGMENT: 0,
+  TO_CUSTOMER: 1,
+} as const;
+export type ETicketReplyDirection =
+  (typeof ETicketReplyDirection)[keyof typeof ETicketReplyDirection];
+
+export const EOrderRefundShipmentStatus = {
+  CANCELED: 0,
+  CREATED: 1,
+  SENT: 2,
+  RECIEVED: 3,
+  DONE: 4,
+  PROBLEM: 5,
+} as const;
+export type EOrderRefundShipmentStatus =
+  (typeof EOrderRefundShipmentStatus)[keyof typeof EOrderRefundShipmentStatus];
+
+export interface ICustomerTicketsRequest {
+  filters?: {
+    id?: number;
+    ticket_type?: ECustomerTicketType;
+    ticket_status?: ECustomerTicketStatus;
+    problem_solution?: ECustomerTicketSolution;
+    related_paid_subscription?: number;
+    has_unread_to_user?: boolean;
+    has_unread_to_management?: boolean;
+  };
+  paginate?: IApiPaginationRequest;
+}
+
+export interface ICustomerTicketRepliesRequest {
+  filters?: {
+    ticket?: number;
+  };
+}
+
+export interface ICustomerTicketRepliesPageRequest extends ICustomerTicketRepliesRequest {
+  paginate?: IApiPaginationRequest;
+}
+
+export interface ICustomerTicketCreateRequest {
+  ticket_body: string;
+}
+
+export interface ICustomerTicketOrderItemRequest extends ICustomerTicketCreateRequest {
+  order_dlf_item: number;
+  // Required after the regular return period, until the defect period ends.
+  is_defect?: boolean;
+}
+
+export interface ICustomerTicketOrderOptionRequest extends ICustomerTicketCreateRequest {
+  order_option_item: number;
+  // Required after the regular return period, until the defect period ends.
+  is_defect?: boolean;
+}
+
+export interface ICustomerTicketSubscriptionRequest extends ICustomerTicketCreateRequest {
+  related_paid_subscription: number;
+}
+
+export interface ICustomerTicketReplyRequest extends ICustomerTicketCreateRequest {
+  ticket: number;
+}
+
+export interface ICustomerTicketRatingRequest {
+  rating: number;
+}
+
+export interface ICustomerTicketReply {
+  id: number;
+  direction: {
+    int: ETicketReplyDirection;
+    text: string;
+  };
+  sender: {
+    id: number;
+    first_name: string;
+    last_name: string;
+    avatar: string | null;
+  };
+  reply_time: IApiDateTime | null;
+  read_time: IApiDateTime | null;
+  reply_images: {
+    id: number;
+    image: string | null;
+  }[];
+  reply_text: string;
+}
+
+export interface ICustomerTicketRefund {
+  id: number;
+  shipment_status: {
+    int: EOrderRefundShipmentStatus;
+    text: string;
+  };
+  track: {
+    id: number;
+    track: string;
+    internal_track: string;
+    status: string;
+    carrier_name: Record<string, {
+      carrier_name?: string;
+    }>;
+    carrier_logo: string | null;
+  } | null;
+  order?: IOrder | null;
+}
+
+// Why the customer cannot add a message right now. `support_reply`: the
+// conversation waits for the first support reply. `delay`: the previous
+// customer message is newer than the store's reply delay; `seconds` is the
+// time left.
+export type TicketReplyWaitReason = 'support_reply' | 'delay';
+
+export interface ICustomerTicketReplyWait {
+  reason: TicketReplyWaitReason;
+  seconds: number | null;
+}
+
+export interface ICustomerTicket {
+  id: number;
+  type: {
+    int: ECustomerTicketType;
+    text: string;
+  };
+  product?: IProduct | null;
+  order_id?: number;
+  related_dlf_item_id: number | null;
+  related_option_item_id: number | null;
+  related_paid_subscription_id: number | null;
+  status: {
+    int: ECustomerTicketStatus;
+    text: string;
+  };
+  time_created: IApiDateTime | null;
+  time_updated: IApiDateTime | null;
+  c_unread_to_user: number;
+  c_unread_to_managment: number;
+  counts: {
+    c_attached_files: number;
+    c_total_messages: number;
+  };
+  solution: {
+    int: ECustomerTicketSolution;
+    text: string;
+  };
+  // A return request marked by the customer as a defect.
+  is_defect?: boolean;
+  rating: number;
+  time_last_msg_customer: IApiDateTime | null;
+  time_last_msg_manager: IApiDateTime | null;
+  // null when a message is accepted now.
+  reply_wait?: ICustomerTicketReplyWait | null;
+  replies?: ICustomerTicketReply[];
+  refund?: ICustomerTicketRefund;
+}
+
+export interface ICustomerTicketsResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    data: ICustomerTicket[];
+    rpag: IApiPagination;
+    counts?: {
+      c_opened: number;
+      c_closed: number;
+    };
+  } | null;
+}
+
+export interface ICustomerTicketCreatedResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: ICustomerTicket | null;
+}
+
+export interface ICustomerTicketRepliesResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: ICustomerTicketReply[] | null;
+}
+
+export interface ICustomerTicketRepliesPageResponse {
+  form_errors: Record<string, ApiFormError[]> | null;
+  success_message: string | null;
+  page_data: {
+    data: ICustomerTicketReply[];
+    rpag: IApiPagination;
+  } | null;
+}
+
+export type ICustomerTicketImageResponse = Blob | string;

package/templates/interfaces/orionplace/transport.ts

@@ -1,11 +1,15 @@
-import type { IAppLoad } from './appBase/IAppLoad';
+import type { IAppLoad } from '@/interfaces/orionplace/appBase/IAppLoad';
 
-export type JsonValue = null | boolean | number | string | JsonValue[] | { [key: string]: JsonValue };
+export type JsonValue =
+  null | boolean | number | string | JsonValue[] | { [key: string]: JsonValue };
 export interface AppLoadRequest {
   detalize_mode: 'full' | 'light';
   ignore_cache: boolean;
 }
-export interface ApiFormError { message: string; code: string }
+export interface ApiFormError {
+  message: string;
+  code: string;
+}
 export interface AppLoadResponse {
   form_errors: Record<string, ApiFormError[]> | null;
   success_message: string | null;

package/templates/lib/orionplace/accountLabels.ts

@@ -0,0 +1,22 @@
+import { getAvailableValueFromObject } from '@/lib/orionplace/presentation';
+
+const labels = {
+  en: {
+    signIn: 'Login',
+    signOut: 'Logout',
+    profile: 'Profile',
+    wallet: 'Wallet',
+    account: 'Your account',
+  },
+  ru: {
+    signIn: 'Войти',
+    signOut: 'Выйти',
+    profile: 'Профиль',
+    wallet: 'Кошелёк',
+    account: 'Личный кабинет',
+  },
+};
+
+export function accountLabels(locale: string) {
+  return getAvailableValueFromObject(labels, locale) ?? labels.en;
+}

package/templates/lib/orionplace/activityLabels.ts

@@ -0,0 +1,65 @@
+const en = {
+  title: 'My activity',
+  logs: 'Sign-in history',
+  logsTab: 'Logins',
+  logsEmpty: 'No sign-ins to show.',
+  from: 'From date',
+  to: 'To date',
+  device: 'Device',
+  browser: 'Browser',
+  location: 'Location',
+  unknown: 'Unknown',
+  promocodes: 'My promo codes',
+  promocodesTab: 'Promos',
+  promosEmpty: 'No promo codes are available.',
+  apply: 'Apply',
+  applied: 'Applied to cart',
+  notStarted: 'Starts on',
+  expired: 'Expired',
+  unavailable: 'Not available',
+  cart: 'Open cart',
+  reviews: 'My reviews',
+  reviewsTab: 'Reviews',
+  wishlist: 'Wishlist',
+  wishlistEmpty: 'Save products with the heart button to find them here.',
+  notifications: 'Notifications',
+  notificationsEmpty: 'No products with availability notifications.',
+  removeWish: 'Remove',
+  stopNotification: 'Unsubscribe',
+  viewProduct: 'View product',
+};
+
+const ru: typeof en = {
+  title: 'Моя активность',
+  logs: 'История входов',
+  logsTab: 'Входы',
+  logsEmpty: 'История входов пока пуста.',
+  from: 'С даты',
+  to: 'По дату',
+  device: 'Устройство',
+  browser: 'Браузер',
+  location: 'Местоположение',
+  unknown: 'Неизвестно',
+  promocodes: 'Мои промокоды',
+  promocodesTab: 'Промокоды',
+  promosEmpty: 'Доступных промокодов пока нет.',
+  apply: 'Применить',
+  applied: 'Применён к корзине',
+  notStarted: 'Начнёт действовать',
+  expired: 'Срок истёк',
+  unavailable: 'Недоступен',
+  cart: 'Открыть корзину',
+  reviews: 'Мои отзывы',
+  reviewsTab: 'Отзывы',
+  wishlist: 'Избранное',
+  wishlistEmpty: 'Нажмите на сердечко у товара, чтобы сохранить его здесь.',
+  notifications: 'Уведомления',
+  notificationsEmpty: 'Товаров с уведомлениями о наличии пока нет.',
+  removeWish: 'Убрать',
+  stopNotification: 'Отписаться',
+  viewProduct: 'Открыть товар',
+};
+
+export function activityLabels(locale: string) {
+  return locale.toLowerCase().startsWith('ru') ? ru : en;
+}

package/templates/lib/orionplace/activityPresentation.ts

@@ -0,0 +1,9 @@
+export type ActivityIconName = 'device' | 'browser' | 'pin' | 'clock';
+
+export const activityIconPaths: Record<ActivityIconName, string> = {
+  device: 'M3 5h18v11H3zM8 20h8M12 16v4',
+  browser:
+    'M12 21a9 9 0 1 0 0-18 9 9 0 0 0 0 18ZM3 12h18M12 3c2.5 2.6 2.5 15 0 18M12 3c-2.5 2.6-2.5 15 0 18',
+  pin: 'M12 21s-7-6.2-7-11.5a7 7 0 0 1 14 0C19 14.8 12 21 12 21ZM12 12a2.5 2.5 0 1 0 0-5 2.5 2.5 0 0 0 0 5Z',
+  clock: 'M12 7v5l3 2M21 12a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z',
+};

package/templates/lib/orionplace/addressChanges.ts

@@ -0,0 +1,26 @@
+import type {
+  IUserAddress,
+  IUserAddressRequest,
+} from '@/interfaces/orionplace/address/IUserAddress';
+
+// The fields an address plugin may rewrite when it recognizes the address
+// (the backend normalizes city, street, house, second line and postcode).
+export const refinableAddressFields = [
+  'city',
+  'line1',
+  'line2',
+  'house_number',
+  'postcode',
+] as const;
+
+export type RefinableAddressField = (typeof refinableAddressFields)[number];
+
+// The fields whose saved value differs from the value the customer sent.
+export function refinedAddressFields(
+  sent: IUserAddressRequest,
+  saved: IUserAddress,
+): RefinableAddressField[] {
+  return refinableAddressFields.filter(
+    (name) => (sent[name] ?? '').trim() !== (saved[name] ?? '').trim(),
+  );
+}

package/templates/lib/orionplace/addressPresentation.ts

@@ -0,0 +1,58 @@
+import type { IAddressRegion } from '@/interfaces/orionplace/address/IAddressRegionSearch';
+import type {
+  IAddressCountry,
+  IUserAddress,
+} from '@/interfaces/orionplace/address/IUserAddress';
+import { getAvailableNestedValueFromObject } from '@/lib/orionplace/presentation';
+
+export function addressCountryName(
+  country: IAddressCountry | null | undefined,
+  locale: string,
+) {
+  if (!country) {
+    return '';
+  }
+  return (
+    getAvailableNestedValueFromObject(
+      country.locale,
+      locale,
+      'printable_name',
+    ) || country.iso_3166_1_a2
+  );
+}
+
+export function addressRegionName(
+  region: IAddressRegion | null | undefined,
+  locale: string,
+) {
+  if (!region) {
+    return '';
+  }
+  return (
+    getAvailableNestedValueFromObject(region.locales, locale, 'region_name') ||
+    region.region_iso
+  );
+}
+
+export function addressSummary(address: IUserAddress, locale: string) {
+  return [
+    addressRegionName(address.state, locale),
+    address.city,
+    address.line1,
+    address.house_number,
+    address.apt_number,
+  ]
+    .filter(Boolean)
+    .join(', ');
+}
+
+export function uniqueAddressRegions(regions: readonly IAddressRegion[]) {
+  const seen = new Set<number>();
+  return regions.filter((region) => {
+    if (seen.has(region.id)) {
+      return false;
+    }
+    seen.add(region.id);
+    return true;
+  });
+}