@backstage-community/plugin-cost-insights-common 0.1.3

package/CHANGELOG.md

@@ -0,0 +1,43 @@
+# @backstage-community/plugin-cost-insights-common
+
+## 0.1.3
+
+### Patch Changes
+
+- 193a2a3: Migrated from the [backstage/backstage](https://github.com/backstage/backstage) monorepo.
+
+## 0.1.2
+
+### Patch Changes
+
+- 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
+
+## 0.1.2-next.0
+
+### Patch Changes
+
+- 406b786a2a2c: Mark package as being free of side effects, allowing more optimized Webpack builds.
+
+## 0.1.1
+
+### Patch Changes
+
+- daf4b33e34: Add name property to Group
+
+## 0.1.1-next.0
+
+### Patch Changes
+
+- daf4b33e34: Add name property to Group
+
+## 0.1.0
+
+### Minor Changes
+
+- 81dd5ea989: Introduces a new isomorphic @backstage/plugin-cost-insight-common package to contain shared types across all other cost insights packages and modules.
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- 81dd5ea989: Introduces a new isomorphic @backstage/plugin-cost-insight-common package to contain shared types across all other cost insights packages and modules.

package/README.md

@@ -0,0 +1,8 @@
+# Cost Insights Common
+
+Shared isomorphic code for the cost-insights plugin.
+
+## Links
+
+- [Frontend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/cost-insights)
+- [The Backstage homepage](https://backstage.io)

package/dist/index.cjs.js

@@ -0,0 +1,3 @@
+'use strict';
+
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/index.d.ts

@@ -0,0 +1,202 @@
+/**
+ * @public
+ */
+interface ChangeStatistic {
+    /**
+     * The ratio of change from one duration to another, expressed as: (newSum - oldSum) / oldSum
+     * If a ratio cannot be calculated - such as when a new or old sum is zero,
+     * the ratio can be omitted and where applicable, ∞ or -∞ will display based on amount.
+     */
+    ratio?: number;
+    /**
+     * The actual USD change between time periods (can be negative if costs decreased)
+     */
+    amount: number;
+}
+
+/**
+ * @public
+ */
+type DateAggregation = {
+    /**
+     * The date aggregation as string.
+     * @example YYYY-MM-DD
+     */
+    date: string;
+    amount: number;
+};
+
+/**
+ * @public
+ */
+type Trendline = {
+    slope: number;
+    intercept: number;
+};
+
+/**
+ * @public
+ */
+interface Cost {
+    id: string;
+    aggregation: DateAggregation[];
+    change?: ChangeStatistic;
+    trendline?: Trendline;
+    groupedCosts?: Record<string, Cost[]>;
+}
+
+/**
+ * @public
+ */
+type Maybe<T> = T | null;
+
+/**
+ *
+ * An entity is a tree-like structure that represents any unique
+ * product or service that generates cost over a fixed period of time.
+ * An entity could be atomic or composite. An atomic entity is indivisible
+ * and cannot be broken into sub-entities.
+ *
+ * A composite entity is divided into sub-entities that account for portions
+ * of the total cost **over the same time period**. The root entity is
+ * expected to only have _one_ Record consisting of the sub-entities to display
+ * in the product panel (keyed by the entity type, such as "service" for
+ * compute entities).
+ *
+ * The root sub-entities may have multiple breakdowns  - for example, a
+ * breakdown of an entity cost by SKU vs deployment environment. The sum
+ * aggregated cost of each keyed breakdown should equal the sub-entity's cost.
+ *
+ * Entities with null ids are considered "unlabeled" - costs without attribution.
+ * If an entity is a composite, it may only have one (1) null child but may have any number of
+ * null grandchildren.
+ *
+ * @public
+ *
+ * @example
+ * Here's an example composite entity:
+ * ```
+ * const compositeEntity = {
+ *   id: 'product',
+ *   aggregation: [0, 200],
+ *   change: {
+ *     ratio: 2000,
+ *     amount: 200
+ *   },
+ *   entities: {
+ *     service: [
+ *       {
+ *         id: 'service-a',
+ *         aggregation: [0, 100],
+ *         change: {
+ *           ratio: 100,
+ *           amount: 100
+ *         },
+ *         entities: {}
+ *       },
+ *       {
+ *         id: 'service-b',
+ *         aggregation: [0, 100],
+ *         change: {
+ *           ratio: 100,
+ *           amount: 100
+ *         },
+ *         entities: {
+ *           SKU: [
+ *             {
+ *               id: 'service-b-sku-a',
+ *               aggregation: [0, 25],
+ *               change: {
+ *                 ratio: 25,
+ *                 amount: 25
+ *               },
+ *               entities: {}
+ *             },
+ *             {
+ *               id: null, // Unlabeled cost for service-b
+ *               aggregation: [0, 75],
+ *               change: {
+ *                 ratio: 75,
+ *                 amount: 75
+ *               },
+ *               entities: {}
+ *             },
+ *           ],
+ *           deployment: [
+ *             {
+ *               id: 'service-b-env-a',
+ *               aggregation: [0, 50],
+ *               change: {
+ *                 ratio: 50,
+ *                 amount: 50
+ *               },
+ *               entities: {}
+ *             },
+ *             {
+ *               id: 'service-b-env-b',
+ *               aggregation: [0, 50],
+ *               change: {
+ *                 ratio: 50,
+ *                 amount: 50
+ *               },
+ *               entities: {}
+ *             },
+ *           ]
+ *         }
+ *       },
+ *     ]
+ *   }
+ * }
+ * ```
+ */
+interface Entity {
+    id: Maybe<string>;
+    aggregation: [number, number];
+    entities: Record<string, Entity[]>;
+    change: ChangeStatistic;
+}
+
+/**
+ * @public
+ */
+type Group = {
+    id: string;
+    name?: string;
+};
+
+/**
+ * @public
+ */
+interface MetricData {
+    id: string;
+    format: 'number' | 'currency';
+    aggregation: DateAggregation[];
+    change: ChangeStatistic;
+}
+
+/**
+ * @public
+ */
+type Metric = {
+    kind: string;
+    name: string;
+    default: boolean;
+};
+
+/**
+ * @public
+ */
+interface Product {
+    kind: string;
+    name: string;
+}
+
+/**
+ * @public
+ */
+interface Project {
+    id: string;
+    name?: string;
+}
+
+export type { ChangeStatistic, Cost, DateAggregation, Entity, Group, Maybe, Metric, MetricData, Product, Project, Trendline };

package/dist/index.esm.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@backstage-community/plugin-cost-insights-common",
+  "version": "0.1.3",
+  "description": "Common functionalities for the cost-insights plugin",
+  "backstage": {
+    "role": "common-library"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "keywords": [
+    "backstage"
+  ],
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/community-plugins",
+    "directory": "workspaces/cost-insights/plugins/cost-insights-common"
+  },
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "test": "backstage-cli package test"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.26.3"
+  },
+  "module": "dist/index.esm.js"
+}