@sonisoft/now-sdk-ext-core 3.0.2 → 3.4.0

package/dist/sn/catalog/CatalogModels.d.ts

@@ -0,0 +1,177 @@
+/**
+ * Models for Service Catalog management operations against ServiceNow tables:
+ * sc_cat_item, sc_category, and item_option_new.
+ */
+/**
+ * A catalog item record from the sc_cat_item table.
+ */
+export interface CatalogItemRecord {
+    sys_id: string;
+    name: string;
+    short_description?: string;
+    description?: string;
+    category?: string;
+    price?: string;
+    active?: string;
+    order?: string;
+    sys_scope?: string;
+    sc_catalogs?: string;
+    type?: string;
+    [key: string]: unknown;
+}
+/**
+ * A catalog category record from the sc_category table.
+ */
+export interface CatalogCategoryRecord {
+    sys_id: string;
+    title: string;
+    description?: string;
+    parent?: string;
+    sc_catalog?: string;
+    active?: string;
+    order?: string;
+    icon?: string;
+    header_icon?: string;
+    [key: string]: unknown;
+}
+/**
+ * A catalog variable record from the item_option_new table.
+ * Includes an enriched friendly_type field mapped from the numeric type code.
+ */
+export interface CatalogVariableRecord {
+    sys_id: string;
+    name: string;
+    question_text?: string;
+    type?: string;
+    mandatory?: string;
+    default_value?: string;
+    help_text?: string;
+    order?: string;
+    reference?: string;
+    reference_qual?: string;
+    choice_table?: string;
+    choice_field?: string;
+    cat_item?: string;
+    variable_set?: string;
+    /** Human-readable variable type name mapped from the numeric type code */
+    friendly_type?: string;
+    [key: string]: unknown;
+}
+/**
+ * A record from the io_set_item table linking variable sets to catalog items.
+ */
+export interface VariableSetItemRecord {
+    sys_id: string;
+    sc_cat_item: string;
+    variable_set: string;
+    [key: string]: unknown;
+}
+/**
+ * Options for listing catalog items.
+ */
+export interface ListCatalogItemsOptions {
+    /** Encoded query string for filtering */
+    query?: string;
+    /** Text search term (searches name and short_description) */
+    textSearch?: string;
+    /** Filter by category sys_id */
+    categorySysId?: string;
+    /** Filter by catalog sys_id */
+    catalogSysId?: 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 catalog categories.
+ */
+export interface ListCatalogCategoriesOptions {
+    /** Filter by parent category sys_id */
+    parentSysId?: string;
+    /** Filter by catalog sys_id */
+    catalogSysId?: string;
+    /** Filter by active status */
+    active?: boolean;
+    /** Filter by title (exact match) */
+    title?: 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 listing catalog item variables.
+ */
+export interface ListCatalogVariablesOptions {
+    /** The catalog item sys_id (required) */
+    catalogItemSysId: string;
+    /** Include variables from variable sets (default true) */
+    includeVariableSets?: boolean;
+}
+/**
+ * Options for submitting a catalog request via order_now.
+ */
+export interface SubmitCatalogRequestOptions {
+    /** The catalog item sys_id (required) */
+    catalogItemSysId: string;
+    /** Quantity to order (default 1) */
+    quantity?: number;
+    /** Variable name-value pairs */
+    variables?: Record<string, string>;
+}
+/**
+ * Enriched catalog item detail including its variables.
+ */
+export interface CatalogItemDetail {
+    item: CatalogItemRecord;
+    variables: CatalogVariableRecord[];
+}
+/**
+ * Enriched catalog category detail including item count.
+ */
+export interface CatalogCategoryDetail {
+    category: CatalogCategoryRecord;
+    itemCount: number;
+}
+/**
+ * Result from submitting a catalog request, including both REQ and RITM.
+ */
+export interface CatalogRequestResult {
+    requestNumber: string;
+    requestSysId: string;
+    requestItemNumber?: string;
+    requestItemSysId?: string;
+}
+export interface CatalogItemResponse {
+    result: CatalogItemRecord[];
+}
+export interface CatalogCategoryResponse {
+    result: CatalogCategoryRecord[];
+}
+export interface CatalogVariableResponse {
+    result: CatalogVariableRecord[];
+}
+export interface VariableSetItemResponse {
+    result: VariableSetItemRecord[];
+}
+export interface CatalogOrderResponse {
+    result: {
+        sys_id: string;
+        number: string;
+        request_number: string;
+        request_id: string;
+        table: string;
+    };
+}
+export interface RequestItemResponse {
+    result: Array<{
+        sys_id: string;
+        number: string;
+        [key: string]: unknown;
+    }>;
+}

package/dist/sn/catalog/CatalogModels.js

@@ -0,0 +1,6 @@
+/**
+ * Models for Service Catalog management operations against ServiceNow tables:
+ * sc_cat_item, sc_category, and item_option_new.
+ */
+export {};
+//# sourceMappingURL=CatalogModels.js.map

package/dist/sn/catalog/CatalogModels.js.map

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

package/dist/sn/flow/FlowManager.d.ts

@@ -0,0 +1,69 @@
+import { ServiceNowInstance } from "../ServiceNowInstance.js";
+import { BackgroundScriptExecutionResult } from "../BackgroundScriptExecutor.js";
+import { ExecuteFlowOptions, ExecuteFlowByNameOptions, ExecuteSubflowOptions, ExecuteActionOptions, FlowExecutionResult, FlowScriptResultEnvelope, FlowContextStatusResult, FlowOutputsResult, FlowErrorResult, FlowCancelResult, FlowSendMessageResult } from './FlowModels.js';
+/**
+ * Provides operations for executing ServiceNow Flow Designer flows,
+ * subflows, and actions remotely via BackgroundScriptExecutor.
+ *
+ * Uses the sn_fd.FlowAPI.getRunner() (ScriptableFlowRunner) API
+ * on the server side to execute and capture results.
+ */
+export declare class FlowManager {
+    private _logger;
+    private _bgExecutor;
+    private _instance;
+    private _defaultScope;
+    /**
+     * @param instance ServiceNow instance connection
+     * @param scope Default scope for script execution (default: "global")
+     */
+    constructor(instance: ServiceNowInstance, scope?: string);
+    /** Execute any flow object (flow, subflow, or action). */
+    execute(options: ExecuteFlowOptions): Promise<FlowExecutionResult>;
+    /** Execute a flow by scoped name. */
+    executeFlow(options: ExecuteFlowByNameOptions): Promise<FlowExecutionResult>;
+    /** Execute a subflow by scoped name. */
+    executeSubflow(options: ExecuteSubflowOptions): Promise<FlowExecutionResult>;
+    /** Execute an action by scoped name. */
+    executeAction(options: ExecuteActionOptions): Promise<FlowExecutionResult>;
+    /** Query the status of a flow context by its sys_id. */
+    getFlowContextStatus(contextId: string): Promise<FlowContextStatusResult>;
+    /** Retrieve outputs from a completed flow/subflow/action by context ID. */
+    getFlowOutputs(contextId: string): Promise<FlowOutputsResult>;
+    /** Retrieve error messages from a flow/subflow/action by context ID. */
+    getFlowError(contextId: string): Promise<FlowErrorResult>;
+    /** Cancel a running or paused flow/subflow/action. */
+    cancelFlow(contextId: string, reason?: string): Promise<FlowCancelResult>;
+    /** Send a message to a paused flow to resume it (for Wait for Message actions). */
+    sendFlowMessage(contextId: string, message: string, payload?: string): Promise<FlowSendMessageResult>;
+    /** Build the ServiceNow server-side script string. */
+    _buildFlowScript(options: ExecuteFlowOptions): string;
+    /** Serialize inputs for embedding in the generated script. */
+    _serializeInputs(inputs: Record<string, unknown>): string;
+    /**
+     * Decode HTML entities and strip HTML tags from a string.
+     * ServiceNow's background script output encodes quotes as &quot;
+     * and appends <BR/> tags that must be removed before JSON parsing.
+     */
+    _decodeHtmlEntities(str: string): string;
+    /** Try to parse a line containing the result marker into a FlowScriptResultEnvelope. */
+    private _tryParseEnvelopeFromLine;
+    /** Extract the JSON envelope from script output lines. */
+    _extractResultEnvelope(bgResult: BackgroundScriptExecutionResult): FlowScriptResultEnvelope | null;
+    /** Parse BackgroundScriptExecutionResult into FlowExecutionResult. */
+    _parseFlowResult(bgResult: BackgroundScriptExecutionResult, options: ExecuteFlowOptions): FlowExecutionResult;
+    /** Validate that a context ID is non-empty. */
+    private _validateContextId;
+    /** Escape a string for embedding in a generated SN script single-quoted string. */
+    private _escapeForScript;
+    /** Build script to query sys_flow_context status. */
+    _buildContextStatusScript(contextId: string): string;
+    /** Build script to retrieve flow outputs via FlowAPI.getOutputs(). */
+    _buildGetOutputsScript(contextId: string): string;
+    /** Build script to retrieve flow error via FlowAPI.getErrorMessage(). */
+    _buildGetErrorScript(contextId: string): string;
+    /** Build script to cancel a flow via FlowAPI.cancel(). */
+    _buildCancelScript(contextId: string, reason: string): string;
+    /** Build script to send a message to a paused flow via FlowAPI.sendMessage(). */
+    _buildSendMessageScript(contextId: string, message: string, payload: string): string;
+}