@unispechq/unispec-core 0.3.2 → 0.3.4

package/dist/cjs/src/optimizer/core.js

@@ -1,140 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.optimizeDocument = optimizeDocument;
-exports.generateOptimizationReport = generateOptimizationReport;
-const schemas_1 = require("../schemas/index.js");
-const optimization_functions_1 = require("./optimization-functions.js");
-/**
- * Optimize a UniSpec document with various optimization strategies.
- *
- * @param doc - The UniSpec document to optimize
- * @param options - Optimization options
- * @returns Optimization result with statistics and changes
- */
-function optimizeDocument(doc, options = {}) {
-    const changes = [];
-    const originalSchemaCount = Object.keys(doc.service?.schemas || {}).length;
-    // Create a deep copy to avoid mutating the original
-    const optimizedDoc = JSON.parse(JSON.stringify(doc));
-    // Ensure service and schemas exist
-    if (!optimizedDoc.service) {
-        optimizedDoc.service = { name: "" };
-    }
-    if (!optimizedDoc.service.schemas) {
-        optimizedDoc.service.schemas = {};
-    }
-    let deduplicatedCount = 0;
-    // Apply optimizations in order
-    if (options.dedupeSchemas !== false) {
-        const dedupResult = (0, optimization_functions_1.deduplicateSchemas)(optimizedDoc);
-        if (dedupResult.removedSchemas.length > 0) {
-            changes.push(`Deduplicated ${dedupResult.removedSchemas.length} schemas: ${dedupResult.removedSchemas.join(", ")}`);
-            changes.push(`Updated ${dedupResult.updatedReferences} schema references`);
-            deduplicatedCount = dedupResult.removedSchemas.length;
-        }
-    }
-    if (options.removeUnusedSchemas === true) {
-        const removed = (0, optimization_functions_1.removeOrphanedSchemas)(optimizedDoc);
-        if (removed.length > 0) {
-            changes.push(`Removed ${removed.length} orphaned schemas: ${removed.join(", ")}`);
-        }
-    }
-    if (options.sortSchemas !== false) {
-        const sortedCount = (0, optimization_functions_1.sortSchemas)(optimizedDoc);
-        if (sortedCount > 0) {
-            changes.push(`Sorted ${sortedCount} schemas alphabetically`);
-        }
-    }
-    if (options.compressReferences !== false) {
-        const compressedCount = (0, optimization_functions_1.compressSchemaReferences)(optimizedDoc);
-        if (compressedCount > 0) {
-            changes.push(`Compressed ${compressedCount} schema references`);
-        }
-    }
-    const finalSchemaCount = Object.keys(optimizedDoc.service.schemas).length;
-    return {
-        document: optimizedDoc,
-        statistics: {
-            originalSchemas: originalSchemaCount,
-            optimizedSchemas: finalSchemaCount,
-            removedSchemas: originalSchemaCount - finalSchemaCount,
-            deduplicatedSchemas: deduplicatedCount,
-        },
-        changes,
-    };
-}
-/**
- * Generate optimization report for a UniSpec document.
- *
- * @param doc - The UniSpec document to analyze
- * @returns Optimization recommendations
- */
-function generateOptimizationReport(doc) {
-    const recommendations = [];
-    // Create copies for analysis to avoid mutating original
-    const docForDedup = JSON.parse(JSON.stringify(doc));
-    const _docForOrphaned = JSON.parse(JSON.stringify(doc));
-    // First find duplicates
-    const dedupResult = (0, optimization_functions_1.deduplicateSchemas)(docForDedup);
-    // Find orphaned schemas that are NOT duplicates
-    const allSchemas = Object.keys(doc.service?.schemas || {});
-    const duplicateNames = new Set(dedupResult.removedSchemas);
-    // Find referenced schemas
-    const referencedSchemas = new Set();
-    function findReferences(obj) {
-        if (!obj || typeof obj !== "object")
-            return;
-        for (const [key, value] of Object.entries(obj)) {
-            if (key === "schemaRef" && typeof value === "string") {
-                const schemaName = (0, schemas_1.normalizeSchemaRef)(value);
-                if (schemaName)
-                    referencedSchemas.add(schemaName);
-            }
-            else if (typeof value === "object" && value !== null) {
-                findReferences(value);
-            }
-        }
-    }
-    findReferences(doc);
-    // Find orphaned schemas that are not duplicates
-    const orphaned = allSchemas.filter((name) => !referencedSchemas.has(name) && !duplicateNames.has(name));
-    if (orphaned.length > 0) {
-        recommendations.push(`Remove ${orphaned.length} orphaned schemas to reduce document size`);
-    }
-    if (dedupResult.removedSchemas.length > 0) {
-        recommendations.push(`Deduplicate ${dedupResult.removedSchemas.length} identical schemas`);
-    }
-    const totalSchemas = Object.keys(doc.service?.schemas || {}).length;
-    const potentialReduction = orphaned.length + dedupResult.removedSchemas.length;
-    // Calculate reference compression savings only if there are schema references
-    let referenceCompression = 0;
-    if (totalSchemas > 0) {
-        // Count actual schema references to estimate compression savings
-        let referenceCount = 0;
-        function countReferences(obj) {
-            if (!obj || typeof obj !== "object")
-                return;
-            for (const [key, value] of Object.entries(obj)) {
-                if (key === "schemaRef" && typeof value === "string") {
-                    referenceCount++;
-                }
-                else if (typeof value === "object" && value !== null) {
-                    countReferences(value);
-                }
-            }
-        }
-        countReferences(doc);
-        // Only estimate compression if there are references to compress
-        if (referenceCount > 1) {
-            referenceCompression = Math.min(referenceCount * 0.1, totalSchemas * 0.1);
-        }
-    }
-    const result = {
-        recommendations,
-        potentialSavings: {
-            schemaReduction: potentialReduction,
-            referenceCompression,
-        },
-    };
-    return result;
-}

