legal-markdown-js 0.1.0

package/dist/styles/headers.css

@@ -0,0 +1,146 @@
+/* Legal Header Styles - Header Field Tracking Support */
+
+/* Base legal header styling */
+.legal-header {
+  display: block;
+  margin: 1em 0 0.5em 0;
+  font-weight: 600;
+  line-height: 1.3;
+}
+
+/* Level-specific styling */
+.legal-header-level-1,
+.legal-article {
+  font-size: 1.6em;
+  font-weight: bold;
+  color: #1a1a1a;
+  margin: 2em 0 1em 0;
+  border-bottom: 3px solid #333;
+  padding-bottom: 0.2em;
+}
+
+.legal-header-level-2,
+.legal-section {
+  font-size: 1.3em;
+  font-weight: 600;
+  color: #333;
+  margin: 1.5em 0 0.8em 0;
+  border-bottom: 1px solid #666;
+  padding-bottom: 0.1em;
+}
+
+.legal-header-level-3,
+.legal-subsection {
+  font-size: 1.1em;
+  font-weight: 500;
+  color: #444;
+  margin: 1em 0 0.5em 0;
+}
+
+.legal-header-level-4,
+.legal-sub-subsection {
+  font-size: 1.05em;
+  font-weight: 500;
+  color: #555;
+  margin: 0.8em 0 0.4em 0;
+}
+
+.legal-header-level-5,
+.legal-paragraph {
+  font-size: 1em;
+  font-weight: 500;
+  color: #666;
+  margin: 0.6em 0 0.3em 0;
+}
+
+/* Data attribute based styling for more specificity */
+.legal-header[data-level='1'] {
+  /* Additional Article-level styling */
+  text-transform: uppercase;
+  letter-spacing: 0.5px;
+}
+
+.legal-header[data-level='2'] {
+  /* Additional Section-level styling */
+  font-variant: small-caps;
+}
+
+.legal-header[data-level='3'] {
+  /* Additional Subsection-level styling */
+  font-style: italic;
+}
+
+/* Hover effects for interactive documents */
+.legal-header:hover {
+  background-color: rgba(0, 120, 215, 0.1);
+  cursor: pointer;
+  border-radius: 2px;
+  padding: 2px 4px;
+  margin: -2px -4px;
+}
+
+/* Print optimizations */
+@media print {
+  .legal-header {
+    page-break-after: avoid;
+    page-break-inside: avoid;
+  }
+
+  .legal-header:hover {
+    background-color: transparent;
+    padding: 0;
+    margin: 1em 0 0.5em 0;
+  }
+
+  .legal-header-level-1,
+  .legal-article {
+    page-break-before: always;
+  }
+
+  .legal-header-level-1:first-child {
+    page-break-before: avoid;
+  }
+}
+
+/* Dark mode support */
+@media (prefers-color-scheme: dark) {
+  .legal-header-level-1,
+  .legal-article {
+    color: #e6e6e6;
+    border-bottom-color: #ccc;
+  }
+
+  .legal-header-level-2,
+  .legal-section {
+    color: #ddd;
+    border-bottom-color: #999;
+  }
+
+  .legal-header-level-3,
+  .legal-subsection {
+    color: #ccc;
+  }
+
+  .legal-header-level-4,
+  .legal-sub-subsection {
+    color: #bbb;
+  }
+
+  .legal-header-level-5,
+  .legal-paragraph {
+    color: #aaa;
+  }
+}
+
+/* Responsive adjustments */
+@media (max-width: 768px) {
+  .legal-header-level-1,
+  .legal-article {
+    font-size: 1.4em;
+  }
+
+  .legal-header-level-2,
+  .legal-section {
+    font-size: 1.2em;
+  }
+}

package/dist/styles/highlight.css

