@glissandoo/lib 1.0.0

package/models/Partnership/Plan/basic.js

@@ -0,0 +1,65 @@
+"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 Model_1 = __importDefault(require("../../Model"));
+const types_1 = require("./types");
+class PartnershipPlanBasic extends Model_1.default {
+    constructor(doc) {
+        super(doc);
+    }
+    get basicInfo() {
+        return {
+            name: this.name,
+            price: this.price,
+            description: this.description,
+            schedule: this.schedule,
+        };
+    }
+    setPaymentDay(date) {
+        return this.isPaymentDayEndOfMonth
+            ? date_fns_1.endOfMonth(date)
+            : date_fns_1.setDate(date, this.schedule.paymentDay);
+    }
+    setPaymentMonth(date) {
+        return lodash_1.isNumber(this.schedule.paymentMonth) && this.isAnnuallySchedule
+            ? date_fns_1.setMonth(date, this.schedule.paymentMonth)
+            : date;
+    }
+    setPaymentDate(date) {
+        return this.setPaymentMonth(this.setPaymentDay(date));
+    }
+    getNextPaymentDate(base) {
+        const newDate = date_fns_1.addMonths(base, this.schedule.period);
+        return this.setPaymentDate(newDate);
+    }
+    getFirstPaymentDate() {
+        const newDate = this.setPaymentDate(new Date());
+        return date_fns_1.isPast(newDate) ? date_fns_1.addMonths(newDate, this.isAnnuallySchedule ? 12 : 1) : newDate;
+    }
+    get name() {
+        return this.data.name;
+    }
+    get price() {
+        return this.data.price;
+    }
+    get displayPrice() {
+        return `${this.price} €`;
+    }
+    get description() {
+        return this.data.description;
+    }
+    get schedule() {
+        return this.data.schedule;
+    }
+    get isAnnuallySchedule() {
+        return this.schedule.period === types_1.PlanSchedulePeriod.Annually;
+    }
+    get isPaymentDayEndOfMonth() {
+        return this.schedule.paymentDay === -1;
+    }
+}
+exports.default = PartnershipPlanBasic;

package/models/Partnership/Plan/index.d.ts

@@ -0,0 +1,12 @@
+import { DocumentSnapshot } from '@google-cloud/firestore';
+import PartnershipPlanBasic from './basic';
+import { PartnershipPlanData } from './types';
+export default class PartnershipPlan extends PartnershipPlanBasic<PartnershipPlanData> {
+    constructor(doc: DocumentSnapshot);
+    get partnershipId(): string;
+    get deletedAt(): FirebaseFirestore.Timestamp | null;
+    get isDeleted(): boolean;
+    get isActive(): boolean;
+    get subscriptionsCount(): number;
+    get createdAt(): FirebaseFirestore.Timestamp;
+}

package/models/Partnership/Plan/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const get_1 = __importDefault(require("lodash/get"));
+const basic_1 = __importDefault(require("./basic"));
+class PartnershipPlan extends basic_1.default {
+    constructor(doc) {
+        super(doc);
+    }
+    get partnershipId() {
+        return get_1.default(this.ref, 'parent.parent.id');
+    }
+    get deletedAt() {
+        return this.data.deletedAt || null;
+    }
+    get isDeleted() {
+        return this.deletedAt !== null;
+    }
+    get isActive() {
+        return this.exists && !this.isDeleted;
+    }
+    get subscriptionsCount() {
+        return this.data.subscriptionsCount || 0;
+    }
+    get createdAt() {
+        return this.data.createdAt;
+    }
+}
+exports.default = PartnershipPlan;

package/models/Partnership/Plan/types.d.ts

@@ -0,0 +1,23 @@
+import { Timestamp } from '@google-cloud/firestore';
+export declare enum PlanSchedulePeriod {
+    Monthly = 1,
+    Quarterly = 3,
+    SemiAnnually = 6,
+    Annually = 12
+}
+export interface PlanScheduleType {
+    period: PlanSchedulePeriod;
+    paymentDay: number;
+    paymentMonth: number | null;
+}
+export interface PartnershipPlanBasicData {
+    name: string;
+    readonly price: number;
+    description: string;
+    readonly schedule: PlanScheduleType;
+}
+export interface PartnershipPlanData extends PartnershipPlanBasicData {
+    deletedAt: Timestamp | null;
+    subscriptionsCount: number;
+    readonly createdAt: Timestamp;
+}

