@esri/solutions-components 0.7.52 → 0.8.0

package/dist/cjs/spatial-ref.cjs.entry.js

@@ -8,11 +8,11 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 const index = require('./index-105cf2b9.js');
-const locale = require('./locale-8c42ba7a.js');
-const common = require('./common-4cd3537b.js');
-require('./esri-loader-a91c0ec1.js');
-require('./_commonjsHelpers-384729db.js');
-require('./solution-resource-abec7452.js');
+const locale = require('./locale-3d0a4bc2.js');
+const common = require('./common-e6e9f7d6.js');
+require('./esri-loader-ce6c3d3d.js');
+require('./_commonjsHelpers-480c2e77.js');
+require('./solution-resource-97186521.js');
 require('./index-f64944ad.js');
 require('./interfaces-7cd0a48a.js');
 

package/dist/cjs/{utils-a137dc1a.js → utils-ea7a5a63.js}

@@ -5,7 +5,7 @@
  */
 'use strict';
 
-const locale = require('./locale-dab3f46a.js');
+const locale = require('./locale-3e33f44c.js');
 const index = require('./index-ae65e42f.js');
 
 exports.EInputType = void 0;

package/dist/collection/collection-manifest.json

@@ -4,6 +4,7 @@
     "components/basemap-gallery/basemap-gallery.js",
     "components/buffer-tools/buffer-tools.js",
     "components/card-manager/card-manager.js",
+    "components/consent-manager/consent-manager.js",
     "components/create-feature/create-feature.js",
     "components/crowdsource-manager/crowdsource-manager.js",
     "components/crowdsource-reporter/crowdsource-reporter.js",

package/dist/collection/components/consent-manager/consent-manager.css

@@ -0,0 +1,67 @@
+/** @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.
+ */
+
+:host {
+  display: block;
+}
+
+.consent-panel {
+  position: fixed;
+  display: block;
+  z-index: 5000;
+  bottom: 0;
+  left: 0;
+  width: 100%;
+  height: auto;
+  text-align: center;
+}
+
+.cookie-consent-popup-container {
+  position: relative;
+  display: block;
+  bottom: 0;
+  left: 0;
+  width: 100%;
+  margin: 0;
+  padding-top: 1rem;
+  padding-bottom: 1rem;
+  transition: transform 0.5s ease-out 0s;
+  background-color: rgba(51, 51, 51, 0.95);
+  color: #fff;
+}
+
+.button-container {
+  position: static;
+  margin-bottom: 1rem;
+  display: flex;
+  justify-content: center;
+  flex-wrap: wrap;
+}
+
+.padding-end-1 {
+  padding-inline-end: 1rem;
+}
+
+.link-text {
+  /* 1.0 vars*/
+  --calcite-ui-text-link: var(--calcite-color-text-inverse);
+  --calcite-ui-brand: var(--calcite-color-text-inverse);
+
+  /* 2.0 vars */
+  --calcite-color-text-link: var(--calcite-color-text-inverse);
+  --calcite-color-brand-underline: var(--calcite-color-text-inverse);
+  --calcite-color-brand: var(--calcite-color-text-inverse);
+}

package/dist/collection/components/consent-manager/consent-manager.js

