@zeniai/client-epic-state 4.14.48 → 4.14.49

package/lib/entity/transaction/payloadTypes/transactionPayload.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRecommendationsPerLine = exports.transformRecommendation = exports.toTransactionPayload = exports.toTransaction = exports.getTransactionPayloadAmount = void 0;
+const recommendationPayload_1 = require("../../../commonPayloadTypes/recommendationPayload");
+const urlPayload_1 = require("../../../commonPayloadTypes/urlPayload");
+const amount_1 = require("../../../commonStateTypes/amount");
+const recommendationBase_1 = require("../../../commonStateTypes/recommendationBase");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+const accountPayload_1 = require("../../account/accountPayload");
+const classPayload_1 = require("../../class/classPayload");
+const transactionType_1 = require("../stateTypes/transactionType");
+const attachmentPayload_1 = require("./attachmentPayload");
+const transactionIDPayload_1 = require("./transactionIDPayload");
+const transactionLinePayload_1 = require("./transactionLinePayload");
+const getTransactionPayloadAmount = (payload) => {
+    if (payload.total_amount != null) {
+        return (0, amount_1.toAmount)(payload.total_amount, payload.currency_code, payload.currency_symbol);
+    }
+    else if (payload.amount != null) {
+        return (0, amount_1.toAmount)(payload.amount, payload.currency_code, payload.currency_symbol);
+    }
+    else {
+        return (0, amount_1.toAmount)(0, payload.currency_code, payload.currency_symbol);
+    }
+};
+exports.getTransactionPayloadAmount = getTransactionPayloadAmount;
+const getTransactionPayloadRecipientAmount = (payload) => {
+    if (payload.recipient_total_amount != null &&
+        payload.recipient_currency_code != null &&
+        payload.recipient_currency_symbol != null) {
+        return (0, amount_1.toAmount)(payload.recipient_total_amount, payload.recipient_currency_code, payload.recipient_currency_symbol);
+    }
+    else {
+        return undefined;
+    }
+};
+const toTransaction = (payload) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const amount = (0, exports.getTransactionPayloadAmount)(payload);
+    const recipientAmount = getTransactionPayloadRecipientAmount(payload);
+    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, (0, transactionIDPayload_1.toTransactionID)(payload)), { typeOfTransaction: 'supported', typeName: payload.transaction_type_name, createTime: (0, zeniDayJS_1.date)(payload.transaction_create_time), updateTime: payload.transaction_update_time != null
+            ? (0, zeniDayJS_1.date)(payload.transaction_update_time)
+            : undefined, date: (0, zeniDayJS_1.date)(payload.transaction_date), amount: amount, memo: payload.transaction_memo, description: payload.transaction_description, documentId: payload.document_id, logo: (0, urlPayload_1.toURL)(payload.logo), attachments: (_a = payload.attachments) === null || _a === void 0 ? void 0 : _a.map((attachmentPayload) => (0, attachmentPayload_1.toAttachment)(attachmentPayload)) }), (payload.vendor_id != null && payload.vendor_id != ''
+        ? { vendorId: payload.vendor_id }
+        : {})), (payload.vendor_name != null && payload.vendor_name != ''
+        ? { vendorName: payload.vendor_name }
+        : {})), { linkedTransactions: (_b = payload.linked_transactions) === null || _b === void 0 ? void 0 : _b.map((transactionIDPayload) => (0, transactionIDPayload_1.toTransactionID)(transactionIDPayload)), lines: (_c = payload === null || payload === void 0 ? void 0 : payload.lines) === null || _c === void 0 ? void 0 : _c.map((linePayload) => (0, transactionLinePayload_1.toLine)(linePayload, amount, recipientAmount)), account: payloadHasAccountInfo(payload)
+            ? (0, accountPayload_1.mapAccountBasePayloadToAccountBase)(payload)
+            : undefined, syncToken: (_d = payload.sync_token) === null || _d === void 0 ? void 0 : _d.toString(), paymentType: (_e = payload.payment_type) !== null && _e !== void 0 ? _e : undefined, paymentTypeName: (_f = payload.payment_type_name) !== null && _f !== void 0 ? _f : undefined, isUpdatingTransaction: (_g = payload === null || payload === void 0 ? void 0 : payload.is_updating_transaction) !== null && _g !== void 0 ? _g : false, bookCloseDate: (payload === null || payload === void 0 ? void 0 : payload.book_close_date) != null
+            ? (0, zeniDayJS_1.date)(payload.book_close_date)
+            : undefined, companyIncDate: (payload === null || payload === void 0 ? void 0 : payload.company_inc_date) != null
+            ? (0, zeniDayJS_1.date)(payload.company_inc_date)
+            : undefined, recommendations: (_h = (0, exports.getRecommendationsPerLine)(payload.lines, payload.recommendations)) !== null && _h !== void 0 ? _h : undefined, isRecommendedTransaction: payload.is_recommended_transaction });
+};
+exports.toTransaction = toTransaction;
+const payloadHasAccountInfo = (payload) => 'account_name' in payload &&
+    payload.account_name != null &&
+    payload.account_name.length > 0;
+const toTransactionPayload = (transaction) => {
+    var _a, _b, _c, _d, _e;
+    let transactionPayload = {
+        sync_token: (_a = transaction.syncToken) === null || _a === void 0 ? void 0 : _a.toString(),
+        currency_code: transaction.amount.currencyCode,
+        transaction_id: transaction.id,
+        transaction_type: (0, transactionType_1.toTransactionType)(transaction.type),
+        total_amount: transaction.amount.amount,
+        transaction_memo: transaction.memo,
+        lines: (_c = (_b = transaction === null || transaction === void 0 ? void 0 : transaction.lines) === null || _b === void 0 ? void 0 : _b.map((line) => (0, transactionLinePayload_1.toLinePayload)(line))) !== null && _c !== void 0 ? _c : [],
+        recommendations: toRecommendationsPayload((_d = transaction.lines) !== null && _d !== void 0 ? _d : [], (_e = transaction.recommendations) !== null && _e !== void 0 ? _e : {}),
+    };
+    //note:  for transaction type deposit and refund account is must for put call
+    if (transaction.account != null &&
+        (transaction.type === 'deposit' || transaction.type === 'refund')) {
+        transactionPayload = Object.assign(Object.assign({}, transactionPayload), (0, accountPayload_1.toAccountPayload)(transaction.account));
+    }
+    if (transaction.paymentType != null && transaction.type === 'bill_payment') {
+        transactionPayload = Object.assign(Object.assign({}, transactionPayload), {
+            payment_type: transaction.paymentType,
+            payment_type_name: transaction.paymentTypeName,
+        });
+    }
+    return transactionPayload;
+};
+exports.toTransactionPayload = toTransactionPayload;
+const transformRecommendation = (recommendation) => {
+    var _a, _b, _c, _d;
+    const accounts = recommendation.accounts;
+    const classObjs = recommendation.accounting_classes;
+    const recommendedVendors = recommendation.vendors;
+    const recommendations = [];
+    const mappedAccounts = accounts === null || accounts === void 0 ? void 0 : accounts.map((account) => (0, accountPayload_1.mapRecommendedAccountBasePayloadToRecommendedAccountBase)(account));
+    const mappedClasses = classObjs === null || classObjs === void 0 ? void 0 : classObjs.map((cls) => (0, classPayload_1.mapRecommendedClassBasePayloadToRecommendedClassBase)(cls));
+    const mappedRecommendedVendors = recommendedVendors === null || recommendedVendors === void 0 ? void 0 : recommendedVendors.map((recommendedVendor) => (0, recommendationBase_1.mapRecommendedVendorPayloadToBase)(recommendedVendor));
+    // Note: Accounts and Classes array length can be different here. So checking for larger array and iterating over that and mapped as per indexes
+    if (mappedAccounts != null &&
+        mappedAccounts.length >= ((_a = mappedClasses === null || mappedClasses === void 0 ? void 0 : mappedClasses.length) !== null && _a !== void 0 ? _a : 0) &&
+        mappedAccounts.length >= ((_b = mappedRecommendedVendors === null || mappedRecommendedVendors === void 0 ? void 0 : mappedRecommendedVendors.length) !== null && _b !== void 0 ? _b : 0)) {
+        mappedAccounts.forEach((account, index) => {
+            recommendations.push({
+                account,
+                class: mappedClasses === null || mappedClasses === void 0 ? void 0 : mappedClasses[index],
+                vendor: mappedRecommendedVendors === null || mappedRecommendedVendors === void 0 ? void 0 : mappedRecommendedVendors[index],
+            });
+        });
+    }
+    else if (mappedClasses != null &&
+        mappedClasses.length >= ((_c = mappedAccounts === null || mappedAccounts === void 0 ? void 0 : mappedAccounts.length) !== null && _c !== void 0 ? _c : 0) &&
+        mappedClasses.length >= ((_d = mappedRecommendedVendors === null || mappedRecommendedVendors === void 0 ? void 0 : mappedRecommendedVendors.length) !== null && _d !== void 0 ? _d : 0)) {
+        mappedClasses.forEach((cls, index) => {
+            recommendations.push({
+                account: mappedAccounts === null || mappedAccounts === void 0 ? void 0 : mappedAccounts[index],
+                class: cls,
+                vendor: mappedRecommendedVendors === null || mappedRecommendedVendors === void 0 ? void 0 : mappedRecommendedVendors[index],
+            });
+        });
+    }
+    else if (mappedRecommendedVendors != null) {
+        mappedRecommendedVendors.forEach((recommendedvendor, index) => {
+            recommendations.push({
+                account: mappedAccounts === null || mappedAccounts === void 0 ? void 0 : mappedAccounts[index],
+                class: mappedClasses === null || mappedClasses === void 0 ? void 0 : mappedClasses[index],
+                vendor: recommendedvendor,
+            });
+        });
+    }
+    return recommendations;
+};
+exports.transformRecommendation = transformRecommendation;
+const getRecommendationsPerLine = (lines, recommendations) => {
+    if (lines != null &&
+        (lines === null || lines === void 0 ? void 0 : lines.length) > 0 &&
+        recommendations != null &&
+        (recommendations === null || recommendations === void 0 ? void 0 : recommendations.length) > 0) {
+        const recommendationsWithLine = {};
+        recommendations === null || recommendations === void 0 ? void 0 : recommendations.forEach((lineRecommendations, index) => {
+            recommendationsWithLine[lines[index].line_id] =
+                (0, exports.transformRecommendation)(lineRecommendations);
+        });
+        return recommendationsWithLine;
+    }
+    return undefined;
+};
+exports.getRecommendationsPerLine = getRecommendationsPerLine;
+function toRecommendationsPayload(lines, recommendationByLineID) {
+    if (Object.keys(recommendationByLineID).length > 0 && lines.length > 0) {
+        const recommendationsPayload = [];
+        lines.forEach((line) => {
+            const lineId = line.id;
+            const recommendationTypes = recommendationByLineID[lineId];
+            const lineRecommendationPayload = {
+                accounts: [],
+                accounting_classes: [],
+                vendors: [],
+            };
+            if (recommendationTypes != null) {
+                recommendationTypes.forEach((recommendationType) => {
+                    if (recommendationType.account != null &&
+                        lineRecommendationPayload.accounts != null) {
+                        lineRecommendationPayload.accounts.push((0, accountPayload_1.toRecommendedAccountBasePayload)(recommendationType.account));
+                    }
+                    if (recommendationType.class != null &&
+                        lineRecommendationPayload.accounting_classes != null) {
+                        lineRecommendationPayload.accounting_classes.push((0, classPayload_1.toRecommendedClassBasePayload)(recommendationType.class));
+                    }
+                    if (recommendationType.vendor != null &&
+                        lineRecommendationPayload.vendors != null) {
+                        lineRecommendationPayload.vendors.push((0, recommendationPayload_1.toRecommendedVendorBasePayload)(recommendationType.vendor));
+                    }
+                });
+                recommendationsPayload.push(lineRecommendationPayload);
+            }
+        });
+        return recommendationsPayload;
+    }
+    else {
+        return [];
+    }
+}

