taxtank-core 2.0.1 → 2.0.3

package/src/lib/models/chat/message.d.ts

@@ -0,0 +1,22 @@
+import { Message as MessageBase } from '../../db/Models/firm/message';
+import { User } from '../user/user';
+import { MessageDocument } from './message-document';
+import { Chat } from './chat';
+export declare class Message extends MessageBase {
+    createdAt: Date;
+    employee: User;
+    chat: Chat;
+    documents: MessageDocument[];
+    /**
+     * Check if message created today or not
+     */
+    isToday(): boolean;
+    /**
+     * Check if message sent from firm
+     */
+    isFromEmployee(): boolean;
+    /**
+     * Check if message read
+     */
+    isRead(): boolean;
+}

package/src/lib/models/client/annual-client-details.d.ts

@@ -0,0 +1,14 @@
+import { AbstractModel } from '../../db/Models';
+import { ClientDetails } from './client-details';
+export declare class AnnualClientDetails extends AbstractModel {
+    privateHealthCare: boolean;
+    spouse: boolean;
+    spouseAnnualIncome: number;
+    dependants?: number;
+    studentLoanAmount?: number;
+    financialYear: number;
+    reportableFringeBenefits?: number;
+    exemptForeignEmploymentIncome?: number;
+    clientDetails: ClientDetails;
+    get spouseMonthlyIncome(): number;
+}

package/src/lib/models/client/capital-loss.d.ts

@@ -0,0 +1,9 @@
+import { CapitalLossInterface } from './capital-loss.interface';
+import { ClientDetails } from './client-details';
+import { AbstractModel } from '../../db/Models';
+export declare class CapitalLoss extends AbstractModel implements CapitalLossInterface {
+    clientDetails: ClientDetails;
+    financialYear: number;
+    balance: number;
+    isManual: boolean;
+}

package/src/lib/models/client/capital-loss.interface.d.ts

@@ -0,0 +1,6 @@
+export interface CapitalLossInterface {
+    clientDetails: object;
+    financialYear: number;
+    balance: number;
+    isManual: boolean;
+}

package/src/lib/models/client/client-details.d.ts

@@ -0,0 +1,11 @@
+import { ClientDetails as ClientDetailsBase } from '../../db/Models/client/client-details';
+export declare class ClientDetails extends ClientDetailsBase {
+    /**
+     * reminder to sign basiq consent after x days before the expiration
+     */
+    static consentExpiryReminderDays: number;
+    get taxFileNumberMasked(): string;
+    basiqConsentExpiryDate: Date;
+    isBasiqConsentExpiring(): boolean;
+    isBasiqConsentExpired(): boolean;
+}

package/src/lib/models/client/client-invite.d.ts

@@ -0,0 +1,36 @@
+import { ClientInvite as ClientInviteBase } from '../../db/Models/firm/client-invite';
+import { RegistrationInvite } from '../registration-invite/registration-invite';
+import { User } from '../user';
+import { Firm, FirmBranch } from '../firm';
+export declare class ClientInvite extends ClientInviteBase {
+    sentOn: Date;
+    updatedAt: Date;
+    client: User;
+    employee: User;
+    registrationInvite: RegistrationInvite;
+    firm: Firm;
+    firmBranch: FirmBranch;
+    /**
+     * Check if client invite status is pending
+     */
+    isPending(): boolean;
+    /**
+     * Check if client invite status is accepted
+     */
+    isAccepted(): boolean;
+    /**
+     * Check if client invite status is rejected
+     */
+    isRejected(): boolean;
+    /**
+     * Check if client invite initiated by firm
+     */
+    isFromEmployee(): boolean;
+    /**
+     * Check if client invite initiated by client
+     */
+    isFromClient(): boolean;
+    get firstName(): string;
+    get fullName(): string;
+    get email(): string;
+}

package/src/lib/models/client/client-movement.d.ts

@@ -0,0 +1,11 @@
+import { ClientMovement as ClientMovementBase } from '../../db/Models/firm/client-movement';
+import { Firm, FirmBranch } from '../firm';
+import { User } from '../user';
+export declare class ClientMovement extends ClientMovementBase {
+    client: User;
+    employee: User;
+    dateFrom: Date;
+    dateTo: Date;
+    firmBranch?: FirmBranch;
+    get firm(): Firm;
+}

