@trackunit/criticality-indicator 0.0.1

package/README.md

@@ -0,0 +1,22 @@
+> **⚠️ Beta**
+>
+> This is a beta version and subject to change without notice.
+
+# Trackunit Criticality indicator
+The `@trackunit/criticality-indicator` package is the home of criticality ui components.
+
+This library is exposed publicly for use in the  the Trackunit [Iris App SDK](https://www.npmjs.com/package/@trackunit/iris-app).  
+
+To browse all available components visit our [Public Storybook](https://developers.trackunit.com/page/ui-components).
+
+For more info and a full guide on Iris App SDK Development, please visit our [Developer Hub](https://developers.trackunit.com/).
+
+## Development
+At this point this library is only developed by Trackunit Employees.
+For development related information see the [development readme](https://github.com/Trackunit/manager/blob/master/libs/react/components/DEVELOPMENT.md).
+
+## Trackunit
+This package was developed by Trackunit ApS.
+Trackunit is the leading SaaS-based IoT solution for the construction industry, offering an ecosystem of hardware, fleet management software & telematics.
+
+![The Trackunit logo](https://trackunit.com/wp-content/uploads/2022/03/top-logo.svg)

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.cjs.js

@@ -0,0 +1,131 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var jsxRuntime = require('react/jsx-runtime');
+var i18nLibraryTranslation = require('@trackunit/i18n-library-translation');
+var reactComponents = require('@trackunit/react-components');
+
+var defaultTranslations = {
+	"indicator.critical": "Critical",
+	"indicator.low": "Low",
+	"indicator.none": "Good"
+};
+
+/** The translation namespace for this library */
+const namespace = "criticality.indicator";
+/**
+ * The TranslationResource for this Library.
+ * Holds lazy loaded imports for all languages supported by the library.
+ *
+ * This is used to register the translations for this library before initializing i18next.
+ */
+const translations = {
+    ns: namespace,
+    default: defaultTranslations,
+    languages: {
+        de: () => Promise.resolve().then(function () { return require('./translation.cjs.js'); }),
+        da: () => Promise.resolve().then(function () { return require('./translation.cjs2.js'); }),
+        cs: () => Promise.resolve().then(function () { return require('./translation.cjs3.js'); }),
+        nl: () => Promise.resolve().then(function () { return require('./translation.cjs4.js'); }),
+        fr: () => Promise.resolve().then(function () { return require('./translation.cjs5.js'); }),
+        fi: () => Promise.resolve().then(function () { return require('./translation.cjs6.js'); }),
+        hu: () => Promise.resolve().then(function () { return require('./translation.cjs7.js'); }),
+        it: () => Promise.resolve().then(function () { return require('./translation.cjs8.js'); }),
+        nb: () => Promise.resolve().then(function () { return require('./translation.cjs9.js'); }),
+        pl: () => Promise.resolve().then(function () { return require('./translation.cjs10.js'); }),
+        pt: () => Promise.resolve().then(function () { return require('./translation.cjs11.js'); }),
+        ru: () => Promise.resolve().then(function () { return require('./translation.cjs12.js'); }),
+        ro: () => Promise.resolve().then(function () { return require('./translation.cjs13.js'); }),
+        es: () => Promise.resolve().then(function () { return require('./translation.cjs14.js'); }),
+        sv: () => Promise.resolve().then(function () { return require('./translation.cjs15.js'); }),
+        ja: () => Promise.resolve().then(function () { return require('./translation.cjs16.js'); }),
+        th: () => Promise.resolve().then(function () { return require('./translation.cjs17.js'); }),
+    },
+};
+/**
+ *  Local useTranslation for this specific library
+ */
+const useTranslation = () => i18nLibraryTranslation.useNamespaceTranslation(namespace);
+/**
+ * Registers the translations for this library
+ */
+const setupLibraryTranslations = () => {
+    i18nLibraryTranslation.registerTranslations(translations);
+};
+
+/** The severity of the Asset. */
+const assetCriticalityState = {
+    Critical: "CRITICAL",
+    Low: "LOW",
+    None: "NONE",
+};
+
+/**
+ * Returns the criticality indicator props.
+ *
+ * @param state - The criticality state.
+ * @returns   {UseCriticality} - The criticality indicator props.
+ */
+const useCriticality = state => {
+    const [t] = useTranslation();
+    if (!state) {
+        return {
+            criticalityIndicator: undefined,
+        };
+    }
+    switch (state) {
+        case assetCriticalityState.Critical:
+            return {
+                criticalityIndicator: {
+                    icon: jsxRuntime.jsx(reactComponents.Icon, { name: "ExclamationCircle", dataTestId: "indicator-icon-critical", size: "medium" }),
+                    label: t("indicator.critical"),
+                    color: "critical",
+                },
+            };
+        case assetCriticalityState.Low:
+            return {
+                criticalityIndicator: {
+                    icon: jsxRuntime.jsx(reactComponents.Icon, { name: "ExclamationTriangle", dataTestId: "indicator-icon-low", size: "medium" }),
+                    label: t("indicator.low"),
+                    color: "low",
+                },
+            };
+        case assetCriticalityState.None:
+            return {
+                criticalityIndicator: {
+                    icon: jsxRuntime.jsx(reactComponents.Icon, { name: "CheckCircle", dataTestId: "indicator-icon-good", size: "medium" }),
+                    label: t("indicator.none"),
+                    color: "good",
+                },
+            };
+        default:
+            return {
+                criticalityIndicator: undefined,
+            };
+    }
+};
+
+/**
+ * Criticality indicator.
+ *
+ * @param props - Criticality indicator props.
+ * @returns {JSX.Element | null} Criticality indicator.
+ */
+const CriticalityIndicator = (props) => {
+    const { criticalityIndicator } = useCriticality(props.state);
+    return criticalityIndicator ? jsxRuntime.jsx(reactComponents.Indicator, Object.assign({}, criticalityIndicator, props)) : null;
+};
+
+/*
+ * ----------------------------
+ * | SETUP TRANSLATIONS START |
+ * ----------------------------
+ * This import and function call is needed to register translations for this library.
+ * Do not remove this if this library has translations.
+ */
+setupLibraryTranslations();
+
+exports.CriticalityIndicator = CriticalityIndicator;
+exports.assetCriticalityState = assetCriticalityState;
+exports.useCriticality = useCriticality;

package/index.esm.js

@@ -0,0 +1,125 @@
+import { jsx } from 'react/jsx-runtime';
+import { registerTranslations, useNamespaceTranslation } from '@trackunit/i18n-library-translation';
+import { Icon, Indicator } from '@trackunit/react-components';
+
+var defaultTranslations = {
+	"indicator.critical": "Critical",
+	"indicator.low": "Low",
+	"indicator.none": "Good"
+};
+
+/** The translation namespace for this library */
+const namespace = "criticality.indicator";
+/**
+ * The TranslationResource for this Library.
+ * Holds lazy loaded imports for all languages supported by the library.
+ *
+ * This is used to register the translations for this library before initializing i18next.
+ */
+const translations = {
+    ns: namespace,
+    default: defaultTranslations,
+    languages: {
+        de: () => import('./translation.esm.js'),
+        da: () => import('./translation.esm2.js'),
+        cs: () => import('./translation.esm3.js'),
+        nl: () => import('./translation.esm4.js'),
+        fr: () => import('./translation.esm5.js'),
+        fi: () => import('./translation.esm6.js'),
+        hu: () => import('./translation.esm7.js'),
+        it: () => import('./translation.esm8.js'),
+        nb: () => import('./translation.esm9.js'),
+        pl: () => import('./translation.esm10.js'),
+        pt: () => import('./translation.esm11.js'),
+        ru: () => import('./translation.esm12.js'),
+        ro: () => import('./translation.esm13.js'),
+        es: () => import('./translation.esm14.js'),
+        sv: () => import('./translation.esm15.js'),
+        ja: () => import('./translation.esm16.js'),
+        th: () => import('./translation.esm17.js'),
+    },
+};
+/**
+ *  Local useTranslation for this specific library
+ */
+const useTranslation = () => useNamespaceTranslation(namespace);
+/**
+ * Registers the translations for this library
+ */
+const setupLibraryTranslations = () => {
+    registerTranslations(translations);
+};
+
+/** The severity of the Asset. */
+const assetCriticalityState = {
+    Critical: "CRITICAL",
+    Low: "LOW",
+    None: "NONE",
+};
+
+/**
+ * Returns the criticality indicator props.
+ *
+ * @param state - The criticality state.
+ * @returns   {UseCriticality} - The criticality indicator props.
+ */
+const useCriticality = state => {
+    const [t] = useTranslation();
+    if (!state) {
+        return {
+            criticalityIndicator: undefined,
+        };
+    }
+    switch (state) {
+        case assetCriticalityState.Critical:
+            return {
+                criticalityIndicator: {
+                    icon: jsx(Icon, { name: "ExclamationCircle", dataTestId: "indicator-icon-critical", size: "medium" }),
+                    label: t("indicator.critical"),
+                    color: "critical",
+                },
+            };
+        case assetCriticalityState.Low:
+            return {
+                criticalityIndicator: {
+                    icon: jsx(Icon, { name: "ExclamationTriangle", dataTestId: "indicator-icon-low", size: "medium" }),
+                    label: t("indicator.low"),
+                    color: "low",
+                },
+            };
+        case assetCriticalityState.None:
+            return {
+                criticalityIndicator: {
+                    icon: jsx(Icon, { name: "CheckCircle", dataTestId: "indicator-icon-good", size: "medium" }),
+                    label: t("indicator.none"),
+                    color: "good",
+                },
+            };
+        default:
+            return {
+                criticalityIndicator: undefined,
+            };
+    }
+};
+
+/**
+ * Criticality indicator.
+ *
+ * @param props - Criticality indicator props.
+ * @returns {JSX.Element | null} Criticality indicator.
+ */
+const CriticalityIndicator = (props) => {
+    const { criticalityIndicator } = useCriticality(props.state);
+    return criticalityIndicator ? jsx(Indicator, Object.assign({}, criticalityIndicator, props)) : null;
+};
+
+/*
+ * ----------------------------
+ * | SETUP TRANSLATIONS START |
+ * ----------------------------
+ * This import and function call is needed to register translations for this library.
+ * Do not remove this if this library has translations.
+ */
+setupLibraryTranslations();
+
+export { CriticalityIndicator, assetCriticalityState, useCriticality };

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@trackunit/criticality-indicator",
+  "version": "0.0.1",
+  "repository": "https://github.com/Trackunit/manager",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "engines": {
+    "node": ">=18.x"
+  },
+  "dependencies": {},
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js"
+}

package/src/CriticalityIndicator.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+import { CommonProps, IndicatorProps } from "@trackunit/react-components";
+import { AssetCriticalityState } from "./types";
+export interface CriticalityIndicatorProps extends Pick<IndicatorProps, "withBackground" | "withLabel" | "ping">, CommonProps {
+    state: AssetCriticalityState;
+}
+/**
+ * Criticality indicator.
+ *
+ * @param props - Criticality indicator props.
+ * @returns {JSX.Element | null} Criticality indicator.
+ */
+export declare const CriticalityIndicator: (props: CriticalityIndicatorProps) => JSX.Element | null;

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./CriticalityIndicator";
+export * from "./types";
+export * from "./useCriticality";

package/src/translation.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="react" />
+import { NamespaceTransProps, TransForLibs, TranslationResource } from "@trackunit/i18n-library-translation";
+import defaultTranslations from "./locales/en/translation.json";
+/** A type for all available translation keys in this library */
+export type TranslationKeys = keyof typeof defaultTranslations;
+/** The translation namespace for this library */
+export declare const namespace = "criticality.indicator";
+/**
+ * The TranslationResource for this Library.
+ * Holds lazy loaded imports for all languages supported by the library.
+ *
+ * This is used to register the translations for this library before initializing i18next.
+ */
+export declare const translations: TranslationResource<TranslationKeys>;
+/**
+ *  Local useTranslation for this specific library
+ */
+export declare const useTranslation: () => [TransForLibs<"indicator.critical" | "indicator.low" | "indicator.none">, import("i18next").i18n, boolean] & {
+    t: TransForLibs<"indicator.critical" | "indicator.low" | "indicator.none">;
+    i18n: import("i18next").i18n;
+    ready: boolean;
+};
+/**
+ * Type of the t function for the local useTranslation for this specific library
+ */
+export type TranslationFunction = TransForLibs<TranslationKeys>;
+/**
+ * Trans for this specific library.
+ */
+export declare const Trans: (props: NamespaceTransProps<TranslationKeys>) => JSX.Element;
+/**
+ * Registers the translations for this library
+ */
+export declare const setupLibraryTranslations: () => void;

package/src/types.d.ts

@@ -0,0 +1,7 @@
+/** The severity of the Asset. */
+export declare const assetCriticalityState: {
+    readonly Critical: "CRITICAL";
+    readonly Low: "LOW";
+    readonly None: "NONE";
+};
+export type AssetCriticalityState = (typeof assetCriticalityState)[keyof typeof assetCriticalityState];

package/src/useCriticality.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import { CriticalityColors } from "@trackunit/ui-design-tokens";
+import { AssetCriticalityState } from "./types";
+type UseCriticality = (state?: AssetCriticalityState) => {
+    criticalityIndicator?: {
+        icon: JSX.Element;
+        label: string;
+        color: CriticalityColors;
+    };
+};
+/**
+ * Returns the criticality indicator props.
+ *
+ * @param state - The criticality state.
+ * @returns   {UseCriticality} - The criticality indicator props.
+ */
+export declare const useCriticality: UseCriticality;
+export {};

package/translation.cjs.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Kritisch",
+	"indicator.low": "Niedrig",
+	"indicator.none": "Gut"
+};
+
+exports["default"] = translation;

package/translation.cjs10.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Stan krytyczny",
+	"indicator.low": "Niska krytyczność",
+	"indicator.none": "Dobrze"
+};
+
+exports["default"] = translation;

package/translation.cjs11.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Crítico",
+	"indicator.low": "Baixo",
+	"indicator.none": "Bom"
+};
+
+exports["default"] = translation;

package/translation.cjs12.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Критические",
+	"indicator.low": "Низкая",
+	"indicator.none": "Хорошо"
+};
+
+exports["default"] = translation;

