@redocly/cli 2.28.0 → 2.29.0

package/lib/commands/score/collectors/document-metrics.js

@@ -0,0 +1,343 @@
+import { isNotEmptyObject, isPlainObject, } from '@redocly/openapi-core';
+import { AMBIGUOUS_PARAM_NAMES } from '../constants.js';
+import { effectivePolymorphismFromCounts } from '../scoring.js';
+/** When two media types have the same property count, pick the triple with stronger doc + constraint signal. */
+function propertyMetricsBundleScore(totalSchemaProperties, schemaPropertiesWithDescription, constraintCount) {
+    const p = Math.max(1, totalSchemaProperties);
+    return schemaPropertiesWithDescription / p + constraintCount / p;
+}
+function shouldReplacePropertyMetrics(current, stats) {
+    if (stats.totalSchemaProperties > current.totalSchemaProperties)
+        return true;
+    if (stats.totalSchemaProperties < current.totalSchemaProperties)
+        return false;
+    return (propertyMetricsBundleScore(stats.totalSchemaProperties, stats.schemaPropertiesWithDescription, stats.constraintCount) >
+        propertyMetricsBundleScore(current.totalSchemaProperties, current.schemaPropertiesWithDescription, current.constraintCount));
+}
+const CONSTRAINT_KEYS = [
+    'enum',
+    'const',
+    'format',
+    'pattern',
+    'minimum',
+    'maximum',
+    'minLength',
+    'maxLength',
+    'minItems',
+    'maxItems',
+    'minProperties',
+    'maxProperties',
+    'multipleOf',
+    'exclusiveMinimum',
+    'exclusiveMaximum',
+    'uniqueItems',
+];
+export function createSchemaWalkState() {
+    return {
+        depth: -1, // starts at -1 because the root Schema.enter increments to 0
+        maxDepth: 0,
+        polymorphismCount: 0,
+        anyOfCount: 0,
+        hasDiscriminator: false,
+        totalSchemaProperties: 0,
+        schemaPropertiesWithDescription: 0,
+        constraintCount: 0,
+        hasPropertyExamples: false,
+        writableTopLevelFields: 0,
+        refsUsed: [],
+        debugEntries: null,
+        pendingRef: null,
+    };
+}
+export function resetSchemaWalkState(s) {
+    Object.assign(s, createSchemaWalkState());
+}
+export function createSchemaMetricVisitor(state) {
+    return {
+        ref: {
+            enter(ref) {
+                if (typeof ref?.$ref === 'string') {
+                    state.refsUsed.push(ref.$ref);
+                    state.pendingRef = ref.$ref;
+                }
+            },
+        },
+        Schema: {
+            enter(schema, ctx) {
+                state.depth++;
+                state.maxDepth = Math.max(state.maxDepth, state.depth);
+                let localConstraints = 0;
+                for (const key of CONSTRAINT_KEYS) {
+                    if (schema[key] !== undefined) {
+                        state.constraintCount++;
+                        localConstraints++;
+                    }
+                }
+                if (schema.discriminator?.propertyName)
+                    state.hasDiscriminator = true;
+                const localPoly = {};
+                for (const keyword of ['oneOf', 'anyOf', 'allOf']) {
+                    const list = schema[keyword];
+                    if (!Array.isArray(list))
+                        continue;
+                    state.polymorphismCount += list.length;
+                    if (keyword === 'anyOf')
+                        state.anyOfCount += list.length;
+                    localPoly[keyword] = list.length;
+                }
+                const localPropertyNames = [];
+                if (isPlainObject(schema.properties)) {
+                    const props = Object.entries(schema.properties);
+                    state.totalSchemaProperties += props.length;
+                    for (const [name, prop] of props) {
+                        localPropertyNames.push(name);
+                        const res = prop && '$ref' in prop && prop.$ref ? (ctx.resolve(prop)?.node ?? prop) : prop;
+                        if (res?.description)
+                            state.schemaPropertiesWithDescription++;
+                        if (res?.example !== undefined || res?.examples)
+                            state.hasPropertyExamples = true;
+                        if (!res?.readOnly)
+                            state.writableTopLevelFields++;
+                    }
+                }
+                if (state.debugEntries !== null) {
+                    state.debugEntries.push({
+                        ref: state.pendingRef,
+                        depth: state.depth,
+                        propertyNames: localPropertyNames,
+                        polymorphism: Object.keys(localPoly).length > 0 ? localPoly : {},
+                        constraintCount: localConstraints,
+                    });
+                }
+                state.pendingRef = null;
+            },
+            leave() {
+                state.depth--;
+            },
+        },
+    };
+}
+export function createScoreAccumulator(walkSchema, anyOfPenaltyMultiplier, debugOperationId) {
+    return {
+        operations: new Map(),
+        currentPath: '',
+        pathLevelParams: [],
+        current: null,
+        walkSchema,
+        anyOfPenaltyMultiplier,
+        debugOperationId,
+        debugLogs: [],
+    };
+}
+function createOperationContext(path, method, operation) {
+    return {
+        path,
+        method,
+        operationId: operation.operationId,
+        operationDescriptionPresent: !!operation.description,
+        parameterCount: 0,
+        requiredParameterCount: 0,
+        paramsWithDescription: 0,
+        ambiguousIdentifierCount: 0,
+        maxRequestSchemaDepth: 0,
+        maxResponseSchemaDepth: 0,
+        totalSchemaProperties: 0,
+        schemaPropertiesWithDescription: 0,
+        constraintCount: 0,
+        polymorphismCount: 0,
+        anyOfCount: 0,
+        hasDiscriminator: false,
+        topLevelWritableFieldCount: 0,
+        requestBodyPresent: false,
+        requestExamplePresent: false,
+        responseExamplePresent: false,
+        structuredErrorResponseCount: 0,
+        totalErrorResponses: 0,
+        inRequestBody: false,
+        inResponse: false,
+        currentResponseCode: '',
+        errorStructuredCounted: false,
+        maxEffectivePolymorphism: -1,
+        refsUsed: new Set(),
+    };
+}
+function buildOperationMetrics(ctx) {
+    const { inRequestBody: _1, inResponse: _2, currentResponseCode: _3, errorStructuredCounted: _4, maxEffectivePolymorphism: _5, ...metrics } = ctx;
+    return metrics;
+}
+export function createScoreVisitor(accumulator) {
+    return {
+        RequestBody: {
+            enter() {
+                if (!accumulator.current)
+                    return;
+                accumulator.current.requestBodyPresent = true;
+                accumulator.current.inRequestBody = true;
+            },
+            leave() {
+                if (accumulator.current)
+                    accumulator.current.inRequestBody = false;
+            },
+        },
+        Response: {
+            enter(response, ctx) {
+                const current = accumulator.current;
+                if (!current)
+                    return;
+                const code = String(ctx.key);
+                current.inResponse = true;
+                current.currentResponseCode = code;
+                current.errorStructuredCounted = false;
+                if (isErrorCode(code)) {
+                    current.totalErrorResponses++;
+                    if (!response.content && response.description) {
+                        current.structuredErrorResponseCount++;
+                        current.errorStructuredCounted = true;
+                    }
+                }
+            },
+            leave() {
+                if (accumulator.current)
+                    accumulator.current.inResponse = false;
+            },
+        },
+        MediaType: {
+            enter(mediaType) {
+                const current = accumulator.current;
+                if (!current)
+                    return;
+                if (hasExample(mediaType)) {
+                    if (current.inRequestBody)
+                        current.requestExamplePresent = true;
+                    if (current.inResponse)
+                        current.responseExamplePresent = true;
+                }
+                if (current.inResponse &&
+                    isErrorCode(current.currentResponseCode) &&
+                    !current.errorStructuredCounted) {
+                    current.structuredErrorResponseCount++;
+                    current.errorStructuredCounted = true;
+                }
+                if (mediaType.schema) {
+                    const isDebugTarget = !!accumulator.debugOperationId &&
+                        (current.operationId === accumulator.debugOperationId ||
+                            `${current.method.toUpperCase()} ${current.path}` === accumulator.debugOperationId);
+                    const stats = accumulator.walkSchema(mediaType.schema, isDebugTarget);
+                    if (shouldReplacePropertyMetrics(current, stats)) {
+                        current.totalSchemaProperties = stats.totalSchemaProperties;
+                        current.schemaPropertiesWithDescription = stats.schemaPropertiesWithDescription;
+                        current.constraintCount = stats.constraintCount;
+                    }
+                    const effective = effectivePolymorphismFromCounts(stats.polymorphismCount, stats.anyOfCount, accumulator.anyOfPenaltyMultiplier);
+                    if (effective > current.maxEffectivePolymorphism) {
+                        current.maxEffectivePolymorphism = effective;
+                        current.polymorphismCount = stats.polymorphismCount;
+                        current.anyOfCount = stats.anyOfCount;
+                    }
+                    if (stats.hasDiscriminator)
+                        current.hasDiscriminator = true;
+                    for (const ref of stats.refsUsed)
+                        current.refsUsed.add(ref);
+                    if (stats.hasPropertyExamples) {
+                        if (current.inRequestBody)
+                            current.requestExamplePresent = true;
+                        if (current.inResponse)
+                            current.responseExamplePresent = true;
+                    }
+                    if (current.inRequestBody) {
+                        current.maxRequestSchemaDepth = Math.max(current.maxRequestSchemaDepth, stats.maxDepth);
+                        current.topLevelWritableFieldCount = Math.max(current.topLevelWritableFieldCount, stats.writableTopLevelFields);
+                    }
+                    if (current.inResponse) {
+                        current.maxResponseSchemaDepth = Math.max(current.maxResponseSchemaDepth, stats.maxDepth);
+                    }
+                    if (isDebugTarget && stats.debugEntries) {
+                        const context = current.inRequestBody
+                            ? 'REQUEST BODY'
+                            : `RESPONSE ${current.currentResponseCode}`;
+                        accumulator.debugLogs.push({
+                            context,
+                            entries: stats.debugEntries,
+                            totalProperties: stats.totalSchemaProperties,
+                            totalPolymorphism: stats.polymorphismCount,
+                            totalConstraints: stats.constraintCount,
+                            maxDepth: stats.maxDepth,
+                        });
+                    }
+                }
+            },
+        },
+        Paths: {
+            PathItem: {
+                enter(pathItem, ctx) {
+                    accumulator.currentPath = String(ctx.key);
+                    accumulator.pathLevelParams = pathItem.parameters ?? [];
+                },
+                Operation: {
+                    enter(operation, ctx) {
+                        const method = String(ctx.key);
+                        const current = createOperationContext(accumulator.currentPath, method, operation);
+                        accumulator.current = current;
+                        const merged = mergeParameters(accumulator.pathLevelParams, operation.parameters ?? [], ctx.resolve);
+                        for (const param of merged.values()) {
+                            current.parameterCount++;
+                            if (param.required)
+                                current.requiredParameterCount++;
+                            if (param.description)
+                                current.paramsWithDescription++;
+                            if (isAmbiguousParam(param))
+                                current.ambiguousIdentifierCount++;
+                        }
+                    },
+                    leave(operation) {
+                        const current = accumulator.current;
+                        if (!current)
+                            return;
+                        const opKey = operation.operationId ?? `${current.method.toUpperCase()} ${current.path}`;
+                        accumulator.operations.set(opKey, buildOperationMetrics(current));
+                        accumulator.current = null;
+                    },
+                },
+            },
+        },
+    };
+}
+export function getDocumentMetrics(accumulator) {
+    return { operationCount: accumulator.operations.size, operations: accumulator.operations };
+}
+function resolveParam(raw, resolve) {
+    return resolve(raw).node;
+}
+function mergeParameters(pathLevel, opLevel, resolve) {
+    const merged = new Map();
+    for (const raw of pathLevel) {
+        const p = resolveParam(raw, resolve);
+        if (p?.name && p.in)
+            merged.set(`${p.in}:${p.name}`, p);
+    }
+    for (const raw of opLevel) {
+        const p = resolveParam(raw, resolve);
+        if (p?.name && p.in)
+            merged.set(`${p.in}:${p.name}`, p);
+    }
+    return merged;
+}
+function hasExample(mediaType) {
+    return mediaType.example !== undefined || isNotEmptyObject(mediaType.examples);
+}
+function isAmbiguousParam(param) {
+    if (param.description)
+        return false;
+    const name = (param.name ?? '').toLowerCase();
+    return AMBIGUOUS_PARAM_NAMES.has(name);
+}
+function isErrorCode(code) {
+    if (code === 'default')
+        return true;
+    // OpenAPI 3.1: status ranges 4XX / 5XX (see https://spec.openapis.org/oas/v3.1.0#patterned-fields)
+    if (/^4xx$/i.test(code) || /^5xx$/i.test(code))
+        return true;
+    const num = parseInt(code, 10);
+    return num >= 400 && num < 600;
+}
+//# sourceMappingURL=document-metrics.js.map

