n8n/dist/config/types.d.ts

n8n Workflow Automation Tool

import type { RedisOptions } from 'ioredis';
import type { BinaryData } from 'n8n-core';
import type { IProcessedDataConfig } from 'n8n-workflow';
import type { schema } from './schema';
type GetPathSegments<Traversable, Filter> = Traversable extends Filter ? [] : {
    [K in ValidKeys<Traversable>]: [K, ...GetPathSegments<Traversable[K], Filter>];
}[ValidKeys<Traversable>];
type JoinByDotting<T extends string[]> = T extends [infer F] ? F : T extends [infer F, ...infer R] ? F extends string ? R extends string[] ? `${F}.${JoinByDotting<R>}` : never : never : string;
type ToDottedPath<T> = JoinByDotting<RemoveExcess<T>>;
type CollectPathsByType<T> = ToDottedPath<GetPathSegments<typeof schema, T>>;
type NumericPath = CollectPathsByType<number>;
type BooleanPath = CollectPathsByType<boolean>;
type StringLiteralArrayPath = CollectPathsByType<Readonly<string[]>>;
type StringPath = CollectPathsByType<string>;
type ConfigOptionPath = NumericPath | BooleanPath | StringPath | StringLiteralArrayPath | keyof ExceptionPaths;
type ToReturnType<T extends ConfigOptionPath> = T extends NumericPath ? number : T extends BooleanPath ? boolean : T extends StringLiteralArrayPath ? StringLiteralMap[T] : T extends keyof ExceptionPaths ? ExceptionPaths[T] : T extends StringPath ? string : unknown;
type ExceptionPaths = {
    'queue.bull.redis': RedisOptions;
    binaryDataManager: BinaryData.Config;
    processedDataManager: IProcessedDataConfig;
    'userManagement.isInstanceOwnerSetUp': boolean;
    'ui.banners.dismissed': string[] | undefined;
    easyAIWorkflowOnboarded: boolean | undefined;
};
type GetPathSegmentsWithUnions<T> = T extends ReadonlyArray<infer C> ? [C] : {
    [K in ValidKeys<T>]: [K, ...GetPathSegmentsWithUnions<T[K]>];
}[ValidKeys<T>];
type ToPathUnionPair<T extends string[]> = T extends [...infer Path, infer Union] ? Path extends string[] ? {
    path: ToDottedPath<Path>;
    union: Union;
} : never : never;
type ToStringLiteralMap<T extends {
    path: string;
    union: string;
}> = {
    [Path in T['path']]: Extract<T, {
        path: Path;
    }>['union'];
};
type StringLiteralMap = ToStringLiteralMap<ToPathUnionPair<GetPathSegmentsWithUnions<typeof schema>>>;
type ValidKeys<T> = keyof T extends string ? keyof T extends keyof NumberConstructor ? never : keyof T : never;
type RemoveExcess<T> = T extends [...infer Path, 'format' | 'default'] ? Path extends string[] ? Path : never : never;
declare module 'convict' {
    interface Config<T> {
        getEnv<Path extends ConfigOptionPath>(path: Path): ToReturnType<Path>;
    }
}
export {};