package/translation.cjs13.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Critic",
+	"indicator.low": "Scăzut",
+	"indicator.none": "Bun"
+};
+
+exports["default"] = translation;

package/translation.cjs14.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Crítico",
+	"indicator.low": "Baja",
+	"indicator.none": "Bien"
+};
+
+exports["default"] = translation;

package/translation.cjs15.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Kritiskt",
+	"indicator.low": "Låg",
+	"indicator.none": "God"
+};
+
+exports["default"] = translation;

package/translation.cjs16.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "重要",
+	"indicator.low": "注意",
+	"indicator.none": "正常"
+};
+
+exports["default"] = translation;

package/translation.cjs17.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "วิกฤต",
+	"indicator.low": "ต่ำ",
+	"indicator.none": "ดี"
+};
+
+exports["default"] = translation;

package/translation.cjs2.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Kritisk",
+	"indicator.low": "Lav",
+	"indicator.none": "God"
+};
+
+exports["default"] = translation;

package/translation.cjs3.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Kritický",
+	"indicator.low": "Nízký",
+	"indicator.none": "Dobrý"
+};
+
+exports["default"] = translation;

package/translation.cjs4.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Kritisch",
+	"indicator.low": "Laag",
+	"indicator.none": "Goed"
+};
+
+exports["default"] = translation;

