@oml/server 0.14.13 → 0.14.15

package/out/rest/server.d.ts

@@ -11,6 +11,15 @@ export interface OmlRestServerOptions {
     runtime?: OmlLanguageServerRuntime;
     featureGate?: OmlFeatureGateLike;
 }
+export type OmlWorkspaceLocalOperation = 'lint' | 'validate' | 'assertions' | 'export' | 'render';
+export declare function runOmlWorkspaceLocalOperation<T = Record<string, unknown>>(options: {
+    workspaceRoot?: string;
+    operation: OmlWorkspaceLocalOperation;
+    params?: Record<string, unknown>;
+    requestTimeoutMs?: number;
+    watchWorkspace?: boolean;
+    runtime?: OmlLanguageServerRuntime;
+}): Promise<T>;
 export declare function startOmlRestServer(options: OmlRestServerOptions): Promise<{
     server: http.Server;
     updateToken: (token: string) => Promise<void>;

package/out/rest/server.js

@@ -12,9 +12,6 @@ import { NodeFileSystem } from 'langium/node';
 import { createConnection } from 'vscode-languageserver/node.js';
 import { DataFactory, Writer } from 'n3';
 import uFuzzy from '@leeoniya/ufuzzy';
-// swagger-ui-dist does not ship TypeScript declarations.
-// @ts-expect-error Untyped CommonJS module import.
-import swaggerUiDist from 'swagger-ui-dist';
 import { MarkdownHandlerRegistry, MarkdownPreviewRuntime, buildTemplateCatalog as buildNavigationTemplateCatalog, extractLeadingFrontMatter, resolveTemplateForNavigation, renderTemplate, MarkdownExecutor, } from '@oml/markdown';
 import { STATIC_MARKDOWN_RUNTIME_BUNDLE_FILE, STATIC_MARKDOWN_RUNTIME_CSS } from '@oml/markdown/static';
 import { applyOmlUpdate, collectOntologyMembers, getIriForNode, getOntologyModelIndex, iriFragment, isDescription, isOntology, isVocabulary, tokenizeForFuzzy, } from '@oml/language';
@@ -23,7 +20,7 @@ import { exportAssertedWorkspace, exportWorkspace } from './export.js';
 import { startOmlLanguageServer } from '../lsp/language-server.js';
 import { createOpenApiSpec, dispatchRestOperation, resolveRestOperationId } from './routes.js';
 import { buildTemplateCatalog, expandTemplateComposeBlocks, findFilesByExtension, frontMatterString, isTemplateMarkdownFile, normalizeContextOntologyIri, } from './template.js';
-import { lintWorkspace, reasonWorkspace, validateWorkspace } from './validation.js';
+import { lintWorkspace, validateWorkspace } from './validation.js';
 import { OmlAccessError, requiredFeatureForRestOperation, } from '../auth/feature-policy.js';
 const JSON_CONTENT_TYPE = 'application/json; charset=utf-8';
 const HTML_CONTENT_TYPE = 'text/html; charset=utf-8';
@@ -43,9 +40,9 @@ const SWAGGER_CONTENT_TYPES = {
     '.js': 'application/javascript; charset=utf-8',
     '.png': 'image/png',
 };
-let swaggerDistDirCache;
 let swaggerAssetValidationError;
 let markdownStaticEntryFileCache;
+const swaggerAssetPathCache = new Map();
 function createModuleRequire() {
     if (typeof __filename === 'string' && path.isAbsolute(__filename)) {
         return createRequire(__filename);
@@ -105,22 +102,6 @@ function textResponse(res, status, contentType, body) {
     res.setHeader('content-length', Buffer.byteLength(body, 'utf-8'));
     res.end(body);
 }
-function resolveSwaggerDistDir() {
-    if (!swaggerDistDirCache) {
-        if (typeof swaggerUiDist?.getAbsoluteFSPath !== 'function') {
-            throw new Error("Swagger UI package is unavailable: missing 'swagger-ui-dist.getAbsoluteFSPath()'.");
-        }
-        const resolved = swaggerUiDist.getAbsoluteFSPath();
-        if (!resolved || resolved.trim().length === 0) {
-            throw new Error("Swagger UI package returned an invalid asset directory.");
-        }
-        swaggerDistDirCache = resolved;
-    }
-    if (!swaggerDistDirCache) {
-        throw new Error('Swagger UI package returned an invalid asset directory.');
-    }
-    return swaggerDistDirCache;
-}
 function resolveMarkdownStaticEntryFile() {
     if (!markdownStaticEntryFileCache) {
         const entryFile = require.resolve('@oml/markdown/static');
@@ -132,13 +113,8 @@ function resolveMarkdownStaticEntryFile() {
     return markdownStaticEntryFileCache;
 }
 function validateSwaggerAssetsOrThrow() {
-    const distDir = resolveSwaggerDistDir();
-    for (const fileName of SWAGGER_ASSET_FILES) {
-        const filePath = path.join(distDir, fileName);
-        const stat = fsSync.statSync(filePath, { throwIfNoEntry: false });
-        if (!stat || !stat.isFile()) {
-            throw new Error(`Swagger UI asset missing: ${fileName}`);
-        }
+    for (const asset of ['swagger-ui-bundle.js', 'swagger-ui-standalone-preset.js']) {
+        resolveSwaggerAssetPath(asset);
     }
 }
 function getSwaggerValidationError() {
@@ -159,7 +135,7 @@ async function serveSwaggerAsset(res, fileName) {
         jsonResponse(res, 404, { error: 'Swagger asset not found.' });
         return;
     }
-    const filePath = path.join(resolveSwaggerDistDir(), fileName);
+    const filePath = resolveSwaggerAssetPath(fileName);
     const extension = path.extname(fileName).toLowerCase();
     const contentType = SWAGGER_CONTENT_TYPES[extension] ?? 'application/octet-stream';
     const content = await fs.readFile(filePath);
@@ -169,6 +145,22 @@ async function serveSwaggerAsset(res, fileName) {
     res.setHeader('content-length', content.length);
     res.end(content);
 }
+function resolveSwaggerAssetPath(fileName) {
+    if (!SWAGGER_ASSET_FILES.has(fileName)) {
+        throw new Error(`Swagger UI asset not allowed: ${fileName}`);
+    }
+    const cached = swaggerAssetPathCache.get(fileName);
+    if (cached) {
+        return cached;
+    }
+    const resolvedPath = require.resolve(`swagger-ui-dist/${fileName}`);
+    const resolvedStat = fsSync.statSync(resolvedPath, { throwIfNoEntry: false });
+    if (resolvedStat?.isFile()) {
+        swaggerAssetPathCache.set(fileName, resolvedPath);
+        return resolvedPath;
+    }
+    throw new Error(`Swagger UI asset missing: ${fileName}`);
+}
 function createSwaggerUiPage() {
     return `<!doctype html>
 <html lang="en">
@@ -789,7 +781,7 @@ function createSparqlWorkbenchPage(defaultWorkspaceRoot) {
         <section class="hero">
             <div class="hero-header">
                 <h1 class="page-title">OML Server</h1>
-                <a id="swaggerLink" class="swagger-link" href="#" target="_blank" rel="noopener noreferrer" title="Open Swagger Docs">
+                <a id="swaggerLink" class="swagger-link" href="docs" target="_blank" rel="noopener noreferrer" title="Open Swagger Docs">
                     <svg viewBox="0 0 24 24" aria-hidden="true">
                         <path d="M13.8 2.6a2.1 2.1 0 0 0-3.6 1.5c0 .2 0 .4.1.6a6 6 0 0 0-2.2 1.3l-.4-.2a2.1 2.1 0 1 0-1.8 3.8l.4.2a6.3 6.3 0 0 0 0 2.6l-.4.2a2.1 2.1 0 1 0 1.8 3.8l.4-.2a6 6 0 0 0 2.2 1.3 2.1 2.1 0 1 0 3.5 0 6 6 0 0 0 2.2-1.3l.4.2a2.1 2.1 0 1 0 1.8-3.8l-.4-.2a6.3 6.3 0 0 0 0-2.6l.4-.2a2.1 2.1 0 1 0-1.8-3.8l-.4.2a6 6 0 0 0-2.2-1.3c.1-.2.1-.4.1-.6 0-.6-.2-1.1-.6-1.5Zm-2.6 6.3a3.3 3.3 0 1 1 0 6.6 3.3 3.3 0 0 1 0-6.6Zm4.8 9.6a1 1 0 1 1 0 2 1 1 0 0 1 0-2Zm-9.6 0a1 1 0 1 1 0 2 1 1 0 0 1 0-2Zm11-8.7a1 1 0 1 1 0-2 1 1 0 0 1 0 2Zm-12.4 0a1 1 0 1 1 0-2 1 1 0 0 1 0 2Zm7.2-7.1a1 1 0 1 1 0 2 1 1 0 0 1 0-2Z"/>
                     </svg>
@@ -897,7 +889,6 @@ LIMIT 25</textarea>
         const browseStatus = document.getElementById('browseStatus');
         const browseList = document.getElementById('browseList');
         const browseFilter = document.getElementById('browseFilter');
-        const swaggerLink = document.getElementById('swaggerLink');
 
         let browseEntries = [];
         let selectedModelId = '';
@@ -916,10 +907,6 @@ LIMIT 25</textarea>
             return baseRoutePath() + normalized;
         }
 
-        if (swaggerLink) {
-            swaggerLink.setAttribute('href', routeUrl('docs'));
-        }
-
         function escapeClientHtml(value) {
             return String(value)
                 .replace(/&/g, '&amp;')
@@ -2044,7 +2031,7 @@ class InMemoryJsonRpcLspClient {
             listener.dispose();
         }
     }
-    async lintWorkspace(params = {}) {
+    async lintWorkspace(_params = {}) {
         const preDocs = this.getWorkspaceOmlDocuments();
         const preSummary = this.summarizeDiagnostics(preDocs);
         const preStates = this.summarizeDocumentStates(preDocs);
@@ -2070,18 +2057,15 @@ class InMemoryJsonRpcLspClient {
             ensureInitialized: () => this.ensureInitialized(),
             ensureWorkspaceCurrent: () => this.ensureWorkspaceCurrent(),
             getWorkspaceOmlDocuments: () => this.getWorkspaceOmlDocuments(),
-            writeWorkspaceAssertedOwl: (outputDir, format, pretty) => this.writeWorkspaceAssertedOwl(outputDir, format, pretty),
         };
-        const result = await lintWorkspace(context, params);
+        const result = await lintWorkspace(context);
         const postDocs = this.getWorkspaceOmlDocuments();
         const postStates = this.summarizeDocumentStates(postDocs);
         debugRest('lint.end', {
             filesChecked: result.filesChecked,
             errors: result.errors,
             warnings: result.warnings,
-            totalProblems: result.totalProblems,
-            returnedProblems: result.returnedProblems,
-            truncated: result.truncated,
+            problems: result.problems.length,
             elapsedMs: result.elapsedMs,
             stateValidated: postStates.validated,
             stateLinked: postStates.linked,
@@ -2177,6 +2161,12 @@ class InMemoryJsonRpcLspClient {
     async updateWorkspace(params) {
         await this.ensureInitialized();
         await this.ensureWorkspaceCurrent();
+        const lint = await this.lintWorkspace({});
+        if (lint.errors > 0 || lint.warnings > 0) {
+            return {
+                error: `lint failed with ${lint.errors} error(s) and ${lint.warnings} warning(s).`,
+            };
+        }
         return await applyOmlUpdate(this.runtime.shared, params, (message) => this.logError(message));
     }
     async fuzzySearchWorkspace(params) {
@@ -2278,6 +2268,52 @@ class InMemoryJsonRpcLspClient {
             };
         }
     }
+    async assertionsWorkspace(params) {
+        await this.ensureInitialized();
+        await this.ensureWorkspaceCurrent();
+        const lint = await this.lintWorkspace({});
+        if (lint.errors > 0 || lint.warnings > 0) {
+            return {
+                success: false,
+                files: [],
+                error: `lint failed with ${lint.errors} error(s) and ${lint.warnings} warning(s).`,
+            };
+        }
+        const modelUriFilter = typeof params.modelUri === 'string' ? params.modelUri.trim() : '';
+        const docs = this.getWorkspaceOmlDocuments();
+        const reasoningService = this.runtime.Oml.reasoning.ReasoningService;
+        const store = reasoningService.getStore().getStore();
+        const files = [];
+        for (const doc of docs) {
+            const modelUri = String(doc?.uri ?? '').trim();
+            if (modelUriFilter.length > 0 && modelUri !== modelUriFilter) {
+                continue;
+            }
+            const root = doc?.parseResult?.value;
+            const ontologyIri = normalizeOntologyNamespace(root?.namespace)?.replace(/[\/#]+$/, '');
+            if (!ontologyIri || BUILT_IN_ONTOLOGIES.has(ontologyIri)) {
+                continue;
+            }
+            await reasoningService.ensureQueryContext(modelUri);
+            const quads = store.getQuads(null, null, null, DataFactory.namedNode(modelUri))
+                .map((quad) => ({
+                subject: quad.subject,
+                predicate: quad.predicate,
+                object: quad.object,
+            }));
+            files.push({
+                modelUri,
+                ontologyIri,
+                path: resolveOutputPathFromOntologyIriString(ontologyIri, 'nt').split(path.sep).join('/'),
+                content: await serializeQuads(quads, 'nt', false),
+            });
+        }
+        files.sort((left, right) => left.ontologyIri.localeCompare(right.ontologyIri));
+        return {
+            success: true,
+            files,
+        };
+    }
     async writeWorkspaceAssertedOwl(outputDir, format, pretty) {
         const entries = [];
         const docs = this.getWorkspaceOmlDocuments();
@@ -2301,17 +2337,6 @@ class InMemoryJsonRpcLspClient {
         entries.sort((left, right) => left.ontologyIri.localeCompare(right.ontologyIri));
         return entries;
     }
-    async reasonWorkspace(params) {
-        const context = {
-            workspaceRoot: this.workspaceRoot,
-            runtime: this.runtime,
-            ensureInitialized: () => this.ensureInitialized(),
-            ensureWorkspaceCurrent: () => this.ensureWorkspaceCurrent(),
-            getWorkspaceOmlDocuments: () => this.getWorkspaceOmlDocuments(),
-            writeWorkspaceAssertedOwl: (outputDir, format, pretty) => this.writeWorkspaceAssertedOwl(outputDir, format, pretty),
-        };
-        return await reasonWorkspace(context, params);
-    }
     async validateWorkspace(params) {
         const context = {
             workspaceRoot: this.workspaceRoot,
@@ -2319,19 +2344,15 @@ class InMemoryJsonRpcLspClient {
             ensureInitialized: () => this.ensureInitialized(),
             ensureWorkspaceCurrent: () => this.ensureWorkspaceCurrent(),
             getWorkspaceOmlDocuments: () => this.getWorkspaceOmlDocuments(),
-            writeWorkspaceAssertedOwl: (outputDir, format, pretty) => this.writeWorkspaceAssertedOwl(outputDir, format, pretty),
         };
         return await validateWorkspace(context, params);
     }
     async exportWorkspace(params) {
-        const lint = await this.lintWorkspace({
-            limit: typeof params.lintLimit === 'number' ? params.lintLimit : undefined,
-        });
+        const lint = await this.lintWorkspace({});
         if (lint.errors > 0 || lint.warnings > 0) {
             return {
                 success: false,
                 error: `lint failed with ${lint.errors} error(s) and ${lint.warnings} warning(s).`,
-                lint,
             };
         }
         const context = {
@@ -2342,10 +2363,7 @@ class InMemoryJsonRpcLspClient {
             exportAssertedWorkspace: (options) => exportAssertedWorkspace(context, options),
         };
         const result = await exportWorkspace(context, params);
-        return {
-            ...result,
-            lint,
-        };
+        return result;
     }
     async close() {
         this.stopWorkspaceWatcher();
@@ -2459,39 +2477,45 @@ class InMemoryJsonRpcLspClient {
     async renderWorkspace(params) {
         await this.ensureInitialized();
         await this.ensureWorkspaceCurrent();
-        const lint = await this.lintWorkspace({
-            limit: typeof params.lintLimit === 'number' ? params.lintLimit : undefined,
-        });
+        const lint = await this.lintWorkspace({});
         if (lint.errors > 0 || lint.warnings > 0) {
             return {
                 success: false,
                 filesRendered: 0,
-                outputDir: '',
                 error: `lint failed with ${lint.errors} error(s) and ${lint.warnings} warning(s).`,
-                lint,
             };
         }
         const workspaceRoot = path.resolve(this.workspaceRoot);
-        const inputFromOptions = typeof params.inputDir === 'string' && params.inputDir.trim().length > 0
-            ? params.inputDir.trim()
-            : (typeof params.md === 'string' && params.md.trim().length > 0 ? params.md.trim() : 'src/md');
-        const outputFromOptions = typeof params.outputDir === 'string' && params.outputDir.trim().length > 0
-            ? params.outputDir.trim()
-            : (typeof params.web === 'string' && params.web.trim().length > 0 ? params.web.trim() : 'build/web');
+        const inputFromOptions = typeof params.md === 'string' && params.md.trim().length > 0 ? params.md.trim() : 'src/md';
+        const outputFromOptions = typeof params.web === 'string' && params.web.trim().length > 0 ? params.web.trim() : 'build/web';
         const inputDir = path.resolve(workspaceRoot, inputFromOptions);
         const outputDir = path.resolve(workspaceRoot, outputFromOptions);
-        const contextOption = typeof params.contextOntologyIri === 'string' && params.contextOntologyIri.trim().length > 0
-            ? params.contextOntologyIri.trim()
-            : (typeof params.context === 'string' && params.context.trim().length > 0 ? params.context.trim() : undefined);
-        const defaultContextOntologyIri = contextOption
-            ? normalizeContextOntologyIri(contextOption)
-            : undefined;
+        if (params.clean === true) {
+            await fs.rm(outputDir, { recursive: true, force: true });
+        }
         const runtime = new MarkdownPreviewRuntime(new MarkdownHandlerRegistry());
         const templateCatalog = await buildTemplateCatalog(workspaceRoot);
         const navigationTemplateCatalog = buildNavigationTemplateCatalog(Array.from(templateCatalog.values()).flatMap((entries) => entries.map((entry) => entry.definition)));
         const staticAssets = await writeStaticAssets(outputDir);
         const reasoningService = this.runtime.Oml.reasoning.ReasoningService;
         const ontologyIndex = getOntologyModelIndex(this.runtime.shared);
+        const contextOption = typeof params.context === 'string' && params.context.trim().length > 0
+            ? params.context.trim()
+            : undefined;
+        const defaultContextOntologyIri = contextOption
+            ? (() => {
+                const contextModelPath = path.resolve(workspaceRoot, contextOption);
+                const contextModelUri = pathToFileURL(contextModelPath).toString();
+                return ontologyIndex.resolveOntologyIri(contextModelUri);
+            })()
+            : undefined;
+        if (contextOption && !defaultContextOntologyIri) {
+            return {
+                success: false,
+                filesRendered: 0,
+                error: `Unable to resolve ontology IRI for context model path '${contextOption}'.`,
+            };
+        }
         const executor = new MarkdownExecutor({
             ensureContext: (modelUri) => reasoningService.ensureQueryContext(modelUri),
             resolveContextIri: (modelUri) => reasoningService.getContextIri(modelUri),
@@ -2707,7 +2731,7 @@ class InMemoryJsonRpcLspClient {
                 }
             }
         }
-        return { success: true, filesRendered, outputDir, blockArtifactFiles, lint };
+        return { success: true, filesRendered, outputDir, blockArtifactFiles };
     }
     async ensureWorkspaceCurrent() {
         debugRest('workspace.current.begin', {
@@ -2835,6 +2859,29 @@ class InMemoryJsonRpcLspClient {
         await this.initPromise;
     }
 }
+export async function runOmlWorkspaceLocalOperation(options) {
+    const client = new InMemoryJsonRpcLspClient(options.workspaceRoot ? path.resolve(options.workspaceRoot) : process.cwd(), options.requestTimeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS, options.watchWorkspace === true, options.runtime);
+    try {
+        const params = options.params ?? {};
+        switch (options.operation) {
+            case 'lint':
+                return await client.lintWorkspace(params);
+            case 'validate':
+                return await client.validateWorkspace(params);
+            case 'assertions':
+                return await client.assertionsWorkspace(params);
+            case 'export':
+                return await client.exportWorkspace(params);
+            case 'render':
+                return await client.renderWorkspace(params);
+            default:
+                throw new Error(`Unsupported local operation: ${String(options.operation)}`);
+        }
+    }
+    finally {
+        await client.close();
+    }
+}
 export async function startOmlRestServer(options) {
     const workspaceRoot = options.workspaceRoot ? path.resolve(options.workspaceRoot) : process.cwd();
     debugRest('rest.start.options', {