Merge branch 'main' into feat/use-interface-for-base-types

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing
+
+We love pull requests from everyone. By contributing to this repository, you
+agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Get started
+
+- First [fork][fork] the repository and then clone it using:
+
+```bash
+git clone [email protected]:your-username/valibot.git
+```
+
+- After that create a branch for your changes. For example:
+  - `feat-XXX` if you will add functionality.
+  - `fix-XXX` if you will fix a bug.
+  - `test-XXX` if you wrote a test/s.
+  - `doc-XXX` if you added to or edited documentation.
+  - `refactor-XXX` if you refactor some part of the code.
+
+You may contribute by:
+
+- Implementing a new validation action.
+- Optimizing or improving the existing code.
+- Suggest a different solution for a problem.
+- Finding and fixing bugs and typos.
+- Adding examples to explain the usage.
+- Adding and improving test cases.
+- Improving our website and documentation.
+
+## Pull requests
+
+Push to your fork and [submit a pull request][pr].
+
+### Best practices
+
+As we strive for excellence in our codebase, here are some guidelines to make your contributions shine:
+
+- Code in TypeScript: Embrace the power of TypeScript for writing your code. It helps in maintaining consistency and leveraging TypeScript's robust features.
+- Clarity and cleanliness: Write code that speaks for itself. Aim for simplicity and clarity, making it easy for others to read and understand at a glance.
+- Commenting and documentation: Illuminate your code with clear comments. Explain the purpose and functionality of your code. Where applicable, include links to relevant Wiki articles or external sources for further context.
+- Illustrative examples: Enhance understanding by providing minimal yet meaningful examples to demonstrate the expected output of your code.
+- Include test cases: Show the robustness of your code by accompanying it with well-thought-out test cases. This practice not only validates your code but also assists in maintaining the code quality in the long run.
+- Size matters for PRs: Keep your pull requests concise and focused. Smaller PRs are easier to review and merge, speeding up the development process. This approach helps in isolating changes and simplifying troubleshooting.
+- Crafting a good commit message: Your commit messages are a roadmap of your changes. Make them informative and useful for everyone.
+
+## Issues
+
+Submit a [new issue][newissue] if there is a feature to be added, or if a bug was found in the existing code. Before submitting a new issue please review the [existing issues][issues] to avoid creating duplicates. Also, consider resolving current issues or contributing to the discussion on an issue.
+
+## Collaborators
+
+You can ask for any help or clarifications from the collaborators.
+
+- [Fabian Hiller](https://github.com/fabian-hiller)
+- [Aris Kemper](https://github.com/ariskemper)
+
+[fork]: https://help.github.com/articles/fork-a-repo/
+[pr]: https://github.com/fabian-hiller/valibot/compare
+[newissue]: https://github.com/fabian-hiller/valibot/issues/new
+[issues]: https://github.com/fabian-hiller/valibot/issues

library/CHANGELOG.md

@@ -2,9 +2,15 @@
 
 All notable changes to the library will be documented in this file.
 
-## vX.X.X (Month DD, YYYY)
+## v0.26.0 (January 16, 2023)
 
+- Improve performance of `enum_` and `enumAsync` schema by caching values
+- Change ISO timestamp regex to support timestamps with lower and higher millisecond accuracy (pull request #353)
+- Change issue handling of `union`, `unionAsync`, `variant` and `variantAsync` to improve developer experience
 - Fix bug in `getDefaults`, `getDefaultsAsync`, `getFallbacks` and `getFallbacksAsync` for falsy but not `undefined` values (issue #356)
+- Fix type of `pipe` argument at `union`, `unionAsync`, `variant` and `variantAsync`
+- Fix bug that broke pipeline execution in `union`, `unionAsync`, `variant` and `variantAsync` (issue #364)
+- Fix typo in type name of `startsWith` validation action (pull request #375)
 
 ## v0.25.0 (December 26, 2023)
 

library/package.json

@@ -1,7 +1,7 @@
 {
   "name": "valibot",
   "description": "The modular and TypeScript-first schema library",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "license": "MIT",
   "author": "Fabian Hiller",
   "homepage": "https://valibot.dev",

library/src/regex.ts

@@ -79,7 +79,7 @@ export const ISO_TIME_SECOND_REGEX = /^(?:0\d|1\d|2[0-3])(?::[0-5]\d){2}$/u;
  * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp regex.
  */
 export const ISO_TIMESTAMP_REGEX =
-  /^\d{4}-(?:0[1-9]|1[0-2])-(?:[12]\d|0[1-9]|3[01])T(?:0\d|1\d|2[0-3])(?::[0-5]\d){2}\.\d{3}Z$/u;
+  /^\d{4}-(?:0[1-9]|1[0-2])-(?:[12]\d|0[1-9]|3[01])T(?:0\d|1\d|2[0-3])(?::[0-5]\d){2}(?:\.\d{1,9})?Z$/u;
 
 /**
  * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) week regex.

library/src/schemas/enum/enum.ts

@@ -40,14 +40,21 @@ export function enum_<TEnum extends Enum>(
   enum_: TEnum,
   message: ErrorMessage = 'Invalid type'
 ): EnumSchema<TEnum> {
+  // Create cached values
+  let cachedValues: (string | number)[];
+
+  // Create and return enum schema
   return {
     type: 'enum',
     async: false,
     enum: enum_,
     message,
     _parse(input, info) {
+      // Cache values lazy
+      cachedValues = cachedValues || Object.values(this.enum);
+
       // Check type of input
-      if (!Object.values(this.enum).includes(input as any)) {
+      if (!cachedValues.includes(input as any)) {
         return schemaIssue(info, 'type', 'enum', this.message, input);
       }
 

library/src/schemas/enum/enumAsync.ts

@@ -35,14 +35,21 @@ export function enumAsync<TEnum extends Enum>(
   enum_: TEnum,
   message: ErrorMessage = 'Invalid type'
 ): EnumSchemaAsync<TEnum> {
+  // Create cached values
+  let cachedValues: (string | number)[];
+
+  // Create and return enum schema
   return {
     type: 'enum',
     async: true,
     enum: enum_,
     message,
     async _parse(input, info) {
+      // Cache values lazy
+      cachedValues = cachedValues || Object.values(this.enum);
+
       // Check type of input
-      if (!Object.values(this.enum).includes(input as any)) {
+      if (!cachedValues.includes(input as any)) {
         return schemaIssue(info, 'type', 'enum', this.message, input);
       }
 

library/src/schemas/union/union.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, test } from 'vitest';
 import { parse } from '../../methods/index.ts';
-import { custom } from '../../validations/index.ts';
+import { custom, length } from '../../validations/index.ts';
 import { string } from '../string/index.ts';
 import { number } from '../number/index.ts';
 import { null_ } from '../null/index.ts';
@@ -31,7 +31,7 @@ describe('union', () => {
     );
   });
 
-  test('should execute pipe', () => {
+  test('should execute pipe with valid result', () => {
     const equalError = 'Not equal 10';
 
     const schema1 = union(
@@ -51,4 +51,52 @@ describe('union', () => {
     expect(() => parse(schema2, '123')).toThrowError(equalError);
     expect(() => parse(schema2, 123)).toThrowError(equalError);
   });
+
+  test('should execute pipe with single typed result', () => {
+    const equalError = 'Not equal 10';
+    const lengthError = 'Invalid string length';
+
+    const schema1 = union(
+      [string([length(2, lengthError)]), number()],
+      [custom((input) => +input === 10, equalError)]
+    );
+    expect(parse(schema1, '10')).toEqual('10');
+    expect(parse(schema1, 10)).toEqual(10);
+    expect(() => parse(schema1, '1')).toThrowError(lengthError);
+    expect(() => parse(schema1, '123')).toThrowError(lengthError);
+    expect(() => parse(schema1, 11)).toThrowError(equalError);
+
+    const schema2 = union(
+      [string([length(2, lengthError)]), number()],
+      'Error',
+      [custom((input) => +input === 10, equalError)]
+    );
+    expect(parse(schema2, '10')).toEqual('10');
+    expect(parse(schema2, 10)).toEqual(10);
+    expect(() => parse(schema2, '1')).toThrowError(lengthError);
+    expect(() => parse(schema2, '123')).toThrowError(lengthError);
+    expect(() => parse(schema2, 11)).toThrowError(equalError);
+  });
+
+  test('should execute pipe with multiple typed results', () => {
+    const invalidError = 'Invalid string value';
+    const schema = union(
+      [string([length(2)]), string([length(4)])],
+      invalidError,
+      [custom((input) => +input % 2 === 0)]
+    );
+    expect(parse(schema, '10')).toEqual('10');
+    expect(parse(schema, '2222')).toEqual('2222');
+    expect(() => parse(schema, '1')).toThrowError(invalidError);
+    expect(() => parse(schema, '123')).toThrowError(invalidError);
+  });
+
+  test('should return single untyped result', () => {
+    const typeError = 'Not a string!';
+    const schema = union([string(typeError)]);
+    expect(parse(schema, 'foo')).toEqual('foo');
+    expect(parse(schema, '123')).toEqual('123');
+    expect(() => parse(schema, null)).toThrowError(typeError);
+    expect(() => parse(schema, 123)).toThrowError(typeError);
+  });
 });