@oslo-flanders/core 1.0.10 → 1.0.12

package/index.d.ts

@@ -22,3 +22,6 @@ export * from './lib/logging/LoggerFactory';
 export * from './lib/logging/VoidLoggerFactory';
 export * from './lib/logging/WinstonLoggerFactory';
 export * from './lib/utils/storeUtils';
+export * from './lib/utils/fileSystem';
+export * from './lib/utils/strings';
+export * from './lib/constants/prefixes';

package/index.js

@@ -38,4 +38,7 @@ __exportStar(require("./lib/logging/LoggerFactory"), exports);
 __exportStar(require("./lib/logging/VoidLoggerFactory"), exports);
 __exportStar(require("./lib/logging/WinstonLoggerFactory"), exports);
 __exportStar(require("./lib/utils/storeUtils"), exports);
+__exportStar(require("./lib/utils/fileSystem"), exports);
+__exportStar(require("./lib/utils/strings"), exports);
+__exportStar(require("./lib/constants/prefixes"), exports);
 //# sourceMappingURL=index.js.map

package/lib/constants/prefixes.d.ts

@@ -0,0 +1 @@
+export declare function getPrefixes(): Promise<Record<string, string>>;

package/lib/constants/prefixes.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPrefixes = void 0;
+const core_1 = require("@oslo-flanders/core");
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const PREFIX_CC_URL = 'https://prefix.cc/context';
+async function getPrefixes() {
+    const url = PREFIX_CC_URL;
+    try {
+        const response = await (0, node_fetch_1.default)(url);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch prefixes: ${response.statusText}`);
+        }
+        const data = await response.json();
+        if (data['@context']) {
+            return data['@context'];
+        }
+        throw new Error('Invalid context format received from prefix.cc');
+    }
+    catch (error) {
+        console.error(`Error fetching prefixes: ${String(error)}`);
+        // Fallback to a minimal set of prefixes if the fetch fails
+        return {
+            skos: core_1.ns.skos(''),
+            rdf: core_1.ns.rdf(''),
+            rdfs: core_1.ns.rdfs(''),
+            dct: core_1.ns.dcterms(''),
+            xsd: core_1.ns.xsd(''),
+        };
+    }
+}
+exports.getPrefixes = getPrefixes;
+//# sourceMappingURL=prefixes.js.map

package/lib/store/QuadStore.d.ts

@@ -4,6 +4,8 @@ export declare class QuadStore {
     constructor();
     addQuads(quads: RDF.Quad[]): void;
     addQuad(quad: RDF.Quad): void;
+    removeQuads(quad: RDF.Quad[]): void;
+    removeQuad(quad: RDF.Quad): void;
     addQuadsFromFile(file: string): Promise<void>;
     findQuads(subject: RDF.Term | null, predicate: RDF.Term | null, object: RDF.Term | null, graph?: RDF.Term | null): RDF.Quad[];
     findQuad(subject: RDF.Term | null, predicate: RDF.Term | null, object: RDF.Term | null, graph?: RDF.Term | null): RDF.Quad | undefined;
@@ -208,8 +210,20 @@ export declare class QuadStore {
     /**
      * Finds the oslo:value of a given RDF.Term
      * @param subject The RDF.Term to find the oslo:key of
-     * @param store A N3 quad store
+     * @param graph The RDF.Term of the named graph
      * @returns An RDF.Term or undefined if not found
      */
     getOsloExtensionValue(subject: RDF.Term, graph?: RDF.Term | null): RDF.NamedNode | undefined;
+    /**
+     * Find the parent attribute of an attribute
+     * @param subject The RDF.Term to find the parent attribute of
+     * @param graph The RDF.Term of the named graph
+     */
+    getParentAttribute(subject: RDF.Term, graph?: RDF.Term | null): RDF.Term | undefined;
+    /**
+     * Find the child attribute of an attribute
+     * @param subject The RDF.Term to find the parent attribute of
+     * @param graph The RDF.Term of the named graph
+     */
+    getChildAttribute(subject: RDF.Term, graph?: RDF.Term | null): RDF.Term | undefined;
 }

package/lib/store/QuadStore.js

@@ -51,6 +51,12 @@ let QuadStore = class QuadStore {
     addQuad(quad) {
         this.store.addQuad(quad);
     }
+    removeQuads(quad) {
+        this.store.removeQuads(quad);
+    }
+    removeQuad(quad) {
+        this.store.removeQuad(quad);
+    }
     async addQuadsFromFile(file) {
         const buffer = await (0, fetchFileOrUrl_1.fetchFileOrUrl)(file);
         const textStream = require('streamify-string')(buffer.toString());
@@ -361,12 +367,28 @@ let QuadStore = class QuadStore {
     /**
      * Finds the oslo:value of a given RDF.Term
      * @param subject The RDF.Term to find the oslo:key of
-     * @param store A N3 quad store
+     * @param graph The RDF.Term of the named graph
      * @returns An RDF.Term or undefined if not found
      */
     getOsloExtensionValue(subject, graph = null) {
         return (this.store.getObjects(subject, namespaces_1.ns.oslo('value'), graph).shift());
     }
+    /**
+     * Find the parent attribute of an attribute
+     * @param subject The RDF.Term to find the parent attribute of
+     * @param graph The RDF.Term of the named graph
+     */
+    getParentAttribute(subject, graph = null) {
+        return (this.findObject(subject, namespaces_1.ns.oslo('parentAttribute')));
+    }
+    /**
+     * Find the child attribute of an attribute
+     * @param subject The RDF.Term to find the parent attribute of
+     * @param graph The RDF.Term of the named graph
+     */
+    getChildAttribute(subject, graph = null) {
+        return (this.findObject(subject, namespaces_1.ns.oslo('childAttribute')));
+    }
 };
 QuadStore = __decorate([
     (0, inversify_1.injectable)(),

package/lib/utils/fileSystem.d.ts

@@ -0,0 +1 @@
+export declare function ensureOutputDirectory(directory: string): void;

package/lib/utils/fileSystem.js

@@ -0,0 +1,16 @@
+"use strict";
+// eslint-disable-next-line eslint-comments/disable-enable-pair
+/* eslint-disable no-sync */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureOutputDirectory = void 0;
+const fs_1 = __importDefault(require("fs"));
+function ensureOutputDirectory(directory) {
+    if (!fs_1.default.existsSync(directory)) {
+        fs_1.default.mkdirSync(directory);
+    }
+}
+exports.ensureOutputDirectory = ensureOutputDirectory;
+//# sourceMappingURL=fileSystem.js.map

package/lib/utils/storeUtils.d.ts

@@ -1,4 +1,5 @@
 import type * as RDF from '@rdfjs/types';
+import type { DataFactory } from 'rdf-data-factory';
 import type { QuadStore } from '../store/QuadStore';
 export declare function getApplicationProfileLabel(subject: RDF.Term, store: QuadStore, language?: string | null): RDF.Literal | undefined;
 export declare function getVocabularyLabel(subject: RDF.Term, store: QuadStore, language?: string | null): RDF.Literal | undefined;
@@ -8,3 +9,5 @@ export declare function getApplicationProfileUsageNote(subject: RDF.Term, store:
 export declare function getVocabularyUsageNote(subject: RDF.Term, store: QuadStore, language?: string | null): RDF.Literal | undefined;
 export declare function getMinCount(subject: RDF.Term, store: QuadStore): string | undefined;
 export declare function getMaxCount(subject: RDF.Term, store: QuadStore): string | undefined;
+export declare function createList(items: RDF.Term[], store: QuadStore, df: DataFactory): RDF.BlankNode | RDF.NamedNode;
+export declare function findAllAttributes(subject: RDF.Term, attributeIds: RDF.Term[], store: QuadStore): RDF.Term[];

package/lib/utils/storeUtils.js

@@ -1,45 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMaxCount = exports.getMinCount = exports.getVocabularyUsageNote = exports.getApplicationProfileUsageNote = exports.getVocabularyDefinition = exports.getApplicationProfileDefinition = exports.getVocabularyLabel = exports.getApplicationProfileLabel = void 0;
+exports.findAllAttributes = exports.createList = exports.getMaxCount = exports.getMinCount = exports.getVocabularyUsageNote = exports.getApplicationProfileUsageNote = exports.getVocabularyDefinition = exports.getApplicationProfileDefinition = exports.getVocabularyLabel = exports.getApplicationProfileLabel = void 0;
 const namespaces_1 = require("./namespaces");
 function getApplicationProfileLabel(subject, store, language = null) {
     var _a, _b, _c;
     const labels = store.getLabels(subject);
-    if (labels.some(x => x.predicate.equals(namespaces_1.ns.oslo('apLabel')))) {
-        return (_a = labels
-            .find(x => x.predicate.equals(namespaces_1.ns.oslo('apLabel')) &&
-            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object;
+    if (labels.some((x) => x.predicate.equals(namespaces_1.ns.oslo('apLabel')))) {
+        return ((_a = labels.find((x) => x.predicate.equals(namespaces_1.ns.oslo('apLabel')) &&
+            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object);
     }
-    if (labels.some(x => x.predicate.equals(namespaces_1.ns.oslo('vocLabel')))) {
-        return (_b = labels.find(x => x.predicate.equals(namespaces_1.ns.oslo('vocLabel')) &&
-            x.object.language === (language || ''))) === null || _b === void 0 ? void 0 : _b.object;
+    if (labels.some((x) => x.predicate.equals(namespaces_1.ns.oslo('vocLabel')))) {
+        return ((_b = labels.find((x) => x.predicate.equals(namespaces_1.ns.oslo('vocLabel')) &&
+            x.object.language === (language || ''))) === null || _b === void 0 ? void 0 : _b.object);
     }
-    return (_c = labels.find(x => x.predicate.equals(namespaces_1.ns.oslo('diagramLabel')))) === null || _c === void 0 ? void 0 : _c.object;
+    return ((_c = labels.find((x) => x.predicate.equals(namespaces_1.ns.oslo('diagramLabel')))) === null || _c === void 0 ? void 0 : _c.object);
 }
 exports.getApplicationProfileLabel = getApplicationProfileLabel;
 function getVocabularyLabel(subject, store, language = null) {
     var _a, _b;
     const labels = store.getLabels(subject);
-    if (labels.some(x => x.predicate.equals(namespaces_1.ns.oslo('vocLabel')))) {
-        return (_a = labels
-            .find(x => x.predicate.equals(namespaces_1.ns.oslo('vocLabel')) &&
-            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object;
+    if (labels.some((x) => x.predicate.equals(namespaces_1.ns.oslo('vocLabel')))) {
+        return ((_a = labels.find((x) => x.predicate.equals(namespaces_1.ns.oslo('vocLabel')) &&
+            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object);
     }
-    return (_b = labels.find(x => x.predicate.equals(namespaces_1.ns.oslo('diagramLabel')))) === null || _b === void 0 ? void 0 : _b.object;
+    return ((_b = labels.find((x) => x.predicate.equals(namespaces_1.ns.oslo('diagramLabel')))) === null || _b === void 0 ? void 0 : _b.object);
 }
 exports.getVocabularyLabel = getVocabularyLabel;
 function getApplicationProfileDefinition(subject, store, language = null) {
     var _a, _b;
     const definitions = store.getDefinitions(subject);
-    if (definitions.some(x => x.predicate.equals(namespaces_1.ns.oslo('apDefinition')))) {
-        return (_a = definitions
-            .find(x => x.predicate.equals(namespaces_1.ns.oslo('apDefinition')) &&
-            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object;
+    if (definitions.some((x) => x.predicate.equals(namespaces_1.ns.oslo('apDefinition')))) {
+        return ((_a = definitions.find((x) => x.predicate.equals(namespaces_1.ns.oslo('apDefinition')) &&
+            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object);
     }
-    if (definitions.some(x => x.predicate.equals(namespaces_1.ns.oslo('vocDefinition')))) {
-        return (_b = definitions
-            .find(x => x.predicate.equals(namespaces_1.ns.oslo('vocDefinition')) &&
-            x.object.language === (language || ''))) === null || _b === void 0 ? void 0 : _b.object;
+    if (definitions.some((x) => x.predicate.equals(namespaces_1.ns.oslo('vocDefinition')))) {
+        return ((_b = definitions.find((x) => x.predicate.equals(namespaces_1.ns.oslo('vocDefinition')) &&
+            x.object.language === (language || ''))) === null || _b === void 0 ? void 0 : _b.object);
     }
     return undefined;
 }
@@ -47,10 +43,9 @@ exports.getApplicationProfileDefinition = getApplicationProfileDefinition;
 function getVocabularyDefinition(subject, store, language = null) {
     var _a;
     const definitions = store.getDefinitions(subject);
-    if (definitions.some(x => x.predicate.equals(namespaces_1.ns.oslo('vocDefinition')))) {
-        return (_a = definitions
-            .find(x => x.predicate.equals(namespaces_1.ns.oslo('vocDefinition')) &&
-            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object;
+    if (definitions.some((x) => x.predicate.equals(namespaces_1.ns.oslo('vocDefinition')))) {
+        return ((_a = definitions.find((x) => x.predicate.equals(namespaces_1.ns.oslo('vocDefinition')) &&
+            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object);
     }
     return undefined;
 }
@@ -58,15 +53,13 @@ exports.getVocabularyDefinition = getVocabularyDefinition;
 function getApplicationProfileUsageNote(subject, store, language = null) {
     var _a, _b;
     const usageNotes = store.getUsageNotes(subject);
-    if (usageNotes.some(x => x.predicate.equals(namespaces_1.ns.oslo('apUsageNote')))) {
-        return (_a = usageNotes
-            .find(x => x.predicate.equals(namespaces_1.ns.oslo('apUsageNote')) &&
-            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object;
+    if (usageNotes.some((x) => x.predicate.equals(namespaces_1.ns.oslo('apUsageNote')))) {
+        return ((_a = usageNotes.find((x) => x.predicate.equals(namespaces_1.ns.oslo('apUsageNote')) &&
+            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object);
     }
-    if (usageNotes.some(x => x.predicate.equals(namespaces_1.ns.oslo('vocUsageNote')))) {
-        return (_b = usageNotes
-            .find(x => x.predicate.equals(namespaces_1.ns.oslo('vocUsageNote')) &&
-            x.object.language === (language || ''))) === null || _b === void 0 ? void 0 : _b.object;
+    if (usageNotes.some((x) => x.predicate.equals(namespaces_1.ns.oslo('vocUsageNote')))) {
+        return ((_b = usageNotes.find((x) => x.predicate.equals(namespaces_1.ns.oslo('vocUsageNote')) &&
+            x.object.language === (language || ''))) === null || _b === void 0 ? void 0 : _b.object);
     }
     return undefined;
 }
@@ -74,10 +67,9 @@ exports.getApplicationProfileUsageNote = getApplicationProfileUsageNote;
 function getVocabularyUsageNote(subject, store, language = null) {
     var _a;
     const usageNotes = store.getUsageNotes(subject);
-    if (usageNotes.some(x => x.predicate.equals(namespaces_1.ns.oslo('vocUsageNote')))) {
-        return (_a = usageNotes
-            .find(x => x.predicate.equals(namespaces_1.ns.oslo('vocUsageNote')) &&
-            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object;
+    if (usageNotes.some((x) => x.predicate.equals(namespaces_1.ns.oslo('vocUsageNote')))) {
+        return ((_a = usageNotes.find((x) => x.predicate.equals(namespaces_1.ns.oslo('vocUsageNote')) &&
+            x.object.language === (language || ''))) === null || _a === void 0 ? void 0 : _a.object);
     }
     return undefined;
 }
@@ -92,4 +84,48 @@ function getMaxCount(subject, store) {
     return (_a = store.findObject(subject, namespaces_1.ns.shacl('maxCount'))) === null || _a === void 0 ? void 0 : _a.value;
 }
 exports.getMaxCount = getMaxCount;
+function createList(items, store, df) {
+    const list = [df.blankNode()];
+    const quads = [];
+    /* Empty list has a single NamedNode RDF:nil */
+    if (items.length === 0)
+        return df.namedNode(namespaces_1.ns.rdf('nil'));
+    items.forEach((entry, index) => {
+        const subject = list[index];
+        const object = entry;
+        /* Items must be identifiers */
+        if (object.termType !== 'NamedNode' && object.termType !== 'BlankNode')
+            return;
+        /* Current list item */
+        quads.push(df.quad(subject, namespaces_1.ns.rdf('first'), object));
+        if (index === items.length - 1) {
+            /* End of list */
+            quads.push(df.quad(subject, namespaces_1.ns.rdf('rest'), namespaces_1.ns.rdf('nil')));
+        }
+        else {
+            /* Next item of the list */
+            list.push(df.blankNode());
+            const nextSubject = list[index + 1];
+            /* Items must be identifiers */
+            if (nextSubject.termType !== 'BlankNode')
+                return;
+            quads.push(df.quad(subject, namespaces_1.ns.rdf('rest'), nextSubject));
+        }
+    });
+    store.addQuads(quads);
+    return list[0];
+}
+exports.createList = createList;
+function findAllAttributes(subject, attributeIds, store) {
+    const parentIds = store.findObjects(subject, namespaces_1.ns.rdfs('subClassOf'));
+    attributeIds = [
+        ...attributeIds,
+        ...store.findSubjects(namespaces_1.ns.rdfs('domain'), subject),
+    ];
+    for (const parentId of parentIds) {
+        attributeIds = findAllAttributes(parentId, attributeIds, store);
+    }
+    return attributeIds;
+}
+exports.findAllAttributes = findAllAttributes;
 //# sourceMappingURL=storeUtils.js.map

package/lib/utils/strings.d.ts

@@ -0,0 +1,2 @@
+export declare function toPascalCase(text: string): string;
+export declare function toCamelCase(text: string): string;

package/lib/utils/strings.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCamelCase = exports.toPascalCase = void 0;
+function removeCaret(text) {
+    return text.replace(/^\^/u, '');
+}
+function toPascalCase(text) {
+    return removeCaret(text)
+        .replace(/(?:^\w|[A-Z]|\b\w)/gu, (word, index) => word.toUpperCase())
+        .replace(/\s+/gu, '');
+}
+exports.toPascalCase = toPascalCase;
+function toCamelCase(text) {
+    return removeCaret(text)
+        .replace(/(?:^\w|[A-Z]|\b\w)/gu, (word, index) => index === 0 ? word.toLowerCase() : word.toUpperCase())
+        .replace(/\s+/gu, '');
+}
+exports.toCamelCase = toCamelCase;
+//# sourceMappingURL=strings.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oslo-flanders/core",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "Core interfaces and utilities",
   "author": "Digitaal Vlaanderen <https://data.vlaanderen.be/id/organisatie/OVO002949>",
   "homepage": "https://github.com/informatievlaanderen/OSLO-UML-Transformer/tree/main/packages/oslo-core#readme",
@@ -33,10 +33,10 @@
     "crypto-js": "^4.1.1",
     "inversify": "^6.0.1",
     "n3": "^1.16.2",
-    "node-fetch": "^2.6.7",
     "rdf-data-factory": "^1.1.1",
     "rdf-parse": "^2.1.1",
     "reflect-metadata": "^0.1.13",
+    "node-fetch": "^2.6.7",
     "streamify-string": "^1.0.1",
     "winston": "^3.8.2",
     "winston-transport": "^4.5.0"