@red-hat-developer-hub/plugin-cost-management-common 2.0.1

package/dist/types/RecommendationList.model.d-J74WXrJI.d.ts

@@ -0,0 +1,414 @@
+/** @public */
+interface CostRecommendationConfigLimitsCpu {
+    amount?: number;
+    format?: string | null;
+}
+
+/** @public */
+interface CostRecommendationConfigLimitsMemory {
+    amount?: number;
+    format?: string;
+}
+
+/** @public */
+interface CostRecommendationConfigLimits {
+    cpu?: CostRecommendationConfigLimitsCpu;
+    memory?: CostRecommendationConfigLimitsMemory;
+}
+
+/** @public */
+interface CostRecommendationConfigRequestsCpu {
+    amount?: number;
+    format?: string | null;
+}
+
+/** @public */
+interface CostRecommendationConfigRequestsMemory {
+    amount?: number;
+    format?: string;
+}
+
+/** @public */
+interface CostRecommendationConfigRequests {
+    cpu?: CostRecommendationConfigRequestsCpu;
+    memory?: CostRecommendationConfigRequestsMemory;
+}
+
+/** @public */
+interface CostRecommendationConfig {
+    limits?: CostRecommendationConfigLimits;
+    requests?: CostRecommendationConfigRequests;
+}
+
+/** @public */
+interface CPULimitOptimisedNotification323005 {
+    code?: number;
+    message?: string;
+    type?: string;
+}
+
+/** @public */
+interface CPURequestOptimisedNotification323004 {
+    code?: number;
+    message?: string;
+    type?: string;
+}
+
+/** @public */
+interface MemoryLimitOptimisedNotification324004 {
+    code?: number;
+    message?: string;
+    type?: string;
+}
+
+/** @public */
+interface MemoryRequestOptimisedNotification324003 {
+    code?: number;
+    message?: string;
+    type?: string;
+}
+
+/** @public */
+interface CostRecommendationNotifications {
+    _323004?: CPURequestOptimisedNotification323004;
+    _323005?: CPULimitOptimisedNotification323005;
+    _324003?: MemoryRequestOptimisedNotification324003;
+    _324004?: MemoryLimitOptimisedNotification324004;
+}
+
+/** @public */
+interface CostRecommendationVariationLimitsCpu {
+    amount?: number;
+    format?: string | null;
+}
+
+/** @public */
+interface CostRecommendationVariationLimitsMemory {
+    amount?: number;
+    format?: string;
+}
+
+/** @public */
+interface CostRecommendationVariationLimits {
+    cpu?: CostRecommendationVariationLimitsCpu;
+    memory?: CostRecommendationVariationLimitsMemory;
+}
+
+/** @public */
+interface CostRecommendationVariationRequestsCpu {
+    amount?: number;
+    format?: string | null;
+}
+
+/** @public */
+interface CostRecommendationVariationRequestsMemory {
+    amount?: number;
+    format?: string;
+}
+
+/** @public */
+interface CostRecommendationVariationRequests {
+    cpu?: CostRecommendationVariationRequestsCpu;
+    memory?: CostRecommendationVariationRequestsMemory;
+}
+
+/** @public */
+interface CostRecommendationVariation {
+    limits?: CostRecommendationVariationLimits;
+    requests?: CostRecommendationVariationRequests;
+}
+
+/** @public */
+interface CostRecommendation {
+    config?: CostRecommendationConfig;
+    notifications?: CostRecommendationNotifications;
+    podsCount?: number;
+    variation?: CostRecommendationVariation;
+}
+
+/** @public */
+interface PerformanceRecommendationConfigLimitsCpu {
+    amount?: number;
+    format?: string | null;
+}
+
+/** @public */
+interface PerformanceRecommendationConfigLimitsMemory {
+    amount?: number;
+    format?: string;
+}
+
+/** @public */
+interface PerformanceRecommendationConfigLimits {
+    cpu?: PerformanceRecommendationConfigLimitsCpu;
+    memory?: PerformanceRecommendationConfigLimitsMemory;
+}
+
+/** @public */
+interface PerformanceRecommendationConfigRequestsCpu {
+    amount?: number;
+    format?: string | null;
+}
+
+/** @public */
+interface PerformanceRecommendationConfigRequestsMemory {
+    amount?: number;
+    format?: string;
+}
+
+/** @public */
+interface PerformanceRecommendationConfigRequests {
+    cpu?: PerformanceRecommendationConfigRequestsCpu;
+    memory?: PerformanceRecommendationConfigRequestsMemory;
+}
+
+/** @public */
+interface PerformanceRecommendationConfig {
+    limits?: PerformanceRecommendationConfigLimits;
+    requests?: PerformanceRecommendationConfigRequests;
+}
+
+/** @public */
+interface PerformanceRecommendationVariationLimitsCpu {
+    amount?: number;
+    format?: string | null;
+}
+
+/** @public */
+interface PerformanceRecommendationVariationLimitsMemory {
+    amount?: number;
+    format?: string;
+}
+
+/** @public */
+interface PerformanceRecommendationVariationLimits {
+    cpu?: PerformanceRecommendationVariationLimitsCpu;
+    memory?: PerformanceRecommendationVariationLimitsMemory;
+}
+
+/** @public */
+interface PerformanceRecommendationVariationRequestsCpu {
+    amount?: number;
+    format?: string | null;
+}
+
+/** @public */
+interface PerformanceRecommendationVariationRequests {
+    cpu?: PerformanceRecommendationVariationRequestsCpu;
+    memory?: CostRecommendationVariationLimitsMemory;
+}
+
+/** @public */
+interface PerformanceRecommendationVariation {
+    limits?: PerformanceRecommendationVariationLimits;
+    requests?: PerformanceRecommendationVariationRequests;
+}
+
+/** @public */
+interface PerformanceRecommendation {
+    config?: PerformanceRecommendationConfig;
+    notifications?: CostRecommendationNotifications;
+    podsCount?: number;
+    variation?: PerformanceRecommendationVariation;
+}
+
+/** @public */
+interface LongTermRecommendationRecommendationEngines {
+    cost?: CostRecommendation;
+    performance?: PerformanceRecommendation;
+}
+
+/** @public */
+interface CpuUsage {
+    format?: string;
+    max?: number;
+    median?: number;
+    min?: number;
+    q1?: number;
+    q3?: number;
+}
+
+/** @public */
+interface MemoryUsage {
+    format?: string;
+    max?: number;
+    median?: number;
+    min?: number;
+    q1?: number;
+    q3?: number;
+}
+
+/** @public */
+interface PlotDetailsValue {
+    cpuUsage?: CpuUsage;
+    memoryUsage?: MemoryUsage;
+}
+
+/** @public */
+interface PlotsData {
+    datapoints?: number;
+    plotsData?: {
+        [key: string]: PlotDetailsValue;
+    };
+}
+
+/** @public */
+interface LongTermRecommendationBoxPlots {
+    durationInHours?: number;
+    monitoringStartTime?: Date;
+    plots?: PlotsData;
+    recommendationEngines?: LongTermRecommendationRecommendationEngines;
+}
+
+/** @public */
+interface MediumTermRecommendationBoxPlots {
+    durationInHours?: number;
+    monitoringStartTime?: Date;
+    plots?: PlotsData;
+    recommendationEngines?: LongTermRecommendationRecommendationEngines;
+}
+
+/** @public */
+interface ShortTermRecommendationBoxPlots {
+    durationInHours?: number;
+    monitoringStartTime?: Date;
+    plots?: PlotsData;
+    recommendationEngines?: LongTermRecommendationRecommendationEngines;
+}
+
+/** @public */
+interface RecommendationBoxPlotsRecommendationsRecommendationTerms {
+    longTerm?: LongTermRecommendationBoxPlots;
+    mediumTerm?: MediumTermRecommendationBoxPlots;
+    shortTerm?: ShortTermRecommendationBoxPlots;
+}
+
+/** @public */
+interface RecommendationsRecommendationsCurrentLimitsCpu {
+    amount?: number;
+    format?: string | null;
+}
+
+/** @public */
+interface RecommendationsRecommendationsCurrentLimitsMemory {
+    amount?: number;
+    format?: string;
+}
+
+/** @public */
+interface RecommendationsRecommendationsCurrentLimits {
+    cpu?: RecommendationsRecommendationsCurrentLimitsCpu;
+    memory?: RecommendationsRecommendationsCurrentLimitsMemory;
+}
+
+/** @public */
+interface RecommendationsRecommendationsCurrentRequestsMemory {
+    amount?: number;
+    format?: string;
+}
+
+/** @public */
+interface RecommendationsRecommendationsCurrentRequests {
+    cpu?: RecommendationsRecommendationsCurrentLimitsCpu;
+    memory?: RecommendationsRecommendationsCurrentRequestsMemory;
+}
+
+/** @public */
+interface RecommendationsRecommendationsCurrent {
+    limits?: RecommendationsRecommendationsCurrentLimits;
+    requests?: RecommendationsRecommendationsCurrentRequests;
+}
+
+/** @public */
+interface RecommendationBoxPlotsRecommendations {
+    current?: RecommendationsRecommendationsCurrent;
+    monitoringEndTime?: Date;
+    recommendationTerms?: RecommendationBoxPlotsRecommendationsRecommendationTerms;
+}
+
+/** @public */
+interface RecommendationBoxPlots {
+    clusterAlias?: string;
+    clusterUuid?: string;
+    container?: string;
+    id?: string;
+    lastReported?: Date;
+    project?: string;
+    recommendations?: RecommendationBoxPlotsRecommendations;
+    sourceId?: string;
+    workload?: string;
+    workloadType?: string;
+}
+
+/** @public */
+interface RecommendationListLinks {
+    first?: string;
+    previous?: string;
+    next?: string;
+    last?: string;
+}
+
+/** @public */
+interface RecommendationListMeta {
+    count?: number;
+    limit?: number;
+    offset?: number;
+}
+
+/** @public */
+interface LongTermRecommendation {
+    durationInHours?: number;
+    monitoringStartTime?: Date;
+    recommendationEngines?: LongTermRecommendationRecommendationEngines;
+}
+
+/** @public */
+interface MediumTermRecommendation {
+    durationInHours?: number;
+    monitoringStartTime?: Date;
+    recommendationEngines?: LongTermRecommendationRecommendationEngines;
+}
+
+/** @public */
+interface ShortTermRecommendation {
+    durationInHours?: number;
+    monitoringStartTime?: Date;
+    recommendationEngines?: LongTermRecommendationRecommendationEngines;
+}
+
+/** @public */
+interface RecommendationsRecommendationsRecommendationTerms {
+    longTerm?: LongTermRecommendation;
+    mediumTerm?: MediumTermRecommendation;
+    shortTerm?: ShortTermRecommendation;
+}
+
+/** @public */
+interface RecommendationsRecommendations {
+    current?: RecommendationsRecommendationsCurrent;
+    monitoringEndTime?: Date;
+    recommendationTerms?: RecommendationsRecommendationsRecommendationTerms;
+}
+
+/** @public */
+interface Recommendations {
+    clusterAlias?: string;
+    clusterUuid?: string;
+    container?: string;
+    id?: string;
+    lastReported?: Date;
+    project?: string;
+    recommendations?: RecommendationsRecommendations;
+    sourceId?: string;
+    workload?: string;
+    workloadType?: string;
+}
+
+/** @public */
+interface RecommendationList {
+    data?: Array<Recommendations>;
+    meta?: RecommendationListMeta;
+    links?: RecommendationListLinks;
+}
+
+export type { RecommendationsRecommendationsCurrentLimitsCpu as $, PerformanceRecommendationConfigLimitsCpu as A, PerformanceRecommendationConfigLimitsMemory as B, CPULimitOptimisedNotification323005 as C, PerformanceRecommendationConfigRequests as D, PerformanceRecommendationConfigRequestsCpu as E, PerformanceRecommendationConfigRequestsMemory as F, PerformanceRecommendationVariation as G, PerformanceRecommendationVariationLimits as H, PerformanceRecommendationVariationLimitsCpu as I, PerformanceRecommendationVariationLimitsMemory as J, PerformanceRecommendationVariationRequests as K, LongTermRecommendation as L, MediumTermRecommendation as M, PerformanceRecommendationVariationRequestsCpu as N, PlotDetailsValue as O, PerformanceRecommendation as P, PlotsData as Q, RecommendationBoxPlots as R, RecommendationBoxPlotsRecommendations as S, RecommendationBoxPlotsRecommendationsRecommendationTerms as T, RecommendationList as U, RecommendationListLinks as V, RecommendationListMeta as W, Recommendations as X, RecommendationsRecommendations as Y, RecommendationsRecommendationsCurrent as Z, RecommendationsRecommendationsCurrentLimits as _, CPURequestOptimisedNotification323004 as a, RecommendationsRecommendationsCurrentLimitsMemory as a0, RecommendationsRecommendationsCurrentRequests as a1, RecommendationsRecommendationsCurrentRequestsMemory as a2, RecommendationsRecommendationsRecommendationTerms as a3, ShortTermRecommendation as a4, ShortTermRecommendationBoxPlots as a5, CostRecommendation as b, CostRecommendationConfig as c, CostRecommendationConfigLimits as d, CostRecommendationConfigLimitsCpu as e, CostRecommendationConfigLimitsMemory as f, CostRecommendationConfigRequests as g, CostRecommendationConfigRequestsCpu as h, CostRecommendationConfigRequestsMemory as i, CostRecommendationNotifications as j, CostRecommendationVariation as k, CostRecommendationVariationLimits as l, CostRecommendationVariationLimitsCpu as m, CostRecommendationVariationLimitsMemory as n, CostRecommendationVariationRequests as o, CostRecommendationVariationRequestsCpu as p, CostRecommendationVariationRequestsMemory as q, CpuUsage as r, LongTermRecommendationBoxPlots as s, LongTermRecommendationRecommendationEngines as t, MediumTermRecommendationBoxPlots as u, MemoryLimitOptimisedNotification324004 as v, MemoryRequestOptimisedNotification324003 as w, MemoryUsage as x, PerformanceRecommendationConfig as y, PerformanceRecommendationConfigLimits as z };

