@praxisui/specification-core

@praxisui/specification-core

🔰 Exemplos / Quickstart

Para ver esta biblioteca em funcionamento em uma aplicação completa, utilize o projeto de exemplo (Quickstart):

• Repositório: https://github.com/codexrodrigues/praxis-ui-quickstart
• O Quickstart demonstra a integração das bibliotecas @praxisui/* em um app Angular, incluindo instalação, configuração e uso em telas reais.

Tipos e classe base do padrão Specification, compartilhados entre os pacotes Praxis.

Visão Geral

A biblioteca @praxisui/specification-core fornece a fundação do padrão Specification no ecossistema Praxis:

• Classe abstrata Specification<T> com ciclo de vida e utilitários (metadata, clone, serialização/DSL).
• Tipos de metadados (SpecificationMetadata, SpecificationOptions) para enriquecer validações e integrações de UI.
• Usada por @praxisui/specification para composições lógicas (and/or/not/xor/implies).

Este pacote não contém componentes Angular nem composições; ele expõe apenas os contratos (core) e a classe base.

Instalação

npm i @praxisui/specification-core

Peer dependencies (Angular v20):

• @angular/core ^20.0.0
• @angular/common ^20.0.0

Dependências em runtime:

• tslib (instalada automaticamente)

Exemplo Rápido

Crie uma especificação concreta estendendo Specification<T> e implemente os métodos abstratos.

import { Specification, SpecificationMetadata } from '@praxisui/specification-core';

interface Person { age: number }

export class AdultSpecification extends Specification<Person> {
  constructor(private minAge = 18, metadata?: SpecificationMetadata) {
    super(metadata);
  }

  isSatisfiedBy(person: Person): boolean {
    return person.age >= this.minAge;
  }

  toJSON() {
    return { kind: 'adult', minAge: this.minAge, metadata: this.getMetadata() };
  }

  static fromJSON(json: any): AdultSpecification {
    return new AdultSpecification(json.minAge, json.metadata);
  }

  toDSL(): string {
    return `age >= ${this.minAge}`;
  }

  clone(): AdultSpecification {
    return new AdultSpecification(this.minAge, this.getMetadata());
  }
}

// Uso
const spec = new AdultSpecification(21, { code: 'ADULT_ONLY', message: 'Somente maiores de 21' });
const ok = spec.isSatisfiedBy({ age: 25 }); // true

// Metadata helper
const withUi = spec.withMetadata({ uiConfig: { severity: 'warning' } });

Observação: métodos de composição (and, or, not, xor, implies) existem como stubs que lançam erro — use as fábricas em @praxisui/specification para composições lógicas.

API (Resumo)

Exports principais:

• Specification<T extends object>
• SpecificationMetadata
• SpecificationOptions

Métodos de Specification<T>:

• isSatisfiedBy(obj: T): boolean — verifica se o objeto satisfaz a regra.
• toJSON(): any e static fromJSON(json: any) — serialização customizável.
• toDSL(): string — representação textual para logs/editores.
• getMetadata() | setMetadata(m) | withMetadata(m) — metadata de validação/UI.
• clone(): Specification<T> — cópia profunda.
• getOperatorKind() — para precedência (usado por composições em @praxisui/specification).

Para operações lógicas e coleções de specifications, utilize @praxisui/specification.

Links

• Repositório: https://github.com/codexrodrigues/praxis
• Issues: https://github.com/codexrodrigues/praxis/issues