@iqb/validate-md-profile 0.1.0

package/README.md

@@ -0,0 +1,2 @@
+# profiles
+Type definitions for metadata profiles

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./validate-md-profile";

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./validate-md-profile"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/dist/md-profile.schema.json

@@ -0,0 +1,204 @@
+{
+  "$id": "https://w3id.org/iqb/vocabs/md-profile.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Metadata Profile",
+  "description": "Data structure to manage UI components for metadata of objects",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Identifier for the metadata profile"
+    },
+    "label": {
+      "$ref": "#/definitions/multi_language_text",
+      "description": "Name of the profile"
+    },
+    "groups": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "label": {
+            "$ref": "#/definitions/multi_language_text"
+          },
+          "entries": {
+            "type": "array",
+            "items": {
+              "$ref": "#/definitions/entry"
+            },
+            "minItems": 1
+          }
+        },
+        "required": ["label", "entries"]
+      },
+      "minItems": 1
+    }
+  },
+  "required": ["id", "label", "groups"],
+  "definitions": {
+    "multi_language_text": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "lang": {
+            "type": "string",
+            "description": "ISO-language code",
+            "pattern": "^[a-z]{2}$"
+          },
+          "value": {
+            "type": "string"
+          }
+        },
+        "required": ["lang", "value"]
+      },
+      "minItems": 1
+    },
+    "vocabulary": {
+      "type": "object",
+      "description": "Creates values of type string (one possible id), string[] (multiple ids) or id+text tuples, if text input is allowed (see md-values).",
+      "properties": {
+        "url": {
+          "type": "string",
+          "description": "URI to the JSON representation (SkoHub) of the vocabulary definition"
+        },
+        "allowMultipleValues": {
+          "type": "boolean",
+          "description": "If true, multiple values are allowed taken from the vocabulary",
+          "default": false
+        },
+        "maxLevel": {
+          "type": "integer",
+          "description": "Maximum level taken from the hierarchical vocabulary. This is to hide lower levels. Use '0' for all levels (default).",
+          "default": 0
+        },
+        "hideNumbering": {
+          "type": "boolean",
+          "description": "If true, the numbering of vocabulary entries is not used/showed in components.",
+          "default": false
+        },
+        "hideDescription": {
+          "type": "boolean",
+          "description": "If true, the description of vocabulary entries is not used/showed in components.",
+          "default": false
+        },
+        "hideTitle": {
+          "type": "boolean",
+          "description": "If true, the title of vocabulary entries is not used/showed in components.",
+          "default": false
+        },
+        "addTextLanguages": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "description": "ISO-language code",
+            "pattern": "^[a-z]{2}$"
+          },
+          "description": "If not empty, text can be added to the selected vocabulary entry. The given entries specify the expected language(s).",
+          "default": []
+        }
+      },
+      "required": ["url"]
+    },
+    "text": {
+      "type": "object",
+      "description": "Creates values of type string (one possible language) or multi-language texts (see md-values).",
+      "properties": {
+        "format": {
+          "type": "string",
+          "enum": ["single", "multiline", "html"],
+          "description": "If true, more then one line of text is prepared for input. Text is wrapped and vertical scrolling is possible.",
+          "default": "single"
+        },
+        "textLanguages": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "description": "ISO-language code",
+            "pattern": "^[a-z]{2}$"
+          },
+          "description": "Use this property to add languages, so you provide more then one text input form field.",
+          "default": [
+            "de"
+          ]
+        },
+        "pattern": {
+          "type": "string",
+          "description": "Use this regular expression to validate the input value."
+        }
+      }
+    },
+    "number": {
+      "type": "object",
+      "description": "Creates values of type string with number content. The decimal separator is always dot '.'.",
+      "properties": {
+        "digits": {
+          "type": "integer",
+          "description": "Number of digits. Negative values are not valid.",
+          "minimum": 0,
+          "default": 0
+        },
+        "minValue": {
+          "type": "number",
+          "description": "Minimal value valid for this entry."
+        },
+        "maxValue": {
+          "type": "number",
+          "description": "Maximal value valid for this entry."
+        },
+        "isPeriodSeconds": {
+          "type": "boolean",
+          "description": "If true, the (integer) value is interpreted as a number of seconds (duration, time period). This might adapt the form controls.",
+          "default": false
+        }
+      }
+    },
+    "boolean": {
+      "type": "object",
+      "description": "Creates values of type string 'true' or 'false'.",
+      "properties": {
+        "trueLabel": {
+          "$ref": "#/definitions/multi_language_text"
+        },
+        "falseLabel": {
+          "$ref": "#/definitions/multi_language_text"
+        }
+      }
+    },
+    "entry": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[a-zA-Z][0-9a-zA-Z_]*$",
+          "description": "Identifier for the property as part of the metadata profile"
+        },
+        "label": {
+          "$ref": "#/definitions/multi_language_text",
+          "description": "Text presented in UI components as prompt"
+        },
+        "type": {
+          "type": "string",
+          "enum": ["text", "vocabulary", "boolean", "number"]
+        },
+        "parameters": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/vocabulary"
+            },
+            {
+              "$ref": "#/definitions/text"
+            },
+            {
+              "$ref": "#/definitions/number"
+            },
+            {
+              "$ref": "#/definitions/boolean"
+            }
+          ]
+        }
+      },
+      "required": ["id", "type"]
+    }
+  }
+}

