@arcgis/coding-components 5.0.0-next.136 → 5.0.0-next.138

package/dist/utils/arcade-executor.d.ts

@@ -1,174 +1,206 @@
-import { IEditorProfileDefinition } from './profile/types';
-import { ProfileVariableInstances, ArcadeServices } from '@arcgis/core/arcade';
-import { GeometryUnion } from '@arcgis/core/unionTypes';
-import { default as Field } from '@arcgis/core/layers/support/Field';
-import { default as KnowledgeGraph } from '@arcgis/core/rest/knowledgeGraph/KnowledgeGraph';
-import { default as SpatialReference } from '@arcgis/core/geometry/SpatialReference';
-interface IContextReferences {
-    /**
-     * Spatial reference object used to define the spatial reference for the arcade runtime.
-     * By defaults, the spatial reference is set to Web Mercator (wkid: 3857).
-     */
-    spatialReference?: SpatialReference | {
-        wkid: number;
-    } | null;
-    /**
-     * Defines the default time zone in which to create and display Arcade date types.
-     * By default, the time zone is set to "system".
-     */
-    timeZone?: string;
-    /**
-     * Defines the "services" passed to the arcade executor.
-     */
-    services?: ArcadeServices;
-}
+import type Field from "@arcgis/core/layers/support/Field";
+import type KnowledgeGraph from "@arcgis/core/rest/knowledgeGraph/KnowledgeGraph";
+import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
+import type { IEditorProfileDefinition } from "./profile/types.js";
+import type { ProfileVariableInstances, ArcadeServices } from "@arcgis/core/arcade";
+import type { GeometryUnion } from "@arcgis/core/unionTypes";
+
 /**
  * If a profile doesn't contain a map, the spatial reference of geometries will be defaulted to
  * wkid: 3857.
  * The test context objects allows to set the execution spatial reference for such scenario.
  */
 export interface IEditorTestContext extends IContextReferences {
-    /**
-     * An object of key/value pairs where the key is the name of a profile variable.
-     * The key's value must be of type ArcGIS core ProfileVariableInstance.
-     */
-    profileVariableInstances: ProfileVariableInstances;
-}
-/**
- * @deprecated Use IEditorTestContext instead.
- */
+  /**
+   * An object of key/value pairs where the key is the name of a profile variable.
+   * The key's value must be of type ArcGIS core ProfileVariableInstance.
+   */
+  profileVariableInstances: ProfileVariableInstances;
+}
+
+/** @deprecated Use IEditorTestContext instead. */
 export type EditorTestContext = IEditorTestContext;
+
 export interface IArcadeRuntimeDictionary {
-    declaredClass?: string;
-    arcadeDeclaredClass?: string;
-    keys: () => string[];
-    field: (name: string) => unknown;
-    geometry?: () => GeometryUnion;
-    castAsJson: () => Record<string, unknown>;
-}
+  declaredClass?: string;
+  arcadeDeclaredClass?: string;
+  keys: () => string[];
+  field: (name: string) => unknown;
+  geometry?: () => GeometryUnion;
+  castAsJson: () => Record<string, unknown>;
+}
+
 export interface IAbortSignal {
-    aborted: boolean;
-}
-interface IArcadeRuntimeFeatureSet {
-    declaredRootClass: string;
-    fields: Field[] | null;
-    load: () => Promise<IArcadeRuntimeFeatureSet>;
-    iterator: (abortSignal: IAbortSignal) => IArcadeRuntimeFeatureSetIterator;
-}
-interface IArcadeRuntimeFeatureSetIterator {
-    nextBatchAsArcadeFeatures: (bsize: number, timeZone: string) => Promise<IArcadeRuntimeDictionary[] | null>;
-}
-interface IArcadeRuntimeDate {
-    declaredRootClass: string;
-    toDateTime: () => {
-        setLocale: (locale: string) => {
-            toFormat: (format: string) => string;
-        };
-    };
-    isUnknownTimeZone: boolean;
-}
-interface IArcadeRuntimeDateOnly {
-    declaredRootClass: string;
-    /**
-     * To ISO Date format
-     */
-    toString: () => string;
-}
-interface IArcadeRuntimeTimeOnly {
-    declaredRootClass: string;
-    /**
-     * To ISO Time format
-     */
-    toString: () => string;
+  aborted: boolean;
 }
