@zeniai/client-epic-state 5.1.18-betaDI1 → 5.1.18-betaDI3

package/lib/commonStateTypes/projectView/projectViewParentID.d.ts

@@ -0,0 +1,5 @@
+import { ID } from '../common';
+export interface ProjectsViewParentID {
+    projectId: ID;
+    sectionId: ID;
+}

package/lib/commonStateTypes/projectView/projectViewParentID.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/commonStateTypes/recommendationBase.d.ts

@@ -0,0 +1,52 @@
+import { RecommendedVendorBasePayload } from '../commonPayloadTypes/vendorRecommendationPayload';
+import { RecommendedAccountBase, RecommendedAccountBaseWithCOT } from '../entity/account/accountState';
+import { RecommendedClassBase, RecommendedClassBaseWithCOT } from '../entity/class/classState';
+import { ID } from './common';
+import { RecommendedVendorBase, RecommendedVendorBaseWithCOT } from './vendorRecommendation';
+export interface RecommendationBase {
+    min: number;
+    reason: string;
+    max?: number;
+    recommendationHash?: ID;
+    type?: string;
+}
+export type TransactionLineRecommendationFieldTypes = 'vendor' | 'category' | 'class' | 'project';
+export interface Recommendation {
+    account?: RecommendedAccountBase;
+    class?: RecommendedClassBase;
+    vendor?: RecommendedVendorBase;
+}
+export interface RecommendationWithCOT {
+    account?: RecommendedAccountBaseWithCOT;
+    class?: RecommendedClassBaseWithCOT;
+    vendor?: RecommendedVendorBaseWithCOT;
+}
+export declare const getRecommendationAmountRange: (amountValue: number) => {
+    min: number;
+    max?: number;
+};
+export declare const mapRecommendedVendorPayloadToBase: (payload: RecommendedVendorBasePayload) => RecommendedVendorBase;
+/**
+ * Interface for tracking COT recommendation types viewed
+ */
+export interface COTRecommendationTracking {
+    recommendationTypesViewed: string[];
+}
+/**
+ * Interface for tracking COT line item data
+ */
+export interface COTLineItemTracking {
+    category: COTRecommendationTracking;
+    class: COTRecommendationTracking;
+    lineId: ID;
+    vendor: COTRecommendationTracking;
+    project?: COTRecommendationTracking;
+}
+/**
+ * Type for COT tracking state (array of line items)
+ */
+export type COTTransactionTracking = COTLineItemTracking[];
+/**
+ * Type for COT transaction tracking (Record of transaction ID to line items)
+ */
+export type COTTransactionTrackingByTransactionId = Record<ID, COTLineItemTracking[]>;

package/lib/commonStateTypes/recommendationBase.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapRecommendedVendorPayloadToBase = exports.getRecommendationAmountRange = void 0;
+const zeniUrl_1 = require("../zeniUrl");
+const getRecommendationAmountRange = (amountValue) => {
+    if (amountValue >= 0 && amountValue < 100) {
+        return {
+            min: 0,
+            max: 100,
+        };
+    }
+    if (amountValue >= 100 && amountValue < 500) {
+        return {
+            min: 100,
+            max: 500,
+        };
+    }
+    if (amountValue >= 500 && amountValue < 1000) {
+        return {
+            min: 5000,
+            max: 1000,
+        };
+    }
+    if (amountValue >= 1000 && amountValue < 2000) {
+        return {
+            min: 1000,
+            max: 2000,
+        };
+    }
+    if (amountValue >= 2000) {
+        return {
+            min: 2000,
+        };
+    }
+    return {
+        min: 0,
+        max: 0,
+    };
+};
+exports.getRecommendationAmountRange = getRecommendationAmountRange;
+const mapRecommendedVendorPayloadToBase = (payload) => {
+    return {
+        name: payload.vendor_name,
+        thirdPartyMerchantId: payload.third_party_merchant_id ?? undefined,
+        id: payload.vendor_id ?? undefined,
+        qboId: payload.qbo_id ?? undefined,
+        reason: payload.reason ?? undefined,
+        type: payload.type ?? undefined,
+        recommendationHash: payload.recommendation_hash ?? undefined,
+        vendorNameConfidence: payload.vendor_name_confidence,
+        logo: Boolean(payload.logo?.url) === true
+            ? (0, zeniUrl_1.toZeniUrlWithoutBaseURL)(payload.logo?.url)
+            : undefined,
+        websiteUrl: payload.website_url != null
+            ? (0, zeniUrl_1.toZeniUrlWithoutBaseURL)(payload.website_url)
+            : undefined,
+    };
+};
+exports.mapRecommendedVendorPayloadToBase = mapRecommendedVendorPayloadToBase;

