taxtank-core 0.5.1 → 0.6.0

package/lib/models/property/property-equity-chart-data.d.ts

@@ -1,62 +1,62 @@
-import { PropertyEquityChartItem } from './property-equity-chart-item';
-import { PropertyCollection } from '../../collections/property.collection';
-import { BankAccountCollection } from '../../collections/bank-account.collection';
-import { LoanCollection } from '../../collections/loan.collection';
-import { PropertyEquityChartTypeEnum } from './property-equity-chart-type.enum';
-import { Property } from './property';
-/**
- * class contain actual and forecasted market values and loan balances for passed properties
- * X axis - years from the first actual data year to the last forecasted year
- * Y axis - amounts of market values, loan balances
- * Also on hover appear equity positions point
- */
-export declare class PropertyEquityChartData {
-    private registerDate;
-    list: PropertyEquityChartItem[];
-    currentYear: number;
-    private properties;
-    private bankAccounts;
-    private loans;
-    constructor(properties: PropertyCollection, bankAccounts: BankAccountCollection, loans: LoanCollection, registerDate: Date);
-    /**
-     * get items list in chart series format
-     * @param type
-     */
-    getChartSeries(type: PropertyEquityChartTypeEnum): number[][];
-    /**
-     * get prepared chart data
-     */
-    getChartData(): object[];
-    /**
-     * create empty equity position item for each year in collection
-     */
-    private initItems;
-    /**
-     * collect equity position items with past values from properties forecasts
-     */
-    private buildHistoryItems;
-    /**
-     * set actual year's real data
-     * @private
-     */
-    private buildActualItem;
-    /**
-     * collect equity position items with forecasted (future) calculated values
-     */
-    private buildForecastedItems;
-    /**
-     * Get property loan balance by financial year
-     * @param property Property instance for filter
-     * @param year Financial year number
-     * @param bankAccounts List of bank accounts
-     * @param loans List of loans
-     * @private
-     */
-    private getLoanBalanceByYear;
-    getMarketValueForPropertyByYear(property: Property, year: number): number;
-    getLoanBalanceForPropertyByYear(property: Property, year: number): number;
-    /**
-     * Check if loan balance is 0 and set it as null (to not to draw point on the chart)
-     */
-    private checkZeroLoanBalance;
-}
+import { PropertyEquityChartItem } from './property-equity-chart-item';
+import { PropertyCollection } from '../../collections/property/property.collection';
+import { BankAccountCollection } from '../../collections/bank-account.collection';
+import { LoanCollection } from '../../collections/loan.collection';
+import { PropertyEquityChartTypeEnum } from './property-equity-chart-type.enum';
+import { Property } from './property';
+/**
+ * class contain actual and forecasted market values and loan balances for passed properties
+ * X axis - years from the first actual data year to the last forecasted year
+ * Y axis - amounts of market values, loan balances
+ * Also on hover appear equity positions point
+ */
+export declare class PropertyEquityChartData {
+    private registerDate;
+    list: PropertyEquityChartItem[];
+    currentYear: number;
+    private properties;
+    private bankAccounts;
+    private loans;
+    constructor(properties: PropertyCollection, bankAccounts: BankAccountCollection, loans: LoanCollection, registerDate: Date);
+    /**
+     * get items list in chart series format
+     * @param type
+     */
+    getChartSeries(type: PropertyEquityChartTypeEnum): number[][];
+    /**
+     * get prepared chart data
+     */
+    getChartData(): object[];
+    /**
+     * create empty equity position item for each year in collection
+     */
+    private initItems;
+    /**
+     * collect equity position items with past values from properties forecasts
+     */
+    private buildHistoryItems;
+    /**
+     * set actual year's real data
+     * @private
+     */
+    private buildActualItem;
+    /**
+     * collect equity position items with forecasted (future) calculated values
+     */
+    private buildForecastedItems;
+    /**
+     * Get property loan balance by financial year
+     * @param property Property instance for filter
+     * @param year Financial year number
+     * @param bankAccounts List of bank accounts
+     * @param loans List of loans
+     * @private
+     */
+    private getLoanBalanceByYear;
+    getMarketValueForPropertyByYear(property: Property, year: number): number;
+    getLoanBalanceForPropertyByYear(property: Property, year: number): number;
+    /**
+     * Check if loan balance is 0 and set it as null (to not to draw point on the chart)
+     */
+    private checkZeroLoanBalance;
+}

