@arcgis/coding-components 4.31.0-next.3 → 4.31.0-next.30

package/dist/cjs/{tsMode-36398912.js → tsMode-5559948f.js}

@@ -1,12 +1,11 @@
 /*!
  * All material copyright Esri, All Rights Reserved, unless otherwise specified.
  * See https://js.arcgis.com/4.31/esri/copyright.txt for details.
- * v4.31.0-next.3
+ * v4.31.0-next.30
  */
 'use strict';
 
-const languageDefaultsBase = require('./language-defaults-base-5817af52.js');
-require('./index-be6b2520.js');
+const languageDefaultsBase = require('./language-defaults-base-b33c98c5.js');
 
 /*!-----------------------------------------------------------------------------
  * Copyright (c) Microsoft Corporation. All rights reserved.

package/dist/cjs/{typescript-608a420b.js → typescript-6dfdd308.js}

@@ -1,12 +1,11 @@
 /*!
  * All material copyright Esri, All Rights Reserved, unless otherwise specified.
  * See https://js.arcgis.com/4.31/esri/copyright.txt for details.
- * v4.31.0-next.3
+ * v4.31.0-next.30
  */
 'use strict';
 
-const languageDefaultsBase = require('./language-defaults-base-5817af52.js');
-require('./index-be6b2520.js');
+const languageDefaultsBase = require('./language-defaults-base-b33c98c5.js');
 
 /*!-----------------------------------------------------------------------------
  * Copyright (c) Microsoft Corporation. All rights reserved.

package/dist/components/arcade-defaults.js

@@ -1,11 +1,12 @@
 /*!
  * All material copyright Esri, All Rights Reserved, unless otherwise specified.
  * See https://js.arcgis.com/4.31/esri/copyright.txt for details.
- * v4.31.0-next.3
+ * v4.31.0-next.30
  */
 import { Uri } from 'monaco-editor';