package/lib/commonStateTypes/selectorTypes/sortOrderTypes.d.ts

@@ -0,0 +1,3 @@
+declare const toSortOrderType: (v: string) => "ascending" | "descending";
+export type SortOrder = ReturnType<typeof toSortOrderType>;
+export {};

package/lib/commonStateTypes/selectorTypes/sortOrderTypes.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const stringToUnion_1 = require("../stringToUnion");
+const SORT_ORDERS = ['ascending', 'descending'];
+const toSortOrderType = (v) => (0, stringToUnion_1.stringToUnion)(v, SORT_ORDERS); // eslint-disable-line @typescript-eslint/no-unused-vars

package/lib/commonStateTypes/status.d.ts

@@ -0,0 +1,9 @@
+import { ZeniDate } from '../zeniDayJS';
+export interface Status {
+    code: number;
+    description: string;
+    message: string;
+    isFilteredReport?: boolean;
+    lastRefreshAttemptTime?: ZeniDate;
+    lastRefreshSuccessTime?: ZeniDate;
+}

package/lib/commonStateTypes/status.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/commonStateTypes/stringToUnion.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Safely convert a string value into string union type.
+ * @param s string value
+ * @param u tuple containing all the values in a string union
+ * @returns value of type union
+ * @note Outputs error to console if incoming string is not part of string union!
+ */
+export declare function stringToUnion<U extends ReadonlyArray<string>>(s: string, u: U): (typeof u)[number];
+/**
+ * Convert a string value into string union type.
+ * @param s string value
+ * @param u tuple containing all the values in a string union
+ * @returns value of type union or undefined if income string is not part of union
+ * @note Outputs error to console if incoming string is not part of string union!
+ */
+export declare function stringToUnionStrict<U extends ReadonlyArray<string>>(s: string, u: U): (typeof u)[number] | undefined;

package/lib/commonStateTypes/stringToUnion.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringToUnion = stringToUnion;
+exports.stringToUnionStrict = stringToUnionStrict;
+/**
+ * Safely convert a string value into string union type.
+ * @param s string value
+ * @param u tuple containing all the values in a string union
+ * @returns value of type union
+ * @note Outputs error to console if incoming string is not part of string union!
+ */
+function stringToUnion(s, u) {
+    const unionValue = u.find((value) => value == s);
+    if (unionValue != null) {
+        return unionValue;
+    }
+    else {
+        console.error(`Value ${s} not part of ${JSON.stringify(u)}`);
+        return s;
+    }
+}
+/**
+ * Convert a string value into string union type.
+ * @param s string value
+ * @param u tuple containing all the values in a string union
+ * @returns value of type union or undefined if income string is not part of union
+ * @note Outputs error to console if incoming string is not part of string union!
+ */
+function stringToUnionStrict(s, u) {
+    const unionValue = u.find((value) => value == s);
+    if (unionValue != null) {
+        return unionValue;
+    }
+    else {
+        return undefined;
+    }
+}

package/lib/commonStateTypes/timePeriod.d.ts