package/src/lib/models/client/client-portfolio-chart-data.d.ts

@@ -0,0 +1,11 @@
+import { ClientPortfolioReportCollection } from '../../collections/client-portfolio-report.collection';
+import { ChartData } from '../chart/chart-data';
+/**
+ * Client portfolio charts data based on ClientPortfolioReportCollection
+ */
+export declare class ClientPortfolioChartData {
+    private clientsPortfolioReportCollection;
+    constructor(clientsPortfolioReportCollection: ClientPortfolioReportCollection);
+    getPieChartData(): ChartData[];
+    getBarChartData(): ChartData[];
+}

package/src/lib/models/client/client-portfolio-report.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Class describes client's portfolio report information
+ */
+import { AbstractModel } from '../../db/Models/abstract-model';
+export declare class ClientPortfolioReport extends AbstractModel {
+    category: string;
+    count: number;
+    marketValue: number;
+    loanBalance: number;
+    equityPosition: number;
+}

package/src/lib/models/client/index.d.ts

@@ -0,0 +1,8 @@
+export * from './annual-client-details';
+export * from './client-details';
+export * from './client-invite';
+export * from './client-movement';
+export * from './client-portfolio-chart-data';
+export * from './client-portfolio-report';
+export * from './capital-loss';
+export * from './capital-loss.interface';

package/src/lib/models/color/alphabet-colors.enum.d.ts

@@ -0,0 +1,28 @@
+export declare enum AlphabetColorsEnum {
+    A = "#9CC3D5",
+    B = "#E69A8D",
+    C = "#ED2B33",
+    D = "#E3CD81",
+    E = "#343148",
+    F = "#2C5F2D",
+    G = "#FFA177",
+    H = "#435E55",
+    I = "#2BAE66",
+    J = "#3C1053",
+    K = "#DD4132",
+    L = "#FC766A",
+    M = "#ADEFD1",
+    N = "#79C000",
+    O = "#D198C5",
+    P = "#5B84B1",
+    Q = "#A13941",
+    R = "#D85A7F",
+    S = "#00203F",
+    T = "#42EADD",
+    U = "#5F4B8B",
+    V = "#FDDB27",
+    W = "#CDB599",
+    X = "#4B878B",
+    Y = "#B0B8B4",
+    Z = "#E3C9CE"
+}

package/src/lib/models/date-range.d.ts

@@ -0,0 +1,8 @@
+/**
+ * custom DateRange because moment has problems with class-transformer
+ */
+export declare class DateRange {
+    start: Date;
+    end: Date;
+    constructor(start: Date, end: Date);
+}

package/src/lib/models/depreciation/depreciation-capital-project.d.ts

@@ -0,0 +1,4 @@
+import { DepreciationCapitalProject as DepreciationCapitalProjectBase } from '../../db/Models/depreciation/depreciation-capital-project';
+export declare class DepreciationCapitalProject extends DepreciationCapitalProjectBase {
+    effectiveDate: Date;
+}

package/src/lib/models/depreciation/depreciation-forecast.d.ts

@@ -0,0 +1,14 @@
+import { DepreciationForecast as DepreciationForecastBase } from '../../db/Models/depreciation/depreciation-forecast';
+export declare class DepreciationForecast extends DepreciationForecastBase {
+    isLVP: boolean;
+    amount: number;
+    closeBalance: number;
+    get dailyClaimAmount(): number;
+    get daysApplied(): number;
+    getDaysByMonth(month: number): number;
+    get claimOpenBalance(): number;
+    get claimCloseBalance(): number;
+    get claimAmount(): number;
+    get claimRate(): number;
+    getClaimAmountByMonth(month: number): number;
+}

package/src/lib/models/depreciation/depreciation-group-item.d.ts

