Merge pull request #3 from TheAppleFreak/internals-fix

v3.0.0 - Add compatibility fallback for fastest-validator schemas

.github/workflows/deploy.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with: 
-          node-version: "16.x"
+          node-version: "18.x"
           registry-url: "https://registry.npmjs.org"
       - run: npm ci
       - run: npm run build

.github/workflows/tests.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix: 
-        node-version: [16.x]
+        node-version: [17.x, 18.x]
 
     steps: 
       - uses: actions/checkout@v2
@@ -28,7 +28,7 @@ jobs:
 
     strategy:
       matrix: 
-        node-version: [16.x]
+        node-version: [17.x, 18.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -44,7 +44,7 @@ jobs:
 
     strategy:
       matrix: 
-        node-version: [16.x]
+        node-version: [17.x, 18.x]
 
     steps:
       - uses: actions/checkout@v2

.prettierrc

@@ -1,7 +1,9 @@
 {
-    "trailingComma": "all",
+    "$schema": "http://json.schemastore.org/prettierrc",
+    "trailingComma": "none",
     "tabWidth": 4,
     "semi": true,
     "singleQuote": false,
-    "bracketSpacing": true
+    "bracketSpacing": true,
+    "printWidth": 88
 }

.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Jest Tests",
+      "type": "node",
+      "request": "launch",
+      "runtimeArgs": [
+        "--inspect-brk",
+        "${workspaceRoot}/node_modules/.bin/jest",
+        "--runInBand"
+      ],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+    }
+  ]
+}

CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 3.0.0 (2023/4/13)
+
+* **BREAKING CHANGE** - The minimum compatible Node.js version is now Node.js v17.0.0. This is due to the requirement of the `structuredClone` function in the fastest-validator fallback (described below), which in Node.js is only available in v17.0.0 and above. I tried using Lodash's `cloneDeep` method like Moleculer itself uses, but for a reason unknown to me it kept causing crashes during unit testing that I couldn't figure out. `structuredClone` does work, however, which should solve the same problem. 
+* Added support for passing in fastest-validator schemas. This is required because the `$node` internal services built into Moleculer assume that fastest-validator is the current validator, which poses a problem given as moleculer-zod-validator had no idea what to do with those schemas. By checking for the existence of property in the Zod schema that is not used in fastest-validator, this can now automatically switch into a failsafe that uses fastest-validator instead. 
+* Added new unit tests for the FV fallback
+* Added descriptive type comments to ZodParams
+* Added some files to the NPM build that should have been present before
+* Updated dependencies
+* Updated Github workflows to use newer Node.js versions
+* Updated copyright year in LICENSE
+
 ## 2.0.0 (2022/1/24)
 
 * Added transformation support to the validator itself, which will allow for features such as defaults and different passthrough modes for unrecognized parameters. This has several side effects that are listed below.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 TheAppleFreak
+Copyright (c) 2023 TheAppleFreak
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -10,6 +10,10 @@ Validate Moleculer action parameters using the [Zod](https://github.com/colinhac
 * Supports [Moleculer](https://moleculer.services) v0.14.x
 * Supports [Zod](https://github.com/colinhacks/zod) v3.x.x
 
+## Requires
+
+As of v3.0.0, this package requires Node.js v17.0.0 or above.
+
 ## Install
 
 `npm install moleculer-zod-validator`
@@ -34,6 +38,8 @@ const broker = new ServiceBroker({
 });
 ```
 
+As of v3.0.0, moleculer-zod-validator implements the default Moleculer validator (fastest-validator) as a compatibility fallback for fastest-validator schemas, [like those used in Moleculer's internal services](https://github.com/moleculerjs/moleculer/issues/1094), so calling services using that should not be a problem. 
+
 ### Actions
 
 One of Zod's main features is how it can infer TypeScript types from a schema. To simplify the usage of this, there is a convenience utility called `ZodParams` that allows for easy access to the necessary data.
@@ -45,16 +51,16 @@ The `ZodParams` constructor takes one or two arguments, `schema` and optionally
   * `partial` (boolean) - Shallowly makes all properties optional. ([docs](https://github.com/colinhacks/zod#partial))
   * `deepPartial` (boolean) - Deeply makes all properties optional. ([docs](https://github.com/colinhacks/zod#deepPartial))
   * `strip` (boolean) - Removes unrecognized keys from the parsed input. This is Zod's default behavior and this validator's default behavior. Mutually exclusive with `passthrough` and `strict`, and will override them if set. ([docs](https://github.com/colinhacks/zod#strip))
-  * `strict` (boolean) - Throws an error if unrecognized keys are present. Mutually exclusive with `passthrough` and `strip`. ([docs](https://github.com/colinhacks/zod#strict))
   * `passthrough` (boolean) - Passes through unrecognized keys. Mutually exclusive with `strict` and `strip`. ([docs](https://github.com/colinhacks/zod#passthrough))
+  * `strict` (boolean) - Throws an error if unrecognized keys are present. Mutually exclusive with `passthrough` and `strip`. ([docs](https://github.com/colinhacks/zod#strict))
   * `catchall` (Zod validator) - Validates all unknown keys against this schema. Obviates `strict`, `passthrough`, and `strip`. ([docs](https://github.com/colinhacks/zod#catchall))
 
-As of v2.0.0, support for object transformations is present, allowing for the use of features such as [preprocessing](https://github.com/colinhacks/zod#preprocess), [refinements](https://github.com/colinhacks/zod#refine), [transforms](https://github.com/colinhacks/zod#transform), and [defaults](https://github.com/colinhacks/zod#default). 
+Additionally, support for object transformations is present, allowing for the use of features such as [preprocessing](https://github.com/colinhacks/zod#preprocess), [refinements](https://github.com/colinhacks/zod#refine), [transforms](https://github.com/colinhacks/zod#transform), and [defaults](https://github.com/colinhacks/zod#default). 
 
 Once constructed, there are four properties exposed on the `ZodParams` object.
 
 * `schema` - The raw schema passed in. This should be passed to the `params` object in the action definition.
-* `context` - The inferred output type from the compiled validator. This should be used within the `Context` object in Moleculer to get the proper types after the parameters have passed through validation. 
+* `context` - The inferred output type from the compiled validator. This should be used within the `Context` object in the action definition to get the proper types after the parameters have passed through validation. 
 * `call` - The inferred input type from the compiled validator. This should be used with `broker.call` or `ctx.call` as the second type parameter to get proper types for the action call. 
 * `validator` - The compiled validator. 
 
@@ -92,7 +98,7 @@ broker.createService({
     }
 });
 
-...
+// ...
 
 broker.call<
     ReturnType,