package/lib/commands/score/collectors/document-metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-metrics.js","sourceRoot":"","sources":["../../../../src/commands/score/collectors/document-metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,aAAa,GAUd,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,+BAA+B,EAAE,MAAM,eAAe,CAAC;AAahE,gHAAgH;AAChH,SAAS,0BAA0B,CACjC,qBAA6B,EAC7B,+BAAuC,EACvC,eAAuB;IAEvB,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC;IAC7C,OAAO,+BAA+B,GAAG,CAAC,GAAG,eAAe,GAAG,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,4BAA4B,CACnC,OAAgC,EAChC,KAAkB;IAElB,IAAI,KAAK,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB;QAAE,OAAO,IAAI,CAAC;IAC7E,IAAI,KAAK,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB;QAAE,OAAO,KAAK,CAAC;IAC9E,OAAO,CACL,0BAA0B,CACxB,KAAK,CAAC,qBAAqB,EAC3B,KAAK,CAAC,+BAA+B,EACrC,KAAK,CAAC,eAAe,CACtB;QACD,0BAA0B,CACxB,OAAO,CAAC,qBAAqB,EAC7B,OAAO,CAAC,+BAA+B,EACvC,OAAO,CAAC,eAAe,CACxB,CACF,CAAC;AACJ,CAAC;AAED,MAAM,eAAe,GAAsB;IACzC,MAAM;IACN,OAAO;IACP,QAAQ;IACR,SAAS;IACT,SAAS;IACT,SAAS;IACT,WAAW;IACX,WAAW;IACX,UAAU;IACV,UAAU;IACV,eAAe;IACf,eAAe;IACf,YAAY;IACZ,kBAAkB;IAClB,kBAAkB;IAClB,aAAa;CACd,CAAC;AAkBF,MAAM,UAAU,qBAAqB;IACnC,OAAO;QACL,KAAK,EAAE,CAAC,CAAC,EAAE,6DAA6D;QAExE,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;QACZ,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,IAAI;KACjB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,CAAkB;IACrD,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,qBAAqB,EAAE,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAsB;IAC9D,OAAO;QACL,GAAG,EAAE;YACH,KAAK,CAAC,GAAqB;gBACzB,IAAI,OAAO,GAAG,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAClC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBAC9B,KAAK,CAAC,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC;gBAC9B,CAAC;YACH,CAAC;SACF;QACD,MAAM,EAAE;YACN,KAAK,CAAC,MAAW,EAAE,GAAgB;gBACjC,KAAK,CAAC,KAAK,EAAE,CAAC;gBACd,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;gBAEvD,IAAI,gBAAgB,GAAG,CAAC,CAAC;gBACzB,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;oBAClC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;wBAC9B,KAAK,CAAC,eAAe,EAAE,CAAC;wBACxB,gBAAgB,EAAE,CAAC;oBACrB,CAAC;gBACH,CAAC;gBAED,IAAI,MAAM,CAAC,aAAa,EAAE,YAAY;oBAAE,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC;gBAEtE,MAAM,SAAS,GAAuD,EAAE,CAAC;gBACzE,KAAK,MAAM,OAAO,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAU,EAAE,CAAC;oBAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;oBAC7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;wBAAE,SAAS;oBACnC,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,MAAM,CAAC;oBACvC,IAAI,OAAO,KAAK,OAAO;wBAAE,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC;oBACzD,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;gBACnC,CAAC;gBAED,MAAM,kBAAkB,GAAa,EAAE,CAAC;gBACxC,IAAI,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;oBACrC,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAoB,CAAC;oBACnE,KAAK,CAAC,qBAAqB,IAAI,KAAK,CAAC,MAAM,CAAC;oBAE5C,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC;wBACjC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAC9B,MAAM,GAAG,GACP,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;wBACjF,IAAI,GAAG,EAAE,WAAW;4BAAE,KAAK,CAAC,+BAA+B,EAAE,CAAC;wBAC9D,IAAI,GAAG,EAAE,OAAO,KAAK,SAAS,IAAI,GAAG,EAAE,QAAQ;4BAAE,KAAK,CAAC,mBAAmB,GAAG,IAAI,CAAC;wBAClF,IAAI,CAAC,GAAG,EAAE,QAAQ;4BAAE,KAAK,CAAC,sBAAsB,EAAE,CAAC;oBACrD,CAAC;gBACH,CAAC;gBAED,IAAI,KAAK,CAAC,YAAY,KAAK,IAAI,EAAE,CAAC;oBAChC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC;wBACtB,GAAG,EAAE,KAAK,CAAC,UAAU;wBACrB,KAAK,EAAE,KAAK,CAAC,KAAK;wBAClB,aAAa,EAAE,kBAAkB;wBACjC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;wBAChE,eAAe,EAAE,gBAAgB;qBAClC,CAAC,CAAC;gBACL,CAAC;gBAED,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;YAC1B,CAAC;YACD,KAAK;gBACH,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,CAAC;SACF;KACF,CAAC;AACJ,CAAC;AAqDD,MAAM,UAAU,sBAAsB,CACpC,UAAyD,EACzD,sBAA8B,EAC9B,gBAAyB;IAEzB,OAAO;QACL,UAAU,EAAE,IAAI,GAAG,EAAE;QACrB,WAAW,EAAE,EAAE;QACf,eAAe,EAAE,EAAE;QACnB,OAAO,EAAE,IAAI;QACb,UAAU;QACV,sBAAsB;QACtB,gBAAgB;QAChB,SAAS,EAAE,EAAE;KACd,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAC7B,IAAY,EACZ,MAAc,EACd,SAAwB;IAExB,OAAO;QACL,IAAI;QACJ,MAAM;QACN,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,2BAA2B,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW;QAEpD,cAAc,EAAE,CAAC;QACjB,sBAAsB,EAAE,CAAC;QACzB,qBAAqB,EAAE,CAAC;QACxB,wBAAwB,EAAE,CAAC;QAE3B,qBAAqB,EAAE,CAAC;QACxB,sBAAsB,EAAE,CAAC;QACzB,qBAAqB,EAAE,CAAC;QACxB,+BAA+B,EAAE,CAAC;QAClC,eAAe,EAAE,CAAC;QAClB,iBAAiB,EAAE,CAAC;QACpB,UAAU,EAAE,CAAC;QACb,gBAAgB,EAAE,KAAK;QAEvB,0BAA0B,EAAE,CAAC;QAE7B,kBAAkB,EAAE,KAAK;QACzB,qBAAqB,EAAE,KAAK;QAC5B,sBAAsB,EAAE,KAAK;QAC7B,4BAA4B,EAAE,CAAC;QAC/B,mBAAmB,EAAE,CAAC;QAEtB,aAAa,EAAE,KAAK;QACpB,UAAU,EAAE,KAAK;QACjB,mBAAmB,EAAE,EAAE;QACvB,sBAAsB,EAAE,KAAK;QAE7B,wBAAwB,EAAE,CAAC,CAAC;QAE5B,QAAQ,EAAE,IAAI,GAAG,EAAE;KACpB,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,GAA4B;IACzD,MAAM,EACJ,aAAa,EAAE,EAAE,EACjB,UAAU,EAAE,EAAE,EACd,mBAAmB,EAAE,EAAE,EACvB,sBAAsB,EAAE,EAAE,EAC1B,wBAAwB,EAAE,EAAE,EAC5B,GAAG,OAAO,EACX,GAAG,GAAG,CAAC;IACR,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,WAA6B;IAC9D,OAAO;QACL,WAAW,EAAE;YACX,KAAK;gBACH,IAAI,CAAC,WAAW,CAAC,OAAO;oBAAE,OAAO;gBACjC,WAAW,CAAC,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;gBAC9C,WAAW,CAAC,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;YAC3C,CAAC;YACD,KAAK;gBACH,IAAI,WAAW,CAAC,OAAO;oBAAE,WAAW,CAAC,OAAO,CAAC,aAAa,GAAG,KAAK,CAAC;YACrE,CAAC;SACF;QACD,QAAQ,EAAE;YACR,KAAK,CACH,QAAqE,EACrE,GAAgB;gBAEhB,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;gBACpC,IAAI,CAAC,OAAO;oBAAE,OAAO;gBACrB,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC7B,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;gBAC1B,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;gBACnC,OAAO,CAAC,sBAAsB,GAAG,KAAK,CAAC;gBAEvC,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtB,OAAO,CAAC,mBAAmB,EAAE,CAAC;oBAC9B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;wBAC9C,OAAO,CAAC,4BAA4B,EAAE,CAAC;wBACvC,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC;oBACxC,CAAC;gBACH,CAAC;YACH,CAAC;YACD,KAAK;gBACH,IAAI,WAAW,CAAC,OAAO;oBAAE,WAAW,CAAC,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC;YAClE,CAAC;SACF;QACD,SAAS,EAAE;YACT,KAAK,CAAC,SAAS;gBACb,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;gBACpC,IAAI,CAAC,OAAO;oBAAE,OAAO;gBAErB,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1B,IAAI,OAAO,CAAC,aAAa;wBAAE,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC;oBAChE,IAAI,OAAO,CAAC,UAAU;wBAAE,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC;gBAChE,CAAC;gBAED,IACE,OAAO,CAAC,UAAU;oBAClB,WAAW,CAAC,OAAO,CAAC,mBAAmB,CAAC;oBACxC,CAAC,OAAO,CAAC,sBAAsB,EAC/B,CAAC;oBACD,OAAO,CAAC,4BAA4B,EAAE,CAAC;oBACvC,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC;gBACxC,CAAC;gBAED,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;oBACrB,MAAM,aAAa,GACjB,CAAC,CAAC,WAAW,CAAC,gBAAgB;wBAC9B,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,gBAAgB;4BACnD,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,WAAW,CAAC,gBAAgB,CAAC,CAAC;oBAExF,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;oBAEtE,IAAI,4BAA4B,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;wBACjD,OAAO,CAAC,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC;wBAC5D,OAAO,CAAC,+BAA+B,GAAG,KAAK,CAAC,+BAA+B,CAAC;wBAChF,OAAO,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;oBAClD,CAAC;oBAED,MAAM,SAAS,GAAG,+BAA+B,CAC/C,KAAK,CAAC,iBAAiB,EACvB,KAAK,CAAC,UAAU,EAChB,WAAW,CAAC,sBAAsB,CACnC,CAAC;oBACF,IAAI,SAAS,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC;wBACjD,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC;wBAC7C,OAAO,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;wBACpD,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;oBACxC,CAAC;oBACD,IAAI,KAAK,CAAC,gBAAgB;wBAAE,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC;oBAE5D,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,QAAQ;wBAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAE5D,IAAI,KAAK,CAAC,mBAAmB,EAAE,CAAC;wBAC9B,IAAI,OAAO,CAAC,aAAa;4BAAE,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC;wBAChE,IAAI,OAAO,CAAC,UAAU;4BAAE,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC;oBAChE,CAAC;oBAED,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;wBAC1B,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;wBACxF,OAAO,CAAC,0BAA0B,GAAG,IAAI,CAAC,GAAG,CAC3C,OAAO,CAAC,0BAA0B,EAClC,KAAK,CAAC,sBAAsB,CAC7B,CAAC;oBACJ,CAAC;oBACD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;wBACvB,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,GAAG,CACvC,OAAO,CAAC,sBAAsB,EAC9B,KAAK,CAAC,QAAQ,CACf,CAAC;oBACJ,CAAC;oBAED,IAAI,aAAa,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;wBACxC,MAAM,OAAO,GAAG,OAAO,CAAC,aAAa;4BACnC,CAAC,CAAC,cAAc;4BAChB,CAAC,CAAC,YAAY,OAAO,CAAC,mBAAmB,EAAE,CAAC;wBAC9C,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC;4BACzB,OAAO;4BACP,OAAO,EAAE,KAAK,CAAC,YAAY;4BAC3B,eAAe,EAAE,KAAK,CAAC,qBAAqB;4BAC5C,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;4BAC1C,gBAAgB,EAAE,KAAK,CAAC,eAAe;4BACvC,QAAQ,EAAE,KAAK,CAAC,QAAQ;yBACzB,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;SACF;QACD,KAAK,EAAE;YACL,QAAQ,EAAE;gBACR,KAAK,CAAC,QAAsB,EAAE,GAAgB;oBAC5C,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAC1C,WAAW,CAAC,eAAe,GAAG,QAAQ,CAAC,UAAU,IAAI,EAAE,CAAC;gBAC1D,CAAC;gBACD,SAAS,EAAE;oBACT,KAAK,CAAC,SAAwB,EAAE,GAAgB;wBAC9C,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;wBAC/B,MAAM,OAAO,GAAG,sBAAsB,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;wBACnF,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;wBAE9B,MAAM,MAAM,GAAG,eAAe,CAC5B,WAAW,CAAC,eAAe,EAC3B,SAAS,CAAC,UAAU,IAAI,EAAE,EAC1B,GAAG,CAAC,OAAO,CACZ,CAAC;wBACF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;4BACpC,OAAO,CAAC,cAAc,EAAE,CAAC;4BACzB,IAAI,KAAK,CAAC,QAAQ;gCAAE,OAAO,CAAC,sBAAsB,EAAE,CAAC;4BACrD,IAAI,KAAK,CAAC,WAAW;gCAAE,OAAO,CAAC,qBAAqB,EAAE,CAAC;4BACvD,IAAI,gBAAgB,CAAC,KAAK,CAAC;gCAAE,OAAO,CAAC,wBAAwB,EAAE,CAAC;wBAClE,CAAC;oBACH,CAAC;oBACD,KAAK,CAAC,SAAwB;wBAC5B,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;wBACpC,IAAI,CAAC,OAAO;4BAAE,OAAO;wBACrB,MAAM,KAAK,GACT,SAAS,CAAC,WAAW,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;wBAC7E,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;wBAClE,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;oBAC7B,CAAC;iBACF;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,WAA6B;IAC9D,OAAO,EAAE,cAAc,EAAE,WAAW,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,CAAC,UAAU,EAAE,CAAC;AAC7F,CAAC;AAED,SAAS,YAAY,CAAC,GAAsB,EAAE,OAAkB;IAC9D,OAAO,OAAO,CAAQ,GAAG,CAAC,CAAC,IAAI,CAAC;AAClC,CAAC;AAED,SAAS,eAAe,CACtB,SAAmC,EACnC,OAAiC,EACjC,OAAkB;IAElB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAiB,CAAC;IACxC,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC5B,MAAM,CAAC,GAAG,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,CAAC,GAAG,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,UAAU,CAAC,SAAwB;IAC1C,OAAO,SAAS,CAAC,OAAO,KAAK,SAAS,IAAI,gBAAgB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AACjF,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAY;IACpC,IAAI,KAAK,CAAC,WAAW;QAAE,OAAO,KAAK,CAAC;IACpC,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9C,OAAO,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAC/B,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACpC,mGAAmG;IACnG,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC5D,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC/B,OAAO,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,CAAC;AACjC,CAAC"}

