@slicemachine/manager 0.1.1-dev-plugins-testing.0 → 0.1.1-dev-plugins-validation.0

package/dist/managers/telemetry/TelemetryManager.cjs

@@ -20,31 +20,25 @@ function assertTelemetryInitialized(segmentClient) {
 class TelemetryManager extends BaseManager.BaseManager {
   constructor() {
     super(...arguments);
-    __publicField(this, "_enabled", false);
     __publicField(this, "_segmentClient");
     __publicField(this, "_anonymousID");
     __publicField(this, "_userID");
+    __publicField(this, "_context");
   }
-  async initTelemetry() {
+  async initTelemetry(args) {
     if (this._segmentClient) {
       return;
     }
-    let root;
-    try {
-      root = await this.project.getRoot();
-    } catch {
-      root = await this.project.suggestRoot();
-    }
-    this._enabled = prismicrc.readPrismicrc(root).telemetry !== false;
     this._segmentClient = new SegmentClient(API_TOKENS.API_TOKENS.SegmentKey, {
       // Since it's a local app, we do not benefit from event batching the way a server would normally do, all tracking event will be awaited.
       flushAt: 1,
       // TODO: Verify that this actually does not send data to Segment when false.
-      enable: this._enabled,
+      enable: await this.checkIsTelemetryEnabled(),
       errorHandler: () => {
       }
     });
     this._anonymousID = crypto.randomUUID();
+    this._context = { app: { name: args.appName, version: args.appVersion } };
   }
   // TODO: Should `userId` be automatically populated by the logged in
   // user? We already have their info via UserRepository.
@@ -54,9 +48,11 @@ class TelemetryManager extends BaseManager.BaseManager {
     const payload = {
       event: types.HumanSegmentEventType[event],
       properties: {
+        nodeVersion: process.versions.node,
         repo: repository,
         ...properties
-      }
+      },
+      context: { ...this._context }
     };
     if (this._userID) {
       payload.userId = this._userID;
@@ -82,18 +78,19 @@ class TelemetryManager extends BaseManager.BaseManager {
   // by the logged in user? We already have their info via
   // UserRepository.
   identify(args) {
+    const payload = {
+      userId: args.userID,
+      anonymousId: this._anonymousID,
+      integrations: {
+        Intercom: {
+          user_hash: args.intercomHash
+        }
+      },
+      context: { ...this._context }
+    };
+    this._userID = args.userID;
     return new Promise((resolve) => {
       assertTelemetryInitialized(this._segmentClient);
-      const payload = {
-        userId: args.userID,
-        anonymousId: this._anonymousID,
-        integrations: {
-          Intercom: {
-            user_hash: args.intercomHash
-          }
-        }
-      };
-      this._userID = args.userID;
       this._segmentClient.identify(payload, (maybeError) => {
         if (maybeError) {
           console.warn(`An error occurred during Segment identify`, maybeError);
@@ -102,6 +99,37 @@ class TelemetryManager extends BaseManager.BaseManager {
       });
     });
   }
+  group(args) {
+    const { repositoryName, ...traits } = args;
+    const payload = {
+      groupId: repositoryName,
+      traits,
+      context: { ...this._context }
+    };
+    if (this._userID) {
+      payload.userId = this._userID;
+    } else {
+      payload.anonymousId = this._anonymousID;
+    }
+    return new Promise((resolve) => {
+      assertTelemetryInitialized(this._segmentClient);
+      this._segmentClient.group(payload, (maybeError) => {
+        if (maybeError) {
+          console.warn(`An error occurred during Segment group`, maybeError);
+        }
+        resolve();
+      });
+    });
+  }
+  async checkIsTelemetryEnabled() {
+    let root;
+    try {
+      root = await this.project.getRoot();
+    } catch {
+      root = await this.project.suggestRoot();
+    }
+    return prismicrc.readPrismicrc(root).telemetry !== false;
+  }
 }
 exports.TelemetryManager = TelemetryManager;
 //# sourceMappingURL=TelemetryManager.cjs.map

package/dist/managers/telemetry/TelemetryManager.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"TelemetryManager.cjs","sources":["../../../../src/managers/telemetry/TelemetryManager.ts"],"sourcesContent":["import { randomUUID } from \"node:crypto\";\n\nimport SegmentClient from \"analytics-node\";\n\nimport { readPrismicrc } from \"../../lib/prismicrc\";\n\nimport { API_TOKENS } from \"../../constants/API_TOKENS\";\n\nimport { BaseManager } from \"../BaseManager\";\n\nimport {\n\tHumanSegmentEventType,\n\tHumanSegmentEventTypes,\n\tSegmentEvents,\n} from \"./types\";\n\ntype TelemetryManagerTrackArgs = SegmentEvents;\n\ntype TelemetryManagerIdentifyArgs = {\n\tuserID: string;\n\tintercomHash: string;\n};\n\nfunction assertTelemetryInitialized(\n\tsegmentClient: SegmentClient | undefined,\n): asserts segmentClient is NonNullable<typeof segmentClient> {\n\tif (segmentClient == undefined) {\n\t\tthrow new Error(\n\t\t\t\"Telemetry has not been initialized. Run `SliceMachineManager.telemetry.prototype.initTelemetry()` before re-calling this method.\",\n\t\t);\n\t}\n}\n\nexport class TelemetryManager extends BaseManager {\n\tprivate _enabled = false;\n\tprivate _segmentClient: SegmentClient | undefined = undefined;\n\tprivate _anonymousID: string | undefined = undefined;\n\tprivate _userID: string | undefined = undefined;\n\n\tasync initTelemetry(): Promise<void> {\n\t\tif (this._segmentClient) {\n\t\t\t// Prevent subsequent initializations.\n\t\t\treturn;\n\t\t}\n\n\t\tlet root: string;\n\t\ttry {\n\t\t\troot = await this.project.getRoot();\n\t\t} catch {\n\t\t\troot = await this.project.suggestRoot();\n\t\t}\n\n\t\tthis._enabled = readPrismicrc(root).telemetry !== false;\n\t\tthis._segmentClient = new SegmentClient(API_TOKENS.SegmentKey, {\n\t\t\t// Since it's a local app, we do not benefit from event batching the way a server would normally do, all tracking event will be awaited.\n\t\t\tflushAt: 1,\n\t\t\t// TODO: Verify that this actually does not send data to Segment when false.\n\t\t\tenable: this._enabled,\n\t\t\terrorHandler: () => {\n\t\t\t\t// noop - We don't care if the tracking event\n\t\t\t\t// failed. Some users or networks intentionally\n\t\t\t\t// block Segment, so we can't block the app if\n\t\t\t\t// a tracking event is unsuccessful.\n\t\t\t},\n\t\t});\n\t\tthis._anonymousID = randomUUID();\n\t}\n\n\t// TODO: Should `userId` be automatically populated by the logged in\n\t// user? We already have their info via UserRepository.\n\ttrack(args: TelemetryManagerTrackArgs): Promise<void> {\n\t\tconst { event, repository, ...properties } = args;\n\n\t\tconst payload: {\n\t\t\tevent: HumanSegmentEventTypes;\n\t\t\tuserId?: string;\n\t\t\tanonymousId?: string;\n\t\t\tproperties?: Record<string, unknown>;\n\t\t\tcontext?: {\n\t\t\t\tgroupId?: {\n\t\t\t\t\tRepository?: string;\n\t\t\t\t};\n\t\t\t};\n\t\t} = {\n\t\t\tevent: HumanSegmentEventType[event],\n\t\t\tproperties: {\n\t\t\t\trepo: repository,\n\t\t\t\t...properties,\n\t\t\t},\n\t\t};\n\n\t\tif (this._userID) {\n\t\t\tpayload.userId = this._userID;\n\t\t} else {\n\t\t\tpayload.anonymousId = this._anonymousID;\n\t\t}\n\n\t\tif (args.repository) {\n\t\t\tpayload.context ||= {};\n\t\t\tpayload.context.groupId ||= {};\n\t\t\tpayload.context.groupId.Repository = repository;\n\t\t}\n\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\t// TODO: Make sure client fails gracefully when no internet connection\n\t\t\tthis._segmentClient.track(payload, (maybeError?: Error) => {\n\t\t\t\tif (maybeError) {\n\t\t\t\t\t// TODO: Not sure how we want to deal with that\n\t\t\t\t\tconsole.warn(`An error occurred during Segment tracking`, maybeError);\n\t\t\t\t}\n\n\t\t\t\tresolve();\n\t\t\t});\n\t\t});\n\t}\n\n\t// TODO: Should `userID` and `intercomHash` be automatically populated\n\t// by the logged in user? We already have their info via\n\t// UserRepository.\n\tidentify(args: TelemetryManagerIdentifyArgs): Promise<void> {\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\tconst payload = {\n\t\t\t\tuserId: args.userID,\n\t\t\t\tanonymousId: this._anonymousID,\n\t\t\t\tintegrations: {\n\t\t\t\t\tIntercom: {\n\t\t\t\t\t\tuser_hash: args.intercomHash,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t};\n\t\t\tthis._userID = args.userID;\n\n\t\t\t// TODO: Make sure client fails gracefully when no internet connection\n\t\t\tthis._segmentClient.identify(payload, (maybeError?: Error) => {\n\t\t\t\tif (maybeError) {\n\t\t\t\t\t// TODO: Not sure how we want to deal with that\n\t\t\t\t\tconsole.warn(`An error occurred during Segment identify`, maybeError);\n\t\t\t\t}\n\n\t\t\t\tresolve();\n\t\t\t});\n\t\t});\n\t}\n}\n"],"names":["BaseManager","readPrismicrc","API_TOKENS","randomUUID","HumanSegmentEventType"],"mappings":";;;;;;;;;;;;;;AAuBA,SAAS,2BACR,eAAwC;AAExC,MAAI,iBAAiB,QAAW;AACzB,UAAA,IAAI,MACT,kIAAkI;AAAA,EAEnI;AACF;AAEM,MAAO,yBAAyBA,YAAAA,YAAW;AAAA,EAA3C;AAAA;AACG,oCAAW;AACX;AACA;AACA;AAAA;AAAA,EAER,MAAM,gBAAa;AAClB,QAAI,KAAK,gBAAgB;AAExB;AAAA,IACA;AAEG,QAAA;AACA,QAAA;AACI,aAAA,MAAM,KAAK,QAAQ;YACzB;AACM,aAAA,MAAM,KAAK,QAAQ;IAC1B;AAED,SAAK,WAAWC,UAAA,cAAc,IAAI,EAAE,cAAc;AAClD,SAAK,iBAAiB,IAAI,cAAcC,WAAAA,WAAW,YAAY;AAAA;AAAA,MAE9D,SAAS;AAAA;AAAA,MAET,QAAQ,KAAK;AAAA,MACb,cAAc,MAAK;AAAA,MAKnB;AAAA,IAAA,CACA;AACD,SAAK,eAAeC,OAAAA;EACrB;AAAA;AAAA;AAAA,EAIA,MAAM,MAA+B;;AACpC,UAAM,EAAE,OAAO,YAAY,GAAG,eAAe;AAE7C,UAAM,UAUF;AAAA,MACH,OAAOC,4BAAsB,KAAK;AAAA,MAClC,YAAY;AAAA,QACX,MAAM;AAAA,QACN,GAAG;AAAA,MACH;AAAA,IAAA;AAGF,QAAI,KAAK,SAAS;AACjB,cAAQ,SAAS,KAAK;AAAA,IAAA,OAChB;AACN,cAAQ,cAAc,KAAK;AAAA,IAC3B;AAED,QAAI,KAAK,YAAY;AACpB,cAAQ,YAAR,QAAQ,UAAY;AACZ,oBAAA,SAAQ,YAAR,GAAQ,UAAY;AACpB,cAAA,QAAQ,QAAQ,aAAa;AAAA,IACrC;AAEM,WAAA,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAG9C,WAAK,eAAe,MAAM,SAAS,CAAC,eAAsB;AACzD,YAAI,YAAY;AAEP,kBAAA,KAAK,6CAA6C,UAAU;AAAA,QACpE;;OAGD;AAAA,IAAA,CACD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,SAAS,MAAkC;AACnC,WAAA,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAE9C,YAAM,UAAU;AAAA,QACf,QAAQ,KAAK;AAAA,QACb,aAAa,KAAK;AAAA,QAClB,cAAc;AAAA,UACb,UAAU;AAAA,YACT,WAAW,KAAK;AAAA,UAChB;AAAA,QACD;AAAA,MAAA;AAEF,WAAK,UAAU,KAAK;AAGpB,WAAK,eAAe,SAAS,SAAS,CAAC,eAAsB;AAC5D,YAAI,YAAY;AAEP,kBAAA,KAAK,6CAA6C,UAAU;AAAA,QACpE;;OAGD;AAAA,IAAA,CACD;AAAA,EACF;AACA;;"}
+{"version":3,"file":"TelemetryManager.cjs","sources":["../../../../src/managers/telemetry/TelemetryManager.ts"],"sourcesContent":["import { randomUUID } from \"node:crypto\";\n\nimport SegmentClient from \"analytics-node\";\n\nimport { readPrismicrc } from \"../../lib/prismicrc\";\n\nimport { API_TOKENS } from \"../../constants/API_TOKENS\";\n\nimport { BaseManager } from \"../BaseManager\";\n\nimport {\n\tHumanSegmentEventType,\n\tHumanSegmentEventTypes,\n\tSegmentEvents,\n} from \"./types\";\n\ntype TelemetryManagerInitTelemetryArgs = {\n\tappName: string;\n\tappVersion: string;\n};\n\ntype TelemetryManagerTrackArgs = SegmentEvents;\n\ntype TelemetryManagerIdentifyArgs = {\n\tuserID: string;\n\tintercomHash: string;\n};\n\ntype TelemetryManagerGroupArgs = {\n\trepositoryName: string;\n\tmanualLibsCount: number;\n\tdownloadedLibsCount: number;\n\tnpmLibsCount: number;\n\tdownloadedLibs: string[];\n};\n\ntype TelemetryManagerContext = {\n\tapp: {\n\t\tname: string;\n\t\tversion: string;\n\t};\n};\n\nfunction assertTelemetryInitialized(\n\tsegmentClient: SegmentClient | undefined,\n): asserts segmentClient is NonNullable<typeof segmentClient> {\n\tif (segmentClient == undefined) {\n\t\tthrow new Error(\n\t\t\t\"Telemetry has not been initialized. Run `SliceMachineManager.telemetry.prototype.initTelemetry()` before re-calling this method.\",\n\t\t);\n\t}\n}\n\nexport class TelemetryManager extends BaseManager {\n\tprivate _segmentClient: SegmentClient | undefined = undefined;\n\tprivate _anonymousID: string | undefined = undefined;\n\tprivate _userID: string | undefined = undefined;\n\tprivate _context: TelemetryManagerContext | undefined = undefined;\n\n\tasync initTelemetry(args: TelemetryManagerInitTelemetryArgs): Promise<void> {\n\t\tif (this._segmentClient) {\n\t\t\t// Prevent subsequent initializations.\n\t\t\treturn;\n\t\t}\n\n\t\tthis._segmentClient = new SegmentClient(API_TOKENS.SegmentKey, {\n\t\t\t// Since it's a local app, we do not benefit from event batching the way a server would normally do, all tracking event will be awaited.\n\t\t\tflushAt: 1,\n\t\t\t// TODO: Verify that this actually does not send data to Segment when false.\n\t\t\tenable: await this.checkIsTelemetryEnabled(),\n\t\t\terrorHandler: () => {\n\t\t\t\t// noop - We don't care if the tracking event\n\t\t\t\t// failed. Some users or networks intentionally\n\t\t\t\t// block Segment, so we can't block the app if\n\t\t\t\t// a tracking event is unsuccessful.\n\t\t\t},\n\t\t});\n\t\tthis._anonymousID = randomUUID();\n\t\tthis._context = { app: { name: args.appName, version: args.appVersion } };\n\t}\n\n\t// TODO: Should `userId` be automatically populated by the logged in\n\t// user? We already have their info via UserRepository.\n\ttrack(args: TelemetryManagerTrackArgs): Promise<void> {\n\t\tconst { event, repository, ...properties } = args;\n\n\t\tconst payload: {\n\t\t\tevent: HumanSegmentEventTypes;\n\t\t\tuserId?: string;\n\t\t\tanonymousId?: string;\n\t\t\tproperties?: Record<string, unknown>;\n\t\t\tcontext?: Partial<TelemetryManagerContext> & {\n\t\t\t\tgroupId?: {\n\t\t\t\t\tRepository?: string;\n\t\t\t\t};\n\t\t\t};\n\t\t} = {\n\t\t\tevent: HumanSegmentEventType[event],\n\t\t\tproperties: {\n\t\t\t\tnodeVersion: process.versions.node,\n\t\t\t\trepo: repository,\n\t\t\t\t...properties,\n\t\t\t},\n\t\t\tcontext: { ...this._context },\n\t\t};\n\n\t\tif (this._userID) {\n\t\t\tpayload.userId = this._userID;\n\t\t} else {\n\t\t\tpayload.anonymousId = this._anonymousID;\n\t\t}\n\n\t\tif (args.repository) {\n\t\t\tpayload.context ||= {};\n\t\t\tpayload.context.groupId ||= {};\n\t\t\tpayload.context.groupId.Repository = repository;\n\t\t}\n\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\t// TODO: Make sure client fails gracefully when no internet connection\n\t\t\tthis._segmentClient.track(\n\t\t\t\tpayload as Parameters<typeof this._segmentClient.track>[0],\n\t\t\t\t(maybeError?: Error) => {\n\t\t\t\t\tif (maybeError) {\n\t\t\t\t\t\t// TODO: Not sure how we want to deal with that\n\t\t\t\t\t\tconsole.warn(\n\t\t\t\t\t\t\t`An error occurred during Segment tracking`,\n\t\t\t\t\t\t\tmaybeError,\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\n\t\t\t\t\tresolve();\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t}\n\n\t// TODO: Should `userID` and `intercomHash` be automatically populated\n\t// by the logged in user? We already have their info via\n\t// UserRepository.\n\tidentify(args: TelemetryManagerIdentifyArgs): Promise<void> {\n\t\tconst payload = {\n\t\t\tuserId: args.userID,\n\t\t\tanonymousId: this._anonymousID,\n\t\t\tintegrations: {\n\t\t\t\tIntercom: {\n\t\t\t\t\tuser_hash: args.intercomHash,\n\t\t\t\t},\n\t\t\t},\n\t\t\tcontext: { ...this._context },\n\t\t};\n\n\t\tthis._userID = args.userID;\n\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\t// TODO: Make sure client fails gracefully when no internet connection\n\t\t\tthis._segmentClient.identify(payload, (maybeError?: Error) => {\n\t\t\t\tif (maybeError) {\n\t\t\t\t\t// TODO: Not sure how we want to deal with that\n\t\t\t\t\tconsole.warn(`An error occurred during Segment identify`, maybeError);\n\t\t\t\t}\n\n\t\t\t\tresolve();\n\t\t\t});\n\t\t});\n\t}\n\n\tgroup(args: TelemetryManagerGroupArgs): Promise<void> {\n\t\tconst { repositoryName, ...traits } = args;\n\n\t\tconst payload: {\n\t\t\tgroupId: string;\n\t\t\tuserId?: string;\n\t\t\tanonymousId?: string;\n\t\t\ttraits?: Record<string, unknown>;\n\t\t\tcontext?: Partial<TelemetryManagerContext>;\n\t\t} = {\n\t\t\tgroupId: repositoryName,\n\t\t\ttraits,\n\t\t\tcontext: { ...this._context },\n\t\t};\n\n\t\tif (this._userID) {\n\t\t\tpayload.userId = this._userID;\n\t\t} else {\n\t\t\tpayload.anonymousId = this._anonymousID;\n\t\t}\n\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\tthis._segmentClient.group(\n\t\t\t\tpayload as Parameters<typeof this._segmentClient.group>[0],\n\t\t\t\t(maybeError?: Error) => {\n\t\t\t\t\tif (maybeError) {\n\t\t\t\t\t\t// TODO: Not sure how we want to deal with that\n\t\t\t\t\t\tconsole.warn(`An error occurred during Segment group`, maybeError);\n\t\t\t\t\t}\n\n\t\t\t\t\tresolve();\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t}\n\n\tasync checkIsTelemetryEnabled(): Promise<boolean> {\n\t\tlet root: string;\n\t\ttry {\n\t\t\troot = await this.project.getRoot();\n\t\t} catch {\n\t\t\troot = await this.project.suggestRoot();\n\t\t}\n\n\t\treturn readPrismicrc(root).telemetry !== false;\n\t}\n}\n"],"names":["BaseManager","API_TOKENS","randomUUID","HumanSegmentEventType","readPrismicrc"],"mappings":";;;;;;;;;;;;;;AA2CA,SAAS,2BACR,eAAwC;AAExC,MAAI,iBAAiB,QAAW;AACzB,UAAA,IAAI,MACT,kIAAkI;AAAA,EAEnI;AACF;AAEM,MAAO,yBAAyBA,YAAAA,YAAW;AAAA,EAA3C;AAAA;AACG;AACA;AACA;AACA;AAAA;AAAA,EAER,MAAM,cAAc,MAAuC;AAC1D,QAAI,KAAK,gBAAgB;AAExB;AAAA,IACA;AAED,SAAK,iBAAiB,IAAI,cAAcC,WAAAA,WAAW,YAAY;AAAA;AAAA,MAE9D,SAAS;AAAA;AAAA,MAET,QAAQ,MAAM,KAAK,wBAAyB;AAAA,MAC5C,cAAc,MAAK;AAAA,MAKnB;AAAA,IAAA,CACA;AACD,SAAK,eAAeC,OAAAA;AACf,SAAA,WAAW,EAAE,KAAK,EAAE,MAAM,KAAK,SAAS,SAAS,KAAK;EAC5D;AAAA;AAAA;AAAA,EAIA,MAAM,MAA+B;;AACpC,UAAM,EAAE,OAAO,YAAY,GAAG,eAAe;AAE7C,UAAM,UAUF;AAAA,MACH,OAAOC,4BAAsB,KAAK;AAAA,MAClC,YAAY;AAAA,QACX,aAAa,QAAQ,SAAS;AAAA,QAC9B,MAAM;AAAA,QACN,GAAG;AAAA,MACH;AAAA,MACD,SAAS,EAAE,GAAG,KAAK,SAAU;AAAA,IAAA;AAG9B,QAAI,KAAK,SAAS;AACjB,cAAQ,SAAS,KAAK;AAAA,IAAA,OAChB;AACN,cAAQ,cAAc,KAAK;AAAA,IAC3B;AAED,QAAI,KAAK,YAAY;AACpB,cAAQ,YAAR,QAAQ,UAAY;AACZ,oBAAA,SAAQ,YAAR,GAAQ,UAAY;AACpB,cAAA,QAAQ,QAAQ,aAAa;AAAA,IACrC;AAEM,WAAA,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAG9C,WAAK,eAAe,MACnB,SACA,CAAC,eAAsB;AACtB,YAAI,YAAY;AAEP,kBAAA,KACP,6CACA,UAAU;AAAA,QAEX;;OAGD;AAAA,IAAA,CAEF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,SAAS,MAAkC;AAC1C,UAAM,UAAU;AAAA,MACf,QAAQ,KAAK;AAAA,MACb,aAAa,KAAK;AAAA,MAClB,cAAc;AAAA,QACb,UAAU;AAAA,UACT,WAAW,KAAK;AAAA,QAChB;AAAA,MACD;AAAA,MACD,SAAS,EAAE,GAAG,KAAK,SAAU;AAAA,IAAA;AAG9B,SAAK,UAAU,KAAK;AAEb,WAAA,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAG9C,WAAK,eAAe,SAAS,SAAS,CAAC,eAAsB;AAC5D,YAAI,YAAY;AAEP,kBAAA,KAAK,6CAA6C,UAAU;AAAA,QACpE;;OAGD;AAAA,IAAA,CACD;AAAA,EACF;AAAA,EAEA,MAAM,MAA+B;AACpC,UAAM,EAAE,gBAAgB,GAAG,OAAA,IAAW;AAEtC,UAAM,UAMF;AAAA,MACH,SAAS;AAAA,MACT;AAAA,MACA,SAAS,EAAE,GAAG,KAAK,SAAU;AAAA,IAAA;AAG9B,QAAI,KAAK,SAAS;AACjB,cAAQ,SAAS,KAAK;AAAA,IAAA,OAChB;AACN,cAAQ,cAAc,KAAK;AAAA,IAC3B;AAEM,WAAA,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAE9C,WAAK,eAAe,MACnB,SACA,CAAC,eAAsB;AACtB,YAAI,YAAY;AAEP,kBAAA,KAAK,0CAA0C,UAAU;AAAA,QACjE;;OAGD;AAAA,IAAA,CAEF;AAAA,EACF;AAAA,EAEA,MAAM,0BAAuB;AACxB,QAAA;AACA,QAAA;AACI,aAAA,MAAM,KAAK,QAAQ;YACzB;AACM,aAAA,MAAM,KAAK,QAAQ;IAC1B;AAEM,WAAAC,wBAAc,IAAI,EAAE,cAAc;AAAA,EAC1C;AACA;;"}

package/dist/managers/telemetry/TelemetryManager.d.ts

@@ -1,17 +1,30 @@
 import { BaseManager } from "../BaseManager";
 import { SegmentEvents } from "./types";
+type TelemetryManagerInitTelemetryArgs = {
+    appName: string;
+    appVersion: string;
+};
 type TelemetryManagerTrackArgs = SegmentEvents;
 type TelemetryManagerIdentifyArgs = {
     userID: string;
     intercomHash: string;
 };
+type TelemetryManagerGroupArgs = {
+    repositoryName: string;
+    manualLibsCount: number;
+    downloadedLibsCount: number;
+    npmLibsCount: number;
+    downloadedLibs: string[];
+};
 export declare class TelemetryManager extends BaseManager {
-    private _enabled;
     private _segmentClient;
     private _anonymousID;
     private _userID;
-    initTelemetry(): Promise<void>;
+    private _context;
+    initTelemetry(args: TelemetryManagerInitTelemetryArgs): Promise<void>;
     track(args: TelemetryManagerTrackArgs): Promise<void>;
     identify(args: TelemetryManagerIdentifyArgs): Promise<void>;
+    group(args: TelemetryManagerGroupArgs): Promise<void>;
+    checkIsTelemetryEnabled(): Promise<boolean>;
 }
 export {};

package/dist/managers/telemetry/TelemetryManager.js

@@ -18,31 +18,25 @@ function assertTelemetryInitialized(segmentClient) {
 class TelemetryManager extends BaseManager {
   constructor() {
     super(...arguments);
-    __publicField(this, "_enabled", false);
     __publicField(this, "_segmentClient");
     __publicField(this, "_anonymousID");
     __publicField(this, "_userID");
+    __publicField(this, "_context");
   }
-  async initTelemetry() {
+  async initTelemetry(args) {
     if (this._segmentClient) {
       return;
     }
-    let root;
-    try {
-      root = await this.project.getRoot();
-    } catch {
-      root = await this.project.suggestRoot();
-    }
-    this._enabled = readPrismicrc(root).telemetry !== false;
     this._segmentClient = new SegmentClient(API_TOKENS.SegmentKey, {
       // Since it's a local app, we do not benefit from event batching the way a server would normally do, all tracking event will be awaited.
       flushAt: 1,
       // TODO: Verify that this actually does not send data to Segment when false.
-      enable: this._enabled,
+      enable: await this.checkIsTelemetryEnabled(),
       errorHandler: () => {
       }
     });
     this._anonymousID = randomUUID();
+    this._context = { app: { name: args.appName, version: args.appVersion } };
   }
   // TODO: Should `userId` be automatically populated by the logged in
   // user? We already have their info via UserRepository.
@@ -52,9 +46,11 @@ class TelemetryManager extends BaseManager {
     const payload = {
       event: HumanSegmentEventType[event],
       properties: {
+        nodeVersion: process.versions.node,
         repo: repository,
         ...properties
-      }
+      },
+      context: { ...this._context }
     };
     if (this._userID) {
       payload.userId = this._userID;
@@ -80,18 +76,19 @@ class TelemetryManager extends BaseManager {
   // by the logged in user? We already have their info via
   // UserRepository.
   identify(args) {
+    const payload = {
+      userId: args.userID,
+      anonymousId: this._anonymousID,
+      integrations: {
+        Intercom: {
+          user_hash: args.intercomHash
+        }
+      },
+      context: { ...this._context }
+    };
+    this._userID = args.userID;
     return new Promise((resolve) => {
       assertTelemetryInitialized(this._segmentClient);
-      const payload = {
-        userId: args.userID,
-        anonymousId: this._anonymousID,
-        integrations: {
-          Intercom: {
-            user_hash: args.intercomHash
-          }
-        }
-      };
-      this._userID = args.userID;
       this._segmentClient.identify(payload, (maybeError) => {
         if (maybeError) {
           console.warn(`An error occurred during Segment identify`, maybeError);
@@ -100,6 +97,37 @@ class TelemetryManager extends BaseManager {
       });
     });
   }
+  group(args) {
+    const { repositoryName, ...traits } = args;
+    const payload = {
+      groupId: repositoryName,
+      traits,
+      context: { ...this._context }
+    };
+    if (this._userID) {
+      payload.userId = this._userID;
+    } else {
+      payload.anonymousId = this._anonymousID;
+    }
+    return new Promise((resolve) => {
+      assertTelemetryInitialized(this._segmentClient);
+      this._segmentClient.group(payload, (maybeError) => {
+        if (maybeError) {
+          console.warn(`An error occurred during Segment group`, maybeError);
+        }
+        resolve();
+      });
+    });
+  }
+  async checkIsTelemetryEnabled() {
+    let root;
+    try {
+      root = await this.project.getRoot();
+    } catch {
+      root = await this.project.suggestRoot();
+    }
+    return readPrismicrc(root).telemetry !== false;
+  }
 }
 export {
   TelemetryManager

package/dist/managers/telemetry/TelemetryManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"TelemetryManager.js","sources":["../../../../src/managers/telemetry/TelemetryManager.ts"],"sourcesContent":["import { randomUUID } from \"node:crypto\";\n\nimport SegmentClient from \"analytics-node\";\n\nimport { readPrismicrc } from \"../../lib/prismicrc\";\n\nimport { API_TOKENS } from \"../../constants/API_TOKENS\";\n\nimport { BaseManager } from \"../BaseManager\";\n\nimport {\n\tHumanSegmentEventType,\n\tHumanSegmentEventTypes,\n\tSegmentEvents,\n} from \"./types\";\n\ntype TelemetryManagerTrackArgs = SegmentEvents;\n\ntype TelemetryManagerIdentifyArgs = {\n\tuserID: string;\n\tintercomHash: string;\n};\n\nfunction assertTelemetryInitialized(\n\tsegmentClient: SegmentClient | undefined,\n): asserts segmentClient is NonNullable<typeof segmentClient> {\n\tif (segmentClient == undefined) {\n\t\tthrow new Error(\n\t\t\t\"Telemetry has not been initialized. Run `SliceMachineManager.telemetry.prototype.initTelemetry()` before re-calling this method.\",\n\t\t);\n\t}\n}\n\nexport class TelemetryManager extends BaseManager {\n\tprivate _enabled = false;\n\tprivate _segmentClient: SegmentClient | undefined = undefined;\n\tprivate _anonymousID: string | undefined = undefined;\n\tprivate _userID: string | undefined = undefined;\n\n\tasync initTelemetry(): Promise<void> {\n\t\tif (this._segmentClient) {\n\t\t\t// Prevent subsequent initializations.\n\t\t\treturn;\n\t\t}\n\n\t\tlet root: string;\n\t\ttry {\n\t\t\troot = await this.project.getRoot();\n\t\t} catch {\n\t\t\troot = await this.project.suggestRoot();\n\t\t}\n\n\t\tthis._enabled = readPrismicrc(root).telemetry !== false;\n\t\tthis._segmentClient = new SegmentClient(API_TOKENS.SegmentKey, {\n\t\t\t// Since it's a local app, we do not benefit from event batching the way a server would normally do, all tracking event will be awaited.\n\t\t\tflushAt: 1,\n\t\t\t// TODO: Verify that this actually does not send data to Segment when false.\n\t\t\tenable: this._enabled,\n\t\t\terrorHandler: () => {\n\t\t\t\t// noop - We don't care if the tracking event\n\t\t\t\t// failed. Some users or networks intentionally\n\t\t\t\t// block Segment, so we can't block the app if\n\t\t\t\t// a tracking event is unsuccessful.\n\t\t\t},\n\t\t});\n\t\tthis._anonymousID = randomUUID();\n\t}\n\n\t// TODO: Should `userId` be automatically populated by the logged in\n\t// user? We already have their info via UserRepository.\n\ttrack(args: TelemetryManagerTrackArgs): Promise<void> {\n\t\tconst { event, repository, ...properties } = args;\n\n\t\tconst payload: {\n\t\t\tevent: HumanSegmentEventTypes;\n\t\t\tuserId?: string;\n\t\t\tanonymousId?: string;\n\t\t\tproperties?: Record<string, unknown>;\n\t\t\tcontext?: {\n\t\t\t\tgroupId?: {\n\t\t\t\t\tRepository?: string;\n\t\t\t\t};\n\t\t\t};\n\t\t} = {\n\t\t\tevent: HumanSegmentEventType[event],\n\t\t\tproperties: {\n\t\t\t\trepo: repository,\n\t\t\t\t...properties,\n\t\t\t},\n\t\t};\n\n\t\tif (this._userID) {\n\t\t\tpayload.userId = this._userID;\n\t\t} else {\n\t\t\tpayload.anonymousId = this._anonymousID;\n\t\t}\n\n\t\tif (args.repository) {\n\t\t\tpayload.context ||= {};\n\t\t\tpayload.context.groupId ||= {};\n\t\t\tpayload.context.groupId.Repository = repository;\n\t\t}\n\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\t// TODO: Make sure client fails gracefully when no internet connection\n\t\t\tthis._segmentClient.track(payload, (maybeError?: Error) => {\n\t\t\t\tif (maybeError) {\n\t\t\t\t\t// TODO: Not sure how we want to deal with that\n\t\t\t\t\tconsole.warn(`An error occurred during Segment tracking`, maybeError);\n\t\t\t\t}\n\n\t\t\t\tresolve();\n\t\t\t});\n\t\t});\n\t}\n\n\t// TODO: Should `userID` and `intercomHash` be automatically populated\n\t// by the logged in user? We already have their info via\n\t// UserRepository.\n\tidentify(args: TelemetryManagerIdentifyArgs): Promise<void> {\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\tconst payload = {\n\t\t\t\tuserId: args.userID,\n\t\t\t\tanonymousId: this._anonymousID,\n\t\t\t\tintegrations: {\n\t\t\t\t\tIntercom: {\n\t\t\t\t\t\tuser_hash: args.intercomHash,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t};\n\t\t\tthis._userID = args.userID;\n\n\t\t\t// TODO: Make sure client fails gracefully when no internet connection\n\t\t\tthis._segmentClient.identify(payload, (maybeError?: Error) => {\n\t\t\t\tif (maybeError) {\n\t\t\t\t\t// TODO: Not sure how we want to deal with that\n\t\t\t\t\tconsole.warn(`An error occurred during Segment identify`, maybeError);\n\t\t\t\t}\n\n\t\t\t\tresolve();\n\t\t\t});\n\t\t});\n\t}\n}\n"],"names":[],"mappings":";;;;;;;;;;;;AAuBA,SAAS,2BACR,eAAwC;AAExC,MAAI,iBAAiB,QAAW;AACzB,UAAA,IAAI,MACT,kIAAkI;AAAA,EAEnI;AACF;AAEM,MAAO,yBAAyB,YAAW;AAAA,EAA3C;AAAA;AACG,oCAAW;AACX;AACA;AACA;AAAA;AAAA,EAER,MAAM,gBAAa;AAClB,QAAI,KAAK,gBAAgB;AAExB;AAAA,IACA;AAEG,QAAA;AACA,QAAA;AACI,aAAA,MAAM,KAAK,QAAQ;YACzB;AACM,aAAA,MAAM,KAAK,QAAQ;IAC1B;AAED,SAAK,WAAW,cAAc,IAAI,EAAE,cAAc;AAClD,SAAK,iBAAiB,IAAI,cAAc,WAAW,YAAY;AAAA;AAAA,MAE9D,SAAS;AAAA;AAAA,MAET,QAAQ,KAAK;AAAA,MACb,cAAc,MAAK;AAAA,MAKnB;AAAA,IAAA,CACA;AACD,SAAK,eAAe;EACrB;AAAA;AAAA;AAAA,EAIA,MAAM,MAA+B;;AACpC,UAAM,EAAE,OAAO,YAAY,GAAG,eAAe;AAE7C,UAAM,UAUF;AAAA,MACH,OAAO,sBAAsB,KAAK;AAAA,MAClC,YAAY;AAAA,QACX,MAAM;AAAA,QACN,GAAG;AAAA,MACH;AAAA,IAAA;AAGF,QAAI,KAAK,SAAS;AACjB,cAAQ,SAAS,KAAK;AAAA,IAAA,OAChB;AACN,cAAQ,cAAc,KAAK;AAAA,IAC3B;AAED,QAAI,KAAK,YAAY;AACpB,cAAQ,YAAR,QAAQ,UAAY;AACZ,oBAAA,SAAQ,YAAR,GAAQ,UAAY;AACpB,cAAA,QAAQ,QAAQ,aAAa;AAAA,IACrC;AAEM,WAAA,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAG9C,WAAK,eAAe,MAAM,SAAS,CAAC,eAAsB;AACzD,YAAI,YAAY;AAEP,kBAAA,KAAK,6CAA6C,UAAU;AAAA,QACpE;;OAGD;AAAA,IAAA,CACD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,SAAS,MAAkC;AACnC,WAAA,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAE9C,YAAM,UAAU;AAAA,QACf,QAAQ,KAAK;AAAA,QACb,aAAa,KAAK;AAAA,QAClB,cAAc;AAAA,UACb,UAAU;AAAA,YACT,WAAW,KAAK;AAAA,UAChB;AAAA,QACD;AAAA,MAAA;AAEF,WAAK,UAAU,KAAK;AAGpB,WAAK,eAAe,SAAS,SAAS,CAAC,eAAsB;AAC5D,YAAI,YAAY;AAEP,kBAAA,KAAK,6CAA6C,UAAU;AAAA,QACpE;;OAGD;AAAA,IAAA,CACD;AAAA,EACF;AACA;"}
+{"version":3,"file":"TelemetryManager.js","sources":["../../../../src/managers/telemetry/TelemetryManager.ts"],"sourcesContent":["import { randomUUID } from \"node:crypto\";\n\nimport SegmentClient from \"analytics-node\";\n\nimport { readPrismicrc } from \"../../lib/prismicrc\";\n\nimport { API_TOKENS } from \"../../constants/API_TOKENS\";\n\nimport { BaseManager } from \"../BaseManager\";\n\nimport {\n\tHumanSegmentEventType,\n\tHumanSegmentEventTypes,\n\tSegmentEvents,\n} from \"./types\";\n\ntype TelemetryManagerInitTelemetryArgs = {\n\tappName: string;\n\tappVersion: string;\n};\n\ntype TelemetryManagerTrackArgs = SegmentEvents;\n\ntype TelemetryManagerIdentifyArgs = {\n\tuserID: string;\n\tintercomHash: string;\n};\n\ntype TelemetryManagerGroupArgs = {\n\trepositoryName: string;\n\tmanualLibsCount: number;\n\tdownloadedLibsCount: number;\n\tnpmLibsCount: number;\n\tdownloadedLibs: string[];\n};\n\ntype TelemetryManagerContext = {\n\tapp: {\n\t\tname: string;\n\t\tversion: string;\n\t};\n};\n\nfunction assertTelemetryInitialized(\n\tsegmentClient: SegmentClient | undefined,\n): asserts segmentClient is NonNullable<typeof segmentClient> {\n\tif (segmentClient == undefined) {\n\t\tthrow new Error(\n\t\t\t\"Telemetry has not been initialized. Run `SliceMachineManager.telemetry.prototype.initTelemetry()` before re-calling this method.\",\n\t\t);\n\t}\n}\n\nexport class TelemetryManager extends BaseManager {\n\tprivate _segmentClient: SegmentClient | undefined = undefined;\n\tprivate _anonymousID: string | undefined = undefined;\n\tprivate _userID: string | undefined = undefined;\n\tprivate _context: TelemetryManagerContext | undefined = undefined;\n\n\tasync initTelemetry(args: TelemetryManagerInitTelemetryArgs): Promise<void> {\n\t\tif (this._segmentClient) {\n\t\t\t// Prevent subsequent initializations.\n\t\t\treturn;\n\t\t}\n\n\t\tthis._segmentClient = new SegmentClient(API_TOKENS.SegmentKey, {\n\t\t\t// Since it's a local app, we do not benefit from event batching the way a server would normally do, all tracking event will be awaited.\n\t\t\tflushAt: 1,\n\t\t\t// TODO: Verify that this actually does not send data to Segment when false.\n\t\t\tenable: await this.checkIsTelemetryEnabled(),\n\t\t\terrorHandler: () => {\n\t\t\t\t// noop - We don't care if the tracking event\n\t\t\t\t// failed. Some users or networks intentionally\n\t\t\t\t// block Segment, so we can't block the app if\n\t\t\t\t// a tracking event is unsuccessful.\n\t\t\t},\n\t\t});\n\t\tthis._anonymousID = randomUUID();\n\t\tthis._context = { app: { name: args.appName, version: args.appVersion } };\n\t}\n\n\t// TODO: Should `userId` be automatically populated by the logged in\n\t// user? We already have their info via UserRepository.\n\ttrack(args: TelemetryManagerTrackArgs): Promise<void> {\n\t\tconst { event, repository, ...properties } = args;\n\n\t\tconst payload: {\n\t\t\tevent: HumanSegmentEventTypes;\n\t\t\tuserId?: string;\n\t\t\tanonymousId?: string;\n\t\t\tproperties?: Record<string, unknown>;\n\t\t\tcontext?: Partial<TelemetryManagerContext> & {\n\t\t\t\tgroupId?: {\n\t\t\t\t\tRepository?: string;\n\t\t\t\t};\n\t\t\t};\n\t\t} = {\n\t\t\tevent: HumanSegmentEventType[event],\n\t\t\tproperties: {\n\t\t\t\tnodeVersion: process.versions.node,\n\t\t\t\trepo: repository,\n\t\t\t\t...properties,\n\t\t\t},\n\t\t\tcontext: { ...this._context },\n\t\t};\n\n\t\tif (this._userID) {\n\t\t\tpayload.userId = this._userID;\n\t\t} else {\n\t\t\tpayload.anonymousId = this._anonymousID;\n\t\t}\n\n\t\tif (args.repository) {\n\t\t\tpayload.context ||= {};\n\t\t\tpayload.context.groupId ||= {};\n\t\t\tpayload.context.groupId.Repository = repository;\n\t\t}\n\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\t// TODO: Make sure client fails gracefully when no internet connection\n\t\t\tthis._segmentClient.track(\n\t\t\t\tpayload as Parameters<typeof this._segmentClient.track>[0],\n\t\t\t\t(maybeError?: Error) => {\n\t\t\t\t\tif (maybeError) {\n\t\t\t\t\t\t// TODO: Not sure how we want to deal with that\n\t\t\t\t\t\tconsole.warn(\n\t\t\t\t\t\t\t`An error occurred during Segment tracking`,\n\t\t\t\t\t\t\tmaybeError,\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\n\t\t\t\t\tresolve();\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t}\n\n\t// TODO: Should `userID` and `intercomHash` be automatically populated\n\t// by the logged in user? We already have their info via\n\t// UserRepository.\n\tidentify(args: TelemetryManagerIdentifyArgs): Promise<void> {\n\t\tconst payload = {\n\t\t\tuserId: args.userID,\n\t\t\tanonymousId: this._anonymousID,\n\t\t\tintegrations: {\n\t\t\t\tIntercom: {\n\t\t\t\t\tuser_hash: args.intercomHash,\n\t\t\t\t},\n\t\t\t},\n\t\t\tcontext: { ...this._context },\n\t\t};\n\n\t\tthis._userID = args.userID;\n\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\t// TODO: Make sure client fails gracefully when no internet connection\n\t\t\tthis._segmentClient.identify(payload, (maybeError?: Error) => {\n\t\t\t\tif (maybeError) {\n\t\t\t\t\t// TODO: Not sure how we want to deal with that\n\t\t\t\t\tconsole.warn(`An error occurred during Segment identify`, maybeError);\n\t\t\t\t}\n\n\t\t\t\tresolve();\n\t\t\t});\n\t\t});\n\t}\n\n\tgroup(args: TelemetryManagerGroupArgs): Promise<void> {\n\t\tconst { repositoryName, ...traits } = args;\n\n\t\tconst payload: {\n\t\t\tgroupId: string;\n\t\t\tuserId?: string;\n\t\t\tanonymousId?: string;\n\t\t\ttraits?: Record<string, unknown>;\n\t\t\tcontext?: Partial<TelemetryManagerContext>;\n\t\t} = {\n\t\t\tgroupId: repositoryName,\n\t\t\ttraits,\n\t\t\tcontext: { ...this._context },\n\t\t};\n\n\t\tif (this._userID) {\n\t\t\tpayload.userId = this._userID;\n\t\t} else {\n\t\t\tpayload.anonymousId = this._anonymousID;\n\t\t}\n\n\t\treturn new Promise((resolve) => {\n\t\t\tassertTelemetryInitialized(this._segmentClient);\n\n\t\t\tthis._segmentClient.group(\n\t\t\t\tpayload as Parameters<typeof this._segmentClient.group>[0],\n\t\t\t\t(maybeError?: Error) => {\n\t\t\t\t\tif (maybeError) {\n\t\t\t\t\t\t// TODO: Not sure how we want to deal with that\n\t\t\t\t\t\tconsole.warn(`An error occurred during Segment group`, maybeError);\n\t\t\t\t\t}\n\n\t\t\t\t\tresolve();\n\t\t\t\t},\n\t\t\t);\n\t\t});\n\t}\n\n\tasync checkIsTelemetryEnabled(): Promise<boolean> {\n\t\tlet root: string;\n\t\ttry {\n\t\t\troot = await this.project.getRoot();\n\t\t} catch {\n\t\t\troot = await this.project.suggestRoot();\n\t\t}\n\n\t\treturn readPrismicrc(root).telemetry !== false;\n\t}\n}\n"],"names":[],"mappings":";;;;;;;;;;;;AA2CA,SAAS,2BACR,eAAwC;AAExC,MAAI,iBAAiB,QAAW;AACzB,UAAA,IAAI,MACT,kIAAkI;AAAA,EAEnI;AACF;AAEM,MAAO,yBAAyB,YAAW;AAAA,EAA3C;AAAA;AACG;AACA;AACA;AACA;AAAA;AAAA,EAER,MAAM,cAAc,MAAuC;AAC1D,QAAI,KAAK,gBAAgB;AAExB;AAAA,IACA;AAED,SAAK,iBAAiB,IAAI,cAAc,WAAW,YAAY;AAAA;AAAA,MAE9D,SAAS;AAAA;AAAA,MAET,QAAQ,MAAM,KAAK,wBAAyB;AAAA,MAC5C,cAAc,MAAK;AAAA,MAKnB;AAAA,IAAA,CACA;AACD,SAAK,eAAe;AACf,SAAA,WAAW,EAAE,KAAK,EAAE,MAAM,KAAK,SAAS,SAAS,KAAK;EAC5D;AAAA;AAAA;AAAA,EAIA,MAAM,MAA+B;;AACpC,UAAM,EAAE,OAAO,YAAY,GAAG,eAAe;AAE7C,UAAM,UAUF;AAAA,MACH,OAAO,sBAAsB,KAAK;AAAA,MAClC,YAAY;AAAA,QACX,aAAa,QAAQ,SAAS;AAAA,QAC9B,MAAM;AAAA,QACN,GAAG;AAAA,MACH;AAAA,MACD,SAAS,EAAE,GAAG,KAAK,SAAU;AAAA,IAAA;AAG9B,QAAI,KAAK,SAAS;AACjB,cAAQ,SAAS,KAAK;AAAA,IAAA,OAChB;AACN,cAAQ,cAAc,KAAK;AAAA,IAC3B;AAED,QAAI,KAAK,YAAY;AACpB,cAAQ,YAAR,QAAQ,UAAY;AACZ,oBAAA,SAAQ,YAAR,GAAQ,UAAY;AACpB,cAAA,QAAQ,QAAQ,aAAa;AAAA,IACrC;AAEM,WAAA,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAG9C,WAAK,eAAe,MACnB,SACA,CAAC,eAAsB;AACtB,YAAI,YAAY;AAEP,kBAAA,KACP,6CACA,UAAU;AAAA,QAEX;;OAGD;AAAA,IAAA,CAEF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,SAAS,MAAkC;AAC1C,UAAM,UAAU;AAAA,MACf,QAAQ,KAAK;AAAA,MACb,aAAa,KAAK;AAAA,MAClB,cAAc;AAAA,QACb,UAAU;AAAA,UACT,WAAW,KAAK;AAAA,QAChB;AAAA,MACD;AAAA,MACD,SAAS,EAAE,GAAG,KAAK,SAAU;AAAA,IAAA;AAG9B,SAAK,UAAU,KAAK;AAEb,WAAA,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAG9C,WAAK,eAAe,SAAS,SAAS,CAAC,eAAsB;AAC5D,YAAI,YAAY;AAEP,kBAAA,KAAK,6CAA6C,UAAU;AAAA,QACpE;;OAGD;AAAA,IAAA,CACD;AAAA,EACF;AAAA,EAEA,MAAM,MAA+B;AACpC,UAAM,EAAE,gBAAgB,GAAG,OAAA,IAAW;AAEtC,UAAM,UAMF;AAAA,MACH,SAAS;AAAA,MACT;AAAA,MACA,SAAS,EAAE,GAAG,KAAK,SAAU;AAAA,IAAA;AAG9B,QAAI,KAAK,SAAS;AACjB,cAAQ,SAAS,KAAK;AAAA,IAAA,OAChB;AACN,cAAQ,cAAc,KAAK;AAAA,IAC3B;AAEM,WAAA,IAAI,QAAQ,CAAC,YAAW;AAC9B,iCAA2B,KAAK,cAAc;AAE9C,WAAK,eAAe,MACnB,SACA,CAAC,eAAsB;AACtB,YAAI,YAAY;AAEP,kBAAA,KAAK,0CAA0C,UAAU;AAAA,QACjE;;OAGD;AAAA,IAAA,CAEF;AAAA,EACF;AAAA,EAEA,MAAM,0BAAuB;AACxB,QAAA;AACA,QAAA;AACI,aAAA,MAAM,KAAK,QAAQ;YACzB;AACM,aAAA,MAAM,KAAK,QAAQ;IAC1B;AAEM,WAAA,cAAc,IAAI,EAAE,cAAc;AAAA,EAC1C;AACA;"}

package/dist/managers/telemetry/types.cjs

@@ -3,12 +3,54 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const SegmentEventType = {
   command_init_start: "command:init:start",
   command_init_identify: "command:init:identify",
-  command_init_end: "command:init:end"
+  command_init_end: "command:init:end",
+  review: "review",
+  onboarding_start: "onboarding:start",
+  onboarding_skip: "onboarding:skip",
+  onboarding_continue_screenIntro: "onboarding:continue:screen-intro",
+  onboarding_continue_screen1: "onboarding:continue:screen-1",
+  onboarding_continue_screen2: "onboarding:continue:screen-2",
+  onboarding_continue_screen3: "onboarding:continue:screen-3",
+  sliceSimulator_setup: "slice-simulator:setup",
+  sliceSimulator_open: "slice-simulator:open",
+  sliceSimulator_isNotRunning: "slice-simulator:is-not-running",
+  pageView: "page-view",
+  openVideoTutorials: "open-video-tutorials",
+  customType_created: "custom-type:created",
+  customType_fieldAdded: "custom-type:field-added",
+  customType_sliceZoneUpdated: "custom-type:slice-zone-updated",
+  customType_saved: "custom-type:saved",
+  slice_created: "slice:created",
+  screenshotTaken: "screenshot-taken",
+  changes_pushed: "changes:pushed",
+  changes_limitReach: "changes:limit-reach",
+  editor_widgetUsed: "editor:widget-used"
 };
 const HumanSegmentEventType = {
   [SegmentEventType.command_init_start]: "SliceMachine Init Start",
   [SegmentEventType.command_init_identify]: "SliceMachine Init Identify",
-  [SegmentEventType.command_init_end]: "SliceMachine Init End"
+  [SegmentEventType.command_init_end]: "SliceMachine Init End",
+  [SegmentEventType.review]: "SliceMachine Review",
+  [SegmentEventType.onboarding_start]: "SliceMachine Onboarding Start",
+  [SegmentEventType.onboarding_skip]: "SliceMachine Onboarding Skip",
+  [SegmentEventType.onboarding_continue_screenIntro]: "SliceMachine Onboarding Continue Screen Intro",
+  [SegmentEventType.onboarding_continue_screen1]: "SliceMachine Onboarding Continue Screen 1",
+  [SegmentEventType.onboarding_continue_screen2]: "SliceMachine Onboarding Continue Screen 2",
+  [SegmentEventType.onboarding_continue_screen3]: "SliceMachine Onboarding Continue Screen 3",
+  [SegmentEventType.sliceSimulator_setup]: "SliceMachine Slice Simulator Setup",
+  [SegmentEventType.sliceSimulator_open]: "SliceMachine Slice Simulator Open",
+  [SegmentEventType.sliceSimulator_isNotRunning]: "SliceMachine Slice Simulator is not running",
+  [SegmentEventType.pageView]: "SliceMachine Page View",
+  [SegmentEventType.openVideoTutorials]: "SliceMachine Open Video Tutorials",
+  [SegmentEventType.customType_created]: "SliceMachine Custom Type Created",
+  [SegmentEventType.customType_fieldAdded]: "SliceMachine Custom Type Field Added",
+  [SegmentEventType.customType_sliceZoneUpdated]: "SliceMachine Slicezone Updated",
+  [SegmentEventType.customType_saved]: "SliceMachine Custom Type Saved",
+  [SegmentEventType.slice_created]: "SliceMachine Slice Created",
+  [SegmentEventType.screenshotTaken]: "SliceMachine Screenshot Taken",
+  [SegmentEventType.changes_pushed]: "SliceMachine Changes Pushed",
+  [SegmentEventType.changes_limitReach]: "SliceMachine Changes Limit Reach",
+  [SegmentEventType.editor_widgetUsed]: "SliceMachine Editor Widget Used"
 };
 exports.HumanSegmentEventType = HumanSegmentEventType;
 exports.SegmentEventType = SegmentEventType;

package/dist/managers/telemetry/types.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.cjs","sources":["../../../../src/managers/telemetry/types.ts"],"sourcesContent":["export const SegmentEventType = {\n\tcommand_init_start: \"command:init:start\",\n\tcommand_init_identify: \"command:init:identify\",\n\tcommand_init_end: \"command:init:end\",\n} as const;\ntype SegmentEventTypes = typeof SegmentEventType[keyof typeof SegmentEventType];\n\nexport const HumanSegmentEventType = {\n\t[SegmentEventType.command_init_start]: \"SliceMachine Init Start\",\n\t[SegmentEventType.command_init_identify]: \"SliceMachine Init Identify\",\n\t[SegmentEventType.command_init_end]: \"SliceMachine Init End\",\n} as const;\nexport type HumanSegmentEventTypes =\n\ttypeof HumanSegmentEventType[keyof typeof HumanSegmentEventType];\n\ntype SegmentEvent<\n\tTType extends SegmentEventTypes,\n\tTProperties extends Record<string, unknown> | void = void,\n> = TProperties extends void\n\t? {\n\t\t\tevent: TType;\n\t\t\trepository?: string;\n\t  }\n\t: {\n\t\t\tevent: TType;\n\t\t\trepository?: string;\n\t  } & TProperties;\n\ntype CommandInitStartSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.command_init_start\n>;\n\n// This event feels off, we have a dedicated `identify` method...\ntype CommandInitIdentifySegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.command_init_identify\n>;\n\ntype CommandInitEndSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.command_init_end,\n\t{ framework: string; success: boolean; error?: string }\n>;\n\nexport type SegmentEvents =\n\t| CommandInitStartSegmentEvent\n\t| CommandInitIdentifySegmentEvent\n\t| CommandInitEndSegmentEvent;\n"],"names":[],"mappings":";;AAAO,MAAM,mBAAmB;AAAA,EAC/B,oBAAoB;AAAA,EACpB,uBAAuB;AAAA,EACvB,kBAAkB;;AAIZ,MAAM,wBAAwB;AAAA,EACpC,CAAC,iBAAiB,kBAAkB,GAAG;AAAA,EACvC,CAAC,iBAAiB,qBAAqB,GAAG;AAAA,EAC1C,CAAC,iBAAiB,gBAAgB,GAAG;;;;"}
+{"version":3,"file":"types.cjs","sources":["../../../../src/managers/telemetry/types.ts"],"sourcesContent":["import type { LimitType } from \"../prismicRepository/types\";\n\nexport const SegmentEventType = {\n\tcommand_init_start: \"command:init:start\",\n\tcommand_init_identify: \"command:init:identify\",\n\tcommand_init_end: \"command:init:end\",\n\treview: \"review\",\n\tonboarding_start: \"onboarding:start\",\n\tonboarding_skip: \"onboarding:skip\",\n\tonboarding_continue_screenIntro: \"onboarding:continue:screen-intro\",\n\tonboarding_continue_screen1: \"onboarding:continue:screen-1\",\n\tonboarding_continue_screen2: \"onboarding:continue:screen-2\",\n\tonboarding_continue_screen3: \"onboarding:continue:screen-3\",\n\tsliceSimulator_setup: \"slice-simulator:setup\",\n\tsliceSimulator_open: \"slice-simulator:open\",\n\tsliceSimulator_isNotRunning: \"slice-simulator:is-not-running\",\n\tpageView: \"page-view\",\n\topenVideoTutorials: \"open-video-tutorials\",\n\tcustomType_created: \"custom-type:created\",\n\tcustomType_fieldAdded: \"custom-type:field-added\",\n\tcustomType_sliceZoneUpdated: \"custom-type:slice-zone-updated\",\n\tcustomType_saved: \"custom-type:saved\",\n\tslice_created: \"slice:created\",\n\tscreenshotTaken: \"screenshot-taken\",\n\tchanges_pushed: \"changes:pushed\",\n\tchanges_limitReach: \"changes:limit-reach\",\n\teditor_widgetUsed: \"editor:widget-used\",\n} as const;\ntype SegmentEventTypes =\n\t(typeof SegmentEventType)[keyof typeof SegmentEventType];\n\nexport const HumanSegmentEventType = {\n\t[SegmentEventType.command_init_start]: \"SliceMachine Init Start\",\n\t[SegmentEventType.command_init_identify]: \"SliceMachine Init Identify\",\n\t[SegmentEventType.command_init_end]: \"SliceMachine Init End\",\n\t[SegmentEventType.review]: \"SliceMachine Review\",\n\t[SegmentEventType.onboarding_start]: \"SliceMachine Onboarding Start\",\n\t[SegmentEventType.onboarding_skip]: \"SliceMachine Onboarding Skip\",\n\t[SegmentEventType.onboarding_continue_screenIntro]:\n\t\t\"SliceMachine Onboarding Continue Screen Intro\",\n\t[SegmentEventType.onboarding_continue_screen1]:\n\t\t\"SliceMachine Onboarding Continue Screen 1\",\n\t[SegmentEventType.onboarding_continue_screen2]:\n\t\t\"SliceMachine Onboarding Continue Screen 2\",\n\t[SegmentEventType.onboarding_continue_screen3]:\n\t\t\"SliceMachine Onboarding Continue Screen 3\",\n\t[SegmentEventType.sliceSimulator_setup]: \"SliceMachine Slice Simulator Setup\",\n\t[SegmentEventType.sliceSimulator_open]: \"SliceMachine Slice Simulator Open\",\n\t[SegmentEventType.sliceSimulator_isNotRunning]:\n\t\t\"SliceMachine Slice Simulator is not running\",\n\t[SegmentEventType.pageView]: \"SliceMachine Page View\",\n\t[SegmentEventType.openVideoTutorials]: \"SliceMachine Open Video Tutorials\",\n\t[SegmentEventType.customType_created]: \"SliceMachine Custom Type Created\",\n\t[SegmentEventType.customType_fieldAdded]:\n\t\t\"SliceMachine Custom Type Field Added\",\n\t[SegmentEventType.customType_sliceZoneUpdated]:\n\t\t\"SliceMachine Slicezone Updated\",\n\t[SegmentEventType.customType_saved]: \"SliceMachine Custom Type Saved\",\n\t[SegmentEventType.slice_created]: \"SliceMachine Slice Created\",\n\t[SegmentEventType.screenshotTaken]: \"SliceMachine Screenshot Taken\",\n\t[SegmentEventType.changes_pushed]: \"SliceMachine Changes Pushed\",\n\t[SegmentEventType.changes_limitReach]: \"SliceMachine Changes Limit Reach\",\n\t[SegmentEventType.editor_widgetUsed]: \"SliceMachine Editor Widget Used\",\n} as const;\nexport type HumanSegmentEventTypes =\n\t(typeof HumanSegmentEventType)[keyof typeof HumanSegmentEventType];\n\ntype SegmentEvent<\n\tTType extends SegmentEventTypes,\n\tTProperties extends Record<string, unknown> | void = void,\n> = TProperties extends void\n\t? {\n\t\t\tevent: TType;\n\t\t\trepository?: string;\n\t  }\n\t: {\n\t\t\tevent: TType;\n\t\t\trepository?: string;\n\t  } & TProperties;\n\ntype CommandInitStartSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.command_init_start\n>;\n\n// This event feels off, we have a dedicated `identify` method...\ntype CommandInitIdentifySegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.command_init_identify\n>;\n\ntype CommandInitEndSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.command_init_end,\n\t{ framework: string; success: boolean; error?: string }\n>;\n\ntype ReviewSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.review,\n\t{ framework: string; rating: number; comment: string }\n>;\n\ntype OnboardingStartSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.onboarding_start\n>;\n\ntype OnboardingSkipSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.onboarding_skip,\n\t{ screenSkipped: number }\n>;\n\ntype OnboardingContinueScreenIntroSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.onboarding_continue_screenIntro\n>;\n\ntype OnboardingContinueScreen1SegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.onboarding_continue_screen1\n>;\n\ntype OnboardingContinueScreen2SegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.onboarding_continue_screen2\n>;\n\ntype OnboardingContinueScreen3SegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.onboarding_continue_screen3\n>;\n\ntype SliceSimulatorSetupSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.sliceSimulator_setup,\n\t{ framework: string }\n>;\n\ntype SliceSimulatorOpenSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.sliceSimulator_open,\n\t{ framework: string }\n>;\n\ntype SliceSimulatorIsNotRunningSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.sliceSimulator_isNotRunning,\n\t{ framework: string }\n>;\n\ntype PageViewSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.pageView,\n\t{\n\t\turl: string;\n\t\tpath: string;\n\t\tsearch: string;\n\t\ttitle: string;\n\t\treferrer: string;\n\t\tframework: string;\n\t}\n>;\n\ntype OpenVideoTutorialsSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.openVideoTutorials,\n\t{ framework: string; video: string }\n>;\n\ntype CustomTypeCreatedSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.customType_created,\n\t{ id: string; name: string; type: \"repeatable\" | \"single\" }\n>;\n\ntype CustomTypeFieldAddedSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.customType_fieldAdded,\n\t{\n\t\tid: string; // field id\n\t\tname: string; // custom type id\n\t\tzone: \"static\" | \"repeatable\";\n\t\ttype: string;\n\t}\n>;\n\ntype CustomTypeSliceZoneUpdatedSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.customType_sliceZoneUpdated,\n\t{ customTypeId: string }\n>;\n\ntype CustomTypeSavedSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.customType_saved,\n\t{ id: string; name: string; type: \"repeatable\" | \"single\" }\n>;\n\ntype SliceCreatedSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.slice_created,\n\t{ id: string; name: string; library: string }\n>;\n\ntype ScreenshotTakenSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.screenshotTaken,\n\t{\n\t\ttype: \"custom\" | \"automatic\";\n\t\tmethod: \"fromSimulator\" | \"upload\" | \"dragAndDrop\";\n\t}\n>;\n\ntype ChangesPushedSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.changes_pushed,\n\t{\n\t\tcustomTypesCreated: number;\n\t\tcustomTypesModified: number;\n\t\tcustomTypesDeleted: number;\n\t\tslicesCreated: number;\n\t\tslicesModified: number;\n\t\tslicesDeleted: number;\n\t\tmissingScreenshots: number;\n\t\ttotal: number;\n\t\tduration: number;\n\t\thasDeletedDocuments: boolean;\n\t}\n>;\n\ntype ChangesLimitReachSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.changes_limitReach,\n\t{ limitType: LimitType }\n>;\n\ntype EditorWidgetUsedSegmentEvent = SegmentEvent<\n\ttypeof SegmentEventType.editor_widgetUsed,\n\t{ sliceId: string }\n>;\n\nexport type SegmentEvents =\n\t| CommandInitStartSegmentEvent\n\t| CommandInitIdentifySegmentEvent\n\t| CommandInitEndSegmentEvent\n\t| ReviewSegmentEvent\n\t| OnboardingStartSegmentEvent\n\t| OnboardingSkipSegmentEvent\n\t| OnboardingContinueScreenIntroSegmentEvent\n\t| OnboardingContinueScreen1SegmentEvent\n\t| OnboardingContinueScreen2SegmentEvent\n\t| OnboardingContinueScreen3SegmentEvent\n\t| SliceSimulatorSetupSegmentEvent\n\t| SliceSimulatorOpenSegmentEvent\n\t| SliceSimulatorIsNotRunningSegmentEvent\n\t| PageViewSegmentEvent\n\t| OpenVideoTutorialsSegmentEvent\n\t| CustomTypeCreatedSegmentEvent\n\t| CustomTypeFieldAddedSegmentEvent\n\t| CustomTypeSliceZoneUpdatedSegmentEvent\n\t| CustomTypeSavedSegmentEvent\n\t| SliceCreatedSegmentEvent\n\t| ScreenshotTakenSegmentEvent\n\t| ChangesPushedSegmentEvent\n\t| ChangesLimitReachSegmentEvent\n\t| EditorWidgetUsedSegmentEvent;\n"],"names":[],"mappings":";;AAEO,MAAM,mBAAmB;AAAA,EAC/B,oBAAoB;AAAA,EACpB,uBAAuB;AAAA,EACvB,kBAAkB;AAAA,EAClB,QAAQ;AAAA,EACR,kBAAkB;AAAA,EAClB,iBAAiB;AAAA,EACjB,iCAAiC;AAAA,EACjC,6BAA6B;AAAA,EAC7B,6BAA6B;AAAA,EAC7B,6BAA6B;AAAA,EAC7B,sBAAsB;AAAA,EACtB,qBAAqB;AAAA,EACrB,6BAA6B;AAAA,EAC7B,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,oBAAoB;AAAA,EACpB,uBAAuB;AAAA,EACvB,6BAA6B;AAAA,EAC7B,kBAAkB;AAAA,EAClB,eAAe;AAAA,EACf,iBAAiB;AAAA,EACjB,gBAAgB;AAAA,EAChB,oBAAoB;AAAA,EACpB,mBAAmB;;AAKb,MAAM,wBAAwB;AAAA,EACpC,CAAC,iBAAiB,kBAAkB,GAAG;AAAA,EACvC,CAAC,iBAAiB,qBAAqB,GAAG;AAAA,EAC1C,CAAC,iBAAiB,gBAAgB,GAAG;AAAA,EACrC,CAAC,iBAAiB,MAAM,GAAG;AAAA,EAC3B,CAAC,iBAAiB,gBAAgB,GAAG;AAAA,EACrC,CAAC,iBAAiB,eAAe,GAAG;AAAA,EACpC,CAAC,iBAAiB,+BAA+B,GAChD;AAAA,EACD,CAAC,iBAAiB,2BAA2B,GAC5C;AAAA,EACD,CAAC,iBAAiB,2BAA2B,GAC5C;AAAA,EACD,CAAC,iBAAiB,2BAA2B,GAC5C;AAAA,EACD,CAAC,iBAAiB,oBAAoB,GAAG;AAAA,EACzC,CAAC,iBAAiB,mBAAmB,GAAG;AAAA,EACxC,CAAC,iBAAiB,2BAA2B,GAC5C;AAAA,EACD,CAAC,iBAAiB,QAAQ,GAAG;AAAA,EAC7B,CAAC,iBAAiB,kBAAkB,GAAG;AAAA,EACvC,CAAC,iBAAiB,kBAAkB,GAAG;AAAA,EACvC,CAAC,iBAAiB,qBAAqB,GACtC;AAAA,EACD,CAAC,iBAAiB,2BAA2B,GAC5C;AAAA,EACD,CAAC,iBAAiB,gBAAgB,GAAG;AAAA,EACrC,CAAC,iBAAiB,aAAa,GAAG;AAAA,EAClC,CAAC,iBAAiB,eAAe,GAAG;AAAA,EACpC,CAAC,iBAAiB,cAAc,GAAG;AAAA,EACnC,CAAC,iBAAiB,kBAAkB,GAAG;AAAA,EACvC,CAAC,iBAAiB,iBAAiB,GAAG;;;;"}

package/dist/managers/telemetry/types.d.ts

@@ -1,15 +1,58 @@
+import type { LimitType } from "../prismicRepository/types";
 export declare const SegmentEventType: {
     readonly command_init_start: "command:init:start";
     readonly command_init_identify: "command:init:identify";
     readonly command_init_end: "command:init:end";
+    readonly review: "review";
+    readonly onboarding_start: "onboarding:start";
+    readonly onboarding_skip: "onboarding:skip";
+    readonly onboarding_continue_screenIntro: "onboarding:continue:screen-intro";
+    readonly onboarding_continue_screen1: "onboarding:continue:screen-1";
+    readonly onboarding_continue_screen2: "onboarding:continue:screen-2";
+    readonly onboarding_continue_screen3: "onboarding:continue:screen-3";
+    readonly sliceSimulator_setup: "slice-simulator:setup";
+    readonly sliceSimulator_open: "slice-simulator:open";
+    readonly sliceSimulator_isNotRunning: "slice-simulator:is-not-running";
+    readonly pageView: "page-view";
+    readonly openVideoTutorials: "open-video-tutorials";
+    readonly customType_created: "custom-type:created";
+    readonly customType_fieldAdded: "custom-type:field-added";
+    readonly customType_sliceZoneUpdated: "custom-type:slice-zone-updated";
+    readonly customType_saved: "custom-type:saved";
+    readonly slice_created: "slice:created";
+    readonly screenshotTaken: "screenshot-taken";
+    readonly changes_pushed: "changes:pushed";
+    readonly changes_limitReach: "changes:limit-reach";
+    readonly editor_widgetUsed: "editor:widget-used";
 };
-type SegmentEventTypes = typeof SegmentEventType[keyof typeof SegmentEventType];
+type SegmentEventTypes = (typeof SegmentEventType)[keyof typeof SegmentEventType];
 export declare const HumanSegmentEventType: {
     readonly "command:init:start": "SliceMachine Init Start";
     readonly "command:init:identify": "SliceMachine Init Identify";
     readonly "command:init:end": "SliceMachine Init End";
+    readonly review: "SliceMachine Review";
+    readonly "onboarding:start": "SliceMachine Onboarding Start";
+    readonly "onboarding:skip": "SliceMachine Onboarding Skip";
+    readonly "onboarding:continue:screen-intro": "SliceMachine Onboarding Continue Screen Intro";
+    readonly "onboarding:continue:screen-1": "SliceMachine Onboarding Continue Screen 1";
+    readonly "onboarding:continue:screen-2": "SliceMachine Onboarding Continue Screen 2";
+    readonly "onboarding:continue:screen-3": "SliceMachine Onboarding Continue Screen 3";
+    readonly "slice-simulator:setup": "SliceMachine Slice Simulator Setup";
+    readonly "slice-simulator:open": "SliceMachine Slice Simulator Open";
+    readonly "slice-simulator:is-not-running": "SliceMachine Slice Simulator is not running";
+    readonly "page-view": "SliceMachine Page View";
+    readonly "open-video-tutorials": "SliceMachine Open Video Tutorials";
+    readonly "custom-type:created": "SliceMachine Custom Type Created";
+    readonly "custom-type:field-added": "SliceMachine Custom Type Field Added";
+    readonly "custom-type:slice-zone-updated": "SliceMachine Slicezone Updated";
+    readonly "custom-type:saved": "SliceMachine Custom Type Saved";
+    readonly "slice:created": "SliceMachine Slice Created";
+    readonly "screenshot-taken": "SliceMachine Screenshot Taken";
+    readonly "changes:pushed": "SliceMachine Changes Pushed";
+    readonly "changes:limit-reach": "SliceMachine Changes Limit Reach";
+    readonly "editor:widget-used": "SliceMachine Editor Widget Used";
 };
-export type HumanSegmentEventTypes = typeof HumanSegmentEventType[keyof typeof HumanSegmentEventType];
+export type HumanSegmentEventTypes = (typeof HumanSegmentEventType)[keyof typeof HumanSegmentEventType];
 type SegmentEvent<TType extends SegmentEventTypes, TProperties extends Record<string, unknown> | void = void> = TProperties extends void ? {
     event: TType;
     repository?: string;
@@ -24,5 +67,85 @@ type CommandInitEndSegmentEvent = SegmentEvent<typeof SegmentEventType.command_i
     success: boolean;
     error?: string;
 }>;
-export type SegmentEvents = CommandInitStartSegmentEvent | CommandInitIdentifySegmentEvent | CommandInitEndSegmentEvent;
+type ReviewSegmentEvent = SegmentEvent<typeof SegmentEventType.review, {
+    framework: string;
+    rating: number;
+    comment: string;
+}>;
+type OnboardingStartSegmentEvent = SegmentEvent<typeof SegmentEventType.onboarding_start>;
+type OnboardingSkipSegmentEvent = SegmentEvent<typeof SegmentEventType.onboarding_skip, {
+    screenSkipped: number;
+}>;
+type OnboardingContinueScreenIntroSegmentEvent = SegmentEvent<typeof SegmentEventType.onboarding_continue_screenIntro>;
+type OnboardingContinueScreen1SegmentEvent = SegmentEvent<typeof SegmentEventType.onboarding_continue_screen1>;
+type OnboardingContinueScreen2SegmentEvent = SegmentEvent<typeof SegmentEventType.onboarding_continue_screen2>;
+type OnboardingContinueScreen3SegmentEvent = SegmentEvent<typeof SegmentEventType.onboarding_continue_screen3>;
+type SliceSimulatorSetupSegmentEvent = SegmentEvent<typeof SegmentEventType.sliceSimulator_setup, {
+    framework: string;
+}>;
+type SliceSimulatorOpenSegmentEvent = SegmentEvent<typeof SegmentEventType.sliceSimulator_open, {
+    framework: string;
+}>;
+type SliceSimulatorIsNotRunningSegmentEvent = SegmentEvent<typeof SegmentEventType.sliceSimulator_isNotRunning, {
+    framework: string;
+}>;
+type PageViewSegmentEvent = SegmentEvent<typeof SegmentEventType.pageView, {
+    url: string;
+    path: string;
+    search: string;
+    title: string;
+    referrer: string;
+    framework: string;
+}>;
+type OpenVideoTutorialsSegmentEvent = SegmentEvent<typeof SegmentEventType.openVideoTutorials, {
+    framework: string;
+    video: string;
+}>;
+type CustomTypeCreatedSegmentEvent = SegmentEvent<typeof SegmentEventType.customType_created, {
+    id: string;
+    name: string;
+    type: "repeatable" | "single";
+}>;
+type CustomTypeFieldAddedSegmentEvent = SegmentEvent<typeof SegmentEventType.customType_fieldAdded, {
+    id: string;
+    name: string;
+    zone: "static" | "repeatable";
+    type: string;
+}>;
+type CustomTypeSliceZoneUpdatedSegmentEvent = SegmentEvent<typeof SegmentEventType.customType_sliceZoneUpdated, {
+    customTypeId: string;
+}>;
+type CustomTypeSavedSegmentEvent = SegmentEvent<typeof SegmentEventType.customType_saved, {
+    id: string;
+    name: string;
+    type: "repeatable" | "single";
+}>;
+type SliceCreatedSegmentEvent = SegmentEvent<typeof SegmentEventType.slice_created, {
+    id: string;
+    name: string;
+    library: string;
+}>;
+type ScreenshotTakenSegmentEvent = SegmentEvent<typeof SegmentEventType.screenshotTaken, {
+    type: "custom" | "automatic";
+    method: "fromSimulator" | "upload" | "dragAndDrop";
+}>;
+type ChangesPushedSegmentEvent = SegmentEvent<typeof SegmentEventType.changes_pushed, {
+    customTypesCreated: number;
+    customTypesModified: number;
+    customTypesDeleted: number;
+    slicesCreated: number;
+    slicesModified: number;
+    slicesDeleted: number;
+    missingScreenshots: number;
+    total: number;
+    duration: number;
+    hasDeletedDocuments: boolean;
+}>;
+type ChangesLimitReachSegmentEvent = SegmentEvent<typeof SegmentEventType.changes_limitReach, {
+    limitType: LimitType;
+}>;
+type EditorWidgetUsedSegmentEvent = SegmentEvent<typeof SegmentEventType.editor_widgetUsed, {
+    sliceId: string;
+}>;
+export type SegmentEvents = CommandInitStartSegmentEvent | CommandInitIdentifySegmentEvent | CommandInitEndSegmentEvent | ReviewSegmentEvent | OnboardingStartSegmentEvent | OnboardingSkipSegmentEvent | OnboardingContinueScreenIntroSegmentEvent | OnboardingContinueScreen1SegmentEvent | OnboardingContinueScreen2SegmentEvent | OnboardingContinueScreen3SegmentEvent | SliceSimulatorSetupSegmentEvent | SliceSimulatorOpenSegmentEvent | SliceSimulatorIsNotRunningSegmentEvent | PageViewSegmentEvent | OpenVideoTutorialsSegmentEvent | CustomTypeCreatedSegmentEvent | CustomTypeFieldAddedSegmentEvent | CustomTypeSliceZoneUpdatedSegmentEvent | CustomTypeSavedSegmentEvent | SliceCreatedSegmentEvent | ScreenshotTakenSegmentEvent | ChangesPushedSegmentEvent | ChangesLimitReachSegmentEvent | EditorWidgetUsedSegmentEvent;
 export {};

package/dist/managers/telemetry/types.js

@@ -1,12 +1,54 @@
 const SegmentEventType = {
   command_init_start: "command:init:start",
   command_init_identify: "command:init:identify",
-  command_init_end: "command:init:end"
+  command_init_end: "command:init:end",
+  review: "review",
+  onboarding_start: "onboarding:start",
+  onboarding_skip: "onboarding:skip",
+  onboarding_continue_screenIntro: "onboarding:continue:screen-intro",
+  onboarding_continue_screen1: "onboarding:continue:screen-1",
+  onboarding_continue_screen2: "onboarding:continue:screen-2",
+  onboarding_continue_screen3: "onboarding:continue:screen-3",
+  sliceSimulator_setup: "slice-simulator:setup",
+  sliceSimulator_open: "slice-simulator:open",
+  sliceSimulator_isNotRunning: "slice-simulator:is-not-running",
+  pageView: "page-view",
+  openVideoTutorials: "open-video-tutorials",
+  customType_created: "custom-type:created",
+  customType_fieldAdded: "custom-type:field-added",
+  customType_sliceZoneUpdated: "custom-type:slice-zone-updated",
+  customType_saved: "custom-type:saved",
+  slice_created: "slice:created",
+  screenshotTaken: "screenshot-taken",
+  changes_pushed: "changes:pushed",
+  changes_limitReach: "changes:limit-reach",
+  editor_widgetUsed: "editor:widget-used"
 };
 const HumanSegmentEventType = {
   [SegmentEventType.command_init_start]: "SliceMachine Init Start",
   [SegmentEventType.command_init_identify]: "SliceMachine Init Identify",
-  [SegmentEventType.command_init_end]: "SliceMachine Init End"
+  [SegmentEventType.command_init_end]: "SliceMachine Init End",
+  [SegmentEventType.review]: "SliceMachine Review",
+  [SegmentEventType.onboarding_start]: "SliceMachine Onboarding Start",
+  [SegmentEventType.onboarding_skip]: "SliceMachine Onboarding Skip",
+  [SegmentEventType.onboarding_continue_screenIntro]: "SliceMachine Onboarding Continue Screen Intro",
+  [SegmentEventType.onboarding_continue_screen1]: "SliceMachine Onboarding Continue Screen 1",
+  [SegmentEventType.onboarding_continue_screen2]: "SliceMachine Onboarding Continue Screen 2",
+  [SegmentEventType.onboarding_continue_screen3]: "SliceMachine Onboarding Continue Screen 3",
+  [SegmentEventType.sliceSimulator_setup]: "SliceMachine Slice Simulator Setup",
+  [SegmentEventType.sliceSimulator_open]: "SliceMachine Slice Simulator Open",
+  [SegmentEventType.sliceSimulator_isNotRunning]: "SliceMachine Slice Simulator is not running",
+  [SegmentEventType.pageView]: "SliceMachine Page View",
+  [SegmentEventType.openVideoTutorials]: "SliceMachine Open Video Tutorials",
+  [SegmentEventType.customType_created]: "SliceMachine Custom Type Created",
+  [SegmentEventType.customType_fieldAdded]: "SliceMachine Custom Type Field Added",
+  [SegmentEventType.customType_sliceZoneUpdated]: "SliceMachine Slicezone Updated",
+  [SegmentEventType.customType_saved]: "SliceMachine Custom Type Saved",
+  [SegmentEventType.slice_created]: "SliceMachine Slice Created",
+  [SegmentEventType.screenshotTaken]: "SliceMachine Screenshot Taken",
+  [SegmentEventType.changes_pushed]: "SliceMachine Changes Pushed",
+  [SegmentEventType.changes_limitReach]: "SliceMachine Changes Limit Reach",
+  [SegmentEventType.editor_widgetUsed]: "SliceMachine Editor Widget Used"
 };
 export {
   HumanSegmentEventType,