@mitre/hdf-openapi 0.0.0-stage → 3.8.0-next.42532249979.1

package/dist/index.d.ts

@@ -0,0 +1,83 @@
+interface JsonSchema {
+  [key: string]: unknown;
+}
+interface ComponentsDocument {
+  openapi: string;
+  info: {
+    title: string;
+    version: string;
+    description: string;
+    license: {
+      name: string;
+      identifier: string;
+    };
+    contact: {
+      name: string;
+      url: string;
+    };
+  };
+  jsonSchemaDialect: string;
+  components: {
+    schemas: Record<string, JsonSchema>;
+  };
+}
+/** The bundler's own list (hdf-schema/src/bundle-schemas.ts), in its order. */
+export declare const MAIN_SCHEMAS: readonly ["hdf-results.schema.json", "hdf-baseline.schema.json", "hdf-comparison.schema.json", "hdf-system.schema.json", "hdf-plan.schema.json", "hdf-amendments.schema.json", "hdf-evidence-package.schema.json", "hdf-requirement-change-event.schema.json"];
+export declare const ROOT_COMPONENT_NAMES: Record<string, string>;
+/** Named definitions across the bundles, excluding the eight roots. */
+export declare const EXPECTED_DEFINITIONS = 118;
+/**
+ * Lifts one component out of the components document as a schema that validates on its
+ * own — the inverse of the components transform, and the only way to check that the
+ * transform preserved meaning rather than merely producing well-formed output.
+ *
+ * The closure is walked transitively rather than copying every component, so what comes
+ * back is the subgraph the named component actually depends on. A component that dragged
+ * in the whole document would make the test pass for the wrong reason.
+ *
+ * Validate the result with a 2020-12 engine. This repository's own validators are
+ * draft-07 and ignore `unevaluatedProperties` (ADR-0009 §5), so they would accept
+ * documents the schema text rejects.
+ */
+export declare function extractStandaloneSchema(doc: ComponentsDocument, name: string): JsonSchema;
+/** Who owns the condition: the mcperr taxonomy, ADR-0008 §3's conventions, or the service. */
+type ProblemOwner = 'taxonomy' | 'convention' | 'service';
+interface ProblemDoc {
+  /** The mcperr code this type maps, where one does (ADR-0010 §6). */
+  code?: string;
+  title: string;
+  status: number;
+  owner: ProblemOwner;
+  cause: string;
+  remedy: string;
+}
+/** Loads the problem-type documentation, refusing a malformed or incomplete entry. */
+export declare function loadProblemDocs(file?: string): Record<string, ProblemDoc>;
+/** Where the hosted problem-type pages live, which every `type` value dereferences to. */
+export declare const PROBLEM_BASE = "https://mitre.github.io/hdf-libs/problems";
+/**
+ * ADR-0010 §6's code-to-status-and-type mapping, derived from problems.yaml rather than
+ * restated beside it — §6 says the mapping exists exactly once, and that file is where.
+ */
+export declare function problemTypes(docs?: Record<string, ProblemDoc>): Record<string, {
+  status: number;
+  type: string;
+}>;
+/**
+ * The codes ADR-0010 §6 marks `never`. Recorded rather than silently dropped: each is a
+ * `file`-adapter concern with no HTTP surface, and TRUNCATED is dead in the MCP too.
+ */
+export declare const UNMAPPED_CODES: string[];
+interface ExampleFault {
+  index: number;
+  errors: string;
+}
+/**
+ * Faults in a schema's own examples. An empty array means every example validates.
+ *
+ * `references` supplies the components an example's schema may `$ref` — the ingest request
+ * points at the eight document roots, so without them it cannot compile.
+ */
+export declare function validateExample(schema: Record<string, unknown>, references?: Record<string, unknown>): ExampleFault[];
+export type { ComponentsDocument, ExampleFault, JsonSchema, ProblemDoc, ProblemOwner };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/components.ts","../src/extract.ts","../src/problems.ts","../src/validate-example.ts"],"mappings":"A,UAAiB;GACd;;UAGc;EACf;EACA;IACE;IACA;IACA;IACA;MAAW;MAAc;;IACzB;MAAW;MAAc;;;EAE3B;EACA;IAAc,SAAS,eAAe;;;;qBAI3B;qBAWA,sBAAsB;;qBAYtB;;;;;;;;;;;;;;wBCWG,wBAAwB,KAAK,oBAAoB,eAAe;;KC5CpE;UAEK;;EAEf;EACA;EACA;EACA,OAAO;EACP;EACA;;;wBAac,gBAAgB,gBAAqC,eAAe;;qBA2CvE;;;;;wBAMG,aAAa,OAAI,eAAA,cAAuB;EAAiB;EAAgB;;;;;;qBAY5E;UCjFI;EACf;EACA;;;;;;;;wBASc,gBACd,QAAQ,yBACR,aAAY,0BACX"}