@lde/docgen 0.2.0 → 0.2.2

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

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

package/dist/cli.js

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { generateDocumentation } from './index.js';
+import packageJson from '../package.json' with { type: 'json' };
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const program = new Command();
+program
+    .name('docgen')
+    .description('Generate documentation from RDF data')
+    .version(packageJson.version);
+program
+    .command('from-shacl')
+    .description('Generate documentation from a SHACL shapes file')
+    .argument('<shacl-file>', 'Path to SHACL shapes file (in any RDF serialization format)')
+    .argument('<template-file>', 'Path to Liquid template file')
+    .option('-f --frame <json-ld-frame-file>', 'Path to a JSON-LD Frame file', __dirname + '/../frames/shacl.frame.jsonld')
+    .addHelpText('after', `
+Example:
+  $ npx @lde/docgen@latest from-shacl shacl.ttl template.liquid
+    `)
+    .action(async (rdfFile, templateFile, { frame }) => {
+    try {
+        const documentation = await generateDocumentation(rdfFile, templateFile, frame);
+        console.log(documentation);
+    }
+    catch (error) {
+        console.error(`Error: ${error instanceof Error ? error.message : error}`);
+        process.exit(1);
+    }
+});
+program.parse();

package/dist/frame.d.ts

@@ -0,0 +1,4 @@
+import type { JsonLdArray } from 'jsonld/jsonld-spec.js';
+import jsonld from 'jsonld';
+export declare function frame(document: JsonLdArray, frame: string): Promise<jsonld.NodeObject>;
+//# sourceMappingURL=frame.d.ts.map

package/dist/frame.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frame.d.ts","sourceRoot":"","sources":["../src/frame.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,wBAAsB,KAAK,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,8BAQ/D"}

package/dist/frame.js

@@ -0,0 +1,7 @@
+import jsonld from 'jsonld';
+import { readFile } from 'node:fs/promises';
+export async function frame(document, frame) {
+    return await jsonld.frame(document, JSON.parse(await readFile(frame, 'utf8')), {
+        omitGraph: false,
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export declare function generateDocumentation(rdfPath: string, templatePath: string, framePath: string): Promise<string>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,CAKjB"}

package/dist/index.js

@@ -0,0 +1,8 @@
+import { parseRdfToJsonLd } from './parse.js';
+import { frame } from './frame.js';
+import { render } from './render.js';
+export async function generateDocumentation(rdfPath, templatePath, framePath) {
+    const jsonld = await parseRdfToJsonLd(rdfPath);
+    const framed = await frame(jsonld, framePath);
+    return render(framed, templatePath);
+}

package/dist/parse.d.ts

@@ -0,0 +1,3 @@
+import { JsonLdArray } from 'jsonld/jsonld-spec.js';
+export declare function parseRdfToJsonLd(filePath: string): Promise<JsonLdArray>;
+//# sourceMappingURL=parse.d.ts.map

package/dist/parse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../src/parse.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGpD,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAa7E"}

package/dist/parse.js

@@ -0,0 +1,14 @@
+import { rdfDereferencer } from 'rdf-dereference';
+import jsonld from 'jsonld';
+export async function parseRdfToJsonLd(filePath) {
+    const { data } = await rdfDereferencer.dereference(filePath, {
+        localFiles: true,
+    });
+    const quads = [];
+    for await (const quad of data) {
+        quads.push(quad);
+    }
+    return jsonld.fromRDF(quads, {
+        useNativeTypes: true, // Convert xsd:integer to Number etc.
+    });
+}

package/dist/render.d.ts

@@ -0,0 +1,3 @@
+import type { NodeObject } from 'jsonld';
+export declare function render(shapes: NodeObject, templatePath: string): Promise<string>;
+//# sourceMappingURL=render.d.ts.map

package/dist/render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../src/render.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEzC,wBAAsB,MAAM,CAC1B,MAAM,EAAE,UAAU,EAClB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,MAAM,CAAC,CA+CjB"}

package/dist/render.js

@@ -0,0 +1,38 @@
+import { Liquid } from 'liquidjs';
+import { dirname } from 'path';
+export async function render(shapes, templatePath) {
+    const templatesDir = dirname(templatePath);
+    const engine = new Liquid({
+        root: templatesDir,
+        extname: '.liquid',
+    });
+    engine.registerFilter('lang', (nodes, language) => {
+        if (nodes === undefined) {
+            return '';
+        }
+        const filtered = [nodes]
+            .flat()
+            .filter((node) => node['@language'] === language);
+        return filtered[0]?.['@value'] ?? '';
+    });
+    engine.registerFilter('mergePropertiesByPath', (properties) => {
+        const grouped = properties.reduce((acc, propertyShape) => {
+            const path = propertyShape.path;
+            acc[path] ??= [];
+            acc[path].push(propertyShape);
+            return acc;
+        }, {});
+        return Object.entries(grouped).map(([_path, propertyShapes]) => {
+            const result = {};
+            for (const propertyShape of propertyShapes) {
+                for (const key in propertyShape) {
+                    if (result[key] === undefined && propertyShape[key] !== undefined) {
+                        result[key] = propertyShape[key];
+                    }
+                }
+            }
+            return result;
+        });
+    });
+    return engine.renderFile(templatePath, { nodeShapes: shapes['@graph'] });
+}

package/frames/shacl.frame.jsonld

@@ -2,7 +2,7 @@
   "@context": {
     "@vocab": "http://www.w3.org/ns/shacl#",
     "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
-    "schema": "https://schema.org/",
+    "schema": "http://schema.org/",
     "xsd": "http://www.w3.org/2001/XMLSchema#",
     "targetClass": {
       "@type": "@id"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lde/docgen",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Generate documentation from SHACL shapes",
   "repository": "github:ldengine/lde",
   "keywords": [