@inploi/plugin-chatbot - npm Package Compare versions

Comparing version 3.20.3 to 3.21.0

dist/chatbot.d.ts

@@ -0,1 +1,2 @@
+import { Logger } from '@inploi/sdk';
 import { Flow } from './chatbot.api';
@@ -12,8 +13,12 @@ import { ChatbotDomManager } from './chatbot.dom';
     /** Specify the cache keys for restoring this flow from local state.
-     *  This will be appended to the flow id and version passed to `flow` property.
+     *  This will be appended *in addition* to the flow id and version passed to `flow` property.
      *  @example [job.id] if you want the flows to be unique per job.
      */
     flowKeys: string[];
-    /** Context to be forwarded to analytics or used by nodes internally. */
-    context: Record<string, unknown>;
+    analytics?: {
+        /** Data to be forwarded to analytics events as custom properties. */
+        customProperties?: Record<string, unknown>;
+    };
+    /** Context to be used by nodes internally. */
+    context?: Record<string, unknown>;
     /** Title to display in the status bar */
@@ -34,6 +39,4 @@ title: string;
     apiClient: import("@inploi/sdk").ApiClient;
-    logger: import("@inploi/sdk").Logger;
-    analytics: import("@inploi/sdk").AnalyticsService; /** Fetches a flow by job ID.
-     *  @param jobId - The job ID to fetch the flow for. This is the job ID according to the **ATS**, and not the inploi job ID.
-     */
+    logger: Logger;
+    analytics: import("@inploi/sdk").AnalyticsService;
 }) => {
@@ -45,4 +48,4 @@ /** Optionally eagerly renders the interface ahead of needing the chatbot. */
      */
-    fetchFlowByJobId: (jobId: string) => Promise<OpenChatbotParams>;
-    fetchFlowById: (flowId: string) => Promise<OpenChatbotParams>;
+    fetchFlowByJobId: (jobId: string, additionalProperties?: Partial<OpenChatbotParams>) => Promise<OpenChatbotParams>;
+    fetchFlowById: (flowId: string, additionalProperties?: Partial<OpenChatbotParams>) => Promise<OpenChatbotParams>;
     open: (params: OpenChatbotParams | Promise<OpenChatbotParams>) => Promise<void>;
@@ -49,0 +52,0 @@ /** @deprecated - Please use `open` instead. */

dist/chatbot.state.d.ts

@@ -13,2 +13,3 @@ import { OpenChatbotParams } from '.';
     nodeIdToProgress: Record<string, ChatbotFlowProgress>;
+    analytics: OpenChatbotParams['analytics'];
 };
@@ -36,3 +37,3 @@ type CurrentFlow = {
     inputHeight$: import("@preact/signals").Signal<number>;
-    startFlow: ({ flow, context, flowKeys, title }: OpenChatbotParams) => Promise<void>;
+    startFlow: ({ flow, context, flowKeys, title, analytics }: OpenChatbotParams) => Promise<void>;
     cancelCurrentFlow: () => void;
@@ -39,0 +40,0 @@ markAsFinished: () => void;

dist/interpreter.d.ts

@@ -27,7 +27,10 @@ import { FlowNode } from '@inploi/core/flows';
 };
-type ChatbotInterpreterParams<TContext extends Record<string, unknown>> = {
+type ChatbotInterpreterParams = {
     apiClient: ApiClient;
-    analytics: AnalyticsService;
+    analytics: {
+        service: AnalyticsService;
+        customProperties?: Record<string, unknown>;
+    };
     logger: Logger;
-    context: TContext;
+    context: Record<string, unknown>;
     flow: StartedFlow;
@@ -43,3 +46,3 @@ getSubmissions: () => KeyToSubmissionMap | undefined;
 };
-export declare const createFlowInterpreter: <TContext extends Record<string, unknown>>({ flow, analytics, logger, context, apiClient, getSubmissions, chatService, onFlowEnd, onInterpret, }: ChatbotInterpreterParams<TContext>) => {
+export declare const createFlowInterpreter: ({ flow, analytics, logger, context, apiClient, getSubmissions, chatService, onFlowEnd, onInterpret, }: ChatbotInterpreterParams) => {
     interpret: (startFromNodeId?: string) => Promise<void>;
@@ -46,0 +49,0 @@ undo: (nodeHistory: string[]) => {

dist/plugin-chatbot.js

@@ -1,2 +0,2 @@
-import { P } from "./index-03f425b8.js";
+import { P } from "./index-8c0699fb.js";
 import "@inploi/sdk";
@@ -3,0 +3,0 @@ export {

package.json

 {
   "name": "@inploi/plugin-chatbot",
-  "version": "3.20.3",
+  "version": "3.21.0",
   "type": "module",
@@ -69,6 +69,6 @@ "main": "dist/plugin-chatbot.js",
     "vite-tsconfig-paths": "^4.2.1",
+    "@inploi/core": "1.14.2",
     "@inploi/design-tokens": "0.2.1",
     "@inploi/sdk": "1.14.1",
     "eslint-config-custom": "0.1.0",
-    "@inploi/core": "1.14.2",
     "tsconfig": "0.1.0"
@@ -75,0 +75,0 @@ },

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

1088181

decreased by-1.82%

Lines of code

25059

decreased by-2.52%

No dependency changes