cognite-neat 0.123.2__py3-none-any.whl → 0.127.30__py3-none-any.whl

cognite/neat/_session/_html/static/issues.js

@@ -0,0 +1,168 @@
+let currentFilter = 'all';
+let currentSearch = '';
+const storageKey = 'neat-issues-theme-' + uniqueId;
+let isDarkMode = localStorage.getItem(storageKey) === 'dark';
+let expandedGroups = new Set();
+
+const container = document.getElementById('issuesContainer-' + uniqueId);
+const themeToggle = document.getElementById('themeToggle-' + uniqueId);
+const themeIcon = document.getElementById('themeIcon-' + uniqueId);
+const themeText = document.getElementById('themeText-' + uniqueId);
+
+// Initialize theme
+function updateTheme() {
+    if (isDarkMode) {
+        container.classList.add('dark-mode');
+        themeIcon.textContent = '☀️';
+        themeText.textContent = 'Light';
+    } else {
+        container.classList.remove('dark-mode');
+        themeIcon.textContent = '🌙';
+        themeText.textContent = 'Dark';
+    }
+}
+
+updateTheme();
+
+// Theme toggle
+themeToggle.addEventListener('click', function() {
+    isDarkMode = !isDarkMode;
+    localStorage.setItem(storageKey, isDarkMode ? 'dark' : 'light');
+    updateTheme();
+});
+
+function groupIssues(issuesList) {
+    const grouped = new Map();
+
+    issuesList.forEach(issue => {
+        const key = issue.code ? `${issue.type}:${issue.code}` : `${issue.type}:${issue.id}`;
+
+        if (!grouped.has(key)) {
+            grouped.set(key, []);
+        }
+        grouped.get(key).push(issue);
+    });
+
+    return grouped;
+}
+
+function renderIssues() {
+    const listContainer = document.getElementById('issuesList-' + uniqueId);
+    const filtered = issues.filter(issue => {
+        const matchesFilter = currentFilter === 'all' || issue.type === currentFilter;
+        const matchesSearch = !currentSearch ||
+            issue.message.toLowerCase().includes(currentSearch.toLowerCase()) ||
+            (issue.code && issue.code.toLowerCase().includes(currentSearch.toLowerCase())) ||
+            (issue.fix && issue.fix.toLowerCase().includes(currentSearch.toLowerCase()));
+        return matchesFilter && matchesSearch;
+    });
+
+    if (filtered.length === 0) {
+        listContainer.innerHTML = '<div class="no-issues">No issues match your filters</div>';
+        return;
+    }
+
+    const grouped = groupIssues(filtered);
+    const html = [];
+
+    grouped.forEach((groupIssues, key) => {
+        const firstIssue = groupIssues[0];
+        const count = groupIssues.length;
+        const isExpanded = expandedGroups.has(key);
+        const codeLink = firstIssue.code
+            ? `<span class="issue-code-link" onclick="event.stopPropagation(); window.open('https://cognite-neat.readthedocs-hosted.com/en/latest/validation/${firstIssue.code.toLowerCase()}.html', '_blank')">${firstIssue.code}</span>`
+            : '';
+
+        if (count === 1) {
+            // Single issue - render normally
+            html.push(`
+                <div class="issue-item">
+                    <div class="issue-header">
+                        <span class="issue-badge badge-${firstIssue.type}">${firstIssue.type}</span>
+                        ${codeLink}
+                    </div>
+                    <div class="issue-message">${firstIssue.message}</div>
+                    ${firstIssue.fix ? `
+                        <div class="issue-fix">
+                            <div class="issue-fix-label">💡 Suggested Fix</div>
+                            <div class="issue-fix-content">${firstIssue.fix}</div>
+                        </div>
+                    ` : ''}
+                </div>
+            `);
+        } else {
+            // Grouped issues
+            html.push(`
+                <div class="issue-group ${isExpanded ? 'expanded' : ''}">
+                    <div class="issue-group-header" onclick="toggleGroup_${uniqueId}('${key}')">
+                        <div class="issue-group-info">
+                            <span class="expand-icon">${isExpanded ? '▼' : '▶'}</span>
+                            <span class="issue-badge badge-${firstIssue.type}">${firstIssue.type}</span>
+                            ${codeLink}
+                            <span class="issue-count">${count} issues</span>
+                        </div>
+                    </div>
+                    <div class="issue-group-items">
+                        ${groupIssues.map((issue, idx) => `
+                            <div class="issue-item grouped">
+                                <div class="issue-number">#${idx + 1}</div>
+                                <div class="issue-message">${issue.message}</div>
+                            </div>
+                        `).join('')}
+                        ${firstIssue.fix ? `
+                            <div class="issue-fix grouped">
+                                <div class="issue-fix-label">💡 Suggested Fix</div>
+                                <div class="issue-fix-content">${firstIssue.fix}</div>
+                            </div>
+                        ` : ''}
+                    </div>
+                </div>
+            `);
+        }
+    });
+
+    listContainer.innerHTML = html.join('');
+}
+
+window['toggleGroup_' + uniqueId] = function(key) {
+    if (expandedGroups.has(key)) {
+        expandedGroups.delete(key);
+    } else {
+        expandedGroups.add(key);
+    }
+    renderIssues();
+};
+
+// Stat item filters
+document.querySelectorAll('#issuesContainer-' + uniqueId + ' .stat-item').forEach(item => {
+    item.addEventListener('click', function() {
+        document.querySelectorAll('#issuesContainer-' + uniqueId + ' .stat-item').forEach(i => i.classList.remove('active'));
+        this.classList.add('active');
+        currentFilter = this.dataset.filter;
+        renderIssues();
+    });
+});
+
+// Search
+document.getElementById('searchInput-' + uniqueId).addEventListener('input', function(e) {
+    currentSearch = e.target.value;
+    renderIssues();
+});
+
+// Export function
+window['exportIssues_' + uniqueId] = function() {
+    const csv = [
+        ['Type', 'Code', 'Message', 'Fix'],
+        ...issues.map(i => [i.type, i.code || '', i.message, i.fix || ''])
+    ].map(row => row.map(cell => `"${String(cell).replace(/"/g, '""')}"`).join(',')).join('\n');
+
+    const blob = new Blob([csv], { type: 'text/csv' });
+    const url = window.URL.createObjectURL(blob);
+    const a = document.createElement('a');
+    a.href = url;
+    a.download = 'session_issues.csv';
+    a.click();
+    window.URL.revokeObjectURL(url);
+};
+
+renderIssues();

