taxtank-core 0.27.4 → 0.27.5

package/lib/collections/chart-accounts.collection.d.ts

@@ -2,7 +2,7 @@ import { Collection } from './collection';
 import { ChartAccounts } from '../models/chart-accounts/chart-accounts';
 export declare class ChartAccountsCollection extends Collection<ChartAccounts> {
     /**
-     * Get 'Klms travelled for work' related chart account value
+     * Get 'Kms travelled for work' related chart account value
      */
-    getVehicleKlmsRate(year?: number): number;
+    getVehicleKmsRate(year?: number): number;
 }

package/lib/collections/transaction/transaction.collection.d.ts

@@ -86,9 +86,9 @@ export declare class TransactionCollection extends ExportableCollection<Transact
     /**
      * Get list of vehicle transactions filtered by vehicle claim
      */
-    getByVehicleClaim(vehicleClaim: VehicleClaim): this;
+    getByVehicleClaim(vehicleClaim?: VehicleClaim): this;
     /**
-     * Get list of vehicle transactions except KLMS transactions
+     * Get list of vehicle transactions except KMS transactions
      */
     getLogbookTransactions(): this;
 }

package/lib/collections/vehicle/vehicle-claim.collection.d.ts

@@ -3,12 +3,10 @@ import { VehicleClaim } from '../../models';
 export declare class VehicleClaimCollection extends Collection<VehicleClaim> {
     /**
      * Get remaining kilometers limit. Total limit ({@link VehicleClaim.totalKmsLimit}) - claimed kilometers from other vehicle claims
-     * @param claim may not exist when user come to vehicle claim page 1st time and not created claim yet
      */
-    getKlmsLimitForClaim(claim?: VehicleClaim): number;
+    getKmsLimitForClaim(claim?: VehicleClaim): number;
     /**
      * Get remaining work usage limit. Total limit ({@link VehicleClaim.totalWorkUsagePercent}) - claimed percent from other vehicle claims
-     * @param claim may not exist when user come to vehicle claim page 1st time and not created claim yet
      */
     getWorkUsageLimitForClaim(claim?: VehicleClaim): number;
 }

package/lib/collections/vehicle/vehicle-logbook.collection.d.ts

@@ -2,7 +2,7 @@ import { Collection } from '../collection';
 import { LogbookPeriod, VehicleClaim, VehicleLogbook } from '../../models';
 export declare class VehicleLogbookCollection extends Collection<VehicleLogbook> {
     /**
-     * Best period may be calculated only when user has logbooks minimum for {@link VehicleLogbook.periodDuration}
+     * Best period may be calculated only when user has logbooks minimum for VehicleLogbook.bestPeriodWeeks
      * @TODO Vik: Best period: move this and related logic to backend
      */
     isBestPeriodExist(): boolean;
@@ -12,8 +12,8 @@ export declare class VehicleLogbookCollection extends Collection<VehicleLogbook>
      */
     getClaimableLogbooks(): this;
     /**
-     * Logbook Period is the best when it has the biggest work usage percent
-     * Best period duration is defined as {@link VehicleLogbook.periodDuration} by the ATO
+     * Get Logbook Period with the biggest work usage percent
+     * Best period duration is defined as VehicleLogbook.bestPeriodWeeks by the ATO
      * @TODO Vik: Best period: move this and related logic to backend
      */
     getBestPeriod(): LogbookPeriod;
@@ -26,13 +26,8 @@ export declare class VehicleLogbookCollection extends Collection<VehicleLogbook>
      * @TODO Alex: TT-2089 replace with getter
      */
     getWorkUsage(): number;
-    /**
-     * Get LOGBOOK_PERIOD_DURATION date range from passed start date
-     * @TODO Vik: Best period: move this and related logic to backend
-     */
-    private getPeriodRange;
     /**
      * Get list of logbooks related to passed vehicle claim
      */
-    getByVehicleClaim(claim: VehicleClaim): this;
+    getByVehicleClaim(vehicleClaim: VehicleClaim): this;
 }

