@bitblit/ratchet-common 4.0.353-alpha → 4.0.355-alpha

package/lib/logger/logger.d.ts

@@ -1,45 +0,0 @@
-import { LogMessage } from './log-message.js';
-import { LogSnapshot } from './log-snapshot.js';
-import { LoggerOptions } from './logger-options.js';
-import { LoggerInstance } from './logger-instance.js';
-import { LoggerLevelName } from './logger-level-name.js';
-import { LoggerRingBuffer } from './logger-ring-buffer.js';
-import { LogMessageBuilder } from './log-message-builder.js';
-export declare class Logger {
-    private static LOGGER_INSTANCE_MAP_GLOBAL_KEY;
-    private static GLOBAL_PROVIDER;
-    private static DEFAULT_OPTIONS;
-    static applyDefaultsToOptions(input?: LoggerOptions): LoggerOptions;
-    private static loggerInstances;
-    static changeDefaultOptions(input: LoggerOptions, retroactive?: boolean): void;
-    static getLogger(loggerName?: string, inOptions?: LoggerOptions): LoggerInstance;
-    static recordMessageBuilder(msgBuild: LogMessageBuilder): string;
-    static recordMessage(msg: LogMessage): string;
-    static formatMessages(msgs: LogMessage[]): string[];
-    static updateTracePrefix(newValue: string): void;
-    static changeRingBufferSize(newValue: number): void;
-    static getRingBuffer(): LoggerRingBuffer;
-    static dumpConfigurationIntoLog(): void;
-    static dumpOptionsIntoLog(): void;
-    static getLevel(): LoggerLevelName;
-    static setLevel(newLevel: LoggerLevelName): void;
-    static getOptions(): LoggerOptions;
-    static getMessages(inStartFrom?: number, clear?: boolean, reverseSort?: boolean): LogMessage[];
-    static consoleLogPassThru(level: LoggerLevelName, ...input: any[]): void;
-    static error(format: string, ...input: any[]): string;
-    static errorP(...input: any[]): void;
-    static warn(format: string, ...input: any[]): string;
-    static warnP(...input: any[]): void;
-    static info(format: string, ...input: any[]): string;
-    static infoP(...input: any[]): void;
-    static verbose(format: string, ...input: any[]): string;
-    static verboseP(...input: any[]): void;
-    static debug(format: string, ...input: any[]): string;
-    static debugP(...input: any[]): void;
-    static silly(format: string, ...input: any[]): string;
-    static sillyP(...input: any[]): void;
-    static takeSnapshot(): LogSnapshot;
-    static logByLevel(level: LoggerLevelName, format: string, ...input: any[]): void;
-    static importMessages(msgs: LogMessage[], prefixIn?: string, addTimestamp?: boolean): void;
-    static getLastLogMessage(): LogMessage;
-}

package/lib/logger/logger.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/logger/none-log-message-formatter.d.ts

@@ -1,6 +0,0 @@
-import { LogMessage } from './log-message.js';
-import { LogMessageFormatter } from './log-message-formatter.js';
-import { LoggerMeta } from './logger-meta.js';
-export declare class NoneLogMessageFormatter implements LogMessageFormatter {
-    formatMessage(msg: LogMessage, meta: LoggerMeta): string;
-}

package/lib/logger/structured-json-log-message-formatter.d.ts

@@ -1,6 +0,0 @@
-import { LogMessage } from './log-message.js';
-import { LogMessageFormatter } from './log-message-formatter.js';
-import { LoggerMeta } from './logger-meta.js';
-export declare class StructuredJsonLogMessageFormatter implements LogMessageFormatter {
-    formatMessage(msg: LogMessage, meta: LoggerMeta): string;
-}

package/lib/mail/archive-email-result.d.ts

@@ -1,5 +0,0 @@
-export interface ArchiveEmailResult<R> {
-    raw: R;
-    error: string;
-    meta: Record<string, any>;
-}

package/lib/mail/email-attachment.d.ts

@@ -1,5 +0,0 @@
-export interface EmailAttachment {
-    filename?: string;
-    contentType?: string;
-    base64Data?: string;
-}

