joi-to-json 3.1.0 → 3.1.2

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 3.1.1
+
+- Fix Typescript definition.
+
 ### 3.1.0
 
 - Add support for relation operator `with` and `without`.

package/README.md

@@ -242,6 +242,10 @@ properties:
 additionalProperties: true
 ```
 
+## Special Joi Operator Support
+
+* [Logical Relation Operator](./docs/logical_rel_support.md)
+
 ## Browser support
 For generating JSON Schema in a browser you should use below import syntax for `joi` library in order to work because the `joi` browser minimized build does not have `describe` api which the `joi-to-json` relies on.
 
@@ -249,9 +253,21 @@ For generating JSON Schema in a browser you should use below import syntax for `
   import Joi from 'joi/lib/index';
 ```
 
-## Special Joi Operator Support
+## TypeScript support
 
-* [Logical Relation Operator](./docs/logical_rel_support.md)
+```typescript
+import joi from 'joi';
+import * as Joi2Json from 'joi-to-json';
+import parse from 'joi-to-json';
+
+const logicalOpParser: Joi2Json.LogicalOpParserOpts = {
+  with: function (a) {}
+};
+
+parse(joi.string()); // Default call
+parse(joi.string(), 'json', {}, false); // Completely disable Logical Relation Operator
+parse(joi.string(), 'open-api', {}, { logicalOpParser }); // Partially override Logical Relation Operator
+```
 
 ## Test
 

package/index.d.ts

@@ -1,18 +1,36 @@
 import Joi from 'joi-17';
 
-declare module Joi2Json {
-  /**
-   * @type {string}
-   */
-  export type Mode = 'json' | 'open-api' | 'json-draft-2019-09' | 'json-draft-04';
+/**
+ * @type {string}
+ */
+export type Mode = 'json' | 'open-api' | 'json-draft-2019-09' | 'json-draft-04';
 
-  /**
-   * @param {string} joi - A Joi schema.
-   * @param {string} [mode='json'] - json / open-api / json-draft-2019-09 / json-draft-04
-   * @param {Record} [sharedSchema={}] - Passed-in object storing shared schemas
-   * @returns {any} Converted JSON schema object.
-   */
-  export function parse(joi: Joi.Schema, mode?: Mode, sharedSchema?: Record<string, any>): any;
-}
+/**
+ * The parser function modifies the schema in-place.
+ * @param {any} schema - JSON schema object
+ * @param {any} dependency - JOI dependency object
+ */
+export type LogicalOpParserFn = (schema, dependency) => void;
 
-export default Joi2Json.parse;
+export interface LogicalOpParserOpts {
+  and?: LogicalOpParserFn,
+  nand?: LogicalOpParserFn,
+  or?: LogicalOpParserFn,
+  xor?: LogicalOpParserFn,
+  oxor?: LogicalOpParserFn,
+  with?: LogicalOpParserFn,
+  without?: LogicalOpParserFn
+};
+
+export type ParserOptions = false | { logicalOpParser?: LogicalOpParserOpts };
+
+/**
+ * @param {Joi.Schema} joi - A Joi schema.
+ * @param {string} [mode='json'] - json / open-api / json-draft-2019-09 / json-draft-04
+ * @param {Record} [sharedSchema={}] - Passed-in object storing shared schemas
+ * @param {ParserOptions} [parserOptions={}] - Passed-in options for parser
+ * @returns {any} Converted JSON schema object.
+ */
+export function parse(joi: typeof Joi.Schema, mode?: Mode, sharedSchema?: Record<string, any>, parserOptions?: ParserOptions): any;
+
+export default parse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joi-to-json",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "joi to JSON / OpenAPI Schema Converter",
   "main": "index.js",
   "repository": {
@@ -28,10 +28,10 @@
     "semver-compare": "^1.0.0"
   },
   "devDependencies": {
-    "ajv": "^8.11.0",
+    "ajv": "^8.12.0",
     "ajv-draft-04": "^1.0.0",
-    "eslint": "^8.12.0",
-    "jest": "^27.5.1",
+    "eslint": "^8.31.0",
+    "jest": "^29.3.1",
     "joi-12": "npm:@commercial/joi@^12.1.0",
     "joi-13": "npm:joi@^13.7.0",
     "joi-14": "npm:joi@^14.3.1",