package/lib/entity/transaction/payloadTypes/vendorTransactionPayload.d.ts

@@ -0,0 +1,15 @@
+import { VendorBasePayload } from '../../vendor/vendorPayload';
+import { VendorBase } from '../../vendor/vendorState';
+import { VendorTransaction } from '../stateTypes/vendorTransaction';
+import { TransactionPayload } from './transactionPayload';
+export interface VendorTransactionPayload extends VendorBasePayload, Omit<TransactionPayload, 'vendor_id' | 'vendor_name'> {
+    document_id: string;
+    payment_type?: string;
+    payment_type_name?: string;
+    payment_method_name?: string;
+    balance?: number;
+    due_date?: string;
+}
+export declare const isVendorTransactionPayload: (payload: TransactionPayload) => boolean;
+export declare const toVendorTransaction: (payload: VendorTransactionPayload) => VendorTransaction;
+export declare const toVendorTransactionPayload: (transaction: VendorTransaction, vendorUpdates?: VendorBase) => Partial<VendorTransactionPayload>;

package/lib/entity/transaction/payloadTypes/vendorTransactionPayload.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toVendorTransactionPayload = exports.toVendorTransaction = exports.isVendorTransactionPayload = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+const vendorPayload_1 = require("../../vendor/vendorPayload");
+const paymentType_1 = require("../stateTypes/paymentType");
+const transactionType_1 = require("../stateTypes/transactionType");
+const transactionPayload_1 = require("./transactionPayload");
+const isVendorTransactionPayload = (payload) => (0, transactionType_1.toVendorTransactionTypeStrict)(payload.transaction_type) != null;
+exports.isVendorTransactionPayload = isVendorTransactionPayload;
+const toVendorTransaction = (payload) => {
+    const transaction = (0, transactionPayload_1.toTransaction)(payload);
+    return Object.assign(Object.assign({}, transaction), { documentId: payload.document_id, vendor: payload.vendor_id != null
+            ? (0, vendorPayload_1.mapVendorBasePayloadToVendorBase)(payload)
+            : undefined, paymentType: (0, paymentType_1.toPaymentTypeStrict)(payload.payment_type), paymentTypeName: payload.payment_type_name, paymentMethodName: payload.payment_method_name, balance: payload.balance != null
+            ? (0, amount_1.toAmountWC)(payload.balance, transaction.amount)
+            : undefined, dueDate: payload.due_date != null ? (0, zeniDayJS_1.date)(payload.due_date) : undefined });
+};
+exports.toVendorTransaction = toVendorTransaction;
+const toVendorTransactionPayload = (transaction, vendorUpdates) => {
+    const payload = (0, transactionPayload_1.toTransactionPayload)(transaction);
+    return Object.assign(Object.assign({}, payload), (0, vendorPayload_1.toVendorBasePayload)(transaction.vendor, vendorUpdates));
+};
+exports.toVendorTransactionPayload = toVendorTransactionPayload;