@@ -0,0 +1,12 @@
+import { DepreciationGroup } from './depreciation-group';
+import { Depreciation } from './depreciation';
+/**
+ * @TODO Alex useless class, use parent instead
+ * Depreciation Tree node with depreciation details
+ */
+export declare class DepreciationGroupItem extends DepreciationGroup {
+    depreciation: Depreciation;
+    constructor(depreciation: Depreciation);
+    getClaimAmount(): number;
+    getAmount(): number;
+}

package/src/lib/models/depreciation/depreciation-group.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Depreciation Nested Tree node with depreciations group
+ */
+export declare class DepreciationGroup {
+    label: string;
+    description: string;
+    icon: string;
+    children: DepreciationGroup[];
+    totalCost: number;
+    openingValue: number;
+    constructor(label: string, description?: string, icon?: string, children?: DepreciationGroup[], totalCost?: number, openingValue?: number);
+    getClaimAmount(): number;
+    getAmount(): number;
+}

package/src/lib/models/depreciation/depreciation-group.enum.d.ts

@@ -0,0 +1,8 @@
+export declare enum DepreciationGroupEnum {
+    BUILDING_IMPROVEMENTS = 0,
+    PLANT_EQUIPMENT = 1,
+    LOW_VALUE_POOL = 2,
+    WRITTEN_OFF_ITEMS = 3,
+    BORROWING_EXPENSES = 4,
+    SMALL_BUSINESS_POOL = 5
+}

package/src/lib/models/depreciation/depreciation-groups.const.d.ts

@@ -0,0 +1,9 @@
+interface DepreciationGroup {
+    label: string;
+    description: string;
+    icon: string;
+}
+export declare const DEPRECIATION_GROUPS: {
+    [key: number]: DepreciationGroup;
+};
+export {};

package/src/lib/models/depreciation/depreciation-lvp-rate.enum.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Depreciation Low Value Pool rate based on asset financial year (current or subsequent years).
+ */
+export declare enum DepreciationLvpRateEnum {
+    FIRST_YEAR = 0.1875,
+    DEFAULT = 0.375
+}

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

@@ -0,0 +1,62 @@
+import { Depreciation as DepreciationBase } from '../../db/Models/depreciation/depreciation';
+import { DepreciationTypeEnum } from '../../db/Enums/depreciation-type.enum';
+import { DepreciationCapitalProject } from './depreciation-capital-project';
+import { DepreciationForecast } from './depreciation-forecast';
+import { ChartAccounts } from '../chart-accounts';
+import { BankTransaction } from '../bank';
+import { Transaction } from '../transaction';
+import { Expense } from '../../interfaces';
+/**
+ * @TODO Alex: clarify grouping rules and refactor
+ */
+export declare class Depreciation extends DepreciationBase implements Expense {
+    static writtenOffThreshold: number;
+    static lowValuePoolThreshold: number;
+    date: Date;
+    claimStartDate: Date;
+    lowValuePoolDate: Date;
+    writeOffManualDate: Date;
+    writeOffDate: Date;
+    depreciationCapitalProject: DepreciationCapitalProject;
+    forecasts: DepreciationForecast[];
+    chartAccounts: ChartAccounts;
+    bankTransaction: BankTransaction;
+    type: DepreciationTypeEnum;
+    amount: number;
+    isCapital(): boolean;
+    isBorrowingExpense(): boolean;
+    isAsset(): boolean;
+    isSBPCalculation(): boolean;
+    isPrimeCost(): boolean;
+    isDiminishing(): boolean;
+    isPlantEquipmentPool(): boolean;
+    isLVP(): boolean;
+    isSBP(): boolean;
+    isWrittenOff(): boolean;
+    get writeOffYear(): number;
+    /**
+     * Check if depreciation chart accounts heading related to vehicles category
+     */
+    isVehicleDepreciation(): boolean;
+    /**
+     * @TODO Vik: Research a problem with depreciations without current year forecast
+     */
+    get currentYearForecast(): DepreciationForecast;
+    getForecastByYear(year: number): DepreciationForecast;
+    getClaimAmountByYear(year: number): number;
+    getCloseBalanceByYear(year: number): number;
+    /**
+     * Create a new transaction from current depreciation
+     */
+    toTransaction(params?: {}): Transaction;
+    /**
+     * @TODO Michael: remove and check everywhere in reports
+     */
+    get claimAmount(): number;
+    get amountWithGst(): number;
+    get gstClaimAmount(): number;
+    /**
+     * assets purchased in the current financial year
+     */
+    isCurrentYearBuy(): boolean;
+}

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

