@arcgis/ai-components 5.1.0-next.99 → 5.1.1

package/dist/utils/index.d.ts

@@ -1,12 +1,27 @@
-import type z from "zod";
-import type { ChatHistory } from "@arcgis/ai-orchestrator";
-import type { AIMessage } from "@langchain/core/messages";
+import type MapView from "@arcgis/core/views/MapView.js";
+import type KnowledgeGraph from "@arcgis/core/rest/knowledgeGraph/KnowledgeGraph.js";
+import type LinkChartView from "@arcgis/core/views/LinkChartView.js";
+import type { AIMessage, BaseMessage } from "@langchain/core/messages";
 import type { RunnableConfig } from "@langchain/core/runnables";
 import type { StructuredToolInterface } from "@langchain/core/tools";
-import type { AnnotationRoot, StateGraph } from "@langchain/langgraph/web";
+import type { AnnotationRoot, BaseChannel, StateGraph } from "@langchain/langgraph/web";
+import type { ChatOpenAI } from "@langchain/openai";
+import type { ZodType } from "zod";
 
-export { type ChatHistory } from "@arcgis/ai-orchestrator";
-export { type CustomConfigurableType } from "@arcgis/ai-orchestrator";
+export { type CustomConfigurableType } from "../orchestrator";
+export { Orchestrator } from "../orchestrator";
+
+/** @internal */
+export type ChatModelTier = "advanced" | "default" | "fast";
+
+/**
+ * Represents the chat message history between the user and the assistant, including all messages sent and received during the conversation.
+ * This structure is used to provide context for the assistant's responses and can be utilized when invoking prompts to ensure the model
+ * has access to the full conversation history.
+ *
+ * @since 5.0
+ */
+export type ChatHistory = BaseMessage[];
 
 /**
  * Represents a user-facing interruption emitted by an agent that requires
@@ -134,6 +149,8 @@ export type ArcgisPromptOptions = {
    * - `advanced` - An advanced model tier that may provide improved accuracy or capabilities compared to
    *   the default tier. However, it may also come with increased cost and slower performance. At
    *   JS SDK v5.0, this model tier corresponds to GPT-5.2 model.
+   * - `fast` - A lower cost model suitable for tasks like classification and summarization. This tier may have limitations in terms of response length and complexity.
+   *   New at JS SDK v5.1, this model tier corresponds to GPT-5.4-nano model.
    *
    * The specific models available in each tier may evolve over time as new models are released and existing
    * models are retired. The dates models are retired depends on the model provider and therefore may not
@@ -147,7 +164,7 @@ export type ArcgisPromptOptions = {
    * agent descriptions and tool node descriptions to
    * ensure they still return the expected responses. You should adjust your implementation as needed.
    */
-  modelTier?: "advanced" | "default";
+  modelTier?: ChatModelTier;
   /**
    * The temperature to use for the model (a number between 0 and 1). Higher values will result in more
    * creative and varied responses, while lower values will produce more focused and deterministic responses.
@@ -160,6 +177,8 @@ export type ArcgisPromptOptions = {
    * and produce more accurate and relevant responses.
    */
   messages?: ChatHistory;
+  /** Optional runnable configuration used to derive runtime values (for example, conversation id and abort signal). */
+  config?: RunnableConfig;
   /**
    * Input variables for the prompt. This can include any relevant variables related to the context
    * provided to the agent. This may be necessary for determining tool parameters or for providing additional
@@ -183,7 +202,7 @@ export type ArcgisStructuredPromptOptions<T> = ArcgisPromptOptions
    *
    * @see [Zod documentation](https://zod.dev/api)
    */
-  schema: z.ZodType<T>;
+  schema: ZodType<T>;
 };
 
 /**
@@ -302,4 +321,222 @@ export function getEmbeddings(inputs: string[]): Promise<number[][]>;
  * @param vectorB - The second vector array.
  * @returns A similarity score from -1 (opposite) to 1 (identical).
  */