@@ -0,0 +1,51 @@
+export declare const SCHEDULE_DAYS_OF_MONTH: readonly [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28];
+export declare const toScheduleDaysOfMonth: (n: number) => 1 | 3 | 12 | 2 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28;
+export type ScheduleDaysOfMonth = ReturnType<typeof toScheduleDaysOfMonth>;
+export declare const MIN_SCHEDULE_DAY_OF_MONTH = 1;
+export declare const MAX_SCHEDULE_DAY_OF_MONTH = 28;
+export declare const LAST_SCHEDULE_DAY_OF_MONTH = 31;
+declare const toDay: (n: number) => 1 | 3 | 12 | 2 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 31 | 29 | 30;
+export type Day = ReturnType<typeof toDay>;
+export declare const toMonth: (n: number) => 1 | 3 | 12 | 2 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11;
+export declare const toMonthStrict: (n: number) => 1 | 3 | 12 | 2 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | undefined;
+export type Month = ReturnType<typeof toMonth>;
+export declare const getMonthFromMonthName: (month: string | undefined, localeID?: string) => Month | undefined;
+export declare const toQuarter: (n: number) => 1 | 3 | 2 | 4;
+export declare const toQuarterStrict: (n: number) => 1 | 3 | 2 | 4 | undefined;
+export type Quarter = ReturnType<typeof toQuarter>;
+/**
+ * Day identified by day-month-year, but without any time zone!
+ */
+export interface AbsoluteDay {
+    day: Day;
+    month: Month;
+    year: number;
+}
+export interface MonthYearPeriod {
+    month: Month;
+    year: number;
+}
+export type MonthYearPeriodId = `${Month}_${number}`;
+export type MonthYearPeriodQuery = `${Month}-${number}`;
+export declare const toMonthYearPeriod: (periodPayload: string) => MonthYearPeriod;
+export declare const toMonthYearPeriodQuery: (selectedPeriod: MonthYearPeriod) => MonthYearPeriodQuery;
+export declare const toMonthYearPeriodId: (selectedPeriod: MonthYearPeriod) => MonthYearPeriodId;
+/**
+ * Convert to start: string; end: string in the format yyyy-mm-dd
+ * @param period - MonthYearPeriod
+ */
+export declare function convertToPeriod(period: MonthYearPeriod, useEndOfCurrentMonth?: boolean): {
+    end: string;
+    start: string;
+};
+/**
+ * Convert to absolute day
+ * @param dateString in the format yyyy-mm-dd
+ */
+export declare function toAbsoluteDay(dateString: string): AbsoluteDay | undefined;
+export declare const toString: (day: AbsoluteDay) => string;
+export interface TimePeriod {
+    end: AbsoluteDay;
+    start: AbsoluteDay;
+}
+export {};

package/lib/commonStateTypes/timePeriod.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toString = exports.toMonthYearPeriodId = exports.toMonthYearPeriodQuery = exports.toMonthYearPeriod = exports.toQuarterStrict = exports.toQuarter = exports.getMonthFromMonthName = exports.toMonthStrict = exports.toMonth = exports.LAST_SCHEDULE_DAY_OF_MONTH = exports.MAX_SCHEDULE_DAY_OF_MONTH = exports.MIN_SCHEDULE_DAY_OF_MONTH = exports.toScheduleDaysOfMonth = exports.SCHEDULE_DAYS_OF_MONTH = void 0;
+exports.convertToPeriod = convertToPeriod;
+exports.toAbsoluteDay = toAbsoluteDay;
+const zeniDayJS_1 = require("../zeniDayJS");
+const formatZeniDateFY_1 = require("./fiscalYearHelpers/formatZeniDateFY");
+const numberToUnion_1 = require("./numberToUnion");
+exports.SCHEDULE_DAYS_OF_MONTH = [
+    1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,
+    23, 24, 25, 26, 27, 28,
+];
+const toScheduleDaysOfMonth = (n) => (0, numberToUnion_1.numberToUnion)(n, exports.SCHEDULE_DAYS_OF_MONTH);
+exports.toScheduleDaysOfMonth = toScheduleDaysOfMonth;
+exports.MIN_SCHEDULE_DAY_OF_MONTH = 1;
+exports.MAX_SCHEDULE_DAY_OF_MONTH = 28;
+exports.LAST_SCHEDULE_DAY_OF_MONTH = 31;
+const allDays = [
+    1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,
+    23, 24, 25, 26, 27, 28, 29, 30, 31,
+];
+const toDay = (n) => (0, numberToUnion_1.numberToUnion)(n, allDays); // eslint-disable-line @typescript-eslint/no-unused-vars
+const allMonths = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
+const toMonth = (n) => (0, numberToUnion_1.numberToUnion)(n, allMonths);
+exports.toMonth = toMonth;
+const toMonthStrict = (n) => (0, numberToUnion_1.numberToUnionStrict)(n, allMonths);
+exports.toMonthStrict = toMonthStrict;
+const getMonthFromMonthName = (month, localeID = 'en') => {
+    if (month != null) {
+        const index = (0, zeniDayJS_1.getMonthIndex)(month, localeID);
+        return index == null ? undefined : index;
+    }
+    else {
+        return undefined;
+    }
+};
+exports.getMonthFromMonthName = getMonthFromMonthName;
+const allQuarters = [1, 2, 3, 4];
+const toQuarter = (n) => (0, numberToUnion_1.numberToUnion)(n, allQuarters);
+exports.toQuarter = toQuarter;
+const toQuarterStrict = (n) => (0, numberToUnion_1.numberToUnionStrict)(n, allQuarters);
+exports.toQuarterStrict = toQuarterStrict;
+const toMonthYearPeriod = (periodPayload) => {
+    return {
+        month: (0, exports.toMonth)(Number(periodPayload.split('-')[0])),
+        year: Number(periodPayload.split('-')[1]),
+    };
+};
+exports.toMonthYearPeriod = toMonthYearPeriod;
+const toMonthYearPeriodQuery = (selectedPeriod) => {
+    const { month, year } = selectedPeriod;
+    return `${month}-${year}`;
+};
+exports.toMonthYearPeriodQuery = toMonthYearPeriodQuery;
+const toMonthYearPeriodId = (selectedPeriod) => {
+    const { month, year } = selectedPeriod;
+    return `${month}_${year}`;
+};
+exports.toMonthYearPeriodId = toMonthYearPeriodId;
+/**
+ * Convert to start: string; end: string in the format yyyy-mm-dd
+ * @param period - MonthYearPeriod
+ */
+function convertToPeriod(period, useEndOfCurrentMonth = false) {
+    const { month, year } = period;
+    // Start of the month
+    const today = (0, zeniDayJS_1.dateNow)();
+    const startDate = (0, zeniDayJS_1.date)(`${year}-${String(month).padStart(2, '0')}-01`);
+    let endDate = startDate.endOf('month');
+    if (endDate.isAfter(today) && useEndOfCurrentMonth === false) {
+        endDate = today;
+    }
+    return {
+        start: startDate.format(formatZeniDateFY_1.DEFAULT_DATE_FORMAT),
+        end: endDate.format(formatZeniDateFY_1.DEFAULT_DATE_FORMAT),
+    };
+}
+/**
+ * Convert to absolute day
+ * @param dateString in the format yyyy-mm-dd
+ */
+function toAbsoluteDay(dateString) {
+    const s = dateString.split('-');
+    if (s.length === 3) {
+        return {
+            year: parseInt(s[0]),
+            month: parseInt(s[1]),
+            day: parseInt(s[2]),
+        };
+    }
+    else {
+        console.error(`Invalid date string is given ${dateString}`);
+        return undefined;
+    }
+}
+const toString = (day) => `${String(day.year).padStart(4, '0')}-${String(day.month).padStart(2, '0')}-${String(day.day).padStart(2, '0')}`;
+exports.toString = toString;

