@glissandoo/lib 1.95.2 → 1.96.0

package/models/Partnership/Plan/index.js

@@ -3,15 +3,71 @@ 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 utils_1 = require("../../../helpers/utils");
-const basic_1 = __importDefault(require("./basic"));
-class PartnershipPlan extends basic_1.default {
-    constructor(doc) {
-        super(doc);
-    }
+const lang_1 = __importDefault(require("../../Model/lang"));
+const isNumber_1 = __importDefault(require("lodash/isNumber"));
+class PartnershipPlan extends lang_1.default {
     get partnershipId() {
         return (0, utils_1.at)(this.ref.path.split('/'), 1) || '';
     }
+    setPaymentDay(date) {
+        return this.isPaymentDayEndOfMonth
+            ? (0, date_fns_1.endOfMonth)(date)
+            : (0, date_fns_1.setDate)(date, this.schedule.paymentDay);
+    }
+    setPaymentMonth(date) {
+        return (0, isNumber_1.default)(this.schedule.paymentMonth) && this.isAnnuallySchedule
+            ? (0, date_fns_1.setMonth)(date, this.schedule.paymentMonth)
+            : date;
+    }
+    setPaymentDate(date) {
+        return this.setPaymentMonth(this.setPaymentDay(date));
+    }
+    getNextPaymentDate(base) {
+        const newDate = (0, date_fns_1.addMonths)(base, this.schedule.periodInMonths);
+        return this.setPaymentDate(newDate);
+    }
+    getFirstPaymentDate() {
+        const newDate = this.setPaymentDate(new Date());
+        return (0, date_fns_1.isPast)(newDate) ? (0, date_fns_1.addMonths)(newDate, this.isAnnuallySchedule ? 12 : 1) : newDate;
+    }
+    get name() {
+        return this.data.name;
+    }
+    get description() {
+        return this.data.description;
+    }
+    get price() {
+        return this.data.price;
+    }
+    get displayPrice() {
+        return `${this.price} €`;
+    }
+    get schedule() {
+        return this.data.schedule;
+    }
+    get paymentMethod() {
+        return this.data.paymentMethod;
+    }
+    get isAnnuallySchedule() {
+        return this.schedule.periodInMonths === 12;
+    }
+    get isPaymentDayEndOfMonth() {
+        return this.schedule.paymentDay === -1;
+    }
+    get createdAt() {
+        return this.data.createdAt;
+    }
+    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;
     }
@@ -24,14 +80,5 @@ class PartnershipPlan extends basic_1.default {
     get isActive() {
         return this.exists && !this.isDeleted;
     }
-    get subscriptionsCount() {
-        return this.data.subscriptionsCount || 0;
-    }
-    get createdAt() {
-        return this.data.createdAt;
-    }
-    get createdBy() {
-        return this.data.createdBy;
-    }
 }
 exports.default = PartnershipPlan;

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

@@ -1,25 +1,22 @@
 import { Timestamp } from '@google-cloud/firestore';
-export declare enum PlanSchedulePeriod {
-    Monthly = 1,
-    Quarterly = 3,
-    SemiAnnually = 6,
-    Annually = 12
+export declare enum PaymentMethod {
+    SEPA = "SEPA"
 }
 export interface PlanScheduleType {
-    period: PlanSchedulePeriod;
+    periodInMonths: number;
     paymentDay: number;
     paymentMonth: number | null;
 }
-export interface PartnershipPlanBasicData {
+export interface PartnershipPlanData {
     name: string;
-    readonly price: number;
     description: string;
-    readonly schedule: PlanScheduleType;
-}
-export interface PartnershipPlanData extends PartnershipPlanBasicData {
+    price: number;
+    schedule: PlanScheduleType;
+    paymentMethod: PaymentMethod;
+    createdAt: Timestamp;
+    createdBy: string;
+    editedAt: Timestamp | null;
+    editedBy: string | null;
     deletedAt: Timestamp | null;
     deletedBy: string | null;
-    subscriptionsCount: number;
-    readonly createdAt: Timestamp;
-    readonly createdBy: string;
 }

package/models/Partnership/Plan/types.js

@@ -1,10 +1,7 @@
 "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 = {}));
+exports.PaymentMethod = void 0;
+var PaymentMethod;
+(function (PaymentMethod) {
+    PaymentMethod["SEPA"] = "SEPA";
+})(PaymentMethod = exports.PaymentMethod || (exports.PaymentMethod = {}));

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

@@ -0,0 +1,12 @@
+import ModelWithLang from '../../Model/lang';
+import { SepaPaymentGroupData } from './types';
+export default class PartnerSepaPaymentGroup extends ModelWithLang<SepaPaymentGroupData> {
+    get partnershipId(): string;
+    get creditorInfo(): import("../types").PartnershipSepaCreditorInfo;
+    get filePath(): string | null;
+    get paymentsIds(): string[];
+    get createdAt(): import("../../../types/firestore").Timestamp;
+    get createdBy(): string;
+    get editedAt(): import("../../../types/firestore").Timestamp | null;
+    get editedBy(): string | null;
+}

package/models/Partnership/SepaPaymentGroup/index.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../../../helpers/utils");
+const lang_1 = __importDefault(require("../../Model/lang"));
+class PartnerSepaPaymentGroup extends lang_1.default {
+    get partnershipId() {
+        return (0, utils_1.at)(this.ref.path.split('/'), 1) || '';
+    }
+    get creditorInfo() {
+        return this.data.creditorInfo;
+    }
+    get filePath() {
+        return this.data.filePath || null;
+    }
+    get paymentsIds() {
+        return this.data.paymentsIds || [];
+    }
+    get createdAt() {
+        return this.data.createdAt;
+    }
+    get createdBy() {
+        return this.data.createdBy;
+    }
+    get editedAt() {
+        return this.data.editedAt || null;
+    }
+    get editedBy() {
+        return this.data.editedBy || null;
+    }
+}
+exports.default = PartnerSepaPaymentGroup;

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

@@ -0,0 +1,11 @@
+import { Timestamp } from '../../../types/firestore';
+import { PartnershipSepaCreditorInfo } from '../types';
+export interface SepaPaymentGroupData {
+    creditorInfo: PartnershipSepaCreditorInfo;
+    filePath: string | null;
+    createdAt: Timestamp;
+    createdBy: string;
+    paymentsIds: string[];
+    editedAt: Timestamp | null;
+    editedBy: string | null;
+}

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

@@ -1,19 +1,15 @@
-import { DocumentModel } from '../../Model';
-import PartnershipPlanBasic from '../Plan/basic';
-import { SubscriptionData, SubscriptionStatus } from './types';
-export default class PartnerSubscription extends PartnershipPlanBasic<SubscriptionData> {
-    constructor(doc: DocumentModel);
+import Model from '../../Model';
+import { SubscriptionData } from './types';
+export default class PartnerSubscription extends Model<SubscriptionData> {
     get planId(): string;
     get partnerId(): string;
     get partnershipId(): string;
-    get status(): SubscriptionStatus;
-    get lastPayment(): import("./types").LastPaymentType | null;
-    get hasPayments(): boolean;
-    get isLastPaymentAnError(): boolean;
-    get paymentDate(): FirebaseFirestore.Timestamp;
     get createdAt(): FirebaseFirestore.Timestamp;
-    get createdBy(): FirebaseFirestore.DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>;
-    get isStatusActive(): boolean;
+    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 isAllowPayment(): boolean;
 }

package/models/Partnership/Subscription/index.js

@@ -3,54 +3,41 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const payments_1 = require("../../../helpers/payments");
 const utils_1 = require("../../../helpers/utils");
-const basic_1 = __importDefault(require("../Plan/basic"));
-const types_1 = require("./types");
-class PartnerSubscription extends basic_1.default {
-    constructor(doc) {
-        super(doc);
-    }
+const Model_1 = __importDefault(require("../../Model"));
+class PartnerSubscription extends Model_1.default {
     get planId() {
         return this.data.planId;
     }
     get partnerId() {
-        return (0, utils_1.at)(this.ref.path.split('/'), 3) || '';
+        return this.data.partnerId;
     }
     get partnershipId() {
         return (0, utils_1.at)(this.ref.path.split('/'), 1) || '';
     }
-    get status() {
-        return this.data.status;
-    }
-    get lastPayment() {
-        return this.data.lastPayment;
-    }
-    get hasPayments() {
-        return this.lastPayment !== null;
-    }
-    get isLastPaymentAnError() {
-        if (!this.lastPayment)
-            return false;
-        return payments_1.paymentStatusErrors.includes(this.lastPayment.status);
-    }
-    get paymentDate() {
-        return this.data.paymentDate;
-    }
     get createdAt() {
         return this.data.createdAt;
     }
     get createdBy() {
         return this.data.createdBy;
     }
-    get isStatusActive() {
-        return this.status === types_1.SubscriptionStatus.Active;
+    get editedAt() {
+        return this.data.editedAt || null;
     }
-    get isActive() {
-        return this.exists;
+    get editedBy() {
+        return this.data.editedBy || null;
+    }
+    get deletedAt() {
+        return this.data.deletedAt || null;
+    }
+    get deletedBy() {
+        return this.data.deletedBy || null;
     }
-    get isAllowPayment() {
-        return this.isActive && this.isStatusActive;
+    get isDeleted() {
+        return this.deletedAt !== null;
+    }
+    get isActive() {
+        return this.exists && !this.data.deletedAt;
     }
 }
 exports.default = PartnerSubscription;

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

@@ -1,21 +1,12 @@
-import { DocumentReference, Timestamp } from '@google-cloud/firestore';
-import { PaymentStatus } from '../Payment/types';
-import { PartnershipPlanBasicData } from '../Plan/types';
-export declare enum SubscriptionStatus {
-    Active = "active",
-    Pause = "pause",
-    Cancel = "cancel"
-}
-export interface LastPaymentType {
-    id: string;
-    status: PaymentStatus;
-    timestamp: number;
-}
-export interface SubscriptionData extends PartnershipPlanBasicData {
-    paymentDate: Timestamp;
-    status: SubscriptionStatus;
-    lastPayment: LastPaymentType | null;
+import { Timestamp } from '@google-cloud/firestore';
+export interface SubscriptionData {
     planId: string;
-    createdBy: DocumentReference;
+    partnerId: string;
+    endDate: Timestamp | null;
     createdAt: Timestamp;
+    createdBy: string;
+    editedAt: Timestamp | null;
+    editedBy: string | null;
+    deletedAt: Timestamp | null;
+    deletedBy: string | null;
 }

package/models/Partnership/Subscription/types.js

@@ -1,9 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubscriptionStatus = void 0;
-var SubscriptionStatus;
-(function (SubscriptionStatus) {
-    SubscriptionStatus["Active"] = "active";
-    SubscriptionStatus["Pause"] = "pause";
-    SubscriptionStatus["Cancel"] = "cancel";
-})(SubscriptionStatus = exports.SubscriptionStatus || (exports.SubscriptionStatus = {}));

package/models/Partnership/basic.d.ts

@@ -1,7 +1,6 @@
-import Model, { DocumentModel } from '../Model';
+import Model from '../Model';
 import { PartnershipBasicData } from './types';
 export default class PartnershipBasic<D> extends Model<D & PartnershipBasicData> {
-    constructor(doc: DocumentModel);
     get basicInfo(): PartnershipBasicData;
     get displayName(): string;
     get photoURL(): string;

package/models/Partnership/basic.js

@@ -3,12 +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 types_1 = require("../../helpers/types");
 const Model_1 = __importDefault(require("../Model"));
 class PartnershipBasic extends Model_1.default {
-    constructor(doc) {
-        super(doc);
-    }
     get basicInfo() {
         return {
             displayName: this.displayName,
@@ -39,9 +36,7 @@ class PartnershipBasic 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/Partnership/index.d.ts

@@ -1,10 +1,8 @@
 import { AdminItemStatus } from '../../helpers/types';
-import { DocumentModel } from '../Model';
 import PartnershipBasic from './basic';
 import { PartnershipData } from './types';
 export default class Partnership extends PartnershipBasic<PartnershipData> {
-    constructor(doc: DocumentModel);
-    get description(): string;
+    get description(): string | null;
     get admins(): string[];
     get adminList(): import("../../helpers/types").AdminItem[];
     adminListByStatus(status: AdminItemStatus): import("../../helpers/types").AdminItem[];
@@ -17,5 +15,6 @@ export default class Partnership extends PartnershipBasic<PartnershipData> {
     get isActive(): boolean;
     get federationIds(): string[];
     get groupIds(): string[];
+    get sepaCreditorInfo(): import("./types").PartnershipSepaCreditorInfo | null;
     get glissandooAdminUrl(): string;
 }

package/models/Partnership/index.js

@@ -7,11 +7,8 @@ const collections_1 = require("../../helpers/collections");
 const glissandooAdmin_1 = require("../../helpers/glissandooAdmin");
 const basic_1 = __importDefault(require("./basic"));
 class Partnership extends basic_1.default {
-    constructor(doc) {
-        super(doc);
-    }
     get description() {
-        return this.data.description;
+        return this.data.description || null;
     }
     get admins() {
         return this.data.administrators || [];
@@ -49,6 +46,9 @@ class Partnership extends basic_1.default {
     get groupIds() {
         return this.data.groupIds || [];
     }
+    get sepaCreditorInfo() {
+        return this.data.sepaCreditorInfo || null;
+    }
     get glissandooAdminUrl() {
         return (0, glissandooAdmin_1.getGlissandooAdminEntityURL)(collections_1.CollectionNames.Partnership, this.id);
     }

package/models/Partnership/types.d.ts

@@ -6,6 +6,13 @@ export declare enum PartnershipRoles {
 export interface PartnershipAlgoliaData extends Pick<PartnershipData, 'displayName' | 'photoURL' | 'partnerCount'> {
     createdAt: number;
 }
+export interface PartnershipSepaCreditorInfo {
+    creditorId: string;
+    legalName: string;
+    address: string;
+    iban: string;
+    swiftbic: string;
+}
 export interface PartnershipBasicData {
     displayName: string;
     photoURL: string;
@@ -19,12 +26,13 @@ export interface PartnershipBasicData {
     website: string | null;
 }
 export interface PartnershipData extends PartnershipBasicData {
-    description: string;
+    sepaCreditorInfo: PartnershipSepaCreditorInfo | null;
+    description: string | null;
     administrators: string[];
     administratorsList: AdminItem[];
     deletedAt: Timestamp | null;
     deletedBy: string | null;
     federationIds: string[];
-    readonly createdAt: Timestamp;
-    readonly createdBy: DocumentReference;
+    createdAt: Timestamp;
+    createdBy: DocumentReference;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@glissandoo/lib",
-	"version": "1.95.2",
+	"version": "1.96.0",
 	"description": "Glissandoo library js",
 	"main": "./index.js",
 	"types": "./index.d.ts",

package/functions/partner.d.ts

@@ -1,64 +0,0 @@
-import { PartnershipPartnerData } from '../models/Partnership/Partner/types';
-import { BasicAddressData } from '../helpers/types';
-import PartnerSubscription from '../models/Partnership/Subscription';
-import { PartnershipData } from '../models/Partnership/types';
-export declare namespace PartnerFbFunctionsTypes {
-    interface CreateParams {
-        partnershipId: string;
-        name: string;
-        lastname: string;
-        email: string;
-        phone: string | null;
-        birthdate: number | null;
-        address: BasicAddressData | null;
-    }
-    type CreateResult = void;
-    type EditParams = CreateParams & {
-        partnerId: string;
-    };
-    type EditResult = void;
-    interface RemoveParams {
-        partnerId: string;
-        partnershipId: string;
-    }
-    type RemoveResult = void;
-    interface ValidateParams {
-        partnershipId: string;
-        partnerId: string;
-        name: string;
-        lastname: string;
-        email: string;
-        iban: string;
-        phone: string | null;
-        birthdate: number | null;
-        address: Required<BasicAddressData> | null;
-    }
-    type ValidateResult = void;
-    interface GetByTokenParams {
-        token: string;
-    }
-    interface GetByTokenResult {
-        partner: Pick<PartnershipPartnerData, 'name' | 'lastname' | 'email' | 'phone' | 'address'> & {
-            id: string;
-            birthdate: number | null;
-        };
-        partnership: Pick<PartnershipData, 'displayName' | 'photoURL' | 'email' | 'phone'> & {
-            id: string;
-            address: string;
-        };
-        subscriptions: Array<Pick<PartnerSubscription, 'name' | 'displayPrice' | 'schedule' | 'id'> & {
-            paymentDate: number;
-        }>;
-    }
-    interface ValidateIBANParams {
-        iban: string;
-    }
-    interface ValidateIBANResult {
-        valid: boolean;
-    }
-    interface SendVerificationParams {
-        partnerId: string;
-        partnershipId: string;
-    }
-    type SendVerificationResult = void;
-}

package/helpers/payments.d.ts

@@ -1,2 +0,0 @@
-import { PaymentStatus } from '../models/Partnership/Payment/types';
-export declare const paymentStatusErrors: PaymentStatus[];

package/helpers/payments.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.paymentStatusErrors = void 0;
-const types_1 = require("../models/Partnership/Payment/types");
-exports.paymentStatusErrors = [
-    types_1.PaymentStatus.Error,
-    types_1.PaymentStatus.Chargeback,
-    types_1.PaymentStatus.Canceled,
-];

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

@@ -1,13 +0,0 @@
-import { DocumentModel } from '../../Model';
-import PartnershipPartnerTiny from './tiny';
-import { PartnershipPartnerBasicData } from './types';
-export default class PartnershipPartnerBasic<D> extends PartnershipPartnerTiny<D & PartnershipPartnerBasicData> {
-    constructor(doc: DocumentModel);
-    get basicInfo(): PartnershipPartnerBasicData;
-    get createdAt(): FirebaseFirestore.Timestamp;
-    get createdBy(): import("../../../types/firestore").DocumentReference<import("../../../types/firestore").DocumentData>;
-    get deletedAt(): FirebaseFirestore.Timestamp | null;
-    get deletedBy(): string | null;
-    get isDeleted(): boolean;
-    get isActive(): boolean;
-}

package/models/Partnership/Partner/basic.js

@@ -1,39 +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 tiny_1 = __importDefault(require("./tiny"));
-class PartnershipPartnerBasic extends tiny_1.default {
-    constructor(doc) {
-        super(doc);
-    }
-    get basicInfo() {
-        return {
-            ...this.tinyInfo,
-            deletedAt: this.deletedAt,
-            deletedBy: this.deletedBy,
-            createdAt: this.createdAt,
-            createdBy: this.createdBy,
-        };
-    }
-    get createdAt() {
-        return this.data.createdAt;
-    }
-    get createdBy() {
-        return this.data.createdBy;
-    }
-    get deletedAt() {
-        return this.data.deletedAt || null;
-    }
-    get deletedBy() {
-        return this.data.deletedBy || null;
-    }
-    get isDeleted() {
-        return this.deletedAt !== null;
-    }
-    get isActive() {
-        return this.exists && !this.isDeleted;
-    }
-}
-exports.default = PartnershipPartnerBasic;

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

@@ -1,7 +0,0 @@
-import Model from '../../Model';
-import { PartnershipPartnerTinyData } from './types';
-export default class PartnershipPartnerTiny<D> extends Model<D & PartnershipPartnerTinyData> {
-    get tinyInfo(): PartnershipPartnerTinyData;
-    get photoURL(): string | null;
-    get displayName(): string;
-}

package/models/Partnership/Partner/tiny.js

@@ -1,21 +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 Model_1 = __importDefault(require("../../Model"));
-class PartnershipPartnerTiny extends Model_1.default {
-    get tinyInfo() {
-        return {
-            displayName: this.displayName,
-            photoURL: this.photoURL,
-        };
-    }
-    get photoURL() {
-        return this.data.photoURL || null;
-    }
-    get displayName() {
-        return this.data.displayName;
-    }
-}
-exports.default = PartnershipPartnerTiny;

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

@@ -1,16 +0,0 @@
-import Model, { DocumentModel } from '../../Model';
-import { PaymentBasicData, PaymentType } from './types';
-export default class PaymentBasic<D> extends Model<D & PaymentBasicData> {
-    constructor(doc: DocumentModel);
-    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(): FirebaseFirestore.Timestamp;
-}