@redocly/cli 2.28.1 → 2.29.0

package/lib/commands/score/collect-metrics.d.ts

@@ -0,0 +1,17 @@
+import { type normalizeTypes, type resolveDocument, type Document, type WalkContext } from '@redocly/openapi-core';
+import type { DebugMediaTypeLog, DocumentMetrics, ScoringConstants } from './types.js';
+export interface CollectMetricsOptions {
+    document: Document;
+    types: ReturnType<typeof normalizeTypes>;
+    resolvedRefMap: ReturnType<typeof resolveDocument> extends Promise<infer R> ? R : never;
+    ctx: WalkContext;
+    debugOperationId?: string;
+    /** When set, must match the constants passed into scoring for this run (e.g. anyOf penalty). */
+    scoringConstants?: ScoringConstants;
+}
+export interface CollectMetricsResult {
+    metrics: DocumentMetrics;
+    debugLogs: DebugMediaTypeLog[];
+}
+export declare function collectMetrics({ document, types, resolvedRefMap, ctx, debugOperationId, scoringConstants, }: CollectMetricsOptions): CollectMetricsResult;
+//# sourceMappingURL=collect-metrics.d.ts.map

package/lib/commands/score/collect-metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collect-metrics.d.ts","sourceRoot":"","sources":["../../../src/commands/score/collect-metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EAGnB,KAAK,eAAe,EAKpB,KAAK,QAAQ,EACb,KAAK,WAAW,EACjB,MAAM,uBAAuB,CAAC;AAW/B,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAe,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAWpG,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;IACzC,cAAc,EAAE,UAAU,CAAC,OAAO,eAAe,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACxF,GAAG,EAAE,WAAW,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gGAAgG;IAChG,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED,wBAAgB,cAAc,CAAC,EAC7B,QAAQ,EACR,KAAK,EACL,cAAc,EACd,GAAG,EACH,gBAAgB,EAChB,gBAAgB,GACjB,EAAE,qBAAqB,GAAG,oBAAoB,CAwN9C"}

package/lib/commands/score/collect-metrics.js