package/lib/entity/transaction/stateTypes/attachment.d.ts

@@ -0,0 +1,26 @@
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniAPIResponse } from '../../../responsePayload';
+import { ZeniDate } from '../../../zeniDayJS';
+import { ZeniUrl as Url } from '../../../zeniUrl';
+import { File } from '../../file/fileState';
+import { AttachmentPayload } from '../payloadTypes/attachmentPayload';
+export declare const toContentType: (v: string) => "image/svg+xml" | "text/html" | "text/xml" | "application/pdf" | "image/jpeg" | "image/jpg" | "image/png" | "image/heic" | "text/csv" | "text/plain" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "image/gif" | "application/msword" | "application/postscript" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.oasis.opendocument.text" | "application/vnd.oasis.opendocument.spreadsheet" | "application/rtf" | "image/heif" | "image/webp";
+export type ContentType = ReturnType<typeof toContentType>;
+export declare const toContentTypeStrict: (v: string) => "image/svg+xml" | "text/html" | "text/xml" | "application/pdf" | "image/jpeg" | "image/jpg" | "image/png" | "image/heic" | "text/csv" | "text/plain" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "image/gif" | "application/msword" | "application/postscript" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.oasis.opendocument.text" | "application/vnd.oasis.opendocument.spreadsheet" | "application/rtf" | "image/heif" | "image/webp" | undefined;
+export interface Attachment {
+    id: ID;
+    contentType?: ContentType;
+    createTime: ZeniDate;
+    updateTime: ZeniDate;
+    fileName: string;
+    fileSizeInBytes: number;
+    fileDownloadUrl: Url;
+    fileChecksum?: string;
+    fileId: ID;
+}
+export declare const mapFileEntityToAttachment: (file: File) => Attachment;
+interface AttachmentViewPayload {
+    transaction_attachments: AttachmentPayload[];
+}
+export type AttachmentViewResponse = ZeniAPIResponse<AttachmentViewPayload>;
+export {};