@@ -0,0 +1,8 @@
+export * from './depreciation-capital-project';
+export * from './depreciation-forecast';
+export * from './depreciation-group-item';
+export * from './depreciation-group.enum';
+export * from './depreciation-group';
+export * from './depreciation-groups.const';
+export * from './depreciation-lvp-rate.enum';
+export * from './depreciation';

package/src/lib/models/dictionary/dictionary.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @TODO refactor with Map or Record
+ * List of objects grouped by passed property
+ */
+export declare class Dictionary<Model> {
+    items: {
+        [key: string]: Model;
+    };
+    constructor(items?: Model[], path?: string);
+    add(key: string | number, value: Model): Dictionary<Model>;
+    get(key: string | number): Model;
+    merge(dictionary: Dictionary<Model>): this;
+    toArray(): Model[];
+    private groupItems;
+    get keys(): string[];
+    get length(): number;
+}

package/src/lib/models/dictionary/index.d.ts

@@ -0,0 +1 @@
+export * from './dictionary';

package/src/lib/models/document/document-api-url-prefix.enum.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Enum with document types which used to API url prefix
+ */
+export declare enum DocumentApiUrlPrefixEnum {
+    FOLDERS = "folders",
+    PROPERTIES = "properties"
+}

package/src/lib/models/document/document-file-types.const.d.ts

@@ -0,0 +1,3 @@
+export declare const DOCUMENT_FILE_TYPES: {
+    [key: string]: string[];
+};

package/src/lib/models/document/document-folder.d.ts

@@ -0,0 +1,3 @@
+import { DocumentFolder as DocumentFolderBase } from '../../db/Models/document/document-folder';
+export declare class DocumentFolder extends DocumentFolderBase {
+}

package/src/lib/models/document/document.d.ts

@@ -0,0 +1,9 @@
+import { FolderDocument as FolderDocumentBase } from '../../db/Models/document/folder-document';
+import { DocumentFolder } from './document-folder';
+import { DocumentInterface } from '../../interfaces';
+import { AppFile } from '../file';
+export declare class Document extends FolderDocumentBase implements DocumentInterface {
+    folder: DocumentFolder;
+    file: AppFile;
+    get parent(): DocumentFolder;
+}

package/src/lib/models/document/index.d.ts

@@ -0,0 +1,4 @@
+export * from './document';
+export * from './document-api-url-prefix.enum';
+export * from './document-file-types.const';
+export * from './document-folder';

package/src/lib/models/employee/employee-details.d.ts

@@ -0,0 +1,7 @@
+import { EmployeeDetails as EmployeeDetailsBase } from '../../db/Models/user/employee-details';
+import { Firm, FirmBranch } from '../firm';
+export declare class EmployeeDetails extends EmployeeDetailsBase {
+    firm: Firm;
+    firmBranches: FirmBranch[];
+    get firmBranchNames(): string;
+}

package/src/lib/models/employee/employee-invite.d.ts

@@ -0,0 +1,13 @@
+import { EmployeeInvite as EmployeeInviteBase } from '../../db/Models/firm/employee-invite';
+import { RegistrationInvite } from '../registration-invite/registration-invite';
+import { User } from '../user';
+import { FirmBranch } from '../firm';
+export declare class EmployeeInvite extends EmployeeInviteBase {
+    registrationInvite: RegistrationInvite;
+    employee: User;
+    firmBranches?: FirmBranch[];
+    get firmBranchNames(): string;
+    get invitedFullName(): string;
+    get inviterFullName(): string;
+    get createdAt(): Date;
+}

