taxtank-core 0.17.0 → 0.17.1

package/lib/collections/tax-summary/report-item.collection.d.ts

@@ -1,68 +1,34 @@
 import { Collection } from '../collection';
 import { ReportItem } from '../../models/tax-summary/report-item';
-import { TaxReturnCategorySectionEnum } from '../../db/Enums/tax-return-category-section.enum';
+import { TaxReturnCategoryListEnum } from '../../db/Enums/tax-return-category-list.enum';
+import { ReportItemDetails } from '../../models/tax-summary/report-item-details';
+import { TaxSummarySectionEnum } from '../../db/Enums/tax-summary-section.enum';
+import { IncomeSource } from '../../models/income-source/income-source';
 /**
  * collection for tax return category items
  */
 export declare class ReportItemCollection extends Collection<ReportItem> {
     /**
-     * Work income
+     * Recursively get collection of report items by Tax Summary Section.
+     * Search items which has details
      */
-    get salary(): number;
+    getBySection(section: TaxSummarySectionEnum): ReportItemCollection;
     /**
-     * Work expenses
+     * Recursively find report item by Tax Return Category ID
      */
-    get workExpenses(): number;
+    findByCategory(categoryId: TaxReturnCategoryListEnum): ReportItem;
     /**
-     * Property income
+     * Get Collection of report items by Tax Return Categories IDs
      */
-    get rentalIncome(): number;
+    getByCategories(categories: TaxReturnCategoryListEnum[]): ReportItemCollection;
     /**
-     * Property rental deductions
+     * A short call to a chain of methods that we often use.
+     * Get total amount of report items by Tax Return categories and Tax Summary Section.
      */
-    get rentalDeductions(): number;
+    sumByCategoriesAndSection(categories: TaxReturnCategoryListEnum[], section: TaxSummarySectionEnum): number;
     /**
-     * Property expenses
+     * Get collection of all report item details related to passed income source
+     * @TODO Alex: consider to create and move to ReportItemDetailsCollection
      */
-    get propertyExpenses(): number;
-    /**
-     * Property interest
-     */
-    get interestDeductions(): number;
-    /**
-     * Property capital works depreciations
-     */
-    get capitalWorks(): number;
-    /**
-     * Property plant & equipment depreciations
-     */
-    get plantEquipment(): number;
-    /**
-     * Total property depreciaions
-     */
-    get propertyDepreciations(): number;
-    get partnershipsAndTrusts(): number;
-    get pciAndSbeIncome(): number;
-    get capitalGains(): number;
-    get foreignSourceIncome(): number;
-    /**
-     * Other income
-     */
-    get otherIncome(): number;
-    /**
-     * Other expenses
-     */
-    get otherDeductions(): number;
-    get taxInstalments(): number;
-    get frankingCredits(): number;
-    get taxOffsets(): number;
-    get borrowingExpenses(): number;
-    get grossTaxPayable(): number;
-    /**
-     * taxWithheld by section (work or other)
-     */
-    getTaxWithheld(section?: TaxReturnCategorySectionEnum): number;
-    getTaxCreditsCollection(): ReportItemCollection;
-    getTotalAmountByIncomeSourceName(name: string): number;
-    private getByCategory;
+    getDetailsByIncomeSource(incomeSource: IncomeSource): Collection<ReportItemDetails>;
 }

package/lib/collections/tax-summary/tax-return-categories.const.d.ts

@@ -0,0 +1,6 @@
+import { TaxReturnCategoryListEnum } from '../../db/Enums/tax-return-category-list.enum';
+export declare const TAX_RETURN_CATEGORIES: {
+    [key: string]: {
+        [key: string]: TaxReturnCategoryListEnum[];
+    };
+};

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

@@ -1,26 +1,40 @@
 export declare enum TaxReturnCategoryListEnum {
     SALARY = 1,
+    ALLOWANCES_EARNINGS_TIPS_DIRECTOR_FEES = 30,
+    EMPLOYER_LUMP_SUM_PAYMENTS = 31,
+    ETP = 32,
+    GOVERNMENT_ALLOWANCES = 2,
+    GOVERNMENT_PENSIONS = 33,
+    ANNUITIES_SUPER_INCOME_STREAMS = 3,
+    SUPERANNUATION_LUMP_SUM_PAYMENTS = 34,
+    ATTRIBUTED_PSI_INCOME = 4,
     WORK_EXPENSES = 7,
     GROSS_RENT = 8,
+    OTHER_RENTAL_DEDUCTIONS = 12,
     INTEREST_DEDUCTIONS = 9,
     CAPITAL_WORKS = 10,
     DEPRECIATION = 11,
-    OTHER_RENTAL_DEDUCTIONS = 12,
-    BORROWING_EXPENSES = 29,
+    GROSS_INTEREST = 5,
+    DIVIDENDS = 6,
+    SHARE_SCHEMES = 35,
     PARTNERSHIPS_TRUSTS = 13,
-    PCI_SBE_INCOME = 14,
+    PSI_SBE_INCOME = 14,
+    SOLE_TRADER_BUSINESS_INCOME = 38,
     CAPITAL_GAINS = 15,
     FOREIGN_SOURCE_INCOME = 16,
-    OTHER_INCOME = 17,
+    BONUSES_FROM_LIFE_INSURANCE = 17,
+    FORESTRY_MANAGED_INVESTMENT_SCHEMES = 39,
+    OTHER_INCOME = 40,
+    TAX_CREDITS = 23,
     OTHER_DEDUCTIONS = 18,
+    TAX_OFFSETS = 27,
+    BORROWING_EXPENSES = 29,
     GROSS_TAX_PAYABLE = 19,
     TAX_ON_TAXABLE_INCOME = 20,
     MEDICARE = 21,
     STUDENT_LOAN_REPAYMENT = 22,
-    TAX_CREDITS = 23,
     TAX_WITHHELD = 24,
     TAX_INSTALMENTS = 25,
     FRANKING_CREDITS = 26,
-    TAX_OFFSETS = 27,
     TAX_PAYABLE = 28
 }

package/lib/models/tax-summary/report-item.d.ts

@@ -1,5 +1,6 @@
 import { TaxReturnCategory } from '../../db/Models/tax-return/tax-return-category';
 import { ReportItemDetails } from './report-item-details';
+import { ReportItemCollection } from '../../collections/tax-summary/report-item.collection';
 /**
  * Used in tax summary reports to show amounts relating to a tax return category entity and details of what this
  * amount is comprised of. Example here shows an amount of $951.96 and also details of what this amount is comprised of:
@@ -7,9 +8,9 @@ import { ReportItemDetails } from './report-item-details';
 export declare class ReportItem {
     amount: number;
     details: ReportItemDetails[];
-    items: ReportItem[];
     taxReturnCategory: TaxReturnCategory;
-    taxWithheld: number;
+    title: string;
+    items: ReportItemCollection;
     /**
      * Get amount for one income source
      * @param name Name of income source for filter

package/package.json

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

package/public-api.d.ts

@@ -27,6 +27,7 @@ export * from './lib/collections/report/property/property-report-item-depreciati
 export * from './lib/collections/report/vehicle-expense/vehicle-expense.collection';
 export * from './lib/collections/subscription/service-subscription.collection';
 export * from './lib/collections/tax-summary/report-item.collection';
+export * from './lib/collections/tax-summary/tax-return-categories.const';
 export * from './lib/collections/tax-review.collection';
 export * from './lib/collections/transaction/transaction-allocation.collection';
 export * from './lib/collections/transaction/transaction.collection';