@pushwoosh/session-store 1.0.0

package/README.md

@@ -0,0 +1,16 @@
+# Pushwoosh / Micro Frontends / Session Store
+Этот пакет является частью микрофронтендовой архитектуры.
+Является хранилищем данных о текущем сеансе.
+
+## Термины
+
+## Установка
+0.  Установить переменную окружения "NPM_TOKEN" в терминале (токен можно получить у администраторов)
+1.  Выполнить `npm ci` для установки зависимостей
+
+## Запуск разработки
+0. Скопировать файл `.env.example` в `.env`. Удалить из него комментарии к переменным
+1. Выполнить `npm start`
+
+## Работа с библиотекой
+

package/dist/entities/account.d.ts

@@ -0,0 +1,253 @@
+import { AccountData } from '../rpc.types';
+export declare enum ProductType {
+    FREE = "Free",
+    DEVELOPER = "Developer",
+    MARKETING = "Marketing",
+    ENTERPRISE = "Enterprise"
+}
+/**
+ * Информация об аккаунте.
+ */
+export declare class Account {
+    /**
+     * Название аккаунта.
+     * (account.name)
+     */
+    readonly name: string;
+    /**
+     * Дата регистрации аккаунта.
+     * (account.registrationDate)
+     */
+    readonly registrationDate: string;
+    /**
+     * Данные для выставления счетов.
+     */
+    readonly billing: {
+        /**
+         * Название компании.
+         * (account.billingAddress.company_name)
+         */
+        readonly companyName: string | undefined;
+        /**
+         * Страна.
+         * (account.billingAddress.country)
+         */
+        readonly companyCountry: string | undefined;
+        /**
+         * Код страны.
+         * (account.billingAddress.country_code)
+         */
+        readonly companyCountryCode: string | undefined;
+        /**
+         * Штат (только для USA).
+         * (account.billingAddress.state)
+         */
+        readonly companyState: string | undefined;
+        /**
+         * Код штата (только для USA).
+         * (account.billingAddress.state_code)
+         */
+        readonly companyStateCode: string | undefined;
+        /**
+         * Город.
+         * (account.billingAddress.city)
+         */
+        readonly companyCity: string | undefined;
+        /**
+         * Улица.
+         * (account.billingAddress.street)
+         */
+        readonly companyStreet: string | undefined;
+        /**
+         * Почтовый индекс.
+         * (account.billingAddress.zip)
+         */
+        readonly companyZip: string | undefined;
+        /**
+         * Телефонный номер.
+         * (account.billingAddress.phone)
+         */
+        readonly companyPhone: string | undefined;
+        /**
+         * ИНН предприятия.
+         * (account.billingAddress.vat_number)
+         */
+        readonly companyVAT: string | undefined;
+        /**
+         * Используется как номер закупки.
+         * (account.billingAddress.company_number)
+         */
+        readonly companyNumber: string | undefined;
+        /**
+         * Имя контакта для связи.
+         * (account.billingAddress.first_name)
+         */
+        readonly primaryPersonFirstName: string | undefined;
+        /**
+         * Фамилия контакта для связи.
+         * (account.billingAddress.last_name)
+         */
+        readonly primaryPersonLastName: string | undefined;
+        /**
+         * Эл. почта контакта для связи.
+         * (account.billingAddress.paymentEmail)
+         */
+        readonly primaryPersonEmail: string | undefined;
+        /**
+         * Имя дополнительного контакта для связи.
+         * (account.billingAddress.secondary_person_first_name)
+         */
+        readonly secondaryPersonFirstName: string | undefined;
+        /**
+         * Фамилия дополнительного контакта для связи.
+         * (account.billingAddress.secondary_person_last_name)
+         */
+        readonly secondaryPersonLastName: string | undefined;
+        /**
+         * Эл. почта дополнительного контакта для связи.
+         * (account.billingAddress.secondary_person_email)
+         */
+        readonly secondaryPersonEmail: string | undefined;
+        /**
+         * Сфера промышленности.
+         * (account.billingAddress.industry)
+         */
+        readonly industry: string | undefined;
+        /**
+         * Департамент.
+         * (account.billingAddress.department)
+         */
+        readonly department: string | undefined;
+        /**
+         * Дополнительные эл. адреса для связи.
+         * (account.billingAddress.additionalEmails)
+         */
+        readonly additionalEmails: string | undefined;
+    };
+    /**
+     * Какой тип подписки куплен.
+     * (account.productType)
+     */
+    readonly productType: ProductType;
+    /**
+     * Название плана подписки. Просто строка, чтобы отобразить в настройках.
+     * (account.restriction)
+     */
+    readonly productName: string;
+    /**
+     * Является ли аккаунт энтерпрайзом.
+     * (account.isEnterprise)
+     */
+    readonly isEnterprise: boolean;
+    /**
+     * Дата окончания подписки.
+     * (account.expireDate)
+     */
+    readonly expiryDate: string;
+    /**
+     * Заморожен ли аккаунт.
+     * (account.frozen)
+     */
+    readonly isFrozen: boolean;
+    /**
+     * Превышено ли количество доступных девайсов.
+     * (account.isDeviceLimitReached)
+     */
+    readonly isDeviceLimitReached: boolean;
+    /**
+     * Включено ли создание резервных копий.
+     * (account.allowBackup)
+     */
+    readonly isEnabledBackup: boolean;
+    /**
+     * Статистика по аккаунту.
+     */
+    readonly statistics: {
+        /**
+         * Количество активных пользователей с начала текущего месяца.
+         * (account.MAU)
+         */
+        readonly currentMonthActiveUsers: number;
+        /**
+         * Количество активных пользователей за предыдущий месяц.
+         * (account.lastMAU)
+         */
+        readonly lastMonthActiveUsers: number;
+        /**
+         * Количество активных пользователей за 30/31 календарный день.
+         * (account.calendarMAU)
+         */
+        readonly calendarMonthActiveUsers: number;
+        /**
+         * Количество активных девайсов с начала текущего месяца.
+         * (account.MAD)
+         */
+        readonly currentMonthActiveDevicesCount: number;
+        /**
+         * Количество активных девайсов за предыдущий месяц.
+         * (account.lastMAD)
+         */
+        readonly lastMonthActiveDevicesCount: number;
+        /**
+         * Количество активных девайсов за 30/31 календарный день.
+         * (account.calendarMAD)
+         */
+        readonly calendarMonthActiveDevicesCount: number;
+        /**
+         * Количество подписчиков.
+         * (account.totalSubscribers)
+         */
+        readonly totalSubscribers: number;
+        /**
+         * Количество устройств, которым есть возможность показывать пуш-уведомления.
+         * (account.pushAvailableSubscribers)
+         */
+        readonly pushAvailableSubscribers: number;
+        /**
+         * Количество устройств, которым нельзя показывать пуш-уведомления.
+         * (account.pushNotAvailableSubscribers)
+         */
+        readonly pushNotAvailableSubscribers: number;
+        /**
+         * Количество отправленных писем за сегодняшний день.
+         * (account.dailyEmailStat)
+         */
+        readonly currentDaySentEmailsCount: number | undefined;
+        /**
+         * Количество отправленных писем с начала текущего месяца.
+         * (account.monthlyEmailStat)
+         */
+        readonly currentMontSentEmailsCount: number | undefined;
+        /**
+         * Количество отправленных писем за 30/31 день.
+         * (account.lastEmailStat)
+         */
+        readonly calendarMonthSentEmailsCount: number | undefined;
+        /**
+         * Предоставленный лимит бесплатных писем.
+         * (account.freeEmailLimit)
+         */
+        readonly freeEmailsLimit: number | undefined;
+        /**
+         * Оставшееся количество бесплатных писем.
+         * (account.freeEmailQuota)
+         */
+        readonly freeEmailsQuota: number | undefined;
+        /**
+         * Дата обновления квоты бесплатных писем.
+         * (account.freeEmailLimitUpdateDate)
+         */
+        readonly freeEmailsQuotaUpdateDate: string | undefined;
+        /**
+         * Оставшееся количество купленных писем.
+         * (account.paidEmailQuota)
+         */
+        readonly paidEmailsQuota: number | undefined;
+        /**
+         * Дата окончания действия квоты купленных писем.
+         * (account.paidEmailExpireDate)
+         */
+        readonly paidEmailsQuotaExpiryDate: string | undefined;
+    };
+    constructor(accountData: AccountData);
+}