package/lib/entity/transaction/stateTypes/attachment.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapFileEntityToAttachment = exports.toContentTypeStrict = exports.toContentType = void 0;
+const stringToUnion_1 = require("../../../commonStateTypes/stringToUnion");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+const ALL_CONTENT_TYPES = [
+    'application/postscript',
+    'application/pdf',
+    'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+    'application/vnd.ms-excel',
+    'application/msword',
+    'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+    'application/vnd.oasis.opendocument.text',
+    'application/vnd.oasis.opendocument.spreadsheet',
+    'application/rtf',
+    'text/plain',
+    'text/html',
+    'text/csv',
+    'text/xml',
+    'image/jpeg',
+    'image/jpg',
+    'image/png',
+    'image/heic',
+    'image/heif',
+    'image/svg+xml',
+    'image/webp',
+    'image/gif',
+];
+const toContentType = (v) => (0, stringToUnion_1.stringToUnion)(v, ALL_CONTENT_TYPES);
+exports.toContentType = toContentType;
+const toContentTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v, ALL_CONTENT_TYPES);
+exports.toContentTypeStrict = toContentTypeStrict;
+const mapFileEntityToAttachment = (file) => {
+    var _a, _b;
+    return ({
+        id: file.fileId,
+        contentType: (0, exports.toContentTypeStrict)(file.contentType),
+        createTime: file.createTime,
+        updateTime: (_a = file.updateTime) !== null && _a !== void 0 ? _a : (0, zeniDayJS_1.dateNow)(),
+        fileName: file.fileName,
+        fileSizeInBytes: file.fileSize,
+        fileDownloadUrl: file.signedUrl,
+        fileChecksum: (_b = file.checksum) !== null && _b !== void 0 ? _b : undefined,
+        fileId: file.fileId,
+    });
+};
+exports.mapFileEntityToAttachment = mapFileEntityToAttachment;