-export function cosineSimilarity(vectorA: number[], vectorB: number[]): number;
+export function cosineSimilarity(vectorA: number[], vectorB: number[]): number;
+
+/**
+ * The suggestions emitted by the agent to the user interface.
+ *
+ * @since 5.1
+ */
+export type UXSuggestion = {
+  /** The type of suggestion being made. */
+  type: string;
+  /** Optional additional data associated with the suggestion. */
+  data?: Record<string, unknown>;
+};
+
+/**
+ * Execution status returned by an agent run.
+ *
+ * @since 5.1
+ */
+export type AgentStatus = "failed" | "success" | "unknown";
+
+/**
+ * Summary of a previously executed agent step.
+ *
+ * @since 5.1
+ */
+export interface PriorStep {
+  /** The agent that handled the step. */
+  agentId: string;
+  /** The task assigned to the agent for this step. */
+  assignedTask: string;
+  /** A brief summary of the step's execution. */
+  summary: string;
+  /** The execution status of the step. */
+  status: AgentStatus;
+}
+
+/**
+ * Runtime execution context available to agent graph nodes and tools.
+ *
+ * @since 5.1
+ */
+export interface AgentExecutionContext<TState extends Record<string, unknown> = Record<string, unknown>> {
+  /** The user's original request. */
+  userRequest: string;
+  /** The task assigned to the agent. */
+  assignedTask: string;
+  /** The message history for the run */
+  messages: ChatHistory;
+  /** Previous steps */
+  priorSteps: PriorStep[];
+  /** Shared state available to the agent. */
+  sharedState: SharedState<TState>;
+}
+
+/** @internal */
+export const NavigationAgent: AgentRegistration;
+
+/** @internal */
+export type NavigationContext = {
+  mapView: MapView;
+};
+
+/** @internal */
+export const LayerStylingAgent: AgentRegistration;
+
+/** @internal */
+export type LayerStylingContext = {
+  mapView: MapView;
+};
+
+/** @internal */
+export const DataExplorationAgent: AgentRegistration;
+
+/** @internal */
+export type DataExplorationContext = {
+  mapView: MapView;
+};
+
+/** @internal */
+export const HelpAgent: AgentRegistration;
+
+/** @internal */
+export const ArcgisKnowledgeAgent: AgentRegistration;
+
+/** @internal */
+export type ArcgisKnowledgeContext = {
+    knowledgeGraph: KnowledgeGraph;
+    view?: never;
+} | {
+    view: LinkChartView | MapView;
+    knowledgeGraph?: never;
+};
+
+/** @internal */
+export const createWebmapEmbeddings: (mapView: MapView) => Promise<{
+    schemaVersion: "0.1";
+    modified: number;
+    embeddings: {
+        modelProvider: "openai";
+        model: string;
+        dimensions: 1536;
+        templates: {
+            layer: string;
+            field: string;
+        };
+    };
+    layers: Array<{
+        id: string;
+        name: string;
+        title: string;
+        description: string;
+        vector: Array<number>;
+        fields: Array<{
+            name: string;
+            alias: string;
+            description: string;
+            vector: Array<number>;
+        }>;
+    }>;
+}>;
+
+/** @internal */
+export type GetContext<TContext extends Record<string, unknown>> = () => Promise<TContext> | TContext;
+
+/** @internal */
+export interface AgentWithContext<TContext extends Record<string, unknown> = Record<string, unknown>> {
+  agent: AgentRegistration;
+  /**
+   * Lazily resolves runtime context.
+   * Can be sync or async, and may perform lifecycle checks (e.g. await view.when()).
+   */
+  getContext?: GetContext<TContext>;
+}
+
+/** @internal */
+export type AgentExecutionContextWithSharedState<TState extends Record<string, unknown> = Record<string, unknown>> = AgentExecutionContext<TState>;
+
+/** @internal */
+export type StatelessAgentBaseState<TState extends Record<string, unknown> = Record<string, unknown>> = {
+  agentExecutionContext: BaseChannel<AgentExecutionContextWithSharedState<TState>, unknown, unknown>;
+  outputMessage: BaseChannel<string, unknown, unknown>;
+  summary: BaseChannel<string, unknown, unknown>;
+  status: BaseChannel<AgentStatus | undefined, unknown, unknown>;
+};
+
+/** @internal */
+export type StatefulAgentBaseState<TState extends Record<string, unknown> = Record<string, unknown>> = StatelessAgentBaseState<TState>
+  & {
+  sharedStatePatch: BaseChannel<SharedStatePatch<TState> | undefined, unknown, unknown>;
+};
+
+/**
+ * Creates the standard runtime state for a custom agent graph.
+ * Includes common fields used by the assistant flow (request context, output message, summary, and status), so you only add your agent-specific state.
+ *
+ * @since 5.1
+ */
+export function createAgentRuntimeState<TState extends Record<string, unknown> = Record<string, unknown>>(): StatelessAgentBaseState<TState>;
+
+/**
+ * Creates the standard runtime state for a custom agent graph, plus support for shared state updates.
+ * Use this when your agent needs to write values that other agents can read later in the same orchestration flow.
+ *
+ * @since 5.1
+ */
+export function createAgentRuntimeStateWithSharedState<TState extends Record<string, unknown> = Record<string, unknown>>(): StatefulAgentBaseState<TState>;
+
+/**
+ * Sends an optional UX suggestion from an agent run to the host application.
+ * Use this for non-blocking hints (for example, recommended next actions or UI prompts) that the app may choose to display.
+ *
+ * @param suggestion
+ * @param config
+ * @since 5.1
+ */
+export function sendUXSuggestion(suggestion: UXSuggestion, config?: RunnableConfig): Promise<void>;
+
+/** @internal */
+export type SharedStateEntry<T = unknown> = {
+  value: T;
+  meta: {
+      updatedByAgentId: string;
+      updatedAt: number;
+  };
+};
+
+/** @internal */
+export type SharedStatePatchEntry<T = unknown> = {
+  value: T;
+};
+
+/**
+ * Shared state that can be read and updated during agent execution.
+ *
+ * @since 5.1
+ */
+export type SharedState<T extends Record<string, unknown> = Record<string, unknown>> = {
+    [K in keyof T]?: SharedStateEntry<T[K]>;
+};
+
+/**
+ * Partial shared state returned by an agent for merging into the current run state.
+ *
+ * @since 5.1
+ */
+export type SharedStatePatch<T extends Record<string, unknown> = Record<string, unknown>> = {
+    [K in keyof T]?: SharedStatePatchEntry<T[K]>;
+};
+
+/**
+ * @param parameter0
+ * @internal
+ */
+export function createChatModel(parameter0?: {
+    modelTier?: ChatModelTier;
+    temperature?: number;
+    config?: RunnableConfig;
+}): Promise<ChatOpenAI>;