package/src/lib/models/endpoint/endpoint.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Available request methods
+ */
+declare type RequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+/**
+ * Backend endpoint class
+ */
+export declare class Endpoint {
+    method: RequestMethod;
+    pattern: string;
+    constructor(method: RequestMethod, pattern: string);
+    /**
+     * check url with regexp
+     * @param url
+     */
+    test(url: string): boolean;
+    /**
+     * Get regexp for endpoint
+     */
+    get regexp(): RegExp;
+}
+export {};

package/src/lib/models/endpoint/endpoints.const.d.ts

@@ -0,0 +1,8 @@
+import { Endpoint } from './endpoint';
+/**
+ * List of all app endpoints
+ * @TODO Alex/Vik: Create some smart system for preloader endpoints.
+ */
+export declare const ENDPOINTS: {
+    [key: string]: Endpoint;
+};

package/src/lib/models/event/app-event-type.enum.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @TODO Alex remove
+ */
+export declare enum AppEventTypeEnum {
+    CLIENT_MOVEMENT_CLOSED = 0,
+    BANK_CONNECTION_ADDED = 1,
+    BANK_TRANSACTION_ALLOCATED = 2,
+    BANK_TRANSACTIONS_ADDED = 3,
+    BANK_TRANSACTIONS_DELETED = 4,
+    BASIQ_CONNECTION_UPDATED = 5,
+    BASIQ_JOB_CREATED = 6,
+    BASIQ_LOGIN_SUCCESS = 7,
+    BASIQ_LOGIN_FAILED = 8,
+    BASIQ_ACCOUNTS_RETRIEVED = 9,
+    CLIENT_INVITE_ACCEPTED = 10,
+    CLIENT_OPEN_CHAT = 11,
+    CLIENT_TRANSFER_TO_OTHER_EMPLOYEE = 12,
+    CURRENT_USER_GET_FAILED = 13,
+    DEPRECIATION_DELETED = 14,
+    DEPRECIATIONS_CREATED = 15,
+    INCOME_SOURCES_CREATED = 16,
+    INCOME_SOURCES_UPDATED = 17,
+    INCOME_SOURCES_FORECASTS_CREATED = 18,
+    INCOME_SOURCES_FORECASTS_UPDATED = 19,
+    LOAN_UPDATED = 20,
+    LOAN_PAYOUT_UPDATED = 21,
+    MESSAGE_CREATED = 22,
+    MESSAGE_FILE_CREATED = 23,
+    MESSAGE_FILE_DELETED = 24,
+    NOTIFICATION_ADDED = 25,
+    PROPERTY_DEPRECIATION_CALCULATION_UPDATED = 26,
+    PROPERTY_UPDATED = 27,
+    PROPERTY_UPDATED_WITH_DOCUMENT = 28,
+    PROPERTY_DOCUMENT_ADDED = 29,
+    PROPERTY_MOVEMENT_CREATED = 30,
+    PROPERTY_MOVEMENT_UPDATED = 31,
+    PROPERTY_MOVEMENT_DELETED = 32,
+    PROPERTY_SALE_ADDED = 33,
+    PROPERTY_SALE_DELETED = 34,
+    PROPERTY_SUBSCRIPTION_ADDED = 35,
+    PROPERTY_SUBSCRIPTION_DELETED = 36,
+    PROPERTY_VALUATION_DOCUMENT_CREATED = 37,
+    SOLE_DEPRECIATION_METHOD_UPDATED = 38,
+    SOLE_INVOICE_PUBLISHED = 39,
+    TAX_REVIEW_UPDATED = 40,
+    TRANSACTION_ALLOCATION_CREATED = 41,
+    TRANSACTION_ALLOCATION_DELETED = 42,
+    TRANSACTION_CREATED = 43,
+    TRANSACTION_DELETED = 44,
+    TRANSACTION_UPDATED = 45,
+    TRANSACTIONS_CREATED = 46,
+    VEHICLE_CLAIM_DETAILS_UPDATED = 47,
+    VEHICLE_CLAIM_DETAILS_CREATED = 48,
+    VEHICLE_LOGBOOK_CREATED = 49,
+    VEHICLE_LOGBOOK_UPDATED = 50,
+    VEHICLE_LOGBOOK_DELETED = 51,
+    VEHICLE_LOGBOOK_BEST_PERIOD_UPDATED = 52
+}

