@sonisoft/now-sdk-ext-core 2.2.1 → 2.5.1

package/dist/sn/schema/SchemaDiscovery.js

@@ -0,0 +1,346 @@
+import { Logger } from "../../util/Logger.js";
+import { ServiceNowRequest } from "../../comm/http/ServiceNowRequest.js";
+import { TableAPIRequest } from "../../comm/http/TableAPIRequest.js";
+/**
+ * SchemaDiscovery provides operations for discovering ServiceNow table schemas,
+ * explaining fields, and validating catalog configurations.
+ */
+export class SchemaDiscovery {
+    static SYS_DB_OBJECT_TABLE = 'sys_db_object';
+    static SYS_DICTIONARY_TABLE = 'sys_dictionary';
+    static SYS_CHOICE_TABLE = 'sys_choice';
+    static ITEM_OPTION_NEW_TABLE = 'item_option_new';
+    static CATALOG_UI_POLICY_TABLE = 'catalog_ui_policy';
+    _logger = new Logger("SchemaDiscovery");
+    _req;
+    _tableAPI;
+    _instance;
+    constructor(instance) {
+        this._instance = instance;
+        this._req = new ServiceNowRequest(instance);
+        this._tableAPI = new TableAPIRequest(instance);
+    }
+    /**
+     * Discover the schema for a ServiceNow table.
+     * Queries sys_db_object for table info and sys_dictionary for field definitions.
+     * Optionally includes choice tables, relationships, UI policies, and business rules.
+     *
+     * @param tableName The name of the table to discover
+     * @param options Optional flags to include additional information
+     * @returns TableSchema with all discovered information
+     * @throws Error if tableName is empty or the table is not found
+     */
+    async discoverTableSchema(tableName, options = {}) {
+        if (!tableName || tableName.trim().length === 0) {
+            throw new Error('Table name is required');
+        }
+        this._logger.info(`Discovering schema for table: ${tableName}`);
+        // Query sys_db_object for the table record
+        const tableQuery = {
+            sysparm_query: `name=${tableName}`,
+            sysparm_limit: 1
+        };
+        const tableResp = await this._tableAPI.get(SchemaDiscovery.SYS_DB_OBJECT_TABLE, tableQuery);
+        if (!tableResp || tableResp.status !== 200 || !tableResp.bodyObject?.result || tableResp.bodyObject.result.length === 0) {
+            throw new Error(`Table '${tableName}' not found in sys_db_object`);
+        }
+        const tableRecord = tableResp.bodyObject.result[0];
+        // Query sys_dictionary for field definitions
+        const dictQuery = {
+            sysparm_query: `name=${tableName}^elementISNOTEMPTY`,
+            sysparm_limit: 500
+        };
+        const dictResp = await this._tableAPI.get(SchemaDiscovery.SYS_DICTIONARY_TABLE, dictQuery);
+        const dictRecords = (dictResp.status === 200 && dictResp.bodyObject?.result) ? dictResp.bodyObject.result : [];
+        // Build field schemas
+        const fields = dictRecords.map((record) => {
+            const internalType = typeof record.internal_type === 'object' && record.internal_type !== null
+                ? record.internal_type.value || ''
+                : (record.internal_type || '');
+            const referenceTable = typeof record.reference === 'object' && record.reference !== null
+                ? record.reference.value || undefined
+                : (record.reference || undefined);
+            return {
+                name: record.element,
+                label: record.column_label || record.element,
+                internalType: internalType,
+                maxLength: parseInt(record.max_length || '0', 10),
+                mandatory: record.mandatory === 'true',
+                readOnly: record.read_only === 'true',
+                referenceTable: referenceTable,
+                defaultValue: record.default_value || undefined
+            };
+        });
+        // Determine super class
+        let superClass;
+        if (tableRecord.super_class) {
+            superClass = typeof tableRecord.super_class === 'object' && tableRecord.super_class !== null
+                ? tableRecord.super_class.display_value || tableRecord.super_class.value
+                : tableRecord.super_class;
+        }
+        const schema = {
+            table: tableName,
+            label: tableRecord.label || tableName,
+            superClass,
+            fields
+        };
+        // Optionally include choice tables
+        if (options.includeChoiceTables) {
+            schema.choiceTables = await this._getChoicesForTable(tableName);
+        }
+        // Optionally include relationships
+        if (options.includeRelationships) {
+            schema.relationships = this._extractRelationships(fields);
+        }
+        // Optionally include UI policies
+        if (options.includeUIPolicies) {
+            schema.uiPolicies = await this._getUIPoliciesForTable(tableName);
+        }
+        // Optionally include business rules
+        if (options.includeBusinessRules) {
+            schema.businessRules = await this._getBusinessRulesForTable(tableName);
+        }
+        this._logger.info(`Discovered schema for ${tableName}: ${fields.length} fields`);
+        return schema;
+    }
+    /**
+     * Explain a specific field on a table.
+     * Queries sys_dictionary for the field definition and sys_choice for available choices.
+     *
+     * @param tableName The table containing the field
+     * @param fieldName The field name to explain
+     * @returns Detailed FieldExplanation
+     * @throws Error if tableName or fieldName is empty, or the field is not found
+     */
+    async explainField(tableName, fieldName) {
+        if (!tableName || tableName.trim().length === 0) {
+            throw new Error('Table name is required');
+        }
+        if (!fieldName || fieldName.trim().length === 0) {
+            throw new Error('Field name is required');
+        }
+        this._logger.info(`Explaining field: ${tableName}.${fieldName}`);
+        // Query sys_dictionary for the specific field
+        const dictQuery = {
+            sysparm_query: `name=${tableName}^element=${fieldName}`,
+            sysparm_limit: 1
+        };
+        const dictResp = await this._tableAPI.get(SchemaDiscovery.SYS_DICTIONARY_TABLE, dictQuery);
+        if (!dictResp || dictResp.status !== 200 || !dictResp.bodyObject?.result || dictResp.bodyObject.result.length === 0) {
+            throw new Error(`Field '${fieldName}' not found on table '${tableName}'`);
+        }
+        const record = dictResp.bodyObject.result[0];
+        const internalType = typeof record.internal_type === 'object' && record.internal_type !== null
+            ? record.internal_type.value || ''
+            : (record.internal_type || '');
+        const referenceTable = typeof record.reference === 'object' && record.reference !== null
+            ? record.reference.value || undefined
+            : (record.reference || undefined);
+        // Query sys_choice for available choices
+        const choiceQuery = {
+            sysparm_query: `name=${tableName}^element=${fieldName}`,
+            sysparm_limit: 500
+        };
+        const choiceResp = await this._tableAPI.get(SchemaDiscovery.SYS_CHOICE_TABLE, choiceQuery);
+        let choices;
+        if (choiceResp.status === 200 && choiceResp.bodyObject?.result && choiceResp.bodyObject.result.length > 0) {
+            choices = choiceResp.bodyObject.result.map((choice) => ({
+                label: choice.label,
+                value: choice.value
+            }));
+        }
+        this._logger.info(`Explained field: ${tableName}.${fieldName}`);
+        return {
+            field: fieldName,
+            table: tableName,
+            label: record.column_label || fieldName,
+            type: internalType,
+            maxLength: parseInt(record.max_length || '0', 10),
+            mandatory: record.mandatory === 'true',
+            readOnly: record.read_only === 'true',
+            comments: record.comments || undefined,
+            help: record.help || undefined,
+            referenceTable,
+            choices
+        };
+    }
+    /**
+     * Validate a catalog item configuration.
+     * Checks variables (item_option_new) and UI policies (catalog_ui_policy) for integrity issues.
+     *
+     * @param catalogItemSysId The sys_id of the catalog item to validate
+     * @returns Validation result with issues, warnings, and errors
+     * @throws Error if catalogItemSysId is empty
+     */
+    async validateCatalogConfiguration(catalogItemSysId) {
+        if (!catalogItemSysId || catalogItemSysId.trim().length === 0) {
+            throw new Error('Catalog item sys_id is required');
+        }
+        this._logger.info(`Validating catalog configuration for: ${catalogItemSysId}`);
+        const issues = [];
+        // Query variables (item_option_new)
+        const varQuery = {
+            sysparm_query: `cat_item=${catalogItemSysId}`,
+            sysparm_limit: 500
+        };
+        const varResp = await this._tableAPI.get(SchemaDiscovery.ITEM_OPTION_NEW_TABLE, varQuery);
+        const variables = (varResp.status === 200 && varResp.bodyObject?.result) ? varResp.bodyObject.result : [];
+        // Validate variables
+        const variableNames = new Set();
+        for (const variable of variables) {
+            // Check for missing name
+            if (!variable.name || variable.name.trim().length === 0) {
+                issues.push({
+                    severity: 'error',
+                    component: 'variable',
+                    sys_id: variable.sys_id,
+                    issue: 'Variable has no name',
+                    fix: 'Set a unique variable name'
+                });
+            }
+            else {
+                // Check for duplicate names
+                if (variableNames.has(variable.name)) {
+                    issues.push({
+                        severity: 'error',
+                        component: 'variable',
+                        sys_id: variable.sys_id,
+                        issue: `Duplicate variable name: ${variable.name}`,
+                        fix: 'Rename the variable to be unique within the catalog item'
+                    });
+                }
+                variableNames.add(variable.name);
+            }
+            // Check for missing question text
+            if (!variable.question_text || variable.question_text.trim().length === 0) {
+                issues.push({
+                    severity: 'warning',
+                    component: 'variable',
+                    sys_id: variable.sys_id,
+                    issue: `Variable '${variable.name || 'unnamed'}' has no question text`,
+                    fix: 'Add a descriptive question text for the variable'
+                });
+            }
+            // Check for inactive mandatory variables
+            if (variable.mandatory === 'true' && variable.active === 'false') {
+                issues.push({
+                    severity: 'warning',
+                    component: 'variable',
+                    sys_id: variable.sys_id,
+                    issue: `Mandatory variable '${variable.name || 'unnamed'}' is inactive`,
+                    fix: 'Either activate the variable or remove the mandatory flag'
+                });
+            }
+        }
+        // Query UI policies
+        const policyQuery = {
+            sysparm_query: `catalog_item=${catalogItemSysId}`,
+            sysparm_limit: 500
+        };
+        const policyResp = await this._tableAPI.get(SchemaDiscovery.CATALOG_UI_POLICY_TABLE, policyQuery);
+        const policies = (policyResp.status === 200 && policyResp.bodyObject?.result) ? policyResp.bodyObject.result : [];
+        // Validate UI policies
+        for (const policy of policies) {
+            if (!policy.short_description || policy.short_description.trim().length === 0) {
+                issues.push({
+                    severity: 'warning',
+                    component: 'ui_policy',
+                    sys_id: policy.sys_id,
+                    issue: 'UI policy has no short description',
+                    fix: 'Add a descriptive short description to the UI policy'
+                });
+            }
+        }
+        const errorCount = issues.filter(i => i.severity === 'error').length;
+        const warningCount = issues.filter(i => i.severity === 'warning').length;
+        this._logger.info(`Validation complete: ${errorCount} errors, ${warningCount} warnings`);
+        return {
+            valid: errorCount === 0,
+            issues,
+            warnings: warningCount,
+            errors: errorCount
+        };
+    }
+    /**
+     * Get choice values for all fields on a table.
+     * @private
+     */
+    async _getChoicesForTable(tableName) {
+        const choiceQuery = {
+            sysparm_query: `name=${tableName}`,
+            sysparm_limit: 1000
+        };
+        const choiceResp = await this._tableAPI.get(SchemaDiscovery.SYS_CHOICE_TABLE, choiceQuery);
+        if (choiceResp.status !== 200 || !choiceResp.bodyObject?.result) {
+            return [];
+        }
+        // Group choices by field
+        const fieldChoices = new Map();
+        for (const choice of choiceResp.bodyObject.result) {
+            if (!fieldChoices.has(choice.element)) {
+                fieldChoices.set(choice.element, []);
+            }
+            fieldChoices.get(choice.element).push({
+                label: choice.label,
+                value: choice.value
+            });
+        }
+        return Array.from(fieldChoices.entries()).map(([field, choices]) => ({
+            field,
+            choices
+        }));
+    }
+    /**
+     * Extract relationship information from field schemas (reference fields).
+     * @private
+     */
+    _extractRelationships(fields) {
+        return fields
+            .filter(f => f.referenceTable)
+            .map(f => ({
+            name: f.name,
+            type: 'reference',
+            relatedTable: f.referenceTable
+        }));
+    }
+    /**
+     * Get UI policies for a table.
+     * @private
+     */
+    async _getUIPoliciesForTable(tableName) {
+        const query = {
+            sysparm_query: `table=${tableName}`,
+            sysparm_limit: 500
+        };
+        const resp = await this._tableAPI.get('sys_ui_policy', query);
+        if (resp.status !== 200 || !resp.bodyObject?.result) {
+            return [];
+        }
+        return resp.bodyObject.result.map(policy => ({
+            sys_id: policy.sys_id,
+            short_description: policy.short_description || '',
+            active: policy.active === 'true'
+        }));
+    }
+    /**
+     * Get business rules for a table.
+     * @private
+     */
+    async _getBusinessRulesForTable(tableName) {
+        const query = {
+            sysparm_query: `collection=${tableName}`,
+            sysparm_limit: 500
+        };
+        const resp = await this._tableAPI.get('sys_script', query);
+        if (resp.status !== 200 || !resp.bodyObject?.result) {
+            return [];
+        }
+        return resp.bodyObject.result.map(rule => ({
+            sys_id: rule.sys_id,
+            name: rule.name || '',
+            when: rule.when || '',
+            active: rule.active === 'true'
+        }));
+    }
+}
+//# sourceMappingURL=SchemaDiscovery.js.map