package/dist/validate-md-profile.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/validate-md-profile.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var ajv_1 = require("ajv");
+var fs = require('fs');
+var schemaFilename = 'md-profile.schema.json';
+var fileToCheckName = './profile.json';
+var schema = null;
+if (process.argv[2]) {
+    fileToCheckName = "./".concat(process.argv[2]);
+}
+if (!fs.existsSync(fileToCheckName)) {
+    console.log("\u001B[0;31mERROR\u001B[0m profile file '".concat(fileToCheckName, "' not found"));
+    process.exitCode = 1;
+}
+else {
+    var schemaFullFilename = "".concat(__dirname, "/").concat(schemaFilename);
+    if (!fs.existsSync(schemaFullFilename)) {
+        schemaFullFilename = "./json_schema/md-profile/".concat(schemaFilename);
+    }
+    if (!fs.existsSync(schemaFullFilename)) {
+        console.log("\u001B[0;31mERROR\u001B[0m profile file '".concat(schemaFilename, "' not found"));
+        process.exitCode = 1;
+    }
+    else {
+        try {
+            schema = fs.readFileSync(schemaFullFilename, 'utf8');
+        }
+        catch (err) {
+            console.log("\u001B[0;31mERROR\u001B[0m reading schema '".concat(schemaFilename, "':"));
+            console.error(err);
+            process.exitCode = 1;
+            schema = null;
+        }
+    }
+}
+if (schema) {
+    var compiledSchema = void 0;
+    var ajv = new ajv_1.default(); // options can be passed, e.g. {allErrors: true}
+    try {
+        compiledSchema = ajv.compile(JSON.parse(schema));
+    }
+    catch (err) {
+        console.log("\u001B[0;31mERROR\u001B[0m parsing schema '".concat(schemaFilename, "':"));
+        console.error(err);
+        process.exitCode = 1;
+        compiledSchema = null;
+    }
+    if (compiledSchema) {
+        var profileData = void 0;
+        try {
+            var profile_data_raw = fs.readFileSync(fileToCheckName, 'utf8');
+            profileData = JSON.parse(profile_data_raw);
+        }
+        catch (err) {
+            console.log("\u001B[0;31mERROR\u001B[0m reading and parsing config file '".concat(fileToCheckName, "':"));
+            console.error(err);
+            profileData = null;
+            process.exitCode = 1;
+        }
+        if (profileData) {
+            try {
+                var valid = compiledSchema ? compiledSchema(profileData) : null;
+                if (valid) {
+                    console.log("'".concat(fileToCheckName, "' is valid"));
+                }
+                else {
+                    console.log("\u001B[0;31mERROR\u001B[0m invalid profile file '".concat(fileToCheckName, "':"));
+                    console.error(compiledSchema ? compiledSchema.errors : 'error unknown');
+                    profileData = null;
+                    process.exitCode = 1;
+                }
+            }
+            catch (err) {
+                console.log("\u001B[0;31mERROR\u001B[0m invalid profile file '".concat(fileToCheckName, "':"));
+                console.error(err);
+                profileData = null;
+                process.exitCode = 1;
+            }
+        }
+    }
+}
+//# sourceMappingURL=validate-md-profile.js.map

