@arcgis/coding-components 4.29.0-beta.11 → 4.29.0-beta.110

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

@@ -5,18 +5,18 @@ import type { IEditorProfileDefinition } from "./profile/types";
  */
 export type ProfileVariableInstances = Record<string, __esri.ProfileVariableInstanceType>;
 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?: __esri.SpatialReference | {
-    wkid: number;
-  };
-  /**
-   * 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;
+    /**
+     * 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?: __esri.SpatialReference | {
+        wkid: number;
+    };
+    /**
+     * 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;
 }
 /**
  * If a profile doesn't contain a map, the spatial reference of geometries will be defaulted to
@@ -24,128 +24,136 @@ interface IContextReferences {
  * 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 ProfileVariableInstanceType.
-   */
-  profileVariableInstances: ProfileVariableInstances;
+    /**
+     * 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 ProfileVariableInstanceType.
+     */
+    profileVariableInstances: ProfileVariableInstances;
 }
 /**
  * @deprecated Use IEditorTestContext instead.
  */
 export type EditorTestContext = IEditorTestContext;
 export interface IArcadeRuntimeDictionary {
-  declaredClass?: string;
-  arcadeDeclaredClass?: string;
-  keys(): string[];
-  field(name: string): any;
-  geometry?(): any;
-  castAsJson(): Record<string, any>;
+    declaredClass?: string;
+    arcadeDeclaredClass?: string;
+    keys: () => string[];
+    field: (name: string) => any;
+    geometry?: () => __esri.Geometry;
+    castAsJson: () => Record<string, any>;
 }
 export interface IAbortSignal {
-  aborted: boolean;
+    aborted: boolean;
 }
 interface IArcadeRuntimeFeatureSet {
-  declaredRootClass: string;
-  fields: __esri.Field[] | null;
-  load(): Promise<IArcadeRuntimeFeatureSet>;
-  iterator(abortSignal: IAbortSignal): IArcadeRuntimeFeatureSetIterator;
+    declaredRootClass: string;
+    fields: __esri.Field[] | null;
+    load: () => Promise<IArcadeRuntimeFeatureSet>;
+    iterator: (abortSignal: IAbortSignal) => IArcadeRuntimeFeatureSetIterator;
 }
 interface IArcadeRuntimeFeatureSetIterator {
-  nextBatchAsArcadeFeatures(bsize: number, timeZone: string): Promise<IArcadeRuntimeDictionary[] | null>;
+    nextBatchAsArcadeFeatures: (bsize: number, timeZone: string) => Promise<IArcadeRuntimeDictionary[] | null>;
 }
 interface IArcadeRuntimeDate {
-  declaredRootClass: string;
-  toDateTime(): any;
-  isUnknownTimeZone: boolean;
+    declaredRootClass: string;
+    toDateTime: () => {
+        setLocale: (locale: string) => {
+            toFormat: (format: string) => string;
+        };
+    };
+    isUnknownTimeZone: boolean;
 }
 interface IArcadeRuntimeDateOnly {
-  declaredRootClass: string;
-  /**
-   * To ISO Date format
-   */
-  toString(): string;
+    declaredRootClass: string;
+    /**
+     * To ISO Date format
+     */
+    toString: () => string;
 }
 interface IArcadeRuntimeTimeOnly {
-  declaredRootClass: string;
-  /**
-   * To ISO Time format
-   */
-  toString(): string;
+    declaredRootClass: string;
+    /**
+     * To ISO Time format
+     */
+    toString: () => string;
 }