package/lib/commonStateTypes/timeframeTick.d.ts

@@ -0,0 +1,15 @@
+import { ZeniDate } from '../zeniDayJS';
+import { COABalance } from './coaBalance/coaBalance';
+import { COABalanceType } from './coaBalance/coaBalanceType';
+import { TimePeriod } from './timePeriod';
+export interface TimeframeTick {
+    endDate: ZeniDate;
+    startDate: ZeniDate;
+}
+export interface TimeframeTickWithMetaData extends TimeframeTick {
+    balanceType: COABalanceType;
+    currencySymbol: string;
+}
+export declare const toTimeframeTick: (balance: COABalance) => TimeframeTickWithMetaData;
+export declare const toTimePeriod: (tick: TimeframeTick) => TimePeriod;
+export declare const mapTimePeriodtoTimeframeTick: (period: TimePeriod) => TimeframeTick;

package/lib/commonStateTypes/timeframeTick.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapTimePeriodtoTimeframeTick = exports.toTimePeriod = exports.toTimeframeTick = void 0;
+const zeniDayJS_1 = require("../zeniDayJS");
+const timePeriod_1 = require("./timePeriod");
+const toTimeframeTick = (balance) => ({
+    startDate: balance.startDate,
+    endDate: balance.endDate,
+    currencySymbol: balance.balance.currencySymbol,
+    balanceType: balance.type,
+});
+exports.toTimeframeTick = toTimeframeTick;
+const toTimePeriod = (tick) => ({
+    start: (0, timePeriod_1.toAbsoluteDay)(tick.startDate.format('YYYY-MM-DD')), // eslint-disable-line @typescript-eslint/no-non-null-assertion
+    end: (0, timePeriod_1.toAbsoluteDay)(tick.endDate.format('YYYY-MM-DD')), // eslint-disable-line @typescript-eslint/no-non-null-assertion
+});
+exports.toTimePeriod = toTimePeriod;
+const mapTimePeriodtoTimeframeTick = (period) => ({
+    startDate: (0, zeniDayJS_1.date)((0, timePeriod_1.toString)(period.start)),
+    endDate: (0, zeniDayJS_1.date)((0, timePeriod_1.toString)(period.end)),
+});
+exports.mapTimePeriodtoTimeframeTick = mapTimePeriodtoTimeframeTick;

