orionplace-react 0.7.7 → 0.8.0

package/templates/components/orionplace/orders/OrderDetails.README.md

@@ -1,116 +0,0 @@
-# OrderDetails · React
-
-## English
-
-`OrderDetails` renders one confirmed `IOrder`. The status rail uses every
-shipment's sent and delivered dates. If only some shipments reached a stage,
-the current step says Partly shipped or Partly delivered and shows the reached
-count. Canceled and return orders show their status explanation without a
-delivery rail. Recipient values come from `contact`; receiver name and phone
-take precedence over the purchaser values. Payment shows the localized method
-and the derived paid, late-paid, partly-paid, on-delivery or unpaid state.
-
-Each shipment shows its own preparation, transit, delivery, returned-by-carrier
-or canceled state, origin store, method, carrier, destination, dates and
-tracking values. `dates.returned_by_carrier` marks a package the carrier
-brought back undelivered and adds its date. Product
-rows reserve a fixed thumbnail area and show the localized name, selected main
-variant, ordered quantity, unit price and product-line amount. `productHref`
-can replace the localized product route.
-
-Only option groups that contain entered text, an uploaded file or an option
-with positive quantity are displayed. An option line uses its own
-`options_price_after_promo`; its unit price is that line amount divided by the
-ordered quantity. The item summary separately shows the option amount and the
-item total.
-
-Return panels list every positive count from `refund_stats`: units to send,
-received units, units approved for refund and, from `c_refund_defect`, the
-units of them returned as a defect. They also show the relevant item or option
-refund amount and, when present, the return shipment state, tracking number
-and conversation link. Otherwise `refund_window` decides the return request:
-`regular` offers an ordinary return, `defect` a return of a defective item and
-`null` none; a backend without `refund_window` sends only `refund_allowed`,
-which reads as `regular`. The request opens a new conversation for that exact
-order item or option. `ticketsHref` can replace these routes.
-
-Paid and late-paid orders show purchased product and option attachments.
-Returned content is no longer listed or downloadable; a digital line or option
-with units received back or approved for refund shows Returned with their
-count.
-Download calls `onDownload(kind, id, filename)` with `product`, `option` or
-`group`; a customer's option-group file uses the group ID. `pending` disables
-all download actions. The component only emits the request and does not treat
-an API error response as a downloaded file.
-
-Source is maintained in `components/orionplace/orders/OrderDetails.tsx`; the
-physical order contract is in
-`interfaces/orionplace/orders/IOrderHistory.ts`.
-
-### Props
-
-| Prop                                                                                                                    | Meaning                                                                                                  |
-| ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `order: IOrder`                                                                                                         | Order displayed by the component.                                                                        |
-| `pending?: boolean`                                                                                                     | Shows the loading state and blocks duplicate actions.                                                    |
-| `productHref?: (productId: number, locale: string) => string`                                                           | Builds the product destination from the callback arguments.                                              |
-| `ticketsHref?: (values: { ticket?: number; item?: number; option?: number; order: number; }, locale: string) => string` | Builds the tickets destination from the callback arguments.                                              |
-| `onDownload?: (kind: OrderDownloadKind, id: number, filename: string) => void`                                          | Selecting a download passes three arguments: attachment kind `kind`, its `id` and `filename`. The application downloads the file. |
-
-## Русский
-
-`OrderDetails` показывает один подтверждённый `IOrder`. Шкала статуса
-использует даты отправки и доставки каждого отправления. Если этапа
-достигла только часть отправлений, текущий шаг назван «Частично
-отправлен» или «Частично доставлен» и показывает число таких
-отправлений. Отменённый заказ и заказ с возвратом показывают объяснение
-статуса без шкалы доставки. Данные получателя берутся из `contact`; имя и
-телефон получателя имеют приоритет над данными покупателя. В оплате
-видны локализованный способ и определённое состояние: оплачено, оплачено
-после отмены, оплачено частично, оплата при получении или не оплачено.
-
-Каждое отправление показывает своё состояние подготовки, перевозки, доставки,
-возврата перевозчиком или отмены, исходный магазин, способ, перевозчика, адрес,
-даты и данные для отслеживания. `dates.returned_by_carrier` отмечает посылку,
-которую перевозчик вернул недоставленной, и добавляет её дату. Строка товара резервирует место для миниатюры и показывает
-локализованное название, выбранный основной вариант, количество, цену за штуку
-и сумму товаров этой позиции. `productHref` может заменить локализованный
-маршрут товара.
-
-Показываются только те группы дополнений, где есть введённый текст,
-загруженный файл или дополнение с положительным количеством. Строка
-дополнения использует свою сумму `options_price_after_promo`; цена за штуку равна
-этой сумме, делённой на заказанное количество. В итогах позиции отдельно
-показаны сумма дополнений и общая сумма позиции.
-
-Панель возврата показывает каждое положительное число из `refund_stats`:
-товары к отправке, полученные товары, товары, по которым одобрена выплата,
-и из `c_refund_defect` — сколько из них возвращено по браку. В ней также видны
-сумма возврата для товара или дополнения, состояние и трек-номер обратного
-отправления, а также ссылка на обращение. Если возврат ещё не оформлен,
-заявку определяет `refund_window`: `regular` предлагает обычный возврат,
-`defect` — возврат товара с браком, `null` — ничего; бэкенд без
-`refund_window` присылает только `refund_allowed`, он читается как `regular`.
-Заявка открывает новое обращение для точной позиции заказа или дополнения.
-`ticketsHref` может заменить эти маршруты.
-
-В оплаченном или оплаченном после отмены заказе видны приобретённые файлы
-товаров и дополнений. Возвращённые материалы больше не перечисляются и не
-скачиваются; цифровая позиция или дополнение с полученными обратно или
-одобренными к выплате единицами показывает «Возвращено» и их число. Скачивание вызывает `onDownload(kind, id, filename)` с
-`product`, `option` или `group`; для загруженного покупателем файла группы
-передаётся ID группы. `pending` блокирует все скачивания. Компонент только
-передаёт запрос и не считает ошибку API скачанным файлом.
-
-Исходный файл: `components/orionplace/orders/OrderDetails.tsx`; физический
-контракт заказа находится в `interfaces/orionplace/orders/IOrderHistory.ts`.
-
-### Свойства
-
-| Свойство                                                                                                                | Назначение                                                                                                 |
-| ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
-| `order: IOrder`                                                                                                         | Заказ, который показывает компонент.                                                                       |
-| `pending?: boolean`                                                                                                     | Показывает загрузку и блокирует повторные действия.                                                        |
-| `productHref?: (productId: number, locale: string) => string`                                                           | Строит адрес ссылки товара из аргументов обработчика.                                                      |
-| `ticketsHref?: (values: { ticket?: number; item?: number; option?: number; order: number; }, locale: string) => string` | Строит адрес ссылки обращений из аргументов обработчика.                                                   |
-| `onDownload?: (kind: OrderDownloadKind, id: number, filename: string) => void`                                          | При выборе скачивания передаёт три аргумента: вид вложения `kind`, его `id` и имя файла `filename`. Приложение загружает файл. |