taxtank-core 0.28.65 → 0.28.67

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

@@ -5,7 +5,18 @@ import { DepreciationCapitalProject } from '../models/depreciation/depreciation-
 import { TransactionCollection } from './transaction/transaction.collection';
 import { ChartAccountsCategoryEnum } from '../db/Enums/chart-accounts-category.enum';
 import { VehicleClaim } from '../models';
+/**
+ * @TODO extend from TransactionBaseCollection
+ */
 export declare class DepreciationCollection extends Collection<Depreciation> {
+    /**
+     * Get business related transactions
+     */
+    getWithBusiness(): this;
+    /**
+     * assets purchased in the current financial year
+     */
+    getNew(): this;
     /**
      * Get total amount of all depreciations in the collection
      */

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

@@ -1,9 +1,16 @@
 import { TransactionBase } from '../../db/Models/transaction/transaction-base';
 import { Collection } from '../collection';
+import { SoleBusiness } from '../../models';
+/**
+ * used to combine transactions/depreciations
+ */
 export declare class TransactionBaseCollection extends Collection<TransactionBase> {
+    filterByBusiness(business: SoleBusiness): this;
     getClaimAmountByBusinessId(businessId: number): number;
     /**
      * Get business related transactions
      */
     getWithBusiness(): this;
+    getIncomeTransactions(): this;
+    getExpenseTransactions(): this;
 }

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

@@ -8,10 +8,21 @@ import { Collection } from '../collection';
 import { TransactionMetadata } from '../../models/transaction/transaction-metadata';
 import { VehicleClaim } from '../../models';
 import { ChartData } from '../../models/chart/chart-data';
+import { Depreciation } from '../../models/depreciation/depreciation';
 /**
+ * @TODO extend from TransactionBaseCollection
  * Collection of transactions
  */
 export declare class TransactionCollection extends ExportableCollection<Transaction> {
+    /**
+     * @TODO use TransactionBaseCollection instead
+     * we use depreciations as expense transactions a lot
+     */
+    constructor(transactions?: Transaction[], depreciations?: Depreciation[]);
+    /**
+     * Get business related transactions
+     */
+    getWithBusiness(): this;
     /**
      * Get total amount of all transactions in the collection
      */
@@ -34,7 +45,6 @@ export declare class TransactionCollection extends ExportableCollection<Transact
      * Get summary of claim amounts
      */
     get claimAmount(): number;
-    get grossAmount(): number;
     getByChartAccountsCategories(categories: ChartAccountsCategoryEnum[]): TransactionCollection;
     /**
      * Get transactions by month
@@ -46,8 +56,8 @@ export declare class TransactionCollection extends ExportableCollection<Transact
      */
     getTransactionsMetadata(): Collection<TransactionMetadata>;
     getIncomeTransactions(): TransactionCollection;
-    get claimIncome(): number;
     getExpenseTransactions(): TransactionCollection;
+    get claimIncome(): number;
     get claimExpense(): number;
     getInterestTransactions(): TransactionCollection;
     get claimInterest(): number;
@@ -98,4 +108,11 @@ export declare class TransactionCollection extends ExportableCollection<Transact
      * Chart data for each month from fin year start till current month
      */
     getCashPositionChartData(): ChartData[];
+    /**
+     * user pays GST only from allocated part of income (the rest user didn't get, so don't have to pay)
+     *
+     * @param allocations
+     */
+    calculateAllocatedGST(allocations: TransactionAllocationCollection): number;
+    getAllocatedAmount(allocations: TransactionAllocationCollection): number;
 }

package/lib/db/Enums/annual-frequency.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum AnnualFrequencyEnum {
+    ANNUAL = 1,
+    QUARTERLY = 3,
+    MONTHLY = 12,
+    FORTNIGHTLY = 26,
+    WEEKLY = 52
+}

package/lib/db/Enums/index.d.ts

@@ -1 +1,2 @@
 export * from './document-type.enum';
+export * from './annual-frequency.enum';

package/lib/db/Models/sole/bas-report.d.ts

@@ -0,0 +1,15 @@
+import { User } from '../user/user';
+export declare class BasReport {
+    dateFrom?: Date;
+    dateTo?: Date;
+    income?: number;
+    incomeGST?: number;
+    expenseGST?: number;
+    salary?: number;
+    taxWithheldSalary?: number;
+    taxWithheldNoABN?: number;
+    paygTaxInstalment?: number;
+    fuelTaxCredit?: number;
+    id?: number;
+    user?: User;
+}

package/lib/db/Models/sole/sole-details.d.ts

@@ -1,5 +1,6 @@
 import { User } from '../user/user';
 import { AbstractModel } from '../abstract-model';
+import { AnnualFrequencyEnum } from '../../Enums/annual-frequency.enum';
 export declare class SoleDetails extends AbstractModel {
     abn?: string;
     id?: number;
@@ -8,4 +9,5 @@ export declare class SoleDetails extends AbstractModel {
     updatedAt?: Date;
     deletedAt?: Date;
     user?: User;
+    reportingFrequency?: AnnualFrequencyEnum;
 }

package/lib/db/Models/transaction/transaction-base.d.ts

@@ -21,6 +21,7 @@ export declare class TransactionBase extends AbstractModel {
      */
     file: File;
     claimPercent?: number;
+    get claimRatio(): number;
     get tankType(): TankTypeEnum;
     /**
      * Check if current tank is Property
@@ -34,6 +35,9 @@ export declare class TransactionBase extends AbstractModel {
      * Check if current tank is Sole
      */
     isSoleTank(): boolean;
-    getAmountWithGst(): number;
-    getGstAmount(): number;
+    get amountWithGst(): number;
+    get gstAmount(): number;
+    get gstClaimAmount(): number;
+    get grossAmount(): number;
+    get grossClaimAmount(): number;
 }

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

@@ -10,6 +10,7 @@ export declare abstract class AbstractForm<Model> extends FormGroup {
      * Initial form value for comparison with changes to check saved/unsaved state
      */
     initialValue: Model;
+    submitDisabledFields: boolean;
     protected modelClass: Type<Model>;
     model: Model;
     submitted: boolean;

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

@@ -16,6 +16,10 @@ export declare class AddressForm extends AbstractForm<Address> implements IEvent
      * Delay before corelogic request
      */
     static searchDelay: number;
+    /**
+     * Regarding corelogic formatting, street number should not contain spaces
+     */
+    static streetNumberPattern: RegExp;
     /**
      * Manual mode flag
      */
@@ -55,4 +59,11 @@ export declare class AddressForm extends AbstractForm<Address> implements IEvent
      * When corelogic is required we have to search address even for manual address
      */
     private listenManualFieldsChanges;
+    /**
+     * Address model has common field 'address' for street name and number because Corelogic returns this data as one string,
+     * but we need separated fields in the form.
+     *
+     * Listen street and number changes and fill address with concatinated values
+     */
+    private listenStreetFieldsChanges;
 }

package/lib/forms/sole/bas-report.form.d.ts

@@ -0,0 +1,16 @@
+import { AbstractForm } from '../abstract.form';
+import { BasReport } from '../../models';
+import { TransactionAllocationCollection, TransactionCollection } from '../../collections';
+import { DepreciationCollection } from '../../collections/depreciation.collection';
+/**
+ * business activity statement report
+ * https://taxtank.atlassian.net/wiki/spaces/TAXTANK/pages/268533936/BAS+Report
+ */
+export declare class BasReportForm extends AbstractForm<BasReport> {
+    private report;
+    submitDisabledFields: boolean;
+    /**
+     * @TODO vik TransactionBaseCollection here and everywhere
+     */
+    constructor(report: BasReport, transactions: TransactionCollection, allocations: TransactionAllocationCollection, depreciations: DepreciationCollection);
+}

package/lib/forms/sole/index.d.ts

@@ -7,3 +7,4 @@ export * from './sole-details.form';
 export * from './sole-invoice.form';
 export * from './sole-invoice-item.form';
 export * from './sole-invoice-template.form';
+export * from './bas-report.form';

package/lib/models/address/address.d.ts

@@ -6,6 +6,22 @@ export declare class Address extends AddressBase {
     suggestion: string;
     type: AddressTypeEnum;
     toString(): string;
+    /**
+     * Short address string
+     * 12/23 Jackson avenue
+     */
     get name(): string;
+    /**
+     * Full address string in corelogic format
+     * 12/23 Jackson avenue Sydney QLD 1212
+     */
     get nameLong(): string;
+    /**
+     * Street number may contain digits, letters, symbols '/' and '-', but not spaces
+     */
+    get streetNumber(): string;
+    /**
+     * Street name without number
+     */
+    get street(): string;
 }

package/lib/models/address/index.d.ts

@@ -0,0 +1,3 @@
+export * from './address';
+export * from './country';
+export * from './states.enum';

package/lib/models/address/states.enum.d.ts

@@ -0,0 +1,10 @@
+export declare enum StatesEnum {
+    ACT = "ACT (The Australian Capital Territory)",
+    NSW = "NSW (New South Wales)",
+    NT = "NT (Northern Territory)",
+    SA = "SA (South Australia)",
+    TAS = "TAS (Tasmania)",
+    VIC = "VIC (Victoria)",
+    QLD = "QLD (Queensland)",
+    WA = "WA (Western Australia)"
+}

package/lib/models/depreciation/depreciation.d.ts

@@ -64,4 +64,9 @@ export declare class Depreciation extends DepreciationBase implements Expense, I
      * @TODO Michael: remove and check everywhere in reports
      */
     get claimAmount(): number;
+    get amountWithGst(): number;
+    /**
+     * @TODO temporary hack, in future backend should return negative numbers
+     */
+    get grossAmount(): number;
 }

package/lib/models/index.d.ts

@@ -1,3 +1,4 @@
+export * from './address';
 export * from './bank';
 export * from './sole';
 export * from './vehicle';

package/lib/models/sole/bas-report.d.ts

@@ -0,0 +1,10 @@
+import { BasReport as BasReportBase } from "../../db/Models/sole/bas-report";
+export declare class BasReport extends BasReportBase {
+    dateFrom: Date;
+    dateTo: Date;
+    get taxWithheldTotal(): number;
+    /**
+     * GST payable to the ATO, or refundable from the ATO in case it's negative
+     */
+    get gst(): number;
+}

package/lib/models/sole/index.d.ts

@@ -10,3 +10,4 @@ export * from './sole-invoice';
 export * from './sole-invoice-item';
 export * from './sole-invoice-send-data.interface';
 export * from './sole-invoice-template';
+export * from './bas-report';

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

@@ -33,9 +33,16 @@ export declare class Transaction extends TransactionBase implements Expense, IRe
     amount: number;
     isDebit(): boolean;
     isCredit(): boolean;
+    /**
+     * @TODO move to base collection
+     */
     isIncome(): boolean;
+    /**
+     * @TODO move to base collection
+     */
     isExpense(): boolean;
     isPersonal(): boolean;
+    isInterest(): boolean;
     get chartAccountsCategories(): ChartAccountsCategoryEnum[];
     /**
      * Check if transaction has 'Kms travelled for work' chart accounts category
@@ -49,15 +56,6 @@ export declare class Transaction extends TransactionBase implements Expense, IRe
      * Check if transaction type is vehicle
      */
     isVehicleTransaction(): boolean;
-    /**
-     * Get net amount (clean amount after all deductions)
-     * @TODO Alex: remove, this.amount should be netAmount actually
-     */
-    getNetAmount(): number;
-    /**
-     * Get gross income amount
-     */
-    getGrossIncome(): number;
     get taxFreeComponent(): number;
     get frankingCredit(): number;
     get eligibleForReduction(): number;
@@ -77,12 +75,6 @@ export declare class Transaction extends TransactionBase implements Expense, IRe
      * @Todo modify 'metadata' property from array to Collection
      */
     getMetadataFieldValue(field: ChartAccountsMetadataListEnum): number;
-    /**
-     * Returns Net or Gross income amount based on provided income type
-     * @param incomeType by which amount should be returned
-     */
-    private getIncomeAmountByType;
-    isInterest(): boolean;
     isCash(): boolean;
     /**
      * Create Depreciation instance based on Transaction
@@ -102,7 +94,6 @@ export declare class Transaction extends TransactionBase implements Expense, IRe
     getUnallocatedAmount(allocations: TransactionAllocationCollection): number;
     /**
      * Total transaction amount including taxes and other additional amounts
-     * @TODO Alex: refactor everything related to amounts
      */
     get grossAmount(): number;
 }

