Fix parameterize types

Author: k-fish

packages/core/src/exports.ts

@@ -23,7 +23,7 @@ import { logger } from './utils-hoist/logger';
 import { uuid4 } from './utils-hoist/misc';
 import { timestampInSeconds } from './utils-hoist/time';
 import { GLOBAL_OBJ } from './utils-hoist/worldwide';
-import { parameterize } from './utils/parameterize';
+import { parameterizeAny } from './utils/parameterize';
 import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
 import { parseEventHintOrCaptureContext } from './utils/prepareEvent';
 
@@ -436,7 +436,7 @@ export const _experiment_log = {
    * Sentry._experiment_log.fmt`This is a log statement with ${x} and ${y} params`
    * ```
    */
-  fmt: parameterize,
+  fmt: parameterizeAny<string | number | null | object>,
 
   /**
    * A flexible utility to record a log with a custom level and send it to sentry.

packages/core/src/index.ts

@@ -67,7 +67,8 @@ export { hasTracingEnabled } from './utils/hasSpansEnabled';
 export { hasSpansEnabled } from './utils/hasSpansEnabled';
 export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
 export { handleCallbackErrors } from './utils/handleCallbackErrors';
-export { parameterize } from './utils/parameterize';
+export {  parameterize } from './utils/parameterize';
+
 export { addAutoIpAddressToSession, addAutoIpAddressToUser } from './utils/ipAddress';
 export {
   convertSpanLinksForEnvelope,

packages/core/src/types-hoist/index.ts

@@ -153,7 +153,7 @@ export type {
 
 export type { BrowserClientReplayOptions, BrowserClientProfilingOptions } from './browseroptions';
 export type { CheckIn, MonitorConfig, FinishedCheckIn, InProgressCheckIn, SerializedCheckIn } from './checkin';
-export type { ParameterizedString } from './parameterize';
+export type { ParameterizedString, ParameterizedAnyValueString } from './parameterize';
 export type { ContinuousProfiler, ProfilingIntegration, Profiler } from './profiling';
 export type { ViewHierarchyData, ViewHierarchyWindow } from './view-hierarchy';
 export type { LegacyCSPReport } from './csp';

packages/core/src/types-hoist/parameterize.ts

@@ -1,4 +1,6 @@
-export type ParameterizedString = string & {
+export type ParameterizedAnyValueString<T> = string & {
   __sentry_template_string__?: string;
-  __sentry_template_values__?: string[];
+  __sentry_template_values__?: T[];
 };
+
+export type ParameterizedString = ParameterizedAnyValueString<string>;

packages/core/src/utils/parameterize.ts

@@ -1,4 +1,4 @@
-import type { ParameterizedString } from '../types-hoist';
+import type { ParameterizedAnyValueString } from '../types-hoist';
 
 /**
  * Tagged template function which returns parameterized representation of the message
@@ -8,9 +8,21 @@ import type { ParameterizedString } from '../types-hoist';
  * @param strings An array of string values splitted between expressions
  * @param values Expressions extracted from template string
  * @returns String with template information in __sentry_template_string__ and __sentry_template_values__ properties
+ * @deprecated Use parameterizeAny instead
  */
-export function parameterize(strings: TemplateStringsArray, ...values: string[]): ParameterizedString {
-  const formatted = new String(String.raw(strings, ...values)) as ParameterizedString;
+export const parameterize = parameterizeAny<string>;
+
+/**
+ * Tagged template function which returns parameterized representation of the message
+ * For example: parameterize`This is a log statement with ${x} and ${y} params`, would return:
+ * "__sentry_template_string__": 'This is a log statement with %s and %s params',
+ * "__sentry_template_values__": ['first', 'second']
+ * @param strings An array of string values splitted between expressions
+ * @param values Expressions extracted from template string, types provided by the generic.
+ * @returns String with template information in __sentry_template_string__ and __sentry_template_values__ properties
+ */
+export function parameterizeAny<T>(strings: TemplateStringsArray, ...values: T[]): ParameterizedAnyValueString<T> {
+  const formatted = new String(String.raw(strings, ...values)) as ParameterizedAnyValueString<T>;
   formatted.__sentry_template_string__ = strings.join('\x00').replace(/%/g, '%%').replace(/\0/g, '%s');
   formatted.__sentry_template_values__ = values;
   return formatted;