@trackunit/iris-app-oem-api 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## 0.0.1 (2023-04-03)
+
+### Dependency Updates
+
+* `iris-app-api` updated to version `0.0.81`

package/README.md

@@ -0,0 +1,19 @@
+> **⚠️ Beta**
+>
+> This is a beta version and subject to change without notice.
+
+# Trackunit Iris App OEM API
+The `@trackunit/iris-app-oem-api` package is a small package containing reusable types for the Trackunit Iris App SDK.
+
+Trackunit Iris App OEM are used to add custom brand images into [the Trackunit Manager platform](https://www.trackunit.com/services/manager/) globally.  
+
+For more info and a full guide on Iris App SDK Development, please visit our [Developer Hub](https://developers.trackunit.com/).
+
+## Basic Usage
+This package is not meant for isolated usage but is a part of the [`@trackunit/iris-app`](https://www.npmjs.com/package/@trackunit/iris-app) package.
+
+## 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/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@trackunit/iris-app-oem-api",
+  "version": "0.0.1",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "repository": "https://github.com/Trackunit/manager",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "@trackunit/iris-app-api": "0.0.81",
+    "tslib": "2.4.1"
+  },
+  "peerDependencies": {}
+}

package/src/index.d.ts

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

package/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/iris-app-sdk/iris-app-oem-api/src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB","sourcesContent":["export * from \"./types\";\n"]}

package/src/types/index.d.ts

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

package/src/types/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./irisAppOemManifest"), exports);
+//# sourceMappingURL=index.js.map

package/src/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-oem-api/src/types/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC","sourcesContent":["export * from \"./irisAppOemManifest\";\n"]}

package/src/types/irisAppOemManifest.d.ts

@@ -0,0 +1,72 @@
+import { IrisAppManifest } from "@trackunit/iris-app-api";
+export interface IrisAppOemManifest extends IrisAppManifest {
+    /**
+     * OEM Branding, where logos and color will be brand oriented.
+     */
+    oemBranding?: Branding;
+    /**
+     * Platform Branding, where logos will be platform oriented.
+     */
+    oemPlatformBranding?: PlatformBranding;
+}
+export interface Branding {
+    /**
+     * Conditions for the OEM app to be shown.
+     */
+    conditions: {
+        /**
+         * It is case insensitive so does not matter how you write the brand.
+         *  brand: "trackunit" and brand: "Trackunit" will be the same.
+         *
+         * Brand used/filled out then the asset needs to match the filled out property.
+         */
+        brand: string;
+    };
+    /**
+     * Path to an image in the assets folder of the app.
+     * The image will be shown as brand logo.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    logoPath?: string;
+    /**
+     * Path to a grey image in the assets folder of the app.
+     * The image will be shown as fleet list logo of an OEM asset.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     * This image color should be fully this shade of grey: '#717579'.
+     */
+    darkLogoPath?: string;
+    /**
+     * Path to an image in the assets folder of the app.
+     * The image will be shown as banner of an OEM asset.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    bannerPath?: string;
+    /**
+     * Color will be applied to banner and also will used as brand theme color.
+     * It will be a hex code. eg: '#FF0000'.
+     */
+    color?: string;
+}
+export interface PlatformBranding {
+    /**
+     * Path to an image in the assets folder of the app.
+     * The image will be shown in the Events and Insights tab in Asset home.
+     * Example: typing "MyImage.png" here, will show the file "apps/my-app/assets/MyImage.png"
+     */
+    logoPath: string;
+    /**
+     * Conditions for the OEM app to be shown.
+     */
+    conditions: {
+        /**
+         * It is case insensitive so does not matter how you write the brand.
+         *  brand: "trackunit" and brand: "Trackunit" will be the same.
+         * Brand used/filled out then the asset needs to match the filled out property.
+         */
+        brand: string;
+        /**
+         * CAN Profiles takes an array of CAN profile names.
+         */
+        canProfiles?: string[];
+    };
+}

package/src/types/irisAppOemManifest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=irisAppOemManifest.js.map

package/src/types/irisAppOemManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irisAppOemManifest.js","sourceRoot":"","sources":["../../../../../../libs/iris-app-sdk/iris-app-oem-api/src/types/irisAppOemManifest.ts"],"names":[],"mappings":"","sourcesContent":["import { IrisAppManifest } from \"@trackunit/iris-app-api\";\n\nexport interface IrisAppOemManifest extends IrisAppManifest {\n  /**\n   * OEM Branding, where logos and color will be brand oriented.\n   */\n  oemBranding?: Branding;\n  /**\n   * Platform Branding, where logos will be platform oriented.\n   */\n  oemPlatformBranding?: PlatformBranding;\n}\n\nexport interface Branding {\n  /**\n   * Conditions for the OEM app to be shown.\n   */\n  conditions: {\n    /**\n     * It is case insensitive so does not matter how you write the brand.\n     *  brand: \"trackunit\" and brand: \"Trackunit\" will be the same.\n     *\n     * Brand used/filled out then the asset needs to match the filled out property.\n     */\n    brand: string;\n  };\n  /**\n   * Path to an image in the assets folder of the app.\n   * The image will be shown as brand logo.\n   * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n   */\n  logoPath?: string;\n  /**\n   * Path to a grey image in the assets folder of the app.\n   * The image will be shown as fleet list logo of an OEM asset.\n   * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n   * This image color should be fully this shade of grey: '#717579'.\n   */\n  darkLogoPath?: string;\n  /**\n   * Path to an image in the assets folder of the app.\n   * The image will be shown as banner of an OEM asset.\n   * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n   */\n  bannerPath?: string;\n  /**\n   * Color will be applied to banner and also will used as brand theme color.\n   * It will be a hex code. eg: '#FF0000'.\n   */\n  color?: string;\n}\n\nexport interface PlatformBranding {\n  /**\n   * Path to an image in the assets folder of the app.\n   * The image will be shown in the Events and Insights tab in Asset home.\n   * Example: typing \"MyImage.png\" here, will show the file \"apps/my-app/assets/MyImage.png\"\n   */\n  logoPath: string;\n  /**\n   * Conditions for the OEM app to be shown.\n   */\n  conditions: {\n    /**\n     * It is case insensitive so does not matter how you write the brand.\n     *  brand: \"trackunit\" and brand: \"Trackunit\" will be the same.\n     * Brand used/filled out then the asset needs to match the filled out property.\n     */\n    brand: string;\n    /**\n     * CAN Profiles takes an array of CAN profile names.\n     */\n    canProfiles?: string[];\n  };\n}\n"]}