package/lib/mail/mail-sending-provider.d.ts

@@ -1,5 +0,0 @@
-import { ResolvedReadyToSendEmail } from './resolved-ready-to-send-email.js';
-export interface MailSendingProvider<T, R> {
-    sendEmail(mail: ResolvedReadyToSendEmail): Promise<T>;
-    archiveEmail?(mail: ResolvedReadyToSendEmail, rawSendResult: T): Promise<R>;
-}

package/lib/mail/mailer-config.d.ts

@@ -1,11 +0,0 @@
-import { MailSendingProvider } from './mail-sending-provider.js';
-import { RatchetTemplateRenderer } from '../template/ratchet-template-renderer.js';
-export interface MailerConfig<T, R> {
-    provider: MailSendingProvider<T, R>;
-    defaultSendingAddress?: string;
-    autoBccAddresses?: string[];
-    templateRenderer?: RatchetTemplateRenderer;
-    allowedDestinationEmails?: RegExp[];
-    maxMessageBodySizeInBytes?: number;
-    maxAttachmentSizeInBase64Bytes?: number;
-}

package/lib/mail/mailer-like.d.ts

@@ -1,11 +0,0 @@
-import { ReadyToSendEmail } from './ready-to-send-email.js';
-import { ResolvedReadyToSendEmail } from './resolved-ready-to-send-email.js';
-import { SendEmailResult } from './send-email-result';
-export interface MailerLike<T, R> {
-    fillEmailBody(rts: ReadyToSendEmail, context: any, htmlTemplateName: string, txtTemplateName?: string, layoutName?: string, partialNames?: string[]): Promise<ReadyToSendEmail>;
-    fillEmailBodyAndSend(rts: ReadyToSendEmail, context: any, htmlTemplateName: string, txtTemplateName?: string, layoutName?: string, partialNames?: string[]): Promise<SendEmailResult<T, R>>;
-    filterEmailsToValid(emails: string[]): string[];
-    applyLimitsToBodySizesIfAnyInPlace(rts: ResolvedReadyToSendEmail): void;
-    applyLimitsToAttachmentSizesIfAnyInPlace(rts: ResolvedReadyToSendEmail): void;
-    sendEmail(inRts: ReadyToSendEmail): Promise<SendEmailResult<T, R>>;
-}

package/lib/mail/mailer-util.d.ts

@@ -1,7 +0,0 @@
-import { ResolvedReadyToSendEmail } from './resolved-ready-to-send-email.js';
-export declare class MailerUtil {
-    static readonly EMAIL: RegExp;
-    constructor();
-    static convertResolvedReadyToSendEmailToRaw(rts: ResolvedReadyToSendEmail): string;
-    static validEmail(email: string): boolean;
-}

package/lib/mail/mailer.d.ts

@@ -1,17 +0,0 @@
-import { ReadyToSendEmail } from './ready-to-send-email.js';
-import { MailerConfig } from './mailer-config.js';
-import { ResolvedReadyToSendEmail } from './resolved-ready-to-send-email.js';
-import { MailerLike } from './mailer-like.js';
-import { SendEmailResult } from './send-email-result';
-export declare class Mailer<T, R> implements MailerLike<T, R> {
-    private config;
-    constructor(config: MailerConfig<T, R>);
-    fillEmailBody(rts: ReadyToSendEmail, context: any, htmlTemplateName: string, txtTemplateName?: string, layoutName?: string, partialNames?: string[]): Promise<ReadyToSendEmail>;
-    fillEmailBodyAndSend(rts: ReadyToSendEmail, context: any, htmlTemplateName: string, txtTemplateName?: string, layoutName?: string, partialNames?: string[]): Promise<SendEmailResult<T, R>>;
-    filterEmailsToValid(emails: string[]): string[];
-    private archiveEmailIfConfigured;
-    applyLimitsToBodySizesIfAnyInPlace(rts: ResolvedReadyToSendEmail): void;
-    applyLimitsToAttachmentSizesIfAnyInPlace(rts: ResolvedReadyToSendEmail): void;
-    sendEmail(inRts: ReadyToSendEmail): Promise<SendEmailResult<T, R>>;
-    resolveReadyToSendEmail(inRts: ReadyToSendEmail): Promise<ResolvedReadyToSendEmail>;
-}