package/lib/models/property/property-equity-chart-item.d.ts

@@ -1,19 +1,19 @@
-import { PropertyEquityChartTypeEnum } from './property-equity-chart-type.enum';
-/**
- * class contains equity information for passed financial year
- */
-export declare class PropertyEquityChartItem {
-    year: number;
-    marketValue: number;
-    loanBalance: number;
-    constructor(year: number, marketValue?: number, loanBalance?: number);
-    /**
-     * calculate equity position
-     */
-    get equityPosition(): number;
-    /**
-     * return this equity position instance as chart serie
-     * @param type
-     */
-    getSerie(type: PropertyEquityChartTypeEnum): number[];
-}
+import { PropertyEquityChartTypeEnum } from './property-equity-chart-type.enum';
+/**
+ * class contains equity information for passed financial year
+ */
+export declare class PropertyEquityChartItem {
+    year: number;
+    marketValue: number;
+    loanBalance: number;
+    constructor(year: number, marketValue?: number, loanBalance?: number);
+    /**
+     * calculate equity position
+     */
+    get equityPosition(): number;
+    /**
+     * return this equity position instance as chart serie
+     * @param type
+     */
+    getSerie(type: PropertyEquityChartTypeEnum): number[];
+}

package/lib/models/property/property-equity-chart-type.enum.d.ts

@@ -1,4 +1,4 @@
-export declare enum PropertyEquityChartTypeEnum {
-    MARKET_VALUE = "marketValue",
-    LOAN_BALANCE = "loanBalance"
-}
+export declare enum PropertyEquityChartTypeEnum {
+    MARKET_VALUE = "marketValue",
+    LOAN_BALANCE = "loanBalance"
+}

package/lib/models/property/property-forecast.d.ts

@@ -1,28 +1,28 @@
-import { PropertyForecast as PropertyForecastBase } from '../../db/Models/property-forecast';
-export declare class PropertyForecast extends PropertyForecastBase {
-    income: number;
-    expense: number;
-    interest: number;
-    depreciation: number;
-    loanBalance: number;
-    marketValue: number;
-    /**
-     * Get cash position
-     * Cash Position = Income - Expense - Interest
-     */
-    get cashPosition(): number;
-    /**
-     * Get tax position
-     * Tax Position = Income - Expense - Interest - Depreciation
-     */
-    get taxPosition(): number;
-    /**
-     * Get rental return percent
-     * Rental Return = Income / Market Value
-     */
-    get rentalReturn(): number;
-    /**
-     * Check if forecast is for real current fin year (not selected in the sidebar)
-     */
-    isCurrentYear(): boolean;
-}
+import { PropertyForecast as PropertyForecastBase } from '../../db/Models/property/property-forecast';
+export declare class PropertyForecast extends PropertyForecastBase {
+    income: number;
+    expense: number;
+    interest: number;
+    depreciation: number;
+    loanBalance: number;
+    marketValue: number;
+    /**
+     * Get cash position
+     * Cash Position = Income - Expense - Interest
+     */
+    get cashPosition(): number;
+    /**
+     * Get tax position
+     * Tax Position = Income - Expense - Interest - Depreciation
+     */
+    get taxPosition(): number;
+    /**
+     * Get rental return percent
+     * Rental Return = Income / Market Value
+     */
+    get rentalReturn(): number;
+    /**
+     * Check if forecast is for real current fin year (not selected in the sidebar)
+     */
+    isCurrentYear(): boolean;
+}

package/lib/models/property/property-owner.d.ts

