@bitblit/ratchet-common 4.0.1-alpha

package/lib/logger/logger-options.d.ts

@@ -0,0 +1,13 @@
+import { LogMessageFormatType } from './log-message-format-type.js';
+import { LoggerLevelName } from './logger-level-name.js';
+import { LogMessageProcessor } from './log-message-processor.js';
+import { LoggerOutputFunction } from './logger-output-function.js';
+export interface LoggerOptions {
+    initialLevel?: LoggerLevelName;
+    formatType?: LogMessageFormatType;
+    trace?: string;
+    globalVars?: Record<string, string | number | boolean>;
+    outputFunction?: LoggerOutputFunction;
+    ringBufferSize?: number;
+    preProcessors?: LogMessageProcessor[];
+}

package/lib/logger/logger-output-function.d.ts

@@ -0,0 +1,5 @@
+export declare enum LoggerOutputFunction {
+    Console = "Console",
+    ConsoleNoDebug = "ConsoleNoDebug",
+    StdOut = "StdOut"
+}

package/lib/logger/logger-ring-buffer.d.ts

@@ -0,0 +1,18 @@
+import { LogMessage } from './log-message.js';
+import { LogSnapshot } from './log-snapshot.js';
+export declare class LoggerRingBuffer {
+    private _lastLogMessage;
+    private _buffer;
+    private _bufferIdx;
+    private _lastSnapshotIdx;
+    private _bufferSize;
+    constructor(size: number);
+    get currentIndex(): number;
+    get lastSnapshotIdx(): number;
+    set bufferSize(newSize: number);
+    getMessages(inStartFrom?: number, clear?: boolean, reverseSort?: boolean): LogMessage[];
+    takeSnapshot(): LogSnapshot;
+    getLastLogMessage(): LogMessage;
+    private clearRingBuffer;
+    addToRingBuffer(newMsg: LogMessage): void;
+}

package/lib/logger/logger-util.d.ts

@@ -0,0 +1,8 @@
+import { LoggerLevelName } from './logger-level-name.js';
+import { LoggerOutputFunction } from './logger-output-function.js';
+export declare class LoggerUtil {
+    private static LOG_LEVELS_IN_ORDER;
+    static handlerFunctionMap(outputFn?: LoggerOutputFunction): Map<LoggerLevelName, (...any: any[]) => void>;
+    static defaultHandlerFunction(): (...any: any[]) => void;
+    static levelIsEnabled(targetLevel: LoggerLevelName, currentEnabled: LoggerLevelName): boolean;
+}

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

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

package/lib/logger/logger.d.ts

@@ -0,0 +1,43 @@
+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_INSTANCES;
+    private static DEFAULT_OPTIONS;
+    static applyDefaultsToOptions(input?: LoggerOptions): LoggerOptions;
+    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

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

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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,6 @@
+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/network/browser-local-ip-provider.d.ts

@@ -0,0 +1,7 @@
+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

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

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

@@ -0,0 +1,6 @@
+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

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

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

@@ -0,0 +1,9 @@
+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

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

package/lib/stream/buffer-writable.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Writable } from 'stream';
+export declare class BufferWritable extends Writable {
+    private _val;
+    constructor();
+    _write(chunk: any, encoding: string, callback: any): void;
+    get value(): Buffer;
+}

package/lib/stream/multi-stream.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+import { Readable, ReadableOptions } from 'stream';
+export declare class MultiStream extends Readable {
+    _object: any;
+    constructor(object: any, options?: ReadableOptions);
+    _read(): void;
+}

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

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Readable } from 'stream';
+export declare class StreamRatchet {
+    private constructor();
+    static readableToBufferSync(stream: Readable): Buffer;
+    static webReadableStreamToBuffer(stream: ReadableStream): Promise<Buffer>;
+    static webReadableStreamToString(stream: ReadableStream): Promise<string>;
+    static stringToReadable(input: string): Readable;
+    static stringToWebReadableStream(input: string): ReadableStream;
+    static anyToStringReadable(input: any): Readable;
+}

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

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

package/lib/stream/string-writable.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { Writable } from 'stream';
+export declare class StringWritable extends Writable {
+    private _val;
+    constructor();
+    _write(chunk: any, encoding: string, callback: any): void;
+    get value(): string;
+}

package/lib/stream/string-writable.spec.d.ts

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

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

@@ -0,0 +1,4 @@
+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

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

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

@@ -0,0 +1,11 @@
+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/transform/built-in-transforms.d.ts

@@ -0,0 +1,18 @@
+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-rule.d.ts

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

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,5 @@
+export declare enum TransactionFinalState {
+    Success = "Success",
+    RolledBack = "RolledBack",
+    RollbackFailed = "RollbackFailed"
+}

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

@@ -0,0 +1,6 @@
+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

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

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

@@ -0,0 +1,9 @@
+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

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

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@bitblit/ratchet-common",
+  "version": "4.0.1-alpha",
+  "description": "Common tools for general use",
+  "type": "module",
+  "files": [
+    "lib/*",
+    "bin/*"
+  ],
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.mjs"
+    }
+  },
+  "contributors": [
+    "Christopher Weiss <bitblit@gmail.com>",
+    "William Weiss <npm@codification.org>",
+    "Austin Grantham <agrantham@algidious.com>",
+    "Lucas Myers <veganbeef@protonmail.com>",
+    "Joel Flint <joel@stimulimedia.net>",
+    "Bilal Shahid <bshahid@adomni.com>"
+  ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "pretty-quick --staged"
+    }
+  },
+  "prettier": {
+    "printWidth": 140,
+    "singleQuote": true,
+    "arrowParens": "always"
+  },
+  "config": {},
+  "scripts": {
+    "watch": "tsc-watch",
+    "clean": "shx rm -Rf lib",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest",
+    "docs": "typedoc",
+    "lint": "eslint src/**/*.ts",
+    "lint-fix": "eslint --fix src/**/*.ts",
+    "generate-barrels": "barrelsby -q --delete -d src -e .*\\.spec\\.ts && sed -i 's/\\x27;/.js\\x27;/' src/index.ts",
+    "build": "yarn clean && yarn generate-barrels && rollup -c rollup.config.js",
+    "force-build": "tsc --build --force"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bitblit/Ratchet"
+  },
+  "keywords": [
+    "wrench",
+    "utility"
+  ],
+  "bugs": {
+    "url": "https://github.com/bitblit/Ratchet/issues"
+  },
+  "homepage": "https://github.com/bitblit/Ratchet#readme",
+  "engines": {
+    "node": ">=14.18"
+  },
+  "license": "Apache-2.0",
+  "dependencies": {
+    "ts-enum-util": "4.0.2"
+  },
+  "peerDependencies": {
+  },
+  "peerDependenciesMeta": {
+  },
+  "devDependencies": {
+  }
+}