@ztothez/design-engineering 2.0.0

package/dist/src/contracts/journeys.js

@@ -0,0 +1,32 @@
+import { readFile } from "node:fs/promises";
+import { z } from "zod";
+import { runtimeJourneySchema } from "../runtime/schema.js";
+import { journeySuiteSchema } from "./schema.js";
+export async function loadRuntimeJourneySelection(file, requestedProfile) {
+    const content = JSON.parse(await readFile(file, "utf8"));
+    const flatJourneys = z.array(runtimeJourneySchema).safeParse(content);
+    if (flatJourneys.success) {
+        if (requestedProfile) {
+            throw new Error("--profile cannot be used with a flat journey array");
+        }
+        return { journeys: flatJourneys.data, expectedNetwork: [] };
+    }
+    const suite = journeySuiteSchema.parse(content);
+    if (!requestedProfile) {
+        const profileIds = suite.profiles.map((profile) => profile.id).join(", ");
+        throw new Error(`--profile is required for a journey suite. Available profiles: ${profileIds}`);
+    }
+    const profile = suite.profiles.find((candidate) => candidate.id === requestedProfile);
+    if (!profile) {
+        const profileIds = suite.profiles.map((candidate) => candidate.id).join(", ");
+        throw new Error(`Unknown journey profile ${requestedProfile}. Available profiles: ${profileIds}`);
+    }
+    return {
+        journeys: profile.journeys.map(({ name, steps }) => ({ name, steps })),
+        expectedNetwork: profile.expectedNetwork ?? [],
+    };
+}
+export async function loadRuntimeJourneys(file, requestedProfile) {
+    return (await loadRuntimeJourneySelection(file, requestedProfile)).journeys;
+}
+//# sourceMappingURL=journeys.js.map

package/dist/src/contracts/journeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"journeys.js","sourceRoot":"","sources":["../../../src/contracts/journeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAOjD,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,IAAY,EACZ,gBAAyB;IAEzB,MAAM,OAAO,GAAY,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAClE,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACtE,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,gBAAgB,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,EAAE,QAAQ,EAAE,YAAY,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;IAC9D,CAAC;IAED,MAAM,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAChD,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1E,MAAM,IAAI,KAAK,CAAC,kEAAkE,UAAU,EAAE,CAAC,CAAC;IAClG,CAAC;IACD,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,gBAAgB,CAAC,CAAC;IACtF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9E,MAAM,IAAI,KAAK,CAAC,2BAA2B,gBAAgB,yBAAyB,UAAU,EAAE,CAAC,CAAC;IACpG,CAAC;IACD,OAAO;QACL,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACtE,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,EAAE;KAC/C,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,IAAY,EACZ,gBAAyB;IAEzB,OAAO,CAAC,MAAM,2BAA2B,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC9E,CAAC"}

package/dist/src/contracts/report.d.ts

@@ -0,0 +1,2 @@
+import type { ContractValidationReport } from "./schema.js";
+export declare function formatContractValidationReport(report: ContractValidationReport): string;

package/dist/src/contracts/report.js

@@ -0,0 +1,33 @@
+export function formatContractValidationReport(report) {
+    const lines = [
+        "# ZtotheZ Design Engineering Product Contract Validation",
+        "",
+        `- Contract: \`${report.contractPath}\``,
+        `- Contract ID: \`${report.contractId ?? "unavailable"}\``,
+        `- Result: ${report.passed ? "PASS" : "FAIL"}`,
+        `- Actors: ${report.counts.actors}`,
+        `- Modes: ${report.counts.modes}`,
+        `- Acceptance criteria: ${report.counts.acceptanceCriteria}`,
+        `- Journey profiles: ${report.counts.journeyProfiles}`,
+        `- Journeys: ${report.counts.journeys}`,
+        `- Task model: ${report.taskModel.status}${report.taskModel.archetype ? ` (${report.taskModel.archetype})` : ""}`,
+        `- Product tasks: ${report.taskModel.primaryTasks} primary, ${report.taskModel.recoveryTasks} recovery, ${report.taskModel.narrowViewportTasks} narrow-viewport`,
+    ];
+    if (report.journeyPath)
+        lines.splice(3, 0, `- Journeys: \`${report.journeyPath}\``);
+    lines.push("");
+    if (report.issues.length === 0) {
+        lines.push("No contract validation issues were detected.");
+    }
+    else {
+        lines.push("## Issues", "");
+        for (const entry of report.issues) {
+            lines.push(`- **${entry.code}** at \`${entry.path}\`: ${entry.message}`);
+        }
+    }
+    if (report.limitations.length > 0) {
+        lines.push("", "## Limitations", "", ...report.limitations.map((entry) => `- ${entry}`));
+    }
+    return lines.join("\n");
+}
+//# sourceMappingURL=report.js.map

package/dist/src/contracts/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../../src/contracts/report.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,8BAA8B,CAAC,MAAgC;IAC7E,MAAM,KAAK,GAAG;QACZ,0DAA0D;QAC1D,EAAE;QACF,iBAAiB,MAAM,CAAC,YAAY,IAAI;QACxC,oBAAoB,MAAM,CAAC,UAAU,IAAI,aAAa,IAAI;QAC1D,aAAa,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE;QAC9C,aAAa,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;QACnC,YAAY,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;QACjC,0BAA0B,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE;QAC5D,uBAAuB,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE;QACtD,eAAe,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;QACvC,iBAAiB,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,SAAS,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACjH,oBAAoB,MAAM,CAAC,SAAS,CAAC,YAAY,aAAa,MAAM,CAAC,SAAS,CAAC,aAAa,cAAc,MAAM,CAAC,SAAS,CAAC,mBAAmB,kBAAkB;KACjK,CAAC;IAEF,IAAI,MAAM,CAAC,WAAW;QAAE,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,iBAAiB,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC;IACpF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;IAC7D,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC5B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,WAAW,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3E,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC;IAC3F,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}