package/lib/mail/mailer.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/mail/ready-to-send-email.d.ts

@@ -1,13 +0,0 @@
-import { EmailAttachment } from './email-attachment.js';
-export interface ReadyToSendEmail {
-    destinationAddresses?: Array<string>;
-    bccAddresses?: Array<string>;
-    attachments?: Array<EmailAttachment>;
-    fromAddress?: string;
-    txtMessage?: string;
-    htmlMessage?: string;
-    subject?: string;
-    fromName?: string;
-    doNotAutoBcc?: boolean;
-    doNotArchive?: boolean;
-}

package/lib/mail/resolved-ready-to-send-email.d.ts

@@ -1,5 +0,0 @@
-import { ReadyToSendEmail } from './ready-to-send-email.js';
-export interface ResolvedReadyToSendEmail extends ReadyToSendEmail {
-    srcDestinationAddresses?: string[];
-    srcBccAddresses?: string[];
-}

package/lib/mail/send-email-result.d.ts

@@ -1,12 +0,0 @@
-import { ReadyToSendEmail } from './ready-to-send-email.js';
-import { ResolvedReadyToSendEmail } from './resolved-ready-to-send-email.js';
-import { ArchiveEmailResult } from './archive-email-result';
-export interface SendEmailResult<T, R> {
-    request: ReadyToSendEmail;
-    resolved: ResolvedReadyToSendEmail;
-    success: boolean;
-    rawResult: T;
-    error: string;
-    meta: Record<string, any>;
-    archiveResults: ArchiveEmailResult<R>;
-}

package/lib/mail/test-mail-sending-provider.d.ts

@@ -1,8 +0,0 @@
-import { ResolvedReadyToSendEmail } from './resolved-ready-to-send-email.js';
-import { MailSendingProvider } from './mail-sending-provider';
-export declare class TestMailSendingProvider implements MailSendingProvider<string, string> {
-    failEmails: string[];
-    constructor(failEmails?: string[]);
-    sendEmail(mail: ResolvedReadyToSendEmail): Promise<string>;
-    archiveEmail(mail: ResolvedReadyToSendEmail): Promise<string>;
-}

package/lib/network/browser-local-ip-provider.d.ts

@@ -1,7 +0,0 @@
-import { LocalIpProvider } from './local-ip-provider.js';
-export declare class BrowserLocalIpProvider implements LocalIpProvider {
-    private currentIp;
-    constructor();
-    ready(): boolean;
-    currentLocalIpAddress(): string;
-}

package/lib/network/browser-local-ip-provider.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/network/fixed-local-ip-provider.d.ts

@@ -1,6 +0,0 @@
-import { LocalIpProvider } from './local-ip-provider.js';
-export declare class FixedLocalIpProvider implements LocalIpProvider {
-    private fixed;
-    constructor(fixed: string);
-    currentLocalIpAddress(): string;
-}

package/lib/network/local-ip-provider.d.ts

@@ -1,3 +0,0 @@
-export interface LocalIpProvider {
-    currentLocalIpAddress(): string;
-}

package/lib/network/network-ratchet.d.ts

@@ -1,9 +0,0 @@
-import { ParsedUrl } from '../lang/parsed-url.js';
-export declare class NetworkRatchet {
-    private static LOCAL_IP;
-    static findLocalIp(useCache?: boolean): Promise<string>;
-    static parseUrl(href: string): ParsedUrl;
-    private static updateLocalIP;
-    private static grepSDP;
-    private static updateAddressList;
-}

package/lib/network/network-ratchet.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/network/restful-api-http-error.d.ts

