@adobe/ccweb-add-on-analytics 0.1.0

package/.c8rc.json

@@ -0,0 +1,14 @@
+{
+    "all": true,
+    "include": ["src/**/*.ts"],
+    "exclude": [
+        "src/**/*.spec.ts",
+        "src/**/*Types.ts",
+        "src/**/index.ts",
+        "src/config/*",
+        "src/constants.ts",
+        "**/*.d.ts"
+    ],
+    "reporter": ["html", "text", "text-summary"],
+    "report-dir": "coverage"
+}

package/.mocharc.json

@@ -0,0 +1,5 @@
+{
+    "extension": ["ts"],
+    "node-option": ["experimental-specifier-resolution=node", "loader=ts-node/esm", "no-warnings"],
+    "spec": ["src/test/**/*.spec.ts"]
+}

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,79 @@
+# Adobe Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contribute to a positive environment for our project and community include:
+
+-   Demonstrating empathy and kindness toward other people
+-   Being respectful of differing opinions, viewpoints, and experiences
+-   Giving and gracefully accepting constructive feedback
+-   Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+-   Focusing on what is best, not just for us as individuals but for the overall community
+
+Examples of unacceptable behavior include:
+
+-   The use of sexualized language or imagery, and sexual attention or advances of any kind
+-   Trolling, insulting or derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others’ private information, such as a physical or email address, without their explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies when an individual is representing the project or its community both within project spaces and in public spaces. Examples of representing a project or community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by first contacting the project team. Oversight of Adobe projects is handled by the Adobe Open Source Office, which has final say in any violations and enforcement of this Code of Conduct and can be reached at Grp-opensourceoffice@adobe.com. All complaints will be reviewed and investigated promptly and fairly.
+
+The project team must respect the privacy and security of the reporter of any incident.
+
+Project maintainers who do not follow or enforce the Code of Conduct may face temporary or permanent repercussions as determined by other members of the project's leadership or the Adobe Open Source Office.
+
+## Enforcement Guidelines
+
+Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem to be in violation of this Code of Conduct:
+
+**1. Correction**
+
+Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+Consequence: A private, written warning from project maintainers describing the violation and why the behavior was unacceptable. A public apology may be requested from the violator before any further involvement in the project by violator.
+
+**2. Warning**
+
+Community Impact: A relatively minor violation through a single incident or series of actions.
+
+Consequence: A written warning from project maintainers that includes stated consequences for continued unacceptable behavior. Violator must refrain from interacting with the people involved for a specified period of time as determined by the project maintainers, including, but not limited to, unsolicited interaction with those enforcing the Code of Conduct through channels such as community spaces and social media. Continued violations may lead to a temporary or permanent ban.
+
+**3. Temporary Ban**
+
+Community Impact: A more serious violation of community standards, including sustained unacceptable behavior.
+
+Consequence: A temporary ban from any interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Failure to comply with the temporary ban may lead to a permanent ban.
+
+**4. Permanent Ban**
+
+Community Impact: Demonstrating a consistent pattern of violation of community standards or an egregious violation of community standards, including, but not limited to, sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+Consequence: A permanent ban from any interaction with the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1,
+available at [http://contributor-covenant.org/version/2/1][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/2/1

package/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing
+
+Thanks for choosing to contribute!
+
+The following are a set of guidelines to follow when contributing to this project.
+
+## Code Of Conduct
+
+This project adheres to the Adobe [code of conduct](../CODE_OF_CONDUCT.md). By participating,
+you are expected to uphold this code. Please report unacceptable behavior to
+[Grp-opensourceoffice@adobe.com](mailto:Grp-opensourceoffice@adobe.com).
+
+## Have A Question?
+
+Start by filing an issue. The existing committers on this project work to reach
+consensus around project direction and issue solutions within issue threads
+(when appropriate).
+
+## Contributor License Agreement
+
+All third-party contributions to this project must be accompanied by a signed contributor
+license agreement. This gives Adobe permission to redistribute your contributions
+as part of the project. [Sign our CLA](https://opensource.adobe.com/cla.html). You
+only need to submit an Adobe CLA one time, so if you have submitted one previously,
+you are good to go!
+
+## Code Reviews
+
+All submissions should come in the form of pull requests and need to be reviewed
+by project committers. Read [GitHub's pull request documentation](https://help.github.com/articles/about-pull-requests/)
+for more information on sending pull requests.
+
+Lastly, please follow the [pull request template](PULL_REQUEST_TEMPLATE.md) when
+submitting a pull request!
+
+## From Contributor To Committer
+
+We love contributions from our community! If you'd like to go a step beyond contributor
+and become a committer with full write access and a say in the project, you must
+be invited to the project. The existing committers employ an internal nomination
+process that must reach lazy consensus (silence is approval) before invitations
+are issued. If you feel you are qualified and want to get more deeply involved,
+feel free to reach out to existing committers to have a conversation about that.
+
+## Security Issues
+
+Security issues shouldn't be reported on this issue tracker. Instead, [file an issue to our security experts](https://helpx.adobe.com/security/alertus.html).

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+© Copyright 2023 Adobe. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# @adobe/ccweb-add-on-analytics
+
+[![Version](https://img.shields.io/npm/v/@adobe/ccweb-add-on-analytics.svg)](https://npmjs.org/package/@adobe/ccweb-add-on-analytics)
+[![Downloads/week](https://img.shields.io/npm/dw/@adobe/ccweb-add-on-analytics.svg)](https://npmjs.org/package/@adobe/ccweb-add-on-analytics)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit)
+
+## Description
+
+This package provides libraries for capturing analytics events from [@adobe/create-ccweb-add-on](https://www.npmjs.com/package/@adobe/create-ccweb-add-on) runs and sending those to Adobe, therefore providing invaluable insights on usage of the application. With this, Adobe can further improve the experience it provides to its developers.
+
+Please be assured that no confidential information is captured or shared. Besides, analytics events are captured only when you provide consent. If at any point of time, you decide to revoke your consent, you may do so by running any of the `ccweb-add-on` commands with the flag `--analytics off`. Similarly, if you wish to turn it back on, you may use the flag `--analytics on`.
+
+For more information about developing Adobe Express add-ons, check out the [documentation](https://developer.adobe.com/express/add-ons/).

package/dist/app/AnalyticsConsent.d.ts

@@ -0,0 +1,40 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+/**
+ * Contract to get and set user's consent
+ * on allowing the application to collect and send analytics to Adobe.
+ */
+export interface AnalyticsConsent {
+    /**
+     * Get user consent to collect and send analytics to Adobe.
+     * @returns Promise of boolean value representing whether the user has provided consent.
+     */
+    get(): Promise<boolean>;
+    /**
+     * Set user consent to collect and send analytics to Adobe.
+     * @param consent - Boolean value representing whether the user has provided consent.
+     */
+    set(consent: boolean): Promise<void>;
+}
+//# sourceMappingURL=AnalyticsConsent.d.ts.map

package/dist/app/AnalyticsConsent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsConsent.d.ts","sourceRoot":"","sources":["../../src/app/AnalyticsConsent.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAExB;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxC"}

package/dist/app/AnalyticsConsent.js

@@ -0,0 +1,25 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+export {};
+//# sourceMappingURL=AnalyticsConsent.js.map

package/dist/app/AnalyticsService.d.ts

@@ -0,0 +1,47 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+import { CLIProgram } from "../models/index.js";
+/**
+ * Analytics service contracts.
+ */
+export interface AnalyticsService {
+    /**
+     * Set the program which is being executed.
+     * @param program - {@link CLIProgram} reference.
+     */
+    set program(program: CLIProgram);
+    /**
+     * Set the start time of an operation.
+     */
+    set startTime(time: number);
+    /**
+     * Post an event to Adobe analytics service.
+     * @param eventType - Event type, either a SUCCESS, or an ERROR.
+     * @param eventData - Event data.
+     * @param isSuccess - Does the event represent a successful operation.
+     * @returns Promise.
+     */
+    postEvent(eventType: string, eventData: string, isSuccess: boolean): Promise<void>;
+}
+//# sourceMappingURL=AnalyticsService.d.ts.map

package/dist/app/AnalyticsService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsService.d.ts","sourceRoot":"","sources":["../../src/app/AnalyticsService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,IAAI,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE;IAEjC;;OAEG;IACH,IAAI,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE;IAE5B;;;;;;OAMG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtF"}

package/dist/app/AnalyticsService.js

@@ -0,0 +1,25 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+export {};
+//# sourceMappingURL=AnalyticsService.js.map

package/dist/app/WxpAnalyticsConsent.d.ts

@@ -0,0 +1,54 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+import type { Logger, Preferences } from "@adobe/ccweb-add-on-core";
+import "reflect-metadata";
+import type { AnalyticsConsent } from "./AnalyticsConsent.js";
+/**
+ * Implementation class to get and set user's consent
+ * on allowing the application to collect and send analytics to Adobe.
+ */
+export declare class WxpAnalyticsConsent implements AnalyticsConsent {
+    private readonly _preferences;
+    private readonly _logger;
+    /**
+     * Instantiate {@link WxpAnalyticsConsent}.
+     * @param preferences - {@link Preferences} reference.
+     * @param logger - {@link Logger} reference.
+     * @returns Reference to a new {@link WxpAnalyticsConsent} instance.
+     */
+    constructor(preferences: Preferences, logger: Logger);
+    /**
+     * Get user consent to collect and send analytics to Adobe.
+     * @returns Promise of boolean value representing whether the user has provided consent.
+     */
+    get(): Promise<boolean>;
+    /**
+     * Set user consent to collect and send analytics to Adobe.
+     * @param consent - Boolean value representing whether the user has provided consent.
+     */
+    set(consent: boolean): Promise<void>;
+    private _promptMessage;
+    private _promptMessageOption;
+}
+//# sourceMappingURL=WxpAnalyticsConsent.d.ts.map

package/dist/app/WxpAnalyticsConsent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WxpAnalyticsConsent.d.ts","sourceRoot":"","sources":["../../src/app/WxpAnalyticsConsent.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAKpE,OAAO,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D;;;GAGG;AACH,qBACa,mBAAoB,YAAW,gBAAgB;IACxD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;;;;OAKG;gBACyC,WAAW,EAAE,WAAW,EAA6B,MAAM,EAAE,MAAM;IAK/G;;;OAGG;IACG,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;IAqC7B;;;OAGG;IACG,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1C,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,oBAAoB;CAG/B"}

package/dist/app/WxpAnalyticsConsent.js

@@ -0,0 +1,113 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+import { __decorate, __metadata, __param } from "tslib";
+import { ITypes as ICoreTypes } from "@adobe/ccweb-add-on-core";
+import chalk from "chalk";
+import { inject, injectable } from "inversify";
+import prompts from "prompts";
+import "reflect-metadata";
+/**
+ * Implementation class to get and set user's consent
+ * on allowing the application to collect and send analytics to Adobe.
+ */
+let WxpAnalyticsConsent = class WxpAnalyticsConsent {
+    _preferences;
+    _logger;
+    /**
+     * Instantiate {@link WxpAnalyticsConsent}.
+     * @param preferences - {@link Preferences} reference.
+     * @param logger - {@link Logger} reference.
+     * @returns Reference to a new {@link WxpAnalyticsConsent} instance.
+     */
+    constructor(preferences, logger) {
+        this._preferences = preferences;
+        this._logger = logger;
+    }
+    /**
+     * Get user consent to collect and send analytics to Adobe.
+     * @returns Promise of boolean value representing whether the user has provided consent.
+     */
+    async get() {
+        // Always get the preference from cache
+        // for checking the analytics consent
+        // to avoid a file IO operation.
+        const preferenceData = this._preferences.get(true);
+        if (preferenceData.hasTelemetryConsent !== undefined) {
+            return preferenceData.hasTelemetryConsent;
+        }
+        this._logger.warning(LOGS.toolCollectsAnalytics, { prefix: LOGS.newLine });
+        const choices = [
+            {
+                title: this._promptMessageOption(LOGS.yesSendAnalytics),
+                value: true
+            },
+            {
+                title: this._promptMessageOption(LOGS.noDontSendAnalytics),
+                value: false
+            }
+        ];
+        const response = await prompts.prompt({
+            type: "select",
+            name: "analyticsConsent",
+            message: this._promptMessage(LOGS.sendToAdobe),
+            choices,
+            initial: 0
+        });
+        if (!response || response.analyticsConsent === undefined) {
+            return process.exit(0);
+        }
+        await this.set(response.analyticsConsent);
+        return response.analyticsConsent;
+    }
+    /**
+     * Set user consent to collect and send analytics to Adobe.
+     * @param consent - Boolean value representing whether the user has provided consent.
+     */
+    async set(consent) {
+        const preferenceData = this._preferences.get();
+        preferenceData.hasTelemetryConsent = consent;
+        this._preferences.set(preferenceData);
+    }
+    _promptMessage(message) {
+        return chalk.hex("#E59400")(message);
+    }
+    _promptMessageOption(message) {
+        return chalk.green.bold(message);
+    }
+};
+WxpAnalyticsConsent = __decorate([
+    injectable(),
+    __param(0, inject(ICoreTypes.Preferences)),
+    __param(1, inject(ICoreTypes.Logger)),
+    __metadata("design:paramtypes", [Object, Object])
+], WxpAnalyticsConsent);
+export { WxpAnalyticsConsent };
+const LOGS = {
+    newLine: "\n",
+    yesSendAnalytics: "Yes, send analytics to Adobe",
+    noDontSendAnalytics: "No, don't send analytics to Adobe",
+    toolCollectsAnalytics: "This tool collects and sends analytics to help Adobe improve its products.",
+    sendToAdobe: "Do you want to allow sending analytics to Adobe"
+};
+//# sourceMappingURL=WxpAnalyticsConsent.js.map

package/dist/app/WxpAnalyticsService.d.ts

@@ -0,0 +1,60 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+import type { Preferences } from "@adobe/ccweb-add-on-core";
+import "reflect-metadata";
+import { CLIProgram } from "../models/index.js";
+import type { AnalyticsService } from "./AnalyticsService";
+/**
+ * Analytics service implementation.
+ */
+export declare class WxpAnalyticsService implements AnalyticsService {
+    private readonly _preferences;
+    private _program;
+    private _startTime;
+    /**
+     * Instantiate {@link WxpAnalyticsService}.
+     * @param preferences - {@link Preferences} reference.
+     * @returns Reference to a new {@link WxpAnalyticsService} instance.
+     */
+    constructor(preferences: Preferences);
+    /**
+     * Set the program which is being executed.
+     * @param program - {@link CLIProgram} reference.
+     */
+    set program(program: CLIProgram);
+    /**
+     * Set the start time of an operation.
+     */
+    set startTime(time: number);
+    /**
+     * Post an event to Adobe analytics service.
+     * @param eventType - Event type, either a SUCCESS, or an ERROR.
+     * @param eventData - Event data.
+     * @param isSuccess - Does the event represent a successful operation.
+     * @returns Promise.
+     */
+    postEvent(eventType: string, eventData: string, isSuccess: boolean): Promise<void>;
+    private _getClientId;
+}
+//# sourceMappingURL=WxpAnalyticsService.d.ts.map

package/dist/app/WxpAnalyticsService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WxpAnalyticsService.d.ts","sourceRoot":"","sources":["../../src/app/WxpAnalyticsService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAK5D,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;GAEG;AACH,qBACa,mBAAoB,YAAW,gBAAgB;IACxD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAE3C,OAAO,CAAC,QAAQ,CAAa;IAE7B,OAAO,CAAC,UAAU,CAAS;IAE3B;;;;OAIG;gBACyC,WAAW,EAAE,WAAW;IAQpE;;;OAGG;IACH,IAAI,OAAO,CAAC,OAAO,EAAE,UAAU,EAE9B;IAED;;OAEG;IACH,IAAI,SAAS,CAAC,IAAI,EAAE,MAAM,EAEzB;IAED;;;;;;OAMG;IACG,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BxF,OAAO,CAAC,YAAY;CASvB"}