package/lib/commonStateTypes/v2/viewAndReport.d.ts

@@ -0,0 +1,17 @@
+import { ZeniDate } from '../../zeniDayJS';
+import { Currency } from '../amount';
+import { DataAvailable } from '../dataAvailable';
+import { Month } from '../timePeriod';
+import { ReportID, View } from '../viewAndReport/viewAndReport';
+/** Any report state should extend this interface*/
+export interface ReportV2 extends View {
+    currency: Currency;
+    firstMonthOfFY: Month;
+    reportId: ReportID;
+    reportTitle: string;
+    bookCloseDate?: ZeniDate;
+    dataAvailable?: DataAvailable;
+}
+/**
+ * Any report going out from Selector should conform to this interface.
+ */

package/lib/commonStateTypes/v2/viewAndReport.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Any report going out from Selector should conform to this interface.
+ */

package/lib/commonStateTypes/vendorRecommendation.d.ts

@@ -0,0 +1,18 @@
+import ZeniUrl from '../zeniUrl';
+import { ID } from './common';
+export interface RecommendedVendorBase {
+    name: string;
+    id?: ID;
+    logo?: ZeniUrl;
+    qboId?: ID;
+    reason?: string;
+    recommendationHash?: ID;
+    thirdPartyMerchantId?: ID;
+    type?: string;
+    vendorNameConfidence?: number;
+    websiteUrl?: ZeniUrl;
+}
+export interface RecommendedVendorBaseWithCOT extends RecommendedVendorBase {
+    cot: string[];
+    reasoning: string;
+}

package/lib/commonStateTypes/vendorRecommendation.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/commonStateTypes/viewAndReport/viewAndReport.d.ts

