@jentic/api-scorecard-cli 1.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,4 @@
+Jentic API Scorecard
+Copyright (c) 2026 Jentic
+Jentic API Scorecard is licensed under Apache 2.0 license.
+Copy of the Apache 2.0 license can be found in `LICENSE` file.

package/README.md

@@ -0,0 +1,112 @@
+# Jentic API Scorecard
+
+![Jentic API Scorecard preview](https://github.com/jentic/jentic-api-scorecard/raw/main/assets/scorecard-preview.jpg)
+
+An OpenAPI document that passes validation isn't necessarily one an AI agent can use. Grammar is
+one thing; semantic clarity, safety, and discoverability are another. The **Jentic API Scorecard**
+scores your OpenAPI document against the
+[Jentic API AI Readiness Framework (JAIRF)](https://github.com/jentic/api-ai-readiness-framework)
+across six dimensions and returns a single grade — so you know exactly where to improve.
+
+## What it scores
+
+Each OpenAPI document is evaluated across six lenses — small, targeted improvements in any of them
+tend to produce outsized gains for both human developers and AI agents:
+
+- **Foundational Compliance (FC)** — structural validity and conformance to OpenAPI itself.
+- **Developer Experience & Jentic Compatibility (DXJ)** — documentation quality and how well the
+  OpenAPI document plays with downstream tooling.
+- **AI-Readiness & Agent Experience (ARAX)** — semantic clarity and the context an LLM needs to
+  reason about each operation.
+- **Agent Usability (AU)** — predictable, safe multi-step orchestration.
+- **Security (SEC)** — declared auth schemes and trust boundaries.
+- **AI Discoverability (AID)** — how easily an AI system can find and parse the OpenAPI document.
+
+## How it works
+
+Scoring runs locally inside a Docker container in two phases. **Analysis** runs a battery of
+validators and structural checks against the OpenAPI document to produce a set of diagnostics and
+observations.
+**Scoring** maps those into ~35 signals across the six JAIRF dimensions, aggregates them into
+per-dimension scores, and rolls those up into a single weighted score and grade.
+
+## Requirements
+
+- **Node.js** >= 20.10.0 with npm/npx. See [Node.js downloads](https://nodejs.org/).
+- **Docker** installed and running. See [Docker installation](https://docs.docker.com/get-docker/).
+  The CLI pulls the scoring image automatically on first run.
+- Network access to [`ghcr.io`](https://ghcr.io) (to pull the image) and to whatever URL hosts the
+  OpenAPI document you're scoring (the engine fetches it from inside the container).
+
+## Try it now
+
+OpenAPI documents from [Jentic Public APIs (OAK)](https://github.com/jentic/jentic-public-apis)
+score without any key or limit — no signup, no config:
+
+```bash
+npx @jentic/api-scorecard-cli@alpha score \
+  https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swagger-api/petstore/1.0.27/openapi.json
+```
+
+For URLs outside OAK or local files, set the API key:
+
+```bash
+JENTIC_API_KEY=mvp-preview npx @jentic/api-scorecard-cli@alpha score \
+  https://petstore3.swagger.io/api/v3/openapi.json
+```
+
+```bash
+JENTIC_API_KEY=mvp-preview npx @jentic/api-scorecard-cli@alpha score ./openapi.yaml
+```
+
+That's it. The CLI pulls the scoring engine automatically on first run.
+
+![CLI score output](https://github.com/jentic/jentic-api-scorecard/raw/main/assets/cli-screenshot.png)
+
+
+
+## Control output depth
+
+The `--detail` flag lets you zoom in:
+
+```bash
+# Just the headline score and grade
+npx @jentic/api-scorecard-cli@alpha score --detail summary ./openapi.yaml
+
+# Per-dimension breakdown (default)
+npx @jentic/api-scorecard-cli@alpha score --detail dimensions ./openapi.yaml
+
+# Individual signals within each dimension
+npx @jentic/api-scorecard-cli@alpha score --detail signals ./openapi.yaml
+
+# Full diagnostics with top 5 findings per severity
+npx @jentic/api-scorecard-cli@alpha score --detail diagnostics ./openapi.yaml
+```
+
+## Anonymous vs keyed access
+
+OpenAPI documents hosted under [jentic-public-apis](https://github.com/jentic/jentic-public-apis)
+score without any key. For everything else, set the MVP preview key:
+
+```bash
+export JENTIC_API_KEY=mvp-preview
+```
+
+This is a documented public placeholder for the alpha preview — not a secret. Real key issuance
+arrives in a future release.
+
+## Status
+
+This project is in **alpha**. Track progress in
+[`specs/roadmap.md`](https://github.com/jentic/jentic-api-scorecard/blob/main/specs/roadmap.md).
+
+The `:unstable` Docker image is rebuilt on every push to `main` for direct `docker run` users.
+Versioned images are published alongside each alpha CLI release.
+
+## License
+
+Jentic API Scorecard is licensed under the
+[Apache 2.0](https://github.com/jentic/jentic-api-scorecard/blob/main/LICENSE) license.
+Jentic API Scorecard comes with an explicit
+[NOTICE](https://github.com/jentic/jentic-api-scorecard/blob/main/NOTICE) file containing
+additional legal notices and information.

package/bin/jentic-api-scorecard.mjs

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+import { main } from '../dist/index.js';
+
+main().catch((err) => {
+  process.stderr.write(`error: ${err instanceof Error ? err.message : String(err)}\n`);
+  process.exit(1);
+});

package/dist/bundle.d.ts

@@ -0,0 +1 @@
+export declare function bundleSpec(ref: string): Promise<string>;

package/dist/bundle.js

@@ -0,0 +1,7 @@
+import { bundle, createConfig } from '@redocly/openapi-core';
+export async function bundleSpec(ref) {
+    const config = await createConfig({});
+    const result = await bundle({ ref, config, dereference: false });
+    return JSON.stringify(result.bundle.parsed);
+}
+//# sourceMappingURL=bundle.js.map

package/dist/bundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bundle.js","sourceRoot":"","sources":["../src/bundle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE7D,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,GAAW;IAC1C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,EAAE,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC9C,CAAC"}

package/dist/commands/score.d.ts

@@ -0,0 +1,6 @@
+import { DetailLevel } from '../detail.ts';
+export interface ScoreOptions {
+    withLlm?: boolean;
+    detail?: DetailLevel;
+}
+export declare function runScore(input: string, options: ScoreOptions): Promise<number>;

package/dist/commands/score.js

@@ -0,0 +1,103 @@
+import { existsSync, statSync } from 'node:fs';
+import { bundleSpec } from "../bundle.js";
+import { DEFAULT_DETAIL, filterByDetail } from "../detail.js";
+import { imageExists, imageRef, pullImage, runDocker } from "../docker.js";
+import { ExitCode } from "../exit-codes.js";
+import { formatPretty } from "../formatters/pretty.js";
+import { spin, done, clearSpinner } from "../spinner.js";
+function isURL(input) {
+    return /^https:\/\//i.test(input);
+}
+function isExistingFile(input) {
+    try {
+        return existsSync(input) && statSync(input).isFile();
+    }
+    catch {
+        return false;
+    }
+}
+export async function runScore(input, options) {
+    const containerArgs = ['score'];
+    if (options.withLlm) {
+        containerArgs.push('--with-llm');
+    }
+    const apiKey = process.env['JENTIC_API_KEY'];
+    const forwardJenticKey = apiKey !== undefined && apiKey !== '';
+    let stdinPayload;
+    const startTime = Date.now();
+    if (isURL(input)) {
+        containerArgs.push('--url', input);
+    }
+    else if (isExistingFile(input)) {
+        spin(`Bundling ${input}…`);
+        try {
+            stdinPayload = await bundleSpec(input);
+        }
+        catch (err) {
+            clearSpinner();
+            const message = err instanceof Error ? err.message : String(err);
+            process.stderr.write(`error: failed to bundle ${input}: ${message}\n`);
+            return ExitCode.SPEC_FAILURE;
+        }
+    }
+    else {
+        process.stderr.write(`error: input '${input}' is neither an https:// URL nor an existing file.\n`);
+        return ExitCode.GENERIC_ERROR;
+    }
+    const ref = imageRef();
+    const present = await imageExists(ref);
+    if (!present) {
+        spin(`Pulling ${ref}…`);
+        const pullResult = await pullImage(ref);
+        if (pullResult.exitCode !== 0) {
+            clearSpinner();
+            process.stderr.write(`error: failed to pull image ${ref}\n`);
+            if (pullResult.stderr) {
+                process.stderr.write(pullResult.stderr);
+            }
+            return pullResult.exitCode === ExitCode.DOCKER_MISSING
+                ? ExitCode.DOCKER_MISSING
+                : ExitCode.GENERIC_ERROR;
+        }
+    }
+    spin(`Scoring…`);
+    let result;
+    try {
+        result = await runDocker({
+            args: containerArgs,
+            stdinPayload,
+            forwardJenticKey,
+        });
+    }
+    catch (err) {
+        clearSpinner();
+        const message = err instanceof Error ? err.message : String(err);
+        process.stderr.write(`error: failed to run docker: ${message}\n`);
+        return ExitCode.GENERIC_ERROR;
+    }
+    if (result.exitCode !== 0) {
+        clearSpinner();
+        if (result.stdout) {
+            process.stdout.write(result.stdout);
+        }
+        return result.exitCode;
+    }
+    let parsed;
+    try {
+        parsed = JSON.parse(result.stdout);
+    }
+    catch {
+        clearSpinner();
+        process.stderr.write('warning: engine output was not valid JSON; passing through raw output.\n');
+        process.stdout.write(result.stdout);
+        return ExitCode.SUCCESS;
+    }
+    const elapsed = ((Date.now() - startTime) / 1000).toFixed(1);
+    done(`Scoring done in ${elapsed}s`);
+    const detail = options.detail ?? DEFAULT_DETAIL;
+    const filtered = filterByDetail(parsed, detail);
+    const output = formatPretty(filtered, input, { detail });
+    process.stdout.write(output);
+    return ExitCode.SUCCESS;
+}
+//# sourceMappingURL=score.js.map

package/dist/commands/score.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"score.js","sourceRoot":"","sources":["../../src/commands/score.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAe,cAAc,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAOzD,SAAS,KAAK,CAAC,KAAa;IAC1B,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,cAAc,CAAC,KAAa;IACnC,IAAI,CAAC;QACH,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;IACvD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,KAAa,EAAE,OAAqB;IACjE,MAAM,aAAa,GAAa,CAAC,OAAO,CAAC,CAAC;IAC1C,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC7C,MAAM,gBAAgB,GAAG,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,EAAE,CAAC;IAE/D,IAAI,YAAgC,CAAC;IACrC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAE7B,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACjB,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;SAAM,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,YAAY,KAAK,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC;YACH,YAAY,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,YAAY,EAAE,CAAC;YACf,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,KAAK,KAAK,OAAO,IAAI,CAAC,CAAC;YACvE,OAAO,QAAQ,CAAC,YAAY,CAAC;QAC/B,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,iBAAiB,KAAK,sDAAsD,CAC7E,CAAC;QACF,OAAO,QAAQ,CAAC,aAAa,CAAC;IAChC,CAAC;IAED,MAAM,GAAG,GAAG,QAAQ,EAAE,CAAC;IACvB,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;IACvC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,CAAC;QACxB,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,UAAU,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;YAC9B,YAAY,EAAE,CAAC;YACf,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,GAAG,IAAI,CAAC,CAAC;YAC7D,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;gBACtB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,CAAC;YACD,OAAO,UAAU,CAAC,QAAQ,KAAK,QAAQ,CAAC,cAAc;gBACpD,CAAC,CAAC,QAAQ,CAAC,cAAc;gBACzB,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,CAAC;IAEjB,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,SAAS,CAAC;YACvB,IAAI,EAAE,aAAa;YACnB,YAAY;YACZ,gBAAgB;SACjB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,YAAY,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,OAAO,IAAI,CAAC,CAAC;QAClE,OAAO,QAAQ,CAAC,aAAa,CAAC;IAChC,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;QAC1B,YAAY,EAAE,CAAC;QACf,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,MAAM,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED,IAAI,MAAuB,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAoB,CAAC;IACxD,CAAC;IAAC,MAAM,CAAC;QACP,YAAY,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,0EAA0E,CAC3E,CAAC;QACF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACpC,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC1B,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7D,IAAI,CAAC,mBAAmB,OAAO,GAAG,CAAC,CAAC;IAEpC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC;IAChD,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACzD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B,OAAO,QAAQ,CAAC,OAAO,CAAC;AAC1B,CAAC"}

package/dist/detail.d.ts

@@ -0,0 +1,12 @@
+import { ScorecardResult } from './result.ts';
+export declare const DetailLevel: {
+    readonly SUMMARY: "summary";
+    readonly DIMENSIONS: "dimensions";
+    readonly SIGNALS: "signals";
+    readonly DIAGNOSTICS: "diagnostics";
+};
+export type DetailLevel = (typeof DetailLevel)[keyof typeof DetailLevel];
+export declare const DETAIL_LEVELS: readonly DetailLevel[];
+export declare const DEFAULT_DETAIL: DetailLevel;
+export declare function isDetailLevel(value: string): value is DetailLevel;
+export declare function filterByDetail(result: ScorecardResult, level: DetailLevel): ScorecardResult;

package/dist/detail.js

@@ -0,0 +1,39 @@
+export const DetailLevel = {
+    SUMMARY: 'summary',
+    DIMENSIONS: 'dimensions',
+    SIGNALS: 'signals',
+    DIAGNOSTICS: 'diagnostics',
+};
+export const DETAIL_LEVELS = [
+    DetailLevel.SUMMARY,
+    DetailLevel.DIMENSIONS,
+    DetailLevel.SIGNALS,
+    DetailLevel.DIAGNOSTICS,
+];
+export const DEFAULT_DETAIL = DetailLevel.DIMENSIONS;
+export function isDetailLevel(value) {
+    return DETAIL_LEVELS.includes(value);
+}
+export function filterByDetail(result, level) {
+    const { summary, details, diagnostics, ...rest } = result;
+    const filtered = { ...rest, summary };
+    if (level === DetailLevel.SUMMARY) {
+        const { dimensions: _dimensions, ...summaryRest } = summary;
+        filtered.summary = summaryRest;
+        return filtered;
+    }
+    if (level === DetailLevel.DIMENSIONS) {
+        return filtered;
+    }
+    if (level === DetailLevel.SIGNALS) {
+        if (details !== undefined)
+            filtered.details = details;
+        return filtered;
+    }
+    if (details !== undefined)
+        filtered.details = details;
+    if (diagnostics !== undefined)
+        filtered.diagnostics = diagnostics;
+    return filtered;
+}
+//# sourceMappingURL=detail.js.map

package/dist/detail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detail.js","sourceRoot":"","sources":["../src/detail.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;CAClB,CAAC;AAIX,MAAM,CAAC,MAAM,aAAa,GAA2B;IACnD,WAAW,CAAC,OAAO;IACnB,WAAW,CAAC,UAAU;IACtB,WAAW,CAAC,OAAO;IACnB,WAAW,CAAC,WAAW;CACxB,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAgB,WAAW,CAAC,UAAU,CAAC;AAElE,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,OAAQ,aAAmC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,MAAuB,EAAE,KAAkB;IACxE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IAE1D,MAAM,QAAQ,GAAoB,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC;IAEvD,IAAI,KAAK,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;QAC5D,QAAQ,CAAC,OAAO,GAAG,WAAW,CAAC;QAC/B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAI,KAAK,KAAK,WAAW,CAAC,UAAU,EAAE,CAAC;QACrC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAI,KAAK,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;QAClC,IAAI,OAAO,KAAK,SAAS;YAAE,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;QACtD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAI,OAAO,KAAK,SAAS;QAAE,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IACtD,IAAI,WAAW,KAAK,SAAS;QAAE,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;IAClE,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/docker.d.ts

@@ -0,0 +1,18 @@
+export declare const IMAGE_NAME = "ghcr.io/jentic/jentic-api-scorecard";
+export declare function imageRef(): string;
+export declare function imageExists(ref: string): Promise<boolean>;
+export interface PullResult {
+    exitCode: number;
+    stderr: string;
+}
+export declare function pullImage(ref: string): Promise<PullResult>;
+export interface DockerRunOptions {
+    args: string[];
+    stdinPayload?: string;
+    forwardJenticKey: boolean;
+}
+export interface DockerRunResult {
+    exitCode: number;
+    stdout: string;
+}
+export declare function runDocker(opts: DockerRunOptions): Promise<DockerRunResult>;

package/dist/docker.js

@@ -0,0 +1,108 @@
+import { execFile, spawn } from 'node:child_process';
+import { constants as osConstants } from 'node:os';
+import { ExitCode } from "./exit-codes.js";
+import { cliVersion } from "./version.js";
+export const IMAGE_NAME = 'ghcr.io/jentic/jentic-api-scorecard';
+export function imageRef() {
+    return `${IMAGE_NAME}:${cliVersion}`;
+}
+export function imageExists(ref) {
+    return new Promise((resolve) => {
+        execFile('docker', ['image', 'inspect', ref], (err) => {
+            resolve(err === null);
+        });
+    });
+}
+export function pullImage(ref) {
+    return new Promise((resolve) => {
+        const child = spawn('docker', ['pull', ref], {
+            stdio: ['ignore', 'ignore', 'pipe'],
+        });
+        const stderrChunks = [];
+        if (child.stderr) {
+            child.stderr.on('data', (chunk) => {
+                stderrChunks.push(chunk);
+            });
+        }
+        child.on('error', (err) => {
+            const exitCode = err.code === 'ENOENT' ? ExitCode.DOCKER_MISSING : ExitCode.GENERIC_ERROR;
+            resolve({ exitCode, stderr: err.message });
+        });
+        child.on('close', (code) => {
+            resolve({
+                exitCode: code ?? ExitCode.GENERIC_ERROR,
+                stderr: Buffer.concat(stderrChunks).toString('utf8'),
+            });
+        });
+    });
+}
+const FORWARDED_SIGNALS = ['SIGINT', 'SIGTERM', 'SIGHUP'];
+export function runDocker(opts) {
+    const dockerArgs = ['run', '--rm'];
+    if (opts.stdinPayload !== undefined) {
+        dockerArgs.push('-i');
+    }
+    if (opts.forwardJenticKey) {
+        dockerArgs.push('-e', 'JENTIC_API_KEY');
+    }
+    dockerArgs.push(imageRef());
+    dockerArgs.push(...opts.args);
+    return new Promise((resolve, reject) => {
+        const child = spawn('docker', dockerArgs, {
+            stdio: [opts.stdinPayload !== undefined ? 'pipe' : 'inherit', 'pipe', 'inherit'],
+        });
+        let settled = false;
+        const signalHandlers = new Map();
+        const stdoutChunks = [];
+        const cleanup = () => {
+            for (const [sig, handler] of signalHandlers) {
+                process.off(sig, handler);
+            }
+            signalHandlers.clear();
+        };
+        const settle = (fn) => {
+            if (settled)
+                return;
+            settled = true;
+            cleanup();
+            fn();
+        };
+        for (const sig of FORWARDED_SIGNALS) {
+            const handler = () => {
+                child.kill(sig);
+            };
+            signalHandlers.set(sig, handler);
+            process.on(sig, handler);
+        }
+        if (child.stdout) {
+            child.stdout.on('data', (chunk) => {
+                stdoutChunks.push(chunk);
+            });
+        }
+        child.on('error', (err) => {
+            if (err.code === 'ENOENT') {
+                process.stderr.write("error: 'docker' command not found.\n" +
+                    '  Install Docker: https://docs.docker.com/get-docker/\n');
+                settle(() => resolve({ exitCode: ExitCode.DOCKER_MISSING, stdout: '' }));
+                return;
+            }
+            settle(() => reject(err));
+        });
+        child.on('close', (code, signal) => {
+            const stdout = Buffer.concat(stdoutChunks).toString('utf8');
+            if (signal !== null) {
+                const signo = osConstants.signals[signal] ?? 0;
+                settle(() => resolve({ exitCode: 128 + signo, stdout }));
+                return;
+            }
+            settle(() => resolve({ exitCode: code ?? ExitCode.GENERIC_ERROR, stdout }));
+        });
+        if (opts.stdinPayload !== undefined && child.stdin) {
+            child.stdin.on('error', () => {
+                /* swallow EPIPE if container exits early */
+            });
+            child.stdin.end(opts.stdinPayload);
+        }
+    });
+}
+//# sourceMappingURL=docker.js.map

package/dist/docker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docker.js","sourceRoot":"","sources":["../src/docker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,SAAS,CAAC;AAEnD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,CAAC,MAAM,UAAU,GAAG,qCAAqC,CAAC;AAEhE,MAAM,UAAU,QAAQ;IACtB,OAAO,GAAG,UAAU,IAAI,UAAU,EAAE,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,QAAQ,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE;YACpD,OAAO,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAOD,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;YAC3C,KAAK,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC;SACpC,CAAC,CAAC;QACH,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;gBACxC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC;QACD,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAA0B,EAAE,EAAE;YAC/C,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC;YAC1F,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;YACzB,OAAO,CAAC;gBACN,QAAQ,EAAE,IAAI,IAAI,QAAQ,CAAC,aAAa;gBACxC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;aACrD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAaD,MAAM,iBAAiB,GAAqB,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;AAE5E,MAAM,UAAU,SAAS,CAAC,IAAsB;IAC9C,MAAM,UAAU,GAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAE7C,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACpC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAED,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC5B,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IAE9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,UAAU,EAAE;YACxC,KAAK,EAAE,CAAC,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC;SACjF,CAAC,CAAC;QAEH,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,MAAM,cAAc,GAAG,IAAI,GAAG,EAA8B,CAAC;QAC7D,MAAM,YAAY,GAAa,EAAE,CAAC;QAElC,MAAM,OAAO,GAAG,GAAS,EAAE;YACzB,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,cAAc,EAAE,CAAC;gBAC5C,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAC5B,CAAC;YACD,cAAc,CAAC,KAAK,EAAE,CAAC;QACzB,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,CAAC,EAAc,EAAQ,EAAE;YACtC,IAAI,OAAO;gBAAE,OAAO;YACpB,OAAO,GAAG,IAAI,CAAC;YACf,OAAO,EAAE,CAAC;YACV,EAAE,EAAE,CAAC;QACP,CAAC,CAAC;QAEF,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE,CAAC;YACpC,MAAM,OAAO,GAAG,GAAS,EAAE;gBACzB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClB,CAAC,CAAC;YACF,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YACjC,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;gBACxC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC;QAED,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAA0B,EAAE,EAAE;YAC/C,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC1B,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,sCAAsC;oBACpC,yDAAyD,CAC5D,CAAC;gBACF,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;gBACzE,OAAO;YACT,CAAC;YACD,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YACjC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC5D,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACpB,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC/C,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,GAAG,GAAG,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;gBACzD,OAAO;YACT,CAAC;YACD,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,IAAI,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACnD,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBAC3B,4CAA4C;YAC9C,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/exit-codes.d.ts

@@ -0,0 +1,10 @@
+export declare const ExitCode: {
+    readonly SUCCESS: 0;
+    readonly GENERIC_ERROR: 1;
+    readonly AUTH_INVALID_KEY: 2;
+    readonly GATE_REJECTED: 3;
+    readonly DOCKER_MISSING: 4;
+    readonly SPEC_FAILURE: 5;
+    readonly ENGINE_FAILURE: 6;
+};
+export type ExitCode = (typeof ExitCode)[keyof typeof ExitCode];

package/dist/exit-codes.js

@@ -0,0 +1,10 @@
+export const ExitCode = {
+    SUCCESS: 0,
+    GENERIC_ERROR: 1,
+    AUTH_INVALID_KEY: 2,
+    GATE_REJECTED: 3,
+    DOCKER_MISSING: 4,
+    SPEC_FAILURE: 5,
+    ENGINE_FAILURE: 6,
+};
+//# sourceMappingURL=exit-codes.js.map

package/dist/exit-codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exit-codes.js","sourceRoot":"","sources":["../src/exit-codes.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,OAAO,EAAE,CAAC;IACV,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,CAAC;IACnB,aAAa,EAAE,CAAC;IAChB,cAAc,EAAE,CAAC;IACjB,YAAY,EAAE,CAAC;IACf,cAAc,EAAE,CAAC;CACT,CAAC"}

package/dist/formatters/pretty.d.ts

@@ -0,0 +1,7 @@
+import { DetailLevel } from '../detail.ts';
+import { ScorecardResult } from '../result.ts';
+export type { ScorecardResult } from '../result.ts';
+export interface FormatPrettyOptions {
+    detail?: DetailLevel;
+}
+export declare function formatPretty(result: ScorecardResult, source: string, options?: FormatPrettyOptions): string;

package/dist/formatters/pretty.js

@@ -0,0 +1,273 @@
+import chalk from 'chalk';
+import { DEFAULT_DETAIL, DetailLevel } from "../detail.js";
+import { cliVersion } from "../version.js";
+const BANNER = `     ██╗███████╗███╗   ██╗████████╗██╗ ██████╗
+     ██║██╔════╝████╗  ██║╚══██╔══╝██║██╔════╝
+     ██║█████╗  ██╔██╗ ██║   ██║   ██║██║
+██   ██║██╔══╝  ██║╚██╗██║   ██║   ██║██║
+╚█████╔╝███████╗██║ ╚████║   ██║   ██║╚██████╗
+ ╚════╝ ╚══════╝╚═╝  ╚═══╝   ╚═╝   ╚═╝ ╚═════╝`;
+function gradeColor(grade) {
+    if (grade.startsWith('A') || grade.startsWith('B'))
+        return chalk.green;
+    if (grade.startsWith('C'))
+        return chalk.yellow;
+    return chalk.red;
+}
+function colorGrade(grade) {
+    return gradeColor(grade)(grade);
+}
+function colorScore(grade, formatted) {
+    return gradeColor(grade)(formatted);
+}
+const BAR_WIDTH = 20;
+function scoreBar(score) {
+    const filled = Math.round((score / 100) * BAR_WIDTH);
+    const empty = BAR_WIDTH - filled;
+    return chalk.white('▄'.repeat(filled)) + chalk.blackBright('▄'.repeat(empty));
+}
+// Signal scores are [0, 1] with no engine-emitted grade, so we band by raw
+// threshold rather than reusing gradeColor (which keys off a grade letter).
+function signalScoreColor(score) {
+    if (score >= 0.8)
+        return chalk.green;
+    if (score >= 0.5)
+        return chalk.yellow;
+    return chalk.red;
+}
+const SEVERITY_LABELS = {
+    1: 'error',
+    2: 'warning',
+    3: 'info',
+    4: 'hint',
+};
+function severityLabel(sev) {
+    return SEVERITY_LABELS[sev] ?? `severity ${sev}`;
+}
+function severityColor(sev) {
+    if (sev === 1)
+        return chalk.red;
+    if (sev === 2)
+        return chalk.yellow;
+    return chalk.dim;
+}
+export function formatPretty(result, source, options = {}) {
+    const detail = options.detail ?? DEFAULT_DETAIL;
+    const { summary, apiMetadata, metadata, details, diagnostics } = result;
+    const lines = [];
+    lines.push('');
+    lines.push(chalk.cyan(BANNER));
+    lines.push(`${chalk.bold('  API Readiness Scorecard')} ${chalk.dim(`v${cliVersion}`)}`);
+    const engineRaw = metadata?.engine?.version;
+    if (engineRaw) {
+        const match = /^([^+]+)(?:\+jairf\.(.+))?$/.exec(engineRaw);
+        const engineVer = match?.[1] ?? engineRaw;
+        const frameworkVer = match?.[2];
+        const parts = [];
+        if (frameworkVer)
+            parts.push(`Scoring Framework ${frameworkVer}`);
+        parts.push(`Scoring Engine ${engineVer}`);
+        lines.push(chalk.dim(`  ${parts.join('  |  ')}`));
+    }
+    lines.push('');
+    if (apiMetadata?.name) {
+        const version = apiMetadata.apiDescriptionVersion
+            ? chalk.dim(` v${apiMetadata.apiDescriptionVersion}`)
+            : '';
+        const heading = `${apiMetadata.name}${apiMetadata.apiDescriptionVersion ? ` v${apiMetadata.apiDescriptionVersion}` : ''}`;
+        const divider = chalk.dim('─'.repeat(heading.length));
+        lines.push(`  ${divider}`);
+        lines.push(`  ${chalk.bold(apiMetadata.name)}${version}`);
+        lines.push(`  ${divider}`);
+        lines.push('');
+    }
+    lines.push(`  ${chalk.dim('OpenAPI Document:')} ${source}`);
+    const finalScore = colorScore(summary.grade, Math.round(summary.score).toString());
+    lines.push(`  Final score:      ${chalk.bold(finalScore)} ${chalk.dim('/ 100')}`);
+    lines.push(`  Readiness:        ${chalk.bold(summary.level.toUpperCase())}  (${colorGrade(summary.grade)})`);
+    const showDimensions = detail !== DetailLevel.SUMMARY;
+    if (showDimensions && summary.dimensions && summary.dimensions.length > 0) {
+        lines.push('');
+        lines.push(`  ${chalk.bold.underline('Dimensions')}`);
+        lines.push('');
+        const kindWidth = Math.max(...summary.dimensions.map((d) => d.kind.length));
+        const nameWidth = Math.max(...summary.dimensions.map((d) => d.name.length));
+        for (const dim of summary.dimensions) {
+            const kind = chalk.cyan(dim.kind.padEnd(kindWidth));
+            const name = dim.name.padEnd(nameWidth);
+            const bar = scoreBar(dim.score);
+            const score = Math.round(dim.score).toString().padStart(3);
+            const grade = colorGrade(dim.grade.padEnd(2));
+            lines.push(`    ${kind}  ${name}  ${bar}  ${score}  ${grade}`);
+        }
+    }
+    if (apiMetadata) {
+        const stat = (n, label) => `${chalk.bold(n)} ${chalk.dim(label)}`;
+        const stats = [];
+        if (apiMetadata.operationCount !== undefined) {
+            stats.push(stat(apiMetadata.operationCount, 'operations'));
+        }
+        if (apiMetadata.schemaCount !== undefined) {
+            stats.push(stat(apiMetadata.schemaCount, 'schemas'));
+        }
+        if (apiMetadata.tagCount !== undefined) {
+            stats.push(stat(apiMetadata.tagCount, 'tags'));
+        }
+        if (apiMetadata.securitySchemeCount !== undefined) {
+            stats.push(stat(apiMetadata.securitySchemeCount, 'security schemes'));
+        }
+        if (apiMetadata.securitySchemeTypes && apiMetadata.securitySchemeTypes.length > 0) {
+            stats.push(stat(apiMetadata.securitySchemeTypes.length, 'security types'));
+        }
+        if (stats.length > 0) {
+            lines.push('');
+            lines.push(`  ${stats.join(chalk.dim('  ·  '))}`);
+        }
+    }
+    if (detail === DetailLevel.SIGNALS || detail === DetailLevel.DIAGNOSTICS) {
+        appendSignals(lines, details);
+    }
+    if (detail === DetailLevel.DIAGNOSTICS) {
+        appendDiagnostics(lines, diagnostics);
+    }
+    appendHint(lines, detail);
+    lines.push('');
+    return lines.join('\n');
+}
+function appendSignals(lines, details) {
+    if (!details || details.length === 0)
+        return;
+    lines.push('');
+    lines.push(`  ${chalk.bold.underline('Signals')}`);
+    const allSignals = details.flatMap((g) => (g.dimensions ?? []).flatMap((d) => d.signals ?? []));
+    if (allSignals.length === 0)
+        return;
+    const nameWidth = Math.max(...allSignals.map((s) => s.name.length));
+    let firstDim = true;
+    for (const group of details) {
+        const groupDimensions = group.dimensions ?? [];
+        for (const dim of groupDimensions) {
+            const signals = dim.signals ?? [];
+            if (signals.length === 0)
+                continue;
+            lines.push('');
+            if (!firstDim)
+                lines.push('');
+            firstDim = false;
+            const stats = [];
+            if (dim.score !== undefined)
+                stats.push(Math.round(dim.score).toString());
+            if (dim.grade)
+                stats.push(colorGrade(dim.grade));
+            const trailer = stats.length > 0 ? `  (${stats.join(' / ')})` : '';
+            lines.push(`  ${chalk.cyan(dim.kind)}  ${chalk.bold(dim.name)}${trailer}`);
+            const indent = 4;
+            const termCols = process.stdout.columns ?? Number.POSITIVE_INFINITY;
+            const maxRowWidth = Math.max(0, termCols - indent);
+            const rows = [];
+            let widest = 0;
+            for (const signal of signals) {
+                const name = signal.name.padEnd(nameWidth);
+                const scoreNum = Math.round(signal.score * 100)
+                    .toString()
+                    .padStart(3);
+                const scoreText = `${scoreNum}%`;
+                const score = signalScoreColor(signal.score)(scoreText);
+                const fixedWidth = name.length + 2 + scoreText.length;
+                let descRaw = signal.description ?? '';
+                let descSegment = '';
+                if (descRaw) {
+                    const descBudget = maxRowWidth - fixedWidth - 2;
+                    if (descBudget <= 1) {
+                        descRaw = '';
+                    }
+                    else if (descRaw.length > descBudget) {
+                        descRaw = descRaw.slice(0, descBudget - 1) + '…';
+                    }
+                    descSegment = descRaw ? `  ${chalk.dim(descRaw)}` : '';
+                }
+                const visible = fixedWidth + (descRaw ? 2 + descRaw.length : 0);
+                if (visible > widest)
+                    widest = visible;
+                rows.push(`    ${name}  ${score}${descSegment}`);
+            }
+            const rule = chalk.dim('─'.repeat(widest));
+            lines.push(`    ${rule}`);
+            lines.push(...rows);
+            lines.push(`    ${rule}`);
+        }
+    }
+}
+const DIAGNOSTIC_PREVIEW_LIMIT = 5;
+function appendDiagnostics(lines, diagnostics) {
+    lines.push('');
+    if (!diagnostics || diagnostics.length === 0) {
+        lines.push(`  ${chalk.bold.underline('Diagnostics')}  ${chalk.dim('0')}`);
+        return;
+    }
+    const grouped = new Map();
+    for (const diag of diagnostics) {
+        const list = grouped.get(diag.severity) ?? [];
+        list.push(diag);
+        grouped.set(diag.severity, list);
+    }
+    lines.push(`  ${chalk.bold.underline('Diagnostics')}  ${chalk.dim(diagnostics.length.toString())}`);
+    const pluralizableSeverities = { 1: true, 2: true, 4: true };
+    const order = [1, 2, 3, 4];
+    const tallyParts = [];
+    for (const sev of order) {
+        const items = grouped.get(sev);
+        if (!items?.length)
+            continue;
+        const base = severityLabel(sev);
+        const label = pluralizableSeverities[sev] && items.length !== 1 ? `${base}s` : base;
+        tallyParts.push(severityColor(sev)(`${items.length} ${label}`));
+    }
+    if (tallyParts.length > 0) {
+        lines.push(`    ${tallyParts.join(chalk.dim('  ·  '))}`);
+    }
+    const indent = 4;
+    const termCols = process.stdout.columns ?? Number.POSITIVE_INFINITY;
+    const maxRowWidth = Math.max(0, termCols - indent);
+    for (const sev of order) {
+        const items = grouped.get(sev);
+        if (!items?.length)
+            continue;
+        const shown = items.slice(0, DIAGNOSTIC_PREVIEW_LIMIT);
+        const codeWidth = Math.max(...shown.map((d) => (d.code ?? '').length));
+        lines.push('');
+        const base = severityLabel(sev);
+        const label = pluralizableSeverities[sev] && items.length !== 1 ? `${base}s` : base;
+        lines.push(`  ${severityColor(sev)(label)}  ${chalk.dim(`(${items.length})`)}`);
+        for (const diag of shown) {
+            const code = (diag.code ?? '').padEnd(codeWidth);
+            const fixed = code.length + 2;
+            const budget = maxRowWidth - fixed;
+            let message = diag.message;
+            if (budget > 1 && message.length > budget) {
+                message = message.slice(0, budget - 1) + '…';
+            }
+            lines.push(`    ${chalk.bold(code)}  ${chalk.dim(message)}`);
+        }
+        if (items.length > shown.length) {
+            lines.push(chalk.dim(`    … +${items.length - shown.length} more`));
+        }
+    }
+}
+function appendHint(lines, detail) {
+    if (detail === DetailLevel.SUMMARY) {
+        lines.push('');
+        lines.push(chalk.dim('  Run with --detail dimensions for the dimension table.'));
+        return;
+    }
+    if (detail === DetailLevel.DIMENSIONS) {
+        lines.push('');
+        lines.push(chalk.dim('  Run with --detail signals for signal breakdown.'));
+        return;
+    }
+    if (detail === DetailLevel.SIGNALS) {
+        lines.push('');
+        lines.push(chalk.dim('  Run with --detail diagnostics for severity counts and a preview of findings.'));
+    }
+}
+//# sourceMappingURL=pretty.js.map

package/dist/formatters/pretty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pretty.js","sourceRoot":"","sources":["../../src/formatters/pretty.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3D,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,MAAM,MAAM,GAAG;;;;;+CAKgC,CAAC;AAIhD,SAAS,UAAU,CAAC,KAAa;IAC/B,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC;IACvE,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC,MAAM,CAAC;IAC/C,OAAO,KAAK,CAAC,GAAG,CAAC;AACnB,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,UAAU,CAAC,KAAa,EAAE,SAAiB;IAClD,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,SAAS,GAAG,EAAE,CAAC;AAErB,SAAS,QAAQ,CAAC,KAAa;IAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;IACrD,MAAM,KAAK,GAAG,SAAS,GAAG,MAAM,CAAC;IACjC,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,2EAA2E;AAC3E,4EAA4E;AAC5E,SAAS,gBAAgB,CAAC,KAAa;IACrC,IAAI,KAAK,IAAI,GAAG;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC;IACrC,IAAI,KAAK,IAAI,GAAG;QAAE,OAAO,KAAK,CAAC,MAAM,CAAC;IACtC,OAAO,KAAK,CAAC,GAAG,CAAC;AACnB,CAAC;AAED,MAAM,eAAe,GAA2B;IAC9C,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,SAAS;IACZ,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,MAAM;CACV,CAAC;AAEF,SAAS,aAAa,CAAC,GAAW;IAChC,OAAO,eAAe,CAAC,GAAG,CAAC,IAAI,YAAY,GAAG,EAAE,CAAC;AACnD,CAAC;AAED,SAAS,aAAa,CAAC,GAAW;IAChC,IAAI,GAAG,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC;IAChC,IAAI,GAAG,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,MAAM,CAAC;IACnC,OAAO,KAAK,CAAC,GAAG,CAAC;AACnB,CAAC;AAMD,MAAM,UAAU,YAAY,CAC1B,MAAuB,EACvB,MAAc,EACd,UAA+B,EAAE;IAEjC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC;IAChD,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IACxE,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/B,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;IAExF,MAAM,SAAS,GAAG,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC;IAC5C,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,KAAK,GAAG,6BAA6B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;QAC1C,MAAM,YAAY,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,YAAY;YAAE,KAAK,CAAC,IAAI,CAAC,qBAAqB,YAAY,EAAE,CAAC,CAAC;QAClE,KAAK,CAAC,IAAI,CAAC,kBAAkB,SAAS,EAAE,CAAC,CAAC;QAC1C,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,WAAW,EAAE,IAAI,EAAE,CAAC;QACtB,MAAM,OAAO,GAAG,WAAW,CAAC,qBAAqB;YAC/C,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,WAAW,CAAC,qBAAqB,EAAE,CAAC;YACrD,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,OAAO,GAAG,GAAG,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,qBAAqB,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC1H,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,OAAO,EAAE,CAAC,CAAC;QAC1D,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC;IAC5D,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACnF,KAAK,CAAC,IAAI,CAAC,uBAAuB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAClF,KAAK,CAAC,IAAI,CACR,uBAAuB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,MAAM,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CACjG,CAAC;IAEF,MAAM,cAAc,GAAG,MAAM,KAAK,WAAW,CAAC,OAAO,CAAC;IAEtD,IAAI,cAAc,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1E,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACtD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEf,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5E,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAE5E,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACrC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YACpD,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACxC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC3D,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,KAAK,IAAI,KAAK,GAAG,KAAK,KAAK,KAAK,KAAK,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,KAAa,EAAU,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1F,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,WAAW,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,WAAW,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YAC1C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;QACvD,CAAC;QACD,IAAI,WAAW,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACvC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,WAAW,CAAC,mBAAmB,KAAK,SAAS,EAAE,CAAC;YAClD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC,CAAC;QACxE,CAAC;QACD,IAAI,WAAW,CAAC,mBAAmB,IAAI,WAAW,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClF,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;QAC7E,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED,IAAI,MAAM,KAAK,WAAW,CAAC,OAAO,IAAI,MAAM,KAAK,WAAW,CAAC,WAAW,EAAE,CAAC;QACzE,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAChC,CAAC;IAED,IAAI,MAAM,KAAK,WAAW,CAAC,WAAW,EAAE,CAAC;QACvC,iBAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IACxC,CAAC;IAED,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAE1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,aAAa,CAAC,KAAe,EAAE,OAAmC;IACzE,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IAE7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAEnD,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;IAChG,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IACpC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEpE,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,eAAe,GAAG,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC;QAC/C,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YAClC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;YAClC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YAEnC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,IAAI,CAAC,QAAQ;gBAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC9B,QAAQ,GAAG,KAAK,CAAC;YACjB,MAAM,KAAK,GAAa,EAAE,CAAC;YAC3B,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS;gBAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC1E,IAAI,GAAG,CAAC,KAAK;gBAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;YACjD,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,OAAO,EAAE,CAAC,CAAC;YAE3E,MAAM,MAAM,GAAG,CAAC,CAAC;YACjB,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,iBAAiB,CAAC;YACpE,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,CAAC;YAEnD,MAAM,IAAI,GAAa,EAAE,CAAC;YAC1B,IAAI,MAAM,GAAG,CAAC,CAAC;YACf,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;qBAC5C,QAAQ,EAAE;qBACV,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACf,MAAM,SAAS,GAAG,GAAG,QAAQ,GAAG,CAAC;gBACjC,MAAM,KAAK,GAAG,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC;gBACxD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC;gBAEtD,IAAI,OAAO,GAAG,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC;gBACvC,IAAI,WAAW,GAAG,EAAE,CAAC;gBACrB,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAM,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,CAAC,CAAC;oBAChD,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;wBACpB,OAAO,GAAG,EAAE,CAAC;oBACf,CAAC;yBAAM,IAAI,OAAO,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;wBACvC,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;oBACnD,CAAC;oBACD,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzD,CAAC;gBAED,MAAM,OAAO,GAAG,UAAU,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChE,IAAI,OAAO,GAAG,MAAM;oBAAE,MAAM,GAAG,OAAO,CAAC;gBACvC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,KAAK,KAAK,GAAG,WAAW,EAAE,CAAC,CAAC;YACnD,CAAC;YAED,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3C,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAC1B,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;YACpB,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,wBAAwB,GAAG,CAAC,CAAC;AAEnC,SAAS,iBAAiB,CAAC,KAAe,EAAE,WAAqC;IAC/E,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7C,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC1E,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,GAAG,EAAwB,CAAC;IAChD,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAAK,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CACxF,CAAC;IAEF,MAAM,sBAAsB,GAA4B,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC;IACtF,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAE3B,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,EAAE,MAAM;YAAE,SAAS;QAC7B,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,sBAAsB,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;QACpF,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;IAClE,CAAC;IACD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,MAAM,GAAG,CAAC,CAAC;IACjB,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,iBAAiB,CAAC;IACpE,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,CAAC;IAEnD,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,EAAE,MAAM;YAAE,SAAS;QAE7B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAAC;QACvD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAEvE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,sBAAsB,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;QACpF,KAAK,CAAC,IAAI,CAAC,KAAK,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC;QAEhF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACjD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;YAC9B,MAAM,MAAM,GAAG,WAAW,GAAG,KAAK,CAAC;YACnC,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAC3B,IAAI,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;gBAC1C,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;YAC/C,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,KAAe,EAAE,MAAmB;IACtD,IAAI,MAAM,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,yDAAyD,CAAC,CAAC,CAAC;QACjF,OAAO;IACT,CAAC;IAED,IAAI,MAAM,KAAK,WAAW,CAAC,UAAU,EAAE,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC,CAAC;QAC3E,OAAO;IACT,CAAC;IAED,IAAI,MAAM,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CACR,KAAK,CAAC,GAAG,CAAC,gFAAgF,CAAC,CAC5F,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export declare function main(argv?: string[]): Promise<void>;

package/dist/index.js

@@ -0,0 +1,25 @@
+import { Command, Option } from 'commander';
+import { runScore } from "./commands/score.js";
+import { DEFAULT_DETAIL, DETAIL_LEVELS } from "./detail.js";
+import { cliVersion } from "./version.js";
+export async function main(argv = process.argv) {
+    const program = new Command();
+    program
+        .name('jentic-api-scorecard')
+        .description('Score an OpenAPI document against the Jentic API AI Readiness Framework (JAIRF).')
+        .version(cliVersion);
+    program
+        .command('score')
+        .description('Score an OpenAPI document by URL or local file path.')
+        .argument('<input>', 'https:// URL or local file path to an OpenAPI document')
+        .option('--with-llm', 'Enable LLM-backed analysis in the engine', false)
+        .addOption(new Option('-d, --detail <level>', 'Payload depth')
+        .choices([...DETAIL_LEVELS])
+        .default(DEFAULT_DETAIL))
+        .action(async (input, opts) => {
+        const exitCode = await runScore(input, { withLlm: opts.withLlm, detail: opts.detail });
+        process.exitCode = exitCode;
+    });
+    await program.parseAsync(argv);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,aAAa,EAAe,MAAM,aAAa,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAiB,OAAO,CAAC,IAAI;IACtD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO;SACJ,IAAI,CAAC,sBAAsB,CAAC;SAC5B,WAAW,CAAC,kFAAkF,CAAC;SAC/F,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvB,OAAO;SACJ,OAAO,CAAC,OAAO,CAAC;SAChB,WAAW,CAAC,sDAAsD,CAAC;SACnE,QAAQ,CAAC,SAAS,EAAE,wDAAwD,CAAC;SAC7E,MAAM,CAAC,YAAY,EAAE,0CAA0C,EAAE,KAAK,CAAC;SACvE,SAAS,CACR,IAAI,MAAM,CAAC,sBAAsB,EAAE,eAAe,CAAC;SAChD,OAAO,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC;SAC3B,OAAO,CAAC,cAAc,CAAC,CAC3B;SACA,MAAM,CAAC,KAAK,EAAE,KAAa,EAAE,IAAgD,EAAE,EAAE;QAChF,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QACvF,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEL,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC"}

package/dist/result.d.ts

@@ -0,0 +1,62 @@
+export interface Dimension {
+    kind: string;
+    name: string;
+    score: number;
+    grade: string;
+}
+export interface ScorecardSummary {
+    score: number;
+    level: string;
+    grade: string;
+    dimensions?: Dimension[];
+}
+export interface ApiMetadata {
+    name?: string;
+    apiDescriptionVersion?: string;
+    operationCount?: number;
+    schemaCount?: number;
+    tagCount?: number;
+    securitySchemeCount?: number;
+    securitySchemeTypes?: string[];
+}
+export interface EngineMetadata {
+    version?: string;
+}
+export interface Metadata {
+    engine?: EngineMetadata;
+}
+export interface Signal {
+    kind: string;
+    name: string;
+    score: number;
+    description?: string;
+    metadata?: Record<string, unknown>;
+}
+export interface DetailDimension {
+    kind: string;
+    name: string;
+    score?: number;
+    grade?: string;
+    signals?: Signal[];
+}
+export interface DetailGroup {
+    kind: string;
+    name: string;
+    score?: number;
+    grade?: string;
+    dimensions?: DetailDimension[];
+}
+export interface Diagnostic {
+    source: string;
+    severity: number;
+    message: string;
+    code?: string;
+    data?: Record<string, unknown>;
+}
+export interface ScorecardResult {
+    summary: ScorecardSummary;
+    apiMetadata?: ApiMetadata;
+    metadata?: Metadata;
+    details?: DetailGroup[];
+    diagnostics?: Diagnostic[];
+}

package/dist/result.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=result.js.map

package/dist/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":""}

package/dist/spinner.d.ts

@@ -0,0 +1,3 @@
+export declare function spin(message: string): void;
+export declare function done(message: string): void;
+export declare function clearSpinner(): void;

package/dist/spinner.js

@@ -0,0 +1,25 @@
+import ora from 'ora';
+// Single process-wide spinner — concurrent score invocations would interleave.
+let spinner = null;
+export function spin(message) {
+    if (spinner) {
+        spinner.text = message;
+        return;
+    }
+    spinner = ora({ text: message, stream: process.stderr }).start();
+}
+export function done(message) {
+    if (spinner) {
+        spinner.succeed(message);
+        spinner = null;
+        return;
+    }
+    process.stderr.write(`${message}\n`);
+}
+export function clearSpinner() {
+    if (spinner) {
+        spinner.stop();
+        spinner = null;
+    }
+}
+//# sourceMappingURL=spinner.js.map

package/dist/spinner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spinner.js","sourceRoot":"","sources":["../src/spinner.ts"],"names":[],"mappings":"AAAA,OAAO,GAAiB,MAAM,KAAK,CAAC;AAEpC,+EAA+E;AAC/E,IAAI,OAAO,GAAe,IAAI,CAAC;AAE/B,MAAM,UAAU,IAAI,CAAC,OAAe;IAClC,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC;QACvB,OAAO;IACT,CAAC;IACD,OAAO,GAAG,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,OAAe;IAClC,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,GAAG,IAAI,CAAC;QACf,OAAO;IACT,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,OAAO,GAAG,IAAI,CAAC;IACjB,CAAC;AACH,CAAC"}

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const cliVersion: string;

package/dist/version.js

@@ -0,0 +1,5 @@
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+const pkg = require('../package.json');
+export const cliVersion = pkg.version;
+//# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAwB,CAAC;AAE9D,MAAM,CAAC,MAAM,UAAU,GAAW,GAAG,CAAC,OAAO,CAAC"}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@jentic/api-scorecard-cli",
+  "version": "1.0.0-alpha.0",
+  "description": "Score an OpenAPI document against the Jentic API AI Readiness Framework (JAIRF).",
+  "keywords": [
+    "openapi",
+    "jentic",
+    "jairf",
+    "score",
+    "scorecard",
+    "ai-readiness"
+  ],
+  "license": "Apache-2.0",
+  "author": "Jentic <hello@jentic.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jentic/jentic-api-scorecard.git",
+    "directory": "packages/cli"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org",
+    "provenance": false,
+    "tag": "alpha"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "jentic-api-scorecard": "./bin/jentic-api-scorecard.mjs"
+  },
+  "files": [
+    "bin/",
+    "dist/",
+    "LICENSE",
+    "NOTICE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "npm run build:typescript",
+    "build:typescript": "tsc -p tsconfig.json",
+    "clean": "rimraf dist *.tsbuildinfo",
+    "prepack": "copyfiles -u 2 ../../LICENSE . && copyfiles -u 2 ../../NOTICE . && copyfiles -u 2 ../../README.md .",
+    "postpack": "rimraf NOTICE LICENSE README.md",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "typescript:check-types": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@redocly/openapi-core": "^1.30.0",
+    "chalk": "^4.1.2",
+    "commander": "^14.0.0",
+    "ora": "^9.4.0"
+  },
+  "engines": {
+    "node": ">=20.10.0"
+  }
+}