Merge pull request #125 from mrjono1/unknown

Unknown

README.md

@@ -13,8 +13,8 @@ This will allow you to reuse a Joi Schema that validates your [Hapi](https://git
 
 For generating Open Api/Swagger this project works with
 
+- [joi-to-swagger](https://github.com/Twipped/joi-to-swagger) using `.meta({className:''})` looking like a better approach
 - [hapi-swagger](https://github.com/glennjones/hapi-swagger) using `.label('')` this has been well tested and used in production
-- [joi-to-swagger](https://github.com/Twipped/joi-to-swagger) using `.meta({className:''})` limited testing but this is looking like a better approach
 
 Version 2, why the move to `.meta({className:'')` from `.label('')`? `Joi.label()` is intended to be used for meaningful error message, using it for another purpose makes the Joi loose a standard feature, this is especially noticeable for frontend usages of Joi. The choice of the property `className` is because this property is used by joi-to-swagger making this project work with other projects is important.
 
@@ -210,10 +210,9 @@ export interface Settings {
 - .alternatives()
 - .allow('') - will be ignored on a string
 - .allow(null) - will add as an optional type eg `string | null`
-- .unknown(true) - will add a property `[x: string]: any;`
+- .unknown(true) - will add a property `[x: string]: unknown;`
 - .example() - jsdoc
-
-Joi Features not listed here will probably be ignored
+  Any many others
 
 ## Contributing
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "joi-to-typescript",
   "description": "Convert Joi Schemas to TypeScript interfaces",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "author": "Jono Clarnette",
   "keywords": [
     "joi",

src/__tests__/joiExtensions/joiExtensions.ts

@@ -8,6 +8,7 @@ const ExtendedJoi = Joi.extend(joi => {
     base: joi.string().meta({ baseType: 'string' })
   };
   return ext;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 }).extend((joi: any) => {
   const ext: Joi.Extension = {
     type: 'dollars',

src/__tests__/unknown.ts

@@ -21,7 +21,7 @@ export interface TestSchema {
   /**
    * Unknown Property
    */
-  [x: string]: any;
+  [x: string]: unknown;
 }`);
   });
 

src/joiUtils.ts

@@ -10,7 +10,9 @@ import { Describe } from './joiDescribeTypes';
  * @param details - the schema details
  * @returns the values for the given field
  */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function getMetadataFromDetails(field: string, details: Describe): any[] {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   const metas: any[] = details?.metas ?? [];
   return metas.filter(entry => entry[field]).map(entry => entry[field]);
 }

src/parse.ts

@@ -408,7 +408,7 @@ function parseObjects(details: ObjectDescribe, settings: Settings): TypeContent
 
   if (details?.flags?.unknown === true) {
     const unknownProperty = {
-      content: 'any',
+      content: 'unknown',
       interfaceOrTypeName: '[x: string]',
       required: true,
       jsDoc: { description: 'Unknown Property' }