package/lib/entity/transaction/stateTypes/customerTransaction.d.ts

@@ -0,0 +1,14 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ZeniDate } from '../../../zeniDayJS';
+import { CustomerBase } from '../../customer/customerState';
+import { PaymentType } from './paymentType';
+import { Transaction } from './transaction';
+export interface CustomerTransaction extends Transaction {
+    customer?: CustomerBase;
+    paymentType?: PaymentType;
+    paymentTypeName?: string;
+    paymentMethodName?: string;
+    balance?: Amount;
+    dueDate?: ZeniDate;
+}
+export declare const isCustomerTransaction: (transaction: Transaction) => boolean;

package/lib/entity/transaction/stateTypes/customerTransaction.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCustomerTransaction = void 0;
+const transactionType_1 = require("./transactionType");
+const isCustomerTransaction = (transaction) => (0, transactionType_1.toCustomerTransactionTypeStrict)(transaction.type) != null;
+exports.isCustomerTransaction = isCustomerTransaction;

package/lib/entity/transaction/stateTypes/otherTransaction.d.ts

@@ -0,0 +1,11 @@
+import { AccountBase } from '../../account/accountState';
+import { Transaction } from './transaction';
+export interface TransferTransaction extends Transaction {
+    fromAccount: AccountBase;
+    toAccount: AccountBase;
+    payee?: {
+        payeeId: string;
+        payeeName: string;
+    };
+}
+export declare const isTransferTransaction: (transaction: Transaction) => boolean;

package/lib/entity/transaction/stateTypes/otherTransaction.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTransferTransaction = void 0;
+const transactionType_1 = require("./transactionType");
+const isTransferTransaction = (transaction) => {
+    var _a, _b;
+    return (0, transactionType_1.toTransferTransactionTypeStrict)(transaction.type) != null &&
+        ((_a = transaction === null || transaction === void 0 ? void 0 : transaction.fromAccount) === null || _a === void 0 ? void 0 : _a.accountId) != null &&
+        ((_b = transaction === null || transaction === void 0 ? void 0 : transaction.toAccount) === null || _b === void 0 ? void 0 : _b.accountId) != null;
+};
+exports.isTransferTransaction = isTransferTransaction;

package/lib/entity/transaction/stateTypes/paymentType.d.ts

@@ -0,0 +1,4 @@
+declare const toPaymentType: (v: string) => "credit_card" | "check" | "cash";
+export declare const toPaymentTypeStrict: (v?: string) => "credit_card" | "check" | "cash" | undefined;
+export type PaymentType = ReturnType<typeof toPaymentType>;
+export {};

package/lib/entity/transaction/stateTypes/paymentType.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toPaymentTypeStrict = void 0;
+const stringToUnion_1 = require("../../../commonStateTypes/stringToUnion");
+const ALL_PAYMENT_TYPES = ['check', 'cash', 'credit_card'];
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const toPaymentType = (v) => (0, stringToUnion_1.stringToUnion)(v, ALL_PAYMENT_TYPES);
+const toPaymentTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v !== null && v !== void 0 ? v : '', ALL_PAYMENT_TYPES);
+exports.toPaymentTypeStrict = toPaymentTypeStrict;

package/lib/entity/transaction/stateTypes/scheduleTransaction.d.ts

@@ -0,0 +1,12 @@
+import { Currency } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { AccountBase } from '../../account/accountState';
+import { ClassBase } from '../../class/classState';
+import { BaseTransaction } from './transaction';
+export interface ScheduleTransaction extends BaseTransaction {
+    currency: Currency;
+    account: AccountBase;
+    thirdPartyTransactionId: ID;
+    lineId: ID;
+    classBase?: ClassBase;
+}

package/lib/entity/transaction/stateTypes/scheduleTransaction.js

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

package/lib/entity/transaction/stateTypes/transaction.d.ts

