@availity/dockyard 1.0.0-alpha.2 → 1.0.1

package/.eslintrc.yml

@@ -0,0 +1,2 @@
+extends: ../../.eslintrc.yml
+ignorePatterns: ['!**/*', 'node_modules/', 'lib/', 'dist/']

package/CHANGELOG.md

@@ -1,7 +1,35 @@
-# Change Log
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## [1.0.1](https://github.com/Availity/sdk-js/compare/@availity/dockyard@1.0.0...@availity/dockyard@1.0.1) (2022-04-28)
+
+
+### Bug Fixes
+
+* add browser field for output ([0ce7170](https://github.com/Availity/sdk-js/commit/0ce717075a82675b8707e4db0cc07cd4af370f3d))
+
+
+
+# [1.0.0](https://github.com/Availity/sdk-js/compare/@availity/dockyard@1.0.0-alpha.3...@availity/dockyard@1.0.0) (2022-04-28)
+
+
+* build!: switch from lerna to nx and compile to esm with tsup ([c586085](https://github.com/Availity/sdk-js/commit/c5860856ca96b743a0653d335ea00f0889132f7f))
+
+
+### BREAKING CHANGES
+
+* Drop Internet Explorer support
+
+
+
+# 1.0.0-alpha.3 (2021-12-21)
+
+**Note:** Version bump only for package @availity/dockyard
+
+
+
 
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
 # 1.0.0-alpha.2 (2021-11-02)
 

package/README.md

@@ -2,6 +2,10 @@
 
 > Convert yup schema to a friendly docs object
 
+[![Version](https://img.shields.io/npm/v/@availity/dockyard.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/dockyard)
+[![NPM Downloads](https://img.shields.io/npm/dt/@availity/dockyard.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/dockyard)
+[![Dependecy Status](https://img.shields.io/librariesio/release/npm/@availity/dockyard?style=for-the-badge)](https://github.com/Availity/sdk-js/blob/master/packages/dockyard/package.json)
+
 ## Installation
 
 ### NPM
@@ -20,11 +24,11 @@ yarn add @availity/dockyard
 
 ```javascript
 import yup from 'yup';
-import getRules from '@availity/dockyard`;
+import getRules from '@availity/dockyard';
 
 const schema = yup.object({
-    name: yup.string(),
-    dateOfBirth: yup.date()
+  name: yup.string(),
+  dateOfBirth: yup.date(),
 });
 
 const rules = getRules(schema, options);
@@ -32,12 +36,12 @@ const rules = getRules(schema, options);
 
 ### `options`
 
-```javascript
-options = {
-    compileRequiredFields = false
-    excludeOneOf = false
-    excludeTypes = false
-}
+```js
+const options = {
+  compileRequiredFields: false,
+  excludeOneOf: false,
+  excludeTypes: false,
+};
 ```
 
 - `compileRequiredFields`: removes the word 'required' from the description and adds an array of required fields to the object.

package/dist/index.d.ts

@@ -0,0 +1 @@
+

package/dist/index.js

@@ -0,0 +1,122 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.js
+var src_exports = {};
+__export(src_exports, {
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+var import_get = __toESM(require("lodash/get"));
+var import_set = __toESM(require("lodash/set"));
+var addDelimiter = (a, b, { underscore = false } = {}) => underscore ? a ? `${a}.${b}._${b}` : `${b}._${b}` : a ? `${a}.${b}` : `${b}`;
+var transformRules = (schemaFieldDocs, options) => {
+  var _a, _b, _c;
+  const fieldDocs = [];
+  let isRequired = false;
+  if (!options.excludeTypes && schemaFieldDocs.type) {
+    fieldDocs.push(schemaFieldDocs.type);
+  }
+  if (((_a = schemaFieldDocs.notOneOf) == null ? void 0 : _a.length) > 0) {
+    fieldDocs.push(`not one of: [${schemaFieldDocs.notOneOf.join(", ")}]`);
+  }
+  if (!options.excludeOneOf && ((_b = schemaFieldDocs.oneOf) == null ? void 0 : _b.length) > 0) {
+    fieldDocs.push(`one of: [${schemaFieldDocs.oneOf.join(", ")}]`);
+  }
+  if (((_c = schemaFieldDocs.tests) == null ? void 0 : _c.length) > 0) {
+    for (const test of schemaFieldDocs.tests) {
+      if (options.compileRequiredFields && test.name === "required") {
+        isRequired = true;
+      } else if (test.params) {
+        const params = [];
+        for (const param in test.params) {
+          if (Object.prototype.hasOwnProperty.call(test.params, param)) {
+            params.push(`${param} ${test.params[param]}`);
+          }
+        }
+        if (test.name === "max" || test.name === "min") {
+          fieldDocs.push(`${params.join(", ")}${schemaFieldDocs.type !== "number" && schemaFieldDocs.type !== "array" ? " chars" : ""}`);
+        } else {
+          fieldDocs.push(`${test.name} ${params.join(", ")}`);
+        }
+      } else {
+        fieldDocs.push(test.name);
+      }
+    }
+  }
+  const friendlyFieldDocs = fieldDocs.length > 0 ? `Rules: ${fieldDocs.join(", ")}.` : "";
+  return options.compileRequiredFields ? { description: friendlyFieldDocs, isRequired } : friendlyFieldDocs;
+};
+var buildRules = (fields, head = "", options) => Object.entries(fields).reduce((obj, [key, value]) => {
+  const pathOptions = {};
+  if (value.fields || value.innerType && value.innerType.fields) {
+    pathOptions.underscore = true;
+  }
+  const path = addDelimiter(head, key, pathOptions);
+  const rules = transformRules(value, options);
+  if (options.compileRequiredFields) {
+    (0, import_set.default)(obj, path, rules.description);
+    if (rules.isRequired) {
+      const requiredFieldName = head ? `${head}.${key}` : key;
+      (0, import_set.default)(obj, "requiredFields", obj.requiredFields ? [...obj.requiredFields, requiredFieldName] : [requiredFieldName]);
+    }
+  } else {
+    (0, import_set.default)(obj, path, rules);
+  }
+  if (value == null ? void 0 : value.fields) {
+    const subFieldHead = addDelimiter(head, key);
+    const subRules = buildRules(value.fields, subFieldHead, options);
+    (0, import_set.default)(obj, subFieldHead, __spreadValues(__spreadValues({}, (0, import_get.default)(obj, subFieldHead)), (0, import_get.default)(subRules, subFieldHead)));
+    if (options.compileRequiredFields && subRules.requiredFields) {
+      (0, import_set.default)(obj, "requiredFields", obj.requiredFields ? [...obj.requiredFields, ...subRules.requiredFields] : [...subRules.requiredFields]);
+    }
+  }
+  if (value.innerType && value.innerType.fields) {
+    const innerFieldHead = addDelimiter(head, key);
+    const innerRules = buildRules(value.innerType.fields, innerFieldHead, options);
+    (0, import_set.default)(obj, innerFieldHead, __spreadValues(__spreadValues({}, (0, import_get.default)(obj, innerFieldHead)), (0, import_get.default)(innerRules, innerFieldHead)));
+    if (options.compileRequiredFields && innerRules.requiredFields) {
+      (0, import_set.default)(obj, "requiredFields", obj.requiredFields ? [...obj.requiredFields, ...innerRules.requiredFields] : [...innerRules.requiredFields]);
+    }
+  }
+  return obj;
+}, {});
+var getRules = (validation, { compileRequiredFields = false, excludeOneOf = false, excludeTypes = false } = {}) => {
+  const description = validation.describe();
+  return buildRules(description.fields, "", { compileRequiredFields, excludeOneOf, excludeTypes });
+};
+var src_default = getRules;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {});

package/dist/index.mjs

@@ -0,0 +1,100 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+
+// src/index.js
+import get from "lodash/get";
+import set from "lodash/set";
+var addDelimiter = (a, b, { underscore = false } = {}) => underscore ? a ? `${a}.${b}._${b}` : `${b}._${b}` : a ? `${a}.${b}` : `${b}`;
+var transformRules = (schemaFieldDocs, options) => {
+  var _a, _b, _c;
+  const fieldDocs = [];
+  let isRequired = false;
+  if (!options.excludeTypes && schemaFieldDocs.type) {
+    fieldDocs.push(schemaFieldDocs.type);
+  }
+  if (((_a = schemaFieldDocs.notOneOf) == null ? void 0 : _a.length) > 0) {
+    fieldDocs.push(`not one of: [${schemaFieldDocs.notOneOf.join(", ")}]`);
+  }
+  if (!options.excludeOneOf && ((_b = schemaFieldDocs.oneOf) == null ? void 0 : _b.length) > 0) {
+    fieldDocs.push(`one of: [${schemaFieldDocs.oneOf.join(", ")}]`);
+  }
+  if (((_c = schemaFieldDocs.tests) == null ? void 0 : _c.length) > 0) {
+    for (const test of schemaFieldDocs.tests) {
+      if (options.compileRequiredFields && test.name === "required") {
+        isRequired = true;
+      } else if (test.params) {
+        const params = [];
+        for (const param in test.params) {
+          if (Object.prototype.hasOwnProperty.call(test.params, param)) {
+            params.push(`${param} ${test.params[param]}`);
+          }
+        }
+        if (test.name === "max" || test.name === "min") {
+          fieldDocs.push(`${params.join(", ")}${schemaFieldDocs.type !== "number" && schemaFieldDocs.type !== "array" ? " chars" : ""}`);
+        } else {
+          fieldDocs.push(`${test.name} ${params.join(", ")}`);
+        }
+      } else {
+        fieldDocs.push(test.name);
+      }
+    }
+  }
+  const friendlyFieldDocs = fieldDocs.length > 0 ? `Rules: ${fieldDocs.join(", ")}.` : "";
+  return options.compileRequiredFields ? { description: friendlyFieldDocs, isRequired } : friendlyFieldDocs;
+};
+var buildRules = (fields, head = "", options) => Object.entries(fields).reduce((obj, [key, value]) => {
+  const pathOptions = {};
+  if (value.fields || value.innerType && value.innerType.fields) {
+    pathOptions.underscore = true;
+  }
+  const path = addDelimiter(head, key, pathOptions);
+  const rules = transformRules(value, options);
+  if (options.compileRequiredFields) {
+    set(obj, path, rules.description);
+    if (rules.isRequired) {
+      const requiredFieldName = head ? `${head}.${key}` : key;
+      set(obj, "requiredFields", obj.requiredFields ? [...obj.requiredFields, requiredFieldName] : [requiredFieldName]);
+    }
+  } else {
+    set(obj, path, rules);
+  }
+  if (value == null ? void 0 : value.fields) {
+    const subFieldHead = addDelimiter(head, key);
+    const subRules = buildRules(value.fields, subFieldHead, options);
+    set(obj, subFieldHead, __spreadValues(__spreadValues({}, get(obj, subFieldHead)), get(subRules, subFieldHead)));
+    if (options.compileRequiredFields && subRules.requiredFields) {
+      set(obj, "requiredFields", obj.requiredFields ? [...obj.requiredFields, ...subRules.requiredFields] : [...subRules.requiredFields]);
+    }
+  }
+  if (value.innerType && value.innerType.fields) {
+    const innerFieldHead = addDelimiter(head, key);
+    const innerRules = buildRules(value.innerType.fields, innerFieldHead, options);
+    set(obj, innerFieldHead, __spreadValues(__spreadValues({}, get(obj, innerFieldHead)), get(innerRules, innerFieldHead)));
+    if (options.compileRequiredFields && innerRules.requiredFields) {
+      set(obj, "requiredFields", obj.requiredFields ? [...obj.requiredFields, ...innerRules.requiredFields] : [...innerRules.requiredFields]);
+    }
+  }
+  return obj;
+}, {});
+var getRules = (validation, { compileRequiredFields = false, excludeOneOf = false, excludeTypes = false } = {}) => {
+  const description = validation.describe();
+  return buildRules(description.fields, "", { compileRequiredFields, excludeOneOf, excludeTypes });
+};
+var src_default = getRules;
+export {
+  src_default as default
+};

package/jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  displayName: 'dockyard',
+  preset: '../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  coverageDirectory: '../../coverage/dockyard',
+  coverageReporters: ['json'],
+};

package/package.json

@@ -1,26 +1,44 @@
 {
   "name": "@availity/dockyard",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.1",
   "description": "Convert yup schema to a friendly docs object",
-  "main": "lib/dockyard.js",
-  "module": "src/dockyard.js",
   "keywords": [
     "yup",
     "schema",
     "docs"
   ],
-  "author": "Greg Martin <greg.martin@availity.com>",
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public"
+  "bugs": {
+    "url": "https://github.com/availity/sdk-js/issues"
   },
-  "devDependencies": {
-    "yup": "^0.32.11"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/availity/sdk-js.git",
+    "directory": "packages/dockyard"
+  },
+  "license": "MIT",
+  "author": "Greg Martin <greg.martin@availity.com>",
+  "browser": "./dist/index.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.js --format esm,cjs --dts",
+    "dev": "tsup src/index.js --format esm,cjs --watch --dts",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "clean": "rm -rf node_modules && rm -rf dist",
+    "bundlesize": "bundlesize",
+    "publish": "yarn npm publish --tolerate-republish --access public"
   },
   "dependencies": {
-    "@babel/runtime": "^7.15.4",
-    "core-js": "^3.19.0",
     "lodash": "^4.17.21"
   },
-  "gitHead": "5e9eabe5f36e049d81d17c175f203182d1ac233f"
-}
+  "devDependencies": {
+    "tsup": "^5.10.1",
+    "typescript": "^4.5.3",
+    "yup": "^0.32.11"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/project.json

@@ -0,0 +1,23 @@
+{
+  "root": "packages/dockyard",
+  "projectType": "library",
+  "targets": {
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["coverage/dockyard"],
+      "options": {
+        "jestConfig": "packages/dockyard/jest.config.js",
+        "passWithNoTests": true
+      }
+    },
+    "version": {
+      "executor": "@jscutlery/semver:version",
+      "options": {
+        "preset": "angular",
+        "commitMessageFormat": "chore(${projectName}): release version ${version} [skip ci]",
+        "tagPrefix": "@availity/${projectName}@",
+        "baseBranch": "master"
+      }
+    }
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,13 @@
+declare const getRules: (
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  validation: any,
+  {
+    compileRequiredFields,
+    excludeOneOf,
+    excludeTypes,
+  }?: {
+    compileRequiredFields: boolean;
+    excludeOneOf: boolean;
+    excludeTypes: boolean;
+  }
+) => Record<string, unknown>;

package/src/{dockyard.js → index.js}

@@ -1,5 +1,5 @@
-const get = require('lodash/get');
-const set = require('lodash/set');
+import get from 'lodash/get';
+import set from 'lodash/set';
 
 /**
  * Builds the object path of the description
@@ -141,4 +141,4 @@ const getRules = (validation, { compileRequiredFields = false, excludeOneOf = fa
   return buildRules(description.fields, '', { compileRequiredFields, excludeOneOf, excludeTypes });
 };
 
-module.exports = getRules;
+export default getRules;

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["."],
+  "exclude": ["dist", "build", "node_modules"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"],
+    "allowJs": true
+  },
+  "include": ["**/*.test.ts", "**/*.spec.ts", "**/*.d.ts"]
+}

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016-present Availity, LLC
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/lib/dockyard.js

@@ -1,206 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-require("core-js/modules/es.array.concat");
-
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-
-var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
-
-require("core-js/modules/es.array.join.js");
-
-require("core-js/modules/es.function.name.js");
-
-require("core-js/modules/es.object.entries.js");
-
-require("core-js/modules/es.symbol.js");
-
-require("core-js/modules/es.symbol.description.js");
-
-var get = require('lodash/get');
-
-var set = require('lodash/set');
-/**
- * Builds the object path of the description
- * @param {string} a
- * @param {string} b
- * @param {Object} options
- * @param {boolean} [options.underscore = false] - Set object path for an object ex. object._object
- * @returns
- */
-
-
-var addDelimiter = function addDelimiter(a, b) {
-  var _ref = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {},
-      _ref$underscore = _ref.underscore,
-      underscore = _ref$underscore === void 0 ? false : _ref$underscore;
-
-  return underscore ? a ? "".concat(a, ".").concat(b, "._").concat(b) : "".concat(b, "._").concat(b) : a ? "".concat(a, ".").concat(b) : "".concat(b);
-};
-/**
- * Transforms a field's SchemaDescription object to friendly docs
- * @param {*} schemaFieldDocs yup schema field
- * @param {Object} options
- * @param {boolean} options.compileRequiredFields - removes the word 'required' from the description and adds an array of required fields to the object
- * @param {boolean} options.excludeOneOf - if oneOf is specified on an item, exclude it from the description
- * @param {boolean} options.excludeTypes - exclude types from the description
- * @returns
- */
-
-
-var transformRules = function transformRules(schemaFieldDocs, options) {
-  var _schemaFieldDocs$notO, _schemaFieldDocs$oneO, _schemaFieldDocs$test;
-
-  var fieldDocs = [];
-  var isRequired = false;
-
-  if (!options.excludeTypes && schemaFieldDocs.type) {
-    fieldDocs.push(schemaFieldDocs.type);
-  }
-
-  if (((_schemaFieldDocs$notO = schemaFieldDocs.notOneOf) === null || _schemaFieldDocs$notO === void 0 ? void 0 : _schemaFieldDocs$notO.length) > 0) {
-    fieldDocs.push("not one of: [".concat(schemaFieldDocs.notOneOf.join(', '), "]"));
-  }
-
-  if (!options.excludeOneOf && ((_schemaFieldDocs$oneO = schemaFieldDocs.oneOf) === null || _schemaFieldDocs$oneO === void 0 ? void 0 : _schemaFieldDocs$oneO.length) > 0) {
-    fieldDocs.push("one of: [".concat(schemaFieldDocs.oneOf.join(', '), "]"));
-  }
-
-  if (((_schemaFieldDocs$test = schemaFieldDocs.tests) === null || _schemaFieldDocs$test === void 0 ? void 0 : _schemaFieldDocs$test.length) > 0) {
-    var _iterator = (0, _createForOfIteratorHelper2["default"])(schemaFieldDocs.tests),
-        _step;
-
-    try {
-      for (_iterator.s(); !(_step = _iterator.n()).done;) {
-        var test = _step.value;
-
-        if (options.compileRequiredFields && test.name === 'required') {
-          isRequired = true;
-        } else if (test.params) {
-          var params = [];
-
-          for (var param in test.params) {
-            if (Object.prototype.hasOwnProperty.call(test.params, param)) {
-              params.push("".concat(param, " ").concat(test.params[param]));
-            }
-          }
-
-          if (test.name === 'max' || test.name === 'min') {
-            fieldDocs.push("".concat(params.join(', ')).concat(schemaFieldDocs.type !== 'number' && schemaFieldDocs.type !== 'array' ? ' chars' : ''));
-          } else {
-            fieldDocs.push("".concat(test.name, " ").concat(params.join(', ')));
-          }
-        } else {
-          fieldDocs.push(test.name);
-        }
-      }
-    } catch (err) {
-      _iterator.e(err);
-    } finally {
-      _iterator.f();
-    }
-  }
-
-  var friendlyFieldDocs = fieldDocs.length > 0 ? "Rules: ".concat(fieldDocs.join(', '), ".") : '';
-  return options.compileRequiredFields ? {
-    description: friendlyFieldDocs,
-    isRequired: isRequired
-  } : friendlyFieldDocs;
-};
-/**
- * Loops through the SchemaDescription and assigns descriptions
- * @param {*} fields - yup schema fields
- * @param {string} head - string
- * @param {Object} options
- * @param {boolean} options.compileRequiredFields - removes the word 'required' from the description and adds an array of required fields to the object
- * @param {boolean} options.excludeOneOf - if oneOf is specified on an item, exclude it from the description
- * @param {boolean} options.excludeTypes - exclude types from the description
- * @returns
- */
-
-
-var buildRules = function buildRules(fields) {
-  var head = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
-  var options = arguments.length > 2 ? arguments[2] : undefined;
-  return Object.entries(fields).reduce(function (obj, _ref2) {
-    var _ref3 = (0, _slicedToArray2["default"])(_ref2, 2),
-        key = _ref3[0],
-        value = _ref3[1];
-
-    var pathOptions = {};
-
-    if (value.fields || value.innerType && value.innerType.fields) {
-      pathOptions.underscore = true;
-    }
-
-    var path = addDelimiter(head, key, pathOptions);
-    var rules = transformRules(value, options);
-
-    if (options.compileRequiredFields) {
-      set(obj, path, rules.description);
-
-      if (rules.isRequired) {
-        var requiredFieldName = head ? "".concat(head, ".").concat(key) : key;
-        set(obj, 'requiredFields', obj.requiredFields ? [].concat((0, _toConsumableArray2["default"])(obj.requiredFields), [requiredFieldName]) : [requiredFieldName]);
-      }
-    } else {
-      set(obj, path, rules);
-    }
-
-    if (value === null || value === void 0 ? void 0 : value.fields) {
-      var subFieldHead = addDelimiter(head, key);
-      var subRules = buildRules(value.fields, subFieldHead, options);
-      set(obj, subFieldHead, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, get(obj, subFieldHead)), get(subRules, subFieldHead)));
-
-      if (options.compileRequiredFields && subRules.requiredFields) {
-        set(obj, 'requiredFields', obj.requiredFields ? [].concat((0, _toConsumableArray2["default"])(obj.requiredFields), (0, _toConsumableArray2["default"])(subRules.requiredFields)) : (0, _toConsumableArray2["default"])(subRules.requiredFields));
-      }
-    }
-
-    if (value.innerType && value.innerType.fields) {
-      var innerFieldHead = addDelimiter(head, key);
-      var innerRules = buildRules(value.innerType.fields, innerFieldHead, options);
-      set(obj, innerFieldHead, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, get(obj, innerFieldHead)), get(innerRules, innerFieldHead)));
-
-      if (options.compileRequiredFields && innerRules.requiredFields) {
-        set(obj, 'requiredFields', obj.requiredFields ? [].concat((0, _toConsumableArray2["default"])(obj.requiredFields), (0, _toConsumableArray2["default"])(innerRules.requiredFields)) : (0, _toConsumableArray2["default"])(innerRules.requiredFields));
-      }
-    }
-
-    return obj;
-  }, {});
-};
-/**
- * Convert yup schema to a friendly docs object
- * @param {*} validation - yup validation schema
- * @param {Object} options
- * @param {boolean} options.compileRequiredFields - removes the word 'required' from the description and adds an array of required fields to the object
- * @param {boolean} options.excludeOneOf - if oneOf is specified on an item, exclude it from the description
- * @param {boolean} options.excludeTypes - exclude types from the description
- * @returns
- */
-
-
-var getRules = function getRules(validation) {
-  var _ref4 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
-      _ref4$compileRequired = _ref4.compileRequiredFields,
-      compileRequiredFields = _ref4$compileRequired === void 0 ? false : _ref4$compileRequired,
-      _ref4$excludeOneOf = _ref4.excludeOneOf,
-      excludeOneOf = _ref4$excludeOneOf === void 0 ? false : _ref4$excludeOneOf,
-      _ref4$excludeTypes = _ref4.excludeTypes,
-      excludeTypes = _ref4$excludeTypes === void 0 ? false : _ref4$excludeTypes;
-
-  var description = validation.describe();
-  return buildRules(description.fields, '', {
-    compileRequiredFields: compileRequiredFields,
-    excludeOneOf: excludeOneOf,
-    excludeTypes: excludeTypes
-  });
-};
-
-module.exports = getRules;

package/tests/dockyard.test.js

@@ -1,82 +0,0 @@
-const getRules = require('../src/dockyard');
-const { movieSchema } = require('./schemas');
-
-describe('dockyard', () => {
-  test('getRules w/ no options', () => {
-    const docs = getRules(movieSchema);
-
-    expect(docs.name).toStrictEqual('Rules: string, matches regex /^[w-]*$/, required.');
-    expect(docs.job).toStrictEqual('Rules: string, not one of: [critic, blogger, influencer], max 250 chars.');
-    expect(docs.friends._friends).toStrictEqual('Rules: object, noUnknown, required.');
-    expect(docs.friends.name).toStrictEqual('Rules: string, matches regex /^[w-]*$/, required.');
-    expect(docs.friends.job).toStrictEqual('Rules: string, one of: [critic, blogger, influencer], max 250 chars.');
-    expect(docs.friends.favoriteMovie._favoriteMovie).toStrictEqual('Rules: object, required.');
-    expect(docs.friends.favoriteMovie.name).toStrictEqual('Rules: string, min 1 chars, required.');
-    expect(docs.friends.favoriteMovie.rating).toStrictEqual('Rules: number, min 1, max 5.');
-    expect(docs.friends.favoriteMovie.awards.bestMovie).toStrictEqual('Rules: boolean, required.');
-    expect(docs.friends.favoriteMovie.awards.bestActor).toStrictEqual('Rules: boolean, required.');
-    expect(docs.friends.favoriteMovie.actors._actors).toStrictEqual('Rules: array, max 10.');
-    expect(docs.friends.favoriteMovie.actors.name).toStrictEqual('Rules: string, max 100 chars, required.');
-  });
-
-  test('getRules w/ compileRequiredFields', () => {
-    const docs = getRules(movieSchema, { compileRequiredFields: true });
-
-    expect(docs.name).toStrictEqual('Rules: string, matches regex /^[w-]*$/.');
-    expect(docs.job).toStrictEqual('Rules: string, not one of: [critic, blogger, influencer], max 250 chars.');
-    expect(docs.friends._friends).toStrictEqual('Rules: object, noUnknown.');
-    expect(docs.friends.name).toStrictEqual('Rules: string, matches regex /^[w-]*$/.');
-    expect(docs.friends.job).toStrictEqual('Rules: string, one of: [critic, blogger, influencer], max 250 chars.');
-    expect(docs.friends.favoriteMovie._favoriteMovie).toStrictEqual('Rules: object.');
-    expect(docs.friends.favoriteMovie.name).toStrictEqual('Rules: string, min 1 chars.');
-    expect(docs.friends.favoriteMovie.rating).toStrictEqual('Rules: number, min 1, max 5.');
-    expect(docs.friends.favoriteMovie.awards.bestMovie).toStrictEqual('Rules: boolean.');
-    expect(docs.friends.favoriteMovie.awards.bestActor).toStrictEqual('Rules: boolean.');
-    expect(docs.friends.favoriteMovie.actors._actors).toStrictEqual('Rules: array, max 10.');
-    expect(docs.friends.favoriteMovie.actors.name).toStrictEqual('Rules: string, max 100 chars.');
-    expect(docs.requiredFields).toStrictEqual([
-      'name',
-      'friends',
-      'friends.name',
-      'friends.favoriteMovie',
-      'friends.favoriteMovie.name',
-      'friends.favoriteMovie.awards.bestMovie',
-      'friends.favoriteMovie.awards.bestActor',
-      'friends.favoriteMovie.actors.name',
-    ]);
-  });
-
-  test('getRules w/ excludeOneOf', () => {
-    const docs = getRules(movieSchema, { excludeOneOf: true });
-
-    expect(docs.name).toStrictEqual('Rules: string, matches regex /^[w-]*$/, required.');
-    expect(docs.job).toStrictEqual('Rules: string, not one of: [critic, blogger, influencer], max 250 chars.');
-    expect(docs.friends._friends).toStrictEqual('Rules: object, noUnknown, required.');
-    expect(docs.friends.name).toStrictEqual('Rules: string, matches regex /^[w-]*$/, required.');
-    expect(docs.friends.job).toStrictEqual('Rules: string, max 250 chars.');
-    expect(docs.friends.favoriteMovie._favoriteMovie).toStrictEqual('Rules: object, required.');
-    expect(docs.friends.favoriteMovie.name).toStrictEqual('Rules: string, min 1 chars, required.');
-    expect(docs.friends.favoriteMovie.rating).toStrictEqual('Rules: number, min 1, max 5.');
-    expect(docs.friends.favoriteMovie.awards.bestMovie).toStrictEqual('Rules: boolean, required.');
-    expect(docs.friends.favoriteMovie.awards.bestActor).toStrictEqual('Rules: boolean, required.');
-    expect(docs.friends.favoriteMovie.actors._actors).toStrictEqual('Rules: array, max 10.');
-    expect(docs.friends.favoriteMovie.actors.name).toStrictEqual('Rules: string, max 100 chars, required.');
-  });
-
-  test('getRules w/ excludeTypes', () => {
-    const docs = getRules(movieSchema, { excludeTypes: true });
-
-    expect(docs.name).toStrictEqual('Rules: matches regex /^[w-]*$/, required.');
-    expect(docs.job).toStrictEqual('Rules: not one of: [critic, blogger, influencer], max 250 chars.');
-    expect(docs.friends._friends).toStrictEqual('Rules: noUnknown, required.');
-    expect(docs.friends.name).toStrictEqual('Rules: matches regex /^[w-]*$/, required.');
-    expect(docs.friends.job).toStrictEqual('Rules: one of: [critic, blogger, influencer], max 250 chars.');
-    expect(docs.friends.favoriteMovie._favoriteMovie).toStrictEqual('Rules: required.');
-    expect(docs.friends.favoriteMovie.name).toStrictEqual('Rules: min 1 chars, required.');
-    expect(docs.friends.favoriteMovie.rating).toStrictEqual('Rules: min 1, max 5.');
-    expect(docs.friends.favoriteMovie.awards.bestMovie).toStrictEqual('Rules: required.');
-    expect(docs.friends.favoriteMovie.awards.bestActor).toStrictEqual('Rules: required.');
-    expect(docs.friends.favoriteMovie.actors._actors).toStrictEqual('Rules: max 10.');
-    expect(docs.friends.favoriteMovie.actors.name).toStrictEqual('Rules: max 100 chars, required.');
-  });
-});

package/tests/schemas.js

@@ -1,33 +0,0 @@
-const yup = require('yup');
-
-const movieSchema = yup.object({
-  name: yup.string().matches('/^[w-]*$/').required(),
-  job: yup.string().max(250).notOneOf(['critic', 'blogger', 'influencer']),
-  friends: yup
-    .object({
-      name: yup.string().matches('/^[w-]*$/').required(),
-      job: yup.string().max(250).oneOf(['critic', 'blogger', 'influencer']),
-      favoriteMovie: yup
-        .object({
-          name: yup.string().min(1).required(),
-          rating: yup.number().min(1).max(5),
-          awards: yup.object({
-            bestMovie: yup.boolean().required(),
-            bestActor: yup.boolean().required(),
-          }),
-          actors: yup
-            .array(
-              yup.object({
-                name: yup.string().max(100).required(),
-                birthDate: yup.date(),
-              })
-            )
-            .max(10),
-        })
-        .required(),
-    })
-    .noUnknown()
-    .required(),
-});
-
-module.exports = { movieSchema };