@@ -1,21 +1,21 @@
-import { PropertyOwner as PropertyOwnerBase } from '../../db/Models/property-owner';
-import { User } from '../user/user';
-import { RegistrationInvite } from '../registration-invite/registration-invite';
-import { Property } from './property';
-export declare class PropertyOwner extends PropertyOwnerBase {
-    fromDate: Date;
-    toDate: Date;
-    user: User;
-    invite: RegistrationInvite;
-    property: Property;
-    email: string;
-    isAccepted(): boolean;
-    isPending(): boolean;
-    isRejected(): boolean;
-    get statusName(): string;
-    /**
-     * Return full user name if user is already registered.
-     * Otherwise - return first name from invitation
-     */
-    get fullName(): string;
-}
+import { PropertyOwner as PropertyOwnerBase } from '../../db/Models/property/property-owner';
+import { User } from '../user/user';
+import { RegistrationInvite } from '../registration-invite/registration-invite';
+import { Property } from './property';
+export declare class PropertyOwner extends PropertyOwnerBase {
+    fromDate: Date;
+    toDate: Date;
+    user: User;
+    invite: RegistrationInvite;
+    property: Property;
+    email: string;
+    isAccepted(): boolean;
+    isPending(): boolean;
+    isRejected(): boolean;
+    get statusName(): string;
+    /**
+     * Return full user name if user is already registered.
+     * Otherwise - return first name from invitation
+     */
+    get fullName(): string;
+}

package/lib/models/property/property-sale/property-sale-tax-exemption-metadata.d.ts

@@ -0,0 +1,3 @@
+import { PropertySaleTaxExemptionMetadata as BasePropertySaleTaxExemptionMetadata } from '../../../db/Models/property/property-sale/property-sale-tax-exemption-metadata';
+export declare class PropertySaleTaxExemptionMetadata extends BasePropertySaleTaxExemptionMetadata {
+}

package/lib/models/property/property-sale/property-sale.d.ts

@@ -0,0 +1,8 @@
+import { PropertySale as BasePropertySale } from '../../../db/Models/property/property-sale/property-sale';
+import { PropertySaleTaxExemptionMetadata } from '../../../db/Models/property/property-sale/property-sale-tax-exemption-metadata';
+export declare class PropertySale extends BasePropertySale {
+    settlementDate: Date;
+    contractDate: Date;
+    taxExemptionMetadata: PropertySaleTaxExemptionMetadata[];
+    get saleCostsTotalAmount(): number;
+}

package/lib/models/property/property-sale/tax-exemption-metadata.d.ts

@@ -0,0 +1,3 @@
+import { TaxExemptionMetadata as BaseTaxExemptionMetadata } from '../../../db/Models/property/property-sale/tax-exemption-metadata';
+export declare class TaxExemptionMetadata extends BaseTaxExemptionMetadata {
+}

package/lib/models/property/property-sale/tax-exemption.d.ts

@@ -0,0 +1,3 @@
+import { TaxExemption as BaseTaxExemption } from '../../../db/Models/property/property-sale/tax-exemption';
+export declare class TaxExemption extends BaseTaxExemption {
+}

package/lib/models/property/property-subscription.d.ts

@@ -1,6 +1,6 @@
-import { PropertySubscription as PropertySubscriptionBase } from '../../db/Models/property-subscription';
-import { User } from '../user/user';
-export declare class PropertySubscription extends PropertySubscriptionBase {
-    createdAt: Date;
-    user: User;
-}
+import { PropertySubscription as PropertySubscriptionBase } from '../../db/Models/property/property-subscription';
+import { User } from '../user/user';
+export declare class PropertySubscription extends PropertySubscriptionBase {
+    createdAt: Date;
+    user: User;
+}

package/lib/models/property/property-valuation.d.ts

@@ -1,9 +1,9 @@
-import { PropertyValuation as PropertyValuationBase } from '../../db/Models/property-valuation';
-import { PropertyDocument } from './property-document';
-export declare class PropertyValuation extends PropertyValuationBase {
-    date: Date;
-    document: PropertyDocument;
-    documentFile: File;
-    get financialYear(): number;
-    isCurrentYear(): boolean;
-}
+import { PropertyValuation as PropertyValuationBase } from '../../db/Models/property/property-valuation';
+import { PropertyDocument } from './property-document';
+export declare class PropertyValuation extends PropertyValuationBase {
+    date: Date;
+    document: PropertyDocument;
+    documentFile: File;
+    get financialYear(): number;
+    isCurrentYear(): boolean;
+}

package/lib/models/property/property.d.ts

