@cognigy/rest-api-client 2025.17.0 → 2025.18.1

package/dist/esm/shared/interfaces/resources/INodeDescriptorSet.js

@@ -1,4 +1,4 @@
-import { chartableResourceTypes, } from "./TResourceType";
+import { chartableResourceTypes } from "./TResourceType";
 import { snippetDataSchema } from "./ISnippet";
 const nodeAppearanceSchema = {
     title: "nodeAppearanceSchema",
@@ -9,8 +9,8 @@ const nodeAppearanceSchema = {
         textColor: { type: "string", format: "color" },
         contrastTextColor: { type: "string", format: "color" },
         showIcon: { type: "boolean" },
-        variant: { type: "string", enum: ["regular", "mini", "hexagon"] },
-    },
+        variant: { type: "string", enum: ["regular", "mini", "hexagon"] }
+    }
 };
 const nodeBehaviorSchema = {
     title: "nodeBehaviorSchema",
@@ -18,8 +18,8 @@ const nodeBehaviorSchema = {
     additionalProperties: false,
     properties: {
         stopping: { type: "boolean" },
-        entrypoint: { type: "boolean" },
-    },
+        entrypoint: { type: "boolean" }
+    }
 };
 export const nodePreviewTypes = [
     "text",
@@ -35,8 +35,8 @@ const nodePreviewSchema = {
     additionalProperties: false,
     properties: {
         key: { type: "string", minLength: 1, maxLength: 200 },
-        type: { type: "string", enum: [...nodePreviewTypes] },
-    },
+        type: { type: "string", enum: [...nodePreviewTypes] }
+    }
 };
 const nodeConstraintSchema = {
     title: "nodeConstraintSchema",
@@ -45,13 +45,13 @@ const nodeConstraintSchema = {
     properties: {
         blacklist: {
             type: "array",
-            items: { type: "string", minLength: 1, maxLength: 200 },
+            items: { type: "string", minLength: 1, maxLength: 200 }
         },
         whitelist: {
             type: "array",
-            items: { type: "string", minLength: 1, maxLength: 200 },
-        },
-    },
+            items: { type: "string", minLength: 1, maxLength: 200 }
+        }
+    }
 };
 const nodeConstraintsSchema = {
     title: "nodeConstraintsSchema",
@@ -70,10 +70,10 @@ const nodeConstraintsSchema = {
             properties: {
                 children: nodeConstraintSchema,
                 predecessor: nodeConstraintSchema,
-                successor: nodeConstraintSchema,
-            },
-        },
-    },
+                successor: nodeConstraintSchema
+            }
+        }
+    }
 };
 const nodeDependenciesSchema = {
     title: "nodeDependenciesSchema",
@@ -82,9 +82,9 @@ const nodeDependenciesSchema = {
     properties: {
         children: {
             type: "array",
-            items: { type: "string", minLength: 1, maxLength: 200 },
-        },
-    },
+            items: { type: "string", minLength: 1, maxLength: 200 }
+        }
+    }
 };
 export const nodeFieldTypes = [
     "adaptivecard",
@@ -154,7 +154,7 @@ export const searchableNodeFieldTypes = [
     "say",
     "code",
     "caseNode",
-    "select",
+    "select"
 ];
 export const nodeFieldSingleConditionSchema = {
     title: "nodeFieldSingleConditionSchema",
@@ -171,11 +171,11 @@ export const nodeFieldSingleConditionSchema = {
                 { type: "number" },
                 { type: "array", items: { type: "number" } },
                 { type: "boolean" },
-                { type: "array", items: { type: "boolean" } },
-            ],
+                { type: "array", items: { type: "boolean" } }
+            ]
         },