+
 export type ResultType = "array" | "attachment" | "boolean" | "date" | "dateOnly" | "dictionary" | "error" | "feature" | "featureSet" | "geometry" | "knowledgeGraph" | "null" | "number" | "pixel" | "portal" | "text" | "time" | "unknown";
-interface IArcadeResultBase {
-    type: ResultType;
-    timeStamp?: Date;
-    compilationTime?: number;
-    executionTime?: number;
-}
+
 export interface IArcadeResultUnknown extends IArcadeResultBase {
-    type: "unknown";
+  type: "unknown";
 }
+
 export interface IArcadeResultNull extends IArcadeResultBase {
-    type: "null";
+  type: "null";
 }
+
 export interface IArcadeResultError extends IArcadeResultBase {
-    type: "error";
-    value: string;
-    error: unknown;
+  type: "error";
+  value: string;
+  error: unknown;
 }
+
 export interface IArcadeResultArray extends IArcadeResultBase {
-    type: "array";
-    value: unknown[];
+  type: "array";
+  value: unknown[];
 }
+
 export interface IArcadeResultDate extends IArcadeResultBase {
-    type: "date";
-    value: Date | IArcadeRuntimeDate;
+  type: "date";
+  value: Date | IArcadeRuntimeDate;
 }
+
 export interface IArcadeResultDateOnly extends IArcadeResultBase {
-    type: "dateOnly";
-    value: IArcadeRuntimeDateOnly;
+  type: "dateOnly";
+  value: IArcadeRuntimeDateOnly;
 }
+
 export interface IArcadeResultTimeOnly extends IArcadeResultBase {
-    type: "time";
-    value: IArcadeRuntimeTimeOnly;
+  type: "time";
+  value: IArcadeRuntimeTimeOnly;
 }
+
 export interface IArcadeResultString extends IArcadeResultBase {
-    type: "text";
-    value: string;
+  type: "text";
+  value: string;
 }
+
 export interface IArcadeResultNumber extends IArcadeResultBase {
-    type: "number";
-    value: number;
+  type: "number";
+  value: number;
 }
+
 export interface IArcadeResultBoolean extends IArcadeResultBase {
-    type: "boolean";
-    value: boolean;
+  type: "boolean";
+  value: boolean;
 }
+
 export interface IArcadeResultDictionary extends IArcadeResultBase {
-    type: "dictionary";
-    value: IArcadeRuntimeDictionary;
+  type: "dictionary";
+  value: IArcadeRuntimeDictionary;
 }
+
 export interface IArcadeResultGeometry extends IArcadeResultBase {
-    type: "geometry";
-    value: GeometryUnion;
+  type: "geometry";
+  value: GeometryUnion;
 }
+
 export interface IArcadeResultKnowledgeGraph extends IArcadeResultBase {
-    type: "knowledgeGraph";
-    value: KnowledgeGraph;
+  type: "knowledgeGraph";
+  value: KnowledgeGraph;
 }
+
 export interface IArcadeResultFeature extends IArcadeResultBase {
-    type: "feature";
-    value: IArcadeRuntimeDictionary;
+  type: "feature";
+  value: IArcadeRuntimeDictionary;
 }
+
 export interface IArcadeResultPixel extends IArcadeResultBase {
-    type: "pixel";
-    value: IArcadeRuntimeDictionary;
+  type: "pixel";
+  value: IArcadeRuntimeDictionary;
 }
+
 export interface IArcadeResultFeatureSet extends IArcadeResultBase {
-    type: "featureSet";
-    value: IArcadeRuntimeFeatureSet;
-    iterator: IArcadeRuntimeFeatureSetIterator | null;
-    features: IArcadeRuntimeDictionary[];
+  type: "featureSet";
+  value: IArcadeRuntimeFeatureSet;
+  iterator: IArcadeRuntimeFeatureSetIterator | null;
+  features: IArcadeRuntimeDictionary[];
 }
