orionplace-react 0.1.0 → 0.2.1

package/templates/lib/orionplace/subscriptionManageLabels.ts

@@ -0,0 +1,306 @@
+const en = {
+  statusActive: 'Active',
+  statusExpired: 'Ended',
+  statusPending: 'Being set up',
+  statusPendingHint:
+    'The service is being prepared and confirms the subscription itself.',
+  manage: 'Manage subscription',
+  extend: 'Extend now',
+  extendHint: 'Pay for another period from the account balance',
+  renewalSettings: 'Automatic renewal',
+  renewalHint: 'Choose the period that is paid automatically, or turn it off',
+  changePlan: 'Change plan',
+  changePlanHint: 'Move this subscription to another plan',
+  close: 'Close',
+  cancel: 'Cancel',
+  period: 'Period',
+  promo: 'Promo code',
+  promoHint: 'Optional. A promo code applies to a paid period.',
+  balance: 'Account balance',
+  planPrice: 'Plan for this period',
+  optionPrice: 'Service option',
+  insufficient:
+    'The balance is lower than this period. Top up the balance, or choose ' +
+    'another period.',
+  topUp: 'Deposit',
+  extendTitle: 'Extend the subscription',
+  extendSummary:
+    'The chosen period is charged from the account balance at once and added ' +
+    'to the subscription.',
+  extendAfter:
+    '{period} is added to the subscription, and the amount is charged from ' +
+    'the account balance now.',
+  extendSubmit: 'Pay',
+  extendPending: 'Paying…',
+  extendConfirm: 'Confirm',
+  renewalTitle: 'Automatic renewal',
+  renewalCurrentOn: 'Now: every {days} for {price}.',
+  renewalCurrentOff: 'Now: automatic renewal is off.',
+  renewalOff: 'Turn automatic renewal off',
+  renewalOffHint: 'Nothing is charged; the paid period stays available.',
+  renewalEffectOff:
+    'Automatic renewal stops. The subscription stays available until the end ' +
+    'of the paid period and the balance is not charged for it again.',
+  renewalEffectOn:
+    'Renewal for {days} costs {price} for the plan, plus any option charge. ' +
+    'After the paid period ends, renewal requires enough account balance ' +
+    'for the total. If the period has already ended, it starts immediately ' +
+    'when the balance is sufficient. Otherwise only the setting is saved.',
+  renewalSubmit: 'Save',
+  renewalPending: 'Saving…',
+  renewalNoChange: 'This is the current setting.',
+  changeOption: 'Change service option',
+  changeOptionHint: 'Move this subscription to another service option',
+  changePlanTitle: 'Change the plan',
+  changeOptionTitle: 'Change the service option',
+  changePlanSummary:
+    'The unused days of the current period are refunded to the account ' +
+    'balance, and the selected period of the new plan is charged in full.',
+  changeOptionSummary:
+    'The unused days of the current period are refunded to the account ' +
+    'balance, and the selected period with the new service option is charged ' +
+    'in full.',
+  changePlanField: 'New plan',
+  changeOptionField: 'Service option',
+  changeCurrentPlan: 'Now: {plan}.',
+  changeCurrentOption: 'Now: {option}.',
+  changeNoOption: 'No service option',
+  changeRefund: 'Refund for the unused days',
+  changeRefundHint:
+    'The refund is credited to the account balance first, and the new period ' +
+    'is charged after it, so a change can be affordable when the same period ' +
+    'could not be bought on its own.',
+  changeRefundUnknown:
+    'The storefront backend calculates this amount when the change is sent.',
+  changeAvailable: 'Available for this change',
+  changeTotal: 'Charged for the new period',
+  changeAfterPlan:
+    'The subscription moves to {plan} for {period} now. The unused days are ' +
+    'refunded to the account balance and {price} is charged for the new ' +
+    'period.',
+  changeAfterOption:
+    'The subscription moves to {option} for {period} now. The unused days ' +
+    'are refunded to the account balance and {price} is charged for the new ' +
+    'period.',
+  changeAfterPlanRefund:
+    'The subscription moves to {plan} for {period} now. {refund} is refunded ' +
+    'to the account balance for the unused days and {price} is charged for ' +
+    'the new period.',
+  changeAfterOptionRefund:
+    'The subscription moves to {option} for {period} now. {refund} is ' +
+    'refunded to the account balance for the unused days and {price} is ' +
+    'charged for the new period.',
+  changeConfirm: 'Confirm',
+  changeSubmit: 'Pay',
+  changePending: 'Changing…',
+  changeNoPlans: 'There is no other plan to move this subscription to.',
+  changeNoOptions: 'This plan has no service option to select.',
+  changeNoPeriods: 'This plan has no period that a change can be bought for.',
+  changeInsufficient:
+    'The balance is lower than the new period. The refund for the unused ' +
+    'days is added to the balance first, so the change can still succeed; ' +
+    'top up the balance if the storefront refuses it.',
+  changeShort:
+    'The balance and the refund together are lower than the new period. Top ' +
+    'up the balance, or choose a shorter period.',
+  cancelSubscription: 'Cancel subscription',
+  cancelHint: 'Stop automatic renewal and keep the paid period',
+  cancelTitle: 'Cancel the subscription',
+  cancelSummary:
+    'Automatic renewal stops and nothing is charged again. The subscription ' +
+    'stays available until {date}, and no money is refunded.',
+  cancelSummaryNoDate:
+    'Automatic renewal stops and nothing is charged again. The subscription ' +
+    'stays available until the end of the paid period, and no money is ' +
+    'refunded.',
+  cancelResume:
+    'Selecting an automatic renewal period again starts renewal and removes ' +
+    'the cancelled state.',
+  cancelSubmit: 'Unsubscribe',
+  cancelPending: 'Cancelling…',
+  cancelKeep: 'Keep',
+  cancelled: 'Cancelled',
+  cancelledOn: 'Cancelled on {date}',
+  cancelledState:
+    'Automatic renewal is stopped. The subscription stays available until ' +
+    '{date}. Selecting an automatic renewal period starts it again.',
+  cancelledStateNoDate:
+    'Automatic renewal is stopped. The subscription stays available until ' +
+    'the end of the paid period. Selecting an automatic renewal period ' +
+    'starts it again.',
+  remoteTitle: 'Subscription service',
+  remoteId: 'Subscription ID in the service',
+  remoteSync: 'Last confirmed by the service',
+  remoteSyncPending: 'Waiting for the service to confirm the last change',
+  remoteHost: 'Host',
+  planTitle: 'Plan',
+  planIncludes: 'Included in the plan',
+  planNotIncluded: 'not included',
+  usageTitle: 'Usage',
+  usageOf: '{used} of {limit}',
+  actions: 'Subscription actions',
+};
+const ru: typeof en = {
+  statusActive: 'Действует',
+  statusExpired: 'Завершена',
+  statusPending: 'Подключается',
+  statusPendingHint:
+    'Сервис готовится к работе и подтверждает подписку самостоятельно.',
+  manage: 'Управление подпиской',
+  extend: 'Продлить сейчас',
+  extendHint: 'Оплатить ещё один период с баланса аккаунта',
+  renewalSettings: 'Автопродление',
+  renewalHint:
+    'Выберите период, который оплачивается автоматически, или выключите ' +
+    'автопродление',
+  changePlan: 'Сменить тариф',
+  changePlanHint: 'Перевести эту подписку на другой тариф',
+  close: 'Закрыть',
+  cancel: 'Отмена',
+  period: 'Период',
+  promo: 'Промокод',
+  promoHint: 'Необязательно. Промокод применяется к платному периоду.',
+  balance: 'Баланс аккаунта',
+  planPrice: 'Тариф за этот период',
+  optionPrice: 'Опция сервиса',
+  insufficient:
+    'Баланса не хватает на этот период. Пополните баланс или выберите другой ' +
+    'период.',
+  topUp: 'Пополнить',
+  extendTitle: 'Продление подписки',
+  extendSummary:
+    'Выбранный период сразу списывается с баланса аккаунта и добавляется к ' +
+    'подписке.',
+  extendAfter:
+    '{period} добавляется к подписке, а сумма списывается с баланса аккаунта ' +
+    'сейчас.',
+  extendSubmit: 'Оплатить',
+  extendPending: 'Оплата…',
+  extendConfirm: 'Подтвердить',
+  renewalTitle: 'Автопродление',
+  renewalCurrentOn: 'Сейчас: каждые {days} за {price}.',
+  renewalCurrentOff: 'Сейчас: автопродление выключено.',
+  renewalOff: 'Выключить автопродление',
+  renewalOffHint: 'Ничего не списывается, оплаченный период остаётся доступен.',
+  renewalEffectOff:
+    'Автопродление прекращается. Подписка остаётся доступна до конца ' +
+    'оплаченного периода, и баланс за неё больше не списывается.',
+  renewalEffectOn:
+    'Продление на {days} стоит {price} за тариф плюс доплата за опцию, если она есть. ' +
+    'После окончания периода для продления нужен баланс на полную сумму. ' +
+    'Если период уже закончился и средств достаточно, продление начинается ' +
+    'сразу. Иначе сохраняется только настройка.',
+  renewalSubmit: 'Сохранить',
+  renewalPending: 'Сохранение…',
+  renewalNoChange: 'Это текущая настройка.',
+  changeOption: 'Сменить опцию сервиса',
+  changeOptionHint: 'Перевести эту подписку на другую опцию сервиса',
+  changePlanTitle: 'Смена тарифа',
+  changeOptionTitle: 'Смена опции сервиса',
+  changePlanSummary:
+    'Неиспользованные дни текущего периода возвращаются на баланс аккаунта, ' +
+    'а выбранный период нового тарифа списывается полностью.',
+  changeOptionSummary:
+    'Неиспользованные дни текущего периода возвращаются на баланс аккаунта, ' +
+    'а выбранный период с новой опцией сервиса списывается полностью.',
+  changePlanField: 'Новый тариф',
+  changeOptionField: 'Опция сервиса',
+  changeCurrentPlan: 'Сейчас: {plan}.',
+  changeCurrentOption: 'Сейчас: {option}.',
+  changeNoOption: 'Без опции сервиса',
+  changeRefund: 'Возврат за неиспользованные дни',
+  changeRefundHint:
+    'Возврат сначала зачисляется на баланс аккаунта, и только потом ' +
+    'списывается новый период, поэтому смена может быть по карману, даже ' +
+    'если тот же период нельзя купить отдельно.',
+  changeRefundUnknown:
+    'Эту сумму бэкенд магазина рассчитывает при отправке смены.',
+  changeAvailable: 'Доступно на эту смену',
+  changeTotal: 'Списание за новый период',
+  changeAfterPlan:
+    'Подписка переходит на {plan} на {period} сейчас. Неиспользованные дни ' +
+    'возвращаются на баланс аккаунта, а за новый период списывается {price}.',
+  changeAfterOption:
+    'Подписка переходит на {option} на {period} сейчас. Неиспользованные дни ' +
+    'возвращаются на баланс аккаунта, а за новый период списывается {price}.',
+  changeAfterPlanRefund:
+    'Подписка переходит на {plan} на {period} сейчас. За неиспользованные ' +
+    'дни на баланс аккаунта возвращается {refund}, а за новый период ' +
+    'списывается {price}.',
+  changeAfterOptionRefund:
+    'Подписка переходит на {option} на {period} сейчас. За неиспользованные ' +
+    'дни на баланс аккаунта возвращается {refund}, а за новый период ' +
+    'списывается {price}.',
+  changeConfirm: 'Подтвердить',
+  changeSubmit: 'Оплатить',
+  changePending: 'Смена…',
+  changeNoPlans: 'Другого тарифа для этой подписки нет.',
+  changeNoOptions: 'В этом тарифе нет опции сервиса для выбора.',
+  changeNoPeriods: 'В этом тарифе нет периода, на который можно сменить.',
+  changeInsufficient:
+    'Баланса меньше, чем стоит новый период. Сначала на баланс зачисляется ' +
+    'возврат за неиспользованные дни, поэтому смена всё ещё может пройти; ' +
+    'пополните баланс, если магазин её отклонит.',
+  changeShort:
+    'Баланса вместе с возвратом меньше, чем стоит новый период. Пополните ' +
+    'баланс или выберите период короче.',
+  cancelSubscription: 'Отменить подписку',
+  cancelHint: 'Остановить автопродление и сохранить оплаченный период',
+  cancelTitle: 'Отмена подписки',
+  cancelSummary:
+    'Автопродление прекращается, и списаний больше не будет. Подписка ' +
+    'остаётся доступна до {date}, деньги не возвращаются.',
+  cancelSummaryNoDate:
+    'Автопродление прекращается, и списаний больше не будет. Подписка ' +
+    'остаётся доступна до конца оплаченного периода, деньги не возвращаются.',
+  cancelResume:
+    'Если снова выбрать период автопродления, оно возобновится и отметка об ' +
+    'отмене снимется.',
+  cancelSubmit: 'Отписаться',
+  cancelPending: 'Отмена…',
+  cancelKeep: 'Оставить',
+  cancelled: 'Отменена',
+  cancelledOn: 'Отменена {date}',
+  cancelledState:
+    'Автопродление остановлено. Подписка остаётся доступна до {date}. Если ' +
+    'снова выбрать период автопродления, оно возобновится.',
+  cancelledStateNoDate:
+    'Автопродление остановлено. Подписка остаётся доступна до конца ' +
+    'оплаченного периода. Если снова выбрать период автопродления, оно ' +
+    'возобновится.',
+  remoteTitle: 'Сервис подписки',
+  remoteId: 'ID подписки в сервисе',
+  remoteSync: 'Последнее подтверждение сервиса',
+  remoteSyncPending: 'Сервис ещё не подтвердил последнее изменение',
+  remoteHost: 'Хост',
+  planTitle: 'Тариф',
+  planIncludes: 'Входит в тариф',
+  planNotIncluded: 'не входит',
+  usageTitle: 'Использование',
+  usageOf: '{used} из {limit}',
+  actions: 'Действия с подпиской',
+};
+export function subscriptionManageLabels(locale: string) {
+  return locale.toLowerCase().startsWith('ru') ? ru : en;
+}
+
+const russianDays = ['день', 'дня', 'дней'];
+
+/** A period length with its noun: `30 days`, `30 дней`, `1 день`. */
+export function subscriptionDays(days: number, locale: string) {
+  if (!locale.toLowerCase().startsWith('ru')) {
+    return `${days} ${days === 1 ? 'day' : 'days'}`;
+  }
+
+  const tens = days % 100;
+  const units = days % 10;
+  let form = russianDays[2];
+
+  if (units === 1 && tens !== 11) {
+    form = russianDays[0];
+  } else if (units >= 2 && units <= 4 && (tens < 12 || tens > 14)) {
+    form = russianDays[1];
+  }
+
+  return `${days} ${form}`;
+}