@@ -1,55 +1,86 @@
-import { Property as PropertyBase } from '../../db/Models/property';
-import { Documentable } from '../../interfaces/documentable.interface';
-import { IDocument } from '../../interfaces/document.interface';
-import { PropertyOwner } from '../../db/Models/property-owner';
-import { PropertySubscription } from './property-subscription';
-import { Photoable } from '../../interfaces/photoable';
-import { Address } from '../address/address';
-import { PropertyCategory } from './property-category';
-import { PropertyValuation } from './property-valuation';
-import { PropertyForecast } from './property-forecast';
-import { PropertyCategoryMovement } from './property-category-movement';
-import { User } from '../user/user';
-export declare class Property extends PropertyBase implements Photoable, Documentable {
-    purchaseDate: Date;
-    settlementDate: Date;
-    address: Address;
-    category: PropertyCategory;
-    valuations: PropertyValuation[];
-    forecasts: PropertyForecast[];
-    categoryMovements: PropertyCategoryMovement[];
-    user: User;
-    subscriptions: PropertySubscription[];
-    documentFile: File;
-    documents: IDocument[];
-    get name(): string;
-    get isActive(): boolean;
-    isOwn(): boolean;
-    /**
-     * Get initials of property. Required by Photoable interface
-     */
-    getInitials(): string;
-    /**
-     * Get property photo. Required by Photoable interface
-     */
-    getPhoto(): string;
-    get capitalCostsTotalAmount(): number;
-    get currentYearValuations(): PropertyValuation[];
-    get marketValue(): number;
-    get currentYearForecast(): PropertyForecast;
-    get forecastedRentalReturn(): number;
-    get forecastedTaxPosition(): number;
-    get firstForecastYear(): number;
-    get marketValueGrowth(): number;
-    get myShare(): PropertyOwner;
-    /**
-     * exact claim percent includes ownership
-     */
-    get ownershipClaimPercent(): number;
-    get actualValuation(): PropertyValuation;
-    get ownershipPercent(): number;
-    get previousCategory(): PropertyCategory;
-    getCurrentSubscription(): PropertySubscription;
-    getForecastByYear(year: number): PropertyForecast;
-    get isShared(): boolean;
-}
+import { Property as PropertyBase } from '../../db/Models/property/property';
+import { Documentable } from '../../interfaces/documentable.interface';
+import { IDocument } from '../../interfaces/document.interface';
+import { PropertyOwner } from '../../db/Models/property/property-owner';
+import { PropertySubscription } from './property-subscription';
+import { Photoable } from '../../interfaces/photoable';
+import { Address } from '../address/address';
+import { PropertyCategory } from './property-category';
+import { PropertyValuation } from './property-valuation';
+import { PropertyForecast } from './property-forecast';
+import { PropertyCategoryMovement } from './property-category-movement';
+import { User } from '../user/user';
+import { TaxExemptionEnum } from '../../db/Enums/property/property-sale/tax-exemption.enum';
+import { PropertySale } from './property-sale/property-sale';
+import { unitOfTime } from 'moment';
+/**
+ * propertySale docs - https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/4209508353/Property+Sold+button
+ */
+export declare class Property extends PropertyBase implements Photoable, Documentable {
+    contractDate: Date;
+    settlementDate: Date;
+    address: Address;
+    category: PropertyCategory;
+    valuations: PropertyValuation[];
+    forecasts: PropertyForecast[];
+    categoryMovements: PropertyCategoryMovement[];
+    user: User;
+    subscriptions: PropertySubscription[];
+    documentFile: File;
+    documents: IDocument[];
+    get name(): string;
+    get isActive(): boolean;
+    isOwn(): boolean;
+    /**
+     * Get initials of property. Required by Photoable interface
+     */
+    getInitials(): string;
+    /**
+     * Get property photo. Required by Photoable interface
+     */
+    getPhoto(): string;
+    get capitalCostsTotalAmount(): number;
+    get currentYearValuations(): PropertyValuation[];
+    get marketValue(): number;
+    get currentYearForecast(): PropertyForecast;
+    get forecastedRentalReturn(): number;
+    get forecastedTaxPosition(): number;
+    get firstForecastYear(): number;
+    get marketValueGrowth(): number;
+    get myShare(): PropertyOwner;
+    /**
+     * exact claim percent includes ownership
+     */
+    get ownershipClaimPercent(): number;
+    get actualValuation(): PropertyValuation;
+    get ownershipPercent(): number;
+    get previousCategory(): PropertyCategory;
+    getCurrentSubscription(): PropertySubscription;
+    getForecastByYear(year: number): PropertyForecast;
+    get isShared(): boolean;
+    /**
+     * purchase costs - claimed costs, except `ppr to investment` exemption,
+     * in that case it's equal to market value, when property became an investment property
+     */
+    calculateCostBase(sale: PropertySale): number;
+    /**
+     * gross capital gain tax: sale costs - cost base
+     */
+    calculateCGT(sale: PropertySale): number;
+    /**
+     * net capital gain tax (includes tax exemptions)
+     */
+    calculateNetCGT(sale: PropertySale): number;
+    /**
+     * guess tax exemption based on property details
+     */
+    getCGTExemption(sale: PropertySale): TaxExemptionEnum;
+    /**
+     * tax exemption can reduce cgt from 100% to less (up to zero)
+     */
+    getCGTExemptionRatio(sale: PropertySale): number;
+    /**
+     * ownership duration from purchase till sale
+     */
+    getOwnershipDuration(sale: PropertySale, unitOfTime?: unitOfTime.Diff): number;
+}