package/dist/cjs/src/optimizer/index.js

@@ -1,17 +0,0 @@
-"use strict";
-// Export types
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compressReference = exports.sortSchemas = exports.removeOrphanedSchemas = exports.deduplicateSchemas = exports.compressSchemaReferences = exports.optimizeDocument = exports.generateOptimizationReport = void 0;
-// Export core functions
-var core_1 = require("./core.js");
-Object.defineProperty(exports, "generateOptimizationReport", { enumerable: true, get: function () { return core_1.generateOptimizationReport; } });
-Object.defineProperty(exports, "optimizeDocument", { enumerable: true, get: function () { return core_1.optimizeDocument; } });
-// Export optimization functions
-var optimization_functions_1 = require("./optimization-functions.js");
-Object.defineProperty(exports, "compressSchemaReferences", { enumerable: true, get: function () { return optimization_functions_1.compressSchemaReferences; } });
-Object.defineProperty(exports, "deduplicateSchemas", { enumerable: true, get: function () { return optimization_functions_1.deduplicateSchemas; } });
-Object.defineProperty(exports, "removeOrphanedSchemas", { enumerable: true, get: function () { return optimization_functions_1.removeOrphanedSchemas; } });
-Object.defineProperty(exports, "sortSchemas", { enumerable: true, get: function () { return optimization_functions_1.sortSchemas; } });
-// Export utilities
-var utils_1 = require("./utils.js");
-Object.defineProperty(exports, "compressReference", { enumerable: true, get: function () { return utils_1.compressReference; } });

package/dist/cjs/src/optimizer/optimization-functions.js