package/dist/util/lib/json.cjs.js

@@ -0,0 +1,20 @@
+'use strict';
+
+function isJsonScalar(value) {
+  return typeof value === "number" || typeof value === "string" || typeof value === "boolean" || value === null;
+}
+function maybeJsonObject(value) {
+  return value?.constructor.name === "Object";
+}
+function maybeJsonArray(value) {
+  return Array.isArray(value);
+}
+function maybeJsonValue(value) {
+  return typeof value !== "undefined" && (isJsonScalar(value) || maybeJsonObject(value) || maybeJsonArray(value));
+}
+
+exports.isJsonScalar = isJsonScalar;
+exports.maybeJsonArray = maybeJsonArray;
+exports.maybeJsonObject = maybeJsonObject;
+exports.maybeJsonValue = maybeJsonValue;
+//# sourceMappingURL=json.cjs.js.map

package/dist/util/lib/json.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.cjs.js","sources":["../../../src/util/lib/json.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport type JsonScalar = number | string | boolean | null;\n\n/** Asserts `value` is a JsonScalar */\nexport function isJsonScalar(value: unknown): value is JsonScalar {\n  return (\n    typeof value === 'number' ||\n    typeof value === 'string' ||\n    typeof value === 'boolean' ||\n    value === null\n  );\n}\n\n/** A type representing a JSON object */\nexport type JsonObject = {\n  [key in string]?: JsonValue;\n};\n\n/** Asserts non-recursively that `value` may be a JsonObject */\nexport function maybeJsonObject(value: unknown): value is JsonObject {\n  return value?.constructor.name === 'Object';\n}\n\n/** A type representing JSON array */\nexport type JsonArray = Array<JsonValue>;\n\n/** Asserts non-recursively that `value` may be a JsonArray */\nexport function maybeJsonArray(value: unknown): value is JsonArray {\n  return Array.isArray(value);\n}\n\n/** A type representing all valid JSON serializable values. */\nexport type JsonValue = JsonObject | JsonArray | JsonScalar;\n\n/** Asserts that `value` may be a JsonValue */\nexport function maybeJsonValue(value: unknown): value is JsonValue {\n  return (\n    typeof value !== 'undefined' &&\n    (isJsonScalar(value) || maybeJsonObject(value) || maybeJsonArray(value))\n  );\n}\n"],"names":[],"mappings":";;AAmBO,SAAS,aAAa,KAAqC,EAAA;AAChE,EACE,OAAA,OAAO,UAAU,QACjB,IAAA,OAAO,UAAU,QACjB,IAAA,OAAO,KAAU,KAAA,SAAA,IACjB,KAAU,KAAA,IAAA;AAEd;AAQO,SAAS,gBAAgB,KAAqC,EAAA;AACnE,EAAO,OAAA,KAAA,EAAO,YAAY,IAAS,KAAA,QAAA;AACrC;AAMO,SAAS,eAAe,KAAoC,EAAA;AACjE,EAAO,OAAA,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5B;AAMO,SAAS,eAAe,KAAoC,EAAA;AACjE,EACE,OAAA,OAAO,KAAU,KAAA,WAAA,KAChB,YAAa,CAAA,KAAK,KAAK,eAAgB,CAAA,KAAK,CAAK,IAAA,cAAA,CAAe,KAAK,CAAA,CAAA;AAE1E;;;;;;;"}

