@memberjunction/db-auto-doc 2.109.0

package/dist/state/state-manager.js

@@ -0,0 +1,236 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StateManager = void 0;
+const fs = __importStar(require("fs/promises"));
+const path = __importStar(require("path"));
+const state_file_1 = require("../types/state-file");
+/**
+ * State file manager - handles read/write/merge of db-doc-state.json
+ */
+class StateManager {
+    constructor(options = {}) {
+        this.stateFilePath = options.stateFilePath || path.join(process.cwd(), 'db-doc-state.json');
+    }
+    /**
+     * Load state file (or create if doesn't exist)
+     */
+    async load(server, database) {
+        try {
+            const content = await fs.readFile(this.stateFilePath, 'utf-8');
+            this.state = JSON.parse(content);
+            return this.state;
+        }
+        catch (error) {
+            // File doesn't exist, create new
+            if (server && database) {
+                this.state = (0, state_file_1.createEmptyStateFile)(server, database);
+                await this.save();
+                return this.state;
+            }
+            throw new Error(`State file not found at ${this.stateFilePath} and no server/database provided`);
+        }
+    }
+    /**
+     * Save state file
+     */
+    async save() {
+        if (!this.state) {
+            throw new Error('No state to save');
+        }
+        this.state.lastModified = new Date().toISOString();
+        const content = JSON.stringify(this.state, null, 2);
+        await fs.writeFile(this.stateFilePath, content, 'utf-8');
+    }
+    /**
+     * Get current state
+     */
+    getState() {
+        if (!this.state) {
+            throw new Error('State not loaded');
+        }
+        return this.state;
+    }
+    /**
+     * Update table with AI-generated documentation
+     */
+    updateTableAI(schemaName, tableName, aiDoc) {
+        if (!this.state)
+            throw new Error('State not loaded');
+        const schema = (0, state_file_1.getOrCreateSchema)(this.state, schemaName);
+        const table = (0, state_file_1.getOrCreateTable)(schema, tableName);
+        table.aiGenerated = {
+            description: aiDoc.description,
+            purpose: aiDoc.purpose,
+            usageNotes: aiDoc.usageNotes,
+            businessDomain: aiDoc.businessDomain,
+            confidence: aiDoc.confidence,
+            generatedAt: new Date().toISOString(),
+            model: aiDoc.model,
+            tokensUsed: aiDoc.tokensUsed,
+            relationships: aiDoc.relationships,
+        };
+        table.lastModified = new Date().toISOString();
+        // Update final description
+        table.finalDescription = (0, state_file_1.mergeFinalDescription)(table.userDescription, table.userNotes, table.aiGenerated.description);
+    }
+    /**
+     * Update column with AI-generated documentation
+     */
+    updateColumnAI(schemaName, tableName, columnName, aiDoc) {
+        if (!this.state)
+            throw new Error('State not loaded');
+        const schema = (0, state_file_1.getOrCreateSchema)(this.state, schemaName);
+        const table = (0, state_file_1.getOrCreateTable)(schema, tableName);
+        const column = (0, state_file_1.getOrCreateColumn)(table, columnName);
+        column.aiGenerated = {
+            description: aiDoc.description,
+            purpose: aiDoc.purpose,
+            validValues: aiDoc.validValues,
+            usageNotes: aiDoc.usageNotes,
+            confidence: aiDoc.confidence,
+            generatedAt: new Date().toISOString(),
+            model: aiDoc.model,
+        };
+        column.lastModified = new Date().toISOString();
+        // Update final description
+        column.finalDescription = (0, state_file_1.mergeFinalDescription)(column.userDescription, column.userNotes, column.aiGenerated.description);
+    }
+    /**
+     * Mark table as user approved
+     */
+    approveTable(schemaName, tableName) {
+        if (!this.state)
+            throw new Error('State not loaded');
+        const schema = (0, state_file_1.getOrCreateSchema)(this.state, schemaName);
+        const table = (0, state_file_1.getOrCreateTable)(schema, tableName);
+        table.userApproved = true;
+        table.lastModified = new Date().toISOString();
+    }
+    /**
+     * Mark column as user approved
+     */
+    approveColumn(schemaName, tableName, columnName) {
+        if (!this.state)
+            throw new Error('State not loaded');
+        const schema = (0, state_file_1.getOrCreateSchema)(this.state, schemaName);
+        const table = (0, state_file_1.getOrCreateTable)(schema, tableName);
+        const column = (0, state_file_1.getOrCreateColumn)(table, columnName);
+        column.userApproved = true;
+        column.lastModified = new Date().toISOString();
+    }
+    /**
+     * Add user notes to table
+     */
+    addTableNotes(schemaName, tableName, notes) {
+        if (!this.state)
+            throw new Error('State not loaded');
+        const schema = (0, state_file_1.getOrCreateSchema)(this.state, schemaName);
+        const table = (0, state_file_1.getOrCreateTable)(schema, tableName);
+        table.userNotes = notes;
+        table.lastModified = new Date().toISOString();
+        // Update final description
+        table.finalDescription = (0, state_file_1.mergeFinalDescription)(table.userDescription, table.userNotes, table.aiGenerated?.description);
+    }
+    /**
+     * Add user notes to column
+     */
+    addColumnNotes(schemaName, tableName, columnName, notes) {
+        if (!this.state)
+            throw new Error('State not loaded');
+        const schema = (0, state_file_1.getOrCreateSchema)(this.state, schemaName);
+        const table = (0, state_file_1.getOrCreateTable)(schema, tableName);
+        const column = (0, state_file_1.getOrCreateColumn)(table, columnName);
+        column.userNotes = notes;
+        column.lastModified = new Date().toISOString();
+        // Update final description
+        column.finalDescription = (0, state_file_1.mergeFinalDescription)(column.userDescription, column.userNotes, column.aiGenerated?.description);
+    }
+    /**
+     * Add run history entry
+     */
+    addRunHistory(entry) {
+        if (!this.state)
+            throw new Error('State not loaded');
+        this.state.runHistory.push(entry);
+    }
+    /**
+     * Get tables that need processing (no AI generation yet)
+     */
+    getTablesNeedingProcessing(schemaName) {
+        if (!this.state)
+            throw new Error('State not loaded');
+        const tables = [];
+        for (const [schema, schemaState] of Object.entries(this.state.schemas)) {
+            if (schemaName && schema !== schemaName)
+                continue;
+            for (const [table, tableState] of Object.entries(schemaState.tables)) {
+                if (!tableState.aiGenerated) {
+                    tables.push({ schema, table });
+                }
+            }
+        }
+        return tables;
+    }
+    /**
+     * Get unapproved tables
+     */
+    getUnapprovedTables(schemaName) {
+        if (!this.state)
+            throw new Error('State not loaded');
+        const tables = [];
+        for (const [schema, schemaState] of Object.entries(this.state.schemas)) {
+            if (schemaName && schema !== schemaName)
+                continue;
+            for (const [table, tableState] of Object.entries(schemaState.tables)) {
+                if (tableState.aiGenerated && !tableState.userApproved) {
+                    tables.push({ schema, table });
+                }
+            }
+        }
+        return tables;
+    }
+    /**
+     * Check if state file exists
+     */
+    async exists() {
+        try {
+            await fs.access(this.stateFilePath);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Reset state file
+     */
+    async reset(server, database) {
+        this.state = (0, state_file_1.createEmptyStateFile)(server, database);
+        await this.save();
+    }
+}
+exports.StateManager = StateManager;
+//# sourceMappingURL=state-manager.js.map

package/dist/state/state-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state-manager.js","sourceRoot":"","sources":["../../src/state/state-manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAkC;AAClC,2CAA6B;AAC7B,oDAW6B;AAM7B;;GAEG;AACH,MAAa,YAAY;IAIvB,YAAY,UAA+B,EAAE;QAC3C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,MAAe,EAAE,QAAiB;QAC3C,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;YAC/D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACjC,OAAO,IAAI,CAAC,KAAM,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,iCAAiC;YACjC,IAAI,MAAM,IAAI,QAAQ,EAAE,CAAC;gBACvB,IAAI,CAAC,KAAK,GAAG,IAAA,iCAAoB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;gBACpD,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,OAAO,IAAI,CAAC,KAAK,CAAC;YACpB,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,aAAa,kCAAkC,CAAC,CAAC;QACnG,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,aAAa,CACX,UAAkB,EAClB,SAAiB,EACjB,KAaC;QAED,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAErD,MAAM,MAAM,GAAG,IAAA,8BAAiB,EAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,IAAA,6BAAgB,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAElD,KAAK,CAAC,WAAW,GAAG;YAClB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACrC,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,aAAa,EAAE,KAAK,CAAC,aAAa;SACnC,CAAC;QAEF,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE9C,2BAA2B;QAC3B,KAAK,CAAC,gBAAgB,GAAG,IAAA,kCAAqB,EAC5C,KAAK,CAAC,eAAe,EACrB,KAAK,CAAC,SAAS,EACf,KAAK,CAAC,WAAW,CAAC,WAAW,CAC9B,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,UAAkB,EAClB,SAAiB,EACjB,UAAkB,EAClB,KAOC;QAED,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAErD,MAAM,MAAM,GAAG,IAAA,8BAAiB,EAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,IAAA,6BAAgB,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,IAAA,8BAAiB,EAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAEpD,MAAM,CAAC,WAAW,GAAG;YACnB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACrC,KAAK,EAAE,KAAK,CAAC,KAAK;SACnB,CAAC;QAEF,MAAM,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE/C,2BAA2B;QAC3B,MAAM,CAAC,gBAAgB,GAAG,IAAA,kCAAqB,EAC7C,MAAM,CAAC,eAAe,EACtB,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,WAAW,CAAC,WAAW,CAC/B,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,UAAkB,EAAE,SAAiB;QAChD,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAErD,MAAM,MAAM,GAAG,IAAA,8BAAiB,EAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,IAAA,6BAAgB,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAElD,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC1B,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,UAAkB,EAAE,SAAiB,EAAE,UAAkB;QACrE,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAErD,MAAM,MAAM,GAAG,IAAA,8BAAiB,EAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,IAAA,6BAAgB,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,IAAA,8BAAiB,EAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAEpD,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;QAC3B,MAAM,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,UAAkB,EAAE,SAAiB,EAAE,KAAa;QAChE,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAErD,MAAM,MAAM,GAAG,IAAA,8BAAiB,EAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,IAAA,6BAAgB,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAElD,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC;QACxB,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE9C,2BAA2B;QAC3B,KAAK,CAAC,gBAAgB,GAAG,IAAA,kCAAqB,EAC5C,KAAK,CAAC,eAAe,EACrB,KAAK,CAAC,SAAS,EACf,KAAK,CAAC,WAAW,EAAE,WAAW,CAC/B,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,UAAkB,EAAE,SAAiB,EAAE,UAAkB,EAAE,KAAa;QACrF,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAErD,MAAM,MAAM,GAAG,IAAA,8BAAiB,EAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,IAAA,6BAAgB,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,IAAA,8BAAiB,EAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAEpD,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC;QACzB,MAAM,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE/C,2BAA2B;QAC3B,MAAM,CAAC,gBAAgB,GAAG,IAAA,kCAAqB,EAC7C,MAAM,CAAC,eAAe,EACtB,MAAM,CAAC,SAAS,EAChB,MAAM,CAAC,WAAW,EAAE,WAAW,CAChC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,KAAsB;QAClC,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,0BAA0B,CAAC,UAAmB;QAC5C,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAErD,MAAM,MAAM,GAA6C,EAAE,CAAC;QAE5D,KAAK,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YACvE,IAAI,UAAU,IAAI,MAAM,KAAK,UAAU;gBAAE,SAAS;YAElD,KAAK,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;gBACrE,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;oBAC5B,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjC,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,mBAAmB,CAAC,UAAmB;QACrC,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAErD,MAAM,MAAM,GAA6C,EAAE,CAAC;QAE5D,KAAK,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YACvE,IAAI,UAAU,IAAI,MAAM,KAAK,UAAU;gBAAE,SAAS;YAElD,KAAK,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;gBACrE,IAAI,UAAU,CAAC,WAAW,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;oBACvD,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjC,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACpC,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,MAAc,EAAE,QAAgB;QAC1C,IAAI,CAAC,KAAK,GAAG,IAAA,iCAAoB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACpD,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IACpB,CAAC;CACF;AArRD,oCAqRC"}

package/dist/types/state-file.d.ts

@@ -0,0 +1,124 @@
+/**
+ * State file type definitions for SQL Server Documentation Generator
+ * This file is persisted as db-doc-state.json and tracks all documentation state
+ */
+/**
+ * AI-generated documentation with metadata
+ */
+export interface AIGenerated {
+    description: string;
+    confidence: number;
+    generatedAt: string;
+    model: string;
+    tokensUsed?: number;
+}
+/**
+ * Column state in the documentation
+ */
+export interface ColumnState {
+    userNotes?: string;
+    userDescription?: string;
+    userApproved?: boolean;
+    aiGenerated?: AIGenerated & {
+        purpose?: string;
+        validValues?: string;
+        usageNotes?: string;
+    };
+    finalDescription?: string;
+    lastModified?: string;
+}
+/**
+ * Table state in the documentation
+ */
+export interface TableState {
+    userNotes?: string;
+    userDescription?: string;
+    userApproved?: boolean;
+    userBusinessDomain?: string;
+    aiGenerated?: AIGenerated & {
+        purpose?: string;
+        usageNotes?: string;
+        businessDomain?: string;
+        relationships?: Array<{
+            type: 'parent' | 'child';
+            table: string;
+            description: string;
+        }>;
+    };
+    finalDescription?: string;
+    columns: Record<string, ColumnState>;
+    lastModified?: string;
+    lastAnalyzed?: string;
+}
+/**
+ * Schema state in the documentation
+ */
+export interface SchemaState {
+    description?: string;
+    businessDomain?: string;
+    userNotes?: string;
+    tables: Record<string, TableState>;
+}
+/**
+ * Seed context provided by user
+ */
+export interface SeedContext {
+    overallPurpose?: string;
+    businessDomains?: string[];
+    customInstructions?: string;
+    industryContext?: string;
+}
+/**
+ * Run history entry
+ */
+export interface RunHistoryEntry {
+    timestamp: string;
+    phase: 'analyze' | 'review' | 'export';
+    tablesProcessed?: number;
+    schemasProcessed?: number;
+    tokensUsed?: number;
+    cost?: number;
+    duration?: number;
+    errors?: string[];
+}
+/**
+ * Database connection info (no credentials - those go in .env)
+ */
+export interface DatabaseInfo {
+    server: string;
+    database: string;
+    lastConnected?: string;
+}
+/**
+ * Complete state file structure
+ */
+export interface StateFile {
+    version: string;
+    database: DatabaseInfo;
+    seedContext?: SeedContext;
+    schemas: Record<string, SchemaState>;
+    runHistory: RunHistoryEntry[];
+    createdAt: string;
+    lastModified: string;
+}
+/**
+ * Default empty state file
+ */
+export declare function createEmptyStateFile(server: string, database: string): StateFile;
+/**
+ * Helper to get or create schema state
+ */
+export declare function getOrCreateSchema(state: StateFile, schemaName: string): SchemaState;
+/**
+ * Helper to get or create table state
+ */
+export declare function getOrCreateTable(schema: SchemaState, tableName: string): TableState;
+/**
+ * Helper to get or create column state
+ */
+export declare function getOrCreateColumn(table: TableState, columnName: string): ColumnState;
+/**
+ * Merge AI-generated description with user input to create final description
+ */
+export declare function mergeFinalDescription(userDescription?: string, userNotes?: string, aiDescription?: string): string | undefined;
+//# sourceMappingURL=state-file.d.ts.map

package/dist/types/state-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"state-file.d.ts","sourceRoot":"","sources":["../../src/types/state-file.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAE1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;IAGvB,WAAW,CAAC,EAAE,WAAW,GAAG;QAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IAGF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAG1B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IAEzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAG5B,WAAW,CAAC,EAAE,WAAW,GAAG;QAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,aAAa,CAAC,EAAE,KAAK,CAAC;YACpB,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;YACzB,KAAK,EAAE,MAAM,CAAC;YACd,WAAW,EAAE,MAAM,CAAC;SACrB,CAAC,CAAC;KACJ,CAAC;IAGF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAG1B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAGrC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IAGnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,YAAY,CAAC;IACvB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACrC,UAAU,EAAE,eAAe,EAAE,CAAC;IAG9B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,CAehF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,GAAG,WAAW,CAOnF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,GAAG,UAAU,CAOnF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,GAAG,WAAW,CAKpF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,eAAe,CAAC,EAAE,MAAM,EACxB,SAAS,CAAC,EAAE,MAAM,EAClB,aAAa,CAAC,EAAE,MAAM,GACrB,MAAM,GAAG,SAAS,CAepB"}

package/dist/types/state-file.js

@@ -0,0 +1,79 @@
+"use strict";
+/**
+ * State file type definitions for SQL Server Documentation Generator
+ * This file is persisted as db-doc-state.json and tracks all documentation state
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeFinalDescription = exports.getOrCreateColumn = exports.getOrCreateTable = exports.getOrCreateSchema = exports.createEmptyStateFile = void 0;
+/**
+ * Default empty state file
+ */
+function createEmptyStateFile(server, database) {
+    const now = new Date().toISOString();
+    return {
+        version: '1.0',
+        database: {
+            server,
+            database,
+            lastConnected: now,
+        },
+        schemas: {},
+        runHistory: [],
+        createdAt: now,
+        lastModified: now,
+    };
+}
+exports.createEmptyStateFile = createEmptyStateFile;
+/**
+ * Helper to get or create schema state
+ */
+function getOrCreateSchema(state, schemaName) {
+    if (!state.schemas[schemaName]) {
+        state.schemas[schemaName] = {
+            tables: {},
+        };
+    }
+    return state.schemas[schemaName];
+}
+exports.getOrCreateSchema = getOrCreateSchema;
+/**
+ * Helper to get or create table state
+ */
+function getOrCreateTable(schema, tableName) {
+    if (!schema.tables[tableName]) {
+        schema.tables[tableName] = {
+            columns: {},
+        };
+    }
+    return schema.tables[tableName];
+}
+exports.getOrCreateTable = getOrCreateTable;
+/**
+ * Helper to get or create column state
+ */
+function getOrCreateColumn(table, columnName) {
+    if (!table.columns[columnName]) {
+        table.columns[columnName] = {};
+    }
+    return table.columns[columnName];
+}
+exports.getOrCreateColumn = getOrCreateColumn;
+/**
+ * Merge AI-generated description with user input to create final description
+ */
+function mergeFinalDescription(userDescription, userNotes, aiDescription) {
+    // Priority: user description > AI description
+    if (userDescription) {
+        return userDescription;
+    }
+    if (aiDescription) {
+        // If user notes exist, prepend them
+        if (userNotes) {
+            return `${userNotes}. ${aiDescription}`;
+        }
+        return aiDescription;
+    }
+    return undefined;
+}
+exports.mergeFinalDescription = mergeFinalDescription;
+//# sourceMappingURL=state-file.js.map

package/dist/types/state-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state-file.js","sourceRoot":"","sources":["../../src/types/state-file.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAiIH;;GAEG;AACH,SAAgB,oBAAoB,CAAC,MAAc,EAAE,QAAgB;IACnE,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAErC,OAAO;QACL,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE;YACR,MAAM;YACN,QAAQ;YACR,aAAa,EAAE,GAAG;SACnB;QACD,OAAO,EAAE,EAAE;QACX,UAAU,EAAE,EAAE;QACd,SAAS,EAAE,GAAG;QACd,YAAY,EAAE,GAAG;KAClB,CAAC;AACJ,CAAC;AAfD,oDAeC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,KAAgB,EAAE,UAAkB;IACpE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG;YAC1B,MAAM,EAAE,EAAE;SACX,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AACnC,CAAC;AAPD,8CAOC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,MAAmB,EAAE,SAAiB;IACrE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG;YACzB,OAAO,EAAE,EAAE;SACZ,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;AAClC,CAAC;AAPD,4CAOC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,KAAiB,EAAE,UAAkB;IACrE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;IACjC,CAAC;IACD,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AACnC,CAAC;AALD,8CAKC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CACnC,eAAwB,EACxB,SAAkB,EAClB,aAAsB;IAEtB,8CAA8C;IAC9C,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,oCAAoC;QACpC,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,GAAG,SAAS,KAAK,aAAa,EAAE,CAAC;QAC1C,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAnBD,sDAmBC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@memberjunction/db-auto-doc",
+  "version": "2.109.0",
+  "description": "AI-powered SQL Server database documentation generator. Analyzes your database structure, uses AI to generate comprehensive descriptions, and saves them as extended properties. Works standalone - no MemberJunction runtime required.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "db-auto-doc": "bin/run.js"
+  },
+  "oclif": {
+    "bin": "db-auto-doc",
+    "commands": "./dist/commands",
+    "dirname": "db-auto-doc",
+    "topicSeparator": " ",
+    "plugins": [
+      "@oclif/plugin-help"
+    ]
+  },
+  "files": [
+    "/bin",
+    "/dist"
+  ],
+  "scripts": {
+    "start": "ts-node-dev src/cli/cli.ts",
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "clean": "rm -rf dist",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "sql-server",
+    "database",
+    "documentation",
+    "ai",
+    "metadata",
+    "extended-properties",
+    "database-documentation",
+    "sql-server-documentation",
+    "auto-documentation"
+  ],
+  "author": "MemberJunction.com",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/inquirer": "^9.0.7",
+    "@types/mssql": "^9.1.1",
+    "@types/node": "^20.10.0",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^5.0.6",
+    "@oclif/core": "^3.27.0",
+    "@oclif/plugin-help": "^6.2.33",
+    "chalk": "^4.1.2",
+    "commander": "^11.1.0",
+    "dotenv": "^16.3.1",
+    "inquirer": "^8.2.5",
+    "mssql": "^10.0.1",
+    "ora": "^5.4.1",
+    "zod": "^3.22.4"
+  }
+}