@sonisoft/now-sdk-ext-core 3.0.1 → 3.3.0

package/dist/sn/knowledge/KnowledgeManager.js

@@ -0,0 +1,316 @@
+import { Logger } from "../../util/Logger.js";
+import { ServiceNowRequest } from "../../comm/http/ServiceNowRequest.js";
+import { TableAPIRequest } from "../../comm/http/TableAPIRequest.js";
+import { AggregateQuery } from "../aggregate/AggregateQuery.js";
+/**
+ * Provides operations for managing ServiceNow Knowledge Base articles,
+ * knowledge bases, and categories via the Table API and Stats API.
+ */
+export class KnowledgeManager {
+    static KB_BASE_TABLE = 'kb_knowledge_base';
+    static KB_CATEGORY_TABLE = 'kb_category';
+    static KB_KNOWLEDGE_TABLE = 'kb_knowledge';
+    /** Fields to return in list operations (excludes large body fields) */
+    static ARTICLE_LIST_FIELDS = 'sys_id,number,short_description,kb_knowledge_base,kb_category,workflow_state,' +
+        'author,article_type,published,active,sys_view_count,sys_created_on,sys_updated_on';
+    _logger = new Logger("KnowledgeManager");
+    _req;
+    _tableAPI;
+    _aggregateQuery;
+    _instance;
+    constructor(instance) {
+        this._instance = instance;
+        this._req = new ServiceNowRequest(instance);
+        this._tableAPI = new TableAPIRequest(instance);
+        this._aggregateQuery = new AggregateQuery(instance);
+    }
+    /**
+     * List knowledge bases with optional filtering and pagination.
+     *
+     * @param options Filtering and pagination options
+     * @returns Array of knowledge base records
+     * @throws Error if the API call fails
+     */
+    async listKnowledgeBases(options = {}) {
+        const { query, active, limit = 20, offset = 0 } = options;
+        this._logger.info('Listing knowledge bases');
+        const queryParts = [];
+        if (active !== undefined)
+            queryParts.push(`active=${active}`);
+        if (query)
+            queryParts.push(query);
+        const params = {
+            sysparm_limit: limit,
+            sysparm_offset: offset
+        };
+        if (queryParts.length > 0) {
+            params.sysparm_query = queryParts.join('^');
+        }
+        const response = await this._tableAPI.get(KnowledgeManager.KB_BASE_TABLE, params);
+        if (response && response.status === 200 && response.bodyObject?.result) {
+            this._logger.info(`Retrieved ${response.bodyObject.result.length} knowledge bases`);
+            return response.bodyObject.result;
+        }
+        throw new Error(`Failed to list knowledge bases. Status: ${response?.status ?? 'unknown'}`);
+    }
+    /**
+     * Get details of a specific knowledge base including article and category counts.
+     *
+     * @param sysId The sys_id of the knowledge base
+     * @returns Knowledge base detail with article and category counts
+     * @throws Error if the sys_id is empty, the KB is not found, or the API call fails
+     */
+    async getKnowledgeBase(sysId) {
+        if (!sysId || sysId.trim().length === 0) {
+            throw new Error('Knowledge base sys_id is required');
+        }
+        this._logger.info(`Getting knowledge base: ${sysId}`);
+        const query = {
+            sysparm_query: `sys_id=${sysId}`,
+            sysparm_limit: 1
+        };
+        const response = await this._tableAPI.get(KnowledgeManager.KB_BASE_TABLE, query);
+        if (!response || response.status !== 200 || !response.bodyObject?.result ||
+            response.bodyObject.result.length === 0) {
+            throw new Error(`Knowledge base '${sysId}' not found. Status: ${response?.status ?? 'unknown'}`);
+        }
+        const knowledgeBase = response.bodyObject.result[0];
+        // Get article and category counts in parallel
+        const [articleCount, categoryCount] = await Promise.all([
+            this._aggregateQuery.count({
+                table: KnowledgeManager.KB_KNOWLEDGE_TABLE,
+                query: `kb_knowledge_base=${sysId}`
+            }),
+            this._aggregateQuery.count({
+                table: KnowledgeManager.KB_CATEGORY_TABLE,
+                query: `value=${sysId}`
+            })
+        ]);
+        this._logger.info(`Knowledge base '${knowledgeBase.title}': ${articleCount} articles, ${categoryCount} categories`);
+        return { knowledgeBase, articleCount, categoryCount };
+    }
+    /**
+     * List categories within a knowledge base with optional filtering.
+     *
+     * @param options Filtering and pagination options
+     * @returns Array of category records
+     * @throws Error if the API call fails
+     */
+    async listCategories(options = {}) {
+        const { knowledgeBaseSysId, parentCategory, query, active, limit = 20, offset = 0 } = options;
+        this._logger.info('Listing categories');
+        const queryParts = [];
+        if (knowledgeBaseSysId)
+            queryParts.push(`value=${knowledgeBaseSysId}`);
+        if (parentCategory)
+            queryParts.push(`parent_id=${parentCategory}`);
+        if (active !== undefined)
+            queryParts.push(`active=${active}`);
+        if (query)
+            queryParts.push(query);
+        const params = {
+            sysparm_limit: limit,
+            sysparm_offset: offset
+        };
+        if (queryParts.length > 0) {
+            params.sysparm_query = queryParts.join('^');
+        }
+        const response = await this._tableAPI.get(KnowledgeManager.KB_CATEGORY_TABLE, params);
+        if (response && response.status === 200 && response.bodyObject?.result) {
+            this._logger.info(`Retrieved ${response.bodyObject.result.length} categories`);
+            return response.bodyObject.result;
+        }
+        throw new Error(`Failed to list categories. Status: ${response?.status ?? 'unknown'}`);
+    }
+    /**
+     * Create a new knowledge base category.
+     *
+     * @param options Category creation options
+     * @returns The created category record
+     * @throws Error if required fields are missing or the API call fails
+     */
+    async createCategory(options) {
+        if (!options.label || options.label.trim().length === 0) {
+            throw new Error('Category label is required');
+        }
+        if (!options.knowledgeBaseSysId || options.knowledgeBaseSysId.trim().length === 0) {
+            throw new Error('Knowledge base sys_id is required');
+        }
+        this._logger.info(`Creating category: ${options.label}`);
+        const body = {
+            label: options.label,
+            value: options.knowledgeBaseSysId
+        };
+        if (options.parentCategory) {
+            body.parent_id = options.parentCategory;
+        }
+        if (options.active !== undefined) {
+            body.active = String(options.active);
+        }
+        const response = await this._tableAPI.post(KnowledgeManager.KB_CATEGORY_TABLE, {}, body);
+        if (response && (response.status === 200 || response.status === 201) && response.bodyObject?.result) {
+            this._logger.info(`Created category: ${options.label} (${response.bodyObject.result.sys_id})`);
+            return response.bodyObject.result;
+        }
+        throw new Error(`Failed to create category '${options.label}'. Status: ${response?.status ?? 'unknown'}`);
+    }
+    /**
+     * List knowledge articles with filtering by KB, category, workflow state, and text search.
+     * Returns article summaries (without large body fields) for efficiency.
+     *
+     * @param options Filtering and pagination options
+     * @returns Array of article summaries
+     * @throws Error if the API call fails
+     */
+    async listArticles(options = {}) {
+        const { knowledgeBaseSysId, categorySysId, workflowState, textSearch, query, limit = 20, offset = 0 } = options;
+        this._logger.info('Listing articles');
+        const queryParts = [];
+        if (knowledgeBaseSysId)
+            queryParts.push(`kb_knowledge_base=${knowledgeBaseSysId}`);
+        if (categorySysId)
+            queryParts.push(`kb_category=${categorySysId}`);
+        if (workflowState)
+            queryParts.push(`workflow_state=${workflowState}`);
+        if (textSearch)
+            queryParts.push(`short_descriptionLIKE${textSearch}`);
+        if (query)
+            queryParts.push(query);
+        const params = {
+            sysparm_limit: limit,
+            sysparm_offset: offset,
+            sysparm_fields: KnowledgeManager.ARTICLE_LIST_FIELDS
+        };
+        if (queryParts.length > 0) {
+            params.sysparm_query = queryParts.join('^');
+        }
+        const response = await this._tableAPI.get(KnowledgeManager.KB_KNOWLEDGE_TABLE, params);
+        if (response && response.status === 200 && response.bodyObject?.result) {
+            this._logger.info(`Retrieved ${response.bodyObject.result.length} articles`);
+            return response.bodyObject.result;
+        }
+        throw new Error(`Failed to list articles. Status: ${response?.status ?? 'unknown'}`);
+    }
+    /**
+     * Get full article content including body text.
+     *
+     * @param sysId The sys_id of the article
+     * @returns The full article record
+     * @throws Error if the sys_id is empty, the article is not found, or the API call fails
+     */
+    async getArticle(sysId) {
+        if (!sysId || sysId.trim().length === 0) {
+            throw new Error('Article sys_id is required');
+        }
+        this._logger.info(`Getting article: ${sysId}`);
+        const query = {
+            sysparm_query: `sys_id=${sysId}`,
+            sysparm_limit: 1
+        };
+        const response = await this._tableAPI.get(KnowledgeManager.KB_KNOWLEDGE_TABLE, query);
+        if (response && response.status === 200 && response.bodyObject?.result) {
+            if (response.bodyObject.result.length > 0) {
+                this._logger.info(`Found article: ${response.bodyObject.result[0].short_description}`);
+                return response.bodyObject.result[0];
+            }
+            throw new Error(`Article '${sysId}' not found`);
+        }
+        throw new Error(`Failed to get article '${sysId}'. Status: ${response?.status ?? 'unknown'}`);
+    }
+    /**
+     * Create a new knowledge article.
+     *
+     * @param options Article creation options
+     * @returns The created article record
+     * @throws Error if required fields are missing or the API call fails
+     */
+    async createArticle(options) {
+        if (!options.shortDescription || options.shortDescription.trim().length === 0) {
+            throw new Error('Article short description is required');
+        }
+        if (!options.knowledgeBaseSysId || options.knowledgeBaseSysId.trim().length === 0) {
+            throw new Error('Knowledge base sys_id is required');
+        }
+        this._logger.info(`Creating article: ${options.shortDescription}`);
+        const body = {
+            short_description: options.shortDescription,
+            kb_knowledge_base: options.knowledgeBaseSysId,
+            workflow_state: options.workflowState || 'draft'
+        };
+        if (options.text)
+            body.text = options.text;
+        if (options.wiki)
+            body.wiki = options.wiki;
+        if (options.categorySysId)
+            body.kb_category = options.categorySysId;
+        if (options.articleType)
+            body.article_type = options.articleType;
+        if (options.additionalFields) {
+            Object.assign(body, options.additionalFields);
+        }
+        const response = await this._tableAPI.post(KnowledgeManager.KB_KNOWLEDGE_TABLE, {}, body);
+        if (response && (response.status === 200 || response.status === 201) && response.bodyObject?.result) {
+            this._logger.info(`Created article: ${options.shortDescription} (${response.bodyObject.result.sys_id})`);
+            return response.bodyObject.result;
+        }
+        throw new Error(`Failed to create article. Status: ${response?.status ?? 'unknown'}`);
+    }
+    /**
+     * Update an existing knowledge article.
+     *
+     * @param sysId The sys_id of the article to update
+     * @param options Fields to update
+     * @returns The updated article record
+     * @throws Error if the sys_id is empty, no fields are provided, or the API call fails
+     */
+    async updateArticle(sysId, options) {
+        if (!sysId || sysId.trim().length === 0) {
+            throw new Error('Article sys_id is required');
+        }
+        this._logger.info(`Updating article: ${sysId}`);
+        const body = {};
+        if (options.shortDescription !== undefined)
+            body.short_description = options.shortDescription;
+        if (options.text !== undefined)
+            body.text = options.text;
+        if (options.wiki !== undefined)
+            body.wiki = options.wiki;
+        if (options.knowledgeBaseSysId !== undefined)
+            body.kb_knowledge_base = options.knowledgeBaseSysId;
+        if (options.categorySysId !== undefined)
+            body.kb_category = options.categorySysId;
+        if (options.workflowState !== undefined)
+            body.workflow_state = options.workflowState;
+        if (options.articleType !== undefined)
+            body.article_type = options.articleType;
+        if (options.active !== undefined)
+            body.active = String(options.active);
+        if (options.additionalFields) {
+            Object.assign(body, options.additionalFields);
+        }
+        if (Object.keys(body).length === 0) {
+            throw new Error('At least one field must be provided for update');
+        }
+        const response = await this._tableAPI.put(KnowledgeManager.KB_KNOWLEDGE_TABLE, sysId, body);
+        if (response && response.status === 200 && response.bodyObject?.result) {
+            this._logger.info(`Updated article: ${sysId}`);
+            return response.bodyObject.result;
+        }
+        throw new Error(`Failed to update article '${sysId}'. Status: ${response?.status ?? 'unknown'}`);
+    }
+    /**
+     * Publish a draft article by setting its workflow_state to "published".
+     *
+     * @param sysId The sys_id of the article to publish
+     * @returns The updated article record
+     * @throws Error if the sys_id is empty or the API call fails
+     */
+    async publishArticle(sysId) {
+        if (!sysId || sysId.trim().length === 0) {
+            throw new Error('Article sys_id is required');
+        }
+        this._logger.info(`Publishing article: ${sysId}`);
+        return this.updateArticle(sysId, { workflowState: 'published' });
+    }
+}
+//# sourceMappingURL=KnowledgeManager.js.map

