@arcgis/coding-components 4.31.0-next.2 → 4.31.0-next.21

package/dist/components/sql-expression-fields.js

@@ -0,0 +1,102 @@
+/*!
+ * 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.21
+ */
+import { proxyCustomElement, HTMLElement, createEvent, forceUpdate, h } from '@stencil/core/internal/client';
+import { u as useControllerManager } from './chunk-2JTWBRMN.js';
+import { s as sqlExprDefaults } from './sql-expr-defaults.js';
+import "@esri/calcite-components/dist/components/calcite-block.js";
+import "@esri/calcite-components/dist/components/calcite-flow.js";
+import "@esri/calcite-components/dist/components/calcite-flow-item.js";
+import "@esri/calcite-components/dist/components/calcite-list.js";
+import "@esri/calcite-components/dist/components/calcite-list-item.js";
+import "@esri/calcite-components/dist/components/calcite-action.js";
+
+const sqlExpressionFieldsCss = ":host calcite-flow{height:100%}:host calcite-list-item-group{background-color:var(--calcite-color-foreground-2)}";
+const ArcgisSqlExpressionFieldsStyle0 = sqlExpressionFieldsCss;
+
+const __cmpMeta = [1,"arcgis-sql-expression-fields",{"loading":[1028],"modelId":[1025,"model-id"],"_mutationCounter":[32],"_flowItemRenderers":[32],"_filterValue":[32]},undefined,{"modelId":["modelIdPropChanged"]}];
+const SqlExpressionFields = /*@__PURE__*/ proxyCustomElement(class SqlExpressionFields extends HTMLElement {
+    connectedCallback() { this.manager._connectedCallback(); }
+    constructor() {
+        super();
+        this.__registerHost();
+this.constructor.__registerControllers = ()=>__cmpMeta[2]??{};
+        this.__attachShadow();
+        this.arcgisClose = createEvent(this, "arcgisClose", 3);
+        this.arcgisFieldSelected = createEvent(this, "arcgisFieldSelected", 3);
+        this.manager = useControllerManager(this,forceUpdate);
+        // #endregion
+        // #region Private Methods
+        this._handleSelectField = (event) => {
+            if (event.target instanceof HTMLElement) {
+                const tagName = event.target.tagName;
+                switch (tagName.toLowerCase()) {
+                    case "calcite-list-item":
+                        // TODO: why is value missing from HTMLCalciteListElement type?
+                        this.arcgisFieldSelected.emit(event.target.value ?? "");
+                        break;
+                    case "calcite-action":
+                        event.stopPropagation();
+                        break;
+                }
+            }
+        };
+        this._emitClose = () => {
+            this.arcgisClose.emit();
+        };
+        this._mutationCounter = 1;
+        this._flowItemRenderers = [];
+        this._filterValue = "";
+        this.loading = false;
+        this.modelId = undefined;
+    }
+    modelIdPropChanged() {
+        this._flowItemRenderers = [];
+    }
+    // #endregion
+    // #region Lifecycle
+    disconnectedCallback() {
+        this.manager._disconnectedCallback();
+        this._flowObserver?.disconnect();
+    }
+    // #endregion
+    render() {
+        const layer = sqlExprDefaults.getFeatureLayerForModel(this.modelId ?? "");
+        if (this.loading || !this.modelId || !layer) {
+            return h("calcite-block", { heading: "Available Fields" });
+        }
+        return (h("calcite-flow", null, h("calcite-flow-item", { heading: "Available Fields", closable: true, description: "Select a field to insert into the expression", onCalciteFlowItemClose: this._emitClose }, h("calcite-list", { filterEnabled: true }, layer.fields.map((field) => (h("calcite-list-item", { key: field.name, onClick: this._handleSelectField, label: field.name, description: field.alias, value: field.name }, field.domain && (h("calcite-action", { slot: "actions-end", text: "open", icon: "chevron-right", onClick: () => {
+                const domain = field.domain;
+                if (domain.type === "coded-value") {
+                    this._flowItemRenderers = [
+                        ...this._flowItemRenderers,
+                        () => (h("calcite-flow-item", { closable: true, heading: "Domains", description: field.name, onCalciteFlowItemClose: this._emitClose }, h("calcite-list", null, domain.codedValues.map((value) => (h("calcite-list-item", { key: value.code, onClick: this._handleSelectField, label: value.name, description: String(value.code), value: value.code })))))),
+                    ];
+                }
+            } }))))))), this._flowItemRenderers.map((renderer) => renderer())));
+    }
+    static get assetsDirs() { return ["assets"]; }
+    get el() { return this; }
+    static get watchers() { return {
+        "modelId": ["modelIdPropChanged"]
+    }; }
+    static get style() { return ArcgisSqlExpressionFieldsStyle0; }
+}, __cmpMeta);
+function defineCustomElement() {
+    if (typeof customElements === "undefined") {
+        return;
+    }
+    const components = ["arcgis-sql-expression-fields"];
+    components.forEach(tagName => { switch (tagName) {
+        case "arcgis-sql-expression-fields":
+            if (!customElements.get(tagName)) {
+                customElements.define(tagName, SqlExpressionFields);
+            }
+            break;
+    } });
+}
+defineCustomElement();
+
+export { SqlExpressionFields as S, defineCustomElement as d };