package/dist/utils/index.js

@@ -1,13 +1,116 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import { cosineSimilarity as o, getEmbeddings as e, invokeStructuredPrompt as t, invokeTextPrompt as i, invokeToolPrompt as s, sendTraceMessage as r } from "@arcgis/ai-orchestrator";
-import "@langchain/langgraph/web";
-import "zod";
-const c = i, p = t, d = s, g = r, k = e, v = o;
+import { g as p } from "../chunks/orchestrator.js";
+import { O as ue } from "../chunks/orchestrator.js";
+import { s as h, a as A } from "../chunks/index.js";
+import { g as S, a as v, W as w, f, l as y, d as $, m as b, b as E, s as L, i as P, e as M, h as T, j as R, k, c as x } from "../chunks/generateLayerDescriptions.js";
+import D from "@arcgis/core/layers/FeatureLayer.js";
+import * as W from "@arcgis/core/core/reactiveUtils.js";
+import { N as F } from "../chunks/navigationGraph.js";
+import { L as C } from "../chunks/layerStylingGraph.js";
+import { D as N } from "../chunks/dataExplorationGraph.js";
+import { H as z } from "../chunks/helpGraph.js";
+import { A as H } from "../chunks/arcgisKnowledgeGraph.js";
+const I = async (e) => {
+  const t = e.allLayers.toArray(), s = [], o = /* @__PURE__ */ new Map();
+  for (const a of t)
+    if (a instanceof D) {
+      const m = (async () => {
+        const r = await S(a), n = await v(a, r);
+        o.set(a.id, { layerItem: n, fieldRegistry: r });
+      })();
+      s.push(m);
+    }
+  return await Promise.all(s), o;
+}, O = async (e) => {
+  await W.whenOnce(() => e.ready);
+  const t = await I(e.map), { layers: s } = await U(t), o = {
+    schemaVersion: L,
+    modified: Date.now(),
+    embeddings: {
+      modelProvider: E,
+      model: b,
+      dimensions: $,
+      templates: {
+        layer: y,
+        field: f
+      }
+    },
+    layers: s
+  }, a = w.safeParse(o);
+  if (!a.success)
+    throw console.error("Schema Mismatch:", a.error.format()), new Error("Webmap embedding generation failed validation.");
+  return a.data;
+}, U = async (e) => {
+  const t = [], s = [];
+  for (const [r, { fieldRegistry: n, layerItem: i }] of e.entries()) {
+    const l = g(y, {
+      name: i.name,
+      title: i.title,
+      description: i.description
+    });
+    t.push(l);
+    const d = {
+      id: r,
+      name: i.name ?? "",
+      title: i.title,
+      description: i.description,
+      vector: [],
+      fields: []
+    };
+    for (const [, c] of n.entries()) {
+      const u = g(f, {
+        name: c.name,
+        alias: c.alias,
+        description: c.description
+      });
+      t.push(u), d.fields.push({
+        name: c.name,
+        alias: c.alias,
+        description: c.description,
+        vector: []
+      });
+    }
+    s.push(d);
+  }
+  const o = await p(t);
+  let a = 0;
+  return { layers: s.map((r) => (r.vector = o[a++], r.fields.forEach((n) => {
+    n.vector = o[a++];
+  }), r)) };
+}, g = (e, t) => e.replace(/\{(\w+)\}/gu, (s, o) => t[o] ?? ""), V = (e, t) => {
+  if (e.length !== t.length)
+    throw new Error("Vectors must be the same length");
+  let s = 0, o = 0, a = 0;
+  for (let n = 0; n < e.length; ++n) {
+    const i = e[n], l = t[n];
+    s += i * l, o += i * i, a += l * l;
+  }
+  const m = Math.sqrt(o * a);
+  if (m === 0)
+    return 0;
+  const r = s / m;
+  return Math.max(-1, Math.min(1, r));
+}, Y = M, Z = P, ee = T, te = h, ae = p, se = V, oe = F, re = C, ne = N, ie = z, ce = H, me = O, le = () => R(), de = () => k(), ge = async (e, t) => await A(e, t), pe = async ({
+  modelTier: e = "default",
+  temperature: t = 0,
+  config: s
+} = {}) => await x({ modelTier: e, temperature: t, config: s });
 export {
-  v as cosineSimilarity,
-  k as getEmbeddings,
-  p as invokeStructuredPrompt,
-  c as invokeTextPrompt,
-  d as invokeToolPrompt,
-  g as sendTraceMessage
+  ce as ArcgisKnowledgeAgent,
+  ne as DataExplorationAgent,
+  ie as HelpAgent,
+  re as LayerStylingAgent,
+  oe as NavigationAgent,
+  ue as Orchestrator,
+  se as cosineSimilarity,
+  le as createAgentRuntimeState,
+  de as createAgentRuntimeStateWithSharedState,
+  pe as createChatModel,
+  me as createWebmapEmbeddings,
+  ae as getEmbeddings,
+  Z as invokeStructuredPrompt,
+  Y as invokeTextPrompt,
+  ee as invokeToolPrompt,
+  te as sendTraceMessage,
+  ge as sendUXSuggestion
 };

