npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@lifesg/validation-schema-generator

v1.3.0

Published

JSON to validation schema for frontend-engine

Downloads

852

Readme

LifeSG Validation Schema Generator npm version

  • typescript-based
  • JSON to Yup conversion
  • field types baked into library

The validation schema generator is meant to be used in conjunction with the web-frontend-engine and any backend service interaction with the frontend engine. It is able to convert validation config in JSON format to a validation schema (Yup) that will be used on both frontend and backend.

For more information on the schema format, please refer to the frontend engine storybook at https://designsystem.life.gov.sg/web-frontend-engine/index.html.

Intention

Since form submission involves validation on both frontend and backend, it makes sense to have a common library for it. This ensures the validation logic is the same across both ends and prevents duplication of codes. This library is meant for stacks that use typescript in both frontend and backend.

Getting started

Installation

npm i @lifesg/validation-schema-generator

jsonToSchema

Generate a validation schema to validate against a set of values.

import { jsonToSchema } from "@lifesg/validation-schema-generator";

const schema = jsonToSchema({
	section1: {
		uiType: "section",
		children: {
			field1: {
				uiType: "contact-field",
				label: "Contact number",
				validation: [
					{ required: true },
					{ contactNumber: { singaporeNumber: "default" }, errorMessage: "Invalid contact number" },
				],
			},
			field2: {
				uiType: "radio",
				label: "Radio",
				options: [
					{ label: "A", value: "Apple" },
					{ label: "B", value: "Berry" },
				],
				validation: [{ required: true }, { min: 2, errorMessage: "Min. 2 items" }],
			},
		},
	},
	section2: {
		uiType: "section",
		children: {
			field3: {
				uiType: "text-field",
				label: "Text field",
				validation: [{ required: true }],
			},
		},
	},
});

await schema.validate(
	{
		field1: "+65 91234567",
		field2: "Apple",
		field3: "Hello",
	},
	{ abortEarly: false }
);

addRule

Add custom rules to support additional validation logic.

import { addRule, jsonToSchema } from "@lifesg/validation-schema-generator";

addRule("string", "testString", (value) => value === "hello");

const schema = jsonToSchema<{ testString?: boolean }>({
	mySection: {
		uiType: "section",
		children: {
			field: {
				uiType: "text-field",
				validation: [{ testString: true, errorMessage: "error message" }],
			},
		},
	},
});

await schema.validate({ field: "invalid" });

Fields supported

  • checkbox
  • chips
  • contact-field
  • date-field
  • email-field
  • multi-select
  • numeric
  • radio
  • select
  • text-field
  • textarea
  • time-field

For more information on the usage of each field, please refer to the frontend engine storybook at https://designsystem.life.gov.sg/web-frontend-engine/index.html.

Definitions

Throughout the library, you will find terms referring to various objects, it will be beneficial to know their actual meanings:

Validation schema

The eventual output as a Yup schema.

Validation config

The validation property of a field in a JSON form schema (refer to web-frontend-engine). It is an array of rules.

// sample form schema
{
	sections: {
		mySection: {
			uiType: "section",
			children: {
				myField: {
					uiType: "text",
					label: "My field",
					validation: [ // <-- validation config
						{ required: true, errorMessage: "this field is required" } // <-- rule
					]
				}
			}
		}
	}
}

Rule

An object within the validation config describing a single validation logic.

Condition

The key of a rule, .e.g, required.