@esri/solutions-components 0.7.52 → 0.8.0

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

@@ -561,3 +561,7 @@ export interface IPopupUtils {
   arcade: typeof import("esri/arcade");
   getPopupTitle(graphic: __esri.Graphic, map: __esri.Map): Promise<string>;
 }
+
+export interface IConsentResponse {
+  granted: boolean;
+}

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

@@ -0,0 +1,109 @@
+/** @license
+ * Copyright 2024 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/// <reference types="arcgis-js-api" />
+import { EventEmitter } from '../../stencil-public-runtime';
+import ConsentManager_T9n from "../../assets/t9n/consent-manager/resources.json";
+import { Telemetry } from "@esri/telemetry";
+import { IConsentResponse } from "../../utils/interfaces";
+export declare class ConsentManager {
+    el: HTMLConsentManagerElement;
+    /**
+     * string: The name to use for the variable stored in the browsers local storge that
+     * will keep track of the users choice for consent
+     */
+    firstUseVar: string;
+    /**
+     * string[]: Any ids for the analytics configured to receive events from the telemety instance
+     */
+    measurementIds: string[];
+    /**
+     * esri/portal/Portal: https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html
+     * Required prop for this component to function
+     */
+    portal: __esri.Portal;
+    /**
+     * boolean: When true the user has not allowed or denied consent
+     */
+    _shouldRender: boolean;
+    /**
+     * Contains the translations for this component.
+     * All UI strings should be defined here.
+     */
+    _translations: typeof ConsentManager_T9n;
+    /**
+     * boolean: When true the user has granted consent and the telemetry instance will be avaliable
+     */
+    protected _consentGranted: boolean;
+    /**
+     * boolean: When true the telemetry instance has been loaded
+     */
+    protected _loaded: boolean;
+    /**
+     * Telemetry: The telemetry instance that can be used to log events by the consuming application
+     * https://www.npmjs.com/package/@esri/telemetry
+     */
+    protected _telemetryInstance: Telemetry;
+    /**
+     * Initialize and return the telemetry instance if consent has been granted
+     */
+    getInstance(): Promise<Telemetry | undefined>;
+    /**
+     * Emitted on demand when the user accepts or denies consent
+     */
+    consentGranted: EventEmitter<IConsentResponse>;
+    /**
+     * StencilJS: Called once just after the component is first connected to the DOM.
+     *
+     * @returns Promise when complete
+     */
+    componentWillLoad(): Promise<void>;
+    /**
+     * Renders the component.
+     */
+    render(): any;
+    /**
+     * Fetches the component's translations
+     *
+     * @returns Promise when complete
+     * @protected
+     */
+    _init(): Promise<void>;
+    /**
+     * Store the users granting of consent
+     *
+     * @protected
+     */
+    _accept(): void;
+    /**
+     * Store the users refusal of consent
+     *
+     * @protected
+     */
+    _refuse(): void;
+    /**
+     * Store and emit the users choice for consent
+     *
+     * @protected
+     */
+    protected _handleConsent(): void;
+    /**
+     * Fetches the component's translations
+     *
+     * @returns Promise when complete
+     * @protected
+     */
+    protected _getTranslations(): Promise<void>;
+}

package/dist/types/components.d.ts

@@ -5,9 +5,9 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { ButtonType, DistanceUnit, EditType, EDrawMode, ELayoutMode, IBasemapConfig, IExportInfos, IInventoryItem, ILayerAndTableIds, IMapChange, IMapInfo, ISearchConfiguration, ISelectionSet, ISketchGraphicsChange, ISolutionSpatialReferenceInfo, ISpatialRefRepresentation, IValueChange, theme } from "./utils/interfaces";
+import { ButtonType, DistanceUnit, EditType, EDrawMode, ELayoutMode, IBasemapConfig, IConsentResponse, IExportInfos, IInventoryItem, ILayerAndTableIds, IMapChange, IMapInfo, ISearchConfiguration, ISelectionSet, ISketchGraphicsChange, ISolutionSpatialReferenceInfo, ISpatialRefRepresentation, IValueChange, theme } from "./utils/interfaces";
 import { UserSession } from "@esri/solution-common";