package/lib/commands/score/constants.d.ts

@@ -0,0 +1,4 @@
+import type { ScoringConstants } from './types.js';
+export declare const DEFAULT_SCORING_CONSTANTS: ScoringConstants;
+export declare const AMBIGUOUS_PARAM_NAMES: Set<string>;
+//# sourceMappingURL=constants.d.ts.map

package/lib/commands/score/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/commands/score/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD,eAAO,MAAM,yBAAyB,EAAE,gBAuBvC,CAAC;AAEF,eAAO,MAAM,qBAAqB,aAqBhC,CAAC"}

package/lib/commands/score/constants.js

@@ -0,0 +1,47 @@
+export const DEFAULT_SCORING_CONSTANTS = {
+    thresholds: {
+        maxParamsGood: 5,
+        maxDepthGood: 4,
+        maxPolymorphismGood: 2,
+        maxDependencyDepthGood: 3,
+        maxAmbiguousGood: 0,
+        maxOperationsForDiscoverability: 1000,
+    },
+    weights: {
+        parameterSimplicity: 0.1,
+        schemaSimplicity: 0.1,
+        documentationQuality: 0.18,
+        constraintClarity: 0.12,
+        exampleCoverage: 0.18,
+        errorClarity: 0.12,
+        dependencyClarity: 0.1,
+        identifierClarity: 0.05,
+        polymorphismClarity: 0.05,
+        anyOfPenaltyMultiplier: 2.0,
+        discoverabilityWeight: 0.1,
+    },
+    hotspotLimit: 10,
+};
+export const AMBIGUOUS_PARAM_NAMES = new Set([
+    'id',
+    'name',
+    'type',
+    'value',
+    'data',
+    'key',
+    'status',
+    'state',
+    'code',
+    'result',
+    'item',
+    'object',
+    'resource',
+    'entity',
+    'input',
+    'output',
+    'payload',
+    'body',
+    'content',
+    'info',
+]);
+//# sourceMappingURL=constants.js.map