@@ -0,0 +1,37 @@
+import { ZeniDate } from '../../zeniDayJS';
+import { FetchStateAndError, ID } from '../common';
+import { DataAvailable } from '../dataAvailable';
+import { Status } from '../status';
+import { Month } from '../timePeriod';
+export declare const ALL_REPORT_IDS: readonly ["cash_balance", "card_balance", "expense_automation_card", "operating_expenses", "operating_expenses_by_classes", "revenue", "revenue_by_classes", "net_burn_or_income", "net_burn_or_income_story_card", "net_burn_or_income_by_classes", "cash_position", "top_expenses", "profit_and_loss", "profit_and_loss_by_classes", "profit_and_loss_by_projects", "balance_sheet", "cash_flow", "dashboard", "finance_statement", "transaction_list_of_account", "transaction_list_missing_receipt", "transaction_list_of_account_by_class", "transaction_list_of_account_by_project", "transaction_detail", "cash_in_cash_out", "insights_dashboard", "company_details", "class_list", "account_list", "account_list_by_type", "vendor", "task_card", "bill_pay", "reimbursement", "bill_pay_card", "reimbursement_card", "bill_pay_promo_card", "zeni_accounts", "zeni_accounts_promo_card", "zeni_treasury", "charge_cards", "other_connection", "reimbursement_promo_card", "onboarding", "operating_expenses_by_vendor", "operating_expenses_by_vendor_summary", "vendors_tab", "accounts_payable_aging", "accounts_receivable_aging", "vendor_global_review", "prepaid_expenses", "fixed_assets", "notification", "rewards_card", "billing", "flux_analysis_operating_expense", "account_reconciliation", "zeni_credit_promo_card", "treasury_promo_card", "excluded_account_reconciliation", "transfer_accounts", "credit_card_transfer_accounts"];
+export declare const toReportID: (v: string) => "cash_balance" | "card_balance" | "expense_automation_card" | "operating_expenses" | "operating_expenses_by_classes" | "revenue" | "revenue_by_classes" | "net_burn_or_income" | "net_burn_or_income_story_card" | "net_burn_or_income_by_classes" | "cash_position" | "top_expenses" | "profit_and_loss" | "profit_and_loss_by_classes" | "profit_and_loss_by_projects" | "balance_sheet" | "cash_flow" | "dashboard" | "finance_statement" | "transaction_list_of_account" | "transaction_list_missing_receipt" | "transaction_list_of_account_by_class" | "transaction_list_of_account_by_project" | "transaction_detail" | "cash_in_cash_out" | "insights_dashboard" | "company_details" | "class_list" | "account_list" | "account_list_by_type" | "vendor" | "task_card" | "bill_pay" | "reimbursement" | "bill_pay_card" | "reimbursement_card" | "bill_pay_promo_card" | "zeni_accounts" | "zeni_accounts_promo_card" | "zeni_treasury" | "charge_cards" | "other_connection" | "reimbursement_promo_card" | "onboarding" | "operating_expenses_by_vendor" | "operating_expenses_by_vendor_summary" | "vendors_tab" | "accounts_payable_aging" | "accounts_receivable_aging" | "vendor_global_review" | "prepaid_expenses" | "fixed_assets" | "notification" | "rewards_card" | "billing" | "flux_analysis_operating_expense" | "account_reconciliation" | "zeni_credit_promo_card" | "treasury_promo_card" | "excluded_account_reconciliation" | "transfer_accounts" | "credit_card_transfer_accounts";
+export type ReportID = ReturnType<typeof toReportID>;
+export type ReportIDPlusForecastID = ReportID | `${ReportID}+${ID}`;
+/** Any view state should extend this interface */
+export interface View {
+    reportId?: ReportID;
+    status?: Status;
+    version?: number | string;
+}
+/** Any view going out from Selector should extend this interface */
+export interface SelectorView extends View, FetchStateAndError {
+    [key: string]: unknown;
+}
+/** Any report state should extend this interface*/
+export interface Report extends View {
+    firstMonthOfFY: Month;
+    reportId: ReportID;
+    reportTitle: string;
+    bookCloseDate?: ZeniDate;
+    dataAvailable?: DataAvailable;
+}
+/**
+ * Any report going out from Selector should conform to this interface.
+ */
+export interface SelectorReport extends Report, FetchStateAndError {
+    availableNumberOfPeriods?: number;
+    [key: string]: unknown;
+}
+export type PageToken = string | null;
+export declare const toReportFormatStrict: (v?: string) => "summary" | "detailed" | "more_detailed" | undefined;
+export type ReportFormat = NonNullable<ReturnType<typeof toReportFormatStrict>>;

package/lib/commonStateTypes/viewAndReport/viewAndReport.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toReportFormatStrict = exports.toReportID = exports.ALL_REPORT_IDS = void 0;
+const stringToUnion_1 = require("../stringToUnion");
+exports.ALL_REPORT_IDS = [
+    'cash_balance',
+    'card_balance',
+    'expense_automation_card',
+    'operating_expenses',
+    'operating_expenses_by_classes',
+    'revenue',
+    'revenue_by_classes',
+    'net_burn_or_income',
+    'net_burn_or_income_story_card',
+    'net_burn_or_income_by_classes',
+    'cash_position',
+    'top_expenses',
+    'profit_and_loss',
+    'profit_and_loss_by_classes',
+    'profit_and_loss_by_projects',
+    'balance_sheet',
+    'cash_flow',
+    'dashboard',
+    'finance_statement',
+    'transaction_list_of_account',
+    'transaction_list_missing_receipt',
+    'transaction_list_of_account_by_class',
+    'transaction_list_of_account_by_project',
+    'transaction_detail',
+    'cash_in_cash_out',
+    'insights_dashboard',
+    'company_details',
+    'class_list',
+    'account_list',
+    'account_list_by_type',
+    'vendor',
+    'task_card',
+    'bill_pay',
+    'reimbursement',
+    'bill_pay_card',
+    'reimbursement_card',
+    'bill_pay_promo_card',
+    'zeni_accounts',
+    'zeni_accounts_promo_card',
+    'zeni_treasury',
+    'charge_cards',
+    'other_connection',
+    'reimbursement_promo_card',
+    'onboarding',
+    'operating_expenses_by_vendor',
+    'operating_expenses_by_vendor_summary',
+    'vendors_tab',
+    'accounts_payable_aging',
+    'accounts_receivable_aging',
+    'vendor_global_review',
+    'prepaid_expenses',
+    'fixed_assets',
+    'notification',
+    'rewards_card',
+    'billing',
+    'flux_analysis_operating_expense',
+    'account_reconciliation',
+    'zeni_credit_promo_card',
+    'treasury_promo_card',
+    'excluded_account_reconciliation',
+    'transfer_accounts',
+    'credit_card_transfer_accounts',
+];
+const toReportID = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.ALL_REPORT_IDS);
+exports.toReportID = toReportID;
+const ALL_REPORT_FORMAT = ['summary', 'detailed', 'more_detailed'];
+const toReportFormatStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v?.toLocaleLowerCase() ?? '', ALL_REPORT_FORMAT);
+exports.toReportFormatStrict = toReportFormatStrict;