package/lib/services/http/sole/bas-report/bas-report.service.d.ts

@@ -0,0 +1,11 @@
+import { RestService } from '../../rest/rest.service';
+import { BasReport as BasReportBase } from '../../../../db/Models/sole/bas-report';
+import { BasReport } from '../../../../models';
+import * as i0 from "@angular/core";
+export declare class BasReportService extends RestService<BasReportBase, BasReport> {
+    modelClass: typeof BasReport;
+    url: string;
+    isHydra: boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BasReportService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<BasReportService>;
+}

package/lib/services/http/sole/index.d.ts

@@ -7,3 +7,4 @@ export * from './sole-depreciation-method/sole-depreciation-method.service';
 export * from './sole-details/sole-details.service';
 export * from './sole-invoice/sole-invoice.service';
 export * from './sole-invoice-template/sole-invoice-template.service';
+export * from './bas-report/bas-report.service';

package/package.json

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

package/public-api.d.ts

@@ -143,8 +143,6 @@ export * from './lib/db/Enums/property/property-sale/tax-exemption-metadata.enum
  */
 export * from './lib/models';
 export * from './lib/models/account-setup/account-setup-item';
-export * from './lib/models/address/address';
-export * from './lib/models/address/country';
 export * from './lib/models/badge/badge';
 export * from './lib/models/badge/badge-color.enum';
 export * from './lib/models/borrowing-expense/borrowing-expense';