package/src/lib/models/event/app-event.d.ts

@@ -0,0 +1,18 @@
+import { ObservableModel } from '../../db/Models/observable-model';
+import { AppEventTypeEnum } from './app-event-type.enum';
+/**
+ * any event happened in the app, which needs to be handled somehow (distributed to other part of the app)
+ */
+export declare class AppEvent<T> {
+    type: AppEventTypeEnum;
+    payload: T;
+    constructor(type: AppEventTypeEnum, payload: T);
+}
+/**
+ * @TODO Alex (TT-1777): temp name, replace AppEvent or rename this class when all services refactored
+ */
+export declare class AppEvent2 {
+    name: string;
+    items: ObservableModel[];
+    constructor(name: string, items: ObservableModel[]);
+}

package/src/lib/models/event/index.d.ts

@@ -0,0 +1,2 @@
+export * from './app-event-type.enum';
+export * from './app-event';

package/src/lib/models/export/export-cell-type.enum.d.ts

@@ -0,0 +1,9 @@
+/**
+ * type of export table column value
+ */
+export declare enum ExportCellTypeEnum {
+    STRING = 0,
+    CURRENCY = 1,
+    DATE = 2,
+    PERCENT = 3
+}

package/src/lib/models/export/export-cell.d.ts

@@ -0,0 +1,8 @@
+import { ExportCellTypeEnum } from './export-cell-type.enum';
+/**
+ * export table column
+ */
+export declare class ExportCell {
+    value: any;
+    type: ExportCellTypeEnum;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Data table structure suitable for export
+ */
+import { ExportCell } from './export-cell';
+export declare class ExportDataTable {
+    caption?: string;
+    header: string[];
+    body: ExportCell[][];
+    footer: ExportCell[][];
+}

package/src/lib/models/export/export-format.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum ExportFormatEnum {
+    PDF = "PDF",
+    XLSX = "XLSX"
+}

package/src/lib/models/file/file.d.ts

@@ -0,0 +1,10 @@
+import { File } from '../../db/Models';
+/**
+ * The model renamed for more comfortable work because File already exist in JS
+ * @TODO Alex: consider a better name like document
+ */
+export declare class AppFile extends File {
+    static imageMimeTypes: string[];
+    isImage(): boolean;
+    get month(): string;
+}

package/src/lib/models/file/icons-file.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum IconsFileEnum {
+    JPG = "icon-image-jpg",
+    PDF = "icon-doc-pdf",
+    DOC = "icon-doc"
+}

package/src/lib/models/file/index.d.ts

@@ -0,0 +1 @@
+export * from './file';

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

@@ -0,0 +1,22 @@
+export declare class FinancialYear {
+    static weeksInYear: number;
+    static monthsInYear: number;
+    static startMonthIndex: number;
+    static get year(): number;
+    year: number;
+    startDate: Date;
+    endDate: Date;
+    private yearStartDate;
+    private yearEndDate;
+    constructor(date?: Date | number);
+    static isCurrent(year?: number): boolean;
+    includes(date: Date): boolean;
+    static toFinYear(date: Date): number;
+    /**
+     * Get date by desired month
+     */
+    getMonthDate(monthIndex: number): Date;
+    private setStartDate;
+    private setEndDate;
+    getPastMonths(): number[];
+}

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

@@ -0,0 +1,4 @@
+export * from './financial-year';
+export * from './month-name-short.enum';
+export * from './month-number.enum';
+export * from './months.const';

package/src/lib/models/financial-year/month-name-short.enum.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @TODO move to pipe/translation
+ * enum with months short names.
+ * Order of items match with financial year months order
+ */
+export declare enum MonthNameShortEnum {
+    JULY = "Jul",
+    AUGUST = "Aug",
+    SEPTEMBER = "Sep",
+    OCTOBER = "Oct",
+    NOVEMBER = "Nov",
+    DECEMBER = "Dec",
+    JANUARY = "Jan",
+    FEBRUARY = "Feb",
+    MARCH = "Mar",
+    APRIL = "Apr",
+    MAY = "May",
+    JUNE = "Jun"
+}