@trackunit/iris-app-runtime-core-api 0.0.1-alpha-afcc978985.0

package/AssetRuntime.d.ts

@@ -0,0 +1,3 @@
+export interface AssetInfo {
+    assetId: string;
+}

package/CustomFieldRuntime.d.ts

@@ -0,0 +1,167 @@
+export declare type EntityType = "ASSET";
+export interface EntityIdentity {
+    type: EntityType;
+    id: string;
+}
+export declare enum CustomFieldType {
+    BOOLEAN = "BOOLEAN",
+    DATE = "DATE",
+    DROPDOWN = "DROPDOWN",
+    EMAIL = "EMAIL",
+    NUMBER = "NUMBER",
+    PHONE_NUMBER = "PHONE_NUMBER",
+    STRING = "STRING",
+    WEB_ADDRESS = "WEB_ADDRESS"
+}
+/**
+ * The new field definition
+ */
+export interface AbstractCustomFieldDefinitionObject {
+    key?: string | null;
+    /** The title */
+    title: string | null;
+    entityType: string;
+    description?: string | null;
+    uiVisible?: boolean | null;
+    uiEditable?: boolean | null;
+    type: CustomFieldType;
+}
+export declare type BooleanFieldDefinition = AbstractCustomFieldDefinitionObject & {
+    defaultBooleanValue?: boolean | null;
+    type: CustomFieldType.BOOLEAN;
+};
+export declare type DateFieldDefinition = AbstractCustomFieldDefinitionObject & {
+    /**
+     * ISO8601 formatted date
+     */
+    defaultDateValue?: string | null;
+    type: CustomFieldType.DATE;
+};
+export declare type PhoneNumberFieldDefinition = AbstractCustomFieldDefinitionObject & {
+    defaultStringValue?: string | null;
+    type: CustomFieldType.PHONE_NUMBER;
+};
+export declare type EmailFieldDefinition = AbstractCustomFieldDefinitionObject & {
+    defaultStringValue?: string | null;
+    type: CustomFieldType.EMAIL;
+};
+export declare type WebAddressFieldDefinition = AbstractCustomFieldDefinitionObject & {
+    defaultStringValue?: string | null;
+    type: CustomFieldType.WEB_ADDRESS;
+};
+export declare type DropDownFieldDefinition = AbstractCustomFieldDefinitionObject & {
+    defaultStringArrayValue?: string[] | null;
+    multiSelect?: boolean | null;
+    allValues?: string[] | null;
+    type: CustomFieldType.DROPDOWN;
+};
+export declare enum UnitUs {
+    "mi" = "mi",
+    "yd" = "yd",
+    "ft" = "ft",
+    "in" = "in",
+    "ac" = "ac",
+    "ha" = "ha",
+    "ft_2" = "ft\u00B2",
+    "gal" = "gal",
+    "ft_3" = "ft\u00B3",
+    "ton_us" = "ton_us",
+    "lb" = "lb",
+    "oz" = "oz",
+    "mph" = "mph",
+    "lb_h" = "lb/h",
+    "lb_s" = "lb/s"
+}
+export declare enum UnitSi {
+    "km" = "km",
+    "m" = "m",
+    "cm" = "cm",
+    "mm" = "mm",
+    "l" = "l",
+    "kg" = "kg",
+    "g" = "g",
+    "ton" = "ton",
+    "N" = "N",
+    "kW" = "kW",
+    "W" = "W",
+    "kWh" = "kWh",
+    "kPa" = "kPa",
+    "Pa" = "Pa",
+    "bar" = "bar",
+    "m_s" = "m/s",
+    "kg_h" = "kg/h",
+    "kg_s" = "kg/s",
+    "km_h" = "km/h",
+    "km_2" = "km\u00B2",
+    "m_2" = "m\u00B2",
+    "m_3" = "m\u00B3",
+    "m_s_2" = "m/s\u00B2"
+}
+export declare type NumberFieldDefinition = AbstractCustomFieldDefinitionObject & {
+    defaultNumberValue?: number | null;
+    minimumNumber?: number | null;
+    maximumNumber?: number | null;
+    unitSi?: UnitSi | null;
+    unitUs?: UnitUs | null;
+    isInteger?: boolean | null;
+    type: CustomFieldType.NUMBER;
+};
+export declare type StringFieldDefinition = AbstractCustomFieldDefinitionObject & {
+    defaultStringValue?: string | null;
+    minimumLength?: number | null;
+    maximumLength?: number | null;
+    pattern?: string | null;
+    type: CustomFieldType.STRING;
+};
+export interface AbstractCustomFieldValue {
+    type: CustomFieldType;
+}
+export declare type BooleanFieldValue = {
+    type: CustomFieldType.BOOLEAN;
+    booleanValue?: boolean | null;
+};
+export declare type DateFieldValue = {
+    type: CustomFieldType.DATE;
+    /**
+     * ISO8601 formatted date
+     */
+    dateValue?: string | null;
+};
+export declare type DropDownFieldValue = {
+    type: CustomFieldType.DROPDOWN;
+    stringArrayValue?: string[];
+};
+export declare type EmailFieldValue = {
+    type: CustomFieldType.EMAIL;
+    stringValue?: string | null;
+};
+export declare type NumberFieldValue = {
+    type: CustomFieldType.NUMBER;
+    numberValue?: number | null;
+};
+export declare type PhoneNumberFieldValue = {
+    type: CustomFieldType.PHONE_NUMBER;
+    stringValue?: string | null;
+};
+export declare type StringFieldValue = {
+    type: CustomFieldType.STRING;
+    stringValue?: string | null;
+};
+export declare type WebAddressFieldValue = {
+    type: CustomFieldType.WEB_ADDRESS;
+    stringValue?: string | null;
+};
+export declare type CustomFieldDefinition = BooleanFieldDefinition | DateFieldDefinition | DropDownFieldDefinition | EmailFieldDefinition | NumberFieldDefinition | PhoneNumberFieldDefinition | StringFieldDefinition | WebAddressFieldDefinition;
+export declare type CustomFieldValue = BooleanFieldValue | DateFieldValue | DropDownFieldValue | EmailFieldValue | NumberFieldValue | PhoneNumberFieldValue | StringFieldValue | WebAddressFieldValue;
+export interface ValueAndDefinition {
+    definition: CustomFieldDefinition;
+    value: CustomFieldValue;
+}
+export interface AbstractValueAndDefinition {
+    definition: AbstractCustomFieldDefinitionObject;
+    value: AbstractCustomFieldValue;
+}
+export interface ValueAndDefinitionKey {
+    definitionKey: string;
+    value: CustomFieldValue;
+}