@@ -0,0 +1,278 @@
+/*!
+ * Copyright 2022 Esri
+ * Licensed under the Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+/** @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.
+ */
+import { Host, h } from "@stencil/core";
+import { getLocaleComponentStrings } from "../../utils/locale";
+import { Telemetry } from "@esri/telemetry";
+import { GoogleAnalytics } from "@esri/telemetry-google-analytics";
+export class ConsentManager {
+    constructor() {
+        //--------------------------------------------------------------------------
+        //
+        //  Properties (protected)
+        //
+        //--------------------------------------------------------------------------
+        /**
+         * boolean: When true the user has granted consent and the telemetry instance will be avaliable
+         */
+        this._consentGranted = false;
+        /**
+         * boolean: When true the telemetry instance has been loaded
+         */
+        this._loaded = false;
+        this.firstUseVar = "solutions-first-use";
+        this.measurementIds = undefined;
+        this.portal = undefined;
+        this._shouldRender = undefined;
+        this._translations = undefined;
+    }
+    //--------------------------------------------------------------------------
+    //
+    //  Watch handlers
+    //
+    //--------------------------------------------------------------------------
+    //--------------------------------------------------------------------------
+    //
+    //  Methods (public)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * Initialize and return the telemetry instance if consent has been granted
+     */
+    async getInstance() {
+        if (localStorage.getItem(this.firstUseVar) === "true") {
+            await this._init();
+            return this._telemetryInstance;
+        }
+        else {
+            return undefined;
+        }
+    }
+    //--------------------------------------------------------------------------
+    //
+    //  Functions (lifecycle)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * StencilJS: Called once just after the component is first connected to the DOM.
+     *
+     * @returns Promise when complete
+     */
+    async componentWillLoad() {
+        await this._getTranslations();
+        this._shouldRender = localStorage.getItem(this.firstUseVar) === null;
+    }
+    /**
+     * Renders the component.
+     */
+    render() {
+        return this._shouldRender ? (h(Host, null, h("calcite-panel", { class: "consent-panel calcite-mode-dark", id: "cookie-policy" }, h("div", { class: "cookie-consent-popup-container" }, h("div", { id: "cookie-policy-description-top", tabindex: "-1" }, h("p", null, this._translations.dearVisitor), h("p", null, this._translations.useAnalytics)), h("div", { class: "button-container" }, h("calcite-button", { appearance: "solid", class: "padding-end-1", kind: "brand", onClick: () => this._refuse() }, this._translations.refuseAnalytics), h("calcite-button", { appearance: "solid", kind: "brand", onClick: () => this._accept() }, this._translations.acceptAnalytics)), h("div", null, h("p", null, this._translations.moreInfo, "\u00A0", h("calcite-link", { class: "link-text", href: "https://www.arcgis.com/", rel: "noopener noreferrer", target: "_blank" }, this._translations.protectionPolicy), this._translations.our, "\u00A0", h("calcite-link", { class: "link-text", href: "https://www.arcgis.com/", rel: "noopener noreferrer", target: "_blank" }, this._translations.cookiePolicy, "\u00A0"), this._translations.andOur, "\u00A0", h("calcite-link", { class: "link-text", href: "https://www.arcgis.com/", rel: "noopener noreferrer", target: "_blank" }, this._translations.cookiesInventory))))))) : undefined;
+    }
+    //--------------------------------------------------------------------------
+    //
+    //  Functions (protected)
+    //
+    //--------------------------------------------------------------------------
+    /**
+     * Fetches the component's translations
+     *
+     * @returns Promise when complete
+     * @protected
+     */
+    async _init() {
+        var _a;
+        if (!this._loaded && ((_a = this.measurementIds) === null || _a === void 0 ? void 0 : _a.length) > 0 && this.portal) {
+            const googleAnalyticsTracker = new GoogleAnalytics({
+                measurementIds: this.measurementIds
+            });
+            this._telemetryInstance = new Telemetry({
+                plugins: [googleAnalyticsTracker],
+                portal: this.portal
+            });
+            await this._telemetryInstance.init();
+            this._loaded = true;
+        }
+    }
+    /**
+     * Store the users granting of consent
+     *
+     * @protected
+     */
+    _accept() {
+        this._consentGranted = true;
+        this._handleConsent();
+    }
+    /**
+     * Store the users refusal of consent
+     *
+     * @protected
+     */
+    _refuse() {
+        this._consentGranted = false;
+        this._handleConsent();
+    }
+    /**
+     * Store and emit the users choice for consent
+     *
+     * @protected
+     */
+    _handleConsent() {
+        this._shouldRender = false;
+        localStorage.setItem(this.firstUseVar, this._consentGranted.toString());
+        this.consentGranted.emit({
+            granted: this._consentGranted
+        });
+    }
+    /**
+     * Fetches the component's translations
+     *
+     * @returns Promise when complete
+     * @protected
+     */
+    async _getTranslations() {
+        const messages = await getLocaleComponentStrings(this.el);
+        this._translations = messages[0];
+    }
+    static get is() { return "consent-manager"; }
+    static get encapsulation() { return "shadow"; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["consent-manager.css"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["consent-manager.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "firstUseVar": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "string: The name to use for the variable stored in the browsers local storge that\r\nwill keep track of the users choice for consent"
+                },
+                "attribute": "first-use-var",
+                "reflect": false,
+                "defaultValue": "\"solutions-first-use\""
+            },
+            "measurementIds": {
+                "type": "unknown",
+                "mutable": false,
+                "complexType": {
+                    "original": "string[]",
+                    "resolved": "string[]",
+                    "references": {}
+                },
+                "required": true,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "string[]: Any ids for the analytics configured to receive events from the telemety instance"
+                }
+            },
+            "portal": {
+                "type": "unknown",
+                "mutable": false,
+                "complexType": {
+                    "original": "__esri.Portal",
+                    "resolved": "Portal",
+                    "references": {
+                        "___esri": {
+                            "location": "global",
+                            "id": "global::___esri"
+                        }
+                    }
+                },
+                "required": true,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "esri/portal/Portal: https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html\r\nRequired prop for this component to function"
+                }
+            }
+        };
+    }
+    static get states() {
+        return {
+            "_shouldRender": {},
+            "_translations": {}
+        };
+    }
+    static get events() {
+        return [{
+                "method": "consentGranted",
+                "name": "consentGranted",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted on demand when the user accepts or denies consent"
+                },
+                "complexType": {
+                    "original": "IConsentResponse",
+                    "resolved": "IConsentResponse",
+                    "references": {
+                        "IConsentResponse": {
+                            "location": "import",
+                            "path": "../../utils/interfaces",
+                            "id": "src/utils/interfaces.ts::IConsentResponse"
+                        }
+                    }
+                }
+            }];
+    }
+    static get methods() {
+        return {
+            "getInstance": {
+                "complexType": {
+                    "signature": "() => Promise<Telemetry | undefined>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        },
+                        "Telemetry": {
+                            "location": "global",
+                            "id": "global::Telemetry"
+                        }
+                    },
+                    "return": "Promise<any>"
+                },
+                "docs": {
+                    "text": "Initialize and return the telemetry instance if consent has been granted",
+                    "tags": []
+                }
+            }
+        };
+    }
+    static get elementRef() { return "el"; }
+}

