taxtank-core 0.0.2 → 0.1.2

package/lib/db/Models/user-event-type.d.ts

@@ -0,0 +1,15 @@
+import { UserEventTypeTypeEnum } from '../Enums/user-event-type-type.enum';
+import { UserEventTypeFrequencyEnum } from '../Enums/user-event-type-frequency.enum';
+import { UserEventSetting } from './user-event-setting';
+export declare class UserEventType {
+    type?: UserEventTypeTypeEnum;
+    name?: string;
+    byEmail?: boolean;
+    byNotification?: boolean;
+    frequency?: UserEventTypeFrequencyEnum;
+    counter?: number;
+    status?: number;
+    emailTemplate?: string;
+    id?: number;
+    settings?: UserEventSetting[];
+}

package/lib/db/Models/user-event.d.ts

@@ -0,0 +1,13 @@
+import { UserEventStatusEnum } from '../Enums/user-event-status.enum';
+import { User } from './user';
+import { UserEventType } from './user-event-type';
+export declare class UserEvent {
+    id?: number;
+    status?: UserEventStatusEnum;
+    counter?: number;
+    entityId?: number;
+    createdAt?: Date;
+    updatedAt?: Date;
+    user?: User;
+    userEventType?: UserEventType;
+}

package/lib/db/Models/user.d.ts

@@ -0,0 +1,51 @@
+import { UserTitleEnum } from '../Enums/user-title.enum';
+import { UserStatusEnum } from '../Enums/user-status.enum';
+import { UserRolesEnum } from '../Enums/user-roles.enum';
+import { Property } from './property';
+import { PropertySubscription } from './property-subscription';
+import { ServiceSubscription } from './service-subscription';
+import { UserEventSetting } from './user-event-setting';
+import { BankConnection } from './bank-connection';
+import { TaxReview } from './tax-review';
+import { PropertyOwner } from './property-owner';
+import { Address } from './address';
+import { Phone } from './phone';
+import { ClientMovement } from './client-movement';
+import { ClientDetails } from './client-details';
+import { EmployeeDetails } from './employee-details';
+export declare class User {
+    id?: number;
+    intercomId?: number;
+    createdAt?: Date;
+    updatedAt?: Date;
+    email?: string;
+    hashedEmail?: string;
+    password?: string;
+    firstName?: string;
+    lastName?: string;
+    title?: UserTitleEnum;
+    photo?: string;
+    status?: UserStatusEnum;
+    isConfirmed?: boolean;
+    verificationCode?: string;
+    referer?: User;
+    referenceCode?: string;
+    stripeId?: string;
+    basiqId?: string;
+    roles?: UserRolesEnum;
+    financialYear?: number;
+    dateOfBirth?: Date;
+    deletedAt?: Date;
+    properties?: Property[];
+    propertySubscriptions?: PropertySubscription[];
+    subscriptions?: ServiceSubscription[];
+    eventSettings?: UserEventSetting[];
+    bankConnections?: BankConnection[];
+    taxReviews?: TaxReview[];
+    ownerships?: PropertyOwner[];
+    address?: Address;
+    phone?: Phone;
+    clientMovements?: ClientMovement[];
+    clientDetails?: ClientDetails;
+    employeeDetails?: EmployeeDetails;
+}

package/lib/db/Models/vehicle-claim.d.ts

@@ -0,0 +1,11 @@
+import { VehicleClaimMethodEnum } from '../Enums/vehicle-claim-method.enum';
+import { User } from './user';
+export declare class VehicleClaim {
+    financialYear?: number;
+    method?: VehicleClaimMethodEnum;
+    kilometers?: number;
+    workUsage?: number;
+    isManual?: boolean;
+    id?: number;
+    user?: User;
+}

package/lib/db/Models/vehicle-logbook.d.ts

@@ -0,0 +1,16 @@
+import { VehicleLogbookPurposeEnum } from '../Enums/vehicle-logbook-purpose.enum';
+import { Vehicle } from './vehicle';
+import { User } from './user';
+export declare class VehicleLogbook {
+    date?: Date;
+    odometerStart?: number;
+    odometerEnd?: number;
+    purpose?: VehicleLogbookPurposeEnum;
+    description?: string;
+    id?: number;
+    createdAt?: Date;
+    updatedAt?: Date;
+    vehicle?: Vehicle;
+    createdBy?: User;
+    updatedBy?: User;
+}

