@esri/solutions-components 0.8.39 → 0.8.40

package/dist/solutions-components/utils/interfaces.ts

@@ -275,7 +275,6 @@ export interface ISolutionTemplateEdits {
   [templateId: string]: ISolutionTemplateEdit;
 }
 
-//???
 export interface ISolutionModel {
   dataModel: monaco.editor.ITextModel;
   dataOriginValue: string;
@@ -306,7 +305,6 @@ export interface ISolutionModel {
 export interface ISolutionModels {
   [key: string]: ISolutionModel;
 }
-//???
 
 /**
  * Feature service name and whether the service is enabled for SR configuration

package/dist/solutions-components/utils/solution-store.ts

@@ -53,11 +53,12 @@ import {
 //   * solutionItemId: [string] id of the current solution
 //   * defaultWkid: [any] value of the solution's `params.wkid.default` data property, which may be undefined
 //   * solutionData: [ISolutionItemData] the solution's data, which is modified in-place
-//   * featureServices: [array] a list of Feature service enablement status for SR configuration
+//   * featureServices: [array] a list of Feature services that use a spatial reference var
 //   * spatialReferenceInfo: [object] the current spatial reference (if enabled) and the services that use it
 //       * enabled: [boolean] use the spatial reference
-//       * services: [object] services using this spatial reference organized by the service name
-//       * spatialReference: [object] the spatial reference display
+//       * services: [object] for each service in featureServices by service name, a switch indicating if the
+//           custom spatial reference parameter is enabled/disabled
+//       * spatialReference: [object] the custom spatial reference wkid
 //
 // Store singleton method:
 //   * Store: Creates singleton instance when accessed; default export from module.
@@ -79,7 +80,7 @@ import {
 //
 //--------------------------------------------------------------------------------------------------------------------//
 
-interface SolutionStoreData {
+interface ISolutionStoreData {
   solutionItemId: string,
   defaultWkid: string,
   solutionData: ISolutionItemData,
@@ -88,7 +89,7 @@ interface SolutionStoreData {
   spatialReferenceInfo: ISolutionSpatialReferenceInfo
 }
 
-const EmptySolutionStore: SolutionStoreData = {
+const EmptySolutionStore: ISolutionStoreData = {
   solutionItemId: "",
   defaultWkid: undefined,
   solutionData: { metadata: {}, templates: [] },
@@ -374,14 +375,12 @@ class SolutionStore
    */
   protected _flagStoreHasChanges(flagHasChanges: boolean): void {
     // Event for notifying if the store has changes or not
-    if (this._hasChanges !== flagHasChanges) {
-      window.dispatchEvent(new CustomEvent("solutionStoreHasChanges", {
-        detail: flagHasChanges,
-        bubbles: true,
-        cancelable: false,
-        composed: true
-      }));
-    }
+    window.dispatchEvent(new CustomEvent("solutionStoreHasChanges", {
+      detail: flagHasChanges,
+      bubbles: true,
+      cancelable: false,
+      composed: true
+    }));
 
     this._hasChanges = flagHasChanges;
   }

package/dist/solutions-components/utils/templates.ts

@@ -24,12 +24,13 @@ import {
   //IItemShare,
   IOrganizationVariableItem,
   //IResourcePath,
-  //SolutionModels,
+  ISolutionModels,
   //ISolutionSpatialReferenceInfo,
   IVariableItem
 } from '../utils/interfaces';
 import {
-  IItemTemplate
+  IItemTemplate,
+  getProp
 } from '@esri/solution-common';
 
 //--------------------------------------------------------------------------
@@ -38,6 +39,31 @@ import {
 //
 //--------------------------------------------------------------------------
 
+/**
+ * Gets a list of Feature Services that are not views along with an enabled property that indicates
+ * if the service currently uses a spatial reference variable.
+ *
+ * @param templates a list of item templates from the solution
+ *
+ * @returns a list of feature service names and an enabled property to indicate
+ * if they currently use a spatial reference variable.
+ */
+export function getFeatureServices(
+  templates: IItemTemplate[]
+): any[] {
+  return templates.reduce((prev, cur) => {
+    const name: string = cur.item.title || cur.item.name;
+    if (cur.type === "Feature Service" &&
+      cur.item.typeKeywords.indexOf("View Service") < 0 &&
+      prev.indexOf(name) < 0
+    ) {
+      const wkid = getProp(cur, "properties.service.spatialReference.wkid");
+      prev.push({ name, enabled: wkid.toString().startsWith("{{params.wkid||")});
+    }
+    return prev;
+  }, []);
+}
+
 /**
  * Sort the solution items
  *
@@ -131,6 +157,83 @@ export function getItemHierarchy(
   return hierarchy;
 }
 
+/**
+ * Create and store text models for the editor as well as other key values such as the original values
+ * that can be used to clear any temp edits.
+ *
+ * @param templates a list of item templates from the solution
+ *
+ * @returns a list of models and key values
+ */
+export function getModels(templates: any[]): ISolutionModels {
+  const ids: string[] = [];
+  const models: ISolutionModels = {};
+  const monacoDefined = typeof(monaco) !== "undefined";
+  templates.forEach(t => {
+    if (ids.indexOf(t.itemId) < 0) {
+      ids.push(t.itemId);
+      models[t.itemId] = {
+        dataModel: monacoDefined ? monaco.editor.createModel(JSON.stringify(t.data, null, '\t'), "json") : undefined,
+        dataOriginValue: JSON.stringify(t.data),
+        propsModel: monacoDefined ? monaco.editor.createModel(JSON.stringify(t.properties, null, '\t'), "json") : undefined,
+        propsOriginValue: JSON.stringify(t.properties),
+        propsDiffOriginValue: JSON.stringify(t.properties),
+        state: undefined,
+        shareInfo: undefined,
+        isEditing: false,
+        itemId: t.itemId,
+        updateItemValues: {},
+        originalItemValues: {},
+        name: t.item?.name,
+        title: t.item?.title,
+        itemOriginValue: JSON.stringify(t.item),
+        spatialReference: t.properties?.service?.spatialReference,
+        resources: [], //???
+        resourceFilePaths: [], //???
+        sourceResourceFilePaths: [], //???
+        thumbnailOrigin: undefined, //???
+        thumbnailNew: undefined, //???
+        type: t.type
+      };
+    }
+  });
+  return models;
+}
+
+/**
+ * Set key organization variables we will allow users to insert at runtime
+ *
+ * @param translations nls translation object
+ *
+ * @returns a list of variables for the organization
+ */
+export function getOrganizationVariables(
+  translations: any
+): IOrganizationVariableItem[] {
+  const orgVars: IOrganizationVariableItem[] = [{
+    id: "",
+    title: translations.geocodeUrl,
+    value: "{{organization.helperServices.geocode:getDefaultLocatorURL}}"
+  }, {
+    id: "",
+    title: translations.geometryUrl,
+    value: "{{organization.helperServices.geometry.url}}"
+  }, {
+    id: "",
+    title: translations.portalBaseUrl,
+    value: "{{portalBaseUrl}}"
+  }, {
+    id: "",
+    title: translations.routeUrl,
+    value: "{{organization.helperServices.route.url}}"
+  }, {
+    id: "",
+    title: translations.solutionItemExtent,
+    value: "{{solutionItemExtent}}"
+  }];
+  return orgVars;
+}
+
 /**
  * Explore the solution item templates for variables we will allow users to insert at runtime
  *
@@ -181,37 +284,29 @@ export function getSolutionVariables(
 }
 
 /**
- * Set key organization variables we will allow users to insert at runtime
+ * Stores basic spatial reference information that is used to determine if a custom spatial reference parameter will
+ * be exposed while deploying this solution and if so what feature services will support it and what will the default wkid be
  *
- * @param translations nls translation object
+ * @param services a list of objects with service name and enabled property (indicates if they currently use a spatial reference var)
+ * @param data the data object of a solution item
  *
- * @returns a list of variables for the organization
+ * @returns an object that stores if a custom spatial reference parameter is enabled/disabled,
+ * a list of services and if they are enabled/disabled, and the default wkid
  */
-export function getOrganizationVariables(
-  translations: any
-): IOrganizationVariableItem[] {
-  const orgVars: IOrganizationVariableItem[] = [{
-    id: "",
-    title: translations.geocodeUrl,
-    value: "{{organization.helperServices.geocode:getDefaultLocatorURL}}"
-  }, {
-    id: "",
-    title: translations.geometryUrl,
-    value: "{{organization.helperServices.geometry.url}}"
-  }, {
-    id: "",
-    title: translations.portalBaseUrl,
-    value: "{{portalBaseUrl}}"
-  }, {
-    id: "",
-    title: translations.routeUrl,
-    value: "{{organization.helperServices.route.url}}"
-  }, {
-    id: "",
-    title: translations.solutionItemExtent,
-    value: "{{solutionItemExtent}}"
-  }];
-  return orgVars;
+export function getSpatialReferenceInfo(
+  services: any[],
+  data: any
+): any {
+  const defaultServices: any = {};
+  services.forEach(service => {
+    defaultServices[service.name] = service.enabled;
+  });
+  const wkid = getProp(data, "params.wkid.default");
+  return {
+    enabled: wkid !== undefined && wkid !== "",
+    services: defaultServices,
+    spatialReference: wkid ? { wkid } : undefined
+  }
 }
 
 //--------------------------------------------------------------------------

package/dist/solutions-components/utils/test/templates.e2e.ts

@@ -22,8 +22,8 @@ import * as electionOutreach from '../../demos/data/election-outreach.json';
 describe("getInventoryItems", () => {
   it("can get inventory items", () => {
     const templates = electionOutreach.templates;
-    expect(templates.length).toEqual(11)
+    expect(templates.length).toEqual(12)
     const actual = getInventoryItems(templates);
-    expect(actual.length).toEqual(5);
+    expect(actual.length).toEqual(6);
   });
 });

package/dist/solutions-components_commit.txt

@@ -0,0 +1,8 @@
+Built 06/18/2024 11:11:44.38 
+solution-spatial-ref
+commit 8861ea503aecdf435be85295ed9bae77b0383812
+Merge: 891b799d 5864f250
+Author: Mike Tschudi <mtschudi@esri.com>
+Date:   Tue Jun 18 11:04:22 2024 -0700
+
+    Merge branch 'develop' into solution-spatial-ref

package/dist/types/components/solution-spatial-ref/solution-spatial-ref.d.ts

@@ -1,5 +1,5 @@
 /** @license
- * Copyright 2022 Esri
+ * Copyright 2021 Esri
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,9 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { EventEmitter, VNode } from '../../stencil-public-runtime';
 import '@esri/calcite-components';
 import SolutionSpatialRef_T9n from '../../assets/t9n/solution-spatial-ref/resources.json';
-import { EventEmitter, VNode } from '../../stencil-public-runtime';
+interface IFeatureServiceSpatialReferenceChange {
+    name: string;
+    enabled: boolean;
+}
 export declare class SolutionSpatialRef {
     el: HTMLSolutionSpatialRefElement;
     /**
@@ -44,55 +48,46 @@ export declare class SolutionSpatialRef {
      * StencilJS: Called once just after the component is first connected to the DOM.
      */
     componentWillLoad(): Promise<void>;
-    /**
-     * Renders the component.
-     */
     render(): VNode;
-    /**
-     * Current text that is being used to filter the list of spatial references.
-     */
-    protected _srSearchText: string;
     /**
      * Contains the translations for this component.
      * All UI strings should be defined here.
      */
     protected _translations: typeof SolutionSpatialRef_T9n;
-    featureServiceSpatialReferenceChange: EventEmitter<{
-        name: string;
-        enabled: boolean;
-    }>;
+    featureServiceSpatialReferenceChange: EventEmitter<IFeatureServiceSpatialReferenceChange>;
     lockedSpatialReferenceChange: EventEmitter<{
         locked: boolean;
     }>;
+    solutionStoreHasChanges(): void;
     /**
      * Saves changes to the embedded spatial reference value
      */
     spatialReferenceChange(event: CustomEvent): void;
     /**
-     * Toggles the ability to set the default spatial reference.
+     * Create a switch control for each of the services
+     *
+     * @param services List of feature services
+     * @returns a node to control each feature service
      */
-    protected _updateLocked(event: any): void;
+    private _getFeatureServices;
     /**
      * Enable spatial reference variable for all feature services.
      *
      * @param services list of service names
      */
-    protected _setFeatureServiceDefaults(services: string[]): void;
+    private _setFeatureServiceDefaults;
     /**
-     * Create a switch control for each of the services
-     *
-     * @param services List of feature services
-     * @returns a node to control each feature service
+     * Updates the enabled/disabled state of the service in spatialReferenceInfo.
      */
-    protected _getFeatureServices(services: string[]): VNode;
+    private _updateEnabledServices;
     /**
-     * Updates the enabled and spatialReference prop in spatialReferenceInfo.
+     * Toggles the ability to set the default spatial reference.
      */
-    protected _updateStore(): void;
+    private _updateLocked;
     /**
-     * Updates the enabled/disabled state of the service in spatialReferenceInfo.
+     * Updates the enabled and spatialReference prop in spatialReferenceInfo.
      */
-    protected _updateEnabledServices(event: any, name: string): void;
+    private _updateStore;
     /**
      * Fetches the component's translations
      *
@@ -100,3 +95,4 @@ export declare class SolutionSpatialRef {
      */
     protected _getTranslations(): Promise<void>;
 }
+export {};

package/dist/types/components/store-manager/store-manager.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 /**
- * The json-editor componet leverages a stencil/store to manage data.
+ * The json-editor component leverages a stencil/store to manage data.
  * If a component uses the json-editor but does not have logic to hydrate the store this component can be used.
  * It will create and hydrate the store based on the value provided.
  *
@@ -24,7 +24,7 @@
  *
 */
 import { EventEmitter, VNode } from '../../stencil-public-runtime';
-import { /*getItemDataAsJson,*/ UserSession } from '@esri/solution-common';
+import { UserSession } from '@esri/solution-common';
 export declare class StoreManager {
     el: HTMLStoreManagerElement;
     /**
@@ -49,7 +49,7 @@ export declare class StoreManager {
     protected _valueObserver: any;
     /**
      * Initialize the observer that will monitor and respond to changes in the value.
-     * When we get a new value we are dealinmg with a new solution and need to fetch the items data and load the state.
+     * When we get a new value we are dealing with a new solution and need to fetch the item's data and load the state.
      */
     protected _initValueObserver(): void;
 }

package/dist/types/components.d.ts

@@ -1425,6 +1425,10 @@ export namespace Components {
           * The wkid that will be used as the default when no user selection has been made.
          */
         "defaultWkid": number;
+        /**
+          * Indicates if the control has been enabled. The first time Spatial Reference has been enabled it should enable all feature services.
+         */
+        "loaded": boolean;
         /**
           * When true, all but the main switch are disabled to prevent interaction.
          */
@@ -2229,7 +2233,7 @@ declare global {
         new (): HTMLSolutionResourceItemElement;
     };
     interface HTMLSolutionSpatialRefElementEventMap {
-        "featureServiceSpatialReferenceChange": { name: string, enabled: boolean };
+        "featureServiceSpatialReferenceChange": IFeatureServiceSpatialReferenceChange;
         "lockedSpatialReferenceChange": { locked: boolean };
     }
     interface HTMLSolutionSpatialRefElement extends Components.SolutionSpatialRef, HTMLStencilElement {
@@ -3825,11 +3829,15 @@ declare namespace LocalJSX {
           * The wkid that will be used as the default when no user selection has been made.
          */
         "defaultWkid"?: number;
+        /**
+          * Indicates if the control has been enabled. The first time Spatial Reference has been enabled it should enable all feature services.
+         */
+        "loaded"?: boolean;
         /**
           * When true, all but the main switch are disabled to prevent interaction.
          */
         "locked"?: boolean;
-        "onFeatureServiceSpatialReferenceChange"?: (event: SolutionSpatialRefCustomEvent<{ name: string, enabled: boolean }>) => void;
+        "onFeatureServiceSpatialReferenceChange"?: (event: SolutionSpatialRefCustomEvent<IFeatureServiceSpatialReferenceChange>) => void;
         "onLockedSpatialReferenceChange"?: (event: SolutionSpatialRefCustomEvent<{ locked: boolean }>) => void;
         /**
           * List of service names the spatial reference should apply to

package/dist/types/utils/templates.d.ts

@@ -13,8 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { IInventoryItem, IOrganizationVariableItem, IVariableItem } from '../utils/interfaces';
+import { IInventoryItem, IOrganizationVariableItem, ISolutionModels, IVariableItem } from '../utils/interfaces';
 import { IItemTemplate } from '@esri/solution-common';
+/**
+ * Gets a list of Feature Services that are not views along with an enabled property that indicates
+ * if the service currently uses a spatial reference variable.
+ *
+ * @param templates a list of item templates from the solution
+ *
+ * @returns a list of feature service names and an enabled property to indicate
+ * if they currently use a spatial reference variable.
+ */
+export declare function getFeatureServices(templates: IItemTemplate[]): any[];
 /**
  * Sort the solution items
  *
@@ -32,14 +42,14 @@ export declare function getInventoryItems(templates: IItemTemplate[]): IInventor
  */
 export declare function getItemHierarchy(templates: IItemTemplate[]): any[];
 /**
- * Explore the solution item templates for variables we will allow users to insert at runtime
+ * Create and store text models for the editor as well as other key values such as the original values
+ * that can be used to clear any temp edits.
  *
  * @param templates a list of item templates from the solution
- * @param translations nls translation object
  *
- * @returns a list of variables from the solution item templates
+ * @returns a list of models and key values
  */
-export declare function getSolutionVariables(templates: any[], translations: any): IVariableItem[];
+export declare function getModels(templates: any[]): ISolutionModels;
 /**
  * Set key organization variables we will allow users to insert at runtime
  *
@@ -48,3 +58,23 @@ export declare function getSolutionVariables(templates: any[], translations: any
  * @returns a list of variables for the organization
  */
 export declare function getOrganizationVariables(translations: any): IOrganizationVariableItem[];
+/**
+ * Explore the solution item templates for variables we will allow users to insert at runtime
+ *
+ * @param templates a list of item templates from the solution
+ * @param translations nls translation object
+ *
+ * @returns a list of variables from the solution item templates
+ */
+export declare function getSolutionVariables(templates: any[], translations: any): IVariableItem[];
+/**
+ * Stores basic spatial reference information that is used to determine if a custom spatial reference parameter will
+ * be exposed while deploying this solution and if so what feature services will support it and what will the default wkid be
+ *
+ * @param services a list of objects with service name and enabled property (indicates if they currently use a spatial reference var)
+ * @param data the data object of a solution item
+ *
+ * @returns an object that stores if a custom spatial reference parameter is enabled/disabled,
+ * a list of services and if they are enabled/disabled, and the default wkid
+ */
+export declare function getSpatialReferenceInfo(services: any[], data: any): any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solutions-components",
-  "version": "0.8.39",
+  "version": "0.8.40",
   "description": "Web Components for Esri's Solutions Applications",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",
@@ -36,6 +36,8 @@
     "@babel/preset-env": "^7.24.7",
     "@babel/preset-typescript": "^7.24.7",
     "@babel/types": "^7.24.7",
+    "@esri/arcgis-rest-service-admin": "^3.7.0",
+    "@esri/calcite-design-tokens": "^2.2.0",
     "@esri/eslint-plugin-calcite-components": "^1.2.0",
     "@esri/solution-common": "5.3.7",
     "@esri/telemetry": "8.0.0",
@@ -47,11 +49,12 @@
     "@stencil/store": "^2.0.16",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.14.2",
-    "@typescript-eslint/eslint-plugin": "^7.13.0",
+    "@typescript-eslint/eslint-plugin": "^7.13.1",
     "@typescript-eslint/parser": "^7.13.0",
     "arcgis-js-api": "^4.29.10",
     "autoprefixer": "^10.4.19",
     "babel-jest": "^29.7.0",
+    "braces": "^3.0.3",
     "dotenv": "^16.4.5",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "9.1.0",
@@ -81,9 +84,7 @@
     "@esri/arcgis-rest-feature-layer": "^3.4.2",
     "@esri/arcgis-rest-portal": "^3.4.2",
     "@esri/arcgis-rest-request": "^3.4.2",
-    "@esri/arcgis-rest-service-admin": "^3.4.2",
     "@esri/calcite-components": "2.8.2",
-    "@esri/calcite-design-tokens": "2.1.1",
     "@esri/hub-common": "^12.37.1",
     "@esri/hub-initiatives": "^12.4.1",
     "@esri/hub-sites": "^12.6.0",