@jackdbd/zod-to-doc - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

CHANGELOG.md

 # CHANGELOG
 
+## [1.1.1](https://github.com/jackdbd/zod-to-doc/compare/v1.1.0...v1.1.1) (2024-04-25)
+
+
+### Bug Fixes
+
+* detect a ZodUnion in a different way ([b2d2d75](https://github.com/jackdbd/zod-to-doc/commit/b2d2d7598d129d7d0bb4dbf91057d311c352a69a))
+
 ## [1.1.0](https://github.com/jackdbd/zod-to-doc/compare/v1.0.7...v1.1.0) (2024-04-25)
@@ -4,0 +11,0 @@

dist/lib.js

@@ -30,2 +30,11 @@ /**
 export const stringsFromZodAnyType = (x) => {
+    if (x.options) {
+        // x should be a z.ZodUnion of some type
+        const arr = x.options.map((opt) => {
+            return stringsFromZodAnyType(opt);
+        });
+        const strings = arr.flat();
+        strings.sort();
+        return strings;
+    }
     if (x instanceof z.ZodBigInt) {
@@ -76,4 +85,7 @@ return x.description ? [x.description] : ['A BigInt'];
     else {
-        // console.log('=== stringFromZodAnyType x._def ===', x._def)
-        return x.description ? [x.description] : ['TODO'];
+        let not_handled = 'unknown';
+        if (x._def && x._def.typeName) {
+            not_handled = x._def.typeName;
+        }
+        return x.description ? [`${not_handled} (${x.description})`] : [not_handled];
     }
@@ -80,0 +92,0 @@ };

package.json

 {
   "name": "@jackdbd/zod-to-doc",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Inject your [Zod](https://github.com/colinhacks/zod) schemas into your docs.",
@@ -74,2 +74,3 @@ "author": {
     "lint": "eslint --config ./config/eslint.cjs",
+    "ncu:dev": "ncu --dep 'dev' --interactive --loglevel info --upgrade",
     "nuke": "npm run clean && rimraf node_modules 'package-lock.json'",
@@ -80,3 +81,3 @@ "publint": "publint run .",
     "size": "pkg-size ./dist --sort-by=brotli --ignore-files '{*.d.ts,*.map}'",
-    "test": "node --test --experimental-test-coverage --test-name-pattern=cli",
+    "test": "node --test --experimental-test-coverage",
     "test:ci": "node --test --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=coverage/lcov.info",
@@ -89,32 +90,32 @@ "test:watch": "node --test --watch"
     "yargs": "^17.7.2",
-    "zod": "^3.22.4"
+    "zod": "^3.23.4"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.6.0",
-    "@commitlint/config-conventional": "^18.6.0",
-    "@microsoft/api-documenter": "^7.23.20",
-    "@microsoft/api-extractor": "^7.39.4",
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-conventional": "^19.2.2",
+    "@microsoft/api-documenter": "^7.24.2",
+    "@microsoft/api-extractor": "^7.43.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@thi.ng/transclude": "^0.1.63",
+    "@thi.ng/transclude": "^0.1.88",
     "@types/debug": "^4.1.12",
     "@types/yargs": "^17.0.32",
-    "@typescript-eslint/eslint-plugin": "^6.19.1",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
-    "npm-check-updates": "^16.14.14",
+    "npm-check-updates": "^16.14.19",
     "npm-run-all": "^4.1.5",
     "pkg-size": "^2.4.0",
-    "prettier": "^3.2.4",
+    "prettier": "^3.2.5",
     "publint": "^0.2.7",
     "rimraf": "^5.0.5",
-    "semantic-release": "^23.0.0",
+    "semantic-release": "^23.0.8",
     "semantic-release-telegram": "^1.6.2",
     "tsm": "^2.3.0",
-    "typedoc": "^0.25.7",
+    "typedoc": "^0.25.13",
     "typedoc-plugin-zod": "^1.1.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.5"
   }
 }

README.md

@@ -107,3 +107,3 @@ # Zod to Doc
 | [yargs](https://www.npmjs.com/package/yargs) | `^17.7.2` |
-| [zod](https://www.npmjs.com/package/zod) | `^3.22.4` |
+| [zod](https://www.npmjs.com/package/zod) | `^3.23.4` |
 
@@ -110,0 +110,0 @@ ## License

No alert changes

Improved metrics

Total package byte prevSize

53359

increased by2.15%

Lines of code

690

increased by1.77%

Dependency changes

• Updatedzod@^3.23.4