@@ -0,0 +1,195 @@
+import { normalizeVisitors, walkDocument, isPlainObject, isRef, isMappingRef, unescapePointerFragment, } from '@redocly/openapi-core';
+import { createScoreAccumulator, createScoreVisitor, createSchemaWalkState, resetSchemaWalkState, createSchemaMetricVisitor, getDocumentMetrics, } from './collectors/document-metrics.js';
+import { DEFAULT_SCORING_CONSTANTS } from './constants.js';
+function resolveJsonPointer(root, ref) {
+    if (!ref.startsWith('#/'))
+        return undefined;
+    let node = root;
+    for (const segment of ref.slice(2).split('/')) {
+        node = node?.[unescapePointerFragment(segment)];
+    }
+    return node;
+}
+export function collectMetrics({ document, types, resolvedRefMap, ctx, debugOperationId, scoringConstants, }) {
+    const anyOfPenaltyMultiplier = scoringConstants?.weights.anyOfPenaltyMultiplier ??
+        DEFAULT_SCORING_CONSTANTS.weights.anyOfPenaltyMultiplier;
+    const schemaWalkState = createSchemaWalkState();
+    const schemaVisitor = createSchemaMetricVisitor(schemaWalkState);
+    const normalizedSchemaVisitors = normalizeVisitors([{ severity: 'warn', ruleId: 'score-schema', visitor: schemaVisitor }], types);
+    const walkSchemaRaw = (schemaNode, debug) => {
+        resetSchemaWalkState(schemaWalkState);
+        if (debug)
+            schemaWalkState.debugEntries = [];
+        walkDocument({
+            document: { ...document, parsed: schemaNode },
+            rootType: types.Schema,
+            normalizedVisitors: normalizedSchemaVisitors,
+            resolvedRefMap,
+            ctx,
+        });
+        const { depth: _, pendingRef: __, debugEntries: _debug, ...stats } = schemaWalkState;
+        return {
+            ...stats,
+            refsUsed: [...schemaWalkState.refsUsed],
+            debugEntries: debug ? (schemaWalkState.debugEntries ?? undefined) : undefined,
+        };
+    };
+    const schemaCache = new Map();
+    const computing = new WeakSet();
+    const emptyStats = {
+        maxDepth: 0,
+        polymorphismCount: 0,
+        anyOfCount: 0,
+        hasDiscriminator: false,
+        totalSchemaProperties: 0,
+        schemaPropertiesWithDescription: 0,
+        constraintCount: 0,
+        hasPropertyExamples: false,
+        writableTopLevelFields: 0,
+        refsUsed: [],
+    };
+    function addStats(a, b) {
+        return {
+            maxDepth: Math.max(a.maxDepth, b.maxDepth),
+            polymorphismCount: a.polymorphismCount + b.polymorphismCount,
+            anyOfCount: a.anyOfCount + b.anyOfCount,
+            hasDiscriminator: a.hasDiscriminator || b.hasDiscriminator,
+            totalSchemaProperties: a.totalSchemaProperties + b.totalSchemaProperties,
+            schemaPropertiesWithDescription: a.schemaPropertiesWithDescription + b.schemaPropertiesWithDescription,
+            constraintCount: a.constraintCount + b.constraintCount,
+            hasPropertyExamples: a.hasPropertyExamples || b.hasPropertyExamples,
+            writableTopLevelFields: a.writableTopLevelFields + b.writableTopLevelFields,
+            refsUsed: [...a.refsUsed, ...b.refsUsed],
+            debugEntries: a.debugEntries || b.debugEntries
+                ? [...(a.debugEntries ?? []), ...(b.debugEntries ?? [])]
+                : undefined,
+        };
+    }
+    const walkSchema = (schemaNode, debug = false) => {
+        let resolved = schemaNode;
+        const ref = isRef(schemaNode) ? schemaNode.$ref : undefined;
+        if (ref) {
+            if (!debug) {
+                const cached = schemaCache.get(ref);
+                if (cached)
+                    return cached;
+            }
+            resolved = resolveJsonPointer(document.parsed, ref) ?? schemaNode;
+        }
+        if (isPlainObject(resolved) && computing.has(resolved)) {
+            return { ...emptyStats };
+        }
+        if (isPlainObject(resolved)) {
+            computing.add(resolved);
+        }
+        const oneOfBranches = resolved?.oneOf;
+        const anyOfBranches = resolved?.anyOf;
+        const hasOneOfPoly = Array.isArray(oneOfBranches) && oneOfBranches.length > 1;
+        const hasAnyOfPoly = Array.isArray(anyOfBranches) && anyOfBranches.length > 1;
+        /** True when we peel off multi-branch oneOf/anyOf for max-branch walks (may be both). */
+        const hasPolyComposition = hasOneOfPoly || hasAnyOfPoly;
+        const hasAllOf = Array.isArray(resolved?.allOf) && resolved.allOf.length > 0;
+        const disc = resolved?.discriminator;
+        const discriminatorRefs = !hasPolyComposition && isPlainObject(disc?.mapping)
+            ? Object.values(disc.mapping)
+                .filter((v) => typeof v === 'string' && isMappingRef(v))
+                .map((v) => ({ $ref: v }))
+            : null;
+        const hasDiscriminatorBranches = Array.isArray(discriminatorRefs) && discriminatorRefs.length > 0;
+        let result;
+        if (hasPolyComposition || hasAllOf || hasDiscriminatorBranches) {
+            const parentOnly = { ...resolved };
+            let polyStats = null;
+            const mergePolyPart = (part) => {
+                polyStats = polyStats ? addStats(polyStats, part) : part;
+            };
+            const maxBranchPolyStats = (polyKeyword, polyBranches) => {
+                let maxBranch = walkSchema(polyBranches[0], debug);
+                for (let i = 1; i < polyBranches.length; i++) {
+                    const branchStats = walkSchema(polyBranches[i], debug);
+                    if (branchStats.totalSchemaProperties > maxBranch.totalSchemaProperties) {
+                        maxBranch = branchStats;
+                    }
+                }
+                return {
+                    ...maxBranch,
+                    polymorphismCount: maxBranch.polymorphismCount + polyBranches.length,
+                    anyOfCount: maxBranch.anyOfCount + (polyKeyword === 'anyOf' ? polyBranches.length : 0),
+                    hasDiscriminator: maxBranch.hasDiscriminator || !!disc,
+                };
+            };
+            if (hasPolyComposition) {
+                delete parentOnly.discriminator;
+            }
+            if (hasOneOfPoly) {
+                delete parentOnly.oneOf;
+                mergePolyPart(maxBranchPolyStats('oneOf', oneOfBranches));
+            }
+            if (hasAnyOfPoly) {
+                delete parentOnly.anyOf;
+                mergePolyPart(maxBranchPolyStats('anyOf', anyOfBranches));
+            }
+            let discStats = null;
+            if (hasDiscriminatorBranches) {
+                delete parentOnly.discriminator;
+                let maxBranch = walkSchema(discriminatorRefs[0], debug);
+                for (let i = 1; i < discriminatorRefs.length; i++) {
+                    const branchStats = walkSchema(discriminatorRefs[i], debug);
+                    if (branchStats.totalSchemaProperties > maxBranch.totalSchemaProperties) {
+                        maxBranch = branchStats;
+                    }
+                }
+                discStats = {
+                    ...maxBranch,
+                    polymorphismCount: maxBranch.polymorphismCount + discriminatorRefs.length,
+                    hasDiscriminator: true,
+                };
+            }
+            let allOfStats = null;
+            if (hasAllOf) {
+                delete parentOnly.allOf;
+                allOfStats = { ...emptyStats };
+                for (const member of resolved.allOf) {
+                    allOfStats = addStats(allOfStats, walkSchema(member, debug));
+                }
+                allOfStats.polymorphismCount += resolved.allOf.length;
+            }
+            const parentStats = walkSchemaRaw(parentOnly, debug);
+            result = parentStats;
+            if (allOfStats)
+                result = addStats(result, allOfStats);
+            if (polyStats)
+                result = addStats(result, polyStats);
+            if (discStats)
+                result = addStats(result, discStats);
+            if (ref) {
+                result = { ...result, refsUsed: [ref, ...result.refsUsed] };
+            }
+        }
+        else {
+            result = walkSchemaRaw(schemaNode, debug);
+        }
+        if (isPlainObject(resolved)) {
+            computing.delete(resolved);
+        }
+        if (ref && !debug) {
+            schemaCache.set(ref, result);
+        }
+        return result;
+    };
+    const accumulator = createScoreAccumulator(walkSchema, anyOfPenaltyMultiplier, debugOperationId);
+    const scoreVisitor = createScoreVisitor(accumulator);
+    const normalizedVisitors = normalizeVisitors([{ severity: 'warn', ruleId: 'score', visitor: scoreVisitor }], types);
+    walkDocument({
+        document,
+        rootType: types.Root,
+        normalizedVisitors,
+        resolvedRefMap,
+        ctx,
+    });
+    return {
+        metrics: getDocumentMetrics(accumulator),
+        debugLogs: accumulator.debugLogs,
+    };
+}
+//# sourceMappingURL=collect-metrics.js.map