cognite/neat/_session/_html/static/shared.css

@@ -0,0 +1,186 @@
+:root {
+    --bg-primary: white;
+    --bg-secondary: #f8f9fa;
+    --bg-header: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
+    --text-primary: #212529;
+    --text-secondary: #495057;
+    --text-muted: #6c757d;
+    --border-color: #dee2e6;
+    --border-light: #e9ecef;
+    --hover-bg: #f8f9fa;
+    --stat-bg: rgba(255, 255, 255, 0.2);
+    --stat-hover-bg: rgba(255, 255, 255, 0.3);
+    --stat-active-bg: rgba(255, 255, 255, 0.4);
+    --code-bg: #e9ecef;
+    --fix-bg: #e7f5ff;
+    --fix-border: #1971c2;
+    --fix-text: #1864ab;
+    --export-btn-bg: rgba(255, 255, 255, 0.2);
+    --export-btn-hover-bg: rgba(255, 255, 255, 0.3);
+    --export-btn-border: rgba(255, 255, 255, 0.5);
+}
+
+.dark-mode {
+    --bg-primary: #1e1e1e;
+    --bg-secondary: #2d2d30;
+    --bg-header: linear-gradient(135deg, #4a5568 0%, #2d3748 100%);
+    --text-primary: #e4e4e7;
+    --text-secondary: #a1a1aa;
+    --text-muted: #71717a;
+    --border-color: #3f3f46;
+    --border-light: #27272a;
+    --hover-bg: #27272a;
+    --stat-bg: rgba(255, 255, 255, 0.1);
+    --stat-hover-bg: rgba(255, 255, 255, 0.15);
+    --stat-active-bg: rgba(255, 255, 255, 0.2);
+    --code-bg: #27272a;
+    --fix-bg: #1e293b;
+    --fix-border: #3b82f6;
+    --fix-text: #60a5fa;
+    --export-btn-bg: rgba(255, 255, 255, 0.1);
+    --export-btn-hover-bg: rgba(255, 255, 255, 0.2);
+    --export-btn-border: rgba(255, 255, 255, 0.3);
+}
+
+
+.issues-container,
+.deployment-container {
+    font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Arial, sans-serif;
+    max-width: 100%;
+    margin: 10px 0;
+    background: var(--bg-primary);
+    color: var(--text-primary);
+    transition: all 0.3s ease;
+}
+
+.issues-header,
+.deployment-header {
+    background: var(--bg-header);
+    color: white;
+    padding: 20px;
+    border-radius: 8px 8px 0 0;
+    margin-bottom: 0;
+    position: relative;
+}
+
+.theme-toggle {
+    position: absolute;
+    top: 15px;
+    right: 15px;
+    padding: 8px 12px;
+    background: rgba(255, 255, 255, 0.1);
+    border: 1px solid rgba(255, 255, 255, 0.2);
+    border-radius: 6px;
+    color: white;
+    cursor: pointer;
+    display: flex;
+    align-items: center;
+    gap: 6px;
+    font-size: 13px;
+    transition: all 0.2s;
+}
+
+.theme-toggle:hover {
+    background: rgba(255, 255, 255, 0.2);
+}
+
+.issues-title,
+.deployment-title {
+    margin: 0 0 15px 0;
+    font-size: 24px;
+    font-weight: 600;
+}
+
+.issues-stats,
+.deployment-stats {
+    display: flex;
+    gap: 15px;
+    flex-wrap: wrap;
+    padding-right: 100px;
+}
+
+.stat-item {
+    padding: 8px 16px;
+    background: rgba(255, 255, 255, 0.1);
+    border-radius: 6px;
+    cursor: pointer;
+    transition: all 0.2s;
+    border: 2px solid transparent;
+}
+
+.stat-item:hover {
+    background: rgba(255, 255, 255, 0.15);
+}
+
+.stat-item.active {
+    background: rgba(255, 255, 255, 0.2);
+    border-color: rgba(255, 255, 255, 0.3);
+}
+
+.stat-number {
+    font-weight: 700;
+    font-size: 18px;
+    margin-right: 4px;
+}
+
+.export-btn {
+    margin-left: auto;
+    padding: 6px 14px;
+    border: 1px solid var(--export-btn-border);
+    background: var(--export-btn-bg);
+    color: white;
+    border-radius: 6px;
+    cursor: pointer;
+    font-size: 13px;
+    font-weight: 600;
+    transition: all 0.2s;
+}
+.export-btn:hover {
+    background: var(--export-btn-hover-bg);
+    border-color: white;
+}
+
+.issues-controls,
+.deployment-controls {
+    background: var(--bg-secondary);
+    padding: 15px 20px;
+    border-left: 1px solid var(--border-color);
+    border-right: 1px solid var(--border-color);
+}
+
+.control-group {
+    display: flex;
+    gap: 10px;
+    align-items: center;
+}
+
+.search-input {
+    flex: 1;
+    padding: 10px 14px;
+    border: 1px solid var(--border-color);
+    border-radius: 6px;
+    font-size: 14px;
+    background: var(--bg-primary);
+    color: var(--text-primary);
+    transition: all 0.2s;
+}
+
+.search-input:focus {
+    outline: none;
+    border-color: var(--fix-border);
+    box-shadow: 0 0 0 3px rgba(59, 130, 246, 0.1);
+}
+
+.search-input::placeholder {
+    color: var(--text-primary);
+    opacity: 0.7;
+    font-style: italic;
+}
+
+.no-issues,
+.no-changes {
+    padding: 40px 20px;
+    text-align: center;
+    color: var(--text-muted);
+    font-size: 14px;
+}

cognite/neat/_session/_html/templates/__init__.py

@@ -0,0 +1,4 @@
+from pathlib import Path
+
+issues = Path(__file__).parent / "issues.html"
+deployment = Path(__file__).parent / "deployment.html"

cognite/neat/_session/_html/templates/deployment.html

@@ -0,0 +1,75 @@
+<style>
+{{SHARED_CSS}}
+{{SPECIFIC_CSS}}
+</style>
+
+<div class="issues-container deployment-container" id="deploymentContainer-{{unique_id}}">
+    <div class="issues-header deployment-header">
+        <button class="theme-toggle" id="themeToggle-{{unique_id}}">
+            <span id="themeIcon-{{unique_id}}">🌙</span>
+            <span id="themeText-{{unique_id}}">Dark</span>
+        </button>
+        <h2 class="deployment-title issues-title">
+            <span>Deployment Result</span>
+            <span class="status-badge status-{{status}}" id="statusBadge-{{unique_id}}">
+                <span id="statusIcon-{{unique_id}}"></span>
+                <span id="statusText-{{unique_id}}"></span>
+            </span>
+        </h2>
+        <div class="deployment-stats issues-stats">
+            <div class="stat-item active" data-filter="all">
+                <span class="stat-number">{{total_changes}}</span> Total Changes
+            </div>
+            <div class="stat-item" data-filter="create">
+                <span class="stat-number">{{created}}</span> Created
+            </div>
+            <div class="stat-item" data-filter="update">
+                <span class="stat-number">{{updated}}</span> Updated
+            </div>
+            <div class="stat-item" data-filter="delete">
+                <span class="stat-number">{{deleted}}</span> Deleted
+            </div>
+            <div class="stat-item" data-filter="skip">
+                <span class="stat-number">{{skipped}}</span> Skipped
+            </div>
+            <div class="stat-item" data-filter="unchanged">
+                <span class="stat-number">{{unchanged}}</span> Unchanged
+            </div>
+            <button class="export-btn" onclick="exportDeployment_{{unique_id}}()">Export Report</button>
+        </div>
+    </div>
+
+    <div class="deployment-controls issues-controls">
+        <div class="filter-group">
+            <span class="filter-label">Endpoint:</span>
+            <button class="filter-btn active" data-filter-type="endpoint" data-filter="all">All</button>
+            <button class="filter-btn" data-filter-type="endpoint" data-filter="spaces">Spaces</button>
+            <button class="filter-btn" data-filter-type="endpoint" data-filter="datamodels">Data Models</button>
+            <button class="filter-btn" data-filter-type="endpoint" data-filter="views">Views</button>
+            <button class="filter-btn" data-filter-type="endpoint" data-filter="containers">Containers</button>
+        </div>
+
+        <div class="filter-group">
+            <span class="filter-label">Severity:</span>
+            <button class="filter-btn active" data-filter-type="severity" data-filter="all">All</button>
+            <button class="filter-btn" data-filter-type="severity" data-filter="SAFE">Safe</button>
+            <button class="filter-btn" data-filter-type="severity" data-filter="WARNING">Warning</button>
+            <button class="filter-btn" data-filter-type="severity" data-filter="BREAKING">Breaking</button>
+        </div>
+
+        <div class="control-group">
+            <input type="text" class="search-input" placeholder="🔍 Search resource IDs, changes..." id="searchInput-{{unique_id}}">
+        </div>
+    </div>
+
+    <div class="deployment-list issues-list" id="deploymentList-{{unique_id}}"></div>
+</div>
+
+<script>
+(function() {
+    const changes = {{CHANGES_JSON}};
+    const stats = {{STATS_JSON}};
+    const uniqueId = '{{unique_id}}';
+    {{SCRIPTS}}
+})();
+</script>

cognite/neat/_session/_html/templates/issues.html

@@ -0,0 +1,45 @@
+<style>
+{{SHARED_CSS}}
+{{SPECIFIC_CSS}}
+</style>
+
+<div class="issues-container" id="issuesContainer-{{unique_id}}">
+    <div class="issues-header">
+        <button class="theme-toggle" id="themeToggle-{{unique_id}}">
+            <span id="themeIcon-{{unique_id}}">🌙</span>
+            <span id="themeText-{{unique_id}}">Dark</span>
+        </button>
+        <h2 class="issues-title">Session Issues</h2>
+        <div class="issues-stats">
+            <div class="stat-item active" data-filter="all">
+                <span class="stat-number">{{total}}</span> Total Issues
+            </div>
+            <div class="stat-item" data-filter="ModelSyntaxError">
+                <span class="stat-number">{{syntax_errors}}</span> Syntax Errors
+            </div>
+            <div class="stat-item" data-filter="ConsistencyError">
+                <span class="stat-number">{{consistency_errors}}</span> Consistency Errors
+            </div>
+            <div class="stat-item" data-filter="Recommendation">
+                <span class="stat-number">{{recommendations}}</span> Recommendations
+            </div>
+            <button class="export-btn" onclick="exportIssues_{{unique_id}}()">Export CSV</button>
+        </div>
+    </div>
+
+    <div class="issues-controls">
+        <div class="control-group">
+            <input type="text" class="search-input" placeholder="🔍 Search messages, codes, fixes..." id="searchInput-{{unique_id}}">
+        </div>
+    </div>
+
+    <div class="issues-list" id="issuesList-{{unique_id}}"></div>
+</div>
+
+<script>
+(function() {
+    const issues = {{JSON}};
+    const uniqueId = '{{unique_id}}';
+    {{SCRIPTS}}
+})();
+</script>

cognite/neat/_session/_issues.py

@@ -0,0 +1,81 @@
+import json
+import uuid
+from collections import defaultdict
+from typing import Any
+
+from cognite.neat._issues import ConsistencyError, IssueList, ModelSyntaxError, Recommendation
+from cognite.neat._session._html._render import render
+from cognite.neat._store import NeatStore
+
+
+class Issues:
+    """Class to handle issues in the NeatSession."""
+
+    def __init__(self, store: NeatStore) -> None:
+        self._store = store
+
+    @property
+    def _issues(self) -> IssueList:
+        """Get all issues from the last change in the store."""
+        issues = IssueList()
+        if change := self._store.provenance.last_change:
+            issues += change.errors or IssueList()
+            issues += change.issues or IssueList()
+        return issues
+
+    @property
+    def _stats(self) -> dict[str, Any]:
+        """Compute statistics about issues."""
+        by_type: defaultdict[str, int] = defaultdict(int)
+        by_code: defaultdict[str, int] = defaultdict(int)
+
+        stats: dict[str, Any] = {
+            "total": len(self._issues),
+            "by_type": by_type,
+            "by_code": by_code,
+            "severity_order": [ModelSyntaxError.__name__, ConsistencyError.__name__, Recommendation.__name__],
+        }
+
+        for issue in self._issues:
+            stats["by_type"][issue.issue_type()] += 1
+
+            if issue.code:
+                stats["by_code"][f"{issue.issue_type()}:{issue.code}"] += 1
+
+        return stats
+
+    @property
+    def _serialized_issues(self) -> list[dict[str, Any]]:
+        """Convert issues to JSON-serializable format."""
+        serialized = []
+        for idx, issue in enumerate(self._issues):
+            serialized.append(
+                {
+                    "id": idx,
+                    "type": issue.issue_type(),
+                    "code": issue.code or "",
+                    "message": issue.message,
+                    "fix": issue.fix or "",
+                }
+            )
+        return serialized
+
+    def _repr_html_(self) -> str:
+        """Generate interactive HTML representation."""
+        if not self._issues:
+            return "<b>No issues found.</b>"
+        stats = self._stats
+
+        # Generate unique ID for this render to avoid conflicts in Jupyter
+        unique_id = uuid.uuid4().hex[:8]
+
+        template_vars = {
+            "JSON": json.dumps(self._serialized_issues),
+            "total": stats["total"],
+            "syntax_errors": stats["by_type"].get("ModelSyntaxError", 0),
+            "consistency_errors": stats["by_type"].get("ConsistencyError", 0),
+            "recommendations": stats["by_type"].get("Recommendation", 0),
+            "unique_id": unique_id,
+        }
+
+        return render("issues", template_vars)

cognite/neat/_session/_opt.py

@@ -0,0 +1,35 @@
+from cognite.neat._session._usage_analytics._collector import Collector
+from cognite.neat._session._wrappers import session_wrapper
+from cognite.neat._store import NeatStore
+
+
+@session_wrapper
+class Opt:
+    """For the user to decide if they want their usage of neat to be collected or not. We do not collect personal
+    information like name etc. only usage.
+    """
+
+    def __init__(self, store: NeatStore) -> None:
+        self._collector = Collector()
+        self._display()
+        self._store = store
+
+    def _display(self) -> None:
+        if self._collector.is_opted_in or self._collector.is_opted_out:
+            return
+        print(
+            "For Neat to improve, we need to collect usage information. "
+            "You acknowledge and agree that neat may collect usage information."
+            "To remove this message run 'neat.opt.in_() "
+            "or to stop collecting usage information run 'neat.opt.out()'."
+        )
+
+    def in_(self) -> None:
+        """Consent to collection of neat user insights."""
+        self._collector.enable()
+        print("You have successfully opted in to data collection.")
+
+    def out(self) -> None:
+        """Opt out of allowing usage of neat to be collected from current user."""
+        self._collector.disable()
+        print("You have successfully opted out of data collection.")