package/models/Partnership/Plan/types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlanSchedulePeriod = void 0;
+var PlanSchedulePeriod;
+(function (PlanSchedulePeriod) {
+    PlanSchedulePeriod[PlanSchedulePeriod["Monthly"] = 1] = "Monthly";
+    PlanSchedulePeriod[PlanSchedulePeriod["Quarterly"] = 3] = "Quarterly";
+    PlanSchedulePeriod[PlanSchedulePeriod["SemiAnnually"] = 6] = "SemiAnnually";
+    PlanSchedulePeriod[PlanSchedulePeriod["Annually"] = 12] = "Annually";
+})(PlanSchedulePeriod = exports.PlanSchedulePeriod || (exports.PlanSchedulePeriod = {}));

package/models/Partnership/basic.d.ts

@@ -0,0 +1,17 @@
+import { DocumentSnapshot } from '@google-cloud/firestore';
+import Model from '../Model';
+import { PartnershipBasicData } from './types';
+export default class PartnershipBasic<D> extends Model<D & PartnershipBasicData> {
+    constructor(doc: DocumentSnapshot);
+    get basicInfo(): PartnershipBasicData;
+    get displayName(): string;
+    get photoURL(): string;
+    get email(): string;
+    get address(): import("../Partner/types").BasicAddressData;
+    get displayAddress(): string;
+    get phone(): string | null;
+    get groupIds(): string[];
+    get CIF(): string | null;
+    get partnerCount(): number;
+    get memberCount(): number;
+}

package/models/Partnership/basic.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const Model_1 = __importDefault(require("../Model"));
+class PartnershipBasic extends Model_1.default {
+    constructor(doc) {
+        super(doc);
+    }
+    get basicInfo() {
+        return {
+            displayName: this.displayName,
+            photoURL: this.photoURL,
+            email: this.email,
+            phone: this.phone,
+            address: this.address,
+            CIF: this.CIF,
+            groupIds: this.groupIds,
+            partnerCount: this.partnerCount,
+            memberCount: this.memberCount,
+        };
+    }
+    get displayName() {
+        return this.data.displayName;
+    }
+    get photoURL() {
+        return this.data.photoURL;
+    }
+    get email() {
+        return this.data.email;
+    }
+    get address() {
+        return this.data.address || {};
+    }
+    get displayAddress() {
+        const { street, city, postalCode, province, country } = this.address;
+        const fields = [street, postalCode, city, province, country];
+        return fields.filter((field) => lodash_1.isString(field)).join(', ');
+    }
+    get phone() {
+        return this.data.phone;
+    }
+    get groupIds() {
+        return this.data.groupIds || [];
+    }
+    get CIF() {
+        return this.data.CIF || null;
+    }
+    get partnerCount() {
+        return this.data.partnerCount || 0;
+    }
+    get memberCount() {
+        return this.data.memberCount || 0;
+    }
+}
+exports.default = PartnershipBasic;

package/models/Partnership/index.d.ts

@@ -0,0 +1,18 @@
+import { DocumentSnapshot } from '@google-cloud/firestore';
+import PartnershipBasic from './basic';
+import { PartnershipData, PartnershipStatus } from './types';
+export default class Partnership extends PartnershipBasic<PartnershipData> {
+    constructor(doc: DocumentSnapshot);
+    get description(): string;
+    get admins(): string[];
+    get status(): PartnershipStatus;
+    get legalContact(): import("./types").LegalContactData | null;
+    get createdAt(): FirebaseFirestore.Timestamp;
+    private get verifiedAt();
+    get isVerified(): boolean;
+    private get deletedAt();
+    get isDeleted(): boolean;
+    get isActive(): boolean;
+    get federationIds(): string[];
+    isAdmin(userId: string): boolean;
+}