package/lib/commands/score/collect-metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collect-metrics.js","sourceRoot":"","sources":["../../../src/commands/score/collect-metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,EACjB,YAAY,EAEZ,aAAa,EACb,KAAK,EACL,YAAY,EACZ,uBAAuB,GAGxB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,kBAAkB,GACnB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAG3D,SAAS,kBAAkB,CAAC,IAAS,EAAE,GAAW;IAChD,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAC;IAC5C,IAAI,IAAI,GAAG,IAAI,CAAC;IAChB,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9C,IAAI,GAAG,IAAI,EAAE,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAiBD,MAAM,UAAU,cAAc,CAAC,EAC7B,QAAQ,EACR,KAAK,EACL,cAAc,EACd,GAAG,EACH,gBAAgB,EAChB,gBAAgB,GACM;IACtB,MAAM,sBAAsB,GAC1B,gBAAgB,EAAE,OAAO,CAAC,sBAAsB;QAChD,yBAAyB,CAAC,OAAO,CAAC,sBAAsB,CAAC;IAC3D,MAAM,eAAe,GAAG,qBAAqB,EAAE,CAAC;IAChD,MAAM,aAAa,GAAG,yBAAyB,CAAC,eAAe,CAAC,CAAC;IACjE,MAAM,wBAAwB,GAAG,iBAAiB,CAChD,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,EACtE,KAAK,CACN,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,UAAe,EAAE,KAAc,EAAe,EAAE;QACrE,oBAAoB,CAAC,eAAe,CAAC,CAAC;QACtC,IAAI,KAAK;YAAE,eAAe,CAAC,YAAY,GAAG,EAAE,CAAC;QAC7C,YAAY,CAAC;YACX,QAAQ,EAAE,EAAE,GAAG,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE;YAC7C,QAAQ,EAAE,KAAK,CAAC,MAAM;YACtB,kBAAkB,EAAE,wBAAwB;YAC5C,cAAc;YACd,GAAG;SACJ,CAAC,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,eAAe,CAAC;QACrF,OAAO;YACL,GAAG,KAAK;YACR,QAAQ,EAAE,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC;YACvC,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,YAAY,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;SAC9E,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,IAAI,GAAG,EAAuB,CAAC;IACnD,MAAM,SAAS,GAAG,IAAI,OAAO,EAAU,CAAC;IAExC,MAAM,UAAU,GAAgB;QAC9B,QAAQ,EAAE,CAAC;QACX,iBAAiB,EAAE,CAAC;QACpB,UAAU,EAAE,CAAC;QACb,gBAAgB,EAAE,KAAK;QACvB,qBAAqB,EAAE,CAAC;QACxB,+BAA+B,EAAE,CAAC;QAClC,eAAe,EAAE,CAAC;QAClB,mBAAmB,EAAE,KAAK;QAC1B,sBAAsB,EAAE,CAAC;QACzB,QAAQ,EAAE,EAAE;KACb,CAAC;IAEF,SAAS,QAAQ,CAAC,CAAc,EAAE,CAAc;QAC9C,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC;YAC1C,iBAAiB,EAAE,CAAC,CAAC,iBAAiB,GAAG,CAAC,CAAC,iBAAiB;YAC5D,UAAU,EAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU;YACvC,gBAAgB,EAAE,CAAC,CAAC,gBAAgB,IAAI,CAAC,CAAC,gBAAgB;YAC1D,qBAAqB,EAAE,CAAC,CAAC,qBAAqB,GAAG,CAAC,CAAC,qBAAqB;YACxE,+BAA+B,EAC7B,CAAC,CAAC,+BAA+B,GAAG,CAAC,CAAC,+BAA+B;YACvE,eAAe,EAAE,CAAC,CAAC,eAAe,GAAG,CAAC,CAAC,eAAe;YACtD,mBAAmB,EAAE,CAAC,CAAC,mBAAmB,IAAI,CAAC,CAAC,mBAAmB;YACnE,sBAAsB,EAAE,CAAC,CAAC,sBAAsB,GAAG,CAAC,CAAC,sBAAsB;YAC3E,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC;YACxC,YAAY,EACV,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,YAAY;gBAC9B,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;gBACxD,CAAC,CAAC,SAAS;SAChB,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAG,CAAC,UAAe,EAAE,KAAK,GAAG,KAAK,EAAe,EAAE;QACjE,IAAI,QAAQ,GAAG,UAAU,CAAC;QAC1B,MAAM,GAAG,GAAuB,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAEhF,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACpC,IAAI,MAAM;oBAAE,OAAO,MAAM,CAAC;YAC5B,CAAC;YACD,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,UAAU,CAAC;QACpE,CAAC;QAED,IAAI,aAAa,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvD,OAAO,EAAE,GAAG,UAAU,EAAE,CAAC;QAC3B,CAAC;QACD,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1B,CAAC;QAED,MAAM,aAAa,GAAG,QAAQ,EAAE,KAAK,CAAC;QACtC,MAAM,aAAa,GAAG,QAAQ,EAAE,KAAK,CAAC;QACtC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;QAC9E,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;QAC9E,yFAAyF;QACzF,MAAM,kBAAkB,GAAG,YAAY,IAAI,YAAY,CAAC;QAExD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;QAE7E,MAAM,IAAI,GAAG,QAAQ,EAAE,aAAa,CAAC;QACrC,MAAM,iBAAiB,GACrB,CAAC,kBAAkB,IAAI,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC;YACjD,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;iBACxB,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;iBACpE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;YAC9B,CAAC,CAAC,IAAI,CAAC;QACX,MAAM,wBAAwB,GAC5B,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;QAEnE,IAAI,MAAmB,CAAC;QAExB,IAAI,kBAAkB,IAAI,QAAQ,IAAI,wBAAwB,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;YAEnC,IAAI,SAAS,GAAuB,IAAI,CAAC;YAEzC,MAAM,aAAa,GAAG,CAAC,IAAiB,EAAE,EAAE;gBAC1C,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC3D,CAAC,CAAC;YAEF,MAAM,kBAAkB,GAAG,CACzB,WAA8B,EAC9B,YAAmB,EACN,EAAE;gBACf,IAAI,SAAS,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC7C,MAAM,WAAW,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;oBACvD,IAAI,WAAW,CAAC,qBAAqB,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC;wBACxE,SAAS,GAAG,WAAW,CAAC;oBAC1B,CAAC;gBACH,CAAC;gBACD,OAAO;oBACL,GAAG,SAAS;oBACZ,iBAAiB,EAAE,SAAS,CAAC,iBAAiB,GAAG,YAAY,CAAC,MAAM;oBACpE,UAAU,EAAE,SAAS,CAAC,UAAU,GAAG,CAAC,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;oBACtF,gBAAgB,EAAE,SAAS,CAAC,gBAAgB,IAAI,CAAC,CAAC,IAAI;iBACvD,CAAC;YACJ,CAAC,CAAC;YAEF,IAAI,kBAAkB,EAAE,CAAC;gBACvB,OAAO,UAAU,CAAC,aAAa,CAAC;YAClC,CAAC;YACD,IAAI,YAAY,EAAE,CAAC;gBACjB,OAAO,UAAU,CAAC,KAAK,CAAC;gBACxB,aAAa,CAAC,kBAAkB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,YAAY,EAAE,CAAC;gBACjB,OAAO,UAAU,CAAC,KAAK,CAAC;gBACxB,aAAa,CAAC,kBAAkB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;YAC5D,CAAC;YAED,IAAI,SAAS,GAAuB,IAAI,CAAC;YACzC,IAAI,wBAAwB,EAAE,CAAC;gBAC7B,OAAO,UAAU,CAAC,aAAa,CAAC;gBAEhC,IAAI,SAAS,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACxD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBAClD,MAAM,WAAW,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;oBAC5D,IAAI,WAAW,CAAC,qBAAqB,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC;wBACxE,SAAS,GAAG,WAAW,CAAC;oBAC1B,CAAC;gBACH,CAAC;gBACD,SAAS,GAAG;oBACV,GAAG,SAAS;oBACZ,iBAAiB,EAAE,SAAS,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,MAAM;oBACzE,gBAAgB,EAAE,IAAI;iBACvB,CAAC;YACJ,CAAC;YAED,IAAI,UAAU,GAAuB,IAAI,CAAC;YAC1C,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,UAAU,CAAC,KAAK,CAAC;gBACxB,UAAU,GAAG,EAAE,GAAG,UAAU,EAAE,CAAC;gBAC/B,KAAK,MAAM,MAAM,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;oBACpC,UAAU,GAAG,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;gBAC/D,CAAC;gBACD,UAAU,CAAC,iBAAiB,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;YACxD,CAAC;YAED,MAAM,WAAW,GAAG,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YACrD,MAAM,GAAG,WAAW,CAAC;YACrB,IAAI,UAAU;gBAAE,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACtD,IAAI,SAAS;gBAAE,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YACpD,IAAI,SAAS;gBAAE,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAEpD,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;YAClB,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC/B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,sBAAsB,CAAC,UAAU,EAAE,sBAAsB,EAAE,gBAAgB,CAAC,CAAC;IACjG,MAAM,YAAY,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAErD,MAAM,kBAAkB,GAAG,iBAAiB,CAC1C,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,EAC9D,KAAK,CACN,CAAC;IAEF,YAAY,CAAC;QACX,QAAQ;QACR,QAAQ,EAAE,KAAK,CAAC,IAAI;QACpB,kBAAkB;QAClB,cAAc;QACd,GAAG;KACJ,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,kBAAkB,CAAC,WAAW,CAAC;QACxC,SAAS,EAAE,WAAW,CAAC,SAAS;KACjC,CAAC;AACJ,CAAC"}