package/lib/db/Models/vehicle.d.ts

@@ -0,0 +1,8 @@
+import { User } from './user';
+import { VehicleLogbook } from './vehicle-logbook';
+export declare class Vehicle {
+    name?: string;
+    id?: number;
+    user?: User;
+    logbook?: VehicleLogbook[];
+}

package/lib/functions/array/index.d.ts

@@ -0,0 +1,3 @@
+export * from './replace';
+export * from './sort';
+export * from './sort-deep';

package/lib/functions/array/replace.d.ts

@@ -0,0 +1 @@
+export declare function replace(array: any[], item: any, matchField?: string): void;

package/lib/functions/array/sort-deep.d.ts

@@ -0,0 +1 @@
+export declare function sortDeep(array: any[], fieldsQueue?: string[], isDesc?: boolean): void;

package/lib/functions/array/sort.d.ts

@@ -0,0 +1 @@
+export declare function sort(array: any[], field?: string, isDesc?: boolean): void;

package/lib/functions/clone-deep.d.ts

@@ -0,0 +1 @@
+export declare function cloneDeep(array: any): any;

package/lib/functions/create-date.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Create date from string entity (or return null if entity is not parsable)
+ * @param date
+ */
+export declare function createDate(date: string): Date;

package/lib/functions/enum-to-list.d.ts

@@ -0,0 +1,2 @@
+import { IOption } from '../interfaces/option.interface';
+export declare function enumToList(data: object): IOption[];

package/lib/functions/get-doc-icon.d.ts

@@ -0,0 +1,7 @@
+import { IAsset } from '../interfaces/asset.interface';
+import { IconsFileEnum } from '../models/file/icons-file.enum';
+/**
+ * Function which returns icon depends on document extension
+ * @param document
+ */
+export declare function getDocIcon(document: IAsset): IconsFileEnum;

package/lib/functions/mat-options-functions.d.ts

@@ -0,0 +1,2 @@
+export declare function compareMatOptions(option: any, value: any): boolean;
+export declare function displayMatOptions(option: object): string;

package/lib/functions/mat-sort-options.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Compare function, that used for sortData method
+ * @param a: first comparison argument
+ * @param b: second comparison argument
+ * @param isAsc: is ascending sorting flag
+ */
+export declare function compare(a: number | string, b: number | string, isAsc: boolean): number;

package/lib/functions/round-to.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Function which round value to the provided decimals
+ * @param value to be rounded
+ * @param decimals: amount of decimals
+ */
+export declare function roundTo(value: number, decimals?: number): number;

package/lib/functions/tax-review-filter-predicate.d.ts

@@ -0,0 +1,7 @@
+import { TaxReview } from '../models/tax-review/tax-review';
+/**
+ * Filter predicate function to search inside TaxReview class fields
+ * @param data in which query will be searched
+ * @param filter: search query
+ */
+export declare function taxReviewFilterPredicate(data: TaxReview, filter: string): boolean;

package/lib/interfaces/asset-entity-type.enum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Enum with asset entity types
+ */
+export declare enum AssetEntityTypeEnum {
+    PROPERTIES = "properties",
+    FOLDERS = "folders",
+    DEPRECIATIONS = "depreciations",
+    TRANSACTIONS = "transactions",
+    MESSAGES = "messages"
+}

package/lib/interfaces/asset-type.enum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Enum with asset types
+ */
+export declare enum AssetTypeEnum {
+    RECEIPTS = "receipts",
+    DOCUMENTS = "documents",
+    MESSAGE = "message"
+}

package/lib/interfaces/asset.interface.d.ts

@@ -0,0 +1,17 @@
+import { AssetTypeEnum } from './asset-type.enum';
+import { AssetEntityTypeEnum } from './asset-entity-type.enum';
+import { User } from '../models/user/user';
+/**
+ * Interface for assets (documents, receipts, e.t.c.)
+ */
+export interface IAsset {
+    id?: number;
+    type: AssetTypeEnum;
+    entityType: AssetEntityTypeEnum;
+    name?: string;
+    originalName?: string;
+    size?: number;
+    mimeType?: string;
+    createdAt?: Date;
+    user?: User;
+}

package/lib/interfaces/chart-data.interface.d.ts