package/models/Partnership/index.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const basic_1 = __importDefault(require("./basic"));
+const types_1 = require("./types");
+class Partnership extends basic_1.default {
+    constructor(doc) {
+        super(doc);
+    }
+    get description() {
+        return this.data.description;
+    }
+    get admins() {
+        return this.data.administrators || [];
+    }
+    get status() {
+        if (this.isDeleted) {
+            return types_1.PartnershipStatus.Deleted;
+        }
+        if (this.isVerified) {
+            return types_1.PartnershipStatus.Verified;
+        }
+        return types_1.PartnershipStatus.PendingVerification;
+    }
+    get legalContact() {
+        return this.data.legalContact;
+    }
+    get createdAt() {
+        return this.data.createdAt;
+    }
+    get verifiedAt() {
+        return this.data.verifiedAt || null;
+    }
+    get isVerified() {
+        return this.verifiedAt !== null;
+    }
+    get deletedAt() {
+        return this.data.deletedAt || null;
+    }
+    get isDeleted() {
+        return this.deletedAt !== null;
+    }
+    get isActive() {
+        return this.exists && !this.deletedAt;
+    }
+    get federationIds() {
+        return this.data.federationIds || [];
+    }
+    isAdmin(userId) {
+        return this.admins.includes(userId);
+    }
+}
+exports.default = Partnership;

package/models/Partnership/types.d.ts

@@ -0,0 +1,37 @@
+import { Timestamp } from '@google-cloud/firestore';
+import { BasicAddressData } from '../Partner/types';
+export declare enum PartnershipStatus {
+    Verified = "verified",
+    PendingVerification = "pendingVerification",
+    Deleted = "deleted"
+}
+export interface LegalContactData {
+    name: string;
+    lastname: string;
+    birthdate: number;
+    email: string;
+}
+export interface PartnershipAlgoliaData extends Pick<PartnershipData, 'displayName' | 'photoURL' | 'partnerCount'> {
+    status: PartnershipStatus;
+    createdAt: number;
+}
+export interface PartnershipBasicData {
+    displayName: string;
+    photoURL: string;
+    email: string;
+    phone: string | null;
+    address: BasicAddressData;
+    CIF: string | null;
+    groupIds: string[];
+    partnerCount: number;
+    memberCount: number;
+}
+export interface PartnershipData extends PartnershipBasicData {
+    description: string;
+    legalContact: LegalContactData | null;
+    administrators: string[];
+    verifiedAt: Timestamp | null;
+    deletedAt: Timestamp | null;
+    federationIds: string[];
+    readonly createdAt: Timestamp;
+}

package/models/Partnership/types.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PartnershipStatus = void 0;
+var PartnershipStatus;
+(function (PartnershipStatus) {
+    PartnershipStatus["Verified"] = "verified";
+    PartnershipStatus["PendingVerification"] = "pendingVerification";
+    PartnershipStatus["Deleted"] = "deleted";
+})(PartnershipStatus = exports.PartnershipStatus || (exports.PartnershipStatus = {}));

package/models/Payment/basic.d.ts

@@ -0,0 +1,17 @@
+import * as firestore from '@google-cloud/firestore';
+import Model from '../Model';
+import { PaymentBasicData, PaymentType } from './types';
+export default class PaymentBasic<D> extends Model<D & PaymentBasicData> {
+    constructor(doc: firestore.DocumentSnapshot);
+    get basicInfo(): PaymentBasicData;
+    get title(): string;
+    get amount(): number;
+    get displayAmount(): string;
+    get lastAction(): import("./types").PaymentHistory;
+    get lastActionStatus(): import("./types").PaymentStatus;
+    get lastActionAt(): Date;
+    get type(): PaymentType;
+    get isRecurrent(): boolean;
+    get isOneTime(): boolean;
+    get createdAt(): firestore.Timestamp;
+}

package/models/Payment/basic.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fromUnixTime_1 = __importDefault(require("date-fns/fromUnixTime"));
+const Model_1 = __importDefault(require("../Model"));
+const types_1 = require("./types");
+class PaymentBasic extends Model_1.default {
+    constructor(doc) {
+        super(doc);
+    }
+    get basicInfo() {
+        return {
+            title: this.title,
+            amount: this.amount,
+            lastAction: this.lastAction,
+            createdAt: this.createdAt,
+            type: this.type,
+        };
+    }
+    get title() {
+        return this.data.title;
+    }
+    get amount() {
+        return this.data.amount;
+    }
+    get displayAmount() {
+        return `${this.amount} €`;
+    }
+    get lastAction() {
+        return this.data.lastAction;
+    }
+    get lastActionStatus() {
+        return this.lastAction.status;
+    }
+    get lastActionAt() {
+        return fromUnixTime_1.default(this.lastAction.timestamp);
+    }
+    get type() {
+        return this.data.type;
+    }
+    get isRecurrent() {
+        return this.type === types_1.PaymentType.Recurring;
+    }
+    get isOneTime() {
+        return this.type === types_1.PaymentType.OneTime;
+    }
+    get createdAt() {
+        return this.data.createdAt;
+    }
+}
+exports.default = PaymentBasic;

