@glissandoo/lib 1.123.2 → 1.124.0-dev.219.1

package/lib/models/Group/index.js

@@ -1,326 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const date_fns_1 = require("date-fns");
-const lodash_1 = require("lodash");
-const collections_1 = require("../../helpers/collections");
-const currency_1 = require("../../helpers/currency");
-const glissandooAdmin_1 = require("../../helpers/glissandooAdmin");
-const orders_1 = require("../../helpers/instruments/orders");
-const objects_1 = require("../../helpers/objects");
-const plans_1 = require("../../helpers/plans");
-const lang_1 = require("../../lang");
-const basic_1 = __importDefault(require("./basic"));
-const types_1 = require("./types");
-class Group extends basic_1.default {
-    constructor(doc, lang = lang_1.defaultLocale) {
-        super(doc, lang);
-        this.getPlayer = (userId) => {
-            return userId in this.players ? this.players[userId] : null;
-        };
-        this.isAdmin = (userId) => {
-            return this.admins.includes(userId);
-        };
-        this.isPlayer = (userId) => {
-            return this.playerIds.includes(userId);
-        };
-    }
-    get owner() {
-        return this.data.owner;
-    }
-    get playerIds() {
-        return this.data.playerIds || [];
-    }
-    get players() {
-        return this.data.players || {};
-    }
-    get playersCount() {
-        return this.playerIds.length;
-    }
-    get description() {
-        return this.data.description || null;
-    }
-    get addresses() {
-        return this.data.addresses || [];
-    }
-    get addressDefault() {
-        return this.addresses.find((a) => a.default === true);
-    }
-    get activeInvitationLink() {
-        return this.data.activeInvitationLink || false;
-    }
-    get invitationLink() {
-        const link = `https://glissandoo.com/joingroup/${this.id}`;
-        if (lang_1.LanguagesTypes.ES === this.lang) {
-            return link;
-        }
-        return `${link}?lang=${this.lang}`;
-    }
-    get invitationEmails() {
-        return this.data.invitationEmails || [];
-    }
-    get shortDynamicLink() {
-        return `https://app.glissandoo.com/group/${this.username}`;
-    }
-    get admins() {
-        return this.data.administrators || [];
-    }
-    get adminPermissions() {
-        return this.data.adminPermissions || {};
-    }
-    permissionsByAdmin(userId) {
-        return this.adminPermissions[userId] || [];
-    }
-    adminsByPermissions(permission) {
-        return this.admins.filter((adminId) => {
-            const permissions = this.permissionsByAdmin(adminId);
-            return permissions.includes(permission);
-        });
-    }
-    get createdAt() {
-        return this.data.createdAt;
-    }
-    get deletedAt() {
-        return this.data.deletedAt || null;
-    }
-    get deletedBy() {
-        return this.data.deletedBy || null;
-    }
-    get repertoryCount() {
-        return this.data.repertoryCount || 0;
-    }
-    get eventCount() {
-        return this.data.eventCount || {};
-    }
-    get performanceCount() {
-        return this.eventCount.performance || 0;
-    }
-    get practiceCount() {
-        return this.eventCount.practice || 0;
-    }
-    get eventTotalCount() {
-        return this.performanceCount + this.practiceCount;
-    }
-    get communicationCount() {
-        return this.data.communicationCount || 0;
-    }
-    get country() {
-        return this.data.country || 'ES';
-    }
-    get currency() {
-        return this.data.currency || currency_1.DEFAULT_CURRENCY;
-    }
-    get currencySymbol() {
-        return (0, currency_1.getCurrencySymbol)(this.currency, this.lang);
-    }
-    get activePlayers() {
-        return Object.keys(this.players);
-    }
-    get playersList() {
-        const players = this.activePlayers.map((playerId) => ({
-            ...this.players[playerId],
-            id: playerId,
-        }));
-        return (0, orders_1.orderByInstruments)(players, 'mainInstrument', this.instrumentsIds);
-    }
-    get isActive() {
-        return this.exists && !this.deletedAt;
-    }
-    get isDeleted() {
-        return !this.exists || !(0, lodash_1.isNull)(this.deletedAt);
-    }
-    get intercomId() {
-        return this.data.intercom_id || null;
-    }
-    get partnershipId() {
-        return this.data.partnershipId || null;
-    }
-    get customerId() {
-        return this.data.customerId || null;
-    }
-    get socialNetworks() {
-        if (this.data.socialNetworks) {
-            return this.data.socialNetworks;
-        }
-        return {
-            [types_1.SocialNetwork.Facebook]: null,
-            [types_1.SocialNetwork.Twitter]: null,
-            [types_1.SocialNetwork.Instagram]: null,
-            [types_1.SocialNetwork.YouTube]: null,
-            [types_1.SocialNetwork.Web]: null,
-        };
-    }
-    getSocialNetworkUrl(id) {
-        if (id in this.socialNetworks) {
-            return this.socialNetworks[id];
-        }
-        return null;
-    }
-    get config() {
-        const config = this.data.config || {};
-        return {
-            [types_1.GroupConfigKey.IncludesMembersToEventsWhenJoined]: types_1.GroupConfigKey.IncludesMembersToEventsWhenJoined in config
-                ? config[types_1.GroupConfigKey.IncludesMembersToEventsWhenJoined]
-                : true,
-            [types_1.GroupConfigKey.AllowEditInstruments]: types_1.GroupConfigKey.AllowEditInstruments in config
-                ? config[types_1.GroupConfigKey.AllowEditInstruments]
-                : true,
-            [types_1.GroupConfigKey.ShowAttendanceToMembers]: types_1.GroupConfigKey.ShowAttendanceToMembers in config
-                ? config[types_1.GroupConfigKey.ShowAttendanceToMembers]
-                : types_1.GroupConfigShowAttendanceToMembers.None,
-            [types_1.GroupConfigKey.AllowVerifyGeoLoc]: types_1.GroupConfigKey.AllowVerifyGeoLoc in config
-                ? config[types_1.GroupConfigKey.AllowVerifyGeoLoc]
-                : false,
-        };
-    }
-    get configSites() {
-        const configSites = this.data.configSites || {};
-        return {
-            [types_1.GroupConfigSitesKey.Active]: types_1.GroupConfigSitesKey.Active in configSites
-                ? configSites[types_1.GroupConfigSitesKey.Active]
-                : false,
-            [types_1.GroupConfigSitesKey.ShowEvents]: types_1.GroupConfigSitesKey.ShowEvents in configSites
-                ? configSites[types_1.GroupConfigSitesKey.ShowEvents]
-                : false,
-            [types_1.GroupConfigSitesKey.ShowMembers]: types_1.GroupConfigSitesKey.ShowMembers in configSites
-                ? configSites[types_1.GroupConfigSitesKey.ShowMembers]
-                : false,
-        };
-    }
-    get status() {
-        return this.data.status;
-    }
-    get planId() {
-        return this.data.planId;
-    }
-    get templates() {
-        return this.data.templates || {};
-    }
-    get templatesList() {
-        return (0, objects_1.mapToArray)(this.templates);
-    }
-    get satisfactionIndex() {
-        return this.data.satisfactionIndex || { current: 0, last: 0 };
-    }
-    get metadata() {
-        return this.data.metadata || {};
-    }
-    /** @deprecated use isUpgradeRequired */
-    get isExpiredTrial() {
-        const isOutDateTrial = (0, date_fns_1.isPast)(this.trialEndAt);
-        const members = this.activePlayers.length;
-        const isAboveMembersLimitPlanFree = members > plans_1.membersPerPlan[plans_1.PlansGroup.Piano];
-        return this.status !== types_1.GroupStatus.Premium && isOutDateTrial && isAboveMembersLimitPlanFree;
-    }
-    get isOutOfMembersLimit() {
-        const members = this.activePlayers.length;
-        return members > plans_1.membersPerPlan[this.planId];
-    }
-    get isUpgradePlanRequired() {
-        const graceMembers = 4;
-        const planMembers = plans_1.membersPerPlan[this.planId] + graceMembers;
-        const members = this.activePlayers.length;
-        return members > planMembers;
-    }
-    get firstAnswerAt() {
-        return this.data.firstAnswerAt || null;
-    }
-    get repertoireTags() {
-        return this.data.repertoireTags || {};
-    }
-    get repertoireTagsList() {
-        return (0, objects_1.mapToArray)(this.repertoireTags);
-    }
-    getRepertoireTagName(id) {
-        if (!(id in this.repertoireTags))
-            return null;
-        const tag = this.repertoireTags[id];
-        return tag.default ? (0, lang_1.getTranslation)(tag.title, this.lang) : tag.title;
-    }
-    get trialEndAt() {
-        if (this.data.trialEndAt) {
-            return this.data.trialEndAt.toDate();
-        }
-        return (0, date_fns_1.addMonths)(this.createdAt.toDate(), 1);
-    }
-    get glissandooAdminUrl() {
-        return (0, glissandooAdmin_1.getGlissandooAdminEntityURL)(collections_1.CollectionNames.Group, this.id);
-    }
-    get createdOn() {
-        return this.data.createdOn;
-    }
-    get instruments() {
-        return this.data.instruments || {};
-    }
-    get instrumentsList() {
-        return (0, objects_1.orderedMapToArray)(this.instruments);
-    }
-    get instrumentsIds() {
-        return this.instrumentsList.map(({ id }) => id);
-    }
-    get customInstruments() {
-        return Object.fromEntries(Object.entries(this.instruments).filter(([key]) => key.startsWith('customInstrument-')));
-    }
-    get customInstrumentsList() {
-        return (0, objects_1.orderedMapToArray)(this.customInstruments);
-    }
-    get customInstrumentsIds() {
-        return this.customInstrumentsList.map(({ id }) => id);
-    }
-    get visitedDashboardAt() {
-        return this.data.visitedDashboardAt || null;
-    }
-    get onboardingMessages() {
-        return this.data.onboardingMessages || [];
-    }
-    get rollcallLink() {
-        return `https://glissandoo.com/rollcall/${this.id}`;
-    }
-    get subscriptionId() {
-        return this.data.subscriptionId || null;
-    }
-    get questions() {
-        return this.data.questions || {};
-    }
-    get questionsList() {
-        return Object.entries(this.questions).map(([id, answers]) => ({
-            id,
-            ...answers,
-        }));
-    }
-    getDefaultQuestion(status) {
-        return this.questionsList.find((q) => q.isDefault && q.status === status);
-    }
-    get customFields() {
-        return this.data.customFields || {};
-    }
-    get customFieldsList() {
-        return Object.entries(this.customFields)
-            .map(([id, field]) => ({
-            id,
-            ...field,
-        }))
-            .sort((a, b) => a.order - b.order);
-    }
-    get inventoryId() {
-        return this.data.inventoryId;
-    }
-    get coverURL() {
-        return this.data.coverURL || null;
-    }
-    get modules() {
-        return this.data.modules || {};
-    }
-    getModule(id) {
-        return this.modules[id] || null;
-    }
-    isModuleEnabled(id) {
-        return !!this.getModule(id)?.enabled;
-    }
-    get payoutRules() {
-        return this.data.payoutRules || [];
-    }
-}
-exports.default = Group;

