@klarocards/cli 1.0.0

package/dist/utils/story-markdown.js

@@ -0,0 +1,114 @@
+import { stringify, parse } from 'yaml';
+/**
+ * Format a story as markdown output.
+ *
+ * - toptitle: first line of the title
+ * - summary: remaining lines of the title (if any)
+ * - description: the specification field
+ * - dimensions: optional array of dimension names to include as YAML frontmatter
+ */
+export function formatStoryMarkdown(story, dimensions) {
+    const lines = [];
+    // Add YAML frontmatter if dimensions are specified
+    if (dimensions && dimensions.length > 0) {
+        const frontmatter = {};
+        for (const dim of dimensions) {
+            if (dim in story) {
+                frontmatter[dim] = story[dim];
+            }
+        }
+        if (Object.keys(frontmatter).length > 0) {
+            lines.push('---');
+            lines.push(stringify(frontmatter).trim());
+            lines.push('---');
+            lines.push('');
+        }
+    }
+    // Split title into toptitle and summary
+    const titleLines = story.title.split('\n');
+    const toptitle = titleLines[0];
+    const summary = titleLines.slice(1).join('\n').trim();
+    // Header with toptitle
+    lines.push(`# ${toptitle}`);
+    lines.push('');
+    // Summary if present
+    if (summary) {
+        lines.push(summary);
+        lines.push('');
+    }
+    // Description (specification)
+    if (story.specification) {
+        lines.push(story.specification);
+    }
+    return lines.join('\n');
+}
+/**
+ * Parse markdown back into story fields.
+ *
+ * Format expected:
+ * ```
+ * ---
+ * dimension: value
+ * ---
+ *
+ * # toptitle
+ *
+ * [summary - optional]
+ *
+ * [description - optional]
+ * ```
+ *
+ * If two content blocks exist (separated by blank line), first is summary, second is description.
+ * If only one content block exists, it's treated as description.
+ */
+export function parseStoryMarkdown(markdown) {
+    let content = markdown;
+    let dimensions;
+    // Check for YAML frontmatter
+    if (content.startsWith('---')) {
+        const endIndex = content.indexOf('---', 3);
+        if (endIndex !== -1) {
+            const yamlContent = content.slice(3, endIndex).trim();
+            if (yamlContent) {
+                dimensions = parse(yamlContent);
+            }
+            content = content.slice(endIndex + 3).trim();
+        }
+    }
+    const lines = content.split('\n');
+    // Extract toptitle from first line
+    const firstLine = lines[0] || '';
+    if (!firstLine.startsWith('# ')) {
+        throw new Error('Invalid format: first line must be a heading (# title)');
+    }
+    const toptitle = firstLine.slice(2).trim();
+    // Skip the title line and find content blocks
+    const rest = lines.slice(1).join('\n').trim();
+    if (!rest) {
+        // Title only
+        return { title: toptitle, dimensions };
+    }
+    // Split by double newlines to find content blocks
+    const blocks = rest.split(/\n\n+/).filter(b => b.trim());
+    if (blocks.length === 0) {
+        return { title: toptitle, dimensions };
+    }
+    if (blocks.length === 1) {
+        // Single block is treated as description
+        return {
+            title: toptitle,
+            specification: blocks[0].trim(),
+            dimensions,
+        };
+    }
+    // Multiple blocks: first is summary (part of title), rest is description
+    const summary = blocks[0].trim();
+    const description = blocks.slice(1).join('\n\n').trim();
+    const title = summary ? `${toptitle}\n${summary}` : toptitle;
+    return {
+        title,
+        specification: description || undefined,
+        dimensions,
+    };
+}
+//# sourceMappingURL=story-markdown.js.map