package/lib/commands/score/collectors/dependency-graph.d.ts

@@ -0,0 +1,9 @@
+import type { OperationMetrics } from '../types.js';
+/**
+ * Builds a dependency graph from shared $ref usage across operations.
+ * An edge from A to B means both A and B reference the same schema $ref.
+ * The depth for each operation is the longest path from a root node (no incoming edges)
+ * in the undirected "shared ref" graph.
+ */
+export declare function computeDependencyDepths(operations: Map<string, OperationMetrics>): Map<string, number>;
+//# sourceMappingURL=dependency-graph.d.ts.map

package/lib/commands/score/collectors/dependency-graph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependency-graph.d.ts","sourceRoot":"","sources":["../../../../src/commands/score/collectors/dependency-graph.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,GACxC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAsCrB"}

package/lib/commands/score/collectors/dependency-graph.js

@@ -0,0 +1,61 @@
+/**
+ * Builds a dependency graph from shared $ref usage across operations.
+ * An edge from A to B means both A and B reference the same schema $ref.
+ * The depth for each operation is the longest path from a root node (no incoming edges)
+ * in the undirected "shared ref" graph.
+ */
+export function computeDependencyDepths(operations) {
+    const refToOps = new Map();
+    for (const [opKey, metrics] of operations) {
+        for (const ref of metrics.refsUsed) {
+            let ops = refToOps.get(ref);
+            if (!ops) {
+                ops = new Set();
+                refToOps.set(ref, ops);
+            }
+            ops.add(opKey);
+        }
+    }
+    const adjacency = new Map();
+    for (const opKey of operations.keys()) {
+        adjacency.set(opKey, new Set());
+    }
+    for (const ops of refToOps.values()) {
+        if (ops.size < 2)
+            continue;
+        const opArray = Array.from(ops);
+        for (let i = 0; i < opArray.length; i++) {
+            for (let j = i + 1; j < opArray.length; j++) {
+                adjacency.get(opArray[i]).add(opArray[j]);
+                adjacency.get(opArray[j]).add(opArray[i]);
+            }
+        }
+    }
+    const depths = new Map();
+    for (const opKey of operations.keys()) {
+        const depth = computeLongestBfsPath(opKey, adjacency);
+        depths.set(opKey, depth);
+    }
+    return depths;
+}
+function computeLongestBfsPath(start, adjacency) {
+    const visited = new Set([start]);
+    let queue = [start];
+    let depth = 0;
+    while (queue.length > 0) {
+        const next = [];
+        for (const node of queue) {
+            for (const neighbor of adjacency.get(node) ?? []) {
+                if (!visited.has(neighbor)) {
+                    visited.add(neighbor);
+                    next.push(neighbor);
+                }
+            }
+        }
+        if (next.length > 0)
+            depth++;
+        queue = next;
+    }
+    return depth;
+}
+//# sourceMappingURL=dependency-graph.js.map

