@esri/solutions-components 0.0.2 → 0.0.6

package/dist/solutions/utils/templates.ts

@@ -17,34 +17,17 @@
 /*
  | Helper functions to get required values from solutions templates
 */
-
-import { IItemDetails } from "../components/solution-item-details/solution-item-details";
-import { IInventoryItem } from "../components/solution-contents/solution-contents";
-import { IItemShare } from "../components/solution-item-sharing/solution-item-sharing";
-import { IVariableItem } from "../components/solution-variables/solution-variables";
-import { IOrganizationVariableItem } from "../components/solution-organization-variables/solution-organization-variables";
-
-export interface ISolutionModel {
-  dataModel: monaco.editor.ITextModel;
-  dataOriginValue: string;
-  propsModel: monaco.editor.ITextModel;
-  propsOriginValue: string;
-  propsDiffOriginValue: string;
-  state: any;
-  shareInfo: any;
-  isEditing: boolean;
-  itemId: string;
-  updateItemValues: any;
-  originalItemValues: any;
-  name: string;
-  title: string;
-  itemOriginValue: string;
-  spatialReference: any;
-}
-
-interface ISolutionModels {
-  [key: string]: ISolutionModel;
-} 
+import { 
+  IInventoryItem,
+  IItemDetails,
+  IItemShare,
+  IOrganizationVariableItem,
+  ISolutionModels,
+  IVariableItem
+} from '../utils/interfaces';
+import {
+  getProp
+} from '@esri/solution-common';
 
 export function getInventoryItems(
   templates: any[]
@@ -186,23 +169,26 @@ export function getFeatureServices(
       cur.item.typeKeywords.indexOf("View Service") < 0 &&
       prev.indexOf(name) < 0
     ) {
-      prev.push(name)
+      const wkid = getProp(cur, "properties.service.spatialReference.wkid");
+      prev.push({ name, enabled: wkid.toString().startsWith("{{params.wkid||")});
     }
     return prev;
   }, []);
 }
 
 export function getSpatialReferenceInfo(
-  services: string[]
+  services: any[],
+  data: any
 ): any {
   const defaultServices: any = {};
   services.forEach(service => {
-    defaultServices[service] = true;
+    defaultServices[service.name] = service.enabled;
   });
+  const wkid = getProp(data, "params.wkid.default");
   return {
-    enabled: false,
+    enabled: wkid !== undefined && wkid !== "",
     services: defaultServices,
-    spatialReference: undefined
+    spatialReference: wkid ? { wkid } : undefined
   }
 }
 

package/dist/types/components/json-editor/json-editor.d.ts

@@ -64,6 +64,7 @@ export declare class JsonEditor {
   solutionVariableSelected(event: CustomEvent): void;
   _modelsChanged(): void;
   _solutionItemSelected(event: CustomEvent): void;
+  featureServiceSpatialReferenceChange(event: CustomEvent): void;
   /**
    * Initializes the editor when the web component is connected.
    *
@@ -209,4 +210,14 @@ export declare class JsonEditor {
    * @protected
    */
   _getOriginalValue(): string;
+  /**
+   * Update the current feature service models wkid
+   *
+   * This functions responds to events fired from the spatial reference control.
+   *
+   * @param enabled does the given service support the wkid variable (true) or the current wkid (false)
+   *
+   * @protected
+   */
+  _setFeatureServiceWkid(enabled: boolean): void;
 }

package/dist/types/components/solution-configuration/solution-configuration.d.ts

@@ -14,15 +14,16 @@
  * limitations under the License.
  */
 import { VNode } from '../../stencil-public-runtime';
-import { IInventoryItem } from '../solution-contents/solution-contents';
-import { ISolutionItem } from '../solution-item/solution-item';
+import { ISolutionConfiguration, ISolutionItem } from '../../utils/interfaces';
+import { UserSession } from '@esri/solution-common';
 import '@esri/calcite-components';