package/dist/sn/knowledge/KnowledgeManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnowledgeManager.js","sourceRoot":"","sources":["../../../src/sn/knowledge/KnowledgeManager.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;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAsB7D;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IACjB,MAAM,CAAU,aAAa,GAAG,mBAAmB,CAAC;IACpD,MAAM,CAAU,iBAAiB,GAAG,aAAa,CAAC;IAClD,MAAM,CAAU,kBAAkB,GAAG,cAAc,CAAC;IAE5D,uEAAuE;IAC/D,MAAM,CAAU,mBAAmB,GACvC,+EAA+E;QAC/E,mFAAmF,CAAC;IAEhF,OAAO,GAAW,IAAI,MAAM,CAAC,kBAAkB,CAAC,CAAC;IACjD,IAAI,CAAoB;IACxB,SAAS,CAAkB;IAC3B,eAAe,CAAiB;IAChC,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;QAC/C,IAAI,CAAC,eAAe,GAAG,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,kBAAkB,CAAC,UAAqC,EAAE;QACnE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC;QAC1D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAE7C,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,IAAI,MAAM,KAAK,SAAS;YAAE,UAAU,CAAC,IAAI,CAAC,UAAU,MAAM,EAAE,CAAC,CAAC;QAC9D,IAAI,KAAK;YAAE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAElC,MAAM,MAAM,GAAoC;YAC5C,aAAa,EAAE,KAAK;YACpB,cAAc,EAAE,MAAM;SACzB,CAAC;QACF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,QAAQ,GAAyC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC3E,gBAAgB,CAAC,aAAa,EAAE,MAAM,CACzC,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,kBAAkB,CAAC,CAAC;YACpF,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,2CAA2C,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,gBAAgB,CAAC,KAAa;QACvC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,KAAK,EAAE,CAAC,CAAC;QAEtD,MAAM,KAAK,GAAoC;YAC3C,aAAa,EAAE,UAAU,KAAK,EAAE;YAChC,aAAa,EAAE,CAAC;SACnB,CAAC;QAEF,MAAM,QAAQ,GAAyC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC3E,gBAAgB,CAAC,aAAa,EAAE,KAAK,CACxC,CAAC;QAEF,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM;YACpE,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,wBAAwB,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;QACrG,CAAC;QAED,MAAM,aAAa,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAEpD,8CAA8C;QAC9C,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpD,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;gBACvB,KAAK,EAAE,gBAAgB,CAAC,kBAAkB;gBAC1C,KAAK,EAAE,qBAAqB,KAAK,EAAE;aACtC,CAAC;YACF,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;gBACvB,KAAK,EAAE,gBAAgB,CAAC,iBAAiB;gBACzC,KAAK,EAAE,SAAS,KAAK,EAAE;aAC1B,CAAC;SACL,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,aAAa,CAAC,KAAK,MAAM,YAAY,cAAc,aAAa,aAAa,CAAC,CAAC;QAEpH,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAAC,UAAiC,EAAE;QAC3D,MAAM,EAAE,kBAAkB,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC;QAC9F,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAExC,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,IAAI,kBAAkB;YAAE,UAAU,CAAC,IAAI,CAAC,SAAS,kBAAkB,EAAE,CAAC,CAAC;QACvE,IAAI,cAAc;YAAE,UAAU,CAAC,IAAI,CAAC,aAAa,cAAc,EAAE,CAAC,CAAC;QACnE,IAAI,MAAM,KAAK,SAAS;YAAE,UAAU,CAAC,IAAI,CAAC,UAAU,MAAM,EAAE,CAAC,CAAC;QAC9D,IAAI,KAAK;YAAE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAElC,MAAM,MAAM,GAAoC;YAC5C,aAAa,EAAE,KAAK;YACpB,cAAc,EAAE,MAAM;SACzB,CAAC;QACF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,QAAQ,GAA6C,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC/E,gBAAgB,CAAC,iBAAiB,EAAE,MAAM,CAC7C,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,aAAa,CAAC,CAAC;YAC/E,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,sCAAsC,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAAC,OAA8B;QACtD,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAClD,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,kBAAkB,IAAI,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChF,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAEzD,MAAM,IAAI,GAA2B;YACjC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,KAAK,EAAE,OAAO,CAAC,kBAAkB;SACpC,CAAC;QACF,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YACzB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,QAAQ,GAAmD,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACtF,gBAAgB,CAAC,iBAAiB,EAAE,EAAE,EAAE,IAAI,CAC/C,CAAC;QAEF,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAClG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YAC/F,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,8BAA8B,OAAO,CAAC,KAAK,cAAc,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IAC9G,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,YAAY,CAAC,UAA+B,EAAE;QACvD,MAAM,EAAE,kBAAkB,EAAE,aAAa,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,GAAG,EAAE,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC;QAChH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAEtC,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,IAAI,kBAAkB;YAAE,UAAU,CAAC,IAAI,CAAC,qBAAqB,kBAAkB,EAAE,CAAC,CAAC;QACnF,IAAI,aAAa;YAAE,UAAU,CAAC,IAAI,CAAC,eAAe,aAAa,EAAE,CAAC,CAAC;QACnE,IAAI,aAAa;YAAE,UAAU,CAAC,IAAI,CAAC,kBAAkB,aAAa,EAAE,CAAC,CAAC;QACtE,IAAI,UAAU;YAAE,UAAU,CAAC,IAAI,CAAC,wBAAwB,UAAU,EAAE,CAAC,CAAC;QACtE,IAAI,KAAK;YAAE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAElC,MAAM,MAAM,GAAoC;YAC5C,aAAa,EAAE,KAAK;YACpB,cAAc,EAAE,MAAM;YACtB,cAAc,EAAE,gBAAgB,CAAC,mBAAmB;SACvD,CAAC;QACF,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,QAAQ,GAAmD,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACrF,gBAAgB,CAAC,kBAAkB,EAAE,MAAM,CAC9C,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,WAAW,CAAC,CAAC;YAC7E,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,oCAAoC,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,KAAa;QACjC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,KAAK,EAAE,CAAC,CAAC;QAE/C,MAAM,KAAK,GAAoC;YAC3C,aAAa,EAAE,UAAU,KAAK,EAAE;YAChC,aAAa,EAAE,CAAC;SACnB,CAAC;QAEF,MAAM,QAAQ,GAA4C,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAC9E,gBAAgB,CAAC,kBAAkB,EAAE,KAAK,CAC7C,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACrE,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC,CAAC;gBACvF,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,YAAY,KAAK,aAAa,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,cAAc,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,aAAa,CAAC,OAA6B;QACpD,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5E,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,kBAAkB,IAAI,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChF,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAEnE,MAAM,IAAI,GAA2B;YACjC,iBAAiB,EAAE,OAAO,CAAC,gBAAgB;YAC3C,iBAAiB,EAAE,OAAO,CAAC,kBAAkB;YAC7C,cAAc,EAAE,OAAO,CAAC,aAAa,IAAI,OAAO;SACnD,CAAC;QACF,IAAI,OAAO,CAAC,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC3C,IAAI,OAAO,CAAC,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC3C,IAAI,OAAO,CAAC,aAAa;YAAE,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;QACpE,IAAI,OAAO,CAAC,WAAW;YAAE,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;QACjE,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC3B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAClD,CAAC;QAED,MAAM,QAAQ,GAAkD,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACrF,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,EAAE,IAAI,CAChD,CAAC;QAEF,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YAClG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,OAAO,CAAC,gBAAgB,KAAK,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YACzG,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,qCAAqC,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,OAA6B;QACnE,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,KAAK,EAAE,CAAC,CAAC;QAEhD,MAAM,IAAI,GAA2B,EAAE,CAAC;QACxC,IAAI,OAAO,CAAC,gBAAgB,KAAK,SAAS;YAAE,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QAC9F,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzD,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS;YAAE,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;QAClG,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS;YAAE,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;QAClF,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS;YAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;QACrF,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;YAAE,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;QAC/E,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;YAAE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvE,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC3B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACtE,CAAC;QAED,MAAM,QAAQ,GAAkD,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CACpF,gBAAgB,CAAC,kBAAkB,EAAE,KAAK,EAAE,IAAI,CACnD,CAAC;QAEF,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,KAAK,EAAE,CAAC,CAAC;YAC/C,OAAO,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QACtC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,6BAA6B,KAAK,cAAc,QAAQ,EAAE,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAAC,KAAa;QACrC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,KAAK,EAAE,CAAC,CAAC;QAElD,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CAAC;IACrE,CAAC"}