package/translation.cjs5.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Critique",
+	"indicator.low": "Faible",
+	"indicator.none": "Bon"
+};
+
+exports["default"] = translation;

package/translation.cjs6.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Kriittinen",
+	"indicator.low": "Matala",
+	"indicator.none": "Hyvä"
+};
+
+exports["default"] = translation;

package/translation.cjs7.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Kritikus",
+	"indicator.low": "Alacsony",
+	"indicator.none": "Jó"
+};
+
+exports["default"] = translation;

package/translation.cjs8.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Critica",
+	"indicator.low": "Bassa",
+	"indicator.none": "Buona"
+};
+
+exports["default"] = translation;

package/translation.cjs9.js

@@ -0,0 +1,9 @@
+'use strict';
+
+var translation = {
+	"indicator.critical": "Kritisk",
+	"indicator.low": "Lav",
+	"indicator.none": "God"
+};
+
+exports["default"] = translation;

package/translation.esm.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Kritisch",
+	"indicator.low": "Niedrig",
+	"indicator.none": "Gut"
+};
+
+export { translation as default };

package/translation.esm10.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Stan krytyczny",
+	"indicator.low": "Niska krytyczność",
+	"indicator.none": "Dobrze"
+};
+
+export { translation as default };

package/translation.esm11.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Crítico",
+	"indicator.low": "Baixo",
+	"indicator.none": "Bom"
+};
+
+export { translation as default };

