@gooddata/util 10.38.0 → 10.39.0-alpha.2

package/esm/index.d.ts

@@ -7,10 +7,10 @@
  * @packageDocumentation
  */
 import * as stringUtils from "./stringUtils.js";
-import * as testUtils from "./testUtils.js";
 import * as translationUtils from "./translationUtils.js";
 import * as arrayUtils from "./arrayUtils.js";
 import * as objectUtils from "./objectUtils.js";
 import * as typesUtils from "./typesUtils.js";
-export { stringUtils, testUtils, translationUtils, arrayUtils, objectUtils, typesUtils };
+export * from "./testUtils.js";
+export { stringUtils, translationUtils, arrayUtils, objectUtils, typesUtils };
 //# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AAEH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAE9C,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,gBAAgB,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AAEH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAE9C,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC"}

package/esm/index.js

@@ -1,4 +1,4 @@
-// (C) 2019-2023 GoodData Corporation
+// (C) 2019-2025 GoodData Corporation
 /**
  * This package contains utility functions used in production or test code of multiple different GoodData.UI packages.
  *
@@ -8,10 +8,10 @@
  * @packageDocumentation
  */
 import * as stringUtils from "./stringUtils.js";
-import * as testUtils from "./testUtils.js";
 import * as translationUtils from "./translationUtils.js";
 import * as arrayUtils from "./arrayUtils.js";
 import * as objectUtils from "./objectUtils.js";
 import * as typesUtils from "./typesUtils.js";
-export { stringUtils, testUtils, translationUtils, arrayUtils, objectUtils, typesUtils };
+export * from "./testUtils.js";
+export { stringUtils, translationUtils, arrayUtils, objectUtils, typesUtils };
 //# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qCAAqC;AAErC;;;;;;;GAOG;AAEH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAE9C,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,gBAAgB,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qCAAqC;AAErC;;;;;;;GAOG;AAEH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAC;AAE9C,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC"}

package/esm/testUtils.d.ts

@@ -5,4 +5,59 @@
  * @internal
  */
 export declare function delay(timeout?: number): Promise<void>;
+/**
+ * A matcher for suppressConsole
+ *
+ * @internal
+ */
+export type Matcher = {
+    type: "regex";
+    value: RegExp;
+} | {
+    type: "includes" | "exact" | "startsWith";
+    value: string;
+};
+/**
+ * A type of console to suppress
+ *
+ * @internal
+ */
+export type ConsoleType = "error" | "warn" | "log" | "debug" | "info";
+/**
+ * A specific matcher function
+ *
+ * @internal
+ */
+export type SpecificMatcherFunction = (message: string) => boolean;
+/**
+ * A matcher function
+ *
+ * @internal
+ */
+export type MatcherFunction = (console: Record<ConsoleType, ConsoleFunction>, type: ConsoleType, message: string) => boolean;
+/**
+ * A console function, like log, warn or error
+ *
+ * @internal
+ */
+export type ConsoleFunction = (...data: any[]) => void;
+/**
+ * Suppresses certain console outputs
+ *
+ * @param fn - function which emits console activity
+ * @param type - type of console activity to suppress, or an array of types
+ * @param matchers - an array of matchers to test console activity against, or a SpecificMatcherFunction
+ * @returns T | Promise<T> - return value of fn param
+ * @internal
+ */
+export declare function suppressConsole<T>(fn: () => T | Promise<T>, type?: ConsoleType | ConsoleType[], matchers?: Matcher[] | SpecificMatcherFunction): T | Promise<T>;
+/**
+ * Suppresses certain console outputs
+ *
+ * @param fn - function which emits console activity
+ * @param matcherFn - a MatcherFunction
+ * @returns T | Promise<T> - return value of fn param
+ * @internal
+ */
+export declare function suppressConsole<T>(fn: () => T | Promise<T>, matcherFn: MatcherFunction): T | Promise<T>;
 //# sourceMappingURL=testUtils.d.ts.map

package/esm/testUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testUtils.d.ts","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,OAAO,SAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAMhD"}
+{"version":3,"file":"testUtils.d.ts","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,OAAO,SAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAMhD;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,GACb;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,UAAU,GAAG,OAAO,GAAG,YAAY,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;AAEtE;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,CAC1B,OAAO,EAAE,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,EAC7C,IAAI,EAAE,WAAW,EACjB,OAAO,EAAE,MAAM,KACd,OAAO,CAAC;AAEb;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;AA8CvD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAC7B,EAAE,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACxB,IAAI,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,EAClC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,uBAAuB,GAC/C,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAElB;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,eAAe,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC"}

package/esm/testUtils.js