package/lib/commands/score/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/commands/score/constants.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,yBAAyB,GAAqB;IACzD,UAAU,EAAE;QACV,aAAa,EAAE,CAAC;QAChB,YAAY,EAAE,CAAC;QACf,mBAAmB,EAAE,CAAC;QACtB,sBAAsB,EAAE,CAAC;QACzB,gBAAgB,EAAE,CAAC;QACnB,+BAA+B,EAAE,IAAI;KACtC;IACD,OAAO,EAAE;QACP,mBAAmB,EAAE,GAAG;QACxB,gBAAgB,EAAE,GAAG;QACrB,oBAAoB,EAAE,IAAI;QAC1B,iBAAiB,EAAE,IAAI;QACvB,eAAe,EAAE,IAAI;QACrB,YAAY,EAAE,IAAI;QAClB,iBAAiB,EAAE,GAAG;QACtB,iBAAiB,EAAE,IAAI;QACvB,mBAAmB,EAAE,IAAI;QACzB,sBAAsB,EAAE,GAAG;QAC3B,qBAAqB,EAAE,GAAG;KAC3B;IACD,YAAY,EAAE,EAAE;CACjB,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC;IAC3C,IAAI;IACJ,MAAM;IACN,MAAM;IACN,OAAO;IACP,MAAM;IACN,KAAK;IACL,QAAQ;IACR,OAAO;IACP,MAAM;IACN,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,UAAU;IACV,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,SAAS;IACT,MAAM;IACN,SAAS;IACT,MAAM;CACP,CAAC,CAAC"}

