@origintrail-official/dkg-okf 10.0.2

package/dist/types.js

@@ -0,0 +1,10 @@
+/**
+ * Public types for the OKF → DKG mapper.
+ *
+ * The RDF output is a deterministic array of `Quad`s. We reuse the node's
+ * canonical `Quad` shape (`{ subject, predicate, object, graph? }`) so the
+ * mapper's output drops straight into the importer/`/api/assertion/write`
+ * path without translation.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

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

package/dist/utils.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Small, dependency-free helpers shared by the mapper.
+ *
+ * `isSafeIri` is replicated verbatim from `dkg-core`'s `sparql-safe.ts` so the
+ * pure mapper has zero runtime cross-package dependency and stays unit-testable
+ * in isolation (the package intentionally does not import the node at runtime).
+ * A test pins the behaviour against the same inputs the node validates.
+ */
+/** True when the string is a syntactically safe IRI with a scheme prefix. */
+export declare function isSafeIri(value: string): boolean;
+/** N-Triples/quad-encoding of a plain string literal: `"escaped"`. */
+export declare function literalTerm(value: string): string;
+/** N-Triples/quad-encoding of a typed literal: `"lexical"^^<datatype>`. */
+export declare function typedLiteralTerm(lexical: string, datatypeIri: string): string;
+/**
+ * `BigQuery Dataset` → `BigQueryDataset`. Splits on any non-alphanumeric run and
+ * upper-cases the first letter of each word, preserving existing inner case.
+ */
+export declare function pascalCase(value: string): string;
+/**
+ * `release date` → `releaseDate`, `custom_field` → `customField`. camelCase used
+ * for producer-defined frontmatter keys (converges with the extractor's handling).
+ */
+export declare function camelCase(value: string): string;
+/** Stable blank-node label fragment from an arbitrary concept ID. */
+export declare function sanitizeForBlank(value: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,6EAA6E;AAC7E,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAGhD;AAED,sEAAsE;AACtE,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED,2EAA2E;AAC3E,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMhD;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAU/C;AAED,qEAAqE;AACrE,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEtD"}

package/dist/utils.js

@@ -0,0 +1,53 @@
+/**
+ * Small, dependency-free helpers shared by the mapper.
+ *
+ * `isSafeIri` is replicated verbatim from `dkg-core`'s `sparql-safe.ts` so the
+ * pure mapper has zero runtime cross-package dependency and stays unit-testable
+ * in isolation (the package intentionally does not import the node at runtime).
+ * A test pins the behaviour against the same inputs the node validates.
+ */
+const IRI_SCHEME_RE = /^[a-zA-Z][a-zA-Z0-9+.-]*:[^\s<>"{}|\\^`\x00-\x20]+$/;
+/** True when the string is a syntactically safe IRI with a scheme prefix. */
+export function isSafeIri(value) {
+    if (!value)
+        return false;
+    return IRI_SCHEME_RE.test(value);
+}
+/** N-Triples/quad-encoding of a plain string literal: `"escaped"`. */
+export function literalTerm(value) {
+    return JSON.stringify(value);
+}
+/** N-Triples/quad-encoding of a typed literal: `"lexical"^^<datatype>`. */
+export function typedLiteralTerm(lexical, datatypeIri) {
+    return `${JSON.stringify(lexical)}^^<${datatypeIri}>`;
+}
+/**
+ * `BigQuery Dataset` → `BigQueryDataset`. Splits on any non-alphanumeric run and
+ * upper-cases the first letter of each word, preserving existing inner case.
+ */
+export function pascalCase(value) {
+    return value
+        .split(/[^A-Za-z0-9]+/)
+        .filter(Boolean)
+        .map((w) => w.charAt(0).toUpperCase() + w.slice(1))
+        .join('');
+}
+/**
+ * `release date` → `releaseDate`, `custom_field` → `customField`. camelCase used
+ * for producer-defined frontmatter keys (converges with the extractor's handling).
+ */
+export function camelCase(value) {
+    const parts = value.split(/[^A-Za-z0-9]+/).filter(Boolean);
+    if (parts.length === 0)
+        return 'property';
+    return parts
+        .map((p, i) => i === 0
+        ? p.charAt(0).toLowerCase() + p.slice(1)
+        : p.charAt(0).toUpperCase() + p.slice(1))
+        .join('');
+}
+/** Stable blank-node label fragment from an arbitrary concept ID. */
+export function sanitizeForBlank(value) {
+    return value.replace(/[^A-Za-z0-9]+/g, '_');
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,MAAM,aAAa,GAAG,qDAAqD,CAAC;AAE5E,6EAA6E;AAC7E,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,OAAO,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACnC,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,WAAW,CAAC,KAAa;IACvC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,gBAAgB,CAAC,OAAe,EAAE,WAAmB;IACnE,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,WAAW,GAAG,CAAC;AACxD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK;SACT,KAAK,CAAC,eAAe,CAAC;SACtB,MAAM,CAAC,OAAO,CAAC;SACf,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAClD,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3D,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC;IAC1C,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACZ,CAAC,KAAK,CAAC;QACL,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAC3C;SACA,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;AAC9C,CAAC"}

package/dist/validation.d.ts

@@ -0,0 +1,17 @@
+/**
+ * OKF §9 conformance validation — deliberately permissive.
+ *
+ * A bundle is conformant iff:
+ *   1. every non-reserved `.md` has a parseable YAML frontmatter block;
+ *   2. every frontmatter has a non-empty `type`;
+ *   3. reserved files (`index.md`/`log.md`) follow §6/§7 when present.
+ *
+ * Consumers MUST NOT reject a bundle for: missing optional fields, unknown
+ * `type` values, unknown extra keys, broken cross-links, or missing `index.md`.
+ * Those are surfaced as `warnings`, never `errors`. Only rules 1 and 2 produce
+ * hard errors; reserved-file structure issues are reported as warnings to keep
+ * the consumer lenient (see ADR 0005 / CONTEXT.md).
+ */
+import type { BundleFile, ConformanceReport } from './types.js';
+export declare function validateBundle(files: BundleFile[]): ConformanceReport;
+//# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAIH,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEhE,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,iBAAiB,CAoErE"}

package/dist/validation.js

@@ -0,0 +1,80 @@
+/**
+ * OKF §9 conformance validation — deliberately permissive.
+ *
+ * A bundle is conformant iff:
+ *   1. every non-reserved `.md` has a parseable YAML frontmatter block;
+ *   2. every frontmatter has a non-empty `type`;
+ *   3. reserved files (`index.md`/`log.md`) follow §6/§7 when present.
+ *
+ * Consumers MUST NOT reject a bundle for: missing optional fields, unknown
+ * `type` values, unknown extra keys, broken cross-links, or missing `index.md`.
+ * Those are surfaced as `warnings`, never `errors`. Only rules 1 and 2 produce
+ * hard errors; reserved-file structure issues are reported as warnings to keep
+ * the consumer lenient (see ADR 0005 / CONTEXT.md).
+ */
+import { parseDocument, OkfDocumentError } from './document.js';
+import { isConceptFile, isReservedFile, isValidSegment, basename, pathToConceptId } from './paths.js';
+export function validateBundle(files) {
+    const errors = [];
+    const warnings = [];
+    const ordered = [...files].sort((a, b) => (a.path < b.path ? -1 : a.path > b.path ? 1 : 0));
+    let conceptCount = 0;
+    let hasRootIndex = false;
+    for (const f of ordered) {
+        if (isReservedFile(f.path)) {
+            const name = basename(f.path);
+            const isRootIndex = f.path === 'index.md';
+            if (isRootIndex)
+                hasRootIndex = true;
+            // Reserved files carry no frontmatter, except the bundle-root index.md may
+            // declare only `okf_version` (§6, §11).
+            try {
+                const parsed = parseDocument(f.path, f.content);
+                const keys = Object.keys(parsed.frontmatter);
+                if (keys.length > 0) {
+                    if (name === 'index.md' && isRootIndex) {
+                        const extra = keys.filter((k) => k !== 'okf_version');
+                        if (extra.length > 0) {
+                            warnings.push(`root index.md declares frontmatter keys other than okf_version: ${extra.join(', ')} (§11)`);
+                        }
+                    }
+                    else {
+                        warnings.push(`reserved file ${f.path} carries frontmatter (§6/§7 expect none)`);
+                    }
+                }
+            }
+            catch (err) {
+                warnings.push(`reserved file ${f.path} did not parse: ${err instanceof OkfDocumentError ? err.message : String(err)}`);
+            }
+            continue;
+        }
+        if (!isConceptFile(f.path))
+            continue; // non-.md assets (viz.html, etc.) are out of scope
+        conceptCount += 1;
+        const conceptId = pathToConceptId(f.path);
+        // Every concept path segment must be a valid OKF segment, or the derived subject
+        // IRI (`${iriBase}${conceptId}`) is malformed (e.g. `urn:okf:bad name`). The
+        // mapper already enforces this for link targets; enforce it for concept files too.
+        if (!conceptId.split('/').every(isValidSegment)) {
+            errors.push(`${conceptId}: invalid concept path segment(s) — must match [A-Za-z0-9_][A-Za-z0-9_.-]* (§2)`);
+        }
+        let frontmatter;
+        try {
+            frontmatter = parseDocument(f.path, f.content).frontmatter;
+        }
+        catch (err) {
+            errors.push(`${conceptId}: ${err instanceof OkfDocumentError ? err.message : String(err)} (§9 rule 1)`);
+            continue;
+        }
+        const type = frontmatter.type;
+        if (type === undefined || type === null || String(type).trim() === '') {
+            errors.push(`${conceptId}: frontmatter has no non-empty \`type\` (§9 rule 2)`);
+        }
+    }
+    if (conceptCount === 0)
+        warnings.push('bundle contains no concept documents');
+    if (!hasRootIndex)
+        warnings.push('bundle has no root index.md (permitted — §9)');
+    return { conformant: errors.length === 0, errors, warnings };
+}
+//# sourceMappingURL=validation.js.map

package/dist/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAGtG,MAAM,UAAU,cAAc,CAAC,KAAmB;IAChD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,MAAM,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5F,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,IAAI,YAAY,GAAG,KAAK,CAAC;IAEzB,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACxB,IAAI,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9B,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC;YAC1C,IAAI,WAAW;gBAAE,YAAY,GAAG,IAAI,CAAC;YACrC,2EAA2E;YAC3E,wCAAwC;YACxC,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;gBAChD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBAC7C,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACpB,IAAI,IAAI,KAAK,UAAU,IAAI,WAAW,EAAE,CAAC;wBACvC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC;wBACtD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;4BACrB,QAAQ,CAAC,IAAI,CACX,mEAAmE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAC5F,CAAC;wBACJ,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,0CAA0C,CAAC,CAAC;oBACnF,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,QAAQ,CAAC,IAAI,CACX,iBAAiB,CAAC,CAAC,IAAI,mBAAmB,GAAG,YAAY,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CACxG,CAAC;YACJ,CAAC;YACD,SAAS;QACX,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC;YAAE,SAAS,CAAC,mDAAmD;QACzF,YAAY,IAAI,CAAC,CAAC;QAElB,MAAM,SAAS,GAAG,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC1C,iFAAiF;QACjF,6EAA6E;QAC7E,mFAAmF;QACnF,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,iFAAiF,CAAC,CAAC;QAC7G,CAAC;QACD,IAAI,WAAoC,CAAC;QACzC,IAAI,CAAC;YACH,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC;QAC7D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,IAAI,CACT,GAAG,SAAS,KAAK,GAAG,YAAY,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,CAC3F,CAAC;YACF,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC;QAC9B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACtE,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,qDAAqD,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;IAED,IAAI,YAAY,KAAK,CAAC;QAAE,QAAQ,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;IAC9E,IAAI,CAAC,YAAY;QAAE,QAAQ,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;IAEjF,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAC/D,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@origintrail-official/dkg-okf",
+  "version": "10.0.2",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "js-yaml": "^4.1.1",
+    "mdast-util-from-markdown": "^2.0.3",
+    "mdast-util-to-string": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/mdast": "^4.0.4",
+    "@vitest/coverage-v8": "^4.0.18",
+    "vitest": "^4.0.18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OriginTrail/dkg.git",
+    "directory": "packages/okf"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo"
+  }
+}