package/dist/sn/knowledge/KnowledgeModels.d.ts

@@ -0,0 +1,234 @@
+/**
+ * Models for Knowledge Base management operations against ServiceNow tables:
+ * kb_knowledge_base, kb_category, and kb_knowledge.
+ */
+/**
+ * A knowledge base record from the kb_knowledge_base table.
+ */
+export interface KnowledgeBaseRecord {
+    sys_id: string;
+    title: string;
+    description?: string;
+    owner?: string;
+    active?: string;
+    kb_version?: string;
+    application?: string;
+    kb_managers?: string;
+    sys_created_on?: string;
+    sys_updated_on?: string;
+    sys_created_by?: string;
+    sys_updated_by?: string;
+    [key: string]: unknown;
+}
+/**
+ * A knowledge category record from the kb_category table.
+ * Note: kb_category uses "label" (not "title") and "value" for the KB reference.
+ */
+export interface KnowledgeCategoryRecord {
+    sys_id: string;
+    /** Category display name */
+    label: string;
+    /** Knowledge base sys_id reference */
+    value: string;
+    /** Parent category sys_id */
+    parent_id?: string;
+    /** Full category path */
+    full_category?: string;
+    active?: string;
+    sys_created_on?: string;
+    sys_updated_on?: string;
+    sys_created_by?: string;
+    sys_updated_by?: string;
+    [key: string]: unknown;
+}
+/**
+ * A full knowledge article record from the kb_knowledge table,
+ * including body content fields (text, wiki).
+ */
+export interface KnowledgeArticleRecord {
+    sys_id: string;
+    number?: string;
+    short_description: string;
+    /** Article body in HTML */
+    text?: string;
+    /** Article body in wiki markup */
+    wiki?: string;
+    description?: string;
+    /** Reference to kb_knowledge_base */
+    kb_knowledge_base: string;
+    /** Reference to kb_category */
+    kb_category?: string;
+    category?: string;
+    workflow_state?: string;
+    author?: string;
+    article_type?: string;
+    published?: string;
+    active?: string;
+    valid_to?: string;
+    version?: string;
+    display_number?: string;
+    meta_description?: string;
+    keywords?: string;
+    sys_view_count?: string;
+    use_count?: string;
+    rating?: string;
+    sys_created_on?: string;
+    sys_updated_on?: string;
+    sys_created_by?: string;
+    sys_updated_by?: string;
+    [key: string]: unknown;
+}
+/**
+ * A lightweight article summary for list operations (excludes large body fields).
+ */
+export interface KnowledgeArticleSummary {
+    sys_id: string;
+    number?: string;
+    short_description: string;
+    kb_knowledge_base: string;
+    kb_category?: string;
+    workflow_state?: string;
+    author?: string;
+    article_type?: string;
+    published?: string;
+    active?: string;
+    sys_view_count?: string;
+    sys_created_on?: string;
+    sys_updated_on?: string;
+    [key: string]: unknown;
+}
+/**
+ * Options for listing knowledge bases.
+ */
+export interface ListKnowledgeBasesOptions {
+    /** Encoded query string for filtering */
+    query?: string;
+    /** Filter by active status */
+    active?: boolean;
+    /** Maximum number of records to return (default 20) */
+    limit?: number;
+    /** Offset for pagination (default 0) */
+    offset?: number;
+}
+/**
+ * Options for listing knowledge categories.
+ */
+export interface ListCategoriesOptions {
+    /** Filter by knowledge base sys_id (kb_category.value field) */
+    knowledgeBaseSysId?: string;
+    /** Filter by parent category sys_id */
+    parentCategory?: string;
+    /** Encoded query string for additional filtering */
+    query?: string;
+    /** Filter by active status */
+    active?: boolean;
+    /** Maximum number of records (default 20) */
+    limit?: number;
+    /** Offset for pagination (default 0) */
+    offset?: number;
+}
+/**
+ * Options for creating a knowledge category.
+ */
+export interface CreateCategoryOptions {
+    /** Category label (display name) */
+    label: string;
+    /** Knowledge base sys_id (stored in kb_category.value) */
+    knowledgeBaseSysId: string;
+    /** Parent category sys_id (stored in kb_category.parent_id) */
+    parentCategory?: string;
+    /** Whether the category is active (default true) */
+    active?: boolean;
+}
+/**
+ * Options for listing knowledge articles.
+ */
+export interface ListArticlesOptions {
+    /** Filter by knowledge base sys_id */
+    knowledgeBaseSysId?: string;
+    /** Filter by category sys_id */
+    categorySysId?: string;
+    /** Filter by workflow state (e.g. "published", "draft", "retired") */
+    workflowState?: string;
+    /** Text search term (searches short_description) */
+    textSearch?: string;
+    /** Encoded query string for additional filtering */
+    query?: string;
+    /** Maximum number of records (default 20) */
+    limit?: number;
+    /** Offset for pagination (default 0) */
+    offset?: number;
+}
+/**
+ * Options for creating a knowledge article.
+ */
+export interface CreateArticleOptions {
+    /** Article short description / title */
+    shortDescription: string;
+    /** Article body in HTML */
+    text?: string;
+    /** Article body in wiki markup */
+    wiki?: string;
+    /** Knowledge base sys_id */
+    knowledgeBaseSysId: string;
+    /** Category sys_id */
+    categorySysId?: string;
+    /** Workflow state (default "draft") */
+    workflowState?: string;
+    /** Article type */
+    articleType?: string;
+    /** Additional fields to set on the record */
+    additionalFields?: Record<string, string>;
+}
+/**
+ * Options for updating a knowledge article.
+ */
+export interface UpdateArticleOptions {
+    /** Updated short description */
+    shortDescription?: string;
+    /** Updated article body in HTML */
+    text?: string;
+    /** Updated article body in wiki markup */
+    wiki?: string;
+    /** Updated knowledge base sys_id */
+    knowledgeBaseSysId?: string;
+    /** Updated category sys_id */
+    categorySysId?: string;
+    /** Updated workflow state */
+    workflowState?: string;
+    /** Updated article type */
+    articleType?: string;
+    /** Updated active status */
+    active?: boolean;
+    /** Additional fields to update */
+    additionalFields?: Record<string, string>;
+}
+/**
+ * Enriched knowledge base detail including article and category counts.
+ */
+export interface KnowledgeBaseDetail {
+    knowledgeBase: KnowledgeBaseRecord;
+    articleCount: number;
+    categoryCount: number;
+}
+export interface KnowledgeBaseResponse {
+    result: KnowledgeBaseRecord[];
+}
+export interface KnowledgeBaseSingleResponse {
+    result: KnowledgeBaseRecord;
+}
+export interface KnowledgeCategoryResponse {
+    result: KnowledgeCategoryRecord[];
+}
+export interface KnowledgeCategorySingleResponse {
+    result: KnowledgeCategoryRecord;
+}
+export interface KnowledgeArticleResponse {
+    result: KnowledgeArticleRecord[];
+}
+export interface KnowledgeArticleSummaryResponse {
+    result: KnowledgeArticleSummary[];
+}
+export interface KnowledgeArticleSingleResponse {
+    result: KnowledgeArticleRecord;
+}

