taxtank-core 0.10.5 → 0.11.0

package/lib/collections/account-setup-item.collection.d.ts

@@ -0,0 +1,6 @@
+import { AccountSetupItem } from '../models/account-setup/account-setup-item';
+import { Collection } from './collection';
+export declare class AccountSetupItemCollection extends Collection<AccountSetupItem> {
+    constructor(items: AccountSetupItem[]);
+    isCompleted(): boolean;
+}

package/lib/collections/collection-dictionary.d.ts

@@ -18,7 +18,7 @@ export declare class CollectionDictionary<Collection extends BaseCollection<obje
      * @param path Path to the property to be grouped (Examples: 'transaction', 'property.category')
      * @param prop Optional: Field to group by (Default 'id', Examples: 'id', 'amount', 'date')
      */
-    constructor(collection: Collection, path?: string, prop?: string);
+    constructor(collection: Collection, path?: string);
     /**
      * List of collections keys
      */

package/lib/collections/collection.d.ts

@@ -36,6 +36,10 @@ export declare class Collection<Model extends object> implements Iterable<Model>
      * Filter items by specific provided callback
      */
     filter(callback: (item: Model) => boolean): Collection<Model>;
+    /**
+     * Sort collection items by provided field
+     */
+    sortBy(filed?: string, isDesc?: boolean): void;
     get first(): Model;
     get last(): Model;
 }

package/lib/collections/report/property/property-report-item-depreciation.collection.d.ts

@@ -0,0 +1,12 @@
+import { Collection } from '../../collection';
+import { ChartAccounts } from '../../../models/chart-accounts/chart-accounts';
+import { DepreciationCollection } from '../../depreciation.collection';
+import { PropertyReportItemCollection } from './property-report-item.collection';
+import { PropertyCollection } from '../../property/property.collection';
+/**
+ * Collection to work with depreciation-based property report items
+ */
+export declare class PropertyReportItemDepreciationCollection extends PropertyReportItemCollection {
+    constructor(depreciations: DepreciationCollection, properties: PropertyCollection, chartAccounts: Collection<ChartAccounts>);
+    private setItems;
+}

package/lib/collections/report/property/property-report-item-transaction.collection.d.ts

@@ -0,0 +1,12 @@
+import { Collection } from '../../collection';
+import { TransactionCollection } from '../../transaction.collection';
+import { ChartAccounts } from '../../../models/chart-accounts/chart-accounts';
+import { PropertyReportItemCollection } from './property-report-item.collection';
+import { PropertyCollection } from '../../property/property.collection';
+/**
+ * Collection to work with transaction-based property report items
+ */
+export declare class PropertyReportItemTransactionCollection extends PropertyReportItemCollection {
+    constructor(transactions: TransactionCollection, properties: PropertyCollection, chartAccounts: Collection<ChartAccounts>);
+    private setItems;
+}

package/lib/collections/report/property/property-report-item.collection.d.ts

@@ -0,0 +1,9 @@
+import { Collection } from '../../collection';
+import { PropertyReportItem } from '../../../models/report/property/property-report-item';
+/**
+ * Base collection to work with property report items
+ */
+export declare class PropertyReportItemCollection extends Collection<PropertyReportItem> {
+    getIncomes(): this;
+    getExpenses(): this;
+}

package/lib/db/Enums/property/property-category-list.enum.d.ts

@@ -1,3 +1,4 @@
 export declare enum PropertyCategoryListEnum {
-    OWNER_OCCUPIED = 3
+    OWNER_OCCUPIED = 3,
+    VACANT_LAND = 5
 }

package/lib/db/Enums/user-status.enum.d.ts

@@ -1,6 +1,5 @@
 export declare enum UserStatusEnum {
     INACTIVE = 0,
     ON_BOARDING = 1,
-    ACTIVE = 2,
-    TRIAL = 3
+    ACTIVE = 2
 }

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

@@ -5,8 +5,8 @@ import { User } from './user';
 import { Occupation } from './occupation';
 import { Address } from './address';
 import { Phone } from './phone';