package/dist/util/lib/json.esm.js

@@ -0,0 +1,15 @@
+function isJsonScalar(value) {
+  return typeof value === "number" || typeof value === "string" || typeof value === "boolean" || value === null;
+}
+function maybeJsonObject(value) {
+  return value?.constructor.name === "Object";
+}
+function maybeJsonArray(value) {
+  return Array.isArray(value);
+}
+function maybeJsonValue(value) {
+  return typeof value !== "undefined" && (isJsonScalar(value) || maybeJsonObject(value) || maybeJsonArray(value));
+}
+
+export { isJsonScalar, maybeJsonArray, maybeJsonObject, maybeJsonValue };
+//# sourceMappingURL=json.esm.js.map

package/dist/util/lib/json.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.esm.js","sources":["../../../src/util/lib/json.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport type JsonScalar = number | string | boolean | null;\n\n/** Asserts `value` is a JsonScalar */\nexport function isJsonScalar(value: unknown): value is JsonScalar {\n  return (\n    typeof value === 'number' ||\n    typeof value === 'string' ||\n    typeof value === 'boolean' ||\n    value === null\n  );\n}\n\n/** A type representing a JSON object */\nexport type JsonObject = {\n  [key in string]?: JsonValue;\n};\n\n/** Asserts non-recursively that `value` may be a JsonObject */\nexport function maybeJsonObject(value: unknown): value is JsonObject {\n  return value?.constructor.name === 'Object';\n}\n\n/** A type representing JSON array */\nexport type JsonArray = Array<JsonValue>;\n\n/** Asserts non-recursively that `value` may be a JsonArray */\nexport function maybeJsonArray(value: unknown): value is JsonArray {\n  return Array.isArray(value);\n}\n\n/** A type representing all valid JSON serializable values. */\nexport type JsonValue = JsonObject | JsonArray | JsonScalar;\n\n/** Asserts that `value` may be a JsonValue */\nexport function maybeJsonValue(value: unknown): value is JsonValue {\n  return (\n    typeof value !== 'undefined' &&\n    (isJsonScalar(value) || maybeJsonObject(value) || maybeJsonArray(value))\n  );\n}\n"],"names":[],"mappings":"AAmBO,SAAS,aAAa,KAAqC,EAAA;AAChE,EACE,OAAA,OAAO,UAAU,QACjB,IAAA,OAAO,UAAU,QACjB,IAAA,OAAO,KAAU,KAAA,SAAA,IACjB,KAAU,KAAA,IAAA;AAEd;AAQO,SAAS,gBAAgB,KAAqC,EAAA;AACnE,EAAO,OAAA,KAAA,EAAO,YAAY,IAAS,KAAA,QAAA;AACrC;AAMO,SAAS,eAAe,KAAoC,EAAA;AACjE,EAAO,OAAA,KAAA,CAAM,QAAQ,KAAK,CAAA;AAC5B;AAMO,SAAS,eAAe,KAAoC,EAAA;AACjE,EACE,OAAA,OAAO,KAAU,KAAA,WAAA,KAChB,YAAa,CAAA,KAAK,KAAK,eAAgB,CAAA,KAAK,CAAK,IAAA,cAAA,CAAe,KAAK,CAAA,CAAA;AAE1E;;;;"}

