@primmel/primmel 1.3.2 → 1.4.0

package/dist/src/export/rdf.d.ts

@@ -0,0 +1,92 @@
+import type Standard from '../types/Standard';
+/** The export format: Turtle (canonical) or JSON-LD (same graph). */
+export type RdfExportFormat = 'turtle' | 'jsonld';
+/** Tallies + honesty bookkeeping for one export run. */
+export interface RdfExportStats {
+    documents: number;
+    /** Requirement classes exported as smart:Clause nodes. */
+    requirementClasses: number;
+    /** Requirements exported as Provision(-subclass) nodes. */
+    requirements: number;
+    /** Conformance tests exported as primmel:ConformanceTest nodes. */
+    conformanceTests: number;
+    /** Terms exported as smart:TermEntry nodes. */
+    terms: number;
+    /** Guidance notes exported as smart:ProvisionSupplement nodes. */
+    supplements: number;
+    /** Emitted cross-references (requires / verifies / references). */
+    crossReferences: number;
+    /** Triples in the exported graph (declaration block included). */
+    triples: number;
+    /**
+     * Dependency / verification / binding / see-also references that name
+     * an id with no node in the export (e.g. an id from an un-composed
+     * upstream package). Dropped, never emitted as a dangling IRI — one
+     * entry per drop, `<owner> -> <ref> (<kind>)`.
+     *
+     * Bindings are pre-filtered (same discipline as the ReqIF surface):
+     * only `binds_to` / `limit.uses` refs in the `/`-addressed id space go
+     * through the drop record; subject-chain paths (`sample.x`,
+     * `formula:…`, `table:…`) stay silent — they are part of the LOST
+     * machine-checkable bindings, not dropped references.
+     */
+    droppedReferences: string[];
+    /**
+     * Requirements whose obligation is neither empty nor a canonical
+     * shall/should/may spelling. Each exports typed smart:Provision with
+     * primmel:obligation "undefined" — never silently promoted, but
+     * counted here so authoring typos (`obligation SHALL`) are visible.
+     */
+    unknownObligations: number;
+}
+/** The export product: the graph in both syntaxes, plus bookkeeping. */
+export interface RdfExport {
+    turtle: string;
+    jsonld: string;
+    stats: RdfExportStats;
+}
+export type RdfObject = {
+    kind: 'iri';
+    iri: string;
+} | {
+    kind: 'literal';
+    value: string;
+    lang?: string;
+    datatype?: string;
+};
+export interface RdfTriple {
+    subject: string;
+    predicate: string;
+    object: RdfObject;
+}
+/**
+ * Slugs a Primmel id into an IRI-safe local-name fragment:
+ * `/req/metrological/mpe` → `req-metrological-mpe`. (Same algorithm as
+ * the ReqIF surface's slug — kept module-local so the two surfaces
+ * evolve independently.)
+ */
+export declare function rdfSlug(id: string): string;
+/**
+ * The class a requirement belongs to: the longest class id that is a
+ * path-prefix of the requirement id (`/req/a/b` holds `/req/a/b/c`).
+ * Null = the requirement sits at the document's top level. (The ReqIF
+ * surface has the same rule as `requirementClassOf`; duplicated here so
+ * the surfaces stay independent.)
+ */
+export declare function rdfRequirementClassOf(requirementId: string, classIds: string[]): string | null;
+/** Projects a loaded Standard into an RDF graph (Turtle + JSON-LD). The
+ *  projection is fully deterministic — no options (the ReqIF surface's
+ *  `now` has no counterpart: the graph carries no timestamps). */
+export declare function exportStandardRdf(standard: Standard): RdfExport;
+/**
+ * Loads the package at `dir` (single directory — the CLI's `check`
+ * default; `uses` composition needs a locator and stays a punt) and
+ * projects it into an RDF graph.
+ */
+export declare function exportPackageRdf(dir: string): RdfExport;
+/** Escapes a string for a Turtle "..." literal. */
+export declare function turtleEscape(s: string): string;
+/** Renders the triple model as Turtle: subjects in insertion order,
+ *  predicates in insertion order, `a` for rdf:type. */
+export declare function renderTurtle(prefixes: [string, string][], triples: RdfTriple[]): string;
+//# sourceMappingURL=rdf.d.ts.map

package/dist/src/export/rdf.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rdf.d.ts","sourceRoot":"","sources":["../../../src/export/rdf.ts"],"names":[],"mappings":"AA0DA,OAAO,KAAK,QAAQ,MAAM,mBAAmB,CAAC;AA+C9C,qEAAqE;AACrE,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAElD,wDAAwD;AACxD,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,kBAAkB,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IAC3D,YAAY,EAAE,MAAM,CAAC;IACrB,mEAAmE;IACnE,gBAAgB,EAAE,MAAM,CAAC;IACzB,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,mEAAmE;IACnE,eAAe,EAAE,MAAM,CAAC;IACxB,kEAAkE;IAClE,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;;;;;;OAWG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,wEAAwE;AACxE,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,cAAc,CAAC;CACvB;AAMD,MAAM,MAAM,SAAS,GACjB;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAC5B;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzE,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,SAAS,CAAC;CACnB;AAgCD;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAO1C;AAUD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,EAAE,GACjB,MAAM,GAAG,IAAI,CAUf;AAmDD;;kEAEkE;AAClE,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAsZ/D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAGvD;AAmFD,mDAAmD;AACnD,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAY9C;AA4CD;uDACuD;AACvD,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAC5B,OAAO,EAAE,SAAS,EAAE,GACnB,MAAM,CA6BR"}