package/HostConnector.d.ts

@@ -0,0 +1,31 @@
+import { ICurrentUserContext, IDeveloperSettingsContext, IEnvironmentContext, ITokenContext, IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
+import { AssetInfo } from "./AssetRuntime";
+import { EntityIdentity, ValueAndDefinition, ValueAndDefinitionKey } from "./CustomFieldRuntime";
+import { BodyType, HttpResponse, RequestParams } from "./RestRuntime";
+import { PublicToast } from "./ToastRuntime";
+export interface CustomFieldError {
+    /**
+     * The custom fields that does not obey the rules of the definition, read the definition to figure out what is wrong.
+     */
+    customFieldKeys: string[];
+}
+export interface HostConnectorApi {
+    getAssetInfo(): Promise<AssetInfo>;
+    requestTrackunitRestApi: <T, E>(path: string, method: string, requestParams?: RequestParams, body?: unknown, bodyType?: BodyType, secureByDefault?: boolean) => Promise<HttpResponse<T, E>>;
+    getCustomFieldsFor(entity: EntityIdentity): Promise<ValueAndDefinition[]>;
+    setCustomFieldsFor(entity: EntityIdentity, values: ValueAndDefinitionKey[]): Promise<void | CustomFieldError>;
+    getEnvironmentContext(): Promise<IEnvironmentContext>;
+    getUserSubscriptionContext(): Promise<IUserSubscriptionContext>;
+    getTokenContext(): Promise<ITokenContext>;
+    getCurrentUserContext(): Promise<ICurrentUserContext>;
+    setDeepLink: SetDeepLink;
+    addToast(toast: PublicToast): Promise<void | "primaryAction" | "secondaryAction">;
+    getDeveloperSettingsContext(): Promise<IDeveloperSettingsContext>;
+}
+export declare type SetDeepLink = (deepLink: DeepLink) => void;
+export declare type DeepLink = {
+    path: string;
+    pathname: string;
+    search: Location["search"];
+    hash: Location["hash"];
+};

package/README.md

@@ -0,0 +1,19 @@
+> **⚠️ Beta**
+>
+> This is a beta version and subject to change without notice.
+
+# Trackunit Iris App Runtime Core API
+The `@trackunit/iris-app-runtime-core-api` package is a small package containing reusable types for the Trackunit Iris App SDK.
+
+Trackunit Iris Apps are used by external developers to integrate custom functionality into [the Trackunit Manager platform](https://www.trackunit.com/services/manager/).  
+
+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/RestRuntime.d.ts

@@ -0,0 +1,30 @@
+export declare type RequestParams = {
+    headers?: {
+        [key: string]: string;
+    };
+    secure?: boolean;
+};
+export declare enum BodyType {
+    Json = 0,
+    FormData = 1
+}
+export interface IRestApiClient {
+    request: <T, E>(path: string, method: string, requestParams?: RequestParams, body?: unknown, bodyType?: BodyType, secureByDefault?: boolean) => Promise<HttpResponse<T, E>>;
+    apiHost: string;
+}
+export declare type RequestQueryParamsType = Record<string | number, any>;
+declare type ResponseType = "basic" | "cors" | "default" | "error" | "opaque" | "opaqueredirect";
+export interface HttpResponse<D, E> {
+    data?: D;
+    error?: E;
+    headers: {
+        [key: string]: string;
+    };
+    ok: boolean;
+    redirected: boolean;
+    status: number;
+    statusText: string;
+    type: ResponseType;
+    url: string;
+}
+export {};

package/ToastRuntime.d.ts

@@ -0,0 +1,8 @@
+import { Toast } from "@trackunit/react-core-contexts-api";
+/**
+ * Serializable toast which is used for sending through penpal
+ */
+export interface PublicToast extends Omit<Toast, "primaryAction" | "secondaryAction"> {
+    primaryAction?: string;
+    secondaryAction?: string;
+}

package/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./AssetRuntime";
+export * from "./CustomFieldRuntime";
+export * from "./HostConnector";
+export * from "./RestRuntime";
+export * from "./ToastRuntime";

package/index.js

@@ -0,0 +1,69 @@
+var CustomFieldType;
+
+(function (CustomFieldType) {
+  CustomFieldType["BOOLEAN"] = "BOOLEAN";
+  CustomFieldType["DATE"] = "DATE";
+  CustomFieldType["DROPDOWN"] = "DROPDOWN";
+  CustomFieldType["EMAIL"] = "EMAIL";
+  CustomFieldType["NUMBER"] = "NUMBER";
+  CustomFieldType["PHONE_NUMBER"] = "PHONE_NUMBER";
+  CustomFieldType["STRING"] = "STRING";
+  CustomFieldType["WEB_ADDRESS"] = "WEB_ADDRESS";
+})(CustomFieldType || (CustomFieldType = {}));
+
+var UnitUs;
+
+(function (UnitUs) {
+  UnitUs["mi"] = "mi";
+  UnitUs["yd"] = "yd";
+  UnitUs["ft"] = "ft";
+  UnitUs["in"] = "in";
+  UnitUs["ac"] = "ac";
+  UnitUs["ha"] = "ha";
+  UnitUs["ft_2"] = "ft\u00B2";
+  UnitUs["gal"] = "gal";
+  UnitUs["ft_3"] = "ft\u00B3";
+  UnitUs["ton_us"] = "ton_us";
+  UnitUs["lb"] = "lb";
+  UnitUs["oz"] = "oz";
+  UnitUs["mph"] = "mph";
+  UnitUs["lb_h"] = "lb/h";
+  UnitUs["lb_s"] = "lb/s";
+})(UnitUs || (UnitUs = {}));
+
+var UnitSi;
+
+(function (UnitSi) {
+  UnitSi["km"] = "km";
+  UnitSi["m"] = "m";
+  UnitSi["cm"] = "cm";
+  UnitSi["mm"] = "mm";
+  UnitSi["l"] = "l";
+  UnitSi["kg"] = "kg";
+  UnitSi["g"] = "g";
+  UnitSi["ton"] = "ton";
+  UnitSi["N"] = "N";
+  UnitSi["kW"] = "kW";
+  UnitSi["W"] = "W";
+  UnitSi["kWh"] = "kWh";
+  UnitSi["kPa"] = "kPa";
+  UnitSi["Pa"] = "Pa";
+  UnitSi["bar"] = "bar";
+  UnitSi["m_s"] = "m/s";
+  UnitSi["kg_h"] = "kg/h";
+  UnitSi["kg_s"] = "kg/s";
+  UnitSi["km_h"] = "km/h";
+  UnitSi["km_2"] = "km\u00B2";
+  UnitSi["m_2"] = "m\u00B2";
+  UnitSi["m_3"] = "m\u00B3";
+  UnitSi["m_s_2"] = "m/s\u00B2";
+})(UnitSi || (UnitSi = {}));
+
+var BodyType;
+
+(function (BodyType) {
+  BodyType[BodyType["Json"] = 0] = "Json";
+  BodyType[BodyType["FormData"] = 1] = "FormData";
+})(BodyType || (BodyType = {}));
+
+export { BodyType, CustomFieldType, UnitSi, UnitUs };

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@trackunit/iris-app-runtime-core-api",
+  "version": "0.0.1-alpha-afcc978985.0",
+  "repository": "https://github.com/Trackunit/manager",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "module": "./index.js",
+  "main": "./index.js",
+  "type": "module",
+  "types": "./index.d.ts",
+  "dependencies": {
+    "@trackunit/react-core-contexts-api": "0.0.1-alpha-afcc978985.0"
+  },
+  "peerDependencies": {}
+}