package/dist/validate-md-profile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-md-profile.js","sourceRoot":"","sources":["../src/validate-md-profile.ts"],"names":[],"mappings":";;AAAA,2BAAsB;AAEtB,IAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACzB,IAAM,cAAc,GAAG,wBAAwB,CAAC;AAChD,IAAI,eAAe,GAAG,gBAAgB,CAAC;AACvC,IAAI,MAAM,GAAG,IAAI,CAAC;AAClB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;IACjB,eAAe,GAAG,YAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,CAAC;CAC5C;AACD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;IACjC,OAAO,CAAC,GAAG,CAAC,mDAAwC,eAAe,gBAAa,CAAC,CAAC;IAClF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;CACxB;KAAM;IACH,IAAI,kBAAkB,GAAG,UAAG,SAAS,cAAI,cAAc,CAAE,CAAC;IAC1D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE;QACpC,kBAAkB,GAAG,mCAA4B,cAAc,CAAE,CAAC;KACrE;IACD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE;QACpC,OAAO,CAAC,GAAG,CAAC,mDAAwC,cAAc,gBAAa,CAAC,CAAC;QACjF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;KACxB;SAAM;QACH,IAAI;YACA,MAAM,GAAG,EAAE,CAAC,YAAY,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;SACxD;QAAC,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,GAAG,CAAC,qDAA0C,cAAc,OAAI,CAAC,CAAC;YAC1E,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,MAAM,GAAG,IAAI,CAAC;SACjB;KACJ;CACJ;AAED,IAAI,MAAM,EAAE;IACR,IAAI,cAAc,SAAA,CAAC;IACnB,IAAM,GAAG,GAAG,IAAI,aAAG,EAAE,CAAA,CAAC,gDAAgD;IACtE,IAAI;QACA,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;KACnD;IAAC,OAAO,GAAG,EAAE;QACV,OAAO,CAAC,GAAG,CAAC,qDAA0C,cAAc,OAAI,CAAC,CAAC;QAC1E,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrB,cAAc,GAAG,IAAI,CAAC;KACzB;IACD,IAAI,cAAc,EAAE;QAChB,IAAI,WAAW,SAAA,CAAC;QAChB,IAAI;YACA,IAAM,gBAAgB,GAAG,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;YAClE,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;SAC9C;QAAC,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,GAAG,CAAC,sEAA2D,eAAe,OAAI,CAAC,CAAC;YAC5F,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,WAAW,GAAG,IAAI,CAAC;YACnB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;SACxB;QACD,IAAI,WAAW,EAAE;YACb,IAAI;gBACA,IAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAClE,IAAI,KAAK,EAAE;oBACP,OAAO,CAAC,GAAG,CAAC,WAAI,eAAe,eAAY,CAAC,CAAC;iBAChD;qBAAM;oBACH,OAAO,CAAC,GAAG,CAAC,2DAAgD,eAAe,OAAI,CAAC,CAAC;oBACjF,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAA;oBACvE,WAAW,GAAG,IAAI,CAAC;oBACnB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;iBACxB;aACJ;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO,CAAC,GAAG,CAAC,2DAAgD,eAAe,OAAI,CAAC,CAAC;gBACjF,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnB,WAAW,GAAG,IAAI,CAAC;gBACnB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;aACxB;SACJ;KACJ;CACJ"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@iqb/validate-md-profile",
+  "version": "0.1.0",
+  "author": "IQB - Institut zur Qualitätsentwicklung im Bildungswesen",
+  "license": "MIT",
+  "description": "Data interfaces for metadata profiling and values",
+  "scripts": {
+    "test_profile": "ts-node ./test.ts md-profile",
+    "test_value": "ts-node ./test.ts md-values",
+    "validate_profile": "ts-node src/validate-md-profile.ts json_schema/md-profile/test_valid/sample_1.json",
+    "generate_docs": "asyncapi generate fromTemplate json_schema/asyncapi.yaml @asyncapi/html-template -o ./public --force-write && cat json_schema/add.css >> ./public/css/global.min.css",
+    "prepare_publish": "rm -rf dist/* && tsc && cp ./json_schema/md-profile/md-profile.schema.json ./dist",
+    "npm_publish": "npm publish --access public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/iqb-vocabs/profiles.git"
+  },
+  "bugs": {
+    "url": "https://github.com/iqb-vocabs/profiles/issues"
+  },
+  "homepage": "https://github.com/iqb-vocabs/profiles#readme",
+  "dependencies": {
+    "ajv": "^8.12.0"
+  },
+  "devDependencies": {
+    "@asyncapi/cli": "^0.58.10",
+    "@asyncapi/html-template": "^1.0.0",
+    "@types/node": "^20.4.4",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
+  },
+  "bin": {
+    "validate-md-profile": "./dist/validate-md-profile.js"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./validate-md-profile";

package/src/validate-md-profile.ts

@@ -0,0 +1,74 @@
+import Ajv from "ajv";
+
+const fs = require('fs');
+const schemaFilename = 'md-profile.schema.json';
+let fileToCheckName = './profile.json';
+let schema = null;
+if (process.argv[2]) {
+    fileToCheckName = `./${process.argv[2]}`;
+}
+if (!fs.existsSync(fileToCheckName)) {
+    console.log(`\x1b[0;31mERROR\x1b[0m profile file '${fileToCheckName}' not found`);
+    process.exitCode = 1;
+} else {
+    let schemaFullFilename = `${__dirname}/${schemaFilename}`;
+    if (!fs.existsSync(schemaFullFilename)) {
+        schemaFullFilename = `./json_schema/md-profile/${schemaFilename}`;
+    }
+    if (!fs.existsSync(schemaFullFilename)) {
+        console.log(`\x1b[0;31mERROR\x1b[0m profile file '${schemaFilename}' not found`);
+        process.exitCode = 1;
+    } else {
+        try {
+            schema = fs.readFileSync(schemaFullFilename, 'utf8');
+        } catch (err) {
+            console.log(`\x1b[0;31mERROR\x1b[0m reading schema '${schemaFilename}':`);
+            console.error(err);
+            process.exitCode = 1;
+            schema = null;
+        }
+    }
+}
+
+if (schema) {
+    let compiledSchema;
+    const ajv = new Ajv() // options can be passed, e.g. {allErrors: true}
+    try {
+        compiledSchema = ajv.compile(JSON.parse(schema))
+    } catch (err) {
+        console.log(`\x1b[0;31mERROR\x1b[0m parsing schema '${schemaFilename}':`);
+        console.error(err);
+        process.exitCode = 1;
+        compiledSchema = null;
+    }
+    if (compiledSchema) {
+        let profileData;
+        try {
+            const profile_data_raw = fs.readFileSync(fileToCheckName, 'utf8');
+            profileData = JSON.parse(profile_data_raw);
+        } catch (err) {
+            console.log(`\x1b[0;31mERROR\x1b[0m reading and parsing config file '${fileToCheckName}':`);
+            console.error(err);
+            profileData = null;
+            process.exitCode = 1;
+        }
+        if (profileData) {
+            try {
+                const valid = compiledSchema ? compiledSchema(profileData) : null;
+                if (valid) {
+                    console.log(`'${fileToCheckName}' is valid`);
+                } else {
+                    console.log(`\x1b[0;31mERROR\x1b[0m invalid profile file '${fileToCheckName}':`);
+                    console.error(compiledSchema ? compiledSchema.errors : 'error unknown')
+                    profileData = null;
+                    process.exitCode = 1;
+                }
+            } catch (err) {
+                console.log(`\x1b[0;31mERROR\x1b[0m invalid profile file '${fileToCheckName}':`);
+                console.error(err);
+                profileData = null;
+                process.exitCode = 1;
+            }
+        }
+    }
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "strictNullChecks": true,
+    "strict": true,
+    "target": "es5",
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "dist",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "lib": ["es2015", "dom", "es2021"],
+    "rootDir": "src",
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}