configTypes.d.ts

import type { ADWebAuthConfig } from '@cityssm/ad-web-auth-connector';
export interface Config {
    application?: ConfigApplication;
    session?: ConfigSession;
    reverseProxy?: {
        disableCompression: boolean;
        disableEtag: boolean;
        urlPrefix: string;
    };
    activeDirectory?: ConfigActiveDirectory;
    adWebAuthConfig?: ADWebAuthConfig;
    users?: {
        testing?: string[];
        canLogin?: string[];
        canUpdate?: string[];
        isAdmin?: string[];
    };
    defaults?: ConfigDefaults;
    settings?: {
        licenceAlias?: string;
        licenceAliasPlural?: string;
        licenseeAlias?: string;
        licenseeAliasPlural?: string;
        renewalAlias?: string;
        includeRelated?: boolean;
        includeBatches?: boolean;
        includeReplacementFee?: boolean;
        includeYearEnd?: boolean;
    };
    exports?: {
        batches?: ConfigBatchExport;
    };
    licenceLengthFunctions?: Record<string, LicenceLengthFunction>;
    additionalFeeFunctions?: Record<string, AdditionalFeeFunction>;
    customReports?: ReportDefinition[];
}
interface ConfigApplication {
    applicationName?: string;
    logoURL?: string;
    httpPort?: number;
    userDomain?: string;
    useTestDatabases?: boolean;
}
interface ConfigSession {
    cookieName?: string;
    secret?: string;
    maxAgeMillis?: number;
    doKeepAlive?: boolean;
}
export interface ConfigActiveDirectory {
    url: string;
    baseDN: string;
    username: string;
    password: string;
}
interface ConfigDefaults {
    licenceNumberFunction: LicenceNumberFunction;
    licenseeCity: string;
    licenseeProvince: string;
}
export type ConfigBatchExport = ConfigBatchExport_RBCPreauthorized | ConfigBatchExport_CPA005;
export interface ConfigBatchExport_RBCPreauthorized {
    exportType: 'rbcPreauthorized';
    isTesting: boolean;
    header: {
        clientNumber: string;
        clientName: string;
        fileCreationNumberOffset: number;
        currencyType: 'CAD' | 'USD';
    };
    record: {
        transactionCode: '430';
        languageCode: 'E' | 'F';
        clientShortName: string;
        destinationCountry: 'CAN' | 'USA';
    };
}
export interface ConfigBatchExport_CPA005 {
    exportType: 'cpa005';
    isTesting: boolean;
    config: {
        fileCreationNumberOffset: number;
        originatorId: string;
        originatorLongName: string;
        originatorShortName?: string;
        cpaCode: number;
    };
}
export type LicenceNumberFunction = 'year-fourDigits' | 'year-fiveDigits' | 'year-sixDigits' | 'category-fourDigits' | 'category-fiveDigits' | 'category-sixDigits' | 'category-distinctFourDigits' | 'category-distinctFiveDigits' | 'category-distinctSixDigits';
export type LicenceLengthFunction = (startDate: Date) => Date;
export type AdditionalFeeFunction = (baseLicenceFee: number) => number;
export interface ReportDefinition {
    reportName: string;
    reportTitle: string;
    reportDescription?: string;
    sql: string;
}
export {};