package/dist/sn/schema/SchemaDiscovery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaDiscovery.js","sourceRoot":"","sources":["../../../src/sn/schema/SchemaDiscovery.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAqBlE;;;GAGG;AACH,MAAM,OAAO,eAAe;IAChB,MAAM,CAAU,mBAAmB,GAAG,eAAe,CAAC;IACtD,MAAM,CAAU,oBAAoB,GAAG,gBAAgB,CAAC;IACxD,MAAM,CAAU,gBAAgB,GAAG,YAAY,CAAC;IAChD,MAAM,CAAU,qBAAqB,GAAG,iBAAiB,CAAC;IAC1D,MAAM,CAAU,uBAAuB,GAAG,mBAAmB,CAAC;IAE9D,OAAO,GAAW,IAAI,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAChD,IAAI,CAAoB;IACxB,SAAS,CAAkB;IAC3B,SAAS,CAAqB;IAEtC,YAAmB,QAA4B;QAC3C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,mBAAmB,CAAC,SAAiB,EAAE,UAA8B,EAAE;QAChF,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,SAAS,EAAE,CAAC,CAAC;QAEhE,2CAA2C;QAC3C,MAAM,UAAU,GAAoC;YAChD,aAAa,EAAE,QAAQ,SAAS,EAAE;YAClC,aAAa,EAAE,CAAC;SACnB,CAAC;QAEF,MAAM,SAAS,GAAuC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC1E,eAAe,CAAC,mBAAmB,EACnC,UAAU,CACb,CAAC;QAEF,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtH,MAAM,IAAI,KAAK,CAAC,UAAU,SAAS,8BAA8B,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAEnD,6CAA6C;QAC7C,MAAM,SAAS,GAAoC;YAC/C,aAAa,EAAE,QAAQ,SAAS,oBAAoB;YACpD,aAAa,EAAE,GAAG;SACrB,CAAC;QAEF,MAAM,QAAQ,GAAyC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC3E,eAAe,CAAC,oBAAoB,EACpC,SAAS,CACZ,CAAC;QAEF,MAAM,WAAW,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAE/G,sBAAsB;QACtB,MAAM,MAAM,GAAkB,WAAW,CAAC,GAAG,CAAC,CAAC,MAA2B,EAAE,EAAE;YAC1E,MAAM,YAAY,GAAG,OAAO,MAAM,CAAC,aAAa,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,KAAK,IAAI;gBAC1F,CAAC,CAAE,MAAM,CAAC,aAAmC,CAAC,KAAK,IAAI,EAAE;gBACzD,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,IAAI,EAAE,CAAW,CAAC;YAE7C,MAAM,cAAc,GAAG,OAAO,MAAM,CAAC,SAAS,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI;gBACpF,CAAC,CAAE,MAAM,CAAC,SAA+B,CAAC,KAAK,IAAI,SAAS;gBAC5D,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAuB,CAAC;YAE5D,OAAO;gBACH,IAAI,EAAE,MAAM,CAAC,OAAO;gBACpB,KAAK,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,OAAO;gBAC5C,YAAY,EAAE,YAAY;gBAC1B,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,IAAI,GAAG,EAAE,EAAE,CAAC;gBACjD,SAAS,EAAE,MAAM,CAAC,SAAS,KAAK,MAAM;gBACtC,QAAQ,EAAE,MAAM,CAAC,SAAS,KAAK,MAAM;gBACrC,cAAc,EAAE,cAAc;gBAC9B,YAAY,EAAE,MAAM,CAAC,aAAa,IAAI,SAAS;aAClD,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,wBAAwB;QACxB,IAAI,UAA8B,CAAC;QACnC,IAAI,WAAW,CAAC,WAAW,EAAE,CAAC;YAC1B,UAAU,GAAG,OAAO,WAAW,CAAC,WAAW,KAAK,QAAQ,IAAI,WAAW,CAAC,WAAW,KAAK,IAAI;gBACxF,CAAC,CAAE,WAAW,CAAC,WAAyD,CAAC,aAAa,IAAK,WAAW,CAAC,WAAiC,CAAC,KAAK;gBAC9I,CAAC,CAAC,WAAW,CAAC,WAAqB,CAAC;QAC5C,CAAC;QAED,MAAM,MAAM,GAAgB;YACxB,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,WAAW,CAAC,KAAK,IAAI,SAAS;YACrC,UAAU;YACV,MAAM;SACT,CAAC;QAEF,mCAAmC;QACnC,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;YAC9B,MAAM,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACpE,CAAC;QAED,mCAAmC;QACnC,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;YAC/B,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAC9D,CAAC;QAED,iCAAiC;QACjC,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;YAC5B,MAAM,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACrE,CAAC;QAED,oCAAoC;QACpC,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;YAC/B,MAAM,CAAC,aAAa,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,SAAS,KAAK,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;QACjF,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,YAAY,CAAC,SAAiB,EAAE,SAAiB;QAC1D,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,SAAS,IAAI,SAAS,EAAE,CAAC,CAAC;QAEjE,8CAA8C;QAC9C,MAAM,SAAS,GAAoC;YAC/C,aAAa,EAAE,QAAQ,SAAS,YAAY,SAAS,EAAE;YACvD,aAAa,EAAE,CAAC;SACnB,CAAC;QAEF,MAAM,QAAQ,GAAyC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC3E,eAAe,CAAC,oBAAoB,EACpC,SAAS,CACZ,CAAC;QAEF,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClH,MAAM,IAAI,KAAK,CAAC,UAAU,SAAS,yBAAyB,SAAS,GAAG,CAAC,CAAC;QAC9E,CAAC;QAED,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAE7C,MAAM,YAAY,GAAG,OAAO,MAAM,CAAC,aAAa,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,KAAK,IAAI;YAC1F,CAAC,CAAE,MAAM,CAAC,aAAmC,CAAC,KAAK,IAAI,EAAE;YACzD,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,IAAI,EAAE,CAAW,CAAC;QAE7C,MAAM,cAAc,GAAG,OAAO,MAAM,CAAC,SAAS,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI;YACpF,CAAC,CAAE,MAAM,CAAC,SAA+B,CAAC,KAAK,IAAI,SAAS;YAC5D,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAuB,CAAC;QAE5D,yCAAyC;QACzC,MAAM,WAAW,GAAoC;YACjD,aAAa,EAAE,QAAQ,SAAS,YAAY,SAAS,EAAE;YACvD,aAAa,EAAE,GAAG;SACrB,CAAC;QAEF,MAAM,UAAU,GAAqC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACzE,eAAe,CAAC,gBAAgB,EAChC,WAAW,CACd,CAAC;QAEF,IAAI,OAA4D,CAAC;QACjE,IAAI,UAAU,CAAC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxG,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAuB,EAAE,EAAE,CAAC,CAAC;gBACrE,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;aACtB,CAAC,CAAC,CAAC;QACR,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,SAAS,IAAI,SAAS,EAAE,CAAC,CAAC;QAEhE,OAAO;YACH,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,MAAM,CAAC,YAAY,IAAI,SAAS;YACvC,IAAI,EAAE,YAAY;YAClB,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,UAAU,IAAI,GAAG,EAAE,EAAE,CAAC;YACjD,SAAS,EAAE,MAAM,CAAC,SAAS,KAAK,MAAM;YACtC,QAAQ,EAAE,MAAM,CAAC,SAAS,KAAK,MAAM;YACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,SAAS;YACtC,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,SAAS;YAC9B,cAAc;YACd,OAAO;SACV,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,4BAA4B,CAAC,gBAAwB;QAC9D,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yCAAyC,gBAAgB,EAAE,CAAC,CAAC;QAE/E,MAAM,MAAM,GAAsB,EAAE,CAAC;QAErC,oCAAoC;QACpC,MAAM,QAAQ,GAAoC;YAC9C,aAAa,EAAE,YAAY,gBAAgB,EAAE;YAC7C,aAAa,EAAE,GAAG;SACrB,CAAC;QAEF,MAAM,OAAO,GAA6C,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC9E,eAAe,CAAC,qBAAqB,EACrC,QAAQ,CACX,CAAC;QAEF,MAAM,SAAS,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,GAAG,IAAI,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAE1G,qBAAqB;QACrB,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;QACxC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC/B,yBAAyB;YACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtD,MAAM,CAAC,IAAI,CAAC;oBACR,QAAQ,EAAE,OAAO;oBACjB,SAAS,EAAE,UAAU;oBACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;oBACvB,KAAK,EAAE,sBAAsB;oBAC7B,GAAG,EAAE,4BAA4B;iBACpC,CAAC,CAAC;YACP,CAAC;iBAAM,CAAC;gBACJ,4BAA4B;gBAC5B,IAAI,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBACnC,MAAM,CAAC,IAAI,CAAC;wBACR,QAAQ,EAAE,OAAO;wBACjB,SAAS,EAAE,UAAU;wBACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;wBACvB,KAAK,EAAE,4BAA4B,QAAQ,CAAC,IAAI,EAAE;wBAClD,GAAG,EAAE,0DAA0D;qBAClE,CAAC,CAAC;gBACP,CAAC;gBACD,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACrC,CAAC;YAED,kCAAkC;YAClC,IAAI,CAAC,QAAQ,CAAC,aAAa,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxE,MAAM,CAAC,IAAI,CAAC;oBACR,QAAQ,EAAE,SAAS;oBACnB,SAAS,EAAE,UAAU;oBACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;oBACvB,KAAK,EAAE,aAAa,QAAQ,CAAC,IAAI,IAAI,SAAS,wBAAwB;oBACtE,GAAG,EAAE,kDAAkD;iBAC1D,CAAC,CAAC;YACP,CAAC;YAED,yCAAyC;YACzC,IAAI,QAAQ,CAAC,SAAS,KAAK,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;gBAC/D,MAAM,CAAC,IAAI,CAAC;oBACR,QAAQ,EAAE,SAAS;oBACnB,SAAS,EAAE,UAAU;oBACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;oBACvB,KAAK,EAAE,uBAAuB,QAAQ,CAAC,IAAI,IAAI,SAAS,eAAe;oBACvE,GAAG,EAAE,2DAA2D;iBACnE,CAAC,CAAC;YACP,CAAC;QACL,CAAC;QAED,oBAAoB;QACpB,MAAM,WAAW,GAAoC;YACjD,aAAa,EAAE,gBAAgB,gBAAgB,EAAE;YACjD,aAAa,EAAE,GAAG;SACrB,CAAC;QAEF,MAAM,UAAU,GAA2C,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC/E,eAAe,CAAC,uBAAuB,EACvC,WAAW,CACd,CAAC;QAEF,MAAM,QAAQ,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAElH,uBAAuB;QACvB,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,iBAAiB,IAAI,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5E,MAAM,CAAC,IAAI,CAAC;oBACR,QAAQ,EAAE,SAAS;oBACnB,SAAS,EAAE,WAAW;oBACtB,MAAM,EAAE,MAAM,CAAC,MAAM;oBACrB,KAAK,EAAE,oCAAoC;oBAC3C,GAAG,EAAE,sDAAsD;iBAC9D,CAAC,CAAC;YACP,CAAC;QACL,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,MAAM,CAAC;QACrE,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;QAEzE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,UAAU,YAAY,YAAY,WAAW,CAAC,CAAC;QAEzF,OAAO;YACH,KAAK,EAAE,UAAU,KAAK,CAAC;YACvB,MAAM;YACN,QAAQ,EAAE,YAAY;YACtB,MAAM,EAAE,UAAU;SACrB,CAAC;IACN,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,mBAAmB,CAAC,SAAiB;QAC/C,MAAM,WAAW,GAAoC;YACjD,aAAa,EAAE,QAAQ,SAAS,EAAE;YAClC,aAAa,EAAE,IAAI;SACtB,CAAC;QAEF,MAAM,UAAU,GAAqC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACzE,eAAe,CAAC,gBAAgB,EAChC,WAAW,CACd,CAAC;QAEF,IAAI,UAAU,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAC9D,OAAO,EAAE,CAAC;QACd,CAAC;QAED,yBAAyB;QACzB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAmD,CAAC;QAChF,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YAChD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACzC,CAAC;YACD,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAE,CAAC,IAAI,CAAC;gBACnC,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;aACtB,CAAC,CAAC;QACP,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YACjE,KAAK;YACL,OAAO;SACV,CAAC,CAAC,CAAC;IACR,CAAC;IAED;;;OAGG;IACK,qBAAqB,CAAC,MAAqB;QAC/C,OAAO,MAAM;aACR,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;aAC7B,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,IAAI,EAAE,WAAW;YACjB,YAAY,EAAE,CAAC,CAAC,cAAe;SAClC,CAAC,CAAC,CAAC;IACZ,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,sBAAsB,CAAC,SAAiB;QAClD,MAAM,KAAK,GAAoC;YAC3C,aAAa,EAAE,SAAS,SAAS,EAAE;YACnC,aAAa,EAAE,GAAG;SACrB,CAAC;QAEF,MAAM,IAAI,GACN,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACpB,eAAe,EACf,KAAK,CACR,CAAC;QAEN,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAClD,OAAO,EAAE,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACzC,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,iBAAiB,EAAE,MAAM,CAAC,iBAAiB,IAAI,EAAE;YACjD,MAAM,EAAE,MAAM,CAAC,MAAM,KAAK,MAAM;SACnC,CAAC,CAAC,CAAC;IACR,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,yBAAyB,CAAC,SAAiB;QACrD,MAAM,KAAK,GAAoC;YAC3C,aAAa,EAAE,cAAc,SAAS,EAAE;YACxC,aAAa,EAAE,GAAG;SACrB,CAAC;QAEF,MAAM,IAAI,GACN,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACpB,YAAY,EACZ,KAAK,CACR,CAAC;QAEN,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAClD,OAAO,EAAE,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACvC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM,KAAK,MAAM;SACjC,CAAC,CAAC,CAAC;IACR,CAAC"}