+
 export interface IArcadeResultPortal extends IArcadeResultBase {
-    type: "portal";
-    value: IArcadeRuntimeDictionary;
+  type: "portal";
+  value: IArcadeRuntimeDictionary;
 }
+
 export interface IArcadeResultAttachment extends IArcadeResultBase {
-    type: "attachment";
-    value: IArcadeRuntimeDictionary;
+  type: "attachment";
+  value: IArcadeRuntimeDictionary;
 }
+
 export type ArcadeResult = IArcadeResultArray | IArcadeResultAttachment | IArcadeResultBoolean | IArcadeResultDate | IArcadeResultDateOnly | IArcadeResultDictionary | IArcadeResultError | IArcadeResultFeature | IArcadeResultFeatureSet | IArcadeResultGeometry | IArcadeResultKnowledgeGraph | IArcadeResultNull | IArcadeResultNumber | IArcadeResultPixel | IArcadeResultPortal | IArcadeResultString | IArcadeResultTimeOnly | IArcadeResultUnknown;
-export declare function valueToArcadeResult(value: unknown): ArcadeResult;
-export declare function formatArcadeResultDate(dateObject: IArcadeResultDate, lang?: string): string;
-export declare function formatArcadeResultDateOnly(dateObject: IArcadeResultDateOnly): string;
-export declare function formatArcadeResultTimeOnly(dateObject: IArcadeResultTimeOnly): string;
-declare function convertScriptOutputToArcadeResult(scriptOutput: unknown, timeZone?: string): Promise<ArcadeResult>;
-export declare function executeScript(editorProfile: IEditorProfileDefinition | undefined, script: string | undefined, testContext: IEditorTestContext, console?: (log: string) => void): Promise<ArcadeResult>;
-export declare const exportsForTests: {
-    convertScriptOutputToArcadeResult: typeof convertScriptOutputToArcadeResult;
-};
-export {};
+
+/** @param value */
+export function valueToArcadeResult(value: unknown): ArcadeResult;
+
+/**
+ * @param dateObject
+ * @param lang
+ */
+export function formatArcadeResultDate(dateObject: IArcadeResultDate, lang?: string): string;
+
+/** @param dateObject */
+export function formatArcadeResultDateOnly(dateObject: IArcadeResultDateOnly): string;
+
+/** @param dateObject */
+export function formatArcadeResultTimeOnly(dateObject: IArcadeResultTimeOnly): string;
+
+/**
+ * @param editorProfile
+ * @param script
+ * @param testContext
+ * @param console
+ */
+export function executeScript(editorProfile: IEditorProfileDefinition | undefined, script: string | undefined, testContext: IEditorTestContext, console?: (log: string) => void): Promise<ArcadeResult>;
+
+export const exportsForTests: { convertScriptOutputToArcadeResult: (scriptOutput: unknown, timeZone?: string) => Promise<ArcadeResult>; };
+
+export interface IContextReferences {
+  /**
+   * Spatial reference object used to define the spatial reference for the arcade runtime.
+   * By defaults, the spatial reference is set to Web Mercator (wkid: 3857).
+   */
+  spatialReference?: SpatialReference | { wkid: number; } | null;
+  /**
+   * Defines the default time zone in which to create and display Arcade date types.
+   * By default, the time zone is set to "system".
+   */
+  timeZone?: string;
+  /** Defines the "services" passed to the arcade executor. */
+  services?: ArcadeServices;
+}
+
+export interface IArcadeRuntimeFeatureSet {
+  declaredRootClass: string;
+  fields: Field[] | null;
+  load: () => Promise<IArcadeRuntimeFeatureSet>;
+  iterator: (abortSignal: IAbortSignal) => IArcadeRuntimeFeatureSetIterator;
+}
+
+export interface IArcadeRuntimeFeatureSetIterator {
+  nextBatchAsArcadeFeatures: (bsize: number, timeZone: string) => Promise<IArcadeRuntimeDictionary[] | null>;
+}
+
+export interface IArcadeRuntimeDate {
+  declaredRootClass: string;
+  toDateTime: () => { setLocale: (locale: string) => { toFormat: (format: string) => string; }; };
+  isUnknownTimeZone: boolean;
+}
+
+export interface IArcadeRuntimeDateOnly {
+  declaredRootClass: string;
+  /** To ISO Date format */
+  toString: () => string;
+}
+
+export interface IArcadeRuntimeTimeOnly {
+  declaredRootClass: string;
+  /** To ISO Time format */
+  toString: () => string;
+}
+
+export interface IArcadeResultBase {
+  type: ResultType;
+  timeStamp?: Date;
+  compilationTime?: number;
+  executionTime?: number;
+}