package/dist/entities/permissions.d.ts

@@ -0,0 +1,91 @@
+import { AccountData } from '../rpc.types';
+/**
+ * Разрешения на использование функционала со стороны владельца аккаунта.
+ */
+export declare class Permissions {
+    /**
+     * Есть ли у пользователя супер-права.
+     */
+    readonly hasSuperRights: boolean;
+    /**
+     * Может ли пользователь управлять подпиской.
+     */
+    readonly canManageSubscription: boolean;
+    /**
+     * Может ли пользователь управлять ключами доступа.
+     */
+    readonly canManageAccessTokens: boolean;
+    /**
+     * Может ли пользователь управлять доменами и электронными адресами.
+     */
+    readonly canManageDomainsAndEmails: boolean;
+    /**
+     * Может ли пользователь управлять правами других пользователей.
+     */
+    readonly canManageSubUsers: boolean;
+    /**
+     * Может ли пользователь просматривать приложения.
+     */
+    readonly canSeeApplications: boolean;
+    /**
+     * Может ли пользователь редактировать приложения.
+     */
+    readonly canModifyApplications: boolean;
+    /**
+     * Может ли пользователь просматривать группы приложений.
+     */
+    readonly canSeeApplicationGroups: boolean;
+    /**
+     * Может ли пользователь редактировать группы приложений.
+     */
+    readonly canModifyApplicationGroups: boolean;
+    /**
+     * Может ли пользователь просматривать отправленные сообщения.
+     */
+    readonly canSeeMessages: boolean;
+    /**
+     * Может ли пользователь редактировать (отменять) отправленные сообщения.
+     */
+    readonly canModifyMessages: boolean;
+    /**
+     * Может ли пользователь отправлять сообщения.
+     */
+    readonly canSendMessages: boolean;
+    /**
+     * Может ли пользователь просматривать теги.
+     */
+    readonly canSeeTags: boolean;
+    /**
+     * Может ли пользователь редактировать теги.
+     */
+    readonly canModifyTags: boolean;
+    /**
+     * Может ли пользователь просматривать сегменты.
+     */
+    readonly canSeeSegments: boolean;
+    /**
+     * Может ли пользователь редактировать сегменты.
+     */
+    readonly canModifySegments: boolean;
+    /**
+     * Может ли пользователь просматривать рич-медиа.
+     */
+    readonly canSeeRichMedia: boolean;
+    /**
+     * Может ли пользователь редактировать рич-медиа.
+     */
+    readonly canModifyRichMedia: boolean;
+    /**
+     * Может ли пользователь просматривать рич-медиа.
+     */
+    readonly canSeeInApps: boolean;
+    /**
+     * Может ли пользователь просматривать шаблоны писем.
+     */
+    readonly canSeeEmailTemplates: boolean;
+    /**
+     * Может ли пользователь редактировать шаблоны писем.
+     */
+    readonly canModifyEmailTemplates: boolean;
+    constructor(account: AccountData);
+}