-export type ResultType = "unknown" | "error" | "null" | "array" | "date" | "dateOnly" | "time" | "text" | "number" | "boolean" | "dictionary" | "geometry" | "attachment" | "feature" | "featureSet" | "portal";
+export type ResultType = "array" | "attachment" | "boolean" | "date" | "dateOnly" | "dictionary" | "error" | "feature" | "featureSet" | "geometry" | "knowledgeGraph" | "null" | "number" | "portal" | "text" | "time" | "unknown";
 interface IArcadeResultBase {
-  type: ResultType;
-  timeStamp?: Date;
-  compilationTime?: number;
-  executionTime?: number;
+    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: any;
+    type: "error";
+    value: string;
+    error: any;
 }
 export interface IArcadeResultArray extends IArcadeResultBase {
-  type: "array";
-  value: Array<any>;
+    type: "array";
+    value: any[];
 }
 export interface IArcadeResultDate extends IArcadeResultBase {
-  type: "date";
-  value: IArcadeRuntimeDate | Date;
+    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: __esri.Geometry;
+    type: "geometry";
+    value: __esri.Geometry;
+}
+export interface IArcadeResultKnowledgeGraph extends IArcadeResultBase {
+    type: "knowledgeGraph";
+    value: __esri.KnowledgeGraph;
 }
 export interface IArcadeResultFeature extends IArcadeResultBase {
-  type: "feature";
-  value: IArcadeRuntimeDictionary;
+    type: "feature";
+    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 = IArcadeResultError | IArcadeResultUnknown | IArcadeResultNull | IArcadeResultNumber | IArcadeResultBoolean | IArcadeResultString | IArcadeResultDate | IArcadeResultDateOnly | IArcadeResultTimeOnly | IArcadeResultArray | IArcadeResultDictionary | IArcadeResultGeometry | IArcadeResultAttachment | IArcadeResultFeature | IArcadeResultFeatureSet | IArcadeResultPortal;
+export type ArcadeResult = IArcadeResultArray | IArcadeResultAttachment | IArcadeResultBoolean | IArcadeResultDate | IArcadeResultDateOnly | IArcadeResultDictionary | IArcadeResultError | IArcadeResultFeature | IArcadeResultFeatureSet | IArcadeResultGeometry | IArcadeResultKnowledgeGraph | IArcadeResultNull | IArcadeResultNumber | 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;

package/dist/types/utils/arcade-monaco/arcade-contribution.d.ts

@@ -1,5 +1,5 @@
 import type { IArcadeWorker } from "./types";
-import { Uri } from "monaco-editor";
+import type { Uri } from "monaco-editor";
 import type { IDiagnosticService } from "./arcade-mode";
 /**
  * Returns the arcade diagnostic service.

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

@@ -1,77 +1,78 @@
 import type { IArcadeLanguageServiceDefaults } from "./types";
 import type { ApiContext, ApiSnippet, ArcadeLanguageServiceSettings } from "@arcgis/arcade-languageservice";
-import { IEvent, Uri } from "monaco-editor";
+import type { IEvent } from "monaco-editor";
+import { Uri } from "monaco-editor";
 import { EditorProfile } from "../profile/editor-profile";
-import { IEditorProfileDefinition, IPredefinedProfile } from "../profile/types";
+import type { IEditorProfileDefinition, IPredefinedProfile } from "../profile/types";
 declare class ArcadeLanguageServiceDefaults implements IArcadeLanguageServiceDefaults {
-  private _languageId;
-  private _languageOptions;
-  private _onDidChange;
-  private _profileMap;
-  private _apiContextMap;
-  private _onModelContextDidChange;
-  private _onDidModelContextChangeTimeout;
-  get onDidChange(): IEvent<IArcadeLanguageServiceDefaults>;
-  get onModelContextDidChange(): IEvent<string>;
-  get languageId(): string;
-  get languageOptions(): ArcadeLanguageServiceSettings | null;
-  private _fireModelContextDidChange;
-  private _getApiKey;
-  /**
-   * 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 cosing 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: string | Uri, definition: IEditorProfileDefinition | IPredefinedProfile | undefined, apiContext?: {
-    locale: string;
-    snippets?: ApiSnippet[];
-  }): Promise<void>;
-  /**
-   * Dispose the editor profile for the given model id.
-   * It is the responsibility of the caller that created the editor profile to dispose it.
-   * @param modelId The model id for which to dispose the editor profile.
-   */
-  disposeEditorProfileForModel(modelId: string | Uri): void;
-  /**
-   * Dispose the api context for the given model id.
-   * @param modelId The model id for which to dispose the api context.
-   */
-  disposeApiContextForModel(modelId: string | Uri): void;
-  /**
-   * Returns the editor profile for the given model id.
-   * @param modelId The model id for which to get the editor profile.
-   * @returns The editor profile for the model.
-   */
-  getEditorProfileForModel(modelId: string | Uri): EditorProfile | undefined;
-  /**
-   * Returns the API context for the given model id.
-   * Returns the default context if the model has no context.
-   * @param modelId The model id for which to get the API context.
-   * @returns The API context for the model.
-   */
-  getApiContextForModel(contextId: string | Uri): ApiContext;
-  /**
-   * Set or update api context for the given model id.
-   * @param modelId The model id for which to set the context.
-   * @param apiContext The api context to set.
-   */
-  updateApiContextForModel(modelId: string | Uri, apiContext: ApiContext): void;
-  /**
-   * Set or update the Arcade language service options.
-   * @param languageOptions The language options to set.
-   */
-  setLanguageOptions(languageOptions?: ArcadeLanguageServiceSettings): void;
+    private _languageId;
+    private _languageOptions;
+    private _onDidChange;
+    private _profileMap;
+    private _apiContextMap;
+    private _onModelContextDidChange;
+    private _onDidModelContextChangeTimeout;
+    get onDidChange(): IEvent<IArcadeLanguageServiceDefaults>;
+    get onModelContextDidChange(): IEvent<string>;
+    get languageId(): string;
+    get languageOptions(): ArcadeLanguageServiceSettings | null;
+    private _fireModelContextDidChange;
+    private _getApiKey;
+    /**
+     * 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 cosing 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?: {
+        locale: string;
+        snippets?: ApiSnippet[];
+    }): Promise<void>;
+    /**
+     * Dispose the editor profile for the given model id.
+     * It is the responsibility of the caller that created the editor profile to dispose it.
+     * @param modelId The model id for which to dispose the editor profile.
+     */
+    disposeEditorProfileForModel(modelId: Uri | string): void;
+    /**
+     * Dispose the api context for the given model id.
+     * @param modelId The model id for which to dispose the api context.
+     */
+    disposeApiContextForModel(modelId: Uri | string): void;
+    /**
+     * Returns the editor profile for the given model id.
+     * @param modelId The model id for which to get the editor profile.
+     * @returns The editor profile for the model.
+     */
+    getEditorProfileForModel(modelId: Uri | string): EditorProfile | undefined;
+    /**
+     * Returns the API context for the given model id.
+     * Returns the default context if the model has no context.
+     * @param modelId The model id for which to get the API context.
+     * @returns The API context for the model.
+     */
+    getApiContextForModel(contextId: Uri | string): ApiContext;
+    /**
+     * Set or update api context for the given model id.
+     * @param modelId The model id for which to set the context.
+     * @param apiContext The api context to set.
+     */
+    updateApiContextForModel(modelId: Uri | string, apiContext: ApiContext): void;
+    /**
+     * Set or update the Arcade language service options.
+     * @param languageOptions The language options to set.
+     */
+    setLanguageOptions(languageOptions?: ArcadeLanguageServiceSettings): void;
 }
 export declare const arcadeDefaults: ArcadeLanguageServiceDefaults;
 export declare const arcade: {
-  setProfileForModel(modelId: string | Uri, definition: IEditorProfileDefinition | IPredefinedProfile | undefined, apiContext?: {
-    locale: string;
-    snippets?: ApiSnippet[];
-  }): Promise<void>;
+    setProfileForModel: (modelId: Uri | string, definition: IEditorProfileDefinition | IPredefinedProfile | undefined, apiContext?: {
+        locale: string;
+        snippets?: ApiSnippet[];
+    }) => Promise<void>;
 };
 export {};