package/dist/utils/arcade-monaco/arcade-defaults.d.ts

@@ -1,51 +1,11 @@
-import { ArcadeApiContext } from '@arcgis/arcade-languageservice';
-import { ApiSnippet } from '@arcgis/languages-api-utils';
-import { Uri } from 'monaco-editor';
-import { IEditorProfileDefinition, IPredefinedProfile } from '../profile/types';
-import { LanguageDefaultsBase } from '../language-defaults-base';
-/**
- * Provides default configuration and per-model state management for the Arcade language service.
- *
- * In addition to the base language defaults, this class manages an {@link EditorProfile} and the
- * corresponding API context for each Monaco model. It serializes profile updates on a per-model basis
- * to prevent race conditions when multiple asynchronous profile changes are requested in quick succession.
- *
- * @remarks
- * Profile updates are queued per model key because `setProfileForModel` performs multiple asynchronous steps
- * (e.g., loading localized strings, converting predefined profiles, converting editor profiles to API profiles,
- * and disposing/reinitializing per-model state). Without serialization, an older request could complete after a
- * newer request and overwrite the latest context.
- *
- * @example
- * ```ts
- * await defaults.setProfileForModel(model.uri, predefinedProfile, { locale: "en" });
- * await defaults.setProfileForModel(model.uri, editorProfileDefinition, { locale: "fr", snippets });
- * ```
- */
-declare class ArcadeLanguageServiceDefaults extends LanguageDefaultsBase<ArcadeApiContext> {
-    #private;
-    constructor();
-    /**
-     * Create an EditorProfile for the given model id using the given definition and locale.
-     * The EditorProfile is used by the the Arcade Language service as well by the coding components.
-     * The definition can be a pre-defined profile or an editor profile definition.
-     * If the locale is not provided then the 'en' locale is used.
-     * @param modelId The model id for which to create the context.
-     * @param definition The definition to use for the model context.
-     * @param locale The locale to use for the model context.
-     * @returns The EditorProfile for the model.
-     */
-    setProfileForModel(modelId: Uri | string, definition: IEditorProfileDefinition | IPredefinedProfile | undefined, apiContext?: {
+import type { IEditorProfileDefinition, IPredefinedProfile } from "../profile/types.js";
+import type { Uri as Uri2 } from "monaco-editor/esm/vs/editor/editor.api.js";
+import type { ApiSnippet as ApiSnippet2, ApiCategory } from "@arcgis/languages-api-utils/dist/types.js";
+
+export const arcade: {
+    setProfileForModel: (modelId: string | Uri2, definition: IEditorProfileDefinition | IPredefinedProfile | undefined, apiContext?: {
         locale: string;
-        snippets?: ApiSnippet[];
-    }): Promise<void>;
-}
-export declare const arcadeDefaults: ArcadeLanguageServiceDefaults;
-export declare const arcade: {
-    setProfileForModel: (modelId: Uri | string, definition: IEditorProfileDefinition | IPredefinedProfile | undefined, apiContext?: {
-        locale: string;
-        snippets?: ApiSnippet[];
+        snippets?: Array<ApiSnippet2> | undefined;
     }) => Promise<void>;
-    getApiLibraryForModel: (modelId: string) => Promise<import('@arcgis/languages-api-utils').ApiCategory[]>;
-};
-export type { ArcadeLanguageServiceDefaults };
+    getApiLibraryForModel: (modelId: string) => Promise<Array<ApiCategory>>;
+};

package/dist/utils/custom-panel.d.ts

@@ -1,31 +1,36 @@
-import { JsxNode } from '@arcgis/lumina';
-import { ArcgisArcadeEditor } from '../components/arcgis-arcade-editor/customElement.js';
-import { IconName } from '../components/arcgis-arcade-coding-assistant/types';
-type IBaseCustomPanel = {
-    /** Unique ID */
-    id: string;
-    name: string;
-    location: "sidebar";
-    renderer: ({ closePanel, insertText, closed, editorRef, }: {
-        closePanel: (e: Event) => void;
-        insertText: (text: string) => void;
-        closed: boolean;
-        editorRef: ArcgisArcadeEditor;
-    }) => JsxNode;
-};
-type ICustomSidePanel = IBaseCustomPanel & {
-    /** Calcite icon */
-    icon: IconName;
-    /** Optional description */
-    description?: string;
-    /** Optional flag to indicate that the user is providing custom flow items
-     * @deprecated - this is not used in the codebase and will be removed in the future.
-     */
-    useFlows?: boolean;
-    /** Optional flag to tell the editor if the panel is enabled, defaults to true */
-    enabled?: boolean;
-    /** location */
-    location: "sidebar";
-};
+import type { JsxNode } from "@arcgis/lumina";
+import type { ArcgisArcadeEditor } from "../components/arcgis-arcade-editor/customElement.js";
+import type { IconName } from "../components/arcgis-arcade-coding-assistant/types.js";
+
 export type ICustomPanel = ICustomSidePanel;
-export {};
+
+export type ICustomSidePanel = IBaseCustomPanel
+  & {
+  /** Calcite icon */
+  icon: IconName;
+  /** Optional description */
+  description?: string;
+  /**
+   * Optional flag to indicate that the user is providing custom flow items
+   *
+   * @deprecated - this is not used in the codebase and will be removed in the future.
+   */
+  useFlows?: boolean;
+  /** Optional flag to tell the editor if the panel is enabled, defaults to true */
+  enabled?: boolean;
+  /** location */
+  location: "sidebar";
+};
+
+export type IBaseCustomPanel = {
+  /** Unique ID */
+  id: string;
+  name: string;
+  location: "sidebar";
+  renderer: ({ closePanel, insertText, closed, editorRef, }: {
+      closePanel: (e: Event) => void;
+      insertText: (text: string) => void;
+      closed: boolean;
+      editorRef: ArcgisArcadeEditor;
+  }) => JsxNode;
+};

package/dist/utils/editor-suggestions.d.ts

@@ -1,32 +1,21 @@
 export interface IEditorCodeSuggestionGroup {
-    /**
-     * Label for the suggestion group
-     */
-    label: string;
-    /**
-     * List of suggestions for the group
-     */
-    suggestions: IEditorCodeSuggestion[];
+  /** Label for the suggestion group */
+  label: string;
+  /** List of suggestions for the group */
+  suggestions: IEditorCodeSuggestion[];
 }
-/**
- * Defines a code suggestion
- */
+
+/** Defines a code suggestion */
 export interface IEditorCodeSuggestion {
-    /**
-     * A short label for the suggestion. Can be thought as a title
-     */
-    label: string;
-    /**
-     * A short description that will be showed below the label in the list of suggestions panel
-     */
-    description?: string;
-    /**
-     * Markdown string that will be rendered along with the code in the detail panel
-     */
-    documentation?: string;
-    /**
-     * The code for the suggestion. Will be injected in the editor is selected
-     */
-    code: string;
+  /** A short label for the suggestion. Can be thought as a title */
+  label: string;
+  /** A short description that will be showed below the label in the list of suggestions panel */
+  description?: string;
+  /** Markdown string that will be rendered along with the code in the detail panel */
+  documentation?: string;
+  /** The code for the suggestion. Will be injected in the editor is selected */
+  code: string;
 }
-export declare function isSuggestionGroups(item: unknown): item is IEditorCodeSuggestionGroup[];
+
+/** @param item */
+export function isSuggestionGroups(item: unknown): item is IEditorCodeSuggestionGroup[];

package/dist/utils/index.d.ts

@@ -1,6 +1,4 @@
-/** @public */
-export * from './arcade-executor';
-/** @public */
-export type * from './profile/types';
-/** @public */
-export * from './editor-suggestions';
+export * from "./arcade-executor";
+export type * from "./profile/types";
+export * from "./editor-suggestions";
+