-        negate: { type: "boolean" },
-    },
+        negate: { type: "boolean" }
+    }
 };
 export const nodeFieldANDConditionSchema = {
     title: "nodeFieldANDConditionSchema",
@@ -183,8 +183,8 @@ export const nodeFieldANDConditionSchema = {
     additionalProperties: false,
     required: ["and"],
     properties: {
-        and: { type: "array", items: { $ref: "nodeFieldConditionSchema" } },
-    },
+        and: { type: "array", items: { $ref: "nodeFieldConditionSchema" } }
+    }
 };
 export const nodeFieldORConditionSchema = {
     title: "nodeFieldORConditionSchema",
@@ -192,8 +192,8 @@ export const nodeFieldORConditionSchema = {
     additionalProperties: false,
     required: ["or"],
     properties: {
-        or: { type: "array", items: { $ref: "nodeFieldConditionSchema" } },
-    },
+        or: { type: "array", items: { $ref: "nodeFieldConditionSchema" } }
+    }
 };
 // @ts-ignore
 export const nodeFieldConditionSchema = {
@@ -206,8 +206,8 @@ export const nodeFieldConditionSchema = {
         // @ts-ignore
         nodeFieldANDConditionSchema,
         // @ts-ignore
-        nodeFieldORConditionSchema,
-    ],
+        nodeFieldORConditionSchema
+    ]
 };
 export const nodeOptionsResolverSchema = {
     title: "nodeOptionsResolverSchema",
@@ -216,10 +216,10 @@ export const nodeOptionsResolverSchema = {
     properties: {
         dependencies: {
             type: "array",
-            items: { type: "string", minLength: 1, maxLength: 200 },
+            items: { type: "string", minLength: 1, maxLength: 200 }
         },
-        resolverFunction: {},
-    },
+        resolverFunction: {}
+    }
 };
 export const nodeFieldSchema = {
     title: "nodeFieldSchema",
@@ -240,10 +240,10 @@ export const nodeFieldSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 },
-                    },
-                },
-            ],
+                        koKR: { type: "string", maxLength: 200 }
+                    }
+                }
+            ]
         },
         condition: nodeFieldConditionSchema,
         defaultValue: {
@@ -253,8 +253,18 @@ export const nodeFieldSchema = {
                 { type: "number" },
                 { type: "null" },
                 { type: "object" },
-                { type: "string" },
-            ],
+                { type: "string" }
+            ]
+        },
+        fallbackValue: {
+            oneOf: [
+                { type: "array" },
+                { type: "boolean" },
+                { type: "number" },
+                { type: "null" },
+                { type: "object" },
+                { type: "string" }
+            ]
         },
         description: {
             oneOf: [
@@ -268,10 +278,10 @@ export const nodeFieldSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 },
-                    },
-                },
-            ],
+                        koKR: { type: "string", maxLength: 200 }
+                    }
+                }
+            ]
         },
         params: { type: "object" },
         optionsResolver: nodeOptionsResolverSchema,
@@ -282,11 +292,11 @@ export const nodeFieldSchema = {
                 lookupValue: { type: "string" },
                 fieldsToReset: {
                     type: "array",
-                    items: { type: "string" },
-                },
-            },
-        },
-    },
+                    items: { type: "string" }
+                }
+            }
+        }
+    }
 };
 export const nodeSectionSchema = {
     title: "nodeSectionSchema",
@@ -306,10 +316,10 @@ export const nodeSectionSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 },
-                    },
-                },
-            ],
+                        koKR: { type: "string", maxLength: 200 }
+                    }
+                }
+            ]
         },
         description: {
             oneOf: [
@@ -323,10 +333,10 @@ export const nodeSectionSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 },
-                    },
-                },
-            ],
+                        koKR: { type: "string", maxLength: 200 }
+                    }
+                }
+            ]
         },
         condition: nodeFieldConditionSchema,
         defaultCollapsed: { type: "boolean" },
@@ -338,10 +348,10 @@ export const nodeSectionSchema = {
             items: {
                 type: "string",
                 minLength: 1,
-                maxLength: 200,
-            },
-        },
-    },
+                maxLength: 200
+            }
+        }
+    }
 };
 export const nodeFieldAndSectionFormElementSchema = {
     title: "nodeFieldAndSectionFormElementSchema",
@@ -349,8 +359,8 @@ export const nodeFieldAndSectionFormElementSchema = {
     required: ["key", "type"],
     properties: {
         key: { type: "string", minLength: 1, maxLength: 200 },
-        type: { type: "string", enum: ["field", "section"] },
-    },
+        type: { type: "string", enum: ["field", "section"] }
+    }
 };
 export const nodeDescriptorSchema = {
     title: "nodeDescriptorSchema",
@@ -372,10 +382,10 @@ export const nodeDescriptorSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 },
-                    },
-                },
-            ],
+                        koKR: { type: "string", maxLength: 200 }
+                    }
+                }
+            ]
         },
         summary: {
             oneOf: [
@@ -389,10 +399,10 @@ export const nodeDescriptorSchema = {
                         deDE: { type: "string", maxLength: 200 },
                         jaJP: { type: "string", maxLength: 200 },
                         esES: { type: "string", maxLength: 200 },
-                        koKR: { type: "string", maxLength: 200 },
-                    },
-                },
-            ],
+                        koKR: { type: "string", maxLength: 200 }
+                    }
+                }
+            ]
         },
         appearance: nodeAppearanceSchema,
         behavior: nodeBehaviorSchema,