@@ -1,185 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deduplicateSchemas = deduplicateSchemas;
-exports.removeOrphanedSchemas = removeOrphanedSchemas;
-exports.sortSchemas = sortSchemas;
-exports.compressSchemaReferences = compressSchemaReferences;
-const schemas_1 = require("../schemas/index.js");
-const utils_1 = require("./utils.js");
-/**
- * Remove duplicate schemas from a UniSpec document.
- * Duplicates are identified by identical JSON Schema content.
- * Updates all schema references to point to the retained schema.
- *
- * @param doc - The UniSpec document to deduplicate
- * @returns Object with deduplication statistics
- */
-function deduplicateSchemas(doc) {
-    if (!doc.service?.schemas) {
-        return { removedSchemas: [], updatedReferences: 0 };
-    }
-    // First, find all referenced schemas
-    const referencedSchemas = new Set();
-    function findReferences(obj) {
-        if (!obj || typeof obj !== "object")
-            return;
-        for (const [key, value] of Object.entries(obj)) {
-            if (key === "schemaRef" && typeof value === "string") {
-                const schemaName = (0, schemas_1.normalizeSchemaRef)(value);
-                if (schemaName)
-                    referencedSchemas.add(schemaName);
-            }
-            else if (typeof value === "object" && value !== null) {
-                findReferences(value);
-            }
-        }
-    }
-    findReferences(doc);
-    const names = Object.keys(doc.service.schemas);
-    const hashToName = new Map();
-    const renameMap = {};
-    const removedSchemas = [];
-    for (const name of names) {
-        const schema = doc.service.schemas[name];
-        // Only hash the jsonSchema content, not the name field
-        const hash = (0, schemas_1.stableStringify)(schema?.jsonSchema ?? null);
-        const existing = hashToName.get(hash);
-        if (!existing) {
-            hashToName.set(hash, name);
-            continue;
-        }
-        // Found duplicate - prefer referenced schema over unreferenced one
-        const existingIsReferenced = referencedSchemas.has(existing);
-        const currentIsReferenced = referencedSchemas.has(name);
-        if (existingIsReferenced && !currentIsReferenced) {
-            // Keep existing, remove current
-            renameMap[name] = existing;
-            removedSchemas.push(name);
-        }
-        else if (!existingIsReferenced && currentIsReferenced) {
-            // Keep current, remove existing
-            renameMap[existing] = name;
-            removedSchemas.push(existing);
-            hashToName.set(hash, name); // Update to current as preferred
-        }
-        else {
-            // Both referenced or both unreferenced - keep first encountered
-            renameMap[name] = existing;
-            removedSchemas.push(name);
-        }
-    }
-    if (removedSchemas.length === 0) {
-        return { removedSchemas: [], updatedReferences: 0 };
-    }
-    // Update all schema references
-    let updatedReferences = 0;
-    function updateReferences(obj, path = "") {
-        if (!obj || typeof obj !== "object")
-            return;
-        const objRecord = obj;
-        for (const [key, value] of Object.entries(objRecord)) {
-            const currentPath = path ? `${path}.${key}` : key;
-            if (key === "schemaRef" && typeof value === "string") {
-                const schemaName = (0, schemas_1.normalizeSchemaRef)(value);
-                if (renameMap[schemaName]) {
-                    objRecord[key] = renameMap[schemaName];
-                    updatedReferences++;
-                }
-            }
-            else if (typeof value === "object" && value !== null) {
-                updateReferences(value, currentPath);
-            }
-        }
-    }
-    updateReferences(doc);
-    // Remove duplicate schemas
-    for (const dup of removedSchemas) {
-        delete doc.service.schemas[dup];
-    }
-    return { removedSchemas, updatedReferences };
-}
-/**
- * Remove orphaned schemas (not referenced anywhere).
- *
- * @param doc - The UniSpec document to optimize
- * @returns Array of removed schema names
- */
-function removeOrphanedSchemas(doc) {
-    if (!doc.service?.schemas)
-        return [];
-    const referencedSchemas = new Set();
-    // Find all referenced schemas
-    function findReferences(obj) {
-        if (!obj || typeof obj !== "object")
-            return;
-        for (const [key, value] of Object.entries(obj)) {
-            if (key === "schemaRef" && typeof value === "string") {
-                const schemaName = (0, schemas_1.normalizeSchemaRef)(value);
-                if (schemaName)
-                    referencedSchemas.add(schemaName);
-            }
-            else if (typeof value === "object" && value !== null) {
-                findReferences(value);
-            }
-        }
-    }
-    findReferences(doc);
-    // Remove orphaned schemas
-    const allSchemas = Object.keys(doc.service.schemas);
-    const orphaned = allSchemas.filter((schema) => !referencedSchemas.has(schema));
-    for (const orphan of orphaned) {
-        delete doc.service.schemas[orphan];
-    }
-    return orphaned;
-}
-/**
- * Sort schemas alphabetically by name for consistent output.
- *
- * @param doc - The UniSpec document to optimize
- * @returns Number of schemas sorted
- */
-function sortSchemas(doc) {
-    if (!doc.service?.schemas)
-        return 0;
-    const schemaNames = Object.keys(doc.service.schemas);
-    if (schemaNames.length === 0)
-        return 0;
-    const sortedSchemas = {};
-    schemaNames.sort().forEach((name) => {
-        const schema = doc.service?.schemas?.[name];
-        if (schema) {
-            sortedSchemas[name] = schema;
-        }
-    });
-    doc.service.schemas = sortedSchemas;
-    return schemaNames.length;
-}
-/**
- * Compress schema references by using shortest possible format.
- *
- * @param doc - The UniSpec document to optimize
- * @returns Number of references compressed
- */
-function compressSchemaReferences(doc) {
-    let compressedCount = 0;
-    function compressReferences(obj) {
-        if (!obj || typeof obj !== "object")
-            return;
-        const objRecord = obj;
-        for (const [key, value] of Object.entries(objRecord)) {
-            if (key === "schemaRef" && typeof value === "string") {
-                const original = value;
-                const compressed = (0, utils_1.compressReference)(original);
-                if (compressed !== original) {
-                    objRecord[key] = compressed;
-                    compressedCount++;
-                }
-            }
-            else if (typeof value === "object" && value !== null) {
-                compressReferences(value);
-            }
-        }
-    }
-    compressReferences(doc);
-    return compressedCount;
-}