package/dist/utils/story-markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"story-markdown.js","sourceRoot":"","sources":["../../src/utils/story-markdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AASxC;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAY,EAAE,UAAqB;IACrE,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,mDAAmD;IACnD,IAAI,UAAU,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,WAAW,GAA4B,EAAE,CAAC;QAChD,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC7B,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;gBACjB,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAC1C,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IAED,wCAAwC;IACxC,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IAEtD,uBAAuB;IACvB,KAAK,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CAAC,CAAC;IAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,qBAAqB;IACrB,IAAI,OAAO,EAAE,CAAC;QACZ,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,8BAA8B;IAC9B,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAgB;IACjD,IAAI,OAAO,GAAG,QAAQ,CAAC;IACvB,IAAI,UAA+C,CAAC;IAEpD,6BAA6B;IAC7B,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC3C,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;YACpB,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;YACtD,IAAI,WAAW,EAAE,CAAC;gBAChB,UAAU,GAAG,KAAK,CAAC,WAAW,CAA4B,CAAC;YAC7D,CAAC;YACD,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAElC,mCAAmC;IACnC,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACjC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IACD,MAAM,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAE3C,8CAA8C;IAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IAE9C,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,aAAa;QACb,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IACzC,CAAC;IAED,kDAAkD;IAClD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAEzD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IACzC,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,yCAAyC;QACzC,OAAO;YACL,KAAK,EAAE,QAAQ;YACf,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YAC/B,UAAU;SACX,CAAC;IACJ,CAAC;IAED,yEAAyE;IACzE,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACjC,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;IAExD,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,KAAK,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;IAE7D,OAAO;QACL,KAAK;QACL,aAAa,EAAE,WAAW,IAAI,SAAS;QACvC,UAAU;KACX,CAAC;AACJ,CAAC"}

package/dist/utils/table.d.ts

@@ -0,0 +1,18 @@
+type Tuple = Record<string, unknown>;
+/**
+ * Format an array of tuples as a table string with rounded borders.
+ *
+ * @param data - Array of objects to display
+ * @param columns - Column names to include in output
+ * @returns Formatted table string
+ */
+export declare function formatTable(data: Tuple[], columns: string[]): string;
+/**
+ * Print an array of tuples as a formatted table with rounded borders.
+ *
+ * @param data - Array of objects to display
+ * @param columns - Column names to include in output
+ */
+export declare function printTable(data: Tuple[], columns: string[]): void;
+export {};
+//# sourceMappingURL=table.d.ts.map

package/dist/utils/table.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../src/utils/table.ts"],"names":[],"mappings":"AAGA,KAAK,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AA4CrC;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAGpE;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAEjE"}

package/dist/utils/table.js

@@ -0,0 +1,57 @@
+import { Bmg } from '@enspirit/bmg-js';
+import { truncate } from './format.js';
+const BORDER_OVERHEAD = 4; // "│ " + " │" for outer borders
+const COLUMN_SEPARATOR = 3; // " │ " between columns
+const MIN_TITLE_WIDTH = 20;
+const DEFAULT_TERMINAL_WIDTH = 80;
+/**
+ * Calculate the maximum width available for the title column.
+ */
+function calculateTitleWidth(data, columns) {
+    const terminalWidth = process.stdout.columns || DEFAULT_TERMINAL_WIDTH;
+    // Calculate width needed for non-title columns
+    let usedWidth = BORDER_OVERHEAD;
+    for (const col of columns) {
+        if (col === 'title')
+            continue;
+        const maxValueLen = Math.max(col.length, ...data.map(row => String(row[col] ?? '').length));
+        usedWidth += maxValueLen + COLUMN_SEPARATOR;
+    }
+    // Title column header is 5 chars
+    const titleHeaderWidth = 'title'.length;
+    const availableWidth = terminalWidth - usedWidth - COLUMN_SEPARATOR;
+    return Math.max(MIN_TITLE_WIDTH, titleHeaderWidth, availableWidth);
+}
+/**
+ * Truncate title fields to fit terminal width.
+ */
+function fitToTerminal(data, columns) {
+    if (!columns.includes('title'))
+        return data;
+    const titleWidth = calculateTitleWidth(data, columns);
+    return data.map(row => ({
+        ...row,
+        title: truncate(String(row.title ?? ''), titleWidth),
+    }));
+}
+/**
+ * Format an array of tuples as a table string with rounded borders.
+ *
+ * @param data - Array of objects to display
+ * @param columns - Column names to include in output
+ * @returns Formatted table string
+ */
+export function formatTable(data, columns) {
+    const fitted = fitToTerminal(data, columns);
+    return Bmg(fitted).project(columns).toText({ border: 'rounded' });
+}
+/**
+ * Print an array of tuples as a formatted table with rounded borders.
+ *
+ * @param data - Array of objects to display
+ * @param columns - Column names to include in output
+ */
+export function printTable(data, columns) {
+    console.log(formatTable(data, columns));
+}
+//# sourceMappingURL=table.js.map

