@adobe/ccweb-add-on-analytics 3.0.0 → 3.1.0

package/dist/app/WxpAnalyticsService.js

@@ -1,112 +0,0 @@
-/********************************************************************************
- * 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 axios from "axios";
-import { inject, injectable } from "inversify";
-import osName from "os-name";
-import "reflect-metadata";
-import { ANALYTICS_API } from "../constants.js";
-import { CLIProgram } from "../models/index.js";
-/**
- * Analytics service implementation.
- */
-let WxpAnalyticsService = class WxpAnalyticsService {
-    _preferences;
-    _program;
-    _startTime;
-    /**
-     * Instantiate {@link WxpAnalyticsService}.
-     * @param preferences - {@link Preferences} reference.
-     * @returns Reference to a new {@link WxpAnalyticsService} instance.
-     */
-    constructor(preferences) {
-        this._preferences = preferences;
-        this._program = new CLIProgram("", "");
-        this._startTime = Date.now();
-    }
-    /**
-     * Set the program which is being executed.
-     * @param program - {@link CLIProgram} reference.
-     */
-    set program(program) {
-        this._program = program;
-    }
-    /**
-     * Set the start time of an operation.
-     */
-    set startTime(time) {
-        this._startTime = time;
-    }
-    /**
-     * 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.
-     */
-    async postEvent(eventType, eventData, isSuccess) {
-        try {
-            const userPreferences = this._preferences.get();
-            if (!userPreferences.hasTelemetryConsent) {
-                return;
-            }
-            const currentTime = Date.now();
-            const body = JSON.stringify({
-                id: Math.floor(currentTime * Math.random()),
-                timestamp: currentTime,
-                _adobeio: {
-                    eventType,
-                    eventData,
-                    cliVersion: this._program.version,
-                    clientId: this._getClientId(),
-                    command: this._program.name,
-                    commandDuration: currentTime - this._startTime,
-                    commandSuccess: isSuccess,
-                    nodeVersion: process.version,
-                    osNameVersion: osName()
-                }
-            });
-            await axios.post(ANALYTICS_API.URL, body, { headers: ANALYTICS_API.HEADERS });
-        }
-        catch {
-            return;
-        }
-    }
-    _getClientId() {
-        const userPreferences = this._preferences.get();
-        if (userPreferences.clientId === undefined) {
-            userPreferences.clientId = Math.floor(Date.now() * Math.random());
-            this._preferences.set(userPreferences);
-        }
-        return userPreferences.clientId;
-    }
-};
-WxpAnalyticsService = __decorate([
-    injectable(),
-    __param(0, inject(ICoreTypes.Preferences)),
-    __metadata("design:paramtypes", [Object])
-], WxpAnalyticsService);
-export { WxpAnalyticsService };
-//# sourceMappingURL=WxpAnalyticsService.js.map

package/src/app/WxpAnalyticsConsent.ts

@@ -1,119 +0,0 @@
-/********************************************************************************
- * 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 { 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";
-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.
- */
-@injectable()
-export class WxpAnalyticsConsent implements AnalyticsConsent {
-    private readonly _preferences: Preferences;
-    private readonly _logger: Logger;
-
-    /**
-     * Instantiate {@link WxpAnalyticsConsent}.
-     * @param preferences - {@link Preferences} reference.
-     * @param logger - {@link Logger} reference.
-     * @returns Reference to a new {@link WxpAnalyticsConsent} instance.
-     */
-    constructor(@inject(ICoreTypes.Preferences) preferences: Preferences, @inject(ICoreTypes.Logger) logger: 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(): Promise<boolean> {
-        // 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: boolean): Promise<void> {
-        const preferenceData = this._preferences.get();
-        preferenceData.hasTelemetryConsent = consent;
-        this._preferences.set(preferenceData);
-    }
-
-    private _promptMessage(message: string): string {
-        return chalk.hex("#E59400")(message);
-    }
-
-    private _promptMessageOption(message: string): string {
-        return chalk.green.bold(message);
-    }
-}
-
-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"
-};

package/src/app/WxpAnalyticsService.ts

@@ -1,120 +0,0 @@
-/********************************************************************************
- * 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 { ITypes as ICoreTypes } from "@adobe/ccweb-add-on-core";
-import axios from "axios";
-import { inject, injectable } from "inversify";
-import osName from "os-name";
-import "reflect-metadata";
-import { ANALYTICS_API } from "../constants.js";
-import { CLIProgram } from "../models/index.js";
-import type { AnalyticsService } from "./AnalyticsService.js";
-
-/**
- * Analytics service implementation.
- */
-@injectable()
-export class WxpAnalyticsService implements AnalyticsService {
-    private readonly _preferences: Preferences;
-
-    private _program: CLIProgram;
-
-    private _startTime: number;
-
-    /**
-     * Instantiate {@link WxpAnalyticsService}.
-     * @param preferences - {@link Preferences} reference.
-     * @returns Reference to a new {@link WxpAnalyticsService} instance.
-     */
-    constructor(@inject(ICoreTypes.Preferences) preferences: Preferences) {
-        this._preferences = preferences;
-
-        this._program = new CLIProgram("", "");
-
-        this._startTime = Date.now();
-    }
-
-    /**
-     * Set the program which is being executed.
-     * @param program - {@link CLIProgram} reference.
-     */
-    set program(program: CLIProgram) {
-        this._program = program;
-    }
-
-    /**
-     * Set the start time of an operation.
-     */
-    set startTime(time: number) {
-        this._startTime = time;
-    }
-
-    /**
-     * 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.
-     */
-    async postEvent(eventType: string, eventData: string, isSuccess: boolean): Promise<void> {
-        try {
-            const userPreferences = this._preferences.get();
-            if (!userPreferences.hasTelemetryConsent) {
-                return;
-            }
-
-            const currentTime = Date.now();
-            const body = JSON.stringify({
-                id: Math.floor(currentTime * Math.random()),
-                timestamp: currentTime,
-                _adobeio: {
-                    eventType,
-                    eventData,
-                    cliVersion: this._program.version,
-                    clientId: this._getClientId(),
-                    command: this._program.name,
-                    commandDuration: currentTime - this._startTime,
-                    commandSuccess: isSuccess,
-                    nodeVersion: process.version,
-                    osNameVersion: osName()
-                }
-            });
-
-            await axios.post(ANALYTICS_API.URL, body, { headers: ANALYTICS_API.HEADERS });
-        } catch {
-            return;
-        }
-    }
-
-    private _getClientId(): number {
-        const userPreferences = this._preferences.get();
-        if (userPreferences.clientId === undefined) {
-            userPreferences.clientId = Math.floor(Date.now() * Math.random());
-            this._preferences.set(userPreferences);
-        }
-
-        return userPreferences.clientId;
-    }
-}