@@ -1,41 +0,0 @@
-export declare class RestfulApiHttpError<T = void> extends Error {
-    private static readonly RATCHET_RESTFUL_API_HTTP_ERROR_FLAG_KEY;
-    private _httpStatusCode;
-    private _errors;
-    private _detailErrorCode;
-    private _endUserErrors;
-    private _details;
-    private _requestId;
-    private _wrappedError;
-    constructor(...errors: string[]);
-    static combineErrorStringsWithDefault(errors: string[], defMessage?: string): string;
-    setFormattedErrorMessage(format: string, ...input: any[]): void;
-    withFormattedErrorMessage(format: string, ...input: any[]): RestfulApiHttpError<T>;
-    withHttpStatusCode(httpStatusCode: number): RestfulApiHttpError<T>;
-    withErrors(errors: string[]): RestfulApiHttpError<T>;
-    withDetailErrorCode(detailErrorCode: number): RestfulApiHttpError<T>;
-    withEndUserErrors(endUserErrors: string[]): RestfulApiHttpError<T>;
-    withDetails(details: T): RestfulApiHttpError<T>;
-    withRequestId(requestId: string): RestfulApiHttpError<T>;
-    withWrappedError(err: Error): RestfulApiHttpError<T>;
-    isWrappedError(): boolean;
-    static wrapError<T = void>(err: Error): RestfulApiHttpError<T>;
-    static objectIsRestfulApiHttpError(obj: any): boolean;
-    get httpStatusCode(): number;
-    get errors(): string[];
-    get detailErrorCode(): number;
-    get endUserErrors(): string[];
-    get details(): T;
-    get requestId(): string;
-    get wrappedError(): Error;
-    set httpStatusCode(value: number);
-    set errors(value: string[]);
-    set detailErrorCode(value: number);
-    set endUserErrors(value: string[]);
-    set details(value: T);
-    set requestId(value: string);
-    set wrappedError(value: Error);
-    static errorIsX0x(errIn: Error, xClass: number): boolean;
-    static errorIs40x(err: Error): boolean;
-    static errorIs50x(err: Error): boolean;
-}

package/lib/network/restful-api-http-error.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/template/ratchet-template-renderer.d.ts

@@ -1,4 +0,0 @@
-export interface RatchetTemplateRenderer {
-    renderTemplate(templateName: string, context: any, layoutName?: string, partialNames?: string[]): Promise<string>;
-    renderTemplateDirect(templateValue: string, context: any, layoutName?: string): Promise<string>;
-}

package/lib/third-party/google/google-recaptcha-ratchet.d.ts

@@ -1,4 +0,0 @@
-export declare class GoogleRecaptchaRatchet {
-    private static readonly GOOGLE_VERIFY_URL;
-    static verifyRecaptchaToken(keySecret: string, token: string, fetchFn?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>): Promise<boolean>;
-}

package/lib/third-party/google/google-recaptcha-ratchet.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/third-party/twilio/twilio-ratchet.d.ts

@@ -1,11 +0,0 @@
-export declare class TwilioRatchet {
-    private accountSid;
-    private authToken;
-    private outBoundNumber;
-    static readonly TWILLIO_BASE_API_URL: string;
-    constructor(accountSid: string, authToken: string, outBoundNumber: string);
-    static sendMessageDirect(accountSid: string, authToken: string, outBoundNumber: string, recipientPhoneNumbers: string[], message: string): Promise<any[]>;
-    static generateTwilioBasicAuth(sid: string, authToken: string): string;
-    sendMessage(recipientPhoneNumbers: string[], message: string): Promise<any[]>;
-    static isValidE164Number(num: string): boolean;
-}

package/lib/third-party/twilio/twilio-verify-ratchet.d.ts

@@ -1,23 +0,0 @@
-export declare class TwilioVerifyRatchet {
-    private accountSid;
-    private authToken;
-    private serviceSid;
-    static readonly TWILLIO_BASE_VERIFY_URL: string;
-    constructor(accountSid: string, authToken: string, serviceSid: string);
-    sendVerificationTokenUsingTwilioVerify(recipientPhoneNumber: string): Promise<string>;
-    simpleCheckVerificationTokenUsingTwilioVerify(recipientPhoneNumber: string, code: string): Promise<boolean>;
-    checkVerificationTokenUsingTwilioVerify(recipientPhoneNumber: string, code: string): Promise<TwilioVerifyCheckResponse>;
-}
-export interface TwilioVerifyCheckResponse {
-    status: string;
-    payee: string;
-    date_updated: string;
-    account_sid: string;
-    to: string;
-    amount: string;
-    valid: boolean;
-    sid: string;
-    date_created: string;
-    service_sid: string;
-    channel: string;
-}