package/templates/lib/orionplace/subscriptionPlans.ts

@@ -0,0 +1,122 @@
+import { tariffAmount } from '@/lib/orionplace/tariffs';
+import type { ISubscribeTariff } from '@/interfaces/orionplace/subscribeTariff/ISubscribeTariff';
+import type { ICurrencyAmounts } from '@/interfaces/orionplace/cart/ICartData';
+import type {
+  ICustomerSubscription,
+  ICustomerSubscriptionRenewal,
+} from '@/interfaces/orionplace/subscribes/ISubscriptionApi';
+
+export function renewalPlanCosts(
+  renewal: ICustomerSubscriptionRenewal,
+): ICurrencyAmounts {
+  return 'cost' in renewal ? renewal.cost : renewal.tariff_costs;
+}
+
+export function renewalOptionCosts(
+  renewal: ICustomerSubscriptionRenewal,
+): ICurrencyAmounts {
+  return 'cost' in renewal ? {} : renewal.option_costs;
+}
+
+export function renewalTotalAmount(
+  renewal: ICustomerSubscriptionRenewal | null,
+  currencyId: string,
+) {
+  if (!renewal) {
+    return undefined;
+  }
+  const plan = tariffAmount(renewalPlanCosts(renewal), currencyId);
+  const option = tariffAmount(renewalOptionCosts(renewal), currencyId) ?? 0;
+  return plan === undefined ? undefined : plan + option;
+}
+
+export type SubscriptionStatus = 'active' | 'ended' | 'pending';
+
+export function subscriptionStatus(
+  subscription: Pick<ICustomerSubscription, 'active_until' | 'plugin'>,
+): SubscriptionStatus {
+  if (subscription.plugin?.remote_subscription_sync_pending) {
+    return 'pending';
+  }
+  const until = subscription.active_until;
+  return typeof until?.days_ago === 'number' && until.days_ago < 0
+    ? 'active'
+    : 'ended';
+}
+
+function samePrice(amounts: ICurrencyAmounts, costs: ICurrencyAmounts) {
+  const currencies = Object.keys(costs);
+  return (
+    currencies.length > 0 &&
+    currencies.every((currencyId) => {
+      const price = amounts[currencyId]?.transform_value;
+      const cost = costs[currencyId]?.transform_value;
+      return (
+        typeof price === 'number' &&
+        typeof cost === 'number' &&
+        Math.abs(price - cost) < 0.01
+      );
+    })
+  );
+}
+
+function planFromRenewalPrice(
+  renewal: ICustomerSubscriptionRenewal,
+  tariffs: ISubscribeTariff[],
+) {
+  const costs = renewalPlanCosts(renewal);
+  const matches = tariffs.filter((tariff) =>
+    tariff.prices.some(
+      (price) => price.days === renewal.days && samePrice(price.amount, costs),
+    ),
+  );
+  return matches.length === 1 ? matches[0] : undefined;
+}
+
+export function subscriptionPlan(
+  subscription: {
+    tariff?: number | null;
+    renew_period: ICustomerSubscriptionRenewal | null;
+  },
+  tariffs: ISubscribeTariff[],
+) {
+  if (subscription.tariff !== undefined) {
+    return tariffs.find((tariff) => tariff.id === subscription.tariff);
+  }
+  return subscription.renew_period
+    ? planFromRenewalPrice(subscription.renew_period, tariffs)
+    : undefined;
+}
+
+export function subscriptionOption(
+  subscription: { option?: number | null },
+  plan: ISubscribeTariff | undefined,
+) {
+  return typeof subscription.option === 'number'
+    ? plan?.options.find((option) => option.id === subscription.option)
+    : undefined;
+}
+
+export interface ISubscriptionPeriodChoice {
+  id: number;
+  periodId: number;
+  days: number;
+  amount: number | undefined;
+}
+
+export function subscriptionPeriodChoices(
+  tariff: ISubscribeTariff | undefined,
+  currencyId: string,
+): ISubscriptionPeriodChoice[] {
+  if (!tariff) {
+    return [];
+  }
+  return [...tariff.prices]
+    .sort((left, right) => left.days - right.days)
+    .map((price) => ({
+      id: price.tariff_cost_id,
+      periodId: price.period_id,
+      days: price.days,
+      amount: tariffAmount(price.amount, currencyId),
+    }));
+}