-import { L as LanguageDefaultsBase, i as isPredefinedProfile, c as convertToEditorProfileDefinition, E as EditorProfile } from './language-defaults-base.js';
-import { f as fetchT9nStringsBundle } from './index2.js';
+import { f as fieldsToProfileValues, i as isPredefinedProfile, a as isFeatureSetCollectionDefinition, b as isFeatureSetDefinition, c as isFeatureDefinition, L as LanguageDefaultsBase, E as EditorProfile } from './language-defaults-base.js';
+import { s as supportedLocales, f as fetchT9nStringsBundle } from './index2.js';
+import { CompletionItemKind, InsertTextMode, InsertTextFormat } from 'vscode-languageserver-types';
 import { getArcgisAssetPath as getAssetPath } from "./arcgis-assets.js";
 
 /**
@@ -43,6 +44,239 @@ async function getMode() {
     return await import('./arcade-mode.js');
 }
 
+// #region convert editor profile to apiProfile
+/**
+ * Converts an editor profile to an api profile.
+ * The api profile is an optimized version of the editor profile designed for minimal data transfer between the main thread and the worker.
+ */
+async function arcadeEditorToApiProfile(editorProfile) {
+    const { apiVersion, bundles, hiddenApiItems } = editorProfile.toEditorProfileDefinition();
+    const variables = await variablesToLSVariable(editorProfile.dictionaryVariables);
+    return { apiVersion, bundles, variables, hiddenApiItems: hiddenApiItems?.map((s) => s.toLowerCase()) };
+}
+async function variablesToLSVariable(editorVariables, kind = CompletionItemKind.Variable) {
+    return await Promise.all(editorVariables.map(async (editorVariable) => {
+        switch (editorVariable.type) {
+            case "dictionary":
+                return await dictionaryToLSDictionary(editorVariable, kind);
+            case "feature":
+                return await featureToLSFeature(editorVariable, kind);
+            default:
+                return variableToLSVariable(editorVariable, kind);
+        }
+    }));
+}
+function variableToLSVariable(editorVariable, kind) {
+    const { name, type } = editorVariable;
+    const description = editorVariable.getDescription();
+    return {
+        name,
+        description,
+        type,
+        completion: {
+            label: name,
+            detail: name,
+            insertText: name,
+            insertTextMode: InsertTextMode.asIs,
+            insertTextFormat: InsertTextFormat.PlainText,
+            kind,
+            documentation: { kind: "markdown", value: description },
+        },
+    };
+}
+async function featureToLSFeature(editorFeature, kind) {
+    // Get the source for the definition
+    const source = await editorFeature.loadSource();
+    const { name } = editorFeature;
+    const description = editorFeature.getDescription();
+    const resultCompletion = {
+        label: name,
+        detail: name,
+        insertText: name,
+        insertTextMode: InsertTextMode.asIs,
+        insertTextFormat: InsertTextFormat.PlainText,
+        kind,
+    };
+    const result = {
+        name,
+        description,
+        type: "dictionary",
+        properties: [],
+        completion: resultCompletion,
+    };
+    // No source definition, then it will be a feature without any known fields
+    if (!source) {
+        return result;
+    }
+    // Create properties for the fields and the aliases
+    // Also improve the feature completion documentation
+    const [properties, featureCompletionDescription] = fieldsToProfileValues(source.fields, description, true);
+    result.properties = properties;
+    resultCompletion.documentation = { kind: "markdown", value: featureCompletionDescription };
+    return result;
+}
+async function dictionaryToLSDictionary(editorDictionary, kind) {
+    const { name, dictionaryVariables: variables } = editorDictionary;
+    const description = editorDictionary.getDescription();
+    const completionDescription = variables.reduce((previous, p) => {
+        if (previous !== "") {
+            previous += "  \n  \n";
+        }
+        previous += `**${p.name}**  \n${p.type}`;
+        const description = p.getDescription();
+        if (description) {
+            previous += `  \n${description}`;
+        }
+        return previous;
+    }, description);
+    return {
+        name,
+        description,
+        type: "dictionary",
+        properties: await variablesToLSVariable(variables, CompletionItemKind.Field),
+        completion: {
+            label: name,
+            detail: name,
+            insertText: name,
+            insertTextMode: InsertTextMode.asIs,
+            insertTextFormat: InsertTextFormat.PlainText,
+            kind,
+            documentation: { kind: "markdown", value: completionDescription },
+        },
+    };
+}
+// #endregion
+// #region predefined profile to editor profile definition
+/**
+ * Get a PredefinedProfile for a locale. If not already loaded then fetch it.
+ * If the locale doesn't exist or the locale profile file doesn't exist then returns
+ * the english version of the profile.
+ */
+async function getSdkPredefinedProfiles(locale = "en") {
+    const profiles = sdkPredefinedProfilesMap.get(locale);
+    if (profiles) {
+        return profiles;
+    }
+    if (!supportedLocales.has(locale)) {
+        return await getSdkPredefinedProfiles("en");
+    }
+    try {
+        const response = await fetch(getAssetPath(`./assets/arcade-language/profiles/arcade-profiles.t9n.${locale}.json`));
+        if (response.ok) {
+            return cacheSdkPredefinedProfiles(locale, (await response.json()));
+        }
+        if (locale === "en") {
+            return null;
+        }
+        return await getSdkPredefinedProfiles("en");
+    }
+    catch {
+        return null;
+    }
+}
+const sdkPredefinedProfilesMap = new Map();
+/**
+ * Convert a stored profile into a PredefinedProfile and add it to the in-memory
+ * Map of profiles per locale.
+ */
+function cacheSdkPredefinedProfiles(locale, profiles) {
+    const map = new Map();
+    profiles.forEach((profile) => {
+        map.set(profile.id, profile);
+    });
+    sdkPredefinedProfilesMap.set(locale, map);
+    return map;
+}
+async function getSdkPredefinedProfile(id, locale = "en") {
+    const profiles = await getSdkPredefinedProfiles(locale);
+    return profiles?.get(id) ?? null;
+}
+function isExtendedPredefinedProfileDefinition(item) {
+    return !!item && typeof item === "object" && "additionalVariables" in item && Array.isArray(item.additionalVariables);
+}
+function convertApiVariables(variables) {
+    return variables?.map(convertApiVariable);
+}
+function convertApiVariable(variable) {
+    switch (variable.type) {
+        case "dictionary":
+            return {
+                ...variable,
+                type: variable.type,
+                properties: convertApiVariables(variable.properties),
+            };
+        case "array": {
+            return {
+                ...variable,
+                type: variable.type,
+                elementType: { type: "number", name: "number" },
+            };
+        }
+        default:
+            return { ...variable, type: variable.type };
+    }
+}
+async function convertToEditorProfileDefinition(predefinedProfile, locale = "en") {
+    if (!isPredefinedProfile(predefinedProfile)) {
+        return undefined;
+    }
+    const sdkPredefinedProfile = await getSdkPredefinedProfile(predefinedProfile.id, locale);
+    if (!sdkPredefinedProfile) {
+        return undefined;
+    }
+    const editorProfile = {
+        bundles: [...sdkPredefinedProfile.bundles],
+        variables: [],
+        hiddenApiItems: predefinedProfile.hiddenApiItems?.map((s) => s.toLowerCase()),
+    };
+    // Merge the SDK variables' definitions/properties with the predefined profile definitions.
+    sdkPredefinedProfile.variables.forEach((predefinedVariable) => {
+        // Don't include disabled variables
+        if (predefinedProfile.disabledVariables?.includes(predefinedVariable.name)) {
+            return;
+        }
+        // Try to get a definition from the predefined profile, for the variable that needs one.
+        const definition = predefinedProfile.definitions[predefinedVariable.name];
+        // Note: Something is weird with TS. The sdkVariables are being casted to the wrong type
+        // despite the type checking from the switch statement.
+        switch (predefinedVariable.type) {
+            case "dictionary": {
+                // For dictionary, we support properties overrride
+                return editorProfile.variables.push(convertApiVariable({
+                    ...predefinedVariable,
+                    type: predefinedVariable.type,
+                    properties: Array.isArray(definition) ? [...definition] : predefinedVariable.properties,
+                }));
+            }
+            case "feature":
+                // If the definition is not valid, then we don't include it.
+                if (!isFeatureDefinition(definition)) {
+                    return;
+                }
+                return editorProfile.variables.push({ ...predefinedVariable, type: predefinedVariable.type, definition });
+            case "featureSet":
+                // If the definition is not valid, then we don't include it.
+                if (!isFeatureSetDefinition(definition)) {
+                    return;
+                }
+                return editorProfile.variables.push({ ...predefinedVariable, type: predefinedVariable.type, definition });
+            case "featureSetCollection":
+                // If the definition is not valid, then we don't include it.
+                if (!isFeatureSetCollectionDefinition(definition)) {
+                    return;
+                }
+                return editorProfile.variables.push({ ...predefinedVariable, type: predefinedVariable.type, definition });
+            default:
+                return editorProfile.variables.push(convertApiVariable(predefinedVariable));
+        }
+    });
+    if (isExtendedPredefinedProfileDefinition(predefinedProfile)) {
+        editorProfile.variables.push(...(predefinedProfile.additionalVariables ?? []));
+    }
+    return editorProfile;
+}
+// #endregion
+
 const arcadeLanguageId = "arcade";
 class ArcadeLanguageServiceDefaults extends LanguageDefaultsBase {
     constructor() {
@@ -73,7 +307,7 @@ class ArcadeLanguageServiceDefaults extends LanguageDefaultsBase {
         const key = this._getApiKey(modelId);
         const editorProfile = new EditorProfile(definition, profileStrings);
         this._profileMap.set(key, editorProfile);
-        const apiProfile = await editorProfile.toLSProfile();
+        const apiProfile = await arcadeEditorToApiProfile(editorProfile);
         this.updateApiContextForModel(modelId, {
             locale: apiContext.locale,
             profile: apiProfile,

package/dist/components/arcade-language-features.js

@@ -0,0 +1,271 @@
+/*!
+ * All material copyright Esri, All Rights Reserved, unless otherwise specified.
+ * See https://js.arcgis.com/4.31/esri/copyright.txt for details.
+ * v4.31.0-next.30
+ */
+import { editor, MarkerSeverity, Range, languages } from 'monaco-editor';
+import { DiagnosticSeverity, InsertTextFormat, CompletionItemKind } from 'vscode-languageserver-types';
+import { t as debounce } from './index2.js';
+
+//#region Diagnostic
+class DiagnosticsAdapter {
+    constructor(_languageId, _worker, { defaults, diagnosticsService, }) {
+        this._languageId = _languageId;
+        this._worker = _worker;
+        this._disposables = [];
+        this._listener = new Map();
+        this._diagnosticsService = diagnosticsService;
+        this._defaults = defaults;
+        const onModelAdd = (model) => {
+            const languageId = model.getLanguageId();
+            if (languageId !== this._languageId) {
+                return;
+            }
+            const debouncedValidate = debounce(() => {
+                this._doValidate(model, languageId).catch((err) => {
+                    throw err;
+                });
+            });
+            this._listener.set(model.uri.toString(), model.onDidChangeContent(debouncedValidate));
+            this._doValidate(model, languageId).catch(console.error);
+        };
+        const onModelRemoved = (model) => {
+            const uriStr = model.uri.toString();
+            editor.setModelMarkers(model, this._languageId, []);
+            const listener = this._listener.get(uriStr);
+            if (listener) {
+                listener.dispose();
+                this._listener.delete(uriStr);
+            }
+        };
+        this._disposables.push(editor.onDidCreateModel(onModelAdd));
+        this._disposables.push(editor.onWillDisposeModel((model) => {
+            onModelRemoved(model);
+        }));
+        this._disposables.push(editor.onDidChangeModelLanguage((event) => {
+            onModelRemoved(event.model);
+            onModelAdd(event.model);
+        }));
+        this._disposables.push(defaults.onDidChange(() => {
+            editor.getModels().forEach((model) => {
+                if (model.getLanguageId() === this._languageId) {
+                    onModelRemoved(model);
+                    onModelAdd(model);
+                }
+            });
+        }));
+        this._disposables.push(defaults.onModelContextDidChange((key) => {
+            editor.getModels().forEach((model) => {
+                if (model.getLanguageId() === this._languageId && model.uri.toString() === key) {
+                    this._doValidate(model, this._languageId).catch(console.error);
+                }
+            });
+        }));
+        this._disposables.push({
+            dispose: () => {
+                this._listener.forEach((value) => value.dispose());
+                this._listener.clear();
+            },
+        });
+        editor.getModels().forEach(onModelAdd);
+    }
+    dispose() {
+        this._disposables.forEach((d) => d.dispose());
+        this._disposables = [];
+    }
+    async _doValidate(model, languageId) {
+        if (!model.isAttachedToEditor()) {
+            return;
+        }
+        try {
+            const workerProxy = await this._worker(model.uri);
+            const context = this._defaults.getApiContextForModel(model.uri);
+            const diagnostics = await workerProxy.doValidation(model.uri.toString(), context);
+            const markers = diagnostics.map((d) => toMarker(model.uri, d));
+            this._diagnosticsService.fireDiagnosticsChange(model.uri, diagnostics);
+            editor.setModelMarkers(model, languageId, markers);
+        }
+        catch (err) {
+            console.error(err);
+        }
+    }
+}
+function toSeverity(languageServiceSeverity) {
+    switch (languageServiceSeverity) {
+        case DiagnosticSeverity.Error:
+            return MarkerSeverity.Error;
+        case DiagnosticSeverity.Warning:
+            return MarkerSeverity.Warning;
+        case DiagnosticSeverity.Information:
+            return MarkerSeverity.Info;
+        case DiagnosticSeverity.Hint:
+            return MarkerSeverity.Hint;
+        default:
+            return MarkerSeverity.Info;
+    }
+}
+function toMarker(_resource, diag) {
+    // Diagnostics positions are zero-based, MarkerData are 1-based
+    return {
+        severity: toSeverity(diag.severity),
+        startLineNumber: diag.range.start.line + 1,
+        startColumn: diag.range.start.character + 1,
+        endLineNumber: diag.range.end.line + 1,
+        endColumn: diag.range.end.character + 1,
+        message: diag.message,
+    };
+}
+//#endregion
+//#region Completion
+function fromPosition(position) {
+    // Language service is zero based
+    return { character: position.column - 1, line: position.lineNumber - 1 };
+}
+function toRange(range) {
+    return new Range(range.start.line + 1, range.start.character + 1, range.end.line + 1, range.end.character + 1);
+}
+function toTextEdit(textEdit) {
+    return {
+        range: toRange(textEdit.range),
+        text: textEdit.newText,
+    };
+}
+function isInsertReplaceEdit(edit) {
+    return (typeof edit.insert !== "undefined" &&
+        typeof edit.replace !== "undefined");
+}
+// TODO: extract this function to common util
+function toCompletionItemKind(kind) {
+    const mItemKind = languages.CompletionItemKind;
+    switch (kind) {
+        case CompletionItemKind.Text:
+            return mItemKind.Text;
+        case CompletionItemKind.Method:
+            return mItemKind.Method;
+        case CompletionItemKind.Function:
+            return mItemKind.Function;
+        case CompletionItemKind.Constructor:
+            return mItemKind.Constructor;
+        case CompletionItemKind.Field:
+            return mItemKind.Field;
+        case CompletionItemKind.Variable:
+            return mItemKind.Variable;
+        case CompletionItemKind.Class:
+            return mItemKind.Class;
+        case CompletionItemKind.Interface:
+            return mItemKind.Interface;
+        case CompletionItemKind.Module:
+            return mItemKind.Module;
+        case CompletionItemKind.Property:
+            return mItemKind.Property;
+        case CompletionItemKind.Unit:
+            return mItemKind.Unit;
+        case CompletionItemKind.Value:
+            return mItemKind.Value;
+        case CompletionItemKind.Enum:
+            return mItemKind.Enum;
+        case CompletionItemKind.Keyword:
+            return mItemKind.Keyword;
+        case CompletionItemKind.Snippet:
+            return mItemKind.Snippet;
+        case CompletionItemKind.Color:
+            return mItemKind.Color;
+        case CompletionItemKind.File:
+            return mItemKind.File;
+        case CompletionItemKind.Reference:
+            return mItemKind.Reference;
+        case CompletionItemKind.Folder:
+            return mItemKind.Folder;
+        case CompletionItemKind.EnumMember:
+            return mItemKind.EnumMember;
+        case CompletionItemKind.Constant:
+            return mItemKind.Constant;
+        case CompletionItemKind.Struct:
+            return mItemKind.Struct;
+        case CompletionItemKind.Event:
+            return mItemKind.Event;
+        case CompletionItemKind.Operator:
+            return mItemKind.Operator;
+        case CompletionItemKind.TypeParameter:
+            return mItemKind.TypeParameter;
+        default:
+            return mItemKind.Property;
+    }
+}
+class CompletionProvider {
+    constructor(_worker, _defaults) {
+        this._worker = _worker;
+        this._defaults = _defaults;
+        this.triggerCharacters = [".", "("];
+    }
+    async provideCompletionItems(model, position) {
+        const worker = await this._worker(model.uri);
+        const context = this._defaults.getApiContextForModel(model.uri);
+        const completionList = await worker.doComplete(model.uri.toString(), fromPosition(position), context);
+        const wordInfo = model.getWordUntilPosition(position);
+        const wordRange = new Range(position.lineNumber, wordInfo.startColumn, position.lineNumber, wordInfo.endColumn);
+        const items = completionList.items.map((entry) => {
+            const item = {
+                label: entry.label,
+                insertText: entry.insertText || entry.label,
+                sortText: entry.sortText,
+                filterText: entry.filterText,
+                detail: entry.detail,
+                range: wordRange,
+                kind: toCompletionItemKind(entry.kind),
+            };
+            if (entry.textEdit) {
+                if (isInsertReplaceEdit(entry.textEdit)) {
+                    item.range = {
+                        insert: toRange(entry.textEdit.insert),
+                        replace: toRange(entry.textEdit.replace),
+                    };
+                }
+                else {
+                    item.range = toRange(entry.textEdit.range);
+                }
+                item.insertText = entry.textEdit.newText;
+            }
+            if (entry.additionalTextEdits) {
+                item.additionalTextEdits = entry.additionalTextEdits.map(toTextEdit);
+            }
+            if (entry.insertTextFormat === InsertTextFormat.Snippet) {
+                item.insertTextRules = languages.CompletionItemInsertTextRule.InsertAsSnippet;
+            }
+            if (entry.documentation) {
+                if (typeof entry.documentation === "string") {
+                    item.documentation = entry.documentation;
+                }
+                else {
+                    item.documentation = {
+                        supportThemeIcons: false,
+                        value: entry.documentation.value,
+                        supportHtml: true,
+                    };
+                }
+            }
+            return item;
+        });
+        return {
+            incomplete: completionList.isIncomplete,
+            suggestions: items,
+        };
+    }
+}
+//#endregion
+//#region Formatter
+class FormattingProvider {
+    constructor(_worker, _defaults) {
+        this._worker = _worker;
+        this._defaults = _defaults;
+    }
+    async provideDocumentFormattingEdits(model) {
+        const worker = await this._worker(model.uri);
+        const context = this._defaults.getApiContextForModel(model.uri.toString());
+        const edits = await worker.doFormat(model.uri.toString(), context);
+        return edits.map((e) => ({ range: toRange(e.range), text: e.newText }));
+    }
+}
+//#endregion
+
+export { CompletionProvider as C, DiagnosticsAdapter as D, FormattingProvider as F, toCompletionItemKind as t };