@shrkcrft/knowledge 0.1.0-alpha.1

package/dist/validate/validate-knowledge-entries.js

@@ -0,0 +1,101 @@
+import { isValidKnowledgeId } from '@shrkcrft/core';
+import { ALL_KNOWLEDGE_TYPES } from "../model/knowledge-type.js";
+import { KnowledgePriority } from "../model/knowledge-priority.js";
+const VALID_PRIORITIES = new Set(Object.values(KnowledgePriority));
+const VALID_TYPES = new Set(ALL_KNOWLEDGE_TYPES);
+/**
+ * Validate a list of knowledge entries. Catches the classic problems:
+ *   - missing or malformed id
+ *   - duplicate ids (warning — first occurrence wins)
+ *   - missing title/content/type
+ *   - unknown type (warning — custom types are allowed but get flagged)
+ *   - unknown priority (error)
+ */
+export function validateKnowledgeEntries(entries) {
+    const issues = [];
+    const seen = new Map();
+    const uniqueEntries = [];
+    for (const entry of entries) {
+        const id = typeof entry.id === 'string' ? entry.id : '';
+        const source = entry.source?.origin;
+        if (!id) {
+            issues.push({
+                code: 'missing-id',
+                entryId: '?',
+                source,
+                message: 'Knowledge entry is missing an `id`.',
+                severity: 'error',
+            });
+            continue;
+        }
+        if (!isValidKnowledgeId(id)) {
+            issues.push({
+                code: 'invalid-id-format',
+                entryId: id,
+                source,
+                message: `Entry id "${id}" does not match /^[a-z0-9]+([.-][a-z0-9]+)*$/`,
+                severity: 'error',
+            });
+            continue;
+        }
+        if (!entry.title) {
+            issues.push({
+                code: 'missing-title',
+                entryId: id,
+                source,
+                message: `Entry "${id}" is missing a title.`,
+                severity: 'error',
+            });
+        }
+        if (typeof entry.content !== 'string') {
+            issues.push({
+                code: 'missing-content',
+                entryId: id,
+                source,
+                message: `Entry "${id}" is missing content.`,
+                severity: 'error',
+            });
+        }
+        if (!entry.type) {
+            issues.push({
+                code: 'missing-type',
+                entryId: id,
+                source,
+                message: `Entry "${id}" is missing a type.`,
+                severity: 'error',
+            });
+        }
+        else if (!VALID_TYPES.has(String(entry.type)) && entry.type !== 'custom') {
+            issues.push({
+                code: 'invalid-type',
+                entryId: id,
+                source,
+                message: `Entry "${id}" uses unknown type "${entry.type}". Use KnowledgeType or set type:'custom'.`,
+                severity: 'warning',
+            });
+        }
+        if (entry.priority && !VALID_PRIORITIES.has(String(entry.priority))) {
+            issues.push({
+                code: 'invalid-priority',
+                entryId: id,
+                source,
+                message: `Entry "${id}" has invalid priority "${entry.priority}". Allowed: critical|high|medium|low.`,
+                severity: 'error',
+            });
+        }
+        if (seen.has(id)) {
+            issues.push({
+                code: 'duplicate-id',
+                entryId: id,
+                source,
+                message: `Duplicate knowledge id "${id}" — first occurrence wins, later ones ignored.`,
+                severity: 'warning',
+            });
+            continue;
+        }
+        seen.set(id, entry);
+        uniqueEntries.push(entry);
+    }
+    const hasErrors = issues.some((i) => i.severity === 'error');
+    return { valid: !hasErrors, issues, uniqueEntries };
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@shrkcrft/knowledge",
+  "version": "0.1.0-alpha.1",
+  "description": "SharkCraft structured knowledge model: typed entries, index, search, loaders (TS + markdown), validation.",
+  "license": "MIT",
+  "author": "SharkCraft contributors",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sharkcraft/sharkcraft.git",
+    "directory": "packages/knowledge"
+  },
+  "homepage": "https://github.com/sharkcraft/sharkcraft",
+  "bugs": {
+    "url": "https://github.com/sharkcraft/sharkcraft/issues"
+  },
+  "keywords": [
+    "sharkcraft",
+    "knowledge",
+    "rules",
+    "retrieval",
+    "ai"
+  ],
+  "engines": {
+    "bun": ">=1.1.0",
+    "node": ">=18"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  },
+  "dependencies": {
+    "@shrkcrft/core": "^0.1.0-alpha.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}