package/templates/lib/orionplace/subscriptionRemote.ts

@@ -0,0 +1,85 @@
+import type { JsonValue } from '@/interfaces/orionplace/transport';
+import type { ICustomerSubscription } from '@/interfaces/orionplace/subscribes/ISubscriptionApi';
+
+export interface SubscriptionRemoteEntry {
+  key: string;
+  label: string;
+  value: string;
+}
+
+export interface SubscriptionRemoteField {
+  key: string;
+  label?: string;
+}
+
+const secretParts = [
+  'cred',
+  'password',
+  'passwd',
+  'secret',
+  'token',
+  'apikey',
+  'api_key',
+  'private',
+  'bucket',
+  'dsn',
+  'connection',
+  'auth',
+];
+
+export function subscriptionRemoteIsSecret(key: string) {
+  const name = key.toLowerCase();
+  return secretParts.some((part) => name.includes(part));
+}
+
+export function subscriptionRemoteEntries(
+  data: JsonValue,
+  fields?: SubscriptionRemoteField[],
+): SubscriptionRemoteEntry[] {
+  if (!data || typeof data !== 'object' || Array.isArray(data)) {
+    return [];
+  }
+  const record = data as Record<string, JsonValue>;
+  const chosen: SubscriptionRemoteField[] =
+    fields ?? Object.keys(record).map((key) => ({ key }));
+  const entries: SubscriptionRemoteEntry[] = [];
+  for (const field of chosen) {
+    const value = record[field.key];
+    if (subscriptionRemoteIsSecret(field.key)) {
+      continue;
+    }
+    if (typeof value === 'string' && value.trim()) {
+      entries.push({
+        key: field.key,
+        label: field.label ?? field.key,
+        value,
+      });
+    } else if (typeof value === 'number' && Number.isFinite(value)) {
+      entries.push({
+        key: field.key,
+        label: field.label ?? field.key,
+        value: String(value),
+      });
+    } else if (typeof value === 'boolean') {
+      entries.push({
+        key: field.key,
+        label: field.label ?? field.key,
+        value: String(value),
+      });
+    }
+  }
+  return entries;
+}
+
+export function subscriptionHasRemote(
+  subscription: Pick<ICustomerSubscription, 'plugin'>,
+) {
+  const plugin = subscription.plugin;
+  return Boolean(
+    plugin &&
+    (typeof plugin.remote_subscription_id === 'number' ||
+      subscriptionRemoteEntries(plugin.remote_subscription_data_user).length ||
+      subscriptionRemoteEntries(plugin.remote_subscription_tariff_usages)
+        .length),
+  );
+}