package/dist/entities/platforms.d.ts

@@ -0,0 +1,70 @@
+import { AccountData } from '../rpc.types';
+/**
+ * Идентификатор платформы.
+ */
+export declare enum Platform {
+    IOS = 1,
+    BLACKBERRY = 2,
+    ANDROID = 3,
+    WINDOWS_PHONE = 5,
+    MAC_OS = 7,
+    WINDOWS = 8,
+    AMAZON = 9,
+    SAFARI = 10,
+    CHROME = 11,
+    FIREFOX = 12,
+    IE = 13,
+    EMAIL = 14,
+    BAIDU = 16,
+    HUAWEI = 17
+}
+/**
+ * Название платформы.
+ */
+export declare enum PlatformName {
+    IOS = "iOS",
+    BLACKBERRY = "Blackberry",
+    ANDROID = "Android",
+    WINDOWS_PHONE = "Windows Phone",
+    MAC_OS = "Mac OS",
+    WINDOWS = "Windows",
+    AMAZON = "Amazon",
+    SAFARI = "Safari",
+    CHROME = "Chrome",
+    FIREFOX = "Firefox",
+    IE = "Internet Explorer",
+    EMAIL = "Email",
+    BAIDU = "Baidu",
+    HUAWEI = "Huawei"
+}
+/**
+ * Вспомогательный класс для работы с платформами.
+ */
+export declare class Platforms {
+    /**
+     * Отсеять неизвестные значения.
+     *
+     * @param { Array<number> } platforms - массив доступных платформ.
+     * @return { Array<Platform> } platforms - безопасный массив доступных платформ.
+     */
+    private static filterAllowPlatforms;
+    /**
+     * Получить название платформы по ее идентификатору.
+     *
+     * @param { Platform } platform - идентификатор платформы.
+     * @return { string }  идентификатор платформы.
+     */
+    static getPlatformName: (platform: Platform) => string;
+    /**
+     * Массив доступных платформ.
+     */
+    readonly available: Array<Platform>;
+    constructor(accountData: AccountData);
+    /**
+     * Проверить, доступна ли платформа для использования.
+     *
+     * @param { Platform } platform - идентификатор платформы.
+     * @return { boolean } - доступна ли платформа для использования.
+     */
+    checkIsAvailablePlatform: (platform: Platform) => boolean;
+}