package/dist/types/utils/arcade-monaco/arcade-language-features.d.ts

@@ -1,32 +1,33 @@
-import { Diagnostic } from "@arcgis/arcade-languageservice";
-import { editor, Uri, Position, languages } from "monaco-editor";
-import { IArcadeLanguageServiceDefaults, IArcadeWorkerAccessor } from "./types";
+import type { Diagnostic } from "@arcgis/arcade-languageservice";
+import type { Uri, Position } from "monaco-editor";
+import { editor, languages } from "monaco-editor";
+import type { IArcadeLanguageServiceDefaults, IArcadeWorkerAccessor } from "./types";
 export declare class DiagnosticsAdapter {
-  private _languageId;
-  private _worker;
-  private _disposables;
-  private _listener;
-  private _diagnosticsService;
-  private _defaults;
-  constructor(_languageId: string, _worker: IArcadeWorkerAccessor, { defaults, diagnosticsService }: {
-    defaults: IArcadeLanguageServiceDefaults;
-    diagnosticsService: {
-      fireDiagnosticsChange(uri: Uri, diagnostics: Diagnostic[]): void;
-    };
-  });
-  dispose(): void;
-  private _doValidate;
+    private _languageId;
+    private _worker;
+    private _disposables;
+    private _listener;
+    private _diagnosticsService;
+    private _defaults;
+    constructor(_languageId: string, _worker: IArcadeWorkerAccessor, { defaults, diagnosticsService }: {
+        defaults: IArcadeLanguageServiceDefaults;
+        diagnosticsService: {
+            fireDiagnosticsChange: (uri: Uri, diagnostics: Diagnostic[]) => void;
+        };
+    });
+    dispose(): void;
+    private _doValidate;
 }
 export declare class CompletionProvider implements languages.CompletionItemProvider {
-  private _worker;
-  private _defaults;
-  constructor(_worker: IArcadeWorkerAccessor, _defaults: IArcadeLanguageServiceDefaults);
-  triggerCharacters: string[];
-  provideCompletionItems(model: editor.ITextModel, position: Position): Promise<languages.CompletionList | undefined>;
+    private _worker;
+    private _defaults;
+    constructor(_worker: IArcadeWorkerAccessor, _defaults: IArcadeLanguageServiceDefaults);
+    triggerCharacters: string[];
+    provideCompletionItems(model: editor.ITextModel, position: Position): Promise<languages.CompletionList | undefined>;
 }
 export declare class FormattingProvider implements languages.DocumentFormattingEditProvider {
-  private _worker;
-  private _defaults;
-  constructor(_worker: IArcadeWorkerAccessor, _defaults: IArcadeLanguageServiceDefaults);
-  provideDocumentFormattingEdits(model: editor.ITextModel): Promise<languages.TextEdit[]>;
+    private _worker;
+    private _defaults;
+    constructor(_worker: IArcadeWorkerAccessor, _defaults: IArcadeLanguageServiceDefaults);
+    provideDocumentFormattingEdits(model: editor.ITextModel): Promise<languages.TextEdit[]>;
 }

