Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
@brabo/schema
Advanced tools
TypeScript schema declaration and validation library with static type inference
Typescript schema validation with static type inference.
Schemas are a crucial part of a microservices architecture or a detachable application architecture (brabo). They can serve as contracts between different pieces of an application (frontend, backend, forms) and different services. So schemas should be easily portable, written and read, and that's the goal of this package.
To install:
npm install @brabo/schema
⚠️ IMPORTANT: You must enable strict
mode in your tsconfig.json
. This is a best practice for all TypeScript projects.
// tsconfig.json
{
// ...
"compilerOptions": {
// ...
"strict": true
}
}
const addressSchema = createSchema({
street: 'string',
number: 'int?',
});
const schemaDefinition = {
name: 'string', // any string
email: 'email?', // email type - will validate against email regex
age: 'int?', // optional integer
notes: '[int]?',
// declaring an union
unionField: [['string?', '[int]?']],
// represents an enum
letter: ['a', 'b', 'c'],
// more detailed way to define enums
letterOptionalList: {
enum: ['x', 'y', 'z'],
optional: true,
list: true,
},
// using a previous schema as field type
optionalAddress: {
type: addressSchema,
optional: true,
},
// another way to define schema fields
deliveryAddress: {
schema: {
street: 'string',
number: 'int?',
},
},
} as const; // "as const" is needed to TS to infer types correctly
const userSchema = createSchema(schemaDefinition);
expect(() => userSchema.parse({ name: 'Antonio', letter: 'x' })).toThrow(
`field "letter": accepted: 'a' or 'b' or 'c', found x.`
);
expect(() => userSchema.parse({ name: 'antonio', letter: 'a', deliveryAddress: {} })).toThrow(
'field "deliveryAddress": ➤ field "street": expected type string, found undefined.'
);
const parsed = userSchema.parse({ name: 'antonio', letter: 'a', deliveryAddress: { street: 'alameda' } });
type InferType = typeof parsed;
assert<
IsExact<
InferType,
{
name: string;
email?: string | undefined;
age?: number | undefined;
notes?: number[] | undefined;
unionField?: string | number[] | undefined;
letter: 'a' | 'b' | 'c';
letterOptionalList?: ('x' | 'y' | 'z')[] | undefined;
optionalAddress?:
| {
street: string;
number?: number | undefined;
}
| undefined;
deliveryAddress: {
street: string;
number?: number | undefined;
};
}
>
>(true);
Returns a string of an interface representing a BraboSchema;
import { schemaToTypescript } from '@brabo/schema/lib/schemaToTypescript';
const interfaceTxt = await schemaToTypescript('User', userSchema);
const interfaceTxt = await schemaToTypescript('User', userSchema);
expect(interfaceTxt).toBe(`
export interface User {
name: string;
email?: Email;
age?: number;
notes?: number[];
unionField?: string | number[];
letter: "a" | "b" | "c";
letterOptionalList?: ("x" | "y" | "z")[];
optionalAddress?: {
street: string;
number?: number;
};
deliveryAddress: {
street: string;
number?: number;
};
}`);
Receives a BraboSchema and returns a json-schema
import { schemaToJSON } from '@brabo/schema/lib/schemaToJSON';
const jsonSchema = schemaToJSON('User', userSchema);
expect(jsonSchema).toEqual({
properties: {
address: {
properties: {
number: {
type: 'integer',
},
street: {
type: 'string',
},
},
required: ['street'],
title: '',
type: 'object',
},
age: {
type: 'integer',
},
email: {
tsType: 'Email',
type: 'string',
},
letter: {
enum: ['a', 'b', 'c'],
title: 'EnumLetterUser',
type: 'string',
},
letterOptionalList: {
items: {
enum: ['x', 'y', 'z'],
title: 'Enum__subLetterOptionalList',
type: 'string',
},
type: 'array',
},
name: {
type: 'string',
},
notes: {
items: {
type: 'integer',
},
type: 'array',
},
},
required: ['name', 'letter'],
title: 'User',
type: 'object',
});
FAQs
TypeScript schema declaration and validation library with static type inference
We found that @brabo/schema demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 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
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.