@@ -0,0 +1,171 @@
+/**
+ * Highlight Styles for Legal Documents
+ * 
+ * Provides visual indicators for:
+ * - Imported values (blue): Fields filled from data
+ * - Missing values (red): Required fields without values  
+ * - Logic fields (yellow): Fields with conditional logic or mixins
+ */
+
+/* Imported values - Successfully filled from data */
+.imported-value {
+  border: 1px solid #0066cc;
+  border-radius: 2px;
+  padding: 1px 3px;
+  background-color: #e6f3ff;
+  color: #004085;
+  display: inline;
+  vertical-align: baseline;
+  white-space: normal;
+}
+
+/* Nested elements in imported values */
+.imported-value a {
+  display: inline;
+  white-space: normal;
+  line-height: inherit;
+  vertical-align: baseline;
+}
+
+/* Print styles for imported values */
+@media print {
+  .imported-value {
+    border-color: #0066cc;
+    background-color: #e6f3ff;
+    color: #004085;
+    -webkit-print-color-adjust: exact;
+    print-color-adjust: exact;
+  }
+}
+
+/* Missing values - Required fields without data */
+.missing-value {
+  border: 1px solid #dc3545;
+  border-radius: 2px;
+  padding: 1px 3px;
+  background-color: #fff5f5;
+  color: #dc3545;
+  display: inline;
+  vertical-align: baseline;
+  white-space: normal;
+  font-weight: 500;
+}
+
+/* Nested elements in missing values */
+.missing-value a {
+  display: inline;
+  white-space: normal;
+  line-height: inherit;
+  vertical-align: baseline;
+}
+
+/* Print styles for missing values */
+@media print {
+  .missing-value {
+    border-color: #dc3545;
+    background-color: #fff5f5;
+    color: #dc3545;
+    -webkit-print-color-adjust: exact;
+    print-color-adjust: exact;
+  }
+}
+
+/* Logic fields - Fields with conditional logic or mixins */
+.highlight {
+  border: 1px solid #ffc107;
+  border-radius: 2px;
+  padding: 3px 3px;
+  background-color: #f9f3df;
+  color: #856404;
+  display: inline;
+  vertical-align: baseline;
+  white-space: normal;
+  margin: 1px 0;
+}
+
+/* Nested highlighting */
+.highlight .imported-value,
+.highlight .missing-value {
+  margin: 0;
+  padding: 0 3px;
+  border-radius: 1px;
+}
+
+/* Print styles for logic fields */
+@media print {
+  .highlight {
+    border-color: #ffc107;
+    background-color: #f9f3df;
+    color: #856404;
+    -webkit-print-color-adjust: exact;
+    print-color-adjust: exact;
+  }
+}
+
+/* Additional helper classes */
+
+/* Legend for highlighting */
+.highlight-legend {
+  margin: 20px 0;
+  padding: 15px;
+  border: 1px solid #ddd;
+  border-radius: 4px;
+  background-color: #f8f9fa;
+  page-break-inside: avoid;
+}
+
+.highlight-legend h3 {
+  margin-top: 0;
+  font-size: 1.1em;
+}
+
+.highlight-legend ul {
+  list-style: none;
+  padding-left: 0;
+  margin: 10px 0 0 0;
+}
+
+.highlight-legend li {
+  margin: 5px 0;
+  padding: 5px 10px;
+  border-radius: 3px;
+}
+
+.highlight-legend .imported-example {
+  background-color: #e6f3ff;
+  border: 1px solid #0066cc;
+  color: #004085;
+}
+
+.highlight-legend .missing-example {
+  background-color: #fff5f5;
+  border: 1px solid #dc3545;
+  color: #dc3545;
+}
+
+.highlight-legend .logic-example {
+  background-color: #f9f3df;
+  border: 1px solid #ffc107;
+  color: #856404;
+}
+
+/* Ensure visibility in different contexts */
+@media screen {
+  .imported-value,
+  .missing-value,
+  .highlight {
+    transition: background-color 0.2s ease;
+  }
+  
+  .imported-value:hover {
+    background-color: #cce5ff;
+  }
+  
+  .missing-value:hover {
+    background-color: #ffe5e5;
+  }
+  
+  .highlight:hover {
+    background-color: #fff3cd;
+  }
+}

package/dist/tracking/field-tracker.d.ts

