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

package/.c8rc.json

@@ -10,6 +10,10 @@
         "src/config/*",
         "src/constants.ts"
     ],
+    "lines": 100,
+    "functions": 100,
+    "branches": 100,
+    "statements": 100,
     "reporter": ["html", "text", "text-summary"],
     "report-dir": "coverage"
 }

package/dist/app/AnalyticsConsent.d.ts

@@ -21,11 +21,23 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  ********************************************************************************/
+import type { Logger } from "@adobe/ccweb-add-on-core";
+import { UserPreferences } from "@adobe/ccweb-add-on-core";
+import "reflect-metadata";
 /**
- * Contract to get and set user's consent
+ * Implementation class to get and set user's consent
  * on allowing the application to collect and send analytics to Adobe.
  */
-export interface AnalyticsConsent {
+export declare class AnalyticsConsent {
+    private readonly _preferences;
+    private readonly _logger;
+    /**
+     * Instantiate {@link AnalyticsConsent}.
+     * @param preferences - {@link UserPreferences} reference.
+     * @param logger - {@link Logger} reference.
+     * @returns Reference to a new {@link AnalyticsConsent} instance.
+     */
+    constructor(preferences: UserPreferences, logger: Logger);
     /**
      * Get user consent to collect and send analytics to Adobe.
      * @returns Promise of boolean value representing whether the user has provided consent.
@@ -36,5 +48,7 @@ export interface AnalyticsConsent {
      * @param consent - Boolean value representing whether the user has provided consent.
      */
     set(consent: boolean): Promise<void>;
+    private _promptMessage;
+    private _promptMessageOption;
 }
 //# sourceMappingURL=AnalyticsConsent.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"AnalyticsConsent.d.ts","sourceRoot":"","sources":["../../src/app/AnalyticsConsent.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAwB,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAIjF,OAAO,kBAAkB,CAAC;AAE1B;;;GAGG;AACH,qBACa,gBAAgB;IACzB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkB;IAC/C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;;;;OAKG;gBAEqC,WAAW,EAAE,eAAe,EACrC,MAAM,EAAE,MAAM;IAM7C;;;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/AnalyticsConsent.js

@@ -21,5 +21,93 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  ********************************************************************************/
-export {};
+import { __decorate, __metadata, __param } from "tslib";
+import { ITypes as ICoreTypes, UserPreferences } 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 AnalyticsConsent = class AnalyticsConsent {
+    _preferences;
+    _logger;
+    /**
+     * Instantiate {@link AnalyticsConsent}.
+     * @param preferences - {@link UserPreferences} reference.
+     * @param logger - {@link Logger} reference.
+     * @returns Reference to a new {@link AnalyticsConsent} 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);
+    }
+};
+AnalyticsConsent = __decorate([
+    injectable(),
+    __param(0, inject(ICoreTypes.UserPreferences)),
+    __param(1, inject(ICoreTypes.Logger)),
+    __metadata("design:paramtypes", [UserPreferences, Object])
+], AnalyticsConsent);
+export { AnalyticsConsent };
+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=AnalyticsConsent.js.map

package/dist/app/AnalyticsService.d.ts

@@ -21,11 +21,22 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  ********************************************************************************/
-import { CLIProgram } from "../models/index.js";
+import { UserPreferences } from "@adobe/ccweb-add-on-core";
+import "reflect-metadata";
+import { CLIProgram } from "../models/CLIProgram.js";
 /**
- * Analytics service contracts.
+ * Analytics service implementation.
  */
-export interface AnalyticsService {
+export declare class AnalyticsService {
+    private readonly _preferences;
+    private _program;
+    private _startTime;
+    /**
+     * Instantiate {@link AnalyticsService}.
+     * @param preferences - {@link UserPreferences} reference.
+     * @returns Reference to a new {@link AnalyticsService} instance.
+     */
+    constructor(preferences: UserPreferences);
     /**
      * Set the program which is being executed.
      * @param program - {@link CLIProgram} reference.
@@ -43,5 +54,6 @@ export interface AnalyticsService {
      * @returns Promise.
      */
     postEvent(eventType: string, eventData: string, isSuccess: boolean): Promise<void>;
+    private _getClientId;
 }
 //# sourceMappingURL=AnalyticsService.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"AnalyticsService.d.ts","sourceRoot":"","sources":["../../src/app/AnalyticsService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,EAAwB,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAIjF,OAAO,kBAAkB,CAAC;AAE1B,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD;;GAEG;AACH,qBACa,gBAAgB;IACzB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkB;IAE/C,OAAO,CAAC,QAAQ,CAAa;IAE7B,OAAO,CAAC,UAAU,CAAS;IAE3B;;;;OAIG;gBAC6C,WAAW,EAAE,eAAe;IAQ5E;;;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"}

package/dist/app/AnalyticsService.js

@@ -21,5 +21,92 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  ********************************************************************************/
-export {};
+import { __decorate, __metadata, __param } from "tslib";
+import { ITypes as ICoreTypes, UserPreferences } 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/CLIProgram.js";
+/**
+ * Analytics service implementation.
+ */
+let AnalyticsService = class AnalyticsService {
+    _preferences;
+    _program;
+    _startTime;
+    /**
+     * Instantiate {@link AnalyticsService}.
+     * @param preferences - {@link UserPreferences} reference.
+     * @returns Reference to a new {@link AnalyticsService} 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;
+    }
+};
+AnalyticsService = __decorate([
+    injectable(),
+    __param(0, inject(ICoreTypes.UserPreferences)),
+    __metadata("design:paramtypes", [UserPreferences])
+], AnalyticsService);
+export { AnalyticsService };
 //# sourceMappingURL=AnalyticsService.js.map

package/dist/app/index.d.ts

@@ -23,6 +23,4 @@
  ********************************************************************************/
 export * from "./AnalyticsConsent.js";
 export * from "./AnalyticsService.js";
-export * from "./WxpAnalyticsConsent.js";
-export * from "./WxpAnalyticsService.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/app/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/app/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC"}

package/dist/app/index.js

@@ -23,6 +23,4 @@
  ********************************************************************************/
 export * from "./AnalyticsConsent.js";
 export * from "./AnalyticsService.js";
-export * from "./WxpAnalyticsConsent.js";
-export * from "./WxpAnalyticsService.js";
 //# sourceMappingURL=index.js.map

package/dist/base/BaseCommand.d.ts

@@ -21,11 +21,12 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  ********************************************************************************/
-import { Command, Config } from "@oclif/core";
-import { BooleanFlag, CustomOptions, OptionFlag } from "@oclif/core/lib/interfaces/parser.js";
-import { AnalyticsConsent } from "../app/AnalyticsConsent.js";
-import { AnalyticsService } from "../app/AnalyticsService.js";
-import { CLIProgram } from "../models/index.js";
+import type { Config } from "@oclif/core";
+import { Command } from "@oclif/core";
+import type { BooleanFlag, CustomOptions, OptionFlag } from "@oclif/core/lib/interfaces/parser.js";
+import type { AnalyticsConsent } from "../app/AnalyticsConsent.js";
+import type { AnalyticsService } from "../app/AnalyticsService.js";
+import type { CLIProgram } from "../models/CLIProgram.js";
 export declare abstract class BaseCommand extends Command {
     protected readonly _analyticsConsent: AnalyticsConsent;
     protected readonly _analyticsService: AnalyticsService;

package/dist/base/BaseCommand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCommand.d.ts","sourceRoot":"","sources":["../../src/base/BaseCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,EAAE,OAAO,EAAE,MAAM,EAAS,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,8BAAsB,WAAY,SAAQ,OAAO;IAC7C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;IACvD,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;gBAE3C,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU;IAU/D,MAAM,CAAC,SAAS,EAAE;QACd,SAAS,EAAE,UAAU,CAAC,MAAM,GAAG,SAAS,EAAE,aAAa,CAAC,CAAC;QACzD,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;KACjC,CAaC;cAEc,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAOtF"}
+{"version":3,"file":"BaseCommand.d.ts","sourceRoot":"","sources":["../../src/base/BaseCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAS,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AACnG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,8BAAsB,WAAY,SAAQ,OAAO;IAC7C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;IACvD,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;gBAE3C,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU;IAU/D,MAAM,CAAC,SAAS,EAAE;QACd,SAAS,EAAE,UAAU,CAAC,MAAM,GAAG,SAAS,EAAE,aAAa,CAAC,CAAC;QACzD,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;KACjC,CAaC;cAEc,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAOtF"}

package/dist/config/inversify.config.d.ts

@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  ********************************************************************************/
+import type { Container } from "inversify";
 import "reflect-metadata";
-import { Container } from "inversify";
 declare const container: Container;
 export { container as IContainer };
 //# sourceMappingURL=inversify.config.d.ts.map

package/dist/config/inversify.config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inversify.config.d.ts","sourceRoot":"","sources":["../../src/config/inversify.config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAGlF,OAAO,kBAAkB,CAAC;AAI1B,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,QAAA,MAAM,SAAS,EAAE,SAA0B,CAAC;AAM5C,OAAO,EAAE,SAAS,IAAI,UAAU,EAAE,CAAC"}
+{"version":3,"file":"inversify.config.d.ts","sourceRoot":"","sources":["../../src/config/inversify.config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAGlF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,kBAAkB,CAAC;AAK1B,QAAA,MAAM,SAAS,EAAE,SAA0B,CAAC;AAM5C,OAAO,EAAE,SAAS,IAAI,UAAU,EAAE,CAAC"}

package/dist/config/inversify.config.js

@@ -23,10 +23,11 @@
  ********************************************************************************/
 import { IContainer as ICoreContainer } from "@adobe/ccweb-add-on-core";
 import "reflect-metadata";
-import { WxpAnalyticsConsent, WxpAnalyticsService } from "../app/index.js";
+import { AnalyticsConsent } from "../app/AnalyticsConsent.js";
+import { AnalyticsService } from "../app/AnalyticsService.js";
 import { ITypes } from "./inversify.types.js";
 const container = ICoreContainer;
-container.bind(ITypes.AnalyticsConsent).to(WxpAnalyticsConsent).inSingletonScope();
-container.bind(ITypes.AnalyticsService).to(WxpAnalyticsService).inSingletonScope();
+container.bind(ITypes.AnalyticsConsent).to(AnalyticsConsent).inSingletonScope();
+container.bind(ITypes.AnalyticsService).to(AnalyticsService).inSingletonScope();
 export { container as IContainer };
 //# sourceMappingURL=inversify.config.js.map