package/dist/cjs/src/optimizer/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/src/optimizer/utils.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compressReference = compressReference;
-/**
- * Compress a single schema reference to its shortest form.
- *
- * @param ref - The schema reference to compress
- * @returns Compressed reference
- */
-function compressReference(ref) {
-    const trimmed = ref.trim();
-    if (trimmed.length === 0)
-        return "";
-    // If it's already a simple name, keep it
-    if (!trimmed.startsWith("#") && !trimmed.includes("/")) {
-        return trimmed;
-    }
-    // Convert JSON Pointer to simple name
-    if (trimmed.startsWith("#/service/schemas/")) {
-        const parts = trimmed.split("/");
-        return parts[parts.length - 1];
-    }
-    // Convert hash format to simple name
-    if (trimmed.startsWith("#")) {
-        const withoutHash = trimmed.slice(1);
-        const parts = withoutHash.split("/").filter(Boolean);
-        return parts.length > 0 ? parts[parts.length - 1] : withoutHash;
-    }
-    // Convert path format to simple name
-    const parts = trimmed.split("/").filter(Boolean);
-    return parts.length > 0 ? parts[parts.length - 1] : trimmed;
-}

package/dist/cjs/src/schemas/dedupe.js

@@ -1,113 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dedupeSchemas = dedupeSchemas;
-const utils_1 = require("./utils.js");
-function updateSchemaRefs(doc, mapping) {
-    const rest = doc.service?.protocols?.rest;
-    const websocket = doc.service?.protocols?.websocket;
-    if (rest?.routes) {
-        for (const route of rest.routes) {
-            for (const params of [
-                route.pathParams,
-                route.queryParams,
-                route.headers,
-            ]) {
-                if (!params)
-                    continue;
-                for (const p of params) {
-                    if (!p.schemaRef)
-                        continue;
-                    const key = (0, utils_1.normalizeSchemaRef)(p.schemaRef);
-                    const next = mapping[key];
-                    if (next && next !== key)
-                        p.schemaRef = next;
-                }
-            }
-            const requestContent = route.requestBody?.content;
-            if (requestContent) {
-                for (const media of Object.values(requestContent)) {
-                    if (!media.schemaRef)
-                        continue;
-                    const key = (0, utils_1.normalizeSchemaRef)(media.schemaRef);
-                    const next = mapping[key];
-                    if (next && next !== key)
-                        media.schemaRef = next;
-                }
-            }
-            const responses = route.responses;
-            if (responses) {
-                for (const resp of Object.values(responses)) {
-                    const respContent = resp.content;
-                    if (!respContent)
-                        continue;
-                    for (const media of Object.values(respContent)) {
-                        if (!media.schemaRef)
-                            continue;
-                        const key = (0, utils_1.normalizeSchemaRef)(media.schemaRef);
-                        const next = mapping[key];
-                        if (next && next !== key)
-                            media.schemaRef = next;
-                    }
-                }
-            }
-        }
-    }
-    if (websocket?.channels) {
-        for (const channel of websocket.channels) {
-            if (!channel.messages)
-                continue;
-            for (const message of channel.messages) {
-                if (!message.schemaRef)
-                    continue;
-                const key = (0, utils_1.normalizeSchemaRef)(message.schemaRef);
-                const next = mapping[key];
-                if (next && next !== key)
-                    message.schemaRef = next;
-            }
-        }
-    }
-}
-/**
- * Remove duplicate schemas from a UniSpec document.
- * Duplicates are identified by identical JSON Schema content.
- * Updates all schema references to point to the retained schema.
- *
- * @param doc - The UniSpec document to deduplicate
- */
-function dedupeSchemas(doc) {
-    if (!doc?.service?.schemas || typeof doc.service.schemas !== "object")
-        return;
-    const schemas = doc.service.schemas;
-    const hashToName = new Map();
-    const toDelete = [];
-    // Find duplicates
-    for (const name of Object.keys(schemas)) {
-        const schema = schemas[name];
-        const hash = (0, utils_1.stableStringify)(schema?.jsonSchema ?? null);
-        const existing = hashToName.get(hash);
-        if (!existing) {
-            hashToName.set(hash, name);
-        }
-        else {
-            // Mark for deletion - keep the first one encountered
-            toDelete.push(name);
-        }
-    }
-    // Update references before deleting
-    if (toDelete.length > 0) {
-        const renameMap = {};
-        for (const dup of toDelete) {
-            const schema = schemas[dup];
-            const hash = (0, utils_1.stableStringify)(schema?.jsonSchema ?? null);
-            const existing = hashToName.get(hash);
-            if (existing) {
-                renameMap[dup] = existing;
-            }
-        }
-        updateSchemaRefs(doc, renameMap);
-        // Delete duplicates
-        for (const dup of toDelete) {
-            delete schemas[dup];
-        }
-    }
-}