package/models/Payment/index.d.ts

@@ -0,0 +1,13 @@
+import { DocumentSnapshot } from '@google-cloud/firestore';
+import PaymentBasic from './basic';
+import { PaymentData } from './types';
+export default class Payment extends PaymentBasic<PaymentData> {
+    constructor(doc: DocumentSnapshot);
+    get partnershipId(): string;
+    get partnerId(): string;
+    get subscriptionId(): string | null;
+    get onetimeId(): string | null;
+    get transactionId(): string;
+    get history(): import("./types").PaymentHistory[];
+    get historyOrdered(): import("./types").PaymentHistory[];
+}

package/models/Payment/index.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const basic_1 = __importDefault(require("./basic"));
+class Payment extends basic_1.default {
+    constructor(doc) {
+        super(doc);
+    }
+    get partnershipId() {
+        return this.data.partnershipId;
+    }
+    get partnerId() {
+        return this.data.partnerId;
+    }
+    get subscriptionId() {
+        return this.data.subscriptionId;
+    }
+    get onetimeId() {
+        return this.data.onetimeId;
+    }
+    get transactionId() {
+        return this.data.transactionId;
+    }
+    get history() {
+        return this.data.history || [];
+    }
+    get historyOrdered() {
+        return this.history.sort((a, b) => (a.timestamp < b.timestamp ? 1 : -1));
+    }
+}
+exports.default = Payment;

package/models/Payment/types.d.ts

@@ -0,0 +1,32 @@
+import { Timestamp } from '@google-cloud/firestore';
+export declare enum PaymentType {
+    Recurring = "recurring",
+    OneTime = "one-time"
+}
+export declare enum PaymentStatus {
+    Pending = 0,
+    Waiting = 1,
+    Success = 2,
+    Error = 3,
+    Chargeback = 4,
+    Canceled = 5
+}
+export interface PaymentHistory {
+    readonly status: PaymentStatus;
+    readonly timestamp: number;
+}
+export interface PaymentBasicData {
+    readonly title: string;
+    readonly amount: number;
+    lastAction: PaymentHistory;
+    readonly createdAt: Timestamp;
+    readonly type: PaymentType;
+}
+export interface PaymentData extends PaymentBasicData {
+    readonly partnershipId: string;
+    readonly partnerId: string;
+    readonly subscriptionId: string | null;
+    readonly onetimeId: string | null;
+    readonly transactionId: string;
+    history: PaymentHistory[];
+}

package/models/Payment/types.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentStatus = exports.PaymentType = void 0;
+var PaymentType;
+(function (PaymentType) {
+    PaymentType["Recurring"] = "recurring";
+    PaymentType["OneTime"] = "one-time";
+})(PaymentType = exports.PaymentType || (exports.PaymentType = {}));
+var PaymentStatus;
+(function (PaymentStatus) {
+    PaymentStatus[PaymentStatus["Pending"] = 0] = "Pending";
+    PaymentStatus[PaymentStatus["Waiting"] = 1] = "Waiting";
+    PaymentStatus[PaymentStatus["Success"] = 2] = "Success";
+    PaymentStatus[PaymentStatus["Error"] = 3] = "Error";
+    PaymentStatus[PaymentStatus["Chargeback"] = 4] = "Chargeback";
+    PaymentStatus[PaymentStatus["Canceled"] = 5] = "Canceled";
+})(PaymentStatus = exports.PaymentStatus || (exports.PaymentStatus = {}));

package/models/Player/basic.d.ts

