@arcgis/coding-components 5.2.0-next.1 → 5.2.0-next.11

package/dist/chunks/sql-expr-defaults.js

@@ -1,50 +1,54 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import { i as c, b as h } from "./utils.js";
-import { CompletionItemKind as m, InsertTextFormat as g, InsertTextMode as b } from "vscode-languageserver-types";
-import { f as x, L as F, E } from "./language-defaults-base.js";
-import { fetchT9nStringsBundle as M } from "@arcgis/toolkit/intl";
-import { g as w } from "./runtime.js";
-const v = {
+import { i as c, b as P } from "./utils.js";
+import { CompletionItemKind as h, InsertTextFormat as g, InsertTextMode as F } from "vscode-languageserver-types";
+import { f as b, L as w, E as x } from "./language-defaults-base.js";
+import { fetchT9nStringsBundle as E } from "@arcgis/toolkit/intl";
+import { g as M } from "./runtime.js";
+const A = {
   allowAllRootBinaryOperators: !1,
   requiresPredicateRootNode: !1
 }, d = {
-  "field-calculation": v,
+  "field-calculation": A,
   "where-clause": {
     allowAllRootBinaryOperators: !0,
-    requiresPredicateRootNode: !0
+    requiresPredicateRootNode: !0,
+    allowGeometryFields: !0
   }
 };
-function A(o) {
+function v(o) {
   return o && o in d ? d[o] : void 0;
 }
 const q = (o) => {
-  const i = o.variables[0], e = i?.type === "featureSet" ? T(i) : void 0, { apiVersion: t, bundles: r, hiddenApiItems: s } = o.toEditorProfileDefinition();
+  const r = o.variables[0], t = r?.type === "featureSet" ? T(r) : void 0, { apiVersion: e, bundles: i, hiddenApiItems: s } = o.toEditorProfileDefinition();
   return {
-    apiVersion: t,
-    bundles: r,
-    variables: e ? [e] : [],
+    apiVersion: e,
+    bundles: i,
+    variables: t ? [t] : [],
     hiddenApiItems: s?.map((a) => a.toLowerCase())
   };
 };
 function T(o) {
-  const { name: i } = o, e = o.getDescription(), { definition: t } = o.toProfileVariableDefinition(), r = {
-    label: i,
-    detail: i,
-    insertText: i,
-    insertTextMode: b.asIs,
+  const { name: r } = o, t = o.getDescription(), { definition: e } = o.toProfileVariableDefinition(), i = {
+    label: r,
+    detail: r,
+    insertText: r,
+    insertTextMode: F.asIs,
     insertTextFormat: g.PlainText,
-    kind: m.Field
+    kind: h.Field
   }, s = {
-    name: i,
-    description: e,
+    name: r,
+    description: t,
     type: "dictionary",
     properties: [],
-    completion: r
+    completion: i
   };
-  if (!t || !("fields" in t))
+  if (!e || !("fields" in e))
     return s;
-  const [a, l] = x(t.fields, e);
-  return s.properties = a, r.documentation = { kind: "markdown", value: l }, s;
+  const [a, l] = b(e.fields, t, {
+    includeAliases: !1,
+    supportGeometryFields: !0
+  });
+  return s.properties = a, i.documentation = { kind: "markdown", value: l }, s;
 }
 const u = [
   {
@@ -68,27 +72,27 @@ function L(o) {
 function S(o) {
   if (!c(o))
     return;
-  const i = L(
+  const r = L(
     o.id
     /*locale*/
   );
-  if (!i)
+  if (!r)
     return;
-  const e = {
+  const t = {
     variables: [],
-    hiddenApiItems: o.hiddenApiItems?.map((t) => t.toLowerCase())
+    hiddenApiItems: o.hiddenApiItems?.map((e) => e.toLowerCase())
   };
-  return i.variables.forEach((t) => {
-    if (o.disabledVariables?.includes(t.name))
+  return r.variables.forEach((e) => {
+    if (o.disabledVariables?.includes(e.name))
       return;
-    const r = o.definitions[t.name];
-    if (t.type === "featureSet")
-      return h(r) ? e.variables.push({ ...t, type: t.type, definition: r }) : void 0;
-    throw Error(`sdkVariable type not supported (yet) type: ${t.type}`);
-  }), e;
+    const i = o.definitions[e.name];
+    if (e.type === "featureSet")
+      return P(i) ? t.variables.push({ ...e, type: e.type, definition: i }) : void 0;
+    throw Error(`sdkVariable type not supported (yet) type: ${e.type}`);
+  }), t;
 }
 const f = "arcgis-sql-expression";
-class _ extends F {
+class _ extends w {
   constructor() {
     super(f, {
       apiPath: "./assets/sql-language/api",
@@ -96,42 +100,42 @@ class _ extends F {
     }), this._languageId = f, this._layerMap = /* @__PURE__ */ new Map();
   }
   // TODO: try to rely on editor profile instance instead of storing a feature layer
-  updateFeatureLayerForModel(i, e) {
-    const t = this._getApiKey(i);
-    this._layerMap.set(t, e);
+  updateFeatureLayerForModel(r, t) {
+    const e = this._getApiKey(r);
+    this._layerMap.set(e, t);
   }
-  getFeatureLayerForModel(i) {
-    const e = this._getApiKey(i);
-    return this._layerMap.get(e);
+  getFeatureLayerForModel(r) {
+    const t = this._getApiKey(r);
+    return this._layerMap.get(t);
   }
-  async setProfileForModel(i, e, t = { locale: "en" }) {
-    const r = c(e) ? A(e.id) : void 0;
-    c(e) && (e = S(e));
-    const s = await M(
-      t.locale,
-      w("./assets/editor-profile/t9n"),
+  async setProfileForModel(r, t, e = { locale: "en" }) {
+    const i = c(t) ? v(t.id) : void 0;
+    c(t) && (t = S(t));
+    const s = await E(
+      e.locale,
+      M("./assets/editor-profile/t9n"),
       "messages."
     );
     if (!s)
-      throw new Error(`Failed to load the language bundle for ${t.locale}`);
-    this.disposeForModel(i);
-    const a = this._getApiKey(i), l = new E(e, s);
+      throw new Error(`Failed to load the language bundle for ${e.locale}`);
+    this.disposeForModel(r);
+    const a = this._getApiKey(r), l = new x(t, s, e.locale, i);
     this._modelToProfileMap.set(a, l);
     const y = q(l);
-    this.updateApiContextForModel(i, {
-      locale: t.locale,
+    this.updateApiContextForModel(r, {
+      locale: e.locale,
       profile: y,
-      ...r ? { profilePolicy: r } : {}
+      ...i ? { profilePolicy: i } : {}
     });
-    const p = e?.variables?.find((P) => P.name === "$layer");
-    p && this.updateFeatureLayerForModel(i, p.definition);
+    const p = t?.variables?.find((m) => m.name === "$layer");
+    p && this.updateFeatureLayerForModel(r, p.definition);
   }
 }
-const n = new _(), R = {
+const n = new _(), $ = {
   setProfileForModel: n.setProfileForModel.bind(n),
   getApiLibraryForModel: n.getApiLibraryForModel.bind(n)
 };
 export {
   n as a,
-  R as s
+  $ as s
 };

package/dist/components/arcgis-arcade-debugger-console/customElement.js

@@ -7,8 +7,8 @@ import { u as x } from "../../chunks/useT9n.js";
 import { load as S } from "@arcgis/lumina/controllers";
 import { i as $ } from "../../chunks/monaco-importer.js";
 import { t as l } from "../../chunks/functional.js";
-import { d as k, g as y, c as m } from "../../chunks/debugger-value-styles.js";
-import { i as h, a as P, p as T, b as E, c as L, d as C, S as M, D as B, e as V } from "../../chunks/debugger-value-components.js";
+import { d as k, g as y, c as h } from "../../chunks/debugger-value-styles.js";
+import { i as m, a as P, p as T, b as E, c as L, d as C, S as M, D as B, e as V } from "../../chunks/debugger-value-components.js";
 import { observeAncestorsMutation as z, unsafeGetCalciteModeName as I } from "@arcgis/toolkit/dom";
 import { generateGuid as A } from "@arcgis/toolkit/string";
 import { d as p } from "../../chunks/ArcadeDebuggerPreviewTabsState.js";
@@ -49,7 +49,7 @@ class N extends f {
     return t ? t.getLineContent(e) : "";
   }
   updateTheme() {
-    I(this.el) === "dark" ? this.elementInternals.states.add(m) : this.elementInternals.states.delete(m);
+    I(this.el) === "dark" ? this.elementInternals.states.add(h) : this.elementInternals.states.delete(h);
   }
   getBreakpointCode(e) {
     return e == null ? this.messages.nocontent ?? "No content" : this.getContentAtLine(e) || (this.messages.nocontent ?? "No content");
@@ -71,7 +71,7 @@ class N extends f {
     }
   }
   getExpandedDebuggerMap(e) {
-    if (e == null || !h(e))
+    if (e == null || !m(e))
       return null;
     const t = e.expand();
     return Array.isArray(t) ? null : t;
@@ -83,7 +83,7 @@ class N extends f {
     });
   }
   getExpandedDebuggerChild(e, t) {
-    if (!e || !h(e))
+    if (!e || !m(e))
       return;
     const a = e.expand();
     if (Array.isArray(a)) {
@@ -207,8 +207,8 @@ class N extends f {
     return r`<calcite-tabs><calcite-tab-nav slot=title-group><calcite-tab-title .tab=${p} .selected=${e === p} @calciteTabsActivate=${(t) => this.activateTab(t.target.tab)}>${this.messages.scope ?? "Scope"}</calcite-tab-title>${g(this.previewTabsState.tabs, (t) => `title-${t.id}`, (t) => r`<calcite-tab-title .tab=${t.id} title=${t.label ?? b} closable .selected=${e === t.id} @calciteTabsActivate=${(a) => this.activateTab(a.target.tab)} @calciteTabsClose=${(a) => this.closePreviewTab(a.target)}><bdi>${t.title}</bdi></calcite-tab-title>`)}</calcite-tab-nav><calcite-tab .tab=${p} .selected=${e === p}><div class="tab-panel">${this.renderScopePanel()}</div></calcite-tab>${g(this.previewTabsState.tabs, (t) => `panel-${t.id}`, (t) => r`<calcite-tab .tab=${t.id} .selected=${e === t.id}><div class="tab-panel preview-panel">${this.renderPreviewPanel(t)}</div></calcite-tab>`)}</calcite-tabs>`;
   }
   render() {
-    const { line: e } = this.debuggerStore?.executionState ?? {}, t = this.breakpoints.find((i) => i.line === e), a = this.breakpoints.findIndex((i) => i.line === e);
-    return r`<div class="console-shell"><div class="breakpoint-header"><arcgis-code-viewer language=arcade class="breakpoint-code-viewer" .lineNumbers=${(i) => String(i + (t?.line ?? e ?? 1) - 1)}>${this.getBreakpointCode(t?.line ?? this.breakpoints[0]?.line ?? e ?? 1)}</arcgis-code-viewer>${this.breakpoints.length ? r`<calcite-action id=${this._breakpointPopoverId ?? b} scale=s .text=${this.getBreakpointPositionText(a >= 0 ? a + 1 : 1)} text-enabled icon=chevron-down></calcite-action>` : null}${this.renderBreakpointPopover(t?.line ?? e)}</div><div class="tabs-container">${this.renderTabs()}</div></div>`;
+    const { line: e } = this.debuggerStore?.executionState ?? {}, t = e ? this.breakpoints.find((i) => i.line === e) : this.breakpoints[0], a = e ? this.breakpoints.findIndex((i) => i.line === e) : 0;
+    return r`<div class="console-shell">${this.breakpoints.length && r`<div class="breakpoint-header"><arcgis-code-viewer language=arcade class="breakpoint-code-viewer" .lineNumbers=${(i) => String(i + (t?.line ?? e ?? 1) - 1)}>${this.getBreakpointCode(t?.line ?? this.breakpoints[0]?.line ?? e ?? 1)}</arcgis-code-viewer>${this.breakpoints.length ? r`<calcite-action id=${this._breakpointPopoverId ?? b} scale=s .text=${this.getBreakpointPositionText(a >= 0 ? a + 1 : 1)} text-enabled icon=chevron-down></calcite-action>` : null}${this.renderBreakpointPopover(t?.line ?? e)}</div>` || ""}<div class="tabs-container">${this.renderTabs()}</div></div>`;
   }
 }
 v("arcgis-arcade-debugger-console", N);

package/dist/components/arcgis-arcade-debugger-output/customElement.js

@@ -1,25 +1,28 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import { c as r } from "../../chunks/runtime.js";
-import { css as l, html as s } from "lit";
-import { LitElement as i } from "@arcgis/lumina";
-import { u as o } from "../../chunks/useT9n.js";
-import { d as c, g as n, c as a, t } from "../../chunks/debugger-value-styles.js";
-import { observeAncestorsMutation as u, unsafeGetCalciteModeName as d } from "@arcgis/toolkit/dom";
-import { D as m } from "../../chunks/debugger-value-components.js";
-const p = l`:host{display:flex;flex-direction:column;width:100%;background-color:var(--calcite-color-foreground-1);color:var(--calcite-color-text-2);--calcite-block-padding: var(--calcite-spacing-sm);overflow:auto;calcite-flow{height:100%}.disabled-state-text{font-size:var(--calcite-font-size-sm);color:var(--calcite-color-text-3);font-style:italic;display:block;margin:var(--calcite-spacing-md)}.ltr-container{direction:ltr}[class*=result-value-]{line-height:1.25rem}}`;
-class h extends i {
+import { c as i } from "../../chunks/runtime.js";
+import { css as l, html as a } from "lit";
+import { LitElement as o } from "@arcgis/lumina";
+import { u as c } from "../../chunks/useT9n.js";
+import { d as u, g as n, c as r, t as s } from "../../chunks/debugger-value-styles.js";
+import { observeAncestorsMutation as d, unsafeGetCalciteModeName as g } from "@arcgis/toolkit/dom";
+import { D as m, i as p, f as h, a as b, b as f } from "../../chunks/debugger-value-components.js";
+const T = l`:host{display:flex;flex-direction:column;width:100%;background-color:var(--calcite-color-foreground-1);color:var(--calcite-color-text-2);--calcite-block-padding: var(--calcite-spacing-sm);overflow:auto;calcite-flow{height:100%}.disabled-state-text{font-size:var(--calcite-font-size-sm);color:var(--calcite-color-text-3);font-style:italic;display:block;margin:var(--calcite-spacing-md)}[class*=result-value-]{line-height:1.25rem}}`;
+function v(t, e) {
+  return p(t) || h(t) || b(t) || f(t) ? e ?? "Output" : t.arcadeType;
+}
+class y extends o {
   constructor() {
-    super(...arguments), this.messages = o();
+    super(...arguments), this.messages = c();
   }
   static {
-    this.properties = { debuggerStore: 0, result: 0 };
+    this.properties = { debuggerStore: 0, result: 0, outputTitle: 1 };
   }
   static {
-    this.styles = [p, c, n()];
+    this.styles = [T, u, n()];
   }
   load() {
     this.manager.onLifecycle(() => {
-      const e = u(this.el, ["class"], this.updateTheme.bind(this));
+      const e = d(this.el, ["class"], this.updateTheme.bind(this));
       return this.updateTheme(), () => e();
     });
   }
@@ -27,16 +30,16 @@ class h extends i {
     e.has("result") && this.result && this.debuggerStore?.lazyTreeState.reset();
   }
   updateTheme() {
-    d(this.el) === "dark" ? this.elementInternals.states.add(a) : this.elementInternals.states.delete(a);
+    g(this.el) === "dark" ? this.elementInternals.states.add(r) : this.elementInternals.states.delete(r);
   }
   render() {
     if (!this.result)
-      return s`<span class="disabled-state-text">${this.messages.nooutput ?? "No output available."}</span>`;
+      return a`<span class="disabled-state-text">${this.messages.nooutput ?? "No output available."}</span>`;
     const e = this.debuggerStore?.lazyTreeState;
-    return e ? s`<calcite-tree .scale=${t.scale} @calciteTreeSelect=${t.oncalciteTreeSelect} .lines=${t.lines} .selectionMode=${t.selectionMode}>${m({ expanded: !0, name: this.result.arcadeType, value: this.result, messages: this.messages, path: this.result.arcadeType, lazyTreeState: e })}</calcite-tree>` : s`<span class="disabled-state-text">${this.messages.nooutput ?? "No output available."}</span>`;
+    return e ? a`<calcite-tree .scale=${s.scale} @calciteTreeSelect=${s.oncalciteTreeSelect} .lines=${s.lines} .selectionMode=${s.selectionMode}>${m({ expanded: !0, name: v(this.result, this.outputTitle), value: this.result, messages: this.messages, path: this.result.arcadeType, lazyTreeState: e })}</calcite-tree>` : a`<span class="disabled-state-text">${this.messages.nooutput ?? "No output available."}</span>`;
   }
 }
-r("arcgis-arcade-debugger-output", h);
+i("arcgis-arcade-debugger-output", y);
 export {
-  h as ArcgisArcadeDebuggerOutput
+  y as ArcgisArcadeDebuggerOutput
 };

package/dist/components/arcgis-arcade-editor/customElement.d.ts

@@ -26,8 +26,19 @@ import type { T9nMeta } from "@arcgis/lumina/controllers";
  * - [Suggestions and code completion](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/discover-the-arcade-editors-powerful-new-features/#suggestions-and-code-completion)
  * - [WCAG 2.0 compliant code colorization / syntax highlighting](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/accessibility-and-arcade-working-in-color/)
  * - Built-in [keyboard shortcuts](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/discover-the-arcade-editors-powerful-new-features/#keyboard-shortcuts)
- * - In-editor help for finding information about profile variables relevant to your profile, documentation for constants and functions, a link to the official Arcade documentation, and, in some case, suggestions.
+ * - In-editor help for finding information about profile variables relevant to your profile, documentation for constants and functions, a link to the official Arcade documentation, and, in some case, suggestions
  * - Support for many [languages and directionality](https://developers.arcgis.com/javascript/latest/localization/)
+ * - A debugger with support for breakpoints, stepping, and an interactive console
+ * - An [AI Assistant](https://doc.arcgis.com/en/arcgis-online/create-maps/understand-arcade-assistant.htm) that uses natural language
+ * processing to generate Arcade expressions from scratch or find and fix errors in your code
+ *
+ * The Arcade editor and some of the underlying core Arcade language functions depend on esriConfig properties. To ensure the best experience for your users,
+ * make sure to set the following:
+ * - [esriConfig.applicationName](https://developers.arcgis.com/javascript/latest/references/core/config/#Config-applicationName)
+ *   - Used by the [GetEnvironment()](https://developers.arcgis.com/arcade/function-reference/debugging_functions/#getenvironment) Arcade function
+ *   - Associates feedback to the Arcade assistant with a specific application
+ * - [esriConfig.portalUrl](https://developers.arcgis.com/javascript/latest/references/core/config/#Config-portalUrl)
+ *   - Required for the Arcade assistant to function, as the assistant relies on ArcGIS Online services
  */
 export abstract class ArcgisArcadeEditor extends LitElement {
   /**
@@ -45,9 +56,30 @@ export abstract class ArcgisArcadeEditor extends LitElement {
    */
   accessor customPanels: ICustomPanel[] | undefined;
   /**
-   * Disables the Arcade Assistant when set to true.
+   * When set to `true`, hides the Arcade assistant (beta) panel and disables all related features.
+   * The Arcade assistant (beta) panel includes a question/answer UX that allows
+   * users to ask the assistant to generate Arcade expressions from natural language prompts, or to find and fix errors in their code.
+   *
+   * The Arcade assistant (beta) will only be available if the following conditions are met:
+   * - The `disableAssistant` property is `false`
+   * - The [esriConfig.portalUrl](https://developers.arcgis.com/javascript/latest/references/core/config/#Config-portalUrl) is set to an ArcGIS Online portal (either the default or a custom one)
+   * - The user is signed in to the portal. The application exposing the editor must handle user authentication.
+   * - The signed in user has permissions to use AI features in ArcGIS Online, including the following conditions:
+   *   - The user's organization allows use of AI assistants,
+   *   - The user's role has the "Use AI assistants" privilege enabled, and
+   *   - Beta features are enabled for the user's organization
+   *
+   * The assistant also provides the ability for users to submit feedback on generated responses, which may be used to improve the assistant's performance over time.
+   * When feedback is logged, it is associated with the application exposing the Arcade editor. It is best practice to set
+   * [esriConfig.applicationName](https://developers.arcgis.com/javascript/latest/references/core/config/#Config-applicationName) so the feedback can be associated with a specific application.
+   *
+   * More information about the Arcade assistant, including best practices, the context provided to the underlying model, limitations,
+   * and transparency cards can be found in the links below.
    *
    * @default false
+   * @since 5.1
+   * @see [Arcade assistant user documentation](https://doc.arcgis.com/en/arcgis-online/create-maps/understand-arcade-assistant.htm)
+   * @see [Arcade assistant best practices and limitations](https://doc.arcgis.com/en/arcgis-online/create-maps/use-arcade-assistant.htm)
    */
   accessor disableAssistant: boolean;
   /**
@@ -63,9 +95,12 @@ export abstract class ArcgisArcadeEditor extends LitElement {
    */
   accessor editorOptions: (Editor.IEditorOptions & Editor.IGlobalEditorOptions) | undefined;
   /**
-   * Enables the bottom run and debug drawer UX.
+   * If `true`, the editor will enable a debug drawer at the bottom of the editor. This drawer
+   * includes debugging features such as the ability to set breakpoints, step through code,
+   * and view variable values during execution.
    *
    * @default false
+   * @since 5.1
    */
   accessor enableDebugger: boolean;
   /**