package/lib/models/registration-invite/registration-invite.d.ts

@@ -1,6 +1,6 @@
-import { RegistrationInvite as RegistrationInviteBase } from '../../db/Models/registration-invite';
-import { Photoable } from '../../interfaces/photoable';
-export declare class RegistrationInvite extends RegistrationInviteBase implements Photoable {
-    getInitials(): string;
-    getPhoto(): string;
-}
+import { RegistrationInvite as RegistrationInviteBase } from '../../db/Models/registration-invite';
+import { Photoable } from '../../interfaces/photoable';
+export declare class RegistrationInvite extends RegistrationInviteBase implements Photoable {
+    getInitials(): string;
+    getPhoto(): string;
+}

package/lib/models/service-subscription/module-url-list.const.d.ts

@@ -1,6 +1,6 @@
-/**
- * Constant with list of URLs
- */
-export declare const MODULE_URL_LIST: {
-    [key: string]: string;
-};
+/**
+ * Constant with list of URLs
+ */
+export declare const MODULE_URL_LIST: {
+    [key: string]: string;
+};

package/lib/models/service-subscription/service-payment.d.ts

@@ -1,5 +1,5 @@
-import { ServicePayment as BaseServicePayment } from '../../db/Models/service-payment';
-import { ServiceSubscription } from './service-subscription';
-export declare class ServicePayment extends BaseServicePayment {
-    subscription: ServiceSubscription;
-}
+import { ServicePayment as BaseServicePayment } from '../../db/Models/service-payment';
+import { ServiceSubscription } from './service-subscription';
+export declare class ServicePayment extends BaseServicePayment {
+    subscription: ServiceSubscription;
+}

package/lib/models/service-subscription/service-price.d.ts

@@ -1,5 +1,5 @@
-import { ServicePrice as BaseServicePrice } from '../../db/Models/service-price';
-import { ServiceProduct } from './service-product';
-export declare class ServicePrice extends BaseServicePrice {
-    product: ServiceProduct;
-}
+import { ServicePrice as BaseServicePrice } from '../../db/Models/service-price';
+import { ServiceProduct } from './service-product';
+export declare class ServicePrice extends BaseServicePrice {
+    product: ServiceProduct;
+}

package/lib/models/service-subscription/service-product.d.ts

@@ -1,5 +1,5 @@
-import { ServiceProduct as BaseServiceProduct } from '../../db/Models/service-product';
-export declare class ServiceProduct extends BaseServiceProduct {
-    isProperty(): boolean;
-    isWork(): boolean;
-}
+import { ServiceProduct as BaseServiceProduct } from '../../db/Models/service-product';
+export declare class ServiceProduct extends BaseServiceProduct {
+    isProperty(): boolean;
+    isWork(): boolean;
+}

package/lib/models/service-subscription/service-subscription-item.d.ts

@@ -1,6 +1,6 @@
-import { ServiceSubscriptionItem as ServiceSubscriptionItemBase } from '../../db/Models/service-subscription-item';
-import { ServicePrice } from './service-price';
-export declare class ServiceSubscriptionItem extends ServiceSubscriptionItemBase {
-    price: ServicePrice;
-    get total(): number;
-}
+import { ServiceSubscriptionItem as ServiceSubscriptionItemBase } from '../../db/Models/service-subscription-item';
+import { ServicePrice } from './service-price';
+export declare class ServiceSubscriptionItem extends ServiceSubscriptionItemBase {
+    price: ServicePrice;
+    get total(): number;
+}