package/lib/db/Enums/depreciation-calculation.enum.d.ts

@@ -1,6 +1,7 @@
 export declare enum DepreciationCalculationEnum {
     PRIME_COST = 1,
     DIMINISHING = 2,
+    CAPITAL = 3,
     LVP = 4,
     AMORTISATION = 5,
     SBP = 6

package/lib/forms/abstract.form.d.ts

@@ -3,7 +3,7 @@ import { EventEmitter, Type } from '@angular/core';
 /**
  * Abstract form class
  * @TODO rename to AbstractFormGroup
- * @TODO Alex: refactor: check and improve logic
+ * @TODO Alex TT-2190: refactor: check and improve logic
  */
 export declare abstract class AbstractForm<Model> extends FormGroup {
     /**
@@ -22,6 +22,7 @@ export declare abstract class AbstractForm<Model> extends FormGroup {
         [key: string]: AbstractControl;
     }, model?: Model, validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null);
     get saved(): boolean;
+    get currentValue(): Model;
     /**
      * Check validation and return a new instance of generic model.
      * Merge form value to initial object
@@ -34,4 +35,5 @@ export declare abstract class AbstractForm<Model> extends FormGroup {
     markAsUnsaved(): void;
     markAsSaved(): void;
     private createModelInstance;
+    private listenValueChanges;
 }

package/lib/forms/bank/bank-account/bank-account-allocation.form.d.ts

@@ -1,7 +1,9 @@
 import { AbstractForm } from '../../abstract.form';
 import { BankAccount } from '../../../models/bank/bank-account';
-export declare class BankAccountAllocationForm extends AbstractForm<BankAccount> {
+import { IEventListener } from '../../../interfaces/event-listener.interface';
+export declare class BankAccountAllocationForm extends AbstractForm<BankAccount> implements IEventListener {
     private bankAccount?;
     constructor(bankAccount?: BankAccount);
-    watchTankType(): void;
+    listenEvents(): void;
+    listenTankTypeChanges(): void;
 }

package/lib/forms/sole/sole-business-allocations.form.d.ts

@@ -3,6 +3,7 @@ import { SoleBusinessAllocation } from '../../models';
 /**
  * Form array with bank account business allocations
  * @TODO create AbstractFormArray
+ * @TODO Alex/Vik (TT-2184): copypasted from bank-account-properties.form, improve logic and create common parent class maybe
  */
 export declare class SoleBusinessAllocationsForm extends FormArray {
     constructor(businessAllocations?: SoleBusinessAllocation[]);

package/lib/forms/vehicle/vehicle-claim-details.form.d.ts

@@ -1,13 +1,8 @@
 import { AbstractForm } from '../abstract.form';
 import { VehicleClaimDetails } from '../../models';
-import { VehicleLogbookCollection } from '../../collections';
 /**
  * Add/Edit vehicle claim details form
  */
 export declare class VehicleClaimDetailsForm extends AbstractForm<VehicleClaimDetails> {
-    /**
-     * @param vehicleClaimDetails required because we create a new details with prefilled data (like Financial year)
-     * @param logbooks required for isManual field disabled state management
-     */
-    constructor(vehicleClaimDetails: VehicleClaimDetails, logbooks: VehicleLogbookCollection);
+    constructor(vehicleClaimDetails: VehicleClaimDetails, isBestPeriodExist: boolean);
 }

package/lib/forms/vehicle/vehicle-claim.form.d.ts

@@ -5,9 +5,12 @@ import { VehicleClaimDetails } from '../../models';
  * Add/Edit Vehicle Claim form
  */
 export declare class VehicleClaimForm extends AbstractForm<VehicleClaim> {
+    private vehicleClaim;
+    private details;
     /**
      * @param vehicleClaim required even for the new claim, because claim needs business for sole tank
      * @param details required for form controls disabled state management
      */
     constructor(vehicleClaim: VehicleClaim, details: VehicleClaimDetails);
+    getAverageWeeklyKMS(): number;
 }

package/lib/forms/vehicle/vehicle-logbook.form.d.ts

@@ -17,4 +17,8 @@ export declare class VehicleLogbookForm extends AbstractForm<VehicleLogbook> {
      * @param logbooks list of all logbooks related to current logbook's vehicle. Required for form fields validation and disabled state management
      */
     constructor(logbook: VehicleLogbook, logbooks: VehicleLogbookCollection);
+    /**
+     * Set logbook validators and disable state depends of initial logbook and its place in the whole list
+     */
+    private updateStateAndValidators;
 }

package/lib/models/bank/bank-account.d.ts

@@ -6,6 +6,7 @@ import { BankAccountBalance } from '../../db/Models/bank/bank-account-balance';
 import { BankAccountProperty } from './bank-account-property';
 import { BankConnection } from './bank-connection';
 import { SoleBusinessAllocation } from '../sole';
+import { Bank } from './bank';
 export declare class BankAccount extends BankAccountBase {
     bankAccountProperties: BankAccountProperty[];
     businessAllocations: SoleBusinessAllocation[];
@@ -13,6 +14,7 @@ export declare class BankAccount extends BankAccountBase {
     loan: Loan;
     bankConnection: BankConnection;
     type: BankAccountTypeEnum;
+    get bank(): Bank;
     /**
      * Get current opening balance amount
      */

package/lib/models/chart-accounts/chart-accounts.d.ts

@@ -11,17 +11,17 @@ export declare class ChartAccounts extends ChartAccountsBase {
      */
     toString(): string;
     /**
-     * Check if chart accounts id is related for 'Klms travelled for work' category
+     * Check if chart accounts id is related for 'Kms travelled for work' category
      */
-    isKlmsForWork(): boolean;
+    isKmsForWork(): boolean;
     /**
-     * Check if chart accounts id is related for 'Klms travelled for sole' category
+     * Check if chart accounts id is related for 'Kms travelled for sole' category
      */
-    isKlmsForSole(): boolean;
+    isKmsForSole(): boolean;
     /**
-     * Check if accounts id is related for KLMs category related to passed tank type
+     * Check if accounts id is related for KMs category related to passed tank type
      */
-    isKLMsByTankType(tankType: TankTypeEnum): boolean;
+    isKMsByTankType(tankType: TankTypeEnum): boolean;
     /**
      * Check if chart accounts id is related for 'NRAS Tax Offset' category
      */

package/lib/models/financial-year/financial-year.d.ts

@@ -1,5 +1,6 @@
 export declare class FinancialYear {
     constructor(date?: Date);
+    static weeksInYear: number;
     static startMonthIndex: number;
     year: number;
     startDate: Date;

package/lib/models/sole/sole-invoice-template.d.ts

@@ -2,7 +2,7 @@ import { SoleBusiness } from './sole-business';
 import { BankAccount } from '../bank/bank-account';
 import { SoleInvoiceTemplate as SoleInvoiceTemplateBase } from '../../db/Models/sole/sole-invoice-template';
 export declare class SoleInvoiceTemplate extends SoleInvoiceTemplateBase {
+    isTaxIncluded: boolean;
     business: SoleBusiness;
     bankAccount: BankAccount;
-    static create(businessId: number): SoleInvoiceTemplate;
 }

package/lib/models/transaction/transaction.d.ts

@@ -38,9 +38,9 @@ export declare class Transaction extends TransactionBase implements Expense, IRe
     isPersonal(): boolean;
     get chartAccountsCategories(): ChartAccountsCategoryEnum[];
     /**
-     * Check if transaction has 'Klms travelled for work' chart accounts category
+     * Check if transaction has 'Kms travelled for work' chart accounts category
      */
-    get isKlmsChartAccountsCategory(): boolean;
+    get isKmsChartAccountsCategory(): boolean;
     /**
      * Get transaction date
      */

package/lib/models/vehicle/logbook-period.d.ts

@@ -3,6 +3,7 @@ import { VehicleClaim } from './vehicle-claim';
 /**
  * Class contains traveled kilometers and work usage percent in 12 weeks date range
  * @TODO Vik: Best period: move this and related logic to backend
+ * @TODO Alex: check if we need this class when calculation refactored with backend
  */
 export declare class LogbookPeriod {
     from: Date;

package/lib/models/vehicle/vehicle-claim-details.d.ts

@@ -1,8 +1,14 @@
 import { VehicleClaimDetails as VehicleClaimDetailsBase } from '../../db/Models/vehicle/vehicle-claim-details';
 import { User } from '../user/user';
+import { VehicleClaimDetailsMethodEnum } from '../../db/Enums/vehicle-claim-details-method.enum';
 export declare class VehicleClaimDetails extends VehicleClaimDetailsBase {
+    /**
+     * Init default values for the new instances
+     */
+    isManual: boolean;
+    method: VehicleClaimDetailsMethodEnum;
+    financialYear: number;
     user: User;
     isLogbookMethod(): boolean;
-    isKlmsMethod(): boolean;
-    static create(): VehicleClaimDetails;
+    isKmsMethod(): boolean;
 }

package/lib/models/vehicle/vehicle-claim.d.ts

@@ -14,18 +14,20 @@ export declare class VehicleClaim extends VehicleClaimBase {
     static totalWorkUsagePercent: number;
     details: VehicleClaimDetails;
     business: SoleBusiness;
+    kilometers: number;
+    workUsage: number;
     isWorkTank(): boolean;
     isSoleTank(): boolean;
     get tankType(): TankTypeEnum;
     /**
-     * Claim amount for KLMs method. Exists only for KLMs method.
+     * Claim amount for KMs method. Exists only for KMs method.
      */
-    getKLMsClaimAmount(vehicleClaimRate: number): number;
+    getKMSClaimAmount(vehicleClaimRate: number): number;
     /**
      * Get logbook claim amount. Exists only for logbook method.
      * ClaimAmount = WorkUsage * transaction/depreciation amount
      */
     getLogbookClaimAmount(transactions: TransactionCollection): number;
-    getKlmsChartAccountsIdByTankType(tankType?: TankTypeEnum): number;
-    static create(details: VehicleClaimDetails, business?: SoleBusiness): VehicleClaim;
+    getAverageWeeklyKMS(): number;
+    static getKMSChartAccountsIdByTankType(tankType: TankTypeEnum): number;
 }

package/lib/models/vehicle/vehicle-logbook.d.ts

@@ -1,17 +1,21 @@
 import { VehicleLogbook as VehicleLogbookBase } from '../../db/Models/vehicle/vehicle-logbook';
 import { SoleBusiness } from '../sole';
 import { TankTypeEnum } from '../../db/Enums/tank-type.enum';
+import { DateRange } from 'moment-range';
 export declare class VehicleLogbook extends VehicleLogbookBase {
     /**
-     * 12 weeks in milliseconds
-     * "To work out your business-use percentage, you need to keep a logbook and the odometer readings for the logbook period.
-     * The logbook period is a minimum continuous period of 12 weeks." © Nicole Kelly
+     * Logbook period duration in weeks.
+     * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/211517441/Logbook+Vehicle
      */
-    static periodDuration: number;
+    static bestPeriodWeeks: number;
     date: Date;
     business: SoleBusiness;
     get kilometers(): number;
     get tankType(): TankTypeEnum;
     isWorkTank(): boolean;
     isSoleTank(): boolean;
+    /**
+     * Get logbook period date range from logbook date and weeksInPeriod duration
+     */
+    getPeriod(): DateRange;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "taxtank-core",
-  "version": "0.27.4",
+  "version": "0.27.5",
   "private": false,
   "peerDependencies": {
     "@angular/common": "^12.2.3 || ~13.0.0",