+import { ClientIncomeTypes } from './client-income-types';
 export declare class ClientDetails {
-    id?: number;
     isAustralianResident?: boolean;
     taxFileNumber?: string;
     workDepreciationCalculation?: ClientDetailsWorkDepreciationCalculationEnum;
@@ -19,7 +19,10 @@ export declare class ClientDetails {
     pensionersTax?: boolean;
     workingHolidayMaker?: ClientDetailsWorkingHolidayMakerEnum;
     dateOfBirth?: Date;
+    abn?: number;
+    isGST?: boolean;
     capitalLoss?: number;
+    id?: number;
     deletedAt?: Date;
     createdAt?: Date;
     updatedAt?: Date;
@@ -27,4 +30,5 @@ export declare class ClientDetails {
     occupation?: Occupation;
     addresses?: Address[];
     phones?: Phone[];
+    incomeTypes?: ClientIncomeTypes;
 }

package/lib/db/Models/client-income-types.d.ts

@@ -0,0 +1,11 @@
+import { ClientDetails } from './client-details';
+export declare class ClientIncomeTypes {
+    salary?: boolean;
+    rental?: boolean;
+    soleTrader?: boolean;
+    dividends?: boolean;
+    other?: boolean;
+    id?: number;
+    deletedAt?: Date;
+    clientDetails?: ClientDetails;
+}

package/lib/forms/client/client-income-types.form.d.ts

@@ -0,0 +1,7 @@
+import { AbstractForm } from '../abstract.form';
+import { ClientIncomeTypes } from '../../models/client/client-income-types';
+export declare class ClientIncomeTypesForm extends AbstractForm {
+    private clientIncomeTypes;
+    constructor(clientIncomeTypes: ClientIncomeTypes);
+    submit(): object;
+}

package/lib/forms/index.d.ts

@@ -1,4 +1,5 @@
 export * from './abstract.form';
+export * from './client/client-income-types.form';
 export * from './login/login.form';
 export * from './register/register-client.form';
 export * from './register/register-firm.form';

package/lib/models/account-setup/account-setup-item.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Account setup item instance is using for account setup checklist
+ */
+export declare class AccountSetupItem {
+    title: string;
+    description: string;
+    url: string;
+    isCompleted: boolean;
+}

package/lib/models/account-setup/account-setup-items.const.d.ts

@@ -0,0 +1,7 @@
+import { AccountSetupItem } from './account-setup-item';
+/**
+ * List of all possible account setup steps
+ */
+export declare const ACCOUNT_SETUP_ITEMS: {
+    [key: number]: AccountSetupItem;
+};

package/lib/models/account-setup/account-setup-items.enum.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Enum list of all possible account setup items. Using with [ACCOUNT_SETUP_ITEMS]{@link ACCOUNT_SETUP_ITEMS}
+ */
+export declare enum AccountSetupItemsEnum {
+    SALARY = 0,
+    OTHER_INCOME = 1,
+    PROPERTY = 2,
+    BANK_FEEDS = 3,
+    WORK_LOGBOOK = 4,
+    SOLE_INCOME = 5,
+    TRANSACTION = 6
+}

package/lib/models/client/client-income-types.d.ts

@@ -0,0 +1,7 @@
+import { ClientIncomeTypes as ClientIncomeTypesBase } from '../../db/Models/client-income-types';
+export declare class ClientIncomeTypes extends ClientIncomeTypesBase {
+    /**
+     * Get count of selected income types
+     */
+    get length(): number;
+}

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

@@ -62,6 +62,6 @@ export declare class Depreciation extends DepreciationBase implements ITank, IRe
     /**
      * Create a new transaction from current depreciation
      */
-    toTransaction(): Transaction;
+    toTransaction(params?: {}): Transaction;
     get claimAmount(): number;
 }

package/lib/models/export/export-data-table.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Data table structure suitable for export
+ */
+export declare class ExportDataTable {
+    caption?: string;
+    header: string[];
+    rows: string[][];
+    footer: string[];
+}

package/lib/models/pdf/pdf-orientation.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum PdfOrientationEnum {
+    PORTRAIT = "portrait",
+    LANDSCAPE = "landscape"
+}

package/lib/models/report/property/property-report-item-depreciation.d.ts

@@ -0,0 +1,10 @@
+import { PropertyReportItem } from './property-report-item';
+import { Property } from '../../property/property';
+import { ChartAccounts } from '../../chart-accounts/chart-accounts';
+import { DepreciationCollection } from '../../../collections/depreciation.collection';
+/**
+ * Class with depreciation-based property transactions report entities
+ */
+export declare class PropertyReportItemDepreciation extends PropertyReportItem {
+    constructor(depreciations: DepreciationCollection, property: Property, chartAccounts: ChartAccounts);
+}

package/lib/models/report/property/property-report-item-transaction.d.ts

@@ -0,0 +1,10 @@
+import { PropertyReportItem } from './property-report-item';
+import { TransactionCollection } from '../../../collections/transaction.collection';
+import { Property } from '../../property/property';
+import { ChartAccounts } from '../../chart-accounts/chart-accounts';
+/**
+ * Class with transaction-based property transactions report entities
+ */
+export declare class PropertyReportItemTransaction extends PropertyReportItem {
+    constructor(transactions: TransactionCollection, property: Property, chartAccounts: ChartAccounts);
+}

package/lib/models/report/property/property-report-item.d.ts

@@ -0,0 +1,22 @@
+import { Property } from '../../property/property';
+import { ChartAccounts } from '../../chart-accounts/chart-accounts';
+/**
+ * Class with property transactions report entities
+ */
+export declare class PropertyReportItem {
+    amount: number;
+    description: string;
+    /**
+     * Tax return item sub-code
+     */
+    subCode: string;
+    sharePercent: number;
+    claimPercent: number;
+    propertyId: number;
+    chartAccounts: ChartAccounts;
+    constructor(property: Property, chartAccounts: ChartAccounts);
+    get claimAmount(): number;
+    get shareClaimAmount(): number;
+    isIncome(): boolean;
+    isExpense(): boolean;
+}

package/lib/services/account-setup/account-setup.service.d.ts

@@ -0,0 +1,47 @@
+import { BankAccountService } from '../http/bank/bank-account/bank-account.service';
+import { ClientIncomeTypesService } from '../http/firm/client-income/client-income-types.service';
+import { IncomeSourceService } from '../http/income-source/income-source.service';
+import { PropertyService } from '../http/property/property.service';
+import { TransactionAllocationService } from '../http/transaction/transaction-allocation/transaction-allocation.service';
+import { VehicleService } from '../http/vehicle/vehicle.service';
+import { Observable, ReplaySubject } from 'rxjs';
+import { AccountSetupItemCollection } from '../../collections/account-setup-item.collection';
+import * as i0 from "@angular/core";
+/**
+ * Service handling user's account setup process.
+ * Checks required steps and their completion
+ */
+export declare class AccountSetupService {
+    private clientIncomeTypesService;
+    private propertyService;
+    private incomeSourceService;
+    private bankAccountsService;
+    private transactionAllocationService;
+    private vehicleService;
+    cache: AccountSetupItemCollection;
+    cacheSubject: ReplaySubject<AccountSetupItemCollection>;
+    constructor(clientIncomeTypesService: ClientIncomeTypesService, propertyService: PropertyService, incomeSourceService: IncomeSourceService, bankAccountsService: BankAccountService, transactionAllocationService: TransactionAllocationService, vehicleService: VehicleService);
+    /**
+     * Get list of account setup items for current user
+     */
+    get(): Observable<AccountSetupItemCollection>;
+    /**
+     * Get a single AccountSetupItem and check it's completion
+     */
+    private create;
+    /**
+     * Get batch of requests to get list of required AccountSetupItem's.
+     * Some items are optional and depends of user's client income types
+     */
+    private createBatch;
+    /**
+     * @TODO Temp solution: Refactor with new logbook system (waiting for PR finish). Use this.getItem() instead after refactoring
+     */
+    private getLogbookItem;
+    /**
+     * @TODO work with collection when services refactored
+     */
+    private getIncomeSourcesByType;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AccountSetupService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AccountSetupService>;
+}

package/lib/services/http/firm/client-income/client-income-types.service.d.ts

@@ -0,0 +1,18 @@
+import { HttpClient } from '@angular/common/http';
+import { Observable, ReplaySubject } from 'rxjs';
+import { ClientIncomeTypes } from '../../../../models/client/client-income-types';
+import * as i0 from "@angular/core";
+/**
+ * @TODO extend rest service when it could work with single objects, not only arrays
+ */
+export declare class ClientIncomeTypesService {
+    private http;
+    private environment;
+    cache: ClientIncomeTypes;
+    cacheSubject: ReplaySubject<ClientIncomeTypes>;
+    constructor(http: HttpClient, environment: any);
+    get(): Observable<ClientIncomeTypes>;
+    update(incomeTypes: ClientIncomeTypes): Observable<ClientIncomeTypes>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ClientIncomeTypesService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ClientIncomeTypesService>;
+}

package/lib/services/http/transaction/transaction.service.d.ts

@@ -42,6 +42,10 @@ export declare class TransactionService extends RestService<TransactionBase, Tra
      * get list of transactions with tank type 'Work'
      */
     getWorkTransactions(): Observable<Transaction[]>;
+    /**
+     * Get list of property holding costs (transactions related to vacant land property)
+     */
+    getPropertyHoldingCosts(propertyId: number): Observable<Transaction[]>;
     /**
      * get list of taxable transactions with tank type 'Work'
      */

package/lib/services/pdf/pdf.service.d.ts

@@ -1,10 +1,24 @@
+import { ExportDataTable } from '../../models/export/export-data-table';
+import { PdfOrientationEnum } from '../../models/pdf/pdf-orientation.enum';
 import * as i0 from "@angular/core";
 export declare class PdfService {
     /**
-     * Export file form provided HTML tables
+     * Export file from provided HTML tables
      */
-    exportTables(tables: NodeListOf<HTMLTableElement>, title: string, fileName: string): void;
+    exportTables(tables: NodeListOf<HTMLTableElement>, title: string, fileName: string, orientation: PdfOrientationEnum): void;
+    /**
+     * Export file from provided array-like table data
+     */
+    exportFromDataTables(dataTables: ExportDataTable[], title: string, fileName: string): void;
+    /**
+     * Generate file from array-like table data
+     */
+    private generateFromDataTables;
     private generateFromTables;
+    /**
+     * Set basic options for PDF table
+     */
+    private setTableOptions;
     private setDocumentTitle;
     private setDocumentLogo;
     static ɵfac: i0.ɵɵFactoryDeclaration<PdfService, never>;

package/lib/services/property/property-holding-costs/property-holding-costs.service.d.ts

@@ -0,0 +1,24 @@
+import { Transaction } from '../../../models/transaction/transaction';
+import { ExportDataTable } from '../../../models/export/export-data-table';
+import { PdfService } from '../../pdf/pdf.service';
+import { TransactionCollection } from '../../../collections/transaction.collection';
+import { CurrencyPipe, DatePipe } from '@angular/common';
+import * as i0 from "@angular/core";
+/**
+ * Service to work with holding costs (transactions related to vacant land property)
+ */
+export declare class PropertyHoldingCostsService {
+    private pdfService;
+    private currencyPipe;
+    private datePipe;
+    url: string;
+    modelClass: typeof Transaction;
+    constructor(pdfService: PdfService, currencyPipe: CurrencyPipe, datePipe: DatePipe);
+    initDataTable(holdingCosts: TransactionCollection): ExportDataTable;
+    /**
+     * Get data for the exporting table rows
+     */
+    private getDataTableRows;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PropertyHoldingCostsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PropertyHoldingCostsService>;
+}

package/lib/services/report/property/property-transaction-report.service.d.ts

@@ -0,0 +1,42 @@
+import { PropertyService } from '../../http/property/property.service';
+import { TransactionService } from '../../http/transaction/transaction.service';
+import { DepreciationService } from '../../http/depreciation/depreciation.service';
+import { ChartAccountsService } from '../../http/chart-accounts/chart-accounts.service';
+import { Observable } from 'rxjs';
+import { Property } from '../../../models/property/property';
+import { ChartAccounts } from '../../../models/chart-accounts/chart-accounts';
+import { DepreciationCollection } from '../../../collections/depreciation.collection';
+import { Collection } from '../../../collections/collection';
+import { CollectionDictionary } from '../../../collections/collection-dictionary';
+import { TransactionCollection } from '../../../collections/transaction.collection';
+import { PropertyReportItemCollection } from '../../../collections/report/property/property-report-item.collection';
+import * as i0 from "@angular/core";
+/**
+ * Service to handle Property transactions report items data (get income / expense report items, e.t.c.)
+ */
+export declare class PropertyTransactionReportService {
+    private propertyService;
+    private transactionService;
+    private depreciationService;
+    private chartAccountsService;
+    properties: Property[];
+    transactions: TransactionCollection;
+    depreciations: DepreciationCollection;
+    chartAccounts: Collection<ChartAccounts>;
+    constructor(propertyService: PropertyService, transactionService: TransactionService, depreciationService: DepreciationService, chartAccountsService: ChartAccountsService);
+    /**
+     * Get collection of report items based on transactions & depreciations
+     */
+    get(): Observable<CollectionDictionary<PropertyReportItemCollection>>;
+    private create;
+    /**
+     * Get collection of property transactions
+     */
+    private getTransactions;
+    /**
+     * Get list of asset & capital property depreciations
+     */
+    private getDepreciations;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PropertyTransactionReportService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PropertyTransactionReportService>;
+}

package/lib/validators/at-least-one.validator.d.ts

@@ -0,0 +1,6 @@
+import { ValidatorFn } from '@angular/forms';
+/**
+ * Check if at least one form field is true, otherwise form is invalid.
+ * Use with groups of boolean form controls (checkbox, toggle, etc.)
+ */
+export declare function atLeastOneCheckedValidator(): ValidatorFn;

package/lib/validators/index.d.ts

@@ -0,0 +1 @@
+export * from './at-least-one.validator';

package/package.json

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

package/public-api.d.ts

@@ -6,6 +6,7 @@ export * from './lib/tt-core.module';
  * Collections
  */
 export * from './lib/collections/collection';
+export * from './lib/collections/account-setup-item.collection';
 export * from './lib/collections/bank-account.collection';
 export * from './lib/collections/bank-transaction.collection';
 export * from './lib/collections/client.collection';
@@ -23,6 +24,9 @@ export * from './lib/collections/message-document.collection';
 export * from './lib/collections/property/property.collection';
 export * from './lib/collections/report/depreciation/depreciation-lvp-report-item.collection';
 export * from './lib/collections/report/depreciation/depreciation-report-item.collection';
+export * from './lib/collections/report/property/property-report-item.collection';
+export * from './lib/collections/report/property/property-report-item-transaction.collection';
+export * from './lib/collections/report/property/property-report-item-depreciation.collection';
 export * from './lib/collections/service-price.collection';
 export * from './lib/collections/service-subscription.collection';
 export * from './lib/collections/tax-summary/report-item.collection';
@@ -77,6 +81,7 @@ export * from './lib/db/Enums/loan-type.enum';
 export * from './lib/db/Enums/loan-vehicle-type.enum';
 export * from './lib/db/Enums/phone-type.enum';
 export * from './lib/db/Enums/property/property-depreciation-calculation.enum';
+export * from './lib/db/Enums/property/property-category-list.enum';
 export * from './lib/db/Enums/property/property-share-access.enum';
 export * from './lib/db/Enums/property/property-share-status.enum';
 export * from './lib/db/Enums/registration-invite-status.enum';
@@ -121,6 +126,7 @@ export * from './lib/db/Enums/property/property-sale/tax-exemption-metadata.enum
 /**
  * Models and related enums and consts
  */
+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/bank/bank';
@@ -151,6 +157,7 @@ export * from './lib/models/chat/chat-view-type.enum';
 export * from './lib/models/chat/message';
 export * from './lib/models/chat/message-document';
 export * from './lib/models/client/client-details';
+export * from './lib/models/client/client-income-types';
 export * from './lib/models/client/client-invite';
 export * from './lib/models/client/client-movement';
 export * from './lib/models/client/client-portfolio-chart-data';
@@ -174,6 +181,7 @@ export * from './lib/models/endpoint/endpoint';
 export * from './lib/models/endpoint/endpoints.const';
 export * from './lib/models/event/app-event';
 export * from './lib/models/event/app-event-type.enum';
+export * from './lib/models/export/export-data-table';
 export * from './lib/models/export/export-format.enum';
 export * from './lib/models/file/icons-file.enum';
 export * from './lib/models/financial-year/financial-year';
@@ -199,6 +207,7 @@ export * from './lib/models/logbook/vehicle';
 export * from './lib/models/logbook/vehicle-claim';
 export * from './lib/models/logbook/vehicle-logbook';
 export * from './lib/models/notification/notification';
+export * from './lib/models/pdf/pdf-orientation.enum';
 export * from './lib/models/phone/phone';
 export * from './lib/models/property/calculation-form-item';
 export * from './lib/models/property/calculation-form-type.enum';
@@ -223,6 +232,8 @@ export * from './lib/models/registration-invite/registration-invite';
 export * from './lib/models/report/depreciation/depreciation-lvp-report-item';
 export * from './lib/models/report/depreciation/depreciation-report-item';
 export * from './lib/models/report/depreciation/depreciation-lvp-asset-type.enum';
+export * from './lib/models/report/property/property-report-item';
+export * from './lib/models/report/property/property-report-item-transaction';
 export * from './lib/models/service-subscription/module-url-list.const';
 export * from './lib/models/service-subscription/service-payment';
 export * from './lib/models/service-subscription/service-price';
@@ -261,6 +272,7 @@ export * from './lib/models/user-event/user-event-type';
 /**
  * Services
  */
+export * from './lib/services/account-setup/account-setup.service';
 export * from './lib/services/http/address/address.service';
 export * from './lib/services/asset/assets.service';
 export * from './lib/services/auth/auth.service';
@@ -286,6 +298,7 @@ export * from './lib/services/http/depreciation/depreciation.service';
 export * from './lib/services/http/document/document-folder/document-folder.service';
 export * from './lib/services/http/firm/employee/employee.service';
 export * from './lib/services/http/firm/employee-invite/employee-invite.service';
+export * from './lib/services/http/firm/client-income/client-income-types.service';
 export * from './lib/services/event/event-dispatcher.service';
 export * from './lib/services/event/sse.service';
 export * from './lib/services/http/firm/firm.service';
@@ -300,9 +313,11 @@ export * from './lib/services/http/loan/loan.service';
 export * from './lib/services/http/service-notification/service-notification.service';
 export * from './lib/services/pdf/pdf.service';
 export * from './lib/services/preloader/preloader.service';
+export * from './lib/services/report/property/property-transaction-report.service';
 export * from './lib/services/property/corelogic/corelogic.service';
 export * from './lib/services/http/property/property.service';
 export * from './lib/services/property/property-calculation/property-calculation.service';
+export * from './lib/services/property/property-holding-costs/property-holding-costs.service';
 export * from './lib/services/http/property/property-category/property-category.service';
 export * from './lib/services/http/property/property-document/property-document.service';
 export * from './lib/services/http/property/property-share/property-share.service';