-export interface ISolutionConfiguration {
-  contents: IInventoryItem[];
-}
 export declare class SolutionConfiguration {
   el: HTMLSolutionConfigurationElement;
   modelsSet: boolean;
+  /**
+   * Credentials for requests
+   */
+  authentication: UserSession;
   /**
    * Contains the translations for this component.
    */
@@ -34,7 +35,7 @@ export declare class SolutionConfiguration {
   /**
    * Contains the raw templates from the solution item
    */
-  templates: string;
+  templates: any[];
   /**
    * Contains the current solution item we are working with
    */
@@ -42,11 +43,15 @@ export declare class SolutionConfiguration {
   /**
    * Contains the current solution item id
    */
-  solutionItemId: string;
+  itemid: string;
   /**
    * Used to show/hide the content tree
    */
   treeOpen: boolean;
+  /**
+  * Contains the current solution item id
+  */
+  sourceItemData: any;
   connectedCallback(): void;
   render(): VNode;
   private _templatesObserver;
@@ -55,10 +60,12 @@ export declare class SolutionConfiguration {
   _solutionItemSelected(event: CustomEvent): void;
   getEditModels(): Promise<any>;
   getSpatialReferenceInfo(): Promise<any>;
+  getSourceTemplates(): Promise<any>;
+  save(): Promise<any>;
   /**
-   * Observe changes to the templates prop
+   * Observe changes to the props
    */
-  private _initTemplatesObserver;
+  private _initObserver;
   /**
    * Update the store with the initial value
    */
@@ -71,4 +78,61 @@ export declare class SolutionConfiguration {
    * Toggle treeOpen prop to show/hide content tree
    */
   private _toggleTree;
+  /**
+   * Save all edits from the current configuration
+   *
+   * @returns a response that will indicate success or failure and any associated messages
+   */
+  private _save;
+  /**
+   * Update the solutions templates based on the stored changes
+   *
+   * @returns an object that contains the updated templates as well as any errors that were found
+   */
+  private _updateTemplates;
+  /**
+   * Set a templates data property with changes from the models
+   *
+   * @param template the current template to update
+   * @param model the corresponding model for the current template (stores any user changes)
+   *
+   * @returns a boolean that indicates if any errors were detected
+   */
+  private _setData;
+  /**
+   * Set a templates properties property with changes from the models
+   *
+   * @param template the current template to update
+   * @param model the corresponding model for the current template (stores any user changes)
+   *
+   * @returns a boolean that indicates if any errors were detected
+   */
+  private _setProps;
+  /**
+   * Generic function used to set properties or data property on a given template
+   *
+   * @param template the current template to update
+   * @param originValue the original value from the solution template
+   * @param modelValue the current value from the model (will contain any edits that have been made)
+   * @param path the path to the property we should update if any changes are found
+   *
+   * @returns a boolean that indicates if any errors were detected
+   */
+  private _setTemplateProp;
+  /**
+   * Set a templates item property with changes from the models
+   *
+   * @param template the current template to update
+   * @param model the corresponding model for the current template (stores any user changes)
+   *
+   * This function will update the template argument when edits are found
+   */
+  private _setItem;
+  /**
+   * Set spatial reference info in the solutions data
+   *
+   * @returns a cloned copy of the solutions data that has been updated with spatial reference info
+   *
+   */
+  private _setSrInfo;
 }

package/dist/types/components/solution-contents/solution-contents.d.ts

@@ -14,16 +14,8 @@
  * limitations under the License.
  */
 import { EventEmitter, VNode } from '../../stencil-public-runtime';
-import { ISolutionItem } from '../solution-item/solution-item';
+import { IInventoryItem } from '../../utils/interfaces';
 import '@esri/calcite-components';
-export interface IInventoryItem {
-  id: string;
-  title: string;
-  dependencies?: IInventoryItem[];
-  type: string;
-  typeKeywords: string[];
-  solutionItem: ISolutionItem;
-}
 export declare class SolutionContents {
   el: HTMLSolutionContentsElement;
   /**
@@ -34,6 +26,7 @@ export declare class SolutionContents {
    * Contains the public value for this component.
    */
   value: IInventoryItem[];
+  valueWatchHandler(v: any, oldV: any): void;
   render(): VNode;
   renderHierarchy(objs: IInventoryItem[]): HTMLCalciteTreeItemElement[];
   solutionItemSelected: EventEmitter;

package/dist/types/components/solution-item/solution-item.d.ts

@@ -14,18 +14,8 @@
  * limitations under the License.
  */
 import { VNode } from '../../stencil-public-runtime';
-import { ITemplateData } from '../solution-template-data/solution-template-data';
+import { ISolutionItem } from '../../utils/interfaces';
 import '@esri/calcite-components';
-import { IItemShare } from '../solution-item-sharing/solution-item-sharing';
-export interface ISolutionItem {
-  itemId: string;
-  itemDetails: any;
-  isResource: boolean;
-  data: ITemplateData;
-  properties: ITemplateData;
-  type: string;
-  groupDetails?: IItemShare[];
-}
 export declare class SolutionItem {
   el: HTMLSolutionItemElement;
   /**

package/dist/types/components/solution-item-details/solution-item-details.d.ts

@@ -15,16 +15,7 @@
  */
 import { VNode } from '../../stencil-public-runtime';
 import '@esri/calcite-components';
-export interface IItemDetails {
-  thumbnail: string;
-  title: string;
-  snippet: string;
-  description: string;
-  tags: string[];
-  accessInformation?: string;
-  licenseInfo?: string;
-  itemId: string;
-}
+import { IItemDetails } from '../../utils/interfaces';
 export declare class SolutionItemDetails {
   el: HTMLSolutionItemDetailsElement;
   /**

package/dist/types/components/solution-item-sharing/solution-item-sharing.d.ts

@@ -14,14 +14,7 @@
  * limitations under the License.
  */
 import { VNode } from '../../stencil-public-runtime';
-export interface IItemShare {
-  id: string;
-  title: string;
-  isShared: boolean;
-  shareItem: boolean;
-  type: string;
-  typeKeywords: string[];
-}
+import { IItemShare } from '../../utils/interfaces';
 export declare class SolutionItemSharing {
   el: HTMLSolutionItemSharingElement;
   /**

package/dist/types/components/solution-organization-variables/solution-organization-variables.d.ts

@@ -14,11 +14,7 @@
  * limitations under the License.
  */
 import { EventEmitter, VNode } from '../../stencil-public-runtime';
-export interface IOrganizationVariableItem {
-  id: string;
-  title: string;
-  value: string;
-}
+import { IOrganizationVariableItem } from '../../utils/interfaces';
 export declare class SolutionOrganizationVariables {
   el: HTMLSolutionOrganizationVariablesElement;
   /**

package/dist/types/components/solution-resource-item/solution-resource-item.d.ts

@@ -13,10 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export interface IResourceItem {
-  name: string;
-  url: string;
-}
+import { IResourceItem } from '../../utils/interfaces';
 export declare class SolutionResourceItem {
   el: HTMLSolutionResourceItemElement;
   /**

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

@@ -13,14 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { VNode } from '../../stencil-public-runtime';
+import { EventEmitter, VNode } from '../../stencil-public-runtime';
 import '@esri/calcite-components';
-export interface ISpatialRefRepresentation {
-  display: string;
-  usingWkid: boolean;
-  wkid: number;
-  wkt: string;
-}
+import { ISpatialRefRepresentation } from '../../utils/interfaces';
 export declare class SolutionSpatialRef {
   el: HTMLSolutionSpatialRefElement;
   /**
@@ -28,6 +23,11 @@ export declare class SolutionSpatialRef {
   */
   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;
@@ -54,6 +54,7 @@ export declare class SolutionSpatialRef {
    * Current text that is being used to filter the list of spatial references.
    */
   private _srSearchText;
+  featureServiceSpatialReferenceChange: EventEmitter;
   /**
    * Returns the spatial reference description of the supplied value.
    * (Exposes private method `_createSpatialRefDisplay` for testing.)
@@ -86,6 +87,12 @@ export declare class SolutionSpatialRef {
    * Toggles the ability to set the default spatial reference.
    */
   private _updateLocked;
+  /**
+   * Enable spatial reference variable for all feature services.
+   *
+   * @param services list of service names
+   */
+  private _setFeatureServiceDefaults;
   /**
    * Stores the wkid as the components value.
    */
@@ -112,25 +119,6 @@ export declare class SolutionSpatialRef {
    * Updates the enabled/disabled state of the service in spatialReferenceInfo.
    */
   private _updateEnabledServices;
-  /**
-   * When the spatial reference param is enabled/disabled..we need to handle all feature services that
-   * are listed in state.services.
-   * When an individual service is enabled/disabled we only need to handle it.
-   *
-   * @param services List of feature services
-   */
-  private _updateEditModels;
-  /**
-   * Updates the services spatial reference by setting the wkid param value and removing latestWkid when enabled and active
-   * OR
-   * Sets the spatial reference back to the original spatialReference when disabled
-   *
-   * @param updateModel The model to update
-   * @param enabled Is the param enabled
-   * @param active Is the service enabled
-   * @param spatialReference The original source spatial reference
-   */
-  private _updateData;
   /**
    * Select the first child on Enter key click
    * OR

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

@@ -13,8 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export interface IWkidDescription {
-  label: string;
-  defaultExtent: string;
-}
+import { IWkidDescription } from '../../utils/interfaces';
 export declare const wkids: Record<number, IWkidDescription>;

package/dist/types/components/solution-template-data/solution-template-data.d.ts

@@ -14,13 +14,7 @@
  * limitations under the License.
  */
 import { VNode } from '@esri/calcite-components/dist/types/stencil-public-runtime';
-import { IOrganizationVariableItem } from '../solution-organization-variables/solution-organization-variables';
-import { IVariableItem } from '../solution-variables/solution-variables';
-import { IResourceItem } from '../solution-resource-item/solution-resource-item';
-export interface ITemplateData {
-  resourceItem?: IResourceItem;
-  value?: any;
-}
+import { IOrganizationVariableItem, ITemplateData, IVariableItem } from '../../utils/interfaces';
 export declare class SolutionTemplateData {
   el: HTMLSolutionTemplateDataElement;
   /**

package/dist/types/components/solution-variables/solution-variables.d.ts

@@ -14,13 +14,7 @@
  * limitations under the License.
  */
 import { EventEmitter, VNode } from '../../stencil-public-runtime';
-export interface IVariableItem {
-  id: string;
-  title: string;
-  type?: string;
-  value: string;
-  dependencies?: IVariableItem[];
-}
+import { IVariableItem } from '../../utils/interfaces';
 export declare class SolutionVariables {
   el: HTMLSolutionVariablesElement;
   /**

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

@@ -24,6 +24,7 @@
  *
 */
 import { EventEmitter } from '../../stencil-public-runtime';
+import { UserSession } from '@esri/solution-common';
 export declare class StoreManager {
   el: HTMLStoreManagerElement;
   /**
@@ -31,6 +32,14 @@ export declare class StoreManager {
    *
    */
   value: string;
+  /**
+   * Templates for the current solution
+   */
+  templates: any[];
+  /**
+   * Credentials for requests
+   */
+  authentication: UserSession;
   connectedCallback(): void;
   render(): any;
   stateLoaded: EventEmitter;

package/dist/types/components.d.ts

@@ -5,19 +5,8 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { ISolutionConfiguration } from "./components/solution-configuration/solution-configuration";
-import { ISolutionItem } from "./components/solution-item/solution-item";
-import { IInventoryItem } from "./components/solution-contents/solution-contents";
-import { ISolutionItem as ISolutionItem1 } from "./components/solution-item/solution-item";
-import { IItemDetails } from "./components/solution-item-details/solution-item-details";
-import { IItemShare } from "./components/solution-item-sharing/solution-item-sharing";
-import { IOrganizationVariableItem } from "./components/solution-organization-variables/solution-organization-variables";
-import { IResourceItem } from "./components/solution-resource-item/solution-resource-item";
-import { ISpatialRefRepresentation } from "./components/solution-spatial-ref/solution-spatial-ref";
-import { ITemplateData } from "./components/solution-template-data/solution-template-data";
-import { IVariableItem } from "./components/solution-variables/solution-variables";
-import { IOrganizationVariableItem as IOrganizationVariableItem1 } from "./components/solution-organization-variables/solution-organization-variables";
-import { IVariableItem as IVariableItem1 } from "./components/solution-variables/solution-variables";
+import { UserSession } from "@esri/solution-common";
+import { IInventoryItem, IItemDetails, IItemShare, IOrganizationVariableItem, IResourceItem, ISolutionConfiguration, ISolutionItem, ISpatialRefRepresentation, ITemplateData, IVariableItem } from "./utils/interfaces";
 export namespace Components {
     interface JsonEditor {
         /**
@@ -46,7 +35,12 @@ export namespace Components {
         "value": any;
     }
     interface SolutionConfiguration {
+        /**
+          * Credentials for requests
+         */
+        "authentication": UserSession;
         "getEditModels": () => Promise<any>;
+        "getSourceTemplates": () => Promise<any>;
         "getSpatialReferenceInfo": () => Promise<any>;
         /**
           * Contains the current solution item we are working with
@@ -55,11 +49,16 @@ export namespace Components {
         /**
           * Contains the current solution item id
          */
-        "solutionItemId": string;
+        "itemid": string;
+        "save": () => Promise<any>;
+        /**
+          * Contains the current solution item id
+         */
+        "sourceItemData": any;
         /**
           * Contains the raw templates from the solution item
          */
-        "templates": string;
+        "templates": any[];
         /**
           * Contains the translations for this component.
          */
@@ -179,6 +178,10 @@ export namespace Components {
           * Returns the current spatial reference description. (Exposes private variable `spatialRef` for testing.)
          */
         "getSpatialRef": () => Promise<ISpatialRefRepresentation>;
+        /**
+          * 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.
          */
@@ -247,6 +250,14 @@ export namespace Components {
         "value": IVariableItem[];
     }
     interface StoreManager {
+        /**
+          * Credentials for requests
+         */
+        "authentication": UserSession;
+        /**
+          * Templates for the current solution
+         */
+        "templates": any[];
         /**
           * Contains source json as a string
          */
@@ -376,6 +387,10 @@ declare namespace LocalJSX {
         "value"?: any;
     }
     interface SolutionConfiguration {
+        /**
+          * Credentials for requests
+         */
+        "authentication"?: UserSession;
         /**
           * Contains the current solution item we are working with
          */
@@ -383,11 +398,15 @@ declare namespace LocalJSX {
         /**
           * Contains the current solution item id
          */
-        "solutionItemId"?: string;
+        "itemid"?: string;
+        /**
+          * Contains the current solution item id
+         */
+        "sourceItemData"?: any;
         /**
           * Contains the raw templates from the solution item
          */
-        "templates"?: string;
+        "templates"?: any[];
         /**
           * Contains the translations for this component.
          */
@@ -499,10 +518,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: CustomEvent<any>) => void;
         /**
           * List of service names the spatial reference should apply to
          */
@@ -562,7 +586,15 @@ declare namespace LocalJSX {
         "value"?: IVariableItem[];
     }
     interface StoreManager {
+        /**
+          * Credentials for requests
+         */
+        "authentication"?: UserSession;
         "onStateLoaded"?: (event: CustomEvent<any>) => void;
+        /**
+          * Templates for the current solution
+         */
+        "templates"?: any[];
         /**
           * Contains source json as a string
          */

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

@@ -13,47 +13,22 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/**
- * Gets a property out of a deeply nested object.
- * Does not handle anything but nested object graph
- *
- * @param obj Object to retrieve value from
- * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property
- *             in obj
- * @return Value at end of path
- */
-export declare function getProp(obj: {
-  [index: string]: any;
-}, path: string): any;
-/**
- * Returns an array of values from an object based on an array of property paths.
- *
- * @param obj Object to retrieve values from
- * @param props Array of paths into the object e.g., "data.values.webmap", where "data" is a top-level property
- * @return Array of the values plucked from the object; only defined values are returned
- */
-export declare function getProps(obj: any, props: string[]): any;
-/**
- * Sets a deeply nested property of an object.
- * Creates the full path if it does not exist.
- *
- * @param obj Object to set value of
- * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property in obj
- * @param value The value to set at the end of the path
- */
-export declare function setCreateProp(obj: any, path: string, value: any): any;
-/**
- * Sets a deeply nested property of an object.
- * Does nothing if the full path does not exist.
- *
- * @param obj Object to set value of
- * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property in obj
- * @param value The value to set at the end of the path
- */
-export declare function setProp(obj: any, path: string, value: any): any;
+import { UserSession } from "@esri/solution-common";
+import { IResponse } from "./interfaces";
 /**
  * Get an array from a list of nodes
  *
  * @param nodeList list of nodes
  */
 export declare function nodeListToArray<T extends Element>(nodeList: HTMLCollectionOf<T> | NodeListOf<T> | T[]): T[];
+/**
+ * Saves any updated templates to the current solution item
+ *
+ * @param templates the updated templates array
+ * @param thumbnailurl url for the items thumbnail
+ * @param id for the solution item
+ * @param data the current solution items data
+ * @param authentication credentials for the request
+ * @param translations translated strings for messages
+ */
+export declare function save(id: string, data: any, authentication: UserSession, translations: any, thumbnailurl: any): Promise<IResponse>;