package/lib/transform/built-in-transforms.d.ts

@@ -1,18 +0,0 @@
-import { TransformRule } from './transform-rule.js';
-export declare class BuiltInTransforms {
-    static keysOnly(rule: TransformRule): TransformRule;
-    static valuesOnly(rule: TransformRule): TransformRule;
-    static stringReplaceTransform(input: string, output: string): TransformRule;
-    static stripStringTransform(input: string): TransformRule;
-    static retainAll(input: string[]): TransformRule;
-    static removeAll(input: string[]): TransformRule;
-    static snakeToCamelCase(): TransformRule;
-    static stringToNumber(): TransformRule;
-    static camelToSnakeCase(): TransformRule;
-    static concatenateToNewField(newFieldName: string, oldFieldNamesInOrder: string[], abortIfFieldMissing?: boolean): TransformRule;
-    static numberToBool(fieldNames: string[]): TransformRule;
-    static boolToNumber(fieldNames: string[]): TransformRule;
-    static makeDuplicateField(oldName: string, newName: string): TransformRule;
-    static addField(name: string, valueToAdd: string): TransformRule;
-    static reformatDateFields(fieldNames: string[], oldFormat: string, newFormat: string): TransformRule;
-}

package/lib/transform/transform-ratchet.d.ts

@@ -1,7 +0,0 @@
-import { TransformRule } from './transform-rule.js';
-export declare class TransformRatchet {
-    static transform(toTransform: any, rules?: TransformRule[]): any;
-    private static transformGeneric;
-    private static applyTransformToObject;
-    private static applyTransformToPrimitive;
-}

package/lib/transform/transform-ratchet.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/transform/transform-rule.d.ts

@@ -1,3 +0,0 @@
-export interface TransformRule {
-    transform(value: any, isKey: boolean, context: any): any;
-}

package/lib/tx/transaction-configuration.d.ts

@@ -1,7 +0,0 @@
-import { TransactionResult } from './transaction-result.js';
-import { LoggerLevelName } from '../logger/logger-level-name.js';
-export interface TransactionConfiguration<T> {
-    stepLogLevel?: LoggerLevelName;
-    executeAfterRollback?(result: TransactionResult<T>): Promise<void>;
-    executeAfterRollbackFailure?(result: TransactionResult<T>): Promise<void>;
-}

package/lib/tx/transaction-final-state.d.ts

@@ -1,6 +0,0 @@
-export declare const TransactionFinalState: {
-    Success: string;
-    RolledBack: string;
-    RollbackFailed: string;
-};
-export type TransactionFinalState = (typeof TransactionFinalState)[keyof typeof TransactionFinalState];

package/lib/tx/transaction-ratchet.d.ts

@@ -1,6 +0,0 @@
-import { TransactionStep } from './transaction-step.js';
-import { TransactionResult } from './transaction-result.js';
-import { TransactionConfiguration } from './transaction-configuration.js';
-export declare class TransactionRatchet {
-    static execute<T>(steps: TransactionStep<T>[], initialContext: T, inConfiguration?: TransactionConfiguration<T>): Promise<TransactionResult<T>>;
-}

package/lib/tx/transaction-ratchet.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/tx/transaction-result.d.ts

@@ -1,9 +0,0 @@
-import { TransactionFinalState } from './transaction-final-state.js';
-export interface TransactionResult<T> {
-    finalContext: T;
-    finalState: TransactionFinalState;
-    error?: any;
-    rollbackError?: any;
-    errorStep?: number;
-    rollbackErrorStep?: number;
-}

package/lib/tx/transaction-step.d.ts

@@ -1,5 +0,0 @@
-export interface TransactionStep<T> {
-    execute(context: T, stepNumber?: number): Promise<void>;
-    rollback?(context: T, stepNumber?: number): Promise<void>;
-    name?: string;
-}