@@ -405,25 +415,25 @@ export const nodeDescriptorSchema = {
             type: "array",
             items: { type: "string" },
             uniqueItems: true,
-            minItems: 0,
+            minItems: 0
         },
         tokens: {
             type: "array",
             items: snippetDataSchema,
-            uniqueItems: true,
+            uniqueItems: true
         },
         sections: {
             type: "array",
             additionalItems: false,
-            items: nodeSectionSchema,
+            items: nodeSectionSchema
         },
         form: {
             type: "array",
             additionalItems: false,
             maxLength: 25,
-            items: nodeFieldAndSectionFormElementSchema,
-        },
-    },
+            items: nodeFieldAndSectionFormElementSchema
+        }
+    }
 };
 export const nodeDescriptorSetSchema = {
     title: "nodeDescriptorSetSchema",
@@ -439,10 +449,10 @@ export const nodeDescriptorSetSchema = {
         descriptors: {
             type: "array",
             additionalItems: false,
-            items: nodeDescriptorSchema,
+            items: nodeDescriptorSchema
         },
         resourceType: { type: "string", enum: chartableResourceTypes },
-        trustedCode: { type: "boolean" },
-    },
+        trustedCode: { type: "boolean" }
+    }
 };
 //# sourceMappingURL=INodeDescriptorSet.js.map

package/dist/esm/shared/interfaces/resources/TResourceType.js

