Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
@open-formulieren/types
Advanced tools
Typescript type definitions for Open Forms' Form.io extensions
TypeScript types for Open Forms and Form.io.
Form.io ships some type definitions itself, but as it is not implemented in TypeScript itself, the practicality of those types is a bit lacking. Open Forms supports a subset of Form.io's features and benefits from much stricter type definitions to make working with component types and certain generic features easier.
This library mostly serves the @open-formulieren/formio-renderer
and
@open-formulieren/formio-builder
packages. In the longer term, they will become relevant for the
@open-formulieren/sdk
package too and any person wishing to extend our SDK using TypeScript.
Install with npm or yarn:
npm install --save-dev @open-formulieren/types
yarn add -D @open-formulieren/types
It's recommended to install the library as dev-dependency as it's only relevant during compilation and in source code.
We provide schemas for the Form.io schemas used by Open Forms. Import them as:
import {NumberComponentSchema, TextfieldSchema} from '@open-formulieren/types';
// use in your own interfaces:
interface TextfieldComponentProps {
component: TextfieldSchema;
value: TextfieldSchema['defaultValue'];
errors: string[];
}
// or even with generics
interface ComponentProps<T> {
component: T;
value: T['defaultValue'];
errors: string[];
}
type TextfieldComponentProps = ComponentProps<TextfieldSchema>;
The component-specific schemas are extended from the base schemas.
You can use these to narrow your own component types, or provide them to interfaces where the exact component type is not known (yet).
import {
DisplayConfig, // additional common OF-specific properties
HasValidation, // subset of Form.io validate options + i18n of validation errors
InputComponentSchema, // base schema for any user-input component type
LayoutComponentSchema, // base schema for any purely layout component type (like fieldset) // custom backend prefill configuration
OFExtensions, // custom backend renderer configuration
PrefillConfig,
} from '@open-formulieren/types';
We don't let npm
apply the git tags when releasing a new version, instead follow this process:
npm version --no-git-tag-version minor
git commit -am ":bookmark: Bump to version <newVersion>"
git tag "<newVersion>"
git push origin main --tags
If you have PGP keys set up, you can use them for the git tag operation.
The CI pipeline will then publish the new version to npmjs.
FAQs
Typescript type definitions for Open Forms' Form.io extensions
The npm package @open-formulieren/types receives a total of 13 weekly downloads. As such, @open-formulieren/types popularity was classified as not popular.
We found that @open-formulieren/types demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.