@orion-js/echoes 4.3.2 → 4.4.1

package/dist/index.d.cts

@@ -1,145 +0,0 @@
-import { SchemaFieldType, InferSchemaType } from '@orion-js/schema';
-import * as kafkajs from 'kafkajs';
-import { EachMessagePayload, Producer, Consumer, KafkaConfig, ProducerConfig, ConsumerConfig } from 'kafkajs';
-
-interface EchoRequestConfig<TParamsSchema extends SchemaFieldType, TReturnsSchema extends SchemaFieldType> {
-    params?: TParamsSchema;
-    returns?: TReturnsSchema;
-    resolve(params?: InferSchemaType<TParamsSchema>, context?: any): Promise<InferSchemaType<TReturnsSchema>>;
-    attemptsBeforeDeadLetter?: number;
-}
-interface EchoEventConfig<TParamsSchema extends SchemaFieldType, TReturnsSchema extends SchemaFieldType> {
-    params?: TParamsSchema;
-    returns?: TReturnsSchema;
-    resolve(params?: InferSchemaType<TParamsSchema>, context?: any): Promise<InferSchemaType<TReturnsSchema>>;
-    attemptsBeforeDeadLetter?: number;
-}
-type EchoConfig<TParamsSchema extends SchemaFieldType, TReturnsSchema extends SchemaFieldType, TEchoType extends 'event' | 'request' = 'event' | 'request'> = (TEchoType extends 'event' ? EchoEventConfig<TParamsSchema, TReturnsSchema> : EchoRequestConfig<TParamsSchema, TReturnsSchema>) & {
-    type: TEchoType;
-};
-type EchoType<TParamsSchema extends SchemaFieldType = any, TReturnsSchema extends SchemaFieldType = any, TEchoType extends 'event' | 'request' = 'event' | 'request'> = {
-    params?: TParamsSchema;
-    returns?: TReturnsSchema;
-    attemptsBeforeDeadLetter?: number;
-    type: TEchoType;
-    resolve(params?: InferSchemaType<TParamsSchema>, context?: any): Promise<InferSchemaType<TReturnsSchema>>;
-    onMessage(messageData: EachMessagePayload): Promise<void>;
-    onRequest(serializedParams: string): any;
-};
-interface PublishOptions<TParams = any> {
-    topic: string;
-    params: TParams;
-    acks?: number;
-    timeout?: number;
-}
-interface RequestOptions<TParams> {
-    method: string;
-    service: string;
-    params: TParams;
-    retries?: number;
-    timeout?: number;
-}
-interface RequestHandlerResponse {
-    result?: any;
-    error?: any;
-    isUserError?: boolean;
-    isValidationError?: boolean;
-    errorInfo?: {
-        error: string;
-        message: string;
-        extra?: any;
-        validationErrors?: any;
-    };
-}
-interface MakeRequestParams {
-    url: string;
-    retries?: number;
-    timeout?: number;
-    data: {
-        body: object;
-        signature: string;
-    };
-}
-interface RequestMakerResult {
-    statusCode: number;
-    data: object;
-}
-type RequestMaker = (options: MakeRequestParams) => Promise<RequestMakerResult>;
-interface RequestsConfig {
-    /**
-     * The secret key used to sign all requests. Shared between all your services.
-     * You can also set the env var echoes_password or process.env.ECHOES_PASSWORD
-     */
-    key?: string;
-    /**
-     * The path of the echoes http receiver. Defaults to /echoes-services
-     */
-    handlerPath?: string;
-    /**
-     * Map of all the services that have echoes requests handlers
-     */
-    services?: {
-        [key: string]: string;
-    };
-    /**
-     * A custom function that make the requests to the services. Uses axios by default
-     */
-    makeRequest?: RequestMaker;
-}
-interface EchoesMap {
-    [key: string]: EchoType<any, any>;
-}
-interface EchoesOptions {
-    client?: KafkaConfig;
-    producer?: ProducerConfig;
-    consumer?: ConsumerConfig;
-    requests?: RequestsConfig;
-    echoes: EchoesMap;
-    /**
-     * Defaults to true. When true, allows a reconnecting service to read missed messages.
-     */
-    readTopicsFromBeginning?: boolean;
-    /**
-     * Defaults to 4. How many partitions to consume concurrently, adjust this with the members to partitions ratio to avoid idle consumers.
-     */
-    partitionsConsumedConcurrently?: number;
-    /**
-     * Defaults to 1. How many members are in comparison to partitions, this is used to determine if the consumer group has room for more members. Numbers over 1 leads to idle consumers. Numbers under 1 needs partitionsConsumedConcurrently to be more than 1.
-     */
-    membersToPartitionsRatio?: number;
-}
-interface EchoesConfigHandler {
-    producer?: Producer;
-    consumer?: Consumer;
-    requests?: RequestsConfig;
-    echoes?: EchoesMap;
-}
-
-declare function startService(options: EchoesOptions): Promise<void>;
-declare function stopService(): Promise<void>;
-
-/**
- * Publish
- */
-declare function publish<TParams = any>(options: PublishOptions<TParams>): Promise<kafkajs.RecordMetadata[]>;
-
-declare function request<TData = any, TParams = any>(options: RequestOptions<TParams>): Promise<TData>;
-
-interface EchoesPropertyDescriptor extends Omit<PropertyDecorator, 'value'> {
-    value?: EchoConfig<any, any>['resolve'];
-}
-declare function Echoes(): (target: any, context: ClassDecoratorContext<any>) => void;
-declare function EchoEvent(): (method: any, context: ClassFieldDecoratorContext | ClassMethodDecoratorContext) => any;
-declare function EchoEvent(options?: Omit<EchoConfig<any, any>, 'resolve' | 'type'>): (method: any, context: ClassMethodDecoratorContext) => any;
-declare function EchoRequest(): (method: any, context: ClassFieldDecoratorContext | ClassMethodDecoratorContext) => any;
-declare function EchoRequest(options?: Omit<EchoConfig<any, any>, 'resolve' | 'type'>): (method: any, context: ClassMethodDecoratorContext) => any;
-declare function getServiceEchoes(target: any): EchoesMap;
-
-/**
- * @deprecated Use createEchoRequest and createEchoEvent instead
- */
-declare const echo: <TParamsSchema extends SchemaFieldType, TReturnsSchema extends SchemaFieldType, TEchoType extends "event" | "request">(options: EchoConfig<TParamsSchema, TReturnsSchema, TEchoType>) => EchoType<TParamsSchema, TReturnsSchema, TEchoType>;
-declare function createEchoRequest<TParamsSchema extends SchemaFieldType, TReturnsSchema extends SchemaFieldType>(options: EchoRequestConfig<TParamsSchema, TReturnsSchema>): EchoType<TParamsSchema, TReturnsSchema, 'request'>;
-declare function createEchoEvent<TParamsSchema extends SchemaFieldType, TReturnsSchema extends SchemaFieldType>(options: EchoEventConfig<TParamsSchema, TReturnsSchema>): EchoType<TParamsSchema, TReturnsSchema, 'event'>;
-
-export { type EchoConfig, EchoEvent, type EchoEventConfig, EchoRequest, type EchoRequestConfig, type EchoType, Echoes, type EchoesConfigHandler, type EchoesMap, type EchoesOptions, type EchoesPropertyDescriptor, type MakeRequestParams, type PublishOptions, type RequestHandlerResponse, type RequestMaker, type RequestMakerResult, type RequestOptions, type RequestsConfig, createEchoEvent, createEchoRequest, echo, getServiceEchoes, publish, request, startService, stopService };