@luxonis/ui-utils 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,122 @@
+import React from 'react';
+import { ErrorObject } from 'serialize-error';
+export { serializeError } from 'serialize-error';
+
+declare const SECOND = 1000;
+declare const MINUTE: number;
+declare const HOUR: number;
+declare const DAY: number;
+declare const WEEK: number;
+declare const MONTH: number;
+declare const YEAR: number;
+declare function getShortTimeElapsed(uptime: number): string;
+declare function formatDate(date: Date, format: "iso" | "time-dayofyear" | "full"): string;
+declare function getDateWithTimezone(date: Date | string): Date;
+declare function formatDateISOInTimezone(date: Date, timezone: string): string;
+declare function getShortDateOrDistance(date: Date | null | undefined | string, opts?: {
+    addSuffix?: boolean;
+}): string;
+declare function getDistance(date: Date | null | string | undefined, opts?: {
+    addSuffix?: boolean;
+}): string;
+declare function getShortDate(date: Date | null | undefined | string, fallbackValue?: string): string;
+declare function getTime(date: Date | null | string): string;
+declare function getShortTime(date: Date | null | string): string;
+declare function getShortDateTime(date: Date | null | string): string;
+declare function unixTimestamp(): number;
+declare function unixTimestampWithMillis(): number;
+declare function unixTimestampAtUtc(): number;
+declare function unixTimestampWithMillisAtUtc(): number;
+declare function toTwoDigits(number: number): string;
+declare function secondsToTime(seconds: number): string;
+declare function newestFirstByCreatedAt<T extends {
+    createdAt: Date | string;
+} | {
+    created: Date | string;
+}>(a: T, b: T): number;
+declare function oldestFirstByCreatedAt<T extends {
+    createdAt: Date | string;
+}>(a: T, b: T): number;
+
+type UseDebounceProps = {
+    effect: () => void;
+    dependencies: React.DependencyList;
+    debounceDelay: number;
+};
+declare const useDebounce: (props: UseDebounceProps) => void;
+
+declare const formatBps: (valueRaw: unknown, fmt?: string) => string;
+declare const formatBytes: (valueRaw: unknown, fmt?: string) => string;
+declare function formatTemperature(value: number): string;
+declare function formatIntTemperature(value: number): string;
+declare function formatLastSeen(lastSeen: Date | string | undefined | null): string;
+declare function formatUptime(uptimeInit: number, compact?: boolean): string;
+declare function formatPrettyDate(date: Date): string;
+declare function formatPlatform(platformString: string | null | undefined): string;
+declare function formatCapitalizeFirstLetter(text: string): string;
+declare function formatCapitalizeWords(sentence: string): string;
+declare function formatMaxLength(value: string, maxLength: number, ellipsis?: boolean): string;
+declare function formatUsbPort(value: string | null): string;
+declare function formatRobotName(value: string | null): string;
+declare function formatAgentVersion(version: string | number | bigint): string;
+declare function formatFirmwareVersion(version: string | undefined | null): string;
+declare function formatSlug(value: string): string;
+
+declare global {
+    var ENV: Record<string, string> | undefined;
+}
+type LoggerConfig = {
+    level: number;
+    rootComponent: string;
+    format: 'pretty' | 'plain' | 'json';
+    runtime: 'development' | 'production' | 'test';
+};
+declare enum LogLevel {
+    trace = 10,
+    debug = 20,
+    info = 30,
+    warn = 40,
+    error = 50,
+    fatal = 60
+}
+type LogFnParamsBase = readonly [message: string];
+type LogFnParamsCtx = readonly [ctx: MessageContext, message: string];
+type LogFnParams = LogFnParamsBase | LogFnParamsCtx;
+declare function isLogFnParamsCtx(params: LogFnParams): params is LogFnParamsCtx;
+type Logger = {
+    readonly config: LoggerConfig;
+    readonly name: string;
+    serializeMessage: SerializeMessageFn;
+    configure: (config: Partial<LoggerConfig>) => void;
+    child: (component: string) => Logger;
+    canLogLevel: (level: LogLevel) => boolean;
+    trace: (...params: LogFnParams) => void;
+    debug: (...params: LogFnParams) => void;
+    info: (...params: LogFnParams) => void;
+    warn: (...params: LogFnParams) => void;
+    error: (...params: LogFnParams) => void;
+    fatal: (...params: LogFnParams) => void;
+};
+type MessageContext = {
+    [key: string]: SupportedContextValue;
+};
+type SupportedContextValue = string | number | Date | {
+    [key: string]: any;
+} | unknown | undefined | null | Error | ErrorObject;
+type Message = {
+    logger: Logger;
+    when: Date;
+    context: MessageContext;
+    message: string;
+    level: number;
+    component: string | null;
+};
+type SerializeMessageFn = (message: Message) => string;
+declare function buildSerializeMessage(config: LoggerConfig): SerializeMessageFn;
+declare const buildLogger: (name: string, initialConfig: LoggerConfig) => Logger;
+declare const defaultLogger: Logger;
+declare const errorAsContext: (e: unknown) => MessageContext;
+declare function prettifyMessage(data: string): string;
+declare const log: Logger;
+
+export { DAY, HOUR, type LogFnParams, type LogFnParamsBase, type LogFnParamsCtx, LogLevel, type Logger, type LoggerConfig, MINUTE, MONTH, type Message, type MessageContext, SECOND, WEEK, YEAR, buildLogger, buildSerializeMessage, defaultLogger, errorAsContext, formatAgentVersion, formatBps, formatBytes, formatCapitalizeFirstLetter, formatCapitalizeWords, formatDate, formatDateISOInTimezone, formatFirmwareVersion, formatIntTemperature, formatLastSeen, formatMaxLength, formatPlatform, formatPrettyDate, formatRobotName, formatSlug, formatTemperature, formatUptime, formatUsbPort, getDateWithTimezone, getDistance, getShortDate, getShortDateOrDistance, getShortDateTime, getShortTime, getShortTimeElapsed, getTime, isLogFnParamsCtx, log, newestFirstByCreatedAt, oldestFirstByCreatedAt, prettifyMessage, secondsToTime, toTwoDigits, unixTimestamp, unixTimestampAtUtc, unixTimestampWithMillis, unixTimestampWithMillisAtUtc, useDebounce };