package/lib/commands/score/formatters/json.d.ts

@@ -0,0 +1,3 @@
+import type { ScoreResult } from '../types.js';
+export declare function printScoreJson(result: ScoreResult): void;
+//# sourceMappingURL=json.d.ts.map

package/lib/commands/score/formatters/json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../../../src/commands/score/formatters/json.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,wBAAgB,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAoBxD"}

package/lib/commands/score/formatters/json.js

@@ -0,0 +1,20 @@
+import { logger } from '@redocly/openapi-core';
+export function printScoreJson(result) {
+    const output = {
+        agentReadiness: result.agentReadiness,
+        discoverability: Math.round(result.discoverability * 100),
+        subscores: result.subscores,
+        rawMetrics: {
+            operationCount: result.rawMetrics.operationCount,
+            operations: Object.fromEntries(Array.from(result.rawMetrics.operations.entries()).map(([key, m]) => {
+                const { refsUsed: _, ...rest } = m;
+                return [key, rest];
+            })),
+        },
+        operationScores: Object.fromEntries(result.operationScores),
+        dependencyDepths: Object.fromEntries(result.dependencyDepths),
+        hotspots: result.hotspots,
+    };
+    logger.output(JSON.stringify(output, null, 2));
+}
+//# sourceMappingURL=json.js.map