@@ -0,0 +1,42 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { Recommendation } from '../../../commonStateTypes/recommendationBase';
+import { ZeniDate } from '../../../zeniDayJS';
+import { ZeniUrl as Url } from '../../../zeniUrl';
+import { AccountBase } from '../../account/accountState';
+import { Attachment } from './attachment';
+import Line from './transactionLine';
+import { TransactionType, TypeOfTransactionType } from './transactionType';
+export interface TransactionID {
+    id: ID;
+    type: TransactionType;
+}
+export type RecommendationByLineId = Record<ID, Recommendation[]>;
+export interface BaseTransaction extends TransactionID {
+    date: ZeniDate;
+    amount: Amount;
+    memo: string;
+    typeName?: string;
+    account?: AccountBase;
+    typeOfTransaction: TypeOfTransactionType;
+}
+export interface Transaction extends BaseTransaction {
+    description: string;
+    isUpdatingTransaction: boolean;
+    createTime: ZeniDate;
+    updateTime?: ZeniDate;
+    documentId?: string;
+    logo?: Url;
+    attachments?: Attachment[];
+    linkedTransactions?: TransactionID[];
+    lines?: Line[];
+    syncToken?: string;
+    paymentType?: string;
+    paymentTypeName?: string;
+    recommendations?: RecommendationByLineId;
+    bookCloseDate?: ZeniDate;
+    companyIncDate?: ZeniDate;
+    isRecommendedTransaction?: boolean;
+    vendorId?: ID;
+    vendorName?: string;
+}

package/lib/entity/transaction/stateTypes/transaction.js

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

package/lib/entity/transaction/stateTypes/transactionLine.d.ts

@@ -0,0 +1,57 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { AccountBase } from '../../account/accountState';
+import { ClassBase } from '../../class/classState';
+import { CustomerBase } from '../../customer/customerState';
+import { VendorBase } from '../../vendor/vendorState';
+import { TransactionID } from './transaction';
+import { TransactionCategory, TransactionType } from './transactionType';
+export interface TransactionLineBase {
+    id: ID;
+    type: LineType;
+    lineDescription: string;
+    amount: Amount;
+    platformLineDetailType: PlatformLineDetailType;
+    recipientAmount?: Amount;
+    categorizationStatus?: CategorizationStatusType;
+    reviewPendingReasons?: string[];
+}
+export interface LinkedTransactionLine extends TransactionLineBase {
+    linkedTransactions: TransactionID[];
+}
+export interface TransactionWithAccountAndClassLine extends TransactionLineBase {
+    class: ClassBase;
+    account: AccountBase;
+    customer?: CustomerBase;
+    vendor?: VendorBase;
+    billable: BillableStatus;
+    isCategoryMiscategorized: boolean;
+    isClassMiscategorized: boolean;
+}
+export interface TransactionWithProductOrServiceLine extends TransactionWithAccountAndClassLine {
+    item: ProductOrService;
+    lineDetailType: PlatformLineDetailType;
+}
+export interface JournalEntryTransactionLine extends TransactionWithAccountAndClassLine {
+    lineTransactionType: TransactionType;
+    postingType: TransactionCategory;
+    postingTypeName: string;
+}
+export interface TransactionInfoLine extends TransactionLineBase {
+    lineDetailType: PlatformLineDetailType;
+}
+export type Line = TransactionWithProductOrServiceLine | JournalEntryTransactionLine | TransactionWithAccountAndClassLine | TransactionInfoLine | LinkedTransactionLine | TransactionLineBase;
+export type LineType = 'linked_transaction_line' | 'transaction_with_account_and_class_line' | 'transaction_with_product_or_service_line' | 'journal_entry_transaction_line' | 'transaction_info_line' | 'transaction_line_base';
+export default Line;
+export interface ProductOrService {
+    itemId: string;
+    itemName: string;
+    unitPrice: Amount;
+    quantity: number;
+}
+export declare const toPlatformLineDetailType: (v: string) => "" | "sales_item_line_detail" | "account_based_expense_line_detail" | "item_based_expense_line_detail" | "journal_entry_line_detail" | "description_only_line_detail" | "sub_total_line_detail" | "deposit_line_detail" | "deposit_without_account_line_detail" | "group_line_detail" | "discount_line_detail";
+export type PlatformLineDetailType = ReturnType<typeof toPlatformLineDetailType>;
+export type BillableStatus = 'billable' | 'not_billable' | 'has_been_billed';
+export declare const CATEGORIZATION_STATUSES: readonly ["auto_categorized", "auto_reviewed", "pending_review", "review_complete"];
+export declare const toCategorizationStatusType: (v: string) => "auto_categorized" | "auto_reviewed" | "pending_review" | "review_complete";
+export type CategorizationStatusType = ReturnType<typeof toCategorizationStatusType>;