@@ -0,0 +1,10 @@
+import { IChartSerie } from './chart-serie.interface';
+/**
+ *  @deprecated Use {@link ChartData} class instead
+ */
+export interface IChartData {
+    id?: number | string;
+    name: string;
+    data: IChartSerie[] | any;
+    zones?: object[];
+}

package/lib/interfaces/chart-serie.interface.d.ts

@@ -0,0 +1,8 @@
+/**
+ *  @deprecated Use {@link ChartSerie} class instead
+ */
+export interface IChartSerie {
+    label: string;
+    value: number;
+    order?: any;
+}

package/lib/interfaces/document.interface.d.ts

@@ -0,0 +1,18 @@
+import { Documentable } from './documentable.interface';
+/**
+ * Interface for documents
+ */
+export interface IDocument {
+    id?: number;
+    originalName?: string;
+    size?: number;
+    updatedAt?: Date;
+    /**
+     * Get document parent entity
+     */
+    getEntity(): Documentable;
+    /**
+     * Get API url prefix
+     */
+    getApiUrlPrefix(): string;
+}

package/lib/interfaces/documentable.interface.d.ts

@@ -0,0 +1,8 @@
+import { IDocument } from './document.interface';
+/**
+ * Interface for entities with documents
+ */
+export interface Documentable {
+    id?: number;
+    documents?: IDocument[];
+}

package/lib/interfaces/event-listener.interface.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for classes that subscribes on Event Dispatcher service
+ */
+export interface IEventListener {
+    /**
+     * Event Dispatcher Service .on() method listeners
+     */
+    listenEvents(): void;
+}

package/lib/interfaces/income-source-forecast.interface.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Interface for income source forecasts
+ */
+export interface IIncomeSourceForecast {
+    id: number;
+    tax: number;
+}

package/lib/interfaces/option.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IOption {
+    label: string;
+    value: any;
+}

package/lib/interfaces/photoable.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Interface that show if object has photo
+ */
+export interface Photoable {
+    /**
+     * Get link to object's photo
+     */
+    getPhoto(): string;
+    /**
+     * get object's initials for photo placeholder
+     */
+    getInitials(): string;
+}

package/lib/interfaces/receipt.interface.d.ts

@@ -0,0 +1,12 @@
+import { IAsset } from './asset.interface';
+import { ChartAccounts } from '../models/chart-accounts/chart-accounts';
+/**
+ * Interface that contains main fields for transaction-like classes
+ */
+export interface IReceipt {
+    id?: number;
+    amount?: number;
+    receipt: IAsset;
+    chartAccounts: ChartAccounts;
+    getDate(): Date;
+}

package/lib/interfaces/salary-forecast.interface.d.ts

@@ -0,0 +1,16 @@
+import { SalaryForecastFrequencyEnum } from '../db/Enums/salary-forecast-frequency.enum';
+import { IncomeSource } from '../models/income-source/income-source';
+/**
+ * Interface for income source forecasts that related to Salary category
+ */
+export interface ISalaryForecast {
+    id: number;
+    tax: number;
+    netPay: number;
+    grossAmount: number;
+    paygIncome: number;
+    financialYear: number;
+    frequency: SalaryForecastFrequencyEnum;
+    isTaxFree: boolean;
+    incomeSource: IncomeSource;
+}

package/lib/interfaces/tank.interface.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Interface, which should be implemented for tank-type checking
+ */
+export interface ITank {
+    isPropertyTank(): boolean;
+    isWorkTank(): boolean;
+}

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

@@ -0,0 +1,11 @@
+import { Address as AddressBase } from '../../db/Models/address';
+import { Country } from './country';
+import { AddressTypeEnum } from '../../db/Enums/address-type.enum';
+export declare class Address extends AddressBase {
+    country: Country;
+    suggestion: string;
+    type: AddressTypeEnum;
+    toString(): string;
+    get name(): string;
+    get nameLong(): string;
+}

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

@@ -0,0 +1,11 @@
+import { Country as CountryBase } from '../../db/Models/country';
+export declare class Country extends CountryBase {
+    /**
+     * Return country name with phone code
+     */
+    get countryWithCode(): string;
+    /**
+     * Check if country calling code is Australian or not
+     */
+    isAustralianCode(): boolean;
+}

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