package/dist/util/lib/json_node.cjs.js

@@ -0,0 +1,191 @@
+'use strict';
+
+var json = require('./json.cjs.js');
+
+const refs = /* @__PURE__ */ new Set();
+function detectCircularReference(nodeValue) {
+  if (refs.has(nodeValue)) {
+    throw new TypeError("Converting circular structure");
+  } else {
+    refs.add(nodeValue);
+  }
+}
+class Visitor {
+  #onVisitObjectKey;
+  #skipList;
+  #isDebugEnabled;
+  constructor(options) {
+    this.#onVisitObjectKey = options?.onVisitJsonObjectKey;
+    this.#skipList = options?.skipList ?? [];
+    this.#isDebugEnabled = options?.debug ?? false;
+  }
+  visitScalar(node) {
+    if (this.#isDebugEnabled) {
+      console.log(node.jsonpath);
+    }
+  }
+  visitArray(node) {
+    if (this.#isDebugEnabled) {
+      console.log(node.jsonpath);
+    }
+    node.children?.forEach((child) => child.accept(this));
+  }
+  visitObject(node) {
+    if (this.#isDebugEnabled) {
+      console.log(node.jsonpath);
+    }
+    node.children?.forEach((child) => {
+      const newKey = this.#skipList.some((regex) => regex.test(child.jsonpath)) ? child.key : this.#onVisitObjectKey?.(child.key) ?? child.key;
+      child.key = newKey;
+      child.accept(this);
+    });
+  }
+}
+class JsonNode {
+  static Visitor = Visitor;
+  static #toJsonPathSegment(value) {
+    if (typeof value === "number") {
+      return `[${value}]`;
+    }
+    const regex = /(\s|\.)/;
+    return regex.test(value) ? `['${value}']` : `.${value}`;
+  }
+  #parent;
+  #children;
+  #kind;
+  #value;
+  #jsonpath;
+  key;
+  /**
+   * Constructs a new Node instance.
+   *
+   * @param key - The key associated with this node, which can be a string or number.
+   * @param value - The value associated with this node.
+   * @param parent - The parent node of this node, if any.
+   *
+   * @throws {TypeError} If the key is not "$" and the parent node is not provided.
+   */
+  constructor(key, value, parent) {
+    this.key = key;
+    this.#value = value;
+    this.#jsonpath = [];
+    if (key === "$") {
+      this.#parent = null;
+      this.#jsonpath.push(key);
+    } else {
+      if (!parent) {
+        throw new TypeError("Parent node is required");
+      }
+      this.#parent = parent;
+      this.#jsonpath.push(
+        ...this.#parent.jsonpath,
+        `${JsonNode.#toJsonPathSegment(key)}`
+      );
+    }
+    switch (true) {
+      case json.maybeJsonArray(value):
+        detectCircularReference(value);
+        this.#kind = "array";
+        this.#children = value.map(
+          (jsonValue, idx) => new JsonNode(idx, jsonValue, this)
+        );
+        break;
+      case json.maybeJsonObject(value):
+        detectCircularReference(value);
+        this.#kind = "object";
+        this.#children = [];
+        for (const [k, jsonValue] of Object.entries(value)) {
+          if (typeof jsonValue !== "undefined") {
+            this.#children.push(new JsonNode(k, jsonValue, this));
+          }
+        }
+        break;
+      default:
+        this.#kind = "scalar";
+        this.#children = null;
+        break;
+    }
+    if (this.parent === null) {
+      refs.clear();
+    }
+  }
+  get value() {
+    return this.#value;
+  }
+  get kind() {
+    return this.#kind;
+  }
+  get parent() {
+    return this.#parent;
+  }
+  get children() {
+    return this.#children;
+  }
+  /**
+   * Returns the JSONPath expression corresponding to this node's location in the data structure.
+   *
+   * @returns {string} The JSONPath expression.
+   */
+  get jsonpath() {
+    return this.#jsonpath.join("");
+  }
+  /**
+   * Accepts a visitor and calls the appropriate visit method based on the node's kind.
+   *
+   * @param visitor - The visitor instance that will process the node.
+   *
+   * The method will call one of the following visitor methods based on the node's kind:
+   * - `visitScalar` if the node is a scalar.
+   * - `visitArray` if the node is an array.
+   * - `visitObject` if the node is an object.
+   */
+  accept(visitor) {
+    switch (this.#kind) {
+      case "scalar":
+        visitor.visitScalar(this);
+        break;
+      case "array":
+        visitor.visitArray(this);
+        break;
+      case "object":
+        visitor.visitObject(this);
+        break;
+    }
+  }
+  /**
+   * Converts the current instance to a JSON value.
+   *
+   * Depending on the type of the instance (`scalar`, `array`, or `object`),
+   * this method will return the corresponding JSON representation.
+   *
+   * - If the instance is a scalar, it returns the scalar value.
+   * - If the instance is an array, it returns an array of JSON values by
+   *   recursively calling `toJsonValue` on each child.
+   * - If the instance is an object, it returns a JSON object by recursively
+   *   calling `toJsonValue` on each child and using their keys as the object's keys.
+   *
+   * @returns {JsonValue} The JSON representation of the current instance.
+   */
+  toJsonValue() {
+    let obj = {};
+    switch (this.#kind) {
+      case "scalar":
+        obj = this.#value;
+        break;
+      case "array":
+        obj = this.#children.map((child) => child.toJsonValue());
+        break;
+      case "object": {
+        const tmpObj = {};
+        for (const child of this.#children ?? []) {
+          tmpObj[child.key] = child.toJsonValue();
+        }
+        obj = tmpObj;
+      }
+    }
+    return obj;
+  }
+}
+
+exports.JsonNode = JsonNode;
+//# sourceMappingURL=json_node.cjs.js.map

