@whook/whook/dist/types/crons.d.ts

Build strong and efficient REST web services.

import { type Dependencies, type ServiceInitializer, type ProviderInitializer } from 'knifecycle';
import { type WhookAPISchemaDefinition } from './openapi.js';
import { type JsonValue } from 'type-fest';
import { type ExpressiveJSONSchema } from 'ya-json-schema-types';
import { type WhookHandlerWrapper } from './wrappers.js';
import { type WhookEnvironmentsConfig } from '../libs/environments.js';
export declare const DEFAULT_CRON_CONFIG: WhookCronConfig;
export type WhookBaseCronConfig = {
    environments?: WhookEnvironmentsConfig;
    targetHandler?: string;
};
export interface WhookCronConfig extends WhookBaseCronConfig {
}
export type WhookCronDefinition<T extends JsonValue = JsonValue> = {
    name: string;
    summary?: string;
    schedules: {
        rule: string;
        body: T;
        environments?: WhookEnvironmentsConfig;
    }[];
    schema: ExpressiveJSONSchema;
    config?: WhookCronConfig;
};
export interface WhookCronHandler<T extends JsonValue, D extends WhookCronDefinition<T> = WhookCronDefinition<T>> {
    (input: {
        date: string;
        body: T;
    }, definition?: D): Promise<void>;
}
export type WhookCronHandlerInitializer<T extends JsonValue, D extends Dependencies = Record<string, unknown>> = ServiceInitializer<D, WhookCronHandler<T>> | ProviderInitializer<D, WhookCronHandler<T>>;
export declare const CRON_ASIDE_COMPONENTS_SUFFIXES: readonly ["Schema"];
export declare const CRON_ASIDE_COMPONENTS_PROPERTY_MAP: {
    readonly Schema: "schema";
};
export type WhookCronAsideComponentSuffix = (typeof CRON_ASIDE_COMPONENTS_SUFFIXES)[number];
export interface WhookCronModule<T extends JsonValue = JsonValue> {
    default: WhookCronHandlerInitializer<T>;
    definition: WhookCronDefinition<T>;
    [name: `${string}Schema`]: WhookAPISchemaDefinition<unknown>;
}
export type WhookCronHandlerWrapper<T extends JsonValue = JsonValue> = WhookHandlerWrapper<WhookCronHandler<T>>;