@@ -0,0 +1,17 @@
+import { BankAccount } from './bank-account';
+import { IChartData } from '../../interfaces/chart-data.interface';
+/**
+ * bank account collection UI class with frontend specific data
+ */
+export declare class BankAccountChartData {
+    private bankAccounts;
+    constructor(bankAccounts: BankAccount[]);
+    /**
+     * set value of pie chart data
+     */
+    getBalancePieChartData(): IChartData[];
+    /**
+     * set value of bar chart data
+     */
+    getBalanceBarChartData(): IChartData[];
+}

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

@@ -0,0 +1,5 @@
+import { BankAccountProperty as BankAccountPropertyBase } from '../../db/Models/bank-account-property';
+import { Property } from '../property/property';
+export declare class BankAccountProperty extends BankAccountPropertyBase {
+    property: Property;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * Const which contains array of bank account types
+ */
+export declare const BANK_ACCOUNT_TYPES: {
+    key: number;
+    value: string;
+}[];

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

@@ -0,0 +1,72 @@
+import { BankAccount as BankAccountBase } from '../../db/Models/bank-account';
+import { Loan } from '../loan/loan';
+import { BankAccountBalance } from '../../db/Models/bank-account-balance';
+import { BankAccountProperty } from './bank-account-property';
+import { BankConnection } from './bank-connection';
+export declare class BankAccount extends BankAccountBase {
+    bankAccountProperties: BankAccountProperty[];
+    balances: BankAccountBalance[];
+    loan: Loan;
+    bankConnection: BankConnection;
+    /**
+     * Get current opening balance amount
+     */
+    getOpeningBalance(): number;
+    /**
+     * Get bank account balance for current financial year
+     */
+    getCurrentYearBalance(): BankAccountBalance;
+    /**
+     * check if bank account type is one of savings accounts
+     */
+    isSavingsAccount(): boolean;
+    /**
+     * check if bank account type is Loan
+     * @TODO nicole check
+     */
+    isLoan(): boolean;
+    /**
+     * check if bank account type is Credit card
+     */
+    isCreditCard(): boolean;
+    /**
+     * check if bank account related to work tank
+     */
+    isWorkTank(): boolean;
+    /**
+     * check if bank account related to work tank
+     */
+    isPropertyTank(): boolean;
+    /**
+     * Get Bank account property by id
+     * @param id Id of property
+     */
+    getPropertyById(id: number): BankAccountProperty;
+    /**
+     * check if bank account is related with passed property by id
+     * @param propertyId Property id for checking
+     */
+    hasProperty(propertyId: number): boolean;
+    /**
+     * Get decimal percentage for property
+     * @param propertyId Id of property
+     */
+    getPropertyPercentage(propertyId: number): number;
+    /**
+     * Get balance amount for property by id
+     * @param propertyId Id of property
+     */
+    getPropertyBalanceAmount(propertyId: number): number;
+    /**
+     * Check if bank account is active (has 'active' status or hasn't been paid out/refinanced)
+     */
+    isActive(): boolean;
+    /**
+     * first import (transactions) of basiq accounts
+     */
+    isFirstImport(): boolean;
+    /**
+     * Check if passed user id is owner of bank account
+     */
+    isOwner(userId: number): boolean;
+}

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

@@ -0,0 +1,7 @@
+import { BankConnection as BankConnectionBase } from '../../db/Models/bank-connection';
+import { BasiqJob } from './basiq-job';
+import { Bank } from './bank';
+export declare class BankConnection extends BankConnectionBase {
+    basiqJob: BasiqJob;
+    bank: Bank;
+}

package/lib/models/bank/bank-transaction-chart-data.d.ts

@@ -0,0 +1,30 @@
+import { BankTransaction } from './bank-transaction';
+import { IChartData } from '../../interfaces/chart-data.interface';
+import { MonthNumberEnum } from '../financial-year/month-number.enum';
+/**
+ * bank transactions collection UI class with frontend specific data
+ */
+export declare class BankTransactionChartData {
+    private bankTransactions;
+    constructor(bankTransactions: BankTransaction[]);
+    /**
+     * get value of bar chart data
+     */
+    getCashInOutBarChartData(months?: MonthNumberEnum[]): IChartData[];
+    /**
+     * get value of line chart data
+     */
+    getBalanceLineChartData(months?: MonthNumberEnum[]): IChartData[];
+    /**
+     * set bar chart data
+     */
+    private calculateCashInOutBarChartData;
+    /**
+     * set line chart data
+     */
+    private calculateBalanceLineChartData;
+    /**
+     * filter chart data for passed months
+     */
+    private filterChartDataByMonths;
+}

package/lib/models/bank/bank-transaction-summary-fields.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum BankTransactionSummaryFieldsEnum {
+    AMOUNT = "amount",
+    ALLOCATED_AMOUNT = "allocatedAmount"
+}

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

@@ -0,0 +1,38 @@
+import { BankTransaction as BankTransactionBase } from '../../db/Models/bank-transaction';
+import { TransactionOperationEnum } from '../../db/Enums/transaction-operation.enum';
+import { Transaction } from '../transaction/transaction';
+import { TransactionAllocationCollection } from '../../collections/transaction-allocation.collection';
+export declare class BankTransaction extends BankTransactionBase {
+    allocatedAmount: number;
+    unallocatedAmount: number;
+    operation: TransactionOperationEnum;
+    date: Date;
+    /**
+     * get allocated amount value but with +/- sign
+     */
+    get balanceAmount(): number;
+    /**
+     * check if bank transaction is debit
+     */
+    isDebit(): boolean;
+    /**
+     * check if bank transaction is credit
+     */
+    isCredit(): boolean;
+    /**
+     * Create Transaction instance based on Bank Transaction
+     */
+    toTransaction(): Transaction;
+    /**
+     * Check if bank transaction is completely allocated
+     */
+    isAllocated(allocations: TransactionAllocationCollection): boolean;
+    /**
+     * Get bank transaction allocated amount
+     */
+    getAllocatedAmount(allocations: TransactionAllocationCollection): number;
+    /**
+     * Get bank transaction unallocated amount
+     */
+    getUnallocatedAmount(allocations: TransactionAllocationCollection): number;
+}

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

@@ -0,0 +1,8 @@
+import { Bank as BankBase } from '../../db/Models/bank';
+import { Photoable } from '../../interfaces/photoable';
+export declare class Bank extends BankBase implements Photoable {
+    private environment;
+    constructor(environment: any);
+    getInitials(): string;
+    getPhoto(): string;
+}

package/lib/models/bank/basiq-job.d.ts

@@ -0,0 +1,3 @@
+import { BasiqJob as BasiqJobBase } from '../../db/Models/basiq-job';
+export declare class BasiqJob extends BasiqJobBase {
+}

package/lib/models/bank/basiq-token.d.ts

@@ -0,0 +1,9 @@
+/**
+ * access token, needed to access basiq connect ui (https://github.com/basiqio/basiq-connect-ui)
+ */
+export declare class BasiqToken {
+    value: string;
+    expiresAt: Date;
+    constructor(value: string, expiresAt: Date);
+    isExpired(): boolean;
+}

package/lib/models/bank/type-loan.const.d.ts

@@ -0,0 +1,2 @@
+import { BankAccountTypeEnum } from '../../db/Enums/bank-account-type.enum';
+export declare const TYPE_LOAN: BankAccountTypeEnum[];

package/lib/models/borrowing-expense/borrowing-expense-loan.d.ts

@@ -0,0 +1,3 @@
+import { BorrowingExpenseLoan as BorrowingExpenseLoanBase } from '../../db/Models/borrowing-expense-loan';
+export declare class BorrowingExpenseLoan extends BorrowingExpenseLoanBase {
+}

package/lib/models/borrowing-expense/borrowing-expense.d.ts

@@ -0,0 +1,3 @@
+import { BorrowingExpense as BorrowingExpenseBase } from '../../db/Models/borrowing-expense';
+export declare class BorrowingExpense extends BorrowingExpenseBase {
+}

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

@@ -0,0 +1,9 @@
+import { ChartSerie } from './chart-serie';
+/**
+ * Chart data class
+ * @TODO consider rename to ChartSerie
+ */
+export declare class ChartData {
+    name: string;
+    data: ChartSerie[];
+}

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

@@ -0,0 +1,8 @@
+/**
+ * Chart serie class: chart data item
+ * @TODO consider rename to ChartSerieData
+ */
+export declare class ChartSerie {
+    label: string;
+    value: number;
+}

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

@@ -0,0 +1,4 @@
+import { ChartAccountsCategoryEnum } from '../../db/Enums/chart-accounts-category.enum';
+export declare const CHART_ACCOUNTS_CATEGORIES: {
+    [key: string]: ChartAccountsCategoryEnum[];
+};