package/lib/commands/score/collectors/dependency-graph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependency-graph.js","sourceRoot":"","sources":["../../../../src/commands/score/collectors/dependency-graph.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAAyC;IAEzC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAuB,CAAC;IAEhD,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,UAAU,EAAE,CAAC;QAC1C,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;gBAChB,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACzB,CAAC;YACD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,GAAG,EAAuB,CAAC;IACjD,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;QACtC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;QACpC,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC;YAAE,SAAS;QAC3B,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5C,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC3C,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEzC,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,qBAAqB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACtD,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAa,EAAE,SAAmC;IAC/E,MAAM,OAAO,GAAG,IAAI,GAAG,CAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACzC,IAAI,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBACjD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC3B,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,KAAK,EAAE,CAAC;QAC7B,KAAK,GAAG,IAAI,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/lib/commands/score/collectors/document-metrics.d.ts

@@ -0,0 +1,69 @@
+import { type Oas3Visitor, type Oas3Parameter, type Oas3Schema, type Oas3_1Schema, type Referenced } from '@redocly/openapi-core';
+import type { DebugMediaTypeLog, DebugSchemaEntry, DocumentMetrics, OperationMetrics, SchemaStats } from '../types.js';
+type Schema = Oas3Schema | Oas3_1Schema;
+type Param = Oas3Parameter<Schema>;
+export interface SchemaWalkState {
+    depth: number;
+    maxDepth: number;
+    polymorphismCount: number;
+    anyOfCount: number;
+    hasDiscriminator: boolean;
+    totalSchemaProperties: number;
+    schemaPropertiesWithDescription: number;
+    constraintCount: number;
+    hasPropertyExamples: boolean;
+    writableTopLevelFields: number;
+    refsUsed: string[];
+    debugEntries: DebugSchemaEntry[] | null;
+    pendingRef: string | null;
+}
+export declare function createSchemaWalkState(): SchemaWalkState;
+export declare function resetSchemaWalkState(s: SchemaWalkState): void;
+export declare function createSchemaMetricVisitor(state: SchemaWalkState): Oas3Visitor;
+interface CurrentOperationContext {
+    path: string;
+    method: string;
+    operationId?: string;
+    operationDescriptionPresent: boolean;
+    parameterCount: number;
+    requiredParameterCount: number;
+    paramsWithDescription: number;
+    ambiguousIdentifierCount: number;
+    maxRequestSchemaDepth: number;
+    maxResponseSchemaDepth: number;
+    totalSchemaProperties: number;
+    schemaPropertiesWithDescription: number;
+    constraintCount: number;
+    polymorphismCount: number;
+    anyOfCount: number;
+    hasDiscriminator: boolean;
+    topLevelWritableFieldCount: number;
+    requestBodyPresent: boolean;
+    requestExamplePresent: boolean;
+    responseExamplePresent: boolean;
+    structuredErrorResponseCount: number;
+    totalErrorResponses: number;
+    inRequestBody: boolean;
+    inResponse: boolean;
+    currentResponseCode: string;
+    errorStructuredCounted: boolean;
+    /** Internal: best schema walk for polymorphism + anyOf (see `effectivePolymorphismFromCounts`). */
+    maxEffectivePolymorphism: number;
+    refsUsed: Set<string>;
+}
+export interface ScoreAccumulator {
+    operations: Map<string, OperationMetrics>;
+    currentPath: string;
+    pathLevelParams: Array<Referenced<Param>>;
+    current: CurrentOperationContext | null;
+    walkSchema: (schema: any, debug?: boolean) => SchemaStats;
+    /** Must match scoring `weights.anyOfPenaltyMultiplier` for this run. */
+    anyOfPenaltyMultiplier: number;
+    debugOperationId?: string;
+    debugLogs: DebugMediaTypeLog[];
+}
+export declare function createScoreAccumulator(walkSchema: (schema: any, debug?: boolean) => SchemaStats, anyOfPenaltyMultiplier: number, debugOperationId?: string): ScoreAccumulator;
+export declare function createScoreVisitor(accumulator: ScoreAccumulator): Oas3Visitor;
+export declare function getDocumentMetrics(accumulator: ScoreAccumulator): DocumentMetrics;
+export {};
+//# sourceMappingURL=document-metrics.d.ts.map