@@ -1,4 +1,5 @@
-// (C) 2007-2020 GoodData Corporation
+// (C) 2007-2025 GoodData Corporation
+/* eslint-disable no-console */
 /**
  * Returns a promise which will resolve after the provided number of milliseconds.
  *
@@ -12,4 +13,79 @@ export function delay(timeout = 0) {
         }, timeout);
     });
 }
+function suppressConsoleBase(fn, matcherFn) {
+    const types = ["error", "warn", "log", "debug", "info"];
+    const originals = {};
+    for (const type of types) {
+        originals[type] = console[type];
+        console[type] = (...data) => {
+            const message = data
+                .map((part) => {
+                if (typeof part === "object") {
+                    try {
+                        return JSON.stringify(part);
+                    }
+                    catch {
+                        return "[object with circular reference]";
+                    }
+                }
+                return part;
+            })
+                .join(" ");
+            if (matcherFn(originals, type, message))
+                return;
+            originals[type].apply(console, data);
+        };
+    }
+    const result = fn();
+    if (result instanceof Promise) {
+        return result.finally(() => {
+            for (const type of types) {
+                // restore the console to previous state
+                console[type] = originals[type];
+            }
+        });
+    }
+    else {
+        for (const type of types) {
+            // restore the console to previous state
+            console[type] = originals[type];
+        }
+        return result;
+    }
+}
+export function suppressConsole(fn, type = ["error", "warn", "log", "debug", "info"], matchers) {
+    if (typeof type === "function")
+        return suppressConsoleBase(fn, type); // simple, user handles all
+    // this scenario is managed by us slightly more
+    // handle the case where they pass a single type
+    const typeArray = typeof type === "string" ? [type] : type;
+    return suppressConsoleBase(fn, (console, type, message) => {
+        if (!typeArray.includes(type))
+            return false;
+        if (typeof matchers === "function") {
+            if (matchers(message))
+                return true;
+        }
+        else if (matchers) {
+            for (const matcher of matchers) {
+                if (matcher.type === "regex" && matcher.value.test(message))
+                    return true;
+                if (matcher.type === "includes" && message.includes(matcher.value))
+                    return true;
+                if (matcher.type === "exact" && message === matcher.value)
+                    return true;
+                if (matcher.type === "startsWith" && message.startsWith(matcher.value))
+                    return true;
+            }
+        }
+        else {
+            // (shown locally, not on CI), devs should use matchers
+            console.log(`Wildcard matched (${type}): ${message}`);
+            return true;
+        }
+        console.error(`Passthrough (${type}): ${message}`);
+        return false;
+    });
+}
 //# sourceMappingURL=testUtils.js.map

package/esm/testUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"testUtils.js","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAAA,qCAAqC;AAErC;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAC,OAAO,GAAG,CAAC;IAC7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,UAAU,CAAC,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;QACd,CAAC,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;AACP,CAAC"}
+{"version":3,"file":"testUtils.js","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAAA,qCAAqC;AACrC,+BAA+B;AAE/B;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAC,OAAO,GAAG,CAAC;IAC7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,UAAU,CAAC,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;QACd,CAAC,EAAE,OAAO,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;AACP,CAAC;AA2CD,SAAS,mBAAmB,CAAI,EAAwB,EAAE,SAA0B;IAChF,MAAM,KAAK,GAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAEvE,MAAM,SAAS,GAAoC,EAAE,CAAC;IAEtD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,SAAS,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE;YAC/B,MAAM,OAAO,GAAG,IAAI;iBACf,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACV,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC3B,IAAI,CAAC;wBACD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;oBAChC,CAAC;oBAAC,MAAM,CAAC;wBACL,OAAO,kCAAkC,CAAC;oBAC9C,CAAC;gBACL,CAAC;gBACD,OAAO,IAAI,CAAC;YAChB,CAAC,CAAC;iBACD,IAAI,CAAC,GAAG,CAAC,CAAC;YAEf,IAAI,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC;gBAAE,OAAO;YAEhD,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACzC,CAAC,CAAC;IACN,CAAC;IAED,MAAM,MAAM,GAAG,EAAE,EAAE,CAAC;IACpB,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;QAC5B,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE;YACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,wCAAwC;gBACxC,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;YACpC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;SAAM,CAAC;QACJ,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,wCAAwC;YACxC,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;AACL,CAAC;AA2BD,MAAM,UAAU,eAAe,CAC3B,EAAwB,EACxB,OAAsD,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAC/F,QAA8C;IAE9C,IAAI,OAAO,IAAI,KAAK,UAAU;QAAE,OAAO,mBAAmB,CAAI,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,2BAA2B;IAEpG,+CAA+C;IAE/C,gDAAgD;IAChD,MAAM,SAAS,GAAkB,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAE1E,OAAO,mBAAmB,CACtB,EAAE,EACF,CAAC,OAA6C,EAAE,IAAiB,EAAE,OAAe,EAAW,EAAE;QAC3F,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QAE5C,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACjC,IAAI,QAAQ,CAAC,OAAO,CAAC;gBAAE,OAAO,IAAI,CAAC;QACvC,CAAC;aAAM,IAAI,QAAQ,EAAE,CAAC;YAClB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAC7B,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;oBAAE,OAAO,IAAI,CAAC;gBACzE,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC;oBAAE,OAAO,IAAI,CAAC;gBAChF,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,IAAI,OAAO,KAAK,OAAO,CAAC,KAAK;oBAAE,OAAO,IAAI,CAAC;gBACvE,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC;oBAAE,OAAO,IAAI,CAAC;YACxF,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,uDAAuD;YACvD,OAAO,CAAC,GAAG,CAAC,qBAAqB,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,OAAO,CAAC,KAAK,CAAC,gBAAgB,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC;QAEnD,OAAO,KAAK,CAAC;IACjB,CAAC,CACJ,CAAC;AACN,CAAC"}

package/esm/util.d.ts

@@ -22,13 +22,27 @@ export { arrayUtils }
  */
 declare function combineGuards<T extends ((x: unknown) => x is unknown)[]>(...guards: T): (x: unknown) => x is GuardType<T[number]>;
 