package/dist/utils/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../../src/utils/table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAIvC,MAAM,eAAe,GAAG,CAAC,CAAC,CAAC,gCAAgC;AAC3D,MAAM,gBAAgB,GAAG,CAAC,CAAC,CAAC,wBAAwB;AACpD,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC;;GAEG;AACH,SAAS,mBAAmB,CAAC,IAAa,EAAE,OAAiB;IAC3D,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,IAAI,sBAAsB,CAAC;IAEvE,+CAA+C;IAC/C,IAAI,SAAS,GAAG,eAAe,CAAC;IAChC,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,IAAI,GAAG,KAAK,OAAO;YAAE,SAAS;QAC9B,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAC1B,GAAG,CAAC,MAAM,EACV,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAClD,CAAC;QACF,SAAS,IAAI,WAAW,GAAG,gBAAgB,CAAC;IAC9C,CAAC;IAED,iCAAiC;IACjC,MAAM,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IACxC,MAAM,cAAc,GAAG,aAAa,GAAG,SAAS,GAAG,gBAAgB,CAAC;IAEpE,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,gBAAgB,EAAE,cAAc,CAAC,CAAC;AACrE,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,IAAa,EAAE,OAAiB;IACrD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO,IAAI,CAAC;IAE5C,MAAM,UAAU,GAAG,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACtB,GAAG,GAAG;QACN,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC;KACrD,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,IAAa,EAAE,OAAiB;IAC1D,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AACpE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,IAAa,EAAE,OAAiB;IACzD,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AAC1C,CAAC"}

package/dist/utils/validation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Validate a subdomain format.
+ * @param subdomain - The subdomain to validate
+ * @returns true if valid
+ * @throws Error if the subdomain format is invalid
+ */
+export declare function validateSubdomain(subdomain: string): true;
+//# sourceMappingURL=validation.d.ts.map

package/dist/utils/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/utils/validation.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAWzD"}

package/dist/utils/validation.js

@@ -0,0 +1,17 @@
+/**
+ * Validate a subdomain format.
+ * @param subdomain - The subdomain to validate
+ * @returns true if valid
+ * @throws Error if the subdomain format is invalid
+ */
+export function validateSubdomain(subdomain) {
+    if (!subdomain) {
+        throw new Error('Subdomain is required.');
+    }
+    // Subdomain should be alphanumeric with hyphens
+    if (!/^[a-z0-9-]+$/i.test(subdomain)) {
+        throw new Error('Invalid subdomain format. Use only letters, numbers, and hyphens.');
+    }
+    return true;
+}
+//# sourceMappingURL=validation.js.map

package/dist/utils/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/utils/validation.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,SAAiB;IACjD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IAED,gDAAgD;IAChD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@klarocards/cli",
+  "version": "1.0.0",
+  "description": "Command-line interface for Klaro Cards",
+  "type": "module",
+  "main": "./dist/index.js",
+  "bin": {
+    "klaro": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "klaro",
+    "klaro-cards",
+    "cli",
+    "project-management"
+  ],
+  "author": "",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@enspirit/bmg-js": "^1.1.1",
+    "chalk": "^5.6.2",
+    "commander": "^12.1.0",
+    "marked": "^15.0.12",
+    "marked-terminal": "^7.3.0",
+    "yaml": "^2.8.2"
+  },
+  "devDependencies": {
+    "@types/marked-terminal": "^6.1.1",
+    "@types/node": "^20.11.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.2.0"
+  }
+}