Implementação de JSON Schema baseada em TypeScript e coleção de ferramentas de desenvolvimento

 (github.com/imhonglu)
6 pontos por honglu 2025-01-08 | 2 comentários | Compartilhar no WhatsApp

Este é um projeto que começou com a ideia de "vamos criar uma biblioteca type-safe do meu jeito".

O projeto começou com uma implementação type-safe de JSON Schema e se expandiu naturalmente para várias ferramentas necessárias ao longo do processo de desenvolvimento.

Por enquanto, coloquei um primeiro ponto final nele enquanto procuro uma nova oportunidade.

Princípios do projeto

O desenvolvimento seguiu os seguintes princípios centrais:

  • Uso de um sistema de tipos rigoroso
  • Manter o mínimo possível de dependências externas
  • Projetar um sistema de tipos reutilizável
  • Documentação da API
  • Manter alta cobertura de testes
  • Implementação puramente em TypeScript

Bibliotecas

@imhonglu/json-schema

Uma implementação em TypeScript compatível com a especificação JSON Schema draft 2020-12.

[IMG] demo-1

import { Schema, SchemaDefinition } from "@imhonglu/json-schema";  
  
export const Address = new Schema({  
  type: "object",  
  properties: {  
    street: { type: "string" },  
    city: { type: "string" },  
    zip: { type: "string" },  
  },  
  required: ["street"] as const,  
});  
  
export type Address = SchemaDefinition.Instance<typeof Address>;  
// {  
//   street: string;  
//   city?: string;  
//   zip?: string;  
// }

@imhonglu/format

Um projeto iniciado para implementar a palavra-chave format do JSON Schema.

import { FullTime } from '@imhonglu/format';  
  
const time = FullTime.parse('00:00:00.000Z');  
// { hour: 0, minute: 0, second: 0, secfrac: '.000', offset: undefined }  
  
console.log(time.toString()); // '00:00:00.000Z'  
console.log(JSON.stringify(time)); // '"00:00:00.000Z"'  
  
const result = FullTime.safeParse('invalid');  
if (!result.ok) {  
  console.error(result.error);  
}

@imhonglu/pattern-builder

Um builder de regex criado para melhorar a legibilidade das expressões regulares durante a implementação da gramática ABNF das especificações RFC.

import { characterSet, concat, hexDigit } from "@imhonglu/pattern-builder";  
  
// pct-encoded = "%" HEXDIG HEXDIG  
export const pctEncoded = concat(  
  "%",  
  hexDigit.clone().exact(2),  
);  
  
// unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"  
export const unreserved = characterSet(  
  alpha,  
  digit,  
  /[\-._~]/,  
);

@imhonglu/type-guard

Uma biblioteca de type guards criada para melhorar a legibilidade dos type guards.

import { composeGuards } from "@imhonglu/type-guard";  
  
const is = composeGuards({  
  string: (value: unknown): value is string => typeof value === "string",  
  number: (value: unknown): value is number => typeof value === "number"  
});  
  
is.string("hello"); // true  
is.not.string(42);  // true  
  
let value: string | number | undefined;  
  
if (is.number(value)) {  
  value.toFixed(2); // 'value' is number  
}  
  
if (is.not.number(value)) {  
  value.toFixed(2); // error: Property 'toFixed' does not exist on type 'undefined'.  
}

@imhonglu/type-object

Uma biblioteca wrapper type-safe para a API nativa de Object. Ela fornece tipos próximos ao comportamento nativo.

import * as TypeObject from '@imhonglu/type-object';  
  
const data = { a: 1, b: 2, c: 3 };  
for (const key of TypeObject.keys(data)) {  
  // key: "a" | "b" | "c"  
  console.log(data[key]); // number  
}  
  
const string = 'hello';  
for (const index of TypeObject.keys(string)) {  
  // index: number & keyof string  
  console.log(string[index]); // string  
}

@imhonglu/toolkit

Uma coleção de tipos utilitários e funções utilitárias usadas internamente no projeto.

import type { Fn } from '@imhonglu/toolkit';  
  
// Fornece um alias de tipo para o tipo de função '(...args: any[]) => any'.  
Fn.Callable // (...args: any[]) => any  
  
// Com genéricos, é possível definir apenas os tipos dos argumentos.  
Fn.Callable<{ args: [number, number] }> // (...args: [number, number]) => any  
  
// Com genéricos, é possível definir apenas o tipo de retorno.  
Fn.Callable<{ return: string }> // (...args: any[]) => string  
  
// Com genéricos, é possível definir tanto os tipos dos argumentos quanto o tipo de retorno.  
Fn.Callable<{ args: [number, number], return: string }> // (...args: [number, number]) => string

Planos futuros e busca por trabalho

A próxima etapa deste projeto em andamento é concluir a implementação da especificação JSON Schema
e também tentar criar um framework backend.

No momento estou procurando trabalho, então agradeço muito o interesse.
Obrigado por ler.

Tenha um ótimo dia!

Leituras relacionadas

2 comentários

 
jjpark78 2025-01-09

Por aqui existe algo excelente chamado zod, então estamos usando isso no produto, mas é interessante.
 
honglu 2025-01-09

Projetos já consolidados como ajv, typia e zod são projetos que também acompanho com bastante interesse.

No caso do safeParse de @imhonglu/format, ele também é uma funcionalidade influenciada pela API do zod.

Agradeço o interesse!