package/dist/sn/knowledge/KnowledgeModels.js

@@ -0,0 +1,6 @@
+/**
+ * Models for Knowledge Base management operations against ServiceNow tables:
+ * kb_knowledge_base, kb_category, and kb_knowledge.
+ */
+export {};
+//# sourceMappingURL=KnowledgeModels.js.map

package/dist/sn/knowledge/KnowledgeModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnowledgeModels.js","sourceRoot":"","sources":["../../../src/sn/knowledge/KnowledgeModels.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/sn/xml/XMLRecordManager.d.ts

@@ -0,0 +1,35 @@
+import { ServiceNowInstance } from '../ServiceNowInstance.js';
+import { ExportRecordOptions, ExportRecordResult, ImportRecordsOptions, ImportRecordsResult } from './XMLRecordModels.js';
+/**
+ * Manages XML record export (unload) and import (upload) operations
+ * against ServiceNow `.do` processor endpoints.
+ */
+export declare class XMLRecordManager {
+    private _snRequest;
+    private _logger;
+    constructor(instance: ServiceNowInstance);
+    /**
+     * Export a single record as XML (ServiceNow unload format).
+     *
+     * @param options - Table name and sys_id of the record to export
+     * @returns The raw XML string plus parsed metadata (table, sysId, unloadDate)
+     */
+    exportRecord(options: ExportRecordOptions): Promise<ExportRecordResult>;
+    /**
+     * Import XML records into ServiceNow via the sys_upload.do processor.
+     *
+     * Acquires a CSRF token first, then POSTs a multipart form with the XML content.
+     *
+     * @param options - XML content and target table name
+     * @returns Success status and the target table
+     */
+    importRecords(options: ImportRecordsOptions): Promise<ImportRecordsResult>;
+    /**
+     * Fetch the CSRF token from /upload.do by parsing the sysparm_ck hidden input.
+     */
+    private _getUploadCSRFToken;
+    /**
+     * Parse ServiceNow unload XML to extract metadata (table name, sys_id, unload_date).
+     */
+    private _parseUnloadXml;
+}