package/templates/lib/orionplace/subscriptionUsage.ts

@@ -0,0 +1,58 @@
+import type { JsonValue } from '@/interfaces/orionplace/transport';
+import type { ISubscribeTariff } from '@/interfaces/orionplace/subscribeTariff/ISubscribeTariff';
+import {
+  tariffUsageDetail,
+  tariffVariableCopy,
+  tariffVariableDetail,
+} from '@/lib/orionplace/tariffVariables';
+import { subscriptionRemoteIsSecret } from '@/lib/orionplace/subscriptionRemote';
+
+export interface SubscriptionUsageMeter {
+  key: string;
+  limitKey: string;
+  label: string;
+  hint: string;
+  used: string;
+  limit: string;
+  share: number | null;
+}
+
+export function subscriptionUsageMeters(
+  usage: JsonValue,
+  plan: ISubscribeTariff | undefined,
+  locale: string,
+): SubscriptionUsageMeter[] {
+  if (!usage || typeof usage !== 'object' || Array.isArray(usage)) {
+    return [];
+  }
+  const described = tariffVariableCopy(locale);
+  const variables = plan?.tariff_variables_json ?? {};
+  const meters: SubscriptionUsageMeter[] = [];
+  for (const [key, value] of Object.entries(usage)) {
+    if (
+      typeof value !== 'number' ||
+      !Number.isFinite(value) ||
+      subscriptionRemoteIsSecret(key)
+    ) {
+      continue;
+    }
+    const limitKey = `max_${key}`;
+    const known = described[limitKey];
+    // The backend allows one domain when the plan sets no limit; 0 means no limit.
+    const rawLimit = variables[limitKey] ?? (limitKey === 'max_front_hosts' ? 1 : undefined);
+    const limit = typeof rawLimit === 'number' ? rawLimit : undefined;
+    meters.push({
+      key,
+      limitKey,
+      label: known?.name || key,
+      hint: known?.hint ?? '',
+      used: tariffUsageDetail(limitKey, value, locale),
+      limit:
+        limit === undefined
+          ? ''
+          : tariffVariableDetail(limitKey, limit, locale),
+      share: limit ? Math.min(Math.max(value / limit, 0), 1) : null,
+    });
+  }
+  return meters;
+}