@@ -0,0 +1,10 @@
+import * as firestore from '@google-cloud/firestore';
+import { LanguagesTypes } from '../../lang';
+import UserBasic from '../User/basic';
+import { PlayerBasicData } from './types';
+export default class PlayerBasic<D> extends UserBasic<PlayerBasicData & D> {
+    constructor(doc: firestore.DocumentSnapshot, lang: LanguagesTypes);
+    get basicInfo(): PlayerBasicData;
+    get mainInstrument(): import("../../helpers/instruments").InstrumentId;
+    get instrument(): string;
+}

package/models/Player/basic.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lang_1 = require("../../lang");
+const basic_1 = __importDefault(require("../User/basic"));
+class PlayerBasic extends basic_1.default {
+    constructor(doc, lang) {
+        super(doc, lang);
+    }
+    get basicInfo() {
+        return {
+            displayName: this.displayName,
+            photoURL: this.photoURL,
+            username: this.username,
+            mainInstrument: this.mainInstrument,
+        };
+    }
+    get mainInstrument() {
+        return this.data.mainInstrument;
+    }
+    get instrument() {
+        return lang_1.getTranslation(`instruments.${this.mainInstrument}`, this.lang);
+    }
+}
+exports.default = PlayerBasic;

package/models/Player/types.d.ts

@@ -0,0 +1,8 @@
+import { InstrumentId } from '../../helpers/instruments';
+import { UserBasicData } from '../User/types';
+export interface APlayerBasicData extends PlayerBasicData {
+    id: string;
+}
+export interface PlayerBasicData extends UserBasicData {
+    mainInstrument: InstrumentId;
+}

package/models/Player/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/models/Repertory/basic.d.ts

@@ -0,0 +1,11 @@
+import * as firestore from '@google-cloud/firestore';
+import Model from '../Model';
+import { ThemeBasicData } from './types';
+export default class Theme<D> extends Model<D & ThemeBasicData> {
+    constructor(doc: firestore.DocumentSnapshot);
+    get basicInfo(): ThemeBasicData;
+    get title(): string;
+    get compositor(): string | null;
+    get tags(): string[];
+    get media(): import("./types").ThemeMediaType | null;
+}

package/models/Repertory/basic.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Model_1 = __importDefault(require("../Model"));
+class Theme extends Model_1.default {
+    constructor(doc) {
+        super(doc);
+    }
+    get basicInfo() {
+        return {
+            title: this.title,
+            compositor: this.compositor,
+            media: this.media,
+            tags: this.tags,
+        };
+    }
+    get title() {
+        return this.data.title;
+    }
+    get compositor() {
+        return this.data.compositor || null;
+    }
+    get tags() {
+        return this.data.tags || [];
+    }
+    get media() {
+        return this.data.media || null;
+    }
+}
+exports.default = Theme;

package/models/Repertory/types.d.ts

@@ -0,0 +1,21 @@
+export declare type ThumbnailSizesTypes = 'default' | 'medium' | 'high';
+export interface ThumbnailType {
+    url: string;
+    width: string;
+    height: string;
+}
+export interface ThemeMediaType {
+    id: string;
+    title: string;
+    description: string;
+    thumbnails: Record<ThumbnailSizesTypes, ThumbnailType>;
+}
+export interface ThemeBasicData {
+    title: string;
+    compositor: string | null;
+    tags: string[];
+    media: ThemeMediaType | null;
+}
+export interface AThemeBasicData extends ThemeBasicData {
+    id: string;
+}

package/models/Repertory/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/models/User/Group/index.d.ts

@@ -0,0 +1,15 @@
+import { DocumentSnapshot } from '@google-cloud/firestore';
+import { LanguagesTypes } from '../../../lang';
+import GroupBasic from '../../Group/basic';
+import { GroupPlayerRole } from '../../Group/Player/types';
+import { UserGroupData } from './types';
+export default class UserGroup extends GroupBasic<UserGroupData> {
+    constructor(doc: DocumentSnapshot, lang?: LanguagesTypes);
+    get groupId(): string;
+    get mainInstrument(): import("../../../helpers/instruments").InstrumentId;
+    get instrument(): string;
+    get instruments(): import("../../../helpers/instruments").InstrumentId[];
+    get role(): GroupPlayerRole;
+    get isAdmin(): boolean;
+    get joinedAt(): FirebaseFirestore.Timestamp;
+}