package/lib/commands/score/collectors/document-metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-metrics.d.ts","sourceRoot":"","sources":["../../../../src/commands/score/collectors/document-metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,WAAW,EAIhB,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,UAAU,EAChB,MAAM,uBAAuB,CAAC;AAI/B,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,WAAW,EACZ,MAAM,aAAa,CAAC;AAErB,KAAK,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC;AACxC,KAAK,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAoDnC,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,+BAA+B,EAAE,MAAM,CAAC;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;IACxC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,wBAAgB,qBAAqB,IAAI,eAAe,CAiBvD;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,eAAe,GAAG,IAAI,CAE7D;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,eAAe,GAAG,WAAW,CAkE7E;AAED,UAAU,uBAAuB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2BAA2B,EAAE,OAAO,CAAC;IAErC,cAAc,EAAE,MAAM,CAAC;IACvB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,wBAAwB,EAAE,MAAM,CAAC;IAEjC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,+BAA+B,EAAE,MAAM,CAAC;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;IAE1B,0BAA0B,EAAE,MAAM,CAAC;IAEnC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,sBAAsB,EAAE,OAAO,CAAC;IAChC,4BAA4B,EAAE,MAAM,CAAC;IACrC,mBAAmB,EAAE,MAAM,CAAC;IAE5B,aAAa,EAAE,OAAO,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,sBAAsB,EAAE,OAAO,CAAC;IAEhC,mGAAmG;IACnG,wBAAwB,EAAE,MAAM,CAAC;IAEjC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC1C,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAAC;IACxC,UAAU,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,OAAO,KAAK,WAAW,CAAC;IAC1D,wEAAwE;IACxE,sBAAsB,EAAE,MAAM,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,OAAO,KAAK,WAAW,EACzD,sBAAsB,EAAE,MAAM,EAC9B,gBAAgB,CAAC,EAAE,MAAM,GACxB,gBAAgB,CAWlB;AA0DD,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,gBAAgB,GAAG,WAAW,CA0J7E;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,gBAAgB,GAAG,eAAe,CAEjF"}