@aidc-toolkit/core 1.0.25-beta → 1.0.27-beta

package/dist/index.d.cts

@@ -1,230 +0,0 @@
-import { Logger } from 'tslog';
-import { i18n, Resource } from 'i18next';
-
-/**
- * Typed function, applicable to any function, stricter than {@linkcode Function}.
- *
- * @template TFunction
- * Function type.
- */
-type TypedFunction<TFunction extends (...args: Parameters<TFunction>) => ReturnType<TFunction>> = (...args: Parameters<TFunction>) => ReturnType<TFunction>;
-/**
- * Typed synchronous function, applicable to any function that doesn't return a {@linkcode Promise}.
- *
- * @template TFunction
- * Function type.
- */
-type TypedSyncFunction<TFunction extends TypedFunction<TFunction>> = [ReturnType<TFunction>] extends [PromiseLike<unknown>] ? never : TypedFunction<TFunction>;
-/**
- * Determine the fundamental promised type. This is stricter than `Awaited<Type>` in that it requires a {@linkcode
- * Promise}.
- *
- * @template T
- * Promised type.
- */
-type PromisedType<T> = [T] extends [PromiseLike<infer TPromised>] ? TPromised : never;
-/**
- * Typed asynchronous function, applicable to any function that returns a {@linkcode Promise}.
- *
- * @template TFunction
- * Function type.
- */
-type TypedAsyncFunction<TMethod extends (...args: Parameters<TMethod>) => PromiseLike<PromisedType<ReturnType<TMethod>>>> = (...args: Parameters<TMethod>) => Promise<PromisedType<ReturnType<TMethod>>>;
-/**
- * Nullishable type. Extends a type by allowing `null` and `undefined`.
- *
- * @template T
- * Type.
- */
-type Nullishable<T> = T | null | undefined;
-/**
- * Non-nullishable type. If T is an object type, it is spread and attributes within it are made non-nullishable.
- * Equivalent to a deep `Required<T>` for an object and `NonNullable<T>` for any other type.
- *
- * @template T
- * Type.
- */
-type NonNullishable<T> = T extends object ? {
-    [P in keyof T]-?: NonNullishable<T[P]>;
-} : NonNullable<T>;
-/**
- * Make some keys within a type optional.
- *
- * @template T
- * Object type.
- *
- * @template K
- * Object key type.
- */
-type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-/**
- * Type to restrict property keys to those that are strings and that support a specified type.
- *
- * @template T
- * Object type.
- *
- * @template P
- * Object property type.
- */
-type PropertyKeys<T, P> = {
-    [K in keyof T]: K extends string ? T[K] extends P ? K : never : never;
-}[keyof T];
-
-/**
- * Create an object with omitted entries.
- *
- * @template T
- * Object type.
- *
- * @template K
- * Object key type.
- *
- * @param o
- * Object.
- *
- * @param keys
- * Keys to omit.
- *
- * @returns
- * Edited object.
- */
-declare function omit<T extends object, K extends keyof T>(o: T, ...keys: K[]): Omit<T, K>;
-/**
- * Create an object with picked entries.
- *
- * @template T
- * Object type.
- *
- * @template K
- * Object key type.
- *
- * @param o
- * Object.
- *
- * @param keys
- * Keys to pick.
- *
- * @returns
- * Edited object.
- */
-declare function pick<T extends object, K extends keyof T>(o: T, ...keys: K[]): Pick<T, K>;
-/**
- * Cast a property as a more narrow type.
- *
- * @template T
- * Object type.
- *
- * @template K
- * Object key type.
- *
- * @template TAsType
- * Desired type.
- *
- * @param o
- * Object.
- *
- * @param key
- * Key of property to cast.
- *
- * @returns
- * Single-key object with property cast as desired type.
- */
-declare function propertyAs<T extends object, K extends keyof T, TAsType extends T[K]>(o: T, key: K): Readonly<Omit<T, K> extends T ? Partial<Record<K, TAsType>> : Record<K, TAsType>>;
-/**
- * Determine if argument is nullish. Application extension may pass `null` or `undefined` to missing parameters.
- *
- * @param argument
- * Argument.
- *
- * @returns
- * True if argument is undefined or null.
- */
-declare function isNullish(argument: unknown): argument is null | undefined;
-
-/**
- * Log levels.
- */
-declare const LogLevels: {
-    readonly Silly: 0;
-    readonly Trace: 1;
-    readonly Debug: 2;
-    readonly Info: 3;
-    readonly Warn: 4;
-    readonly Error: 5;
-    readonly Fatal: 6;
-};
-/**
- * Log level key.
- */
-type LogLevelKey = keyof typeof LogLevels;
-/**
- * Log level.
- */
-type LogLevel = typeof LogLevels[LogLevelKey];
-/**
- * Get a simple logger with an optional log level.
- *
- * @param logLevel
- * Log level as enumeration value or string.
- *
- * @returns
- * Logger.
- */
-declare function getLogger(logLevel?: string | number): Logger<unknown>;
-
-/**
- * Locale strings type for generic manipulation.
- */
-interface LocaleResources {
-    [key: string]: LocaleResources | string;
-}
-/**
- * Internationalization operating environments.
- */
-declare const I18nEnvironments: {
-    /**
-     * Command-line interface (e.g., unit tests).
-     */
-    readonly CLI: 0;
-    /**
-     * Web server.
-     */
-    readonly Server: 1;
-    /**
-     * Web browser.
-     */
-    readonly Browser: 2;
-};
-/**
- * Internationalization operating environment key.
- */
-type I18nEnvironmentKey = keyof typeof I18nEnvironments;
-/**
- * Internationalization operating environment.
- */
-type I18nEnvironment = typeof I18nEnvironments[I18nEnvironmentKey];
-/**
- * Initialize internationalization.
- *
- * @param i18next
- * Internationalization object. As multiple objects exists, this parameter represents the one for the module for which
- * internationalization is being initialized.
- *
- * @param environment
- * Environment in which the application is running.
- *
- * @param debug
- * Debug setting.
- *
- * @param defaultNS
- * Default namespace.
- *
- * @param resources
- * Resources.
- *
- * @returns
- * Void promise.
- */
-declare function i18nCoreInit(i18next: i18n, environment: I18nEnvironment, debug: boolean, defaultNS: string, ...resources: Resource[]): Promise<void>;
-
-export { type I18nEnvironment, type I18nEnvironmentKey, I18nEnvironments, type LocaleResources, type LogLevel, type LogLevelKey, LogLevels, type NonNullishable, type Nullishable, type Optional, type PromisedType, type PropertyKeys, type TypedAsyncFunction, type TypedFunction, type TypedSyncFunction, getLogger, i18nCoreInit, isNullish, omit, pick, propertyAs };