@@ -0,0 +1,206 @@
+/**
+ * @fileoverview Field Tracking System for Legal Markdown Processing
+ *
+ * This module provides comprehensive field tracking functionality for Legal Markdown
+ * documents, including field status monitoring, highlighting support, and reporting
+ * capabilities. It tracks field processing state and applies appropriate CSS classes
+ * for visual feedback during document review.
+ *
+ * Features:
+ * - Field status tracking (filled, empty, logic)
+ * - CSS class application for field highlighting
+ * - Field processing state management
+ * - Mixin usage tracking for complex field logic
+ * - Reporting and analytics for field usage
+ * - Singleton pattern for consistent tracking across the application
+ *
+ * @example
+ * ```typescript
+ * import { fieldTracker, FieldStatus } from './field-tracker';
+ *
+ * // Track a field during processing
+ * fieldTracker.trackField('client.name', {
+ *   value: 'Acme Corporation',
+ *   status: FieldStatus.FILLED
+ * });
+ *
+ * // Apply field tracking to content
+ * const highlightedContent = fieldTracker.applyFieldTracking(processedContent);
+ *
+ * // Generate field report
+ * const report = fieldTracker.generateReport();
+ * console.log(`${report.filled} fields filled, ${report.empty} fields empty`);
+ * ```
+ */
+/**
+ * Enumeration of possible field statuses during processing
+ *
+ * @enum {string} FieldStatus
+ * @example
+ * ```typescript
+ * import { FieldStatus } from './field-tracker';
+ *
+ * // Check field status
+ * if (field.status === FieldStatus.FILLED) {
+ *   console.log('Field has a value');
+ * } else if (field.status === FieldStatus.EMPTY) {
+ *   console.log('Field needs a value');
+ * } else if (field.status === FieldStatus.LOGIC) {
+ *   console.log('Field uses conditional logic');
+ * }
+ * ```
+ */
+export declare enum FieldStatus {
+    /** Field has been filled with a value */
+    FILLED = "filled",
+    /** Field is empty or missing a value */
+    EMPTY = "empty",
+    /** Field contains logic or uses mixins */
+    LOGIC = "logic"
+}
+/**
+ * Interface representing a tracked field in the Legal Markdown system
+ *
+ * @interface TrackedField
+ * @example
+ * ```typescript
+ * const field: TrackedField = {
+ *   name: 'client.name',
+ *   status: FieldStatus.FILLED,
+ *   value: 'Acme Corporation',
+ *   originalValue: '{{client.name}}',
+ *   hasLogic: false,
+ *   mixinUsed: undefined
+ * };
+ * ```
+ */
+export interface TrackedField {
+    /** The name/identifier of the field */
+    name: string;
+    /** The current status of the field */
+    status: FieldStatus;
+    /** The processed value of the field */
+    value?: any;
+    /** The original unprocessed value of the field */
+    originalValue?: any;
+    /** Whether the field contains logical operations */
+    hasLogic: boolean;
+    /** Name of mixin used for processing this field */
+    mixinUsed?: string;
+}
+/**
+ * Field tracking system for Legal Markdown processing
+ *
+ * Manages field tracking throughout the document processing lifecycle,
+ * including status monitoring, highlighting, and reporting capabilities.
+ *
+ * @class FieldTracker
+ * @example
+ * ```typescript
+ * import { FieldTracker, FieldStatus } from './field-tracker';
+ *
+ * const tracker = new FieldTracker();
+ *
+ * // Track field processing
+ * tracker.trackField('client.name', {
+ *   value: 'Acme Corp',
+ *   originalValue: '{{client.name}}',
+ *   hasLogic: false
+ * });
+ *
+ * // Apply tracking to content
+ * const highlighted = tracker.applyFieldTracking(content);
+ *
+ * // Generate report
+ * const report = tracker.generateReport();
+ * ```
+ */
+export declare class FieldTracker {
+    private fields;
+    private processedContent;
+    /**
+     * Creates a new FieldTracker instance
+     *
+     * @constructor
+     */
+    constructor();
+    /**
+     * Track a field that has been processed
+     *
+     * Registers a field with the tracking system, determining its status based on
+     * the provided options and storing relevant metadata for later use.
+     *
+     * @method trackField
+     * @param {string} fieldName - The name/identifier of the field to track
+     * @param {Object} options - Options for field tracking
+     * @param {any} [options.value] - The processed value of the field
+     * @param {any} [options.originalValue] - The original unprocessed value
+     * @param {boolean} [options.hasLogic=false] - Whether the field contains logical operations
+     * @param {string} [options.mixinUsed] - Name of mixin used for processing
+     * @returns {void}
+     * @example
+     * ```typescript
+     * // Track a filled field
+     * tracker.trackField('client.name', {
+     *   value: 'Acme Corporation',
+     *   originalValue: '{{client.name}}'
+     * });
+     *
+     * // Track an empty field
+     * tracker.trackField('client.address', {
+     *   value: '',
+     *   originalValue: '{{client.address}}'
+     * });
+     *
+     * // Track a field with logic
+     * tracker.trackField('warranty.clause', {
+     *   value: 'Standard warranty applies',
+     *   originalValue: '{{#if warranty.enabled}}{{warranty.text}}{{/if}}',
+     *   hasLogic: true,
+     *   mixinUsed: 'warranty-mixin'
+     * });
+     * ```
+     */
+    trackField(fieldName: string, options: {
+        value?: any;
+        originalValue?: any;
+        hasLogic?: boolean;
+        mixinUsed?: string;
+    }): void;
+    /**
+     * Apply field tracking to processed content by wrapping fields with appropriate CSS classes
+     */
+    applyFieldTracking(content: string): string;
+    /**
+     * Get CSS class for field based on its status
+     */
+    private getFieldCssClass;
+    /**
+     * Escape special regex characters in a string
+     */
+    private escapeRegex;
+    /**
+     * Get all tracked fields
+     */
+    getFields(): Map<string, TrackedField>;
+    /**
+     * Get fields by status
+     */
+    getFieldsByStatus(status: FieldStatus): TrackedField[];
+    /**
+     * Generate a summary report of tracked fields
+     */
+    generateReport(): {
+        total: number;
+        filled: number;
+        empty: number;
+        logic: number;
+        fields: TrackedField[];
+    };
+    /**
+     * Clear all tracked fields
+     */
+    clear(): void;
+}
+export declare const fieldTracker: FieldTracker;
+//# sourceMappingURL=field-tracker.d.ts.map