package/dist/collection/components/consent-manager/test/consent-manager.e2e.js

@@ -0,0 +1,29 @@
+/*!
+ * Copyright 2022 Esri
+ * Licensed under the Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+/** @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.
+ */
+import { newE2EPage } from "@stencil/core/testing";
+xdescribe('consent-manager', () => {
+    it('renders', async () => {
+        const page = await newE2EPage();
+        await page.setContent('<consent-manager></consent-manager>');
+        const element = await page.find('consent-manager');
+        expect(element).toHaveClass('hydrated');
+    });
+});

package/dist/collection/components/consent-manager/test/consent-manager.spec.js

@@ -0,0 +1,37 @@
+/*!
+ * Copyright 2022 Esri
+ * Licensed under the Apache License, Version 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+/** @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.
+ */
+import { newSpecPage } from "@stencil/core/testing";
+import { ConsentManager } from "../consent-manager";
+xdescribe('consent-manager', () => {
+    it('renders', async () => {
+        const page = await newSpecPage({
+            components: [ConsentManager],
+            html: `<consent-manager></consent-manager>`,
+        });
+        expect(page.root).toEqualHtml(`
+      <consent-manager>
+        <mock:shadow-root>
+          <slot></slot>
+        </mock:shadow-root>
+      </consent-manager>
+    `);
+    });
+});

package/dist/collection/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/components/_commonjsHelpers.js

@@ -19,8 +19,23 @@ function createCommonjsModule(fn, basedir, module) {
 	}, fn(module, module.exports), module.exports;
 }
 
+function getAugmentedNamespace(n) {
+	if (n.__esModule) return n;
+	var a = Object.defineProperty({}, '__esModule', {value: true});
+	Object.keys(n).forEach(function (k) {
+		var d = Object.getOwnPropertyDescriptor(n, k);
+		Object.defineProperty(a, k, d.get ? d : {
+			enumerable: true,
+			get: function () {
+				return n[k];
+			}
+		});
+	});
+	return a;
+}
+
 function commonjsRequire () {
 	throw new Error('Dynamic requires are not currently supported by @rollup/plugin-commonjs');
 }
 
-export { commonjsGlobal as a, commonjsRequire as b, createCommonjsModule as c, getDefaultExportFromCjs as g };
+export { commonjsGlobal as a, commonjsRequire as b, createCommonjsModule as c, getDefaultExportFromCjs as d, getAugmentedNamespace as g };

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

@@ -0,0 +1,11 @@
+import type { Components, JSX } from "../types/components";
+
+interface ConsentManager extends Components.ConsentManager, HTMLElement {}
+export const ConsentManager: {
+    prototype: ConsentManager;
+    new (): ConsentManager;
+};
+/**
+ * Used to define this component and all nested components recursively.
+ */
+export const defineCustomElement: () => void;