package/dist/components/useT9n.js

@@ -1,36 +1,73 @@
 /*!
  * 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.2
+ * v4.31.0-next.21
  */
-import { m as makeController } from './chunk-IHYYRFLQ.js';
-import { p as startLocaleObserver, r as getElementLocales } from './index2.js';
+import { m as makeController, w as watch } from './chunk-2JTWBRMN.js';
+import { n as startLocaleObserver, p as getElementLocales } from './index2.js';
 import { getArcgisAssetPath as getAssetPath } from "./arcgis-assets.js";
 
-var makeT9nController = (getAssetPath) => ({ blocking = false, name } = {}) => (
+var makeT9nController = (getAssetPath) => (options = {}) => (
   // eslint-disable-next-line @typescript-eslint/promise-function-async
   makeController((component, controller) => {
+    const componentWithOverrides = component;
     controller.onLifecycle(
       () => startLocaleObserver(
         component.el,
         getAssetPath("./assets"),
         ({ t9nLocale, t9nStrings, lang }) => {
-          controller.exports = { ...t9nStrings, _lang: lang, _t9nLocale: t9nLocale };
+          const withoutOverrides = {
+            ...t9nStrings,
+            _lang: lang,
+            _t9nLocale: t9nLocale,
+            _loading: false
+          };
+          controller.exports = withoutOverrides;
           const label = t9nStrings.componentLabel ?? t9nStrings.widgetLabel;
           if (typeof label === "string" && "label" in component && component.label == null) {
             component.label ?? (component.label = label);
           }
+          applyOverrides(componentWithOverrides.messageOverrides);
         },
-        name
+        options.name
       )
     );
-    if (blocking) {
+    function applyOverrides(messageOverrides) {
+      const currentValue = controller.exports;
+      const rawMessages = currentValue._original ?? currentValue;
+      const updated = deepMerge(rawMessages, messageOverrides);
+      updated._original = rawMessages;
+      controller.exports = updated;
+    }
+    if ("messageOverrides" in componentWithOverrides) {
+      controller.onLifecycle(() => watch(componentWithOverrides, "messageOverrides", applyOverrides));
+    }
+    if (options.blocking) {
       return controller.ready;
     }
     const locale = getElementLocales(component.el);
-    return { _lang: locale.lang, _t9nLocale: locale.t9nLocale };
+    const pending = {
+      _lang: locale.lang,
+      _t9nLocale: locale.t9nLocale,
+      _loading: true
+    };
+    return pending;
   })
 );
+function deepMerge(original, overwrites) {
+  if (!overwrites) {
+    return original;
+  }
+  const merged = { ...original };
+  Object.entries(overwrites).forEach(([key, value]) => {
+    if (typeof value === "object") {
+      merged[key] = deepMerge(original[key], value);
+    } else {
+      merged[key] = value ?? original[key];
+    }
+  });
+  return merged;
+}
 
 const useT9n = makeT9nController(getAssetPath);
 

package/dist/components/utilities.js

@@ -1,7 +1,7 @@
 /*!
  * 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.2
+ * v4.31.0-next.21
  */
 import { d as createFilterExpression } from './index2.js';
 

package/dist/esm/{app-globals-59faaf33.js → app-globals-6d0ca11d.js}

@@ -1,7 +1,7 @@
 /*!
  * 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.2
+ * v4.31.0-next.21
  */
 const globalScripts = () => {};
 

package/dist/esm/arcade-defaults-066445c4.js

@@ -0,0 +1,344 @@
+/*!
+ * 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.21
+ */
+import { m as main, f as fieldsToProfileValues, i as isPredefinedProfile, a as isFeatureSetCollectionDefinition, b as isFeatureSetDefinition, c as isFeatureDefinition, s as supportedLocales, L as LanguageDefaultsBase, d as fetchT9nStringsBundle, E as EditorProfile, U as Uri } from './language-defaults-base-85a7f476.js';
+import { g as getAssetPath } from './index-0edd9846.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 import('./arcade-mode-abf1e1cf.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 = 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: main.exports.InsertTextMode.asIs,
+            insertTextFormat: 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: main.exports.InsertTextMode.asIs,
+        insertTextFormat: 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] = 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, main.exports.CompletionItemKind.Field),
+        completion: {
+            label: name,
+            detail: name,
+            insertText: name,
+            insertTextMode: main.exports.InsertTextMode.asIs,
+            insertTextFormat: 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 (!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() {
+        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 (isPredefinedProfile(definition)) {
+            definition = await convertToEditorProfileDefinition(definition, apiContext.locale);
+        }
+        const profileStrings = await fetchT9nStringsBundle(apiContext.locale, 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 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 = 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),
+};
+
+export { arcade as a, arcadeDefaults as b, getMode as c, getArcadeDiagnosticService as g };