package/dist/tracking/field-tracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-tracker.d.ts","sourceRoot":"","sources":["../../src/tracking/field-tracker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAIH;;;;;;;;;;;;;;;;;GAiBG;AACH,oBAAY,WAAW;IACrB,yCAAyC;IACzC,MAAM,WAAW;IACjB,wCAAwC;IACxC,KAAK,UAAU;IACf,0CAA0C;IAC1C,KAAK,UAAU;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,YAAY;IAC3B,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,MAAM,EAAE,WAAW,CAAC;IACpB,uCAAuC;IACvC,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,kDAAkD;IAClD,aAAa,CAAC,EAAE,GAAG,CAAC;IACpB,oDAAoD;IACpD,QAAQ,EAAE,OAAO,CAAC;IAClB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAwC;IACtD,OAAO,CAAC,gBAAgB,CAAc;IAEtC;;;;OAIG;;IAGH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE;QACP,KAAK,CAAC,EAAE,GAAG,CAAC;QACZ,aAAa,CAAC,EAAE,GAAG,CAAC;QACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GACA,IAAI;IAyBP;;OAEG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAgC3C;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAaxB;;OAEG;IACH,OAAO,CAAC,WAAW;IAInB;;OAEG;IACH,SAAS,IAAI,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC;IAItC;;OAEG;IACH,iBAAiB,CAAC,MAAM,EAAE,WAAW,GAAG,YAAY,EAAE;IAItD;;OAEG;IACH,cAAc,IAAI;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,YAAY,EAAE,CAAC;KACxB;IAYD;;OAEG;IACH,KAAK,IAAI,IAAI;CAId;AAGD,eAAO,MAAM,YAAY,cAAqB,CAAC"}