package/dist/types/utils/arcade-monaco/arcade-mode.d.ts

@@ -1,4 +1,4 @@
-import { IEvent, Uri } from "monaco-editor";
+import type { IEvent, Uri } from "monaco-editor";
 import type { IArcadeLanguageServiceDefaults, IArcadeWorker } from "./types";
 import type { Diagnostic } from "@arcgis/arcade-languageservice";
 /**
@@ -8,17 +8,17 @@ import type { Diagnostic } from "@arcgis/arcade-languageservice";
  */
 export declare function getArcadeWorker(...uris: Uri[]): Promise<IArcadeWorker>;
 export interface IDiagnosticsEvent {
-  /**
-   * The uri of the model for which the diagnostics changed.
-   */
-  uri: Uri;
-  /**
-   * The diagnostics for the model.
-   */
-  diagnostics: Diagnostic[];
+    /**
+     * The uri of the model for which the diagnostics changed.
+     */
+    uri: Uri;
+    /**
+     * The diagnostics for the model.
+     */
+    diagnostics: Diagnostic[];
 }
 export interface IDiagnosticService {
-  onDiagnosticsChange: IEvent<IDiagnosticsEvent>;
+    onDiagnosticsChange: IEvent<IDiagnosticsEvent>;
 }
 /**
  * Get the Arcade Diagnostic Service.

package/dist/types/utils/arcade-monaco/arcade-theme.d.ts

@@ -1,11 +1,12 @@
 export declare function setupArcadeTheme(): void;
 export interface IColorRules {
-  comment?: string;
-  keyword?: string;
-  identifier?: string;
-  string?: string;
-  number?: string;
-  constant?: string;
-  date?: string;
+    comment?: string;
+    keyword?: string;
+    identifier?: string;
+    string?: string;
+    number?: string;
+    constant?: string;
+    date?: string;
 }
-export declare function updateThemeColors(theme: "light" | "dark", colorRules: IColorRules | undefined): void;
+export declare const colorRulesKeys: (keyof IColorRules)[];
+export declare function updateThemeColors(theme: "dark" | "light", colorRules: IColorRules | undefined): void;

package/dist/types/utils/arcade-monaco/arcade-worker-manager.d.ts

@@ -1,16 +1,16 @@
-import { Uri } from "monaco-editor";
-import { IArcadeLanguageServiceDefaults, IArcadeWorker } from "./types";
+import type { Uri } from "monaco-editor";
+import type { IArcadeLanguageServiceDefaults, IArcadeWorker } from "./types";
 /**
  * Manager to create our arcade worker and client proxy
  */
 export declare class WorkerManager {
-  private _defaults;
-  private _worker;
-  private _client;
-  private _configChangeListener;
-  constructor(_defaults: IArcadeLanguageServiceDefaults);
-  dispose(): void;
-  stopWorker(): void;
-  private _getClientProxy;
-  getLanguageServiceWorker(...resources: Uri[]): Promise<IArcadeWorker>;
+    private _defaults;
+    private _worker;
+    private _client;
+    private _configChangeListener;
+    constructor(_defaults: IArcadeLanguageServiceDefaults);
+    dispose(): void;
+    stopWorker(): void;
+    private _getClientProxy;
+    getLanguageServiceWorker(...resources: Uri[]): Promise<IArcadeWorker>;
 }

