json-schema-compatibility-checker 1.0.3 → 1.0.5

package/dist/semantic-diff/detectors.d.ts

@@ -1,79 +0,0 @@
-import type { JSONSchema7 } from "json-schema";
-import type { SchemaDiff } from "../types";
-import type { SemanticDiff } from "./types";
-/** Formate un type JSON Schema pour l'affichage (string, array → "string | number") */
-export declare function formatType(type: unknown): string;
-/**
- * Détecte les propriétés requises par le target que le source ne fournit pas.
- *
- * Condition : la propriété est dans `sup.required` mais n'existe pas
- * dans `sub.properties`.
- *
- * Regroupe les diffs structurels `properties.X added` + `required changed`
- * en un seul diagnostic.
- */
-export declare function detectMissingRequiredProperties(sub: JSONSchema7, sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Détecte les propriétés optionnelles dans le source mais requises par le target.
- *
- * Condition : la propriété existe dans `sub.properties` (mais pas dans
- * `sub.required`), et elle est dans `sup.required`.
- *
- * Ne se déclenche que si la propriété n'a pas déjà été détectée comme
- * `missing-required-property`.
- */
-export declare function detectPropertiesNotGuaranteed(sub: JSONSchema7, sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Détecte les propriétés fournies par le source que le target interdit.
- *
- * Condition : la propriété existe dans `sub.properties` mais pas dans
- * `sup.properties`, et `sup.additionalProperties === false`.
- */
-export declare function detectPropertiesNotAllowed(_sub: JSONSchema7, sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Détecte les incompatibilités de type sur les propriétés ou à la racine.
- *
- * Distingue deux cas :
- *   - `type-mismatch`  : types complètement différents (string vs number)
- *   - `type-too-wide`  : source est un superset du target (string|number vs string)
- */
-export declare function detectTypeDiffs(sub: JSONSchema7, sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Détecte les incompatibilités d'enum : source autorise des valeurs
- * que target n'accepte pas.
- */
-export declare function detectEnumDiffs(sub: JSONSchema7, sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Détecte les incompatibilités de const : valeurs const différentes.
- */
-export declare function detectConstDiffs(sub: JSONSchema7, sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Détecte les contraintes du target plus strictes que celles du source.
- *
- * Couvre : minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf,
- * minLength, maxLength, minItems, maxItems, minProperties, maxProperties.
- */
-export declare function detectConstraintDiffs(sub: JSONSchema7, sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Détecte les conflits d'additionalProperties :
- * source autorise des propriétés supplémentaires, target les interdit.
- */
-export declare function detectAdditionalPropertiesConflict(sub: JSONSchema7, sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Détecte les incompatibilités de schema d'items (arrays).
- */
-export declare function detectItemsDiffs(_sub: JSONSchema7, _sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Détecte les incompatibilités de format (email, uri, date-time, etc.).
- */
-export declare function detectFormatDiffs(sub: JSONSchema7, sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Détecte les incompatibilités de pattern regex.
- */
-export declare function detectPatternDiffs(sub: JSONSchema7, sup: JSONSchema7, diffs: SchemaDiff[], consumed: Set<number>): SemanticDiff[];
-/**
- * Convertit les diffs structurels non consommés en `schema-incompatible`.
- *
- * C'est le catch-all pour les cas non couverts par les détecteurs spécifiques.
- */
-export declare function createFallbackDiff(diff: SchemaDiff): SemanticDiff;

package/dist/semantic-diff/index.d.ts

@@ -1,3 +0,0 @@
-export { computeSemanticDiffs } from "./analyzer";
-export { formatType } from "./detectors";
-export type { SemanticDiff, SemanticDiffType } from "./types";

package/dist/semantic-diff/types.d.ts

@@ -1,81 +0,0 @@
-/**
- * Types de diffs sémantiques possibles.
- *
- * Chaque type correspond à une catégorie d'incompatibilité
- * entre un schema source et un schema target.
- */
-export type SemanticDiffType = 
-/** Target exige une propriété que source ne fournit pas du tout */
-"missing-required-property"
-/** La propriété existe dans source mais est optionnelle, target l'exige */
- | "property-not-guaranteed"
-/** Même propriété, types complètement incompatibles (string vs number) */
- | "type-mismatch"
-/** Source produit un type plus large que ce que target accepte (string|number vs string) */
- | "type-too-wide"
-/** Source autorise des valeurs enum que target n'accepte pas */
- | "enum-not-subset"
-/** Valeurs const incompatibles */
- | "const-mismatch"
-/** Source a des contraintes plus larges (min/max/length/items/etc.) */
- | "constraint-too-loose"
-/** Source autorise des propriétés supplémentaires, target les interdit */
- | "additional-properties-conflict"
-/** Source fournit une propriété que target interdit (additionalProperties: false) */
- | "property-not-allowed"
-/** Contrainte de format incompatible */
- | "format-mismatch"
-/** Pattern regex du source pas inclus dans celui du target */
- | "pattern-not-subset"
-/** Schema des items d'un array incompatible */
- | "incompatible-items"
-/** Incompatibilité générique (catch-all pour les cas non couverts) */
- | "schema-incompatible";
-/**
- * Un diagnostic sémantique décrivant une incompatibilité entre deux schemas.
- *
- * Contrairement aux `SchemaDiff` structurels (qui comparent original vs merged),
- * les `SemanticDiff` décrivent le problème en termes compréhensibles :
- *   - Quel est le problème (`type`)
- *   - Où il se situe (`path`)
- *   - Pourquoi c'est incompatible (`message`)
- *   - Données structurées pour l'exploiter programmatiquement (`details`)
- *
- * @example
- * ```
- * {
- *   type: 'missing-required-property',
- *   path: 'properties.meetingId',
- *   message: "Target requires property 'meetingId' (string) which source does not provide",
- *   details: { property: 'meetingId', targetSchema: { type: 'string' } }
- * }
- * ```
- */
-export interface SemanticDiff {
-    /** Catégorie sémantique de l'incompatibilité */
-    type: SemanticDiffType;
-    /** Chemin JSON-path vers l'élément problématique (ex: "properties.meetingId") */
-    path: string;
-    /** Message humain lisible décrivant le problème */
-    message: string;
-    /**
-     * Données structurées associées au diagnostic.
-     *
-     * Le contenu varie selon le `type` :
-     *
-     * - `missing-required-property` → `{ property, targetSchema }`
-     * - `property-not-guaranteed`   → `{ property }`
-     * - `type-mismatch`             → `{ property?, sourceType, targetType }`
-     * - `type-too-wide`             → `{ property?, sourceType, targetType }`
-     * - `enum-not-subset`           → `{ property?, sourceValues, targetValues, extraValues }`
-     * - `const-mismatch`            → `{ property?, sourceConst, targetConst }`
-     * - `constraint-too-loose`      → `{ property?, constraint, sourceValue, targetValue }`
-     * - `additional-properties-conflict` → `{ sourceAllows, targetAllows }`
-     * - `property-not-allowed`      → `{ property }`
-     * - `format-mismatch`           → `{ property?, sourceFormat, targetFormat }`
-     * - `pattern-not-subset`        → `{ property?, sourcePattern, targetPattern }`
-     * - `incompatible-items`        → `{ reason }`
-     * - `schema-incompatible`       → `{ reason }`
-     */
-    details: Record<string, unknown>;
-}