@treatwell/moleculer-essentials 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,373 @@
+import { J as JSONSchemaType, S as SomeJSONSchema, C as CustomActionSchema, A as Alias, a as CustomServiceSchema, D as Document, b as SchemaObject, O as OperationObject, R as ReferenceObject } from './context-factory-BWO3xPWE.mjs';
+export { d as AjvValidator, x as ApiKeySecurityScheme, F as CallbackObject, G as ComponentsObject, j as ContactObject, i as ContextFactory, q as EncodingObject, p as ExampleObject, E as ExternalDocumentationObject, H as HeaderObject, w as HttpSecurityScheme, I as InfoObject, L as LicenseObject, s as LinkObject, M as MediaTypeObject, y as OAuth2SecurityScheme, z as OpenIdSecurityScheme, o as ParameterBaseObject, n as ParameterObject, N as PathItemObject, m as PathsObject, P as PropertiesSchema, r as RequestBodyObject, c as RequiredMembers, t as ResponseObject, u as ResponsesObject, v as SecurityRequirementObject, B as SecuritySchemeObject, l as ServerObject, k as ServerVariableObject, K as TagObject, e as Transform, h as TransformField, f as TransformLevel, g as TransformMap, T as Transformer, V as ValidationSchema, Z as ZodValidator } from './context-factory-BWO3xPWE.mjs';
+import { ObjectId } from 'bson';
+import { ZodType, z as z$1 } from 'zod';
+import { z } from 'zod/v4';
+import { Ajv2019 } from 'ajv/dist/2019.js';
+import * as Moleculer from 'moleculer';
+import { Context, ServiceSchema, ServiceSettingSchema, Service, ServiceBroker, BrokerOptions, Middleware, LoggerConfig, TracerExporters, LoggerInstance, Tracer, Span, MetricReporters, MetricRegistry, MetricReporterOptions } from 'moleculer';
+import { Logger } from 'pino';
+
+declare function omitFields<T extends Record<string, unknown>, F extends keyof T>(schema: JSONSchemaType<T>, fields: F[], refName?: string): JSONSchemaType<Omit<T, F>>;
+declare function pickFields<T extends Record<string, unknown>, F extends keyof T>(schema: JSONSchemaType<T>, fields: F[], refName?: string): JSONSchemaType<Pick<T, F>>;
+declare function optionalExceptFields<T extends Record<string, unknown>, F extends keyof T>(schema: JSONSchemaType<T>, fields: F[], refName?: string): JSONSchemaType<Partial<Omit<T, F>> & Pick<T, F>>;
+declare function optionalFields<T extends Record<string, unknown>, F extends keyof T>(schema: JSONSchemaType<T>, fields: F[], refName?: string): JSONSchemaType<Omit<T, F> & Partial<Pick<T, F>>>;
+declare function toPartialSchema<T extends Record<string, unknown>>(schema: JSONSchemaType<T>, refName?: string): JSONSchemaType<Partial<T>, true>;
+declare function addFieldsToSchema<T extends Record<string, unknown>, F extends Record<string, SomeJSONSchema>>(schema: JSONSchemaType<T>, newFields: F, refName?: string): JSONSchemaType<T & F>;
+declare function composeSchemas<T extends Record<string, unknown>, U extends Record<string, unknown>>(schemaRefName: string | null, schema1: JSONSchemaType<T>, schema2: JSONSchemaType<U>): JSONSchemaType<T & U>;
+declare function composeSchemas<T extends Record<string, unknown>, U extends Record<string, unknown>, V extends Record<string, unknown>>(schemaRefName: string | null, schema1: JSONSchemaType<T>, schema2: JSONSchemaType<U>, schema3: JSONSchemaType<V>): JSONSchemaType<T & U & V>;
+declare function composeSchemas<T extends Record<string, unknown>, U extends Record<string, unknown>, V extends Record<string, unknown>, W extends Record<string, unknown>>(schemaRefName: string | null, schema1: JSONSchemaType<T>, schema2: JSONSchemaType<U>, schema3: JSONSchemaType<V>, schema4: JSONSchemaType<W>): JSONSchemaType<T & U & V & W>;
+
+declare const COERCE_ARRAY_ATTRIBUTE = "x-coerce-array";
+declare const SCHEMA_REF_NAME = "$id";
+declare const EMPTY_OBJECT_SCHEMA: JSONSchemaType<Record<string, never>>;
+declare const DATE_TYPE: JSONSchemaType<Date>;
+declare const OBJECTID_TYPE: JSONSchemaType<ObjectId>;
+
+type OpenAPIMixinOptions = {
+    /**
+     * OpenAPI Tags to be applied to this mixin actions
+     */
+    tags?: string[];
+    swaggerUI?: {
+        version?: string;
+    };
+    /**
+     * Default kinds to be used when no kind is specified in the service or action
+     */
+    defaultKinds?: string[];
+    /**
+     * Additional options to be set on actions generated by this mixin.
+     */
+    actionOptions?: CustomActionSchema;
+    /**
+     * Gives the list of security schemes to apply for a specific action.
+     */
+    getSecuritySchemes?: (action: Alias) => string[] | undefined | false;
+};
+declare function OpenAPIMixin(options: OpenAPIMixinOptions): Partial<CustomServiceSchema<{
+    openapi: {
+        openapi: string;
+        info: {
+            description: string;
+            version: string;
+            title: string;
+        };
+        paths: {};
+        components: {
+            responses: {
+                ServerError: {
+                    description: string;
+                    content: {
+                        'application/json': {
+                            schema: JSONSchemaType<Omit<Moleculer.Errors.MoleculerServerError, "cause">>;
+                        };
+                    };
+                };
+                UnauthorizedError: {
+                    description: string;
+                    content: {
+                        'application/json': {
+                            schema: JSONSchemaType<Record<string, unknown>>;
+                        };
+                    };
+                };
+                FileNotExist: {
+                    description: string;
+                    content: {
+                        'application/json': {
+                            schema: JSONSchemaType<Record<string, unknown>>;
+                        };
+                    };
+                };
+                FileTooBig: {
+                    description: string;
+                    content: {
+                        'application/json': {
+                            schema: JSONSchemaType<Record<string, unknown>>;
+                        };
+                    };
+                };
+                ValidationError: {
+                    description: string;
+                    content: {
+                        'application/json': {
+                            schema: JSONSchemaType<Omit<Moleculer.Errors.ValidationError, "cause">>;
+                        };
+                    };
+                };
+            };
+            schemas: {
+                OpenAPIModel: {
+                    type: string;
+                    properties: {
+                        openapi: {
+                            example: string;
+                            type: string;
+                            description: string;
+                        };
+                        info: {
+                            type: string;
+                            properties: {
+                                description: {
+                                    type: string;
+                                };
+                            };
+                        };
+                        tags: {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        };
+                    };
+                    required: string[];
+                };
+            };
+        };
+    };
+}, {
+    matchesKind(openAPINames: string[] | null | undefined, kind: string | undefined): boolean;
+    /**
+     * Generate the OpenAPI schema for the specified kind.
+     */
+    generateSchema(ctx: Context, kind?: string): Promise<Document>;
+}, unknown, unknown>>;
+
+/**
+ * This class walks through a JSON schema and extracts all the refs.
+ * When a ref is found, it calls the onNewRef child method, and replace the schema with the ref.
+ */
+declare abstract class RefExtractor {
+    private refs;
+    protected meta: Record<string, unknown>;
+    /**
+     * Allows to translate the ref name to a new ref name.
+     * The walk method will use the response to decide if a ref was already extracted or not.
+     */
+    protected abstract refReplacer(ref: string): string;
+    /**
+     * Called when a new ref is found. Allows to store the ref in a map or do something else.
+     */
+    protected abstract onNewRef(originalRef: string, schema: SomeJSONSchema): unknown;
+    protected onError(message: string, other?: Record<string, unknown>): void;
+    setMeta(meta: Record<string, unknown>): void;
+    extract(schemaToExtract: SomeJSONSchema, initialRef?: string | undefined, skipRoot?: boolean): SomeJSONSchema;
+}
+
+declare class OpenAPIExtractor extends RefExtractor {
+    private readonly doc;
+    constructor(doc: Document);
+    refReplacer(ref: string): string;
+    onNewRef(originalRef: string, schema: SomeJSONSchema): void;
+}
+
+type OpenAPIResponses = SchemaObject<NonNullable<any>> | z.ZodType;
+
+declare function createOpenAPIResponses(model: OpenAPIResponses, description?: string): OperationObject;
+
+/**
+ * Convert a zod schema to a JSON Schema with an OpenAPI spec (for refs).
+ *
+ * We always take the input version of a Zod schema, before transforms.
+ * It means that we don't support inputs not JSON schemas compatible, including dates, objectIds.
+ * For this, you should use helpers provided by this package.
+ */
+declare function zodToOpenAPISchema(schema: ZodType, extractor: OpenAPIExtractor): SchemaObject | ReferenceObject;
+declare const zodDate: z$1.ZodPipe<z$1.ZodTransform<unknown, unknown>, z$1.ZodDate>;
+declare const zodObjectId: z$1.ZodPipe<z$1.ZodTransform<unknown, unknown>, z$1.ZodCustom<ObjectId, ObjectId>>;
+declare function zodCoerceArray<T extends ZodType>(element: T, params?: Parameters<typeof z$1.array>[1]): z$1.ZodPipe<z$1.ZodTransform<any[] | undefined, unknown>, z$1.ZodArray<T>>;
+
+declare class AjvExtractor extends RefExtractor {
+    private readonly ajv;
+    constructor(ajv: Ajv2019);
+    protected refReplacer(ref: string): string;
+    protected onNewRef(originalRef: string, schema: SomeJSONSchema): void;
+}
+
+/**
+ * This function is a NO-OP and is only useful for Typescript types.
+ * Using Generic arguments allows TS to infer types directly from the object
+ * passed as input.
+ *
+ * For the wrapMixin fn, it will return the exact type of the object passed
+ * in order to generate smart typings for services using the mixin.
+ *
+ * In case of a mixin using options (a function that will return the mixin),
+ * for types to work, you must NOT specify the return type and let TS infer
+ * the return type.
+ *
+ * For now, only methods are typed.
+ */
+declare function wrapMixin<Settings, Methods, Mixins, AdditionalProperties>(svc: Partial<CustomServiceSchema<Settings, Methods, Mixins, AdditionalProperties>>): typeof svc;
+/**
+ * This function is a NO-OP and is only useful for Typescript types.
+ * Using Generic arguments allows TS to infer types directly from the object
+ * passed as input.
+ *
+ * For the wrapService fn, it will return a moleculer ServiceSchema that will stripe
+ * out every smart typing of methods. This should never be used inside a mixin.
+ */
+declare function wrapService<Settings, Methods, Mixins, AdditionalProperties>(svc: CustomServiceSchema<Settings, Methods, Mixins, AdditionalProperties>): ServiceSchema;
+
+/**
+ * This class replace the default Service class in Moleculer to:
+ * - Replace the params of actions with functions that return the params in
+ *   order to prevent moleculer from merging them.
+ */
+declare class ServiceFactory<S = ServiceSettingSchema> extends Service<S> {
+    constructor(broker: ServiceBroker, schema?: ServiceSchema<S>);
+}
+
+declare function createServiceBroker(opts?: BrokerOptions): ServiceBroker;
+
+type LabelValue = string;
+type Operator = 'in' | 'notin' | 'exists' | 'doesnotexists';
+type Rule<Op extends Operator = Operator> = Op extends 'in' | 'notin' ? {
+    key: string;
+    operator: Op;
+    values: LabelValue[];
+} : {
+    key: string;
+    operator: Op;
+};
+type Selector = {
+    matchLabels?: Record<string, LabelValue>;
+    matchExpressions: Rule[];
+};
+type ServiceMetadata = Record<string, LabelValue | number | boolean> | undefined;
+declare function isServiceSelected(metadata: ServiceMetadata, selector: Partial<Selector>): boolean;
+declare function getMetadataFromService(svc: Partial<ServiceSchema>): ServiceMetadata;
+
+type HealthCheckOptions = {
+    port: number;
+    startDebounce: number;
+    readiness: {
+        path: string;
+    };
+    liveness: {
+        path: string;
+    };
+};
+/**
+ * Inspired from https://gist.github.com/icebob/c717ae22002b9ecaa4b253a67952da3a
+ */
+declare function HealthCheckMiddleware(_opts: Partial<HealthCheckOptions>): Middleware;
+
+declare const createLogger: (bindings: Record<string, unknown>) => Logger;
+declare function createLoggerConfig(): LoggerConfig;
+declare const defaultLogger: Logger;
+
+type NewrelicTraceExporterOptions = {
+    logger?: LoggerInstance;
+    safetyTags?: boolean;
+    /**
+     * Base URL for NewRelic server.
+     */
+    baseURL?: string;
+    /**
+     * Maximum number of spans to be sent in one time.
+     */
+    batchSize?: number;
+    /**
+     * NewRelic Insert API Key.
+     */
+    insertKey?: string;
+    /**
+     * Batch send time interval in seconds.
+     */
+    interval?: number;
+    /**
+     * Default span tags.
+     */
+    defaultTags?: Record<string, unknown> | (() => Record<string, unknown>);
+};
+/**
+ * >>> Hard copy of the moleculer NewRelic provider. It didn't handle errors correctly
+ *
+ * Trace Exporter for NewRelic using Zipkin data.
+ *
+ * NewRelic zipkin tracer: https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/trace-api/report-zipkin-format-traces-trace-api
+ * API v2: https://zipkin.io/zipkin-api/#/
+ */
+declare class NewrelicTraceExporter extends TracerExporters.Base {
+    private queue;
+    private timer;
+    private defaultTags;
+    constructor(opts: NewrelicTraceExporterOptions);
+    /**
+     * Initialize Trace Exporter.
+     */
+    init(tracer: Tracer): void;
+    /**
+     * Stop Trace exporter
+     */
+    stop(): Promise<void>;
+    /**
+     * Span is finished.
+     */
+    spanFinished(span: Span): void;
+    /**
+     * Flush tracing data to NewRelic Zipkin api endpoint
+     */
+    flush(): Promise<void>;
+    /**
+     * Generate tracing data for NewRelic
+     */
+    generateTracingData(): unknown[];
+    /**
+     * Create NewRelic v1 payload
+     */
+    makePayload(span: Span): unknown;
+}
+
+type DefaultTags = Record<string, unknown> | ((registry: MetricRegistry) => Record<string, unknown>);
+type NewrelicMetricsOptions = MetricReporterOptions & {
+    /**
+     * Base URL for NewRelic server.
+     */
+    baseURL?: string;
+    /**
+     * NewRelic Insert API Key
+     */
+    insertKey?: string;
+    /**
+     * Batch send time interval in seconds.
+     */
+    interval?: number;
+    /**
+     * Default tags to be added to all metrics.
+     */
+    defaultTags?: DefaultTags;
+};
+/**
+ * NewRelic metrics reporter.
+ *
+ * NewRelic API: https://docs.newrelic.com/docs/data-apis/understand-data/metric-data/metric-data-type/
+ */
+declare class NewrelicMetricsReporter extends MetricReporters.Base {
+    registry: MetricRegistry;
+    logger: LoggerInstance;
+    private timer;
+    private defaultTags;
+    constructor(opts: NewrelicMetricsOptions);
+    /**
+     * Initialize Trace Exporter.
+     */
+    init(registry: MetricRegistry): void;
+    /**
+     * Stop Trace exporter
+     */
+    stop(): Promise<void>;
+    /**
+     * Flush tracing data to NewRelic Zipkin api endpoint
+     */
+    flush(): Promise<void>;
+    /**
+     * Generate metrics data for NewRelic
+     */
+    generateMetricsPayload(): unknown[];
+}
+
+export { AjvExtractor, Alias, COERCE_ARRAY_ATTRIBUTE, CustomActionSchema, CustomServiceSchema, DATE_TYPE, Document, EMPTY_OBJECT_SCHEMA, HealthCheckMiddleware, JSONSchemaType, NewrelicMetricsReporter, NewrelicTraceExporter, OBJECTID_TYPE, OpenAPIExtractor, OpenAPIMixin, OperationObject, RefExtractor, ReferenceObject, SCHEMA_REF_NAME, SchemaObject, ServiceFactory, SomeJSONSchema, addFieldsToSchema, composeSchemas, createLogger, createLoggerConfig, createOpenAPIResponses, createServiceBroker, defaultLogger, getMetadataFromService, isServiceSelected, omitFields, optionalExceptFields, optionalFields, pickFields, toPartialSchema, wrapMixin, wrapService, zodCoerceArray, zodDate, zodObjectId, zodToOpenAPISchema };
+export type { OpenAPIMixinOptions, OpenAPIResponses, Selector };