@glissandoo/lib 1.95.2 → 1.97.0

package/functions/partnership.d.ts

@@ -1,35 +1,44 @@
 import { BasicAddressData } from '../helpers/types';
+import { PartnershipSepaCreditorInfo } from '../models/Partnership/types';
 export declare namespace PartnershipFbFunctionsTypes {
-    interface PublishParams {
-        groupId: string;
+    interface BaseCreateParams {
         displayName: string;
         CIF: string;
         email: string;
         phone: string | null;
         address: BasicAddressData;
+        sepaCreditorInfo: PartnershipSepaCreditorInfo | null;
+    }
+    export interface PublishParams extends BaseCreateParams {
+        groupId: string;
     }
-    type PublishResult = void;
-    interface CreateParams {
+    export type PublishResult = void;
+    export interface CreateParams extends BaseCreateParams {
         partnershipId: string;
-        displayName: string;
     }
-    type CreateResult = void;
-    interface EditParams {
+    export type CreateResult = void;
+    export interface EditParams extends Partial<BaseCreateParams> {
         partnershipId: string;
+        displayName: string;
+        CIF: string;
+        email: string;
+        phone: string | null;
+        address: BasicAddressData;
     }
-    type EditResult = void;
-    interface RemoveParams {
+    export type EditResult = void;
+    export interface RemoveParams {
         partnershipId: string;
     }
-    type RemoveResult = void;
-    interface AddConfirmedAdminParams {
+    export type RemoveResult = void;
+    export interface AddConfirmedAdminParams {
         partnershipId: string;
-        userId: string;
+        email: string;
     }
-    type AddConfirmedAdminResult = void;
-    interface RemoveAdminParams {
+    export type AddConfirmedAdminResult = void;
+    export interface RemoveAdminParams {
         partnershipId: string;
         email: string;
     }
-    type RemoveAdminResult = void;
+    export type RemoveAdminResult = void;
+    export {};
 }

package/functions/partnershipPartner.d.ts

@@ -1,9 +1,10 @@
-import { CreatedOn } from '../helpers/types';
-import { BasicAddressData } from '../helpers/types';
+import { BasicAddressData, CreatedOn } from '../helpers/types';
+import { PartnershipPartnerSepaMandate } from '../models/Partnership/Partner/types';
 export declare namespace PartnershipPartnerFbFunctionsTypes {
     interface CreateParams {
         partnershipId: string;
         partnerId: string;
+        NIF: string | null;
         name: string;
         lastname: string;
         email: string;
@@ -11,6 +12,7 @@ export declare namespace PartnershipPartnerFbFunctionsTypes {
         birthdate: number | null;
         address: BasicAddressData | null;
         createdOn: CreatedOn;
+        sepaMandate: Omit<PartnershipPartnerSepaMandate, 'mandateId'> | null;
     }
     type CreateResult = void;
     type EditParams = Omit<CreateParams, 'createdOn'>;

package/helpers/collections.d.ts

@@ -21,11 +21,11 @@ export declare enum CollectionNames {
     GroupStageTemplates = "stageTemplates",
     Metrics = "metrics",
     Partnership = "partnership",
-    PartnershipPartners = "partnershipPartner",
-    PartnershipGroups = "partnershipGroup",
-    PartnershipSubscriptions = "partnershipSubscription",
-    PartnershipPayments = "partnershipPayment",
-    PartnershipPlans = "partnershipPlan",
+    PartnershipPartner = "partnershipPartner",
+    PartnershipGroup = "partnershipGroup",
+    PartnershipSubscription = "partnershipSubscription",
+    PartnershipPayment = "partnershipPayment",
+    PartnershipPlan = "partnershipPlan",
     Federation = "federation",
     FederationPartnerships = "partnerships",
     Offer = "offer",

package/helpers/collections.js

@@ -25,11 +25,11 @@ var CollectionNames;
     CollectionNames["GroupStageTemplates"] = "stageTemplates";
     CollectionNames["Metrics"] = "metrics";
     CollectionNames["Partnership"] = "partnership";
-    CollectionNames["PartnershipPartners"] = "partnershipPartner";
-    CollectionNames["PartnershipGroups"] = "partnershipGroup";
-    CollectionNames["PartnershipSubscriptions"] = "partnershipSubscription";
-    CollectionNames["PartnershipPayments"] = "partnershipPayment";
-    CollectionNames["PartnershipPlans"] = "partnershipPlan";
+    CollectionNames["PartnershipPartner"] = "partnershipPartner";
+    CollectionNames["PartnershipGroup"] = "partnershipGroup";
+    CollectionNames["PartnershipSubscription"] = "partnershipSubscription";
+    CollectionNames["PartnershipPayment"] = "partnershipPayment";
+    CollectionNames["PartnershipPlan"] = "partnershipPlan";
     CollectionNames["Federation"] = "federation";
     CollectionNames["FederationPartnerships"] = "partnerships";
     CollectionNames["Offer"] = "offer";

package/helpers/errors.d.ts

@@ -62,7 +62,8 @@ export declare enum HttpsErrorMessages {
     PlayersWithCustomInstrumentsToBeDeleted = "error.group.playersWithCustomInstrumentsToBeDeleted",
     ThemesWithCustomInstrumentsToBeDeleted = "error.group.themesWithCustomInstrumentsToBeDeleted",
     CustomerHasGroups = "error.customer.hasGroups",
-    GroupPlayerEditInstumentsNotAllowed = "error.groupPlayer.editInstrumentsNotAllowed"
+    GroupPlayerEditInstumentsNotAllowed = "error.groupPlayer.editInstrumentsNotAllowed",
+    InvalidEmail = "error.email.noValid"
 }
 export interface HttpsErrorDetails extends Record<HttpsErrorMessages, unknown> {
     [HttpsErrorMessages.ThemesWithCustomInstrumentsToBeDeleted]: {

package/helpers/errors.js

@@ -64,4 +64,5 @@ var HttpsErrorMessages;
     HttpsErrorMessages["ThemesWithCustomInstrumentsToBeDeleted"] = "error.group.themesWithCustomInstrumentsToBeDeleted";
     HttpsErrorMessages["CustomerHasGroups"] = "error.customer.hasGroups";
     HttpsErrorMessages["GroupPlayerEditInstumentsNotAllowed"] = "error.groupPlayer.editInstrumentsNotAllowed";
+    HttpsErrorMessages["InvalidEmail"] = "error.email.noValid";
 })(HttpsErrorMessages = exports.HttpsErrorMessages || (exports.HttpsErrorMessages = {}));

package/helpers/types.d.ts

@@ -22,3 +22,4 @@ export interface BasicAddressData {
     province?: string;
     country?: string;
 }
+export declare function displayBasicAddress<T extends BasicAddressData | null | undefined>(address: T): T extends BasicAddressData ? string : null;

package/helpers/types.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreatedOn = exports.AdminItemStatus = void 0;
+exports.displayBasicAddress = exports.CreatedOn = exports.AdminItemStatus = void 0;
+const isString_1 = __importDefault(require("lodash/isString"));
 var AdminItemStatus;
 (function (AdminItemStatus) {
     AdminItemStatus["Pending"] = "pending";
@@ -13,3 +17,13 @@ var CreatedOn;
     CreatedOn["App"] = "app";
     CreatedOn["Dashboard"] = "dashboard";
 })(CreatedOn = exports.CreatedOn || (exports.CreatedOn = {}));
+function displayBasicAddress(address) {
+    if (address === null || address === undefined)
+        return null;
+    const { street, city, postalCode, province, country } = address;
+    const fields = [street, postalCode, city, province, country];
+    return fields
+        .filter((field) => (0, isString_1.default)(field) && field.trim() !== '')
+        .join(', ');
+}
+exports.displayBasicAddress = displayBasicAddress;

package/models/Customer/basic.js

@@ -3,7 +3,7 @@ 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 types_1 = require("../../helpers/types");
 const Model_1 = __importDefault(require("../Model"));
 class CustomerBasic extends Model_1.default {
     constructor(doc) {
@@ -29,9 +29,7 @@ class CustomerBasic extends Model_1.default {
         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) => (0, lodash_1.isString)(field)).join(', ');
+        return (0, types_1.displayBasicAddress)(this.address);
     }
     get phone() {
         return this.data.phone;

package/models/Federation/index.js

@@ -3,9 +3,9 @@ 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 collections_1 = require("../../helpers/collections");
 const glissandooAdmin_1 = require("../../helpers/glissandooAdmin");
+const types_1 = require("../../helpers/types");
 const Model_1 = __importDefault(require("../Model"));
 class Federation extends Model_1.default {
     constructor(doc) {
@@ -45,9 +45,7 @@ class Federation extends Model_1.default {
         return this.data.address || null;
     }
     get displayAddress() {
-        const { street, city, postalCode, province, country } = this.address || {};
-        const fields = [street, postalCode, city, province, country];
-        return fields.filter((field) => (0, lodash_1.isString)(field) && field.trim() !== '').join(', ');
+        return (0, types_1.displayBasicAddress)(this.address || {});
     }
     get partnershipConnectedIds() {
         return this.data.partnershipConnectedIds || [];

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

@@ -1,19 +1,32 @@
-import PartnershipPartnerBasic from './basic';
+import ModelWithLang from '../../Model/lang';
 import { PartnershipPartnerData } from './types';
-export default class PartnershipPartner extends PartnershipPartnerBasic<PartnershipPartnerData> {
+export default class PartnershipPartner extends ModelWithLang<PartnershipPartnerData> {
     get name(): string;
     get lastname(): string;
+    get photoURL(): string | null;
+    get displayName(): string;
+    get NIF(): string | null;
     get email(): string;
     get phone(): string | null;
     get birthdate(): FirebaseFirestore.Timestamp | null;
-    get partnershipId(): string;
+    get partnershipId(): string[];
+    get sepaMandate(): {
+        holderDisplayAddress: string;
+        mandateId: string;
+        iban: string;
+        holderFullName: string;
+        holderAddress: import("../../../helpers/types").BasicAddressData;
+        swiftbic: string | null;
+    } | null;
     get address(): import("../../../helpers/types").BasicAddressData | null;
-    get iban(): string | null;
     get displayAddress(): string | null;
     get createdAt(): FirebaseFirestore.Timestamp;
     get createdBy(): import("../../../types/firestore").DocumentReference<import("../../../types/firestore").DocumentData>;
+    get editedAt(): FirebaseFirestore.Timestamp | null;
+    get editedBy(): string | null;
     get deletedAt(): FirebaseFirestore.Timestamp | null;
     get deletedBy(): string | null;
     get isDeleted(): boolean;
     get isActive(): boolean;
+    get userId(): string | null;
 }

package/models/Partnership/Partner/index.js

@@ -3,16 +3,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const isString_1 = __importDefault(require("lodash/isString"));
-const utils_1 = require("../../../helpers/utils");
-const basic_1 = __importDefault(require("./basic"));
-class PartnershipPartner extends basic_1.default {
+const lodash_1 = require("lodash");
+const types_1 = require("../../../helpers/types");
+const lang_1 = __importDefault(require("../../Model/lang"));
+class PartnershipPartner extends lang_1.default {
     get name() {
         return this.data.name;
     }
     get lastname() {
         return this.data.lastname;
     }
+    get photoURL() {
+        return this.data.photoURL || null;
+    }
+    get displayName() {
+        return this.data.displayName;
+    }
+    get NIF() {
+        return this.data.NIF;
+    }
     get email() {
         return this.data.email;
     }
@@ -23,20 +32,21 @@ class PartnershipPartner extends basic_1.default {
         return this.data.birthdate;
     }
     get partnershipId() {
-        return (0, utils_1.at)(this.ref.path.split('/'), 1) || '';
+        return (0, lodash_1.at)(this.ref.path.split('/'), 1) || '';
+    }
+    get sepaMandate() {
+        if (!this.data.sepaMandate)
+            return null;
+        return {
+            ...this.data.sepaMandate,
+            holderDisplayAddress: (0, types_1.displayBasicAddress)(this.data.sepaMandate.holderAddress),
+        };
     }
     get address() {
         return this.data.address;
     }
-    get iban() {
-        return this.data.iban;
-    }
     get displayAddress() {
-        if (!this.address)
-            return null;
-        const { street, city, postalCode, province, country } = this.address;
-        const fields = [street, postalCode, city, province, country];
-        return fields.filter((field) => (0, isString_1.default)(field)).join(', ');
+        return (0, types_1.displayBasicAddress)(this.address);
     }
     get createdAt() {
         return this.data.createdAt;
@@ -44,6 +54,12 @@ class PartnershipPartner extends basic_1.default {
     get createdBy() {
         return this.data.createdBy;
     }
+    get editedAt() {
+        return this.data.editedAt || null;
+    }
+    get editedBy() {
+        return this.data.editedBy || null;
+    }
     get deletedAt() {
         return this.data.deletedAt || null;
     }
@@ -56,5 +72,8 @@ class PartnershipPartner extends basic_1.default {
     get isActive() {
         return this.exists && !this.isDeleted;
     }
+    get userId() {
+        return this.data.userId || null;
+    }
 }
 exports.default = PartnershipPartner;

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

@@ -1,23 +1,30 @@
 import { Timestamp } from '@google-cloud/firestore';
 import { BasicAddressData } from '../../../helpers/types';
 import { DocumentReference } from '../../../types/firestore';
-export interface PartnershipPartnerTinyData {
-    photoURL: string | null;
-    displayName: string;
-}
-export interface PartnershipPartnerBasicData extends PartnershipPartnerTinyData {
-    readonly createdAt: Timestamp;
-    readonly createdBy: DocumentReference;
-    deletedAt: Timestamp | null;
-    deletedBy: string | null;
+export interface PartnershipPartnerSepaMandate {
+    mandateId: string;
+    iban: string;
+    holderFullName: string;
+    holderAddress: BasicAddressData;
+    swiftbic: string | null;
 }
-export interface PartnershipPartnerData extends PartnershipPartnerBasicData {
+export interface PartnershipPartnerData {
     name: string;
     lastname: string;
+    photoURL: string | null;
+    displayName: string;
     email: string;
     address: BasicAddressData | null;
     phone: string | null;
     birthdate: Timestamp | null;
-    iban: string | null;
+    NIF: string | null;
+    sepaMandate: PartnershipPartnerSepaMandate | null;
     groupIds: string[];
+    createdAt: Timestamp;
+    createdBy: DocumentReference;
+    editedAt: Timestamp | null;
+    editedBy: string | null;
+    deletedAt: Timestamp | null;
+    deletedBy: string | null;
+    userId: string | null;
 }

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

@@ -1,13 +1,20 @@
-import { DocumentModel } from '../../Model';
-import PaymentBasic from './basic';
-import { PaymentData } from './types';
-export default class Payment extends PaymentBasic<PaymentData> {
-    constructor(doc: DocumentModel);
-    get partnershipId(): string;
-    get partnerId(): string;
+import ModelWithLang from '../../Model/lang';
+import { PaymentData, PaymentType } from './types';
+export default class Payment extends ModelWithLang<PaymentData> {
+    get partnershipId(): string | null;
+    get title(): string;
+    get amount(): number;
+    get displayAmount(): string;
+    get type(): PaymentType;
+    get isRecurrent(): boolean;
+    get isOneTime(): boolean;
     get subscriptionId(): string | null;
-    get onetimeId(): string | null;
-    get transactionId(): string;
-    get history(): import("./types").PaymentHistory[];
-    get historyOrdered(): import("./types").PaymentHistory[];
+    get partnerId(): string | null;
+    get paymentMethod(): import("../Plan/types").PaymentMethod | null;
+    get history(): import("./types").PaymentHistoryItem[];
+    get historyOrdered(): import("./types").PaymentHistoryItem[];
+    get createdAt(): FirebaseFirestore.Timestamp;
+    get createdBy(): string | null;
+    get editedAt(): FirebaseFirestore.Timestamp | null;
+    get editedBy(): string | null;
 }

package/models/Partnership/Payment/index.js

@@ -3,31 +3,57 @@ 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);
-    }
+const utils_1 = require("../../../helpers/utils");
+const lang_1 = __importDefault(require("../../Model/lang"));
+const types_1 = require("./types");
+class Payment extends lang_1.default {
     get partnershipId() {
-        return this.data.partnershipId;
+        return (0, utils_1.at)(this.ref.path.split('/'), 1);
     }
-    get partnerId() {
-        return this.data.partnerId;
+    get title() {
+        return this.data.title;
+    }
+    get amount() {
+        return this.data.amount;
+    }
+    get displayAmount() {
+        return `${this.amount} €`;
+    }
+    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 subscriptionId() {
         return this.data.subscriptionId;
     }
-    get onetimeId() {
-        return this.data.onetimeId;
+    get partnerId() {
+        return this.data.partnerId;
     }
-    get transactionId() {
-        return this.data.transactionId;
+    get paymentMethod() {
+        return this.data.paymentMethod;
     }
     get history() {
         return this.data.history || [];
     }
     get historyOrdered() {
-        return this.history.sort((a, b) => (a.timestamp < b.timestamp ? 1 : -1));
+        return this.history.sort((a, b) => a.changedAt.toMillis() < b.changedAt.toMillis() ? 1 : -1);
+    }
+    get createdAt() {
+        return this.data.createdAt;
+    }
+    get createdBy() {
+        return this.data.createdBy || null;
+    }
+    get editedAt() {
+        return this.data.editedAt || null;
+    }
+    get editedBy() {
+        return this.data.editedBy || null;
     }
 }
 exports.default = Payment;

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

@@ -1,32 +1,29 @@
 import { Timestamp } from '@google-cloud/firestore';
+import { PaymentMethod } from '../Plan/types';
 export declare enum PaymentType {
-    Recurring = "recurring",
-    OneTime = "one-time"
+    Recurring = "RCUR",
+    OneTime = "OOFF"
 }
 export declare enum PaymentStatus {
-    Pending = 0,
-    Waiting = 1,
-    Success = 2,
-    Error = 3,
-    Chargeback = 4,
-    Canceled = 5
+    Pending = "pending",
+    Charged = "charged",
+    Canceled = "canceled"
 }
-export interface PaymentHistory {
-    readonly status: PaymentStatus;
-    readonly timestamp: number;
+export interface PaymentHistoryItem {
+    status: PaymentStatus;
+    changedAt: Timestamp;
+    changedBy: string;
 }
-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[];
+export interface PaymentData {
+    title: string;
+    amount: number;
+    type: PaymentType;
+    subscriptionId: string | null;
+    partnerId: string | null;
+    paymentMethod: PaymentMethod | null;
+    history: PaymentHistoryItem[];
+    createdAt: Timestamp;
+    createdBy: string | null;
+    editedAt: Timestamp | null;
+    editedBy: string | null;
 }

package/models/Partnership/Payment/types.js

@@ -3,15 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PaymentStatus = exports.PaymentType = void 0;
 var PaymentType;
 (function (PaymentType) {
-    PaymentType["Recurring"] = "recurring";
-    PaymentType["OneTime"] = "one-time";
+    PaymentType["Recurring"] = "RCUR";
+    PaymentType["OneTime"] = "OOFF";
 })(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["Pending"] = "pending";
+    PaymentStatus["Charged"] = "charged";
+    PaymentStatus["Canceled"] = "canceled";
 })(PaymentStatus = exports.PaymentStatus || (exports.PaymentStatus = {}));

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

@@ -1,14 +1,26 @@
-import { DocumentModel } from '../../Model';
-import PartnershipPlanBasic from './basic';
+import ModelWithLang from '../../Model/lang';
 import { PartnershipPlanData } from './types';
-export default class PartnershipPlan extends PartnershipPlanBasic<PartnershipPlanData> {
-    constructor(doc: DocumentModel);
+export default class PartnershipPlan extends ModelWithLang<PartnershipPlanData> {
     get partnershipId(): string;
+    private setPaymentDay;
+    private setPaymentMonth;
+    private setPaymentDate;
+    getNextPaymentDate(base: Date): Date;
+    getFirstPaymentDate(): Date;
+    get name(): string;
+    get description(): string;
+    get price(): number;
+    get displayPrice(): string;
+    get schedule(): import("./types").PlanScheduleType;
+    get paymentMethod(): import("./types").PaymentMethod;
+    get isAnnuallySchedule(): boolean;
+    get isPaymentDayEndOfMonth(): boolean;
+    get createdAt(): FirebaseFirestore.Timestamp;
+    get createdBy(): string;
+    get editedAt(): FirebaseFirestore.Timestamp | null;
+    get editedBy(): string | null;
     get deletedAt(): FirebaseFirestore.Timestamp | null;
     get deletedBy(): string | null;
     get isDeleted(): boolean;
     get isActive(): boolean;
-    get subscriptionsCount(): number;
-    get createdAt(): FirebaseFirestore.Timestamp;
-    get createdBy(): string;
 }