package/dist/sn/schema/SchemaModels.d.ts

@@ -0,0 +1,277 @@
+/**
+ * Options for discovering a table schema.
+ */
+export interface TableSchemaOptions {
+    /** Include internal type codes from sys_dictionary */
+    includeTypeCodes?: boolean;
+    /** Include choice tables (sys_choice) for fields with choices */
+    includeChoiceTables?: boolean;
+    /** Include relationship information */
+    includeRelationships?: boolean;
+    /** Include UI policies */
+    includeUIPolicies?: boolean;
+    /** Include business rules */
+    includeBusinessRules?: boolean;
+}
+/**
+ * Schema information for a single field.
+ */
+export interface FieldSchema {
+    /** Internal field name */
+    name: string;
+    /** Display label */
+    label: string;
+    /** Internal type (e.g., "string", "integer", "reference") */
+    internalType: string;
+    /** Maximum length for the field */
+    maxLength: number;
+    /** Whether the field is mandatory */
+    mandatory: boolean;
+    /** Whether the field is read-only */
+    readOnly: boolean;
+    /** Reference table name (for reference fields) */
+    referenceTable?: string;
+    /** Default value for the field */
+    defaultValue?: string;
+}
+/**
+ * Schema for a ServiceNow table.
+ */
+export interface TableSchema {
+    /** Table name */
+    table: string;
+    /** Display label of the table */
+    label: string;
+    /** Super class (parent table) if any */
+    superClass?: string;
+    /** Array of field schemas */
+    fields: FieldSchema[];
+    /** Choice tables data (if includeChoiceTables was true) */
+    choiceTables?: Array<{
+        field: string;
+        choices: Array<{
+            label: string;
+            value: string;
+        }>;
+    }>;
+    /** Relationship data (if includeRelationships was true) */
+    relationships?: Array<{
+        name: string;
+        type: string;
+        relatedTable: string;
+    }>;
+    /** UI policies (if includeUIPolicies was true) */
+    uiPolicies?: Array<{
+        sys_id: string;
+        short_description: string;
+        active: boolean;
+    }>;
+    /** Business rules (if includeBusinessRules was true) */
+    businessRules?: Array<{
+        sys_id: string;
+        name: string;
+        when: string;
+        active: boolean;
+    }>;
+}
+/**
+ * Detailed explanation of a field.
+ */
+export interface FieldExplanation {
+    /** Internal field name */
+    field: string;
+    /** Table the field belongs to */
+    table: string;
+    /** Display label */
+    label: string;
+    /** Internal type */
+    type: string;
+    /** Maximum length */
+    maxLength: number;
+    /** Whether the field is mandatory */
+    mandatory: boolean;
+    /** Whether the field is read-only */
+    readOnly: boolean;
+    /** Comments/description of the field */
+    comments?: string;
+    /** Help text for the field */
+    help?: string;
+    /** Reference table (for reference fields) */
+    referenceTable?: string;
+    /** Available choices (for choice fields) */
+    choices?: Array<{
+        label: string;
+        value: string;
+    }>;
+}
+/**
+ * A single validation issue found during catalog configuration validation.
+ */
+export interface ValidationIssue {
+    /** Severity of the issue */
+    severity: 'error' | 'warning';
+    /** Component type where the issue was found */
+    component: string;
+    /** sys_id of the component (if applicable) */
+    sys_id?: string;
+    /** Description of the issue */
+    issue: string;
+    /** Suggested fix */
+    fix?: string;
+}
+/**
+ * Result of validating a catalog configuration.
+ */
+export interface CatalogValidationResult {
+    /** Whether the configuration is valid (no errors) */
+    valid: boolean;
+    /** Array of validation issues */
+    issues: ValidationIssue[];
+    /** Count of warnings */
+    warnings: number;
+    /** Count of errors */
+    errors: number;
+}
+/**
+ * Record from the sys_db_object table.
+ */
+export interface SysDbObjectRecord {
+    /** System ID */
+    sys_id: string;
+    /** Table name */
+    name: string;
+    /** Display label */
+    label?: string;
+    /** Super class (parent table) reference */
+    super_class?: string | {
+        link: string;
+        value: string;
+        display_value?: string;
+    };
+    /** Additional fields */
+    [key: string]: unknown;
+}
+/**
+ * Response wrapper for sys_db_object query.
+ */
+export interface SysDbObjectResponse {
+    result: SysDbObjectRecord[];
+}
+/**
+ * Record from the sys_dictionary table.
+ */
+export interface SysDictionaryRecord {
+    /** System ID */
+    sys_id: string;
+    /** Table name */
+    name: string;
+    /** Field element name */
+    element: string;
+    /** Display label (column_label) */
+    column_label?: string;
+    /** Internal type */
+    internal_type?: string | {
+        link: string;
+        value: string;
+        display_value?: string;
+    };
+    /** Maximum length */
+    max_length?: string;
+    /** Whether the field is mandatory */
+    mandatory?: string;
+    /** Whether the field is read-only */
+    read_only?: string;
+    /** Reference table */
+    reference?: string | {
+        link: string;
+        value: string;
+        display_value?: string;
+    };
+    /** Default value */
+    default_value?: string;
+    /** Comments */
+    comments?: string;
+    /** Help text */
+    help?: string;
+    /** Additional fields */
+    [key: string]: unknown;
+}
+/**
+ * Response wrapper for sys_dictionary query.
+ */
+export interface SysDictionaryResponse {
+    result: SysDictionaryRecord[];
+}
+/**
+ * Record from the sys_choice table.
+ */
+export interface SysChoiceRecord {
+    /** System ID */
+    sys_id: string;
+    /** Table name */
+    name: string;
+    /** Field element name */
+    element: string;
+    /** Choice label */
+    label: string;
+    /** Choice value */
+    value: string;
+    /** Additional fields */
+    [key: string]: unknown;
+}
+/**
+ * Response wrapper for sys_choice query.
+ */
+export interface SysChoiceResponse {
+    result: SysChoiceRecord[];
+}
+/**
+ * Record from the catalog item options (item_option_new) table.
+ */
+export interface CatalogItemOptionRecord {
+    /** System ID */
+    sys_id: string;
+    /** Variable name */
+    name?: string;
+    /** Question text */
+    question_text?: string;
+    /** Variable type */
+    type?: string;
+    /** Whether the variable is mandatory */
+    mandatory?: string;
+    /** Catalog item reference */
+    cat_item?: string;
+    /** Order */
+    order?: string;
+    /** Active flag */
+    active?: string;
+    /** Additional fields */
+    [key: string]: unknown;
+}
+/**
+ * Response wrapper for catalog item option query.
+ */
+export interface CatalogItemOptionResponse {
+    result: CatalogItemOptionRecord[];
+}
+/**
+ * Record from the catalog_ui_policy table.
+ */
+export interface CatalogUIPolicyRecord {
+    /** System ID */
+    sys_id: string;
+    /** Short description */
+    short_description?: string;
+    /** Catalog item reference */
+    catalog_item?: string;
+    /** Active flag */
+    active?: string;
+    /** Additional fields */
+    [key: string]: unknown;
+}
+/**
+ * Response wrapper for catalog UI policy query.
+ */
+export interface CatalogUIPolicyResponse {
+    result: CatalogUIPolicyRecord[];
+}

package/dist/sn/schema/SchemaModels.js

@@ -0,0 +1,5 @@
+// ============================================================
+// Options Types
+// ============================================================
+export {};
+//# sourceMappingURL=SchemaModels.js.map

package/dist/sn/schema/SchemaModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaModels.js","sourceRoot":"","sources":["../../../src/sn/schema/SchemaModels.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,gBAAgB;AAChB,+DAA+D"}