+/**
+ * A console function, like log, warn or error
+ *
+ * @internal
+ */
+export declare type ConsoleFunction = (...data: any[]) => void;
+
+/**
+ * A type of console to suppress
+ *
+ * @internal
+ */
+export declare type ConsoleType = "error" | "warn" | "log" | "debug" | "info";
+
 /**
  * Returns a promise which will resolve after the provided number of milliseconds.
  *
  * @param timeout - resolve timeout in milliseconds
  * @internal
  */
-declare function delay(timeout?: number): Promise<void>;
+export declare function delay(timeout?: number): Promise<void>;
 
 /**
  * Escapes special characters used in regular expressions.
@@ -68,6 +82,26 @@ declare interface IShortenTextOptions {
     maxLength?: number;
 }
 
+/**
+ * A matcher for suppressConsole
+ *
+ * @internal
+ */
+export declare type Matcher = {
+    type: "regex";
+    value: RegExp;
+} | {
+    type: "includes" | "exact" | "startsWith";
+    value: string;
+};
+
+/**
+ * A matcher function
+ *
+ * @internal
+ */
+export declare type MatcherFunction = (console: Record<ConsoleType, ConsoleFunction>, type: ConsoleType, message: string) => boolean;
+
 declare namespace objectUtils {
     export {
         shallowEqualObjects
@@ -147,6 +181,13 @@ declare function shortenText(value: string, options?: IShortenTextOptions): stri
  */
 declare function simplifyText(value: string | number | null): string;
 
+/**
+ * A specific matcher function
+ *
+ * @internal
+ */
+export declare type SpecificMatcherFunction = (message: string) => boolean;
+
 declare namespace stringUtils {
     export {
         shortenText,
@@ -160,12 +201,26 @@ declare namespace stringUtils {
 }
 export { stringUtils }
 
-declare namespace testUtils {
-    export {
-        delay
-    }
-}
-export { testUtils }
+/**
+ * Suppresses certain console outputs
+ *
+ * @param fn - function which emits console activity
+ * @param type - type of console activity to suppress, or an array of types
+ * @param matchers - an array of matchers to test console activity against, or a SpecificMatcherFunction
+ * @returns T | Promise<T> - return value of fn param
+ * @internal
+ */
+export declare function suppressConsole<T>(fn: () => T | Promise<T>, type?: ConsoleType | ConsoleType[], matchers?: Matcher[] | SpecificMatcherFunction): T | Promise<T>;
+
+/**
+ * Suppresses certain console outputs
+ *
+ * @param fn - function which emits console activity
+ * @param matcherFn - a MatcherFunction
+ * @returns T | Promise<T> - return value of fn param
+ * @internal
+ */
+export declare function suppressConsole<T>(fn: () => T | Promise<T>, matcherFn: MatcherFunction): T | Promise<T>;
 
 declare namespace translationUtils {
     export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/util",
-  "version": "10.38.0",
+  "version": "10.39.0-alpha.2",
   "author": "GoodData",
   "description": "GoodData Utility Functions",
   "repository": {