package/dist/cjs/src/schemas/index.js

@@ -1,14 +0,0 @@
-"use strict";
-// Export utility functions
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stableStringify = exports.normalizeSchemaRef = exports.resolveSchemaRef = exports.registerSchema = exports.dedupeSchemas = void 0;
-// Export deduplication functions
-var dedupe_1 = require("./dedupe.js");
-Object.defineProperty(exports, "dedupeSchemas", { enumerable: true, get: function () { return dedupe_1.dedupeSchemas; } });
-// Export resolver functions
-var resolver_1 = require("./resolver.js");
-Object.defineProperty(exports, "registerSchema", { enumerable: true, get: function () { return resolver_1.registerSchema; } });
-Object.defineProperty(exports, "resolveSchemaRef", { enumerable: true, get: function () { return resolver_1.resolveSchemaRef; } });
-var utils_1 = require("./utils.js");
-Object.defineProperty(exports, "normalizeSchemaRef", { enumerable: true, get: function () { return utils_1.normalizeSchemaRef; } });
-Object.defineProperty(exports, "stableStringify", { enumerable: true, get: function () { return utils_1.stableStringify; } });

package/dist/cjs/src/schemas/resolver.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveSchemaRef = resolveSchemaRef;
-exports.registerSchema = registerSchema;
-const utils_1 = require("./utils.js");
-/**
- * Resolve a schema reference to its definition in a UniSpec document.
- *
- * @param doc - The UniSpec document containing schemas
- * @param ref - The schema reference to resolve
- * @returns The schema definition or undefined if not found
- */
-function resolveSchemaRef(doc, ref) {
-    if (!doc)
-        return undefined;
-    const name = (0, utils_1.normalizeSchemaRef)(ref);
-    if (!name)
-        return undefined;
-    return doc.service?.schemas?.[name];
-}
-/**
- * Register a new schema definition in a UniSpec document.
- * Creates the schemas container if it doesn't exist.
- *
- * @param doc - The UniSpec document to modify
- * @param name - The schema name
- * @param jsonSchema - The JSON Schema definition
- * @returns The created schema definition
- */
-function registerSchema(doc, name, jsonSchema) {
-    if (!doc.service) {
-        doc.service = { name: "" };
-    }
-    if (!doc.service.schemas) {
-        doc.service.schemas = {};
-    }
-    const definition = {
-        jsonSchema,
-    };
-    doc.service.schemas[name] = definition;
-    return definition;
-}

