InvoiceDTO.ts

// Copyright (c) 2022. Heusala Group Oy <info@heusalagroup.fi>. All rights reserved.

import { isBoolean } from "../../../types/Boolean";
import { isInvoiceRowDTO, InvoiceRowDTO } from "./InvoiceRowDTO";
import { isBooleanOrUndefined } from "../../../types/Boolean";
import { isString } from "../../../types/String";
import { isNumber } from "../../../types/Number";
import { isRegularObject } from "../../../types/RegularObject";
import { hasNoOtherKeysInDevelopment } from "../../../types/OtherKeys";
import { isArrayOfOrUndefined } from "../../../types/Array";

export interface InvoiceDTO {
    readonly invoiceId         : string;
    readonly clientId          : string;
    readonly campaignId        : string;
    readonly groupId           : string;
    readonly bankAccountId     : string;
    readonly wcOrderId         : string;
    readonly updated           : string;
    readonly created           : string;
    readonly date              : string;
    readonly dueDate           : string;
    readonly remindDate        : string;
    readonly checkoutDate      : string;
    readonly referenceNumber   : string;
    readonly internalNote      : string;
    readonly extraNotice       : string;
    readonly webSecret         : string;
    readonly checkoutStamp     : string;
    readonly onHold            : boolean;
    readonly isReminded        : boolean;
    readonly onCollection      : boolean;
    readonly isTerminated      : boolean;
    readonly buildDocuments    : boolean;
    readonly sendDocuments     : boolean;
    readonly dueDays           : number;
    readonly rows             ?: readonly InvoiceRowDTO[];
    readonly isPaid           ?: boolean | undefined;
}

export function createInvoiceDTO (
    invoiceId        : string,
    clientId         : string,
    campaignId       : string,
    groupId          : string,
    bankAccountId    : string,
    wcOrderId        : string,
    updated          : string,
    created          : string,
    date             : string,
    dueDate          : string,
    remindDate       : string,
    checkoutDate     : string,
    referenceNumber  : string,
    internalNote     : string,
    extraNotice      : string,
    webSecret        : string,
    checkoutStamp    : string,
    onHold           : boolean,
    isReminded       : boolean,
    onCollection     : boolean,
    isTerminated     : boolean,
    buildDocuments   : boolean,
    sendDocuments    : boolean,
    dueDays          : number,
    rows            ?: readonly InvoiceRowDTO[],
    isPaid          ?: boolean
): InvoiceDTO {
    return {
        invoiceId,
        clientId,
        campaignId,
        groupId,
        bankAccountId,
        wcOrderId,
        updated,
        created,
        date,
        dueDate,
        remindDate,
        checkoutDate,
        referenceNumber,
        internalNote,
        extraNotice,
        webSecret,
        checkoutStamp,
        onHold,
        isReminded,
        onCollection,
        isTerminated,
        buildDocuments,
        sendDocuments,
        dueDays,
        rows,
        isPaid
    };
}

export function isInvoiceDTO (value: any): value is InvoiceDTO {
    return (
        isRegularObject(value)
        && hasNoOtherKeysInDevelopment(value, [
            'invoiceId',
            'clientId',
            'campaignId',
            'groupId',
            'bankAccountId',
            'wcOrderId',
            'updated',
            'created',
            'date',
            'dueDate',
            'remindDate',
            'checkoutDate',
            'referenceNumber',
            'internalNote',
            'extraNotice',
            'webSecret',
            'checkoutStamp',
            'onHold',
            'isReminded',
            'onCollection',
            'isTerminated',
            'isPaid',
            'buildDocuments',
            'sendDocuments',
            'dueDays',
            'rows'
        ])
        && isString(value?.invoiceId)
        && isString(value?.clientId)
        && isString(value?.campaignId)
        && isString(value?.groupId)
        && isString(value?.bankAccountId)
        && isString(value?.wcOrderId)
        && isString(value?.updated)
        && isString(value?.created)
        && isString(value?.date)
        && isString(value?.dueDate)
        && isString(value?.remindDate)
        && isString(value?.checkoutDate)
        && isString(value?.referenceNumber)
        && isString(value?.internalNote)
        && isString(value?.extraNotice)
        && isString(value?.webSecret)
        && isString(value?.checkoutStamp)
        && isBoolean(value?.onHold)
        && isBoolean(value?.isReminded)
        && isBoolean(value?.onCollection)
        && isBoolean(value?.isTerminated)
        && isBooleanOrUndefined(value?.isPaid)
        && isBoolean(value?.buildDocuments)
        && isBoolean(value?.sendDocuments)
        && isNumber(value?.dueDays)
        && isArrayOfOrUndefined<InvoiceRowDTO>(value?.rows, isInvoiceRowDTO)
    );
}

export function stringifyInvoiceDTO (value: InvoiceDTO): string {
    return `InvoiceDTO(${value})`;
}

export function parseInvoiceDTO (value: any): InvoiceDTO | undefined {
    if ( isInvoiceDTO(value) ) return value;
    return undefined;
}