@jamesaphoenix/tx-core 0.5.4 → 0.5.6

package/dist/utils/ears-validator.js

@@ -0,0 +1,170 @@
+import { EARS_PATTERNS } from "@jamesaphoenix/tx-types";
+const EARS_ID_PATTERN = /^EARS-[A-Z0-9]+-\d{3}$/;
+const EARS_PRIORITIES = ["must", "should", "could", "wont"];
+const validPatternSet = new Set(EARS_PATTERNS);
+const validPrioritySet = new Set(EARS_PRIORITIES);
+const asRecord = (value) => {
+    if (typeof value !== "object" || value === null || Array.isArray(value)) {
+        return null;
+    }
+    return value;
+};
+const pickString = (obj, key) => {
+    const value = obj[key];
+    return typeof value === "string" ? value.trim() : null;
+};
+const requiredPatternField = (pattern) => {
+    switch (pattern) {
+        case "event_driven":
+            return "trigger";
+        case "state_driven":
+            return "state";
+        case "unwanted":
+            return "condition";
+        case "optional":
+            return "feature";
+        default:
+            return null;
+    }
+};
+export const validateEarsRequirements = (requirements) => {
+    const errors = [];
+    const seenIds = new Set();
+    requirements.forEach((entry, index) => {
+        const req = asRecord(entry);
+        if (!req) {
+            errors.push({
+                index,
+                id: null,
+                field: "ears_requirements",
+                code: "invalid_type",
+                message: "Each EARS requirement must be an object.",
+            });
+            return;
+        }
+        const id = pickString(req, "id");
+        const pattern = pickString(req, "pattern");
+        const system = pickString(req, "system");
+        const response = pickString(req, "response");
+        const priority = pickString(req, "priority");
+        if (!id) {
+            errors.push({
+                index,
+                id: null,
+                field: "id",
+                code: "missing_required",
+                message: "Field 'id' is required.",
+            });
+        }
+        else {
+            if (!EARS_ID_PATTERN.test(id)) {
+                errors.push({
+                    index,
+                    id,
+                    field: "id",
+                    code: "invalid_format",
+                    message: "Field 'id' must match EARS-<SYSTEM>-NNN (e.g. EARS-FL-001).",
+                });
+            }
+            if (seenIds.has(id)) {
+                errors.push({
+                    index,
+                    id,
+                    field: "id",
+                    code: "duplicate_id",
+                    message: `Duplicate EARS requirement id '${id}'.`,
+                });
+            }
+            else {
+                seenIds.add(id);
+            }
+        }
+        if (!pattern) {
+            errors.push({
+                index,
+                id,
+                field: "pattern",
+                code: "missing_required",
+                message: "Field 'pattern' is required.",
+            });
+        }
+        else if (!validPatternSet.has(pattern)) {
+            errors.push({
+                index,
+                id,
+                field: "pattern",
+                code: "invalid_value",
+                message: `Invalid EARS pattern '${pattern}'. Valid patterns: ${EARS_PATTERNS.join(", ")}.`,
+            });
+        }
+        if (!system) {
+            errors.push({
+                index,
+                id,
+                field: "system",
+                code: "missing_required",
+                message: "Field 'system' is required.",
+            });
+        }
+        if (!response) {
+            errors.push({
+                index,
+                id,
+                field: "response",
+                code: "missing_required",
+                message: "Field 'response' is required.",
+            });
+        }
+        if (priority && !validPrioritySet.has(priority)) {
+            errors.push({
+                index,
+                id,
+                field: "priority",
+                code: "invalid_value",
+                message: `Invalid priority '${priority}'. Valid priorities: ${EARS_PRIORITIES.join(", ")}.`,
+            });
+        }
+        if (pattern && validPatternSet.has(pattern)) {
+            const requiredField = requiredPatternField(pattern);
+            if (requiredField) {
+                const requiredValue = pickString(req, requiredField);
+                if (!requiredValue) {
+                    errors.push({
+                        index,
+                        id,
+                        field: requiredField,
+                        code: "missing_required",
+                        message: `Pattern '${pattern}' requires field '${requiredField}'.`,
+                    });
+                }
+            }
+            if (pattern === "complex") {
+                const hasClause = Boolean(pickString(req, "trigger")) ||
+                    Boolean(pickString(req, "state")) ||
+                    Boolean(pickString(req, "condition")) ||
+                    Boolean(pickString(req, "feature"));
+                if (!hasClause) {
+                    errors.push({
+                        index,
+                        id,
+                        field: "pattern",
+                        code: "missing_required",
+                        message: "Pattern 'complex' requires at least one clause: trigger, state, condition, or feature.",
+                    });
+                }
+            }
+        }
+    });
+    return errors;
+};
+export const formatEarsValidationErrors = (errors) => {
+    return errors
+        .map((error) => {
+        const location = error.id
+            ? `${error.id}`
+            : `entry #${error.index + 1}`;
+        return `${location} (${error.field}): ${error.message}`;
+    })
+        .join("; ");
+};
+//# sourceMappingURL=ears-validator.js.map

