@trackunit/react-core-contexts-api 0.0.1-alpha-afcc978985.0

package/README.md

@@ -0,0 +1,18 @@
+> **⚠️ Beta**
+>
+> This is a beta version and subject to change without notice.
+
+# Trackunit React Core Contexts API
+The `@trackunit/react-core-contexts-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/currentUserContext.d.ts

@@ -0,0 +1,34 @@
+export interface ICurrentUserContext {
+    tasUserId: string | undefined;
+    /**
+     * userName used when logging in. Undefined if not authenticated
+     */
+    userName: string | undefined;
+    /**
+     * Legacy user id. Undefined if not authenticated
+     */
+    userId: number | undefined;
+    /**
+     * Legacy customer id. Undefined if not authenticated
+     */
+    customerId: number | undefined;
+    /**
+     * Account ID. undefined if not authenticated
+     */
+    accountId: string | undefined;
+    /**
+     * If currently assuming a different user, this contains the information of that user. Null if not assuming
+     */
+    assumedUser: {
+        userId: number;
+        customerId: number;
+        accountId: string;
+    } | null;
+    email: string | undefined;
+    name: string | undefined;
+    jobTitle: string | undefined;
+    /**
+     * Is there an authenticated user or not
+     */
+    isAuthenticated: boolean;
+}

package/developerSettingsContext.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+export interface IDeveloperSettingsContext {
+    localFeatureFlagsEnabled: boolean;
+    enableLocalFeatureFlags?: React.Dispatch<React.SetStateAction<boolean>>;
+    localFeatureFlags?: FeatureFlags;
+    launchdarklyFlags?: FeatureFlags;
+    setFlags?: React.Dispatch<React.SetStateAction<FeatureFlags | undefined>>;
+}
+export declare type FeatureFlags = {
+    [key: string]: boolean | Json;
+};
+export declare type Json = string;

package/environmentContext.d.ts

@@ -0,0 +1,30 @@
+export interface ITracingHeaders {
+    "X-TrackunitAppVersion": string;
+    "session-id": string;
+}
+export interface IEnvironmentContext {
+    auth: {
+        url: string;
+        clientId: string;
+        issuer: string;
+    };
+    tracingHeaders: ITracingHeaders;
+    managerClassicUrl: string;
+    googleMapsApiKey: string;
+    amplitudeApiKey: string;
+    launchDarklyApiKey: string;
+    graphqlLegacyUrl: string;
+    graphqlManagerUrl: string;
+    graphqlManagerImageUploadUrl: string;
+    graphqlReportUrl: string;
+    graphqlSimulatorUrl: string;
+    buildVersion: string;
+    commitNumber: number;
+    buildDate: string;
+    publicUrl: string;
+    irisAppSdkServerUrl: string;
+    isDev: boolean;
+    environment: string;
+    sentryDsn: string;
+    sessionId: string;
+}

package/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./currentUserContext";
+export * from "./developerSettingsContext";
+export * from "./environmentContext";
+export * from "./toastContext";
+export * from "./tokenContext";
+export * from "./userSubscriptionContext";

package/index.js

@@ -0,0 +1,14 @@
+var UserSubscriptionPackageType;
+
+(function (UserSubscriptionPackageType) {
+  UserSubscriptionPackageType["EXPAND_FLEET_OWNER"] = "Expand (Fleet Owner)";
+  UserSubscriptionPackageType["EVOLVE_FLEET_OWNER"] = "Evolve (Fleet Owner)";
+  UserSubscriptionPackageType["EXPLORE_FLEET_OWNER"] = "Explore (Fleet Owner)"; // OLD PACKAGES
+
+  UserSubscriptionPackageType["Collect"] = "COLLECT";
+  UserSubscriptionPackageType["Insight"] = "INSIGHT";
+  UserSubscriptionPackageType["View"] = "VIEW";
+  UserSubscriptionPackageType["None"] = "NONE";
+})(UserSubscriptionPackageType || (UserSubscriptionPackageType = {}));
+
+export { UserSubscriptionPackageType };

package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@trackunit/react-core-contexts-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"
+}

package/test/config/jest.setup.d.ts

@@ -0,0 +1 @@
+export {};

package/toastContext.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="react" />
+export declare type AlertColors = "info" | "warning" | "danger" | "success";
+export declare type AlertAction = {
+    label: string;
+    onClick: () => void;
+    loading?: boolean;
+};
+export interface Toast {
+    dedupeKey?: string;
+    intent: AlertColors;
+    title: string;
+    description?: string;
+    primaryAction?: AlertAction;
+    secondaryAction?: AlertAction;
+    duration?: number;
+}
+export declare type AddToast = (toast: Toast) => void;
+export interface IToastContext {
+    addToast: AddToast;
+    setIsManifestError?: React.Dispatch<React.SetStateAction<boolean>>;
+}

package/tokenContext.d.ts

@@ -0,0 +1,6 @@
+export interface ITokenContext {
+    /**
+     * The current valid token or null if no token is available.
+     */
+    token?: string;
+}

package/userSubscriptionContext.d.ts

@@ -0,0 +1,23 @@
+export interface IUserSubscriptionContext {
+    /**
+     * The users subscription package
+     */
+    packageType: UserSubscriptionPackageType;
+    /**
+     * Extra features enabled for the current user. Will be null if still loading
+     */
+    features: IFeature[] | null;
+}
+export declare enum UserSubscriptionPackageType {
+    EXPAND_FLEET_OWNER = "Expand (Fleet Owner)",
+    EVOLVE_FLEET_OWNER = "Evolve (Fleet Owner)",
+    EXPLORE_FLEET_OWNER = "Explore (Fleet Owner)",
+    Collect = "COLLECT",
+    Insight = "INSIGHT",
+    View = "VIEW",
+    None = "NONE"
+}
+export interface IFeature {
+    id: string;
+    name: string;
+}