package/lib/entity/transaction/stateTypes/transactionLine.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCategorizationStatusType = exports.CATEGORIZATION_STATUSES = exports.toPlatformLineDetailType = void 0;
+const stringToUnion_1 = require("../../../commonStateTypes/stringToUnion");
+const PLATFORM_LINE_DETAIL_TYPES = [
+    'sales_item_line_detail',
+    'account_based_expense_line_detail',
+    'item_based_expense_line_detail',
+    'journal_entry_line_detail',
+    'description_only_line_detail',
+    'sub_total_line_detail',
+    'deposit_line_detail',
+    'deposit_without_account_line_detail',
+    // yet to do
+    'group_line_detail',
+    'discount_line_detail',
+    // for linked transaction type empty string will be line_detail_type
+    '',
+    // 'discount_line_detail' not supported by platform as of now
+];
+const toPlatformLineDetailType = (v) => (0, stringToUnion_1.stringToUnion)(v, PLATFORM_LINE_DETAIL_TYPES);
+exports.toPlatformLineDetailType = toPlatformLineDetailType;
+exports.CATEGORIZATION_STATUSES = [
+    'auto_categorized',
+    'auto_reviewed',
+    'pending_review',
+    'review_complete',
+];
+const toCategorizationStatusType = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.CATEGORIZATION_STATUSES);
+exports.toCategorizationStatusType = toCategorizationStatusType;

package/lib/entity/transaction/stateTypes/transactionType.d.ts

@@ -0,0 +1,23 @@
+export declare const toTypeOfTransaction: (v: string) => "schedule" | "supported" | "uncategorized";
+export type TypeOfTransactionType = ReturnType<typeof toTypeOfTransaction>;
+declare const toCustomerTransactionType: (v: string) => "invoice" | "payment" | "credit_memo" | "sales_receipt" | "delayed_credit" | "delayed_charge" | "refund";
+export declare const toCustomerTransactionTypeStrict: (v?: string) => "invoice" | "payment" | "credit_memo" | "sales_receipt" | "delayed_credit" | "delayed_charge" | "refund" | undefined;
+export type CustomerTransactionType = ReturnType<typeof toCustomerTransactionType>;
+declare const toVendorTransactionType: (v: string) => "expense" | "check" | "bill" | "bill_payment" | "bill_payment_check" | "bill_payment_credit_card" | "vendor_credit" | "credit_card_credit";
+export declare const toVendorTransactionTypeStrict: (v?: string) => "expense" | "check" | "bill" | "bill_payment" | "bill_payment_check" | "bill_payment_credit_card" | "vendor_credit" | "credit_card_credit" | undefined;
+export type VendorTransactionType = ReturnType<typeof toVendorTransactionType>;
+declare const toEmployeeTransactionType: (v: string) => never;
+export type EmployeeTransactionType = ReturnType<typeof toEmployeeTransactionType>;
+declare const toTransferTransactionType: (v: string) => "transfer" | "credit_card_payment";
+export declare const toTransferTransactionTypeStrict: (v?: string) => "transfer" | "credit_card_payment" | undefined;
+export type TransferTransactionType = ReturnType<typeof toTransferTransactionType>;
+export declare const toJEAndDepositTransactionTypeStrict: (v?: string) => "transfer" | "credit_card_payment" | "deposit" | "journal_entry" | undefined;
+declare const toOtherTransactionType: (v: string) => "transfer" | "credit_card_payment" | "deposit" | "journal_entry";
+export type OtherTransactionType = ReturnType<typeof toOtherTransactionType>;
+export type TransactionType = CustomerTransactionType | VendorTransactionType | EmployeeTransactionType | OtherTransactionType;
+export declare const toTransactionType: (v: string) => TransactionType;
+export declare const toTransactionTypeStrict: (v?: string) => TransactionType | undefined;
+export declare const ALL_TRANSACTION_CATEGORY: readonly ["credit", "debit"];
+export declare const toTransactionCategory: (v: string) => "credit" | "debit";
+export type TransactionCategory = ReturnType<typeof toTransactionCategory>;
+export {};