package/dist/utils/ears-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ears-validator.js","sourceRoot":"","sources":["../../src/utils/ears-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAEvD,MAAM,eAAe,GAAG,wBAAwB,CAAA;AAChD,MAAM,eAAe,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAU,CAAA;AAEpE,MAAM,eAAe,GAAG,IAAI,GAAG,CAAS,aAAa,CAAC,CAAA;AACtD,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAS,eAAe,CAAC,CAAA;AAiBzD,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAkC,EAAE;IAClE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxE,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,KAAgC,CAAA;AACzC,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,CAAC,GAA4B,EAAE,GAAW,EAAiB,EAAE;IAC9E,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAA;IACtB,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACxD,CAAC,CAAA;AAED,MAAM,oBAAoB,GAAG,CAAC,OAAoB,EAAiB,EAAE;IACnE,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,cAAc;YACjB,OAAO,SAAS,CAAA;QAClB,KAAK,cAAc;YACjB,OAAO,OAAO,CAAA;QAChB,KAAK,UAAU;YACb,OAAO,WAAW,CAAA;QACpB,KAAK,UAAU;YACb,OAAO,SAAS,CAAA;QAClB;YACE,OAAO,IAAI,CAAA;IACf,CAAC;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,YAAgC,EACT,EAAE;IACzB,MAAM,MAAM,GAA0B,EAAE,CAAA;IACxC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAA;IAEjC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACpC,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;QAC3B,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK;gBACL,EAAE,EAAE,IAAI;gBACR,KAAK,EAAE,mBAAmB;gBAC1B,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,0CAA0C;aACpD,CAAC,CAAA;YACF,OAAM;QACR,CAAC;QAED,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;QAChC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;QAC1C,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;QACxC,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QAC5C,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QAE5C,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK;gBACL,EAAE,EAAE,IAAI;gBACR,KAAK,EAAE,IAAI;gBACX,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,yBAAyB;aACnC,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC;oBACV,KAAK;oBACL,EAAE;oBACF,KAAK,EAAE,IAAI;oBACX,IAAI,EAAE,gBAAgB;oBACtB,OAAO,EAAE,6DAA6D;iBACvE,CAAC,CAAA;YACJ,CAAC;YACD,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBACpB,MAAM,CAAC,IAAI,CAAC;oBACV,KAAK;oBACL,EAAE;oBACF,KAAK,EAAE,IAAI;oBACX,IAAI,EAAE,cAAc;oBACpB,OAAO,EAAE,kCAAkC,EAAE,IAAI;iBAClD,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YACjB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK;gBACL,EAAE;gBACF,KAAK,EAAE,SAAS;gBAChB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,8BAA8B;aACxC,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACzC,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK;gBACL,EAAE;gBACF,KAAK,EAAE,SAAS;gBAChB,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,yBAAyB,OAAO,sBAAsB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;aAC3F,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK;gBACL,EAAE;gBACF,KAAK,EAAE,QAAQ;gBACf,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,6BAA6B;aACvC,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK;gBACL,EAAE;gBACF,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,+BAA+B;aACzC,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,QAAQ,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC;gBACV,KAAK;gBACL,EAAE;gBACF,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,qBAAqB,QAAQ,wBAAwB,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;aAC5F,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,OAAO,IAAI,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5C,MAAM,aAAa,GAAG,oBAAoB,CAAC,OAAsB,CAAC,CAAA;YAClE,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;gBACpD,IAAI,CAAC,aAAa,EAAE,CAAC;oBACnB,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK;wBACL,EAAE;wBACF,KAAK,EAAE,aAAa;wBACpB,IAAI,EAAE,kBAAkB;wBACxB,OAAO,EAAE,YAAY,OAAO,qBAAqB,aAAa,IAAI;qBACnE,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;YAED,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,MAAM,SAAS,GACb,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;oBACnC,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;oBACjC,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;oBACrC,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAA;gBACrC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK;wBACL,EAAE;wBACF,KAAK,EAAE,SAAS;wBAChB,IAAI,EAAE,kBAAkB;wBACxB,OAAO,EACL,wFAAwF;qBAC3F,CAAC,CAAA;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,MAAsC,EAC9B,EAAE;IACV,OAAO,MAAM;SACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE;YACvB,CAAC,CAAC,GAAG,KAAK,CAAC,EAAE,EAAE;YACf,CAAC,CAAC,UAAU,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,CAAA;QAC/B,OAAO,GAAG,QAAQ,KAAK,KAAK,CAAC,KAAK,MAAM,KAAK,CAAC,OAAO,EAAE,CAAA;IACzD,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAA;AACf,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jamesaphoenix/tx-core",
-  "version": "0.5.4",
+  "version": "0.5.6",
   "description": "Core business logic for tx - Effect-TS services and repositories",
   "type": "module",
   "main": "./dist/index.js",