-export { ButtonType, DistanceUnit, EditType, EDrawMode, ELayoutMode, IBasemapConfig, IExportInfos, IInventoryItem, ILayerAndTableIds, IMapChange, IMapInfo, ISearchConfiguration, ISelectionSet, ISketchGraphicsChange, ISolutionSpatialReferenceInfo, ISpatialRefRepresentation, IValueChange, theme } from "./utils/interfaces";
+export { ButtonType, DistanceUnit, EditType, EDrawMode, ELayoutMode, IBasemapConfig, IConsentResponse, IExportInfos, IInventoryItem, ILayerAndTableIds, IMapChange, IMapInfo, ISearchConfiguration, ISelectionSet, ISketchGraphicsChange, ISolutionSpatialReferenceInfo, ISpatialRefRepresentation, IValueChange, theme } from "./utils/interfaces";
 export { UserSession } from "@esri/solution-common";
 export namespace Components {
     interface ArcgisLogin {
@@ -84,6 +84,24 @@ export namespace Components {
          */
         "zoomAndScrollToSelected": boolean;
     }
+    interface ConsentManager {
+        /**
+          * string: The name to use for the variable stored in the browsers local storge that will keep track of the users choice for consent
+         */
+        "firstUseVar": string;
+        /**
+          * Initialize and return the telemetry instance if consent has been granted
+         */
+        "getInstance": () => Promise<Telemetry | undefined>;
+        /**
+          * string[]: Any ids for the analytics configured to receive events from the telemety instance
+         */
+        "measurementIds": string[];
+        /**
+          * esri/portal/Portal: https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html Required prop for this component to function
+         */
+        "portal": __esri.Portal;
+    }
     interface CreateFeature {
         /**
           * Destroy the Editor widget instance
@@ -1307,6 +1325,10 @@ export interface BufferToolsCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLBufferToolsElement;
 }
+export interface ConsentManagerCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLConsentManagerElement;
+}
 export interface CreateFeatureCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLCreateFeatureElement;
@@ -1445,6 +1467,23 @@ declare global {
         prototype: HTMLCardManagerElement;
         new (): HTMLCardManagerElement;
     };
+    interface HTMLConsentManagerElementEventMap {
+        "consentGranted": IConsentResponse;
+    }
+    interface HTMLConsentManagerElement extends Components.ConsentManager, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLConsentManagerElementEventMap>(type: K, listener: (this: HTMLConsentManagerElement, ev: ConsentManagerCustomEvent<HTMLConsentManagerElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLConsentManagerElementEventMap>(type: K, listener: (this: HTMLConsentManagerElement, ev: ConsentManagerCustomEvent<HTMLConsentManagerElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    }
+    var HTMLConsentManagerElement: {
+        prototype: HTMLConsentManagerElement;
+        new (): HTMLConsentManagerElement;
+    };
     interface HTMLCreateFeatureElementEventMap {
         "success": void;
         "fail": Error;
@@ -2018,6 +2057,7 @@ declare global {
         "basemap-gallery": HTMLBasemapGalleryElement;
         "buffer-tools": HTMLBufferToolsElement;
         "card-manager": HTMLCardManagerElement;
+        "consent-manager": HTMLConsentManagerElement;
         "create-feature": HTMLCreateFeatureElement;
         "crowdsource-manager": HTMLCrowdsourceManagerElement;
         "crowdsource-reporter": HTMLCrowdsourceReporterElement;
@@ -2148,6 +2188,24 @@ declare namespace LocalJSX {
          */
         "zoomAndScrollToSelected"?: boolean;
     }
+    interface ConsentManager {
+        /**
+          * string: The name to use for the variable stored in the browsers local storge that will keep track of the users choice for consent
+         */
+        "firstUseVar"?: string;
+        /**
+          * string[]: Any ids for the analytics configured to receive events from the telemety instance
+         */
+        "measurementIds": string[];
+        /**
+          * Emitted on demand when the user accepts or denies consent
+         */
+        "onConsentGranted"?: (event: ConsentManagerCustomEvent<IConsentResponse>) => void;
+        /**
+          * esri/portal/Portal: https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html Required prop for this component to function
+         */
+        "portal": __esri.Portal;
+    }
     interface CreateFeature {
         /**
           * boolean: Set this to true when have a custom submit button in the app. This will hide the header and footer elements of the editor and user needs to execute the submit method manually.
@@ -3418,6 +3476,7 @@ declare namespace LocalJSX {
         "basemap-gallery": BasemapGallery;
         "buffer-tools": BufferTools;
         "card-manager": CardManager;
+        "consent-manager": ConsentManager;
         "create-feature": CreateFeature;
         "crowdsource-manager": CrowdsourceManager;
         "crowdsource-reporter": CrowdsourceReporter;
@@ -3474,6 +3533,7 @@ declare module "@stencil/core" {
             "basemap-gallery": LocalJSX.BasemapGallery & JSXBase.HTMLAttributes<HTMLBasemapGalleryElement>;
             "buffer-tools": LocalJSX.BufferTools & JSXBase.HTMLAttributes<HTMLBufferToolsElement>;
             "card-manager": LocalJSX.CardManager & JSXBase.HTMLAttributes<HTMLCardManagerElement>;
+            "consent-manager": LocalJSX.ConsentManager & JSXBase.HTMLAttributes<HTMLConsentManagerElement>;
             "create-feature": LocalJSX.CreateFeature & JSXBase.HTMLAttributes<HTMLCreateFeatureElement>;
             "crowdsource-manager": LocalJSX.CrowdsourceManager & JSXBase.HTMLAttributes<HTMLCrowdsourceManagerElement>;
             "crowdsource-reporter": LocalJSX.CrowdsourceReporter & JSXBase.HTMLAttributes<HTMLCrowdsourceReporterElement>;

package/dist/types/preact.d.ts

@@ -510,6 +510,10 @@ declare module "preact/src/jsx" {
 
       "card-manager": JSX.SolutionsCardManager & JSXInternal.HTMLAttributes<HTMLSolutionsCardManagerElement>
 
+      "consent-manager": Omit<JSX.SolutionsConsentManager, "onConsentGranted"> & JSXInternal.HTMLAttributes<HTMLSolutionsConsentManagerElement> & {
+        "onconsentGranted"?: (event: CustomEvent<any>) => void;
+      }
+
       "create-feature": Omit<JSX.SolutionsCreateFeature, "onSuccess" | "onFail" | "onDrawComplete" | "onEditingAttachment"> & JSXInternal.HTMLAttributes<HTMLSolutionsCreateFeatureElement> & {
         "onsuccess"?: (event: CustomEvent<any>) => void;
         "onfail"?: (event: CustomEvent<any>) => void;

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

@@ -484,3 +484,6 @@ export interface IPopupUtils {
     arcade: typeof import("esri/arcade");
     getPopupTitle(graphic: __esri.Graphic, map: __esri.Map): Promise<string>;
 }
+export interface IConsentResponse {
+    granted: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solutions-components",
-  "version": "0.7.52",
+  "version": "0.8.0",
   "description": "Web Components for Esri's Solutions Applications",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",
@@ -71,7 +71,10 @@
     "tailwindcss": "3.0.23",
     "ts-node": "^10.9.1",
     "tslib": "^2.4.0",
-    "typescript": "^4.8.4"
+    "typescript": "^4.8.4",
+    "@esri/telemetry": "6.1.3",
+    "@esri/telemetry-amazon": "1.1.3",
+    "@esri/telemetry-google-analytics": "0.4.3"
   },
   "dependencies": {
     "@esri/arcgis-rest-auth": "^3.4.2",

package/dist/solutions-components/p-00f9774c.js

@@ -1,6 +0,0 @@
-/*!
- * Copyright 2022 Esri
- * Licensed under the Apache License, Version 2.0
- * http://www.apache.org/licenses/LICENSE-2.0
- */
-import{l as o}from"./p-a8a0187d.js";async function t(o,t){var n,a,e;try{const s=null===(e=null===(a=null===(n=null==t?void 0:t.portalItem)||void 0===n?void 0:n.portal)||void 0===a?void 0:a.credential)||void 0===e?void 0:e.token,i={responseType:"json"};s&&(i.query={token:s});var r="cacheBuster="+Date.now();const l=`${t.url}?${r}`,c=await o(l,i);return Promise.resolve(c.data)}catch(o){console.error("Unable to get resource t9n data.")}}async function n(t){if(!t)return null;const[n]=await o(["esri/portal/PortalItemResource"]),a=await t.fetchResources(),e=`t9n/${null==t?void 0:t.id}.json`,r=new n({path:e,portalItem:t}),s=a.resources.filter((o=>o.resource.path===e));if(0!==s.length)return Promise.resolve(s[0].resource);{const o="application/json",n=new Blob([JSON.stringify({})],{type:o});try{await t.addResource(r,n);const o=await t.fetchResources(),a=`t9n/${null==t?void 0:t.id}.json`,e=o.resources.filter((o=>o.resource.path===a));return Promise.resolve(e[0].resource)}catch(o){return console.error("ERROR: ",o),Promise.reject(null)}}}export{t as f,n as g}

package/dist/solutions-components/p-e1a4994d.js

@@ -1,6 +0,0 @@
-/*!
- * Copyright 2022 Esri
- * Licensed under the Apache License, Version 2.0
- * http://www.apache.org/licenses/LICENSE-2.0
- */
-var e="undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{};function n(e){return e&&e.__esModule&&Object.prototype.hasOwnProperty.call(e,"default")?e.default:e}function o(e,n,o){return e(o={path:n,exports:{},require:function(){return r()}},o.exports),o.exports}function r(){throw new Error("Dynamic requires are not currently supported by @rollup/plugin-commonjs")}export{e as a,r as b,o as c,n as g}