package/lib/commands/score/formatters/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../../../src/commands/score/formatters/json.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAI/C,MAAM,UAAU,cAAc,CAAC,MAAmB;IAChD,MAAM,MAAM,GAAG;QACb,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe,GAAG,GAAG,CAAC;QACzD,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,UAAU,EAAE;YACV,cAAc,EAAE,MAAM,CAAC,UAAU,CAAC,cAAc;YAChD,UAAU,EAAE,MAAM,CAAC,WAAW,CAC5B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE;gBAClE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC;gBACnC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACrB,CAAC,CAAC,CACH;SACF;QACD,eAAe,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,eAAe,CAAC;QAC3D,gBAAgB,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,gBAAgB,CAAC;QAC7D,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AACjD,CAAC"}

package/lib/commands/score/formatters/stylish.d.ts

@@ -0,0 +1,4 @@
+import type { DebugMediaTypeLog, ScoreResult } from '../types.js';
+export declare function printScoreStylish(result: ScoreResult, operationDetails?: boolean): void;
+export declare function printDebugOperation(operationId: string, logs: DebugMediaTypeLog[]): void;
+//# sourceMappingURL=stylish.d.ts.map

package/lib/commands/score/formatters/stylish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stylish.d.ts","sourceRoot":"","sources":["../../../../src/commands/score/formatters/stylish.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAGlE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,WAAW,EAAE,gBAAgB,UAAQ,GAAG,IAAI,CAMrF;AAqJD,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,IAAI,CA0FxF"}