package/lib/entity/account/accountPayload.d.ts

@@ -0,0 +1,66 @@
+import { BalancePayload } from '../../commonPayloadTypes/balanceChangePayload';
+import { COABalanceGroupedPayload } from '../../commonPayloadTypes/coaBalancePayload';
+import { RecommendationBasePayload, RecommendedAccountBasePayloadWithCOT } from '../../commonPayloadTypes/recommendationPayload';
+import { StatusPayload } from '../../commonPayloadTypes/statusPayload';
+import { URLPayload } from '../../commonPayloadTypes/urlPayload';
+import { AccountBase, AccountMetadata, RecommendedAccountBase, RecommendedAccountBaseWithCOT, StatementCloseDay } from './accountState';
+export interface AccountBasePayload {
+    account_id: string;
+    account_name: string;
+    labels: string[];
+    account_description?: string | null;
+    account_sub_type?: string | null;
+    account_type?: string | null;
+    coa_id?: string | null;
+    currency_code?: string | null;
+    currency_symbol?: string | null;
+    is_bill_editable_coa_account_type?: boolean | null;
+    is_deleted?: boolean | null;
+    last_4_digits?: string | null;
+    logo?: URLPayload;
+    payment_type?: string | null;
+    payment_type_name?: string | null;
+    qbo_id?: string;
+    reconciliation_source?: string | null;
+    tax_1099_config?: Tax1099ConfigPayload | null;
+}
+export interface Tax1099ConfigPayload {
+    box_type: string | null;
+    expense_type: string | null;
+    is_bank_account: boolean;
+    is_expense_account: boolean;
+    type_1099: string | null;
+}
+export interface RecommendedAccountBasePayload extends AccountBasePayload, RecommendationBasePayload {
+    account_name_confidence?: number;
+}
+export declare const mapAccountBasePayloadToAccountBase: (payload: AccountBasePayload) => AccountBase;
+export declare const mapRecommendedAccountBasePayloadToRecommendedAccountBase: (payload: RecommendedAccountBasePayload) => RecommendedAccountBase | undefined;
+export declare const mapRecommendedAccountBasePayloadWithCOTToRecommendedAccountBaseWithCOT: (payload: RecommendedAccountBasePayloadWithCOT) => RecommendedAccountBaseWithCOT | undefined;
+export declare const mapStatementCloseDayPayloadToStatementCloseDay: (payload: string) => StatementCloseDay;
+export interface AccountPayload extends AccountBasePayload {
+    assets?: COABalanceGroupedPayload;
+    balance?: BalancePayload;
+    cash_in?: COABalanceGroupedPayload;
+    cash_out?: COABalanceGroupedPayload;
+    cash_position?: COABalanceGroupedPayload;
+    cogs?: COABalanceGroupedPayload;
+    equity?: COABalanceGroupedPayload;
+    expenses?: COABalanceGroupedPayload;
+    financing_activities?: COABalanceGroupedPayload;
+    income?: COABalanceGroupedPayload;
+    investing_activities?: COABalanceGroupedPayload;
+    liabilities?: COABalanceGroupedPayload;
+    operating_activities?: COABalanceGroupedPayload;
+    other_expenses?: COABalanceGroupedPayload;
+    other_income?: COABalanceGroupedPayload;
+    statement_close_day?: string | null;
+    status?: StatusPayload;
+}
+export interface AccountMetadataPayload extends AccountBasePayload {
+    is_sub_account: boolean | null;
+    parent_account_id: string | null;
+}
+export declare const toAccountPayload: (acc?: AccountBase) => AccountBasePayload;
+export declare const toRecommendedAccountBasePayload: (acc: RecommendedAccountBase) => RecommendedAccountBasePayload;
+export declare const mapAccountMetadataPayloadToAccountMetadata: (payload: AccountMetadataPayload) => AccountMetadata;