package/package.json

@@ -1,14 +1,30 @@
 {
   "name": "@arcgis/ai-components",
-  "version": "5.1.0-next.99",
+  "version": "5.1.1",
   "description": "ArcGIS AI Components",
   "type": "module",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": "./dist/index.js",
     "./loader": "./dist/loader.js",
+    "./agent-utils/index.js": "./dist/agent-utils/index.js",
+    "./agent-utils/BaseAgent.js": "./dist/agent-utils/BaseAgent.js",
+    "./agent-utils/FunctionAgent.js": "./dist/agent-utils/FunctionAgent.js",
+    "./agent-utils/LLMAgent.js": "./dist/agent-utils/LLMAgent.js",
+    "./agent-utils/WorkflowAgent.js": "./dist/agent-utils/WorkflowAgent.js",
+    "./agent-utils/tools/FunctionTool.js": "./dist/agent-utils/tools/FunctionTool.js",
+    "./agent-utils/workflows/ConditionalWorkflow.js": "./dist/agent-utils/workflows/ConditionalWorkflow.js",
+    "./agent-utils/workflows/LoopWorkflow.js": "./dist/agent-utils/workflows/LoopWorkflow.js",
+    "./agent-utils/workflows/ParallelWorkflow.js": "./dist/agent-utils/workflows/ParallelWorkflow.js",
+    "./agent-utils/workflows/RouterWorkflow.js": "./dist/agent-utils/workflows/RouterWorkflow.js",
+    "./agent-utils/workflows/SequentialWorkflow.js": "./dist/agent-utils/workflows/SequentialWorkflow.js",
+    "./agent-utils/workflows/SwitchWorkflow.js": "./dist/agent-utils/workflows/SwitchWorkflow.js",
+    "./agent-utils/middlewares/middleware.js": "./dist/agent-utils/middlewares/middleware.js",
+    "./agent-utils/middlewares/humanInTheLoop.js": "./dist/agent-utils/middlewares/humanInTheLoop.js",
+    "./agent-utils/middlewares/trace.js": "./dist/agent-utils/middlewares/trace.js",
+    "./agent-utils/middlewares/types.js": "./dist/agent-utils/middlewares/types.js",
     "./utils/index.js": "./dist/utils/index.js",
     "./package.json": "./package.json",
     "./components/*/customElement": "./dist/components/*/customElement.js",
@@ -26,19 +42,19 @@
     "@esri/arcgis-html-sanitizer": "~4.1.0",
     "@langchain/core": "^1.1.39",
     "@langchain/langgraph": "^1.2.6",
+    "@langchain/openai": "^1.4.3",
+    "langchain": "^1.3.1",
     "lit": "^3.3.0",
-    "marked": "~18.0.3",
+    "marked": "~18.0.5",
     "tslib": "^2.8.1",
     "zod": "^4.3.6",
-    "@arcgis/ai-agents": "5.1.0-next.99",
-    "@arcgis/toolkit": "5.1.0-next.99",
-    "@arcgis/lumina": "5.1.0-next.99",
-    "@arcgis/ai-orchestrator": "5.1.0-next.99"
+    "@arcgis/lumina": "5.1.1",
+    "@arcgis/toolkit": "5.1.1"
   },
   "peerDependencies": {
-    "@arcgis/core": "^5.1.0-next",
-    "@esri/calcite-components": "^5.1.0-next.45",
-    "@arcgis/map-components": "~5.1.0-next.99"
+    "@arcgis/core": "^5.1.0",
+    "@esri/calcite-components": "^5.1.1",
+    "@arcgis/map-components": "~5.1.1"
   },
   "css.customData": [
     "dist/docs/vscode.css-custom-data.json"

package/dist/cdn/2YEKZADB.js

@@ -1,2 +0,0 @@
-/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import{g as e,h as t,t as a,u as i,v as o,y as l}from"./DSEMD4M2.js";import"./CFDTXKJ6.js";export default $arcgis.t(([r,{watch:n}])=>{var c=e`.messages-container{display:flex;flex:1;flex-direction:column}.messages-list{padding:var(--calcite-spacing-lg);display:flex;flex-direction:column;gap:var(--calcite-spacing-xxl);flex:1 1 auto;min-height:0;justify-content:flex-end;overflow:auto}`,s=class extends o{constructor(){super(...arguments),this.#s=a(),this.loading=!1,this.messages=new r([])}static{this.properties={loading:5,messages:0}}static{this.styles=c}#s;firstUpdated(){this._scrollToEnd()}loaded(){this.manager.onLifecycle(()=>[this.messages.on("change",()=>{this.requestUpdate(),this._scrollToEnd()}),n(()=>this.loading,()=>{this._scrollToEnd()})])}_scrollToEnd(){requestAnimationFrame(()=>{this.#s.value?.scrollIntoView({behavior:"smooth"})})}render(){return t`<div class="messages-container"><div class="messages-list"><slot name=message-starter></slot><slot name=messages></slot><slot name=message-loading></slot></div><div ${i(this.#s)}></div></div>`}};l("arcgis-assistant-chat",s);return s},"core/Collection","core/reactiveUtils")

package/dist/cdn/457RLS3H.js

@@ -1,2 +0,0 @@
-/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import{A as z,Ab as _,B as A,Bb as $,C as B,Cb as aa,Fb as ba,Gb as ca,Hb as da,Ib as ea,Jb as fa,Kb as ga,Lb as ha,Mb as ia,Nb as ja,Ob as ka,Pb as la,a,b,bb as C,c,cb as D,d,db as E,e,eb as F,f,fb as G,gb as H,h as g,hb as I,i as h,ib as J,j as i,jb as K,k as j,kb as L,l as k,lb as M,m as l,mb as N,n as m,nb as O,o as n,ob as P,p as o,pb as Q,q as p,r as q,rb as R,s as r,sb as S,t as s,tb as T,u as t,ub as U,v as u,vb as V,w as v,wb as W,x as w,xb as X,y as x,yb as Y,z as y,zb as Z}from"./YW52XJMM.js";import"./CFDTXKJ6.js";export{L as Annotation,H as AsyncBatchedStore,J as BaseChannel,E as BaseCheckpointSaver,k as BaseLangGraphError,G as BaseStore,K as BinaryOperatorAggregate,d as COMMAND_SYMBOL,i as Command,e as CommandInstance,ca as CompiledStateGraph,b as END,v as EmptyChannelError,u as EmptyInputError,R as Graph,l as GraphBubbleUp,o as GraphInterrupt,m as GraphRecursionError,n as GraphValueError,c as INTERRUPT,I as InMemoryStore,w as InvalidUpdateError,F as MemorySaver,da as MessageGraph,ia as MessagesAnnotation,aa as MessagesValue,ja as MessagesZodMeta,ka as MessagesZodState,x as MultipleSubgraphsError,p as NodeInterrupt,g as Overwrite,q as ParentCommand,_ as REMOVE_ALL_MESSAGES,X as ReducedValue,z as RemoteException,a as START,f as Send,ba as StateGraph,A as StateGraphInputError,Z as StateSchema,y as UnreachableNodeError,Y as UntrackedValue,W as UntrackedValueChannel,$ as addMessages,D as copyCheckpoint,C as emptyCheckpoint,ga as entrypoint,O as getConfig,P as getCurrentTaskInput,U as getJsonSchemaFromSchema,ha as getPreviousState,V as getSchemaDefaultGetter,M as getStore,B as getSubgraphsSeenSet,N as getWriter,Q as interrupt,j as isCommand,s as isGraphBubbleUp,t as isGraphInterrupt,h as isInterrupted,r as isParentCommand,T as isSerializableSchema,S as isStandardSchema,$ as messagesStateReducer,ea as pushMessage,fa as task,la as writer};

package/dist/cdn/4QVKWA2Z.js

@@ -1,24 +0,0 @@
-/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import"./CFDTXKJ6.js";var e=`# ArcgisKnowledge Tool Instructions
-
-You are an assistant that helps users answer questions and perform operations on their knowledge graph or link chart. You have been assigned the task below, which must be achieved by calling a single tool.
-
-## Task Details:
-
-Assigned task:
-{assignedTask}
-
-User Request:
-{userRequest}
-
-Prior steps:
-{priorSteps}
-
-## Your Goal:
-
-Call exactly one arcgisKnowledge tool, with the appropriate arguments given the assigned task. Use the provided user request or prior steps only if needed for context based on the assigned task.
-
-If no tools apply, return an **empty string**
-
-CRITICAL: You are FORBIDDEN from making multiple tool calls. You MUST make exactly ONE tool call.
-`;export{e as default};