package/translation.esm12.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Критические",
+	"indicator.low": "Низкая",
+	"indicator.none": "Хорошо"
+};
+
+export { translation as default };

package/translation.esm13.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Critic",
+	"indicator.low": "Scăzut",
+	"indicator.none": "Bun"
+};
+
+export { translation as default };

package/translation.esm14.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Crítico",
+	"indicator.low": "Baja",
+	"indicator.none": "Bien"
+};
+
+export { translation as default };

package/translation.esm15.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Kritiskt",
+	"indicator.low": "Låg",
+	"indicator.none": "God"
+};
+
+export { translation as default };

package/translation.esm16.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "重要",
+	"indicator.low": "注意",
+	"indicator.none": "正常"
+};
+
+export { translation as default };

package/translation.esm17.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "วิกฤต",
+	"indicator.low": "ต่ำ",
+	"indicator.none": "ดี"
+};
+
+export { translation as default };

package/translation.esm2.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Kritisk",
+	"indicator.low": "Lav",
+	"indicator.none": "God"
+};
+
+export { translation as default };

package/translation.esm3.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Kritický",
+	"indicator.low": "Nízký",
+	"indicator.none": "Dobrý"
+};
+
+export { translation as default };

package/translation.esm4.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Kritisch",
+	"indicator.low": "Laag",
+	"indicator.none": "Goed"
+};
+
+export { translation as default };

package/translation.esm5.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Critique",
+	"indicator.low": "Faible",
+	"indicator.none": "Bon"
+};
+
+export { translation as default };

package/translation.esm6.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Kriittinen",
+	"indicator.low": "Matala",
+	"indicator.none": "Hyvä"
+};
+
+export { translation as default };

package/translation.esm7.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Kritikus",
+	"indicator.low": "Alacsony",
+	"indicator.none": "Jó"
+};
+
+export { translation as default };

package/translation.esm8.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Critica",
+	"indicator.low": "Bassa",
+	"indicator.none": "Buona"
+};
+
+export { translation as default };

package/translation.esm9.js

@@ -0,0 +1,7 @@
+var translation = {
+	"indicator.critical": "Kritisk",
+	"indicator.low": "Lav",
+	"indicator.none": "God"
+};
+
+export { translation as default };