@@ -156,6 +156,7 @@ export const searchableResourceTypes = [
     "playbook",
     "project",
     "snapshot",
+    "simulation",
 ];
 export const packageableResourceTypes = [
     "aiAgent",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cognigy/rest-api-client",
-	"version": "2025.17.0",
+	"version": "2025.18.1",
 	"description": "Cognigy REST-Client",
 	"main": "build/index.js",
 	"module": "dist/esm/index.js",

package/types/index.d.ts

@@ -146,6 +146,11 @@ export interface IHttpRequestOptions {
 	 * @default true
 	 */
 	withAuthentication?: boolean;
+	/**
+	 * Should send credentials to the request.
+	 * @default false
+	 */
+	withCredentials?: boolean;
 	/**
 	 * Specifies the number of milliseconds before the request times out.
 	 */
@@ -374,6 +379,13 @@ export interface ILoginByAuthorizationCodeParameters {
 	 * The code verifier for authentication using authorization code with PKCE
 	 */
 	codeVerifier?: string;
+	/**
+	 * If rememberMe is set to true, you get a long lived refreshToken, default
+	 * 7 days. If rememberMe is set to false, you get a short lived refreshToken valid only for 24 hours.
+	 *
+	 * @default false
+	 */
+	rememberMe: boolean;
 }
 export interface IGetAuthorizationCodeParameters {
 	/**
@@ -771,6 +783,10 @@ declare class InvalidArgumentError extends BadRequestError {
 	constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
 		[key: string]: any;
 	}, logLevel?: TLogLevel);
+	toRFC7807Response(data?: {
+		path?: string;
+		traceId?: string;
+	}): IErrorResponse;
 }
 declare class MethodNotAllowedError extends BaseError {
 	constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
@@ -781,6 +797,10 @@ declare class MissingArgumentError extends BadRequestError {
 	constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
 		[key: string]: any;
 	}, logLevel?: TLogLevel);
+	toRFC7807Response(data?: {
+		path?: string;
+		traceId?: string;
+	}): IErrorResponse;
 }
 declare class NetworkError extends BaseError {
 	constructor(message: string, stack?: ILoggerStack, meta?: ISuggestedMetaInfo, details?: {
@@ -979,7 +999,8 @@ declare const searchableResourceTypes: readonly [
 	"nluconnector",
 	"playbook",
 	"project",
-	"snapshot"
+	"snapshot",
+	"simulation"
 ];
 export declare type TSearchableResourceType = (typeof searchableResourceTypes)[number];
 declare const pinnableResourceTypes: readonly [
@@ -4358,6 +4379,10 @@ declare const generativeAIModels: readonly [
 	"gpt-4.1",
 	"gpt-4.1-mini",
 	"gpt-4.1-nano",
+	"gpt-5",
+	"gpt-5-nano",
+	"gpt-5-mini",
+	"gpt-5-chat-latest",
 	"luminous-extended-control",
 	"claude-v1-100k",
 	"claude-instant-v1",
@@ -5527,15 +5552,15 @@ export interface IMongoosePaginationPluginReturnValue<T = any> {
  *           type: integer
  *           example: 1
  *         next:
- *           oneOf:
+ *           allOf:
  *             - $ref: '#/components/schemas/TMongoId'
- *             - nullable: true
+ *           nullable: true
  *           example: 5ce7c2d833ea1e04d7e6c432
  *         previous:
- *           oneOf:
+ *           allOf:
  *             - $ref: '#/components/schemas/TMongoId'
- *             - nullable: true
- *           example: null
+ *           nullable: true
+ *           example: 5ce7c2d833ea1e04d7e6c432
  */
 export interface ICursorBasedPaginationReturnValue<T> extends IMongoosePaginationPluginReturnValue<T> {
 }
@@ -10125,6 +10150,7 @@ declare enum TranscriptEntryType {
 }
 export declare type TTranscriptEntryContent = TTranscriptUserInput | TTranscriptAssistantOutput | TTranscriptAgentOutput | TTranscriptAssistantToolCall | TTranscriptToolAnswer | TTranscriptDebugLog;
 export declare type TTranscriptEntry = TTranscriptEntryContent & {
+	id: string;
 	timestamp: number;
 	traceId: string;
 };
@@ -10645,7 +10671,7 @@ export interface IActions {
 	getState?: () => string;
 	getSystemContext?: (key: string) => any;
 	emitEvent?: TEmitter;
-	executeCodeInSecureContext?: (codeParams: ICodeNodeParams) => void;
+	executeCodeInSecureContext?: (codeParams: ICodeNodeParams) => Promise<void>;
 	executeCognigyNLU?: (params: IExecuteCognigyNLUParams) => Promise<INLProperties>;
 	handleIntentDefaultReply?: (params: INLProperties) => Promise<any>;
 	/**
@@ -10940,6 +10966,11 @@ export interface IPatternMatchResult {
 	detailedMatches?: any[];
 }
 export declare type IPatternTypes = "de_lp" | "iban" | "us_ssn" | "bic" | "ipv4" | "creditcard" | "phonenumber";
+export interface IExecutionMetadata {
+	sessionId: string;
+	projectId: string;
+	organisationId: string;
+}
 export interface IExecutionObjects {
 	input: {
 		[key: string]: any;
@@ -10954,6 +10985,7 @@ export interface IExecutionObjects {
 		[key: string]: any;
 	};
 	lastConversationEntries: ILastConversationEntry[];
+	metadata: IExecutionMetadata;
 }
 export declare type TEmitter = (type: TDebugEventType, payload: TDebugEventPayload, options?: IEmitterOptions) => void;
 export interface IEmitterOptions {
@@ -11301,7 +11333,7 @@ export interface INodeExecutionAPI extends Omit<IActions, "parseCognigyScriptCon
 	executeCognigyNLU?: (text: string, data: any, inputId: string, pipeline: IGetNluPipelineParams) => Promise<INLProperties>;
 	handleIntentDefaultReply?: (nlProperties: INLProperties) => Promise<any>;
 	executeFlow: (config: IExecuteFlowNodeConfig) => Promise<void>;
-	goToNode?: (config: IGoToNodeParams["config"]["flowNode"]) => Promise<void>;
+	goToNode?: (config: Pick<IGoToNodeParams["config"], "flowNode" | "absorbContext">) => Promise<void>;
 	addConditionalEntrypoint: (addConditionalEntrypointParams: IAddConditionalEntrypointParams) => void;
 	runSQLQuery?: (params: {
 		connection: ISQLConnectionFields;
@@ -11496,7 +11528,7 @@ declare const nodePreviewTypes: readonly [
 	"image",
 	"aiAgent"
 ];
-export declare type TNodePreviewType = (typeof nodePreviewTypes)[number];
+export declare type TNodePreviewType = typeof nodePreviewTypes[number];
 export interface INodePreview {
 	type: TNodePreviewType;
 	key: string;
@@ -11593,7 +11625,7 @@ declare const nodeFieldTypes: readonly [
 	"typescript",
 	"xml"
 ];
-export declare type TNodeFieldType = (typeof nodeFieldTypes)[number];
+export declare type TNodeFieldType = typeof nodeFieldTypes[number];
 export declare type TComparableValue = string | number | boolean;
 export declare type TNodeFieldCondition = INodeFieldSingleCondition | INodeFieldANDCondition | INodeFieldORCondition;
 export interface INodeFieldSingleCondition {
@@ -11640,6 +11672,7 @@ export interface INodeField<K extends string | number | symbol = string> {
 	label: string | INodeFieldTranslations;
 	condition?: TNodeFieldCondition;
 	defaultValue?: any;
+	fallbackValue?: any;
 	description?: string | INodeFieldTranslations;
 	params?: {
 		[key: string]: any;
@@ -11813,27 +11846,27 @@ export interface IKnowledgeField<K extends string | number | symbol = string> {
  *           items:
  *             type: object
  *             properties:
-*               type:
-*                 type: string
-*                 enum:
-*                   - text
-*                   - rule
-*                   - json
-*                   - checkbox
-*                   - time
-*                   - date
-*                   - datetime
-*                   - select
-*                   - xml
-*                   - textArray
-*                   - chipInput
-*                   - toggle
-*                   - slider
-*                   - number
-*                   - daterange
-*                   - connection
-*                   - condition
-*                   - description
+ *               type:
+ *                 type: string
+ *                 enum:
+ *                   - text
+ *                   - rule
+ *                   - json
+ *                   - checkbox
+ *                   - time
+ *                   - date
+ *                   - datetime
+ *                   - select
+ *                   - xml
+ *                   - textArray
+ *                   - chipInput
+ *                   - toggle
+ *                   - slider
+ *                   - number
+ *                   - daterange
+ *                   - connection
+ *                   - condition
+ *                   - description
  *               key:
  *                 type: string
  *               label:
@@ -13169,9 +13202,9 @@ export interface IIndexChartNodesRestReturnValue_2_0 extends ICursorBasedPaginat
  *           items:
  *             $ref: '#/components/schemas/TMongoId'
  *         next:
- *           oneOf:
+ *           allOf:
  *             - $ref: '#/components/schemas/TMongoId'
- *             - nullable: true
+ *           nullable: true
  */
 export interface IChartNodeRelation_2_0 {
 	_id: TMongoId;
@@ -18254,6 +18287,11 @@ export interface IKnowledgeSourceMetaData {
 	failReason?: string;
 	tags?: string[];
 	extractedChunks?: number;
+	extension?: {
+		name: string;
+		id: string;
+		type: string;
+	};
 }
 /**
  * @openapi
@@ -18549,6 +18587,8 @@ export interface IRunKnowledgeExtensionRestDataBody_2_0 {
 }
 export interface IRunKnowledgeExtensionRestData_2_0 extends IRunKnowledgeExtensionRestDataParams_2_0, IRunKnowledgeExtensionRestDataBody_2_0 {
 }
+export interface IRunKnowledgeExtensionRestReturnValue_2_0 extends ICreatedTask_2_0 {
+}
 /**
  * @openapi
  *
@@ -19250,7 +19290,7 @@ export interface ResourcesAPIGroup_2_0 {
 	readKnowledgeStore: TRestAPIOperation<IReadKnowledgeStoreRestData_2_0, IReadKnowledgeStoreRestReturnValue_2_0>;
 	deleteKnowledgeStore: TRestAPIOperation<IDeleteKnowledgeStoreRestData_2_0, IDeleteKnowledgeStoreRestReturnValue_2_0>;
 	updateKnowledgeStore: TRestAPIOperation<IUpdateKnowledgeStoreRestData_2_0, IUpdateKnowledgeStoreRestReturnValue_2_0>;
-	runKnowledgeExtension: TRestAPIOperation<IRunKnowledgeExtensionRestData_2_0, IRunKnowledgeExtensionRestDataBody_2_0>;
+	runKnowledgeExtension: TRestAPIOperation<IRunKnowledgeExtensionRestData_2_0, IRunKnowledgeExtensionRestReturnValue_2_0>;
 	indexKnowledgeDescriptors: TRestAPIOperation<IIndexKnowledgeDescriptorsRestData_2_0, IIndexKnowledgeDescriptorsRestReturnValue_2_0>;
 	indexKnowledgeSources: TRestAPIOperation<IIndexKnowledgeSourcesRestData_2_0, IIndexKnowledgeSourcesRestReturnValue_2_0>;
 	createKnowledgeSource: TRestAPIOperation<ICreateKnowledgeSourceRestData_2_0, ICreateKnowledgeSourceRestReturnValue_2_0>;