@treatwell/moleculer-essentials 2.0.0-beta.5 → 2.0.0

package/README.md

@@ -50,21 +50,20 @@ To complete the TS support and improve the developer experience, we also provide
 
 ## Usage
 
+A working example is available in the [`example`](./example) folder, with a simple calculator service and an OpenAPI.
+It's a great way to start a project.
+
 ### Basic Example
 
 ```ts
 // src/index.ts
+import { join } from 'node:path';
 import fg from 'fast-glob';
 import {
-  HealthCheckMiddleware,
   createLoggerConfig,
   createServiceBroker,
-  defaultLogger,
   ZodValidator,
 } from '@treatwell/moleculer-essentials';
-import { fileURLToPath } from 'url';
-import { dirname, join } from 'path';
-import { config } from 'dotenv';
 
 async function run() {
   // Create Service Broker
@@ -95,7 +94,7 @@ async function run() {
 }
 
 run().catch(err => {
-  defaultLogger.error('Error while starting server', { err });
+  console.error('Error while starting server', { err });
   process.exit(1);
 });
 ```

package/dist/index.d.cts

@@ -200,6 +200,12 @@ declare class AjvExtractor extends RefExtractor {
  * For now, only methods are typed.
  */
 declare function wrapMixin<Settings, Methods, Mixins>(svc: Partial<CustomServiceSchema<Settings, Methods, Mixins>>): typeof svc;
+/**
+ * In order to let TS emit types for inferred services, we return our own
+ * type that extend the original one.
+ * More on why: https://github.com/microsoft/TypeScript/pull/58176#issuecomment-2052698294
+ */
+type _InferredServiceSchema = ServiceSchema;
 /**
  * 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
@@ -208,7 +214,7 @@ declare function wrapMixin<Settings, Methods, Mixins>(svc: Partial<CustomService
  * 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>(svc: CustomServiceSchema<Settings, Methods, Mixins>): ServiceSchema;
+declare function wrapService<Settings, Methods, Mixins>(svc: CustomServiceSchema<Settings, Methods, Mixins>): _InferredServiceSchema;
 
 /**
  * This class replace the default Service class in Moleculer to:
@@ -381,4 +387,4 @@ declare class NewrelicMetricsReporter extends MetricReporters.Base {
 }
 
 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, getMetadataFromService, isServiceSelected, isZodSchema, omitFields, optionalExceptFields, optionalFields, pickFields, toPartialSchema, wrapMixin, wrapService, zodCoerceArray, zodDate, zodObjectId, zodToOpenAPISchema };
-export type { OpenAPIMixinOptions, OpenAPIResponses, Selector };
+export type { OpenAPIMixinOptions, OpenAPIResponses, Selector, _InferredServiceSchema };

package/dist/index.d.mts

@@ -200,6 +200,12 @@ declare class AjvExtractor extends RefExtractor {
  * For now, only methods are typed.
  */
 declare function wrapMixin<Settings, Methods, Mixins>(svc: Partial<CustomServiceSchema<Settings, Methods, Mixins>>): typeof svc;
+/**
+ * In order to let TS emit types for inferred services, we return our own
+ * type that extend the original one.
+ * More on why: https://github.com/microsoft/TypeScript/pull/58176#issuecomment-2052698294
+ */
+type _InferredServiceSchema = ServiceSchema;
 /**
  * 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
@@ -208,7 +214,7 @@ declare function wrapMixin<Settings, Methods, Mixins>(svc: Partial<CustomService
  * 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>(svc: CustomServiceSchema<Settings, Methods, Mixins>): ServiceSchema;
+declare function wrapService<Settings, Methods, Mixins>(svc: CustomServiceSchema<Settings, Methods, Mixins>): _InferredServiceSchema;
 
 /**
  * This class replace the default Service class in Moleculer to:
@@ -381,4 +387,4 @@ declare class NewrelicMetricsReporter extends MetricReporters.Base {
 }
 
 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, getMetadataFromService, isServiceSelected, isZodSchema, omitFields, optionalExceptFields, optionalFields, pickFields, toPartialSchema, wrapMixin, wrapService, zodCoerceArray, zodDate, zodObjectId, zodToOpenAPISchema };
-export type { OpenAPIMixinOptions, OpenAPIResponses, Selector };
+export type { OpenAPIMixinOptions, OpenAPIResponses, Selector, _InferredServiceSchema };

package/package.json

@@ -6,7 +6,7 @@
     "type": "git",
     "url": "https://github.com/treatwell/moleculer-essentials"
   },
-  "version": "2.0.0-beta.5",
+  "version": "2.0.0",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",