@arcgis/coding-components 4.31.0-next.4 → 4.31.0-next.40

package/dist/cjs/arcade-defaults-ed0ccdc8.js

@@ -0,0 +1,349 @@
+/*!
+ * 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.40
+ */
+'use strict';
+
+const languageDefaultsBase = require('./language-defaults-base-e8f93cb5.js');
+const index = require('./index-b1aa4d20.js');
+
+/**
+ * Returns the arcade diagnostic service.
+ * Example:
+ * ```ts
+ * const diagnosticService = await getArcadeDiagnosticService();
+ * diagnosticService.onDidChangeDiagnostics(({uri, diaganostics }) => {
+ *  // Filter the diagnostics for the uri of interest
+ *  // Do something with the diagnostics
+ * });
+ * ```
+ */
+async function getArcadeDiagnosticService() {
+    const mode = await getMode();
+    return mode.getArcadeDiagnosticService();
+}
+/**
+ * Returns the arcade worker for the model.
+ * Example:
+ * ```ts
+ * const arcadeWorker = await getArcadeWorker(model.uri);
+ * ```
+ * @returns arcade worker
+ */
+async function getArcadeWorker(uri) {
+    const mode = await getMode();
+    return await mode.getArcadeWorker(uri);
+}
+/**
+ * Request the arcade mode
+ * @returns arcade mode module
+ */
+async function getMode() {
+    return await Promise.resolve().then(function () { return require('./arcade-mode-e4201a06.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 = languageDefaultsBase.main.exports.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: languageDefaultsBase.main.exports.InsertTextMode.asIs,
+            insertTextFormat: languageDefaultsBase.main.exports.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: languageDefaultsBase.main.exports.InsertTextMode.asIs,
+        insertTextFormat: languageDefaultsBase.main.exports.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] = languageDefaultsBase.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, languageDefaultsBase.main.exports.CompletionItemKind.Field),
+        completion: {
+            label: name,
+            detail: name,
+            insertText: name,
+            insertTextMode: languageDefaultsBase.main.exports.InsertTextMode.asIs,
+            insertTextFormat: languageDefaultsBase.main.exports.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 (!languageDefaultsBase.supportedLocales.has(locale)) {
+        return await getSdkPredefinedProfiles("en");
+    }
+    try {
+        const response = await fetch(index.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 (!languageDefaultsBase.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 (!languageDefaultsBase.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 (!languageDefaultsBase.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 (!languageDefaultsBase.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.LanguageDefaultsBase {
+    constructor() {
+        super(...arguments);
+        this._languageId = arcadeLanguageId;
+        this._languageOptions = {};
+    }
+    /**
+     * 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.
+     */
+    async setProfileForModel(modelId, definition, apiContext = { locale: "en" }) {
+        // Convert pre-defined profile to a runtime profile
+        if (languageDefaultsBase.isPredefinedProfile(definition)) {
+            definition = await convertToEditorProfileDefinition(definition, apiContext.locale);
+        }
+        const profileStrings = await languageDefaultsBase.fetchT9nStringsBundle(apiContext.locale, index.getAssetPath("./assets/arcade-language/t9n"), "profile.t9n.");
+        if (!profileStrings) {
+            throw new Error(`Failed to load the language bundle for ${apiContext.locale}`);
+        }
+        this.disposeForModel(modelId);
+        const key = this._getApiKey(modelId);
+        const editorProfile = new languageDefaultsBase.EditorProfile(definition, profileStrings);
+        this._profileMap.set(key, editorProfile);
+        const apiProfile = await arcadeEditorToApiProfile(editorProfile);
+        this.updateApiContextForModel(modelId, {
+            locale: apiContext.locale,
+            profile: apiProfile,
+            snippets: apiContext.snippets,
+        });
+    }
+    /**
+     * Set or update the Arcade language service options.
+     * @param languageOptions The language options to set.
+     */
+    setLanguageOptions(languageOptions = {}) {
+        // Check if options have actually changed.
+        // Avoid restarting the worker when no updates.
+        // Today we only have the 'assetsPath' as a property
+        if (this._languageOptions.assetsPath === languageOptions.assetsPath) {
+            return;
+        }
+        this._languageOptions = { ...this._languageOptions, ...languageOptions };
+        this._onDidChange.fire(this);
+    }
+    /**
+     * Gets the API library for the given model id.
+     * @param modelId The model id for which to get the API library.
+     * @returns The API library for the model.
+     */
+    async getApiLibrary(modelId) {
+        const uri = languageDefaultsBase.Uri.parse(modelId);
+        const worker = await getArcadeWorker(uri);
+        return await worker.getApiLibrary(this.getApiContextForModel(uri));
+    }
+}
+const arcadeDefaults = new ArcadeLanguageServiceDefaults();
+const arcade = {
+    setProfileForModel: arcadeDefaults.setProfileForModel.bind(arcadeDefaults),
+};
+
+exports.arcade = arcade;
+exports.arcadeDefaults = arcadeDefaults;
+exports.getArcadeDiagnosticService = getArcadeDiagnosticService;
+exports.getMode = getMode;

package/dist/cjs/{arcade-mode-f2c3951e.js → arcade-mode-e4201a06.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.4
+ * v4.31.0-next.40
  */
 'use strict';
 
-const languageDefaultsBase = require('./language-defaults-base-4300e691.js');
-require('./index-8b891c40.js');
+const languageDefaultsBase = require('./language-defaults-base-e8f93cb5.js');
 
 var V={False:"false",Null:"null",True:"true"},f={Break:"break",Continue:"continue",Else:"else",For:"for",From:"from",Function:"function",If:"if",Import:"import",Export:"export",In:"in",Return:"return",Var:"var",While:"while"},Ee=["++","--"],Je=["-","+","!","~"],Qe=["=","/=","*=","%=","+=","-="],Ze=["||","&&"],Lt=["|","&",">>","<<",">>>","^","==","!=","<","<=",">",">=","+","-","*","/","%"];var U=[[],[],[]];Ee.forEach(t=>U[t.length-1]?.push(t));Je.forEach(t=>U[t.length-1]?.push(t));Ze.forEach(t=>U[t.length-1]?.push(t));Qe.forEach(t=>U[t.length-1]?.push(t));Lt.forEach(t=>U[t.length-1]?.push(t));var ft=Object.values(f),gt=Object.values(V);gt.map(t=>({label:t,kind:languageDefaultsBase.main.exports.CompletionItemKind.Constant}));ft.map(t=>({label:t,kind:languageDefaultsBase.main.exports.CompletionItemKind.Keyword}));
 
@@ -345,6 +344,7 @@ function isInsertReplaceEdit(edit) {
     return (typeof edit.insert !== "undefined" &&
         typeof edit.replace !== "undefined");
 }
+// TODO: extract this function to common util
 function toCompletionItemKind(kind) {
     const mItemKind = languageDefaultsBase.languages.CompletionItemKind;
     switch (kind) {