package/lib/models/Group/types.d.ts

@@ -1,291 +0,0 @@
-import { DocumentReference, GeoPoint, Timestamp } from '@google-cloud/firestore';
-import { CustomInstrumentId, DefaultInstrumentId } from '../../helpers/instruments';
-import { MusicStyleType } from '../../helpers/musicStyles';
-import { PlansGroup } from '../../helpers/plans';
-import { CreatedOn } from '../../helpers/types';
-import { GroupPayoutRuleEntry } from '../../types/payoutRule';
-import { EventPlayerStatus } from '../Evento/Player/types';
-import { EventType } from '../Evento/types';
-import { PlayerBasicData } from '../Player/types';
-export declare enum GroupHistoryAction {
-    Created = "created",
-    Deleted = "deleted",
-    MemberAdd = "member_add",
-    MemberJoin = "member_join",
-    MemberLeave = "member_leave",
-    MemberRemove = "member_remove",
-    MemberInstrumentChange = "member_instrument_change",
-    MemberPermissionsChange = "member_permissions_change",
-    TemplateCreated = "template_created",
-    TemplateDeleted = "template_deleted",
-    TemplateEdited = "template_edited",
-    EditInstruments = "edit_instruments",
-    EditName = "edit_name",
-    EditLocation = "edit_location",
-    EditMusicStyle = "edit_music_style",
-    EditUsername = "edit_username",
-    EditPhoto = "edit_photo",
-    LinkFakeAccount = "link_fake_account",
-    EditFakeAccountInfo = "edit_fake_account_info"
-}
-export declare enum GroupCustomFieldType {
-    TEXT = "text",
-    NUMBER = "number",
-    DATE = "date",
-    SELECT = "select",
-    EMAIL = "email",
-    PHONE = "phone",
-    LINK = "link",
-    PARAGRAPH = "paragraph"
-}
-export interface GroupCustomFieldOption {
-    id: string;
-    value: string;
-}
-export interface GroupCustomField {
-    label: string;
-    type: GroupCustomFieldType;
-    required: boolean;
-    allowEditByMember: boolean;
-    private?: boolean;
-    placeholder: string | null;
-    options: GroupCustomFieldOption[];
-    order: number;
-    createdAt: Timestamp;
-    updatedAt: Timestamp;
-    createdBy: string;
-    updatedBy: string;
-}
-export interface AGroupCustomField extends GroupCustomField {
-    id: string;
-}
-export interface GroupOnboardingMessage {
-    type: string;
-    createdAt: Timestamp;
-    via: string;
-    to: string[];
-}
-export declare enum AdminPermissions {
-    Owner = "owner",
-    Events = "events",
-    Rollcall = "rollcall",
-    Members = "members",
-    Repertoire = "repertoire",
-    Communications = "communications",
-    Offers = "offers",
-    Billing = "billing",
-    Inventory = "inventory"
-}
-export declare enum GroupConfigKey {
-    IncludesMembersToEventsWhenJoined = "includesMembersToEventsWhenJoined",
-    AllowEditInstruments = "allowEditInstruments",
-    ShowAttendanceToMembers = "showAttendanceToMembers",
-    AllowVerifyGeoLoc = "allowVerifyGeoLoc"
-}
-export declare enum GroupConfigSitesKey {
-    Active = "active",
-    ShowMembers = "showMembers",
-    ShowEvents = "showEvents"
-}
-export declare enum GroupConfigShowAttendanceToMembers {
-    None = "none",
-    OnlyConfirmed = "onlyConfirmed",
-    OnlyToSection = "onlyToSection",
-    All = "all"
-}
-export declare enum GroupStatus {
-    Premium = "premium",
-    Trial = "trial",
-    Inactive = "inactive",
-    Deleted = "deleted"
-}
-export declare enum GroupModuleId {
-    Payout = "payout",
-    Inventory = "inventory",
-    Vacancies = "vacancies",
-    Partnership = "partnership",
-    MusicSchool = "musicSchool"
-}
-export declare enum GroupModulePlan {
-    Free = "free",
-    Paid = "paid"
-}
-export interface GroupModuleData {
-    enabled: boolean;
-    activatedAt: Timestamp | null;
-    activatedBy: string | null;
-    disabledAt: Timestamp | null;
-    disabledBy: string | null;
-    plan: GroupModulePlan;
-    /**
-     * Reserved for future Stripe integration. Not used yet.
-     */
-    subscriptionId: string | null;
-    stripeCustomerId: string | null;
-    stripeSubscriptionId: string | null;
-}
-export type GroupModules = Partial<Record<GroupModuleId, GroupModuleData>>;
-export declare enum SocialNetwork {
-    Facebook = "facebook",
-    Twitter = "twitter",
-    Instagram = "instagram",
-    YouTube = "youtube",
-    Web = "web"
-}
-export interface GroupAddressData {
-    address: string;
-    location: GeoPoint | null;
-    default: boolean;
-}
-export interface GroupTemplateData {
-    title: string;
-    playerIds: string[];
-    updatedAt: Timestamp;
-    updatedBy: string;
-    createdAt: Timestamp;
-    owner: string;
-}
-export interface AGroupTemplateData extends GroupTemplateData {
-    id: string;
-}
-export interface GroupAlgoliaData extends Omit<GroupBasicData, 'location'> {
-    objectID: string;
-    _geoloc: {
-        lat: number;
-        lng: number;
-    };
-    country: string;
-    playerCount: number;
-    repertoryCount: number;
-    eventCount: number;
-    communicationCount: number;
-    status: GroupStatus;
-    si: number;
-    siChange: 'up' | 'down' | 'equal';
-    createdOn: CreatedOn;
-    createdAt: number;
-    memberForecast: string;
-    sites: boolean;
-}
-export interface AGroupBasicData extends GroupBasicData {
-    id: string;
-}
-export interface GroupTinyData {
-    displayName: string;
-    photoURL: string;
-}
-export interface GroupBasicData extends GroupTinyData {
-    username: string;
-    musicStyle: MusicStyleType;
-    locality: string;
-    location: GeoPoint;
-}
-export declare enum GroupRepertoireTagReserved {
-    NoTag = "$noTag"
-}
-export declare enum GroupRepertoireTagDefault {
-    First = "repertoireTags.1",
-    Second = "repertoireTags.2",
-    Third = "repertoireTags.3",
-    Fourth = "repertoireTags.4",
-    Principal = "repertoireTags.principal"
-}
-export interface GroupConfig {
-    [GroupConfigKey.IncludesMembersToEventsWhenJoined]: boolean;
-    [GroupConfigKey.AllowEditInstruments]: boolean;
-    [GroupConfigKey.ShowAttendanceToMembers]: GroupConfigShowAttendanceToMembers;
-    [GroupConfigKey.AllowVerifyGeoLoc]: boolean;
-}
-export interface GroupConfigSites {
-    [GroupConfigSitesKey.Active]: boolean;
-    [GroupConfigSitesKey.ShowMembers]: boolean;
-    [GroupConfigSitesKey.ShowEvents]: boolean;
-}
-export interface GroupRepertoireTag {
-    title: string;
-    default: boolean;
-}
-export interface AGroupRepertoireTag extends GroupRepertoireTag {
-    id: string;
-}
-export interface DefaultGroupInstrument {
-    order: number;
-}
-export interface CustomGroupInstrument extends DefaultGroupInstrument {
-    icon: string;
-    name: string;
-    basedOnInstrument: DefaultInstrumentId;
-}
-export interface AGroupDefaultInstrument extends DefaultGroupInstrument {
-    id: DefaultInstrumentId;
-}
-export interface AGroupCustomInstrument extends CustomGroupInstrument {
-    id: CustomInstrumentId;
-}
-export type AGroupInstrument = AGroupDefaultInstrument | AGroupCustomInstrument;
-export interface GroupEventQuestion {
-    updatedBy: string;
-    title: string;
-    status: EventPlayerStatus;
-    isDefault: boolean;
-    answers: {
-        id: string;
-        text: string;
-    }[];
-    allowNotes: boolean;
-    multiselect: boolean;
-}
-export interface AGroupEventQuestion extends GroupEventQuestion {
-    id: string;
-}
-export type GroupInstruments = Partial<Record<DefaultInstrumentId, DefaultGroupInstrument>> & Record<CustomInstrumentId, CustomGroupInstrument>;
-export interface GroupData extends GroupBasicData {
-    playerIds: string[];
-    players: Record<string, PlayerBasicData>;
-    templates: Record<string, GroupTemplateData>;
-    administrators: string[];
-    adminPermissions: Record<string, AdminPermissions[]>;
-    addresses: GroupAddressData[];
-    activeInvitationLink: boolean;
-    invitationEmails: string[];
-    invitationLink: string | null;
-    rollcallLink: string | null;
-    shortDynamicLink: string | null;
-    intercom_id: string | null;
-    description: string | null;
-    deletedAt: Timestamp | null;
-    deletedBy: string | null;
-    socialNetworks?: Record<SocialNetwork, string | null>;
-    config: GroupConfig;
-    configSites: GroupConfigSites;
-    satisfactionIndex: {
-        current: number;
-        last: number;
-    };
-    status: GroupStatus;
-    planId: PlansGroup;
-    partnershipId: string | null;
-    customerId: string | null;
-    repertoryCount: number;
-    eventCount: Record<EventType, number>;
-    communicationCount: number;
-    country: string;
-    currency: string;
-    instruments: GroupInstruments;
-    metadata: Record<string, string>;
-    firstAnswerAt: Timestamp | null;
-    repertoireTags: Record<string, GroupRepertoireTag>;
-    trialEndAt: Timestamp | null;
-    visitedDashboardAt: Record<string, Timestamp>;
-    onboardingMessages: GroupOnboardingMessage[];
-    subscriptionId: string | null;
-    questions: Record<string, GroupEventQuestion>;
-    customFields: Record<string, GroupCustomField>;
-    inventoryId: string;
-    coverURL: string | null;
-    modules: GroupModules;
-    payoutRules: GroupPayoutRuleEntry[];
-    readonly createdOn: CreatedOn;
-    readonly owner: DocumentReference;
-    readonly createdAt: Timestamp;
-}