package/dist/util/lib/json_node.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json_node.cjs.js","sources":["../../../src/util/lib/json_node.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/* eslint-disable no-console */\n/* eslint-disable default-case */\n/*\n * Copyright 2025 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  type JsonArray,\n  type JsonObject,\n  type JsonScalar,\n  type JsonValue,\n  maybeJsonArray,\n  maybeJsonObject,\n} from './json';\nimport type { JsonNodeVisitor } from './json_node_visitor';\n\nconst refs = new Set<JsonObject | JsonArray>();\nfunction detectCircularReference(nodeValue: JsonObject | JsonArray): void {\n  if (refs.has(nodeValue)) {\n    throw new TypeError('Converting circular structure');\n  } else {\n    refs.add(nodeValue);\n  }\n}\n\nexport type ObjectKeyMutatorFunction = (key: string | number) => string;\n\n/**\n * Options for configuring the JSON visitor.\n */\nexport interface JsonNodeVisitorOptions {\n  /**\n   * A list of regular expression matching the JSONPath (RFC 9535) of a key in the data structure.\n   * Every time a key is found in the data structure, its JSONPath is tested for a match against the entries in the list.\n   * If at least one match is found, then that key won't be processed by the `JsonNodeVisitorOptions#onVisitJsonObjectKey` callback.\n   */\n  skipList?: Array<RegExp>;\n\n  /**\n   * An optional flag to enable debug mode.\n   * When set to true, each time a node is visited, its JSONPath will be logged.\n   */\n  debug?: boolean;\n\n  /**\n   * A function that can be used to process the object keys names.\n   * The string returned by this function will be used to replace the name of the object key being visited.\n   */\n  onVisitJsonObjectKey?: ObjectKeyMutatorFunction;\n}\n\nclass Visitor implements JsonNodeVisitor {\n  readonly #onVisitObjectKey?: ObjectKeyMutatorFunction;\n  readonly #skipList: Array<RegExp>;\n  readonly #isDebugEnabled: boolean;\n\n  constructor(options?: JsonNodeVisitorOptions) {\n    this.#onVisitObjectKey = options?.onVisitJsonObjectKey;\n    this.#skipList = options?.skipList ?? [];\n    this.#isDebugEnabled = options?.debug ?? false;\n  }\n\n  visitScalar(node: JsonNode<JsonScalar>): void {\n    if (this.#isDebugEnabled) {\n      console.log(node.jsonpath);\n    }\n  }\n\n  visitArray(node: JsonNode<JsonArray>): void {\n    if (this.#isDebugEnabled) {\n      console.log(node.jsonpath);\n    }\n\n    node.children?.forEach(child => child.accept(this));\n  }\n\n  visitObject(node: JsonNode<JsonObject>): void {\n    if (this.#isDebugEnabled) {\n      console.log(node.jsonpath);\n    }\n\n    node.children?.forEach(child => {\n      const newKey = this.#skipList.some(regex => regex.test(child.jsonpath))\n        ? child.key\n        : this.#onVisitObjectKey?.(child.key) ?? child.key;\n      child.key = newKey;\n      child.accept(this);\n    });\n  }\n}\n\n/** Represents a node in a tree structure where each node can be a scalar, array, or object. */\nexport class JsonNode<T extends JsonValue> {\n  static readonly Visitor = Visitor;\n  static #toJsonPathSegment(value: string | number): string {\n    if (typeof value === 'number') {\n      return `[${value}]`;\n    }\n\n    const regex = /(\\s|\\.)/;\n    return regex.test(value) ? `['${value}']` : `.${value}`;\n  }\n\n  readonly #parent: JsonNode<JsonValue> | null;\n  readonly #children: Array<JsonNode<JsonValue>> | null;\n  readonly #kind: 'scalar' | 'array' | 'object';\n  readonly #value: T;\n  readonly #jsonpath: Array<string>;\n  key: string | number;\n\n  /**\n   * Constructs a new Node instance.\n   *\n   * @param key - The key associated with this node, which can be a string or number.\n   * @param value - The value associated with this node.\n   * @param parent - The parent node of this node, if any.\n   *\n   * @throws {TypeError} If the key is not \"$\" and the parent node is not provided.\n   */\n  constructor(key: string | number, value: T, parent?: JsonNode<T>) {\n    this.key = key;\n    this.#value = value;\n    this.#jsonpath = [];\n\n    if (key === '$') {\n      this.#parent = null;\n      this.#jsonpath.push(key);\n    } else {\n      if (!parent) {\n        throw new TypeError('Parent node is required');\n      }\n\n      this.#parent = parent;\n      this.#jsonpath.push(\n        ...this.#parent.jsonpath,\n        `${JsonNode.#toJsonPathSegment(key)}`,\n      );\n    }\n\n    switch (true) {\n      case maybeJsonArray(value):\n        detectCircularReference(value);\n        this.#kind = 'array';\n        this.#children = value.map(\n          (jsonValue, idx) => new JsonNode(idx, jsonValue, this),\n        );\n        break;\n      case maybeJsonObject(value):\n        detectCircularReference(value);\n        this.#kind = 'object';\n        this.#children = [];\n        for (const [k, jsonValue] of Object.entries(value)) {\n          if (typeof jsonValue !== 'undefined') {\n            this.#children.push(new JsonNode(k, jsonValue, this));\n          }\n        }\n        break;\n      default:\n        this.#kind = 'scalar';\n        this.#children = null;\n        break;\n    }\n\n    if (this.parent === null) {\n      refs.clear();\n    }\n  }\n\n  get value(): T {\n    return this.#value;\n  }\n\n  get kind(): 'scalar' | 'array' | 'object' {\n    return this.#kind;\n  }\n\n  get parent(): JsonNode<JsonValue> | null {\n    return this.#parent;\n  }\n\n  get children(): Array<JsonNode<JsonValue>> | null {\n    return this.#children;\n  }\n\n  /**\n   * Returns the JSONPath expression corresponding to this node's location in the data structure.\n   *\n   * @returns {string} The JSONPath expression.\n   */\n  get jsonpath(): string {\n    return this.#jsonpath.join('');\n  }\n\n  /**\n   * Accepts a visitor and calls the appropriate visit method based on the node's kind.\n   *\n   * @param visitor - The visitor instance that will process the node.\n   *\n   * The method will call one of the following visitor methods based on the node's kind:\n   * - `visitScalar` if the node is a scalar.\n   * - `visitArray` if the node is an array.\n   * - `visitObject` if the node is an object.\n   */\n  accept(visitor: Visitor) {\n    switch (this.#kind) {\n      case 'scalar':\n        visitor.visitScalar(this as JsonNode<JsonScalar>);\n        break;\n      case 'array':\n        visitor.visitArray(this as JsonNode<JsonArray>);\n        break;\n      case 'object':\n        visitor.visitObject(this as JsonNode<JsonObject>);\n        break;\n    }\n  }\n\n  /**\n   * Converts the current instance to a JSON value.\n   *\n   * Depending on the type of the instance (`scalar`, `array`, or `object`),\n   * this method will return the corresponding JSON representation.\n   *\n   * - If the instance is a scalar, it returns the scalar value.\n   * - If the instance is an array, it returns an array of JSON values by\n   *   recursively calling `toJsonValue` on each child.\n   * - If the instance is an object, it returns a JSON object by recursively\n   *   calling `toJsonValue` on each child and using their keys as the object's keys.\n   *\n   * @returns {JsonValue} The JSON representation of the current instance.\n   */\n  toJsonValue(): JsonValue {\n    let obj: JsonValue = {};\n    switch (this.#kind) {\n      case 'scalar':\n        obj = this.#value;\n        break;\n      case 'array':\n        obj = this.#children!.map(child => child.toJsonValue());\n        break;\n      case 'object': {\n        const tmpObj: JsonObject = {};\n        for (const child of this.#children ?? []) {\n          tmpObj[child.key] = child.toJsonValue();\n        }\n        obj = tmpObj;\n      }\n    }\n    return obj;\n  }\n}\n"],"names":["maybeJsonArray","maybeJsonObject"],"mappings":";;;;AA2CA,MAAM,IAAA,uBAAW,GAA4B,EAAA;AAC7C,SAAS,wBAAwB,SAAyC,EAAA;AACxE,EAAI,IAAA,IAAA,CAAK,GAAI,CAAA,SAAS,CAAG,EAAA;AACvB,IAAM,MAAA,IAAI,UAAU,+BAA+B,CAAA;AAAA,GAC9C,MAAA;AACL,IAAA,IAAA,CAAK,IAAI,SAAS,CAAA;AAAA;AAEtB;AA4BA,MAAM,OAAmC,CAAA;AAAA,EAC9B,iBAAA;AAAA,EACA,SAAA;AAAA,EACA,eAAA;AAAA,EAET,YAAY,OAAkC,EAAA;AAC5C,IAAA,IAAA,CAAK,oBAAoB,OAAS,EAAA,oBAAA;AAClC,IAAK,IAAA,CAAA,SAAA,GAAY,OAAS,EAAA,QAAA,IAAY,EAAC;AACvC,IAAK,IAAA,CAAA,eAAA,GAAkB,SAAS,KAAS,IAAA,KAAA;AAAA;AAC3C,EAEA,YAAY,IAAkC,EAAA;AAC5C,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAQ,OAAA,CAAA,GAAA,CAAI,KAAK,QAAQ,CAAA;AAAA;AAC3B;AACF,EAEA,WAAW,IAAiC,EAAA;AAC1C,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAQ,OAAA,CAAA,GAAA,CAAI,KAAK,QAAQ,CAAA;AAAA;AAG3B,IAAA,IAAA,CAAK,UAAU,OAAQ,CAAA,CAAA,KAAA,KAAS,KAAM,CAAA,MAAA,CAAO,IAAI,CAAC,CAAA;AAAA;AACpD,EAEA,YAAY,IAAkC,EAAA;AAC5C,IAAA,IAAI,KAAK,eAAiB,EAAA;AACxB,MAAQ,OAAA,CAAA,GAAA,CAAI,KAAK,QAAQ,CAAA;AAAA;AAG3B,IAAK,IAAA,CAAA,QAAA,EAAU,QAAQ,CAAS,KAAA,KAAA;AAC9B,MAAA,MAAM,SAAS,IAAK,CAAA,SAAA,CAAU,KAAK,CAAS,KAAA,KAAA,KAAA,CAAM,KAAK,KAAM,CAAA,QAAQ,CAAC,CAAA,GAClE,MAAM,GACN,GAAA,IAAA,CAAK,oBAAoB,KAAM,CAAA,GAAG,KAAK,KAAM,CAAA,GAAA;AACjD,MAAA,KAAA,CAAM,GAAM,GAAA,MAAA;AACZ,MAAA,KAAA,CAAM,OAAO,IAAI,CAAA;AAAA,KAClB,CAAA;AAAA;AAEL;AAGO,MAAM,QAA8B,CAAA;AAAA,EACzC,OAAgB,OAAU,GAAA,OAAA;AAAA,EAC1B,OAAO,mBAAmB,KAAgC,EAAA;AACxD,IAAI,IAAA,OAAO,UAAU,QAAU,EAAA;AAC7B,MAAA,OAAO,IAAI,KAAK,CAAA,CAAA,CAAA;AAAA;AAGlB,IAAA,MAAM,KAAQ,GAAA,SAAA;AACd,IAAO,OAAA,KAAA,CAAM,KAAK,KAAK,CAAA,GAAI,KAAK,KAAK,CAAA,EAAA,CAAA,GAAO,IAAI,KAAK,CAAA,CAAA;AAAA;AACvD,EAES,OAAA;AAAA,EACA,SAAA;AAAA,EACA,KAAA;AAAA,EACA,MAAA;AAAA,EACA,SAAA;AAAA,EACT,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,WAAA,CAAY,GAAsB,EAAA,KAAA,EAAU,MAAsB,EAAA;AAChE,IAAA,IAAA,CAAK,GAAM,GAAA,GAAA;AACX,IAAA,IAAA,CAAK,MAAS,GAAA,KAAA;AACd,IAAA,IAAA,CAAK,YAAY,EAAC;AAElB,IAAA,IAAI,QAAQ,GAAK,EAAA;AACf,MAAA,IAAA,CAAK,OAAU,GAAA,IAAA;AACf,MAAK,IAAA,CAAA,SAAA,CAAU,KAAK,GAAG,CAAA;AAAA,KAClB,MAAA;AACL,MAAA,IAAI,CAAC,MAAQ,EAAA;AACX,QAAM,MAAA,IAAI,UAAU,yBAAyB,CAAA;AAAA;AAG/C,MAAA,IAAA,CAAK,OAAU,GAAA,MAAA;AACf,MAAA,IAAA,CAAK,SAAU,CAAA,IAAA;AAAA,QACb,GAAG,KAAK,OAAQ,CAAA,QAAA;AAAA,QAChB,CAAG,EAAA,QAAA,CAAS,kBAAmB,CAAA,GAAG,CAAC,CAAA;AAAA,OACrC;AAAA;AAGF,IAAA,QAAQ,IAAM;AAAA,MACZ,KAAKA,oBAAe,KAAK,CAAA;AACvB,QAAA,uBAAA,CAAwB,KAAK,CAAA;AAC7B,QAAA,IAAA,CAAK,KAAQ,GAAA,OAAA;AACb,QAAA,IAAA,CAAK,YAAY,KAAM,CAAA,GAAA;AAAA,UACrB,CAAC,SAAW,EAAA,GAAA,KAAQ,IAAI,QAAS,CAAA,GAAA,EAAK,WAAW,IAAI;AAAA,SACvD;AACA,QAAA;AAAA,MACF,KAAKC,qBAAgB,KAAK,CAAA;AACxB,QAAA,uBAAA,CAAwB,KAAK,CAAA;AAC7B,QAAA,IAAA,CAAK,KAAQ,GAAA,QAAA;AACb,QAAA,IAAA,CAAK,YAAY,EAAC;AAClB,QAAA,KAAA,MAAW,CAAC,CAAG,EAAA,SAAS,KAAK,MAAO,CAAA,OAAA,CAAQ,KAAK,CAAG,EAAA;AAClD,UAAI,IAAA,OAAO,cAAc,WAAa,EAAA;AACpC,YAAA,IAAA,CAAK,UAAU,IAAK,CAAA,IAAI,SAAS,CAAG,EAAA,SAAA,EAAW,IAAI,CAAC,CAAA;AAAA;AACtD;AAEF,QAAA;AAAA,MACF;AACE,QAAA,IAAA,CAAK,KAAQ,GAAA,QAAA;AACb,QAAA,IAAA,CAAK,SAAY,GAAA,IAAA;AACjB,QAAA;AAAA;AAGJ,IAAI,IAAA,IAAA,CAAK,WAAW,IAAM,EAAA;AACxB,MAAA,IAAA,CAAK,KAAM,EAAA;AAAA;AACb;AACF,EAEA,IAAI,KAAW,GAAA;AACb,IAAA,OAAO,IAAK,CAAA,MAAA;AAAA;AACd,EAEA,IAAI,IAAsC,GAAA;AACxC,IAAA,OAAO,IAAK,CAAA,KAAA;AAAA;AACd,EAEA,IAAI,MAAqC,GAAA;AACvC,IAAA,OAAO,IAAK,CAAA,OAAA;AAAA;AACd,EAEA,IAAI,QAA8C,GAAA;AAChD,IAAA,OAAO,IAAK,CAAA,SAAA;AAAA;AACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,QAAmB,GAAA;AACrB,IAAO,OAAA,IAAA,CAAK,SAAU,CAAA,IAAA,CAAK,EAAE,CAAA;AAAA;AAC/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,OAAO,OAAkB,EAAA;AACvB,IAAA,QAAQ,KAAK,KAAO;AAAA,MAClB,KAAK,QAAA;AACH,QAAA,OAAA,CAAQ,YAAY,IAA4B,CAAA;AAChD,QAAA;AAAA,MACF,KAAK,OAAA;AACH,QAAA,OAAA,CAAQ,WAAW,IAA2B,CAAA;AAC9C,QAAA;AAAA,MACF,KAAK,QAAA;AACH,QAAA,OAAA,CAAQ,YAAY,IAA4B,CAAA;AAChD,QAAA;AAAA;AACJ;AACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,WAAyB,GAAA;AACvB,IAAA,IAAI,MAAiB,EAAC;AACtB,IAAA,QAAQ,KAAK,KAAO;AAAA,MAClB,KAAK,QAAA;AACH,QAAA,GAAA,GAAM,IAAK,CAAA,MAAA;AACX,QAAA;AAAA,MACF,KAAK,OAAA;AACH,QAAA,GAAA,GAAM,KAAK,SAAW,CAAA,GAAA,CAAI,CAAS,KAAA,KAAA,KAAA,CAAM,aAAa,CAAA;AACtD,QAAA;AAAA,MACF,KAAK,QAAU,EAAA;AACb,QAAA,MAAM,SAAqB,EAAC;AAC5B,QAAA,KAAA,MAAW,KAAS,IAAA,IAAA,CAAK,SAAa,IAAA,EAAI,EAAA;AACxC,UAAA,MAAA,CAAO,KAAM,CAAA,GAAG,CAAI,GAAA,KAAA,CAAM,WAAY,EAAA;AAAA;AAExC,QAAM,GAAA,GAAA,MAAA;AAAA;AACR;AAEF,IAAO,OAAA,GAAA;AAAA;AAEX;;;;"}