package/dist/cjs/src/schemas/utils.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeSchemaRef = normalizeSchemaRef;
-exports.stableStringify = stableStringify;
-/**
- * Normalize a schema reference to extract the schema name.
- * Supports multiple formats:
- * - Simple name: "User"
- * - JSON Pointer: "#/service/schemas/User"
- * - Hash format: "#User"
- * - Path format: "path/to/User"
- *
- * @param ref - The schema reference to normalize
- * @returns The normalized schema name
- */
-function normalizeSchemaRef(ref) {
-    const trimmed = ref.trim();
-    if (trimmed.length === 0)
-        return "";
-    // Handle JSON Pointer format: #/service/schemas/SchemaName
-    if (trimmed.startsWith("#/service/schemas/")) {
-        const parts = trimmed.split("/");
-        return parts[parts.length - 1];
-    }
-    // Handle simple name format: SchemaName
-    const withoutHash = trimmed.startsWith("#") ? trimmed.slice(1) : trimmed;
-    const parts = withoutHash.split("/").filter(Boolean);
-    return parts.length > 0 ? parts[parts.length - 1] : withoutHash;
-}
-/**
- * Create a stable string representation of a value for comparison.
- * Used for schema deduplication by creating consistent JSON strings.
- *
- * @param value - The value to stringify
- * @returns A stable JSON string representation
- */
-function stableStringify(value) {
-    if (value === null)
-        return "null";
-    const t = typeof value;
-    if (t === "number" || t === "boolean")
-        return JSON.stringify(value);
-    if (t === "string")
-        return JSON.stringify(value);
-    if (Array.isArray(value))
-        return `[${value.map(stableStringify).join(",")}]`;
-    if (t !== "object")
-        return JSON.stringify(value);
-    const obj = value;
-    const keys = Object.keys(obj).sort();
-    const entries = keys.map((k) => `${JSON.stringify(k)}:${stableStringify(obj[k])}`);
-    return `{${entries.join(",")}}`;
-}

package/dist/cjs/src/types/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });