commandkit 1.0.0-dev.20250605125234 → 1.0.0-dev.20250605135449

package/analytics.cjs

@@ -0,0 +1,19 @@
+const { getCommandKit } = require('./dist/CommandKit-CykDrHnK.js');
+const { AnalyticsEngine } = require('./dist/analytics/analytics-engine.js');
+const { noAnalytics } = require('./dist/analytics/utils.js');
+
+function useAnalytics() {
+    const commandkit = getCommandKit(true);
+    return commandkit.analytics;
+}
+
+function track(event) {
+    return useAnalytics().track(event);
+}
+
+module.exports = {
+    AnalyticsEngine,
+    useAnalytics,
+    noAnalytics,
+    track,
+};

package/analytics.d.ts

@@ -0,0 +1,8 @@
+import type { AnalyticsEngine } from './dist/CommandKit-CykDrHnK';
+
+export * from './dist/analytics/analytics-engine';
+export * from './dist/analytics/analytics-provider';
+export { noAnalytics } from './dist/analytics/utils';
+
+export function useAnalytics(): AnalyticsEngine;
+export function track(event: AnalyticsEvent): Promise<void>;

package/dist/{CommandKit-LJlFFidn.d.ts → CommandKit-CEFWQpDo.d.ts}

@@ -808,6 +808,7 @@ interface FlagRunner<E, R> {
 }
 declare class FeatureFlag<R, T> {
   readonly options: FeatureFlagDefinition<R, T>;
+  private commandkit;
   constructor(options: FeatureFlagDefinition<R, T>);
   private getContext;
   execute(res?: T): Promise<R>;
@@ -817,6 +818,33 @@ declare function flag<Returns = boolean, Entity = Record<any, any>>(options: Fea
 //#region src/flags/store.d.ts
 declare class FlagStore extends Collection<string, FeatureFlag<any, any>> {}
 //#endregion
+//#region src/analytics/analytics-provider.d.ts
+interface AnalyticsEvent {
+  name: string;
+  id?: string;
+  data: Record<string, any>;
+}
+type IdentifyEvent = Record<string, any>;
+interface AnalyticsProvider {
+  readonly name: string;
+  track(engine: AnalyticsEngine, event: AnalyticsEvent): Promise<void>;
+  identify?(engine: AnalyticsEngine, event: IdentifyEvent): Promise<void>;
+}
+//#endregion
+//#region src/analytics/analytics-engine.d.ts
+type FilterFunction = (engine: AnalyticsEngine, event: AnalyticsEvent) => boolean;
+declare class AnalyticsEngine {
+  #private;
+  readonly commandkit: CommandKit;
+  constructor(commandkit: CommandKit);
+  setFilter(filter: FilterFunction | null): void;
+  registerProvider(provider: AnalyticsProvider): void;
+  removeProvider(provider: AnalyticsProvider): void;
+  getProvider(): AnalyticsProvider | null;
+  identify(event: IdentifyEvent): Promise<void>;
+  track(event: AnalyticsEvent): Promise<void>;
+}
+//#endregion
 //#region src/CommandKit.d.ts
 interface CommandKitConfiguration {
   defaultLocale: Locale;
@@ -865,6 +893,7 @@ declare class CommandKit extends EventEmitter {
   eventHandler: AppEventsHandler;
   plugins: CommandKitPluginRuntime;
   events: CommandKitEventsChannel;
+  analytics: AnalyticsEngine;
   static instance: CommandKit | undefined;
   /**
    * Create a new command and event handler with CommandKit.
@@ -932,5 +961,5 @@ declare class CommandKit extends EventEmitter {
 }
 declare const commandkit: CommandKit;
 //#endregion
-export { AnyCommandExecute, AppCommandHandler, AppCommandRunner, AppEventsHandler, AppEventsHandlerLoadedData, AsyncFunction, AutocompleteCommand, AutocompleteCommandContext, AutocompleteCommandMiddlewareContext, BootstrapFunction, ChatInputCommand, ChatInputCommandContext, CommandBuilderLike, CommandContext, CommandContextOptions, CommandData, CommandExecutionMode, CommandFlagContext, CommandKit, CommandKitConfiguration, CommandKitEnvironment, CommandKitEnvironmentInternalData, CommandKitEnvironmentType, CommandKitEventDispatch, CommandKitEventsChannel, CommandKitHMREvent, CommandKitOptions, CommandKitPlugin, CommandKitPluginRuntime, CommandRegistrar, CommandTypeData, CommonDirectiveTransformer, CommonDirectiveTransformerOptions, CommonPluginRuntime, CompilerPlugin, CompilerPluginRuntime, Context, ContextParameters, CustomEvaluationContext, CustomEvaluationFunction, DecideFunction, EvaluationContext, EventFlagContext, EventListener, FeatureFlag, FeatureFlagDefinition, FlagRunner, FlagStore, GenericFunction, IdentifyFunction, InteractionCommandContext, InteractionCommandMiddlewareContext, ListenerFunction, LoadedCommand, LoadedEvent, MaybeFalsey, MaybePromise, MessageCommand, MessageCommandContext, MessageCommandMiddlewareContext, MessageContextMenuCommand, MessageContextMenuCommandContext, MessageContextMenuCommandMiddlewareContext, MiddlewareContext, MiddlewareContextArgs, PluginCommon, PluginOptions, PluginTransformParameters, PluginType, PreRegisterCommandsEvent, PreparedAppCommandExecution, ResolvableCommand, RunCommand, RuntimePlugin, SlashCommandMiddlewareContext, TemplateHandler, TransformedResult, UserContextMenuCommand, UserContextMenuCommandContext, UserContextMenuCommandMiddlewareContext, after, cancelAfter, commandkit, exitContext, flag, getCommandKit, getContext, isCommandWorkerContext, isCompilerPlugin, isPlugin, isRuntimePlugin, makeContextAwareFunction, onApplicationBootstrap, onBootstrap, provideContext, registerDevHooks, useEnvironment };
-//# sourceMappingURL=CommandKit-LJlFFidn.d.ts.map
+export { AnalyticsEngine, AnalyticsEvent, AnalyticsProvider, AnyCommandExecute, AppCommandHandler, AppCommandRunner, AppEventsHandler, AppEventsHandlerLoadedData, AsyncFunction, AutocompleteCommand, AutocompleteCommandContext, AutocompleteCommandMiddlewareContext, BootstrapFunction, ChatInputCommand, ChatInputCommandContext, CommandBuilderLike, CommandContext, CommandContextOptions, CommandData, CommandExecutionMode, CommandFlagContext, CommandKit, CommandKitConfiguration, CommandKitEnvironment, CommandKitEnvironmentInternalData, CommandKitEnvironmentType, CommandKitEventDispatch, CommandKitEventsChannel, CommandKitHMREvent, CommandKitOptions, CommandKitPlugin, CommandKitPluginRuntime, CommandRegistrar, CommandTypeData, CommonDirectiveTransformer, CommonDirectiveTransformerOptions, CommonPluginRuntime, CompilerPlugin, CompilerPluginRuntime, Context, ContextParameters, CustomEvaluationContext, CustomEvaluationFunction, DecideFunction, EvaluationContext, EventFlagContext, EventListener, FeatureFlag, FeatureFlagDefinition, FilterFunction, FlagRunner, FlagStore, GenericFunction, IdentifyEvent, IdentifyFunction, InteractionCommandContext, InteractionCommandMiddlewareContext, ListenerFunction, LoadedCommand, LoadedEvent, MaybeFalsey, MaybePromise, MessageCommand, MessageCommandContext, MessageCommandMiddlewareContext, MessageContextMenuCommand, MessageContextMenuCommandContext, MessageContextMenuCommandMiddlewareContext, MiddlewareContext, MiddlewareContextArgs, PluginCommon, PluginOptions, PluginTransformParameters, PluginType, PreRegisterCommandsEvent, PreparedAppCommandExecution, ResolvableCommand, RunCommand, RuntimePlugin, SlashCommandMiddlewareContext, TemplateHandler, TransformedResult, UserContextMenuCommand, UserContextMenuCommandContext, UserContextMenuCommandMiddlewareContext, after, cancelAfter, commandkit, exitContext, flag, getCommandKit, getContext, isCommandWorkerContext, isCompilerPlugin, isPlugin, isRuntimePlugin, makeContextAwareFunction, onApplicationBootstrap, onBootstrap, provideContext, registerDevHooks, useEnvironment };
+//# sourceMappingURL=CommandKit-CEFWQpDo.d.ts.map

package/dist/{CommandKit-O_Ra_xRL.js → CommandKit-CrZN2bV4.js}

@@ -1,6 +1,7 @@
 const require_chunk = require('./chunk-nOFOJqeH.js');
 const require_colors = require('./colors-Cd4Oz-r-.js');
 const require_error_codes = require('./error-codes-C_UO39jz.js');
+const require_warn_unstable = require('./warn-unstable-DHLaxPC8.js');
 const require_element = require('./element-DcqNz1dV.js');
 const require_EventInterceptor = require('./EventInterceptor-Bvh05z7n.js');
 const require_constants = require('./constants-CCqS_v55.js');
@@ -16,6 +17,7 @@ const require_EventsRouter = require('./EventsRouter-C_J0M3uO.js');
 const require_common = require('./common-CoUM9Czx.js');
 const require_CommandKitEventsChannel = require('./CommandKitEventsChannel-BnSPcFdq.js');
 const require_store = require('./store-B9bo6On8.js');
+const require_constants$1 = require('./constants-CKVeDN4e.js');
 const node_events = require_chunk.__toESM(require("node:events"));
 const discord_js = require_chunk.__toESM(require("discord.js"));
 const node_async_hooks = require_chunk.__toESM(require("node:async_hooks"));
@@ -1420,6 +1422,28 @@ function debounce(fn, ms) {
 	};
 }
 /**
+* Defers the execution of a function.
+* @param fn The function to defer.
+*/
+function defer(fn, timeout = 0) {
+	setTimeout(() => {
+		return fn();
+	}, timeout).unref();
+}
+/**
+* Serializes a value to JSON.
+* @param value The value to serialize.
+* @param defaultValue The default value to return if the value is not serializable.
+* @returns The serialized value.
+*/
+function JsonSerialize(value, defaultValue = {}) {
+	try {
+		return JSON.parse(JSON.stringify(value));
+	} catch {
+		return defaultValue;
+	}
+}
+/**
 * Creates a function from the given function that runs only in development mode.
 * @param fn The function to run in development mode.
 * @returns The function that runs only in development mode.
@@ -2570,7 +2594,8 @@ var AppEventsHandler = class {
 					namespace: namespace ?? null,
 					data: data.event,
 					commandkit: this.commandkit,
-					arguments: args
+					arguments: args,
+					variables: /* @__PURE__ */ new Map()
 				}, async () => {
 					for (const listener of onListeners) try {
 						await listener.handler(...args);
@@ -2609,7 +2634,8 @@ var AppEventsHandler = class {
 						namespace: namespace ?? null,
 						data: data.event,
 						commandkit: this.commandkit,
-						arguments: args
+						arguments: args,
+						variables: /* @__PURE__ */ new Map()
 					}, async () => {
 						try {
 							if (executedOnceListeners.has(listener.handler)) return;
@@ -2744,6 +2770,75 @@ function registerDevHooks(commandkit$1) {
 	});
 }
 
+//#endregion
+//#region src/analytics/utils.ts
+function getVariableStore() {
+	const ctx = getContext();
+	if (!ctx) try {
+		const eventContext = require_EventWorkerContext.getEventWorkerContext();
+		return eventContext.variables;
+	} catch {
+		return null;
+	}
+	return ctx.variables;
+}
+function getDoNotTrack() {
+	const variables = getVariableStore();
+	return (variables === null || variables === void 0 ? void 0 : variables.get(require_constants$1.DO_NOT_TRACK_KEY)) === true;
+}
+function noAnalytics() {
+	const variables = getVariableStore();
+	if (!variables) throw new Error("noAnalytics may only be used inside commandkit context");
+	variables.set(require_constants$1.DO_NOT_TRACK_KEY, true);
+}
+
+//#endregion
+//#region src/analytics/analytics-engine.ts
+var AnalyticsEngine = class {
+	#provider = null;
+	#filter = null;
+	constructor(commandkit$1) {
+		this.commandkit = commandkit$1;
+	}
+	setFilter(filter) {
+		this.#filter = filter;
+	}
+	registerProvider(provider) {
+		require_warn_unstable.warnUnstable("analytics");
+		this.#provider = provider;
+	}
+	removeProvider(provider) {
+		if (this.#provider === provider) this.#provider = null;
+	}
+	getProvider() {
+		return this.#provider;
+	}
+	async identify(event) {
+		if (!this.#provider) return;
+		try {
+			var _identify, _ref;
+			await ((_identify = (_ref = this.#provider).identify) === null || _identify === void 0 ? void 0 : _identify.call(_ref, this, event));
+		} catch (error) {
+			Logger.error(`Error identifying with provider ${this.#provider.name}`, error);
+		}
+	}
+	async track(event) {
+		if (!this.#provider) return;
+		try {
+			if (await this.#doNotTrack(event)) return;
+			await this.#provider.track(this, event);
+		} catch (error) {
+			Logger.error(`Error tracking ${event.name} event with provider ${this.#provider.name}`, error);
+		}
+	}
+	async #doNotTrack(event) {
+		const dnt = getDoNotTrack();
+		if (dnt) return true;
+		if (this.#filter) return this.#filter(this, event);
+		return false;
+	}
+};
+
 //#endregion
 //#region src/CommandKit.ts
 const bootstrapHooks = /* @__PURE__ */ new Set();
@@ -2799,6 +2894,7 @@ var CommandKit = class CommandKit extends node_events.default {
 	eventHandler;
 	plugins;
 	events;
+	analytics;
 	static instance = void 0;
 	/**
 	* Create a new command and event handler with CommandKit.
@@ -2812,6 +2908,7 @@ var CommandKit = class CommandKit extends node_events.default {
 		if (!CommandKit.instance) CommandKit.instance = this;
 		if (options === null || options === void 0 ? void 0 : options.client) this.setClient(options.client);
 		this.plugins = new CommandKitPluginRuntime(this);
+		this.analytics = new AnalyticsEngine(this);
 		this.#bootstrapHooks();
 	}
 	async #bootstrapHooks() {
@@ -2999,6 +3096,12 @@ var CommandKit = class CommandKit extends node_events.default {
 const commandkit = CommandKit.instance || new CommandKit();
 
 //#endregion
+Object.defineProperty(exports, 'AnalyticsEngine', {
+  enumerable: true,
+  get: function () {
+    return AnalyticsEngine;
+  }
+});
 Object.defineProperty(exports, 'AppCommandHandler', {
   enumerable: true,
   get: function () {
@@ -3095,6 +3198,12 @@ Object.defineProperty(exports, 'DefaultLogger', {
     return DefaultLogger;
   }
 });
+Object.defineProperty(exports, 'JsonSerialize', {
+  enumerable: true,
+  get: function () {
+    return JsonSerialize;
+  }
+});
 Object.defineProperty(exports, 'Logger', {
   enumerable: true,
   get: function () {
@@ -3245,6 +3354,12 @@ Object.defineProperty(exports, 'defaultConfig', {
     return defaultConfig;
   }
 });
+Object.defineProperty(exports, 'defer', {
+  enumerable: true,
+  get: function () {
+    return defer;
+  }
+});
 Object.defineProperty(exports, 'defineConfig', {
   enumerable: true,
   get: function () {
@@ -3293,6 +3408,12 @@ Object.defineProperty(exports, 'getCurrentDirectory', {
     return getCurrentDirectory;
   }
 });
+Object.defineProperty(exports, 'getDoNotTrack', {
+  enumerable: true,
+  get: function () {
+    return getDoNotTrack;
+  }
+});
 Object.defineProperty(exports, 'getPossibleConfigPaths', {
   enumerable: true,
   get: function () {
@@ -3323,6 +3444,12 @@ Object.defineProperty(exports, 'makeContextAwareFunction', {
     return makeContextAwareFunction;
   }
 });
+Object.defineProperty(exports, 'noAnalytics', {
+  enumerable: true,
+  get: function () {
+    return noAnalytics;
+  }
+});
 Object.defineProperty(exports, 'onApplicationBootstrap', {
   enumerable: true,
   get: function () {
@@ -3359,4 +3486,4 @@ Object.defineProperty(exports, 'useEnvironment', {
     return useEnvironment;
   }
 });
-//# sourceMappingURL=CommandKit-O_Ra_xRL.js.map
+//# sourceMappingURL=CommandKit-CrZN2bV4.js.map