package/dist/types/utils/arcade-monaco/arcade.worker.d.ts

@@ -1,22 +1,24 @@
-import { worker } from "monaco-editor";
+import type { worker } from "monaco-editor";
 import type { IArcadeWorker } from "./types";
 import type { ArcadeLanguageServiceSettings, ApiCategory, ApiContext, Diagnostic } from "@arcgis/arcade-languageservice";
-import { CompletionList, Position, TextEdit } from "vscode-languageserver-types";
+import type { CompletionList, Position, TextEdit } from "vscode-languageserver-types";
+interface IArcadeWorkerData {
+    languageId: string;
+    languageOptions?: ArcadeLanguageServiceSettings;
+}
 /**
  * The Arcade Web Worker is leveraging the Arcade Language Service to provide the editor functionalities.
  * The Arcade Web Worker is proxied by the Monaco worker server.
  */
 export declare class ArcadeWorker implements IArcadeWorker {
-  private _ctx;
-  private _languageId;
-  private _languageService;
-  constructor(_ctx: worker.IWorkerContext, { languageId, languageOptions }: {
-    languageId: string;
-    languageOptions?: ArcadeLanguageServiceSettings;
-  });
-  doValidation(modelId: string, context: ApiContext): Promise<Diagnostic[]>;
-  doComplete(modelId: string, position: Position, context: ApiContext): Promise<CompletionList>;
-  doFormat(modelId: string, context: ApiContext): Promise<TextEdit[]>;
-  getApiLibrary(context: ApiContext): Promise<ApiCategory[]>;
-  private _getTextDocument;
+    private _ctx;
+    private _languageId;
+    private _languageService;
+    constructor(_ctx: worker.IWorkerContext, { languageId, languageOptions }: IArcadeWorkerData);
+    doValidation(modelId: string, context: ApiContext): Promise<Diagnostic[]>;
+    doComplete(modelId: string, position: Position, context: ApiContext): Promise<CompletionList>;
+    doFormat(modelId: string, context: ApiContext): Promise<TextEdit[]>;
+    getApiLibrary(context: ApiContext): Promise<ApiCategory[]>;
+    private _getTextDocument;
 }
+export {};