package/lib/entity/transaction/stateTypes/transactionType.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toTransactionCategory = exports.ALL_TRANSACTION_CATEGORY = exports.toTransactionTypeStrict = exports.toTransactionType = exports.toJEAndDepositTransactionTypeStrict = exports.toTransferTransactionTypeStrict = exports.toVendorTransactionTypeStrict = exports.toCustomerTransactionTypeStrict = exports.toTypeOfTransaction = void 0;
+const stringToUnion_1 = require("../../../commonStateTypes/stringToUnion");
+const ALL_TYPES_OF_TRANSACTIONS = [
+    'schedule',
+    'supported', // supported is like a superset at this point
+    'uncategorized',
+];
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const toTypeOfTransaction = (v) => (0, stringToUnion_1.stringToUnion)(v, ALL_TYPES_OF_TRANSACTIONS);
+exports.toTypeOfTransaction = toTypeOfTransaction;
+const ALL_CUSTOMER_TRANSACTION_TYPE = [
+    'invoice',
+    'payment',
+    'credit_memo',
+    'sales_receipt',
+    'delayed_credit',
+    'delayed_charge',
+    'refund',
+];
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const toCustomerTransactionType = (v) => (0, stringToUnion_1.stringToUnion)(v, ALL_CUSTOMER_TRANSACTION_TYPE);
+const toCustomerTransactionTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v !== null && v !== void 0 ? v : '', ALL_CUSTOMER_TRANSACTION_TYPE);
+exports.toCustomerTransactionTypeStrict = toCustomerTransactionTypeStrict;
+const ALL_VENDOR_TRANSACTION_TYPE = [
+    'expense',
+    'check',
+    'bill',
+    'bill_payment',
+    'bill_payment_check',
+    'bill_payment_credit_card',
+    'vendor_credit',
+    'credit_card_credit',
+];
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const toVendorTransactionType = (v) => (0, stringToUnion_1.stringToUnion)(v, ALL_VENDOR_TRANSACTION_TYPE);
+const toVendorTransactionTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v !== null && v !== void 0 ? v : '', ALL_VENDOR_TRANSACTION_TYPE);
+exports.toVendorTransactionTypeStrict = toVendorTransactionTypeStrict;
+const ALL_EMPLOYEE_TRANSACTION_TYPE = [];
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const toEmployeeTransactionType = (v) => (0, stringToUnion_1.stringToUnion)(v, ALL_EMPLOYEE_TRANSACTION_TYPE);
+const ALL_TRANSFER_TRANSACTION_TYPE = [
+    'transfer',
+    'credit_card_payment',
+];
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const toTransferTransactionType = (v) => (0, stringToUnion_1.stringToUnion)(v, ALL_TRANSFER_TRANSACTION_TYPE);
+const toTransferTransactionTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v !== null && v !== void 0 ? v : '', ALL_TRANSFER_TRANSACTION_TYPE);
+exports.toTransferTransactionTypeStrict = toTransferTransactionTypeStrict;
+const JE_AND_DEPOSIT_TRANSACTION_TYPE = ['deposit', 'journal_entry'];
+const toJEAndDepositTransactionTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v !== null && v !== void 0 ? v : '', ALL_OTHER_TRANSACTION_TYPE);
+exports.toJEAndDepositTransactionTypeStrict = toJEAndDepositTransactionTypeStrict;
+const ALL_OTHER_TRANSACTION_TYPE = [
+    ...ALL_TRANSFER_TRANSACTION_TYPE,
+    ...JE_AND_DEPOSIT_TRANSACTION_TYPE,
+];
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const toOtherTransactionType = (v) => (0, stringToUnion_1.stringToUnion)(v, ALL_OTHER_TRANSACTION_TYPE);
+const ALL_TRANSACTION_TYPE = [
+    ...ALL_CUSTOMER_TRANSACTION_TYPE,
+    ...ALL_VENDOR_TRANSACTION_TYPE,
+    ...ALL_EMPLOYEE_TRANSACTION_TYPE,
+    ...ALL_OTHER_TRANSACTION_TYPE,
+];
+const toTransactionType = (v) => (0, stringToUnion_1.stringToUnion)(v, ALL_TRANSACTION_TYPE);
+exports.toTransactionType = toTransactionType;
+const toTransactionTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v !== null && v !== void 0 ? v : '', ALL_TRANSACTION_TYPE);
+exports.toTransactionTypeStrict = toTransactionTypeStrict;
+exports.ALL_TRANSACTION_CATEGORY = ['credit', 'debit'];
+const toTransactionCategory = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.ALL_TRANSACTION_CATEGORY);
+exports.toTransactionCategory = toTransactionCategory;

package/lib/entity/transaction/stateTypes/vendorTransaction.d.ts

@@ -0,0 +1,14 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ZeniDate } from '../../../zeniDayJS';
+import { VendorBase } from '../../vendor/vendorState';
+import { PaymentType } from './paymentType';
+import { Transaction } from './transaction';
+export interface VendorTransaction extends Transaction {
+    vendor?: VendorBase;
+    paymentType?: PaymentType;
+    paymentTypeName?: string;
+    paymentMethodName?: string;
+    balance?: Amount;
+    dueDate?: ZeniDate;
+}
+export declare const isVendorTransaction: (transaction: Transaction) => boolean;