@dereekb/analytics 13.11.14 → 13.11.15

package/index.cjs.js

@@ -15,6 +15,10 @@ function _type_of(obj) {
  * 2. Filters out any values that are not `string`, `number`, or `boolean`
  * 3. Filters out non-finite numbers (`NaN`, `Infinity`, `-Infinity`)
  *
+ * @param input - The object to convert. If nullish, returns an empty object.
+ * @param config - Optional configuration for flattening behavior.
+ * @returns A new {@link AnalyticsEventData} object containing only valid analytics values.
+ *
  * @example
  * ```ts
  * asAnalyticsEventData({ action: 'click', user: { age: 25, name: 'Jo' }, tags: [1, 2] });
@@ -23,10 +27,6 @@ function _type_of(obj) {
  * asAnalyticsEventData({ a: 'ok', b: { nested: 1 } }, { flattenObjects: false });
  * // { a: 'ok' }
  * ```
- *
- * @param input - The object to convert. If nullish, returns an empty object.
- * @param config - Optional configuration for flattening behavior.
- * @returns A new {@link AnalyticsEventData} object containing only valid analytics values.
  */ function asAnalyticsEventData(input, config) {
     var result = {};
     if (input != null) {

package/index.esm.js

@@ -13,6 +13,10 @@ function _type_of(obj) {
  * 2. Filters out any values that are not `string`, `number`, or `boolean`
  * 3. Filters out non-finite numbers (`NaN`, `Infinity`, `-Infinity`)
  *
+ * @param input - The object to convert. If nullish, returns an empty object.
+ * @param config - Optional configuration for flattening behavior.
+ * @returns A new {@link AnalyticsEventData} object containing only valid analytics values.
+ *
  * @example
  * ```ts
  * asAnalyticsEventData({ action: 'click', user: { age: 25, name: 'Jo' }, tags: [1, 2] });
@@ -21,10 +25,6 @@ function _type_of(obj) {
  * asAnalyticsEventData({ a: 'ok', b: { nested: 1 } }, { flattenObjects: false });
  * // { a: 'ok' }
  * ```
- *
- * @param input - The object to convert. If nullish, returns an empty object.
- * @param config - Optional configuration for flattening behavior.
- * @returns A new {@link AnalyticsEventData} object containing only valid analytics values.
  */ function asAnalyticsEventData(input, config) {
     var result = {};
     if (input != null) {

package/nestjs/index.cjs.js

@@ -393,9 +393,8 @@ function _object_spread_props(target, source) {
      *
      * In log-only mode, events are logged to the console instead of being sent to Segment.
      *
-     * @param userId - the user to associate with the event
-     * @param event - the track event containing event name, properties, and optional context
-     *
+     * @param userId - The user to associate with the event.
+     * @param event - The track event containing event name, properties, and optional context.
      * @throws {Error} When userId is falsy.
      *
      * @example
@@ -429,8 +428,8 @@ function _object_spread_props(target, source) {
      *
      * Convenience wrapper around {@link track} for cases where the user may not be authenticated.
      *
-     * @param userId - the user to associate with the event, or nullish to skip
-     * @param event - the track event containing event name, properties, and optional context
+     * @param userId - The user to associate with the event, or nullish to skip.
+     * @param event - The track event containing event name, properties, and optional context.
      */ key: "tryTrack",
             value: function tryTrack(userId, event) {
                 if (userId) {
@@ -444,7 +443,7 @@ function _object_spread_props(target, source) {
      *
      * In log-only mode, the identify call is logged to the console instead of being sent.
      *
-     * @param params - the identify parameters including userId and optional traits
+     * @param params - The identify parameters including userId and optional traits.
      *
      * @example
      * ```ts
@@ -587,13 +586,18 @@ var ANALYTICS_INTERCEPTOR_METADATA_KEY = 'analyticsevent';
  *
  * @param config - The analytics event configuration specifying the event name and optional data extractor.
  * @returns A method decorator that attaches analytics metadata.
+ * @throws {Error} When `config.name` is empty.
+ *
+ * @dbxAllowConstantName NestJS decorator factories conventionally use PascalCase.
  *
  * @example
- * ```ts
- * @EmitAnalyticsEvent({ name: 'User Registered', fn: (result) => ({ userId: result.id }) })
- * @Post('register')
- * async register(@Body() body: RegisterDto) {
- *   return this.authService.register(body);
+ * ```typescript
+ * class AuthController {
+ *   @EmitAnalyticsEvent({ name: 'User Registered', fn: (result) => ({ userId: result.id }) })
+ *   @Post('register')
+ *   async register(@Body() body: RegisterDto) {
+ *     return this.authService.register(body);
+ *   }
  * }
  * ```
  */ var EmitAnalyticsEvent = function EmitAnalyticsEvent(config) {

package/nestjs/index.esm.js

@@ -391,9 +391,8 @@ function _object_spread_props(target, source) {
      *
      * In log-only mode, events are logged to the console instead of being sent to Segment.
      *
-     * @param userId - the user to associate with the event
-     * @param event - the track event containing event name, properties, and optional context
-     *
+     * @param userId - The user to associate with the event.
+     * @param event - The track event containing event name, properties, and optional context.
      * @throws {Error} When userId is falsy.
      *
      * @example
@@ -427,8 +426,8 @@ function _object_spread_props(target, source) {
      *
      * Convenience wrapper around {@link track} for cases where the user may not be authenticated.
      *
-     * @param userId - the user to associate with the event, or nullish to skip
-     * @param event - the track event containing event name, properties, and optional context
+     * @param userId - The user to associate with the event, or nullish to skip.
+     * @param event - The track event containing event name, properties, and optional context.
      */ key: "tryTrack",
             value: function tryTrack(userId, event) {
                 if (userId) {
@@ -442,7 +441,7 @@ function _object_spread_props(target, source) {
      *
      * In log-only mode, the identify call is logged to the console instead of being sent.
      *
-     * @param params - the identify parameters including userId and optional traits
+     * @param params - The identify parameters including userId and optional traits.
      *
      * @example
      * ```ts
@@ -585,13 +584,18 @@ var ANALYTICS_INTERCEPTOR_METADATA_KEY = 'analyticsevent';
  *
  * @param config - The analytics event configuration specifying the event name and optional data extractor.
  * @returns A method decorator that attaches analytics metadata.
+ * @throws {Error} When `config.name` is empty.
+ *
+ * @dbxAllowConstantName NestJS decorator factories conventionally use PascalCase.
  *
  * @example
- * ```ts
- * @EmitAnalyticsEvent({ name: 'User Registered', fn: (result) => ({ userId: result.id }) })
- * @Post('register')
- * async register(@Body() body: RegisterDto) {
- *   return this.authService.register(body);
+ * ```typescript
+ * class AuthController {
+ *   @EmitAnalyticsEvent({ name: 'User Registered', fn: (result) => ({ userId: result.id }) })
+ *   @Post('register')
+ *   async register(@Body() body: RegisterDto) {
+ *     return this.authService.register(body);
+ *   }
  * }
  * ```
  */ var EmitAnalyticsEvent = function EmitAnalyticsEvent(config) {

package/nestjs/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dereekb/analytics/nestjs",
-  "version": "13.11.14",
+  "version": "13.11.15",
   "peerDependencies": {
-    "@dereekb/analytics": "13.11.14",
-    "@dereekb/nestjs": "13.11.14",
-    "@dereekb/rxjs": "13.11.14",
-    "@dereekb/util": "13.11.14",
+    "@dereekb/analytics": "13.11.15",
+    "@dereekb/nestjs": "13.11.15",
+    "@dereekb/rxjs": "13.11.15",
+    "@dereekb/util": "13.11.15",
     "@nestjs/common": "^11.1.19",
     "@nestjs/config": "^4.0.4",
     "@nestjs/core": "^11.1.19",

package/nestjs/src/lib/interceptor/analytics.interceptor.d.ts

@@ -34,13 +34,18 @@ export interface AnalyticsEventInterceptorConfig<T> {
  *
  * @param config - The analytics event configuration specifying the event name and optional data extractor.
  * @returns A method decorator that attaches analytics metadata.
+ * @throws {Error} When `config.name` is empty.
+ *
+ * @dbxAllowConstantName NestJS decorator factories conventionally use PascalCase.
  *
  * @example
- * ```ts
- * @EmitAnalyticsEvent({ name: 'User Registered', fn: (result) => ({ userId: result.id }) })
- * @Post('register')
- * async register(@Body() body: RegisterDto) {
- *   return this.authService.register(body);
+ * ```typescript
+ * class AuthController {
+ *   @EmitAnalyticsEvent({ name: 'User Registered', fn: (result) => ({ userId: result.id }) })
+ *   @Post('register')
+ *   async register(@Body() body: RegisterDto) {
+ *     return this.authService.register(body);
+ *   }
  * }
  * ```
  */

package/nestjs/src/lib/segment/segment.service.d.ts

@@ -19,9 +19,8 @@ export declare class SegmentService {
      *
      * In log-only mode, events are logged to the console instead of being sent to Segment.
      *
-     * @param userId - the user to associate with the event
-     * @param event - the track event containing event name, properties, and optional context
-     *
+     * @param userId - The user to associate with the event.
+     * @param event - The track event containing event name, properties, and optional context.
      * @throws {Error} When userId is falsy.
      *
      * @example
@@ -38,8 +37,8 @@ export declare class SegmentService {
      *
      * Convenience wrapper around {@link track} for cases where the user may not be authenticated.
      *
-     * @param userId - the user to associate with the event, or nullish to skip
-     * @param event - the track event containing event name, properties, and optional context
+     * @param userId - The user to associate with the event, or nullish to skip.
+     * @param event - The track event containing event name, properties, and optional context.
      */
     tryTrack(userId: Maybe<AnalyticsUserId>, event: SegmentTrackEvent): void;
     /**
@@ -47,7 +46,7 @@ export declare class SegmentService {
      *
      * In log-only mode, the identify call is logged to the console instead of being sent.
      *
-     * @param params - the identify parameters including userId and optional traits
+     * @param params - The identify parameters including userId and optional traits.
      *
      * @example
      * ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/analytics",
-  "version": "13.11.14",
+  "version": "13.11.15",
   "exports": {
     "./nestjs": {
       "module": "./nestjs/index.esm.js",
@@ -17,9 +17,9 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/nestjs": "13.11.14",
-    "@dereekb/rxjs": "13.11.14",
-    "@dereekb/util": "13.11.14",
+    "@dereekb/nestjs": "13.11.15",
+    "@dereekb/rxjs": "13.11.15",
+    "@dereekb/util": "13.11.15",
     "@nestjs/common": "^11.1.19",
     "@nestjs/config": "^4.0.4",
     "@nestjs/core": "^11.1.19",

package/src/lib/analytics.event.d.ts

@@ -1,4 +1,4 @@
-import { type Maybe, type PrimativeKey } from '@dereekb/util';
+import { type SuggestedString, type Maybe, type PrimativeKey } from '@dereekb/util';
 /**
  * Name identifier for an analytics event (e.g., `'User Registered'`, `'Page Viewed'`).
  */
@@ -53,7 +53,7 @@ export interface UserAnalyticsEvent extends AnalyticsEvent {
 /**
  * Registration method used to create a new user account (e.g., `'facebook'`, `'google'`, `'email'`).
  */
-export type NewUserRegistrationMethod = 'facebook' | 'google' | 'email' | (string & {});
+export type NewUserRegistrationMethod = SuggestedString<'facebook' | 'google' | 'email'>;
 /**
  * Event data for new user registration events, requiring the registration method.
  */

package/src/lib/analytics.event.util.d.ts

@@ -39,6 +39,10 @@ export interface AsAnalyticsEventDataConfig {
  * 2. Filters out any values that are not `string`, `number`, or `boolean`
  * 3. Filters out non-finite numbers (`NaN`, `Infinity`, `-Infinity`)
  *
+ * @param input - The object to convert. If nullish, returns an empty object.
+ * @param config - Optional configuration for flattening behavior.
+ * @returns A new {@link AnalyticsEventData} object containing only valid analytics values.
+ *
  * @example
  * ```ts
  * asAnalyticsEventData({ action: 'click', user: { age: 25, name: 'Jo' }, tags: [1, 2] });
@@ -47,9 +51,5 @@ export interface AsAnalyticsEventDataConfig {
  * asAnalyticsEventData({ a: 'ok', b: { nested: 1 } }, { flattenObjects: false });
  * // { a: 'ok' }
  * ```
- *
- * @param input - The object to convert. If nullish, returns an empty object.
- * @param config - Optional configuration for flattening behavior.
- * @returns A new {@link AnalyticsEventData} object containing only valid analytics values.
  */
 export declare function asAnalyticsEventData(input: Maybe<Record<string, unknown>>, config?: AsAnalyticsEventDataConfig): AnalyticsEventData;