ember-headless-form-yup 1.0.0-beta.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2023
+
+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/README.md

@@ -0,0 +1,26 @@
+# ember-headless-form-yup
+
+Integrates [`yup`](https://github.com/jquense/yup) based schemas seamlessly with the validation support of [ember-headless-form](https://github.com/CrowdStrike/ember-headless-form).
+
+## Compatibility
+
+- Ember.js v4.4 or above
+- Embroider or ember-auto-import v2
+
+## Installation
+
+```
+ember install ember-headless-form-yup
+```
+
+## Usage
+
+Visit our [documentation website](https://ember-headless-form.pages.dev/).
+
+## Contributing
+
+See the [Contributing](CONTRIBUTING.md) guide for details.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).

package/addon-main.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+const { addonV1Shim } = require('@embroider/addon-shim');
+module.exports = addonV1Shim(__dirname);

package/dist/_app_/helpers/validate-yup.js

@@ -0,0 +1 @@
+export { default } from "ember-headless-form-yup/helpers/validate-yup";

package/dist/helpers/validate-yup.d.ts

@@ -0,0 +1,10 @@
+import { FormValidateCallback } from 'ember-headless-form';
+import { ObjectSchema } from 'yup';
+/**
+ * Validation helper for integrating `yup` based validations into headless forms.
+ *
+ * Pass this to the `@validate` hook, supplying the `yup` schema as the only argument: `@validate={{validateYup schema}}`.
+ */
+declare function validateChangeset<DATA extends object>(schema: ObjectSchema<DATA>): FormValidateCallback<Partial<DATA>>;
+export { validateChangeset as default };
+//# sourceMappingURL=helpers/validate-yup.d.ts.map

package/dist/helpers/validate-yup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers/validate-yup.d.ts","sourceRoot":"","sources":["../src/helpers/validate-yup.ts"],"names":[],"mappings":"AAAA,OAAO,wBAIN,MAAM,qBAAqB,CAAC;AAG7B,OAAO,gBAAsC,MAAM,KAAK,CAAC;AAEzD;;;;GAIG;AACH,iBAAwB,iBAAiB,CAAC,IAAI,SAAS,MAAM,EAC3D,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,GACzB,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAkCrC"}

package/dist/helpers/validate-yup.js

@@ -0,0 +1,45 @@
+import { assert } from '@ember/debug';
+
+/**
+ * Validation helper for integrating `yup` based validations into headless forms.
+ *
+ * Pass this to the `@validate` hook, supplying the `yup` schema as the only argument: `@validate={{validateYup schema}}`.
+ */
+function validateChangeset(schema) {
+  return async formData => {
+    try {
+      await schema.validate(formData, {
+        abortEarly: false
+      });
+    } catch (e) {
+      const validationError = e;
+      const errorRecord = {};
+      for (const {
+        path,
+        type,
+        value,
+        message
+      } of validationError.inner) {
+        assert('Received undefined path for yup validation error. If you see this, please report it as a bug to ember-headless-form!', path !== undefined);
+        const key = path; // yup maybe could have stricter types here, as path will always refer to a key of its schema
+
+        if (!errorRecord[key]) {
+          errorRecord[key] = [];
+        }
+        const errors = errorRecord[key];
+        assert('Expected errorRecord to have array', errors); // TS does not understand errors cannot be undefined at this point
+
+        errors.push({
+          type: type ?? 'unknown',
+          value,
+          message
+        });
+      }
+      return errorRecord;
+    }
+    return undefined;
+  };
+}
+
+export { validateChangeset as default };
+//# sourceMappingURL=validate-yup.js.map

package/dist/helpers/validate-yup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-yup.js","sources":["../../src/helpers/validate-yup.ts"],"sourcesContent":["import type {\n  ErrorRecord,\n  FormKey,\n  FormValidateCallback,\n} from 'ember-headless-form';\nimport { assert } from '@ember/debug';\n\nimport type { ObjectSchema, ValidationError } from 'yup';\n\n/**\n * Validation helper for integrating `yup` based validations into headless forms.\n *\n * Pass this to the `@validate` hook, supplying the `yup` schema as the only argument: `@validate={{validateYup schema}}`.\n */\nexport default function validateChangeset<DATA extends object>(\n  schema: ObjectSchema<DATA>\n): FormValidateCallback<Partial<DATA>> {\n  return async (formData) => {\n    try {\n      await schema.validate(formData, { abortEarly: false });\n    } catch (e) {\n      const validationError = e as ValidationError;\n      const errorRecord: ErrorRecord<DATA> = {};\n\n      for (const { path, type, value, message } of validationError.inner) {\n        assert(\n          'Received undefined path for yup validation error. If you see this, please report it as a bug to ember-headless-form!',\n          path !== undefined\n        );\n        const key = path as FormKey<DATA>; // yup maybe could have stricter types here, as path will always refer to a key of its schema\n\n        if (!errorRecord[key]) {\n          errorRecord[key] = [];\n        }\n\n        const errors = errorRecord[key];\n        assert('Expected errorRecord to have array', errors); // TS does not understand errors cannot be undefined at this point\n\n        errors.push({\n          type: type ?? 'unknown',\n          value,\n          message,\n        });\n      }\n\n      return errorRecord;\n    }\n\n    return undefined;\n  };\n}\n"],"names":["validateChangeset","schema","formData","validate","abortEarly","e","validationError","errorRecord","path","type","value","message","inner","assert","undefined","key","errors","push"],"mappings":";;AASA;AACA;AACA;AACA;AACA;AACe,SAASA,iBAAiB,CACvCC,MAA0B,EACW;EACrC,OAAO,MAAOC,QAAQ,IAAK;IACzB,IAAI;AACF,MAAA,MAAMD,MAAM,CAACE,QAAQ,CAACD,QAAQ,EAAE;AAAEE,QAAAA,UAAU,EAAE,KAAA;AAAM,OAAC,CAAC,CAAA;KACvD,CAAC,OAAOC,CAAC,EAAE;MACV,MAAMC,eAAe,GAAGD,CAAoB,CAAA;MAC5C,MAAME,WAA8B,GAAG,EAAE,CAAA;AAEzC,MAAA,KAAK,MAAM;QAAEC,IAAI;QAAEC,IAAI;QAAEC,KAAK;AAAEC,QAAAA,OAAAA;AAAQ,OAAC,IAAIL,eAAe,CAACM,KAAK,EAAE;AAClEC,QAAAA,MAAM,CACJ,sHAAsH,EACtHL,IAAI,KAAKM,SAAS,CACnB,CAAA;AACD,QAAA,MAAMC,GAAG,GAAGP,IAAqB,CAAC;;AAElC,QAAA,IAAI,CAACD,WAAW,CAACQ,GAAG,CAAC,EAAE;AACrBR,UAAAA,WAAW,CAACQ,GAAG,CAAC,GAAG,EAAE,CAAA;AACvB,SAAA;AAEA,QAAA,MAAMC,MAAM,GAAGT,WAAW,CAACQ,GAAG,CAAC,CAAA;AAC/BF,QAAAA,MAAM,CAAC,oCAAoC,EAAEG,MAAM,CAAC,CAAC;;QAErDA,MAAM,CAACC,IAAI,CAAC;UACVR,IAAI,EAAEA,IAAI,IAAI,SAAS;UACvBC,KAAK;AACLC,UAAAA,OAAAA;AACF,SAAC,CAAC,CAAA;AACJ,OAAA;AAEA,MAAA,OAAOJ,WAAW,CAAA;AACpB,KAAA;AAEA,IAAA,OAAOO,SAAS,CAAA;GACjB,CAAA;AACH;;;;"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { default as validateYup } from "./helpers/validate-yup.js";

package/dist/index.js

@@ -0,0 +1,2 @@
+export { default as validateYup } from './helpers/validate-yup.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/template-registry.d.ts

@@ -0,0 +1,6 @@
+import validateYup from "./helpers/validate-yup.js";
+interface Registry {
+    validateYup: typeof validateYup;
+    'validate-yup': typeof validateYup;
+}
+export { Registry as default };

package/dist/template-registry.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=template-registry.js.map

package/dist/template-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-registry.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,113 @@
+{
+  "name": "ember-headless-form-yup",
+  "version": "1.0.0-beta.0",
+  "description": "Integrates yup-based validations with ember-headless-form",
+  "keywords": [
+    "ember-addon"
+  ],
+  "repository": "https://github.com/CrowdStrike/ember-headless-form.git",
+  "license": "MIT",
+  "author": "CrowdStrike UX Team",
+  "files": [
+    "addon-main.cjs",
+    "dist"
+  ],
+  "dependencies": {
+    "@embroider/addon-shim": "^1.0.0",
+    "ember-functions-as-helper-polyfill": "^2.1.1"
+  },
+  "peerDependencies": {
+    "yup": "^1.0.0",
+    "ember-headless-form": "^1.0.0-beta.0",
+    "ember-source": ">=4.4.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.17.0",
+    "@babel/preset-typescript": "^7.18.6",
+    "@babel/plugin-proposal-class-properties": "^7.16.7",
+    "@babel/plugin-proposal-decorators": "^7.17.0",
+    "@babel/plugin-syntax-decorators": "^7.17.0",
+    "ember-headless-form": "^1.0.0-beta.0",
+    "@embroider/addon-dev": "^3.0.0",
+    "@glimmer/component": "^1.1.2",
+    "@glint/core": "^1.0.0-beta.3",
+    "@glint/environment-ember-loose": "^1.0.0-beta.3",
+    "@glint/template": "^1.0.0-beta.3",
+    "@tsconfig/ember": "^1.0.0",
+    "@types/ember": "^4.0.0",
+    "@types/ember__object": "^4.0.0",
+    "@types/ember__service": "^4.0.0",
+    "@types/ember__controller": "^4.0.0",
+    "@types/ember__string": "^3.16.0",
+    "@types/ember__template": "^4.0.0",
+    "@types/ember__polyfills": "^4.0.0",
+    "@types/ember__utils": "^4.0.0",
+    "@types/ember__runloop": "^4.0.0",
+    "@types/ember__debug": "^4.0.0",
+    "@types/ember__engine": "^4.0.0",
+    "@types/ember__application": "^4.0.0",
+    "@types/ember__test": "^4.0.0",
+    "@types/ember__array": "^4.0.0",
+    "@types/ember__error": "^4.0.0",
+    "@types/ember__component": "^4.0.0",
+    "@types/ember__routing": "^4.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
+    "concurrently": "^7.2.1",
+    "ember-template-lint": "^4.0.0",
+    "ember-source": "~4.10.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-ember": "^10.5.8",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "prettier": "^2.5.1",
+    "rollup": "^2.67.0",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-ts": "^3.0.2",
+    "typescript": "^4.7.4",
+    "yup": "^1.0.0",
+    "webpack": "^5.75.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "ember": {
+    "edition": "octane"
+  },
+  "ember-addon": {
+    "version": 2,
+    "type": "addon",
+    "main": "addon-main.cjs",
+    "app-js": {
+      "./helpers/validate-yup.js": "./dist/_app_/helpers/validate-yup.js"
+    }
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
+    },
+    "./addon-main.js": "./addon-main.cjs"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/*"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "rollup --config",
+    "lint": "concurrently 'npm:lint:*(!fix)' --names 'lint:'",
+    "lint:fix": "concurrently 'npm:lint:*:fix' --names 'fix:'",
+    "lint:hbs": "ember-template-lint . --no-error-on-unmatched-pattern",
+    "lint:js": "eslint . --cache",
+    "lint:hbs:fix": "ember-template-lint . --fix --no-error-on-unmatched-pattern",
+    "lint:js:fix": "eslint . --fix",
+    "lint:types": "glint",
+    "start": "rollup --config --watch",
+    "test": "echo 'A v2 addon does not have tests, run tests in test-app'"
+  }
+}